Remove gogo from proto bindings (part 1: CRI) #128653
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Copyright 2017 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # This script generates `*/api.pb.go` files from protobuf files `*/api.proto`. | ||
|
|
||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| KUBE_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../" && pwd -P)" | ||
|
|
||
| source "${KUBE_ROOT}/hack/lib/init.sh" | ||
| source "${KUBE_ROOT}/hack/lib/protoc.sh" | ||
| source "${KUBE_ROOT}/hack/lib/util.sh" | ||
|
|
||
| if [ "$#" == 0 ]; then | ||
| echo "usage: $0 <api_dir>..." | ||
| exit 1 | ||
| fi | ||
|
|
||
| kube::protoc::check_protoc | ||
|
|
||
| for api; do | ||
| # This can't use `git ls-files` because it runs in a container without the | ||
| # .git dir synced. | ||
|
|
||
| protos=() | ||
| kube::util::read-array protos < <( \ | ||
| find "${api}" -type f -name "api.proto") | ||
|
|
||
| if [ "${#protos[@]}" == 0 ]; then | ||
| echo "ERROR: no 'api.proto' files under '${api}'" | ||
| exit 1 | ||
| fi | ||
|
|
||
| for file in "${protos[@]}"; do | ||
| dir="$(dirname "${file}")" | ||
| kube::protoc::generate_proto_gogo "${dir}" | ||
| done | ||
| done | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,7 +32,8 @@ PROTOC_VERSION=23.4 | |
| # $1: Full path to the directory where the api.proto file is | ||
| function kube::protoc::generate_proto() { | ||
| kube::golang::setup_env | ||
| go -C "${KUBE_ROOT}/hack/tools" install google.golang.org/protobuf/cmd/protoc-gen-go | ||
| go -C "${KUBE_ROOT}/hack/tools" install google.golang.org/grpc/cmd/protoc-gen-go-grpc | ||
|
|
||
| kube::protoc::check_protoc | ||
|
|
||
|
|
@@ -41,6 +42,20 @@ function kube::protoc::generate_proto() { | |
| kube::protoc::format "${package}" | ||
| } | ||
|
|
||
| # Generates $1/api.pb.go from the protobuf file $1/api.proto | ||
| # and formats it correctly | ||
| # $1: Full path to the directory where the api.proto file is | ||
| function kube::protoc::generate_proto_gogo() { | ||
| kube::golang::setup_env | ||
| GOPROXY=off go install k8s.io/code-generator/cmd/go-to-protobuf/protoc-gen-gogo | ||
|
|
||
| kube::protoc::check_protoc | ||
|
|
||
| local package=${1} | ||
| kube::protoc::protoc_gogo "${package}" | ||
| kube::protoc::format "${package}" | ||
| } | ||
|
|
||
| # Checks that the current protoc version matches the required version and | ||
| # exit 1 if it's not the case | ||
| function kube::protoc::check_protoc() { | ||
|
|
@@ -55,7 +70,7 @@ function kube::protoc::check_protoc() { | |
|
|
||
| # Generates $1/api.pb.go from the protobuf file $1/api.proto | ||
| # $1: Full path to the directory where the api.proto file is | ||
| function kube::protoc::protoc_gogo() { | ||
| local package=${1} | ||
| gogopath=$(dirname "$(kube::util::find-binary "protoc-gen-gogo")") | ||
|
|
||
|
|
@@ -76,17 +91,36 @@ function kube::protoc::protoc() { | |
| ) | ||
| } | ||
|
|
||
| # Generates $1/api.pb.go from the protobuf file $1/api.proto without using gogo | ||
| # $1: Full path to the directory where the api.proto file is | ||
| function kube::protoc::protoc() { | ||
|
There was a problem hiding this comment. we have a new pattern where functions not meant to be called directly have a There was a problem hiding this comment. like Line 416 in e933a30 There was a problem hiding this comment. I'm not sure if I understand that correctly. What we do here is trying to keep the same structure as existing but introducing a parallel implementation (gogo vs non gogo). Do you suggest that we need to refactor them into another location? There was a problem hiding this comment. @BenTheElder do you have a suggestion how to refactor that or should I follow-up when other proto bindings move over to use non-gogo? There was a problem hiding this comment. I think that could be a follow-up that transitions both the kube::protoc::protoc_gogo / kube::protoc::protoc function names to add |
||
| local package=${1} | ||
|
|
||
| protoc \ | ||
| --proto_path="$(pwd -P)" \ | ||
| --proto_path="${KUBE_ROOT}/vendor" \ | ||
| --proto_path="${KUBE_ROOT}/staging/src" \ | ||
| --proto_path="${KUBE_ROOT}/third_party/protobuf" \ | ||
| --go_out=. \ | ||
| --go_opt=paths=source_relative \ | ||
| --go-grpc_out=. \ | ||
| --go-grpc_opt=paths=source_relative \ | ||
| "${package}"/api.proto | ||
| } | ||
|
|
||
| # Formats $1/api.pb.go, adds the boilerplate comments and run gofmt on it | ||
| # $1: Full path to the directory where the api.proto file is | ||
| function kube::protoc::format() { | ||
| local package=${1} | ||
|
|
||
| # Run gofmt to clean up the generated code. | ||
| kube::golang::setup_env | ||
|
|
||
| # Update boilerplate for the generated files. | ||
| for file in "${package}"/api*.pb.go ; do | ||
saschagrunert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| cat hack/boilerplate/boilerplate.generatego.txt "${file}" > tmpfile && mv tmpfile "${file}" | ||
| gofmt -s -w "${file}" | ||
| done | ||
| } | ||
|
|
||
| # Compares the contents of $1 and $2 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any chance we can avoid an entire new script that replicates everything but the
kube::protoc::generate_proto_gogocall?we wouldn't need hack/_update-generated-proto-bindings-gogo-dockerized.sh if we require telling
_update-generated-proto-bindings-dockerized.shwhich generator to use, like this: