[ { "path": ".bufstyle.yaml", "content": "version: v1\nignore:\n PACKAGE_FILENAME:\n - private/gen\n" }, { "path": ".dockerignore", "content": "# Autogenerated by makego. DO NOT EDIT.\n.build/\n.claude/settings.local.json\n.ctrlp\n.env/\n.idea/\n.tmp/\n.vscode/\ncmd/buf/buf\ncmd/buf/internal/command/alpha/protoc/internal/protoc-gen-insertion-point-receiver/protoc-gen-insertion-point-receiver\ncmd/buf/internal/command/alpha/protoc/internal/protoc-gen-insertion-point-writer/protoc-gen-insertion-point-writer\ncmd/buf/internal/command/alpha/protoc/test.txt\ncmd/buf/internal/command/generate/internal/protoc-gen-top-level-type-names-yaml/protoc-gen-top-level-type-names-yaml\ncmd/buf/testdata/imports/cache/v3/modulelocks/\ncmd/buf/testdata/imports/corrupted_cache_dep/v3/modulelocks/\ncmd/buf/testdata/imports/corrupted_cache_file/v3/modulelocks/\ncmd/protoc-gen-buf-breaking/protoc-gen-buf-breaking\ncmd/protoc-gen-buf-lint/protoc-gen-buf-lint\nprivate/buf/buftesting/cache/\nprivate/buf/bufwkt/cmd/wkt-go-data/wkt-go-data\nprivate/bufpkg/bufcheck/internal/cmd/buf-plugin-duplicate-category/buf-plugin-duplicate-category\nprivate/bufpkg/bufcheck/internal/cmd/buf-plugin-duplicate-rule/buf-plugin-duplicate-rule\nprivate/bufpkg/bufcheck/internal/cmd/buf-plugin-panic/buf-plugin-panic\nprivate/bufpkg/bufcheck/internal/cmd/buf-plugin-protovalidate-ext/buf-plugin-protovalidate-ext\nprivate/bufpkg/bufcheck/internal/cmd/buf-plugin-rpc-ext/buf-plugin-rpc-ext\nprivate/bufpkg/bufcheck/internal/cmd/buf-plugin-suffix/buf-plugin-suffix\nprivate/bufpkg/bufmodule/bufmoduleapi/cmd/buf-legacyfederation-go-data/buf-legacyfederation-go-data\nprivate/bufpkg/bufmodule/bufmoduletesting/cmd/buf-digest/buf-digest\nprivate/bufpkg/bufmodule/bufmoduletesting/cmd/buf-new-commit-id/buf-new-commit-id\nprivate/bufpkg/buftesting/cache/\nprivate/pkg/bandeps/cmd/bandeps/bandeps\nprivate/pkg/git/cmd/git-ls-files-unstaged/git-ls-files-unstaged\nprivate/pkg/licenseheader/cmd/license-header/license-header\nprivate/pkg/storage/cmd/ddiff/ddiff\nprivate/pkg/storage/cmd/storage-go-data/storage-go-data\nprivate/pkg/storage/storageos/tmp/\n" }, { "path": ".envrc", "content": ". $(make -s direnv)\n" }, { "path": ".gitattributes", "content": "# This is similar to the git option core.autocrlf but it applies to all\n# users of the repository and therefore doesn't depend on a developers\n# local configuration.\n* text=auto\n\n# Never attempt EOL conversion on files within testdata\n**/testdata/** -text -diff\n\n**/corpus/** linguist-generated=true\n**/usage.gen.go linguist-generated=true\n/private/gen/** linguist-generated=true\n" }, { "path": ".github/CODEOWNERS", "content": "" }, { "path": ".github/ISSUE_TEMPLATE/1-bug-report.yml", "content": "name: Bug Report\ndescription: File a bug report.\nlabels: Bug\nbody:\n - type: markdown\n attributes:\n value: |\n Thanks for helping us improve Buf by filing bugs, we really appreciate it! For us to investigate your issue efficiently, we need a minimal reproducible example. We get lots of support requests, so please help us help you. We find that the easiest way to do this is by linking to a GitHub repository with the setup of the example, as well as a set of commands for us to run on this GitHub repository to reproduce the issue. You can use an existing GitHub repository, or a temporary GitHub repository you create.\n\n **If you do not provide a minimal reproducible example in a GitHub repository, we will likely close your issue until a reproducible example is provided. We apologize, but we have to be efficient with our support requests, and we appreciate your help.**\n\n [This article](https://stackoverflow.com/help/minimal-reproducible-example) on minimal reproducible examples may be of use!\n - type: input\n id: github-repository\n attributes:\n label: GitHub repository with your minimal reproducible example (do not leave this field blank or fill out this field with \"github.com/bufbuild/buf\" or we will automatically close your issue, see the instructions above!)\n description: Provide us with a link to the GitHub repository that contains the setup needed to reproduce the issue. This is a repository you create, and is required for us to investigate your issue.\n placeholder: https://github.com/you/temp-repo-with-repro\n validations:\n required: true\n - type: textarea\n id: commands\n attributes:\n label: Commands\n description: Please provide the commands to run from the root of this repository to reproduce the issue.\n placeholder: |\n cd ./proto\n buf lint\n render: shell\n validations:\n required: true\n - type: textarea\n id: actual-output\n attributes:\n label: Output\n description: What is the output of running these commands?\n placeholder: |\n foo/bar/v1/bar.proto:37:29:Field name \"CreateTime\" should be lower_snake_case, such as \"create_time\".\n render: shell\n validations:\n required: true\n - type: textarea\n id: expected-output\n attributes:\n label: Expected Output\n description: What did you expect instead?\n placeholder: I expected no lint failures.\n validations:\n required: true\n - type: textarea\n id: other\n attributes:\n label: Anything else?\n description: Is there any other context you'd like us to have?\n" }, { "path": ".github/ISSUE_TEMPLATE/2-feature-request.yml", "content": "name: Feature Request\ndescription: Let us know about a feature you'd like us to add.\nlabels: Feature\nbody:\n - type: markdown\n attributes:\n value: |\n Thanks for your suggestions on how to improve Buf, we really appreciate it!\n - type: textarea\n id: feature\n attributes:\n label: Feature\n description: Tell us what you'd like to see!\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/3-other.yml", "content": "name: Other\ndescription: Anything else.\nbody:\n - type: markdown\n attributes:\n value: |\n Thanks for getting in touch, we really appreciate it! If your issue isn't a bug or feature request, we'd highly recommend to talk to us on the [Buf Slack](https://buf.build/links/slack). If you think the issue is more appropriate for a GitHub issue, please file it below!\n\n If this is a question about some behavior you are witnessing, we will need a minimal reproducible example. We get lots of support requests, so please help us help you. We find that the easiest way to do this is by linking to a GitHub repository with the setup of the example, as well as a set of commands for us to run on this GitHub repository to reproduce the issue. You can use an existing GitHub repository, or a temporary GitHub repository you create.\n\n **If this is a question about some behavior you are witnessing, and you do not provide a minimal reproducible example in a GitHub repository, we will likely close your issue until a reproducible example is provided. We apologize, but we have to be efficient with our support requests, and we appreciate your help.**\n\n [This article](https://stackoverflow.com/help/minimal-reproducible-example) on minimal reproducible examples may be of use!\n - type: input\n id: github-repository\n attributes:\n label: GitHub repository with your minimal reproducible example (do not leave this field blank or fill out this field with \"github.com/bufbuild/buf\" or we will automatically close your issue, see the instructions above!)\n description: If this is a question about some behavior you are witnessing, provide us with a link to the GitHub repository that contains the setup needed to reproduce the issue. This is a repository you create, and is required for us to investigate your issue.\n placeholder: https://github.com/you/temp-repo-with-repro\n - type: textarea\n id: feature\n attributes:\n label: What's up?\n description: Tell us what's on your mind!\n validations:\n required: true\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: \"docker\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n - package-ecosystem: \"gomod\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n ignore:\n # We manually update this from main and lock the commit in make/buf/all.mk\n - dependency-name: \"github.com/bufbuild/protocompile\"\n # This needs to be locked to the same version we generate with, which is\n # controlled via dep_protoc_gen_connect_go.mk\n - dependency-name: \"github.com/bufbuild/connect-go\"\n # This needs to be locked to the same version we generate with, which is\n # controlled via make/go/dep_protoc_gen_go.mk\n - dependency-name: \"google.golang.org/protobuf\"\n" }, { "path": ".github/workflows/add-to-project.yaml", "content": "name: Add issues and PRs to project\n\non:\n issues:\n types:\n - opened\n - reopened\n - transferred\n pull_request_target:\n types:\n - opened\n - reopened\n issue_comment:\n types:\n - created\n\njobs:\n call-workflow-add-to-project:\n name: Call workflow to add issue to project\n uses: bufbuild/base-workflows/.github/workflows/add-to-project.yaml@main\n secrets: inherit\n" }, { "path": ".github/workflows/back-to-development.yaml", "content": "name: Go back to Development\non:\n workflow_dispatch:\n release:\n types: [published]\nenv:\n APP_ID: 251311\njobs:\n post-release:\n runs-on: ubuntu-latest\n steps:\n - name: Get GitHub app token\n uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859 # v3.0.0\n id: app_token\n with:\n app-id: ${{ env.APP_ID }}\n private-key: ${{ secrets.TOKEN_EXCHANGE_GH_APP_PRIVATE_KEY }}\n - name: Checkout repository code\n uses: actions/checkout@v6\n with:\n token: ${{ steps.app_token.outputs.token }}\n - name: Set up Git name and email\n run: |\n git config user.name \"${{ github.actor }}\"\n git config user.email \"${{ github.actor }}@users.noreply.github.com\"\n - name: Create PR back to development\n run: bash ./make/buf/scripts/gobacktodevelopment.bash\n env:\n GH_TOKEN: ${{ steps.app_token.outputs.token }}\n WEBHOOK_URL: ${{ secrets.SLACK_RELEASE_NOTIFICATION_WEBHOOK }}\n" }, { "path": ".github/workflows/buf-binary-size.yaml", "content": "name: binary-size\non:\n push:\n branches:\n - main\n tags: [\"v*\"]\n pull_request:\n# Prevent writing to the repository using the CI token.\n# Ref: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions\npermissions: read-all\nenv:\n MAKEFLAGS: \"-j 2\"\njobs:\n buf-binary-size:\n runs-on: ubuntu-latest\n steps:\n - name: checkout\n uses: actions/checkout@v6\n - name: setup-go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.26.x\"\n check-latest: true\n - name: cache\n uses: actions/cache@v5\n with:\n path: |\n ~/.cache/buf/${{ runner.os }}/x86_64/bin\n ~/.cache/buf/${{ runner.os }}/x86_64/go/pkg/mod\n ~/.cache/buf/${{ runner.os }}/x86_64/gocache\n ~/.cache/buf/${{ runner.os }}/x86_64/include\n ~/.cache/buf/${{ runner.os }}/x86_64/versions\n key: ${{ runner.os }}-buf-${{ hashFiles('**/go.sum', 'make/**') }}\n restore-keys: |\n ${{ runner.os }}-buf-\n - name: make-bufbinarysize\n run: make bufbinarysize\n" }, { "path": ".github/workflows/buf-ci.yaml", "content": "name: Buf CI\non:\n push:\n pull_request:\n types: [opened, synchronize, reopened, labeled, unlabeled]\n delete:\npermissions:\n contents: read\n pull-requests: write\njobs:\n buf:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - uses: bufbuild/buf-action@v1\n with:\n token: ${{ secrets.BUF_TOKEN }}\n" }, { "path": ".github/workflows/build-and-draft-release.yaml", "content": "name: Build and Draft Release\non:\n pull_request:\n types: [closed]\n workflow_dispatch:\n inputs:\n version:\n type: string\n description: The released version without 'v'. For example, 1.0.0.\nenv:\n APP_ID: 251311\njobs:\n draft_release:\n runs-on: ubuntu-latest\n if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'release')) }}\n steps:\n - name: Set VERSION variable\n # The head ref looks like release/v1.0.0, and we need to trim the string up to the `/v`.\n run: |\n VERSION=\"${{ github.event.inputs.version || github.head_ref}}\"\n echo \"VERSION=${VERSION##*/v}\" >> $GITHUB_ENV\n - name: Get GitHub app token\n uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859 # v3.0.0\n id: app_token\n with:\n app-id: ${{ env.APP_ID }}\n private-key: ${{ secrets.TOKEN_EXCHANGE_GH_APP_PRIVATE_KEY }}\n - name: Checkout repository code\n uses: actions/checkout@v6\n with:\n token: ${{ steps.app_token.outputs.token }}\n - name: Set up Go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.26.x\"\n check-latest: true\n - name: Set up Git name and email\n run: |\n git config user.name \"${{ github.actor }}\"\n git config user.email \"${{ github.actor }}@users.noreply.github.com\"\n - name: Build assets and draft release\n run: bash ./make/buf/scripts/draftrelease.bash\n env:\n GH_TOKEN: ${{ steps.app_token.outputs.token }}\n WEBHOOK_URL: ${{ secrets.SLACK_RELEASE_NOTIFICATION_WEBHOOK }}\n RELEASE_MINISIGN_PRIVATE_KEY: ${{secrets.RELEASE_MINISIGN_PRIVATE_KEY}}\n RELEASE_MINISIGN_PRIVATE_KEY_PASSWORD: ${{secrets.RELEASE_MINISIGN_PRIVATE_KEY_PASSWORD}}\n - name: Unset keys\n if: ${{ always() }}\n run: |\n unset RELEASE_MINISIGN_PRIVATE_KEY\n unset RELEASE_MINISIGN_PRIVATE_KEY_PASSWORD\n" }, { "path": ".github/workflows/ci.yaml", "content": "name: ci\non:\n push:\n branches:\n - main\n tags: [\"v*\"]\n pull_request:\n# Prevent writing to the repository using the CI token.\n# Ref: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions\npermissions: read-all\nenv:\n MAKEFLAGS: \"-j 2\"\njobs:\n lint:\n runs-on: ubuntu-latest\n steps:\n - name: checkout\n uses: actions/checkout@v6\n - name: setup-go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.26.x\"\n check-latest: true\n - name: cache\n uses: actions/cache@v5\n with:\n path: |\n ~/.cache/buf/${{ runner.os }}/x86_64/bin\n ~/.cache/buf/${{ runner.os }}/x86_64/go/pkg/mod\n ~/.cache/buf/${{ runner.os }}/x86_64/gocache\n ~/.cache/buf/${{ runner.os }}/x86_64/include\n ~/.cache/buf/${{ runner.os }}/x86_64/versions\n key: ${{ runner.os }}-buf-lint-${{ hashFiles('**/go.sum', 'make/**') }}\n restore-keys: |\n ${{ runner.os }}-buf-lint-\n - name: golangci-lint-cache\n uses: actions/cache@v5\n with:\n path: ~/.cache/golangci-lint\n # https://github.com/golangci/golangci-lint-action#caching-internals includes an interval number in the cache\n # key, however we update our go modules at least once weekly so we shouldn't need that.\n key: ${{ runner.os }}-buf-golangci-lint-${{ hashFiles('**/go.sum') }}\n restore-keys: |\n ${{ runner.os }}-buf-golangci-lint-\n - name: make-lint\n run: make lint\n env:\n BUF_BREAKING_AGAINST_INPUT: \"https://github.com/bufbuild/buf.git#branch=main\"\n BUF_INPUT_HTTPS_USERNAME: ${{ github.actor }}\n BUF_INPUT_HTTPS_PASSWORD: ${{ github.token }}\n test:\n runs-on: ubuntu-latest\n steps:\n - name: checkout\n uses: actions/checkout@v6\n - name: setup-go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.26.x\"\n check-latest: true\n - name: cache\n uses: actions/cache@v5\n with:\n path: |\n ~/.cache/buf/${{ runner.os }}/x86_64/bin\n ~/.cache/buf/${{ runner.os }}/x86_64/go/pkg/mod\n ~/.cache/buf/${{ runner.os }}/x86_64/gocache\n ~/.cache/buf/${{ runner.os }}/x86_64/include\n ~/.cache/buf/${{ runner.os }}/x86_64/versions\n key: ${{ runner.os }}-buf-test-${{ hashFiles('**/go.sum', 'make/**') }}\n restore-keys: |\n ${{ runner.os }}-buf-test-\n - name: make-test\n run: make test\n docker:\n runs-on: ubuntu-latest\n needs:\n - lint\n - test\n # This job only runs when\n # 1. The previous lint and test jobs have completed successfully\n # 2. The repository is not a fork, i.e. it will only run on the official bufbuild/buf\n # 3. The workflow run is trigged by main branch OR a tag with v prefix\n # See https://github.com/bufbuild/buf/pull/289/files#r596207623 for the discussion\n if: ${{ github.repository == 'bufbuild/buf' && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/v')) }}\n steps:\n # qemu is used when executing things like `apk` in the final build\n # stage which must execute on the target platform. We currently do\n # not have any CGO and care should be taken in the Dockerfile to ensure\n # that go cross compilation happens on the build platform.\n - name: setup-qemu\n uses: docker/setup-qemu-action@v4\n id: qemu\n with:\n # alpine image doesn't support linux/riscv64\n platforms: linux/386,linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6,linux/ppc64le,linux/s390x\n - name: setup-docker-buildx\n uses: docker/setup-buildx-action@v4\n - name: login-docker\n uses: docker/login-action@v4\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_TOKEN }}\n - name: docker-meta\n id: meta\n uses: docker/metadata-action@v6\n with:\n images: |\n bufbuild/buf\n tags: |\n type=edge,branch=main\n type=semver,pattern={{version}}\n type=semver,pattern={{major}}.{{minor}}\n type=semver,pattern={{major}}\n flavor: |\n latest=auto\n - name: docker-build-push\n uses: docker/build-push-action@v7\n with:\n file: Dockerfile.buf\n platforms: ${{ steps.qemu.outputs.platforms }}\n push: true\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n" }, { "path": ".github/workflows/codeql.yaml", "content": "# Broadly based on example Github action from\n# https://github.com/github/codeql-action#usage\nname: codeql\n# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions\n# https://github.com/github/codeql-action/issues/572\npermissions:\n actions: read\n contents: read\n pull-requests: read\n security-events: write\non:\n push:\n branches:\n - main\njobs:\n codeql:\n runs-on: ubuntu-latest\n steps:\n - name: checkout\n uses: actions/checkout@v6\n - name: setup-go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.26.x\"\n check-latest: true\n - name: initialize\n uses: github/codeql-action/init@v4\n with:\n # Limit analysis to Go for now.\n # Available languages: https://docs.github.com/en/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#changing-the-languages-that-are-analyzed\n languages: go\n - name: autobuild\n uses: github/codeql-action/autobuild@v4\n - name: analyze\n uses: github/codeql-action/analyze@v4\n" }, { "path": ".github/workflows/create-release-pr.yaml", "content": "name: Create Release PR\non:\n workflow_dispatch:\n inputs:\n version:\n type: string\n description: The released version without 'v'. For example, 1.0.0.\nenv:\n APP_ID: 251311\njobs:\n prepare:\n runs-on: ubuntu-latest\n steps:\n - name: Get GitHub app token\n uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859 # v3.0.0\n id: app_token\n with:\n app-id: ${{ env.APP_ID }}\n private-key: ${{ secrets.TOKEN_EXCHANGE_GH_APP_PRIVATE_KEY }}\n - name: Checkout repository code\n uses: actions/checkout@v6\n with:\n token: ${{ steps.app_token.outputs.token }}\n - name: Set up Git name and email\n run: |\n git config user.name \"${{ github.actor }}\"\n git config user.email \"${{ github.actor }}@users.noreply.github.com\"\n - name: Create release PR\n run: bash ./make/buf/scripts/createreleasepr.bash\n env:\n GH_TOKEN: ${{ steps.app_token.outputs.token }}\n VERSION: ${{ github.event.inputs.version }}\n WEBHOOK_URL: ${{ secrets.SLACK_RELEASE_NOTIFICATION_WEBHOOK }}\n" }, { "path": ".github/workflows/docker-publish.yaml", "content": "# This job will build and push the Docker image to Docker Hub.\nname: docker-publish\non:\n workflow_dispatch:\n inputs:\n version:\n type: string\n required: true\n description: The release version (e.g., X.Y.Z), without the v.\n latest:\n type: boolean\n description: Tag with latest\n default: false\n publish:\n type: boolean\n description: Publish the image to Docker Hub\n default: false\npermissions: read-all\njobs:\n docker:\n runs-on: ubuntu-latest\n if: github.repository == 'bufbuild/buf'\n steps:\n - name: Validate SemVer\n run: |\n VERSION=${{ github.event.inputs.version }}\n SEMVER_REGEX='^[0-9]*\\.[0-9]*\\.[0-9]*$'\n if [[ ! $VERSION =~ $SEMVER_REGEX ]]; then\n echo \"Error: '$VERSION' is not a valid SemVer version\"\n exit 1\n else\n echo \"Version '$VERSION' is a valid SemVer version\"\n fi\n - name: checkout\n id: checkout\n uses: actions/checkout@v6\n with:\n ref: refs/tags/v${{ github.event.inputs.version }}\n - name: setup-qemu\n uses: docker/setup-qemu-action@v4\n id: qemu\n with:\n platforms: linux/386,linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6,linux/ppc64le,linux/s390x\n - name: setup-docker-buildx\n uses: docker/setup-buildx-action@v4\n - name: login-docker\n uses: docker/login-action@v4\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_TOKEN }}\n - name: docker-meta\n id: meta\n uses: docker/metadata-action@v6\n with:\n images: |\n bufbuild/buf\n tags: |\n type=raw,value=latest,enable=${{ github.event.inputs.latest }}\n type=semver,pattern={{major}},value=v${{ github.event.inputs.version }}\n type=semver,pattern={{major}}.{{minor}},value=v${{ github.event.inputs.version }}\n type=semver,pattern={{major}}.{{minor}}.{{patch}},value=v${{ github.event.inputs.version }}\n type=semver,pattern={{version}},value=v${{ github.event.inputs.version }}\n labels: |\n org.opencontainers.image.revision=${{ steps.checkout.outputs.commit }}\n org.opencontainers.image.version=${{ github.event.inputs.version }}\n flavor: |\n latest=false\n - name: docker-build\n uses: docker/build-push-action@v7\n with:\n context: . # This uses the checkout context\n file: Dockerfile.buf\n load: true\n push: false\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n - name: docker-test\n run: |\n OUTPUT=$(docker run --rm bufbuild/buf:${{ github.event.inputs.version }} --version)\n if [ \"$OUTPUT\" == \"${{ github.event.inputs.version }}\" ]; then\n echo \"Version matches\"\n else\n echo \"Version does not match: expected ${{ github.event.inputs.version }}, got $OUTPUT\"\n exit 1\n fi\n - name: docker-build-publish\n uses: docker/build-push-action@v7\n if: ${{ github.event.inputs.publish == 'true' }}\n with:\n context: . # This uses the checkout context\n file: Dockerfile.buf\n platforms: ${{ steps.qemu.outputs.platforms }}\n push: ${{ github.event.inputs.publish == 'true' }}\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n" }, { "path": ".github/workflows/emergency-review-bypass.yaml", "content": "name: Bypass review in case of emergency\non:\n pull_request:\n types:\n - labeled\npermissions:\n pull-requests: write\njobs:\n approve:\n if: github.event.label.name == 'Emergency Bypass Review'\n uses: bufbuild/base-workflows/.github/workflows/emergency-review-bypass.yaml@main\n secrets: inherit\n" }, { "path": ".github/workflows/make-upgrade.yaml", "content": "name: Make upgrade\non:\n schedule:\n # Run every Monday at 10am UTC\n - cron: \"0 10 * * 1\"\nenv:\n APP_ID: 251311\njobs:\n prepare:\n runs-on: ubuntu-latest\n steps:\n - name: Get GitHub app token\n uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859 # v3.0.0\n id: app_token\n with:\n app-id: ${{ env.APP_ID }}\n private-key: ${{ secrets.TOKEN_EXCHANGE_GH_APP_PRIVATE_KEY }}\n - name: Checkout repository code\n uses: actions/checkout@v6\n with:\n token: ${{ steps.app_token.outputs.token }}\n - name: setup-go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.26.x\"\n check-latest: true\n cache: false\n - name: Set up Git name and email\n run: |\n git config user.name 'github-actions[bot]'\n git config user.email 'github-actions[bot]@users.noreply.github.com'\n - name: make-githubactionupgrade\n run: make githubactionupgrade\n env:\n GH_TOKEN: ${{ steps.app_token.outputs.token }}\n" }, { "path": ".github/workflows/notify-approval-bypass.yaml", "content": "name: PR Approval Bypass Notifier\non:\n pull_request:\n types:\n - closed\n branches:\n - main\npermissions:\n pull-requests: read\njobs:\n approval:\n uses: bufbuild/base-workflows/.github/workflows/notify-approval-bypass.yaml@main\n secrets: inherit\n" }, { "path": ".github/workflows/pr-title.yaml", "content": "name: Lint PR Title\n# Prevent writing to the repository using the CI token.\n# Ref: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions\npermissions:\n pull-requests: read\non:\n pull_request:\n # By default, a workflow only runs when a pull_request's activity type is opened,\n # synchronize, or reopened. We explicity override here so that PR titles are\n # re-linted when the PR text content is edited.\n types:\n - opened\n - edited\n - reopened\n - synchronize\njobs:\n lint:\n uses: bufbuild/base-workflows/.github/workflows/pr-title.yaml@main\n" }, { "path": ".github/workflows/previous.yaml", "content": "name: previous\non:\n push:\n branches:\n - main\n tags: [\"v*\"]\n pull_request:\n# Prevent writing to the repository using the CI token.\n# Ref: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions\npermissions: read-all\nenv:\n MAKEFLAGS: \"-j 2\"\njobs:\n test-previous:\n strategy:\n matrix:\n go-version: [\"1.25.x\"]\n runs-on: ubuntu-latest\n steps:\n - name: checkout\n uses: actions/checkout@v6\n - name: setup-go\n uses: actions/setup-go@v6\n with:\n go-version: ${{ matrix.go-version }}\n check-latest: true\n - name: cache\n uses: actions/cache@v5\n with:\n path: |\n ~/.cache/buf/${{ runner.os }}/x86_64/bin\n ~/.cache/buf/${{ runner.os }}/x86_64/go/pkg/mod\n ~/.cache/buf/${{ runner.os }}/x86_64/gocache\n ~/.cache/buf/${{ runner.os }}/x86_64/include\n ~/.cache/buf/${{ runner.os }}/x86_64/versions\n key: ${{ runner.os }}-${{ matrix.go-version }}-buf-${{ hashFiles('**/go.sum', 'make/**') }}\n restore-keys: |\n ${{ runner.os }}-${{ matrix.go-version }}-buf-\n - name: make-test\n run: make test\n" }, { "path": ".github/workflows/verify-changelog.yaml", "content": "name: Verify Changelog\non:\n pull_request:\n types:\n - opened\n push:\n branches:\n - \"release/**\"\n - \"next/**\"\njobs:\n verify:\n runs-on: ubuntu-latest\n if: ${{ github.event_name == 'push' || startsWith(github.head_ref, 'release/') || startsWith(github.head_ref, 'next/')}}\n steps:\n - name: Checkout repository code\n uses: actions/checkout@v6\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n fetch-depth: 0\n - name: Check changelog is modified\n run: bash ./make/buf/scripts/verifychangelog.bash\n" }, { "path": ".github/workflows/windows.yaml", "content": "name: windows\non:\n push:\n branches:\n - main\n tags: [\"v*\"]\n pull_request:\n# Prevent writing to the repository using the CI token.\n# Ref: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions\npermissions: read-all\njobs:\n test:\n env:\n DOWNLOAD_CACHE: 'd:\\downloadcache'\n # Improve performance by using D: drive.\n # C: seems to be really slow, especially for cache restores.\n GOPATH: 'd:\\go\\path'\n GOCACHE: 'd:\\go\\cache'\n GOMODCACHE: 'd:\\go\\modcache'\n runs-on: windows-latest\n steps:\n - name: support-longpaths\n run: git config --system core.longpaths true\n - name: checkout\n uses: actions/checkout@v6\n - name: setup-go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.26.x\"\n check-latest: true\n cache: true\n - name: windows-cache\n uses: actions/cache@v5\n with:\n path: |\n ${{ env.DOWNLOAD_CACHE }}\n key: ${{ runner.os }}-buf-windows-${{ hashFiles('windows/**') }}\n restore-keys: |\n ${{ runner.os }}-buf-windows-\n - name: test\n shell: bash\n run: ./etc/windows/test.bash\n" }, { "path": ".gitignore", "content": "# Autogenerated by makego. DO NOT EDIT.\n/.build/\n/.claude/settings.local.json\n/.ctrlp\n/.env/\n/.idea/\n/.tmp/\n/.vscode/\n/cmd/buf/buf\n/cmd/buf/internal/command/alpha/protoc/internal/protoc-gen-insertion-point-receiver/protoc-gen-insertion-point-receiver\n/cmd/buf/internal/command/alpha/protoc/internal/protoc-gen-insertion-point-writer/protoc-gen-insertion-point-writer\n/cmd/buf/internal/command/alpha/protoc/test.txt\n/cmd/buf/internal/command/generate/internal/protoc-gen-top-level-type-names-yaml/protoc-gen-top-level-type-names-yaml\n/cmd/buf/testdata/imports/cache/v3/modulelocks/\n/cmd/buf/testdata/imports/corrupted_cache_dep/v3/modulelocks/\n/cmd/buf/testdata/imports/corrupted_cache_file/v3/modulelocks/\n/cmd/protoc-gen-buf-breaking/protoc-gen-buf-breaking\n/cmd/protoc-gen-buf-lint/protoc-gen-buf-lint\n/private/buf/buftesting/cache/\n/private/buf/bufwkt/cmd/wkt-go-data/wkt-go-data\n/private/bufpkg/bufcheck/internal/cmd/buf-plugin-duplicate-category/buf-plugin-duplicate-category\n/private/bufpkg/bufcheck/internal/cmd/buf-plugin-duplicate-rule/buf-plugin-duplicate-rule\n/private/bufpkg/bufcheck/internal/cmd/buf-plugin-panic/buf-plugin-panic\n/private/bufpkg/bufcheck/internal/cmd/buf-plugin-protovalidate-ext/buf-plugin-protovalidate-ext\n/private/bufpkg/bufcheck/internal/cmd/buf-plugin-rpc-ext/buf-plugin-rpc-ext\n/private/bufpkg/bufcheck/internal/cmd/buf-plugin-suffix/buf-plugin-suffix\n/private/bufpkg/bufmodule/bufmoduleapi/cmd/buf-legacyfederation-go-data/buf-legacyfederation-go-data\n/private/bufpkg/bufmodule/bufmoduletesting/cmd/buf-digest/buf-digest\n/private/bufpkg/bufmodule/bufmoduletesting/cmd/buf-new-commit-id/buf-new-commit-id\n/private/bufpkg/buftesting/cache/\n/private/pkg/bandeps/cmd/bandeps/bandeps\n/private/pkg/git/cmd/git-ls-files-unstaged/git-ls-files-unstaged\n/private/pkg/licenseheader/cmd/license-header/license-header\n/private/pkg/storage/cmd/ddiff/ddiff\n/private/pkg/storage/cmd/storage-go-data/storage-go-data\n/private/pkg/storage/storageos/tmp/\n" }, { "path": ".godoclint.yaml", "content": "# Configuration file version.\nversion: \"1.0\"\n\n# List of regexp patterns matching files the linter should include. When\n# omitted/null, the linter includes all Go files. If assigned then only the\n# files that their relative path (with respect to the config file path) matches\n# any of the patterns will be processed.\n#\n# Note: The patterns must assume a Unix-like path (i.e., separated with forward\n# slashes, `/`), even on Windows. This is to ensure a consistent behavior across\n# different platforms.\n#\n# Example:\n# include:\n# - ^pkg/\n# - _foo.go$\ninclude: null\n\n# List of regexp patterns matching files the linter should skip. When\n# omitted/null, the linter excludes no Go files. If assigned then only the\n# files that their relative path (with respect to the config file path) does not\n# match any of the patterns will be processed.\n#\n# Note: The patterns must assume a Unix-like path (i.e., separated with forward\n# slashes, `/`), even on Windows. This is to ensure a consistent behavior across\n# different platforms.\n#\n# Example:\n# exclude:\n# - ^internal/\n# - _autogenerated.go$\nexclude:\n - ^private/gen\n\n# Default set of rules to enable. Possible values are:\n# - `basic`: enables basic rules which are: `pkg-doc`, `single-pkg-doc`, `start-with-name` and `deprecated`.\n# - `all`: all rules are enabled by default; the `disable` key can be used to disable specific rules.\n# - `none`: no rule is enabled by default; the `enable` key can be used to enable specific rules.\ndefault: none\n\n# List of rules to enable *in addition to* the default set.\n#\n# See the linter docs for more on supported rules.\n#\n# Example:\n# - pkg-doc\n# - single-pkg-doc\n# - require-pkg-doc\n# - specific-file-pkg-doc\n# - start-with-name\n# - require-doc\n# - deprecated\n# - max-len\n# - no-unused-link\nenable:\n - pkg-doc\n - single-pkg-doc\n #- require-pkg-doc\n - specific-file-pkg-doc\n - start-with-name\n - require-doc\n - deprecated\n #- max-len\n - no-unused-link\n\n# List of rules to disable.\n#\n# Example:\n# disable:\n# - pkg-doc\n# - single-pkg-doc\ndisable: null\n\n# A map for setting individual rule options.\n#\n# All sub-keys are optional.\noptions:\n # Maximum line length for godocs, not including the `// `, or `/*` or `*/`\n # tokens.\n max-len/length: 120\n\n # Include test files when applying the `max-len` rule.\n max-len/include-tests: false\n\n # Include test files when applying the `pkg-doc` rule.\n pkg-doc/include-tests: false\n\n # Include test files when applying the `single-pkg-doc` rule.\n single-pkg-doc/include-tests: false\n\n # Include test files when applying the `require-pkg-doc` rule.\n require-pkg-doc/include-tests: false\n\n # Include test files when applying the `specific-file-pkg-doc` rule.\n specific-file-pkg-doc/include-tests: false\n\n # The file pattern to indicate which file should contain the package-level godoc when\n # applying the `specific-file-pkg-doc` rule.\n #\n # Valid values are:\n #\n # - \"doc\": The godoc should be in a file named doc.go\n # - \"package-name\": The godoc should be in a file named after the package. For example, if a package\n # is named \"foobar\", the godoc should be in a file named \"foobar.go\".\n specific-file-pkg-doc/file-pattern: \"package-name\"\n\n # Include test files when applying the `require-doc` rule.\n require-doc/include-tests: false\n\n # Ignore exported (public) symbols when applying the `require-doc` rule.\n require-doc/ignore-exported: false\n\n # Ignore unexported (private) symbols when applying the `require-doc` rule.\n require-doc/ignore-unexported: true\n\n # Include test files when applying the `start-with-name` rule.\n start-with-name/include-tests: false\n\n # Include unexported (private) symbols when applying the `start-with-name` rule.\n start-with-name/include-unexported: false\n\n # Include test files when applying the `no-unused-link` rule.\n no-unused-link/include-tests: false\n" }, { "path": ".golangci.yml", "content": "version: \"2\"\nlinters:\n default: none\n enable:\n - asciicheck\n - bidichk\n - bodyclose\n - containedctx\n - copyloopvar\n # - contextcheck\n - decorder\n # - depguard\n - dogsled\n - errcheck\n - exhaustruct\n - forbidigo\n - forcetypeassert\n - gochecknoinits\n - goheader\n - gomodguard\n - goprintffuncname\n - gosec\n - govet\n - grouper\n - importas\n - ineffassign\n - loggercheck\n - makezero\n - mirror\n - misspell\n - modernize\n - nakedret\n - nilerr\n - nolintlint\n - nosprintfhostport\n - paralleltest\n - predeclared\n - promlinter\n - reassign\n - rowserrcheck\n - staticcheck\n - unconvert\n - unused\n - usetesting\n - wastedassign\n - whitespace\n settings:\n errcheck:\n check-type-assertions: true\n forbidigo:\n forbid:\n # Use private/pkg/thread.Parallelize\n - pattern: ^errgroup\\.\n # Use private/pkg/standard/xos/xexec\n - pattern: ^exec\\.Cmd$\n - pattern: ^exec\\.Command$\n - pattern: ^exec\\.CommandContext$\n # os.Rename does not work across filesystem boundaries\n # See https://github.com/bufbuild/buf/issues/639\n - pattern: ^os\\.Rename$\n # Use private/pkg/osext.Getwd\n - pattern: ^os\\.Getwd$\n # Use private/pkg/osext.Chdir\n - pattern: ^os\\.Chdir$\n # Ban debug statements\n - pattern: ^fmt\\.Print\n - pattern: ^log\\.\n - pattern: ^print$\n - pattern: ^println$\n # Use private/pkg/protoencoding Marshalers and Unmarshalers\n - pattern: ^(proto|prototext|protojson|protoyaml).Marshal$\n - pattern: ^(proto|prototext|protojson|protoyaml).Unmarshal$\n - pattern: ^(proto|prototext|protojson|protoyaml).MarshalOptions$\n - pattern: ^(proto|prototext|protojson|protoyaml).UnmarshalOptions$\n - pattern: ^proto\\.Clone$\n msg: please use proto.CloneOf\n govet:\n enable:\n - nilness\n importas:\n alias:\n - pkg: github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/image/v1\n alias: imagev1\n - pkg: github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/module/v1\n alias: modulev1\n - pkg: github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\n alias: registryv1alpha1\n nolintlint:\n require-explanation: true\n require-specific: true\n allow-unused: false\n usetesting:\n context-background: true\n context-todo: true\n exclusions:\n generated: lax\n presets:\n - comments\n - common-false-positives\n - legacy\n - std-error-handling\n rules:\n - linters:\n - staticcheck\n # No need to require embedded fields from selector expression, they could help with\n # more expressive code.\n text: \"QF1008\"\n - linters:\n - staticcheck\n # Whether or not to apply De Morgan's law is contextual and should be handled during\n # code review.\n text: \"QF1001\"\n - linters:\n - paralleltest\n # We use chdir in these tests.\n path: cmd/buf/workspace_subdir_test.go\n text: missing the call to method parallel\n - linters:\n - paralleltest\n # TestWorkspaceArchiveDir, TestWorkspaceWithInvalidArchivePathFail\n # and TestWorkspaceWithInvalidArchiveAbsolutePathFail cannot run in parallel\n # because they all call createZipFromDir on the same path, writing to the same file.\n path: cmd/buf/workspace_test.go\n text: missing the call to method parallel\n - linters:\n - paralleltest\n # This test shouldn't run in parallel as it needs osext.Getwd.\n path: cmd/buf/internal/command/config/configmigrate/configmigrate_test.go\n text: missing the call to method parallel\n - linters:\n - forbidigo\n # This is a legacy usage of os.Getwd we're not bothering to port yet.\n path: cmd/buf/internal/command/alpha/protoc/protoc_test.go\n text: os.Getwd\n - linters:\n - dogsled\n # One function call doesn't care about most of the returned destructured values. The\n # dogsled linter complains about it. (Value of this linter is unclear...)\n path: cmd/buf/internal/command/curl/curl.go\n - linters:\n - forbidigo\n # This is a legacy usage of os.Getwd we're not bothering to port yet.\n path: cmd/buf/internal/command/generate/generate_test.go\n text: os.Getwd\n - linters:\n - exhaustruct\n # We didn't turn on exhaustruct historically, but we really want to make sure it is turned on\n # for this file, as we do conversion between v1beta1 and v1 registry-proto types.\n path-except: private/bufpkg/bufmodule/bufmoduleapi/convert.go\n - linters:\n - gosec\n # G101 checks for hardcoded credentials, and the variables named \"*Password*\n # trip this off.\n path: private/buf/bufcli/env.go\n text: \"G101:\"\n - linters:\n - gosec\n # G404 checks for use of the ordinary non-CPRNG.\n path: private/buf/buflsp/progress.go\n text: \"G404:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/file.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/diagnostic.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/image.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/report.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/server.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/symbol.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/semantic_tokens.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/cel.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/folding_range.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/completion.go\n text: \"G115:\"\n - linters:\n - gosec\n # G115 checks for use of truncating conversions.\n path: private/buf/buflsp/organize_imports.go\n text: \"G115:\"\n - linters:\n - containedctx\n # Type must implement an interface whose methods do not accept context. But this\n # implementation makes RPC calls, which need a context. So we allow creator of the\n # type to provide a context at value creation (instead of using context.Background()).\n path: private/buf/bufcurl/reflection_resolver.go\n - linters:\n - gosec\n # We verify manually so that we can emit verbose output while doing so.\n path: private/buf/bufcurl/tls.go\n text: \"G402:\"\n - linters:\n - paralleltest\n # This test shouldn't run in parallel as it needs osext.Getwd.\n path: private/buf/buffetch/internal/reader_test.go\n text: missing the call to method parallel\n - linters:\n - paralleltest\n # Parallelizing TestPlainPostHandlerTLS and TestPlainPostHandlerH2C\n # makes this test flaky.\n path: private/buf/bufstudioagent/bufstudioagent_test.go\n text: missing the call to method parallel\n - linters:\n - gochecknoinits\n # we actually want to use init here\n path: private/bufpkg/bufconfig/module_config.go\n - linters:\n - gosec\n # We don't need a cryptographically secure RNG for these tests, and a\n # deterministic RNG is actually nice for test repeatability.\n path: private/bufpkg/bufimage/bufimageutil/.*_test\\.go\n text: \"G404:\"\n - linters:\n - paralleltest\n # This test shouldn't run in parallel as it allocates a lot of memory.\n path: private/bufpkg/bufimage/build_image_unix_test.go\n text: missing the call to method parallel\n - linters:\n - containedctx\n # we actually want to embed a context here\n path: private/bufpkg/bufimage/parser_accessor_handler.go\n - linters:\n - containedctx\n # we actually want to embed a context here\n path: private/bufpkg/bufmodule/module.go\n - linters:\n - containedctx\n # we actually want to embed a context here\n path: private/bufpkg/bufmodule/module_set_builder.go\n - linters:\n - containedctx\n # we actually want to embed a context here\n path: private/pkg/standard/xos/xexec/process.go\n - linters:\n - gochecknoinits\n # we actually want to use init here\n path: private/bufpkg/bufmodule/paths.go\n - linters:\n - forbidigo\n # we want to use errgroup here\n path: private/bufpkg/bufremoteplugin/bufremoteplugindocker/docker.go\n text: use of `errgroup\n - linters:\n - forbidigo\n # this is one of two files we want to allow exec.Cmd functions in\n path: private/pkg/standard/xos/xexec/xexec.go\n - linters:\n - forbidigo\n # this is one of two files we want to allow exec.Cmd functions in\n path: private/pkg/standard/xos/xexec/process.go\n - linters:\n - gosec\n # G204 checks that exec.Command is not called with non-constants.\n path: private/pkg/standard/xos/xexec/xexec.go\n text: \"G204:\"\n - linters:\n - gosec\n # We should be able to use net/http/cgi in a unit test, in addition the CVE mentions\n # only versions of go < 1.6.3 are affected.\n path: private/pkg/git/git_test.go\n text: \"G504:\"\n - linters:\n - wastedassign\n # netrc/internal is a library largely copied in from an external repository with attribution.\n # We try to make minimal edits.\n path: private/pkg/netrc/internal/internal.go\n - linters:\n - forbidigo\n # We cache os.Getwd in osext, osext is the entrypoint.\n path: private/pkg/osext/osext.go\n text: os.Getwd\n - linters:\n - forbidigo\n # We cache os.Getwd in osext, osext has a Chdir that clears the cache.\n path: private/pkg/osext/osext.go\n text: os.Chdir\n - linters:\n - forbidigo\n # We're going to move xfilepath out.\n path: private/pkg/standard/xpath/xfilepath/xfilepath.go\n text: os.Getwd\n - linters:\n - gochecknoinits\n # protoencoding calls detrand.Disable via go:linkname and and init function. See the comments\n # in the file for more details.\n path: private/pkg/protoencoding/detrand.go\n - linters:\n - errcheck\n # headers.go has casts with values from contexts that should fail if there\n # is no error, but it would be very unidiomatic to return an error from\n # the functions that do these casts, and we completely control the\n # context values within this file\n path: private/pkg/rpc/headers.go\n - linters:\n - forbidigo\n # we use os.Rename here to rename files in the same directory\n # This is safe (we aren't traversing filesystem boundaries).\n path: private/pkg/storage/storageos/bucket.go\n text: os.Rename\n - linters:\n - containedctx\n # connCtx is cancelled when the connection is done; the context lifetime is\n # tied to the struct, not passed per-call.\n path: private/buf/buflsp/buflsp.go\n - linters:\n - containedctx\n # we actually want to embed a context here\n path: private/pkg/transport/grpc/grpcclient/client_conn_provider.go\n - linters:\n - forbidigo\n # we actually want to use errgroup when starting an HTTP server\n path: private/pkg/transport/http/httpserver/httpserver.go\n - linters:\n - staticcheck\n text: \"ST1005:\"\n - linters:\n - gochecknoinits\n # we actually want to use this init\n path: private/usage/usage.go\n - linters:\n - staticcheck\n # We deprecated all the definitions in plugin.proto but we still implement them.\n text: buf/alpha/registry/v1alpha1/plugin.proto is marked as deprecated\n - linters:\n - staticcheck\n # We deprecated all the definitions in generate.proto but we still implement them.\n text: buf/alpha/registry/v1alpha1/generate.proto is marked as deprecated\n - linters:\n - staticcheck\n # This greatly simplifies creation of descriptors, and it's safe enough since\n # it's just test code.\n text: GetDeprecatedLegacyJsonFieldConflicts is deprecated\n - linters:\n - forcetypeassert\n path: private/bufpkg/bufimage/source_retention_options_test\\.go\n - linters:\n - paralleltest\n # The LsModules tests call chdir and cannot be parallelized.\n path: cmd/buf/buf_test.go\n text: LsModules\n - linters:\n - gosec\n # G101 checks for hardcoded credentials, and the variables named \"*Token*\n # trip this off.\n path: private/pkg/oauth2/device.go\n text: \"G101:\"\n # G115 checks for integer overflow from integer conversions. There are known false\n # positives from the check (https://github.com/securego/gosec/issues/1212) that are\n # actively being worked on. Each exemption below is a false positive or for a safe operation,\n # such as parsing indices from descriptors and/or images.\n - linters:\n - gosec\n # Loop index conversion to uint64.\n path: private/buf/bufgen/features.go\n text: \"G115:\"\n - linters:\n - gosec\n # Converting result from utf8.RuneCountInString to uint64.\n path: private/bufpkg/bufcheck/bufcheckserver/internal/buflintvalidate/field.go\n text: \"G115:\"\n - linters:\n - gosec\n # PluginReference revision is validated with a bounds check at construction time.\n path: private/bufpkg/bufremoteplugin/bufremoteplugin.go\n text: \"G115:\"\n - linters:\n - gosec\n # A bounds check has been added for int32 -> uint32 conversion this is being flagged\n # as a false positive.\n path: private/buf/bufcurl/reflection_resolver.go\n text: \"G115:\"\n - linters:\n - gosec\n # bufprotosource converts indices to int32 to form the source path. Since it is parsing\n # from the fileDescriptor set, the operation should be safe.\n path: private/bufpkg/bufprotosource/paths.go\n text: \"G115:\"\n - linters:\n - gosec\n # Bounds checks have been added with assertion statements to ensure safe int -> int32\n # conversions, this is a false positive.\n path: private/bufpkg/bufprotosource/option_extension_descriptor_test.go\n text: \"G115:\"\n - linters:\n - gosec\n # This converts results from strconv.ParseInt with the bit size set to 32 to int32,\n # so it should be a safe conversion, this is a false positive.\n path: private/buf/bufprotopluginexec/version.go\n text: \"G115:\"\n - linters:\n - gosec\n # This checks the cel constraints from an Image, and converts loop indices to int32\n # to set the source path for the location, this operation should be safe.\n path: private/bufpkg/bufcheck/bufcheckserver/internal/buflintvalidate/cel.go\n text: \"G115:\"\n # No obvious deprecated replacement.\n - linters:\n - staticcheck\n path: private/pkg/protoencoding/reparse_extensions_test.go\n text: \"SA1019:\"\n - linters:\n - staticcheck\n # We still need to strip the \"weak\" option from fields until it is fully deprecated\n path: private/pkg/protoencoding/strip_legacy_options.go\n # Allow marshal and unmarshal functions in protoencoding only\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: proto.Marshal\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: proto.Unmarshal\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: protojson.Marshal\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: protojson.Unmarshal\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: protoyaml.Marshal\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: protoyaml.Unmarshal\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: prototext.Marshal\n - linters:\n - forbidigo\n path: private/pkg/protoencoding\n text: prototext.Unmarshal\n - linters:\n - gosec\n # This checks the cel constraints for predefined rules from an Image, and converts loop indices to int32\n # to set the source path for the location, this operation should be safe.\n path: private/bufpkg/bufcheck/bufcheckserver/internal/buflintvalidate/predefined_rules.go\n text: \"G115:\"\n - linters:\n - govet\n # We print command.Short to markdown, which is controlled and set by each command\n # and should be considered safe.\n path: private/bufpkg/bufcobra/markdown.go\n text: \"printf: non-constant format string in call to p\"\n - linters:\n - gosec\n # This converts slice indexes in a FileDescriptorProto to int32,\n # which are not an actual risk of overflow.\n path: private/bufpkg/bufimage/bufimageutil/image_filter.go\n text: \"G115:\"\n\nissues:\n max-same-issues: 0\nformatters:\n enable:\n - gci\n - gofmt\n exclusions:\n generated: lax\n" }, { "path": ".pre-commit-hooks.yaml", "content": "- id: buf-generate\n name: buf generate\n language: golang\n language_version: 1.25.6\n entry: buf generate\n types: [proto]\n pass_filenames: false\n- id: buf-build\n name: buf build\n language: golang\n language_version: 1.25.6\n entry: buf build\n types: [proto]\n pass_filenames: false\n- id: buf-breaking\n name: buf breaking\n language: golang\n language_version: 1.25.6\n entry: buf breaking\n types: [proto]\n pass_filenames: false\n- id: buf-lint\n name: buf lint\n language: golang\n language_version: 1.25.6\n entry: buf lint\n types: [proto]\n pass_filenames: false\n- id: buf-format\n name: buf format\n language: golang\n language_version: 1.25.6\n entry: buf format -w --exit-code\n types: [proto]\n pass_filenames: false\n- id: buf-dep-update\n name: buf dep update\n language: golang\n language_version: 1.25.6\n entry: buf dep update\n files: '(buf\\.lock|buf\\.yaml)'\n pass_filenames: false\n- id: buf-dep-prune\n name: buf dep prune\n language: golang\n language_version: 1.25.6\n entry: buf dep prune\n files: '(buf\\.lock|buf\\.yaml)'\n pass_filenames: false\n # Deprecated: use buf-dep-update instead.\n- id: buf-mod-update\n name: buf mod update\n language: golang\n language_version: 1.25.6\n entry: buf mod update\n files: '(buf\\.lock|buf\\.yaml)'\n pass_filenames: false\n # Deprecated: use buf-dep-prune instead.\n- id: buf-mod-prune\n name: buf mod prune\n language: golang\n language_version: 1.25.6\n entry: buf mod prune\n files: '(buf\\.lock|buf\\.yaml)'\n pass_filenames: false\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\n## [Unreleased]\n\n- Add support for `--rbs_out` as a `protoc_builtin` plugin (requires protoc v34.0+).\n- Add relevant links from CEL LSP hover documentation to either or \n\n## [v1.66.1] - 2026-03-09\n\n- Fix `exclude_types` in `buf generate` dropping transitive dependencies of import files retained for their extension fields.\n\n## [v1.66.0] - 2026-02-23\n\n- Add LSP comment ignore code action to add comment ignores for lint errors.\n- Fix buf breaking module comparison when adding new modules.\n- Add LSP hover support for protovalidate CEL expressions.\n- Fixed offset handling in CEL semantic tokens for non-ASCII content and proto escape sequences in multi-line string literal expressions.\n- Improve URI normalization for the LSP.\n\n## [v1.65.0] - 2026-02-03\n\n- Add `buf registry policy {commit,create,delete,info,label,settings}` commands to manage BSR policies.\n- Add LSP deprecate code action to add the deprecated option on types and symbols.\n- Fix import LSP document link to not include `import` keyword.\n- Update `PROTOVALIDATE` lint rule to support checking unenforceable `required` rules on `repeated.items`, `map.keys` and `map.values`.\n- Add `buf source edit deprecate` command to deprecate types by setting the `deprecate = true` option.\n\n## [v1.64.0] - 2026-01-19\n\n- Fix LSP completion for options.\n- Add LSP document highlighting support.\n- Add LSP completion for fully-qualified type references.\n- Improve LSP semantic tokens implementation (for syntax highlighting).\n- Add LSP organize imports code action to add missing imports, remove unused\n imports, and sort imports alphabetically.\n- Add LSP document link support.\n- Add LSP folding range support.\n- Update `PROTOVALIDATE` lint rule to support checking `cel_expression` fields for valid CEL.\n\n## [v1.63.0] - 2026-01-06\n\n- Update `PROTOVALIDATE` lint rule to support field mask rules.\n- Add LSP completion for field numbers.\n\n## [v1.62.1] - 2025-12-29\n\n- Fix default behavior for `swift_prefix` to remain unset when no override is provided in\n managed mode.\n\n## [v1.62.0] - 2025-12-29\n\n- Add `swift_prefix` to managed mode.\n- Add `textDocument/rename` and `textDocument/prepareRename` support for `buf lsp serve`.\n- Fix panic in LSP for empty option paths.\n- Fix support for multi-arch image manifests for `buf beta registry plugin push`.\n\n## [v1.61.0] - 2025-11-25\n\n- Disable format on unknown or invalid syntax.\n- Fix regression in LSP functionality for well-known types.\n- Fix browser open for `buf registry login` in WSL2.\n- Fix panic in LSP for EOF lookups.\n- Fix `--create` flag for `buf push` to avoid errors on already existing modules if create is disallowed.\n\n## [v1.60.0] - 2025-11-14\n\n- Fix LSP published diagnostics to filter to the opened file.\n- Add `textDocument/documentSymbol` support for `buf lsp serve`.\n- Fix LSP navigation for cached modules which could cause import paths to become unresolvable.\n- Update default value of `--timeout` flag to 0, which results in no timeout by default.\n- Update `PROTOVALIDATE` lint rule to allow for custom rules that do not have `id` or `message`\n fields.\n\n## [v1.59.0] - 2025-10-20\n\n- Promote `buf beta lsp` to `buf lsp serve`. Command `buf beta lsp` is now deprecated.\n- Add `textDocument/References` support for `buf lsp serve`.\n- Add autocompletion for basic keywords, syntax, package and imports for `buf lsp serve`.\n- Add workspace symbol queries for `buf lsp serve`.\n- Fix positional encoding for diagnostics in `buf lsp serve`.\n- Fix format updates for `buf lsp serve`.\n- Fix syntax highlighting on semantic tokens for `buf lsp serve`.\n- Fix `buf format` to remove extraneous whitespace before the first header node (syntax/package\n declarations).\n\n## [v1.58.0] - 2025-10-09\n\n- Update `PROTOVALIDATE` lint rule to check `IGNORE_IF_ZERO_VALUE` on fields that track presence.\n- Fix `buf format` on fields with missing field number tags.\n- Optimize `include` and `exclude` path handling for workspaces to avoid unnecessary file system\n operations. This change can result in a performance improvement for large workspaces.\n- Fix buf curl for HTTP/2 services with ` --http2-prior-knowledge` flag set.\n\n## [v1.57.2] - 2025-09-16\n\n- Fix buf curl for HTTP/2 services.\n\n## [v1.57.1] - 2025-09-16\n\n- Minor bug fixes and dependency upgrades.\n\n## [v1.57.0] - 2025-08-27\n\n- Update exclude types to remove unused options reducing the size of generated code.\n- Add `gitlab-code-quality` error format to print errors in the GitLab Code Quality format\n for `buf lint` and `buf breaking`.\n- Add `source_control_url` to `json` outputs for `buf registry {module, plugin} commit` commands.\n\n## [v1.56.0] - 2025-07-31\n\n- Add `buf export --all` flag to include non-proto source files.\n- Add s390x binaries for Linux to releases.\n- Fix ppc64le binaries for Linux released as x86_64 binaries.\n- `buf lint` will no longer warn about uses of `(buf.validate.message).disabled`, as it was\n removed in protovalidate v0.14.0. Please update to protovalidate v0.14.0 or higher, using the\n steps outlined in the\n [protovalidate release notes](https://github.com/bufbuild/protovalidate/releases/tag/v0.14.0).\n- Fix `buf breaking --against-registry` to work with new modules that have no commits on the\n default branch.\n\n## [v1.55.1] - 2025-06-17\n\n- Fix language version for pre-commit hooks.\n\n## [v1.55.0] - 2025-06-17\n\n- Promote `buf beta stats` to `buf stats`.\n- Update built-in Well-Known Types to Protobuf v31.1.\n- Add `buf registry sdk info` command.\n- Allow workspaces that are adding new module(s) with no module-specific breaking configurations\n to run `buf breaking`, ignoring new module(s).\n\n## [v1.54.0] - 2025-05-12\n\n- Add `CSR` category to breaking rules.\n- Add support for local bufplugins for `protoc-gen-buf-breaking` and `protoc-gen-buf-lint`.\n- Add RISC-V (64-bit) binaries for Linux to releases.\n- Fix type filtering on `buf generate` for empty files, files with no declared types.\n- Fix CEL check on `buf lint` for predefined `rules` variables.\n- Fix `buf config migrate` to filter out removed rules.\n- Allow users to set examples without constraints in `PROTOVALIDATE` lint rule.\n- Add ppc64le binaries for Linux to releases.\n\n## [v1.53.0] - 2025-04-21\n\n- Fix buf breaking annotations for JSON format.\n\n## [v1.52.1] - 2025-04-08\n\n- Fix language version for pre-commit hooks.\n\n## [v1.52.0] - 2025-04-07\n\n- Fix `exclude_type` on a non imported package.\n- Fix `--exclude-type` flag for `buf generate` when an input is specified.\n- Fix type filter import filtering for options.\n- Add OS environment when invoking local buf plugins.\n- Add file path to `buf lint` and `buf breaking` output even when source code info is not\n available. This allows `buf lint` and `buf breaking` to respect `ignore` and `ignore_only`\n configurations when source code info is not available.\n\n## [v1.51.0] - 2025-03-28\n\n- Fix `buf convert` to allow for zero length for `binpb`, `txtpb`, and `yaml` formats.\n- Fix use of deprecated flag `--include-types` for `buf generate`.\n- Add `--against-registry` flag to `buf breaking` that runs breaking checks against the latest\n commit on the default branch of the corresponding module in the registry.\n- Fix type filter with unused image dependencies for `buf generate`.\n- Improve type filtering for `buf generate`. Adds the ability to exclude types with the parameter\n `exclude_types` in `buf.gen.yaml` and a flag `--exclude-types` in the CLI.\n Type filters may now also be specified as plugin parameters in `buf.gen.yaml`.\n\n## [v1.50.1] - 2025-03-10\n\n- Minor fixes and dependency updates.\n\n## [v1.50.0] - 2025-01-17\n\n- Add input parameter `filter` for use with git inputs. This sets the filter\n flag argument for the git fetch command.\n\n## [v1.49.0] - 2025-01-07\n\n- Fix `buf plugin push --label` to allow pushing a plugin with a label.\n- Add `--digest-changes-only` flag to `buf registry {module,plugin} commit list` to filter\n out commits that have no digest changes.\n- Fix `buf plugin push --source-control-url` to allow pushing a plugin with the source\n control url.\n\n## [v1.48.0] - 2024-12-19\n\n- Add `buf registry plugin {create,delete,info,update}` commands to manage BSR plugins.\n- Breaking analysis support for `buf beta lsp`.\n- Fix bug when using the `--type` flag filter for `buf build` where import ordering is not\n deterministic.\n- Add `buf plugin push` command to push a plugin to the Buf Schema Registry.\n Only WebAssembly check plugins are supported at this time.\n- Add `buf plugin update` and `buf plugin prune` command to manage plugins in the `buf.lock`\n file. Only WebAssembly check plugins are supported at this time.\n- Add `buf registry plugin commit {add-label,info,list,resolve}` to manage BSR plugin commits.\n- Add `buf registry plugin label {archive,info,list,unarchive}` to manage BSR plugin commits.\n- Move `buf registry module update` to `buf registry module settings update`. Command\n `buf registry module update` is now deprecated.\n- Support remote check plugins in `buf lint` and `buf breaking` commands.\n\n## [v1.47.2] - 2024-11-14\n\n- Update the patch version to resolve NPM packaging issues. No command updates or user changes.\n\n## [v1.47.1] - 2024-11-14\n\n- Update the patch version to resolve NPM packaging issues. No command updates or user changes.\n\n## [v1.47.0] - 2024-11-13\n\n- Move `buf registry commit` to `buf registry module commit`. Command\n `buf registry commit` is now deprecated.\n- Move `buf registry label` to `buf registry module label`. Command\n `buf registry label` is now deprecated.\n\n## [v1.46.0] - 2024-10-29\n\n- Add `buf registry whoami` command, which checks if you are logged in to the Buf Schema\n Registry at a given domain.\n\n## [v1.45.0] - 2024-10-08\n\n- Update `buf registry module info --format=json` to add `default_label_name`, which provides the name\n of the default label of a module.\n\n## [v1.44.0] - 2024-10-03\n\n- Update the `PROTOVALIDATE` lint rule to check example field options. Examples will be checked that\n they satisfy the field constraints, and are only present if constraints are present.\n- Update the `PROTOVALIDATE` lint rule to check predefined rules. Predefined rules will be checked\n that they compile.\n- Add support for a WebAssembly (Wasm) runtime for custom lint and breaking changes plugins. Use the\n `.wasm` file extension to specify a path to a Wasm plugin.\n\n## [v1.43.0] - 2024-09-30\n\n- Add new experimental LSP support under `buf beta lsp`.\n\n## [v1.42.0] - 2024-09-18\n\n- Add support for custom lint and breaking change plugins. See\n [our launch blog post](https://buf.build/blog/buf-custom-lint-breaking-change-plugins)\n for more details!\n- Add `buf dep graph --format` flag that defaults to `dot`, and adds the option `json`, to print\n the dependency graph in JSON format.\n- Fix bugs in `buf format` where trailing comments on commas in message literals were not properly\n propagated to the formatted proto, empty message literals were not properly indented, and\n compound strings in options added an extra newline before trailing commas.\n\n## [v1.41.0] - 2024-09-11\n\n- Add HTTP/3 support for gRPC with `buf curl`.\n- Fix issue where errors from protoc plugins may be overwritten when executing plugins in parallel.\n\n## [v1.40.1] - 2024-09-06\n\n- Fix issue with `buf lint` where comment ignores in the shape of `// buf:lint:ignore `\n were not recognized due to the extra comment.\n\n## [v1.40.0] - 2024-09-04\n\n- Add concept of a default lint or breaking rule, which is printed out as a property when running\n `buf config ls-{breaking,lint}-rules`. Default rules are those rules which are run if no lint\n or breaking rules are explicitly configured in your `buf.yaml`.\n- Rename `DEFAULT` lint rule category to `STANDARD`. With the concept of default rules being introduced,\n having a category named `DEFAULT` is confusing, as while it happens that all the rules in the `DEFAULT`\n lint category are also default rules, the name has become overloaded. As with all `buf` changes, this\n change is backwards-compatible: the `DEFAULT` lint category continues to work, and always will. We\n recommend changing to `STANDARD`, however.\n\n## [v1.39.0] - 2024-08-27\n\n- Fix git input handling of relative HEAD refs without branch names.\n- Add `includes` key to module configurations in v2 `buf.yaml`, accepting a list of directories.\n * If `includes` is specified, a proto file is considered in the module only if it is in one of the\n directories specified.\n * If both `includes` and `excludes` keys are specified for a module, a proto file is considered\n part of this module if it is contained in any of the include paths and not in any of the exclude\n paths.\n- Allow multiple module configurations in the same v2 `buf.yaml` to have the same directory path.\n\n## [v1.38.0] - 2024-08-22\n\n- Add `--http3` flag to `buf curl` which forces `buf curl` to use HTTP/3 as the transport.\n- Fix issue with directory inputs for v2 workspaces where the specified directory was not itself\n a path to a module, but contained directories with modules, and the modules would not build.\n- Stop creating empty `buf.lock` files when `buf dep update` does not find new dependencies\n to update and there is no existing `buf.lock`.\n- Update `buf push` to push the license file or doc file (e.g. `README.md`, `LICENSE`) in the\n same directory as `buf.yaml` if a module does not have a license file or doc file in the\n module's directory.\n- Fix constraints of `--path` flag for lint and breaking rules to avoid resolving all files\n within a module. This change can result in a performance improvement for large workspaces.\n\n## [v1.37.0] - 2024-08-16\n\n- Add `STABLE_PACKAGE_NO_IMPORT_UNSTABLE` lint rule which disallows files from stable packages\n to import files from unstable packages.\n- Fix plugin push failures when pushing an image built with containerd image store.\n\n## [v1.36.0] - 2024-08-06\n\n- Add `--list-services` and `--list-methods` flags to `buf curl`, which trigger the command to list\n known services or methods in the RPC schema, instead of invoking an RPC method.\n- Add `clean` as a top-level option in `buf.gen.yaml`, matching the `buf generate --clean` flag. If\n set to true, this will delete the directories, jar files, or zip files set to `out` for each\n plugin.\n- Fix git input handling of annotated tags.\n- Update `buf registry login` to complete the login flow in the browser by default. This allows\n users to login with their browser and have the token automatically provided to the CLI.\n- Add `buf registry organization {create, delete, info, update}` commands to manage BSR\n organizations. Remove `buf beta registry organization` commands.\n- Add `buf registry module {create, delete, deprecate, info, undeprecate, update}` commands to\n manage BSR modules. Remove `buf beta registry repository` commands.\n- Add `buf registry label {archive, info, list, unarchive}` commands to manage BSR module labels.\n Remove `buf beta registry label` commands and `buf beta registry {archive, unarchive}`.\n- Add `buf registry commit {add-label, info, list, resolve}` to manage BSR module commits. Remove\n `buf beta registry commit` commands.\n\n## [v1.35.1] - 2024-07-24\n\n- Fix the git input parameter `ref` to align with the `git` notion of a ref. This allows for the use\n of branch names, tag names, and commit hashes.\n- Fix unexpected `buf build` errors with absolute path directory inputs without workspace and/or\n module configurations (e.g. `buf.yaml`, `buf.work.yaml`) and proto file paths set to the `--path` flag.\n\n## [v1.35.0] - 2024-07-22\n\n- Add `buf generate --clean` flag that will delete the directories, jar files, or zip files that the\n plugins will write to, prior to generation. Allows cleaning of existing assets without having\n to call `rm -rf`.\n- Deprecate `--username` flag on and username prompt on `buf registry login`. A username is no longer\n required to log in.\n\n## [v1.34.0] - 2024-06-21\n\n- Add `buf config ls-modules` command to list configured modules.\n- Fix issue where `buf generate` would succeed on missing insertion points and\n panic on empty insertion point files.\n- Update `buf generate` to allow the use of Editions syntax when doing local code\n generation by proxying to a `protoc` binary (for languages where code gen is\n implemented inside of `protoc` instead of in a plugin: Java, C++, Python, etc).\n- Allow use of an array of strings for the `protoc_path` property of for `buf.gen.yaml`,\n where the first array element is the actual path and other array elements are extra\n arguments that are passed to `protoc` each time it is invoked.\n\n## [v1.33.0] - 2024-06-13\n\n- Allow user to override `--source-control-url` and `--create-default-label` when using\n `--git-metadata` with `buf push`.\n- Fix `buf push --git-metadata` when local tags point to different objects than\n the remote tags.\n- Fix issue where comment ignores were not respected for `PROTOVALIDATE` lint rule violations.\n- Add `buf beta registry label {create,get,list}` to replace `buf beta registry {draft, tag}`\n commands.\n- Update `buf beta commit {get,list}` command outputs to display create time and stop\n displaying associated tags.\n- Change the behavior of `buf beta commit list ` when the\n reference is empty. It now lists commits in the repository instead of listing commits\n of the default label.\n- Update output of `buf format` to canonicalize the punctuation used in message literals\n in option values. The output now always uses `{` and `}` instead of `<` and `>`; it\n adds `:` separators between field names and message values if the source omitted them,\n and it removes unnecessary separators between fields (`,` and `;` are allowed, but\n neither is needed).\n- Update `buf format -w` so that it does not touch files whose contents don't actually\n change. This eliminates noisy notifications to file-system-watcher tools that are\n watching the directory that contains proto sources.\n- Update `buf generate` to work with plugins provided by protoc for versions v24.0\n to v25.3. Editions support was experimental in these releases, and the plugins\n advertise incomplete support for editions, which triggers `buf` to report an error.\n With this fix, these plugins can be used again as long as none of the input files use\n editions syntax.\n- Add `buf push --exclude-unnamed` flag to exclude unnamed modules when pushing to the BSR.\n\n## [v1.32.2] - 2024-05-28\n\n- Update `buf generate` to warn instead of error when proto3 optional is required but not\n supported by a plugin.\n\n## [v1.32.1] - 2024-05-21\n\n- Fix archive and git inputs so that `--path` and `--exclude-path` paths are relative to\n the `#subdir` rather than the root of the input. This fixes an unintended behavior change\n that was introduced in `v1.32.0`.\n- Add `module` input for `protoc-gen-buf-lint` and `protoc-gen-buf-breaking` to allow\n users to specify the module for `v2` configuration files.\n\n## [v1.32.0] - 2024-05-16\n\n- Add version `v2` for `buf.yaml` and `buf.gen.yaml` configuration files.\n- Add `buf config migrate` to migrate configuration files to the latest version (now `v2`).\n- Move `buf mod init` to `buf config init`. `buf mod init` is now deprecated.\n- Move `buf mod ls-lint-rules` to `buf config ls-lint-rules`. `buf mod ls-lint-rules` is now\n deprecated.\n- Move `buf mod ls-breaking-rules` to `buf config ls-breaking-rules`. `buf mod ls-breaking-rules`\n is now deprecated.\n- Move `buf mod prune` to `buf dep prune`. `buf mod prune` is now deprecated.\n- Move `buf mod update` to `buf dep update`. `buf mod update` is now deprecated.\n- Move `buf mod {clear-cache,cc}` to `buf registry cc`. `buf mod {clear-cache,cc}` is now\n deprecated.\n- Move `buf beta graph` to stable as `buf dep graph`.\n- Change the default visibility of `buf push --create-visibility` to `private` when the `--create`\n flag is set. Users are no longer required to set `--create-visibility` when running\n `buf push --create`.\n- Add `buf push --label`, which allows users to set labels when pushing new commits to the BSR.\n- Add `buf push --source-control-url`, which allows users to associate commits pushed to the BSR\n with a URL to a source code repository.\n- Add `buf push --create-default-label`, which allows users to set a default label for a repository\n when calling `buf push --create`.\n- Add `buf push --git-metadata`, which automatically sets appropriate `--label`,\n `--source-control-url`, and `--create-default-label` flags based on the current Git repository.\n- Add `buf convert --validate` to apply [protovalidate](https://github.com/bufbuild/protovalidate)\n rules to incoming messages specified with `--from`.\n- Deprecate `buf mod open`.\n- Delete `buf beta migrate-v1beta1` This is now replaced with `buf config migrate`.\n- Add `buf registry sdk version` to get the version of a Generated SDK for a module and plugin.\n- Add `buf beta registry archive` and `buf beta registry unarchive` commands for archiving and\n unarchiving labels on the BSR.\n- Add support for Protobuf Editions. This allows `buf` to be used with sources that use edition\n 2023, instead of proto2 or proto3 syntax. This also updates the `protoc-gen-buf-breaking` and\n `protoc-gen-buf-lint` Protobuf plugins to support files that use edition 2023.\n- Update `buf breaking` rules to work with Protobuf Editions. To support Editions, some rules have\n been deprecated and replaced with Editions-aware rules. All deprecated rules continue to work\n for existing users.\n * `FIELD_SAME_CTYPE` has been replaced with `FIELD_SAME_CPP_STRING_TYPE`, which considers both\n `ctype` field options and new `(pb.cpp).string_type` features when deciding on backwards\n compatibility.\n * `FIELD_SAME_LABEL` has been replaced with three rules that all check \"cardinality\". The new\n rules can distinguish between maps and other repeated fields and between implicit and explicit\n field presence. The new rules are:\n 1. `FIELD_SAME_CARDINALITY` in the `FILE` and `PACKAGE` categories.\n 2. `FIELD_WIRE_COMPATIBLE_CARDINALITY` in the `WIRE` category.\n 3. `FIELD_WIRE_JSON_COMPATIBLE_CARDINALITY` in the `WIRE_JSON` category.\n * `FILE_SAME_JAVA_STRING_CHECK_UTF8` has been replaced with `FIELD_SAME_JAVA_UTF8_VALIDATION`,\n which considers both the `java_string_check_utf8` file option and `(pb.java).utf8_validation`\n features when deciding on backwards compatibility.\n * Add to the existing `FILE_SAME_SYNTAX` rule with a few related rules that can catch the same\n sort of compatibility issues, but in an Editions source file that changes feature values:\n 1. `MESSAGE_SAME_JSON_FORMAT` and `ENUM_SAME_JSON_FORMAT` catch changes to the `json_format`\n feature, which controls whether support for the JSON format is best-effort or properly\n supported. When supported, the compiler performs more checks relating to field name\n collisions for the JSON format as well as for FieldMask usage.\n 2. `FIELD_SAME_UTF8_VALIDATION` catches changes to the `utf8_validation` feature, which\n controls validation of string values.\n 3. `ENUM_SAME_TYPE` catches changes to an enum's type, open vs. closed.\n- Add support for extensions to `buf breaking`. All existing rules for fields are now applied to\n extensions, except for `FIELD_NO_DELETE` (and its variants). There are also new\n `EXTENSION_NO_DELETE` and `PACKAGE_EXTENSION_NO_DELETE` rules for catching deletions of an\n extension. The new rules are not active by default in existing `v1` and `v1beta1`\n configurations, for backwards-compatibility reasons. Migrate your config to `v2` to use them.\n- Add support for top-level extensions to `buf lint`. It previously only checked extensions that\n were defined inside of messages.\n- Add a new `FIELD_NOT_REQUIRED` lint rule that prevents use of required in proto2 files and of\n `features.field_presence = LEGACY_REQUIRED` in Editions files. This new rule is not active by\n default in existing `v1` and `v1beta1` configurations, for backwards-compatibility reasons.\n Migrate your config to `v2` to use them.\n\n## [v1.32.0-beta.1] - 2024-04-23\n\n- Add `buf convert --validate` to apply [protovalidate](https://github.com/bufbuild/protovalidate)\n rules to incoming messages specified with `--from`.\n- Add `buf config migrate` to migrate configuration files to the latest version (now `v2`).\n- Promote `buf beta graph` to stable as `buf dep graph`.\n- Move `buf mod init` to `buf config init`. `buf mod init` is now deprecated.\n- Move `buf mod ls-lint-rules` to `buf config ls-lint-rules`. `buf mod ls-lint-rules` is now deprecated.\n- Move `buf mod ls-breaking-rules` to `buf config ls-breaking-rules`. `buf mod ls-breaking-rules` is now deprecated.\n- Move `buf mod prune` to `buf dep prune`. `buf mod prune` is now deprecated.\n- Move `buf mod update` to `buf dep update`. `buf mod update` is now deprecated.\n- Move `buf mod {clear-cache,cc}` to `buf registry cc`. `buf mod {clear-cache,cc}` is now deprecated.\n- Deprecate `buf mod open`.\n- Delete `buf beta migrate-v1beta1`.\n- Add `buf registry sdk version` to get the version of a Generated SDK for a module and plugin.\n\n## [v1.31.0] - 2024-04-23\n\n- Update dependencies.\n\n## [v1.30.1] - 2024-04-03\n\n- Fix issue where `buf lint` incorrectly reports an error for `(buf.validate.field).repeated`\n is set for a repeated validation rule.\n\n## [v1.30.0] - 2024-03-07\n\n- Update `buf generate` so it populates the recently-added\n [`source_file_descriptors`](https://github.com/protocolbuffers/protobuf/blob/v24.0/src/google/protobuf/compiler/plugin.proto#L96-L99)\n field of the `CodeGeneratorRequest` message. This provides the plugin with access to options\n that are configured to only be retained in source and not at runtime (via\n [field option](https://github.com/protocolbuffers/protobuf/blob/v24.0/src/google/protobuf/descriptor.proto#L693-L702)).\n Descriptors in the `proto_file` field will not include any options configured this way\n for the files named in `file_to_generate` field.\n- Add `--exclude-source-retention-options` flag to `buf build`, which\n causes options configured to only be retained in source to be stripped\n from the output descriptors.\n\n## [v1.29.0] - 2024-01-24\n\n- Add support for `yaml` format. All commands that take image inputs, output images,\n or convert between message formats, now take `yaml` as a format, in addition to\n the existing `binpb` and `txtpb` formats. Some examples:\n - `buf build -o image.yaml`\n - `buf ls-files image.yaml`\n - `buf convert --type foo.Bar --from input.binpb --to output.yaml`\n- The `yaml` and `json` formats now accept two new options: `use_proto_names` and\n `use_enum_numbers`. This affects output serialization. Some examples:\n - `buf convert --type foo.Bar --from input.binpb --to output.yaml#use_proto_names=true`\n - `buf convert --type foo.Bar --from input.binpb --to -#format=yaml,use_enum_numbers=true`\n- Fix issue where `buf format` would inadvertently mangle files that used\n the [expanded `Any` syntax](https://protobuf.com/docs/language-spec#any-messages)\n in option values.\n\n## [v1.28.1] - 2023-11-15\n\n- The `buf curl` command has been updated to support the use of multiple schemas.\n This allows users to specify multiple `--schema` flags and/or to use both `--schema`\n and `--reflect` flags at the same time. The result is that additional sources can\n be consulted to resolve an element. This can be useful when the result of an RPC\n contains extensions or values in `google.protobuf.Any` messages that are not defined\n in the same schema that defines the RPC service.\n- Fix issue where `buf lint` incorrectly reports error when `(buf.validate.field).required`\n is set for an optional field in proto3.\n\n## [v1.28.0] - 2023-11-10\n\n- Add lint rules for [protovalidate](https://github.com/bufbuild/protovalidate). `buf lint`\n will now verify that your protovalidate rules are valid. A single rule `PROTOVALIDATE` has been\n added to the `DEFAULT` group - given that protovalidate is net new, this does not represent\n a breaking change.\n- Update `buf beta price` with the latest pricing information.\n- Display a warning when reading a `buf.lock` with dependencies with b1 or b3 digests. b1 and b3\n digests will be deprecated in a future version. Run `buf mod update` to update dependency digests.\n\n## [v1.27.2] - 2023-10-27\n\n- Fix issue where `buf build` and other commands may fail when handling certain\n archives created on macOS that contain files with extended attributes.\n\n## [v1.27.1] - 2023-10-16\n\n- Fix issue in v1.27.0 where `--path` did not work with workspaces under certain scenarios.\n\n## [v1.27.0] - 2023-10-04\n\n- Fix issue where `buf generate --exclude-path` was not properly excluding paths\n for remote modules.\n- Fix issue where `buf curl` had a user agent that did not properly place the\n extension as a suffix.\n- Update `buf beta price` with the latest pricing information.\n\n## [v1.26.1] - 2023-08-09\n\n- Fix issue where `buf build -o` did not properly output files with the `.txtpb`\n extension in Protobuf text format.\n\n## [v1.26.0] - 2023-08-09\n\n- Add support for the `--http2-prior-knowledge` flag when running `buf curl`\n against secure \"https\" URLs. This can be used with gRPC servers, that only\n support HTTP/2, when used with a network (layer 4) load balancer, that does\n not support protocol negotiation in TLS handshake.\n\n## [v1.25.1] - 2023-08-02\n\n- Fix issue where all files were being iterated over when using the `--path` flag.\n- Fix issue where the directory `.` was incorrectly accepted as a value for the\n `directories` key in `buf.work.yaml`.\n\n## [v1.25.0] - 2023-07-18\n\n- Add `txtpb` format to handle the Protobuf text format. and automatically recognize\n `.txtpb` files as Protobuf text files. The `txtpb` format can now be used with\n all `buf` commands that take images as input or output, such as `build`, `convert`,\n and `curl`.\n\n## [v1.24.0] - 2023-07-13\n\n- Update `buf mod update` to block updates that will result in conflicting `.proto`\n files across dependencies.\n- Replace `bin` format with `binpb` format, and support the `.binpb` file extension.\n `.binpb` is now the canonical file extension for binary-encoded Protobuf data.\n The `bin` format and the `.bin` file extension continue to be accepted.\n- Remove support for `go` subdomain in `.netrc`. This was used as part of the\n remote generation alpha, which has been fully deprecated in favor of remote\n plugins and remote packages. See https://buf.build/blog/remote-packages-remote-plugins-approaching-v1\n for more details.\n- Update `buf beta price` with the latest pricing information.\n\n## [v1.23.1] - 2023-06-30\n\n- Fix issue where `buf beta graph` would not print modules within a workspace that\n had no dependencies or dependents.\n- Fix issue where `buf beta graph` would print warnings for missing dependencies\n that were actually present.\n\n## [v1.23.0] - 2023-06-29\n\n- Add `buf beta graph` to print the dependency graph for a module in DOT format.\n- Various small bug fixes.\n\n## [v1.22.0] - 2023-06-23\n\n- Change default for `--origin` flag of `buf beta studio-agent` to `https://buf.build`\n\n## [v1.21.0] - 2023-06-05\n\n- Fix issue where locally-produced images did not have module information if the corresponding\n module was stored in the new cache.\n- Remove `buf beta registry template`.\n- Remove `buf beta registry plugin {create,deprecate,list,undeprecate,version}` and replace with\n `buf beta registry plugin {push,delete}`.\n- Update `buf beta price` with the latest pricing information.\n\n## [v1.20.0] - 2023-05-30\n\n- Add `--emit-defaults` flag to `buf curl` to emit default values in JSON-encoded responses.\n- Indent JSON-encoded responses from `buf curl` by default.\n- Log a warning in case an import statement does not point to a file in the module, a file in a\n direct dependency, or a well-known type file.\n\n## [v1.19.0] - 2023-05-17\n\n- Add `--create` flag to `buf push` to create a repository if it does not exist. The user\n is also required to specify the visibility using `--create-visibility`.\n- Add `github-actions` error format to print errors in a form parseable by GitHub Actions.\n- Fix issue in `buf build` and `buf generate` where the use of type filtering (via\n `--type` flags) would cause the resulting image to have no source code info, even\n when `--exclude-source-info` was not specified. The main impact of the bug was that\n generated code would be missing comments.\n- Fix issue in `buf curl` when using `--user` or `--netrc` that would cause a malformed\n Authorization header to be sent.\n- Update the module cache to use an optimized content addressable store. The cache is\n now self-healing and uses significantly less space. Users wishing to free unused space\n can run `buf mod --clear-cache` once after upgrading to remove data stored in the\n previous module cache.\n\n## [v1.18.0] - 2023-05-05\n\n- Remove `buf beta registry {plugin,template} {deprecate,undeprecate}`.\n- Add `--user` and `--netrc` flags to `buf curl`, providing the same behavior as the\n flags of the same name in the cURL tool.\n- Include `DocumentationPath` in the module on `buf push`.\n- Support fallback paths, `README.md` and `README.markdown`, for module documentation.\n The default source for module documentation is `buf.md`.\n If `buf.md` is missing, `README.md` or `README.markdown` is used as fallback sources.\n\n## [v1.17.0] - 2023-04-05\n\n- Fix issue with JSON marshalling of errors where line and column fields were\n omitted when line and column information was empty.\n- Fix issue with MSVS marshalling of errors where the column could be 0.\n- Add `buf beta stats` command to print statistics about a given source or module.\n- Update `buf beta price` with the latest pricing information.\n\n## [v1.16.0] - 2023-03-29\n\n- Add `buf beta price` command to help users of the BSR figure out how much a module\n will cost to store on the BSR under the Teams or Pro plans.\n- Fix issue in `protoc-gen-buf-lint` that prevented it from reporting lint\n errors for unused imports.\n- Fix issue with `buf format` where indents would be produced on certain empty lines.\n- Remove `buf alpha registry token create` command. Tokens must be created through the BSR UI.\n- Add local WASM plugin support in alpha, gated by the `BUF_ALPHA_ENABLE_WASM` environment variable.\n This feature is under evaluation, and may change at any time. If you are interested in WASM\n Protobuf plugins, reach out to us.\n\n## [v1.15.1] - 2023-03-08\n\n- Fix bug in `buf generate` with `v1beta1` config files.\n- Fix potential crash when using the `--type` flag with `buf build` or `buf generate`.\n\n## [v1.15.0] - 2023-02-28\n\n- Update built-in Well-Known Types to Protobuf v22.0.\n- Fix bug in `buf format` where C-style block comments in which every\n line includes a prefix (usually \"*\") would be incorrectly indented.\n- Add `--private-network` flag to `buf beta studio-agent` to support handling CORS requests\n from Studio on private networks that set the `Access-Control-Request-Private-Network` header.\n\n## [v1.14.0] - 2023-02-09\n\n- Replace `buf generate --include-types` with `buf generate --type` for consistency. `--include-types`\n is now deprecated but continues to work, consistent with our compatibility guarantee.\n- Include type references in `google.protobuf.Any` messages in option values\n when filtering on type, e.g. with `buf build --type` or `buf generate --type`.\n- Allow specifying a specific `protoc` path in `buf.gen.yaml` when using `protoc`'s built-in plugins\n via the new `protoc_path` option.\n- Allow specifying arguments for local plugins in `buf.gen.yaml`. You can now do e.g.\n `path: [\"go, \"run\", ./cmd/protoc-gen-foo]` in addition to `path: protoc-gen-foo`.\n- Add optional name parameter to `buf mod init`, e.g. `buf mod init buf.build/owner/foobar`.\n- Fix issue with `php_metadata_namespace` file option in [managed mode](https://docs.buf.build/generate/managed-mode).\n- Make all help documentation much clearer. If you notice any inconsistencies, let us know.\n\n## [v1.13.1] - 2023-01-27\n\n- Fix race condition with `buf generate` when remote plugins from multiple\n BSR instances are being used at once.\n\n## [v1.13.0] - 2023-01-26\n\n- Extend the `BUF_TOKEN` environment variable to accept tokens for multiple\n BSR instances. Both `TOKEN` and `TOKEN1@BSRHOSTNAME1,TOKEN2@BSRHOSTNAME2,...`\n are now valid values for `BUF_TOKEN`.\n- Remove `buf beta convert` in favor of the now-stable `buf convert`.\n\n## [v1.12.0] - 2023-01-12\n- Add `buf curl` command to invoke RPCs via [Connect](https://connect-build),\n [gRPC](https://grpc.io/), or [gRPC-Web](https://github.com/grpc/grpc-web.)\n- Introduce `objc_class_prefix` option in managed mode, allowing a `default` value\n for `objc_class_prefix` for all files, `except` and `override`, which both behave\n similarly to other `except` and `override` options. Specifying an empty `default`\n value is equivalent to having managed mode on in previous versions.\n- Introduce `ruby_package` option in managed mode, allowing `except` and `override`,\n in the same style as `objc_class_prefix`. Leaving `ruby_package` unspecified has\n the same effect as having mananged mode enabled in previous versions.\n\n## [v1.11.0] - 2022-12-19\n- `buf generate` now batches remote plugin generation calls for improved performance.\n- Update `optimize_for` option in managed mode, allowing a `default` value for `optimize_for`\n for all files, `except` and `override`, which both behave similarly to other `except`\n and `override` options. Specifying an `optimize_for` value in the earlier versions is\n equivalent to having a `optimize_for` with that value as default.\n\n## [v1.10.0] - 2022-12-07\n\n- When using managed mode, setting `enabled: false` now no longer fails `buf generate`\n and instead prints a warning log and ignores managed mode options.\n- Add `csharp_namespace` option to managed mode, allowing `except`, which excludes\n modules from managed mode, and `override`, which specifies `csharp_namespace` values\n per module, overriding the default value. By default, when managed mode is enabled,\n `csharp_namespace` is set to the package name with each package sub-name capitalized.\n- Promote `buf convert` to stable, keep `buf beta convert` aliased in the beta command.\n- Add `Types` filter to `buf generate` command to specify types (message, enum,\n service) that should be included in the image. When specified, the resulting\n image will only include descriptors to describe the requested types.\n\n## [v1.9.0] - 2022-10-19\n\n- New compiler that is faster and uses less memory than the outgoing one.\n - When generating source code info, the new compiler is 20% faster, and allocates\n 13% less memory.\n - If _not_ generating source code info, the new compiler is 50% faster and\n allocates 35% less memory.\n - In addition to allocating less memory through the course of a compilation, the\n new compiler releases some memory much earlier, allowing it to be garbage\n collected much sooner. This means that by the end of a very large compilation\n process, less than half as much memory is live/pinned to the heap, decreasing\n overall memory pressure.\n\n The new compiler also addresses a few bugs where Buf would accept proto sources\n that protoc would reject:\n - In proto3 files, field and enum names undergo a validation that they are\n sufficiently different so that there will be no conflicts in JSON names.\n - Fully-qualified names of elements (like a message, enum, or service) may not\n conflict with package names.\n - A oneof or extend block may not contain empty statements.\n - Package names may not be >= 512 characters in length or contain > 100 dots.\n - Nesting depth of messages may not be > 32.\n - Field types and method input/output types may not refer to synthetic\n map entry messages.\n- Push lint and breaking configuration to the registry.\n- Include `LICENSE` file in the module on `buf push`.\n- Formatter better edits/preserves whitespace around inline comments.\n- Formatter correctly indents multi-line block (C-style) comments.\n- Formatter now indents trailing comments at the end of an indented block body\n (including contents of message and array literals and elements in compact options)\n the same as the rest of the body (instead of out one level, like the closing\n punctuation).\n- Formatter uses a compact, single-line representation for array and message literals\n in option values that are sufficiently simple (single scalar element or field).\n- `buf beta convert` flags have changed from `--input` to `--from` and `--output`/`-o` to `--to`\n- fully qualified type names now must be parsed to the `input` argument and `--type` flag separately\n\n## [v1.8.0] - 2022-09-14\n\n- Change default for `--origin` flag of `buf beta studio-agent` to `https://studio.buf.build`\n- Change default for `--timeout` flag of `buf beta studio-agent` to `0` (no timeout). Before it was\n `2m` (the default for all the other `buf` commands).\n- Add support for experimental code generation with the `plugin:` key in `buf.gen.yaml`.\n- Preserve single quotes with `buf format`.\n- Support `junit` format errors with `--error-format`.\n\n## [v1.7.0] - 2022-06-27\n\n- Support protocol and encoding client options based on content-type in Studio Agent.\n- Add `--draft` flag to `buf push`.\n- Add `buf beta registry draft {list,delete}` commands.\n\n## [v1.6.0] - 2022-06-21\n\n- Fix issue where `// buf:lint:ignore` comment ignores did not work for the\n `ENUM_FIRST_VALUE_ZERO` rule.\n- Add `buf beta studio-agent` command to support the upcoming Buf Studio.\n\n## [v1.5.0] - 2022-05-30\n\n- Upgrade to `protoc` 3.20.1 support.\n- Fix an issue where `buf` would fail if two or more roots contained\n a file with the same name, but with different file types (i.e. a\n regular file vs. a directory).\n- Fix check for `PACKAGE_SERVICE_NO_DELETE` to detect deleted services.\n- Remove `buf beta registry track`.\n- Remove `buf beta registry branch`.\n\n## [v1.4.0] - 2022-04-21\n\n- Fix issue where duplicate synthetic oneofs (such as with proto3 maps or\n optional fields) did not result in a properly formed error.\n- Add `buf beta registry repository update` command which supports updating\n repository visibility (public vs private). As with all beta commands, this\n is likely to change in the future.\n\n## [v1.3.1] - 2022-03-30\n\n- Allow `--config` flag to be set when targeting a module within a workspace.\n- Update `buf format`'s file option order so that default file options are\n sorted before custom options.\n- Update `buf format` to write adjacent string literals across multiple lines.\n- Fix `buf format` so that the output directory (if any) is created if and only\n if the input is successfully formatted.\n\n## [v1.3.0] - 2022-03-25\n\n- Add `--exit-code` flag to `buf format` to exit with a non-zero exit code if\n the files were not already formatted.\n\n## [v1.2.1] - 2022-03-24\n\n- Fix a few formatting edge cases.\n\n## [v1.2.0] - 2022-03-24\n\n- Add `buf format` command to format `.proto` files.\n- Fix build scripts to avoid using the `command-line-arguments` pseudo-package\n when building binaries and re-introduce checking for proper usage of private\n packages.\n\n## [v1.1.1] - 2022-03-21\n\n- Remove check for proper usage of private packages due to a breaking change made in the Golang standard library in 1.18.\n\n## [v1.1.0] - 2022-03-01\n- Add `--type` flag to the `build` command to create filtered images containing\n only the specified types and their required dependencies.\n- Trim spaces and new lines from user-supplied token for `buf registry login`.\n- Add support for conversion between JSON and binary serialized message for `buf beta convert`.\n\n## [v1.0.0] - 2022-02-17\n\n- Check that the user provided a valid token when running `buf registry login`.\n- Add `buf mod open` that opens a module's homepage in a browser.\n- Add `buf completion` command to generate auto-completion scripts in commonly used shells.\n- Add `--disable-symlinks` flag to the `breaking, build, export, generate, lint, ls-files, push`\n commands. By default, the CLI will follow symlinks except on Windows, and this disables following\n symlinks.\n- Add `--include-wkt` flag to `buf generate`. When this flag is specified alongside\n `--include-imports`, this will result in the [Well-Known Types](https://github.com/bufbuild/wellknowntypes/tree/11ea259bf71c4d386131c1986ffe103cb1edb3d6/v3.19.4/google/protobuf)\n being generated as well. Most language runtimes have the Well-Known Types included as part\n of the core library, making generating the Well-Known Types separately undesirable.\n- Remove `buf protoc`. This was a pre-v1.0 demonstration to show that `buf` compilation\n produces equivalent results to mainline `protoc`, however `buf` is working on building\n a better Protobuf future that provides easier mechanics than our former `protoc`-based\n world. `buf protoc` itself added no benefit over mainline `protoc` beyond being considerably\n faster and allowing parallel compilation. If `protoc` is required, move back to mainline `protoc`\n until you can upgrade to `buf`. See [#915](https://github.com/bufbuild/buf/pull/915) for more\n details.\n- Context modifier no longer overrides an existing token on the context. This allows `buf registry login`\n to properly check the user provided token without the token being overridden by the CLI interceptor.\n- Removed the `buf config init` command in favor of `buf mod init`.\n- Removed the `buf config ls-breaking-rules` command in favor of `buf mod ls-breaking-rules`.\n- Removed the `buf config ls-lint-rules` command in favor of `buf mod ls-lint-rules`.\n- Removed the `buf config migrate-v1beta1` command in favor of `buf beta migrate-v1beta1`.\n- Add `buf beta decode` command to decode message with provided image source and message type.\n- Disable `--config` flag for workspaces.\n- Move default config version from `v1beta1` to `v1`.\n\n## [v1.0.0-rc12] - 2022-02-01\n\n- Add `default`, `except` and `override` to `java_package_prefix`.\n- Add dependency commits as a part of the `b3` digest.\n- Upgrade to `protoc` 3.19.4 support.\n- Remove `branch` field from `buf.lock`.\n\n## [v1.0.0-rc11] - 2022-01-18\n\n- Upgrade to `protoc` 3.19.3 support.\n- Add `PACKAGE_NO_IMPORT_CYCLE` lint rule to detect package import cycles.\n- Add `buf beta registry {plugin,template} {deprecate,undeprecate}`.\n- Add warning when using enterprise dependencies without specifying a enterprise\n remote in the module's identity.\n- Remove `digest`, and `created_at` fields from the `buf.lock`. This will temporarily create a new commit\n when pushing the same contents to an existing repository, since the `ModulePin` has been reduced down.\n- Add `--track` flag to `buf push`\n- Update `buf beta registry commit list` to allow a track to be specified.\n- Add `buf beta registry track {list,delete}` commands.\n- Add manpages for `buf`.\n\n## [v1.0.0-rc10] - 2021-12-16\n\n- Fix issue where remote references were not correctly cached.\n\n## [v1.0.0-rc9] - 2021-12-15\n\n- Always set `compiler_version` parameter in the `CodeGeneratorRequest` to \"(unknown)\".\n- Fix issue where `buf mod update` was unable to resolve dependencies from different remotes.\n- Display the user-provided Buf Schema Registry remote, if specified, instead of the default within the `buf login` message.\n- Fix issue where `buf generate` fails when the same plugin was specified more than once in a single invocation.\n- Update the digest algorithm so that it encodes the `name`, `lint`, and `breaking` configuration encoded in the `buf.yaml`.\n When this change is deployed, users will observe the following:\n - Users on `v0.43.0` or before will notice mismatched digest errors similar to the one described in https://github.com/bufbuild/buf/issues/661.\n - Users on `v0.44.0` or after will have their module cache invalidated, but it will repair itself automatically.\n - The `buf.lock` (across all versions) will reflect the new `b3-` digest values for new commits.\n\n## [v1.0.0-rc8] - 2021-11-10\n\n- Add new endpoints to the recommendation service to make it configurable.\n- Add `--exclude-path` flag to `buf breaking`, `buf build`, `buf export`, `buf generate`, and `buf lint` commands. This allows users to exclude specific paths when running commands.\n- Change `GetModulePackages` endpoint to return a repeated `ModulePackage` message that now includes package description with the package name.\n- Add `Oneof` to the `Message` structure for documentation.\n\n## [v1.0.0-rc7] - 2021-11-08\n\n- Upgrade to `protoc` 3.19.1 support.\n- Fix issue with `buf generate` where multiple insertion points are defined in the same file.\n\n## [v1.0.0-rc6] - 2021-10-20\n\n- Fix issue with `buf ls-files` when given an image as an input, imports were being printed,\n even without the `--include-imports` flag.\n- Add the ability for users to provide individual protobuf files as inputs to CLI commands. This allows users to run `buf` commands against and file input based on their current working directory, for example, `buf lint foo/bar.proto`, where `foo/bar.proto` is a path to protobuf file on disk.\n\n## [v1.0.0-rc5] - 2021-10-12\n\n- Add `buf beta registry repository deprecate` and `buf beta registry repository undeprecate`.\n- Support `--include-imports` for remote plugins.\n- Fix issue where `buf config migrate-v1beta1 fails` when files cannot be renamed.\n- Fix issue where `buf registry login` panics when an existing .netrc entry exists.\n\n## [v1.0.0-rc4] - 2021-10-07\n\n- Fix issue where `buf generate` could fail when used with large numbers of plugins and files on\n systems with low file limits.\n- Add `buf protoc --version` flag back. This was accidentally removed.\n- Upgrade to `protoc` 3.18.1 support.\n\n## [v1.0.0-rc3] - 2021-10-04\n\n- Add `--as-import-paths` flag to `ls-files` that strips local directory paths and prints file\n paths as they are imported.\n- Fix issue where groups used in custom options did not result in the same behavior as `protoc`.\n- Fix issue where insertion points were not applied with respect to the configured output directory.\n\n## [v1.0.0-rc2] - 2021-09-23\n\n- Add `--include-imports` flag to `ls-files`.\n- Upgrade to `protoc` 3.18.0 support.\n- Fix regression with git inputs using `recurse_submodules=true`.\n\n## [v1.0.0-rc1] - 2021-09-15\n\nThis is our first v1.0 release candidate. This release largely concentrates on erroring for\nalready-deprecated commands and flags.\n\nAt Buf, we take compatibility very seriously. When we say v1.0, we mean it - we hope `buf` will be\nstable on v1 for the next decade, and if there is something we want to change, it is our responsibility to\nmake sure that we don't break you, not your responsibility to change because of us. We have learned\na lot about `buf` usage in the last two years of our beta, and have deprecated flags and commands as\nwe go, but for v1.0, we are removing the deprecated items to make sure we have a clean setup going forward.\n\nAll commands and flags have been printing warnings for a long time, and have an easy migration path.\nSimply update the command or flag, and you'll be good to go:\n\n- Removed the `buf login` command in favor of `buf registry login`.\n- Removed the `buf logout` command in favor of `buf registry logout`.\n- Removed the `buf mod init` command in favor of `buf config init`.\n- Removed the `--name` and `--dep` flags in `buf config init`.\n- Removed the `--log-level` global flag.\n- Moved the output of `--version` from stderr to stdout.\n- Moved the output of `--help` and `help` from stderr to stdout.\n- [From v0.55.0](https://github.com/bufbuild/buf/releases/tag/v0.55.0): The version key in all configuration files (`buf.yaml`, `buf.gen.yaml`, `buf.work.yaml`) is now required.\n- [From v0.45.0](https://github.com/bufbuild/buf/releases/tag/v0.45.0): Removed the `buf beta config init` command in favor of `buf config init`.\n- [From v0.45.0](https://github.com/bufbuild/buf/releases/tag/v0.45.0): Removed the `buf beta mod export` command in favor of `buf export`.\n- [From v0.45.0](https://github.com/bufbuild/buf/releases/tag/v0.45.0): Removed the `buf beta mod init` command in favor of `buf config init`.\n- [From v0.45.0](https://github.com/bufbuild/buf/releases/tag/v0.45.0): Removed the `buf beta mod update` command in favor of `buf mod update`.\n- [From v0.45.0](https://github.com/bufbuild/buf/releases/tag/v0.45.0): Removed the `buf beta mod clear-cache` command in favor of `buf mod clear-cache`.\n- [From v0.45.0](https://github.com/bufbuild/buf/releases/tag/v0.45.0): Removed the `buf beta push` command in favor of `buf push`.\n- [From v0.34.0](https://github.com/bufbuild/buf/releases/tag/v0.34.0): Removed the `buf check breaking` command in favor of `buf breaking`.\n- [From v0.34.0](https://github.com/bufbuild/buf/releases/tag/v0.34.0): Removed the `buf check lint` command in favor of `buf lint`.\n- [From v0.34.0](https://github.com/bufbuild/buf/releases/tag/v0.34.0): Removed the `buf check ls-lint-checkers` command in favor of `buf config ls-lint-rules`.\n- [From v0.34.0](https://github.com/bufbuild/buf/releases/tag/v0.34.0): Removed the `buf check ls-breaking-checkers` command in favor of `buf config ls-breaking-rules`.\n- [From v0.31.0](https://github.com/bufbuild/buf/releases/tag/v0.31.0): Removed the `--file` flag on `buf build` in favor of the `--path` flag.\n- [From v0.31.0](https://github.com/bufbuild/buf/releases/tag/v0.31.0): Removed the `--file` flag on `buf lint` in favor of the `--path` flag.\n- [From v0.31.0](https://github.com/bufbuild/buf/releases/tag/v0.31.0): Removed the `--file` flag on `buf breaking` in favor of the `--path` flag.\n- [From v0.31.0](https://github.com/bufbuild/buf/releases/tag/v0.31.0): Removed the `--file` flag on `buf generate` in favor of the `--path` flag.\n- [From v0.31.0](https://github.com/bufbuild/buf/releases/tag/v0.31.0): Removed the `--file` flag on `buf export` in favor of the `--path` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--source` flag on `buf build` in favor of the first positional parameter.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--source-config` flag on `buf build` in favor of the `--config` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input` flag on `buf lint` in favor of the first positional parameter.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input-config` flag on `buf lint` in favor of the `--config` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input` flag on `buf breaking` in favor of the first positional parameter.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input-config` flag on `buf breaking` in favor of the `--config` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--against-input` flag on `buf breaking` in favor of the `--against` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--against-input-config` flag on `buf breaking` in favor of the `--against-config` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input` flag on `buf generate` in favor of the first positional parameter.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input-config` flag on `buf generate` in favor of the `--config` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input` flag on `buf ls-files` in favor of the first positional parameter.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `--input-config` flag on `buf ls-files` in favor of the `--config` flag.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `buf image build` command in favor of `buf build`.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `buf image convert` command.\n- [From v0.29.0](https://github.com/bufbuild/buf/releases/tag/v0.29.0): Removed the `buf beta image convert` command.\n- [From v0.23.0](https://github.com/bufbuild/buf/releases/tag/v0.23.0): Removed the `buf experimental image convert` command.\n- [From v0.52.0](https://github.com/bufbuild/buf/releases/tag/v0.52.0) [and v0.34.0](https://github.com/bufbuild/buf/releases/tag/v0.34.0): Complete deletion `protoc-gen-buf-check-breaking` and `protoc-gen-buf-check-lint`, which have been moved to `protoc-gen-buf-breaking` and `protoc-gen-buf-lint`.\n\nIn January 2021 (v0.34.0), `protoc-gen-buf-check-breaking` and `protoc-gen-buf-check-lint` were deprecated and scheduled for removal for v1.0. In August 2021 (v0.52.0), we began returning error for every invocation of `protoc-gen-buf-check-breaking` and `protoc-gen-buf-check-lint`. This release completes the deletion process.\n\nThe only migration necessary is to change your installation and invocation from `protoc-gen-buf-check-breaking` to `protoc-gen-buf-breaking` and `protoc-gen-buf-check-lint` to `protoc-gen-buf-lint`. These can be installed in the exact same manner, whether from GitHub Releases, Homebrew, AUR, or direct Go installation:\n\n```\n# instead of go get github.com/bufbuild/buf/cmd/protoc-gen-buf-check-breaking\ngo get github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking\n# instead of curl -sSL https://github.com/bufbuild/buf/releases/download/v0.57.0/protoc-gen-buf-check-breaking-Linux-x86_64\ncurl -sSL https://github.com/bufbuild/buf/releases/download/v0.57.0/protoc-gen-buf-breaking-Linux-x86_64\n```\n\n## [v0.56.0] - 2021-09-08\n\n- Cascade `ENUM_ZERO_VALUE_SUFFIX` comment ignores from the enum level.\n- Fix issue where `buf generate --output` was not being respected in 0.55.0.\n\n## [v0.55.0] - 2021-09-07\n\n- Error if `version:` is not set in `buf.yaml`. This is one of the few breaking changes we must make before v1.0 to guarantee stability for the future. If you do not have a version set, simply add `version: v1beta1` to the top of your `buf.yaml`.\n- Support `BUF_TOKEN` for authentication. `buf` will now look for a token in the `BUF_TOKEN` environment variable, falling back to `.netrc` as set via `buf login`.\n- Add support for using remote plugins with local source files.\n- Add per-file overrides for managed mode.\n- Fix issue with the module cache where multiple simultaneous downloads would result in a temporarily-corrupted cache.\n- Hide verbose messaing behind the `--verbose` (`-v`) flag.\n- Add `--debug` flag to print out debug logging.\n\n## [v0.54.1] - 2021-08-30\n\n- Fix docker build.\n\n## [v0.54.0] - 2021-08-30\n\n- Add windows support.\n- Add `java_package_prefix` support to managed mode.\n- Fix issue with C# namespaces in managed mode.\n- Fix issue where `:main` was appended for errors containing references to modules.\n\n## [v0.53.0] - 2021-08-25\n\n- Fix issue where `buf generate --include-imports` would end up generating files for certain imports twice.\n- Error when both a `buf.mod` and `buf.yaml` are present. `buf.mod` was briefly used as the new default name for `buf.yaml`, but we've reverted back to `buf.yaml`.\n\n## [v0.52.0] - 2021-08-19\n\nReturn error for all invocations of `protoc-gen-buf-check-breaking` and `protoc-gen-buf-check-lint`.\n\nAs one of the few changes buf will ever make, `protoc-gen-buf-check-breaking` and `protoc-gen-buf-check-lint` were deprecated and scheduled for removal for v1.0 in January 2021. In preparation for v1.0, instead of just printing out a message notifying users of this, these commands now return an error for every invocation and will be completely removed when v1.0 is released.\n\nThe only migration necessary is to change your installation and invocation from `protoc-gen-buf-check-breaking` to `protoc-gen-buf-breaking` and `protoc-gen-buf-check-lint` to `protoc-gen-buf-lint`. These can be installed in the exact same manner, whether from GitHub Releases, Homebrew, AUR, or direct Go installation:\n\n```\n# instead of go get github.com/bufbuild/buf/cmd/protoc-gen-buf-check-breaking\ngo get github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking\n# instead of curl -sSL https://github.com/bufbuild/buf/releases/download/v0.52.0/protoc-gen-buf-check-breaking-Linux-x86_64\ncurl -sSL https://github.com/bufbuild/buf/releases/download/v0.52.0/protoc-gen-buf-breaking-Linux-x86_64\n```\n\nThere is no change in functionality.\n\n## [v0.51.1] - 2021-08-16\n\n- Fix issue with git LFS where a remote must be set for fetch.\n\n## [v0.51.0] - 2021-08-13\n\n- Accept packages of the form `v\\d+alpha` and `v\\d+beta` as packages with valid versions. These will be considered unstable packages for the purposes of linting and breaking change detection if `ignore_unstable_packages` is set.\n- Fix issue with git clones that occurred when using a previous reference of the current branch.\n\n## [v0.50.0] - 2021-08-12\n\n- Add `buf generate --include-imports` that also generates all imports except for the Well-Known Types.\n- Fix issue where a deleted file within an unstable package that contained messages, enums, or services resulted in a breaking change failure if the `PACKAGE` category was used and `ignore_unstable_packages` was set.\n\n## [v0.49.0] - 2021-08-10\n\n- Split `FIELD_SAME_TYPE` breaking change rule into `FIELD_SAME_TYPE, FIELD_WIRE_COMPATIBLE_TYPE, FIELD_WIRE_JSON_COMPATIBLE_TYPE` in `v1`. See https://github.com/bufbuild/buf/pull/400 for details.\n- Only export imported dependencies from `buf export`.\n\n## [v0.48.2] - 2021-07-30\n\n- Fix git args for http auth with git lfs.\n\n## [v0.48.1] - 2021-07-30\n\n- Fix: use `-c` on `git` parent command instead of `--config` on `git fetch`.\n- Add `ruby_package` to managed mode.\n\n## [v0.48.0] - 2021-07-29\n\n- Add `buf export`. `buf export` will export the files from the specified input (default `\".\"`) to the given directory in a manner that is buildable by `protoc` without any `-I` flags. It also has options `--exclude-imports`, which excludes imports (and won't result in a buildable set of files), and `--path`, which filters to the specific paths.\n\n## [v0.47.0] - 2021-07-29\n\n- Rewrite the git cloner to use `git init && git fetch` rather than `git clone`. `git clone` is limited to local branches on the remote, whereas `git fetch` we can fetch any references on the remote including remote branches.\n- Add `php_namespace` managed mode handling.\n- Add `java_string_check_utf8` managed mode handling.\n\n## [v0.46.0] - 2021-07-27\n\n- Add `buf login` and `buf logout` to login and logout from the Buf Schema Registry.\n- Fix cache, configuration, and data environment variables for Windows. Note that while Windows is still not officially supported, `buf` largely works on Windows.\n\n## [v0.45.0] - 2021-07-26\n\n- Revert default configuration file location back from `buf.mod` to `buf.yaml`. Note that both continue to work.\n- Move default workspace configuration file location from `buf.work` to `buf.work.yaml`. Note that both continue to work.\n- Move `buf beta push` to `buf push`. Note that `buf beta push` continues to work.\n- Move most `buf beta mod` commands to `buf mod`. Note that all `buf beta mod` commands continue to work.\n- Add `--only` flag to `buf mod update`.\n- Warn if `buf.yaml` contains dependencies that are not represented in the `buf.lock` file.\n- Add `--version` flag to `buf config ls-{breaking,lint}-rules`.\n- Add `SYNTAX_SPECIFIED` lint rule to `BASIC, DEFAULT` categories for v1 configuration.\n- Add `IMPORT_USED` lint rule to `BASIC, DEFAULT` categories for v1 configuration.\n- Bring v1 configuration out of beta.\n- Add managed mode for `objc_class_prefix`, `csharp_namespace`.\n\n## [v0.44.0] - 2021-07-08\n\n- Fix issue where C++ scoping rules were not properly enforced.\n- Add support for splitting directory paths passed to `buf protoc -I` by a directory separator.\n- Fix Windows support for builtin `protoc` plugins when using `buf generate` or `buf protoc`. Note that Windows remains officially unsupported as we have not set up testing, but largely works.\n- Upgrade to `protoc` 3.17.3 support.\n- Change the default module configuration location from `buf.yaml` to `buf.mod`. Note that `buf.yaml` continues to work.\n- Continued work on the workspaces beta, including the `v1` configuration specification.\n- Continued work on the managed mode beta, including the `v1` configuration specification.\n- Add `v1` module configuration specification in beta - please continue to use `v1beta1` until the `v1` configuration specification is rolled out.\n- Add `buf config migrate-v1beta1`.\n\n## [v0.43.2] - 2021-05-31\n\n- Fix namespace resolution diff with protoc.\n\n## [v0.43.1] - 2021-05-28\n\n- Revert `protoc` namespace resolution diff change.\n\n## [v0.43.0] - 2021-05-28\n\n- Do not count `buf:lint:ignore` directives as valid comments for the `COMMENT_.*` lint rules.\n- Upgrade to `protoc` 3.17.1 support.\n- Fix namespace resolution diff with `protoc`.\n\n## [v0.42.1] - 2021-05-20\n\n- Change the architecture suffix of the Linux ARM release assets from `arm64` to `aarch64` to match the output of `uname -m` on Linux.\n\n## [v0.42.0] - 2021-05-20\n\n- Add managed mode in beta. This is a new feature that automatically sets file option values.\n- Add workspaces in beta. This is a new feature that allows multiple modules within the same directory structure.\n- Add arm64 releases.\n\n## [v0.41.0] - 2021-04-01\n\n* Add `MESSAGE_SAME_REQUIRED_FIELDS` breaking change rule. This checks to make sure no `required` fields are added or deleted from existing messages.\n* Support multi-architecture Docker image.\n* Exit with code 100 for `FileAnnotation` errors.\n\n## [v0.40.0] - 2021-03-15\n\n* Add `buf beta registry tag {create,list}` commands.\n* Add support for creating tags in `push` via `buf beta push -t`.\n* Fix an issue where errors were unnecessarily written in `buf lint` and `buf breaking`.\n\n## [v0.39.1] - 2021-03-04\n\n- Fix issue with CLI build process in 0.39.0.\n\n## [v0.39.0] - 2021-03-04\n\n* `buf beta push` doesn't create a new commit if the content of the push is the same as the latest commit on the branch.\n* Fix an issue where no error was shown when authentication failed.\n* Fix an issue where `buf protoc` would error if a plugin returned an empty error string.\n\n## [v0.38.0] - 2021-02-25\n\n- Update the tested `protoc` version for compatibility to 3.15.2. The `--experimental_allow_proto3_optional` flag is no longer set for versions >=3.15.\n- Update the Well-Known Types to 3.15.2. The `go_package` values for the Well-Known Types now point at google.golang.org/protobuf instead of github.com/golang/protobuf.\n\n## [v0.37.1] - 2021-02-23\n\n- Fix bug where authentication headers were not threaded through for certain Buf Schema Registry commands.\n- Fix issue where empty errors would incorrectly be wrapped by the CLI interceptor.\n- Update Buf module cache location to include remote.\n\n## [v0.37.0] - 2021-02-09\n\n- Add commands for the Buf Schema Registry. Visit our website to add yourself to [the waitlist](https://buf.build/waitlist).\n\n## [v0.36.0] - 2021-01-18\n\nAllows comment ignores of the form `// buf:lint:ignore ID` to be cascaded upwards for specific rules.\n\n- For `ENUM_VALUE_PREFIX, ENUM_VALUE_UPPER_SNAKE_CASE`, both the enum value and the enum are checked.\n- For `FIELD_LOWER_SNAKE_CASE, FIELD_NO_DESCRIPTOR`, both the field and message are checked.\n- For `ONEOF_LOWER_SNAKE_CASE`, both the oneof and message are checked.\n- For `RPC_NO_CLIENT_STREAMING, RPC_NO_SERVER_STREAMING, RPC_PASCAL_CASE, RPC_REQUEST_RESPONSE_UNIQUE`, both the method and service are checked.\n- For `RPC_REQUEST_STANDARD_NAME, RPC_RESPONSE_STANDARD_NAME`, the input/output type, method, and service are checked.\n\n## [v0.35.1] - 2021-01-08\n\n- Fix error when unmarshalling plugin configuration with no options (#236)\n\n## [v0.35.0] - 2021-01-07\n\n- Allow `opt` in `buf.gen.yaml` files to be either a single string, or a list of strings. Both of the following forms are accepted, and result in `foo=bar,baz,bat`:\n\n```yaml\nversion: v1beta1\nplugins:\n - name: foo\n out: out\n opt: foo=bar,baz,bat\n```\n\n```yaml\nversion: v1beta1\nplugins:\n - name: foo\n out: out\n opt:\n - foo=bar\n - baz\n - bat\n```\n\n## [v0.34.0] - 2021-01-04\n\n- Move `buf check lint` to `buf lint`.\n- Move `buf check breaking` to `buf breaking`.\n- Move `buf check ls-lint-checkers` to `buf config ls-lint-rules`.\n- Move `buf check ls-breaking-checkers` to `buf config ls-breaking-rules`.\n- Move `protoc-gen-buf-check-lint` to `protoc-gen-buf-lint`.\n- Move `protoc-gen-buf-check-breaking` to `protoc-gen-buf-breaking`.\n- Add `buf beta config init`.\n\nAll previous commands continue to work in a backwards-compatible manner, and the previous `protoc-gen-buf-check-lint` and `protoc-gen-buf-check-breaking` binaries continue to be available at the same paths, however deprecation messages are printed.\n\n## [v0.33.0] - 2020-12-12\n\n- Add `strategy` option to `buf.gen.yaml` generation configuration. This allows selecting either plugin invocations with files on a per-directory basis, or plugin invocations with all files at once. See the [generation documentation](https://docs.buf.build/generate-usage) for more details.\n\n## [v0.32.1] - 2020-12-10\n\n- Fix issue where `SourceCodeInfo` for map fields within nested messages could be dropped.\n- Fix issue where deleted files would cause a panic when `breaking.ignore_unstable_packages = true`.\n\n## [v0.32.0] - 2020-11-24\n\n- Add symlink support for directory inputs. Symlinks will now be followed within your local directories when running `buf` commands.\n- Add the `breaking.ignore_unstable_packages` option to allow ignoring of unstable packages when running `buf check breaking`. See [the documentation](https://docs.buf.build/breaking-configuration#ignore_unstable_packages) for more details.\n- Enums that use the `allow_alias` option that add new aliases to a given number will no longer be considered breaking by `ENUM_VALUE_SAME_NAME`. See [the documentation](https://docs.buf.build/breaking-checkers#enum_value_same_name) for more details.\n\n## [v0.31.1] - 2020-11-17\n\n- Fix issue where `--experimental_allow_proto3_optional` was not set when proxying to `protoc` for the builtin plugins via `buf generate` or `buf protoc`. This flag is now set for `protoc` versions >= 3.12.\n\n## [v0.31.0] - 2020-11-16\n\n- Change the `--file` flag to `--path` and allow `--path` to take both files and directories, instead of just files with the old `--file`. This flag is used to filter the actual Protobuf files built under an input for most commands. You can now do for example `buf generate --path proto/foo` to only generate stubs for the files under `proto/foo`. Note that the `--file` flag continues to work, but prints a deprecation message.\n\n## [v0.30.1] - 2020-11-12\n\n- Relax validation of response file names from protoc plugins, so that when possible, plugins that are not compliant with the plugin specification are still usable with `buf generate`.\n\n## [v0.30.0] - 2020-11-03\n\n- Add `git://` protocol handling.\n\n## [v0.29.0] - 2020-10-30\n\nAs we work towards v1.0, we are cleaning up the CLI UX. As part of this, we made the following changes:\n\n- `buf image build` has been moved to `buf build` and now accepts images as inputs.\n- `buf beta image convert` has been deleted, as `buf build` now covers this functionality.\n- The `-o` flag is no longer required for `buf build`, instead defaulting to the OS equivalent of `/dev/null`.\n- The `--source` flag on `buf build` has been deprecated in favor of passing the input as the first argument.\n- The `--source-config` flag on `buf build` has been moved to `--config`.\n- The `--input` flag on `buf check lint` has been deprecated in favor of passing the input as the first argument.\n- The `--input-config` flag on `buf check lint` has been moved to `--config`.\n- The `--input` flag on `buf check breaking` has been deprecated in favor of passing the input as the first argument.\n- The `--input-config` flag on `buf check breaking` has been moved to `--config`.\n- The `--against-input` flag on `buf check breaking` has been moved to `--against`.\n- The `--against-input-config` flag on `buf check breaking` has been moved to `--against-config`.\n- The `--input` flag on `buf generate` has been deprecated in favor of passing the input as the first argument.\n- The `--input-config` flag on `buf generate` has been moved to `--config`.\n- The `--input` flag on `buf ls-files` has been deprecated in favor of passing the input as the first argument.\n- The `--input-config` flag on `buf ls-files` has been moved to `--config`.\n\nWe feel these changes make using `buf` more natural. Examples:\n\n```\n# compile the files in the current directory\nbuf build\n# equivalent to the default no-arg invocation\nbuf build .\n# build the repository at https://github.com/foo/bar.git\nbuf build https://github.com/foo/bar.git\n# lint the files in the proto directory\nbuf check lint proto\n# check the files in the current directory against the files on the master branch for breaking changes\nbuf check breaking --against .git#branch=master\n# check the files in the proto directory against the files in the proto directory on the master branch\nbuf check breaking proto --against .git#branch=master,subdir=proto\n```\n\n**Note that existing commands and flags continue to work.** While the deprecation messages will be printed, and we recommend migrating to the new invocations, your existing invocations have no change in functionality.\n\n## [v0.28.0] - 2020-10-21\n\n- Add `subdir` option for archive and git [Inputs](https://buf.build/docs/inputs). This allows placement of the `buf.yaml` configuration file in directories other than the base of your repository. You then can check against this subdirectory using, for example, `buf check breaking --against-input https://github.com/foo/bar.git#subdir=proto`.\n\n## [v0.27.1] - 2020-10-16\n\n- Fix minor typo in `buf help generate` documentation.\n\n## [v0.27.0] - 2020-10-16\n\n- Move `buf beta generate` out of beta to `buf generate`. This command now uses a template of configured plugins to generate stubs. See `buf help generate` for more details.\n\n## [v0.26.0] - 2020-10-13\n\n- Add jar and zip support to `buf protoc` and `buf beta generate`.\n\n## [v0.25.0] - 2020-10-09\n\n- Add the concept of configuration file version. The only currently-available version is `v1beta1`. See [buf.build/docs/faq](https://buf.build/docs/faq) for more details.\n\n## [v0.24.0] - 2020-09-21\n\n- Add fish completion to releases.\n- Update the `protoc` version for `buf protoc` to be `3.13.0`.\n\n## [v0.23.0] - 2020-09-11\n\n- Move the `experimental` parent command to `beta`. The command `buf experimental image convert` continues to work, but is deprecated in favor of `buf beta image convert`.\n- Add `buf beta generate`.\n\n## [v0.22.0] - 2020-09-09\n\n- Add [insertion point](https://github.com/protocolbuffers/protobuf/blob/cdf5022ada7159f0c82888bebee026cbbf4ac697/src/google/protobuf/compiler/plugin.proto#L135) support to `buf protoc`.\n\n## [v0.21.0] - 2020-09-02\n\n- Fix issue where `optional` fields in proto3 would cause the `ONEOF_LOWER_SNAKE_CASE` lint checker to fail.\n\n## [v0.20.5] - 2020-07-24\n\n- Fix issue where parser would fail on files starting with [byte order marks](https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8).\n\n## [v0.20.4] - 2020-07-21\n\n- Fix issue where custom message options that had an unset map field could cause a parser failure.\n\n## [v0.20.3] - 2020-07-18\n\n- Fix issue where parameters passed with `--.*_opt` to `buf protoc` for builtin plugins were not properly propagated.\n\n## [v0.20.2] - 2020-07-17\n\n- Fix issue where roots containing non-proto files with the same path would cause an error.\n\n## [v0.20.1] - 2020-07-14\n\n- Fix issue where Zsh completion would fail due to some flags having brackets in their description.\n- Fix issue where non-builtin protoc plugin invocations would not have errors properly propagated.\n- Fix issue where multiple `--.*_opt` flags, `--.*_opt` flags with commas, or `--.*_out` flags with options that contained commas, would not be properly added.\n\n## [v0.20.0] - 2020-07-13\n\n- Add `--by-dir` flag to `buf protoc` that parallelizes generation per directory, resulting in a 25-75% reduction in the time taken to generate stubs for medium to large file sets.\n- Properly clean up temporary files and commands on interrupts.\n- Fix issue where certain files that started with invalid Protobuf would cause the parser to crash.\n\n## [v0.19.1] - 2020-07-10\n\n- Fix issue where stderr was not being propagated for protoc plugins in CLI mode.\n\n## [v0.19.0] - 2020-07-10\n\n- Add `protoc` command. This is a substitute for `protoc` that uses Buf's internal compiler.\n- Add `ENUM_FIRST_VALUE_ZERO` lint checker to the `OTHER` category.\n- Add support for the Visual Studio error format.\n\n## [v0.18.1] - 2020-06-25\n\n- Fix issue where linking errors for custom options that had a message type were not properly reported (#93)\n\n## [v0.18.0] - 2020-06-22\n\n- Handle custom options when marshalling JSON images (#87).\n- Add `buf experimental image convert` command to convert to/from binary/JSON images (#87).\n\n## [v0.17.0] - 2020-06-17\n\n- Add git ref support to allow specifying arbitrary git references as inputs (https://github.com/bufbuild/buf/issues/48). This allows you to do i.e. `buf check lint --input https://github.com/bufbuild/buf.git#ref=fa74aa9c4161304dfa83db4abc4a0effe886d253`.\n- Add `depth` input option when specifying git inputs with `ref`. This allows the user to configure the depth at which to clone the repository when looking for the `ref`. If specifying a `ref`, this defaults to 50. Otherwise, this defaults to 1.\n- Remove requirement for git branch or tag in inputs. This allows you to do i.e. `buf check lint --input https://github.com/bufbuild/buf.git` and it will automatically choose the default branch as an input.\n\n## [v0.16.0] - 2020-06-02\n\n- Add [proto3 optional](https://github.com/protocolbuffers/protobuf/blob/7cb5597013f0c4b978f02bce4330849f118aa853/docs/field_presence.md#how-to-enable-explicit-presence-in-proto3) support.\n\n## [v0.15.0] - 2020-05-31\n\n- Add opt-in comment-driven lint ignores via the `allow_comment_ignores` lint configuration option and `buf:lint:ignore ID` leading comment annotation (#73).\n\n## [v0.14.0] - 2020-05-30\n\n- Add `--file` flag to `buf image build` to only add specific files and their imports to outputted images. To exclude imports, use `--exclude-imports`.\n- Add `zip` as a source format. Buf can now read `zip` files, either locally or remotely, for image building, linting, and breaking change detection.\n- Add `zstd` as a compression format. Buf can now read and write Image files that are compressed using zstandard, and can read tarballs compressed with zstandard.\n- Deprecated: The formats `bingz, jsongz, targz` are now deprecated. Instead, use `format=bin,compression=gzip`, `format=json,compression=gzip`, or `format=tar,compression=gzip`. The formats `bingz, jsongz, targz` will continue to work forever and will not be broken, but will print a deprecation warning and we recommend updating. Automatic file extension parsing continues to work the same as well.\n\n## [v0.13.0] - 2020-05-17\n\n- Use the `git` binary instead of go-git for internal clones. This also enables using your system git credential management for git repositories cloned using https or ssh. See https://buf.build/docs/inputs#authentication for more details.\n\n## [v0.12.1] - 2020-05-11\n\n- Fix issue where roots were detected as overlapping if one root's name was a prefix of the other.\n\n## [v0.12.0] - 2020-05-11\n\n- Add netrc support for inputs.\n- Fix issue where filenames that contained `..` resulted in an error.\n- Internal: migrate to golang/protobuf v2.\n\n## [v0.11.0] - 2020-04-09\n\n- Add experimental flag `--experimental-git-clone` to use the `git` binary for git clones.\n\n## [v0.10.0] - 2020-04-06\n\n- Add `recurse_submodules` option for git inputs.\n Example: `https://github.com/foo/bar.git#branch=master,recurse_submodules=true`\n\n## [v0.9.0] - 2020-03-25\n\n- Fix issue where the option value ordering on an outputted `Image` was non-deterministic.\n- Fix issue where the `SourceCodeInfo` for the Well-Known Types was not included on an outputted `Image` when requested.\n\n## [v0.8.0] - 2020-03-11\n\n- Update dependencies.\n\n## [v0.7.1] - 2020-03-05\n\n- Tie HTTP download timeout to the `--timeout` flag.\n\n## [v0.7.0] - 2020-01-31\n\n- Add `tag` option for git inputs.\n\n## [v0.6.0] - 2020-01-17\n\n- Add `git` to the Docker container for local filesystem clones.\n- Update the JSON error format to use `path` as the file path key instead of `filename`.\n\n## [v0.5.0] - 2020-01-01\n\n- Allow basic authentication for remote tarballs, git repositories, and image files served from HTTPS endpoints. See https://buf.build/docs/inputs#https for more details.\n- Allow public key authentication for remote git repositories served from SSH endpoints. See https://buf.build/docs/inputs#ssh for more details.\n\n## [v0.4.1] - 2019-12-30\n\n- Fix issue where comparing enum values for enums that have `allow_alias` set and duplicate enum values present resulted in a system error.\n\n## [v0.4.0] - 2019-12-05\n\n- Change the breaking change detector to compare enum values on number instead of name. This also results in the `ENUM_VALUE_SAME_NUMBER` checker being replaced with the `ENUM_VALUE_SAME_NAME` checker, except this new checker is not in the `WIRE` category.\n\n## [v0.3.0] - 2019-11-05\n\n- Fix issue where multiple timeout errors were printed.\n- Add `buf check lint --error-format=config-ignore-yaml` to print out current lint errors in a format that can be copied into a configuration file.\n\n## [v0.2.0] - 2019-10-28\n\n- Add a Docker image for the `buf` binary.\n\n## v0.1.0 - 2019-10-18\n\nInitial beta release.\n\n[Unreleased]: https://github.com/bufbuild/buf/compare/v1.66.1...HEAD\n[v1.66.1]: https://github.com/bufbuild/buf/compare/v1.66.0...v1.66.1\n[v1.66.0]: https://github.com/bufbuild/buf/compare/v1.65.0...v1.66.0\n[v1.65.0]: https://github.com/bufbuild/buf/compare/v1.64.0...v1.65.0\n[v1.64.0]: https://github.com/bufbuild/buf/compare/v1.63.0...v1.64.0\n[v1.63.0]: https://github.com/bufbuild/buf/compare/v1.62.1...v1.63.0\n[v1.62.1]: https://github.com/bufbuild/buf/compare/v1.62.0...v1.62.1\n[v1.62.0]: https://github.com/bufbuild/buf/compare/v1.61.0...v1.62.0\n[v1.61.0]: https://github.com/bufbuild/buf/compare/v1.60.0...v1.61.0\n[v1.60.0]: https://github.com/bufbuild/buf/compare/v1.59.0...v1.60.0\n[v1.59.0]: https://github.com/bufbuild/buf/compare/v1.58.0...v1.59.0\n[v1.58.0]: https://github.com/bufbuild/buf/compare/v1.57.2...v1.58.0\n[v1.57.2]: https://github.com/bufbuild/buf/compare/v1.57.1...v1.57.2\n[v1.57.1]: https://github.com/bufbuild/buf/compare/v1.57.0...v1.57.1\n[v1.57.0]: https://github.com/bufbuild/buf/compare/v1.56.0...v1.57.0\n[v1.56.0]: https://github.com/bufbuild/buf/compare/v1.55.1...v1.56.0\n[v1.55.1]: https://github.com/bufbuild/buf/compare/v1.55.0...v1.55.1\n[v1.55.0]: https://github.com/bufbuild/buf/compare/v1.54.0...v1.55.0\n[v1.54.0]: https://github.com/bufbuild/buf/compare/v1.53.0...v1.54.0\n[v1.53.0]: https://github.com/bufbuild/buf/compare/v1.52.1...v1.53.0\n[v1.52.1]: https://github.com/bufbuild/buf/compare/v1.52.0...v1.52.1\n[v1.52.0]: https://github.com/bufbuild/buf/compare/v1.51.0...v1.52.0\n[v1.51.0]: https://github.com/bufbuild/buf/compare/v1.50.1...v1.51.0\n[v1.50.1]: https://github.com/bufbuild/buf/compare/v1.50.0...v1.50.1\n[v1.50.0]: https://github.com/bufbuild/buf/compare/v1.49.0...v1.50.0\n[v1.49.0]: https://github.com/bufbuild/buf/compare/v1.48.0...v1.49.0\n[v1.48.0]: https://github.com/bufbuild/buf/compare/v1.47.2...v1.48.0\n[v1.47.2]: https://github.com/bufbuild/buf/compare/v1.47.1...v1.47.2\n[v1.47.1]: https://github.com/bufbuild/buf/compare/v1.47.0...v1.47.1\n[v1.47.0]: https://github.com/bufbuild/buf/compare/v1.46.0...v1.47.0\n[v1.46.0]: https://github.com/bufbuild/buf/compare/v1.45.0...v1.46.0\n[v1.45.0]: https://github.com/bufbuild/buf/compare/v1.44.0...v1.45.0\n[v1.44.0]: https://github.com/bufbuild/buf/compare/v1.43.0...v1.44.0\n[v1.43.0]: https://github.com/bufbuild/buf/compare/v1.42.0...v1.43.0\n[v1.42.0]: https://github.com/bufbuild/buf/compare/v1.41.0...v1.42.0\n[v1.41.0]: https://github.com/bufbuild/buf/compare/v1.40.1...v1.41.0\n[v1.40.1]: https://github.com/bufbuild/buf/compare/v1.40.0...v1.40.1\n[v1.40.0]: https://github.com/bufbuild/buf/compare/v1.39.0...v1.40.0\n[v1.39.0]: https://github.com/bufbuild/buf/compare/v1.38.0...v1.39.0\n[v1.38.0]: https://github.com/bufbuild/buf/compare/v1.37.0...v1.38.0\n[v1.37.0]: https://github.com/bufbuild/buf/compare/v1.36.0...v1.37.0\n[v1.36.0]: https://github.com/bufbuild/buf/compare/v1.35.1...v1.36.0\n[v1.35.1]: https://github.com/bufbuild/buf/compare/v1.35.0...v1.35.1\n[v1.35.0]: https://github.com/bufbuild/buf/compare/v1.34.0...v1.35.0\n[v1.34.0]: https://github.com/bufbuild/buf/compare/v1.33.0...v1.34.0\n[v1.33.0]: https://github.com/bufbuild/buf/compare/v1.32.2...v1.33.0\n[v1.32.2]: https://github.com/bufbuild/buf/compare/v1.32.1...v1.32.2\n[v1.32.1]: https://github.com/bufbuild/buf/compare/v1.32.0...v1.32.1\n[v1.32.0]: https://github.com/bufbuild/buf/compare/v1.32.0-beta.1...v1.32.0\n[v1.32.0-beta.1]: https://github.com/bufbuild/buf/compare/v1.31.0...v1.32.0-beta.1\n[v1.31.0]: https://github.com/bufbuild/buf/compare/v1.30.1...v1.31.0\n[v1.30.1]: https://github.com/bufbuild/buf/compare/v1.30.0...v1.30.1\n[v1.30.0]: https://github.com/bufbuild/buf/compare/v1.29.0...v1.30.0\n[v1.29.0]: https://github.com/bufbuild/buf/compare/v1.28.1...v1.29.0\n[v1.28.1]: https://github.com/bufbuild/buf/compare/v1.28.0...v1.28.1\n[v1.28.0]: https://github.com/bufbuild/buf/compare/v1.27.2...v1.28.0\n[v1.27.2]: https://github.com/bufbuild/buf/compare/v1.27.1...v1.27.2\n[v1.27.1]: https://github.com/bufbuild/buf/compare/v1.27.0...v1.27.1\n[v1.27.0]: https://github.com/bufbuild/buf/compare/v1.26.1...v1.27.0\n[v1.26.1]: https://github.com/bufbuild/buf/compare/v1.26.0...v1.26.1\n[v1.26.0]: https://github.com/bufbuild/buf/compare/v1.25.1...v1.26.0\n[v1.25.1]: https://github.com/bufbuild/buf/compare/v1.25.0...v1.25.1\n[v1.25.0]: https://github.com/bufbuild/buf/compare/v1.24.0...v1.25.0\n[v1.24.0]: https://github.com/bufbuild/buf/compare/v1.23.1...v1.24.0\n[v1.23.1]: https://github.com/bufbuild/buf/compare/v1.23.0...v1.23.1\n[v1.23.0]: https://github.com/bufbuild/buf/compare/v1.22.0...v1.23.0\n[v1.22.0]: https://github.com/bufbuild/buf/compare/v1.21.0...v1.22.0\n[v1.21.0]: https://github.com/bufbuild/buf/compare/v1.20.0...v1.21.0\n[v1.20.0]: https://github.com/bufbuild/buf/compare/v1.19.0...v1.20.0\n[v1.19.0]: https://github.com/bufbuild/buf/compare/v1.18.0...v1.19.0\n[v1.18.0]: https://github.com/bufbuild/buf/compare/v1.17.0...v1.18.0\n[v1.17.0]: https://github.com/bufbuild/buf/compare/v1.16.0...v1.17.0\n[v1.16.0]: https://github.com/bufbuild/buf/compare/v1.15.1...v1.16.0\n[v1.15.1]: https://github.com/bufbuild/buf/compare/v1.15.0...v1.15.1\n[v1.15.0]: https://github.com/bufbuild/buf/compare/v1.14.0...v1.15.0\n[v1.14.0]: https://github.com/bufbuild/buf/compare/v1.13.1...v1.14.0\n[v1.13.1]: https://github.com/bufbuild/buf/compare/v1.13.0...v1.13.1\n[v1.13.0]: https://github.com/bufbuild/buf/compare/v1.12.0...v1.13.0\n[v1.12.0]: https://github.com/bufbuild/buf/compare/v1.11.0...v1.12.0\n[v1.11.0]: https://github.com/bufbuild/buf/compare/v1.10.0...v1.11.0\n[v1.10.0]: https://github.com/bufbuild/buf/compare/v1.9.0...v1.10.0\n[v1.9.0]: https://github.com/bufbuild/buf/compare/v1.8.0...v1.9.0\n[v1.8.0]: https://github.com/bufbuild/buf/compare/v1.7.0...v1.8.0\n[v1.7.0]: https://github.com/bufbuild/buf/compare/v1.6.0...v1.7.0\n[v1.6.0]: https://github.com/bufbuild/buf/compare/v1.5.0...v1.6.0\n[v1.5.0]: https://github.com/bufbuild/buf/compare/v1.4.0...v1.5.0\n[v1.4.0]: https://github.com/bufbuild/buf/compare/v1.3.1...v1.4.0\n[v1.3.1]: https://github.com/bufbuild/buf/compare/v1.3.0...v1.3.1\n[v1.3.0]: https://github.com/bufbuild/buf/compare/v1.2.1...1.3.0\n[v1.2.1]: https://github.com/bufbuild/buf/compare/v1.2.0...v1.2.1\n[v1.2.0]: https://github.com/bufbuild/buf/compare/v1.1.1...v1.2.0\n[v1.1.1]: https://github.com/bufbuild/buf/compare/v1.1.0...v1.1.1\n[v1.1.0]: https://github.com/bufbuild/buf/compare/v1.0.0...v1.1.0\n[v1.0.0]: https://github.com/bufbuild/buf/compare/v1.0.0-rc12...v1.0.0\n[v1.0.0-rc12]: https://github.com/bufbuild/buf/compare/v1.0.0-rc11...v1.0.0-rc12\n[v1.0.0-rc11]: https://github.com/bufbuild/buf/compare/v1.0.0-rc10...v1.0.0-rc11\n[v1.0.0-rc10]: https://github.com/bufbuild/buf/compare/v1.0.0-rc9...v1.0.0-rc10\n[v1.0.0-rc9]: https://github.com/bufbuild/buf/compare/v1.0.0-rc8...v1.0.0-rc9\n[v1.0.0-rc8]: https://github.com/bufbuild/buf/compare/v1.0.0-rc7...v1.0.0-rc8\n[v1.0.0-rc7]: https://github.com/bufbuild/buf/compare/v1.0.0-rc6...v1.0.0-rc7\n[v1.0.0-rc6]: https://github.com/bufbuild/buf/compare/v1.0.0-rc5...v1.0.0-rc6\n[v1.0.0-rc5]: https://github.com/bufbuild/buf/compare/v1.0.0-rc4...v1.0.0-rc5\n[v1.0.0-rc4]: https://github.com/bufbuild/buf/compare/v1.0.0-rc3...v1.0.0-rc4\n[v1.0.0-rc3]: https://github.com/bufbuild/buf/compare/v1.0.0-rc2...v1.0.0-rc3\n[v1.0.0-rc2]: https://github.com/bufbuild/buf/compare/v1.0.0-rc1...v1.0.0-rc2\n[v1.0.0-rc1]: https://github.com/bufbuild/buf/compare/v0.56.0...v1.0.0-rc1\n[v0.56.0]: https://github.com/bufbuild/buf/compare/v0.55.0...v0.56.0\n[v0.55.0]: https://github.com/bufbuild/buf/compare/v0.54.1...v0.55.0\n[v0.54.1]: https://github.com/bufbuild/buf/compare/v0.54.0...v0.54.1\n[v0.54.0]: https://github.com/bufbuild/buf/compare/v0.53.0...v0.54.0\n[v0.53.0]: https://github.com/bufbuild/buf/compare/v0.52.0...v0.53.0\n[v0.52.0]: https://github.com/bufbuild/buf/compare/v0.51.1...v0.52.0\n[v0.51.1]: https://github.com/bufbuild/buf/compare/v0.51.0...v0.51.1\n[v0.51.0]: https://github.com/bufbuild/buf/compare/v0.50.0...v0.51.0\n[v0.50.0]: https://github.com/bufbuild/buf/compare/v0.49.0...v0.50.0\n[v0.49.0]: https://github.com/bufbuild/buf/compare/v0.48.2...v0.49.0\n[v0.48.2]: https://github.com/bufbuild/buf/compare/v0.48.1...v0.48.2\n[v0.48.1]: https://github.com/bufbuild/buf/compare/v0.48.0...v0.48.1\n[v0.48.0]: https://github.com/bufbuild/buf/compare/v0.47.0...v0.48.0\n[v0.47.0]: https://github.com/bufbuild/buf/compare/v0.46.0...v0.47.0\n[v0.46.0]: https://github.com/bufbuild/buf/compare/v0.45.0...v0.46.0\n[v0.45.0]: https://github.com/bufbuild/buf/compare/v0.44.0...v0.45.0\n[v0.44.0]: https://github.com/bufbuild/buf/compare/v0.43.2...v0.44.0\n[v0.43.2]: https://github.com/bufbuild/buf/compare/v0.43.1...v0.43.2\n[v0.43.1]: https://github.com/bufbuild/buf/compare/v0.43.0...v0.43.1\n[v0.43.0]: https://github.com/bufbuild/buf/compare/v0.42.1...v0.43.0\n[v0.42.1]: https://github.com/bufbuild/buf/compare/v0.42.0...v0.42.1\n[v0.42.0]: https://github.com/bufbuild/buf/compare/v0.41.0...v0.42.0\n[v0.41.0]: https://github.com/bufbuild/buf/compare/v0.40.0...v0.41.0\n[v0.40.0]: https://github.com/bufbuild/buf/compare/v0.39.1...v0.40.0\n[v0.39.1]: https://github.com/bufbuild/buf/compare/v0.39.0...v0.39.1\n[v0.39.0]: https://github.com/bufbuild/buf/compare/v0.38.0...v0.39.0\n[v0.38.0]: https://github.com/bufbuild/buf/compare/v0.37.1...v0.38.0\n[v0.37.1]: https://github.com/bufbuild/buf/compare/v0.37.0...v0.37.1\n[v0.37.0]: https://github.com/bufbuild/buf/compare/v0.36.0...v0.37.0\n[v0.36.0]: https://github.com/bufbuild/buf/compare/v0.35.1...v0.36.0\n[v0.35.1]: https://github.com/bufbuild/buf/compare/v0.35.0...v0.35.1\n[v0.35.0]: https://github.com/bufbuild/buf/compare/v0.34.0...v0.35.0\n[v0.34.0]: https://github.com/bufbuild/buf/compare/v0.33.0...v0.34.0\n[v0.33.0]: https://github.com/bufbuild/buf/compare/v0.32.1...v0.33.0\n[v0.32.1]: https://github.com/bufbuild/buf/compare/v0.32.0...v0.32.1\n[v0.32.0]: https://github.com/bufbuild/buf/compare/v0.31.1...v0.32.0\n[v0.31.1]: https://github.com/bufbuild/buf/compare/v0.31.0...v0.31.1\n[v0.31.0]: https://github.com/bufbuild/buf/compare/v0.30.1...v0.31.0\n[v0.30.1]: https://github.com/bufbuild/buf/compare/v0.30.0...v0.30.1\n[v0.30.0]: https://github.com/bufbuild/buf/compare/v0.29.0...v0.30.0\n[v0.29.0]: https://github.com/bufbuild/buf/compare/v0.28.0...v0.29.0\n[v0.28.0]: https://github.com/bufbuild/buf/compare/v0.27.1...v0.28.0\n[v0.27.1]: https://github.com/bufbuild/buf/compare/v0.27.0...v0.27.1\n[v0.27.0]: https://github.com/bufbuild/buf/compare/v0.26.0...v0.27.0\n[v0.26.0]: https://github.com/bufbuild/buf/compare/v0.25.0...v0.26.0\n[v0.25.0]: https://github.com/bufbuild/buf/compare/v0.24.0...v0.25.0\n[v0.24.0]: https://github.com/bufbuild/buf/compare/v0.23.0...v0.24.0\n[v0.23.0]: https://github.com/bufbuild/buf/compare/v0.22.0...v0.23.0\n[v0.22.0]: https://github.com/bufbuild/buf/compare/v0.21.0...v0.22.0\n[v0.21.0]: https://github.com/bufbuild/buf/compare/v0.20.5...v0.21.0\n[v0.20.5]: https://github.com/bufbuild/buf/compare/v0.20.4...v0.20.5\n[v0.20.4]: https://github.com/bufbuild/buf/compare/v0.20.3...v0.20.4\n[v0.20.3]: https://github.com/bufbuild/buf/compare/v0.20.2...v0.20.3\n[v0.20.2]: https://github.com/bufbuild/buf/compare/v0.20.1...v0.20.2\n[v0.20.1]: https://github.com/bufbuild/buf/compare/v0.20.0...v0.20.1\n[v0.20.0]: https://github.com/bufbuild/buf/compare/v0.19.1...v0.20.0\n[v0.19.1]: https://github.com/bufbuild/buf/compare/v0.19.0...v0.19.1\n[v0.19.0]: https://github.com/bufbuild/buf/compare/v0.18.1...v0.19.0\n[v0.18.1]: https://github.com/bufbuild/buf/compare/v0.18.0...v0.18.1\n[v0.18.0]: https://github.com/bufbuild/buf/compare/v0.17.0...v0.18.0\n[v0.17.0]: https://github.com/bufbuild/buf/compare/v0.16.0...v0.17.0\n[v0.16.0]: https://github.com/bufbuild/buf/compare/v0.15.0...v0.16.0\n[v0.15.0]: https://github.com/bufbuild/buf/compare/v0.14.0...v0.15.0\n[v0.14.0]: https://github.com/bufbuild/buf/compare/v0.13.0...v0.14.0\n[v0.13.0]: https://github.com/bufbuild/buf/compare/v0.12.1...v0.13.0\n[v0.12.1]: https://github.com/bufbuild/buf/compare/v0.12.0...v0.12.1\n[v0.12.0]: https://github.com/bufbuild/buf/compare/v0.11.0...v0.12.0\n[v0.11.0]: https://github.com/bufbuild/buf/compare/v0.10.0...v0.11.0\n[v0.10.0]: https://github.com/bufbuild/buf/compare/v0.9.0...v0.10.0\n[v0.9.0]: https://github.com/bufbuild/buf/compare/v0.8.0...v0.9.0\n[v0.8.0]: https://github.com/bufbuild/buf/compare/v0.7.1...v0.8.0\n[v0.7.1]: https://github.com/bufbuild/buf/compare/v0.7.0...v0.7.1\n[v0.7.0]: https://github.com/bufbuild/buf/compare/v0.6.0...v0.7.0\n[v0.6.0]: https://github.com/bufbuild/buf/compare/v0.5.0...v0.6.0\n[v0.5.0]: https://github.com/bufbuild/buf/compare/v0.4.1...v0.5.0\n[v0.4.1]: https://github.com/bufbuild/buf/compare/v0.4.0...v0.4.1\n[v0.4.0]: https://github.com/bufbuild/buf/compare/v0.3.0...v0.4.0\n[v0.3.0]: https://github.com/bufbuild/buf/compare/v0.2.0...v0.3.0\n[v0.2.0]: https://github.com/bufbuild/buf/compare/v0.1.0...v0.2.0\n" }, { "path": "Dockerfile.buf", "content": "FROM --platform=${BUILDPLATFORM} golang:1.26-alpine3.23 AS builder\n\nWORKDIR /workspace\n\nCOPY go.mod go.sum /workspace/\nRUN go mod download\n\nCOPY cmd /workspace/cmd\nCOPY private /workspace/private\n\nARG TARGETOS\nARG TARGETARCH\nRUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} \\\n go build -ldflags \"-s -w\" -trimpath -buildvcs=false -o /go/bin/buf ./cmd/buf\n\nFROM alpine:3.23.3\n\nRUN apk add --update --no-cache \\\n ca-certificates \\\n git \\\n openssh-client && \\\n rm -rf /var/cache/apk/*\n\nCOPY --from=builder /go/bin/buf /usr/local/bin/buf\n\nENTRYPOINT [\"/usr/local/bin/buf\"]\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright 2020-2026 Buf Technologies, Inc.\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "Makefile", "content": "MAKEGO := make/go\nMAKEGO_REMOTE := https://github.com/bufbuild/makego.git\nPROJECT := buf\nGO_MODULE := github.com/bufbuild/buf\nDOCKER_ORG := bufbuild\nDOCKER_PROJECT := buf\n\ninclude make/buf/all.mk\n" }, { "path": "README.md", "content": "![The Buf logo](./.github/buf-logo.svg)\n\n# Buf\n\n[![License](https://img.shields.io/github/license/bufbuild/buf?color=blue)](https://github.com/bufbuild/buf/blob/main/LICENSE)\n[![Release](https://img.shields.io/github/v/release/bufbuild/buf?include_prereleases)](https://github.com/bufbuild/buf/releases)\n[![CI](https://github.com/bufbuild/buf/workflows/ci/badge.svg)](https://github.com/bufbuild/buf/actions?workflow=ci)\n[![Docker](https://img.shields.io/docker/pulls/bufbuild/buf)](https://hub.docker.com/r/bufbuild/buf)\n[![Homebrew](https://img.shields.io/homebrew/v/buf)](https://github.com/bufbuild/homebrew-buf)\n[![Slack](https://img.shields.io/badge/slack-buf-%23e01563)][badges_slack]\n\n\nThe [`buf`][buf] CLI is the best tool for working with [Protocol Buffers][protobuf]. It provides:\n\n- A [linter][lint_usage] that enforces good API design choices and structure.\n- A [breaking change detector][breaking_tutorial] that enforces compatibility at the source code or wire level.\n- A [generator][generate_usage] that invokes your plugins based on [configuration files][templates].\n- A [formatter][format_usage] that formats your Protobuf files in accordance with industry standards.\n- Integration with the [Buf Schema Registry][bsr], including full dependency management.\n\n## Installation\n\n### Homebrew\n\nYou can install `buf` using [Homebrew][brew] (macOS or Linux):\n\n```sh\nbrew install bufbuild/buf/buf\n```\n\nThis installs:\n\n- The `buf`, [`protoc-gen-buf-breaking`][breaking], and [`protoc-gen-buf-lint`][lint] binaries\n- Shell completion scripts for [Bash], [Fish], [Powershell], and [zsh]\n\n### Other methods\n\nFor other installation methods, see our [official documentation][install], which covers:\n\n- Installing `buf` via [npm]\n- Installing `buf` on [Windows]\n- Using `buf` as a [Docker image][docker]\n- Installing as a [binary], from a [tarball], and from [source] through [GitHub Releases][releases]\n- [Verifying] releases using a [minisign] public key\n\n\n## Usage\n\nBuf's help interface provides summaries for commands and flags:\n\n```sh\nbuf --help\n```\n\nFor more comprehensive usage information, consult Buf's [documentation][docs], especially these guides:\n\n* [`buf breaking`][breaking_tutorial]\n* [`buf build`][build_usage]\n* [`buf generate`][generate_usage]\n* [`buf lint`][lint_usage]\n* [`buf format`][format_usage]\n* [`buf registry`][bsr_quickstart] (for using the [BSR])\n\n## CLI breaking change policy\n\nWe will never make breaking changes within a given major version of the CLI. After `buf` reached v1.0, you can expect no breaking changes until v2.0. But as we have no plans to ever release a v2.0, we will likely never break the `buf` CLI.\n\n> This breaking change policy does _not_ apply to commands behind the `buf beta` gate, and you should expect breaking changes to commands like `buf beta registry`. The policy does go into effect, however, when those commands or flags are elevated out of beta.\n\n## Our goals for Protobuf\n\n[Buf]'s goal is to replace the current paradigm of API development, centered around REST/JSON, with a **schema-driven** paradigm. Defining APIs using an [IDL] provides numerous benefits over REST/JSON, and [Protobuf] is by far the most stable and widely adopted IDL in the industry. We've chosen to build on this widely trusted foundation rather than creating a new IDL from scratch.\n\nBut despite its technical merits, actually _using_ Protobuf has long been more challenging than it needs to be. The Buf CLI and the [BSR](#the-buf-schema-registry) are the cornerstones of our effort to change that for good and to make Protobuf reliable and easy to use for service owners and clients alike—in other words, to create a **modern Protobuf ecosystem**.\n\nWhile we intend to incrementally improve on the `buf` CLI and the [BSR](#the-buf-schema-registry), we're confident that the basic groundwork for such an ecosystem is _already_ in place.\n\n## The Buf Schema Registry\n\nThe [Buf Schema Registry][bsr] (BSR) is a SaaS platform for managing your Protobuf APIs. It provides a centralized registry and a single source of truth for all of your Protobuf assets, including not just your `.proto` files but also [remote plugins][bsr_plugins]. Although the BSR provides an intuitive browser UI, `buf` enables you to perform most BSR-related tasks from the command line, such as [pushing] Protobuf sources to the registry and managing [users] and [repositories]. \n\n> The BSR is not required to use `buf`. We've made the core [features] of the `buf` CLI available to _all_ Protobuf users.\n\n## More advanced CLI features\n\nWhile `buf`'s [core features][features] should cover most use cases, we've included some more advanced features to cover edge cases:\n\n* **Automatic file discovery**. Buf walks your file tree and builds your `.proto` files in accordance with your supplied [build configuration][build_config], which means that you no longer need to manually specify `--proto_paths`. You can still, however, specify `.proto` files manually through CLI flags in cases where file discovery needs to be disabled.\n* **Fine-grained rule configuration** for [linting][lint_rules] and [breaking changes][breaking_rules]. While we do have recommended defaults, you can always select the exact set of rules that your use case requires, with [40 lint rules][lint_rules] and [53 breaking change rules][breaking_rules] available.\n* **Configurable error formats** for CLI output. `buf` outputs information in `file:line:column:message` form by default for each lint error and breaking change it encounters, but you can also select JSON, MSVS, JUnit, and Github Actions output.\n* **Editor integration** driven by `buf`'s granular error output. We currently provide linting integrations for both [Vim and Visual Studio Code][ide] and [JetBrains IDEs][jetbrains] like IntelliJ and GoLand, but we plan to support other editors such as Emacs in the future.\n* **Universal Input targeting**. Buf enables you to perform actions like linting and breaking change detection not just against local `.proto` files but also against a broad range of other [Inputs], such as tarballs and ZIP files, remote Git repositories, and pre-built [image][images] files.\n* **Speed**. Buf's internal Protobuf [compiler] compiles your Protobuf sources using all available cores without compromising deterministic output, which is considerably faster than `protoc`. This allows for near-instantaneous feedback, which is of special importance for features like [editor integration][ide].\n\n## Next steps\n\nOnce you've installed `buf`, we recommend completing the [CLI tutorial][cli-tutorial], which provides a broad but hands-on overview of the core functionality of the CLI. The tour takes about 10 minutes to complete.\n\nAfter completing the tour, check out the remainder of the [docs] for your specific areas of interest.\n\n## Builds\n\nThe following is a breakdown of the binaries by CPU architecture and operating system available through our [releases]:\n\n| | Linux | MacOS | Windows |\n| --- | --- | --- | --- |\n| x86 (64-bit) | ✅ | ✅ | ✅ |\n| ARM (64-bit) | ✅ | ✅ | ✅ |\n| ARMv7 (32-bit) | ✅ | ❌ | ❌ |\n| RISC-V (64-bit) | ✅ | ❌ | ❌ |\n| ppc64le | ✅ | ❌ | ❌ |\n| s390x | ✅ | ❌ | ❌ |\n\n## Community\n\nFor help and discussion around Protobuf, best practices, and more, join us on [Slack][badges_slack].\n\nFor updates on the Buf CLI, [follow this repo on GitHub][repo].\n\nFor feature requests, bugs, or technical questions, email us at [dev@buf.build][email_dev]. For general inquiries or inclusion in our upcoming feature betas, email us at [info@buf.build][email_info].\n\n[badges_slack]: https://buf.build/links/slack\n[bash]: https://www.gnu.org/software/bash\n[binary]: https://buf.build/docs/cli/installation/#source\n[breaking]: https://buf.build/docs/breaking/overview/\n[breaking_rules]: https://buf.build/docs/breaking/rules/\n[breaking_tutorial]: https://buf.build/docs/breaking/tutorial/\n[brew]: https://brew.sh\n[bsr]: https://buf.build/docs/bsr/\n[bsr_plugins]: https://buf.build/plugins\n[bsr_quickstart]: https://buf.build/docs/bsr/quickstart/\n[buf]: https://buf.build\n[build_config]: https://buf.build/docs/build/usage/#key-concepts\n[build_usage]: https://buf.build/docs/build/usage\n[cli-tutorial]: https://buf.build/docs/cli/quickstart/\n[compiler]: https://buf.build/docs/reference/internal-compiler/\n[docker]: https://buf.build/docs/cli/installation/#docker\n[docs]: https://buf.build/docs\n[email_dev]: mailto:dev@buf.build\n[email_info]: mailto:info@buf.build\n[features]: #features\n[fish]: https://fishshell.com\n[format_usage]: https://buf.build/docs/format/style/\n[generate_usage]: https://buf.build/docs/generate/tutorial/\n[ide]: https://buf.build/docs/cli/editor-integration/\n[idl]: https://en.wikipedia.org/wiki/Interface_description_language\n[images]: https://buf.build/docs/reference/images/\n[inputs]: https://buf.build/docs/reference/inputs/\n[install]: https://buf.build/docs/cli/installation/\n[jetbrains]: https://buf.build/docs/cli/editor-integration/#jetbrains-ides\n[lint]: https://buf.build/docs/lint/overview/\n[lint_rules]: https://buf.build/docs/lint/rules/\n[lint_usage]: https://buf.build/docs/lint/tutorial/\n[npm]: https://buf.build/docs/cli/installation/#npm\n[minisign]: https://github.com/jedisct1/minisign\n[powershell]: https://docs.microsoft.com/en-us/powershell\n[protobuf]: https://protobuf.dev\n[pushing]: https://buf.build/docs/bsr/module/publish/\n[releases]: https://buf.build/docs/cli/installation/#github\n[repo]: https://github.com/bufbuild/buf/\n[repositories]: https://buf.build/docs/concepts/repositories/\n[source]: https://buf.build/docs/cli/installation/#source\n[tarball]: https://buf.build/docs/cli/installation/#github\n[templates]: https://buf.build/docs/configuration/v2/buf-gen-yaml/\n[users]: https://buf.build/docs/admin/manage-members/\n[verifying]: https://buf.build/docs/cli/installation/#github\n[windows]: https://buf.build/docs/cli/installation/#windows\n[zsh]: https://zsh.org\n" }, { "path": "buf.yaml", "content": "version: v2\nmodules:\n - path: proto\n name: buf.build/bufbuild/buf\nlint:\n use:\n - STANDARD\n - UNARY_RPC\n disallow_comment_ignores: true\nbreaking:\n use:\n - WIRE_JSON\n ignore_unstable_packages: true\n" }, { "path": "cmd/buf/buf.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage main\n\nimport (\n\t\"context\"\n\t\"crypto/tls\"\n\t\"errors\"\n\t\"fmt\"\n\t\"net\"\n\t\"net/http\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/alpha/protoc\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/alpha/registry/token/tokendelete\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/alpha/registry/token/tokenget\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/alpha/registry/token/tokenlist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/bufpluginv1\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/bufpluginv1beta1\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/bufpluginv2\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/price\"\n\tbetaplugindelete \"github.com/bufbuild/buf/cmd/buf/internal/command/beta/registry/plugin/plugindelete\"\n\tbetapluginpush \"github.com/bufbuild/buf/cmd/buf/internal/command/beta/registry/plugin/pluginpush\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/registry/webhook/webhookcreate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/registry/webhook/webhookdelete\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/registry/webhook/webhooklist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/studioagent\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/breaking\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/build\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/config/configinit\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/config/configlsbreakingrules\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/config/configlslintrules\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/config/configlsmodules\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/config/configmigrate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/convert\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/curl\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/dep/depgraph\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/dep/depprune\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/dep/depupdate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/export\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/format\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/generate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/lint\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/lsfiles\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/lsp/lspserve\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/mod/modlsbreakingrules\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/mod/modlslintrules\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/mod/modopen\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/plugin/pluginprune\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/plugin/pluginpush\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/plugin/pluginupdate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/policy/policyprune\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/policy/policypush\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/policy/policyupdate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/push\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulecommit/modulecommitaddlabel\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulecommit/modulecommitinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulecommit/modulecommitlist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulecommit/modulecommitresolve\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulecreate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/moduledelete\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/moduledeprecate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/moduleinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulelabel/modulelabelarchive\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulelabel/modulelabelinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulelabel/modulelabellist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulelabel/modulelabelunarchive\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/modulesettings/modulesettingsupdate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/module/moduleundeprecate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/organization/organizationcreate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/organization/organizationdelete\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/organization/organizationinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/organization/organizationupdate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/plugincommit/plugincommitaddlabel\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/plugincommit/plugincommitinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/plugincommit/plugincommitlist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/plugincommit/plugincommitresolve\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/plugincreate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/plugindelete\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/plugininfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/pluginlabel/pluginlabelarchive\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/pluginlabel/pluginlabelinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/pluginlabel/pluginlabellist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/pluginlabel/pluginlabelunarchive\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/plugin/pluginsettings/pluginsettingsupdate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policycommit/policycommitaddlabel\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policycommit/policycommitinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policycommit/policycommitlist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policycommit/policycommitresolve\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policycreate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policydelete\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policyinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policylabel/policylabelarchive\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policylabel/policylabelinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policylabel/policylabellist\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policylabel/policylabelunarchive\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/policy/policysettings/policysettingsupdate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/registrycc\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/registrylogin\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/registrylogout\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/sdk/sdkinfo\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/sdk/version\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/registry/whoami\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/source/sourceedit/sourceeditdeprecate\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/stats\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcobra\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconnect\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/pkg/slogapp\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/cobra\"\n)\n\nfunc main() {\n\tappcmd.Main(context.Background(), newRootCommand(\"buf\"))\n}\n\nfunc newRootCommand(name string) *appcmd.Command {\n\tbuilder := appext.NewBuilder(\n\t\tname,\n\t\tappext.BuilderWithTimeout(0),\n\t\tappext.BuilderWithInterceptor(newErrorInterceptor()),\n\t\tappext.BuilderWithLoggerProvider(slogapp.LoggerProvider),\n\t)\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"The Buf CLI\",\n\t\tLong: \"A tool for working with Protocol Buffers and managing resources on the Buf Schema Registry (BSR)\",\n\t\tVersion: bufcli.Version,\n\t\tBindPersistentFlags: builder.BindRoot,\n\t\tSubCommands: []*appcmd.Command{\n\t\t\tbuild.NewCommand(\"build\", builder),\n\t\t\texport.NewCommand(\"export\", builder),\n\t\t\tformat.NewCommand(\"format\", builder),\n\t\t\tlint.NewCommand(\"lint\", builder),\n\t\t\tbreaking.NewCommand(\"breaking\", builder),\n\t\t\tgenerate.NewCommand(\"generate\", builder),\n\t\t\tlsfiles.NewCommand(\"ls-files\", builder),\n\t\t\tstats.NewCommand(\"stats\", builder),\n\t\t\tpush.NewCommand(\"push\", builder),\n\t\t\tconvert.NewCommand(\"convert\", builder),\n\t\t\tcurl.NewCommand(\"curl\", builder),\n\t\t\t{\n\t\t\t\tUse: \"dep\",\n\t\t\t\tShort: \"Work with dependencies\",\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tdepgraph.NewCommand(\"graph\", builder),\n\t\t\t\t\tdepprune.NewCommand(\"prune\", builder, ``, false),\n\t\t\t\t\tdepupdate.NewCommand(\"update\", builder, ``, false),\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"config\",\n\t\t\t\tShort: \"Work with configuration files\",\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tconfiginit.NewCommand(\"init\", builder, ``, false, false),\n\t\t\t\t\tconfigmigrate.NewCommand(\"migrate\", builder),\n\t\t\t\t\tconfiglslintrules.NewCommand(\"ls-lint-rules\", builder),\n\t\t\t\t\tconfiglsbreakingrules.NewCommand(\"ls-breaking-rules\", builder),\n\t\t\t\t\tconfiglsmodules.NewCommand(\"ls-modules\", builder),\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"source\",\n\t\t\t\tShort: \"Work with Protobuf source files\",\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"edit\",\n\t\t\t\t\t\tShort: \"Edit Protobuf source files\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\tsourceeditdeprecate.NewCommand(\"deprecate\", builder),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"lsp\",\n\t\t\t\tShort: \"Work with Buf Language Server\",\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tlspserve.NewCommand(\"serve\", builder, ``, false, false),\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"mod\",\n\t\t\t\tShort: `Manage Buf modules, all commands are deprecated and have moved to the \"buf config\", \"buf dep\", or \"buf registry\" subcommands.`,\n\t\t\t\tDeprecated: `all commands are deprecated and have moved to the \"buf config\", \"buf dep\", or \"buf registry\" subcommands.`,\n\t\t\t\tHidden: true,\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t// Deprecated and hidden.\n\t\t\t\t\tconfiginit.NewCommand(\"init\", builder, deprecatedMessage(\"buf config init\", \"buf mod init\"), true, true),\n\t\t\t\t\t// Deprecated and hidden.\n\t\t\t\t\tdepprune.NewCommand(\"prune\", builder, deprecatedMessage(\"buf dep prune\", \"buf mod update\"), true),\n\t\t\t\t\t// Deprecated and hidden.\n\t\t\t\t\tdepupdate.NewCommand(\"update\", builder, deprecatedMessage(\"buf dep update\", \"buf mod update\"), true),\n\t\t\t\t\t// Deprecated and hidden.\n\t\t\t\t\tmodopen.NewCommand(\"open\", builder),\n\t\t\t\t\t// Deprecated and hidden.\n\t\t\t\t\tregistrycc.NewCommand(\"clear-cache\", builder, deprecatedMessage(\"buf registry cc\", \"buf mod clear-cache\"), true, \"cc\"),\n\t\t\t\t\t// Deprecated and hidden.\n\t\t\t\t\tmodlslintrules.NewCommand(\"ls-lint-rules\", builder),\n\t\t\t\t\t// Deprecated and hidden.\n\t\t\t\t\tmodlsbreakingrules.NewCommand(\"ls-breaking-rules\", builder),\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"plugin\",\n\t\t\t\tShort: \"Work with check plugins\",\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tpluginpush.NewCommand(\"push\", builder),\n\t\t\t\t\tpluginupdate.NewCommand(\"update\", builder),\n\t\t\t\t\tpluginprune.NewCommand(\"prune\", builder),\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"policy\",\n\t\t\t\tShort: \"Work with policies\",\n\t\t\t\tHidden: true,\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tpolicypush.NewCommand(\"push\", builder),\n\t\t\t\t\tpolicyupdate.NewCommand(\"update\", builder),\n\t\t\t\t\tpolicyprune.NewCommand(\"prune\", builder),\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"registry\",\n\t\t\t\tShort: \"Manage assets on the Buf Schema Registry\",\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tregistrylogin.NewCommand(\"login\", builder),\n\t\t\t\t\tregistrylogout.NewCommand(\"logout\", builder),\n\t\t\t\t\twhoami.NewCommand(\"whoami\", builder),\n\t\t\t\t\tregistrycc.NewCommand(\"cc\", builder, ``, false),\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"commit\",\n\t\t\t\t\t\tShort: `Manage a module's commits, all commands are deprecated and have moved to the \"buf registry module commit\" subcommands`,\n\t\t\t\t\t\tDeprecated: `all commands are deprecated and have moved to the \"buf registry module commit\" subcommands.`,\n\t\t\t\t\t\tHidden: true,\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\tmodulecommitaddlabel.NewCommand(\"add-label\", builder, deprecatedMessage(\"buf registry module commit add-label\", \"buf registry commit add-label\")),\n\t\t\t\t\t\t\tmodulecommitinfo.NewCommand(\"info\", builder, deprecatedMessage(\"buf registry module commit info\", \"buf registry commit info\")),\n\t\t\t\t\t\t\tmodulecommitlist.NewCommand(\"list\", builder, deprecatedMessage(\"buf registry module commit list\", \"buf registry commit list\")),\n\t\t\t\t\t\t\tmodulecommitresolve.NewCommand(\"resolve\", builder, deprecatedMessage(\"buf registry module commit resolve\", \"buf registry commit resolve\")),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"sdk\",\n\t\t\t\t\t\tShort: \"Manage Generated SDKs\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\tversion.NewCommand(\"version\", builder),\n\t\t\t\t\t\t\tsdkinfo.NewCommand(\"info\", builder),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"label\",\n\t\t\t\t\t\tShort: `Manage a module's labels, all commands are deprecated and have moved to the \"buf registry module label\" subcommands`,\n\t\t\t\t\t\tDeprecated: `all commands are deprecated and have moved to the \"buf registry module label\" subcommands.`,\n\t\t\t\t\t\tHidden: true,\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\tmodulelabelarchive.NewCommand(\"archive\", builder, deprecatedMessage(\"buf registry module label archive\", \"buf registry label archive\")),\n\t\t\t\t\t\t\tmodulelabelinfo.NewCommand(\"info\", builder, deprecatedMessage(\"buf registry module label info\", \"buf registry label info\")),\n\t\t\t\t\t\t\tmodulelabellist.NewCommand(\"list\", builder, deprecatedMessage(\"buf registry module label list\", \"buf registry label list\")),\n\t\t\t\t\t\t\tmodulelabelunarchive.NewCommand(\"unarchive\", builder, deprecatedMessage(\"buf registry module label unarchive\", \"buf registry label unarchive\")),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"organization\",\n\t\t\t\t\t\tShort: \"Manage organizations\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\torganizationcreate.NewCommand(\"create\", builder),\n\t\t\t\t\t\t\torganizationdelete.NewCommand(\"delete\", builder),\n\t\t\t\t\t\t\torganizationinfo.NewCommand(\"info\", builder),\n\t\t\t\t\t\t\torganizationupdate.NewCommand(\"update\", builder),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"module\",\n\t\t\t\t\t\tShort: \"Manage BSR modules\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"commit\",\n\t\t\t\t\t\t\t\tShort: \"Manage a module's commits\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tmodulecommitaddlabel.NewCommand(\"add-label\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tmodulecommitinfo.NewCommand(\"info\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tmodulecommitlist.NewCommand(\"list\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tmodulecommitresolve.NewCommand(\"resolve\", builder, \"\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"label\",\n\t\t\t\t\t\t\t\tShort: \"Manage a module's labels\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tmodulelabelarchive.NewCommand(\"archive\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tmodulelabelinfo.NewCommand(\"info\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tmodulelabellist.NewCommand(\"list\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tmodulelabelunarchive.NewCommand(\"unarchive\", builder, \"\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"settings\",\n\t\t\t\t\t\t\t\tShort: \"Manage a module's settings\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tmodulesettingsupdate.NewCommand(\"update\", builder, \"\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tmodulecreate.NewCommand(\"create\", builder),\n\t\t\t\t\t\t\tmoduleinfo.NewCommand(\"info\", builder),\n\t\t\t\t\t\t\tmoduledelete.NewCommand(\"delete\", builder),\n\t\t\t\t\t\t\tmoduledeprecate.NewCommand(\"deprecate\", builder),\n\t\t\t\t\t\t\tmodulesettingsupdate.NewCommand(\"update\", builder, deprecatedMessage(\"buf registry module settings update\", \"buf registry update\")),\n\t\t\t\t\t\t\tmoduleundeprecate.NewCommand(\"undeprecate\", builder),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"plugin\",\n\t\t\t\t\t\tShort: \"Manage BSR plugins\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"commit\",\n\t\t\t\t\t\t\t\tShort: \"Manage a plugin's commits\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tplugincommitaddlabel.NewCommand(\"add-label\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tplugincommitinfo.NewCommand(\"info\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tplugincommitlist.NewCommand(\"list\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tplugincommitresolve.NewCommand(\"resolve\", builder, \"\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"label\",\n\t\t\t\t\t\t\t\tShort: \"Manage a plugin's labels\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tpluginlabelarchive.NewCommand(\"archive\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpluginlabelinfo.NewCommand(\"info\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpluginlabellist.NewCommand(\"list\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpluginlabelunarchive.NewCommand(\"unarchive\", builder, \"\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"settings\",\n\t\t\t\t\t\t\t\tShort: \"Manage a plugin's settings\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tpluginsettingsupdate.NewCommand(\"update\", builder),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tplugincreate.NewCommand(\"create\", builder),\n\t\t\t\t\t\t\tplugininfo.NewCommand(\"info\", builder),\n\t\t\t\t\t\t\tplugindelete.NewCommand(\"delete\", builder),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"policy\",\n\t\t\t\t\t\tShort: \"Manage BSR policies\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"commit\",\n\t\t\t\t\t\t\t\tShort: \"Manage a policy's commits\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tpolicycommitaddlabel.NewCommand(\"add-label\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpolicycommitinfo.NewCommand(\"info\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpolicycommitlist.NewCommand(\"list\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpolicycommitresolve.NewCommand(\"resolve\", builder, \"\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"label\",\n\t\t\t\t\t\t\t\tShort: \"Manage a policy's labels\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tpolicylabelarchive.NewCommand(\"archive\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpolicylabelinfo.NewCommand(\"info\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpolicylabellist.NewCommand(\"list\", builder, \"\"),\n\t\t\t\t\t\t\t\t\tpolicylabelunarchive.NewCommand(\"unarchive\", builder, \"\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"settings\",\n\t\t\t\t\t\t\t\tShort: \"Manage a policy's settings\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tpolicysettingsupdate.NewCommand(\"update\", builder),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tpolicycreate.NewCommand(\"create\", builder),\n\t\t\t\t\t\t\tpolicyinfo.NewCommand(\"info\", builder),\n\t\t\t\t\t\t\tpolicydelete.NewCommand(\"delete\", builder),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"beta\",\n\t\t\t\tShort: \"Beta commands. Unstable and likely to change\",\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tlspserve.NewCommand(\"lsp\", builder, deprecatedMessage(\"buf lsp serve\", \"buf beta lsp\"), true, true),\n\t\t\t\t\tprice.NewCommand(\"price\", builder),\n\t\t\t\t\tbufpluginv1beta1.NewCommand(\"buf-plugin-v1beta1\", builder),\n\t\t\t\t\tbufpluginv1.NewCommand(\"buf-plugin-v1\", builder),\n\t\t\t\t\tbufpluginv2.NewCommand(\"buf-plugin-v2\", builder),\n\t\t\t\t\tstudioagent.NewCommand(\"studio-agent\", builder),\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"registry\",\n\t\t\t\t\t\tShort: \"Manage assets on the Buf Schema Registry\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"webhook\",\n\t\t\t\t\t\t\t\tShort: \"Manage webhooks for a repository on the Buf Schema Registry\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\twebhookcreate.NewCommand(\"create\", builder),\n\t\t\t\t\t\t\t\t\twebhookdelete.NewCommand(\"delete\", builder),\n\t\t\t\t\t\t\t\t\twebhooklist.NewCommand(\"list\", builder),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"plugin\",\n\t\t\t\t\t\t\t\tShort: \"Manage plugins on the Buf Schema Registry\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\tbetapluginpush.NewCommand(\"push\", builder),\n\t\t\t\t\t\t\t\t\tbetaplugindelete.NewCommand(\"delete\", builder),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tUse: \"alpha\",\n\t\t\t\tShort: \"Alpha commands. Unstable and recommended only for experimentation. These may be deleted\",\n\t\t\t\tHidden: true,\n\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\tprotoc.NewCommand(\"protoc\", builder),\n\t\t\t\t\t{\n\t\t\t\t\t\tUse: \"registry\",\n\t\t\t\t\t\tShort: \"Manage assets on the Buf Schema Registry\",\n\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tUse: \"token\",\n\t\t\t\t\t\t\t\tShort: \"Manage user tokens\",\n\t\t\t\t\t\t\t\tSubCommands: []*appcmd.Command{\n\t\t\t\t\t\t\t\t\ttokenget.NewCommand(\"get\", builder),\n\t\t\t\t\t\t\t\t\ttokenlist.NewCommand(\"list\", builder),\n\t\t\t\t\t\t\t\t\ttokendelete.NewCommand(\"delete\", builder),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\tModifyCobra: func(cobraCommand *cobra.Command) error {\n\t\t\tcobraCommand.AddCommand(bufcobra.NewWebpagesCommand(\"webpages\", cobraCommand))\n\t\t\treturn nil\n\t\t},\n\t}\n}\n\n// newErrorInterceptor returns a CLI interceptor that wraps Buf CLI errors.\nfunc newErrorInterceptor() appext.Interceptor {\n\treturn func(next func(context.Context, appext.Container) error) func(context.Context, appext.Container) error {\n\t\treturn func(ctx context.Context, container appext.Container) error {\n\t\t\treturn wrapError(next(ctx, container))\n\t\t}\n\t}\n}\n\n// wrapError is used when a CLI command fails, regardless of its error code.\n// Note that this function will wrap the error so that the underlying error\n// can be recovered via 'errors.Is'.\nfunc wrapError(err error) error {\n\tif err == nil {\n\t\treturn nil\n\t}\n\n\tvar connectErr *connect.Error\n\tisConnectError := errors.As(err, &connectErr)\n\t// If error is empty and not a system error or Connect error, we return it as-is.\n\tif !isConnectError && err.Error() == \"\" {\n\t\treturn err\n\t}\n\tif isConnectError {\n\t\tvar augmentedConnectError *bufconnect.AugmentedConnectError\n\t\tisAugmentedConnectErr := errors.As(err, &augmentedConnectError)\n\t\tif isPossibleNewCLIOldBSRError(connectErr) && isAugmentedConnectErr {\n\t\t\treturn fmt.Errorf(\"Failure: %[1]s for https://%[2]s%[3]s\\n\"+\n\t\t\t\t\"This version of the buf CLI may require APIs that have not yet been deployed to https://%[2]s\\n\"+\n\t\t\t\t\"To resolve this failure, you can either:\\n\"+\n\t\t\t\t\"- Try using an older version of the buf CLI\\n\"+\n\t\t\t\t\"- Contact the site admin for https://%[2]s to upgrade the instance\",\n\t\t\t\tconnectErr,\n\t\t\t\taugmentedConnectError.Addr(),\n\t\t\t\taugmentedConnectError.Procedure(),\n\t\t\t)\n\t\t}\n\t\tconnectCode := connectErr.Code()\n\t\tswitch {\n\t\tcase connectCode == connect.CodeUnauthenticated, isEmptyUnknownError(err):\n\t\t\tloginCommand := \"buf registry login\"\n\t\t\tauthErr, ok := bufconnect.AsAuthError(err)\n\t\t\tif !ok {\n\t\t\t\t// This code should be unreachable.\n\t\t\t\treturn fmt.Errorf(\"Failure: you are not authenticated. \"+\n\t\t\t\t\t\"Set the %[1]s environment variable or run %q, using a Buf API token as the password. \"+\n\t\t\t\t\t\"If you have set the %[1]s or run the login command, \"+\n\t\t\t\t\t\"your token may have expired. \"+\n\t\t\t\t\t\"For details, visit https://buf.build/docs/bsr/authentication\",\n\t\t\t\t\tbufconnect.TokenEnvKey,\n\t\t\t\t\tloginCommand,\n\t\t\t\t)\n\t\t\t}\n\t\t\t// Invalid token found in env var.\n\t\t\tif authErr.HasToken() && authErr.TokenEnvKey() != \"\" {\n\t\t\t\treturn fmt.Errorf(\"Failure: the %[1]s environment variable is not valid for %[2]s. \"+\n\t\t\t\t\t\"Set %[1]s to a valid Buf API token, or unset it. \"+\n\t\t\t\t\t\"For details, visit https://buf.build/docs/bsr/authentication\",\n\t\t\t\t\tauthErr.TokenEnvKey(), authErr.Remote(),\n\t\t\t\t)\n\t\t\t}\n\t\t\tif authErr.Remote() != bufconnect.DefaultRemote {\n\t\t\t\tloginCommand = fmt.Sprintf(\"%s %s\", loginCommand, authErr.Remote())\n\t\t\t}\n\t\t\t// Invalid token found in netrc.\n\t\t\tif authErr.HasToken() {\n\t\t\t\treturn fmt.Errorf(\"Failure: your Buf API token for %s is invalid. \"+\n\t\t\t\t\t\"Run %q using a valid Buf API token. \"+\n\t\t\t\t\t\"For details, visit https://buf.build/docs/bsr/authentication\",\n\t\t\t\t\tauthErr.Remote(),\n\t\t\t\t\tloginCommand,\n\t\t\t\t)\n\t\t\t}\n\t\t\t// No token found.\n\t\t\treturn fmt.Errorf(\"Failure: you are not authenticated for %s. \"+\n\t\t\t\t\"Set the %s environment variable or run %q, \"+\n\t\t\t\t\"using a Buf API token as the password. \"+\n\t\t\t\t\"For details, visit https://buf.build/docs/bsr/authentication\",\n\t\t\t\tauthErr.Remote(),\n\t\t\t\tbufconnect.TokenEnvKey,\n\t\t\t\tloginCommand,\n\t\t\t)\n\t\tcase connectCode == connect.CodeUnavailable:\n\t\t\tmsg := `Failure: the server hosted at that remote is unavailable.`\n\t\t\t// If the returned error is Unavailable, then determine if this is a DNS error. If so,\n\t\t\t// get the address used so that we can display a more helpful error message.\n\t\t\tif dnsError := (&net.DNSError{}); errors.As(err, &dnsError) && dnsError.IsNotFound {\n\t\t\t\treturn fmt.Errorf(`%s Are you sure \"%s\" is a valid remote address?`, msg, dnsError.Name)\n\t\t\t}\n\t\t\t// If the unavailable error wraps a tls.CertificateVerificationError, show a more specific\n\t\t\t// error message to the user to aid in troubleshooting.\n\t\t\tif tlsErr := wrappedTLSError(err); tlsErr != nil {\n\t\t\t\treturn fmt.Errorf(\"tls certificate verification: %w\", tlsErr)\n\t\t\t}\n\t\t\treturn errors.New(msg)\n\t\t}\n\t}\n\n\tsysError, isSysError := syserror.As(err)\n\tif isSysError {\n\t\terr = fmt.Errorf(\n\t\t\t\"it looks like you have found a bug in buf. \"+\n\t\t\t\t\"Please file an issue at https://github.com/bufbuild/buf/issues \"+\n\t\t\t\t\"and provide the command you ran, as well as the following message: %w\",\n\t\t\tsysError.Unwrap(),\n\t\t)\n\t}\n\n\tvar importNotExistError *bufmodule.ImportNotExistError\n\tif errors.As(err, &importNotExistError) {\n\t\t// There must be a better place to do this, perhaps in the Controller, but this works for now.\n\t\terr = app.WrapError(bufctl.ExitCodeFileAnnotation, importNotExistError)\n\t}\n\n\treturn appFailureError(err)\n}\n\n// isEmptyUnknownError returns true if the given\n// error is non-nil, but has an empty message\n// and an unknown error code.\n//\n// This is relevant for errors returned by\n// envoyauthd when the client does not provide\n// an authentication header.\nfunc isEmptyUnknownError(err error) bool {\n\tif err == nil {\n\t\treturn false\n\t}\n\treturn err.Error() == \"\" && connect.CodeOf(err) == connect.CodeUnknown\n}\n\n// wrappedTLSError returns an unwrapped TLS error or nil if the error is another type of error.\nfunc wrappedTLSError(err error) error {\n\tif tlsErr := (&tls.CertificateVerificationError{}); errors.As(err, &tlsErr) {\n\t\treturn tlsErr\n\t}\n\treturn nil\n}\n\nfunc appFailureError(err error) error {\n\treturn fmt.Errorf(\"Failure: %w\", err)\n}\n\n// isPossibleNewCLIOldBSRError determines if an error might be from a newer\n// version of the CLI interacting with an older version of the BSR.\nfunc isPossibleNewCLIOldBSRError(connectErr *connect.Error) bool {\n\tswitch connectErr.Code() {\n\tcase connect.CodeUnknown:\n\t\t// Older versions of the BSR return errors of this shape\n\t\t// for unrecognized services.\n\t\t// NOTE: This handling can be removed once all BSR instances\n\t\t// are upgraded past v1.7.0.\n\t\treturn connectErr.Message() == fmt.Sprintf(\"%d %s\", http.StatusMethodNotAllowed, http.StatusText(http.StatusMethodNotAllowed))\n\tcase connect.CodeUnimplemented:\n\t\t// RPC was known, but unimplemented in the BSR version.\n\t\treturn true\n\tdefault:\n\t\treturn false\n\t}\n}\n\n// deprecatedMessage returns a message indicating that a command is deprecated.\nfunc deprecatedMessage(newCommand, oldCommand string) string {\n\treturn fmt.Sprintf(\n\t\t`use \"%s\" instead. However, \"%s\" will continue to work.`,\n\t\tnewCommand, oldCommand,\n\t)\n}\n" }, { "path": "cmd/buf/buf_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"slices\"\n\t\"sort\"\n\t\"strconv\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"buf.build/go/app/appcmd/appcmdtesting\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"buf.build/go/standard/xslices\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/internaltesting\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage\"\n\timagev1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/image/v1\"\n\t\"github.com/bufbuild/buf/private/pkg/osext\"\n\t\"github.com/bufbuild/buf/private/pkg/protoencoding\"\n\t\"github.com/bufbuild/buf/private/pkg/slogtestext\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storagetesting\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nvar (\n\tconvertTestDataDir = filepath.Join(\"internal\", \"command\", \"convert\", \"testdata\", \"convert\")\n\t// ordered, contains non-default\n\tbuiltinLintRulesV2 = []*outputCheckRule{\n\t\t{ID: \"DIRECTORY_SAME_PACKAGE\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files in a given directory are in the same package.\"},\n\t\t{ID: \"PACKAGE_DEFINED\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files have a package defined.\"},\n\t\t{ID: \"PACKAGE_DIRECTORY_MATCH\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files are in a directory that matches their package name.\"},\n\t\t{ID: \"PACKAGE_NO_IMPORT_CYCLE\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that packages do not have import cycles.\"},\n\t\t{ID: \"PACKAGE_SAME_DIRECTORY\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package are in the same directory.\"},\n\t\t{ID: \"ENUM_FIRST_VALUE_ZERO\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all first values of enums have a numeric value of 0.\"},\n\t\t{ID: \"ENUM_NO_ALLOW_ALIAS\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that enums do not have the allow_alias option set.\"},\n\t\t{ID: \"ENUM_PASCAL_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that enums are PascalCase.\"},\n\t\t{ID: \"ENUM_VALUE_UPPER_SNAKE_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that enum values are UPPER_SNAKE_CASE.\"},\n\t\t{ID: \"FIELD_LOWER_SNAKE_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that field names are lower_snake_case.\"},\n\t\t{ID: \"FIELD_NOT_REQUIRED\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that fields are not configured to be required.\"},\n\t\t{ID: \"IMPORT_NO_PUBLIC\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that imports are not public.\"},\n\t\t{ID: \"IMPORT_USED\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that imports are used.\"},\n\t\t{ID: \"MESSAGE_PASCAL_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that messages are PascalCase.\"},\n\t\t{ID: \"ONEOF_LOWER_SNAKE_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that oneof names are lower_snake_case.\"},\n\t\t{ID: \"PACKAGE_LOWER_SNAKE_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that packages are lower_snake.case.\"},\n\t\t{ID: \"PACKAGE_SAME_CSHARP_NAMESPACE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package have the same value for the csharp_namespace option.\"},\n\t\t{ID: \"PACKAGE_SAME_GO_PACKAGE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package have the same value for the go_package option.\"},\n\t\t{ID: \"PACKAGE_SAME_JAVA_MULTIPLE_FILES\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package have the same value for the java_multiple_files option.\"},\n\t\t{ID: \"PACKAGE_SAME_JAVA_PACKAGE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package have the same value for the java_package option.\"},\n\t\t{ID: \"PACKAGE_SAME_PHP_NAMESPACE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package have the same value for the php_namespace option.\"},\n\t\t{ID: \"PACKAGE_SAME_RUBY_PACKAGE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package have the same value for the ruby_package option.\"},\n\t\t{ID: \"PACKAGE_SAME_SWIFT_PREFIX\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package have the same value for the swift_prefix option.\"},\n\t\t{ID: \"RPC_PASCAL_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that RPCs are PascalCase.\"},\n\t\t{ID: \"SERVICE_PASCAL_CASE\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that services are PascalCase.\"},\n\t\t{ID: \"SYNTAX_SPECIFIED\", Categories: []string{\"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files have a syntax specified.\"},\n\t\t{ID: \"ENUM_VALUE_PREFIX\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that enum values are prefixed with ENUM_NAME_UPPER_SNAKE_CASE.\"},\n\t\t{ID: \"ENUM_ZERO_VALUE_SUFFIX\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that enum zero values have a consistent suffix (configurable, default suffix is \\\"_UNSPECIFIED\\\").\"},\n\t\t{ID: \"FILE_LOWER_SNAKE_CASE\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that filenames are lower_snake_case.\"},\n\t\t{ID: \"PACKAGE_VERSION_SUFFIX\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that the last component of all packages is a version of the form v\\\\d+, v\\\\d+test.*, v\\\\d+(alpha|beta)\\\\d+, or v\\\\d+p\\\\d+(alpha|beta)\\\\d+, where numbers are >=1.\"},\n\t\t{ID: \"PROTOVALIDATE\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that protovalidate rules are valid and all CEL expressions compile.\"},\n\t\t{ID: \"RPC_REQUEST_RESPONSE_UNIQUE\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that RPC request and response types are only used in one RPC (configurable).\"},\n\t\t{ID: \"RPC_REQUEST_STANDARD_NAME\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that RPC request type names are RPCNameRequest or ServiceNameRPCNameRequest (configurable).\"},\n\t\t{ID: \"RPC_RESPONSE_STANDARD_NAME\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that RPC response type names are RPCNameResponse or ServiceNameRPCNameResponse (configurable).\"},\n\t\t{ID: \"SERVICE_SUFFIX\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that services have a consistent suffix (configurable, default suffix is \\\"Service\\\").\"},\n\t\t{ID: \"COMMENT_ENUM\", Categories: []string{\"COMMENTS\"}, Default: false, Purpose: \"Checks that enums have non-empty comments.\"},\n\t\t{ID: \"COMMENT_ENUM_VALUE\", Categories: []string{\"COMMENTS\"}, Default: false, Purpose: \"Checks that enum values have non-empty comments.\"},\n\t\t{ID: \"COMMENT_FIELD\", Categories: []string{\"COMMENTS\"}, Default: false, Purpose: \"Checks that fields have non-empty comments.\"},\n\t\t{ID: \"COMMENT_MESSAGE\", Categories: []string{\"COMMENTS\"}, Default: false, Purpose: \"Checks that messages have non-empty comments.\"},\n\t\t{ID: \"COMMENT_ONEOF\", Categories: []string{\"COMMENTS\"}, Default: false, Purpose: \"Checks that oneofs have non-empty comments.\"},\n\t\t{ID: \"COMMENT_RPC\", Categories: []string{\"COMMENTS\"}, Default: false, Purpose: \"Checks that RPCs have non-empty comments.\"},\n\t\t{ID: \"COMMENT_SERVICE\", Categories: []string{\"COMMENTS\"}, Default: false, Purpose: \"Checks that services have non-empty comments.\"},\n\t\t{ID: \"RPC_NO_CLIENT_STREAMING\", Categories: []string{\"UNARY_RPC\"}, Default: false, Purpose: \"Checks that RPCs are not client streaming.\"},\n\t\t{ID: \"RPC_NO_SERVER_STREAMING\", Categories: []string{\"UNARY_RPC\"}, Default: false, Purpose: \"Checks that RPCs are not server streaming.\"},\n\t\t{ID: \"STABLE_PACKAGE_NO_IMPORT_UNSTABLE\", Categories: []string{}, Default: false, Purpose: \"Checks that all files that have stable versioned packages do not import packages with unstable version packages.\"},\n\t}\n\t// ordered, contains non-default\n\tbuiltinBreakingRulesV2 = []*outputCheckRule{\n\t\t{ID: \"EXTENSION_NO_DELETE\", Categories: []string{\"FILE\"}, Default: true, Purpose: \"Checks that extensions are not deleted from a given file.\"},\n\t\t{ID: \"SERVICE_NO_DELETE\", Categories: []string{\"FILE\"}, Default: true, Purpose: \"Checks that services are not deleted from a given file.\"},\n\t\t{ID: \"ENUM_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\"}, Default: true, Purpose: \"Checks that enums are not deleted from a given file.\"},\n\t\t{ID: \"FILE_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\"}, Default: true, Purpose: \"Checks that files are not deleted.\"},\n\t\t{ID: \"MESSAGE_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\"}, Default: true, Purpose: \"Checks that messages are not deleted from a given file.\"},\n\t\t{ID: \"ENUM_SAME_TYPE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that enums have the same type (open vs closed).\"},\n\t\t{ID: \"FIELD_SAME_CARDINALITY\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that fields have the same cardinalities in a given message.\"},\n\t\t{ID: \"FIELD_SAME_CPP_STRING_TYPE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that fields have the same C++ string type, based on ctype field option or (pb.cpp).string_type feature.\"},\n\t\t{ID: \"FIELD_SAME_JAVA_UTF8_VALIDATION\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that fields have the same Java string UTF8 validation, based on java_string_check_utf8 file option or (pb.java).utf8_validation feature.\"},\n\t\t{ID: \"FIELD_SAME_JSTYPE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that fields have the same value for the jstype option.\"},\n\t\t{ID: \"FIELD_SAME_UTF8_VALIDATION\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that string fields have the same UTF8 validation mode.\"},\n\t\t{ID: \"FILE_SAME_CC_ENABLE_ARENAS\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the cc_enable_arenas option.\"},\n\t\t{ID: \"FILE_SAME_CC_GENERIC_SERVICES\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the cc_generic_services option.\"},\n\t\t{ID: \"FILE_SAME_CSHARP_NAMESPACE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the csharp_namespace option.\"},\n\t\t{ID: \"FILE_SAME_GO_PACKAGE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the go_package option.\"},\n\t\t{ID: \"FILE_SAME_JAVA_GENERIC_SERVICES\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the java_generic_services option.\"},\n\t\t{ID: \"FILE_SAME_JAVA_MULTIPLE_FILES\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the java_multiple_files option.\"},\n\t\t{ID: \"FILE_SAME_JAVA_OUTER_CLASSNAME\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the java_outer_classname option.\"},\n\t\t{ID: \"FILE_SAME_JAVA_PACKAGE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the java_package option.\"},\n\t\t{ID: \"FILE_SAME_OBJC_CLASS_PREFIX\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the objc_class_prefix option.\"},\n\t\t{ID: \"FILE_SAME_OPTIMIZE_FOR\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the optimize_for option.\"},\n\t\t{ID: \"FILE_SAME_PHP_CLASS_PREFIX\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the php_class_prefix option.\"},\n\t\t{ID: \"FILE_SAME_PHP_METADATA_NAMESPACE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the php_metadata_namespace option.\"},\n\t\t{ID: \"FILE_SAME_PHP_NAMESPACE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the php_namespace option.\"},\n\t\t{ID: \"FILE_SAME_PY_GENERIC_SERVICES\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the py_generic_services option.\"},\n\t\t{ID: \"FILE_SAME_RUBY_PACKAGE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the ruby_package option.\"},\n\t\t{ID: \"FILE_SAME_SWIFT_PREFIX\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same value for the swift_prefix option.\"},\n\t\t{ID: \"RPC_NO_DELETE\", Categories: []string{\"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that rpcs are not deleted from a given service.\"},\n\t\t{ID: \"ENUM_VALUE_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that enum values are not deleted from a given enum.\"},\n\t\t{ID: \"EXTENSION_MESSAGE_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that extension ranges are not deleted from a given message.\"},\n\t\t{ID: \"FIELD_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that fields are not deleted from a given message.\"},\n\t\t{ID: \"FIELD_SAME_TYPE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that fields have the same types in a given message.\"},\n\t\t{ID: \"FILE_SAME_SYNTAX\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that files have the same syntax.\"},\n\t\t{ID: \"MESSAGE_NO_REMOVE_STANDARD_DESCRIPTOR_ACCESSOR\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that messages do not change the no_standard_descriptor_accessor option from false or unset to true.\"},\n\t\t{ID: \"ONEOF_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\"}, Default: true, Purpose: \"Checks that oneofs are not deleted from a given message.\"},\n\t\t{ID: \"ENUM_SAME_JSON_FORMAT\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\"}, Default: true, Purpose: \"Checks that enums have the same JSON format support.\"},\n\t\t{ID: \"ENUM_VALUE_SAME_NAME\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\"}, Default: true, Purpose: \"Checks that enum values have the same name.\"},\n\t\t{ID: \"FIELD_SAME_JSON_NAME\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\"}, Default: true, Purpose: \"Checks that fields have the same value for the json_name option.\"},\n\t\t{ID: \"FIELD_SAME_NAME\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\"}, Default: true, Purpose: \"Checks that fields have the same names in a given message.\"},\n\t\t{ID: \"MESSAGE_SAME_JSON_FORMAT\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\"}, Default: true, Purpose: \"Checks that messages have the same JSON format support.\"},\n\t\t{ID: \"FIELD_SAME_DEFAULT\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that fields have the same default value, if a default is specified.\"},\n\t\t{ID: \"FIELD_SAME_ONEOF\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that fields have the same oneofs in a given message.\"},\n\t\t{ID: \"FILE_SAME_PACKAGE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that files have the same package.\"},\n\t\t{ID: \"MESSAGE_SAME_REQUIRED_FIELDS\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that messages have no added or deleted required fields.\"},\n\t\t{ID: \"RESERVED_ENUM_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that reserved ranges and names are not deleted from a given enum.\"},\n\t\t{ID: \"RESERVED_MESSAGE_NO_DELETE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that reserved ranges and names are not deleted from a given message.\"},\n\t\t{ID: \"RPC_SAME_CLIENT_STREAMING\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that rpcs have the same client streaming value.\"},\n\t\t{ID: \"RPC_SAME_IDEMPOTENCY_LEVEL\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that rpcs have the same value for the idempotency_level option.\"},\n\t\t{ID: \"RPC_SAME_REQUEST_TYPE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that rpcs are have the same request type.\"},\n\t\t{ID: \"RPC_SAME_RESPONSE_TYPE\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that rpcs are have the same response type.\"},\n\t\t{ID: \"RPC_SAME_SERVER_STREAMING\", Categories: []string{\"CSR\", \"FILE\", \"PACKAGE\", \"WIRE_JSON\", \"WIRE\"}, Default: true, Purpose: \"Checks that rpcs have the same server streaming value.\"},\n\t\t{ID: \"PACKAGE_ENUM_NO_DELETE\", Categories: []string{\"PACKAGE\"}, Default: false, Purpose: \"Checks that enums are not deleted from a given package.\"},\n\t\t{ID: \"PACKAGE_EXTENSION_NO_DELETE\", Categories: []string{\"PACKAGE\"}, Default: false, Purpose: \"Checks that extensions are not deleted from a given package.\"},\n\t\t{ID: \"PACKAGE_MESSAGE_NO_DELETE\", Categories: []string{\"PACKAGE\"}, Default: false, Purpose: \"Checks that messages are not deleted from a given package.\"},\n\t\t{ID: \"PACKAGE_NO_DELETE\", Categories: []string{\"PACKAGE\"}, Default: false, Purpose: \"Checks that packages are not deleted.\"},\n\t\t{ID: \"PACKAGE_SERVICE_NO_DELETE\", Categories: []string{\"PACKAGE\"}, Default: false, Purpose: \"Checks that services are not deleted from a given package.\"},\n\t\t{ID: \"ENUM_VALUE_NO_DELETE_UNLESS_NAME_RESERVED\", Categories: []string{\"CSR\", \"WIRE_JSON\"}, Default: false, Purpose: \"Checks that enum values are not deleted from a given enum unless the name is reserved.\"},\n\t\t{ID: \"FIELD_NO_DELETE_UNLESS_NAME_RESERVED\", Categories: []string{\"CSR\", \"WIRE_JSON\"}, Default: false, Purpose: \"Checks that fields are not deleted from a given message unless the name is reserved.\"},\n\t\t{ID: \"FIELD_WIRE_JSON_COMPATIBLE_CARDINALITY\", Categories: []string{\"CSR\", \"WIRE_JSON\"}, Default: false, Purpose: \"Checks that fields have wire and JSON compatible cardinalities in a given message.\"},\n\t\t{ID: \"FIELD_WIRE_JSON_COMPATIBLE_TYPE\", Categories: []string{\"CSR\", \"WIRE_JSON\"}, Default: false, Purpose: \"Checks that fields have wire and JSON compatible types in a given message.\"},\n\t\t{ID: \"ENUM_VALUE_NO_DELETE_UNLESS_NUMBER_RESERVED\", Categories: []string{\"CSR\", \"WIRE_JSON\", \"WIRE\"}, Default: false, Purpose: \"Checks that enum values are not deleted from a given enum unless the number is reserved.\"},\n\t\t{ID: \"FIELD_NO_DELETE_UNLESS_NUMBER_RESERVED\", Categories: []string{\"CSR\", \"WIRE_JSON\", \"WIRE\"}, Default: false, Purpose: \"Checks that fields are not deleted from a given message unless the number is reserved.\"},\n\t\t{ID: \"FIELD_WIRE_COMPATIBLE_CARDINALITY\", Categories: []string{\"WIRE\"}, Default: false, Purpose: \"Checks that fields have wire-compatible cardinalities in a given message.\"},\n\t\t{ID: \"FIELD_WIRE_COMPATIBLE_TYPE\", Categories: []string{\"WIRE\"}, Default: false, Purpose: \"Checks that fields have wire-compatible types in a given message.\"},\n\t}\n)\n\ntype outputCheckRule struct {\n\tID string `json:\"id\"`\n\tCategories []string `json:\"categories\"`\n\tDefault bool `json:\"default\"`\n\tPurpose string `json:\"purpose\"`\n\tPlugin string `json:\"plugin\"`\n\tDeprecated bool `json:\"deprecated\"`\n\tReplacements []string `json:\"replacements\"`\n}\n\nfunc TestSuccess1(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 1, ``, \"build\", \"--source\", filepath.Join(\"testdata\", \"success\"))\n\ttestRunStdout(t, nil, 0, ``, \"build\", filepath.Join(\"testdata\", \"success\"))\n}\n\nfunc TestSuccess2(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 1, ``, \"build\", \"--exclude-imports\", \"--source\", filepath.Join(\"testdata\", \"success\"))\n\ttestRunStdout(t, nil, 0, ``, \"build\", \"--exclude-imports\", filepath.Join(\"testdata\", \"success\"))\n}\n\nfunc TestSuccess3(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 1, ``, \"build\", \"--exclude-source-info\", \"--source\", filepath.Join(\"testdata\", \"success\"))\n\ttestRunStdout(t, nil, 0, ``, \"build\", \"--exclude-source-info\", filepath.Join(\"testdata\", \"success\"))\n}\n\nfunc TestSuccess4(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 1, ``, \"build\", \"--exclude-imports\", \"--exclude-source-info\", \"--source\", filepath.Join(\"testdata\", \"success\"))\n\ttestRunStdout(t, nil, 0, ``, \"build\", \"--exclude-imports\", \"--exclude-source-info\", filepath.Join(\"testdata\", \"success\"))\n}\n\nfunc TestSuccess5(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 1, ``, \"build\", \"--exclude-imports\", \"--exclude-source-info\", \"--source\", filepath.Join(\"testdata\", \"success\"))\n\ttestRunStdout(t, nil, 0, ``, \"build\", \"--exclude-imports\", \"--exclude-source-info\", filepath.Join(\"testdata\", \"success\"))\n}\n\nfunc TestSuccess6(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 0, ``, \"lint\", filepath.Join(\"testdata\", \"success\"))\n\ttestRunStdout(t, nil, 1, ``, \"lint\", \"--input\", filepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"))\n\ttestRunStdout(t, nil, 0, ``, \"lint\", filepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"))\n}\n\nfunc TestSuccessDir(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 0, ``, \"build\", filepath.Join(\"testdata\", \"successnobufyaml\"))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"successnobufyaml\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"successnobufyaml\", \"buf\", \"buf.proto\"),\n\t)\n\twd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\ttestRunStdout(t, nil, 0, ``, \"build\", filepath.Join(wd, \"testdata\", \"successnobufyaml\"))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(wd, \"testdata\", \"successnobufyaml\"),\n\t\t\"--path\",\n\t\tfilepath.Join(wd, \"testdata\", \"successnobufyaml\", \"buf\", \"buf.proto\"),\n\t)\n}\n\nfunc TestFail1(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"build\",\n\t\t\"--source\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n}\n\nfunc TestFail2(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"build\",\n\t\t\"--exclude-imports\",\n\t\t\"--source\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\t\"--exclude-imports\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n}\n\nfunc TestFail3(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"build\",\n\t\t\"--exclude-source-info\",\n\t\t\"--source\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\t\"--exclude-source-info\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n}\n\nfunc TestFail4(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"build\",\n\t\t\"--exclude-imports\",\n\t\t\"--exclude-source-info\",\n\t\t\"--source\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\t\"--exclude-imports\",\n\t\t\"--exclude-source-info\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n}\n\nfunc TestFail5(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail/buf/buf.proto:3:1:Files with package \"other\" must be within a directory \"other\" relative to root but were in directory \"buf\".\n testdata/fail/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"lint\",\n\t\t\"--input\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail/buf/buf.proto:3:1:Files with package \"other\" must be within a directory \"other\" relative to root but were in directory \"buf\".\n testdata/fail/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t)\n}\n\nfunc TestFail6(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail/buf/buf.proto:3:1:Files with package \"other\" must be within a directory \"other\" relative to root but were in directory \"buf\".\n testdata/fail/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".`),\n\t\t\"\", // stderr should be empty\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"lint\",\n\t\t\"--input\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t)\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\", // stdout should be empty\n\t\t\"Failure: --path is not valid for use with .proto file references\",\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t)\n}\n\nfunc TestFail7(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t\t\"--input-config\",\n\t\t`{\"version\":\"v1\",\"lint\":{\"use\":[\"BASIC\"]}}`,\n\t)\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail/buf/buf.proto:3:1:Files with package \"other\" must be within a directory \"other\" relative to root but were in directory \"fail/buf\".\ntestdata/fail/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".`),\n\t\t// This is new behavior we introduced. When setting a config override, we no longer do\n\t\t// a search for the controlling workspace. See bufctl/option.go for additional details.\n\t\t// Only the paths specified by \"--path\" in the command are considered. This avoids build\n\t\t// failures from other proto files under testdata. Command \"build\" succeeds with this path\n\t\t// restriction, \"lint\" should be able to build the image and only fail on lint issue for\n\t\t// the specified file.\n\t\t\"\",\n\t\t\"lint\",\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t\tfilepath.Join(\"testdata\"),\n\t\t\"--config\",\n\t\t`{\"version\":\"v1beta1\",\"lint\":{\"use\":[\"BASIC\"]}}`,\n\t)\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\t// Note: `were in directory \"buf\"` was changed to `were in directory \"testdata/fail/buf\"`\n\t\t// during the refactor. This is actually more correct - pre-refactor, the CLI was acting\n\t\t// as if the buf.yaml at testdata/fail/buf.yaml mattered in some way. In fact, it doesn't -\n\t\t// you've said that you have overridden it entirely.\n\t\tfilepath.FromSlash(`testdata/fail/buf/buf.proto:3:1:Files with package \"other\" must be within a directory \"other\" relative to root but were in directory \".\".\ntestdata/fail/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".`),\n\t\t\"\", // stderr should be empty\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail\", \"buf\", \"buf.proto\"),\n\t\t\"--config\",\n\t\t`{\"version\":\"v1\",\"lint\":{\"use\":[\"BASIC\"]}}`,\n\t)\n}\n\nfunc TestFail8(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail2/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".\n\t\ttestdata/fail2/buf/buf2.proto:9:9:Field name \"oneThree\" should be lower_snake_case, such as \"one_three\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail2\"),\n\t)\n}\n\nfunc TestFail9(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail2/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail2\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail2\", \"buf\", \"buf.proto\"),\n\t)\n}\n\nfunc TestFail10(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail2\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail2\", \"buf\", \"buf3.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\",\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail2\", \"buf\", \"buf3.proto\"),\n\t)\n}\n\nfunc TestFail11(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t\"lint\",\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail2\", \"buf\", \"buf2.proto\"),\n\t\t\"--input\",\n\t\tfilepath.Join(\"testdata\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail2/buf/buf2.proto:9:9:Field name \"oneThree\" should be lower_snake_case, such as \"one_three\".`),\n\t\t\"lint\",\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"fail2\", \"buf\", \"buf2.proto\"),\n\t\tfilepath.Join(\"testdata\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail2/buf/buf2.proto:9:9:Field name \"oneThree\" should be lower_snake_case, such as \"one_three\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail2\", \"buf\", \"buf2.proto\"),\n\t)\n}\n\nfunc TestFail12(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\t`version: v1\nlint:\n ignore_only:\n FIELD_LOWER_SNAKE_CASE:\n\t - buf/buf.proto\n\tPACKAGE_DIRECTORY_MATCH:\n\t - buf/buf.proto`,\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t\t\"--error-format\",\n\t\t\"config-ignore-yaml\",\n\t)\n}\n\nfunc TestFail13(t *testing.T) {\n\tt.Parallel()\n\t// this tests that we still use buf.mod if it exists\n\t// this has an ignore for FIELD_LOWER_SNAKE_CASE to make sure we are actually reading the config\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/fail_buf_mod/buf/buf.proto:3:1:Files with package \"other\" must be within a directory \"other\" relative to root but were in directory \"buf\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"fail_buf_mod\"),\n\t)\n}\n\nfunc TestFailCheckBreaking1(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\n\t\t../../private/bufpkg/bufcheck/testdata/breaking/current/breaking_field_no_delete/1.proto:5:1:Previously present field \"3\" with name \"three\" on message \"Two\" was deleted.\n\t\t../../private/bufpkg/bufcheck/testdata/breaking/current/breaking_field_no_delete/1.proto:10:1:Previously present field \"3\" with name \"three\" on message \"Three\" was deleted.\n\t\t../../private/bufpkg/bufcheck/testdata/breaking/current/breaking_field_no_delete/1.proto:12:5:Previously present field \"3\" with name \"three\" on message \"Five\" was deleted.\n\t\t../../private/bufpkg/bufcheck/testdata/breaking/current/breaking_field_no_delete/1.proto:22:3:Previously present field \"3\" with name \"three\" on message \"Seven\" was deleted.\n\t\t../../private/bufpkg/bufcheck/testdata/breaking/current/breaking_field_no_delete/2.proto:57:1:Previously present field \"3\" with name \"three\" on message \"Nine\" was deleted.\n\t\t`),\n\t\t\"\", // stderr should be empty\n\t\t\"breaking\",\n\t\t// can't bother right now to filepath.Join this\n\t\t\"../../private/bufpkg/bufcheck/testdata/breaking/current/breaking_field_no_delete\",\n\t\t\"--against\",\n\t\t\"../../private/bufpkg/bufcheck/testdata/breaking/previous/breaking_field_no_delete\",\n\t)\n}\n\nfunc TestFailCheckBreaking2(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/protofileref/breaking/a/foo.proto:7:3:Field \"2\" with name \"world\" on message \"Foo\" changed type from \"int32\" to \"string\".`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"a\", \"foo.proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"b\", \"foo.proto\"),\n\t)\n}\n\nfunc TestFailCheckBreaking3(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\n\t\t:1:1:Previously present file \"bar.proto\" was deleted.\n\t\ttestdata/protofileref/breaking/a/foo.proto:7:3:Field \"2\" with name \"world\" on message \"Foo\" changed type from \"int32\" to \"string\".\n\t\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"a\", \"foo.proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"b\"),\n\t)\n}\n\nfunc TestFailCheckBreaking4(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\n\t\ttestdata/protofileref/breaking/a/bar.proto:5:1:Previously present field \"2\" with name \"value\" on message \"Bar\" was deleted.\n\t\ttestdata/protofileref/breaking/a/foo.proto:7:3:Field \"2\" with name \"world\" on message \"Foo\" changed type from \"int32\" to \"string\".\n\t\t`),\n\t\t\"breaking\",\n\t\tfmt.Sprintf(\"%s#include_package_files=true\", filepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"a\", \"foo.proto\")),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"b\"),\n\t)\n}\n\nfunc TestFailCheckBreaking5(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\n :1:1:Previously present file \"bar.proto\" was deleted.\n\t\ttestdata/protofileref/breaking/a/foo.proto:7:3:Field \"2\" with name \"world\" on message \"Foo\" changed type from \"int32\" to \"string\".\n\t\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"a\", \"foo.proto\"),\n\t\t\"--against\",\n\t\tfmt.Sprintf(\"%s#include_package_files=true\", filepath.Join(\"testdata\", \"protofileref\", \"breaking\", \"b\", \"foo.proto\")),\n\t)\n}\n\nfunc TestCheckLsLintRulesModAll(t *testing.T) {\n\tt.Parallel()\n\texpectedStdout := `\nID CATEGORIES DEFAULT PURPOSE\nDIRECTORY_SAME_PACKAGE MINIMAL, BASIC, STANDARD * Checks that all files in a given directory are in the same package.\nPACKAGE_DEFINED MINIMAL, BASIC, STANDARD * Checks that all files have a package defined.\nPACKAGE_DIRECTORY_MATCH MINIMAL, BASIC, STANDARD * Checks that all files are in a directory that matches their package name.\nPACKAGE_SAME_DIRECTORY MINIMAL, BASIC, STANDARD * Checks that all files with a given package are in the same directory.\nENUM_FIRST_VALUE_ZERO BASIC, STANDARD * Checks that all first values of enums have a numeric value of 0.\nENUM_NO_ALLOW_ALIAS BASIC, STANDARD * Checks that enums do not have the allow_alias option set.\nENUM_PASCAL_CASE BASIC, STANDARD * Checks that enums are PascalCase.\nENUM_VALUE_UPPER_SNAKE_CASE BASIC, STANDARD * Checks that enum values are UPPER_SNAKE_CASE.\nFIELD_LOWER_SNAKE_CASE BASIC, STANDARD * Checks that field names are lower_snake_case.\nIMPORT_NO_PUBLIC BASIC, STANDARD * Checks that imports are not public.\nIMPORT_USED BASIC, STANDARD * Checks that imports are used.\nMESSAGE_PASCAL_CASE BASIC, STANDARD * Checks that messages are PascalCase.\nONEOF_LOWER_SNAKE_CASE BASIC, STANDARD * Checks that oneof names are lower_snake_case.\nPACKAGE_LOWER_SNAKE_CASE BASIC, STANDARD * Checks that packages are lower_snake.case.\nPACKAGE_SAME_CSHARP_NAMESPACE BASIC, STANDARD * Checks that all files with a given package have the same value for the csharp_namespace option.\nPACKAGE_SAME_GO_PACKAGE BASIC, STANDARD * Checks that all files with a given package have the same value for the go_package option.\nPACKAGE_SAME_JAVA_MULTIPLE_FILES BASIC, STANDARD * Checks that all files with a given package have the same value for the java_multiple_files option.\nPACKAGE_SAME_JAVA_PACKAGE BASIC, STANDARD * Checks that all files with a given package have the same value for the java_package option.\nPACKAGE_SAME_PHP_NAMESPACE BASIC, STANDARD * Checks that all files with a given package have the same value for the php_namespace option.\nPACKAGE_SAME_RUBY_PACKAGE BASIC, STANDARD * Checks that all files with a given package have the same value for the ruby_package option.\nPACKAGE_SAME_SWIFT_PREFIX BASIC, STANDARD * Checks that all files with a given package have the same value for the swift_prefix option.\nRPC_PASCAL_CASE BASIC, STANDARD * Checks that RPCs are PascalCase.\nSERVICE_PASCAL_CASE BASIC, STANDARD * Checks that services are PascalCase.\nSYNTAX_SPECIFIED BASIC, STANDARD * Checks that all files have a syntax specified.\nENUM_VALUE_PREFIX STANDARD * Checks that enum values are prefixed with ENUM_NAME_UPPER_SNAKE_CASE.\nENUM_ZERO_VALUE_SUFFIX STANDARD * Checks that enum zero values have a consistent suffix (configurable, default suffix is \"_UNSPECIFIED\").\nFILE_LOWER_SNAKE_CASE STANDARD * Checks that filenames are lower_snake_case.\nPACKAGE_VERSION_SUFFIX STANDARD * Checks that the last component of all packages is a version of the form v\\d+, v\\d+test.*, v\\d+(alpha|beta)\\d+, or v\\d+p\\d+(alpha|beta)\\d+, where numbers are >=1.\nPROTOVALIDATE STANDARD * Checks that protovalidate rules are valid and all CEL expressions compile.\nRPC_REQUEST_RESPONSE_UNIQUE STANDARD * Checks that RPC request and response types are only used in one RPC (configurable).\nRPC_REQUEST_STANDARD_NAME STANDARD * Checks that RPC request type names are RPCNameRequest or ServiceNameRPCNameRequest (configurable).\nRPC_RESPONSE_STANDARD_NAME STANDARD * Checks that RPC response type names are RPCNameResponse or ServiceNameRPCNameResponse (configurable).\nSERVICE_SUFFIX STANDARD * Checks that services have a consistent suffix (configurable, default suffix is \"Service\").\nCOMMENT_ENUM COMMENTS Checks that enums have non-empty comments.\nCOMMENT_ENUM_VALUE COMMENTS Checks that enum values have non-empty comments.\nCOMMENT_FIELD COMMENTS Checks that fields have non-empty comments.\nCOMMENT_MESSAGE COMMENTS Checks that messages have non-empty comments.\nCOMMENT_ONEOF COMMENTS Checks that oneofs have non-empty comments.\nCOMMENT_RPC COMMENTS Checks that RPCs have non-empty comments.\nCOMMENT_SERVICE COMMENTS Checks that services have non-empty comments.\nRPC_NO_CLIENT_STREAMING UNARY_RPC Checks that RPCs are not client streaming.\nRPC_NO_SERVER_STREAMING UNARY_RPC Checks that RPCs are not server streaming.\nPACKAGE_NO_IMPORT_CYCLE Checks that packages do not have import cycles.\n\t\t`\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\texpectedStdout,\n\t\t\"mod\",\n\t\t\"ls-lint-rules\",\n\t\t\"--all\",\n\t)\n}\n\nfunc TestCheckPolicyConfigLsLintRulesConfigured(t *testing.T) {\n\tt.Parallel()\n\texpectedConfiguredOnlyStdout, err := os.ReadFile(filepath.Join(\"testdata\", \"policy_list_rules\", \"expected_ls_lint_rules_configured_only.txt\"))\n\trequire.NoError(t, err)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\tstring(expectedConfiguredOnlyStdout),\n\t\t\"config\",\n\t\t\"ls-lint-rules\",\n\t\t\"--config\",\n\t\tfilepath.Join(\"testdata\", \"policy_list_rules\", \"buf.yaml\"),\n\t\t\"--configured-only\",\n\t)\n}\n\nfunc TestCheckLsLintRulesFromConfig(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`\n\t\tID CATEGORIES DEFAULT PURPOSE\n\t\tPACKAGE_DIRECTORY_MATCH MINIMAL, BASIC, STANDARD, FILE_LAYOUT * Checks that all files are in a directory that matches their package name.\n\t\tENUM_NO_ALLOW_ALIAS MINIMAL, BASIC, STANDARD, SENSIBLE * Checks that enums do not have the allow_alias option set.\n\t\t`,\n\t\t\"mod\",\n\t\t\"ls-lint-rules\",\n\t\t\"--config\",\n\t\tfilepath.Join(\"testdata\", \"small_list_rules\", \"buf.yaml\"),\n\t)\n\t// defaults only, built-ins and plugins.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeLint,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\tappend(\n\t\t\txslices.Filter(builtinLintRulesV2, func(lintRule *outputCheckRule) bool {\n\t\t\t\treturn lintRule.Default\n\t\t\t}),\n\t\t\t&outputCheckRule{ID: \"RPC_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no RPCs with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t&outputCheckRule{ID: \"SERVICE_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no services with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t),\n\t)\n\t// configure a deprecated category and a non-deprecated built-in category.\n\t// deprecated category contains some non-deprecated rules.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeLint,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"lint\": {\n\t\t\t\t\"use\": [\"MINIMAL\", \"RESOURCE_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\t[]*outputCheckRule{\n\t\t\t{ID: \"DIRECTORY_SAME_PACKAGE\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files in a given directory are in the same package.\"},\n\t\t\t{ID: \"PACKAGE_DEFINED\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files have a package defined.\"},\n\t\t\t{ID: \"PACKAGE_DIRECTORY_MATCH\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files are in a directory that matches their package name.\"},\n\t\t\t{ID: \"PACKAGE_NO_IMPORT_CYCLE\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that packages do not have import cycles.\"},\n\t\t\t{ID: \"PACKAGE_SAME_DIRECTORY\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package are in the same directory.\"},\n\t\t\t{ID: \"ENUM_VALUE_BANNED_SUFFIXES\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that there are no enum values of top-level enums with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"FIELD_BANNED_SUFFIXES\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that there are no fields with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t},\n\t)\n\t// configure a deprecated category and a non-deprecated category, no built-ins.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeLint,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"lint\": {\n\t\t\t\t\"use\": [\"OPERATION_SUFFIXES\",\"ATTRIBUTES_SUFFIXES\", \"RESOURCE_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\t[]*outputCheckRule{\n\t\t\t{ID: \"RPC_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no RPCs with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"SERVICE_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no services with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"ENUM_VALUE_BANNED_SUFFIXES\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that there are no enum values of top-level enums with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"FIELD_BANNED_SUFFIXES\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that there are no fields with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t},\n\t)\n\t// configure a deprecated category and a non-deprecated category, no built-ins.\n\t// note: ATTRIBUTES_SUFFIXES is not in USE, but is the replacement category for\n\t// RESOURCE_SUFFIXES.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeLint,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"lint\": {\n\t\t\t\t\"use\": [\"OPERATION_SUFFIXES\", \"RESOURCE_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\t[]*outputCheckRule{\n\t\t\t{ID: \"RPC_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no RPCs with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"SERVICE_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no services with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"ENUM_VALUE_BANNED_SUFFIXES\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that there are no enum values of top-level enums with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"FIELD_BANNED_SUFFIXES\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that there are no fields with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t},\n\t)\n\t// configure a mix of rules from built-ins and plugins. MESSAGE_BANNED_SUFFIXES is a deprecated\n\t// rule, expect to print its replacement, FIELD_BANNED_SUFFIXES.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeLint,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"lint\": {\n\t\t\t\t\"use\": [\"RPC_BANNED_SUFFIXES\",\"SERVICE_SUFFIX\", \"MESSAGE_BANNED_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\t[]*outputCheckRule{\n\t\t\t{ID: \"SERVICE_SUFFIX\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that services have a consistent suffix (configurable, default suffix is \\\"Service\\\").\"},\n\t\t\t{ID: \"RPC_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no RPCs with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"FIELD_BANNED_SUFFIXES\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that there are no fields with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t},\n\t)\n\t// configure a mix of categories and rules from built-ins and plugins.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeLint,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"lint\": {\n\t\t\t\t\"use\": [\"RPC_BANNED_SUFFIXES\",\"SERVICE_SUFFIX\", \"MINIMAL\", \"OPERATION_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\t[]*outputCheckRule{\n\t\t\t{ID: \"DIRECTORY_SAME_PACKAGE\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files in a given directory are in the same package.\"},\n\t\t\t{ID: \"PACKAGE_DEFINED\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files have a package defined.\"},\n\t\t\t{ID: \"PACKAGE_DIRECTORY_MATCH\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files are in a directory that matches their package name.\"},\n\t\t\t{ID: \"PACKAGE_NO_IMPORT_CYCLE\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that packages do not have import cycles.\"},\n\t\t\t{ID: \"PACKAGE_SAME_DIRECTORY\", Categories: []string{\"MINIMAL\", \"BASIC\", \"STANDARD\"}, Default: true, Purpose: \"Checks that all files with a given package are in the same directory.\"},\n\t\t\t{ID: \"SERVICE_SUFFIX\", Categories: []string{\"STANDARD\"}, Default: true, Purpose: \"Checks that services have a consistent suffix (configurable, default suffix is \\\"Service\\\").\"},\n\t\t\t{ID: \"RPC_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no RPCs with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"SERVICE_BANNED_SUFFIXES\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that there are no services with the list of configured banned suffixes.\", Plugin: \"buf-plugin-suffix\"},\n\t\t},\n\t)\n}\n\nfunc TestCheckLsLintRulesV1Beta1(t *testing.T) {\n\tt.Parallel()\n\texpectedStdout := `\nID CATEGORIES DEFAULT PURPOSE\nDIRECTORY_SAME_PACKAGE MINIMAL, BASIC, STANDARD, FILE_LAYOUT * Checks that all files in a given directory are in the same package.\nPACKAGE_DIRECTORY_MATCH MINIMAL, BASIC, STANDARD, FILE_LAYOUT * Checks that all files are in a directory that matches their package name.\nPACKAGE_SAME_DIRECTORY MINIMAL, BASIC, STANDARD, FILE_LAYOUT * Checks that all files with a given package are in the same directory.\nPACKAGE_SAME_CSHARP_NAMESPACE MINIMAL, BASIC, STANDARD, PACKAGE_AFFINITY * Checks that all files with a given package have the same value for the csharp_namespace option.\nPACKAGE_SAME_GO_PACKAGE MINIMAL, BASIC, STANDARD, PACKAGE_AFFINITY * Checks that all files with a given package have the same value for the go_package option.\nPACKAGE_SAME_JAVA_MULTIPLE_FILES MINIMAL, BASIC, STANDARD, PACKAGE_AFFINITY * Checks that all files with a given package have the same value for the java_multiple_files option.\nPACKAGE_SAME_JAVA_PACKAGE MINIMAL, BASIC, STANDARD, PACKAGE_AFFINITY * Checks that all files with a given package have the same value for the java_package option.\nPACKAGE_SAME_PHP_NAMESPACE MINIMAL, BASIC, STANDARD, PACKAGE_AFFINITY * Checks that all files with a given package have the same value for the php_namespace option.\nPACKAGE_SAME_RUBY_PACKAGE MINIMAL, BASIC, STANDARD, PACKAGE_AFFINITY * Checks that all files with a given package have the same value for the ruby_package option.\nPACKAGE_SAME_SWIFT_PREFIX MINIMAL, BASIC, STANDARD, PACKAGE_AFFINITY * Checks that all files with a given package have the same value for the swift_prefix option.\nENUM_NO_ALLOW_ALIAS MINIMAL, BASIC, STANDARD, SENSIBLE * Checks that enums do not have the allow_alias option set.\nFIELD_NO_DESCRIPTOR MINIMAL, BASIC, STANDARD, SENSIBLE * Checks that field names are not any capitalization of \"descriptor\" with any number of prefix or suffix underscores.\nIMPORT_NO_PUBLIC MINIMAL, BASIC, STANDARD, SENSIBLE * Checks that imports are not public.\nPACKAGE_DEFINED MINIMAL, BASIC, STANDARD, SENSIBLE * Checks that all files have a package defined.\nENUM_PASCAL_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that enums are PascalCase.\nENUM_VALUE_UPPER_SNAKE_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that enum values are UPPER_SNAKE_CASE.\nFIELD_LOWER_SNAKE_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that field names are lower_snake_case.\nMESSAGE_PASCAL_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that messages are PascalCase.\nONEOF_LOWER_SNAKE_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that oneof names are lower_snake_case.\nPACKAGE_LOWER_SNAKE_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that packages are lower_snake.case.\nRPC_PASCAL_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that RPCs are PascalCase.\nSERVICE_PASCAL_CASE BASIC, STANDARD, STYLE_BASIC, STYLE_STANDARD * Checks that services are PascalCase.\nENUM_VALUE_PREFIX STANDARD, STYLE_STANDARD * Checks that enum values are prefixed with ENUM_NAME_UPPER_SNAKE_CASE.\nENUM_ZERO_VALUE_SUFFIX STANDARD, STYLE_STANDARD * Checks that enum zero values have a consistent suffix (configurable, default suffix is \"_UNSPECIFIED\").\nFILE_LOWER_SNAKE_CASE STANDARD, STYLE_STANDARD * Checks that filenames are lower_snake_case.\nPACKAGE_VERSION_SUFFIX STANDARD, STYLE_STANDARD * Checks that the last component of all packages is a version of the form v\\d+, v\\d+test.*, v\\d+(alpha|beta)\\d+, or v\\d+p\\d+(alpha|beta)\\d+, where numbers are >=1.\nRPC_REQUEST_RESPONSE_UNIQUE STANDARD, STYLE_STANDARD * Checks that RPC request and response types are only used in one RPC (configurable).\nRPC_REQUEST_STANDARD_NAME STANDARD, STYLE_STANDARD * Checks that RPC request type names are RPCNameRequest or ServiceNameRPCNameRequest (configurable).\nRPC_RESPONSE_STANDARD_NAME STANDARD, STYLE_STANDARD * Checks that RPC response type names are RPCNameResponse or ServiceNameRPCNameResponse (configurable).\nSERVICE_SUFFIX STANDARD, STYLE_STANDARD * Checks that services have a consistent suffix (configurable, default suffix is \"Service\").\nCOMMENT_ENUM COMMENTS Checks that enums have non-empty comments.\nCOMMENT_ENUM_VALUE COMMENTS Checks that enum values have non-empty comments.\nCOMMENT_FIELD COMMENTS Checks that fields have non-empty comments.\nCOMMENT_MESSAGE COMMENTS Checks that messages have non-empty comments.\nCOMMENT_ONEOF COMMENTS Checks that oneofs have non-empty comments.\nCOMMENT_RPC COMMENTS Checks that RPCs have non-empty comments.\nCOMMENT_SERVICE COMMENTS Checks that services have non-empty comments.\nRPC_NO_CLIENT_STREAMING UNARY_RPC Checks that RPCs are not client streaming.\nRPC_NO_SERVER_STREAMING UNARY_RPC Checks that RPCs are not server streaming.\nENUM_FIRST_VALUE_ZERO OTHER Checks that all first values of enums have a numeric value of 0.\n\t\t`\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\texpectedStdout,\n\t\t\"mod\",\n\t\t\"ls-lint-rules\",\n\t\t\"--version\",\n\t\t\"v1beta1\",\n\t)\n}\n\nfunc TestCheckLsLintRulesV2(t *testing.T) {\n\tt.Parallel()\n\texpectedStdout := `\nID CATEGORIES DEFAULT PURPOSE\nDIRECTORY_SAME_PACKAGE MINIMAL, BASIC, STANDARD * Checks that all files in a given directory are in the same package.\nPACKAGE_DEFINED MINIMAL, BASIC, STANDARD * Checks that all files have a package defined.\nPACKAGE_DIRECTORY_MATCH MINIMAL, BASIC, STANDARD * Checks that all files are in a directory that matches their package name.\nPACKAGE_NO_IMPORT_CYCLE MINIMAL, BASIC, STANDARD * Checks that packages do not have import cycles.\nPACKAGE_SAME_DIRECTORY MINIMAL, BASIC, STANDARD * Checks that all files with a given package are in the same directory.\nENUM_FIRST_VALUE_ZERO BASIC, STANDARD * Checks that all first values of enums have a numeric value of 0.\nENUM_NO_ALLOW_ALIAS BASIC, STANDARD * Checks that enums do not have the allow_alias option set.\nENUM_PASCAL_CASE BASIC, STANDARD * Checks that enums are PascalCase.\nENUM_VALUE_UPPER_SNAKE_CASE BASIC, STANDARD * Checks that enum values are UPPER_SNAKE_CASE.\nFIELD_LOWER_SNAKE_CASE BASIC, STANDARD * Checks that field names are lower_snake_case.\nFIELD_NOT_REQUIRED BASIC, STANDARD * Checks that fields are not configured to be required.\nIMPORT_NO_PUBLIC BASIC, STANDARD * Checks that imports are not public.\nIMPORT_USED BASIC, STANDARD * Checks that imports are used.\nMESSAGE_PASCAL_CASE BASIC, STANDARD * Checks that messages are PascalCase.\nONEOF_LOWER_SNAKE_CASE BASIC, STANDARD * Checks that oneof names are lower_snake_case.\nPACKAGE_LOWER_SNAKE_CASE BASIC, STANDARD * Checks that packages are lower_snake.case.\nPACKAGE_SAME_CSHARP_NAMESPACE BASIC, STANDARD * Checks that all files with a given package have the same value for the csharp_namespace option.\nPACKAGE_SAME_GO_PACKAGE BASIC, STANDARD * Checks that all files with a given package have the same value for the go_package option.\nPACKAGE_SAME_JAVA_MULTIPLE_FILES BASIC, STANDARD * Checks that all files with a given package have the same value for the java_multiple_files option.\nPACKAGE_SAME_JAVA_PACKAGE BASIC, STANDARD * Checks that all files with a given package have the same value for the java_package option.\nPACKAGE_SAME_PHP_NAMESPACE BASIC, STANDARD * Checks that all files with a given package have the same value for the php_namespace option.\nPACKAGE_SAME_RUBY_PACKAGE BASIC, STANDARD * Checks that all files with a given package have the same value for the ruby_package option.\nPACKAGE_SAME_SWIFT_PREFIX BASIC, STANDARD * Checks that all files with a given package have the same value for the swift_prefix option.\nRPC_PASCAL_CASE BASIC, STANDARD * Checks that RPCs are PascalCase.\nSERVICE_PASCAL_CASE BASIC, STANDARD * Checks that services are PascalCase.\nSYNTAX_SPECIFIED BASIC, STANDARD * Checks that all files have a syntax specified.\nENUM_VALUE_PREFIX STANDARD * Checks that enum values are prefixed with ENUM_NAME_UPPER_SNAKE_CASE.\nENUM_ZERO_VALUE_SUFFIX STANDARD * Checks that enum zero values have a consistent suffix (configurable, default suffix is \"_UNSPECIFIED\").\nFILE_LOWER_SNAKE_CASE STANDARD * Checks that filenames are lower_snake_case.\nPACKAGE_VERSION_SUFFIX STANDARD * Checks that the last component of all packages is a version of the form v\\d+, v\\d+test.*, v\\d+(alpha|beta)\\d+, or v\\d+p\\d+(alpha|beta)\\d+, where numbers are >=1.\nPROTOVALIDATE STANDARD * Checks that protovalidate rules are valid and all CEL expressions compile.\nRPC_REQUEST_RESPONSE_UNIQUE STANDARD * Checks that RPC request and response types are only used in one RPC (configurable).\nRPC_REQUEST_STANDARD_NAME STANDARD * Checks that RPC request type names are RPCNameRequest or ServiceNameRPCNameRequest (configurable).\nRPC_RESPONSE_STANDARD_NAME STANDARD * Checks that RPC response type names are RPCNameResponse or ServiceNameRPCNameResponse (configurable).\nSERVICE_SUFFIX STANDARD * Checks that services have a consistent suffix (configurable, default suffix is \"Service\").\nCOMMENT_ENUM COMMENTS Checks that enums have non-empty comments.\nCOMMENT_ENUM_VALUE COMMENTS Checks that enum values have non-empty comments.\nCOMMENT_FIELD COMMENTS Checks that fields have non-empty comments.\nCOMMENT_MESSAGE COMMENTS Checks that messages have non-empty comments.\nCOMMENT_ONEOF COMMENTS Checks that oneofs have non-empty comments.\nCOMMENT_RPC COMMENTS Checks that RPCs have non-empty comments.\nCOMMENT_SERVICE COMMENTS Checks that services have non-empty comments.\nRPC_NO_CLIENT_STREAMING UNARY_RPC Checks that RPCs are not client streaming.\nRPC_NO_SERVER_STREAMING UNARY_RPC Checks that RPCs are not server streaming.\nSTABLE_PACKAGE_NO_IMPORT_UNSTABLE Checks that all files that have stable versioned packages do not import packages with unstable version packages.\n\t\t`\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\texpectedStdout,\n\t\t\"config\",\n\t\t\"ls-lint-rules\",\n\t\t\"--version\",\n\t\t\"v2\",\n\t)\n}\n\nfunc TestCheckLsBreakingRulesV1(t *testing.T) {\n\tt.Parallel()\n\texpectedStdout := `\nID CATEGORIES DEFAULT PURPOSE\nENUM_NO_DELETE FILE * Checks that enums are not deleted from a given file.\nFILE_NO_DELETE FILE * Checks that files are not deleted.\nMESSAGE_NO_DELETE FILE * Checks that messages are not deleted from a given file.\nSERVICE_NO_DELETE FILE * Checks that services are not deleted from a given file.\nENUM_SAME_TYPE FILE, PACKAGE * Checks that enums have the same type (open vs closed).\nENUM_VALUE_NO_DELETE FILE, PACKAGE * Checks that enum values are not deleted from a given enum.\nEXTENSION_MESSAGE_NO_DELETE FILE, PACKAGE * Checks that extension ranges are not deleted from a given message.\nFIELD_NO_DELETE FILE, PACKAGE * Checks that fields are not deleted from a given message.\nFIELD_SAME_CARDINALITY FILE, PACKAGE * Checks that fields have the same cardinalities in a given message.\nFIELD_SAME_CPP_STRING_TYPE FILE, PACKAGE * Checks that fields have the same C++ string type, based on ctype field option or (pb.cpp).string_type feature.\nFIELD_SAME_JAVA_UTF8_VALIDATION FILE, PACKAGE * Checks that fields have the same Java string UTF8 validation, based on java_string_check_utf8 file option or (pb.java).utf8_validation feature.\nFIELD_SAME_JSTYPE FILE, PACKAGE * Checks that fields have the same value for the jstype option.\nFIELD_SAME_TYPE FILE, PACKAGE * Checks that fields have the same types in a given message.\nFIELD_SAME_UTF8_VALIDATION FILE, PACKAGE * Checks that string fields have the same UTF8 validation mode.\nFILE_SAME_CC_ENABLE_ARENAS FILE, PACKAGE * Checks that files have the same value for the cc_enable_arenas option.\nFILE_SAME_CC_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the cc_generic_services option.\nFILE_SAME_CSHARP_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the csharp_namespace option.\nFILE_SAME_GO_PACKAGE FILE, PACKAGE * Checks that files have the same value for the go_package option.\nFILE_SAME_JAVA_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the java_generic_services option.\nFILE_SAME_JAVA_MULTIPLE_FILES FILE, PACKAGE * Checks that files have the same value for the java_multiple_files option.\nFILE_SAME_JAVA_OUTER_CLASSNAME FILE, PACKAGE * Checks that files have the same value for the java_outer_classname option.\nFILE_SAME_JAVA_PACKAGE FILE, PACKAGE * Checks that files have the same value for the java_package option.\nFILE_SAME_OBJC_CLASS_PREFIX FILE, PACKAGE * Checks that files have the same value for the objc_class_prefix option.\nFILE_SAME_OPTIMIZE_FOR FILE, PACKAGE * Checks that files have the same value for the optimize_for option.\nFILE_SAME_PHP_CLASS_PREFIX FILE, PACKAGE * Checks that files have the same value for the php_class_prefix option.\nFILE_SAME_PHP_METADATA_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the php_metadata_namespace option.\nFILE_SAME_PHP_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the php_namespace option.\nFILE_SAME_PY_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the py_generic_services option.\nFILE_SAME_RUBY_PACKAGE FILE, PACKAGE * Checks that files have the same value for the ruby_package option.\nFILE_SAME_SWIFT_PREFIX FILE, PACKAGE * Checks that files have the same value for the swift_prefix option.\nFILE_SAME_SYNTAX FILE, PACKAGE * Checks that files have the same syntax.\nMESSAGE_NO_REMOVE_STANDARD_DESCRIPTOR_ACCESSOR FILE, PACKAGE * Checks that messages do not change the no_standard_descriptor_accessor option from false or unset to true.\nONEOF_NO_DELETE FILE, PACKAGE * Checks that oneofs are not deleted from a given message.\nRPC_NO_DELETE FILE, PACKAGE * Checks that rpcs are not deleted from a given service.\nENUM_SAME_JSON_FORMAT FILE, PACKAGE, WIRE_JSON * Checks that enums have the same JSON format support.\nENUM_VALUE_SAME_NAME FILE, PACKAGE, WIRE_JSON * Checks that enum values have the same name.\nFIELD_SAME_JSON_NAME FILE, PACKAGE, WIRE_JSON * Checks that fields have the same value for the json_name option.\nFIELD_SAME_NAME FILE, PACKAGE, WIRE_JSON * Checks that fields have the same names in a given message.\nMESSAGE_SAME_JSON_FORMAT FILE, PACKAGE, WIRE_JSON * Checks that messages have the same JSON format support.\nFIELD_SAME_ONEOF FILE, PACKAGE, WIRE_JSON, WIRE * Checks that fields have the same oneofs in a given message.\nFILE_SAME_PACKAGE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that files have the same package.\nMESSAGE_SAME_REQUIRED_FIELDS FILE, PACKAGE, WIRE_JSON, WIRE * Checks that messages have no added or deleted required fields.\nRESERVED_ENUM_NO_DELETE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that reserved ranges and names are not deleted from a given enum.\nRESERVED_MESSAGE_NO_DELETE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that reserved ranges and names are not deleted from a given message.\nRPC_SAME_CLIENT_STREAMING FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same client streaming value.\nRPC_SAME_IDEMPOTENCY_LEVEL FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same value for the idempotency_level option.\nRPC_SAME_REQUEST_TYPE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs are have the same request type.\nRPC_SAME_RESPONSE_TYPE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs are have the same response type.\nRPC_SAME_SERVER_STREAMING FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same server streaming value.\nPACKAGE_ENUM_NO_DELETE PACKAGE Checks that enums are not deleted from a given package.\nPACKAGE_MESSAGE_NO_DELETE PACKAGE Checks that messages are not deleted from a given package.\nPACKAGE_NO_DELETE PACKAGE Checks that packages are not deleted.\nPACKAGE_SERVICE_NO_DELETE PACKAGE Checks that services are not deleted from a given package.\nENUM_VALUE_NO_DELETE_UNLESS_NAME_RESERVED WIRE_JSON Checks that enum values are not deleted from a given enum unless the name is reserved.\nFIELD_NO_DELETE_UNLESS_NAME_RESERVED WIRE_JSON Checks that fields are not deleted from a given message unless the name is reserved.\nFIELD_WIRE_JSON_COMPATIBLE_CARDINALITY WIRE_JSON Checks that fields have wire and JSON compatible cardinalities in a given message.\nFIELD_WIRE_JSON_COMPATIBLE_TYPE WIRE_JSON Checks that fields have wire and JSON compatible types in a given message.\nENUM_VALUE_NO_DELETE_UNLESS_NUMBER_RESERVED WIRE_JSON, WIRE Checks that enum values are not deleted from a given enum unless the number is reserved.\nFIELD_NO_DELETE_UNLESS_NUMBER_RESERVED WIRE_JSON, WIRE Checks that fields are not deleted from a given message unless the number is reserved.\nFIELD_WIRE_COMPATIBLE_CARDINALITY WIRE Checks that fields have wire-compatible cardinalities in a given message.\nFIELD_WIRE_COMPATIBLE_TYPE WIRE Checks that fields have wire-compatible types in a given message.\n\t\t`\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\texpectedStdout,\n\t\t\"mod\",\n\t\t\"ls-breaking-rules\",\n\t\t\"--version\",\n\t\t\"v1\",\n\t)\n}\n\nfunc TestCheckLsBreakingRulesV1Beta1(t *testing.T) {\n\tt.Parallel()\n\texpectedStdout := `\nID CATEGORIES DEFAULT PURPOSE\nENUM_NO_DELETE FILE * Checks that enums are not deleted from a given file.\nFILE_NO_DELETE FILE * Checks that files are not deleted.\nFILE_SAME_PACKAGE FILE * Checks that files have the same package.\nMESSAGE_NO_DELETE FILE * Checks that messages are not deleted from a given file.\nSERVICE_NO_DELETE FILE * Checks that services are not deleted from a given file.\nENUM_SAME_TYPE FILE, PACKAGE * Checks that enums have the same type (open vs closed).\nENUM_VALUE_NO_DELETE FILE, PACKAGE * Checks that enum values are not deleted from a given enum.\nEXTENSION_MESSAGE_NO_DELETE FILE, PACKAGE * Checks that extension ranges are not deleted from a given message.\nFIELD_NO_DELETE FILE, PACKAGE * Checks that fields are not deleted from a given message.\nFIELD_SAME_CPP_STRING_TYPE FILE, PACKAGE * Checks that fields have the same C++ string type, based on ctype field option or (pb.cpp).string_type feature.\nFIELD_SAME_JAVA_UTF8_VALIDATION FILE, PACKAGE * Checks that fields have the same Java string UTF8 validation, based on java_string_check_utf8 file option or (pb.java).utf8_validation feature.\nFIELD_SAME_JSTYPE FILE, PACKAGE * Checks that fields have the same value for the jstype option.\nFIELD_SAME_UTF8_VALIDATION FILE, PACKAGE * Checks that string fields have the same UTF8 validation mode.\nFILE_SAME_CC_ENABLE_ARENAS FILE, PACKAGE * Checks that files have the same value for the cc_enable_arenas option.\nFILE_SAME_CC_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the cc_generic_services option.\nFILE_SAME_CSHARP_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the csharp_namespace option.\nFILE_SAME_GO_PACKAGE FILE, PACKAGE * Checks that files have the same value for the go_package option.\nFILE_SAME_JAVA_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the java_generic_services option.\nFILE_SAME_JAVA_MULTIPLE_FILES FILE, PACKAGE * Checks that files have the same value for the java_multiple_files option.\nFILE_SAME_JAVA_OUTER_CLASSNAME FILE, PACKAGE * Checks that files have the same value for the java_outer_classname option.\nFILE_SAME_JAVA_PACKAGE FILE, PACKAGE * Checks that files have the same value for the java_package option.\nFILE_SAME_OBJC_CLASS_PREFIX FILE, PACKAGE * Checks that files have the same value for the objc_class_prefix option.\nFILE_SAME_OPTIMIZE_FOR FILE, PACKAGE * Checks that files have the same value for the optimize_for option.\nFILE_SAME_PHP_CLASS_PREFIX FILE, PACKAGE * Checks that files have the same value for the php_class_prefix option.\nFILE_SAME_PHP_METADATA_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the php_metadata_namespace option.\nFILE_SAME_PHP_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the php_namespace option.\nFILE_SAME_PY_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the py_generic_services option.\nFILE_SAME_RUBY_PACKAGE FILE, PACKAGE * Checks that files have the same value for the ruby_package option.\nFILE_SAME_SWIFT_PREFIX FILE, PACKAGE * Checks that files have the same value for the swift_prefix option.\nFILE_SAME_SYNTAX FILE, PACKAGE * Checks that files have the same syntax.\nMESSAGE_NO_REMOVE_STANDARD_DESCRIPTOR_ACCESSOR FILE, PACKAGE * Checks that messages do not change the no_standard_descriptor_accessor option from false or unset to true.\nONEOF_NO_DELETE FILE, PACKAGE * Checks that oneofs are not deleted from a given message.\nRPC_NO_DELETE FILE, PACKAGE * Checks that rpcs are not deleted from a given service.\nENUM_SAME_JSON_FORMAT FILE, PACKAGE, WIRE_JSON * Checks that enums have the same JSON format support.\nENUM_VALUE_SAME_NAME FILE, PACKAGE, WIRE_JSON * Checks that enum values have the same name.\nFIELD_SAME_JSON_NAME FILE, PACKAGE, WIRE_JSON * Checks that fields have the same value for the json_name option.\nFIELD_SAME_NAME FILE, PACKAGE, WIRE_JSON * Checks that fields have the same names in a given message.\nMESSAGE_SAME_JSON_FORMAT FILE, PACKAGE, WIRE_JSON * Checks that messages have the same JSON format support.\nFIELD_SAME_CARDINALITY FILE, PACKAGE, WIRE_JSON, WIRE * Checks that fields have the same cardinalities in a given message.\nFIELD_SAME_ONEOF FILE, PACKAGE, WIRE_JSON, WIRE * Checks that fields have the same oneofs in a given message.\nFIELD_SAME_TYPE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that fields have the same types in a given message.\nMESSAGE_SAME_REQUIRED_FIELDS FILE, PACKAGE, WIRE_JSON, WIRE * Checks that messages have no added or deleted required fields.\nRESERVED_ENUM_NO_DELETE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that reserved ranges and names are not deleted from a given enum.\nRESERVED_MESSAGE_NO_DELETE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that reserved ranges and names are not deleted from a given message.\nRPC_SAME_CLIENT_STREAMING FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same client streaming value.\nRPC_SAME_IDEMPOTENCY_LEVEL FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same value for the idempotency_level option.\nRPC_SAME_REQUEST_TYPE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs are have the same request type.\nRPC_SAME_RESPONSE_TYPE FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs are have the same response type.\nRPC_SAME_SERVER_STREAMING FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same server streaming value.\nPACKAGE_ENUM_NO_DELETE PACKAGE Checks that enums are not deleted from a given package.\nPACKAGE_MESSAGE_NO_DELETE PACKAGE Checks that messages are not deleted from a given package.\nPACKAGE_NO_DELETE PACKAGE Checks that packages are not deleted.\nPACKAGE_SERVICE_NO_DELETE PACKAGE Checks that services are not deleted from a given package.\nENUM_VALUE_NO_DELETE_UNLESS_NAME_RESERVED WIRE_JSON Checks that enum values are not deleted from a given enum unless the name is reserved.\nFIELD_NO_DELETE_UNLESS_NAME_RESERVED WIRE_JSON Checks that fields are not deleted from a given message unless the name is reserved.\nFIELD_WIRE_JSON_COMPATIBLE_CARDINALITY WIRE_JSON Checks that fields have wire and JSON compatible cardinalities in a given message.\nENUM_VALUE_NO_DELETE_UNLESS_NUMBER_RESERVED WIRE_JSON, WIRE Checks that enum values are not deleted from a given enum unless the number is reserved.\nFIELD_NO_DELETE_UNLESS_NUMBER_RESERVED WIRE_JSON, WIRE Checks that fields are not deleted from a given message unless the number is reserved.\nFIELD_WIRE_COMPATIBLE_CARDINALITY WIRE Checks that fields have wire-compatible cardinalities in a given message.\n\t\t`\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\texpectedStdout,\n\t\t\"mod\",\n\t\t\"ls-breaking-rules\",\n\t\t\"--version\",\n\t\t\"v1beta1\",\n\t)\n}\n\nfunc TestCheckLsBreakingRulesV2(t *testing.T) {\n\tt.Parallel()\n\texpectedStdout := `\nID CATEGORIES DEFAULT PURPOSE\nEXTENSION_NO_DELETE FILE * Checks that extensions are not deleted from a given file.\nSERVICE_NO_DELETE FILE * Checks that services are not deleted from a given file.\nENUM_NO_DELETE CSR, FILE * Checks that enums are not deleted from a given file.\nFILE_NO_DELETE CSR, FILE * Checks that files are not deleted.\nMESSAGE_NO_DELETE CSR, FILE * Checks that messages are not deleted from a given file.\nENUM_SAME_TYPE FILE, PACKAGE * Checks that enums have the same type (open vs closed).\nFIELD_SAME_CARDINALITY FILE, PACKAGE * Checks that fields have the same cardinalities in a given message.\nFIELD_SAME_CPP_STRING_TYPE FILE, PACKAGE * Checks that fields have the same C++ string type, based on ctype field option or (pb.cpp).string_type feature.\nFIELD_SAME_JAVA_UTF8_VALIDATION FILE, PACKAGE * Checks that fields have the same Java string UTF8 validation, based on java_string_check_utf8 file option or (pb.java).utf8_validation feature.\nFIELD_SAME_JSTYPE FILE, PACKAGE * Checks that fields have the same value for the jstype option.\nFIELD_SAME_UTF8_VALIDATION FILE, PACKAGE * Checks that string fields have the same UTF8 validation mode.\nFILE_SAME_CC_ENABLE_ARENAS FILE, PACKAGE * Checks that files have the same value for the cc_enable_arenas option.\nFILE_SAME_CC_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the cc_generic_services option.\nFILE_SAME_CSHARP_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the csharp_namespace option.\nFILE_SAME_GO_PACKAGE FILE, PACKAGE * Checks that files have the same value for the go_package option.\nFILE_SAME_JAVA_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the java_generic_services option.\nFILE_SAME_JAVA_MULTIPLE_FILES FILE, PACKAGE * Checks that files have the same value for the java_multiple_files option.\nFILE_SAME_JAVA_OUTER_CLASSNAME FILE, PACKAGE * Checks that files have the same value for the java_outer_classname option.\nFILE_SAME_JAVA_PACKAGE FILE, PACKAGE * Checks that files have the same value for the java_package option.\nFILE_SAME_OBJC_CLASS_PREFIX FILE, PACKAGE * Checks that files have the same value for the objc_class_prefix option.\nFILE_SAME_OPTIMIZE_FOR FILE, PACKAGE * Checks that files have the same value for the optimize_for option.\nFILE_SAME_PHP_CLASS_PREFIX FILE, PACKAGE * Checks that files have the same value for the php_class_prefix option.\nFILE_SAME_PHP_METADATA_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the php_metadata_namespace option.\nFILE_SAME_PHP_NAMESPACE FILE, PACKAGE * Checks that files have the same value for the php_namespace option.\nFILE_SAME_PY_GENERIC_SERVICES FILE, PACKAGE * Checks that files have the same value for the py_generic_services option.\nFILE_SAME_RUBY_PACKAGE FILE, PACKAGE * Checks that files have the same value for the ruby_package option.\nFILE_SAME_SWIFT_PREFIX FILE, PACKAGE * Checks that files have the same value for the swift_prefix option.\nRPC_NO_DELETE FILE, PACKAGE * Checks that rpcs are not deleted from a given service.\nENUM_VALUE_NO_DELETE CSR, FILE, PACKAGE * Checks that enum values are not deleted from a given enum.\nEXTENSION_MESSAGE_NO_DELETE CSR, FILE, PACKAGE * Checks that extension ranges are not deleted from a given message.\nFIELD_NO_DELETE CSR, FILE, PACKAGE * Checks that fields are not deleted from a given message.\nFIELD_SAME_TYPE CSR, FILE, PACKAGE * Checks that fields have the same types in a given message.\nFILE_SAME_SYNTAX CSR, FILE, PACKAGE * Checks that files have the same syntax.\nMESSAGE_NO_REMOVE_STANDARD_DESCRIPTOR_ACCESSOR CSR, FILE, PACKAGE * Checks that messages do not change the no_standard_descriptor_accessor option from false or unset to true.\nONEOF_NO_DELETE CSR, FILE, PACKAGE * Checks that oneofs are not deleted from a given message.\nENUM_SAME_JSON_FORMAT CSR, FILE, PACKAGE, WIRE_JSON * Checks that enums have the same JSON format support.\nENUM_VALUE_SAME_NAME CSR, FILE, PACKAGE, WIRE_JSON * Checks that enum values have the same name.\nFIELD_SAME_JSON_NAME CSR, FILE, PACKAGE, WIRE_JSON * Checks that fields have the same value for the json_name option.\nFIELD_SAME_NAME CSR, FILE, PACKAGE, WIRE_JSON * Checks that fields have the same names in a given message.\nMESSAGE_SAME_JSON_FORMAT CSR, FILE, PACKAGE, WIRE_JSON * Checks that messages have the same JSON format support.\nFIELD_SAME_DEFAULT CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that fields have the same default value, if a default is specified.\nFIELD_SAME_ONEOF CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that fields have the same oneofs in a given message.\nFILE_SAME_PACKAGE CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that files have the same package.\nMESSAGE_SAME_REQUIRED_FIELDS CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that messages have no added or deleted required fields.\nRESERVED_ENUM_NO_DELETE CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that reserved ranges and names are not deleted from a given enum.\nRESERVED_MESSAGE_NO_DELETE CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that reserved ranges and names are not deleted from a given message.\nRPC_SAME_CLIENT_STREAMING CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same client streaming value.\nRPC_SAME_IDEMPOTENCY_LEVEL CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same value for the idempotency_level option.\nRPC_SAME_REQUEST_TYPE CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs are have the same request type.\nRPC_SAME_RESPONSE_TYPE CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs are have the same response type.\nRPC_SAME_SERVER_STREAMING CSR, FILE, PACKAGE, WIRE_JSON, WIRE * Checks that rpcs have the same server streaming value.\nPACKAGE_ENUM_NO_DELETE PACKAGE Checks that enums are not deleted from a given package.\nPACKAGE_EXTENSION_NO_DELETE PACKAGE Checks that extensions are not deleted from a given package.\nPACKAGE_MESSAGE_NO_DELETE PACKAGE Checks that messages are not deleted from a given package.\nPACKAGE_NO_DELETE PACKAGE Checks that packages are not deleted.\nPACKAGE_SERVICE_NO_DELETE PACKAGE Checks that services are not deleted from a given package.\nENUM_VALUE_NO_DELETE_UNLESS_NAME_RESERVED CSR, WIRE_JSON Checks that enum values are not deleted from a given enum unless the name is reserved.\nFIELD_NO_DELETE_UNLESS_NAME_RESERVED CSR, WIRE_JSON Checks that fields are not deleted from a given message unless the name is reserved.\nFIELD_WIRE_JSON_COMPATIBLE_CARDINALITY CSR, WIRE_JSON Checks that fields have wire and JSON compatible cardinalities in a given message.\nFIELD_WIRE_JSON_COMPATIBLE_TYPE CSR, WIRE_JSON Checks that fields have wire and JSON compatible types in a given message.\nENUM_VALUE_NO_DELETE_UNLESS_NUMBER_RESERVED CSR, WIRE_JSON, WIRE Checks that enum values are not deleted from a given enum unless the number is reserved.\nFIELD_NO_DELETE_UNLESS_NUMBER_RESERVED CSR, WIRE_JSON, WIRE Checks that fields are not deleted from a given message unless the number is reserved.\nFIELD_WIRE_COMPATIBLE_CARDINALITY WIRE Checks that fields have wire-compatible cardinalities in a given message.\nFIELD_WIRE_COMPATIBLE_TYPE WIRE Checks that fields have wire-compatible types in a given message.\n\t\t`\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\texpectedStdout,\n\t\t\"config\",\n\t\t\"ls-breaking-rules\",\n\t\t\"--version\",\n\t\t\"v2\",\n\t)\n}\n\nfunc TestCheckLsBreakingRulesFromConfig(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`\n\t \tID CATEGORIES DEFAULT PURPOSE\n\t \tENUM_VALUE_NO_DELETE FILE, PACKAGE * Checks that enum values are not deleted from a given enum.\n\t \tFIELD_SAME_JSTYPE FILE, PACKAGE * Checks that fields have the same value for the jstype option.\n\t \t`,\n\t\t\"mod\",\n\t\t\"ls-breaking-rules\",\n\t\t\"--config\",\n\t\tfilepath.Join(\"testdata\", \"small_list_rules\", \"buf.yaml\"),\n\t)\n\t// defaults only, built-ins and plugins.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeBreaking,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\tappend(\n\t\t\txslices.Filter(builtinBreakingRulesV2, func(breakingRule *outputCheckRule) bool {\n\t\t\t\treturn breakingRule.Default\n\t\t\t}),\n\t\t\t&outputCheckRule{ID: \"SERVICE_SUFFIXES_NO_CHANGE\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that services with configured suffixes are not deleted and do not have new RPCs or delete RPCs.\", Plugin: \"buf-plugin-suffix\"},\n\t\t),\n\t)\n\t// configure a deprecated category and a non-deprecated built-in category.\n\t// deprecated category contains some non-deprecated rules.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeBreaking,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"breaking\": {\n\t\t\t\t\"use\": [\"WIRE\", \"RESOURCE_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\tappend(\n\t\t\txslices.Filter(builtinBreakingRulesV2, func(breakingRule *outputCheckRule) bool {\n\t\t\t\treturn slices.Contains(breakingRule.Categories, \"WIRE\")\n\t\t\t}),\n\t\t\t&outputCheckRule{ID: \"ENUM_SUFFIXES_NO_CHANGE\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that enums with configured suffixes are not deleted and do not have new enum values or delete enum values.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t&outputCheckRule{ID: \"MESSAGE_SUFFIXES_NO_CHANGE\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that messages with configured suffixes are not deleted and do not have new fields or delete fields.\", Plugin: \"buf-plugin-suffix\"},\n\t\t),\n\t)\n\t// configure a deprecated category and a non-deprecated category, no built-ins.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeBreaking,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"breaking\": {\n\t\t\t\t\"use\": [\"OPERATION_SUFFIXES\",\"ATTRIBUTES_SUFFIXES\", \"RESOURCE_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\t[]*outputCheckRule{\n\t\t\t{ID: \"SERVICE_SUFFIXES_NO_CHANGE\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that services with configured suffixes are not deleted and do not have new RPCs or delete RPCs.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"ENUM_SUFFIXES_NO_CHANGE\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that enums with configured suffixes are not deleted and do not have new enum values or delete enum values.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t{ID: \"MESSAGE_SUFFIXES_NO_CHANGE\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that messages with configured suffixes are not deleted and do not have new fields or delete fields.\", Plugin: \"buf-plugin-suffix\"},\n\t\t},\n\t)\n\t// configure a mix of rules from built-ins and plugins.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeBreaking,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"breaking\": {\n\t\t\t\t\"use\": [\"FIELD_WIRE_COMPATIBLE_TYPE\", \"PACKAGE\", \"ENUM_SUFFIXES_NO_CHANGE\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\tappend(\n\t\t\txslices.Filter(builtinBreakingRulesV2, func(breakingRule *outputCheckRule) bool {\n\t\t\t\treturn slices.Contains(breakingRule.Categories, \"PACKAGE\")\n\t\t\t}),\n\t\t\t&outputCheckRule{ID: \"FIELD_WIRE_COMPATIBLE_TYPE\", Categories: []string{\"WIRE\"}, Default: false, Purpose: \"Checks that fields have wire-compatible types in a given message.\"},\n\t\t\t&outputCheckRule{ID: \"ENUM_SUFFIXES_NO_CHANGE\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that enums with configured suffixes are not deleted and do not have new enum values or delete enum values.\", Plugin: \"buf-plugin-suffix\"},\n\t\t),\n\t)\n\t// configure a mix of categories and rules from built-ins and plugins.\n\ttestLsRuleOutputJSON(\n\t\tt,\n\t\tcheck.RuleTypeBreaking,\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"breaking\": {\n\t\t\t\t\"use\": [\"FIELD_WIRE_COMPATIBLE_TYPE\", \"PACKAGE\", \"ENUM_SUFFIXES_NO_CHANGE\", \"OPERATION_SUFFIXES\"],\n\t\t\t},\n\t\t\t\"plugins\":[{\"plugin\": \"buf-plugin-suffix\"}]\n\t\t}`,\n\t\tappend(\n\t\t\txslices.Filter(builtinBreakingRulesV2, func(breakingRule *outputCheckRule) bool {\n\t\t\t\treturn slices.Contains(breakingRule.Categories, \"PACKAGE\") || breakingRule.ID == \"FIELD_WIRE_COMPATIBLE_TYPE\"\n\t\t\t}),\n\t\t\t&outputCheckRule{ID: \"SERVICE_SUFFIXES_NO_CHANGE\", Categories: []string{\"OPERATION_SUFFIXES\"}, Default: true, Purpose: \"Ensure that services with configured suffixes are not deleted and do not have new RPCs or delete RPCs.\", Plugin: \"buf-plugin-suffix\"},\n\t\t\t&outputCheckRule{ID: \"ENUM_SUFFIXES_NO_CHANGE\", Categories: []string{\"ATTRIBUTES_SUFFIXES\"}, Default: false, Purpose: \"Ensure that enums with configured suffixes are not deleted and do not have new enum values or delete enum values.\", Plugin: \"buf-plugin-suffix\"},\n\t\t),\n\t)\n}\n\nfunc TestCheckLsBreakingRulesFromConfigNotNamedBufYAML(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`\n\t\tID CATEGORIES DEFAULT PURPOSE\n\t\tENUM_VALUE_NO_DELETE FILE, PACKAGE * Checks that enum values are not deleted from a given enum.\n\t\tFIELD_SAME_JSTYPE FILE, PACKAGE * Checks that fields have the same value for the jstype option.\n\t\t`,\n\t\t\"mod\",\n\t\t\"ls-breaking-rules\",\n\t\t\"--config\",\n\t\t// making sure that .yml works\n\t\tfilepath.Join(\"testdata\", \"small_list_rules_yml\", \"config.yml\"),\n\t)\n}\n\nfunc TestCheckLsBreakingRulesFromConfigExceptDeprecated(t *testing.T) {\n\tt.Parallel()\n\n\tfor _, version := range bufconfig.AllFileVersions {\n\t\tt.Run(version.String(), func(t *testing.T) {\n\t\t\tt.Parallel()\n\t\t\t// Do not need any custom lint/breaking plugins here.\n\t\t\tclient, err := bufcheck.NewClient(slogtestext.NewLogger(t))\n\t\t\trequire.NoError(t, err)\n\t\t\tallRules, err := client.AllRules(t.Context(), check.RuleTypeBreaking, version)\n\t\t\trequire.NoError(t, err)\n\t\t\tallPackageIDs := make([]string, 0, len(allRules))\n\t\t\tfor _, rule := range allRules {\n\t\t\t\tif rule.Deprecated() {\n\t\t\t\t\t// Deprecated rules should not be associated with a category.\n\t\t\t\t\t// Instead, their replacements are associated with categories.\n\t\t\t\t\tassert.Empty(t, rule.Categories())\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tvar found bool\n\t\t\t\tfor _, category := range rule.Categories() {\n\t\t\t\t\tif category.ID() == \"PACKAGE\" {\n\t\t\t\t\t\tfound = true\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif found {\n\t\t\t\t\tallPackageIDs = append(allPackageIDs, rule.ID())\n\t\t\t\t}\n\t\t\t}\n\t\t\tsort.Strings(allPackageIDs)\n\t\t\tdeprecations, err := bufcheck.GetDeprecatedIDToReplacementIDs(allRules)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tfor deprecatedRule := range deprecations {\n\t\t\t\tt.Run(deprecatedRule, func(t *testing.T) {\n\t\t\t\t\tt.Parallel()\n\t\t\t\t\tids := getRuleIDsFromLsBreaking(t, version.String(), []string{\"PACKAGE\"}, []string{deprecatedRule})\n\t\t\t\t\texpectedIDs := make([]string, 0, len(allPackageIDs))\n\t\t\t\t\treplacements := deprecations[deprecatedRule]\n\t\t\t\t\tfor _, id := range allPackageIDs {\n\t\t\t\t\t\tif slices.Contains(replacements, id) {\n\t\t\t\t\t\t\tcontinue\n\t\t\t\t\t\t}\n\t\t\t\t\t\texpectedIDs = append(expectedIDs, id)\n\t\t\t\t\t}\n\t\t\t\t\trequire.Equal(t, expectedIDs, ids)\n\t\t\t\t})\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestLsModulesWorkspaceV1(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev1\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t`\na_v1\nb_no_name_v1\nc_v1beta1\nd_no_file\ne_no_file\nf_no_name_v1beta1\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as path\n\t\t`\na_v1\nb_no_name_v1\nc_v1beta1\nd_no_file\ne_no_file\nf_no_name_v1beta1\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as name\n\t\t`\nbuf.build/bar/baz\nbuf.build/foo/bar\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as json, sort by path\n\t\t`\n{\"path\":\"a_v1\",\"name\":\"buf.build/foo/bar\"}\n{\"path\":\"b_no_name_v1\"}\n{\"path\":\"c_v1beta1\",\"name\":\"buf.build/bar/baz\"}\n{\"path\":\"d_no_file\"}\n{\"path\":\"e_no_file\"}\n{\"path\":\"f_no_name_v1beta1\"}\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n}\n\nfunc TestLsModulesWorkspaceV2(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev2\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t`\na\nb_no_name\nc\nd_no_name\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as path\n\t\t`\na\nb_no_name\nc\nd_no_name\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as name\n\t\t`\nbuf.build/bar/baz\nbuf.build/foo/bar\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as json, sort by path\n\t\t`\n{\"path\":\"a\",\"name\":\"buf.build/foo/bar\"}\n{\"path\":\"b_no_name\"}\n{\"path\":\"c\",\"name\":\"buf.build/bar/baz\"}\n{\"path\":\"d_no_name\"}\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n}\n\nfunc TestLsModulesModuleV1(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\t// with name\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev1\", \"a_v1\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`\nbuf.build/foo/bar\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`{\"path\":\".\",\"name\":\"buf.build/foo/bar\"}`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n\t// without name\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev1\", \"b_no_name_v1\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\", // empty output\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`{\"path\":\".\"}`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n}\n\nfunc TestLsModulesModuleV1Beta1(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\t// with name\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev1\", \"c_v1beta1\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"buf.build/bar/baz\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`{\"path\":\".\",\"name\":\"buf.build/bar/baz\"}`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n\t// without name\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev1\", \"f_no_name_v1beta1\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\", // empty output\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`{\"path\":\".\"}`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n}\n\nfunc TestLsModulesNoConfig(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\t// with name\n\trequire.NoError(t, osext.Chdir(t.TempDir()))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\".\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\",\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`{\"path\":\".\"}`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n}\n\nfunc TestLsModulesBothConfig(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"extraconfigv1\")))\n\ttestRunStderrContainsNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t[]string{\"buf.yaml\", \"buf.work.yaml\"},\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"extraconfigv2\")))\n\ttestRunStderrContainsNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t[]string{\"buf.yaml\", \"buf.work.yaml\"},\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n}\n\nfunc TestLsModulesInvalidVersion(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspaceinvalid\")))\n\ttestRunStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t`Failure: buf.work.yaml pointed to directory \"proto\" which has a v2 buf.yaml file`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n}\n\nfunc TestLsModulesConfigFlag(t *testing.T) {\n\tt.Parallel()\n\n\t// v1beta1\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`{\"path\":\".\",\"name\":\"buf.build/bar/baz\"}`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--config\",\n\t\tfilepath.Join(\"testdata\", \"lsmodules\", \"workspacev1\", \"c_v1beta1\", \"buf.yaml\"),\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n\n\t// v1\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`{\"path\":\".\",\"name\":\"buf.build/foo/bar\"}`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--config\",\n\t\tfilepath.Join(\"testdata\", \"lsmodules\", \"workspacev1\", \"a_v1\", \"buf.yaml\"),\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n\n\t// v2\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`\n{\"path\":\"a\",\"name\":\"buf.build/foo/bar\"}\n{\"path\":\"b_no_name\"}\n{\"path\":\"c\",\"name\":\"buf.build/bar/baz\"}\n{\"path\":\"d_no_name\"}\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--config\",\n\t\tfilepath.Join(\"testdata\", \"lsmodules\", \"workspacev2\", \"buf.yaml\"),\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n}\n\nfunc TestLsModulesConfigFlagTakesPrecedence(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev1\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t`\na\nb_no_name\nc\nd_no_name\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--config\",\n\t\tfilepath.Join(pwd, \"testdata\", \"lsmodules\", \"workspacev2\", \"buf.yaml\"),\n\t)\n}\n\nfunc TestLsModulesWorkspaceV2DuplicateDirPath(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\tpwd, err := osext.Getwd()\n\trequire.NoError(t, err)\n\tdefer func() {\n\t\tr := recover()\n\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\tif r != nil {\n\t\t\tpanic(r)\n\t\t}\n\t}()\n\n\trequire.NoError(t, osext.Chdir(filepath.Join(pwd, \"testdata\", \"workspace\", \"success\", \"duplicate_dir_path\")))\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// default format is path\n\t\t`\nproto/shared\nproto/shared\nproto/shared1\nproto/shared1\nseparate\n`,\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as path\n\t\t`\nproto/shared\nproto/shared\nproto/shared1\nproto/shared1\nseparate\n\t`,\n\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"path\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as name\n\t\t`\nbuf.build/shared/one\nbuf.build/shared/zero\n\t`,\n\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"name\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// format as json, sort by path\n\t\t`\n\n\t{\"path\":\"proto/shared\",\"excludes\":[\"proto/shared/prefix/foo\"]}\n\t{\"path\":\"proto/shared\",\"excludes\":[\"proto/shared/prefix/bar\"],\"name\":\"buf.build/shared/zero\"}\n\t{\"path\":\"proto/shared1\",\"includes\":[\"proto/shared1/prefix/x\"],\"name\":\"buf.build/shared/one\"}\n\t{\"path\":\"proto/shared1\",\"excludes\":[\"proto/shared1/prefix/x\"]}\n\t{\"path\":\"separate\"}\n\t`,\n\n\t\t\"config\",\n\t\t\"ls-modules\",\n\t\t\"--format\",\n\t\t\"json\",\n\t)\n}\n\nfunc TestLsBreakingRulesDeprecated(t *testing.T) {\n\tt.Parallel()\n\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"mod\", \"ls-breaking-rules\", \"--version\", \"v1beta1\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"mod\", \"ls-breaking-rules\", \"--version\", \"v1beta1\", \"--include-deprecated\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"mod\", \"ls-breaking-rules\", \"--version\", \"v1\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"mod\", \"ls-breaking-rules\", \"--version\", \"v1\", \"--include-deprecated\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--version\", \"v1beta1\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--version\", \"v1beta1\", \"--include-deprecated\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--version\", \"v1\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--version\", \"v1\", \"--include-deprecated\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.Contains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.Contains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--version\", \"v2\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\t// The deprecated rules are omitted from v2.\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--version\", \"v2\", \"--include-deprecated\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\t// Test the non-all version too. Should never have deprecated rules.\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"mod\", \"ls-breaking-rules\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"mod\", \"ls-breaking-rules\", \"--include-deprecated\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--configured-only\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(t, 0, nil, stdout, \"config\", \"ls-breaking-rules\", \"--configured-only\", \"--include-deprecated\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_CTYPE\")\n\tassert.NotContains(t, stdout.String(), \"FIELD_SAME_LABEL\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_JAVA_STRING_CHECK_UTF8\")\n\tassert.NotContains(t, stdout.String(), \"FILE_SAME_PHP_GENERIC_SERVICES\")\n}\n\nfunc TestLsFiles(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\tfilepath.FromSlash(`testdata/success/buf/buf.proto`),\n\t\t\"ls-files\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\tfilepath.FromSlash(`testdata/success/buf/buf.proto`),\n\t\t\"ls-files\",\n\t\tfilepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\tfilepath.FromSlash(`testdata/protofileref/success/buf.proto`),\n\t\t\"ls-files\",\n\t\t// test single file ref that is not part of the module or workspace\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"success\", \"buf.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\tfilepath.FromSlash(`\n\t\t\ttestdata/protofileref/success/buf.proto\n\t\t\ttestdata/protofileref/success/other.proto\n\t\t`),\n\t\t\"ls-files\",\n\t\t// test single file ref that is not part of the module or workspace\n\t\tfmt.Sprintf(\"%s#include_package_files=true\", filepath.Join(\"testdata\", \"protofileref\", \"success\", \"buf.proto\")),\n\t)\n}\n\nfunc TestLsFilesIncludeImports(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`google/protobuf/descriptor.proto\n`+filepath.FromSlash(`testdata/success/buf/buf.proto`),\n\t\t\"ls-files\",\n\t\t\"--include-imports\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`google/protobuf/descriptor.proto\n`+filepath.FromSlash(`testdata/protofileref/success/buf.proto`),\n\t\t\"ls-files\",\n\t\t\"--include-imports\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"success\", \"buf.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`google/protobuf/descriptor.proto`+filepath.FromSlash(`\n\t\ttestdata/protofileref/success/buf.proto\n\t\ttestdata/protofileref/success/other.proto\n\t\t`),\n\t\t\"ls-files\",\n\t\t\"--include-imports\",\n\t\tfmt.Sprintf(\"%s#include_package_files=true\", filepath.Join(\"testdata\", \"protofileref\", \"success\", \"buf.proto\")),\n\t)\n}\n\nfunc TestLsFilesIncludeImportsAsImportPaths(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`buf/buf.proto\ngoogle/protobuf/descriptor.proto`,\n\t\t\"ls-files\",\n\t\t\"--include-imports\",\n\t\t\"--as-import-paths\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`buf/buf.proto\ngoogle/protobuf/descriptor.proto`,\n\t\t\"ls-files\",\n\t\t\"--include-imports\",\n\t\t\"--as-import-paths\",\n\t\tfilepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"),\n\t)\n}\n\nfunc TestLsFilesImage1(t *testing.T) {\n\tt.Parallel()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-o\",\n\t\t\"-\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tstdout,\n\t\t0,\n\t\t`\n\t\tbuf/buf.proto\n\t\t`,\n\t\t\"ls-files\",\n\t\t\"-\",\n\t)\n}\n\nfunc TestLsFilesImage1_Yaml(t *testing.T) {\n\tt.Parallel()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-o\",\n\t\t\"-#format=yaml\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tstdout,\n\t\t0,\n\t\t`\n\t\tbuf/buf.proto\n\t\t`,\n\t\t\"ls-files\",\n\t\t\"-#format=yaml\",\n\t)\n}\n\nfunc TestLsFilesImage2(t *testing.T) {\n\tt.Parallel()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-o\",\n\t\t\"-\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tstdout,\n\t\t0,\n\t\t`\n\t\tbuf/buf.proto\n\t\tgoogle/protobuf/descriptor.proto\n\t\t`,\n\t\t\"ls-files\",\n\t\t\"-\",\n\t\t\"--include-imports\",\n\t)\n}\n\nfunc TestLsFilesImage3(t *testing.T) {\n\tt.Parallel()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"--exclude-imports\",\n\t\t\"-o\",\n\t\t\"-\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tstdout,\n\t\t0,\n\t\t`\n\t\tbuf/buf.proto\n\t\t`,\n\t\t\"ls-files\",\n\t\t\"-\",\n\t)\n}\n\nfunc TestLsFilesImage4(t *testing.T) {\n\tt.Parallel()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-o\",\n\t\t\"-\",\n\t\tfilepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tstdout,\n\t\t0,\n\t\t`\n\t\tbuf/buf.proto\n\t\t`,\n\t\t\"ls-files\",\n\t\t\"-\",\n\t)\n}\n\nfunc TestLsFilesImage5(t *testing.T) {\n\tt.Parallel()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-o\",\n\t\t\"-\",\n\t\tfilepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tstdout,\n\t\t0,\n\t\t`\n\t\tbuf/buf.proto\n\t\tgoogle/protobuf/descriptor.proto\n\t\t`,\n\t\t\"ls-files\",\n\t\t\"--include-imports\",\n\t\t\"-\",\n\t)\n}\n\nfunc TestBuildFailProtoFileRefWithPathFlag(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\", // stdout should be empty\n\t\t`Failure: --path is not valid for use with .proto file references`,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"success\", \"buf\", \"buf.proto\"),\n\t\t\"-o\",\n\t\t\"-\",\n\t)\n}\n\nfunc TestImageConvertRoundtripBinaryJSONBinary(t *testing.T) {\n\tt.Parallel()\n\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-o\",\n\t\t\"-\",\n\t\tfilepath.Join(\"testdata\", \"customoptions1\"),\n\t)\n\n\tbinary1 := stdout.Bytes()\n\trequire.NotEmpty(t, binary1)\n\n\tstdin := stdout\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tstdin,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-\",\n\t\t\"-o\",\n\t\t\"-#format=json\",\n\t)\n\n\tstdin = stdout\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tstdin,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-#format=json\",\n\t\t\"-o\",\n\t\t\"-\",\n\t)\n\n\trequire.Equal(t, binary1, stdout.Bytes())\n}\n\nfunc TestImageConvertRoundtripJSONBinaryJSON(t *testing.T) {\n\tt.Parallel()\n\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-o\",\n\t\t\"-#format=json\",\n\t\tfilepath.Join(\"testdata\", \"customoptions1\"),\n\t)\n\n\tjson1 := stdout.Bytes()\n\trequire.NotEmpty(t, json1)\n\n\tstdin := stdout\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tstdin,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-#format=json\",\n\t\t\"-o\",\n\t\t\"-\",\n\t)\n\n\tstdin = stdout\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tstdin,\n\t\tstdout,\n\t\t\"build\",\n\t\t\"-\",\n\t\t\"-o\",\n\t\t\"-#format=json\",\n\t)\n\n\trequire.Equal(t, json1, stdout.Bytes())\n}\n\nfunc TestModInitBasic(t *testing.T) {\n\tt.Parallel()\n\ttestModInit(\n\t\tt,\n\t\t`# For details on buf.yaml configuration, visit https://buf.build/docs/configuration/v2/buf-yaml\nversion: v2\nlint:\n use:\n - STANDARD\nbreaking:\n use:\n - FILE\n`,\n\t\tfalse,\n\t\t\"\",\n\t)\n}\n\nfunc TestLsFilesOverlappingPaths(t *testing.T) {\n\tt.Parallel()\n\t// It should be OK to have paths that overlap, and ls-files (and other commands)\n\t// should output the union.\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\tfilepath.FromSlash(`testdata/paths/a/v3/a.proto\ntestdata/paths/a/v3/foo/bar.proto\ntestdata/paths/a/v3/foo/foo.proto`),\n\t\t\"ls-files\",\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t)\n}\n\nfunc TestBuildOverlappingPaths(t *testing.T) {\n\tt.Parallel()\n\t// This may differ from LsFilesOverlappingPaths as we do a build of an image here.\n\t// Building of images results in bufmodule.ModuleSetToModuleReadBucketWithOnlyProtoFiles being\n\t// called, which is the original source of the issue that resulted in this test.\n\ttestBuildLsFilesFormatImport(\n\t\tt,\n\t\t0,\n\t\t[]string{\n\t\t\t`a/v3/a.proto`,\n\t\t\t`a/v3/foo/bar.proto`,\n\t\t\t`a/v3/foo/foo.proto`,\n\t\t},\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t)\n}\n\nfunc TestExportProto(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\", \"proto\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\t// This should NOT include unimported.proto\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"request.proto\",\n\t\t\"rpc.proto\",\n\t)\n}\n\nfunc TestExportOtherProto(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\", \"other\", \"proto\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"request.proto\",\n\t\t\"unimported.proto\",\n\t\t\"another.proto\",\n\t)\n}\n\nfunc TestExportAll(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"another.proto\",\n\t\t\"request.proto\",\n\t\t\"rpc.proto\",\n\t\t\"unimported.proto\",\n\t)\n}\n\nfunc TestExportExcludeImports(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--exclude-imports\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\", \"proto\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"rpc.proto\",\n\t)\n}\n\nfunc TestExportPaths(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"export\", \"other\", \"proto\", \"request.proto\"),\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"request.proto\",\n\t)\n}\n\nfunc TestExportPathsAndExcludes(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t\t\"-o\",\n\t\ttempDir,\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"a/v3/a.proto\",\n\t)\n\tstoragetesting.AssertNotExist(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"a/v3/foo/foo.proto\",\n\t)\n\tstoragetesting.AssertNotExist(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"a/v3/foo/bar.proto\",\n\t)\n}\n\nfunc TestExportProtoFileRef(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\", \"proto\", \"rpc.proto\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"request.proto\",\n\t\t\"rpc.proto\",\n\t)\n}\n\nfunc TestExportProtoFileRefExcludeImports(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--exclude-imports\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\", \"proto\", \"rpc.proto\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"rpc.proto\",\n\t)\n}\n\nfunc TestExportProtoFileRefIncludePackageFiles(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfmt.Sprintf(\"%s#include_package_files=true\", filepath.Join(\"testdata\", \"export\", \"other\", \"proto\", \"request.proto\")),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"request.proto\",\n\t\t\"unimported.proto\",\n\t\t\"another.proto\",\n\t)\n}\n\nfunc TestExportProtoFileRefIncludePackageFilesExcludeImports(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--exclude-imports\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfmt.Sprintf(\"%s#include_package_files=true\", filepath.Join(\"testdata\", \"export\", \"other\", \"proto\", \"request.proto\")),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"request.proto\",\n\t\t\"unimported.proto\",\n\t)\n}\n\nfunc TestExportProtoFileRefWithPathFlag(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\", // stdout should be empty\n\t\t`Failure: --path is not valid for use with .proto file references`,\n\t\t\"export\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"success\", \"buf.proto\"),\n\t\t\"-o\",\n\t\ttempDir,\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"success\", \"buf.proto\"),\n\t)\n}\n\nfunc TestExportAllSourceFilesV1Module(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--all\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\", \"proto\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"LICENSE\",\n\t\t\"README.md\",\n\t\t\"request.proto\",\n\t\t\"rpc.proto\",\n\t)\n}\n\nfunc TestExportAllSourceFilesV1Workspace(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--all\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"export\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"LICENSE.request\",\n\t\t\"LICENSE.rpc\",\n\t\t\"README.another.md\",\n\t\t\"README.rpc.md\",\n\t\t\"another.proto\",\n\t\t\"request.proto\",\n\t\t\"rpc.proto\",\n\t\t\"unimported.proto\",\n\t)\n}\n\nfunc TestExportAllSourceFilesV2Module(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--all\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"success\", \"v2\", \"export\", \"proto\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"LICENSE\",\n\t\t\"README.md\",\n\t\t\"request.proto\",\n\t\t\"rpc.proto\",\n\t)\n}\n\nfunc TestExportAllSourceFilesV2Workspace(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"export\",\n\t\t\"--all\",\n\t\t\"-o\",\n\t\ttempDir,\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"success\", \"v2\", \"export\"),\n\t)\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"LICENSE.request\",\n\t\t\"LICENSE.rpc\",\n\t\t\"README.another.md\",\n\t\t\"README.rpc.md\",\n\t\t\"another.proto\",\n\t\t\"request.proto\",\n\t\t\"rpc.proto\",\n\t\t\"unimported.proto\",\n\t)\n}\n\nfunc TestBuildWithPaths(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 0, ``, \"build\", filepath.Join(\"testdata\", \"paths\"), \"--path\", filepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"), \"--exclude-path\", filepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"))\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\t\tfilepath.FromSlash(`Failure: excluded path \"testdata/paths/a/v3\" contains targeted path \"testdata/paths/a/v3/foo\", which means all paths in \"testdata/paths/a/v3/foo\" will be excluded`),\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t)\n}\n\nfunc TestLintWithPaths(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/paths/a/v3/a.proto:7:10:Field name \"Value\" should be lower_snake_case, such as \"value\".`),\n\t\t\"\",\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t)\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\",\n\t\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\t\tfilepath.FromSlash(`Failure: excluded path \"testdata/paths/a/v3\" contains targeted path \"testdata/paths/a/v3/foo\", which means all paths in \"testdata/paths/a/v3/foo\" will be excluded`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t)\n}\n\nfunc TestLintWithPlugins(t *testing.T) {\n\tt.Parallel()\n\t// defaults only, comment ignores on.\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/api/v1/service.proto:11:1:Service name \"api.v1.FooServiceMock\" has banned suffix \"Mock\". (buf-plugin-suffix)\ntestdata/check_plugins/current/proto/api/v1/service.proto:12:14:RPC request type \"GetFooMockRequest\" should be named \"GetFooRequest\" or \"FooServiceMockGetFooRequest\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:12:42:RPC response type \"GetFooMockResponse\" should be named \"GetFooResponse\" or \"FooServiceMockGetFooResponse\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:16:9:Service name \"FooServiceTest\" should be suffixed with \"Service\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:17:14:RPC request type \"GetFooTestRequest\" should be named \"GetFooRequest\" or \"FooServiceTestGetFooRequest\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:17:42:RPC response type \"GetFooTestResponse\" should be named \"GetFooResponse\" or \"FooServiceTestGetFooResponse\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:26:1:\"ListFooResponse\" is a pagination response without a page token field named \"page_token\" (buf-plugin-rpc-ext)\ntestdata/check_plugins/current/proto/common/v1alpha1/messages.proto:16:5:field \"common.v1alpha1.Four.FourTwo.id\" does not have rule (buf.validate.field).string.tuuid set (buf-plugin-protovalidate-ext)\ntestdata/check_plugins/current/vendor/protovalidate/buf/validate/validate.proto:95:3:field \"buf.validate.Rule.id\" does not have rule (buf.validate.field).string.tuuid set (buf-plugin-protovalidate-ext)\n\t\t`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\"),\n\t)\n\t// Defaults only, comment ignores off.\n\t// Always ignore the vendored protovalidate module.\n\t//\n\t// There are still lint failures for protovalidate despite being set as an ignore path because\n\t// proto imports these files, and paths outside of a module cannot be configured as ignore paths\n\t// for the module -- this is expected behavior for now.\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/api/v1/service.proto:11:1:Service name \"api.v1.FooServiceMock\" has banned suffix \"Mock\". (buf-plugin-suffix)\ntestdata/check_plugins/current/proto/api/v1/service.proto:11:9:Service name \"FooServiceMock\" should be suffixed with \"Service\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:12:14:RPC request type \"GetFooMockRequest\" should be named \"GetFooRequest\" or \"FooServiceMockGetFooRequest\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:12:42:RPC response type \"GetFooMockResponse\" should be named \"GetFooResponse\" or \"FooServiceMockGetFooResponse\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:16:1:Service name \"api.v1.FooServiceTest\" has banned suffix \"Test\". (buf-plugin-suffix)\ntestdata/check_plugins/current/proto/api/v1/service.proto:16:9:Service name \"FooServiceTest\" should be suffixed with \"Service\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:17:14:RPC request type \"GetFooTestRequest\" should be named \"GetFooRequest\" or \"FooServiceTestGetFooRequest\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:17:42:RPC response type \"GetFooTestResponse\" should be named \"GetFooResponse\" or \"FooServiceTestGetFooResponse\".\ntestdata/check_plugins/current/proto/api/v1/service.proto:26:1:\"ListFooResponse\" is a pagination response without a page token field named \"page_token\" (buf-plugin-rpc-ext)\ntestdata/check_plugins/current/proto/common/v1alpha1/messages.proto:16:5:field \"common.v1alpha1.Four.FourTwo.id\" does not have rule (buf.validate.field).string.tuuid set (buf-plugin-protovalidate-ext)\ntestdata/check_plugins/current/vendor/protovalidate/buf/validate/validate.proto:95:3:field \"buf.validate.Rule.id\" does not have rule (buf.validate.field).string.tuuid set (buf-plugin-protovalidate-ext)\n\t\t`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\"),\n\t\t\"--config\",\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"modules\": [\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t\t],\n\t\t\t\"lint\": {\n\t\t\t\t\"disallow_comment_ignores\": true,\n\t\t\t\t\"ignore\": [\n\t\t\t\t\t\"testdata/check_plugins/current/vendor/protovalidate\",\n \t\t\t\t\"testdata/check_plugins/current/proto/common/v1/breaking.proto\",\n \t\t\t\t\"testdata/check_plugins/current/proto/common/v1alpha1/breaking.proto\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"plugins\":[\n\t\t\t\t{\n\t\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\"service_banned_suffixes\": [\"Mock\", \"Test\"],\n\t\t\t\t\t\t\"rpc_banned_suffixes\": [\"Element\"],\n\t\t\t\t\t\t\"field_banned_suffixes\": [\"_uuid\"],\n\t\t\t\t\t\t\"enum_value_banned_suffixes\": [\"_invalid\"],\n\t\t\t\t\t\t\"service_no_change_suffixes\": [\"Service\"],\n\t\t\t\t\t\t\"message_no_change_suffixes\": [\"Request\", \"Response\"],\n\t\t\t\t\t\t\"enum_no_change_suffixes\": [\"State\"]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\"plugin\": \"buf-plugin-protovalidate-ext\"},\n\t\t\t\t{\"plugin\": \"buf-plugin-rpc-ext\"}\n\t\t\t]\n\t\t}`,\n\t)\n\t// With specified use, ignore, and ignore_only configurations.\n\t// Always ignore the vendored protovalidate module.\n\t//\n\t// There are still lint failures for protovalidate despite being set as an ignore path because\n\t// proto imports these files, and paths outside of a module cannot be configured as ignore paths\n\t// for the module -- this is expected behavior for now.\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/api/v1/service.proto:11:1:Service name \"api.v1.FooServiceMock\" has banned suffix \"Mock\". (buf-plugin-suffix)\ntestdata/check_plugins/current/proto/common/v1alpha1/messages.proto:16:5:field \"common.v1alpha1.Four.FourTwo.id\" does not have rule (buf.validate.field).string.tuuid set (buf-plugin-protovalidate-ext)\ntestdata/check_plugins/current/vendor/protovalidate/buf/validate/validate.proto:95:3:field \"buf.validate.Rule.id\" does not have rule (buf.validate.field).string.tuuid set (buf-plugin-protovalidate-ext)\n\t\t`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\"),\n\t\t\"--config\",\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"modules\": [\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t\t],\n\t\t\t\"lint\": {\n\t\t\t\t\"use\": [\"PAGE_REQUEST_HAS_TOKEN\", \"SERVICE_BANNED_SUFFIXES\", \"VALIDATE_ID_DASHLESS\"],\n\t\t\t\t\"ignore\": [\n\t\t\t\t\t\"testdata/check_plugins/current/vendor/protovalidate\",\n \t\t\t\t\"testdata/check_plugins/current/proto/common/v1/breaking.proto\",\n \t\t\t\t\"testdata/check_plugins/current/proto/common/v1alpha1/breaking.proto\"\n\t\t\t\t],\n\t\t\t\t\"ignore_only\": {\n\t\t\t\t\t\"VALIDATE_ID_DASHLESS\": [\"testdata/check_plugins/current/vendor/protovalidate/buf/validate\"],\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"plugins\":[\n\t\t\t\t{\n\t\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\"service_banned_suffixes\": [\"Mock\", \"Test\"],\n\t\t\t\t\t\t\"rpc_banned_suffixes\": [\"Element\"],\n\t\t\t\t\t\t\"field_banned_suffixes\": [\"_uuid\"],\n\t\t\t\t\t\t\"enum_value_banned_suffixes\": [\"_invalid\"],\n\t\t\t\t\t\t\"service_no_change_suffixes\": [\"Service\"],\n\t\t\t\t\t\t\"message_no_change_suffixes\": [\"Request\", \"Response\"],\n\t\t\t\t\t\t\"enum_no_change_suffixes\": [\"State\"]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\"plugin\": \"buf-plugin-protovalidate-ext\"},\n\t\t\t\t{\"plugin\": \"buf-plugin-rpc-ext\"}\n\t\t\t]\n\t\t}`,\n\t)\n\t// Set the same category for lint and breaking, but ensure that only the lint rules run.\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/common.proto:8:5:Field name \"common.v1.One.Two.foo_uuid\" has banned suffix \"_uuid\". (buf-plugin-suffix)\n\t\t`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\"),\n\t\t\"--config\",\n\t\t`{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"modules\": [\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t\t],\n\t\t\t\"lint\": {\n\t\t\t\t\"use\": [\"ATTRIBUTES_SUFFIXES\"]\n\t\t\t},\n\t\t\t\"breaking\": {\n\t\t\t\t\"use\": [\"ATTRIBUTES_SUFFIXES\"]\n\t\t\t},\n\t\t\t\"plugins\":[\n\t\t\t\t{\n\t\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\"service_banned_suffixes\": [\"Mock\", \"Test\"],\n\t\t\t\t\t\t\"rpc_banned_suffixes\": [\"Element\"],\n\t\t\t\t\t\t\"field_banned_suffixes\": [\"_uuid\"],\n\t\t\t\t\t\t\"enum_value_banned_suffixes\": [\"_invalid\"],\n\t\t\t\t\t\t\"service_no_change_suffixes\": [\"Service\"],\n\t\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\"plugin\": \"buf-plugin-protovalidate-ext\"},\n\t\t\t\t{\"plugin\": \"buf-plugin-rpc-ext\"}\n\t\t\t]\n\t\t}`,\n\t)\n\n\t// tests that if a plugin panics, the buf CLI does not panic\n\trequire.NotPanics(\n\t\tt,\n\t\tfunc() {\n\t\t\tappcmdtesting.Run(\n\t\t\t\tt,\n\t\t\t\tnewRootCommand,\n\t\t\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\t\t\tappcmdtesting.WithExpectedExitCode(1),\n\t\t\t\tappcmdtesting.WithExpectedStderrPartials(\n\t\t\t\t\t`panic: this panic is intentional`,\n\t\t\t\t\t`Failure: plugin \"buf-plugin-panic\" failed: Exited with code 2: exit status 2`,\n\t\t\t\t),\n\t\t\t\tappcmdtesting.WithArgs(\n\t\t\t\t\t\"lint\",\n\t\t\t\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\"),\n\t\t\t\t\t\"--config\",\n\t\t\t\t\t`{\n\t\t\t\t\t\"version\":\"v2\",\n\t\t\t\t\t\"modules\": [\n\t\t\t\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t\t\t\t],\n\t\t\t\t\t\"lint\": {\n\t\t\t\t\t\t\"use\": [\"LINT_PANIC\"]\n\t\t\t\t\t},\n\t\t\t\t\t\"plugins\":[\n\t\t\t\t\t\t{\"plugin\": \"buf-plugin-panic\"}\n\t\t\t\t\t]\n\t\t\t\t}`,\n\t\t\t\t),\n\t\t\t)\n\t\t},\n\t)\n}\n\nfunc TestBreakingWithPaths(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(t, nil, 0, ``, \"build\", filepath.Join(\"internal\", \"command\", \"generate\", \"testdata\", \"paths\"), \"-o\", filepath.Join(tempDir, \"previous.binpb\"))\n\ttestRunStdout(t, nil, 0, ``, \"build\", filepath.Join(\"testdata\", \"paths\"), \"-o\", filepath.Join(tempDir, \"current.binpb\"))\n\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tstoragetesting.AssertPaths(\n\t\tt,\n\t\treadWriteBucket,\n\t\t\"\",\n\t\t\"previous.binpb\",\n\t\t\"current.binpb\",\n\t)\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\t`a/v3/a.proto:6:3:Field \"1\" with name \"key\" on message \"Foo\" changed type from \"string\" to \"int32\".\na/v3/a.proto:7:3:Field \"2\" with name \"Value\" on message \"Foo\" changed option \"json_name\" from \"value\" to \"Value\".\na/v3/a.proto:7:10:Field \"2\" on message \"Foo\" changed name from \"value\" to \"Value\".`,\n\t\t\"\",\n\t\t\"breaking\",\n\t\tfilepath.Join(tempDir, \"current.binpb\"),\n\t\t\"--against\",\n\t\tfilepath.Join(tempDir, \"previous.binpb\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"a\", \"v3\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"a\", \"v3\", \"foo\"),\n\t)\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\t`a/v3/a.proto:6:3:Field \"1\" with name \"key\" on message \"Foo\" changed type from \"string\" to \"int32\". See https://developers.google.com/protocol-buffers/docs/proto3#updating for wire compatibility rules.`,\n\t\t\"\",\n\t\t\"breaking\",\n\t\tfilepath.Join(tempDir, \"current.binpb\"),\n\t\t\"--against\",\n\t\tfilepath.Join(tempDir, \"previous.binpb\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"a\", \"v3\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"a\", \"v3\", \"foo\"),\n\t\t\"--config\",\n\t\t`{\"version\":\"v2\",\"breaking\":{\"use\":[\"WIRE\"]}}`,\n\t)\n}\n\nfunc TestBreakingWithPlugins(t *testing.T) {\n\tt.Parallel()\n\tcurrentConfig := `{\n\t\t\t\"version\":\"v2\",\n\t\t\t\"modules\": [\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t\t],\n\t\t\t\"breaking\": {\n\t\t\t\t\"use\": [\"STRING_LEN_RANGE_NO_SHRINK\"]\n\t\t\t},\n\t\t\t\"plugins\":[\n\t\t\t\t{\n\t\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\"service_banned_suffixes\": [\"Mock\", \"Test\"],\n\t\t\t\t\t\t\"rpc_banned_suffixes\": [\"Element\"],\n\t\t\t\t\t\t\"field_banned_suffixes\": [\"_uuid\"],\n\t\t\t\t\t\t\"enum_value_banned_suffixes\": [\"_invalid\"],\n\t\t\t\t\t\t\"service_no_change_suffixes\": [\"Service\"],\n\t\t\t\t\t\t\"message_no_change_suffixes\": [\"Request\", \"Response\"],\n\t\t\t\t\t\t\"enum_no_change_suffixes\": [\"State\"]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\"plugin\": \"buf-plugin-protovalidate-ext\"},\n\t\t\t\t{\"plugin\": \"buf-plugin-rpc-ext\"}\n\t\t\t]\n\t\t}`\n\tpreviousConfig := strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:10:5:max len requirement reduced from 10 to 5 (buf-plugin-protovalidate-ext)\ntestdata/check_plugins/current/proto/common/v1alpha1/breaking.proto:10:5:max len requirement reduced from 10 to 5 (buf-plugin-protovalidate-ext)\n\t\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\n\t// ignore unstable package\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"STRING_LEN_RANGE_NO_SHRINK\"],\n\t\t\t\"ignore_unstable_packages\": true\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"service_banned_suffixes\": [\"Mock\", \"Test\"],\n\t\t\t\t\t\"rpc_banned_suffixes\": [\"Element\"],\n\t\t\t\t\t\"field_banned_suffixes\": [\"_uuid\"],\n\t\t\t\t\t\"enum_value_banned_suffixes\": [\"_invalid\"],\n\t\t\t\t\t\"service_no_change_suffixes\": [\"Service\"],\n\t\t\t\t\t\"message_no_change_suffixes\": [\"Request\", \"Response\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"State\"]\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\"plugin\": \"buf-plugin-protovalidate-ext\"},\n\t\t\t{\"plugin\": \"buf-plugin-rpc-ext\"}\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:10:5:max len requirement reduced from 10 to 5 (buf-plugin-protovalidate-ext)\n\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\n\t// use category\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"ATTRIBUTES_SUFFIXES\"],\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t}\n\t\t\t},\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:14:1:Message \"common.v1.MSG_DONT_CHANGE\" has a suffix configured for no changes has different fields, previously [], currently [common.v1.MSG_DONT_CHANGE.new_field]. (buf-plugin-suffix)\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:18:1:Enum \"common.v1.E_DO_NOT_CHANGE\" has a suffix configured for no changes has different enum values, previously [common.v1.ZERO], currently [common.v1.ONE common.v1.ZERO]. (buf-plugin-suffix)\n\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\n\t// use deprecated category\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"RESOURCE_SUFFIXES\"],\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t}\n\t\t\t},\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:14:1:Message \"common.v1.MSG_DONT_CHANGE\" has a suffix configured for no changes has different fields, previously [], currently [common.v1.MSG_DONT_CHANGE.new_field]. (buf-plugin-suffix)\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:18:1:Enum \"common.v1.E_DO_NOT_CHANGE\" has a suffix configured for no changes has different enum values, previously [common.v1.ZERO], currently [common.v1.ONE common.v1.ZERO]. (buf-plugin-suffix)\n\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\n\t// use except\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"RESOURCE_SUFFIXES\"],\n\t\t\t\"except\": [\"ENUM_SUFFIXES_NO_CHANGE\"]\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t}\n\t\t\t},\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:14:1:Message \"common.v1.MSG_DONT_CHANGE\" has a suffix configured for no changes has different fields, previously [], currently [common.v1.MSG_DONT_CHANGE.new_field]. (buf-plugin-suffix)\n\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\n\t// ignore module\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"RESOURCE_SUFFIXES\"],\n\t\t\t\"ignore\": [\"testdata/check_plugins/current/proto\"]\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t}\n\t\t\t},\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\",\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\t// ignore path inside module\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"RESOURCE_SUFFIXES\"],\n\t\t\t\"ignore\": [\"testdata/check_plugins/current/proto/common/v1\"]\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t}\n\t\t\t},\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\",\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\t// ignore only\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"RESOURCE_SUFFIXES\"],\n\t\t\t\"ignore_only\": {\n\t\t\t\t\"MESSAGE_SUFFIXES_NO_CHANGE\": [\"testdata/check_plugins/current/proto/common\"],\n\t\t\t},\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t}\n\t\t\t},\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:18:1:Enum \"common.v1.E_DO_NOT_CHANGE\" has a suffix configured for no changes has different enum values, previously [common.v1.ZERO], currently [common.v1.ONE common.v1.ZERO]. (buf-plugin-suffix)\n\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n\t// Set the same category for lint and breaking but ensure only breaking is run.\n\tcurrentConfig = `{\n\t\t\"version\":\"v2\",\n\t\t\"modules\": [\n\t\t\t{\"path\": \"testdata/check_plugins/current/proto\"},\n\t\t\t{\"path\": \"testdata/check_plugins/current/vendor/protovalidate\"}\n\t\t],\n\t\t\"lint\": {\n\t\t\t\"use\": [\"ATTRIBUTES_SUFFIXES\"]\n\t\t},\n\t\t\"breaking\": {\n\t\t\t\"use\": [\"ATTRIBUTES_SUFFIXES\"]\n\t\t},\n\t\t\"plugins\":[\n\t\t\t{\n\t\t\t\t\"plugin\": \"buf-plugin-suffix\",\n\t\t\t\t\"options\": {\n\t\t\t\t\t\"service_banned_suffixes\": [\"Mock\", \"Test\"],\n\t\t\t\t\t\"rpc_banned_suffixes\": [\"Element\"],\n\t\t\t\t\t\"field_banned_suffixes\": [\"_uuid\"],\n\t\t\t\t\t\"enum_value_banned_suffixes\": [\"_invalid\"],\n\t\t\t\t\t\"service_no_change_suffixes\": [\"Service\"],\n\t\t\t\t\t\"message_no_change_suffixes\": [\"DONT_CHANGE\"],\n\t\t\t\t\t\"enum_no_change_suffixes\": [\"DO_NOT_CHANGE\"]\n\t\t\t\t}\n\t\t\t},\n\t\t]\n\t}`\n\tpreviousConfig = strings.ReplaceAll(\n\t\tcurrentConfig,\n\t\t\"current\",\n\t\t\"previous\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:14:1:Message \"common.v1.MSG_DONT_CHANGE\" has a suffix configured for no changes has different fields, previously [], currently [common.v1.MSG_DONT_CHANGE.new_field]. (buf-plugin-suffix)\ntestdata/check_plugins/current/proto/common/v1/breaking.proto:18:1:Enum \"common.v1.E_DO_NOT_CHANGE\" has a suffix configured for no changes has different enum values, previously [common.v1.ZERO], currently [common.v1.ONE common.v1.ZERO]. (buf-plugin-suffix)\n\t`),\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--config\",\n\t\tcurrentConfig,\n\t\t\"--against-config\",\n\t\tpreviousConfig,\n\t)\n}\n\nfunc TestBreakingAgainstRegistryFlag(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"Failure: Cannot set both --against and --against-registry\",\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"current\", \"proto\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"check_plugins\", \"previous\", \"proto\"),\n\t\t\"--against-registry\",\n\t)\n\ttestRunStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"Failure: cannot use --against-registry with unnamed module, testdata/success\",\n\t\t\"breaking\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t\t\"--against-registry\",\n\t)\n}\n\nfunc TestVersion(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(t, nil, 0, bufcli.Version, \"--version\")\n}\n\nfunc TestConvertWithImage(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t)\n\tt.Run(\"stdin input\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tstdin, err := os.Open(filepath.Join(convertTestDataDir, \"descriptor.plain.binpb\"))\n\t\trequire.NoError(t, err)\n\t\tdefer stdin.Close()\n\t\tstdout := bytes.NewBuffer(nil)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tstdin,\n\t\t\tstdout,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t)\n\t\tassert.JSONEq(t, `{\"one\":\"55\"}`, stdout.String())\n\t})\n\n\tt.Run(\"no stdin input from binpb\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tnil,\n\t\t\tnil,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from=-#format=binpb\",\n\t\t\t\"--to=-#format=txtpb\",\n\t\t)\n\t})\n\tt.Run(\"no stdin input from txtpb\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tnil,\n\t\t\tnil,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from=-#format=txtpb\",\n\t\t\t\"--to=-#format=binpb\",\n\t\t)\n\t})\n\tt.Run(\"no stdin input from yaml\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tnil,\n\t\t\tnil,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from=-#format=yaml\",\n\t\t\t\"--to=-#format=binpb\",\n\t\t)\n\t})\n\tt.Run(\"no stdin input from json\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRunStderrContainsNoWarn(\n\t\t\tt,\n\t\t\tnil,\n\t\t\t1,\n\t\t\t[]string{\n\t\t\t\t\"Failure: --from:\",\n\t\t\t\t\"json unmarshal:\",\n\t\t\t\t\"proto:\",\n\t\t\t\t\"syntax error (line 1:1): unexpected token\",\n\t\t\t},\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from=-#format=json\",\n\t\t\t\"--to=-#format=binpb\",\n\t\t)\n\t})\n}\n\nfunc TestConvertOutput(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t)\n\tt.Run(\"json file output\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tstdin, err := os.Open(filepath.Join(convertTestDataDir, \"descriptor.plain.binpb\"))\n\t\trequire.NoError(t, err)\n\t\tdefer stdin.Close()\n\t\toutputTempDir := t.TempDir()\n\t\ttestRunStdout(\n\t\t\tt,\n\t\t\tstdin,\n\t\t\t0,\n\t\t\t``,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--to\",\n\t\t\tfilepath.Join(outputTempDir, \"result.json\"),\n\t\t)\n\t\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(outputTempDir)\n\t\trequire.NoError(t, err)\n\t\tstoragetesting.AssertPathToContent(\n\t\t\tt,\n\t\t\treadWriteBucket,\n\t\t\t\"\",\n\t\t\tmap[string]string{\n\t\t\t\t\"result.json\": `{\"one\":\"55\"}`,\n\t\t\t},\n\t\t)\n\t})\n\tt.Run(\"txt file output\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tstdin, err := os.Open(filepath.Join(convertTestDataDir, \"descriptor.plain.binpb\"))\n\t\trequire.NoError(t, err)\n\t\tdefer stdin.Close()\n\t\toutputTempDir := t.TempDir()\n\t\ttestRunStdout(\n\t\t\tt,\n\t\t\tstdin,\n\t\t\t0,\n\t\t\t``,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--to\",\n\t\t\tfilepath.Join(outputTempDir, \"result.txt\"),\n\t\t)\n\t\treadWriteBucket, err := storageos.NewProvider().NewReadWriteBucket(outputTempDir)\n\t\trequire.NoError(t, err)\n\t\tstoragetesting.AssertPathToContent(\n\t\t\tt,\n\t\t\treadWriteBucket,\n\t\t\t\"\",\n\t\t\tmap[string]string{\n\t\t\t\t\"result.txt\": `{\"one\":\"55\"}`,\n\t\t\t},\n\t\t)\n\t})\n\tt.Run(\"stdout with dash\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tstdin, err := os.Open(filepath.Join(convertTestDataDir, \"descriptor.plain.binpb\"))\n\t\trequire.NoError(t, err)\n\t\tdefer stdin.Close()\n\t\tstdout := bytes.NewBuffer(nil)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tstdin,\n\t\t\tstdout,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--to\",\n\t\t\t\"-\",\n\t\t)\n\t\tassert.JSONEq(t, `{\"one\":\"55\"}`, stdout.String())\n\t})\n}\n\nfunc TestConvertInvalidTypeName(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t)\n\tstdin, err := os.Open(filepath.Join(convertTestDataDir, \"descriptor.plain.binpb\"))\n\trequire.NoError(t, err)\n\tdefer stdin.Close()\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tstdin,\n\t\t1,\n\t\t\"\",\n\t\t`Failure: --from: \".foo\" is not a valid fully qualified type name`,\n\t\t\"convert\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\"--type\",\n\t\t\".foo\",\n\t)\n}\n\nfunc TestConvert(t *testing.T) {\n\tt.Parallel()\n\tt.Run(\"binpb-to-json-file-proto\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRunStdoutFile(t,\n\t\t\tnil,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"--from=\"+convertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\tconvertTestDataDir+\"/bin_json/buf.proto\",\n\t\t)\n\t})\n\tt.Run(\"json-to-binpb-file-proto\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRunStdoutFile(t,\n\t\t\tnil,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"--from=\"+convertTestDataDir+\"/bin_json/payload.json\",\n\t\t\tconvertTestDataDir+\"/bin_json/buf.proto\",\n\t\t)\n\t})\n\tt.Run(\"stdin-json-to-binpb-proto\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRunStdoutFile(t,\n\t\t\tstrings.NewReader(`{\"one\":\"55\"}`),\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=json\",\n\t\t\tconvertTestDataDir+\"/bin_json/buf.proto\",\n\t\t)\n\t})\n\tt.Run(\"stdin-binpb-to-json-proto\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/payload.binpb\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t, file,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=binpb\",\n\t\t\tconvertTestDataDir+\"/bin_json/buf.proto\",\n\t\t)\n\t})\n\tt.Run(\"stdin-json-to-json-proto\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\ttestRunStdoutFile(t,\n\t\t\tstrings.NewReader(`{\"one\":\"55\"}`),\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\tconvertTestDataDir+\"/bin_json/buf.proto\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\")\n\t})\n\tt.Run(\"stdin-input-to-json-image\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/image.binpb\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t, file,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"-\",\n\t\t\t\"--from=\"+convertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t)\n\t})\n\tt.Run(\"stdin-json-to-json-image\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/payload.binpb\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\tconvertTestDataDir+\"/bin_json/image.binpb\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=binpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\")\n\t})\n\tt.Run(\"stdin-binpb-payload-to-json-with-image\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/payload.binpb\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\tconvertTestDataDir+\"/bin_json/image.binpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t)\n\t})\n\tt.Run(\"stdin-json-payload-to-binpb-with-image\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/payload.json\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\tconvertTestDataDir+\"/bin_json/image.binpb\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t)\n\t})\n\tt.Run(\"stdin-json-payload-to-yaml-with-image\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/payload.json\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.yaml\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\tconvertTestDataDir+\"/bin_json/image.yaml\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=yaml\",\n\t\t)\n\t})\n\tt.Run(\"stdin-image-json-to-binpb\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/image.json\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"-#format=json\",\n\t\t\t\"--from=\"+convertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t)\n\t})\n\tt.Run(\"stdin-image-json-to-yaml\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/image.json\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.yaml\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"-#format=json\",\n\t\t\t\"--from=\"+convertTestDataDir+\"/bin_json/payload.json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=yaml\",\n\t\t)\n\t})\n\tt.Run(\"stdin-image-txtpb-to-binpb\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/image.txtpb\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"-#format=txtpb\",\n\t\t\t\"--from=\"+convertTestDataDir+\"/bin_json/payload.txtpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t)\n\t})\n\tt.Run(\"stdin-image-yaml-to-binpb\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tfile, err := os.Open(convertTestDataDir + \"/bin_json/image.yaml\")\n\t\trequire.NoError(t, err)\n\t\ttestRunStdoutFile(t,\n\t\t\tfile,\n\t\t\t0,\n\t\t\tconvertTestDataDir+\"/bin_json/payload.binpb\",\n\t\t\t\"convert\",\n\t\t\t\"--type=buf.Foo\",\n\t\t\t\"-#format=yaml\",\n\t\t\t\"--from=\"+convertTestDataDir+\"/bin_json/payload.yaml\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t)\n\t})\n}\n\nfunc TestFormat(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t`\nsyntax = \"proto3\";\n\npackage simple;\n\nmessage Object {\n string key = 1;\n bytes value = 2;\n}\n\t\t`,\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"simple\"),\n\t)\n}\n\nfunc TestFormatSingleFile(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"simple\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"simple.formatted\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"format\",\n\t\tfilepath.Join(tempDir, \"simple.formatted\"),\n\t\t\"-d\",\n\t)\n}\n\nfunc TestFormatDiff(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\t0,\n\t\tnil,\n\t\tstdout,\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"diff\"),\n\t\t\"-d\",\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"formatted\"),\n\t)\n\tassert.Contains(\n\t\tt,\n\t\tstdout.String(),\n\t\t`\n@@ -1,13 +1,7 @@\n-\n syntax = \"proto3\";\n`,\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"format\",\n\t\tfilepath.Join(tempDir, \"formatted\"),\n\t\t\"-d\",\n\t)\n}\n\n// Tests if the exit code is set for common invocations of buf format\n// with the --exit-code flag.\nfunc TestFormatExitCode(t *testing.T) {\n\tt.Parallel()\n\tstdout := bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tnil,\n\t\tstdout,\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"diff\"),\n\t\t\"--exit-code\",\n\t)\n\tassert.NotEmpty(t, stdout.String())\n\tstdout = bytes.NewBuffer(nil)\n\ttestRun(\n\t\tt,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tnil,\n\t\tstdout,\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"diff\"),\n\t\t\"-d\",\n\t\t\"--exit-code\",\n\t)\n\tassert.NotEmpty(t, stdout.String())\n}\n\n// Tests if the image produced by the formatted result is\n// equivalent to the original result.\nfunc TestFormatEquivalence(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"complex\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\"--exclude-source-info\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"complex\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"formatted\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(tempDir, \"formatted\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"formatted.binpb\"),\n\t\t\"--exclude-source-info\",\n\t)\n\toriginalImageData, err := os.ReadFile(filepath.Join(tempDir, \"image.binpb\"))\n\trequire.NoError(t, err)\n\tformattedImageData, err := os.ReadFile(filepath.Join(tempDir, \"formatted.binpb\"))\n\trequire.NoError(t, err)\n\trequire.Equal(t, originalImageData, formattedImageData)\n}\n\nfunc TestFormatInvalidFlagCombination(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStderrContainsNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t[]string{\n\t\t\t`Failure: cannot use --output when using --write`,\n\t\t},\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"diff\"),\n\t\t\"-w\",\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"formatted\"),\n\t)\n}\n\nfunc TestFormatInvalidWriteWithModuleReference(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrContainsNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t[]string{\n\t\t\t`Failure: invalid input \"buf.build/acme/weather\" when using --write: must be a directory or proto file`,\n\t\t},\n\t\t\"format\",\n\t\t\"buf.build/acme/weather\",\n\t\t\"-w\",\n\t)\n}\n\nfunc TestFormatInvalidIncludePackageFiles(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrContainsNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t[]string{\n\t\t\t\"Failure: cannot specify include_package_files=true with format\",\n\t\t},\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"simple\", \"simple.proto#include_package_files=true\"),\n\t)\n}\n\nfunc TestFormatInvalidInputDoesNotCreateDirectory(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\",\n\t\tfilepath.FromSlash(`Failure: testdata/format/invalid/invalid.proto:4:12: syntax error: unexpected '.', expecting '{'`),\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"invalid\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"formatted\", \"invalid\"), // Directory output.\n\t)\n\t_, err := os.Stat(filepath.Join(tempDir, \"formatted\", \"invalid\"))\n\tassert.True(t, os.IsNotExist(err))\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\",\n\t\tfilepath.FromSlash(`Failure: testdata/format/invalid/invalid.proto:4:12: syntax error: unexpected '.', expecting '{'`),\n\t\t\"format\",\n\t\tfilepath.Join(\"testdata\", \"format\", \"invalid\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"formatted\", \"invalid\", \"invalid.proto\"), // Single file output.\n\t)\n\t_, err = os.Stat(filepath.Join(tempDir, \"formatted\", \"invalid\"))\n\tassert.True(t, os.IsNotExist(err))\n}\n\nfunc TestConvertRoundTrip(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"success\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t)\n\tt.Run(\"stdin and stdout\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tstdin := bytes.NewBufferString(`{\"one\":\"55\"}`)\n\t\tencodedMessage := bytes.NewBuffer(nil)\n\t\tdecodedMessage := bytes.NewBuffer(nil)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tstdin,\n\t\t\tencodedMessage,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=json\",\n\t\t)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tencodedMessage,\n\t\t\tdecodedMessage,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t)\n\t\tassert.JSONEq(t, `{\"one\":\"55\"}`, decodedMessage.String())\n\t})\n\tt.Run(\"stdin and stdout with type specified\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tstdin := bytes.NewBufferString(`{\"one\":\"55\"}`)\n\t\tencodedMessage := bytes.NewBuffer(nil)\n\t\tdecodedMessage := bytes.NewBuffer(nil)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tstdin,\n\t\t\tencodedMessage,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tencodedMessage,\n\t\t\tdecodedMessage,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=binpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t)\n\t\tassert.JSONEq(t, `{\"one\":\"55\"}`, decodedMessage.String())\n\t})\n\tt.Run(\"file output and input\", func(t *testing.T) {\n\t\tt.Parallel()\n\t\tstdin := bytes.NewBufferString(`{\"one\":\"55\"}`)\n\t\tdecodedMessage := bytes.NewBuffer(nil)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tstdin,\n\t\t\tnil,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=json\",\n\t\t\t\"--to\",\n\t\t\tfilepath.Join(tempDir, \"decoded_message.binpb\"),\n\t\t)\n\t\ttestRun(\n\t\t\tt,\n\t\t\t0,\n\t\t\tnil,\n\t\t\tdecodedMessage,\n\t\t\t\"convert\",\n\t\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\tfilepath.Join(tempDir, \"decoded_message.binpb\"),\n\t\t)\n\t\tassert.JSONEq(t, `{\"one\":\"55\"}`, decodedMessage.String())\n\t})\n}\n\nfunc TestProtoFileNoWorkspaceOrModule(t *testing.T) {\n\tt.Parallel()\n\t// We can build a simple proto file re that does not belong to any workspace or module\n\t// based on the directory of the input.\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\",\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"noworkspaceormodule\", \"success\", \"simple.proto\"),\n\t)\n\t// However, we should fail if there is any complexity (e.g. an import that cannot be\n\t// resolved) since there is no workspace or module config to base this off of.\n\ttestRunStdoutStderrNoWarn(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\t\"\", // no stdout\n\t\tfilepath.FromSlash(`testdata/protofileref/noworkspaceormodule/fail/import.proto:3:8:import \"`)+`google/type/date.proto\": file does not exist`,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"noworkspaceormodule\", \"fail\", \"import.proto\"),\n\t)\n}\n\nfunc TestModuleArchiveDir(t *testing.T) {\n\t// Archive that defines module at input path\n\tt.Parallel()\n\tzipDir := createZipFromDir(\n\t\tt,\n\t\tfilepath.Join(\"testdata\", \"failarchive\"),\n\t\t\"archive.zip\",\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`fail/buf/buf.proto:3:1:Files with package \"other\" must be within a directory \"other\" relative to root but were in directory \"buf\".\nfail/buf/buf.proto:6:9:Field name \"oneTwo\" should be lower_snake_case, such as \"one_two\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(zipDir, \"archive.zip#subdir=fail\"),\n\t)\n}\n\nfunc TestLintDisabledForModuleInWorkspace(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\tbufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/lint_ignore_disabled/proto/a.proto:3:9:Message name \"foo\" should be PascalCase, such as \"Foo\".`),\n\t\t\"lint\",\n\t\tfilepath.Join(\"testdata\", \"lint_ignore_disabled\"),\n\t)\n}\n\nfunc TestLintNoSourceCodeInfoIgnores(t *testing.T) {\n\tt.Parallel()\n\ttempDir := t.TempDir()\n\t// Build image without source code info\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\t\"--exclude-source-info\",\n\t\tfilepath.Join(\"testdata\", \"fail\"),\n\t\t\"-o\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"lint\",\n\t\tfilepath.Join(tempDir, \"image.binpb\"),\n\t\t\"--config\",\n\t\t`{\n\t\t\"version\": \"v2\",\n\t\t\"lint\": {\n\t\t\t\"ignore_only\": {\n\t\t\t\t\"FIELD_LOWER_SNAKE_CASE\": [\"buf/buf.proto\"],\n\t\t\t\t\"PACKAGE_DIRECTORY_MATCH\": [\"buf/buf.proto\"],\n\t\t\t\t\"PACKAGE_VERSION_SUFFIX\": [\"buf/buf.proto\"],\n\t\t\t\t},\n\t\t\t},\n\t\t}`,\n\t)\n}\n\n// testBuildLsFilesFormatImport does effectively an ls-files, but via doing a build of an Image, and then\n// listing the files from the image as if --format=import was set.\nfunc testBuildLsFilesFormatImport(t *testing.T, expectedExitCode int, expectedFiles []string, buildArgs ...string) {\n\tbuffer := bytes.NewBuffer(nil)\n\ttestRun(t, expectedExitCode, nil, buffer, append([]string{\"build\", \"-o\", \"-\"}, buildArgs...)...)\n\tprotoImage := &imagev1.Image{}\n\terr := protoencoding.NewWireUnmarshaler(nil).Unmarshal(buffer.Bytes(), protoImage)\n\trequire.NoError(t, err)\n\timage, err := bufimage.NewImageForProto(protoImage)\n\trequire.NoError(t, err)\n\tvar paths []string\n\tfor _, imageFile := range image.Files() {\n\t\tpaths = append(paths, imageFile.Path())\n\t}\n\trequire.Equal(t, expectedFiles, paths)\n}\n\nfunc testModInit(t *testing.T, expectedData string, document bool, name string, deps ...string) {\n\ttempDir := t.TempDir()\n\tbaseArgs := []string{\"mod\", \"init\"}\n\targs := append(baseArgs, \"-o\", tempDir)\n\tif document {\n\t\targs = append(args, \"--doc\")\n\t}\n\tif name != \"\" {\n\t\targs = append(args, \"--name\", name)\n\t}\n\ttestRun(t, 0, nil, nil, args...)\n\tdata, err := os.ReadFile(filepath.Join(tempDir, \"buf.yaml\"))\n\trequire.NoError(t, err)\n\trequire.Equal(t, expectedData, string(data))\n}\n\nfunc testRunStdout(t *testing.T, stdin io.Reader, expectedExitCode int, expectedStdout string, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tnewRootCommand,\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStdout(expectedStdout),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n\nfunc testRunStderr(t *testing.T, stdin io.Reader, expectedExitCode int, expectedStderr string, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tnewRootCommand,\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStderr(expectedStderr),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n\nfunc testRunStdoutStderrNoWarn(t *testing.T, stdin io.Reader, expectedExitCode int, expectedStdout string, expectedStderr string, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tnewRootCommand,\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStdout(expectedStdout),\n\t\tappcmdtesting.WithExpectedStderr(expectedStderr),\n\t\tappcmdtesting.WithArgs(\n\t\t\t// we do not want warnings to be part of our stderr test calculation\n\t\t\tappend(\n\t\t\t\targs,\n\t\t\t\t\"--no-warn\",\n\t\t\t)...,\n\t\t),\n\t)\n}\n\nfunc testRunStderrContainsNoWarn(t *testing.T, stdin io.Reader, expectedExitCode int, expectedStderrPartials []string, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tnewRootCommand,\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStderrPartials(expectedStderrPartials...),\n\t\tappcmdtesting.WithArgs(\n\t\t\t// we do not want warnings to be part of our stderr test calculation\n\t\t\tappend(\n\t\t\t\targs,\n\t\t\t\t\"--no-warn\",\n\t\t\t)...,\n\t\t),\n\t)\n}\n\nfunc testRunStdoutFile(t *testing.T, stdin io.Reader, expectedExitCode int, wantFile string, args ...string) {\n\twantReader, err := os.Open(wantFile)\n\trequire.NoError(t, err)\n\twantBytes, err := io.ReadAll(wantReader)\n\trequire.NoError(t, err)\n\ttestRunStdout(\n\t\tt,\n\t\tstdin,\n\t\texpectedExitCode,\n\t\tstring(wantBytes),\n\t\targs...,\n\t)\n}\n\nfunc testRun(\n\tt *testing.T,\n\texpectedExitCode int,\n\tstdin io.Reader,\n\tstdout io.Writer,\n\targs ...string,\n) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tnewRootCommand,\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithStdout(stdout),\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n\nfunc getRuleIDsFromLsBreaking(t *testing.T, fileVersion string, useIDs []string, exceptIDs []string) []string {\n\tt.Helper()\n\tstdout := bytes.NewBuffer(nil)\n\tappcmdtesting.Run(\n\t\tt,\n\t\tnewRootCommand,\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdout(stdout),\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"config\",\n\t\t\t\"ls-breaking-rules\",\n\t\t\t\"--format=json\",\n\t\t\t\"--configured-only\",\n\t\t\t\"--config\",\n\t\t\tfmt.Sprintf(\n\t\t\t\t`{ \"version\": %q, \"breaking\": { \"use\": %s, \"except\": %s } }`,\n\t\t\t\tfileVersion,\n\t\t\t\t\"[\"+strings.Join(xslices.Map(useIDs, func(s string) string { return strconv.Quote(s) }), \",\")+\"]\",\n\t\t\t\t\"[\"+strings.Join(xslices.Map(exceptIDs, func(s string) string { return strconv.Quote(s) }), \",\")+\"]\",\n\t\t\t),\n\t\t),\n\t)\n\tvar ids []string\n\tdecoder := json.NewDecoder(stdout)\n\ttype entry struct {\n\t\tID string\n\t}\n\tfor {\n\t\tvar entry entry\n\t\terr := decoder.Decode(&entry)\n\t\tif errors.Is(err, io.EOF) {\n\t\t\tbreak\n\t\t}\n\t\trequire.NoError(t, err)\n\t\tids = append(ids, entry.ID)\n\t}\n\tsort.Strings(ids)\n\treturn ids\n}\n\nfunc testLsRuleOutputJSON(\n\tt *testing.T,\n\truleType check.RuleType,\n\tconfig string,\n\texpectedRules []*outputCheckRule,\n) {\n\tstdout := bytes.NewBuffer(nil)\n\tstderr := bytes.NewBuffer(nil)\n\tvar command string\n\tswitch ruleType {\n\tcase check.RuleTypeLint:\n\t\tcommand = \"ls-lint-rules\"\n\tcase check.RuleTypeBreaking:\n\t\tcommand = \"ls-breaking-rules\"\n\tdefault:\n\t\tt.Errorf(\"invalid rule type %v\", ruleType)\n\t\tt.FailNow()\n\t}\n\tappcmdtesting.Run(\n\t\tt,\n\t\tnewRootCommand,\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdout(stdout),\n\t\tappcmdtesting.WithStderr(stderr),\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"config\",\n\t\t\tcommand,\n\t\t\t\"--configured-only\",\n\t\t\t\"--config\",\n\t\t\tconfig,\n\t\t\t\"--format\",\n\t\t\t\"json\",\n\t\t),\n\t)\n\toutputRules :=\n\t\txslices.Map(\n\t\t\txslices.Filter(\n\t\t\t\tbytes.Split(stdout.Bytes(), []byte(\"\\n\")),\n\t\t\t\tfunc(outputBytes []byte) bool {\n\t\t\t\t\treturn len(outputBytes) > 0\n\t\t\t\t},\n\t\t\t),\n\t\t\tfunc(outputBytes []byte) *outputCheckRule {\n\t\t\t\tvar outputRule outputCheckRule\n\t\t\t\trequire.NoError(t, json.Unmarshal(outputBytes, &outputRule), \"unable to unmarshal %s\", string(outputBytes))\n\t\t\t\treturn &outputRule\n\t\t\t},\n\t\t)\n\trequire.Equal(t, expectedRules, outputRules)\n}\n" }, { "path": "cmd/buf/buf_unix_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n//go:build aix || darwin || dragonfly || freebsd || (js && wasm) || linux || netbsd || openbsd || solaris\n\npackage main\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n)\n\nfunc TestLsFilesSymlinks(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t// b.proto links to a .go file, which shouldn't be parsed.\n\t\t// This requires ls-files to not build an Image if we don't include imports\n\t\t// on ls-files. This test effectively verifies that we don't build unless\n\t\t// we have to.\n\t\tfilepath.FromSlash(`testdata/symlinks/a.proto\ntestdata/symlinks/b.proto`),\n\t\t\"ls-files\",\n\t\tfilepath.Join(\"testdata\", \"symlinks\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\tfilepath.FromSlash(`testdata/symlinks/a.proto`),\n\t\t\"ls-files\",\n\t\t\"--disable-symlinks\",\n\t\tfilepath.Join(\"testdata\", \"symlinks\"),\n\t)\n}\n\nfunc TestBuildSymlinks(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t100,\n\t\t``,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"symlinks\"),\n\t)\n\ttestRunStdout(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t\"build\",\n\t\t\"--disable-symlinks\",\n\t\tfilepath.Join(\"testdata\", \"symlinks\"),\n\t)\n}\n" }, { "path": "cmd/buf/imports_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage main\n\nimport (\n\t\"io\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appcmd/appcmdtesting\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/bufbuild/buf/private/pkg/uuidutil\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestValidNoImports(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrWithCache(\n\t\tt, nil, 0,\n\t\t\"\",\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"people\"),\n\t)\n}\n\nfunc TestValidImportFromCache(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrWithCache(\n\t\tt, nil, 0,\n\t\t\"\",\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"students\"),\n\t)\n}\n\nfunc TestValidImportFromCorruptedCacheFile(t *testing.T) {\n\tt.Parallel()\n\n\tmoduleFullName, err := bufparse.NewFullName(\"bufbuild.test\", \"bufbot\", \"people\")\n\trequire.NoError(t, err)\n\tcommitID, err := uuidutil.FromDashless(\"fc7d540124fd42db92511c19a60a1d98\")\n\trequire.NoError(t, err)\n\texpectedDigest, err := bufmodule.ParseDigest(\"b5:b22338d6faf2a727613841d760c9cbfd21af6950621a589df329e1fe6611125904c39e22a73e0aa8834006a514dbd084e6c33b6bef29c8e4835b4b9dec631465\")\n\trequire.NoError(t, err)\n\tactualDigest, err := bufmodule.ParseDigest(\"b5:87403abcc5ec8403180536840a46bef8751df78caa8ad4b46939f4673d8bd58663d0f593668651bb2cd23049fedac4989e8b28c7e0e36b9b524f58ab09bf1053\")\n\trequire.NoError(t, err)\n\tdigestMismatchError := &bufmodule.DigestMismatchError{\n\t\tFullName: moduleFullName,\n\t\tCommitID: commitID,\n\t\tExpectedDigest: expectedDigest,\n\t\tActualDigest: actualDigest,\n\t}\n\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(use string) *appcmd.Command { return newRootCommand(use) },\n\t\tappcmdtesting.WithExpectedExitCode(1),\n\t\tappcmdtesting.WithExpectedStderr(appFailureError(digestMismatchError).Error()),\n\t\tappcmdtesting.WithEnv(\n\t\t\tfunc(use string) map[string]string {\n\t\t\t\treturn map[string]string{\n\t\t\t\t\tuseEnvVar(use, \"CACHE_DIR\"): filepath.Join(\"testdata\", \"imports\", \"corrupted_cache_file\"),\n\t\t\t\t}\n\t\t\t},\n\t\t),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"build\",\n\t\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"students\"),\n\t\t\t\"--no-warn\",\n\t\t),\n\t)\n}\n\nfunc TestValidImportFromCorruptedCacheDep(t *testing.T) {\n\tt.Parallel()\n\tmoduleFullName, err := bufparse.NewFullName(\"bufbuild.test\", \"bufbot\", \"students\")\n\trequire.NoError(t, err)\n\tcommitID, err := uuidutil.FromDashless(\"6c776ed5bee54462b06d31fb7f7c16b8\")\n\trequire.NoError(t, err)\n\texpectedDigest, err := bufmodule.ParseDigest(\"b5:01764dd31d0e1b8355eb3b262bba4539657af44872df6e4dfec76f57fbd9f1ae645c7c9c607db5c8352fb7041ca97111e3b0f142dafc1028832acbbc14ba1d70\")\n\trequire.NoError(t, err)\n\tactualDigest, err := bufmodule.ParseDigest(\"b5:975dad3641303843fb6a06eedf038b0e6ff41da82b8a483920afb36011e0b0a24f720a2407f5e0783389530486ff410b7e132f219add69a5c7324d54f6f89a6c\")\n\trequire.NoError(t, err)\n\tdigestMismatchError := &bufmodule.DigestMismatchError{\n\t\tFullName: moduleFullName,\n\t\tCommitID: commitID,\n\t\tExpectedDigest: expectedDigest,\n\t\tActualDigest: actualDigest,\n\t}\n\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(use string) *appcmd.Command { return newRootCommand(use) },\n\t\tappcmdtesting.WithExpectedExitCode(1),\n\t\tappcmdtesting.WithExpectedStderr(appFailureError(digestMismatchError).Error()),\n\t\tappcmdtesting.WithEnv(\n\t\t\tfunc(use string) map[string]string {\n\t\t\t\treturn map[string]string{\n\t\t\t\t\tuseEnvVar(use, \"CACHE_DIR\"): filepath.Join(\"testdata\", \"imports\", \"corrupted_cache_dep\"),\n\t\t\t\t}\n\t\t\t},\n\t\t),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"build\",\n\t\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"school\"),\n\t\t\t\"--no-warn\",\n\t\t),\n\t)\n}\n\nfunc TestValidImportTransitiveFromCache(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrWithCache(\n\t\tt, nil, 0,\n\t\t\"\",\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"school\"),\n\t)\n}\n\nfunc TestValidImportWKT(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderr(\n\t\tt, nil, 0,\n\t\t\"\", // no warnings\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"wkt\"),\n\t)\n}\n\nfunc TestInvalidNonexistentImport(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrWithCache(\n\t\tt, nil, bufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/imports/failure/people/people/v1/people1.proto:5:8:import \"nonexistent.proto\": file does not exist`),\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"failure\", \"people\"),\n\t)\n}\n\nfunc TestInvalidNonexistentImportFromDirectDep(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrWithCache(\n\t\tt, nil, bufctl.ExitCodeFileAnnotation,\n\t\tfilepath.FromSlash(`testdata/imports/failure/students/students/v1/students.proto:`)+`6:8:import \"people/v1/people_nonexistent.proto\": file does not exist`,\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"failure\", \"students\"),\n\t)\n}\n\nfunc TestInvalidImportFromTransitive(t *testing.T) {\n\tt.Parallel()\n\t// We actually want to verify that there are no warnings now. Transitive dependencies not declared\n\t// in your buf.yaml are acceptable now.\n\ttestRunStderrContainsWithCache(\n\t\tt, nil, 0,\n\t\t[]string{\n\t\t\t`WARN`,\n\t\t\t`File \"school/v1/school1.proto\" imports \"people/v1/people1.proto\", which is not in your workspace or in the dependencies declared in your buf.yaml`,\n\t\t\t`File \"school/v1/school1.proto\" imports \"people/v1/people2.proto\", which is not in your workspace or in the dependencies declared in your buf.yaml`,\n\t\t},\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"failure\", \"school\"),\n\t)\n}\n\nfunc TestInvalidImportFromTransitiveWorkspace(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderrWithCache(\n\t\tt, nil, 0,\n\t\t// We actually want to verify that there are no warnings now. deps in your v1 buf.yaml may actually\n\t\t// have an effect - they can affect your buf.lock.\n\t\t\"\",\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"failure\", \"workspace\", \"transitive_imports\"),\n\t)\n}\n\nfunc TestValidImportFromLocalOnlyWorkspaceUnnamedModules(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderr(\n\t\tt, nil, 0,\n\t\t\"\", // no warnings\n\t\t\"build\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"workspace\", \"unnamed_local_only_modules\"),\n\t)\n}\n\nfunc TestGraphNoWarningsValidImportFromWorkspaceNamedModules(t *testing.T) {\n\tt.Parallel()\n\ttestRunStderr(\n\t\tt, nil, 0,\n\t\t\"\", // no warnings\n\t\t\"dep\",\n\t\t\"graph\",\n\t\tfilepath.Join(\"testdata\", \"imports\", \"success\", \"workspace\", \"valid_explicit_deps\"),\n\t)\n}\n\nfunc testRunStderrWithCache(t *testing.T, stdin io.Reader, expectedExitCode int, expectedStderr string, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(use string) *appcmd.Command { return newRootCommand(use) },\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStderr(expectedStderr),\n\t\tappcmdtesting.WithEnv(\n\t\t\tfunc(use string) map[string]string {\n\t\t\t\treturn map[string]string{\n\t\t\t\t\tuseEnvVar(use, \"CACHE_DIR\"): filepath.Join(\"testdata\", \"imports\", \"cache\"),\n\t\t\t\t}\n\t\t\t},\n\t\t),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n\nfunc testRunStderrContainsWithCache(t *testing.T, stdin io.Reader, expectedExitCode int, expectedStderrPartials []string, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(use string) *appcmd.Command { return newRootCommand(use) },\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStderrPartials(expectedStderrPartials...),\n\t\tappcmdtesting.WithEnv(\n\t\t\tfunc(use string) map[string]string {\n\t\t\t\treturn map[string]string{\n\t\t\t\t\tuseEnvVar(use, \"CACHE_DIR\"): filepath.Join(\"testdata\", \"imports\", \"cache\"),\n\t\t\t\t}\n\t\t\t},\n\t\t),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n\nfunc useEnvVar(use string, suffix string) string {\n\treturn strings.ToUpper(use) + \"_\" + suffix\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/const_unix.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// Matching the unix-like build tags in the Golang source i.e. https://github.com/golang/go/blob/912f0750472dd4f674b69ca1616bfaf377af1805/src/os/file_unix.go#L6\n\n//go:build aix || darwin || dragonfly || freebsd || (js && wasm) || linux || netbsd || openbsd || solaris\n\npackage protoc\n\n// https://github.com/protocolbuffers/protobuf/blob/336ed1820a4f2649c9aa3953d5059b03b7a77100/src/google/protobuf/compiler/command_line_interface.cc#L892-L896\n//\n// This will be \":\" for all unix-like platforms including darwin.\n// This will be \";\" for windows.\nconst includeDirPathSeparator = \":\"\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/const_windows.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n//go:build windows\n\npackage protoc\n\n// https://github.com/protocolbuffers/protobuf/blob/336ed1820a4f2649c9aa3953d5059b03b7a77100/src/google/protobuf/compiler/command_line_interface.cc#L892-L896\n//\n// This will be \":\" for all unix-like platforms including darwin.\n// This will be \";\" for windows.\nconst includeDirPathSeparator = \";\"\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/errors.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage protoc\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n)\n\nvar (\n\terrNoInputFiles = errors.New(\"no input files specified\")\n\terrArgEmpty = errors.New(\"empty argument specified\")\n)\n\nfunc newCannotSpecifyOptWithoutOutError(pluginName string) error {\n\treturn fmt.Errorf(\"cannot specify --%s_opt without --%s_out\", pluginName, pluginName)\n}\n\nfunc newCannotSpecifyPathWithoutOutError(pluginName string) error {\n\treturn fmt.Errorf(\"cannot specify --%s=protoc-gen-%s without --%s_out\", pluginPathValuesFlagName, pluginName, pluginName)\n}\n\nfunc newRecursiveReferenceError(flagFilePath string) error {\n\treturn fmt.Errorf(\"%s recursively referenced\", flagFilePath)\n}\n\nfunc newDuplicateOutError(pluginName string) error {\n\treturn fmt.Errorf(\"duplicate --%s_out\", pluginName)\n}\n\nfunc newEmptyOptError(pluginName string) error {\n\treturn fmt.Errorf(\"empty option value for %s\", pluginName)\n}\n\nfunc newPluginPathValueEmptyError() error {\n\treturn fmt.Errorf(\"--%s had an empty value\", pluginPathValuesFlagName)\n}\n\nfunc newPluginPathValueInvalidError(pluginPathValue string) error {\n\treturn fmt.Errorf(\"--%s value invalid: %s\", pluginPathValuesFlagName, pluginPathValue)\n}\n\nfunc newPluginPathNameInvalidPrefixError(pluginName string) error {\n\treturn fmt.Errorf(`--%s had name %q which must be prefixed by \"protoc-gen-\"`, pluginPathValuesFlagName, pluginName)\n}\n\nfunc newDuplicatePluginPathError(pluginName string) error {\n\treturn fmt.Errorf(\"duplicate --%s for protoc-gen-%s\", pluginPathValuesFlagName, pluginName)\n}\n\nfunc newEncodeNotSupportedError() error {\n\treturn fmt.Errorf(\n\t\t`--%s is not supported by buf.\n\nBuf only handles the binary and JSON formats for now, however we can support this flag if there is sufficient demand.\nPlease email us at support@buf.build if this is a need for your organization.`,\n\t\tencodeFlagName,\n\t)\n}\n\nfunc newDecodeNotSupportedError() error {\n\treturn fmt.Errorf(\n\t\t`--%s is not supported by buf.\n\nBuf only handles the binary and JSON formats for now, however we can support this flag if there is sufficient demand.\nPlease email us at support@buf.build if this is a need for your organization.`,\n\t\tdecodeFlagName,\n\t)\n}\n\nfunc newDecodeRawNotSupportedError() error {\n\treturn fmt.Errorf(\n\t\t`--%s is not supported by buf.\n\nBuf only handles the binary and JSON formats for now, however we can support this flag if there is sufficient demand.\nPlease email us at support@buf.build if this is a need for your organization.`,\n\t\tdecodeRawFlagName,\n\t)\n}\n\nfunc newDescriptorSetInNotSupportedError() error {\n\treturn fmt.Errorf(\n\t\t`--%s is not supported by buf.\n\nBuf will work with cross-repository imports Buf Schema Registry, which will be based on source files, not pre-built Images.\nWe think this is a much safer option that leads to less errors and more consistent results.\n\nPlease email us at support@buf.build if this is a need for your organization.`,\n\t\tdescriptorSetInFlagName,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/flags.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage protoc\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"sort\"\n\t\"strings\"\n\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/buffetch\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/pkg/normalpath\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tincludeDirPathsFlagName = \"proto_path\"\n\tincludeImportsFlagName = \"include_imports\"\n\tincludeSourceInfoFlagName = \"include_source_info\"\n\tprintFreeFieldNumbersFlagName = \"print_free_field_numbers\"\n\toutputFlagName = \"descriptor_set_out\"\n\tpluginPathValuesFlagName = \"plugin\"\n\terrorFormatFlagName = \"error_format\"\n\tbyDirFlagName = \"by-dir\"\n\n\tpluginFakeFlagName = \"protoc_plugin_fake\"\n\n\tencodeFlagName = \"encode\"\n\tdecodeFlagName = \"decode\"\n\tdecodeRawFlagName = \"decode_raw\"\n\tdescriptorSetInFlagName = \"descriptor_set_in\"\n)\n\nvar (\n\tdefaultIncludeDirPaths = []string{\".\"}\n\tdefaultErrorFormat = \"gcc\"\n)\n\ntype flags struct {\n\tIncludeDirPaths []string\n\tIncludeImports bool\n\tIncludeSourceInfo bool\n\tPrintFreeFieldNumbers bool\n\tOutput string\n\tErrorFormat string\n\tByDir bool\n}\n\ntype env struct {\n\tflags\n\n\tPluginNamesSortedByOutIndex []string\n\tPluginNameToPluginInfo map[string]*pluginInfo\n\tFilePaths []string\n}\n\ntype flagsBuilder struct {\n\tflags\n\n\tPluginPathValues []string\n\n\tEncode string\n\tDecode string\n\tDecodeRaw bool\n\tDescriptorSetIn []string\n\n\tpluginFake []string\n\tpluginNameToValue map[string]*pluginValue\n}\n\nfunc newFlagsBuilder() *flagsBuilder {\n\treturn &flagsBuilder{\n\t\tpluginNameToValue: make(map[string]*pluginValue),\n\t}\n}\n\nfunc (f *flagsBuilder) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringSliceVarP(\n\t\t&f.IncludeDirPaths,\n\t\tincludeDirPathsFlagName,\n\t\t\"I\",\n\t\t// cannot set default due to recursive flag parsing\n\t\t// no way to differentiate between default and set for now\n\t\t// perhaps we could rework pflag usage somehow\n\t\tnil,\n\t\t`The directory paths to include.`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.IncludeImports,\n\t\tincludeImportsFlagName,\n\t\tfalse,\n\t\t`Include imports in the resulting FileDescriptorSet.`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.IncludeSourceInfo,\n\t\tincludeSourceInfoFlagName,\n\t\tfalse,\n\t\t`Include source info in the resulting FileDescriptorSet.`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.PrintFreeFieldNumbers,\n\t\tprintFreeFieldNumbersFlagName,\n\t\tfalse,\n\t\t`Print the free field numbers of all messages.`,\n\t)\n\tflagSet.StringVarP(\n\t\t&f.Output,\n\t\toutputFlagName,\n\t\t\"o\",\n\t\t\"\",\n\t\tfmt.Sprintf(\n\t\t\t`The location to write the FileDescriptorSet. Must be one of format %s.`,\n\t\t\tbuffetch.MessageFormatsString,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t// cannot set default due to recursive flag parsing\n\t\t// no way to differentiate between default and set for now\n\t\t// perhaps we could rework pflag usage somehow\n\t\t\"\",\n\t\tfmt.Sprintf(\n\t\t\t`The error format to use. Must be one of format %s.`,\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStringsWithAliases),\n\t\t),\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.PluginPathValues,\n\t\tpluginPathValuesFlagName,\n\t\tnil,\n\t\t`The paths to the plugin executables to use, either in the form \"path/to/protoc-gen-foo\" or \"protoc-gen-foo=path/to/binary\".`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.ByDir,\n\t\tbyDirFlagName,\n\t\tfalse,\n\t\t`Execute parallel plugin calls for every directory containing .proto files.`,\n\t)\n\n\t// MUST be a StringArray instead of StringSlice so we do not split on commas\n\t// Otherwise --go_out=foo=bar,baz=bat:out would be treated as --go_out=foo=bar --go_out=baz=bat:out\n\tflagSet.StringArrayVar(\n\t\t&f.pluginFake,\n\t\tpluginFakeFlagName,\n\t\tnil,\n\t\t`If you are calling this, you should not be.`,\n\t)\n\t_ = flagSet.MarkHidden(pluginFakeFlagName)\n\n\tflagSet.StringVar(\n\t\t&f.Encode,\n\t\tencodeFlagName,\n\t\t\"\",\n\t\t`Not supported by buf.`,\n\t)\n\t_ = flagSet.MarkHidden(encodeFlagName)\n\tflagSet.StringVar(\n\t\t&f.Decode,\n\t\tdecodeFlagName,\n\t\t\"\",\n\t\t`Not supported by buf.`,\n\t)\n\t_ = flagSet.MarkHidden(decodeFlagName)\n\tflagSet.BoolVar(\n\t\t&f.DecodeRaw,\n\t\tdecodeRawFlagName,\n\t\tfalse,\n\t\t`Not supported by buf.`,\n\t)\n\t_ = flagSet.MarkHidden(decodeRawFlagName)\n\tflagSet.StringSliceVar(\n\t\t&f.DescriptorSetIn,\n\t\tdescriptorSetInFlagName,\n\t\tnil,\n\t\t`Not supported by buf.`,\n\t)\n\t_ = flagSet.MarkHidden(descriptorSetInFlagName)\n}\n\nfunc (f *flagsBuilder) Normalize(flagSet *pflag.FlagSet, name string) string {\n\tif name != \"descriptor_set_out\" && strings.HasSuffix(name, \"_out\") {\n\t\tf.pluginFakeParse(name, \"_out\", true)\n\t\treturn pluginFakeFlagName\n\t}\n\tif strings.HasSuffix(name, \"_opt\") {\n\t\tf.pluginFakeParse(name, \"_opt\", false)\n\t\treturn pluginFakeFlagName\n\t}\n\treturn strings.ReplaceAll(name, \"-\", \"_\")\n}\n\nfunc (f *flagsBuilder) Build(args []string) (*env, error) {\n\tpluginNameToPluginInfo := make(map[string]*pluginInfo)\n\tseenFlagFilePaths := make(map[string]struct{})\n\tfilePaths, err := f.buildRec(args, pluginNameToPluginInfo, seenFlagFilePaths)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif err := f.checkUnsupported(); err != nil {\n\t\treturn nil, err\n\t}\n\tfor pluginName, pluginInfo := range pluginNameToPluginInfo {\n\t\tif pluginInfo.Out == \"\" && len(pluginInfo.Opt) > 0 {\n\t\t\treturn nil, newCannotSpecifyOptWithoutOutError(pluginName)\n\t\t}\n\t\tif pluginInfo.Out == \"\" && pluginInfo.Path != \"\" {\n\t\t\treturn nil, newCannotSpecifyPathWithoutOutError(pluginName)\n\t\t}\n\t}\n\tpluginNamesSortedByOutIndex, err := f.getPluginNamesSortedByOutIndex(pluginNameToPluginInfo)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif len(f.IncludeDirPaths) == 0 {\n\t\tf.IncludeDirPaths = defaultIncludeDirPaths\n\t} else {\n\t\tf.IncludeDirPaths = splitIncludeDirPaths(f.IncludeDirPaths)\n\t}\n\tif f.ErrorFormat == \"\" {\n\t\tf.ErrorFormat = defaultErrorFormat\n\t}\n\tif len(filePaths) == 0 {\n\t\treturn nil, errNoInputFiles\n\t}\n\treturn &env{\n\t\tflags: f.flags,\n\t\tPluginNamesSortedByOutIndex: pluginNamesSortedByOutIndex,\n\t\tPluginNameToPluginInfo: pluginNameToPluginInfo,\n\t\tFilePaths: filePaths,\n\t}, nil\n}\n\nfunc (f *flagsBuilder) pluginFakeParse(name string, suffix string, isOut bool) {\n\tpluginName := strings.TrimSuffix(name, suffix)\n\tpluginValue, ok := f.pluginNameToValue[pluginName]\n\tif !ok {\n\t\tpluginValue = newPluginValue()\n\t\tf.pluginNameToValue[pluginName] = pluginValue\n\t}\n\tindex := len(f.pluginFake)\n\tif isOut {\n\t\tpluginValue.OutIndexes = append(pluginValue.OutIndexes, index)\n\t} else {\n\t\tpluginValue.OptIndexes = append(pluginValue.OptIndexes, index)\n\t}\n}\n\nfunc (f *flagsBuilder) buildRec(\n\targs []string,\n\tpluginNameToPluginInfo map[string]*pluginInfo,\n\tseenFlagFilePaths map[string]struct{},\n) ([]string, error) {\n\tif err := f.parsePluginNameToPluginInfo(pluginNameToPluginInfo); err != nil {\n\t\treturn nil, err\n\t}\n\tfilePaths := make([]string, 0, len(args))\n\tfor _, arg := range args {\n\t\tif len(arg) == 0 {\n\t\t\treturn nil, errArgEmpty\n\t\t}\n\t\tif arg[0] != '@' {\n\t\t\tfilePaths = append(filePaths, arg)\n\t\t} else {\n\t\t\tflagFilePath := normalpath.Unnormalize(arg[1:])\n\t\t\tif _, ok := seenFlagFilePaths[flagFilePath]; ok {\n\t\t\t\treturn nil, newRecursiveReferenceError(flagFilePath)\n\t\t\t}\n\t\t\tseenFlagFilePaths[flagFilePath] = struct{}{}\n\t\t\tdata, err := os.ReadFile(flagFilePath)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tvar flagFilePathArgs []string\n\t\t\tfor flagFilePathArg := range strings.SplitSeq(string(data), \"\\n\") {\n\t\t\t\tflagFilePathArg = strings.TrimSpace(flagFilePathArg)\n\t\t\t\tif flagFilePathArg != \"\" {\n\t\t\t\t\tflagFilePathArgs = append(flagFilePathArgs, flagFilePathArg)\n\t\t\t\t}\n\t\t\t}\n\t\t\tsubFlagsBuilder := newFlagsBuilder()\n\t\t\tflagSet := pflag.NewFlagSet(flagFilePath, pflag.ContinueOnError)\n\t\t\tsubFlagsBuilder.Bind(flagSet)\n\t\t\tflagSet.SetNormalizeFunc(normalizeFunc(subFlagsBuilder.Normalize))\n\t\t\tif err := flagSet.Parse(flagFilePathArgs); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tsubFilePaths, err := subFlagsBuilder.buildRec(\n\t\t\t\tflagSet.Args(),\n\t\t\t\tpluginNameToPluginInfo,\n\t\t\t\tseenFlagFilePaths,\n\t\t\t)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tif err := f.merge(subFlagsBuilder); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tfilePaths = append(filePaths, subFilePaths...)\n\t\t}\n\t}\n\treturn filePaths, nil\n}\n\n// we need to bind a separate flags as pflags overrides the values with defaults if you bind again\n// note that pflags does not error on duplicates so we do not either\nfunc (f *flagsBuilder) merge(subFlagsBuilder *flagsBuilder) error {\n\tf.IncludeDirPaths = append(f.IncludeDirPaths, subFlagsBuilder.IncludeDirPaths...)\n\tif subFlagsBuilder.IncludeImports {\n\t\tf.IncludeImports = true\n\t}\n\tif subFlagsBuilder.IncludeSourceInfo {\n\t\tf.IncludeSourceInfo = true\n\t}\n\tif subFlagsBuilder.PrintFreeFieldNumbers {\n\t\tf.PrintFreeFieldNumbers = true\n\t}\n\tif subFlagsBuilder.Output != \"\" {\n\t\tf.Output = subFlagsBuilder.Output\n\t}\n\tif subFlagsBuilder.ErrorFormat != \"\" {\n\t\tf.ErrorFormat = subFlagsBuilder.ErrorFormat\n\t}\n\tif subFlagsBuilder.ByDir {\n\t\tf.ByDir = true\n\t}\n\tf.PluginPathValues = append(f.PluginPathValues, subFlagsBuilder.PluginPathValues...)\n\tif subFlagsBuilder.Encode != \"\" {\n\t\tf.Encode = subFlagsBuilder.Encode\n\t}\n\tif subFlagsBuilder.Decode != \"\" {\n\t\tf.Decode = subFlagsBuilder.Decode\n\t}\n\tif subFlagsBuilder.DecodeRaw {\n\t\tf.DecodeRaw = true\n\t}\n\tf.DescriptorSetIn = append(f.DescriptorSetIn, subFlagsBuilder.DescriptorSetIn...)\n\treturn nil\n}\n\nfunc (f *flagsBuilder) parsePluginNameToPluginInfo(pluginNameToPluginInfo map[string]*pluginInfo) error {\n\tfor pluginName, pluginValue := range f.pluginNameToValue {\n\t\tswitch len(pluginValue.OutIndexes) {\n\t\tcase 0:\n\t\tcase 1:\n\t\t\tout := f.pluginFake[pluginValue.OutIndexes[0]]\n\t\t\tvar opt string\n\t\t\tif isOutNotAFullPath(out) {\n\t\t\t\tsplit := strings.SplitN(out, \":\", 2)\n\t\t\t\tswitch len(split) {\n\t\t\t\tcase 1:\n\t\t\t\tcase 2:\n\t\t\t\t\tout = split[1]\n\t\t\t\t\topt = split[0]\n\t\t\t\t}\n\t\t\t}\n\t\t\tpluginInfo, ok := pluginNameToPluginInfo[pluginName]\n\t\t\tif !ok {\n\t\t\t\tpluginInfo = newPluginInfo()\n\t\t\t\tpluginNameToPluginInfo[pluginName] = pluginInfo\n\t\t\t}\n\t\t\tpluginInfo.Out = out\n\t\t\tif opt != \"\" {\n\t\t\t\tfor value := range strings.SplitSeq(opt, \",\") {\n\t\t\t\t\tif value := strings.TrimSpace(value); value != \"\" {\n\t\t\t\t\t\tpluginInfo.Opt = append(pluginInfo.Opt, value)\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn newEmptyOptError(pluginName)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\tdefault:\n\t\t\treturn newDuplicateOutError(pluginName)\n\t\t}\n\t\tif len(pluginValue.OptIndexes) > 0 {\n\t\t\tpluginInfo, ok := pluginNameToPluginInfo[pluginName]\n\t\t\tif !ok {\n\t\t\t\tpluginInfo = newPluginInfo()\n\t\t\t\tpluginNameToPluginInfo[pluginName] = pluginInfo\n\t\t\t}\n\t\t\tfor _, optIndex := range pluginValue.OptIndexes {\n\t\t\t\tfor value := range strings.SplitSeq(f.pluginFake[optIndex], \",\") {\n\t\t\t\t\tif value := strings.TrimSpace(value); value != \"\" {\n\t\t\t\t\t\tpluginInfo.Opt = append(pluginInfo.Opt, value)\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn newEmptyOptError(pluginName)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\tfor _, pluginPathValue := range f.PluginPathValues {\n\t\tvar pluginName string\n\t\tvar pluginPath string\n\t\tswitch split := strings.SplitN(pluginPathValue, \"=\", 2); len(split) {\n\t\tcase 0:\n\t\t\treturn newPluginPathValueEmptyError()\n\t\tcase 1:\n\t\t\tpluginName = filepath.Base(split[0])\n\t\t\tpluginPath = split[0]\n\t\tcase 2:\n\t\t\tpluginName = split[0]\n\t\t\tpluginPath = split[1]\n\t\tdefault:\n\t\t\treturn newPluginPathValueInvalidError(pluginPathValue)\n\t\t}\n\t\tif !strings.HasPrefix(pluginName, \"protoc-gen-\") {\n\t\t\treturn newPluginPathNameInvalidPrefixError(pluginName)\n\t\t}\n\t\tpluginName = strings.TrimPrefix(pluginName, \"protoc-gen-\")\n\t\tpluginInfo, ok := pluginNameToPluginInfo[pluginName]\n\t\tif !ok {\n\t\t\tpluginInfo = newPluginInfo()\n\t\t\tpluginNameToPluginInfo[pluginName] = pluginInfo\n\t\t}\n\t\tif pluginInfo.Path != \"\" {\n\t\t\treturn newDuplicatePluginPathError(pluginName)\n\t\t}\n\t\tpluginInfo.Path = pluginPath\n\t}\n\treturn nil\n}\n\nfunc (f *flagsBuilder) getPluginNamesSortedByOutIndex(\n\tpluginNameToPluginInfo map[string]*pluginInfo,\n) ([]string, error) {\n\tpluginNames := make([]string, 0, len(pluginNameToPluginInfo))\n\tfor pluginName := range pluginNameToPluginInfo {\n\t\tpluginNames = append(pluginNames, pluginName)\n\t}\n\tvar err error\n\tsort.Slice(\n\t\tpluginNames,\n\t\tfunc(i int, j int) bool {\n\t\t\tpluginName1 := pluginNames[i]\n\t\t\tpluginName2 := pluginNames[j]\n\t\t\tpluginValue1, ok := f.pluginNameToValue[pluginName1]\n\t\t\tif !ok {\n\t\t\t\terr = fmt.Errorf(\"no value for plugin name %q inside pluginNameToValue\", pluginName1)\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tpluginValue2, ok := f.pluginNameToValue[pluginName2]\n\t\t\tif !ok {\n\t\t\t\terr = fmt.Errorf(\"no value for plugin name %q inside pluginNameToValue\", pluginName2)\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif len(pluginValue1.OutIndexes) != 1 {\n\t\t\t\terr = fmt.Errorf(\"%d out indexes for plugin name %q\", len(pluginValue1.OutIndexes), pluginName1)\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif len(pluginValue2.OutIndexes) != 1 {\n\t\t\t\terr = fmt.Errorf(\"%d out indexes for plugin name %q\", len(pluginValue2.OutIndexes), pluginName2)\n\t\t\t\treturn false\n\t\t\t}\n\t\t\treturn pluginValue1.OutIndexes[0] < pluginValue2.OutIndexes[0]\n\t\t},\n\t)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn pluginNames, nil\n}\n\nfunc (f *flagsBuilder) checkUnsupported() error {\n\tif f.Encode != \"\" {\n\t\treturn newEncodeNotSupportedError()\n\t}\n\tif f.Decode != \"\" {\n\t\treturn newDecodeNotSupportedError()\n\t}\n\tif f.DecodeRaw {\n\t\treturn newDecodeRawNotSupportedError()\n\t}\n\tif len(f.DescriptorSetIn) > 0 {\n\t\treturn newDescriptorSetInNotSupportedError()\n\t}\n\treturn nil\n}\n\ntype pluginValue struct {\n\tOutIndexes []int\n\tOptIndexes []int\n}\n\nfunc newPluginValue() *pluginValue {\n\treturn &pluginValue{}\n}\n\nfunc normalizeFunc(f func(*pflag.FlagSet, string) string) func(*pflag.FlagSet, string) pflag.NormalizedName {\n\treturn func(flagSet *pflag.FlagSet, name string) pflag.NormalizedName {\n\t\treturn pflag.NormalizedName(f(flagSet, name))\n\t}\n}\n\n// https://github.com/protocolbuffers/protobuf/blob/336ed1820a4f2649c9aa3953d5059b03b7a77100/src/google/protobuf/compiler/command_line_interface.cc#L1699-L1705\n//\n// This roughly supports the equivalent of Java's -classpath flag.\n// Note that for filenames such as \"foo:bar\" on unix, this breaks, but our goal is to match\n// this flag from protoc.\nfunc splitIncludeDirPaths(includeDirPaths []string) []string {\n\tcopyIncludeDirPaths := make([]string, 0, len(includeDirPaths))\n\tfor _, includeDirPath := range includeDirPaths {\n\t\t// protocolbuffers/protobuf has true for omit_empty\n\t\tfor splitIncludeDirPath := range strings.SplitSeq(includeDirPath, includeDirPathSeparator) {\n\t\t\tif len(splitIncludeDirPath) > 0 {\n\t\t\t\tcopyIncludeDirPaths = append(copyIncludeDirPaths, splitIncludeDirPath)\n\t\t\t}\n\t\t}\n\t}\n\treturn copyIncludeDirPaths\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/flags_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage protoc\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/spf13/pflag\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestParseFlags(t *testing.T) {\n\tt.Parallel()\n\tabsFilePath, err := filepath.Abs(\"out\")\n\trequire.NoError(t, err)\n\ttestCases := []struct {\n\t\tArgs []string\n\t\tExpected *env\n\t\tExpectedError error\n\t}{\n\t\t{\n\t\t\tExpectedError: errNoInputFiles,\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: defaultIncludeDirPaths,\n\t\t\t\t\tErrorFormat: defaultErrorFormat,\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"plugins=connect:go_out\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\"plugins=connect\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"go_out\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"plugins=connect\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\"plugins=connect\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"go_out\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"plugins=connect\",\n\t\t\t\t\"--plugin\",\n\t\t\t\t\"/bin/protoc-gen-go\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\"plugins=connect\"},\n\t\t\t\t\t\tPath: \"/bin/protoc-gen-go\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"go_out\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"plugins=connect\",\n\t\t\t\t\"--plugin\",\n\t\t\t\t\"protoc-gen-go=/bin/foo\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\"plugins=connect\"},\n\t\t\t\t\t\tPath: \"/bin/foo\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"@\" + filepath.Join(\"testdata\", \"1\", \"flags.txt\"),\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\"plugins=connect\"},\n\t\t\t\t\t\tPath: \"/bin/protoc-gen-go\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"@\" + filepath.Join(\"testdata\", \"2\", \"flags1.txt\"),\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\"plugins=connect\"},\n\t\t\t\t\t\tPath: \"/bin/protoc-gen-go\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"@\" + filepath.Join(\"testdata\", \"3\", \"flags1.txt\"),\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpectedError: newRecursiveReferenceError(filepath.Join(\"testdata\", \"3\", \"flags1.txt\")),\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"plugins=connect:go_out\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"foo=bar\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\n\t\t\t\t\t\t\t\"plugins=connect\",\n\t\t\t\t\t\t\t\"foo=bar\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"plugins=connect:go_out\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"foo=bar\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"baz=bat\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\n\t\t\t\t\t\t\t\"plugins=connect\",\n\t\t\t\t\t\t\t\"foo=bar\",\n\t\t\t\t\t\t\t\"baz=bat\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"go_out\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"foo=bar\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"baz=bat\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\n\t\t\t\t\t\t\t\"foo=bar\",\n\t\t\t\t\t\t\t\"baz=bat\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"--error_format\",\n\t\t\t\t\"text\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"foo=bar,baz=bat:go_out\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"one=two,three=four\",\n\t\t\t\t\"--go_opt\",\n\t\t\t\t\"five=six\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"text\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: \"go_out\",\n\t\t\t\t\t\tOpt: []string{\n\t\t\t\t\t\t\t\"foo=bar\",\n\t\t\t\t\t\t\t\"baz=bat\",\n\t\t\t\t\t\t\t\"one=two\",\n\t\t\t\t\t\t\t\"three=four\",\n\t\t\t\t\t\t\t\"five=six\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"go_out\",\n\t\t\t\t\"--go_out\",\n\t\t\t\t\"go_out\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpectedError: newDuplicateOutError(\"go\"),\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"--foo_out=foo\",\n\t\t\t\t\"--bar_out=bar\",\n\t\t\t\t\"--baz_out=baz\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: defaultIncludeDirPaths,\n\t\t\t\t\tErrorFormat: defaultErrorFormat,\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"foo\",\n\t\t\t\t\t\"bar\",\n\t\t\t\t\t\"baz\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"foo\": {\n\t\t\t\t\t\tOut: \"foo\",\n\t\t\t\t\t},\n\t\t\t\t\t\"bar\": {\n\t\t\t\t\t\tOut: \"bar\",\n\t\t\t\t\t},\n\t\t\t\t\t\"baz\": {\n\t\t\t\t\t\tOut: \"baz\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"foo\" + includeDirPathSeparator + \"bar\" + includeDirPathSeparator + \"baz\",\n\t\t\t\t\"-I\",\n\t\t\t\t\"bat\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"foo\",\n\t\t\t\t\t\t\"bar\",\n\t\t\t\t\t\t\"baz\",\n\t\t\t\t\t\t\"bat\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: defaultErrorFormat,\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"foo\" + includeDirPathSeparator + includeDirPathSeparator + \"baz\",\n\t\t\t\t\"-I\",\n\t\t\t\t\"bat\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"foo\",\n\t\t\t\t\t\t\"baz\",\n\t\t\t\t\t\t\"bat\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: defaultErrorFormat,\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"foo\" + includeDirPathSeparator + \"bar\" + includeDirPathSeparator,\n\t\t\t\t\"-I\",\n\t\t\t\t\"bat\",\n\t\t\t\t\"foo.proto\",\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"foo\",\n\t\t\t\t\t\t\"bar\",\n\t\t\t\t\t\t\"bat\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: defaultErrorFormat,\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"foo.proto\",\n\t\t\t\tfmt.Sprintf(\"--go_out=%s\", absFilePath),\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"gcc\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: absFilePath,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tArgs: []string{\n\t\t\t\t\"-I\",\n\t\t\t\t\"proto\",\n\t\t\t\t\"foo.proto\",\n\t\t\t\tfmt.Sprintf(\"--go_out=opt:%s\", absFilePath),\n\t\t\t},\n\t\t\tExpected: &env{\n\t\t\t\tflags: flags{\n\t\t\t\t\tIncludeDirPaths: []string{\n\t\t\t\t\t\t\"proto\",\n\t\t\t\t\t},\n\t\t\t\t\tErrorFormat: \"gcc\",\n\t\t\t\t},\n\t\t\t\tPluginNamesSortedByOutIndex: []string{\n\t\t\t\t\t\"go\",\n\t\t\t\t},\n\t\t\t\tPluginNameToPluginInfo: map[string]*pluginInfo{\n\t\t\t\t\t\"go\": {\n\t\t\t\t\t\tOut: absFilePath,\n\t\t\t\t\t\tOpt: []string{\"opt\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tFilePaths: []string{\n\t\t\t\t\t\"foo.proto\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\tfor i, testCase := range testCases {\n\t\tname := fmt.Sprintf(\"%d\", i)\n\t\tt.Run(name, func(t *testing.T) {\n\t\t\tt.Parallel()\n\t\t\tenv, err := testParseFlags(name, testCase.Args)\n\t\t\tif testCase.ExpectedError != nil {\n\t\t\t\tassert.Equal(t, testCase.ExpectedError, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\tif env != nil {\n\t\t\t\t\t// testify counts nil and empty as different\n\t\t\t\t\t// we do not want to have to set empty values in our expected env\n\t\t\t\t\t// so we set them to nil here for comparison\n\t\t\t\t\tif len(env.IncludeDirPaths) == 0 {\n\t\t\t\t\t\tenv.IncludeDirPaths = nil\n\t\t\t\t\t}\n\t\t\t\t\tif len(env.PluginNamesSortedByOutIndex) == 0 {\n\t\t\t\t\t\tenv.PluginNamesSortedByOutIndex = nil\n\t\t\t\t\t}\n\t\t\t\t\tif len(env.PluginNameToPluginInfo) == 0 {\n\t\t\t\t\t\tenv.PluginNameToPluginInfo = nil\n\t\t\t\t\t}\n\t\t\t\t\tif len(env.FilePaths) == 0 {\n\t\t\t\t\t\tenv.FilePaths = nil\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tassert.Equal(t, testCase.Expected, env)\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc testParseFlags(name string, args []string) (*env, error) {\n\tflagsBuilder := newFlagsBuilder()\n\tflagSet := pflag.NewFlagSet(name, pflag.ContinueOnError)\n\tflagsBuilder.Bind(flagSet)\n\tflagSet.SetNormalizeFunc(normalizeFunc(flagsBuilder.Normalize))\n\tif err := flagSet.Parse(args); err != nil {\n\t\treturn nil, err\n\t}\n\treturn flagsBuilder.Build(flagSet.Args())\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/flags_unix.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n//go:build aix || darwin || dragonfly || freebsd || (js && wasm) || linux || netbsd || openbsd || solaris\n\npackage protoc\n\n// isOutNotAFullPath checks if we need to consider the path to be a full path.\n//\n// This is always true in unix, and is true if the path is not absolute in windows.\n// This is needed because i.e.:\n//\n//\t# unix\n//\t--go_out=opt:foo/bar\n//\t--go_out=foo/bar\n//\t# windows\n//\t--go_out=opt:C:\\foo\\bar\n//\t--go_out=C:\\foo\\bar\n//\n// protoc uses : in both unix and windows to separate the opt and out, but in windows,\n// if a full path is given, then we don't want it interpreted as something we should split.\nfunc isOutNotAFullPath(path string) bool {\n\treturn true\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/flags_windows.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n//go:build windows\n\npackage protoc\n\nimport (\n\t\"path/filepath\"\n)\n\n// isOutNotAFullPath checks if we need to consider the path to be a full path.\n//\n// This is always true in unix, and is true if the path is not absolute in windows.\n// This is needed because i.e.:\n//\n//\t# unix\n//\t--go_out=opt:foo/bar\n//\t--go_out=foo/bar\n//\t# windows\n//\t--go_out=opt:C:\\foo\\bar\n//\t--go_out=C:\\foo\\bar\n//\n// protoc uses : in both unix and windows to separate the opt and out, but in windows,\n// if a full path is given, then we don't want it interpreted as something we should split.\nfunc isOutNotAFullPath(path string) bool {\n\treturn !filepath.IsAbs(path)\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/internal/protoc-gen-insertion-point-receiver/main.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage main\n\nimport (\n\t\"context\"\n\n\t\"github.com/bufbuild/protoplugin\"\n\t\"google.golang.org/protobuf/proto\"\n\t\"google.golang.org/protobuf/types/pluginpb\"\n)\n\nfunc main() {\n\tprotoplugin.Main(protoplugin.HandlerFunc(handle))\n}\n\nfunc handle(\n\t_ context.Context,\n\t_ protoplugin.PluginEnv,\n\tresponseWriter protoplugin.ResponseWriter,\n\t_ protoplugin.Request,\n) error {\n\tresponseWriter.AddCodeGeneratorResponseFiles(\n\t\t&pluginpb.CodeGeneratorResponse_File{\n\t\t\tName: proto.String(\"test.txt\"),\n\t\t\tContent: proto.String(`\n\t\t// The following line represents an insertion point named 'example'.\n\t\t// We include a few indentation to verify the whitespace is preserved\n\t\t// in the inserted content.\n\t\t//\n\t\t// @@protoc_insertion_point(example)\n\t\t//\n\t\t// The 'other' insertion point is also included so that we verify\n\t\t// multiple insertion points can be written in a single invocation.\n\t\t//\n\t\t// @@protoc_insertion_point(other)\n\t\t//\n\t\t// Note that all text should be added above the insertion points.\n\t\t`),\n\t\t},\n\t)\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/internal/protoc-gen-insertion-point-writer/main.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage main\n\nimport (\n\t\"context\"\n\n\t\"github.com/bufbuild/protoplugin\"\n\t\"google.golang.org/protobuf/proto\"\n\t\"google.golang.org/protobuf/types/pluginpb\"\n)\n\nfunc main() {\n\tprotoplugin.Main(protoplugin.HandlerFunc(handle))\n}\n\nfunc handle(\n\t_ context.Context,\n\t_ protoplugin.PluginEnv,\n\tresponseWriter protoplugin.ResponseWriter,\n\t_ protoplugin.Request,\n) error {\n\tresponseWriter.AddCodeGeneratorResponseFiles(\n\t\t&pluginpb.CodeGeneratorResponse_File{\n\t\t\tName: proto.String(\"test.txt\"),\n\t\t\tInsertionPoint: proto.String(\"example\"),\n\t\t\tContent: proto.String(`\n\t\t\t// Include this comment on the 'example' insertion point.\n\t\t\t // This is another example where whitespaces are preserved.\n\t\t\t // And this demonstrates a newline literal (\\n).\n\t\t\t// And don't forget the windows newline literal (\\r\\n).\n\t\t`),\n\t\t},\n\t\t&pluginpb.CodeGeneratorResponse_File{\n\t\t\tName: proto.String(\"test.txt\"),\n\t\t\tInsertionPoint: proto.String(\"other\"),\n\t\t\tContent: proto.String(`\n\t\t\t// Include this comment on the 'other' insertion point.\n\t\t`),\n\t\t},\n\t)\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/plugin.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage protoc\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log/slog\"\n\t\"strings\"\n\n\t\"buf.build/go/app\"\n\t\"github.com/bufbuild/buf/private/buf/bufprotopluginexec\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"google.golang.org/protobuf/types/pluginpb\"\n)\n\ntype pluginInfo struct {\n\t// Required\n\tOut string\n\t// optional\n\tOpt []string\n\t// optional\n\tPath string\n}\n\nfunc newPluginInfo() *pluginInfo {\n\treturn &pluginInfo{}\n}\n\nfunc executePlugin(\n\tctx context.Context,\n\tlogger *slog.Logger,\n\tstorageosProvider storageos.Provider,\n\tcontainer app.EnvStderrContainer,\n\timages []bufimage.Image,\n\tpluginName string,\n\tpluginInfo *pluginInfo,\n) (*pluginpb.CodeGeneratorResponse, error) {\n\tgenerator := bufprotopluginexec.NewGenerator(\n\t\tlogger,\n\t\tstorageosProvider,\n\t)\n\trequests, err := bufimage.ImagesToCodeGeneratorRequests(\n\t\timages,\n\t\tstrings.Join(pluginInfo.Opt, \",\"),\n\t\tbufprotopluginexec.DefaultVersion,\n\t\tfalse,\n\t\tfalse,\n\t)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar options []bufprotopluginexec.GenerateOption\n\tif pluginInfo.Path != \"\" {\n\t\toptions = append(options, bufprotopluginexec.GenerateWithPluginPath(pluginInfo.Path))\n\t}\n\tresponse, err := generator.Generate(\n\t\tctx,\n\t\tcontainer,\n\t\tpluginName,\n\t\trequests,\n\t\toptions...,\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"--%s_out: %v\", pluginName, err)\n\t}\n\treturn response, nil\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/protoc.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage protoc\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"log/slog\"\n\t\"strings\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xlog/xslog\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/bufprotoc\"\n\t\"github.com/bufbuild/buf/private/buf/bufprotopluginexec\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage/bufimageutil\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufprotoplugin\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufprotoplugin/bufprotopluginos\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflagsBuilder := newFlagsBuilder()\n\treturn &appcmd.Command{\n\t\tUse: name + \" ...\",\n\t\tShort: \"High-performance protoc replacement\",\n\t\tLong: `This command replaces protoc using Buf's internal compiler.\n\nThe implementation is in progress. Although it outperforms mainline protoc,\nit hasn't yet been optimized.\n\nThis protoc replacement is currently stable but should be considered a preview.\n\nAdditional flags:\n\n --(.*)_out: Run the named plugin.\n --(.*)_opt: Options for the named plugin.\n @filename: Parse arguments from the given filename.`,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\tenv, err := flagsBuilder.Build(app.Args(container))\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t\treturn run(ctx, container, env)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flagsBuilder.Bind,\n\t\tNormalizeFlag: flagsBuilder.Normalize,\n\t\tVersion: fmt.Sprintf(\n\t\t\t\"%v.%v-buf\",\n\t\t\t// DefaultVersion has an extra major version that corresponds to\n\t\t\t// backwards-compatibility level of C++ runtime. The actual version\n\t\t\t// of the compiler is just the minor and patch versions.\n\t\t\tbufprotopluginexec.DefaultVersion.GetMinor(),\n\t\t\tbufprotopluginexec.DefaultVersion.GetPatch(),\n\t\t),\n\t}\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tenv *env,\n) (retErr error) {\n\tlogger := container.Logger()\n\tdefer xslog.DebugProfile(logger)()\n\n\tif env.PrintFreeFieldNumbers && len(env.PluginNameToPluginInfo) > 0 {\n\t\treturn fmt.Errorf(\"cannot call --%s and plugins at the same time\", printFreeFieldNumbersFlagName)\n\t}\n\tif env.PrintFreeFieldNumbers && env.Output != \"\" {\n\t\treturn fmt.Errorf(\"cannot call --%s and --%s at the same time\", printFreeFieldNumbersFlagName, outputFlagName)\n\t}\n\tif len(env.PluginNameToPluginInfo) > 0 && env.Output != \"\" {\n\t\treturn fmt.Errorf(\"cannot call --%s and plugins at the same time\", outputFlagName)\n\t}\n\n\tlogger.DebugContext(\n\t\tctx,\n\t\t\"env\",\n\t\tslog.Any(\"flags\", env.flags),\n\t\tslog.Any(\"plugins\", env.PluginNameToPluginInfo),\n\t)\n\n\tstorageosProvider := storageos.NewProvider(storageos.ProviderWithSymlinks())\n\tmoduleSet, err := bufprotoc.NewModuleSetForProtoc(\n\t\tctx,\n\t\tlogger,\n\t\tstorageosProvider,\n\t\tenv.IncludeDirPaths,\n\t\tenv.FilePaths,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar buildOptions []bufimage.BuildImageOption\n\t// we always need source code info if we are doing generation\n\tif len(env.PluginNameToPluginInfo) == 0 && !env.IncludeSourceInfo {\n\t\tbuildOptions = append(buildOptions, bufimage.WithExcludeSourceCodeInfo())\n\t}\n\timage, err := bufimage.BuildImage(\n\t\tctx,\n\t\tlogger,\n\t\tbufmodule.ModuleSetToModuleReadBucketWithOnlyProtoFiles(moduleSet),\n\t\tbuildOptions...,\n\t)\n\tif err != nil {\n\t\tvar fileAnnotationSet bufanalysis.FileAnnotationSet\n\t\tif errors.As(err, &fileAnnotationSet) {\n\t\t\tif err := bufanalysis.PrintFileAnnotationSet(\n\t\t\t\tcontainer.Stderr(),\n\t\t\t\tfileAnnotationSet,\n\t\t\t\tenv.ErrorFormat,\n\t\t\t); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\t// we do this even though we're in protoc compatibility mode as we just need to do non-zero\n\t\t\t// but this also makes us consistent with the rest of buf\n\t\t\treturn bufctl.ErrFileAnnotation\n\t\t}\n\t\treturn err\n\t}\n\tif env.PrintFreeFieldNumbers {\n\t\tfileInfos, err := bufmodule.GetTargetFileInfos(\n\t\t\tctx,\n\t\t\tbufmodule.ModuleSetToModuleReadBucketWithOnlyProtoFiles(\n\t\t\t\tmoduleSet,\n\t\t\t),\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tvar filePaths []string\n\t\tfor _, fileInfo := range fileInfos {\n\t\t\tfilePaths = append(filePaths, fileInfo.Path())\n\t\t}\n\t\ts, err := bufimageutil.FreeMessageRangeStrings(ctx, filePaths, image)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif _, err := container.Stdout().Write([]byte(strings.Join(s, \"\\n\") + \"\\n\")); err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t}\n\tif len(env.PluginNameToPluginInfo) > 0 {\n\t\timages := []bufimage.Image{image}\n\t\tif env.ByDir {\n\t\t\tf := func() (retErr error) {\n\t\t\t\tdefer xslog.DebugProfile(logger)()\n\t\t\t\timages, err = bufimage.ImageByDir(image)\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tif err := f(); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\tpluginResponses := make([]*bufprotoplugin.PluginResponse, 0, len(env.PluginNamesSortedByOutIndex))\n\t\tfor _, pluginName := range env.PluginNamesSortedByOutIndex {\n\t\t\tpluginInfo, ok := env.PluginNameToPluginInfo[pluginName]\n\t\t\tif !ok {\n\t\t\t\treturn fmt.Errorf(\"no value in PluginNamesToPluginInfo for %q\", pluginName)\n\t\t\t}\n\t\t\tresponse, err := executePlugin(\n\t\t\t\tctx,\n\t\t\t\tlogger,\n\t\t\t\tstorageosProvider,\n\t\t\t\tcontainer,\n\t\t\t\timages,\n\t\t\t\tpluginName,\n\t\t\t\tpluginInfo,\n\t\t\t)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tpluginResponses = append(pluginResponses, bufprotoplugin.NewPluginResponse(response, pluginName, pluginInfo.Out))\n\t\t}\n\t\tif err := bufprotoplugin.ValidatePluginResponses(pluginResponses); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tresponseWriter := bufprotopluginos.NewResponseWriter(\n\t\t\tlogger,\n\t\t\tstorageosProvider,\n\t\t)\n\t\tfor _, pluginResponse := range pluginResponses {\n\t\t\tpluginInfo, ok := env.PluginNameToPluginInfo[pluginResponse.PluginName]\n\t\t\tif !ok {\n\t\t\t\treturn fmt.Errorf(\"no value in PluginNamesToPluginInfo for %q\", pluginResponse.PluginName)\n\t\t\t}\n\t\t\tif err := responseWriter.AddResponse(\n\t\t\t\tctx,\n\t\t\t\tpluginResponse.Response,\n\t\t\t\tpluginInfo.Out,\n\t\t\t); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\tif err := responseWriter.Close(); err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t}\n\tif env.Output == \"\" {\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"required flag %q not set\", outputFlagName)\n\t}\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn controller.PutImage(\n\t\tctx,\n\t\tenv.Output,\n\t\timage,\n\t\t// Actually redundant with bufimage.BuildImageOptions right now.\n\t\tbufctl.WithImageExcludeSourceInfo(!env.IncludeSourceInfo),\n\t\tbufctl.WithImageExcludeImports(!env.IncludeImports),\n\t\tbufctl.WithImageAsFileDescriptorSet(true),\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/protoc_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage protoc\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appcmd/appcmdtesting\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xtesting\"\n\t\"github.com/bufbuild/buf/private/buf/buftesting\"\n\t\"github.com/bufbuild/buf/private/pkg/protoencoding\"\n\t\"github.com/bufbuild/buf/private/pkg/prototesting\"\n\t\"github.com/bufbuild/buf/private/pkg/storage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storagearchive\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storagemem\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n\t\"google.golang.org/protobuf/types/descriptorpb\"\n)\n\nvar buftestingDirPath = filepath.Join(\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"private\",\n\t\"buf\",\n\t\"buftesting\",\n)\n\ntype testPluginInfo struct {\n\tname string\n\topt string\n}\n\nfunc TestOverlap(t *testing.T) {\n\tt.Parallel()\n\t// https://github.com/bufbuild/buf/issues/113\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"-I\",\n\t\t\tfilepath.Join(\"testdata\", \"overlap\", \"a\"),\n\t\t\t\"-I\",\n\t\t\tfilepath.Join(\"testdata\", \"overlap\", \"b\"),\n\t\t\t\"-o\",\n\t\t\tapp.DevNullFilePath,\n\t\t\tfilepath.Join(\"testdata\", \"overlap\", \"a\", \"1.proto\"),\n\t\t\tfilepath.Join(\"testdata\", \"overlap\", \"b\", \"2.proto\"),\n\t\t),\n\t)\n}\n\nfunc TestComparePrintFreeFieldNumbersGoogleapis(t *testing.T) {\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\tfilePaths := buftesting.GetProtocFilePaths(t, googleapisDirPath, 100)\n\tactualProtocStdout := bytes.NewBuffer(nil)\n\tbuftesting.RunActualProtoc(\n\t\tt,\n\t\tfalse,\n\t\tfalse,\n\t\tgoogleapisDirPath,\n\t\tfilePaths,\n\t\tnil,\n\t\tactualProtocStdout,\n\t\tfmt.Sprintf(\"--%s\", printFreeFieldNumbersFlagName),\n\t)\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(actualProtocStdout.String()),\n\t\tappcmdtesting.WithArgs(\n\t\t\tappend(\n\t\t\t\t[]string{\n\t\t\t\t\t\"-I\",\n\t\t\t\t\tgoogleapisDirPath,\n\t\t\t\t\tfmt.Sprintf(\"--%s\", printFreeFieldNumbersFlagName),\n\t\t\t\t},\n\t\t\t\tfilePaths...,\n\t\t\t)...,\n\t\t),\n\t)\n}\n\nfunc TestCompareOutputGoogleapis(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\tfilePaths := buftesting.GetProtocFilePaths(t, googleapisDirPath, 100)\n\tactualProtocFileDescriptorSet := buftesting.GetActualProtocFileDescriptorSet(\n\t\tt,\n\t\tfalse,\n\t\tfalse,\n\t\tgoogleapisDirPath,\n\t\tfilePaths,\n\t)\n\tbufProtocFileDescriptorSet := testGetBufProtocFileDescriptorSet(t, googleapisDirPath)\n\tprototesting.AssertFileDescriptorSetsEqual(t, bufProtocFileDescriptorSet, actualProtocFileDescriptorSet)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisGo(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubs(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]testPluginInfo{\n\t\t\t{name: \"go\", opt: \"Mgoogle/api/auth.proto=foo\"},\n\t\t},\n\t)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisGoZip(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubsArchive(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]testPluginInfo{\n\t\t\t{name: \"go\", opt: \"Mgoogle/api/auth.proto=foo\"},\n\t\t},\n\t\tfalse,\n\t)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisGoJar(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubsArchive(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]testPluginInfo{\n\t\t\t{name: \"go\", opt: \"Mgoogle/api/auth.proto=foo\"},\n\t\t},\n\t\ttrue,\n\t)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisObjc(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubs(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]testPluginInfo{{name: \"objc\"}},\n\t)\n}\n\nfunc TestCompareInsertionPointOutput(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tinsertionTestdataDirPath := filepath.Join(\"testdata\", \"insertion\")\n\ttestCompareGeneratedStubs(\n\t\tt,\n\t\tinsertionTestdataDirPath,\n\t\t[]testPluginInfo{\n\t\t\t{name: \"insertion-point-receiver\"},\n\t\t\t{name: \"insertion-point-writer\"},\n\t\t},\n\t)\n}\n\nfunc TestInsertionPointMixedPathsSuccess(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\twd, err := os.Getwd()\n\trequire.NoError(t, err)\n\ttestInsertionPointMixedPathsSuccess(t, \".\", wd)\n\ttestInsertionPointMixedPathsSuccess(t, wd, \".\")\n}\n\n// testInsertionPointMixedPathsSuccess demonstrates that insertion points are able\n// to generate to the same output directory, even if the absolute path points to\n// the same place.\nfunc testInsertionPointMixedPathsSuccess(t *testing.T, receiverOut string, writerOut string) {\n\tdirPath := filepath.Join(\"testdata\", \"insertion\")\n\tfilePaths := buftesting.GetProtocFilePaths(t, dirPath, 100)\n\tprotocFlags := []string{\n\t\tfmt.Sprintf(\"--%s_out=%s\", \"insertion-point-receiver\", receiverOut),\n\t\tfmt.Sprintf(\"--%s_out=%s\", \"insertion-point-writer\", writerOut),\n\t}\n\terr := prototesting.RunProtoc(\n\t\tt.Context(),\n\t\t[]string{dirPath},\n\t\tfilePaths,\n\t\tfalse,\n\t\tfalse,\n\t\tmap[string]string{\n\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t},\n\t\tnil,\n\t\tprotocFlags...,\n\t)\n\trequire.Error(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithEnv(\n\t\t\tfunc(string) map[string]string {\n\t\t\t\treturn map[string]string{\n\t\t\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t\t\t}\n\t\t\t},\n\t\t),\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithArgs(\n\t\t\tappend(\n\t\t\t\tappend(\n\t\t\t\t\tprotocFlags,\n\t\t\t\t\t\"-I\",\n\t\t\t\t\tdirPath,\n\t\t\t\t\t\"--by-dir\",\n\t\t\t\t),\n\t\t\t\tfilePaths...,\n\t\t\t)...,\n\t\t),\n\t)\n}\n\nfunc testCompareGeneratedStubs(\n\tt *testing.T,\n\tdirPath string,\n\tplugins []testPluginInfo,\n) {\n\tfilePaths := buftesting.GetProtocFilePaths(t, dirPath, 100)\n\tactualProtocDir := t.TempDir()\n\tbufProtocDir := t.TempDir()\n\tvar actualProtocPluginFlags []string\n\tfor _, plugin := range plugins {\n\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_out=%s\", plugin.name, actualProtocDir))\n\t\tif plugin.opt != \"\" {\n\t\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_opt=%s\", plugin.name, plugin.opt))\n\t\t}\n\t}\n\tbuftesting.RunActualProtoc(\n\t\tt,\n\t\tfalse,\n\t\tfalse,\n\t\tdirPath,\n\t\tfilePaths,\n\t\tmap[string]string{\n\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t},\n\t\tnil,\n\t\tactualProtocPluginFlags...,\n\t)\n\tvar bufProtocPluginFlags []string\n\tfor _, plugin := range plugins {\n\t\tbufProtocPluginFlags = append(bufProtocPluginFlags, fmt.Sprintf(\"--%s_out=%s\", plugin.name, bufProtocDir))\n\t\tif plugin.opt != \"\" {\n\t\t\tbufProtocPluginFlags = append(bufProtocPluginFlags, fmt.Sprintf(\"--%s_opt=%s\", plugin.name, plugin.opt))\n\t\t}\n\t}\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithEnv(\n\t\t\tfunc(string) map[string]string {\n\t\t\t\treturn map[string]string{\n\t\t\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t\t\t}\n\t\t\t},\n\t\t),\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithArgs(\n\t\t\tappend(\n\t\t\t\tappend(\n\t\t\t\t\tbufProtocPluginFlags,\n\t\t\t\t\t\"-I\",\n\t\t\t\t\tdirPath,\n\t\t\t\t\t\"--by-dir\",\n\t\t\t\t),\n\t\t\t\tfilePaths...,\n\t\t\t)...,\n\t\t),\n\t)\n\tstorageosProvider := storageos.NewProvider(storageos.ProviderWithSymlinks())\n\tactualReadWriteBucket, err := storageosProvider.NewReadWriteBucket(\n\t\tactualProtocDir,\n\t\tstorageos.ReadWriteBucketWithSymlinksIfSupported(),\n\t)\n\trequire.NoError(t, err)\n\tbufReadWriteBucket, err := storageosProvider.NewReadWriteBucket(\n\t\tbufProtocDir,\n\t\tstorageos.ReadWriteBucketWithSymlinksIfSupported(),\n\t)\n\trequire.NoError(t, err)\n\tdiff, err := storage.DiffBytes(\n\t\tt.Context(),\n\t\tactualReadWriteBucket,\n\t\tbufReadWriteBucket,\n\t)\n\trequire.NoError(t, err)\n\tassert.Empty(t, string(diff))\n}\n\nfunc testCompareGeneratedStubsArchive(\n\tt *testing.T,\n\tdirPath string,\n\tplugins []testPluginInfo,\n\tuseJar bool,\n) {\n\tfileExt := \".zip\"\n\tif useJar {\n\t\tfileExt = \".jar\"\n\t}\n\tfilePaths := buftesting.GetProtocFilePaths(t, dirPath, 100)\n\ttempDir := t.TempDir()\n\tactualProtocFile := filepath.Join(tempDir, \"actual-protoc\"+fileExt)\n\tbufProtocFile := filepath.Join(tempDir, \"buf-protoc\"+fileExt)\n\tvar actualProtocPluginFlags []string\n\tfor _, plugin := range plugins {\n\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_out=%s\", plugin.name, actualProtocFile))\n\t\tif plugin.opt != \"\" {\n\t\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_opt=%s\", plugin.name, plugin.opt))\n\t\t}\n\t}\n\tbuftesting.RunActualProtoc(\n\t\tt,\n\t\tfalse,\n\t\tfalse,\n\t\tdirPath,\n\t\tfilePaths,\n\t\tmap[string]string{\n\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t},\n\t\tnil,\n\t\tactualProtocPluginFlags...,\n\t)\n\tvar bufProtocPluginFlags []string\n\tfor _, plugin := range plugins {\n\t\tbufProtocPluginFlags = append(bufProtocPluginFlags, fmt.Sprintf(\"--%s_out=%s\", plugin.name, bufProtocFile))\n\t\tif plugin.opt != \"\" {\n\t\t\tbufProtocPluginFlags = append(bufProtocPluginFlags, fmt.Sprintf(\"--%s_opt=%s\", plugin.name, plugin.opt))\n\t\t}\n\t}\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithEnv(\n\t\t\tfunc(string) map[string]string {\n\t\t\t\treturn map[string]string{\n\t\t\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t\t\t}\n\t\t\t},\n\t\t),\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithArgs(\n\t\t\tappend(\n\t\t\t\tappend(\n\t\t\t\t\tbufProtocPluginFlags,\n\t\t\t\t\t\"-I\",\n\t\t\t\t\tdirPath,\n\t\t\t\t\t\"--by-dir\",\n\t\t\t\t),\n\t\t\t\tfilePaths...,\n\t\t\t)...,\n\t\t),\n\t)\n\tactualData, err := os.ReadFile(actualProtocFile)\n\trequire.NoError(t, err)\n\tactualReadWriteBucket := storagemem.NewReadWriteBucket()\n\terr = storagearchive.Unzip(\n\t\tt.Context(),\n\t\tbytes.NewReader(actualData),\n\t\tint64(len(actualData)),\n\t\tactualReadWriteBucket,\n\t)\n\trequire.NoError(t, err)\n\tbufData, err := os.ReadFile(bufProtocFile)\n\trequire.NoError(t, err)\n\tbufReadWriteBucket := storagemem.NewReadWriteBucket()\n\terr = storagearchive.Unzip(\n\t\tt.Context(),\n\t\tbytes.NewReader(bufData),\n\t\tint64(len(bufData)),\n\t\tbufReadWriteBucket,\n\t)\n\trequire.NoError(t, err)\n\tdiff, err := storage.DiffBytes(\n\t\tt.Context(),\n\t\tactualReadWriteBucket,\n\t\tbufReadWriteBucket,\n\t)\n\trequire.NoError(t, err)\n\tassert.Empty(t, string(diff))\n}\n\nfunc testGetBufProtocFileDescriptorSet(t *testing.T, dirPath string) *descriptorpb.FileDescriptorSet {\n\tdata := testGetBufProtocFileDescriptorSetBytes(t, dirPath)\n\tfileDescriptorSet := &descriptorpb.FileDescriptorSet{}\n\t// TODO: change to image read logic\n\trequire.NoError(\n\t\tt,\n\t\tprotoencoding.NewWireUnmarshaler(nil).Unmarshal(\n\t\t\tdata,\n\t\t\tfileDescriptorSet,\n\t\t),\n\t)\n\treturn fileDescriptorSet\n}\n\nfunc testGetBufProtocFileDescriptorSetBytes(t *testing.T, dirPath string) []byte {\n\tstdout := bytes.NewBuffer(nil)\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithStdout(stdout),\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithArgs(\n\t\t\tappend(\n\t\t\t\t[]string{\n\t\t\t\t\t\"-I\",\n\t\t\t\t\tdirPath,\n\t\t\t\t\t\"-o\",\n\t\t\t\t\t\"-\",\n\t\t\t\t},\n\t\t\t\tbuftesting.GetProtocFilePaths(t, dirPath, 100)...,\n\t\t\t)...,\n\t\t),\n\t)\n\treturn stdout.Bytes()\n}\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/1/flags.txt", "content": "-I\nproto\n--error_format\ntext\n--go_out\ngo_out\n--go_opt\nplugins=connect\n--plugin\n/bin/protoc-gen-go\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/2/flags1.txt", "content": "-I\nproto\n--error_format\ntext\n@testdata/2/flags2.txt\n--go_opt\nplugins=connect\n--plugin\n/bin/protoc-gen-go\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/2/flags2.txt", "content": "--go_out\ngo_out\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/3/flags1.txt", "content": "-I\nproto\n--error_format\ntext\n@testdata/3/flags2.txt\n--go_opt\nplugins=connect\n--plugin\n/bin/protoc-gen-go\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/3/flags2.txt", "content": "--go_out\ngo_out\n@testdata/3/flags1.txt\n" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/insertion/test.proto", "content": "syntax = \"proto3\";\n\npackage test;\n\nmessage Test {\n string name = 1;\n}" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/overlap/a/1.proto", "content": "" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/overlap/a/1.txt", "content": "" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/overlap/b/1.txt", "content": "" }, { "path": "cmd/buf/internal/command/alpha/protoc/testdata/overlap/b/2.proto", "content": "" }, { "path": "cmd/buf/internal/command/alpha/registry/token/tokendelete/tokendelete.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage tokendelete\n\nimport (\n\t\"context\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/bufbuild/buf/private/pkg/netext\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tforceFlagName = \"force\"\n\ttokenIDFlagName = \"token-id\"\n)\n\n// NewCommand returns a new Command\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Delete a token by ID\",\n\t\tArgs: appcmd.ExactArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tForce bool\n\tTokenID string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.BoolVar(\n\t\t&f.Force,\n\t\tforceFlagName,\n\t\tfalse,\n\t\t\"Force deletion without confirming. Use with caution\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.TokenID,\n\t\ttokenIDFlagName,\n\t\t\"\",\n\t\t\"The ID of the token to delete\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, tokenIDFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tbufcli.WarnAlphaCommand(ctx, container)\n\tregistryHostname := container.Arg(0)\n\tif _, err := netext.ValidateHostname(registryHostname); err != nil {\n\t\treturn err\n\t}\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(clientConfig, registryHostname, registryv1alpha1connect.NewTokenServiceClient)\n\tif !flags.Force {\n\t\tif err := bufcli.PromptUserForDelete(container, \"token\", flags.TokenID); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tif _, err := service.DeleteToken(\n\t\tctx,\n\t\tconnect.NewRequest(registryv1alpha1.DeleteTokenRequest_builder{\n\t\t\tTokenId: flags.TokenID,\n\t\t}.Build()),\n\t); err != nil {\n\t\tif connect.CodeOf(err) == connect.CodeNotFound {\n\t\t\treturn bufcli.NewTokenNotFoundError(flags.TokenID)\n\t\t}\n\t\treturn err\n\t}\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/alpha/registry/token/tokenget/tokenget.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage tokenget\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufprint\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/bufbuild/buf/private/pkg/netext\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tformatFlagName = \"format\"\n\ttokenIDFlagName = \"token-id\"\n)\n\n// NewCommand returns a new Command\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Get a token by ID\",\n\t\tArgs: appcmd.ExactArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tFormat string\n\tTokenID string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\tbufprint.FormatText.String(),\n\t\tfmt.Sprintf(`The output format to use. Must be one of %s`, bufprint.AllFormatsString),\n\t)\n\tflagSet.StringVar(\n\t\t&f.TokenID,\n\t\ttokenIDFlagName,\n\t\t\"\",\n\t\t\"The ID of the token to get\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, tokenIDFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tbufcli.WarnAlphaCommand(ctx, container)\n\tregistryHostname := container.Arg(0)\n\tif _, err := netext.ValidateHostname(registryHostname); err != nil {\n\t\treturn err\n\t}\n\tformat, err := bufprint.ParseFormat(flags.Format)\n\tif err != nil {\n\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t}\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(clientConfig, registryHostname, registryv1alpha1connect.NewTokenServiceClient)\n\tresp, err := service.GetToken(\n\t\tctx,\n\t\tconnect.NewRequest(registryv1alpha1.GetTokenRequest_builder{\n\t\t\tTokenId: flags.TokenID,\n\t\t}.Build()),\n\t)\n\tif err != nil {\n\t\tif connect.CodeOf(err) == connect.CodeNotFound {\n\t\t\treturn bufcli.NewTokenNotFoundError(flags.TokenID)\n\t\t}\n\t\treturn err\n\t}\n\tprinter, err := bufprint.NewTokenPrinter(container.Stdout(), format)\n\tif err != nil {\n\t\treturn syserror.Wrap(err)\n\t}\n\treturn printer.PrintTokens(ctx, resp.Msg.GetToken())\n}\n" }, { "path": "cmd/buf/internal/command/alpha/registry/token/tokenlist/tokenlist.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage tokenlist\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufprint\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/bufbuild/buf/private/pkg/netext\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tpageSizeFlagName = \"page-size\"\n\tpageTokenFlagName = \"page-token\"\n\treverseFlagName = \"reverse\"\n\tformatFlagName = \"format\"\n)\n\n// NewCommand returns a new Command\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"List user tokens\",\n\t\tArgs: appcmd.ExactArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tPageSize uint32\n\tPageToken string\n\tReverse bool\n\tFormat string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.Uint32Var(&f.PageSize,\n\t\tpageSizeFlagName,\n\t\t10,\n\t\t`The page size.`,\n\t)\n\tflagSet.StringVar(&f.PageToken,\n\t\tpageTokenFlagName,\n\t\t\"\",\n\t\t`The page token. If more results are available, a \"next_page\" key is present in the --format=json output.`,\n\t)\n\tflagSet.BoolVar(&f.Reverse,\n\t\treverseFlagName,\n\t\tfalse,\n\t\t`Reverse the results.`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\tbufprint.FormatText.String(),\n\t\tfmt.Sprintf(`The output format to use. Must be one of %s`, bufprint.AllFormatsString),\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tbufcli.WarnAlphaCommand(ctx, container)\n\tregistryHostname := container.Arg(0)\n\tif _, err := netext.ValidateHostname(registryHostname); err != nil {\n\t\treturn err\n\t}\n\tformat, err := bufprint.ParseFormat(flags.Format)\n\tif err != nil {\n\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t}\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(clientConfig, registryHostname, registryv1alpha1connect.NewTokenServiceClient)\n\tresp, err := service.ListTokens(\n\t\tctx,\n\t\tconnect.NewRequest(registryv1alpha1.ListTokensRequest_builder{\n\t\t\tPageSize: flags.PageSize,\n\t\t\tPageToken: flags.PageToken,\n\t\t\tReverse: flags.Reverse,\n\t\t}.Build()),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tprinter, err := bufprint.NewTokenPrinter(container.Stdout(), format)\n\tif err != nil {\n\t\treturn syserror.Wrap(err)\n\t}\n\t// TODO: flag docs say \"next_token\" field will be present in the output,\n\t// for paging through results but we are actually ignoring that field now.\n\treturn printer.PrintTokens(ctx, resp.Msg.GetTokens()...)\n}\n" }, { "path": "cmd/buf/internal/command/beta/bufpluginv1/bufpluginv1.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage bufpluginv1\n\nimport (\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/internal\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck/bufcheckserver\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(name string, builder appext.SubCommandBuilder) *appcmd.Command {\n\treturn internal.NewCommand(name, builder, bufcheckserver.V1Spec)\n}\n" }, { "path": "cmd/buf/internal/command/beta/bufpluginv1beta1/bufpluginv1beta1.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage bufpluginv1beta1\n\nimport (\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/internal\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck/bufcheckserver\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(name string, builder appext.SubCommandBuilder) *appcmd.Command {\n\treturn internal.NewCommand(name, builder, bufcheckserver.V1Beta1Spec)\n}\n" }, { "path": "cmd/buf/internal/command/beta/bufpluginv2/bufpluginv2.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage bufpluginv2\n\nimport (\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/beta/internal\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck/bufcheckserver\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(name string, builder appext.SubCommandBuilder) *appcmd.Command {\n\treturn internal.NewCommand(name, builder, bufcheckserver.V2Spec)\n}\n" }, { "path": "cmd/buf/internal/command/beta/internal/internal.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage internal\n\nimport (\n\t\"context\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"github.com/spf13/pflag\"\n\t\"pluginrpc.com/pluginrpc\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n\tspec *check.Spec,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"Run buf as a check plugin.\",\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags, spec)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tProtocol bool\n\tSpec bool\n\tFormat string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.BoolVar(&f.Protocol, pluginrpc.ProtocolFlagName, false, \"Passed through to plugin.\")\n\tflagSet.BoolVar(&f.Spec, pluginrpc.SpecFlagName, false, \"Passed through to plugin.\")\n\tflagSet.StringVar(&f.Format, pluginrpc.FormatFlagName, pluginrpc.FormatBinary.String(), \"Passed through to plugin.\")\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n\tspec *check.Spec,\n) error {\n\tserver, err := check.NewServer(spec)\n\tif err != nil {\n\t\treturn err\n\t}\n\targs := app.Args(container)\n\tif flags.Protocol {\n\t\targs = append(args, \"--\"+pluginrpc.ProtocolFlagName)\n\t}\n\tif flags.Spec {\n\t\targs = append(args, \"--\"+pluginrpc.SpecFlagName)\n\t}\n\tif flags.Format != \"\" {\n\t\targs = append(args, \"--\"+pluginrpc.FormatFlagName+\"=\"+flags.Format)\n\t}\n\treturn server.Serve(\n\t\tctx,\n\t\tpluginrpc.Env{\n\t\t\tArgs: args,\n\t\t\tStdin: container.Stdin(),\n\t\t\tStdout: container.Stdout(),\n\t\t\tStderr: container.Stderr(),\n\t\t},\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/beta/price/price.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage price\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"math\"\n\t\"text/template\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/pkg/protostat\"\n\t\"github.com/bufbuild/buf/private/pkg/protostat/protostatstorage\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\tteamsDollarsPerType = float64(0.50)\n\tproDollarsPerType = float64(5)\n\tproDollarsMinimumSpend = float64(3000)\n\ttmplCopy = `Current BSR pricing:\n\n - Teams: $0.50 per type\n - Pro: $5.00 per type, with a minimum spend of $3,000 per month\n\nPricing data last updated on February 1, 2025.\n\nMake sure you are on the latest version of the Buf CLI to get the most updated pricing\ninformation, and see buf.build/pricing if in doubt - this command runs completely locally\nand does not interact with our servers.\n\nYour sources have:\n\n - {{.Messages}} messages\n - {{.Enums}} enums\n - {{.RPCs}} RPCs\n\nThis adds up to {{.Types}} types.\n\nBased on this, these sources will cost:\n\n- ${{.TeamsDollarsPerMonth}}/month for Teams\n- ${{.ProDollarsPerMonth}}/month for Pro\n\nThese values should be treated as an estimate - we price based on the average number\nof private types you have on the BSR during your billing period.\n`\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Get the price for BSR paid plans for a given source or module\",\n\t\tLong: bufcli.GetSourceOrModuleLong(`the source or module to get a price for`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tDisableSymlinks bool\n\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspace, err := controller.GetWorkspace(\n\t\tctx,\n\t\tinput,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tstats, err := protostat.GetStats(\n\t\tctx,\n\t\tprotostatstorage.NewFileWalker(\n\t\t\tbufmodule.ModuleReadBucketToStorageReadBucket(\n\t\t\t\tbufmodule.ModuleSetToModuleReadBucketWithOnlyProtoFilesForTargetModules(\n\t\t\t\t\tworkspace,\n\t\t\t\t),\n\t\t\t),\n\t\t),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\ttmpl, err := template.New(\"tmpl\").Parse(tmplCopy)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn tmpl.Execute(\n\t\tcontainer.Stdout(),\n\t\tnewTmplData(stats),\n\t)\n}\n\ntype tmplData struct {\n\t*protostat.Stats\n\n\tTeamsDollarsPerMonth string\n\tProDollarsPerMonth string\n}\n\nfunc newTmplData(stats *protostat.Stats) *tmplData {\n\ttmplData := &tmplData{\n\t\tStats: stats,\n\t}\n\ttmplData.TeamsDollarsPerMonth = fmt.Sprintf(\"%.2f\", float64(tmplData.Types)*teamsDollarsPerType)\n\ttmplData.ProDollarsPerMonth = fmt.Sprintf(\"%.2f\", math.Max(float64(tmplData.Types)*proDollarsPerType, proDollarsMinimumSpend))\n\treturn tmplData\n}\n" }, { "path": "cmd/buf/internal/command/beta/registry/plugin/plugindelete/plugindelete.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage plugindelete\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"strings\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufremoteplugin/bufremotepluginref\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/spf13/pflag\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Delete a plugin from the registry\",\n\t\tArgs: appcmd.ExactArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct{}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tbufcli.WarnBetaCommand(ctx, container)\n\tidentity, version, _ := strings.Cut(container.Arg(0), \":\")\n\tpluginIdentity, err := bufremotepluginref.PluginIdentityForString(identity)\n\tif err != nil {\n\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t}\n\tif version != \"\" {\n\t\tif err := bufremotepluginref.ValidatePluginVersion(version); err != nil {\n\t\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t\t}\n\t}\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(\n\t\tclientConfig,\n\t\tpluginIdentity.Remote(),\n\t\tregistryv1alpha1connect.NewPluginCurationServiceClient,\n\t)\n\tif _, err := service.DeleteCuratedPlugin(\n\t\tctx,\n\t\tconnect.NewRequest(\n\t\t\tregistryv1alpha1.DeleteCuratedPluginRequest_builder{\n\t\t\t\tOwner: pluginIdentity.Owner(),\n\t\t\t\tName: pluginIdentity.Plugin(),\n\t\t\t\tVersion: version,\n\t\t\t}.Build(),\n\t\t),\n\t); err != nil {\n\t\tif connect.CodeOf(err) == connect.CodeNotFound {\n\t\t\treturn fmt.Errorf(\"the plugin %s does not exist\", container.Arg(0))\n\t\t}\n\t\treturn err\n\t}\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/beta/registry/plugin/pluginpush/pluginpush.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage pluginpush\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io/fs\"\n\t\"log/slog\"\n\t\"net/http\"\n\t\"os\"\n\t\"strings\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufprint\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufremoteplugin\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufremoteplugin/bufremotepluginconfig\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufremoteplugin/bufremoteplugindocker\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/bufbuild/buf/private/pkg/netext\"\n\t\"github.com/bufbuild/buf/private/pkg/netrc\"\n\t\"github.com/bufbuild/buf/private/pkg/storage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storagearchive\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/google/go-containerregistry/pkg/authn\"\n\t\"github.com/google/go-containerregistry/pkg/name\"\n\tpkgv1 \"github.com/google/go-containerregistry/pkg/v1\"\n\t\"github.com/google/go-containerregistry/pkg/v1/remote\"\n\t\"github.com/google/go-containerregistry/pkg/v1/remote/transport\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tformatFlagName = \"format\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\toverrideRemoteFlagName = \"override-remote\"\n\timageFlagName = \"image\"\n\tvisibilityFlagName = \"visibility\"\n\n\tpublicVisibility = \"public\"\n\tprivateVisibility = \"private\"\n)\n\nvar allVisibilityStrings = []string{\n\tpublicVisibility,\n\tprivateVisibility,\n}\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Push a plugin to a registry\",\n\t\tLong: bufcli.GetSourceDirLong(`the source to push (directory containing buf.plugin.yaml or plugin release zip)`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tFormat string\n\tDisableSymlinks bool\n\tOverrideRemote string\n\tImage string\n\tVisibility string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\tbufprint.FormatText.String(),\n\t\tfmt.Sprintf(`The output format to use. Must be one of %s`, bufprint.AllFormatsString),\n\t)\n\tflagSet.StringVar(\n\t\t&f.OverrideRemote,\n\t\toverrideRemoteFlagName,\n\t\t\"\",\n\t\t\"Override the default remote found in buf.plugin.yaml name and dependencies\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.Image,\n\t\timageFlagName,\n\t\t\"\",\n\t\t\"Existing image to push\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.Visibility,\n\t\tvisibilityFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(`The plugin's visibility setting. Must be one of %s`, xstrings.SliceToString(allVisibilityStrings)),\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, visibilityFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tbufcli.WarnBetaCommand(ctx, container)\n\tif len(flags.OverrideRemote) > 0 {\n\t\tif _, err := netext.ValidateHostname(flags.OverrideRemote); err != nil {\n\t\t\treturn fmt.Errorf(\"%s: %w\", overrideRemoteFlagName, err)\n\t\t}\n\t}\n\tformat, err := bufprint.ParseFormat(flags.Format)\n\tif err != nil {\n\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t}\n\tsource, err := bufcli.GetInputValue(container, \"\" /* The input hashtag is not supported here */, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tstorageProvider := newStorageosProvider(flags.DisableSymlinks)\n\tsourceStat, err := os.Stat(source)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar sourceBucket storage.ReadWriteBucket\n\tif !sourceStat.IsDir() && strings.HasSuffix(strings.ToLower(sourceStat.Name()), \".zip\") {\n\t\t// Unpack plugin release to temporary directory\n\t\ttmpDir, err := os.MkdirTemp(os.TempDir(), \"plugin-push\")\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tdefer func() {\n\t\t\tif err := os.RemoveAll(tmpDir); !os.IsNotExist(err) {\n\t\t\t\tretErr = errors.Join(retErr, err)\n\t\t\t}\n\t\t}()\n\t\tsourceBucket, err = storageProvider.NewReadWriteBucket(tmpDir)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif err := unzipPluginToSourceBucket(ctx, source, sourceStat.Size(), sourceBucket); err != nil {\n\t\t\treturn err\n\t\t}\n\t} else {\n\t\tsourceBucket, err = storageProvider.NewReadWriteBucket(source)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\texistingConfigFilePath, err := bufremotepluginconfig.ExistingConfigFilePath(ctx, sourceBucket)\n\tif err != nil {\n\t\treturn syserror.Wrap(err)\n\t}\n\tif existingConfigFilePath == \"\" {\n\t\treturn fmt.Errorf(\"please define a %s configuration file in the target directory\", bufremotepluginconfig.ExternalConfigFilePath)\n\t}\n\tvar options []bufremotepluginconfig.ConfigOption\n\tif len(flags.OverrideRemote) > 0 {\n\t\toptions = append(options, bufremotepluginconfig.WithOverrideRemote(flags.OverrideRemote))\n\t}\n\tpluginConfig, err := bufremotepluginconfig.GetConfigForBucket(ctx, sourceBucket, options...)\n\tif err != nil {\n\t\treturn err\n\t}\n\tclient, err := bufremoteplugindocker.NewClient(container.Logger(), bufcli.Version)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer func() {\n\t\tif err := client.Close(); err != nil {\n\t\t\tretErr = errors.Join(retErr, fmt.Errorf(\"docker client close error: %w\", err))\n\t\t}\n\t}()\n\tvar imageID string\n\tif flags.Image != \"\" {\n\t\tinspectResponse, err := client.Inspect(ctx, flags.Image)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\timageID = inspectResponse.ImageID\n\t} else {\n\t\timage, err := loadDockerImage(ctx, sourceBucket)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tloadResponse, err := client.Load(ctx, image)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tdefer func() {\n\t\t\tif err := image.Close(); err != nil && !errors.Is(err, storage.ErrClosed) {\n\t\t\t\tretErr = errors.Join(retErr, fmt.Errorf(\"docker image close error: %w\", err))\n\t\t\t}\n\t\t}()\n\t\timageID = loadResponse.ImageID\n\t}\n\tvisibility, err := visibilityFlagToVisibility(flags.Visibility)\n\tif err != nil {\n\t\treturn err\n\t}\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(\n\t\tclientConfig,\n\t\tpluginConfig.Name.Remote(),\n\t\tregistryv1alpha1connect.NewPluginCurationServiceClient,\n\t)\n\tlatestPluginResp, err := service.GetLatestCuratedPlugin(\n\t\tctx,\n\t\tconnect.NewRequest(\n\t\t\tregistryv1alpha1.GetLatestCuratedPluginRequest_builder{\n\t\t\t\tOwner: pluginConfig.Name.Owner(),\n\t\t\t\tName: pluginConfig.Name.Plugin(),\n\t\t\t\tVersion: pluginConfig.PluginVersion,\n\t\t\t\tRevision: 0, // get latest revision for the plugin version.\n\t\t\t}.Build(),\n\t\t),\n\t)\n\tvar currentImageDigest string\n\tvar nextRevision uint32\n\tif err != nil {\n\t\tif connect.CodeOf(err) != connect.CodeNotFound {\n\t\t\treturn err\n\t\t}\n\t\tnextRevision = 1\n\t} else {\n\t\tnextRevision = latestPluginResp.Msg.GetPlugin().GetRevision() + 1\n\t\tcurrentImageDigest = latestPluginResp.Msg.GetPlugin().GetContainerImageDigest()\n\t}\n\tmachine, err := netrc.GetMachineForName(container, pluginConfig.Name.Remote())\n\tif err != nil {\n\t\treturn err\n\t}\n\tauthConfig := &bufremoteplugindocker.RegistryAuthConfig{}\n\tif machine != nil {\n\t\tauthConfig.ServerAddress = machine.Name()\n\t\tauthConfig.Username = machine.Login()\n\t\tauthConfig.Password = machine.Password()\n\t}\n\timageDigest, err := findExistingDigestForImageID(ctx, pluginConfig, authConfig, imageID, currentImageDigest)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif imageDigest == \"\" {\n\t\timageDigest, err = pushImage(ctx, client, authConfig, pluginConfig, imageID)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t} else {\n\t\tcontainer.Logger().Info(\"image found in registry - skipping push\")\n\t}\n\tplugin, err := bufremoteplugin.NewPlugin(\n\t\tpluginConfig.PluginVersion,\n\t\tpluginConfig.Dependencies,\n\t\tpluginConfig.Registry,\n\t\timageDigest,\n\t\tpluginConfig.SourceURL,\n\t\tpluginConfig.Description,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tcreateRequest, err := createCuratedPluginRequest(pluginConfig, plugin, nextRevision, visibility)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar curatedPlugin *registryv1alpha1.CuratedPlugin\n\tcreatePluginResp, err := service.CreateCuratedPlugin(ctx, connect.NewRequest(createRequest))\n\tif err != nil {\n\t\tif connect.CodeOf(err) != connect.CodeAlreadyExists {\n\t\t\treturn err\n\t\t}\n\t\t// Plugin with the same image digest and metadata already exists\n\t\tcontainer.Logger().Info(\n\t\t\t\"plugin already exists\",\n\t\t\tslog.String(\"name\", pluginConfig.Name.IdentityString()),\n\t\t\tslog.String(\"digest\", plugin.ContainerImageDigest()),\n\t\t)\n\t\tif latestPluginResp == nil {\n\t\t\tlatestPluginResp, err = service.GetLatestCuratedPlugin(\n\t\t\t\tctx,\n\t\t\t\tconnect.NewRequest(\n\t\t\t\t\tregistryv1alpha1.GetLatestCuratedPluginRequest_builder{\n\t\t\t\t\t\tOwner: pluginConfig.Name.Owner(),\n\t\t\t\t\t\tName: pluginConfig.Name.Plugin(),\n\t\t\t\t\t\tVersion: pluginConfig.PluginVersion,\n\t\t\t\t\t\tRevision: 0, // get latest revision for the plugin version.\n\t\t\t\t\t}.Build(),\n\t\t\t\t),\n\t\t\t)\n\t\t\tif err != nil {\n\t\t\t\treturn fmt.Errorf(\"unable to fetch latest plugin after AlreadyExists error: %w\", err)\n\t\t\t}\n\t\t}\n\t\t// Ensure the image digest matches.\n\t\tif latestPluginResp.Msg.GetPlugin().GetContainerImageDigest() != plugin.ContainerImageDigest() {\n\t\t\treturn fmt.Errorf(\"a plugin with the same name and version already exists, but with a different image digest (%s). If you want to push a new revision, please retry\", latestPluginResp.Msg.GetPlugin().GetContainerImageDigest())\n\t\t}\n\t\tcuratedPlugin = latestPluginResp.Msg.GetPlugin()\n\t} else {\n\t\tcuratedPlugin = createPluginResp.Msg.GetConfiguration()\n\t}\n\treturn bufprint.NewCuratedPluginPrinter(container.Stdout()).PrintCuratedPlugin(ctx, format, curatedPlugin)\n}\n\nfunc createCuratedPluginRequest(\n\tpluginConfig *bufremotepluginconfig.Config,\n\tplugin bufremoteplugin.Plugin,\n\tnextRevision uint32,\n\tvisibility registryv1alpha1.CuratedPluginVisibility,\n) (*registryv1alpha1.CreateCuratedPluginRequest, error) {\n\toutputLanguages, err := bufremoteplugin.OutputLanguagesToProtoLanguages(pluginConfig.OutputLanguages)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tprotoRegistryConfig, err := bufremoteplugin.PluginRegistryToProtoRegistryConfig(plugin.Registry())\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn registryv1alpha1.CreateCuratedPluginRequest_builder{\n\t\tOwner: pluginConfig.Name.Owner(),\n\t\tName: pluginConfig.Name.Plugin(),\n\t\tRegistryType: bufremoteplugin.PluginToProtoPluginRegistryType(plugin),\n\t\tVersion: plugin.Version(),\n\t\tContainerImageDigest: plugin.ContainerImageDigest(),\n\t\tDependencies: bufremoteplugin.PluginReferencesToCuratedProtoPluginReferences(plugin.Dependencies()),\n\t\tSourceUrl: plugin.SourceURL(),\n\t\tDescription: plugin.Description(),\n\t\tRegistryConfig: protoRegistryConfig,\n\t\tRevision: nextRevision,\n\t\tOutputLanguages: outputLanguages,\n\t\tSpdxLicenseId: pluginConfig.SPDXLicenseID,\n\t\tLicenseUrl: pluginConfig.LicenseURL,\n\t\tVisibility: visibility,\n\t\tIntegrationGuideUrl: pluginConfig.IntegrationGuideURL,\n\t\tDeprecated: pluginConfig.Deprecated,\n\t}.Build(), nil\n}\n\nfunc pushImage(\n\tctx context.Context,\n\tclient bufremoteplugindocker.Client,\n\tauthConfig *bufremoteplugindocker.RegistryAuthConfig,\n\tplugin *bufremotepluginconfig.Config,\n\timage string,\n) (_ string, retErr error) {\n\ttagResponse, err := client.Tag(ctx, image, plugin)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tcreatedImage := tagResponse.Image\n\t// We tag a Docker image using a unique ID label each time.\n\t// After we're done publishing the image, we delete it to not leave a lot of images left behind.\n\tdefer func() {\n\t\tif _, err := client.Delete(ctx, createdImage); err != nil {\n\t\t\tretErr = errors.Join(retErr, fmt.Errorf(\"failed to delete image %q\", createdImage))\n\t\t}\n\t}()\n\tpushResponse, err := client.Push(ctx, createdImage, authConfig)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\treturn pushResponse.Digest, nil\n}\n\n// findExistingDigestForImageID will query the OCI registry to see if the imageID already exists.\n// If an image is found with the same imageID, its digest will be returned (and we'll skip pushing to OCI registry).\n//\n// It performs the following search:\n//\n// - GET /v2/{owner}/{plugin}/tags/list\n// - For each tag:\n// - Fetch image: GET /v2/{owner}/{plugin}/manifests/{tag}\n// - If image manifest matches imageID, we can use the image digest for the image.\nfunc findExistingDigestForImageID(\n\tctx context.Context,\n\tplugin *bufremotepluginconfig.Config,\n\tauthConfig *bufremoteplugindocker.RegistryAuthConfig,\n\timageID string,\n\tcurrentImageDigest string,\n) (string, error) {\n\trepo, err := name.NewRepository(fmt.Sprintf(\"%s/%s/%s\", plugin.Name.Remote(), plugin.Name.Owner(), plugin.Name.Plugin()))\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tauth := &authn.Basic{Username: authConfig.Username, Password: authConfig.Password}\n\tremoteOpts := []remote.Option{remote.WithContext(ctx), remote.WithAuth(auth)}\n\t// First attempt to see if the current image digest matches the image ID\n\tif currentImageDigest != \"\" {\n\t\tremoteImageID, _, err := getImageIDAndDigestFromReference(ctx, repo.Digest(currentImageDigest), remoteOpts...)\n\t\tif err != nil {\n\t\t\treturn \"\", err\n\t\t}\n\t\tif remoteImageID == imageID {\n\t\t\treturn currentImageDigest, nil\n\t\t}\n\t}\n\t// List all tags and check for a match\n\ttags, err := remote.List(repo, remoteOpts...)\n\tif err != nil {\n\t\tstructuredErr := new(transport.Error)\n\t\tif errors.As(err, &structuredErr) {\n\t\t\tif structuredErr.StatusCode == http.StatusUnauthorized {\n\t\t\t\treturn \"\", errors.New(\"you are not authenticated. For details, visit https://buf.build/docs/bsr/authentication\")\n\t\t\t}\n\t\t\tif structuredErr.StatusCode == http.StatusNotFound {\n\t\t\t\treturn \"\", nil\n\t\t\t}\n\t\t}\n\t\treturn \"\", err\n\t}\n\texistingImageDigest := \"\"\n\tfor _, tag := range tags {\n\t\tremoteImageID, imageDigest, err := getImageIDAndDigestFromReference(ctx, repo.Tag(tag), remoteOpts...)\n\t\tif err != nil {\n\t\t\treturn \"\", err\n\t\t}\n\t\tif remoteImageID == imageID {\n\t\t\texistingImageDigest = imageDigest\n\t\t\tbreak\n\t\t}\n\t}\n\treturn existingImageDigest, nil\n}\n\n// getImageIDAndDigestFromReference takes an image reference and returns 2 resolved digests:\n//\n// 1. The image config digest (https://github.com/opencontainers/image-spec/blob/v1.1.0/config.md)\n// 2. The image manifest digest (https://github.com/opencontainers/image-spec/blob/v1.1.0/manifest.md)\n//\n// The incoming ref is expected to be either an image manifest digest or an image index digest.\nfunc getImageIDAndDigestFromReference(\n\tctx context.Context,\n\tref name.Reference,\n\toptions ...remote.Option,\n) (string, string, error) {\n\tpuller, err := remote.NewPuller(options...)\n\tif err != nil {\n\t\treturn \"\", \"\", err\n\t}\n\tdesc, err := puller.Get(ctx, ref)\n\tif err != nil {\n\t\treturn \"\", \"\", err\n\t}\n\n\tswitch {\n\tcase desc.MediaType.IsIndex():\n\t\timageIndex, err := desc.ImageIndex()\n\t\tif err != nil {\n\t\t\treturn \"\", \"\", fmt.Errorf(\"failed to get image index: %w\", err)\n\t\t}\n\t\tindexManifest, err := imageIndex.IndexManifest()\n\t\tif err != nil {\n\t\t\treturn \"\", \"\", fmt.Errorf(\"failed to get image manifests: %w\", err)\n\t\t}\n\t\tvar manifest pkgv1.Descriptor\n\t\tfor _, desc := range indexManifest.Manifests {\n\t\t\tif p := desc.Platform; p != nil {\n\t\t\t\t// Drop attestations, which don't have a valid platform set.\n\t\t\t\tif p.OS == \"unknown\" && p.Architecture == \"unknown\" {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tmanifest = desc\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif manifest.Digest.String() == \"\" {\n\t\t\treturn \"\", \"\", fmt.Errorf(\"no valid platform manifest found in image index for %q\", ref)\n\t\t}\n\t\t// We resolved the image index to an image manifest digest, we can now call this function\n\t\t// again to resolve the image manifest digest to an image config digest.\n\t\treturn getImageIDAndDigestFromReference(\n\t\t\tctx,\n\t\t\tref.Context().Digest(manifest.Digest.String()),\n\t\t\toptions...,\n\t\t)\n\tcase desc.MediaType.IsImage():\n\t\timageManifest, err := desc.Image()\n\t\tif err != nil {\n\t\t\treturn \"\", \"\", fmt.Errorf(\"failed to get image: %w\", err)\n\t\t}\n\t\timageManifestDigest, err := imageManifest.Digest()\n\t\tif err != nil {\n\t\t\treturn \"\", \"\", fmt.Errorf(\"failed to get image digest for %q: %w\", ref, err)\n\t\t}\n\t\tmanifest, err := imageManifest.Manifest()\n\t\tif err != nil {\n\t\t\treturn \"\", \"\", fmt.Errorf(\"failed to get image manifest for %q: %w\", ref, err)\n\t\t}\n\t\treturn manifest.Config.Digest.String(), imageManifestDigest.String(), nil\n\t}\n\treturn \"\", \"\", fmt.Errorf(\"unsupported media type: %q\", desc.MediaType)\n}\n\nfunc unzipPluginToSourceBucket(ctx context.Context, pluginZip string, size int64, bucket storage.ReadWriteBucket) (retErr error) {\n\tf, err := os.Open(pluginZip)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer func() {\n\t\tif err := f.Close(); err != nil {\n\t\t\tretErr = errors.Join(retErr, fmt.Errorf(\"plugin zip close error: %w\", err))\n\t\t}\n\t}()\n\treturn storagearchive.Unzip(ctx, f, size, bucket)\n}\n\nfunc loadDockerImage(ctx context.Context, bucket storage.ReadBucket) (storage.ReadObjectCloser, error) {\n\timage, err := bucket.Get(ctx, bufremoteplugindocker.ImagePath)\n\tif errors.Is(err, fs.ErrNotExist) {\n\t\treturn nil, fmt.Errorf(\"unable to find a %s plugin image: %w\", bufremoteplugindocker.ImagePath, err)\n\t}\n\treturn image, nil\n}\n\nfunc visibilityFlagToVisibility(visibility string) (registryv1alpha1.CuratedPluginVisibility, error) {\n\tswitch visibility {\n\tcase publicVisibility:\n\t\treturn registryv1alpha1.CuratedPluginVisibility_CURATED_PLUGIN_VISIBILITY_PUBLIC, nil\n\tcase privateVisibility:\n\t\treturn registryv1alpha1.CuratedPluginVisibility_CURATED_PLUGIN_VISIBILITY_PRIVATE, nil\n\tdefault:\n\t\treturn 0, fmt.Errorf(\"invalid visibility: %s, expected one of %s\", visibility, xstrings.SliceToString(allVisibilityStrings))\n\t}\n}\n\nfunc newStorageosProvider(disableSymlinks bool) storageos.Provider {\n\tvar options []storageos.ProviderOption\n\tif !disableSymlinks {\n\t\toptions = append(options, storageos.ProviderWithSymlinks())\n\t}\n\treturn storageos.NewProvider(options...)\n}\n" }, { "path": "cmd/buf/internal/command/beta/registry/webhook/webhookcreate/webhookcreate.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage webhookcreate\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\townerFlagName = \"owner\"\n\trepositoryFlagName = \"repository\"\n\tcallbackURLFlagName = \"callback-url\"\n\twebhookEventFlagName = \"event\"\n\tremoteFlagName = \"remote\"\n)\n\n// NewCommand returns a new Command\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"Create a repository webhook\",\n\t\tArgs: appcmd.ExactArgs(0),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tWebhookEvent string\n\tOwnerName string\n\tRepositoryName string\n\tCallbackURL string\n\tRemote string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVar(\n\t\t&f.WebhookEvent,\n\t\twebhookEventFlagName,\n\t\t\"\",\n\t\t\"The event type to create a webhook for. The proto enum string value is used for this input (e.g. 'WEBHOOK_EVENT_REPOSITORY_PUSH')\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, webhookEventFlagName)\n\tflagSet.StringVar(\n\t\t&f.OwnerName,\n\t\townerFlagName,\n\t\t\"\",\n\t\t`The owner name of the repository to create a webhook for`,\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, ownerFlagName)\n\tflagSet.StringVar(\n\t\t&f.RepositoryName,\n\t\trepositoryFlagName,\n\t\t\"\",\n\t\t\"The repository name to create a webhook for\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, repositoryFlagName)\n\tflagSet.StringVar(\n\t\t&f.CallbackURL,\n\t\tcallbackURLFlagName,\n\t\t\"\",\n\t\t\"The url for the webhook to callback to on a given event\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, callbackURLFlagName)\n\tflagSet.StringVar(\n\t\t&f.Remote,\n\t\tremoteFlagName,\n\t\t\"\",\n\t\t\"The remote of the repository the created webhook will belong to\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, remoteFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tbufcli.WarnBetaCommand(ctx, container)\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(clientConfig, flags.Remote, registryv1alpha1connect.NewWebhookServiceClient)\n\tevent, ok := registryv1alpha1.WebhookEvent_value[flags.WebhookEvent]\n\tif !ok || event == int32(registryv1alpha1.WebhookEvent_WEBHOOK_EVENT_UNSPECIFIED) {\n\t\treturn fmt.Errorf(\"webhook event must be specified\")\n\t}\n\tresp, err := service.CreateWebhook(\n\t\tctx,\n\t\tconnect.NewRequest(\n\t\t\tregistryv1alpha1.CreateWebhookRequest_builder{\n\t\t\t\tWebhookEvent: registryv1alpha1.WebhookEvent(event),\n\t\t\t\tOwnerName: flags.OwnerName,\n\t\t\t\tRepositoryName: flags.RepositoryName,\n\t\t\t\tCallbackUrl: flags.CallbackURL,\n\t\t\t}.Build(),\n\t\t),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\twebhookJSON, err := json.MarshalIndent(resp.Msg.GetWebhook(), \"\", \"\\t\")\n\tif err != nil {\n\t\treturn err\n\t}\n\t// Ignore errors for writing to stdout.\n\t_, _ = container.Stdout().Write(webhookJSON)\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/beta/registry/webhook/webhookdelete/webhookdelete.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage webhookdelete\n\nimport (\n\t\"context\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\twebhookIDFlagName = \"id\"\n\tremoteFlagName = \"remote\"\n)\n\n// NewCommand returns a new Command\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"Delete a repository webhook\",\n\t\tArgs: appcmd.ExactArgs(0),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tWebhookID string\n\tRemote string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVar(\n\t\t&f.WebhookID,\n\t\twebhookIDFlagName,\n\t\t\"\",\n\t\t\"The webhook ID to delete\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, webhookIDFlagName)\n\tflagSet.StringVar(\n\t\t&f.Remote,\n\t\tremoteFlagName,\n\t\t\"\",\n\t\t\"The remote of the repository the webhook ID belongs to\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, remoteFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tbufcli.WarnBetaCommand(ctx, container)\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(clientConfig, flags.Remote, registryv1alpha1connect.NewWebhookServiceClient)\n\tif _, err := service.DeleteWebhook(\n\t\tctx,\n\t\tconnect.NewRequest(\n\t\t\tregistryv1alpha1.DeleteWebhookRequest_builder{\n\t\t\t\tWebhookId: flags.WebhookID,\n\t\t\t}.Build(),\n\t\t),\n\t); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/beta/registry/webhook/webhooklist/webhooklist.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage webhooklist\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/gen/proto/connect/buf/alpha/registry/v1alpha1/registryv1alpha1connect\"\n\tregistryv1alpha1 \"github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1\"\n\t\"github.com/bufbuild/buf/private/pkg/connectclient\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\townerFlagName = \"owner\"\n\trepositoryFlagName = \"repository\"\n\tremoteFlagName = \"remote\"\n)\n\n// NewCommand returns a new Command\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"List repository webhooks\",\n\t\tArgs: appcmd.ExactArgs(0),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tOwnerName string\n\tRepositoryName string\n\tRemote string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVar(\n\t\t&f.OwnerName,\n\t\townerFlagName,\n\t\t\"\",\n\t\t`The owner name of the repository to list webhooks for`,\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, ownerFlagName)\n\tflagSet.StringVar(\n\t\t&f.RepositoryName,\n\t\trepositoryFlagName,\n\t\t\"\",\n\t\t\"The repository name to list webhooks for.\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, repositoryFlagName)\n\tflagSet.StringVar(\n\t\t&f.Remote,\n\t\tremoteFlagName,\n\t\t\"\",\n\t\t\"The remote of the owner and repository to list webhooks for\",\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, remoteFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tbufcli.WarnBetaCommand(ctx, container)\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tservice := connectclient.Make(clientConfig, flags.Remote, registryv1alpha1connect.NewWebhookServiceClient)\n\tresp, err := service.ListWebhooks(\n\t\tctx,\n\t\tconnect.NewRequest(\n\t\t\tregistryv1alpha1.ListWebhooksRequest_builder{\n\t\t\t\tRepositoryName: flags.RepositoryName,\n\t\t\t\tOwnerName: flags.OwnerName,\n\t\t\t\t// TODO FUTURE: this should probably be in a loop so we can get page token from\n\t\t\t\t// response and query for the next page\n\t\t\t}.Build(),\n\t\t),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif resp.Msg.GetWebhooks() == nil {\n\t\t// Ignore errors for writing to stdout.\n\t\t_, _ = container.Stdout().Write([]byte(\"[]\"))\n\t\treturn nil\n\t}\n\twebhooksJSON, err := json.MarshalIndent(resp.Msg.GetWebhooks(), \"\", \"\\t\")\n\tif err != nil {\n\t\treturn err\n\t}\n\t// Ignore errors for writing to stdout.\n\t_, _ = container.Stdout().Write(webhooksJSON)\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/beta/studioagent/studioagent.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage studioagent\n\nimport (\n\t\"context\"\n\t\"crypto/tls\"\n\t\"fmt\"\n\t\"net\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"github.com/bufbuild/buf/private/buf/bufstudioagent\"\n\t\"github.com/bufbuild/buf/private/pkg/cert/certclient\"\n\t\"github.com/bufbuild/buf/private/pkg/transport/http/httpserver\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tbindFlagName = \"bind\"\n\tportFlagName = \"port\"\n\toriginFlagName = \"origin\"\n\tdisallowedHeadersFlagName = \"disallowed-header\"\n\tforwardHeadersFlagName = \"forward-header\"\n\tcaCertFlagName = \"ca-cert\"\n\tclientCertFlagName = \"client-cert\"\n\tclientKeyFlagName = \"client-key\"\n\tserverCertFlagName = \"server-cert\"\n\tserverKeyFlagName = \"server-key\"\n\tprivateNetworkFlagName = \"private-network\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"Run an HTTP(S) server as the Studio agent\",\n\t\tArgs: appcmd.ExactArgs(0),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tBindAddress string\n\tPort string\n\tOrigin string\n\tDisallowedHeaders []string\n\tForwardHeaders map[string]string\n\tCACert string\n\tClientCert string\n\tClientKey string\n\tServerCert string\n\tServerKey string\n\tPrivateNetwork bool\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVar(\n\t\t&f.BindAddress,\n\t\tbindFlagName,\n\t\t\"127.0.0.1\",\n\t\t\"The address to be exposed to accept HTTP requests\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.Port,\n\t\tportFlagName,\n\t\t\"8080\",\n\t\t\"The port to be exposed to accept HTTP requests\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.Origin,\n\t\toriginFlagName,\n\t\t\"https://buf.build\",\n\t\t\"The allowed origin for CORS options\",\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.DisallowedHeaders,\n\t\tdisallowedHeadersFlagName,\n\t\tnil,\n\t\t`The header names that are disallowed by this agent. When the agent receives an enveloped request with these headers set, it will return an error rather than forward the request to the target server. Multiple headers are appended if specified multiple times`,\n\t)\n\tflagSet.StringToStringVar(\n\t\t&f.ForwardHeaders,\n\t\tforwardHeadersFlagName,\n\t\tnil,\n\t\t`The headers to be forwarded via the agent to the target server. Must be an equals sign separated key-value pair (like --forward-header=fromHeader1=toHeader1). Multiple header pairs are appended if specified multiple times`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.CACert,\n\t\tcaCertFlagName,\n\t\t\"\",\n\t\t\"The CA cert to be used in the client and server TLS configuration\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.ClientCert,\n\t\tclientCertFlagName,\n\t\t\"\",\n\t\t\"The cert to be used in the client TLS configuration\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.ClientKey,\n\t\tclientKeyFlagName,\n\t\t\"\",\n\t\t\"The key to be used in the client TLS configuration\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.ServerCert,\n\t\tserverCertFlagName,\n\t\t\"\",\n\t\t\"The cert to be used in the server TLS configuration\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.ServerKey,\n\t\tserverKeyFlagName,\n\t\t\"\",\n\t\t\"The key to be used in the server TLS configuration\",\n\t)\n\tflagSet.BoolVar(\n\t\t&f.PrivateNetwork,\n\t\tprivateNetworkFlagName,\n\t\tfalse,\n\t\t`Use the agent with private network CORS`,\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\t// CA cert pool is optional. If it is nil, TLS uses the host's root CA set.\n\tvar rootCAConfig *tls.Config\n\tvar err error\n\tif flags.CACert != \"\" {\n\t\trootCAConfig, err = certclient.NewClientTLS(certclient.WithRootCertFilePaths(flags.CACert))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\t// client TLS config is optional. If it is nil, it uses the default configuration from http2.Transport.\n\tvar clientTLSConfig *tls.Config\n\tif flags.ClientCert != \"\" || flags.ClientKey != \"\" {\n\t\tclientTLSConfig, err = newTLSConfig(rootCAConfig, flags.ClientCert, flags.ClientKey)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"cannot create new client TLS config: %w\", err)\n\t\t}\n\t}\n\t// server TLS config is optional. If it is nil, we serve with a h2c handler.\n\tvar serverTLSConfig *tls.Config\n\tif flags.ServerCert != \"\" || flags.ServerKey != \"\" {\n\t\tserverTLSConfig, err = newTLSConfig(rootCAConfig, flags.ServerCert, flags.ServerKey)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"cannot create new server TLS config: %w\", err)\n\t\t}\n\t}\n\tmux := bufstudioagent.NewHandler(\n\t\tcontainer.Logger(),\n\t\tflags.Origin,\n\t\tclientTLSConfig,\n\t\txslices.ToStructMap(flags.DisallowedHeaders),\n\t\tflags.ForwardHeaders,\n\t\tflags.PrivateNetwork,\n\t)\n\tvar httpListenConfig net.ListenConfig\n\thttpListener, err := httpListenConfig.Listen(ctx, \"tcp\", fmt.Sprintf(\"%s:%s\", flags.BindAddress, flags.Port))\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn httpserver.Run(\n\t\tctx,\n\t\tcontainer.Logger(),\n\t\thttpListener,\n\t\tmux,\n\t\thttpserver.RunWithTLSConfig(\n\t\t\tserverTLSConfig,\n\t\t),\n\t)\n}\n\nfunc newTLSConfig(baseConfig *tls.Config, certFile, keyFile string) (*tls.Config, error) {\n\tconfig := baseConfig.Clone()\n\tif config == nil {\n\t\tconfig = &tls.Config{\n\t\t\tMinVersion: tls.VersionTLS12,\n\t\t}\n\t}\n\tcert, err := tls.LoadX509KeyPair(certFile, keyFile)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error creating x509 keypair from cert file %s and key file %s\", certFile, keyFile)\n\t}\n\tconfig.Certificates = []tls.Certificate{cert}\n\treturn config, nil\n}\n" }, { "path": "cmd/buf/internal/command/breaking/breaking.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage breaking\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"log/slog\"\n\t\"maps\"\n\t\"slices\"\n\n\tmodulev1 \"buf.build/gen/go/bufbuild/registry/protocolbuffers/go/buf/registry/module/v1\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/buffetch\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufregistryapi/bufregistryapimodule\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/bufbuild/buf/private/pkg/wasm\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\terrorFormatFlagName = \"error-format\"\n\texcludeImportsFlagName = \"exclude-imports\"\n\tpathsFlagName = \"path\"\n\tlimitToInputFilesFlagName = \"limit-to-input-files\"\n\tconfigFlagName = \"config\"\n\tagainstFlagName = \"against\"\n\tagainstConfigFlagName = \"against-config\"\n\tagainstRegistryFlagName = \"against-registry\"\n\texcludePathsFlagName = \"exclude-path\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" --against \",\n\t\tShort: \"Verify no breaking changes have been made\",\n\t\tLong: `This command makes sure that the location has no breaking changes compared to the location.\n\n` +\n\t\t\tbufcli.GetInputLong(`the source, module, or image to check for breaking changes`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tErrorFormat string\n\tExcludeImports bool\n\tLimitToInputFiles bool\n\tPaths []string\n\tConfig string\n\tAgainst string\n\tAgainstConfig string\n\tAgainstRegistry bool\n\tExcludePaths []string\n\tDisableSymlinks bool\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors or check violations printed to stdout. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.ExcludeImports,\n\t\texcludeImportsFlagName,\n\t\tfalse,\n\t\t\"Exclude imports from breaking change detection.\",\n\t)\n\tflagSet.BoolVar(\n\t\t&f.LimitToInputFiles,\n\t\tlimitToInputFilesFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t`Only run breaking checks against the files in the input\nWhen set, the against input contains only the files in the input\nOverrides --%s`,\n\t\t\tpathsFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.Against,\n\t\tagainstFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(\n\t\t\t`Required, except if --%s is set. The source, module, or image to check against. Must be one of format %s`,\n\t\t\tagainstRegistryFlagName,\n\t\t\tbuffetch.AllFormatsString,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.AgainstConfig,\n\t\tagainstConfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use to configure the against source, module, or image`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.AgainstRegistry,\n\t\tagainstRegistryFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t`Run breaking checks against the latest commit on the default branch in the registry. All modules in the input must have a name configured, otherwise this will fail.\nIf a remote module is not found with the configured name, then this will fail. This cannot be set with --%s.`,\n\t\t\tagainstFlagName,\n\t\t),\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tif err := validateFlags(flags); err != nil {\n\t\treturn err\n\t}\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t\tbufctl.WithFileAnnotationErrorFormat(flags.ErrorFormat),\n\t\tbufctl.WithFileAnnotationsToStdout(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\twasmRuntime, err := bufcli.NewWasmRuntime(ctx, container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer func() {\n\t\tretErr = errors.Join(retErr, wasmRuntime.Close(ctx))\n\t}()\n\t// Do not exclude imports here. bufcheck's Client requires all imports.\n\t// Use bufcheck's BreakingWithExcludeImports.\n\timageWithConfigs, checkClient, err := controller.GetTargetImageWithConfigsAndCheckClient(\n\t\tctx,\n\t\tinput,\n\t\twasmRuntime,\n\t\tbufctl.WithTargetPaths(flags.Paths, flags.ExcludePaths),\n\t\tbufctl.WithConfigOverride(flags.Config),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\t// TODO: this doesn't actually work because we're using the same file paths for both sides\n\t// of the roots change, then we're torched\n\texternalPaths := flags.Paths\n\tif flags.LimitToInputFiles {\n\t\texternalPaths, err = getExternalPathsForImages(imageWithConfigs)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tvar againstImages []bufimage.Image\n\tif flags.Against != \"\" {\n\t\t// Do not exclude imports here. bufcheck's Client requires all imports.\n\t\t// Use bufcheck's BreakingWithExcludeImports.\n\t\tagainstImagesWithConfigs, _, err := controller.GetTargetImageWithConfigsAndCheckClient(\n\t\t\tctx,\n\t\t\tflags.Against,\n\t\t\twasm.UnimplementedRuntime,\n\t\t\tbufctl.WithTargetPaths(externalPaths, flags.ExcludePaths),\n\t\t\tbufctl.WithConfigOverride(flags.AgainstConfig),\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// We do not require the check configs from the against target once built, so they can\n\t\t// be dropped here.\n\t\tagainstImages, err = xslices.MapError(\n\t\t\tagainstImagesWithConfigs,\n\t\t\tfunc(imageWithConfig bufctl.ImageWithConfig) (bufimage.Image, error) {\n\t\t\t\tagainstImage, ok := imageWithConfig.(bufimage.Image)\n\t\t\t\tif !ok {\n\t\t\t\t\treturn nil, syserror.New(\"imageWithConfig could not be converted to Image\")\n\t\t\t\t}\n\t\t\t\treturn againstImage, nil\n\t\t\t},\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tmoduleServiceProvider := bufregistryapimodule.NewClientProvider(clientConfig)\n\tif flags.AgainstRegistry {\n\t\tfor _, imageWithConfig := range imageWithConfigs {\n\t\t\tmoduleFullName := imageWithConfig.ModuleFullName()\n\t\t\tif moduleFullName == nil {\n\t\t\t\tif imageWithConfig.ModuleOpaqueID() == \"\" {\n\t\t\t\t\t// This can occur in the case of a [buffetch.MessageRef], where we resolve the message\n\t\t\t\t\t// ref directly from the bucket without building the [bufmodule.Module]. In that case,\n\t\t\t\t\t// we are unnable to use --against-registry.\n\t\t\t\t\treturn fmt.Errorf(\"cannot use --%s with unnamed module\", againstRegistryFlagName)\n\t\t\t\t}\n\t\t\t\treturn fmt.Errorf(\n\t\t\t\t\t\"cannot use --%s with unnamed module, %s\",\n\t\t\t\t\tagainstRegistryFlagName,\n\t\t\t\t\timageWithConfig.ModuleOpaqueID(),\n\t\t\t\t)\n\t\t\t}\n\t\t\t// Check commits exist for the module on the default label before we try to get the against image.\n\t\t\t// TODO: remove this check once we have error details to indicate that the against input\n\t\t\t// has no commits on the default label. We use the API directly here to avoid issues of conflating\n\t\t\t// dependency errors to empty module errors.\n\t\t\tcommitServiceClient := moduleServiceProvider.V1CommitServiceClient(moduleFullName.Registry())\n\t\t\tif _, err := commitServiceClient.GetCommits(\n\t\t\t\tctx,\n\t\t\t\tconnect.NewRequest(\n\t\t\t\t\t&modulev1.GetCommitsRequest{\n\t\t\t\t\t\tResourceRefs: []*modulev1.ResourceRef{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tValue: &modulev1.ResourceRef_Name_{\n\t\t\t\t\t\t\t\t\tName: &modulev1.ResourceRef_Name{\n\t\t\t\t\t\t\t\t\t\tOwner: moduleFullName.Owner(),\n\t\t\t\t\t\t\t\t\t\tModule: moduleFullName.Name(),\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t),\n\t\t\t); err != nil {\n\t\t\t\tif connect.CodeOf(err) == connect.CodeFailedPrecondition {\n\t\t\t\t\t// This error occurs when the against input is a module that has no commits on the default branch.\n\t\t\t\t\t// We ignore this case to support new modulues that have just been created in the registry.\n\t\t\t\t\tcontainer.Logger().DebugContext(\n\t\t\t\t\t\tctx, \"ignoring empty module without commits on the default branch\",\n\t\t\t\t\t\tslog.String(\"module\", imageWithConfig.ModuleFullName().String()),\n\t\t\t\t\t)\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tagainstImage, err := controller.GetImage(\n\t\t\t\tctx,\n\t\t\t\tmoduleFullName.String(),\n\t\t\t\tbufctl.WithTargetPaths(externalPaths, flags.ExcludePaths),\n\t\t\t\tbufctl.WithConfigOverride(flags.AgainstConfig),\n\t\t\t)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tagainstImages = append(againstImages, againstImage)\n\t\t}\n\t}\n\tif len(imageWithConfigs) != len(againstImages) {\n\t\t// In the case where the input and against workspaces do not contain the same number of\n\t\t// images, this could happen if the input contains new module(s). However, we require\n\t\t// the number of images to match because of module-specific [bufconfig.BreakingConfig].\n\t\t// This can result in a less satisfying UX when adding modules to a workspace.\n\t\t//\n\t\t// To mitigate this for users adding new modules to their workspace, for the case where\n\t\t// len(imageWithConfigs) > len(againstImages), if all modules in [imageWithConfigs] have\n\t\t// the same [bufconfig.BreakingConfig] (so no unique, module-specific [bufconfig.BreakingConfig]),\n\t\t// we query the [againstImages] for the matching modules and ignore any modules from\n\t\t// [imageWithConfigs] that are not found in [againstImages].\n\t\t//\n\t\t// In the case where len(imageWithConfigs) < len(againstImages) or there are module-specific\n\t\t// [bufconfig.BreakingConfig], we still return an error. Also, if the roots change, we're\n\t\t// torched. (Issue #3641)\n\t\tif len(imageWithConfigs) > len(againstImages) && hasNoUniqueBreakingConfig(imageWithConfigs) {\n\t\t\timageWithConfigs, err = filterImageWithConfigsNotInAgainstImages(imageWithConfigs, againstImages)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t} else {\n\t\t\treturn newInputAgainstImageCountError(len(imageWithConfigs), len(againstImages))\n\t\t}\n\t}\n\t// We add all check configs (both lint and breaking) as related configs to check if plugins\n\t// have rules configured.\n\t// We allocated twice the size of imageWithConfigs for both lint and breaking configs.\n\tallCheckConfigs := make([]bufconfig.CheckConfig, 0, len(imageWithConfigs)*2)\n\tfor _, imageWithConfig := range imageWithConfigs {\n\t\tallCheckConfigs = append(allCheckConfigs, imageWithConfig.LintConfig())\n\t\tallCheckConfigs = append(allCheckConfigs, imageWithConfig.BreakingConfig())\n\t}\n\tvar allFileAnnotations []bufanalysis.FileAnnotation\n\tfor i, imageWithConfig := range imageWithConfigs {\n\t\tbreakingOptions := []bufcheck.BreakingOption{\n\t\t\tbufcheck.WithPluginConfigs(imageWithConfig.PluginConfigs()...),\n\t\t\tbufcheck.WithPolicyConfigs(imageWithConfig.PolicyConfigs()...),\n\t\t\tbufcheck.WithRelatedCheckConfigs(allCheckConfigs...),\n\t\t}\n\t\tif flags.ExcludeImports {\n\t\t\tbreakingOptions = append(breakingOptions, bufcheck.BreakingWithExcludeImports())\n\t\t}\n\t\tif err := checkClient.Breaking(\n\t\t\tctx,\n\t\t\timageWithConfig.BreakingConfig(),\n\t\t\timageWithConfig,\n\t\t\tagainstImages[i],\n\t\t\tbreakingOptions...,\n\t\t); err != nil {\n\t\t\tvar fileAnnotationSet bufanalysis.FileAnnotationSet\n\t\t\tif errors.As(err, &fileAnnotationSet) {\n\t\t\t\tallFileAnnotations = append(allFileAnnotations, fileAnnotationSet.FileAnnotations()...)\n\t\t\t} else {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t}\n\tif len(allFileAnnotations) > 0 {\n\t\tallFileAnnotationSet := bufanalysis.NewFileAnnotationSet(allFileAnnotations...)\n\t\tif err := bufanalysis.PrintFileAnnotationSet(\n\t\t\tcontainer.Stdout(),\n\t\t\tallFileAnnotationSet,\n\t\t\tflags.ErrorFormat,\n\t\t); err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn bufctl.ErrFileAnnotation\n\t}\n\treturn nil\n}\n\nfunc getExternalPathsForImages[I bufimage.Image, S ~[]I](images S) ([]string, error) {\n\texternalPaths := make(map[string]struct{})\n\tfor _, image := range images {\n\t\tfor _, imageFile := range image.Files() {\n\t\t\texternalPaths[imageFile.ExternalPath()] = struct{}{}\n\t\t}\n\t}\n\treturn xslices.MapKeysToSlice(externalPaths), nil\n}\n\nfunc validateFlags(flags *flags) error {\n\tif flags.Against == \"\" && !flags.AgainstRegistry {\n\t\treturn fmt.Errorf(\"Must set --%s or --%s\", againstFlagName, againstRegistryFlagName)\n\t}\n\tif flags.Against != \"\" && flags.AgainstRegistry {\n\t\treturn fmt.Errorf(\"Cannot set both --%s and --%s\", againstFlagName, againstRegistryFlagName)\n\t}\n\treturn nil\n}\n\n// hasNoUniqueBreakingConfig iterates through imageWithConfigs and checks to see if there\n// are any unique [bufconfig.BreakingConfig]. It returns true if all [bufconfig.BreakingConfig]\n// are the same across all the images.\nfunc hasNoUniqueBreakingConfig(imageWithConfigs []bufctl.ImageWithConfig) bool {\n\tvar base bufconfig.BreakingConfig\n\tfor _, imageWithConfig := range imageWithConfigs {\n\t\tif base == nil {\n\t\t\tbase = imageWithConfig.BreakingConfig()\n\t\t\tcontinue\n\t\t}\n\t\tif !equalBreakingConfig(base, imageWithConfig.BreakingConfig()) {\n\t\t\treturn false\n\t\t}\n\t\tbase = imageWithConfig.BreakingConfig()\n\t}\n\treturn true\n}\n\n// Checks if the specified [bufconfig.BreakingConfig]s are equal. Returns true if both\n// [bufconfig.BreakingConfig] have the same configuration parameters.\nfunc equalBreakingConfig(breakingConfig1, breakingConfig2 bufconfig.BreakingConfig) bool {\n\tif breakingConfig1.Disabled() == breakingConfig2.Disabled() &&\n\t\tbreakingConfig1.FileVersion() == breakingConfig2.FileVersion() &&\n\t\tslices.Equal(breakingConfig1.UseIDsAndCategories(), breakingConfig2.UseIDsAndCategories()) &&\n\t\tslices.Equal(breakingConfig1.ExceptIDsAndCategories(), breakingConfig2.ExceptIDsAndCategories()) &&\n\t\tslices.Equal(breakingConfig1.IgnorePaths(), breakingConfig2.IgnorePaths()) &&\n\t\tmaps.EqualFunc(\n\t\t\tbreakingConfig1.IgnoreIDOrCategoryToPaths(),\n\t\t\tbreakingConfig2.IgnoreIDOrCategoryToPaths(),\n\t\t\tslices.Equal[[]string],\n\t\t) &&\n\t\tbreakingConfig1.DisableBuiltin() == breakingConfig2.DisableBuiltin() &&\n\t\tbreakingConfig1.IgnoreUnstablePackages() == breakingConfig2.IgnoreUnstablePackages() {\n\t\treturn true\n\t}\n\treturn false\n}\n\n// A helper function for filtering out [bufctl.ImageWithConfig]s from [imagesWithConfig]\n// if there is no corresponding image in [againstImages]. We determine this based on image\n// file path.\n//\n// This assumes that len(imageWithConfigs) > len(againstImages).\n// We also expect that each image in [againstImages] is mapped only once to a single\n// imageWithConfig in [imagesWithConfig]. If an againstImage is found, then we don't check\n// it again. We also validate that each image in [againstImages] is mapped to an imageWithConfig\n// from [imageWithConfigs].\nfunc filterImageWithConfigsNotInAgainstImages(\n\timageWithConfigs []bufctl.ImageWithConfig,\n\tagainstImages []bufimage.Image,\n) ([]bufctl.ImageWithConfig, error) {\n\tfoundAgainstImageIndices := make(map[int]struct{})\n\tvar filteredImageWithConfigs []bufctl.ImageWithConfig\n\tfor _, imageWithConfig := range imageWithConfigs {\n\t\tfor _, imageFile := range imageWithConfig.Files() {\n\t\t\tif imageFile.IsImport() {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tvar foundImage bufimage.Image\n\t\t\tfor i, againstImage := range againstImages {\n\t\t\t\tif _, ok := foundAgainstImageIndices[i]; ok {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tif againstFile := againstImage.GetFile(imageFile.Path()); againstFile != nil && !againstFile.IsImport() {\n\t\t\t\t\tfoundAgainstImageIndices[i] = struct{}{}\n\t\t\t\t\tfoundImage = againstImage\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t\tif foundImage != nil {\n\t\t\t\tfilteredImageWithConfigs = append(filteredImageWithConfigs, imageWithConfig)\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\t// If we are unsuccessful in mapping all againstImages to a unique imageWithConfig, then\n\t// we return the same error message.\n\tif len(foundAgainstImageIndices) != len(againstImages) || len(againstImages) != len(filteredImageWithConfigs) {\n\t\treturn nil, newInputAgainstImageCountError(len(imageWithConfigs), len(againstImages))\n\t}\n\treturn filteredImageWithConfigs, nil\n}\n\nfunc newInputAgainstImageCountError(lenImageWithConfigs, lenAgainstImages int) error {\n\treturn fmt.Errorf(\n\t\t\"input contained %d images, whereas against contained %d images\",\n\t\tlenImageWithConfigs,\n\t\tlenAgainstImages,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/breaking/breaking_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage breaking\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appcmd/appcmdtesting\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/internaltesting\"\n)\n\n// TestBreakingWorkspaceNewModuleWithImport tests that adding a new module to a\n// workspace does not produce false breaking change errors when the new module\n// imports files from an existing module.\n//\n// This is a regression test for the case where the new module's imported files\n// cause filterImageWithConfigsNotInAgainstImages to incorrectly match the new\n// module to an existing against image, stealing the match from the module that\n// actually owns those files.\nfunc TestBreakingWorkspaceNewModuleWithImport(t *testing.T) {\n\tt.Parallel()\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t\"\",\n\t\t\"\",\n\t\tfilepath.Join(\"testdata\", \"workspace_new_module\", \"head\"),\n\t\t\"--against\",\n\t\tfilepath.Join(\"testdata\", \"workspace_new_module\", \"against\"),\n\t)\n}\n\nfunc testRunStdoutStderr(\n\tt *testing.T,\n\tstdin io.Reader,\n\texpectedExitCode int,\n\texpectedStdout string,\n\texpectedStderr string,\n\targs ...string,\n) {\n\tt.Helper()\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(\n\t\t\t\t\tname,\n\t\t\t\t\tappext.BuilderWithInterceptor(\n\t\t\t\t\t\tfunc(next func(context.Context, appext.Container) error) func(context.Context, appext.Container) error {\n\t\t\t\t\t\t\treturn func(ctx context.Context, container appext.Container) error {\n\t\t\t\t\t\t\t\terr := next(ctx, container)\n\t\t\t\t\t\t\t\tif err == nil {\n\t\t\t\t\t\t\t\t\treturn nil\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\treturn fmt.Errorf(\"Failure: %w\", err)\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t),\n\t\t\t\t),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStdout(expectedStdout),\n\t\tappcmdtesting.WithExpectedStderr(expectedStderr),\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/breaking/testdata/workspace_new_module/against/b/b.proto", "content": "syntax = \"proto3\";\n\npackage b.v1;\n\nmessage Bar {\n string name = 1;\n}\n" }, { "path": "cmd/buf/internal/command/breaking/testdata/workspace_new_module/against/buf.yaml", "content": "version: v2\nmodules:\n - path: b\n - path: c\n" }, { "path": "cmd/buf/internal/command/breaking/testdata/workspace_new_module/against/c/c.proto", "content": "syntax = \"proto3\";\n\npackage c.v1;\n\nmessage Baz {\n string name = 1;\n}\n" }, { "path": "cmd/buf/internal/command/breaking/testdata/workspace_new_module/head/a/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nimport \"c.proto\";\n\nmessage Foo {\n c.v1.Baz baz = 1;\n}\n" }, { "path": "cmd/buf/internal/command/breaking/testdata/workspace_new_module/head/b/b.proto", "content": "syntax = \"proto3\";\n\npackage b.v1;\n\nmessage Bar {\n string name = 1;\n}\n" }, { "path": "cmd/buf/internal/command/breaking/testdata/workspace_new_module/head/buf.yaml", "content": "version: v2\nmodules:\n - path: a\n - path: b\n - path: c\n" }, { "path": "cmd/buf/internal/command/breaking/testdata/workspace_new_module/head/c/c.proto", "content": "syntax = \"proto3\";\n\npackage c.v1;\n\nmessage Baz {\n string name = 1;\n}\n" }, { "path": "cmd/buf/internal/command/build/build.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage build\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/buffetch\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage/bufimageutil\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tasFileDescriptorSetFlagName = \"as-file-descriptor-set\"\n\terrorFormatFlagName = \"error-format\"\n\texcludeImportsFlagName = \"exclude-imports\"\n\texcludeSourceInfoFlagName = \"exclude-source-info\"\n\texcludeSourceRetentionOptionsFlagName = \"exclude-source-retention-options\"\n\tpathsFlagName = \"path\"\n\toutputFlagName = \"output\"\n\toutputFlagShortName = \"o\"\n\tconfigFlagName = \"config\"\n\texcludePathsFlagName = \"exclude-path\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\ttypeFlagName = \"type\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Build Protobuf files into a Buf image\",\n\t\tLong: bufcli.GetInputLong(`the source or module to build or image to convert`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tAsFileDescriptorSet bool\n\tErrorFormat string\n\tExcludeImports bool\n\tExcludeSourceInfo bool\n\tExcludeSourceRetentionOptions bool\n\tPaths []string\n\tOutput string\n\tConfig string\n\tExcludePaths []string\n\tDisableSymlinks bool\n\tTypes []string\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindAsFileDescriptorSet(flagSet, &f.AsFileDescriptorSet, asFileDescriptorSetFlagName)\n\tbufcli.BindExcludeImports(flagSet, &f.ExcludeImports, excludeImportsFlagName)\n\tbufcli.BindExcludeSourceInfo(flagSet, &f.ExcludeSourceInfo, excludeSourceInfoFlagName)\n\tbufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)\n\tbufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.BoolVar(\n\t\t&f.ExcludeSourceRetentionOptions,\n\t\texcludeSourceRetentionOptionsFlagName,\n\t\tfalse,\n\t\t\"Exclude options whose retention is source\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors printed to stderr. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVarP(\n\t\t&f.Output,\n\t\toutputFlagName,\n\t\toutputFlagShortName,\n\t\tapp.DevNullFilePath,\n\t\tfmt.Sprintf(\n\t\t\t`The output location for the built image. Must be one of format %s`,\n\t\t\tbuffetch.MessageFormatsString,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration`,\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.Types,\n\t\ttypeFlagName,\n\t\tnil,\n\t\t\"The types (package, message, enum, extension, service, method) that should be included in this image. When specified, the resulting image will only include descriptors to describe the requested types\",\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tif err := bufcli.ValidateRequiredFlag(outputFlagName, flags.Output); err != nil {\n\t\treturn err\n\t}\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t\tbufctl.WithFileAnnotationErrorFormat(flags.ErrorFormat),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\timage, err := controller.GetImage(\n\t\tctx,\n\t\tinput,\n\t\tbufctl.WithTargetPaths(flags.Paths, flags.ExcludePaths),\n\t\tbufctl.WithImageExcludeSourceInfo(flags.ExcludeSourceInfo),\n\t\tbufctl.WithImageExcludeImports(flags.ExcludeImports),\n\t\tbufctl.WithImageIncludeTypes(flags.Types),\n\t\tbufctl.WithConfigOverride(flags.Config),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif flags.ExcludeSourceRetentionOptions {\n\t\timage, err = bufimageutil.StripSourceRetentionOptions(image)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn controller.PutImage(\n\t\tctx,\n\t\tflags.Output,\n\t\timage,\n\t\tbufctl.WithImageAsFileDescriptorSet(flags.AsFileDescriptorSet),\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/config/configinit/configinit.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage configinit\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tdocumentationCommentsFlagName = \"doc\"\n\toutDirPathFlagName = \"output\"\n\toutDirPathFlagShortName = \"o\"\n\tuncommentFlagName = \"uncomment\"\n)\n\n// NewCommand returns a new init Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n\tdeprecated string,\n\thidden bool,\n\tbindOldFlags bool,\n) *appcmd.Command {\n\tflags := newFlags(bindOldFlags)\n\treturn &appcmd.Command{\n\t\tUse: name + \" [buf.build/owner/foobar]\",\n\t\tShort: \"Initialize buf configuration files for your local development\",\n\t\tLong: `This command will write a new buf.yaml file to start your local development.\n\nIf a buf.yaml already exists, this command will not overwrite it, and will produce an error.\n\nThe effects of this command may change over time - this command may initialize i.e. buf.gen.yaml files in the future.`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tDeprecated: deprecated,\n\t\tHidden: hidden,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tOutDirPath string\n\n\t// Hidden.\n\tDocumentationComments bool\n\t// Hidden.\n\tUncomment bool\n\n\tbindOldFlags bool\n}\n\nfunc newFlags(bindOldFlags bool) *flags {\n\treturn &flags{\n\t\tbindOldFlags: bindOldFlags,\n\t}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVarP(\n\t\t&f.OutDirPath,\n\t\toutDirPathFlagName,\n\t\toutDirPathFlagShortName,\n\t\t\".\",\n\t\t`The directory to write the configuration files to`,\n\t)\n\tif f.bindOldFlags {\n\t\t// TODO FUTURE: Bring this flag back in future versions if we decide it's important.\n\t\t// We're not breaking anyone by not actually producing comments for now.\n\t\tflagSet.BoolVar(\n\t\t\t&f.DocumentationComments,\n\t\t\tdocumentationCommentsFlagName,\n\t\t\tfalse,\n\t\t\t\"Write inline documentation in the form of comments in the resulting configuration file\",\n\t\t)\n\t\t_ = flagSet.MarkHidden(documentationCommentsFlagName)\n\t\tflagSet.BoolVar(\n\t\t\t&f.Uncomment,\n\t\t\tuncommentFlagName,\n\t\t\tfalse,\n\t\t\t\"Uncomment examples in the resulting configuration file\",\n\t\t)\n\t\t_ = flagSet.MarkHidden(uncommentFlagName)\n\t}\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tif err := bufcli.ValidateRequiredFlag(outDirPathFlagName, flags.OutDirPath); err != nil {\n\t\treturn err\n\t}\n\texists, err := bufcli.BufYAMLFileExistsForDirPath(ctx, flags.OutDirPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif exists {\n\t\treturn fmt.Errorf(\"buf.yaml already exists in directory %s, will not overwrite\", flags.OutDirPath)\n\t}\n\n\tfileVersion := bufconfig.FileVersionV2\n\tvar moduleFullName bufparse.FullName\n\tif container.NumArgs() > 0 {\n\t\tmoduleFullName, err = bufparse.ParseFullName(container.Arg(0))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\tmoduleConfig, err := bufconfig.NewModuleConfig(\n\t\t\".\",\n\t\tmoduleFullName,\n\t\t// The default (empty) value for rootToIncludes and rootToExcludes only has key \".\".\n\t\tmap[string][]string{\n\t\t\t\".\": {},\n\t\t},\n\t\tmap[string][]string{\n\t\t\t\".\": {},\n\t\t},\n\t\tbufconfig.NewLintConfig(\n\t\t\tbufconfig.NewEnabledCheckConfigForUseIDsAndCategories(\n\t\t\t\tfileVersion,\n\t\t\t\t[]string{\"STANDARD\"},\n\t\t\t\tfalse,\n\t\t\t),\n\t\t\t\"\",\n\t\t\tfalse,\n\t\t\tfalse,\n\t\t\tfalse,\n\t\t\t\"\",\n\t\t\t// We actually want comment ignores enabled by default\n\t\t\ttrue,\n\t\t),\n\t\tbufconfig.NewBreakingConfig(\n\t\t\tbufconfig.NewEnabledCheckConfigForUseIDsAndCategories(\n\t\t\t\tfileVersion,\n\t\t\t\t[]string{\"FILE\"},\n\t\t\t\tfalse,\n\t\t\t),\n\t\t\tfalse,\n\t\t),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tbufYAMLFile, err := bufconfig.NewBufYAMLFile(\n\t\tfileVersion,\n\t\t[]bufconfig.ModuleConfig{\n\t\t\tmoduleConfig,\n\t\t},\n\t\tnil,\n\t\tnil,\n\t\tnil,\n\t\tbufconfig.BufYAMLFileWithIncludeDocsLink(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn bufcli.PutBufYAMLFileForDirPath(ctx, flags.OutDirPath, bufYAMLFile)\n}\n" }, { "path": "cmd/buf/internal/command/config/configlsbreakingrules/configlsbreakingrules.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage configlsbreakingrules\n\nimport (\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/config/internal\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\treturn internal.NewLSCommand(\n\t\tname,\n\t\tbuilder,\n\t\tcheck.RuleTypeBreaking,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/config/configlslintrules/configlslintrules.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage configlslintrules\n\nimport (\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/config/internal\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\treturn internal.NewLSCommand(\n\t\tname,\n\t\tbuilder,\n\t\tcheck.RuleTypeLint,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/config/configlsmodules/configlsmodules.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage configlsmodules\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io/fs\"\n\t\"sort\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/pkg/normalpath\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tconfigFlagName = \"config\"\n\tformatFlagName = \"format\"\n\n\tformatPath = \"path\"\n\tformatName = \"name\"\n\tformatJSON = \"json\"\n\n\tdefaultFormat = formatPath\n)\n\nvar (\n\tallFormats = []string{\n\t\tformatPath,\n\t\tformatName,\n\t\tformatJSON,\n\t}\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"List configured modules\",\n\t\tArgs: appcmd.NoArgs,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tConfig string\n\tFormat string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration.`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\tdefaultFormat,\n\t\tfmt.Sprintf(\n\t\t\t\"The format to print rules as. Must be one of %s\",\n\t\t\txstrings.SliceToString(allFormats),\n\t\t),\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\texternalModules, err := getExternalModules(ctx, flags.Config)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn printExternalModules(ctx, container, flags.Format, externalModules)\n}\n\nfunc getExternalModules(\n\tctx context.Context,\n\tconfigOverride string,\n) ([]*externalModule, error) {\n\t// If an override is specified, read buf.yaml from it.\n\tif configOverride != \"\" {\n\t\tbufYAMLFile, err := bufconfig.GetBufYAMLFileForOverride(configOverride)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn getExternalModulesForBufYAMLFile(ctx, bufYAMLFile)\n\t}\n\t// First, look for a buf.work.yaml file.\n\tbufWorkYAMLFile, err := bufcli.GetBufWorkYAMLFileForDirPath(ctx, \".\")\n\tif err != nil {\n\t\tif !errors.Is(err, fs.ErrNotExist) {\n\t\t\treturn nil, err\n\t\t}\n\t\t// We do not have a buf.work.yaml file, attempt to read a buf.yaml file.\n\t\tbufYAMLFile, err := bufcli.GetBufYAMLFileForDirPath(ctx, \".\")\n\t\tif err != nil {\n\t\t\tif !errors.Is(err, fs.ErrNotExist) {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\t// We do not have a buf.work.yaml or buf.yaml file, use the default.\n\t\t\tbufYAMLFile, err = bufconfig.NewBufYAMLFile(\n\t\t\t\tbufconfig.FileVersionV2,\n\t\t\t\t[]bufconfig.ModuleConfig{\n\t\t\t\t\tbufconfig.DefaultModuleConfigV2,\n\t\t\t\t},\n\t\t\t\tnil,\n\t\t\t\tnil,\n\t\t\t\tnil,\n\t\t\t)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t}\n\t\t// This handles both buf.yaml file and no file courtesy of the above logic.\n\t\treturn getExternalModulesForBufYAMLFile(ctx, bufYAMLFile)\n\t}\n\t// We did have a buf.work.yaml file, but before handling it, check there is not a buf.yaml.\n\t_, err = bufcli.GetBufYAMLFileForDirPath(ctx, \".\")\n\tif err != nil && !errors.Is(err, fs.ErrNotExist) {\n\t\treturn nil, err\n\t}\n\tif err == nil {\n\t\treturn nil, errors.New(\"Both buf.work.yaml and buf.yaml found. It is not valid to have a buf.work.yaml and buf.yaml in the same directory, buf.work.yaml specifies a workspace of modules, while buf.yaml either specifies a single module or a workspace of modules itself.\")\n\t}\n\t// Handle the buf.work.yaml.\n\treturn getExternalModulesForBufWorkYAMLFile(ctx, bufWorkYAMLFile)\n}\n\n// This preserves directory order from the bufWorkYAMLFile.\nfunc getExternalModulesForBufWorkYAMLFile(\n\tctx context.Context,\n\tbufWorkYAMLFile bufconfig.BufWorkYAMLFile,\n) ([]*externalModule, error) {\n\tvar externalModules []*externalModule\n\tfor _, dirPath := range bufWorkYAMLFile.DirPaths() {\n\t\tbufYAMLFile, err := bufcli.GetBufYAMLFileForDirPath(ctx, dirPath)\n\t\tif err != nil {\n\t\t\tif !errors.Is(err, fs.ErrNotExist) {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\texternalModules = append(\n\t\t\t\texternalModules,\n\t\t\t\tnewExternalModule(dirPath, nil, nil, \"\"),\n\t\t\t)\n\t\t\tcontinue\n\t\t}\n\t\t// This is a sanity check. Make sure we have what we expect.\n\t\tswitch bufYAMLFile.FileVersion() {\n\t\tcase bufconfig.FileVersionV1Beta1, bufconfig.FileVersionV1:\n\t\t\tmoduleConfigs := bufYAMLFile.ModuleConfigs()\n\t\t\tif len(moduleConfigs) != 1 {\n\t\t\t\treturn nil, syserror.Newf(\"got BufYAMLFile at %q with FileVersion %v with %d ModuleConfigs\", dirPath, bufYAMLFile.FileVersion(), len(moduleConfigs))\n\t\t\t}\n\t\t\tmoduleConfig := moduleConfigs[0]\n\t\t\tif moduleConfig.DirPath() != \".\" {\n\t\t\t\treturn nil, syserror.Newf(\"got BufYAMLFile at %q with FileVersion %v with ModuleConfig that had non-root DirPath %q\", dirPath, bufYAMLFile.FileVersion(), moduleConfig.DirPath())\n\t\t\t}\n\t\t\tvar name string\n\t\t\tif moduleFullName := moduleConfig.FullName(); moduleFullName != nil {\n\t\t\t\tname = moduleFullName.String()\n\t\t\t}\n\t\t\tincludes := xslices.Map(moduleConfig.RootToIncludes()[\".\"], func(include string) string { return normalpath.Join(dirPath, include) })\n\t\t\texcludes := xslices.Map(moduleConfig.RootToExcludes()[\".\"], func(exclude string) string { return normalpath.Join(dirPath, exclude) })\n\t\t\texternalModules = append(\n\t\t\t\texternalModules,\n\t\t\t\t// The dirPath is the path specified in the buf.work.yaml.\n\t\t\t\t// The DirPath for v1/v1beta1 ModuleConfigs is always \".\".\n\t\t\t\tnewExternalModule(dirPath, includes, excludes, name),\n\t\t\t)\n\t\tcase bufconfig.FileVersionV2:\n\t\t\treturn nil, fmt.Errorf(\"buf.work.yaml pointed to directory %q which has a v2 buf.yaml file\", dirPath)\n\t\tdefault:\n\t\t\treturn nil, syserror.Newf(\"unknown FileVersion: %v\", bufYAMLFile.FileVersion())\n\t\t}\n\t}\n\treturn externalModules, nil\n}\n\n// This preserves module config order from the bufYAMLFile.\nfunc getExternalModulesForBufYAMLFile(\n\tctx context.Context,\n\tbufYAMLFile bufconfig.BufYAMLFile,\n) ([]*externalModule, error) {\n\tmoduleConfigs := bufYAMLFile.ModuleConfigs()\n\texternalModules := make([]*externalModule, len(moduleConfigs))\n\tfor i, moduleConfig := range moduleConfigs {\n\t\tvar name string\n\t\tif moduleFullName := moduleConfig.FullName(); moduleFullName != nil {\n\t\t\tname = moduleFullName.String()\n\t\t}\n\t\tdirPath := moduleConfig.DirPath()\n\t\tincludes := xslices.Map(moduleConfig.RootToIncludes()[\".\"], func(include string) string { return normalpath.Join(dirPath, include) })\n\t\texcludes := xslices.Map(moduleConfig.RootToExcludes()[\".\"], func(exclude string) string { return normalpath.Join(dirPath, exclude) })\n\t\texternalModules[i] = newExternalModule(dirPath, includes, excludes, name)\n\t}\n\treturn externalModules, nil\n}\n\nfunc printExternalModules(\n\tctx context.Context,\n\tcontainer app.StdoutContainer,\n\tformat string,\n\texternalModules []*externalModule,\n) error {\n\tswitch format {\n\tcase formatPath:\n\t\t// Two modules may have the same path, SliceStable breaks the tie with the original ordering.\n\t\tsort.SliceStable(\n\t\t\texternalModules,\n\t\t\tfunc(i int, j int) bool {\n\t\t\t\treturn externalModules[i].Path < externalModules[j].Path\n\t\t\t},\n\t\t)\n\t\tfor _, externalModule := range externalModules {\n\t\t\tif _, err := container.Stdout().Write([]byte(externalModule.Path + \"\\n\")); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\treturn nil\n\tcase formatName:\n\t\tsort.Slice(\n\t\t\texternalModules,\n\t\t\tfunc(i int, j int) bool {\n\t\t\t\treturn externalModules[i].Name < externalModules[j].Name\n\t\t\t},\n\t\t)\n\t\tfor _, externalModule := range externalModules {\n\t\t\tif externalModule.Name == \"\" {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif _, err := container.Stdout().Write([]byte(externalModule.Name + \"\\n\")); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\treturn nil\n\tcase formatJSON:\n\t\t// Two modules may have the same path, SliceStable breaks the tie with the original ordering.\n\t\tsort.SliceStable(\n\t\t\texternalModules,\n\t\t\tfunc(i int, j int) bool {\n\t\t\t\treturn externalModules[i].Path < externalModules[j].Path\n\t\t\t},\n\t\t)\n\t\tfor _, externalModule := range externalModules {\n\t\t\tdata, err := json.Marshal(externalModule)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tif _, err := container.Stdout().Write([]byte(string(data) + \"\\n\")); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\treturn nil\n\tdefault:\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"unknown value for --%s: %s\", formatFlagName, format)\n\t}\n}\n\ntype externalModule struct {\n\tPath string `json:\"path,omitempty\" yaml:\"path,omitempty\"`\n\tIncludes []string `json:\"includes,omitempty\" yaml:\"includes,omitempty\"`\n\tExcludes []string `json:\"excludes,omitempty\" yaml:\"excludes,omitempty\"`\n\tName string `json:\"name,omitempty\" yaml:\"name,omitempty\"`\n}\n\nfunc newExternalModule(path string, includes []string, excludes []string, name string) *externalModule {\n\treturn &externalModule{\n\t\tPath: path,\n\t\tIncludes: includes,\n\t\tExcludes: excludes,\n\t\tName: name,\n\t}\n}\n" }, { "path": "cmd/buf/internal/command/config/configmigrate/configmigrate.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage configmigrate\n\nimport (\n\t\"context\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufmigrate\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tworkspaceDirectoriesFlagName = \"workspace\"\n\tmoduleDirectoriesFlagName = \"module\"\n\tbufGenYAMLFilePathFlagName = \"buf-gen-yaml\"\n\tdiffFlagName = \"diff\"\n\tdiffFlagShortName = \"d\"\n)\n\n// ignoreDirPaths are paths we ignore when calling MigrateAll or DiffAll.\n//\n// This is just a hardcoded list for the 99% case. If users actually want to migrate files in one\n// of these locations, they can use the flags, but typically we do not want to pick these up.\nvar ignoreDirPaths = []string{\n\t\".git\",\n\t\".github\",\n}\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: `Migrate all buf.yaml, buf.work.yaml, buf.gen.yaml, and buf.lock files at the specified directories or paths to v2`,\n\t\tLong: `If no flags are specified, the current directory is searched for buf.yamls, buf.work.yamls, and buf.gen.yamls.\n\nThe effects of this command may change over time `,\n\t\tArgs: appcmd.MaximumNArgs(0),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tWorkspaceDirPaths []string\n\tModuleDirPaths []string\n\tBufGenYAMLFilePaths []string\n\tDiff bool\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringSliceVar(\n\t\t&f.WorkspaceDirPaths,\n\t\tworkspaceDirectoriesFlagName,\n\t\tnil,\n\t\t\"The workspace directories to migrate. buf.work.yaml, buf.yamls and buf.locks will be migrated\",\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.ModuleDirPaths,\n\t\tmoduleDirectoriesFlagName,\n\t\tnil,\n\t\t\"The module directories to migrate. buf.yaml and buf.lock will be migrated\",\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.BufGenYAMLFilePaths,\n\t\tbufGenYAMLFilePathFlagName,\n\t\tnil,\n\t\t\"The paths to the buf.gen.yaml generation templates to migrate\",\n\t)\n\tflagSet.BoolVarP(\n\t\t&f.Diff,\n\t\tdiffFlagName,\n\t\tdiffFlagShortName,\n\t\tfalse,\n\t\t\"Write a diff to stdout instead of migrating files on disk. Useful for performing a dry run.\",\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tmoduleKeyProvider, err := bufcli.NewModuleKeyProvider(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tcommitProvider, err := bufcli.NewCommitProvider(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tbucket, err := storageos.NewProvider(storageos.ProviderWithSymlinks()).NewReadWriteBucket(\n\t\t\".\",\n\t\tstorageos.ReadWriteBucketWithSymlinksIfSupported(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tmigrator := bufmigrate.NewMigrator(\n\t\tcontainer.Logger(),\n\t\tmoduleKeyProvider,\n\t\tcommitProvider,\n\t)\n\tall := len(flags.WorkspaceDirPaths) == 0 && len(flags.ModuleDirPaths) == 0 && len(flags.BufGenYAMLFilePaths) == 0\n\tif flags.Diff {\n\t\tif all {\n\t\t\treturn bufmigrate.DiffAll(\n\t\t\t\tctx,\n\t\t\t\tmigrator,\n\t\t\t\tbucket,\n\t\t\t\tcontainer.Stdout(),\n\t\t\t\tignoreDirPaths,\n\t\t\t)\n\t\t}\n\t\treturn migrator.Diff(\n\t\t\tctx,\n\t\t\tbucket,\n\t\t\tcontainer.Stdout(),\n\t\t\tflags.WorkspaceDirPaths,\n\t\t\tflags.ModuleDirPaths,\n\t\t\tflags.BufGenYAMLFilePaths,\n\t\t)\n\t}\n\tif all {\n\t\treturn bufmigrate.MigrateAll(\n\t\t\tctx,\n\t\t\tmigrator,\n\t\t\tbucket,\n\t\t\tignoreDirPaths,\n\t\t)\n\t}\n\treturn migrator.Migrate(\n\t\tctx,\n\t\tbucket,\n\t\tflags.WorkspaceDirPaths,\n\t\tflags.ModuleDirPaths,\n\t\tflags.BufGenYAMLFilePaths,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/config/configmigrate/configmigrate_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage configmigrate\n\nimport (\n\t\"bytes\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appcmd/appcmdtesting\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/internaltesting\"\n\t\"github.com/bufbuild/buf/private/pkg/osext\"\n\t\"github.com/bufbuild/buf/private/pkg/storage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestConfigMigrateV1DefaultConfig(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\ttestCompareConfigMigrate(t, \"testdata/defaultv1\", 0, \"\")\n}\n\nfunc TestConfigMigrateV1BetaV1DefaultConfig(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\ttestCompareConfigMigrate(t, \"testdata/defaultv1beta1\", 0, \"\")\n}\n\nfunc TestConfigMigrateUnknownVersion(t *testing.T) {\n\t// Cannot be parallel since we chdir.\n\ttestCompareConfigMigrate(t, \"testdata/unknown\", 1, \"decode buf.yaml: \\\"version\\\" is not set. Please add \\\"version: v2\\\"\")\n}\n\nfunc testCompareConfigMigrate(t *testing.T, dir string, expectCode int, expectStderr string) {\n\t// Setup temporary bucket with input, then compare it to the output.\n\tstorageosProvider := storageos.NewProvider()\n\tinputBucket, err := storageosProvider.NewReadWriteBucket(filepath.Join(dir, \"input\"))\n\trequire.NoError(t, err)\n\ttempDir := t.TempDir()\n\ttempBucket, err := storageosProvider.NewReadWriteBucket(tempDir)\n\trequire.NoError(t, err)\n\tctx := t.Context()\n\t_, err = storage.Copy(ctx, inputBucket, tempBucket)\n\trequire.NoError(t, err)\n\tvar outputBucket storage.ReadWriteBucket\n\tif expectCode == 0 {\n\t\toutputBucket, err = storageosProvider.NewReadWriteBucket(filepath.Join(dir, \"output\"))\n\t\trequire.NoError(t, err)\n\t}\n\t// Run in the temp directory.\n\tfunc() {\n\t\tpwd, err := osext.Getwd()\n\t\trequire.NoError(t, err)\n\t\trequire.NoError(t, osext.Chdir(tempDir))\n\t\tdefer func() {\n\t\t\tr := recover()\n\t\t\tassert.NoError(t, osext.Chdir(pwd))\n\t\t\tif r != nil {\n\t\t\t\tpanic(r)\n\t\t\t}\n\t\t}()\n\t\tappcmdtesting.Run(\n\t\t\tt,\n\t\t\tfunc(use string) *appcmd.Command {\n\t\t\t\treturn NewCommand(use, appext.NewBuilder(use))\n\t\t\t},\n\t\t\tappcmdtesting.WithExpectedExitCode(expectCode),\n\t\t\tappcmdtesting.WithExpectedStderr(expectStderr),\n\t\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\t)\n\t}()\n\tif expectCode != 0 {\n\t\treturn // Nothing to compare.\n\t}\n\tvar diff bytes.Buffer\n\trequire.NoError(t, storage.Diff(ctx, &diff, outputBucket, tempBucket))\n\tassert.Empty(t, diff.String())\n}\n" }, { "path": "cmd/buf/internal/command/config/configmigrate/testdata/defaultv1/input/buf.yaml", "content": "version: v1\nname: \"\"\ndeps: []\nbuild:\n excludes: []\nlint:\n use:\n - STANDARD\n except: []\n ignore: []\n ignore_only: {}\n allow_comment_ignores: false\n enum_zero_value_suffix: _UNSPECIFIED\n rpc_allow_same_request_response: false\n rpc_allow_google_protobuf_empty_requests: false\n rpc_allow_google_protobuf_empty_responses: false\n service_suffix: Service\nbreaking:\n use:\n - FILE\n except: []\n ignore: []\n ignore_only: {}\n ignore_unstable_packages: false\n" }, { "path": "cmd/buf/internal/command/config/configmigrate/testdata/defaultv1/output/buf.yaml", "content": "version: v2\nlint:\n use:\n - STANDARD\n except:\n - FIELD_NOT_REQUIRED\n - PACKAGE_NO_IMPORT_CYCLE\n enum_zero_value_suffix: _UNSPECIFIED\n service_suffix: Service\n disallow_comment_ignores: true\nbreaking:\n use:\n - FILE\n except:\n - EXTENSION_NO_DELETE\n - FIELD_SAME_DEFAULT\n" }, { "path": "cmd/buf/internal/command/config/configmigrate/testdata/defaultv1beta1/input/buf.yaml", "content": "version: v1beta1\nname: \"\"\ndeps: []\nbuild:\n roots:\n - .\n excludes: []\nlint:\n use:\n - STANDARD\n enum_zero_value_suffix: _UNSPECIFIED\n rpc_allow_same_request_response: false\n rpc_allow_google_protobuf_empty_requests: false\n rpc_allow_google_protobuf_empty_responses: false\n service_suffix: Service\nbreaking:\n use:\n - FILE\n" }, { "path": "cmd/buf/internal/command/config/configmigrate/testdata/defaultv1beta1/output/buf.yaml", "content": "version: v2\nlint:\n use:\n - STANDARD\n except:\n - ENUM_FIRST_VALUE_ZERO\n - FIELD_NOT_REQUIRED\n - IMPORT_USED\n - PACKAGE_NO_IMPORT_CYCLE\n - PROTOVALIDATE\n - SYNTAX_SPECIFIED\n enum_zero_value_suffix: _UNSPECIFIED\n service_suffix: Service\n disallow_comment_ignores: true\nbreaking:\n use:\n - FILE\n except:\n - EXTENSION_NO_DELETE\n - FIELD_SAME_DEFAULT\n" }, { "path": "cmd/buf/internal/command/config/configmigrate/testdata/unknown/input/buf.yaml", "content": "name: \"empty\"\n" }, { "path": "cmd/buf/internal/command/config/internal/internal.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage internal\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io/fs\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/pkg/normalpath\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tconfiguredOnlyFlagName = \"configured-only\"\n\tconfigFlagName = \"config\"\n\tincludeDeprecatedFlagName = \"include-deprecated\"\n\tformatFlagName = \"format\"\n\tversionFlagName = \"version\"\n\tmodulePathFlagName = \"module-path\"\n)\n\n// NewLSCommand returns a new ls Command.\nfunc NewLSCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n\truleType check.RuleType,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: fmt.Sprintf(\"List %s rules\", ruleType.String()),\n\t\tArgs: appcmd.NoArgs,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn lsRun(\n\t\t\t\t\tctx,\n\t\t\t\t\tcontainer,\n\t\t\t\t\tflags,\n\t\t\t\t\tname,\n\t\t\t\t\truleType,\n\t\t\t\t)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tConfiguredOnly bool\n\tConfig string\n\tIncludeDeprecated bool\n\tFormat string\n\tVersion string\n\tModulePath string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.BoolVar(\n\t\t&f.ConfiguredOnly,\n\t\tconfiguredOnlyFlagName,\n\t\tfalse,\n\t\t\"List rules that are configured instead of listing all available rules\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(\n\t\t\t`The buf.yaml file or data to use for configuration. --%s must be set`,\n\t\t\tconfiguredOnlyFlagName,\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.IncludeDeprecated,\n\t\tincludeDeprecatedFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t`Also print deprecated rules. Has no effect if --%s is set.`,\n\t\t\tconfiguredOnlyFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format to print rules as. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufcli.AllRuleFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Version,\n\t\tversionFlagName,\n\t\t\"\", // do not set a default as we need to know if this is unset\n\t\tfmt.Sprintf(\n\t\t\t\"List all the rules for the given configuration version. By default, the version in the buf.yaml in the current directory is used, or the latest version otherwise (currently v2). Cannot be set if --%s is set. Must be one of %s\",\n\t\t\tconfiguredOnlyFlagName,\n\t\t\txslices.Map(\n\t\t\t\tbufconfig.AllFileVersions,\n\t\t\t\tfunc(fileVersion bufconfig.FileVersion) string {\n\t\t\t\t\treturn fileVersion.String()\n\t\t\t\t},\n\t\t\t),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.ModulePath,\n\t\tmodulePathFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(\n\t\t\t\"The path to the specific module to list configured rules for as specified in the buf.yaml. If the buf.yaml has more than one module defined, this must be set. --%s must be set\",\n\t\t\tconfiguredOnlyFlagName,\n\t\t),\n\t)\n}\n\nfunc lsRun(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n\tcommandName string,\n\truleType check.RuleType,\n) (retErr error) {\n\tif flags.ConfiguredOnly {\n\t\tif flags.Version != \"\" {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s cannot be specified if --%s is specified\", versionFlagName, configFlagName)\n\t\t}\n\t} else {\n\t\tif flags.Config != \"\" {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be set if --%s is specified\", configuredOnlyFlagName, configFlagName)\n\t\t}\n\t\tif flags.ModulePath != \"\" {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be set if --%s is specified\", configuredOnlyFlagName, modulePathFlagName)\n\t\t}\n\t}\n\tconfigOverride := flags.Config\n\tif flags.Version != \"\" {\n\t\tconfigOverride = fmt.Sprintf(`{\"version\":\"%s\"}`, flags.Version)\n\t}\n\tbufYAMLFile, err := bufcli.GetBufYAMLFileForDirPathOrOverride(ctx, \".\", configOverride)\n\tif err != nil {\n\t\tif !errors.Is(err, fs.ErrNotExist) {\n\t\t\treturn err\n\t\t}\n\t\tbufYAMLFile, err = bufconfig.NewBufYAMLFile(\n\t\t\tbufconfig.FileVersionV2,\n\t\t\t[]bufconfig.ModuleConfig{\n\t\t\t\tbufconfig.DefaultModuleConfigV2,\n\t\t\t},\n\t\t\tnil,\n\t\t\tnil,\n\t\t\tnil,\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\twasmRuntime, err := bufcli.NewWasmRuntime(ctx, container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer func() {\n\t\tretErr = errors.Join(retErr, wasmRuntime.Close(ctx))\n\t}()\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspace, err := controller.GetWorkspace(\n\t\tctx,\n\t\t\".\",\n\t\tbufctl.WithConfigOverride(configOverride),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tcheckClient, err := controller.GetCheckClientForWorkspace(\n\t\tctx,\n\t\tworkspace,\n\t\twasmRuntime,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar rules []bufcheck.Rule\n\tif flags.ConfiguredOnly {\n\t\tmoduleConfigs := bufYAMLFile.ModuleConfigs()\n\t\tvar moduleConfig bufconfig.ModuleConfig\n\t\tswitch fileVersion := bufYAMLFile.FileVersion(); fileVersion {\n\t\tcase bufconfig.FileVersionV1Beta1, bufconfig.FileVersionV1:\n\t\t\tif len(moduleConfigs) != 1 {\n\t\t\t\treturn syserror.Newf(\"got %d ModuleConfigs for a v1beta1/v1 buf.yaml\", len(moduleConfigs))\n\t\t\t}\n\t\t\tmoduleConfig = moduleConfigs[0]\n\t\tcase bufconfig.FileVersionV2:\n\t\t\tswitch len(moduleConfigs) {\n\t\t\tcase 0:\n\t\t\t\treturn syserror.New(\"got 0 ModuleConfigs from a BufYAMLFile\")\n\t\t\tcase 1:\n\t\t\t\tmoduleConfig = moduleConfigs[0]\n\t\t\tdefault:\n\t\t\t\tif flags.ModulePath == \"\" {\n\t\t\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be specified if the the buf.yaml has more than one module\", modulePathFlagName)\n\t\t\t\t}\n\t\t\t\tmoduleConfig, err = getModuleConfigForModulePath(moduleConfigs, flags.ModulePath)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t}\n\t\tdefault:\n\t\t\treturn syserror.Newf(\"unknown FileVersion: %v\", fileVersion)\n\t\t}\n\t\tvar checkConfig bufconfig.CheckConfig\n\t\t// We add all check configs (both lint and breaking) as related configs to check if plugins\n\t\t// have rules configured.\n\t\t// We allocated twice the size of moduleConfigs for both lint and breaking configs.\n\t\tallCheckConfigs := make([]bufconfig.CheckConfig, 0, len(moduleConfigs)*2)\n\t\tfor _, moduleConfig := range moduleConfigs {\n\t\t\tallCheckConfigs = append(allCheckConfigs, moduleConfig.LintConfig())\n\t\t\tallCheckConfigs = append(allCheckConfigs, moduleConfig.BreakingConfig())\n\t\t}\n\t\tswitch ruleType {\n\t\tcase check.RuleTypeLint:\n\t\t\tcheckConfig = moduleConfig.LintConfig()\n\t\tcase check.RuleTypeBreaking:\n\t\t\tcheckConfig = moduleConfig.BreakingConfig()\n\t\tdefault:\n\t\t\treturn fmt.Errorf(\"unknown check.RuleType: %v\", ruleType)\n\t\t}\n\t\tconfiguredRuleOptions := []bufcheck.ConfiguredRulesOption{\n\t\t\tbufcheck.WithPluginConfigs(bufYAMLFile.PluginConfigs()...),\n\t\t\tbufcheck.WithPolicyConfigs(bufYAMLFile.PolicyConfigs()...),\n\t\t\tbufcheck.WithRelatedCheckConfigs(allCheckConfigs...),\n\t\t}\n\t\trules, err = checkClient.ConfiguredRules(\n\t\t\tctx,\n\t\t\truleType,\n\t\t\tcheckConfig,\n\t\t\tconfiguredRuleOptions...,\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t} else {\n\t\tallRulesOptions := []bufcheck.AllRulesOption{\n\t\t\tbufcheck.WithPluginConfigs(bufYAMLFile.PluginConfigs()...),\n\t\t\tbufcheck.WithPolicyConfigs(bufYAMLFile.PolicyConfigs()...),\n\t\t}\n\t\trules, err = checkClient.AllRules(\n\t\t\tctx,\n\t\t\truleType,\n\t\t\tbufYAMLFile.FileVersion(),\n\t\t\tallRulesOptions...,\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn bufcli.PrintRules(\n\t\tcontainer.Stdout(),\n\t\trules,\n\t\tflags.Format,\n\t\tflags.IncludeDeprecated,\n\t)\n}\n\nfunc getModuleConfigForModulePath(moduleConfigs []bufconfig.ModuleConfig, modulePath string) (bufconfig.ModuleConfig, error) {\n\tmodulePath = normalpath.Normalize(modulePath)\n\t// Multiple modules in a v2 workspace may have the same moduleDirPath.\n\tmoduleConfigsFound := []bufconfig.ModuleConfig{}\n\tfor _, moduleConfig := range moduleConfigs {\n\t\tif moduleConfig.DirPath() == modulePath {\n\t\t\tmoduleConfigsFound = append(moduleConfigsFound, moduleConfig)\n\t\t}\n\t}\n\tswitch len(moduleConfigsFound) {\n\tcase 0:\n\t\treturn nil, fmt.Errorf(\"no module found for path %q\", modulePath)\n\tcase 1:\n\t\treturn moduleConfigsFound[0], nil\n\tdefault:\n\t\t// TODO: add --module-name flag to allow differentiation\n\t\treturn nil, fmt.Errorf(\"multiple modules found for %q\", modulePath)\n\t}\n}\n" }, { "path": "cmd/buf/internal/command/convert/convert.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage convert\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"log/slog\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufconvert\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/buffetch\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage/bufimageutil\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/gen/data/datawkt\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\terrorFormatFlagName = \"error-format\"\n\ttypeFlagName = \"type\"\n\tfromFlagName = \"from\"\n\ttoFlagName = \"to\"\n\tvalidateFlagName = \"validate\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Convert a message between binary, text, or JSON\",\n\t\tLong: `\nUse an input proto to interpret a proto/json message and convert it to a different format.\n\nExamples:\n\n $ buf convert --type= --from= --to=\n\nThe can be a local .proto file, binary output of \"buf build\", bsr module or local buf module:\n\n $ buf convert example.proto --type=Foo.proto --from=payload.json --to=output.binpb\n\nAll of , \"--from\" and \"to\" accept formatting options:\n\n $ buf convert example.proto#format=binpb --type=buf.Foo --from=payload#format=json --to=out#format=json\n\nBoth and \"--from\" accept stdin redirecting:\n\n $ buf convert <(buf build -o -)#format=binpb --type=foo.Bar --from=<(echo \"{\\\"one\\\":\\\"55\\\"}\")#format=json\n\nRedirect from stdin to --from:\n\n $ echo \"{\\\"one\\\":\\\"55\\\"}\" | buf convert buf.proto --type buf.Foo --from -#format=json\n\nRedirect from stdin to :\n\n $ buf build -o - | buf convert -#format=binpb --type buf.Foo --from=payload.json\n\nUse a module on the bsr:\n\n $ buf convert --type buf.Foo --from=payload.json\n`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tErrorFormat string\n\tType string\n\tFrom string\n\tTo string\n\tValidate bool\n\tDisableSymlinks bool\n\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors printed to stderr. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Type,\n\t\ttypeFlagName,\n\t\t\"\",\n\t\t`The full type name of the message within the input (e.g. acme.weather.v1.Units)`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.From,\n\t\tfromFlagName,\n\t\t\"-\",\n\t\tfmt.Sprintf(\n\t\t\t`The location of the payload to be converted. Supported formats are %s`,\n\t\t\tbuffetch.MessageFormatsString,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.To,\n\t\ttoFlagName,\n\t\t\"-\",\n\t\tfmt.Sprintf(\n\t\t\t`The output location of the conversion. Supported formats are %s`,\n\t\t\tbuffetch.MessageFormatsString,\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.Validate,\n\t\tvalidateFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t`Validate the message specified with --%s by applying protovalidate rules to it. See https://github.com/bufbuild/protovalidate for more details.`,\n\t\t\tfromFlagName,\n\t\t),\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t\tbufctl.WithFileAnnotationErrorFormat(flags.ErrorFormat),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tschemaImage, schemaImageErr := controller.GetImage(\n\t\tctx,\n\t\tinput,\n\t)\n\tvar resolveWellKnownType bool\n\t// only resolve wkts if input was not set.\n\tif container.NumArgs() == 0 {\n\t\tif schemaImageErr != nil {\n\t\t\tresolveWellKnownType = true\n\t\t}\n\t\tif schemaImage != nil {\n\t\t\t_, filterErr := bufimageutil.FilterImage(\n\t\t\t\tschemaImage,\n\t\t\t\tbufimageutil.WithIncludeTypes(flags.Type),\n\t\t\t\tbufimageutil.WithMutateInPlace(),\n\t\t\t)\n\t\t\tif errors.Is(filterErr, bufimageutil.ErrImageFilterTypeNotFound) {\n\t\t\t\tresolveWellKnownType = true\n\t\t\t}\n\t\t}\n\t}\n\tif resolveWellKnownType {\n\t\tif _, ok := datawkt.MessageFilePath(flags.Type); ok {\n\t\t\tvar wktErr error\n\t\t\tschemaImage, wktErr = wellKnownTypeImage(\n\t\t\t\tctx,\n\t\t\t\tcontainer.Logger(),\n\t\t\t\tflags.Type,\n\t\t\t)\n\t\t\tif wktErr != nil {\n\t\t\t\treturn wktErr\n\t\t\t}\n\t\t}\n\t}\n\tif schemaImageErr != nil && schemaImage == nil {\n\t\treturn schemaImageErr\n\t}\n\t// We can't correctly convert anything that uses message-set wire\n\t// format. So we prevent that by having the resolver return an error\n\t// if asked to resolve any type that uses it.\n\tschemaImage = bufconvert.ImageWithoutMessageSetWireFormatResolution(schemaImage)\n\tvar fromFunctionOptions []bufctl.FunctionOption\n\tif flags.Validate {\n\t\tfromFunctionOptions = append(fromFunctionOptions, bufctl.WithMessageValidation())\n\t}\n\tfromMessage, fromMessageEncoding, err := controller.GetMessage(\n\t\tctx,\n\t\tschemaImage,\n\t\tflags.From,\n\t\tflags.Type,\n\t\tbuffetch.MessageEncodingBinpb,\n\t\tfromFunctionOptions...,\n\t)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"--%s: %w\", fromFlagName, err)\n\t}\n\tdefaultToMessageEncoding, err := inverseEncoding(fromMessageEncoding)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif err := controller.PutMessage(\n\t\tctx,\n\t\tschemaImage,\n\t\tflags.To,\n\t\tfromMessage,\n\t\tdefaultToMessageEncoding,\n\t); err != nil {\n\t\treturn fmt.Errorf(\"--%s: %w\", toFlagName, err)\n\t}\n\treturn nil\n}\n\n// inverseEncoding returns the opposite encoding of the provided encoding,\n// which will be the default output encoding for a given payload encoding.\nfunc inverseEncoding(encoding buffetch.MessageEncoding) (buffetch.MessageEncoding, error) {\n\tswitch encoding {\n\tcase buffetch.MessageEncodingBinpb:\n\t\treturn buffetch.MessageEncodingJSON, nil\n\tcase buffetch.MessageEncodingJSON:\n\t\treturn buffetch.MessageEncodingBinpb, nil\n\tcase buffetch.MessageEncodingTxtpb:\n\t\treturn buffetch.MessageEncodingBinpb, nil\n\tcase buffetch.MessageEncodingYAML:\n\t\treturn buffetch.MessageEncodingBinpb, nil\n\tdefault:\n\t\treturn 0, fmt.Errorf(\"unknown message encoding %v\", encoding)\n\t}\n}\n\n// wellKnownTypeImage returns an Image with just the given WKT type name (google.protobuf.Duration for example).\nfunc wellKnownTypeImage(\n\tctx context.Context,\n\tlogger *slog.Logger,\n\twellKnownTypeName string,\n) (bufimage.Image, error) {\n\tmoduleSetBuilder := bufmodule.NewModuleSetBuilder(ctx, logger, bufmodule.NopModuleDataProvider, bufmodule.NopCommitProvider)\n\tmoduleSetBuilder.AddLocalModule(\n\t\tdatawkt.ReadBucket,\n\t\t\".\",\n\t\ttrue,\n\t)\n\tmoduleSet, err := moduleSetBuilder.Build()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\timage, err := bufimage.BuildImage(\n\t\tctx,\n\t\tlogger,\n\t\tbufmodule.ModuleSetToModuleReadBucketWithOnlyProtoFiles(moduleSet),\n\t)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn bufimageutil.FilterImage(\n\t\timage,\n\t\tbufimageutil.WithIncludeTypes(wellKnownTypeName),\n\t\tbufimageutil.WithMutateInPlace(),\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/convert/convert_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage convert\n\nimport (\n\t\"os\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appcmd/appcmdtesting\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestConvertDefaultInputBin(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`{\"one\":\"55\"}`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/payload.bin\",\n\t\t),\n\t)\n}\n\nfunc TestConvertDefaultInputBinpb(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`{\"one\":\"55\"}`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/payload.binpb\",\n\t\t),\n\t)\n}\n\nfunc TestConvertDefaultInputTxtpb(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`{\"one\":\"55\"}`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/payload.txtpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t),\n\t)\n}\n\nfunc TestConvertDefaultInputYAML(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`one: \"55\"`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/payload.txtpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=yaml\",\n\t\t),\n\t)\n}\nfunc TestConvertFromStdinBin(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/payload.bin\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`{\"one\":\"55\"}`),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=bin\",\n\t\t),\n\t)\n}\nfunc TestConvertFromStdinBinpb(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/payload.binpb\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`{\"one\":\"55\"}`),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=binpb\",\n\t\t),\n\t)\n}\nfunc TestConvertFromStdinTxtpbJSON(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/payload.txtpb\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`{\"one\":\"55\"}`),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=txtpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t),\n\t)\n}\nfunc TestConvertFromStdinTxtpbYAML(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/payload.txtpb\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`one: \"55\"`),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"-#format=txtpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=yaml\",\n\t\t),\n\t)\n}\nfunc TestConvertDiscardedStdin(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`{\"one\":\"55\"}`),\n\t\tappcmdtesting.WithStdin(strings.NewReader(\"this should be discarded\")), // stdin is discarded if not needed\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"buf.Foo\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/payload.binpb\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTBin(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`\"3600s\"`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"google.protobuf.Duration\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/duration.bin\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTBinpb(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`\"3600s\"`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"google.protobuf.Duration\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/duration.binpb\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTTxtpb(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`\"3600s\"`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"google.protobuf.Duration\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/duration.txtpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTYAML(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(`3600s`),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type\",\n\t\t\t\"google.protobuf.Duration\",\n\t\t\t\"--from\",\n\t\t\t\"testdata/convert/bin_json/duration.txtpb\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=yaml\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTFormatBin(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/duration.bin\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Duration\",\n\t\t\t\"--from=testdata/convert/bin_json/duration.json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=bin\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTFormatBinYAML(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/duration.bin\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Duration\",\n\t\t\t\"--from=testdata/convert/bin_json/duration.yaml\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=bin\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTFormatBinpb(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/duration.binpb\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Duration\",\n\t\t\t\"--from=testdata/convert/bin_json/duration.json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTFormatBinpbYAML(t *testing.T) {\n\tt.Parallel()\n\tstdin, err := os.Open(\"testdata/convert/bin_json/duration.binpb\")\n\trequire.NoError(t, err)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Duration\",\n\t\t\t\"--from=testdata/convert/bin_json/duration.yaml\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTIncorrectInput(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(1),\n\t\tappcmdtesting.WithExpectedStdout(\"\"), // explicitly check for empty stdout\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"filedoestexist\",\n\t\t\t\"--type=google.protobuf.Duration\",\n\t\t\t\"--from=testdata/convert/bin_json/duration.json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTGoogleFileLocal(t *testing.T) {\n\tt.Parallel()\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(1),\n\t\tappcmdtesting.WithExpectedStdout(\"\"), // explicitly check for empty stdout\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"google/protobuf/timestamp.proto\", // this file doesn't exist locally\n\t\t\t\"--type=google.protobuf.Duration\",\n\t\t\t\"--from=duration.json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=binpb\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTLocalWKTExists(t *testing.T) {\n\tt.Parallel()\n\texpected := `{\"name\":\"blah\"}` // valid google.protobuf.Method message\n\tstdin := strings.NewReader(expected)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(expected),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Method\",\n\t\t\t\"--from=-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTLocalChanged(t *testing.T) {\n\tt.Parallel()\n\texpected := `{\"notinoriginal\":\"blah\"}` // notinoriginal exists in the local api.proto\n\tstdin := strings.NewReader(expected)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(expected),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Method\",\n\t\t\t\"--from=-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t),\n\t)\n}\n\n// No idea what this does compared to above function - it was the same name in table tests,\n// and table tests dont enforce unique test names.\nfunc TestConvertWKTLocalChanged2(t *testing.T) {\n\tt.Parallel()\n\tstdin := strings.NewReader(`{\"notinchanged\":\"blah\"}`) // notinchanged does not exist in the local api.proto\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(\"{}\"), // we expect empty json because the field doesn't exist in api.proto\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Method\",\n\t\t\t\"--from=-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t),\n\t)\n}\nfunc TestConvertWKTImport(t *testing.T) {\n\tt.Parallel()\n\texpected := `{\"syntax\":\"SYNTAX_PROTO3\"}` // Syntax is imported into type.proto\n\tstdin := strings.NewReader(expected)\n\tappcmdtesting.Run(\n\t\tt,\n\t\ttestNewCommand,\n\t\tappcmdtesting.WithExpectedExitCode(0),\n\t\tappcmdtesting.WithExpectedStdout(expected),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(\n\t\t\t\"--type=google.protobuf.Type\",\n\t\t\t\"--from=-#format=json\",\n\t\t\t\"--to\",\n\t\t\t\"-#format=json\",\n\t\t),\n\t)\n}\n\nfunc testNewCommand(use string) *appcmd.Command {\n\treturn NewCommand(\"convert\", appext.NewBuilder(\"convert\"))\n}\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/README.md", "content": "To re-generate the `descriptor.plain.binpb` file, run the following command in the root of the project:\n\n```\necho \"{\\\"one\\\":\\\"55\\\"}\" | \\\nbuf convert cmd/buf/testdata/success \\\n --type buf.Foo \\\n --from -#format=json \\\n --to cmd/buf/internal/command/convert/testdata/convert/descriptor.plain.binpb\n```\n\nTo re-generate the `bin_json/duration.{bin,binpb,json,txtpb}` files, run the following command in the root of the project:\n\n```\nfor EXT in bin binpb json txtpb\ndo\n echo \"\\\"3600s\\\"\" | \\\n buf convert \\\n --type google.protobuf.Duration \\\n --from -#format=json \\\n --to cmd/buf/internal/command/convert/testdata/convert/bin_json/duration.$EXT\ndone\n```\n\nTo re-generate the `bin_json/image.{bin,binpb,json,txtpb}` files, run the following command in the root of the project:\n\n```\nfor EXT in bin binpb json txtpb\ndo\n buf build cmd/buf/internal/command/convert/testdata/convert/bin_json/buf.proto \\\n --output cmd/buf/internal/command/convert/testdata/convert/bin_json/image.$EXT\ndone\n```\n\nTo re-generate the `bin_json/payload.{bin,binpb,json,txtpb}` files, run the following command in the root of the project:\n\n```\nfor EXT in bin binpb json txtpb\ndo\n echo \"{\\\"one\\\":\\\"55\\\"}\" | \\\n buf convert cmd/buf/internal/command/convert/testdata/convert/bin_json \\\n --type buf.Foo \\\n --from -#format=json \\\n --to cmd/buf/internal/command/convert/testdata/convert/bin_json/payload.$EXT\ndone\n```\n\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/api.proto", "content": "syntax = \"proto3\";\n\npackage google.protobuf;\n\n// Example of if a well known type exists locally and is different to the\n// baked in well known types\nmessage Method {\n string name = 1;\n string notinoriginal = 2;\n}\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/buf.proto", "content": "syntax = \"proto3\";\n\npackage buf;\n\nmessage Foo {\n int64 one = 1;\n}\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/buf.yaml", "content": "version: v1\nbreaking:\n use:\n - FILE\nlint:\n use:\n - DEFAULT\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/duration.binpb", "content": "\b\u001c" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/duration.json", "content": "\"3600s\"" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/duration.txtpb", "content": "seconds: 3600\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/duration.yaml", "content": "3600s\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/image.json", "content": "{\"file\":[{\"name\":\"buf.proto\",\"package\":\"buf\",\"messageType\":[{\"name\":\"Foo\",\"field\":[{\"name\":\"one\",\"number\":1,\"label\":\"LABEL_OPTIONAL\",\"type\":\"TYPE_INT64\",\"jsonName\":\"one\"}]}],\"sourceCodeInfo\":{\"location\":[{\"span\":[0,0,6,1]},{\"path\":[12],\"span\":[0,0,18]},{\"path\":[2],\"span\":[2,0,12]},{\"path\":[4,0],\"span\":[4,0,6,1]},{\"path\":[4,0,1],\"span\":[4,8,11]},{\"path\":[4,0,2,0],\"span\":[5,2,16]},{\"path\":[4,0,2,0,5],\"span\":[5,2,7]},{\"path\":[4,0,2,0,1],\"span\":[5,8,11]},{\"path\":[4,0,2,0,3],\"span\":[5,14,15]}]},\"syntax\":\"proto3\",\"bufExtension\":{\"isImport\":false,\"isSyntaxUnspecified\":false}}]}" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/image.txtpb", "content": "file: {\n name: \"buf.proto\"\n package: \"buf\"\n message_type: {\n name: \"Foo\"\n field: {\n name: \"one\"\n number: 1\n label: LABEL_OPTIONAL\n type: TYPE_INT64\n json_name: \"one\"\n }\n }\n source_code_info: {\n location: {\n span: 0\n span: 0\n span: 6\n span: 1\n }\n location: {\n path: 12\n span: 0\n span: 0\n span: 18\n }\n location: {\n path: 2\n span: 2\n span: 0\n span: 12\n }\n location: {\n path: 4\n path: 0\n span: 4\n span: 0\n span: 6\n span: 1\n }\n location: {\n path: 4\n path: 0\n path: 1\n span: 4\n span: 8\n span: 11\n }\n location: {\n path: 4\n path: 0\n path: 2\n path: 0\n span: 5\n span: 2\n span: 16\n }\n location: {\n path: 4\n path: 0\n path: 2\n path: 0\n path: 5\n span: 5\n span: 2\n span: 7\n }\n location: {\n path: 4\n path: 0\n path: 2\n path: 0\n path: 1\n span: 5\n span: 8\n span: 11\n }\n location: {\n path: 4\n path: 0\n path: 2\n path: 0\n path: 3\n span: 5\n span: 14\n span: 15\n }\n }\n syntax: \"proto3\"\n buf_extension: {\n is_import: false\n is_syntax_unspecified: false\n }\n}\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/image.yaml", "content": "file:\n - bufExtension:\n isImport: false\n isSyntaxUnspecified: false\n messageType:\n - field:\n - jsonName: one\n label: LABEL_OPTIONAL\n name: one\n number: 1\n type: TYPE_INT64\n name: Foo\n name: buf.proto\n package: buf\n sourceCodeInfo:\n location:\n - span:\n - 0\n - 0\n - 6\n - 1\n - path:\n - 12\n span:\n - 0\n - 0\n - 18\n - path:\n - 2\n span:\n - 2\n - 0\n - 12\n - path:\n - 4\n - 0\n span:\n - 4\n - 0\n - 6\n - 1\n - path:\n - 4\n - 0\n - 1\n span:\n - 4\n - 8\n - 11\n - path:\n - 4\n - 0\n - 2\n - 0\n span:\n - 5\n - 2\n - 16\n - path:\n - 4\n - 0\n - 2\n - 0\n - 5\n span:\n - 5\n - 2\n - 7\n - path:\n - 4\n - 0\n - 2\n - 0\n - 1\n span:\n - 5\n - 8\n - 11\n - path:\n - 4\n - 0\n - 2\n - 0\n - 3\n span:\n - 5\n - 14\n - 15\n syntax: proto3\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/payload.binpb", "content": "\b7" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/payload.json", "content": "{\"one\":\"55\"}" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/payload.txtpb", "content": "one: 55\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/bin_json/payload.yaml", "content": "one: \"55\"\n" }, { "path": "cmd/buf/internal/command/convert/testdata/convert/descriptor.plain.binpb", "content": "\b7" }, { "path": "cmd/buf/internal/command/curl/curl.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage curl\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"crypto/tls\"\n\t\"encoding/base64\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net\"\n\t\"net/http\"\n\t\"net/url\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"slices\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"connectrpc.com/connect\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufcurl\"\n\t\"github.com/bufbuild/buf/private/pkg/netrc\"\n\t\"github.com/bufbuild/buf/private/pkg/verbose\"\n\t\"github.com/quic-go/quic-go\"\n\t\"github.com/quic-go/quic-go/http3\"\n\t\"github.com/spf13/pflag\"\n\t\"google.golang.org/protobuf/reflect/protoreflect\"\n)\n\nconst (\n\t// Input schema flags\n\tschemaFlagName = \"schema\"\n\n\t// Reflection flags\n\treflectFlagName = \"reflect\"\n\treflectHeaderFlagName = \"reflect-header\"\n\treflectProtocolFlagName = \"reflect-protocol\"\n\n\t// Protocol/transport flags\n\tprotocolFlagName = \"protocol\"\n\tunixSocketFlagName = \"unix-socket\"\n\thttp2PriorKnowledgeFlagName = \"http2-prior-knowledge\"\n\thttp3FlagName = \"http3\"\n\n\t// TLS flags\n\tkeyFlagName = \"key\"\n\tcertFlagName = \"cert\"\n\tcertFlagShortName = \"E\"\n\tcaCertFlagName = \"cacert\"\n\tserverNameFlagName = \"servername\"\n\tinsecureFlagName = \"insecure\"\n\tinsecureFlagShortName = \"k\"\n\n\t// Action flags\n\tlistServicesFlagName = \"list-services\"\n\tlistMethodsFlagName = \"list-methods\"\n\n\t// Timeout flags\n\tnoKeepAliveFlagName = \"no-keepalive\"\n\tkeepAliveFlagName = \"keepalive-time\"\n\tconnectTimeoutFlagName = \"connect-timeout\"\n\n\t// Header and request body flags\n\tuserAgentFlagName = \"user-agent\"\n\tuserAgentFlagShortName = \"A\"\n\tuserFlagName = \"user\"\n\tuserFlagShortName = \"u\"\n\tnetrcFlagName = \"netrc\"\n\tnetrcFlagShortName = \"n\"\n\tnetrcFileFlagName = \"netrc-file\"\n\theaderFlagName = \"header\"\n\theaderFlagShortName = \"H\"\n\tdataFlagName = \"data\"\n\tdataFlagShortName = \"d\"\n\n\t// Output flags\n\toutputFlagName = \"output\"\n\toutputFlagShortName = \"o\"\n\temitDefaultsFlagName = \"emit-defaults\"\n\n\tverboseFlagName = \"verbose\"\n\tverboseFlagShortName = \"v\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Invoke an RPC endpoint, a la 'cURL'\",\n\t\tLong: `This command helps you invoke HTTP RPC endpoints on a server that uses gRPC or Connect.\n\nBy default, server reflection is used, unless the --reflect flag is set to false. Without server\nreflection, a --schema flag must be provided to indicate the Protobuf schema for the method being\ninvoked.\n\nThe only positional argument is the URL of the RPC method to invoke. The name of the method to\ninvoke comes from the last two path components of the URL, which should be the fully-qualified\nservice name and method name, respectively.\n\nThe URL can use either http or https as the scheme. If http is used then HTTP 1.1 will be used\nunless the --http2-prior-knowledge flag is set. If https is used then HTTP/2 will be preferred\nduring protocol negotiation and HTTP 1.1 used only if the server does not support HTTP/2.\n\nThe default RPC protocol used will be Connect. To use a different protocol (gRPC or gRPC-Web),\nuse the --protocol flag. Note that the gRPC protocol cannot be used with HTTP 1.1.\n\nThe input request is specified via the -d or --data flag. If absent, an empty request is sent. If\nthe flag value starts with an at-sign (@), then the rest of the flag value is interpreted as a\nfilename from which to read the request body. If that filename is just a dash (-), then the request\nbody is read from stdin. The request body is a JSON document that contains the JSON formatted\nrequest message. If the RPC method being invoked is a client-streaming method, the request body may\nconsist of multiple JSON values, appended to one another. Multiple JSON documents should usually be\nseparated by whitespace, though this is not strictly required unless the request message type has a\ncustom JSON representation that is not a JSON object.\n\nRequest metadata (i.e. headers) are defined using -H or --header flags. The flag value is in\n\"name: value\" format. But if it starts with an at-sign (@), the rest of the value is interpreted as\na filename from which headers are read, each on a separate line. If the filename is just a dash (-),\nthen the headers are read from stdin.\n\nIf headers and the request body are both to be read from the same file (or both read from stdin),\nthe file must include headers first, then a blank line, and then the request body.\n\nExamples:\n\nIssue a unary RPC to a plain-text (i.e. \"h2c\") gRPC server, where the schema for the service is\nin a Buf module in the current directory, using an empty request message:\n\n $ buf curl --schema . --protocol grpc --http2-prior-knowledge \\\n http://localhost:20202/foo.bar.v1.FooService/DoSomething\n\nIssue an RPC to a Connect server, where the schema comes from the Buf Schema Registry, using\na request that is defined as a command-line argument:\n\n $ buf curl --schema buf.build/connectrpc/eliza \\\n --data '{\"name\": \"Bob Loblaw\"}' \\\n https://demo.connectrpc.com/connectrpc.eliza.v1.ElizaService/Introduce\n\nIssue a unary RPC to a server that supports reflection, with verbose output:\n\n $ buf curl --data '{\"sentence\": \"I am not feeling well.\"}' -v \\\n\t\t https://demo.connectrpc.com/connectrpc.eliza.v1.ElizaService/Say\n\nIssue a client-streaming RPC to a gRPC-web server that supports reflection, where custom\nheaders and request data are both in a heredoc:\n\n $ buf curl --data @- --header @- --protocol grpcweb \\\n\t\t https://demo.connectrpc.com/connectrpc.eliza.v1.ElizaService/Converse \\\n < arguments to\nother buf sub-commands such as build and generate. It can indicate a directory, a file, a\nremote module in the Buf Schema Registry, or even standard in (\"-\") for feeding an image or\nfile descriptor set to the command in a shell pipeline.\nIf multiple %s flags are present, they will be consulted in order to resolve service and type\nnames. Setting this flags implies --%s=false unless a %s flag is explicitly present. If both\n%s and %s flags are in use, reflection will be used first and the schemas will be consulted\nin order thereafter if reflection fails to resolve a schema element.`,\n\t\t\tschemaFlagName, reflectFlagName, reflectFlagName,\n\t\t\tschemaFlagName, reflectFlagName,\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.Reflect,\n\t\treflectFlagName,\n\t\ttrue,\n\t\t`If true, use server reflection to determine the schema`,\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.ReflectHeaders,\n\t\treflectHeaderFlagName,\n\t\tnil,\n\t\tfmt.Sprintf(`Request headers to include with reflection requests. This flag may only be used\nwhen --%s is also set. This flag may be specified more than once to indicate\nmultiple headers. Each flag value should have the form \"name: value\". But a special value\nof '*' may be used to indicate that all normal request headers (from --%s and -%s\nflags) should also be included with reflection requests. A special value of '@'\nmeans to read headers from the file at . If the path is \"-\" then headers are\nread from stdin. It is not allowed to indicate a file with the same path as used with\nthe request data flag (--%s or -%s). Furthermore, it is not allowed to indicate stdin\nif the schema is expected to be provided via stdin as a file descriptor set or image`,\n\t\t\treflectFlagName, headerFlagName, headerFlagShortName, dataFlagName, dataFlagShortName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.ReflectProtocol,\n\t\treflectProtocolFlagName,\n\t\t\"\",\n\t\t`The reflection protocol to use for downloading information from the server. This flag\nmay only be used when server reflection is used. By default, this command will try all known\nreflection protocols from newest to oldest. If this results in a \"Not Implemented\" error,\nthen older protocols will be used. In practice, this means that \"grpc-v1\" is tried first,\nand \"grpc-v1alpha\" is used if it doesn't work. If newer reflection protocols are introduced,\nthey may be preferred in the absence of this flag being explicitly set to a specific protocol.\nThe valid values for this flag are \"grpc-v1\" and \"grpc-v1alpha\". These correspond to services\nnamed \"grpc.reflection.v1.ServerReflection\" and \"grpc.reflection.v1alpha.ServerReflection\"\nrespectively`,\n\t)\n\n\tflagSet.StringVar(\n\t\t&f.Protocol,\n\t\tprotocolFlagName,\n\t\tconnect.ProtocolConnect,\n\t\t`The RPC protocol to use. This can be one of \"grpc\", \"grpcweb\", or \"connect\"`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.UnixSocket,\n\t\tunixSocketFlagName,\n\t\t\"\",\n\t\t`The path to a unix socket that will be used instead of opening a TCP socket to the host\nand port indicated in the URL`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.HTTP2PriorKnowledge,\n\t\thttp2PriorKnowledgeFlagName,\n\t\tfalse,\n\t\t`This flag can be used to indicate that HTTP/2 should be used. Without this, HTTP 1.1\nwill be used with URLs with an http scheme, and protocol negotiation will be used to\nchoose either HTTP 1.1 or HTTP/2 for URLs with an https scheme. With this flag set,\nHTTP/2 is always used, even over plain-text.`,\n\t)\n\n\tflagSet.BoolVar(\n\t\t&f.HTTP3,\n\t\thttp3FlagName,\n\t\tfalse,\n\t\t`This flag can be used to indicate that HTTP/3 should be used. Without this, HTTP 1.1\nwill be used with URLs with an http scheme, and protocol negotiation will be used to\nchoose either HTTP 1.1 or HTTP/2 for URLs with an https scheme. With this flag set,\nHTTP/3 is always used.`,\n\t)\n\n\tflagSet.BoolVar(\n\t\t&f.NoKeepAlive,\n\t\tnoKeepAliveFlagName,\n\t\tfalse,\n\t\t`By default, connections are created using TCP keepalive. If this flag is present, they\nwill be disabled`,\n\t)\n\tflagSet.Float64Var(\n\t\t&f.KeepAliveTimeSeconds,\n\t\tkeepAliveFlagName,\n\t\t60,\n\t\t`The duration, in seconds, between TCP keepalive transmissions`,\n\t)\n\tflagSet.Float64Var(\n\t\t&f.ConnectTimeoutSeconds,\n\t\tconnectTimeoutFlagName,\n\t\t0,\n\t\t`The time limit, in seconds, for a connection to be established with the server. There is\nno limit if this flag is not present`,\n\t)\n\n\tflagSet.StringVar(\n\t\t&f.Key,\n\t\tkeyFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(`Path to a PEM-encoded X509 private key file, for using client certificates with TLS. This\noption is only valid when the URL uses the https scheme. A --%s or -%s flag must also be\npresent to provide the certificate and public key that corresponds to the given\nprivate key`,\n\t\t\tcertFlagName, certFlagShortName,\n\t\t),\n\t)\n\tflagSet.StringVarP(\n\t\t&f.Cert,\n\t\tcertFlagName,\n\t\tcertFlagShortName,\n\t\t\"\",\n\t\tfmt.Sprintf(`Path to a PEM-encoded X509 certificate file, for using client certificates with TLS. This\noption is only valid when the URL uses the https scheme. A --%s flag must also be\npresent to provide the private key that corresponds to the given certificate`,\n\t\t\tkeyFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.CACert,\n\t\tcaCertFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(`Path to a PEM-encoded X509 certificate pool file that contains the set of trusted\ncertificate authorities/issuers. If omitted, the system's default set of trusted\ncertificates are used to verify the server's certificate. This option is only valid\nwhen the URL uses the https scheme. It is not applicable if --%s or -%s flag is used`,\n\t\t\tinsecureFlagName, insecureFlagShortName,\n\t\t),\n\t)\n\tflagSet.BoolVarP(\n\t\t&f.Insecure,\n\t\tinsecureFlagName,\n\t\tinsecureFlagShortName,\n\t\tfalse,\n\t\t`If set, the TLS connection will be insecure and the server's certificate will NOT be\nverified. This is generally discouraged. This option is only valid when the URL uses\nthe https scheme`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.ServerName,\n\t\tserverNameFlagName,\n\t\t\"\",\n\t\t`The server name to use in TLS handshakes (for SNI) if the URL scheme is https. If not\nspecified, the default is the origin host in the URL or the value in a \"Host\" header if\none is provided`,\n\t)\n\n\tflagSet.BoolVar(\n\t\t&f.ListServices,\n\t\tlistServicesFlagName,\n\t\tfalse,\n\t\t`When set, the command lists supported services and then exits. If server reflection is used\nto provide the RPC schema, then the given URL must be a base URL, not including a service\nor method name. If the schema source is not server reflection, the URL is not used and\nmay be omitted.`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.ListMethods,\n\t\tlistMethodsFlagName,\n\t\tfalse,\n\t\t`When set, the command lists supported methods and then exits. If server reflection is used\nto provide the RPC schema, then the given URL must be a base URL, not including a service\nor method name. If the schema source is not server reflection, the URL is not used and\nmay be omitted.`,\n\t)\n\n\tflagSet.StringVarP(\n\t\t&f.UserAgent,\n\t\tuserAgentFlagName,\n\t\tuserAgentFlagShortName,\n\t\t\"\",\n\t\tfmt.Sprintf(`The user agent string to send. This is ignored if a --%s or -%s flag is provided\nthat sets a header named 'User-Agent'.`,\n\t\t\theaderFlagName, headerFlagShortName,\n\t\t),\n\t)\n\tflagSet.StringVarP(\n\t\t&f.User,\n\t\tuserFlagName,\n\t\tuserFlagShortName,\n\t\t\"\",\n\t\tfmt.Sprintf(`The user credentials to send, via a basic authorization header. The value should be\nin the format \"username:password\". If the value has no colon, it is assumed to just be\nthe username, in which case you will be prompted to enter a password. This overrides\nthe use of a .netrc file. This is ignored if a --%s or -%s flag is provided that sets\na header named 'Authorization'.`,\n\t\t\theaderFlagName, headerFlagShortName,\n\t\t),\n\t)\n\tflagSet.BoolVarP(\n\t\t&f.Netrc,\n\t\tnetrcFlagName,\n\t\tnetrcFlagShortName,\n\t\tfalse,\n\t\tfmt.Sprintf(`If true, a file named .netrc in the user's home directory will be examined to find\ncredentials for the request. The credentials will be sent via a basic authorization header.\nThe command will fail if the file does not have an entry for the hostname in the URL. This\nflag is ignored if a --%s or -%s flag is present. This is ignored if a --%s or -%s flag\nis provided that sets a header named 'Authorization'.`,\n\t\t\tuserFlagName, userFlagShortName, headerFlagName, headerFlagShortName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.NetrcFile,\n\t\tnetrcFileFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(`This is just like use --%s or -%s, except that the named file is used instead of\na file named .netrc in the user's home directory. This flag cannot be used with the --%s\nor -%s flag. This is ignored if a --%s or -%s flag is provided that sets a header named\n'Authorization'.`,\n\t\t\tnetrcFlagName, netrcFlagShortName, netrcFlagName, netrcFlagShortName, headerFlagName, headerFlagShortName,\n\t\t),\n\t)\n\tflagSet.StringSliceVarP(\n\t\t&f.Headers,\n\t\theaderFlagName,\n\t\theaderFlagShortName,\n\t\tnil,\n\t\tfmt.Sprintf(`Request headers to include with the RPC invocation. This flag may be specified more\nthan once to indicate multiple headers. Each flag value should have the form \"name: value\".\nA special value of '@' means to read headers from the file at . If the path\nis \"-\" then headers are read from stdin. If the same file is indicated as used with the\nrequest data flag (--%s or -%s), the file must contain all headers, then a blank line,\nand then the request body. It is not allowed to indicate stdin if the schema is expected\nto be provided via stdin as a file descriptor set or image`,\n\t\t\tdataFlagName, dataFlagShortName,\n\t\t),\n\t)\n\tflagSet.StringVarP(\n\t\t&f.Data,\n\t\tdataFlagName,\n\t\tdataFlagShortName,\n\t\t\"\",\n\t\tfmt.Sprintf(`Request data. This should be zero or more JSON documents, each indicating a request\nmessage. For unary RPCs, there should be exactly one JSON document. A special value of\n'@' means to read the data from the file at . If the path is \"-\" then the\nrequest data is read from stdin. If the same file is indicated as used with the request\nheaders flags (--%s or -%s), the file must contain all headers, then a blank line, and\nthen the request body. It is not allowed to indicate stdin if the schema is expected to be\nprovided via stdin as a file descriptor set or image`,\n\t\t\theaderFlagName, headerFlagShortName,\n\t\t),\n\t)\n\tflagSet.StringVarP(\n\t\t&f.Output,\n\t\toutputFlagName,\n\t\toutputFlagShortName,\n\t\t\"\",\n\t\t`Path to output file to create with response data. If absent, response is printed to stdout`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.EmitDefaults,\n\t\temitDefaultsFlagName,\n\t\tfalse,\n\t\t`Emit default values for JSON-encoded responses.`,\n\t)\n\n\tflagSet.BoolVarP(\n\t\t&f.Verbose,\n\t\tverboseFlagName,\n\t\tverboseFlagShortName,\n\t\tfalse,\n\t\t\"Turn on verbose mode\",\n\t)\n}\n\nfunc (f *flags) validate(hasURL, isSecure bool) error {\n\tif len(f.Schemas) > 0 && f.Reflect && !f.flagSet.Changed(reflectFlagName) {\n\t\t// Reflect just has default value; unset it since we're going to use --schema instead.\n\t\tf.Reflect = false\n\t}\n\tif !f.Reflect && len(f.Schemas) == 0 {\n\t\treturn fmt.Errorf(\"must specify --%s if --%s is false\", schemaFlagName, reflectFlagName)\n\t}\n\n\tif !hasURL && ((!f.ListServices && !f.ListMethods) || f.Reflect) {\n\t\t// If we are trying to use reflection for anything or if we are invoking an RPC (which\n\t\t// means we aren't listing services, listing methods, or describing an element), then\n\t\t// a URL is required.\n\t\treturn appcmd.NewInvalidArgumentError(\"URL positional argument is missing\")\n\t}\n\n\tif f.ListServices && f.ListMethods {\n\t\treturn fmt.Errorf(\"flags --%s and --%s are mutually exclusive\", listServicesFlagName, listMethodsFlagName)\n\t}\n\n\tif (f.Key != \"\" || f.Cert != \"\" || f.CACert != \"\" || f.ServerName != \"\" || f.flagSet.Changed(insecureFlagName)) &&\n\t\t!isSecure {\n\t\treturn fmt.Errorf(\n\t\t\t\"TLS flags (--%s, --%s, --%s, --%s, --%s) should not be used unless URL is secure (https)\",\n\t\t\tkeyFlagName, certFlagName, caCertFlagName, insecureFlagName, serverNameFlagName)\n\t}\n\tif (f.Key != \"\") != (f.Cert != \"\") {\n\t\treturn fmt.Errorf(\"if one of --%s or --%s flags is used, both should be used (mutual TLS with a client certificate requires both)\", keyFlagName, certFlagName)\n\t}\n\tif f.Insecure && f.CACert != \"\" {\n\t\treturn fmt.Errorf(\"if --%s is set, --%s should not be set as it is unused\", insecureFlagName, caCertFlagName)\n\t}\n\n\tif !isSecure && !f.HTTP2PriorKnowledge && f.Protocol == connect.ProtocolGRPC {\n\t\treturn fmt.Errorf(\"grpc protocol cannot be used with plain-text URLs (http) unless --%s flag is set\", http2PriorKnowledgeFlagName)\n\t}\n\n\tif !isSecure && f.HTTP3 {\n\t\treturn fmt.Errorf(\"--%s cannot be used with plain-text URLs (http)\", http3FlagName)\n\t}\n\n\tif f.UnixSocket != \"\" && f.HTTP3 {\n\t\treturn fmt.Errorf(\"--%s cannot be used with --%s\", unixSocketFlagName, http3FlagName)\n\t}\n\n\tif f.Netrc && f.NetrcFile != \"\" {\n\t\treturn fmt.Errorf(\"--%s and --%s flags are mutually exclusive; they may not both be specified\", netrcFlagName, netrcFileFlagName)\n\t}\n\n\tvar schemaIsStdin bool\n\tfor _, schema := range f.Schemas {\n\t\tisStdin := strings.HasPrefix(schema, \"-\")\n\t\tif isStdin && schemaIsStdin {\n\t\t\t// more than one schema argument wants to use stdin\n\t\t\treturn fmt.Errorf(\"multiple --%s flags indicate the use of stdin which is not allowed\", schemaFlagName)\n\t\t}\n\t\tif isStdin {\n\t\t\tschemaIsStdin = true\n\t\t}\n\t}\n\tif (len(f.ReflectHeaders) > 0 || f.flagSet.Changed(reflectProtocolFlagName)) && !f.Reflect {\n\t\treturn fmt.Errorf(\n\t\t\t\"reflection flags (--%s, --%s) should not be used if --%s is false\",\n\t\t\treflectHeaderFlagName, reflectProtocolFlagName, reflectFlagName)\n\t}\n\tif f.Reflect {\n\t\tif !isSecure && !f.HTTP2PriorKnowledge {\n\t\t\treturn fmt.Errorf(\"--%s cannot be used with plain-text URLs (http) unless --%s flag is set\", reflectFlagName, http2PriorKnowledgeFlagName)\n\t\t}\n\t\tif _, err := bufcurl.ParseReflectProtocol(f.ReflectProtocol); err != nil {\n\t\t\treturn fmt.Errorf(\n\t\t\t\t\"--%s value must be one of %s\",\n\t\t\t\treflectProtocolFlagName,\n\t\t\t\txstrings.SliceToHumanStringOrQuoted(bufcurl.AllKnownReflectProtocolStrings),\n\t\t\t)\n\t\t}\n\t}\n\n\tswitch f.Protocol {\n\tcase connect.ProtocolConnect, connect.ProtocolGRPC, connect.ProtocolGRPCWeb:\n\tdefault:\n\t\treturn fmt.Errorf(\n\t\t\t\"--%s value must be one of %q, %q, or %q\",\n\t\t\tprotocolFlagName, connect.ProtocolConnect, connect.ProtocolGRPC, connect.ProtocolGRPCWeb)\n\t}\n\n\tif f.NoKeepAlive && f.flagSet.Changed(keepAliveFlagName) {\n\t\treturn fmt.Errorf(\"--%s should not be specified if keepalive is disabled\", keepAliveFlagName)\n\t}\n\tif f.KeepAliveTimeSeconds <= 0 {\n\t\treturn fmt.Errorf(\"--%s value must be positive\", keepAliveFlagName)\n\t}\n\t// these two default to zero (which means no timeout in effect)\n\tif f.ConnectTimeoutSeconds < 0 || (f.ConnectTimeoutSeconds == 0 && f.flagSet.Changed(connectTimeoutFlagName)) {\n\t\treturn fmt.Errorf(\"--%s value must be positive\", connectTimeoutFlagName)\n\t}\n\n\tvar dataFile string\n\tif after, ok := strings.CutPrefix(f.Data, \"@\"); ok {\n\t\tdataFile = after\n\t\tif dataFile == \"\" {\n\t\t\treturn fmt.Errorf(\"--%s value starting with '@' must indicate '-' for stdin or a filename\", dataFlagName)\n\t\t}\n\t\tif dataFile == \"-\" && schemaIsStdin {\n\t\t\treturn fmt.Errorf(\"--%s and --%s flags cannot both indicate reading from stdin\", schemaFlagName, dataFlagName)\n\t\t}\n\t}\n\n\theaderFiles := map[string]struct{}{}\n\tif err := validateHeaders(f.Headers, headerFlagName, schemaIsStdin, false, headerFiles); err != nil {\n\t\treturn err\n\t}\n\treflectHeaderFiles := map[string]struct{}{}\n\tif err := validateHeaders(f.ReflectHeaders, reflectHeaderFlagName, schemaIsStdin, true, reflectHeaderFiles); err != nil {\n\t\treturn err\n\t}\n\tfor file := range reflectHeaderFiles {\n\t\tif file == dataFile {\n\t\t\treturn fmt.Errorf(\"--%s and --%s flags cannot indicate the same source\", dataFlagName, reflectHeaderFlagName)\n\t\t}\n\t}\n\n\treturn nil\n}\n\nfunc (f *flags) determineCredentials(\n\tctx context.Context,\n\tcontainer app.Container,\n\tverbosePrinter verbose.Printer,\n\thost string,\n) (string, error) {\n\tif f.User != \"\" {\n\t\t// this flag overrides any netrc-related flags\n\t\tparts := strings.SplitN(f.User, \":\", 2)\n\t\tusername := parts[0]\n\t\tvar password string\n\t\tif len(parts) < 2 {\n\t\t\tvar err error\n\t\t\tpassword, err = promptForPassword(ctx, container, fmt.Sprintf(\"Enter host password for user %q:\", username))\n\t\t\tif err != nil {\n\t\t\t\treturn \"\", fmt.Errorf(\"could not prompt for password: %w\", err)\n\t\t\t}\n\t\t} else {\n\t\t\tpassword = parts[1]\n\t\t}\n\t\treturn basicAuth(username, password), nil\n\t}\n\n\t// process netrc-related flags\n\tnetrcFile := f.NetrcFile\n\tif netrcFile == \"\" {\n\t\tif !f.Netrc {\n\t\t\t// no netrc file usage, so no creds\n\t\t\treturn \"\", nil\n\t\t}\n\t\tvar err error\n\t\tnetrcFile, err = netrc.GetFilePath(container)\n\t\tif err != nil {\n\t\t\treturn \"\", fmt.Errorf(\"could not determine path to .netrc file: %w\", err)\n\t\t}\n\t}\n\tif _, err := os.Stat(netrcFile); err != nil {\n\t\tif errors.Is(err, os.ErrNotExist) {\n\t\t\t// This mirrors the behavior of curl when a netrc file does not exist ¯\\_(ツ)_/¯\n\t\t\tverbosePrinter.Printf(\"* Couldn't find host %s in the file %q; using no credentials\", host, netrcFile)\n\t\t\treturn \"\", nil\n\t\t}\n\t\tif !strings.Contains(err.Error(), netrcFile) {\n\t\t\t// make sure error message contains path to file\n\t\t\treturn \"\", fmt.Errorf(\"could not read file: %s: %w\", netrcFile, err)\n\t\t}\n\t\treturn \"\", fmt.Errorf(\"could not read file: %w\", err)\n\t}\n\tmachine, err := netrc.GetMachineForNameAndFilePath(host, netrcFile)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"could not read file: %s: %w\", netrcFile, err)\n\t}\n\tif machine == nil {\n\t\t// no creds found for this host\n\t\tverbosePrinter.Printf(\"* Couldn't find host %s in the file %q; using no credentials\", host, netrcFile)\n\t\treturn \"\", nil\n\t}\n\tusername := machine.Login()\n\tif strings.ContainsRune(username, ':') {\n\t\treturn \"\", fmt.Errorf(\"invalid credentials found for %s in %s: username %s should not contain colon\", host, netrcFile, username)\n\t}\n\tpassword := machine.Password()\n\treturn basicAuth(username, password), nil\n}\n\nfunc (f *flags) getTLSConfig(authority string, printer verbose.Printer) (*tls.Config, error) {\n\treturn bufcurl.MakeVerboseTLSConfig(&bufcurl.TLSSettings{\n\t\tKeyFile: f.Key,\n\t\tCertFile: f.Cert,\n\t\tCACertFile: f.CACert,\n\t\tServerName: f.ServerName,\n\t\tInsecure: f.Insecure,\n\t\tHTTP2PriorKnowledge: f.HTTP2PriorKnowledge,\n\t\tHTTP3: f.HTTP3,\n\t}, authority, printer)\n}\n\nfunc promptForPassword(ctx context.Context, container app.Container, prompt string) (string, error) {\n\t// NB: The comments below and the mechanism of handling I/O async was\n\t// copied from the \"registry login\" command.\n\n\t// If a user sends a SIGINT to buf, the top-level application context is\n\t// cancelled and signal masks are reset. However, during an interactive\n\t// login the context is not respected; for example, it takes two SIGINTs\n\t// to interrupt the process.\n\n\t// Ideally we could just trigger an I/O timeout by setting the deadline on\n\t// stdin, but when stdin is connected to a terminal the underlying fd is in\n\t// blocking mode making it ineligible. As changing the mode of stdin is\n\t// dangerous, this change takes an alternate approach of simply returning\n\t// early.\n\n\t// Note that this does not gracefully handle the case where the terminal is\n\t// in no-echo mode, as is the case when prompting for a password\n\t// interactively.\n\tch := make(chan struct{})\n\tvar password string\n\tvar err error\n\tgo func() {\n\t\tdefer close(ch)\n\t\tpassword, err = bufcli.PromptUserForPassword(container, prompt)\n\t}()\n\tselect {\n\tcase <-ch:\n\t\treturn password, err\n\tcase <-ctx.Done():\n\t\tctxErr := ctx.Err()\n\t\t// Otherwise we will print \"Failure: context canceled\".\n\t\tif errors.Is(ctxErr, context.Canceled) {\n\t\t\t// Otherwise the next terminal line will be on the same line as the\n\t\t\t// last output from buf.\n\t\t\tif _, err := fmt.Fprintln(container.Stdout()); err != nil {\n\t\t\t\treturn \"\", err\n\t\t\t}\n\t\t\treturn \"\", errors.New(\"interrupted\")\n\t\t}\n\t\treturn \"\", ctxErr\n\t}\n}\n\nfunc basicAuth(username, password string) string {\n\tvar buf bytes.Buffer\n\tbuf.WriteString(username)\n\tbuf.WriteByte(':')\n\tbuf.WriteString(password)\n\treturn \"Basic \" + base64.StdEncoding.EncodeToString(buf.Bytes())\n}\n\nfunc validateHeaders(flags []string, flagName string, schemaIsStdin bool, allowAsterisk bool, headerFiles map[string]struct{}) error {\n\tvar hasAsterisk bool\n\tfor _, header := range flags {\n\t\tswitch {\n\t\tcase strings.HasPrefix(header, \"@\"):\n\t\t\tfile := strings.TrimPrefix(header, \"@\")\n\t\t\tif _, ok := headerFiles[file]; ok {\n\t\t\t\treturn fmt.Errorf(\"multiple --%s values refer to the same file %s\", flagName, file)\n\t\t\t}\n\t\t\tif file == \"\" {\n\t\t\t\treturn fmt.Errorf(\"--%s value starting with '@' must indicate '-' for stdin or a filename\", flagName)\n\t\t\t}\n\t\t\tif file == \"-\" && schemaIsStdin {\n\t\t\t\treturn fmt.Errorf(\"--%s and --%s flags cannot both indicate reading from stdin\", schemaFlagName, flagName)\n\t\t\t}\n\t\t\theaderFiles[file] = struct{}{}\n\t\tcase header == \"*\":\n\t\t\tif !allowAsterisk {\n\t\t\t\treturn fmt.Errorf(\"--%s value '*' is not valid\", flagName)\n\t\t\t}\n\t\t\tif hasAsterisk {\n\t\t\t\treturn fmt.Errorf(\"multiple --%s values both indicate '*'\", flagName)\n\t\t\t}\n\t\t\thasAsterisk = true\n\t\tcase header == \"\":\n\t\t\treturn fmt.Errorf(\"--%s value cannot be blank\", flagName)\n\t\tcase strings.ContainsRune(header, '\\n'):\n\t\t\treturn fmt.Errorf(\"--%s value cannot contain a newline\", flagName)\n\t\tdefault:\n\t\t\tparts := strings.SplitN(header, \":\", 2)\n\t\t\tif len(parts) < 2 {\n\t\t\t\treturn fmt.Errorf(\"--%s value is a malformed header: %q\", flagName, header)\n\t\t\t}\n\t\t}\n\t}\n\n\treturn nil\n}\n\nfunc verifyEndpointURL(urlArg string) (host string, isSecure bool, err error) {\n\tendpointURL, err := url.Parse(urlArg)\n\tif err != nil {\n\t\treturn \"\", false, fmt.Errorf(\"%q is not a valid endpoint URL: %w\", urlArg, err)\n\t}\n\tif endpointURL.Scheme != \"http\" && endpointURL.Scheme != \"https\" {\n\t\treturn \"\", false, fmt.Errorf(\"invalid endpoint URL: scheme %q is not supported\", endpointURL.Scheme)\n\t}\n\treturn endpointURL.Host, endpointURL.Scheme == \"https\", nil\n}\n\nfunc parseEndpointURL(urlArg string) (service, method, baseURL string, err error) {\n\tif strings.HasSuffix(urlArg, \"/\") {\n\t\treturn \"\", \"\", \"\", fmt.Errorf(\"invalid endpoint URL: %q should not end with a slash (/)\", urlArg)\n\t}\n\tparts := strings.Split(urlArg, \"/\")\n\tif len(parts) < 3 || parts[len(parts)-1] == \"\" || parts[len(parts)-2] == \"\" {\n\t\treturn \"\", \"\", \"\", fmt.Errorf(\"invalid endpoint URL: %q should end with two non-empty components indicating service and method\", urlArg)\n\t}\n\tservice, method = parts[len(parts)-2], parts[len(parts)-1]\n\tbaseURL = strings.TrimSuffix(urlArg, service+\"/\"+method)\n\tif baseURL == urlArg {\n\t\t// should not be possible due to above checks\n\t\treturn \"\", \"\", \"\", fmt.Errorf(\"failed to extract base URL from %q\", urlArg)\n\t}\n\treturn service, method, baseURL, nil\n}\n\nfunc run(ctx context.Context, container appext.Container, f *flags) (err error) {\n\tvar urlArg, host string\n\tvar isSecure bool\n\tif container.NumArgs() != 0 {\n\t\turlArg = container.Arg(0)\n\t\tvar err error\n\t\thost, isSecure, err = verifyEndpointURL(urlArg)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tif err := f.validate(urlArg != \"\", isSecure); err != nil {\n\t\treturn err\n\t}\n\tvar service, method, baseURL string\n\tswitch {\n\tcase f.ListServices || f.ListMethods:\n\t\tbaseURL = urlArg\n\tdefault:\n\t\tservice, method, baseURL, err = parseEndpointURL(urlArg)\n\t}\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tvar verbosePrinter verbose.Printer = verbose.NopPrinter\n\tif f.Verbose {\n\t\tverbosePrinter = verbose.NewPrinter(container.Stderr(), container.AppName())\n\t}\n\n\tvar clientOptions []connect.ClientOption\n\tswitch f.Protocol {\n\tcase connect.ProtocolGRPC:\n\t\tclientOptions = []connect.ClientOption{connect.WithGRPC()}\n\tcase connect.ProtocolGRPCWeb:\n\t\tclientOptions = []connect.ClientOption{connect.WithGRPCWeb()}\n\t}\n\tif f.Protocol != connect.ProtocolGRPC {\n\t\t// The transport will log trailers to the verbose printer. But if\n\t\t// we're not using standard grpc protocol, trailers are actually encoded\n\t\t// in an end-of-stream message for streaming calls. So this interceptor\n\t\t// will print the trailers for streaming calls when the response stream\n\t\t// is drained.\n\t\tclientOptions = append(clientOptions, connect.WithInterceptors(bufcurl.TraceTrailersInterceptor(verbosePrinter)))\n\t}\n\n\tdataSource := \"(argument)\"\n\tvar dataFileReference string\n\tif after, ok := strings.CutPrefix(f.Data, \"@\"); ok {\n\t\tdataFileReference = after\n\t\tif dataFileReference == \"-\" {\n\t\t\tdataSource = \"(stdin)\"\n\t\t} else {\n\t\t\tdataSource = dataFileReference\n\t\t\tif absFile, err := filepath.Abs(dataFileReference); err == nil {\n\t\t\t\tdataFileReference = absFile\n\t\t\t}\n\t\t}\n\t}\n\trequestHeaders, dataReader, err := bufcurl.LoadHeaders(f.Headers, dataFileReference, nil)\n\tif err != nil {\n\t\treturn err\n\t}\n\tuserAgent := f.UserAgent\n\tif userAgent == \"\" {\n\t\tuserAgent = bufcurl.DefaultUserAgent(f.Protocol, bufcli.Version)\n\t}\n\tif len(requestHeaders.Values(\"user-agent\")) == 0 {\n\t\trequestHeaders.Set(\"user-agent\", userAgent)\n\t}\n\tvar basicCreds *string\n\tif len(requestHeaders.Values(\"authorization\")) == 0 {\n\t\tcreds, err := f.determineCredentials(ctx, container, verbosePrinter, host)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif creds != \"\" {\n\t\t\trequestHeaders.Set(\"authorization\", creds)\n\t\t}\n\t\t// set this to non-nil so we know we've already determined credentials\n\t\tbasicCreds = &creds\n\t}\n\tif dataReader == nil {\n\t\tif dataFileReference == \"-\" {\n\t\t\tdataReader = os.Stdin\n\t\t} else if dataFileReference != \"\" {\n\t\t\tf, err := os.Open(dataFileReference)\n\t\t\tif err != nil {\n\t\t\t\treturn bufcurl.ErrorHasFilename(err, dataFileReference)\n\t\t\t}\n\t\t\tdataReader = f\n\t\t} else if f.Data != \"\" {\n\t\t\tdataReader = io.NopCloser(strings.NewReader(f.Data))\n\t\t}\n\t\t// dataReader is left nil when nothing specified on command-line\n\t}\n\tdefer func() {\n\t\tif dataReader != nil {\n\t\t\terr = errors.Join(err, dataReader.Close())\n\t\t}\n\t}()\n\n\tmakeTransportOnce := sync.OnceValues(func() (connect.HTTPClient, error) {\n\t\t// We do this lazily since some commands don't need a transport, like listing\n\t\t// services and methods and describing elements when the schema source is\n\t\t// something other than server reflection. We memoize the result to use the\n\t\t// same transport for multiple operations where useful (like for both server\n\t\t// reflection and for subsequently invoking an RPC).\n\t\tif urlArg == \"\" {\n\t\t\t// This shouldn't be possible since we check in flags.validate, but just in case\n\t\t\treturn nil, errors.New(\"URL positional argument is missing\")\n\t\t}\n\t\troundTripper, err := makeHTTPRoundTripper(f, isSecure, bufcurl.GetAuthority(host, requestHeaders), verbosePrinter)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn bufcurl.NewVerboseHTTPClient(roundTripper, verbosePrinter), nil\n\t})\n\n\toutput := container.Stdout()\n\tif f.Output != \"\" {\n\t\toutput, err = os.Create(f.Output)\n\t\tif err != nil {\n\t\t\treturn bufcurl.ErrorHasFilename(err, f.Output)\n\t\t}\n\t}\n\n\tresolvers := make([]bufcurl.Resolver, 0, len(f.Schemas)+2)\n\tif f.Reflect {\n\t\treflectHeaders, _, err := bufcurl.LoadHeaders(f.ReflectHeaders, \"\", requestHeaders)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif len(reflectHeaders.Values(\"authorization\")) == 0 {\n\t\t\tvar creds string\n\t\t\tif basicCreds != nil {\n\t\t\t\tcreds = *basicCreds\n\t\t\t} else {\n\t\t\t\tif creds, err = f.determineCredentials(ctx, container, verbosePrinter, host); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t}\n\t\t\tif creds != \"\" {\n\t\t\t\treflectHeaders.Set(\"authorization\", creds)\n\t\t\t}\n\t\t}\n\t\tif len(reflectHeaders.Values(\"user-agent\")) == 0 {\n\t\t\treflectHeaders.Set(\"user-agent\", userAgent)\n\t\t}\n\t\treflectProtocol, err := bufcurl.ParseReflectProtocol(f.ReflectProtocol)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\ttransport, err := makeTransportOnce()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tres, closeRes := bufcurl.NewServerReflectionResolver(ctx, transport, clientOptions, baseURL, reflectProtocol, reflectHeaders, verbosePrinter)\n\t\tdefer closeRes()\n\t\tresolvers = append(resolvers, res)\n\t}\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tfor _, schema := range f.Schemas {\n\t\timage, err := controller.GetImage(ctx, schema)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tresolvers = append(resolvers, bufcurl.ResolverForImage(image))\n\t}\n\t// Add a WKT resolver to the end of the end of the list. This is used\n\t// for printing a WKT encoded in a \"google.protobuf.Any\" type as JSON.\n\twktResolver, err := bufcurl.NewWKTResolver(ctx, container.Logger())\n\tif err != nil {\n\t\treturn err\n\t}\n\tres := bufcurl.CombineResolvers(append(resolvers, wktResolver)...)\n\n\tswitch {\n\tcase f.ListServices || f.ListMethods:\n\t\tserviceNames, err := res.ListServices()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tslices.Sort(serviceNames)\n\t\tfor _, serviceName := range serviceNames {\n\t\t\tif f.ListServices {\n\t\t\t\tif _, err := fmt.Fprintf(container.Stdout(), \"%s\\n\", serviceName); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tserviceDescriptor, err := bufcurl.ResolveServiceDescriptor(res, string(serviceName))\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t\tmethods := serviceDescriptor.Methods()\n\t\t\t\tlength := methods.Len()\n\t\t\t\tmethodNames := make([]protoreflect.Name, length)\n\t\t\t\tfor i := range length {\n\t\t\t\t\tmethodNames[i] = methods.Get(i).Name()\n\t\t\t\t}\n\t\t\t\tslices.Sort(methodNames)\n\t\t\t\tfor _, methodName := range methodNames {\n\t\t\t\t\tif _, err := fmt.Fprintf(container.Stdout(), \"%s/%s\\n\", serviceName, methodName); err != nil {\n\t\t\t\t\t\treturn err\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn nil\n\tdefault:\n\t\t// Invoke RPC\n\t\tmethodDescriptor, err := bufcurl.ResolveMethodDescriptor(res, service, method)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\ttransport, err := makeTransportOnce()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tinvoker := bufcurl.NewInvoker(container, verbosePrinter, methodDescriptor, res, f.EmitDefaults, transport, clientOptions, urlArg, output)\n\t\treturn invoker.Invoke(ctx, dataSource, dataReader, requestHeaders)\n\t}\n}\n\nfunc makeHTTPRoundTripper(f *flags, isSecure bool, authority string, printer verbose.Printer) (http.RoundTripper, error) {\n\tif f.HTTP3 {\n\t\treturn makeHTTP3RoundTripper(f, authority, printer)\n\t}\n\tvar dialer net.Dialer\n\tif f.ConnectTimeoutSeconds != 0 {\n\t\tdialer.Timeout = secondsToDuration(f.ConnectTimeoutSeconds)\n\t}\n\tif f.NoKeepAlive {\n\t\tdialer.KeepAlive = -1\n\t} else {\n\t\tdialer.KeepAlive = secondsToDuration(f.KeepAliveTimeSeconds)\n\t}\n\n\tvar dialFunc func(ctx context.Context, network, address string) (net.Conn, error)\n\tif f.UnixSocket != \"\" {\n\t\tdialFunc = func(ctx context.Context, network, addr string) (net.Conn, error) {\n\t\t\tprinter.Printf(\"* Dialing unix socket %s...\", f.UnixSocket)\n\t\t\treturn dialer.DialContext(ctx, \"unix\", f.UnixSocket)\n\t\t}\n\t} else {\n\t\tdialFunc = func(ctx context.Context, network, address string) (net.Conn, error) {\n\t\t\tprinter.Printf(\"* Dialing (%s) %s...\", network, address)\n\t\t\tconn, err := dialer.DialContext(ctx, network, address)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tprinter.Printf(\"* Connected to %s\", conn.RemoteAddr().String())\n\t\t\treturn conn, err\n\t\t}\n\t}\n\n\tvar dialTLSFunc func(ctx context.Context, network, address string) (net.Conn, error)\n\tif isSecure {\n\t\ttlsConfig, err := f.getTLSConfig(authority, printer)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tdialTLSFunc = func(ctx context.Context, network, addr string) (net.Conn, error) {\n\t\t\tconn, err := dialFunc(ctx, network, addr)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tprinter.Printf(\"* ALPN: offering %s\", strings.Join(tlsConfig.NextProtos, \",\"))\n\t\t\ttlsConn := tls.Client(conn, tlsConfig)\n\t\t\tif err := tlsConn.HandshakeContext(ctx); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\treturn tlsConn, nil\n\t\t}\n\t}\n\tprotocols := new(http.Protocols)\n\tprotocols.SetHTTP1(!f.HTTP2PriorKnowledge)\n\tprotocols.SetHTTP2(true)\n\tprotocols.SetUnencryptedHTTP2(f.HTTP2PriorKnowledge && !isSecure)\n\treturn &http.Transport{\n\t\tProxy: http.ProxyFromEnvironment,\n\t\tDialContext: dialFunc,\n\t\tDialTLSContext: dialTLSFunc,\n\t\tForceAttemptHTTP2: true,\n\t\tMaxIdleConns: 1,\n\t\tProtocols: protocols,\n\t}, nil\n}\n\nfunc makeHTTP3RoundTripper(f *flags, authority string, printer verbose.Printer) (http.RoundTripper, error) {\n\tquicCfg := &quic.Config{\n\t\tKeepAlivePeriod: -1,\n\t}\n\tif f.ConnectTimeoutSeconds != 0 {\n\t\tquicCfg.HandshakeIdleTimeout = secondsToDuration(f.ConnectTimeoutSeconds)\n\t}\n\tif !f.NoKeepAlive {\n\t\tquicCfg.KeepAlivePeriod = secondsToDuration(f.KeepAliveTimeSeconds)\n\t}\n\n\ttlsConfig, err := f.getTLSConfig(authority, printer)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tudpConn, err := net.ListenUDP(\"udp\", nil)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\ttransport := &quic.Transport{Conn: udpConn}\n\troundTripper := &http3.Transport{\n\t\tTLSClientConfig: tlsConfig,\n\t\tQUICConfig: quicCfg,\n\t\tDial: func(ctx context.Context, addr string, tlsCfg *tls.Config, cfg *quic.Config) (*quic.Conn, error) {\n\t\t\tprinter.Printf(\"* Dialing (udp) %s...\", addr)\n\t\t\tudpAddr, err := net.ResolveUDPAddr(\"udp\", addr)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tprinter.Printf(\"* ALPN: offering %s\", strings.Join(tlsCfg.NextProtos, \",\"))\n\t\t\tconn, err := transport.DialEarly(ctx, udpAddr, tlsCfg, cfg)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tprinter.Printf(\"* Connected to %s\", conn.RemoteAddr().String())\n\t\t\treturn conn, err\n\t\t},\n\t\tEnableDatagrams: false,\n\t\tAdditionalSettings: map[uint64]uint64{},\n\t\tMaxResponseHeaderBytes: 0,\n\t\tDisableCompression: false,\n\t}\n\treturn roundTripper, nil\n}\n\nfunc secondsToDuration(secs float64) time.Duration {\n\treturn time.Duration(float64(time.Second) * secs)\n}\n" }, { "path": "cmd/buf/internal/command/dep/depgraph/depgraph.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage depgraph\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"slices\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/pkg/dag\"\n\t\"github.com/bufbuild/buf/private/pkg/uuidutil\"\n\t\"github.com/google/uuid\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\terrorFormatFlagName = \"error-format\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\tformatFlagName = \"format\"\n\n\tdotFormatString = \"dot\"\n\tjsonFormatString = \"json\"\n)\n\nvar (\n\tallGraphFormatStrings = []string{\n\t\tdotFormatString,\n\t\tjsonFormatString,\n\t}\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Print the dependency graph\",\n\t\tLong: `As an example, if module in directory \"src/proto\" depends on module \"buf.build/foo/bar\"\nfrom the BSR with commit \"12345\", and \"buf.build/foo/bar:12345\" depends on module \"buf.build/foo/baz\"\nfrom the BSR with commit \"67890\", the following will be printed:\n\ndigraph {\n\n \"src/proto\" -> \"buf.build/foo/bar:12345\"\n \"buf.build/foo/bar:12345\" -> \"buf.build/foo/baz:67890\"\n\n}\n\nThe actual output may vary between CLI versions and has no stability guarantees, however the output\nwill always be in valid DOT format. If you'd like us to produce an alternative stable format\n(such as a Protobuf message that we serialize to JSON), let us know!\n\nSee https://graphviz.org to explore Graphviz and the DOT language.\nInstallation of graphviz will vary by platform, but is easy to install using homebrew:\n\nbrew install graphviz\n\nYou can easily visualize a dependency graph using the dot tool:\n\nbuf dep graph | dot -Tpng >| graph.png && open graph.png\n` + bufcli.GetSourceOrModuleLong(`the source or module to print the dependency graph for`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tErrorFormat string\n\tDisableSymlinks bool\n\t// special\n\tInputHashtag string\n\tFormat string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors printed to stderr. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\tdotFormatString,\n\t\tfmt.Sprintf(\n\t\t\t\"The format to print graph as. Must be one of %s\",\n\t\t\txstrings.SliceToString(allGraphFormatStrings),\n\t\t),\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t\tbufctl.WithFileAnnotationErrorFormat(flags.ErrorFormat),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspace, err := controller.GetWorkspace(ctx, input)\n\tif err != nil {\n\t\treturn err\n\t}\n\tgraph, err := bufmodule.ModuleSetToDAG(workspace)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar graphString string\n\tswitch flags.Format {\n\tcase dotFormatString:\n\t\tdotString, err := graph.DOTString(moduleToString)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tgraphString = dotString\n\tcase jsonFormatString:\n\t\t// We traverse each module (node) in the graph and populate the deps (outbound nodes).\n\t\t// We keep track of every module we have seen so we can update their d\n\t\tmoduleFullNameOrOpaqueIDToExternalModule := make(map[string]externalModule)\n\t\tif err := graph.WalkNodes(\n\t\t\tfunc(module bufmodule.Module, _ []bufmodule.Module, deps []bufmodule.Module) error {\n\t\t\t\tmoduleFullNameOrOpaqueID := moduleFullNameOrOpaqueID(module)\n\t\t\t\t// We have already populated this node through deps, we can skip module.\n\t\t\t\tif _, ok := moduleFullNameOrOpaqueIDToExternalModule[moduleFullNameOrOpaqueID]; ok {\n\t\t\t\t\treturn nil\n\t\t\t\t}\n\t\t\t\t// We first scaffold a module with no deps populated yet.\n\t\t\t\texternalModule, err := externalModuleNoDepsForModule(module)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t\tif err := externalModule.addDeps(deps, graph, moduleFullNameOrOpaqueIDToExternalModule, flags); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t\t// Sort the deps alphabetically before adding our external module.\n\t\t\t\tsortExternalModules(externalModule.Deps)\n\t\t\t\tmoduleFullNameOrOpaqueIDToExternalModule[moduleFullNameOrOpaqueID] = externalModule\n\t\t\t\treturn nil\n\t\t\t},\n\t\t); err != nil {\n\t\t\treturn err\n\t\t}\n\t\texternalModules := xslices.MapValuesToSlice(moduleFullNameOrOpaqueIDToExternalModule)\n\t\t// Sort all modules alphabetically.\n\t\tsortExternalModules(externalModules)\n\t\tdata, err := json.Marshal(externalModules)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tgraphString = string(data)\n\tdefault:\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"invalid value for --%s: %s\", formatFlagName, flags.Format)\n\t}\n\t_, err = fmt.Fprintln(container.Stdout(), graphString)\n\treturn err\n}\n\nfunc moduleToString(module bufmodule.Module) string {\n\tif moduleFullName := module.FullName(); moduleFullName != nil {\n\t\tcommitID := dashlessCommitIDStringForModule(module)\n\t\tif commitID != \"\" {\n\t\t\treturn moduleFullName.String() + \":\" + commitID\n\t\t}\n\t\treturn moduleFullName.String()\n\t}\n\treturn module.OpaqueID()\n}\n\n// moduleFullNameOrOpaqueID returns the FullName for a module if available, otherwise\n// it returns the OpaqueID.\nfunc moduleFullNameOrOpaqueID(module bufmodule.Module) string {\n\tif moduleFullName := module.FullName(); moduleFullName != nil {\n\t\treturn moduleFullName.String()\n\t}\n\treturn module.OpaqueID()\n}\n\n// dashlessCommitIDStringForModule returns the dashless UUID for the commit. If no commit\n// is set, we return an empty string.\nfunc dashlessCommitIDStringForModule(module bufmodule.Module) string {\n\tif commitID := module.CommitID(); commitID != uuid.Nil {\n\t\treturn uuidutil.ToDashless(commitID)\n\t}\n\treturn \"\"\n}\n\ntype externalModule struct {\n\t// FullName if remote, OpaqueID if no FullName\n\tName string `json:\"name,omitempty\" yaml:\"name,omitempty\"`\n\t// Dashless\n\tCommit string `json:\"commit,omitempty\" yaml:\"commit,omitempty\"`\n\tDigest string `json:\"digest,omitempty\" yaml:\"digest,omitempty\"`\n\tDeps []externalModule `json:\"deps,omitempty\" yaml:\"deps,omitempty\"`\n\tLocal bool `json:\"local,omitempty\" yaml:\"local,omitempty\"`\n}\n\nfunc (e *externalModule) addDeps(\n\tdeps []bufmodule.Module,\n\tgraph *dag.Graph[string, bufmodule.Module],\n\tmoduleFullNameOrOpaqueIDToExternalModule map[string]externalModule,\n\tflags *flags,\n) error {\n\tfor _, dep := range deps {\n\t\tdepFullNameOrOpaqueID := moduleFullNameOrOpaqueID(dep)\n\t\tdepExternalModule, ok := moduleFullNameOrOpaqueIDToExternalModule[depFullNameOrOpaqueID]\n\t\tif ok {\n\t\t\t// If this dependency has already been seen, we can simply update our current module\n\t\t\t// and return early.\n\t\t\te.Deps = append(e.Deps, depExternalModule)\n\t\t\treturn nil\n\t\t}\n\t\t// Otherwise, we create a new external module for our direct dependency. However, we do\n\t\t// not add it to our map yet, we only add it once all transitive dependencies have been\n\t\t// handled.\n\t\tdepExternalModule, err := externalModuleNoDepsForModule(dep)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\ttransitiveDeps, err := graph.OutboundNodes(dep.OpaqueID())\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif err := depExternalModule.addDeps(transitiveDeps, graph, moduleFullNameOrOpaqueIDToExternalModule, flags); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmoduleFullNameOrOpaqueIDToExternalModule[depFullNameOrOpaqueID] = depExternalModule\n\t\te.Deps = append(e.Deps, depExternalModule)\n\t}\n\treturn nil\n}\n\n// externalModuleNoDepsForModule returns an externalModule for the given bufmodule.Module\n// without populating the deps. This is because we want to populate the deps from the graph,\n// so we handle it outside of this function.\nfunc externalModuleNoDepsForModule(module bufmodule.Module) (externalModule, error) {\n\t// We always calculate the b5 digest here, we do not check the digest type that is stored\n\t// in buf.lock.\n\tdigest, err := module.Digest(bufmodule.DigestTypeB5)\n\tif err != nil {\n\t\treturn externalModule{}, err\n\t}\n\treturn externalModule{\n\t\tName: moduleFullNameOrOpaqueID(module),\n\t\tCommit: dashlessCommitIDStringForModule(module),\n\t\tDigest: digest.String(),\n\t\tLocal: module.IsLocal(),\n\t}, nil\n}\n\nfunc sortExternalModules(externalModules []externalModule) {\n\tslices.SortFunc(\n\t\texternalModules,\n\t\tfunc(a externalModule, b externalModule) int {\n\t\t\tif a.Name > b.Name {\n\t\t\t\treturn 1\n\t\t\t}\n\t\t\treturn -1\n\t\t},\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/dep/depprune/depprune.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage depprune\n\nimport (\n\t\"context\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/dep/internal\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n)\n\n// NewCommand returns a new prune Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n\tdeprecated string,\n\thidden bool,\n) *appcmd.Command {\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Prune unused dependencies from a buf.lock\",\n\t\tLong: `The first argument is the directory of your buf.yaml configuration file.\nDefaults to \".\" if no argument is specified.`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tDeprecated: deprecated,\n\t\tHidden: hidden,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container)\n\t\t\t},\n\t\t),\n\t}\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n) error {\n\tdirPath := \".\"\n\tif container.NumArgs() > 0 {\n\t\tdirPath = container.Arg(0)\n\t}\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspaceDepManager, err := controller.GetWorkspaceDepManager(ctx, dirPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredDepModuleRefs, err := workspaceDepManager.ConfiguredDepModuleRefs(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredDepModuleKeys, err := internal.ModuleKeysAndTransitiveDepModuleKeysForModuleRefs(\n\t\tctx,\n\t\tcontainer,\n\t\tconfiguredDepModuleRefs,\n\t\tworkspaceDepManager.BufLockFileDigestType(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn internal.Prune(\n\t\tctx,\n\t\tcontainer.Logger(),\n\t\tcontroller,\n\t\tconfiguredDepModuleKeys,\n\t\tworkspaceDepManager,\n\t\tdirPath,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/dep/depupdate/depupdate.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage depupdate\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"log/slog\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/dep/internal\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tonlyFlagName = \"only\"\n)\n\n// NewCommand returns a new update Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n\tdeprecated string,\n\thidden bool,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Update pinned module dependencies in a buf.lock\",\n\t\tLong: `Fetch the latest digests for the specified module references in buf.yaml,\nand write them and their transitive dependencies to buf.lock.\n\nThe first argument is the directory of the local module to update.\nDefaults to \".\" if no argument is specified.`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tDeprecated: deprecated,\n\t\tHidden: hidden,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tOnly []string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringSliceVar(\n\t\t&f.Only,\n\t\tonlyFlagName,\n\t\tnil,\n\t\t\"The name of the dependency to update. When set, only this dependency and its transitive dependencies are updated. May be passed multiple times\",\n\t)\n\t// TODO FUTURE: implement\n\t_ = flagSet.MarkHidden(onlyFlagName)\n}\n\n// run update the buf.lock file for a specific module.\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tdirPath := \".\"\n\tif container.NumArgs() > 0 {\n\t\tdirPath = container.Arg(0)\n\t}\n\tif len(flags.Only) > 0 {\n\t\t// TODO FUTURE: implement\n\t\treturn syserror.Newf(\"--%s is not implemented\", onlyFlagName)\n\t}\n\n\tlogger := container.Logger()\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspaceDepManager, err := controller.GetWorkspaceDepManager(ctx, dirPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredDepModuleRefs, err := workspaceDepManager.ConfiguredDepModuleRefs(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredDepModuleKeys, err := internal.ModuleKeysAndTransitiveDepModuleKeysForModuleRefs(\n\t\tctx,\n\t\tcontainer,\n\t\tconfiguredDepModuleRefs,\n\t\tworkspaceDepManager.BufLockFileDigestType(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tlogger.DebugContext(\n\t\tctx,\n\t\t\"all deps\",\n\t\tslog.Any(\"deps\", xslices.Map(configuredDepModuleKeys, bufmodule.ModuleKey.String)),\n\t)\n\n\t// Store the existing buf.lock data.\n\texistingDepModuleKeys, err := workspaceDepManager.ExistingBufLockFileDepModuleKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif configuredDepModuleKeys == nil && existingDepModuleKeys == nil {\n\t\t// No new configured deps were found, and no existing buf.lock deps were found, so there\n\t\t// is nothing to update, we can return here.\n\t\t// This ensures we do not create an empty buf.lock when one did not exist in the first\n\t\t// place and we do not need to go through the entire operation of updating non-existent\n\t\t// deps and building the image for tamper-proofing.\n\t\tlogger.Warn(fmt.Sprintf(\"No configured dependencies were found to update in %q.\", dirPath))\n\t\treturn nil\n\t}\n\texistingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingRemotePolicyKeys, err := workspaceDepManager.ExistingBufLockFileRemotePolicyKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingPolicyNameToRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFilePolicyNameToRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// We're about to edit the buf.lock file on disk. If we have a subsequent error,\n\t// attempt to revert the buf.lock file.\n\t//\n\t// TODO FUTURE: We should be able to update the buf.lock file in an in-memory bucket, then do the rebuild,\n\t// and if the rebuild is successful, then actually write to disk. It shouldn't even be that much work - just\n\t// overlay the new buf.lock file in a union bucket.\n\tdefer func() {\n\t\tif retErr != nil {\n\t\t\tretErr = errors.Join(retErr, workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, existingRemotePluginKeys, existingRemotePolicyKeys, existingPolicyNameToRemotePluginKeys))\n\t\t}\n\t}()\n\t// Edit the buf.lock file with the unpruned dependencies.\n\tif err := workspaceDepManager.UpdateBufLockFile(ctx, configuredDepModuleKeys, existingRemotePluginKeys, existingRemotePolicyKeys, existingPolicyNameToRemotePluginKeys); err != nil {\n\t\treturn err\n\t}\n\tworkspace, err := controller.GetWorkspace(ctx, dirPath, bufctl.WithIgnoreAndDisallowV1BufWorkYAMLs())\n\tif err != nil {\n\t\treturn err\n\t}\n\t// Validate that the workspace builds.\n\t// Building also has the side effect of doing tamper-proofing.\n\tif _, err := controller.GetImageForWorkspace(\n\t\tctx,\n\t\tworkspace,\n\t\t// This is a performance optimization - we don't need source code info.\n\t\tbufctl.WithImageExcludeSourceInfo(true),\n\t); err != nil {\n\t\treturn err\n\t}\n\t// Log warnings for users on unused configured deps.\n\treturn internal.LogUnusedConfiguredDepsForWorkspace(workspace, logger)\n}\n" }, { "path": "cmd/buf/internal/command/dep/internal/internal.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage internal\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log/slog\"\n\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/bufworkspace\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n)\n\n// ModuleKeysAndTransitiveDepModuleKeysForModuleRefs gets the ModuleKeys for the\n// ModuleRefs, and all the transitive dependencies.\nfunc ModuleKeysAndTransitiveDepModuleKeysForModuleRefs(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tmoduleRefs []bufparse.Ref,\n\tdigestType bufmodule.DigestType,\n) ([]bufmodule.ModuleKey, error) {\n\tmoduleKeyProvider, err := bufcli.NewModuleKeyProvider(container)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tmoduleKeys, err := moduleKeyProvider.GetModuleKeysForModuleRefs(\n\t\tctx,\n\t\tmoduleRefs,\n\t\tdigestType,\n\t)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn moduleKeysAndTransitiveDepModuleKeysForModuleKeys(ctx, container, moduleKeys)\n}\n\n// Prune prunes the buf.lock.\n//\n// Used by dep/mod prune.\nfunc Prune(\n\tctx context.Context,\n\tlogger *slog.Logger,\n\tcontroller bufctl.Controller,\n\t// Contains all the Modules and their transitive dependencies based on the buf.yaml.\n\t//\n\t// All dependencies must be within this group from RemoteDepsForModuleSet. If a dependency\n\t// is not within this group, this means it existed in the buf.lock from a previous buf dep update\n\t// call, but no longer is a declared remote dependency based on the current buf.yaml. In this\n\t// case, we error.\n\t//\n\t// This list is computed based on the result of ModuleKeysAndTransitiveDepModuleKeysForModuleRefs.\n\tbufYAMLBasedDepModuleKeys []bufmodule.ModuleKey,\n\tworkspaceDepManager bufworkspace.WorkspaceDepManager,\n\tdirPath string,\n) error {\n\tworkspace, err := controller.GetWorkspace(ctx, dirPath, bufctl.WithIgnoreAndDisallowV1BufWorkYAMLs())\n\tif err != nil {\n\t\treturn err\n\t}\n\t// Make sure the workspace builds.\n\tif _, err := controller.GetImageForWorkspace(\n\t\tctx,\n\t\tworkspace,\n\t\tbufctl.WithImageExcludeSourceInfo(true),\n\t); err != nil {\n\t\treturn err\n\t}\n\t// Compute those dependencies that are in buf.yaml that are not used at all, and warn\n\t// about them.\n\tif err := LogUnusedConfiguredDepsForWorkspace(workspace, logger); err != nil {\n\t\treturn err\n\t}\n\t// Step that actually computes remote dependencies based on imports. These are all\n\t// that is needed for buf.lock.\n\tdepModules, err := bufmodule.RemoteDepsForModuleSet(workspace)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdepModuleKeys, err := xslices.MapError(\n\t\tdepModules,\n\t\tfunc(remoteDep bufmodule.RemoteDep) (bufmodule.ModuleKey, error) {\n\t\t\treturn bufmodule.ModuleToModuleKey(remoteDep, workspaceDepManager.BufLockFileDigestType())\n\t\t},\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif err := validateModuleKeysContains(bufYAMLBasedDepModuleKeys, depModuleKeys); err != nil {\n\t\treturn err\n\t}\n\texistingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingRemotePolicyKeys, err := workspaceDepManager.ExistingBufLockFileRemotePolicyKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingPolicyNameToRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFilePolicyNameToRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn workspaceDepManager.UpdateBufLockFile(ctx, depModuleKeys, existingRemotePluginKeys, existingRemotePolicyKeys, existingPolicyNameToRemotePluginKeys)\n}\n\n// LogUnusedConfiguredDepsForWorkspace takes a workspace and logs the unused configured\n// dependencies as warnings to the user.\nfunc LogUnusedConfiguredDepsForWorkspace(\n\tworkspace bufworkspace.Workspace,\n\tlogger *slog.Logger,\n) error {\n\tmalformedDeps, err := bufworkspace.MalformedDepsForWorkspace(workspace)\n\tif err != nil {\n\t\treturn err\n\t}\n\tfor _, malformedDep := range malformedDeps {\n\t\tswitch t := malformedDep.Type(); t {\n\t\tcase bufworkspace.MalformedDepTypeUnused:\n\t\t\tlogger.Warn(fmt.Sprintf(\n\t\t\t\t`Module %[1]s is declared in your buf.yaml deps but is unused. This command only modifies buf.lock files, not buf.yaml files. Please remove %[1]s from your buf.yaml deps if it is not needed.`,\n\t\t\t\tmalformedDep.ModuleRef().FullName(),\n\t\t\t))\n\t\tdefault:\n\t\t\treturn fmt.Errorf(\"unknown MalformedDepType: %v\", t)\n\t\t}\n\t}\n\treturn nil\n}\n\n// moduleKeysAndTransitiveDepModuleKeysForModuleKeys returns the ModuleKeys\n// and all the transitive dependencies.\nfunc moduleKeysAndTransitiveDepModuleKeysForModuleKeys(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tmoduleKeys []bufmodule.ModuleKey,\n) ([]bufmodule.ModuleKey, error) {\n\tgraphProvider, err := bufcli.NewGraphProvider(container)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\t// Walk the graph to get all ModuleKeys including transitive dependencies.\n\tgraph, err := graphProvider.GetGraphForModuleKeys(ctx, moduleKeys)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar newModuleKeys []bufmodule.ModuleKey\n\tif err := graph.WalkNodes(\n\t\tfunc(moduleKey bufmodule.ModuleKey, _ []bufmodule.ModuleKey, _ []bufmodule.ModuleKey) error {\n\t\t\tnewModuleKeys = append(newModuleKeys, moduleKey)\n\t\t\treturn nil\n\t\t},\n\t); err != nil {\n\t\treturn nil, err\n\t}\n\treturn newModuleKeys, nil\n}\n\n// validateModuleKeysContains validates that containingModuleKeys is a superset of moduleKeys.\n//\n// This is used by Prune to validate that bufYAMLBasedDepModuleKeys are a superset of RemoteDepsForModuleSet.\n//\n// See comment on Prune.\nfunc validateModuleKeysContains(containingModuleKeys []bufmodule.ModuleKey, moduleKeys []bufmodule.ModuleKey) error {\n\tcontainingFullNameStringToModuleKey, err := getFullNameStringToModuleKey(containingModuleKeys)\n\tif err != nil {\n\t\treturn syserror.Newf(\"validateModuleKeysContains: containingModuleKeys: %w\", err)\n\t}\n\tmoduleFullNameStringToModuleKey, err := getFullNameStringToModuleKey(moduleKeys)\n\tif err != nil {\n\t\treturn syserror.Newf(\"validateModuleKeysContains: moduleKeys: %w\", err)\n\t}\n\tfor moduleFullNameString := range moduleFullNameStringToModuleKey {\n\t\tif _, ok := containingFullNameStringToModuleKey[moduleFullNameString]; !ok {\n\t\t\treturn fmt.Errorf(\n\t\t\t\t`Module %s is detected to be a still-used dependency from your existing buf.lock, but is not a declared dependency in your buf.yaml deps, and is not a transitive dependency of any declared dependency. Add %s to your buf.yaml deps.`,\n\t\t\t\tmoduleFullNameString,\n\t\t\t\tmoduleFullNameString,\n\t\t\t)\n\t\t}\n\t}\n\treturn nil\n}\n\n// All ModuleKeys are expected to be unique by FullName.\nfunc getFullNameStringToModuleKey(moduleKeys []bufmodule.ModuleKey) (map[string]bufmodule.ModuleKey, error) {\n\treturn xslices.ToUniqueValuesMap(\n\t\tmoduleKeys,\n\t\tfunc(moduleKey bufmodule.ModuleKey) string {\n\t\t\treturn moduleKey.FullName().String()\n\t\t},\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/export/export.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage export\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io/fs\"\n\t\"os\"\n\t\"strings\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/gen/data/datawkt\"\n\t\"github.com/bufbuild/buf/private/pkg/normalpath\"\n\t\"github.com/bufbuild/buf/private/pkg/storage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\texcludeImportsFlagName = \"exclude-imports\"\n\tpathsFlagName = \"path\"\n\toutputFlagName = \"output\"\n\toutputFlagShortName = \"o\"\n\tconfigFlagName = \"config\"\n\texcludePathsFlagName = \"exclude-path\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\tallFlagName = \"all\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Export proto files from one location to another\",\n\t\tLong: bufcli.GetSourceOrModuleLong(`the source or module to export`) + `\n\nExamples:\n\nExport proto files in to an output directory.\n\n $ buf export --output=\n\nExport current directory to another local directory.\n\n $ buf export . --output=\n\nExport the latest remote module to a local directory.\n\n $ buf export --output=\n\nExport a specific version of a remote module to a local directory.\n\n $ buf export --output=\n\nExport a git repo to a local directory.\n\n $ buf export https://github.com/owner/repository.git --output=\n`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tExcludeImports bool\n\tPaths []string\n\tOutput string\n\tConfig string\n\tExcludePaths []string\n\tDisableSymlinks bool\n\tAll bool\n\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindExcludeImports(flagSet, &f.ExcludeImports, excludeImportsFlagName)\n\tbufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)\n\tbufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)\n\tflagSet.StringVarP(\n\t\t&f.Output,\n\t\toutputFlagName,\n\t\toutputFlagShortName,\n\t\t\"\",\n\t\t`The output directory for exported files`,\n\t)\n\t_ = appcmd.MarkFlagRequired(flagSet, outputFlagName)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration`,\n\t)\n\tflagSet.BoolVar(\n\t\t&f.All,\n\t\tallFlagName,\n\t\tfalse,\n\t\t`When set, include any available documentation and license files for the exported input. If the input has more than one module, then the documentation and license file names will be suffixed with the module name.`,\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspace, err := controller.GetWorkspace(\n\t\tctx,\n\t\tinput,\n\t\tbufctl.WithTargetPaths(flags.Paths, flags.ExcludePaths),\n\t\tbufctl.WithConfigOverride(flags.Config),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tmoduleReadBucket := bufmodule.ModuleSetToModuleReadBucketWithOnlyProtoFiles(workspace)\n\n\tif err := os.MkdirAll(flags.Output, 0755); err != nil {\n\t\treturn err\n\t}\n\tvar options []storageos.ProviderOption\n\tif !flags.DisableSymlinks {\n\t\toptions = append(options, storageos.ProviderWithSymlinks())\n\t}\n\treadWriteBucket, err := storageos.NewProvider(options...).NewReadWriteBucket(\n\t\tflags.Output,\n\t\tstorageos.ReadWriteBucketWithSymlinksIfSupported(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// If the --all flag is set, then we need to pull the non-proto source files, documentation\n\t// and license files, for the input, if available.\n\t// We only add non-proto source files for target module(s).\n\t//\n\t// If the input has more than one target module (e.g. a workspace Git input), then we set\n\t// an identifier on the file path.\n\t// See [getNonProtoFilePath] docs for details on how that is set.\n\tif flags.All {\n\t\tseenModuleNamesForDocs := map[string]int{}\n\t\tseenModuleNamesForLicense := map[string]int{}\n\t\ttargetModules := bufmodule.ModuleSetTargetModules(workspace)\n\t\tfor _, module := range targetModules {\n\t\t\tdocFile, err := bufmodule.GetDocFile(ctx, module)\n\t\t\t// If the file is not found, then we ignore it.\n\t\t\tif err != nil && !errors.Is(err, fs.ErrNotExist) {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tif docFile != nil {\n\t\t\t\tdocFilePath := docFile.Path()\n\t\t\t\tif len(targetModules) > 1 {\n\t\t\t\t\tdocFilePath = getNonProtoFilePath(docFilePath, module, seenModuleNamesForDocs)\n\t\t\t\t}\n\t\t\t\tif err := storage.CopyReader(ctx, readWriteBucket, docFile, docFilePath); err != nil {\n\t\t\t\t\treturn errors.Join(err, docFile.Close())\n\t\t\t\t}\n\t\t\t\tif err := docFile.Close(); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t}\n\t\t\tlicenseFile, err := bufmodule.GetLicenseFile(ctx, module)\n\t\t\t// If the file is not found, then we ignore it.\n\t\t\tif err != nil && !errors.Is(err, fs.ErrNotExist) {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tif licenseFile != nil {\n\t\t\t\tlicenseFilePath := licenseFile.Path()\n\t\t\t\tif len(targetModules) > 1 {\n\t\t\t\t\tlicenseFilePath = getNonProtoFilePath(licenseFilePath, module, seenModuleNamesForLicense)\n\t\t\t\t}\n\t\t\t\tif err := storage.CopyReader(ctx, readWriteBucket, licenseFile, licenseFilePath); err != nil {\n\t\t\t\t\treturn errors.Join(err, licenseFile.Close())\n\t\t\t\t}\n\t\t\t\tif err := licenseFile.Close(); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// In the case where we are excluding imports, we are allowing users to specify an input\n\t// that may not have resolved imports (https://github.com/bufbuild/buf/issues/3002).\n\t// Thus we do not need to build the image, and instead we can return the non-import files\n\t// from the workspace.\n\tif flags.ExcludeImports {\n\t\tif err := moduleReadBucket.WalkFileInfos(\n\t\t\tctx,\n\t\t\tfunc(fileInfo bufmodule.FileInfo) error {\n\t\t\t\tmoduleFile, err := moduleReadBucket.GetFile(ctx, fileInfo.Path())\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn syserror.Wrap(err)\n\t\t\t\t}\n\t\t\t\tif err := storage.CopyReadObject(ctx, readWriteBucket, moduleFile); err != nil {\n\t\t\t\t\treturn errors.Join(err, moduleFile.Close())\n\t\t\t\t}\n\t\t\t\treturn moduleFile.Close()\n\t\t\t},\n\t\t\tbufmodule.WalkFileInfosWithOnlyTargetFiles(),\n\t\t); err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t}\n\n\timage, err := controller.GetImageForWorkspace(\n\t\tctx,\n\t\tworkspace,\n\t\tbufctl.WithImageExcludeSourceInfo(true),\n\t\tbufctl.WithImageExcludeImports(flags.ExcludeImports),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\timageFiles := image.Files()\n\tif len(imageFiles) == 0 {\n\t\treturn errors.New(\"no .proto target files found\")\n\t}\n\tfor _, imageFile := range image.Files() {\n\t\tmoduleFile, err := moduleReadBucket.GetFile(ctx, imageFile.Path())\n\t\tif err != nil {\n\t\t\tif errors.Is(err, fs.ErrNotExist) && datawkt.Exists(imageFile.Path()) {\n\t\t\t\t// Images include all imports, including WKTs. WKTs may or may not exist as part of the Workspace. They are implicitly\n\t\t\t\t// added to Images if they are not present in a Module or its dependencies. However, we want to make sure that\n\t\t\t\t// we still export them if they were part of a Module, or were part of an explicit dependency (for example,\n\t\t\t\t// buf.build/protocolbuffers/wellknowntypes).\n\t\t\t\t//\n\t\t\t\t// This is the only case where a file may exist in the Image but not in the Workspace. Any other case where a file\n\t\t\t\t// does not exist is a system error.\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\treturn syserror.Wrap(err)\n\t\t}\n\t\tif err := storage.CopyReadObject(ctx, readWriteBucket, moduleFile); err != nil {\n\t\t\treturn errors.Join(err, moduleFile.Close())\n\t\t}\n\t\tif err := moduleFile.Close(); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\n// This is a helper function that returns the path non-proto source files should be written\n// to if the --all flag has been set.\n//\n// This sets an identifier for the module using the module name, [bufparse.FullName.Name()]\n// if available, and if not, we use [module.OpaqueID()].\n//\n// e.g. README.foo.md, README.bar.md\n//\n// If a module name is repeated, e.g. acme/foo and bufbuild/foo both have the module name\n// \"foo\", then we use an incrementing integer based on the order they are seen in the workspace.\n//\n// e.g. README.foo.md, README.foo.2.md\nfunc getNonProtoFilePath(\n\tpath string,\n\tmodule bufmodule.Module,\n\tseenModuleNamesForPath map[string]int,\n) string {\n\tmoduleIdentifier := module.OpaqueID()\n\tif module.FullName() != nil {\n\t\tmoduleIdentifier = module.FullName().Name()\n\t\tseenModuleNamesForPath[module.FullName().Name()]++\n\t\tcount := seenModuleNamesForPath[module.FullName().Name()]\n\t\tif count > 1 {\n\t\t\tmoduleIdentifier = fmt.Sprintf(\"%s.%d\", module.FullName().Name(), count)\n\t\t}\n\t}\n\treturn fmt.Sprintf(\n\t\t\"%s.%s%s\",\n\t\tstrings.TrimSuffix(path, normalpath.Ext(path)),\n\t\tmoduleIdentifier,\n\t\tnormalpath.Ext(path),\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/format/format.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage format\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/buffetch\"\n\t\"github.com/bufbuild/buf/private/buf/bufformat\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/pkg/storage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tconfigFlagName = \"config\"\n\tdiffFlagName = \"diff\"\n\tdiffFlagShortName = \"d\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\terrorFormatFlagName = \"error-format\"\n\texcludePathsFlagName = \"exclude-path\"\n\texitCodeFlagName = \"exit-code\"\n\toutputFlagName = \"output\"\n\toutputFlagShortName = \"o\"\n\tpathsFlagName = \"path\"\n\twriteFlagName = \"write\"\n\twriteFlagShortName = \"w\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Format Protobuf files\",\n\t\tLong: `\nBy default, the source is the current directory and the formatted content is written to stdout.\n\nExamples:\n\nWrite the current directory's formatted content to stdout:\n\n $ buf format\n\nMost people will want to rewrite the files defined in the current directory in-place with -w:\n\n $ buf format -w\n\nDisplay a diff between the original and formatted content with -d\nWrite a diff instead of the formatted file:\n\n $ buf format simple/simple.proto -d\n\n $ diff -u simple/simple.proto.orig simple/simple.proto\n --- simple/simple.proto.orig\t2022-03-24 09:44:10.000000000 -0700\n +++ simple/simple.proto\t2022-03-24 09:44:10.000000000 -0700\n @@ -2,8 +2,7 @@\n\n package simple;\n\n -\n message Object {\n - string key = 1;\n - bytes value = 2;\n + string key = 1;\n + bytes value = 2;\n }\n\nUse the --exit-code flag to exit with a non-zero exit code if there is a diff:\n\n $ buf format --exit-code\n $ buf format -w --exit-code\n $ buf format -d --exit-code\n\nFormat a file, directory, or module reference by specifying a source e.g.\nWrite the formatted file to stdout:\n\n $ buf format simple/simple.proto\n\n syntax = \"proto3\";\n\n package simple;\n\n message Object {\n string key = 1;\n bytes value = 2;\n }\n\nWrite the formatted directory to stdout:\n\n $ buf format simple\n ...\n\nWrite the formatted module reference to stdout:\n\n $ buf format buf.build/acme/petapis\n ...\n\nWrite the result to a specified output file or directory with -o e.g.\n\nWrite the formatted file to another file:\n\n $ buf format simple/simple.proto -o simple/simple.formatted.proto\n\nWrite the formatted directory to another directory, creating it if it doesn't exist:\n\n $ buf format proto -o formatted\n\nThis also works with module references:\n\n $ buf format buf.build/acme/weather -o formatted\n\nRewrite the file(s) in-place with -w. e.g.\n\nRewrite a single file in-place:\n\n $ buf format simple.proto -w\n\nRewrite an entire directory in-place:\n\n $ buf format proto -w\n\nWrite a diff and rewrite the file(s) in-place:\n\n $ buf format simple -d -w\n\n $ diff -u simple/simple.proto.orig simple/simple.proto\n ...\n\nThe -w and -o flags cannot be used together in a single invocation.\n`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tConfig string\n\tDiff bool\n\tDisableSymlinks bool\n\tErrorFormat string\n\tExcludePaths []string\n\tExitCode bool\n\tPaths []string\n\tOutput string\n\tWrite bool\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)\n\tbufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.BoolVarP(\n\t\t&f.Diff,\n\t\tdiffFlagName,\n\t\tdiffFlagShortName,\n\t\tfalse,\n\t\t\"Display diffs instead of rewriting files\",\n\t)\n\tflagSet.BoolVar(\n\t\t&f.ExitCode,\n\t\texitCodeFlagName,\n\t\tfalse,\n\t\t\"Exit with a non-zero exit code if files were not already formatted\",\n\t)\n\tflagSet.BoolVarP(\n\t\t&f.Write,\n\t\twriteFlagName,\n\t\twriteFlagShortName,\n\t\tfalse,\n\t\t\"Rewrite files in-place\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors printed to stderr. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVarP(\n\t\t&f.Output,\n\t\toutputFlagName,\n\t\toutputFlagShortName,\n\t\t\"-\",\n\t\tfmt.Sprintf(\n\t\t\t`The output location for the formatted files. Must be one of format %s. If omitted, the result is written to stdout`,\n\t\t\tbuffetch.DirOrProtoFileFormatsString,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration`,\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tsource, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\t// We use getDirOrProtoFileRef to see if we have a valid DirOrProtoFileRef, and if so,\n\t// whether or not we have IncludePackageFiles Set.\n\t//\n\t// We abuse ExternalPaths below to say that if flags.Write is set, just write over\n\t// the ExternalPath, You can only really use flags.Write if you have a dir\n\t// or proto file. So, we abuse getDirOrProtoFileRef to determine if we have a writable source.\n\t// if flags.Write is set\n\t//\n\t// We also want to check that if we have a ProtoFileRef, we don't have IncludePackageFiles\n\t// set, regardless of if flags.Write is set.\n\tsourceDirOrProtoFileRef, sourceDirOrProtoFileRefErr := getDirOrProtoFileRef(ctx, container, source)\n\tif sourceDirOrProtoFileRefErr == nil {\n\t\tif err := validateNoIncludePackageFiles(sourceDirOrProtoFileRef); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tif flags.Write {\n\t\tif flags.Output != \"-\" {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"cannot use --%s when using --%s\", outputFlagName, writeFlagName)\n\t\t}\n\t\t// We abuse ExternalPaths below to say that if flags.Write is set, just write over\n\t\t// the ExternalPath. Also, you can only really use flags.Write if you have a dir\n\t\t// or proto file. So, we abuse getDirOrProtoFileRef to determine if we have a writable source.\n\t\tif sourceDirOrProtoFileRefErr != nil {\n\t\t\tif errors.Is(sourceDirOrProtoFileRefErr, buffetch.ErrModuleFormatDetectedForDirOrProtoFileRef) {\n\t\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"invalid input %q when using --%s: must be a directory or proto file\", source, writeFlagName)\n\t\t\t}\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"invalid input %q when using --%s: %v\", source, writeFlagName, sourceDirOrProtoFileRefErr)\n\t\t}\n\t}\n\tdirOrProtoFileRef, err := getDirOrProtoFileRef(ctx, container, flags.Output)\n\tif err != nil {\n\t\tif errors.Is(err, buffetch.ErrModuleFormatDetectedForDirOrProtoFileRef) {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be a directory or proto file\", outputFlagName)\n\t\t}\n\t\treturn err\n\t}\n\tif err := validateNoIncludePackageFiles(dirOrProtoFileRef); err != nil {\n\t\treturn err\n\t}\n\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t\tbufctl.WithFileAnnotationErrorFormat(flags.ErrorFormat),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspace, err := controller.GetWorkspace(\n\t\tctx,\n\t\tsource,\n\t\tbufctl.WithTargetPaths(flags.Paths, flags.ExcludePaths),\n\t\tbufctl.WithConfigOverride(flags.Config),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tmoduleReadBucket := bufmodule.ModuleReadBucketWithOnlyTargetFiles(\n\t\t// We only want to start with the target Modules. Otherwise, we're going to fetch potential\n\t\t// ModuleDeps that are not targeted, which may result in buf format making remote calls\n\t\t// when all we care to do is format local files.\n\t\t//\n\t\t// We need to make remote Modules even lazier to make sure that buf format is really\n\t\t// not making these remote calls, but this is one component of it.\n\t\tbufmodule.ModuleSetToModuleReadBucketWithOnlyProtoFilesForTargetModules(workspace),\n\t)\n\toriginalReadBucket := bufmodule.ModuleReadBucketToStorageReadBucket(moduleReadBucket)\n\tformattedReadBucket, err := bufformat.FormatBucket(ctx, originalReadBucket)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tdiffBuffer := bytes.NewBuffer(nil)\n\tchangedPaths, err := storage.DiffWithFilenames(\n\t\tctx,\n\t\tdiffBuffer,\n\t\toriginalReadBucket,\n\t\tformattedReadBucket,\n\t\tstorage.DiffWithExternalPaths(), // No need to set prefixes as the buckets are from the same location.\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdiffExists := diffBuffer.Len() > 0\n\tdefer func() {\n\t\tif retErr == nil && flags.ExitCode && diffExists {\n\t\t\tretErr = bufctl.ErrFileAnnotation\n\t\t}\n\t}()\n\n\tif flags.Diff {\n\t\tif diffExists {\n\t\t\tif _, err := io.Copy(container.Stdout(), diffBuffer); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\t// If we haven't overridden the output flag and haven't set write, we can stop here.\n\t\tif flags.Output == \"-\" && !flags.Write {\n\t\t\treturn nil\n\t\t}\n\t}\n\tif flags.Write {\n\t\tchangedPathSet := xslices.ToStructMap(changedPaths)\n\t\treturn storage.WalkReadObjects(\n\t\t\tctx,\n\t\t\tformattedReadBucket,\n\t\t\t\"\",\n\t\t\tfunc(readObject storage.ReadObject) error {\n\t\t\t\tif _, ok := changedPathSet[readObject.Path()]; !ok {\n\t\t\t\t\t// no change, nothing to re-write\n\t\t\t\t\treturn nil\n\t\t\t\t}\n\t\t\t\t// TODO FUTURE: This is a legacy hack that we shouldn't use. We should not\n\t\t\t\t// rely on external paths being writable.\n\t\t\t\t//\n\t\t\t\t// We do validation above on the flags.Write flag to quasi-ensure that ExternalPath\n\t\t\t\t// will be a real externalPath, but it's not great.\n\t\t\t\tfile, err := os.OpenFile(readObject.ExternalPath(), os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t\tdefer func() {\n\t\t\t\t\tretErr = errors.Join(retErr, file.Close())\n\t\t\t\t}()\n\t\t\t\tif _, err := file.ReadFrom(readObject); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t\treturn nil\n\t\t\t},\n\t\t)\n\t}\n\t// Both flags.Diff and flags.Write not set, do output logic.\n\tswitch t := dirOrProtoFileRef.(type) {\n\tcase buffetch.DirRef:\n\t\tif err := writeToDir(ctx, flags.DisableSymlinks, formattedReadBucket, t); err != nil {\n\t\t\treturn err\n\t\t}\n\tcase buffetch.ProtoFileRef:\n\t\tif err := writeToProtoFile(ctx, container, formattedReadBucket, t); err != nil {\n\t\t\treturn err\n\t\t}\n\tdefault:\n\t\treturn syserror.Newf(\"buffetch ref type must be dir or proto file: %T\", dirOrProtoFileRef)\n\t}\n\treturn nil\n}\n\nfunc writeToDir(\n\tctx context.Context,\n\tdisableSymlinks bool,\n\tformattedReadBucket storage.ReadBucket,\n\tdirRef buffetch.DirRef,\n) error {\n\tif err := createDirIfNotExists(dirRef.DirPath()); err != nil {\n\t\treturn err\n\t}\n\treadWriteBucket, err := newStorageosProvider(disableSymlinks).NewReadWriteBucket(\n\t\tdirRef.DirPath(),\n\t\tstorageos.ReadWriteBucketWithSymlinksIfSupported(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\t// We don't copy with ExternalPaths, we use Paths.\n\t// This is what we were always doing, including pre-refactor.\n\t_, err = storage.Copy(\n\t\tctx,\n\t\tformattedReadBucket,\n\t\treadWriteBucket,\n\t)\n\treturn err\n}\n\nfunc writeToProtoFile(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tformattedReadBucket storage.ReadBucket,\n\tprotoFileRef buffetch.ProtoFileRef,\n) (retErr error) {\n\twriteCloser, err := buffetch.NewProtoFileWriter(container.Logger()).PutProtoFile(\n\t\tctx,\n\t\tcontainer,\n\t\tprotoFileRef,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer func() {\n\t\tretErr = errors.Join(retErr, writeCloser.Close())\n\t}()\n\treturn storage.WalkReadObjects(\n\t\tctx,\n\t\tformattedReadBucket,\n\t\t\"\",\n\t\tfunc(readObject storage.ReadObject) error {\n\t\t\tdata, err := io.ReadAll(readObject)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tif _, err := writeCloser.Write(data); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\treturn nil\n\t\t},\n\t)\n}\n\nfunc createDirIfNotExists(dirPath string) error {\n\t// OK to use os.Stat instead of os.LStat here as this is CLI-only\n\tif _, err := os.Stat(dirPath); err != nil {\n\t\t// We don't need to check fileInfo.IsDir() because it's\n\t\t// already handled by the storageosProvider.\n\t\tif os.IsNotExist(err) {\n\t\t\tif err := os.MkdirAll(dirPath, 0755); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\t// We could os.RemoveAll if the overall command exits without error, but we're\n\t\t\t// not going to, just to be safe.\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc getDirOrProtoFileRef(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tvalue string,\n) (buffetch.DirOrProtoFileRef, error) {\n\treturn buffetch.NewDirOrProtoFileRefParser(\n\t\tcontainer.Logger(),\n\t).GetDirOrProtoFileRef(ctx, value)\n}\n\nfunc validateNoIncludePackageFiles(dirOrProtoFileRef buffetch.DirOrProtoFileRef) error {\n\tif protoFileRef, ok := dirOrProtoFileRef.(buffetch.ProtoFileRef); ok && protoFileRef.IncludePackageFiles() {\n\t\t// We should have a better answer here. Right now, it's\n\t\t// possible that the other files in the same package are defined\n\t\t// in a remote dependency, which makes it impossible to rewrite\n\t\t// in-place.\n\t\t//\n\t\t// In the case that the user uses the -w flag, we'll either need\n\t\t// to return an error, or omit the file that it can't rewrite in-place\n\t\t// (potentially including a debug log).\n\t\treturn appcmd.NewInvalidArgumentError(\"cannot specify include_package_files=true with format\")\n\t}\n\treturn nil\n}\n\nfunc newStorageosProvider(disableSymlinks bool) storageos.Provider {\n\tvar options []storageos.ProviderOption\n\tif !disableSymlinks {\n\t\toptions = append(options, storageos.ProviderWithSymlinks())\n\t}\n\treturn storageos.NewProvider(options...)\n}\n" }, { "path": "cmd/buf/internal/command/generate/generate.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage generate\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log/slog\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/bufgen\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\ttemplateFlagName = \"template\"\n\tbaseOutDirPathFlagName = \"output\"\n\tbaseOutDirPathFlagShortName = \"o\"\n\tdeleteOutsFlagName = \"clean\"\n\terrorFormatFlagName = \"error-format\"\n\tconfigFlagName = \"config\"\n\tpathsFlagName = \"path\"\n\tincludeImportsFlagName = \"include-imports\"\n\tincludeWKTFlagName = \"include-wkt\"\n\texcludePathsFlagName = \"exclude-path\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\ttypeFlagName = \"type\"\n\ttypeDeprecatedFlagName = \"include-types\"\n\texcludeTypeFlagName = \"exclude-type\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Generate code with protoc plugins\",\n\t\tLong: `This command uses a template file of the shape:\n\n # buf.gen.yaml\n # The version of the generation template.\n # The valid values are v1beta1, v1 and v2.\n # Required.\n version: v2\n # When clean is set to true, delete the directories, zip files, and/or jar files specified in the\n # \"out\" field for all plugins before running code generation. Defaults to false.\n # Optional.\n clean: true\n # The plugins to run.\n # Required.\n plugins:\n # Use the plugin hosted at buf.build/protocolbuffers/go at version v1.28.1.\n # If version is omitted, uses the latest version of the plugin.\n # One of \"remote\", \"local\" and \"protoc_builtin\" is required.\n - remote: buf.build/protocolbuffers/go:v1.28.1\n # The relative output directory.\n # Required.\n out: gen/go\n # The revision of the remote plugin to use, a sequence number that Buf\n # increments when rebuilding or repackaging the plugin.\n revision: 4\n # Any options to provide to the plugin.\n # This can be either a single string or a list of strings.\n # Optional.\n opt: paths=source_relative\n # Whether to generate code for imported files as well.\n # Optional.\n include_imports: false\n # Whether to generate code for the well-known types.\n # Optional.\n include_wkt: false\n # Include only these types for this plugin.\n # Optional.\n types:\n - \"foo.v1.User\"\n # Exclude these types for this plugin.\n # Optional.\n exclude_types:\n - \"buf.validate.oneof\"\n - \"buf.validate.message\"\n - \"buf.validate.field\"\"\n\n # The name of a local plugin if discoverable in \"${PATH}\" or its path in the file system.\n - local: protoc-gen-es\n out: gen/es\n include_imports: true\n include_wkt: true\n\n # The full invocation of a local plugin can be specified as a list.\n - local: [\"go\", \"run\", \"path/to/plugin.go\"]\n out: gen/plugin\n # The generation strategy to use. There are two options:\n #\n # 1. \"directory\"\n #\n # This will result in buf splitting the input files by directory, and making separate plugin\n # invocations in parallel. This is roughly the concurrent equivalent of:\n #\n # for dir in $(find . -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq); do\n # protoc -I . $(find \"${dir}\" -name '*.proto')\n # done\n #\n # Almost every Protobuf plugin either requires this, or works with this,\n # and this is the recommended and default value.\n #\n # 2. \"all\"\n #\n # This will result in buf making a single plugin invocation with all input files.\n # This is roughly the equivalent of:\n #\n # protoc -I . $(find . -name '*.proto')\n #\n # This is needed for certain plugins that expect all files to be given at once.\n # This is also the only strategy for remote plugins.\n #\n # If omitted, \"directory\" is used. Most users should not need to set this option.\n # Optional.\n strategy: directory\n\n # \"protoc_builtin\" specifies a plugin that comes with protoc, without the \"protoc-gen-\" prefix.\n - protoc_builtin: java\n out: gen/java\n # Path to protoc. If not specified, the protoc installation in \"${PATH}\" is used.\n # Optional.\n protoc_path: path/to/protoc\n\n # Managed mode modifies file options and/or field options on the fly.\n managed:\n # Enables managed mode.\n enabled: true\n\n # Each override rule specifies an option, the value for this option and\n # optionally the files/fields for which the override is applied.\n #\n # The accepted file options are:\n # - java_package\n # - java_package_prefix\n # - java_package_suffix\n # - java_multiple_files\n # - java_outer_classname\n # - java_string_check_utf8\n # - go_package\n # - go_package_prefix\n # - optimize_for\n # - csharp_namespace\n # - csharp_namespace_prefix\n # - ruby_package\n # - ruby_package_suffix\n # - objc_class_prefix\n # - php_namespace\n # - php_metadata_namespace\n # - php_metadata_namespace_suffix\n # - cc_enable_arenas\n #\n # An override rule can apply to a field option.\n # The accepted field options are:\n # - jstype\n #\n # If multiple overrides for the same option apply to a file or field,\n # the last rule takes effect.\n # Optional.\n override:\n # Sets \"go_package_prefix\" to \"foo/bar/baz\" for all files.\n - file_option: go_package_prefix\n value: foo/bar/baz\n\n # Sets \"java_package_prefix\" to \"net.foo\" for files in \"buf.build/foo/bar\".\n - file_option: java_package_prefix\n value: net.foo\n module: buf.build/foo/bar\n\n # Sets \"java_package_prefix\" to \"dev\" for \"file.proto\".\n # This overrides the value \"net.foo\" for \"file.proto\" from the previous rule.\n - file_option: java_package_prefix\n value: dev\n module: buf.build/foo/bar\n path: file.proto\n\n # Sets \"go_package\" to \"x/y/z\" for all files in directory \"x/y/z\".\n - file_option: go_package\n value: foo/bar/baz\n path: x/y/z\n\n # Sets a field's \"jstype\" to \"JS_NORMAL\".\n - field_option: jstype\n value: JS_STRING\n field: foo.v1.Bar.baz\n\n # Disables managed mode under certain conditions.\n # Takes precedence over \"overrides\".\n # Optional.\n disable:\n # Do not modify any options for files in this module.\n - module: buf.build/googleapis/googleapis\n\n # Do not modify any options for this file.\n - module: buf.build/googleapis/googleapis\n path: foo/bar/file.proto\n\n # Do not modify \"java_multiple_files\" for any file\n - file_option: java_multiple_files\n\n # Do not modify \"csharp_namespace\" for files in this module.\n - module: buf.build/acme/weather\n file_option: csharp_namespace\n\n # The inputs to generate code for.\n # The inputs here are ignored if an input is specified as a command line argument.\n # Each input is one of \"directory\", \"git_repo\", \"module\", \"tarball\", \"zip_archive\",\n # \"proto_file\", \"binary_image\", \"json_image\", \"text_image\" and \"yaml_image\".\n # Optional.\n inputs:\n # The path to a directory.\n - directory: x/y/z\n\n # The URL of a Git repository.\n - git_repo: https://github.com/acme/weather.git\n # The branch to clone.\n # Optional.\n branch: dev\n # The subdirectory in the repository to use.\n # Optional.\n subdir: proto\n # How deep of a clone to perform.\n # Optional.\n depth: 30\n\n # The URL of a BSR module.\n - module: buf.build/acme/weather\n # Only generate code for these types.\n # Optional.\n types:\n - \"foo.v1.User\"\n - \"foo.v1.UserService\"\n # Exclude these types.\n # Optional.\n exclude_types:\n - \"buf.validate\"\n # Only generate code for files in these paths.\n # If empty, include all paths.\n paths:\n - a/b/c\n - a/b/d\n # Do not generate code for files in these paths.\n exclude_paths:\n - a/b/c/x.proto\n - a/b/d/y.proto\n\n # The URL or path to a tarball.\n - tarball: a/b/x.tar.gz\n # The relative path within the archive to use as the base directory.\n # Optional.\n subdir: proto\n\n # The compression scheme, derived from the file extension if unspecified.\n # \".tgz\" and \".tar.gz\" extensions automatically use Gzip.\n # \".tar.zst\" automatically uses Zstandard.\n # Optional.\n compression: gzip\n\n # Reads at the relative path and strips some number of components.\n # Optional.\n strip_components: 2\n\n # The URL or path to a zip archive.\n - zip_archive: https://github.com/googleapis/googleapis/archive/master.zip\n # The number of directories to strip.\n # Optional.\n strip_components: 1\n\n # The path to a specific proto file.\n - proto_file: foo/bar/baz.proto\n # Whether to generate code for files in the same package as well, default to false.\n # Optional.\n include_package_files: true\n\n # A Buf image in binary format.\n # Other image formats are \"yaml_image\", \"text_image\" and \"json_image\".\n - binary_image: image.binpb.gz\n # The compression scheme of the image file, derived from file extension if unspecified.\n # Optional.\n compression: gzip\n\nAs an example, here's a typical \"buf.gen.yaml\" go and grpc, assuming\n\"protoc-gen-go\" and \"protoc-gen-go-grpc\" are on your \"$PATH\":\n\n # buf.gen.yaml\n version: v2\n plugins:\n - local: protoc-gen-go\n out: gen/go\n opt: paths=source_relative\n - local: protoc-gen-go-grpc\n out: gen/go\n opt:\n - paths=source_relative\n - require_unimplemented_servers=false\n\nBy default, buf generate will look for a file of this shape named\n\"buf.gen.yaml\" in your current directory. This can be thought of as a template\nfor the set of plugins you want to invoke.\n\nThe first argument is the source, module, or image to generate from.\nDefaults to \".\" if no argument is specified.\n\nUse buf.gen.yaml as template, current directory as input:\n\n $ buf generate\n\nSame as the defaults (template of \"buf.gen.yaml\", current directory as input):\n\n $ buf generate --template buf.gen.yaml .\n\nThe --template flag also takes YAML or JSON data as input, so it can be used without a file:\n\n $ buf generate --template '{\"version\":\"v2\",\"plugins\":[{\"local\":\"protoc-gen-go\",\"out\":\"gen/go\"}]}'\n\nDownload the repository and generate code stubs per the bar.yaml template:\n\n $ buf generate --template bar.yaml https://github.com/foo/bar.git\n\nGenerate to the bar/ directory, prepending bar/ to the out directives in the template:\n\n $ buf generate --template bar.yaml -o bar https://github.com/foo/bar.git\n\nThe paths in the template and the -o flag will be interpreted as relative to the\ncurrent directory, so you can place your template files anywhere.\n\nIf you only want to generate stubs for a subset of your input, you can do so via the --path. e.g.\n\nOnly generate for the files in the directories proto/foo and proto/bar:\n\n $ buf generate --path proto/foo --path proto/bar\n\nOnly generate for the files proto/foo/foo.proto and proto/foo/bar.proto:\n\n $ buf generate --path proto/foo/foo.proto --path proto/foo/bar.proto\n\nOnly generate for the files in the directory proto/foo on your git repository:\n\n $ buf generate --template buf.gen.yaml https://github.com/foo/bar.git --path proto/foo\n\nNote that all paths must be contained within the same module. For example, if you have a\nmodule in \"proto\", you cannot specify \"--path proto\", however \"--path proto/foo\" is allowed\nas \"proto/foo\" is contained within \"proto\".\n\nPlugins are invoked in the order they are specified in the template, but each plugin\nhas a per-directory parallel invocation, with results from each invocation combined\nbefore writing the result.\n\nInsertion points are processed in the order the plugins are specified in the template.\n`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tTemplate string\n\tBaseOutDirPath string\n\tDeleteOuts *bool\n\tErrorFormat string\n\tFiles []string\n\tConfig string\n\tPaths []string\n\tIncludeImportsOverride *bool\n\tIncludeWKTOverride *bool\n\tExcludePaths []string\n\tDisableSymlinks bool\n\t// We may be able to bind two flags to one string slice but I don't\n\t// want to find out what will break if we do.\n\tTypes []string\n\tTypesDeprecated []string\n\tExcludeTypes []string\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)\n\tbufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)\n\tbindBoolPointer(\n\t\tflagSet,\n\t\tincludeImportsFlagName,\n\t\t&f.IncludeImportsOverride,\n\t\t\"Also generate all imports except for Well-Known Types\",\n\t)\n\tbindBoolPointer(\n\t\tflagSet,\n\t\tincludeWKTFlagName,\n\t\t&f.IncludeWKTOverride,\n\t\tfmt.Sprintf(\n\t\t\t\"Also generate Well-Known Types. Cannot be set to true without setting --%s to true\",\n\t\t\tincludeImportsFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Template,\n\t\ttemplateFlagName,\n\t\t\"\",\n\t\t`The generation template file or data to use. Must be in either YAML or JSON format`,\n\t)\n\tflagSet.StringVarP(\n\t\t&f.BaseOutDirPath,\n\t\tbaseOutDirPathFlagName,\n\t\tbaseOutDirPathFlagShortName,\n\t\t\".\",\n\t\t`The base directory to generate to. This is prepended to the out directories in the generation template`,\n\t)\n\tbindBoolPointer(\n\t\tflagSet,\n\t\tdeleteOutsFlagName,\n\t\t&f.DeleteOuts,\n\t\t`Prior to generation, delete the directories, jar files, or zip files that the plugins will write to. Allows cleaning of existing assets without having to call rm -rf`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors, printed to stderr. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration`,\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.Types,\n\t\ttypeFlagName,\n\t\tnil,\n\t\t\"The types (package, message, enum, extension, service, method) that should be included in this image. When specified, the resulting image will only include descriptors to describe the requested types. Flag usage overrides buf.gen.yaml\",\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.TypesDeprecated,\n\t\ttypeDeprecatedFlagName,\n\t\tnil,\n\t\t\"The types (package, message, enum, extension, service, method) that should be included in this image. When specified, the resulting image will only include descriptors to describe the requested types. Flag usage overrides buf.gen.yaml\",\n\t)\n\tflagSet.StringSliceVar(\n\t\t&f.ExcludeTypes,\n\t\texcludeTypeFlagName,\n\t\tnil,\n\t\t\"The types (package, message, enum, extension, service, method) that should be excluded from this image. When specified, the resulting image will omit descriptors for the specified types and remove any references to them, such as fields typed to an excluded message or enum, or custom options tied to an excluded extension. The image is first filtered by the included types, then further reduced by the excluded. Flag usage overrides buf.gen.yaml\",\n\t)\n\t_ = flagSet.MarkDeprecated(typeDeprecatedFlagName, fmt.Sprintf(\"use --%s instead\", typeFlagName))\n\t_ = flagSet.MarkHidden(typeDeprecatedFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tlogger := container.Logger()\n\tif flags.IncludeWKTOverride != nil &&\n\t\t*flags.IncludeWKTOverride &&\n\t\t(flags.IncludeImportsOverride == nil || !*flags.IncludeImportsOverride) {\n\t\t// You need to set --include-imports to true if you set --include-wkt to true, which isn’t great.\n\t\t// The alternative is to have --include-wkt implicitly set --include-imports, but this could be surprising.\n\t\t// Or we could rename --include-wkt to --include-imports-and/with-wkt. But the summary is that the flag\n\t\t// only makes sense in the context of including imports.\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"Cannot set --%s to true without setting --%s to true\", includeWKTFlagName, includeImportsFlagName)\n\t}\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \"\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar storageosProvider storageos.Provider\n\tif flags.DisableSymlinks {\n\t\tstorageosProvider = storageos.NewProvider()\n\t} else {\n\t\tstorageosProvider = storageos.NewProvider(storageos.ProviderWithSymlinks())\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t\tbufctl.WithFileAnnotationErrorFormat(flags.ErrorFormat),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tclientConfig, err := bufcli.NewConnectClientConfig(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tbufGenYAMLFile, err := readBufGenYAMLFile(ctx, storageosProvider, flags.Template)\n\tif err != nil {\n\t\treturn err\n\t}\n\timages, err := getInputImages(\n\t\tctx,\n\t\tlogger,\n\t\tcontroller,\n\t\tinput,\n\t\tbufGenYAMLFile,\n\t\tflags.Config,\n\t\tflags.Paths,\n\t\tflags.ExcludePaths,\n\t\tappend(flags.Types, flags.TypesDeprecated...),\n\t\tflags.ExcludeTypes,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tgenerateOptions := []bufgen.GenerateOption{\n\t\tbufgen.GenerateWithBaseOutDirPath(flags.BaseOutDirPath),\n\t}\n\tif flags.DeleteOuts != nil {\n\t\tgenerateOptions = append(\n\t\t\tgenerateOptions,\n\t\t\tbufgen.GenerateWithDeleteOuts(*flags.DeleteOuts),\n\t\t)\n\t}\n\tif flags.IncludeImportsOverride != nil {\n\t\tgenerateOptions = append(\n\t\t\tgenerateOptions,\n\t\t\tbufgen.GenerateWithIncludeImportsOverride(*flags.IncludeImportsOverride),\n\t\t)\n\t}\n\tif flags.IncludeWKTOverride != nil {\n\t\tgenerateOptions = append(\n\t\t\tgenerateOptions,\n\t\t\tbufgen.GenerateWithIncludeWellKnownTypesOverride(*flags.IncludeWKTOverride),\n\t\t)\n\t}\n\treturn bufgen.NewGenerator(\n\t\tlogger,\n\t\tstorageosProvider,\n\t\tclientConfig,\n\t).Generate(\n\t\tctx,\n\t\tcontainer,\n\t\tbufGenYAMLFile.GenerateConfig(),\n\t\timages,\n\t\tgenerateOptions...,\n\t)\n}\n\nfunc readBufGenYAMLFile(\n\tctx context.Context,\n\tstorageosProvider storageos.Provider,\n\ttemplatePath string,\n) (bufconfig.BufGenYAMLFile, error) {\n\ttemplatePathExtension := filepath.Ext(templatePath)\n\tswitch {\n\tcase templatePath == \"\":\n\t\tbucket, err := storageosProvider.NewReadWriteBucket(\".\", storageos.ReadWriteBucketWithSymlinksIfSupported())\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn bufconfig.GetBufGenYAMLFileForPrefix(ctx, bucket, \".\")\n\tcase templatePathExtension == \".yaml\" || templatePathExtension == \".yml\" || templatePathExtension == \".json\":\n\t\t// We should not read from a bucket at \".\" because this path can jump context.\n\t\tconfigFile, err := os.Open(templatePath)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tdefer configFile.Close()\n\t\treturn bufconfig.ReadBufGenYAMLFile(configFile)\n\tdefault:\n\t\treturn bufconfig.ReadBufGenYAMLFile(strings.NewReader(templatePath))\n\t}\n}\n\nfunc getInputImages(\n\tctx context.Context,\n\tlogger *slog.Logger,\n\tcontroller bufctl.Controller,\n\tinputSpecified string,\n\tbufGenYAMLFile bufconfig.BufGenYAMLFile,\n\tmoduleConfigOverride string,\n\ttargetPathsOverride []string,\n\texcludePathsOverride []string,\n\tincludeTypesOverride []string,\n\texcludeTypesOverride []string,\n) ([]bufimage.Image, error) {\n\t// If input is specified on the command line, we use that. If input is not\n\t// specified on the command line, use the default input.\n\tif inputSpecified != \"\" || len(bufGenYAMLFile.InputConfigs()) == 0 {\n\t\tinput := \".\"\n\t\tif inputSpecified != \"\" {\n\t\t\tinput = inputSpecified\n\t\t}\n\t\tvar includeTypes []string\n\t\tif typesConfig := bufGenYAMLFile.GenerateConfig().GenerateTypeConfig(); typesConfig != nil {\n\t\t\tincludeTypes = typesConfig.IncludeTypes()\n\t\t}\n\t\tif len(includeTypesOverride) > 0 {\n\t\t\tincludeTypes = includeTypesOverride\n\t\t}\n\t\tvar excludeTypes []string\n\t\tif len(excludeTypesOverride) > 0 {\n\t\t\texcludeTypes = excludeTypesOverride\n\t\t}\n\t\tinputImage, err := controller.GetImage(\n\t\t\tctx,\n\t\t\tinput,\n\t\t\tbufctl.WithConfigOverride(moduleConfigOverride),\n\t\t\tbufctl.WithTargetPaths(targetPathsOverride, excludePathsOverride),\n\t\t\tbufctl.WithImageIncludeTypes(includeTypes),\n\t\t\tbufctl.WithImageExcludeTypes(excludeTypes),\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn []bufimage.Image{inputImage}, nil\n\t}\n\tvar inputImages []bufimage.Image\n\tfor _, inputConfig := range bufGenYAMLFile.InputConfigs() {\n\t\ttargetPaths := inputConfig.TargetPaths()\n\t\tif len(targetPathsOverride) > 0 {\n\t\t\ttargetPaths = targetPathsOverride\n\t\t}\n\t\texcludePaths := inputConfig.ExcludePaths()\n\t\tif len(excludePathsOverride) > 0 {\n\t\t\texcludePaths = excludePathsOverride\n\t\t}\n\t\tincludeTypes := inputConfig.IncludeTypes()\n\t\tif len(includeTypesOverride) > 0 {\n\t\t\tincludeTypes = includeTypesOverride\n\t\t}\n\t\texcludeTypes := inputConfig.ExcludeTypes()\n\t\tif len(excludeTypesOverride) > 0 {\n\t\t\texcludeTypes = excludeTypesOverride\n\t\t}\n\t\tinputImage, err := controller.GetImageForInputConfig(\n\t\t\tctx,\n\t\t\tinputConfig,\n\t\t\tbufctl.WithConfigOverride(moduleConfigOverride),\n\t\t\tbufctl.WithTargetPaths(targetPaths, excludePaths),\n\t\t\tbufctl.WithImageIncludeTypes(includeTypes),\n\t\t\tbufctl.WithImageExcludeTypes(excludeTypes),\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tinputImages = append(inputImages, inputImage)\n\t}\n\treturn inputImages, nil\n}\n\n// TODO FUTURE: where does this belong? A flagsext package?\n// value must not be nil.\nfunc bindBoolPointer(flagSet *pflag.FlagSet, name string, value **bool, usage string) {\n\tflag := flagSet.VarPF(\n\t\t&boolPointerValue{\n\t\t\tvaluePointer: value,\n\t\t},\n\t\tname,\n\t\t\"\",\n\t\tusage,\n\t)\n\tflag.NoOptDefVal = \"true\"\n}\n\n// Implements pflag.Value.\ntype boolPointerValue struct {\n\t// This must not be nil at construction time.\n\tvaluePointer **bool\n}\n\nfunc (b *boolPointerValue) Type() string {\n\t// From the CLI users' perspective, this is just a bool.\n\treturn \"bool\"\n}\n\nfunc (b *boolPointerValue) String() string {\n\tif *b.valuePointer == nil {\n\t\t// From the CLI users' perspective, this is just false.\n\t\treturn \"false\"\n\t}\n\treturn strconv.FormatBool(**b.valuePointer)\n}\n\nfunc (b *boolPointerValue) Set(value string) error {\n\tparsedValue, err := strconv.ParseBool(value)\n\tif err != nil {\n\t\treturn err\n\t}\n\t*b.valuePointer = &parsedValue\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/generate/generate_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage generate\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"io/fs\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appcmd/appcmdtesting\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xtesting\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/internaltesting\"\n\t\"github.com/bufbuild/buf/private/buf/buftesting\"\n\t\"github.com/bufbuild/buf/private/pkg/normalpath\"\n\t\"github.com/bufbuild/buf/private/pkg/storage\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storagearchive\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storagemem\"\n\t\"github.com/bufbuild/buf/private/pkg/storage/storageos\"\n\t\"github.com/spf13/pflag\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\n// TODO FUTURE: this has to change if we split up this repository\nvar buftestingDirPath = filepath.Join(\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"..\",\n\t\"private\",\n\t\"buf\",\n\t\"buftesting\",\n)\n\nfunc TestCompareGeneratedStubsGoogleapisGo(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubs(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]*testPluginInfo{\n\t\t\t{name: \"go\", opt: \"Mgoogle/api/auth.proto=foo\"},\n\t\t},\n\t)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisGoZip(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubsArchive(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]*testPluginInfo{\n\t\t\t{name: \"go\", opt: \"Mgoogle/api/auth.proto=foo\"},\n\t\t},\n\t\tfalse,\n\t)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisGoJar(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubsArchive(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]*testPluginInfo{\n\t\t\t{name: \"go\", opt: \"Mgoogle/api/auth.proto=foo\"},\n\t\t},\n\t\ttrue,\n\t)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisObjc(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubs(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]*testPluginInfo{{name: \"objc\"}},\n\t)\n}\n\nfunc TestCompareGeneratedStubsGoogleapisPyi(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tgoogleapisDirPath := buftesting.GetGoogleapisDirPath(t, buftestingDirPath)\n\ttestCompareGeneratedStubs(\n\t\tt,\n\t\tgoogleapisDirPath,\n\t\t[]*testPluginInfo{{name: \"pyi\"}},\n\t)\n}\n\nfunc TestCompareInsertionPointOutput(t *testing.T) {\n\txtesting.SkipIfShort(t)\n\tt.Parallel()\n\tinsertionTestdataDirPath := filepath.Join(\"testdata\", \"insertion\")\n\ttestCompareGeneratedStubs(\n\t\tt,\n\t\tinsertionTestdataDirPath,\n\t\t[]*testPluginInfo{\n\t\t\t{name: \"insertion-point-receiver\"},\n\t\t\t{name: \"insertion-point-writer\"},\n\t\t},\n\t)\n}\n\nfunc TestGenerateV2LocalPluginBasic(t *testing.T) {\n\tt.Parallel()\n\n\ttempDirPath := t.TempDir()\n\tinput := filepath.Join(\"testdata\", \"v2\", \"local_plugin\")\n\ttemplate := filepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.basic.gen.yaml\")\n\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\ttemplate,\n\t\tinput,\n\t)\n\n\texpected, err := storagemem.NewReadBucket(\n\t\tmap[string][]byte{\n\t\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Bar\n - a.v1.Foo\n`),\n\t\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Bar\n - b.v1.Foo\n`),\n\t\t},\n\t)\n\trequire.NoError(t, err)\n\tactual, err := storageos.NewProvider().NewReadWriteBucket(tempDirPath)\n\trequire.NoError(t, err)\n\n\tdiff, err := storage.DiffBytes(t.Context(), expected, actual)\n\trequire.NoError(t, err)\n\trequire.Empty(t, string(diff))\n}\n\nfunc TestGenerateV2LocalPluginTypes(t *testing.T) {\n\tt.Parallel()\n\ttestRunTypeArgs := func(t *testing.T, expect map[string][]byte, args ...string) {\n\t\tt.Helper()\n\t\ttempDirPath := t.TempDir()\n\t\ttestRunSuccess(\n\t\t\tt,\n\t\t\tappend([]string{\n\t\t\t\t\"--output\",\n\t\t\t\ttempDirPath,\n\t\t\t}, args...)...,\n\t\t)\n\t\texpected, err := storagemem.NewReadBucket(expect)\n\t\trequire.NoError(t, err)\n\t\trequire.NoError(t, err)\n\t\tactual, err := storageos.NewProvider().NewReadWriteBucket(tempDirPath)\n\t\trequire.NoError(t, err)\n\n\t\tdiff, err := storage.DiffBytes(t.Context(), expected, actual)\n\t\trequire.NoError(t, err)\n\t\trequire.Empty(t, string(diff))\n\t}\n\n\t// buf.basic.gen.yaml\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Bar\n - a.v1.Foo\n`),\n\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Bar\n - b.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.basic.gen.yaml\"),\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\"),\n\t)\n\t// buf.types.gen.yaml\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.types.gen.yaml\"),\n\t)\n\t// input specified\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Bar\n - a.v1.Foo\n`),\n\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Bar\n - b.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.types.gen.yaml\"),\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\"), // input\n\t)\n\t// --template as CLI flag\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\t`version: v2\nplugins:\n - local: protoc-gen-top-level-type-names-yaml\n out: gen\ninputs:\n - directory: ./testdata/v2/local_plugin\n types:\n - a.v1.Foo`,\n\t)\n\t// --type\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Bar\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.types.gen.yaml\"),\n\t\t\"--type\",\n\t\t\"b.v1.Bar\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\"),\n\t)\n\t// --path\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Bar\n - b.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.types.gen.yaml\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"b\"),\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\"),\n\t)\n\t// --exclude-path\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Bar\n - a.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.types.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"b\", \"v1\"),\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\"),\n\t)\n\t// buf.paths.gen.yaml\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Bar\n - a.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.paths.gen.yaml\"),\n\t)\n\t// buf.exclude.paths.gen.yaml\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Bar\n - b.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.exclude.paths.gen.yaml\"),\n\t)\n\t// --type overrides template\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Bar\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"local_plugin\", \"buf.types.gen.yaml\"),\n\t\t\"--type\",\n\t\t\"b.v1.Bar\",\n\t)\n\t// buf.gen.yaml has types and exclude_types on inputs and plugins\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Foo\n`),\n\t\tfilepath.Join(\"gen\", \"b\", \"v1\", \"b.top-level-type-names.yaml\"): []byte(`messages:\n - b.v1.Baz\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"types\", \"buf.gen.yaml\"),\n\t)\n\t// --exclude-type override\n\ttestRunTypeArgs(t, map[string][]byte{\n\t\tfilepath.Join(\"gen\", \"a\", \"v1\", \"a.top-level-type-names.yaml\"): []byte(`messages:\n - a.v1.Foo\n`),\n\t},\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"types\", \"buf.gen.yaml\"),\n\t\t\"--exclude-type\",\n\t\t\"b.v1.Baz\",\n\t)\n}\n\nfunc TestOutputFlag(t *testing.T) {\n\tt.Parallel()\n\tfor _, paths := range []struct {\n\t\ttemplate string\n\t\tdir string\n\t}{\n\t\t// v1 buf.gen.yaml, v1 module\n\t\t{filepath.Join(\"testdata\", \"simple\", \"buf.gen.yaml\"), filepath.Join(\"testdata\", \"simple\")},\n\t\t// v1 buf.gen.yaml, v2 module\n\t\t{filepath.Join(\"testdata\", \"simple\", \"buf.gen.yaml\"), filepath.Join(\"testdata\", \"v2\", \"simple\")},\n\t\t// v2 buf.gen.yaml, v1 module\n\t\t{filepath.Join(\"testdata\", \"v2\", \"simple\", \"buf.gen.yaml\"), filepath.Join(\"testdata\", \"simple\")},\n\t\t// v2 buf.gen.yaml, v2 module\n\t\t{filepath.Join(\"testdata\", \"v2\", \"simple\", \"buf.gen.yaml\"), filepath.Join(\"testdata\", \"v2\", \"simple\")},\n\t} {\n\t\ttempDirPath := t.TempDir()\n\t\ttestRunSuccess(\n\t\t\tt,\n\t\t\t\"--output\",\n\t\t\ttempDirPath,\n\t\t\t\"--template\",\n\t\t\tpaths.template,\n\t\t\tpaths.dir,\n\t\t)\n\t\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\t\trequire.NoError(t, err)\n\t}\n}\n\nfunc TestProtoFileRefIncludePackageFiles(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"buf.gen.yaml\"),\n\t\tfmt.Sprintf(\"%s#include_package_files=true\", filepath.Join(\"testdata\", \"protofileref\", \"a\", \"v1\", \"a.proto\")),\n\t)\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"B.java\"))\n\trequire.NoError(t, err)\n}\n\nfunc TestGenerateDuplicatePlugins(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"duplicate_plugins\", \"buf.gen.yaml\"),\n\t\tfilepath.Join(\"testdata\", \"duplicate_plugins\"),\n\t)\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"foo\", \"a\", \"v1\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"bar\", \"a\", \"v1\", \"A.java\"))\n\trequire.NoError(t, err)\n}\n\nfunc TestGenerateDuplicatePluginsV2(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"v2\", \"duplicate_plugins\", \"buf.gen.yaml\"),\n\t\tfilepath.Join(\"testdata\", \"v2\", \"duplicate_plugins\"),\n\t)\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"foo\", \"a\", \"v1\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"bar\", \"a\", \"v1\", \"A.java\"))\n\trequire.NoError(t, err)\n}\n\nfunc TestOutputWithPathEqualToExclude(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\tfilepath.FromSlash(`Failure: cannot set the same path for both --path and --exclude-path: \"testdata/paths/a/v1/a.proto\"`),\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\", \"a.proto\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\", \"a.proto\"),\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t)\n}\n\nfunc TestGenerateInsertionPoint(t *testing.T) {\n\tt.Parallel()\n\ttestGenerateInsertionPointV1(t, \".\", \".\", filepath.Join(\"testdata\", \"insertion_point\"))\n\ttestGenerateInsertionPointV1(t, \"gen/proto/insertion\", \"gen/proto/insertion\", filepath.Join(\"testdata\", \"nested_insertion_point\"))\n\ttestGenerateInsertionPointV1(t, \"gen/proto/insertion/\", \"./gen/proto/insertion\", filepath.Join(\"testdata\", \"nested_insertion_point\"))\n\ttestGenerateInsertionPointV2(t, \".\", \".\", filepath.Join(\"testdata\", \"insertion_point\"))\n\ttestGenerateInsertionPointV2(t, \"gen/proto/insertion\", \"gen/proto/insertion\", filepath.Join(\"testdata\", \"nested_insertion_point\"))\n\ttestGenerateInsertionPointV2(t, \"gen/proto/insertion/\", \"./gen/proto/insertion\", filepath.Join(\"testdata\", \"nested_insertion_point\"))\n}\n\nfunc TestGenerateInsertionPointFail(t *testing.T) {\n\tt.Parallel()\n\tsuccessTemplate := `\nversion: v1\nplugins:\n - name: insertion-point-receiver\n out: gen/proto/insertion\n - name: insertion-point-writer\n out: .\n`\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t`Failure: plugin insertion-point-writer: read test.txt: file does not exist`,\n\t\tfilepath.Join(\"testdata\", \"simple\"), // The input directory is irrelevant for these insertion points.\n\t\t\"--template\",\n\t\tsuccessTemplate,\n\t\t\"-o\",\n\t\tt.TempDir(),\n\t)\n}\n\nfunc TestGenerateInsertionPointFailV2(t *testing.T) {\n\tt.Parallel()\n\tsuccessTemplate := `\nversion: v2\nplugins:\n - protoc_builtin: insertion-point-receiver\n out: gen/proto/insertion\n - protoc_builtin: insertion-point-writer\n out: .\nmanaged:\n enabled: false\n`\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t`Failure: plugin insertion-point-writer: read test.txt: file does not exist`,\n\t\tfilepath.Join(\"testdata\", \"v2\", \"simple\"), // The input directory is irrelevant for these insertion points.\n\t\t\"--template\",\n\t\tsuccessTemplate,\n\t\t\"-o\",\n\t\tt.TempDir(),\n\t)\n}\n\nfunc TestGenerateDuplicateFileFail(t *testing.T) {\n\tt.Parallel()\n\tsuccessTemplate := `\nversion: v1\nplugins:\n - name: insertion-point-receiver\n out: .\n - name: insertion-point-receiver\n out: .\n`\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t`Failure: file \"test.txt\" was generated multiple times: once by plugin \"insertion-point-receiver\" and again by plugin \"insertion-point-receiver\"`,\n\t\tfilepath.Join(\"testdata\", \"simple\"), // The input directory is irrelevant for these insertion points.\n\t\t\"--template\",\n\t\tsuccessTemplate,\n\t\t\"-o\",\n\t\tt.TempDir(),\n\t)\n}\n\nfunc TestGenerateDuplicateFileFailV2(t *testing.T) {\n\tt.Parallel()\n\tsuccessTemplate := `\nversion: v2\nplugins:\n - protoc_builtin: insertion-point-receiver\n out: .\n - protoc_builtin: insertion-point-receiver\n out: .\nmanaged:\n enabled: false\n`\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t`Failure: file \"test.txt\" was generated multiple times: once by plugin \"insertion-point-receiver\" and again by plugin \"insertion-point-receiver\"`,\n\t\tfilepath.Join(\"testdata\", \"v2\", \"simple\"), // The input directory is irrelevant for these insertion points.\n\t\t\"--template\",\n\t\tsuccessTemplate,\n\t\t\"-o\",\n\t\tt.TempDir(),\n\t)\n}\n\nfunc TestGenerateInsertionPointMixedPathsFail(t *testing.T) {\n\tt.Parallel()\n\twd, err := os.Getwd()\n\trequire.NoError(t, err)\n\ttestGenerateInsertionPointMixedPathsFailV1(t, \".\", wd)\n\ttestGenerateInsertionPointMixedPathsFailV1(t, wd, \".\")\n\ttestGenerateInsertionPointMixedPathsFailV2(t, \".\", wd)\n\ttestGenerateInsertionPointMixedPathsFailV2(t, wd, \".\")\n}\n\nfunc TestGenerateDeleteOutDir(t *testing.T) {\n\tt.Parallel()\n\ttestGenerateDeleteOuts(t, \"\", \"foo\")\n\ttestGenerateDeleteOuts(t, \"base\", \"foo\")\n\ttestGenerateDeleteOuts(t, \"\", \"foo\", \"bar\")\n\ttestGenerateDeleteOuts(t, \"\", \"foo\", \"bar\", \"foo\")\n\ttestGenerateDeleteOuts(t, \"base\", \"foo\", \"bar\")\n\ttestGenerateDeleteOuts(t, \"base\", \"foo\", \"bar\", \"foo\")\n\ttestGenerateDeleteOuts(t, \"\", \"foo.jar\")\n\ttestGenerateDeleteOuts(t, \"\", \"foo.zip\")\n\ttestGenerateDeleteOuts(t, \"\", \"foo/bar.jar\")\n\ttestGenerateDeleteOuts(t, \"\", \"foo/bar.zip\")\n\ttestGenerateDeleteOuts(t, \"base\", \"foo.jar\")\n\ttestGenerateDeleteOuts(t, \"base\", \"foo.zip\")\n\ttestGenerateDeleteOuts(t, \"base\", \"foo/bar.jar\")\n\ttestGenerateDeleteOuts(t, \"base\", \"foo/bar.zip\")\n}\n\nfunc TestBoolPointerFlagTrue(t *testing.T) {\n\tt.Parallel()\n\texpected := true\n\ttestParseBoolPointer(t, \"test-name\", &expected, \"--test-name\")\n}\n\nfunc TestBoolPointerFlagTrueSpecified(t *testing.T) {\n\tt.Parallel()\n\texpected := true\n\ttestParseBoolPointer(t, \"test-name\", &expected, \"--test-name=true\")\n}\n\nfunc TestBoolPointerFlagFalseSpecified(t *testing.T) {\n\tt.Parallel()\n\texpected := false\n\ttestParseBoolPointer(t, \"test-name\", &expected, \"--test-name=false\")\n}\n\nfunc TestBoolPointerFlagUnspecified(t *testing.T) {\n\tt.Parallel()\n\ttestParseBoolPointer(t, \"test-name\", nil)\n}\n\nfunc testGenerateInsertionPointV1(\n\tt *testing.T,\n\treceiverOut string,\n\twriterOut string,\n\texpectedOutputPath string,\n) {\n\ttestGenerateInsertionPoint(\n\t\tt,\n\t\treceiverOut,\n\t\twriterOut,\n\t\texpectedOutputPath,\n\t\t`\nversion: v1\nplugins:\n - name: insertion-point-receiver\n out: %s\n - name: insertion-point-writer\n out: %s\n`,\n\t)\n}\n\nfunc testGenerateInsertionPointV2(\n\tt *testing.T,\n\treceiverOut string,\n\twriterOut string,\n\texpectedOutputPath string,\n) {\n\ttestGenerateInsertionPoint(\n\t\tt,\n\t\treceiverOut,\n\t\twriterOut,\n\t\texpectedOutputPath,\n\t\t`\nversion: v2\nplugins:\n - protoc_builtin: insertion-point-receiver\n out: %s\n - protoc_builtin: insertion-point-writer\n out: %s\n`,\n\t)\n}\n\nfunc testGenerateInsertionPoint(\n\tt *testing.T,\n\treceiverOut string,\n\twriterOut string,\n\texpectedOutputPath string,\n\tsuccessTemplate string,\n) {\n\tstorageosProvider := storageos.NewProvider()\n\ttempDir, readWriteBucket := internaltesting.CopyReadBucketToTempDir(\n\t\tt.Context(),\n\t\tt,\n\t\tstorageosProvider,\n\t\tstoragemem.NewReadWriteBucket(),\n\t)\n\ttestRunSuccess(\n\t\tt,\n\t\tfilepath.Join(\"testdata\", \"simple\"), // The input directory is irrelevant for these insertion points.\n\t\t\"--template\",\n\t\tfmt.Sprintf(successTemplate, receiverOut, writerOut),\n\t\t\"-o\",\n\t\ttempDir,\n\t)\n\texpectedOutput, err := storageosProvider.NewReadWriteBucket(expectedOutputPath)\n\trequire.NoError(t, err)\n\tdiff, err := storage.DiffBytes(t.Context(), expectedOutput, readWriteBucket)\n\trequire.NoError(t, err)\n\trequire.Empty(t, string(diff))\n}\n\nfunc testGenerateInsertionPointMixedPathsFailV1(\n\tt *testing.T,\n\treceiverOut string,\n\twriterOut string,\n) {\n\ttestGenerateInsertionPointMixedPathsFail(\n\t\tt,\n\t\treceiverOut,\n\t\twriterOut,\n\t\t`\nversion: v1\nplugins:\n - name: insertion-point-receiver\n out: %s\n - name: insertion-point-writer\n out: %s\n`,\n\t)\n}\n\nfunc testGenerateInsertionPointMixedPathsFailV2(\n\tt *testing.T,\n\treceiverOut string,\n\twriterOut string,\n) {\n\ttestGenerateInsertionPointMixedPathsFail(\n\t\tt,\n\t\treceiverOut,\n\t\twriterOut,\n\t\t`\nversion: v2\nplugins:\n - protoc_builtin: insertion-point-receiver\n out: %s\n - protoc_builtin: insertion-point-writer\n out: %s\n`,\n\t)\n}\n\n// testGenerateInsertionPointMixedPathsFail demonstrates that insertion points are only\n// able to generate to the same output directory, even if the absolute path points to the\n// same place. This is equivalent to protoc's behavior.\nfunc testGenerateInsertionPointMixedPathsFail(\n\tt *testing.T,\n\treceiverOut string,\n\twriterOut string,\n\tsuccessTemplate string,\n) {\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t`Failure: plugin insertion-point-writer: read test.txt: file does not exist`,\n\t\tfilepath.Join(\"testdata\", \"simple\"), // The input directory is irrelevant for these insertion points.\n\t\t\"--template\",\n\t\tfmt.Sprintf(successTemplate, receiverOut, writerOut),\n\t\t\"-o\",\n\t\tt.TempDir(),\n\t)\n}\n\nfunc testCompareGeneratedStubs(\n\tt *testing.T,\n\tdirPath string,\n\ttestPluginInfos []*testPluginInfo,\n) {\n\tfilePaths := buftesting.GetProtocFilePaths(t, dirPath, 100)\n\tactualProtocDir := t.TempDir()\n\tbufGenDir := t.TempDir()\n\tvar actualProtocPluginFlags []string\n\tfor _, testPluginInfo := range testPluginInfos {\n\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_out=%s\", testPluginInfo.name, actualProtocDir))\n\t\tif testPluginInfo.opt != \"\" {\n\t\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_opt=%s\", testPluginInfo.name, testPluginInfo.opt))\n\t\t}\n\t}\n\tbuftesting.RunActualProtoc(\n\t\tt,\n\t\tfalse,\n\t\tfalse,\n\t\tdirPath,\n\t\tfilePaths,\n\t\tmap[string]string{\n\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t},\n\t\tnil,\n\t\tactualProtocPluginFlags...,\n\t)\n\tgenFlags := []string{\n\t\tdirPath,\n\t\t\"--template\",\n\t\tnewExternalConfigV1String(t, testPluginInfos, bufGenDir),\n\t}\n\tfor _, filePath := range filePaths {\n\t\tgenFlags = append(\n\t\t\tgenFlags,\n\t\t\t\"--path\",\n\t\t\tfilePath,\n\t\t)\n\t}\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithArgs(genFlags...),\n\t)\n\tstorageosProvider := storageos.NewProvider(storageos.ProviderWithSymlinks())\n\tactualReadWriteBucket, err := storageosProvider.NewReadWriteBucket(\n\t\tactualProtocDir,\n\t\tstorageos.ReadWriteBucketWithSymlinksIfSupported(),\n\t)\n\trequire.NoError(t, err)\n\tbufReadWriteBucket, err := storageosProvider.NewReadWriteBucket(\n\t\tbufGenDir,\n\t\tstorageos.ReadWriteBucketWithSymlinksIfSupported(),\n\t)\n\trequire.NoError(t, err)\n\tdiff, err := storage.DiffBytes(\n\t\tt.Context(),\n\t\tactualReadWriteBucket,\n\t\tbufReadWriteBucket,\n\t\ttransformGolangProtocVersionToUnknown(t),\n\t)\n\trequire.NoError(t, err)\n\tassert.Empty(t, string(diff))\n}\n\nfunc testCompareGeneratedStubsArchive(\n\tt *testing.T,\n\tdirPath string,\n\ttestPluginInfos []*testPluginInfo,\n\tuseJar bool,\n) {\n\tfileExt := \".zip\"\n\tif useJar {\n\t\tfileExt = \".jar\"\n\t}\n\tfilePaths := buftesting.GetProtocFilePaths(t, dirPath, 100)\n\ttempDir := t.TempDir()\n\tactualProtocFile := filepath.Join(tempDir, \"actual-protoc\"+fileExt)\n\tbufGenFile := filepath.Join(tempDir, \"buf-generate\"+fileExt)\n\tvar actualProtocPluginFlags []string\n\tfor _, testPluginInfo := range testPluginInfos {\n\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_out=%s\", testPluginInfo.name, actualProtocFile))\n\t\tif testPluginInfo.opt != \"\" {\n\t\t\tactualProtocPluginFlags = append(actualProtocPluginFlags, fmt.Sprintf(\"--%s_opt=%s\", testPluginInfo.name, testPluginInfo.opt))\n\t\t}\n\t}\n\tbuftesting.RunActualProtoc(\n\t\tt,\n\t\tfalse,\n\t\tfalse,\n\t\tdirPath,\n\t\tfilePaths,\n\t\tmap[string]string{\n\t\t\t\"PATH\": os.Getenv(\"PATH\"),\n\t\t},\n\t\tnil,\n\t\tactualProtocPluginFlags...,\n\t)\n\tgenFlags := []string{\n\t\tdirPath,\n\t\t\"--template\",\n\t\tnewExternalConfigV1String(t, testPluginInfos, bufGenFile),\n\t}\n\tfor _, filePath := range filePaths {\n\t\tgenFlags = append(\n\t\t\tgenFlags,\n\t\t\t\"--path\",\n\t\t\tfilePath,\n\t\t)\n\t}\n\ttestRunSuccess(\n\t\tt,\n\t\tgenFlags...,\n\t)\n\tactualData, err := os.ReadFile(actualProtocFile)\n\trequire.NoError(t, err)\n\tactualReadWriteBucket := storagemem.NewReadWriteBucket()\n\terr = storagearchive.Unzip(\n\t\tt.Context(),\n\t\tbytes.NewReader(actualData),\n\t\tint64(len(actualData)),\n\t\tactualReadWriteBucket,\n\t)\n\trequire.NoError(t, err)\n\tbufData, err := os.ReadFile(bufGenFile)\n\trequire.NoError(t, err)\n\tbufReadWriteBucket := storagemem.NewReadWriteBucket()\n\terr = storagearchive.Unzip(\n\t\tt.Context(),\n\t\tbytes.NewReader(bufData),\n\t\tint64(len(bufData)),\n\t\tbufReadWriteBucket,\n\t)\n\trequire.NoError(t, err)\n\tdiff, err := storage.DiffBytes(\n\t\tt.Context(),\n\t\tactualReadWriteBucket,\n\t\tbufReadWriteBucket,\n\t\ttransformGolangProtocVersionToUnknown(t),\n\t)\n\trequire.NoError(t, err)\n\tassert.Empty(t, string(diff))\n}\n\nfunc testRunSuccess(t *testing.T, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(name),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n\nfunc testGenerateDeleteOuts(\n\tt *testing.T,\n\tbaseOutDirPath string,\n\toutputPaths ...string,\n) {\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, nil, true, true, outputPaths)\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, nil, false, false, outputPaths)\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, []string{\"--clean\"}, false, true, outputPaths)\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, []string{\"--clean\"}, true, true, outputPaths)\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, []string{\"--clean=true\"}, true, true, outputPaths)\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, []string{\"--clean=true\"}, false, true, outputPaths)\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, []string{\"--clean=false\"}, true, false, outputPaths)\n\ttestGenerateDeleteOutsWithArgAndConfig(t, baseOutDirPath, []string{\"--clean=false\"}, false, false, outputPaths)\n}\n\nfunc testGenerateDeleteOutsWithArgAndConfig(\n\tt *testing.T,\n\tbaseOutDirPath string,\n\tcleanArgs []string,\n\tcleanOptionInConfig bool,\n\texpectedClean bool,\n\toutputPaths []string,\n) {\n\t// Just add more builtins to the plugins slice below if this goes off\n\trequire.True(t, len(outputPaths) < 4, \"we want to have unique plugins to work with and this test is only set up for three plugins max right now\")\n\tfullOutputPaths := outputPaths\n\tif baseOutDirPath != \"\" && baseOutDirPath != \".\" {\n\t\tfullOutputPaths = xslices.Map(\n\t\t\toutputPaths,\n\t\t\tfunc(outputPath string) string {\n\t\t\t\treturn normalpath.Join(baseOutDirPath, outputPath)\n\t\t\t},\n\t\t)\n\t}\n\tctx := t.Context()\n\ttmpDirPath := t.TempDir()\n\tstorageBucket, err := storageos.NewProvider().NewReadWriteBucket(tmpDirPath)\n\trequire.NoError(t, err)\n\tfor _, fullOutputPath := range fullOutputPaths {\n\t\tswitch normalpath.Ext(fullOutputPath) {\n\t\tcase \".jar\", \".zip\":\n\t\t\t// Write a one-byte file to the location. We'll compare the size below as a simple test.\n\t\t\trequire.NoError(\n\t\t\t\tt,\n\t\t\t\tstorage.PutPath(\n\t\t\t\t\tctx,\n\t\t\t\t\tstorageBucket,\n\t\t\t\t\tfullOutputPath,\n\t\t\t\t\t[]byte(`1`),\n\t\t\t\t),\n\t\t\t)\n\t\tdefault:\n\t\t\t// Write a file that won't be generated to the location.\n\t\t\trequire.NoError(\n\t\t\t\tt,\n\t\t\t\tstorage.PutPath(\n\t\t\t\t\tctx,\n\t\t\t\t\tstorageBucket,\n\t\t\t\t\tnormalpath.Join(fullOutputPath, \"foo.txt\"),\n\t\t\t\t\t[]byte(`1`),\n\t\t\t\t),\n\t\t\t)\n\t\t}\n\t}\n\tvar templateBuilder strings.Builder\n\t_, _ = templateBuilder.WriteString(`version: v2\nplugins:\n`)\n\n\tplugins := []string{\"java\", \"cpp\", \"ruby\"}\n\tfor i, outputPath := range outputPaths {\n\t\t_, _ = templateBuilder.WriteString(` - protoc_builtin: `)\n\t\t_, _ = templateBuilder.WriteString(plugins[i])\n\t\t_, _ = templateBuilder.WriteString(\"\\n\")\n\t\t_, _ = templateBuilder.WriteString(` out: `)\n\t\t_, _ = templateBuilder.WriteString(outputPath)\n\t\t_, _ = templateBuilder.WriteString(\"\\n\")\n\t}\n\tif cleanOptionInConfig {\n\t\ttemplateBuilder.WriteString(\"clean: true\\n\")\n\t}\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t0,\n\t\t``,\n\t\t``,\n\t\tappend(\n\t\t\t[]string{\n\t\t\t\tfilepath.Join(\"testdata\", \"simple\"),\n\t\t\t\t\"--template\",\n\t\t\t\ttemplateBuilder.String(),\n\t\t\t\t\"-o\",\n\t\t\t\tfilepath.Join(tmpDirPath, normalpath.Unnormalize(baseOutDirPath)),\n\t\t\t},\n\t\t\tcleanArgs...,\n\t\t)...,\n\t)\n\tfor _, fullOutputPath := range fullOutputPaths {\n\t\tswitch normalpath.Ext(fullOutputPath) {\n\t\tcase \".jar\", \".zip\":\n\t\t\tdata, err := storage.ReadPath(\n\t\t\t\tctx,\n\t\t\t\tstorageBucket,\n\t\t\t\tfullOutputPath,\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\t\t\t// Always expect non-fake data, because the existing \".jar\" or \".zip\"\n\t\t\t// file is always replaced by the output. This is the existing and correct\n\t\t\t// behavior.\n\t\t\trequire.True(t, len(data) > 1, \"expected non-fake data at %q\", fullOutputPath)\n\t\tdefault:\n\t\t\tdata, err := storage.ReadPath(\n\t\t\t\tctx,\n\t\t\t\tstorageBucket,\n\t\t\t\tnormalpath.Join(fullOutputPath, \"foo.txt\"),\n\t\t\t)\n\t\t\tif expectedClean {\n\t\t\t\trequire.ErrorIs(t, err, fs.ErrNotExist)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err, \"expected foo.txt at %q\", fullOutputPath)\n\t\t\t\trequire.NotNil(t, data, \"expected foo.txt at %q\", fullOutputPath)\n\t\t\t}\n\t\t}\n\t}\n}\n\nfunc testRunStdoutStderr(t *testing.T, stdin io.Reader, expectedExitCode int, expectedStdout string, expectedStderr string, args ...string) {\n\tappcmdtesting.Run(\n\t\tt,\n\t\tfunc(name string) *appcmd.Command {\n\t\t\treturn NewCommand(\n\t\t\t\tname,\n\t\t\t\tappext.NewBuilder(\n\t\t\t\t\tname,\n\t\t\t\t\tappext.BuilderWithInterceptor(\n\t\t\t\t\t\t// TODO FUTURE: use the real interceptor. Currently in buf.go, NewBuilder receives appflag.BuilderWithInterceptor(newErrorInterceptor()).\n\t\t\t\t\t\t// However we cannot depend on newErrorInterceptor because it would create an import cycle, not to mention it needs to be exported first.\n\t\t\t\t\t\t// This can depend on newErrorInterceptor when it's moved to a separate package and made public.\n\t\t\t\t\t\tfunc(next func(context.Context, appext.Container) error) func(context.Context, appext.Container) error {\n\t\t\t\t\t\t\treturn func(ctx context.Context, container appext.Container) error {\n\t\t\t\t\t\t\t\terr := next(ctx, container)\n\t\t\t\t\t\t\t\tif err == nil {\n\t\t\t\t\t\t\t\t\treturn nil\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\treturn fmt.Errorf(\"Failure: %w\", err)\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t),\n\t\t\t\t),\n\t\t\t)\n\t\t},\n\t\tappcmdtesting.WithExpectedExitCode(expectedExitCode),\n\t\tappcmdtesting.WithExpectedStdout(expectedStdout),\n\t\tappcmdtesting.WithExpectedStderr(expectedStderr),\n\t\tappcmdtesting.WithEnv(internaltesting.NewEnvFunc(t)),\n\t\tappcmdtesting.WithStdin(stdin),\n\t\tappcmdtesting.WithArgs(args...),\n\t)\n}\n\nfunc testParseBoolPointer(t *testing.T, flagName string, expectedResult *bool, args ...string) {\n\tvar boolPointer *bool\n\tflagSet := pflag.NewFlagSet(\"test flag set\", pflag.ContinueOnError)\n\tbindBoolPointer(flagSet, flagName, &boolPointer, \"test usage\")\n\terr := flagSet.Parse(args)\n\trequire.NoError(t, err)\n\trequire.Equal(t, expectedResult, boolPointer)\n}\n\nfunc newExternalConfigV1String(t *testing.T, plugins []*testPluginInfo, out string) string {\n\texternalConfig := make(map[string]any)\n\texternalConfig[\"version\"] = \"v1\"\n\tpluginConfigs := []map[string]string{}\n\tfor _, plugin := range plugins {\n\t\tpluginConfigs = append(\n\t\t\tpluginConfigs,\n\t\t\tmap[string]string{\n\t\t\t\t\"name\": plugin.name,\n\t\t\t\t\"opt\": plugin.opt,\n\t\t\t\t\"out\": out,\n\t\t\t},\n\t\t)\n\t}\n\texternalConfig[\"plugins\"] = pluginConfigs\n\tdata, err := json.Marshal(externalConfig)\n\trequire.NoError(t, err)\n\treturn string(data)\n}\n\ntype testPluginInfo struct {\n\tname string\n\topt string\n}\n\nfunc transformGolangProtocVersionToUnknown(t *testing.T) storage.DiffOption {\n\treturn storage.DiffWithTransform(func(_, _ string, content []byte) []byte {\n\t\tlines := bytes.Split(content, []byte(\"\\n\"))\n\t\tfilteredLines := make([][]byte, 0, len(lines))\n\t\tcommentPrefix := []byte(\"//\")\n\t\tprotocVersionIndicator := []byte(\"protoc\")\n\t\tfor _, line := range lines {\n\t\t\tif !(bytes.HasPrefix(line, commentPrefix) && bytes.Contains(line, protocVersionIndicator)) {\n\t\t\t\tfilteredLines = append(filteredLines, line)\n\t\t\t}\n\t\t}\n\t\treturn bytes.Join(filteredLines, []byte(\"\\n\"))\n\t})\n}\n" }, { "path": "cmd/buf/internal/command/generate/generate_unix_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n//go:build aix || darwin || dragonfly || freebsd || (js && wasm) || linux || netbsd || openbsd || solaris\n\npackage generate\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestProtoFileRef(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"buf.gen.yaml\"),\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"a\", \"v1\", \"a.proto\"),\n\t)\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"B.java\"))\n\trequire.Contains(t, err.Error(), \"no such file or directory\")\n}\n\nfunc TestOutputWithExclude(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t)\n\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v2\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"b\", \"v1\", \"B.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"no such file or directory\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v3\", \"A.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"no such file or directory\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v3\", \"foo\", \"Foo.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"no such file or directory\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v3\", \"bar\", \"Bar.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"no such file or directory\")\n}\n\nfunc TestOutputWithPathWithinExclude(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\",\n\t\tfilepath.FromSlash(`Failure: excluded path \"testdata/paths/a\" contains targeted path \"testdata/paths/a/v1/a.proto\", which means all paths in \"testdata/paths/a/v1/a.proto\" will be excluded`),\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\", \"a.proto\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\"),\n\t)\n}\n\nfunc TestOutputWithExcludeWithinPath(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\", \"a.proto\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\"),\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t)\n\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v2\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"b\", \"v1\", \"B.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"no such file or directory\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"no such file or directory\")\n}\n\nfunc TestOutputWithNestedExcludeAndTargetPaths(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\",\n\t\tfilepath.FromSlash(`Failure: excluded path \"testdata/paths/a/v3\" contains targeted path \"testdata/paths/a/v3/foo\", which means all paths in \"testdata/paths/a/v3/foo\" will be excluded`),\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\", \"bar.proto\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t)\n}\n\nfunc TestWorkspaceGenerateWithExcludeAndTargetPaths(t *testing.T) {\n\tt.Parallel()\n\ttempDirPath := t.TempDir()\n\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t\"\",\n\t\tfilepath.FromSlash(`Failure: excluded path \"a/v3\" contains targeted path \"a/v3/foo\", which means all paths in \"a/v3/foo\" will be excluded`),\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"a\", \"v3\", \"foo\", \"bar.proto\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"a\", \"v3\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"a\", \"v3\", \"foo\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"b\", \"v1\", \"foo.proto\"),\n\t\tfilepath.Join(\"testdata\", \"workspace\"),\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/generate/generate_windows_test.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n//go:build windows\n\npackage generate\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestProtoFileRef(t *testing.T) {\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"buf.gen.yaml\"),\n\t\tfilepath.Join(\"testdata\", \"protofileref\", \"a\", \"v1\", \"a.proto\"),\n\t)\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"B.java\"))\n\trequire.Contains(t, err.Error(), \"The system cannot find the file specified.\")\n}\n\nfunc TestOutputWithExclude(t *testing.T) {\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t)\n\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v2\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"b\", \"v1\", \"B.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"The system cannot find the path specified.\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v3\", \"A.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"The system cannot find the path specified.\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v3\", \"foo\", \"Foo.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"The system cannot find the path specified.\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v3\", \"bar\", \"Bar.java\"))\n\trequire.Error(t, err)\n\trequire.Contains(t, err.Error(), \"The system cannot find the path specified.\")\n}\n\nfunc TestOutputWithPathWithinExclude(t *testing.T) {\n\ttempDirPath := t.TempDir()\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\t\t`Failure: excluded path \"testdata\\paths\\a\" contains targeted path \"testdata\\paths\\a\\v1\\a.proto\", which means all paths in \"testdata\\paths\\a\\v1\\a.proto\" will be excluded`,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\", \"a.proto\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\"),\n\t)\n}\n\nfunc TestOutputWithExcludeWithinPath(t *testing.T) {\n\ttempDirPath := t.TempDir()\n\ttestRunSuccess(\n\t\tt,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v1\", \"a.proto\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\"),\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t)\n\n\t_, err := os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v2\", \"A.java\"))\n\trequire.NoError(t, err)\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"b\", \"v1\", \"B.java\"))\n\trequire.Contains(t, err.Error(), \"The system cannot find the path specified.\")\n\t_, err = os.Stat(filepath.Join(tempDirPath, \"java\", \"a\", \"v1\", \"A.java\"))\n\trequire.Contains(t, err.Error(), \"The system cannot find the path specified.\")\n}\n\nfunc TestOutputWithNestedExcludeAndTargetPaths(t *testing.T) {\n\ttempDirPath := t.TempDir()\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\t\t`Failure: excluded path \"testdata\\paths\\a\\v3\" contains targeted path \"testdata\\paths\\a\\v3\\foo\", which means all paths in \"testdata\\paths\\a\\v3\\foo\" will be excluded`,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\", \"bar.proto\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"paths\", \"a\", \"v3\", \"foo\"),\n\t\tfilepath.Join(\"testdata\", \"paths\"),\n\t)\n}\n\nfunc TestWorkspaceGenerateWithExcludeAndTargetPaths(t *testing.T) {\n\ttempDirPath := t.TempDir()\n\ttestRunStdoutStderr(\n\t\tt,\n\t\tnil,\n\t\t1,\n\t\t``,\n\t\t// This is new post-refactor. Before, we gave precedence to --path. While a change,\n\t\t// doing --path foo/bar --exclude-path foo seems like a bug rather than expected behavior to maintain.\n\t\t`Failure: excluded path \"testdata\\workspace\\a\\v3\" contains targeted path \"testdata\\workspace\\a\\v3\\foo\", which means all paths in \"testdata\\workspace\\a\\v3\\foo\" will be excluded`,\n\t\t\"--output\",\n\t\ttempDirPath,\n\t\t\"--template\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"buf.gen.yaml\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"a\", \"v3\", \"foo\", \"bar.proto\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"a\", \"v3\"),\n\t\t\"--path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"a\", \"v3\", \"foo\"),\n\t\t\"--exclude-path\",\n\t\tfilepath.Join(\"testdata\", \"workspace\", \"b\", \"v1\", \"foo.proto\"),\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/generate/internal/protoc-gen-top-level-type-names-yaml/main.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage main\n\nimport (\n\t\"context\"\n\t\"path/filepath\"\n\t\"sort\"\n\t\"strings\"\n\n\t\"github.com/bufbuild/protoplugin\"\n\t\"gopkg.in/yaml.v3\"\n)\n\nconst fileExt = \".top-level-type-names.yaml\"\n\nfunc main() {\n\tprotoplugin.Main(protoplugin.HandlerFunc(handle))\n}\n\nfunc handle(\n\t_ context.Context,\n\t_ protoplugin.PluginEnv,\n\tresponseWriter protoplugin.ResponseWriter,\n\trequest protoplugin.Request,\n) error {\n\tfileDescriptors, err := request.FileDescriptorsToGenerate()\n\tif err != nil {\n\t\treturn err\n\t}\n\tfor _, fileDescriptor := range fileDescriptors {\n\t\texternalFile := &externalFile{}\n\t\tenumDescriptors := fileDescriptor.Enums()\n\t\tfor i := range enumDescriptors.Len() {\n\t\t\texternalFile.Enums = append(externalFile.Enums, string(enumDescriptors.Get(i).FullName()))\n\t\t}\n\t\tmessageDescriptors := fileDescriptor.Messages()\n\t\tfor i := range messageDescriptors.Len() {\n\t\t\texternalFile.Messages = append(externalFile.Messages, string(messageDescriptors.Get(i).FullName()))\n\t\t}\n\t\tserviceDescriptors := fileDescriptor.Services()\n\t\tfor i := range serviceDescriptors.Len() {\n\t\t\texternalFile.Services = append(externalFile.Services, string(serviceDescriptors.Get(i).FullName()))\n\t\t}\n\t\tsort.Strings(externalFile.Enums)\n\t\tsort.Strings(externalFile.Messages)\n\t\tsort.Strings(externalFile.Services)\n\t\tdata, err := yaml.Marshal(externalFile)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tresponseWriter.AddFile(\n\t\t\tstrings.TrimSuffix(fileDescriptor.Path(), filepath.Ext(filepath.FromSlash(fileDescriptor.Path())))+fileExt,\n\t\t\tstring(data),\n\t\t)\n\t}\n\treturn nil\n}\n\ntype externalFile struct {\n\tEnums []string `json:\"enums,omitempty\" yaml:\"enums,omitempty\"`\n\tMessages []string `json:\"messages,omitempty\" yaml:\"messages,omitempty\"`\n\tServices []string `json:\"services,omitempty\" yaml:\"services,omitempty\"`\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/duplicate_plugins/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/duplicate_plugins/buf.gen.yaml", "content": "# The same plugin can be executed more than once, as long as they are written\n# to different output directories.\nversion: v1\nplugins:\n - name: java\n out: foo\n - name: java\n out: bar\n" }, { "path": "cmd/buf/internal/command/generate/testdata/insertion/test.proto", "content": "syntax = \"proto3\";\n\npackage test;\n\nmessage Test {\n string name = 1;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/insertion_point/test.txt", "content": "\n\t\t// The following line represents an insertion point named 'example'.\n\t\t// We include a few indentation to verify the whitespace is preserved\n\t\t// in the inserted content.\n\t\t//\n\t\t\n\t\t\t\t\t// Include this comment on the 'example' insertion point.\n\t\t\t\t\t // This is another example where whitespaces are preserved.\n\t\t\t\t\t // And this demonstrates a newline literal (\\n).\n\t\t\t\t\t// And don't forget the windows newline literal (\\r\\n).\n\t\t\t\t\n\t\t// @@protoc_insertion_point(example)\n\t\t//\n\t\t// The 'other' insertion point is also included so that we verify\n\t\t// multiple insertion points can be written in a single invocation.\n\t\t//\n\t\t\n\t\t\t\t\t// Include this comment on the 'other' insertion point.\n\t\t\t\t\n\t\t// @@protoc_insertion_point(other)\n\t\t//\n\t\t// Note that all text should be added above the insertion points.\n\t\t" }, { "path": "cmd/buf/internal/command/generate/testdata/nested_insertion_point/gen/proto/insertion/test.txt", "content": "\n\t\t// The following line represents an insertion point named 'example'.\n\t\t// We include a few indentation to verify the whitespace is preserved\n\t\t// in the inserted content.\n\t\t//\n\t\t\n\t\t\t\t\t// Include this comment on the 'example' insertion point.\n\t\t\t\t\t // This is another example where whitespaces are preserved.\n\t\t\t\t\t // And this demonstrates a newline literal (\\n).\n\t\t\t\t\t// And don't forget the windows newline literal (\\r\\n).\n\t\t\t\t\n\t\t// @@protoc_insertion_point(example)\n\t\t//\n\t\t// The 'other' insertion point is also included so that we verify\n\t\t// multiple insertion points can be written in a single invocation.\n\t\t//\n\t\t\n\t\t\t\t\t// Include this comment on the 'other' insertion point.\n\t\t\t\t\n\t\t// @@protoc_insertion_point(other)\n\t\t//\n\t\t// Note that all text should be added above the insertion points.\n\t\t" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/a/v2/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v2;\n\nmessage Foo {\n string key = 1;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/a/v3/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v3;\n\nmessage Foo {\n string key = 1;\n string value = 2;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/a/v3/foo/bar.proto", "content": "syntax = \"proto3\";\n\npackage a.v3.foo;\n\nmessage Bar {\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/a/v3/foo/foo.proto", "content": "syntax = \"proto3\";\n\npackage a.v3.foo;\n\nmessage Foo {\n string id = 1;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/b/v1/b.proto", "content": "syntax = \"proto3\";\n\npackage b.v1;\n\nmessage Bar {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/buf.gen.yaml", "content": "version: v1\nplugins:\n - name: java\n out: java\n" }, { "path": "cmd/buf/internal/command/generate/testdata/paths/buf.yaml", "content": "version: v1\n" }, { "path": "cmd/buf/internal/command/generate/testdata/protofileref/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/protofileref/a/v1/b.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Bar {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/protofileref/buf.gen.yaml", "content": "version: v1\nplugins:\n - name: java\n out: java\n" }, { "path": "cmd/buf/internal/command/generate/testdata/protofileref/buf.yaml", "content": "version: v1\n" }, { "path": "cmd/buf/internal/command/generate/testdata/simple/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/simple/buf.gen.yaml", "content": "version: v1\nplugins:\n - name: java\n out: java\n\n" }, { "path": "cmd/buf/internal/command/generate/testdata/simple/buf.yaml", "content": "version: v1\n" }, { "path": "cmd/buf/internal/command/generate/testdata/types/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/types/buf.gen.yaml", "content": "version: v1\nplugins:\n - name: java\n out: java\ntypes:\n - \"a.v1.Foo\"\n" }, { "path": "cmd/buf/internal/command/generate/testdata/types/buf.yaml", "content": "version: v1\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/duplicate_plugins/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/duplicate_plugins/buf.gen.yaml", "content": "# The same plugin can be executed more than once, as long as they are written\n# to different output directories.\nversion: v2\nplugins:\n - protoc_builtin: java\n out: foo\n - protoc_builtin: java\n out: bar\nmanaged:\n enabled: false\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/local_plugin/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n\nmessage Bar {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/local_plugin/b/v1/b.proto", "content": "syntax = \"proto3\";\n\npackage b.v1;\n\nmessage Foo {}\n\nmessage Bar {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/local_plugin/buf.basic.gen.yaml", "content": "version: v2\nplugins:\n - local: protoc-gen-top-level-type-names-yaml\n out: gen\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/local_plugin/buf.exclude.paths.gen.yaml", "content": "version: v2\nplugins:\n - local: protoc-gen-top-level-type-names-yaml\n out: gen\n strategy: all\ninputs:\n - directory: testdata/v2/local_plugin\n exclude_paths:\n - testdata/v2/local_plugin/a\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/local_plugin/buf.paths.gen.yaml", "content": "version: v2\nplugins:\n - local: protoc-gen-top-level-type-names-yaml\n out: gen\n strategy: all\ninputs:\n - directory: testdata/v2/local_plugin\n paths:\n - testdata/v2/local_plugin/a\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/local_plugin/buf.types.gen.yaml", "content": "version: v2\nplugins:\n - local: protoc-gen-top-level-type-names-yaml\n out: gen\n strategy: all\ninputs:\n - directory: ./testdata/v2/local_plugin\n types:\n - a.v1.Foo\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/local_plugin/buf.yaml", "content": "version: v2\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/simple/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/simple/buf.gen.yaml", "content": "version: v2\nplugins:\n - protoc_builtin: java\n out: java\nmanaged:\n enabled: false\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/simple/buf.yaml", "content": "version: v2\nmodules:\n - path: .\n lint:\n except:\n - PACKAGE_NO_IMPORT_CYCLE\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/types/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nimport \"b/v1/b.proto\";\nimport \"pkg/v1/options.proto\";\n\nmessage Foo {\n option (pkg.v1.message_foo).foo = \"str\";\n message Bar {\n option (pkg.v1.message_bar).bar = \"str\";\n string bar = 1;\n }\n Bar nested_bar = 1;\n b.v1.Baz baz = 2;\n}\n\nmessage Empty {}\n\nmessage FooBar {\n Foo foo = 1;\n Foo.Bar bar = 2;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/types/b/v1/b.proto", "content": "syntax = \"proto3\";\n\npackage b.v1;\n\nimport \"pkg/v1/options.proto\";\n\nmessage Baz {\n option (pkg.v1.message_baz) = \"str\";\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/types/buf.gen.invalid.yaml", "content": "version: v2\nplugins:\n - local: protoc-gen-top-level-type-names-yaml\n out: gen\n strategy: all\ninputs:\n - directory: ./testdata/v2/types\n types:\n - \"a.v1.Foo.Bar\"\n exclude_types:\n - \"a.v1.Foo\"\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/types/buf.gen.yaml", "content": "version: v2\nmanaged:\n enabled: true\n override:\n - file_option: java_package_prefix\n value: net\nplugins:\n - local: protoc-gen-top-level-type-names-yaml\n out: gen\n strategy: all\n types:\n - \"a.v1.Foo\"\n exclude_types:\n - \"a.v1.Foo.Bar\"\n - \"pkg.v1.message_foo\"\n - \"pkg.v1.message_bar\"\ninputs:\n - directory: ./testdata/v2/types\n types:\n - \"a.v1.FooBar\"\n exclude_types:\n - \"a.v1.Empty\"\n - \"pkg.v1.message_baz\"\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/types/buf.yaml", "content": "version: v2\n" }, { "path": "cmd/buf/internal/command/generate/testdata/v2/types/pkg/v1/options.proto", "content": "syntax = \"proto3\";\n\npackage pkg.v1;\n\nimport \"google/protobuf/descriptor.proto\";\n\nmessage OptionFoo {\n string foo = 1;\n}\n\nmessage OptionBar {\n string bar = 1;\n}\n\nextend google.protobuf.MessageOptions {\n optional OptionFoo message_foo = 50000;\n optional OptionBar message_bar = 50001;\n optional string message_baz = 50002;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/a/v1/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v1;\n\nmessage Foo {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/a/v2/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v2;\n\nmessage Foo {\n string key = 1;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/a/v3/a.proto", "content": "syntax = \"proto3\";\n\npackage a.v3;\n\nmessage Foo {\n string key = 1;\n string value = 2;\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/a/v3/foo/bar.proto", "content": "syntax = \"proto3\";\n\npackage a.v3.foo;\n\nmessage Bar {\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/a/v3/foo/foo.proto", "content": "syntax = \"proto3\";\n\npackage a.v3.foo;\n\nmessage Foo {\n}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/b/v1/b.proto", "content": "syntax = \"proto3\";\n\npackage b.v1;\n\nmessage Bar {}\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/b/v1/foo.proto", "content": "syntax = \"proto3\";\n\npackage b.foo;\n\nmessage Foo {\n}\n\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/buf.gen.yaml", "content": "version: v1\nplugins:\n - name: java\n out: java\n" }, { "path": "cmd/buf/internal/command/generate/testdata/workspace/buf.work.yaml", "content": "version: v1\ndirectories:\n - a\n - b\n" }, { "path": "cmd/buf/internal/command/lint/lint.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage lint\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\terrorFormatFlagName = \"error-format\"\n\tconfigFlagName = \"config\"\n\tpathsFlagName = \"path\"\n\texcludePathsFlagName = \"exclude-path\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Run linting on Protobuf files\",\n\t\tLong: bufcli.GetInputLong(`the source, module, or Image to lint`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tErrorFormat string\n\tConfig string\n\tPaths []string\n\tExcludePaths []string\n\tDisableSymlinks bool\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)\n\tbufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors or check violations printed to stdout. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufcli.AllLintFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration`,\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tif err := bufcli.ValidateErrorFormatFlagLint(flags.ErrorFormat, errorFormatFlagName); err != nil {\n\t\treturn err\n\t}\n\t// Parse out if this is config-ignore-yaml.\n\t// This is messed.\n\tcontrollerErrorFormat := flags.ErrorFormat\n\tif controllerErrorFormat == \"config-ignore-yaml\" {\n\t\tcontrollerErrorFormat = \"text\"\n\t}\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t\tbufctl.WithFileAnnotationErrorFormat(controllerErrorFormat),\n\t\tbufctl.WithFileAnnotationsToStdout(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\twasmRuntime, err := bufcli.NewWasmRuntime(ctx, container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer func() {\n\t\tretErr = errors.Join(retErr, wasmRuntime.Close(ctx))\n\t}()\n\timageWithConfigs, checkClient, err := controller.GetTargetImageWithConfigsAndCheckClient(\n\t\tctx,\n\t\tinput,\n\t\twasmRuntime,\n\t\tbufctl.WithTargetPaths(flags.Paths, flags.ExcludePaths),\n\t\tbufctl.WithConfigOverride(flags.Config),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar allFileAnnotations []bufanalysis.FileAnnotation\n\t// We add all check configs (both lint and breaking) as related configs to check if plugins\n\t// have rules configured.\n\t// We allocated twice the size of imageWithConfigs for both lint and breaking configs.\n\tallCheckConfigs := make([]bufconfig.CheckConfig, 0, len(imageWithConfigs)*2)\n\tfor _, imageWithConfig := range imageWithConfigs {\n\t\tallCheckConfigs = append(allCheckConfigs, imageWithConfig.LintConfig())\n\t\tallCheckConfigs = append(allCheckConfigs, imageWithConfig.BreakingConfig())\n\t}\n\tfor _, imageWithConfig := range imageWithConfigs {\n\t\tlintOptions := []bufcheck.LintOption{\n\t\t\tbufcheck.WithPluginConfigs(imageWithConfig.PluginConfigs()...),\n\t\t\tbufcheck.WithPolicyConfigs(imageWithConfig.PolicyConfigs()...),\n\t\t\tbufcheck.WithRelatedCheckConfigs(allCheckConfigs...),\n\t\t}\n\t\tif err := checkClient.Lint(\n\t\t\tctx,\n\t\t\timageWithConfig.LintConfig(),\n\t\t\timageWithConfig,\n\t\t\tlintOptions...,\n\t\t); err != nil {\n\t\t\tvar fileAnnotationSet bufanalysis.FileAnnotationSet\n\t\t\tif errors.As(err, &fileAnnotationSet) {\n\t\t\t\tallFileAnnotations = append(allFileAnnotations, fileAnnotationSet.FileAnnotations()...)\n\t\t\t} else {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t}\n\tif len(allFileAnnotations) > 0 {\n\t\tallFileAnnotationSet := bufanalysis.NewFileAnnotationSet(allFileAnnotations...)\n\t\tif flags.ErrorFormat == \"config-ignore-yaml\" {\n\t\t\tif err := bufcli.PrintFileAnnotationSetLintConfigIgnoreYAMLV1(\n\t\t\t\tcontainer.Stdout(),\n\t\t\t\tallFileAnnotationSet,\n\t\t\t); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t} else {\n\t\t\tif err := bufanalysis.PrintFileAnnotationSet(\n\t\t\t\tcontainer.Stdout(),\n\t\t\t\tallFileAnnotationSet,\n\t\t\t\tflags.ErrorFormat,\n\t\t\t); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\treturn bufctl.ErrFileAnnotation\n\t}\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/lsfiles/lsfiles.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage lsfiles\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"sort\"\n\t\"strings\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufimage\"\n\t\"github.com/bufbuild/buf/private/gen/data/datawkt\"\n\t\"github.com/bufbuild/buf/private/pkg/uuidutil\"\n\t\"github.com/google/uuid\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tformatFlagName = \"format\"\n\tconfigFlagName = \"config\"\n\terrorFormatFlagName = \"error-format\"\n\tincludeImportsFlagName = \"include-imports\"\n\tincludeImportableFlagName = \"include-importable\"\n\tpathsFlagName = \"path\"\n\texcludePathsFlagName = \"exclude-path\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\tasImportPathsFlagName = \"as-import-paths\"\n\n\tformatText = \"text\"\n\tformatJSON = \"json\"\n\tformatImport = \"import\"\n)\n\nvar (\n\tallFormats = []string{formatText, formatJSON, formatImport}\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"List Protobuf files\",\n\t\tLong: bufcli.GetInputLong(`the source, module, or image to list from`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tFormat string\n\tConfig string\n\tIncludeImports bool\n\tIncludeImportable bool\n\tPaths []string\n\tExcludePaths []string\n\tDisableSymlinks bool\n\t// Deprecated. This flag no longer has any effect as we don't build images anymore.\n\tErrorFormat string\n\t// Deprecated\n\tAsImportPaths bool\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindPaths(flagSet, &f.Paths, pathsFlagName)\n\tbufcli.BindExcludePaths(flagSet, &f.ExcludePaths, excludePathsFlagName)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\t`The buf.yaml file or data to use for configuration`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\tformatText,\n\t\tfmt.Sprintf(\n\t\t\t`The format to print the .proto files. Must be one of %s`,\n\t\t\txstrings.SliceToString(allFormats),\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.IncludeImports,\n\t\tincludeImportsFlagName,\n\t\tfalse,\n\t\t\"Include imports\",\n\t)\n\tflagSet.BoolVar(\n\t\t&f.IncludeImportable,\n\t\tincludeImportableFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t\"Include all .proto files that are importable by the input. --%s is redundant if this is set\",\n\t\t\tincludeImportsFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors printed to stderr. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\t_ = flagSet.MarkDeprecated(errorFormatFlagName, \"this flag no longer has any effect\")\n\t_ = flagSet.MarkHidden(errorFormatFlagName)\n\tflagSet.BoolVar(\n\t\t&f.AsImportPaths,\n\t\tasImportPathsFlagName,\n\t\tfalse,\n\t\t\"Strip local directory paths and print filepaths as they are imported\",\n\t)\n\t_ = flagSet.MarkDeprecated(asImportPathsFlagName, fmt.Sprintf(\"use --%s=import instead\", formatFlagName))\n\t_ = flagSet.MarkHidden(asImportPathsFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) error {\n\tif flags.AsImportPaths {\n\t\tflags.Format = formatImport\n\t}\n\tinput, err := bufcli.GetInputValue(container, flags.InputHashtag, \".\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tcontroller, err := bufcli.NewController(\n\t\tcontainer,\n\t\tbufctl.WithDisableSymlinks(flags.DisableSymlinks),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\t// Sorted by Path.\n\timageFileInfos, err := controller.GetImportableImageFileInfos(\n\t\tctx,\n\t\tinput,\n\t\tbufctl.WithTargetPaths(flags.Paths, flags.ExcludePaths),\n\t\tbufctl.WithConfigOverride(flags.Config),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif !flags.IncludeImportable {\n\t\tif !flags.IncludeImports {\n\t\t\timageFileInfos = xslices.Filter(\n\t\t\t\timageFileInfos,\n\t\t\t\tfunc(imageFileInfo bufimage.ImageFileInfo) bool {\n\t\t\t\t\treturn !imageFileInfo.IsImport()\n\t\t\t\t},\n\t\t\t)\n\t\t} else {\n\t\t\t// Also automatically adds imported WKTs if not present.\n\t\t\timageFileInfos, err = bufimage.ImageFileInfosWithOnlyTargetsAndTargetImports(\n\t\t\t\tctx,\n\t\t\t\tdatawkt.ReadBucket,\n\t\t\t\timageFileInfos,\n\t\t\t)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t}\n\tvar formatFunc func(bufimage.ImageFileInfo) (string, error)\n\tswitch flags.Format {\n\tcase formatText:\n\t\tsort.Slice(\n\t\t\timageFileInfos,\n\t\t\tfunc(i int, j int) bool {\n\t\t\t\treturn imageFileInfos[i].ExternalPath() < imageFileInfos[j].ExternalPath()\n\t\t\t},\n\t\t)\n\t\tformatFunc = func(imageFileInfo bufimage.ImageFileInfo) (string, error) {\n\t\t\treturn imageFileInfo.ExternalPath(), nil\n\t\t}\n\tcase formatJSON:\n\t\tsort.Slice(\n\t\t\timageFileInfos,\n\t\t\tfunc(i int, j int) bool {\n\t\t\t\tif imageFileInfos[i].LocalPath() < imageFileInfos[j].LocalPath() {\n\t\t\t\t\treturn true\n\t\t\t\t}\n\t\t\t\tif imageFileInfos[i].LocalPath() > imageFileInfos[j].LocalPath() {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\treturn imageFileInfos[i].Path() < imageFileInfos[j].Path()\n\t\t\t},\n\t\t)\n\t\tformatFunc = func(imageFileInfo bufimage.ImageFileInfo) (string, error) {\n\t\t\tdata, err := json.Marshal(newExternalImageFileInfo(imageFileInfo))\n\t\t\tif err != nil {\n\t\t\t\treturn \"\", err\n\t\t\t}\n\t\t\treturn string(data), nil\n\t\t}\n\tcase formatImport:\n\t\tformatFunc = func(imageFileInfo bufimage.ImageFileInfo) (string, error) {\n\t\t\treturn imageFileInfo.Path(), nil\n\t\t}\n\tdefault:\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be one of %s\", formatFlagName, strings.Join(allFormats, \", \"))\n\t}\n\tlines, err := xslices.MapError(imageFileInfos, formatFunc)\n\tif err != nil {\n\t\treturn err\n\t}\n\tfor _, line := range lines {\n\t\tif _, err := fmt.Fprintln(container.Stdout(), line); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\ntype externalImageFileInfo struct {\n\tPath string `json:\"path\" yaml:\"path\"`\n\tImportPath string `json:\"import_path\" yaml:\"import_path\"`\n\tModule string `json:\"module\" yaml:\"module\"`\n\t// Dashless\n\tCommit string `json:\"commit\" yaml:\"commit\"`\n\tIsImport bool `json:\"is_import\" yaml:\"is_import\"`\n}\n\nfunc newExternalImageFileInfo(imageFileInfo bufimage.ImageFileInfo) *externalImageFileInfo {\n\tvar module string\n\tif moduleFullName := imageFileInfo.FullName(); moduleFullName != nil {\n\t\tmodule = moduleFullName.String()\n\t}\n\tvar commit string\n\tif commitID := imageFileInfo.CommitID(); commitID != uuid.Nil {\n\t\tcommit = uuidutil.ToDashless(commitID)\n\t}\n\treturn &externalImageFileInfo{\n\t\tPath: imageFileInfo.LocalPath(),\n\t\t// This seems backwards when you read it, but it is right: the Path is the import path,\n\t\t// the LocalPath is the path that a user would have for a file on disk.\n\t\tImportPath: imageFileInfo.Path(),\n\t\tModule: module,\n\t\tCommit: commit,\n\t\tIsImport: imageFileInfo.IsImport(),\n\t}\n}\n" }, { "path": "cmd/buf/internal/command/lsp/lspserve/lspserve.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// Package lspserve defines the entry-point for the Buf LSP within the CLI.\n//\n// The actual implementation of the LSP lives under private/buf/buflsp\npackage lspserve\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xio\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/buflsp\"\n\t\"github.com/bufbuild/protocompile/experimental/incremental\"\n\t\"github.com/spf13/pflag\"\n\t\"go.lsp.dev/jsonrpc2\"\n)\n\nconst (\n\t// pipe is chosen because that's what the vscode LSP client expects.\n\tpipeFlagName = \"pipe\"\n)\n\n// NewCommand constructs the CLI command for executing the LSP.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.Builder,\n\tdeprecated string,\n\thidden bool,\n\tbeta bool,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: \"Start the language server\",\n\t\tArgs: appcmd.NoArgs,\n\t\tDeprecated: deprecated,\n\t\tHidden: hidden,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\tif beta {\n\t\t\t\t\tbufcli.WarnBetaCommand(ctx, container)\n\t\t\t\t}\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\t// A file path to a UNIX socket to use for IPC. If empty, stdio is used instead.\n\tPipePath string\n}\n\n// Bind sets up the CLI flags that the LSP needs.\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringVar(\n\t\t&f.PipePath,\n\t\tpipeFlagName,\n\t\t\"\",\n\t\t\"path to a UNIX socket to listen on; uses stdio if not specified\",\n\t)\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\n// run starts the LSP server and listens on the configured.\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\ttransport, err := dial(container, flags)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\twktStore, err := bufcli.NewWKTStore(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\twktBucket, err := wktStore.GetBucket(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\twasmRuntime, err := bufcli.NewWasmRuntime(ctx, container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer func() {\n\t\tretErr = errors.Join(retErr, wasmRuntime.Close(ctx))\n\t}()\n\n\tconn, err := buflsp.Serve(\n\t\tctx,\n\t\tbufcli.Version,\n\t\twktBucket,\n\t\tcontainer,\n\t\tcontroller,\n\t\twasmRuntime,\n\t\tjsonrpc2.NewStream(transport),\n\t\tincremental.New(),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\t<-conn.Done()\n\treturn conn.Err()\n}\n\n// dial opens a connection to the LSP client.\nfunc dial(container appext.Container, flags *flags) (io.ReadWriteCloser, error) {\n\tswitch {\n\tcase flags.PipePath != \"\":\n\t\tconn, err := net.Dial(\"unix\", flags.PipePath)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"could not open IPC socket %q: %w\", flags.PipePath, err)\n\t\t}\n\t\treturn conn, nil\n\n\t// TODO: Add other transport implementations, such as TCP, here!\n\n\tdefault:\n\t\t// Fall back to stdio by default.\n\t\treturn xio.CompositeReadWriteCloser(\n\t\t\tcontainer.Stdin(),\n\t\t\tcontainer.Stdout(),\n\t\t\txio.NopCloser,\n\t\t), nil\n\t}\n}\n" }, { "path": "cmd/buf/internal/command/mod/internal/internal.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage internal\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io/fs\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufcheck\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tallFlagName = \"all\"\n\tconfigFlagName = \"config\"\n\tincludeDeprecatedFlagName = \"include-deprecated\"\n\tformatFlagName = \"format\"\n\tversionFlagName = \"version\"\n)\n\n// NewLSCommand returns a new ls Command.\nfunc NewLSCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n\truleType check.RuleType,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name,\n\t\tShort: fmt.Sprintf(\"List %s rules\", ruleType.String()),\n\t\tArgs: appcmd.NoArgs,\n\t\tDeprecated: fmt.Sprintf(`use \"buf config %s\" instead. However, \"buf mod %s\" will continue to work.`, name, name),\n\t\tHidden: true,\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn lsRun(\n\t\t\t\t\tctx,\n\t\t\t\t\tcontainer,\n\t\t\t\t\tflags,\n\t\t\t\t\tname,\n\t\t\t\t\truleType,\n\t\t\t\t)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tAll bool\n\tConfig string\n\tIncludeDeprecated bool\n\tFormat string\n\tVersion string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.BoolVar(\n\t\t&f.All,\n\t\tallFlagName,\n\t\tfalse,\n\t\t\"List all rules and not just those currently configured\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.Config,\n\t\tconfigFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(\n\t\t\t`The buf.yaml file or data to use for configuration. Ignored if --%s or --%s is specified`,\n\t\t\tallFlagName,\n\t\t\tversionFlagName,\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.IncludeDeprecated,\n\t\tincludeDeprecatedFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t`Also print deprecated rules. Has no effect if --%s is not set.`,\n\t\t\tallFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Format,\n\t\tformatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format to print rules as. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufcli.AllRuleFormatStrings),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.Version,\n\t\tversionFlagName,\n\t\t\"\", // do not set a default as we need to know if this is unset\n\t\tfmt.Sprintf(\n\t\t\t\"List all the rules for the given configuration version. Implies --%s. Must be one of %s\",\n\t\t\tallFlagName,\n\t\t\txslices.Map(\n\t\t\t\tbufconfig.AllFileVersions,\n\t\t\t\tfunc(fileVersion bufconfig.FileVersion) string {\n\t\t\t\t\treturn fileVersion.String()\n\t\t\t\t},\n\t\t\t),\n\t\t),\n\t)\n}\n\nfunc lsRun(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n\tcommandName string,\n\truleType check.RuleType,\n) error {\n\tif flags.All {\n\t\t// We explicitly document that if all is set, config is ignored.\n\t\t// If a user wants to override the version while using all, they should use version.\n\t\tflags.Config = \"\"\n\t}\n\tif flags.Version != \"\" {\n\t\t// If version is set, all is implied, and we use the config override to specify the version.\n\t\tflags.All = true\n\t\t// This also results in config being ignored per the documentation.\n\t\tflags.Config = fmt.Sprintf(`{\"version\":\"%s\"}`, flags.Version)\n\t}\n\tbufYAMLFile, err := bufcli.GetBufYAMLFileForDirPathOrOverride(ctx, \".\", flags.Config)\n\tif err != nil {\n\t\tif !errors.Is(err, fs.ErrNotExist) {\n\t\t\treturn err\n\t\t}\n\t\tbufYAMLFile, err = bufconfig.NewBufYAMLFile(\n\t\t\tbufconfig.FileVersionV1,\n\t\t\t[]bufconfig.ModuleConfig{\n\t\t\t\tbufconfig.DefaultModuleConfigV1,\n\t\t\t},\n\t\t\tnil,\n\t\t\tnil,\n\t\t\tnil,\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tfileVersion := bufYAMLFile.FileVersion()\n\tif fileVersion == bufconfig.FileVersionV2 {\n\t\treturn fmt.Errorf(`\"buf mod %s\" does not work for v2 buf.yaml files, use \"buf config %s\" instead`, commandName, commandName)\n\t}\n\t// BufYAMLFiles <=v1 never had plugins.\n\tclient, err := bufcheck.NewClient(\n\t\tcontainer.Logger(),\n\t\tbufcheck.ClientWithStderr(container.Stderr()),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar rules []bufcheck.Rule\n\tif flags.All {\n\t\trules, err = client.AllRules(ctx, ruleType, bufYAMLFile.FileVersion())\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t} else {\n\t\tmoduleConfigs := bufYAMLFile.ModuleConfigs()\n\t\tif len(moduleConfigs) != 1 {\n\t\t\treturn syserror.Newf(\"got %d ModuleConfigs for a v1beta1/v1 buf.yaml\", len(moduleConfigs))\n\t\t}\n\t\tvar checkConfig bufconfig.CheckConfig\n\t\tswitch ruleType {\n\t\tcase check.RuleTypeLint:\n\t\t\tcheckConfig = moduleConfigs[0].LintConfig()\n\t\tcase check.RuleTypeBreaking:\n\t\t\tcheckConfig = moduleConfigs[0].BreakingConfig()\n\t\tdefault:\n\t\t\treturn fmt.Errorf(\"unknown check.RuleType: %v\", ruleType)\n\t\t}\n\t\trules, err = client.ConfiguredRules(ctx, ruleType, checkConfig)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn bufcli.PrintRules(\n\t\tcontainer.Stdout(),\n\t\trules,\n\t\tflags.Format,\n\t\tflags.IncludeDeprecated,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/mod/modlsbreakingrules/modlsbreakingrules.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage modlsbreakingrules\n\nimport (\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/mod/internal\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\treturn internal.NewLSCommand(\n\t\tname,\n\t\tbuilder,\n\t\tcheck.RuleTypeBreaking,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/mod/modlslintrules/modlslintrules.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage modlslintrules\n\nimport (\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/bufplugin/check\"\n\t\"github.com/bufbuild/buf/cmd/buf/internal/command/mod/internal\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\treturn internal.NewLSCommand(\n\t\tname,\n\t\tbuilder,\n\t\tcheck.RuleTypeLint,\n\t)\n}\n" }, { "path": "cmd/buf/internal/command/mod/modopen/modopen.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage modopen\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io/fs\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufconfig\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/cli/browser\"\n)\n\nconst deprecationMessage = \"this command is not supported for v2 buf.yaml files as v2 buf.yaml files contain multiple modules. However, this command will continue to work for v1 buf.yaml files.\"\n\n// NewCommand returns a new open Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Open the module's homepage in a web browser\",\n\t\tLong: `The first argument is the directory with the buf.yaml of the module to open.\n\nThe directory must have a buf.yaml that contains a single specified module name.\n\nThe directory defaults to \".\" if no argument is specified.`,\n\t\tDeprecated: deprecationMessage,\n\t\tHidden: true,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container)\n\t\t\t},\n\t\t),\n\t}\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n) error {\n\tdirPath := \".\"\n\tif container.NumArgs() > 0 {\n\t\tdirPath = container.Arg(0)\n\t}\n\tbufYAMLFile, err := bufcli.GetBufYAMLFileForDirPath(ctx, dirPath)\n\tif err != nil {\n\t\tif errors.Is(err, fs.ErrNotExist) {\n\t\t\treturn fmt.Errorf(\"no buf.yaml discovered in directory %s\", dirPath)\n\t\t}\n\t\treturn err\n\t}\n\tswitch fileVersion := bufYAMLFile.FileVersion(); fileVersion {\n\tcase bufconfig.FileVersionV1Beta1, bufconfig.FileVersionV1:\n\t\tmoduleConfigs := bufYAMLFile.ModuleConfigs()\n\t\tif len(moduleConfigs) != 1 {\n\t\t\treturn syserror.Newf(\"got %d ModuleConfigs for a v1beta1/v1 buf.yaml\", len(moduleConfigs))\n\t\t}\n\t\tmoduleFullName := moduleConfigs[0].FullName()\n\t\tif moduleFullName == nil {\n\t\t\treturn fmt.Errorf(\"%s/buf.yaml has no module name\", dirPath)\n\t\t}\n\t\treturn browser.OpenURL(\"https://\" + moduleFullName.String())\n\tcase bufconfig.FileVersionV2:\n\t\treturn errors.New(deprecationMessage)\n\tdefault:\n\t\treturn syserror.Newf(\"unknown FileVersion: %v\", fileVersion)\n\t}\n}\n" }, { "path": "cmd/buf/internal/command/plugin/pluginprune/pluginprune.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage pluginprune\n\nimport (\n\t\"context\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufworkspace\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufplugin\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Prune unused plugins from buf.lock\",\n\t\tLong: `Plugins that are no longer configured in buf.yaml are removed from the buf.lock file.\n\nThe first argument is the directory of your buf.yaml configuration file.\nDefaults to \".\" if no argument is specified.`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container)\n\t\t\t},\n\t\t),\n\t}\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n) error {\n\tdirPath := \".\"\n\tif container.NumArgs() > 0 {\n\t\tdirPath = container.Arg(0)\n\t}\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspaceDepManager, err := controller.GetWorkspaceDepManager(ctx, dirPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredRemotePluginRefs, err := workspaceDepManager.ConfiguredRemotePluginRefs(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn prune(\n\t\tctx,\n\t\txslices.Map(\n\t\t\tconfiguredRemotePluginRefs,\n\t\t\tfunc(pluginRef bufparse.Ref) string {\n\t\t\t\treturn pluginRef.FullName().String()\n\t\t\t},\n\t\t),\n\t\tworkspaceDepManager,\n\t)\n}\n\nfunc prune(\n\tctx context.Context,\n\tbufYAMLBasedRemotePluginNames []string,\n\tworkspaceDepManager bufworkspace.WorkspaceDepManager,\n) error {\n\tbufYAMLRemotePluginNames := xslices.ToStructMap(bufYAMLBasedRemotePluginNames)\n\texistingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar prunedBufLockPluginKeys []bufplugin.PluginKey\n\tfor _, existingRemotePluginKey := range existingRemotePluginKeys {\n\t\t// Check if an existing plugin key from the buf.lock is configured in the buf.yaml.\n\t\tif _, ok := bufYAMLRemotePluginNames[existingRemotePluginKey.FullName().String()]; ok {\n\t\t\t// If yes, then we keep it for the updated buf.lock.\n\t\t\tprunedBufLockPluginKeys = append(prunedBufLockPluginKeys, existingRemotePluginKey)\n\t\t}\n\t}\n\t// We keep the existing dep module keys as-is.\n\texistingDepModuleKeys, err := workspaceDepManager.ExistingBufLockFileDepModuleKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingRemotePolicyKeys, err := workspaceDepManager.ExistingBufLockFileRemotePolicyKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingPolicyNameToRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFilePolicyNameToRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, prunedBufLockPluginKeys, existingRemotePolicyKeys, existingPolicyNameToRemotePluginKeys)\n}\n" }, { "path": "cmd/buf/internal/command/plugin/pluginpush/pluginpush.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage pluginpush\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"os\"\n\t\"slices\"\n\t\"strings\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufplugin\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tlabelFlagName = \"label\"\n\tbinaryFlagName = \"binary\"\n\tcreateFlagName = \"create\"\n\tcreateVisibilityFlagName = \"create-visibility\"\n\tcreateTypeFlagName = \"create-type\"\n\tsourceControlURLFlagName = \"source-control-url\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Push a check plugin to a registry\",\n\t\tLong: `The first argument is the plugin full name in the format .`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tLabels []string\n\tBinary string\n\tCreate bool\n\tCreateVisibility string\n\tCreateType string\n\tSourceControlURL string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindCreateVisibility(flagSet, &f.CreateVisibility, createVisibilityFlagName, createFlagName)\n\tflagSet.StringSliceVar(\n\t\t&f.Labels,\n\t\tlabelFlagName,\n\t\tnil,\n\t\t\"Associate the label with the plugins pushed. Can be used multiple times.\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.Binary,\n\t\tbinaryFlagName,\n\t\t\"\",\n\t\t\"The path to the Wasm binary file to push.\",\n\t)\n\tflagSet.BoolVar(\n\t\t&f.Create,\n\t\tcreateFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t\"Create the plugin if it does not exist. Defaults to creating a private plugin on the BSR if --%s is not set. Must be used with --%s.\",\n\t\t\tcreateVisibilityFlagName,\n\t\t\tcreateTypeFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.CreateType,\n\t\tcreateTypeFlagName,\n\t\t\"\",\n\t\tfmt.Sprintf(\n\t\t\t\"The plugin's type setting, if created. Can only be set with --%s. Must be one of %s\",\n\t\t\tcreateFlagName,\n\t\t\txstrings.SliceToString(bufplugin.AllPluginTypeStrings),\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.SourceControlURL,\n\t\tsourceControlURLFlagName,\n\t\t\"\",\n\t\t\"The URL for viewing the source code of the pushed plugins (e.g. the specific commit in source control).\",\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tif err := validateFlags(flags); err != nil {\n\t\treturn err\n\t}\n\t// We parse the plugin full name from the user-provided argument.\n\tpluginFullName, err := bufparse.ParseFullName(container.Arg(0))\n\tif err != nil {\n\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t}\n\tcommit, err := upload(ctx, container, flags, pluginFullName)\n\tif err != nil {\n\t\treturn err\n\t}\n\t// Only one commit is returned.\n\tif _, err := fmt.Fprintf(container.Stdout(), \"%s\\n\", commit.PluginKey().String()); err != nil {\n\t\treturn syserror.Wrap(err)\n\t}\n\treturn nil\n}\n\nfunc upload(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n\tpluginFullName bufparse.FullName,\n) (_ bufplugin.Commit, retErr error) {\n\tvar plugin bufplugin.Plugin\n\tswitch {\n\tcase flags.Binary != \"\":\n\t\t// We create a local plugin reference to the Wasm binary.\n\t\tvar err error\n\t\tplugin, err = bufplugin.NewLocalWasmPlugin(\n\t\t\tpluginFullName,\n\t\t\tflags.Binary,\n\t\t\tnil, // args\n\t\t\tfunc() ([]byte, error) {\n\t\t\t\twasmBinary, err := os.ReadFile(flags.Binary)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn nil, fmt.Errorf(\"could not read Wasm binary %q: %w\", flags.Binary, err)\n\t\t\t\t}\n\t\t\t\treturn wasmBinary, nil\n\t\t\t},\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\tdefault:\n\t\t// This should never happen because the flags are validated.\n\t\treturn nil, syserror.Newf(\"--%s must be set\", binaryFlagName)\n\t}\n\tuploader, err := bufcli.NewPluginUploader(container)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar options []bufplugin.UploadOption\n\tif flags.Create {\n\t\tcreatePluginVisibility, err := bufplugin.ParsePluginVisibility(flags.CreateVisibility)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tcreatePluginType, err := bufplugin.ParsePluginType(flags.CreateType)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\toptions = append(options, bufplugin.UploadWithCreateIfNotExist(\n\t\t\tcreatePluginVisibility,\n\t\t\tcreatePluginType,\n\t\t))\n\t}\n\tif len(flags.Labels) > 0 {\n\t\toptions = append(options, bufplugin.UploadWithLabels(flags.Labels...))\n\t}\n\tif flags.SourceControlURL != \"\" {\n\t\toptions = append(options, bufplugin.UploadWithSourceControlURL(flags.SourceControlURL))\n\t}\n\tcommits, err := uploader.Upload(ctx, []bufplugin.Plugin{plugin}, options...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif len(commits) != 1 {\n\t\treturn nil, syserror.Newf(\"unexpected number of commits returned from server: %d\", len(commits))\n\t}\n\treturn commits[0], nil\n}\n\nfunc validateFlags(flags *flags) error {\n\tif err := validateLabelFlags(flags); err != nil {\n\t\treturn err\n\t}\n\tif err := validateTypeFlags(flags); err != nil {\n\t\treturn err\n\t}\n\tif err := validateCreateFlags(flags); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\nfunc validateLabelFlags(flags *flags) error {\n\treturn validateLabelFlagValues(flags)\n}\n\nfunc validateTypeFlags(flags *flags) error {\n\tvar typeFlags []string\n\tif flags.Binary != \"\" {\n\t\ttypeFlags = append(typeFlags, binaryFlagName)\n\t}\n\tif len(typeFlags) > 1 {\n\t\tusedFlagsErrStr := strings.Join(\n\t\t\txslices.Map(\n\t\t\t\ttypeFlags,\n\t\t\t\tfunc(flag string) string { return fmt.Sprintf(\"--%s\", flag) },\n\t\t\t),\n\t\t\t\", \",\n\t\t)\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"These flags cannot be used in combination with one another: %s\", usedFlagsErrStr)\n\t}\n\tif len(typeFlags) == 0 {\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be set\", binaryFlagName)\n\t}\n\treturn nil\n}\n\nfunc validateLabelFlagValues(flags *flags) error {\n\tif slices.Contains(flags.Labels, \"\") {\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s requires a non-empty string\", labelFlagName)\n\t}\n\treturn nil\n}\n\nfunc validateCreateFlags(flags *flags) error {\n\tif flags.Create {\n\t\tif flags.CreateVisibility == \"\" {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be set if --%s is set\", createVisibilityFlagName, createFlagName)\n\t\t}\n\t\tif _, err := bufplugin.ParsePluginVisibility(flags.CreateVisibility); err != nil {\n\t\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t\t}\n\t}\n\tif flags.Create {\n\t\tif flags.CreateType == \"\" {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be set if --%s is set\", createTypeFlagName, createFlagName)\n\t\t}\n\t\tif _, err := bufplugin.ParsePluginType(flags.CreateType); err != nil {\n\t\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t\t}\n\t}\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/plugin/pluginupdate/pluginupdate.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage pluginupdate\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufplugin\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tonlyFlagName = \"only\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Update pinned remote plugins in a buf.lock\",\n\t\tLong: `Fetch the latest digests for the specified plugin references in buf.yaml.\n\nThe first argument is the directory of the local module to update.\nDefaults to \".\" if no argument is specified.`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tOnly []string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringSliceVar(\n\t\t&f.Only,\n\t\tonlyFlagName,\n\t\tnil,\n\t\t\"The name of the plugin to update. When set, only this plugin is updated. May be provided multiple times\",\n\t)\n\t// TODO FUTURE: implement\n\t_ = flagSet.MarkHidden(onlyFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tdirPath := \".\"\n\tif container.NumArgs() > 0 {\n\t\tdirPath = container.Arg(0)\n\t}\n\tif len(flags.Only) > 0 {\n\t\t// TODO FUTURE: implement\n\t\treturn syserror.Newf(\"--%s is not implemented\", onlyFlagName)\n\t}\n\n\tlogger := container.Logger()\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspaceDepManager, err := controller.GetWorkspaceDepManager(ctx, dirPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredRemotePluginRefs, err := workspaceDepManager.ConfiguredRemotePluginRefs(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tpluginKeyProvider, err := bufcli.NewPluginKeyProvider(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredRemotePluginKeys, err := pluginKeyProvider.GetPluginKeysForPluginRefs(\n\t\tctx,\n\t\tconfiguredRemotePluginRefs,\n\t\tbufplugin.DigestTypeP1,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// Store the existing buf.lock data.\n\texistingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif configuredRemotePluginKeys == nil && existingRemotePluginKeys == nil {\n\t\t// No new configured remote plugins were found, and no existing buf.lock deps were found, so there\n\t\t// is nothing to update, we can return here.\n\t\t// This ensures we do not create an empty buf.lock when one did not exist in the first\n\t\t// place and we do not need to go through the entire operation of updating non-existent\n\t\t// deps and building the image for tamper-proofing.\n\t\tlogger.Warn(fmt.Sprintf(\"No configured remote plugins were found to update in %q.\", dirPath))\n\t\treturn nil\n\t}\n\texistingDepModuleKeys, err := workspaceDepManager.ExistingBufLockFileDepModuleKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingRemotePolicyKeys, err := workspaceDepManager.ExistingBufLockFileRemotePolicyKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingPolicyNameToRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFilePolicyNameToRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// We're about to edit the buf.lock file on disk. If we have a subsequent error,\n\t// attempt to revert the buf.lock file.\n\t//\n\t// TODO FUTURE: We should be able to update the buf.lock file in an in-memory bucket, then do the rebuild,\n\t// and if the rebuild is successful, then actually write to disk. It shouldn't even be that much work - just\n\t// overlay the new buf.lock file in a union bucket.\n\tdefer func() {\n\t\tif retErr != nil {\n\t\t\tretErr = errors.Join(retErr, workspaceDepManager.UpdateBufLockFile(\n\t\t\t\tctx, existingDepModuleKeys, existingRemotePluginKeys, existingRemotePolicyKeys, existingPolicyNameToRemotePluginKeys,\n\t\t\t))\n\t\t}\n\t}()\n\t// Edit the buf.lock file with the updated remote plugins.\n\tif err := workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, configuredRemotePluginKeys, existingRemotePolicyKeys, existingPolicyNameToRemotePluginKeys); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/policy/policyprune/policyprune.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage policyprune\n\nimport (\n\t\"context\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufworkspace\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufplugin\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufpolicy\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Prune unused policies from buf.lock\",\n\t\tLong: `Policies that are no longer configured in buf.yaml are removed from the buf.lock file.\n\nThe first argument is the directory of your buf.yaml configuration file.\nDefaults to \".\" if no argument is specified.`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container)\n\t\t\t},\n\t\t),\n\t}\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n) error {\n\tdirPath := \".\"\n\tif container.NumArgs() > 0 {\n\t\tdirPath = container.Arg(0)\n\t}\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspaceDepManager, err := controller.GetWorkspaceDepManager(ctx, dirPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredRemotePolicyRefs, err := workspaceDepManager.ConfiguredRemotePolicyRefs(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn prune(\n\t\tctx,\n\t\txslices.Map(\n\t\t\tconfiguredRemotePolicyRefs,\n\t\t\tfunc(policyRef bufparse.Ref) string {\n\t\t\t\treturn policyRef.FullName().String()\n\t\t\t},\n\t\t),\n\t\tworkspaceDepManager,\n\t)\n}\n\nfunc prune(\n\tctx context.Context,\n\tbufYAMLBasedRemotePolicyNames []string,\n\tworkspaceDepManager bufworkspace.WorkspaceDepManager,\n) error {\n\tbufYAMLRemotePolicyNames := xslices.ToStructMap(bufYAMLBasedRemotePolicyNames)\n\texistingRemotePolicyKeys, err := workspaceDepManager.ExistingBufLockFileRemotePolicyKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingPolicyNameToRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFilePolicyNameToRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar (\n\t\tprunedBufLockPolicyKeys []bufpolicy.PolicyKey\n\t\tprunedBufLockPolicyNameToRemotePluginKeys = make(map[string][]bufplugin.PluginKey)\n\t)\n\tfor _, existingRemotePolicyKey := range existingRemotePolicyKeys {\n\t\t// Check if an existing policy key from the buf.lock is configured in the buf.yaml.\n\t\tpolicyFullNameString := existingRemotePolicyKey.FullName().String()\n\t\tif _, ok := bufYAMLRemotePolicyNames[policyFullNameString]; ok {\n\t\t\t// If yes, then we keep it for the updated buf.lock.\n\t\t\tprunedBufLockPolicyKeys = append(prunedBufLockPolicyKeys, existingRemotePolicyKey)\n\t\t\texistingRemotePluginKeys := existingPolicyNameToRemotePluginKeys[policyFullNameString]\n\t\t\tprunedBufLockPolicyNameToRemotePluginKeys[policyFullNameString] = existingRemotePluginKeys\n\t\t}\n\t}\n\t// We keep the existing dep module keys as-is.\n\texistingDepModuleKeys, err := workspaceDepManager.ExistingBufLockFileDepModuleKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, existingRemotePluginKeys, prunedBufLockPolicyKeys, prunedBufLockPolicyNameToRemotePluginKeys)\n}\n" }, { "path": "cmd/buf/internal/command/policy/policypush/policypush.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage policypush\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"os\"\n\t\"slices\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufpolicy\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufpolicy/bufpolicyconfig\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/google/uuid\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tlabelFlagName = \"label\"\n\tcreateFlagName = \"create\"\n\tcreateVisibilityFlagName = \"create-visibility\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Push a policy to a registry\",\n\t\tLong: `The first argument is the path to the local policy config.`,\n\t\tArgs: appcmd.ExactArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tLabels []string\n\tCreate bool\n\tCreateVisibility string\n\tSourceControlURL string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindCreateVisibility(flagSet, &f.CreateVisibility, createVisibilityFlagName, createFlagName)\n\tflagSet.StringSliceVar(\n\t\t&f.Labels,\n\t\tlabelFlagName,\n\t\tnil,\n\t\t\"Associate the label with the policies pushed. Can be used multiple times.\",\n\t)\n\tflagSet.BoolVar(\n\t\t&f.Create,\n\t\tcreateFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t\"Create the policy if it does not exist. Defaults to creating a private policy on the BSR if --%s is not set.\",\n\t\t\tcreateVisibilityFlagName,\n\t\t),\n\t)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tif err := validateFlags(flags); err != nil {\n\t\treturn err\n\t}\n\tcommit, err := upload(ctx, container, flags)\n\tif err != nil {\n\t\treturn err\n\t}\n\t// Only one commit is returned.\n\tif _, err := fmt.Fprintf(container.Stdout(), \"%s\\n\", commit.PolicyKey().String()); err != nil {\n\t\treturn syserror.Wrap(err)\n\t}\n\treturn nil\n}\n\nfunc upload(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (_ bufpolicy.Commit, retErr error) {\n\tvar policy bufpolicy.Policy\n\tif container.NumArgs() != 1 {\n\t\t// This should never happen because the args length is validated.\n\t\treturn nil, syserror.Newf(\"policy arg must be provided\")\n\t}\n\tpolicyFilePath := container.Arg(0)\n\t// We read the policy YAML file.\n\tdata, err := os.ReadFile(policyFilePath)\n\tif err != nil {\n\t\treturn nil, appcmd.NewInvalidArgumentErrorf(\"could not read policy file %q: %w\", policyFilePath, err)\n\t}\n\t// Parse the policy YAML file to validate it upfront.\n\tpolicyYamlFile, err := bufpolicyconfig.ReadBufPolicyYAMLFile(bytes.NewReader(data), policyFilePath)\n\tif err != nil {\n\t\treturn nil, appcmd.NewInvalidArgumentErrorf(\"unable to validate policy file %q: %w\", policyFilePath, err)\n\t}\n\t// We parse the policy full name from the user-provided argument.\n\tif policyYamlFile.Name() == \"\" {\n\t\treturn nil, appcmd.NewInvalidArgumentErrorf(\"policy file %q must have a name\", policyFilePath)\n\t}\n\tpolicyFullName, err := bufparse.ParseFullName(policyYamlFile.Name())\n\tif err != nil {\n\t\treturn nil, appcmd.NewInvalidArgumentErrorf(\"unable to parse policy full name %q: %w\", policyYamlFile.Name(), err)\n\t}\n\tpolicy, err = bufpolicy.NewPolicy(policyFilePath, policyFullName, policyFullName.Name(), uuid.Nil, policyYamlFile.PolicyConfig)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"unable to create policy from file %q: %w\", policyFilePath, err)\n\t}\n\tuploader, err := bufcli.NewPolicyUploader(container)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar options []bufpolicy.UploadOption\n\tif flags.Create {\n\t\tcreatePolicyVisibility, err := bufpolicy.ParsePolicyVisibility(flags.CreateVisibility)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\toptions = append(options, bufpolicy.UploadWithCreateIfNotExist(\n\t\t\tcreatePolicyVisibility,\n\t\t))\n\t}\n\tif len(flags.Labels) > 0 {\n\t\toptions = append(options, bufpolicy.UploadWithLabels(flags.Labels...))\n\t}\n\tif flags.SourceControlURL != \"\" {\n\t\toptions = append(options, bufpolicy.UploadWithSourceControlURL(flags.SourceControlURL))\n\t}\n\tcommits, err := uploader.Upload(ctx, []bufpolicy.Policy{policy}, options...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif len(commits) != 1 {\n\t\treturn nil, syserror.Newf(\"unexpected number of commits returned from server: %d\", len(commits))\n\t}\n\treturn commits[0], nil\n}\n\nfunc validateFlags(flags *flags) error {\n\tif err := validateLabelFlags(flags); err != nil {\n\t\treturn err\n\t}\n\tif err := validateCreateFlags(flags); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\nfunc validateLabelFlags(flags *flags) error {\n\treturn validateLabelFlagValues(flags)\n}\n\nfunc validateLabelFlagValues(flags *flags) error {\n\tif slices.Contains(flags.Labels, \"\") {\n\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s requires a non-empty string\", labelFlagName)\n\t}\n\treturn nil\n}\n\nfunc validateCreateFlags(flags *flags) error {\n\tif flags.Create {\n\t\tif flags.CreateVisibility == \"\" {\n\t\t\treturn appcmd.NewInvalidArgumentErrorf(\"--%s must be set if --%s is set\", createVisibilityFlagName, createFlagName)\n\t\t}\n\t\tif _, err := bufpolicy.ParsePolicyVisibility(flags.CreateVisibility); err != nil {\n\t\t\treturn appcmd.WrapInvalidArgumentError(err)\n\t\t}\n\t}\n\treturn nil\n}\n" }, { "path": "cmd/buf/internal/command/policy/policyupdate/policyupdate.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage policyupdate\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"maps\"\n\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufparse\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufplugin\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufpolicy\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tonlyFlagName = \"only\"\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Update pinned remote policies in a buf.lock\",\n\t\tLong: `Fetch the latest digests for the specified policy references in buf.yaml.\n\nThe first argument is the directory of the local module to update.\nDefaults to \".\" if no argument is specified.`,\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tOnly []string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tflagSet.StringSliceVar(\n\t\t&f.Only,\n\t\tonlyFlagName,\n\t\tnil,\n\t\t\"The name of the policy to update. When set, only this policy is updated. May be provided multiple times\",\n\t)\n\t// TODO FUTURE: implement\n\t_ = flagSet.MarkHidden(onlyFlagName)\n}\n\nfunc run(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tflags *flags,\n) (retErr error) {\n\tdirPath := \".\"\n\tif container.NumArgs() > 0 {\n\t\tdirPath = container.Arg(0)\n\t}\n\tif len(flags.Only) > 0 {\n\t\t// TODO FUTURE: implement\n\t\treturn syserror.Newf(\"--%s is not implemented\", onlyFlagName)\n\t}\n\n\tlogger := container.Logger()\n\tcontroller, err := bufcli.NewController(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tworkspaceDepManager, err := controller.GetWorkspaceDepManager(ctx, dirPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredRemotePolicyRefs, err := workspaceDepManager.ConfiguredRemotePolicyRefs(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredLocalPolicyNameToRemotePluginRefs, err := workspaceDepManager.ConfiguredLocalPolicyNameToRemotePluginRefs(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tpolicyKeyProvider, err := bufcli.NewPolicyKeyProvider(container)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredRemotePolicyKeys, err := policyKeyProvider.GetPolicyKeysForPolicyRefs(\n\t\tctx,\n\t\tconfiguredRemotePolicyRefs,\n\t\tbufpolicy.DigestTypeO1,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredRemotePolicyNameToRemotePluginKeys, err := getPolicyKeyPluginKeysForPolicyKeys(\n\t\tctx,\n\t\tcontainer,\n\t\tconfiguredRemotePolicyKeys,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tconfiguredLocalPolicyNameToRemotePluginKeys, err := getPolicyPluginKeysForPolicyNames(\n\t\tctx,\n\t\tcontainer,\n\t\tconfiguredLocalPolicyNameToRemotePluginRefs,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar configuredPolicyNameToRemotePluginKeys map[string][]bufplugin.PluginKey\n\tif policyCount := len(configuredRemotePolicyNameToRemotePluginKeys) + len(configuredLocalPolicyNameToRemotePluginKeys); policyCount > 0 {\n\t\tconfiguredPolicyNameToRemotePluginKeys = make(map[string][]bufplugin.PluginKey, policyCount)\n\t\tmaps.Copy(configuredPolicyNameToRemotePluginKeys, configuredRemotePolicyNameToRemotePluginKeys)\n\t\tmaps.Copy(configuredPolicyNameToRemotePluginKeys, configuredLocalPolicyNameToRemotePluginKeys)\n\t}\n\n\t// Store the existing buf.lock data.\n\texistingRemotePolicyKeys, err := workspaceDepManager.ExistingBufLockFileRemotePolicyKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingPolicyNameToRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFilePolicyNameToRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif len(configuredRemotePolicyKeys) == 0 && len(configuredPolicyNameToRemotePluginKeys) == 0 &&\n\t\tlen(existingRemotePolicyKeys) == 0 && len(existingPolicyNameToRemotePluginKeys) == 0 {\n\t\t// No new configured remote plugins were found, and no existing buf.lock deps were found, so there\n\t\t// is nothing to update, we can return here.\n\t\t// This ensures we do not create an empty buf.lock when one did not exist in the first\n\t\t// place and we do not need to go through the entire operation of updating non-existent\n\t\t// deps and building the image for tamper-proofing.\n\t\tlogger.Warn(fmt.Sprintf(\"No configured remote policies were found to update in %q.\", dirPath))\n\t\treturn nil\n\t}\n\texistingDepModuleKeys, err := workspaceDepManager.ExistingBufLockFileDepModuleKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\texistingRemotePluginKeys, err := workspaceDepManager.ExistingBufLockFileRemotePluginKeys(ctx)\n\tif err != nil {\n\t\treturn err\n\t}\n\t// We're about to edit the buf.lock file on disk. If we have a subsequent error,\n\t// attempt to revert the buf.lock file.\n\t//\n\t// TODO FUTURE: We should be able to update the buf.lock file in an in-memory bucket, then do the rebuild,\n\t// and if the rebuild is successful, then actually write to disk. It shouldn't even be that much work - just\n\t// overlay the new buf.lock file in a union bucket.\n\tdefer func() {\n\t\tif retErr != nil {\n\t\t\tretErr = errors.Join(retErr, workspaceDepManager.UpdateBufLockFile(\n\t\t\t\tctx, existingDepModuleKeys, existingRemotePluginKeys, existingRemotePolicyKeys, existingPolicyNameToRemotePluginKeys,\n\t\t\t))\n\t\t}\n\t}()\n\t// Edit the buf.lock file with the updated remote plugins.\n\tif err := workspaceDepManager.UpdateBufLockFile(ctx, existingDepModuleKeys, existingRemotePluginKeys, configuredRemotePolicyKeys, configuredPolicyNameToRemotePluginKeys); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\nfunc getPolicyKeyPluginKeysForPolicyKeys(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tpolicyKeys []bufpolicy.PolicyKey,\n) (map[string][]bufplugin.PluginKey, error) {\n\tif len(policyKeys) == 0 {\n\t\treturn nil, nil\n\t}\n\tpolicyDataProvider, err := bufcli.NewPolicyDataProvider(container)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tpluginKeyProvider, err := bufcli.NewPluginKeyProvider(container)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tpolicyDatas, err := policyDataProvider.GetPolicyDatasForPolicyKeys(ctx, policyKeys)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tpolicyNameToRemotePluginKeys := make(map[string][]bufplugin.PluginKey)\n\tfor _, policyData := range policyDatas {\n\t\tpolicyConfig, err := policyData.Config()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tpluginConfigs := policyConfig.PluginConfigs()\n\t\tpluginRefs, err := xslices.MapError(pluginConfigs, func(pluginConfig bufpolicy.PluginConfig) (bufparse.Ref, error) {\n\t\t\tpluginRef := pluginConfig.Ref()\n\t\t\tif pluginRef == nil {\n\t\t\t\treturn nil, fmt.Errorf(\"plugin config %q does not have a valid ref\", pluginConfig.Name())\n\t\t\t}\n\t\t\treturn pluginRef, nil\n\t\t})\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to get plugin refs for policy %q: %w\", policyData.PolicyKey(), err)\n\t\t}\n\t\tremotePluginKeys, err := pluginKeyProvider.GetPluginKeysForPluginRefs(\n\t\t\tctx,\n\t\t\tpluginRefs,\n\t\t\tbufplugin.DigestTypeP1,\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tpolicyName := policyData.PolicyKey().FullName().String()\n\t\tif len(remotePluginKeys) > 0 {\n\t\t\tpolicyNameToRemotePluginKeys[policyName] = remotePluginKeys\n\t\t}\n\t}\n\treturn policyNameToRemotePluginKeys, nil\n}\n\nfunc getPolicyPluginKeysForPolicyNames(\n\tctx context.Context,\n\tcontainer appext.Container,\n\tlocalPolicyNameToRemotePluginRefs map[string][]bufparse.Ref,\n) (map[string][]bufplugin.PluginKey, error) {\n\tif len(localPolicyNameToRemotePluginRefs) == 0 {\n\t\treturn nil, nil\n\t}\n\tpluginKeyProvider, err := bufcli.NewPluginKeyProvider(container)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tpolicyNameToRemotePluginKeys := make(map[string][]bufplugin.PluginKey)\n\tfor policyName, pluginRefs := range localPolicyNameToRemotePluginRefs {\n\t\tremotePluginKeys, err := pluginKeyProvider.GetPluginKeysForPluginRefs(\n\t\t\tctx,\n\t\t\tpluginRefs,\n\t\t\tbufplugin.DigestTypeP1,\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif len(remotePluginKeys) > 0 {\n\t\t\tpolicyNameToRemotePluginKeys[policyName] = remotePluginKeys\n\t\t}\n\t}\n\treturn policyNameToRemotePluginKeys, nil\n}\n" }, { "path": "cmd/buf/internal/command/push/push.go", "content": "// Copyright 2020-2026 Buf Technologies, Inc.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage push\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"slices\"\n\t\"strings\"\n\n\t\"buf.build/go/app\"\n\t\"buf.build/go/app/appcmd\"\n\t\"buf.build/go/app/appext\"\n\t\"buf.build/go/standard/xslices\"\n\t\"buf.build/go/standard/xstrings\"\n\t\"github.com/bufbuild/buf/private/buf/bufcli\"\n\t\"github.com/bufbuild/buf/private/buf/bufctl\"\n\t\"github.com/bufbuild/buf/private/buf/buffetch\"\n\t\"github.com/bufbuild/buf/private/buf/bufworkspace\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufanalysis\"\n\t\"github.com/bufbuild/buf/private/bufpkg/bufmodule\"\n\t\"github.com/bufbuild/buf/private/pkg/git\"\n\t\"github.com/bufbuild/buf/private/pkg/syserror\"\n\t\"github.com/bufbuild/buf/private/pkg/uuidutil\"\n\t\"github.com/spf13/pflag\"\n)\n\nconst (\n\tlabelFlagName = \"label\"\n\terrorFormatFlagName = \"error-format\"\n\tdisableSymlinksFlagName = \"disable-symlinks\"\n\tcreateFlagName = \"create\"\n\tcreateVisibilityFlagName = \"create-visibility\"\n\tcreateDefaultLabelFlagName = \"create-default-label\"\n\tsourceControlURLFlagName = \"source-control-url\"\n\tgitMetadataFlagName = \"git-metadata\"\n\texcludeUnnamedFlagName = \"exclude-unnamed\"\n\n\t// All deprecated.\n\ttagFlagName = \"tag\"\n\ttagFlagShortName = \"t\"\n\tdraftFlagName = \"draft\"\n\tbranchFlagName = \"branch\"\n\n\tgitOriginRemote = \"origin\"\n)\n\nvar (\n\tuseLabelInstead = fmt.Sprintf(\"use --%s instead.\", labelFlagName)\n)\n\n// NewCommand returns a new Command.\nfunc NewCommand(\n\tname string,\n\tbuilder appext.SubCommandBuilder,\n) *appcmd.Command {\n\tflags := newFlags()\n\treturn &appcmd.Command{\n\t\tUse: name + \" \",\n\t\tShort: \"Push to a registry\",\n\t\tLong: bufcli.GetSourceLong(`the source to push`),\n\t\tArgs: appcmd.MaximumNArgs(1),\n\t\tRun: builder.NewRunFunc(\n\t\t\tfunc(ctx context.Context, container appext.Container) error {\n\t\t\t\treturn run(ctx, container, flags)\n\t\t\t},\n\t\t),\n\t\tBindFlags: flags.Bind,\n\t}\n}\n\ntype flags struct {\n\tTags []string\n\tBranch string\n\tDraft string\n\tLabels []string\n\tErrorFormat string\n\tDisableSymlinks bool\n\tCreate bool\n\tCreateVisibility string\n\tCreateDefaultLabel string\n\tSourceControlURL string\n\tExcludeUnnamed bool\n\tGitMetadata bool\n\t// special\n\tInputHashtag string\n}\n\nfunc newFlags() *flags {\n\treturn &flags{}\n}\n\nfunc (f *flags) Bind(flagSet *pflag.FlagSet) {\n\tbufcli.BindInputHashtag(flagSet, &f.InputHashtag)\n\tbufcli.BindDisableSymlinks(flagSet, &f.DisableSymlinks, disableSymlinksFlagName)\n\tbufcli.BindCreateVisibility(flagSet, &f.CreateVisibility, createVisibilityFlagName, createFlagName)\n\tflagSet.StringSliceVar(\n\t\t&f.Labels,\n\t\tlabelFlagName,\n\t\tnil,\n\t\t\"Associate the label with the modules pushed. Can be used multiple times.\",\n\t)\n\tflagSet.StringVar(\n\t\t&f.ErrorFormat,\n\t\terrorFormatFlagName,\n\t\t\"text\",\n\t\tfmt.Sprintf(\n\t\t\t\"The format for build errors printed to stderr. Must be one of %s\",\n\t\t\txstrings.SliceToString(bufanalysis.AllFormatStrings),\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.Create,\n\t\tcreateFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t\"Create the module if it does not exist. Defaults to creating a private module if --%s is not set.\",\n\t\t\tcreateVisibilityFlagName,\n\t\t),\n\t)\n\tflagSet.StringVar(\n\t\t&f.CreateDefaultLabel,\n\t\tcreateDefaultLabelFlagName,\n\t\t\"\",\n\t\t`The module's default label setting, if created. If this is not set, then the module will be created with the default label \"main\".`,\n\t)\n\tflagSet.StringVar(\n\t\t&f.SourceControlURL,\n\t\tsourceControlURLFlagName,\n\t\t\"\",\n\t\t\"The URL for viewing the source code of the pushed modules (e.g. the specific commit in source control).\",\n\t)\n\tflagSet.BoolVar(\n\t\t&f.GitMetadata,\n\t\tgitMetadataFlagName,\n\t\tfalse,\n\t\tfmt.Sprintf(\n\t\t\t`Uses the Git source control state to set flag values. If this flag is set, we will use the following values for your flags:\n\n\t--%s to /// (e.g. https://github.com/acme/weather/commit/ffac537e6cbbf934b08745a378932722df287a53).\n\t--%s for each Git tag and branch pointing to the currently checked out commit. You can set additional labels using --%s with this flag.\n\t--%s to the Git default branch (e.g. main) - this is only in effect if --%s is also set.\n\nThe source control URL and default branch is based on the required Git remote %q.\nThis flag is only compatible with checkouts of Git source repositories.\nIf you set the --%s flag and/or --%s flag yourself, then the value(s) will be used instead and the information will not be derived from the Git source control state.`,\n\t\t\tsourceControlURLFlagName,\n\t\t\tlabelFlagName,\n\t\t\tlabelFlagName,\n\t\t\tcreateDefaultLabelFlagName,\n\t\t\tcreateFlagName,\n\t\t\tgitOriginRemote,\n\t\t\tsourceControlURLFlagName,\n\t\t\tcreateDefaultLabelFlagName,\n\t\t),\n\t)\n\tflagSet.BoolVar(\n\t\t&f.ExcludeUnnamed,\n\t\texcludeUnnamedFlagName,\n\t\tfalse,\n\t\t\"Only push named modules to the BSR. Named modules must not have any unnamed dependencies.\",\n\t)\n\n\tflagSet.StringSliceVarP(&f.Tags, tagFlagName, tagFlagShortName, nil, useLabelInstead)\n\t_ = flagSet.MarkHidden(tagFlagName)\n\t_ = flagSet.MarkHidden(tagFlagShortName)\n\t_ = flagSet.MarkDeprecated(\n\t\ttagFlagName,\n\t\tfmt.Sprintf(\n\t\t\t`%s Replace \"buf push --tag \" with \"buf push --label --label \" ( and are equivalent in this case).\nYou can also use \"buf registry commit add-label --label