Create config and input file : Dynamically generates device specific

configuration and input files.

This code supports to dynamically create "configuration file" and
"input file" for virtual interface with few required parameters.

Signed-off-by: Shaik Abdulla <abdulla1@linux.vnet.ibm.com>

Author: FarooqAbdulla02

pci_info.py

@@ -14,9 +14,11 @@
 # Copyright: 2023 IBM
 # Author: Narasimhan V <sim@linux.vnet.ibm.com>
 # Author: Manvanthara Puttashankar <manvanth@linux.vnet.ibm.com>
+# Author: Shaik Abdulla <abdulla1@linux.vom>
 
 from pprint import pprint
 from lib import pci
+from lib import virtual
 import argparse
 import shutil
 import os
@@ -38,109 +40,195 @@
 
 logger = logger_init(filepath=BASE_PATH).getlogger()
 
-
-def create_config(pci_list):
+def create_config_inputs(orig_cfg, new_cfg, inputfile, interface, config_type):
     """
-    Creates avocado test suite / config file, and input file needed for yaml files in that config files.
+    1. Creates modified configuration file name according to type of interface from original configuration file
+    2. Generates string with "input file option" along with input file,
+    3. Generates input parametes of specific device type interface.
+
+    Parameters:
+        orig_cfg (str): The name of the original configuration file.
+        new_cfg (str): The name of the new configuration file to be generated with
+                       according to interface type.
+        inputfile (str): The path to the input file containing configuration data.
+        interface (list): The details of Interface in list format.
+        config_type (str): The type of configuration to generate. Ex: PCI, vNIC etc.
+
+    Returns:
+        test_suites :: A list, having configuration[cfg] files of different set.
+        input_file_string :: A string, with extension of "--input-file" option.
+        input_params:: A list, of different input parameters of specific interface.
     """
     test_suites = []
     input_file_string = ""
     input_params = []
     additional_params = args.add_params.split()
-    for pci in pci_list:
-        if pci['is_root_disk']:
-            logger.debug(
-                "ignoring pci address %s as it contains root disk", pci['pci_root'])
-            continue
+    if len(additional_params) != 0:
+        additional_params = args.add_params.split(",")
+
+    # Exclude input parameters when vNIC has been created manually, as these parameters are not needed.
+    # exclude_inputs_params = ["manageSystem","sriov", "hmc_pwd", "hmc_username", "vios_ip","vios_username",
+    #                   "vios_pwd","slot_num", "vios_names","sriov_adapters", "sriov_ports",
+    #                   "priority", "auto_failover", "bandwidth"]
+
+    # Exclude test-cases from test bucket when vNIC created manually.
+    exclude_test_cases = ["NetworkVirtualization.test_add", "NetworkVirtualization.test_backingdevadd",
+                          "NetworkVirtualization.test_backingdevremove", "NetworkVirtualization.test_remove"]
+
+    # when vNIC created manually, Read the orignal configuration file and write only required test-cases in new configuration file.
+    if config_type == 'vnic':
+        test_cases = []
+        with open("config/tests/host/%s.cfg" % orig_cfg, 'r') as file:
+
+            lines = file.readlines()
+            for testcases in lines:
+                if not any(exclude_test_case in testcases for exclude_test_case in exclude_test_cases):
+                    test_cases.append(testcases)
+
+        with open("config/tests/host/%s.cfg" % new_cfg, 'w+') as output_file:
+            output_file.write("".join(test_cases))
+    else:
+        shutil.copy("config/tests/host/%s.cfg" % orig_cfg, "config/tests/host/%s.cfg" % new_cfg)
+
+    test_suites.append("host_%s" % new_cfg)
+
+    # adding info to input file
+    if not CONFIGFILE.has_section(orig_cfg) and not additional_params:
+        return
+    input_params = CONFIGFILE.items(orig_cfg)
+    if not input_params:
+        return
+
+    INPUTFILE.add_section(new_cfg)
+
+    # read the input file content and store in dict
+    inputfile_dict = {}
+    with open(inputfile, 'r') as file:
+        for line in file:
+            # Check if the line starts with '#' or '[' and skip it
+            if line.startswith('#') or line.startswith('['):
+                continue
 
-        # copy template cfg files and create new ones
-        cfg_name = "_".join(pci['pci_root'].split(':'))
-        if pci['adapter_type'] == 'nvmf' and is_rhel8():
-            orig_cfg = "io_%s_rhel8_fvt" % pci['adapter_type']
-            new_cfg = "io_%s_rhel8_%s_fvt" % (pci['adapter_type'], cfg_name)
-            inputfile = "%s/io_%s_rhel8_input.txt" % (
-                BASE_INPUTFILE_PATH, pci['adapter_type'])
+            # Split each line by '=' to separate key and value
+            parts = line.strip().split('=')
+
+            # Ensure there are exactly two parts (key and value)
+            if len(parts) == 2:
+                inputkey, inputvalue = parts[0].strip(), parts[1].strip()
+                inputfile_dict[inputkey] = inputvalue
+
+    # input params
+    for param in input_params:
+        try:
+            key = param[0]
+            if ':' not in param[1]:
+                value = interface[param[1]]
+            else:
+                index = param[1].split(':')[0]
+                index_exact = param[1].split(':')[1]
+                if index_exact == 'all':
+
+                    # adding only first two available vNIC interfaces when
+                    # multiple vNIC interfaces are available in system.
+                    if config_type in ('vnic', 'veth', 'hnv'):
+                        value = " ".join(str(item) for item in interface[index][:2])
+                    else:
+                        value = " ".join(interface[index])
+                else:
+                    value = interface[index][int(index_exact)]
+                    if len(interface[index]) > 1:
+                        del interface[index][int(index_exact)]
+            # remove the duplicate inputfile enteries
+            if key in inputfile_dict:
+                del inputfile_dict[key]
+            INPUTFILE.set(new_cfg, key, "\"%s\"" % value)
+
+        except:
+            pass
+
+        # exclude input parameters when vNIC has been created manually.
+        # if config_type == 'vnic':
+        #     for key in list(inputfile_dict.keys()):
+        #         if any(key.startswith(exclude) for exclude in exclude_inputs_params):
+        #             del inputfile_dict[key]
+
+    # additional params
+    for param in additional_params:
+        key = param.split('=')[0]
+        # handling additional params per pci
+        if '::' in key:
+            pci_root = key.split('::')[0].split('.')[0]
+            if pci_root != pci['pci_root']:
+                continue
+            key = key.split('::')[1]
+
+        # check if the newly added additional param is same
+        # as inputfile assign the values directly
+        if key in inputfile_dict:
+            inputfile_dict[key] = param.split('=')[1]
         else:
-            orig_cfg = "io_%s_fvt" % pci['adapter_type']
-            new_cfg = "io_%s_%s_fvt" % (pci['adapter_type'], cfg_name)
-            inputfile = "%s/io_%s_input.txt" % (
-                BASE_INPUTFILE_PATH, pci['adapter_type'])
+            # if it is completly new then directly write to new input file
+            value = param.split('=')[1]
+            INPUTFILE.set(new_cfg, key, "\"%s\"" % value)
+
+    # append the remaining input file entries to the new input file
+    for inputkey, inputvalue in inputfile_dict.items():
+        INPUTFILE.set(new_cfg, inputkey, "%s" % inputvalue)
+
+    return test_suites, input_file_string, input_params
+
+
+def create_config_file(interface_details, config_type):
+    """
+    Creates avocado test suite / config file, and input file needed for yaml files in that config files.
+
+    Parameters:
+        interface_details(list): The detailed differnet Interface parameters in list format.
+        config_type (str): The type of configuration to generate. Ex: vNIC, HNV, vETH etc.
+    """
+    for virtual in interface_details:
+        cfg_name = virtual['adapter_type']
+        orig_cfg = "io_%s_fvt" % virtual['adapter_type']
+        new_cfg = "io_%s_stress_fvt" % virtual['adapter_type']
+        inputfile = "%s/io_%s_input.txt" % (BASE_INPUTFILE_PATH, virtual['adapter_type'])
+
         if not os.path.exists("config/tests/host/%s.cfg" % orig_cfg):
-            logger.debug("ignoring pci address %s as there is no cfg for %s",
-                         pci['pci_root'], pci['adapter_type'])
+            logger.debug("ignoring hnv address as there is no cfg for %s", virtual['adapter_type'])
             continue
-        shutil.copy("config/tests/host/%s.cfg" %
-                    orig_cfg, "config/tests/host/%s.cfg" % new_cfg)
-        test_suites.append("host_%s" % new_cfg)
 
-        # adding info to input file
-        if not CONFIGFILE.has_section(orig_cfg) and not additional_params:
-            continue
-        input_params = CONFIGFILE.items(orig_cfg)
-        if not input_params:
-            continue
-        INPUTFILE.add_section(new_cfg)
-
-        # read the input file content and store in dict
-        inputfile_dict = {}
-        with open(inputfile, 'r') as file:
-            for line in file:
-                # Check if the line starts with '#' or '[' and skip it
-                if line.startswith('#') or line.startswith('['):
-                    continue
-
-                # Split each line by '=' to separate key and value
-                parts = line.strip().split('=')
-
-                # Ensure there are exactly two parts (key and value)
-                if len(parts) == 2:
-                    inputkey, inputvalue = parts[0].strip(), parts[1].strip()
-                    inputfile_dict[inputkey] = inputvalue
-
-        # input params
-        for param in input_params:
-            try:
-                key = param[0]
-                if ':' not in param[1]:
-                    value = pci[param[1]]
-                else:
-                    index = param[1].split(':')[0]
-                    index_exact = param[1].split(':')[1]
-                    if index_exact == 'all':
-                        value = " ".join(pci[index])
-                    else:
-                        value = pci[index][int(index_exact)]
-                        if len(pci[index]) > 1 and not key == 'pci_device':
-                            del pci[index][int(index_exact)]
-                # remove the duplicate inputfile enteries
-                if key in inputfile_dict:
-                    del inputfile_dict[key]
-                INPUTFILE.set(new_cfg, key, "\"%s\"" % value)
-            except:
-                pass
-
-        # additional params
-        for param in additional_params:
-            key = param.split('=')[0]
-            # handling additional params per pci
-            if '::' in key:
-                pci_root = key.split('::')[0].split('.')[0]
-                if pci_root != pci['pci_root']:
-                    continue
-                key = key.split('::')[1]
-
-            # check if the newly added additional param is same
-            # as inputfile assign the values directly
-            if key in inputfile_dict:
-                inputfile_dict[key] = param.split('=')[1]
+    return create_config_inputs(orig_cfg, new_cfg, inputfile, virtual, config_type=config_type)
+
+def create_config(interface_details, config_type):
+    """
+    Creates avocado test suite / config file, and input file needed for yaml files in that config files.
+    """
+    if config_type == 'pci':
+        for pci in interface_details:
+            if pci['is_root_disk']:
+                logger.debug(
+                    "ignoring pci address %s as it contains root disk", pci['pci_root'])
+                continue
+
+            # copy template cfg files and create new ones
+            cfg_name = "_".join(pci['pci_root'].split(':'))
+            if pci['adapter_type'] == 'nvmf' and is_rhel8():
+                orig_cfg = "io_%s_rhel8_fvt" % pci['adapter_type']
+                new_cfg = "io_%s_rhel8_%s_fvt" % (pci['adapter_type'], cfg_name)
+                inputfile = "%s/io_%s_rhel8_input.txt" % (
+                    BASE_INPUTFILE_PATH, pci['adapter_type'])
             else:
-                # if it is completly new then directly write to new input file
-                value = param.split('=')[1]
-                INPUTFILE.set(new_cfg, key, "\"%s\"" % value)
+                orig_cfg = "io_%s_fvt" % pci['adapter_type']
+                new_cfg = "io_%s_%s_fvt" % (pci['adapter_type'], cfg_name)
+                inputfile = "%s/io_%s_input.txt" % (
+                    BASE_INPUTFILE_PATH, pci['adapter_type'])
+            if not os.path.exists("config/tests/host/%s.cfg" % orig_cfg):
+                logger.debug("ignoring pci address %s as there is no cfg for %s",
+                            pci['pci_root'], pci['adapter_type'])
+                continue
+        test_suites, input_file_string, input_params = create_config_inputs(orig_cfg, new_cfg, inputfile, pci, config_type='pci')
 
-        # append the remaining input file entries to the new input file
-        for inputkey, inputvalue in inputfile_dict.items():
-            INPUTFILE.set(new_cfg, inputkey, "%s" % inputvalue)
+    if config_type in ('vnic', 'veth', 'hnv'):
+        test_suites, input_file_string, input_params = create_config_file(interface_details, config_type)
 
     test_suites = ",".join(test_suites)
 
