dfdda47bd8
Refactoring script/genproto.sh around state-of-the-art techniques of managing tooling in go: - https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module - uses https://github.com/myitcv/gobin instead of customly created gopath.proto dir - caches tools between executions - guaratees hermetics runs (it was not guaranteed for protoc_grpc_gateway that used latest) The change is no-op for the generated code. The commit reveals a few 'worring things': 1 We depend on : github.com/grpc-ecosystem/grpc-gateway/@v/v1.4.1/protoc-gen-grpc-gateway 2. And also : github.com/grpc-ecosystem/grpc-gateway/@v/v1.15.0/protoc-gen-swagger/protoc-gen-swagger 3. And on extremely old: github.com/gogo/protobuf@v1.0.0 protoc-gen-gofast that is out of sync with the library linked to binaries: github.com/gogo/protobuf@v1.2.1
138 lines
5.8 KiB
Bash
Executable File
138 lines
5.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Generate all etcd protobuf bindings.
|
|
# Run from repository root.
|
|
#
|
|
set -e
|
|
|
|
if ! [[ "$0" =~ scripts/genproto.sh ]]; then
|
|
echo "must be run from repository root"
|
|
exit 255
|
|
fi
|
|
|
|
source ./scripts/test_lib.sh
|
|
|
|
if [[ $(protoc --version | cut -f2 -d' ') != "3.12.3" ]]; then
|
|
echo "could not find protoc 3.12.3, is it installed + in PATH?"
|
|
exit 255
|
|
fi
|
|
|
|
export GOMOD="./tools/mod"
|
|
|
|
run env GO111MODULE=off go get -u github.com/myitcv/gobin
|
|
|
|
GOFAST_BIN=$(tool_get_bin github.com/gogo/protobuf/protoc-gen-gofast)
|
|
GRPC_GATEWAY_BIN=$(tool_get_bin github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway)
|
|
SWAGGER_BIN=$(tool_get_bin github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger@v1.15.0)
|
|
GOGOPROTO_ROOT="$(tool_pkg_dir github.com/gogo/protobuf/proto)/.."
|
|
GRPC_GATEWAY_ROOT="$(tool_pkg_dir github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway)/.."
|
|
|
|
echo
|
|
echo "Resolved binary and packages versions:"
|
|
echo " - protoc-gen-gofast: ${GOFAST_BIN}"
|
|
echo " - protoc-gen-grpc-gateway: ${GRPC_GATEWAY_BIN}"
|
|
echo " - swagger: ${SWAGGER_BIN}"
|
|
echo " - gogoproto-root: ${GOGOPROTO_ROOT}"
|
|
echo " - grpc-gateway-root: ${GRPC_GATEWAY_ROOT}"
|
|
|
|
# directories containing protos to be built
|
|
DIRS="./wal/walpb ./api/etcdserverpb ./etcdserver/api/snap/snappb ./raft/raftpb ./api/mvccpb ./lease/leasepb ./api/authpb ./etcdserver/api/v3lock/v3lockpb ./etcdserver/api/v3election/v3electionpb ./api/membershippb"
|
|
|
|
GOGOPROTO_PATH="${GOGOPROTO_ROOT}:${GOGOPROTO_ROOT}/protobuf"
|
|
|
|
log_callout -e "\nRunning gofast proto generation..."
|
|
|
|
for dir in ${DIRS}; do
|
|
run pushd "${dir}"
|
|
run protoc --gofast_out=plugins=grpc,import_prefix=go.etcd.io/:. -I=".:${GOGOPROTO_PATH}:${ETCD_ROOT_DIR}/..:${GRPC_GATEWAY_ROOT}/third_party/googleapis" \
|
|
--plugin="${GOFAST_BIN}" ./*.proto
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E 's/go\.etcd\.io\/(gogoproto|github\.com|golang\.org|google\.golang\.org)/\1/g' ./*.pb.go
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E 's/go\.etcd\.io\/(errors|fmt|io)/\1/g' ./*.pb.go
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E 's/import _ \"gogoproto\"//g' ./*.pb.go
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E 's/import fmt \"fmt\"//g' ./*.pb.go
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E 's/import _ \"go\.etcd\.io\/google\/api\"//g' ./*.pb.go
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E 's/import _ \"google\.golang\.org\/genproto\/googleapis\/api\/annotations\"//g' ./*.pb.go
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E "s|go.etcd.io/etcd|go.etcd.io/etcd/v3|g" ./*.pb.go
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E "s|go.etcd.io/etcd/v3/api|go.etcd.io/etcd/api/v3|g" ./*.pb.go
|
|
rm -f ./*.bak
|
|
run gofmt -s -w ./*.pb.go
|
|
run goimports -w ./*.pb.go
|
|
run popd
|
|
done
|
|
|
|
log_callout -e "\nRunning swagger & grpc_gateway proto generation..."
|
|
|
|
# remove old swagger files so it's obvious whether the files fail to generate
|
|
rm -rf Documentation/dev-guide/apispec/swagger/*json
|
|
for pb in api/etcdserverpb/rpc etcdserver/api/v3lock/v3lockpb/v3lock etcdserver/api/v3election/v3electionpb/v3election; do
|
|
protobase="${pb}"
|
|
run protoc -I. \
|
|
-I"${GRPC_GATEWAY_ROOT}"/third_party/googleapis \
|
|
-I"${GOGOPROTO_PATH}" \
|
|
-I"${ETCD_ROOT_DIR}/.." \
|
|
--grpc-gateway_out=logtostderr=true:. \
|
|
--swagger_out=logtostderr=true:./Documentation/dev-guide/apispec/swagger/. \
|
|
--plugin="${SWAGGER_BIN}" --plugin="${GRPC_GATEWAY_BIN}" \
|
|
${protobase}.proto
|
|
# hack to move gw files around so client won't include them
|
|
pkgpath=$(dirname "${protobase}")
|
|
pkg=$(basename "${pkgpath}")
|
|
gwfile="${protobase}.pb.gw.go"
|
|
|
|
sed -i.bak -E "s/package $pkg/package gw/g" ${gwfile}
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E "s/protoReq /&$pkg\./g" ${gwfile}
|
|
sed -i.bak -E "s/, client /, client $pkg./g" ${gwfile}
|
|
sed -i.bak -E "s/Client /, client $pkg./g" ${gwfile}
|
|
sed -i.bak -E "s/[^(]*Client, runtime/${pkg}.&/" ${gwfile}
|
|
sed -i.bak -E "s/New[A-Za-z]*Client/${pkg}.&/" ${gwfile}
|
|
# darwin doesn't like newlines in sed...
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E "s|import \(|& \"go.etcd.io/etcd/${pkgpath}\"|" ${gwfile}
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E "s|go.etcd.io/etcd|go.etcd.io/etcd/v3|g" ${gwfile}
|
|
# shellcheck disable=SC1117
|
|
sed -i.bak -E "s|go.etcd.io/etcd/v3/api|go.etcd.io/etcd/api/v3|g" ${gwfile}
|
|
mkdir -p "${pkgpath}"/gw/
|
|
run go fmt ${gwfile}
|
|
mv ${gwfile} "${pkgpath}/gw/"
|
|
rm -f ./${protobase}*.bak
|
|
swaggerName=$(basename ${protobase})
|
|
run mv Documentation/dev-guide/apispec/swagger/${protobase}.swagger.json \
|
|
Documentation/dev-guide/apispec/swagger/"${swaggerName}".swagger.json
|
|
done
|
|
|
|
log_callout -e "\nRunning swagger ..."
|
|
run_go_tool github.com/hexfusion/schwag -input=Documentation/dev-guide/apispec/swagger/rpc.swagger.json
|
|
|
|
if [ "$1" != "--skip-protodoc" ]; then
|
|
log_callout "protodoc is auto-generating grpc API reference documentation..."
|
|
|
|
run rm -rf Documentation/dev-guide/api_reference_v3.md
|
|
run_go_tool go.etcd.io/protodoc --directories="api/etcdserverpb=service_message,api/mvccpb=service_message,lease/leasepb=service_message,api/authpb=service_message" \
|
|
--title="etcd API Reference" \
|
|
--output="Documentation/dev-guide/api_reference_v3.md" \
|
|
--message-only-from-this-file="api/etcdserverpb/rpc.proto" \
|
|
--disclaimer="This is a generated documentation. Please read the proto files for more." || exit 2
|
|
|
|
run rm -rf Documentation/dev-guide/api_concurrency_reference_v3.md
|
|
run_go_tool go.etcd.io/protodoc --directories="etcdserver/api/v3lock/v3lockpb=service_message,etcdserver/api/v3election/v3electionpb=service_message,api/mvccpb=service_message" \
|
|
--title="etcd concurrency API Reference" \
|
|
--output="Documentation/dev-guide/api_concurrency_reference_v3.md" \
|
|
--disclaimer="This is a generated documentation. Please read the proto files for more." || exit 2
|
|
|
|
log_success "protodoc is finished."
|
|
else
|
|
log_warning "skipping grpc API reference document auto-generation..."
|
|
fi
|
|
|
|
log_success -e "\n./genproto SUCCESS"
|