[parametize by ports] add infrastructure to allow test parametized by ports (#2411)

* [parametize by ports] add infrastructure to allow test parametized by ports

Assumptions:

- Run test_pretest before actual test.
- test_update_testbed_metadata will populate testbed information
  and save to tests/metadata/<testbed_name>.json.

Available parameterizes:
- all_ports      : all ports available on target testbed.
- oper_up_ports  : all ports in oper_up state.
- admin_up_ports : all ports in admin_up state.
- all_pc         : all port channel available on target testbed.
- oper_up_pc     : all port channel in oper_up state.
- admin_up_pc    : all port channel in admin_up state.

Parameter format:
  { 'dut' : <dut name, str>, 'interface' : <port or port channel name, str> }

Expectations:
- when { 'dut' : 'unknown', 'interface' : 'found-no-<port|pc>' } is passed
  in as parameter, test should warn and loop through all ports (port channels).

Signed-off-by: Ying Xie <ying.xie@microsoft.com>

* add port channel enumerators

* format json file to be more human readable

* encode/decode dut/port names so the paramters are more informative

* unify encoding for no found cases

Author: yxieca

tests/common/helpers/dut_ports.py

@@ -0,0 +1,17 @@
+def encode_dut_port_name(dutname, portname):
+    return dutname + '|' + portname
+
+
+def decode_dut_port_name(dut_portname):
+    tokens = dut_portname.split('|')
+    if len(tokens) >= 2:
+        dutname = tokens[0]
+        portname = tokens[1]
+    elif len(tokens) == 1:
+        dutname = None
+        portname = dut_portname
+    else:
+        dutname = None
+        portname = None
+    return dutname, portname
+

tests/conftest.py

@@ -21,6 +21,7 @@
 from tests.common.devices import SonicHost, Localhost
 from tests.common.devices import PTFHost, EosHost, FanoutHost
 from tests.common.helpers.constants import ASIC_PARAM_TYPE_ALL, ASIC_PARAM_TYPE_FRONTEND, DEFAULT_ASIC_ID
+from tests.common.helpers.dut_ports import encode_dut_port_name
 
 logger = logging.getLogger(__name__)
 
@@ -482,6 +483,53 @@ def generate_params_dut_index(request):
     logging.info("Num of duts in testbed topology {}".format(num_duts))
     return range(num_duts)
 
+
+def generate_port_lists(request, port_scope):
+    empty = [ encode_dut_port_name('unknown', 'unknown') ]
+    if 'ports' in port_scope:
+        scope = 'Ethernet'
+    elif 'pcs' in port_scope:
+        scope = 'PortChannel'
+    else:
+        return empty
+
+    if 'all' in port_scope:
+        state = None
+    elif 'oper_up' in port_scope:
+        state = 'oper_state'
+    elif 'admin_up' in port_scope:
+        state = 'admin_state'
+    else:
+        return empty
+
+    tbname = request.config.getoption("--testbed")
+    if not tbname:
+        return empty
+
+    folder = 'metadata'
+    filepath = os.path.join(folder, tbname + '.json')
+
+    try:
+        with open(filepath, 'r') as yf:
+            ports = json.load(yf)
+    except IOError as e:
+        return empty
+
+    if tbname not in ports:
+        return empty
+
+    dut_ports = ports[tbname]
+    ret = []
+    for dut, val in dut_ports.items():
+        if 'intf_status' not in val:
+            continue
+        for intf, status in val['intf_status'].items():
+            if scope in intf and (not state or status[state] == 'up'):
+                ret.append(encode_dut_port_name(dut, intf))
+
+    return ret if ret else empty
+
+
 def pytest_generate_tests(metafunc):
     # The topology always has atleast 1 dut
     dut_indices = [0]
@@ -493,3 +541,15 @@ def pytest_generate_tests(metafunc):
     if "frontend_asic_index" in metafunc.fixturenames:
         metafunc.parametrize("frontend_asic_index",generate_param_asic_index(metafunc, dut_indices, ASIC_PARAM_TYPE_FRONTEND))
 
+    if "all_ports" in metafunc.fixturenames:
+        metafunc.parametrize("all_ports", generate_port_lists(metafunc, "all_ports"))
+    if "oper_up_ports" in metafunc.fixturenames:
+        metafunc.parametrize("oper_up_ports", generate_port_lists(metafunc, "oper_up_ports"))
+    if "admin_up_ports" in metafunc.fixturenames:
+        metafunc.parametrize("admin_up_ports", generate_port_lists(metafunc, "admin_up_ports"))
+    if "all_pcs" in metafunc.fixturenames:
+        metafunc.parametrize("all_pcs", generate_port_lists(metafunc, "all_pcs"))
+    if "oper_up_pcs" in metafunc.fixturenames:
+        metafunc.parametrize("oper_up_pcs", generate_port_lists(metafunc, "oper_up_pcs"))
+    if "admin_up_pcs" in metafunc.fixturenames:
+        metafunc.parametrize("admin_up_pcs", generate_port_lists(metafunc, "admin_up_pcs"))