Merge pull request #3956 from AkihiroSuda/fix-3953

make check-generated: check reproducibility of *.pb.go too

Author: jandubois

Makefile

@@ -501,9 +501,8 @@ uninstall:
 
 .PHONY: check-generated
 check-generated:
-	@test -z "$$(git status --short | grep ".pb.desc" | tee /dev/stderr)" || \
-		((git diff $$(find . -name '*.pb.desc') | cat) && \
-		(echo "Please run 'make generate' when making changes to proto files and check-in the generated file changes" && false))
+	git diff --exit-code || \
+		(echo "Please run 'make generate' when making changes to proto files and check-in the generated file changes" && false)
 
 .PHONY: lint
 lint: check-generated

hack/gogenerate/protoc.sh

@@ -0,0 +1,29 @@
+#!/bin/sh
+
+# SPDX-FileCopyrightText: Copyright The Lima Authors
+# SPDX-License-Identifier: Apache-2.0
+
+# Generate Go code from a .proto file.
+# Expected to be called from `//go:generate` directive.
+
+set -eu
+if [ "$#" -ne 1 ]; then
+	echo >&2 "Usage: $0 FILE"
+	exit 1
+fi
+
+PROTO="$1"                         ## a.proto
+BASE="$(basename "$PROTO" .proto)" ## a
+PB_DESC="${BASE}.pb.desc"          ## a.pb.desc
+PB_GO="${BASE}.pb.go"              ## a.pb.go
+GRPC_PB_GO="${BASE}_grpc.pb.go"    ## a_grpc.pb.go
+
+set -x
+
+protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative "$PROTO" --descriptor_set_out="$PB_DESC"
+
+# -// - protoc             v6.32.0
+# +// - protoc version [omitted for reproducibility]
+#
+# perl is used because `sed -i` is not portable across BSD (macOS) and GNU.
+perl -pi -E 's@(^//.*)protoc[[:blank:]]+v[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+@\1protoc version [omitted for reproducibility]@g' "$PB_GO" "$GRPC_PB_GO"

pkg/driver/external/driver.pb.go

@@ -1,4 +1,4 @@
-//go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative driver.proto --descriptor_set_out=driver.pb.desc
+//go:generate ../../../hack/gogenerate/protoc.sh driver.proto
 
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0

pkg/driver/external/driver_grpc.pb.go

@@ -1,4 +1,4 @@
-//go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative guestservice.proto --descriptor_set_out=guestservice.pb.desc
+//go:generate ../../../hack/gogenerate/protoc.sh guestservice.proto
 
 // SPDX-FileCopyrightText: Copyright The Lima Authors
 // SPDX-License-Identifier: Apache-2.0