tox.ini: add new environments for generating grpc related files

Add a new tox environment that is to be used for regenerated python
source files from .proto files. Currently, it is up to the contributor
to make sure these are up-to-date.

A second env is provided for use on centos/fedora with packaged versions
for grpc and protobuf in order to make sure the generated files match
what the planned deployment containers will support.

Signed-off-by: John Mulligan <[email protected]>

Author: phlogistonjohn

tox.ini

@@ -90,3 +90,47 @@ deps =
     gitlint==0.19.1
 commands =
     gitlint -C .gitlint --commits origin/master.. lint
+
+
+# IMPORTANT: note that there are two environments provided here for generating
+# the grpc/protobuf files. One uses a typical tox environment with versions
+# and the other uses system packages (sitepackages=True).
+# The former is what developers are expected to use HOWEVER because we must
+# deliver on enterprise linux platforms we provide a way to generate
+# the code using system packages for comparison purposes.
+
+# Generate grpc/protobuf code from .proto files.
+# Includes a generator for .pyi files.
+# Uses sed to fix the foolish import behavior of the grpc generator.
+[testenv:grpc-generate]
+description = Generate gRPC files
+deps =
+    grpcio-tools ~= 1.48.0
+    protobuf ~= 3.19.0
+    mypy-protobuf
+allowlist_externals = sed
+commands =
+    python -m grpc_tools.protoc \
+        -I sambacc/grpc/protobufs \
+        --python_out=sambacc/grpc/generated \
+        --grpc_python_out=sambacc/grpc/generated \
+        --mypy_out=sambacc/grpc/generated \
+        sambacc/grpc/protobufs/control.proto
+    sed -i -E 's/^import.*_pb2/from . \0/' \
+        sambacc/grpc/generated/control_pb2_grpc.py
+
+# Generate grpc/protobuf code from .proto files using system packages.
+# Does NOT include a generator for .pyi files.
+# Uses sed to fix the foolish import behavior of the grpc generator.
+[testenv:grpc-sys-generate]
+description = Generate gRPC files using system python packages
+sitepackages = True
+allowlist_externals = sed
+commands =
+    python -m grpc_tools.protoc \
+        -I sambacc/grpc/protobufs \
+        --python_out=sambacc/grpc/generated \
+        --grpc_python_out=sambacc/grpc/generated \
+        sambacc/grpc/protobufs/control.proto
+    sed -i -E 's/^import.*_pb2/from . \0/' \
+        sambacc/grpc/generated/control_pb2_grpc.py