sonic-net · Pterosaur · Sep 27, 2023 · Aug 2, 2023 · Aug 19, 2023 · Aug 19, 2023
diff --git a/tests/dash/conftest.py b/tests/dash/conftest.py
@@ -7,9 +7,13 @@
     REMOTE_PA_IP, REMOTE_PTF_INTF, REMOTE_PTF_MAC, REMOTE_PA_PREFIX, VNET1_NAME, VNET2_NAME, ROUTING_ACTION, \
     ROUTING_ACTION_TYPE, LOOKUP_OVERLAY_IP
 from dash_utils import render_template_to_host, apply_swssconfig_file
+from gnmi_utils import generate_gnmi_cert, apply_gnmi_cert, recover_gnmi_cert, apply_gnmi_file
 
 logger = logging.getLogger(__name__)
 
+ENABLE_GNMI_API = True
+# ENABLE_GNMI_API = FalseE
+
 
 def pytest_addoption(parser):
     """
@@ -126,7 +130,7 @@ def dash_config_info(duthost, config_facts, minigraph_facts):
 
 
 @pytest.fixture(scope="function")
-def apply_config(duthost, skip_config, skip_cleanup):
+def apply_config(duthost, localhost, skip_config, skip_cleanup):
     configs = []
     op = "SET"
 
@@ -140,7 +144,10 @@ def _apply_config(config_info):
         template_name = "{}.j2".format(config)
         dest_path = "/tmp/{}.json".format(config)
         render_template_to_host(template_name, duthost, dest_path, config_info, op=op)
-        apply_swssconfig_file(duthost, dest_path)
+        if ENABLE_GNMI_API is True:
+            apply_gnmi_file(duthost, localhost, dest_path)
+        else:
+            apply_swssconfig_file(duthost, dest_path)
 
     yield _apply_config
 
@@ -202,3 +209,17 @@ def apply_direct_configs(dash_outbound_configs, apply_config):
     del dash_outbound_configs[VNET2_NAME]
 
     apply_config(dash_outbound_configs)
+
+
+@pytest.fixture(scope="module", autouse=True)
+def setup_gnmi_server(duthosts, rand_one_dut_hostname, localhost):
+    if ENABLE_GNMI_API is False:
+        yield
+        return
+
+    duthost = duthosts[rand_one_dut_hostname]
+    duthost.shell("docker exec gnmi rm /usr/local/yang-models/sonic-dash.yang", module_ignore_errors=True)
+    generate_gnmi_cert(localhost, duthost)
+    apply_gnmi_cert(duthost)
+    yield
+    recover_gnmi_cert(duthost)
diff --git a/tests/dash/gnmi_utils.py b/tests/dash/gnmi_utils.py
@@ -0,0 +1,322 @@
+import logging
+import json
+import time
+import re
+import ipaddress
+import pytest
+import socket
+import uuid
+
+from dash_api.appliance_pb2 import *
+from dash_api.vnet_pb2 import *
+from dash_api.eni_pb2 import *
+from dash_api.qos_pb2 import *
+from dash_api.route_pb2 import *
+from dash_api.route_rule_pb2 import *
+from dash_api.vnet_mapping_pb2 import *
+from dash_api.route_type_pb2 import *
+from dash_api.types_pb2 import *
+
+logger = logging.getLogger(__name__)
+
+GNMI_PORT = 0
+# Wait 15 seconds after starting GNMI server
+GNMI_SERVER_START_WAIT_TIME = 30
+GNMI_CONTAINER = "gnmi"
+GNMI_PROGRAM = "gnmi-native"
+GNMI_CA_CERT = "gnmiCA.pem"
+GNMI_CA_KEY = "gnmiCA.key"
+GNMI_SERVER_CERT = "gnmiserver.crt"
+GNMI_SERVER_KEY = "gnmiserver.key"
+GNMI_CLIENT_CERT = "gnmiclient.crt"
+GNMI_CLIENT_KEY = "gnmiclient.key"
+
+
+# ENABLE_PROTO = False
+ENABLE_PROTO = True
+
+
+def gnmi_port(duthost):
+    global GNMI_PORT
+    if GNMI_PORT == 0:
+        GNMI_CONFIG_KEY = 'GNMI|gnmi'
+        port = duthost.shell("sonic-db-cli CONFIG_DB hget '%s' 'port'" % GNMI_CONFIG_KEY)['stdout']
+        GNMI_PORT = int(port)
+    return GNMI_PORT
+
+
+def create_ext_conf(ip, filename):
+    text = '''
+[ req_ext ]
+subjectAltName = @alt_names
+[alt_names]
+DNS.1   = hostname.com
+IP      = %s
+''' % ip
+    with open(filename, 'w') as file:
+        file.write(text)
+    return
+
+
+def generate_gnmi_cert(localhost, duthost):
+    # Create Root key
+    local_command = "openssl genrsa -out %s 2048" % (GNMI_CA_KEY)
+    localhost.shell(local_command)
+
+    # Create Root cert
+    local_command = "openssl req \
+                        -x509 \
+                        -new \
+                        -nodes \
+                        -key %s \
+                        -sha256 \
+                        -days 1825 \
+                        -subj '/CN=test.gnmi.sonic' \
+                        -out %s" % (GNMI_CA_KEY, GNMI_CA_CERT)
+    localhost.shell(local_command)
+
+    # Create server key
+    local_command = "openssl genrsa -out %s 2048" % (GNMI_SERVER_KEY)
+    localhost.shell(local_command)
+
+    # Create server CSR
+    local_command = "openssl req \
+                        -new \
+                        -key %s \
+                        -subj '/CN=test.server.gnmi.sonic' \
+                        -out gnmiserver.csr" % (GNMI_SERVER_KEY)
+    localhost.shell(local_command)
+
+    # Sign server certificate
+    create_ext_conf(duthost.mgmt_ip, "extfile.cnf")
+    local_command = "openssl x509 \
+                        -req \
+                        -in gnmiserver.csr \
+                        -CA %s \
+                        -CAkey %s \
+                        -CAcreateserial \
+                        -out %s \
+                        -days 825 \
+                        -sha256 \
+                        -extensions req_ext -extfile extfile.cnf" % (GNMI_CA_CERT, GNMI_CA_KEY, GNMI_SERVER_CERT)
+    localhost.shell(local_command)
+
+    # Create client key
+    local_command = "openssl genrsa -out %s 2048" % (GNMI_CLIENT_KEY)
+    localhost.shell(local_command)
+
+    # Create client CSR
+    local_command = "openssl req \
+                        -new \
+                        -key %s \
+                        -subj '/CN=test.client.gnmi.sonic' \
+                        -out gnmiclient.csr" % (GNMI_CLIENT_KEY)
+    localhost.shell(local_command)
+
+    # Sign client certificate
+    local_command = "openssl x509 \
+                        -req \
+                        -in gnmiclient.csr \
+                        -CA %s \
+                        -CAkey %s \
+                        -CAcreateserial \
+                        -out %s \
+                        -days 825 \
+                        -sha256" % (GNMI_CA_CERT, GNMI_CA_KEY, GNMI_CLIENT_CERT)
+    localhost.shell(local_command)
+
+
+def apply_gnmi_cert(duthost):
+    # Copy CA certificate and server certificate over to the DUT
+    duthost.copy(src=GNMI_CA_CERT, dest='/etc/sonic/telemetry/')
+    duthost.copy(src=GNMI_SERVER_CERT, dest='/etc/sonic/telemetry/')
+    duthost.copy(src=GNMI_SERVER_KEY, dest='/etc/sonic/telemetry/')
+    port = gnmi_port(duthost)
+    assert int(port) > 0, "Invalid GNMI port"
+    dut_command = "docker exec %s supervisorctl stop %s" % (GNMI_CONTAINER, GNMI_PROGRAM)
+    duthost.shell(dut_command)
+    dut_command = "docker exec %s pkill telemetry" % (GNMI_CONTAINER)
+    duthost.shell(dut_command, module_ignore_errors=True)
+    dut_command = "docker exec %s bash -c " % GNMI_CONTAINER
+    dut_command += "\"/usr/bin/nohup /usr/sbin/telemetry -logtostderr --port %s " % port
+    dut_command += "--server_crt /etc/sonic/telemetry/%s " % (GNMI_SERVER_CERT)
+    dut_command += "--server_key /etc/sonic/telemetry/%s " % (GNMI_SERVER_KEY)
+    dut_command += "--ca_crt /etc/sonic/telemetry/%s " % (GNMI_CA_CERT)
+    # dut_command += "-gnmi_native_write=true -v=10 -zmq_address=tcp://127.0.0.1:8100 >/root/gnmi.log 2>&1 &\""
+    dut_command += "-gnmi_native_write=true -v=10 >/root/gnmi.log 2>&1 &\""
+    duthost.shell(dut_command)
+    time.sleep(GNMI_SERVER_START_WAIT_TIME)
+
+
+def recover_gnmi_cert(duthost):
+    dut_command = "docker exec %s supervisorctl status %s" % (GNMI_CONTAINER, GNMI_PROGRAM)
+    output = duthost.command(dut_command, module_ignore_errors=True)['stdout'].strip()
+    if 'RUNNING' in output:
+        return
+    dut_command = "docker exec %s pkill telemetry" % (GNMI_CONTAINER)
+    duthost.shell(dut_command, module_ignore_errors=True)
+    dut_command = "docker exec %s supervisorctl start %s" % (GNMI_CONTAINER, GNMI_PROGRAM)
+    duthost.shell(dut_command)
+    time.sleep(GNMI_SERVER_START_WAIT_TIME)
+
+
+def gnmi_capabilities(duthost, localhost, client_cert):
+    ip = duthost.mgmt_ip
+    port = gnmi_port(duthost)
+    cmd = "dash/gnmi_cli -client_types=gnmi -a %s:%s " % (ip, port)
+    cmd += "-logtostderr -client_crt ./%s -client_key ./%s " % (GNMI_CLIENT_CERT, GNMI_CLIENT_KEY)
+    cmd += "-ca_crt ./%s -capabilities" % (GNMI_CA_CERT)
+    output = localhost.shell(cmd, module_ignore_errors=True)
+    if output['stderr']:
+        return -1, output['stderr']
+    else:
+        return 0, output['stdout']
+
+
+def gnmi_set(duthost, localhost, delete_list, update_list, replace_list):
+    ip = duthost.mgmt_ip
+    port = gnmi_port(duthost)
+    cmd = "dash/gnmi_set -target_addr %s:%s " % (ip, port)
+    cmd += "-alsologtostderr -cert ./%s -key ./%s " % (GNMI_CLIENT_CERT, GNMI_CLIENT_KEY)
+    cmd += "-ca ./%s -time_out 60s " % (GNMI_CA_CERT)
+    cmd += "-xpath_target MIXED "
+    for delete in delete_list:
+        cmd += " -delete " + delete
+    for update in update_list:
+        cmd += " -update " + update
+    for replace in replace_list:
+        cmd += " -replace " + replace
+    output = localhost.shell(cmd, module_ignore_errors=True)
+    if output['stderr']:
+        return -1, output['stderr']
+    else:
+        return 0, output['stdout']
+
+
+def gnmi_get(duthost, localhost, path_list):
+    ip = duthost.mgmt_ip
+    port = gnmi_port(duthost)
+    cmd = "dash/gnmi_get -target_addr %s:%s " % (ip, port)
+    cmd += "-alsologtostderr -cert ./%s -key ./%s " % (GNMI_CLIENT_CERT, GNMI_CLIENT_KEY)
+    cmd += "-ca ./%s " % (GNMI_CA_CERT)
+    cmd += "-xpath_target MIXED "
+    for path in path_list:
+        cmd += " -xpath " + path
+    output = localhost.shell(cmd, module_ignore_errors=True)
+    if output['stderr']:
+        return -1, [output['stderr']]
+    else:
+        msg = output['stdout'].replace('\\', '')
+        find_list = re.findall(r'json_ietf_val:\s*"(.*?)"\s*>', msg)
+        if find_list:
+            return 0, find_list
+        else:
+            return -1, [msg]
+
+
+def json_to_proto(key, json_obj):
+    table_name = re.search(r"DASH_(\w+)_TABLE", key).group(1)
+    if table_name == "APPLIANCE":
+        pb = Appliance()
+        pb.sip.ipv4 = socket.htonl(int(ipaddress.IPv4Address(json_obj["sip"])))
+        pb.vm_vni = int(json_obj["vm_vni"])
+    elif table_name == "VNET":
+        pb = Vnet()
+        pb.vni = int(json_obj["vni"])
+        pb.guid.value = bytes.fromhex(uuid.UUID(json_obj["guid"]).hex)
+    elif table_name == "VNET_MAPPING":
+        pb = VnetMapping()
+        pb.action_type = RoutingType.ROUTING_TYPE_VNET_ENCAP
+        pb.underlay_ip.ipv4 = socket.htonl(int(ipaddress.IPv4Address(json_obj["underlay_ip"])))
+        pb.mac_address = bytes.fromhex(json_obj["mac_address"].replace(":", ""))
+        pb.use_dst_vni = json_obj["use_dst_vni"] == "true"
+    elif table_name == "QOS":
+        pb = Qos()
+        pb.qos_id = json_obj["qos_id"]
+        pb.bw = int(json_obj["bw"])
+        pb.cps = int(json_obj["cps"])
+        pb.flows = int(json_obj["flows"])
+    elif table_name == "ENI":
+        pb = Eni()
+        pb.eni_id = json_obj["eni_id"]
+        pb.mac_address = bytes.fromhex(json_obj["mac_address"].replace(":", ""))
+        pb.underlay_ip.ipv4 = socket.htonl(int(ipaddress.IPv4Address(json_obj["underlay_ip"])))
+        pb.admin_state = State.STATE_ENABLED if json_obj["admin_state"] == "enabled" else State.STATE_DISABLED
+        pb.vnet = json_obj["vnet"]
+        pb.qos = json_obj["qos"]
+    elif table_name == "ROUTE":
+        pb = Route()
+        if json_obj["action_type"] == "vnet":
+            pb.action_type = RoutingType.ROUTING_TYPE_VNET
+            pb.vnet = json_obj["vnet"]
+        elif json_obj["action_type"] == "vnet_direct":
+            pb.action_type = RoutingType.ROUTING_TYPE_VNET_DIRECT
+            pb.vnet_direct.vnet = json_obj["vnet"]
+            pb.vnet_direct.overlay_ip.ipv4 = socket.htonl(int(ipaddress.IPv4Address(json_obj["overlay_ip"])))
+        elif json_obj["action_type"] == "direct":
+            pb.action_type = RoutingType.ROUTING_TYPE_DIRECT
+        else:
+            pytest.fail("Unknown action type %s" % json_obj["action_type"])
+    elif table_name == "ROUTE_RULE":
+        pb = RouteRule()
+        pb.action_type = RoutingType.ROUTING_TYPE_VNET_ENCAP
+        pb.priority = int(json_obj["priority"])
+        pb.pa_validation = json_obj["pa_validation"] == "true"
+        pb.vnet = json_obj["vnet"]
+    elif table_name == "ROUTING_TYPE":
+        pb = RouteType()
+        pbi = RouteTypeItem()
+        pbi.action_name = json_obj["name"]
+        pbi.action_type = ActionType.ACTION_TYPE_MAPROUTING
+        pb.items.append(pbi)
+    else:
+        pytest.fail("Unknown table %s" % table_name)
+    return pb.SerializeToString()
+
+
+def apply_gnmi_file(duthost, localhost, dest_path):
+    logger.info("Applying config files on DUT")
+    dut_command = "cat %s" % dest_path
+    ret = duthost.shell(dut_command)
+    assert ret["rc"] == 0, "Failed to read config file"
+    text = ret["stdout"]
+    res = json.loads(text)
+    delete_list = []
+    update_list = []
+    update_cnt = 0
+    for operation in res:
+        if operation["OP"] == "SET":
+            for k, v in operation.items():
+                if k == "OP":
+                    continue
+                logger.info("Config Json %s" % k)
+                update_cnt += 1
+                filename = "update%u" % update_cnt
+                if ENABLE_PROTO:
+                    message = json_to_proto(k, v)
+                    with open(filename, "wb") as file:
+                        file.write(message)
+                else:
+                    text = json.dumps(v)
+                    with open(filename, "w") as file:
+                        file.write(text)
+                k = k.replace("/", "\\\\/", 1)
+                k = k.replace(":", "/", 1)
+                if ENABLE_PROTO:
+                    path = "/sonic-db:APPL_DB/%s:$./%s" % (k, filename)
+                else:
+                    path = "/sonic-db:APPL_DB/%s:@%s" % (k, filename)
+                update_list.append(path)
+        elif operation["OP"] == "DEL":
+            for k, v in operation.items():
+                if k == "OP":
+                    continue
+                k = k.replace("/", "\\\\/", 1)
+                k = k.replace(":", "/", 1)
+                path = "/sonic-db:APPL_DB/%s" % (k)
+                delete_list.append(path)
+        else:
+            logger.info("Invalid operation %s" % operation["OP"])
+    ret, msg = gnmi_set(duthost, localhost, delete_list, update_list, [])
+    assert ret == 0, msg
+    time.sleep(5)