mirror of
https://github.com/prometheus/prometheus
synced 2024-12-27 17:13:22 +00:00
c3434a39b7
Current way of setting prometheus project to generate repo is tedious. If you just go install packages described in README.md it ends up with those (non buildable code) ``` ../../../prompb/remote.pb.go:61:34: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:109:33: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:164:34: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:214:27: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:284:33: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ``` The issue is that the guide presented in proto folder is asking to install some GO packages. It does not mention from what version and there is strong mismatch between those used to generate proto and those that are vendored and used to run the code later... The particular outdated packages in vendor are: `github.com/gogo/protobuf` and `google.golang.org/grpc`. Just updating vendor would be not enough, as it would only tmp fix. I propose adding script that will parse version from vendor.json and install correct version. Changes: - Added script that uses packages in *exactly* the same version the Go code is build against later. - Regenerated proto with those pinned deps. - Updated REAMDE.md - Added `make proto`Current way of setting prometheus project to generate code from proto files is tedious. If you just go install packages described in README.md, it ends up with this (non buildable code) ``` ../../../prompb/remote.pb.go:61:34: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:109:33: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:164:34: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:214:27: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ../../../prompb/remote.pb.go:284:33: undefined: "github.com/prometheus/prometheus/vendor/github.com/gogo/protobuf/proto".InternalMessageInfo ``` The issue is that the guide presented in proto folder is asking to install some GO packages. It does not mention from what version and there is strong mismatch between those used to generate proto and those that are vendored and used to run the code later... The particular outdated packages in vendor are: `github.com/gogo/protobuf` and `google.golang.org/grpc`. Just updating vendor would be not enough, as it would only tmp fix. I propose adding script that will parse version from vendor.json and install correct version. Changes: - Added script that uses packages in *exactly* the same version the Go code is build against later. - Regenerated proto with those pinned deps. - Updated REAMDE.md - Added `make proto` Signed-off-by: Bartek Plotka <bwplotka@gmail.com>
70 lines
2.3 KiB
Bash
Executable File
70 lines
2.3 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Generate all protobuf bindings.
|
|
# Run from repository root.
|
|
set -e
|
|
set -u
|
|
|
|
if ! [[ "$0" =~ "scripts/genproto.sh" ]]; then
|
|
echo "must be run from repository root"
|
|
exit 255
|
|
fi
|
|
|
|
if ! [[ $(protoc --version) =~ "3.5.1" ]]; then
|
|
echo "could not find protoc 3.5.1, is it installed + in PATH?"
|
|
exit 255
|
|
fi
|
|
|
|
# Exact version of plugins to build.
|
|
PROTOC_GEN_GOGOFAST_SHA="971cbfd2e72b513a28c74af7462aee0800248d69"
|
|
PROTOC_GEN_GRPC_ECOSYSTEM_SHA="e4b8a938efae14de11fd97311e873e989896348c"
|
|
|
|
echo "installing plugins"
|
|
go install "golang.org/x/tools/cmd/goimports"
|
|
go get -d -u "github.com/gogo/protobuf/protoc-gen-gogo"
|
|
pushd ${GOPATH}/src/github.com/gogo/protobuf
|
|
git reset --hard "${PROTOC_GEN_GOGOFAST_SHA}"
|
|
go install "github.com/gogo/protobuf/protoc-gen-gogofast"
|
|
popd
|
|
|
|
go get -d -u "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway"
|
|
go get -d -u "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger"
|
|
pushd ${GOPATH}/src/github.com/grpc-ecosystem/grpc-gateway
|
|
git reset --hard "${PROTOC_GEN_GRPC_ECOSYSTEM_SHA}"
|
|
go install "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway"
|
|
go install "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger"
|
|
popd
|
|
|
|
PROM_ROOT="${GOPATH}/src/github.com/prometheus/prometheus"
|
|
PROM_PATH="${PROM_ROOT}/prompb"
|
|
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"
|
|
|
|
DIRS="prompb"
|
|
|
|
for dir in ${DIRS}; do
|
|
pushd ${dir}
|
|
protoc --gogofast_out=plugins=grpc:. -I=. \
|
|
-I="${GOGOPROTO_PATH}" \
|
|
-I="${PROM_PATH}" \
|
|
-I="${GRPC_GATEWAY_ROOT}/third_party/googleapis" \
|
|
*.proto
|
|
|
|
protoc -I. \
|
|
-I="${GOGOPROTO_PATH}" \
|
|
-I="${PROM_PATH}" \
|
|
-I="${GRPC_GATEWAY_ROOT}/third_party/googleapis" \
|
|
--grpc-gateway_out=logtostderr=true:. \
|
|
--swagger_out=logtostderr=true:../documentation/dev/api/ \
|
|
rpc.proto
|
|
mv ../documentation/dev/api/rpc.swagger.json ../documentation/dev/api/swagger.json
|
|
|
|
sed -i.bak -E 's/import _ \"github.com\/gogo\/protobuf\/gogoproto\"//g' *.pb.go
|
|
sed -i.bak -E 's/import _ \"google\/protobuf\"//g' *.pb.go
|
|
sed -i.bak -E 's/golang\/protobuf/gogo\/protobuf/g' *.go
|
|
rm -f *.bak
|
|
goimports -w *.pb.go
|
|
popd
|
|
done
|