[release-3.5] MacOS support for scripts/genproto.sh

[vivekpatani]

Bug report criteria

• This bug report is not security related, security issues should be disclosed privately via security@etcd.io.
• This is not a support request, support requests should be raised in the etcd discussion forums.
• You have read the etcd bug reporting guidelines.
• Existing open issues along with etcd frequently asked questions have been checked and this is not a duplicate.

What happened?

# first clone
git clone git@github.com:etcd-io/etcd.git

# enter directory
cd etcd

# switch to 3.5
git checkout release-3.5

# run genproto.sh from root, from a folder named etcd
./scripts/genproto.sh

#Error Trace
.
.
.
Running swagger & grpc_gateway proto generation...
grpc & swagger for: api/etcdserverpb/rpc.proto
% protoc -I. -I/Users/x/go/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v1.14.6/protoc-gen-grpc-gateway/../third_party/googleapis -I/Users/x/go/pkg/mod/github.com/gogo/protobuf@v1.3.2/proto/..:/Users/x/go/pkg/mod/github.com/gogo/protobuf@v1.3.2/proto/../protobuf -I/Users/x/junkyard/etcd/etcd/.. --grpc-gateway_out=logtostderr=true,paths=source_relative:. --swagger_out=logtostderr=true:./Documentation/dev-guide/apispec/swagger/. --plugin=/Users/x/go/bin/protoc-gen-swagger --plugin=/Users/x/go/bin/protoc-gen-grpc-gateway api/etcdserverpb/rpc.proto
% sed -i -E s#package etcdserverpb#package gw#g api/etcdserverpb/rpc.pb.gw.go
% sed -i -E s#import \(#import \("go.etcd.io/etcd/api/etcdserverpb"#g api/etcdserverpb/rpc.pb.gw.go
stderr: sed: 1: "s#import \(#import \("g ...": RE error: parentheses not balanced

What did you expect to happen?

Generate all the protos for etcd-3.5

How can we reproduce it (as minimally and precisely as possible)?

Stated above

Anything else we need to know?

No response

Etcd version (please run commands below)

$ etcd --version
3.5.9

$ etcdctl version
3.5.9

Etcd configuration (command line flags or environment variables)

paste your configuration here

Etcd debug information (please run commands below, feel free to obfuscate the IP address or FQDN in the output)

$ etcdctl member list -w table
# paste output here

$ etcdctl --endpoints=<member list> endpoint status -w table
# paste output here

Relevant log output

Running swagger & grpc_gateway proto generation...
grpc & swagger for: api/etcdserverpb/rpc.proto
% protoc -I. -I/Users/x/go/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v1.14.6/protoc-gen-grpc-gateway/../third_party/googleapis -I/Users/x/go/pkg/mod/github.com/gogo/protobuf@v1.3.2/proto/..:/Users/x/go/pkg/mod/github.com/gogo/protobuf@v1.3.2/proto/../protobuf -I/Users/x/junkyard/etcd/etcd/.. --grpc-gateway_out=logtostderr=true,paths=source_relative:. --swagger_out=logtostderr=true:./Documentation/dev-guide/apispec/swagger/. --plugin=/Users/x/go/bin/protoc-gen-swagger --plugin=/Users/x/go/bin/protoc-gen-grpc-gateway api/etcdserverpb/rpc.proto
% sed -i -E s#package etcdserverpb#package gw#g api/etcdserverpb/rpc.pb.gw.go
% sed -i -E s#import \(#import \("go.etcd.io/etcd/api/etcdserverpb"#g api/etcdserverpb/rpc.pb.gw.go
stderr: sed: 1: "s#import \(#import \("g ...": RE error: parentheses not balanced

[fuweid]

Did you run it in the linux ?

[chaochn47]

How about exit the script if OS is not linux with error message that "please run it on linux"?

I bet not just @vivekpatani met this problem.

[vivekpatani]

@fuweid it was a MacOS (Darwin) with Apple Silicon.

@chaochn47 thanks.

Okay, for anyone else runs into this, can try doing this until we have a proper workaround/error message:

• If root folder name is not etcd, then git clone -b v3.5.0 https://github.com/etcd-io/etcd.git
• Download the protoc 3.14.0 binary for darwin from here, and place it in $PATH
• Replace all sed commands in scripts/genproto.sh with gsed, revert before moving forward. gsed = GNU Sed which is the one most linux variants use.

If this sounds like a solution, can make the scritps/genproto.sh a little more generic so you can build on Mac Apple Silicon as well. Can create PR if there's interest. Thank you for the help folks.

[jmhbnz]

Thanks for sharing the workaround @vivekpatani. Just to make sure you're aware, as outlined in our CONTRIBUTING.md the only supported operating system for etcd development is linux currently.

However if you can do some cross platform testing between linux and darwin for this particular script and raise a pull request that sounds like a great step forward to removing friction for others in future. I'll certainly be happy to review it :)

[mjlshen]

I'm interested in working on this :D

[jmhbnz]

Assigned, thanks @mjlshen! 🎉

[wenjiaswe]

Thank you very much!