Rename to Constants.py 75/17875/5
authorVratko Polak <vrpolak@cisco.com>
Tue, 26 Feb 2019 14:46:02 +0000 (15:46 +0100)
committerVratko Polak <vrpolak@cisco.com>
Mon, 4 Mar 2019 14:16:44 +0000 (14:16 +0000)
Motivation: Make the constants available also for Robot.
Restraint: Robotframework user guide says:
  Because variable files are always imported using a file system path,
  creating them as classes has some restrictions:
    Python classes must have the same name as the module they are located.

Change-Id: I638ef3fe045db132e366de2e2699638b8637e45e
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
27 files changed:
docs/test_code_guidelines.rst
resources/libraries/python/Constants.py [moved from resources/libraries/python/constants.py with 91% similarity]
resources/libraries/python/ContainerUtils.py
resources/libraries/python/CoreDumpUtil.py
resources/libraries/python/DPDK/DPDKTools.py
resources/libraries/python/DPDK/L2fwdTest.py
resources/libraries/python/DPDK/L3fwdTest.py
resources/libraries/python/DUTSetup.py
resources/libraries/python/IPUtil.py
resources/libraries/python/IPv6Setup.py
resources/libraries/python/KubernetesUtils.py
resources/libraries/python/PapiExecutor.py
resources/libraries/python/QemuUtils.py
resources/libraries/python/SFC/SFCTest.py
resources/libraries/python/SFC/SetupSFCTest.py
resources/libraries/python/SetupFramework.py
resources/libraries/python/TrafficGenerator.py
resources/libraries/python/TrafficScriptExecutor.py
resources/libraries/python/VPPUtil.py
resources/libraries/python/VatExecutor.py
resources/libraries/python/VppConfigGenerator.py
resources/libraries/python/honeycomb/BGP.py
resources/libraries/python/honeycomb/HcPersistence.py
resources/libraries/python/honeycomb/HoneycombSetup.py
resources/libraries/python/honeycomb/HoneycombUtil.py
resources/libraries/python/honeycomb/Performance.py
resources/tools/wrk/wrk.py

index b455c92..24544b9 100644 (file)
@@ -284,7 +284,7 @@ and unrelated ones such as PAL) if there are any (in addition to library ones).
 
   + It is NOT RECOMMENDED to use hard-coded constants (e.g. numbers,
     paths without any description). It is RECOMMENDED to use
 
   + It is NOT RECOMMENDED to use hard-coded constants (e.g. numbers,
     paths without any description). It is RECOMMENDED to use
-    configuration file(s), like /csit/resources/libraries/python/constants.py,
+    configuration file(s), like /csit/resources/libraries/python/Constants.py,
     with appropriate comments.
 
   + The code SHALL log at the lowest possible level of implementation,
     with appropriate comments.
 
   + The code SHALL log at the lowest possible level of implementation,
similarity index 91%
rename from resources/libraries/python/constants.py
rename to resources/libraries/python/Constants.py
index b4a9669..b89f50c 100644 (file)
 
 
 class Constants(object):
 
 
 class Constants(object):
-    """Constants used in CSIT."""
+    """Constants used in CSIT.
+
+    TODO: Yaml files are easier for humans to edit.
+    Figure out how to set the attributes by parsing a file
+    that works regardless of current working directory.
+    """
 
     # OpenVPP testing directory location at topology nodes
     REMOTE_FW_DIR = '/tmp/openvpp-testing'
 
     # OpenVPP testing directory location at topology nodes
     REMOTE_FW_DIR = '/tmp/openvpp-testing'
index 9c42a3c..1530657 100644 (file)
@@ -19,7 +19,7 @@
 from collections import OrderedDict, Counter
 
 from resources.libraries.python.ssh import SSH
 from collections import OrderedDict, Counter
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.topology import Topology
 from resources.libraries.python.VppConfigGenerator import VppConfigGenerator
 
 from resources.libraries.python.topology import Topology
 from resources.libraries.python.VppConfigGenerator import VppConfigGenerator
 
index ea79124..9fd8b24 100644 (file)
@@ -15,7 +15,7 @@
 
 from time import time
 
 
 from time import time
 
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.LimitUtil import LimitUtil
 from resources.libraries.python.SysctlUtil import SysctlUtil
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.LimitUtil import LimitUtil
 from resources.libraries.python.SysctlUtil import SysctlUtil
index ec70b40..25d2217 100644 (file)
@@ -15,7 +15,7 @@
 """This module implements initialization and cleanup of DPDK environment."""
 
 from resources.libraries.python.ssh import SSH
 """This module implements initialization and cleanup of DPDK environment."""
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.topology import NodeType, Topology
 
 
 from resources.libraries.python.topology import NodeType, Topology
 
 
