Python3: resources and libraries
[csit.git] / resources / libraries / python / Constants.py
index 3fa9ae2..eee9177 100644 (file)
@@ -42,7 +42,7 @@ def get_str_from_env(env_var_names, default_value):
     :returns: The value read, or default value.
     :rtype: str
     """
-    prefixes = ("FDIO_CSIT_", "CSIT_", "")
+    prefixes = (u"FDIO_CSIT_", u"CSIT_", u"")
     if not isinstance(env_var_names, (list, tuple)):
         env_var_names = [env_var_names]
     for name in env_var_names:
@@ -65,7 +65,7 @@ def get_int_from_env(env_var_names, default_value):
     :returns: The value read, or default value.
     :rtype: int
     """
-    env_str = get_str_from_env(env_var_names, "")
+    env_str = get_str_from_env(env_var_names, u"")
     try:
         return int(env_str)
     except ValueError:
@@ -84,7 +84,7 @@ def get_float_from_env(env_var_names, default_value):
     :returns: The value read, or default value.
     :rtype: float
     """
-    env_str = get_str_from_env(env_var_names, "")
+    env_str = get_str_from_env(env_var_names, u"")
     try:
         return float(env_str)
     except ValueError:
@@ -101,8 +101,8 @@ def get_pessimistic_bool_from_env(env_var_names):
     :returns: The value read, or False.
     :rtype: bool
     """
-    env_str = get_str_from_env(env_var_names, "").lower()
-    return True if env_str in ("true", "yes", "y", "1") else False
+    env_str = get_str_from_env(env_var_names, u"").lower()
+    return bool(env_str in (u"true", u"yes", u"y", u"1"))
 
 
 def get_optimistic_bool_from_env(env_var_names):
@@ -115,11 +115,11 @@ def get_optimistic_bool_from_env(env_var_names):
     :returns: The value read, or True.
     :rtype: bool
     """
-    env_str = get_str_from_env(env_var_names, "").lower()
-    return False if env_str in ("false", "no", "n", "0") else True
+    env_str = get_str_from_env(env_var_names, u"").lower()
+    return bool(env_str not in (u"false", u"no", u"n", u"0"))
 
 
-class Constants(object):
+class Constants:
     """Constants used in CSIT.
 
     TODO: Yaml files are easier for humans to edit.
@@ -128,34 +128,34 @@ class Constants(object):
     """
 
     # OpenVPP testing directory location at topology nodes
-    REMOTE_FW_DIR = '/tmp/openvpp-testing'
+    REMOTE_FW_DIR = u"/tmp/openvpp-testing"
 
     # shell scripts location
-    RESOURCES_LIB_SH = 'resources/libraries/bash'
+    RESOURCES_LIB_SH = u"resources/libraries/bash"
 
     # Python API provider location
-    RESOURCES_PAPI_PROVIDER = 'resources/tools/papi/vpp_papi_provider.py'
+    RESOURCES_PAPI_PROVIDER = u"resources/tools/papi/vpp_papi_provider.py"
 
     # vat templates location
-    RESOURCES_TPL_VAT = 'resources/templates/vat'
+    RESOURCES_TPL_VAT = u"resources/templates/vat"
 
     # Kubernetes templates location
-    RESOURCES_TPL_K8S = 'resources/templates/kubernetes'
+    RESOURCES_TPL_K8S = u"resources/templates/kubernetes"
 
     # KernelVM templates location
-    RESOURCES_TPL_VM = 'resources/templates/vm'
+    RESOURCES_TPL_VM = u"resources/templates/vm"
 
     # Container templates location
-    RESOURCES_TPL_CONTAINER = 'resources/templates/container'
+    RESOURCES_TPL_CONTAINER = u"resources/templates/container"
 
     # HTTP Server www root directory
-    RESOURCES_TP_WRK_WWW = 'resources/traffic_profiles/wrk/www'
+    RESOURCES_TP_WRK_WWW = u"resources/traffic_profiles/wrk/www"
 
     # OpenVPP VAT binary name
-    VAT_BIN_NAME = 'vpp_api_test'
+    VAT_BIN_NAME = u"vpp_api_test"
 
     # VPP service unit name
-    VPP_UNIT = 'vpp'
+    VPP_UNIT = u"vpp"
 
     # Number of system CPU cores.
     CPU_CNT_SYSTEM = 1
@@ -164,120 +164,122 @@ class Constants(object):
     CPU_CNT_MAIN = 1
 
     # QEMU binary path
-    QEMU_BIN_PATH = '/usr/bin'
+    QEMU_BIN_PATH = u"/usr/bin"
 
     # QEMU VM kernel image path
-    QEMU_VM_KERNEL = '/opt/boot/vmlinuz'
+    QEMU_VM_KERNEL = u"/opt/boot/vmlinuz"
 
     # QEMU VM kernel initrd path
-    QEMU_VM_KERNEL_INITRD = '/opt/boot/initrd.img'
+    QEMU_VM_KERNEL_INITRD = u"/opt/boot/initrd.img"
 
     # QEMU VM nested image path
-    QEMU_VM_IMAGE = '/var/lib/vm/vhost-nested.img'
+    QEMU_VM_IMAGE = u"/var/lib/vm/vhost-nested.img"
 
     # QEMU VM DPDK path
-    QEMU_VM_DPDK = '/opt/dpdk-19.02'
+    QEMU_VM_DPDK = u"/opt/dpdk-19.02"
 
     # Docker container SUT image
-    DOCKER_SUT_IMAGE_UBUNTU = 'snergster/csit-sut:latest'
+    DOCKER_SUT_IMAGE_UBUNTU = u"snergster/csit-sut:latest"
 
     # Docker container arm SUT image
-    DOCKER_SUT_IMAGE_UBUNTU_ARM = 'snergster/csit-arm-sut:latest'
+    DOCKER_SUT_IMAGE_UBUNTU_ARM = u"snergster/csit-arm-sut:latest"
 
     # TRex install directory
-    TREX_INSTALL_DIR = '/opt/trex-core-2.61'
+    TREX_INSTALL_DIR = u"/opt/trex-core-2.61"
 
     # Sysctl kernel.core_pattern
-    KERNEL_CORE_PATTERN = '/tmp/%p-%u-%g-%s-%t-%h-%e.core'
+    KERNEL_CORE_PATTERN = u"/tmp/%p-%u-%g-%s-%t-%h-%e.core"
 
     # Core dump directory
-    CORE_DUMP_DIR = '/tmp'
+    CORE_DUMP_DIR = u"/tmp"
 
     # Equivalent to ~0 used in vpp code
     BITWISE_NON_ZERO = 0xffffffff
 
     # Default path to VPP API socket.
-    SOCKSVR_PATH = "/run/vpp/api.sock"
+    SOCKSVR_PATH = u"/run/vpp/api.sock"
 
     # Number of trials to execute in MRR test.
-    PERF_TRIAL_MULTIPLICITY = get_int_from_env("PERF_TRIAL_MULTIPLICITY", 10)
+    PERF_TRIAL_MULTIPLICITY = get_int_from_env(u"PERF_TRIAL_MULTIPLICITY", 10)
 
     # Duration of one trial in MRR test.
-    PERF_TRIAL_DURATION = get_float_from_env("PERF_TRIAL_DURATION", 1.0)
+    PERF_TRIAL_DURATION = get_float_from_env(u"PERF_TRIAL_DURATION", 1.0)
 
     # UUID string of DUT1 /tmp volume created outside of the
     # DUT1 docker in case of vpp-device test. ${EMPTY} value means that
     #  /tmp directory is inside the DUT1 docker.
-    DUT1_UUID = get_str_from_env("DUT1_UUID", "")
+    DUT1_UUID = get_str_from_env(u"DUT1_UUID", u"")
 
     # Default path to VPP API Stats socket.
-    SOCKSTAT_PATH = "/run/vpp/stats.sock"
+    SOCKSTAT_PATH = u"/run/vpp/stats.sock"
 
     # Global "kill switch" for CRC checking during runtime.
-    FAIL_ON_CRC_MISMATCH = get_pessimistic_bool_from_env("FAIL_ON_CRC_MISMATCH")
+    FAIL_ON_CRC_MISMATCH = get_pessimistic_bool_from_env(
+        u"FAIL_ON_CRC_MISMATCH"
+    )
 
     # Mapping from NIC name to its bps limit.
     NIC_NAME_TO_BPS_LIMIT = {
-        "Cisco-VIC-1227": 10000000000,
-        "Cisco-VIC-1385": 24500000000,
-        "Intel-X520-DA2": 10000000000,
-        "Intel-X553": 10000000000,
-        "Intel-X710": 10000000000,
-        "Intel-XL710": 24500000000,
-        "Intel-XXV710": 24500000000,
-        "Mellanox-CX556A": 100000000000,
-        "virtual": 100000000,
+        u"Cisco-VIC-1227": 10000000000,
+        u"Cisco-VIC-1385": 24500000000,
+        u"Intel-X520-DA2": 10000000000,
+        u"Intel-X553": 10000000000,
+        u"Intel-X710": 10000000000,
+        u"Intel-XL710": 24500000000,
+        u"Intel-XXV710": 24500000000,
+        u"Mellanox-CX556A": 100000000000,
+        u"virtual": 100000000,
     }
 
     # Mapping from NIC name to its pps limit.
     NIC_NAME_TO_PPS_LIMIT = {
-        "Cisco-VIC-1227": 14880952,
-        "Cisco-VIC-1385": 18750000,
-        "Intel-X520-DA2": 14880952,
-        "Intel-X553": 14880952,
-        "Intel-X710": 14880952,
-        "Intel-XL710": 18750000,
-        "Intel-XXV710": 18750000,
-        "Mellanox-CX556A": 60000000, #148809523,
-        "virtual": 14880952,
+        u"Cisco-VIC-1227": 14880952,
+        u"Cisco-VIC-1385": 18750000,
+        u"Intel-X520-DA2": 14880952,
+        u"Intel-X553": 14880952,
+        u"Intel-X710": 14880952,
+        u"Intel-XL710": 18750000,
+        u"Intel-XXV710": 18750000,
+        u"Mellanox-CX556A": 60000000, # 148809523,
+        u"virtual": 14880952,
     }
 
     # Suite file names use codes for NICs.
     NIC_NAME_TO_CODE = {
-        "Cisco-VIC-1227": "10ge2p1vic1227",
-        "Cisco-VIC-1385": "40ge2p1vic1385",
-        "Intel-X520-DA2": "10ge2p1x520",
-        "Intel-X553": "10ge2p1x553",
-        "Intel-X710": "10ge2p1x710",
-        "Intel-XL710": "40ge2p1xl710",
-        "Intel-XXV710": "25ge2p1xxv710",
-        "Mellanox-CX556A": "100ge2p1cx556a",
+        u"Cisco-VIC-1227": u"10ge2p1vic1227",
+        u"Cisco-VIC-1385": u"40ge2p1vic1385",
+        u"Intel-X520-DA2": u"10ge2p1x520",
+        u"Intel-X553": u"10ge2p1x553",
+        u"Intel-X710": u"10ge2p1x710",
+        u"Intel-XL710": u"40ge2p1xl710",
+        u"Intel-XXV710": u"25ge2p1xxv710",
+        u"Mellanox-CX556A": u"100ge2p1cx556a",
     }
 
     # TODO CSIT-1481: Crypto HW should be read from topology file instead.
     NIC_NAME_TO_CRYPTO_HW = {
-        "Intel-X553": "HW_C3xxx",
-        "Intel-X710": "HW_DH895xcc",
-        "Intel-XL710": "HW_DH895xcc",
+        u"Intel-X553": u"HW_C3xxx",
+        u"Intel-X710": u"HW_DH895xcc",
+        u"Intel-XL710": u"HW_DH895xcc",
     }
 
     PERF_TYPE_TO_KEYWORD = {
-        "mrr": "Traffic should pass with maximum rate",
-        "ndrpdr": "Find NDR and PDR intervals using optimized search",
-        "soak": "Find critical load using PLRsearch",
+        u"mrr": u"Traffic should pass with maximum rate",
+        u"ndrpdr": u"Find NDR and PDR intervals using optimized search",
+        u"soak": u"Find critical load using PLRsearch",
     }
 
     PERF_TYPE_TO_SUITE_DOC_VER = {
-        "mrr" : '''fication:* In MaxReceivedRate tests TG sends traffic\\
+        u"mrr": u'''fication:* In MaxReceivedRate tests TG sends traffic\\
 | ... | at line rate and reports total received packets over trial period.\\''',
         # TODO: Figure out how to include the full "*[Ver] TG verification:*"
         # while keeping this readable and without breaking line length limit.
-        "ndrpdr": '''fication:* TG finds and reports throughput NDR (Non Drop\\
+        u"ndrpdr": u'''ication:* TG finds and reports throughput NDR (Non Drop\\
 | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
 | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
 | ... | of packets transmitted. NDR and PDR are discovered for different\\
 | ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
-        "soak": '''fication:* TG sends traffic at dynamically computed\\
+        u"soak": u'''fication:* TG sends traffic at dynamically computed\\
 | ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
 | ... | of a rate at which a prescribed small fraction of packets\\
 | ... | would be lost. After set time, the serarch stops\\
@@ -285,9 +287,8 @@ class Constants(object):
     }
 
     PERF_TYPE_TO_TEMPLATE_DOC_VER = {
-        "mrr": '''Measure MaxReceivedRate for ${frame_size}B frames\\
+        u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames\\
 | | ... | using burst trials throughput test.\\''',
-        "ndrpdr": '''Measure NDR and PDR values using MLRsearch algorithm.\\''',
-        "soak": '''Estimate critical rate using PLRsearch algorithm.\\''',
+        u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.\\",
+        u"soak": u"Estimate critical rate using PLRsearch algorithm.\\",
     }
-