Update how code is generated from .proto files (#566)

* go get google.golang.org/genproto

* go get github.com/hashicorp/[email protected]

* go mod tidy

* Copy approach for generating code from proto files from hashicorp/terraform

* Add use of Go workspace to let Makefile run Go code in ./tools

* Fix to where code is generated to

* Update script to match the current version of protoc used

* switch to MPL-2.0 licensed version of this tool from Terraform v1.5

MPL licensed source: https://github.com/hashicorp/terraform/blob/7111fd1170c90b2b05aae61e7c89cc812dd7ca7b/tools/protobuf-compile/protobuf-compile.go

* re-adjust generation to plugin-go

Co-authored-by: Sarah French <[email protected]>

* Fix the terraform-provider-corner-tfprotov5 tests

* Fix the terraform-provider-corner-tfprotov6 tests

* Change how diffing GHA downloads protoc

* go mod download

* Update README

* Update description & instructions related to reusable proto files

* Remove `protoc` and `tools` targets in Makefile, simplify README

---------

Co-authored-by: Ansgar Mertens <[email protected]>

Author: SarahFrench

.github/workflows/ci-go.yml

@@ -41,6 +41,7 @@ jobs:
         with:
           terraform_version: ${{ matrix.terraform }}
           terraform_wrapper: false
+      - run: go work use ../terraform-provider-corner
       - run: go mod edit -replace github.com/hashicorp/terraform-plugin-go=../
       - run: go mod tidy
       - run: go test -v ./internal/protocolprovider
@@ -74,6 +75,7 @@ jobs:
         with:
           terraform_version: ${{ matrix.terraform }}
           terraform_wrapper: false
+      - run: go work use ../terraform-provider-corner
       - run: go mod edit -replace github.com/hashicorp/terraform-plugin-go=../
       - run: go mod tidy
       - run: go test -v ./internal/framework6provider

.github/workflows/ci-protobuf.yml

@@ -23,17 +23,8 @@ jobs:
       - uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0
         with:
           go-version-file: 'go.mod'
-      - uses: arduino/setup-protoc@c65c819552d16ad3c9b72d9dfd5ba5237b9c906b # v3.0.0
-        with:
-          # The version string is embedded in protoc generated files, so it is
-          # pinned here to prevent unexpected differences. Follow the
-          # https://github.com/protocolbuffers/protobuf repository for protoc
-          # release updates.
-          version: '29.3'
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
       - run: go mod download
-      - run: make tools
-      - run: make protoc
+      - run: make protobuf
       - name: git diff
         run: |
           git diff --compact-summary --exit-code || \

Makefile

@@ -3,29 +3,10 @@ default: test
 lint:
 	golangci-lint run ./...
 
-tools:
-	go install google.golang.org/protobuf/cmd/protoc-gen-go
-	cd tools; go install google.golang.org/grpc/cmd/protoc-gen-go-grpc
-
 # Protocol Buffers compilation is done outside of 'go generate' handling since
 # the 'protoc' tool is not installable via 'go install'.
-protoc:
-	@cd tfprotov5/internal/tfplugin5 && \
-		protoc \
-			--proto_path=. \
-			--go_out=. \
-			--go_opt=paths=source_relative \
-			--go-grpc_out=. \
-			--go-grpc_opt=paths=source_relative \
-			tfplugin5.proto
-	@cd tfprotov6/internal/tfplugin6 && \
-		protoc \
-			--proto_path=. \
-			--go_out=. \
-			--go_opt=paths=source_relative \
-			--go-grpc_out=. \
-			--go-grpc_opt=paths=source_relative \
-			tfplugin6.proto
+protobuf:
+	go run ./tools/protobuf-compile .
 
 test:
 	go test ./...

README.md

@@ -177,16 +177,9 @@ Run `golangci-lint run ./...` or `make lint` after any changes.
 
 ### Protocol Updates
 
-Ensure the following tooling is installed:
-
-- [`protoc`](https://github.com/protocolbuffers/protobuf): Protocol Buffers compiler. This isn't Go specific tooling, so follow this [installation guide](https://github.com/protocolbuffers/protobuf#protobuf-compiler-installation)
-  - The Terraform Plugin Protocol uses well-known types (`Timestamp`), so be sure to copy the `include` directory to a folder included in your `PATH` (for example, on MacOS, `/usr/local/include`).
-- [`protoc-gen-go`](https://pkg.go.dev/google.golang.org/protobuf/cmd/protoc-gen-go): Go plugin for Protocol Buffers compiler. Install by running `make tools`
-- [`protoc-gen-go-grpc`](https://pkg.go.dev/google.golang.org/grpc/cmd/protoc-gen-go-grpc): Go gRPC plugin for Protocol Buffers compiler. Install by running `make tools`
-
-The Protocol Buffers definitions can be found in `tfprotov5/internal/tfplugin5` and `tfprotov6/internal/tfplugin6`.
+Run `make protobuf` to install the necessary tooling and to recompile the Protocol Buffers files after any changes.
 
-Run `make protoc` to recompile the Protocol Buffers files after any changes.
+The `make protobuf` command uses a script in `./tools/protobuf-compile` to compile the Go code using the Protocol Buffers defined in `tfprotov5/internal/tfplugin5` and `tfprotov6/internal/tfplugin6`. Before generating the code, the script will download `protoc` and build binaries for `protoc-gen-go` and `protoc-gen-go-grpc` using the Go toolchain. This tooling will be saved into a gitignored location in that directory, so it's easy to know which tooling versions are in use when making protocol changes.
 
 ## License
 

go.work

@@ -0,0 +1,6 @@
+go 1.24.4
+
+use (
+	.
+	./tools
+)

go.work.sum

@@ -6,65 +6,109 @@ toolchain go1.24.4
 
 require (
 	github.com/hashicorp/copywrite v0.22.0
+	github.com/hashicorp/go-getter v1.7.8
 	google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.5.1
 )
 
 require (
+	cel.dev/expr v0.24.0 // indirect
+	cloud.google.com/go v0.120.0 // indirect
+	cloud.google.com/go/auth v0.16.0 // indirect
+	cloud.google.com/go/auth/oauth2adapt v0.2.8 // indirect
+	cloud.google.com/go/compute/metadata v0.7.0 // indirect
+	cloud.google.com/go/iam v1.5.2 // indirect
+	cloud.google.com/go/monitoring v1.24.2 // indirect
+	cloud.google.com/go/storage v1.50.0 // indirect
 	github.com/AlecAivazis/survey/v2 v2.3.7 // indirect
+	github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcp v1.27.0 // indirect
+	github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric v0.50.0 // indirect
+	github.com/GoogleCloudPlatform/opentelemetry-operations-go/internal/resourcemapping v0.50.0 // indirect
 	github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8 // indirect
 	github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef // indirect
+	github.com/aws/aws-sdk-go v1.44.122 // indirect
+	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect
 	github.com/bmatcuk/doublestar/v4 v4.6.0 // indirect
 	github.com/bradleyfalzon/ghinstallation/v2 v2.5.0 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/cli/go-gh/v2 v2.12.1 // indirect
 	github.com/cli/safeexec v1.0.0 // indirect
 	github.com/cloudflare/circl v1.6.1 // indirect
+	github.com/cncf/xds/go v0.0.0-20250501225837-2ac532fd4443 // indirect
+	github.com/envoyproxy/go-control-plane/envoy v1.32.4 // indirect
+	github.com/envoyproxy/protoc-gen-validate v1.2.1 // indirect
 	github.com/fatih/color v1.15.0 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.5.4 // indirect
+	github.com/go-jose/go-jose/v4 v4.0.5 // indirect
+	github.com/go-logr/logr v1.4.3 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-openapi/errors v0.20.2 // indirect
 	github.com/go-openapi/strfmt v0.21.3 // indirect
 	github.com/golang-jwt/jwt/v4 v4.5.2 // indirect
-	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/go-github/v45 v45.2.0 // indirect
 	github.com/google/go-github/v53 v53.0.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
+	github.com/google/s2a-go v0.1.9 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/googleapis/enterprise-certificate-proxy v0.3.6 // indirect
+	github.com/googleapis/gax-go/v2 v2.14.1 // indirect
+	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-hclog v1.5.0 // indirect
+	github.com/hashicorp/go-safetemp v1.0.0 // indirect
+	github.com/hashicorp/go-version v1.6.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect
 	github.com/jedib0t/go-pretty v4.3.0+incompatible // indirect
 	github.com/jedib0t/go-pretty/v6 v6.4.6 // indirect
+	github.com/jmespath/go-jmespath v0.4.0 // indirect
 	github.com/joho/godotenv v1.3.0 // indirect
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
+	github.com/klauspost/compress v1.15.11 // indirect
 	github.com/knadh/koanf v1.5.0 // indirect
-	github.com/kr/pretty v0.3.1 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-runewidth v0.0.16 // indirect
 	github.com/mergestat/timediff v0.0.3 // indirect
 	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/mitchellh/go-testing-interface v1.14.1 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/oklog/ulid v1.3.1 // indirect
+	github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
-	github.com/rogpeppe/go-internal v1.10.0 // indirect
 	github.com/samber/lo v1.37.0 // indirect
-	github.com/spf13/afero v1.10.0 // indirect
 	github.com/spf13/cobra v1.6.1 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/stretchr/testify v1.9.0 // indirect
+	github.com/spiffe/go-spiffe/v2 v2.5.0 // indirect
 	github.com/thanhpk/randstr v1.0.4 // indirect
+	github.com/ulikunitz/xz v0.5.10 // indirect
+	github.com/zeebo/errs v1.4.0 // indirect
 	go.mongodb.org/mongo-driver v1.10.0 // indirect
-	golang.org/x/crypto v0.36.0 // indirect
+	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
+	go.opentelemetry.io/contrib/detectors/gcp v1.36.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.60.0 // indirect
+	go.opentelemetry.io/otel v1.36.0 // indirect
+	go.opentelemetry.io/otel/metric v1.36.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.36.0 // indirect
+	go.opentelemetry.io/otel/sdk/metric v1.36.0 // indirect
+	go.opentelemetry.io/otel/trace v1.36.0 // indirect
+	golang.org/x/crypto v0.41.0 // indirect
 	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
-	golang.org/x/net v0.38.0 // indirect
-	golang.org/x/oauth2 v0.27.0 // indirect
-	golang.org/x/sync v0.12.0 // indirect
-	golang.org/x/sys v0.31.0 // indirect
-	golang.org/x/term v0.30.0 // indirect
-	golang.org/x/text v0.23.0 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240903143218-8af14fe29dc1 // indirect
-	google.golang.org/grpc v1.66.0 // indirect
-	google.golang.org/protobuf v1.34.2 // indirect
+	golang.org/x/net v0.43.0 // indirect
+	golang.org/x/oauth2 v0.30.0 // indirect
+	golang.org/x/sync v0.16.0 // indirect
+	golang.org/x/sys v0.35.0 // indirect
+	golang.org/x/term v0.34.0 // indirect
+	golang.org/x/text v0.28.0 // indirect
+	golang.org/x/time v0.11.0 // indirect
+	google.golang.org/api v0.229.0 // indirect
+	google.golang.org/genproto v0.0.0-20250908214217-97024824d090 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20250826171959-ef028d996bc1 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250826171959-ef028d996bc1 // indirect
+	google.golang.org/grpc v1.74.2 // indirect
+	google.golang.org/protobuf v1.36.8 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )