From c2802be5588eeda19d59e16c4a10ed2412130ef7 Mon Sep 17 00:00:00 2001 From: Jacob Boddey Date: Thu, 20 Apr 2023 17:49:55 +0100 Subject: [PATCH 1/3] Load in devices --- etc/requirements.txt | 3 +- framework/device.py | 6 +++ framework/run.py | 1 + framework/testrun.py | 47 +++++++++++++++++++ .../Teltonika TRB140/device_config.json | 5 ++ test_orc/python/src/test_orchestrator.py | 0 6 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 framework/device.py create mode 100644 local/devices/Teltonika TRB140/device_config.json create mode 100644 test_orc/python/src/test_orchestrator.py diff --git a/etc/requirements.txt b/etc/requirements.txt index 56b8f0f66..979b408bd 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -1 +1,2 @@ -netifaces \ No newline at end of file +netifaces +scapy \ No newline at end of file diff --git a/framework/device.py b/framework/device.py new file mode 100644 index 000000000..b5c00061c --- /dev/null +++ b/framework/device.py @@ -0,0 +1,6 @@ +class Device: + + def __init__(self, make, model, mac_addr = None): + self.make = make + self.model = model + self.mac_addr = mac_addr diff --git a/framework/run.py b/framework/run.py index ad7c038ee..568b267f4 100644 --- a/framework/run.py +++ b/framework/run.py @@ -3,3 +3,4 @@ from testrun import TestRun testrun = TestRun() +testrun.start() diff --git a/framework/testrun.py b/framework/testrun.py index 225bed853..1a7fc96e2 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -12,6 +12,7 @@ import json import signal import time +from device import Device import logger # Locate parent directory @@ -23,12 +24,19 @@ sys.path.append(net_orc_dir) import network_orchestrator as net_orc # pylint: disable=wrong-import-position +from listener import NetworkEvent # pylint: disable=wrong-import-position LOGGER = logger.get_logger('test_run') CONFIG_FILE = "conf/system.json" EXAMPLE_CONFIG_FILE = "conf/system.json.example" RUNTIME = 300 +DEVICES_DIR = 'local/devices' +DEVICE_CONFIG = 'device_config.json' +DEVICE_MAKE = 'make' +DEVICE_MODEL = 'model' +DEVICE_MAC_ADDR = 'mac_addr' + class TestRun: # pylint: disable=too-few-public-methods """Test Run controller. @@ -39,11 +47,21 @@ class TestRun: # pylint: disable=too-few-public-methods def __init__(self): LOGGER.info("Starting Test Run") + self._devices = [] + + def start(self): + # Catch any exit signals self._register_exits() + self._load_devices() + self._start_network() + # Register callbacks + self._net_orc.listener.register_callback(self._device_discovered, + [NetworkEvent.DEVICE_DISCOVERED]) + # Keep application running time.sleep(RUNTIME) @@ -96,3 +114,32 @@ def _stop_network(self): self._net_orc.stop_networking_services(kill=True) self._net_orc.restore_net() sys.exit(0) + + def _load_devices(self): + LOGGER.debug('Loading devices from ' + DEVICES_DIR) + + for device_folder in os.listdir(DEVICES_DIR): + with open(os.path.join(DEVICES_DIR, device_folder, DEVICE_CONFIG), + encoding='utf-8') as device_config_file: + device_config_json = json.load(device_config_file) + + device_make = device_config_json[DEVICE_MAKE] + device_model = device_config_json[DEVICE_MODEL] + mac_addr = device_config_json[DEVICE_MAC_ADDR] + + device = Device(device_make, device_model, mac_addr = mac_addr) + self._devices.append(device) + + LOGGER.info("Loaded " + str(len(self._devices)) + " devices") + + def get_device(self, mac_addr): + for device in self._devices: + if device.mac_addr == mac_addr: + return device + + def _device_discovered(self, mac_addr): + device = self.get_device(mac_addr) + if device is not None: + LOGGER.info("Discovered " + device.make + " " + device.model + " on the network") + else: + LOGGER.info("A new device has been discovered with mac address " + mac_addr) diff --git a/local/devices/Teltonika TRB140/device_config.json b/local/devices/Teltonika TRB140/device_config.json new file mode 100644 index 000000000..759c1e9b4 --- /dev/null +++ b/local/devices/Teltonika TRB140/device_config.json @@ -0,0 +1,5 @@ +{ + "make": "Teltonika", + "model": "TRB140", + "mac_addr": "00:1e:42:35:73:c4" +} \ No newline at end of file diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py new file mode 100644 index 000000000..e69de29bb From a970839a573f6c10bfb25fea1585a7080edbfcfb Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Tue, 25 Apr 2023 10:50:18 -0600 Subject: [PATCH 2/3] Change method name to be more inline with its function --- framework/testrun.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/testrun.py b/framework/testrun.py index b7269f4eb..df02f7ca4 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -44,7 +44,7 @@ def __init__(self, local_net=True): self._register_exits() # Import the correct net orchestrator - self.import_orchestrators(local_net) + self.import_dependencies(local_net) self._net_orc = net_orc.NetworkOrchestrator() self._test_orc = test_orc.TestOrchestrator() @@ -59,7 +59,7 @@ def start(self): self._net_orc.listener.register_callback(self._device_discovered, [NetworkEvent.DEVICE_DISCOVERED]) - def import_orchestrators(self, local_net=True): + def import_dependencies(self, local_net=True): if local_net: # Add local net_orc to Python path net_orc_dir = os.path.join(parent_dir, 'net_orc', 'python', 'src') From d27e1a59e852e97ca27ed01ae450ccfd72668bf5 Mon Sep 17 00:00:00 2001 From: Jacob Boddey Date: Wed, 26 Apr 2023 11:11:16 +0100 Subject: [PATCH 3/3] Refactor --- .pylintrc | 429 +++++++++++++++++++++++++++++++++++++++++++ framework/device.py | 12 +- framework/testrun.py | 291 +++++++++++++++-------------- 3 files changed, 586 insertions(+), 146 deletions(-) create mode 100644 .pylintrc diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 000000000..4e89b0c10 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,429 @@ +# This Pylint rcfile contains a best-effort configuration to uphold the +# best-practices and style described in the Google Python style guide: +# https://google.github.io/styleguide/pyguide.html +# +# Its canonical open-source location is: +# https://google.github.io/styleguide/pylintrc + +[MASTER] + +# Files or directories to be skipped. They should be base names, not paths. +ignore=third_party + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# Pickle collected data for later comparisons. +persistent=no + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Use multiple processes to speed up Pylint. +jobs=4 + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +#enable= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +disable=abstract-method, + apply-builtin, + arguments-differ, + attribute-defined-outside-init, + backtick, + bad-option-value, + basestring-builtin, + buffer-builtin, + c-extension-no-member, + consider-using-enumerate, + cmp-builtin, + cmp-method, + coerce-builtin, + coerce-method, + delslice-method, + div-method, + duplicate-code, + eq-without-hash, + execfile-builtin, + file-builtin, + filter-builtin-not-iterating, + fixme, + getslice-method, + global-statement, + hex-method, + idiv-method, + implicit-str-concat, + import-error, + import-self, + import-star-module-level, + inconsistent-return-statements, + input-builtin, + intern-builtin, + invalid-str-codec, + locally-disabled, + long-builtin, + long-suffix, + map-builtin-not-iterating, + misplaced-comparison-constant, + missing-function-docstring, + metaclass-assignment, + next-method-called, + next-method-defined, + no-absolute-import, + no-else-break, + no-else-continue, + no-else-raise, + no-else-return, + no-init, # added + no-member, + no-name-in-module, + no-self-use, + nonzero-method, + oct-method, + old-division, + old-ne-operator, + old-octal-literal, + old-raise-syntax, + parameter-unpacking, + print-statement, + raising-string, + range-builtin-not-iterating, + raw_input-builtin, + rdiv-method, + reduce-builtin, + relative-import, + reload-builtin, + round-builtin, + setslice-method, + signature-differs, + standarderror-builtin, + suppressed-message, + sys-max-int, + too-few-public-methods, + too-many-ancestors, + too-many-arguments, + too-many-boolean-expressions, + too-many-branches, + too-many-instance-attributes, + too-many-locals, + too-many-nested-blocks, + too-many-public-methods, + too-many-return-statements, + too-many-statements, + trailing-newlines, + unichr-builtin, + unicode-builtin, + unnecessary-pass, + unpacking-in-except, + useless-else-on-loop, + useless-object-inheritance, + useless-suppression, + using-cmp-argument, + wrong-import-order, + xrange-builtin, + zip-builtin-not-iterating, + + +[REPORTS] + +# Set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html. You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + + +[BASIC] + +# Good variable names which should always be accepted, separated by a comma +good-names=main,_ + +# Bad variable names which should always be refused, separated by a comma +bad-names= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl + +# Regular expression matching correct function names +function-rgx=^(?:(?PsetUp|tearDown|setUpModule|tearDownModule)|(?P_?[A-Z][a-zA-Z0-9]*)|(?P_?[a-z][a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct constant names +const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression matching correct attribute names +attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ + +# Regular expression matching correct argument names +argument-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct class names +class-rgx=^_?[A-Z][a-zA-Z0-9]*$ + +# Regular expression matching correct module names +module-rgx=^(_?[a-z][a-z0-9_]*|__init__)$ + +# Regular expression matching correct method names +method-rgx=(?x)^(?:(?P_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P_{0,2}[a-z][a-z0-9_]*))$ + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=(__.*__|main|test.*|.*test|.*Test)$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=10 + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + + +[FORMAT] + +# Maximum number of characters on a single line. +max-line-length=80 + +# TODO(https://github.com/PyCQA/pylint/issues/3352): Direct pylint to exempt +# lines made too long by directives to pytype. + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=(?x)( + ^\s*(\#\ )??$| + ^\s*(from\s+\S+\s+)?import\s+.+$) + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=yes + +# Maximum number of lines in a module +max-module-lines=99999 + +# String used as indentation unit. The internal Google style guide mandates 2 +# spaces. Google's externaly-published style guide says 4, consistent with +# PEP 8. Here, we use 2 spaces, for conformity with many open-sourced Google +# projects (like TensorFlow). +indent-string=' ' + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=TODO + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=yes + + +[VARIABLES] + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six,six.moves,past.builtins,future.builtins,functools + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging,absl.logging,tensorflow.io.logging + + +[SIMILARITIES] + +# Minimum lines number of a similarity. +min-similarity-lines=4 + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[IMPORTS] + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub, + TERMIOS, + Bastion, + rexec, + sets + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant, absl + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls, + class_ + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=StandardError, + Exception, + BaseException \ No newline at end of file diff --git a/framework/device.py b/framework/device.py index b5c00061c..08014c127 100644 --- a/framework/device.py +++ b/framework/device.py @@ -1,6 +1,10 @@ +"""Track device object information.""" +from dataclasses import dataclass + +@dataclass class Device: + """Represents a physical device and it's configuration.""" - def __init__(self, make, model, mac_addr = None): - self.make = make - self.model = model - self.mac_addr = mac_addr + make: str + model: str + mac_addr: str diff --git a/framework/testrun.py b/framework/testrun.py index df02f7ca4..372a64692 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -19,8 +19,8 @@ parent_dir = os.path.dirname(current_dir) LOGGER = logger.get_logger('test_run') -CONFIG_FILE = "conf/system.json" -EXAMPLE_CONFIG_FILE = "conf/system.json.example" +CONFIG_FILE = 'conf/system.json' +EXAMPLE_CONFIG_FILE = 'conf/system.json.example' RUNTIME = 300 DEVICES_DIR = 'local/devices' @@ -31,143 +31,150 @@ class TestRun: # pylint: disable=too-few-public-methods - """Test Run controller. - - Creates an instance of the network orchestrator, test - orchestrator and user interface. - """ - - def __init__(self, local_net=True): - self._devices = [] - - # Catch any exit signals - self._register_exits() - - # Import the correct net orchestrator - self.import_dependencies(local_net) - - self._net_orc = net_orc.NetworkOrchestrator() - self._test_orc = test_orc.TestOrchestrator() - - def start(self): - - self._load_devices() - - self.start_network() - - # Register callbacks - self._net_orc.listener.register_callback(self._device_discovered, - [NetworkEvent.DEVICE_DISCOVERED]) - - def import_dependencies(self, local_net=True): - if local_net: - # Add local net_orc to Python path - net_orc_dir = os.path.join(parent_dir, 'net_orc', 'python', 'src') - else: - # Resolve the path to the test-run parent folder - root_dir = os.path.abspath(os.path.join(parent_dir, os.pardir)) - # Add manually cloned network orchestrator from parent folder - net_orc_dir = os.path.join( - root_dir, 'network-orchestrator', 'python', 'src') - # Add net_orc to Python path - sys.path.append(net_orc_dir) - # Import the network orchestrator - global net_orc - import network_orchestrator as net_orc # pylint: disable=wrong-import-position,import-outside-toplevel - - # Add test_orc to Python path - test_orc_dir = os.path.join(parent_dir, 'test_orc', 'python', 'src') - sys.path.append(test_orc_dir) - global test_orc - import test_orchestrator as test_orc # pylint: disable=wrong-import-position,import-outside-toplevel - - global NetworkEvent - from listener import NetworkEvent # pylint: disable=wrong-import-position,import-outside-toplevel - - def _register_exits(self): - signal.signal(signal.SIGINT, self._exit_handler) - signal.signal(signal.SIGTERM, self._exit_handler) - signal.signal(signal.SIGABRT, self._exit_handler) - signal.signal(signal.SIGQUIT, self._exit_handler) - - def _exit_handler(self, signum, arg): # pylint: disable=unused-argument - LOGGER.debug("Exit signal received: " + str(signum)) - if signum in (2, signal.SIGTERM): - LOGGER.info("Exit signal received.") - self.stop_network() - - def load_config(self): - """Loads all settings from the config file into memory.""" - if not os.path.isfile(CONFIG_FILE): - LOGGER.error("Configuration file is not present at " + CONFIG_FILE) - LOGGER.info("An example is present in " + EXAMPLE_CONFIG_FILE) - sys.exit(1) - - with open(CONFIG_FILE, 'r', encoding='UTF-8') as config_file_open: - config_json = json.load(config_file_open) - self._net_orc.import_config(config_json) - self._test_orc.import_config(config_json) - - def start_network(self): - """Starts the network orchestrator and network services.""" - - # Load and build any unbuilt network containers - self._net_orc.load_network_modules() - self._net_orc.build_network_modules() - - self._net_orc.stop_networking_services(kill=True) - self._net_orc.restore_net() - - # Create baseline network - self._net_orc.create_net() - - # Launch network service containers - self._net_orc.start_network_services() - - LOGGER.info("Network is ready.") - - def run_tests(self): - """Iterate through and start all test modules.""" - - self._test_orc.load_test_modules() - self._test_orc.build_test_modules() - - # Begin testing - self._test_orc.run_test_modules() - - def stop_network(self): - """Commands the net_orc to stop the network and clean up.""" - self._net_orc.stop_networking_services(kill=True) - self._net_orc.restore_net() - sys.exit(0) - - def _load_devices(self): - LOGGER.debug('Loading devices from ' + DEVICES_DIR) - - for device_folder in os.listdir(DEVICES_DIR): - with open(os.path.join(DEVICES_DIR, device_folder, DEVICE_CONFIG), - encoding='utf-8') as device_config_file: - device_config_json = json.load(device_config_file) - - device_make = device_config_json[DEVICE_MAKE] - device_model = device_config_json[DEVICE_MODEL] - mac_addr = device_config_json[DEVICE_MAC_ADDR] - - device = Device(device_make, device_model, mac_addr=mac_addr) - self._devices.append(device) - - LOGGER.info("Loaded " + str(len(self._devices)) + " devices") - - def get_device(self, mac_addr): - for device in self._devices: - if device.mac_addr == mac_addr: - return device - - def _device_discovered(self, mac_addr): - device = self.get_device(mac_addr) - if device is not None: - LOGGER.info("Discovered " + device.make + " " + - device.model + " on the network") - else: - LOGGER.info( - "A new device has been discovered with mac address " + mac_addr) + """Test Run controller. + + Creates an instance of the network orchestrator, test + orchestrator and user interface. + """ + + def __init__(self, local_net=True): + self._devices = [] + + # Catch any exit signals + self._register_exits() + + # Import the correct net orchestrator + self.import_dependencies(local_net) + + self._net_orc = net_orc.NetworkOrchestrator() + self._test_orc = test_orc.TestOrchestrator() + + def start(self): + + self._load_devices() + + self.start_network() + + # Register callbacks + self._net_orc.listener.register_callback( + self._device_discovered, + [NetworkEvent.DEVICE_DISCOVERED]) + + def import_dependencies(self, local_net=True): + """Imports both net and test orchestrators from relevant directories.""" + if local_net: + # Add local net_orc to Python path + net_orc_dir = os.path.join( + parent_dir, 'net_orc', 'python', 'src') + else: + # Resolve the path to the test-run parent folder + root_dir = os.path.abspath(os.path.join(parent_dir, os.pardir)) + # Add manually cloned network orchestrator from parent folder + net_orc_dir = os.path.join( + root_dir, 'network-orchestrator', 'python', 'src') + # Add net_orc to Python path + sys.path.append(net_orc_dir) + # Import the network orchestrator + global net_orc + import network_orchestrator as net_orc # pylint: disable=wrong-import-position,import-outside-toplevel + + # Add test_orc to Python path + test_orc_dir = os.path.join( + parent_dir, 'test_orc', 'python', 'src') + sys.path.append(test_orc_dir) + global test_orc + import test_orchestrator as test_orc # pylint: disable=wrong-import-position,import-outside-toplevel + + global NetworkEvent + from listener import NetworkEvent # pylint: disable=wrong-import-position,import-outside-toplevel + + def _register_exits(self): + signal.signal(signal.SIGINT, self._exit_handler) + signal.signal(signal.SIGTERM, self._exit_handler) + signal.signal(signal.SIGABRT, self._exit_handler) + signal.signal(signal.SIGQUIT, self._exit_handler) + + def _exit_handler(self, signum, arg): # pylint: disable=unused-argument + LOGGER.debug('Exit signal received: ' + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info('Exit signal received.') + self.stop_network() + + def load_config(self): + """Loads all settings from the config file into memory.""" + if not os.path.isfile(CONFIG_FILE): + LOGGER.error( + 'Configuration file is not present at ' + CONFIG_FILE) + LOGGER.info('An example is present in ' + EXAMPLE_CONFIG_FILE) + sys.exit(1) + + with open(CONFIG_FILE, 'r', encoding='UTF-8') as config_file_open: + config_json = json.load(config_file_open) + self._net_orc.import_config(config_json) + self._test_orc.import_config(config_json) + + def start_network(self): + """Starts the network orchestrator and network services.""" + + # Load and build any unbuilt network containers + self._net_orc.load_network_modules() + self._net_orc.build_network_modules() + + self._net_orc.stop_networking_services(kill=True) + self._net_orc.restore_net() + + # Create baseline network + self._net_orc.create_net() + + # Launch network service containers + self._net_orc.start_network_services() + + LOGGER.info('Network is ready.') + + def run_tests(self): + """Iterate through and start all test modules.""" + self._test_orc.load_test_modules() + self._test_orc.build_test_modules() + + # Begin testing + self._test_orc.run_test_modules() + + def stop_network(self): + """Commands the net_orc to stop the network and clean up.""" + self._net_orc.stop_networking_services(kill=True) + self._net_orc.restore_net() + sys.exit(0) + + def _load_devices(self): + LOGGER.debug('Loading devices from ' + DEVICES_DIR) + + for device_folder in os.listdir(DEVICES_DIR): + with open(os.path.join(DEVICES_DIR, device_folder, DEVICE_CONFIG), + encoding='utf-8') as device_config_file: + device_config_json = json.load(device_config_file) + + device_make = device_config_json.get(DEVICE_MAKE) + device_model = device_config_json.get(DEVICE_MODEL) + mac_addr = device_config_json.get(DEVICE_MAC_ADDR) + + device = Device(device_make, device_model, + mac_addr=mac_addr) + self._devices.append(device) + + LOGGER.info('Loaded ' + str(len(self._devices)) + ' devices') + + def get_device(self, mac_addr): + """Returns a loaded device object from the device mac address.""" + for device in self._devices: + if device.mac_addr == mac_addr: + return device + return None + + def _device_discovered(self, mac_addr): + device = self.get_device(mac_addr) + if device is not None: + LOGGER.info( + f'Discovered {device.make} {device.model} on the network') + else: + LOGGER.info( + f'A new device has been discovered with mac address {device.mac_addr}')