index aaa4435..70ca93c 100644 (file)
@@ -16,7 +16,7 @@ DUT nodes.
 """
 
 from resources.libraries.python.ssh import SSH
 """
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.topology import NodeType, Topology
 
 
 from resources.libraries.python.topology import NodeType, Topology
 
 
index 0a22fe6..6230752 100644 (file)
@@ -16,7 +16,7 @@ This module exists to provide the l3fwd test for DPDK on topology nodes.
 """
 
 from resources.libraries.python.ssh import SSH
 """
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.topology import NodeType, Topology
 
 
 from resources.libraries.python.topology import NodeType, Topology
 
 
index 631bff4..69594ef 100644 (file)
@@ -15,7 +15,7 @@
 
 from robot.api import logger
 
 
 from robot.api import logger
 
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.ssh import SSH, exec_cmd_no_error
 from resources.libraries.python.topology import NodeType, Topology
 
 from resources.libraries.python.ssh import SSH, exec_cmd_no_error
 from resources.libraries.python.topology import NodeType, Topology
 
index e215b30..cf7034c 100644 (file)
@@ -18,7 +18,7 @@ import re
 from ipaddress import IPv4Network, ip_address
 
 from resources.libraries.python.ssh import SSH
 from ipaddress import IPv4Network, ip_address
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
 from resources.libraries.python.topology import Topology
 
 from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
 from resources.libraries.python.topology import Topology
 
index 260c08b..72aeb30 100644 (file)
@@ -18,7 +18,7 @@ from robot.api import logger
 
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.topology import NodeType, Topology
 
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.topology import NodeType, Topology
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.VatExecutor import VatTerminal, VatExecutor
 
 
 from resources.libraries.python.VatExecutor import VatTerminal, VatExecutor
 
 
index 7a4784d..c3ebb4c 100644 (file)
@@ -15,7 +15,7 @@
 
 from time import sleep
 
 
 from time import sleep
 
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.ssh import SSH, exec_cmd_no_error
 from resources.libraries.python.CpuUtils import CpuUtils
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.ssh import SSH, exec_cmd_no_error
 from resources.libraries.python.CpuUtils import CpuUtils
index 75bdde0..ad0de27 100644 (file)
@@ -19,7 +19,7 @@ import json
 from paramiko.ssh_exception import SSHException
 from robot.api import logger
 
 from paramiko.ssh_exception import SSHException
 from robot.api import logger
 
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.PapiErrors import PapiInitError, \
     PapiJsonFileError, PapiCommandError, PapiCommandInputError
 # TODO: from resources.libraries.python.PapiHistory import PapiHistory
 from resources.libraries.python.PapiErrors import PapiInitError, \
     PapiJsonFileError, PapiCommandError, PapiCommandInputError
 # TODO: from resources.libraries.python.PapiHistory import PapiHistory
index 037d0de..6fad6ed 100644 (file)
@@ -23,7 +23,7 @@ from distutils.version import StrictVersion
 from robot.api import logger
 
 from resources.libraries.python.ssh import SSH, SSHTimeout
 from robot.api import logger
 
 from resources.libraries.python.ssh import SSH, SSHTimeout
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.topology import NodeType, Topology
 
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.topology import NodeType, Topology
 
index d4f77ba..3794d3a 100644 (file)
@@ -17,7 +17,7 @@ the NSH SFC functional test.
 """
 
 from resources.libraries.python.ssh import SSH
 """
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants as con
+from resources.libraries.python.Constants import Constants as con
 from resources.libraries.python.topology import Topology
 
 
 from resources.libraries.python.topology import Topology
 
 
index 0ba1971..7daf49c 100644 (file)
@@ -26,7 +26,7 @@ from robot.api import logger
 from robot.libraries.BuiltIn import BuiltIn
 
 from resources.libraries.python.ssh import SSH
 from robot.libraries.BuiltIn import BuiltIn
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants as con
+from resources.libraries.python.Constants import Constants as con
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.topology import Topology
 
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.topology import Topology
 
index 46b8597..9b50b90 100644 (file)
@@ -27,7 +27,7 @@ from robot.api import logger
 from robot.libraries.BuiltIn import BuiltIn
 
 from resources.libraries.python.ssh import SSH
 from robot.libraries.BuiltIn import BuiltIn
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants as con
+from resources.libraries.python.Constants import Constants as con
 from resources.libraries.python.topology import NodeType
 
 __all__ = ["SetupFramework"]
 from resources.libraries.python.topology import NodeType
 
 __all__ = ["SetupFramework"]
index 10fee9a..ea587d7 100644 (file)
@@ -17,7 +17,7 @@ from robot.api import logger
 from robot.libraries.BuiltIn import BuiltIn
 
 from .DropRateSearch import DropRateSearch
 from robot.libraries.BuiltIn import BuiltIn
 
 from .DropRateSearch import DropRateSearch
