build: make python generation from protobuf automatic through tox

Author: pthierry-ledger

genproto.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -e
+
+sed -i -e '/gogoproto/d' src/etcd3/proto/rpc.proto
+sed -i -e 's/etcd\/mvcc\/mvccpb\/kv.proto/kv.proto/g' src/etcd3/proto/rpc.proto
+sed -i -e 's/etcd\/auth\/authpb\/auth.proto/auth.proto/g' src/etcd3/proto/rpc.proto
+sed -i -e '/google\/api\/annotations.proto/d' src/etcd3/proto/rpc.proto
+sed -i -e '/option (google.api.http)/,+3d' src/etcd3/proto/rpc.proto
+python -m grpc.tools.protoc -Isrc/etcd3/proto \
+    --python_out=src/etcd3/etcdrpc/ \
+    --grpc_python_out=src/etcd3/etcdrpc/ \
+    src/etcd3/proto/rpc.proto src/etcd3/proto/auth.proto src/etcd3/proto/kv.proto
+sed -i -e 's/import auth_pb2/from etcd3.etcdrpc import auth_pb2/g' src/etcd3/etcdrpc/rpc_pb2.py
+sed -i -e 's/import kv_pb2/from etcd3.etcdrpc import kv_pb2/g' src/etcd3/etcdrpc/rpc_pb2.py
+sed -i -e 's/import rpc_pb2/from etcd3.etcdrpc import rpc_pb2/g' src/etcd3/etcdrpc/rpc_pb2_grpc.py

tox.ini

@@ -10,22 +10,30 @@ isolated_build = true
 basepython = python3
 
 [testenv:build]
+description = generate proto and build pacakge
 deps =
     build
     twine
+extras = protoc
+allowlist_externals =
+    {toxinidir}/genproto.sh
 commands =
+    {toxinidir}/genproto.sh
     python -m build
     twine check dist/*
 
 [testenv:unittests]
+description = generate proto and run package unit tests
 extras = tests
 #passenv = ETCD_ENDPOINT,TEST_ETCD_VERSION
 allowlist_externals =
     wget
     tar
     gzip
     cp
+    {toxinidir}/genproto.sh
 commands_pre =
+    {toxinidir}/genproto.sh
     wget https://github.com/etcd-io/etcd/releases/download/v3.3.10/etcd-v3.3.10-linux-amd64.tar.gz -O {env_tmp_dir}/etcd.tar.gz
     tar xzvf {env_tmp_dir}/etcd.tar.gz -C {env_tmp_dir}
     cp {env_tmp_dir}/etcd-v3.3.10-linux-amd64/etcd {envdir}/bin
@@ -39,23 +47,13 @@ commands =
 commands=flake8 {posargs}
 
 [testenv:genproto]
+description = generate proto only
 whitelist_externals = sed
 extras = protoc
 allowlist_externals =
-    sed
+    {toxinidir}/genproto.sh
 commands =
-    sed -i -e '/gogoproto/d' etcd3/proto/rpc.proto
-    sed -i -e 's/etcd\/mvcc\/mvccpb\/kv.proto/kv.proto/g' etcd3/proto/rpc.proto
-    sed -i -e 's/etcd\/auth\/authpb\/auth.proto/auth.proto/g' etcd3/proto/rpc.proto
-    sed -i -e '/google\/api\/annotations.proto/d' etcd3/proto/rpc.proto
-    sed -i -e '/option (google.api.http)/,+3d' etcd3/proto/rpc.proto
-    python -m grpc.tools.protoc -Ietcd3/proto \
-        --python_out=etcd3/etcdrpc/ \
-        --grpc_python_out=etcd3/etcdrpc/ \
-        etcd3/proto/rpc.proto etcd3/proto/auth.proto etcd3/proto/kv.proto
-    sed -i -e 's/import auth_pb2/from etcd3.etcdrpc import auth_pb2/g' etcd3/etcdrpc/rpc_pb2.py
-    sed -i -e 's/import kv_pb2/from etcd3.etcdrpc import kv_pb2/g' etcd3/etcdrpc/rpc_pb2.py
-    sed -i -e 's/import rpc_pb2/from etcd3.etcdrpc import rpc_pb2/g' etcd3/etcdrpc/rpc_pb2_grpc.py
+    {toxinidir}/genproto.sh
 
 [flake8]
 exclude =  .venv,.git,.tox,dist,docs,*lib/python*,*egg,build,etcd3/etcdrpc/