mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
998fa0de76
Was missing the new cancel_reason field. Also includes updated protodoc sha to fix generating documentation for upcoming txn compare range patchset.
133 lines
5.1 KiB
Bash
Executable File
133 lines
5.1 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
|
|
|
|
# for now, be conservative about what version of protoc we expect
|
|
if ! [[ $(protoc --version) =~ "3.2.0" ]]; then
|
|
echo "could not find protoc 3.2.0, is it installed + in PATH?"
|
|
exit 255
|
|
fi
|
|
|
|
# directories containing protos to be built
|
|
DIRS="./wal/walpb ./etcdserver/etcdserverpb ./snap/snappb ./raft/raftpb ./mvcc/mvccpb ./lease/leasepb ./auth/authpb ./etcdserver/api/v3lock/v3lockpb ./etcdserver/api/v3election/v3electionpb"
|
|
|
|
# exact version of protoc-gen-gogo to build
|
|
GOGO_PROTO_SHA="8d70fb3182befc465c4a1eac8ad4d38ff49778e2"
|
|
GRPC_GATEWAY_SHA="84398b94e188ee336f307779b57b3aa91af7063c"
|
|
|
|
# set up self-contained GOPATH for building
|
|
export GOPATH=${PWD}/gopath.proto
|
|
export GOBIN=${PWD}/bin
|
|
export PATH="${GOBIN}:${PATH}"
|
|
|
|
COREOS_ROOT="${GOPATH}/src/github.com/coreos"
|
|
ETCD_ROOT="${COREOS_ROOT}/etcd"
|
|
GOGOPROTO_ROOT="${GOPATH}/src/github.com/gogo/protobuf"
|
|
GOGOPROTO_PATH="${GOGOPROTO_ROOT}:${GOGOPROTO_ROOT}/protobuf"
|
|
GRPC_GATEWAY_ROOT="${GOPATH}/src/github.com/grpc-ecosystem/grpc-gateway"
|
|
|
|
rm -f "${ETCD_ROOT}"
|
|
mkdir -p "${COREOS_ROOT}"
|
|
ln -s "${PWD}" "${ETCD_ROOT}"
|
|
|
|
# Ensure we have the right version of protoc-gen-gogo by building it every time.
|
|
# TODO(jonboulle): vendor this instead of `go get`ting it.
|
|
go get -u github.com/gogo/protobuf/{proto,protoc-gen-gogo,gogoproto}
|
|
go get -u golang.org/x/tools/cmd/goimports
|
|
pushd "${GOGOPROTO_ROOT}"
|
|
git reset --hard "${GOGO_PROTO_SHA}"
|
|
make install
|
|
popd
|
|
|
|
# generate gateway code
|
|
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
|
|
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
|
|
pushd "${GRPC_GATEWAY_ROOT}"
|
|
git reset --hard "${GRPC_GATEWAY_SHA}"
|
|
go install ./protoc-gen-grpc-gateway
|
|
popd
|
|
|
|
for dir in ${DIRS}; do
|
|
pushd ${dir}
|
|
protoc --gofast_out=plugins=grpc,import_prefix=github.com/coreos/:. -I=.:"${GOGOPROTO_PATH}":"${COREOS_ROOT}":"${GRPC_GATEWAY_ROOT}/third_party/googleapis" *.proto
|
|
sed -i.bak -E "s/github\.com\/coreos\/(gogoproto|github\.com|golang\.org|google\.golang\.org)/\1/g" *.pb.go
|
|
sed -i.bak -E 's/github\.com\/coreos\/(errors|fmt|io)/\1/g' *.pb.go
|
|
sed -i.bak -E 's/import _ \"gogoproto\"//g' *.pb.go
|
|
sed -i.bak -E 's/import fmt \"fmt\"//g' *.pb.go
|
|
sed -i.bak -E 's/import _ \"github\.com\/coreos\/google\/api\"//g' *.pb.go
|
|
rm -f *.bak
|
|
goimports -w *.pb.go
|
|
popd
|
|
done
|
|
|
|
for pb in etcdserverpb/rpc api/v3lock/v3lockpb/v3lock api/v3election/v3electionpb/v3election; do
|
|
protobase="etcdserver/${pb}"
|
|
protoc -I. \
|
|
-I${GRPC_GATEWAY_ROOT}/third_party/googleapis \
|
|
-I${GOGOPROTO_PATH} \
|
|
-I${COREOS_ROOT} \
|
|
--grpc-gateway_out=logtostderr=true:. \
|
|
--swagger_out=logtostderr=true:./Documentation/dev-guide/apispec/swagger/. \
|
|
${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}
|
|
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...
|
|
sed -i.bak -E "s|import \(|& \"github.com/coreos/etcd/${pkgpath}\"|" ${gwfile}
|
|
mkdir -p ${pkgpath}/gw/
|
|
go fmt ${gwfile}
|
|
mv ${gwfile} ${pkgpath}/gw/
|
|
rm -f ./etcdserver/${pb}*.bak
|
|
mv Documentation/dev-guide/apispec/swagger/etcdserver/${pb}.swagger.json \
|
|
Documentation/dev-guide/apispec/swagger/${name}.swagger.json
|
|
done
|
|
rm -rf Documentation/dev-guide/apispec/swagger/etcdserver/
|
|
|
|
# install protodoc
|
|
# go get -v -u github.com/coreos/protodoc
|
|
#
|
|
# by default, do not run this option.
|
|
# only run when './scripts/genproto.sh -g'
|
|
#
|
|
if [ "$1" = "-g" ]; then
|
|
echo "protodoc is auto-generating grpc API reference documentation..."
|
|
go get -v -u github.com/coreos/protodoc
|
|
SHA_PROTODOC="4372ee725035a208404e2d5465ba921469decc32"
|
|
PROTODOC_PATH="${GOPATH}/src/github.com/coreos/protodoc"
|
|
pushd "${PROTODOC_PATH}"
|
|
git reset --hard "${SHA_PROTODOC}"
|
|
go install
|
|
echo "protodoc is updated"
|
|
popd
|
|
|
|
protodoc --directories="etcdserver/etcdserverpb=service_message,mvcc/mvccpb=service_message,lease/leasepb=service_message,auth/authpb=service_message" \
|
|
--title="etcd API Reference" \
|
|
--output="Documentation/dev-guide/api_reference_v3.md" \
|
|
--message-only-from-this-file="etcdserver/etcdserverpb/rpc.proto" \
|
|
--disclaimer="This is a generated documentation. Please read the proto files for more."
|
|
|
|
protodoc --directories="etcdserver/api/v3lock/v3lockpb=service_message,etcdserver/api/v3election/v3electionpb=service_message,mvcc/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."
|
|
|
|
echo "protodoc is finished..."
|
|
else
|
|
echo "skipping grpc API reference document auto-generation..."
|
|
fi
|