#!/usr/bin/env bash # # Generate all etcd protobuf bindings. # Run from repository root directory named etcd. # set -e shopt -s globstar 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.14.0" ]]; then echo "could not find protoc 3.14.0, is it installed + in PATH?" exit 255 fi 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) 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}" GOGOPROTO_PATH="${GOGOPROTO_ROOT}:${GOGOPROTO_ROOT}/protobuf" # directories containing protos to be built DIRS="./server/storage/wal/walpb ./api/etcdserverpb ./server/etcdserver/api/snap/snappb ./raft/raftpb ./api/mvccpb ./server/lease/leasepb ./api/authpb ./server/etcdserver/api/v3lock/v3lockpb ./server/etcdserver/api/v3election/v3electionpb ./api/membershippb ./tests/functional ./api/versionpb" log_callout -e "\\nRunning gofast (gogo) proto generation..." for dir in ${DIRS}; do run pushd "${dir}" run protoc --gofast_out=plugins=grpc:. -I=".:${GOGOPROTO_PATH}:${ETCD_ROOT_DIR}/..:${ETCD_ROOT_DIR}:${GRPC_GATEWAY_ROOT}/third_party/googleapis" \ --plugin="${GOFAST_BIN}" ./**/*.proto run sed -i.bak -E 's|"etcd/api/|"go.etcd.io/etcd/api/v3/|g' ./**/*.pb.go run sed -i.bak -E 's|"raft/raftpb"|"go.etcd.io/etcd/raft/v3/raftpb"|g' ./**/*.pb.go run sed -i.bak -E 's|"google/protobuf"|"github.com/gogo/protobuf/protoc-gen-gogo/descriptor"|g' ./**/*.pb.go rm -f ./**/*.bak run gofmt -s -w ./**/*.pb.go run_go_tool "golang.org/x/tools/cmd/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 server/etcdserver/api/v3lock/v3lockpb/v3lock server/etcdserver/api/v3election/v3electionpb/v3election; do log_callout "grpc & swagger for: ${pb}.proto" run protoc -I. \ -I"${GRPC_GATEWAY_ROOT}"/third_party/googleapis \ -I"${GOGOPROTO_PATH}" \ -I"${ETCD_ROOT_DIR}/.." \ --grpc-gateway_out=logtostderr=true,paths=source_relative:. \ --swagger_out=logtostderr=true:./Documentation/dev-guide/apispec/swagger/. \ --plugin="${SWAGGER_BIN}" --plugin="${GRPC_GATEWAY_BIN}" \ ${pb}.proto # hack to move gw files around so client won't include them pkgpath=$(dirname "${pb}") pkg=$(basename "${pkgpath}") gwfile="${pb}.pb.gw.go" run sed -i -E "s#package $pkg#package gw#g" "${gwfile}" run sed -i -E "s#import \\(#import \\(\"go.etcd.io/etcd/${pkgpath}\"#g" "${gwfile}" run sed -i -E "s#([ (])([a-zA-Z0-9_]*(Client|Server|Request)([^(]|$))#\\1${pkg}.\\2#g" "${gwfile}" run sed -i -E "s# (New[a-zA-Z0-9_]*Client\\()# ${pkg}.\\1#g" "${gwfile}" run sed -i -E "s|go.etcd.io/etcd|go.etcd.io/etcd/v3|g" "${gwfile}" run sed -i -E "s|go.etcd.io/etcd/v3/api|go.etcd.io/etcd/api/v3|g" "${gwfile}" run sed -i -E "s|go.etcd.io/etcd/v3/server|go.etcd.io/etcd/server/v3|g" "${gwfile}" run go fmt "${gwfile}" gwdir="${pkgpath}/gw/" run mkdir -p "${gwdir}" run mv "${gwfile}" "${gwdir}" swaggerName=$(basename ${pb}) run mv Documentation/dev-guide/apispec/swagger/${pb}.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..." # API reference API_REFERENCE_FILE="Documentation/dev-guide/api_reference_v3.md" run rm -rf ${API_REFERENCE_FILE} run_go_tool go.etcd.io/protodoc --directories="api/etcdserverpb=service_message,api/mvccpb=service_message,server/lease/leasepb=service_message,api/authpb=service_message" \ --output="${API_REFERENCE_FILE}" \ --message-only-from-this-file="api/etcdserverpb/rpc.proto" \ --disclaimer="--- title: API reference --- This API reference is autogenerated from the named \`.proto\` files." || exit 2 # remove the first 3 lines of the doc as an empty --title adds '### ' to the top of the file. run sed -i -e 1,3d ${API_REFERENCE_FILE} # API reference: concurrency API_REFERENCE_CONCURRENCY_FILE="Documentation/dev-guide/api_concurrency_reference_v3.md" run rm -rf ${API_REFERENCE_CONCURRENCY_FILE} run_go_tool go.etcd.io/protodoc --directories="server/etcdserver/api/v3lock/v3lockpb=service_message,server/etcdserver/api/v3election/v3electionpb=service_message,api/mvccpb=service_message" \ --output="${API_REFERENCE_CONCURRENCY_FILE}" \ --disclaimer="--- title: \"API reference: concurrency\" --- This API reference is autogenerated from the named \`.proto\` files." || exit 2 # remove the first 3 lines of the doc as an empty --title adds '### ' to the top of the file. run sed -i -e 1,3d ${API_REFERENCE_CONCURRENCY_FILE} log_success "protodoc is finished." log_warning -e "\\nThe API references have NOT been automatically published on the website." log_success -e "\\nTo publish the API references, copy the following files" log_success " - ${API_REFERENCE_FILE}" log_success " - ${API_REFERENCE_CONCURRENCY_FILE}" log_success "to the etcd-io/website repo under the /content/en/docs/next/dev-guide/ folder." log_success "(https://github.com/etcd-io/website/tree/main/content/en/docs/next/dev-guide)" else log_warning "skipping grpc API reference document auto-generation..." fi log_success -e "\\n./genproto SUCCESS"