-from .constants import Constants
+from .Constants import Constants
 from .ssh import SSH
 from .topology import NodeType
 from .topology import NodeSubTypeTG
 from .ssh import SSH
 from .topology import NodeType
 from .topology import NodeSubTypeTG
index db5e434..7b5368f 100644 (file)
@@ -13,7 +13,7 @@
 
 """Traffic script executor library."""
 
 
 """Traffic script executor library."""
 
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.ssh import SSH
 
 __all__ = ['TrafficScriptExecutor']
 from resources.libraries.python.ssh import SSH
 
 __all__ = ['TrafficScriptExecutor']
index 82fded3..b3f471a 100644 (file)
@@ -17,7 +17,7 @@ import time
 
 from robot.api import logger
 
 
 from robot.api import logger
 
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.PapiExecutor import PapiExecutor
 from resources.libraries.python.PapiErrors import PapiError
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.PapiExecutor import PapiExecutor
 from resources.libraries.python.PapiErrors import PapiError
index 1f7a6f8..0e40266 100644 (file)
@@ -20,7 +20,7 @@ from paramiko.ssh_exception import SSHException
 from robot.api import logger
 
 from resources.libraries.python.ssh import SSH, SSHTimeout
 from robot.api import logger
 
 from resources.libraries.python.ssh import SSH, SSHTimeout
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.VatHistory import VatHistory
 
 __all__ = ['VatExecutor']
 from resources.libraries.python.VatHistory import VatHistory
 
 __all__ = ['VatExecutor']
index db21875..154e2e9 100644 (file)
@@ -17,7 +17,7 @@ import re
 import time
 
 from resources.libraries.python.ssh import SSH
 import time
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.topology import Topology
 from resources.libraries.python.DUTSetup import DUTSetup
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.topology import Topology
index fa51b87..37a9cb6 100644 (file)
@@ -13,7 +13,7 @@
 
 """Keywords to manipulate BGP configuration using Honeycomb REST API."""
 
 
 """Keywords to manipulate BGP configuration using Honeycomb REST API."""
 
-from resources.libraries.python.constants import Constants as Const
+from resources.libraries.python.Constants import Constants as Const
 from resources.libraries.python.HTTPRequest import HTTPCodes
 from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError
 from resources.libraries.python.honeycomb.HoneycombUtil \
 from resources.libraries.python.HTTPRequest import HTTPCodes
 from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError
 from resources.libraries.python.honeycomb.HoneycombUtil \
index ffa850f..1627375 100644 (file)
@@ -15,7 +15,7 @@
 
 from robot.api import logger
 
 
 from robot.api import logger
 
-from resources.libraries.python.constants import Constants as Const
+from resources.libraries.python.Constants import Constants as Const
 from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.topology import NodeType
index 4505074..b4617eb 100644 (file)
@@ -22,7 +22,7 @@ from robot.api import logger
 
 from resources.libraries.python.HTTPRequest import HTTPRequest, HTTPCodes, \
     HTTPRequestError
 
 from resources.libraries.python.HTTPRequest import HTTPRequest, HTTPCodes, \
     HTTPRequestError
-from resources.libraries.python.constants import Constants as Const
+from resources.libraries.python.Constants import Constants as Const
 from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
 from resources.libraries.python.honeycomb.HoneycombUtil \
     import HoneycombUtil as HcUtil
 from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
 from resources.libraries.python.honeycomb.HoneycombUtil \
     import HoneycombUtil as HcUtil
index 52670b5..59483f4 100644 (file)
@@ -29,7 +29,7 @@ from robot.api import logger
 
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.HTTPRequest import HTTPRequest
 
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.HTTPRequest import HTTPRequest
-from resources.libraries.python.constants import Constants as Const
+from resources.libraries.python.Constants import Constants as Const
 
 
 @unique
 
 
 @unique
index 391607f..b81b9fd 100644 (file)
@@ -14,7 +14,7 @@
 """Implementation of keywords for testing Honeycomb performance."""
 
 from resources.libraries.python.ssh import SSH
 """Implementation of keywords for testing Honeycomb performance."""
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants as Const
+from resources.libraries.python.Constants import Constants as Const
 from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
 
 
 from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
 
 
index a891fd6..43355b9 100644 (file)
@@ -24,7 +24,7 @@ from robot.api import logger
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.CpuUtils import CpuUtils
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.CpuUtils import CpuUtils
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 
 from resources.tools.wrk.wrk_traffic_profile_parser import WrkTrafficProfile
 from resources.tools.wrk.wrk_errors import WrkError
 
 from resources.tools.wrk.wrk_traffic_profile_parser import WrkTrafficProfile
 from resources.tools.wrk.wrk_errors import WrkError