Parameterize gNMI CONFIG DB tests with different VRF binding scenarios

Author: spandan-nexthop

docs/testplan/Container-Upgrade-test-plan.md

@@ -112,9 +112,9 @@ We will have a source testcase file container_upgrade/testcases.json that will h
     snmp/test_snmp_loopback.py
     gnmi/test_gnmi.py
     gnmi/test_gnmi_appIdb.py
-    gnmi/test_gnmi_configdb.py
     gnmi/test_gnmi_countersdb.py
     gnmi/test_gnoi_killprocess.py
+    gnmi/vrf_aware_tests/test_gnmi_configdb.py
 ]
 ```
 

tests/common/helpers/gnmi_utils.py

@@ -181,7 +181,7 @@ def create_revoked_cert_and_crl(localhost, ptfhost):
     localhost.shell(local_command)
 
 
-def create_gnmi_certs(duthost, localhost, ptfhost):
+def create_gnmi_certs(duthost, localhost, ptfhost, dut_ip=None):
     '''
     Create GNMI client certificates
     '''
@@ -214,7 +214,7 @@ def create_gnmi_certs(duthost, localhost, ptfhost):
     localhost.shell(local_command)
 
     # Sign server certificate
-    create_ext_conf(duthost.mgmt_ip, "extfile.cnf")
+    create_ext_conf(dut_ip or duthost.mgmt_ip, "extfile.cnf")
     local_command = "openssl x509 \
                         -req \
                         -in gnmiserver.csr \

tests/common/plugins/conditional_mark/tests_mark_conditions.yaml

@@ -2194,34 +2194,34 @@ gnmi:
     conditions:
       - "release in ['202412']"
 
-gnmi/test_gnmi_configdb.py:
+gnmi/test_gnoi_killprocess.py:
   skip:
-    reason: "This feature is not supported for multi asic. Skipping these test for T2 and multi asic."
+    reason: "Test noisy due to restart issue not relevant to GNOI. Disabling them to rewrite."
+
+gnmi/test_gnoi_system_reboot.py::test_gnoi_system_reboot_warm:
+  skip:
+    reason: "Warm reboot should only run on t0 topology but not on dualtor"
     conditions_logical_operator: or
     conditions:
-      - "'t2' in topo_name"
-      - "is_multi_asic==True"
+      - "topo_type not in ['t0']"
+      - "topo_name in ['dualtor', 'dualtor-56', 'dualtor-120', 'dualtor-aa', 'dualtor-aa-56', 'dualtor-aa-64-breakout']"
       - "release in ['202412']"
 
-gnmi/test_gnmi_configdb.py::test_gnmi_configdb_full_01:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py:
   skip:
-    reason: "The test refers to a stale implementation of GNOI.System.Reboot."
+    reason: "This feature is not supported for multi asic. Skipping these test for T2 and multi asic."
     conditions_logical_operator: or
     conditions:
-      - "https://github.com/sonic-net/sonic-mgmt/issues/17436"
+      - "'t2' in topo_name"
+      - "is_multi_asic==True"
       - "release in ['202412']"
 
-gnmi/test_gnoi_killprocess.py:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py::test_gnmi_configdb_full_01:
   skip:
-    reason: "Test noisy due to restart issue not relevant to GNOI. Disabling them to rewrite."
-
-gnmi/test_gnoi_system_reboot.py::test_gnoi_system_reboot_warm:
-  skip:
-    reason: "Warm reboot should only run on t0 topology but not on dualtor"
+    reason: "The test refers to a stale implementation of GNOI.System.Reboot."
     conditions_logical_operator: or
     conditions:
-      - "topo_type not in ['t0']"
-      - "topo_name in ['dualtor', 'dualtor-56', 'dualtor-120', 'dualtor-aa', 'dualtor-aa-56', 'dualtor-aa-64-breakout']"
+      - "https://github.com/sonic-net/sonic-mgmt/issues/17436"
       - "release in ['202412']"
 
 #######################################

tests/common/plugins/conditional_mark/tests_mark_conditions_sonic_vpp.yaml

@@ -551,87 +551,87 @@ gnmi/test_gnmi_appldb.py::test_gnmi_appldb_01:
 #######################################
 #####          GNMI               #####
 #######################################
-gnmi/test_gnmi_configdb.py::test_gnmi_configdb_full_01:
+gnmi/test_gnmi_countersdb.py::test_gnmi_counterdb_streaming_sample_01:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_configdb.py::test_gnmi_configdb_incremental_01:
+gnmi/test_gnmi_countersdb.py::test_gnmi_counterdb_streaming_sample_02:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_configdb.py::test_gnmi_configdb_incremental_02:
+gnmi/test_gnmi_countersdb.py::test_gnmi_output:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_configdb.py::test_gnmi_configdb_streaming_onchange_01:
+gnmi/test_gnmi_countersdb.py::test_gnmi_queue_buffer_cnt:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_configdb.py::test_gnmi_configdb_streaming_onchange_02:
+gnmi/test_gnoi_killprocess.py::test_gnoi_killprocess_then_restart:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_configdb.py::test_gnmi_configdb_streaming_sample_01:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py::test_gnmi_configdb_full_01:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_countersdb.py::test_gnmi_counterdb_streaming_sample_01:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py::test_gnmi_configdb_incremental_01:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_countersdb.py::test_gnmi_counterdb_streaming_sample_02:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py::test_gnmi_configdb_incremental_02:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_countersdb.py::test_gnmi_output:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py::test_gnmi_configdb_streaming_onchange_01:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnmi_countersdb.py::test_gnmi_queue_buffer_cnt:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py::test_gnmi_configdb_streaming_onchange_02:
   skip:
     reason: >
             Failed/Errored: To be included
     conditions_logical_operator: or
     conditions:
       - "asic_type in ['vpp']"
 
-gnmi/test_gnoi_killprocess.py::test_gnoi_killprocess_then_restart:
+gnmi/vrf_aware_tests/test_gnmi_configdb.py::test_gnmi_configdb_streaming_sample_01:
   skip:
     reason: >
             Failed/Errored: To be included

tests/common/plugins/conditional_mark/tests_mark_conditions_vs_t2.yaml

@@ -243,11 +243,6 @@ gnmi/test_gnmi_appldb.py:
     conditions:
     - asic_type in ['vs'] and 't2' in topo_name
     reason: This test case either cannot pass or should be skipped on virtual chassis
-gnmi/test_gnmi_configdb.py:
-  skip:
-    conditions:
-    - asic_type in ['vs'] and 't2' in topo_name
-    reason: This test case either cannot pass or should be skipped on virtual chassis
 gnmi/test_gnmi_countersdb.py:
   skip:
     conditions:
@@ -298,6 +293,11 @@ gnmi/test_mimic_hwproxy_cert_rotation.py:
     conditions:
     - asic_type in ['vs'] and 't2' in topo_name
     reason: This test case either cannot pass or should be skipped on virtual chassis
+gnmi/vrf_aware_tests/test_gnmi_configdb.py:
+  skip:
+    conditions:
+    - asic_type in ['vs'] and 't2' in topo_name
+    reason: This test case either cannot pass or should be skipped on virtual chassis
 golden_config_infra/test_config_reload_with_rendered_golden_config.py:
   skip:
     conditions:

tests/common/utilities.py

@@ -49,6 +49,8 @@
 # Wait 300 seconds because sometime 'interfaces-config' service take 45 seconds to response
 # interfaces-config service issue track by: https://github.com/sonic-net/sonic-buildimage/issues/19045
 FILE_CHANGE_TIMEOUT = 300
+DEFAULT_VRF_NAME = "default"
+MGMT_VRF_NAME = "mgmt"
 
 NON_USER_CONFIG_TABLES = ["FLEX_COUNTER_TABLE", "ASIC_SENSORS", "LOGGER"]
 

tests/container_upgrade/testcases.json

@@ -5,7 +5,7 @@
     "bmp/test_bmp_statedb.py": 0,
     "bmp/test_docker_restart.py": 0,
     "gnmi/test_gnmi.py": 0,
-    "gnmi/test_gnmi_configdb.py": 0,
+    "gnmi/vrf_aware_tests/test_gnmi_configdb.py": 0,
     "gnmi/test_gnmi_appldb.py": 0,
     "telemetry/test_telemetry.py::test_config_db_parameters": 0,
     "tacacs/test_accounting.py": 3

tests/gnmi/conftest.py

@@ -9,7 +9,8 @@
 
 from tests.common.helpers.assertions import pytest_require as pyrequire
 from tests.common.helpers.dut_utils import check_container_state
-from tests.gnmi.helper import gnmi_container, apply_cert_config, recover_cert_config
+from tests.common.helpers.gnmi_utils import gnmi_container
+from tests.gnmi.helper import apply_cert_config, recover_cert_config
 from tests.gnmi.helper import GNMI_SERVER_START_WAIT_TIME, check_ntp_sync_status
 from tests.common.gu_utils import create_checkpoint, rollback
 from tests.common.helpers.gnmi_utils import GNMIEnvironment, create_revoked_cert_and_crl, \
@@ -20,6 +21,24 @@
 logger = logging.getLogger(__name__)
 SETUP_ENV_CP = "test_setup_checkpoint"
 
+VRF_SCENARIOS = [
+    {"name": "default_1", "vrf": None, "description": "Default (no VRF)"},
+]
+
+
+@pytest.fixture(scope="module", params=VRF_SCENARIOS, ids=lambda scenario: f"vrf_{scenario['name']}")
+def vrf_config(request):
+    return request.param
+
+
+@pytest.fixture(scope="module", autouse=True)
+def setup_vrf_configuration(vrf_config):
+    """
+    This fixture runs before setup_gnmi_server to ensure VRF config is in place.
+    It gets overridden in vrf_aware_tests/conftest.py.
+    """
+    return vrf_config
+
 
 @pytest.fixture(scope="function", autouse=True)
 def skip_non_x86_platform(duthosts, rand_one_dut_hostname):
@@ -63,7 +82,7 @@ def setup_gnmi_ntp_client_server(duthosts, rand_one_dut_hostname, ptfhost):
 
 
 @pytest.fixture(scope="module", autouse=True)
-def setup_gnmi_server(duthosts, rand_one_dut_hostname, localhost, ptfhost):
+def setup_gnmi_server(duthosts, rand_one_dut_hostname, localhost, ptfhost, vrf_config, setup_vrf_configuration):
     '''
     Setup GNMI server with client certificates
     '''
@@ -74,10 +93,10 @@ def setup_gnmi_server(duthosts, rand_one_dut_hostname, localhost, ptfhost):
         check_container_state(duthost, gnmi_container(duthost), should_be_running=True),
         "Test was not supported on devices which do not support GNMI!")
 
-    create_gnmi_certs(duthost, localhost, ptfhost)
+    create_gnmi_certs(duthost, localhost, ptfhost, dut_ip=vrf_config.get("dut_ip"))
 
     create_checkpoint(duthost, SETUP_ENV_CP)
-    apply_cert_config(duthost)
+    apply_cert_config(duthost, vrf_config.get("vrf"))
 
     yield
 
@@ -92,7 +111,7 @@ def setup_gnmi_server(duthosts, rand_one_dut_hostname, localhost, ptfhost):
 
 
 @pytest.fixture(scope="module", autouse=True)
-def setup_gnmi_rotated_server(duthosts, rand_one_dut_hostname, localhost, ptfhost):
+def setup_gnmi_rotated_server(duthosts, rand_one_dut_hostname, localhost, ptfhost, vrf_config={}):
     '''
     Create GNMI client certificates
     '''
@@ -133,7 +152,8 @@ def setup_gnmi_rotated_server(duthosts, rand_one_dut_hostname, localhost, ptfhos
     localhost.shell(local_command)
 
     # Sign server certificate
-    create_ext_conf(duthost.mgmt_ip, "extfile.cnf")
+    dut_ip = vrf_config.get("dut_ip") or duthost.mgmt_ip
+    create_ext_conf(dut_ip, "extfile.cnf")
     local_command = "openssl x509 \
                         -req \
                         -in gnmiserver.csr \