Add CI Workflow and Makefile target for Protocol Buffers (#173)

Reference: #172

Also includes the Makefile `lint` and `test` targets along with associated README updates while in the neighborhood.

Author: bflad

.github/workflows/ci-protobuf.yml

@@ -0,0 +1,42 @@
+# Continuous integration handling for Protocol Buffers
+name: ci-protobuf
+
+on:
+  pull_request:
+    paths:
+      - .github/workflows/ci-protobuf.yml
+      - .go-version
+      - go.mod
+      - go.sum
+      - 'tfprotov5/internal/tfplugin5/*'
+      - 'tfprotov6/internal/tfplugin6/*'
+
+permissions:
+  contents: read
+
+jobs:
+  protoc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - id: go-version
+        # Reference: https://github.com/actions/setup-go/issues/23
+        run: echo "::set-output name=version::$(cat ./.go-version)"
+      - uses: actions/setup-go@v2
+        with:
+          go-version: ${{ steps.go-version.outputs.version }}
+      - uses: arduino/setup-protoc@v1
+        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: '3.19.4'
+      - run: go mod download
+      - run: go install google.golang.org/protobuf/cmd/protoc-gen-go
+      - run: go install google.golang.org/grpc/cmd/protoc-gen-go-grpc
+      - run: make protoc
+      - name: git diff
+        run: |
+          git diff --compact-summary --exit-code || \
+            (echo; echo "Unexpected difference in directories after code generation. Run 'protoc' command and commit."; exit 1)

Makefile

@@ -0,0 +1,29 @@
+default: test
+
+lint:
+	golangci-lint run ./...
+
+# 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
+
+test:
+	go test ./...
+
+.PHONY: default lint protoc test

README.md

@@ -157,6 +157,30 @@ out of scope and should live in a separate module.
 
 Please see [`.github/CONTRIBUTING.md`](https://github.com/hashicorp/terraform-plugin-go/blob/main/.github/CONTRIBUTING.md).
 
+### Unit Testing
+
+Run `go test ./...` or `make test` after any changes.
+
+### Linting
+
+Ensure the following tooling is installed:
+
+- [`golangci-lint](https://golangci-lint.run/): Aggregate Go linting tool.
+
+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.
+- [`protoc-gen-go`](https://pkg.go.dev/google.golang.org/protobuf/cmd/protoc-gen-go): Go plugin for Protocol Buffers compiler. e.g. `go install google.golang.org/protobuf/cmd/protoc-gen-go`
+- [`protoc-gen-go-grpc`](https://pkg.go.dev/google.golang.org/grpc/cmd/protoc-gen-go-grpc): Go gRPC plugin for Protocol Buffers compiler. e.g. `go install google.golang.org/grpc/cmd/protoc-gen-go-grpc`
+
+The Protocol Buffers definitions can be found in `tfprotov5/internal/tfplugin5` and `tfprotov6/internal/tfplugin6`.
+
+Run `make protoc` to recompile the Protocol Buffers files after any changes.
+
 ## License
 
 This module is licensed under the [Mozilla Public License v2.0](https://github.com/hashicorp/terraform-plugin-go/blob/main/LICENSE).

go.mod

@@ -13,5 +13,6 @@ require (
 	github.com/nsf/jsondiff v0.0.0-20200515183724-f29ed568f4ce
 	github.com/vmihailenco/msgpack/v4 v4.3.12
 	google.golang.org/grpc v1.45.0
+	google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.2.0
 	google.golang.org/protobuf v1.27.1
 )

go.sum

@@ -176,6 +176,8 @@ google.golang.org/grpc v1.33.1/go.mod h1:fr5YgcSWrqhRRxogOsw7RzIpsmvOZ6IcH4kBYTp
 google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU=
 google.golang.org/grpc v1.45.0 h1:NEpgUqV3Z+ZjkqMsxMg11IaDrXY4RY6CQukSGK0uI1M=
 google.golang.org/grpc v1.45.0/go.mod h1:lN7owxKUQEqMfSyQikvvk5tf/6zMPsrK+ONuO11+0rQ=
+google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.2.0 h1:TLkBREm4nIsEcexnCjgQd5GQWaHcqMzwQV0TX9pq8S0=
+google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.2.0/go.mod h1:DNq5QpG7LJqD2AamLZ7zvKE0DEpVl2BSEVjFycAAjRY=
 google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
 google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
 google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=