[Snappi] Adding Lossless Response to External pause storm test case

tests/snappi_tests/multidut/pfc/files/lossless_response_to_external_pause_storms_helper.py

@@ -0,0 +1,386 @@
+# uncompyle6 version 3.9.0
+# Python bytecode version base 2.7 (62211)
+# Decompiled from: Python 3.10.4 (tags/v3.10.4:9d38120, Mar 23 2022, 23:13:41) [MSC v.1929 64 bit (AMD64)]
+# Embedded file name: /var/johnar/sonic-mgmt/tests/snappi/multi_dut_rdma/files/rdma_helper.py
+# Compiled at: 2023-02-10 09:15:26
+from math import ceil                                                                                # noqa: F401
+import logging                                                                                       # noqa: F401
+from tests.common.helpers.assertions import pytest_assert, pytest_require                            # noqa: F401
+from tests.common.fixtures.conn_graph_facts import conn_graph_facts, fanout_graph_facts              # noqa: F401
+from tests.common.snappi_tests.snappi_helpers import get_dut_port_id                                 # noqa: F401
+from tests.common.snappi_tests.common_helpers import pfc_class_enable_vector, stop_pfcwd, \
+    disable_packet_aging, sec_to_nanosec                                                             # noqa: F401
+from tests.common.snappi_tests.port import select_ports                                              # noqa: F401
+from tests.common.snappi_tests.snappi_test_params import SnappiTestParams
+from tests.common.snappi_tests.traffic_generation import run_traffic, verify_pause_flow, \
+     setup_base_traffic_config, verify_m2o_oversubscribtion_results                                 # noqa: F401
+
+logger = logging.getLogger(__name__)
+
+TEST_FLOW_NAME = 'Test Flow'
+TEST_FLOW_AGGR_RATE_PERCENT = 25
+BG_FLOW_NAME = 'Background Flow'
+BG_FLOW_AGGR_RATE_PERCENT = 25
+DATA_PKT_SIZE = 1024
+DATA_FLOW_DURATION_SEC = 20
+PAUSE_FLOW_DURATION_SEC = 10
+PAUSE_FLOW_DELAY_SEC = 5
+DATA_FLOW_DELAY_SEC = 0
+SNAPPI_POLL_DELAY_SEC = 2
+TOLERANCE_THRESHOLD = 0.05
+PAUSE_FLOW_RATE = 15
+PAUSE_FLOW_NAME = 'PFC Traffic'
+
+
+def run_lossless_response_to_external_pause_storms_test(api,
+                                                        testbed_config,
+                                                        port_config_list,
+                                                        conn_data,
+                                                        fanout_data,
+                                                        dut_port,
+                                                        pause_prio_list,
+                                                        test_prio_list,
+                                                        bg_prio_list,
+                                                        prio_dscp_map,
+                                                        snappi_extra_params=None):
+    """
+    Run PFC watchdog test in a multi-node (>=3) topoology
+
+    Args:
+        api (obj): SNAPPI session
+        testbed_config (obj): testbed L1/L2/L3 configuration
+        port_config_list (list): list of port configuration
+        conn_data (dict): the dictionary returned by conn_graph_fact.
+        fanout_data (dict): the dictionary returned by fanout_graph_fact.
+        duthost (Ansible host instance): device under test
+        dut_port (str): DUT port to test
+        pause_prio_list (list): priorities to pause for PFC pause storm
+        test_prio_list (list): priorities of test flows
+        bg_prio_list (list): priorities of background flows
+        prio_dscp_map (dict): Priority vs. DSCP map (key = priority)
+        snappi_extra_params (SnappiTestParams obj): additional parameters for Snappi traffic
+    Returns:
+        N/A
+    """
+    if snappi_extra_params is None:
+        snappi_extra_params = SnappiTestParams()
+
+    duthost1 = snappi_extra_params.multi_dut_params.duthost1
+    rx_port = snappi_extra_params.multi_dut_params.multi_dut_ports[0]
+    rx_port_id_list = [rx_port["port_id"]]
+    duthost2 = snappi_extra_params.multi_dut_params.duthost2
+    tx_port = [snappi_extra_params.multi_dut_params.multi_dut_ports[1],
+               snappi_extra_params.multi_dut_params.multi_dut_ports[2]]
+    tx_port_id_list = [tx_port[0]["port_id"], tx_port[1]["port_id"]]
+
+    pytest_assert(testbed_config is not None, 'Fail to get L2/3 testbed config')
+    stop_pfcwd(duthost1, rx_port['asic_value'])
+    disable_packet_aging(duthost1)
+    stop_pfcwd(duthost2, tx_port[0]['asic_value'])
+    disable_packet_aging(duthost2)
+
+    test_flow_rate_percent = int(TEST_FLOW_AGGR_RATE_PERCENT)
+    bg_flow_rate_percent = int(BG_FLOW_AGGR_RATE_PERCENT)
+    port_id = 0
+
+    # Generate base traffic config
+    snappi_extra_params.base_flow_config = setup_base_traffic_config(testbed_config=testbed_config,
+                                                                     port_config_list=port_config_list,
+                                                                     port_id=port_id)
+
+    __gen_traffic(testbed_config=testbed_config,
+                  port_config_list=port_config_list,
+                  rx_port_id_list=rx_port_id_list,
+                  tx_port_id_list=tx_port_id_list,
+                  pause_flow_name=PAUSE_FLOW_NAME,
+                  pause_flow_rate=PAUSE_FLOW_RATE,
+                  pause_prio_list=pause_prio_list,
+                  test_flow_name=TEST_FLOW_NAME,
+                  test_flow_prio_list=test_prio_list,
+                  test_flow_rate_percent=test_flow_rate_percent,
+                  bg_flow_name=BG_FLOW_NAME,
+                  bg_flow_prio_list=bg_prio_list,
+                  bg_flow_rate_percent=bg_flow_rate_percent,
+                  data_flow_dur_sec=DATA_FLOW_DURATION_SEC,
+                  data_pkt_size=DATA_PKT_SIZE,
+                  prio_dscp_map=prio_dscp_map)
+
+    flows = testbed_config.flows
+    all_flow_names = [flow.name for flow in flows]
+    data_flow_names = [flow.name for flow in flows if PAUSE_FLOW_NAME not in flow.name]
+
+    """ Run traffic """
+    flow_stats, switch_flow_stats = run_traffic(duthost=duthost1,
+                                                api=api,
+                                                config=testbed_config,
+                                                data_flow_names=data_flow_names,
+                                                all_flow_names=all_flow_names,
+                                                exp_dur_sec=DATA_FLOW_DURATION_SEC + DATA_FLOW_DELAY_SEC,
+                                                snappi_extra_params=snappi_extra_params)
+    flag = {
+        'Test Flow': {
+            'loss': '0'
+        },
+        'Background Flow': {
+            'loss': '0'
+        }
+    }
+
+    verify_m2o_oversubscribtion_results(duthost=duthost2,
+                                        rows=flow_stats,
+                                        test_flow_name=TEST_FLOW_NAME,
+                                        bg_flow_name=BG_FLOW_NAME,
+                                        rx_port=rx_port,
+                                        rx_frame_count_deviation=TOLERANCE_THRESHOLD,
+                                        flag=flag)
+
+    # Verify pause flows
+    verify_pause_flow(flow_metrics=flow_stats,
+                      pause_flow_name=PAUSE_FLOW_NAME)
+
+
+def __gen_traffic(testbed_config,
+                  port_config_list,
+                  rx_port_id_list,
+                  tx_port_id_list,
+                  pause_flow_name,
+                  pause_flow_rate,
+                  pause_prio_list,
+                  test_flow_name,
+                  test_flow_prio_list,
+                  test_flow_rate_percent,
+                  bg_flow_name,
+                  bg_flow_prio_list,
+                  bg_flow_rate_percent,
+                  data_flow_dur_sec,
+                  data_pkt_size,
+                  prio_dscp_map):
+    """
+    Generate configurations of flows under all to all traffic pattern, including
+    test flows, background flows and pause storm. Test flows and background flows
+    are also known as data flows.
+
+    Args:
+        testbed_config (obj): testbed L1/L2/L3 configuration
+        port_config_list (list): list of port configuration
+        port_id (int): ID of DUT port to test.
+        pause_flow_name (str): name of pause storm
+        pause_prio_list (list): priorities to pause for PFC frames
+        test_flow_name (str): name prefix of test flows
+        test_prio_list (list): priorities of test flows
+        test_flow_rate_percent (int): rate percentage for each test flow
+        bg_flow_name (str): name prefix of background flows
+        bg_prio_list (list): priorities of background flows
+        bg_flow_rate_percent (int): rate percentage for each background flow
+        data_flow_dur_sec (int): duration of data flows in second
+        pfc_storm_dur_sec (float): duration of the pause storm in second
+        data_pkt_size (int): packet size of data flows in byte
+        prio_dscp_map (dict): Priority vs. DSCP map (key = priority).
+
+    Returns:
+        N/A
+    """
+    __gen_data_flows(testbed_config=testbed_config,
+                     port_config_list=port_config_list,
+                     src_port_id_list=tx_port_id_list,
+                     dst_port_id_list=rx_port_id_list,
+                     flow_name_prefix=TEST_FLOW_NAME,
+                     flow_prio_list=test_flow_prio_list,
+                     flow_rate_percent=test_flow_rate_percent,
+                     flow_dur_sec=data_flow_dur_sec,
+                     data_pkt_size=data_pkt_size,
+                     prio_dscp_map=prio_dscp_map)
+
+    __gen_data_flows(testbed_config=testbed_config,
+                     port_config_list=port_config_list,
+                     src_port_id_list=tx_port_id_list,
+                     dst_port_id_list=rx_port_id_list,
+                     flow_name_prefix=BG_FLOW_NAME,
+                     flow_prio_list=bg_flow_prio_list,
+                     flow_rate_percent=bg_flow_rate_percent,
+                     flow_dur_sec=data_flow_dur_sec,
+                     data_pkt_size=data_pkt_size,
+                     prio_dscp_map=prio_dscp_map)
+
+    __gen_data_flows(testbed_config=testbed_config,
+                     port_config_list=port_config_list,
+                     src_port_id_list=rx_port_id_list,
+                     dst_port_id_list=tx_port_id_list,
+                     flow_name_prefix=PAUSE_FLOW_NAME,
+                     flow_prio_list=pause_prio_list,
+                     flow_rate_percent=pause_flow_rate,
+                     flow_dur_sec=data_flow_dur_sec,
+                     data_pkt_size=data_pkt_size,
+                     prio_dscp_map=prio_dscp_map)
+
+
+def __gen_data_flows(testbed_config,
+                     port_config_list,
+                     src_port_id_list,
+                     dst_port_id_list,
+                     flow_name_prefix,
+                     flow_prio_list,
+                     flow_rate_percent,
+                     flow_dur_sec,
+                     data_pkt_size,
+                     prio_dscp_map):
+    """
+    Generate the configuration for data flows
+
+    Args:
+        testbed_config (obj): testbed L1/L2/L3 configuration
+        port_config_list (list): list of port configuration
+        src_port_id_list (list): IDs of source ports
+        dst_port_id_list (list): IDs of destination ports
+        flow_name_prefix (str): prefix of flows' names
+        flow_prio_list (list): priorities of data flows
+        flow_rate_percent (int): rate percentage for each flow
+        flow_dur_sec (int): duration of each flow in second
+        data_pkt_size (int): packet size of data flows in byte
+        prio_dscp_map (dict): Priority vs. DSCP map (key = priority).
+
+    Returns:
+        N/A
+    """
+    if 'PFC Traffic' not in flow_name_prefix:
+        for src_port_id in src_port_id_list:
+            for dst_port_id in dst_port_id_list:
+                if src_port_id == dst_port_id:
+                    continue
+                __gen_data_flow(testbed_config=testbed_config,
+                                port_config_list=port_config_list,
+                                src_port_id=src_port_id,
+                                dst_port_id=dst_port_id,
+                                flow_name_prefix=flow_name_prefix,
+                                flow_prio=flow_prio_list,
+                                flow_rate_percent=flow_rate_percent,
+                                flow_dur_sec=flow_dur_sec,
+                                data_pkt_size=data_pkt_size,
+                                prio_dscp_map=prio_dscp_map)
+    else:
+        __gen_data_flow(testbed_config=testbed_config,
+                        port_config_list=port_config_list,
+                        src_port_id=src_port_id_list[0],
+                        dst_port_id=dst_port_id_list[0],
+                        flow_name_prefix=flow_name_prefix,
+                        flow_prio=flow_prio_list,
+                        flow_rate_percent=flow_rate_percent,
+                        flow_dur_sec=flow_dur_sec,
+                        data_pkt_size=data_pkt_size,
+                        prio_dscp_map=prio_dscp_map)
+
+
+def __gen_data_flow(testbed_config,
+                    port_config_list,
+                    src_port_id,
+                    dst_port_id,
+                    flow_name_prefix,
+                    flow_prio,
+                    flow_rate_percent,
+                    flow_dur_sec,
+                    data_pkt_size,
+                    prio_dscp_map):
+    """
+    Generate the configuration for a data flow
+
+    Args:
+        testbed_config (obj): testbed L1/L2/L3 configuration
+        port_config_list (list): list of port configuration
+        src_port_id (int): ID of the source port
+        dst_port_id (int): ID of destination port
+        flow_name_prefix (str): prefix of flow' name
+        flow_prio_list (list): priorities of the flow
+        flow_rate_percent (int): rate percentage for the flow
+        flow_dur_sec (int): duration of the flow in second
+        data_pkt_size (int): packet size of the flow in byte
+        prio_dscp_map (dict): Priority vs. DSCP map (key = priority).
+
+    Returns:
+        N/A
+    """
+    if 'PFC Traffic' not in flow_name_prefix:
+        tx_port_config = next((x for x in port_config_list if x.id == src_port_id), None)
+        rx_port_config = next((x for x in port_config_list if x.id == dst_port_id), None)
+        tx_mac = tx_port_config.mac
+        if tx_port_config.gateway == rx_port_config.gateway and tx_port_config.prefix_len == rx_port_config.prefix_len:
+            rx_mac = rx_port_config.mac
+        else:
+            rx_mac = tx_port_config.gateway_mac
+
+        flow = testbed_config.flows.flow(name='{} {} -> {}'.format(flow_name_prefix, src_port_id, dst_port_id))[-1]
+        flow.tx_rx.port.tx_name = testbed_config.ports[src_port_id].name
+        flow.tx_rx.port.rx_name = testbed_config.ports[dst_port_id].name
+        eth, ipv4 = flow.packet.ethernet().ipv4()
+        eth.src.value = tx_mac
+        eth.dst.value = rx_mac
+
+        if 'Background Flow' in flow.name:
+            eth.pfc_queue.value = 0
+        elif 'Test Flow 1 -> 0' in flow.name:
+            eth.pfc_queue.value = 3
+        else:
+            eth.pfc_queue.value = 4
+
+        ipv4.src.value = tx_port_config.ip
+        ipv4.dst.value = rx_port_config.ip
+        ipv4.priority.choice = ipv4.priority.DSCP
+        flow_prio_dscp_list = []
+        if 'Background Flow 1 -> 0' in flow.name:
+            ipv4.priority.dscp.phb.values = [
+                ipv4.priority.dscp.phb.CS2,
+            ]
+        elif 'Background Flow 2 -> 0' in flow.name:
+            ipv4.priority.dscp.phb.values = [5]
+        else:
+            for fp in flow_prio:
+                for val in prio_dscp_map[fp]:
+                    flow_prio_dscp_list.append(val)
+            ipv4.priority.dscp.phb.values = flow_prio_dscp_list
+
+        ipv4.priority.dscp.ecn.value = ipv4.priority.dscp.ecn.CAPABLE_TRANSPORT_1
+        flow.duration.fixed_seconds.delay.nanoseconds = int(sec_to_nanosec(DATA_FLOW_DELAY_SEC))
+        flow.size.fixed = data_pkt_size
+        flow.rate.percentage = flow_rate_percent
+        flow.duration.fixed_seconds.seconds = flow_dur_sec
+        flow.metrics.enable = True
+        flow.metrics.loss = True
+
+    else:
+        """ Generate a series of PFC storms """
+        tx_port_config = next((x for x in port_config_list if x.id == src_port_id), None)
+        rx_port_config = next((x for x in port_config_list if x.id == dst_port_id), None)
+
+        pause_time = []
+        for x in range(8):
+            if x in flow_prio:
+                pause_time.append(int('ffff', 16))
+            else:
+                pause_time.append(int('0000', 16))
+
+        vector = pfc_class_enable_vector(flow_prio)
+
+        pause_flow = testbed_config.flows.flow(
+            name="{}".format(flow_name_prefix))[-1]
+        pause_flow.tx_rx.port.tx_name = testbed_config.ports[src_port_id].name
+        pause_flow.tx_rx.port.rx_name = testbed_config.ports[dst_port_id].name
+
+        pause_pkt = pause_flow.packet.pfcpause()[-1]
+
+        pause_pkt.src.value = '00:00:aa:00:00:01'
+        pause_pkt.dst.value = '01:80:c2:00:00:01'
+        pause_pkt.class_enable_vector.value = vector
+        pause_pkt.pause_class_0.value = pause_time[0]
+        pause_pkt.pause_class_1.value = pause_time[1]
+        pause_pkt.pause_class_2.value = pause_time[2]
+        pause_pkt.pause_class_3.value = pause_time[3]
+        pause_pkt.pause_class_4.value = pause_time[4]
+        pause_pkt.pause_class_5.value = pause_time[5]
+        pause_pkt.pause_class_6.value = pause_time[6]
+        pause_pkt.pause_class_7.value = pause_time[7]
+
+        pause_flow.duration.fixed_seconds.delay.nanoseconds = int(sec_to_nanosec(PAUSE_FLOW_DELAY_SEC))
+        pause_flow.rate.percentage = flow_rate_percent
+        pause_flow.size.fixed = 64
+        pause_flow.duration.fixed_seconds.seconds = PAUSE_FLOW_DURATION_SEC
+        pause_flow.metrics.enable = True
+        pause_flow.metrics.loss = True