@@ -152,17 +240,21 @@ def create_config(pci_list):
 
     # generate avocado-setup command line
     if test_suites:
-        cmd = "python avocado-setup.py --run-suite %s %s" % (
-            test_suites, input_file_string)
+        cmd = "python avocado-setup.py --run-suite %s %s" % (test_suites, input_file_string)
         return cmd
     return ""
 
-
 if __name__ == '__main__':
     parser = argparse.ArgumentParser()
     parser.add_argument('--pci-address', dest='pci_addr',
                         action='store', default='',
                         help='pci address, comma separated')
+    parser.add_argument('--vnic', dest='vnic_int', action='store', nargs='?', const='vnic_default', default=None,
+                        help='vNIC interface name')
+    parser.add_argument('--veth', dest='veth_int', action='store', nargs='?', const='veth_default', default=None,
+                        help='vETH interface name')
+    parser.add_argument('--hnv', dest='hnv_int', action='store', nargs='?', const='hnv_default', default=None,
+                        help='HNV interface name')
     parser.add_argument('--pci-address-blocklist', dest='pci_addr_blocklist',
                         action='store', default='',
                         help='pci address which need not be considered, comma separated')
@@ -185,19 +277,58 @@ def create_config(pci_list):
                         action='store', default='',
                         help='Additional parameters(key=value) to the input file, space separated')
     args = parser.parse_args()
-    if args.pci_addr:
-        pci_details = pci.pci_info(args.pci_addr, pci_type=args.pci_type,
-                                   pci_blocklist=args.pci_addr_blocklist, type_blocklist=args.type_blocklist)
-    else:
-        pci_details = pci.all_pci_info(
-            pci_type=args.pci_type, pci_blocklist=args.pci_addr_blocklist, type_blocklist=args.type_blocklist)
-    if not pci_details:
-        logger.info("No PCI Found")
+
+    #if no interfaces name is provided for vNIC ,vETH or HNV, get the first aavailable interface.
+    if args.vnic_int == 'vnic_default':
+        args.vnic_int = virtual.get_vnic_interface_names()[0]
+
+    if args.veth_int == 'veth_default':
+        args.veth_int = virtual.get_veth_interface_names()[0]
+
+    if args.hnv_int == 'hnv_default':
+        args.hnv_int = virtual.get_hnv_interface_names()[0]
+
+    try:
+        if args.vnic_int:
+            vnic_details = virtual.virtual_info(args.vnic_int)
+        elif args.veth_int:
+            veth_details = virtual.virtual_info(args.veth_int)
+        elif args.hnv_int:
+            hnv_details = virtual.virtual_info(args.hnv_int)
+        elif args.pci_addr:
+            pci_details = pci.pci_info(args.pci_addr, pci_type=args.pci_type, pci_blocklist=args.pci_addr_blocklist, type_blocklist=args.type_blocklist)
+        else:
+            pci_details = pci.all_pci_info(pci_type=args.pci_type, pci_blocklist=args.pci_addr_blocklist, type_blocklist=args.type_blocklist)
+    except Exception as e:
+        if args.vnic_int:
+            logger.info("vNIC interface not found")
+        else:
+            logger.info("No PCI Found")
         sys.exit(0)
+
     if args.show_info:
-        pprint(pci_details)
+        if args.pci_addr:
+            pprint(pci_details)
+        elif args.vnic_int:
+            pprint(vnic_details)
+        elif args.veth_int:
+            pprint(veth_details)
+        elif args.hnv_int:
+            pprint(hnv_details)
+
     if args.create_cfg:
-        cmd = create_config(pci_details)
-        logger.info(cmd)
+        if args.vnic_int:
+            cmd = create_config(interface_details=vnic_details, config_type='vnic')
+            logger.info(cmd)
+        elif args.veth_int:
+            cmd = create_config(interface_details=veth_details, config_type='veth')
+            logger.info(cmd)
+        elif args.hnv_int:
+            cmd = create_config(interface_details=hnv_details, config_type='hnv')
+            logger.info(cmd)
+        else:
+            cmd = create_config(interface_details=pci_details, config_type='pci')
+            logger.info(cmd)
+
     if args.run_test:
-        os.system(cmd)
+        os.system(cmd)