Merge pull request #15358 from LabNConsulting/chopps/doc-update

update doc with new more strict protobuf requirements
FRRouting · Feb 12, 2024 · 24ca4f4 · 24ca4f4
2 parents d71710a + 8d6e7a3
commit 24ca4f4
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
@@ -10,7 +10,10 @@ Installation and Setup
 
 Topotests run under python3.
 
-Tested with Ubuntu 20.04,Ubuntu 18.04, and Debian 11.
+Tested with Ubuntu 22.04,Ubuntu 20.04, and Debian 12.
+
+Python protobuf version < 4 is required b/c python protobuf >= 4 requires a
+protoc >= 3.19, and older package versions are shipped by in the above distros.
 
 Instructions are the same for all setups. However, ExaBGP is only used for
 BGP tests.
@@ -33,16 +36,16 @@ Installing Topotest Requirements
        tshark \
        valgrind
    python3 -m pip install wheel
-   python3 -m pip install protobuf
-   python3 -m pip install 'pytest>=6.2.4'
-   python3 -m pip install 'pytest-xdist>=2.3.0'
+   python3 -m pip install 'protobuf<4'
+   python3 -m pip install 'pytest>=6.2.4' 'pytest-xdist>=2.3.0'
    python3 -m pip install 'scapy>=2.4.5'
    python3 -m pip install xmltodict
    python3 -m pip install git+https://github.com/Exa-Networks/exabgp@0659057837cd6c6351579e9f0fa47e9fb7de7311
    useradd -d /var/run/exabgp/ -s /bin/false exabgp
 
    # To enable the gRPC topotest install:
-   python3 -m pip install grpcio grpcio-tools
+   # It's important to include 'protobuf<4' here to avoid incompatible grpcio-tools versions.
+   python3 -m pip install 'protobuf<4' grpcio grpcio-tools
 
 
 Enable Coredumps

diff --git a/docker/ubuntu-ci/Dockerfile b/docker/ubuntu-ci/Dockerfile
@@ -74,12 +74,10 @@ RUN apt update && apt upgrade -y && \
     wget https://raw.githubusercontent.com/FRRouting/frr-mibs/main/ietf/SNMPv2-PDU -O /usr/share/snmp/mibs/ietf/SNMPv2-PDU && \
     wget https://raw.githubusercontent.com/FRRouting/frr-mibs/main/ietf/IPATM-IPMC-MIB -O /usr/share/snmp/mibs/ietf/IPATM-IPMC-MIB && \
     python3 -m pip install wheel && \
-    python3 -m pip install pytest && \
-    python3 -m pip install pytest-sugar && \
-    python3 -m pip install pytest-xdist && \
-    python3 -m pip install "scapy>=2.4.2" && \
+    python3 -m pip install 'protobuf<4' grpcio grpcio-tools && \
+    python3 -m pip install 'pytest>=6.2.4' 'pytest-xdist>=2.3.0' && \
+    python3 -m pip install 'scapy>=2.4.5' && \
     python3 -m pip install xmltodict && \
-    python3 -m pip install grpcio grpcio-tools && \
     python3 -m pip install git+https://github.com/Exa-Networks/exabgp@0659057837cd6c6351579e9f0fa47e9fb7de7311
 
 RUN groupadd -r -g 92 frr && \

diff --git a/tests/lib/subdir.am b/tests/lib/subdir.am
@@ -25,7 +25,7 @@ copy_script: tests/lib/script1.lua
 	$(INSTALL_SCRIPT) $< tests/lib/script1.lua
 
 ##############################################################################
-GRPC_TESTS_LDADD = staticd/libstatic.a grpc/libfrrgrpc_pb.la -lgrpc++ -lprotobuf $(ALL_TESTS_LDADD) $(LIBYANG_LIBS) -lm
+GRPC_TESTS_LDADD = mgmtd/libmgmt_be_nb.la staticd/libstatic.a grpc/libfrrgrpc_pb.la -lgrpc++ -lprotobuf $(ALL_TESTS_LDADD) $(LIBYANG_LIBS) -lm
 
 if GRPC
 check_PROGRAMS += tests/lib/test_grpc