From fe10e73eefb1991fe7e7946a4be91f9ec883fffc Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Tue, 25 Apr 2023 08:20:35 -0700 Subject: [PATCH 001/400] Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey --- .gitignore | 134 ++++++++++- cmd/install | 3 +- cmd/start | 8 +- conf/system.json.example | 10 +- framework/logger.py | 45 +++- framework/run.py | 45 +++- framework/testrun.py | 217 +++++++++-------- test_orc/modules/base/base.Dockerfile | 23 ++ test_orc/modules/base/bin/capture | 20 ++ test_orc/modules/base/bin/setup_binaries | 10 + test_orc/modules/base/bin/start_grpc | 17 ++ test_orc/modules/base/bin/start_module | 76 ++++++ test_orc/modules/base/bin/wait_for_interface | 10 + test_orc/modules/base/conf/module_config.json | 12 + test_orc/modules/base/python/requirements.txt | 2 + .../base/python/src/grpc/start_server.py | 34 +++ test_orc/modules/base/python/src/logger.py | 45 ++++ test_orc/modules/baseline/baseline.Dockerfile | 11 + .../modules/baseline/bin/start_test_module | 40 ++++ .../modules/baseline/conf/module_config.json | 21 ++ .../modules/baseline/python/src/logger.py | 46 ++++ test_orc/modules/baseline/python/src/run.py | 50 ++++ .../baseline/python/src/test_module.py | 63 +++++ test_orc/python/requirements.txt | 0 test_orc/python/src/test_orchestrator.py | 221 ++++++++++++++++++ 25 files changed, 1042 insertions(+), 121 deletions(-) create mode 100644 test_orc/modules/base/base.Dockerfile create mode 100644 test_orc/modules/base/bin/capture create mode 100644 test_orc/modules/base/bin/setup_binaries create mode 100644 test_orc/modules/base/bin/start_grpc create mode 100644 test_orc/modules/base/bin/start_module create mode 100644 test_orc/modules/base/bin/wait_for_interface create mode 100644 test_orc/modules/base/conf/module_config.json create mode 100644 test_orc/modules/base/python/requirements.txt create mode 100644 test_orc/modules/base/python/src/grpc/start_server.py create mode 100644 test_orc/modules/base/python/src/logger.py create mode 100644 test_orc/modules/baseline/baseline.Dockerfile create mode 100644 test_orc/modules/baseline/bin/start_test_module create mode 100644 test_orc/modules/baseline/conf/module_config.json create mode 100644 test_orc/modules/baseline/python/src/logger.py create mode 100644 test_orc/modules/baseline/python/src/run.py create mode 100644 test_orc/modules/baseline/python/src/test_module.py create mode 100644 test_orc/python/requirements.txt create mode 100644 test_orc/python/src/test_orchestrator.py diff --git a/.gitignore b/.gitignore index 93fe84e64..4016b6901 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,135 @@ +# Runtime folder +runtime/ venv/ net_orc/ -.vscode/ \ No newline at end of file +.vscode/ + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/cmd/install b/cmd/install index 351eb4129..61722e273 100755 --- a/cmd/install +++ b/cmd/install @@ -2,6 +2,7 @@ GIT_URL=https://github.com/auto-iot NET_ORC_DIR=net_orc +NET_ORC_VERSION="dev" python3 -m venv venv @@ -10,7 +11,7 @@ source venv/bin/activate pip3 install -r etc/requirements.txt rm -rf $NET_ORC_DIR -git clone $GIT_URL/network-orchestrator $NET_ORC_DIR +git clone -b $NET_ORC_VERSION $GIT_URL/network-orchestrator $NET_ORC_DIR chown -R $USER $NET_ORC_DIR pip3 install -r $NET_ORC_DIR/python/requirements.txt diff --git a/cmd/start b/cmd/start index 43a295338..fa6bbc1e1 100755 --- a/cmd/start +++ b/cmd/start @@ -5,6 +5,12 @@ if [[ "$EUID" -ne 0 ]]; then exit 1 fi +# Ensure that /var/run/netns folder exists +mkdir -p /var/run/netns + +# Clear up existing runtime files +rm -rf runtime + # Check if python modules exist. Install if not [ ! -d "venv" ] && cmd/install @@ -12,6 +18,6 @@ fi source venv/bin/activate # TODO: Execute python code -python -u framework/run.py +python -u framework/run.py $@ deactivate \ No newline at end of file diff --git a/conf/system.json.example b/conf/system.json.example index 379545ad6..2d4b737d0 100644 --- a/conf/system.json.example +++ b/conf/system.json.example @@ -1,7 +1,7 @@ { - "network": { - "device_intf": "enx123456789123", - "internet_intf": "enx123456789124" - }, - "log_level": "INFO" + "network": { + "device_intf": "enx123456789123", + "internet_intf": "enx123456789124" + }, + "log_level": "INFO" } \ No newline at end of file diff --git a/framework/logger.py b/framework/logger.py index 25970bd21..64d8fdb97 100644 --- a/framework/logger.py +++ b/framework/logger.py @@ -1,4 +1,4 @@ -"""Manages all things logging.""" +"""Manages stream and file loggers.""" import json import logging import os @@ -6,18 +6,43 @@ LOGGERS = {} _LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" _DATE_FORMAT = '%b %02d %H:%M:%S' -_CONF_DIR="conf" -_CONF_FILE_NAME="system.json" +_DEFAULT_LOG_LEVEL = logging.INFO +_LOG_LEVEL = logging.INFO +_CONF_DIR = "conf" +_CONF_FILE_NAME = "system.json" +_LOG_DIR = "runtime/testing/" -with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='utf-8') as config_file: - system_conf_json = json.load(config_file) - log_level_str = system_conf_json['log_level'] - log_level = logging.getLevelName(log_level_str) +# Set log level +with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='utf-8') as system_conf_file: + system_conf_json = json.load(system_conf_file) +log_level_str = system_conf_json['log_level'] -logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=log_level) +temp_log = logging.getLogger('temp') +try: + temp_log.setLevel(logging.getLevelName(log_level_str)) + _LOG_LEVEL = logging.getLevelName(log_level_str) +except ValueError: + print('Invalid log level set in ' + _CONF_DIR + '/' + _CONF_FILE_NAME + + '. Using INFO as log level') + _LOG_LEVEL = _DEFAULT_LOG_LEVEL -def get_logger(name): - """Returns the logger belonging to the class calling the method.""" +log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) + +def add_file_handler(log, log_file): + handler = logging.FileHandler(_LOG_DIR + log_file + ".log") + handler.setFormatter(log_format) + log.addHandler(handler) + +def add_stream_handler(log): + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + +def get_logger(name, log_file=None): if name not in LOGGERS: LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(_LOG_LEVEL) + add_stream_handler(LOGGERS[name]) + if log_file is not None: + add_file_handler(LOGGERS[name], log_file) return LOGGERS[name] diff --git a/framework/run.py b/framework/run.py index ad7c038ee..d2643d956 100644 --- a/framework/run.py +++ b/framework/run.py @@ -1,5 +1,40 @@ -"""Starts Test Run.""" - -from testrun import TestRun - -testrun = TestRun() +"""Starts Test Run.""" + +import argparse +import sys +from testrun import TestRun +import logger + +LOGGER = logger.get_logger('runner') + +class TestRunner: + + def __init__(self, local_net=True): + + LOGGER.info('Starting Test Run') + + testrun = TestRun(local_net) + + testrun.load_config() + + testrun.start_network() + + testrun.run_tests() + + testrun.stop_network() + + +def run(argv): + parser = argparse.ArgumentParser(description="Test Run", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("-r", "--remote-net", action="store_false", + help='''Use the network orchestrator from the parent directory instead + of the one downloaded locally from the install script.''') + + args, unknown = parser.parse_known_args() + + TestRunner(args.remote_net) + + +if __name__ == "__main__": + run(sys.argv) diff --git a/framework/testrun.py b/framework/testrun.py index 225bed853..22fa0295a 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -1,98 +1,119 @@ -"""The overall control of the Test Run application. - -This file provides the integration between all of the -Test Run components, such as net_orc, test_orc and test_ui. - -Run using the provided command scripts in the cmd folder. -E.g sudo cmd/start -""" - -import os -import sys -import json -import signal -import time -import logger - -# Locate parent directory -current_dir = os.path.dirname(os.path.realpath(__file__)) -parent_dir = os.path.dirname(current_dir) - -# Add net_orc to Python path -net_orc_dir = os.path.join(parent_dir, 'net_orc', 'python', 'src') -sys.path.append(net_orc_dir) - -import network_orchestrator as net_orc # 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 - -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): - LOGGER.info("Starting Test Run") - - # Catch any exit signals - self._register_exits() - - self._start_network() - - # Keep application running - time.sleep(RUNTIME) - - self._stop_network() - - 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) - - def _start_network(self): - # Create an instance of the network orchestrator - self._net_orc = net_orc.NetworkOrchestrator() - - # Load config file and pass to other components - self._load_config() - - # Load and build any unbuilt network containers - self._net_orc.load_network_modules() - self._net_orc.build_network_modules() - - # Create baseline network - self._net_orc.create_net() - - # Launch network service containers - self._net_orc.start_network_services() - - LOGGER.info("Network is ready.") - - def _stop_network(self): - LOGGER.info("Stopping Test Run") - self._net_orc.stop_networking_services(kill=True) - self._net_orc.restore_net() - sys.exit(0) +"""The overall control of the Test Run application. + +This file provides the integration between all of the +Test Run components, such as net_orc, test_orc and test_ui. + +Run using the provided command scripts in the cmd folder. +E.g sudo cmd/start +""" + +import os +import sys +import json +import signal +import logger + +# Locate parent directory +current_dir = os.path.dirname(os.path.realpath(__file__)) +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" +RUNTIME = 300 + +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): + + # Catch any exit signals + self._register_exits() + + # Import the correct net orchestrator + self.import_orchestrators(local_net) + + self._net_orc = net_orc.NetworkOrchestrator() + self._test_orc = test_orc.TestOrchestrator() + + def import_orchestrators(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 + + 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) diff --git a/test_orc/modules/base/base.Dockerfile b/test_orc/modules/base/base.Dockerfile new file mode 100644 index 000000000..b5f35326a --- /dev/null +++ b/test_orc/modules/base/base.Dockerfile @@ -0,0 +1,23 @@ +# Image name: test-run/base-test +FROM ubuntu:jammy + +# Install common software +RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix + +# Setup the base python requirements +COPY modules/base/python /testrun/python + +# Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt + +# Add the bin files +COPY modules/base/bin /testrun/bin + +# Remove incorrect line endings +RUN dos2unix /testrun/bin/* + +# Make sure all the bin files are executable +RUN chmod u+x /testrun/bin/* + +# Start the test module +ENTRYPOINT [ "/testrun/bin/start_module" ] \ No newline at end of file diff --git a/test_orc/modules/base/bin/capture b/test_orc/modules/base/bin/capture new file mode 100644 index 000000000..dccafb0c5 --- /dev/null +++ b/test_orc/modules/base/bin/capture @@ -0,0 +1,20 @@ +#!/bin/bash -e + +# Fetch module name +MODULE_NAME=$1 + +# Define the local file location for the capture to be saved +PCAP_DIR="/runtime/output/" +PCAP_FILE=$MODULE_NAME.pcap + +# Allow a user to define an interface by passing it into this script +INTERFACE=$2 + +# Create the output directory and start the capture +mkdir -p $PCAP_DIR +chown $HOST_USER:$HOST_USER $PCAP_DIR +echo "PCAP Dir: $PCAP_DIR/$PCAP_FILE" +tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & + +# Small pause to let the capture to start +sleep 1 \ No newline at end of file diff --git a/test_orc/modules/base/bin/setup_binaries b/test_orc/modules/base/bin/setup_binaries new file mode 100644 index 000000000..3535ead3c --- /dev/null +++ b/test_orc/modules/base/bin/setup_binaries @@ -0,0 +1,10 @@ +#!/bin/bash -e + +# Directory where all binaries will be loaded +BIN_DIR=$1 + +# Remove incorrect line endings +dos2unix $BIN_DIR/* + +# Make sure all the bin files are executable +chmod u+x $BIN_DIR/* \ No newline at end of file diff --git a/test_orc/modules/base/bin/start_grpc b/test_orc/modules/base/bin/start_grpc new file mode 100644 index 000000000..917381e89 --- /dev/null +++ b/test_orc/modules/base/bin/start_grpc @@ -0,0 +1,17 @@ +#!/bin/bash -e + +GRPC_DIR="/testrun/python/src/grpc" +GRPC_PROTO_DIR="proto" +GRPC_PROTO_FILE="grpc.proto" + +# Move into the grpc directory +pushd $GRPC_DIR >/dev/null 2>&1 + +# Build the grpc proto file every time before starting server +python3 -m grpc_tools.protoc --proto_path=. ./$GRPC_PROTO_DIR/$GRPC_PROTO_FILE --python_out=. --grpc_python_out=. + +popd >/dev/null 2>&1 + +# Start the grpc server +python3 -u $GRPC_DIR/start_server.py $@ + diff --git a/test_orc/modules/base/bin/start_module b/test_orc/modules/base/bin/start_module new file mode 100644 index 000000000..a9f5402f4 --- /dev/null +++ b/test_orc/modules/base/bin/start_module @@ -0,0 +1,76 @@ +#!/bin/bash + +# Directory where all binaries will be loaded +BIN_DIR="/testrun/bin" + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Create a local user that matches the same as the host +# to be used for correct file ownership for various logs +# HOST_USER mapped in via docker container environemnt variables +useradd $HOST_USER + +# Enable IPv6 for all containers +sysctl net.ipv6.conf.all.disable_ipv6=0 +sysctl -p + +# Read in the config file +CONF_FILE="/testrun/conf/module_config.json" +CONF=`cat $CONF_FILE` + +if [[ -z $CONF ]] +then + echo "No config file present at $CONF_FILE. Exiting startup." + exit 1 +fi + +# Extract the necessary config parameters +MODULE_NAME=$(echo "$CONF" | jq -r '.config.meta.name') +DEFINED_IFACE=$(echo "$CONF" | jq -r '.config.network.interface') +GRPC=$(echo "$CONF" | jq -r '.config.grpc') + +# Validate the module name is present +if [[ -z "$MODULE_NAME" || "$MODULE_NAME" == "null" ]] +then + echo "No module name present in $CONF_FILE. Exiting startup." + exit 1 +fi + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No Interface Defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +echo "Starting module $MODULE_NAME..." + +$BIN_DIR/setup_binaries $BIN_DIR + +# Wait for interface to become ready +$BIN_DIR/wait_for_interface $INTF + +# Start network capture +$BIN_DIR/capture $MODULE_NAME $INTF + +# Start the grpc server +if [[ ! -z $GRPC && ! $GRPC == "null" ]] +then + GRPC_PORT=$(echo "$GRPC" | jq -r '.port') + if [[ ! -z $GRPC_PORT && ! $GRPC_PORT == "null" ]] + then + echo "gRPC port resolved from config: $GRPC_PORT" + $BIN_DIR/start_grpc "-p $GRPC_PORT" & + else + $BIN_DIR/start_grpc & + fi +fi + +# Small pause to let all core services stabalize +sleep 3 + +# Start the networking service +$BIN_DIR/start_test_module $MODULE_NAME $INTF \ No newline at end of file diff --git a/test_orc/modules/base/bin/wait_for_interface b/test_orc/modules/base/bin/wait_for_interface new file mode 100644 index 000000000..c9c1682f0 --- /dev/null +++ b/test_orc/modules/base/bin/wait_for_interface @@ -0,0 +1,10 @@ +#!/bin/bash + +# Allow a user to define an interface by passing it into this script +INTF=$1 + +# Wait for local interface to be ready +while ! ip link show $INTF; do + echo $INTF is not yet ready. Waiting 3 seconds + sleep 3 +done \ No newline at end of file diff --git a/test_orc/modules/base/conf/module_config.json b/test_orc/modules/base/conf/module_config.json new file mode 100644 index 000000000..1f3a47ba2 --- /dev/null +++ b/test_orc/modules/base/conf/module_config.json @@ -0,0 +1,12 @@ +{ + "config": { + "meta": { + "name": "base", + "display_name": "Base", + "description": "Base image" + }, + "docker": { + "enable_container": false + } + } +} \ No newline at end of file diff --git a/test_orc/modules/base/python/requirements.txt b/test_orc/modules/base/python/requirements.txt new file mode 100644 index 000000000..9c4e2b056 --- /dev/null +++ b/test_orc/modules/base/python/requirements.txt @@ -0,0 +1,2 @@ +grpcio +grpcio-tools \ No newline at end of file diff --git a/test_orc/modules/base/python/src/grpc/start_server.py b/test_orc/modules/base/python/src/grpc/start_server.py new file mode 100644 index 000000000..9ed31ffcf --- /dev/null +++ b/test_orc/modules/base/python/src/grpc/start_server.py @@ -0,0 +1,34 @@ +from concurrent import futures +import grpc +import proto.grpc_pb2_grpc as pb2_grpc +import proto.grpc_pb2 as pb2 +from network_service import NetworkService +import logging +import sys +import argparse + +DEFAULT_PORT = '5001' + +def serve(PORT): + server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) + pb2_grpc.add_NetworkModuleServicer_to_server(NetworkService(), server) + server.add_insecure_port('[::]:' + PORT) + server.start() + server.wait_for_termination() + +def run(argv): + parser = argparse.ArgumentParser(description="GRPC Server for Network Module", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("-p", "--port", default=DEFAULT_PORT, + help="Define the default port to run the server on.") + + args = parser.parse_args() + + PORT = args.port + + print("gRPC server starting on port " + PORT) + serve(PORT) + + +if __name__ == "__main__": + run(sys.argv) \ No newline at end of file diff --git a/test_orc/modules/base/python/src/logger.py b/test_orc/modules/base/python/src/logger.py new file mode 100644 index 000000000..0eb7b9ccf --- /dev/null +++ b/test_orc/modules/base/python/src/logger.py @@ -0,0 +1,45 @@ +#!/usr/bin/env python3 + +import json +import logging +import os + +LOGGERS = {} +_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_DATE_FORMAT = '%b %02d %H:%M:%S' +_DEFAULT_LEVEL = logging.INFO +_CONF_DIR = "conf" +_CONF_FILE_NAME = "system.json" +_LOG_DIR = "/runtime/network/" + +# Set log level +try: + system_conf_json = json.load( + open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='utf-8')) + log_level_str = system_conf_json['log_level'] + log_level = logging.getLevelName(log_level_str) +except: + # TODO: Print out warning that log level is incorrect or missing + log_level = _DEFAULT_LEVEL + +log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) + + +def add_file_handler(log, log_file): + handler = logging.FileHandler(_LOG_DIR+log_file+".log") + handler.setFormatter(log_format) + log.addHandler(handler) + +def add_stream_handler(log): + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + +def get_logger(name, log_file=None): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if log_file is not None: + add_file_handler(LOGGERS[name], log_file) + return LOGGERS[name] diff --git a/test_orc/modules/baseline/baseline.Dockerfile b/test_orc/modules/baseline/baseline.Dockerfile new file mode 100644 index 000000000..5b634e6ee --- /dev/null +++ b/test_orc/modules/baseline/baseline.Dockerfile @@ -0,0 +1,11 @@ +# Image name: test-run/baseline-test +FROM test-run/base-test:latest + +# Copy over all configuration files +COPY modules/baseline/conf /testrun/conf + +# Load device binary files +COPY modules/baseline/bin /testrun/bin + +# Copy over all python files +COPY modules/baseline/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/baseline/bin/start_test_module b/test_orc/modules/baseline/bin/start_test_module new file mode 100644 index 000000000..292b57de2 --- /dev/null +++ b/test_orc/modules/baseline/bin/start_test_module @@ -0,0 +1,40 @@ +#!/bin/bash + +# An example startup script that does the bare minimum to start +# a test module via a pyhon script. Each test module should include a +# start_test_module file that overwrites this one to boot all of its +# specific requirements to run. + +# Define where the python source files are located +PYTHON_SRC_DIR=/testrun/python/src + +# Fetch module name +MODULE_NAME=$1 + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No interface defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +# Create and set permissions on the log files +LOG_FILE=/runtime/output/$MODULE_NAME.log +RESULT_FILE=/runtime/output/$MODULE_NAME-result.json +touch $LOG_FILE +touch $RESULT_FILE +chown $HOST_USER:$HOST_USER $LOG_FILE +chown $HOST_USER:$HOST_USER $RESULT_FILE + +# Run the python scrip that will execute the tests for this module +# -u flag allows python print statements +# to be logged by docker by running unbuffered +python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" \ No newline at end of file diff --git a/test_orc/modules/baseline/conf/module_config.json b/test_orc/modules/baseline/conf/module_config.json new file mode 100644 index 000000000..1b8b7b9ba --- /dev/null +++ b/test_orc/modules/baseline/conf/module_config.json @@ -0,0 +1,21 @@ +{ + "config": { + "meta": { + "name": "baseline", + "display_name": "Baseline", + "description": "Baseline test" + }, + "network": { + "interface": "eth0", + "enable_wan": false, + "ip_index": 9 + }, + "grpc": { + "port": 50001 + }, + "docker": { + "enable_container": true, + "timeout": 30 + } + } +} \ No newline at end of file diff --git a/test_orc/modules/baseline/python/src/logger.py b/test_orc/modules/baseline/python/src/logger.py new file mode 100644 index 000000000..641aa16b4 --- /dev/null +++ b/test_orc/modules/baseline/python/src/logger.py @@ -0,0 +1,46 @@ +#!/usr/bin/env python3 + +import json +import logging +import os + +LOGGERS = {} +_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_DATE_FORMAT = '%b %02d %H:%M:%S' +_DEFAULT_LEVEL = logging.INFO +_CONF_DIR = "conf" +_CONF_FILE_NAME = "system.json" +_LOG_DIR = "/runtime/output/" + +# Set log level +try: + system_conf_json = json.load( + open(os.path.join(_CONF_DIR, _CONF_FILE_NAME))) + log_level_str = system_conf_json['log_level'] + log_level = logging.getLevelName(log_level_str) +except: + # TODO: Print out warning that log level is incorrect or missing + log_level = _DEFAULT_LEVEL + +log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) + +def add_file_handler(log, logFile): + handler = logging.FileHandler(_LOG_DIR+logFile+".log") + handler.setFormatter(log_format) + log.addHandler(handler) + + +def add_stream_handler(log): + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + + +def get_logger(name, logFile=None): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if logFile is not None: + add_file_handler(LOGGERS[name], logFile) + return LOGGERS[name] diff --git a/test_orc/modules/baseline/python/src/run.py b/test_orc/modules/baseline/python/src/run.py new file mode 100644 index 000000000..7ff11559f --- /dev/null +++ b/test_orc/modules/baseline/python/src/run.py @@ -0,0 +1,50 @@ +#!/usr/bin/env python3 + +import argparse +import signal +import sys +import logger + +from test_module import TestModule + +LOGGER = logger.get_logger('test_module') +RUNTIME = 300 + +class TestModuleRunner: + + def __init__(self,module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + + LOGGER.info("Starting Test Module Template") + + self._test_module = TestModule(module) + self._test_module.run_tests() + self._test_module.generate_results() + + def _handler(self, signum, *other): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping test module...") + LOGGER.info("Test module stopped") + sys.exit(1) + +def run(argv): + parser = argparse.ArgumentParser(description="Test Module Template", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + "-m", "--module", help="Define the module name to be used to create the log file") + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + TestModuleRunner(args.module.strip()) + +if __name__ == "__main__": + run(sys.argv) diff --git a/test_orc/modules/baseline/python/src/test_module.py b/test_orc/modules/baseline/python/src/test_module.py new file mode 100644 index 000000000..440b87f7f --- /dev/null +++ b/test_orc/modules/baseline/python/src/test_module.py @@ -0,0 +1,63 @@ +#!/usr/bin/env python3 + +import json +import time +import logger + +LOG_NAME = "test_baseline" +RESULTS_DIR = "/runtime/output/" +LOGGER = logger.get_logger(LOG_NAME) + +class TestModule: + + def __init__(self, module): + + self.module_test1 = None + self.module_test2 = None + self.module_test3 = None + self.module = module + self.add_logger(module) + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + # Make up some fake test results + def run_tests(self): + LOGGER.info("Running test 1...") + self.module_test1 = True + LOGGER.info("Test 1 complete.") + + LOGGER.info("Running test 2...") + self.module_test2 = False + LOGGER.info("Test 2 complete.") + + time.sleep(10) + + def generate_results(self): + results = [] + results.append(self.generate_result("Test 1", self.module_test1)) + results.append(self.generate_result("Test 2", self.module_test2)) + results.append(self.generate_result("Test 3", self.module_test3)) + json_results = json.dumps({"results":results}, indent=2) + self.write_results(json_results) + + def write_results(self,results): + results_file=RESULTS_DIR+self.module+"-result.json" + LOGGER.info("Writing results to " + results_file) + f = open(results_file, "w", encoding="utf-8") + f.write(results) + f.close() + + def generate_result(self, test_name, test_result): + if test_result is not None: + result = "compliant" if test_result else "non-compliant" + else: + result = "skipped" + LOGGER.info(test_name + ": " + result) + res_dict = { + "name": test_name, + "result": result, + "description": "The device is " + result + } + return res_dict diff --git a/test_orc/python/requirements.txt b/test_orc/python/requirements.txt new file mode 100644 index 000000000..e69de29bb diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py new file mode 100644 index 000000000..396f533fa --- /dev/null +++ b/test_orc/python/src/test_orchestrator.py @@ -0,0 +1,221 @@ +"""Provides high level management of the test orchestrator.""" +import os +import json +import time +import shutil +import docker +from docker.types import Mount +import logger + +LOG_NAME = "test_orc" +LOGGER = logger.get_logger('test_orc') +RUNTIME_DIR = "runtime" +TEST_MODULES_DIR = "modules" +MODULE_CONFIG = "conf/module_config.json" + +class TestOrchestrator: + """Manages and controls the test modules.""" + + def __init__(self): + self._test_modules = [] + self._module_config = None + + self._path = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.realpath(__file__)))) + + # Resolve the path to the test-run folder + self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) + + shutil.rmtree(os.path.join(self._root_path, RUNTIME_DIR), ignore_errors=True) + os.makedirs(os.path.join(self._root_path, RUNTIME_DIR), exist_ok=True) + + def import_config(self, json_config): + """Load settings from JSON object into memory.""" + + # No relevant config options in system.json as of yet + + def get_test_module(self, name): + """Returns a test module by the module name.""" + for module in self._test_modules: + if name == module.name: + return module + return None + + def run_test_modules(self): + """Iterates through each test module and starts the container.""" + LOGGER.info("Running test modules...") + for module in self._test_modules: + self.run_test_module(module) + LOGGER.info("All tests complete") + + def run_test_module(self, module): + """Start the test container and extract the results.""" + + if module is None or not module.enable_container: + return + + LOGGER.info("Running test module " + module.display_name) + try: + + container_runtime_dir = os.path.join(self._root_path, "runtime/test/" + module.name) + os.makedirs(container_runtime_dir) + + client = docker.from_env() + + module.container = client.containers.run( + module.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=module.container_name, + hostname=module.container_name, + privileged=True, + detach=True, + mounts=[Mount( + target="/runtime/output", + source=container_runtime_dir, + type='bind' + )], + environment={"HOST_USER": os.getlogin()} + ) + except (docker.errors.APIError, docker.errors.ContainerError) as container_error: + LOGGER.error("Test module " + module.display_name + " has failed to start") + LOGGER.debug(container_error) + return + + # Determine the module timeout time + test_module_timeout = time.time() + module.timeout + status = self._get_module_status(module) + + while time.time() < test_module_timeout and status == 'running': + time.sleep(1) + status = self._get_module_status(module) + + LOGGER.info("Test module " + module.display_name + " has finished") + + def _get_module_status(self,module): + container = self._get_module_container(module) + if container is not None: + return container.status + return None + + def _get_module_container(self, module): + container = None + try: + client = docker.from_env() + container = client.containers.get(module.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + + module.container_name + " not found") + except docker.errors.APIError as error: + LOGGER.error("Failed to resolve container") + LOGGER.error(error) + return container + + def load_test_modules(self): + """Import module configuration from module_config.json.""" + + modules_dir = os.path.join(self._path, TEST_MODULES_DIR) + + LOGGER.debug("Loading test modules from /" + modules_dir) + loaded_modules = "Loaded the following test modules: " + + for module_dir in os.listdir(modules_dir): + + LOGGER.debug("Loading module from: " + module_dir) + + # Load basic module information + module = TestModule() + with open(os.path.join( + self._path, + modules_dir, + module_dir, + MODULE_CONFIG), + encoding='UTF-8') as module_config_file: + module_json = json.load(module_config_file) + + module.name = module_json['config']['meta']['name'] + module.display_name = module_json['config']['meta']['display_name'] + module.description = module_json['config']['meta']['description'] + module.dir = os.path.join(self._path, modules_dir, module_dir) + module.dir_name = module_dir + module.build_file = module_dir + ".Dockerfile" + module.container_name = "tr-ct-" + module.dir_name + "-test" + module.image_name = "test-run/" + module.dir_name + "-test" + + if 'timeout' in module_json['config']['docker']: + module.timeout = module_json['config']['docker']['timeout'] + + # Determine if this is a container or just an image/template + if "enable_container" in module_json['config']['docker']: + module.enable_container = module_json['config']['docker']['enable_container'] + + self._test_modules.append(module) + + loaded_modules += module.dir_name + " " + + LOGGER.info(loaded_modules) + + def build_test_modules(self): + """Build all test modules.""" + LOGGER.info("Building test modules...") + for module in self._test_modules: + self._build_test_module(module) + + def _build_test_module(self, module): + LOGGER.debug("Building docker image for module " + module.dir_name) + client = docker.from_env() + try: + client.images.build( + dockerfile=os.path.join(module.dir, module.build_file), + path=self._path, + forcerm=True, # Cleans up intermediate containers during build + tag=module.image_name + ) + except docker.errors.BuildError as error: + LOGGER.error(error) + + def _stop_modules(self, kill=False): + LOGGER.debug("Stopping test modules") + for module in self._test_modules: + # Test modules may just be Docker images, so we do not want to stop them + if not module.enable_container: + continue + self._stop_module(module, kill) + + def _stop_module(self, module, kill=False): + LOGGER.debug("Stopping test module " + module.container_name) + try: + container = module.container + if container is not None: + if kill: + LOGGER.debug("Killing container:" + + module.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + + module.container_name) + container.stop() + LOGGER.debug("Container stopped:" + module.container_name) + except Exception as error: + LOGGER.error("Container stop error") + LOGGER.error(error) + +class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes + """Represents a test module.""" + + def __init__(self): + self.name = None + self.display_name = None + self.description = None + + self.build_file = None + self.container = None + self.container_name = None + self.image_name = None + self.enable_container = True + + self.timeout = 60 + + # Absolute path + self.dir = None + self.dir_name = None From 6f3a7fedd198d584fd217579dda66f30d02fad1b Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 26 Apr 2023 11:29:55 +0100 Subject: [PATCH 002/400] Add issue report templates (#7) * Add issue templates * Update README.md --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++++ README.md | 3 +++ 3 files changed, 52 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..852476aeb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us identify and resolve bugs +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Error logs** +If applicable, provide a log from https://gist.github.com/ + +**Environment (please provide the following information about your setup):** + - OS: [e.g. Ubuntu] + - Version [e.g. 22.04] + - Additional hardware (network adapters) + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..9fd0ca896 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest a new feature or change request +title: '' +labels: request +assignees: '' + +--- + +**What is the problem your feature is trying to solve?** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you think would solve the problem** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/README.md b/README.md index b374bdbf5..41c559499 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,9 @@ Test Run cannot automate everything, and so additional manual testing may be req ## Roadmap :chart_with_upwards_trend: Test Run will constantly evolve to further support end-users by automating device network behaviour against industry standards. +## Issue reporting :triangular_flag_on_post: +If the application has come across a problem at any point during setup or use, please raise an issue under the [issues tab](https://github.com/auto-iot/test-run/issues). Issue templates exist for both bug reports and feature requests. If neither of these are appropriate for your issue, raise a blank issue instead. + ## Contributing :keyboard: The contributing requirements can be found in [CONTRIBUTING.md](CONTRIBUTING.md). In short, checkout the [Google CLA](https://cla.developers.google.com/) site to get started. From e05c383fe65b5468d58bb6ae4b8747319c9635c8 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 26 Apr 2023 12:13:34 +0100 Subject: [PATCH 003/400] Discover devices on the network (#5) --- .pylintrc | 429 ++++++++++++++++++ etc/requirements.txt | 3 +- framework/device.py | 10 + framework/run.py | 2 +- framework/testrun.py | 255 +++++++---- .../Teltonika TRB140/device_config.json | 5 + 6 files changed, 605 insertions(+), 99 deletions(-) create mode 100644 .pylintrc create mode 100644 framework/device.py create mode 100644 local/devices/Teltonika TRB140/device_config.json 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/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..08014c127 --- /dev/null +++ b/framework/device.py @@ -0,0 +1,10 @@ +"""Track device object information.""" +from dataclasses import dataclass + +@dataclass +class Device: + """Represents a physical device and it's configuration.""" + + make: str + model: str + mac_addr: str diff --git a/framework/run.py b/framework/run.py index d2643d956..fc6c197e3 100644 --- a/framework/run.py +++ b/framework/run.py @@ -17,7 +17,7 @@ def __init__(self, local_net=True): testrun.load_config() - testrun.start_network() + testrun.start() testrun.run_tests() diff --git a/framework/testrun.py b/framework/testrun.py index 22fa0295a..372a64692 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -12,108 +12,169 @@ import json import signal import logger +from device import Device # Locate parent directory current_dir = os.path.dirname(os.path.realpath(__file__)) 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 -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): - - # Catch any exit signals - self._register_exits() - - # Import the correct net orchestrator - self.import_orchestrators(local_net) - - self._net_orc = net_orc.NetworkOrchestrator() - self._test_orc = test_orc.TestOrchestrator() - - def import_orchestrators(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 - - 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) +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. + + 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}') 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 From 823709e25338f48dfd9dee2004eced63965bac76 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Fri, 28 Apr 2023 05:45:33 -0700 Subject: [PATCH 004/400] Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- --- .gitignore | 270 ++++++++++----------- cmd/install | 2 +- cmd/start | 2 +- framework/run.py | 40 ---- framework/test_runner.py | 73 ++++++ framework/testrun.py | 288 +++++++++++------------ test_orc/python/src/module.py | 23 ++ test_orc/python/src/runner.py | 40 ++++ test_orc/python/src/test_orchestrator.py | 42 ++-- 9 files changed, 433 insertions(+), 347 deletions(-) delete mode 100644 framework/run.py create mode 100644 framework/test_runner.py create mode 100644 test_orc/python/src/module.py create mode 100644 test_orc/python/src/runner.py diff --git a/.gitignore b/.gitignore index 4016b6901..f79a6efcb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,135 +1,135 @@ -# Runtime folder -runtime/ -venv/ -net_orc/ -.vscode/ - -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ +# Runtime folder +runtime/ +venv/ +net_orc/ +.vscode/ + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/cmd/install b/cmd/install index 61722e273..6dee1c635 100755 --- a/cmd/install +++ b/cmd/install @@ -2,7 +2,7 @@ GIT_URL=https://github.com/auto-iot NET_ORC_DIR=net_orc -NET_ORC_VERSION="dev" +NET_ORC_VERSION="main" python3 -m venv venv diff --git a/cmd/start b/cmd/start index fa6bbc1e1..113f14b3e 100755 --- a/cmd/start +++ b/cmd/start @@ -18,6 +18,6 @@ rm -rf runtime source venv/bin/activate # TODO: Execute python code -python -u framework/run.py $@ +python -u framework/test_runner.py $@ deactivate \ No newline at end of file diff --git a/framework/run.py b/framework/run.py deleted file mode 100644 index fc6c197e3..000000000 --- a/framework/run.py +++ /dev/null @@ -1,40 +0,0 @@ -"""Starts Test Run.""" - -import argparse -import sys -from testrun import TestRun -import logger - -LOGGER = logger.get_logger('runner') - -class TestRunner: - - def __init__(self, local_net=True): - - LOGGER.info('Starting Test Run') - - testrun = TestRun(local_net) - - testrun.load_config() - - testrun.start() - - testrun.run_tests() - - testrun.stop_network() - - -def run(argv): - parser = argparse.ArgumentParser(description="Test Run", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-r", "--remote-net", action="store_false", - help='''Use the network orchestrator from the parent directory instead - of the one downloaded locally from the install script.''') - - args, unknown = parser.parse_known_args() - - TestRunner(args.remote_net) - - -if __name__ == "__main__": - run(sys.argv) diff --git a/framework/test_runner.py b/framework/test_runner.py new file mode 100644 index 000000000..91ff4cb1a --- /dev/null +++ b/framework/test_runner.py @@ -0,0 +1,73 @@ +#!/usr/bin/env python3 + +"""Wrapper for the TestRun that simplifies +virtual testing procedure by allowing direct calling +from the command line. + +Run using the provided command scripts in the cmd folder. +E.g sudo cmd/start +""" + +import argparse +import sys +from testrun import TestRun +import logger +import signal + +LOGGER = logger.get_logger('runner') + + +class TestRunner: + + def __init__(self, local_net=True, config_file=None, validate=True, net_only=False): + self._register_exits() + self.test_run = TestRun(local_net=local_net, config_file=config_file, + validate=validate, net_only=net_only) + + 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.") + # Kill all container services quickly + # If we're here, we want everything to stop immediately + # and don't care about a gracefully shutdown + self._stop(True) + sys.exit(1) + + def stop(self, kill=False): + self.test_run.stop(kill) + + def start(self): + self.test_run.start() + LOGGER.info("Test Run has finished") + + +def parse_args(argv): + parser = argparse.ArgumentParser(description="Test Run", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("-r", "--remote-net", action="store_false", + help='''Use the network orchestrator from the parent directory instead + of the one downloaded locally from the install script.''') + parser.add_argument("-f", "--config-file", default=None, + help="Define the configuration file for Test Run and Network Orchestrator") + parser.add_argument("--no-validate", action="store_true", + help="Turn off the validation of the network after network boot") + parser.add_argument("-net", "--net-only", action="store_true", + help="Run the network only, do not run tests") + args, unknown = parser.parse_known_args() + return args + + +if __name__ == "__main__": + args = parse_args(sys.argv) + runner = TestRunner(local_net=args.remote_net, + config_file=args.config_file, + validate=not args.no_validate, + net_only=args.net_only) + runner.start() diff --git a/framework/testrun.py b/framework/testrun.py index 372a64692..4a29b4e20 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,150 +31,142 @@ 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): - """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: + """Test Run controller. + + Creates an instance of the network orchestrator, test + orchestrator and user interface. + """ + + def __init__(self, local_net=True, config_file=CONFIG_FILE,validate=True, net_only=False): + self._devices = [] + self._net_only = net_only + + # Catch any exit signals + self._register_exits() + + # Import the correct net orchestrator + self.import_dependencies(local_net) + + # Expand the config file to absolute pathing + config_file_abs=self._get_config_abs(config_file=config_file) + + self._net_orc = net_orc.NetworkOrchestrator(config_file=config_file_abs,validate=validate,async_monitor=not self._net_only) + self._test_orc = test_orc.TestOrchestrator() + + def start(self): + + self._load_devices() + + if self._net_only: + LOGGER.info("Network only option configured, no tests will be run") + self._start_network() + else: + self._start_network() + self._start_tests() + + self.stop() + + # Register callbacks + # Disable for now as this is causing boot failures when no devices are discovered + # self._net_orc.listener.register_callback( + # self._device_discovered, + # [NetworkEvent.DEVICE_DISCOVERED]) + + def stop(self,kill=False): + self._stop_tests() + self._stop_network(kill=kill) + + 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(kill=True) + sys.exit(1) + + def _get_config_abs(self,config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + config_file = os.path.join(parent_dir, CONFIG_FILE) + + # Expand the config file to absolute pathing + return os.path.abspath(config_file) + + def _start_network(self): + self._net_orc.start() + + def _start_tests(self): + """Iterate through and start all test modules.""" + + self._test_orc.start() + + def _stop_network(self,kill=False): + self._net_orc.stop(kill=kill) + + def _stop_tests(self): + self._test_orc.stop() + + 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}') 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}') diff --git a/test_orc/python/src/module.py b/test_orc/python/src/module.py new file mode 100644 index 000000000..6d24d7e1e --- /dev/null +++ b/test_orc/python/src/module.py @@ -0,0 +1,23 @@ +"""Represemts a test module.""" +from dataclasses import dataclass +from docker.client.Container import Container + +@dataclass +class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes + """Represents a test module.""" + + name: str = None + display_name: str = None + description: str = None + + build_file: str = None + container: Container = None + container_name: str = None + image_name :str = None + enable_container: bool = True + + timeout: int = 60 + + # Absolute path + dir: str = None + dir_name: str = None diff --git a/test_orc/python/src/runner.py b/test_orc/python/src/runner.py new file mode 100644 index 000000000..cc495bf8d --- /dev/null +++ b/test_orc/python/src/runner.py @@ -0,0 +1,40 @@ +"""Provides high level management of the test orchestrator.""" +import time +import logger + +LOGGER = logger.get_logger('runner') + +class Runner: + """Holds the state of the testing for one device.""" + + def __init__(self, test_orc, device): + self._test_orc = test_orc + self._device = device + + def run(self): + self._run_test_modules() + + def _run_test_modules(self): + """Iterates through each test module and starts the container.""" + LOGGER.info('Running test modules...') + for module in self._test_modules: + self.run_test_module(module) + LOGGER.info('All tests complete') + + def run_test_module(self, module): + """Start the test container and extract the results.""" + + if module is None or not module.enable_container: + return + + self._test_orc.start_test_module(module) + + # Determine the module timeout time + test_module_timeout = time.time() + module.timeout + status = self._test_orc.get_module_status(module) + + while time.time() < test_module_timeout and status == 'running': + time.sleep(1) + status = self._test_orc.get_module_status(module) + + LOGGER.info(f'Test module {module.display_name} has finished') diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 396f533fa..77f73f407 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -29,32 +29,29 @@ def __init__(self): shutil.rmtree(os.path.join(self._root_path, RUNTIME_DIR), ignore_errors=True) os.makedirs(os.path.join(self._root_path, RUNTIME_DIR), exist_ok=True) - def import_config(self, json_config): - """Load settings from JSON object into memory.""" + def start(self): + LOGGER.info("Starting Test Orchestrator") + self._load_test_modules() + self._run_test_modules() - # No relevant config options in system.json as of yet + def stop(self): + """Stop any running tests""" + self._stop_modules() - def get_test_module(self, name): - """Returns a test module by the module name.""" - for module in self._test_modules: - if name == module.name: - return module - return None - - def run_test_modules(self): + def _run_test_modules(self): """Iterates through each test module and starts the container.""" LOGGER.info("Running test modules...") for module in self._test_modules: - self.run_test_module(module) + self._run_test_module(module) LOGGER.info("All tests complete") - def run_test_module(self, module): + def _run_test_module(self, module): """Start the test container and extract the results.""" if module is None or not module.enable_container: return - LOGGER.info("Running test module " + module.display_name) + LOGGER.info("Running test module " + module.name) try: container_runtime_dir = os.path.join(self._root_path, "runtime/test/" + module.name) @@ -78,7 +75,7 @@ def run_test_module(self, module): environment={"HOST_USER": os.getlogin()} ) except (docker.errors.APIError, docker.errors.ContainerError) as container_error: - LOGGER.error("Test module " + module.display_name + " has failed to start") + LOGGER.error("Test module " + module.name + " has failed to start") LOGGER.debug(container_error) return @@ -90,7 +87,7 @@ def run_test_module(self, module): time.sleep(1) status = self._get_module_status(module) - LOGGER.info("Test module " + module.display_name + " has finished") + LOGGER.info("Test module " + module.name + " has finished") def _get_module_status(self,module): container = self._get_module_container(module) @@ -111,7 +108,7 @@ def _get_module_container(self, module): LOGGER.error(error) return container - def load_test_modules(self): + def _load_test_modules(self): """Import module configuration from module_config.json.""" modules_dir = os.path.join(self._path, TEST_MODULES_DIR) @@ -151,7 +148,8 @@ def load_test_modules(self): self._test_modules.append(module) - loaded_modules += module.dir_name + " " + if module.enable_container: + loaded_modules += module.dir_name + " " LOGGER.info(loaded_modules) @@ -175,12 +173,13 @@ def _build_test_module(self, module): LOGGER.error(error) def _stop_modules(self, kill=False): - LOGGER.debug("Stopping test modules") + LOGGER.info("Stopping test modules") for module in self._test_modules: # Test modules may just be Docker images, so we do not want to stop them if not module.enable_container: continue self._stop_module(module, kill) + LOGGER.info("All test modules have been stopped") def _stop_module(self, module, kill=False): LOGGER.debug("Stopping test module " + module.container_name) @@ -196,9 +195,8 @@ def _stop_module(self, module, kill=False): module.container_name) container.stop() LOGGER.debug("Container stopped:" + module.container_name) - except Exception as error: - LOGGER.error("Container stop error") - LOGGER.error(error) + except docker.errors.NotFound: + pass class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes """Represents a test module.""" From ba6afc416717e883edb297572d97b03fd28ee171 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Fri, 28 Apr 2023 14:47:14 +0100 Subject: [PATCH 005/400] Quick refactor (#9) --- framework/testrun.py | 30 +++++++++++-------- .../modules/baseline/bin/start_test_module | 4 ++- .../baseline/python/src/test_module.py | 2 -- test_orc/python/src/module.py | 2 +- test_orc/python/src/test_orchestrator.py | 25 ++-------------- 5 files changed, 24 insertions(+), 39 deletions(-) diff --git a/framework/testrun.py b/framework/testrun.py index 4a29b4e20..df6006411 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -11,6 +11,7 @@ import sys import json import signal +import time import logger from device import Device @@ -57,21 +58,22 @@ def start(self): self._load_devices() + self._start_network() + if self._net_only: LOGGER.info("Network only option configured, no tests will be run") - self._start_network() + time.sleep(RUNTIME) else: - self._start_network() - self._start_tests() + self._net_orc.listener.register_callback( + self._device_discovered, + [NetworkEvent.DEVICE_DISCOVERED]) + + LOGGER.info("Waiting for devices on the network...") + # Check timeout and whether testing is currently in progress before stopping + time.sleep(RUNTIME) self.stop() - # Register callbacks - # Disable for now as this is causing boot failures when no devices are discovered - # self._net_orc.listener.register_callback( - # self._device_discovered, - # [NetworkEvent.DEVICE_DISCOVERED]) - def stop(self,kill=False): self._stop_tests() self._stop_network(kill=kill) @@ -125,9 +127,8 @@ def _get_config_abs(self,config_file=None): def _start_network(self): self._net_orc.start() - def _start_tests(self): + def _run_tests(self): """Iterate through and start all test modules.""" - self._test_orc.start() def _stop_network(self,kill=False): @@ -167,6 +168,9 @@ def _device_discovered(self, mac_addr): LOGGER.info( f'Discovered {device.make} {device.model} on the network') else: + device = Device(make=None, model=None, mac_addr=mac_addr) LOGGER.info( - f'A new device has been discovered with mac address {device.mac_addr}') - return device + f'A new device has been discovered with mac address {mac_addr}') + + # TODO: Pass device information to test orchestrator/runner + self._run_tests() diff --git a/test_orc/modules/baseline/bin/start_test_module b/test_orc/modules/baseline/bin/start_test_module index 292b57de2..2938eb0f8 100644 --- a/test_orc/modules/baseline/bin/start_test_module +++ b/test_orc/modules/baseline/bin/start_test_module @@ -37,4 +37,6 @@ chown $HOST_USER:$HOST_USER $RESULT_FILE # Run the python scrip that will execute the tests for this module # -u flag allows python print statements # to be logged by docker by running unbuffered -python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" \ No newline at end of file +python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" + +echo Module has finished \ No newline at end of file diff --git a/test_orc/modules/baseline/python/src/test_module.py b/test_orc/modules/baseline/python/src/test_module.py index 440b87f7f..d4065cde3 100644 --- a/test_orc/modules/baseline/python/src/test_module.py +++ b/test_orc/modules/baseline/python/src/test_module.py @@ -32,8 +32,6 @@ def run_tests(self): self.module_test2 = False LOGGER.info("Test 2 complete.") - time.sleep(10) - def generate_results(self): results = [] results.append(self.generate_result("Test 1", self.module_test1)) diff --git a/test_orc/python/src/module.py b/test_orc/python/src/module.py index 6d24d7e1e..8121c34db 100644 --- a/test_orc/python/src/module.py +++ b/test_orc/python/src/module.py @@ -1,6 +1,6 @@ """Represemts a test module.""" from dataclasses import dataclass -from docker.client.Container import Container +from docker.models.containers import Container @dataclass class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 77f73f407..f68a13579 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -6,9 +6,10 @@ import docker from docker.types import Mount import logger +from module import TestModule LOG_NAME = "test_orc" -LOGGER = logger.get_logger('test_orc') +LOGGER = logger.get_logger("test_orc") RUNTIME_DIR = "runtime" TEST_MODULES_DIR = "modules" MODULE_CONFIG = "conf/module_config.json" @@ -196,24 +197,4 @@ def _stop_module(self, module, kill=False): container.stop() LOGGER.debug("Container stopped:" + module.container_name) except docker.errors.NotFound: - pass - -class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes - """Represents a test module.""" - - def __init__(self): - self.name = None - self.display_name = None - self.description = None - - self.build_file = None - self.container = None - self.container_name = None - self.image_name = None - self.enable_container = True - - self.timeout = 60 - - # Absolute path - self.dir = None - self.dir_name = None + pass \ No newline at end of file From c87a976eeceb804aa9f0bd43a878210700b13bc0 Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Fri, 28 Apr 2023 10:56:50 -0600 Subject: [PATCH 006/400] Fix duplicate sleep calls --- framework/testrun.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/framework/testrun.py b/framework/testrun.py index df6006411..42534265a 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -58,20 +58,20 @@ def start(self): self._load_devices() - self._start_network() - if self._net_only: LOGGER.info("Network only option configured, no tests will be run") - time.sleep(RUNTIME) + self._start_network() else: + self._start_network() self._net_orc.listener.register_callback( self._device_discovered, [NetworkEvent.DEVICE_DISCOVERED]) LOGGER.info("Waiting for devices on the network...") - - # Check timeout and whether testing is currently in progress before stopping - time.sleep(RUNTIME) + + # Check timeout and whether testing is currently in progress before stopping + time.sleep(RUNTIME) + self.stop() def stop(self,kill=False): From 34ce2112fc7283d19e68037ee2075ad56d3993f9 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Tue, 2 May 2023 01:56:38 -0700 Subject: [PATCH 007/400] Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files --- .gitignore | 1 - cmd/install | 14 +- cmd/start | 21 + etc/requirements.txt | 2 - framework/.gitignore | 1 - framework/test_runner.py | 10 +- framework/testrun.py | 16 +- net_orc/LICENSE | 201 ++++++ net_orc/README.md | 66 ++ net_orc/docker-compose.yml | 64 ++ .../devices/faux-dev/bin/get_default_gateway | 3 + .../devices/faux-dev/bin/start_dhcp_client | 16 + .../faux-dev/bin/start_network_service | 39 ++ .../devices/faux-dev/conf/module_config.json | 11 + .../devices/faux-dev/faux-dev.Dockerfile | 20 + .../devices/faux-dev/python/src/dhcp_check.py | 85 +++ .../devices/faux-dev/python/src/dns_check.py | 109 ++++ .../faux-dev/python/src/gateway_check.py | 40 ++ .../devices/faux-dev/python/src/logger.py | 43 ++ .../devices/faux-dev/python/src/ntp_check.py | 79 +++ .../devices/faux-dev/python/src/run.py | 114 ++++ .../devices/faux-dev/python/src/util.py | 28 + net_orc/network/modules/base/base.Dockerfile | 23 + net_orc/network/modules/base/bin/capture | 30 + .../network/modules/base/bin/setup_binaries | 10 + net_orc/network/modules/base/bin/start_grpc | 17 + net_orc/network/modules/base/bin/start_module | 79 +++ .../modules/base/bin/start_network_service | 10 + .../modules/base/bin/wait_for_interface | 21 + .../modules/base/conf/module_config.json | 12 + .../modules/base/python/requirements.txt | 2 + .../base/python/src/grpc/start_server.py | 34 + .../network/modules/base/python/src/logger.py | 47 ++ .../modules/dhcp-1/bin/start_network_service | 77 +++ .../network/modules/dhcp-1/conf/dhcpd.conf | 26 + .../modules/dhcp-1/conf/module_config.json | 25 + .../network/modules/dhcp-1/conf/radvd.conf | 12 + .../network/modules/dhcp-1/dhcp-1.Dockerfile | 14 + .../dhcp-1/python/src/grpc/__init__.py | 0 .../dhcp-1/python/src/grpc/dhcp_config.py | 267 ++++++++ .../dhcp-1/python/src/grpc/network_service.py | 44 ++ .../dhcp-1/python/src/grpc/proto/grpc.proto | 36 ++ .../network/modules/dhcp-1/python/src/run.py | 40 ++ .../modules/dhcp-2/bin/start_network_service | 77 +++ .../network/modules/dhcp-2/conf/dhcpd.conf | 24 + .../modules/dhcp-2/conf/module_config.json | 25 + .../network/modules/dhcp-2/conf/radvd.conf | 12 + .../network/modules/dhcp-2/dhcp-2.Dockerfile | 14 + .../dhcp-2/python/src/grpc/__init__.py | 0 .../dhcp-2/python/src/grpc/dhcp_config.py | 267 ++++++++ .../dhcp-2/python/src/grpc/network_service.py | 44 ++ .../dhcp-2/python/src/grpc/proto/grpc.proto | 36 ++ .../network/modules/dhcp-2/python/src/run.py | 40 ++ .../modules/dns/bin/start_network_service | 48 ++ net_orc/network/modules/dns/conf/dnsmasq.conf | 5 + .../modules/dns/conf/module_config.json | 22 + net_orc/network/modules/dns/dns.Dockerfile | 14 + .../modules/gateway/bin/start_network_service | 30 + .../modules/gateway/conf/module_config.json | 22 + .../modules/gateway/gateway.Dockerfile | 11 + .../modules/ntp/bin/start_network_service | 13 + .../modules/ntp/conf/module_config.json | 22 + net_orc/network/modules/ntp/ntp-server.py | 315 +++++++++ net_orc/network/modules/ntp/ntp.Dockerfile | 13 + .../modules/ntp/python/src/ntp_server.py | 315 +++++++++ .../modules/ovs/bin/start_network_service | 22 + .../modules/ovs/conf/module_config.json | 23 + net_orc/network/modules/ovs/ovs.Dockerfile | 20 + .../modules/ovs/python/requirements.txt | 0 .../network/modules/ovs/python/src/logger.py | 17 + .../modules/ovs/python/src/ovs_control.py | 107 ++++ net_orc/network/modules/ovs/python/src/run.py | 53 ++ .../network/modules/ovs/python/src/util.py | 19 + .../modules/radius/bin/start_network_service | 20 + net_orc/network/modules/radius/conf/ca.crt | 26 + net_orc/network/modules/radius/conf/eap | 602 ++++++++++++++++++ .../modules/radius/conf/module_config.json | 22 + .../modules/radius/python/requirements.txt | 3 + .../radius/python/src/authenticator.py | 31 + .../network/modules/radius/radius.Dockerfile | 26 + .../template/bin/start_network_service | 13 + .../modules/template/conf/module_config.json | 26 + .../template/python/src/template_main.py | 4 + .../modules/template/template.Dockerfile | 11 + net_orc/orchestrator.Dockerfile | 22 + net_orc/python/requirements.txt | 4 + net_orc/python/src/listener.py | 68 ++ net_orc/python/src/logger.py | 27 + net_orc/python/src/network_event.py | 10 + net_orc/python/src/network_orchestrator.py | 573 +++++++++++++++++ net_orc/python/src/network_runner.py | 68 ++ net_orc/python/src/network_validator.py | 274 ++++++++ net_orc/python/src/run_validator.py | 52 ++ net_orc/python/src/util.py | 30 + 94 files changed, 5318 insertions(+), 33 deletions(-) delete mode 100644 etc/requirements.txt delete mode 100644 framework/.gitignore create mode 100644 net_orc/LICENSE create mode 100644 net_orc/README.md create mode 100644 net_orc/docker-compose.yml create mode 100644 net_orc/network/devices/faux-dev/bin/get_default_gateway create mode 100644 net_orc/network/devices/faux-dev/bin/start_dhcp_client create mode 100644 net_orc/network/devices/faux-dev/bin/start_network_service create mode 100644 net_orc/network/devices/faux-dev/conf/module_config.json create mode 100644 net_orc/network/devices/faux-dev/faux-dev.Dockerfile create mode 100644 net_orc/network/devices/faux-dev/python/src/dhcp_check.py create mode 100644 net_orc/network/devices/faux-dev/python/src/dns_check.py create mode 100644 net_orc/network/devices/faux-dev/python/src/gateway_check.py create mode 100644 net_orc/network/devices/faux-dev/python/src/logger.py create mode 100644 net_orc/network/devices/faux-dev/python/src/ntp_check.py create mode 100644 net_orc/network/devices/faux-dev/python/src/run.py create mode 100644 net_orc/network/devices/faux-dev/python/src/util.py create mode 100644 net_orc/network/modules/base/base.Dockerfile create mode 100644 net_orc/network/modules/base/bin/capture create mode 100644 net_orc/network/modules/base/bin/setup_binaries create mode 100644 net_orc/network/modules/base/bin/start_grpc create mode 100644 net_orc/network/modules/base/bin/start_module create mode 100644 net_orc/network/modules/base/bin/start_network_service create mode 100644 net_orc/network/modules/base/bin/wait_for_interface create mode 100644 net_orc/network/modules/base/conf/module_config.json create mode 100644 net_orc/network/modules/base/python/requirements.txt create mode 100644 net_orc/network/modules/base/python/src/grpc/start_server.py create mode 100644 net_orc/network/modules/base/python/src/logger.py create mode 100644 net_orc/network/modules/dhcp-1/bin/start_network_service create mode 100644 net_orc/network/modules/dhcp-1/conf/dhcpd.conf create mode 100644 net_orc/network/modules/dhcp-1/conf/module_config.json create mode 100644 net_orc/network/modules/dhcp-1/conf/radvd.conf create mode 100644 net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile create mode 100644 net_orc/network/modules/dhcp-1/python/src/grpc/__init__.py create mode 100644 net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py create mode 100644 net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py create mode 100644 net_orc/network/modules/dhcp-1/python/src/grpc/proto/grpc.proto create mode 100644 net_orc/network/modules/dhcp-1/python/src/run.py create mode 100644 net_orc/network/modules/dhcp-2/bin/start_network_service create mode 100644 net_orc/network/modules/dhcp-2/conf/dhcpd.conf create mode 100644 net_orc/network/modules/dhcp-2/conf/module_config.json create mode 100644 net_orc/network/modules/dhcp-2/conf/radvd.conf create mode 100644 net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile create mode 100644 net_orc/network/modules/dhcp-2/python/src/grpc/__init__.py create mode 100644 net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py create mode 100644 net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py create mode 100644 net_orc/network/modules/dhcp-2/python/src/grpc/proto/grpc.proto create mode 100644 net_orc/network/modules/dhcp-2/python/src/run.py create mode 100644 net_orc/network/modules/dns/bin/start_network_service create mode 100644 net_orc/network/modules/dns/conf/dnsmasq.conf create mode 100644 net_orc/network/modules/dns/conf/module_config.json create mode 100644 net_orc/network/modules/dns/dns.Dockerfile create mode 100644 net_orc/network/modules/gateway/bin/start_network_service create mode 100644 net_orc/network/modules/gateway/conf/module_config.json create mode 100644 net_orc/network/modules/gateway/gateway.Dockerfile create mode 100644 net_orc/network/modules/ntp/bin/start_network_service create mode 100644 net_orc/network/modules/ntp/conf/module_config.json create mode 100644 net_orc/network/modules/ntp/ntp-server.py create mode 100644 net_orc/network/modules/ntp/ntp.Dockerfile create mode 100644 net_orc/network/modules/ntp/python/src/ntp_server.py create mode 100644 net_orc/network/modules/ovs/bin/start_network_service create mode 100644 net_orc/network/modules/ovs/conf/module_config.json create mode 100644 net_orc/network/modules/ovs/ovs.Dockerfile create mode 100644 net_orc/network/modules/ovs/python/requirements.txt create mode 100644 net_orc/network/modules/ovs/python/src/logger.py create mode 100644 net_orc/network/modules/ovs/python/src/ovs_control.py create mode 100644 net_orc/network/modules/ovs/python/src/run.py create mode 100644 net_orc/network/modules/ovs/python/src/util.py create mode 100644 net_orc/network/modules/radius/bin/start_network_service create mode 100644 net_orc/network/modules/radius/conf/ca.crt create mode 100644 net_orc/network/modules/radius/conf/eap create mode 100644 net_orc/network/modules/radius/conf/module_config.json create mode 100644 net_orc/network/modules/radius/python/requirements.txt create mode 100644 net_orc/network/modules/radius/python/src/authenticator.py create mode 100644 net_orc/network/modules/radius/radius.Dockerfile create mode 100644 net_orc/network/modules/template/bin/start_network_service create mode 100644 net_orc/network/modules/template/conf/module_config.json create mode 100644 net_orc/network/modules/template/python/src/template_main.py create mode 100644 net_orc/network/modules/template/template.Dockerfile create mode 100644 net_orc/orchestrator.Dockerfile create mode 100644 net_orc/python/requirements.txt create mode 100644 net_orc/python/src/listener.py create mode 100644 net_orc/python/src/logger.py create mode 100644 net_orc/python/src/network_event.py create mode 100644 net_orc/python/src/network_orchestrator.py create mode 100644 net_orc/python/src/network_runner.py create mode 100644 net_orc/python/src/network_validator.py create mode 100644 net_orc/python/src/run_validator.py create mode 100644 net_orc/python/src/util.py diff --git a/.gitignore b/.gitignore index f79a6efcb..15aae1278 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,6 @@ # Runtime folder runtime/ venv/ -net_orc/ .vscode/ # Byte-compiled / optimized / DLL files diff --git a/cmd/install b/cmd/install index 6dee1c635..539234006 100755 --- a/cmd/install +++ b/cmd/install @@ -1,19 +1,13 @@ #!/bin/bash -e -GIT_URL=https://github.com/auto-iot -NET_ORC_DIR=net_orc -NET_ORC_VERSION="main" - python3 -m venv venv source venv/bin/activate -pip3 install -r etc/requirements.txt +pip3 install --upgrade requests -rm -rf $NET_ORC_DIR -git clone -b $NET_ORC_VERSION $GIT_URL/network-orchestrator $NET_ORC_DIR -chown -R $USER $NET_ORC_DIR +pip3 install -r net_orc/python/requirements.txt -pip3 install -r $NET_ORC_DIR/python/requirements.txt +pip3 install -r test_orc/python/requirements.txt -deactivate \ No newline at end of file +deactivate diff --git a/cmd/start b/cmd/start index 113f14b3e..d146f413d 100755 --- a/cmd/start +++ b/cmd/start @@ -20,4 +20,25 @@ source venv/bin/activate # TODO: Execute python code python -u framework/test_runner.py $@ +# TODO: Work in progress code for containerization of OVS module +# asyncRun() { +# "$@" & +# pid="$!" +# echo "PID Running: " $pid +# trap "echo 'Stopping PID $pid'; kill -SIGTERM $pid" SIGINT SIGTERM + +# sleep 10 + +# # A signal emitted while waiting will make the wait command return code > 128 +# # Let's wrap it in a loop that doesn't end before the process is indeed stopped +# while kill -0 $pid > /dev/null 2>&1; do +# #while $(kill -0 $pid 2>/dev/null); do +# wait +# done +# } + +# # -u flag allows python print statements +# # to be logged by docker by running unbuffered +# asyncRun python3 -u python/src/run.py $@ + deactivate \ No newline at end of file diff --git a/etc/requirements.txt b/etc/requirements.txt deleted file mode 100644 index 979b408bd..000000000 --- a/etc/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -netifaces -scapy \ No newline at end of file diff --git a/framework/.gitignore b/framework/.gitignore deleted file mode 100644 index ba0430d26..000000000 --- a/framework/.gitignore +++ /dev/null @@ -1 +0,0 @@ -__pycache__/ \ No newline at end of file diff --git a/framework/test_runner.py b/framework/test_runner.py index 91ff4cb1a..14cadf3e1 100644 --- a/framework/test_runner.py +++ b/framework/test_runner.py @@ -19,9 +19,9 @@ class TestRunner: - def __init__(self, local_net=True, config_file=None, validate=True, net_only=False): + def __init__(self, config_file=None, validate=True, net_only=False): self._register_exits() - self.test_run = TestRun(local_net=local_net, config_file=config_file, + self.test_run = TestRun(config_file=config_file, validate=validate, net_only=net_only) def _register_exits(self): @@ -51,9 +51,6 @@ def start(self): def parse_args(argv): parser = argparse.ArgumentParser(description="Test Run", formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-r", "--remote-net", action="store_false", - help='''Use the network orchestrator from the parent directory instead - of the one downloaded locally from the install script.''') parser.add_argument("-f", "--config-file", default=None, help="Define the configuration file for Test Run and Network Orchestrator") parser.add_argument("--no-validate", action="store_true", @@ -66,8 +63,7 @@ def parse_args(argv): if __name__ == "__main__": args = parse_args(sys.argv) - runner = TestRunner(local_net=args.remote_net, - config_file=args.config_file, + runner = TestRunner(config_file=args.config_file, validate=not args.no_validate, net_only=args.net_only) runner.start() diff --git a/framework/testrun.py b/framework/testrun.py index 42534265a..0561163ac 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -38,7 +38,7 @@ class TestRun: # pylint: disable=too-few-public-methods orchestrator and user interface. """ - def __init__(self, local_net=True, config_file=CONFIG_FILE,validate=True, net_only=False): + def __init__(self, config_file=CONFIG_FILE,validate=True, net_only=False): self._devices = [] self._net_only = net_only @@ -46,7 +46,7 @@ def __init__(self, local_net=True, config_file=CONFIG_FILE,validate=True, net_on self._register_exits() # Import the correct net orchestrator - self.import_dependencies(local_net) + self.import_dependencies() # Expand the config file to absolute pathing config_file_abs=self._get_config_abs(config_file=config_file) @@ -78,17 +78,9 @@ def stop(self,kill=False): self._stop_tests() self._stop_network(kill=kill) - 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') + def import_dependencies(self): # Add net_orc to Python path + net_orc_dir = os.path.join(parent_dir, 'net_orc', 'python', 'src') sys.path.append(net_orc_dir) # Import the network orchestrator global net_orc diff --git a/net_orc/LICENSE b/net_orc/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/net_orc/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/net_orc/README.md b/net_orc/README.md new file mode 100644 index 000000000..9cb1eec1a --- /dev/null +++ b/net_orc/README.md @@ -0,0 +1,66 @@ +Testrun logo + +## Introduction :wave: +The network orchestrator is a tool to automate the management of a test lab network and provide essential services to begin device testing in just a few minutes. + +## Motivation :bulb: +Test labs may be maintaining a large and complex network using equipment such as: A managed layer 3 switch, an enterprise-grade network router, virtualized or physical servers to provide DNS, NTP, 802.1x etc. With this amount of moving parts, all with dynamic configuration files and constant software updates, more time is likely to be spent on preparation and clean up of functinality or penetration testing - not forgetting the number of software tools required to perform the testing. + +## How it works :triangular_ruler: +The network orchestrator creates an isolated and controlled network environment to fully simulate enterprise network deployments in your device testing lab. +This removes the necessity for complex hardware, advanced knowledge and networking experience whilst enabling semi-technical engineers to validate device +behaviour against industry cyber standards. + +The network orchestrator will provide the network and some tools to assist an engineer performing the additional testing. At the same time, packet captures of the device behaviour will be recorded, alongside logs for each network service, for further debugging. + +## Minimum Requirements :computer: +### Hardware + - PC running Ubuntu LTS (laptop or desktop) + - 2x USB ethernet adapter (One may be built in ethernet) + - Connect one adapter to your router (for internet access) + - Connect one adapter to your device under test + - Internet connection +### Software + - Python 3 with pip3 (Already available on Ubuntu LTS) + - Docker - [Install guide](https://docs.docker.com/engine/install/ubuntu/) + - Open vSwitch ``sudo apt-get install openvswitch-common openvswitch-switch`` + +An additional network interface (even wifi) with internet access can be used to maintain internet connection during use of the network orchestrator. + +## How to use :arrow_forward: +1) Ensure you have a device with the minimum hardware and software requirements setup +2) Clone the project using ```git clone https://github.com/auto-iot/network-orchestrator``` +3) Navigate into the project using ```cd network-orchestrator``` +4) Copy conf/system.json.example to conf/system.json (after setting the correct interfaces in the file) +5) Start the tool using ```sudo cmd/start``` + +## Issue reporting :triangular_flag_on_post: +If the application has come across a problem at any point during setup or use, please raise an issue under the [issues tab](https://github.com/auto-iot/network-orchestrator/issues). Issue templates exist for both bug reports and feature requests. If neither of these are appropriate for your issue, raise a blank issue instead. + +## Roadmap :chart_with_upwards_trend: + - Ability to modify configuration files of each network service during use (via GRPC) + - IPv6 internet routing + +## Contributing :keyboard: +The contributing requirements can be found in [CONTRIBUTING.md](CONTRIBUTING.md). In short, checkout the [Google CLA](https://cla.developers.google.com/) site to get started. + +## FAQ :raising_hand: +1) What services are provided on the virtual network? + + The following are network services that are containerized and accessible to the device under test though are likely to change over time: + - DHCP in failover configuration with internet connectivity + - IPv6 router advertisements + - DNS (and DNS over HTTPS) + - NTPv4 + - 802.1x Port Based Authentication + +2) Can I run the network orchestrator on a virtual machine? + + Probably. Provided that the required 2x USB ethernet adapters are passed to the virtual machine as USB devices rather than network adapters, the tool should + still work. We will look to test and approve the use of virtualisation in the future. + +3) Can I connect multiple devices to the Network Orchestrator? + + In short, Yes you can. The way in which multiple devices could be tested simultaneously is yet to be decided. However, if you simply want to add field/peer devices during runtime (even another laptop performing manual testing) then you may connect the USB ethernet adapter to an unmanaged switch. + +4) Raise an issue with the label 'question' if your question has not been answered in this readme. \ No newline at end of file diff --git a/net_orc/docker-compose.yml b/net_orc/docker-compose.yml new file mode 100644 index 000000000..8c50d766a --- /dev/null +++ b/net_orc/docker-compose.yml @@ -0,0 +1,64 @@ +version: "3.7" + +services: + + base: + build: + context: network/modules/base + dockerfile: base.Dockerfile + image: test-run/base + container_name: tr-ct-base + + ovs: + depends_on: + - base + build: + context: network/modules/ovs + dockerfile: ovs.Dockerfile + image: test-run/ovs + network_mode: host + container_name: tr-ct-ovs + stdin_open: true + privileged: true + volumes: + - $PWD/network/modules/ovs/python:/ovs/python + # Mount host open vswitch socket to allow container + # access to control open vswitch on the host + - /var/run/openvswitch/db.sock:/var/run/openvswitch/db.sock + # Mount host network namespace to allow container + # access to assign proper namespaces to containers + - /var/run/netns:/var/run/netns + + netorch: + depends_on: + - base + build: + context: . + dockerfile: orchestrator.Dockerfile + image: test-run/orchestrator + network_mode: host + privileged: true + volumes: + - $PWD/cmd:/orchestrator/cmd + - $PWD/network:/orchestrator/network + - $PWD/python:/orchestrator/python + # Mount host docker socket to allow container access + # control docker containers on the host + - /var/run/docker.sock:/var/run/docker.sock + # Mount host open vswitch socket to allow container + # access to control open vswitch on the host + - /var/run/openvswitch/db.sock:/var/run/openvswitch/db.sock + # Mount host network namespace to allow container + # access to assign proper namespaces to containers + - /var/run/netns:/var/run/netns + # Mount the host process information to allow container + # access to configure docker containers and namespaces properly + - /proc:/proc + container_name: network_orchestrator + stdin_open: true + working_dir: /orchestrator + #entrypoint: ["cmd/start"] + # Give more time for stopping so when we stop the container it has + # time to stop all network services gracefuly + stop_grace_period: 60s + entrypoint: ["python3","-u","python/src/run.py"] diff --git a/net_orc/network/devices/faux-dev/bin/get_default_gateway b/net_orc/network/devices/faux-dev/bin/get_default_gateway new file mode 100644 index 000000000..f6f1e2a0d --- /dev/null +++ b/net_orc/network/devices/faux-dev/bin/get_default_gateway @@ -0,0 +1,3 @@ +#!/bin/bash -e + +route | grep default | awk '{print $2}' \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/bin/start_dhcp_client b/net_orc/network/devices/faux-dev/bin/start_dhcp_client new file mode 100644 index 000000000..de9270c82 --- /dev/null +++ b/net_orc/network/devices/faux-dev/bin/start_dhcp_client @@ -0,0 +1,16 @@ +#!/bin/bash -e + +# Fetch the interface +INTF=$1 + +PID_FILE=/var/run/dhclient.pid + +echo "Starting DHCP Client on interface $INTF" + +#Kill any existing running dhclient process +if [ -f $PID_FILE ]; then + kill -9 $(cat $PID_FILE) || true + rm -f $PID_FILE +fi + +dhclient $INTF \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/bin/start_network_service b/net_orc/network/devices/faux-dev/bin/start_network_service new file mode 100644 index 000000000..b727d2091 --- /dev/null +++ b/net_orc/network/devices/faux-dev/bin/start_network_service @@ -0,0 +1,39 @@ +#!/bin/bash -e + +# Directory where all binaries will be loaded +BIN_DIR="/testrun/bin" + +# Fetch module name +MODULE_NAME=$1 + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No interface defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +#Create and set permissions on the output files +LOG_FILE=/runtime/validation/$MODULE_NAME.log +RESULT_FILE=/runtime/validation/result.json +touch $LOG_FILE +touch $RESULT_FILE +chown $HOST_USER:$HOST_USER $LOG_FILE +chown $HOST_USER:$HOST_USER $RESULT_FILE + +# Start dhclient +$BIN_DIR/start_dhcp_client $INTF + +# -u flag allows python print statements +# to be logged by docker by running unbuffered +exec python3 -u /testrun/python/src/run.py "-m $MODULE_NAME" + +echo Network validator complete \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/conf/module_config.json b/net_orc/network/devices/faux-dev/conf/module_config.json new file mode 100644 index 000000000..afde8c629 --- /dev/null +++ b/net_orc/network/devices/faux-dev/conf/module_config.json @@ -0,0 +1,11 @@ +{ + "config": { + "meta": { + "name": "faux-dev", + "description": "Faux device to test network modules are functioning properly" + }, + "docker": { + "timeout": 60 + } + } +} \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/faux-dev.Dockerfile b/net_orc/network/devices/faux-dev/faux-dev.Dockerfile new file mode 100644 index 000000000..1686341b5 --- /dev/null +++ b/net_orc/network/devices/faux-dev/faux-dev.Dockerfile @@ -0,0 +1,20 @@ +# Image name: test-run/faux-dev +FROM test-run/base:latest + +#Update and get all additional requirements not contained in the base image +RUN apt-get update --fix-missing + +# NTP requireds interactive installation so we're going to turn that off +ARG DEBIAN_FRONTEND=noninteractive + +# Install dhcp client and ntp client +RUN apt-get install -y isc-dhcp-client ntp ntpdate + +# Copy over all configuration files +COPY network/devices/faux-dev/conf /testrun/conf + +# Load device binary files +COPY network/devices/faux-dev/bin /testrun/bin + +# Copy over all python files +COPY network/devices/faux-dev/python /testrun/python \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/python/src/dhcp_check.py b/net_orc/network/devices/faux-dev/python/src/dhcp_check.py new file mode 100644 index 000000000..ab7defc39 --- /dev/null +++ b/net_orc/network/devices/faux-dev/python/src/dhcp_check.py @@ -0,0 +1,85 @@ +#!/usr/bin/env python3 + +import time +import logger + +LOGGER = None +LOG_NAME = "dhcp_validator" +DHCP_LEASE_FILE = "/var/lib/dhcp/dhclient.leases" +IP_ADDRESS_KEY = "fixed-address" +DNS_OPTION_KEY = "option domain-name-servers" +GATEWAY_OPTION_KEY = "option routers" +NTP_OPTION_KEY = "option ntp-servers" + + +class DHCPValidator: + def __init__(self, module): + self._dhcp_lease = None + self.dhcp_lease_test = False + self.add_logger(module) + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def print_test_results(self): + self.print_test_result("DHCP lease test", self.dhcp_lease_test) + + def print_test_result(self, test_name, result): + LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") + + def get_dhcp_lease(self): + """Returns the current DHCP lease.""" + return self._dhcp_lease + + def validate(self): + self._resolve_dhcp_lease() + LOGGER.info("IP Addr: " + self._dhcp_lease.ip_addr) + LOGGER.info("Gateway: " + self._dhcp_lease.gateway) + LOGGER.info("DNS Server: " + self._dhcp_lease.dns_server) + LOGGER.info("NTP Server: " + self._dhcp_lease.ntp_server) + + def _resolve_dhcp_lease(self): + LOGGER.info("Resolving DHCP lease...") + while self._dhcp_lease is None: + time.sleep(5) + try: + lease_file = open(DHCP_LEASE_FILE) + lines = lease_file.read() + LOGGER.debug("Lease file:\n" + lines) + leases = lines.split("lease ") + # Last lease is the current lease + cur_lease = leases[-1] + if cur_lease is not None: + LOGGER.debug("Current lease: " + cur_lease) + self._dhcp_lease = DHCPLease() + self.dhcp_lease_test = True + # Iterate over entire lease and pick the parts we care about + lease_parts = cur_lease.split("\n") + for part in lease_parts: + part_clean = part.strip() + if part_clean.startswith(IP_ADDRESS_KEY): + self._dhcp_lease.ip_addr = part_clean[len( + IP_ADDRESS_KEY):-1].strip() + elif part_clean.startswith(DNS_OPTION_KEY): + self._dhcp_lease.dns_server = part_clean[len( + DNS_OPTION_KEY):-1].strip() + elif part_clean.startswith(GATEWAY_OPTION_KEY): + self._dhcp_lease.gateway = part_clean[len( + GATEWAY_OPTION_KEY):-1].strip() + elif part_clean.startswith(NTP_OPTION_KEY): + self._dhcp_lease.ntp_server = part_clean[len( + NTP_OPTION_KEY):-1].strip() + except Exception: + LOGGER.error("DHCP Resolved Error") + LOGGER.info("DHCP lease resolved") + + +class DHCPLease: + """Stores information about a device's DHCP lease.""" + + def __init__(self): + self.ip_addr = None + self.gateway = None + self.dns_server = None + self.ntp_server = None diff --git a/net_orc/network/devices/faux-dev/python/src/dns_check.py b/net_orc/network/devices/faux-dev/python/src/dns_check.py new file mode 100644 index 000000000..d3d709d6e --- /dev/null +++ b/net_orc/network/devices/faux-dev/python/src/dns_check.py @@ -0,0 +1,109 @@ +#!/usr/bin/env python3 + +import logger +import time +import util +import subprocess + +from dhcp_check import DHCPLease + +LOGGER = None +LOG_NAME = "dns_validator" +HOST_PING = "google.com" +CAPTURE_FILE = "/runtime/network/faux-dev.pcap" +DNS_CONFIG_FILE = "/etc/resolv.conf" + + +class DNSValidator: + + def __init__(self, module): + self._dns_server = None + self._dns_resolution_test = False + self._dns_dhcp_server_test = False + self.add_logger(module) + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def print_test_results(self): + self.print_test_result( + "DNS resolution test", self._dns_resolution_test) + self.print_test_result( + "DNS DHCP server test", self._dns_dhcp_server_test) + + def print_test_result(self, test_name, result): + LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") + + def validate(self, dhcp_lease): + self._dns_server = dhcp_lease.dns_server + self._set_dns_server() + self._check_dns_traffic() + + def _check_dns_traffic(self): + LOGGER.info("Checking DNS traffic for DNS server: " + self._dns_server) + + # Ping a host to generate DNS traffic + if self._ping(HOST_PING)[0]: + LOGGER.info("Ping success") + self._dns_resolution_test = True + else: + LOGGER.info("Ping failed") + + # Some delay between pings and DNS traffic in the capture file + # so give some delay before we try to query again + time.sleep(5) + + # Check if the device has sent any DNS requests + filter_to_dns = 'dst port 53 and dst host {}'.format( + self._dns_server) + to_dns = self._exec_tcpdump(filter_to_dns) + num_query_dns = len(to_dns) + LOGGER.info("DNS queries found: " + str(num_query_dns)) + dns_traffic_detected = len(to_dns) > 0 + if dns_traffic_detected: + LOGGER.info("DNS traffic detected to configured DHCP DNS server") + self._dns_dhcp_server_test = True + else: + LOGGER.error("No DNS traffic detected") + + # Docker containeres resolve DNS servers from the host + # and do not play nice with normal networking methods + # so we need to set our DNS servers manually + def _set_dns_server(self): + f = open(DNS_CONFIG_FILE, "w", encoding="utf-8") + f.write("nameserver " + self._dns_server) + f.close() + + # Generate DNS traffic by doing a simple ping by hostname + def _ping(self, host): + cmd = "ping -c 5 " + host + success = util.run_command(cmd, LOGGER) + return success + + def _exec_tcpdump(self, tcpdump_filter): + """ + Args + tcpdump_filter: Filter to pass onto tcpdump file + capture_file: Optional capture file to look + Returns + List of packets matching the filter + """ + command = 'tcpdump -tttt -n -r {} {}'.format( + CAPTURE_FILE, tcpdump_filter) + + LOGGER.debug("tcpdump command: " + command) + + process = subprocess.Popen(command, + universal_newlines=True, + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + text = str(process.stdout.read()).rstrip() + + LOGGER.debug("tcpdump response: " + text) + + if text: + return text.split("\n") + + return [] \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/python/src/gateway_check.py b/net_orc/network/devices/faux-dev/python/src/gateway_check.py new file mode 100644 index 000000000..17457874a --- /dev/null +++ b/net_orc/network/devices/faux-dev/python/src/gateway_check.py @@ -0,0 +1,40 @@ +import logger +import util + +from dhcp_check import DHCPLease + +LOGGER = None +LOG_NAME = "gateway_validator" + + +class GatewayValidator: + + def __init__(self, module): + self._gateway = None + self._default_gateway_test = False + self.add_logger(module) + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def print_test_results(self): + self.print_test_result("Default gateway test", + self._default_gateway_test) + + def print_test_result(self, test_name, result): + LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") + + + def validate(self, dhcp_lease): + self._gateway = dhcp_lease.gateway + self.check_default_gateway() + + def check_default_gateway(self): + LOGGER.info( + "Checking default gateway matches DHCP gateway: " + self._gateway) + cmd = "/testrun/bin/get_default_gateway" + success, default_gateway, stderr = util.run_command(cmd, LOGGER) + LOGGER.info("Default gateway resolved: " + default_gateway) + if default_gateway == self._gateway: + self._default_gateway_test = True \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/python/src/logger.py b/net_orc/network/devices/faux-dev/python/src/logger.py new file mode 100644 index 000000000..bf692c85e --- /dev/null +++ b/net_orc/network/devices/faux-dev/python/src/logger.py @@ -0,0 +1,43 @@ +#!/usr/bin/env python3 + +import json +import logging +import os + +LOGGERS = {} +_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_DATE_FORMAT = '%b %02d %H:%M:%S' +_CONF_DIR = "conf" +_CONF_FILE_NAME = "system.json" +_LOG_DIR = "/runtime/validation" + +# Set log level +with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='utf-8') as conf_file: + system_conf_json = json.load(conf_file) + +log_level_str = system_conf_json['log_level'] +log_level = logging.getLevelName(log_level_str) + +log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) + +def add_file_handler(log, log_file): + """Add file handler to existing log.""" + handler = logging.FileHandler(os.path.join(_LOG_DIR, log_file + ".log")) + handler.setFormatter(log_format) + log.addHandler(handler) + +def add_stream_handler(log): + """Add stream handler to existing log.""" + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + +def get_logger(name, log_file=None): + """Return logger for requesting class.""" + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if log_file is not None: + add_file_handler(LOGGERS[name], log_file) + return LOGGERS[name] diff --git a/net_orc/network/devices/faux-dev/python/src/ntp_check.py b/net_orc/network/devices/faux-dev/python/src/ntp_check.py new file mode 100644 index 000000000..a50bf337e --- /dev/null +++ b/net_orc/network/devices/faux-dev/python/src/ntp_check.py @@ -0,0 +1,79 @@ +import time +import logger +import util + +LOGGER = None +LOG_NAME = "ntp_validator" +ATTEMPTS = 3 + + +class NTPValidator: + """Perform testing of the NTP server.""" + + def __init__(self, module): + self._ntp_server = None + self._ntp_sync_test = False + self.add_logger(module) + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def print_test_results(self): + """Print all test results to log.""" + self.print_test_result("NTP sync test", + self._ntp_sync_test) + + def print_test_result(self, test_name, result): + """Output test result to log.""" + LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") + + def validate(self, dhcp_lease): + """Call NTP sync test.""" + self._ntp_server = dhcp_lease.ntp_server + self.check_ntp() + + def check_ntp(self): + """Perform NTP sync test.""" + if self._ntp_server is not None: + attempt = 0 + LOGGER.info(f"Attempting to sync to NTP server: {self._ntp_server}") + LOGGER.info("Attempts allowed: " + str(ATTEMPTS)) + + # If we don't ping before syncing, this will fail. + while attempt < ATTEMPTS and not self._ntp_sync_test: + attempt += 1 + if self.ping_ntp_server(): + self.sync_ntp() + if not self._ntp_sync_test: + LOGGER.info("Waiting 5 seconds before next attempt") + time.sleep(5) + else: + LOGGER.info("No NTP server available from DHCP lease") + + def sync_ntp(self): + """Send NTP request to server.""" + LOGGER.info("Sending NTP Sync Request to: " + self._ntp_server) + cmd = "ntpdate " + self._ntp_server + ntp_response = util.run_command(cmd, LOGGER)[1] + LOGGER.info("NTP sync response: " + ntp_response) + if "adjust time server " + self._ntp_server in ntp_response: + LOGGER.info("NTP sync succesful") + self._ntp_sync_test = True + else: + LOGGER.info("NTP client failed to sync to server") + + def ping_ntp_server(self): + """Ping NTP server before sending a time request.""" + LOGGER.info("Pinging NTP server before syncing...") + if self.ping(self._ntp_server): + LOGGER.info("NTP server successfully pinged") + return True + LOGGER.info("NTP server did not respond to ping") + return False + + def ping(self, host): + """Send ping request to host.""" + cmd = "ping -c 1 " + host + success = util.run_command(cmd, LOGGER) + return success diff --git a/net_orc/network/devices/faux-dev/python/src/run.py b/net_orc/network/devices/faux-dev/python/src/run.py new file mode 100644 index 000000000..5891b8c4b --- /dev/null +++ b/net_orc/network/devices/faux-dev/python/src/run.py @@ -0,0 +1,114 @@ +#!/usr/bin/env python3 + +import argparse +import json +import os +import signal +import sys + +import logger +from dns_check import DNSValidator +from dhcp_check import DHCPValidator +from gateway_check import GatewayValidator +from ntp_check import NTPValidator + +RESULTS_DIR = '/runtime/validation/' +LOGGER = logger.get_logger('validator') + +class FauxDevice: + """Represents a virtual testing device.""" + + def __init__(self, module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + + self.dhcp_validator = DHCPValidator(module) + self.dns_validator = DNSValidator(module) + self.gateway_validator = GatewayValidator(module) + self.ntp_validator = NTPValidator(module) + + self._module = module + self.run_tests() + results = self.generate_results() + self.write_results(results) + + def run_tests(self): + """Execute configured network tests.""" + + # Run DHCP tests first since everything hinges on basic DHCP compliance first + self.dhcp_validator.validate() + + dhcp_lease = self.dhcp_validator.get_dhcp_lease() + + # Use current lease from dhcp tests to validate DNS behaviors + self.dns_validator.validate(dhcp_lease) + + # Use current lease from dhcp tests to validate default gateway + self.gateway_validator.validate(dhcp_lease) + + # Use current lease from dhcp tests to validate ntp server + self.ntp_validator.validate(dhcp_lease) + + def print_test_results(self): + """Print test results to log.""" + self.dhcp_validator.print_test_results() + self.dns_validator.print_test_results() + self.gateway_validator.print_test_results() + self.ntp_validator.print_test_results() + + def generate_results(self): + """Transform test results into JSON format.""" + + results = [] + results.append(self.generate_result("dhcp_lease", self.dhcp_validator.dhcp_lease_test)) + results.append(self.generate_result("dns_from_dhcp", self.dns_validator._dns_dhcp_server_test)) + results.append(self.generate_result("dns_resolution", self.dns_validator._dns_resolution_test)) + results.append(self.generate_result("gateway_default", self.gateway_validator._default_gateway_test)) + results.append(self.generate_result("ntp_sync", self.ntp_validator._ntp_sync_test)) + json_results = json.dumps({"results":results}, indent=2) + + return json_results + + def write_results(self, results): + """Write test results to file.""" + results_file = os.path.join(RESULTS_DIR, "result.json") + LOGGER.info("Writing results to " + results_file) + f = open(results_file, "w", encoding="utf-8") + f.write(results) + f.close() + + def generate_result(self, test_name, test_result): + """Return JSON object for test result.""" + if test_result is not None: + result = "compliant" if test_result else "non-compliant" + else: + result = "skipped" + LOGGER.info(test_name + ": " + result) + res_dict = { + "name": test_name, + "result": result + } + return res_dict + + def _handler(self, signum, frame): # pylint: disable=unused-argument + if signum in (2, signal.SIGTERM): + sys.exit(1) + +def run(argv): # pylint: disable=unused-argument + """Run the network validator.""" + parser = argparse.ArgumentParser(description="Faux Device _validator", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("-m","--module", + help="Define the module name to be used to create the log file") + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + FauxDevice(args.module.strip()) + +if __name__ == "__main__": + run(sys.argv) diff --git a/net_orc/network/devices/faux-dev/python/src/util.py b/net_orc/network/devices/faux-dev/python/src/util.py new file mode 100644 index 000000000..605af1132 --- /dev/null +++ b/net_orc/network/devices/faux-dev/python/src/util.py @@ -0,0 +1,28 @@ +import subprocess +import shlex + +# Runs a process at the os level +# By default, returns the standard output and error output +# If the caller sets optional output parameter to False, +# will only return a boolean result indicating if it was +# succesful in running the command. Failure is indicated +# by any return code from the process other than zero. + + +def run_command(cmd, logger, output=True): + success = False + process = subprocess.Popen(shlex.split( + cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + + if process.returncode != 0: + err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) + logger.error("Command Failed: " + cmd) + logger.error("Error: " + err_msg) + else: + success = True + + if output: + return success, stdout.strip().decode('utf-8'), stderr + else: + return success, None, stderr diff --git a/net_orc/network/modules/base/base.Dockerfile b/net_orc/network/modules/base/base.Dockerfile new file mode 100644 index 000000000..2400fd1c6 --- /dev/null +++ b/net_orc/network/modules/base/base.Dockerfile @@ -0,0 +1,23 @@ +# Image name: test-run/base +FROM ubuntu:jammy + +# Install common software +RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix + +#Setup the base python requirements +COPY network/modules/base/python /testrun/python + +# Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt + +# Add the bin files +COPY network/modules/base/bin /testrun/bin + +# Remove incorrect line endings +RUN dos2unix /testrun/bin/* + +# Make sure all the bin files are executable +RUN chmod u+x /testrun/bin/* + +#Start the network module +ENTRYPOINT [ "/testrun/bin/start_module" ] \ No newline at end of file diff --git a/net_orc/network/modules/base/bin/capture b/net_orc/network/modules/base/bin/capture new file mode 100644 index 000000000..8a8430feb --- /dev/null +++ b/net_orc/network/modules/base/bin/capture @@ -0,0 +1,30 @@ +#!/bin/bash -e + +# Fetch module name +MODULE_NAME=$1 + +# Define the local file location for the capture to be saved +PCAP_DIR="/runtime/network/" +PCAP_FILE=$MODULE_NAME.pcap + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE ]] +then + INTERFACE=$DEFAULT_IFACE +else + INTERFACE=$DEFINED_IFACE +fi + +# Create the output directory and start the capture +mkdir -p $PCAP_DIR +chown $HOST_USER:$HOST_USER $PCAP_DIR +tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & + +#Small pause to let the capture to start +sleep 1 \ No newline at end of file diff --git a/net_orc/network/modules/base/bin/setup_binaries b/net_orc/network/modules/base/bin/setup_binaries new file mode 100644 index 000000000..3535ead3c --- /dev/null +++ b/net_orc/network/modules/base/bin/setup_binaries @@ -0,0 +1,10 @@ +#!/bin/bash -e + +# Directory where all binaries will be loaded +BIN_DIR=$1 + +# Remove incorrect line endings +dos2unix $BIN_DIR/* + +# Make sure all the bin files are executable +chmod u+x $BIN_DIR/* \ No newline at end of file diff --git a/net_orc/network/modules/base/bin/start_grpc b/net_orc/network/modules/base/bin/start_grpc new file mode 100644 index 000000000..9792b4bd4 --- /dev/null +++ b/net_orc/network/modules/base/bin/start_grpc @@ -0,0 +1,17 @@ +#!/bin/bash -e + +GRPC_DIR="/testrun/python/src/grpc" +GRPC_PROTO_DIR="proto" +GRPC_PROTO_FILE="grpc.proto" + +#Move into the grpc directory +pushd $GRPC_DIR >/dev/null 2>&1 + +#Build the grpc proto file every time before starting server +python3 -m grpc_tools.protoc --proto_path=. ./$GRPC_PROTO_DIR/$GRPC_PROTO_FILE --python_out=. --grpc_python_out=. + +popd >/dev/null 2>&1 + +#Start the grpc server +python3 -u $GRPC_DIR/start_server.py $@ + diff --git a/net_orc/network/modules/base/bin/start_module b/net_orc/network/modules/base/bin/start_module new file mode 100644 index 000000000..7fdcbc404 --- /dev/null +++ b/net_orc/network/modules/base/bin/start_module @@ -0,0 +1,79 @@ +#!/bin/bash + +# Directory where all binaries will be loaded +BIN_DIR="/testrun/bin" + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Create a local user that matches the same as the host +# to be used for correct file ownership for various logs +# HOST_USER mapped in via docker container environemnt variables +useradd $HOST_USER + +# Enable IPv6 for all containers +sysctl net.ipv6.conf.all.disable_ipv6=0 +sysctl -p + +#Read in the config file +CONF_FILE="/testrun/conf/module_config.json" +CONF=`cat $CONF_FILE` + +if [[ -z $CONF ]] +then + echo "No config file present at $CONF_FILE. Exiting startup." + exit 1 +fi + +# Extract the necessary config parameters +MODULE_NAME=$(echo "$CONF" | jq -r '.config.meta.name') +DEFINED_IFACE=$(echo "$CONF" | jq -r '.config.network.interface') +GRPC=$(echo "$CONF" | jq -r '.config.grpc') + +# Validate the module name is present +if [[ -z "$MODULE_NAME" || "$MODULE_NAME" == "null" ]] +then + echo "No module name present in $CONF_FILE. Exiting startup." + exit 1 +fi + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No Interface Defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +echo "Starting module $MODULE_NAME on local interface $INTF..." + +$BIN_DIR/setup_binaries $BIN_DIR + +# Wait for interface to become ready +$BIN_DIR/wait_for_interface $INTF + +# Small pause to let the interface stabalize before starting the capture +#sleep 1 + +# Start network capture +$BIN_DIR/capture $MODULE_NAME $INTF + +# Start the grpc server +if [[ ! -z $GRPC && ! $GRPC == "null" ]] +then + GRPC_PORT=$(echo "$GRPC" | jq -r '.port') + if [[ ! -z $GRPC_PORT && ! $GRPC_PORT == "null" ]] + then + echo "gRPC port resolved from config: $GRPC_PORT" + $BIN_DIR/start_grpc "-p $GRPC_PORT" & + else + $BIN_DIR/start_grpc & + fi +fi + +#Small pause to let all core services stabalize +sleep 3 + +#Start the networking service +$BIN_DIR/start_network_service $MODULE_NAME $INTF \ No newline at end of file diff --git a/net_orc/network/modules/base/bin/start_network_service b/net_orc/network/modules/base/bin/start_network_service new file mode 100644 index 000000000..7d13750b8 --- /dev/null +++ b/net_orc/network/modules/base/bin/start_network_service @@ -0,0 +1,10 @@ +#!/bin/bash + +# Place holder function for testing and validation +# Each network module should include a start_networkig_service +# file that overwrites this one to boot all of the its specific +# requirements to run. + +echo "Starting network service..." +echo "This is not a real network service, just a test" +echo "Network service started" \ No newline at end of file diff --git a/net_orc/network/modules/base/bin/wait_for_interface b/net_orc/network/modules/base/bin/wait_for_interface new file mode 100644 index 000000000..1377705d8 --- /dev/null +++ b/net_orc/network/modules/base/bin/wait_for_interface @@ -0,0 +1,21 @@ +#!/bin/bash + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$1 + +# Select which interace to use +if [[ -z $DEFINED_IFACE ]] +then + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +# Wait for local interface to be ready +while ! ip link show $INTF; do + echo $INTF is not yet ready. Waiting 3 seconds + sleep 3 +done \ No newline at end of file diff --git a/net_orc/network/modules/base/conf/module_config.json b/net_orc/network/modules/base/conf/module_config.json new file mode 100644 index 000000000..1f3a47ba2 --- /dev/null +++ b/net_orc/network/modules/base/conf/module_config.json @@ -0,0 +1,12 @@ +{ + "config": { + "meta": { + "name": "base", + "display_name": "Base", + "description": "Base image" + }, + "docker": { + "enable_container": false + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/base/python/requirements.txt b/net_orc/network/modules/base/python/requirements.txt new file mode 100644 index 000000000..9c4e2b056 --- /dev/null +++ b/net_orc/network/modules/base/python/requirements.txt @@ -0,0 +1,2 @@ +grpcio +grpcio-tools \ No newline at end of file diff --git a/net_orc/network/modules/base/python/src/grpc/start_server.py b/net_orc/network/modules/base/python/src/grpc/start_server.py new file mode 100644 index 000000000..9ed31ffcf --- /dev/null +++ b/net_orc/network/modules/base/python/src/grpc/start_server.py @@ -0,0 +1,34 @@ +from concurrent import futures +import grpc +import proto.grpc_pb2_grpc as pb2_grpc +import proto.grpc_pb2 as pb2 +from network_service import NetworkService +import logging +import sys +import argparse + +DEFAULT_PORT = '5001' + +def serve(PORT): + server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) + pb2_grpc.add_NetworkModuleServicer_to_server(NetworkService(), server) + server.add_insecure_port('[::]:' + PORT) + server.start() + server.wait_for_termination() + +def run(argv): + parser = argparse.ArgumentParser(description="GRPC Server for Network Module", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("-p", "--port", default=DEFAULT_PORT, + help="Define the default port to run the server on.") + + args = parser.parse_args() + + PORT = args.port + + print("gRPC server starting on port " + PORT) + serve(PORT) + + +if __name__ == "__main__": + run(sys.argv) \ No newline at end of file diff --git a/net_orc/network/modules/base/python/src/logger.py b/net_orc/network/modules/base/python/src/logger.py new file mode 100644 index 000000000..4924512c6 --- /dev/null +++ b/net_orc/network/modules/base/python/src/logger.py @@ -0,0 +1,47 @@ +#!/usr/bin/env python3 + +import json +import logging +import os + +LOGGERS = {} +_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_DATE_FORMAT = '%b %02d %H:%M:%S' +_DEFAULT_LEVEL = logging.INFO +_CONF_DIR = "conf" +_CONF_FILE_NAME = "system.json" +_LOG_DIR = "/runtime/network/" + +# Set log level +try: + system_conf_json = json.load( + open(os.path.join(_CONF_DIR, _CONF_FILE_NAME))) + log_level_str = system_conf_json['log_level'] + log_level = logging.getLevelName(log_level_str) +except: + # TODO: Print out warning that log level is incorrect or missing + log_level = _DEFAULT_LEVEL + +log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) + + +def add_file_handler(log, logFile): + handler = logging.FileHandler(_LOG_DIR+logFile+".log") + handler.setFormatter(log_format) + log.addHandler(handler) + + +def add_stream_handler(log): + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + + +def get_logger(name, logFile=None): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if logFile is not None: + add_file_handler(LOGGERS[name], logFile) + return LOGGERS[name] diff --git a/net_orc/network/modules/dhcp-1/bin/start_network_service b/net_orc/network/modules/dhcp-1/bin/start_network_service new file mode 100644 index 000000000..e8e0ad06c --- /dev/null +++ b/net_orc/network/modules/dhcp-1/bin/start_network_service @@ -0,0 +1,77 @@ +#!/bin/bash + +CONFIG_FILE=/etc/dhcp/dhcpd.conf +DHCP_PID_FILE=/var/run/dhcpd.pid +DHCP_LOG_FILE=/runtime/network/dhcp1-dhcpd.log +RA_PID_FILE=/var/run/radvd/radvd.pid +RA_LOG_FILE=/runtime/network/dhcp1-radvd.log + +echo "Starrting Network Service..." + +#Enable IPv6 Forwarding +sysctl net.ipv6.conf.all.forwarding=1 +sysctl -p + +# Create leases file if needed +touch /var/lib/dhcp/dhcpd.leases + +#Create directory for radvd +mkdir /var/run/radvd + +#Create and set permissions on the log files +touch $DHCP_LOG_FILE +touch $RA_LOG_FILE +chown $HOST_USER:$HOST_USER $DHCP_LOG_FILE +chown $HOST_USER:$HOST_USER $RA_LOG_FILE + + +#Move the config files to the correct location +cp /testrun/conf/dhcpd.conf /etc/dhcp/dhcpd.conf +cp /testrun/conf/radvd.conf /etc/radvd.conf + +# Restart dhcp server when config changes +while true; do + + new_checksum=$(md5sum $CONFIG_FILE) + + if [ "$checksum" == "$new_checksum" ]; then + sleep 2 + continue + fi + + echo Config changed. Restarting dhcp server at $(date).. + + if [ -f $DHCP_PID_FILE ]; then + kill -9 $(cat $DHCP_PID_FILE) || true + rm -f $DHCP_PID_FILE + fi + + if [ -f $RA_PID_FILE ]; then + kill -9 $(cat $RA_PID_FILE) || true + rm -f $RA_PID_FILE + fi + + checksum=$new_checksum + + echo Starting isc-dhcp-server at $(date) + + radvd -m logfile -l $RA_LOG_FILE -p $RA_PID_FILE + dhcpd -d &> $DHCP_LOG_FILE & + + while [ ! -f $DHCP_PID_FILE ]; do + echo Waiting for $DHCP_PID_FILE... + sleep 2 + done + + echo $DHCP_PID_FILE now available + + while [ ! -f $RA_PID_FILE ]; do + echo Waiting for $RA_PID_FILE... + sleep 2 + done + + echo $RA_PID_FILE now available + + echo Server now stable + +done \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-1/conf/dhcpd.conf b/net_orc/network/modules/dhcp-1/conf/dhcpd.conf new file mode 100644 index 000000000..9f4fe1c28 --- /dev/null +++ b/net_orc/network/modules/dhcp-1/conf/dhcpd.conf @@ -0,0 +1,26 @@ +default-lease-time 300; + +failover peer "failover-peer" { + primary; + address 10.10.10.2; + port 847; + peer address 10.10.10.3; + peer port 647; + max-response-delay 60; + max-unacked-updates 10; + mclt 3600; + split 128; + load balance max seconds 3; +} + +subnet 10.10.10.0 netmask 255.255.255.0 { + option ntp-servers 10.10.10.5; + option subnet-mask 255.255.255.0; + option broadcast-address 10.10.10.255; + option routers 10.10.10.1; + option domain-name-servers 10.10.10.4; + pool { + failover peer "failover-peer"; + range 10.10.10.10 10.10.10.20; + } +} diff --git a/net_orc/network/modules/dhcp-1/conf/module_config.json b/net_orc/network/modules/dhcp-1/conf/module_config.json new file mode 100644 index 000000000..56d9aa271 --- /dev/null +++ b/net_orc/network/modules/dhcp-1/conf/module_config.json @@ -0,0 +1,25 @@ +{ + "config": { + "meta": { + "name": "dhcp-1", + "display_name": "DHCP Primary", + "description": "Primary DHCP server with IPv6 SLAAC" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 2 + }, + "grpc":{ + "port": 5001 + }, + "docker": { + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-1/conf/radvd.conf b/net_orc/network/modules/dhcp-1/conf/radvd.conf new file mode 100644 index 000000000..f6d6f30d9 --- /dev/null +++ b/net_orc/network/modules/dhcp-1/conf/radvd.conf @@ -0,0 +1,12 @@ +interface veth0 +{ + AdvSendAdvert on; + AdvManagedFlag off; + MinRtrAdvInterval 30; + MaxRtrAdvInterval 60; + prefix fd10:77be:4186::/64 { + AdvOnLink on; + AdvAutonomous on; + AdvRouterAddr on; + }; +}; \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile b/net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile new file mode 100644 index 000000000..99804e0e3 --- /dev/null +++ b/net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile @@ -0,0 +1,14 @@ +# Image name: test-run/dhcp-primary +FROM test-run/base:latest + +# Install dhcp server +RUN apt-get install -y isc-dhcp-server radvd + +# Copy over all configuration files +COPY network/modules/dhcp-1/conf /testrun/conf + +# Copy over all binary files +COPY network/modules/dhcp-1/bin /testrun/bin + +# Copy over all python files +COPY network/modules/dhcp-1/python /testrun/python diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/__init__.py b/net_orc/network/modules/dhcp-1/python/src/grpc/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py b/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py new file mode 100644 index 000000000..f5445ca44 --- /dev/null +++ b/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py @@ -0,0 +1,267 @@ +import re + +CONFIG_FILE = "/etc/dhcp/dhcpd.conf" +CONFIG_FILE_TEST = "network/modules/dhcp-1/conf/dhcpd.conf" + +DEFAULT_LEASE_TIME_KEY = "default-lease-time" + + +class DHCPConfig: + + def __init__(self): + self._default_lease_time = 300 + self._subnets = [] + self._peer = None + + def write_config(self): + conf = str(self) + print("Writing config: \n" + conf) + f = open(CONFIG_FILE, "w") + f.write(conf) + + def resolve_config(self): + with open(CONFIG_FILE) as f: + conf = f.read() + self.resolve_subnets(conf) + self.peer = DHCPFailoverPeer(conf) + + def resolve_subnets(self, conf): + self._subnets = [] + regex = r"(subnet.*)" + subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) + for subnet in subnets: + dhcp_subnet = DHCPSubnet(subnet) + self._subnets.append(dhcp_subnet) + + def set_range(self, start, end, subnet=0, pool=0): + print("Setting Range for pool ") + print(self._subnets[subnet]._pools[pool]) + self._subnets[subnet]._pools[pool]._range_start = start + self._subnets[subnet]._pools[pool]._range_end = end + + def resolve_settings(self, conf): + lines = conf.split("\n") + for line in lines: + if DEFAULT_LEASE_TIME_KEY in line: + self._default_lease_time = line.strip().split(DEFAULT_LEASE_TIME_KEY)[ + 1].strip().split(";")[0] + + self.peer = peer + + def __str__(self): + + config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + + config = config.format(length='multi-line', + DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, DEFAULT_LEASE_TIME=self._default_lease_time + ) + + config += "\n\n"+str(self.peer) + for subnet in self._subnets: + config += "\n\n"+str(subnet) + return str(config) + + +FAILOVER_PEER_KEY = "failover peer" +PRIMARY_KEY = "primary" +ADDRESS_KEY = "address" +PORT_KEY = "port" +PEER_ADDRESS_KEY = "peer address" +PEER_PORT_KEY = "peer port" +MAX_RESPONSE_DELAY_KEY = "max-response-delay" +MAX_UNACKED_UPDATES_KEY = "max-unacked-updates" +MCLT_KEY = "mclt" +SPLIT_KEY = "split" +LOAD_BALANCE_MAX_SECONDS_KEY = "load balance max seconds" + + +class DHCPFailoverPeer: + def __init__(self, config): + self.name = None + self.primary = False + self.address = None + self.port = None + self.peer_address = None + self.peer_port = None + self.max_response_delay = None + self.max_unacked_updates = None + self.mclt = None + self.split = None + self.load_balance_max_seconds = None + self.peer = None + + self.resolve_peer(config) + + def __str__(self): + config = "{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n" + config += "\tprimary;" if self.primary else "secondary;" + config += """\n\t{ADDRESS_KEY} {ADDRESS}; + {PORT_KEY} {PORT}; + {PEER_ADDRESS_KEY} {PEER_ADDRESS}; + {PEER_PORT_KEY} {PEER_PORT}; + {MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY}; + {MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES}; + {MCLT_KEY} {MCLT}; + {SPLIT_KEY} {SPLIT}; + {LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS}; + \r}}""" + + return config.format(length='multi-line', + FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, FAILOVER_PEER=self.name, + ADDRESS_KEY=ADDRESS_KEY, ADDRESS=self.address, + PORT_KEY=PORT_KEY, PORT=self.port, + PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, PEER_ADDRESS=self.peer_address, + PEER_PORT_KEY=PEER_PORT_KEY, PEER_PORT=self.peer_port, + MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, MAX_RESPONSE_DELAY=self.max_response_delay, + MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, MAX_UNACKED_UPDATES=self.max_unacked_updates, + MCLT_KEY=MCLT_KEY, MCLT=self.mclt, + SPLIT_KEY=SPLIT_KEY, SPLIT=self.split, + LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds + ) + + def resolve_peer(self, conf): + peer = "" + lines = conf.split("\n") + for line in lines: + if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: + if(len(peer) <= 0): + self.name = line.strip().split(FAILOVER_PEER_KEY)[ + 1].strip().split("{")[0].split("\"")[1] + peer += line+"\n" + if PRIMARY_KEY in line: + self.primary = True + elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: + self.address = line.strip().split(ADDRESS_KEY)[ + 1].strip().split(";")[0] + elif PORT_KEY in line and PEER_PORT_KEY not in line: + self.port = line.strip().split(PORT_KEY)[ + 1].strip().split(";")[0] + elif PEER_ADDRESS_KEY in line: + self.peer_address = line.strip().split(PEER_ADDRESS_KEY)[ + 1].strip().split(";")[0] + elif PEER_PORT_KEY in line: + self.peer_port = line.strip().split(PEER_PORT_KEY)[ + 1].strip().split(";")[0] + elif MAX_RESPONSE_DELAY_KEY in line: + self.max_response_delay = line.strip().split(MAX_RESPONSE_DELAY_KEY)[ + 1].strip().split(";")[0] + elif MAX_UNACKED_UPDATES_KEY in line: + self.max_unacked_updates = line.strip().split(MAX_UNACKED_UPDATES_KEY)[ + 1].strip().split(";")[0] + elif MCLT_KEY in line: + self.mclt = line.strip().split(MCLT_KEY)[ + 1].strip().split(";")[0] + elif SPLIT_KEY in line: + self.split = line.strip().split(SPLIT_KEY)[ + 1].strip().split(";")[0] + elif LOAD_BALANCE_MAX_SECONDS_KEY in line: + self.load_balance_max_seconds = line.strip().split(LOAD_BALANCE_MAX_SECONDS_KEY)[ + 1].strip().split(";")[0] + if line.endswith("}") and len(peer) > 0: + break + self.peer = peer + + +NTP_OPTION_KEY = "option ntp-servers" +SUBNET_MASK_OPTION_KEY = "option subnet-mask" +BROADCAST_OPTION_KEY = "option broadcast-address" +ROUTER_OPTION_KEY = "option routers" +DNS_OPTION_KEY = "option domain-name-servers" + + +class DHCPSubnet: + def __init__(self, subnet): + self._ntp_servers = None + self._subnet_mask = None + self._broadcast = None + self._routers = None + self._dns_servers = None + self._pools = [] + + self.resolve_subnet(subnet) + self.resolve_pools(subnet) + + def __str__(self): + config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ + \r\t{NTP_OPTION_KEY} {NTP_OPTION}; + \r\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION}; + \r\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION}; + \r\t{ROUTER_OPTION_KEY} {ROUTER_OPTION}; + \r\t{DNS_OPTION_KEY} {DNS_OPTION};""" + + config = config.format(length='multi-line', + NTP_OPTION_KEY=NTP_OPTION_KEY, NTP_OPTION=self._ntp_servers, + SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, SUBNET_MASK_OPTION=self._subnet_mask, + BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, BROADCAST_OPTION=self._broadcast, + ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, ROUTER_OPTION=self._routers, + DNS_OPTION_KEY=DNS_OPTION_KEY, DNS_OPTION=self._dns_servers + ) + for pool in self._pools: + config += "\n\t"+str(pool) + + config += "\n\r}" + return config + + def resolve_subnet(self, subnet): + subnet_parts = subnet.split("\n") + for part in subnet_parts: + if NTP_OPTION_KEY in part: + self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[ + 1].strip().split(";")[0] + elif SUBNET_MASK_OPTION_KEY in part: + self._subnet_mask = part.strip().split(SUBNET_MASK_OPTION_KEY)[ + 1].strip().split(";")[0] + elif BROADCAST_OPTION_KEY in part: + self._broadcast = part.strip().split(BROADCAST_OPTION_KEY)[ + 1].strip().split(";")[0] + elif ROUTER_OPTION_KEY in part: + self._routers = part.strip().split(ROUTER_OPTION_KEY)[ + 1].strip().split(";")[0] + elif DNS_OPTION_KEY in part: + self._dns_servers = part.strip().split(DNS_OPTION_KEY)[ + 1].strip().split(";")[0] + + def resolve_pools(self, subnet): + regex = r"(pool.*)\}" + pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) + for pool in pools: + dhcp_pool = DHCPPool(pool) + self._pools.append(dhcp_pool) + + +FAILOVER_KEY = "failover peer" +RANGE_KEY = "range" + + +class DHCPPool: + + def __init__(self, pool): + self._failover_peer = None + self._range_start = None + self._range_end = None + self.resolve_pool(pool) + + def __str__(self): + + config = """pool {{ + \r\t\t{FAILOVER_KEY} "{FAILOVER}"; + \r\t\t{RANGE_KEY} {RANGE_START} {RANGE_END}; + \r\t}}""" + + return config.format(length='multi-line', + FAILOVER_KEY=FAILOVER_KEY, FAILOVER=self._failover_peer, + RANGE_KEY=RANGE_KEY, RANGE_START=self._range_start, RANGE_END=self._range_end, + ) + + def resolve_pool(self, pool): + pool_parts = pool.split("\n") + # pool_parts = pool.split("\n") + for part in pool_parts: + if FAILOVER_KEY in part: + self._failover_peer = part.strip().split( + FAILOVER_KEY)[1].strip().split(";")[0].replace("\"", "") + if RANGE_KEY in part: + range = part.strip().split(RANGE_KEY)[ + 1].strip().split(";")[0] + self._range_start = range.split(" ")[0].strip() + self._range_end = range.split(" ")[1].strip() diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py b/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py new file mode 100644 index 000000000..f90cb6b51 --- /dev/null +++ b/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py @@ -0,0 +1,44 @@ +import proto.grpc_pb2_grpc as pb2_grpc +import proto.grpc_pb2 as pb2 + +from dhcp_config import DHCPConfig + + +class NetworkService(pb2_grpc.NetworkModule): + + def __init__(self): + self._dhcp_config = DHCPConfig() + + """ + Resolve the current DHCP configuration and return + the first range from the first subnet in the file + """ + + def GetDHCPRange(self, request, context): + self._dhcp_config.resolve_config() + pool = self._dhcp_config._subnets[0]._pools[0] + return pb2.DHCPRange(code=200, start=pool._range_start, end=pool._range_end) + + """ + Change DHCP configuration and set the + the first range from the first subnet in the configuration + """ + + def SetDHCPRange(self, request, context): + print("Setting DHCPRange") + print("Start: " + request.start) + print("End: " + request.end) + self._dhcp_config.resolve_config() + self._dhcp_config.set_range(request.start, request.end, 0, 0) + self._dhcp_config.write_config() + return pb2.Response(code=200, message="DHCP Range Set") + + """ + Return the current status of the network module + """ + + def GetStatus(self, request, context): + # ToDo: Figure out how to resolve the current DHCP status + dhcpStatus = True + message = str({"dhcpStatus":dhcpStatus}) + return pb2.Response(code=200, message=message) diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/proto/grpc.proto b/net_orc/network/modules/dhcp-1/python/src/grpc/proto/grpc.proto new file mode 100644 index 000000000..8e2732620 --- /dev/null +++ b/net_orc/network/modules/dhcp-1/python/src/grpc/proto/grpc.proto @@ -0,0 +1,36 @@ +syntax = "proto3"; + +service NetworkModule { + + rpc GetDHCPRange(GetDHCPRangeRequest) returns (DHCPRange) {}; + + rpc SetDHCPRange(DHCPRange) returns (Response) {}; + + rpc GetStatus(GetStatusRequest) returns (Response) {}; + + rpc GetIPAddress(GetIPAddressRequest) returns (Response) {}; + + rpc SetLeaseAddress(SetLeaseAddressRequest) returns (Response) {}; + +} + +message Response { + int32 code = 1; + string message = 2; +} + +message DHCPRange { + int32 code = 1; + string start = 2; + string end = 3; +} + +message GetDHCPRangeRequest {} + +message GetIPAddressRequest {} + +message GetStatusRequest {} + +message SetLeaseAddressRequest { + string ipAddress = 1; +} \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-1/python/src/run.py b/net_orc/network/modules/dhcp-1/python/src/run.py new file mode 100644 index 000000000..830f048cf --- /dev/null +++ b/net_orc/network/modules/dhcp-1/python/src/run.py @@ -0,0 +1,40 @@ +#!/usr/bin/env python3 + +import signal +import sys +import argparse + +from grpc.dhcp_config import DHCPConfig + + +class DHCPServer: + + def __init__(self, module): + + signal.signal(signal.SIGINT, self.handler) + signal.signal(signal.SIGTERM, self.handler) + signal.signal(signal.SIGABRT, self.handler) + signal.signal(signal.SIGQUIT, self.handler) + + config = DHCPConfig() + config.resolve_config() + config.write_config() + + def handler(self, signum, frame): + if (signum == 2 or signal == signal.SIGTERM): + exit(1) + + +def run(argv): + parser = argparse.ArgumentParser(description="Faux Device Validator", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument( + "-m", "--module", help="Define the module name to be used to create the log file") + + args = parser.parse_args() + + server = DHCPServer(args.module) + + +if __name__ == "__main__": + run(sys.argv) diff --git a/net_orc/network/modules/dhcp-2/bin/start_network_service b/net_orc/network/modules/dhcp-2/bin/start_network_service new file mode 100644 index 000000000..d58174695 --- /dev/null +++ b/net_orc/network/modules/dhcp-2/bin/start_network_service @@ -0,0 +1,77 @@ +#!/bin/bash + +CONFIG_FILE=/etc/dhcp/dhcpd.conf +DHCP_PID_FILE=/var/run/dhcpd.pid +DHCP_LOG_FILE=/runtime/network/dhcp2-dhcpd.log +RA_PID_FILE=/var/run/radvd/radvd.pid +RA_LOG_FILE=/runtime/network/dhcp2-radvd.log + +echo "Starrting Network Service..." + +#Enable IPv6 Forwarding +sysctl net.ipv6.conf.all.forwarding=1 +sysctl -p + +# Create leases file if needed +touch /var/lib/dhcp/dhcpd.leases + +#Create directory for radvd +mkdir /var/run/radvd + +#Create and set permissions on the log files +touch $DHCP_LOG_FILE +touch $RA_LOG_FILE +chown $HOST_USER:$HOST_USER $DHCP_LOG_FILE +chown $HOST_USER:$HOST_USER $RA_LOG_FILE + + +#Move the config files to the correct location +cp /testrun/conf/dhcpd.conf /etc/dhcp/dhcpd.conf +cp /testrun/conf/radvd.conf /etc/radvd.conf + +# Restart dhcp server when config changes +while true; do + + new_checksum=$(md5sum $CONFIG_FILE) + + if [ "$checksum" == "$new_checksum" ]; then + sleep 2 + continue + fi + + echo Config changed. Restarting dhcp server at $(date).. + + if [ -f $DHCP_PID_FILE ]; then + kill -9 $(cat $DHCP_PID_FILE) || true + rm -f $DHCP_PID_FILE + fi + + if [ -f $RA_PID_FILE ]; then + kill -9 $(cat $RA_PID_FILE) || true + rm -f $RA_PID_FILE + fi + + checksum=$new_checksum + + echo Starting isc-dhcp-server at $(date) + + radvd -m logfile -l $RA_LOG_FILE -p $RA_PID_FILE + dhcpd -d &> $DHCP_LOG_FILE & + + while [ ! -f $DHCP_PID_FILE ]; do + echo Waiting for $DHCP_PID_FILE... + sleep 2 + done + + echo $DHCP_PID_FILE now available + + while [ ! -f $RA_PID_FILE ]; do + echo Waiting for $RA_PID_FILE... + sleep 2 + done + + echo $RA_PID_FILE now available + + echo Server now stable + +done \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-2/conf/dhcpd.conf b/net_orc/network/modules/dhcp-2/conf/dhcpd.conf new file mode 100644 index 000000000..e73a81441 --- /dev/null +++ b/net_orc/network/modules/dhcp-2/conf/dhcpd.conf @@ -0,0 +1,24 @@ +default-lease-time 300; + +failover peer "failover-peer" { + secondary; + address 10.10.10.3; + port 647; + peer address 10.10.10.2; + peer port 847; + max-response-delay 60; + max-unacked-updates 10; + load balance max seconds 3; +} + +subnet 10.10.10.0 netmask 255.255.255.0 { + option ntp-servers 10.10.10.5; + option subnet-mask 255.255.255.0; + option broadcast-address 10.10.10.255; + option routers 10.10.10.1; + option domain-name-servers 10.10.10.4; + pool { + failover peer "failover-peer"; + range 10.10.10.10 10.10.10.20; + } +} diff --git a/net_orc/network/modules/dhcp-2/conf/module_config.json b/net_orc/network/modules/dhcp-2/conf/module_config.json new file mode 100644 index 000000000..2a978ca8c --- /dev/null +++ b/net_orc/network/modules/dhcp-2/conf/module_config.json @@ -0,0 +1,25 @@ +{ + "config": { + "meta": { + "name": "dhcp-2", + "display_name": "DHCP Secondary", + "description": "Secondary DHCP server with IPv6 SLAAC" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 3 + }, + "grpc":{ + "port": 5001 + }, + "docker": { + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-2/conf/radvd.conf b/net_orc/network/modules/dhcp-2/conf/radvd.conf new file mode 100644 index 000000000..f6d6f30d9 --- /dev/null +++ b/net_orc/network/modules/dhcp-2/conf/radvd.conf @@ -0,0 +1,12 @@ +interface veth0 +{ + AdvSendAdvert on; + AdvManagedFlag off; + MinRtrAdvInterval 30; + MaxRtrAdvInterval 60; + prefix fd10:77be:4186::/64 { + AdvOnLink on; + AdvAutonomous on; + AdvRouterAddr on; + }; +}; \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile b/net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile new file mode 100644 index 000000000..989992570 --- /dev/null +++ b/net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile @@ -0,0 +1,14 @@ +# Image name: test-run/dhcp-primary +FROM test-run/base:latest + +# Install dhcp server +RUN apt-get install -y isc-dhcp-server radvd + +# Copy over all configuration files +COPY network/modules/dhcp-2/conf /testrun/conf + +# Copy over all binary files +COPY network/modules/dhcp-2/bin /testrun/bin + +# Copy over all python files +COPY network/modules/dhcp-2/python /testrun/python diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/__init__.py b/net_orc/network/modules/dhcp-2/python/src/grpc/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py b/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py new file mode 100644 index 000000000..f5445ca44 --- /dev/null +++ b/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py @@ -0,0 +1,267 @@ +import re + +CONFIG_FILE = "/etc/dhcp/dhcpd.conf" +CONFIG_FILE_TEST = "network/modules/dhcp-1/conf/dhcpd.conf" + +DEFAULT_LEASE_TIME_KEY = "default-lease-time" + + +class DHCPConfig: + + def __init__(self): + self._default_lease_time = 300 + self._subnets = [] + self._peer = None + + def write_config(self): + conf = str(self) + print("Writing config: \n" + conf) + f = open(CONFIG_FILE, "w") + f.write(conf) + + def resolve_config(self): + with open(CONFIG_FILE) as f: + conf = f.read() + self.resolve_subnets(conf) + self.peer = DHCPFailoverPeer(conf) + + def resolve_subnets(self, conf): + self._subnets = [] + regex = r"(subnet.*)" + subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) + for subnet in subnets: + dhcp_subnet = DHCPSubnet(subnet) + self._subnets.append(dhcp_subnet) + + def set_range(self, start, end, subnet=0, pool=0): + print("Setting Range for pool ") + print(self._subnets[subnet]._pools[pool]) + self._subnets[subnet]._pools[pool]._range_start = start + self._subnets[subnet]._pools[pool]._range_end = end + + def resolve_settings(self, conf): + lines = conf.split("\n") + for line in lines: + if DEFAULT_LEASE_TIME_KEY in line: + self._default_lease_time = line.strip().split(DEFAULT_LEASE_TIME_KEY)[ + 1].strip().split(";")[0] + + self.peer = peer + + def __str__(self): + + config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + + config = config.format(length='multi-line', + DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, DEFAULT_LEASE_TIME=self._default_lease_time + ) + + config += "\n\n"+str(self.peer) + for subnet in self._subnets: + config += "\n\n"+str(subnet) + return str(config) + + +FAILOVER_PEER_KEY = "failover peer" +PRIMARY_KEY = "primary" +ADDRESS_KEY = "address" +PORT_KEY = "port" +PEER_ADDRESS_KEY = "peer address" +PEER_PORT_KEY = "peer port" +MAX_RESPONSE_DELAY_KEY = "max-response-delay" +MAX_UNACKED_UPDATES_KEY = "max-unacked-updates" +MCLT_KEY = "mclt" +SPLIT_KEY = "split" +LOAD_BALANCE_MAX_SECONDS_KEY = "load balance max seconds" + + +class DHCPFailoverPeer: + def __init__(self, config): + self.name = None + self.primary = False + self.address = None + self.port = None + self.peer_address = None + self.peer_port = None + self.max_response_delay = None + self.max_unacked_updates = None + self.mclt = None + self.split = None + self.load_balance_max_seconds = None + self.peer = None + + self.resolve_peer(config) + + def __str__(self): + config = "{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n" + config += "\tprimary;" if self.primary else "secondary;" + config += """\n\t{ADDRESS_KEY} {ADDRESS}; + {PORT_KEY} {PORT}; + {PEER_ADDRESS_KEY} {PEER_ADDRESS}; + {PEER_PORT_KEY} {PEER_PORT}; + {MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY}; + {MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES}; + {MCLT_KEY} {MCLT}; + {SPLIT_KEY} {SPLIT}; + {LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS}; + \r}}""" + + return config.format(length='multi-line', + FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, FAILOVER_PEER=self.name, + ADDRESS_KEY=ADDRESS_KEY, ADDRESS=self.address, + PORT_KEY=PORT_KEY, PORT=self.port, + PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, PEER_ADDRESS=self.peer_address, + PEER_PORT_KEY=PEER_PORT_KEY, PEER_PORT=self.peer_port, + MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, MAX_RESPONSE_DELAY=self.max_response_delay, + MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, MAX_UNACKED_UPDATES=self.max_unacked_updates, + MCLT_KEY=MCLT_KEY, MCLT=self.mclt, + SPLIT_KEY=SPLIT_KEY, SPLIT=self.split, + LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds + ) + + def resolve_peer(self, conf): + peer = "" + lines = conf.split("\n") + for line in lines: + if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: + if(len(peer) <= 0): + self.name = line.strip().split(FAILOVER_PEER_KEY)[ + 1].strip().split("{")[0].split("\"")[1] + peer += line+"\n" + if PRIMARY_KEY in line: + self.primary = True + elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: + self.address = line.strip().split(ADDRESS_KEY)[ + 1].strip().split(";")[0] + elif PORT_KEY in line and PEER_PORT_KEY not in line: + self.port = line.strip().split(PORT_KEY)[ + 1].strip().split(";")[0] + elif PEER_ADDRESS_KEY in line: + self.peer_address = line.strip().split(PEER_ADDRESS_KEY)[ + 1].strip().split(";")[0] + elif PEER_PORT_KEY in line: + self.peer_port = line.strip().split(PEER_PORT_KEY)[ + 1].strip().split(";")[0] + elif MAX_RESPONSE_DELAY_KEY in line: + self.max_response_delay = line.strip().split(MAX_RESPONSE_DELAY_KEY)[ + 1].strip().split(";")[0] + elif MAX_UNACKED_UPDATES_KEY in line: + self.max_unacked_updates = line.strip().split(MAX_UNACKED_UPDATES_KEY)[ + 1].strip().split(";")[0] + elif MCLT_KEY in line: + self.mclt = line.strip().split(MCLT_KEY)[ + 1].strip().split(";")[0] + elif SPLIT_KEY in line: + self.split = line.strip().split(SPLIT_KEY)[ + 1].strip().split(";")[0] + elif LOAD_BALANCE_MAX_SECONDS_KEY in line: + self.load_balance_max_seconds = line.strip().split(LOAD_BALANCE_MAX_SECONDS_KEY)[ + 1].strip().split(";")[0] + if line.endswith("}") and len(peer) > 0: + break + self.peer = peer + + +NTP_OPTION_KEY = "option ntp-servers" +SUBNET_MASK_OPTION_KEY = "option subnet-mask" +BROADCAST_OPTION_KEY = "option broadcast-address" +ROUTER_OPTION_KEY = "option routers" +DNS_OPTION_KEY = "option domain-name-servers" + + +class DHCPSubnet: + def __init__(self, subnet): + self._ntp_servers = None + self._subnet_mask = None + self._broadcast = None + self._routers = None + self._dns_servers = None + self._pools = [] + + self.resolve_subnet(subnet) + self.resolve_pools(subnet) + + def __str__(self): + config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ + \r\t{NTP_OPTION_KEY} {NTP_OPTION}; + \r\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION}; + \r\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION}; + \r\t{ROUTER_OPTION_KEY} {ROUTER_OPTION}; + \r\t{DNS_OPTION_KEY} {DNS_OPTION};""" + + config = config.format(length='multi-line', + NTP_OPTION_KEY=NTP_OPTION_KEY, NTP_OPTION=self._ntp_servers, + SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, SUBNET_MASK_OPTION=self._subnet_mask, + BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, BROADCAST_OPTION=self._broadcast, + ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, ROUTER_OPTION=self._routers, + DNS_OPTION_KEY=DNS_OPTION_KEY, DNS_OPTION=self._dns_servers + ) + for pool in self._pools: + config += "\n\t"+str(pool) + + config += "\n\r}" + return config + + def resolve_subnet(self, subnet): + subnet_parts = subnet.split("\n") + for part in subnet_parts: + if NTP_OPTION_KEY in part: + self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[ + 1].strip().split(";")[0] + elif SUBNET_MASK_OPTION_KEY in part: + self._subnet_mask = part.strip().split(SUBNET_MASK_OPTION_KEY)[ + 1].strip().split(";")[0] + elif BROADCAST_OPTION_KEY in part: + self._broadcast = part.strip().split(BROADCAST_OPTION_KEY)[ + 1].strip().split(";")[0] + elif ROUTER_OPTION_KEY in part: + self._routers = part.strip().split(ROUTER_OPTION_KEY)[ + 1].strip().split(";")[0] + elif DNS_OPTION_KEY in part: + self._dns_servers = part.strip().split(DNS_OPTION_KEY)[ + 1].strip().split(";")[0] + + def resolve_pools(self, subnet): + regex = r"(pool.*)\}" + pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) + for pool in pools: + dhcp_pool = DHCPPool(pool) + self._pools.append(dhcp_pool) + + +FAILOVER_KEY = "failover peer" +RANGE_KEY = "range" + + +class DHCPPool: + + def __init__(self, pool): + self._failover_peer = None + self._range_start = None + self._range_end = None + self.resolve_pool(pool) + + def __str__(self): + + config = """pool {{ + \r\t\t{FAILOVER_KEY} "{FAILOVER}"; + \r\t\t{RANGE_KEY} {RANGE_START} {RANGE_END}; + \r\t}}""" + + return config.format(length='multi-line', + FAILOVER_KEY=FAILOVER_KEY, FAILOVER=self._failover_peer, + RANGE_KEY=RANGE_KEY, RANGE_START=self._range_start, RANGE_END=self._range_end, + ) + + def resolve_pool(self, pool): + pool_parts = pool.split("\n") + # pool_parts = pool.split("\n") + for part in pool_parts: + if FAILOVER_KEY in part: + self._failover_peer = part.strip().split( + FAILOVER_KEY)[1].strip().split(";")[0].replace("\"", "") + if RANGE_KEY in part: + range = part.strip().split(RANGE_KEY)[ + 1].strip().split(";")[0] + self._range_start = range.split(" ")[0].strip() + self._range_end = range.split(" ")[1].strip() diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py b/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py new file mode 100644 index 000000000..f90cb6b51 --- /dev/null +++ b/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py @@ -0,0 +1,44 @@ +import proto.grpc_pb2_grpc as pb2_grpc +import proto.grpc_pb2 as pb2 + +from dhcp_config import DHCPConfig + + +class NetworkService(pb2_grpc.NetworkModule): + + def __init__(self): + self._dhcp_config = DHCPConfig() + + """ + Resolve the current DHCP configuration and return + the first range from the first subnet in the file + """ + + def GetDHCPRange(self, request, context): + self._dhcp_config.resolve_config() + pool = self._dhcp_config._subnets[0]._pools[0] + return pb2.DHCPRange(code=200, start=pool._range_start, end=pool._range_end) + + """ + Change DHCP configuration and set the + the first range from the first subnet in the configuration + """ + + def SetDHCPRange(self, request, context): + print("Setting DHCPRange") + print("Start: " + request.start) + print("End: " + request.end) + self._dhcp_config.resolve_config() + self._dhcp_config.set_range(request.start, request.end, 0, 0) + self._dhcp_config.write_config() + return pb2.Response(code=200, message="DHCP Range Set") + + """ + Return the current status of the network module + """ + + def GetStatus(self, request, context): + # ToDo: Figure out how to resolve the current DHCP status + dhcpStatus = True + message = str({"dhcpStatus":dhcpStatus}) + return pb2.Response(code=200, message=message) diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/proto/grpc.proto b/net_orc/network/modules/dhcp-2/python/src/grpc/proto/grpc.proto new file mode 100644 index 000000000..8e2732620 --- /dev/null +++ b/net_orc/network/modules/dhcp-2/python/src/grpc/proto/grpc.proto @@ -0,0 +1,36 @@ +syntax = "proto3"; + +service NetworkModule { + + rpc GetDHCPRange(GetDHCPRangeRequest) returns (DHCPRange) {}; + + rpc SetDHCPRange(DHCPRange) returns (Response) {}; + + rpc GetStatus(GetStatusRequest) returns (Response) {}; + + rpc GetIPAddress(GetIPAddressRequest) returns (Response) {}; + + rpc SetLeaseAddress(SetLeaseAddressRequest) returns (Response) {}; + +} + +message Response { + int32 code = 1; + string message = 2; +} + +message DHCPRange { + int32 code = 1; + string start = 2; + string end = 3; +} + +message GetDHCPRangeRequest {} + +message GetIPAddressRequest {} + +message GetStatusRequest {} + +message SetLeaseAddressRequest { + string ipAddress = 1; +} \ No newline at end of file diff --git a/net_orc/network/modules/dhcp-2/python/src/run.py b/net_orc/network/modules/dhcp-2/python/src/run.py new file mode 100644 index 000000000..830f048cf --- /dev/null +++ b/net_orc/network/modules/dhcp-2/python/src/run.py @@ -0,0 +1,40 @@ +#!/usr/bin/env python3 + +import signal +import sys +import argparse + +from grpc.dhcp_config import DHCPConfig + + +class DHCPServer: + + def __init__(self, module): + + signal.signal(signal.SIGINT, self.handler) + signal.signal(signal.SIGTERM, self.handler) + signal.signal(signal.SIGABRT, self.handler) + signal.signal(signal.SIGQUIT, self.handler) + + config = DHCPConfig() + config.resolve_config() + config.write_config() + + def handler(self, signum, frame): + if (signum == 2 or signal == signal.SIGTERM): + exit(1) + + +def run(argv): + parser = argparse.ArgumentParser(description="Faux Device Validator", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument( + "-m", "--module", help="Define the module name to be used to create the log file") + + args = parser.parse_args() + + server = DHCPServer(args.module) + + +if __name__ == "__main__": + run(sys.argv) diff --git a/net_orc/network/modules/dns/bin/start_network_service b/net_orc/network/modules/dns/bin/start_network_service new file mode 100644 index 000000000..4537033c0 --- /dev/null +++ b/net_orc/network/modules/dns/bin/start_network_service @@ -0,0 +1,48 @@ +#!/bin/bash + +CONFIG_FILE=/etc/dnsmasq.conf +PID_FILE=/var/run/dnsmasq.pid +LOG_FILE=/runtime/network/dns.log + +echo Starting dns + +cp /testrun/conf/dnsmasq.conf /etc/dnsmasq.conf + +# Route internet traffic through gateway +ip route add default via 10.10.10.1 dev veth0 + +# Restart dnsmasq when config changes +while true; do + + new_checksum=$(md5sum $CONFIG_FILE) + + if [ "$checksum" == "$new_checksum" ]; then + sleep 2 + continue + fi + + echo Config changed. Restarting dnsmasq at $(date).. + + if [ -f $PID_FILE ]; then + kill -9 $(cat $PID_FILE) || true + rm -f $PID_FILE + fi + + checksum=$new_checksum + + echo Starting dnsmasq at $(date) + + dnsmasq --log-facility=$LOG_FILE -u $HOST_USER & + + while [ ! -f $PID_FILE ]; do + echo Waiting for $PID_FILE... + sleep 2 + done + + # Group flag doesn't work for some reason on dnsmasq + # so we'll manually change the group to the log file + chgrp $HOST_USER $LOG_FILE + + echo $PID_FILE now available + +done \ No newline at end of file diff --git a/net_orc/network/modules/dns/conf/dnsmasq.conf b/net_orc/network/modules/dns/conf/dnsmasq.conf new file mode 100644 index 000000000..5513a9220 --- /dev/null +++ b/net_orc/network/modules/dns/conf/dnsmasq.conf @@ -0,0 +1,5 @@ +server=8.8.8.8 + +interface=veth0 + +log-queries \ No newline at end of file diff --git a/net_orc/network/modules/dns/conf/module_config.json b/net_orc/network/modules/dns/conf/module_config.json new file mode 100644 index 000000000..73f890d28 --- /dev/null +++ b/net_orc/network/modules/dns/conf/module_config.json @@ -0,0 +1,22 @@ +{ + "config": { + "meta": { + "name": "dns", + "display_name": "DNS", + "description": "A DNS server" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 4 + }, + "docker": { + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/dns/dns.Dockerfile b/net_orc/network/modules/dns/dns.Dockerfile new file mode 100644 index 000000000..84c1c7eb1 --- /dev/null +++ b/net_orc/network/modules/dns/dns.Dockerfile @@ -0,0 +1,14 @@ +# Image name: test-run/dns +FROM test-run/base:latest + +#Update and get all additional requirements not contained in the base image +RUN apt-get update --fix-missing + +#Install dnsmasq +RUN apt-get install -y dnsmasq + +# Copy over all configuration files +COPY network/modules/dns/conf /testrun/conf + +# Copy over all binary files +COPY network/modules/dns/bin /testrun/bin diff --git a/net_orc/network/modules/gateway/bin/start_network_service b/net_orc/network/modules/gateway/bin/start_network_service new file mode 100644 index 000000000..b1b31d335 --- /dev/null +++ b/net_orc/network/modules/gateway/bin/start_network_service @@ -0,0 +1,30 @@ +#!/bin/bash + +LOCAL_INTF=veth0 +EXT_INTF=eth1 + +echo Starting gateway + +/testrun/bin/wait_for_interface $EXT_INT + +# Enable IPv6 forwarding +sysctl net.ipv6.conf.eth1.accept_ra=1 +sysctl net.ipv6.conf.default.forwarding=1 +sysctl -p + +# Start dhclient if external interface does not have IP +if ! ip addr show $EXT_INTF | fgrep 'inet '; then + echo No inet address for $EXT_INTF, initiating dhcp client... + dhclient $EXT_INTF +fi + +# Enable NAT to the outside world +echo 1 > /proc/sys/net/ipv4/ip_forward +iptables -t nat -A POSTROUTING -o $EXT_INTF -j MASQUERADE +iptables -A FORWARD -i $EXT_INTF -o $LOCAL_INTF -m state --state RELATED,ESTABLISHED -j ACCEPT +iptables -A FORWARD -i $LOCAL_INTF -o $EXT_INTF -j ACCEPT + +# Keep gateway running until killed by framework +while true; do + sleep 10 +done diff --git a/net_orc/network/modules/gateway/conf/module_config.json b/net_orc/network/modules/gateway/conf/module_config.json new file mode 100644 index 000000000..35bd34392 --- /dev/null +++ b/net_orc/network/modules/gateway/conf/module_config.json @@ -0,0 +1,22 @@ +{ + "config": { + "meta": { + "name": "gateway", + "display_name": "Gateway", + "description": "Enable internet connectivity on device bridge" + }, + "network": { + "interface": "veth0", + "enable_wan": true, + "ip_index": 1 + }, + "docker": { + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/gateway/gateway.Dockerfile b/net_orc/network/modules/gateway/gateway.Dockerfile new file mode 100644 index 000000000..b7085ebac --- /dev/null +++ b/net_orc/network/modules/gateway/gateway.Dockerfile @@ -0,0 +1,11 @@ +# Image name: test-run/gateway +FROM test-run/base:latest + +# Install required packages +RUN apt-get install -y iptables isc-dhcp-client + +# Copy over all configuration files +COPY network/modules/gateway/conf /testrun/conf + +# Copy over all binary files +COPY network/modules/gateway/bin /testrun/bin diff --git a/net_orc/network/modules/ntp/bin/start_network_service b/net_orc/network/modules/ntp/bin/start_network_service new file mode 100644 index 000000000..4c0c5dc74 --- /dev/null +++ b/net_orc/network/modules/ntp/bin/start_network_service @@ -0,0 +1,13 @@ +#!/bin/bash + +PYTHON_SRC_DIR=/testrun/python/src +LOG_FILE="/runtime/network/ntp.log" + +echo Starting ntp + +#Create and set permissions on the log file +touch $LOG_FILE +chown $HOST_USER:$HOST_USER $LOG_FILE + +#Start the NTP server +python3 -u $PYTHON_SRC_DIR/ntp_server.py > $LOG_FILE diff --git a/net_orc/network/modules/ntp/conf/module_config.json b/net_orc/network/modules/ntp/conf/module_config.json new file mode 100644 index 000000000..781521263 --- /dev/null +++ b/net_orc/network/modules/ntp/conf/module_config.json @@ -0,0 +1,22 @@ +{ + "config": { + "meta": { + "name": "ntp", + "display_name": "NTP", + "description": "An NTP server" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 5 + }, + "docker": { + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/ntp/ntp-server.py b/net_orc/network/modules/ntp/ntp-server.py new file mode 100644 index 000000000..ace3099b0 --- /dev/null +++ b/net_orc/network/modules/ntp/ntp-server.py @@ -0,0 +1,315 @@ +import datetime +import socket +import struct +import time +import queue + +import threading +import select + +taskQueue = queue.Queue() +stopFlag = False + +def system_to_ntp_time(timestamp): + """Convert a system time to a NTP time. + + Parameters: + timestamp -- timestamp in system time + + Returns: + corresponding NTP time + """ + return timestamp + NTP.NTP_DELTA + +def _to_int(timestamp): + """Return the integral part of a timestamp. + + Parameters: + timestamp -- NTP timestamp + + Retuns: + integral part + """ + return int(timestamp) + +def _to_frac(timestamp, n=32): + """Return the fractional part of a timestamp. + + Parameters: + timestamp -- NTP timestamp + n -- number of bits of the fractional part + + Retuns: + fractional part + """ + return int(abs(timestamp - _to_int(timestamp)) * 2**n) + +def _to_time(integ, frac, n=32): + """Return a timestamp from an integral and fractional part. + + Parameters: + integ -- integral part + frac -- fractional part + n -- number of bits of the fractional part + + Retuns: + timestamp + """ + return integ + float(frac)/2**n + + + +class NTPException(Exception): + """Exception raised by this module.""" + pass + + +class NTP: + """Helper class defining constants.""" + + _SYSTEM_EPOCH = datetime.date(*time.gmtime(0)[0:3]) + """system epoch""" + _NTP_EPOCH = datetime.date(1900, 1, 1) + """NTP epoch""" + NTP_DELTA = (_SYSTEM_EPOCH - _NTP_EPOCH).days * 24 * 3600 + """delta between system and NTP time""" + + REF_ID_TABLE = { + 'DNC': "DNC routing protocol", + 'NIST': "NIST public modem", + 'TSP': "TSP time protocol", + 'DTS': "Digital Time Service", + 'ATOM': "Atomic clock (calibrated)", + 'VLF': "VLF radio (OMEGA, etc)", + 'callsign': "Generic radio", + 'LORC': "LORAN-C radionavidation", + 'GOES': "GOES UHF environment satellite", + 'GPS': "GPS UHF satellite positioning", + } + """reference identifier table""" + + STRATUM_TABLE = { + 0: "unspecified", + 1: "primary reference", + } + """stratum table""" + + MODE_TABLE = { + 0: "unspecified", + 1: "symmetric active", + 2: "symmetric passive", + 3: "client", + 4: "server", + 5: "broadcast", + 6: "reserved for NTP control messages", + 7: "reserved for private use", + } + """mode table""" + + LEAP_TABLE = { + 0: "no warning", + 1: "last minute has 61 seconds", + 2: "last minute has 59 seconds", + 3: "alarm condition (clock not synchronized)", + } + """leap indicator table""" + +class NTPPacket: + """NTP packet class. + + This represents an NTP packet. + """ + + _PACKET_FORMAT = "!B B B b 11I" + """packet format to pack/unpack""" + + def __init__(self, version=4, mode=3, tx_timestamp=0): + """Constructor. + + Parameters: + version -- NTP version + mode -- packet mode (client, server) + tx_timestamp -- packet transmit timestamp + """ + self.leap = 0 + """leap second indicator""" + self.version = version + """version""" + self.mode = mode + """mode""" + self.stratum = 0 + """stratum""" + self.poll = 0 + """poll interval""" + self.precision = 0 + """precision""" + self.root_delay = 0 + """root delay""" + self.root_dispersion = 0 + """root dispersion""" + self.ref_id = 0 + """reference clock identifier""" + self.ref_timestamp = 0 + """reference timestamp""" + self.orig_timestamp = 0 + self.orig_timestamp_high = 0 + self.orig_timestamp_low = 0 + """originate timestamp""" + self.recv_timestamp = 0 + """receive timestamp""" + self.tx_timestamp = tx_timestamp + self.tx_timestamp_high = 0 + self.tx_timestamp_low = 0 + """tansmit timestamp""" + + def to_data(self): + """Convert this NTPPacket to a buffer that can be sent over a socket. + + Returns: + buffer representing this packet + + Raises: + NTPException -- in case of invalid field + """ + try: + packed = struct.pack(NTPPacket._PACKET_FORMAT, + (self.leap << 6 | self.version << 3 | self.mode), + self.stratum, + self.poll, + self.precision, + _to_int(self.root_delay) << 16 | _to_frac(self.root_delay, 16), + _to_int(self.root_dispersion) << 16 | + _to_frac(self.root_dispersion, 16), + self.ref_id, + _to_int(self.ref_timestamp), + _to_frac(self.ref_timestamp), + #Change by lichen, avoid loss of precision + self.orig_timestamp_high, + self.orig_timestamp_low, + _to_int(self.recv_timestamp), + _to_frac(self.recv_timestamp), + _to_int(self.tx_timestamp), + _to_frac(self.tx_timestamp)) + except struct.error: + raise NTPException("Invalid NTP packet fields.") + return packed + + def from_data(self, data): + """Populate this instance from a NTP packet payload received from + the network. + + Parameters: + data -- buffer payload + + Raises: + NTPException -- in case of invalid packet format + """ + try: + unpacked = struct.unpack(NTPPacket._PACKET_FORMAT, + data[0:struct.calcsize(NTPPacket._PACKET_FORMAT)]) + except struct.error: + raise NTPException("Invalid NTP packet.") + + self.leap = unpacked[0] >> 6 & 0x3 + self.version = unpacked[0] >> 3 & 0x7 + self.mode = unpacked[0] & 0x7 + self.stratum = unpacked[1] + self.poll = unpacked[2] + self.precision = unpacked[3] + self.root_delay = float(unpacked[4])/2**16 + self.root_dispersion = float(unpacked[5])/2**16 + self.ref_id = unpacked[6] + self.ref_timestamp = _to_time(unpacked[7], unpacked[8]) + self.orig_timestamp = _to_time(unpacked[9], unpacked[10]) + self.orig_timestamp_high = unpacked[9] + self.orig_timestamp_low = unpacked[10] + self.recv_timestamp = _to_time(unpacked[11], unpacked[12]) + self.tx_timestamp = _to_time(unpacked[13], unpacked[14]) + self.tx_timestamp_high = unpacked[13] + self.tx_timestamp_low = unpacked[14] + + def GetTxTimeStamp(self): + return (self.tx_timestamp_high,self.tx_timestamp_low) + + def SetOriginTimeStamp(self,high,low): + self.orig_timestamp_high = high + self.orig_timestamp_low = low + + +class RecvThread(threading.Thread): + def __init__(self,socket): + threading.Thread.__init__(self) + self.socket = socket + def run(self): + global t,stopFlag + while True: + if stopFlag == True: + print("RecvThread Ended") + break + rlist,wlist,elist = select.select([self.socket],[],[],1); + if len(rlist) != 0: + print("Received %d packets" % len(rlist)) + for tempSocket in rlist: + try: + data,addr = tempSocket.recvfrom(1024) + recvTimestamp = recvTimestamp = system_to_ntp_time(time.time()) + taskQueue.put((data,addr,recvTimestamp)) + except socket.error as msg: + print(msg) + +class WorkThread(threading.Thread): + def __init__(self,socket): + threading.Thread.__init__(self) + self.socket = socket + def run(self): + global taskQueue,stopFlag + while True: + if stopFlag == True: + print("WorkThread Ended") + break + try: + data,addr,recvTimestamp = taskQueue.get(timeout=1) + recvPacket = NTPPacket() + recvPacket.from_data(data) + timeStamp_high,timeStamp_low = recvPacket.GetTxTimeStamp() + sendPacket = NTPPacket(version=4,mode=4) + sendPacket.stratum = 2 + sendPacket.poll = 10 + ''' + sendPacket.precision = 0xfa + sendPacket.root_delay = 0x0bfa + sendPacket.root_dispersion = 0x0aa7 + sendPacket.ref_id = 0x808a8c2c + ''' + sendPacket.ref_timestamp = recvTimestamp-5 + sendPacket.SetOriginTimeStamp(timeStamp_high,timeStamp_low) + sendPacket.recv_timestamp = recvTimestamp + sendPacket.tx_timestamp = system_to_ntp_time(time.time()) + socket.sendto(sendPacket.to_data(),addr) + print("Sent to %s:%d" % (addr[0],addr[1])) + except queue.Empty: + continue + + +listenIp = "0.0.0.0" +listenPort = 123 +socket = socket.socket(socket.AF_INET,socket.SOCK_DGRAM) +socket.bind((listenIp,listenPort)) +print("local socket: ", socket.getsockname()); +recvThread = RecvThread(socket) +recvThread.start() +workThread = WorkThread(socket) +workThread.start() + +while True: + try: + time.sleep(0.5) + except KeyboardInterrupt: + print("Exiting...") + stopFlag = True + recvThread.join() + workThread.join() + #socket.close() + print("Exited") + break + diff --git a/net_orc/network/modules/ntp/ntp.Dockerfile b/net_orc/network/modules/ntp/ntp.Dockerfile new file mode 100644 index 000000000..3474a504e --- /dev/null +++ b/net_orc/network/modules/ntp/ntp.Dockerfile @@ -0,0 +1,13 @@ +# Image name: test-run/ntp +FROM test-run/base:latest + +# Copy over all configuration files +COPY network/modules/ntp/conf /testrun/conf + +# Copy over all binary files +COPY network/modules/ntp/bin /testrun/bin + +# Copy over all python files +COPY network/modules/ntp/python /testrun/python + +EXPOSE 123/udp diff --git a/net_orc/network/modules/ntp/python/src/ntp_server.py b/net_orc/network/modules/ntp/python/src/ntp_server.py new file mode 100644 index 000000000..a53134fe7 --- /dev/null +++ b/net_orc/network/modules/ntp/python/src/ntp_server.py @@ -0,0 +1,315 @@ +import datetime +import socket +import struct +import time +import queue + +import threading +import select + +taskQueue = queue.Queue() +stopFlag = False + +def system_to_ntp_time(timestamp): + """Convert a system time to a NTP time. + + Parameters: + timestamp -- timestamp in system time + + Returns: + corresponding NTP time + """ + return timestamp + NTP.NTP_DELTA + +def _to_int(timestamp): + """Return the integral part of a timestamp. + + Parameters: + timestamp -- NTP timestamp + + Retuns: + integral part + """ + return int(timestamp) + +def _to_frac(timestamp, n=32): + """Return the fractional part of a timestamp. + + Parameters: + timestamp -- NTP timestamp + n -- number of bits of the fractional part + + Retuns: + fractional part + """ + return int(abs(timestamp - _to_int(timestamp)) * 2**n) + +def _to_time(integ, frac, n=32): + """Return a timestamp from an integral and fractional part. + + Parameters: + integ -- integral part + frac -- fractional part + n -- number of bits of the fractional part + + Retuns: + timestamp + """ + return integ + float(frac)/2**n + + + +class NTPException(Exception): + """Exception raised by this module.""" + pass + + +class NTP: + """Helper class defining constants.""" + + _SYSTEM_EPOCH = datetime.date(*time.gmtime(0)[0:3]) + """system epoch""" + _NTP_EPOCH = datetime.date(1900, 1, 1) + """NTP epoch""" + NTP_DELTA = (_SYSTEM_EPOCH - _NTP_EPOCH).days * 24 * 3600 + """delta between system and NTP time""" + + REF_ID_TABLE = { + 'DNC': "DNC routing protocol", + 'NIST': "NIST public modem", + 'TSP': "TSP time protocol", + 'DTS': "Digital Time Service", + 'ATOM': "Atomic clock (calibrated)", + 'VLF': "VLF radio (OMEGA, etc)", + 'callsign': "Generic radio", + 'LORC': "LORAN-C radionavidation", + 'GOES': "GOES UHF environment satellite", + 'GPS': "GPS UHF satellite positioning", + } + """reference identifier table""" + + STRATUM_TABLE = { + 0: "unspecified", + 1: "primary reference", + } + """stratum table""" + + MODE_TABLE = { + 0: "unspecified", + 1: "symmetric active", + 2: "symmetric passive", + 3: "client", + 4: "server", + 5: "broadcast", + 6: "reserved for NTP control messages", + 7: "reserved for private use", + } + """mode table""" + + LEAP_TABLE = { + 0: "no warning", + 1: "last minute has 61 seconds", + 2: "last minute has 59 seconds", + 3: "alarm condition (clock not synchronized)", + } + """leap indicator table""" + +class NTPPacket: + """NTP packet class. + + This represents an NTP packet. + """ + + _PACKET_FORMAT = "!B B B b 11I" + """packet format to pack/unpack""" + + def __init__(self, version=4, mode=3, tx_timestamp=0): + """Constructor. + + Parameters: + version -- NTP version + mode -- packet mode (client, server) + tx_timestamp -- packet transmit timestamp + """ + self.leap = 0 + """leap second indicator""" + self.version = version + """version""" + self.mode = mode + """mode""" + self.stratum = 0 + """stratum""" + self.poll = 0 + """poll interval""" + self.precision = 0 + """precision""" + self.root_delay = 0 + """root delay""" + self.root_dispersion = 0 + """root dispersion""" + self.ref_id = 0 + """reference clock identifier""" + self.ref_timestamp = 0 + """reference timestamp""" + self.orig_timestamp = 0 + self.orig_timestamp_high = 0 + self.orig_timestamp_low = 0 + """originate timestamp""" + self.recv_timestamp = 0 + """receive timestamp""" + self.tx_timestamp = tx_timestamp + self.tx_timestamp_high = 0 + self.tx_timestamp_low = 0 + """tansmit timestamp""" + + def to_data(self): + """Convert this NTPPacket to a buffer that can be sent over a socket. + + Returns: + buffer representing this packet + + Raises: + NTPException -- in case of invalid field + """ + try: + packed = struct.pack(NTPPacket._PACKET_FORMAT, + (self.leap << 6 | self.version << 3 | self.mode), + self.stratum, + self.poll, + self.precision, + _to_int(self.root_delay) << 16 | _to_frac(self.root_delay, 16), + _to_int(self.root_dispersion) << 16 | + _to_frac(self.root_dispersion, 16), + self.ref_id, + _to_int(self.ref_timestamp), + _to_frac(self.ref_timestamp), + #Change by lichen, avoid loss of precision + self.orig_timestamp_high, + self.orig_timestamp_low, + _to_int(self.recv_timestamp), + _to_frac(self.recv_timestamp), + _to_int(self.tx_timestamp), + _to_frac(self.tx_timestamp)) + except struct.error: + raise NTPException("Invalid NTP packet fields.") + return packed + + def from_data(self, data): + """Populate this instance from a NTP packet payload received from + the network. + + Parameters: + data -- buffer payload + + Raises: + NTPException -- in case of invalid packet format + """ + try: + unpacked = struct.unpack(NTPPacket._PACKET_FORMAT, + data[0:struct.calcsize(NTPPacket._PACKET_FORMAT)]) + except struct.error: + raise NTPException("Invalid NTP packet.") + + self.leap = unpacked[0] >> 6 & 0x3 + self.version = unpacked[0] >> 3 & 0x7 + self.mode = unpacked[0] & 0x7 + self.stratum = unpacked[1] + self.poll = unpacked[2] + self.precision = unpacked[3] + self.root_delay = float(unpacked[4])/2**16 + self.root_dispersion = float(unpacked[5])/2**16 + self.ref_id = unpacked[6] + self.ref_timestamp = _to_time(unpacked[7], unpacked[8]) + self.orig_timestamp = _to_time(unpacked[9], unpacked[10]) + self.orig_timestamp_high = unpacked[9] + self.orig_timestamp_low = unpacked[10] + self.recv_timestamp = _to_time(unpacked[11], unpacked[12]) + self.tx_timestamp = _to_time(unpacked[13], unpacked[14]) + self.tx_timestamp_high = unpacked[13] + self.tx_timestamp_low = unpacked[14] + + def GetTxTimeStamp(self): + return (self.tx_timestamp_high,self.tx_timestamp_low) + + def SetOriginTimeStamp(self,high,low): + self.orig_timestamp_high = high + self.orig_timestamp_low = low + + +class RecvThread(threading.Thread): + def __init__(self,socket): + threading.Thread.__init__(self) + self.socket = socket + def run(self): + global t,stopFlag + while True: + if stopFlag == True: + print("RecvThread Ended") + break + rlist,wlist,elist = select.select([self.socket],[],[],1); + if len(rlist) != 0: + print("Received %d packets" % len(rlist)) + for tempSocket in rlist: + try: + data,addr = tempSocket.recvfrom(1024) + recvTimestamp = recvTimestamp = system_to_ntp_time(time.time()) + taskQueue.put((data,addr,recvTimestamp)) + except socket.error as msg: + print(msg) + +class WorkThread(threading.Thread): + def __init__(self,socket): + threading.Thread.__init__(self) + self.socket = socket + def run(self): + global taskQueue,stopFlag + while True: + if stopFlag == True: + print("WorkThread Ended") + break + try: + data,addr,recvTimestamp = taskQueue.get(timeout=1) + recvPacket = NTPPacket() + recvPacket.from_data(data) + timeStamp_high,timeStamp_low = recvPacket.GetTxTimeStamp() + sendPacket = NTPPacket(version=4,mode=4) + sendPacket.stratum = 2 + sendPacket.poll = 10 + ''' + sendPacket.precision = 0xfa + sendPacket.root_delay = 0x0bfa + sendPacket.root_dispersion = 0x0aa7 + sendPacket.ref_id = 0x808a8c2c + ''' + sendPacket.ref_timestamp = recvTimestamp-5 + sendPacket.SetOriginTimeStamp(timeStamp_high,timeStamp_low) + sendPacket.recv_timestamp = recvTimestamp + sendPacket.tx_timestamp = system_to_ntp_time(time.time()) + socket.sendto(sendPacket.to_data(),addr) + print("Sent to %s:%d" % (addr[0],addr[1])) + except queue.Empty: + continue + + +listenIp = "0.0.0.0" +listenPort = 123 +socket = socket.socket(socket.AF_INET,socket.SOCK_DGRAM) +socket.bind((listenIp,listenPort)) +print("local socket: ", socket.getsockname()); +recvThread = RecvThread(socket) +recvThread.start() +workThread = WorkThread(socket) +workThread.start() + +while True: + try: + time.sleep(0.5) + except KeyboardInterrupt: + print("Exiting...") + stopFlag = True + recvThread.join() + workThread.join() + #socket.close() + print("Exited") + break + diff --git a/net_orc/network/modules/ovs/bin/start_network_service b/net_orc/network/modules/ovs/bin/start_network_service new file mode 100644 index 000000000..7c38f484a --- /dev/null +++ b/net_orc/network/modules/ovs/bin/start_network_service @@ -0,0 +1,22 @@ +#!/bin/bash -e + +if [[ "$EUID" -ne 0 ]]; then + echo "Must run as root." + exit 1 +fi + +asyncRun() { + "$@" & + pid="$!" + trap "echo 'Stopping PID $pid'; kill -SIGTERM $pid" SIGINT SIGTERM + + # A signal emitted while waiting will make the wait command return code > 128 + # Let's wrap it in a loop that doesn't end before the process is indeed stopped + while kill -0 $pid > /dev/null 2>&1; do + wait + done +} + +# -u flag allows python print statements +# to be logged by docker by running unbuffered +asyncRun exec python3 -u /ovs/python/src/run.py \ No newline at end of file diff --git a/net_orc/network/modules/ovs/conf/module_config.json b/net_orc/network/modules/ovs/conf/module_config.json new file mode 100644 index 000000000..f6a1eff50 --- /dev/null +++ b/net_orc/network/modules/ovs/conf/module_config.json @@ -0,0 +1,23 @@ +{ + "config": { + "meta": { + "name": "ovs", + "display_name": "OVS", + "description": "Setup and configure Open vSwitch" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 6, + "host": true + }, + "docker": { + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/ovs/ovs.Dockerfile b/net_orc/network/modules/ovs/ovs.Dockerfile new file mode 100644 index 000000000..cd4710e66 --- /dev/null +++ b/net_orc/network/modules/ovs/ovs.Dockerfile @@ -0,0 +1,20 @@ +# Image name: test-run/orchestrator +FROM test-run/base:latest + +#Update and get all additional requirements not contained in the base image +RUN apt-get update --fix-missing + +#Install openvswitch +RUN apt-get install -y openvswitch-switch + +# Copy over all configuration files +COPY network/modules/ovs/conf /testrun/conf + +# Copy over all binary files +COPY network/modules/ovs/bin /testrun/bin + +# Copy over all python files +COPY network/modules/ovs/python /testrun/python + +#Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt \ No newline at end of file diff --git a/net_orc/network/modules/ovs/python/requirements.txt b/net_orc/network/modules/ovs/python/requirements.txt new file mode 100644 index 000000000..e69de29bb diff --git a/net_orc/network/modules/ovs/python/src/logger.py b/net_orc/network/modules/ovs/python/src/logger.py new file mode 100644 index 000000000..50dfb4f50 --- /dev/null +++ b/net_orc/network/modules/ovs/python/src/logger.py @@ -0,0 +1,17 @@ +#!/usr/bin/env python3 + +import logging +import os +import sys + +LOGGERS = {} +_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_DATE_FORMAT = '%b %02d %H:%M:%S' + +# Set level to debug if set as runtime flag +logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=logging.INFO) + +def get_logger(name): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + return LOGGERS[name] \ No newline at end of file diff --git a/net_orc/network/modules/ovs/python/src/ovs_control.py b/net_orc/network/modules/ovs/python/src/ovs_control.py new file mode 100644 index 000000000..6647dc89e --- /dev/null +++ b/net_orc/network/modules/ovs/python/src/ovs_control.py @@ -0,0 +1,107 @@ +#!/usr/bin/env python3 + +#import ipaddress +import json +import logger +#import os +import util + +CONFIG_FILE = "/ovs/conf/system.json" +DEVICE_BRIDGE = "tr-d" +INTERNET_BRIDGE = "tr-c" +LOGGER = logger.get_logger('ovs_ctrl') + +class OVSControl: + + def __init__(self): + self._int_intf = None + self._dev_intf = None + self._load_config() + + def add_bridge(self,bridgeName): + LOGGER.info("Adding OVS Bridge: " + bridgeName) + # Create the bridge using ovs-vsctl commands + # Uses the --may-exist option to prevent failures + # if this bridge already exists by this name it won't fail + # and will not modify the existing bridge + success=util.run_command("ovs-vsctl --may-exist add-br " + bridgeName) + return success + + def add_port(self,port, bridgeName): + LOGGER.info("Adding Port " + port + " to OVS Bridge: " + bridgeName) + # Add a port to the bridge using ovs-vsctl commands + # Uses the --may-exist option to prevent failures + # if this port already exists on the bridge and will not + # modify the existing bridge + success=util.run_command("ovs-vsctl --may-exist add-port " + bridgeName + " " + port) + return success + + def create_net(self): + LOGGER.info("Creating baseline network") + + # Create data plane + self.add_bridge(DEVICE_BRIDGE) + + # Create control plane + self.add_bridge(INTERNET_BRIDGE) + + # Remove IP from internet adapter + self.set_interface_ip(self._int_intf,"0.0.0.0") + + # Add external interfaces to data and control plane + self.add_port(self._dev_intf,DEVICE_BRIDGE) + self.add_port(self._int_intf,INTERNET_BRIDGE) + + # # Set ports up + self.set_bridge_up(DEVICE_BRIDGE) + self.set_bridge_up(INTERNET_BRIDGE) + + def delete_bridge(self,bridgeName): + LOGGER.info("Deleting OVS Bridge: " + bridgeName) + # Delete the bridge using ovs-vsctl commands + # Uses the --if-exists option to prevent failures + # if this bridge does not exists + success=util.run_command("ovs-vsctl --if-exists del-br " + bridgeName) + return success + + def _load_config(self): + LOGGER.info("Loading Configuration: " + CONFIG_FILE) + config_json = json.load(open(CONFIG_FILE, 'r')) + self._int_intf = config_json['internet_intf'] + self._dev_intf = config_json['device_intf'] + LOGGER.info("Configuration Loaded") + LOGGER.info("Internet Interface: " + self._int_intf) + LOGGER.info("Device Interface: " + self._dev_intf) + + def restore_net(self): + LOGGER.info("Restoring Network...") + # Delete data plane + self.delete_bridge(DEVICE_BRIDGE) + + # Delete control plane + self.delete_bridge(INTERNET_BRIDGE) + + LOGGER.info("Network is restored") + + def show_config(self): + LOGGER.info("Show current config of OVS") + success=util.run_command("ovs-vsctl show") + return success + + def set_bridge_up(self,bridgeName): + LOGGER.info("Setting Bridge device to up state: " + bridgeName) + success=util.run_command("ip link set dev " + bridgeName + " up") + return success + + def set_interface_ip(self,interface, ipAddr): + LOGGER.info("Setting interface " + interface + " to " + ipAddr) + # Remove IP from internet adapter + util.run_command("ifconfig " + interface + " 0.0.0.0") + +if __name__ == '__main__': + ovs = OVSControl() + ovs.create_net() + ovs.show_config() + ovs.restore_net() + ovs.show_config() + diff --git a/net_orc/network/modules/ovs/python/src/run.py b/net_orc/network/modules/ovs/python/src/run.py new file mode 100644 index 000000000..4c1474e74 --- /dev/null +++ b/net_orc/network/modules/ovs/python/src/run.py @@ -0,0 +1,53 @@ +#!/usr/bin/env python3 + +import logger +import signal +import time + +from ovs_control import OVSControl + +LOGGER = logger.get_logger('ovs_control_run') + +class OVSControlRun: + + def __init__(self): + + signal.signal(signal.SIGINT, self.handler) + signal.signal(signal.SIGTERM, self.handler) + signal.signal(signal.SIGABRT, self.handler) + signal.signal(signal.SIGQUIT, self.handler) + + LOGGER.info("Starting OVS Control") + + # Get all components ready + self._ovs_control = OVSControl() + + self._ovs_control.restore_net() + + self._ovs_control.create_net() + + self._ovs_control.show_config() + + # Get network ready (via Network orchestrator) + LOGGER.info("Network is ready. Waiting for device information...") + + #Loop forever until process is stopped + while True: + LOGGER.info("OVS Running") + time.sleep(1000) + + # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) + #time.sleep(300) + + # Tear down network + #self._ovs_control.shutdown() + + def handler(self, signum, frame): + LOGGER.info("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.info("Exit signal received: " + str(signum)) + if (signum == 2 or signal == signal.SIGTERM): + LOGGER.info("Exit signal received. Restoring network...") + self._ovs_control.shutdown() + exit(1) + +ovs = OVSControlRun() diff --git a/net_orc/network/modules/ovs/python/src/util.py b/net_orc/network/modules/ovs/python/src/util.py new file mode 100644 index 000000000..8bb0439bc --- /dev/null +++ b/net_orc/network/modules/ovs/python/src/util.py @@ -0,0 +1,19 @@ +import subprocess +import logger + + +def run_command(cmd): + success = False + LOGGER = logger.get_logger('util') + process = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + if process.returncode !=0: + err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) + LOGGER.error("Command Failed: " + cmd) + LOGGER.error("Error: " + err_msg) + else: + succ_msg = "%s. Code: %s" % (stdout.strip().decode('utf-8'), process.returncode) + LOGGER.info("Command Success: " + cmd) + LOGGER.info("Success: " + succ_msg) + success = True + return success \ No newline at end of file diff --git a/net_orc/network/modules/radius/bin/start_network_service b/net_orc/network/modules/radius/bin/start_network_service new file mode 100644 index 000000000..e27a828dd --- /dev/null +++ b/net_orc/network/modules/radius/bin/start_network_service @@ -0,0 +1,20 @@ +#!/bin/bash + +PYTHON_SRC_DIR=/testrun/python/src +CONF_DIR="/testrun/conf" +LOG_FILE="/runtime/network/radius.log" + +echo Starting authenticator.py + +cp $CONF_DIR/eap /etc/freeradius/3.0/mods-available/eap + +# Do we want to mount resources/network/{module} to the network module to avoid file copying during build? +cp $CONF_DIR/ca.crt /etc/ssl/certs/ca-certificates.crt + +python3 -u $PYTHON_SRC_DIR/authenticator.py & + +#Create and set permissions on the log file +touch $LOG_FILE +chown $HOST_USER:$HOST_USER $LOG_FILE + +freeradius -f -X &> $LOG_FILE \ No newline at end of file diff --git a/net_orc/network/modules/radius/conf/ca.crt b/net_orc/network/modules/radius/conf/ca.crt new file mode 100644 index 000000000..d009cb1ab --- /dev/null +++ b/net_orc/network/modules/radius/conf/ca.crt @@ -0,0 +1,26 @@ +-----BEGIN CERTIFICATE----- +MIIEYTCCA0mgAwIBAgIUQJ4F8hBCnCp7ASPZqG/tNQgoUR4wDQYJKoZIhvcNAQEL +BQAwgb8xCzAJBgNVBAYTAkdCMRswGQYDVQQIDBIbWzN+TGVpY2VzdGVyc2hpcmUx +FTATBgNVBAcMDExvdWdoYm9yb3VnaDEUMBIGA1UECgwLRm9yZXN0IFJvY2sxDjAM +BgNVBAsMBUN5YmVyMR8wHQYDVQQDDBZjeWJlci5mb3Jlc3Ryb2NrLmNvLnVrMTUw +MwYJKoZIhvcNAQkBFiZjeWJlcnNlY3VyaXR5LnRlc3RpbmdAZm9yZXN0cm9jay5j +by51azAeFw0yMjAzMDQxMjEzMTBaFw0yNzAzMDMxMjEzMTBaMIG/MQswCQYDVQQG +EwJHQjEbMBkGA1UECAwSG1szfkxlaWNlc3RlcnNoaXJlMRUwEwYDVQQHDAxMb3Vn +aGJvcm91Z2gxFDASBgNVBAoMC0ZvcmVzdCBSb2NrMQ4wDAYDVQQLDAVDeWJlcjEf +MB0GA1UEAwwWY3liZXIuZm9yZXN0cm9jay5jby51azE1MDMGCSqGSIb3DQEJARYm +Y3liZXJzZWN1cml0eS50ZXN0aW5nQGZvcmVzdHJvY2suY28udWswggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDDNz3vJiZ5nX8lohEhqXvxEme3srip8qF7 +r5ScIeQzsTKuPNAmoefx9TcU3SyA2BnREuDX+OCYMN62xxWG2PndOl0LNezAY22C +PJwHbaBntLKY/ZhxYSTyratM7zxKSVLtClamA/bJXBhdfZZKYOP3xlZQEQTygtzK +j5hZwDrpDARtjRZIMWPLqVcoaW9ow2urJVsdD4lYAhpQU2UIgiWo7BG3hJsUfcYX +EQyyrMKJ7xaCwzIU7Sem1PETrzeiWg4KhDijc7A0RMPWlU5ljf0CnY/IZwiDsMRl +hGmGBPvR+ddiWPZPtSKj6TPWpsaMUR9UwncLmSSrhf1otX4Mw0vbAgMBAAGjUzBR +MB0GA1UdDgQWBBR0Qxx2mDTPIfpnzO5YtycGs6t8ijAfBgNVHSMEGDAWgBR0Qxx2 +mDTPIfpnzO5YtycGs6t8ijAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUA +A4IBAQCpTMBMZGXF74WCxrIk23MUsu0OKzMs8B16Wy8BHz+7hInLZwbkx71Z0TP5 +rsMITetSANtM/k4jH7Vmr1xmzU7oSz5zKU1+7rIjKjGtih48WZdJay0uqfKe0K2s +vsRS0LVLY6IiTFWK9YrLC0QFSK7z5GDl1oc/D5yIZAkbsL6PRQJ5RQsYf5BhHfyB +PRV/KcF7c9iKVYW2vILJzbyYLHTDADTHbtfCe5+pAGxagswDjSMVkQu5iJNjbtUO +5iv7PRkgzUFru9Kk6q+LrXbzyPPCwlc3Xbh1q5jSkJLkcV3K26E7+uX5HI+Hxpeh +a8kOsdnw+N8wX6bc7eXIaGBDMine +-----END CERTIFICATE----- diff --git a/net_orc/network/modules/radius/conf/eap b/net_orc/network/modules/radius/conf/eap new file mode 100644 index 000000000..a868f16cd --- /dev/null +++ b/net_orc/network/modules/radius/conf/eap @@ -0,0 +1,602 @@ +eap { + + default_eap_type = tls + + # A list is maintained to correlate EAP-Response + # packets with EAP-Request packets. After a + # configurable length of time, entries in the list + # expire, and are deleted. + # + timer_expire = 60 + + # There are many EAP types, but the server has support + # for only a limited subset. If the server receives + # a request for an EAP type it does not support, then + # it normally rejects the request. By setting this + # configuration to "yes", you can tell the server to + # instead keep processing the request. Another module + # MUST then be configured to proxy the request to + # another RADIUS server which supports that EAP type. + # + # If another module is NOT configured to handle the + # request, then the request will still end up being + # rejected. + # + ignore_unknown_eap_types = no + + # Cisco AP1230B firmware 12.2(13)JA1 has a bug. When given + # a User-Name attribute in an Access-Accept, it copies one + # more byte than it should. + # + # We can work around it by configurably adding an extra + # zero byte. + # + cisco_accounting_username_bug = no + + # Help prevent DoS attacks by limiting the number of + # sessions that the server is tracking. For simplicity, + # this is taken from the "max_requests" directive in + # radiusd.conf. + # + max_sessions = ${max_requests} + + # Common TLS configuration for TLS-based EAP types + # ------------------------------------------------ + # + # See raddb/certs/README.md for additional comments + # on certificates. + # + # If OpenSSL was not found at the time the server was + # built, the "tls", "ttls", and "peap" sections will + # be ignored. + # + # If you do not currently have certificates signed by + # a trusted CA you may use the 'snakeoil' certificates. + # Included with the server in raddb/certs. + # + # If these certificates have not been auto-generated: + # cd raddb/certs + # make + # + # These test certificates SHOULD NOT be used in a normal + # deployment. They are created only to make it easier + # to install the server, and to perform some simple + # tests with EAP-TLS, TTLS, or PEAP. + # + # Note that you should NOT use a globally known CA here! + # e.g. using a Verisign cert as a "known CA" means that + # ANYONE who has a certificate signed by them can + # authenticate via EAP-TLS! This is likely not what you want. + # + tls-config tls-common { + private_key_password = whatever + private_key_file = /etc/ssl/private/ssl-cert-snakeoil.key + + # If Private key & Certificate are located in + # the same file, then private_key_file & + # certificate_file must contain the same file + # name. + # + # If ca_file (below) is not used, then the + # certificate_file below SHOULD also include all of + # the intermediate CA certificates used to sign the + # server certificate, but NOT the root CA. + # + # Including the ROOT CA certificate is not useful and + # merely inflates the exchanged data volume during + # the TLS negotiation. + # + # This file should contain the server certificate, + # followed by intermediate certificates, in order. + # i.e. If we have a server certificate signed by CA1, + # which is signed by CA2, which is signed by a root + # CA, then the "certificate_file" should contain + # server.pem, followed by CA1.pem, followed by + # CA2.pem. + # + # When using "ca_file" or "ca_dir", the + # "certificate_file" should contain only + # "server.pem". And then you may (or may not) need + # to set "auto_chain", depending on your version of + # OpenSSL. + # + # In short, SSL / TLS certificates are complex. + # There are many versions of software, each of which + # behave slightly differently. It is impossible to + # give advice which will work everywhere. Instead, + # we give general guidelines. + # + certificate_file = /etc/ssl/certs/ssl-cert-snakeoil.pem + + # Trusted Root CA list + # + # This file can contain multiple CA certificates. + # ALL of the CA's in this list will be trusted to + # issue client certificates for authentication. + # + # In general, you should use self-signed + # certificates for 802.1x (EAP) authentication. + # In that case, this CA file should contain + # *one* CA certificate. + # + ca_file = /etc/ssl/certs/ca-certificates.crt + + # Check the Certificate Revocation List + # + # 1) Copy CA certificates and CRLs to same directory. + # 2) Execute 'c_rehash '. + # 'c_rehash' is OpenSSL's command. + # 3) uncomment the lines below. + # 5) Restart radiusd + # check_crl = yes + + # Check if intermediate CAs have been revoked. + # check_all_crl = yes + + ca_path = ${cadir} + + # OpenSSL does not reload contents of ca_path dir over time. + # That means that if check_crl is enabled and CRLs are loaded + # from ca_path dir, at some point CRLs will expire and + # RADIUSd will stop authenticating users. + # If ca_path_reload_interval is non-zero, it will force OpenSSL + # to reload all data from ca_path periodically + # + # Flush ca_path each hour + # ca_path_reload_interval = 3600 + + + # Accept an expired Certificate Revocation List + # + # allow_expired_crl = no + + # If check_cert_issuer is set, the value will + # be checked against the DN of the issuer in + # the client certificate. If the values do not + # match, the certificate verification will fail, + # rejecting the user. + # + # This check can be done more generally by checking + # the value of the TLS-Client-Cert-Issuer attribute. + # This check can be done via any mechanism you + # choose. + # + # check_cert_issuer = "/C=GB/ST=Berkshire/L=Newbury/O=My Company Ltd" + + # If check_cert_cn is set, the value will + # be xlat'ed and checked against the CN + # in the client certificate. If the values + # do not match, the certificate verification + # will fail rejecting the user. + # + # This check is done only if the previous + # "check_cert_issuer" is not set, or if + # the check succeeds. + # + # This check can be done more generally by writing + # "unlang" statements to examine the value of the + # TLS-Client-Cert-Common-Name attribute. + # + # check_cert_cn = %{User-Name} + + # + # This configuration item only applies when there is + # an intermediate CA between the "root" CA, and the + # client certificate. If we trust the root CA, then + # by definition we also trust ANY intermediate CA + # which is signed by that root. This means ANOTHER + # intermediate CA can issue client certificates, and + # have them accepted by the EAP module. + # + # The solution is to list ONLY the trusted CAs in the + # FreeRADIUS configuration, and then set this + # configuration item to "yes". + # + # Then, when the server receives a client certificate + # from an untrusted CA, that authentication request + # can be rejected. + # + # It is possible to do these checks in "unlang", by + # checking for unknown names in the + # TLS-Cert-Common-Name attribute, but that is + # more complex. So we add a configuration option + # which can be set once, and which works for all + # possible intermediate CAs, no matter what their + # value. + # + # reject_unknown_intermediate_ca = no + + # Set this option to specify the allowed + # TLS cipher suites. The format is listed + # in "man 1 ciphers". + # + cipher_list = "DEFAULT" + + # If enabled, OpenSSL will use server cipher list + # (possibly defined by cipher_list option above) + # for choosing right cipher suite rather than + # using client-specified list which is OpenSSl default + # behavior. Setting this to "yes" means that OpenSSL + # will choose the servers ciphers, even if they do not + # best match what the client sends. + # + # TLS negotiation is usually good, but can be imperfect. + # This setting allows administrators to "fine tune" it + # if necessary. + # + cipher_server_preference = no + + # You can selectively disable TLS versions for + # compatability with old client devices. + # + # If your system has OpenSSL 1.1.0 or greater, do NOT + # use these. Instead, set tls_min_version and + # tls_max_version. + # +# disable_tlsv1_2 = yes +# disable_tlsv1_1 = yes +# disable_tlsv1 = yes + + + # Set min / max TLS version. + # + # Generally speaking you should NOT use TLS 1.0 or + # TLS 1.1. They are old, possibly insecure, and + # deprecated. However, it is sometimes necessary to + # enable it for compatibility with legact systems. + # We recommend replacing those legacy systems, and + # using at least TLS 1.2. + # + # Some Debian versions disable older versions of TLS, + # and requires the application to manually enable + # them. + # + # If you are running such a distribution, you should + # set these options, otherwise older clients will not + # be able to connect. + # + # Allowed values are "1.0", "1.1", "1.2", and "1.3". + # + # As of 2021, it is STRONGLY RECOMMENDED to set + # + # tls_min_version = "1.2" + # + # Older TLS versions are insecure and deprecated. + # + # In order to enable TLS 1.0 and TLS 1.1, you may + # also need to update cipher_list below to: + # + # * OpenSSL >= 3.x + # + # cipher_list = "DEFAULT@SECLEVEL=0" + # + # * OpenSSL < 3.x + # + # cipher_list = "DEFAULT@SECLEVEL=1" + # + # The values must be in quotes. + # + # We also STRONGLY RECOMMEND to set + # + # tls_max_version = "1.2" + # + # While the server will accept "1.3" as a value, + # most EAP supplicants WILL NOT DO TLS 1.3 PROPERLY. + # + # i.e. they WILL NOT WORK, SO DO NOT ASK QUESTIONS ON + # THE LIST ABOUT WHY IT DOES NOT WORK. + # + # The TLS 1.3 support is here for future + # compatibility, as clients get upgraded, and people + # don't upgrade their copies of FreeRADIUS. + # + # Also note that we only support TLS 1.3 for EAP-TLS. + # Other versions of EAP (PEAP, TTLS, FAST) DO NOT + # SUPPORT TLS 1.3. + # + tls_min_version = "1.2" + tls_max_version = "1.2" + + # Elliptical cryptography configuration + # + # This configuration should be one of the following: + # + # * a name of the curve to use, e.g. "prime256v1". + # + # * a colon separated list of curve NIDs or names. + # + # * an empty string, in which case OpenSSL will choose + # the "best" curve for the situation. + # + # For supported curve names, please run + # + # openssl ecparam -list_curves + # + ecdh_curve = "" + + # Session resumption / fast reauthentication + # cache. + # + # The cache contains the following information: + # + # session Id - unique identifier, managed by SSL + # User-Name - from the Access-Accept + # Stripped-User-Name - from the Access-Request + # Cached-Session-Policy - from the Access-Accept + # + # See also the "store" subsection below for + # additional attributes which can be cached. + # + # The "Cached-Session-Policy" is the name of a + # policy which should be applied to the cached + # session. This policy can be used to assign + # VLANs, IP addresses, etc. It serves as a useful + # way to re-apply the policy from the original + # Access-Accept to the subsequent Access-Accept + # for the cached session. + # + # On session resumption, these attributes are + # copied from the cache, and placed into the + # reply list. + # + # You probably also want "use_tunneled_reply = yes" + # when using fast session resumption. + # + # You can check if a session has been resumed by + # looking for the existence of the EAP-Session-Resumed + # attribute. Note that this attribute will *only* + # exist in the "post-auth" section. + # + # CAVEATS: The cache is stored and reloaded BEFORE + # the "post-auth" section is run. This limitation + # makes caching more difficult than it should be. In + # practice, it means that the first authentication + # session must set the reply attributes before the + # post-auth section is run. + # + # When the session is resumed, the attributes are + # restored and placed into the session-state list. + # + cache { + # Enable it. The default is "no". Deleting the entire "cache" + # subsection also disables caching. + # + # The session cache requires the use of the + # "name" and "persist_dir" configuration + # items, below. + # + # The internal OpenSSL session cache has been permanently + # disabled. + # + # You can disallow resumption for a particular user by adding the + # following attribute to the control item list: + # + # Allow-Session-Resumption = No + # + # If "enable = no" below, you CANNOT enable resumption for just one + # user by setting the above attribute to "yes". + # + enable = no + + # Lifetime of the cached entries, in hours. The sessions will be + # deleted/invalidated after this time. + # + lifetime = 24 # hours + + # Internal "name" of the session cache. Used to + # distinguish which TLS context sessions belong to. + # + # The server will generate a random value if unset. + # This will change across server restart so you MUST + # set the "name" if you want to persist sessions (see + # below). + # + # name = "EAP module" + + # Simple directory-based storage of sessions. + # Two files per session will be written, the SSL + # state and the cached VPs. This will persist session + # across server restarts. + # + # The default directory is ${logdir}, for historical + # reasons. You should ${db_dir} instead. And check + # the value of db_dir in the main radiusd.conf file. + # It should not point to ${raddb} + # + # The server will need write perms, and the directory + # should be secured from anyone else. You might want + # a script to remove old files from here periodically: + # + # find ${logdir}/tlscache -mtime +2 -exec rm -f {} \; + # + # This feature REQUIRES "name" option be set above. + # + # persist_dir = "${logdir}/tlscache" + + # + # As of 3.0.20, it is possible to partially + # control which attributes exist in the + # session cache. This subsection lists + # attributes which are taken from the reply, + # and saved to the on-disk cache. When the + # session is resumed, these attributes are + # added to the "session-state" list. The + # default configuration will then take care + # of copying them to the reply. + # + store { + Tunnel-Private-Group-Id + } + } + + # Client certificates can be validated via an + # external command. This allows dynamic CRLs or OCSP + # to be used. + # + # This configuration is commented out in the + # default configuration. Uncomment it, and configure + # the correct paths below to enable it. + # + # If OCSP checking is enabled, and the OCSP checks fail, + # the verify section is not run. + # + # If OCSP checking is disabled, the verify section is + # run on successful certificate validation. + # + verify { + # If the OCSP checks succeed, the verify section + # is run to allow additional checks. + # + # If you want to skip verify on OCSP success, + # uncomment this configuration item, and set it + # to "yes". + # + # skip_if_ocsp_ok = no + + # A temporary directory where the client + # certificates are stored. This directory + # MUST be owned by the UID of the server, + # and MUST not be accessible by any other + # users. When the server starts, it will do + # "chmod go-rwx" on the directory, for + # security reasons. The directory MUST + # exist when the server starts. + # + # You should also delete all of the files + # in the directory when the server starts. + # + # tmpdir = /tmp/radiusd + + # The command used to verify the client cert. + # We recommend using the OpenSSL command-line + # tool. + # + # The ${..ca_path} text is a reference to + # the ca_path variable defined above. + # + # The %{TLS-Client-Cert-Filename} is the name + # of the temporary file containing the cert + # in PEM format. This file is automatically + # deleted by the server when the command + # returns. + # + # client = "/path/to/openssl verify -CApath ${..ca_path} %{TLS-Client-Cert-Filename}" + } + + # OCSP Configuration + # + # Certificates can be verified against an OCSP + # Responder. This makes it possible to immediately + # revoke certificates without the distribution of + # new Certificate Revocation Lists (CRLs). + # + ocsp { + # Enable it. The default is "no". + # Deleting the entire "ocsp" subsection + # also disables ocsp checking + # + enable = no + + # The OCSP Responder URL can be automatically + # extracted from the certificate in question. + # To override the OCSP Responder URL set + # "override_cert_url = yes". + # + override_cert_url = yes + + # If the OCSP Responder address is not extracted from + # the certificate, the URL can be defined here. + # + url = "http://127.0.0.1/ocsp/" + + # If the OCSP Responder can not cope with nonce + # in the request, then it can be disabled here. + # + # For security reasons, disabling this option + # is not recommended as nonce protects against + # replay attacks. + # + # Note that Microsoft AD Certificate Services OCSP + # Responder does not enable nonce by default. It is + # more secure to enable nonce on the responder than + # to disable it in the query here. + # See http://technet.microsoft.com/en-us/library/cc770413%28WS.10%29.aspx + # + # use_nonce = yes + + # Number of seconds before giving up waiting + # for OCSP response. 0 uses system default. + # + # timeout = 0 + + # Normally an error in querying the OCSP + # responder (no response from server, server did + # not understand the request, etc) will result in + # a validation failure. + # + # To treat these errors as 'soft' failures and + # still accept the certificate, enable this + # option. + # + # Warning: this may enable clients with revoked + # certificates to connect if the OCSP responder + # is not available. Use with caution. + # + # softfail = no + } + + # + # The server can present different certificates based + # on the realm presented in EAP. See + # raddb/certs/realms/README.md for examples of how to + # configure this. + # + # Note that the default is to use the same set of + # realm certificates for both EAP and RadSec! If + # this is not what you want, you should use different + # subdirectories or each, e.g. ${certdir}/realms/radsec/, + # and ${certdir}/realms/eap/ + # + # realm_dir = ${certdir}/realms/ + } + + # EAP-TLS + # + # The TLS configuration for TLS-based EAP types is held in + # the "tls-config" section, above. + # + tls { + # Point to the common TLS configuration + # + tls = tls-common + + # As part of checking a client certificate, the EAP-TLS + # sets some attributes such as TLS-Client-Cert-Common-Name. This + # virtual server has access to these attributes, and can + # be used to accept or reject the request. + # + # virtual_server = check-eap-tls + + # You can control whether or not EAP-TLS requires a + # client certificate by setting + # + # configurable_client_cert = yes + # + # Once that setting has been changed, you can then set + # + # EAP-TLS-Require-Client-Cert = No + # + # in the control items for a request, and the EAP-TLS + # module will not require a client certificate from + # the supplicant. + # + # WARNING: This configuration should only be used + # when the users are placed into a "captive portal" + # or "walled garden", where they have limited network + # access. Otherwise the configuraton will allow + # anyone on the network, without authenticating them! + # +# configurable_client_cert = no + } + +} diff --git a/net_orc/network/modules/radius/conf/module_config.json b/net_orc/network/modules/radius/conf/module_config.json new file mode 100644 index 000000000..153d951df --- /dev/null +++ b/net_orc/network/modules/radius/conf/module_config.json @@ -0,0 +1,22 @@ +{ + "config": { + "meta": { + "name": "radius", + "display_name": "Radius", + "description": "Enable port based authentication" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 7 + }, + "docker": { + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/radius/python/requirements.txt b/net_orc/network/modules/radius/python/requirements.txt new file mode 100644 index 000000000..37d126cb1 --- /dev/null +++ b/net_orc/network/modules/radius/python/requirements.txt @@ -0,0 +1,3 @@ +eventlet +pbr +transitions \ No newline at end of file diff --git a/net_orc/network/modules/radius/python/src/authenticator.py b/net_orc/network/modules/radius/python/src/authenticator.py new file mode 100644 index 000000000..55fa51d87 --- /dev/null +++ b/net_orc/network/modules/radius/python/src/authenticator.py @@ -0,0 +1,31 @@ +from chewie.chewie import Chewie +import logging + +_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_DATE_FORMAT = '%b %02d %H:%M:%S' +INTERFACE_NAME="veth0" +RADIUS_SERVER_IP="127.0.0.1" +RADIUS_SERVER_PORT=1812 +RADIUS_SERVER_SECRET="testing123" + +class Authenticator(): + + def __init__(self): + self.chewie = Chewie(INTERFACE_NAME, self._get_logger(), self._auth_handler, self._failure_handler, self._logoff_handler, radius_server_ip=RADIUS_SERVER_IP, radius_server_port=RADIUS_SERVER_PORT, radius_server_secret=RADIUS_SERVER_SECRET) + self.chewie.run() + + def _get_logger(self): + logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=logging.INFO) + logger = logging.getLogger("chewie") + return logger + + def _auth_handler(self, address, group_address, *args, **kwargs): + print("Successful auth for " + str(address) + " on port " + str(group_address)) + + def _failure_handler(self, address, group_address): + print("Failed auth for " + str(address) + " on port " + str(group_address)) + + def _logoff_handler(self, address, group_address): + print("Log off reported for " + str(address) + " on port " + str(group_address)) + +authenticator = Authenticator() \ No newline at end of file diff --git a/net_orc/network/modules/radius/radius.Dockerfile b/net_orc/network/modules/radius/radius.Dockerfile new file mode 100644 index 000000000..a72313826 --- /dev/null +++ b/net_orc/network/modules/radius/radius.Dockerfile @@ -0,0 +1,26 @@ +# Image name: test-run/radius +FROM test-run/base:latest + +# Install radius and git +RUN apt-get update && apt-get install -y openssl freeradius git + +# Clone chewie from source. +RUN git clone --branch 0.0.25 https://github.com/faucetsdn/chewie + +# Install chewie as Python module +RUN pip3 install chewie/ + +EXPOSE 1812/udp +EXPOSE 1813/udp + +# Copy over all configuration files +COPY network/modules/radius/conf /testrun/conf + +# Copy over all binary files +COPY network/modules/radius/bin /testrun/bin + +# Copy over all python files +COPY network/modules/radius/python /testrun/python + +# Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt \ No newline at end of file diff --git a/net_orc/network/modules/template/bin/start_network_service b/net_orc/network/modules/template/bin/start_network_service new file mode 100644 index 000000000..94ae0def9 --- /dev/null +++ b/net_orc/network/modules/template/bin/start_network_service @@ -0,0 +1,13 @@ +#!/bin/bash + +# Place holder function for testing and validation +# Each network module should include a start_networkig_service +# file that overwrites this one to boot all of the its specific +# requirements to run. + +echo "Starting network service..." +echo "This is not a real network service, just a test" +echo "Network service started" + +# Do Nothing, just keep the module alive +while true; do sleep 1; done \ No newline at end of file diff --git a/net_orc/network/modules/template/conf/module_config.json b/net_orc/network/modules/template/conf/module_config.json new file mode 100644 index 000000000..bcea3808e --- /dev/null +++ b/net_orc/network/modules/template/conf/module_config.json @@ -0,0 +1,26 @@ +{ + "config": { + "meta": { + "name": "template", + "display_name": "Template", + "description": "Template for building network service modules" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 9 + }, + "grpc": { + "port": 50001 + }, + "docker": { + "enable_container": false, + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} \ No newline at end of file diff --git a/net_orc/network/modules/template/python/src/template_main.py b/net_orc/network/modules/template/python/src/template_main.py new file mode 100644 index 000000000..50c425c23 --- /dev/null +++ b/net_orc/network/modules/template/python/src/template_main.py @@ -0,0 +1,4 @@ +"""Python code for the template module.""" + +if __name__ == "__main__": + print ("Template main") diff --git a/net_orc/network/modules/template/template.Dockerfile b/net_orc/network/modules/template/template.Dockerfile new file mode 100644 index 000000000..54bfb9628 --- /dev/null +++ b/net_orc/network/modules/template/template.Dockerfile @@ -0,0 +1,11 @@ +# Image name: test-run/dhcp-primary +FROM test-run/base:latest + +# Copy over all configuration files +COPY network/modules/template/conf /testrun/conf + +# Load device binary files +COPY network/modules/template/bin /testrun/bin + +# Copy over all python files +COPY network/modules/template/python /testrun/python \ No newline at end of file diff --git a/net_orc/orchestrator.Dockerfile b/net_orc/orchestrator.Dockerfile new file mode 100644 index 000000000..f062a33d4 --- /dev/null +++ b/net_orc/orchestrator.Dockerfile @@ -0,0 +1,22 @@ +# Image name: test-run/orchestrator +FROM test-run/base:latest + +#Update and get all additional requirements not contained in the base image +RUN apt-get update + +RUN apt-get install -y python3-pip curl openvswitch-switch + +#Download and install docker client +ENV DOCKERVERSION=20.10.2 +RUN curl -fsSLO https://download.docker.com/linux/static/stable/x86_64/docker-${DOCKERVERSION}.tgz \ + && tar xzvf docker-${DOCKERVERSION}.tgz --strip 1 -C /usr/local/bin docker/docker \ + && rm docker-${DOCKERVERSION}.tgz + +#Create a directory to load all the app files into +RUN mkdir /python + +#Load the requirements file +COPY python/requirements.txt /python + +#Install all python requirements for the module +RUN pip3 install -r python/requirements.txt diff --git a/net_orc/python/requirements.txt b/net_orc/python/requirements.txt new file mode 100644 index 000000000..5d8f29214 --- /dev/null +++ b/net_orc/python/requirements.txt @@ -0,0 +1,4 @@ +docker +ipaddress +netifaces +scapy \ No newline at end of file diff --git a/net_orc/python/src/listener.py b/net_orc/python/src/listener.py new file mode 100644 index 000000000..d07de4686 --- /dev/null +++ b/net_orc/python/src/listener.py @@ -0,0 +1,68 @@ +"""Intercepts network traffic between network services and the device +under test.""" +from scapy.all import AsyncSniffer, DHCP, get_if_hwaddr +import logger +from network_event import NetworkEvent + +LOGGER = logger.get_logger('listener') + +DHCP_DISCOVER = 1 +DHCP_OFFER = 2 +DHCP_REQUEST = 3 +DHCP_ACK = 5 +CONTAINER_MAC_PREFIX = '9a:02:57:1e:8f' + + +class Listener: + """Methods to start and stop the network listener.""" + + def __init__(self, device_intf): + self._device_intf = device_intf + self._device_intf_mac = get_if_hwaddr(self._device_intf) + + self._sniffer = AsyncSniffer( + iface=self._device_intf, prn=self._packet_callback) + + self._callbacks = [] + self._discovered_devices = [] + + def start_listener(self): + """Start sniffing packets on the device interface.""" + self._sniffer.start() + + def stop_listener(self): + """Stop sniffing packets on the device interface.""" + self._sniffer.stop() + + def is_running(self): + """Determine whether the sniffer is running.""" + return self._sniffer.running + + def register_callback(self, callback, events=[]): # pylint: disable=dangerous-default-value + """Register a callback for specified events.""" + self._callbacks.append( + { + 'callback': callback, + 'events': events + } + ) + + def _packet_callback(self, packet): + + # Ignore packets originating from our containers + if packet.src.startswith(CONTAINER_MAC_PREFIX) or packet.src == self._device_intf_mac: + return + + if not packet.src is None and packet.src not in self._discovered_devices: + self._device_discovered(packet.src) + + def _get_dhcp_type(self, packet): + return packet[DHCP].options[0][1] + + def _device_discovered(self, mac_addr): + LOGGER.debug(f'Discovered device with address {mac_addr}') + self._discovered_devices.append(mac_addr) + + for callback in self._callbacks: + if NetworkEvent.DEVICE_DISCOVERED in callback['events']: + callback['callback'](mac_addr) diff --git a/net_orc/python/src/logger.py b/net_orc/python/src/logger.py new file mode 100644 index 000000000..e930f1953 --- /dev/null +++ b/net_orc/python/src/logger.py @@ -0,0 +1,27 @@ +#!/usr/bin/env python3 + +import json +import logging +import os + +LOGGERS = {} +_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_DATE_FORMAT = '%b %02d %H:%M:%S' +_DEFAULT_LEVEL = logging.INFO +_CONF_DIR="conf" +_CONF_FILE_NAME="system.json" + +# Set log level +try: + system_conf_json = json.load(open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='UTF-8')) + log_level_str = system_conf_json['log_level'] + LOG_LEVEL = logging.getLevelName(log_level_str) +except OSError: + LOG_LEVEL = _DEFAULT_LEVEL + +logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=LOG_LEVEL) + +def get_logger(name): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + return LOGGERS[name] diff --git a/net_orc/python/src/network_event.py b/net_orc/python/src/network_event.py new file mode 100644 index 000000000..c77dfa706 --- /dev/null +++ b/net_orc/python/src/network_event.py @@ -0,0 +1,10 @@ +"""Specify the various types of network events to be reported.""" +from enum import Enum + +class NetworkEvent(Enum): + """All possible network events.""" + + ALL = 0 + DEVICE_DISCOVERED = 1 + DHCP_LEASE_NEW = 2 + DHCP_LEASE_RENEWED = 3 diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py new file mode 100644 index 000000000..828ad58a7 --- /dev/null +++ b/net_orc/python/src/network_orchestrator.py @@ -0,0 +1,573 @@ +#!/usr/bin/env python3 + +import ipaddress +import json +import os +import shutil +import sys +import time +import threading + +import docker +from docker.types import Mount + +import logger +import util +from listener import Listener +from network_validator import NetworkValidator + +LOGGER = logger.get_logger("net_orc") +CONFIG_FILE = "conf/system.json" +EXAMPLE_CONFIG_FILE = "conf/system.json.example" +RUNTIME_DIR = "runtime/network" +NETWORK_MODULES_DIR = "network/modules" +NETWORK_MODULE_METADATA = "conf/module_config.json" +DEVICE_BRIDGE = "tr-d" +INTERNET_BRIDGE = "tr-c" +PRIVATE_DOCKER_NET = "tr-private-net" +CONTAINER_NAME = "network_orchestrator" +RUNTIME = 300 + + +class NetworkOrchestrator: + """Manage and controls a virtual testing network.""" + + def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False): + self._int_intf = None + self._dev_intf = None + + self.listener = None + + self._net_modules = [] + + self.validate = validate + + self.async_monitor = async_monitor + + self._path = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.realpath(__file__)))) + + self.validator = NetworkValidator() + + shutil.rmtree(os.path.join(os.getcwd(), RUNTIME_DIR), ignore_errors=True) + + self.network_config = NetworkConfig() + + self.load_config(config_file) + + def start(self): + """Start the network orchestrator.""" + + LOGGER.info("Starting Network Orchestrator") + # Get all components ready + self.load_network_modules() + + # Restore the network first if required + self.stop(kill=True) + + self.start_network() + + if self.async_monitor: + # Run the monitor method asynchronously to keep this method non-blocking + self._monitor_thread = threading.Thread( + target=self.monitor_network) + self._monitor_thread.daemon = True + self._monitor_thread.start() + else: + self.monitor_network() + + def start_network(self): + """Start the virtual testing network.""" + LOGGER.info("Starting network") + + self.build_network_modules() + self.create_net() + self.start_network_services() + + if self.validate: + # Start the validator after network is ready + self.validator.start() + + # Get network ready (via Network orchestrator) + LOGGER.info("Network is ready.") + + def stop(self, kill=False): + """Stop the network orchestrator.""" + self.stop_validator(kill=kill) + self.stop_network(kill=kill) + + def stop_validator(self, kill=False): + """Stop the network validator.""" + # Shutdown the validator + self.validator.stop(kill=kill) + + def stop_network(self, kill=False): + """Stop the virtual testing network.""" + # Shutdown network + self.stop_networking_services(kill=kill) + self.restore_net() + + def monitor_network(self): + # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) + time.sleep(RUNTIME) + + self.stop() + + def load_config(self,config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + self._config_file=os.path.join(self._path, CONFIG_FILE) + else: + # If defined, use as provided + self._config_file=config_file + + if not os.path.isfile(self._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) + + LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) + with open(self._config_file, encoding='UTF-8') as config_json_file: + config_json = json.load(config_json_file) + self.import_config(config_json) + + def import_config(self, json_config): + self._int_intf = json_config['network']['internet_intf'] + self._dev_intf = json_config['network']['device_intf'] + + def _check_network_services(self): + LOGGER.debug("Checking network modules...") + for net_module in self._net_modules: + if net_module.enable_container: + LOGGER.debug("Checking network module: " + + net_module.display_name) + success = self._ping(net_module) + if success: + LOGGER.debug(net_module.display_name + + " responded succesfully: " + str(success)) + else: + LOGGER.error(net_module.display_name + + " failed to respond to ping") + + def _ping(self, net_module): + host = net_module.net_config.ipv4_address + namespace = "tr-ctns-" + net_module.dir_name + cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) + success = util.run_command(cmd, output=False) + return success + + def _create_private_net(self): + client = docker.from_env() + try: + network = client.networks.get(PRIVATE_DOCKER_NET) + network.remove() + except docker.errors.NotFound: + pass + + # TODO: These should be made into variables + ipam_pool = docker.types.IPAMPool( + subnet='100.100.0.0/16', + iprange='100.100.100.0/24' + ) + + ipam_config = docker.types.IPAMConfig( + pool_configs=[ipam_pool] + ) + + client.networks.create( + PRIVATE_DOCKER_NET, + ipam=ipam_config, + internal=True, + check_duplicate=True, + driver="macvlan" + ) + + def create_net(self): + LOGGER.info("Creating baseline network") + + if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): + LOGGER.error("Configured interfaces are not ready for use. " + + "Ensure both interfaces are connected.") + sys.exit(1) + + # Create data plane + util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) + + # Create control plane + util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) + + # Add external interfaces to data and control plane + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + self._dev_intf) + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + self._int_intf) + + # Enable forwarding of eapol packets + util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + + " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") + + # Remove IP from internet adapter + util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") + + # Set ports up + util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") + util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") + + self._create_private_net() + + self.listener = Listener(self._dev_intf) + self.listener.start_listener() + + def load_network_modules(self): + """Load network modules from module_config.json.""" + LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) + + loaded_modules = "Loaded the following network modules: " + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + for module_dir in os.listdir(net_modules_dir): + + net_module = NetworkModule() + + # Load basic module information + + net_module_json = json.load(open(os.path.join( + self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) + + net_module.name = net_module_json['config']['meta']['name'] + net_module.display_name = net_module_json['config']['meta']['display_name'] + net_module.description = net_module_json['config']['meta']['description'] + net_module.dir = os.path.join( + self._path, net_modules_dir, module_dir) + net_module.dir_name = module_dir + net_module.build_file = module_dir + ".Dockerfile" + net_module.container_name = "tr-ct-" + net_module.dir_name + net_module.image_name = "test-run/" + net_module.dir_name + + # Attach folder mounts to network module + if "docker" in net_module_json['config']: + if "mounts" in net_module_json['config']['docker']: + for mount_point in net_module_json['config']['docker']['mounts']: + net_module.mounts.append(Mount( + target=mount_point['target'], + source=os.path.join( + os.getcwd(), mount_point['source']), + type='bind' + )) + + # Determine if this is a container or just an image/template + if "enable_container" in net_module_json['config']['docker']: + net_module.enable_container = net_module_json['config']['docker']['enable_container'] + + # Load network service networking configuration + if net_module.enable_container: + + net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] + net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] + + net_module.net_config.host = False if not "host" in net_module_json[ + 'config']['network'] else net_module_json['config']['network']['host'] + + net_module.net_config.ipv4_address = self.network_config.ipv4_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv4_network = self.network_config.ipv4_network + + net_module.net_config.ipv6_address = self.network_config.ipv6_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv6_network = self.network_config.ipv6_network + + loaded_modules += net_module.dir_name + " " + + self._net_modules.append(net_module) + + LOGGER.info(loaded_modules) + + def build_network_modules(self): + LOGGER.info("Building network modules...") + for net_module in self._net_modules: + self._build_module(net_module) + + def _build_module(self, net_module): + LOGGER.debug("Building network module " + net_module.dir_name) + client = docker.from_env() + client.images.build( + dockerfile=os.path.join(net_module.dir, net_module.build_file), + path=self._path, + forcerm=True, + tag="test-run/" + net_module.dir_name + ) + + def _get_network_module(self, name): + for net_module in self._net_modules: + if name == net_module.display_name: + return net_module + return None + + # Start the OVS network module + # This should always be called before loading all + # other modules to allow for a properly setup base + # network + def _start_ovs_module(self): + self._start_network_service(self._get_network_module("OVS")) + + def _start_network_service(self, net_module): + + LOGGER.debug("Starting net service " + net_module.display_name) + network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET + LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, + container name: {net_module.container_name}""") + try: + client = docker.from_env() + net_module.container = client.containers.run( + net_module.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=net_module.container_name, + hostname=net_module.container_name, + network=PRIVATE_DOCKER_NET, + privileged=True, + detach=True, + mounts=net_module.mounts, + environment={"HOST_USER": os.getlogin()} + ) + except docker.errors.ContainerError as error: + LOGGER.error("Container run error") + LOGGER.error(error) + + if network != "host": + self._attach_service_to_network(net_module) + + def _stop_service_module(self, net_module, kill=False): + LOGGER.debug("Stopping Service container " + net_module.container_name) + try: + container = self._get_service_container(net_module) + if container is not None: + if kill: + LOGGER.debug("Killing container:" + + net_module.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + + net_module.container_name) + container.stop() + LOGGER.debug("Container stopped:" + net_module.container_name) + except Exception as error: + LOGGER.error("Container stop error") + LOGGER.error(error) + + def _get_service_container(self, net_module): + LOGGER.debug("Resolving service container: " + + net_module.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_module.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + + net_module.container_name + " not found") + except Exception as e: + LOGGER.error("Failed to resolve container") + LOGGER.error(e) + return container + + def stop_networking_services(self, kill=False): + LOGGER.info("Stopping network services") + for net_module in self._net_modules: + # Network modules may just be Docker images, so we do not want to stop them + if not net_module.enable_container: + continue + self._stop_service_module(net_module, kill) + + def start_network_services(self): + LOGGER.info("Starting network services") + + os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) + + for net_module in self._net_modules: + + # TODO: There should be a better way of doing this + # Do not try starting OVS module again, as it should already be running + if "OVS" != net_module.display_name: + + # Network modules may just be Docker images, so we do not want to start them as containers + if not net_module.enable_container: + continue + + self._start_network_service(net_module) + + LOGGER.info("All network services are running") + self._check_network_services() + + # TODO: Let's move this into a separate script? It does not look great + def _attach_service_to_network(self, net_module): + LOGGER.debug("Attaching net service " + + net_module.display_name + " to device bridge") + + # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Container network namespace name + container_net_ns = "tr-ctns-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Add bridge interface to device bridge + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command( + "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] + + # Create symlink for container network namespace + util.run_command("ln -sf /proc/" + container_pid + + "/ns/net /var/run/netns/" + container_net_ns) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to veth0 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name veth0") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) + + # Set IP address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") + + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev veth0 up") + + if net_module.net_config.enable_wan: + LOGGER.debug("Attaching net service " + + net_module.display_name + " to internet bridge") + + # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) + bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Attach bridge interface to internet bridge + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + bridge_intf) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to eth1 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name eth1") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + + container_net_ns + " ip link set dev eth1 up") + + def restore_net(self): + + LOGGER.info("Clearing baseline network") + + if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): + self.listener.stop_listener() + + client = docker.from_env() + + # Stop all network containers if still running + for net_module in self._net_modules: + try: + container = client.containers.get( + "tr-ct-" + net_module.dir_name) + container.kill() + except Exception: + continue + + # Delete data plane + util.run_command("ovs-vsctl --if-exists del-br tr-d") + + # Delete control plane + util.run_command("ovs-vsctl --if-exists del-br tr-c") + + # Restart internet interface + if util.interface_exists(self._int_intf): + util.run_command("ip link set " + self._int_intf + " down") + util.run_command("ip link set " + self._int_intf + " up") + + LOGGER.info("Network is restored") + + +class NetworkModule: + + def __init__(self): + self.name = None + self.display_name = None + self.description = None + + self.container = None + self.container_name = None + self.image_name = None + + # Absolute path + self.dir = None + self.dir_name = None + self.build_file = None + self.mounts = [] + + self.enable_container = True + + self.net_config = NetworkModuleNetConfig() + +# The networking configuration for a network module + + +class NetworkModuleNetConfig: + + def __init__(self): + + self.enable_wan = False + + self.ip_index = 0 + self.ipv4_address = None + self.ipv4_network = None + self.ipv6_address = None + self.ipv6_network = None + + self.host = False + + def get_ipv4_addr_with_prefix(self): + return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) + + def get_ipv6_addr_with_prefix(self): + return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) + +# Represents the current configuration of the network for the device bridge + +class NetworkConfig: + + # TODO: Let's get this from a configuration file + def __init__(self): + self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') + self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') diff --git a/net_orc/python/src/network_runner.py b/net_orc/python/src/network_runner.py new file mode 100644 index 000000000..3fe9e8a41 --- /dev/null +++ b/net_orc/python/src/network_runner.py @@ -0,0 +1,68 @@ +#!/usr/bin/env python3 + +"""Wrapper for the NetworkOrchestrator that simplifies +virtual network start process by allowing direct calling +from the command line. + +Run using the provided command scripts in the cmd folder. +E.g sudo cmd/start +""" + +import argparse +import signal +import sys +import time + +import logger + +from network_orchestrator import NetworkOrchestrator + +LOGGER = logger.get_logger('net_runner') + +class NetworkRunner: + def __init__(self, config_file=None, validate=True, async_monitor=False): + self._monitor_thread = None + self._register_exits() + self.net_orc = NetworkOrchestrator(config_file=config_file,validate=validate,async_monitor=async_monitor) + + 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.") + # Kill all container services quickly + # If we're here, we want everything to stop immediately + # and don't care about a gracefully shutdown + self.stop(True) + sys.exit(1) + + def stop(self, kill=False): + self.net_orc.stop(kill) + + def start(self): + self.net_orc.start() + +def parse_args(argv): + parser = argparse.ArgumentParser(description="Test Run Help", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("--no-validate", action="store_true", + help="Turn off the validation of the network after network boot") + parser.add_argument("-f", "--config-file", default=None, + help="Define the configuration file for the Network Orchestrator") + parser.add_argument("-d", "--daemon", action="store_true", + help="Run the network monitor process in the background as a daemon thread") + + args, unknown = parser.parse_known_args() + return args + +if __name__ == "__main__": + args=parse_args(sys.argv) + runner = NetworkRunner(config_file=args.config_file, + validate=not args.no_validate, + async_monitor=args.daemon) + runner.start() \ No newline at end of file diff --git a/net_orc/python/src/network_validator.py b/net_orc/python/src/network_validator.py new file mode 100644 index 000000000..53fbcdbd0 --- /dev/null +++ b/net_orc/python/src/network_validator.py @@ -0,0 +1,274 @@ +"""Holds logic for validation of network services prior to runtime.""" +import json +import os +import shutil +import time +import docker +from docker.types import Mount +import logger +import util + +LOGGER = logger.get_logger("validator") +OUTPUT_DIR = "runtime/validation" +DEVICES_DIR = "network/devices" +DEVICE_METADATA = "conf/module_config.json" +DEVICE_BRIDGE = "tr-d" +CONF_DIR = "conf" +CONF_FILE = "system.json" + +class NetworkValidator: + """Perform validation of network services.""" + + def __init__(self): + self._net_devices = [] + + self._path = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.realpath(__file__)))) + + self._device_dir = os.path.join(self._path, DEVICES_DIR) + + shutil.rmtree(os.path.join(self._path, OUTPUT_DIR), ignore_errors=True) + + def start(self): + """Start the network validator.""" + LOGGER.info("Starting validator") + self._load_devices() + self._build_network_devices() + self._start_network_devices() + + def stop(self, kill=False): + """Stop the network validator.""" + LOGGER.info("Stopping validator") + self._stop_network_devices(kill) + LOGGER.info("Validator stopped") + + def _build_network_devices(self): + LOGGER.debug("Building network validators...") + for net_device in self._net_devices: + self._build_device(net_device) + + def _build_device(self, net_device): + LOGGER.debug("Building network validator " + net_device.dir_name) + try: + client = docker.from_env() + client.images.build( + dockerfile=os.path.join(net_device.dir, net_device.build_file), + path=self._path, + forcerm=True, + tag="test-run/" + net_device.dir_name + ) + LOGGER.debug("Validator device built: " + net_device.dir_name) + except docker.errors.BuildError as error: + LOGGER.error("Container build error") + LOGGER.error(error) + + def _load_devices(self): + + LOGGER.info(f"Loading validators from {DEVICES_DIR}") + + loaded_devices = "Loaded the following validators: " + + for module_dir in os.listdir(self._device_dir): + + device = FauxDevice() + + # Load basic module information + with open(os.path.join(self._device_dir, module_dir, DEVICE_METADATA), + encoding='utf-8') as device_config_file: + device_json = json.load(device_config_file) + + device.name = device_json['config']['meta']['name'] + device.description = device_json['config']['meta']['description'] + + device.dir = os.path.join(self._path, self._device_dir, module_dir) + device.dir_name = module_dir + device.build_file = module_dir + ".Dockerfile" + device.container_name = "tr-ct-" + device.dir_name + device.image_name = "test-run/" + device.dir_name + + runtime_source = os.path.join(os.getcwd(), OUTPUT_DIR, device.name) + conf_source = os.path.join(os.getcwd(), CONF_DIR) + os.makedirs(runtime_source, exist_ok=True) + + device.mounts = [ + Mount( + target='/runtime/validation', + source=runtime_source, + type = 'bind' + ), + Mount( + target='/conf', + source=conf_source, + type='bind', + read_only=True + ), + Mount( + target='/runtime/network', + source=runtime_source, + type='bind' + ) + ] + + if 'timeout' in device_json['config']['docker']: + device.timeout = device_json['config']['docker']['timeout'] + + # Determine if this is a container or just an image/template + if "enable_container" in device_json['config']['docker']: + device.enable_container = device_json['config']['docker']['enable_container'] + + self._net_devices.append(device) + + loaded_devices += device.dir_name + " " + + LOGGER.info(loaded_devices) + + def _start_network_devices(self): + LOGGER.debug("Starting network devices") + for net_device in self._net_devices: + self._start_network_device(net_device) + + def _start_network_device(self, device): + LOGGER.info("Starting device " + device.name) + LOGGER.debug("Image name: " + device.image_name) + LOGGER.debug("Container name: " + device.container_name) + + try: + client = docker.from_env() + device.container = client.containers.run( + device.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=device.container_name, + hostname=device.container_name, + network="none", + privileged=True, + detach=True, + mounts=device.mounts, + environment={"HOST_USER": os.getlogin()} + ) + except docker.errors.ContainerError as error: + LOGGER.error("Container run error") + LOGGER.error(error) + + self._attach_device_to_network(device) + + # Determine the module timeout time + test_module_timeout = time.time() + device.timeout + status = self._get_device_status(device) + + while time.time() < test_module_timeout and status == 'running': + time.sleep(1) + status = self._get_device_status(device) + + LOGGER.info("Validation device " + device.name + " has finished") + + def _get_device_status(self,module): + container = self._get_device_container(module) + if container is not None: + return container.status + return None + + def _attach_device_to_network(self, device): + LOGGER.debug("Attaching device " + device.name + " to device bridge") + + # Device bridge interface example: tr-di-dhcp + # (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + "i-" + device.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + device.dir_name + + # Container network namespace name + container_net_ns = "tr-ctns-" + device.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Add bridge interface to device bridge + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command( + "docker inspect -f {{.State.Pid}} " + device.container_name)[0] + + # Create symlink for container network namespace + util.run_command("ln -sf /proc/" + container_pid + + "/ns/net /var/run/netns/" + container_net_ns) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to veth0 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name veth0") + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev veth0 up") + + def _stop_network_device(self, net_device, kill=False): + LOGGER.debug("Stopping device container " + net_device.container_name) + try: + container = self._get_device_container(net_device) + if container is not None: + if kill: + LOGGER.debug("Killing container:" + + net_device.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + + net_device.container_name) + container.stop() + LOGGER.debug("Container stopped:" + net_device.container_name) + except Exception as e: + LOGGER.error("Container stop error") + LOGGER.error(e) + + def _get_device_container(self, net_device): + LOGGER.debug("Resolving device container: " + + net_device.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_device.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + + net_device.container_name + " not found") + except Exception as e: + LOGGER.error("Failed to resolve container") + LOGGER.error(e) + return container + + def _stop_network_devices(self, kill=False): + LOGGER.debug("Stopping devices") + for net_device in self._net_devices: + # Devices may just be Docker images, so we do not want to stop them + if not net_device.enable_container: + continue + self._stop_network_device(net_device, kill) + +class FauxDevice: # pylint: disable=too-few-public-methods,too-many-instance-attributes + """Represent a faux device.""" + + def __init__(self): + self.name = "Unknown device" + self.description = "Unknown description" + + self.container = None + self.container_name = None + self.image_name = None + + # Absolute path + self.dir = None + + self.dir_name = None + self.build_file = None + self.mounts = [] + + self.enable_container = True + self.timeout = 60 diff --git a/net_orc/python/src/run_validator.py b/net_orc/python/src/run_validator.py new file mode 100644 index 000000000..318456083 --- /dev/null +++ b/net_orc/python/src/run_validator.py @@ -0,0 +1,52 @@ +#!/usr/bin/env python3 + +import os +import logger +import signal +import time +import os + +from network_orchestrator import NetworkOrchestrator +from network_orchestrator_validator import NetworkOrchestratorValidator + +LOGGER = logger.get_logger('test_run') +RUNTIME_FOLDER = "runtime/network" + +class ValidatorRun: + + def __init__(self): + + signal.signal(signal.SIGINT, self.handler) + signal.signal(signal.SIGTERM, self.handler) + signal.signal(signal.SIGABRT, self.handler) + signal.signal(signal.SIGQUIT, self.handler) + + LOGGER.info("Starting Network Orchestrator") + #os.makedirs(RUNTIME_FOLDER) + + # Cleanup any old validator components + self._validator = NetworkOrchestratorValidator() + self._validator._stop_validator(True); + + # Start the validator after network is ready + self._validator._start_validator() + + # TODO: Kill validator once all faux devices are no longer running + time.sleep(2000) + + # Gracefully shutdown network + self._validator._stop_validator(); + + def handler(self, signum, frame): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if (signum == 2 or signum == signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping validator...") + # Kill all container services quickly + # If we're here, we want everything to stop immediately + # and don't care about a gracefully shutdown. + self._validator._stop_validator(True); + LOGGER.info("Validator stopped") + exit(1) + +test_run = ValidatorRun() diff --git a/net_orc/python/src/util.py b/net_orc/python/src/util.py new file mode 100644 index 000000000..a5cfe205f --- /dev/null +++ b/net_orc/python/src/util.py @@ -0,0 +1,30 @@ +import subprocess +import shlex +import logger +import netifaces + + +# Runs a process at the os level +# By default, returns the standard output and error output +# If the caller sets optional output parameter to False, +# will only return a boolean result indicating if it was +# succesful in running the command. Failure is indicated +# by any return code from the process other than zero. +def run_command(cmd, output=True): + success = False + LOGGER = logger.get_logger('util') + process = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + if process.returncode !=0 and output: + err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) + LOGGER.error("Command Failed: " + cmd) + LOGGER.error("Error: " + err_msg) + else: + success = True + if output: + return stdout.strip().decode('utf-8'), stderr + else: + return success + +def interface_exists(interface): + return interface in netifaces.interfaces() \ No newline at end of file From ceba4533cf87022f16f1d65c8c0e0bbbbc2abda6 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 4 May 2023 03:21:35 -0700 Subject: [PATCH 008/400] Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- --- .gitignore | 2 + cmd/install | 2 +- framework/device.py | 10 +- framework/requirements.txt | 1 + framework/testrun.py | 281 ++-- .../Teltonika TRB140/device_config.json | 5 - net_orc/.gitignore | 133 ++ net_orc/conf/.gitignore | 1 + net_orc/conf/network/radius/ca.crt | 26 + net_orc/conf/system.json.example | 7 + .../modules/template/template.Dockerfile | 2 +- net_orc/python/src/network_orchestrator.py | 1143 ++++++++--------- resources/devices/Template/device_config.json | 32 + test_orc/modules/base/bin/capture | 3 +- test_orc/modules/base/bin/start_module | 27 +- test_orc/modules/base/conf/module_config.json | 1 + test_orc/modules/base/python/src/logger.py | 17 +- .../modules/base/python/src/test_module.py | 84 ++ .../modules/baseline/conf/module_config.json | 28 +- .../baseline/python/src/baseline_module.py | 31 + .../modules/baseline/python/src/logger.py | 46 - test_orc/modules/baseline/python/src/run.py | 13 +- .../baseline/python/src/test_module.py | 61 - test_orc/modules/dns/bin/start_test_module | 42 + test_orc/modules/dns/conf/module_config.json | 26 + test_orc/modules/dns/dns.Dockerfile | 11 + test_orc/modules/dns/python/src/dns_module.py | 77 ++ test_orc/modules/dns/python/src/run.py | 58 + test_orc/python/src/test_orchestrator.py | 59 +- 29 files changed, 1337 insertions(+), 892 deletions(-) create mode 100644 framework/requirements.txt delete mode 100644 local/devices/Teltonika TRB140/device_config.json create mode 100644 net_orc/.gitignore create mode 100644 net_orc/conf/.gitignore create mode 100644 net_orc/conf/network/radius/ca.crt create mode 100644 net_orc/conf/system.json.example create mode 100644 resources/devices/Template/device_config.json create mode 100644 test_orc/modules/base/python/src/test_module.py create mode 100644 test_orc/modules/baseline/python/src/baseline_module.py delete mode 100644 test_orc/modules/baseline/python/src/logger.py delete mode 100644 test_orc/modules/baseline/python/src/test_module.py create mode 100644 test_orc/modules/dns/bin/start_test_module create mode 100644 test_orc/modules/dns/conf/module_config.json create mode 100644 test_orc/modules/dns/dns.Dockerfile create mode 100644 test_orc/modules/dns/python/src/dns_module.py create mode 100644 test_orc/modules/dns/python/src/run.py diff --git a/.gitignore b/.gitignore index 15aae1278..db1580ffb 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ runtime/ venv/ .vscode/ +local/ + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/cmd/install b/cmd/install index 539234006..23e463158 100755 --- a/cmd/install +++ b/cmd/install @@ -4,7 +4,7 @@ python3 -m venv venv source venv/bin/activate -pip3 install --upgrade requests +pip3 install -r framework/requirements.txt pip3 install -r net_orc/python/requirements.txt diff --git a/framework/device.py b/framework/device.py index 08014c127..d41199612 100644 --- a/framework/device.py +++ b/framework/device.py @@ -1,10 +1,12 @@ """Track device object information.""" from dataclasses import dataclass + @dataclass class Device: - """Represents a physical device and it's configuration.""" + """Represents a physical device and it's configuration.""" - make: str - model: str - mac_addr: str + make: str + model: str + mac_addr: str + test_modules: str = None diff --git a/framework/requirements.txt b/framework/requirements.txt new file mode 100644 index 000000000..ca56948f4 --- /dev/null +++ b/framework/requirements.txt @@ -0,0 +1 @@ +requests<2.29.0 \ No newline at end of file diff --git a/framework/testrun.py b/framework/testrun.py index 0561163ac..40076108b 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -6,7 +6,6 @@ Run using the provided command scripts in the cmd folder. E.g sudo cmd/start """ - import os import sys import json @@ -19,150 +18,156 @@ current_dir = os.path.dirname(os.path.realpath(__file__)) parent_dir = os.path.dirname(current_dir) +# Add net_orc to Python path +net_orc_dir = os.path.join(parent_dir, 'net_orc', 'python', 'src') +sys.path.append(net_orc_dir) + +# Add test_orc to Python path +test_orc_dir = os.path.join(parent_dir, 'test_orc', 'python', 'src') +sys.path.append(test_orc_dir) + +from listener import NetworkEvent # pylint: disable=wrong-import-position,import-outside-toplevel +import test_orchestrator as test_orc # pylint: disable=wrong-import-position,import-outside-toplevel +import network_orchestrator as net_orc # pylint: disable=wrong-import-position,import-outside-toplevel + 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' +LOCAL_DEVICES_DIR = 'local/devices' +RESOURCE_DEVICES_DIR = 'resources/devices' DEVICE_CONFIG = 'device_config.json' DEVICE_MAKE = 'make' DEVICE_MODEL = 'model' DEVICE_MAC_ADDR = 'mac_addr' +DEVICE_TEST_MODULES = 'test_modules' 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, config_file=CONFIG_FILE,validate=True, net_only=False): - self._devices = [] - self._net_only = net_only - - # Catch any exit signals - self._register_exits() - - # Import the correct net orchestrator - self.import_dependencies() - - # Expand the config file to absolute pathing - config_file_abs=self._get_config_abs(config_file=config_file) - - self._net_orc = net_orc.NetworkOrchestrator(config_file=config_file_abs,validate=validate,async_monitor=not self._net_only) - self._test_orc = test_orc.TestOrchestrator() - - def start(self): - - self._load_devices() - - if self._net_only: - LOGGER.info("Network only option configured, no tests will be run") - self._start_network() - else: - self._start_network() - self._net_orc.listener.register_callback( - self._device_discovered, - [NetworkEvent.DEVICE_DISCOVERED]) - - LOGGER.info("Waiting for devices on the network...") - - # Check timeout and whether testing is currently in progress before stopping - time.sleep(RUNTIME) - - self.stop() - - def stop(self,kill=False): - self._stop_tests() - self._stop_network(kill=kill) - - def import_dependencies(self): - # Add net_orc to Python path - net_orc_dir = os.path.join(parent_dir, 'net_orc', 'python', 'src') - 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(kill=True) - sys.exit(1) - - def _get_config_abs(self,config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - config_file = os.path.join(parent_dir, CONFIG_FILE) - - # Expand the config file to absolute pathing - return os.path.abspath(config_file) - - def _start_network(self): - self._net_orc.start() - - def _run_tests(self): - """Iterate through and start all test modules.""" - self._test_orc.start() - - def _stop_network(self,kill=False): - self._net_orc.stop(kill=kill) - - def _stop_tests(self): - self._test_orc.stop() - - 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: - device = Device(make=None, model=None, mac_addr=mac_addr) - LOGGER.info( - f'A new device has been discovered with mac address {mac_addr}') - - # TODO: Pass device information to test orchestrator/runner - self._run_tests() + """Test Run controller. + + Creates an instance of the network orchestrator, test + orchestrator and user interface. + """ + + def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False): + self._devices = [] + self._net_only = net_only + + # Catch any exit signals + self._register_exits() + + # Expand the config file to absolute pathing + config_file_abs = self._get_config_abs(config_file=config_file) + + self._net_orc = net_orc.NetworkOrchestrator( + config_file=config_file_abs, validate=validate, async_monitor=not self._net_only) + self._test_orc = test_orc.TestOrchestrator() + + def start(self): + + self._load_all_devices() + + if self._net_only: + LOGGER.info( + "Network only option configured, no tests will be run") + self._start_network() + else: + self._start_network() + self._test_orc.start() + self._net_orc.listener.register_callback( + self._device_discovered, + [NetworkEvent.DEVICE_DISCOVERED]) + + LOGGER.info("Waiting for devices on the network...") + + # Check timeout and whether testing is currently in progress before stopping + time.sleep(RUNTIME) + + self.stop() + + def stop(self, kill=False): + self._stop_tests() + self._stop_network(kill=kill) + + 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(kill=True) + sys.exit(1) + + def _get_config_abs(self, config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + config_file = os.path.join(parent_dir, CONFIG_FILE) + + # Expand the config file to absolute pathing + return os.path.abspath(config_file) + + def _start_network(self): + self._net_orc.start() + + def _run_tests(self, device): + """Iterate through and start all test modules.""" + + # TODO: Make this configurable + time.sleep(60) # Let device bootup + + self._test_orc.run_test_modules(device) + + def _stop_network(self, kill=False): + self._net_orc.stop(kill=kill) + + def _stop_tests(self): + self._test_orc.stop() + + def _load_all_devices(self): + self._load_devices(device_dir=LOCAL_DEVICES_DIR) + LOGGER.info('Loaded ' + str(len(self._devices)) + ' devices') + + def _load_devices(self, device_dir): + LOGGER.debug('Loading devices from ' + device_dir) + + os.makedirs(device_dir, exist_ok=True) + + for device_folder in os.listdir(device_dir): + with open(os.path.join(device_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) + test_modules = device_config_json.get(DEVICE_TEST_MODULES) + + device = Device(make=device_make, model=device_model, + mac_addr=mac_addr, test_modules=json.dumps(test_modules)) + self._devices.append(device) + + 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: + device = Device(make=None, model=None, mac_addr=mac_addr) + LOGGER.info( + f'A new device has been discovered with mac address {mac_addr}') + + # TODO: Pass device information to test orchestrator/runner + self._run_tests(device) diff --git a/local/devices/Teltonika TRB140/device_config.json b/local/devices/Teltonika TRB140/device_config.json deleted file mode 100644 index 759c1e9b4..000000000 --- a/local/devices/Teltonika TRB140/device_config.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "make": "Teltonika", - "model": "TRB140", - "mac_addr": "00:1e:42:35:73:c4" -} \ No newline at end of file diff --git a/net_orc/.gitignore b/net_orc/.gitignore new file mode 100644 index 000000000..2d77147eb --- /dev/null +++ b/net_orc/.gitignore @@ -0,0 +1,133 @@ +# Runtime folder +runtime/ +.vscode/ + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/net_orc/conf/.gitignore b/net_orc/conf/.gitignore new file mode 100644 index 000000000..41b89ceb1 --- /dev/null +++ b/net_orc/conf/.gitignore @@ -0,0 +1 @@ +system.json \ No newline at end of file diff --git a/net_orc/conf/network/radius/ca.crt b/net_orc/conf/network/radius/ca.crt new file mode 100644 index 000000000..d009cb1ab --- /dev/null +++ b/net_orc/conf/network/radius/ca.crt @@ -0,0 +1,26 @@ +-----BEGIN CERTIFICATE----- +MIIEYTCCA0mgAwIBAgIUQJ4F8hBCnCp7ASPZqG/tNQgoUR4wDQYJKoZIhvcNAQEL +BQAwgb8xCzAJBgNVBAYTAkdCMRswGQYDVQQIDBIbWzN+TGVpY2VzdGVyc2hpcmUx +FTATBgNVBAcMDExvdWdoYm9yb3VnaDEUMBIGA1UECgwLRm9yZXN0IFJvY2sxDjAM +BgNVBAsMBUN5YmVyMR8wHQYDVQQDDBZjeWJlci5mb3Jlc3Ryb2NrLmNvLnVrMTUw +MwYJKoZIhvcNAQkBFiZjeWJlcnNlY3VyaXR5LnRlc3RpbmdAZm9yZXN0cm9jay5j +by51azAeFw0yMjAzMDQxMjEzMTBaFw0yNzAzMDMxMjEzMTBaMIG/MQswCQYDVQQG +EwJHQjEbMBkGA1UECAwSG1szfkxlaWNlc3RlcnNoaXJlMRUwEwYDVQQHDAxMb3Vn +aGJvcm91Z2gxFDASBgNVBAoMC0ZvcmVzdCBSb2NrMQ4wDAYDVQQLDAVDeWJlcjEf +MB0GA1UEAwwWY3liZXIuZm9yZXN0cm9jay5jby51azE1MDMGCSqGSIb3DQEJARYm +Y3liZXJzZWN1cml0eS50ZXN0aW5nQGZvcmVzdHJvY2suY28udWswggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDDNz3vJiZ5nX8lohEhqXvxEme3srip8qF7 +r5ScIeQzsTKuPNAmoefx9TcU3SyA2BnREuDX+OCYMN62xxWG2PndOl0LNezAY22C +PJwHbaBntLKY/ZhxYSTyratM7zxKSVLtClamA/bJXBhdfZZKYOP3xlZQEQTygtzK +j5hZwDrpDARtjRZIMWPLqVcoaW9ow2urJVsdD4lYAhpQU2UIgiWo7BG3hJsUfcYX +EQyyrMKJ7xaCwzIU7Sem1PETrzeiWg4KhDijc7A0RMPWlU5ljf0CnY/IZwiDsMRl +hGmGBPvR+ddiWPZPtSKj6TPWpsaMUR9UwncLmSSrhf1otX4Mw0vbAgMBAAGjUzBR +MB0GA1UdDgQWBBR0Qxx2mDTPIfpnzO5YtycGs6t8ijAfBgNVHSMEGDAWgBR0Qxx2 +mDTPIfpnzO5YtycGs6t8ijAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUA +A4IBAQCpTMBMZGXF74WCxrIk23MUsu0OKzMs8B16Wy8BHz+7hInLZwbkx71Z0TP5 +rsMITetSANtM/k4jH7Vmr1xmzU7oSz5zKU1+7rIjKjGtih48WZdJay0uqfKe0K2s +vsRS0LVLY6IiTFWK9YrLC0QFSK7z5GDl1oc/D5yIZAkbsL6PRQJ5RQsYf5BhHfyB +PRV/KcF7c9iKVYW2vILJzbyYLHTDADTHbtfCe5+pAGxagswDjSMVkQu5iJNjbtUO +5iv7PRkgzUFru9Kk6q+LrXbzyPPCwlc3Xbh1q5jSkJLkcV3K26E7+uX5HI+Hxpeh +a8kOsdnw+N8wX6bc7eXIaGBDMine +-----END CERTIFICATE----- diff --git a/net_orc/conf/system.json.example b/net_orc/conf/system.json.example new file mode 100644 index 000000000..77c981394 --- /dev/null +++ b/net_orc/conf/system.json.example @@ -0,0 +1,7 @@ +{ + "network": { + "device_intf": "enx207bd2620617", + "internet_intf": "enx207bd26205e9" + }, + "log_level": "INFO" +} \ No newline at end of file diff --git a/net_orc/network/modules/template/template.Dockerfile b/net_orc/network/modules/template/template.Dockerfile index 54bfb9628..45f9da6d9 100644 --- a/net_orc/network/modules/template/template.Dockerfile +++ b/net_orc/network/modules/template/template.Dockerfile @@ -1,4 +1,4 @@ -# Image name: test-run/dhcp-primary +# Image name: test-run/template FROM test-run/base:latest # Copy over all configuration files diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 828ad58a7..63391a24f 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,573 +1,570 @@ -#!/usr/bin/env python3 - -import ipaddress -import json -import os -import shutil -import sys -import time -import threading - -import docker -from docker.types import Mount - -import logger -import util -from listener import Listener -from network_validator import NetworkValidator - -LOGGER = logger.get_logger("net_orc") -CONFIG_FILE = "conf/system.json" -EXAMPLE_CONFIG_FILE = "conf/system.json.example" -RUNTIME_DIR = "runtime/network" -NETWORK_MODULES_DIR = "network/modules" -NETWORK_MODULE_METADATA = "conf/module_config.json" -DEVICE_BRIDGE = "tr-d" -INTERNET_BRIDGE = "tr-c" -PRIVATE_DOCKER_NET = "tr-private-net" -CONTAINER_NAME = "network_orchestrator" -RUNTIME = 300 - - -class NetworkOrchestrator: - """Manage and controls a virtual testing network.""" - - def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False): - self._int_intf = None - self._dev_intf = None - - self.listener = None - - self._net_modules = [] - - self.validate = validate - - self.async_monitor = async_monitor - - self._path = os.path.dirname(os.path.dirname( - os.path.dirname(os.path.realpath(__file__)))) - - self.validator = NetworkValidator() - - shutil.rmtree(os.path.join(os.getcwd(), RUNTIME_DIR), ignore_errors=True) - - self.network_config = NetworkConfig() - - self.load_config(config_file) - - def start(self): - """Start the network orchestrator.""" - - LOGGER.info("Starting Network Orchestrator") - # Get all components ready - self.load_network_modules() - - # Restore the network first if required - self.stop(kill=True) - - self.start_network() - - if self.async_monitor: - # Run the monitor method asynchronously to keep this method non-blocking - self._monitor_thread = threading.Thread( - target=self.monitor_network) - self._monitor_thread.daemon = True - self._monitor_thread.start() - else: - self.monitor_network() - - def start_network(self): - """Start the virtual testing network.""" - LOGGER.info("Starting network") - - self.build_network_modules() - self.create_net() - self.start_network_services() - - if self.validate: - # Start the validator after network is ready - self.validator.start() - - # Get network ready (via Network orchestrator) - LOGGER.info("Network is ready.") - - def stop(self, kill=False): - """Stop the network orchestrator.""" - self.stop_validator(kill=kill) - self.stop_network(kill=kill) - - def stop_validator(self, kill=False): - """Stop the network validator.""" - # Shutdown the validator - self.validator.stop(kill=kill) - - def stop_network(self, kill=False): - """Stop the virtual testing network.""" - # Shutdown network - self.stop_networking_services(kill=kill) - self.restore_net() - - def monitor_network(self): - # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) - time.sleep(RUNTIME) - - self.stop() - - def load_config(self,config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - self._config_file=os.path.join(self._path, CONFIG_FILE) - else: - # If defined, use as provided - self._config_file=config_file - - if not os.path.isfile(self._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) - - LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) - with open(self._config_file, encoding='UTF-8') as config_json_file: - config_json = json.load(config_json_file) - self.import_config(config_json) - - def import_config(self, json_config): - self._int_intf = json_config['network']['internet_intf'] - self._dev_intf = json_config['network']['device_intf'] - - def _check_network_services(self): - LOGGER.debug("Checking network modules...") - for net_module in self._net_modules: - if net_module.enable_container: - LOGGER.debug("Checking network module: " + - net_module.display_name) - success = self._ping(net_module) - if success: - LOGGER.debug(net_module.display_name + - " responded succesfully: " + str(success)) - else: - LOGGER.error(net_module.display_name + - " failed to respond to ping") - - def _ping(self, net_module): - host = net_module.net_config.ipv4_address - namespace = "tr-ctns-" + net_module.dir_name - cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) - success = util.run_command(cmd, output=False) - return success - - def _create_private_net(self): - client = docker.from_env() - try: - network = client.networks.get(PRIVATE_DOCKER_NET) - network.remove() - except docker.errors.NotFound: - pass - - # TODO: These should be made into variables - ipam_pool = docker.types.IPAMPool( - subnet='100.100.0.0/16', - iprange='100.100.100.0/24' - ) - - ipam_config = docker.types.IPAMConfig( - pool_configs=[ipam_pool] - ) - - client.networks.create( - PRIVATE_DOCKER_NET, - ipam=ipam_config, - internal=True, - check_duplicate=True, - driver="macvlan" - ) - - def create_net(self): - LOGGER.info("Creating baseline network") - - if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): - LOGGER.error("Configured interfaces are not ready for use. " + - "Ensure both interfaces are connected.") - sys.exit(1) - - # Create data plane - util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) - - # Create control plane - util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) - - # Add external interfaces to data and control plane - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + self._dev_intf) - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + self._int_intf) - - # Enable forwarding of eapol packets - util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + - " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") - - # Remove IP from internet adapter - util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") - - # Set ports up - util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") - util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") - - self._create_private_net() - - self.listener = Listener(self._dev_intf) - self.listener.start_listener() - - def load_network_modules(self): - """Load network modules from module_config.json.""" - LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) - - loaded_modules = "Loaded the following network modules: " - net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) - - for module_dir in os.listdir(net_modules_dir): - - net_module = NetworkModule() - - # Load basic module information - - net_module_json = json.load(open(os.path.join( - self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) - - net_module.name = net_module_json['config']['meta']['name'] - net_module.display_name = net_module_json['config']['meta']['display_name'] - net_module.description = net_module_json['config']['meta']['description'] - net_module.dir = os.path.join( - self._path, net_modules_dir, module_dir) - net_module.dir_name = module_dir - net_module.build_file = module_dir + ".Dockerfile" - net_module.container_name = "tr-ct-" + net_module.dir_name - net_module.image_name = "test-run/" + net_module.dir_name - - # Attach folder mounts to network module - if "docker" in net_module_json['config']: - if "mounts" in net_module_json['config']['docker']: - for mount_point in net_module_json['config']['docker']['mounts']: - net_module.mounts.append(Mount( - target=mount_point['target'], - source=os.path.join( - os.getcwd(), mount_point['source']), - type='bind' - )) - - # Determine if this is a container or just an image/template - if "enable_container" in net_module_json['config']['docker']: - net_module.enable_container = net_module_json['config']['docker']['enable_container'] - - # Load network service networking configuration - if net_module.enable_container: - - net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] - net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] - - net_module.net_config.host = False if not "host" in net_module_json[ - 'config']['network'] else net_module_json['config']['network']['host'] - - net_module.net_config.ipv4_address = self.network_config.ipv4_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv4_network = self.network_config.ipv4_network - - net_module.net_config.ipv6_address = self.network_config.ipv6_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv6_network = self.network_config.ipv6_network - - loaded_modules += net_module.dir_name + " " - - self._net_modules.append(net_module) - - LOGGER.info(loaded_modules) - - def build_network_modules(self): - LOGGER.info("Building network modules...") - for net_module in self._net_modules: - self._build_module(net_module) - - def _build_module(self, net_module): - LOGGER.debug("Building network module " + net_module.dir_name) - client = docker.from_env() - client.images.build( - dockerfile=os.path.join(net_module.dir, net_module.build_file), - path=self._path, - forcerm=True, - tag="test-run/" + net_module.dir_name - ) - - def _get_network_module(self, name): - for net_module in self._net_modules: - if name == net_module.display_name: - return net_module - return None - - # Start the OVS network module - # This should always be called before loading all - # other modules to allow for a properly setup base - # network - def _start_ovs_module(self): - self._start_network_service(self._get_network_module("OVS")) - - def _start_network_service(self, net_module): - - LOGGER.debug("Starting net service " + net_module.display_name) - network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET - LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, - container name: {net_module.container_name}""") - try: - client = docker.from_env() - net_module.container = client.containers.run( - net_module.image_name, - auto_remove=True, - cap_add=["NET_ADMIN"], - name=net_module.container_name, - hostname=net_module.container_name, - network=PRIVATE_DOCKER_NET, - privileged=True, - detach=True, - mounts=net_module.mounts, - environment={"HOST_USER": os.getlogin()} - ) - except docker.errors.ContainerError as error: - LOGGER.error("Container run error") - LOGGER.error(error) - - if network != "host": - self._attach_service_to_network(net_module) - - def _stop_service_module(self, net_module, kill=False): - LOGGER.debug("Stopping Service container " + net_module.container_name) - try: - container = self._get_service_container(net_module) - if container is not None: - if kill: - LOGGER.debug("Killing container:" + - net_module.container_name) - container.kill() - else: - LOGGER.debug("Stopping container:" + - net_module.container_name) - container.stop() - LOGGER.debug("Container stopped:" + net_module.container_name) - except Exception as error: - LOGGER.error("Container stop error") - LOGGER.error(error) - - def _get_service_container(self, net_module): - LOGGER.debug("Resolving service container: " + - net_module.container_name) - container = None - try: - client = docker.from_env() - container = client.containers.get(net_module.container_name) - except docker.errors.NotFound: - LOGGER.debug("Container " + - net_module.container_name + " not found") - except Exception as e: - LOGGER.error("Failed to resolve container") - LOGGER.error(e) - return container - - def stop_networking_services(self, kill=False): - LOGGER.info("Stopping network services") - for net_module in self._net_modules: - # Network modules may just be Docker images, so we do not want to stop them - if not net_module.enable_container: - continue - self._stop_service_module(net_module, kill) - - def start_network_services(self): - LOGGER.info("Starting network services") - - os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) - - for net_module in self._net_modules: - - # TODO: There should be a better way of doing this - # Do not try starting OVS module again, as it should already be running - if "OVS" != net_module.display_name: - - # Network modules may just be Docker images, so we do not want to start them as containers - if not net_module.enable_container: - continue - - self._start_network_service(net_module) - - LOGGER.info("All network services are running") - self._check_network_services() - - # TODO: Let's move this into a separate script? It does not look great - def _attach_service_to_network(self, net_module): - LOGGER.debug("Attaching net service " + - net_module.display_name + " to device bridge") - - # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) - bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Container network namespace name - container_net_ns = "tr-ctns-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Add bridge interface to device bridge - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + bridge_intf) - - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command( - "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] - - # Create symlink for container network namespace - util.run_command("ln -sf /proc/" + container_pid + - "/ns/net /var/run/netns/" + container_net_ns) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to veth0 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name veth0") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) - - # Set IP address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") - - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev veth0 up") - - if net_module.net_config.enable_wan: - LOGGER.debug("Attaching net service " + - net_module.display_name + " to internet bridge") - - # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) - bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Attach bridge interface to internet bridge - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + bridge_intf) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to eth1 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name eth1") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + - container_net_ns + " ip link set dev eth1 up") - - def restore_net(self): - - LOGGER.info("Clearing baseline network") - - if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): - self.listener.stop_listener() - - client = docker.from_env() - - # Stop all network containers if still running - for net_module in self._net_modules: - try: - container = client.containers.get( - "tr-ct-" + net_module.dir_name) - container.kill() - except Exception: - continue - - # Delete data plane - util.run_command("ovs-vsctl --if-exists del-br tr-d") - - # Delete control plane - util.run_command("ovs-vsctl --if-exists del-br tr-c") - - # Restart internet interface - if util.interface_exists(self._int_intf): - util.run_command("ip link set " + self._int_intf + " down") - util.run_command("ip link set " + self._int_intf + " up") - - LOGGER.info("Network is restored") - - -class NetworkModule: - - def __init__(self): - self.name = None - self.display_name = None - self.description = None - - self.container = None - self.container_name = None - self.image_name = None - - # Absolute path - self.dir = None - self.dir_name = None - self.build_file = None - self.mounts = [] - - self.enable_container = True - - self.net_config = NetworkModuleNetConfig() - -# The networking configuration for a network module - - -class NetworkModuleNetConfig: - - def __init__(self): - - self.enable_wan = False - - self.ip_index = 0 - self.ipv4_address = None - self.ipv4_network = None - self.ipv6_address = None - self.ipv6_network = None - - self.host = False - - def get_ipv4_addr_with_prefix(self): - return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) - - def get_ipv6_addr_with_prefix(self): - return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) - -# Represents the current configuration of the network for the device bridge - -class NetworkConfig: - - # TODO: Let's get this from a configuration file - def __init__(self): - self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') - self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') +#!/usr/bin/env python3 + +import ipaddress +import json +import os +import sys +import time +import threading + +import docker +from docker.types import Mount + +import logger +import util +from listener import Listener +from network_validator import NetworkValidator + +LOGGER = logger.get_logger("net_orc") +CONFIG_FILE = "conf/system.json" +EXAMPLE_CONFIG_FILE = "conf/system.json.example" +RUNTIME_DIR = "runtime/network" +NETWORK_MODULES_DIR = "network/modules" +NETWORK_MODULE_METADATA = "conf/module_config.json" +DEVICE_BRIDGE = "tr-d" +INTERNET_BRIDGE = "tr-c" +PRIVATE_DOCKER_NET = "tr-private-net" +CONTAINER_NAME = "network_orchestrator" +RUNTIME = 300 + + +class NetworkOrchestrator: + """Manage and controls a virtual testing network.""" + + def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False): + self._int_intf = None + self._dev_intf = None + + self.listener = None + + self._net_modules = [] + + self.validate = validate + + self.async_monitor = async_monitor + + self._path = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.realpath(__file__)))) + + self.validator = NetworkValidator() + + self.network_config = NetworkConfig() + + self.load_config(config_file) + + def start(self): + """Start the network orchestrator.""" + + LOGGER.info("Starting Network Orchestrator") + # Get all components ready + self.load_network_modules() + + # Restore the network first if required + self.stop(kill=True) + + self.start_network() + + if self.async_monitor: + # Run the monitor method asynchronously to keep this method non-blocking + self._monitor_thread = threading.Thread( + target=self.monitor_network) + self._monitor_thread.daemon = True + self._monitor_thread.start() + else: + self.monitor_network() + + def start_network(self): + """Start the virtual testing network.""" + LOGGER.info("Starting network") + + self.build_network_modules() + self.create_net() + self.start_network_services() + + if self.validate: + # Start the validator after network is ready + self.validator.start() + + # Get network ready (via Network orchestrator) + LOGGER.info("Network is ready.") + + def stop(self, kill=False): + """Stop the network orchestrator.""" + self.stop_validator(kill=kill) + self.stop_network(kill=kill) + + def stop_validator(self, kill=False): + """Stop the network validator.""" + # Shutdown the validator + self.validator.stop(kill=kill) + + def stop_network(self, kill=False): + """Stop the virtual testing network.""" + # Shutdown network + self.stop_networking_services(kill=kill) + self.restore_net() + + def monitor_network(self): + # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) + time.sleep(RUNTIME) + + self.stop() + + def load_config(self,config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + self._config_file=os.path.join(self._path, CONFIG_FILE) + else: + # If defined, use as provided + self._config_file=config_file + + if not os.path.isfile(self._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) + + LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) + with open(self._config_file, encoding='UTF-8') as config_json_file: + config_json = json.load(config_json_file) + self.import_config(config_json) + + def import_config(self, json_config): + self._int_intf = json_config['network']['internet_intf'] + self._dev_intf = json_config['network']['device_intf'] + + def _check_network_services(self): + LOGGER.debug("Checking network modules...") + for net_module in self._net_modules: + if net_module.enable_container: + LOGGER.debug("Checking network module: " + + net_module.display_name) + success = self._ping(net_module) + if success: + LOGGER.debug(net_module.display_name + + " responded succesfully: " + str(success)) + else: + LOGGER.error(net_module.display_name + + " failed to respond to ping") + + def _ping(self, net_module): + host = net_module.net_config.ipv4_address + namespace = "tr-ctns-" + net_module.dir_name + cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) + success = util.run_command(cmd, output=False) + return success + + def _create_private_net(self): + client = docker.from_env() + try: + network = client.networks.get(PRIVATE_DOCKER_NET) + network.remove() + except docker.errors.NotFound: + pass + + # TODO: These should be made into variables + ipam_pool = docker.types.IPAMPool( + subnet='100.100.0.0/16', + iprange='100.100.100.0/24' + ) + + ipam_config = docker.types.IPAMConfig( + pool_configs=[ipam_pool] + ) + + client.networks.create( + PRIVATE_DOCKER_NET, + ipam=ipam_config, + internal=True, + check_duplicate=True, + driver="macvlan" + ) + + def create_net(self): + LOGGER.info("Creating baseline network") + + if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): + LOGGER.error("Configured interfaces are not ready for use. " + + "Ensure both interfaces are connected.") + sys.exit(1) + + # Create data plane + util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) + + # Create control plane + util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) + + # Add external interfaces to data and control plane + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + self._dev_intf) + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + self._int_intf) + + # Enable forwarding of eapol packets + util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + + " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") + + # Remove IP from internet adapter + util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") + + # Set ports up + util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") + util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") + + self._create_private_net() + + self.listener = Listener(self._dev_intf) + self.listener.start_listener() + + def load_network_modules(self): + """Load network modules from module_config.json.""" + LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) + + loaded_modules = "Loaded the following network modules: " + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + for module_dir in os.listdir(net_modules_dir): + + net_module = NetworkModule() + + # Load basic module information + + net_module_json = json.load(open(os.path.join( + self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) + + net_module.name = net_module_json['config']['meta']['name'] + net_module.display_name = net_module_json['config']['meta']['display_name'] + net_module.description = net_module_json['config']['meta']['description'] + net_module.dir = os.path.join( + self._path, net_modules_dir, module_dir) + net_module.dir_name = module_dir + net_module.build_file = module_dir + ".Dockerfile" + net_module.container_name = "tr-ct-" + net_module.dir_name + net_module.image_name = "test-run/" + net_module.dir_name + + # Attach folder mounts to network module + if "docker" in net_module_json['config']: + if "mounts" in net_module_json['config']['docker']: + for mount_point in net_module_json['config']['docker']['mounts']: + net_module.mounts.append(Mount( + target=mount_point['target'], + source=os.path.join( + os.getcwd(), mount_point['source']), + type='bind' + )) + + # Determine if this is a container or just an image/template + if "enable_container" in net_module_json['config']['docker']: + net_module.enable_container = net_module_json['config']['docker']['enable_container'] + + # Load network service networking configuration + if net_module.enable_container: + + net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] + net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] + + net_module.net_config.host = False if not "host" in net_module_json[ + 'config']['network'] else net_module_json['config']['network']['host'] + + net_module.net_config.ipv4_address = self.network_config.ipv4_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv4_network = self.network_config.ipv4_network + + net_module.net_config.ipv6_address = self.network_config.ipv6_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv6_network = self.network_config.ipv6_network + + loaded_modules += net_module.dir_name + " " + + self._net_modules.append(net_module) + + LOGGER.info(loaded_modules) + + def build_network_modules(self): + LOGGER.info("Building network modules...") + for net_module in self._net_modules: + self._build_module(net_module) + + def _build_module(self, net_module): + LOGGER.debug("Building network module " + net_module.dir_name) + client = docker.from_env() + client.images.build( + dockerfile=os.path.join(net_module.dir, net_module.build_file), + path=self._path, + forcerm=True, + tag="test-run/" + net_module.dir_name + ) + + def _get_network_module(self, name): + for net_module in self._net_modules: + if name == net_module.display_name: + return net_module + return None + + # Start the OVS network module + # This should always be called before loading all + # other modules to allow for a properly setup base + # network + def _start_ovs_module(self): + self._start_network_service(self._get_network_module("OVS")) + + def _start_network_service(self, net_module): + + LOGGER.debug("Starting net service " + net_module.display_name) + network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET + LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, + container name: {net_module.container_name}""") + try: + client = docker.from_env() + net_module.container = client.containers.run( + net_module.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=net_module.container_name, + hostname=net_module.container_name, + network=PRIVATE_DOCKER_NET, + privileged=True, + detach=True, + mounts=net_module.mounts, + environment={"HOST_USER": os.getlogin()} + ) + except docker.errors.ContainerError as error: + LOGGER.error("Container run error") + LOGGER.error(error) + + if network != "host": + self._attach_service_to_network(net_module) + + def _stop_service_module(self, net_module, kill=False): + LOGGER.debug("Stopping Service container " + net_module.container_name) + try: + container = self._get_service_container(net_module) + if container is not None: + if kill: + LOGGER.debug("Killing container:" + + net_module.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + + net_module.container_name) + container.stop() + LOGGER.debug("Container stopped:" + net_module.container_name) + except Exception as error: + LOGGER.error("Container stop error") + LOGGER.error(error) + + def _get_service_container(self, net_module): + LOGGER.debug("Resolving service container: " + + net_module.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_module.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + + net_module.container_name + " not found") + except Exception as e: + LOGGER.error("Failed to resolve container") + LOGGER.error(e) + return container + + def stop_networking_services(self, kill=False): + LOGGER.info("Stopping network services") + for net_module in self._net_modules: + # Network modules may just be Docker images, so we do not want to stop them + if not net_module.enable_container: + continue + self._stop_service_module(net_module, kill) + + def start_network_services(self): + LOGGER.info("Starting network services") + + os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) + + for net_module in self._net_modules: + + # TODO: There should be a better way of doing this + # Do not try starting OVS module again, as it should already be running + if "OVS" != net_module.display_name: + + # Network modules may just be Docker images, so we do not want to start them as containers + if not net_module.enable_container: + continue + + self._start_network_service(net_module) + + LOGGER.info("All network services are running") + self._check_network_services() + + # TODO: Let's move this into a separate script? It does not look great + def _attach_service_to_network(self, net_module): + LOGGER.debug("Attaching net service " + + net_module.display_name + " to device bridge") + + # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Container network namespace name + container_net_ns = "tr-ctns-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Add bridge interface to device bridge + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command( + "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] + + # Create symlink for container network namespace + util.run_command("ln -sf /proc/" + container_pid + + "/ns/net /var/run/netns/" + container_net_ns) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to veth0 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name veth0") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) + + # Set IP address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") + + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev veth0 up") + + if net_module.net_config.enable_wan: + LOGGER.debug("Attaching net service " + + net_module.display_name + " to internet bridge") + + # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) + bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Attach bridge interface to internet bridge + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + bridge_intf) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to eth1 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name eth1") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + + container_net_ns + " ip link set dev eth1 up") + + def restore_net(self): + + LOGGER.info("Clearing baseline network") + + if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): + self.listener.stop_listener() + + client = docker.from_env() + + # Stop all network containers if still running + for net_module in self._net_modules: + try: + container = client.containers.get( + "tr-ct-" + net_module.dir_name) + container.kill() + except Exception: + continue + + # Delete data plane + util.run_command("ovs-vsctl --if-exists del-br tr-d") + + # Delete control plane + util.run_command("ovs-vsctl --if-exists del-br tr-c") + + # Restart internet interface + if util.interface_exists(self._int_intf): + util.run_command("ip link set " + self._int_intf + " down") + util.run_command("ip link set " + self._int_intf + " up") + + LOGGER.info("Network is restored") + + +class NetworkModule: + + def __init__(self): + self.name = None + self.display_name = None + self.description = None + + self.container = None + self.container_name = None + self.image_name = None + + # Absolute path + self.dir = None + self.dir_name = None + self.build_file = None + self.mounts = [] + + self.enable_container = True + + self.net_config = NetworkModuleNetConfig() + +# The networking configuration for a network module + + +class NetworkModuleNetConfig: + + def __init__(self): + + self.enable_wan = False + + self.ip_index = 0 + self.ipv4_address = None + self.ipv4_network = None + self.ipv6_address = None + self.ipv6_network = None + + self.host = False + + def get_ipv4_addr_with_prefix(self): + return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) + + def get_ipv6_addr_with_prefix(self): + return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) + +# Represents the current configuration of the network for the device bridge + +class NetworkConfig: + + # TODO: Let's get this from a configuration file + def __init__(self): + self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') + self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') diff --git a/resources/devices/Template/device_config.json b/resources/devices/Template/device_config.json new file mode 100644 index 000000000..f8b56b7a3 --- /dev/null +++ b/resources/devices/Template/device_config.json @@ -0,0 +1,32 @@ +{ + "make": "Manufacturer X", + "model": "Device X", + "mac_addr": "aa:bb:cc:dd:ee:ff", + "test_modules": { + "dns": { + "enabled": true, + "tests": { + "dns.network.from_device": { + "enabled": true + }, + "dns.network.from_dhcp": { + "enabled": true + } + } + }, + "baseline": { + "enabled": true, + "tests": { + "baseline.passe": { + "enabled": true + }, + "baseline.pass": { + "enabled": true + }, + "baseline.skip": { + "enabled": true + } + } + } + } +} \ No newline at end of file diff --git a/test_orc/modules/base/bin/capture b/test_orc/modules/base/bin/capture index dccafb0c5..facb6acf7 100644 --- a/test_orc/modules/base/bin/capture +++ b/test_orc/modules/base/bin/capture @@ -4,7 +4,7 @@ MODULE_NAME=$1 # Define the local file location for the capture to be saved -PCAP_DIR="/runtime/output/" +PCAP_DIR="/runtime/output" PCAP_FILE=$MODULE_NAME.pcap # Allow a user to define an interface by passing it into this script @@ -13,7 +13,6 @@ INTERFACE=$2 # Create the output directory and start the capture mkdir -p $PCAP_DIR chown $HOST_USER:$HOST_USER $PCAP_DIR -echo "PCAP Dir: $PCAP_DIR/$PCAP_FILE" tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & # Small pause to let the capture to start diff --git a/test_orc/modules/base/bin/start_module b/test_orc/modules/base/bin/start_module index a9f5402f4..6adc53f58 100644 --- a/test_orc/modules/base/bin/start_module +++ b/test_orc/modules/base/bin/start_module @@ -4,7 +4,7 @@ BIN_DIR="/testrun/bin" # Default interface should be veth0 for all containers -DEFAULT_IFACE=veth0 +IFACE=veth0 # Create a local user that matches the same as the host # to be used for correct file ownership for various logs @@ -27,7 +27,7 @@ fi # Extract the necessary config parameters MODULE_NAME=$(echo "$CONF" | jq -r '.config.meta.name') -DEFINED_IFACE=$(echo "$CONF" | jq -r '.config.network.interface') +NETWORK_REQUIRED=$(echo "$CONF" | jq -r '.config.network') GRPC=$(echo "$CONF" | jq -r '.config.grpc') # Validate the module name is present @@ -37,24 +37,19 @@ then exit 1 fi -# Select which interace to use -if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] -then - echo "No Interface Defined, defaulting to veth0" - INTF=$DEFAULT_IFACE -else - INTF=$DEFINED_IFACE -fi - echo "Starting module $MODULE_NAME..." $BIN_DIR/setup_binaries $BIN_DIR -# Wait for interface to become ready -$BIN_DIR/wait_for_interface $INTF +# Only start network services if the test container needs +# a network connection to run its tests +if [ $NETWORK_REQUIRED == "true" ];then + # Wait for interface to become ready + $BIN_DIR/wait_for_interface $IFACE -# Start network capture -$BIN_DIR/capture $MODULE_NAME $INTF + # Start network capture + $BIN_DIR/capture $MODULE_NAME $IFACE +fi # Start the grpc server if [[ ! -z $GRPC && ! $GRPC == "null" ]] @@ -73,4 +68,4 @@ fi sleep 3 # Start the networking service -$BIN_DIR/start_test_module $MODULE_NAME $INTF \ No newline at end of file +$BIN_DIR/start_test_module $MODULE_NAME $IFACE \ No newline at end of file diff --git a/test_orc/modules/base/conf/module_config.json b/test_orc/modules/base/conf/module_config.json index 1f3a47ba2..7288dacfd 100644 --- a/test_orc/modules/base/conf/module_config.json +++ b/test_orc/modules/base/conf/module_config.json @@ -5,6 +5,7 @@ "display_name": "Base", "description": "Base image" }, + "network": false, "docker": { "enable_container": false } diff --git a/test_orc/modules/base/python/src/logger.py b/test_orc/modules/base/python/src/logger.py index 0eb7b9ccf..641aa16b4 100644 --- a/test_orc/modules/base/python/src/logger.py +++ b/test_orc/modules/base/python/src/logger.py @@ -10,12 +10,12 @@ _DEFAULT_LEVEL = logging.INFO _CONF_DIR = "conf" _CONF_FILE_NAME = "system.json" -_LOG_DIR = "/runtime/network/" +_LOG_DIR = "/runtime/output/" # Set log level try: system_conf_json = json.load( - open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='utf-8')) + open(os.path.join(_CONF_DIR, _CONF_FILE_NAME))) log_level_str = system_conf_json['log_level'] log_level = logging.getLevelName(log_level_str) except: @@ -24,22 +24,23 @@ log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) - -def add_file_handler(log, log_file): - handler = logging.FileHandler(_LOG_DIR+log_file+".log") +def add_file_handler(log, logFile): + handler = logging.FileHandler(_LOG_DIR+logFile+".log") handler.setFormatter(log_format) log.addHandler(handler) + def add_stream_handler(log): handler = logging.StreamHandler() handler.setFormatter(log_format) log.addHandler(handler) -def get_logger(name, log_file=None): + +def get_logger(name, logFile=None): if name not in LOGGERS: LOGGERS[name] = logging.getLogger(name) LOGGERS[name].setLevel(log_level) add_stream_handler(LOGGERS[name]) - if log_file is not None: - add_file_handler(LOGGERS[name], log_file) + if logFile is not None: + add_file_handler(LOGGERS[name], logFile) return LOGGERS[name] diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py new file mode 100644 index 000000000..6f7f48c3a --- /dev/null +++ b/test_orc/modules/base/python/src/test_module.py @@ -0,0 +1,84 @@ +import json +import logger +import os + +LOGGER = None +RESULTS_DIR = "/runtime/output/" +CONF_FILE = "/testrun/conf/module_config.json" + + +class TestModule: + + def __init__(self, module_name, log_name): + self._module_name = module_name + self._device_mac = os.environ['DEVICE_MAC'] + self._add_logger(log_name=log_name, module_name=module_name) + self._config = self._read_config() + + def _add_logger(self, log_name, module_name): + global LOGGER + LOGGER = logger.get_logger(log_name, module_name) + + def _get_logger(self): + return LOGGER + + def _get_tests(self): + device_test_module = self._get_device_test_module() + return self._get_device_tests(device_test_module) + + def _get_device_tests(self, device_test_module): + module_tests = self._config["config"]["tests"] + if device_test_module is None: + return module_tests + elif not device_test_module["enabled"]: + return [] + else: + for test in module_tests: + if test["name"] in device_test_module["tests"]: + test["enabled"] = device_test_module["tests"][test["name"]]["enabled"] + return module_tests + + def _get_device_test_module(self): + test_modules = json.loads(os.environ['DEVICE_TEST_MODULES']) + if self._module_name in test_modules: + return test_modules[self._module_name] + return None + + def run_tests(self): + tests = self._get_tests() + device_modules = os.environ['DEVICE_TEST_MODULES'] + for test in tests: + test_method_name = "_" + test["name"].replace(".", "_") + result = None + if ("enabled" in test and test["enabled"]) or "enabled" not in test: + LOGGER.info("Attempting to run test: " + test["name"]) + + # Resolve the correct python method by test name and run test + if hasattr(self, test_method_name): + result = getattr(self, test_method_name)() + else: + LOGGER.info("Test " + test["name"] + + " not resolved. Skipping") + result = None + else: + LOGGER.info("Test " + test["name"] + + " disabled. Skipping") + if result is not None: + test["result"] = "compliant" if result else "non-compliant" + else: + test["result"] = "skipped" + json_results = json.dumps({"results": tests}, indent=2) + self._write_results(json_results) + + def _read_config(self): + f = open(CONF_FILE, encoding="utf-8") + config = json.load(f) + f.close() + return config + + def _write_results(self, results): + results_file = RESULTS_DIR + self._module_name + "-result.json" + LOGGER.info("Writing results to " + results_file) + f = open(results_file, "w", encoding="utf-8") + f.write(results) + f.close() diff --git a/test_orc/modules/baseline/conf/module_config.json b/test_orc/modules/baseline/conf/module_config.json index 1b8b7b9ba..ba337267a 100644 --- a/test_orc/modules/baseline/conf/module_config.json +++ b/test_orc/modules/baseline/conf/module_config.json @@ -5,17 +5,27 @@ "display_name": "Baseline", "description": "Baseline test" }, - "network": { - "interface": "eth0", - "enable_wan": false, - "ip_index": 9 - }, - "grpc": { - "port": 50001 - }, + "network": false, "docker": { "enable_container": true, "timeout": 30 - } + }, + "tests":[ + { + "name": "baseline.pass", + "description": "Simulate a compliant test", + "expected_behavior": "A compliant test result is generated" + }, + { + "name": "baseline.fail", + "description": "Simulate a non-compliant test", + "expected_behavior": "A non-compliant test result is generated" + }, + { + "name": "baseline.skip", + "description": "Simulate a skipped test", + "expected_behavior": "A skipped test result is generated" + } + ] } } \ No newline at end of file diff --git a/test_orc/modules/baseline/python/src/baseline_module.py b/test_orc/modules/baseline/python/src/baseline_module.py new file mode 100644 index 000000000..80c04ef48 --- /dev/null +++ b/test_orc/modules/baseline/python/src/baseline_module.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python3 + +from test_module import TestModule + +LOG_NAME = "test_baseline" +LOGGER = None + +class BaselineModule(TestModule): + + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + global LOGGER + LOGGER = self._get_logger() + + def _baseline_pass(self): + LOGGER.info( + "Running baseline pass test") + LOGGER.info("Baseline pass test finished") + return True + + def _baseline_fail(self): + LOGGER.info( + "Running baseline pass test") + LOGGER.info("Baseline pass test finished") + return False + + def _baseline_skip(self): + LOGGER.info( + "Running baseline pass test") + LOGGER.info("Baseline pass test finished") + return None \ No newline at end of file diff --git a/test_orc/modules/baseline/python/src/logger.py b/test_orc/modules/baseline/python/src/logger.py deleted file mode 100644 index 641aa16b4..000000000 --- a/test_orc/modules/baseline/python/src/logger.py +++ /dev/null @@ -1,46 +0,0 @@ -#!/usr/bin/env python3 - -import json -import logging -import os - -LOGGERS = {} -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" -_DATE_FORMAT = '%b %02d %H:%M:%S' -_DEFAULT_LEVEL = logging.INFO -_CONF_DIR = "conf" -_CONF_FILE_NAME = "system.json" -_LOG_DIR = "/runtime/output/" - -# Set log level -try: - system_conf_json = json.load( - open(os.path.join(_CONF_DIR, _CONF_FILE_NAME))) - log_level_str = system_conf_json['log_level'] - log_level = logging.getLevelName(log_level_str) -except: - # TODO: Print out warning that log level is incorrect or missing - log_level = _DEFAULT_LEVEL - -log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) - -def add_file_handler(log, logFile): - handler = logging.FileHandler(_LOG_DIR+logFile+".log") - handler.setFormatter(log_format) - log.addHandler(handler) - - -def add_stream_handler(log): - handler = logging.StreamHandler() - handler.setFormatter(log_format) - log.addHandler(handler) - - -def get_logger(name, logFile=None): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - LOGGERS[name].setLevel(log_level) - add_stream_handler(LOGGERS[name]) - if logFile is not None: - add_file_handler(LOGGERS[name], logFile) - return LOGGERS[name] diff --git a/test_orc/modules/baseline/python/src/run.py b/test_orc/modules/baseline/python/src/run.py index 7ff11559f..ffa171e17 100644 --- a/test_orc/modules/baseline/python/src/run.py +++ b/test_orc/modules/baseline/python/src/run.py @@ -5,12 +5,12 @@ import sys import logger -from test_module import TestModule +from baseline_module import BaselineModule LOGGER = logger.get_logger('test_module') RUNTIME = 300 -class TestModuleRunner: +class BaselineModuleRunner: def __init__(self,module): @@ -19,11 +19,10 @@ def __init__(self,module): signal.signal(signal.SIGABRT, self._handler) signal.signal(signal.SIGQUIT, self._handler) - LOGGER.info("Starting Test Module Template") + LOGGER.info("Starting Baseline Module") - self._test_module = TestModule(module) + self._test_module = BaselineModule(module) self._test_module.run_tests() - self._test_module.generate_results() def _handler(self, signum, *other): LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) @@ -34,7 +33,7 @@ def _handler(self, signum, *other): sys.exit(1) def run(argv): - parser = argparse.ArgumentParser(description="Test Module Template", + parser = argparse.ArgumentParser(description="Baseline Module Help", formatter_class=argparse.ArgumentDefaultsHelpFormatter) parser.add_argument( @@ -44,7 +43,7 @@ def run(argv): # For some reason passing in the args from bash adds an extra # space before the argument so we'll just strip out extra space - TestModuleRunner(args.module.strip()) + BaselineModuleRunner(args.module.strip()) if __name__ == "__main__": run(sys.argv) diff --git a/test_orc/modules/baseline/python/src/test_module.py b/test_orc/modules/baseline/python/src/test_module.py deleted file mode 100644 index d4065cde3..000000000 --- a/test_orc/modules/baseline/python/src/test_module.py +++ /dev/null @@ -1,61 +0,0 @@ -#!/usr/bin/env python3 - -import json -import time -import logger - -LOG_NAME = "test_baseline" -RESULTS_DIR = "/runtime/output/" -LOGGER = logger.get_logger(LOG_NAME) - -class TestModule: - - def __init__(self, module): - - self.module_test1 = None - self.module_test2 = None - self.module_test3 = None - self.module = module - self.add_logger(module) - - def add_logger(self, module): - global LOGGER - LOGGER = logger.get_logger(LOG_NAME, module) - - # Make up some fake test results - def run_tests(self): - LOGGER.info("Running test 1...") - self.module_test1 = True - LOGGER.info("Test 1 complete.") - - LOGGER.info("Running test 2...") - self.module_test2 = False - LOGGER.info("Test 2 complete.") - - def generate_results(self): - results = [] - results.append(self.generate_result("Test 1", self.module_test1)) - results.append(self.generate_result("Test 2", self.module_test2)) - results.append(self.generate_result("Test 3", self.module_test3)) - json_results = json.dumps({"results":results}, indent=2) - self.write_results(json_results) - - def write_results(self,results): - results_file=RESULTS_DIR+self.module+"-result.json" - LOGGER.info("Writing results to " + results_file) - f = open(results_file, "w", encoding="utf-8") - f.write(results) - f.close() - - def generate_result(self, test_name, test_result): - if test_result is not None: - result = "compliant" if test_result else "non-compliant" - else: - result = "skipped" - LOGGER.info(test_name + ": " + result) - res_dict = { - "name": test_name, - "result": result, - "description": "The device is " + result - } - return res_dict diff --git a/test_orc/modules/dns/bin/start_test_module b/test_orc/modules/dns/bin/start_test_module new file mode 100644 index 000000000..2938eb0f8 --- /dev/null +++ b/test_orc/modules/dns/bin/start_test_module @@ -0,0 +1,42 @@ +#!/bin/bash + +# An example startup script that does the bare minimum to start +# a test module via a pyhon script. Each test module should include a +# start_test_module file that overwrites this one to boot all of its +# specific requirements to run. + +# Define where the python source files are located +PYTHON_SRC_DIR=/testrun/python/src + +# Fetch module name +MODULE_NAME=$1 + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No interface defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +# Create and set permissions on the log files +LOG_FILE=/runtime/output/$MODULE_NAME.log +RESULT_FILE=/runtime/output/$MODULE_NAME-result.json +touch $LOG_FILE +touch $RESULT_FILE +chown $HOST_USER:$HOST_USER $LOG_FILE +chown $HOST_USER:$HOST_USER $RESULT_FILE + +# Run the python scrip that will execute the tests for this module +# -u flag allows python print statements +# to be logged by docker by running unbuffered +python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" + +echo Module has finished \ No newline at end of file diff --git a/test_orc/modules/dns/conf/module_config.json b/test_orc/modules/dns/conf/module_config.json new file mode 100644 index 000000000..d21f6bca6 --- /dev/null +++ b/test_orc/modules/dns/conf/module_config.json @@ -0,0 +1,26 @@ +{ + "config": { + "meta": { + "name": "dns", + "display_name": "DNS", + "description": "DNS test" + }, + "network": false, + "docker": { + "enable_container": true, + "timeout": 30 + }, + "tests":[ + { + "name": "dns.network.from_device", + "description": "Verify the device sends DNS requests", + "expected_behavior": "The device sends DNS requests." + }, + { + "name": "dns.network.from_dhcp", + "description": "Verify the device allows for a DNS server to be entered automatically", + "expected_behavior": "The device sends DNS requests to the DNS server provided by the DHCP server" + } + ] + } +} \ No newline at end of file diff --git a/test_orc/modules/dns/dns.Dockerfile b/test_orc/modules/dns/dns.Dockerfile new file mode 100644 index 000000000..7c3497bc3 --- /dev/null +++ b/test_orc/modules/dns/dns.Dockerfile @@ -0,0 +1,11 @@ +# Image name: test-run/baseline-test +FROM test-run/base-test:latest + +# Copy over all configuration files +COPY modules/dns/conf /testrun/conf + +# Load device binary files +COPY modules/dns/bin /testrun/bin + +# Copy over all python files +COPY modules/dns/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/dns/python/src/dns_module.py b/test_orc/modules/dns/python/src/dns_module.py new file mode 100644 index 000000000..f1333ce14 --- /dev/null +++ b/test_orc/modules/dns/python/src/dns_module.py @@ -0,0 +1,77 @@ +#!/usr/bin/env python3 + +import subprocess +from test_module import TestModule + +LOG_NAME = "test_dns" +CAPTURE_FILE = "/runtime/network/dns.pcap" +LOGGER = None + +class DNSModule(TestModule): + + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + self._dns_server = "10.10.10.4" + global LOGGER + LOGGER = self._get_logger() + + def _check_dns_traffic(self, tcpdump_filter): + to_dns = self._exec_tcpdump(tcpdump_filter) + num_query_dns = len(to_dns) + LOGGER.info("DNS queries found: " + str(num_query_dns)) + dns_traffic_detected = len(to_dns) > 0 + LOGGER.info("DNS traffic detected: " + str(dns_traffic_detected)) + return dns_traffic_detected + + def _dns_network_from_dhcp(self): + LOGGER.info( + "Checking DNS traffic for configured DHCP DNS server: " + self._dns_server) + + # Check if the device DNS traffic is to appropriate server + tcpdump_filter = 'dst port 53 and dst host {} and ether src {}'.format( + self._dns_server, self._device_mac) + + result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) + + LOGGER.info( + "DNS traffic detected to configured DHCP DNS server: " + str(result)) + return result + + def _dns_network_from_device(self): + LOGGER.info("Checking DNS traffic from device: " + self._device_mac) + + # Check if the device DNS traffic is to appropriate server + tcpdump_filter = 'dst port 53 and ether src {}'.format( + self._device_mac) + + result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) + + LOGGER.info("DNS traffic detected from device: " + str(result)) + return result + + def _exec_tcpdump(self, tcpdump_filter): + """ + Args + tcpdump_filter: Filter to pass onto tcpdump file + capture_file: Optional capture file to look + Returns + List of packets matching the filter + """ + command = 'tcpdump -tttt -n -r {} {}'.format( + CAPTURE_FILE, tcpdump_filter) + + LOGGER.debug("tcpdump command: " + command) + + process = subprocess.Popen(command, + universal_newlines=True, + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + text = str(process.stdout.read()).rstrip() + + LOGGER.debug("tcpdump response: " + text) + + if text: + return text.split("\n") + + return [] diff --git a/test_orc/modules/dns/python/src/run.py b/test_orc/modules/dns/python/src/run.py new file mode 100644 index 000000000..7ee5e7833 --- /dev/null +++ b/test_orc/modules/dns/python/src/run.py @@ -0,0 +1,58 @@ +#!/usr/bin/env python3 + +import argparse +import signal +import sys +import logger +import time + +from dns_module import DNSModule + +LOG_NAME = "dns_module" +LOGGER = logger.get_logger(LOG_NAME) +RUNTIME = 300 + +class DNSModuleRunner: + + def __init__(self,module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + self.add_logger(module) + + LOGGER.info("Starting DNS Test Module") + + self._test_module = DNSModule(module) + self._test_module.run_tests() + + LOGGER.info("DNS Test Module Finished") + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def _handler(self, signum, *other): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping test module...") + LOGGER.info("Test module stopped") + sys.exit(1) + +def run(argv): + parser = argparse.ArgumentParser(description="Test Module DNS", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + "-m", "--module", help="Define the module name to be used to create the log file") + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + DNSModuleRunner(args.module.strip()) + +if __name__ == "__main__": + run(sys.argv) diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index f68a13579..85c6fb631 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -14,6 +14,7 @@ TEST_MODULES_DIR = "modules" MODULE_CONFIG = "conf/module_config.json" + class TestOrchestrator: """Manages and controls the test modules.""" @@ -27,26 +28,27 @@ def __init__(self): # Resolve the path to the test-run folder self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) - shutil.rmtree(os.path.join(self._root_path, RUNTIME_DIR), ignore_errors=True) + shutil.rmtree(os.path.join(self._root_path, + RUNTIME_DIR), ignore_errors=True) os.makedirs(os.path.join(self._root_path, RUNTIME_DIR), exist_ok=True) def start(self): LOGGER.info("Starting Test Orchestrator") self._load_test_modules() - self._run_test_modules() + self.build_test_modules() def stop(self): """Stop any running tests""" self._stop_modules() - def _run_test_modules(self): + def run_test_modules(self, device): """Iterates through each test module and starts the container.""" LOGGER.info("Running test modules...") for module in self._test_modules: - self._run_test_module(module) + self._run_test_module(module, device) LOGGER.info("All tests complete") - def _run_test_module(self, module): + def _run_test_module(self, module, device): """Start the test container and extract the results.""" if module is None or not module.enable_container: @@ -55,7 +57,10 @@ def _run_test_module(self, module): LOGGER.info("Running test module " + module.name) try: - container_runtime_dir = os.path.join(self._root_path, "runtime/test/" + module.name) + container_runtime_dir = os.path.join( + self._root_path, "runtime/test/" + device.mac_addr.replace(":","") + "/" + module.name) + network_runtime_dir = os.path.join( + self._root_path, "runtime/network") os.makedirs(container_runtime_dir) client = docker.from_env() @@ -68,12 +73,24 @@ def _run_test_module(self, module): hostname=module.container_name, privileged=True, detach=True, - mounts=[Mount( - target="/runtime/output", - source=container_runtime_dir, - type='bind' - )], - environment={"HOST_USER": os.getlogin()} + mounts=[ + Mount( + target="/runtime/output", + source=container_runtime_dir, + type='bind' + ), + Mount( + target="/runtime/network", + source=network_runtime_dir, + type='bind', + read_only=True + ), + ], + environment={ + "HOST_USER": os.getlogin(), + "DEVICE_MAC": device.mac_addr, + "DEVICE_TEST_MODULES": device.test_modules + } ) except (docker.errors.APIError, docker.errors.ContainerError) as container_error: LOGGER.error("Test module " + module.name + " has failed to start") @@ -90,7 +107,7 @@ def _run_test_module(self, module): LOGGER.info("Test module " + module.name + " has finished") - def _get_module_status(self,module): + def _get_module_status(self, module): container = self._get_module_container(module) if container is not None: return container.status @@ -124,11 +141,11 @@ def _load_test_modules(self): # Load basic module information module = TestModule() with open(os.path.join( - self._path, - modules_dir, - module_dir, - MODULE_CONFIG), - encoding='UTF-8') as module_config_file: + self._path, + modules_dir, + module_dir, + MODULE_CONFIG), + encoding='UTF-8') as module_config_file: module_json = json.load(module_config_file) module.name = module_json['config']['meta']['name'] @@ -150,7 +167,7 @@ def _load_test_modules(self): self._test_modules.append(module) if module.enable_container: - loaded_modules += module.dir_name + " " + loaded_modules += module.dir_name + " " LOGGER.info(loaded_modules) @@ -167,7 +184,7 @@ def _build_test_module(self, module): client.images.build( dockerfile=os.path.join(module.dir, module.build_file), path=self._path, - forcerm=True, # Cleans up intermediate containers during build + forcerm=True, # Cleans up intermediate containers during build tag=module.image_name ) except docker.errors.BuildError as error: @@ -197,4 +214,4 @@ def _stop_module(self, module, kill=False): container.stop() LOGGER.debug("Container stopped:" + module.container_name) except docker.errors.NotFound: - pass \ No newline at end of file + pass From 0837a9cc8a947ff2edac37a058f3516c0bf415f2 Mon Sep 17 00:00:00 2001 From: Noureddine Date: Tue, 16 May 2023 15:49:46 +0100 Subject: [PATCH 009/400] Add baseline and pylint tests (#25) --- .github/workflows/testing.yml | 30 +++++++++ framework/test_runner.py | 11 +++- framework/testrun.py | 10 ++- net_orc/python/src/network_orchestrator.py | 47 ++++++++++++- net_orc/python/src/network_validator.py | 3 +- test_orc/modules/baseline/python/src/run.py | 2 +- test_orc/modules/dns/python/src/run.py | 2 +- test_orc/python/src/test_orchestrator.py | 3 +- testing/docker/ci_baseline/Dockerfile | 10 +++ testing/docker/ci_baseline/entrypoint.sh | 56 ++++++++++++++++ testing/test_baseline | 73 +++++++++++++++++++++ testing/test_baseline.py | 49 ++++++++++++++ testing/test_pylint | 26 ++++++++ 13 files changed, 309 insertions(+), 13 deletions(-) create mode 100644 .github/workflows/testing.yml create mode 100644 testing/docker/ci_baseline/Dockerfile create mode 100755 testing/docker/ci_baseline/entrypoint.sh create mode 100755 testing/test_baseline create mode 100644 testing/test_baseline.py create mode 100755 testing/test_pylint diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml new file mode 100644 index 000000000..fbdbe442c --- /dev/null +++ b/.github/workflows/testing.yml @@ -0,0 +1,30 @@ +name: Testrun test suite + +on: + push: + pull_request: + schedule: + - cron: '0 13 * * *' + +jobs: + testrun: + name: Baseline + runs-on: ubuntu-20.04 + timeout-minutes: 20 + steps: + - name: Checkout source + uses: actions/checkout@v2.3.4 + - name: Run tests + shell: bash {0} + run: testing/test_baseline + + pylint: + name: Pylint + runs-on: ubuntu-20.04 + timeout-minutes: 20 + steps: + - name: Checkout source + uses: actions/checkout@v2.3.4 + - name: Run tests + shell: bash {0} + run: testing/test_pylint diff --git a/framework/test_runner.py b/framework/test_runner.py index 14cadf3e1..5c4bf1472 100644 --- a/framework/test_runner.py +++ b/framework/test_runner.py @@ -19,10 +19,12 @@ class TestRunner: - def __init__(self, config_file=None, validate=True, net_only=False): + def __init__(self, config_file=None, validate=True, net_only=False, single_intf=False): self._register_exits() self.test_run = TestRun(config_file=config_file, - validate=validate, net_only=net_only) + validate=validate, + net_only=net_only, + single_intf=single_intf) def _register_exits(self): signal.signal(signal.SIGINT, self._exit_handler) @@ -57,6 +59,8 @@ def parse_args(argv): help="Turn off the validation of the network after network boot") parser.add_argument("-net", "--net-only", action="store_true", help="Run the network only, do not run tests") + parser.add_argument("--single-intf", action="store_true", + help="Single interface mode (experimental)") args, unknown = parser.parse_known_args() return args @@ -65,5 +69,6 @@ def parse_args(argv): args = parse_args(sys.argv) runner = TestRunner(config_file=args.config_file, validate=not args.no_validate, - net_only=args.net_only) + net_only=args.net_only, + single_intf=args.single_intf) runner.start() diff --git a/framework/testrun.py b/framework/testrun.py index 40076108b..55719d968 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -33,7 +33,7 @@ LOGGER = logger.get_logger('test_run') CONFIG_FILE = 'conf/system.json' EXAMPLE_CONFIG_FILE = 'conf/system.json.example' -RUNTIME = 300 +RUNTIME = 1500 LOCAL_DEVICES_DIR = 'local/devices' RESOURCE_DEVICES_DIR = 'resources/devices' @@ -51,9 +51,10 @@ class TestRun: # pylint: disable=too-few-public-methods orchestrator and user interface. """ - def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False): + def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False, single_intf=False): self._devices = [] self._net_only = net_only + self._single_intf = single_intf # Catch any exit signals self._register_exits() @@ -62,7 +63,10 @@ def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False): config_file_abs = self._get_config_abs(config_file=config_file) self._net_orc = net_orc.NetworkOrchestrator( - config_file=config_file_abs, validate=validate, async_monitor=not self._net_only) + config_file=config_file_abs, + validate=validate, + async_monitor=not self._net_only, + single_intf = self._single_intf) self._test_orc = test_orc.TestOrchestrator() def start(self): diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 63391a24f..56ae93c3f 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,8 +1,10 @@ #!/usr/bin/env python3 +import getpass import ipaddress import json import os +import subprocess import sys import time import threading @@ -25,15 +27,16 @@ INTERNET_BRIDGE = "tr-c" PRIVATE_DOCKER_NET = "tr-private-net" CONTAINER_NAME = "network_orchestrator" -RUNTIME = 300 +RUNTIME = 1500 class NetworkOrchestrator: """Manage and controls a virtual testing network.""" - def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False): + def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): self._int_intf = None self._dev_intf = None + self._single_intf = single_intf self.listener = None @@ -153,6 +156,38 @@ def _ping(self, net_module): success = util.run_command(cmd, output=False) return success + def _ci_pre_network_create(self): + """ Stores network properties to restore network after + network creation and flushes internet interface + """ + + self._ethmac = subprocess.check_output( + f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() + self._gateway = subprocess.check_output( + "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() + self._ipv4 = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._ipv6 = subprocess.check_output( + f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._brd = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() + + def _ci_post_network_create(self): + """ Restore network connection in CI environment """ + LOGGER.info("post cr") + util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") + util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") + util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") + util.run_command(f"ip addr flush dev {self._int_intf}") + util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") + util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") + util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") + util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") + util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") + util.run_command(f"dhclient {INTERNET_BRIDGE}") + util.run_command(f"ip route del default via 10.1.0.1") + util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") + def _create_private_net(self): client = docker.from_env() try: @@ -186,6 +221,9 @@ def create_net(self): LOGGER.error("Configured interfaces are not ready for use. " + "Ensure both interfaces are connected.") sys.exit(1) + + if self._single_intf: + self._ci_pre_network_create() # Create data plane util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) @@ -210,6 +248,9 @@ def create_net(self): util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") + if self._single_intf: + self._ci_post_network_create() + self._create_private_net() self.listener = Listener(self._dev_intf) @@ -325,7 +366,7 @@ def _start_network_service(self, net_module): privileged=True, detach=True, mounts=net_module.mounts, - environment={"HOST_USER": os.getlogin()} + environment={"HOST_USER": getpass.getuser()} ) except docker.errors.ContainerError as error: LOGGER.error("Container run error") diff --git a/net_orc/python/src/network_validator.py b/net_orc/python/src/network_validator.py index 53fbcdbd0..2f01a06e9 100644 --- a/net_orc/python/src/network_validator.py +++ b/net_orc/python/src/network_validator.py @@ -5,6 +5,7 @@ import time import docker from docker.types import Mount +import getpass import logger import util @@ -144,7 +145,7 @@ def _start_network_device(self, device): privileged=True, detach=True, mounts=device.mounts, - environment={"HOST_USER": os.getlogin()} + environment={"HOST_USER": getpass.getuser()} ) except docker.errors.ContainerError as error: LOGGER.error("Container run error") diff --git a/test_orc/modules/baseline/python/src/run.py b/test_orc/modules/baseline/python/src/run.py index ffa171e17..8b55484ae 100644 --- a/test_orc/modules/baseline/python/src/run.py +++ b/test_orc/modules/baseline/python/src/run.py @@ -8,7 +8,7 @@ from baseline_module import BaselineModule LOGGER = logger.get_logger('test_module') -RUNTIME = 300 +RUNTIME = 1500 class BaselineModuleRunner: diff --git a/test_orc/modules/dns/python/src/run.py b/test_orc/modules/dns/python/src/run.py index 7ee5e7833..e5fedb67b 100644 --- a/test_orc/modules/dns/python/src/run.py +++ b/test_orc/modules/dns/python/src/run.py @@ -10,7 +10,7 @@ LOG_NAME = "dns_module" LOGGER = logger.get_logger(LOG_NAME) -RUNTIME = 300 +RUNTIME = 1500 class DNSModuleRunner: diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 85c6fb631..ee5cc5b45 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -1,4 +1,5 @@ """Provides high level management of the test orchestrator.""" +import getpass import os import json import time @@ -87,7 +88,7 @@ def _run_test_module(self, module, device): ), ], environment={ - "HOST_USER": os.getlogin(), + "HOST_USER": getpass.getuser(), "DEVICE_MAC": device.mac_addr, "DEVICE_TEST_MODULES": device.test_modules } diff --git a/testing/docker/ci_baseline/Dockerfile b/testing/docker/ci_baseline/Dockerfile new file mode 100644 index 000000000..7c3c1eebd --- /dev/null +++ b/testing/docker/ci_baseline/Dockerfile @@ -0,0 +1,10 @@ +FROM ubuntu:jammy + +#Update and get all additional requirements not contained in the base image +RUN apt-get update && apt-get -y upgrade + +RUN apt-get install -y isc-dhcp-client ntpdate coreutils moreutils inetutils-ping curl jq dnsutils + +COPY entrypoint.sh /entrypoint.sh + +ENTRYPOINT ["/entrypoint.sh"] \ No newline at end of file diff --git a/testing/docker/ci_baseline/entrypoint.sh b/testing/docker/ci_baseline/entrypoint.sh new file mode 100755 index 000000000..bc2da3ec2 --- /dev/null +++ b/testing/docker/ci_baseline/entrypoint.sh @@ -0,0 +1,56 @@ +#!/bin/bash + +OUT=/out/testrun_ci.json + +NTP_SERVER=10.10.10.5 +DNS_SERVER=10.10.10.4 + +function wout(){ + temp=${1//./\".\"} + key=${temp:1}\" + echo $key + value=$2 + jq "$key+=\"$value\"" $OUT | sponge $OUT +} + + +dig @8.8.8.8 +short www.google.com + +# DHCP +ip addr flush dev eth0 +PID_FILE=/var/run/dhclient.pid +if [ -f $PID_FILE ]; then + kill -9 $(cat $PID_FILE) || true + rm -f $PID_FILE +fi +dhclient -v eth0 + +echo "{}" > $OUT + +# Gen network +main_intf=$(ip route | grep '^default' | awk '{print $NF}') + +wout .network.main_intf $main_intf +wout .network.gateway $(ip route | head -n 1 | awk '{print $3}') +wout .network.ipv4 $(ip a show $main_intf | grep "inet " | awk '{print $2}') +wout .network.ipv6 $(ip a show $main_intf | grep inet6 | awk '{print $2}') +wout .network.ethmac $(cat /sys/class/net/$main_intf/address) + +wout .dns_response $(dig @$DNS_SERVER +short www.google.com | tail -1) +wout .ntp_offset $(ntpdate -q $NTP_SERVER | tail -1 | sed -E 's/.*offset ([-=0-9\.]*) sec/\1/') + +# INTERNET CONNECTION +google_com_response=$(curl -LI http://www.google.com -o /dev/null -w '%{http_code}\n' -s) +wout .network.internet $google_com_response + +# DHCP LEASE +while read pre name value; do + if [[ $pre != option ]]; then + continue; + fi + + wout .dhcp.$name $(echo "${value%;}" | tr -d '\"\\') + +done < <(grep -B 99 -m 1 "}" /var/lib/dhcp/dhclient.leases) + +cat $OUT \ No newline at end of file diff --git a/testing/test_baseline b/testing/test_baseline new file mode 100755 index 000000000..d7fc1e5c5 --- /dev/null +++ b/testing/test_baseline @@ -0,0 +1,73 @@ + +#!/bin/bash -e + +TESTRUN_OUT=/tmp/testrun.log + +# Setup requirements +sudo apt-get update +sudo apt-get install openvswitch-common openvswitch-switch tcpdump jq moreutils coreutils + +pip3 install pytest + +# Setup device network +sudo ip link add dev endev0a type veth peer name endev0b +sudo ip link set dev endev0a up +sudo ip link set dev endev0b up +sudo docker network create -d macvlan -o parent=endev0b endev0 + +# Start OVS +sudo /usr/share/openvswitch/scripts/ovs-ctl start + +# Fix due to ordering +sudo docker build ./net_orc/ -t test-run/base -f net_orc/network/modules/base/base.Dockerfile + +# Build Test Container +sudo docker build ./testing/docker/ci_baseline -t ci1 -f ./testing/docker/ci_baseline/Dockerfile + +cat <conf/system.json +{ + "network": { + "device_intf": "endev0a", + "internet_intf": "eth0" + }, + "log_level": "DEBUG" +} +EOF + +sudo cmd/install + +sudo cmd/start --single-intf > $TESTRUN_OUT 2>&1 & +TPID=$! + +# Time to wait for testrun to be ready +WAITING=600 +for i in `seq 1 $WAITING`; do + if [[ -n $(fgrep "Waiting for devices on the network" $TESTRUN_OUT) ]]; then + break + fi + + if [[ ! -d /proc/$TPID ]]; then + cat $TESTRUN_OUT + echo "error encountered starting test run" + exit 1 + fi + + sleep 1 +done + +if [[ $i -eq $WAITING ]]; then + cat $TESTRUN_OUT + echo "failed after waiting $WAITING seconds for test-run start" + exit 1 +fi + +# Load Test Container +sudo docker run --network=endev0 --cap-add=NET_ADMIN -v /tmp:/out --privileged ci1 + +echo "Done baseline test" + +more $TESTRUN_OUT + +pytest testing/ + +exit $? diff --git a/testing/test_baseline.py b/testing/test_baseline.py new file mode 100644 index 000000000..3ab30a7c0 --- /dev/null +++ b/testing/test_baseline.py @@ -0,0 +1,49 @@ +import json +import pytest +import re +import os + +NTP_SERVER = '10.10.10.5' +DNS_SERVER = '10.10.10.4' + +CI_BASELINE_OUT = '/tmp/testrun_ci.json' + +@pytest.fixture +def container_data(): + dir = os.path.dirname(os.path.abspath(__file__)) + with open(CI_BASELINE_OUT) as f: + return json.load(f) + +@pytest.fixture +def validator_results(): + dir = os.path.dirname(os.path.abspath(__file__)) + with open(os.path.join(dir, '../', 'runtime/validation/faux-dev/result.json')) as f: + return json.load(f) + +def test_internet_connectivity(container_data): + assert container_data['network']['internet'] == 200 + +def test_dhcp_ntp_option(container_data): + """ Check DHCP gives NTP server as option """ + assert container_data['dhcp']['ntp-servers'] == NTP_SERVER + +def test_dhcp_dns_option(container_data): + assert container_data['dhcp']['domain-name-servers'] == DNS_SERVER + +def test_assigned_ipv4_address(container_data): + assert int(container_data['network']['ipv4'].split('.')[-1][:-3]) > 10 + +def test_ntp_server_reachable(container_data): + assert not 'no servers' in container_data['ntp_offset'] + +def test_dns_server_reachable(container_data): + assert not 'no servers' in container_data['dns_response'] + +def test_dns_server_resolves(container_data): + assert re.match(r'[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}', + container_data['dns_response']) + +def test_validator_results_compliant(validator_results): + results = [True if x['result'] == 'compliant' else False + for x in validator_results['results']] + assert all(results) diff --git a/testing/test_pylint b/testing/test_pylint new file mode 100755 index 000000000..833961d94 --- /dev/null +++ b/testing/test_pylint @@ -0,0 +1,26 @@ +#!/bin/bash + +ERROR_LIMIT=2534 + +sudo cmd/install + +source venv/bin/activate +sudo pip3 install pylint + +files=$(find . -path ./venv -prune -o -name '*.py' -print) + +OUT=pylint.out + +rm -f $OUT && touch $OUT +pylint $files -ry --extension-pkg-allow-list=docker 2>/dev/null | tee -a $OUT + +new_errors=$(cat $OUT | grep "statements analysed." | awk '{print $1}') + +echo "$new_errors > $ERROR_LIMIT?" +if (( $new_errors > $ERROR_LIMIT)); then + echo new errors $new_errors > error limit $ERROR_LIMIT + echo failing .. + exit 1 +fi + +exit 0 From 4171e5f343149b5f49433c4155d4af41647b40e9 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Tue, 16 May 2023 17:27:18 +0100 Subject: [PATCH 010/400] Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot --- conf/system.json.example | 5 +- framework/device.py | 8 +- framework/testrun.py | 22 +- net_orc/python/src/listener.py | 31 +- net_orc/python/src/network_device.py | 9 + net_orc/python/src/network_event.py | 6 +- net_orc/python/src/network_orchestrator.py | 1298 +++++++++++--------- net_orc/python/src/network_runner.py | 85 +- net_orc/python/src/util.py | 49 +- test_orc/python/src/test_orchestrator.py | 2 +- 10 files changed, 811 insertions(+), 704 deletions(-) create mode 100644 net_orc/python/src/network_device.py diff --git a/conf/system.json.example b/conf/system.json.example index 2d4b737d0..ecf480104 100644 --- a/conf/system.json.example +++ b/conf/system.json.example @@ -3,5 +3,8 @@ "device_intf": "enx123456789123", "internet_intf": "enx123456789124" }, - "log_level": "INFO" + "log_level": "INFO", + "startup_timeout": 60, + "monitor_period": 300, + "runtime": 1200 } \ No newline at end of file diff --git a/framework/device.py b/framework/device.py index d41199612..c17dd8e3a 100644 --- a/framework/device.py +++ b/framework/device.py @@ -1,12 +1,12 @@ """Track device object information.""" from dataclasses import dataclass +from network_device import NetworkDevice @dataclass -class Device: +class Device(NetworkDevice): """Represents a physical device and it's configuration.""" - make: str - model: str - mac_addr: str + make: str = None + model: str = None test_modules: str = None diff --git a/framework/testrun.py b/framework/testrun.py index 55719d968..b9cb6a0e5 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -12,7 +12,6 @@ import signal import time import logger -from device import Device # Locate parent directory current_dir = os.path.dirname(os.path.realpath(__file__)) @@ -30,6 +29,8 @@ import test_orchestrator as test_orc # pylint: disable=wrong-import-position,import-outside-toplevel import network_orchestrator as net_orc # pylint: disable=wrong-import-position,import-outside-toplevel +from device import Device # pylint: disable=wrong-import-position,import-outside-toplevel + LOGGER = logger.get_logger('test_run') CONFIG_FILE = 'conf/system.json' EXAMPLE_CONFIG_FILE = 'conf/system.json.example' @@ -80,9 +81,11 @@ def start(self): else: self._start_network() self._test_orc.start() + self._net_orc.listener.register_callback( - self._device_discovered, - [NetworkEvent.DEVICE_DISCOVERED]) + self._device_stable, + [NetworkEvent.DEVICE_STABLE] + ) LOGGER.info("Waiting for devices on the network...") @@ -117,6 +120,10 @@ def _get_config_abs(self, config_file=None): return os.path.abspath(config_file) def _start_network(self): + # Load in local device configs to the network orchestrator + self._net_orc._devices = self._devices + + # Start the network orchestrator self._net_orc.start() def _run_tests(self, device): @@ -169,9 +176,12 @@ def _device_discovered(self, mac_addr): LOGGER.info( f'Discovered {device.make} {device.model} on the network') else: - device = Device(make=None, model=None, mac_addr=mac_addr) + device = Device(mac_addr=mac_addr) + self._devices.append(device) LOGGER.info( f'A new device has been discovered with mac address {mac_addr}') - # TODO: Pass device information to test orchestrator/runner - self._run_tests(device) + def _device_stable(self, mac_addr): + device = self.get_device(mac_addr) + LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') + self._test_orc.run_test_modules(device) diff --git a/net_orc/python/src/listener.py b/net_orc/python/src/listener.py index d07de4686..0323fd9f6 100644 --- a/net_orc/python/src/listener.py +++ b/net_orc/python/src/listener.py @@ -1,5 +1,6 @@ """Intercepts network traffic between network services and the device under test.""" +import threading from scapy.all import AsyncSniffer, DHCP, get_if_hwaddr import logger from network_event import NetworkEvent @@ -12,7 +13,6 @@ DHCP_ACK = 5 CONTAINER_MAC_PREFIX = '9a:02:57:1e:8f' - class Listener: """Methods to start and stop the network listener.""" @@ -47,22 +47,25 @@ def register_callback(self, callback, events=[]): # pylint: disable=dangerous-d } ) + def call_callback(self, net_event, *args): + for callback in self._callbacks: + if net_event in callback['events']: + callback_thread = threading.Thread(target=callback['callback'], name="Callback thread", args=args) + callback_thread.start() + def _packet_callback(self, packet): - # Ignore packets originating from our containers - if packet.src.startswith(CONTAINER_MAC_PREFIX) or packet.src == self._device_intf_mac: - return + # DHCP ACK callback + if DHCP in packet and self._get_dhcp_type(packet) == DHCP_ACK: + self.call_callback(NetworkEvent.DHCP_LEASE_ACK, packet) + # New device discovered callback if not packet.src is None and packet.src not in self._discovered_devices: - self._device_discovered(packet.src) + # Ignore packets originating from our containers + if packet.src.startswith(CONTAINER_MAC_PREFIX) or packet.src == self._device_intf_mac: + return + self._discovered_devices.append(packet.src) + self.call_callback(NetworkEvent.DEVICE_DISCOVERED, packet.src) def _get_dhcp_type(self, packet): - return packet[DHCP].options[0][1] - - def _device_discovered(self, mac_addr): - LOGGER.debug(f'Discovered device with address {mac_addr}') - self._discovered_devices.append(mac_addr) - - for callback in self._callbacks: - if NetworkEvent.DEVICE_DISCOVERED in callback['events']: - callback['callback'](mac_addr) + return packet[DHCP].options[0][1] \ No newline at end of file diff --git a/net_orc/python/src/network_device.py b/net_orc/python/src/network_device.py new file mode 100644 index 000000000..f54a273b6 --- /dev/null +++ b/net_orc/python/src/network_device.py @@ -0,0 +1,9 @@ +"""Track device object information.""" +from dataclasses import dataclass + +@dataclass +class NetworkDevice: + """Represents a physical device and it's configuration.""" + + mac_addr: str + ip_addr: str = None diff --git a/net_orc/python/src/network_event.py b/net_orc/python/src/network_event.py index c77dfa706..dc08cf892 100644 --- a/net_orc/python/src/network_event.py +++ b/net_orc/python/src/network_event.py @@ -3,8 +3,6 @@ class NetworkEvent(Enum): """All possible network events.""" - - ALL = 0 DEVICE_DISCOVERED = 1 - DHCP_LEASE_NEW = 2 - DHCP_LEASE_RENEWED = 3 + DEVICE_STABLE = 2 + DHCP_LEASE_ACK = 3 diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 56ae93c3f..690e974c2 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,611 +1,687 @@ -#!/usr/bin/env python3 - -import getpass -import ipaddress -import json -import os -import subprocess -import sys -import time -import threading - -import docker -from docker.types import Mount - -import logger -import util -from listener import Listener -from network_validator import NetworkValidator - -LOGGER = logger.get_logger("net_orc") -CONFIG_FILE = "conf/system.json" -EXAMPLE_CONFIG_FILE = "conf/system.json.example" -RUNTIME_DIR = "runtime/network" -NETWORK_MODULES_DIR = "network/modules" -NETWORK_MODULE_METADATA = "conf/module_config.json" -DEVICE_BRIDGE = "tr-d" -INTERNET_BRIDGE = "tr-c" -PRIVATE_DOCKER_NET = "tr-private-net" -CONTAINER_NAME = "network_orchestrator" -RUNTIME = 1500 - - -class NetworkOrchestrator: - """Manage and controls a virtual testing network.""" - - def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): - self._int_intf = None - self._dev_intf = None - self._single_intf = single_intf - - self.listener = None - - self._net_modules = [] - - self.validate = validate - - self.async_monitor = async_monitor - - self._path = os.path.dirname(os.path.dirname( - os.path.dirname(os.path.realpath(__file__)))) - - self.validator = NetworkValidator() - - self.network_config = NetworkConfig() - - self.load_config(config_file) - - def start(self): - """Start the network orchestrator.""" - - LOGGER.info("Starting Network Orchestrator") - # Get all components ready - self.load_network_modules() - - # Restore the network first if required - self.stop(kill=True) - - self.start_network() - - if self.async_monitor: - # Run the monitor method asynchronously to keep this method non-blocking - self._monitor_thread = threading.Thread( - target=self.monitor_network) - self._monitor_thread.daemon = True - self._monitor_thread.start() - else: - self.monitor_network() - - def start_network(self): - """Start the virtual testing network.""" - LOGGER.info("Starting network") - - self.build_network_modules() - self.create_net() - self.start_network_services() - - if self.validate: - # Start the validator after network is ready - self.validator.start() - - # Get network ready (via Network orchestrator) - LOGGER.info("Network is ready.") - - def stop(self, kill=False): - """Stop the network orchestrator.""" - self.stop_validator(kill=kill) - self.stop_network(kill=kill) - - def stop_validator(self, kill=False): - """Stop the network validator.""" - # Shutdown the validator - self.validator.stop(kill=kill) - - def stop_network(self, kill=False): - """Stop the virtual testing network.""" - # Shutdown network - self.stop_networking_services(kill=kill) - self.restore_net() - - def monitor_network(self): - # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) - time.sleep(RUNTIME) - - self.stop() - - def load_config(self,config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - self._config_file=os.path.join(self._path, CONFIG_FILE) - else: - # If defined, use as provided - self._config_file=config_file - - if not os.path.isfile(self._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) - - LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) - with open(self._config_file, encoding='UTF-8') as config_json_file: - config_json = json.load(config_json_file) - self.import_config(config_json) - - def import_config(self, json_config): - self._int_intf = json_config['network']['internet_intf'] - self._dev_intf = json_config['network']['device_intf'] - - def _check_network_services(self): - LOGGER.debug("Checking network modules...") - for net_module in self._net_modules: - if net_module.enable_container: - LOGGER.debug("Checking network module: " + - net_module.display_name) - success = self._ping(net_module) - if success: - LOGGER.debug(net_module.display_name + - " responded succesfully: " + str(success)) - else: - LOGGER.error(net_module.display_name + - " failed to respond to ping") - - def _ping(self, net_module): - host = net_module.net_config.ipv4_address - namespace = "tr-ctns-" + net_module.dir_name - cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) - success = util.run_command(cmd, output=False) - return success - - def _ci_pre_network_create(self): - """ Stores network properties to restore network after - network creation and flushes internet interface - """ - - self._ethmac = subprocess.check_output( - f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() - self._gateway = subprocess.check_output( - "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() - self._ipv4 = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._ipv6 = subprocess.check_output( - f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._brd = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() - - def _ci_post_network_create(self): - """ Restore network connection in CI environment """ - LOGGER.info("post cr") - util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") - util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") - util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") - util.run_command(f"ip addr flush dev {self._int_intf}") - util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") - util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") - util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") - util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") - util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") - util.run_command(f"dhclient {INTERNET_BRIDGE}") - util.run_command(f"ip route del default via 10.1.0.1") - util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") - - def _create_private_net(self): - client = docker.from_env() - try: - network = client.networks.get(PRIVATE_DOCKER_NET) - network.remove() - except docker.errors.NotFound: - pass - - # TODO: These should be made into variables - ipam_pool = docker.types.IPAMPool( - subnet='100.100.0.0/16', - iprange='100.100.100.0/24' - ) - - ipam_config = docker.types.IPAMConfig( - pool_configs=[ipam_pool] - ) - - client.networks.create( - PRIVATE_DOCKER_NET, - ipam=ipam_config, - internal=True, - check_duplicate=True, - driver="macvlan" - ) - - def create_net(self): - LOGGER.info("Creating baseline network") - - if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): - LOGGER.error("Configured interfaces are not ready for use. " + - "Ensure both interfaces are connected.") - sys.exit(1) - - if self._single_intf: - self._ci_pre_network_create() - - # Create data plane - util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) - - # Create control plane - util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) - - # Add external interfaces to data and control plane - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + self._dev_intf) - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + self._int_intf) - - # Enable forwarding of eapol packets - util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + - " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") - - # Remove IP from internet adapter - util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") - - # Set ports up - util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") - util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") - - if self._single_intf: - self._ci_post_network_create() - - self._create_private_net() - - self.listener = Listener(self._dev_intf) - self.listener.start_listener() - - def load_network_modules(self): - """Load network modules from module_config.json.""" - LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) - - loaded_modules = "Loaded the following network modules: " - net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) - - for module_dir in os.listdir(net_modules_dir): - - net_module = NetworkModule() - - # Load basic module information - - net_module_json = json.load(open(os.path.join( - self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) - - net_module.name = net_module_json['config']['meta']['name'] - net_module.display_name = net_module_json['config']['meta']['display_name'] - net_module.description = net_module_json['config']['meta']['description'] - net_module.dir = os.path.join( - self._path, net_modules_dir, module_dir) - net_module.dir_name = module_dir - net_module.build_file = module_dir + ".Dockerfile" - net_module.container_name = "tr-ct-" + net_module.dir_name - net_module.image_name = "test-run/" + net_module.dir_name - - # Attach folder mounts to network module - if "docker" in net_module_json['config']: - if "mounts" in net_module_json['config']['docker']: - for mount_point in net_module_json['config']['docker']['mounts']: - net_module.mounts.append(Mount( - target=mount_point['target'], - source=os.path.join( - os.getcwd(), mount_point['source']), - type='bind' - )) - - # Determine if this is a container or just an image/template - if "enable_container" in net_module_json['config']['docker']: - net_module.enable_container = net_module_json['config']['docker']['enable_container'] - - # Load network service networking configuration - if net_module.enable_container: - - net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] - net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] - - net_module.net_config.host = False if not "host" in net_module_json[ - 'config']['network'] else net_module_json['config']['network']['host'] - - net_module.net_config.ipv4_address = self.network_config.ipv4_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv4_network = self.network_config.ipv4_network - - net_module.net_config.ipv6_address = self.network_config.ipv6_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv6_network = self.network_config.ipv6_network - - loaded_modules += net_module.dir_name + " " - - self._net_modules.append(net_module) - - LOGGER.info(loaded_modules) - - def build_network_modules(self): - LOGGER.info("Building network modules...") - for net_module in self._net_modules: - self._build_module(net_module) - - def _build_module(self, net_module): - LOGGER.debug("Building network module " + net_module.dir_name) - client = docker.from_env() - client.images.build( - dockerfile=os.path.join(net_module.dir, net_module.build_file), - path=self._path, - forcerm=True, - tag="test-run/" + net_module.dir_name - ) - - def _get_network_module(self, name): - for net_module in self._net_modules: - if name == net_module.display_name: - return net_module - return None - - # Start the OVS network module - # This should always be called before loading all - # other modules to allow for a properly setup base - # network - def _start_ovs_module(self): - self._start_network_service(self._get_network_module("OVS")) - - def _start_network_service(self, net_module): - - LOGGER.debug("Starting net service " + net_module.display_name) - network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET - LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, - container name: {net_module.container_name}""") - try: - client = docker.from_env() - net_module.container = client.containers.run( - net_module.image_name, - auto_remove=True, - cap_add=["NET_ADMIN"], - name=net_module.container_name, - hostname=net_module.container_name, - network=PRIVATE_DOCKER_NET, - privileged=True, - detach=True, - mounts=net_module.mounts, - environment={"HOST_USER": getpass.getuser()} - ) - except docker.errors.ContainerError as error: - LOGGER.error("Container run error") - LOGGER.error(error) - - if network != "host": - self._attach_service_to_network(net_module) - - def _stop_service_module(self, net_module, kill=False): - LOGGER.debug("Stopping Service container " + net_module.container_name) - try: - container = self._get_service_container(net_module) - if container is not None: - if kill: - LOGGER.debug("Killing container:" + - net_module.container_name) - container.kill() - else: - LOGGER.debug("Stopping container:" + - net_module.container_name) - container.stop() - LOGGER.debug("Container stopped:" + net_module.container_name) - except Exception as error: - LOGGER.error("Container stop error") - LOGGER.error(error) - - def _get_service_container(self, net_module): - LOGGER.debug("Resolving service container: " + - net_module.container_name) - container = None - try: - client = docker.from_env() - container = client.containers.get(net_module.container_name) - except docker.errors.NotFound: - LOGGER.debug("Container " + - net_module.container_name + " not found") - except Exception as e: - LOGGER.error("Failed to resolve container") - LOGGER.error(e) - return container - - def stop_networking_services(self, kill=False): - LOGGER.info("Stopping network services") - for net_module in self._net_modules: - # Network modules may just be Docker images, so we do not want to stop them - if not net_module.enable_container: - continue - self._stop_service_module(net_module, kill) - - def start_network_services(self): - LOGGER.info("Starting network services") - - os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) - - for net_module in self._net_modules: - - # TODO: There should be a better way of doing this - # Do not try starting OVS module again, as it should already be running - if "OVS" != net_module.display_name: - - # Network modules may just be Docker images, so we do not want to start them as containers - if not net_module.enable_container: - continue - - self._start_network_service(net_module) - - LOGGER.info("All network services are running") - self._check_network_services() - - # TODO: Let's move this into a separate script? It does not look great - def _attach_service_to_network(self, net_module): - LOGGER.debug("Attaching net service " + - net_module.display_name + " to device bridge") - - # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) - bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Container network namespace name - container_net_ns = "tr-ctns-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Add bridge interface to device bridge - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + bridge_intf) - - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command( - "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] - - # Create symlink for container network namespace - util.run_command("ln -sf /proc/" + container_pid + - "/ns/net /var/run/netns/" + container_net_ns) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to veth0 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name veth0") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) - - # Set IP address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") - - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev veth0 up") - - if net_module.net_config.enable_wan: - LOGGER.debug("Attaching net service " + - net_module.display_name + " to internet bridge") - - # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) - bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Attach bridge interface to internet bridge - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + bridge_intf) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to eth1 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name eth1") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + - container_net_ns + " ip link set dev eth1 up") - - def restore_net(self): - - LOGGER.info("Clearing baseline network") - - if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): - self.listener.stop_listener() - - client = docker.from_env() - - # Stop all network containers if still running - for net_module in self._net_modules: - try: - container = client.containers.get( - "tr-ct-" + net_module.dir_name) - container.kill() - except Exception: - continue - - # Delete data plane - util.run_command("ovs-vsctl --if-exists del-br tr-d") - - # Delete control plane - util.run_command("ovs-vsctl --if-exists del-br tr-c") - - # Restart internet interface - if util.interface_exists(self._int_intf): - util.run_command("ip link set " + self._int_intf + " down") - util.run_command("ip link set " + self._int_intf + " up") - - LOGGER.info("Network is restored") - - -class NetworkModule: - - def __init__(self): - self.name = None - self.display_name = None - self.description = None - - self.container = None - self.container_name = None - self.image_name = None - - # Absolute path - self.dir = None - self.dir_name = None - self.build_file = None - self.mounts = [] - - self.enable_container = True - - self.net_config = NetworkModuleNetConfig() - -# The networking configuration for a network module - - -class NetworkModuleNetConfig: - - def __init__(self): - - self.enable_wan = False - - self.ip_index = 0 - self.ipv4_address = None - self.ipv4_network = None - self.ipv6_address = None - self.ipv6_network = None - - self.host = False - - def get_ipv4_addr_with_prefix(self): - return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) - - def get_ipv6_addr_with_prefix(self): - return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) - -# Represents the current configuration of the network for the device bridge - -class NetworkConfig: - - # TODO: Let's get this from a configuration file - def __init__(self): - self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') - self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') +#!/usr/bin/env python3 + +import binascii +import getpass +import ipaddress +import json +import os +from scapy.all import BOOTP +import subprocess +import sys +import time +import threading +from threading import Timer + +import docker +from docker.types import Mount + +import logger +import util +from listener import Listener +from network_device import NetworkDevice +from network_event import NetworkEvent +from network_validator import NetworkValidator + +LOGGER = logger.get_logger("net_orc") +CONFIG_FILE = "conf/system.json" +EXAMPLE_CONFIG_FILE = "conf/system.json.example" +RUNTIME_DIR = "runtime/network" +NETWORK_MODULES_DIR = "network/modules" +NETWORK_MODULE_METADATA = "conf/module_config.json" +DEVICE_BRIDGE = "tr-d" +INTERNET_BRIDGE = "tr-c" +PRIVATE_DOCKER_NET = "tr-private-net" +CONTAINER_NAME = "network_orchestrator" + +RUNTIME_KEY = "runtime" +MONITOR_PERIOD_KEY = "monitor_period" +STARTUP_TIMEOUT_KEY = "startup_timeout" +DEFAULT_STARTUP_TIMEOUT = 60 +DEFAULT_RUNTIME = 1200 +DEFAULT_MONITOR_PERIOD = 300 + +RUNTIME = 1500 + + +class NetworkOrchestrator: + """Manage and controls a virtual testing network.""" + + def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): + + self._runtime = DEFAULT_RUNTIME + self._startup_timeout = DEFAULT_STARTUP_TIMEOUT + self._monitor_period = DEFAULT_MONITOR_PERIOD + + self._int_intf = None + self._dev_intf = None + self._single_intf = single_intf + + self.listener = None + + self._net_modules = [] + + self.validate = validate + + self.async_monitor = async_monitor + + self._path = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.realpath(__file__)))) + + self.validator = NetworkValidator() + + self.network_config = NetworkConfig() + + self.load_config(config_file) + + def start(self): + """Start the network orchestrator.""" + + LOGGER.info("Starting Network Orchestrator") + # Get all components ready + self.load_network_modules() + + # Restore the network first if required + self.stop(kill=True) + + self.start_network() + + if self.async_monitor: + # Run the monitor method asynchronously to keep this method non-blocking + self._monitor_thread = threading.Thread( + target=self.monitor_network) + self._monitor_thread.daemon = True + self._monitor_thread.start() + else: + self.monitor_network() + + def start_network(self): + """Start the virtual testing network.""" + LOGGER.info("Starting network") + + self.build_network_modules() + self.create_net() + self.start_network_services() + + if self.validate: + # Start the validator after network is ready + self.validator.start() + + # Get network ready (via Network orchestrator) + LOGGER.info("Network is ready.") + + # Start the listener + self.listener = Listener(self._dev_intf) + self.listener.start_listener() + + def stop(self, kill=False): + """Stop the network orchestrator.""" + self.stop_validator(kill=kill) + self.stop_network(kill=kill) + + def stop_validator(self, kill=False): + """Stop the network validator.""" + # Shutdown the validator + self.validator.stop(kill=kill) + + def stop_network(self, kill=False): + """Stop the virtual testing network.""" + # Shutdown network + self.stop_networking_services(kill=kill) + self.restore_net() + + def monitor_network(self): + self.listener.register_callback(self._device_discovered, [ + NetworkEvent.DEVICE_DISCOVERED]) + self.listener.register_callback( + self._dhcp_lease_ack, [NetworkEvent.DHCP_LEASE_ACK]) + # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) + time.sleep(self._runtime) + + self.stop() + + def _device_discovered(self, mac_addr): + + LOGGER.debug(f'Discovered device {mac_addr}. Waiting for device to obtain IP') + device = self._get_device(mac_addr=mac_addr) + + timeout = time.time() + self._startup_timeout + + while time.time() < timeout: + if device.ip_addr is None: + time.sleep(3) + else: + break + + if device.ip_addr is None: + LOGGER.info(f"Timed out whilst waiting for {mac_addr} to obtain an IP address") + return + + LOGGER.info(f"Device with mac addr {device.mac_addr} has obtained IP address {device.ip_addr}") + + self._start_device_monitor(device) + + def _dhcp_lease_ack(self, packet): + mac_addr = packet[BOOTP].chaddr.hex(":")[0:17] + device = self._get_device(mac_addr=mac_addr) + device.ip_addr = packet[BOOTP].yiaddr + + def _start_device_monitor(self, device): + """Start a timer until the steady state has been reached and + callback the steady state method for this device.""" + LOGGER.info(f"Monitoring device with mac addr {device.mac_addr} for {str(self._monitor_period)} seconds") + timer = Timer(self._monitor_period, + self.listener.call_callback, + args=(NetworkEvent.DEVICE_STABLE, device.mac_addr,)) + timer.start() + + def _get_device(self, mac_addr): + for device in self._devices: + if device.mac_addr == mac_addr: + return device + device = NetworkDevice(mac_addr=mac_addr) + self._devices.append(device) + return device + + def load_config(self, config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + self._config_file = os.path.join(self._path, CONFIG_FILE) + else: + # If defined, use as provided + self._config_file = config_file + + if not os.path.isfile(self._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) + + LOGGER.info("Loading config file: " + + os.path.abspath(self._config_file)) + with open(self._config_file, encoding='UTF-8') as config_json_file: + config_json = json.load(config_json_file) + self.import_config(config_json) + + def import_config(self, json_config): + self._int_intf = json_config['network']['internet_intf'] + self._dev_intf = json_config['network']['device_intf'] + if RUNTIME_KEY in json_config: + self._runtime = json_config[RUNTIME_KEY] + if STARTUP_TIMEOUT_KEY in json_config: + self._startup_timeout = json_config[STARTUP_TIMEOUT_KEY] + if MONITOR_PERIOD_KEY in json_config: + self._monitor_period = json_config[MONITOR_PERIOD_KEY] + + def _check_network_services(self): + LOGGER.debug("Checking network modules...") + for net_module in self._net_modules: + if net_module.enable_container: + LOGGER.debug("Checking network module: " + + net_module.display_name) + success = self._ping(net_module) + if success: + LOGGER.debug(net_module.display_name + + " responded succesfully: " + str(success)) + else: + LOGGER.error(net_module.display_name + + " failed to respond to ping") + + def _ping(self, net_module): + host = net_module.net_config.ipv4_address + namespace = "tr-ctns-" + net_module.dir_name + cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) + success = util.run_command(cmd, output=False) + return success + + def _ci_pre_network_create(self): + """ Stores network properties to restore network after + network creation and flushes internet interface + """ + + self._ethmac = subprocess.check_output( + f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() + self._gateway = subprocess.check_output( + "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() + self._ipv4 = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._ipv6 = subprocess.check_output( + f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._brd = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() + + def _ci_post_network_create(self): + """ Restore network connection in CI environment """ + LOGGER.info("post cr") + util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") + util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") + util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") + util.run_command(f"ip addr flush dev {self._int_intf}") + util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") + util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") + util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") + util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") + util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") + util.run_command(f"dhclient {INTERNET_BRIDGE}") + util.run_command(f"ip route del default via 10.1.0.1") + util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") + + def _create_private_net(self): + client = docker.from_env() + try: + network = client.networks.get(PRIVATE_DOCKER_NET) + network.remove() + except docker.errors.NotFound: + pass + + # TODO: These should be made into variables + ipam_pool = docker.types.IPAMPool( + subnet='100.100.0.0/16', + iprange='100.100.100.0/24' + ) + + ipam_config = docker.types.IPAMConfig( + pool_configs=[ipam_pool] + ) + + client.networks.create( + PRIVATE_DOCKER_NET, + ipam=ipam_config, + internal=True, + check_duplicate=True, + driver="macvlan" + ) + + def create_net(self): + LOGGER.info("Creating baseline network") + + if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): + LOGGER.error("Configured interfaces are not ready for use. " + + "Ensure both interfaces are connected.") + sys.exit(1) + + if self._single_intf: + self._ci_pre_network_create() + + # Create data plane + util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) + + # Create control plane + util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) + + # Add external interfaces to data and control plane + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + self._dev_intf) + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + self._int_intf) + + # Enable forwarding of eapol packets + util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + + " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") + + # Remove IP from internet adapter + util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") + + # Set ports up + util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") + util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") + + if self._single_intf: + self._ci_post_network_create() + + self._create_private_net() + + self.listener = Listener(self._dev_intf) + self.listener.start_listener() + + def load_network_modules(self): + """Load network modules from module_config.json.""" + LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) + + loaded_modules = "Loaded the following network modules: " + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + for module_dir in os.listdir(net_modules_dir): + + net_module = NetworkModule() + + # Load basic module information + + net_module_json = json.load(open(os.path.join( + self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) + + net_module.name = net_module_json['config']['meta']['name'] + net_module.display_name = net_module_json['config']['meta']['display_name'] + net_module.description = net_module_json['config']['meta']['description'] + net_module.dir = os.path.join( + self._path, net_modules_dir, module_dir) + net_module.dir_name = module_dir + net_module.build_file = module_dir + ".Dockerfile" + net_module.container_name = "tr-ct-" + net_module.dir_name + net_module.image_name = "test-run/" + net_module.dir_name + + # Attach folder mounts to network module + if "docker" in net_module_json['config']: + if "mounts" in net_module_json['config']['docker']: + for mount_point in net_module_json['config']['docker']['mounts']: + net_module.mounts.append(Mount( + target=mount_point['target'], + source=os.path.join( + os.getcwd(), mount_point['source']), + type='bind' + )) + + # Determine if this is a container or just an image/template + if "enable_container" in net_module_json['config']['docker']: + net_module.enable_container = net_module_json['config']['docker']['enable_container'] + + # Load network service networking configuration + if net_module.enable_container: + + net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] + net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] + + net_module.net_config.host = False if not "host" in net_module_json[ + 'config']['network'] else net_module_json['config']['network']['host'] + + net_module.net_config.ipv4_address = self.network_config.ipv4_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv4_network = self.network_config.ipv4_network + + net_module.net_config.ipv6_address = self.network_config.ipv6_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv6_network = self.network_config.ipv6_network + + loaded_modules += net_module.dir_name + " " + + self._net_modules.append(net_module) + + LOGGER.info(loaded_modules) + + def build_network_modules(self): + LOGGER.info("Building network modules...") + for net_module in self._net_modules: + self._build_module(net_module) + + def _build_module(self, net_module): + LOGGER.debug("Building network module " + net_module.dir_name) + client = docker.from_env() + client.images.build( + dockerfile=os.path.join(net_module.dir, net_module.build_file), + path=self._path, + forcerm=True, + tag="test-run/" + net_module.dir_name + ) + + def _get_network_module(self, name): + for net_module in self._net_modules: + if name == net_module.display_name: + return net_module + return None + + # Start the OVS network module + # This should always be called before loading all + # other modules to allow for a properly setup base + # network + def _start_ovs_module(self): + self._start_network_service(self._get_network_module("OVS")) + + def _start_network_service(self, net_module): + + LOGGER.debug("Starting net service " + net_module.display_name) + network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET + LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, + container name: {net_module.container_name}""") + try: + client = docker.from_env() + net_module.container = client.containers.run( + net_module.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=net_module.container_name, + hostname=net_module.container_name, + network=PRIVATE_DOCKER_NET, + privileged=True, + detach=True, + mounts=net_module.mounts, + environment={"HOST_USER": getpass.getuser()} + ) + except docker.errors.ContainerError as error: + LOGGER.error("Container run error") + LOGGER.error(error) + + if network != "host": + self._attach_service_to_network(net_module) + + def _stop_service_module(self, net_module, kill=False): + LOGGER.debug("Stopping Service container " + net_module.container_name) + try: + container = self._get_service_container(net_module) + if container is not None: + if kill: + LOGGER.debug("Killing container:" + + net_module.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + + net_module.container_name) + container.stop() + LOGGER.debug("Container stopped:" + net_module.container_name) + except Exception as error: + LOGGER.error("Container stop error") + LOGGER.error(error) + + def _get_service_container(self, net_module): + LOGGER.debug("Resolving service container: " + + net_module.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_module.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + + net_module.container_name + " not found") + except Exception as e: + LOGGER.error("Failed to resolve container") + LOGGER.error(e) + return container + + def stop_networking_services(self, kill=False): + LOGGER.info("Stopping network services") + for net_module in self._net_modules: + # Network modules may just be Docker images, so we do not want to stop them + if not net_module.enable_container: + continue + self._stop_service_module(net_module, kill) + + def start_network_services(self): + LOGGER.info("Starting network services") + + os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) + + for net_module in self._net_modules: + + # TODO: There should be a better way of doing this + # Do not try starting OVS module again, as it should already be running + if "OVS" != net_module.display_name: + + # Network modules may just be Docker images, so we do not want to start them as containers + if not net_module.enable_container: + continue + + self._start_network_service(net_module) + + LOGGER.info("All network services are running") + self._check_network_services() + + # TODO: Let's move this into a separate script? It does not look great + def _attach_service_to_network(self, net_module): + LOGGER.debug("Attaching net service " + + net_module.display_name + " to device bridge") + + # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Container network namespace name + container_net_ns = "tr-ctns-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Add bridge interface to device bridge + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command( + "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] + + # Create symlink for container network namespace + util.run_command("ln -sf /proc/" + container_pid + + "/ns/net /var/run/netns/" + container_net_ns) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to veth0 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name veth0") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) + + # Set IP address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") + + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev veth0 up") + + if net_module.net_config.enable_wan: + LOGGER.debug("Attaching net service " + + net_module.display_name + " to internet bridge") + + # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) + bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Attach bridge interface to internet bridge + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + bridge_intf) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to eth1 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name eth1") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + + container_net_ns + " ip link set dev eth1 up") + + def restore_net(self): + + LOGGER.info("Clearing baseline network") + + if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): + self.listener.stop_listener() + + client = docker.from_env() + + # Stop all network containers if still running + for net_module in self._net_modules: + try: + container = client.containers.get( + "tr-ct-" + net_module.dir_name) + container.kill() + except Exception: + continue + + # Delete data plane + util.run_command("ovs-vsctl --if-exists del-br tr-d") + + # Delete control plane + util.run_command("ovs-vsctl --if-exists del-br tr-c") + + # Restart internet interface + if util.interface_exists(self._int_intf): + util.run_command("ip link set " + self._int_intf + " down") + util.run_command("ip link set " + self._int_intf + " up") + + LOGGER.info("Network is restored") + + +class NetworkModule: + + def __init__(self): + self.name = None + self.display_name = None + self.description = None + + self.container = None + self.container_name = None + self.image_name = None + + # Absolute path + self.dir = None + self.dir_name = None + self.build_file = None + self.mounts = [] + + self.enable_container = True + + self.net_config = NetworkModuleNetConfig() + +# The networking configuration for a network module + + +class NetworkModuleNetConfig: + + def __init__(self): + + self.enable_wan = False + + self.ip_index = 0 + self.ipv4_address = None + self.ipv4_network = None + self.ipv6_address = None + self.ipv6_network = None + + self.host = False + + def get_ipv4_addr_with_prefix(self): + return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) + + def get_ipv6_addr_with_prefix(self): + return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) + +# Represents the current configuration of the network for the device bridge + +class NetworkConfig: + + # TODO: Let's get this from a configuration file + def __init__(self): + self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') + self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') \ No newline at end of file diff --git a/net_orc/python/src/network_runner.py b/net_orc/python/src/network_runner.py index 3fe9e8a41..0b7573fb3 100644 --- a/net_orc/python/src/network_runner.py +++ b/net_orc/python/src/network_runner.py @@ -11,58 +11,59 @@ import argparse import signal import sys -import time - import logger - from network_orchestrator import NetworkOrchestrator -LOGGER = logger.get_logger('net_runner') +LOGGER = logger.get_logger("net_runner") class NetworkRunner: - def __init__(self, config_file=None, validate=True, async_monitor=False): - self._monitor_thread = None - self._register_exits() - self.net_orc = NetworkOrchestrator(config_file=config_file,validate=validate,async_monitor=async_monitor) + """Entry point to the Network Orchestrator.""" + + def __init__(self, config_file=None, validate=True, async_monitor=False): + self._monitor_thread = None + self._register_exits() + self.net_orc = NetworkOrchestrator(config_file=config_file, + validate=validate, + async_monitor=async_monitor) - 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 _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.") - # Kill all container services quickly - # If we're here, we want everything to stop immediately - # and don't care about a gracefully shutdown - self.stop(True) - sys.exit(1) + 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.") + # Kill all container services quickly + # If we're here, we want everything to stop immediately + # and don't care about a graceful shutdown + self.stop(True) + sys.exit(1) - def stop(self, kill=False): - self.net_orc.stop(kill) + def stop(self, kill=False): + self.net_orc.stop(kill) - def start(self): - self.net_orc.start() + def start(self): + self.net_orc.start() -def parse_args(argv): - parser = argparse.ArgumentParser(description="Test Run Help", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("--no-validate", action="store_true", - help="Turn off the validation of the network after network boot") - parser.add_argument("-f", "--config-file", default=None, - help="Define the configuration file for the Network Orchestrator") - parser.add_argument("-d", "--daemon", action="store_true", - help="Run the network monitor process in the background as a daemon thread") +def parse_args(): + parser = argparse.ArgumentParser(description="Test Run Help", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("--no-validate", action="store_true", + help="Turn off the validation of the network after network boot") + parser.add_argument("-f", "--config-file", default=None, + help="Define the configuration file for the Network Orchestrator") + parser.add_argument("-d", "--daemon", action="store_true", + help="Run the network monitor process in the background as a daemon thread") - args, unknown = parser.parse_known_args() - return args + args = parser.parse_known_args()[0] + return args if __name__ == "__main__": - args=parse_args(sys.argv) - runner = NetworkRunner(config_file=args.config_file, - validate=not args.no_validate, - async_monitor=args.daemon) - runner.start() \ No newline at end of file + arguments = parse_args() + runner = NetworkRunner(config_file=arguments.config_file, + validate=not arguments.no_validate, + async_monitor=arguments.daemon) + runner.start() diff --git a/net_orc/python/src/util.py b/net_orc/python/src/util.py index a5cfe205f..e4a4bd5fd 100644 --- a/net_orc/python/src/util.py +++ b/net_orc/python/src/util.py @@ -1,30 +1,37 @@ +"""Provides basic utilities for the network orchestrator.""" import subprocess import shlex import logger import netifaces +LOGGER = logger.get_logger("util") -# Runs a process at the os level -# By default, returns the standard output and error output -# If the caller sets optional output parameter to False, -# will only return a boolean result indicating if it was -# succesful in running the command. Failure is indicated -# by any return code from the process other than zero. def run_command(cmd, output=True): - success = False - LOGGER = logger.get_logger('util') - process = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE) - stdout, stderr = process.communicate() - if process.returncode !=0 and output: - err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) - LOGGER.error("Command Failed: " + cmd) - LOGGER.error("Error: " + err_msg) - else: - success = True - if output: - return stdout.strip().decode('utf-8'), stderr - else: - return success + """Runs a process at the os level + By default, returns the standard output and error output + If the caller sets optional output parameter to False, + will only return a boolean result indicating if it was + succesful in running the command. Failure is indicated + by any return code from the process other than zero.""" + + success = False + process = subprocess.Popen(shlex.split(cmd), + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + if process.returncode !=0 and output: + err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) + LOGGER.error("Command Failed: " + cmd) + LOGGER.error("Error: " + err_msg) + else: + success = True + if output: + return stdout.strip().decode("utf-8"), stderr + else: + return success def interface_exists(interface): - return interface in netifaces.interfaces() \ No newline at end of file + return interface in netifaces.interfaces() + +def prettify(mac_string): + return ':'.join('%02x' % ord(b) for b in mac_string) diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index ee5cc5b45..f9f906af5 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -44,7 +44,7 @@ def stop(self): def run_test_modules(self, device): """Iterates through each test module and starts the container.""" - LOGGER.info("Running test modules...") + LOGGER.info(f"Running test modules on device with mac addr {device.mac_addr}") for module in self._test_modules: self._run_test_module(module, device) LOGGER.info("All tests complete") From be829a3457b37484563441a064af989eb99d65fe Mon Sep 17 00:00:00 2001 From: J Boddey Date: Tue, 16 May 2023 20:13:45 +0100 Subject: [PATCH 011/400] Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot --- .../modules/dhcp-1/conf/module_config.json | 1 + .../modules/dhcp-2/conf/module_config.json | 1 + .../modules/dns/conf/module_config.json | 1 + .../modules/gateway/conf/module_config.json | 1 + .../modules/ntp/conf/module_config.json | 1 + .../modules/ovs/conf/module_config.json | 1 + .../modules/radius/conf/module_config.json | 1 + .../modules/template/conf/module_config.json | 1 + net_orc/python/src/network_orchestrator.py | 1307 ++++++++--------- .../modules/baseline/conf/module_config.json | 1 + test_orc/modules/dns/conf/module_config.json | 1 + test_orc/python/src/test_orchestrator.py | 89 +- 12 files changed, 682 insertions(+), 724 deletions(-) diff --git a/net_orc/network/modules/dhcp-1/conf/module_config.json b/net_orc/network/modules/dhcp-1/conf/module_config.json index 56d9aa271..4a41eee3f 100644 --- a/net_orc/network/modules/dhcp-1/conf/module_config.json +++ b/net_orc/network/modules/dhcp-1/conf/module_config.json @@ -14,6 +14,7 @@ "port": 5001 }, "docker": { + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/network/modules/dhcp-2/conf/module_config.json b/net_orc/network/modules/dhcp-2/conf/module_config.json index 2a978ca8c..bd719604d 100644 --- a/net_orc/network/modules/dhcp-2/conf/module_config.json +++ b/net_orc/network/modules/dhcp-2/conf/module_config.json @@ -14,6 +14,7 @@ "port": 5001 }, "docker": { + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/network/modules/dns/conf/module_config.json b/net_orc/network/modules/dns/conf/module_config.json index 73f890d28..cad1c02ef 100644 --- a/net_orc/network/modules/dns/conf/module_config.json +++ b/net_orc/network/modules/dns/conf/module_config.json @@ -11,6 +11,7 @@ "ip_index": 4 }, "docker": { + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/network/modules/gateway/conf/module_config.json b/net_orc/network/modules/gateway/conf/module_config.json index 35bd34392..5b39339ce 100644 --- a/net_orc/network/modules/gateway/conf/module_config.json +++ b/net_orc/network/modules/gateway/conf/module_config.json @@ -11,6 +11,7 @@ "ip_index": 1 }, "docker": { + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/network/modules/ntp/conf/module_config.json b/net_orc/network/modules/ntp/conf/module_config.json index 781521263..e3dbdc8f1 100644 --- a/net_orc/network/modules/ntp/conf/module_config.json +++ b/net_orc/network/modules/ntp/conf/module_config.json @@ -11,6 +11,7 @@ "ip_index": 5 }, "docker": { + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/network/modules/ovs/conf/module_config.json b/net_orc/network/modules/ovs/conf/module_config.json index f6a1eff50..8a440d0ae 100644 --- a/net_orc/network/modules/ovs/conf/module_config.json +++ b/net_orc/network/modules/ovs/conf/module_config.json @@ -12,6 +12,7 @@ "host": true }, "docker": { + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/network/modules/radius/conf/module_config.json b/net_orc/network/modules/radius/conf/module_config.json index 153d951df..ce8fbd52f 100644 --- a/net_orc/network/modules/radius/conf/module_config.json +++ b/net_orc/network/modules/radius/conf/module_config.json @@ -11,6 +11,7 @@ "ip_index": 7 }, "docker": { + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/network/modules/template/conf/module_config.json b/net_orc/network/modules/template/conf/module_config.json index bcea3808e..c767c9ad6 100644 --- a/net_orc/network/modules/template/conf/module_config.json +++ b/net_orc/network/modules/template/conf/module_config.json @@ -15,6 +15,7 @@ }, "docker": { "enable_container": false, + "depends_on": "base", "mounts": [ { "source": "runtime/network", diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 690e974c2..6930f22be 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,687 +1,620 @@ -#!/usr/bin/env python3 - -import binascii -import getpass -import ipaddress -import json -import os -from scapy.all import BOOTP -import subprocess -import sys -import time -import threading -from threading import Timer - -import docker -from docker.types import Mount - -import logger -import util -from listener import Listener -from network_device import NetworkDevice -from network_event import NetworkEvent -from network_validator import NetworkValidator - -LOGGER = logger.get_logger("net_orc") -CONFIG_FILE = "conf/system.json" -EXAMPLE_CONFIG_FILE = "conf/system.json.example" -RUNTIME_DIR = "runtime/network" -NETWORK_MODULES_DIR = "network/modules" -NETWORK_MODULE_METADATA = "conf/module_config.json" -DEVICE_BRIDGE = "tr-d" -INTERNET_BRIDGE = "tr-c" -PRIVATE_DOCKER_NET = "tr-private-net" -CONTAINER_NAME = "network_orchestrator" - -RUNTIME_KEY = "runtime" -MONITOR_PERIOD_KEY = "monitor_period" -STARTUP_TIMEOUT_KEY = "startup_timeout" -DEFAULT_STARTUP_TIMEOUT = 60 -DEFAULT_RUNTIME = 1200 -DEFAULT_MONITOR_PERIOD = 300 - -RUNTIME = 1500 - - -class NetworkOrchestrator: - """Manage and controls a virtual testing network.""" - - def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): - - self._runtime = DEFAULT_RUNTIME - self._startup_timeout = DEFAULT_STARTUP_TIMEOUT - self._monitor_period = DEFAULT_MONITOR_PERIOD - - self._int_intf = None - self._dev_intf = None - self._single_intf = single_intf - - self.listener = None - - self._net_modules = [] - - self.validate = validate - - self.async_monitor = async_monitor - - self._path = os.path.dirname(os.path.dirname( - os.path.dirname(os.path.realpath(__file__)))) - - self.validator = NetworkValidator() - - self.network_config = NetworkConfig() - - self.load_config(config_file) - - def start(self): - """Start the network orchestrator.""" - - LOGGER.info("Starting Network Orchestrator") - # Get all components ready - self.load_network_modules() - - # Restore the network first if required - self.stop(kill=True) - - self.start_network() - - if self.async_monitor: - # Run the monitor method asynchronously to keep this method non-blocking - self._monitor_thread = threading.Thread( - target=self.monitor_network) - self._monitor_thread.daemon = True - self._monitor_thread.start() - else: - self.monitor_network() - - def start_network(self): - """Start the virtual testing network.""" - LOGGER.info("Starting network") - - self.build_network_modules() - self.create_net() - self.start_network_services() - - if self.validate: - # Start the validator after network is ready - self.validator.start() - - # Get network ready (via Network orchestrator) - LOGGER.info("Network is ready.") - - # Start the listener - self.listener = Listener(self._dev_intf) - self.listener.start_listener() - - def stop(self, kill=False): - """Stop the network orchestrator.""" - self.stop_validator(kill=kill) - self.stop_network(kill=kill) - - def stop_validator(self, kill=False): - """Stop the network validator.""" - # Shutdown the validator - self.validator.stop(kill=kill) - - def stop_network(self, kill=False): - """Stop the virtual testing network.""" - # Shutdown network - self.stop_networking_services(kill=kill) - self.restore_net() - - def monitor_network(self): - self.listener.register_callback(self._device_discovered, [ - NetworkEvent.DEVICE_DISCOVERED]) - self.listener.register_callback( - self._dhcp_lease_ack, [NetworkEvent.DHCP_LEASE_ACK]) - # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) - time.sleep(self._runtime) - - self.stop() - - def _device_discovered(self, mac_addr): - - LOGGER.debug(f'Discovered device {mac_addr}. Waiting for device to obtain IP') - device = self._get_device(mac_addr=mac_addr) - - timeout = time.time() + self._startup_timeout - - while time.time() < timeout: - if device.ip_addr is None: - time.sleep(3) - else: - break - - if device.ip_addr is None: - LOGGER.info(f"Timed out whilst waiting for {mac_addr} to obtain an IP address") - return - - LOGGER.info(f"Device with mac addr {device.mac_addr} has obtained IP address {device.ip_addr}") - - self._start_device_monitor(device) - - def _dhcp_lease_ack(self, packet): - mac_addr = packet[BOOTP].chaddr.hex(":")[0:17] - device = self._get_device(mac_addr=mac_addr) - device.ip_addr = packet[BOOTP].yiaddr - - def _start_device_monitor(self, device): - """Start a timer until the steady state has been reached and - callback the steady state method for this device.""" - LOGGER.info(f"Monitoring device with mac addr {device.mac_addr} for {str(self._monitor_period)} seconds") - timer = Timer(self._monitor_period, - self.listener.call_callback, - args=(NetworkEvent.DEVICE_STABLE, device.mac_addr,)) - timer.start() - - def _get_device(self, mac_addr): - for device in self._devices: - if device.mac_addr == mac_addr: - return device - device = NetworkDevice(mac_addr=mac_addr) - self._devices.append(device) - return device - - def load_config(self, config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - self._config_file = os.path.join(self._path, CONFIG_FILE) - else: - # If defined, use as provided - self._config_file = config_file - - if not os.path.isfile(self._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) - - LOGGER.info("Loading config file: " + - os.path.abspath(self._config_file)) - with open(self._config_file, encoding='UTF-8') as config_json_file: - config_json = json.load(config_json_file) - self.import_config(config_json) - - def import_config(self, json_config): - self._int_intf = json_config['network']['internet_intf'] - self._dev_intf = json_config['network']['device_intf'] - if RUNTIME_KEY in json_config: - self._runtime = json_config[RUNTIME_KEY] - if STARTUP_TIMEOUT_KEY in json_config: - self._startup_timeout = json_config[STARTUP_TIMEOUT_KEY] - if MONITOR_PERIOD_KEY in json_config: - self._monitor_period = json_config[MONITOR_PERIOD_KEY] - - def _check_network_services(self): - LOGGER.debug("Checking network modules...") - for net_module in self._net_modules: - if net_module.enable_container: - LOGGER.debug("Checking network module: " + - net_module.display_name) - success = self._ping(net_module) - if success: - LOGGER.debug(net_module.display_name + - " responded succesfully: " + str(success)) - else: - LOGGER.error(net_module.display_name + - " failed to respond to ping") - - def _ping(self, net_module): - host = net_module.net_config.ipv4_address - namespace = "tr-ctns-" + net_module.dir_name - cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) - success = util.run_command(cmd, output=False) - return success - - def _ci_pre_network_create(self): - """ Stores network properties to restore network after - network creation and flushes internet interface - """ - - self._ethmac = subprocess.check_output( - f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() - self._gateway = subprocess.check_output( - "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() - self._ipv4 = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._ipv6 = subprocess.check_output( - f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._brd = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() - - def _ci_post_network_create(self): - """ Restore network connection in CI environment """ - LOGGER.info("post cr") - util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") - util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") - util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") - util.run_command(f"ip addr flush dev {self._int_intf}") - util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") - util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") - util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") - util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") - util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") - util.run_command(f"dhclient {INTERNET_BRIDGE}") - util.run_command(f"ip route del default via 10.1.0.1") - util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") - - def _create_private_net(self): - client = docker.from_env() - try: - network = client.networks.get(PRIVATE_DOCKER_NET) - network.remove() - except docker.errors.NotFound: - pass - - # TODO: These should be made into variables - ipam_pool = docker.types.IPAMPool( - subnet='100.100.0.0/16', - iprange='100.100.100.0/24' - ) - - ipam_config = docker.types.IPAMConfig( - pool_configs=[ipam_pool] - ) - - client.networks.create( - PRIVATE_DOCKER_NET, - ipam=ipam_config, - internal=True, - check_duplicate=True, - driver="macvlan" - ) - - def create_net(self): - LOGGER.info("Creating baseline network") - - if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): - LOGGER.error("Configured interfaces are not ready for use. " + - "Ensure both interfaces are connected.") - sys.exit(1) - - if self._single_intf: - self._ci_pre_network_create() - - # Create data plane - util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) - - # Create control plane - util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) - - # Add external interfaces to data and control plane - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + self._dev_intf) - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + self._int_intf) - - # Enable forwarding of eapol packets - util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + - " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") - - # Remove IP from internet adapter - util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") - - # Set ports up - util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") - util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") - - if self._single_intf: - self._ci_post_network_create() - - self._create_private_net() - - self.listener = Listener(self._dev_intf) - self.listener.start_listener() - - def load_network_modules(self): - """Load network modules from module_config.json.""" - LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) - - loaded_modules = "Loaded the following network modules: " - net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) - - for module_dir in os.listdir(net_modules_dir): - - net_module = NetworkModule() - - # Load basic module information - - net_module_json = json.load(open(os.path.join( - self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) - - net_module.name = net_module_json['config']['meta']['name'] - net_module.display_name = net_module_json['config']['meta']['display_name'] - net_module.description = net_module_json['config']['meta']['description'] - net_module.dir = os.path.join( - self._path, net_modules_dir, module_dir) - net_module.dir_name = module_dir - net_module.build_file = module_dir + ".Dockerfile" - net_module.container_name = "tr-ct-" + net_module.dir_name - net_module.image_name = "test-run/" + net_module.dir_name - - # Attach folder mounts to network module - if "docker" in net_module_json['config']: - if "mounts" in net_module_json['config']['docker']: - for mount_point in net_module_json['config']['docker']['mounts']: - net_module.mounts.append(Mount( - target=mount_point['target'], - source=os.path.join( - os.getcwd(), mount_point['source']), - type='bind' - )) - - # Determine if this is a container or just an image/template - if "enable_container" in net_module_json['config']['docker']: - net_module.enable_container = net_module_json['config']['docker']['enable_container'] - - # Load network service networking configuration - if net_module.enable_container: - - net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] - net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] - - net_module.net_config.host = False if not "host" in net_module_json[ - 'config']['network'] else net_module_json['config']['network']['host'] - - net_module.net_config.ipv4_address = self.network_config.ipv4_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv4_network = self.network_config.ipv4_network - - net_module.net_config.ipv6_address = self.network_config.ipv6_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv6_network = self.network_config.ipv6_network - - loaded_modules += net_module.dir_name + " " - - self._net_modules.append(net_module) - - LOGGER.info(loaded_modules) - - def build_network_modules(self): - LOGGER.info("Building network modules...") - for net_module in self._net_modules: - self._build_module(net_module) - - def _build_module(self, net_module): - LOGGER.debug("Building network module " + net_module.dir_name) - client = docker.from_env() - client.images.build( - dockerfile=os.path.join(net_module.dir, net_module.build_file), - path=self._path, - forcerm=True, - tag="test-run/" + net_module.dir_name - ) - - def _get_network_module(self, name): - for net_module in self._net_modules: - if name == net_module.display_name: - return net_module - return None - - # Start the OVS network module - # This should always be called before loading all - # other modules to allow for a properly setup base - # network - def _start_ovs_module(self): - self._start_network_service(self._get_network_module("OVS")) - - def _start_network_service(self, net_module): - - LOGGER.debug("Starting net service " + net_module.display_name) - network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET - LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, - container name: {net_module.container_name}""") - try: - client = docker.from_env() - net_module.container = client.containers.run( - net_module.image_name, - auto_remove=True, - cap_add=["NET_ADMIN"], - name=net_module.container_name, - hostname=net_module.container_name, - network=PRIVATE_DOCKER_NET, - privileged=True, - detach=True, - mounts=net_module.mounts, - environment={"HOST_USER": getpass.getuser()} - ) - except docker.errors.ContainerError as error: - LOGGER.error("Container run error") - LOGGER.error(error) - - if network != "host": - self._attach_service_to_network(net_module) - - def _stop_service_module(self, net_module, kill=False): - LOGGER.debug("Stopping Service container " + net_module.container_name) - try: - container = self._get_service_container(net_module) - if container is not None: - if kill: - LOGGER.debug("Killing container:" + - net_module.container_name) - container.kill() - else: - LOGGER.debug("Stopping container:" + - net_module.container_name) - container.stop() - LOGGER.debug("Container stopped:" + net_module.container_name) - except Exception as error: - LOGGER.error("Container stop error") - LOGGER.error(error) - - def _get_service_container(self, net_module): - LOGGER.debug("Resolving service container: " + - net_module.container_name) - container = None - try: - client = docker.from_env() - container = client.containers.get(net_module.container_name) - except docker.errors.NotFound: - LOGGER.debug("Container " + - net_module.container_name + " not found") - except Exception as e: - LOGGER.error("Failed to resolve container") - LOGGER.error(e) - return container - - def stop_networking_services(self, kill=False): - LOGGER.info("Stopping network services") - for net_module in self._net_modules: - # Network modules may just be Docker images, so we do not want to stop them - if not net_module.enable_container: - continue - self._stop_service_module(net_module, kill) - - def start_network_services(self): - LOGGER.info("Starting network services") - - os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) - - for net_module in self._net_modules: - - # TODO: There should be a better way of doing this - # Do not try starting OVS module again, as it should already be running - if "OVS" != net_module.display_name: - - # Network modules may just be Docker images, so we do not want to start them as containers - if not net_module.enable_container: - continue - - self._start_network_service(net_module) - - LOGGER.info("All network services are running") - self._check_network_services() - - # TODO: Let's move this into a separate script? It does not look great - def _attach_service_to_network(self, net_module): - LOGGER.debug("Attaching net service " + - net_module.display_name + " to device bridge") - - # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) - bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Container network namespace name - container_net_ns = "tr-ctns-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Add bridge interface to device bridge - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + bridge_intf) - - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command( - "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] - - # Create symlink for container network namespace - util.run_command("ln -sf /proc/" + container_pid + - "/ns/net /var/run/netns/" + container_net_ns) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to veth0 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name veth0") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) - - # Set IP address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") - - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev veth0 up") - - if net_module.net_config.enable_wan: - LOGGER.debug("Attaching net service " + - net_module.display_name + " to internet bridge") - - # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) - bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Attach bridge interface to internet bridge - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + bridge_intf) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to eth1 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name eth1") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + - container_net_ns + " ip link set dev eth1 up") - - def restore_net(self): - - LOGGER.info("Clearing baseline network") - - if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): - self.listener.stop_listener() - - client = docker.from_env() - - # Stop all network containers if still running - for net_module in self._net_modules: - try: - container = client.containers.get( - "tr-ct-" + net_module.dir_name) - container.kill() - except Exception: - continue - - # Delete data plane - util.run_command("ovs-vsctl --if-exists del-br tr-d") - - # Delete control plane - util.run_command("ovs-vsctl --if-exists del-br tr-c") - - # Restart internet interface - if util.interface_exists(self._int_intf): - util.run_command("ip link set " + self._int_intf + " down") - util.run_command("ip link set " + self._int_intf + " up") - - LOGGER.info("Network is restored") - - -class NetworkModule: - - def __init__(self): - self.name = None - self.display_name = None - self.description = None - - self.container = None - self.container_name = None - self.image_name = None - - # Absolute path - self.dir = None - self.dir_name = None - self.build_file = None - self.mounts = [] - - self.enable_container = True - - self.net_config = NetworkModuleNetConfig() - -# The networking configuration for a network module - - -class NetworkModuleNetConfig: - - def __init__(self): - - self.enable_wan = False - - self.ip_index = 0 - self.ipv4_address = None - self.ipv4_network = None - self.ipv6_address = None - self.ipv6_network = None - - self.host = False - - def get_ipv4_addr_with_prefix(self): - return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) - - def get_ipv6_addr_with_prefix(self): - return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) - -# Represents the current configuration of the network for the device bridge - -class NetworkConfig: - - # TODO: Let's get this from a configuration file - def __init__(self): - self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') - self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') \ No newline at end of file +#!/usr/bin/env python3 + +import getpass +import ipaddress +import json +import os +import subprocess +import sys +import time +import threading + +import docker +from docker.types import Mount + +import logger +import util +from listener import Listener +from network_validator import NetworkValidator + +LOGGER = logger.get_logger("net_orc") +CONFIG_FILE = "conf/system.json" +EXAMPLE_CONFIG_FILE = "conf/system.json.example" +RUNTIME_DIR = "runtime/network" +NETWORK_MODULES_DIR = "network/modules" +NETWORK_MODULE_METADATA = "conf/module_config.json" +DEVICE_BRIDGE = "tr-d" +INTERNET_BRIDGE = "tr-c" +PRIVATE_DOCKER_NET = "tr-private-net" +CONTAINER_NAME = "network_orchestrator" +RUNTIME = 300 + + +class NetworkOrchestrator: + """Manage and controls a virtual testing network.""" + + def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): + self._int_intf = None + self._dev_intf = None + self._single_intf = single_intf + self.listener = None + + self._net_modules = [] + + self.validate = validate + + self.async_monitor = async_monitor + + self._path = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.realpath(__file__)))) + + self.validator = NetworkValidator() + + self.network_config = NetworkConfig() + + self.load_config(config_file) + + def start(self): + """Start the network orchestrator.""" + + LOGGER.info("Starting Network Orchestrator") + # Get all components ready + self.load_network_modules() + + # Restore the network first if required + self.stop(kill=True) + + self.start_network() + + if self.async_monitor: + # Run the monitor method asynchronously to keep this method non-blocking + self._monitor_thread = threading.Thread( + target=self.monitor_network) + self._monitor_thread.daemon = True + self._monitor_thread.start() + else: + self.monitor_network() + + def start_network(self): + """Start the virtual testing network.""" + LOGGER.info("Starting network") + + self.build_network_modules() + self.create_net() + self.start_network_services() + + if self.validate: + # Start the validator after network is ready + self.validator.start() + + # Get network ready (via Network orchestrator) + LOGGER.info("Network is ready.") + + def stop(self, kill=False): + """Stop the network orchestrator.""" + self.stop_validator(kill=kill) + self.stop_network(kill=kill) + + def stop_validator(self, kill=False): + """Stop the network validator.""" + # Shutdown the validator + self.validator.stop(kill=kill) + + def stop_network(self, kill=False): + """Stop the virtual testing network.""" + # Shutdown network + self.stop_networking_services(kill=kill) + self.restore_net() + + def monitor_network(self): + # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) + time.sleep(RUNTIME) + + self.stop() + + def load_config(self,config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + self._config_file=os.path.join(self._path, CONFIG_FILE) + else: + # If defined, use as provided + self._config_file=config_file + + if not os.path.isfile(self._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) + + LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) + with open(self._config_file, encoding='UTF-8') as config_json_file: + config_json = json.load(config_json_file) + self.import_config(config_json) + + def import_config(self, json_config): + self._int_intf = json_config['network']['internet_intf'] + self._dev_intf = json_config['network']['device_intf'] + + def _check_network_services(self): + LOGGER.debug("Checking network modules...") + for net_module in self._net_modules: + if net_module.enable_container: + LOGGER.debug("Checking network module: " + + net_module.display_name) + success = self._ping(net_module) + if success: + LOGGER.debug(net_module.display_name + + " responded succesfully: " + str(success)) + else: + LOGGER.error(net_module.display_name + + " failed to respond to ping") + + def _ping(self, net_module): + host = net_module.net_config.ipv4_address + namespace = "tr-ctns-" + net_module.dir_name + cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) + success = util.run_command(cmd, output=False) + return success + + def _create_private_net(self): + client = docker.from_env() + try: + network = client.networks.get(PRIVATE_DOCKER_NET) + network.remove() + except docker.errors.NotFound: + pass + + # TODO: These should be made into variables + ipam_pool = docker.types.IPAMPool( + subnet='100.100.0.0/16', + iprange='100.100.100.0/24' + ) + + ipam_config = docker.types.IPAMConfig( + pool_configs=[ipam_pool] + ) + + client.networks.create( + PRIVATE_DOCKER_NET, + ipam=ipam_config, + internal=True, + check_duplicate=True, + driver="macvlan" + ) + + def _ci_pre_network_create(self): + """ Stores network properties to restore network after + network creation and flushes internet interface + """ + + self._ethmac = subprocess.check_output( + f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() + self._gateway = subprocess.check_output( + "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() + self._ipv4 = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._ipv6 = subprocess.check_output( + f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._brd = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() + + def _ci_post_network_create(self): + """ Restore network connection in CI environment """ + LOGGER.info("post cr") + util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") + util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") + util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") + util.run_command(f"ip addr flush dev {self._int_intf}") + util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") + util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") + util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") + util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") + util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") + util.run_command(f"dhclient {INTERNET_BRIDGE}") + util.run_command(f"ip route del default via 10.1.0.1") + util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") + + def create_net(self): + LOGGER.info("Creating baseline network") + + if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): + LOGGER.error("Configured interfaces are not ready for use. " + + "Ensure both interfaces are connected.") + sys.exit(1) + + if self._single_intf: + self._ci_pre_network_create() + + # Create data plane + util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) + + # Create control plane + util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) + + # Add external interfaces to data and control plane + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + self._dev_intf) + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + self._int_intf) + + # Enable forwarding of eapol packets + util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + + " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") + + # Remove IP from internet adapter + util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") + + # Set ports up + util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") + util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") + + if self._single_intf: + self._ci_post_network_create() + + self._create_private_net() + + self.listener = Listener(self._dev_intf) + self.listener.start_listener() + + def load_network_modules(self): + """Load network modules from module_config.json.""" + LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) + + loaded_modules = "Loaded the following network modules: " + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + for module_dir in os.listdir(net_modules_dir): + + if self._get_network_module(module_dir) is None: + loaded_module = self._load_network_module(module_dir) + loaded_modules += loaded_module.dir_name + " " + + LOGGER.info(loaded_modules) + + def _load_network_module(self, module_dir): + + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + net_module = NetworkModule() + + # Load basic module information + net_module_json = json.load(open(os.path.join( + self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) + + net_module.name = net_module_json['config']['meta']['name'] + net_module.display_name = net_module_json['config']['meta']['display_name'] + net_module.description = net_module_json['config']['meta']['description'] + net_module.dir = os.path.join( + self._path, net_modules_dir, module_dir) + net_module.dir_name = module_dir + net_module.build_file = module_dir + ".Dockerfile" + net_module.container_name = "tr-ct-" + net_module.dir_name + net_module.image_name = "test-run/" + net_module.dir_name + + # Attach folder mounts to network module + if "docker" in net_module_json['config']: + + if "mounts" in net_module_json['config']['docker']: + for mount_point in net_module_json['config']['docker']['mounts']: + net_module.mounts.append(Mount( + target=mount_point['target'], + source=os.path.join( + os.getcwd(), mount_point['source']), + type='bind' + )) + + if "depends_on" in net_module_json['config']['docker']: + depends_on_module = net_module_json['config']['docker']['depends_on'] + if self._get_network_module(depends_on_module) is None: + self._load_network_module(depends_on_module) + + # Determine if this is a container or just an image/template + if "enable_container" in net_module_json['config']['docker']: + net_module.enable_container = net_module_json['config']['docker']['enable_container'] + + # Load network service networking configuration + if net_module.enable_container: + + net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] + net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] + + net_module.net_config.host = False if not "host" in net_module_json[ + 'config']['network'] else net_module_json['config']['network']['host'] + + net_module.net_config.ipv4_address = self.network_config.ipv4_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv4_network = self.network_config.ipv4_network + + net_module.net_config.ipv6_address = self.network_config.ipv6_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv6_network = self.network_config.ipv6_network + + self._net_modules.append(net_module) + return net_module + + def build_network_modules(self): + LOGGER.info("Building network modules...") + for net_module in self._net_modules: + self._build_module(net_module) + + def _build_module(self, net_module): + LOGGER.debug("Building network module " + net_module.dir_name) + client = docker.from_env() + client.images.build( + dockerfile=os.path.join(net_module.dir, net_module.build_file), + path=self._path, + forcerm=True, + tag="test-run/" + net_module.dir_name + ) + + def _get_network_module(self, name): + for net_module in self._net_modules: + if name == net_module.display_name or name == net_module.name or name == net_module.dir_name: + return net_module + return None + + # Start the OVS network module + # This should always be called before loading all + # other modules to allow for a properly setup base + # network + def _start_ovs_module(self): + self._start_network_service(self._get_network_module("OVS")) + + def _start_network_service(self, net_module): + + LOGGER.debug("Starting net service " + net_module.display_name) + network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET + LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, + container name: {net_module.container_name}""") + try: + client = docker.from_env() + net_module.container = client.containers.run( + net_module.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=net_module.container_name, + hostname=net_module.container_name, + network=PRIVATE_DOCKER_NET, + privileged=True, + detach=True, + mounts=net_module.mounts, + environment={"HOST_USER": getpass.getuser()} + ) + except docker.errors.ContainerError as error: + LOGGER.error("Container run error") + LOGGER.error(error) + + if network != "host": + self._attach_service_to_network(net_module) + + def _stop_service_module(self, net_module, kill=False): + LOGGER.debug("Stopping Service container " + net_module.container_name) + try: + container = self._get_service_container(net_module) + if container is not None: + if kill: + LOGGER.debug("Killing container:" + + net_module.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + + net_module.container_name) + container.stop() + LOGGER.debug("Container stopped:" + net_module.container_name) + except Exception as error: + LOGGER.error("Container stop error") + LOGGER.error(error) + + def _get_service_container(self, net_module): + LOGGER.debug("Resolving service container: " + + net_module.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_module.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + + net_module.container_name + " not found") + except Exception as e: + LOGGER.error("Failed to resolve container") + LOGGER.error(e) + return container + + def stop_networking_services(self, kill=False): + LOGGER.info("Stopping network services") + for net_module in self._net_modules: + # Network modules may just be Docker images, so we do not want to stop them + if not net_module.enable_container: + continue + self._stop_service_module(net_module, kill) + + def start_network_services(self): + LOGGER.info("Starting network services") + + os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) + + for net_module in self._net_modules: + + # TODO: There should be a better way of doing this + # Do not try starting OVS module again, as it should already be running + if "OVS" != net_module.display_name: + + # Network modules may just be Docker images, so we do not want to start them as containers + if not net_module.enable_container: + continue + + self._start_network_service(net_module) + + LOGGER.info("All network services are running") + self._check_network_services() + + # TODO: Let's move this into a separate script? It does not look great + def _attach_service_to_network(self, net_module): + LOGGER.debug("Attaching net service " + + net_module.display_name + " to device bridge") + + # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Container network namespace name + container_net_ns = "tr-ctns-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Add bridge interface to device bridge + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command( + "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] + + # Create symlink for container network namespace + util.run_command("ln -sf /proc/" + container_pid + + "/ns/net /var/run/netns/" + container_net_ns) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to veth0 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name veth0") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) + + # Set IP address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") + + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev veth0 up") + + if net_module.net_config.enable_wan: + LOGGER.debug("Attaching net service " + + net_module.display_name + " to internet bridge") + + # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) + bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Attach bridge interface to internet bridge + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + bridge_intf) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to eth1 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name eth1") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + + container_net_ns + " ip link set dev eth1 up") + + def restore_net(self): + + LOGGER.info("Clearing baseline network") + + if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): + self.listener.stop_listener() + + client = docker.from_env() + + # Stop all network containers if still running + for net_module in self._net_modules: + try: + container = client.containers.get( + "tr-ct-" + net_module.dir_name) + container.kill() + except Exception: + continue + + # Delete data plane + util.run_command("ovs-vsctl --if-exists del-br tr-d") + + # Delete control plane + util.run_command("ovs-vsctl --if-exists del-br tr-c") + + # Restart internet interface + if util.interface_exists(self._int_intf): + util.run_command("ip link set " + self._int_intf + " down") + util.run_command("ip link set " + self._int_intf + " up") + + LOGGER.info("Network is restored") + +class NetworkModule: + + def __init__(self): + self.name = None + self.display_name = None + self.description = None + + self.container = None + self.container_name = None + self.image_name = None + + # Absolute path + self.dir = None + self.dir_name = None + self.build_file = None + self.mounts = [] + + self.enable_container = True + + self.net_config = NetworkModuleNetConfig() + +# The networking configuration for a network module + +class NetworkModuleNetConfig: + + def __init__(self): + + self.enable_wan = False + + self.ip_index = 0 + self.ipv4_address = None + self.ipv4_network = None + self.ipv6_address = None + self.ipv6_network = None + + self.host = False + + def get_ipv4_addr_with_prefix(self): + return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) + + def get_ipv6_addr_with_prefix(self): + return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) + +# Represents the current configuration of the network for the device bridge + +class NetworkConfig: + + # TODO: Let's get this from a configuration file + def __init__(self): + self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') + self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') diff --git a/test_orc/modules/baseline/conf/module_config.json b/test_orc/modules/baseline/conf/module_config.json index ba337267a..4c0cd08d8 100644 --- a/test_orc/modules/baseline/conf/module_config.json +++ b/test_orc/modules/baseline/conf/module_config.json @@ -7,6 +7,7 @@ }, "network": false, "docker": { + "depends_on": "base", "enable_container": true, "timeout": 30 }, diff --git a/test_orc/modules/dns/conf/module_config.json b/test_orc/modules/dns/conf/module_config.json index d21f6bca6..b8ff36c97 100644 --- a/test_orc/modules/dns/conf/module_config.json +++ b/test_orc/modules/dns/conf/module_config.json @@ -7,6 +7,7 @@ }, "network": false, "docker": { + "depends_on": "base", "enable_container": true, "timeout": 30 }, diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index f9f906af5..c257cd901 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -114,6 +114,12 @@ def _get_module_status(self, module): return container.status return None + def _get_test_module(self, name): + for test_module in self._test_modules: + if name == test_module.display_name or name == test_module.name or name == test_module.dir_name: + return test_module + return None + def _get_module_container(self, module): container = None try: @@ -128,49 +134,58 @@ def _get_module_container(self, module): return container def _load_test_modules(self): - """Import module configuration from module_config.json.""" - - modules_dir = os.path.join(self._path, TEST_MODULES_DIR) - - LOGGER.debug("Loading test modules from /" + modules_dir) + """Load network modules from module_config.json.""" + LOGGER.debug("Loading test modules from /" + TEST_MODULES_DIR) + loaded_modules = "Loaded the following test modules: " + test_modules_dir = os.path.join(self._path, TEST_MODULES_DIR) + + for module_dir in os.listdir(test_modules_dir): - for module_dir in os.listdir(modules_dir): - - LOGGER.debug("Loading module from: " + module_dir) + if self._get_test_module(module_dir) is None: + loaded_module = self._load_test_module(module_dir) + loaded_modules += loaded_module.dir_name + " " - # Load basic module information - module = TestModule() - with open(os.path.join( - self._path, - modules_dir, - module_dir, - MODULE_CONFIG), - encoding='UTF-8') as module_config_file: - module_json = json.load(module_config_file) - - module.name = module_json['config']['meta']['name'] - module.display_name = module_json['config']['meta']['display_name'] - module.description = module_json['config']['meta']['description'] - module.dir = os.path.join(self._path, modules_dir, module_dir) - module.dir_name = module_dir - module.build_file = module_dir + ".Dockerfile" - module.container_name = "tr-ct-" + module.dir_name + "-test" - module.image_name = "test-run/" + module.dir_name + "-test" - - if 'timeout' in module_json['config']['docker']: - module.timeout = module_json['config']['docker']['timeout'] - - # Determine if this is a container or just an image/template - if "enable_container" in module_json['config']['docker']: - module.enable_container = module_json['config']['docker']['enable_container'] + LOGGER.info(loaded_modules) - self._test_modules.append(module) + def _load_test_module(self,module_dir): + """Import module configuration from module_config.json.""" - if module.enable_container: - loaded_modules += module.dir_name + " " + modules_dir = os.path.join(self._path, TEST_MODULES_DIR) - LOGGER.info(loaded_modules) + # Load basic module information + module = TestModule() + with open(os.path.join( + self._path, + modules_dir, + module_dir, + MODULE_CONFIG), + encoding='UTF-8') as module_config_file: + module_json = json.load(module_config_file) + + module.name = module_json['config']['meta']['name'] + module.display_name = module_json['config']['meta']['display_name'] + module.description = module_json['config']['meta']['description'] + module.dir = os.path.join(self._path, modules_dir, module_dir) + module.dir_name = module_dir + module.build_file = module_dir + ".Dockerfile" + module.container_name = "tr-ct-" + module.dir_name + "-test" + module.image_name = "test-run/" + module.dir_name + "-test" + + if 'timeout' in module_json['config']['docker']: + module.timeout = module_json['config']['docker']['timeout'] + + # Determine if this is a container or just an image/template + if "enable_container" in module_json['config']['docker']: + module.enable_container = module_json['config']['docker']['enable_container'] + + if "depends_on" in module_json['config']['docker']: + depends_on_module = module_json['config']['docker']['depends_on'] + if self._get_test_module(depends_on_module) is None: + self._load_test_module(depends_on_module) + + self._test_modules.append(module) + return module def build_test_modules(self): """Build all test modules.""" From 84d9ff992afe59032f1b05f0c054def9d083f028 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Wed, 17 May 2023 02:06:25 -0700 Subject: [PATCH 012/400] Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues --- cmd/install | 2 + framework/device.py | 26 +- framework/testrun.py | 208 +-- net_orc/python/src/network_orchestrator.py | 1374 +++++++++-------- resources/devices/Template/device_config.json | 115 ++ test_orc/modules/base/base.Dockerfile | 2 +- test_orc/modules/base/bin/get_ipv4_addr | 8 + .../modules/base/python/src/test_module.py | 28 +- test_orc/modules/base/python/src/util.py | 25 + test_orc/modules/nmap/bin/start_test_module | 42 + test_orc/modules/nmap/conf/module_config.json | 176 +++ test_orc/modules/nmap/nmap.Dockerfile | 11 + .../modules/nmap/python/src/nmap_module.py | 227 +++ test_orc/modules/nmap/python/src/run.py | 48 + test_orc/python/src/module.py | 4 + test_orc/python/src/test_orchestrator.py | 12 +- 16 files changed, 1566 insertions(+), 742 deletions(-) create mode 100644 test_orc/modules/base/bin/get_ipv4_addr create mode 100644 test_orc/modules/base/python/src/util.py create mode 100644 test_orc/modules/nmap/bin/start_test_module create mode 100644 test_orc/modules/nmap/conf/module_config.json create mode 100644 test_orc/modules/nmap/nmap.Dockerfile create mode 100644 test_orc/modules/nmap/python/src/nmap_module.py create mode 100644 test_orc/modules/nmap/python/src/run.py diff --git a/cmd/install b/cmd/install index 23e463158..f5af3a5d3 100755 --- a/cmd/install +++ b/cmd/install @@ -4,6 +4,8 @@ python3 -m venv venv source venv/bin/activate +pip3 install --upgrade requests + pip3 install -r framework/requirements.txt pip3 install -r net_orc/python/requirements.txt diff --git a/framework/device.py b/framework/device.py index c17dd8e3a..74d62d495 100644 --- a/framework/device.py +++ b/framework/device.py @@ -1,12 +1,14 @@ -"""Track device object information.""" -from dataclasses import dataclass -from network_device import NetworkDevice - - -@dataclass -class Device(NetworkDevice): - """Represents a physical device and it's configuration.""" - - make: str = None - model: str = None - test_modules: str = None +"""Track device object information.""" + +from network_device import NetworkDevice +from dataclasses import dataclass + + +@dataclass +class Device(NetworkDevice): + """Represents a physical device and it's configuration.""" + + make: str = None + model: str = None + mac_addr: str + test_modules: str = None diff --git a/framework/testrun.py b/framework/testrun.py index b9cb6a0e5..44c3bca6d 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -46,142 +46,142 @@ class TestRun: # pylint: disable=too-few-public-methods - """Test Run controller. + """Test Run controller. - Creates an instance of the network orchestrator, test - orchestrator and user interface. - """ + Creates an instance of the network orchestrator, test + orchestrator and user interface. + """ - def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False, single_intf=False): - self._devices = [] - self._net_only = net_only - self._single_intf = single_intf + def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False, single_intf=False): + self._devices = [] + self._net_only = net_only + self._single_intf = single_intf - # Catch any exit signals - self._register_exits() + # Catch any exit signals + self._register_exits() - # Expand the config file to absolute pathing - config_file_abs = self._get_config_abs(config_file=config_file) + # Expand the config file to absolute pathing + config_file_abs = self._get_config_abs(config_file=config_file) - self._net_orc = net_orc.NetworkOrchestrator( - config_file=config_file_abs, - validate=validate, - async_monitor=not self._net_only, - single_intf = self._single_intf) - self._test_orc = test_orc.TestOrchestrator() + self._net_orc = net_orc.NetworkOrchestrator( + config_file=config_file_abs, + validate=validate, + async_monitor=not self._net_only, + single_intf = self._single_intf) + self._test_orc = test_orc.TestOrchestrator(self._net_orc) - def start(self): + def start(self): - self._load_all_devices() + self._load_all_devices() - if self._net_only: - LOGGER.info( - "Network only option configured, no tests will be run") - self._start_network() - else: - self._start_network() - self._test_orc.start() - self._net_orc.listener.register_callback( + if self._net_only: + LOGGER.info("Network only option configured, no tests will be run") + self._start_network() + else: + self._start_network() + self._test_orc.start() + + self._net_orc.listener.register_callback( self._device_stable, [NetworkEvent.DEVICE_STABLE] ) - LOGGER.info("Waiting for devices on the network...") + LOGGER.info("Waiting for devices on the network...") - # Check timeout and whether testing is currently in progress before stopping - time.sleep(RUNTIME) + # Check timeout and whether testing is currently in progress before stopping + time.sleep(RUNTIME) - self.stop() + self.stop() - def stop(self, kill=False): - self._stop_tests() - self._stop_network(kill=kill) + def stop(self, kill=False): + self._stop_tests() + self._stop_network(kill=kill) - 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 _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(kill=True) - sys.exit(1) + 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(kill=True) + sys.exit(1) - def _get_config_abs(self, config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - config_file = os.path.join(parent_dir, CONFIG_FILE) + def _get_config_abs(self, config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + config_file = os.path.join(parent_dir, CONFIG_FILE) - # Expand the config file to absolute pathing - return os.path.abspath(config_file) + # Expand the config file to absolute pathing + return os.path.abspath(config_file) - def _start_network(self): - # Load in local device configs to the network orchestrator - self._net_orc._devices = self._devices + def _start_network(self): + # Load in local device configs to the network orchestrator + self._net_orc._devices = self._devices - # Start the network orchestrator - self._net_orc.start() + # Start the network orchestrator + self._net_orc.start() - def _run_tests(self, device): - """Iterate through and start all test modules.""" + def _run_tests(self, device): + """Iterate through and start all test modules.""" - # TODO: Make this configurable - time.sleep(60) # Let device bootup + # To Do: Make this configurable + time.sleep(60) # Let device bootup - self._test_orc.run_test_modules(device) + self._test_orc._run_test_modules(device) - def _stop_network(self, kill=False): - self._net_orc.stop(kill=kill) + def _stop_network(self, kill=False): + self._net_orc.stop(kill=kill) - def _stop_tests(self): - self._test_orc.stop() + def _stop_tests(self): + self._test_orc.stop() - def _load_all_devices(self): - self._load_devices(device_dir=LOCAL_DEVICES_DIR) - LOGGER.info('Loaded ' + str(len(self._devices)) + ' devices') + def _load_all_devices(self): + self._load_devices(device_dir=LOCAL_DEVICES_DIR) + self._load_devices(device_dir=RESOURCE_DEVICES_DIR) - def _load_devices(self, device_dir): - LOGGER.debug('Loading devices from ' + device_dir) + def _load_devices(self, device_dir): + LOGGER.debug('Loading devices from ' + device_dir) - os.makedirs(device_dir, exist_ok=True) + os.makedirs(device_dir, exist_ok=True) - for device_folder in os.listdir(device_dir): - with open(os.path.join(device_dir, device_folder, DEVICE_CONFIG), - encoding='utf-8') as device_config_file: - device_config_json = json.load(device_config_file) + for device_folder in os.listdir(device_dir): + with open(os.path.join(device_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) - test_modules = device_config_json.get(DEVICE_TEST_MODULES) + 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) + test_modules = device_config_json.get(DEVICE_TEST_MODULES) - device = Device(make=device_make, model=device_model, - mac_addr=mac_addr, test_modules=json.dumps(test_modules)) - self._devices.append(device) - - 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: - device = Device(mac_addr=mac_addr) + device = Device(make=device_make, model=device_model, + mac_addr=mac_addr, test_modules=json.dumps(test_modules)) self._devices.append(device) - LOGGER.info( - f'A new device has been discovered with mac address {mac_addr}') - def _device_stable(self, mac_addr): - device = self.get_device(mac_addr) - LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') - self._test_orc.run_test_modules(device) + 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: + device = Device(mac_addr=mac_addr) + self._devices.append(device) + LOGGER.info( + f'A new device has been discovered with mac address {mac_addr}') + + def _device_stable(self, mac_addr): + device = self.get_device(mac_addr) + LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') + self._test_orc.run_test_modules(device) diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 6930f22be..2950f97fb 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,620 +1,754 @@ -#!/usr/bin/env python3 - -import getpass -import ipaddress -import json -import os -import subprocess -import sys -import time -import threading - -import docker -from docker.types import Mount - -import logger -import util -from listener import Listener -from network_validator import NetworkValidator - -LOGGER = logger.get_logger("net_orc") -CONFIG_FILE = "conf/system.json" -EXAMPLE_CONFIG_FILE = "conf/system.json.example" -RUNTIME_DIR = "runtime/network" -NETWORK_MODULES_DIR = "network/modules" -NETWORK_MODULE_METADATA = "conf/module_config.json" -DEVICE_BRIDGE = "tr-d" -INTERNET_BRIDGE = "tr-c" -PRIVATE_DOCKER_NET = "tr-private-net" -CONTAINER_NAME = "network_orchestrator" -RUNTIME = 300 - - -class NetworkOrchestrator: - """Manage and controls a virtual testing network.""" - - def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): - self._int_intf = None - self._dev_intf = None - self._single_intf = single_intf - self.listener = None - - self._net_modules = [] - - self.validate = validate - - self.async_monitor = async_monitor - - self._path = os.path.dirname(os.path.dirname( - os.path.dirname(os.path.realpath(__file__)))) - - self.validator = NetworkValidator() - - self.network_config = NetworkConfig() - - self.load_config(config_file) - - def start(self): - """Start the network orchestrator.""" - - LOGGER.info("Starting Network Orchestrator") - # Get all components ready - self.load_network_modules() - - # Restore the network first if required - self.stop(kill=True) - - self.start_network() - - if self.async_monitor: - # Run the monitor method asynchronously to keep this method non-blocking - self._monitor_thread = threading.Thread( - target=self.monitor_network) - self._monitor_thread.daemon = True - self._monitor_thread.start() - else: - self.monitor_network() - - def start_network(self): - """Start the virtual testing network.""" - LOGGER.info("Starting network") - - self.build_network_modules() - self.create_net() - self.start_network_services() - - if self.validate: - # Start the validator after network is ready - self.validator.start() - - # Get network ready (via Network orchestrator) - LOGGER.info("Network is ready.") - - def stop(self, kill=False): - """Stop the network orchestrator.""" - self.stop_validator(kill=kill) - self.stop_network(kill=kill) - - def stop_validator(self, kill=False): - """Stop the network validator.""" - # Shutdown the validator - self.validator.stop(kill=kill) - - def stop_network(self, kill=False): - """Stop the virtual testing network.""" - # Shutdown network - self.stop_networking_services(kill=kill) - self.restore_net() - - def monitor_network(self): - # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) - time.sleep(RUNTIME) - - self.stop() - - def load_config(self,config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - self._config_file=os.path.join(self._path, CONFIG_FILE) - else: - # If defined, use as provided - self._config_file=config_file - - if not os.path.isfile(self._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) - - LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) - with open(self._config_file, encoding='UTF-8') as config_json_file: - config_json = json.load(config_json_file) - self.import_config(config_json) - - def import_config(self, json_config): - self._int_intf = json_config['network']['internet_intf'] - self._dev_intf = json_config['network']['device_intf'] - - def _check_network_services(self): - LOGGER.debug("Checking network modules...") - for net_module in self._net_modules: - if net_module.enable_container: - LOGGER.debug("Checking network module: " + - net_module.display_name) - success = self._ping(net_module) - if success: - LOGGER.debug(net_module.display_name + - " responded succesfully: " + str(success)) - else: - LOGGER.error(net_module.display_name + - " failed to respond to ping") - - def _ping(self, net_module): - host = net_module.net_config.ipv4_address - namespace = "tr-ctns-" + net_module.dir_name - cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) - success = util.run_command(cmd, output=False) - return success - - def _create_private_net(self): - client = docker.from_env() - try: - network = client.networks.get(PRIVATE_DOCKER_NET) - network.remove() - except docker.errors.NotFound: - pass - - # TODO: These should be made into variables - ipam_pool = docker.types.IPAMPool( - subnet='100.100.0.0/16', - iprange='100.100.100.0/24' - ) - - ipam_config = docker.types.IPAMConfig( - pool_configs=[ipam_pool] - ) - - client.networks.create( - PRIVATE_DOCKER_NET, - ipam=ipam_config, - internal=True, - check_duplicate=True, - driver="macvlan" - ) - - def _ci_pre_network_create(self): - """ Stores network properties to restore network after - network creation and flushes internet interface - """ - - self._ethmac = subprocess.check_output( - f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() - self._gateway = subprocess.check_output( - "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() - self._ipv4 = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._ipv6 = subprocess.check_output( - f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._brd = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() - - def _ci_post_network_create(self): - """ Restore network connection in CI environment """ - LOGGER.info("post cr") - util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") - util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") - util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") - util.run_command(f"ip addr flush dev {self._int_intf}") - util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") - util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") - util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") - util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") - util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") - util.run_command(f"dhclient {INTERNET_BRIDGE}") - util.run_command(f"ip route del default via 10.1.0.1") - util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") - - def create_net(self): - LOGGER.info("Creating baseline network") - - if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): - LOGGER.error("Configured interfaces are not ready for use. " + - "Ensure both interfaces are connected.") - sys.exit(1) - - if self._single_intf: - self._ci_pre_network_create() - - # Create data plane - util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) - - # Create control plane - util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) - - # Add external interfaces to data and control plane - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + self._dev_intf) - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + self._int_intf) - - # Enable forwarding of eapol packets - util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + - " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") - - # Remove IP from internet adapter - util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") - - # Set ports up - util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") - util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") - - if self._single_intf: - self._ci_post_network_create() - - self._create_private_net() - - self.listener = Listener(self._dev_intf) - self.listener.start_listener() - - def load_network_modules(self): - """Load network modules from module_config.json.""" - LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) - - loaded_modules = "Loaded the following network modules: " - net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) - - for module_dir in os.listdir(net_modules_dir): - - if self._get_network_module(module_dir) is None: - loaded_module = self._load_network_module(module_dir) - loaded_modules += loaded_module.dir_name + " " - - LOGGER.info(loaded_modules) - - def _load_network_module(self, module_dir): - - net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) - - net_module = NetworkModule() - - # Load basic module information - net_module_json = json.load(open(os.path.join( - self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) - - net_module.name = net_module_json['config']['meta']['name'] - net_module.display_name = net_module_json['config']['meta']['display_name'] - net_module.description = net_module_json['config']['meta']['description'] - net_module.dir = os.path.join( - self._path, net_modules_dir, module_dir) - net_module.dir_name = module_dir - net_module.build_file = module_dir + ".Dockerfile" - net_module.container_name = "tr-ct-" + net_module.dir_name - net_module.image_name = "test-run/" + net_module.dir_name - - # Attach folder mounts to network module - if "docker" in net_module_json['config']: - - if "mounts" in net_module_json['config']['docker']: - for mount_point in net_module_json['config']['docker']['mounts']: - net_module.mounts.append(Mount( - target=mount_point['target'], - source=os.path.join( - os.getcwd(), mount_point['source']), - type='bind' - )) - - if "depends_on" in net_module_json['config']['docker']: - depends_on_module = net_module_json['config']['docker']['depends_on'] - if self._get_network_module(depends_on_module) is None: - self._load_network_module(depends_on_module) - - # Determine if this is a container or just an image/template - if "enable_container" in net_module_json['config']['docker']: - net_module.enable_container = net_module_json['config']['docker']['enable_container'] - - # Load network service networking configuration - if net_module.enable_container: - - net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] - net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] - - net_module.net_config.host = False if not "host" in net_module_json[ - 'config']['network'] else net_module_json['config']['network']['host'] - - net_module.net_config.ipv4_address = self.network_config.ipv4_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv4_network = self.network_config.ipv4_network - - net_module.net_config.ipv6_address = self.network_config.ipv6_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv6_network = self.network_config.ipv6_network - - self._net_modules.append(net_module) - return net_module - - def build_network_modules(self): - LOGGER.info("Building network modules...") - for net_module in self._net_modules: - self._build_module(net_module) - - def _build_module(self, net_module): - LOGGER.debug("Building network module " + net_module.dir_name) - client = docker.from_env() - client.images.build( - dockerfile=os.path.join(net_module.dir, net_module.build_file), - path=self._path, - forcerm=True, - tag="test-run/" + net_module.dir_name - ) - - def _get_network_module(self, name): - for net_module in self._net_modules: - if name == net_module.display_name or name == net_module.name or name == net_module.dir_name: - return net_module - return None - - # Start the OVS network module - # This should always be called before loading all - # other modules to allow for a properly setup base - # network - def _start_ovs_module(self): - self._start_network_service(self._get_network_module("OVS")) - - def _start_network_service(self, net_module): - - LOGGER.debug("Starting net service " + net_module.display_name) - network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET - LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, - container name: {net_module.container_name}""") - try: - client = docker.from_env() - net_module.container = client.containers.run( - net_module.image_name, - auto_remove=True, - cap_add=["NET_ADMIN"], - name=net_module.container_name, - hostname=net_module.container_name, - network=PRIVATE_DOCKER_NET, - privileged=True, - detach=True, - mounts=net_module.mounts, - environment={"HOST_USER": getpass.getuser()} - ) - except docker.errors.ContainerError as error: - LOGGER.error("Container run error") - LOGGER.error(error) - - if network != "host": - self._attach_service_to_network(net_module) - - def _stop_service_module(self, net_module, kill=False): - LOGGER.debug("Stopping Service container " + net_module.container_name) - try: - container = self._get_service_container(net_module) - if container is not None: - if kill: - LOGGER.debug("Killing container:" + - net_module.container_name) - container.kill() - else: - LOGGER.debug("Stopping container:" + - net_module.container_name) - container.stop() - LOGGER.debug("Container stopped:" + net_module.container_name) - except Exception as error: - LOGGER.error("Container stop error") - LOGGER.error(error) - - def _get_service_container(self, net_module): - LOGGER.debug("Resolving service container: " + - net_module.container_name) - container = None - try: - client = docker.from_env() - container = client.containers.get(net_module.container_name) - except docker.errors.NotFound: - LOGGER.debug("Container " + - net_module.container_name + " not found") - except Exception as e: - LOGGER.error("Failed to resolve container") - LOGGER.error(e) - return container - - def stop_networking_services(self, kill=False): - LOGGER.info("Stopping network services") - for net_module in self._net_modules: - # Network modules may just be Docker images, so we do not want to stop them - if not net_module.enable_container: - continue - self._stop_service_module(net_module, kill) - - def start_network_services(self): - LOGGER.info("Starting network services") - - os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) - - for net_module in self._net_modules: - - # TODO: There should be a better way of doing this - # Do not try starting OVS module again, as it should already be running - if "OVS" != net_module.display_name: - - # Network modules may just be Docker images, so we do not want to start them as containers - if not net_module.enable_container: - continue - - self._start_network_service(net_module) - - LOGGER.info("All network services are running") - self._check_network_services() - - # TODO: Let's move this into a separate script? It does not look great - def _attach_service_to_network(self, net_module): - LOGGER.debug("Attaching net service " + - net_module.display_name + " to device bridge") - - # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) - bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Container network namespace name - container_net_ns = "tr-ctns-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Add bridge interface to device bridge - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + bridge_intf) - - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command( - "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] - - # Create symlink for container network namespace - util.run_command("ln -sf /proc/" + container_pid + - "/ns/net /var/run/netns/" + container_net_ns) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to veth0 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name veth0") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) - - # Set IP address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") - - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev veth0 up") - - if net_module.net_config.enable_wan: - LOGGER.debug("Attaching net service " + - net_module.display_name + " to internet bridge") - - # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) - bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Attach bridge interface to internet bridge - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + bridge_intf) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to eth1 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name eth1") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + - container_net_ns + " ip link set dev eth1 up") - - def restore_net(self): - - LOGGER.info("Clearing baseline network") - - if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): - self.listener.stop_listener() - - client = docker.from_env() - - # Stop all network containers if still running - for net_module in self._net_modules: - try: - container = client.containers.get( - "tr-ct-" + net_module.dir_name) - container.kill() - except Exception: - continue - - # Delete data plane - util.run_command("ovs-vsctl --if-exists del-br tr-d") - - # Delete control plane - util.run_command("ovs-vsctl --if-exists del-br tr-c") - - # Restart internet interface - if util.interface_exists(self._int_intf): - util.run_command("ip link set " + self._int_intf + " down") - util.run_command("ip link set " + self._int_intf + " up") - - LOGGER.info("Network is restored") - -class NetworkModule: - - def __init__(self): - self.name = None - self.display_name = None - self.description = None - - self.container = None - self.container_name = None - self.image_name = None - - # Absolute path - self.dir = None - self.dir_name = None - self.build_file = None - self.mounts = [] - - self.enable_container = True - - self.net_config = NetworkModuleNetConfig() - -# The networking configuration for a network module - -class NetworkModuleNetConfig: - - def __init__(self): - - self.enable_wan = False - - self.ip_index = 0 - self.ipv4_address = None - self.ipv4_network = None - self.ipv6_address = None - self.ipv6_network = None - - self.host = False - - def get_ipv4_addr_with_prefix(self): - return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) - - def get_ipv6_addr_with_prefix(self): - return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) - -# Represents the current configuration of the network for the device bridge - -class NetworkConfig: - - # TODO: Let's get this from a configuration file - def __init__(self): - self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') - self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') +#!/usr/bin/env python3 + +import binascii +import getpass +import ipaddress +import json +import os +from scapy.all import BOOTP +import shutil +import subprocess +import sys +import time +import threading +from threading import Timer +import docker +from docker.types import Mount +import logger +import util +from listener import Listener +from network_device import NetworkDevice +from network_event import NetworkEvent +from network_validator import NetworkValidator + +LOGGER = logger.get_logger("net_orc") +CONFIG_FILE = "conf/system.json" +EXAMPLE_CONFIG_FILE = "conf/system.json.example" +RUNTIME_DIR = "runtime/network" +NETWORK_MODULES_DIR = "network/modules" +NETWORK_MODULE_METADATA = "conf/module_config.json" +DEVICE_BRIDGE = "tr-d" +INTERNET_BRIDGE = "tr-c" +PRIVATE_DOCKER_NET = "tr-private-net" +CONTAINER_NAME = "network_orchestrator" + +RUNTIME_KEY = "runtime" +MONITOR_PERIOD_KEY = "monitor_period" +STARTUP_TIMEOUT_KEY = "startup_timeout" +DEFAULT_STARTUP_TIMEOUT = 60 +DEFAULT_RUNTIME = 1200 +DEFAULT_MONITOR_PERIOD = 300 + +RUNTIME = 1500 + + +class NetworkOrchestrator: + """Manage and controls a virtual testing network.""" + + def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): + + self._runtime = DEFAULT_RUNTIME + self._startup_timeout = DEFAULT_STARTUP_TIMEOUT + self._monitor_period = DEFAULT_MONITOR_PERIOD + + self._int_intf = None + self._dev_intf = None + self._single_intf = single_intf + + self.listener = None + + self._net_modules = [] + + self.validate = validate + + self.async_monitor = async_monitor + + self._path = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.realpath(__file__)))) + + self.validator = NetworkValidator() + + shutil.rmtree(os.path.join(os.getcwd(), RUNTIME_DIR), ignore_errors=True) + + self.network_config = NetworkConfig() + + self.load_config(config_file) + + def start(self): + """Start the network orchestrator.""" + + LOGGER.info("Starting Network Orchestrator") + # Get all components ready + self.load_network_modules() + + # Restore the network first if required + self.stop(kill=True) + + self.start_network() + + if self.async_monitor: + # Run the monitor method asynchronously to keep this method non-blocking + self._monitor_thread = threading.Thread( + target=self.monitor_network) + self._monitor_thread.daemon = True + self._monitor_thread.start() + else: + self.monitor_network() + + def start_network(self): + """Start the virtual testing network.""" + LOGGER.info("Starting network") + + self.build_network_modules() + self.create_net() + self.start_network_services() + + if self.validate: + # Start the validator after network is ready + self.validator.start() + + # Get network ready (via Network orchestrator) + LOGGER.info("Network is ready.") + + def stop(self, kill=False): + """Stop the network orchestrator.""" + self.stop_validator(kill=kill) + self.stop_network(kill=kill) + + def stop_validator(self, kill=False): + """Stop the network validator.""" + # Shutdown the validator + self.validator.stop(kill=kill) + + def stop_network(self, kill=False): + """Stop the virtual testing network.""" + # Shutdown network + self.stop_networking_services(kill=kill) + self.restore_net() + + def monitor_network(self): + # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) + time.sleep(RUNTIME) + + self.stop() + + def load_config(self,config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + self._config_file=os.path.join(self._path, CONFIG_FILE) + else: + # If defined, use as provided + self._config_file=config_file + + if not os.path.isfile(self._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) + + LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) + with open(self._config_file, encoding='UTF-8') as config_json_file: + config_json = json.load(config_json_file) + self.import_config(config_json) + + def _device_discovered(self, mac_addr): + + LOGGER.debug(f'Discovered device {mac_addr}. Waiting for device to obtain IP') + device = self._get_device(mac_addr=mac_addr) + + timeout = time.time() + self._startup_timeout + + while time.time() < timeout: + if device.ip_addr is None: + time.sleep(3) + else: + break + + if device.ip_addr is None: + LOGGER.info(f"Timed out whilst waiting for {mac_addr} to obtain an IP address") + return + + LOGGER.info(f"Device with mac addr {device.mac_addr} has obtained IP address {device.ip_addr}") + + self._start_device_monitor(device) + + def _dhcp_lease_ack(self, packet): + mac_addr = packet[BOOTP].chaddr.hex(":")[0:17] + device = self._get_device(mac_addr=mac_addr) + device.ip_addr = packet[BOOTP].yiaddr + + def _start_device_monitor(self, device): + """Start a timer until the steady state has been reached and + callback the steady state method for this device.""" + LOGGER.info(f"Monitoring device with mac addr {device.mac_addr} for {str(self._monitor_period)} seconds") + timer = Timer(self._monitor_period, + self.listener.call_callback, + args=(NetworkEvent.DEVICE_STABLE, device.mac_addr,)) + timer.start() + + def _get_device(self, mac_addr): + for device in self._devices: + if device.mac_addr == mac_addr: + return device + device = NetworkDevice(mac_addr=mac_addr) + self._devices.append(device) + return device + + def import_config(self, json_config): + self._int_intf = json_config['network']['internet_intf'] + self._dev_intf = json_config['network']['device_intf'] + + if RUNTIME_KEY in json_config: + self._runtime = json_config[RUNTIME_KEY] + if STARTUP_TIMEOUT_KEY in json_config: + self._startup_timeout = json_config[STARTUP_TIMEOUT_KEY] + if MONITOR_PERIOD_KEY in json_config: + self._monitor_period = json_config[MONITOR_PERIOD_KEY] + + def _check_network_services(self): + LOGGER.debug("Checking network modules...") + for net_module in self._net_modules: + if net_module.enable_container: + LOGGER.debug("Checking network module: " + + net_module.display_name) + success = self._ping(net_module) + if success: + LOGGER.debug(net_module.display_name + + " responded succesfully: " + str(success)) + else: + LOGGER.error(net_module.display_name + + " failed to respond to ping") + + def _ping(self, net_module): + host = net_module.net_config.ipv4_address + namespace = "tr-ctns-" + net_module.dir_name + cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) + success = util.run_command(cmd, output=False) + return success + + def _create_private_net(self): + client = docker.from_env() + try: + network = client.networks.get(PRIVATE_DOCKER_NET) + network.remove() + except docker.errors.NotFound: + pass + + # TODO: These should be made into variables + ipam_pool = docker.types.IPAMPool( + subnet='100.100.0.0/16', + iprange='100.100.100.0/24' + ) + + ipam_config = docker.types.IPAMConfig( + pool_configs=[ipam_pool] + ) + + client.networks.create( + PRIVATE_DOCKER_NET, + ipam=ipam_config, + internal=True, + check_duplicate=True, + driver="macvlan" + ) + + def _ci_pre_network_create(self): + """ Stores network properties to restore network after + network creation and flushes internet interface + """ + + self._ethmac = subprocess.check_output( + f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() + self._gateway = subprocess.check_output( + "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() + self._ipv4 = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._ipv6 = subprocess.check_output( + f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() + self._brd = subprocess.check_output( + f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() + + def _ci_post_network_create(self): + """ Restore network connection in CI environment """ + LOGGER.info("post cr") + util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") + util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") + util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") + util.run_command(f"ip addr flush dev {self._int_intf}") + util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") + util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") + util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") + util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") + util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") + util.run_command(f"dhclient {INTERNET_BRIDGE}") + util.run_command(f"ip route del default via 10.1.0.1") + util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") + + def create_net(self): + LOGGER.info("Creating baseline network") + + if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): + LOGGER.error("Configured interfaces are not ready for use. " + + "Ensure both interfaces are connected.") + sys.exit(1) + + if self._single_intf: + self._ci_pre_network_create() + + # Create data plane + util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) + + # Create control plane + util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) + + # Add external interfaces to data and control plane + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + self._dev_intf) + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + self._int_intf) + + # Enable forwarding of eapol packets + util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + + " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") + + # Remove IP from internet adapter + util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") + + # Set ports up + util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") + util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") + + if self._single_intf: + self._ci_post_network_create() + + self._create_private_net() + + self.listener = Listener(self._dev_intf) + self.listener.register_callback(self._device_discovered, [ + NetworkEvent.DEVICE_DISCOVERED]) + self.listener.register_callback( + self._dhcp_lease_ack, [NetworkEvent.DHCP_LEASE_ACK]) + self.listener.start_listener() + + def load_network_modules(self): + """Load network modules from module_config.json.""" + LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) + + loaded_modules = "Loaded the following network modules: " + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + for module_dir in os.listdir(net_modules_dir): + + if self._get_network_module(module_dir) is None: + loaded_module = self._load_network_module(module_dir) + loaded_modules += loaded_module.dir_name + " " + + LOGGER.info(loaded_modules) + + def _load_network_module(self, module_dir): + + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + net_module = NetworkModule() + + # Load basic module information + net_module_json = json.load(open(os.path.join( + self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) + + net_module.name = net_module_json['config']['meta']['name'] + net_module.display_name = net_module_json['config']['meta']['display_name'] + net_module.description = net_module_json['config']['meta']['description'] + net_module.dir = os.path.join( + self._path, net_modules_dir, module_dir) + net_module.dir_name = module_dir + net_module.build_file = module_dir + ".Dockerfile" + net_module.container_name = "tr-ct-" + net_module.dir_name + net_module.image_name = "test-run/" + net_module.dir_name + + # Attach folder mounts to network module + if "docker" in net_module_json['config']: + + if "mounts" in net_module_json['config']['docker']: + for mount_point in net_module_json['config']['docker']['mounts']: + net_module.mounts.append(Mount( + target=mount_point['target'], + source=os.path.join( + os.getcwd(), mount_point['source']), + type='bind' + )) + + if "depends_on" in net_module_json['config']['docker']: + depends_on_module = net_module_json['config']['docker']['depends_on'] + if self._get_network_module(depends_on_module) is None: + self._load_network_module(depends_on_module) + + # Determine if this is a container or just an image/template + if "enable_container" in net_module_json['config']['docker']: + net_module.enable_container = net_module_json['config']['docker']['enable_container'] + + # Load network service networking configuration + if net_module.enable_container: + + net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] + net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] + + net_module.net_config.host = False if not "host" in net_module_json[ + 'config']['network'] else net_module_json['config']['network']['host'] + + net_module.net_config.ipv4_address = self.network_config.ipv4_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv4_network = self.network_config.ipv4_network + + net_module.net_config.ipv6_address = self.network_config.ipv6_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv6_network = self.network_config.ipv6_network + + self._net_modules.append(net_module) + return net_module + + def build_network_modules(self): + LOGGER.info("Building network modules...") + for net_module in self._net_modules: + self._build_module(net_module) + + def _build_module(self, net_module): + LOGGER.debug("Building network module " + net_module.dir_name) + client = docker.from_env() + client.images.build( + dockerfile=os.path.join(net_module.dir, net_module.build_file), + path=self._path, + forcerm=True, + tag="test-run/" + net_module.dir_name + ) + + def _get_network_module(self, name): + for net_module in self._net_modules: + if name == net_module.display_name or name == net_module.name or name == net_module.dir_name: + return net_module + return None + + # Start the OVS network module + # This should always be called before loading all + # other modules to allow for a properly setup base + # network + def _start_ovs_module(self): + self._start_network_service(self._get_network_module("OVS")) + + def _start_network_service(self, net_module): + + LOGGER.debug("Starting net service " + net_module.display_name) + network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET + LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, + container name: {net_module.container_name}""") + try: + client = docker.from_env() + net_module.container = client.containers.run( + net_module.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=net_module.container_name, + hostname=net_module.container_name, + network=PRIVATE_DOCKER_NET, + privileged=True, + detach=True, + mounts=net_module.mounts, + environment={"HOST_USER": getpass.getuser()} + ) + except docker.errors.ContainerError as error: + LOGGER.error("Container run error") + LOGGER.error(error) + + if network != "host": + self._attach_service_to_network(net_module) + + def _stop_service_module(self, net_module, kill=False): + LOGGER.debug("Stopping Service container " + net_module.container_name) + try: + container = self._get_service_container(net_module) + if container is not None: + if kill: + LOGGER.debug("Killing container:" + + net_module.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + + net_module.container_name) + container.stop() + LOGGER.debug("Container stopped:" + net_module.container_name) + except Exception as error: + LOGGER.error("Container stop error") + LOGGER.error(error) + + def _get_service_container(self, net_module): + LOGGER.debug("Resolving service container: " + + net_module.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_module.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + + net_module.container_name + " not found") + except Exception as e: + LOGGER.error("Failed to resolve container") + LOGGER.error(e) + return container + + def stop_networking_services(self, kill=False): + LOGGER.info("Stopping network services") + for net_module in self._net_modules: + # Network modules may just be Docker images, so we do not want to stop them + if not net_module.enable_container: + continue + self._stop_service_module(net_module, kill) + + def start_network_services(self): + LOGGER.info("Starting network services") + + os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) + + for net_module in self._net_modules: + + # TODO: There should be a better way of doing this + # Do not try starting OVS module again, as it should already be running + if "OVS" != net_module.display_name: + + # Network modules may just be Docker images, so we do not want to start them as containers + if not net_module.enable_container: + continue + + self._start_network_service(net_module) + + LOGGER.info("All network services are running") + self._check_network_services() + + def _attach_test_module_to_network(self, test_module): + LOGGER.debug("Attaching test module " + + test_module.display_name + " to device bridge") + + # Device bridge interface example: tr-di-baseline-test (Test Run Device Interface for baseline test container) + bridge_intf = DEVICE_BRIDGE + "i-" + test_module.dir_name + "-test" + + # Container interface example: tr-cti-baseline-test (Test Run Container Interface for baseline test container) + container_intf = "tr-test-" + test_module.dir_name + + # Container network namespace name + container_net_ns = "tr-test-" + test_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Add bridge interface to device bridge + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command( + "docker inspect -f {{.State.Pid}} " + test_module.container_name)[0] + + # Create symlink for container network namespace + util.run_command("ln -sf /proc/" + container_pid + + "/ns/net /var/run/netns/" + container_net_ns) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to veth0 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name veth0") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(test_module.ip_index)) + + # Set IP address of container interface + ipv4_address = self.network_config.ipv4_network[test_module.ip_index] + ipv6_address = self.network_config.ipv6_network[test_module.ip_index] + + ipv4_address_with_prefix=str(ipv4_address) + "/" + str(self.network_config.ipv4_network.prefixlen) + ipv6_address_with_prefix=str(ipv6_address) + "/" + str(self.network_config.ipv6_network.prefixlen) + + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + ipv4_address_with_prefix + " dev veth0") + + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + ipv6_address_with_prefix + " dev veth0") + + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev veth0 up") + + # TODO: Let's move this into a separate script? It does not look great + def _attach_service_to_network(self, net_module): + LOGGER.debug("Attaching net service " + + net_module.display_name + " to device bridge") + + # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Container network namespace name + container_net_ns = "tr-ctns-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Add bridge interface to device bridge + util.run_command("ovs-vsctl add-port " + + DEVICE_BRIDGE + " " + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command( + "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] + + # Create symlink for container network namespace + util.run_command("ln -sf /proc/" + container_pid + + "/ns/net /var/run/netns/" + container_net_ns) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to veth0 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name veth0") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) + + # Set IP address of container interface + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") + + util.run_command("ip netns exec " + container_net_ns + " ip addr add " + + net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev veth0 up") + + if net_module.net_config.enable_wan: + LOGGER.debug("Attaching net service " + + net_module.display_name + " to internet bridge") + + # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) + bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name + + # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = "tr-cti-" + net_module.dir_name + + # Create interface pair + util.run_command("ip link add " + bridge_intf + + " type veth peer name " + container_intf) + + # Attach bridge interface to internet bridge + util.run_command("ovs-vsctl add-port " + + INTERNET_BRIDGE + " " + bridge_intf) + + # Attach container interface to container network namespace + util.run_command("ip link set " + container_intf + + " netns " + container_net_ns) + + # Rename container interface name to eth1 + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev " + container_intf + " name eth1") + + # Set MAC address of container interface + util.run_command("ip netns exec " + container_net_ns + + " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) + + # Set interfaces up + util.run_command("ip link set dev " + bridge_intf + " up") + util.run_command("ip netns exec " + + container_net_ns + " ip link set dev eth1 up") + + def restore_net(self): + + LOGGER.info("Clearing baseline network") + + if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): + self.listener.stop_listener() + + client = docker.from_env() + + # Stop all network containers if still running + for net_module in self._net_modules: + try: + container = client.containers.get( + "tr-ct-" + net_module.dir_name) + container.kill() + except Exception: + continue + + # Delete data plane + util.run_command("ovs-vsctl --if-exists del-br tr-d") + + # Delete control plane + util.run_command("ovs-vsctl --if-exists del-br tr-c") + + # Restart internet interface + if util.interface_exists(self._int_intf): + util.run_command("ip link set " + self._int_intf + " down") + util.run_command("ip link set " + self._int_intf + " up") + + LOGGER.info("Network is restored") + +class NetworkModule: + + def __init__(self): + self.name = None + self.display_name = None + self.description = None + + self.container = None + self.container_name = None + self.image_name = None + + # Absolute path + self.dir = None + self.dir_name = None + self.build_file = None + self.mounts = [] + + self.enable_container = True + + self.net_config = NetworkModuleNetConfig() + +# The networking configuration for a network module + +class NetworkModuleNetConfig: + + def __init__(self): + + self.enable_wan = False + + self.ip_index = 0 + self.ipv4_address = None + self.ipv4_network = None + self.ipv6_address = None + self.ipv6_network = None + + self.host = False + + def get_ipv4_addr_with_prefix(self): + return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) + + def get_ipv6_addr_with_prefix(self): + return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) + +# Represents the current configuration of the network for the device bridge + +class NetworkConfig: + + # TODO: Let's get this from a configuration file + def __init__(self): + self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') + self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') diff --git a/resources/devices/Template/device_config.json b/resources/devices/Template/device_config.json index f8b56b7a3..7a3d4441c 100644 --- a/resources/devices/Template/device_config.json +++ b/resources/devices/Template/device_config.json @@ -27,6 +27,121 @@ "enabled": true } } + }, + "nmap": { + "enabled": true, + "tests": { + "security.nmap.ports": { + "enabled": true, + "security.services.ftp": { + "tcp_ports": { + "20": { + "allowed": false + }, + "21": { + "allowed": false + } + } + }, + "security.services.ssh": { + "tcp_ports": { + "22": { + "allowed": true + } + } + }, + "security.services.telnet": { + "tcp_ports": { + "23": { + "allowed": false + } + } + }, + "security.services.smtp": { + "tcp_ports": { + "25": { + "allowed": false + }, + "465": { + "allowed": false + }, + "587": { + "allowed": false + } + } + }, + "security.services.http": { + "tcp_ports": { + "80": { + "allowed": false + } + } + }, + "security.services.pop": { + "tcp_ports": { + "110": { + "allowed": false + } + } + }, + "security.services.imap": { + "tcp_ports": { + "143": { + "allowed": false + } + } + }, + "security.services.snmpv3": { + "tcp_ports": { + "161": { + "allowed": false + }, + "162": { + "allowed": false + } + }, + "udp_ports": { + "161": { + "allowed": false + }, + "162": { + "allowed": false + } + } + }, + "security.services.https": { + "tcp_ports": { + "80": { + "allowed": false + } + } + }, + "security.services.vnc": { + "tcp_ports": { + "5500": { + "allowed": false + }, + "5800": { + "allowed": false + } + } + }, + "security.services.tftp": { + "udp_ports": { + "69": { + "allowed": false + } + } + }, + "security.services.ntp": { + "udp_ports": { + "123": { + "allowed": false + } + } + } + } + } } } } \ No newline at end of file diff --git a/test_orc/modules/base/base.Dockerfile b/test_orc/modules/base/base.Dockerfile index b5f35326a..a508caef7 100644 --- a/test_orc/modules/base/base.Dockerfile +++ b/test_orc/modules/base/base.Dockerfile @@ -2,7 +2,7 @@ FROM ubuntu:jammy # Install common software -RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix +RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix nmap --fix-missing # Setup the base python requirements COPY modules/base/python /testrun/python diff --git a/test_orc/modules/base/bin/get_ipv4_addr b/test_orc/modules/base/bin/get_ipv4_addr new file mode 100644 index 000000000..09a19bc13 --- /dev/null +++ b/test_orc/modules/base/bin/get_ipv4_addr @@ -0,0 +1,8 @@ +#!/bin/bash + +NET=$1 +MAC=$2 + +IP_ADDR=$(nmap -sP $NET | grep -B 2 $MAC | head -n 1 | cut -d " " -f 5) + +echo $IP_ADDR \ No newline at end of file diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 6f7f48c3a..9a348faa7 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -1,6 +1,7 @@ import json import logger import os +import util LOGGER = None RESULTS_DIR = "/runtime/output/" @@ -12,8 +13,12 @@ class TestModule: def __init__(self, module_name, log_name): self._module_name = module_name self._device_mac = os.environ['DEVICE_MAC'] + self._ipv4_subnet = os.environ['IPV4_SUBNET'] + self._ipv6_subnet = os.environ['IPV6_SUBNET'] self._add_logger(log_name=log_name, module_name=module_name) self._config = self._read_config() + self._device_ipv4_addr = None + self._device_ipv6_addr = None def _add_logger(self, log_name, module_name): global LOGGER @@ -34,8 +39,11 @@ def _get_device_tests(self, device_test_module): return [] else: for test in module_tests: + # Resolve device specific configurations for the test if it exists + # and update module test config with device config options if test["name"] in device_test_module["tests"]: - test["enabled"] = device_test_module["tests"][test["name"]]["enabled"] + dev_test_config = device_test_module["tests"][test["name"]] + test["config"].update(dev_test_config) return module_tests def _get_device_test_module(self): @@ -45,8 +53,10 @@ def _get_device_test_module(self): return None def run_tests(self): + if self._config["config"]["network"]: + self._device_ipv4_addr = self._get_device_ipv4() + LOGGER.info("Device IP Resolved: " + str(self._device_ipv4_addr)) tests = self._get_tests() - device_modules = os.environ['DEVICE_TEST_MODULES'] for test in tests: test_method_name = "_" + test["name"].replace(".", "_") result = None @@ -55,7 +65,11 @@ def run_tests(self): # Resolve the correct python method by test name and run test if hasattr(self, test_method_name): - result = getattr(self, test_method_name)() + if "config" in test: + result = getattr(self, test_method_name)( + config=test["config"]) + else: + result = getattr(self, test_method_name)() else: LOGGER.info("Test " + test["name"] + " not resolved. Skipping") @@ -82,3 +96,11 @@ def _write_results(self, results): f = open(results_file, "w", encoding="utf-8") f.write(results) f.close() + + def _get_device_ipv4(self): + command = '/testrun/bin/get_ipv4_addr {} {}'.format( + self._ipv4_subnet, self._device_mac.upper()) + text, err = util.run_command(command) + if text: + return text.split("\n")[0] + return None diff --git a/test_orc/modules/base/python/src/util.py b/test_orc/modules/base/python/src/util.py new file mode 100644 index 000000000..a2dcfbdb1 --- /dev/null +++ b/test_orc/modules/base/python/src/util.py @@ -0,0 +1,25 @@ +import subprocess +import shlex +import logger + +# Runs a process at the os level +# By default, returns the standard output and error output +# If the caller sets optional output parameter to False, +# will only return a boolean result indicating if it was +# succesful in running the command. Failure is indicated +# by any return code from the process other than zero. +def run_command(cmd, output=True): + success = False + LOGGER = logger.get_logger('util') + process = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + if process.returncode !=0 and output: + err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) + LOGGER.error("Command Failed: " + cmd) + LOGGER.error("Error: " + err_msg) + else: + success = True + if output: + return stdout.strip().decode('utf-8'), stderr + else: + return success diff --git a/test_orc/modules/nmap/bin/start_test_module b/test_orc/modules/nmap/bin/start_test_module new file mode 100644 index 000000000..4bb7e9f96 --- /dev/null +++ b/test_orc/modules/nmap/bin/start_test_module @@ -0,0 +1,42 @@ +#!/bin/bash + +# An example startup script that does the bare minimum to start +# a test module via a pyhon script. Each test module should include a +# start_test_module file that overwrites this one to boot all of its +# specific requirements to run. + +# Define where the python source files are located +PYTHON_SRC_DIR=/testrun/python/src + +# Fetch module name +MODULE_NAME=$1 + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No interface defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +# Create and set permissions on the log files +LOG_FILE=/runtime/output/$MODULE_NAME.log +RESULT_FILE=/runtime/output/$MODULE_NAME-result.json +touch $LOG_FILE +touch $RESULT_FILE +chown $HOST_USER:$HOST_USER $LOG_FILE +chown $HOST_USER:$HOST_USER $RESULT_FILE + +# Run the python scrip that will execute the tests for this module +# -u flag allows python print statements +# to be logged by docker by running unbuffered +python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" + +echo Module has finished \ No newline at end of file diff --git a/test_orc/modules/nmap/conf/module_config.json b/test_orc/modules/nmap/conf/module_config.json new file mode 100644 index 000000000..5449327a1 --- /dev/null +++ b/test_orc/modules/nmap/conf/module_config.json @@ -0,0 +1,176 @@ +{ + "config": { + "meta": { + "name": "nmap", + "display_name": "nmap", + "description": "Scan for open ports using nmap" + }, + "network": true, + "docker": { + "enable_container": true, + "timeout": 600 + }, + "tests": [ + { + "name": "security.nmap.ports", + "description": "Run an nmap scan of open ports", + "expected_behavior": "Report all open ports", + "config": { + "security.services.ftp": { + "tcp_ports": { + "20": { + "allowed": false, + "description": "File Transfer Protocol (FTP) Server Data Transfer" + }, + "21": { + "allowed": false, + "description": "File Transfer Protocol (FTP) Server Data Transfer" + } + }, + "description": "Check FTP port 20/21 is disabled and FTP is not running on any port", + "expected_behavior": "There is no FTP service running on any port" + }, + "security.services.ssh": { + "tcp_ports": { + "22": { + "allowed": true, + "description": "Secure Shell (SSH) server" + } + }, + "description": "Check TELNET port 23 is disabled and TELNET is not running on any port", + "expected_behavior": "There is no FTP service running on any port" + }, + "security.services.telnet": { + "tcp_ports": { + "23": { + "allowed": false, + "description": "Telnet Server" + } + }, + "description": "Check TELNET port 23 is disabled and TELNET is not running on any port", + "expected_behavior": "There is no FTP service running on any port" + }, + "security.services.smtp": { + "tcp_ports": { + "25": { + "allowed": false, + "description": "Simple Mail Transfer Protocol (SMTP) Server" + }, + "465": { + "allowed": false, + "description": "Simple Mail Transfer Protocol over SSL (SMTPS) Server" + }, + "587": { + "allowed": false, + "description": "Simple Mail Transfer Protocol via TLS (SMTPS) Server" + } + }, + "description": "Check SMTP port 25 is disabled and ports 465 or 587 with SSL encryption are (not?) enabled and SMTP is not running on any port.", + "expected_behavior": "There is no smtp service running on any port" + }, + "security.services.http": { + "tcp_ports": { + "80": { + "service_scan": { + "script": "http-methods" + }, + "allowed": false, + "description": "Administrative Insecure Web-Server" + } + }, + "description": "Check that there is no HTTP server running on any port", + "expected_behavior": "Device is unreachable on port 80 (or any other port) and only responds to HTTPS requests on port 443 (or any other port if HTTP is used at all)" + }, + "security.services.pop": { + "tcp_ports": { + "110": { + "allowed": false, + "description": "Post Office Protocol v3 (POP3) Server" + } + }, + "description": "Check POP port 110 is disalbed and POP is not running on any port", + "expected_behavior": "There is no pop service running on any port" + }, + "security.services.imap": { + "tcp_ports": { + "143": { + "allowed": false, + "description": "Internet Message Access Protocol (IMAP) Server" + } + }, + "description": "Check IMAP port 143 is disabled and IMAP is not running on any port", + "expected_behavior": "There is no imap service running on any port" + }, + "security.services.snmpv3": { + "tcp_ports": { + "161": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP)" + }, + "162": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP) Trap" + } + }, + "udp_ports": { + "161": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP)" + }, + "162": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP) Trap" + } + }, + "description": "Check SNMP port 161/162 is disabled. If SNMP is an essential service, check it supports version 3", + "expected_behavior": "Device is unreachable on port 161 (or any other port) and device is unreachable on port 162 (or any other port) unless SNMP is essential in which case it is SNMPv3 is used." + }, + "security.services.https": { + "tcp_ports": { + "80": { + "allowed": false, + "description": "Administrative Secure Web-Server" + } + }, + "description": "Check that if there is a web server running it is running on a secure port.", + "expected_behavior": "Device only responds to HTTPS requests on port 443 (or any other port if HTTP is used at all)" + }, + "security.services.vnc": { + "tcp_ports": { + "5800": { + "allowed": false, + "description": "Virtual Network Computing (VNC) Remote Frame Buffer Protocol Over HTTP" + }, + "5500": { + "allowed": false, + "description": "Virtual Network Computing (VNC) Remote Frame Buffer Protocol" + } + }, + "description": "Check VNC is disabled on any port", + "expected_behavior": "Device cannot be accessed /connected to via VNc on any port" + }, + "security.services.tftp": { + "udp_ports": { + "69": { + "allowed": false, + "description": "Trivial File Transfer Protocol (TFTP) Server" + } + }, + "description": "Check TFTP port 69 is disabled (UDP)", + "expected_behavior": "There is no tftp service running on any port" + }, + "security.services.ntp": { + "udp_ports": { + "123": { + "allowed": false, + "description": "Network Time Protocol (NTP) Server" + } + }, + "description": "Check NTP port 123 is disabled and the device is not operating as an NTP server", + "expected_behavior": "The device dos not respond to NTP requests when it's IP is set as the NTP server on another device" + } + } + } + ] + } +} \ No newline at end of file diff --git a/test_orc/modules/nmap/nmap.Dockerfile b/test_orc/modules/nmap/nmap.Dockerfile new file mode 100644 index 000000000..12f23dde7 --- /dev/null +++ b/test_orc/modules/nmap/nmap.Dockerfile @@ -0,0 +1,11 @@ +# Image name: test-run/baseline-test +FROM test-run/base-test:latest + +# Copy over all configuration files +COPY modules/nmap/conf /testrun/conf + +# Load device binary files +COPY modules/nmap/bin /testrun/bin + +# Copy over all python files +COPY modules/nmap/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/nmap/python/src/nmap_module.py b/test_orc/modules/nmap/python/src/nmap_module.py new file mode 100644 index 000000000..7d5bd3604 --- /dev/null +++ b/test_orc/modules/nmap/python/src/nmap_module.py @@ -0,0 +1,227 @@ +#!/usr/bin/env python3 + +import time +import util +import json +import threading +from test_module import TestModule + +LOG_NAME = "test_nmap" +LOGGER = None + + +class NmapModule(TestModule): + + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + self._unallowed_ports = [] + self._scan_tcp_results = None + self._udp_tcp_results = None + self._script_scan_results = None + global LOGGER + LOGGER = self._get_logger() + + def _security_nmap_ports(self, config): + LOGGER.info( + "Running security.nmap.ports test") + + # Delete the enabled key from the config if it exists + # to prevent it being treated as a test key + if "enabled" in config: + del config["enabled"] + + if self._device_ipv4_addr is not None: + # Run the monitor method asynchronously to keep this method non-blocking + self._tcp_scan_thread = threading.Thread( + target=self._scan_tcp_ports, args=(config,)) + self._udp_scan_thread = threading.Thread( + target=self._scan_udp_ports, args=(config,)) + self._script_scan_thread = threading.Thread( + target=self._scan_scripts, args=(config,)) + + self._tcp_scan_thread.daemon = True + self._udp_scan_thread.daemon = True + self._script_scan_thread.daemon = True + + self._tcp_scan_thread.start() + self._udp_scan_thread.start() + self._script_scan_thread.start() + + while self._tcp_scan_thread.is_alive() or self._udp_scan_thread.is_alive() or self._script_scan_thread.is_alive(): + time.sleep(1) + + LOGGER.debug("TCP scan results: " + str(self._scan_tcp_results)) + LOGGER.debug("UDP scan results: " + str(self._scan_udp_results)) + LOGGER.debug("Service scan results: " + + str(self._script_scan_results)) + self._process_port_results( + tests=config) + LOGGER.info("Unallowed Ports: " + str(self._unallowed_ports)) + LOGGER.info("Script scan results:\n" + + json.dumps(self._script_scan_results)) + return len(self._unallowed_ports) == 0 + else: + LOGGER.info("Device ip address not resolved, skipping") + return None + + def _process_port_results(self, tests): + for test in tests: + LOGGER.info("Checking results for test: " + str(test)) + self._check_scan_results(test_config=tests[test]) + + def _check_scan_results(self, test_config): + port_config = {} + if "tcp_ports" in test_config: + port_config.update(test_config["tcp_ports"]) + elif "udp_ports" in test_config: + port_config.update(test_config["udp_ports"]) + + scan_results = {} + if self._scan_tcp_results is not None: + scan_results.update(self._scan_tcp_results) + if self._scan_udp_results is not None: + scan_results.update(self._scan_udp_results) + if self._script_scan_results is not None: + scan_results.update(self._script_scan_results) + if port_config is not None: + for port in port_config: + result = None + LOGGER.info("Checking port: " + str(port)) + LOGGER.debug("Port config: " + str(port_config[port])) + if port in scan_results: + if scan_results[port]["state"] == "open": + if not port_config[port]["allowed"]: + LOGGER.info("Unallowed port open") + self._unallowed_ports.append(str(port)) + result = False + else: + LOGGER.info("Allowed port open") + result = True + else: + LOGGER.info("Port is closed") + result = True + else: + LOGGER.info("Port not detected, closed") + result = True + + if result is not None: + port_config[port]["result"] = "compliant" if result else "non-compliant" + else: + port_config[port]["result"] = "skipped" + + def _scan_scripts(self, tests): + scan_results = {} + LOGGER.info("Checing for scan scripts") + for test in tests: + test_config = tests[test] + if "tcp_ports" in test_config: + for port in test_config["tcp_ports"]: + port_config = test_config["tcp_ports"][port] + if "service_scan" in port_config: + LOGGER.info("Service Scan Detected for: " + str(port)) + svc = port_config["service_scan"] + scan_results.update( + self._scan_tcp_with_script(svc["script"])) + if "udp_ports" in test_config: + for port in test_config["udp_ports"]: + if "service_scan" in port: + LOGGER.info("Service Scan Detected for: " + str(port)) + svc = port["service_scan"] + self._scan_udp_with_script(svc["script"], port) + scan_results.update( + self._scan_tcp_with_script(svc["script"])) + self._script_scan_results = scan_results + + def _scan_tcp_with_script(self, script_name, ports=None): + LOGGER.info("Running TCP nmap scan with script " + script_name) + scan_options = " -v -n T3 --host-timeout=6m -A --script " + script_name + port_options = " --open " + if ports is None: + port_options += " -p- " + else: + port_options += " -p" + ports + " " + results_file = "/runtime/output/" + self._module_name + "-"+script_name+".log" + nmap_options = scan_options + port_options + " -oG " + results_file + nmap_results, err = util.run_command( + "nmap " + nmap_options + " " + self._device_ipv4_addr) + LOGGER.info("Nmap TCP script scan complete") + LOGGER.info("nmap script results\n" + str(nmap_results)) + return self._process_nmap_results(nmap_results=nmap_results) + + def _scan_udp_with_script(self, script_name, ports=None): + LOGGER.info("Running UDP nmap scan with script " + script_name) + scan_options = " --sU -Pn -n --script " + script_name + port_options = " --open " + if ports is None: + port_options += " -p- " + else: + port_options += " -p" + ports + " " + nmap_options = scan_options + port_options + nmap_results, err = util.run_command( + "nmap " + nmap_options + self._device_ipv4_addr) + LOGGER.info("Nmap UDP script scan complete") + LOGGER.info("nmap script results\n" + str(nmap_results)) + return self._process_nmap_results(nmap_results=nmap_results) + + def _scan_tcp_ports(self, tests): + max_port = 1000 + ports = [] + for test in tests: + test_config = tests[test] + if "tcp_ports" in test_config: + for port in test_config["tcp_ports"]: + if int(port) > max_port: + ports.append(port) + ports_to_scan = "1-" + str(max_port) + if len(ports) > 0: + ports_to_scan += "," + ','.join(ports) + LOGGER.info("Running nmap TCP port scan") + LOGGER.info("TCP ports: " + str(ports_to_scan)) + nmap_results, err = util.run_command( + "nmap -sT -sV -Pn -v -p " + ports_to_scan + " --version-intensity 7 -T4 " + self._device_ipv4_addr) + LOGGER.info("TCP port scan complete") + self._scan_tcp_results = self._process_nmap_results( + nmap_results=nmap_results) + + def _scan_udp_ports(self, tests): + ports = [] + for test in tests: + test_config = tests[test] + if "udp_ports" in test_config: + for port in test_config["udp_ports"]: + ports.append(port) + if len(ports) > 0: + port_list = ','.join(ports) + LOGGER.info("Running nmap UDP port scan") + LOGGER.info("UDP ports: " + str(port_list)) + nmap_results, err = util.run_command( + "nmap -sU -sV -p " + port_list + " " + self._device_ipv4_addr) + LOGGER.info("UDP port scan complete") + self._scan_udp_results = self._process_nmap_results( + nmap_results=nmap_results) + + def _process_nmap_results(self, nmap_results): + results = {} + LOGGER.info("nmap results\n" + str(nmap_results)) + if nmap_results: + if "Service Info" in nmap_results: + rows = nmap_results.split("PORT")[1].split( + "Service Info")[0].split("\n") + elif "PORT" in nmap_results: + rows = nmap_results.split("PORT")[1].split( + "MAC Address")[0].split("\n") + if rows: + for result in rows[1:-1]: # Iterate skipping the header and tail rows + cols = result.split() + port = cols[0].split("/")[0] + # If results don't start with a a port number, it's likely a bleed over + # from previous result so we need to ignore it + if port.isdigit(): + version = "" + if len(cols) > 3: + # recombine full version information that may contain spaces + version = ' '.join(cols[3:]) + port_result = {cols[0].split( + "/")[0]: {"state": cols[1], "service": cols[2], "version": version}} + results.update(port_result) + return results diff --git a/test_orc/modules/nmap/python/src/run.py b/test_orc/modules/nmap/python/src/run.py new file mode 100644 index 000000000..4c8294769 --- /dev/null +++ b/test_orc/modules/nmap/python/src/run.py @@ -0,0 +1,48 @@ +#!/usr/bin/env python3 + +import argparse +import signal +import sys +import logger + +from nmap_module import NmapModule + +LOGGER = logger.get_logger('test_module') + +class NmapModuleRunner: + + def __init__(self,module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + + LOGGER.info("Starting nmap Module") + + self._test_module = NmapModule(module) + self._test_module.run_tests() + + def _handler(self, signum, *other): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping test module...") + LOGGER.info("Test module stopped") + sys.exit(1) + +def run(argv): + parser = argparse.ArgumentParser(description="Nmap Module Help", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + "-m", "--module", help="Define the module name to be used to create the log file") + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + NmapModuleRunner(args.module.strip()) + +if __name__ == "__main__": + run(sys.argv) diff --git a/test_orc/python/src/module.py b/test_orc/python/src/module.py index 8121c34db..6b2f14f9d 100644 --- a/test_orc/python/src/module.py +++ b/test_orc/python/src/module.py @@ -15,9 +15,13 @@ class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-att container_name: str = None image_name :str = None enable_container: bool = True + network: bool = True timeout: int = 60 # Absolute path dir: str = None dir_name: str = None + + #Set IP Index for all test modules + ip_index: str = 9 diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index c257cd901..08c855d9a 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -19,9 +19,10 @@ class TestOrchestrator: """Manages and controls the test modules.""" - def __init__(self): + def __init__(self,net_orc): self._test_modules = [] self._module_config = None + self._net_orc = net_orc self._path = os.path.dirname(os.path.dirname( os.path.dirname(os.path.realpath(__file__)))) @@ -90,7 +91,9 @@ def _run_test_module(self, module, device): environment={ "HOST_USER": getpass.getuser(), "DEVICE_MAC": device.mac_addr, - "DEVICE_TEST_MODULES": device.test_modules + "DEVICE_TEST_MODULES": device.test_modules, + "IPV4_SUBNET": self._net_orc.network_config.ipv4_network, + "IPV6_SUBNET": self._net_orc.network_config.ipv6_network } ) except (docker.errors.APIError, docker.errors.ContainerError) as container_error: @@ -98,6 +101,11 @@ def _run_test_module(self, module, device): LOGGER.debug(container_error) return + # Mount the test container to the virtual network if requried + if module.network: + LOGGER.info("Mounting test module to the network") + self._net_orc._attach_test_module_to_network(module) + # Determine the module timeout time test_module_timeout = time.time() + module.timeout status = self._get_module_status(module) From 07432ee1de1d2759b70d4771b2121913dc82714d Mon Sep 17 00:00:00 2001 From: Jacob Boddey Date: Wed, 17 May 2023 15:49:08 +0100 Subject: [PATCH 013/400] Fix device configs --- framework/device.py | 10 +- framework/testrun.py | 271 +++++++++--------- net_orc/python/src/network_orchestrator.py | 37 ++- .../modules/base/python/src/test_module.py | 8 +- test_orc/python/src/test_orchestrator.py | 4 +- 5 files changed, 168 insertions(+), 162 deletions(-) diff --git a/framework/device.py b/framework/device.py index 74d62d495..80cfb9c9c 100644 --- a/framework/device.py +++ b/framework/device.py @@ -6,9 +6,9 @@ @dataclass class Device(NetworkDevice): - """Represents a physical device and it's configuration.""" + """Represents a physical device and it's configuration.""" - make: str = None - model: str = None - mac_addr: str - test_modules: str = None + make: str = None + model: str = None + mac_addr: str + test_modules: str = None diff --git a/framework/testrun.py b/framework/testrun.py index 44c3bca6d..d5c70a9ca 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -46,142 +46,149 @@ class TestRun: # pylint: disable=too-few-public-methods - """Test Run controller. + """Test Run controller. - Creates an instance of the network orchestrator, test - orchestrator and user interface. - """ + Creates an instance of the network orchestrator, test + orchestrator and user interface. + """ - def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False, single_intf=False): - self._devices = [] - self._net_only = net_only - self._single_intf = single_intf + def __init__(self, + config_file=CONFIG_FILE, + validate=True, + net_only=False, + single_intf=False): + self._devices = [] + self._net_only = net_only + self._single_intf = single_intf - # Catch any exit signals - self._register_exits() + # Catch any exit signals + self._register_exits() - # Expand the config file to absolute pathing - config_file_abs = self._get_config_abs(config_file=config_file) + # Expand the config file to absolute pathing + config_file_abs = self._get_config_abs(config_file=config_file) - self._net_orc = net_orc.NetworkOrchestrator( - config_file=config_file_abs, - validate=validate, - async_monitor=not self._net_only, - single_intf = self._single_intf) - self._test_orc = test_orc.TestOrchestrator(self._net_orc) + self._net_orc = net_orc.NetworkOrchestrator( + config_file=config_file_abs, + validate=validate, + async_monitor=not self._net_only, + single_intf = self._single_intf) - def start(self): + self._test_orc = test_orc.TestOrchestrator(self._net_orc) + + def start(self): - self._load_all_devices() - - - if self._net_only: - LOGGER.info("Network only option configured, no tests will be run") - self._start_network() - else: - self._start_network() - self._test_orc.start() - - self._net_orc.listener.register_callback( - self._device_stable, - [NetworkEvent.DEVICE_STABLE] - ) - - LOGGER.info("Waiting for devices on the network...") - - # Check timeout and whether testing is currently in progress before stopping - time.sleep(RUNTIME) - - self.stop() - - def stop(self, kill=False): - self._stop_tests() - self._stop_network(kill=kill) - - 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(kill=True) - sys.exit(1) - - def _get_config_abs(self, config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - config_file = os.path.join(parent_dir, CONFIG_FILE) - - # Expand the config file to absolute pathing - return os.path.abspath(config_file) - - def _start_network(self): - # Load in local device configs to the network orchestrator - self._net_orc._devices = self._devices - - # Start the network orchestrator - self._net_orc.start() - - def _run_tests(self, device): - """Iterate through and start all test modules.""" - - # To Do: Make this configurable - time.sleep(60) # Let device bootup - - self._test_orc._run_test_modules(device) - - def _stop_network(self, kill=False): - self._net_orc.stop(kill=kill) - - def _stop_tests(self): - self._test_orc.stop() - - def _load_all_devices(self): - self._load_devices(device_dir=LOCAL_DEVICES_DIR) - self._load_devices(device_dir=RESOURCE_DEVICES_DIR) - - def _load_devices(self, device_dir): - LOGGER.debug('Loading devices from ' + device_dir) - - os.makedirs(device_dir, exist_ok=True) - - for device_folder in os.listdir(device_dir): - with open(os.path.join(device_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) - test_modules = device_config_json.get(DEVICE_TEST_MODULES) - - device = Device(make=device_make, model=device_model, - mac_addr=mac_addr, test_modules=json.dumps(test_modules)) - self._devices.append(device) - - 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: - device = Device(mac_addr=mac_addr) - self._devices.append(device) - LOGGER.info( - f'A new device has been discovered with mac address {mac_addr}') - - def _device_stable(self, mac_addr): - device = self.get_device(mac_addr) - LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') - self._test_orc.run_test_modules(device) + self._load_all_devices() + + if self._net_only: + LOGGER.info('Network only option configured, no tests will be run') + self._start_network() + else: + self._start_network() + self._test_orc.start() + + self._net_orc.listener.register_callback( + self._device_stable, + [NetworkEvent.DEVICE_STABLE] + ) + self._net_orc.listener.register_callback( + self._device_discovered, + [NetworkEvent.DEVICE_DISCOVERED] + ) + + LOGGER.info('Waiting for devices on the network...') + + # Check timeout and whether testing is currently + # in progress before stopping + time.sleep(RUNTIME) + + self.stop() + + def stop(self, kill=False): + self._stop_tests() + self._stop_network(kill=kill) + + 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(kill=True) + sys.exit(1) + + def _get_config_abs(self, config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + config_file = os.path.join(parent_dir, CONFIG_FILE) + + # Expand the config file to absolute pathing + return os.path.abspath(config_file) + + def _start_network(self): + # Start the network orchestrator + self._net_orc.start() + + def _run_tests(self, device): + """Iterate through and start all test modules.""" + + # To Do: Make this configurable + time.sleep(60) # Let device bootup + + self._test_orc._run_test_modules(device) + + def _stop_network(self, kill=False): + self._net_orc.stop(kill=kill) + + def _stop_tests(self): + self._test_orc.stop() + + def _load_all_devices(self): + self._load_devices(device_dir=LOCAL_DEVICES_DIR) + self._load_devices(device_dir=RESOURCE_DEVICES_DIR) + + def _load_devices(self, device_dir): + LOGGER.debug('Loading devices from ' + device_dir) + + os.makedirs(device_dir, exist_ok=True) + + for device_folder in os.listdir(device_dir): + with open(os.path.join(device_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) + test_modules = device_config_json.get(DEVICE_TEST_MODULES) + + device = Device(make=device_make, + model=device_model, + mac_addr=mac_addr, + test_modules=json.dumps(test_modules)) + self._devices.append(device) + + 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 + + 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: + device = Device(mac_addr=mac_addr) + self._devices.append(device) + LOGGER.info( + f'A new device has been discovered with mac address {mac_addr}') + + def _device_stable(self, mac_addr): + device = self.get_device(mac_addr) + LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') + self._test_orc.run_test_modules(device) diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 2950f97fb..3b3f92e64 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,11 +1,10 @@ #!/usr/bin/env python3 -import binascii import getpass import ipaddress import json import os -from scapy.all import BOOTP +from scapy.all import sniff, wrpcap, BOOTP import shutil import subprocess import sys @@ -24,7 +23,10 @@ LOGGER = logger.get_logger("net_orc") CONFIG_FILE = "conf/system.json" EXAMPLE_CONFIG_FILE = "conf/system.json.example" -RUNTIME_DIR = "runtime/network" +RUNTIME_DIR = "runtime" +DEVICES_DIR = "devices" +MONITOR_PCAP = "monitor.pcap" +NET_DIR = "runtime/network" NETWORK_MODULES_DIR = "network/modules" NETWORK_MODULE_METADATA = "conf/module_config.json" DEVICE_BRIDGE = "tr-d" @@ -41,7 +43,6 @@ RUNTIME = 1500 - class NetworkOrchestrator: """Manage and controls a virtual testing network.""" @@ -56,22 +57,17 @@ def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, self._single_intf = single_intf self.listener = None - self._net_modules = [] - + self._devices = [] self.validate = validate - self.async_monitor = async_monitor self._path = os.path.dirname(os.path.dirname( os.path.dirname(os.path.realpath(__file__)))) self.validator = NetworkValidator() - - shutil.rmtree(os.path.join(os.getcwd(), RUNTIME_DIR), ignore_errors=True) - + shutil.rmtree(os.path.join(os.getcwd(), NET_DIR), ignore_errors=True) self.network_config = NetworkConfig() - self.load_config(config_file) def start(self): @@ -154,6 +150,7 @@ def _device_discovered(self, mac_addr): LOGGER.debug(f'Discovered device {mac_addr}. Waiting for device to obtain IP') device = self._get_device(mac_addr=mac_addr) + os.makedirs(os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(':', ''))) timeout = time.time() + self._startup_timeout @@ -180,15 +177,15 @@ def _start_device_monitor(self, device): """Start a timer until the steady state has been reached and callback the steady state method for this device.""" LOGGER.info(f"Monitoring device with mac addr {device.mac_addr} for {str(self._monitor_period)} seconds") - timer = Timer(self._monitor_period, - self.listener.call_callback, - args=(NetworkEvent.DEVICE_STABLE, device.mac_addr,)) - timer.start() + packet_capture = sniff(iface=self._dev_intf, timeout=self._monitor_period) + wrpcap(os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(":",""), 'monitor.pcap'), packet_capture) + self.listener.call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) def _get_device(self, mac_addr): for device in self._devices: if device.mac_addr == mac_addr: return device + device = NetworkDevice(mac_addr=mac_addr) self._devices.append(device) return device @@ -504,7 +501,7 @@ def stop_networking_services(self, kill=False): def start_network_services(self): LOGGER.info("Starting network services") - os.makedirs(os.path.join(os.getcwd(), RUNTIME_DIR), exist_ok=True) + os.makedirs(os.path.join(os.getcwd(), NET_DIR), exist_ok=True) for net_module in self._net_modules: @@ -525,11 +522,11 @@ def _attach_test_module_to_network(self, test_module): LOGGER.debug("Attaching test module " + test_module.display_name + " to device bridge") - # Device bridge interface example: tr-di-baseline-test (Test Run Device Interface for baseline test container) - bridge_intf = DEVICE_BRIDGE + "i-" + test_module.dir_name + "-test" + # Device bridge interface example: tr-d-t-baseline (Test Run Device Interface for Test container) + bridge_intf = DEVICE_BRIDGE + "-t-" + test_module.dir_name - # Container interface example: tr-cti-baseline-test (Test Run Container Interface for baseline test container) - container_intf = "tr-test-" + test_module.dir_name + # Container interface example: tr-cti-baseline-test (Test Run Test Container Interface for test container) + container_intf = "tr-tci-" + test_module.dir_name # Container network namespace name container_net_ns = "tr-test-" + test_module.dir_name diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 9a348faa7..522a048f4 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -47,9 +47,11 @@ def _get_device_tests(self, device_test_module): return module_tests def _get_device_test_module(self): - test_modules = json.loads(os.environ['DEVICE_TEST_MODULES']) - if self._module_name in test_modules: - return test_modules[self._module_name] + # TODO: Make DEVICE_TEST_MODULES a static string + if 'DEVICE_TEST_MODULES' in os.environ: + test_modules = json.loads(os.environ['DEVICE_TEST_MODULES']) + if self._module_name in test_modules: + return test_modules[self._module_name] return None def run_tests(self): diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 08c855d9a..48a0cb32d 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -57,8 +57,8 @@ def _run_test_module(self, module, device): return LOGGER.info("Running test module " + module.name) - try: + try: container_runtime_dir = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":","") + "/" + module.name) network_runtime_dir = os.path.join( @@ -103,7 +103,7 @@ def _run_test_module(self, module, device): # Mount the test container to the virtual network if requried if module.network: - LOGGER.info("Mounting test module to the network") + LOGGER.debug("Attaching test module to the network") self._net_orc._attach_test_module_to_network(module) # Determine the module timeout time From 7b27e23debbe9c159fe3be3011a93628f1a361b7 Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Wed, 17 May 2023 12:32:07 -0600 Subject: [PATCH 014/400] Remove unecessary files --- net_orc/LICENSE | 201 --------------------------- net_orc/README.md | 66 --------- net_orc/conf/.gitignore | 1 - net_orc/conf/network/radius/ca.crt | 26 ---- net_orc/conf/system.json.example | 7 - net_orc/python/src/network_runner.py | 69 --------- 6 files changed, 370 deletions(-) delete mode 100644 net_orc/LICENSE delete mode 100644 net_orc/README.md delete mode 100644 net_orc/conf/.gitignore delete mode 100644 net_orc/conf/network/radius/ca.crt delete mode 100644 net_orc/conf/system.json.example delete mode 100644 net_orc/python/src/network_runner.py diff --git a/net_orc/LICENSE b/net_orc/LICENSE deleted file mode 100644 index 261eeb9e9..000000000 --- a/net_orc/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/net_orc/README.md b/net_orc/README.md deleted file mode 100644 index 9cb1eec1a..000000000 --- a/net_orc/README.md +++ /dev/null @@ -1,66 +0,0 @@ -Testrun logo - -## Introduction :wave: -The network orchestrator is a tool to automate the management of a test lab network and provide essential services to begin device testing in just a few minutes. - -## Motivation :bulb: -Test labs may be maintaining a large and complex network using equipment such as: A managed layer 3 switch, an enterprise-grade network router, virtualized or physical servers to provide DNS, NTP, 802.1x etc. With this amount of moving parts, all with dynamic configuration files and constant software updates, more time is likely to be spent on preparation and clean up of functinality or penetration testing - not forgetting the number of software tools required to perform the testing. - -## How it works :triangular_ruler: -The network orchestrator creates an isolated and controlled network environment to fully simulate enterprise network deployments in your device testing lab. -This removes the necessity for complex hardware, advanced knowledge and networking experience whilst enabling semi-technical engineers to validate device -behaviour against industry cyber standards. - -The network orchestrator will provide the network and some tools to assist an engineer performing the additional testing. At the same time, packet captures of the device behaviour will be recorded, alongside logs for each network service, for further debugging. - -## Minimum Requirements :computer: -### Hardware - - PC running Ubuntu LTS (laptop or desktop) - - 2x USB ethernet adapter (One may be built in ethernet) - - Connect one adapter to your router (for internet access) - - Connect one adapter to your device under test - - Internet connection -### Software - - Python 3 with pip3 (Already available on Ubuntu LTS) - - Docker - [Install guide](https://docs.docker.com/engine/install/ubuntu/) - - Open vSwitch ``sudo apt-get install openvswitch-common openvswitch-switch`` - -An additional network interface (even wifi) with internet access can be used to maintain internet connection during use of the network orchestrator. - -## How to use :arrow_forward: -1) Ensure you have a device with the minimum hardware and software requirements setup -2) Clone the project using ```git clone https://github.com/auto-iot/network-orchestrator``` -3) Navigate into the project using ```cd network-orchestrator``` -4) Copy conf/system.json.example to conf/system.json (after setting the correct interfaces in the file) -5) Start the tool using ```sudo cmd/start``` - -## Issue reporting :triangular_flag_on_post: -If the application has come across a problem at any point during setup or use, please raise an issue under the [issues tab](https://github.com/auto-iot/network-orchestrator/issues). Issue templates exist for both bug reports and feature requests. If neither of these are appropriate for your issue, raise a blank issue instead. - -## Roadmap :chart_with_upwards_trend: - - Ability to modify configuration files of each network service during use (via GRPC) - - IPv6 internet routing - -## Contributing :keyboard: -The contributing requirements can be found in [CONTRIBUTING.md](CONTRIBUTING.md). In short, checkout the [Google CLA](https://cla.developers.google.com/) site to get started. - -## FAQ :raising_hand: -1) What services are provided on the virtual network? - - The following are network services that are containerized and accessible to the device under test though are likely to change over time: - - DHCP in failover configuration with internet connectivity - - IPv6 router advertisements - - DNS (and DNS over HTTPS) - - NTPv4 - - 802.1x Port Based Authentication - -2) Can I run the network orchestrator on a virtual machine? - - Probably. Provided that the required 2x USB ethernet adapters are passed to the virtual machine as USB devices rather than network adapters, the tool should - still work. We will look to test and approve the use of virtualisation in the future. - -3) Can I connect multiple devices to the Network Orchestrator? - - In short, Yes you can. The way in which multiple devices could be tested simultaneously is yet to be decided. However, if you simply want to add field/peer devices during runtime (even another laptop performing manual testing) then you may connect the USB ethernet adapter to an unmanaged switch. - -4) Raise an issue with the label 'question' if your question has not been answered in this readme. \ No newline at end of file diff --git a/net_orc/conf/.gitignore b/net_orc/conf/.gitignore deleted file mode 100644 index 41b89ceb1..000000000 --- a/net_orc/conf/.gitignore +++ /dev/null @@ -1 +0,0 @@ -system.json \ No newline at end of file diff --git a/net_orc/conf/network/radius/ca.crt b/net_orc/conf/network/radius/ca.crt deleted file mode 100644 index d009cb1ab..000000000 --- a/net_orc/conf/network/radius/ca.crt +++ /dev/null @@ -1,26 +0,0 @@ ------BEGIN CERTIFICATE----- -MIIEYTCCA0mgAwIBAgIUQJ4F8hBCnCp7ASPZqG/tNQgoUR4wDQYJKoZIhvcNAQEL -BQAwgb8xCzAJBgNVBAYTAkdCMRswGQYDVQQIDBIbWzN+TGVpY2VzdGVyc2hpcmUx -FTATBgNVBAcMDExvdWdoYm9yb3VnaDEUMBIGA1UECgwLRm9yZXN0IFJvY2sxDjAM -BgNVBAsMBUN5YmVyMR8wHQYDVQQDDBZjeWJlci5mb3Jlc3Ryb2NrLmNvLnVrMTUw -MwYJKoZIhvcNAQkBFiZjeWJlcnNlY3VyaXR5LnRlc3RpbmdAZm9yZXN0cm9jay5j -by51azAeFw0yMjAzMDQxMjEzMTBaFw0yNzAzMDMxMjEzMTBaMIG/MQswCQYDVQQG -EwJHQjEbMBkGA1UECAwSG1szfkxlaWNlc3RlcnNoaXJlMRUwEwYDVQQHDAxMb3Vn -aGJvcm91Z2gxFDASBgNVBAoMC0ZvcmVzdCBSb2NrMQ4wDAYDVQQLDAVDeWJlcjEf -MB0GA1UEAwwWY3liZXIuZm9yZXN0cm9jay5jby51azE1MDMGCSqGSIb3DQEJARYm -Y3liZXJzZWN1cml0eS50ZXN0aW5nQGZvcmVzdHJvY2suY28udWswggEiMA0GCSqG -SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDDNz3vJiZ5nX8lohEhqXvxEme3srip8qF7 -r5ScIeQzsTKuPNAmoefx9TcU3SyA2BnREuDX+OCYMN62xxWG2PndOl0LNezAY22C -PJwHbaBntLKY/ZhxYSTyratM7zxKSVLtClamA/bJXBhdfZZKYOP3xlZQEQTygtzK -j5hZwDrpDARtjRZIMWPLqVcoaW9ow2urJVsdD4lYAhpQU2UIgiWo7BG3hJsUfcYX -EQyyrMKJ7xaCwzIU7Sem1PETrzeiWg4KhDijc7A0RMPWlU5ljf0CnY/IZwiDsMRl -hGmGBPvR+ddiWPZPtSKj6TPWpsaMUR9UwncLmSSrhf1otX4Mw0vbAgMBAAGjUzBR -MB0GA1UdDgQWBBR0Qxx2mDTPIfpnzO5YtycGs6t8ijAfBgNVHSMEGDAWgBR0Qxx2 -mDTPIfpnzO5YtycGs6t8ijAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUA -A4IBAQCpTMBMZGXF74WCxrIk23MUsu0OKzMs8B16Wy8BHz+7hInLZwbkx71Z0TP5 -rsMITetSANtM/k4jH7Vmr1xmzU7oSz5zKU1+7rIjKjGtih48WZdJay0uqfKe0K2s -vsRS0LVLY6IiTFWK9YrLC0QFSK7z5GDl1oc/D5yIZAkbsL6PRQJ5RQsYf5BhHfyB -PRV/KcF7c9iKVYW2vILJzbyYLHTDADTHbtfCe5+pAGxagswDjSMVkQu5iJNjbtUO -5iv7PRkgzUFru9Kk6q+LrXbzyPPCwlc3Xbh1q5jSkJLkcV3K26E7+uX5HI+Hxpeh -a8kOsdnw+N8wX6bc7eXIaGBDMine ------END CERTIFICATE----- diff --git a/net_orc/conf/system.json.example b/net_orc/conf/system.json.example deleted file mode 100644 index 77c981394..000000000 --- a/net_orc/conf/system.json.example +++ /dev/null @@ -1,7 +0,0 @@ -{ - "network": { - "device_intf": "enx207bd2620617", - "internet_intf": "enx207bd26205e9" - }, - "log_level": "INFO" -} \ No newline at end of file diff --git a/net_orc/python/src/network_runner.py b/net_orc/python/src/network_runner.py deleted file mode 100644 index 0b7573fb3..000000000 --- a/net_orc/python/src/network_runner.py +++ /dev/null @@ -1,69 +0,0 @@ -#!/usr/bin/env python3 - -"""Wrapper for the NetworkOrchestrator that simplifies -virtual network start process by allowing direct calling -from the command line. - -Run using the provided command scripts in the cmd folder. -E.g sudo cmd/start -""" - -import argparse -import signal -import sys -import logger -from network_orchestrator import NetworkOrchestrator - -LOGGER = logger.get_logger("net_runner") - -class NetworkRunner: - """Entry point to the Network Orchestrator.""" - - def __init__(self, config_file=None, validate=True, async_monitor=False): - self._monitor_thread = None - self._register_exits() - self.net_orc = NetworkOrchestrator(config_file=config_file, - validate=validate, - async_monitor=async_monitor) - - 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.") - # Kill all container services quickly - # If we're here, we want everything to stop immediately - # and don't care about a graceful shutdown - self.stop(True) - sys.exit(1) - - def stop(self, kill=False): - self.net_orc.stop(kill) - - def start(self): - self.net_orc.start() - -def parse_args(): - parser = argparse.ArgumentParser(description="Test Run Help", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("--no-validate", action="store_true", - help="Turn off the validation of the network after network boot") - parser.add_argument("-f", "--config-file", default=None, - help="Define the configuration file for the Network Orchestrator") - parser.add_argument("-d", "--daemon", action="store_true", - help="Run the network monitor process in the background as a daemon thread") - - args = parser.parse_known_args()[0] - return args - -if __name__ == "__main__": - arguments = parse_args() - runner = NetworkRunner(config_file=arguments.config_file, - validate=not arguments.no_validate, - async_monitor=arguments.daemon) - runner.start() From 5ac87269dd5b9f3afd7b46af80e0e98a0e405d5f Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Wed, 17 May 2023 13:07:53 -0600 Subject: [PATCH 015/400] Cleanup duplicate properties --- framework/device.py | 1 - 1 file changed, 1 deletion(-) diff --git a/framework/device.py b/framework/device.py index 80cfb9c9c..eef275d54 100644 --- a/framework/device.py +++ b/framework/device.py @@ -10,5 +10,4 @@ class Device(NetworkDevice): make: str = None model: str = None - mac_addr: str test_modules: str = None From 2c4efe86b384ebd40cdd896b4dd6f556e55968c1 Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Wed, 17 May 2023 13:13:19 -0600 Subject: [PATCH 016/400] Cleanup install script --- cmd/install | 2 -- 1 file changed, 2 deletions(-) diff --git a/cmd/install b/cmd/install index f5af3a5d3..23e463158 100755 --- a/cmd/install +++ b/cmd/install @@ -4,8 +4,6 @@ python3 -m venv venv source venv/bin/activate -pip3 install --upgrade requests - pip3 install -r framework/requirements.txt pip3 install -r net_orc/python/requirements.txt From 25fd8a5bffc5deb19d0a174a76aaa251f2a5a4ef Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Mon, 22 May 2023 07:51:31 -0700 Subject: [PATCH 017/400] Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev --- .../devices/faux-dev/python/src/dhcp_check.py | 136 +- .../devices/faux-dev/python/src/dns_check.py | 170 +-- .../faux-dev/python/src/gateway_check.py | 66 +- .../devices/faux-dev/python/src/logger.py | 50 +- .../devices/faux-dev/python/src/ntp_check.py | 118 +- .../devices/faux-dev/python/src/run.py | 205 +-- .../devices/faux-dev/python/src/util.py | 30 +- .../base/python/src/grpc/start_server.py | 43 +- .../network/modules/base/python/src/logger.py | 61 +- .../dhcp-1/python/src/grpc/dhcp_config.py | 480 +++--- .../dhcp-1/python/src/grpc/network_service.py | 60 +- .../network/modules/dhcp-1/python/src/run.py | 40 - .../dhcp-2/python/src/grpc/dhcp_config.py | 480 +++--- .../dhcp-2/python/src/grpc/network_service.py | 60 +- .../network/modules/dhcp-2/python/src/run.py | 40 - .../modules/ntp/python/src/ntp_server.py | 461 +++--- .../radius/python/src/authenticator.py | 64 +- .../template/python/src/template_main.py | 2 +- net_orc/python/src/listener.py | 21 +- net_orc/python/src/logger.py | 28 +- net_orc/python/src/network_device.py | 1 + net_orc/python/src/network_event.py | 1 + net_orc/python/src/network_orchestrator.py | 1360 +++++++++-------- net_orc/python/src/network_validator.py | 511 +++---- net_orc/python/src/run_validator.py | 52 - net_orc/python/src/util.py | 18 +- 26 files changed, 2272 insertions(+), 2286 deletions(-) delete mode 100644 net_orc/network/modules/dhcp-1/python/src/run.py delete mode 100644 net_orc/network/modules/dhcp-2/python/src/run.py delete mode 100644 net_orc/python/src/run_validator.py diff --git a/net_orc/network/devices/faux-dev/python/src/dhcp_check.py b/net_orc/network/devices/faux-dev/python/src/dhcp_check.py index ab7defc39..82dd6e31f 100644 --- a/net_orc/network/devices/faux-dev/python/src/dhcp_check.py +++ b/net_orc/network/devices/faux-dev/python/src/dhcp_check.py @@ -1,85 +1,87 @@ -#!/usr/bin/env python3 +"""Used to check if the DHCP server is functioning as expected""" import time import logger LOGGER = None -LOG_NAME = "dhcp_validator" -DHCP_LEASE_FILE = "/var/lib/dhcp/dhclient.leases" -IP_ADDRESS_KEY = "fixed-address" -DNS_OPTION_KEY = "option domain-name-servers" -GATEWAY_OPTION_KEY = "option routers" -NTP_OPTION_KEY = "option ntp-servers" +LOG_NAME = 'dhcp_validator' +DHCP_LEASE_FILE = '/var/lib/dhcp/dhclient.leases' +IP_ADDRESS_KEY = 'fixed-address' +DNS_OPTION_KEY = 'option domain-name-servers' +GATEWAY_OPTION_KEY = 'option routers' +NTP_OPTION_KEY = 'option ntp-servers' class DHCPValidator: - def __init__(self, module): - self._dhcp_lease = None - self.dhcp_lease_test = False - self.add_logger(module) + """Validates all expected test behaviors around the DHCP server""" - def add_logger(self, module): - global LOGGER - LOGGER = logger.get_logger(LOG_NAME, module) + def __init__(self, module): + self._dhcp_lease = None + self.dhcp_lease_test = False + self.add_logger(module) - def print_test_results(self): - self.print_test_result("DHCP lease test", self.dhcp_lease_test) + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) - def print_test_result(self, test_name, result): - LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") + def print_test_results(self): + self.print_test_result('DHCP lease test', self.dhcp_lease_test) - def get_dhcp_lease(self): - """Returns the current DHCP lease.""" - return self._dhcp_lease + def print_test_result(self, test_name, result): + LOGGER.info(test_name + ': Pass' if result else test_name + ': Fail') - def validate(self): - self._resolve_dhcp_lease() - LOGGER.info("IP Addr: " + self._dhcp_lease.ip_addr) - LOGGER.info("Gateway: " + self._dhcp_lease.gateway) - LOGGER.info("DNS Server: " + self._dhcp_lease.dns_server) - LOGGER.info("NTP Server: " + self._dhcp_lease.ntp_server) + def get_dhcp_lease(self): + """Returns the current DHCP lease.""" + return self._dhcp_lease - def _resolve_dhcp_lease(self): - LOGGER.info("Resolving DHCP lease...") - while self._dhcp_lease is None: - time.sleep(5) - try: - lease_file = open(DHCP_LEASE_FILE) - lines = lease_file.read() - LOGGER.debug("Lease file:\n" + lines) - leases = lines.split("lease ") - # Last lease is the current lease - cur_lease = leases[-1] - if cur_lease is not None: - LOGGER.debug("Current lease: " + cur_lease) - self._dhcp_lease = DHCPLease() - self.dhcp_lease_test = True - # Iterate over entire lease and pick the parts we care about - lease_parts = cur_lease.split("\n") - for part in lease_parts: - part_clean = part.strip() - if part_clean.startswith(IP_ADDRESS_KEY): - self._dhcp_lease.ip_addr = part_clean[len( - IP_ADDRESS_KEY):-1].strip() - elif part_clean.startswith(DNS_OPTION_KEY): - self._dhcp_lease.dns_server = part_clean[len( - DNS_OPTION_KEY):-1].strip() - elif part_clean.startswith(GATEWAY_OPTION_KEY): - self._dhcp_lease.gateway = part_clean[len( - GATEWAY_OPTION_KEY):-1].strip() - elif part_clean.startswith(NTP_OPTION_KEY): - self._dhcp_lease.ntp_server = part_clean[len( - NTP_OPTION_KEY):-1].strip() - except Exception: - LOGGER.error("DHCP Resolved Error") - LOGGER.info("DHCP lease resolved") + def validate(self): + self._resolve_dhcp_lease() + LOGGER.info('IP Addr: ' + self._dhcp_lease.ip_addr) + LOGGER.info('Gateway: ' + self._dhcp_lease.gateway) + LOGGER.info('DNS Server: ' + self._dhcp_lease.dns_server) + LOGGER.info('NTP Server: ' + self._dhcp_lease.ntp_server) + + def _resolve_dhcp_lease(self): + LOGGER.info('Resolving DHCP lease...') + while self._dhcp_lease is None: + time.sleep(5) + try: + with open(DHCP_LEASE_FILE, 'r', encoding='UTF-8') as lease_file: + lines = lease_file.read() + LOGGER.debug('Lease file:\n' + lines) + leases = lines.split('lease ') + # Last lease is the current lease + cur_lease = leases[-1] + if cur_lease is not None: + LOGGER.debug('Current lease: ' + cur_lease) + self._dhcp_lease = DHCPLease() + self.dhcp_lease_test = True + # Iterate over entire lease and pick the parts we care about + lease_parts = cur_lease.split('\n') + for part in lease_parts: + part_clean = part.strip() + if part_clean.startswith(IP_ADDRESS_KEY): + self._dhcp_lease.ip_addr = part_clean[len(IP_ADDRESS_KEY + ):-1].strip() + elif part_clean.startswith(DNS_OPTION_KEY): + self._dhcp_lease.dns_server = part_clean[len(DNS_OPTION_KEY + ):-1].strip() + elif part_clean.startswith(GATEWAY_OPTION_KEY): + self._dhcp_lease.gateway = part_clean[len(GATEWAY_OPTION_KEY + ):-1].strip() + elif part_clean.startswith(NTP_OPTION_KEY): + self._dhcp_lease.ntp_server = part_clean[len(NTP_OPTION_KEY + ):-1].strip() + except Exception: # pylint: disable=broad-exception-caught + LOGGER.error('DHCP Resolved Error') + LOGGER.info('DHCP lease resolved') class DHCPLease: - """Stores information about a device's DHCP lease.""" + """Stores information about a device's DHCP lease.""" - def __init__(self): - self.ip_addr = None - self.gateway = None - self.dns_server = None - self.ntp_server = None + def __init__(self): + self.ip_addr = None + self.gateway = None + self.dns_server = None + self.ntp_server = None diff --git a/net_orc/network/devices/faux-dev/python/src/dns_check.py b/net_orc/network/devices/faux-dev/python/src/dns_check.py index d3d709d6e..73a72e8c8 100644 --- a/net_orc/network/devices/faux-dev/python/src/dns_check.py +++ b/net_orc/network/devices/faux-dev/python/src/dns_check.py @@ -1,109 +1,103 @@ -#!/usr/bin/env python3 +"""Used to check if the DNS server is functioning as expected""" import logger import time import util import subprocess -from dhcp_check import DHCPLease - LOGGER = None -LOG_NAME = "dns_validator" -HOST_PING = "google.com" -CAPTURE_FILE = "/runtime/network/faux-dev.pcap" -DNS_CONFIG_FILE = "/etc/resolv.conf" +LOG_NAME = 'dns_validator' +HOST_PING = 'google.com' +CAPTURE_FILE = '/runtime/network/faux-dev.pcap' +DNS_CONFIG_FILE = '/etc/resolv.conf' class DNSValidator: - - def __init__(self, module): - self._dns_server = None - self._dns_resolution_test = False - self._dns_dhcp_server_test = False - self.add_logger(module) - - def add_logger(self, module): - global LOGGER - LOGGER = logger.get_logger(LOG_NAME, module) - - def print_test_results(self): - self.print_test_result( - "DNS resolution test", self._dns_resolution_test) - self.print_test_result( - "DNS DHCP server test", self._dns_dhcp_server_test) - - def print_test_result(self, test_name, result): - LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") - - def validate(self, dhcp_lease): - self._dns_server = dhcp_lease.dns_server - self._set_dns_server() - self._check_dns_traffic() - - def _check_dns_traffic(self): - LOGGER.info("Checking DNS traffic for DNS server: " + self._dns_server) - - # Ping a host to generate DNS traffic - if self._ping(HOST_PING)[0]: - LOGGER.info("Ping success") - self._dns_resolution_test = True - else: - LOGGER.info("Ping failed") - - # Some delay between pings and DNS traffic in the capture file - # so give some delay before we try to query again - time.sleep(5) - - # Check if the device has sent any DNS requests - filter_to_dns = 'dst port 53 and dst host {}'.format( - self._dns_server) - to_dns = self._exec_tcpdump(filter_to_dns) - num_query_dns = len(to_dns) - LOGGER.info("DNS queries found: " + str(num_query_dns)) - dns_traffic_detected = len(to_dns) > 0 - if dns_traffic_detected: - LOGGER.info("DNS traffic detected to configured DHCP DNS server") - self._dns_dhcp_server_test = True - else: - LOGGER.error("No DNS traffic detected") - - # Docker containeres resolve DNS servers from the host - # and do not play nice with normal networking methods - # so we need to set our DNS servers manually - def _set_dns_server(self): - f = open(DNS_CONFIG_FILE, "w", encoding="utf-8") - f.write("nameserver " + self._dns_server) - f.close() - - # Generate DNS traffic by doing a simple ping by hostname - def _ping(self, host): - cmd = "ping -c 5 " + host - success = util.run_command(cmd, LOGGER) - return success - - def _exec_tcpdump(self, tcpdump_filter): - """ + """Validates all expected test behaviors around the DNS server""" + + def __init__(self, module): + self._dns_server = None + self.dns_resolution_test = False + self.dns_dhcp_server_test = False + self.add_logger(module) + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def print_test_results(self): + self.print_test_result('DNS resolution test', self.dns_resolution_test) + self.print_test_result('DNS DHCP server test', self.dns_dhcp_server_test) + + def print_test_result(self, test_name, result): + LOGGER.info(test_name + ': Pass' if result else test_name + ': Fail') + + def validate(self, dhcp_lease): + self._dns_server = dhcp_lease.dns_server + self._set_dns_server() + self._check_dns_traffic() + + def _check_dns_traffic(self): + LOGGER.info('Checking DNS traffic for DNS server: ' + self._dns_server) + + # Ping a host to generate DNS traffic + if self._ping(HOST_PING)[0]: + LOGGER.info('Ping success') + self.dns_resolution_test = True + else: + LOGGER.info('Ping failed') + + # Some delay between pings and DNS traffic in the capture file + # so give some delay before we try to query again + time.sleep(5) + + # Check if the device has sent any DNS requests + filter_to_dns = f'dst port 53 and dst host {self._dns_server}' + to_dns = self._exec_tcpdump(filter_to_dns) + num_query_dns = len(to_dns) + LOGGER.info('DNS queries found: ' + str(num_query_dns)) + dns_traffic_detected = len(to_dns) > 0 + if dns_traffic_detected: + LOGGER.info('DNS traffic detected to configured DHCP DNS server') + self.dns_dhcp_server_test = True + else: + LOGGER.error('No DNS traffic detected') + + # Docker containeres resolve DNS servers from the host + # and do not play nice with normal networking methods + # so we need to set our DNS servers manually + def _set_dns_server(self): + with open(DNS_CONFIG_FILE, 'w', encoding='utf-8') as f: + f.write('nameserver ' + self._dns_server) + + # Generate DNS traffic by doing a simple ping by hostname + def _ping(self, host): + cmd = 'ping -c 5 ' + host + success = util.run_command(cmd, LOGGER) + return success + + def _exec_tcpdump(self, tcpdump_filter): + """ Args tcpdump_filter: Filter to pass onto tcpdump file capture_file: Optional capture file to look Returns List of packets matching the filter """ - command = 'tcpdump -tttt -n -r {} {}'.format( - CAPTURE_FILE, tcpdump_filter) + command = f'tcpdump -tttt -n -r {CAPTURE_FILE} {tcpdump_filter}' - LOGGER.debug("tcpdump command: " + command) + LOGGER.debug('tcpdump command: ' + command) - process = subprocess.Popen(command, - universal_newlines=True, - shell=True, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - text = str(process.stdout.read()).rstrip() + process = subprocess.Popen(command, + universal_newlines=True, + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + text = str(process.stdout.read()).rstrip() - LOGGER.debug("tcpdump response: " + text) + LOGGER.debug('tcpdump response: ' + text) - if text: - return text.split("\n") + if text: + return text.split('\n') - return [] \ No newline at end of file + return [] diff --git a/net_orc/network/devices/faux-dev/python/src/gateway_check.py b/net_orc/network/devices/faux-dev/python/src/gateway_check.py index 17457874a..85fe35db0 100644 --- a/net_orc/network/devices/faux-dev/python/src/gateway_check.py +++ b/net_orc/network/devices/faux-dev/python/src/gateway_check.py @@ -1,40 +1,40 @@ +"""Used to check if the Gateway server is functioning as expected""" + import logger import util -from dhcp_check import DHCPLease - LOGGER = None -LOG_NAME = "gateway_validator" +LOG_NAME = 'gateway_validator' class GatewayValidator: - - def __init__(self, module): - self._gateway = None - self._default_gateway_test = False - self.add_logger(module) - - def add_logger(self, module): - global LOGGER - LOGGER = logger.get_logger(LOG_NAME, module) - - def print_test_results(self): - self.print_test_result("Default gateway test", - self._default_gateway_test) - - def print_test_result(self, test_name, result): - LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") - - - def validate(self, dhcp_lease): - self._gateway = dhcp_lease.gateway - self.check_default_gateway() - - def check_default_gateway(self): - LOGGER.info( - "Checking default gateway matches DHCP gateway: " + self._gateway) - cmd = "/testrun/bin/get_default_gateway" - success, default_gateway, stderr = util.run_command(cmd, LOGGER) - LOGGER.info("Default gateway resolved: " + default_gateway) - if default_gateway == self._gateway: - self._default_gateway_test = True \ No newline at end of file + """Validates all expected test behaviors around the Gateway server""" + + def __init__(self, module): + self._gateway = None + self.default_gateway_test = False + self.add_logger(module) + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def print_test_results(self): + self.print_test_result('Default gateway test', self.default_gateway_test) + + def print_test_result(self, test_name, result): + LOGGER.info(test_name + ': Pass' if result else test_name + ': Fail') + + def validate(self, dhcp_lease): + self._gateway = dhcp_lease.gateway + self.check_default_gateway() + + def check_default_gateway(self): + LOGGER.info('Checking default gateway matches DHCP gateway: ' + + self._gateway) + cmd = '/testrun/bin/get_default_gateway' + success, default_gateway = util.run_command(cmd, LOGGER) + if success: + LOGGER.info('Default gateway resolved: ' + default_gateway) + if default_gateway == self._gateway: + self.default_gateway_test = True diff --git a/net_orc/network/devices/faux-dev/python/src/logger.py b/net_orc/network/devices/faux-dev/python/src/logger.py index bf692c85e..97d7f935a 100644 --- a/net_orc/network/devices/faux-dev/python/src/logger.py +++ b/net_orc/network/devices/faux-dev/python/src/logger.py @@ -1,43 +1,47 @@ -#!/usr/bin/env python3 +"""Sets up the logger to be used for the faux-device.""" import json import logging import os LOGGERS = {} -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' -_CONF_DIR = "conf" -_CONF_FILE_NAME = "system.json" -_LOG_DIR = "/runtime/validation" +_CONF_DIR = 'conf' +_CONF_FILE_NAME = 'system.json' +_LOG_DIR = '/runtime/validation' # Set log level -with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='utf-8') as conf_file: - system_conf_json = json.load(conf_file) +with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), + encoding='utf-8') as conf_file: + system_conf_json = json.load(conf_file) log_level_str = system_conf_json['log_level'] log_level = logging.getLevelName(log_level_str) log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) + def add_file_handler(log, log_file): - """Add file handler to existing log.""" - handler = logging.FileHandler(os.path.join(_LOG_DIR, log_file + ".log")) - handler.setFormatter(log_format) - log.addHandler(handler) + """Add file handler to existing log.""" + handler = logging.FileHandler(os.path.join(_LOG_DIR, log_file + '.log')) + handler.setFormatter(log_format) + log.addHandler(handler) + def add_stream_handler(log): - """Add stream handler to existing log.""" - handler = logging.StreamHandler() - handler.setFormatter(log_format) - log.addHandler(handler) + """Add stream handler to existing log.""" + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + def get_logger(name, log_file=None): - """Return logger for requesting class.""" - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - LOGGERS[name].setLevel(log_level) - add_stream_handler(LOGGERS[name]) - if log_file is not None: - add_file_handler(LOGGERS[name], log_file) - return LOGGERS[name] + """Return logger for requesting class.""" + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if log_file is not None: + add_file_handler(LOGGERS[name], log_file) + return LOGGERS[name] diff --git a/net_orc/network/devices/faux-dev/python/src/ntp_check.py b/net_orc/network/devices/faux-dev/python/src/ntp_check.py index a50bf337e..ceef164c6 100644 --- a/net_orc/network/devices/faux-dev/python/src/ntp_check.py +++ b/net_orc/network/devices/faux-dev/python/src/ntp_check.py @@ -1,3 +1,4 @@ +"""Used to check if the NTP server is functioning as expected""" import time import logger import util @@ -8,72 +9,71 @@ class NTPValidator: - """Perform testing of the NTP server.""" + """Perform testing of the NTP server.""" - def __init__(self, module): - self._ntp_server = None - self._ntp_sync_test = False - self.add_logger(module) + def __init__(self, module): + self._ntp_server = None + self.ntp_sync_test = False + self.add_logger(module) - def add_logger(self, module): - global LOGGER - LOGGER = logger.get_logger(LOG_NAME, module) + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) - def print_test_results(self): - """Print all test results to log.""" - self.print_test_result("NTP sync test", - self._ntp_sync_test) + def print_test_results(self): + """Print all test results to log.""" + self.print_test_result("NTP sync test", self.ntp_sync_test) - def print_test_result(self, test_name, result): - """Output test result to log.""" - LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") + def print_test_result(self, test_name, result): + """Output test result to log.""" + LOGGER.info(test_name + ": Pass" if result else test_name + ": Fail") - def validate(self, dhcp_lease): - """Call NTP sync test.""" - self._ntp_server = dhcp_lease.ntp_server - self.check_ntp() + def validate(self, dhcp_lease): + """Call NTP sync test.""" + self._ntp_server = dhcp_lease.ntp_server + self.check_ntp() - def check_ntp(self): - """Perform NTP sync test.""" - if self._ntp_server is not None: - attempt = 0 - LOGGER.info(f"Attempting to sync to NTP server: {self._ntp_server}") - LOGGER.info("Attempts allowed: " + str(ATTEMPTS)) + def check_ntp(self): + """Perform NTP sync test.""" + if self._ntp_server is not None: + attempt = 0 + LOGGER.info(f"Attempting to sync to NTP server: {self._ntp_server}") + LOGGER.info("Attempts allowed: " + str(ATTEMPTS)) - # If we don't ping before syncing, this will fail. - while attempt < ATTEMPTS and not self._ntp_sync_test: - attempt += 1 - if self.ping_ntp_server(): - self.sync_ntp() - if not self._ntp_sync_test: - LOGGER.info("Waiting 5 seconds before next attempt") - time.sleep(5) - else: - LOGGER.info("No NTP server available from DHCP lease") + # If we don't ping before syncing, this will fail. + while attempt < ATTEMPTS and not self.ntp_sync_test: + attempt += 1 + if self.ping_ntp_server(): + self.sync_ntp() + if not self.ntp_sync_test: + LOGGER.info("Waiting 5 seconds before next attempt") + time.sleep(5) + else: + LOGGER.info("No NTP server available from DHCP lease") - def sync_ntp(self): - """Send NTP request to server.""" - LOGGER.info("Sending NTP Sync Request to: " + self._ntp_server) - cmd = "ntpdate " + self._ntp_server - ntp_response = util.run_command(cmd, LOGGER)[1] - LOGGER.info("NTP sync response: " + ntp_response) - if "adjust time server " + self._ntp_server in ntp_response: - LOGGER.info("NTP sync succesful") - self._ntp_sync_test = True - else: - LOGGER.info("NTP client failed to sync to server") + def sync_ntp(self): + """Send NTP request to server.""" + LOGGER.info("Sending NTP Sync Request to: " + self._ntp_server) + cmd = "ntpdate " + self._ntp_server + ntp_response = util.run_command(cmd, LOGGER)[1] + LOGGER.info("NTP sync response: " + ntp_response) + if "adjust time server " + self._ntp_server in ntp_response: + LOGGER.info("NTP sync succesful") + self.ntp_sync_test = True + else: + LOGGER.info("NTP client failed to sync to server") - def ping_ntp_server(self): - """Ping NTP server before sending a time request.""" - LOGGER.info("Pinging NTP server before syncing...") - if self.ping(self._ntp_server): - LOGGER.info("NTP server successfully pinged") - return True - LOGGER.info("NTP server did not respond to ping") - return False + def ping_ntp_server(self): + """Ping NTP server before sending a time request.""" + LOGGER.info("Pinging NTP server before syncing...") + if self.ping(self._ntp_server): + LOGGER.info("NTP server successfully pinged") + return True + LOGGER.info("NTP server did not respond to ping") + return False - def ping(self, host): - """Send ping request to host.""" - cmd = "ping -c 1 " + host - success = util.run_command(cmd, LOGGER) - return success + def ping(self, host): + """Send ping request to host.""" + cmd = "ping -c 1 " + host + success = util.run_command(cmd, LOGGER) + return success diff --git a/net_orc/network/devices/faux-dev/python/src/run.py b/net_orc/network/devices/faux-dev/python/src/run.py index 5891b8c4b..062a1a643 100644 --- a/net_orc/network/devices/faux-dev/python/src/run.py +++ b/net_orc/network/devices/faux-dev/python/src/run.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python3 +"""Used to run all the various validator modules for the faux-device""" import argparse import json @@ -15,100 +15,111 @@ RESULTS_DIR = '/runtime/validation/' LOGGER = logger.get_logger('validator') + class FauxDevice: - """Represents a virtual testing device.""" - - def __init__(self, module): - - signal.signal(signal.SIGINT, self._handler) - signal.signal(signal.SIGTERM, self._handler) - signal.signal(signal.SIGABRT, self._handler) - signal.signal(signal.SIGQUIT, self._handler) - - self.dhcp_validator = DHCPValidator(module) - self.dns_validator = DNSValidator(module) - self.gateway_validator = GatewayValidator(module) - self.ntp_validator = NTPValidator(module) - - self._module = module - self.run_tests() - results = self.generate_results() - self.write_results(results) - - def run_tests(self): - """Execute configured network tests.""" - - # Run DHCP tests first since everything hinges on basic DHCP compliance first - self.dhcp_validator.validate() - - dhcp_lease = self.dhcp_validator.get_dhcp_lease() - - # Use current lease from dhcp tests to validate DNS behaviors - self.dns_validator.validate(dhcp_lease) - - # Use current lease from dhcp tests to validate default gateway - self.gateway_validator.validate(dhcp_lease) - - # Use current lease from dhcp tests to validate ntp server - self.ntp_validator.validate(dhcp_lease) - - def print_test_results(self): - """Print test results to log.""" - self.dhcp_validator.print_test_results() - self.dns_validator.print_test_results() - self.gateway_validator.print_test_results() - self.ntp_validator.print_test_results() - - def generate_results(self): - """Transform test results into JSON format.""" - - results = [] - results.append(self.generate_result("dhcp_lease", self.dhcp_validator.dhcp_lease_test)) - results.append(self.generate_result("dns_from_dhcp", self.dns_validator._dns_dhcp_server_test)) - results.append(self.generate_result("dns_resolution", self.dns_validator._dns_resolution_test)) - results.append(self.generate_result("gateway_default", self.gateway_validator._default_gateway_test)) - results.append(self.generate_result("ntp_sync", self.ntp_validator._ntp_sync_test)) - json_results = json.dumps({"results":results}, indent=2) - - return json_results - - def write_results(self, results): - """Write test results to file.""" - results_file = os.path.join(RESULTS_DIR, "result.json") - LOGGER.info("Writing results to " + results_file) - f = open(results_file, "w", encoding="utf-8") - f.write(results) - f.close() - - def generate_result(self, test_name, test_result): - """Return JSON object for test result.""" - if test_result is not None: - result = "compliant" if test_result else "non-compliant" - else: - result = "skipped" - LOGGER.info(test_name + ": " + result) - res_dict = { - "name": test_name, - "result": result - } - return res_dict - - def _handler(self, signum, frame): # pylint: disable=unused-argument - if signum in (2, signal.SIGTERM): - sys.exit(1) - -def run(argv): # pylint: disable=unused-argument - """Run the network validator.""" - parser = argparse.ArgumentParser(description="Faux Device _validator", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-m","--module", - help="Define the module name to be used to create the log file") - - args = parser.parse_args() - - # For some reason passing in the args from bash adds an extra - # space before the argument so we'll just strip out extra space - FauxDevice(args.module.strip()) - -if __name__ == "__main__": - run(sys.argv) + """Represents a virtual testing device.""" + + def __init__(self, module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + + self.dhcp_validator = DHCPValidator(module) + self.dns_validator = DNSValidator(module) + self.gateway_validator = GatewayValidator(module) + self.ntp_validator = NTPValidator(module) + + self._module = module + self.run_tests() + results = self.generate_results() + self.write_results(results) + + def run_tests(self): + """Execute configured network tests.""" + + # Run DHCP tests first since everything hinges + # on basic DHCP compliance first + self.dhcp_validator.validate() + + dhcp_lease = self.dhcp_validator.get_dhcp_lease() + + # Use current lease from dhcp tests to validate DNS behaviors + self.dns_validator.validate(dhcp_lease) + + # Use current lease from dhcp tests to validate default gateway + self.gateway_validator.validate(dhcp_lease) + + # Use current lease from dhcp tests to validate ntp server + self.ntp_validator.validate(dhcp_lease) + + def print_test_results(self): + """Print test results to log.""" + self.dhcp_validator.print_test_results() + self.dns_validator.print_test_results() + self.gateway_validator.print_test_results() + self.ntp_validator.print_test_results() + + def generate_results(self): + """Transform test results into JSON format.""" + + results = [] + results.append( + self.generate_result('dhcp_lease', self.dhcp_validator.dhcp_lease_test)) + results.append( + self.generate_result('dns_from_dhcp', + self.dns_validator.dns_dhcp_server_test)) + results.append( + self.generate_result('dns_resolution', + self.dns_validator.dns_resolution_test)) + results.append( + self.generate_result('gateway_default', + self.gateway_validator.default_gateway_test)) + results.append( + self.generate_result('ntp_sync', self.ntp_validator.ntp_sync_test)) + json_results = json.dumps({'results': results}, indent=2) + + return json_results + + def write_results(self, results): + """Write test results to file.""" + results_file = os.path.join(RESULTS_DIR, 'result.json') + LOGGER.info('Writing results to ' + results_file) + with open(results_file, 'w', encoding='utf-8') as f: + f.write(results) + + def generate_result(self, test_name, test_result): + """Return JSON object for test result.""" + if test_result is not None: + result = 'compliant' if test_result else 'non-compliant' + else: + result = 'skipped' + LOGGER.info(test_name + ': ' + result) + res_dict = {'name': test_name, 'result': result} + return res_dict + + def _handler(self, signum, frame): # pylint: disable=unused-argument + if signum in (2, signal.SIGTERM): + sys.exit(1) + + +def run(argv): # pylint: disable=unused-argument + """Run the network validator.""" + parser = argparse.ArgumentParser( + description='Faux Device _validator', + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument( + '-m', + '--module', + help='Define the module name to be used to create the log file') + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + FauxDevice(args.module.strip()) + + +if __name__ == '__main__': + run(sys.argv) diff --git a/net_orc/network/devices/faux-dev/python/src/util.py b/net_orc/network/devices/faux-dev/python/src/util.py index 605af1132..6848206b4 100644 --- a/net_orc/network/devices/faux-dev/python/src/util.py +++ b/net_orc/network/devices/faux-dev/python/src/util.py @@ -1,3 +1,4 @@ +"""Provides basic utilities for the faux-device.""" import subprocess import shlex @@ -10,19 +11,20 @@ def run_command(cmd, logger, output=True): - success = False - process = subprocess.Popen(shlex.split( - cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE) - stdout, stderr = process.communicate() + success = False + process = subprocess.Popen(shlex.split(cmd), + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + stdout, stderr = process.communicate() - if process.returncode != 0: - err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) - logger.error("Command Failed: " + cmd) - logger.error("Error: " + err_msg) - else: - success = True + if process.returncode != 0: + err_msg = f'{stderr.strip()}. Code: {process.returncode}' + logger.error('Command Failed: ' + cmd) + logger.error('Error: ' + err_msg) + else: + success = True - if output: - return success, stdout.strip().decode('utf-8'), stderr - else: - return success, None, stderr + if output: + return success, stdout.strip().decode('utf-8') + else: + return success, None diff --git a/net_orc/network/modules/base/python/src/grpc/start_server.py b/net_orc/network/modules/base/python/src/grpc/start_server.py index 9ed31ffcf..b4016c831 100644 --- a/net_orc/network/modules/base/python/src/grpc/start_server.py +++ b/net_orc/network/modules/base/python/src/grpc/start_server.py @@ -1,34 +1,37 @@ +"""Base class for starting the gRPC server for a network module.""" from concurrent import futures import grpc import proto.grpc_pb2_grpc as pb2_grpc -import proto.grpc_pb2 as pb2 from network_service import NetworkService -import logging -import sys import argparse DEFAULT_PORT = '5001' -def serve(PORT): - server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) - pb2_grpc.add_NetworkModuleServicer_to_server(NetworkService(), server) - server.add_insecure_port('[::]:' + PORT) - server.start() - server.wait_for_termination() -def run(argv): - parser = argparse.ArgumentParser(description="GRPC Server for Network Module", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-p", "--port", default=DEFAULT_PORT, - help="Define the default port to run the server on.") +def serve(port): + server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) + pb2_grpc.add_NetworkModuleServicer_to_server(NetworkService(), server) + server.add_insecure_port('[::]:' + port) + server.start() + server.wait_for_termination() - args = parser.parse_args() - PORT = args.port +def run(): + parser = argparse.ArgumentParser( + description='GRPC Server for Network Module', + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument('-p', + '--port', + default=DEFAULT_PORT, + help='Define the default port to run the server on.') - print("gRPC server starting on port " + PORT) - serve(PORT) + args = parser.parse_args() + port = args.port -if __name__ == "__main__": - run(sys.argv) \ No newline at end of file + print('gRPC server starting on port ' + port) + serve(port) + + +if __name__ == '__main__': + run() diff --git a/net_orc/network/modules/base/python/src/logger.py b/net_orc/network/modules/base/python/src/logger.py index 4924512c6..abec00f69 100644 --- a/net_orc/network/modules/base/python/src/logger.py +++ b/net_orc/network/modules/base/python/src/logger.py @@ -1,47 +1,48 @@ -#!/usr/bin/env python3 - +"""Sets up the logger to be used for the network modules.""" import json import logging import os LOGGERS = {} -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' _DEFAULT_LEVEL = logging.INFO -_CONF_DIR = "conf" -_CONF_FILE_NAME = "system.json" -_LOG_DIR = "/runtime/network/" +_CONF_DIR = 'conf' +_CONF_FILE_NAME = 'system.json' +_LOG_DIR = '/runtime/network/' # Set log level try: - system_conf_json = json.load( - open(os.path.join(_CONF_DIR, _CONF_FILE_NAME))) - log_level_str = system_conf_json['log_level'] - log_level = logging.getLevelName(log_level_str) -except: - # TODO: Print out warning that log level is incorrect or missing - log_level = _DEFAULT_LEVEL + with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), + encoding='UTF-8') as config_json_file: + system_conf_json = json.load(config_json_file) + + log_level_str = system_conf_json['log_level'] + log_level = logging.getLevelName(log_level_str) +except OSError: + # TODO: Print out warning that log level is incorrect or missing + LOG_LEVEL = _DEFAULT_LEVEL log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) -def add_file_handler(log, logFile): - handler = logging.FileHandler(_LOG_DIR+logFile+".log") - handler.setFormatter(log_format) - log.addHandler(handler) +def add_file_handler(log, log_file): + handler = logging.FileHandler(_LOG_DIR + log_file + '.log') + handler.setFormatter(log_format) + log.addHandler(handler) def add_stream_handler(log): - handler = logging.StreamHandler() - handler.setFormatter(log_format) - log.addHandler(handler) - - -def get_logger(name, logFile=None): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - LOGGERS[name].setLevel(log_level) - add_stream_handler(LOGGERS[name]) - if logFile is not None: - add_file_handler(LOGGERS[name], logFile) - return LOGGERS[name] + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + + +def get_logger(name, log_file=None): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if log_file is not None: + add_file_handler(LOGGERS[name], log_file) + return LOGGERS[name] diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py b/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py index f5445ca44..23e1b4047 100644 --- a/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py +++ b/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py @@ -1,101 +1,106 @@ +"""Contains all the necessary classes to maintain the +DHCP server's configuration""" import re -CONFIG_FILE = "/etc/dhcp/dhcpd.conf" -CONFIG_FILE_TEST = "network/modules/dhcp-1/conf/dhcpd.conf" +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' +CONFIG_FILE_TEST = 'network/modules/dhcp-1/conf/dhcpd.conf' -DEFAULT_LEASE_TIME_KEY = "default-lease-time" +DEFAULT_LEASE_TIME_KEY = 'default-lease-time' class DHCPConfig: - - def __init__(self): - self._default_lease_time = 300 - self._subnets = [] - self._peer = None - - def write_config(self): - conf = str(self) - print("Writing config: \n" + conf) - f = open(CONFIG_FILE, "w") - f.write(conf) - - def resolve_config(self): - with open(CONFIG_FILE) as f: - conf = f.read() - self.resolve_subnets(conf) - self.peer = DHCPFailoverPeer(conf) - - def resolve_subnets(self, conf): - self._subnets = [] - regex = r"(subnet.*)" - subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) - for subnet in subnets: - dhcp_subnet = DHCPSubnet(subnet) - self._subnets.append(dhcp_subnet) - - def set_range(self, start, end, subnet=0, pool=0): - print("Setting Range for pool ") - print(self._subnets[subnet]._pools[pool]) - self._subnets[subnet]._pools[pool]._range_start = start - self._subnets[subnet]._pools[pool]._range_end = end - - def resolve_settings(self, conf): - lines = conf.split("\n") - for line in lines: - if DEFAULT_LEASE_TIME_KEY in line: - self._default_lease_time = line.strip().split(DEFAULT_LEASE_TIME_KEY)[ - 1].strip().split(";")[0] - - self.peer = peer - - def __str__(self): - - config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" - - config = config.format(length='multi-line', - DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, DEFAULT_LEASE_TIME=self._default_lease_time - ) - - config += "\n\n"+str(self.peer) - for subnet in self._subnets: - config += "\n\n"+str(subnet) - return str(config) - - -FAILOVER_PEER_KEY = "failover peer" -PRIMARY_KEY = "primary" -ADDRESS_KEY = "address" -PORT_KEY = "port" -PEER_ADDRESS_KEY = "peer address" -PEER_PORT_KEY = "peer port" -MAX_RESPONSE_DELAY_KEY = "max-response-delay" -MAX_UNACKED_UPDATES_KEY = "max-unacked-updates" -MCLT_KEY = "mclt" -SPLIT_KEY = "split" -LOAD_BALANCE_MAX_SECONDS_KEY = "load balance max seconds" + """Represents the DHCP Servers configuration and gives access to modify it""" + + def __init__(self): + self._default_lease_time = 300 + self.subnets = [] + self._peer = None + + def write_config(self): + conf = str(self) + print('Writing config: \n' + conf) + with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: + conf_file.write(conf) + + def resolve_config(self): + with open(CONFIG_FILE, 'r', encoding='UTF-8') as f: + conf = f.read() + self.resolve_subnets(conf) + self._peer = DHCPFailoverPeer(conf) + + def resolve_subnets(self, conf): + self.subnets = [] + regex = r'(subnet.*)' + subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) + for subnet in subnets: + dhcp_subnet = DHCPSubnet(subnet) + self.subnets.append(dhcp_subnet) + + def set_range(self, start, end, subnet=0, pool=0): + print('Setting Range for pool ') + print(self.subnets[subnet].pools[pool]) + self.subnets[subnet].pools[pool].range_start = start + self.subnets[subnet].pools[pool].range_end = end + + # def resolve_settings(self, conf): + # lines = conf.split('\n') + # for line in lines: + # if DEFAULT_LEASE_TIME_KEY in line: + # self._default_lease_time = line.strip().split( + # DEFAULT_LEASE_TIME_KEY)[1].strip().split(';')[0] + + # self.peer = peer + + def __str__(self): + + config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + + config = config.format(length='multi-line', + DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, + DEFAULT_LEASE_TIME=self._default_lease_time) + + config += '\n\n' + str(self.peer) + for subnet in self._subnets: + config += '\n\n' + str(subnet) + return str(config) + + +FAILOVER_PEER_KEY = 'failover peer' +PRIMARY_KEY = 'primary' +ADDRESS_KEY = 'address' +PORT_KEY = 'port' +PEER_ADDRESS_KEY = 'peer address' +PEER_PORT_KEY = 'peer port' +MAX_RESPONSE_DELAY_KEY = 'max-response-delay' +MAX_UNACKED_UPDATES_KEY = 'max-unacked-updates' +MCLT_KEY = 'mclt' +SPLIT_KEY = 'split' +LOAD_BALANCE_MAX_SECONDS_KEY = 'load balance max seconds' class DHCPFailoverPeer: - def __init__(self, config): - self.name = None - self.primary = False - self.address = None - self.port = None - self.peer_address = None - self.peer_port = None - self.max_response_delay = None - self.max_unacked_updates = None - self.mclt = None - self.split = None - self.load_balance_max_seconds = None - self.peer = None - - self.resolve_peer(config) - - def __str__(self): - config = "{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n" - config += "\tprimary;" if self.primary else "secondary;" - config += """\n\t{ADDRESS_KEY} {ADDRESS}; + """Contains all information to define the DHCP failover peer""" + + def __init__(self, config): + self.name = None + self.primary = False + self.address = None + self.port = None + self.peer_address = None + self.peer_port = None + self.max_response_delay = None + self.max_unacked_updates = None + self.mclt = None + self.split = None + self.load_balance_max_seconds = None + self.peer = None + + self.resolve_peer(config) + + def __str__(self): + config = '{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n' + config += '\tprimary;' if self.primary else 'secondary;' + config += """\n\t{ADDRESS_KEY} {ADDRESS}; {PORT_KEY} {PORT}; {PEER_ADDRESS_KEY} {PEER_ADDRESS}; {PEER_PORT_KEY} {PEER_PORT}; @@ -106,162 +111,179 @@ def __str__(self): {LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS}; \r}}""" - return config.format(length='multi-line', - FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, FAILOVER_PEER=self.name, - ADDRESS_KEY=ADDRESS_KEY, ADDRESS=self.address, - PORT_KEY=PORT_KEY, PORT=self.port, - PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, PEER_ADDRESS=self.peer_address, - PEER_PORT_KEY=PEER_PORT_KEY, PEER_PORT=self.peer_port, - MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, MAX_RESPONSE_DELAY=self.max_response_delay, - MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, MAX_UNACKED_UPDATES=self.max_unacked_updates, - MCLT_KEY=MCLT_KEY, MCLT=self.mclt, - SPLIT_KEY=SPLIT_KEY, SPLIT=self.split, - LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds - ) - - def resolve_peer(self, conf): - peer = "" - lines = conf.split("\n") - for line in lines: - if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: - if(len(peer) <= 0): - self.name = line.strip().split(FAILOVER_PEER_KEY)[ - 1].strip().split("{")[0].split("\"")[1] - peer += line+"\n" - if PRIMARY_KEY in line: - self.primary = True - elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: - self.address = line.strip().split(ADDRESS_KEY)[ - 1].strip().split(";")[0] - elif PORT_KEY in line and PEER_PORT_KEY not in line: - self.port = line.strip().split(PORT_KEY)[ - 1].strip().split(";")[0] - elif PEER_ADDRESS_KEY in line: - self.peer_address = line.strip().split(PEER_ADDRESS_KEY)[ - 1].strip().split(";")[0] - elif PEER_PORT_KEY in line: - self.peer_port = line.strip().split(PEER_PORT_KEY)[ - 1].strip().split(";")[0] - elif MAX_RESPONSE_DELAY_KEY in line: - self.max_response_delay = line.strip().split(MAX_RESPONSE_DELAY_KEY)[ - 1].strip().split(";")[0] - elif MAX_UNACKED_UPDATES_KEY in line: - self.max_unacked_updates = line.strip().split(MAX_UNACKED_UPDATES_KEY)[ - 1].strip().split(";")[0] - elif MCLT_KEY in line: - self.mclt = line.strip().split(MCLT_KEY)[ - 1].strip().split(";")[0] - elif SPLIT_KEY in line: - self.split = line.strip().split(SPLIT_KEY)[ - 1].strip().split(";")[0] - elif LOAD_BALANCE_MAX_SECONDS_KEY in line: - self.load_balance_max_seconds = line.strip().split(LOAD_BALANCE_MAX_SECONDS_KEY)[ - 1].strip().split(";")[0] - if line.endswith("}") and len(peer) > 0: - break - self.peer = peer - - -NTP_OPTION_KEY = "option ntp-servers" -SUBNET_MASK_OPTION_KEY = "option subnet-mask" -BROADCAST_OPTION_KEY = "option broadcast-address" -ROUTER_OPTION_KEY = "option routers" -DNS_OPTION_KEY = "option domain-name-servers" + return config.format( + length='multi-line', + FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, + FAILOVER_PEER=self.name, + ADDRESS_KEY=ADDRESS_KEY, + ADDRESS=self.address, + PORT_KEY=PORT_KEY, + PORT=self.port, + PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, + PEER_ADDRESS=self.peer_address, + PEER_PORT_KEY=PEER_PORT_KEY, + PEER_PORT=self.peer_port, + MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, + MAX_RESPONSE_DELAY=self.max_response_delay, + MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, + MAX_UNACKED_UPDATES=self.max_unacked_updates, + MCLT_KEY=MCLT_KEY, + MCLT=self.mclt, + SPLIT_KEY=SPLIT_KEY, + SPLIT=self.split, + LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, + LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds) + + def resolve_peer(self, conf): + peer = '' + lines = conf.split('\n') + for line in lines: + if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: + if len(peer) <= 0: + self.name = line.strip().split(FAILOVER_PEER_KEY)[1].strip().split( + '{')[0].split('\"')[1] + peer += line + '\n' + if PRIMARY_KEY in line: + self.primary = True + elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: + self.address = line.strip().split(ADDRESS_KEY)[1].strip().split( + ';')[0] + elif PORT_KEY in line and PEER_PORT_KEY not in line: + self.port = line.strip().split(PORT_KEY)[1].strip().split(';')[0] + elif PEER_ADDRESS_KEY in line: + self.peer_address = line.strip().split( + PEER_ADDRESS_KEY)[1].strip().split(';')[0] + elif PEER_PORT_KEY in line: + self.peer_port = line.strip().split(PEER_PORT_KEY)[1].strip().split( + ';')[0] + elif MAX_RESPONSE_DELAY_KEY in line: + self.max_response_delay = line.strip().split( + MAX_RESPONSE_DELAY_KEY)[1].strip().split(';')[0] + elif MAX_UNACKED_UPDATES_KEY in line: + self.max_unacked_updates = line.strip().split( + MAX_UNACKED_UPDATES_KEY)[1].strip().split(';')[0] + elif MCLT_KEY in line: + self.mclt = line.strip().split(MCLT_KEY)[1].strip().split(';')[0] + elif SPLIT_KEY in line: + self.split = line.strip().split(SPLIT_KEY)[1].strip().split(';')[0] + elif LOAD_BALANCE_MAX_SECONDS_KEY in line: + self.load_balance_max_seconds = line.strip().split( + LOAD_BALANCE_MAX_SECONDS_KEY)[1].strip().split(';')[0] + if line.endswith('}') and len(peer) > 0: + break + self.peer = peer + + +NTP_OPTION_KEY = 'option ntp-servers' +SUBNET_MASK_OPTION_KEY = 'option subnet-mask' +BROADCAST_OPTION_KEY = 'option broadcast-address' +ROUTER_OPTION_KEY = 'option routers' +DNS_OPTION_KEY = 'option domain-name-servers' class DHCPSubnet: - def __init__(self, subnet): - self._ntp_servers = None - self._subnet_mask = None - self._broadcast = None - self._routers = None - self._dns_servers = None - self._pools = [] - - self.resolve_subnet(subnet) - self.resolve_pools(subnet) - - def __str__(self): - config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ + """Represents the DHCP Servers subnet configuration""" + + def __init__(self, subnet): + self._ntp_servers = None + self._subnet_mask = None + self._broadcast = None + self._routers = None + self._dns_servers = None + self.pools = [] + + self.resolve_subnet(subnet) + self.resolve_pools(subnet) + + def __str__(self): + config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ \r\t{NTP_OPTION_KEY} {NTP_OPTION}; \r\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION}; \r\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION}; \r\t{ROUTER_OPTION_KEY} {ROUTER_OPTION}; \r\t{DNS_OPTION_KEY} {DNS_OPTION};""" - config = config.format(length='multi-line', - NTP_OPTION_KEY=NTP_OPTION_KEY, NTP_OPTION=self._ntp_servers, - SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, SUBNET_MASK_OPTION=self._subnet_mask, - BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, BROADCAST_OPTION=self._broadcast, - ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, ROUTER_OPTION=self._routers, - DNS_OPTION_KEY=DNS_OPTION_KEY, DNS_OPTION=self._dns_servers - ) - for pool in self._pools: - config += "\n\t"+str(pool) - - config += "\n\r}" - return config - - def resolve_subnet(self, subnet): - subnet_parts = subnet.split("\n") - for part in subnet_parts: - if NTP_OPTION_KEY in part: - self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[ - 1].strip().split(";")[0] - elif SUBNET_MASK_OPTION_KEY in part: - self._subnet_mask = part.strip().split(SUBNET_MASK_OPTION_KEY)[ - 1].strip().split(";")[0] - elif BROADCAST_OPTION_KEY in part: - self._broadcast = part.strip().split(BROADCAST_OPTION_KEY)[ - 1].strip().split(";")[0] - elif ROUTER_OPTION_KEY in part: - self._routers = part.strip().split(ROUTER_OPTION_KEY)[ - 1].strip().split(";")[0] - elif DNS_OPTION_KEY in part: - self._dns_servers = part.strip().split(DNS_OPTION_KEY)[ - 1].strip().split(";")[0] - - def resolve_pools(self, subnet): - regex = r"(pool.*)\}" - pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) - for pool in pools: - dhcp_pool = DHCPPool(pool) - self._pools.append(dhcp_pool) - - -FAILOVER_KEY = "failover peer" -RANGE_KEY = "range" + config = config.format(length='multi-line', + NTP_OPTION_KEY=NTP_OPTION_KEY, + NTP_OPTION=self._ntp_servers, + SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, + SUBNET_MASK_OPTION=self._subnet_mask, + BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, + BROADCAST_OPTION=self._broadcast, + ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, + ROUTER_OPTION=self._routers, + DNS_OPTION_KEY=DNS_OPTION_KEY, + DNS_OPTION=self._dns_servers) + for pool in self.pools: + config += '\n\t' + str(pool) + + config += '\n\r}' + return config + + def resolve_subnet(self, subnet): + subnet_parts = subnet.split('\n') + for part in subnet_parts: + if NTP_OPTION_KEY in part: + self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[1].strip().split( + ';')[0] + elif SUBNET_MASK_OPTION_KEY in part: + self._subnet_mask = part.strip().split( + SUBNET_MASK_OPTION_KEY)[1].strip().split(';')[0] + elif BROADCAST_OPTION_KEY in part: + self._broadcast = part.strip().split( + BROADCAST_OPTION_KEY)[1].strip().split(';')[0] + elif ROUTER_OPTION_KEY in part: + self._routers = part.strip().split(ROUTER_OPTION_KEY)[1].strip().split( + ';')[0] + elif DNS_OPTION_KEY in part: + self._dns_servers = part.strip().split(DNS_OPTION_KEY)[1].strip().split( + ';')[0] + + def resolve_pools(self, subnet): + regex = r'(pool.*)\}' + pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) + for pool in pools: + dhcp_pool = DHCPPool(pool) + self.pools.append(dhcp_pool) + + +FAILOVER_KEY = 'failover peer' +RANGE_KEY = 'range' class DHCPPool: + """Represents a DHCP Servers subnet pool configuration""" - def __init__(self, pool): - self._failover_peer = None - self._range_start = None - self._range_end = None - self.resolve_pool(pool) + def __init__(self, pool): + self.failover_peer = None + self.range_start = None + self.range_end = None + self.resolve_pool(pool) - def __str__(self): + def __str__(self): - config = """pool {{ + config = """pool {{ \r\t\t{FAILOVER_KEY} "{FAILOVER}"; \r\t\t{RANGE_KEY} {RANGE_START} {RANGE_END}; \r\t}}""" - return config.format(length='multi-line', - FAILOVER_KEY=FAILOVER_KEY, FAILOVER=self._failover_peer, - RANGE_KEY=RANGE_KEY, RANGE_START=self._range_start, RANGE_END=self._range_end, - ) - - def resolve_pool(self, pool): - pool_parts = pool.split("\n") - # pool_parts = pool.split("\n") - for part in pool_parts: - if FAILOVER_KEY in part: - self._failover_peer = part.strip().split( - FAILOVER_KEY)[1].strip().split(";")[0].replace("\"", "") - if RANGE_KEY in part: - range = part.strip().split(RANGE_KEY)[ - 1].strip().split(";")[0] - self._range_start = range.split(" ")[0].strip() - self._range_end = range.split(" ")[1].strip() + return config.format( + length='multi-line', + FAILOVER_KEY=FAILOVER_KEY, + FAILOVER=self.failover_peer, + RANGE_KEY=RANGE_KEY, + RANGE_START=self.range_start, + RANGE_END=self.range_end, + ) + + def resolve_pool(self, pool): + pool_parts = pool.split('\n') + # pool_parts = pool.split("\n") + for part in pool_parts: + if FAILOVER_KEY in part: + self.failover_peer = part.strip().split(FAILOVER_KEY)[1].strip().split( + ';')[0].replace('\"', '') + if RANGE_KEY in part: + pool_range = part.strip().split(RANGE_KEY)[1].strip().split(';')[0] + self.range_start = pool_range.split(' ')[0].strip() + self.range_end = pool_range.split(' ')[1].strip() diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py b/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py index f90cb6b51..49732b362 100644 --- a/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py +++ b/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py @@ -1,3 +1,4 @@ +"""gRPC Network Service for the DHCP Server network module""" import proto.grpc_pb2_grpc as pb2_grpc import proto.grpc_pb2 as pb2 @@ -5,40 +6,39 @@ class NetworkService(pb2_grpc.NetworkModule): + """gRPC endpoints for the DHCP Server""" - def __init__(self): - self._dhcp_config = DHCPConfig() + def __init__(self): + self._dhcp_config = DHCPConfig() + def GetDHCPRange(self, request, context): # pylint: disable=W0613 """ - Resolve the current DHCP configuration and return - the first range from the first subnet in the file - """ - - def GetDHCPRange(self, request, context): - self._dhcp_config.resolve_config() - pool = self._dhcp_config._subnets[0]._pools[0] - return pb2.DHCPRange(code=200, start=pool._range_start, end=pool._range_end) + Resolve the current DHCP configuration and return + the first range from the first subnet in the file + """ + self._dhcp_config.resolve_config() + pool = self._dhcp_config.subnets[0].pools[0] + return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) + def SetDHCPRange(self, request, context): # pylint: disable=W0613 + """ + Change DHCP configuration and set the + the first range from the first subnet in the configuration """ - Change DHCP configuration and set the - the first range from the first subnet in the configuration - """ - - def SetDHCPRange(self, request, context): - print("Setting DHCPRange") - print("Start: " + request.start) - print("End: " + request.end) - self._dhcp_config.resolve_config() - self._dhcp_config.set_range(request.start, request.end, 0, 0) - self._dhcp_config.write_config() - return pb2.Response(code=200, message="DHCP Range Set") + print('Setting DHCPRange') + print('Start: ' + request.start) + print('End: ' + request.end) + self._dhcp_config.resolve_config() + self._dhcp_config.set_range(request.start, request.end, 0, 0) + self._dhcp_config.write_config() + return pb2.Response(code=200, message='DHCP Range Set') + + def GetStatus(self, request, context): # pylint: disable=W0613 + """ + Return the current status of the network module """ - Return the current status of the network module - """ - - def GetStatus(self, request, context): - # ToDo: Figure out how to resolve the current DHCP status - dhcpStatus = True - message = str({"dhcpStatus":dhcpStatus}) - return pb2.Response(code=200, message=message) + # ToDo: Figure out how to resolve the current DHCP status + dhcp_status = True + message = str({'dhcpStatus': dhcp_status}) + return pb2.Response(code=200, message=message) diff --git a/net_orc/network/modules/dhcp-1/python/src/run.py b/net_orc/network/modules/dhcp-1/python/src/run.py deleted file mode 100644 index 830f048cf..000000000 --- a/net_orc/network/modules/dhcp-1/python/src/run.py +++ /dev/null @@ -1,40 +0,0 @@ -#!/usr/bin/env python3 - -import signal -import sys -import argparse - -from grpc.dhcp_config import DHCPConfig - - -class DHCPServer: - - def __init__(self, module): - - signal.signal(signal.SIGINT, self.handler) - signal.signal(signal.SIGTERM, self.handler) - signal.signal(signal.SIGABRT, self.handler) - signal.signal(signal.SIGQUIT, self.handler) - - config = DHCPConfig() - config.resolve_config() - config.write_config() - - def handler(self, signum, frame): - if (signum == 2 or signal == signal.SIGTERM): - exit(1) - - -def run(argv): - parser = argparse.ArgumentParser(description="Faux Device Validator", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument( - "-m", "--module", help="Define the module name to be used to create the log file") - - args = parser.parse_args() - - server = DHCPServer(args.module) - - -if __name__ == "__main__": - run(sys.argv) diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py b/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py index f5445ca44..1d93c2d34 100644 --- a/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py +++ b/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py @@ -1,101 +1,106 @@ +"""Contains all the necessary classes to maintain the +DHCP server's configuration""" import re -CONFIG_FILE = "/etc/dhcp/dhcpd.conf" -CONFIG_FILE_TEST = "network/modules/dhcp-1/conf/dhcpd.conf" +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' +CONFIG_FILE_TEST = 'network/modules/dhcp-2/conf/dhcpd.conf' -DEFAULT_LEASE_TIME_KEY = "default-lease-time" +DEFAULT_LEASE_TIME_KEY = 'default-lease-time' class DHCPConfig: - - def __init__(self): - self._default_lease_time = 300 - self._subnets = [] - self._peer = None - - def write_config(self): - conf = str(self) - print("Writing config: \n" + conf) - f = open(CONFIG_FILE, "w") - f.write(conf) - - def resolve_config(self): - with open(CONFIG_FILE) as f: - conf = f.read() - self.resolve_subnets(conf) - self.peer = DHCPFailoverPeer(conf) - - def resolve_subnets(self, conf): - self._subnets = [] - regex = r"(subnet.*)" - subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) - for subnet in subnets: - dhcp_subnet = DHCPSubnet(subnet) - self._subnets.append(dhcp_subnet) - - def set_range(self, start, end, subnet=0, pool=0): - print("Setting Range for pool ") - print(self._subnets[subnet]._pools[pool]) - self._subnets[subnet]._pools[pool]._range_start = start - self._subnets[subnet]._pools[pool]._range_end = end - - def resolve_settings(self, conf): - lines = conf.split("\n") - for line in lines: - if DEFAULT_LEASE_TIME_KEY in line: - self._default_lease_time = line.strip().split(DEFAULT_LEASE_TIME_KEY)[ - 1].strip().split(";")[0] - - self.peer = peer - - def __str__(self): - - config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" - - config = config.format(length='multi-line', - DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, DEFAULT_LEASE_TIME=self._default_lease_time - ) - - config += "\n\n"+str(self.peer) - for subnet in self._subnets: - config += "\n\n"+str(subnet) - return str(config) - - -FAILOVER_PEER_KEY = "failover peer" -PRIMARY_KEY = "primary" -ADDRESS_KEY = "address" -PORT_KEY = "port" -PEER_ADDRESS_KEY = "peer address" -PEER_PORT_KEY = "peer port" -MAX_RESPONSE_DELAY_KEY = "max-response-delay" -MAX_UNACKED_UPDATES_KEY = "max-unacked-updates" -MCLT_KEY = "mclt" -SPLIT_KEY = "split" -LOAD_BALANCE_MAX_SECONDS_KEY = "load balance max seconds" + """Represents the DHCP Servers configuration and gives access to modify it""" + + def __init__(self): + self._default_lease_time = 300 + self.subnets = [] + self._peer = None + + def write_config(self): + conf = str(self) + print('Writing config: \n' + conf) + with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: + conf_file.write(conf) + + def resolve_config(self): + with open(CONFIG_FILE, 'r', encoding='UTF-8') as f: + conf = f.read() + self.resolve_subnets(conf) + self._peer = DHCPFailoverPeer(conf) + + def resolve_subnets(self, conf): + self.subnets = [] + regex = r'(subnet.*)' + subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) + for subnet in subnets: + dhcp_subnet = DHCPSubnet(subnet) + self.subnets.append(dhcp_subnet) + + def set_range(self, start, end, subnet=0, pool=0): + print('Setting Range for pool ') + print(self.subnets[subnet].pools[pool]) + self.subnets[subnet].pools[pool].range_start = start + self.subnets[subnet].pools[pool].range_end = end + + # def resolve_settings(self, conf): + # lines = conf.split('\n') + # for line in lines: + # if DEFAULT_LEASE_TIME_KEY in line: + # self._default_lease_time = line.strip().split( + # DEFAULT_LEASE_TIME_KEY)[1].strip().split(';')[0] + + # self.peer = peer + + def __str__(self): + + config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + + config = config.format(length='multi-line', + DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, + DEFAULT_LEASE_TIME=self._default_lease_time) + + config += '\n\n' + str(self.peer) + for subnet in self._subnets: + config += '\n\n' + str(subnet) + return str(config) + + +FAILOVER_PEER_KEY = 'failover peer' +PRIMARY_KEY = 'primary' +ADDRESS_KEY = 'address' +PORT_KEY = 'port' +PEER_ADDRESS_KEY = 'peer address' +PEER_PORT_KEY = 'peer port' +MAX_RESPONSE_DELAY_KEY = 'max-response-delay' +MAX_UNACKED_UPDATES_KEY = 'max-unacked-updates' +MCLT_KEY = 'mclt' +SPLIT_KEY = 'split' +LOAD_BALANCE_MAX_SECONDS_KEY = 'load balance max seconds' class DHCPFailoverPeer: - def __init__(self, config): - self.name = None - self.primary = False - self.address = None - self.port = None - self.peer_address = None - self.peer_port = None - self.max_response_delay = None - self.max_unacked_updates = None - self.mclt = None - self.split = None - self.load_balance_max_seconds = None - self.peer = None - - self.resolve_peer(config) - - def __str__(self): - config = "{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n" - config += "\tprimary;" if self.primary else "secondary;" - config += """\n\t{ADDRESS_KEY} {ADDRESS}; + """Contains all information to define the DHCP failover peer""" + + def __init__(self, config): + self.name = None + self.primary = False + self.address = None + self.port = None + self.peer_address = None + self.peer_port = None + self.max_response_delay = None + self.max_unacked_updates = None + self.mclt = None + self.split = None + self.load_balance_max_seconds = None + self.peer = None + + self.resolve_peer(config) + + def __str__(self): + config = '{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n' + config += '\tprimary;' if self.primary else 'secondary;' + config += """\n\t{ADDRESS_KEY} {ADDRESS}; {PORT_KEY} {PORT}; {PEER_ADDRESS_KEY} {PEER_ADDRESS}; {PEER_PORT_KEY} {PEER_PORT}; @@ -106,162 +111,179 @@ def __str__(self): {LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS}; \r}}""" - return config.format(length='multi-line', - FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, FAILOVER_PEER=self.name, - ADDRESS_KEY=ADDRESS_KEY, ADDRESS=self.address, - PORT_KEY=PORT_KEY, PORT=self.port, - PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, PEER_ADDRESS=self.peer_address, - PEER_PORT_KEY=PEER_PORT_KEY, PEER_PORT=self.peer_port, - MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, MAX_RESPONSE_DELAY=self.max_response_delay, - MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, MAX_UNACKED_UPDATES=self.max_unacked_updates, - MCLT_KEY=MCLT_KEY, MCLT=self.mclt, - SPLIT_KEY=SPLIT_KEY, SPLIT=self.split, - LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds - ) - - def resolve_peer(self, conf): - peer = "" - lines = conf.split("\n") - for line in lines: - if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: - if(len(peer) <= 0): - self.name = line.strip().split(FAILOVER_PEER_KEY)[ - 1].strip().split("{")[0].split("\"")[1] - peer += line+"\n" - if PRIMARY_KEY in line: - self.primary = True - elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: - self.address = line.strip().split(ADDRESS_KEY)[ - 1].strip().split(";")[0] - elif PORT_KEY in line and PEER_PORT_KEY not in line: - self.port = line.strip().split(PORT_KEY)[ - 1].strip().split(";")[0] - elif PEER_ADDRESS_KEY in line: - self.peer_address = line.strip().split(PEER_ADDRESS_KEY)[ - 1].strip().split(";")[0] - elif PEER_PORT_KEY in line: - self.peer_port = line.strip().split(PEER_PORT_KEY)[ - 1].strip().split(";")[0] - elif MAX_RESPONSE_DELAY_KEY in line: - self.max_response_delay = line.strip().split(MAX_RESPONSE_DELAY_KEY)[ - 1].strip().split(";")[0] - elif MAX_UNACKED_UPDATES_KEY in line: - self.max_unacked_updates = line.strip().split(MAX_UNACKED_UPDATES_KEY)[ - 1].strip().split(";")[0] - elif MCLT_KEY in line: - self.mclt = line.strip().split(MCLT_KEY)[ - 1].strip().split(";")[0] - elif SPLIT_KEY in line: - self.split = line.strip().split(SPLIT_KEY)[ - 1].strip().split(";")[0] - elif LOAD_BALANCE_MAX_SECONDS_KEY in line: - self.load_balance_max_seconds = line.strip().split(LOAD_BALANCE_MAX_SECONDS_KEY)[ - 1].strip().split(";")[0] - if line.endswith("}") and len(peer) > 0: - break - self.peer = peer - - -NTP_OPTION_KEY = "option ntp-servers" -SUBNET_MASK_OPTION_KEY = "option subnet-mask" -BROADCAST_OPTION_KEY = "option broadcast-address" -ROUTER_OPTION_KEY = "option routers" -DNS_OPTION_KEY = "option domain-name-servers" + return config.format( + length='multi-line', + FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, + FAILOVER_PEER=self.name, + ADDRESS_KEY=ADDRESS_KEY, + ADDRESS=self.address, + PORT_KEY=PORT_KEY, + PORT=self.port, + PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, + PEER_ADDRESS=self.peer_address, + PEER_PORT_KEY=PEER_PORT_KEY, + PEER_PORT=self.peer_port, + MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, + MAX_RESPONSE_DELAY=self.max_response_delay, + MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, + MAX_UNACKED_UPDATES=self.max_unacked_updates, + MCLT_KEY=MCLT_KEY, + MCLT=self.mclt, + SPLIT_KEY=SPLIT_KEY, + SPLIT=self.split, + LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, + LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds) + + def resolve_peer(self, conf): + peer = '' + lines = conf.split('\n') + for line in lines: + if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: + if len(peer) <= 0: + self.name = line.strip().split(FAILOVER_PEER_KEY)[1].strip().split( + '{')[0].split('\"')[1] + peer += line + '\n' + if PRIMARY_KEY in line: + self.primary = True + elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: + self.address = line.strip().split(ADDRESS_KEY)[1].strip().split( + ';')[0] + elif PORT_KEY in line and PEER_PORT_KEY not in line: + self.port = line.strip().split(PORT_KEY)[1].strip().split(';')[0] + elif PEER_ADDRESS_KEY in line: + self.peer_address = line.strip().split( + PEER_ADDRESS_KEY)[1].strip().split(';')[0] + elif PEER_PORT_KEY in line: + self.peer_port = line.strip().split(PEER_PORT_KEY)[1].strip().split( + ';')[0] + elif MAX_RESPONSE_DELAY_KEY in line: + self.max_response_delay = line.strip().split( + MAX_RESPONSE_DELAY_KEY)[1].strip().split(';')[0] + elif MAX_UNACKED_UPDATES_KEY in line: + self.max_unacked_updates = line.strip().split( + MAX_UNACKED_UPDATES_KEY)[1].strip().split(';')[0] + elif MCLT_KEY in line: + self.mclt = line.strip().split(MCLT_KEY)[1].strip().split(';')[0] + elif SPLIT_KEY in line: + self.split = line.strip().split(SPLIT_KEY)[1].strip().split(';')[0] + elif LOAD_BALANCE_MAX_SECONDS_KEY in line: + self.load_balance_max_seconds = line.strip().split( + LOAD_BALANCE_MAX_SECONDS_KEY)[1].strip().split(';')[0] + if line.endswith('}') and len(peer) > 0: + break + self.peer = peer + + +NTP_OPTION_KEY = 'option ntp-servers' +SUBNET_MASK_OPTION_KEY = 'option subnet-mask' +BROADCAST_OPTION_KEY = 'option broadcast-address' +ROUTER_OPTION_KEY = 'option routers' +DNS_OPTION_KEY = 'option domain-name-servers' class DHCPSubnet: - def __init__(self, subnet): - self._ntp_servers = None - self._subnet_mask = None - self._broadcast = None - self._routers = None - self._dns_servers = None - self._pools = [] - - self.resolve_subnet(subnet) - self.resolve_pools(subnet) - - def __str__(self): - config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ + """Represents the DHCP Servers subnet configuration""" + + def __init__(self, subnet): + self._ntp_servers = None + self._subnet_mask = None + self._broadcast = None + self._routers = None + self._dns_servers = None + self.pools = [] + + self.resolve_subnet(subnet) + self.resolve_pools(subnet) + + def __str__(self): + config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ \r\t{NTP_OPTION_KEY} {NTP_OPTION}; \r\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION}; \r\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION}; \r\t{ROUTER_OPTION_KEY} {ROUTER_OPTION}; \r\t{DNS_OPTION_KEY} {DNS_OPTION};""" - config = config.format(length='multi-line', - NTP_OPTION_KEY=NTP_OPTION_KEY, NTP_OPTION=self._ntp_servers, - SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, SUBNET_MASK_OPTION=self._subnet_mask, - BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, BROADCAST_OPTION=self._broadcast, - ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, ROUTER_OPTION=self._routers, - DNS_OPTION_KEY=DNS_OPTION_KEY, DNS_OPTION=self._dns_servers - ) - for pool in self._pools: - config += "\n\t"+str(pool) - - config += "\n\r}" - return config - - def resolve_subnet(self, subnet): - subnet_parts = subnet.split("\n") - for part in subnet_parts: - if NTP_OPTION_KEY in part: - self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[ - 1].strip().split(";")[0] - elif SUBNET_MASK_OPTION_KEY in part: - self._subnet_mask = part.strip().split(SUBNET_MASK_OPTION_KEY)[ - 1].strip().split(";")[0] - elif BROADCAST_OPTION_KEY in part: - self._broadcast = part.strip().split(BROADCAST_OPTION_KEY)[ - 1].strip().split(";")[0] - elif ROUTER_OPTION_KEY in part: - self._routers = part.strip().split(ROUTER_OPTION_KEY)[ - 1].strip().split(";")[0] - elif DNS_OPTION_KEY in part: - self._dns_servers = part.strip().split(DNS_OPTION_KEY)[ - 1].strip().split(";")[0] - - def resolve_pools(self, subnet): - regex = r"(pool.*)\}" - pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) - for pool in pools: - dhcp_pool = DHCPPool(pool) - self._pools.append(dhcp_pool) - - -FAILOVER_KEY = "failover peer" -RANGE_KEY = "range" + config = config.format(length='multi-line', + NTP_OPTION_KEY=NTP_OPTION_KEY, + NTP_OPTION=self._ntp_servers, + SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, + SUBNET_MASK_OPTION=self._subnet_mask, + BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, + BROADCAST_OPTION=self._broadcast, + ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, + ROUTER_OPTION=self._routers, + DNS_OPTION_KEY=DNS_OPTION_KEY, + DNS_OPTION=self._dns_servers) + for pool in self.pools: + config += '\n\t' + str(pool) + + config += '\n\r}' + return config + + def resolve_subnet(self, subnet): + subnet_parts = subnet.split('\n') + for part in subnet_parts: + if NTP_OPTION_KEY in part: + self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[1].strip().split( + ';')[0] + elif SUBNET_MASK_OPTION_KEY in part: + self._subnet_mask = part.strip().split( + SUBNET_MASK_OPTION_KEY)[1].strip().split(';')[0] + elif BROADCAST_OPTION_KEY in part: + self._broadcast = part.strip().split( + BROADCAST_OPTION_KEY)[1].strip().split(';')[0] + elif ROUTER_OPTION_KEY in part: + self._routers = part.strip().split(ROUTER_OPTION_KEY)[1].strip().split( + ';')[0] + elif DNS_OPTION_KEY in part: + self._dns_servers = part.strip().split(DNS_OPTION_KEY)[1].strip().split( + ';')[0] + + def resolve_pools(self, subnet): + regex = r'(pool.*)\}' + pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) + for pool in pools: + dhcp_pool = DHCPPool(pool) + self.pools.append(dhcp_pool) + + +FAILOVER_KEY = 'failover peer' +RANGE_KEY = 'range' class DHCPPool: + """Represents a DHCP Servers subnet pool configuration""" - def __init__(self, pool): - self._failover_peer = None - self._range_start = None - self._range_end = None - self.resolve_pool(pool) + def __init__(self, pool): + self.failover_peer = None + self.range_start = None + self.range_end = None + self.resolve_pool(pool) - def __str__(self): + def __str__(self): - config = """pool {{ + config = """pool {{ \r\t\t{FAILOVER_KEY} "{FAILOVER}"; \r\t\t{RANGE_KEY} {RANGE_START} {RANGE_END}; \r\t}}""" - return config.format(length='multi-line', - FAILOVER_KEY=FAILOVER_KEY, FAILOVER=self._failover_peer, - RANGE_KEY=RANGE_KEY, RANGE_START=self._range_start, RANGE_END=self._range_end, - ) - - def resolve_pool(self, pool): - pool_parts = pool.split("\n") - # pool_parts = pool.split("\n") - for part in pool_parts: - if FAILOVER_KEY in part: - self._failover_peer = part.strip().split( - FAILOVER_KEY)[1].strip().split(";")[0].replace("\"", "") - if RANGE_KEY in part: - range = part.strip().split(RANGE_KEY)[ - 1].strip().split(";")[0] - self._range_start = range.split(" ")[0].strip() - self._range_end = range.split(" ")[1].strip() + return config.format( + length='multi-line', + FAILOVER_KEY=FAILOVER_KEY, + FAILOVER=self.failover_peer, + RANGE_KEY=RANGE_KEY, + RANGE_START=self.range_start, + RANGE_END=self.range_end, + ) + + def resolve_pool(self, pool): + pool_parts = pool.split('\n') + # pool_parts = pool.split("\n") + for part in pool_parts: + if FAILOVER_KEY in part: + self.failover_peer = part.strip().split(FAILOVER_KEY)[1].strip().split( + ';')[0].replace('\"', '') + if RANGE_KEY in part: + pool_range = part.strip().split(RANGE_KEY)[1].strip().split(';')[0] + self.range_start = pool_range.split(' ')[0].strip() + self.range_end = pool_range.split(' ')[1].strip() diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py b/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py index f90cb6b51..49732b362 100644 --- a/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py +++ b/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py @@ -1,3 +1,4 @@ +"""gRPC Network Service for the DHCP Server network module""" import proto.grpc_pb2_grpc as pb2_grpc import proto.grpc_pb2 as pb2 @@ -5,40 +6,39 @@ class NetworkService(pb2_grpc.NetworkModule): + """gRPC endpoints for the DHCP Server""" - def __init__(self): - self._dhcp_config = DHCPConfig() + def __init__(self): + self._dhcp_config = DHCPConfig() + def GetDHCPRange(self, request, context): # pylint: disable=W0613 """ - Resolve the current DHCP configuration and return - the first range from the first subnet in the file - """ - - def GetDHCPRange(self, request, context): - self._dhcp_config.resolve_config() - pool = self._dhcp_config._subnets[0]._pools[0] - return pb2.DHCPRange(code=200, start=pool._range_start, end=pool._range_end) + Resolve the current DHCP configuration and return + the first range from the first subnet in the file + """ + self._dhcp_config.resolve_config() + pool = self._dhcp_config.subnets[0].pools[0] + return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) + def SetDHCPRange(self, request, context): # pylint: disable=W0613 + """ + Change DHCP configuration and set the + the first range from the first subnet in the configuration """ - Change DHCP configuration and set the - the first range from the first subnet in the configuration - """ - - def SetDHCPRange(self, request, context): - print("Setting DHCPRange") - print("Start: " + request.start) - print("End: " + request.end) - self._dhcp_config.resolve_config() - self._dhcp_config.set_range(request.start, request.end, 0, 0) - self._dhcp_config.write_config() - return pb2.Response(code=200, message="DHCP Range Set") + print('Setting DHCPRange') + print('Start: ' + request.start) + print('End: ' + request.end) + self._dhcp_config.resolve_config() + self._dhcp_config.set_range(request.start, request.end, 0, 0) + self._dhcp_config.write_config() + return pb2.Response(code=200, message='DHCP Range Set') + + def GetStatus(self, request, context): # pylint: disable=W0613 + """ + Return the current status of the network module """ - Return the current status of the network module - """ - - def GetStatus(self, request, context): - # ToDo: Figure out how to resolve the current DHCP status - dhcpStatus = True - message = str({"dhcpStatus":dhcpStatus}) - return pb2.Response(code=200, message=message) + # ToDo: Figure out how to resolve the current DHCP status + dhcp_status = True + message = str({'dhcpStatus': dhcp_status}) + return pb2.Response(code=200, message=message) diff --git a/net_orc/network/modules/dhcp-2/python/src/run.py b/net_orc/network/modules/dhcp-2/python/src/run.py deleted file mode 100644 index 830f048cf..000000000 --- a/net_orc/network/modules/dhcp-2/python/src/run.py +++ /dev/null @@ -1,40 +0,0 @@ -#!/usr/bin/env python3 - -import signal -import sys -import argparse - -from grpc.dhcp_config import DHCPConfig - - -class DHCPServer: - - def __init__(self, module): - - signal.signal(signal.SIGINT, self.handler) - signal.signal(signal.SIGTERM, self.handler) - signal.signal(signal.SIGABRT, self.handler) - signal.signal(signal.SIGQUIT, self.handler) - - config = DHCPConfig() - config.resolve_config() - config.write_config() - - def handler(self, signum, frame): - if (signum == 2 or signal == signal.SIGTERM): - exit(1) - - -def run(argv): - parser = argparse.ArgumentParser(description="Faux Device Validator", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument( - "-m", "--module", help="Define the module name to be used to create the log file") - - args = parser.parse_args() - - server = DHCPServer(args.module) - - -if __name__ == "__main__": - run(sys.argv) diff --git a/net_orc/network/modules/ntp/python/src/ntp_server.py b/net_orc/network/modules/ntp/python/src/ntp_server.py index a53134fe7..602585196 100644 --- a/net_orc/network/modules/ntp/python/src/ntp_server.py +++ b/net_orc/network/modules/ntp/python/src/ntp_server.py @@ -1,3 +1,4 @@ +"""NTP Server""" import datetime import socket import struct @@ -7,11 +8,12 @@ import threading import select -taskQueue = queue.Queue() -stopFlag = False +task_queue = queue.Queue() +stop_flag = False + def system_to_ntp_time(timestamp): - """Convert a system time to a NTP time. + """Convert a system time to a NTP time. Parameters: timestamp -- timestamp in system time @@ -19,10 +21,11 @@ def system_to_ntp_time(timestamp): Returns: corresponding NTP time """ - return timestamp + NTP.NTP_DELTA + return timestamp + NTP.NTP_DELTA + def _to_int(timestamp): - """Return the integral part of a timestamp. + """Return the integral part of a timestamp. Parameters: timestamp -- NTP timestamp @@ -30,10 +33,11 @@ def _to_int(timestamp): Retuns: integral part """ - return int(timestamp) + return int(timestamp) + def _to_frac(timestamp, n=32): - """Return the fractional part of a timestamp. + """Return the fractional part of a timestamp. Parameters: timestamp -- NTP timestamp @@ -42,10 +46,11 @@ def _to_frac(timestamp, n=32): Retuns: fractional part """ - return int(abs(timestamp - _to_int(timestamp)) * 2**n) + return int(abs(timestamp - _to_int(timestamp)) * 2**n) + def _to_time(integ, frac, n=32): - """Return a timestamp from an integral and fractional part. + """Return a timestamp from an integral and fractional part. Parameters: integ -- integral part @@ -55,115 +60,115 @@ def _to_time(integ, frac, n=32): Retuns: timestamp """ - return integ + float(frac)/2**n - + return integ + float(frac) / 2**n class NTPException(Exception): - """Exception raised by this module.""" - pass + """Exception raised by this module.""" + pass class NTP: - """Helper class defining constants.""" - - _SYSTEM_EPOCH = datetime.date(*time.gmtime(0)[0:3]) - """system epoch""" - _NTP_EPOCH = datetime.date(1900, 1, 1) - """NTP epoch""" - NTP_DELTA = (_SYSTEM_EPOCH - _NTP_EPOCH).days * 24 * 3600 - """delta between system and NTP time""" - - REF_ID_TABLE = { - 'DNC': "DNC routing protocol", - 'NIST': "NIST public modem", - 'TSP': "TSP time protocol", - 'DTS': "Digital Time Service", - 'ATOM': "Atomic clock (calibrated)", - 'VLF': "VLF radio (OMEGA, etc)", - 'callsign': "Generic radio", - 'LORC': "LORAN-C radionavidation", - 'GOES': "GOES UHF environment satellite", - 'GPS': "GPS UHF satellite positioning", - } - """reference identifier table""" - - STRATUM_TABLE = { - 0: "unspecified", - 1: "primary reference", - } - """stratum table""" - - MODE_TABLE = { - 0: "unspecified", - 1: "symmetric active", - 2: "symmetric passive", - 3: "client", - 4: "server", - 5: "broadcast", - 6: "reserved for NTP control messages", - 7: "reserved for private use", - } - """mode table""" - - LEAP_TABLE = { - 0: "no warning", - 1: "last minute has 61 seconds", - 2: "last minute has 59 seconds", - 3: "alarm condition (clock not synchronized)", - } - """leap indicator table""" + """Helper class defining constants.""" + + _SYSTEM_EPOCH = datetime.date(*time.gmtime(0)[0:3]) + """system epoch""" + _NTP_EPOCH = datetime.date(1900, 1, 1) + """NTP epoch""" + NTP_DELTA = (_SYSTEM_EPOCH - _NTP_EPOCH).days * 24 * 3600 + """delta between system and NTP time""" + + REF_ID_TABLE = { + 'DNC': 'DNC routing protocol', + 'NIST': 'NIST public modem', + 'TSP': 'TSP time protocol', + 'DTS': 'Digital Time Service', + 'ATOM': 'Atomic clock (calibrated)', + 'VLF': 'VLF radio (OMEGA, etc)', + 'callsign': 'Generic radio', + 'LORC': 'LORAN-C radionavidation', + 'GOES': 'GOES UHF environment satellite', + 'GPS': 'GPS UHF satellite positioning', + } + """reference identifier table""" + + STRATUM_TABLE = { + 0: 'unspecified', + 1: 'primary reference', + } + """stratum table""" + + MODE_TABLE = { + 0: 'unspecified', + 1: 'symmetric active', + 2: 'symmetric passive', + 3: 'client', + 4: 'server', + 5: 'broadcast', + 6: 'reserved for NTP control messages', + 7: 'reserved for private use', + } + """mode table""" + + LEAP_TABLE = { + 0: 'no warning', + 1: 'last minute has 61 seconds', + 2: 'last minute has 59 seconds', + 3: 'alarm condition (clock not synchronized)', + } + """leap indicator table""" + class NTPPacket: - """NTP packet class. + """NTP packet class. This represents an NTP packet. """ - - _PACKET_FORMAT = "!B B B b 11I" - """packet format to pack/unpack""" - def __init__(self, version=4, mode=3, tx_timestamp=0): - """Constructor. + _PACKET_FORMAT = '!B B B b 11I' + """packet format to pack/unpack""" + + def __init__(self, version=4, mode=3, tx_timestamp=0): + """Constructor. Parameters: version -- NTP version mode -- packet mode (client, server) tx_timestamp -- packet transmit timestamp """ - self.leap = 0 - """leap second indicator""" - self.version = version - """version""" - self.mode = mode - """mode""" - self.stratum = 0 - """stratum""" - self.poll = 0 - """poll interval""" - self.precision = 0 - """precision""" - self.root_delay = 0 - """root delay""" - self.root_dispersion = 0 - """root dispersion""" - self.ref_id = 0 - """reference clock identifier""" - self.ref_timestamp = 0 - """reference timestamp""" - self.orig_timestamp = 0 - self.orig_timestamp_high = 0 - self.orig_timestamp_low = 0 - """originate timestamp""" - self.recv_timestamp = 0 - """receive timestamp""" - self.tx_timestamp = tx_timestamp - self.tx_timestamp_high = 0 - self.tx_timestamp_low = 0 - """tansmit timestamp""" - - def to_data(self): - """Convert this NTPPacket to a buffer that can be sent over a socket. + self.leap = 0 + """leap second indicator""" + self.version = version + """version""" + self.mode = mode + """mode""" + self.stratum = 0 + """stratum""" + self.poll = 0 + """poll interval""" + self.precision = 0 + """precision""" + self.root_delay = 0 + """root delay""" + self.root_dispersion = 0 + """root dispersion""" + self.ref_id = 0 + """reference clock identifier""" + self.ref_timestamp = 0 + """reference timestamp""" + self.orig_timestamp = 0 + self.orig_timestamp_high = 0 + self.orig_timestamp_low = 0 + """originate timestamp""" + self.recv_timestamp = 0 + """receive timestamp""" + self.tx_timestamp = tx_timestamp + self.tx_timestamp_high = 0 + self.tx_timestamp_low = 0 + """tansmit timestamp""" + + def to_data(self): + """Convert this NTPPacket to a buffer that can be sent over a socket. Returns: buffer representing this packet @@ -171,31 +176,32 @@ def to_data(self): Raises: NTPException -- in case of invalid field """ - try: - packed = struct.pack(NTPPacket._PACKET_FORMAT, - (self.leap << 6 | self.version << 3 | self.mode), - self.stratum, - self.poll, - self.precision, - _to_int(self.root_delay) << 16 | _to_frac(self.root_delay, 16), - _to_int(self.root_dispersion) << 16 | - _to_frac(self.root_dispersion, 16), - self.ref_id, - _to_int(self.ref_timestamp), - _to_frac(self.ref_timestamp), - #Change by lichen, avoid loss of precision - self.orig_timestamp_high, - self.orig_timestamp_low, - _to_int(self.recv_timestamp), - _to_frac(self.recv_timestamp), - _to_int(self.tx_timestamp), - _to_frac(self.tx_timestamp)) - except struct.error: - raise NTPException("Invalid NTP packet fields.") - return packed - - def from_data(self, data): - """Populate this instance from a NTP packet payload received from + try: + packed = struct.pack( + NTPPacket._PACKET_FORMAT, + (self.leap << 6 | self.version << 3 | self.mode), + self.stratum, + self.poll, + self.precision, + _to_int(self.root_delay) << 16 | _to_frac(self.root_delay, 16), + _to_int(self.root_dispersion) << 16 + | _to_frac(self.root_dispersion, 16), + self.ref_id, + _to_int(self.ref_timestamp), + _to_frac(self.ref_timestamp), + #Change by lichen, avoid loss of precision + self.orig_timestamp_high, + self.orig_timestamp_low, + _to_int(self.recv_timestamp), + _to_frac(self.recv_timestamp), + _to_int(self.tx_timestamp), + _to_frac(self.tx_timestamp)) + except struct.error as exc: + raise NTPException('Invalid NTP packet fields.') from exc + return packed + + def from_data(self, data): + """Populate this instance from a NTP packet payload received from the network. Parameters: @@ -204,112 +210,115 @@ def from_data(self, data): Raises: NTPException -- in case of invalid packet format """ - try: - unpacked = struct.unpack(NTPPacket._PACKET_FORMAT, - data[0:struct.calcsize(NTPPacket._PACKET_FORMAT)]) - except struct.error: - raise NTPException("Invalid NTP packet.") - - self.leap = unpacked[0] >> 6 & 0x3 - self.version = unpacked[0] >> 3 & 0x7 - self.mode = unpacked[0] & 0x7 - self.stratum = unpacked[1] - self.poll = unpacked[2] - self.precision = unpacked[3] - self.root_delay = float(unpacked[4])/2**16 - self.root_dispersion = float(unpacked[5])/2**16 - self.ref_id = unpacked[6] - self.ref_timestamp = _to_time(unpacked[7], unpacked[8]) - self.orig_timestamp = _to_time(unpacked[9], unpacked[10]) - self.orig_timestamp_high = unpacked[9] - self.orig_timestamp_low = unpacked[10] - self.recv_timestamp = _to_time(unpacked[11], unpacked[12]) - self.tx_timestamp = _to_time(unpacked[13], unpacked[14]) - self.tx_timestamp_high = unpacked[13] - self.tx_timestamp_low = unpacked[14] - - def GetTxTimeStamp(self): - return (self.tx_timestamp_high,self.tx_timestamp_low) - - def SetOriginTimeStamp(self,high,low): - self.orig_timestamp_high = high - self.orig_timestamp_low = low - + try: + unpacked = struct.unpack( + NTPPacket._PACKET_FORMAT, + data[0:struct.calcsize(NTPPacket._PACKET_FORMAT)]) + except struct.error as exc: + raise NTPException('Invalid NTP packet.') from exc + + self.leap = unpacked[0] >> 6 & 0x3 + self.version = unpacked[0] >> 3 & 0x7 + self.mode = unpacked[0] & 0x7 + self.stratum = unpacked[1] + self.poll = unpacked[2] + self.precision = unpacked[3] + self.root_delay = float(unpacked[4]) / 2**16 + self.root_dispersion = float(unpacked[5]) / 2**16 + self.ref_id = unpacked[6] + self.ref_timestamp = _to_time(unpacked[7], unpacked[8]) + self.orig_timestamp = _to_time(unpacked[9], unpacked[10]) + self.orig_timestamp_high = unpacked[9] + self.orig_timestamp_low = unpacked[10] + self.recv_timestamp = _to_time(unpacked[11], unpacked[12]) + self.tx_timestamp = _to_time(unpacked[13], unpacked[14]) + self.tx_timestamp_high = unpacked[13] + self.tx_timestamp_low = unpacked[14] + + def get_tx_timestamp(self): + return (self.tx_timestamp_high, self.tx_timestamp_low) + + def set_origin_timestamp(self, high, low): + self.orig_timestamp_high = high + self.orig_timestamp_low = low + class RecvThread(threading.Thread): - def __init__(self,socket): - threading.Thread.__init__(self) - self.socket = socket - def run(self): - global t,stopFlag - while True: - if stopFlag == True: - print("RecvThread Ended") - break - rlist,wlist,elist = select.select([self.socket],[],[],1); - if len(rlist) != 0: - print("Received %d packets" % len(rlist)) - for tempSocket in rlist: - try: - data,addr = tempSocket.recvfrom(1024) - recvTimestamp = recvTimestamp = system_to_ntp_time(time.time()) - taskQueue.put((data,addr,recvTimestamp)) - except socket.error as msg: - print(msg) + """Thread class to recieve all requests""" + def __init__(self): + threading.Thread.__init__(self) + #self.local_socket = local_socket + + def run(self): + while True: + if stop_flag: + print('RecvThread Ended') + break + rlist, wlist, elist = select.select([local_socket], [], [], 1) # pylint: disable=unused-variable + if len(rlist) != 0: + print(f'Received {len(rlist)} packets') + for temp_socket in rlist: + try: + data, addr = temp_socket.recvfrom(1024) + recv_timestamp = system_to_ntp_time(time.time()) + task_queue.put((data, addr, recv_timestamp)) + except socket.error as msg: + print(msg) + class WorkThread(threading.Thread): - def __init__(self,socket): - threading.Thread.__init__(self) - self.socket = socket - def run(self): - global taskQueue,stopFlag - while True: - if stopFlag == True: - print("WorkThread Ended") - break - try: - data,addr,recvTimestamp = taskQueue.get(timeout=1) - recvPacket = NTPPacket() - recvPacket.from_data(data) - timeStamp_high,timeStamp_low = recvPacket.GetTxTimeStamp() - sendPacket = NTPPacket(version=4,mode=4) - sendPacket.stratum = 2 - sendPacket.poll = 10 - ''' - sendPacket.precision = 0xfa - sendPacket.root_delay = 0x0bfa - sendPacket.root_dispersion = 0x0aa7 - sendPacket.ref_id = 0x808a8c2c - ''' - sendPacket.ref_timestamp = recvTimestamp-5 - sendPacket.SetOriginTimeStamp(timeStamp_high,timeStamp_low) - sendPacket.recv_timestamp = recvTimestamp - sendPacket.tx_timestamp = system_to_ntp_time(time.time()) - socket.sendto(sendPacket.to_data(),addr) - print("Sent to %s:%d" % (addr[0],addr[1])) - except queue.Empty: - continue - - -listenIp = "0.0.0.0" -listenPort = 123 -socket = socket.socket(socket.AF_INET,socket.SOCK_DGRAM) -socket.bind((listenIp,listenPort)) -print("local socket: ", socket.getsockname()); -recvThread = RecvThread(socket) + """Thread class to process all requests and respond""" + def __init__(self): + threading.Thread.__init__(self) + #self.local_socket = local_socket + + def run(self): + while True: + if stop_flag: + print('WorkThread Ended') + break + try: + data, addr, recv_timestamp = task_queue.get(timeout=1) + recv_packet = NTPPacket() + recv_packet.from_data(data) + timestamp_high, timestamp_low = recv_packet.get_tx_timestamp() + send_packet = NTPPacket(version=4, mode=4) + send_packet.stratum = 2 + send_packet.poll = 10 + + # send_packet.precision = 0xfa + # send_packet.root_delay = 0x0bfa + # send_packet.root_dispersion = 0x0aa7 + # send_packet.ref_id = 0x808a8c2c + + send_packet.ref_timestamp = recv_timestamp - 5 + send_packet.set_origin_timestamp(timestamp_high, timestamp_low) + send_packet.recv_timestamp = recv_timestamp + send_packet.tx_timestamp = system_to_ntp_time(time.time()) + local_socket.sendto(send_packet.to_data(), addr) + print(f'Sent to {addr[0]}:{addr[1]}') + except queue.Empty: + continue + + +listen_ip = '0.0.0.0' +listen_port = 123 +local_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) +local_socket.bind((listen_ip, listen_port)) +print('local socket: ', local_socket.getsockname()) +recvThread = RecvThread() recvThread.start() -workThread = WorkThread(socket) +workThread = WorkThread() workThread.start() while True: - try: - time.sleep(0.5) - except KeyboardInterrupt: - print("Exiting...") - stopFlag = True - recvThread.join() - workThread.join() - #socket.close() - print("Exited") - break - + try: + time.sleep(0.5) + except KeyboardInterrupt: + print('Exiting...') + stop_flag = True + recvThread.join() + workThread.join() + #local_socket.close() + print('Exited') + break diff --git a/net_orc/network/modules/radius/python/src/authenticator.py b/net_orc/network/modules/radius/python/src/authenticator.py index 55fa51d87..32f4ac221 100644 --- a/net_orc/network/modules/radius/python/src/authenticator.py +++ b/net_orc/network/modules/radius/python/src/authenticator.py @@ -1,31 +1,45 @@ +"""Authenticator for the RADIUS Server""" from chewie.chewie import Chewie import logging -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' -INTERFACE_NAME="veth0" -RADIUS_SERVER_IP="127.0.0.1" -RADIUS_SERVER_PORT=1812 -RADIUS_SERVER_SECRET="testing123" +INTERFACE_NAME = 'veth0' +RADIUS_SERVER_IP = '127.0.0.1' +RADIUS_SERVER_PORT = 1812 +RADIUS_SERVER_SECRET = 'testing123' -class Authenticator(): - - def __init__(self): - self.chewie = Chewie(INTERFACE_NAME, self._get_logger(), self._auth_handler, self._failure_handler, self._logoff_handler, radius_server_ip=RADIUS_SERVER_IP, radius_server_port=RADIUS_SERVER_PORT, radius_server_secret=RADIUS_SERVER_SECRET) - self.chewie.run() - - def _get_logger(self): - logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=logging.INFO) - logger = logging.getLogger("chewie") - return logger - - def _auth_handler(self, address, group_address, *args, **kwargs): - print("Successful auth for " + str(address) + " on port " + str(group_address)) - def _failure_handler(self, address, group_address): - print("Failed auth for " + str(address) + " on port " + str(group_address)) - - def _logoff_handler(self, address, group_address): - print("Log off reported for " + str(address) + " on port " + str(group_address)) - -authenticator = Authenticator() \ No newline at end of file +class Authenticator(): + """Authenticator for the RADIUS Server""" + def __init__(self): + self.chewie = Chewie(INTERFACE_NAME, + self._get_logger(), + self._auth_handler, + self._failure_handler, + self._logoff_handler, + radius_server_ip=RADIUS_SERVER_IP, + radius_server_port=RADIUS_SERVER_PORT, + radius_server_secret=RADIUS_SERVER_SECRET) + self.chewie.run() + + def _get_logger(self): + logging.basicConfig(format=_LOG_FORMAT, + datefmt=_DATE_FORMAT, + level=logging.INFO) + logger = logging.getLogger('chewie') + return logger + + def _auth_handler(self, address, group_address, *args, **kwargs): # pylint: disable=unused-argument + print('Successful auth for ' + str(address) + ' on port '+ + str(group_address)) + + def _failure_handler(self, address, group_address): + print('Failed auth for ' + str(address) + ' on port ' + str(group_address)) + + def _logoff_handler(self, address, group_address): + print('Log off reported for ' + str(address) + ' on port ' + + str(group_address)) + + +authenticator = Authenticator() diff --git a/net_orc/network/modules/template/python/src/template_main.py b/net_orc/network/modules/template/python/src/template_main.py index 50c425c23..df2452550 100644 --- a/net_orc/network/modules/template/python/src/template_main.py +++ b/net_orc/network/modules/template/python/src/template_main.py @@ -1,4 +1,4 @@ """Python code for the template module.""" if __name__ == "__main__": - print ("Template main") + print("Template main") diff --git a/net_orc/python/src/listener.py b/net_orc/python/src/listener.py index 0323fd9f6..de7a07616 100644 --- a/net_orc/python/src/listener.py +++ b/net_orc/python/src/listener.py @@ -13,6 +13,7 @@ DHCP_ACK = 5 CONTAINER_MAC_PREFIX = '9a:02:57:1e:8f' + class Listener: """Methods to start and stop the network listener.""" @@ -20,8 +21,8 @@ def __init__(self, device_intf): self._device_intf = device_intf self._device_intf_mac = get_if_hwaddr(self._device_intf) - self._sniffer = AsyncSniffer( - iface=self._device_intf, prn=self._packet_callback) + self._sniffer = AsyncSniffer(iface=self._device_intf, + prn=self._packet_callback) self._callbacks = [] self._discovered_devices = [] @@ -40,17 +41,14 @@ def is_running(self): def register_callback(self, callback, events=[]): # pylint: disable=dangerous-default-value """Register a callback for specified events.""" - self._callbacks.append( - { - 'callback': callback, - 'events': events - } - ) + self._callbacks.append({'callback': callback, 'events': events}) def call_callback(self, net_event, *args): for callback in self._callbacks: if net_event in callback['events']: - callback_thread = threading.Thread(target=callback['callback'], name="Callback thread", args=args) + callback_thread = threading.Thread(target=callback['callback'], + name='Callback thread', + args=args) callback_thread.start() def _packet_callback(self, packet): @@ -62,10 +60,11 @@ def _packet_callback(self, packet): # New device discovered callback if not packet.src is None and packet.src not in self._discovered_devices: # Ignore packets originating from our containers - if packet.src.startswith(CONTAINER_MAC_PREFIX) or packet.src == self._device_intf_mac: + if packet.src.startswith( + CONTAINER_MAC_PREFIX) or packet.src == self._device_intf_mac: return self._discovered_devices.append(packet.src) self.call_callback(NetworkEvent.DEVICE_DISCOVERED, packet.src) def _get_dhcp_type(self, packet): - return packet[DHCP].options[0][1] \ No newline at end of file + return packet[DHCP].options[0][1] diff --git a/net_orc/python/src/logger.py b/net_orc/python/src/logger.py index e930f1953..aaf690c8a 100644 --- a/net_orc/python/src/logger.py +++ b/net_orc/python/src/logger.py @@ -1,27 +1,31 @@ -#!/usr/bin/env python3 - +"""Sets up the logger to be used for the network orchestrator.""" import json import logging import os LOGGERS = {} -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' _DEFAULT_LEVEL = logging.INFO -_CONF_DIR="conf" -_CONF_FILE_NAME="system.json" +_CONF_DIR = 'conf' +_CONF_FILE_NAME = 'system.json' # Set log level try: - system_conf_json = json.load(open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='UTF-8')) - log_level_str = system_conf_json['log_level'] - LOG_LEVEL = logging.getLevelName(log_level_str) + + with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), + encoding='UTF-8') as config_json_file: + system_conf_json = json.load(config_json_file) + + log_level_str = system_conf_json['log_level'] + LOG_LEVEL = logging.getLevelName(log_level_str) except OSError: - LOG_LEVEL = _DEFAULT_LEVEL + LOG_LEVEL = _DEFAULT_LEVEL logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=LOG_LEVEL) + def get_logger(name): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - return LOGGERS[name] + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + return LOGGERS[name] diff --git a/net_orc/python/src/network_device.py b/net_orc/python/src/network_device.py index f54a273b6..1b856da16 100644 --- a/net_orc/python/src/network_device.py +++ b/net_orc/python/src/network_device.py @@ -1,6 +1,7 @@ """Track device object information.""" from dataclasses import dataclass + @dataclass class NetworkDevice: """Represents a physical device and it's configuration.""" diff --git a/net_orc/python/src/network_event.py b/net_orc/python/src/network_event.py index dc08cf892..f56adf494 100644 --- a/net_orc/python/src/network_event.py +++ b/net_orc/python/src/network_event.py @@ -1,6 +1,7 @@ """Specify the various types of network events to be reported.""" from enum import Enum + class NetworkEvent(Enum): """All possible network events.""" DEVICE_DISCOVERED = 1 diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 3b3f92e64..39fd3339c 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,5 +1,5 @@ -#!/usr/bin/env python3 - +"""Network orchestrator is responsible for managing +all of the virtual network services""" import getpass import ipaddress import json @@ -10,7 +10,6 @@ import sys import time import threading -from threading import Timer import docker from docker.types import Mount import logger @@ -20,732 +19,771 @@ from network_event import NetworkEvent from network_validator import NetworkValidator -LOGGER = logger.get_logger("net_orc") -CONFIG_FILE = "conf/system.json" -EXAMPLE_CONFIG_FILE = "conf/system.json.example" -RUNTIME_DIR = "runtime" -DEVICES_DIR = "devices" -MONITOR_PCAP = "monitor.pcap" -NET_DIR = "runtime/network" -NETWORK_MODULES_DIR = "network/modules" -NETWORK_MODULE_METADATA = "conf/module_config.json" -DEVICE_BRIDGE = "tr-d" -INTERNET_BRIDGE = "tr-c" -PRIVATE_DOCKER_NET = "tr-private-net" -CONTAINER_NAME = "network_orchestrator" - -RUNTIME_KEY = "runtime" -MONITOR_PERIOD_KEY = "monitor_period" -STARTUP_TIMEOUT_KEY = "startup_timeout" +LOGGER = logger.get_logger('net_orc') +CONFIG_FILE = 'conf/system.json' +EXAMPLE_CONFIG_FILE = 'conf/system.json.example' +RUNTIME_DIR = 'runtime' +DEVICES_DIR = 'devices' +MONITOR_PCAP = 'monitor.pcap' +NET_DIR = 'runtime/network' +NETWORK_MODULES_DIR = 'network/modules' +NETWORK_MODULE_METADATA = 'conf/module_config.json' +DEVICE_BRIDGE = 'tr-d' +INTERNET_BRIDGE = 'tr-c' +PRIVATE_DOCKER_NET = 'tr-private-net' +CONTAINER_NAME = 'network_orchestrator' + +RUNTIME_KEY = 'runtime' +MONITOR_PERIOD_KEY = 'monitor_period' +STARTUP_TIMEOUT_KEY = 'startup_timeout' DEFAULT_STARTUP_TIMEOUT = 60 DEFAULT_RUNTIME = 1200 DEFAULT_MONITOR_PERIOD = 300 RUNTIME = 1500 -class NetworkOrchestrator: - """Manage and controls a virtual testing network.""" - - def __init__(self, config_file=CONFIG_FILE, validate=True, async_monitor=False, single_intf = False): - - self._runtime = DEFAULT_RUNTIME - self._startup_timeout = DEFAULT_STARTUP_TIMEOUT - self._monitor_period = DEFAULT_MONITOR_PERIOD - - self._int_intf = None - self._dev_intf = None - self._single_intf = single_intf - - self.listener = None - self._net_modules = [] - self._devices = [] - self.validate = validate - self.async_monitor = async_monitor - - self._path = os.path.dirname(os.path.dirname( - os.path.dirname(os.path.realpath(__file__)))) - - self.validator = NetworkValidator() - shutil.rmtree(os.path.join(os.getcwd(), NET_DIR), ignore_errors=True) - self.network_config = NetworkConfig() - self.load_config(config_file) - - def start(self): - """Start the network orchestrator.""" - - LOGGER.info("Starting Network Orchestrator") - # Get all components ready - self.load_network_modules() - - # Restore the network first if required - self.stop(kill=True) - - self.start_network() - - if self.async_monitor: - # Run the monitor method asynchronously to keep this method non-blocking - self._monitor_thread = threading.Thread( - target=self.monitor_network) - self._monitor_thread.daemon = True - self._monitor_thread.start() - else: - self.monitor_network() - - def start_network(self): - """Start the virtual testing network.""" - LOGGER.info("Starting network") - - self.build_network_modules() - self.create_net() - self.start_network_services() - - if self.validate: - # Start the validator after network is ready - self.validator.start() - - # Get network ready (via Network orchestrator) - LOGGER.info("Network is ready.") - - def stop(self, kill=False): - """Stop the network orchestrator.""" - self.stop_validator(kill=kill) - self.stop_network(kill=kill) - - def stop_validator(self, kill=False): - """Stop the network validator.""" - # Shutdown the validator - self.validator.stop(kill=kill) - - def stop_network(self, kill=False): - """Stop the virtual testing network.""" - # Shutdown network - self.stop_networking_services(kill=kill) - self.restore_net() - - def monitor_network(self): - # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) - time.sleep(RUNTIME) - - self.stop() - - def load_config(self,config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - self._config_file=os.path.join(self._path, CONFIG_FILE) - else: - # If defined, use as provided - self._config_file=config_file - - if not os.path.isfile(self._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) - - LOGGER.info("Loading config file: " + os.path.abspath(self._config_file)) - with open(self._config_file, encoding='UTF-8') as config_json_file: - config_json = json.load(config_json_file) - self.import_config(config_json) - - def _device_discovered(self, mac_addr): - LOGGER.debug(f'Discovered device {mac_addr}. Waiting for device to obtain IP') - device = self._get_device(mac_addr=mac_addr) - os.makedirs(os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(':', ''))) - - timeout = time.time() + self._startup_timeout - - while time.time() < timeout: - if device.ip_addr is None: - time.sleep(3) - else: - break - - if device.ip_addr is None: - LOGGER.info(f"Timed out whilst waiting for {mac_addr} to obtain an IP address") - return - - LOGGER.info(f"Device with mac addr {device.mac_addr} has obtained IP address {device.ip_addr}") - - self._start_device_monitor(device) - - def _dhcp_lease_ack(self, packet): - mac_addr = packet[BOOTP].chaddr.hex(":")[0:17] - device = self._get_device(mac_addr=mac_addr) - device.ip_addr = packet[BOOTP].yiaddr - - def _start_device_monitor(self, device): - """Start a timer until the steady state has been reached and +class NetworkOrchestrator: + """Manage and controls a virtual testing network.""" + + def __init__(self, + config_file=CONFIG_FILE, + validate=True, + async_monitor=False, + single_intf=False): + + self._runtime = DEFAULT_RUNTIME + self._startup_timeout = DEFAULT_STARTUP_TIMEOUT + self._monitor_period = DEFAULT_MONITOR_PERIOD + + self._int_intf = None + self._dev_intf = None + self._single_intf = single_intf + + self.listener = None + self._net_modules = [] + self._devices = [] + self.validate = validate + self.async_monitor = async_monitor + + self._path = os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))) + + self.validator = NetworkValidator() + shutil.rmtree(os.path.join(os.getcwd(), NET_DIR), ignore_errors=True) + self.network_config = NetworkConfig() + self.load_config(config_file) + + def start(self): + """Start the network orchestrator.""" + + LOGGER.info('Starting Network Orchestrator') + # Get all components ready + self.load_network_modules() + + # Restore the network first if required + self.stop(kill=True) + + self.start_network() + + if self.async_monitor: + # Run the monitor method asynchronously to keep this method non-blocking + self._monitor_thread = threading.Thread(target=self.monitor_network) + self._monitor_thread.daemon = True + self._monitor_thread.start() + else: + self.monitor_network() + + def start_network(self): + """Start the virtual testing network.""" + LOGGER.info('Starting network') + + self.build_network_modules() + self.create_net() + self.start_network_services() + + if self.validate: + # Start the validator after network is ready + self.validator.start() + + # Get network ready (via Network orchestrator) + LOGGER.info('Network is ready.') + + def stop(self, kill=False): + """Stop the network orchestrator.""" + self.stop_validator(kill=kill) + self.stop_network(kill=kill) + + def stop_validator(self, kill=False): + """Stop the network validator.""" + # Shutdown the validator + self.validator.stop(kill=kill) + + def stop_network(self, kill=False): + """Stop the virtual testing network.""" + # Shutdown network + self.stop_networking_services(kill=kill) + self.restore_net() + + def monitor_network(self): + # TODO: This time should be configurable (How long to hold before exiting, + # this could be infinite too) + time.sleep(RUNTIME) + + self.stop() + + def load_config(self, config_file=None): + if config_file is None: + # If not defined, use relative pathing to local file + self._config_file = os.path.join(self._path, CONFIG_FILE) + else: + # If defined, use as provided + self._config_file = config_file + + if not os.path.isfile(self._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) + + LOGGER.info('Loading config file: ' + os.path.abspath(self._config_file)) + with open(self._config_file, encoding='UTF-8') as config_json_file: + config_json = json.load(config_json_file) + self.import_config(config_json) + + def _device_discovered(self, mac_addr): + + LOGGER.debug( + f'Discovered device {mac_addr}. Waiting for device to obtain IP') + device = self._get_device(mac_addr=mac_addr) + os.makedirs( + os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(':', + ''))) + + timeout = time.time() + self._startup_timeout + + while time.time() < timeout: + if device.ip_addr is None: + time.sleep(3) + else: + break + + if device.ip_addr is None: + LOGGER.info( + f'Timed out whilst waiting for {mac_addr} to obtain an IP address') + return + + LOGGER.info( + f'Device with mac addr {device.mac_addr} has obtained IP address ' + f'{device.ip_addr}') + + self._start_device_monitor(device) + + def _dhcp_lease_ack(self, packet): + mac_addr = packet[BOOTP].chaddr.hex(':')[0:17] + device = self._get_device(mac_addr=mac_addr) + device.ip_addr = packet[BOOTP].yiaddr + + def _start_device_monitor(self, device): + """Start a timer until the steady state has been reached and callback the steady state method for this device.""" - LOGGER.info(f"Monitoring device with mac addr {device.mac_addr} for {str(self._monitor_period)} seconds") - packet_capture = sniff(iface=self._dev_intf, timeout=self._monitor_period) - wrpcap(os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(":",""), 'monitor.pcap'), packet_capture) - self.listener.call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) - - def _get_device(self, mac_addr): - for device in self._devices: - if device.mac_addr == mac_addr: - return device - - device = NetworkDevice(mac_addr=mac_addr) - self._devices.append(device) + LOGGER.info( + f'Monitoring device with mac addr {device.mac_addr} ' + f'for {str(self._monitor_period)} seconds') + + packet_capture = sniff(iface=self._dev_intf, timeout=self._monitor_period) + wrpcap( + os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(':', ''), + 'monitor.pcap'), packet_capture) + self.listener.call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) + + def _get_device(self, mac_addr): + for device in self._devices: + if device.mac_addr == mac_addr: return device - def import_config(self, json_config): - self._int_intf = json_config['network']['internet_intf'] - self._dev_intf = json_config['network']['device_intf'] - - if RUNTIME_KEY in json_config: - self._runtime = json_config[RUNTIME_KEY] - if STARTUP_TIMEOUT_KEY in json_config: - self._startup_timeout = json_config[STARTUP_TIMEOUT_KEY] - if MONITOR_PERIOD_KEY in json_config: - self._monitor_period = json_config[MONITOR_PERIOD_KEY] - - def _check_network_services(self): - LOGGER.debug("Checking network modules...") - for net_module in self._net_modules: - if net_module.enable_container: - LOGGER.debug("Checking network module: " + - net_module.display_name) - success = self._ping(net_module) - if success: - LOGGER.debug(net_module.display_name + - " responded succesfully: " + str(success)) - else: - LOGGER.error(net_module.display_name + - " failed to respond to ping") - - def _ping(self, net_module): - host = net_module.net_config.ipv4_address - namespace = "tr-ctns-" + net_module.dir_name - cmd = "ip netns exec " + namespace + " ping -c 1 " + str(host) - success = util.run_command(cmd, output=False) - return success - - def _create_private_net(self): - client = docker.from_env() - try: - network = client.networks.get(PRIVATE_DOCKER_NET) - network.remove() - except docker.errors.NotFound: - pass - - # TODO: These should be made into variables - ipam_pool = docker.types.IPAMPool( - subnet='100.100.0.0/16', - iprange='100.100.100.0/24' - ) - - ipam_config = docker.types.IPAMConfig( - pool_configs=[ipam_pool] - ) - - client.networks.create( - PRIVATE_DOCKER_NET, - ipam=ipam_config, - internal=True, - check_duplicate=True, - driver="macvlan" - ) - - def _ci_pre_network_create(self): - """ Stores network properties to restore network after + device = NetworkDevice(mac_addr=mac_addr) + self._devices.append(device) + return device + + def import_config(self, json_config): + self._int_intf = json_config['network']['internet_intf'] + self._dev_intf = json_config['network']['device_intf'] + + if RUNTIME_KEY in json_config: + self._runtime = json_config[RUNTIME_KEY] + if STARTUP_TIMEOUT_KEY in json_config: + self._startup_timeout = json_config[STARTUP_TIMEOUT_KEY] + if MONITOR_PERIOD_KEY in json_config: + self._monitor_period = json_config[MONITOR_PERIOD_KEY] + + def _check_network_services(self): + LOGGER.debug('Checking network modules...') + for net_module in self._net_modules: + if net_module.enable_container: + LOGGER.debug('Checking network module: ' + net_module.display_name) + success = self._ping(net_module) + if success: + LOGGER.debug(net_module.display_name + ' responded succesfully: ' + + str(success)) + else: + LOGGER.error(net_module.display_name + ' failed to respond to ping') + + def _ping(self, net_module): + host = net_module.net_config.ipv4_address + namespace = 'tr-ctns-' + net_module.dir_name + cmd = 'ip netns exec ' + namespace + ' ping -c 1 ' + str(host) + success = util.run_command(cmd, output=False) + return success + + def _create_private_net(self): + client = docker.from_env() + try: + network = client.networks.get(PRIVATE_DOCKER_NET) + network.remove() + except docker.errors.NotFound: + pass + + # TODO: These should be made into variables + ipam_pool = docker.types.IPAMPool(subnet='100.100.0.0/16', + iprange='100.100.100.0/24') + + ipam_config = docker.types.IPAMConfig(pool_configs=[ipam_pool]) + + client.networks.create(PRIVATE_DOCKER_NET, + ipam=ipam_config, + internal=True, + check_duplicate=True, + driver='macvlan') + + def _ci_pre_network_create(self): + """ Stores network properties to restore network after network creation and flushes internet interface """ - self._ethmac = subprocess.check_output( - f"cat /sys/class/net/{self._int_intf}/address", shell=True).decode("utf-8").strip() - self._gateway = subprocess.check_output( - "ip route | head -n 1 | awk '{print $3}'", shell=True).decode("utf-8").strip() - self._ipv4 = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._ipv6 = subprocess.check_output( - f"ip a show {self._int_intf} | grep inet6 | awk '{{print $2}}'", shell=True).decode("utf-8").strip() - self._brd = subprocess.check_output( - f"ip a show {self._int_intf} | grep \"inet \" | awk '{{print $4}}'", shell=True).decode("utf-8").strip() - - def _ci_post_network_create(self): - """ Restore network connection in CI environment """ - LOGGER.info("post cr") - util.run_command(f"ip address del {self._ipv4} dev {self._int_intf}") - util.run_command(f"ip -6 address del {self._ipv6} dev {self._int_intf}") - util.run_command(f"ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26") - util.run_command(f"ip addr flush dev {self._int_intf}") - util.run_command(f"ip addr add dev {self._int_intf} 0.0.0.0") - util.run_command(f"ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}") - util.run_command(f"ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ") - util.run_command(f"systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8") - util.run_command(f"ip link set dev {INTERNET_BRIDGE} up") - util.run_command(f"dhclient {INTERNET_BRIDGE}") - util.run_command(f"ip route del default via 10.1.0.1") - util.run_command(f"ip route add default via {self._gateway} src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}") - - def create_net(self): - LOGGER.info("Creating baseline network") - - if not util.interface_exists(self._int_intf) or not util.interface_exists(self._dev_intf): - LOGGER.error("Configured interfaces are not ready for use. " + - "Ensure both interfaces are connected.") - sys.exit(1) - - if self._single_intf: - self._ci_pre_network_create() - - # Create data plane - util.run_command("ovs-vsctl add-br " + DEVICE_BRIDGE) - - # Create control plane - util.run_command("ovs-vsctl add-br " + INTERNET_BRIDGE) - - # Add external interfaces to data and control plane - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + self._dev_intf) - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + self._int_intf) - - # Enable forwarding of eapol packets - util.run_command("ovs-ofctl add-flow " + DEVICE_BRIDGE + - " 'table=0, dl_dst=01:80:c2:00:00:03, actions=flood'") - - # Remove IP from internet adapter - util.run_command("ifconfig " + self._int_intf + " 0.0.0.0") - - # Set ports up - util.run_command("ip link set dev " + DEVICE_BRIDGE + " up") - util.run_command("ip link set dev " + INTERNET_BRIDGE + " up") - - if self._single_intf: - self._ci_post_network_create() - - self._create_private_net() - - self.listener = Listener(self._dev_intf) - self.listener.register_callback(self._device_discovered, [ - NetworkEvent.DEVICE_DISCOVERED]) - self.listener.register_callback( - self._dhcp_lease_ack, [NetworkEvent.DHCP_LEASE_ACK]) - self.listener.start_listener() - - def load_network_modules(self): - """Load network modules from module_config.json.""" - LOGGER.debug("Loading network modules from /" + NETWORK_MODULES_DIR) - - loaded_modules = "Loaded the following network modules: " - net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) - - for module_dir in os.listdir(net_modules_dir): - - if self._get_network_module(module_dir) is None: - loaded_module = self._load_network_module(module_dir) - loaded_modules += loaded_module.dir_name + " " - - LOGGER.info(loaded_modules) - - def _load_network_module(self, module_dir): - - net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) - - net_module = NetworkModule() - - # Load basic module information - net_module_json = json.load(open(os.path.join( - self._path, net_modules_dir, module_dir, NETWORK_MODULE_METADATA), encoding='UTF-8')) - - net_module.name = net_module_json['config']['meta']['name'] - net_module.display_name = net_module_json['config']['meta']['display_name'] - net_module.description = net_module_json['config']['meta']['description'] - net_module.dir = os.path.join( - self._path, net_modules_dir, module_dir) - net_module.dir_name = module_dir - net_module.build_file = module_dir + ".Dockerfile" - net_module.container_name = "tr-ct-" + net_module.dir_name - net_module.image_name = "test-run/" + net_module.dir_name - - # Attach folder mounts to network module - if "docker" in net_module_json['config']: - - if "mounts" in net_module_json['config']['docker']: - for mount_point in net_module_json['config']['docker']['mounts']: - net_module.mounts.append(Mount( - target=mount_point['target'], - source=os.path.join( - os.getcwd(), mount_point['source']), - type='bind' - )) - - if "depends_on" in net_module_json['config']['docker']: - depends_on_module = net_module_json['config']['docker']['depends_on'] - if self._get_network_module(depends_on_module) is None: - self._load_network_module(depends_on_module) - - # Determine if this is a container or just an image/template - if "enable_container" in net_module_json['config']['docker']: - net_module.enable_container = net_module_json['config']['docker']['enable_container'] - - # Load network service networking configuration - if net_module.enable_container: - - net_module.net_config.enable_wan = net_module_json['config']['network']['enable_wan'] - net_module.net_config.ip_index = net_module_json['config']['network']['ip_index'] - - net_module.net_config.host = False if not "host" in net_module_json[ - 'config']['network'] else net_module_json['config']['network']['host'] - - net_module.net_config.ipv4_address = self.network_config.ipv4_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv4_network = self.network_config.ipv4_network - - net_module.net_config.ipv6_address = self.network_config.ipv6_network[ - net_module.net_config.ip_index] - net_module.net_config.ipv6_network = self.network_config.ipv6_network - - self._net_modules.append(net_module) + self._ethmac = subprocess.check_output( + f'cat /sys/class/net/{self._int_intf}/address', + shell=True).decode('utf-8').strip() + self._gateway = subprocess.check_output( + 'ip route | head -n 1 | awk \'{print $3}\'', + shell=True).decode('utf-8').strip() + self._ipv4 = subprocess.check_output( + f'ip a show {self._int_intf} | grep \"inet \" | awk \'{{print $2}}\'', + shell=True).decode('utf-8').strip() + self._ipv6 = subprocess.check_output( + f'ip a show {self._int_intf} | grep inet6 | awk \'{{print $2}}\'', + shell=True).decode('utf-8').strip() + self._brd = subprocess.check_output( + f'ip a show {self._int_intf} | grep \"inet \" | awk \'{{print $4}}\'', + shell=True).decode('utf-8').strip() + + def _ci_post_network_create(self): + """ Restore network connection in CI environment """ + LOGGER.info('post cr') + util.run_command(f'ip address del {self._ipv4} dev {self._int_intf}') + util.run_command(f'ip -6 address del {self._ipv6} dev {self._int_intf}') + util.run_command( + f'ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26') + util.run_command(f'ip addr flush dev {self._int_intf}') + util.run_command(f'ip addr add dev {self._int_intf} 0.0.0.0') + util.run_command( + f'ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}') + util.run_command(f'ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ') + util.run_command( + f'systemd-resolve --interface {INTERNET_BRIDGE} --set-dns 8.8.8.8') + util.run_command(f'ip link set dev {INTERNET_BRIDGE} up') + util.run_command(f'dhclient {INTERNET_BRIDGE}') + util.run_command('ip route del default via 10.1.0.1') + util.run_command( + f'ip route add default via {self._gateway} ' + f'src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}') + + def create_net(self): + LOGGER.info('Creating baseline network') + + if not util.interface_exists(self._int_intf) or not util.interface_exists( + self._dev_intf): + LOGGER.error('Configured interfaces are not ready for use. ' + + 'Ensure both interfaces are connected.') + sys.exit(1) + + if self._single_intf: + self._ci_pre_network_create() + + # Create data plane + util.run_command('ovs-vsctl add-br ' + DEVICE_BRIDGE) + + # Create control plane + util.run_command('ovs-vsctl add-br ' + INTERNET_BRIDGE) + + # Add external interfaces to data and control plane + util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + + self._dev_intf) + util.run_command('ovs-vsctl add-port ' + INTERNET_BRIDGE + ' ' + + self._int_intf) + + # Enable forwarding of eapol packets + util.run_command('ovs-ofctl add-flow ' + DEVICE_BRIDGE + + ' \'table=0, dl_dst=01:80:c2:00:00:03, actions=flood\'') + + # Remove IP from internet adapter + util.run_command('ifconfig ' + self._int_intf + ' 0.0.0.0') + + # Set ports up + util.run_command('ip link set dev ' + DEVICE_BRIDGE + ' up') + util.run_command('ip link set dev ' + INTERNET_BRIDGE + ' up') + + if self._single_intf: + self._ci_post_network_create() + + self._create_private_net() + + self.listener = Listener(self._dev_intf) + self.listener.register_callback(self._device_discovered, + [NetworkEvent.DEVICE_DISCOVERED]) + self.listener.register_callback(self._dhcp_lease_ack, + [NetworkEvent.DHCP_LEASE_ACK]) + self.listener.start_listener() + + def load_network_modules(self): + """Load network modules from module_config.json.""" + LOGGER.debug('Loading network modules from /' + NETWORK_MODULES_DIR) + + loaded_modules = 'Loaded the following network modules: ' + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + for module_dir in os.listdir(net_modules_dir): + + if self._get_network_module(module_dir) is None: + loaded_module = self._load_network_module(module_dir) + loaded_modules += loaded_module.dir_name + ' ' + + LOGGER.info(loaded_modules) + + def _load_network_module(self, module_dir): + + net_modules_dir = os.path.join(self._path, NETWORK_MODULES_DIR) + + net_module = NetworkModule() + + # Load module information + with open(os.path.join(self._path, net_modules_dir, module_dir, + NETWORK_MODULE_METADATA), 'r', + encoding='UTF-8') as module_file_open: + net_module_json = json.load(module_file_open) + + net_module.name = net_module_json['config']['meta']['name'] + net_module.display_name = net_module_json['config']['meta']['display_name'] + net_module.description = net_module_json['config']['meta']['description'] + net_module.dir = os.path.join(self._path, net_modules_dir, module_dir) + net_module.dir_name = module_dir + net_module.build_file = module_dir + '.Dockerfile' + net_module.container_name = 'tr-ct-' + net_module.dir_name + net_module.image_name = 'test-run/' + net_module.dir_name + + # Attach folder mounts to network module + if 'docker' in net_module_json['config']: + + if 'mounts' in net_module_json['config']['docker']: + for mount_point in net_module_json['config']['docker']['mounts']: + net_module.mounts.append( + Mount(target=mount_point['target'], + source=os.path.join(os.getcwd(), mount_point['source']), + type='bind')) + + if 'depends_on' in net_module_json['config']['docker']: + depends_on_module = net_module_json['config']['docker']['depends_on'] + if self._get_network_module(depends_on_module) is None: + self._load_network_module(depends_on_module) + + # Determine if this is a container or just an image/template + if 'enable_container' in net_module_json['config']['docker']: + net_module.enable_container = net_module_json['config']['docker'][ + 'enable_container'] + + # Load network service networking configuration + if net_module.enable_container: + + net_module.net_config.enable_wan = net_module_json['config']['network'][ + 'enable_wan'] + net_module.net_config.ip_index = net_module_json['config']['network'][ + 'ip_index'] + + net_module.net_config.host = False if not 'host' in net_module_json[ + 'config']['network'] else net_module_json['config']['network']['host'] + + net_module.net_config.ipv4_address = self.network_config.ipv4_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv4_network = self.network_config.ipv4_network + + net_module.net_config.ipv6_address = self.network_config.ipv6_network[ + net_module.net_config.ip_index] + net_module.net_config.ipv6_network = self.network_config.ipv6_network + + self._net_modules.append(net_module) + return net_module + + def build_network_modules(self): + LOGGER.info('Building network modules...') + for net_module in self._net_modules: + self._build_module(net_module) + + def _build_module(self, net_module): + LOGGER.debug('Building network module ' + net_module.dir_name) + client = docker.from_env() + client.images.build(dockerfile=os.path.join(net_module.dir, + net_module.build_file), + path=self._path, + forcerm=True, + tag='test-run/' + net_module.dir_name) + + def _get_network_module(self, name): + for net_module in self._net_modules: + if name in (net_module.display_name, net_module.name, + net_module.dir_name): return net_module + return None - def build_network_modules(self): - LOGGER.info("Building network modules...") - for net_module in self._net_modules: - self._build_module(net_module) - - def _build_module(self, net_module): - LOGGER.debug("Building network module " + net_module.dir_name) - client = docker.from_env() - client.images.build( - dockerfile=os.path.join(net_module.dir, net_module.build_file), - path=self._path, - forcerm=True, - tag="test-run/" + net_module.dir_name - ) - - def _get_network_module(self, name): - for net_module in self._net_modules: - if name == net_module.display_name or name == net_module.name or name == net_module.dir_name: - return net_module - return None - - # Start the OVS network module - # This should always be called before loading all - # other modules to allow for a properly setup base - # network - def _start_ovs_module(self): - self._start_network_service(self._get_network_module("OVS")) - - def _start_network_service(self, net_module): - - LOGGER.debug("Starting net service " + net_module.display_name) - network = "host" if net_module.net_config.host else PRIVATE_DOCKER_NET - LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, - container name: {net_module.container_name}""") - try: - client = docker.from_env() - net_module.container = client.containers.run( - net_module.image_name, - auto_remove=True, - cap_add=["NET_ADMIN"], - name=net_module.container_name, - hostname=net_module.container_name, - network=PRIVATE_DOCKER_NET, - privileged=True, - detach=True, - mounts=net_module.mounts, - environment={"HOST_USER": getpass.getuser()} - ) - except docker.errors.ContainerError as error: - LOGGER.error("Container run error") - LOGGER.error(error) - - if network != "host": - self._attach_service_to_network(net_module) - - def _stop_service_module(self, net_module, kill=False): - LOGGER.debug("Stopping Service container " + net_module.container_name) - try: - container = self._get_service_container(net_module) - if container is not None: - if kill: - LOGGER.debug("Killing container:" + - net_module.container_name) - container.kill() - else: - LOGGER.debug("Stopping container:" + - net_module.container_name) - container.stop() - LOGGER.debug("Container stopped:" + net_module.container_name) - except Exception as error: - LOGGER.error("Container stop error") - LOGGER.error(error) - - def _get_service_container(self, net_module): - LOGGER.debug("Resolving service container: " + - net_module.container_name) - container = None - try: - client = docker.from_env() - container = client.containers.get(net_module.container_name) - except docker.errors.NotFound: - LOGGER.debug("Container " + - net_module.container_name + " not found") - except Exception as e: - LOGGER.error("Failed to resolve container") - LOGGER.error(e) - return container - - def stop_networking_services(self, kill=False): - LOGGER.info("Stopping network services") - for net_module in self._net_modules: - # Network modules may just be Docker images, so we do not want to stop them - if not net_module.enable_container: - continue - self._stop_service_module(net_module, kill) - - def start_network_services(self): - LOGGER.info("Starting network services") - - os.makedirs(os.path.join(os.getcwd(), NET_DIR), exist_ok=True) - - for net_module in self._net_modules: - - # TODO: There should be a better way of doing this - # Do not try starting OVS module again, as it should already be running - if "OVS" != net_module.display_name: - - # Network modules may just be Docker images, so we do not want to start them as containers - if not net_module.enable_container: - continue - - self._start_network_service(net_module) - - LOGGER.info("All network services are running") - self._check_network_services() - - def _attach_test_module_to_network(self, test_module): - LOGGER.debug("Attaching test module " + - test_module.display_name + " to device bridge") - - # Device bridge interface example: tr-d-t-baseline (Test Run Device Interface for Test container) - bridge_intf = DEVICE_BRIDGE + "-t-" + test_module.dir_name - - # Container interface example: tr-cti-baseline-test (Test Run Test Container Interface for test container) - container_intf = "tr-tci-" + test_module.dir_name - - # Container network namespace name - container_net_ns = "tr-test-" + test_module.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Add bridge interface to device bridge - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + bridge_intf) - - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command( - "docker inspect -f {{.State.Pid}} " + test_module.container_name)[0] - - # Create symlink for container network namespace - util.run_command("ln -sf /proc/" + container_pid + - "/ns/net /var/run/netns/" + container_net_ns) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to veth0 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name veth0") - - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(test_module.ip_index)) - - # Set IP address of container interface - ipv4_address = self.network_config.ipv4_network[test_module.ip_index] - ipv6_address = self.network_config.ipv6_network[test_module.ip_index] - - ipv4_address_with_prefix=str(ipv4_address) + "/" + str(self.network_config.ipv4_network.prefixlen) - ipv6_address_with_prefix=str(ipv6_address) + "/" + str(self.network_config.ipv6_network.prefixlen) - - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - ipv4_address_with_prefix + " dev veth0") - - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - ipv6_address_with_prefix + " dev veth0") + # Start the OVS network module + # This should always be called before loading all + # other modules to allow for a properly setup base + # network + def _start_ovs_module(self): + self._start_network_service(self._get_network_module('OVS')) + def _start_network_service(self, net_module): - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev veth0 up") + LOGGER.debug('Starting net service ' + net_module.display_name) + network = 'host' if net_module.net_config.host else PRIVATE_DOCKER_NET + LOGGER.debug(f"""Network: {network}, image name: {net_module.image_name}, + container name: {net_module.container_name}""") + try: + client = docker.from_env() + net_module.container = client.containers.run( + net_module.image_name, + auto_remove=True, + cap_add=['NET_ADMIN'], + name=net_module.container_name, + hostname=net_module.container_name, + network=PRIVATE_DOCKER_NET, + privileged=True, + detach=True, + mounts=net_module.mounts, + environment={'HOST_USER': getpass.getuser()}) + except docker.errors.ContainerError as error: + LOGGER.error('Container run error') + LOGGER.error(error) + + if network != 'host': + self._attach_service_to_network(net_module) + + def _stop_service_module(self, net_module, kill=False): + LOGGER.debug('Stopping Service container ' + net_module.container_name) + try: + container = self._get_service_container(net_module) + if container is not None: + if kill: + LOGGER.debug('Killing container:' + net_module.container_name) + container.kill() + else: + LOGGER.debug('Stopping container:' + net_module.container_name) + container.stop() + LOGGER.debug('Container stopped:' + net_module.container_name) + except Exception as error: # pylint: disable=W0703 + LOGGER.error('Container stop error') + LOGGER.error(error) + + def _get_service_container(self, net_module): + LOGGER.debug('Resolving service container: ' + net_module.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_module.container_name) + except docker.errors.NotFound: + LOGGER.debug('Container ' + net_module.container_name + ' not found') + except Exception as e: # pylint: disable=W0703 + LOGGER.error('Failed to resolve container') + LOGGER.error(e) + return container + + def stop_networking_services(self, kill=False): + LOGGER.info('Stopping network services') + for net_module in self._net_modules: + # Network modules may just be Docker images, + # so we do not want to stop them + if not net_module.enable_container: + continue + self._stop_service_module(net_module, kill) + + def start_network_services(self): + LOGGER.info('Starting network services') + + os.makedirs(os.path.join(os.getcwd(), NET_DIR), exist_ok=True) + + for net_module in self._net_modules: + + # TODO: There should be a better way of doing this + # Do not try starting OVS module again, as it should already be running + if 'OVS' != net_module.display_name: + + # Network modules may just be Docker images, + # so we do not want to start them as containers + if not net_module.enable_container: + continue + + self._start_network_service(net_module) + + LOGGER.info('All network services are running') + self._check_network_services() + + def _attach_test_module_to_network(self, test_module): + LOGGER.debug('Attaching test module ' + test_module.display_name + + ' to device bridge') + + # Device bridge interface example: + # tr-d-t-baseline (Test Run Device Interface for Test container) + bridge_intf = DEVICE_BRIDGE + '-t-' + test_module.dir_name + + # Container interface example: + # tr-cti-baseline-test (Test Run Container Interface for test container) + container_intf = 'tr-tci-' + test_module.dir_name + + # Container network namespace name + container_net_ns = 'tr-test-' + test_module.dir_name + + # Create interface pair + util.run_command('ip link add ' + bridge_intf + ' type veth peer name ' + + container_intf) + + # Add bridge interface to device bridge + util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command('docker inspect -f {{.State.Pid}} ' + + test_module.container_name)[0] + + # Create symlink for container network namespace + util.run_command('ln -sf /proc/' + container_pid + + '/ns/net /var/run/netns/' + container_net_ns) + + # Attach container interface to container network namespace + util.run_command('ip link set ' + container_intf + ' netns ' + + container_net_ns) + + # Rename container interface name to veth0 + util.run_command('ip netns exec ' + container_net_ns + ' ip link set dev ' + + container_intf + ' name veth0') + + # Set MAC address of container interface + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev veth0 address 9a:02:57:1e:8f:' + + str(test_module.ip_index)) + + # Set IP address of container interface + ipv4_address = self.network_config.ipv4_network[test_module.ip_index] + ipv6_address = self.network_config.ipv6_network[test_module.ip_index] + + ipv4_address_with_prefix = str(ipv4_address) + '/' + str( + self.network_config.ipv4_network.prefixlen) + ipv6_address_with_prefix = str(ipv6_address) + '/' + str( + self.network_config.ipv6_network.prefixlen) + + util.run_command('ip netns exec ' + container_net_ns + ' ip addr add ' + + ipv4_address_with_prefix + ' dev veth0') + + util.run_command('ip netns exec ' + container_net_ns + ' ip addr add ' + + ipv6_address_with_prefix + ' dev veth0') + + # Set interfaces up + util.run_command('ip link set dev ' + bridge_intf + ' up') + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev veth0 up') + + # TODO: Let's move this into a separate script? It does not look great + def _attach_service_to_network(self, net_module): + LOGGER.debug('Attaching net service ' + net_module.display_name + + ' to device bridge') - # TODO: Let's move this into a separate script? It does not look great - def _attach_service_to_network(self, net_module): - LOGGER.debug("Attaching net service " + - net_module.display_name + " to device bridge") + # Device bridge interface example: + # tr-di-dhcp (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + 'i-' + net_module.dir_name - # Device bridge interface example: tr-di-dhcp (Test Run Device Interface for DHCP container) - bridge_intf = DEVICE_BRIDGE + "i-" + net_module.dir_name + # Container interface example: + # tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = 'tr-cti-' + net_module.dir_name - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name + # Container network namespace name + container_net_ns = 'tr-ctns-' + net_module.dir_name - # Container network namespace name - container_net_ns = "tr-ctns-" + net_module.dir_name + # Create interface pair + util.run_command('ip link add ' + bridge_intf + ' type veth peer name ' + + container_intf) - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) + # Add bridge interface to device bridge + util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + bridge_intf) - # Add bridge interface to device bridge - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + bridge_intf) + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command('docker inspect -f {{.State.Pid}} ' + + net_module.container_name)[0] - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command( - "docker inspect -f {{.State.Pid}} " + net_module.container_name)[0] + # Create symlink for container network namespace + util.run_command('ln -sf /proc/' + container_pid + + '/ns/net /var/run/netns/' + container_net_ns) - # Create symlink for container network namespace - util.run_command("ln -sf /proc/" + container_pid + - "/ns/net /var/run/netns/" + container_net_ns) + # Attach container interface to container network namespace + util.run_command('ip link set ' + container_intf + ' netns ' + + container_net_ns) - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) + # Rename container interface name to veth0 + util.run_command('ip netns exec ' + container_net_ns + ' ip link set dev ' + + container_intf + ' name veth0') - # Rename container interface name to veth0 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name veth0") + # Set MAC address of container interface + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev veth0 address 9a:02:57:1e:8f:' + + str(net_module.net_config.ip_index)) - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip link set dev veth0 address 9a:02:57:1e:8f:" + str(net_module.net_config.ip_index)) + # Set IP address of container interface + util.run_command('ip netns exec ' + container_net_ns + ' ip addr add ' + + net_module.net_config.get_ipv4_addr_with_prefix() + + ' dev veth0') - # Set IP address of container interface - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv4_addr_with_prefix() + " dev veth0") + util.run_command('ip netns exec ' + container_net_ns + ' ip addr add ' + + net_module.net_config.get_ipv6_addr_with_prefix() + + ' dev veth0') - util.run_command("ip netns exec " + container_net_ns + " ip addr add " + - net_module.net_config.get_ipv6_addr_with_prefix() + " dev veth0") + # Set interfaces up + util.run_command('ip link set dev ' + bridge_intf + ' up') + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev veth0 up') - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev veth0 up") + if net_module.net_config.enable_wan: + LOGGER.debug('Attaching net service ' + net_module.display_name + + ' to internet bridge') - if net_module.net_config.enable_wan: - LOGGER.debug("Attaching net service " + - net_module.display_name + " to internet bridge") + # Internet bridge interface example: + # tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) + bridge_intf = INTERNET_BRIDGE + 'i-' + net_module.dir_name - # Internet bridge interface example: tr-ci-dhcp (Test Run Control (Internet) Interface for DHCP container) - bridge_intf = INTERNET_BRIDGE + "i-" + net_module.dir_name + # Container interface example: + # tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = 'tr-cti-' + net_module.dir_name - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + net_module.dir_name + # Create interface pair + util.run_command('ip link add ' + bridge_intf + ' type veth peer name ' + + container_intf) - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) + # Attach bridge interface to internet bridge + util.run_command('ovs-vsctl add-port ' + INTERNET_BRIDGE + ' ' + + bridge_intf) - # Attach bridge interface to internet bridge - util.run_command("ovs-vsctl add-port " + - INTERNET_BRIDGE + " " + bridge_intf) + # Attach container interface to container network namespace + util.run_command('ip link set ' + container_intf + ' netns ' + + container_net_ns) - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) + # Rename container interface name to eth1 + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev ' + container_intf + ' name eth1') - # Rename container interface name to eth1 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name eth1") + # Set MAC address of container interface + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev eth1 address 9a:02:57:1e:8f:0' + + str(net_module.net_config.ip_index)) - # Set MAC address of container interface - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev eth1 address 9a:02:57:1e:8f:0" + str(net_module.net_config.ip_index)) + # Set interfaces up + util.run_command('ip link set dev ' + bridge_intf + ' up') + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev eth1 up') - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + - container_net_ns + " ip link set dev eth1 up") + def restore_net(self): - def restore_net(self): + LOGGER.info('Clearing baseline network') - LOGGER.info("Clearing baseline network") + if hasattr(self, 'listener' + ) and self.listener is not None and self.listener.is_running(): + self.listener.stop_listener() - if hasattr(self, 'listener') and self.listener is not None and self.listener.is_running(): - self.listener.stop_listener() + client = docker.from_env() - client = docker.from_env() + # Stop all network containers if still running + for net_module in self._net_modules: + try: + container = client.containers.get('tr-ct-' + net_module.dir_name) + container.kill() + except Exception: # pylint: disable=W0703 + continue - # Stop all network containers if still running - for net_module in self._net_modules: - try: - container = client.containers.get( - "tr-ct-" + net_module.dir_name) - container.kill() - except Exception: - continue + # Delete data plane + util.run_command('ovs-vsctl --if-exists del-br tr-d') - # Delete data plane - util.run_command("ovs-vsctl --if-exists del-br tr-d") + # Delete control plane + util.run_command('ovs-vsctl --if-exists del-br tr-c') - # Delete control plane - util.run_command("ovs-vsctl --if-exists del-br tr-c") + # Restart internet interface + if util.interface_exists(self._int_intf): + util.run_command('ip link set ' + self._int_intf + ' down') + util.run_command('ip link set ' + self._int_intf + ' up') - # Restart internet interface - if util.interface_exists(self._int_intf): - util.run_command("ip link set " + self._int_intf + " down") - util.run_command("ip link set " + self._int_intf + " up") + LOGGER.info('Network is restored') - LOGGER.info("Network is restored") class NetworkModule: + """Define all the properties of a Network Module""" - def __init__(self): - self.name = None - self.display_name = None - self.description = None + def __init__(self): + self.name = None + self.display_name = None + self.description = None - self.container = None - self.container_name = None - self.image_name = None + self.container = None + self.container_name = None + self.image_name = None - # Absolute path - self.dir = None - self.dir_name = None - self.build_file = None - self.mounts = [] + # Absolute path + self.dir = None + self.dir_name = None + self.build_file = None + self.mounts = [] - self.enable_container = True + self.enable_container = True + + self.net_config = NetworkModuleNetConfig() - self.net_config = NetworkModuleNetConfig() # The networking configuration for a network module + class NetworkModuleNetConfig: + """Define all the properties of the network config + for a network module""" - def __init__(self): + def __init__(self): - self.enable_wan = False + self.enable_wan = False - self.ip_index = 0 - self.ipv4_address = None - self.ipv4_network = None - self.ipv6_address = None - self.ipv6_network = None + self.ip_index = 0 + self.ipv4_address = None + self.ipv4_network = None + self.ipv6_address = None + self.ipv6_network = None - self.host = False + self.host = False - def get_ipv4_addr_with_prefix(self): - return format(self.ipv4_address) + "/" + str(self.ipv4_network.prefixlen) + def get_ipv4_addr_with_prefix(self): + return format(self.ipv4_address) + '/' + str(self.ipv4_network.prefixlen) + + def get_ipv6_addr_with_prefix(self): + return format(self.ipv6_address) + '/' + str(self.ipv6_network.prefixlen) - def get_ipv6_addr_with_prefix(self): - return format(self.ipv6_address) + "/" + str(self.ipv6_network.prefixlen) # Represents the current configuration of the network for the device bridge + class NetworkConfig: + """Define all the properties of the network configuration""" - # TODO: Let's get this from a configuration file - def __init__(self): - self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') - self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') + # TODO: Let's get this from a configuration file + def __init__(self): + self.ipv4_network = ipaddress.ip_network('10.10.10.0/24') + self.ipv6_network = ipaddress.ip_network('fd10:77be:4186::/64') diff --git a/net_orc/python/src/network_validator.py b/net_orc/python/src/network_validator.py index 2f01a06e9..83ca6f671 100644 --- a/net_orc/python/src/network_validator.py +++ b/net_orc/python/src/network_validator.py @@ -9,267 +9,254 @@ import logger import util -LOGGER = logger.get_logger("validator") -OUTPUT_DIR = "runtime/validation" -DEVICES_DIR = "network/devices" -DEVICE_METADATA = "conf/module_config.json" -DEVICE_BRIDGE = "tr-d" -CONF_DIR = "conf" -CONF_FILE = "system.json" +LOGGER = logger.get_logger('validator') +OUTPUT_DIR = 'runtime/validation' +DEVICES_DIR = 'network/devices' +DEVICE_METADATA = 'conf/module_config.json' +DEVICE_BRIDGE = 'tr-d' +CONF_DIR = 'conf' +CONF_FILE = 'system.json' + class NetworkValidator: - """Perform validation of network services.""" - - def __init__(self): - self._net_devices = [] - - self._path = os.path.dirname(os.path.dirname( - os.path.dirname(os.path.realpath(__file__)))) - - self._device_dir = os.path.join(self._path, DEVICES_DIR) - - shutil.rmtree(os.path.join(self._path, OUTPUT_DIR), ignore_errors=True) - - def start(self): - """Start the network validator.""" - LOGGER.info("Starting validator") - self._load_devices() - self._build_network_devices() - self._start_network_devices() - - def stop(self, kill=False): - """Stop the network validator.""" - LOGGER.info("Stopping validator") - self._stop_network_devices(kill) - LOGGER.info("Validator stopped") - - def _build_network_devices(self): - LOGGER.debug("Building network validators...") - for net_device in self._net_devices: - self._build_device(net_device) - - def _build_device(self, net_device): - LOGGER.debug("Building network validator " + net_device.dir_name) - try: - client = docker.from_env() - client.images.build( - dockerfile=os.path.join(net_device.dir, net_device.build_file), - path=self._path, - forcerm=True, - tag="test-run/" + net_device.dir_name - ) - LOGGER.debug("Validator device built: " + net_device.dir_name) - except docker.errors.BuildError as error: - LOGGER.error("Container build error") - LOGGER.error(error) - - def _load_devices(self): - - LOGGER.info(f"Loading validators from {DEVICES_DIR}") - - loaded_devices = "Loaded the following validators: " - - for module_dir in os.listdir(self._device_dir): - - device = FauxDevice() - - # Load basic module information - with open(os.path.join(self._device_dir, module_dir, DEVICE_METADATA), - encoding='utf-8') as device_config_file: - device_json = json.load(device_config_file) - - device.name = device_json['config']['meta']['name'] - device.description = device_json['config']['meta']['description'] - - device.dir = os.path.join(self._path, self._device_dir, module_dir) - device.dir_name = module_dir - device.build_file = module_dir + ".Dockerfile" - device.container_name = "tr-ct-" + device.dir_name - device.image_name = "test-run/" + device.dir_name - - runtime_source = os.path.join(os.getcwd(), OUTPUT_DIR, device.name) - conf_source = os.path.join(os.getcwd(), CONF_DIR) - os.makedirs(runtime_source, exist_ok=True) - - device.mounts = [ - Mount( - target='/runtime/validation', - source=runtime_source, - type = 'bind' - ), - Mount( - target='/conf', - source=conf_source, - type='bind', - read_only=True - ), - Mount( - target='/runtime/network', - source=runtime_source, - type='bind' - ) - ] - - if 'timeout' in device_json['config']['docker']: - device.timeout = device_json['config']['docker']['timeout'] - - # Determine if this is a container or just an image/template - if "enable_container" in device_json['config']['docker']: - device.enable_container = device_json['config']['docker']['enable_container'] - - self._net_devices.append(device) - - loaded_devices += device.dir_name + " " - - LOGGER.info(loaded_devices) - - def _start_network_devices(self): - LOGGER.debug("Starting network devices") - for net_device in self._net_devices: - self._start_network_device(net_device) - - def _start_network_device(self, device): - LOGGER.info("Starting device " + device.name) - LOGGER.debug("Image name: " + device.image_name) - LOGGER.debug("Container name: " + device.container_name) - - try: - client = docker.from_env() - device.container = client.containers.run( - device.image_name, - auto_remove=True, - cap_add=["NET_ADMIN"], - name=device.container_name, - hostname=device.container_name, - network="none", - privileged=True, - detach=True, - mounts=device.mounts, - environment={"HOST_USER": getpass.getuser()} - ) - except docker.errors.ContainerError as error: - LOGGER.error("Container run error") - LOGGER.error(error) - - self._attach_device_to_network(device) - - # Determine the module timeout time - test_module_timeout = time.time() + device.timeout - status = self._get_device_status(device) - - while time.time() < test_module_timeout and status == 'running': - time.sleep(1) - status = self._get_device_status(device) - - LOGGER.info("Validation device " + device.name + " has finished") - - def _get_device_status(self,module): - container = self._get_device_container(module) - if container is not None: - return container.status - return None - - def _attach_device_to_network(self, device): - LOGGER.debug("Attaching device " + device.name + " to device bridge") - - # Device bridge interface example: tr-di-dhcp - # (Test Run Device Interface for DHCP container) - bridge_intf = DEVICE_BRIDGE + "i-" + device.dir_name - - # Container interface example: tr-cti-dhcp (Test Run Container Interface for DHCP container) - container_intf = "tr-cti-" + device.dir_name - - # Container network namespace name - container_net_ns = "tr-ctns-" + device.dir_name - - # Create interface pair - util.run_command("ip link add " + bridge_intf + - " type veth peer name " + container_intf) - - # Add bridge interface to device bridge - util.run_command("ovs-vsctl add-port " + - DEVICE_BRIDGE + " " + bridge_intf) - - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command( - "docker inspect -f {{.State.Pid}} " + device.container_name)[0] - - # Create symlink for container network namespace - util.run_command("ln -sf /proc/" + container_pid + - "/ns/net /var/run/netns/" + container_net_ns) - - # Attach container interface to container network namespace - util.run_command("ip link set " + container_intf + - " netns " + container_net_ns) - - # Rename container interface name to veth0 - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev " + container_intf + " name veth0") - - # Set interfaces up - util.run_command("ip link set dev " + bridge_intf + " up") - util.run_command("ip netns exec " + container_net_ns + - " ip link set dev veth0 up") - - def _stop_network_device(self, net_device, kill=False): - LOGGER.debug("Stopping device container " + net_device.container_name) - try: - container = self._get_device_container(net_device) - if container is not None: - if kill: - LOGGER.debug("Killing container:" + - net_device.container_name) - container.kill() - else: - LOGGER.debug("Stopping container:" + - net_device.container_name) - container.stop() - LOGGER.debug("Container stopped:" + net_device.container_name) - except Exception as e: - LOGGER.error("Container stop error") - LOGGER.error(e) - - def _get_device_container(self, net_device): - LOGGER.debug("Resolving device container: " + - net_device.container_name) - container = None - try: - client = docker.from_env() - container = client.containers.get(net_device.container_name) - except docker.errors.NotFound: - LOGGER.debug("Container " + - net_device.container_name + " not found") - except Exception as e: - LOGGER.error("Failed to resolve container") - LOGGER.error(e) - return container - - def _stop_network_devices(self, kill=False): - LOGGER.debug("Stopping devices") - for net_device in self._net_devices: - # Devices may just be Docker images, so we do not want to stop them - if not net_device.enable_container: - continue - self._stop_network_device(net_device, kill) - -class FauxDevice: # pylint: disable=too-few-public-methods,too-many-instance-attributes - """Represent a faux device.""" - - def __init__(self): - self.name = "Unknown device" - self.description = "Unknown description" - - self.container = None - self.container_name = None - self.image_name = None - - # Absolute path - self.dir = None - - self.dir_name = None - self.build_file = None - self.mounts = [] - - self.enable_container = True - self.timeout = 60 + """Perform validation of network services.""" + + def __init__(self): + self._net_devices = [] + + self._path = os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))) + + self._device_dir = os.path.join(self._path, DEVICES_DIR) + + shutil.rmtree(os.path.join(self._path, OUTPUT_DIR), ignore_errors=True) + + def start(self): + """Start the network validator.""" + LOGGER.info('Starting validator') + self._load_devices() + self._build_network_devices() + self._start_network_devices() + + def stop(self, kill=False): + """Stop the network validator.""" + LOGGER.info('Stopping validator') + self._stop_network_devices(kill) + LOGGER.info('Validator stopped') + + def _build_network_devices(self): + LOGGER.debug('Building network validators...') + for net_device in self._net_devices: + self._build_device(net_device) + + def _build_device(self, net_device): + LOGGER.debug('Building network validator ' + net_device.dir_name) + try: + client = docker.from_env() + client.images.build(dockerfile=os.path.join(net_device.dir, + net_device.build_file), + path=self._path, + forcerm=True, + tag='test-run/' + net_device.dir_name) + LOGGER.debug('Validator device built: ' + net_device.dir_name) + except docker.errors.BuildError as error: + LOGGER.error('Container build error') + LOGGER.error(error) + + def _load_devices(self): + + LOGGER.info(f'Loading validators from {DEVICES_DIR}') + + loaded_devices = 'Loaded the following validators: ' + + for module_dir in os.listdir(self._device_dir): + + device = FauxDevice() + + # Load basic module information + with open(os.path.join(self._device_dir, module_dir, DEVICE_METADATA), + encoding='utf-8') as device_config_file: + device_json = json.load(device_config_file) + + device.name = device_json['config']['meta']['name'] + device.description = device_json['config']['meta']['description'] + + device.dir = os.path.join(self._path, self._device_dir, module_dir) + device.dir_name = module_dir + device.build_file = module_dir + '.Dockerfile' + device.container_name = 'tr-ct-' + device.dir_name + device.image_name = 'test-run/' + device.dir_name + + runtime_source = os.path.join(os.getcwd(), OUTPUT_DIR, device.name) + conf_source = os.path.join(os.getcwd(), CONF_DIR) + os.makedirs(runtime_source, exist_ok=True) + + device.mounts = [ + Mount(target='/runtime/validation', + source=runtime_source, + type='bind'), + Mount(target='/conf', source=conf_source, type='bind', + read_only=True), + Mount(target='/runtime/network', source=runtime_source, type='bind') + ] + + if 'timeout' in device_json['config']['docker']: + device.timeout = device_json['config']['docker']['timeout'] + + # Determine if this is a container or just an image/template + if 'enable_container' in device_json['config']['docker']: + device.enable_container = device_json['config']['docker'][ + 'enable_container'] + + self._net_devices.append(device) + + loaded_devices += device.dir_name + ' ' + + LOGGER.info(loaded_devices) + + def _start_network_devices(self): + LOGGER.debug('Starting network devices') + for net_device in self._net_devices: + self._start_network_device(net_device) + + def _start_network_device(self, device): + LOGGER.info('Starting device ' + device.name) + LOGGER.debug('Image name: ' + device.image_name) + LOGGER.debug('Container name: ' + device.container_name) + + try: + client = docker.from_env() + device.container = client.containers.run( + device.image_name, + auto_remove=True, + cap_add=['NET_ADMIN'], + name=device.container_name, + hostname=device.container_name, + network='none', + privileged=True, + detach=True, + mounts=device.mounts, + environment={'HOST_USER': getpass.getuser()}) + except docker.errors.ContainerError as error: + LOGGER.error('Container run error') + LOGGER.error(error) + + self._attach_device_to_network(device) + + # Determine the module timeout time + test_module_timeout = time.time() + device.timeout + status = self._get_device_status(device) + + while time.time() < test_module_timeout and status == 'running': + time.sleep(1) + status = self._get_device_status(device) + + LOGGER.info('Validation device ' + device.name + ' has finished') + + def _get_device_status(self, module): + container = self._get_device_container(module) + if container is not None: + return container.status + return None + + def _attach_device_to_network(self, device): + LOGGER.debug('Attaching device ' + device.name + ' to device bridge') + + # Device bridge interface example: tr-di-dhcp + # (Test Run Device Interface for DHCP container) + bridge_intf = DEVICE_BRIDGE + 'i-' + device.dir_name + + # Container interface example: + # tr-cti-dhcp (Test Run Container Interface for DHCP container) + container_intf = 'tr-cti-' + device.dir_name + + # Container network namespace name + container_net_ns = 'tr-ctns-' + device.dir_name + + # Create interface pair + util.run_command('ip link add ' + bridge_intf + ' type veth peer name ' + + container_intf) + + # Add bridge interface to device bridge + util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + bridge_intf) + + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command('docker inspect -f {{.State.Pid}} ' + + device.container_name)[0] + + # Create symlink for container network namespace + util.run_command('ln -sf /proc/' + container_pid + + '/ns/net /var/run/netns/' + container_net_ns) + + # Attach container interface to container network namespace + util.run_command('ip link set ' + container_intf + ' netns ' + + container_net_ns) + + # Rename container interface name to veth0 + util.run_command('ip netns exec ' + container_net_ns + ' ip link set dev ' + + container_intf + ' name veth0') + + # Set interfaces up + util.run_command('ip link set dev ' + bridge_intf + ' up') + util.run_command('ip netns exec ' + container_net_ns + + ' ip link set dev veth0 up') + + def _stop_network_device(self, net_device, kill=False): + LOGGER.debug('Stopping device container ' + net_device.container_name) + try: + container = self._get_device_container(net_device) + if container is not None: + if kill: + LOGGER.debug('Killing container:' + net_device.container_name) + container.kill() + else: + LOGGER.debug('Stopping container:' + net_device.container_name) + container.stop() + LOGGER.debug('Container stopped:' + net_device.container_name) + except Exception as e: # pylint: disable=W0703 + LOGGER.error('Container stop error') + LOGGER.error(e) + + def _get_device_container(self, net_device): + LOGGER.debug('Resolving device container: ' + net_device.container_name) + container = None + try: + client = docker.from_env() + container = client.containers.get(net_device.container_name) + except docker.errors.NotFound: + LOGGER.debug('Container ' + net_device.container_name + ' not found') + except Exception as e: # pylint: disable=W0703 + LOGGER.error('Failed to resolve container') + LOGGER.error(e) + return container + + def _stop_network_devices(self, kill=False): + LOGGER.debug('Stopping devices') + for net_device in self._net_devices: + # Devices may just be Docker images, so we do not want to stop them + if not net_device.enable_container: + continue + self._stop_network_device(net_device, kill) + + +class FauxDevice: # pylint: disable=too-few-public-methods,too-many-instance-attributes + """Represent a faux device.""" + + def __init__(self): + self.name = 'Unknown device' + self.description = 'Unknown description' + + self.container = None + self.container_name = None + self.image_name = None + + # Absolute path + self.dir = None + + self.dir_name = None + self.build_file = None + self.mounts = [] + + self.enable_container = True + self.timeout = 60 diff --git a/net_orc/python/src/run_validator.py b/net_orc/python/src/run_validator.py deleted file mode 100644 index 318456083..000000000 --- a/net_orc/python/src/run_validator.py +++ /dev/null @@ -1,52 +0,0 @@ -#!/usr/bin/env python3 - -import os -import logger -import signal -import time -import os - -from network_orchestrator import NetworkOrchestrator -from network_orchestrator_validator import NetworkOrchestratorValidator - -LOGGER = logger.get_logger('test_run') -RUNTIME_FOLDER = "runtime/network" - -class ValidatorRun: - - def __init__(self): - - signal.signal(signal.SIGINT, self.handler) - signal.signal(signal.SIGTERM, self.handler) - signal.signal(signal.SIGABRT, self.handler) - signal.signal(signal.SIGQUIT, self.handler) - - LOGGER.info("Starting Network Orchestrator") - #os.makedirs(RUNTIME_FOLDER) - - # Cleanup any old validator components - self._validator = NetworkOrchestratorValidator() - self._validator._stop_validator(True); - - # Start the validator after network is ready - self._validator._start_validator() - - # TODO: Kill validator once all faux devices are no longer running - time.sleep(2000) - - # Gracefully shutdown network - self._validator._stop_validator(); - - def handler(self, signum, frame): - LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.debug("Exit signal received: " + str(signum)) - if (signum == 2 or signum == signal.SIGTERM): - LOGGER.info("Exit signal received. Stopping validator...") - # Kill all container services quickly - # If we're here, we want everything to stop immediately - # and don't care about a gracefully shutdown. - self._validator._stop_validator(True); - LOGGER.info("Validator stopped") - exit(1) - -test_run = ValidatorRun() diff --git a/net_orc/python/src/util.py b/net_orc/python/src/util.py index e4a4bd5fd..a7b07ddf9 100644 --- a/net_orc/python/src/util.py +++ b/net_orc/python/src/util.py @@ -4,7 +4,8 @@ import logger import netifaces -LOGGER = logger.get_logger("util") +LOGGER = logger.get_logger('util') + def run_command(cmd, output=True): """Runs a process at the os level @@ -19,19 +20,22 @@ def run_command(cmd, output=True): stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = process.communicate() - if process.returncode !=0 and output: - err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) - LOGGER.error("Command Failed: " + cmd) - LOGGER.error("Error: " + err_msg) + + if process.returncode != 0 and output: + err_msg = f'{stderr.strip()}. Code: {process.returncode}' + LOGGER.error('Command Failed: ' + cmd) + LOGGER.error('Error: ' + err_msg) else: success = True if output: - return stdout.strip().decode("utf-8"), stderr + return stdout.strip().decode('utf-8'), stderr else: return success + def interface_exists(interface): return interface in netifaces.interfaces() + def prettify(mac_string): - return ':'.join('%02x' % ord(b) for b in mac_string) + return ':'.join([f'{ord(b):02x}' for b in mac_string]) From 41aaaf7a819bfddcfaab0aab2e8c7b51e48a3d3e Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Tue, 23 May 2023 12:22:43 -0700 Subject: [PATCH 018/400] Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results --- .../modules/base/python/src/test_module.py | 5 +- test_orc/python/src/test_orchestrator.py | 458 +++++++++--------- 2 files changed, 240 insertions(+), 223 deletions(-) diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 522a048f4..2ca686fa9 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -2,6 +2,7 @@ import logger import os import util +from datetime import datetime LOGGER = None RESULTS_DIR = "/runtime/output/" @@ -43,7 +44,8 @@ def _get_device_tests(self, device_test_module): # and update module test config with device config options if test["name"] in device_test_module["tests"]: dev_test_config = device_test_module["tests"][test["name"]] - test["config"].update(dev_test_config) + if "config" in test: + test["config"].update(dev_test_config) return module_tests def _get_device_test_module(self): @@ -83,6 +85,7 @@ def run_tests(self): test["result"] = "compliant" if result else "non-compliant" else: test["result"] = "skipped" + test["timestamp"] = datetime.now().isoformat() json_results = json.dumps({"results": tests}, indent=2) self._write_results(json_results) diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 48a0cb32d..acd24b59a 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -17,225 +17,239 @@ class TestOrchestrator: - """Manages and controls the test modules.""" - - def __init__(self,net_orc): - self._test_modules = [] - self._module_config = None - self._net_orc = net_orc - - self._path = os.path.dirname(os.path.dirname( - os.path.dirname(os.path.realpath(__file__)))) - - # Resolve the path to the test-run folder - self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) - - shutil.rmtree(os.path.join(self._root_path, - RUNTIME_DIR), ignore_errors=True) - os.makedirs(os.path.join(self._root_path, RUNTIME_DIR), exist_ok=True) - - def start(self): - LOGGER.info("Starting Test Orchestrator") - self._load_test_modules() - self.build_test_modules() - - def stop(self): - """Stop any running tests""" - self._stop_modules() - - def run_test_modules(self, device): - """Iterates through each test module and starts the container.""" - LOGGER.info(f"Running test modules on device with mac addr {device.mac_addr}") - for module in self._test_modules: - self._run_test_module(module, device) - LOGGER.info("All tests complete") - - def _run_test_module(self, module, device): - """Start the test container and extract the results.""" - - if module is None or not module.enable_container: - return - - LOGGER.info("Running test module " + module.name) - - try: - container_runtime_dir = os.path.join( - self._root_path, "runtime/test/" + device.mac_addr.replace(":","") + "/" + module.name) - network_runtime_dir = os.path.join( - self._root_path, "runtime/network") - os.makedirs(container_runtime_dir) - - client = docker.from_env() - - module.container = client.containers.run( - module.image_name, - auto_remove=True, - cap_add=["NET_ADMIN"], - name=module.container_name, - hostname=module.container_name, - privileged=True, - detach=True, - mounts=[ - Mount( - target="/runtime/output", - source=container_runtime_dir, - type='bind' - ), - Mount( - target="/runtime/network", - source=network_runtime_dir, - type='bind', - read_only=True - ), - ], - environment={ - "HOST_USER": getpass.getuser(), - "DEVICE_MAC": device.mac_addr, - "DEVICE_TEST_MODULES": device.test_modules, - "IPV4_SUBNET": self._net_orc.network_config.ipv4_network, - "IPV6_SUBNET": self._net_orc.network_config.ipv6_network - } - ) - except (docker.errors.APIError, docker.errors.ContainerError) as container_error: - LOGGER.error("Test module " + module.name + " has failed to start") - LOGGER.debug(container_error) - return - - # Mount the test container to the virtual network if requried - if module.network: - LOGGER.debug("Attaching test module to the network") - self._net_orc._attach_test_module_to_network(module) - - # Determine the module timeout time - test_module_timeout = time.time() + module.timeout - status = self._get_module_status(module) - - while time.time() < test_module_timeout and status == 'running': - time.sleep(1) - status = self._get_module_status(module) - - LOGGER.info("Test module " + module.name + " has finished") - - def _get_module_status(self, module): - container = self._get_module_container(module) - if container is not None: - return container.status - return None - - def _get_test_module(self, name): - for test_module in self._test_modules: - if name == test_module.display_name or name == test_module.name or name == test_module.dir_name: - return test_module - return None - - def _get_module_container(self, module): - container = None - try: - client = docker.from_env() - container = client.containers.get(module.container_name) - except docker.errors.NotFound: - LOGGER.debug("Container " + - module.container_name + " not found") - except docker.errors.APIError as error: - LOGGER.error("Failed to resolve container") - LOGGER.error(error) - return container - - def _load_test_modules(self): - """Load network modules from module_config.json.""" - LOGGER.debug("Loading test modules from /" + TEST_MODULES_DIR) - - loaded_modules = "Loaded the following test modules: " - test_modules_dir = os.path.join(self._path, TEST_MODULES_DIR) - - for module_dir in os.listdir(test_modules_dir): - - if self._get_test_module(module_dir) is None: - loaded_module = self._load_test_module(module_dir) - loaded_modules += loaded_module.dir_name + " " - - LOGGER.info(loaded_modules) - - def _load_test_module(self,module_dir): - """Import module configuration from module_config.json.""" - - modules_dir = os.path.join(self._path, TEST_MODULES_DIR) - - # Load basic module information - module = TestModule() - with open(os.path.join( - self._path, - modules_dir, - module_dir, - MODULE_CONFIG), - encoding='UTF-8') as module_config_file: - module_json = json.load(module_config_file) - - module.name = module_json['config']['meta']['name'] - module.display_name = module_json['config']['meta']['display_name'] - module.description = module_json['config']['meta']['description'] - module.dir = os.path.join(self._path, modules_dir, module_dir) - module.dir_name = module_dir - module.build_file = module_dir + ".Dockerfile" - module.container_name = "tr-ct-" + module.dir_name + "-test" - module.image_name = "test-run/" + module.dir_name + "-test" - - if 'timeout' in module_json['config']['docker']: - module.timeout = module_json['config']['docker']['timeout'] - - # Determine if this is a container or just an image/template - if "enable_container" in module_json['config']['docker']: - module.enable_container = module_json['config']['docker']['enable_container'] - - if "depends_on" in module_json['config']['docker']: - depends_on_module = module_json['config']['docker']['depends_on'] - if self._get_test_module(depends_on_module) is None: - self._load_test_module(depends_on_module) - - self._test_modules.append(module) - return module - - def build_test_modules(self): - """Build all test modules.""" - LOGGER.info("Building test modules...") - for module in self._test_modules: - self._build_test_module(module) - - def _build_test_module(self, module): - LOGGER.debug("Building docker image for module " + module.dir_name) - client = docker.from_env() - try: - client.images.build( - dockerfile=os.path.join(module.dir, module.build_file), - path=self._path, - forcerm=True, # Cleans up intermediate containers during build - tag=module.image_name - ) - except docker.errors.BuildError as error: - LOGGER.error(error) - - def _stop_modules(self, kill=False): - LOGGER.info("Stopping test modules") - for module in self._test_modules: - # Test modules may just be Docker images, so we do not want to stop them - if not module.enable_container: - continue - self._stop_module(module, kill) - LOGGER.info("All test modules have been stopped") - - def _stop_module(self, module, kill=False): - LOGGER.debug("Stopping test module " + module.container_name) - try: - container = module.container - if container is not None: - if kill: - LOGGER.debug("Killing container:" + - module.container_name) - container.kill() - else: - LOGGER.debug("Stopping container:" + - module.container_name) - container.stop() - LOGGER.debug("Container stopped:" + module.container_name) - except docker.errors.NotFound: - pass + """Manages and controls the test modules.""" + + def __init__(self, net_orc): + self._test_modules = [] + self._module_config = None + self._net_orc = net_orc + + self._path = os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))) + + # Resolve the path to the test-run folder + self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) + + shutil.rmtree(os.path.join(self._root_path, RUNTIME_DIR), + ignore_errors=True) + os.makedirs(os.path.join(self._root_path, RUNTIME_DIR), exist_ok=True) + + def start(self): + LOGGER.info("Starting Test Orchestrator") + self._load_test_modules() + self.build_test_modules() + + def stop(self): + """Stop any running tests""" + self._stop_modules() + + def run_test_modules(self, device): + """Iterates through each test module and starts the container.""" + LOGGER.info( + f"Running test modules on device with mac addr {device.mac_addr}") + for module in self._test_modules: + self._run_test_module(module, device) + LOGGER.info("All tests complete") + LOGGER.info( + f"Completed running test modules on device with mac addr {device.mac_addr}") + results = self._generate_results(device) + + def _generate_results(self, device): + results = {} + for module in self._test_modules: + container_runtime_dir = os.path.join( + self._root_path, 'runtime/test/' + device.mac_addr.replace(':', '') + + '/' + module.name) + results_file = container_runtime_dir + '/' + module.name + '-result.json' + try: + with open(results_file, 'r', encoding='UTF-8') as f: + module_results = json.load(f) + results[module.name] = module_results + except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: + LOGGER.error("Module Results Errror " + module.name) + LOGGER.debug(results_error) + + out_file = os.path.join( + self._root_path, 'runtime/test/' + device.mac_addr.replace(':', '') + '/results.json') + with open(out_file, 'w') as f: + json.dump(results,f,indent=2) + return results + + def _run_test_module(self, module, device): + """Start the test container and extract the results.""" + + if module is None or not module.enable_container: + return + + LOGGER.info("Running test module " + module.name) + + try: + container_runtime_dir = os.path.join( + self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + + "/" + module.name) + network_runtime_dir = os.path.join(self._root_path, "runtime/network") + os.makedirs(container_runtime_dir) + + client = docker.from_env() + + module.container = client.containers.run( + module.image_name, + auto_remove=True, + cap_add=["NET_ADMIN"], + name=module.container_name, + hostname=module.container_name, + privileged=True, + detach=True, + mounts=[ + Mount(target="/runtime/output", + source=container_runtime_dir, + type='bind'), + Mount(target="/runtime/network", + source=network_runtime_dir, + type='bind', + read_only=True), + ], + environment={ + "HOST_USER": getpass.getuser(), + "DEVICE_MAC": device.mac_addr, + "DEVICE_TEST_MODULES": device.test_modules, + "IPV4_SUBNET": self._net_orc.network_config.ipv4_network, + "IPV6_SUBNET": self._net_orc.network_config.ipv6_network + }) + except (docker.errors.APIError, + docker.errors.ContainerError) as container_error: + LOGGER.error("Test module " + module.name + " has failed to start") + LOGGER.debug(container_error) + return + + # Mount the test container to the virtual network if requried + if module.network: + LOGGER.debug("Attaching test module to the network") + self._net_orc._attach_test_module_to_network(module) + + # Determine the module timeout time + test_module_timeout = time.time() + module.timeout + status = self._get_module_status(module) + + while time.time() < test_module_timeout and status == 'running': + time.sleep(1) + status = self._get_module_status(module) + + LOGGER.info("Test module " + module.name + " has finished") + + def _get_module_status(self, module): + container = self._get_module_container(module) + if container is not None: + return container.status + return None + + def _get_test_module(self, name): + for test_module in self._test_modules: + if name == test_module.display_name or name == test_module.name or name == test_module.dir_name: + return test_module + return None + + def _get_module_container(self, module): + container = None + try: + client = docker.from_env() + container = client.containers.get(module.container_name) + except docker.errors.NotFound: + LOGGER.debug("Container " + module.container_name + " not found") + except docker.errors.APIError as error: + LOGGER.error("Failed to resolve container") + LOGGER.error(error) + return container + + def _load_test_modules(self): + """Load network modules from module_config.json.""" + LOGGER.debug("Loading test modules from /" + TEST_MODULES_DIR) + + loaded_modules = "Loaded the following test modules: " + test_modules_dir = os.path.join(self._path, TEST_MODULES_DIR) + + for module_dir in os.listdir(test_modules_dir): + + if self._get_test_module(module_dir) is None: + loaded_module = self._load_test_module(module_dir) + loaded_modules += loaded_module.dir_name + " " + + LOGGER.info(loaded_modules) + + def _load_test_module(self, module_dir): + """Import module configuration from module_config.json.""" + + modules_dir = os.path.join(self._path, TEST_MODULES_DIR) + + # Load basic module information + module = TestModule() + with open(os.path.join(self._path, modules_dir, module_dir, MODULE_CONFIG), + encoding='UTF-8') as module_config_file: + module_json = json.load(module_config_file) + + module.name = module_json['config']['meta']['name'] + module.display_name = module_json['config']['meta']['display_name'] + module.description = module_json['config']['meta']['description'] + module.dir = os.path.join(self._path, modules_dir, module_dir) + module.dir_name = module_dir + module.build_file = module_dir + ".Dockerfile" + module.container_name = "tr-ct-" + module.dir_name + "-test" + module.image_name = "test-run/" + module.dir_name + "-test" + + if 'timeout' in module_json['config']['docker']: + module.timeout = module_json['config']['docker']['timeout'] + + # Determine if this is a container or just an image/template + if "enable_container" in module_json['config']['docker']: + module.enable_container = module_json['config']['docker'][ + 'enable_container'] + + if "depends_on" in module_json['config']['docker']: + depends_on_module = module_json['config']['docker']['depends_on'] + if self._get_test_module(depends_on_module) is None: + self._load_test_module(depends_on_module) + + self._test_modules.append(module) + return module + + def build_test_modules(self): + """Build all test modules.""" + LOGGER.info("Building test modules...") + for module in self._test_modules: + self._build_test_module(module) + + def _build_test_module(self, module): + LOGGER.debug("Building docker image for module " + module.dir_name) + client = docker.from_env() + try: + client.images.build( + dockerfile=os.path.join(module.dir, module.build_file), + path=self._path, + forcerm=True, # Cleans up intermediate containers during build + tag=module.image_name) + except docker.errors.BuildError as error: + LOGGER.error(error) + + def _stop_modules(self, kill=False): + LOGGER.info("Stopping test modules") + for module in self._test_modules: + # Test modules may just be Docker images, so we do not want to stop them + if not module.enable_container: + continue + self._stop_module(module, kill) + LOGGER.info("All test modules have been stopped") + + def _stop_module(self, module, kill=False): + LOGGER.debug("Stopping test module " + module.container_name) + try: + container = module.container + if container is not None: + if kill: + LOGGER.debug("Killing container:" + module.container_name) + container.kill() + else: + LOGGER.debug("Stopping container:" + module.container_name) + container.stop() + LOGGER.debug("Container stopped:" + module.container_name) + except docker.errors.NotFound: + pass From ea60b410c7b036b0c715049815a126d8660e1c13 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 25 May 2023 02:43:51 -0700 Subject: [PATCH 019/400] Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled --- .../modules/base/python/src/test_module.py | 6 ++- test_orc/python/src/module.py | 54 +++++++++---------- test_orc/python/src/test_orchestrator.py | 41 ++++++++++---- 3 files changed, 61 insertions(+), 40 deletions(-) diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 2ca686fa9..22b9e0773 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -66,7 +66,7 @@ def run_tests(self): result = None if ("enabled" in test and test["enabled"]) or "enabled" not in test: LOGGER.info("Attempting to run test: " + test["name"]) - + test['start'] = datetime.now().isoformat() # Resolve the correct python method by test name and run test if hasattr(self, test_method_name): if "config" in test: @@ -85,7 +85,9 @@ def run_tests(self): test["result"] = "compliant" if result else "non-compliant" else: test["result"] = "skipped" - test["timestamp"] = datetime.now().isoformat() + test['end'] = datetime.now().isoformat() + duration = datetime.fromisoformat(test['end']) - datetime.fromisoformat(test['start']) + test['duration'] = str(duration) json_results = json.dumps({"results": tests}, indent=2) self._write_results(json_results) diff --git a/test_orc/python/src/module.py b/test_orc/python/src/module.py index 6b2f14f9d..54f920fa1 100644 --- a/test_orc/python/src/module.py +++ b/test_orc/python/src/module.py @@ -1,27 +1,27 @@ -"""Represemts a test module.""" -from dataclasses import dataclass -from docker.models.containers import Container - -@dataclass -class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes - """Represents a test module.""" - - name: str = None - display_name: str = None - description: str = None - - build_file: str = None - container: Container = None - container_name: str = None - image_name :str = None - enable_container: bool = True - network: bool = True - - timeout: int = 60 - - # Absolute path - dir: str = None - dir_name: str = None - - #Set IP Index for all test modules - ip_index: str = 9 +"""Represemts a test module.""" +from dataclasses import dataclass +from docker.models.containers import Container + +@dataclass +class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes + """Represents a test module.""" + + name: str = None + display_name: str = None + description: str = None + + build_file: str = None + container: Container = None + container_name: str = None + image_name :str = None + enable_container: bool = True + network: bool = True + + timeout: int = 60 + + # Absolute path + dir: str = None + dir_name: str = None + + #Set IP Index for all test modules + ip_index: str = 9 diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index acd24b59a..f1e45e2f6 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -56,18 +56,25 @@ def run_test_modules(self, device): def _generate_results(self, device): results = {} + results["device"] = {} + if device.make is not None: + results["device"]["make"] = device.make + if device.make is not None: + results["device"]["model"] = device.model + results["device"]["mac_addr"] = device.mac_addr for module in self._test_modules: - container_runtime_dir = os.path.join( - self._root_path, 'runtime/test/' + device.mac_addr.replace(':', '') + - '/' + module.name) - results_file = container_runtime_dir + '/' + module.name + '-result.json' - try: - with open(results_file, 'r', encoding='UTF-8') as f: - module_results = json.load(f) - results[module.name] = module_results - except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: - LOGGER.error("Module Results Errror " + module.name) - LOGGER.debug(results_error) + if module.enable_container and self._is_module_enabled(module,device): + container_runtime_dir = os.path.join( + self._root_path, 'runtime/test/' + device.mac_addr.replace(':', '') + + '/' + module.name) + results_file = container_runtime_dir + '/' + module.name + '-result.json' + try: + with open(results_file, 'r', encoding='UTF-8') as f: + module_results = json.load(f) + results[module.name] = module_results + except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: + LOGGER.error("Module Results Errror " + module.name) + LOGGER.debug(results_error) out_file = os.path.join( self._root_path, 'runtime/test/' + device.mac_addr.replace(':', '') + '/results.json') @@ -75,12 +82,24 @@ def _generate_results(self, device): json.dump(results,f,indent=2) return results + def _is_module_enabled(self,module,device): + enabled = True + if device.test_modules is not None: + test_modules = json.loads(device.test_modules) + if module.name in test_modules: + if 'enabled' in test_modules[module.name]: + enabled = test_modules[module.name]["enabled"] + return enabled + def _run_test_module(self, module, device): """Start the test container and extract the results.""" if module is None or not module.enable_container: return + if not self._is_module_enabled(module,device): + return + LOGGER.info("Running test module " + module.name) try: From b6a6cdcc8b22756fabaee45bc46ec399ee3c549c Mon Sep 17 00:00:00 2001 From: Noureddine Date: Thu, 25 May 2023 14:35:16 +0000 Subject: [PATCH 020/400] Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test --- testing/test_baseline.py | 2 ++ testing/test_pylint | 7 ++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/testing/test_baseline.py b/testing/test_baseline.py index 3ab30a7c0..e8a257672 100644 --- a/testing/test_baseline.py +++ b/testing/test_baseline.py @@ -20,6 +20,7 @@ def validator_results(): with open(os.path.join(dir, '../', 'runtime/validation/faux-dev/result.json')) as f: return json.load(f) +@pytest.mark.skip(reason="requires internet") def test_internet_connectivity(container_data): assert container_data['network']['internet'] == 200 @@ -43,6 +44,7 @@ def test_dns_server_resolves(container_data): assert re.match(r'[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}', container_data['dns_response']) +@pytest.mark.skip(reason="requires internet") def test_validator_results_compliant(validator_results): results = [True if x['result'] == 'compliant' else False for x in validator_results['results']] diff --git a/testing/test_pylint b/testing/test_pylint index 833961d94..e3ade62b5 100755 --- a/testing/test_pylint +++ b/testing/test_pylint @@ -1,6 +1,6 @@ #!/bin/bash -ERROR_LIMIT=2534 +ERROR_LIMIT=1100 sudo cmd/install @@ -12,9 +12,10 @@ files=$(find . -path ./venv -prune -o -name '*.py' -print) OUT=pylint.out rm -f $OUT && touch $OUT -pylint $files -ry --extension-pkg-allow-list=docker 2>/dev/null | tee -a $OUT -new_errors=$(cat $OUT | grep "statements analysed." | awk '{print $1}') +pylint $files -ry --extension-pkg-allow-list=docker --evaluation="error + warning + refactor + convention" 2>/dev/null | tee -a $OUT + +new_errors=$(cat $OUT | grep -oP "(?!=^Your code has been rated at)([0-9]+)(?=\.00/10[ \(]?)" ) echo "$new_errors > $ERROR_LIMIT?" if (( $new_errors > $ERROR_LIMIT)); then From 3d53ecbdef973d78641d2482569ebb575fa2f601 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Thu, 25 May 2023 19:42:57 +0100 Subject: [PATCH 021/400] Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot --- .gitignore | 135 +---- framework/logger.py | 49 +- framework/test_runner.py | 93 ++- framework/testrun.py | 10 +- net_orc/network/modules/ntp/ntp-server.py | 532 +++++++++--------- .../network/modules/ovs/python/src/logger.py | 12 +- .../modules/ovs/python/src/ovs_control.py | 186 +++--- net_orc/network/modules/ovs/python/src/run.py | 60 +- .../network/modules/ovs/python/src/util.py | 30 +- net_orc/network/modules/radius/conf/ca.crt | 54 +- net_orc/python/src/network_orchestrator.py | 2 +- .../base/python/src/grpc/start_server.py | 36 +- test_orc/modules/base/python/src/logger.py | 62 +- .../modules/base/python/src/test_module.py | 185 +++--- test_orc/modules/base/python/src/util.py | 31 +- .../baseline/python/src/baseline_module.py | 43 +- test_orc/modules/baseline/python/src/run.py | 55 +- test_orc/modules/dns/python/src/dns_module.py | 101 ++-- test_orc/modules/dns/python/src/run.py | 65 ++- .../modules/nmap/python/src/nmap_module.py | 424 +++++++------- test_orc/modules/nmap/python/src/run.py | 55 +- test_orc/python/src/module.py | 5 +- test_orc/python/src/runner.py | 1 + test_orc/python/src/test_orchestrator.py | 66 ++- testing/test_baseline.py | 41 +- 25 files changed, 1119 insertions(+), 1214 deletions(-) diff --git a/.gitignore b/.gitignore index db1580ffb..5dfc1f6f9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,136 +1,7 @@ -# Runtime folder runtime/ venv/ .vscode/ - +error +pylint.out local/ - -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ +__pycache__/ \ No newline at end of file diff --git a/framework/logger.py b/framework/logger.py index 64d8fdb97..d4702cb38 100644 --- a/framework/logger.py +++ b/framework/logger.py @@ -4,45 +4,46 @@ import os LOGGERS = {} -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' _DEFAULT_LOG_LEVEL = logging.INFO _LOG_LEVEL = logging.INFO -_CONF_DIR = "conf" -_CONF_FILE_NAME = "system.json" -_LOG_DIR = "runtime/testing/" +_CONF_DIR = 'conf' +_CONF_FILE_NAME = 'system.json' +_LOG_DIR = 'runtime/testing/' # Set log level -with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='utf-8') as system_conf_file: - system_conf_json = json.load(system_conf_file) +with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), + encoding='utf-8') as system_conf_file: + system_conf_json = json.load(system_conf_file) log_level_str = system_conf_json['log_level'] temp_log = logging.getLogger('temp') try: - temp_log.setLevel(logging.getLevelName(log_level_str)) - _LOG_LEVEL = logging.getLevelName(log_level_str) + temp_log.setLevel(logging.getLevelName(log_level_str)) + _LOG_LEVEL = logging.getLevelName(log_level_str) except ValueError: - print('Invalid log level set in ' + _CONF_DIR + '/' + _CONF_FILE_NAME + - '. Using INFO as log level') - _LOG_LEVEL = _DEFAULT_LOG_LEVEL + print('Invalid log level set in ' + _CONF_DIR + '/' + _CONF_FILE_NAME + + '. Using INFO as log level') + _LOG_LEVEL = _DEFAULT_LOG_LEVEL log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) def add_file_handler(log, log_file): - handler = logging.FileHandler(_LOG_DIR + log_file + ".log") - handler.setFormatter(log_format) - log.addHandler(handler) + handler = logging.FileHandler(_LOG_DIR + log_file + '.log') + handler.setFormatter(log_format) + log.addHandler(handler) def add_stream_handler(log): - handler = logging.StreamHandler() - handler.setFormatter(log_format) - log.addHandler(handler) + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) def get_logger(name, log_file=None): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - LOGGERS[name].setLevel(_LOG_LEVEL) - add_stream_handler(LOGGERS[name]) - if log_file is not None: - add_file_handler(LOGGERS[name], log_file) - return LOGGERS[name] + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(_LOG_LEVEL) + add_stream_handler(LOGGERS[name]) + if log_file is not None: + add_file_handler(LOGGERS[name], log_file) + return LOGGERS[name] diff --git a/framework/test_runner.py b/framework/test_runner.py index 5c4bf1472..95f3e4208 100644 --- a/framework/test_runner.py +++ b/framework/test_runner.py @@ -14,61 +14,60 @@ import logger import signal -LOGGER = logger.get_logger('runner') - +LOGGER = logger.get_logger("runner") class TestRunner: + """Controls and starts the Test Run application.""" - def __init__(self, config_file=None, validate=True, net_only=False, single_intf=False): - self._register_exits() - self.test_run = TestRun(config_file=config_file, - validate=validate, - net_only=net_only, - single_intf=single_intf) - - 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 __init__(self, config_file=None, validate=True, + net_only=False, single_intf=False): + self._register_exits() + self.test_run = TestRun(config_file=config_file, + validate=validate, + net_only=net_only, + single_intf=single_intf) - 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.") - # Kill all container services quickly - # If we're here, we want everything to stop immediately - # and don't care about a gracefully shutdown - self._stop(True) - sys.exit(1) + 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 stop(self, kill=False): - self.test_run.stop(kill) + 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.") + # Kill all container services quickly + # If we're here, we want everything to stop immediately + # and don't care about a gracefully shutdown + self._stop(True) + sys.exit(1) - def start(self): - self.test_run.start() - LOGGER.info("Test Run has finished") + def stop(self, kill=False): + self.test_run.stop(kill) + def start(self): + self.test_run.start() + LOGGER.info("Test Run has finished") def parse_args(argv): - parser = argparse.ArgumentParser(description="Test Run", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-f", "--config-file", default=None, - help="Define the configuration file for Test Run and Network Orchestrator") - parser.add_argument("--no-validate", action="store_true", - help="Turn off the validation of the network after network boot") - parser.add_argument("-net", "--net-only", action="store_true", - help="Run the network only, do not run tests") - parser.add_argument("--single-intf", action="store_true", - help="Single interface mode (experimental)") - args, unknown = parser.parse_known_args() - return args - + parser = argparse.ArgumentParser(description="Test Run", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("-f", "--config-file", default=None, + help="Define the configuration file for Test Run and Network Orchestrator") + parser.add_argument("--no-validate", action="store_true", + help="Turn off the validation of the network after network boot") + parser.add_argument("-net", "--net-only", action="store_true", + help="Run the network only, do not run tests") + parser.add_argument("--single-intf", action="store_true", + help="Single interface mode (experimental)") + parsed_args = parser.parse_known_args()[0] + return parsed_args if __name__ == "__main__": - args = parse_args(sys.argv) - runner = TestRunner(config_file=args.config_file, - validate=not args.no_validate, - net_only=args.net_only, - single_intf=args.single_intf) - runner.start() + args = parse_args(sys.argv) + runner = TestRunner(config_file=args.config_file, + validate=not args.no_validate, + net_only=args.net_only, + single_intf=args.single_intf) + runner.start() diff --git a/framework/testrun.py b/framework/testrun.py index d5c70a9ca..94ad2ef9f 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -52,7 +52,7 @@ class TestRun: # pylint: disable=too-few-public-methods orchestrator and user interface. """ - def __init__(self, + def __init__(self, config_file=CONFIG_FILE, validate=True, net_only=False, @@ -97,7 +97,7 @@ def start(self): LOGGER.info('Waiting for devices on the network...') - # Check timeout and whether testing is currently + # Check timeout and whether testing is currently # in progress before stopping time.sleep(RUNTIME) @@ -138,7 +138,7 @@ def _run_tests(self, device): # To Do: Make this configurable time.sleep(60) # Let device bootup - self._test_orc._run_test_modules(device) + self._test_orc.run_test_modules(device) def _stop_network(self, kill=False): self._net_orc.stop(kill=kill) @@ -165,9 +165,9 @@ def _load_devices(self, device_dir): mac_addr = device_config_json.get(DEVICE_MAC_ADDR) test_modules = device_config_json.get(DEVICE_TEST_MODULES) - device = Device(make=device_make, + device = Device(make=device_make, model=device_model, - mac_addr=mac_addr, + mac_addr=mac_addr, test_modules=json.dumps(test_modules)) self._devices.append(device) diff --git a/net_orc/network/modules/ntp/ntp-server.py b/net_orc/network/modules/ntp/ntp-server.py index ace3099b0..9d6a6da8e 100644 --- a/net_orc/network/modules/ntp/ntp-server.py +++ b/net_orc/network/modules/ntp/ntp-server.py @@ -8,308 +8,300 @@ import select taskQueue = queue.Queue() -stopFlag = False +stop_flag = False def system_to_ntp_time(timestamp): - """Convert a system time to a NTP time. + """Convert a system time to a NTP time. - Parameters: - timestamp -- timestamp in system time + Parameters: + timestamp -- timestamp in system time - Returns: - corresponding NTP time - """ - return timestamp + NTP.NTP_DELTA + Returns: + corresponding NTP time + """ + return timestamp + NTP.NTP_DELTA def _to_int(timestamp): - """Return the integral part of a timestamp. + """Return the integral part of a timestamp. - Parameters: - timestamp -- NTP timestamp + Parameters: + timestamp -- NTP timestamp - Retuns: - integral part - """ - return int(timestamp) + Retuns: + integral part + """ + return int(timestamp) def _to_frac(timestamp, n=32): - """Return the fractional part of a timestamp. + """Return the fractional part of a timestamp. - Parameters: - timestamp -- NTP timestamp - n -- number of bits of the fractional part + Parameters: + timestamp -- NTP timestamp + n -- number of bits of the fractional part - Retuns: - fractional part - """ - return int(abs(timestamp - _to_int(timestamp)) * 2**n) + Retuns: + fractional part + """ + return int(abs(timestamp - _to_int(timestamp)) * 2**n) def _to_time(integ, frac, n=32): - """Return a timestamp from an integral and fractional part. + """Return a timestamp from an integral and fractional part. - Parameters: - integ -- integral part - frac -- fractional part - n -- number of bits of the fractional part - - Retuns: - timestamp - """ - return integ + float(frac)/2**n - + Parameters: + integ -- integral part + frac -- fractional part + n -- number of bits of the fractional part + Retuns: + timestamp + """ + return integ + float(frac)/2**n class NTPException(Exception): - """Exception raised by this module.""" - pass - + """Exception raised by this module.""" + pass class NTP: - """Helper class defining constants.""" - - _SYSTEM_EPOCH = datetime.date(*time.gmtime(0)[0:3]) - """system epoch""" - _NTP_EPOCH = datetime.date(1900, 1, 1) - """NTP epoch""" - NTP_DELTA = (_SYSTEM_EPOCH - _NTP_EPOCH).days * 24 * 3600 - """delta between system and NTP time""" - - REF_ID_TABLE = { - 'DNC': "DNC routing protocol", - 'NIST': "NIST public modem", - 'TSP': "TSP time protocol", - 'DTS': "Digital Time Service", - 'ATOM': "Atomic clock (calibrated)", - 'VLF': "VLF radio (OMEGA, etc)", - 'callsign': "Generic radio", - 'LORC': "LORAN-C radionavidation", - 'GOES': "GOES UHF environment satellite", - 'GPS': "GPS UHF satellite positioning", - } - """reference identifier table""" - - STRATUM_TABLE = { - 0: "unspecified", - 1: "primary reference", - } - """stratum table""" - - MODE_TABLE = { - 0: "unspecified", - 1: "symmetric active", - 2: "symmetric passive", - 3: "client", - 4: "server", - 5: "broadcast", - 6: "reserved for NTP control messages", - 7: "reserved for private use", - } - """mode table""" - - LEAP_TABLE = { - 0: "no warning", - 1: "last minute has 61 seconds", - 2: "last minute has 59 seconds", - 3: "alarm condition (clock not synchronized)", - } - """leap indicator table""" + """Helper class defining constants.""" + + _SYSTEM_EPOCH = datetime.date(*time.gmtime(0)[0:3]) + """system epoch""" + _NTP_EPOCH = datetime.date(1900, 1, 1) + """NTP epoch""" + NTP_DELTA = (_SYSTEM_EPOCH - _NTP_EPOCH).days * 24 * 3600 + """delta between system and NTP time""" + + REF_ID_TABLE = { + 'DNC': "DNC routing protocol", + 'NIST': "NIST public modem", + 'TSP': "TSP time protocol", + 'DTS': "Digital Time Service", + 'ATOM': "Atomic clock (calibrated)", + 'VLF': "VLF radio (OMEGA, etc)", + 'callsign': "Generic radio", + 'LORC': "LORAN-C radionavidation", + 'GOES': "GOES UHF environment satellite", + 'GPS': "GPS UHF satellite positioning", + } + """reference identifier table""" + + STRATUM_TABLE = { + 0: "unspecified", + 1: "primary reference", + } + """stratum table""" + + MODE_TABLE = { + 0: "unspecified", + 1: "symmetric active", + 2: "symmetric passive", + 3: "client", + 4: "server", + 5: "broadcast", + 6: "reserved for NTP control messages", + 7: "reserved for private use", + } + """mode table""" + + LEAP_TABLE = { + 0: "no warning", + 1: "last minute has 61 seconds", + 2: "last minute has 59 seconds", + 3: "alarm condition (clock not synchronized)", + } + """leap indicator table""" class NTPPacket: - """NTP packet class. + """NTP packet class. + + This represents an NTP packet. + """ + + _PACKET_FORMAT = "!B B B b 11I" + """packet format to pack/unpack""" - This represents an NTP packet. + def __init__(self, version=4, mode=3, tx_timestamp=0): + """Constructor. + + Parameters: + version -- NTP version + mode -- packet mode (client, server) + tx_timestamp -- packet transmit timestamp """ - - _PACKET_FORMAT = "!B B B b 11I" - """packet format to pack/unpack""" - - def __init__(self, version=4, mode=3, tx_timestamp=0): - """Constructor. - - Parameters: - version -- NTP version - mode -- packet mode (client, server) - tx_timestamp -- packet transmit timestamp - """ - self.leap = 0 - """leap second indicator""" - self.version = version - """version""" - self.mode = mode - """mode""" - self.stratum = 0 - """stratum""" - self.poll = 0 - """poll interval""" - self.precision = 0 - """precision""" - self.root_delay = 0 - """root delay""" - self.root_dispersion = 0 - """root dispersion""" - self.ref_id = 0 - """reference clock identifier""" - self.ref_timestamp = 0 - """reference timestamp""" - self.orig_timestamp = 0 - self.orig_timestamp_high = 0 - self.orig_timestamp_low = 0 - """originate timestamp""" - self.recv_timestamp = 0 - """receive timestamp""" - self.tx_timestamp = tx_timestamp - self.tx_timestamp_high = 0 - self.tx_timestamp_low = 0 - """tansmit timestamp""" - - def to_data(self): - """Convert this NTPPacket to a buffer that can be sent over a socket. - - Returns: - buffer representing this packet - - Raises: - NTPException -- in case of invalid field - """ - try: - packed = struct.pack(NTPPacket._PACKET_FORMAT, - (self.leap << 6 | self.version << 3 | self.mode), - self.stratum, - self.poll, - self.precision, - _to_int(self.root_delay) << 16 | _to_frac(self.root_delay, 16), - _to_int(self.root_dispersion) << 16 | - _to_frac(self.root_dispersion, 16), - self.ref_id, - _to_int(self.ref_timestamp), - _to_frac(self.ref_timestamp), - #Change by lichen, avoid loss of precision - self.orig_timestamp_high, - self.orig_timestamp_low, - _to_int(self.recv_timestamp), - _to_frac(self.recv_timestamp), - _to_int(self.tx_timestamp), - _to_frac(self.tx_timestamp)) - except struct.error: - raise NTPException("Invalid NTP packet fields.") - return packed - - def from_data(self, data): - """Populate this instance from a NTP packet payload received from - the network. - - Parameters: - data -- buffer payload - - Raises: - NTPException -- in case of invalid packet format - """ - try: - unpacked = struct.unpack(NTPPacket._PACKET_FORMAT, - data[0:struct.calcsize(NTPPacket._PACKET_FORMAT)]) - except struct.error: - raise NTPException("Invalid NTP packet.") - - self.leap = unpacked[0] >> 6 & 0x3 - self.version = unpacked[0] >> 3 & 0x7 - self.mode = unpacked[0] & 0x7 - self.stratum = unpacked[1] - self.poll = unpacked[2] - self.precision = unpacked[3] - self.root_delay = float(unpacked[4])/2**16 - self.root_dispersion = float(unpacked[5])/2**16 - self.ref_id = unpacked[6] - self.ref_timestamp = _to_time(unpacked[7], unpacked[8]) - self.orig_timestamp = _to_time(unpacked[9], unpacked[10]) - self.orig_timestamp_high = unpacked[9] - self.orig_timestamp_low = unpacked[10] - self.recv_timestamp = _to_time(unpacked[11], unpacked[12]) - self.tx_timestamp = _to_time(unpacked[13], unpacked[14]) - self.tx_timestamp_high = unpacked[13] - self.tx_timestamp_low = unpacked[14] - - def GetTxTimeStamp(self): - return (self.tx_timestamp_high,self.tx_timestamp_low) - - def SetOriginTimeStamp(self,high,low): - self.orig_timestamp_high = high - self.orig_timestamp_low = low - + self.leap = 0 + """leap second indicator""" + self.version = version + """version""" + self.mode = mode + """mode""" + self.stratum = 0 + """stratum""" + self.poll = 0 + """poll interval""" + self.precision = 0 + """precision""" + self.root_delay = 0 + """root delay""" + self.root_dispersion = 0 + """root dispersion""" + self.ref_id = 0 + """reference clock identifier""" + self.ref_timestamp = 0 + """reference timestamp""" + self.orig_timestamp = 0 + self.orig_timestamp_high = 0 + self.orig_timestamp_low = 0 + """originate timestamp""" + self.recv_timestamp = 0 + """receive timestamp""" + self.tx_timestamp = tx_timestamp + self.tx_timestamp_high = 0 + self.tx_timestamp_low = 0 + """tansmit timestamp""" + + def to_data(self): + """Convert this NTPPacket to a buffer that can be sent over a socket. + + Returns: + buffer representing this packet + + Raises: + NTPException -- in case of invalid field + """ + try: + packed = struct.pack(NTPPacket._PACKET_FORMAT, + (self.leap << 6 | self.version << 3 | self.mode), + self.stratum, + self.poll, + self.precision, + _to_int(self.root_delay) << 16 | _to_frac(self.root_delay, 16), + _to_int(self.root_dispersion) << 16 | + _to_frac(self.root_dispersion, 16), + self.ref_id, + _to_int(self.ref_timestamp), + _to_frac(self.ref_timestamp), + #Change by lichen, avoid loss of precision + self.orig_timestamp_high, + self.orig_timestamp_low, + _to_int(self.recv_timestamp), + _to_frac(self.recv_timestamp), + _to_int(self.tx_timestamp), + _to_frac(self.tx_timestamp)) + except struct.error: + raise NTPException("Invalid NTP packet fields.") + return packed + + def from_data(self, data): + """Populate this instance from a NTP packet payload received from + the network. + + Parameters: + data -- buffer payload + + Raises: + NTPException -- in case of invalid packet format + """ + try: + unpacked = struct.unpack(NTPPacket._PACKET_FORMAT, + data[0:struct.calcsize(NTPPacket._PACKET_FORMAT)]) + except struct.error: + raise NTPException("Invalid NTP packet.") + + self.leap = unpacked[0] >> 6 & 0x3 + self.version = unpacked[0] >> 3 & 0x7 + self.mode = unpacked[0] & 0x7 + self.stratum = unpacked[1] + self.poll = unpacked[2] + self.precision = unpacked[3] + self.root_delay = float(unpacked[4])/2**16 + self.root_dispersion = float(unpacked[5])/2**16 + self.ref_id = unpacked[6] + self.ref_timestamp = _to_time(unpacked[7], unpacked[8]) + self.orig_timestamp = _to_time(unpacked[9], unpacked[10]) + self.orig_timestamp_high = unpacked[9] + self.orig_timestamp_low = unpacked[10] + self.recv_timestamp = _to_time(unpacked[11], unpacked[12]) + self.tx_timestamp = _to_time(unpacked[13], unpacked[14]) + self.tx_timestamp_high = unpacked[13] + self.tx_timestamp_low = unpacked[14] + + def GetTxTimeStamp(self): + return (self.tx_timestamp_high,self.tx_timestamp_low) + + def SetOriginTimeStamp(self,high,low): + self.orig_timestamp_high = high + self.orig_timestamp_low = low class RecvThread(threading.Thread): - def __init__(self,socket): - threading.Thread.__init__(self) - self.socket = socket - def run(self): - global t,stopFlag - while True: - if stopFlag == True: - print("RecvThread Ended") - break - rlist,wlist,elist = select.select([self.socket],[],[],1); - if len(rlist) != 0: - print("Received %d packets" % len(rlist)) - for tempSocket in rlist: - try: - data,addr = tempSocket.recvfrom(1024) - recvTimestamp = recvTimestamp = system_to_ntp_time(time.time()) - taskQueue.put((data,addr,recvTimestamp)) - except socket.error as msg: - print(msg) + + def __init__(self,socket): + threading.Thread.__init__(self) + self.socket = socket + + def run(self): + global t,stop_flag + while True: + if stop_flag == True: + print("RecvThread Ended") + break + rlist,wlist,elist = select.select([self.socket],[],[],1) + if len(rlist) != 0: + print("Received %d packets" % len(rlist)) + for tempSocket in rlist: + try: + data,addr = tempSocket.recvfrom(1024) + recvTimestamp = recvTimestamp = system_to_ntp_time(time.time()) + taskQueue.put((data,addr,recvTimestamp)) + except socket.error as msg: + print(msg) class WorkThread(threading.Thread): - def __init__(self,socket): - threading.Thread.__init__(self) - self.socket = socket - def run(self): - global taskQueue,stopFlag - while True: - if stopFlag == True: - print("WorkThread Ended") - break - try: - data,addr,recvTimestamp = taskQueue.get(timeout=1) - recvPacket = NTPPacket() - recvPacket.from_data(data) - timeStamp_high,timeStamp_low = recvPacket.GetTxTimeStamp() - sendPacket = NTPPacket(version=4,mode=4) - sendPacket.stratum = 2 - sendPacket.poll = 10 - ''' - sendPacket.precision = 0xfa - sendPacket.root_delay = 0x0bfa - sendPacket.root_dispersion = 0x0aa7 - sendPacket.ref_id = 0x808a8c2c - ''' - sendPacket.ref_timestamp = recvTimestamp-5 - sendPacket.SetOriginTimeStamp(timeStamp_high,timeStamp_low) - sendPacket.recv_timestamp = recvTimestamp - sendPacket.tx_timestamp = system_to_ntp_time(time.time()) - socket.sendto(sendPacket.to_data(),addr) - print("Sent to %s:%d" % (addr[0],addr[1])) - except queue.Empty: - continue - - -listenIp = "0.0.0.0" -listenPort = 123 + + def __init__(self,socket): + threading.Thread.__init__(self) + self.socket = socket + + def run(self): + global taskQueue,stop_flag + while True: + if stop_flag is True: + print("WorkThread Ended") + break + try: + data,addr,recvTimestamp = taskQueue.get(timeout=1) + recvPacket = NTPPacket() + recvPacket.from_data(data) + timeStamp_high,timeStamp_low = recvPacket.GetTxTimeStamp() + sendPacket = NTPPacket(version=4,mode=4) + sendPacket.stratum = 2 + sendPacket.poll = 10 + sendPacket.ref_timestamp = recvTimestamp-5 + sendPacket.SetOriginTimeStamp(timeStamp_high,timeStamp_low) + sendPacket.recv_timestamp = recvTimestamp + sendPacket.tx_timestamp = system_to_ntp_time(time.time()) + socket.sendto(sendPacket.to_data(),addr) + print("Sent to %s:%d" % (addr[0],addr[1])) + except queue.Empty: + continue + +listen_ip = "0.0.0.0" +listen_port = 123 socket = socket.socket(socket.AF_INET,socket.SOCK_DGRAM) -socket.bind((listenIp,listenPort)) -print("local socket: ", socket.getsockname()); +socket.bind((listen_ip,listen_port)) +print(f"local socket: {socket.getsockname()}") recvThread = RecvThread(socket) recvThread.start() workThread = WorkThread(socket) workThread.start() while True: - try: - time.sleep(0.5) - except KeyboardInterrupt: - print("Exiting...") - stopFlag = True - recvThread.join() - workThread.join() - #socket.close() - print("Exited") - break - + try: + time.sleep(0.5) + except KeyboardInterrupt: + print("Exiting...") + stop_flag = True + recvThread.join() + workThread.join() + #socket.close() + print("Exited") + break diff --git a/net_orc/network/modules/ovs/python/src/logger.py b/net_orc/network/modules/ovs/python/src/logger.py index 50dfb4f50..566a5c75e 100644 --- a/net_orc/network/modules/ovs/python/src/logger.py +++ b/net_orc/network/modules/ovs/python/src/logger.py @@ -1,17 +1,17 @@ #!/usr/bin/env python3 import logging -import os -import sys LOGGERS = {} _LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" _DATE_FORMAT = '%b %02d %H:%M:%S' # Set level to debug if set as runtime flag -logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=logging.INFO) +logging.basicConfig(format=_LOG_FORMAT, + datefmt=_DATE_FORMAT, + level=logging.INFO) def get_logger(name): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - return LOGGERS[name] \ No newline at end of file + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + return LOGGERS[name] diff --git a/net_orc/network/modules/ovs/python/src/ovs_control.py b/net_orc/network/modules/ovs/python/src/ovs_control.py index 6647dc89e..53406cef2 100644 --- a/net_orc/network/modules/ovs/python/src/ovs_control.py +++ b/net_orc/network/modules/ovs/python/src/ovs_control.py @@ -1,9 +1,7 @@ #!/usr/bin/env python3 -#import ipaddress import json import logger -#import os import util CONFIG_FILE = "/ovs/conf/system.json" @@ -13,95 +11,95 @@ class OVSControl: - def __init__(self): - self._int_intf = None - self._dev_intf = None - self._load_config() - - def add_bridge(self,bridgeName): - LOGGER.info("Adding OVS Bridge: " + bridgeName) - # Create the bridge using ovs-vsctl commands - # Uses the --may-exist option to prevent failures - # if this bridge already exists by this name it won't fail - # and will not modify the existing bridge - success=util.run_command("ovs-vsctl --may-exist add-br " + bridgeName) - return success - - def add_port(self,port, bridgeName): - LOGGER.info("Adding Port " + port + " to OVS Bridge: " + bridgeName) - # Add a port to the bridge using ovs-vsctl commands - # Uses the --may-exist option to prevent failures - # if this port already exists on the bridge and will not - # modify the existing bridge - success=util.run_command("ovs-vsctl --may-exist add-port " + bridgeName + " " + port) - return success - - def create_net(self): - LOGGER.info("Creating baseline network") - - # Create data plane - self.add_bridge(DEVICE_BRIDGE) - - # Create control plane - self.add_bridge(INTERNET_BRIDGE) - - # Remove IP from internet adapter - self.set_interface_ip(self._int_intf,"0.0.0.0") - - # Add external interfaces to data and control plane - self.add_port(self._dev_intf,DEVICE_BRIDGE) - self.add_port(self._int_intf,INTERNET_BRIDGE) - - # # Set ports up - self.set_bridge_up(DEVICE_BRIDGE) - self.set_bridge_up(INTERNET_BRIDGE) - - def delete_bridge(self,bridgeName): - LOGGER.info("Deleting OVS Bridge: " + bridgeName) - # Delete the bridge using ovs-vsctl commands - # Uses the --if-exists option to prevent failures - # if this bridge does not exists - success=util.run_command("ovs-vsctl --if-exists del-br " + bridgeName) - return success - - def _load_config(self): - LOGGER.info("Loading Configuration: " + CONFIG_FILE) - config_json = json.load(open(CONFIG_FILE, 'r')) - self._int_intf = config_json['internet_intf'] - self._dev_intf = config_json['device_intf'] - LOGGER.info("Configuration Loaded") - LOGGER.info("Internet Interface: " + self._int_intf) - LOGGER.info("Device Interface: " + self._dev_intf) - - def restore_net(self): - LOGGER.info("Restoring Network...") - # Delete data plane - self.delete_bridge(DEVICE_BRIDGE) - - # Delete control plane - self.delete_bridge(INTERNET_BRIDGE) - - LOGGER.info("Network is restored") - - def show_config(self): - LOGGER.info("Show current config of OVS") - success=util.run_command("ovs-vsctl show") - return success - - def set_bridge_up(self,bridgeName): - LOGGER.info("Setting Bridge device to up state: " + bridgeName) - success=util.run_command("ip link set dev " + bridgeName + " up") - return success - - def set_interface_ip(self,interface, ipAddr): - LOGGER.info("Setting interface " + interface + " to " + ipAddr) - # Remove IP from internet adapter - util.run_command("ifconfig " + interface + " 0.0.0.0") - -if __name__ == '__main__': - ovs = OVSControl() - ovs.create_net() - ovs.show_config() - ovs.restore_net() - ovs.show_config() - + def __init__(self): + self._int_intf = None + self._dev_intf = None + self._load_config() + + def add_bridge(self, bridge_name): + LOGGER.info("Adding OVS Bridge: " + bridge_name) + # Create the bridge using ovs-vsctl commands + # Uses the --may-exist option to prevent failures + # if this bridge already exists by this name it won't fail + # and will not modify the existing bridge + success=util.run_command("ovs-vsctl --may-exist add-br " + bridge_name) + return success + + def add_port(self,port, bridge_name): + LOGGER.info("Adding Port " + port + " to OVS Bridge: " + bridge_name) + # Add a port to the bridge using ovs-vsctl commands + # Uses the --may-exist option to prevent failures + # if this port already exists on the bridge and will not + # modify the existing bridge + success=util.run_command(f"""ovs-vsctl --may-exist + add-port {bridge_name} {port}""") + return success + + def create_net(self): + LOGGER.info("Creating baseline network") + + # Create data plane + self.add_bridge(DEVICE_BRIDGE) + + # Create control plane + self.add_bridge(INTERNET_BRIDGE) + + # Remove IP from internet adapter + self.set_interface_ip(self._int_intf,"0.0.0.0") + + # Add external interfaces to data and control plane + self.add_port(self._dev_intf,DEVICE_BRIDGE) + self.add_port(self._int_intf,INTERNET_BRIDGE) + + # # Set ports up + self.set_bridge_up(DEVICE_BRIDGE) + self.set_bridge_up(INTERNET_BRIDGE) + + def delete_bridge(self,bridge_name): + LOGGER.info("Deleting OVS Bridge: " + bridge_name) + # Delete the bridge using ovs-vsctl commands + # Uses the --if-exists option to prevent failures + # if this bridge does not exists + success=util.run_command("ovs-vsctl --if-exists del-br " + bridge_name) + return success + + def _load_config(self): + LOGGER.info("Loading Configuration: " + CONFIG_FILE) + config_json = json.load(open(CONFIG_FILE, "r", encoding="utf-8")) + self._int_intf = config_json["internet_intf"] + self._dev_intf = config_json["device_intf"] + LOGGER.info("Configuration Loaded") + LOGGER.info("Internet Interface: " + self._int_intf) + LOGGER.info("Device Interface: " + self._dev_intf) + + def restore_net(self): + LOGGER.info("Restoring Network...") + # Delete data plane + self.delete_bridge(DEVICE_BRIDGE) + + # Delete control plane + self.delete_bridge(INTERNET_BRIDGE) + + LOGGER.info("Network is restored") + + def show_config(self): + LOGGER.info("Show current config of OVS") + success=util.run_command("ovs-vsctl show") + return success + + def set_bridge_up(self,bridge_name): + LOGGER.info("Setting Bridge device to up state: " + bridge_name) + success=util.run_command("ip link set dev " + bridge_name + " up") + return success + + def set_interface_ip(self,interface, ip_addr): + LOGGER.info("Setting interface " + interface + " to " + ip_addr) + # Remove IP from internet adapter + util.run_command("ifconfig " + interface + " 0.0.0.0") + +if __name__ == "__main__": + ovs = OVSControl() + ovs.create_net() + ovs.show_config() + ovs.restore_net() + ovs.show_config() diff --git a/net_orc/network/modules/ovs/python/src/run.py b/net_orc/network/modules/ovs/python/src/run.py index 4c1474e74..f91c2dfeb 100644 --- a/net_orc/network/modules/ovs/python/src/run.py +++ b/net_orc/network/modules/ovs/python/src/run.py @@ -2,7 +2,8 @@ import logger import signal -import time +import sys +import time from ovs_control import OVSControl @@ -10,44 +11,45 @@ class OVSControlRun: - def __init__(self): + def __init__(self): - signal.signal(signal.SIGINT, self.handler) - signal.signal(signal.SIGTERM, self.handler) - signal.signal(signal.SIGABRT, self.handler) - signal.signal(signal.SIGQUIT, self.handler) + signal.signal(signal.SIGINT, self.handler) + signal.signal(signal.SIGTERM, self.handler) + signal.signal(signal.SIGABRT, self.handler) + signal.signal(signal.SIGQUIT, self.handler) - LOGGER.info("Starting OVS Control") + LOGGER.info("Starting OVS Control") - # Get all components ready - self._ovs_control = OVSControl() + # Get all components ready + self._ovs_control = OVSControl() - self._ovs_control.restore_net() + self._ovs_control.restore_net() - self._ovs_control.create_net() + self._ovs_control.create_net() - self._ovs_control.show_config() + self._ovs_control.show_config() - # Get network ready (via Network orchestrator) - LOGGER.info("Network is ready. Waiting for device information...") + # Get network ready (via Network orchestrator) + LOGGER.info("Network is ready. Waiting for device information...") - #Loop forever until process is stopped - while True: - LOGGER.info("OVS Running") - time.sleep(1000) + #Loop forever until process is stopped + while True: + LOGGER.info("OVS Running") + time.sleep(1000) - # TODO: This time should be configurable (How long to hold before exiting, this could be infinite too) - #time.sleep(300) + # TODO: This time should be configurable (How long to hold before exiting, + # this could be infinite too) + #time.sleep(300) - # Tear down network - #self._ovs_control.shutdown() + # Tear down network + #self._ovs_control.shutdown() - def handler(self, signum, frame): - LOGGER.info("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.info("Exit signal received: " + str(signum)) - if (signum == 2 or signal == signal.SIGTERM): - LOGGER.info("Exit signal received. Restoring network...") - self._ovs_control.shutdown() - exit(1) + def handler(self, signum, frame): + LOGGER.info("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.info("Exit signal received: " + str(signum)) + if (signum == 2 or signal == signal.SIGTERM): + LOGGER.info("Exit signal received. Restoring network...") + self._ovs_control.shutdown() + sys.exit(1) ovs = OVSControlRun() diff --git a/net_orc/network/modules/ovs/python/src/util.py b/net_orc/network/modules/ovs/python/src/util.py index 8bb0439bc..c9eba39ff 100644 --- a/net_orc/network/modules/ovs/python/src/util.py +++ b/net_orc/network/modules/ovs/python/src/util.py @@ -3,17 +3,19 @@ def run_command(cmd): - success = False - LOGGER = logger.get_logger('util') - process = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE) - stdout, stderr = process.communicate() - if process.returncode !=0: - err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) - LOGGER.error("Command Failed: " + cmd) - LOGGER.error("Error: " + err_msg) - else: - succ_msg = "%s. Code: %s" % (stdout.strip().decode('utf-8'), process.returncode) - LOGGER.info("Command Success: " + cmd) - LOGGER.info("Success: " + succ_msg) - success = True - return success \ No newline at end of file + success = False + LOGGER = logger.get_logger('util') + process = subprocess.Popen(cmd.split(), + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + if process.returncode !=0: + err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) + LOGGER.error("Command Failed: " + cmd) + LOGGER.error("Error: " + err_msg) + else: + succ_msg = "%s. Code: %s" % (stdout.strip().decode('utf-8'), process.returncode) + LOGGER.info("Command Success: " + cmd) + LOGGER.info("Success: " + succ_msg) + success = True + return success diff --git a/net_orc/network/modules/radius/conf/ca.crt b/net_orc/network/modules/radius/conf/ca.crt index d009cb1ab..bb8aadf6a 100644 --- a/net_orc/network/modules/radius/conf/ca.crt +++ b/net_orc/network/modules/radius/conf/ca.crt @@ -1,26 +1,30 @@ -----BEGIN CERTIFICATE----- -MIIEYTCCA0mgAwIBAgIUQJ4F8hBCnCp7ASPZqG/tNQgoUR4wDQYJKoZIhvcNAQEL -BQAwgb8xCzAJBgNVBAYTAkdCMRswGQYDVQQIDBIbWzN+TGVpY2VzdGVyc2hpcmUx -FTATBgNVBAcMDExvdWdoYm9yb3VnaDEUMBIGA1UECgwLRm9yZXN0IFJvY2sxDjAM -BgNVBAsMBUN5YmVyMR8wHQYDVQQDDBZjeWJlci5mb3Jlc3Ryb2NrLmNvLnVrMTUw -MwYJKoZIhvcNAQkBFiZjeWJlcnNlY3VyaXR5LnRlc3RpbmdAZm9yZXN0cm9jay5j -by51azAeFw0yMjAzMDQxMjEzMTBaFw0yNzAzMDMxMjEzMTBaMIG/MQswCQYDVQQG -EwJHQjEbMBkGA1UECAwSG1szfkxlaWNlc3RlcnNoaXJlMRUwEwYDVQQHDAxMb3Vn -aGJvcm91Z2gxFDASBgNVBAoMC0ZvcmVzdCBSb2NrMQ4wDAYDVQQLDAVDeWJlcjEf -MB0GA1UEAwwWY3liZXIuZm9yZXN0cm9jay5jby51azE1MDMGCSqGSIb3DQEJARYm -Y3liZXJzZWN1cml0eS50ZXN0aW5nQGZvcmVzdHJvY2suY28udWswggEiMA0GCSqG -SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDDNz3vJiZ5nX8lohEhqXvxEme3srip8qF7 -r5ScIeQzsTKuPNAmoefx9TcU3SyA2BnREuDX+OCYMN62xxWG2PndOl0LNezAY22C -PJwHbaBntLKY/ZhxYSTyratM7zxKSVLtClamA/bJXBhdfZZKYOP3xlZQEQTygtzK -j5hZwDrpDARtjRZIMWPLqVcoaW9ow2urJVsdD4lYAhpQU2UIgiWo7BG3hJsUfcYX -EQyyrMKJ7xaCwzIU7Sem1PETrzeiWg4KhDijc7A0RMPWlU5ljf0CnY/IZwiDsMRl -hGmGBPvR+ddiWPZPtSKj6TPWpsaMUR9UwncLmSSrhf1otX4Mw0vbAgMBAAGjUzBR -MB0GA1UdDgQWBBR0Qxx2mDTPIfpnzO5YtycGs6t8ijAfBgNVHSMEGDAWgBR0Qxx2 -mDTPIfpnzO5YtycGs6t8ijAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUA -A4IBAQCpTMBMZGXF74WCxrIk23MUsu0OKzMs8B16Wy8BHz+7hInLZwbkx71Z0TP5 -rsMITetSANtM/k4jH7Vmr1xmzU7oSz5zKU1+7rIjKjGtih48WZdJay0uqfKe0K2s -vsRS0LVLY6IiTFWK9YrLC0QFSK7z5GDl1oc/D5yIZAkbsL6PRQJ5RQsYf5BhHfyB -PRV/KcF7c9iKVYW2vILJzbyYLHTDADTHbtfCe5+pAGxagswDjSMVkQu5iJNjbtUO -5iv7PRkgzUFru9Kk6q+LrXbzyPPCwlc3Xbh1q5jSkJLkcV3K26E7+uX5HI+Hxpeh -a8kOsdnw+N8wX6bc7eXIaGBDMine ------END CERTIFICATE----- +MIIFDzCCAvegAwIBAgIJAOb7lZzENM1TMA0GCSqGSIb3DQEBCwUAMB0xCzAJBgNV +BAYTAkZSMQ4wDAYDVQQKDAVDQVRUSzAgFw0yMjEwMDcwODIxNTVaGA8yMDcyMDky +NDA4MjE1NVowHTELMAkGA1UEBhMCRlIxDjAMBgNVBAoMBUNBVFRLMIICIjANBgkq +hkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAsZ+wd41TfLs5Vh5Wz1ESqIxwzu3iHWjJ +KbOlpnPdI6uPo9DU5xdmhcH0jc/RVis+EVn1ylFyzN3l4uIACah1Dk3frFXN/LWc +EzN7DyyHO56HZ5IpOFazVMQn5xrRwsglRop6et+Azqm+3xDpBSoKg8YhBAUsezuT +N0XlpsN3BMLjVXfwrTV1ECKP0Emg3qP3EaKRm1EdQ0uVNRNe24q5EDWiLnqlD14a +X5w1hHAj0Rr9kmKo+fs9WL7vIzbgy6xccfkKE8Wk7IR/xabTNjC5x+/7Pscqthic +tGYQ+Rm4Z1XTYDKBgoFHdI2ouscmiceqxESu3hW/IBe3iLin84kGywRGrzjLcOFI +adAj+0y3lGGV7Vw2RI3bUA6oOM8V1zbFUsZLq6+ylmvw0HQLAUeBODo6Iwu8ACxT +8/A+LmBUZFk7copLfvqFUmt8vjP7XiDuYsGvVJrTc6MJWWOITqyirhAkcP/vPoNK +l8PXhLGo66xG+hC57gCm3d3IwkXNLW6UhCHIuUa6LTTTaTehy2unDEm7Rt4ghWlw +2JuDr7QcZrWrRj1OwVAiPNkjLCF30aKxnVQxc2JY9W3H+xRC0YlDNmOpdHHvuJfS +1y1tNUq+fZQGybubDsa0l0LHfoKRGfeFXnxT6tyvNnGEaJG9mkLPXPkEBuadrnvA +oZeymb/D440CAwEAAaNQME4wHQYDVR0OBBYEFHKNGWOtO3haPEkZSVfgnxbEbTs3 +MB8GA1UdIwQYMBaAFHKNGWOtO3haPEkZSVfgnxbEbTs3MAwGA1UdEwQFMAMBAf8w +DQYJKoZIhvcNAQELBQADggIBAGzuawd3tYwDCnO84eZ+NT0uqQk37ss1fdwgDY7G +dAaeSb0oW5+tejdiLzWsKgHL7g6ClEOS3f2Vvo65fsH7BA5Ppmhk+4U6ppqbBiGG +v5WqnRz7OpdMTqunFsmYhbgbu+OZX3TTg6hkIYxFHlHDMpcMwMYtlWsPRZSlTM09 +BbaWyhqTZjbUIxemwc3JW+5zRYoA2ii/Om/2/9iUbngVqEilmUrflMcfn81ddate +0XwMcm/qhyKU+CIAPXmmtLkTms66FSSXMfqy1HizzSsCFntozUA7mtPRm53IsGpR +TOdGTe5Y5jJ/dlXwmZ5dmWBR8qlyxLpG0iB7KWNxs+V7B6kCFU3BhiLPiS/BnDap +EE1JDKu1jktJhxeAhmSsrvZ10bCKZW+dQbSjqr3wScYok/f05daB97LaAs869jra +93uJ7dYA9gfUtkaqZW9oqPrIO3FNZLL5D1z6eWcGC2+3MLhrtNTov3fthFGJyWf7 +iCBdQYofeR4EA4nfI+QcM2HAHNtChGESZ/8p/eBSU4GQW7zURELIKJ5OeTJZGAgs +bMbNbqbiyzCSuM2CHTN+Nw0rMc9AXkqSV57scCu/2ui1z1GKWeI65hKhwc++IXP7 +lJWv710T4+9DOgoi5sFNNLbRcVmkUeodFje83PTs+U/hgvQHW1+RTJ4ESTPMqVf1 +VTyk +-----END CERTIFICATE----- \ No newline at end of file diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 39fd3339c..53a94b795 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -535,7 +535,7 @@ def start_network_services(self): LOGGER.info('All network services are running') self._check_network_services() - def _attach_test_module_to_network(self, test_module): + def attach_test_module_to_network(self, test_module): LOGGER.debug('Attaching test module ' + test_module.display_name + ' to device bridge') diff --git a/test_orc/modules/base/python/src/grpc/start_server.py b/test_orc/modules/base/python/src/grpc/start_server.py index 9ed31ffcf..970da67fc 100644 --- a/test_orc/modules/base/python/src/grpc/start_server.py +++ b/test_orc/modules/base/python/src/grpc/start_server.py @@ -3,32 +3,36 @@ import proto.grpc_pb2_grpc as pb2_grpc import proto.grpc_pb2 as pb2 from network_service import NetworkService -import logging import sys import argparse -DEFAULT_PORT = '5001' +DEFAULT_PORT = "5001" + def serve(PORT): - server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) - pb2_grpc.add_NetworkModuleServicer_to_server(NetworkService(), server) - server.add_insecure_port('[::]:' + PORT) - server.start() - server.wait_for_termination() + server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) + pb2_grpc.add_NetworkModuleServicer_to_server(NetworkService(), server) + server.add_insecure_port("[::]:" + PORT) + server.start() + server.wait_for_termination() + def run(argv): - parser = argparse.ArgumentParser(description="GRPC Server for Network Module", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-p", "--port", default=DEFAULT_PORT, - help="Define the default port to run the server on.") + parser = argparse.ArgumentParser( + description="GRPC Server for Network Module", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument("-p", + "--port", + default=DEFAULT_PORT, + help="Define the default port to run the server on.") - args = parser.parse_args() + args = parser.parse_args() - PORT = args.port + PORT = args.port - print("gRPC server starting on port " + PORT) - serve(PORT) + print("gRPC server starting on port " + PORT) + serve(PORT) if __name__ == "__main__": - run(sys.argv) \ No newline at end of file + run(sys.argv) diff --git a/test_orc/modules/base/python/src/logger.py b/test_orc/modules/base/python/src/logger.py index 641aa16b4..42124beea 100644 --- a/test_orc/modules/base/python/src/logger.py +++ b/test_orc/modules/base/python/src/logger.py @@ -1,46 +1,48 @@ -#!/usr/bin/env python3 - +"""Sets up the logger to be used for the test modules.""" import json import logging import os LOGGERS = {} -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' _DEFAULT_LEVEL = logging.INFO -_CONF_DIR = "conf" -_CONF_FILE_NAME = "system.json" -_LOG_DIR = "/runtime/output/" +_CONF_DIR = 'conf' +_CONF_FILE_NAME = 'system.json' +_LOG_DIR = '/runtime/output/' # Set log level try: - system_conf_json = json.load( - open(os.path.join(_CONF_DIR, _CONF_FILE_NAME))) - log_level_str = system_conf_json['log_level'] - log_level = logging.getLevelName(log_level_str) -except: - # TODO: Print out warning that log level is incorrect or missing - log_level = _DEFAULT_LEVEL + with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), + encoding='UTF-8') as config_json_file: + system_conf_json = json.load(config_json_file) + + log_level_str = system_conf_json['log_level'] + log_level = logging.getLevelName(log_level_str) +except OSError: + # TODO: Print out warning that log level is incorrect or missing + log_level = _DEFAULT_LEVEL log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) -def add_file_handler(log, logFile): - handler = logging.FileHandler(_LOG_DIR+logFile+".log") - handler.setFormatter(log_format) - log.addHandler(handler) + +def add_file_handler(log, log_file): + handler = logging.FileHandler(_LOG_DIR + log_file + '.log') + handler.setFormatter(log_format) + log.addHandler(handler) def add_stream_handler(log): - handler = logging.StreamHandler() - handler.setFormatter(log_format) - log.addHandler(handler) - - -def get_logger(name, logFile=None): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - LOGGERS[name].setLevel(log_level) - add_stream_handler(LOGGERS[name]) - if logFile is not None: - add_file_handler(LOGGERS[name], logFile) - return LOGGERS[name] + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + + +def get_logger(name, log_file=None): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if log_file is not None: + add_file_handler(LOGGERS[name], log_file) + return LOGGERS[name] diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 22b9e0773..34af4cbb4 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -5,109 +5,108 @@ from datetime import datetime LOGGER = None -RESULTS_DIR = "/runtime/output/" -CONF_FILE = "/testrun/conf/module_config.json" +RESULTS_DIR = '/runtime/output/' +CONF_FILE = '/testrun/conf/module_config.json' class TestModule: + """An example test module.""" - def __init__(self, module_name, log_name): - self._module_name = module_name - self._device_mac = os.environ['DEVICE_MAC'] - self._ipv4_subnet = os.environ['IPV4_SUBNET'] - self._ipv6_subnet = os.environ['IPV6_SUBNET'] - self._add_logger(log_name=log_name, module_name=module_name) - self._config = self._read_config() - self._device_ipv4_addr = None - self._device_ipv6_addr = None + def __init__(self, module_name, log_name): + self._module_name = module_name + self._device_mac = os.environ['DEVICE_MAC'] + self._ipv4_subnet = os.environ['IPV4_SUBNET'] + self._ipv6_subnet = os.environ['IPV6_SUBNET'] + self._add_logger(log_name=log_name, module_name=module_name) + self._config = self._read_config() + self._device_ipv4_addr = None + self._device_ipv6_addr = None - def _add_logger(self, log_name, module_name): - global LOGGER - LOGGER = logger.get_logger(log_name, module_name) + def _add_logger(self, log_name, module_name): + global LOGGER + LOGGER = logger.get_logger(log_name, module_name) - def _get_logger(self): - return LOGGER + def _get_logger(self): + return LOGGER - def _get_tests(self): - device_test_module = self._get_device_test_module() - return self._get_device_tests(device_test_module) + def _get_tests(self): + device_test_module = self._get_device_test_module() + return self._get_device_tests(device_test_module) - def _get_device_tests(self, device_test_module): - module_tests = self._config["config"]["tests"] - if device_test_module is None: - return module_tests - elif not device_test_module["enabled"]: - return [] - else: - for test in module_tests: - # Resolve device specific configurations for the test if it exists - # and update module test config with device config options - if test["name"] in device_test_module["tests"]: - dev_test_config = device_test_module["tests"][test["name"]] - if "config" in test: - test["config"].update(dev_test_config) - return module_tests + def _get_device_tests(self, device_test_module): + module_tests = self._config['config']['tests'] + if device_test_module is None: + return module_tests + elif not device_test_module['enabled']: + return [] + else: + for test in module_tests: + # Resolve device specific configurations for the test if it exists + # and update module test config with device config options + if test['name'] in device_test_module['tests']: + dev_test_config = device_test_module['tests'][test['name']] + if 'config' in test: + test['config'].update(dev_test_config) + return module_tests - def _get_device_test_module(self): - # TODO: Make DEVICE_TEST_MODULES a static string - if 'DEVICE_TEST_MODULES' in os.environ: - test_modules = json.loads(os.environ['DEVICE_TEST_MODULES']) - if self._module_name in test_modules: - return test_modules[self._module_name] - return None + def _get_device_test_module(self): + # TODO: Make DEVICE_TEST_MODULES a static string + if 'DEVICE_TEST_MODULES' in os.environ: + test_modules = json.loads(os.environ['DEVICE_TEST_MODULES']) + if self._module_name in test_modules: + return test_modules[self._module_name] + return None - def run_tests(self): - if self._config["config"]["network"]: - self._device_ipv4_addr = self._get_device_ipv4() - LOGGER.info("Device IP Resolved: " + str(self._device_ipv4_addr)) - tests = self._get_tests() - for test in tests: - test_method_name = "_" + test["name"].replace(".", "_") - result = None - if ("enabled" in test and test["enabled"]) or "enabled" not in test: - LOGGER.info("Attempting to run test: " + test["name"]) - test['start'] = datetime.now().isoformat() - # Resolve the correct python method by test name and run test - if hasattr(self, test_method_name): - if "config" in test: - result = getattr(self, test_method_name)( - config=test["config"]) - else: - result = getattr(self, test_method_name)() - else: - LOGGER.info("Test " + test["name"] + - " not resolved. Skipping") - result = None - else: - LOGGER.info("Test " + test["name"] + - " disabled. Skipping") - if result is not None: - test["result"] = "compliant" if result else "non-compliant" - else: - test["result"] = "skipped" - test['end'] = datetime.now().isoformat() - duration = datetime.fromisoformat(test['end']) - datetime.fromisoformat(test['start']) - test['duration'] = str(duration) - json_results = json.dumps({"results": tests}, indent=2) - self._write_results(json_results) + def run_tests(self): + if self._config['config']['network']: + self._device_ipv4_addr = self._get_device_ipv4() + LOGGER.info('Device IP Resolved: ' + str(self._device_ipv4_addr)) + tests = self._get_tests() + for test in tests: + test_method_name = '_' + test['name'].replace('.', '_') + result = None + if ('enabled' in test and test['enabled']) or 'enabled' not in test: + LOGGER.info('Attempting to run test: ' + test['name']) + test['start'] = datetime.now().isoformat() + # Resolve the correct python method by test name and run test + if hasattr(self, test_method_name): + if 'config' in test: + result = getattr(self, test_method_name)(config=test['config']) + else: + result = getattr(self, test_method_name)() + else: + LOGGER.info('Test ' + test['name'] + ' not resolved. Skipping') + result = None + else: + LOGGER.info('Test ' + test['name'] + ' disabled. Skipping') + if result is not None: + test['result'] = 'compliant' if result else 'non-compliant' + else: + test['result'] = 'skipped' + test['end'] = datetime.now().isoformat() + duration = datetime.fromisoformat(test['end']) - datetime.fromisoformat( + test['start']) + test['duration'] = str(duration) + json_results = json.dumps({'results': tests}, indent=2) + self._write_results(json_results) - def _read_config(self): - f = open(CONF_FILE, encoding="utf-8") - config = json.load(f) - f.close() - return config + def _read_config(self): + f = open(CONF_FILE, encoding='utf-8') + config = json.load(f) + f.close() + return config - def _write_results(self, results): - results_file = RESULTS_DIR + self._module_name + "-result.json" - LOGGER.info("Writing results to " + results_file) - f = open(results_file, "w", encoding="utf-8") - f.write(results) - f.close() + def _write_results(self, results): + results_file = RESULTS_DIR + self._module_name + '-result.json' + LOGGER.info('Writing results to ' + results_file) + f = open(results_file, 'w', encoding='utf-8') + f.write(results) + f.close() - def _get_device_ipv4(self): - command = '/testrun/bin/get_ipv4_addr {} {}'.format( - self._ipv4_subnet, self._device_mac.upper()) - text, err = util.run_command(command) - if text: - return text.split("\n")[0] - return None + def _get_device_ipv4(self): + command = f"""/testrun/bin/get_ipv4_addr {self._ipv4_subnet} + {self._device_mac.upper()}""" + text = util.run_command(command)[0] + if text: + return text.split('\n')[0] + return None diff --git a/test_orc/modules/base/python/src/util.py b/test_orc/modules/base/python/src/util.py index a2dcfbdb1..557f450a6 100644 --- a/test_orc/modules/base/python/src/util.py +++ b/test_orc/modules/base/python/src/util.py @@ -2,6 +2,7 @@ import shlex import logger + # Runs a process at the os level # By default, returns the standard output and error output # If the caller sets optional output parameter to False, @@ -9,17 +10,19 @@ # succesful in running the command. Failure is indicated # by any return code from the process other than zero. def run_command(cmd, output=True): - success = False - LOGGER = logger.get_logger('util') - process = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE) - stdout, stderr = process.communicate() - if process.returncode !=0 and output: - err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) - LOGGER.error("Command Failed: " + cmd) - LOGGER.error("Error: " + err_msg) - else: - success = True - if output: - return stdout.strip().decode('utf-8'), stderr - else: - return success + success = False + LOGGER = logger.get_logger('util') + process = subprocess.Popen(shlex.split(cmd), + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + if process.returncode != 0 and output: + err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) + LOGGER.error("Command Failed: " + cmd) + LOGGER.error("Error: " + err_msg) + else: + success = True + if output: + return stdout.strip().decode("utf-8"), stderr + else: + return success diff --git a/test_orc/modules/baseline/python/src/baseline_module.py b/test_orc/modules/baseline/python/src/baseline_module.py index 80c04ef48..9816bd28a 100644 --- a/test_orc/modules/baseline/python/src/baseline_module.py +++ b/test_orc/modules/baseline/python/src/baseline_module.py @@ -5,27 +5,26 @@ LOG_NAME = "test_baseline" LOGGER = None + class BaselineModule(TestModule): + """An example testing module.""" + + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + global LOGGER + LOGGER = self._get_logger() + + def _baseline_pass(self): + LOGGER.info("Running baseline pass test") + LOGGER.info("Baseline pass test finished") + return True + + def _baseline_fail(self): + LOGGER.info("Running baseline pass test") + LOGGER.info("Baseline pass test finished") + return False - def __init__(self, module): - super().__init__(module_name=module, log_name=LOG_NAME) - global LOGGER - LOGGER = self._get_logger() - - def _baseline_pass(self): - LOGGER.info( - "Running baseline pass test") - LOGGER.info("Baseline pass test finished") - return True - - def _baseline_fail(self): - LOGGER.info( - "Running baseline pass test") - LOGGER.info("Baseline pass test finished") - return False - - def _baseline_skip(self): - LOGGER.info( - "Running baseline pass test") - LOGGER.info("Baseline pass test finished") - return None \ No newline at end of file + def _baseline_skip(self): + LOGGER.info("Running baseline pass test") + LOGGER.info("Baseline pass test finished") + return None diff --git a/test_orc/modules/baseline/python/src/run.py b/test_orc/modules/baseline/python/src/run.py index 8b55484ae..89b3a08e4 100644 --- a/test_orc/modules/baseline/python/src/run.py +++ b/test_orc/modules/baseline/python/src/run.py @@ -10,40 +10,47 @@ LOGGER = logger.get_logger('test_module') RUNTIME = 1500 + class BaselineModuleRunner: + """An example runner class for test modules.""" + + def __init__(self, module): - def __init__(self,module): + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) - signal.signal(signal.SIGINT, self._handler) - signal.signal(signal.SIGTERM, self._handler) - signal.signal(signal.SIGABRT, self._handler) - signal.signal(signal.SIGQUIT, self._handler) + LOGGER.info("Starting Baseline Module") - LOGGER.info("Starting Baseline Module") + self._test_module = BaselineModule(module) + self._test_module.run_tests() - self._test_module = BaselineModule(module) - self._test_module.run_tests() + def _handler(self, signum, *other): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping test module...") + LOGGER.info("Test module stopped") + sys.exit(1) - def _handler(self, signum, *other): - LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.debug("Exit signal received: " + str(signum)) - if signum in (2, signal.SIGTERM): - LOGGER.info("Exit signal received. Stopping test module...") - LOGGER.info("Test module stopped") - sys.exit(1) def run(argv): - parser = argparse.ArgumentParser(description="Baseline Module Help", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser = argparse.ArgumentParser( + description="Baseline Module Help", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + "-m", + "--module", + help="Define the module name to be used to create the log file") - parser.add_argument( - "-m", "--module", help="Define the module name to be used to create the log file") + args = parser.parse_args() - args = parser.parse_args() + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + BaselineModuleRunner(args.module.strip()) - # For some reason passing in the args from bash adds an extra - # space before the argument so we'll just strip out extra space - BaselineModuleRunner(args.module.strip()) if __name__ == "__main__": - run(sys.argv) + run(sys.argv) diff --git a/test_orc/modules/dns/python/src/dns_module.py b/test_orc/modules/dns/python/src/dns_module.py index f1333ce14..b161805a5 100644 --- a/test_orc/modules/dns/python/src/dns_module.py +++ b/test_orc/modules/dns/python/src/dns_module.py @@ -7,71 +7,70 @@ CAPTURE_FILE = "/runtime/network/dns.pcap" LOGGER = None + class DNSModule(TestModule): - def __init__(self, module): - super().__init__(module_name=module, log_name=LOG_NAME) - self._dns_server = "10.10.10.4" - global LOGGER - LOGGER = self._get_logger() + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + self._dns_server = "10.10.10.4" + global LOGGER + LOGGER = self._get_logger() - def _check_dns_traffic(self, tcpdump_filter): - to_dns = self._exec_tcpdump(tcpdump_filter) - num_query_dns = len(to_dns) - LOGGER.info("DNS queries found: " + str(num_query_dns)) - dns_traffic_detected = len(to_dns) > 0 - LOGGER.info("DNS traffic detected: " + str(dns_traffic_detected)) - return dns_traffic_detected + def _check_dns_traffic(self, tcpdump_filter): + to_dns = self._exec_tcpdump(tcpdump_filter) + num_query_dns = len(to_dns) + LOGGER.info("DNS queries found: " + str(num_query_dns)) + dns_traffic_detected = len(to_dns) > 0 + LOGGER.info("DNS traffic detected: " + str(dns_traffic_detected)) + return dns_traffic_detected - def _dns_network_from_dhcp(self): - LOGGER.info( - "Checking DNS traffic for configured DHCP DNS server: " + self._dns_server) + def _dns_network_from_dhcp(self): + LOGGER.info("Checking DNS traffic for configured DHCP DNS server: " + + self._dns_server) - # Check if the device DNS traffic is to appropriate server - tcpdump_filter = 'dst port 53 and dst host {} and ether src {}'.format( - self._dns_server, self._device_mac) + # Check if the device DNS traffic is to appropriate server + tcpdump_filter = "dst port 53 and dst host {} and ether src {}".format( + self._dns_server, self._device_mac) - result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) + result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) - LOGGER.info( - "DNS traffic detected to configured DHCP DNS server: " + str(result)) - return result + LOGGER.info("DNS traffic detected to configured DHCP DNS server: " + + str(result)) + return result - def _dns_network_from_device(self): - LOGGER.info("Checking DNS traffic from device: " + self._device_mac) + def _dns_network_from_device(self): + LOGGER.info("Checking DNS traffic from device: " + self._device_mac) - # Check if the device DNS traffic is to appropriate server - tcpdump_filter = 'dst port 53 and ether src {}'.format( - self._device_mac) + # Check if the device DNS traffic is to appropriate server + tcpdump_filter = "dst port 53 and ether src {}".format(self._device_mac) - result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) + result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) - LOGGER.info("DNS traffic detected from device: " + str(result)) - return result + LOGGER.info("DNS traffic detected from device: " + str(result)) + return result - def _exec_tcpdump(self, tcpdump_filter): - """ - Args - tcpdump_filter: Filter to pass onto tcpdump file - capture_file: Optional capture file to look - Returns - List of packets matching the filter - """ - command = 'tcpdump -tttt -n -r {} {}'.format( - CAPTURE_FILE, tcpdump_filter) + def _exec_tcpdump(self, tcpdump_filter): + """ + Args + tcpdump_filter: Filter to pass onto tcpdump file + capture_file: Optional capture file to look + Returns + List of packets matching the filter + """ + command = "tcpdump -tttt -n -r {} {}".format(CAPTURE_FILE, tcpdump_filter) - LOGGER.debug("tcpdump command: " + command) + LOGGER.debug("tcpdump command: " + command) - process = subprocess.Popen(command, - universal_newlines=True, - shell=True, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - text = str(process.stdout.read()).rstrip() + process = subprocess.Popen(command, + universal_newlines=True, + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + text = str(process.stdout.read()).rstrip() - LOGGER.debug("tcpdump response: " + text) + LOGGER.debug("tcpdump response: " + text) - if text: - return text.split("\n") + if text: + return text.split("\n") - return [] + return [] diff --git a/test_orc/modules/dns/python/src/run.py b/test_orc/modules/dns/python/src/run.py index e5fedb67b..06b8aa571 100644 --- a/test_orc/modules/dns/python/src/run.py +++ b/test_orc/modules/dns/python/src/run.py @@ -4,7 +4,6 @@ import signal import sys import logger -import time from dns_module import DNSModule @@ -12,47 +11,53 @@ LOGGER = logger.get_logger(LOG_NAME) RUNTIME = 1500 + class DNSModuleRunner: - def __init__(self,module): + def __init__(self, module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + self.add_logger(module) - signal.signal(signal.SIGINT, self._handler) - signal.signal(signal.SIGTERM, self._handler) - signal.signal(signal.SIGABRT, self._handler) - signal.signal(signal.SIGQUIT, self._handler) - self.add_logger(module) + LOGGER.info("Starting DNS Test Module") - LOGGER.info("Starting DNS Test Module") + self._test_module = DNSModule(module) + self._test_module.run_tests() - self._test_module = DNSModule(module) - self._test_module.run_tests() + LOGGER.info("DNS Test Module Finished") - LOGGER.info("DNS Test Module Finished") + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) - def add_logger(self, module): - global LOGGER - LOGGER = logger.get_logger(LOG_NAME, module) + def _handler(self, signum, *other): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping test module...") + LOGGER.info("Test module stopped") + sys.exit(1) - def _handler(self, signum, *other): - LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.debug("Exit signal received: " + str(signum)) - if signum in (2, signal.SIGTERM): - LOGGER.info("Exit signal received. Stopping test module...") - LOGGER.info("Test module stopped") - sys.exit(1) def run(argv): - parser = argparse.ArgumentParser(description="Test Module DNS", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser = argparse.ArgumentParser( + description="Test Module DNS", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + "-m", + "--module", + help="Define the module name to be used to create the log file") - parser.add_argument( - "-m", "--module", help="Define the module name to be used to create the log file") + args = parser.parse_args() - args = parser.parse_args() + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + DNSModuleRunner(args.module.strip()) - # For some reason passing in the args from bash adds an extra - # space before the argument so we'll just strip out extra space - DNSModuleRunner(args.module.strip()) if __name__ == "__main__": - run(sys.argv) + run(sys.argv) diff --git a/test_orc/modules/nmap/python/src/nmap_module.py b/test_orc/modules/nmap/python/src/nmap_module.py index 7d5bd3604..cd6ec276b 100644 --- a/test_orc/modules/nmap/python/src/nmap_module.py +++ b/test_orc/modules/nmap/python/src/nmap_module.py @@ -12,216 +12,218 @@ class NmapModule(TestModule): - def __init__(self, module): - super().__init__(module_name=module, log_name=LOG_NAME) - self._unallowed_ports = [] - self._scan_tcp_results = None - self._udp_tcp_results = None - self._script_scan_results = None - global LOGGER - LOGGER = self._get_logger() - - def _security_nmap_ports(self, config): - LOGGER.info( - "Running security.nmap.ports test") - - # Delete the enabled key from the config if it exists - # to prevent it being treated as a test key - if "enabled" in config: - del config["enabled"] - - if self._device_ipv4_addr is not None: - # Run the monitor method asynchronously to keep this method non-blocking - self._tcp_scan_thread = threading.Thread( - target=self._scan_tcp_ports, args=(config,)) - self._udp_scan_thread = threading.Thread( - target=self._scan_udp_ports, args=(config,)) - self._script_scan_thread = threading.Thread( - target=self._scan_scripts, args=(config,)) - - self._tcp_scan_thread.daemon = True - self._udp_scan_thread.daemon = True - self._script_scan_thread.daemon = True - - self._tcp_scan_thread.start() - self._udp_scan_thread.start() - self._script_scan_thread.start() - - while self._tcp_scan_thread.is_alive() or self._udp_scan_thread.is_alive() or self._script_scan_thread.is_alive(): - time.sleep(1) - - LOGGER.debug("TCP scan results: " + str(self._scan_tcp_results)) - LOGGER.debug("UDP scan results: " + str(self._scan_udp_results)) - LOGGER.debug("Service scan results: " + - str(self._script_scan_results)) - self._process_port_results( - tests=config) - LOGGER.info("Unallowed Ports: " + str(self._unallowed_ports)) - LOGGER.info("Script scan results:\n" + - json.dumps(self._script_scan_results)) - return len(self._unallowed_ports) == 0 + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + self._unallowed_ports = [] + self._scan_tcp_results = None + self._udp_tcp_results = None + self._script_scan_results = None + global LOGGER + LOGGER = self._get_logger() + + def _security_nmap_ports(self, config): + LOGGER.info("Running security.nmap.ports test") + + # Delete the enabled key from the config if it exists + # to prevent it being treated as a test key + if "enabled" in config: + del config["enabled"] + + if self._device_ipv4_addr is not None: + # Run the monitor method asynchronously to keep this method non-blocking + self._tcp_scan_thread = threading.Thread(target=self._scan_tcp_ports, + args=(config, )) + self._udp_scan_thread = threading.Thread(target=self._scan_udp_ports, + args=(config, )) + self._script_scan_thread = threading.Thread(target=self._scan_scripts, + args=(config, )) + + self._tcp_scan_thread.daemon = True + self._udp_scan_thread.daemon = True + self._script_scan_thread.daemon = True + + self._tcp_scan_thread.start() + self._udp_scan_thread.start() + self._script_scan_thread.start() + + while self._tcp_scan_thread.is_alive() or self._udp_scan_thread.is_alive( + ) or self._script_scan_thread.is_alive(): + time.sleep(1) + + LOGGER.debug("TCP scan results: " + str(self._scan_tcp_results)) + LOGGER.debug("UDP scan results: " + str(self._scan_udp_results)) + LOGGER.debug("Service scan results: " + str(self._script_scan_results)) + self._process_port_results(tests=config) + LOGGER.info("Unallowed Ports: " + str(self._unallowed_ports)) + LOGGER.info("Script scan results:\n" + + json.dumps(self._script_scan_results)) + return len(self._unallowed_ports) == 0 + else: + LOGGER.info("Device ip address not resolved, skipping") + return None + + def _process_port_results(self, tests): + for test in tests: + LOGGER.info("Checking results for test: " + str(test)) + self._check_scan_results(test_config=tests[test]) + + def _check_scan_results(self, test_config): + port_config = {} + if "tcp_ports" in test_config: + port_config.update(test_config["tcp_ports"]) + elif "udp_ports" in test_config: + port_config.update(test_config["udp_ports"]) + + scan_results = {} + if self._scan_tcp_results is not None: + scan_results.update(self._scan_tcp_results) + if self._scan_udp_results is not None: + scan_results.update(self._scan_udp_results) + if self._script_scan_results is not None: + scan_results.update(self._script_scan_results) + if port_config is not None: + for port in port_config: + result = None + LOGGER.info("Checking port: " + str(port)) + LOGGER.debug("Port config: " + str(port_config[port])) + if port in scan_results: + if scan_results[port]["state"] == "open": + if not port_config[port]["allowed"]: + LOGGER.info("Unallowed port open") + self._unallowed_ports.append(str(port)) + result = False + else: + LOGGER.info("Allowed port open") + result = True + else: + LOGGER.info("Port is closed") + result = True else: - LOGGER.info("Device ip address not resolved, skipping") - return None - - def _process_port_results(self, tests): - for test in tests: - LOGGER.info("Checking results for test: " + str(test)) - self._check_scan_results(test_config=tests[test]) - - def _check_scan_results(self, test_config): - port_config = {} - if "tcp_ports" in test_config: - port_config.update(test_config["tcp_ports"]) - elif "udp_ports" in test_config: - port_config.update(test_config["udp_ports"]) - - scan_results = {} - if self._scan_tcp_results is not None: - scan_results.update(self._scan_tcp_results) - if self._scan_udp_results is not None: - scan_results.update(self._scan_udp_results) - if self._script_scan_results is not None: - scan_results.update(self._script_scan_results) - if port_config is not None: - for port in port_config: - result = None - LOGGER.info("Checking port: " + str(port)) - LOGGER.debug("Port config: " + str(port_config[port])) - if port in scan_results: - if scan_results[port]["state"] == "open": - if not port_config[port]["allowed"]: - LOGGER.info("Unallowed port open") - self._unallowed_ports.append(str(port)) - result = False - else: - LOGGER.info("Allowed port open") - result = True - else: - LOGGER.info("Port is closed") - result = True - else: - LOGGER.info("Port not detected, closed") - result = True - - if result is not None: - port_config[port]["result"] = "compliant" if result else "non-compliant" - else: - port_config[port]["result"] = "skipped" - - def _scan_scripts(self, tests): - scan_results = {} - LOGGER.info("Checing for scan scripts") - for test in tests: - test_config = tests[test] - if "tcp_ports" in test_config: - for port in test_config["tcp_ports"]: - port_config = test_config["tcp_ports"][port] - if "service_scan" in port_config: - LOGGER.info("Service Scan Detected for: " + str(port)) - svc = port_config["service_scan"] - scan_results.update( - self._scan_tcp_with_script(svc["script"])) - if "udp_ports" in test_config: - for port in test_config["udp_ports"]: - if "service_scan" in port: - LOGGER.info("Service Scan Detected for: " + str(port)) - svc = port["service_scan"] - self._scan_udp_with_script(svc["script"], port) - scan_results.update( - self._scan_tcp_with_script(svc["script"])) - self._script_scan_results = scan_results - - def _scan_tcp_with_script(self, script_name, ports=None): - LOGGER.info("Running TCP nmap scan with script " + script_name) - scan_options = " -v -n T3 --host-timeout=6m -A --script " + script_name - port_options = " --open " - if ports is None: - port_options += " -p- " - else: - port_options += " -p" + ports + " " - results_file = "/runtime/output/" + self._module_name + "-"+script_name+".log" - nmap_options = scan_options + port_options + " -oG " + results_file - nmap_results, err = util.run_command( - "nmap " + nmap_options + " " + self._device_ipv4_addr) - LOGGER.info("Nmap TCP script scan complete") - LOGGER.info("nmap script results\n" + str(nmap_results)) - return self._process_nmap_results(nmap_results=nmap_results) - - def _scan_udp_with_script(self, script_name, ports=None): - LOGGER.info("Running UDP nmap scan with script " + script_name) - scan_options = " --sU -Pn -n --script " + script_name - port_options = " --open " - if ports is None: - port_options += " -p- " + LOGGER.info("Port not detected, closed") + result = True + + if result is not None: + port_config[port][ + "result"] = "compliant" if result else "non-compliant" else: - port_options += " -p" + ports + " " - nmap_options = scan_options + port_options - nmap_results, err = util.run_command( - "nmap " + nmap_options + self._device_ipv4_addr) - LOGGER.info("Nmap UDP script scan complete") - LOGGER.info("nmap script results\n" + str(nmap_results)) - return self._process_nmap_results(nmap_results=nmap_results) - - def _scan_tcp_ports(self, tests): - max_port = 1000 - ports = [] - for test in tests: - test_config = tests[test] - if "tcp_ports" in test_config: - for port in test_config["tcp_ports"]: - if int(port) > max_port: - ports.append(port) - ports_to_scan = "1-" + str(max_port) - if len(ports) > 0: - ports_to_scan += "," + ','.join(ports) - LOGGER.info("Running nmap TCP port scan") - LOGGER.info("TCP ports: " + str(ports_to_scan)) - nmap_results, err = util.run_command( - "nmap -sT -sV -Pn -v -p " + ports_to_scan + " --version-intensity 7 -T4 " + self._device_ipv4_addr) - LOGGER.info("TCP port scan complete") - self._scan_tcp_results = self._process_nmap_results( - nmap_results=nmap_results) - - def _scan_udp_ports(self, tests): - ports = [] - for test in tests: - test_config = tests[test] - if "udp_ports" in test_config: - for port in test_config["udp_ports"]: - ports.append(port) - if len(ports) > 0: - port_list = ','.join(ports) - LOGGER.info("Running nmap UDP port scan") - LOGGER.info("UDP ports: " + str(port_list)) - nmap_results, err = util.run_command( - "nmap -sU -sV -p " + port_list + " " + self._device_ipv4_addr) - LOGGER.info("UDP port scan complete") - self._scan_udp_results = self._process_nmap_results( - nmap_results=nmap_results) - - def _process_nmap_results(self, nmap_results): - results = {} - LOGGER.info("nmap results\n" + str(nmap_results)) - if nmap_results: - if "Service Info" in nmap_results: - rows = nmap_results.split("PORT")[1].split( - "Service Info")[0].split("\n") - elif "PORT" in nmap_results: - rows = nmap_results.split("PORT")[1].split( - "MAC Address")[0].split("\n") - if rows: - for result in rows[1:-1]: # Iterate skipping the header and tail rows - cols = result.split() - port = cols[0].split("/")[0] - # If results don't start with a a port number, it's likely a bleed over - # from previous result so we need to ignore it - if port.isdigit(): - version = "" - if len(cols) > 3: - # recombine full version information that may contain spaces - version = ' '.join(cols[3:]) - port_result = {cols[0].split( - "/")[0]: {"state": cols[1], "service": cols[2], "version": version}} - results.update(port_result) - return results + port_config[port]["result"] = "skipped" + + def _scan_scripts(self, tests): + scan_results = {} + LOGGER.info("Checing for scan scripts") + for test in tests: + test_config = tests[test] + if "tcp_ports" in test_config: + for port in test_config["tcp_ports"]: + port_config = test_config["tcp_ports"][port] + if "service_scan" in port_config: + LOGGER.info("Service Scan Detected for: " + str(port)) + svc = port_config["service_scan"] + scan_results.update(self._scan_tcp_with_script(svc["script"])) + if "udp_ports" in test_config: + for port in test_config["udp_ports"]: + if "service_scan" in port: + LOGGER.info("Service Scan Detected for: " + str(port)) + svc = port["service_scan"] + self._scan_udp_with_script(svc["script"], port) + scan_results.update(self._scan_tcp_with_script(svc["script"])) + self._script_scan_results = scan_results + + def _scan_tcp_with_script(self, script_name, ports=None): + LOGGER.info("Running TCP nmap scan with script " + script_name) + scan_options = " -v -n T3 --host-timeout=6m -A --script " + script_name + port_options = " --open " + if ports is None: + port_options += " -p- " + else: + port_options += " -p" + ports + " " + results_file = f"/runtime/output/{self._module_name}-script_name.log" + nmap_options = scan_options + port_options + " -oG " + results_file + nmap_results = util.run_command("nmap " + nmap_options + " " + + self._device_ipv4_addr)[0] + LOGGER.info("Nmap TCP script scan complete") + LOGGER.info("nmap script results\n" + str(nmap_results)) + return self._process_nmap_results(nmap_results=nmap_results) + + def _scan_udp_with_script(self, script_name, ports=None): + LOGGER.info("Running UDP nmap scan with script " + script_name) + scan_options = " --sU -Pn -n --script " + script_name + port_options = " --open " + if ports is None: + port_options += " -p- " + else: + port_options += " -p" + ports + " " + nmap_options = scan_options + port_options + nmap_results = util.run_command("nmap " + nmap_options + + self._device_ipv4_addr)[0] + LOGGER.info("Nmap UDP script scan complete") + LOGGER.info("nmap script results\n" + str(nmap_results)) + return self._process_nmap_results(nmap_results=nmap_results) + + def _scan_tcp_ports(self, tests): + max_port = 1000 + ports = [] + for test in tests: + test_config = tests[test] + if "tcp_ports" in test_config: + for port in test_config["tcp_ports"]: + if int(port) > max_port: + ports.append(port) + ports_to_scan = "1-" + str(max_port) + if len(ports) > 0: + ports_to_scan += "," + ",".join(ports) + LOGGER.info("Running nmap TCP port scan") + LOGGER.info("TCP ports: " + str(ports_to_scan)) + nmap_results = util.run_command(f"""nmap -sT -sV -Pn -v -p {ports_to_scan} + --version-intensity 7 -T4 {self._device_ipv4_addr}""")[0] + LOGGER.info("TCP port scan complete") + self._scan_tcp_results = self._process_nmap_results( + nmap_results=nmap_results) + + def _scan_udp_ports(self, tests): + ports = [] + for test in tests: + test_config = tests[test] + if "udp_ports" in test_config: + for port in test_config["udp_ports"]: + ports.append(port) + if len(ports) > 0: + port_list = ",".join(ports) + LOGGER.info("Running nmap UDP port scan") + LOGGER.info("UDP ports: " + str(port_list)) + nmap_results = util.run_command( + f"nmap -sU -sV -p {port_list} {self._device_ipv4_addr}")[0] + LOGGER.info("UDP port scan complete") + self._scan_udp_results = self._process_nmap_results( + nmap_results=nmap_results) + + def _process_nmap_results(self, nmap_results): + results = {} + LOGGER.info("nmap results\n" + str(nmap_results)) + if nmap_results: + if "Service Info" in nmap_results: + rows = nmap_results.split("PORT")[1].split("Service Info")[0].split( + "\n") + elif "PORT" in nmap_results: + rows = nmap_results.split("PORT")[1].split("MAC Address")[0].split("\n") + if rows: + for result in rows[1:-1]: # Iterate skipping the header and tail rows + cols = result.split() + port = cols[0].split("/")[0] + # If results do not start with a a port number, + # it is likely a bleed over from previous result so + # we need to ignore it + if port.isdigit(): + version = "" + if len(cols) > 3: + # recombine full version information that may contain spaces + version = " ".join(cols[3:]) + port_result = { + cols[0].split("/")[0]: { + "state": cols[1], + "service": cols[2], + "version": version + } + } + results.update(port_result) + return results diff --git a/test_orc/modules/nmap/python/src/run.py b/test_orc/modules/nmap/python/src/run.py index 4c8294769..4ed1f533c 100644 --- a/test_orc/modules/nmap/python/src/run.py +++ b/test_orc/modules/nmap/python/src/run.py @@ -9,40 +9,47 @@ LOGGER = logger.get_logger('test_module') + class NmapModuleRunner: + """Run the NMAP module tests.""" + + def __init__(self, module): - def __init__(self,module): + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) - signal.signal(signal.SIGINT, self._handler) - signal.signal(signal.SIGTERM, self._handler) - signal.signal(signal.SIGABRT, self._handler) - signal.signal(signal.SIGQUIT, self._handler) + LOGGER.info("Starting nmap Module") - LOGGER.info("Starting nmap Module") + self._test_module = NmapModule(module) + self._test_module.run_tests() - self._test_module = NmapModule(module) - self._test_module.run_tests() + def _handler(self, signum, *other): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping test module...") + LOGGER.info("Test module stopped") + sys.exit(1) - def _handler(self, signum, *other): - LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.debug("Exit signal received: " + str(signum)) - if signum in (2, signal.SIGTERM): - LOGGER.info("Exit signal received. Stopping test module...") - LOGGER.info("Test module stopped") - sys.exit(1) def run(argv): - parser = argparse.ArgumentParser(description="Nmap Module Help", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser = argparse.ArgumentParser( + description="Nmap Module Help", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + "-m", + "--module", + help="Define the module name to be used to create the log file") - parser.add_argument( - "-m", "--module", help="Define the module name to be used to create the log file") + args = parser.parse_args() - args = parser.parse_args() + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + NmapModuleRunner(args.module.strip()) - # For some reason passing in the args from bash adds an extra - # space before the argument so we'll just strip out extra space - NmapModuleRunner(args.module.strip()) if __name__ == "__main__": - run(sys.argv) + run(sys.argv) diff --git a/test_orc/python/src/module.py b/test_orc/python/src/module.py index 54f920fa1..72791f86e 100644 --- a/test_orc/python/src/module.py +++ b/test_orc/python/src/module.py @@ -2,8 +2,9 @@ from dataclasses import dataclass from docker.models.containers import Container + @dataclass -class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes +class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes """Represents a test module.""" name: str = None @@ -13,7 +14,7 @@ class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-att build_file: str = None container: Container = None container_name: str = None - image_name :str = None + image_name: str = None enable_container: bool = True network: bool = True diff --git a/test_orc/python/src/runner.py b/test_orc/python/src/runner.py index cc495bf8d..d82935057 100644 --- a/test_orc/python/src/runner.py +++ b/test_orc/python/src/runner.py @@ -4,6 +4,7 @@ LOGGER = logger.get_logger('runner') + class Runner: """Holds the state of the testing for one device.""" diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index f1e45e2f6..5cc14ae85 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -50,9 +50,9 @@ def run_test_modules(self, device): for module in self._test_modules: self._run_test_module(module, device) LOGGER.info("All tests complete") - LOGGER.info( - f"Completed running test modules on device with mac addr {device.mac_addr}") - results = self._generate_results(device) + LOGGER.info(f"""Completed running test modules on device + with mac addr {device.mac_addr}""") + self._generate_results(device) def _generate_results(self, device): results = {} @@ -63,31 +63,33 @@ def _generate_results(self, device): results["device"]["model"] = device.model results["device"]["mac_addr"] = device.mac_addr for module in self._test_modules: - if module.enable_container and self._is_module_enabled(module,device): + if module.enable_container and self._is_module_enabled(module, device): container_runtime_dir = os.path.join( - self._root_path, 'runtime/test/' + device.mac_addr.replace(':', '') + - '/' + module.name) - results_file = container_runtime_dir + '/' + module.name + '-result.json' + self._root_path, "runtime/test/" + + device.mac_addr.replace(":", "") + "/" + module.name) + results_file = container_runtime_dir + "/" + module.name + "-result.json" try: - with open(results_file, 'r', encoding='UTF-8') as f: + with open(results_file, "r", encoding="UTF-8") as f: module_results = json.load(f) results[module.name] = module_results - except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: + except (FileNotFoundError, PermissionError, + json.JSONDecodeError) as results_error: LOGGER.error("Module Results Errror " + module.name) LOGGER.debug(results_error) out_file = os.path.join( - self._root_path, 'runtime/test/' + device.mac_addr.replace(':', '') + '/results.json') - with open(out_file, 'w') as f: - json.dump(results,f,indent=2) + self._root_path, + "runtime/test/" + device.mac_addr.replace(":", "") + "/results.json") + with open(out_file, "w", encoding="utf-8") as f: + json.dump(results, f, indent=2) return results - def _is_module_enabled(self,module,device): + def _is_module_enabled(self, module, device): enabled = True if device.test_modules is not None: test_modules = json.loads(device.test_modules) if module.name in test_modules: - if 'enabled' in test_modules[module.name]: + if "enabled" in test_modules[module.name]: enabled = test_modules[module.name]["enabled"] return enabled @@ -97,7 +99,7 @@ def _run_test_module(self, module, device): if module is None or not module.enable_container: return - if not self._is_module_enabled(module,device): + if not self._is_module_enabled(module, device): return LOGGER.info("Running test module " + module.name) @@ -122,10 +124,10 @@ def _run_test_module(self, module, device): mounts=[ Mount(target="/runtime/output", source=container_runtime_dir, - type='bind'), + type="bind"), Mount(target="/runtime/network", source=network_runtime_dir, - type='bind', + type="bind", read_only=True), ], environment={ @@ -144,13 +146,13 @@ def _run_test_module(self, module, device): # Mount the test container to the virtual network if requried if module.network: LOGGER.debug("Attaching test module to the network") - self._net_orc._attach_test_module_to_network(module) + self._net_orc.attach_test_module_to_network(module) # Determine the module timeout time test_module_timeout = time.time() + module.timeout status = self._get_module_status(module) - while time.time() < test_module_timeout and status == 'running': + while time.time() < test_module_timeout and status == "running": time.sleep(1) status = self._get_module_status(module) @@ -164,7 +166,9 @@ def _get_module_status(self, module): def _get_test_module(self, name): for test_module in self._test_modules: - if name == test_module.display_name or name == test_module.name or name == test_module.dir_name: + if name in [ + test_module.display_name, test_module.name, test_module.dir_name + ]: return test_module return None @@ -203,28 +207,28 @@ def _load_test_module(self, module_dir): # Load basic module information module = TestModule() with open(os.path.join(self._path, modules_dir, module_dir, MODULE_CONFIG), - encoding='UTF-8') as module_config_file: + encoding="UTF-8") as module_config_file: module_json = json.load(module_config_file) - module.name = module_json['config']['meta']['name'] - module.display_name = module_json['config']['meta']['display_name'] - module.description = module_json['config']['meta']['description'] + module.name = module_json["config"]["meta"]["name"] + module.display_name = module_json["config"]["meta"]["display_name"] + module.description = module_json["config"]["meta"]["description"] module.dir = os.path.join(self._path, modules_dir, module_dir) module.dir_name = module_dir module.build_file = module_dir + ".Dockerfile" module.container_name = "tr-ct-" + module.dir_name + "-test" module.image_name = "test-run/" + module.dir_name + "-test" - if 'timeout' in module_json['config']['docker']: - module.timeout = module_json['config']['docker']['timeout'] + if "timeout" in module_json["config"]["docker"]: + module.timeout = module_json["config"]["docker"]["timeout"] # Determine if this is a container or just an image/template - if "enable_container" in module_json['config']['docker']: - module.enable_container = module_json['config']['docker'][ - 'enable_container'] + if "enable_container" in module_json["config"]["docker"]: + module.enable_container = module_json["config"]["docker"][ + "enable_container"] - if "depends_on" in module_json['config']['docker']: - depends_on_module = module_json['config']['docker']['depends_on'] + if "depends_on" in module_json["config"]["docker"]: + depends_on_module = module_json["config"]["docker"]["depends_on"] if self._get_test_module(depends_on_module) is None: self._load_test_module(depends_on_module) diff --git a/testing/test_baseline.py b/testing/test_baseline.py index e8a257672..6f6240c27 100644 --- a/testing/test_baseline.py +++ b/testing/test_baseline.py @@ -1,7 +1,7 @@ import json import pytest import re -import os +import os NTP_SERVER = '10.10.10.5' DNS_SERVER = '10.10.10.4' @@ -10,42 +10,45 @@ @pytest.fixture def container_data(): - dir = os.path.dirname(os.path.abspath(__file__)) - with open(CI_BASELINE_OUT) as f: - return json.load(f) + dir = os.path.dirname(os.path.abspath(__file__)) + with open(CI_BASELINE_OUT, encoding='utf-8') as f: + return json.load(f) @pytest.fixture def validator_results(): - dir = os.path.dirname(os.path.abspath(__file__)) - with open(os.path.join(dir, '../', 'runtime/validation/faux-dev/result.json')) as f: - return json.load(f) + dir = os.path.dirname(os.path.abspath(__file__)) + with open(os.path.join(dir, + '../', + 'runtime/validation/faux-dev/result.json'), + encoding='utf-8') as f: + return json.load(f) @pytest.mark.skip(reason="requires internet") def test_internet_connectivity(container_data): - assert container_data['network']['internet'] == 200 + assert container_data['network']['internet'] == 200 def test_dhcp_ntp_option(container_data): - """ Check DHCP gives NTP server as option """ - assert container_data['dhcp']['ntp-servers'] == NTP_SERVER + """ Check DHCP gives NTP server as option """ + assert container_data['dhcp']['ntp-servers'] == NTP_SERVER def test_dhcp_dns_option(container_data): - assert container_data['dhcp']['domain-name-servers'] == DNS_SERVER + assert container_data['dhcp']['domain-name-servers'] == DNS_SERVER def test_assigned_ipv4_address(container_data): - assert int(container_data['network']['ipv4'].split('.')[-1][:-3]) > 10 + assert int(container_data['network']['ipv4'].split('.')[-1][:-3]) > 10 def test_ntp_server_reachable(container_data): - assert not 'no servers' in container_data['ntp_offset'] + assert not 'no servers' in container_data['ntp_offset'] def test_dns_server_reachable(container_data): - assert not 'no servers' in container_data['dns_response'] + assert not 'no servers' in container_data['dns_response'] def test_dns_server_resolves(container_data): - assert re.match(r'[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}', - container_data['dns_response']) + assert re.match(r'[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}', + container_data['dns_response']) @pytest.mark.skip(reason="requires internet") def test_validator_results_compliant(validator_results): - results = [True if x['result'] == 'compliant' else False - for x in validator_results['results']] - assert all(results) + results = [True if x['result'] == 'compliant' else False + for x in validator_results['results']] + assert all(results) From b91fff541f95659ef9259df9a3f72e20cda9b6c0 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Tue, 30 May 2023 04:09:17 -0700 Subject: [PATCH 022/400] Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey --- framework/test_runner.py | 45 ++- net_orc/network/modules/ntp/ntp-server.py | 307 ------------------ .../network/modules/ovs/python/src/logger.py | 9 +- .../modules/ovs/python/src/ovs_control.py | 58 ++-- net_orc/network/modules/ovs/python/src/run.py | 19 +- .../network/modules/ovs/python/src/util.py | 22 +- net_orc/python/src/logger.py | 31 -- .../base/python/src/grpc/start_server.py | 29 +- .../modules/base/python/src/test_module.py | 13 +- test_orc/modules/base/python/src/util.py | 11 +- .../baseline/python/src/baseline_module.py | 4 +- test_orc/modules/baseline/python/src/run.py | 29 +- test_orc/modules/dns/python/src/dns_module.py | 36 +- test_orc/modules/dns/python/src/run.py | 11 +- .../modules/nmap/python/src/nmap_module.py | 18 +- test_orc/modules/nmap/python/src/run.py | 29 +- test_orc/python/src/test_orchestrator.py | 2 +- testing/test_baseline.py | 4 +- 18 files changed, 173 insertions(+), 504 deletions(-) delete mode 100644 net_orc/network/modules/ntp/ntp-server.py delete mode 100644 net_orc/python/src/logger.py diff --git a/framework/test_runner.py b/framework/test_runner.py index 95f3e4208..0733d4353 100644 --- a/framework/test_runner.py +++ b/framework/test_runner.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 - """Wrapper for the TestRun that simplifies virtual testing procedure by allowing direct calling from the command line. @@ -16,11 +15,15 @@ LOGGER = logger.get_logger("runner") + class TestRunner: """Controls and starts the Test Run application.""" - def __init__(self, config_file=None, validate=True, - net_only=False, single_intf=False): + def __init__(self, + config_file=None, + validate=True, + net_only=False, + single_intf=False): self._register_exits() self.test_run = TestRun(config_file=config_file, validate=validate, @@ -50,22 +53,34 @@ def start(self): self.test_run.start() LOGGER.info("Test Run has finished") -def parse_args(argv): - parser = argparse.ArgumentParser(description="Test Run", - formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-f", "--config-file", default=None, - help="Define the configuration file for Test Run and Network Orchestrator") - parser.add_argument("--no-validate", action="store_true", - help="Turn off the validation of the network after network boot") - parser.add_argument("-net", "--net-only", action="store_true", - help="Run the network only, do not run tests") - parser.add_argument("--single-intf", action="store_true", - help="Single interface mode (experimental)") + +def parse_args(): + parser = argparse.ArgumentParser( + description="Test Run", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument( + "-f", + "--config-file", + default=None, + help="Define the configuration file for Test Run and Network Orchestrator" + ) + parser.add_argument( + "--no-validate", + action="store_true", + help="Turn off the validation of the network after network boot") + parser.add_argument("-net", + "--net-only", + action="store_true", + help="Run the network only, do not run tests") + parser.add_argument("--single-intf", + action="store_true", + help="Single interface mode (experimental)") parsed_args = parser.parse_known_args()[0] return parsed_args + if __name__ == "__main__": - args = parse_args(sys.argv) + args = parse_args() runner = TestRunner(config_file=args.config_file, validate=not args.no_validate, net_only=args.net_only, diff --git a/net_orc/network/modules/ntp/ntp-server.py b/net_orc/network/modules/ntp/ntp-server.py deleted file mode 100644 index 9d6a6da8e..000000000 --- a/net_orc/network/modules/ntp/ntp-server.py +++ /dev/null @@ -1,307 +0,0 @@ -import datetime -import socket -import struct -import time -import queue - -import threading -import select - -taskQueue = queue.Queue() -stop_flag = False - -def system_to_ntp_time(timestamp): - """Convert a system time to a NTP time. - - Parameters: - timestamp -- timestamp in system time - - Returns: - corresponding NTP time - """ - return timestamp + NTP.NTP_DELTA - -def _to_int(timestamp): - """Return the integral part of a timestamp. - - Parameters: - timestamp -- NTP timestamp - - Retuns: - integral part - """ - return int(timestamp) - -def _to_frac(timestamp, n=32): - """Return the fractional part of a timestamp. - - Parameters: - timestamp -- NTP timestamp - n -- number of bits of the fractional part - - Retuns: - fractional part - """ - return int(abs(timestamp - _to_int(timestamp)) * 2**n) - -def _to_time(integ, frac, n=32): - """Return a timestamp from an integral and fractional part. - - Parameters: - integ -- integral part - frac -- fractional part - n -- number of bits of the fractional part - - Retuns: - timestamp - """ - return integ + float(frac)/2**n - -class NTPException(Exception): - """Exception raised by this module.""" - pass - -class NTP: - """Helper class defining constants.""" - - _SYSTEM_EPOCH = datetime.date(*time.gmtime(0)[0:3]) - """system epoch""" - _NTP_EPOCH = datetime.date(1900, 1, 1) - """NTP epoch""" - NTP_DELTA = (_SYSTEM_EPOCH - _NTP_EPOCH).days * 24 * 3600 - """delta between system and NTP time""" - - REF_ID_TABLE = { - 'DNC': "DNC routing protocol", - 'NIST': "NIST public modem", - 'TSP': "TSP time protocol", - 'DTS': "Digital Time Service", - 'ATOM': "Atomic clock (calibrated)", - 'VLF': "VLF radio (OMEGA, etc)", - 'callsign': "Generic radio", - 'LORC': "LORAN-C radionavidation", - 'GOES': "GOES UHF environment satellite", - 'GPS': "GPS UHF satellite positioning", - } - """reference identifier table""" - - STRATUM_TABLE = { - 0: "unspecified", - 1: "primary reference", - } - """stratum table""" - - MODE_TABLE = { - 0: "unspecified", - 1: "symmetric active", - 2: "symmetric passive", - 3: "client", - 4: "server", - 5: "broadcast", - 6: "reserved for NTP control messages", - 7: "reserved for private use", - } - """mode table""" - - LEAP_TABLE = { - 0: "no warning", - 1: "last minute has 61 seconds", - 2: "last minute has 59 seconds", - 3: "alarm condition (clock not synchronized)", - } - """leap indicator table""" - -class NTPPacket: - """NTP packet class. - - This represents an NTP packet. - """ - - _PACKET_FORMAT = "!B B B b 11I" - """packet format to pack/unpack""" - - def __init__(self, version=4, mode=3, tx_timestamp=0): - """Constructor. - - Parameters: - version -- NTP version - mode -- packet mode (client, server) - tx_timestamp -- packet transmit timestamp - """ - self.leap = 0 - """leap second indicator""" - self.version = version - """version""" - self.mode = mode - """mode""" - self.stratum = 0 - """stratum""" - self.poll = 0 - """poll interval""" - self.precision = 0 - """precision""" - self.root_delay = 0 - """root delay""" - self.root_dispersion = 0 - """root dispersion""" - self.ref_id = 0 - """reference clock identifier""" - self.ref_timestamp = 0 - """reference timestamp""" - self.orig_timestamp = 0 - self.orig_timestamp_high = 0 - self.orig_timestamp_low = 0 - """originate timestamp""" - self.recv_timestamp = 0 - """receive timestamp""" - self.tx_timestamp = tx_timestamp - self.tx_timestamp_high = 0 - self.tx_timestamp_low = 0 - """tansmit timestamp""" - - def to_data(self): - """Convert this NTPPacket to a buffer that can be sent over a socket. - - Returns: - buffer representing this packet - - Raises: - NTPException -- in case of invalid field - """ - try: - packed = struct.pack(NTPPacket._PACKET_FORMAT, - (self.leap << 6 | self.version << 3 | self.mode), - self.stratum, - self.poll, - self.precision, - _to_int(self.root_delay) << 16 | _to_frac(self.root_delay, 16), - _to_int(self.root_dispersion) << 16 | - _to_frac(self.root_dispersion, 16), - self.ref_id, - _to_int(self.ref_timestamp), - _to_frac(self.ref_timestamp), - #Change by lichen, avoid loss of precision - self.orig_timestamp_high, - self.orig_timestamp_low, - _to_int(self.recv_timestamp), - _to_frac(self.recv_timestamp), - _to_int(self.tx_timestamp), - _to_frac(self.tx_timestamp)) - except struct.error: - raise NTPException("Invalid NTP packet fields.") - return packed - - def from_data(self, data): - """Populate this instance from a NTP packet payload received from - the network. - - Parameters: - data -- buffer payload - - Raises: - NTPException -- in case of invalid packet format - """ - try: - unpacked = struct.unpack(NTPPacket._PACKET_FORMAT, - data[0:struct.calcsize(NTPPacket._PACKET_FORMAT)]) - except struct.error: - raise NTPException("Invalid NTP packet.") - - self.leap = unpacked[0] >> 6 & 0x3 - self.version = unpacked[0] >> 3 & 0x7 - self.mode = unpacked[0] & 0x7 - self.stratum = unpacked[1] - self.poll = unpacked[2] - self.precision = unpacked[3] - self.root_delay = float(unpacked[4])/2**16 - self.root_dispersion = float(unpacked[5])/2**16 - self.ref_id = unpacked[6] - self.ref_timestamp = _to_time(unpacked[7], unpacked[8]) - self.orig_timestamp = _to_time(unpacked[9], unpacked[10]) - self.orig_timestamp_high = unpacked[9] - self.orig_timestamp_low = unpacked[10] - self.recv_timestamp = _to_time(unpacked[11], unpacked[12]) - self.tx_timestamp = _to_time(unpacked[13], unpacked[14]) - self.tx_timestamp_high = unpacked[13] - self.tx_timestamp_low = unpacked[14] - - def GetTxTimeStamp(self): - return (self.tx_timestamp_high,self.tx_timestamp_low) - - def SetOriginTimeStamp(self,high,low): - self.orig_timestamp_high = high - self.orig_timestamp_low = low - -class RecvThread(threading.Thread): - - def __init__(self,socket): - threading.Thread.__init__(self) - self.socket = socket - - def run(self): - global t,stop_flag - while True: - if stop_flag == True: - print("RecvThread Ended") - break - rlist,wlist,elist = select.select([self.socket],[],[],1) - if len(rlist) != 0: - print("Received %d packets" % len(rlist)) - for tempSocket in rlist: - try: - data,addr = tempSocket.recvfrom(1024) - recvTimestamp = recvTimestamp = system_to_ntp_time(time.time()) - taskQueue.put((data,addr,recvTimestamp)) - except socket.error as msg: - print(msg) - -class WorkThread(threading.Thread): - - def __init__(self,socket): - threading.Thread.__init__(self) - self.socket = socket - - def run(self): - global taskQueue,stop_flag - while True: - if stop_flag is True: - print("WorkThread Ended") - break - try: - data,addr,recvTimestamp = taskQueue.get(timeout=1) - recvPacket = NTPPacket() - recvPacket.from_data(data) - timeStamp_high,timeStamp_low = recvPacket.GetTxTimeStamp() - sendPacket = NTPPacket(version=4,mode=4) - sendPacket.stratum = 2 - sendPacket.poll = 10 - sendPacket.ref_timestamp = recvTimestamp-5 - sendPacket.SetOriginTimeStamp(timeStamp_high,timeStamp_low) - sendPacket.recv_timestamp = recvTimestamp - sendPacket.tx_timestamp = system_to_ntp_time(time.time()) - socket.sendto(sendPacket.to_data(),addr) - print("Sent to %s:%d" % (addr[0],addr[1])) - except queue.Empty: - continue - -listen_ip = "0.0.0.0" -listen_port = 123 -socket = socket.socket(socket.AF_INET,socket.SOCK_DGRAM) -socket.bind((listen_ip,listen_port)) -print(f"local socket: {socket.getsockname()}") -recvThread = RecvThread(socket) -recvThread.start() -workThread = WorkThread(socket) -workThread.start() - -while True: - try: - time.sleep(0.5) - except KeyboardInterrupt: - print("Exiting...") - stop_flag = True - recvThread.join() - workThread.join() - #socket.close() - print("Exited") - break diff --git a/net_orc/network/modules/ovs/python/src/logger.py b/net_orc/network/modules/ovs/python/src/logger.py index 566a5c75e..23e697e43 100644 --- a/net_orc/network/modules/ovs/python/src/logger.py +++ b/net_orc/network/modules/ovs/python/src/logger.py @@ -1,14 +1,13 @@ -#!/usr/bin/env python3 - +"""Sets up the logger to be used for the ovs modules.""" import logging LOGGERS = {} -_LOG_FORMAT = "%(asctime)s %(name)-8s %(levelname)-7s %(message)s" +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' # Set level to debug if set as runtime flag -logging.basicConfig(format=_LOG_FORMAT, - datefmt=_DATE_FORMAT, +logging.basicConfig(format=_LOG_FORMAT, + datefmt=_DATE_FORMAT, level=logging.INFO) def get_logger(name): diff --git a/net_orc/network/modules/ovs/python/src/ovs_control.py b/net_orc/network/modules/ovs/python/src/ovs_control.py index 53406cef2..765c50f92 100644 --- a/net_orc/network/modules/ovs/python/src/ovs_control.py +++ b/net_orc/network/modules/ovs/python/src/ovs_control.py @@ -1,32 +1,31 @@ -#!/usr/bin/env python3 - +"""OVS Control Module""" import json import logger import util -CONFIG_FILE = "/ovs/conf/system.json" -DEVICE_BRIDGE = "tr-d" -INTERNET_BRIDGE = "tr-c" +CONFIG_FILE = '/ovs/conf/system.json' +DEVICE_BRIDGE = 'tr-d' +INTERNET_BRIDGE = 'tr-c' LOGGER = logger.get_logger('ovs_ctrl') class OVSControl: - + """OVS Control""" def __init__(self): self._int_intf = None self._dev_intf = None self._load_config() def add_bridge(self, bridge_name): - LOGGER.info("Adding OVS Bridge: " + bridge_name) + LOGGER.info('Adding OVS Bridge: ' + bridge_name) # Create the bridge using ovs-vsctl commands # Uses the --may-exist option to prevent failures # if this bridge already exists by this name it won't fail # and will not modify the existing bridge - success=util.run_command("ovs-vsctl --may-exist add-br " + bridge_name) + success=util.run_command('ovs-vsctl --may-exist add-br ' + bridge_name) return success def add_port(self,port, bridge_name): - LOGGER.info("Adding Port " + port + " to OVS Bridge: " + bridge_name) + LOGGER.info('Adding Port ' + port + ' to OVS Bridge: ' + bridge_name) # Add a port to the bridge using ovs-vsctl commands # Uses the --may-exist option to prevent failures # if this port already exists on the bridge and will not @@ -36,7 +35,7 @@ def add_port(self,port, bridge_name): return success def create_net(self): - LOGGER.info("Creating baseline network") + LOGGER.info('Creating baseline network') # Create data plane self.add_bridge(DEVICE_BRIDGE) @@ -45,7 +44,7 @@ def create_net(self): self.add_bridge(INTERNET_BRIDGE) # Remove IP from internet adapter - self.set_interface_ip(self._int_intf,"0.0.0.0") + self.set_interface_ip(self._int_intf,'0.0.0.0') # Add external interfaces to data and control plane self.add_port(self._dev_intf,DEVICE_BRIDGE) @@ -56,48 +55,49 @@ def create_net(self): self.set_bridge_up(INTERNET_BRIDGE) def delete_bridge(self,bridge_name): - LOGGER.info("Deleting OVS Bridge: " + bridge_name) + LOGGER.info('Deleting OVS Bridge: ' + bridge_name) # Delete the bridge using ovs-vsctl commands # Uses the --if-exists option to prevent failures # if this bridge does not exists - success=util.run_command("ovs-vsctl --if-exists del-br " + bridge_name) + success=util.run_command('ovs-vsctl --if-exists del-br ' + bridge_name) return success def _load_config(self): - LOGGER.info("Loading Configuration: " + CONFIG_FILE) - config_json = json.load(open(CONFIG_FILE, "r", encoding="utf-8")) - self._int_intf = config_json["internet_intf"] - self._dev_intf = config_json["device_intf"] - LOGGER.info("Configuration Loaded") - LOGGER.info("Internet Interface: " + self._int_intf) - LOGGER.info("Device Interface: " + self._dev_intf) + LOGGER.info('Loading Configuration: ' + CONFIG_FILE) + with open(CONFIG_FILE, 'r', encoding='utf-8') as conf_file: + config_json = json.load(conf_file) + self._int_intf = config_json['internet_intf'] + self._dev_intf = config_json['device_intf'] + LOGGER.info('Configuration Loaded') + LOGGER.info('Internet Interface: ' + self._int_intf) + LOGGER.info('Device Interface: ' + self._dev_intf) def restore_net(self): - LOGGER.info("Restoring Network...") + LOGGER.info('Restoring Network...') # Delete data plane self.delete_bridge(DEVICE_BRIDGE) # Delete control plane self.delete_bridge(INTERNET_BRIDGE) - LOGGER.info("Network is restored") + LOGGER.info('Network is restored') def show_config(self): - LOGGER.info("Show current config of OVS") - success=util.run_command("ovs-vsctl show") + LOGGER.info('Show current config of OVS') + success=util.run_command('ovs-vsctl show') return success def set_bridge_up(self,bridge_name): - LOGGER.info("Setting Bridge device to up state: " + bridge_name) - success=util.run_command("ip link set dev " + bridge_name + " up") + LOGGER.info('Setting Bridge device to up state: ' + bridge_name) + success=util.run_command('ip link set dev ' + bridge_name + ' up') return success def set_interface_ip(self,interface, ip_addr): - LOGGER.info("Setting interface " + interface + " to " + ip_addr) + LOGGER.info('Setting interface ' + interface + ' to ' + ip_addr) # Remove IP from internet adapter - util.run_command("ifconfig " + interface + " 0.0.0.0") + util.run_command('ifconfig ' + interface + ' 0.0.0.0') -if __name__ == "__main__": +if __name__ == '__main__': ovs = OVSControl() ovs.create_net() ovs.show_config() diff --git a/net_orc/network/modules/ovs/python/src/run.py b/net_orc/network/modules/ovs/python/src/run.py index f91c2dfeb..5787a74e6 100644 --- a/net_orc/network/modules/ovs/python/src/run.py +++ b/net_orc/network/modules/ovs/python/src/run.py @@ -1,5 +1,4 @@ -#!/usr/bin/env python3 - +"""Run OVS module""" import logger import signal import sys @@ -10,7 +9,7 @@ LOGGER = logger.get_logger('ovs_control_run') class OVSControlRun: - + """Run the OVS module.""" def __init__(self): signal.signal(signal.SIGINT, self.handler) @@ -18,7 +17,7 @@ def __init__(self): signal.signal(signal.SIGABRT, self.handler) signal.signal(signal.SIGQUIT, self.handler) - LOGGER.info("Starting OVS Control") + LOGGER.info('Starting OVS Control') # Get all components ready self._ovs_control = OVSControl() @@ -30,11 +29,11 @@ def __init__(self): self._ovs_control.show_config() # Get network ready (via Network orchestrator) - LOGGER.info("Network is ready. Waiting for device information...") + LOGGER.info('Network is ready. Waiting for device information...') #Loop forever until process is stopped while True: - LOGGER.info("OVS Running") + LOGGER.info('OVS Running') time.sleep(1000) # TODO: This time should be configurable (How long to hold before exiting, @@ -44,11 +43,11 @@ def __init__(self): # Tear down network #self._ovs_control.shutdown() - def handler(self, signum, frame): - LOGGER.info("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.info("Exit signal received: " + str(signum)) + def handler(self, signum): + LOGGER.info('SigtermEnum: ' + str(signal.SIGTERM)) + LOGGER.info('Exit signal received: ' + str(signum)) if (signum == 2 or signal == signal.SIGTERM): - LOGGER.info("Exit signal received. Restoring network...") + LOGGER.info('Exit signal received. Restoring network...') self._ovs_control.shutdown() sys.exit(1) diff --git a/net_orc/network/modules/ovs/python/src/util.py b/net_orc/network/modules/ovs/python/src/util.py index c9eba39ff..a3ebbb10a 100644 --- a/net_orc/network/modules/ovs/python/src/util.py +++ b/net_orc/network/modules/ovs/python/src/util.py @@ -1,21 +1,23 @@ +"""Provides basic utilities for a ovs module.""" import subprocess import logger +LOGGER = logger.get_logger('util') def run_command(cmd): success = False - LOGGER = logger.get_logger('util') - process = subprocess.Popen(cmd.split(), - stdout=subprocess.PIPE, + process = subprocess.Popen(cmd.split(), + stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = process.communicate() - if process.returncode !=0: - err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) - LOGGER.error("Command Failed: " + cmd) - LOGGER.error("Error: " + err_msg) + if process.returncode != 0: + err_msg = f'{stderr.strip()}. Code: {process.returncode}' + LOGGER.error('Command Failed: ' + cmd) + LOGGER.error('Error: ' + err_msg) else: - succ_msg = "%s. Code: %s" % (stdout.strip().decode('utf-8'), process.returncode) - LOGGER.info("Command Success: " + cmd) - LOGGER.info("Success: " + succ_msg) + msg = stdout.strip().decode('utf-8') + succ_msg = f'{msg}. Code: {process.returncode}' + LOGGER.info('Command Success: ' + cmd) + LOGGER.info('Success: ' + succ_msg) success = True return success diff --git a/net_orc/python/src/logger.py b/net_orc/python/src/logger.py deleted file mode 100644 index aaf690c8a..000000000 --- a/net_orc/python/src/logger.py +++ /dev/null @@ -1,31 +0,0 @@ -"""Sets up the logger to be used for the network orchestrator.""" -import json -import logging -import os - -LOGGERS = {} -_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' -_DATE_FORMAT = '%b %02d %H:%M:%S' -_DEFAULT_LEVEL = logging.INFO -_CONF_DIR = 'conf' -_CONF_FILE_NAME = 'system.json' - -# Set log level -try: - - with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), - encoding='UTF-8') as config_json_file: - system_conf_json = json.load(config_json_file) - - log_level_str = system_conf_json['log_level'] - LOG_LEVEL = logging.getLevelName(log_level_str) -except OSError: - LOG_LEVEL = _DEFAULT_LEVEL - -logging.basicConfig(format=_LOG_FORMAT, datefmt=_DATE_FORMAT, level=LOG_LEVEL) - - -def get_logger(name): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - return LOGGERS[name] diff --git a/test_orc/modules/base/python/src/grpc/start_server.py b/test_orc/modules/base/python/src/grpc/start_server.py index 970da67fc..b4016c831 100644 --- a/test_orc/modules/base/python/src/grpc/start_server.py +++ b/test_orc/modules/base/python/src/grpc/start_server.py @@ -1,38 +1,37 @@ +"""Base class for starting the gRPC server for a network module.""" from concurrent import futures import grpc import proto.grpc_pb2_grpc as pb2_grpc -import proto.grpc_pb2 as pb2 from network_service import NetworkService -import sys import argparse -DEFAULT_PORT = "5001" +DEFAULT_PORT = '5001' -def serve(PORT): +def serve(port): server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) pb2_grpc.add_NetworkModuleServicer_to_server(NetworkService(), server) - server.add_insecure_port("[::]:" + PORT) + server.add_insecure_port('[::]:' + port) server.start() server.wait_for_termination() -def run(argv): +def run(): parser = argparse.ArgumentParser( - description="GRPC Server for Network Module", + description='GRPC Server for Network Module', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument("-p", - "--port", + parser.add_argument('-p', + '--port', default=DEFAULT_PORT, - help="Define the default port to run the server on.") + help='Define the default port to run the server on.') args = parser.parse_args() - PORT = args.port + port = args.port - print("gRPC server starting on port " + PORT) - serve(PORT) + print('gRPC server starting on port ' + port) + serve(port) -if __name__ == "__main__": - run(sys.argv) +if __name__ == '__main__': + run() diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 34af4cbb4..8e10a3637 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -1,3 +1,4 @@ +"""Base class for all core test module functions""" import json import logger import os @@ -91,20 +92,18 @@ def run_tests(self): self._write_results(json_results) def _read_config(self): - f = open(CONF_FILE, encoding='utf-8') - config = json.load(f) - f.close() + with open(CONF_FILE, encoding='utf-8') as f: + config = json.load(f) return config def _write_results(self, results): results_file = RESULTS_DIR + self._module_name + '-result.json' LOGGER.info('Writing results to ' + results_file) - f = open(results_file, 'w', encoding='utf-8') - f.write(results) - f.close() + with open(results_file, 'w', encoding='utf-8') as f: + f.write(results) def _get_device_ipv4(self): - command = f"""/testrun/bin/get_ipv4_addr {self._ipv4_subnet} + command = f"""/testrun/bin/get_ipv4_addr {self._ipv4_subnet} {self._device_mac.upper()}""" text = util.run_command(command)[0] if text: diff --git a/test_orc/modules/base/python/src/util.py b/test_orc/modules/base/python/src/util.py index 557f450a6..d387db796 100644 --- a/test_orc/modules/base/python/src/util.py +++ b/test_orc/modules/base/python/src/util.py @@ -1,7 +1,9 @@ +"""Provides basic utilities for a test module.""" import subprocess import shlex import logger +LOGGER = logger.get_logger('util') # Runs a process at the os level # By default, returns the standard output and error output @@ -11,18 +13,17 @@ # by any return code from the process other than zero. def run_command(cmd, output=True): success = False - LOGGER = logger.get_logger('util') process = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = process.communicate() if process.returncode != 0 and output: - err_msg = "%s. Code: %s" % (stderr.strip(), process.returncode) - LOGGER.error("Command Failed: " + cmd) - LOGGER.error("Error: " + err_msg) + err_msg = f'{stderr.strip()}. Code: {process.returncode}' + LOGGER.error('Command Failed: ' + cmd) + LOGGER.error('Error: ' + err_msg) else: success = True if output: - return stdout.strip().decode("utf-8"), stderr + return stdout.strip().decode('utf-8'), stderr else: return success diff --git a/test_orc/modules/baseline/python/src/baseline_module.py b/test_orc/modules/baseline/python/src/baseline_module.py index 9816bd28a..083123436 100644 --- a/test_orc/modules/baseline/python/src/baseline_module.py +++ b/test_orc/modules/baseline/python/src/baseline_module.py @@ -1,5 +1,4 @@ -#!/usr/bin/env python3 - +"""Baseline test module""" from test_module import TestModule LOG_NAME = "test_baseline" @@ -27,4 +26,3 @@ def _baseline_fail(self): def _baseline_skip(self): LOGGER.info("Running baseline pass test") LOGGER.info("Baseline pass test finished") - return None diff --git a/test_orc/modules/baseline/python/src/run.py b/test_orc/modules/baseline/python/src/run.py index 89b3a08e4..1892ed8ae 100644 --- a/test_orc/modules/baseline/python/src/run.py +++ b/test_orc/modules/baseline/python/src/run.py @@ -1,5 +1,4 @@ -#!/usr/bin/env python3 - +"""Run Baseline module""" import argparse import signal import sys @@ -21,29 +20,29 @@ def __init__(self, module): signal.signal(signal.SIGABRT, self._handler) signal.signal(signal.SIGQUIT, self._handler) - LOGGER.info("Starting Baseline Module") + LOGGER.info('Starting Baseline Module') self._test_module = BaselineModule(module) self._test_module.run_tests() - def _handler(self, signum, *other): - LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.debug("Exit signal received: " + str(signum)) + def _handler(self, signum): + LOGGER.debug('SigtermEnum: ' + str(signal.SIGTERM)) + LOGGER.debug('Exit signal received: ' + str(signum)) if signum in (2, signal.SIGTERM): - LOGGER.info("Exit signal received. Stopping test module...") - LOGGER.info("Test module stopped") + LOGGER.info('Exit signal received. Stopping test module...') + LOGGER.info('Test module stopped') sys.exit(1) -def run(argv): +def run(): parser = argparse.ArgumentParser( - description="Baseline Module Help", + description='Baseline Module Help', formatter_class=argparse.ArgumentDefaultsHelpFormatter) parser.add_argument( - "-m", - "--module", - help="Define the module name to be used to create the log file") + '-m', + '--module', + help='Define the module name to be used to create the log file') args = parser.parse_args() @@ -52,5 +51,5 @@ def run(argv): BaselineModuleRunner(args.module.strip()) -if __name__ == "__main__": - run(sys.argv) +if __name__ == '__main__': + run() diff --git a/test_orc/modules/dns/python/src/dns_module.py b/test_orc/modules/dns/python/src/dns_module.py index b161805a5..58ce48123 100644 --- a/test_orc/modules/dns/python/src/dns_module.py +++ b/test_orc/modules/dns/python/src/dns_module.py @@ -1,52 +1,52 @@ -#!/usr/bin/env python3 - +"""DNS test module""" import subprocess from test_module import TestModule -LOG_NAME = "test_dns" -CAPTURE_FILE = "/runtime/network/dns.pcap" +LOG_NAME = 'test_dns' +CAPTURE_FILE = '/runtime/network/dns.pcap' LOGGER = None class DNSModule(TestModule): + """DNS Test module""" def __init__(self, module): super().__init__(module_name=module, log_name=LOG_NAME) - self._dns_server = "10.10.10.4" + self._dns_server = '10.10.10.4' global LOGGER LOGGER = self._get_logger() def _check_dns_traffic(self, tcpdump_filter): to_dns = self._exec_tcpdump(tcpdump_filter) num_query_dns = len(to_dns) - LOGGER.info("DNS queries found: " + str(num_query_dns)) + LOGGER.info('DNS queries found: ' + str(num_query_dns)) dns_traffic_detected = len(to_dns) > 0 - LOGGER.info("DNS traffic detected: " + str(dns_traffic_detected)) + LOGGER.info('DNS traffic detected: ' + str(dns_traffic_detected)) return dns_traffic_detected def _dns_network_from_dhcp(self): - LOGGER.info("Checking DNS traffic for configured DHCP DNS server: " + + LOGGER.info('Checking DNS traffic for configured DHCP DNS server: ' + self._dns_server) # Check if the device DNS traffic is to appropriate server - tcpdump_filter = "dst port 53 and dst host {} and ether src {}".format( - self._dns_server, self._device_mac) + tcpdump_filter = (f'dst port 53 and dst host {self._dns_server}', + f' and ether src {self._device_mac}') result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) - LOGGER.info("DNS traffic detected to configured DHCP DNS server: " + + LOGGER.info('DNS traffic detected to configured DHCP DNS server: ' + str(result)) return result def _dns_network_from_device(self): - LOGGER.info("Checking DNS traffic from device: " + self._device_mac) + LOGGER.info('Checking DNS traffic from device: ' + self._device_mac) # Check if the device DNS traffic is to appropriate server - tcpdump_filter = "dst port 53 and ether src {}".format(self._device_mac) + tcpdump_filter = f'dst port 53 and ether src {self._device_mac}' result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) - LOGGER.info("DNS traffic detected from device: " + str(result)) + LOGGER.info('DNS traffic detected from device: ' + str(result)) return result def _exec_tcpdump(self, tcpdump_filter): @@ -57,9 +57,9 @@ def _exec_tcpdump(self, tcpdump_filter): Returns List of packets matching the filter """ - command = "tcpdump -tttt -n -r {} {}".format(CAPTURE_FILE, tcpdump_filter) + command = f'tcpdump -tttt -n -r {CAPTURE_FILE} {tcpdump_filter}' - LOGGER.debug("tcpdump command: " + command) + LOGGER.debug('tcpdump command: ' + command) process = subprocess.Popen(command, universal_newlines=True, @@ -68,9 +68,9 @@ def _exec_tcpdump(self, tcpdump_filter): stderr=subprocess.PIPE) text = str(process.stdout.read()).rstrip() - LOGGER.debug("tcpdump response: " + text) + LOGGER.debug('tcpdump response: ' + text) if text: - return text.split("\n") + return text.split('\n') return [] diff --git a/test_orc/modules/dns/python/src/run.py b/test_orc/modules/dns/python/src/run.py index 06b8aa571..4cd991804 100644 --- a/test_orc/modules/dns/python/src/run.py +++ b/test_orc/modules/dns/python/src/run.py @@ -1,5 +1,4 @@ -#!/usr/bin/env python3 - +"""Run DNS test module""" import argparse import signal import sys @@ -13,7 +12,7 @@ class DNSModuleRunner: - + """Run the DNS module tests.""" def __init__(self, module): signal.signal(signal.SIGINT, self._handler) @@ -33,7 +32,7 @@ def add_logger(self, module): global LOGGER LOGGER = logger.get_logger(LOG_NAME, module) - def _handler(self, signum, *other): + def _handler(self, signum): LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) LOGGER.debug("Exit signal received: " + str(signum)) if signum in (2, signal.SIGTERM): @@ -42,7 +41,7 @@ def _handler(self, signum, *other): sys.exit(1) -def run(argv): +def run(): parser = argparse.ArgumentParser( description="Test Module DNS", formatter_class=argparse.ArgumentDefaultsHelpFormatter) @@ -60,4 +59,4 @@ def run(argv): if __name__ == "__main__": - run(sys.argv) + run() diff --git a/test_orc/modules/nmap/python/src/nmap_module.py b/test_orc/modules/nmap/python/src/nmap_module.py index cd6ec276b..876343a0f 100644 --- a/test_orc/modules/nmap/python/src/nmap_module.py +++ b/test_orc/modules/nmap/python/src/nmap_module.py @@ -1,5 +1,4 @@ -#!/usr/bin/env python3 - +"""NMAP test module""" import time import util import json @@ -11,7 +10,7 @@ class NmapModule(TestModule): - + """NMAP Test module""" def __init__(self, module): super().__init__(module_name=module, log_name=LOG_NAME) self._unallowed_ports = [] @@ -82,13 +81,13 @@ def _check_scan_results(self, test_config): if self._script_scan_results is not None: scan_results.update(self._script_scan_results) if port_config is not None: - for port in port_config: + for port, config in port_config.items(): result = None LOGGER.info("Checking port: " + str(port)) - LOGGER.debug("Port config: " + str(port_config[port])) + LOGGER.debug("Port config: " + str(config)) if port in scan_results: if scan_results[port]["state"] == "open": - if not port_config[port]["allowed"]: + if not config["allowed"]: LOGGER.info("Unallowed port open") self._unallowed_ports.append(str(port)) result = False @@ -103,10 +102,9 @@ def _check_scan_results(self, test_config): result = True if result is not None: - port_config[port][ - "result"] = "compliant" if result else "non-compliant" + config["result"] = "compliant" if result else "non-compliant" else: - port_config[port]["result"] = "skipped" + config["result"] = "skipped" def _scan_scripts(self, tests): scan_results = {} @@ -174,7 +172,7 @@ def _scan_tcp_ports(self, tests): ports_to_scan += "," + ",".join(ports) LOGGER.info("Running nmap TCP port scan") LOGGER.info("TCP ports: " + str(ports_to_scan)) - nmap_results = util.run_command(f"""nmap -sT -sV -Pn -v -p {ports_to_scan} + nmap_results = util.run_command(f"""nmap -sT -sV -Pn -v -p {ports_to_scan} --version-intensity 7 -T4 {self._device_ipv4_addr}""")[0] LOGGER.info("TCP port scan complete") self._scan_tcp_results = self._process_nmap_results( diff --git a/test_orc/modules/nmap/python/src/run.py b/test_orc/modules/nmap/python/src/run.py index 4ed1f533c..959e30f87 100644 --- a/test_orc/modules/nmap/python/src/run.py +++ b/test_orc/modules/nmap/python/src/run.py @@ -1,5 +1,4 @@ -#!/usr/bin/env python3 - +"""Run NMAP test module""" import argparse import signal import sys @@ -20,29 +19,29 @@ def __init__(self, module): signal.signal(signal.SIGABRT, self._handler) signal.signal(signal.SIGQUIT, self._handler) - LOGGER.info("Starting nmap Module") + LOGGER.info('Starting nmap Module') self._test_module = NmapModule(module) self._test_module.run_tests() - def _handler(self, signum, *other): - LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) - LOGGER.debug("Exit signal received: " + str(signum)) + def _handler(self, signum): + LOGGER.debug('SigtermEnum: ' + str(signal.SIGTERM)) + LOGGER.debug('Exit signal received: ' + str(signum)) if signum in (2, signal.SIGTERM): - LOGGER.info("Exit signal received. Stopping test module...") - LOGGER.info("Test module stopped") + LOGGER.info('Exit signal received. Stopping test module...') + LOGGER.info('Test module stopped') sys.exit(1) -def run(argv): +def run(): parser = argparse.ArgumentParser( - description="Nmap Module Help", + description='Nmap Module Help', formatter_class=argparse.ArgumentDefaultsHelpFormatter) parser.add_argument( - "-m", - "--module", - help="Define the module name to be used to create the log file") + '-m', + '--module', + help='Define the module name to be used to create the log file') args = parser.parse_args() @@ -51,5 +50,5 @@ def run(argv): NmapModuleRunner(args.module.strip()) -if __name__ == "__main__": - run(sys.argv) +if __name__ == '__main__': + run() diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 5cc14ae85..4b65bae12 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -67,7 +67,7 @@ def _generate_results(self, device): container_runtime_dir = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/" + module.name) - results_file = container_runtime_dir + "/" + module.name + "-result.json" + results_file = f"{container_runtime_dir}/{module.name}-result.json" try: with open(results_file, "r", encoding="UTF-8") as f: module_results = json.load(f) diff --git a/testing/test_baseline.py b/testing/test_baseline.py index 6f6240c27..b356983dd 100644 --- a/testing/test_baseline.py +++ b/testing/test_baseline.py @@ -23,7 +23,7 @@ def validator_results(): encoding='utf-8') as f: return json.load(f) -@pytest.mark.skip(reason="requires internet") +@pytest.mark.skip(reason='requires internet') def test_internet_connectivity(container_data): assert container_data['network']['internet'] == 200 @@ -47,7 +47,7 @@ def test_dns_server_resolves(container_data): assert re.match(r'[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}', container_data['dns_response']) -@pytest.mark.skip(reason="requires internet") +@pytest.mark.skip(reason='requires internet') def test_validator_results_compliant(validator_results): results = [True if x['result'] == 'compliant' else False for x in validator_results['results']] From b84a026c4fe537fc1b1b5be1b2ccf5727236395f Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Tue, 30 May 2023 15:01:16 -0700 Subject: [PATCH 023/400] Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron --- framework/device.py | 14 ++ framework/logger.py | 14 ++ framework/test_runner.py | 15 +- framework/testrun.py | 14 ++ net_orc/docker-compose.yml | 64 ------ .../devices/faux-dev/python/src/dhcp_check.py | 14 ++ .../devices/faux-dev/python/src/dns_check.py | 14 ++ .../faux-dev/python/src/gateway_check.py | 14 ++ .../devices/faux-dev/python/src/logger.py | 14 ++ .../devices/faux-dev/python/src/ntp_check.py | 14 ++ .../devices/faux-dev/python/src/run.py | 14 ++ .../devices/faux-dev/python/src/util.py | 14 ++ .../base/python/src/grpc/start_server.py | 14 ++ .../network/modules/base/python/src/logger.py | 14 ++ .../dhcp-1/python/src/grpc/dhcp_config.py | 14 ++ .../dhcp-1/python/src/grpc/network_service.py | 14 ++ .../dhcp-2/python/src/grpc/dhcp_config.py | 14 ++ .../dhcp-2/python/src/grpc/network_service.py | 14 ++ .../modules/ntp/python/src/ntp_server.py | 14 ++ .../modules/ovs/bin/start_network_service | 22 --- .../modules/ovs/conf/module_config.json | 24 --- net_orc/network/modules/ovs/ovs.Dockerfile | 20 -- .../modules/ovs/python/requirements.txt | 0 .../network/modules/ovs/python/src/logger.py | 16 -- .../modules/ovs/python/src/ovs_control.py | 105 ---------- net_orc/network/modules/ovs/python/src/run.py | 54 ----- .../network/modules/ovs/python/src/util.py | 23 --- .../radius/python/src/authenticator.py | 14 ++ .../template/python/src/template_main.py | 14 ++ net_orc/python/src/listener.py | 14 ++ net_orc/python/src/network_device.py | 14 ++ net_orc/python/src/network_event.py | 14 ++ net_orc/python/src/network_orchestrator.py | 109 +++++----- net_orc/python/src/network_validator.py | 14 ++ net_orc/python/src/ovs_control.py | 186 ++++++++++++++++++ net_orc/python/src/util.py | 14 ++ .../base/python/src/grpc/start_server.py | 14 ++ test_orc/modules/base/python/src/logger.py | 14 ++ .../modules/base/python/src/test_module.py | 14 ++ test_orc/modules/base/python/src/util.py | 14 ++ .../baseline/python/src/baseline_module.py | 14 ++ test_orc/modules/baseline/python/src/run.py | 14 ++ test_orc/modules/dns/python/src/dns_module.py | 14 ++ test_orc/modules/dns/python/src/run.py | 14 ++ .../modules/nmap/python/src/nmap_module.py | 14 ++ test_orc/modules/nmap/python/src/run.py | 14 ++ test_orc/python/src/module.py | 14 ++ test_orc/python/src/runner.py | 14 ++ test_orc/python/src/test_orchestrator.py | 14 ++ testing/test_baseline.py | 14 ++ 50 files changed, 784 insertions(+), 386 deletions(-) delete mode 100644 net_orc/docker-compose.yml delete mode 100644 net_orc/network/modules/ovs/bin/start_network_service delete mode 100644 net_orc/network/modules/ovs/conf/module_config.json delete mode 100644 net_orc/network/modules/ovs/ovs.Dockerfile delete mode 100644 net_orc/network/modules/ovs/python/requirements.txt delete mode 100644 net_orc/network/modules/ovs/python/src/logger.py delete mode 100644 net_orc/network/modules/ovs/python/src/ovs_control.py delete mode 100644 net_orc/network/modules/ovs/python/src/run.py delete mode 100644 net_orc/network/modules/ovs/python/src/util.py create mode 100644 net_orc/python/src/ovs_control.py diff --git a/framework/device.py b/framework/device.py index eef275d54..53263e6a6 100644 --- a/framework/device.py +++ b/framework/device.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Track device object information.""" from network_device import NetworkDevice diff --git a/framework/logger.py b/framework/logger.py index d4702cb38..cb71c9fdd 100644 --- a/framework/logger.py +++ b/framework/logger.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Manages stream and file loggers.""" import json import logging diff --git a/framework/test_runner.py b/framework/test_runner.py index 0733d4353..0ee5e8416 100644 --- a/framework/test_runner.py +++ b/framework/test_runner.py @@ -1,4 +1,17 @@ -#!/usr/bin/env python3 +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Wrapper for the TestRun that simplifies virtual testing procedure by allowing direct calling from the command line. diff --git a/framework/testrun.py b/framework/testrun.py index 94ad2ef9f..a818c9a45 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """The overall control of the Test Run application. This file provides the integration between all of the diff --git a/net_orc/docker-compose.yml b/net_orc/docker-compose.yml deleted file mode 100644 index 8c50d766a..000000000 --- a/net_orc/docker-compose.yml +++ /dev/null @@ -1,64 +0,0 @@ -version: "3.7" - -services: - - base: - build: - context: network/modules/base - dockerfile: base.Dockerfile - image: test-run/base - container_name: tr-ct-base - - ovs: - depends_on: - - base - build: - context: network/modules/ovs - dockerfile: ovs.Dockerfile - image: test-run/ovs - network_mode: host - container_name: tr-ct-ovs - stdin_open: true - privileged: true - volumes: - - $PWD/network/modules/ovs/python:/ovs/python - # Mount host open vswitch socket to allow container - # access to control open vswitch on the host - - /var/run/openvswitch/db.sock:/var/run/openvswitch/db.sock - # Mount host network namespace to allow container - # access to assign proper namespaces to containers - - /var/run/netns:/var/run/netns - - netorch: - depends_on: - - base - build: - context: . - dockerfile: orchestrator.Dockerfile - image: test-run/orchestrator - network_mode: host - privileged: true - volumes: - - $PWD/cmd:/orchestrator/cmd - - $PWD/network:/orchestrator/network - - $PWD/python:/orchestrator/python - # Mount host docker socket to allow container access - # control docker containers on the host - - /var/run/docker.sock:/var/run/docker.sock - # Mount host open vswitch socket to allow container - # access to control open vswitch on the host - - /var/run/openvswitch/db.sock:/var/run/openvswitch/db.sock - # Mount host network namespace to allow container - # access to assign proper namespaces to containers - - /var/run/netns:/var/run/netns - # Mount the host process information to allow container - # access to configure docker containers and namespaces properly - - /proc:/proc - container_name: network_orchestrator - stdin_open: true - working_dir: /orchestrator - #entrypoint: ["cmd/start"] - # Give more time for stopping so when we stop the container it has - # time to stop all network services gracefuly - stop_grace_period: 60s - entrypoint: ["python3","-u","python/src/run.py"] diff --git a/net_orc/network/devices/faux-dev/python/src/dhcp_check.py b/net_orc/network/devices/faux-dev/python/src/dhcp_check.py index 82dd6e31f..565e33308 100644 --- a/net_orc/network/devices/faux-dev/python/src/dhcp_check.py +++ b/net_orc/network/devices/faux-dev/python/src/dhcp_check.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Used to check if the DHCP server is functioning as expected""" import time diff --git a/net_orc/network/devices/faux-dev/python/src/dns_check.py b/net_orc/network/devices/faux-dev/python/src/dns_check.py index 73a72e8c8..be9c58d43 100644 --- a/net_orc/network/devices/faux-dev/python/src/dns_check.py +++ b/net_orc/network/devices/faux-dev/python/src/dns_check.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Used to check if the DNS server is functioning as expected""" import logger diff --git a/net_orc/network/devices/faux-dev/python/src/gateway_check.py b/net_orc/network/devices/faux-dev/python/src/gateway_check.py index 85fe35db0..a913993fc 100644 --- a/net_orc/network/devices/faux-dev/python/src/gateway_check.py +++ b/net_orc/network/devices/faux-dev/python/src/gateway_check.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Used to check if the Gateway server is functioning as expected""" import logger diff --git a/net_orc/network/devices/faux-dev/python/src/logger.py b/net_orc/network/devices/faux-dev/python/src/logger.py index 97d7f935a..a727ad7bb 100644 --- a/net_orc/network/devices/faux-dev/python/src/logger.py +++ b/net_orc/network/devices/faux-dev/python/src/logger.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Sets up the logger to be used for the faux-device.""" import json diff --git a/net_orc/network/devices/faux-dev/python/src/ntp_check.py b/net_orc/network/devices/faux-dev/python/src/ntp_check.py index ceef164c6..371e4464c 100644 --- a/net_orc/network/devices/faux-dev/python/src/ntp_check.py +++ b/net_orc/network/devices/faux-dev/python/src/ntp_check.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Used to check if the NTP server is functioning as expected""" import time import logger diff --git a/net_orc/network/devices/faux-dev/python/src/run.py b/net_orc/network/devices/faux-dev/python/src/run.py index 062a1a643..8f9733eb4 100644 --- a/net_orc/network/devices/faux-dev/python/src/run.py +++ b/net_orc/network/devices/faux-dev/python/src/run.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Used to run all the various validator modules for the faux-device""" import argparse diff --git a/net_orc/network/devices/faux-dev/python/src/util.py b/net_orc/network/devices/faux-dev/python/src/util.py index 6848206b4..920752217 100644 --- a/net_orc/network/devices/faux-dev/python/src/util.py +++ b/net_orc/network/devices/faux-dev/python/src/util.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Provides basic utilities for the faux-device.""" import subprocess import shlex diff --git a/net_orc/network/modules/base/python/src/grpc/start_server.py b/net_orc/network/modules/base/python/src/grpc/start_server.py index b4016c831..d372949e5 100644 --- a/net_orc/network/modules/base/python/src/grpc/start_server.py +++ b/net_orc/network/modules/base/python/src/grpc/start_server.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Base class for starting the gRPC server for a network module.""" from concurrent import futures import grpc diff --git a/net_orc/network/modules/base/python/src/logger.py b/net_orc/network/modules/base/python/src/logger.py index abec00f69..8893b1e8d 100644 --- a/net_orc/network/modules/base/python/src/logger.py +++ b/net_orc/network/modules/base/python/src/logger.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Sets up the logger to be used for the network modules.""" import json import logging diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py b/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py index 23e1b4047..99d6bdebd 100644 --- a/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py +++ b/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Contains all the necessary classes to maintain the DHCP server's configuration""" import re diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py b/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py index 49732b362..64aab8a07 100644 --- a/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py +++ b/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """gRPC Network Service for the DHCP Server network module""" import proto.grpc_pb2_grpc as pb2_grpc import proto.grpc_pb2 as pb2 diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py b/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py index 1d93c2d34..f6e79a2ec 100644 --- a/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py +++ b/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Contains all the necessary classes to maintain the DHCP server's configuration""" import re diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py b/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py index 49732b362..64aab8a07 100644 --- a/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py +++ b/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """gRPC Network Service for the DHCP Server network module""" import proto.grpc_pb2_grpc as pb2_grpc import proto.grpc_pb2 as pb2 diff --git a/net_orc/network/modules/ntp/python/src/ntp_server.py b/net_orc/network/modules/ntp/python/src/ntp_server.py index 602585196..4eda2b13e 100644 --- a/net_orc/network/modules/ntp/python/src/ntp_server.py +++ b/net_orc/network/modules/ntp/python/src/ntp_server.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """NTP Server""" import datetime import socket diff --git a/net_orc/network/modules/ovs/bin/start_network_service b/net_orc/network/modules/ovs/bin/start_network_service deleted file mode 100644 index 7c38f484a..000000000 --- a/net_orc/network/modules/ovs/bin/start_network_service +++ /dev/null @@ -1,22 +0,0 @@ -#!/bin/bash -e - -if [[ "$EUID" -ne 0 ]]; then - echo "Must run as root." - exit 1 -fi - -asyncRun() { - "$@" & - pid="$!" - trap "echo 'Stopping PID $pid'; kill -SIGTERM $pid" SIGINT SIGTERM - - # A signal emitted while waiting will make the wait command return code > 128 - # Let's wrap it in a loop that doesn't end before the process is indeed stopped - while kill -0 $pid > /dev/null 2>&1; do - wait - done -} - -# -u flag allows python print statements -# to be logged by docker by running unbuffered -asyncRun exec python3 -u /ovs/python/src/run.py \ No newline at end of file diff --git a/net_orc/network/modules/ovs/conf/module_config.json b/net_orc/network/modules/ovs/conf/module_config.json deleted file mode 100644 index 8a440d0ae..000000000 --- a/net_orc/network/modules/ovs/conf/module_config.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "config": { - "meta": { - "name": "ovs", - "display_name": "OVS", - "description": "Setup and configure Open vSwitch" - }, - "network": { - "interface": "veth0", - "enable_wan": false, - "ip_index": 6, - "host": true - }, - "docker": { - "depends_on": "base", - "mounts": [ - { - "source": "runtime/network", - "target": "/runtime/network" - } - ] - } - } -} \ No newline at end of file diff --git a/net_orc/network/modules/ovs/ovs.Dockerfile b/net_orc/network/modules/ovs/ovs.Dockerfile deleted file mode 100644 index cd4710e66..000000000 --- a/net_orc/network/modules/ovs/ovs.Dockerfile +++ /dev/null @@ -1,20 +0,0 @@ -# Image name: test-run/orchestrator -FROM test-run/base:latest - -#Update and get all additional requirements not contained in the base image -RUN apt-get update --fix-missing - -#Install openvswitch -RUN apt-get install -y openvswitch-switch - -# Copy over all configuration files -COPY network/modules/ovs/conf /testrun/conf - -# Copy over all binary files -COPY network/modules/ovs/bin /testrun/bin - -# Copy over all python files -COPY network/modules/ovs/python /testrun/python - -#Install all python requirements for the module -RUN pip3 install -r /testrun/python/requirements.txt \ No newline at end of file diff --git a/net_orc/network/modules/ovs/python/requirements.txt b/net_orc/network/modules/ovs/python/requirements.txt deleted file mode 100644 index e69de29bb..000000000 diff --git a/net_orc/network/modules/ovs/python/src/logger.py b/net_orc/network/modules/ovs/python/src/logger.py deleted file mode 100644 index 23e697e43..000000000 --- a/net_orc/network/modules/ovs/python/src/logger.py +++ /dev/null @@ -1,16 +0,0 @@ -"""Sets up the logger to be used for the ovs modules.""" -import logging - -LOGGERS = {} -_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' -_DATE_FORMAT = '%b %02d %H:%M:%S' - -# Set level to debug if set as runtime flag -logging.basicConfig(format=_LOG_FORMAT, - datefmt=_DATE_FORMAT, - level=logging.INFO) - -def get_logger(name): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - return LOGGERS[name] diff --git a/net_orc/network/modules/ovs/python/src/ovs_control.py b/net_orc/network/modules/ovs/python/src/ovs_control.py deleted file mode 100644 index 765c50f92..000000000 --- a/net_orc/network/modules/ovs/python/src/ovs_control.py +++ /dev/null @@ -1,105 +0,0 @@ -"""OVS Control Module""" -import json -import logger -import util - -CONFIG_FILE = '/ovs/conf/system.json' -DEVICE_BRIDGE = 'tr-d' -INTERNET_BRIDGE = 'tr-c' -LOGGER = logger.get_logger('ovs_ctrl') - -class OVSControl: - """OVS Control""" - def __init__(self): - self._int_intf = None - self._dev_intf = None - self._load_config() - - def add_bridge(self, bridge_name): - LOGGER.info('Adding OVS Bridge: ' + bridge_name) - # Create the bridge using ovs-vsctl commands - # Uses the --may-exist option to prevent failures - # if this bridge already exists by this name it won't fail - # and will not modify the existing bridge - success=util.run_command('ovs-vsctl --may-exist add-br ' + bridge_name) - return success - - def add_port(self,port, bridge_name): - LOGGER.info('Adding Port ' + port + ' to OVS Bridge: ' + bridge_name) - # Add a port to the bridge using ovs-vsctl commands - # Uses the --may-exist option to prevent failures - # if this port already exists on the bridge and will not - # modify the existing bridge - success=util.run_command(f"""ovs-vsctl --may-exist - add-port {bridge_name} {port}""") - return success - - def create_net(self): - LOGGER.info('Creating baseline network') - - # Create data plane - self.add_bridge(DEVICE_BRIDGE) - - # Create control plane - self.add_bridge(INTERNET_BRIDGE) - - # Remove IP from internet adapter - self.set_interface_ip(self._int_intf,'0.0.0.0') - - # Add external interfaces to data and control plane - self.add_port(self._dev_intf,DEVICE_BRIDGE) - self.add_port(self._int_intf,INTERNET_BRIDGE) - - # # Set ports up - self.set_bridge_up(DEVICE_BRIDGE) - self.set_bridge_up(INTERNET_BRIDGE) - - def delete_bridge(self,bridge_name): - LOGGER.info('Deleting OVS Bridge: ' + bridge_name) - # Delete the bridge using ovs-vsctl commands - # Uses the --if-exists option to prevent failures - # if this bridge does not exists - success=util.run_command('ovs-vsctl --if-exists del-br ' + bridge_name) - return success - - def _load_config(self): - LOGGER.info('Loading Configuration: ' + CONFIG_FILE) - with open(CONFIG_FILE, 'r', encoding='utf-8') as conf_file: - config_json = json.load(conf_file) - self._int_intf = config_json['internet_intf'] - self._dev_intf = config_json['device_intf'] - LOGGER.info('Configuration Loaded') - LOGGER.info('Internet Interface: ' + self._int_intf) - LOGGER.info('Device Interface: ' + self._dev_intf) - - def restore_net(self): - LOGGER.info('Restoring Network...') - # Delete data plane - self.delete_bridge(DEVICE_BRIDGE) - - # Delete control plane - self.delete_bridge(INTERNET_BRIDGE) - - LOGGER.info('Network is restored') - - def show_config(self): - LOGGER.info('Show current config of OVS') - success=util.run_command('ovs-vsctl show') - return success - - def set_bridge_up(self,bridge_name): - LOGGER.info('Setting Bridge device to up state: ' + bridge_name) - success=util.run_command('ip link set dev ' + bridge_name + ' up') - return success - - def set_interface_ip(self,interface, ip_addr): - LOGGER.info('Setting interface ' + interface + ' to ' + ip_addr) - # Remove IP from internet adapter - util.run_command('ifconfig ' + interface + ' 0.0.0.0') - -if __name__ == '__main__': - ovs = OVSControl() - ovs.create_net() - ovs.show_config() - ovs.restore_net() - ovs.show_config() diff --git a/net_orc/network/modules/ovs/python/src/run.py b/net_orc/network/modules/ovs/python/src/run.py deleted file mode 100644 index 5787a74e6..000000000 --- a/net_orc/network/modules/ovs/python/src/run.py +++ /dev/null @@ -1,54 +0,0 @@ -"""Run OVS module""" -import logger -import signal -import sys -import time - -from ovs_control import OVSControl - -LOGGER = logger.get_logger('ovs_control_run') - -class OVSControlRun: - """Run the OVS module.""" - def __init__(self): - - signal.signal(signal.SIGINT, self.handler) - signal.signal(signal.SIGTERM, self.handler) - signal.signal(signal.SIGABRT, self.handler) - signal.signal(signal.SIGQUIT, self.handler) - - LOGGER.info('Starting OVS Control') - - # Get all components ready - self._ovs_control = OVSControl() - - self._ovs_control.restore_net() - - self._ovs_control.create_net() - - self._ovs_control.show_config() - - # Get network ready (via Network orchestrator) - LOGGER.info('Network is ready. Waiting for device information...') - - #Loop forever until process is stopped - while True: - LOGGER.info('OVS Running') - time.sleep(1000) - - # TODO: This time should be configurable (How long to hold before exiting, - # this could be infinite too) - #time.sleep(300) - - # Tear down network - #self._ovs_control.shutdown() - - def handler(self, signum): - LOGGER.info('SigtermEnum: ' + str(signal.SIGTERM)) - LOGGER.info('Exit signal received: ' + str(signum)) - if (signum == 2 or signal == signal.SIGTERM): - LOGGER.info('Exit signal received. Restoring network...') - self._ovs_control.shutdown() - sys.exit(1) - -ovs = OVSControlRun() diff --git a/net_orc/network/modules/ovs/python/src/util.py b/net_orc/network/modules/ovs/python/src/util.py deleted file mode 100644 index a3ebbb10a..000000000 --- a/net_orc/network/modules/ovs/python/src/util.py +++ /dev/null @@ -1,23 +0,0 @@ -"""Provides basic utilities for a ovs module.""" -import subprocess -import logger - -LOGGER = logger.get_logger('util') - -def run_command(cmd): - success = False - process = subprocess.Popen(cmd.split(), - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - stdout, stderr = process.communicate() - if process.returncode != 0: - err_msg = f'{stderr.strip()}. Code: {process.returncode}' - LOGGER.error('Command Failed: ' + cmd) - LOGGER.error('Error: ' + err_msg) - else: - msg = stdout.strip().decode('utf-8') - succ_msg = f'{msg}. Code: {process.returncode}' - LOGGER.info('Command Success: ' + cmd) - LOGGER.info('Success: ' + succ_msg) - success = True - return success diff --git a/net_orc/network/modules/radius/python/src/authenticator.py b/net_orc/network/modules/radius/python/src/authenticator.py index 32f4ac221..0cca1921a 100644 --- a/net_orc/network/modules/radius/python/src/authenticator.py +++ b/net_orc/network/modules/radius/python/src/authenticator.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Authenticator for the RADIUS Server""" from chewie.chewie import Chewie import logging diff --git a/net_orc/network/modules/template/python/src/template_main.py b/net_orc/network/modules/template/python/src/template_main.py index df2452550..ddf83e2c4 100644 --- a/net_orc/network/modules/template/python/src/template_main.py +++ b/net_orc/network/modules/template/python/src/template_main.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Python code for the template module.""" if __name__ == "__main__": diff --git a/net_orc/python/src/listener.py b/net_orc/python/src/listener.py index de7a07616..0bbd2b1c9 100644 --- a/net_orc/python/src/listener.py +++ b/net_orc/python/src/listener.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Intercepts network traffic between network services and the device under test.""" import threading diff --git a/net_orc/python/src/network_device.py b/net_orc/python/src/network_device.py index 1b856da16..f17ac0f0d 100644 --- a/net_orc/python/src/network_device.py +++ b/net_orc/python/src/network_device.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Track device object information.""" from dataclasses import dataclass diff --git a/net_orc/python/src/network_event.py b/net_orc/python/src/network_event.py index f56adf494..204c97a0a 100644 --- a/net_orc/python/src/network_event.py +++ b/net_orc/python/src/network_event.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Specify the various types of network events to be reported.""" from enum import Enum diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 53a94b795..ba16b6a9c 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Network orchestrator is responsible for managing all of the virtual network services""" import getpass @@ -18,6 +32,7 @@ from network_device import NetworkDevice from network_event import NetworkEvent from network_validator import NetworkValidator +from ovs_control import OVSControl LOGGER = logger.get_logger('net_orc') CONFIG_FILE = 'conf/system.json' @@ -73,6 +88,7 @@ def __init__(self, shutil.rmtree(os.path.join(os.getcwd(), NET_DIR), ignore_errors=True) self.network_config = NetworkConfig() self.load_config(config_file) + self._ovs = OVSControl() def start(self): """Start the network orchestrator.""" @@ -142,7 +158,7 @@ def load_config(self, config_file=None): if not os.path.isfile(self._config_file): LOGGER.error('Configuration file is not present at ' + config_file) - LOGGER.info('An example is present in '+ EXAMPLE_CONFIG_FILE) + LOGGER.info('An example is present in ' + EXAMPLE_CONFIG_FILE) sys.exit(1) LOGGER.info('Loading config file: ' + os.path.abspath(self._config_file)) @@ -153,7 +169,7 @@ def load_config(self, config_file=None): def _device_discovered(self, mac_addr): LOGGER.debug( - f'Discovered device {mac_addr}. Waiting for device to obtain IP') + f'Discovered device {mac_addr}. Waiting for device to obtain IP') device = self._get_device(mac_addr=mac_addr) os.makedirs( os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(':', @@ -169,12 +185,12 @@ def _device_discovered(self, mac_addr): if device.ip_addr is None: LOGGER.info( - f'Timed out whilst waiting for {mac_addr} to obtain an IP address') + f'Timed out whilst waiting for {mac_addr} to obtain an IP address') return LOGGER.info( - f'Device with mac addr {device.mac_addr} has obtained IP address ' - f'{device.ip_addr}') + f'Device with mac addr {device.mac_addr} has obtained IP address ' + f'{device.ip_addr}') self._start_device_monitor(device) @@ -186,9 +202,8 @@ def _dhcp_lease_ack(self, packet): def _start_device_monitor(self, device): """Start a timer until the steady state has been reached and callback the steady state method for this device.""" - LOGGER.info( - f'Monitoring device with mac addr {device.mac_addr} ' - f'for {str(self._monitor_period)} seconds') + LOGGER.info(f'Monitoring device with mac addr {device.mac_addr} ' + f'for {str(self._monitor_period)} seconds') packet_capture = sniff(iface=self._dev_intf, timeout=self._monitor_period) wrpcap( @@ -293,9 +308,8 @@ def _ci_post_network_create(self): util.run_command(f'ip link set dev {INTERNET_BRIDGE} up') util.run_command(f'dhclient {INTERNET_BRIDGE}') util.run_command('ip route del default via 10.1.0.1') - util.run_command( - f'ip route add default via {self._gateway} ' - f'src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}') + util.run_command(f'ip route add default via {self._gateway} ' + f'src {self._ipv4[:-3]} metric 100 dev {INTERNET_BRIDGE}') def create_net(self): LOGGER.info('Creating baseline network') @@ -309,28 +323,14 @@ def create_net(self): if self._single_intf: self._ci_pre_network_create() - # Create data plane - util.run_command('ovs-vsctl add-br ' + DEVICE_BRIDGE) - - # Create control plane - util.run_command('ovs-vsctl add-br ' + INTERNET_BRIDGE) - - # Add external interfaces to data and control plane - util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + - self._dev_intf) - util.run_command('ovs-vsctl add-port ' + INTERNET_BRIDGE + ' ' + - self._int_intf) - - # Enable forwarding of eapol packets - util.run_command('ovs-ofctl add-flow ' + DEVICE_BRIDGE + - ' \'table=0, dl_dst=01:80:c2:00:00:03, actions=flood\'') - # Remove IP from internet adapter util.run_command('ifconfig ' + self._int_intf + ' 0.0.0.0') - # Set ports up - util.run_command('ip link set dev ' + DEVICE_BRIDGE + ' up') - util.run_command('ip link set dev ' + INTERNET_BRIDGE + ' up') + # Setup the virtual network + if not self._ovs.create_baseline_net(verify=True): + LOGGER.error('Baseline network validation failed.') + self.stop() + sys.exit(1) if self._single_intf: self._ci_post_network_create() @@ -367,8 +367,9 @@ def _load_network_module(self, module_dir): # Load module information with open(os.path.join(self._path, net_modules_dir, module_dir, - NETWORK_MODULE_METADATA), 'r', - encoding='UTF-8') as module_file_open: + NETWORK_MODULE_METADATA), + 'r', + encoding='UTF-8') as module_file_open: net_module_json = json.load(module_file_open) net_module.name = net_module_json['config']['meta']['name'] @@ -443,13 +444,6 @@ def _get_network_module(self, name): return net_module return None - # Start the OVS network module - # This should always be called before loading all - # other modules to allow for a properly setup base - # network - def _start_ovs_module(self): - self._start_network_service(self._get_network_module('OVS')) - def _start_network_service(self, net_module): LOGGER.debug('Starting net service ' + net_module.display_name) @@ -521,16 +515,12 @@ def start_network_services(self): for net_module in self._net_modules: - # TODO: There should be a better way of doing this - # Do not try starting OVS module again, as it should already be running - if 'OVS' != net_module.display_name: - - # Network modules may just be Docker images, - # so we do not want to start them as containers - if not net_module.enable_container: - continue + # Network modules may just be Docker images, + # so we do not want to start them as containers + if not net_module.enable_container: + continue - self._start_network_service(net_module) + self._start_network_service(net_module) LOGGER.info('All network services are running') self._check_network_services() @@ -555,7 +545,7 @@ def attach_test_module_to_network(self, test_module): container_intf) # Add bridge interface to device bridge - util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + bridge_intf) + self._ovs.add_port(port=bridge_intf, bridge_name=DEVICE_BRIDGE) # Get PID for running container # TODO: Some error checking around missing PIDs might be required @@ -620,7 +610,11 @@ def _attach_service_to_network(self, net_module): container_intf) # Add bridge interface to device bridge - util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + bridge_intf) + if self._ovs.add_port(port=bridge_intf, bridge_name=DEVICE_BRIDGE): + if not self._ovs.port_exists(bridge_name=DEVICE_BRIDGE, port=bridge_intf): + LOGGER.error('Failed to add ' + net_module.name + ' to device bridge ' + + DEVICE_BRIDGE + '. Exiting.') + sys.exit(1) # Get PID for running container # TODO: Some error checking around missing PIDs might be required @@ -675,8 +669,12 @@ def _attach_service_to_network(self, net_module): container_intf) # Attach bridge interface to internet bridge - util.run_command('ovs-vsctl add-port ' + INTERNET_BRIDGE + ' ' + - bridge_intf) + if self._ovs.add_port(port=bridge_intf, bridge_name=INTERNET_BRIDGE): + if not self._ovs.port_exists(bridge_name=INTERNET_BRIDGE, + port=bridge_intf): + LOGGER.error('Failed to add ' + net_module.name + + ' to internet bridge ' + DEVICE_BRIDGE + '. Exiting.') + sys.exit(1) # Attach container interface to container network namespace util.run_command('ip link set ' + container_intf + ' netns ' + @@ -714,11 +712,8 @@ def restore_net(self): except Exception: # pylint: disable=W0703 continue - # Delete data plane - util.run_command('ovs-vsctl --if-exists del-br tr-d') - - # Delete control plane - util.run_command('ovs-vsctl --if-exists del-br tr-c') + # Clear the virtual network + self._ovs.restore_net() # Restart internet interface if util.interface_exists(self._int_intf): diff --git a/net_orc/python/src/network_validator.py b/net_orc/python/src/network_validator.py index 83ca6f671..a90096f7d 100644 --- a/net_orc/python/src/network_validator.py +++ b/net_orc/python/src/network_validator.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Holds logic for validation of network services prior to runtime.""" import json import os diff --git a/net_orc/python/src/ovs_control.py b/net_orc/python/src/ovs_control.py new file mode 100644 index 000000000..4c989756b --- /dev/null +++ b/net_orc/python/src/ovs_control.py @@ -0,0 +1,186 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""OVS Control Module""" +import json +import logger +import util +import os + +CONFIG_FILE = 'conf/system.json' +DEVICE_BRIDGE = 'tr-d' +INTERNET_BRIDGE = 'tr-c' +LOGGER = logger.get_logger('ovs_ctrl') + + +class OVSControl: + """OVS Control""" + + def __init__(self): + self._int_intf = None + self._dev_intf = None + self._load_config() + + def add_bridge(self, bridge_name): + LOGGER.debug('Adding OVS bridge: ' + bridge_name) + # Create the bridge using ovs-vsctl commands + # Uses the --may-exist option to prevent failures + # if this bridge already exists by this name it won't fail + # and will not modify the existing bridge + success = util.run_command('ovs-vsctl --may-exist add-br ' + bridge_name) + return success + + def add_flow(self, bridge_name, flow): + # Add a flow to the bridge using ovs-ofctl commands + LOGGER.debug(f'Adding flow {flow} to bridge: {bridge_name}') + success = util.run_command(f'ovs-ofctl add-flow {bridge_name} \'{flow}\'') + return success + + def add_port(self, port, bridge_name): + LOGGER.debug('Adding port ' + port + ' to OVS bridge: ' + bridge_name) + # Add a port to the bridge using ovs-vsctl commands + # Uses the --may-exist option to prevent failures + # if this port already exists on the bridge and will not + # modify the existing bridge + success = util.run_command(f"""ovs-vsctl --may-exist + add-port {bridge_name} {port}""") + return success + + def get_bridge_ports(self, bridge_name): + # Get a list of all the ports on a bridge + response = util.run_command(f'ovs-vsctl list-ports {bridge_name}', + output=True) + return response[0].splitlines() + + def bridge_exists(self, bridge_name): + # Check if a bridge exists by the name provided + LOGGER.debug(f'Checking if {bridge_name} exists') + success = util.run_command(f'ovs-vsctl br-exists {bridge_name}') + return success + + def port_exists(self, bridge_name, port): + # Check if a port exists on a specified bridge + LOGGER.debug(f'Checking if {bridge_name} exists') + resp = util.run_command(f'ovs-vsctl port-to-br {port}', True) + return resp[0] == bridge_name + + def validate_baseline_network(self): + # Verify the OVS setup of the virtual network + LOGGER.info('Validating baseline network') + + # Verify the device bridge + dev_bridge = self.verify_bridge(DEVICE_BRIDGE, [self._dev_intf]) + LOGGER.info('Device bridge verified: ' + str(dev_bridge)) + + # Verify the internet bridge + int_bridge = self.verify_bridge(INTERNET_BRIDGE, [self._int_intf]) + LOGGER.info('Internet bridge verified: ' + str(int_bridge)) + + return dev_bridge and int_bridge + + def verify_bridge(self, bridge_name, ports): + LOGGER.debug('Verifying bridge: ' + bridge_name) + verified = True + if self.bridge_exists(bridge_name): + bridge_ports = self.get_bridge_ports(bridge_name) + LOGGER.debug('Checking bridge for ports: ' + str(ports)) + for port in ports: + if port not in bridge_ports: + verified = False + break + else: + verified = False + return verified + + def create_baseline_net(self, verify=True): + LOGGER.debug('Creating baseline network') + + # Remove IP from internet adapter + self.set_interface_ip(interface=self._int_intf, ip_addr='0.0.0.0') + + # Create data plane + self.add_bridge(DEVICE_BRIDGE) + + # Create control plane + self.add_bridge(INTERNET_BRIDGE) + + # Remove IP from internet adapter + self.set_interface_ip(self._int_intf, '0.0.0.0') + + # Add external interfaces to data and control plane + self.add_port(self._dev_intf, DEVICE_BRIDGE) + self.add_port(self._int_intf, INTERNET_BRIDGE) + + # Enable forwarding of eapol packets + self.add_flow(bridge_name=DEVICE_BRIDGE, + flow='table=0, dl_dst=01:80:c2:00:00:03, actions=flood') + + # Set ports up + self.set_bridge_up(DEVICE_BRIDGE) + self.set_bridge_up(INTERNET_BRIDGE) + + self.show_config() + + if verify: + return self.validate_baseline_network() + else: + return None + + def delete_bridge(self, bridge_name): + LOGGER.debug('Deleting OVS Bridge: ' + bridge_name) + # Delete the bridge using ovs-vsctl commands + # Uses the --if-exists option to prevent failures + # if this bridge does not exists + success = util.run_command('ovs-vsctl --if-exists del-br ' + bridge_name) + return success + + def _load_config(self): + path = os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__))))) + config_file = os.path.join(path, CONFIG_FILE) + LOGGER.debug('Loading configuration: ' + config_file) + with open(config_file, 'r', encoding='utf-8') as conf_file: + config_json = json.load(conf_file) + self._int_intf = config_json['network']['internet_intf'] + self._dev_intf = config_json['network']['device_intf'] + LOGGER.debug('Configuration loaded') + LOGGER.debug('Internet interface: ' + self._int_intf) + LOGGER.debug('Device interface: ' + self._dev_intf) + + def restore_net(self): + LOGGER.debug('Restoring network...') + # Delete data plane + self.delete_bridge(DEVICE_BRIDGE) + + # Delete control plane + self.delete_bridge(INTERNET_BRIDGE) + + LOGGER.debug('Network is restored') + + def show_config(self): + LOGGER.debug('Show current config of OVS') + success = util.run_command('ovs-vsctl show', output=True) + LOGGER.debug(f'OVS Config\n{success[0]}') + return success + + def set_bridge_up(self, bridge_name): + LOGGER.debug('Setting bridge device to up state: ' + bridge_name) + success = util.run_command('ip link set dev ' + bridge_name + ' up') + return success + + def set_interface_ip(self, interface, ip_addr): + LOGGER.debug('Setting interface ' + interface + ' to ' + ip_addr) + # Remove IP from internet adapter + util.run_command(f'ifconfig {interface} {ip_addr}') diff --git a/net_orc/python/src/util.py b/net_orc/python/src/util.py index a7b07ddf9..ba9527996 100644 --- a/net_orc/python/src/util.py +++ b/net_orc/python/src/util.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Provides basic utilities for the network orchestrator.""" import subprocess import shlex diff --git a/test_orc/modules/base/python/src/grpc/start_server.py b/test_orc/modules/base/python/src/grpc/start_server.py index b4016c831..d372949e5 100644 --- a/test_orc/modules/base/python/src/grpc/start_server.py +++ b/test_orc/modules/base/python/src/grpc/start_server.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Base class for starting the gRPC server for a network module.""" from concurrent import futures import grpc diff --git a/test_orc/modules/base/python/src/logger.py b/test_orc/modules/base/python/src/logger.py index 42124beea..64594c7b3 100644 --- a/test_orc/modules/base/python/src/logger.py +++ b/test_orc/modules/base/python/src/logger.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Sets up the logger to be used for the test modules.""" import json import logging diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 8e10a3637..57795a182 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Base class for all core test module functions""" import json import logger diff --git a/test_orc/modules/base/python/src/util.py b/test_orc/modules/base/python/src/util.py index d387db796..0f54c4298 100644 --- a/test_orc/modules/base/python/src/util.py +++ b/test_orc/modules/base/python/src/util.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Provides basic utilities for a test module.""" import subprocess import shlex diff --git a/test_orc/modules/baseline/python/src/baseline_module.py b/test_orc/modules/baseline/python/src/baseline_module.py index 083123436..22555d369 100644 --- a/test_orc/modules/baseline/python/src/baseline_module.py +++ b/test_orc/modules/baseline/python/src/baseline_module.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Baseline test module""" from test_module import TestModule diff --git a/test_orc/modules/baseline/python/src/run.py b/test_orc/modules/baseline/python/src/run.py index 1892ed8ae..42eccbef4 100644 --- a/test_orc/modules/baseline/python/src/run.py +++ b/test_orc/modules/baseline/python/src/run.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Run Baseline module""" import argparse import signal diff --git a/test_orc/modules/dns/python/src/dns_module.py b/test_orc/modules/dns/python/src/dns_module.py index 58ce48123..cd7261da0 100644 --- a/test_orc/modules/dns/python/src/dns_module.py +++ b/test_orc/modules/dns/python/src/dns_module.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """DNS test module""" import subprocess from test_module import TestModule diff --git a/test_orc/modules/dns/python/src/run.py b/test_orc/modules/dns/python/src/run.py index 4cd991804..2b924bbaf 100644 --- a/test_orc/modules/dns/python/src/run.py +++ b/test_orc/modules/dns/python/src/run.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Run DNS test module""" import argparse import signal diff --git a/test_orc/modules/nmap/python/src/nmap_module.py b/test_orc/modules/nmap/python/src/nmap_module.py index 876343a0f..028471bb9 100644 --- a/test_orc/modules/nmap/python/src/nmap_module.py +++ b/test_orc/modules/nmap/python/src/nmap_module.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """NMAP test module""" import time import util diff --git a/test_orc/modules/nmap/python/src/run.py b/test_orc/modules/nmap/python/src/run.py index 959e30f87..ecb6cd028 100644 --- a/test_orc/modules/nmap/python/src/run.py +++ b/test_orc/modules/nmap/python/src/run.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Run NMAP test module""" import argparse import signal diff --git a/test_orc/python/src/module.py b/test_orc/python/src/module.py index 72791f86e..185940dd8 100644 --- a/test_orc/python/src/module.py +++ b/test_orc/python/src/module.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Represemts a test module.""" from dataclasses import dataclass from docker.models.containers import Container diff --git a/test_orc/python/src/runner.py b/test_orc/python/src/runner.py index d82935057..363f800af 100644 --- a/test_orc/python/src/runner.py +++ b/test_orc/python/src/runner.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Provides high level management of the test orchestrator.""" import time import logger diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 4b65bae12..14b39720d 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + """Provides high level management of the test orchestrator.""" import getpass import os diff --git a/testing/test_baseline.py b/testing/test_baseline.py index b356983dd..246857581 100644 --- a/testing/test_baseline.py +++ b/testing/test_baseline.py @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + import json import pytest import re From 38d71aae4895a34aa50dfc4f3afc979d3c881b04 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Wed, 31 May 2023 09:09:48 -0700 Subject: [PATCH 024/400] Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron From 00be9cbad0e55a38f91e7757cdac8d2c82697506 Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Wed, 31 May 2023 10:36:46 -0600 Subject: [PATCH 025/400] remove ovs files added back in during merge --- net_orc/docker-compose.yml | 64 ----------- .../modules/ovs/bin/start_network_service | 22 ---- .../modules/ovs/conf/module_config.json | 24 ---- net_orc/network/modules/ovs/ovs.Dockerfile | 20 ---- .../modules/ovs/python/requirements.txt | 0 .../network/modules/ovs/python/src/logger.py | 16 --- .../modules/ovs/python/src/ovs_control.py | 105 ------------------ net_orc/network/modules/ovs/python/src/run.py | 54 --------- .../network/modules/ovs/python/src/util.py | 23 ---- 9 files changed, 328 deletions(-) delete mode 100644 net_orc/docker-compose.yml delete mode 100644 net_orc/network/modules/ovs/bin/start_network_service delete mode 100644 net_orc/network/modules/ovs/conf/module_config.json delete mode 100644 net_orc/network/modules/ovs/ovs.Dockerfile delete mode 100644 net_orc/network/modules/ovs/python/requirements.txt delete mode 100644 net_orc/network/modules/ovs/python/src/logger.py delete mode 100644 net_orc/network/modules/ovs/python/src/ovs_control.py delete mode 100644 net_orc/network/modules/ovs/python/src/run.py delete mode 100644 net_orc/network/modules/ovs/python/src/util.py diff --git a/net_orc/docker-compose.yml b/net_orc/docker-compose.yml deleted file mode 100644 index 8c50d766a..000000000 --- a/net_orc/docker-compose.yml +++ /dev/null @@ -1,64 +0,0 @@ -version: "3.7" - -services: - - base: - build: - context: network/modules/base - dockerfile: base.Dockerfile - image: test-run/base - container_name: tr-ct-base - - ovs: - depends_on: - - base - build: - context: network/modules/ovs - dockerfile: ovs.Dockerfile - image: test-run/ovs - network_mode: host - container_name: tr-ct-ovs - stdin_open: true - privileged: true - volumes: - - $PWD/network/modules/ovs/python:/ovs/python - # Mount host open vswitch socket to allow container - # access to control open vswitch on the host - - /var/run/openvswitch/db.sock:/var/run/openvswitch/db.sock - # Mount host network namespace to allow container - # access to assign proper namespaces to containers - - /var/run/netns:/var/run/netns - - netorch: - depends_on: - - base - build: - context: . - dockerfile: orchestrator.Dockerfile - image: test-run/orchestrator - network_mode: host - privileged: true - volumes: - - $PWD/cmd:/orchestrator/cmd - - $PWD/network:/orchestrator/network - - $PWD/python:/orchestrator/python - # Mount host docker socket to allow container access - # control docker containers on the host - - /var/run/docker.sock:/var/run/docker.sock - # Mount host open vswitch socket to allow container - # access to control open vswitch on the host - - /var/run/openvswitch/db.sock:/var/run/openvswitch/db.sock - # Mount host network namespace to allow container - # access to assign proper namespaces to containers - - /var/run/netns:/var/run/netns - # Mount the host process information to allow container - # access to configure docker containers and namespaces properly - - /proc:/proc - container_name: network_orchestrator - stdin_open: true - working_dir: /orchestrator - #entrypoint: ["cmd/start"] - # Give more time for stopping so when we stop the container it has - # time to stop all network services gracefuly - stop_grace_period: 60s - entrypoint: ["python3","-u","python/src/run.py"] diff --git a/net_orc/network/modules/ovs/bin/start_network_service b/net_orc/network/modules/ovs/bin/start_network_service deleted file mode 100644 index 7c38f484a..000000000 --- a/net_orc/network/modules/ovs/bin/start_network_service +++ /dev/null @@ -1,22 +0,0 @@ -#!/bin/bash -e - -if [[ "$EUID" -ne 0 ]]; then - echo "Must run as root." - exit 1 -fi - -asyncRun() { - "$@" & - pid="$!" - trap "echo 'Stopping PID $pid'; kill -SIGTERM $pid" SIGINT SIGTERM - - # A signal emitted while waiting will make the wait command return code > 128 - # Let's wrap it in a loop that doesn't end before the process is indeed stopped - while kill -0 $pid > /dev/null 2>&1; do - wait - done -} - -# -u flag allows python print statements -# to be logged by docker by running unbuffered -asyncRun exec python3 -u /ovs/python/src/run.py \ No newline at end of file diff --git a/net_orc/network/modules/ovs/conf/module_config.json b/net_orc/network/modules/ovs/conf/module_config.json deleted file mode 100644 index 8a440d0ae..000000000 --- a/net_orc/network/modules/ovs/conf/module_config.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "config": { - "meta": { - "name": "ovs", - "display_name": "OVS", - "description": "Setup and configure Open vSwitch" - }, - "network": { - "interface": "veth0", - "enable_wan": false, - "ip_index": 6, - "host": true - }, - "docker": { - "depends_on": "base", - "mounts": [ - { - "source": "runtime/network", - "target": "/runtime/network" - } - ] - } - } -} \ No newline at end of file diff --git a/net_orc/network/modules/ovs/ovs.Dockerfile b/net_orc/network/modules/ovs/ovs.Dockerfile deleted file mode 100644 index cd4710e66..000000000 --- a/net_orc/network/modules/ovs/ovs.Dockerfile +++ /dev/null @@ -1,20 +0,0 @@ -# Image name: test-run/orchestrator -FROM test-run/base:latest - -#Update and get all additional requirements not contained in the base image -RUN apt-get update --fix-missing - -#Install openvswitch -RUN apt-get install -y openvswitch-switch - -# Copy over all configuration files -COPY network/modules/ovs/conf /testrun/conf - -# Copy over all binary files -COPY network/modules/ovs/bin /testrun/bin - -# Copy over all python files -COPY network/modules/ovs/python /testrun/python - -#Install all python requirements for the module -RUN pip3 install -r /testrun/python/requirements.txt \ No newline at end of file diff --git a/net_orc/network/modules/ovs/python/requirements.txt b/net_orc/network/modules/ovs/python/requirements.txt deleted file mode 100644 index e69de29bb..000000000 diff --git a/net_orc/network/modules/ovs/python/src/logger.py b/net_orc/network/modules/ovs/python/src/logger.py deleted file mode 100644 index 23e697e43..000000000 --- a/net_orc/network/modules/ovs/python/src/logger.py +++ /dev/null @@ -1,16 +0,0 @@ -"""Sets up the logger to be used for the ovs modules.""" -import logging - -LOGGERS = {} -_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' -_DATE_FORMAT = '%b %02d %H:%M:%S' - -# Set level to debug if set as runtime flag -logging.basicConfig(format=_LOG_FORMAT, - datefmt=_DATE_FORMAT, - level=logging.INFO) - -def get_logger(name): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - return LOGGERS[name] diff --git a/net_orc/network/modules/ovs/python/src/ovs_control.py b/net_orc/network/modules/ovs/python/src/ovs_control.py deleted file mode 100644 index 765c50f92..000000000 --- a/net_orc/network/modules/ovs/python/src/ovs_control.py +++ /dev/null @@ -1,105 +0,0 @@ -"""OVS Control Module""" -import json -import logger -import util - -CONFIG_FILE = '/ovs/conf/system.json' -DEVICE_BRIDGE = 'tr-d' -INTERNET_BRIDGE = 'tr-c' -LOGGER = logger.get_logger('ovs_ctrl') - -class OVSControl: - """OVS Control""" - def __init__(self): - self._int_intf = None - self._dev_intf = None - self._load_config() - - def add_bridge(self, bridge_name): - LOGGER.info('Adding OVS Bridge: ' + bridge_name) - # Create the bridge using ovs-vsctl commands - # Uses the --may-exist option to prevent failures - # if this bridge already exists by this name it won't fail - # and will not modify the existing bridge - success=util.run_command('ovs-vsctl --may-exist add-br ' + bridge_name) - return success - - def add_port(self,port, bridge_name): - LOGGER.info('Adding Port ' + port + ' to OVS Bridge: ' + bridge_name) - # Add a port to the bridge using ovs-vsctl commands - # Uses the --may-exist option to prevent failures - # if this port already exists on the bridge and will not - # modify the existing bridge - success=util.run_command(f"""ovs-vsctl --may-exist - add-port {bridge_name} {port}""") - return success - - def create_net(self): - LOGGER.info('Creating baseline network') - - # Create data plane - self.add_bridge(DEVICE_BRIDGE) - - # Create control plane - self.add_bridge(INTERNET_BRIDGE) - - # Remove IP from internet adapter - self.set_interface_ip(self._int_intf,'0.0.0.0') - - # Add external interfaces to data and control plane - self.add_port(self._dev_intf,DEVICE_BRIDGE) - self.add_port(self._int_intf,INTERNET_BRIDGE) - - # # Set ports up - self.set_bridge_up(DEVICE_BRIDGE) - self.set_bridge_up(INTERNET_BRIDGE) - - def delete_bridge(self,bridge_name): - LOGGER.info('Deleting OVS Bridge: ' + bridge_name) - # Delete the bridge using ovs-vsctl commands - # Uses the --if-exists option to prevent failures - # if this bridge does not exists - success=util.run_command('ovs-vsctl --if-exists del-br ' + bridge_name) - return success - - def _load_config(self): - LOGGER.info('Loading Configuration: ' + CONFIG_FILE) - with open(CONFIG_FILE, 'r', encoding='utf-8') as conf_file: - config_json = json.load(conf_file) - self._int_intf = config_json['internet_intf'] - self._dev_intf = config_json['device_intf'] - LOGGER.info('Configuration Loaded') - LOGGER.info('Internet Interface: ' + self._int_intf) - LOGGER.info('Device Interface: ' + self._dev_intf) - - def restore_net(self): - LOGGER.info('Restoring Network...') - # Delete data plane - self.delete_bridge(DEVICE_BRIDGE) - - # Delete control plane - self.delete_bridge(INTERNET_BRIDGE) - - LOGGER.info('Network is restored') - - def show_config(self): - LOGGER.info('Show current config of OVS') - success=util.run_command('ovs-vsctl show') - return success - - def set_bridge_up(self,bridge_name): - LOGGER.info('Setting Bridge device to up state: ' + bridge_name) - success=util.run_command('ip link set dev ' + bridge_name + ' up') - return success - - def set_interface_ip(self,interface, ip_addr): - LOGGER.info('Setting interface ' + interface + ' to ' + ip_addr) - # Remove IP from internet adapter - util.run_command('ifconfig ' + interface + ' 0.0.0.0') - -if __name__ == '__main__': - ovs = OVSControl() - ovs.create_net() - ovs.show_config() - ovs.restore_net() - ovs.show_config() diff --git a/net_orc/network/modules/ovs/python/src/run.py b/net_orc/network/modules/ovs/python/src/run.py deleted file mode 100644 index 5787a74e6..000000000 --- a/net_orc/network/modules/ovs/python/src/run.py +++ /dev/null @@ -1,54 +0,0 @@ -"""Run OVS module""" -import logger -import signal -import sys -import time - -from ovs_control import OVSControl - -LOGGER = logger.get_logger('ovs_control_run') - -class OVSControlRun: - """Run the OVS module.""" - def __init__(self): - - signal.signal(signal.SIGINT, self.handler) - signal.signal(signal.SIGTERM, self.handler) - signal.signal(signal.SIGABRT, self.handler) - signal.signal(signal.SIGQUIT, self.handler) - - LOGGER.info('Starting OVS Control') - - # Get all components ready - self._ovs_control = OVSControl() - - self._ovs_control.restore_net() - - self._ovs_control.create_net() - - self._ovs_control.show_config() - - # Get network ready (via Network orchestrator) - LOGGER.info('Network is ready. Waiting for device information...') - - #Loop forever until process is stopped - while True: - LOGGER.info('OVS Running') - time.sleep(1000) - - # TODO: This time should be configurable (How long to hold before exiting, - # this could be infinite too) - #time.sleep(300) - - # Tear down network - #self._ovs_control.shutdown() - - def handler(self, signum): - LOGGER.info('SigtermEnum: ' + str(signal.SIGTERM)) - LOGGER.info('Exit signal received: ' + str(signum)) - if (signum == 2 or signal == signal.SIGTERM): - LOGGER.info('Exit signal received. Restoring network...') - self._ovs_control.shutdown() - sys.exit(1) - -ovs = OVSControlRun() diff --git a/net_orc/network/modules/ovs/python/src/util.py b/net_orc/network/modules/ovs/python/src/util.py deleted file mode 100644 index a3ebbb10a..000000000 --- a/net_orc/network/modules/ovs/python/src/util.py +++ /dev/null @@ -1,23 +0,0 @@ -"""Provides basic utilities for a ovs module.""" -import subprocess -import logger - -LOGGER = logger.get_logger('util') - -def run_command(cmd): - success = False - process = subprocess.Popen(cmd.split(), - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - stdout, stderr = process.communicate() - if process.returncode != 0: - err_msg = f'{stderr.strip()}. Code: {process.returncode}' - LOGGER.error('Command Failed: ' + cmd) - LOGGER.error('Error: ' + err_msg) - else: - msg = stdout.strip().decode('utf-8') - succ_msg = f'{msg}. Code: {process.returncode}' - LOGGER.info('Command Success: ' + cmd) - LOGGER.info('Success: ' + succ_msg) - success = True - return success From f33123959cb4c9419c11cb941a82f209f9f3382f Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Mon, 5 Jun 2023 08:34:45 -0700 Subject: [PATCH 026/400] Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron --- net_orc/python/src/network_orchestrator.py | 1 + test_orc/modules/nmap/conf/module_config.json | 3 +- .../modules/nmap/python/src/nmap_module.py | 170 +++++++++++++++--- 3 files changed, 146 insertions(+), 28 deletions(-) diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index bb8d77f3d..2852f1565 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -190,6 +190,7 @@ def _device_discovered(self, mac_addr): LOGGER.info( f'Device with mac addr {device.mac_addr} has obtained IP address ' f'{device.ip_addr}') + self._start_device_monitor(device) def _dhcp_lease_ack(self, packet): diff --git a/test_orc/modules/nmap/conf/module_config.json b/test_orc/modules/nmap/conf/module_config.json index 5449327a1..aafde4c03 100644 --- a/test_orc/modules/nmap/conf/module_config.json +++ b/test_orc/modules/nmap/conf/module_config.json @@ -34,7 +34,8 @@ "tcp_ports": { "22": { "allowed": true, - "description": "Secure Shell (SSH) server" + "description": "Secure Shell (SSH) server", + "version": "2.0" } }, "description": "Check TELNET port 23 is disabled and TELNET is not running on any port", diff --git a/test_orc/modules/nmap/python/src/nmap_module.py b/test_orc/modules/nmap/python/src/nmap_module.py index 028471bb9..6b5477489 100644 --- a/test_orc/modules/nmap/python/src/nmap_module.py +++ b/test_orc/modules/nmap/python/src/nmap_module.py @@ -25,6 +25,7 @@ class NmapModule(TestModule): """NMAP Test module""" + def __init__(self, module): super().__init__(module_name=module, log_name=LOG_NAME) self._unallowed_ports = [] @@ -67,33 +68,87 @@ def _security_nmap_ports(self, config): LOGGER.debug("UDP scan results: " + str(self._scan_udp_results)) LOGGER.debug("Service scan results: " + str(self._script_scan_results)) self._process_port_results(tests=config) + LOGGER.info("Unallowed Ports Detected: " + str(self._unallowed_ports)) + self._check_unallowed_port(self._unallowed_ports,config) LOGGER.info("Unallowed Ports: " + str(self._unallowed_ports)) - LOGGER.info("Script scan results:\n" + - json.dumps(self._script_scan_results)) return len(self._unallowed_ports) == 0 else: LOGGER.info("Device ip address not resolved, skipping") return None def _process_port_results(self, tests): + scan_results = {} + if self._scan_tcp_results is not None: + scan_results.update(self._scan_tcp_results) + if self._scan_udp_results is not None: + scan_results.update(self._scan_udp_results) + if self._script_scan_results is not None: + scan_results.update(self._script_scan_results) + + self._check_unknown_ports(tests=tests,scan_results=scan_results) + for test in tests: LOGGER.info("Checking results for test: " + str(test)) - self._check_scan_results(test_config=tests[test]) + self._check_scan_results(test_config=tests[test],scan_results=scan_results) + + def _check_unknown_ports(self,tests,scan_results): + """ Check if any of the open ports detected are not defined + in the test configurations. If an open port is detected + without a configuration associated with it, the default behavior + is to mark it as an unallowed port. + """ + known_ports = [] + for test in tests: + if "tcp_ports" in tests[test]: + for port in tests[test]['tcp_ports']: + known_ports.append(port) + if "udp_ports" in tests[test]: + for port in tests[test]['udp_ports']: + known_ports.append(port) + + for port_result in scan_results: + if not port_result in known_ports: + LOGGER.info("Unknown port detected: " + port_result) + unallowed_port = {'port':port_result, + 'service':scan_results[port_result]['service'], + 'tcp_udp':scan_results[port_result]['tcp_udp']} + #self._unallowed_ports.append(unallowed_port) + self._add_unknown_ports(tests,unallowed_port) + + def _add_unknown_ports(self,tests,unallowed_port): + known_service = False + result = {'description':"Undefined port",'allowed':False} + if unallowed_port['tcp_udp'] == 'tcp': + port_style = 'tcp_ports' + elif unallowed_port['tcp_udp'] == 'udp': + port_style = 'udp_ports' + for test in tests: + if unallowed_port['service'] in test: + known_service=True + for test_port in tests[test][port_style]: + if "version" in tests[test][port_style][test_port]: + result['version'] = tests[test][port_style][test_port]['version'] + if "description" in tests[test][port_style][test_port]: + result['description'] = tests[test][port_style][test_port]['description'] + result['inherited_from'] = test_port + if tests[test][port_style][test_port]['allowed']: + result['allowed'] = True + break + + tests[test][port_style][unallowed_port['port']]=result + + if not known_service: + service_name = "security.services.unknown." + str(unallowed_port['port']) + unknown_service = {port_style:{unallowed_port['port']:result}} + tests[service_name]=unknown_service - def _check_scan_results(self, test_config): + def _check_scan_results(self, test_config,scan_results): port_config = {} if "tcp_ports" in test_config: port_config.update(test_config["tcp_ports"]) elif "udp_ports" in test_config: port_config.update(test_config["udp_ports"]) - scan_results = {} - if self._scan_tcp_results is not None: - scan_results.update(self._scan_tcp_results) - if self._scan_udp_results is not None: - scan_results.update(self._scan_udp_results) - if self._script_scan_results is not None: - scan_results.update(self._script_scan_results) if port_config is not None: for port, config in port_config.items(): result = None @@ -103,11 +158,23 @@ def _check_scan_results(self, test_config): if scan_results[port]["state"] == "open": if not config["allowed"]: LOGGER.info("Unallowed port open") - self._unallowed_ports.append(str(port)) + self._unallowed_ports.append( + {"port":str(port), + "service":str(scan_results[port]["service"]), + 'tcp_udp':scan_results[port]['tcp_udp']} + ) result = False else: LOGGER.info("Allowed port open") - result = True + if "version" in config and "version" in scan_results[port]: + version_check = self._check_version(scan_results[port]["service"], + scan_results[port]["version"],config["version"]) + if version_check is not None: + result = version_check + else: + result = True + else: + result = True else: LOGGER.info("Port is closed") result = True @@ -120,6 +187,64 @@ def _check_scan_results(self, test_config): else: config["result"] = "skipped" + def _check_unallowed_port(self,unallowed_ports,tests): + service_allowed=False + allowed = False + version = None + service = None + for port in unallowed_ports: + LOGGER.info('Checking unallowed port: ' + port['port']) + LOGGER.info('Looking for service: ' + port['service']) + LOGGER.info('Unallowed Port Config: ' + str(port)) + if port['tcp_udp'] == 'tcp': + port_style = 'tcp_ports' + elif port['tcp_udp'] == 'udp': + port_style = 'udp_ports' + for test in tests: + LOGGER.info('Checking test: ' + str(test)) + if port['service'] in test: + service_config = tests[test] + service = port['service'] + for service_port in service_config[port_style]: + port_config = service_config[port_style][service_port] + service_allowed |= port_config['allowed'] + version = port_config['version'] if 'version' in port_config else None + if service_allowed: + LOGGER.info("Unallowed port detected for allowed service: " + service) + if version is not None: + allowed = self._check_version(service=service, + version_detected=self._scan_tcp_results[port['port']]['version'], + version_expected=version) + else: + allowed = True + if allowed: + LOGGER.info("Unallowed port exception for approved service: " + port['port']) + for u_port in self._unallowed_ports: + if port['port'] in u_port['port']: + self._unallowed_ports.remove(u_port) + break + break + + def _check_version(self,service,version_detected,version_expected): + """Check if the version specified for the service matches what was + detected by nmap. Since there is no consistency in how nmap service + results are returned, each service that needs a checked must be + implemented individually. If a service version is requested + that is not implemented, this test will provide a skip (None) + result. + """ + LOGGER.info("Checking version for service: " + service) + LOGGER.info("NMAP Version Detected: " + version_detected) + LOGGER.info("Version Expected: " + version_expected) + version_check = None + match service: + case "ssh": + version_check = f"protocol {version_expected}" in version_detected + case _: + LOGGER.info("No version check implemented for service: " + service + ". Skipping") + LOGGER.info("Version check result: " + str(version_check)) + return version_check + def _scan_scripts(self, tests): scan_results = {} LOGGER.info("Checing for scan scripts") @@ -169,25 +294,15 @@ def _scan_udp_with_script(self, script_name, ports=None): nmap_results = util.run_command("nmap " + nmap_options + self._device_ipv4_addr)[0] LOGGER.info("Nmap UDP script scan complete") - LOGGER.info("nmap script results\n" + str(nmap_results)) return self._process_nmap_results(nmap_results=nmap_results) def _scan_tcp_ports(self, tests): max_port = 1000 - ports = [] - for test in tests: - test_config = tests[test] - if "tcp_ports" in test_config: - for port in test_config["tcp_ports"]: - if int(port) > max_port: - ports.append(port) - ports_to_scan = "1-" + str(max_port) - if len(ports) > 0: - ports_to_scan += "," + ",".join(ports) LOGGER.info("Running nmap TCP port scan") - LOGGER.info("TCP ports: " + str(ports_to_scan)) - nmap_results = util.run_command(f"""nmap -sT -sV -Pn -v -p {ports_to_scan} + nmap_results = util.run_command( + f"""nmap --open -sT -sV -Pn -v -p 1-{max_port} --version-intensity 7 -T4 {self._device_ipv4_addr}""")[0] + LOGGER.info("TCP port scan complete") self._scan_tcp_results = self._process_nmap_results( nmap_results=nmap_results) @@ -213,7 +328,7 @@ def _process_nmap_results(self, nmap_results): results = {} LOGGER.info("nmap results\n" + str(nmap_results)) if nmap_results: - if "Service Info" in nmap_results: + if "Service Info" in nmap_results and "MAC Address" not in nmap_results: rows = nmap_results.split("PORT")[1].split("Service Info")[0].split( "\n") elif "PORT" in nmap_results: @@ -232,6 +347,7 @@ def _process_nmap_results(self, nmap_results): version = " ".join(cols[3:]) port_result = { cols[0].split("/")[0]: { + "tcp_udp":cols[0].split("/")[1], "state": cols[1], "service": cols[2], "version": version From 2a68fba9d68afe796a076a6ec29727d2c414a12a Mon Sep 17 00:00:00 2001 From: J Boddey Date: Mon, 5 Jun 2023 18:33:28 +0100 Subject: [PATCH 027/400] Create startup capture (#37) --- framework/testrun.py | 19 +++++------ net_orc/python/src/network_orchestrator.py | 34 ++++++++++++------- net_orc/python/src/network_validator.py | 6 ++-- net_orc/python/src/ovs_control.py | 6 ++-- .../{Template => template}/device_config.json | 0 test_orc/python/src/test_orchestrator.py | 16 ++++++--- 6 files changed, 47 insertions(+), 34 deletions(-) rename resources/devices/{Template => template}/device_config.json (100%) diff --git a/framework/testrun.py b/framework/testrun.py index a818c9a45..25232f90c 100644 --- a/framework/testrun.py +++ b/framework/testrun.py @@ -48,7 +48,7 @@ LOGGER = logger.get_logger('test_run') CONFIG_FILE = 'conf/system.json' EXAMPLE_CONFIG_FILE = 'conf/system.json.example' -RUNTIME = 1500 +RUNTIME = 120 LOCAL_DEVICES_DIR = 'local/devices' RESOURCE_DEVICES_DIR = 'resources/devices' @@ -109,12 +109,17 @@ def start(self): [NetworkEvent.DEVICE_DISCOVERED] ) + self._net_orc.start_listener() LOGGER.info('Waiting for devices on the network...') - # Check timeout and whether testing is currently - # in progress before stopping time.sleep(RUNTIME) + if not self._test_orc.test_in_progress(): + LOGGER.info('Timed out whilst waiting for device') + else: + while self._test_orc.test_in_progress(): + time.sleep(5) + self.stop() def stop(self, kill=False): @@ -146,14 +151,6 @@ def _start_network(self): # Start the network orchestrator self._net_orc.start() - def _run_tests(self, device): - """Iterate through and start all test modules.""" - - # To Do: Make this configurable - time.sleep(60) # Let device bootup - - self._test_orc.run_test_modules(device) - def _stop_network(self, kill=False): self._net_orc.stop(kill=kill) diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 2852f1565..726eef3b9 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -38,7 +38,7 @@ CONFIG_FILE = 'conf/system.json' EXAMPLE_CONFIG_FILE = 'conf/system.json.example' RUNTIME_DIR = 'runtime' -DEVICES_DIR = 'devices' +TEST_DIR = 'test' MONITOR_PCAP = 'monitor.pcap' NET_DIR = 'runtime/network' NETWORK_MODULES_DIR = 'network/modules' @@ -93,7 +93,7 @@ def __init__(self, def start(self): """Start the network orchestrator.""" - LOGGER.info('Starting Network Orchestrator') + LOGGER.debug('Starting network orchestrator') # Get all components ready self.load_network_modules() @@ -125,6 +125,9 @@ def start_network(self): # Get network ready (via Network orchestrator) LOGGER.info('Network is ready.') + def start_listener(self): + self.listener.start_listener() + def stop(self, kill=False): """Stop the network orchestrator.""" self.stop_validator(kill=kill) @@ -172,16 +175,16 @@ def _device_discovered(self, mac_addr): f'Discovered device {mac_addr}. Waiting for device to obtain IP') device = self._get_device(mac_addr=mac_addr) os.makedirs( - os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(':', - ''))) - - timeout = time.time() + self._startup_timeout + os.path.join(RUNTIME_DIR, + TEST_DIR, + device.mac_addr.replace(':', ''))) - while time.time() < timeout: - if device.ip_addr is None: - time.sleep(3) - else: - break + packet_capture = sniff(iface=self._dev_intf, + timeout=self._startup_timeout, + stop_filter=self._device_has_ip) + wrpcap( + os.path.join(RUNTIME_DIR, TEST_DIR, device.mac_addr.replace(':', ''), + 'startup.pcap'), packet_capture) if device.ip_addr is None: LOGGER.info( @@ -193,6 +196,12 @@ def _device_discovered(self, mac_addr): self._start_device_monitor(device) + def _device_has_ip(self, packet): + device = self._get_device(mac_addr=packet.src) + if device is None or device.ip_addr is None: + return False + return True + def _dhcp_lease_ack(self, packet): mac_addr = packet[BOOTP].chaddr.hex(':')[0:17] device = self._get_device(mac_addr=mac_addr) @@ -206,7 +215,7 @@ def _start_device_monitor(self, device): packet_capture = sniff(iface=self._dev_intf, timeout=self._monitor_period) wrpcap( - os.path.join(RUNTIME_DIR, DEVICES_DIR, device.mac_addr.replace(':', ''), + os.path.join(RUNTIME_DIR, TEST_DIR, device.mac_addr.replace(':', ''), 'monitor.pcap'), packet_capture) self.listener.call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) @@ -341,7 +350,6 @@ def create_net(self): [NetworkEvent.DEVICE_DISCOVERED]) self.listener.register_callback(self._dhcp_lease_ack, [NetworkEvent.DHCP_LEASE_ACK]) - self.listener.start_listener() def load_network_modules(self): """Load network modules from module_config.json.""" diff --git a/net_orc/python/src/network_validator.py b/net_orc/python/src/network_validator.py index a90096f7d..e76e49a5c 100644 --- a/net_orc/python/src/network_validator.py +++ b/net_orc/python/src/network_validator.py @@ -47,16 +47,16 @@ def __init__(self): def start(self): """Start the network validator.""" - LOGGER.info('Starting validator') + LOGGER.debug('Starting validator') self._load_devices() self._build_network_devices() self._start_network_devices() def stop(self, kill=False): """Stop the network validator.""" - LOGGER.info('Stopping validator') + LOGGER.debug('Stopping validator') self._stop_network_devices(kill) - LOGGER.info('Validator stopped') + LOGGER.debug('Validator stopped') def _build_network_devices(self): LOGGER.debug('Building network validators...') diff --git a/net_orc/python/src/ovs_control.py b/net_orc/python/src/ovs_control.py index 4c989756b..ce316dba7 100644 --- a/net_orc/python/src/ovs_control.py +++ b/net_orc/python/src/ovs_control.py @@ -77,15 +77,15 @@ def port_exists(self, bridge_name, port): def validate_baseline_network(self): # Verify the OVS setup of the virtual network - LOGGER.info('Validating baseline network') + LOGGER.debug('Validating baseline network') # Verify the device bridge dev_bridge = self.verify_bridge(DEVICE_BRIDGE, [self._dev_intf]) - LOGGER.info('Device bridge verified: ' + str(dev_bridge)) + LOGGER.debug('Device bridge verified: ' + str(dev_bridge)) # Verify the internet bridge int_bridge = self.verify_bridge(INTERNET_BRIDGE, [self._int_intf]) - LOGGER.info('Internet bridge verified: ' + str(int_bridge)) + LOGGER.debug('Internet bridge verified: ' + str(int_bridge)) return dev_bridge and int_bridge diff --git a/resources/devices/Template/device_config.json b/resources/devices/template/device_config.json similarity index 100% rename from resources/devices/Template/device_config.json rename to resources/devices/template/device_config.json diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 14b39720d..08b720150 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -37,6 +37,7 @@ def __init__(self, net_orc): self._test_modules = [] self._module_config = None self._net_orc = net_orc + self._test_in_progress = False self._path = os.path.dirname( os.path.dirname(os.path.dirname(os.path.realpath(__file__)))) @@ -49,7 +50,7 @@ def __init__(self, net_orc): os.makedirs(os.path.join(self._root_path, RUNTIME_DIR), exist_ok=True) def start(self): - LOGGER.info("Starting Test Orchestrator") + LOGGER.debug("Starting test orchestrator") self._load_test_modules() self.build_test_modules() @@ -59,14 +60,18 @@ def stop(self): def run_test_modules(self, device): """Iterates through each test module and starts the container.""" + self._test_in_progress = True LOGGER.info( f"Running test modules on device with mac addr {device.mac_addr}") for module in self._test_modules: self._run_test_module(module, device) LOGGER.info("All tests complete") - LOGGER.info(f"""Completed running test modules on device - with mac addr {device.mac_addr}""") + LOGGER.info( + f"""Completed running test \ +modules on device with mac \ +addr {device.mac_addr}""") self._generate_results(device) + self._test_in_progress = False def _generate_results(self, device): results = {} @@ -88,7 +93,7 @@ def _generate_results(self, device): results[module.name] = module_results except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: - LOGGER.error("Module Results Errror " + module.name) + LOGGER.error("Error occured whilst running module " + module.name) LOGGER.debug(results_error) out_file = os.path.join( @@ -98,6 +103,9 @@ def _generate_results(self, device): json.dump(results, f, indent=2) return results + def test_in_progress(self): + return self._test_in_progress + def _is_module_enabled(self, module, device): enabled = True if device.test_modules is not None: From 8e8e154623c4aee5286d4003ef9f08c069e113d6 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Wed, 7 Jun 2023 11:10:16 -0700 Subject: [PATCH 028/400] Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator --- net_orc/python/src/network_orchestrator.py | 42 +++++++++++- net_orc/python/src/network_validator.py | 42 +++++++++++- test_orc/modules/conn/bin/start_test_module | 39 +++++++++++ test_orc/modules/conn/conf/module_config.json | 22 ++++++ test_orc/modules/conn/conn.Dockerfile | 11 +++ .../conn/python/src/connection_module.py | 49 +++++++++++++ test_orc/modules/conn/python/src/run.py | 68 +++++++++++++++++++ test_orc/python/src/test_orchestrator.py | 43 +++++++++++- 8 files changed, 313 insertions(+), 3 deletions(-) create mode 100644 test_orc/modules/conn/bin/start_test_module create mode 100644 test_orc/modules/conn/conf/module_config.json create mode 100644 test_orc/modules/conn/conn.Dockerfile create mode 100644 test_orc/modules/conn/python/src/connection_module.py create mode 100644 test_orc/modules/conn/python/src/run.py diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 726eef3b9..77af509f2 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -469,7 +469,7 @@ def _start_network_service(self, net_module): privileged=True, detach=True, mounts=net_module.mounts, - environment={'HOST_USER': getpass.getuser()}) + environment={'HOST_USER': self._get_host_user()}) except docker.errors.ContainerError as error: LOGGER.error('Container run error') LOGGER.error(error) @@ -477,6 +477,46 @@ def _start_network_service(self, net_module): if network != 'host': self._attach_service_to_network(net_module) + def _get_host_user(self): + user = self._get_os_user() + + # If primary method failed, try secondary + if user is None: + user = self._get_user() + + LOGGER.debug("Network orchestrator host user: " + user) + return user + + def _get_os_user(self): + user = None + try: + user = os.getlogin() + except OSError as e: + # Handle the OSError exception + LOGGER.error("An OS error occurred while retrieving the login name.") + except Exception as e: + # Catch any other unexpected exceptions + LOGGER.error("An exception occurred:", e) + return user + + def _get_user(self): + user = None + try: + user = getpass.getuser() + except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: + # Handle specific exceptions individually + if isinstance(e, KeyError): + LOGGER.error("USER environment variable not set or unavailable.") + elif isinstance(e, ImportError): + LOGGER.error("Unable to import the getpass module.") + elif isinstance(e, ModuleNotFoundError): + LOGGER.error("The getpass module was not found.") + elif isinstance(e, OSError): + LOGGER.error("An OS error occurred while retrieving the username.") + else: + LOGGER.error("An exception occurred:", e) + return user + def _stop_service_module(self, net_module, kill=False): LOGGER.debug('Stopping Service container ' + net_module.container_name) try: diff --git a/net_orc/python/src/network_validator.py b/net_orc/python/src/network_validator.py index e76e49a5c..4a3a2a080 100644 --- a/net_orc/python/src/network_validator.py +++ b/net_orc/python/src/network_validator.py @@ -150,7 +150,7 @@ def _start_network_device(self, device): privileged=True, detach=True, mounts=device.mounts, - environment={'HOST_USER': getpass.getuser()}) + environment={'HOST_USER': self._get_host_user()}) except docker.errors.ContainerError as error: LOGGER.error('Container run error') LOGGER.error(error) @@ -167,6 +167,46 @@ def _start_network_device(self, device): LOGGER.info('Validation device ' + device.name + ' has finished') + def _get_host_user(self): + user = self._get_os_user() + + # If primary method failed, try secondary + if user is None: + user = self._get_user() + + LOGGER.debug("Network validator host user: " + user) + return user + + def _get_os_user(self): + user = None + try: + user = os.getlogin() + except OSError as e: + # Handle the OSError exception + LOGGER.error("An OS error occurred while retrieving the login name.") + except Exception as e: + # Catch any other unexpected exceptions + LOGGER.error("An exception occurred:", e) + return user + + def _get_user(self): + user = None + try: + user = getpass.getuser() + except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: + # Handle specific exceptions individually + if isinstance(e, KeyError): + LOGGER.error("USER environment variable not set or unavailable.") + elif isinstance(e, ImportError): + LOGGER.error("Unable to import the getpass module.") + elif isinstance(e, ModuleNotFoundError): + LOGGER.error("The getpass module was not found.") + elif isinstance(e, OSError): + LOGGER.error("An OS error occurred while retrieving the username.") + else: + LOGGER.error("An exception occurred:", e) + return user + def _get_device_status(self, module): container = self._get_device_container(module) if container is not None: diff --git a/test_orc/modules/conn/bin/start_test_module b/test_orc/modules/conn/bin/start_test_module new file mode 100644 index 000000000..4550849ce --- /dev/null +++ b/test_orc/modules/conn/bin/start_test_module @@ -0,0 +1,39 @@ +#!/bin/bash + +# Setup and start the connection test module + +# Define where the python source files are located +PYTHON_SRC_DIR=/testrun/python/src + +# Fetch module name +MODULE_NAME=$1 + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No interface defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +# Create and set permissions on the log files +LOG_FILE=/runtime/output/$MODULE_NAME.log +RESULT_FILE=/runtime/output/$MODULE_NAME-result.json +touch $LOG_FILE +touch $RESULT_FILE +chown $HOST_USER:$HOST_USER $LOG_FILE +chown $HOST_USER:$HOST_USER $RESULT_FILE + +# Run the python scrip that will execute the tests for this module +# -u flag allows python print statements +# to be logged by docker by running unbuffered +python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" + +echo Module has finished \ No newline at end of file diff --git a/test_orc/modules/conn/conf/module_config.json b/test_orc/modules/conn/conf/module_config.json new file mode 100644 index 000000000..e73846340 --- /dev/null +++ b/test_orc/modules/conn/conf/module_config.json @@ -0,0 +1,22 @@ +{ + "config": { + "meta": { + "name": "connection", + "display_name": "Connection", + "description": "Connection tests" + }, + "network": true, + "docker": { + "depends_on": "base", + "enable_container": true, + "timeout": 30 + }, + "tests":[ + { + "name": "connection.target_ping", + "description": "The device under test responds to an ICMP echo (ping) request.", + "expected_behavior": "The device under test responds to an ICMP echo (ping) request." + } + ] + } +} \ No newline at end of file diff --git a/test_orc/modules/conn/conn.Dockerfile b/test_orc/modules/conn/conn.Dockerfile new file mode 100644 index 000000000..f6a2c86b4 --- /dev/null +++ b/test_orc/modules/conn/conn.Dockerfile @@ -0,0 +1,11 @@ +# Image name: test-run/conn-test +FROM test-run/base-test:latest + +# Copy over all configuration files +COPY modules/conn/conf /testrun/conf + +# Load device binary files +COPY modules/conn/bin /testrun/bin + +# Copy over all python files +COPY modules/conn/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/conn/python/src/connection_module.py b/test_orc/modules/conn/python/src/connection_module.py new file mode 100644 index 000000000..086f32a04 --- /dev/null +++ b/test_orc/modules/conn/python/src/connection_module.py @@ -0,0 +1,49 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Connection test module""" +import util +import sys +from test_module import TestModule + +LOG_NAME = "test_connection" +LOGGER = None + + +class ConnectionModule(TestModule): + """Connection Test module""" + + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + global LOGGER + LOGGER = self._get_logger() + + def _connection_target_ping(self): + LOGGER.info("Running connection.target_ping") + + # If the ipv4 address wasn't resolved yet, try again + if self._device_ipv4_addr is None: + self._device_ipv4_addr = self._get_device_ipv4(self) + + if self._device_ipv4_addr is None: + LOGGER.error("No device IP could be resolved") + sys.exit(1) + else: + return self._ping(self._device_ipv4_addr) + + + def _ping(self, host): + cmd = 'ping -c 1 ' + str(host) + success = util.run_command(cmd, output=False) + return success \ No newline at end of file diff --git a/test_orc/modules/conn/python/src/run.py b/test_orc/modules/conn/python/src/run.py new file mode 100644 index 000000000..5165b58c6 --- /dev/null +++ b/test_orc/modules/conn/python/src/run.py @@ -0,0 +1,68 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Run NMAP test module""" +import argparse +import signal +import sys +import logger + +from connection_module import ConnectionModule + +LOGGER = logger.get_logger('connection_module') + + +class ConnectionModuleRunner: + """Run the Connection module tests.""" + + def __init__(self, module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + + LOGGER.info('Starting connection module') + + self._test_module = ConnectionModule(module) + self._test_module.run_tests() + + def _handler(self, signum): + LOGGER.debug('SigtermEnum: ' + str(signal.SIGTERM)) + LOGGER.debug('Exit signal received: ' + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info('Exit signal received. Stopping connection test module...') + LOGGER.info('Test module stopped') + sys.exit(1) + + +def run(): + parser = argparse.ArgumentParser( + description='Connection Module Help', + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + '-m', + '--module', + help='Define the module name to be used to create the log file') + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + ConnectionModuleRunner(args.module.strip()) + + +if __name__ == '__main__': + run() diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index 08b720150..e122221f5 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -153,7 +153,7 @@ def _run_test_module(self, module, device): read_only=True), ], environment={ - "HOST_USER": getpass.getuser(), + "HOST_USER": self._get_host_user(), "DEVICE_MAC": device.mac_addr, "DEVICE_TEST_MODULES": device.test_modules, "IPV4_SUBNET": self._net_orc.network_config.ipv4_network, @@ -206,6 +206,47 @@ def _get_module_container(self, module): LOGGER.error(error) return container + def _get_host_user(self): + user = self._get_os_user() + + # If primary method failed, try secondary + if user is None: + user = self._get_user() + + LOGGER.debug("Test orchestrator host user: " + user) + return user + + def _get_os_user(self): + user = None + try: + user = os.getlogin() + except OSError as e: + # Handle the OSError exception + LOGGER.error("An OS error occurred while retrieving the login name.") + except Exception as e: + # Catch any other unexpected exceptions + LOGGER.error("An exception occurred:", e) + return user + + def _get_user(self): + user = None + try: + user = getpass.getuser() + except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: + # Handle specific exceptions individually + if isinstance(e, KeyError): + LOGGER.error("USER environment variable not set or unavailable.") + elif isinstance(e, ImportError): + LOGGER.error("Unable to import the getpass module.") + elif isinstance(e, ModuleNotFoundError): + LOGGER.error("The getpass module was not found.") + elif isinstance(e, OSError): + LOGGER.error("An OS error occurred while retrieving the username.") + else: + LOGGER.error("An exception occurred:", e) + return user + + def _load_test_modules(self): """Load network modules from module_config.json.""" LOGGER.debug("Loading test modules from /" + TEST_MODULES_DIR) From 6ff220b59bceb3a843ebae7ab4942116b0ed601d Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 8 Jun 2023 01:17:28 -0700 Subject: [PATCH 029/400] Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting --- .../modules/base/python/src/test_module.py | 7 +- test_orc/modules/conn/conf/module_config.json | 5 + test_orc/modules/conn/conn.Dockerfile | 8 +- .../conn/python/src/connection_module.py | 21 ++++ test_orc/python/src/runner.py | 110 +++++++++--------- 5 files changed, 94 insertions(+), 57 deletions(-) diff --git a/test_orc/modules/base/python/src/test_module.py b/test_orc/modules/base/python/src/test_module.py index 57795a182..f29668bb2 100644 --- a/test_orc/modules/base/python/src/test_module.py +++ b/test_orc/modules/base/python/src/test_module.py @@ -95,7 +95,12 @@ def run_tests(self): else: LOGGER.info('Test ' + test['name'] + ' disabled. Skipping') if result is not None: - test['result'] = 'compliant' if result else 'non-compliant' + success = None + if isinstance(result,bool): + test['result'] = 'compliant' if result else 'non-compliant' + else: + test['result'] = 'compliant' if result[0] else 'non-compliant' + test['result_details'] = result[1] else: test['result'] = 'skipped' test['end'] = datetime.now().isoformat() diff --git a/test_orc/modules/conn/conf/module_config.json b/test_orc/modules/conn/conf/module_config.json index e73846340..505cc9e78 100644 --- a/test_orc/modules/conn/conf/module_config.json +++ b/test_orc/modules/conn/conf/module_config.json @@ -16,6 +16,11 @@ "name": "connection.target_ping", "description": "The device under test responds to an ICMP echo (ping) request.", "expected_behavior": "The device under test responds to an ICMP echo (ping) request." + }, + { + "name": "connection.mac_oui", + "description": "The device under test hs a MAC address prefix that is registered against a known manufacturer.", + "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database." } ] } diff --git a/test_orc/modules/conn/conn.Dockerfile b/test_orc/modules/conn/conn.Dockerfile index f6a2c86b4..10130933d 100644 --- a/test_orc/modules/conn/conn.Dockerfile +++ b/test_orc/modules/conn/conn.Dockerfile @@ -1,6 +1,12 @@ # Image name: test-run/conn-test FROM test-run/base-test:latest +# Install all necessary packages +RUN apt-get install -y wget + +#Update the oui.txt file from ieee +RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ + # Copy over all configuration files COPY modules/conn/conf /testrun/conf @@ -8,4 +14,4 @@ COPY modules/conn/conf /testrun/conf COPY modules/conn/bin /testrun/bin # Copy over all python files -COPY modules/conn/python /testrun/python \ No newline at end of file +COPY modules/conn/python /testrun/python diff --git a/test_orc/modules/conn/python/src/connection_module.py b/test_orc/modules/conn/python/src/connection_module.py index 086f32a04..28d41638c 100644 --- a/test_orc/modules/conn/python/src/connection_module.py +++ b/test_orc/modules/conn/python/src/connection_module.py @@ -19,6 +19,7 @@ LOG_NAME = "test_connection" LOGGER = None +OUI_FILE="/usr/local/etc/oui.txt" class ConnectionModule(TestModule): @@ -42,6 +43,26 @@ def _connection_target_ping(self): else: return self._ping(self._device_ipv4_addr) + def _connection_mac_oui(self): + LOGGER.info("Running connection.mac_oui") + manufacturer = self._get_oui_manufacturer(self._device_mac) + if manufacturer is not None: + LOGGER.info("OUI Manufacturer found: " + manufacturer) + return True, "OUI Manufacturer found: " + manufacturer + else: + LOGGER.info("No OUI Manufacturer found for: " + self._device_mac) + return False, "No OUI Manufacturer found for: " + self._device_mac + + def _get_oui_manufacturer(self,mac_address): + # Do some quick fixes on the format of the mac_address + # to match the oui file pattern + mac_address = mac_address.replace(":","-").upper() + with open(OUI_FILE, "r") as file: + for line in file: + if mac_address.startswith(line[:8]): + start = line.index("(hex)") + len("(hex)") + return line[start:].strip() # Extract the company name + return None def _ping(self, host): cmd = 'ping -c 1 ' + str(host) diff --git a/test_orc/python/src/runner.py b/test_orc/python/src/runner.py index 363f800af..ed3b9059a 100644 --- a/test_orc/python/src/runner.py +++ b/test_orc/python/src/runner.py @@ -1,55 +1,55 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Provides high level management of the test orchestrator.""" -import time -import logger - -LOGGER = logger.get_logger('runner') - - -class Runner: - """Holds the state of the testing for one device.""" - - def __init__(self, test_orc, device): - self._test_orc = test_orc - self._device = device - - def run(self): - self._run_test_modules() - - def _run_test_modules(self): - """Iterates through each test module and starts the container.""" - LOGGER.info('Running test modules...') - for module in self._test_modules: - self.run_test_module(module) - LOGGER.info('All tests complete') - - def run_test_module(self, module): - """Start the test container and extract the results.""" - - if module is None or not module.enable_container: - return - - self._test_orc.start_test_module(module) - - # Determine the module timeout time - test_module_timeout = time.time() + module.timeout - status = self._test_orc.get_module_status(module) - - while time.time() < test_module_timeout and status == 'running': - time.sleep(1) - status = self._test_orc.get_module_status(module) - - LOGGER.info(f'Test module {module.display_name} has finished') +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Provides high level management of the test orchestrator.""" +import time +import logger + +LOGGER = logger.get_logger('runner') + + +class Runner: + """Holds the state of the testing for one device.""" + + def __init__(self, test_orc, device): + self._test_orc = test_orc + self._device = device + + def run(self): + self._run_test_modules() + + def _run_test_modules(self): + """Iterates through each test module and starts the container.""" + LOGGER.info('Running test modules...') + for module in self._test_modules: + self.run_test_module(module) + LOGGER.info('All tests complete') + + def run_test_module(self, module): + """Start the test container and extract the results.""" + + if module is None or not module.enable_container: + return + + self._test_orc.start_test_module(module) + + # Determine the module timeout time + test_module_timeout = time.time() + module.timeout + status = self._test_orc.get_module_status(module) + + while time.time() < test_module_timeout and status == 'running': + time.sleep(1) + status = self._test_orc.get_module_status(module) + + LOGGER.info(f'Test module {module.display_name} has finished') From 4ca8f442cf5b73b561456a42576c02bc69ee57a7 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 8 Jun 2023 01:51:05 -0700 Subject: [PATCH 030/400] Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test --- test_orc/modules/conn/conf/module_config.json | 12 +++++++++++- .../modules/conn/python/src/connection_module.py | 12 +++++++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/test_orc/modules/conn/conf/module_config.json b/test_orc/modules/conn/conf/module_config.json index 505cc9e78..25145980e 100644 --- a/test_orc/modules/conn/conf/module_config.json +++ b/test_orc/modules/conn/conf/module_config.json @@ -11,7 +11,17 @@ "enable_container": true, "timeout": 30 }, - "tests":[ + "tests": [ + { + "name": "connection.mac_address", + "description": "Check and note device physical address.", + "expected_behavior": "N/A" + }, + { + "name": "connection.mac_oui", + "description": "The device under test hs a MAC address prefix that is registered against a known manufacturer.", + "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database." + }, { "name": "connection.target_ping", "description": "The device under test responds to an ICMP echo (ping) request.", diff --git a/test_orc/modules/conn/python/src/connection_module.py b/test_orc/modules/conn/python/src/connection_module.py index 28d41638c..48d134584 100644 --- a/test_orc/modules/conn/python/src/connection_module.py +++ b/test_orc/modules/conn/python/src/connection_module.py @@ -43,6 +43,15 @@ def _connection_target_ping(self): else: return self._ping(self._device_ipv4_addr) + def _connection_mac_address(self): + LOGGER.info("Running connection.mac_address") + if self._device_mac is not None: + LOGGER.info("MAC address found: " + self._device_mac) + return True, "MAC address found: " + self._device_mac + else: + LOGGER.info("No MAC address found: " + self._device_mac) + return False, "No MAC address found." + def _connection_mac_oui(self): LOGGER.info("Running connection.mac_oui") manufacturer = self._get_oui_manufacturer(self._device_mac) @@ -67,4 +76,5 @@ def _get_oui_manufacturer(self,mac_address): def _ping(self, host): cmd = 'ping -c 1 ' + str(host) success = util.run_command(cmd, output=False) - return success \ No newline at end of file + return success + \ No newline at end of file From ff04f4393574cfa148c790d5a01c7442a4651ea3 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 8 Jun 2023 13:15:26 -0700 Subject: [PATCH 031/400] Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures --- test_orc/modules/dns/conf/module_config.json | 4 ++ test_orc/modules/dns/python/src/dns_module.py | 37 ++++++++++++++++--- test_orc/python/src/test_orchestrator.py | 17 +++++++++ 3 files changed, 52 insertions(+), 6 deletions(-) diff --git a/test_orc/modules/dns/conf/module_config.json b/test_orc/modules/dns/conf/module_config.json index b8ff36c97..177537b69 100644 --- a/test_orc/modules/dns/conf/module_config.json +++ b/test_orc/modules/dns/conf/module_config.json @@ -21,6 +21,10 @@ "name": "dns.network.from_dhcp", "description": "Verify the device allows for a DNS server to be entered automatically", "expected_behavior": "The device sends DNS requests to the DNS server provided by the DHCP server" + }, + { + "name": "dns.mdns", + "description": "If the device has MDNS (or any kind of IP multicast), can it be disabled" } ] } diff --git a/test_orc/modules/dns/python/src/dns_module.py b/test_orc/modules/dns/python/src/dns_module.py index cd7261da0..8d32d4dfb 100644 --- a/test_orc/modules/dns/python/src/dns_module.py +++ b/test_orc/modules/dns/python/src/dns_module.py @@ -17,7 +17,9 @@ from test_module import TestModule LOG_NAME = 'test_dns' -CAPTURE_FILE = '/runtime/network/dns.pcap' +DNS_SERVER_CAPTURE_FILE = '/runtime/network/dns.pcap' +STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' +MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' LOGGER = None @@ -31,14 +33,24 @@ def __init__(self, module): LOGGER = self._get_logger() def _check_dns_traffic(self, tcpdump_filter): - to_dns = self._exec_tcpdump(tcpdump_filter) - num_query_dns = len(to_dns) + dns_server_queries = self._exec_tcpdump(tcpdump_filter,DNS_SERVER_CAPTURE_FILE) + LOGGER.info('DNS Server queries found: ' + str(len(dns_server_queries))) + + dns_startup_queries = self._exec_tcpdump(tcpdump_filter,STARTUP_CAPTURE_FILE) + LOGGER.info('Startup DNS queries found: ' + str(len(dns_startup_queries))) + + dns_monitor_queries = self._exec_tcpdump(tcpdump_filter,MONITOR_CAPTURE_FILE) + LOGGER.info('Monitor DNS queries found: ' + str(len(dns_monitor_queries))) + + num_query_dns = len(dns_server_queries) + len(dns_startup_queries) + len(dns_monitor_queries) + LOGGER.info('DNS queries found: ' + str(num_query_dns)) - dns_traffic_detected = len(to_dns) > 0 + dns_traffic_detected = num_query_dns > 0 LOGGER.info('DNS traffic detected: ' + str(dns_traffic_detected)) return dns_traffic_detected def _dns_network_from_dhcp(self): + LOGGER.info("Running dns.network.from_dhcp") LOGGER.info('Checking DNS traffic for configured DHCP DNS server: ' + self._dns_server) @@ -53,6 +65,7 @@ def _dns_network_from_dhcp(self): return result def _dns_network_from_device(self): + LOGGER.info("Running dns.network.from_device") LOGGER.info('Checking DNS traffic from device: ' + self._device_mac) # Check if the device DNS traffic is to appropriate server @@ -63,7 +76,19 @@ def _dns_network_from_device(self): LOGGER.info('DNS traffic detected from device: ' + str(result)) return result - def _exec_tcpdump(self, tcpdump_filter): + def _dns_mdns(self): + LOGGER.info("Running dns.mdns") + + # Check if the device sends any MDNS traffic + tcpdump_filter = f'udp port 5353 and ether src {self._device_mac}' + + result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) + + LOGGER.info('MDNS traffic detected from device: ' + str(result)) + return not result + + + def _exec_tcpdump(self, tcpdump_filter, capture_file): """ Args tcpdump_filter: Filter to pass onto tcpdump file @@ -71,7 +96,7 @@ def _exec_tcpdump(self, tcpdump_filter): Returns List of packets matching the filter """ - command = f'tcpdump -tttt -n -r {CAPTURE_FILE} {tcpdump_filter}' + command = f'tcpdump -tttt -n -r {capture_file} {tcpdump_filter}' LOGGER.debug('tcpdump command: ' + command) diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index e122221f5..b8b7a3af2 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -133,6 +133,15 @@ def _run_test_module(self, module, device): network_runtime_dir = os.path.join(self._root_path, "runtime/network") os.makedirs(container_runtime_dir) + device_startup_capture = os.path.join( + self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + + "/startup.pcap") + + device_monitor_capture = os.path.join( + self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + + "/monitor.pcap") + + client = docker.from_env() module.container = client.containers.run( @@ -151,6 +160,14 @@ def _run_test_module(self, module, device): source=network_runtime_dir, type="bind", read_only=True), + Mount(target="/runtime/device/startup.pcap", + source=device_startup_capture, + type="bind", + read_only=True), + Mount(target="/runtime/device/monitor.pcap", + source=device_monitor_capture, + type="bind", + read_only=True), ], environment={ "HOST_USER": self._get_host_user(), From 752f7017f488c3f6ac92a38fb39c89b168996dc9 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Fri, 9 Jun 2023 02:10:26 -0700 Subject: [PATCH 032/400] File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions --- .../devices/faux-dev/bin/start_network_service | 8 ++++---- net_orc/python/src/network_orchestrator.py | 13 +++++++++---- net_orc/python/src/network_validator.py | 6 ++++++ test_orc/modules/base/bin/start_module | 6 ++++++ test_orc/modules/dns/python/src/run.py | 8 ++++---- test_orc/modules/nmap/python/src/run.py | 13 ++++++++++--- test_orc/python/src/test_orchestrator.py | 16 ++++++++++++---- 7 files changed, 51 insertions(+), 19 deletions(-) diff --git a/net_orc/network/devices/faux-dev/bin/start_network_service b/net_orc/network/devices/faux-dev/bin/start_network_service index b727d2091..13e2f6baf 100644 --- a/net_orc/network/devices/faux-dev/bin/start_network_service +++ b/net_orc/network/devices/faux-dev/bin/start_network_service @@ -22,12 +22,12 @@ else fi #Create and set permissions on the output files -LOG_FILE=/runtime/validation/$MODULE_NAME.log -RESULT_FILE=/runtime/validation/result.json +OUTPUT_DIR=/runtime/validation/ +LOG_FILE=$OUTPUT_DIR/$MODULE_NAME.log +RESULT_FILE=$OUTPUT_DIR/result.json touch $LOG_FILE touch $RESULT_FILE -chown $HOST_USER:$HOST_USER $LOG_FILE -chown $HOST_USER:$HOST_USER $RESULT_FILE +chown -R $HOST_USER:$HOST_USER $OUTPUT_DIR # Start dhclient $BIN_DIR/start_dhcp_client $INTF diff --git a/net_orc/python/src/network_orchestrator.py b/net_orc/python/src/network_orchestrator.py index 77af509f2..f53b17d15 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/net_orc/python/src/network_orchestrator.py @@ -94,6 +94,9 @@ def start(self): """Start the network orchestrator.""" LOGGER.debug('Starting network orchestrator') + + self._host_user = self._get_host_user() + # Get all components ready self.load_network_modules() @@ -174,10 +177,12 @@ def _device_discovered(self, mac_addr): LOGGER.debug( f'Discovered device {mac_addr}. Waiting for device to obtain IP') device = self._get_device(mac_addr=mac_addr) - os.makedirs( - os.path.join(RUNTIME_DIR, + + device_runtime_dir = os.path.join(RUNTIME_DIR, TEST_DIR, - device.mac_addr.replace(':', ''))) + device.mac_addr.replace(':', '')) + os.makedirs(device_runtime_dir) + util.run_command(f'chown -R {self._host_user}:{self._host_user} {device_runtime_dir}') packet_capture = sniff(iface=self._dev_intf, timeout=self._startup_timeout, @@ -469,7 +474,7 @@ def _start_network_service(self, net_module): privileged=True, detach=True, mounts=net_module.mounts, - environment={'HOST_USER': self._get_host_user()}) + environment={'HOST_USER': self._host_user}) except docker.errors.ContainerError as error: LOGGER.error('Container run error') LOGGER.error(error) diff --git a/net_orc/python/src/network_validator.py b/net_orc/python/src/network_validator.py index 4a3a2a080..832a154e3 100644 --- a/net_orc/python/src/network_validator.py +++ b/net_orc/python/src/network_validator.py @@ -48,6 +48,12 @@ def __init__(self): def start(self): """Start the network validator.""" LOGGER.debug('Starting validator') + + # Setup the output directory + host_user = self._get_host_user() + os.makedirs(OUTPUT_DIR, exist_ok=True) + util.run_command(f'chown -R {host_user}:{host_user} {OUTPUT_DIR}') + self._load_devices() self._build_network_devices() self._start_network_devices() diff --git a/test_orc/modules/base/bin/start_module b/test_orc/modules/base/bin/start_module index 6adc53f58..c179668ba 100644 --- a/test_orc/modules/base/bin/start_module +++ b/test_orc/modules/base/bin/start_module @@ -1,5 +1,8 @@ #!/bin/bash +# Define the local mount point to store local files to +OUTPUT_DIR="/runtime/output" + # Directory where all binaries will be loaded BIN_DIR="/testrun/bin" @@ -11,6 +14,9 @@ IFACE=veth0 # HOST_USER mapped in via docker container environemnt variables useradd $HOST_USER +# Set permissions on the output files +chown -R $HOST_USER:$HOST_USER $OUTPUT_DIR + # Enable IPv6 for all containers sysctl net.ipv6.conf.all.disable_ipv6=0 sysctl -p diff --git a/test_orc/modules/dns/python/src/run.py b/test_orc/modules/dns/python/src/run.py index 2b924bbaf..4803f63cd 100644 --- a/test_orc/modules/dns/python/src/run.py +++ b/test_orc/modules/dns/python/src/run.py @@ -20,7 +20,7 @@ from dns_module import DNSModule -LOG_NAME = "dns_module" +LOG_NAME = "dns_runner" LOGGER = logger.get_logger(LOG_NAME) RUNTIME = 1500 @@ -35,12 +35,12 @@ def __init__(self, module): signal.signal(signal.SIGQUIT, self._handler) self.add_logger(module) - LOGGER.info("Starting DNS Test Module") + LOGGER.info("Starting DNS test module") self._test_module = DNSModule(module) self._test_module.run_tests() - LOGGER.info("DNS Test Module Finished") + LOGGER.info("DNS test module finished") def add_logger(self, module): global LOGGER @@ -57,7 +57,7 @@ def _handler(self, signum): def run(): parser = argparse.ArgumentParser( - description="Test Module DNS", + description="DNS Module Help", formatter_class=argparse.ArgumentDefaultsHelpFormatter) parser.add_argument( diff --git a/test_orc/modules/nmap/python/src/run.py b/test_orc/modules/nmap/python/src/run.py index ecb6cd028..5e33451d9 100644 --- a/test_orc/modules/nmap/python/src/run.py +++ b/test_orc/modules/nmap/python/src/run.py @@ -20,8 +20,8 @@ from nmap_module import NmapModule -LOGGER = logger.get_logger('test_module') - +LOG_NAME = "nmap_runner" +LOGGER = logger.get_logger(LOG_NAME) class NmapModuleRunner: """Run the NMAP module tests.""" @@ -32,12 +32,19 @@ def __init__(self, module): signal.signal(signal.SIGTERM, self._handler) signal.signal(signal.SIGABRT, self._handler) signal.signal(signal.SIGQUIT, self._handler) + self.add_logger(module) - LOGGER.info('Starting nmap Module') + LOGGER.info('Starting nmap module') self._test_module = NmapModule(module) self._test_module.run_tests() + LOGGER.info("nmap test module finished") + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + def _handler(self, signum): LOGGER.debug('SigtermEnum: ' + str(signal.SIGTERM)) LOGGER.debug('Exit signal received: ' + str(signum)) diff --git a/test_orc/python/src/test_orchestrator.py b/test_orc/python/src/test_orchestrator.py index b8b7a3af2..9f0f100ab 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/test_orc/python/src/test_orchestrator.py @@ -22,10 +22,11 @@ from docker.types import Mount import logger from module import TestModule +import util LOG_NAME = "test_orc" LOGGER = logger.get_logger("test_orc") -RUNTIME_DIR = "runtime" +RUNTIME_DIR = "runtime/test" TEST_MODULES_DIR = "modules" MODULE_CONFIG = "conf/module_config.json" @@ -47,10 +48,15 @@ def __init__(self, net_orc): shutil.rmtree(os.path.join(self._root_path, RUNTIME_DIR), ignore_errors=True) - os.makedirs(os.path.join(self._root_path, RUNTIME_DIR), exist_ok=True) def start(self): LOGGER.debug("Starting test orchestrator") + + # Setup the output directory + self._host_user = self._get_host_user() + os.makedirs(RUNTIME_DIR, exist_ok=True) + util.run_command(f'chown -R {self._host_user}:{self._host_user} {RUNTIME_DIR}') + self._load_test_modules() self.build_test_modules() @@ -101,6 +107,7 @@ def _generate_results(self, device): "runtime/test/" + device.mac_addr.replace(":", "") + "/results.json") with open(out_file, "w", encoding="utf-8") as f: json.dump(results, f, indent=2) + util.run_command(f'chown -R {self._host_user}:{self._host_user} {out_file}') return results def test_in_progress(self): @@ -136,11 +143,12 @@ def _run_test_module(self, module, device): device_startup_capture = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/startup.pcap") + util.run_command(f'chown -R {self._host_user}:{self._host_user} {device_startup_capture}') device_monitor_capture = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/monitor.pcap") - + util.run_command(f'chown -R {self._host_user}:{self._host_user} {device_monitor_capture}') client = docker.from_env() @@ -170,7 +178,7 @@ def _run_test_module(self, module, device): read_only=True), ], environment={ - "HOST_USER": self._get_host_user(), + "HOST_USER": self._host_user, "DEVICE_MAC": device.mac_addr, "DEVICE_TEST_MODULES": device.test_modules, "IPV4_SUBNET": self._net_orc.network_config.ipv4_network, From f6e4e93c5263fc66d578ff11dbb197ca278fa72d Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Mon, 12 Jun 2023 05:20:42 -0700 Subject: [PATCH 033/400] Add connection single ip test (#47) --- test_orc/modules/conn/conf/module_config.json | 10 +-- test_orc/modules/conn/conn.Dockerfile | 6 ++ test_orc/modules/conn/python/requirements.txt | 1 + .../conn/python/src/connection_module.py | 63 +++++++++++++++---- 4 files changed, 62 insertions(+), 18 deletions(-) create mode 100644 test_orc/modules/conn/python/requirements.txt diff --git a/test_orc/modules/conn/conf/module_config.json b/test_orc/modules/conn/conf/module_config.json index 25145980e..0f599c5d3 100644 --- a/test_orc/modules/conn/conf/module_config.json +++ b/test_orc/modules/conn/conf/module_config.json @@ -22,15 +22,15 @@ "description": "The device under test hs a MAC address prefix that is registered against a known manufacturer.", "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database." }, + { + "name": "connection.single_ip", + "description": "The network switch port connected to the device reports only one IP address for the device under test.", + "expected_behavior": "The device under test does not behave as a network switch and only requets one IP address. This test is to avoid that devices implement network switches that allow connecting strings of daisy chained devices to one single network port, as this would not make 802.1x port based authentication possible." + }, { "name": "connection.target_ping", "description": "The device under test responds to an ICMP echo (ping) request.", "expected_behavior": "The device under test responds to an ICMP echo (ping) request." - }, - { - "name": "connection.mac_oui", - "description": "The device under test hs a MAC address prefix that is registered against a known manufacturer.", - "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database." } ] } diff --git a/test_orc/modules/conn/conn.Dockerfile b/test_orc/modules/conn/conn.Dockerfile index 10130933d..cf25d0f02 100644 --- a/test_orc/modules/conn/conn.Dockerfile +++ b/test_orc/modules/conn/conn.Dockerfile @@ -7,6 +7,12 @@ RUN apt-get install -y wget #Update the oui.txt file from ieee RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ +#Load the requirements file +COPY modules/conn/python/requirements.txt /testrun/python + +#Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt + # Copy over all configuration files COPY modules/conn/conf /testrun/conf diff --git a/test_orc/modules/conn/python/requirements.txt b/test_orc/modules/conn/python/requirements.txt new file mode 100644 index 000000000..93b351f44 --- /dev/null +++ b/test_orc/modules/conn/python/requirements.txt @@ -0,0 +1 @@ +scapy \ No newline at end of file diff --git a/test_orc/modules/conn/python/src/connection_module.py b/test_orc/modules/conn/python/src/connection_module.py index 48d134584..196c335d8 100644 --- a/test_orc/modules/conn/python/src/connection_module.py +++ b/test_orc/modules/conn/python/src/connection_module.py @@ -15,11 +15,15 @@ """Connection test module""" import util import sys +from scapy.all import * from test_module import TestModule LOG_NAME = "test_connection" LOGGER = None OUI_FILE="/usr/local/etc/oui.txt" +DHCP_SERVER_CAPTURE_FILE = '/runtime/network/dhcp-1.pcap' +STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' +MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' class ConnectionModule(TestModule): @@ -30,19 +34,6 @@ def __init__(self, module): global LOGGER LOGGER = self._get_logger() - def _connection_target_ping(self): - LOGGER.info("Running connection.target_ping") - - # If the ipv4 address wasn't resolved yet, try again - if self._device_ipv4_addr is None: - self._device_ipv4_addr = self._get_device_ipv4(self) - - if self._device_ipv4_addr is None: - LOGGER.error("No device IP could be resolved") - sys.exit(1) - else: - return self._ping(self._device_ipv4_addr) - def _connection_mac_address(self): LOGGER.info("Running connection.mac_address") if self._device_mac is not None: @@ -62,6 +53,52 @@ def _connection_mac_oui(self): LOGGER.info("No OUI Manufacturer found for: " + self._device_mac) return False, "No OUI Manufacturer found for: " + self._device_mac + def _connection_single_ip(self): + LOGGER.info("Running connection.single_ip") + + result = None + if self._device_mac is None: + LOGGER.info("No MAC address found: ") + return result, "No MAC address found." + + # Read all the pcap files containing DHCP packet information + packets = rdpcap(DHCP_SERVER_CAPTURE_FILE) + packets.append(rdpcap(STARTUP_CAPTURE_FILE)) + packets.append(rdpcap(MONITOR_CAPTURE_FILE)) + + # Extract MAC addresses from DHCP packets + mac_addresses = set() + LOGGER.info("Inspecting: " + str(len(packets)) + " packets") + for packet in packets: + # Option[1] = message-type, option 3 = DHCPREQUEST + if DHCP in packet and packet[DHCP].options[0][1] == 3: + mac_address = packet[Ether].src + mac_addresses.add(mac_address.upper()) + + # Check if the device mac address is in the list of DHCPREQUESTs + result = self._device_mac.upper() in mac_addresses + LOGGER.info("DHCPREQUEST detected from device: " + str(result)) + + # Check the unique MAC addresses to see if they match the device + for mac_address in mac_addresses: + LOGGER.info("DHCPREQUEST from MAC address: " + mac_address) + result &= self._device_mac.upper() == mac_address + return result + + + def _connection_target_ping(self): + LOGGER.info("Running connection.target_ping") + + # If the ipv4 address wasn't resolved yet, try again + if self._device_ipv4_addr is None: + self._device_ipv4_addr = self._get_device_ipv4(self) + + if self._device_ipv4_addr is None: + LOGGER.error("No device IP could be resolved") + sys.exit(1) + else: + return self._ping(self._device_ipv4_addr) + def _get_oui_manufacturer(self,mac_address): # Do some quick fixes on the format of the mac_address # to match the oui file pattern From bca0db853ee1f83767663cb586b3e60ba91c6dcd Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 15 Jun 2023 08:35:32 -0700 Subject: [PATCH 034/400] Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range --- test_orc/modules/nmap/nmap.Dockerfile | 6 + test_orc/modules/nmap/python/requirements.txt | 1 + .../modules/nmap/python/src/nmap_module.py | 126 +++++++++++------- 3 files changed, 82 insertions(+), 51 deletions(-) create mode 100644 test_orc/modules/nmap/python/requirements.txt diff --git a/test_orc/modules/nmap/nmap.Dockerfile b/test_orc/modules/nmap/nmap.Dockerfile index 12f23dde7..3a8728d9f 100644 --- a/test_orc/modules/nmap/nmap.Dockerfile +++ b/test_orc/modules/nmap/nmap.Dockerfile @@ -1,6 +1,12 @@ # Image name: test-run/baseline-test FROM test-run/base-test:latest +#Load the requirements file +COPY modules/nmap/python/requirements.txt /testrun/python + +#Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt + # Copy over all configuration files COPY modules/nmap/conf /testrun/conf diff --git a/test_orc/modules/nmap/python/requirements.txt b/test_orc/modules/nmap/python/requirements.txt new file mode 100644 index 000000000..42669b12c --- /dev/null +++ b/test_orc/modules/nmap/python/requirements.txt @@ -0,0 +1 @@ +xmltodict \ No newline at end of file diff --git a/test_orc/modules/nmap/python/src/nmap_module.py b/test_orc/modules/nmap/python/src/nmap_module.py index 6b5477489..ea013f413 100644 --- a/test_orc/modules/nmap/python/src/nmap_module.py +++ b/test_orc/modules/nmap/python/src/nmap_module.py @@ -17,6 +17,8 @@ import util import json import threading +import xmltodict +import re from test_module import TestModule LOG_NAME = "test_nmap" @@ -35,6 +37,7 @@ def __init__(self, module): global LOGGER LOGGER = self._get_logger() + def _security_nmap_ports(self, config): LOGGER.info("Running security.nmap.ports test") @@ -88,7 +91,7 @@ def _process_port_results(self, tests): self._check_unknown_ports(tests=tests,scan_results=scan_results) for test in tests: - LOGGER.info("Checking results for test: " + str(test)) + LOGGER.info("Checking scan results for test: " + str(test)) self._check_scan_results(test_config=tests[test],scan_results=scan_results) def _check_unknown_ports(self,tests,scan_results): @@ -122,8 +125,16 @@ def _add_unknown_ports(self,tests,unallowed_port): port_style = 'tcp_ports' elif unallowed_port['tcp_udp'] == 'udp': port_style = 'udp_ports' + + LOGGER.info("Unknown Port Service: " + unallowed_port['service']) for test in tests: - if unallowed_port['service'] in test: + LOGGER.debug("Checking for known service: " + test) + # Create a regular expression pattern to match the variable at the + # end of the string + port_service = r"\b" + re.escape(unallowed_port['service']) + r"\b$" + service_match = re.search(port_service, test) + if service_match: + LOGGER.info("Service Matched: " + test) known_service=True for test_port in tests[test][port_style]: if "version" in tests[test][port_style][test_port]: @@ -134,8 +145,8 @@ def _add_unknown_ports(self,tests,unallowed_port): if tests[test][port_style][test_port]['allowed']: result['allowed'] = True break - tests[test][port_style][unallowed_port['port']]=result + break if not known_service: service_name = "security.services.unknown." + str(unallowed_port['port']) @@ -195,14 +206,19 @@ def _check_unallowed_port(self,unallowed_ports,tests): for port in unallowed_ports: LOGGER.info('Checking unallowed port: ' + port['port']) LOGGER.info('Looking for service: ' + port['service']) - LOGGER.info('Unallowed Port Config: ' + str(port)) + LOGGER.debug('Unallowed Port Config: ' + str(port)) if port['tcp_udp'] == 'tcp': port_style = 'tcp_ports' elif port['tcp_udp'] == 'udp': port_style = 'udp_ports' for test in tests: - LOGGER.info('Checking test: ' + str(test)) - if port['service'] in test: + LOGGER.debug('Checking test: ' + str(test)) + # Create a regular expression pattern to match the variable at the + # end of the string + port_service = r"\b" + re.escape(port['service']) + r"\b$" + service_match = re.search(port_service, test) + if service_match: + LOGGER.info("Service Matched: " + test) service_config = tests[test] service = port['service'] for service_port in service_config[port_style]: @@ -247,7 +263,7 @@ def _check_version(self,service,version_detected,version_expected): def _scan_scripts(self, tests): scan_results = {} - LOGGER.info("Checing for scan scripts") + LOGGER.info("Checking for scan scripts") for test in tests: test_config = tests[test] if "tcp_ports" in test_config: @@ -256,14 +272,15 @@ def _scan_scripts(self, tests): if "service_scan" in port_config: LOGGER.info("Service Scan Detected for: " + str(port)) svc = port_config["service_scan"] - scan_results.update(self._scan_tcp_with_script(svc["script"])) + result = self._scan_tcp_with_script(svc["script"]) + scan_results.update(result) if "udp_ports" in test_config: for port in test_config["udp_ports"]: if "service_scan" in port: LOGGER.info("Service Scan Detected for: " + str(port)) svc = port["service_scan"] - self._scan_udp_with_script(svc["script"], port) - scan_results.update(self._scan_tcp_with_script(svc["script"])) + result = self._scan_udp_with_script(svc["script"], port) + scan_results.update(result) self._script_scan_results = scan_results def _scan_tcp_with_script(self, script_name, ports=None): @@ -275,12 +292,12 @@ def _scan_tcp_with_script(self, script_name, ports=None): else: port_options += " -p" + ports + " " results_file = f"/runtime/output/{self._module_name}-script_name.log" - nmap_options = scan_options + port_options + " -oG " + results_file + nmap_options = scan_options + port_options + " " + results_file + " -oX -" nmap_results = util.run_command("nmap " + nmap_options + " " + self._device_ipv4_addr)[0] LOGGER.info("Nmap TCP script scan complete") - LOGGER.info("nmap script results\n" + str(nmap_results)) - return self._process_nmap_results(nmap_results=nmap_results) + nmap_results_json = self._nmap_results_to_json(nmap_results) + return self._process_nmap_json_results(nmap_results_json=nmap_results_json) def _scan_udp_with_script(self, script_name, ports=None): LOGGER.info("Running UDP nmap scan with script " + script_name) @@ -290,22 +307,24 @@ def _scan_udp_with_script(self, script_name, ports=None): port_options += " -p- " else: port_options += " -p" + ports + " " - nmap_options = scan_options + port_options + nmap_options = scan_options + port_options + " -oX - " nmap_results = util.run_command("nmap " + nmap_options + self._device_ipv4_addr)[0] LOGGER.info("Nmap UDP script scan complete") - return self._process_nmap_results(nmap_results=nmap_results) + nmap_results_json = self._nmap_results_to_json(nmap_results) + return self._process_nmap_json_results(nmap_results_json=nmap_results_json) def _scan_tcp_ports(self, tests): - max_port = 1000 + max_port = 65535 LOGGER.info("Running nmap TCP port scan") nmap_results = util.run_command( f"""nmap --open -sT -sV -Pn -v -p 1-{max_port} - --version-intensity 7 -T4 {self._device_ipv4_addr}""")[0] + --version-intensity 7 -T4 -oX - {self._device_ipv4_addr}""")[0] LOGGER.info("TCP port scan complete") - self._scan_tcp_results = self._process_nmap_results( - nmap_results=nmap_results) + nmap_results_json = self._nmap_results_to_json(nmap_results) + self._scan_tcp_results = self._process_nmap_json_results( + nmap_results_json=nmap_results_json) def _scan_udp_ports(self, tests): ports = [] @@ -319,39 +338,44 @@ def _scan_udp_ports(self, tests): LOGGER.info("Running nmap UDP port scan") LOGGER.info("UDP ports: " + str(port_list)) nmap_results = util.run_command( - f"nmap -sU -sV -p {port_list} {self._device_ipv4_addr}")[0] + f"nmap -sU -sV -p {port_list} -oX - {self._device_ipv4_addr}")[0] LOGGER.info("UDP port scan complete") - self._scan_udp_results = self._process_nmap_results( - nmap_results=nmap_results) + nmap_results_json = self._nmap_results_to_json(nmap_results) + self._scan_udp_results = self._process_nmap_json_results( + nmap_results_json=nmap_results_json) - def _process_nmap_results(self, nmap_results): + def _nmap_results_to_json(self,nmap_results): + try: + xml_data = xmltodict.parse(nmap_results) + json_data = json.dumps(xml_data, indent=4) + return json.loads(json_data) + + except Exception as e: + LOGGER.error(f"Error parsing Nmap output: {e}") + + def _process_nmap_json_results(self,nmap_results_json): + LOGGER.debug("nmap results\n" + json.dumps(nmap_results_json,indent=2)) results = {} - LOGGER.info("nmap results\n" + str(nmap_results)) - if nmap_results: - if "Service Info" in nmap_results and "MAC Address" not in nmap_results: - rows = nmap_results.split("PORT")[1].split("Service Info")[0].split( - "\n") - elif "PORT" in nmap_results: - rows = nmap_results.split("PORT")[1].split("MAC Address")[0].split("\n") - if rows: - for result in rows[1:-1]: # Iterate skipping the header and tail rows - cols = result.split() - port = cols[0].split("/")[0] - # If results do not start with a a port number, - # it is likely a bleed over from previous result so - # we need to ignore it - if port.isdigit(): - version = "" - if len(cols) > 3: - # recombine full version information that may contain spaces - version = " ".join(cols[3:]) - port_result = { - cols[0].split("/")[0]: { - "tcp_udp":cols[0].split("/")[1], - "state": cols[1], - "service": cols[2], - "version": version - } - } - results.update(port_result) + if "ports" in nmap_results_json["nmaprun"]["host"]: + ports = nmap_results_json["nmaprun"]["host"]["ports"] + # Checking if an object is a JSON object + if isinstance(ports["port"], dict): + results.update(self._json_port_to_dict(ports["port"])) + elif isinstance(ports["port"], list): + for port in ports["port"]: + results.update(self._json_port_to_dict(port)) return results + + def _json_port_to_dict(self,port_json): + port_result = {} + port = {} + port["tcp_udp"] = port_json["@protocol"] + port["state"] = port_json["state"]["@state"] + port["service"] = port_json["service"]["@name"] + port["version"] = "" + if "@version" in port_json["service"]: + port["version"] += port_json["service"]["@version"] + if "@extrainfo" in port_json["service"]: + port["version"] += " " + port_json["service"]["@extrainfo"] + port_result = {port_json["@portid"]:port} + return port_result \ No newline at end of file From 5b56a793502f4fd71700f2562ccacd98d6c6458a Mon Sep 17 00:00:00 2001 From: J Boddey Date: Thu, 15 Jun 2023 17:50:42 +0100 Subject: [PATCH 035/400] Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot --- .gitignore | 3 +- cmd/install | 4 - cmd/start | 4 +- framework/{ => python/src/common}/logger.py | 123 ++++++++-------- .../python/src/common}/util.py | 110 +++++++-------- framework/{ => python/src/core}/device.py | 2 +- .../{ => python/src/core}/test_runner.py | 2 +- framework/{ => python/src/core}/testrun.py | 24 ++-- .../python/src/net_orc}/listener.py | 4 +- .../python/src/net_orc}/network_device.py | 0 .../python/src/net_orc}/network_event.py | 0 .../src/net_orc}/network_orchestrator.py | 36 +++-- .../python/src/net_orc}/network_validator.py | 29 ++-- .../python/src/net_orc}/ovs_control.py | 10 +- .../python/src/test_orc}/module.py | 0 .../python/src/test_orc}/runner.py | 0 .../python/src/test_orc}/test_orchestrator.py | 30 ++-- framework/requirements.txt | 9 +- .../devices/faux-dev/bin/get_default_gateway | 0 .../devices/faux-dev/bin/start_dhcp_client | 0 .../faux-dev/bin/start_network_service | 2 +- .../devices/faux-dev/conf/module_config.json | 0 .../devices/faux-dev/faux-dev.Dockerfile | 11 +- .../devices/faux-dev/python/src/dhcp_check.py | 0 .../devices/faux-dev/python/src/dns_check.py | 0 .../faux-dev/python/src/gateway_check.py | 0 .../devices/faux-dev/python/src/logger.py | 0 .../devices/faux-dev/python/src/ntp_check.py | 0 .../devices/faux-dev/python/src/run.py | 0 .../devices/faux-dev/python/src/util.py | 0 .../network}/base/base.Dockerfile | 9 +- .../network}/base/bin/capture | 2 +- .../network}/base/bin/setup_binaries | 0 .../network}/base/bin/start_grpc | 0 .../network}/base/bin/start_module | 0 .../network}/base/bin/start_network_service | 0 .../network}/base/bin/wait_for_interface | 0 .../network}/base/conf/module_config.json | 0 .../network}/base/python/requirements.txt | 0 .../base/python/src/grpc/start_server.py | 0 .../network}/base/python/src/logger.py | 0 .../network}/dhcp-1/bin/start_network_service | 4 +- .../network}/dhcp-1/conf/dhcpd.conf | 0 .../network}/dhcp-1/conf/module_config.json | 0 .../network}/dhcp-1/conf/radvd.conf | 0 .../network/dhcp-1/dhcp-1.Dockerfile | 9 +- .../dhcp-1/python/src/grpc/__init__.py | 0 .../dhcp-1/python/src/grpc/dhcp_config.py | 0 .../dhcp-1/python/src/grpc/network_service.py | 0 .../dhcp-1/python/src/grpc/proto/grpc.proto | 0 .../network}/dhcp-2/bin/start_network_service | 4 +- .../network}/dhcp-2/conf/dhcpd.conf | 0 .../network}/dhcp-2/conf/module_config.json | 0 .../network}/dhcp-2/conf/radvd.conf | 0 .../network/dhcp-2/dhcp-2.Dockerfile | 12 +- .../dhcp-2/python/src/grpc/__init__.py | 0 .../dhcp-2/python/src/grpc/dhcp_config.py | 0 .../dhcp-2/python/src/grpc/network_service.py | 0 .../dhcp-2/python/src/grpc/proto/grpc.proto | 0 .../network}/dns/bin/start_network_service | 0 .../network}/dns/conf/dnsmasq.conf | 0 .../network}/dns/conf/module_config.json | 0 .../network}/dns/dns.Dockerfile | 7 +- .../gateway/bin/start_network_service | 0 .../network}/gateway/conf/module_config.json | 0 .../network}/gateway/gateway.Dockerfile | 7 +- .../network}/ntp/bin/start_network_service | 2 +- .../network}/ntp/conf/module_config.json | 0 modules/network/ntp/ntp.Dockerfile | 16 +++ .../network}/ntp/python/src/ntp_server.py | 0 .../network}/radius/bin/start_network_service | 2 +- .../network}/radius/conf/ca.crt | 0 .../network}/radius/conf/eap | 0 .../network}/radius/conf/module_config.json | 0 .../network}/radius/python/requirements.txt | 0 .../radius/python/src/authenticator.py | 0 .../network}/radius/radius.Dockerfile | 9 +- .../template/bin/start_network_service | 0 .../network}/template/conf/module_config.json | 1 + .../template/python/src/template_main.py | 0 modules/network/template/template.Dockerfile | 14 ++ .../test}/base/base.Dockerfile | 9 +- .../modules => modules/test}/base/bin/capture | 2 +- .../test}/base/bin/get_ipv4_addr | 0 .../test}/base/bin/setup_binaries | 0 .../test}/base/bin/start_grpc | 0 .../test}/base/bin/start_module | 2 +- .../test}/base/bin/wait_for_interface | 0 .../test}/base/conf/module_config.json | 0 .../test}/base/python/requirements.txt | 0 .../base/python/src/grpc/start_server.py | 0 .../test}/base/python/src/logger.py | 0 .../test}/base/python/src/test_module.py | 0 .../test}/base/python/src/util.py | 0 modules/test/baseline/baseline.Dockerfile | 14 ++ .../test}/baseline/bin/start_test_module | 4 +- .../test}/baseline/conf/module_config.json | 0 .../baseline/python/src/baseline_module.py | 0 .../test}/baseline/python/src/run.py | 0 .../test}/conn/bin/start_test_module | 4 +- .../test}/conn/conf/module_config.json | 0 .../test}/conn/conn.Dockerfile | 13 +- .../test}/conn/python/requirements.txt | 0 .../conn/python/src/connection_module.py | 0 .../test}/conn/python/src/run.py | 0 .../test}/dns/bin/start_test_module | 4 +- .../test}/dns/conf/module_config.json | 0 modules/test/dns/dns.Dockerfile | 14 ++ .../test}/dns/python/src/dns_module.py | 0 .../test}/dns/python/src/run.py | 0 .../test}/nmap/bin/start_test_module | 4 +- .../test}/nmap/conf/module_config.json | 0 modules/test/nmap/nmap.Dockerfile | 20 +++ .../test}/nmap/python/requirements.txt | 0 .../test}/nmap/python/src/nmap_module.py | 0 .../test}/nmap/python/src/run.py | 0 net_orc/.gitignore | 133 ------------------ net_orc/network/modules/ntp/ntp.Dockerfile | 13 -- .../modules/template/template.Dockerfile | 11 -- net_orc/orchestrator.Dockerfile | 22 --- net_orc/python/requirements.txt | 4 - test_orc/modules/baseline/baseline.Dockerfile | 11 -- test_orc/modules/dns/dns.Dockerfile | 11 -- test_orc/modules/nmap/nmap.Dockerfile | 17 --- test_orc/python/requirements.txt | 0 testing/test_baseline | 5 +- 126 files changed, 357 insertions(+), 461 deletions(-) rename framework/{ => python/src/common}/logger.py (57%) rename {net_orc/python/src => framework/python/src/common}/util.py (95%) rename framework/{ => python/src/core}/device.py (91%) rename framework/{ => python/src/core}/test_runner.py (96%) rename framework/{ => python/src/core}/testrun.py (85%) rename {net_orc/python/src => framework/python/src/net_orc}/listener.py (97%) rename {net_orc/python/src => framework/python/src/net_orc}/network_device.py (100%) rename {net_orc/python/src => framework/python/src/net_orc}/network_event.py (100%) rename {net_orc/python/src => framework/python/src/net_orc}/network_orchestrator.py (94%) rename {net_orc/python/src => framework/python/src/net_orc}/network_validator.py (91%) rename {net_orc/python/src => framework/python/src/net_orc}/ovs_control.py (95%) rename {test_orc/python/src => framework/python/src/test_orc}/module.py (100%) rename {test_orc/python/src => framework/python/src/test_orc}/runner.py (100%) rename {test_orc/python/src => framework/python/src/test_orc}/test_orchestrator.py (91%) rename {net_orc/network => modules}/devices/faux-dev/bin/get_default_gateway (100%) rename {net_orc/network => modules}/devices/faux-dev/bin/start_dhcp_client (100%) rename {net_orc/network => modules}/devices/faux-dev/bin/start_network_service (91%) rename {net_orc/network => modules}/devices/faux-dev/conf/module_config.json (100%) rename {net_orc/network => modules}/devices/faux-dev/faux-dev.Dockerfile (65%) rename {net_orc/network => modules}/devices/faux-dev/python/src/dhcp_check.py (100%) rename {net_orc/network => modules}/devices/faux-dev/python/src/dns_check.py (100%) rename {net_orc/network => modules}/devices/faux-dev/python/src/gateway_check.py (100%) rename {net_orc/network => modules}/devices/faux-dev/python/src/logger.py (100%) rename {net_orc/network => modules}/devices/faux-dev/python/src/ntp_check.py (100%) rename {net_orc/network => modules}/devices/faux-dev/python/src/run.py (100%) rename {net_orc/network => modules}/devices/faux-dev/python/src/util.py (100%) rename {net_orc/network/modules => modules/network}/base/base.Dockerfile (74%) rename {net_orc/network/modules => modules/network}/base/bin/capture (90%) rename {net_orc/network/modules => modules/network}/base/bin/setup_binaries (100%) rename {net_orc/network/modules => modules/network}/base/bin/start_grpc (100%) rename {net_orc/network/modules => modules/network}/base/bin/start_module (100%) rename {net_orc/network/modules => modules/network}/base/bin/start_network_service (100%) rename {net_orc/network/modules => modules/network}/base/bin/wait_for_interface (100%) rename {net_orc/network/modules => modules/network}/base/conf/module_config.json (100%) rename {net_orc/network/modules => modules/network}/base/python/requirements.txt (100%) rename {net_orc/network/modules => modules/network}/base/python/src/grpc/start_server.py (100%) rename {net_orc/network/modules => modules/network}/base/python/src/logger.py (100%) rename {net_orc/network/modules => modules/network}/dhcp-1/bin/start_network_service (91%) rename {net_orc/network/modules => modules/network}/dhcp-1/conf/dhcpd.conf (100%) rename {net_orc/network/modules => modules/network}/dhcp-1/conf/module_config.json (100%) rename {net_orc/network/modules => modules/network}/dhcp-1/conf/radvd.conf (100%) rename net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile => modules/network/dhcp-1/dhcp-1.Dockerfile (56%) rename {net_orc/network/modules => modules/network}/dhcp-1/python/src/grpc/__init__.py (100%) rename {net_orc/network/modules => modules/network}/dhcp-1/python/src/grpc/dhcp_config.py (100%) rename {net_orc/network/modules => modules/network}/dhcp-1/python/src/grpc/network_service.py (100%) rename {net_orc/network/modules => modules/network}/dhcp-1/python/src/grpc/proto/grpc.proto (100%) rename {net_orc/network/modules => modules/network}/dhcp-2/bin/start_network_service (91%) rename {net_orc/network/modules => modules/network}/dhcp-2/conf/dhcpd.conf (100%) rename {net_orc/network/modules => modules/network}/dhcp-2/conf/module_config.json (100%) rename {net_orc/network/modules => modules/network}/dhcp-2/conf/radvd.conf (100%) rename net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile => modules/network/dhcp-2/dhcp-2.Dockerfile (55%) rename {net_orc/network/modules => modules/network}/dhcp-2/python/src/grpc/__init__.py (100%) rename {net_orc/network/modules => modules/network}/dhcp-2/python/src/grpc/dhcp_config.py (100%) rename {net_orc/network/modules => modules/network}/dhcp-2/python/src/grpc/network_service.py (100%) rename {net_orc/network/modules => modules/network}/dhcp-2/python/src/grpc/proto/grpc.proto (100%) rename {net_orc/network/modules => modules/network}/dns/bin/start_network_service (100%) rename {net_orc/network/modules => modules/network}/dns/conf/dnsmasq.conf (100%) rename {net_orc/network/modules => modules/network}/dns/conf/module_config.json (100%) rename {net_orc/network/modules => modules/network}/dns/dns.Dockerfile (67%) rename {net_orc/network/modules => modules/network}/gateway/bin/start_network_service (100%) rename {net_orc/network/modules => modules/network}/gateway/conf/module_config.json (100%) rename {net_orc/network/modules => modules/network}/gateway/gateway.Dockerfile (59%) rename {net_orc/network/modules => modules/network}/ntp/bin/start_network_service (82%) rename {net_orc/network/modules => modules/network}/ntp/conf/module_config.json (100%) create mode 100644 modules/network/ntp/ntp.Dockerfile rename {net_orc/network/modules => modules/network}/ntp/python/src/ntp_server.py (100%) rename {net_orc/network/modules => modules/network}/radius/bin/start_network_service (89%) rename {net_orc/network/modules => modules/network}/radius/conf/ca.crt (100%) rename {net_orc/network/modules => modules/network}/radius/conf/eap (100%) rename {net_orc/network/modules => modules/network}/radius/conf/module_config.json (100%) rename {net_orc/network/modules => modules/network}/radius/python/requirements.txt (100%) rename {net_orc/network/modules => modules/network}/radius/python/src/authenticator.py (100%) rename {net_orc/network/modules => modules/network}/radius/radius.Dockerfile (74%) rename {net_orc/network/modules => modules/network}/template/bin/start_network_service (100%) rename {net_orc/network/modules => modules/network}/template/conf/module_config.json (91%) rename {net_orc/network/modules => modules/network}/template/python/src/template_main.py (100%) create mode 100644 modules/network/template/template.Dockerfile rename {test_orc/modules => modules/test}/base/base.Dockerfile (74%) rename {test_orc/modules => modules/test}/base/bin/capture (88%) rename {test_orc/modules => modules/test}/base/bin/get_ipv4_addr (100%) rename {test_orc/modules => modules/test}/base/bin/setup_binaries (100%) rename {test_orc/modules => modules/test}/base/bin/start_grpc (100%) rename {test_orc/modules => modules/test}/base/bin/start_module (97%) rename {test_orc/modules => modules/test}/base/bin/wait_for_interface (100%) rename {test_orc/modules => modules/test}/base/conf/module_config.json (100%) rename {test_orc/modules => modules/test}/base/python/requirements.txt (100%) rename {test_orc/modules => modules/test}/base/python/src/grpc/start_server.py (100%) rename {test_orc/modules => modules/test}/base/python/src/logger.py (100%) rename {test_orc/modules => modules/test}/base/python/src/test_module.py (100%) rename {test_orc/modules => modules/test}/base/python/src/util.py (100%) create mode 100644 modules/test/baseline/baseline.Dockerfile rename {test_orc/modules => modules/test}/baseline/bin/start_test_module (90%) rename {test_orc/modules => modules/test}/baseline/conf/module_config.json (100%) rename {test_orc/modules => modules/test}/baseline/python/src/baseline_module.py (100%) rename {test_orc/modules => modules/test}/baseline/python/src/run.py (100%) rename {test_orc/modules => modules/test}/conn/bin/start_test_module (92%) rename {test_orc/modules => modules/test}/conn/conf/module_config.json (100%) rename {test_orc/modules => modules/test}/conn/conn.Dockerfile (59%) rename {test_orc/modules => modules/test}/conn/python/requirements.txt (100%) rename {test_orc/modules => modules/test}/conn/python/src/connection_module.py (100%) rename {test_orc/modules => modules/test}/conn/python/src/run.py (100%) rename {test_orc/modules => modules/test}/dns/bin/start_test_module (90%) rename {test_orc/modules => modules/test}/dns/conf/module_config.json (100%) create mode 100644 modules/test/dns/dns.Dockerfile rename {test_orc/modules => modules/test}/dns/python/src/dns_module.py (100%) rename {test_orc/modules => modules/test}/dns/python/src/run.py (100%) rename {test_orc/modules => modules/test}/nmap/bin/start_test_module (93%) rename {test_orc/modules => modules/test}/nmap/conf/module_config.json (100%) create mode 100644 modules/test/nmap/nmap.Dockerfile rename {test_orc/modules => modules/test}/nmap/python/requirements.txt (100%) rename {test_orc/modules => modules/test}/nmap/python/src/nmap_module.py (100%) rename {test_orc/modules => modules/test}/nmap/python/src/run.py (100%) delete mode 100644 net_orc/.gitignore delete mode 100644 net_orc/network/modules/ntp/ntp.Dockerfile delete mode 100644 net_orc/network/modules/template/template.Dockerfile delete mode 100644 net_orc/orchestrator.Dockerfile delete mode 100644 net_orc/python/requirements.txt delete mode 100644 test_orc/modules/baseline/baseline.Dockerfile delete mode 100644 test_orc/modules/dns/dns.Dockerfile delete mode 100644 test_orc/modules/nmap/nmap.Dockerfile delete mode 100644 test_orc/python/requirements.txt diff --git a/.gitignore b/.gitignore index 5dfc1f6f9..ad8f26d34 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ venv/ error pylint.out local/ -__pycache__/ \ No newline at end of file +__pycache__/ +build/ \ No newline at end of file diff --git a/cmd/install b/cmd/install index 23e463158..37c03e113 100755 --- a/cmd/install +++ b/cmd/install @@ -6,8 +6,4 @@ source venv/bin/activate pip3 install -r framework/requirements.txt -pip3 install -r net_orc/python/requirements.txt - -pip3 install -r test_orc/python/requirements.txt - deactivate diff --git a/cmd/start b/cmd/start index d146f413d..55d2e52eb 100755 --- a/cmd/start +++ b/cmd/start @@ -18,7 +18,9 @@ rm -rf runtime source venv/bin/activate # TODO: Execute python code -python -u framework/test_runner.py $@ +# Set the PYTHONPATH to include the "src" directory +export PYTHONPATH="$PWD/framework/python/src" +python -u framework/python/src/core/test_runner.py $@ # TODO: Work in progress code for containerization of OVS module # asyncRun() { diff --git a/framework/logger.py b/framework/python/src/common/logger.py similarity index 57% rename from framework/logger.py rename to framework/python/src/common/logger.py index cb71c9fdd..539767f53 100644 --- a/framework/logger.py +++ b/framework/python/src/common/logger.py @@ -1,63 +1,60 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Manages stream and file loggers.""" -import json -import logging -import os - -LOGGERS = {} -_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' -_DATE_FORMAT = '%b %02d %H:%M:%S' -_DEFAULT_LOG_LEVEL = logging.INFO -_LOG_LEVEL = logging.INFO -_CONF_DIR = 'conf' -_CONF_FILE_NAME = 'system.json' -_LOG_DIR = 'runtime/testing/' - -# Set log level -with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), - encoding='utf-8') as system_conf_file: - system_conf_json = json.load(system_conf_file) -log_level_str = system_conf_json['log_level'] - -temp_log = logging.getLogger('temp') -try: - temp_log.setLevel(logging.getLevelName(log_level_str)) - _LOG_LEVEL = logging.getLevelName(log_level_str) -except ValueError: - print('Invalid log level set in ' + _CONF_DIR + '/' + _CONF_FILE_NAME + - '. Using INFO as log level') - _LOG_LEVEL = _DEFAULT_LOG_LEVEL - -log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) - -def add_file_handler(log, log_file): - handler = logging.FileHandler(_LOG_DIR + log_file + '.log') - handler.setFormatter(log_format) - log.addHandler(handler) - -def add_stream_handler(log): - handler = logging.StreamHandler() - handler.setFormatter(log_format) - log.addHandler(handler) - -def get_logger(name, log_file=None): - if name not in LOGGERS: - LOGGERS[name] = logging.getLogger(name) - LOGGERS[name].setLevel(_LOG_LEVEL) - add_stream_handler(LOGGERS[name]) - if log_file is not None: - add_file_handler(LOGGERS[name], log_file) - return LOGGERS[name] +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Sets up the logger to be used for the test modules.""" +import json +import logging +import os + +LOGGERS = {} +_LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' +_DATE_FORMAT = '%b %02d %H:%M:%S' +_DEFAULT_LEVEL = logging.INFO +_CONF_DIR = 'conf' +_CONF_FILE_NAME = 'system.json' + +# Set log level +try: + with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), + encoding='UTF-8') as config_json_file: + system_conf_json = json.load(config_json_file) + + log_level_str = system_conf_json['log_level'] + log_level = logging.getLevelName(log_level_str) +except OSError: + # TODO: Print out warning that log level is incorrect or missing + log_level = _DEFAULT_LEVEL + +log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) + +def add_file_handler(log, log_file, log_dir): + handler = logging.FileHandler(log_dir + log_file + '.log') + handler.setFormatter(log_format) + log.addHandler(handler) + + +def add_stream_handler(log): + handler = logging.StreamHandler() + handler.setFormatter(log_format) + log.addHandler(handler) + + +def get_logger(name, log_file=None, log_dir=None): + if name not in LOGGERS: + LOGGERS[name] = logging.getLogger(name) + LOGGERS[name].setLevel(log_level) + add_stream_handler(LOGGERS[name]) + if log_file is not None and log_dir is not None: + add_file_handler(LOGGERS[name], log_file, log_dir) + return LOGGERS[name] diff --git a/net_orc/python/src/util.py b/framework/python/src/common/util.py similarity index 95% rename from net_orc/python/src/util.py rename to framework/python/src/common/util.py index ba9527996..1ffe70651 100644 --- a/net_orc/python/src/util.py +++ b/framework/python/src/common/util.py @@ -1,55 +1,55 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Provides basic utilities for the network orchestrator.""" -import subprocess -import shlex -import logger -import netifaces - -LOGGER = logger.get_logger('util') - - -def run_command(cmd, output=True): - """Runs a process at the os level - By default, returns the standard output and error output - If the caller sets optional output parameter to False, - will only return a boolean result indicating if it was - succesful in running the command. Failure is indicated - by any return code from the process other than zero.""" - - success = False - process = subprocess.Popen(shlex.split(cmd), - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - stdout, stderr = process.communicate() - - if process.returncode != 0 and output: - err_msg = f'{stderr.strip()}. Code: {process.returncode}' - LOGGER.error('Command Failed: ' + cmd) - LOGGER.error('Error: ' + err_msg) - else: - success = True - if output: - return stdout.strip().decode('utf-8'), stderr - else: - return success - - -def interface_exists(interface): - return interface in netifaces.interfaces() - - -def prettify(mac_string): - return ':'.join([f'{ord(b):02x}' for b in mac_string]) +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Provides basic utilities for the network orchestrator.""" +import subprocess +import shlex +from common import logger +import netifaces + +LOGGER = logger.get_logger('util') + + +def run_command(cmd, output=True): + """Runs a process at the os level + By default, returns the standard output and error output + If the caller sets optional output parameter to False, + will only return a boolean result indicating if it was + succesful in running the command. Failure is indicated + by any return code from the process other than zero.""" + + success = False + process = subprocess.Popen(shlex.split(cmd), + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + stdout, stderr = process.communicate() + + if process.returncode != 0 and output: + err_msg = f'{stderr.strip()}. Code: {process.returncode}' + LOGGER.error('Command Failed: ' + cmd) + LOGGER.error('Error: ' + err_msg) + else: + success = True + if output: + return stdout.strip().decode('utf-8'), stderr + else: + return success + + +def interface_exists(interface): + return interface in netifaces.interfaces() + + +def prettify(mac_string): + return ':'.join([f'{ord(b):02x}' for b in mac_string]) diff --git a/framework/device.py b/framework/python/src/core/device.py similarity index 91% rename from framework/device.py rename to framework/python/src/core/device.py index 53263e6a6..44f275bdf 100644 --- a/framework/device.py +++ b/framework/python/src/core/device.py @@ -14,7 +14,7 @@ """Track device object information.""" -from network_device import NetworkDevice +from net_orc.network_device import NetworkDevice from dataclasses import dataclass diff --git a/framework/test_runner.py b/framework/python/src/core/test_runner.py similarity index 96% rename from framework/test_runner.py rename to framework/python/src/core/test_runner.py index 0ee5e8416..226f874cc 100644 --- a/framework/test_runner.py +++ b/framework/python/src/core/test_runner.py @@ -23,7 +23,7 @@ import argparse import sys from testrun import TestRun -import logger +from common import logger import signal LOGGER = logger.get_logger("runner") diff --git a/framework/testrun.py b/framework/python/src/core/testrun.py similarity index 85% rename from framework/testrun.py rename to framework/python/src/core/testrun.py index 25232f90c..e59b7cda2 100644 --- a/framework/testrun.py +++ b/framework/python/src/core/testrun.py @@ -25,25 +25,18 @@ import json import signal import time -import logger +from common import logger # Locate parent directory current_dir = os.path.dirname(os.path.realpath(__file__)) -parent_dir = os.path.dirname(current_dir) -# Add net_orc to Python path -net_orc_dir = os.path.join(parent_dir, 'net_orc', 'python', 'src') -sys.path.append(net_orc_dir) +# Locate the test-run root directory, 4 levels, src->python->framework->test-run +root_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(current_dir)))) -# Add test_orc to Python path -test_orc_dir = os.path.join(parent_dir, 'test_orc', 'python', 'src') -sys.path.append(test_orc_dir) - -from listener import NetworkEvent # pylint: disable=wrong-import-position,import-outside-toplevel -import test_orchestrator as test_orc # pylint: disable=wrong-import-position,import-outside-toplevel -import network_orchestrator as net_orc # pylint: disable=wrong-import-position,import-outside-toplevel - -from device import Device # pylint: disable=wrong-import-position,import-outside-toplevel +from net_orc.listener import NetworkEvent +from test_orc import test_orchestrator as test_orc +from net_orc import network_orchestrator as net_orc +from device import Device LOGGER = logger.get_logger('test_run') CONFIG_FILE = 'conf/system.json' @@ -58,7 +51,6 @@ DEVICE_MAC_ADDR = 'mac_addr' DEVICE_TEST_MODULES = 'test_modules' - class TestRun: # pylint: disable=too-few-public-methods """Test Run controller. @@ -142,7 +134,7 @@ def _exit_handler(self, signum, arg): # pylint: disable=unused-argument def _get_config_abs(self, config_file=None): if config_file is None: # If not defined, use relative pathing to local file - config_file = os.path.join(parent_dir, CONFIG_FILE) + config_file = os.path.join(root_dir, CONFIG_FILE) # Expand the config file to absolute pathing return os.path.abspath(config_file) diff --git a/net_orc/python/src/listener.py b/framework/python/src/net_orc/listener.py similarity index 97% rename from net_orc/python/src/listener.py rename to framework/python/src/net_orc/listener.py index 0bbd2b1c9..4f8e1961f 100644 --- a/net_orc/python/src/listener.py +++ b/framework/python/src/net_orc/listener.py @@ -16,8 +16,8 @@ under test.""" import threading from scapy.all import AsyncSniffer, DHCP, get_if_hwaddr -import logger -from network_event import NetworkEvent +from net_orc.network_event import NetworkEvent +from common import logger LOGGER = logger.get_logger('listener') diff --git a/net_orc/python/src/network_device.py b/framework/python/src/net_orc/network_device.py similarity index 100% rename from net_orc/python/src/network_device.py rename to framework/python/src/net_orc/network_device.py diff --git a/net_orc/python/src/network_event.py b/framework/python/src/net_orc/network_event.py similarity index 100% rename from net_orc/python/src/network_event.py rename to framework/python/src/net_orc/network_event.py diff --git a/net_orc/python/src/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py similarity index 94% rename from net_orc/python/src/network_orchestrator.py rename to framework/python/src/net_orc/network_orchestrator.py index f53b17d15..f1f479742 100644 --- a/net_orc/python/src/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -26,13 +26,14 @@ import threading import docker from docker.types import Mount -import logger -import util -from listener import Listener -from network_device import NetworkDevice -from network_event import NetworkEvent -from network_validator import NetworkValidator -from ovs_control import OVSControl +from collections import OrderedDict +from common import logger +from common import util +from net_orc.listener import Listener +from net_orc.network_device import NetworkDevice +from net_orc.network_event import NetworkEvent +from net_orc.network_validator import NetworkValidator +from net_orc.ovs_control import OVSControl LOGGER = logger.get_logger('net_orc') CONFIG_FILE = 'conf/system.json' @@ -41,7 +42,8 @@ TEST_DIR = 'test' MONITOR_PCAP = 'monitor.pcap' NET_DIR = 'runtime/network' -NETWORK_MODULES_DIR = 'network/modules' +#NETWORK_MODULES_DIR = 'network/modules' +NETWORK_MODULES_DIR = 'modules/network' NETWORK_MODULE_METADATA = 'conf/module_config.json' DEVICE_BRIDGE = 'tr-d' INTERNET_BRIDGE = 'tr-c' @@ -81,8 +83,9 @@ def __init__(self, self.validate = validate self.async_monitor = async_monitor - self._path = os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__)))) + self._path = os.path.dirname(os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) self.validator = NetworkValidator() shutil.rmtree(os.path.join(os.getcwd(), NET_DIR), ignore_errors=True) @@ -182,7 +185,7 @@ def _device_discovered(self, mac_addr): TEST_DIR, device.mac_addr.replace(':', '')) os.makedirs(device_runtime_dir) - util.run_command(f'chown -R {self._host_user}:{self._host_user} {device_runtime_dir}') + util.run_command(f'chown -R {self._host_user} {device_runtime_dir}') packet_capture = sniff(iface=self._dev_intf, timeout=self._startup_timeout, @@ -413,6 +416,11 @@ def _load_network_module(self, module_dir): net_module.enable_container = net_module_json['config']['docker'][ 'enable_container'] + # Determine if this is a template + if 'template' in net_module_json['config']['docker']: + net_module.template = net_module_json['config']['docker'][ + 'template'] + # Load network service networking configuration if net_module.enable_container: @@ -432,13 +440,14 @@ def _load_network_module(self, module_dir): net_module.net_config.ip_index] net_module.net_config.ipv6_network = self.network_config.ipv6_network - self._net_modules.append(net_module) + self._net_modules.append(net_module) return net_module def build_network_modules(self): LOGGER.info('Building network modules...') for net_module in self._net_modules: - self._build_module(net_module) + if not net_module.template: + self._build_module(net_module) def _build_module(self, net_module): LOGGER.debug('Building network module ' + net_module.dir_name) @@ -786,6 +795,7 @@ def __init__(self): self.container = None self.container_name = None self.image_name = None + self.template = False # Absolute path self.dir = None diff --git a/net_orc/python/src/network_validator.py b/framework/python/src/net_orc/network_validator.py similarity index 91% rename from net_orc/python/src/network_validator.py rename to framework/python/src/net_orc/network_validator.py index 832a154e3..4ee46124d 100644 --- a/net_orc/python/src/network_validator.py +++ b/framework/python/src/net_orc/network_validator.py @@ -20,12 +20,12 @@ import docker from docker.types import Mount import getpass -import logger -import util +from common import logger +from common import util LOGGER = logger.get_logger('validator') OUTPUT_DIR = 'runtime/validation' -DEVICES_DIR = 'network/devices' +DEVICES_DIR = 'modules/devices' DEVICE_METADATA = 'conf/module_config.json' DEVICE_BRIDGE = 'tr-d' CONF_DIR = 'conf' @@ -38,8 +38,9 @@ class NetworkValidator: def __init__(self): self._net_devices = [] - self._path = os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__)))) + self._path = os.path.dirname(os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) self._device_dir = os.path.join(self._path, DEVICES_DIR) @@ -48,11 +49,11 @@ def __init__(self): def start(self): """Start the network validator.""" LOGGER.debug('Starting validator') - + # Setup the output directory host_user = self._get_host_user() os.makedirs(OUTPUT_DIR, exist_ok=True) - util.run_command(f'chown -R {host_user}:{host_user} {OUTPUT_DIR}') + util.run_command(f'chown -R {host_user} {OUTPUT_DIR}') self._load_devices() self._build_network_devices() @@ -85,7 +86,7 @@ def _build_device(self, net_device): def _load_devices(self): - LOGGER.info(f'Loading validators from {DEVICES_DIR}') + LOGGER.info(f'Loading validators from {self._device_dir}') loaded_devices = 'Loaded the following validators: ' @@ -175,24 +176,24 @@ def _start_network_device(self, device): def _get_host_user(self): user = self._get_os_user() - + # If primary method failed, try secondary if user is None: user = self._get_user() - LOGGER.debug("Network validator host user: " + user) + LOGGER.debug(f'Network validator host user: {user}') return user def _get_os_user(self): user = None try: user = os.getlogin() - except OSError as e: + except OSError: # Handle the OSError exception - LOGGER.error("An OS error occurred while retrieving the login name.") - except Exception as e: + LOGGER.error('An OS error occurred while retrieving the login name.') + except Exception as error: # Catch any other unexpected exceptions - LOGGER.error("An exception occurred:", e) + LOGGER.error('An exception occurred:', error) return user def _get_user(self): diff --git a/net_orc/python/src/ovs_control.py b/framework/python/src/net_orc/ovs_control.py similarity index 95% rename from net_orc/python/src/ovs_control.py rename to framework/python/src/net_orc/ovs_control.py index ce316dba7..3c950d4af 100644 --- a/net_orc/python/src/ovs_control.py +++ b/framework/python/src/net_orc/ovs_control.py @@ -14,9 +14,9 @@ """OVS Control Module""" import json -import logger -import util import os +from common import logger +from common import util CONFIG_FILE = 'conf/system.json' DEVICE_BRIDGE = 'tr-d' @@ -146,9 +146,9 @@ def delete_bridge(self, bridge_name): return success def _load_config(self): - path = os.path.dirname( - os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__))))) + path = os.path.dirname(os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) config_file = os.path.join(path, CONFIG_FILE) LOGGER.debug('Loading configuration: ' + config_file) with open(config_file, 'r', encoding='utf-8') as conf_file: diff --git a/test_orc/python/src/module.py b/framework/python/src/test_orc/module.py similarity index 100% rename from test_orc/python/src/module.py rename to framework/python/src/test_orc/module.py diff --git a/test_orc/python/src/runner.py b/framework/python/src/test_orc/runner.py similarity index 100% rename from test_orc/python/src/runner.py rename to framework/python/src/test_orc/runner.py diff --git a/test_orc/python/src/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py similarity index 91% rename from test_orc/python/src/test_orchestrator.py rename to framework/python/src/test_orc/test_orchestrator.py index 9f0f100ab..58c1944f8 100644 --- a/test_orc/python/src/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -20,14 +20,14 @@ import shutil import docker from docker.types import Mount -import logger -from module import TestModule -import util +from common import logger +from test_orc.module import TestModule +from common import util LOG_NAME = "test_orc" LOGGER = logger.get_logger("test_orc") RUNTIME_DIR = "runtime/test" -TEST_MODULES_DIR = "modules" +TEST_MODULES_DIR = "modules/test" MODULE_CONFIG = "conf/module_config.json" @@ -40,22 +40,28 @@ def __init__(self, net_orc): self._net_orc = net_orc self._test_in_progress = False - self._path = os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__)))) + self._path = os.path.dirname(os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) # Resolve the path to the test-run folder - self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) + #self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) + + + self._root_path = os.path.dirname(os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) shutil.rmtree(os.path.join(self._root_path, RUNTIME_DIR), ignore_errors=True) def start(self): LOGGER.debug("Starting test orchestrator") - + # Setup the output directory self._host_user = self._get_host_user() os.makedirs(RUNTIME_DIR, exist_ok=True) - util.run_command(f'chown -R {self._host_user}:{self._host_user} {RUNTIME_DIR}') + util.run_command(f'chown -R {self._host_user} {RUNTIME_DIR}') self._load_test_modules() self.build_test_modules() @@ -107,7 +113,7 @@ def _generate_results(self, device): "runtime/test/" + device.mac_addr.replace(":", "") + "/results.json") with open(out_file, "w", encoding="utf-8") as f: json.dump(results, f, indent=2) - util.run_command(f'chown -R {self._host_user}:{self._host_user} {out_file}') + util.run_command(f'chown -R {self._host_user} {out_file}') return results def test_in_progress(self): @@ -143,12 +149,12 @@ def _run_test_module(self, module, device): device_startup_capture = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/startup.pcap") - util.run_command(f'chown -R {self._host_user}:{self._host_user} {device_startup_capture}') + util.run_command(f'chown -R {self._host_user} {device_startup_capture}') device_monitor_capture = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/monitor.pcap") - util.run_command(f'chown -R {self._host_user}:{self._host_user} {device_monitor_capture}') + util.run_command(f'chown -R {self._host_user} {device_monitor_capture}') client = docker.from_env() diff --git a/framework/requirements.txt b/framework/requirements.txt index ca56948f4..03eab9796 100644 --- a/framework/requirements.txt +++ b/framework/requirements.txt @@ -1 +1,8 @@ -requests<2.29.0 \ No newline at end of file +# Requirements for the core module +requests<2.29.0 + +# Requirements for the net_orc module +docker +ipaddress +netifaces +scapy \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/bin/get_default_gateway b/modules/devices/faux-dev/bin/get_default_gateway similarity index 100% rename from net_orc/network/devices/faux-dev/bin/get_default_gateway rename to modules/devices/faux-dev/bin/get_default_gateway diff --git a/net_orc/network/devices/faux-dev/bin/start_dhcp_client b/modules/devices/faux-dev/bin/start_dhcp_client similarity index 100% rename from net_orc/network/devices/faux-dev/bin/start_dhcp_client rename to modules/devices/faux-dev/bin/start_dhcp_client diff --git a/net_orc/network/devices/faux-dev/bin/start_network_service b/modules/devices/faux-dev/bin/start_network_service similarity index 91% rename from net_orc/network/devices/faux-dev/bin/start_network_service rename to modules/devices/faux-dev/bin/start_network_service index 13e2f6baf..80a587684 100644 --- a/net_orc/network/devices/faux-dev/bin/start_network_service +++ b/modules/devices/faux-dev/bin/start_network_service @@ -27,7 +27,7 @@ LOG_FILE=$OUTPUT_DIR/$MODULE_NAME.log RESULT_FILE=$OUTPUT_DIR/result.json touch $LOG_FILE touch $RESULT_FILE -chown -R $HOST_USER:$HOST_USER $OUTPUT_DIR +chown -R $HOST_USER $OUTPUT_DIR # Start dhclient $BIN_DIR/start_dhcp_client $INTF diff --git a/net_orc/network/devices/faux-dev/conf/module_config.json b/modules/devices/faux-dev/conf/module_config.json similarity index 100% rename from net_orc/network/devices/faux-dev/conf/module_config.json rename to modules/devices/faux-dev/conf/module_config.json diff --git a/net_orc/network/devices/faux-dev/faux-dev.Dockerfile b/modules/devices/faux-dev/faux-dev.Dockerfile similarity index 65% rename from net_orc/network/devices/faux-dev/faux-dev.Dockerfile rename to modules/devices/faux-dev/faux-dev.Dockerfile index 1686341b5..0a4f02f38 100644 --- a/net_orc/network/devices/faux-dev/faux-dev.Dockerfile +++ b/modules/devices/faux-dev/faux-dev.Dockerfile @@ -1,6 +1,9 @@ # Image name: test-run/faux-dev FROM test-run/base:latest +ARG MODULE_NAME=faux-dev +ARG MODULE_DIR=modules/devices/$MODULE_NAME + #Update and get all additional requirements not contained in the base image RUN apt-get update --fix-missing @@ -11,10 +14,10 @@ ARG DEBIAN_FRONTEND=noninteractive RUN apt-get install -y isc-dhcp-client ntp ntpdate # Copy over all configuration files -COPY network/devices/faux-dev/conf /testrun/conf +COPY $MODULE_DIR/conf /testrun/conf -# Load device binary files -COPY network/devices/faux-dev/bin /testrun/bin +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin # Copy over all python files -COPY network/devices/faux-dev/python /testrun/python \ No newline at end of file +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/net_orc/network/devices/faux-dev/python/src/dhcp_check.py b/modules/devices/faux-dev/python/src/dhcp_check.py similarity index 100% rename from net_orc/network/devices/faux-dev/python/src/dhcp_check.py rename to modules/devices/faux-dev/python/src/dhcp_check.py diff --git a/net_orc/network/devices/faux-dev/python/src/dns_check.py b/modules/devices/faux-dev/python/src/dns_check.py similarity index 100% rename from net_orc/network/devices/faux-dev/python/src/dns_check.py rename to modules/devices/faux-dev/python/src/dns_check.py diff --git a/net_orc/network/devices/faux-dev/python/src/gateway_check.py b/modules/devices/faux-dev/python/src/gateway_check.py similarity index 100% rename from net_orc/network/devices/faux-dev/python/src/gateway_check.py rename to modules/devices/faux-dev/python/src/gateway_check.py diff --git a/net_orc/network/devices/faux-dev/python/src/logger.py b/modules/devices/faux-dev/python/src/logger.py similarity index 100% rename from net_orc/network/devices/faux-dev/python/src/logger.py rename to modules/devices/faux-dev/python/src/logger.py diff --git a/net_orc/network/devices/faux-dev/python/src/ntp_check.py b/modules/devices/faux-dev/python/src/ntp_check.py similarity index 100% rename from net_orc/network/devices/faux-dev/python/src/ntp_check.py rename to modules/devices/faux-dev/python/src/ntp_check.py diff --git a/net_orc/network/devices/faux-dev/python/src/run.py b/modules/devices/faux-dev/python/src/run.py similarity index 100% rename from net_orc/network/devices/faux-dev/python/src/run.py rename to modules/devices/faux-dev/python/src/run.py diff --git a/net_orc/network/devices/faux-dev/python/src/util.py b/modules/devices/faux-dev/python/src/util.py similarity index 100% rename from net_orc/network/devices/faux-dev/python/src/util.py rename to modules/devices/faux-dev/python/src/util.py diff --git a/net_orc/network/modules/base/base.Dockerfile b/modules/network/base/base.Dockerfile similarity index 74% rename from net_orc/network/modules/base/base.Dockerfile rename to modules/network/base/base.Dockerfile index 2400fd1c6..d14713c59 100644 --- a/net_orc/network/modules/base/base.Dockerfile +++ b/modules/network/base/base.Dockerfile @@ -1,17 +1,20 @@ # Image name: test-run/base FROM ubuntu:jammy +ARG MODULE_NAME=base +ARG MODULE_DIR=modules/network/$MODULE_NAME + # Install common software RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix -#Setup the base python requirements -COPY network/modules/base/python /testrun/python +# Setup the base python requirements +COPY $MODULE_DIR/python /testrun/python # Install all python requirements for the module RUN pip3 install -r /testrun/python/requirements.txt # Add the bin files -COPY network/modules/base/bin /testrun/bin +COPY $MODULE_DIR/bin /testrun/bin # Remove incorrect line endings RUN dos2unix /testrun/bin/* diff --git a/net_orc/network/modules/base/bin/capture b/modules/network/base/bin/capture similarity index 90% rename from net_orc/network/modules/base/bin/capture rename to modules/network/base/bin/capture index 8a8430feb..bc6c425e5 100644 --- a/net_orc/network/modules/base/bin/capture +++ b/modules/network/base/bin/capture @@ -23,7 +23,7 @@ fi # Create the output directory and start the capture mkdir -p $PCAP_DIR -chown $HOST_USER:$HOST_USER $PCAP_DIR +chown $HOST_USER $PCAP_DIR tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & #Small pause to let the capture to start diff --git a/net_orc/network/modules/base/bin/setup_binaries b/modules/network/base/bin/setup_binaries similarity index 100% rename from net_orc/network/modules/base/bin/setup_binaries rename to modules/network/base/bin/setup_binaries diff --git a/net_orc/network/modules/base/bin/start_grpc b/modules/network/base/bin/start_grpc similarity index 100% rename from net_orc/network/modules/base/bin/start_grpc rename to modules/network/base/bin/start_grpc diff --git a/net_orc/network/modules/base/bin/start_module b/modules/network/base/bin/start_module similarity index 100% rename from net_orc/network/modules/base/bin/start_module rename to modules/network/base/bin/start_module diff --git a/net_orc/network/modules/base/bin/start_network_service b/modules/network/base/bin/start_network_service similarity index 100% rename from net_orc/network/modules/base/bin/start_network_service rename to modules/network/base/bin/start_network_service diff --git a/net_orc/network/modules/base/bin/wait_for_interface b/modules/network/base/bin/wait_for_interface similarity index 100% rename from net_orc/network/modules/base/bin/wait_for_interface rename to modules/network/base/bin/wait_for_interface diff --git a/net_orc/network/modules/base/conf/module_config.json b/modules/network/base/conf/module_config.json similarity index 100% rename from net_orc/network/modules/base/conf/module_config.json rename to modules/network/base/conf/module_config.json diff --git a/net_orc/network/modules/base/python/requirements.txt b/modules/network/base/python/requirements.txt similarity index 100% rename from net_orc/network/modules/base/python/requirements.txt rename to modules/network/base/python/requirements.txt diff --git a/net_orc/network/modules/base/python/src/grpc/start_server.py b/modules/network/base/python/src/grpc/start_server.py similarity index 100% rename from net_orc/network/modules/base/python/src/grpc/start_server.py rename to modules/network/base/python/src/grpc/start_server.py diff --git a/net_orc/network/modules/base/python/src/logger.py b/modules/network/base/python/src/logger.py similarity index 100% rename from net_orc/network/modules/base/python/src/logger.py rename to modules/network/base/python/src/logger.py diff --git a/net_orc/network/modules/dhcp-1/bin/start_network_service b/modules/network/dhcp-1/bin/start_network_service similarity index 91% rename from net_orc/network/modules/dhcp-1/bin/start_network_service rename to modules/network/dhcp-1/bin/start_network_service index e8e0ad06c..a60806684 100644 --- a/net_orc/network/modules/dhcp-1/bin/start_network_service +++ b/modules/network/dhcp-1/bin/start_network_service @@ -21,8 +21,8 @@ mkdir /var/run/radvd #Create and set permissions on the log files touch $DHCP_LOG_FILE touch $RA_LOG_FILE -chown $HOST_USER:$HOST_USER $DHCP_LOG_FILE -chown $HOST_USER:$HOST_USER $RA_LOG_FILE +chown $HOST_USER $DHCP_LOG_FILE +chown $HOST_USER $RA_LOG_FILE #Move the config files to the correct location diff --git a/net_orc/network/modules/dhcp-1/conf/dhcpd.conf b/modules/network/dhcp-1/conf/dhcpd.conf similarity index 100% rename from net_orc/network/modules/dhcp-1/conf/dhcpd.conf rename to modules/network/dhcp-1/conf/dhcpd.conf diff --git a/net_orc/network/modules/dhcp-1/conf/module_config.json b/modules/network/dhcp-1/conf/module_config.json similarity index 100% rename from net_orc/network/modules/dhcp-1/conf/module_config.json rename to modules/network/dhcp-1/conf/module_config.json diff --git a/net_orc/network/modules/dhcp-1/conf/radvd.conf b/modules/network/dhcp-1/conf/radvd.conf similarity index 100% rename from net_orc/network/modules/dhcp-1/conf/radvd.conf rename to modules/network/dhcp-1/conf/radvd.conf diff --git a/net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile b/modules/network/dhcp-1/dhcp-1.Dockerfile similarity index 56% rename from net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile rename to modules/network/dhcp-1/dhcp-1.Dockerfile index 989992570..766f18c57 100644 --- a/net_orc/network/modules/dhcp-2/dhcp-2.Dockerfile +++ b/modules/network/dhcp-1/dhcp-1.Dockerfile @@ -1,14 +1,17 @@ # Image name: test-run/dhcp-primary FROM test-run/base:latest +ARG MODULE_NAME=dhcp-1 +ARG MODULE_DIR=modules/network/$MODULE_NAME + # Install dhcp server RUN apt-get install -y isc-dhcp-server radvd # Copy over all configuration files -COPY network/modules/dhcp-2/conf /testrun/conf +COPY $MODULE_DIR/conf /testrun/conf # Copy over all binary files -COPY network/modules/dhcp-2/bin /testrun/bin +COPY $MODULE_DIR/bin /testrun/bin # Copy over all python files -COPY network/modules/dhcp-2/python /testrun/python +COPY $MODULE_DIR/python /testrun/python diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/__init__.py b/modules/network/dhcp-1/python/src/grpc/__init__.py similarity index 100% rename from net_orc/network/modules/dhcp-1/python/src/grpc/__init__.py rename to modules/network/dhcp-1/python/src/grpc/__init__.py diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py b/modules/network/dhcp-1/python/src/grpc/dhcp_config.py similarity index 100% rename from net_orc/network/modules/dhcp-1/python/src/grpc/dhcp_config.py rename to modules/network/dhcp-1/python/src/grpc/dhcp_config.py diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py b/modules/network/dhcp-1/python/src/grpc/network_service.py similarity index 100% rename from net_orc/network/modules/dhcp-1/python/src/grpc/network_service.py rename to modules/network/dhcp-1/python/src/grpc/network_service.py diff --git a/net_orc/network/modules/dhcp-1/python/src/grpc/proto/grpc.proto b/modules/network/dhcp-1/python/src/grpc/proto/grpc.proto similarity index 100% rename from net_orc/network/modules/dhcp-1/python/src/grpc/proto/grpc.proto rename to modules/network/dhcp-1/python/src/grpc/proto/grpc.proto diff --git a/net_orc/network/modules/dhcp-2/bin/start_network_service b/modules/network/dhcp-2/bin/start_network_service similarity index 91% rename from net_orc/network/modules/dhcp-2/bin/start_network_service rename to modules/network/dhcp-2/bin/start_network_service index d58174695..ad5ff09e7 100644 --- a/net_orc/network/modules/dhcp-2/bin/start_network_service +++ b/modules/network/dhcp-2/bin/start_network_service @@ -21,8 +21,8 @@ mkdir /var/run/radvd #Create and set permissions on the log files touch $DHCP_LOG_FILE touch $RA_LOG_FILE -chown $HOST_USER:$HOST_USER $DHCP_LOG_FILE -chown $HOST_USER:$HOST_USER $RA_LOG_FILE +chown $HOST_USER $DHCP_LOG_FILE +chown $HOST_USER $RA_LOG_FILE #Move the config files to the correct location diff --git a/net_orc/network/modules/dhcp-2/conf/dhcpd.conf b/modules/network/dhcp-2/conf/dhcpd.conf similarity index 100% rename from net_orc/network/modules/dhcp-2/conf/dhcpd.conf rename to modules/network/dhcp-2/conf/dhcpd.conf diff --git a/net_orc/network/modules/dhcp-2/conf/module_config.json b/modules/network/dhcp-2/conf/module_config.json similarity index 100% rename from net_orc/network/modules/dhcp-2/conf/module_config.json rename to modules/network/dhcp-2/conf/module_config.json diff --git a/net_orc/network/modules/dhcp-2/conf/radvd.conf b/modules/network/dhcp-2/conf/radvd.conf similarity index 100% rename from net_orc/network/modules/dhcp-2/conf/radvd.conf rename to modules/network/dhcp-2/conf/radvd.conf diff --git a/net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile b/modules/network/dhcp-2/dhcp-2.Dockerfile similarity index 55% rename from net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile rename to modules/network/dhcp-2/dhcp-2.Dockerfile index 99804e0e3..231d0c558 100644 --- a/net_orc/network/modules/dhcp-1/dhcp-1.Dockerfile +++ b/modules/network/dhcp-2/dhcp-2.Dockerfile @@ -1,14 +1,18 @@ # Image name: test-run/dhcp-primary FROM test-run/base:latest +ARG MODULE_NAME=dhcp-2 +ARG MODULE_DIR=modules/network/$MODULE_NAME + # Install dhcp server RUN apt-get install -y isc-dhcp-server radvd # Copy over all configuration files -COPY network/modules/dhcp-1/conf /testrun/conf +COPY $MODULE_DIR/conf /testrun/conf # Copy over all binary files -COPY network/modules/dhcp-1/bin /testrun/bin - +COPY $MODULE_DIR/bin /testrun/bin + # Copy over all python files -COPY network/modules/dhcp-1/python /testrun/python +COPY $MODULE_DIR/python /testrun/python + diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/__init__.py b/modules/network/dhcp-2/python/src/grpc/__init__.py similarity index 100% rename from net_orc/network/modules/dhcp-2/python/src/grpc/__init__.py rename to modules/network/dhcp-2/python/src/grpc/__init__.py diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py b/modules/network/dhcp-2/python/src/grpc/dhcp_config.py similarity index 100% rename from net_orc/network/modules/dhcp-2/python/src/grpc/dhcp_config.py rename to modules/network/dhcp-2/python/src/grpc/dhcp_config.py diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py b/modules/network/dhcp-2/python/src/grpc/network_service.py similarity index 100% rename from net_orc/network/modules/dhcp-2/python/src/grpc/network_service.py rename to modules/network/dhcp-2/python/src/grpc/network_service.py diff --git a/net_orc/network/modules/dhcp-2/python/src/grpc/proto/grpc.proto b/modules/network/dhcp-2/python/src/grpc/proto/grpc.proto similarity index 100% rename from net_orc/network/modules/dhcp-2/python/src/grpc/proto/grpc.proto rename to modules/network/dhcp-2/python/src/grpc/proto/grpc.proto diff --git a/net_orc/network/modules/dns/bin/start_network_service b/modules/network/dns/bin/start_network_service similarity index 100% rename from net_orc/network/modules/dns/bin/start_network_service rename to modules/network/dns/bin/start_network_service diff --git a/net_orc/network/modules/dns/conf/dnsmasq.conf b/modules/network/dns/conf/dnsmasq.conf similarity index 100% rename from net_orc/network/modules/dns/conf/dnsmasq.conf rename to modules/network/dns/conf/dnsmasq.conf diff --git a/net_orc/network/modules/dns/conf/module_config.json b/modules/network/dns/conf/module_config.json similarity index 100% rename from net_orc/network/modules/dns/conf/module_config.json rename to modules/network/dns/conf/module_config.json diff --git a/net_orc/network/modules/dns/dns.Dockerfile b/modules/network/dns/dns.Dockerfile similarity index 67% rename from net_orc/network/modules/dns/dns.Dockerfile rename to modules/network/dns/dns.Dockerfile index 84c1c7eb1..edfd4dd03 100644 --- a/net_orc/network/modules/dns/dns.Dockerfile +++ b/modules/network/dns/dns.Dockerfile @@ -1,6 +1,9 @@ # Image name: test-run/dns FROM test-run/base:latest +ARG MODULE_NAME=dns +ARG MODULE_DIR=modules/network/$MODULE_NAME + #Update and get all additional requirements not contained in the base image RUN apt-get update --fix-missing @@ -8,7 +11,7 @@ RUN apt-get update --fix-missing RUN apt-get install -y dnsmasq # Copy over all configuration files -COPY network/modules/dns/conf /testrun/conf +COPY $MODULE_DIR/conf /testrun/conf # Copy over all binary files -COPY network/modules/dns/bin /testrun/bin +COPY $MODULE_DIR/bin /testrun/bin diff --git a/net_orc/network/modules/gateway/bin/start_network_service b/modules/network/gateway/bin/start_network_service similarity index 100% rename from net_orc/network/modules/gateway/bin/start_network_service rename to modules/network/gateway/bin/start_network_service diff --git a/net_orc/network/modules/gateway/conf/module_config.json b/modules/network/gateway/conf/module_config.json similarity index 100% rename from net_orc/network/modules/gateway/conf/module_config.json rename to modules/network/gateway/conf/module_config.json diff --git a/net_orc/network/modules/gateway/gateway.Dockerfile b/modules/network/gateway/gateway.Dockerfile similarity index 59% rename from net_orc/network/modules/gateway/gateway.Dockerfile rename to modules/network/gateway/gateway.Dockerfile index b7085ebac..9bfa77dae 100644 --- a/net_orc/network/modules/gateway/gateway.Dockerfile +++ b/modules/network/gateway/gateway.Dockerfile @@ -1,11 +1,14 @@ # Image name: test-run/gateway FROM test-run/base:latest +ARG MODULE_NAME=gateway +ARG MODULE_DIR=modules/network/$MODULE_NAME + # Install required packages RUN apt-get install -y iptables isc-dhcp-client # Copy over all configuration files -COPY network/modules/gateway/conf /testrun/conf +COPY $MODULE_DIR/conf /testrun/conf # Copy over all binary files -COPY network/modules/gateway/bin /testrun/bin +COPY $MODULE_DIR/bin /testrun/bin diff --git a/net_orc/network/modules/ntp/bin/start_network_service b/modules/network/ntp/bin/start_network_service similarity index 82% rename from net_orc/network/modules/ntp/bin/start_network_service rename to modules/network/ntp/bin/start_network_service index 4c0c5dc74..b20cf8831 100644 --- a/net_orc/network/modules/ntp/bin/start_network_service +++ b/modules/network/ntp/bin/start_network_service @@ -7,7 +7,7 @@ echo Starting ntp #Create and set permissions on the log file touch $LOG_FILE -chown $HOST_USER:$HOST_USER $LOG_FILE +chown $HOST_USER $LOG_FILE #Start the NTP server python3 -u $PYTHON_SRC_DIR/ntp_server.py > $LOG_FILE diff --git a/net_orc/network/modules/ntp/conf/module_config.json b/modules/network/ntp/conf/module_config.json similarity index 100% rename from net_orc/network/modules/ntp/conf/module_config.json rename to modules/network/ntp/conf/module_config.json diff --git a/modules/network/ntp/ntp.Dockerfile b/modules/network/ntp/ntp.Dockerfile new file mode 100644 index 000000000..1add3178e --- /dev/null +++ b/modules/network/ntp/ntp.Dockerfile @@ -0,0 +1,16 @@ +# Image name: test-run/ntp +FROM test-run/base:latest + +ARG MODULE_NAME=ntp +ARG MODULE_DIR=modules/network/$MODULE_NAME + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python + +EXPOSE 123/udp diff --git a/net_orc/network/modules/ntp/python/src/ntp_server.py b/modules/network/ntp/python/src/ntp_server.py similarity index 100% rename from net_orc/network/modules/ntp/python/src/ntp_server.py rename to modules/network/ntp/python/src/ntp_server.py diff --git a/net_orc/network/modules/radius/bin/start_network_service b/modules/network/radius/bin/start_network_service similarity index 89% rename from net_orc/network/modules/radius/bin/start_network_service rename to modules/network/radius/bin/start_network_service index e27a828dd..399a90ae5 100644 --- a/net_orc/network/modules/radius/bin/start_network_service +++ b/modules/network/radius/bin/start_network_service @@ -15,6 +15,6 @@ python3 -u $PYTHON_SRC_DIR/authenticator.py & #Create and set permissions on the log file touch $LOG_FILE -chown $HOST_USER:$HOST_USER $LOG_FILE +chown $HOST_USER $LOG_FILE freeradius -f -X &> $LOG_FILE \ No newline at end of file diff --git a/net_orc/network/modules/radius/conf/ca.crt b/modules/network/radius/conf/ca.crt similarity index 100% rename from net_orc/network/modules/radius/conf/ca.crt rename to modules/network/radius/conf/ca.crt diff --git a/net_orc/network/modules/radius/conf/eap b/modules/network/radius/conf/eap similarity index 100% rename from net_orc/network/modules/radius/conf/eap rename to modules/network/radius/conf/eap diff --git a/net_orc/network/modules/radius/conf/module_config.json b/modules/network/radius/conf/module_config.json similarity index 100% rename from net_orc/network/modules/radius/conf/module_config.json rename to modules/network/radius/conf/module_config.json diff --git a/net_orc/network/modules/radius/python/requirements.txt b/modules/network/radius/python/requirements.txt similarity index 100% rename from net_orc/network/modules/radius/python/requirements.txt rename to modules/network/radius/python/requirements.txt diff --git a/net_orc/network/modules/radius/python/src/authenticator.py b/modules/network/radius/python/src/authenticator.py similarity index 100% rename from net_orc/network/modules/radius/python/src/authenticator.py rename to modules/network/radius/python/src/authenticator.py diff --git a/net_orc/network/modules/radius/radius.Dockerfile b/modules/network/radius/radius.Dockerfile similarity index 74% rename from net_orc/network/modules/radius/radius.Dockerfile rename to modules/network/radius/radius.Dockerfile index a72313826..c44c5f0cc 100644 --- a/net_orc/network/modules/radius/radius.Dockerfile +++ b/modules/network/radius/radius.Dockerfile @@ -1,6 +1,9 @@ # Image name: test-run/radius FROM test-run/base:latest +ARG MODULE_NAME=radius +ARG MODULE_DIR=modules/network/$MODULE_NAME + # Install radius and git RUN apt-get update && apt-get install -y openssl freeradius git @@ -14,13 +17,13 @@ EXPOSE 1812/udp EXPOSE 1813/udp # Copy over all configuration files -COPY network/modules/radius/conf /testrun/conf +COPY $MODULE_DIR/conf /testrun/conf # Copy over all binary files -COPY network/modules/radius/bin /testrun/bin +COPY $MODULE_DIR/bin /testrun/bin # Copy over all python files -COPY network/modules/radius/python /testrun/python +COPY $MODULE_DIR/python /testrun/python # Install all python requirements for the module RUN pip3 install -r /testrun/python/requirements.txt \ No newline at end of file diff --git a/net_orc/network/modules/template/bin/start_network_service b/modules/network/template/bin/start_network_service similarity index 100% rename from net_orc/network/modules/template/bin/start_network_service rename to modules/network/template/bin/start_network_service diff --git a/net_orc/network/modules/template/conf/module_config.json b/modules/network/template/conf/module_config.json similarity index 91% rename from net_orc/network/modules/template/conf/module_config.json rename to modules/network/template/conf/module_config.json index c767c9ad6..e702e1804 100644 --- a/net_orc/network/modules/template/conf/module_config.json +++ b/modules/network/template/conf/module_config.json @@ -15,6 +15,7 @@ }, "docker": { "enable_container": false, + "template":true, "depends_on": "base", "mounts": [ { diff --git a/net_orc/network/modules/template/python/src/template_main.py b/modules/network/template/python/src/template_main.py similarity index 100% rename from net_orc/network/modules/template/python/src/template_main.py rename to modules/network/template/python/src/template_main.py diff --git a/modules/network/template/template.Dockerfile b/modules/network/template/template.Dockerfile new file mode 100644 index 000000000..9efbfb230 --- /dev/null +++ b/modules/network/template/template.Dockerfile @@ -0,0 +1,14 @@ +# Image name: test-run/template +FROM test-run/base:latest + +ARG MODULE_NAME=template +ARG MODULE_DIR=modules/network/$MODULE_NAME + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/base/base.Dockerfile b/modules/test/base/base.Dockerfile similarity index 74% rename from test_orc/modules/base/base.Dockerfile rename to modules/test/base/base.Dockerfile index a508caef7..b8398eae9 100644 --- a/test_orc/modules/base/base.Dockerfile +++ b/modules/test/base/base.Dockerfile @@ -1,17 +1,20 @@ # Image name: test-run/base-test FROM ubuntu:jammy +ARG MODULE_NAME=base +ARG MODULE_DIR=modules/test/$MODULE_NAME + # Install common software RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix nmap --fix-missing # Setup the base python requirements -COPY modules/base/python /testrun/python +COPY $MODULE_DIR/python /testrun/python # Install all python requirements for the module RUN pip3 install -r /testrun/python/requirements.txt -# Add the bin files -COPY modules/base/bin /testrun/bin +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin # Remove incorrect line endings RUN dos2unix /testrun/bin/* diff --git a/test_orc/modules/base/bin/capture b/modules/test/base/bin/capture similarity index 88% rename from test_orc/modules/base/bin/capture rename to modules/test/base/bin/capture index facb6acf7..45cfcd42f 100644 --- a/test_orc/modules/base/bin/capture +++ b/modules/test/base/bin/capture @@ -12,7 +12,7 @@ INTERFACE=$2 # Create the output directory and start the capture mkdir -p $PCAP_DIR -chown $HOST_USER:$HOST_USER $PCAP_DIR +chown $HOST_USER $PCAP_DIR tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & # Small pause to let the capture to start diff --git a/test_orc/modules/base/bin/get_ipv4_addr b/modules/test/base/bin/get_ipv4_addr similarity index 100% rename from test_orc/modules/base/bin/get_ipv4_addr rename to modules/test/base/bin/get_ipv4_addr diff --git a/test_orc/modules/base/bin/setup_binaries b/modules/test/base/bin/setup_binaries similarity index 100% rename from test_orc/modules/base/bin/setup_binaries rename to modules/test/base/bin/setup_binaries diff --git a/test_orc/modules/base/bin/start_grpc b/modules/test/base/bin/start_grpc similarity index 100% rename from test_orc/modules/base/bin/start_grpc rename to modules/test/base/bin/start_grpc diff --git a/test_orc/modules/base/bin/start_module b/modules/test/base/bin/start_module similarity index 97% rename from test_orc/modules/base/bin/start_module rename to modules/test/base/bin/start_module index c179668ba..3e4737d8b 100644 --- a/test_orc/modules/base/bin/start_module +++ b/modules/test/base/bin/start_module @@ -15,7 +15,7 @@ IFACE=veth0 useradd $HOST_USER # Set permissions on the output files -chown -R $HOST_USER:$HOST_USER $OUTPUT_DIR +chown -R $HOST_USER $OUTPUT_DIR # Enable IPv6 for all containers sysctl net.ipv6.conf.all.disable_ipv6=0 diff --git a/test_orc/modules/base/bin/wait_for_interface b/modules/test/base/bin/wait_for_interface similarity index 100% rename from test_orc/modules/base/bin/wait_for_interface rename to modules/test/base/bin/wait_for_interface diff --git a/test_orc/modules/base/conf/module_config.json b/modules/test/base/conf/module_config.json similarity index 100% rename from test_orc/modules/base/conf/module_config.json rename to modules/test/base/conf/module_config.json diff --git a/test_orc/modules/base/python/requirements.txt b/modules/test/base/python/requirements.txt similarity index 100% rename from test_orc/modules/base/python/requirements.txt rename to modules/test/base/python/requirements.txt diff --git a/test_orc/modules/base/python/src/grpc/start_server.py b/modules/test/base/python/src/grpc/start_server.py similarity index 100% rename from test_orc/modules/base/python/src/grpc/start_server.py rename to modules/test/base/python/src/grpc/start_server.py diff --git a/test_orc/modules/base/python/src/logger.py b/modules/test/base/python/src/logger.py similarity index 100% rename from test_orc/modules/base/python/src/logger.py rename to modules/test/base/python/src/logger.py diff --git a/test_orc/modules/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py similarity index 100% rename from test_orc/modules/base/python/src/test_module.py rename to modules/test/base/python/src/test_module.py diff --git a/test_orc/modules/base/python/src/util.py b/modules/test/base/python/src/util.py similarity index 100% rename from test_orc/modules/base/python/src/util.py rename to modules/test/base/python/src/util.py diff --git a/modules/test/baseline/baseline.Dockerfile b/modules/test/baseline/baseline.Dockerfile new file mode 100644 index 000000000..c2b32e7b7 --- /dev/null +++ b/modules/test/baseline/baseline.Dockerfile @@ -0,0 +1,14 @@ +# Image name: test-run/baseline-test +FROM test-run/base-test:latest + +ARG MODULE_NAME=baseline +ARG MODULE_DIR=modules/test/$MODULE_NAME + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/baseline/bin/start_test_module b/modules/test/baseline/bin/start_test_module similarity index 90% rename from test_orc/modules/baseline/bin/start_test_module rename to modules/test/baseline/bin/start_test_module index 2938eb0f8..a09349cf9 100644 --- a/test_orc/modules/baseline/bin/start_test_module +++ b/modules/test/baseline/bin/start_test_module @@ -31,8 +31,8 @@ LOG_FILE=/runtime/output/$MODULE_NAME.log RESULT_FILE=/runtime/output/$MODULE_NAME-result.json touch $LOG_FILE touch $RESULT_FILE -chown $HOST_USER:$HOST_USER $LOG_FILE -chown $HOST_USER:$HOST_USER $RESULT_FILE +chown $HOST_USER $LOG_FILE +chown $HOST_USER $RESULT_FILE # Run the python scrip that will execute the tests for this module # -u flag allows python print statements diff --git a/test_orc/modules/baseline/conf/module_config.json b/modules/test/baseline/conf/module_config.json similarity index 100% rename from test_orc/modules/baseline/conf/module_config.json rename to modules/test/baseline/conf/module_config.json diff --git a/test_orc/modules/baseline/python/src/baseline_module.py b/modules/test/baseline/python/src/baseline_module.py similarity index 100% rename from test_orc/modules/baseline/python/src/baseline_module.py rename to modules/test/baseline/python/src/baseline_module.py diff --git a/test_orc/modules/baseline/python/src/run.py b/modules/test/baseline/python/src/run.py similarity index 100% rename from test_orc/modules/baseline/python/src/run.py rename to modules/test/baseline/python/src/run.py diff --git a/test_orc/modules/conn/bin/start_test_module b/modules/test/conn/bin/start_test_module similarity index 92% rename from test_orc/modules/conn/bin/start_test_module rename to modules/test/conn/bin/start_test_module index 4550849ce..8290c0764 100644 --- a/test_orc/modules/conn/bin/start_test_module +++ b/modules/test/conn/bin/start_test_module @@ -28,8 +28,8 @@ LOG_FILE=/runtime/output/$MODULE_NAME.log RESULT_FILE=/runtime/output/$MODULE_NAME-result.json touch $LOG_FILE touch $RESULT_FILE -chown $HOST_USER:$HOST_USER $LOG_FILE -chown $HOST_USER:$HOST_USER $RESULT_FILE +chown $HOST_USER $LOG_FILE +chown $HOST_USER $RESULT_FILE # Run the python scrip that will execute the tests for this module # -u flag allows python print statements diff --git a/test_orc/modules/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json similarity index 100% rename from test_orc/modules/conn/conf/module_config.json rename to modules/test/conn/conf/module_config.json diff --git a/test_orc/modules/conn/conn.Dockerfile b/modules/test/conn/conn.Dockerfile similarity index 59% rename from test_orc/modules/conn/conn.Dockerfile rename to modules/test/conn/conn.Dockerfile index cf25d0f02..2526b0046 100644 --- a/test_orc/modules/conn/conn.Dockerfile +++ b/modules/test/conn/conn.Dockerfile @@ -1,6 +1,9 @@ # Image name: test-run/conn-test FROM test-run/base-test:latest +ARG MODULE_NAME=conn +ARG MODULE_DIR=modules/test/$MODULE_NAME + # Install all necessary packages RUN apt-get install -y wget @@ -8,16 +11,16 @@ RUN apt-get install -y wget RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ #Load the requirements file -COPY modules/conn/python/requirements.txt /testrun/python +COPY $MODULE_DIR/python/requirements.txt /testrun/python #Install all python requirements for the module RUN pip3 install -r /testrun/python/requirements.txt # Copy over all configuration files -COPY modules/conn/conf /testrun/conf +COPY $MODULE_DIR/conf /testrun/conf -# Load device binary files -COPY modules/conn/bin /testrun/bin +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin # Copy over all python files -COPY modules/conn/python /testrun/python +COPY $MODULE_DIR/python /testrun/python diff --git a/test_orc/modules/conn/python/requirements.txt b/modules/test/conn/python/requirements.txt similarity index 100% rename from test_orc/modules/conn/python/requirements.txt rename to modules/test/conn/python/requirements.txt diff --git a/test_orc/modules/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py similarity index 100% rename from test_orc/modules/conn/python/src/connection_module.py rename to modules/test/conn/python/src/connection_module.py diff --git a/test_orc/modules/conn/python/src/run.py b/modules/test/conn/python/src/run.py similarity index 100% rename from test_orc/modules/conn/python/src/run.py rename to modules/test/conn/python/src/run.py diff --git a/test_orc/modules/dns/bin/start_test_module b/modules/test/dns/bin/start_test_module similarity index 90% rename from test_orc/modules/dns/bin/start_test_module rename to modules/test/dns/bin/start_test_module index 2938eb0f8..a09349cf9 100644 --- a/test_orc/modules/dns/bin/start_test_module +++ b/modules/test/dns/bin/start_test_module @@ -31,8 +31,8 @@ LOG_FILE=/runtime/output/$MODULE_NAME.log RESULT_FILE=/runtime/output/$MODULE_NAME-result.json touch $LOG_FILE touch $RESULT_FILE -chown $HOST_USER:$HOST_USER $LOG_FILE -chown $HOST_USER:$HOST_USER $RESULT_FILE +chown $HOST_USER $LOG_FILE +chown $HOST_USER $RESULT_FILE # Run the python scrip that will execute the tests for this module # -u flag allows python print statements diff --git a/test_orc/modules/dns/conf/module_config.json b/modules/test/dns/conf/module_config.json similarity index 100% rename from test_orc/modules/dns/conf/module_config.json rename to modules/test/dns/conf/module_config.json diff --git a/modules/test/dns/dns.Dockerfile b/modules/test/dns/dns.Dockerfile new file mode 100644 index 000000000..f831d0e2b --- /dev/null +++ b/modules/test/dns/dns.Dockerfile @@ -0,0 +1,14 @@ +# Image name: test-run/conn-test +FROM test-run/base-test:latest + +ARG MODULE_NAME=dns +ARG MODULE_DIR=modules/test/$MODULE_NAME + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/dns/python/src/dns_module.py b/modules/test/dns/python/src/dns_module.py similarity index 100% rename from test_orc/modules/dns/python/src/dns_module.py rename to modules/test/dns/python/src/dns_module.py diff --git a/test_orc/modules/dns/python/src/run.py b/modules/test/dns/python/src/run.py similarity index 100% rename from test_orc/modules/dns/python/src/run.py rename to modules/test/dns/python/src/run.py diff --git a/test_orc/modules/nmap/bin/start_test_module b/modules/test/nmap/bin/start_test_module similarity index 93% rename from test_orc/modules/nmap/bin/start_test_module rename to modules/test/nmap/bin/start_test_module index 4bb7e9f96..333566342 100644 --- a/test_orc/modules/nmap/bin/start_test_module +++ b/modules/test/nmap/bin/start_test_module @@ -31,8 +31,8 @@ LOG_FILE=/runtime/output/$MODULE_NAME.log RESULT_FILE=/runtime/output/$MODULE_NAME-result.json touch $LOG_FILE touch $RESULT_FILE -chown $HOST_USER:$HOST_USER $LOG_FILE -chown $HOST_USER:$HOST_USER $RESULT_FILE +chown $HOST_USER $LOG_FILE +chown $HOST_USER $RESULT_FILE # Run the python scrip that will execute the tests for this module # -u flag allows python print statements diff --git a/test_orc/modules/nmap/conf/module_config.json b/modules/test/nmap/conf/module_config.json similarity index 100% rename from test_orc/modules/nmap/conf/module_config.json rename to modules/test/nmap/conf/module_config.json diff --git a/modules/test/nmap/nmap.Dockerfile b/modules/test/nmap/nmap.Dockerfile new file mode 100644 index 000000000..c1a2f96ce --- /dev/null +++ b/modules/test/nmap/nmap.Dockerfile @@ -0,0 +1,20 @@ +# Image name: test-run/nmap-test +FROM test-run/base-test:latest + +ARG MODULE_NAME=nmap +ARG MODULE_DIR=modules/test/$MODULE_NAME + +#Load the requirements file +COPY $MODULE_DIR/python/requirements.txt /testrun/python + +#Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/nmap/python/requirements.txt b/modules/test/nmap/python/requirements.txt similarity index 100% rename from test_orc/modules/nmap/python/requirements.txt rename to modules/test/nmap/python/requirements.txt diff --git a/test_orc/modules/nmap/python/src/nmap_module.py b/modules/test/nmap/python/src/nmap_module.py similarity index 100% rename from test_orc/modules/nmap/python/src/nmap_module.py rename to modules/test/nmap/python/src/nmap_module.py diff --git a/test_orc/modules/nmap/python/src/run.py b/modules/test/nmap/python/src/run.py similarity index 100% rename from test_orc/modules/nmap/python/src/run.py rename to modules/test/nmap/python/src/run.py diff --git a/net_orc/.gitignore b/net_orc/.gitignore deleted file mode 100644 index 2d77147eb..000000000 --- a/net_orc/.gitignore +++ /dev/null @@ -1,133 +0,0 @@ -# Runtime folder -runtime/ -.vscode/ - -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ diff --git a/net_orc/network/modules/ntp/ntp.Dockerfile b/net_orc/network/modules/ntp/ntp.Dockerfile deleted file mode 100644 index 3474a504e..000000000 --- a/net_orc/network/modules/ntp/ntp.Dockerfile +++ /dev/null @@ -1,13 +0,0 @@ -# Image name: test-run/ntp -FROM test-run/base:latest - -# Copy over all configuration files -COPY network/modules/ntp/conf /testrun/conf - -# Copy over all binary files -COPY network/modules/ntp/bin /testrun/bin - -# Copy over all python files -COPY network/modules/ntp/python /testrun/python - -EXPOSE 123/udp diff --git a/net_orc/network/modules/template/template.Dockerfile b/net_orc/network/modules/template/template.Dockerfile deleted file mode 100644 index 45f9da6d9..000000000 --- a/net_orc/network/modules/template/template.Dockerfile +++ /dev/null @@ -1,11 +0,0 @@ -# Image name: test-run/template -FROM test-run/base:latest - -# Copy over all configuration files -COPY network/modules/template/conf /testrun/conf - -# Load device binary files -COPY network/modules/template/bin /testrun/bin - -# Copy over all python files -COPY network/modules/template/python /testrun/python \ No newline at end of file diff --git a/net_orc/orchestrator.Dockerfile b/net_orc/orchestrator.Dockerfile deleted file mode 100644 index f062a33d4..000000000 --- a/net_orc/orchestrator.Dockerfile +++ /dev/null @@ -1,22 +0,0 @@ -# Image name: test-run/orchestrator -FROM test-run/base:latest - -#Update and get all additional requirements not contained in the base image -RUN apt-get update - -RUN apt-get install -y python3-pip curl openvswitch-switch - -#Download and install docker client -ENV DOCKERVERSION=20.10.2 -RUN curl -fsSLO https://download.docker.com/linux/static/stable/x86_64/docker-${DOCKERVERSION}.tgz \ - && tar xzvf docker-${DOCKERVERSION}.tgz --strip 1 -C /usr/local/bin docker/docker \ - && rm docker-${DOCKERVERSION}.tgz - -#Create a directory to load all the app files into -RUN mkdir /python - -#Load the requirements file -COPY python/requirements.txt /python - -#Install all python requirements for the module -RUN pip3 install -r python/requirements.txt diff --git a/net_orc/python/requirements.txt b/net_orc/python/requirements.txt deleted file mode 100644 index 5d8f29214..000000000 --- a/net_orc/python/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -docker -ipaddress -netifaces -scapy \ No newline at end of file diff --git a/test_orc/modules/baseline/baseline.Dockerfile b/test_orc/modules/baseline/baseline.Dockerfile deleted file mode 100644 index 5b634e6ee..000000000 --- a/test_orc/modules/baseline/baseline.Dockerfile +++ /dev/null @@ -1,11 +0,0 @@ -# Image name: test-run/baseline-test -FROM test-run/base-test:latest - -# Copy over all configuration files -COPY modules/baseline/conf /testrun/conf - -# Load device binary files -COPY modules/baseline/bin /testrun/bin - -# Copy over all python files -COPY modules/baseline/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/dns/dns.Dockerfile b/test_orc/modules/dns/dns.Dockerfile deleted file mode 100644 index 7c3497bc3..000000000 --- a/test_orc/modules/dns/dns.Dockerfile +++ /dev/null @@ -1,11 +0,0 @@ -# Image name: test-run/baseline-test -FROM test-run/base-test:latest - -# Copy over all configuration files -COPY modules/dns/conf /testrun/conf - -# Load device binary files -COPY modules/dns/bin /testrun/bin - -# Copy over all python files -COPY modules/dns/python /testrun/python \ No newline at end of file diff --git a/test_orc/modules/nmap/nmap.Dockerfile b/test_orc/modules/nmap/nmap.Dockerfile deleted file mode 100644 index 3a8728d9f..000000000 --- a/test_orc/modules/nmap/nmap.Dockerfile +++ /dev/null @@ -1,17 +0,0 @@ -# Image name: test-run/baseline-test -FROM test-run/base-test:latest - -#Load the requirements file -COPY modules/nmap/python/requirements.txt /testrun/python - -#Install all python requirements for the module -RUN pip3 install -r /testrun/python/requirements.txt - -# Copy over all configuration files -COPY modules/nmap/conf /testrun/conf - -# Load device binary files -COPY modules/nmap/bin /testrun/bin - -# Copy over all python files -COPY modules/nmap/python /testrun/python \ No newline at end of file diff --git a/test_orc/python/requirements.txt b/test_orc/python/requirements.txt deleted file mode 100644 index e69de29bb..000000000 diff --git a/testing/test_baseline b/testing/test_baseline index d7fc1e5c5..bf191b88f 100755 --- a/testing/test_baseline +++ b/testing/test_baseline @@ -3,6 +3,8 @@ TESTRUN_OUT=/tmp/testrun.log +ifconfig + # Setup requirements sudo apt-get update sudo apt-get install openvswitch-common openvswitch-switch tcpdump jq moreutils coreutils @@ -18,9 +20,6 @@ sudo docker network create -d macvlan -o parent=endev0b endev0 # Start OVS sudo /usr/share/openvswitch/scripts/ovs-ctl start -# Fix due to ordering -sudo docker build ./net_orc/ -t test-run/base -f net_orc/network/modules/base/base.Dockerfile - # Build Test Container sudo docker build ./testing/docker/ci_baseline -t ci1 -f ./testing/docker/ci_baseline/Dockerfile From 7bb93664219e2575dc6934e4fcf3d383636508b1 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Tue, 20 Jun 2023 03:03:32 -0700 Subject: [PATCH 036/400] Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting --- framework/python/src/net_orc/ip_control.py | 220 ++++++++++++++++++ .../src/net_orc/network_orchestrator.py | 114 +++------ 2 files changed, 257 insertions(+), 77 deletions(-) create mode 100644 framework/python/src/net_orc/ip_control.py diff --git a/framework/python/src/net_orc/ip_control.py b/framework/python/src/net_orc/ip_control.py new file mode 100644 index 000000000..eb683c46b --- /dev/null +++ b/framework/python/src/net_orc/ip_control.py @@ -0,0 +1,220 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""IP Control Module""" +from common import logger +from common import util +import re + +LOGGER = logger.get_logger('ip_ctrl') + + +class IPControl: + """IP Control""" + + def __init__(self): + """Initialize the IPControl object""" + + def add_link(self, interface_name, peer_name): + """Create an ip link with a peer""" + success = util.run_command('ip link add ' + interface_name + + ' type veth peer name ' + peer_name) + return success + + def add_namespace(self, namespace): + """Add a network namespace""" + exists = self.namespace_exists(namespace) + LOGGER.info("Namespace exists: " + str(exists)) + if exists: + return True + else: + success = util.run_command('ip netns add ' + namespace) + return success + + def delete_link(self, interface_name): + """Delete an ip link""" + success = util.run_command('ip link delete ' + interface_name) + return success + + def delete_namespace(self, interface_name): + """Delete an ip namespace""" + success = util.run_command('ip netns delete ' + interface_name) + return success + + def link_exists(self, link_name): + links = self.get_links() + return link_name in links + + def namespace_exists(self, namespace): + """Check if a namespace already exists""" + namespaces = self.get_namespaces() + if namespace in namespaces: + return True + else: + return False + + def get_links(self): + stdout, stderr = util.run_command('ip link list') + links = stdout.strip().split('\n') + netns_links = [] + for link in links: + match = re.search(r'\d+:\s+(\S+)', link) + if match: + interface_name = match.group(1) + name_match = re.search(r'(.*)@', interface_name) + if name_match: + interface_name = name_match.group(1) + netns_links.append(interface_name.strip()) + return netns_links + + def get_namespaces(self): + stdout, stderr = util.run_command('ip netns list') + #Strip ID's from the namespace results + namespaces = re.findall(r'(\S+)(?:\s+\(id: \d+\))?', stdout) + return namespaces + + def set_namespace(self, interface_name, namespace): + """Attach an interface to a network namespace""" + success = util.run_command('ip link set ' + interface_name + ' netns ' + + namespace) + return success + + def rename_interface(self, interface_name, namespace, new_name): + """Rename an interface""" + success = util.run_command('ip netns exec ' + namespace + + ' ip link set dev ' + interface_name + ' name ' + + new_name) + return success + + def set_interface_mac(self, interface_name, namespace, mac_addr): + """Set MAC address of an interface""" + success = util.run_command('ip netns exec ' + namespace + + ' ip link set dev ' + interface_name + + ' address ' + mac_addr) + return success + + def set_interface_ip(self, interface_name, namespace, ipaddr): + """Set IP address of an interface""" + success = util.run_command('ip netns exec ' + namespace + ' ip addr add ' + + ipaddr + ' dev ' + interface_name) + return success + + def set_interface_up(self, interface_name, namespace=None): + """Set the interface to the up state""" + if namespace is None: + success = util.run_command('ip link set dev ' + interface_name + ' up') + else: + success = util.run_command('ip netns exec ' + namespace + + ' ip link set dev ' + interface_name + ' up') + return success + + def clean_all(self): + """Cleanup all existing test run interfaces and namespaces""" + + # Delete all namesapces that start with tr + namespaces = self.get_namespaces() + for ns in namespaces: + if 'tr' in ns: + self.delete_namespace(ns) + + # Delete all namespaces that start with tr + links = self.get_links() + for link in links: + if 'tr' in link: + self.delete_link(link) + + def cleanup(self, interface=None, namespace=None): + """Cleanup existing link and namespace if they still exist""" + + link_clean = True + if interface is not None: + if self.link_exists(interface): + link_clean = self.delete_link(interface) + + ns_clean = True + if namespace is not None: + if self.namespace_exists(namespace): + ns_clean = self.delete_namespace + return link_clean and ns_clean + + def configure_container_interface(self, + bridge_intf, + container_intf, + namespace_intf, + namespace, + mac_addr, + container_name=None, + ipv4_addr=None, + ipv6_addr=None): + + # Cleanup old interface and namespaces + self.cleanup(bridge_intf, namespace) + + # Create interface pair + self.add_link(bridge_intf, container_intf) + + if container_name is not None: + # Get PID for running container + # TODO: Some error checking around missing PIDs might be required + container_pid = util.run_command('docker inspect -f {{.State.Pid}} ' + + container_name)[0] + if not container_pid.isdigit(): + LOGGER.error(f'Failed to resolve pid for {container_name}') + return False + + # Create symlink for container network namespace + if not util.run_command('ln -sf /proc/' + container_pid + + '/ns/net /var/run/netns/' + namespace, + output=False): + LOGGER.error( + f'Failed to link {container_name} to namespace {namespace_intf}') + return False + + # Attach container interface to container network namespace + if not self.set_namespace(container_intf, namespace): + LOGGER.error(f'Failed to set namespace {namespace} for {container_intf}') + return False + + # Rename container interface name + if not self.rename_interface(container_intf, namespace, namespace_intf): + LOGGER.error( + f'Failed to rename container interface {container_intf} to {namespace_intf}' + ) + return False + + # Set MAC address of container interface + if not self.set_interface_mac(namespace_intf, namespace, mac_addr): + LOGGER.error( + f'Failed to set MAC address for {namespace_intf} to {mac_addr}') + return False + + # Set IP address of container interface + if ipv4_addr is not None: + if not self.set_interface_ip(namespace_intf, namespace, ipv4_addr): + LOGGER.error( + f'Failed to set IPv4 address for {namespace_intf} to {ipv4_addr}') + return False + if ipv6_addr is not None: + if not self.set_interface_ip(namespace_intf, namespace, ipv6_addr): + LOGGER.error( + f'Failed to set IPv6 address for {namespace_intf} to {ipv6_addr}') + return False + + # Set interfaces up + if not self.set_interface_up(bridge_intf): + LOGGER.error(f'Failed to set interface up {bridge_intf}') + return False + if not self.set_interface_up(namespace_intf, namespace): + LOGGER.error(f'Failed to set interface up {namespace_intf}') + return False + return True diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index f1f479742..f3c07e8e4 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -11,7 +11,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """Network orchestrator is responsible for managing all of the virtual network services""" import getpass @@ -34,6 +33,7 @@ from net_orc.network_event import NetworkEvent from net_orc.network_validator import NetworkValidator from net_orc.ovs_control import OVSControl +from net_orc.ip_control import IPControl LOGGER = logger.get_logger('net_orc') CONFIG_FILE = 'conf/system.json' @@ -83,15 +83,17 @@ def __init__(self, self.validate = validate self.async_monitor = async_monitor - self._path = os.path.dirname(os.path.dirname( - os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) + self._path = os.path.dirname( + os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) self.validator = NetworkValidator() shutil.rmtree(os.path.join(os.getcwd(), NET_DIR), ignore_errors=True) self.network_config = NetworkConfig() self.load_config(config_file) self._ovs = OVSControl() + self._ip_ctrl = IPControl() def start(self): """Start the network orchestrator.""" @@ -181,9 +183,8 @@ def _device_discovered(self, mac_addr): f'Discovered device {mac_addr}. Waiting for device to obtain IP') device = self._get_device(mac_addr=mac_addr) - device_runtime_dir = os.path.join(RUNTIME_DIR, - TEST_DIR, - device.mac_addr.replace(':', '')) + device_runtime_dir = os.path.join(RUNTIME_DIR, TEST_DIR, + device.mac_addr.replace(':', '')) os.makedirs(device_runtime_dir) util.run_command(f'chown -R {self._host_user} {device_runtime_dir}') @@ -201,7 +202,7 @@ def _device_discovered(self, mac_addr): LOGGER.info( f'Device with mac addr {device.mac_addr} has obtained IP address ' f'{device.ip_addr}') - + self._start_device_monitor(device) def _device_has_ip(self, packet): @@ -418,8 +419,7 @@ def _load_network_module(self, module_dir): # Determine if this is a template if 'template' in net_module_json['config']['docker']: - net_module.template = net_module_json['config']['docker'][ - 'template'] + net_module.template = net_module_json['config']['docker']['template'] # Load network service networking configuration if net_module.enable_container: @@ -493,7 +493,7 @@ def _start_network_service(self, net_module): def _get_host_user(self): user = self._get_os_user() - + # If primary method failed, try secondary if user is None: user = self._get_user() @@ -510,7 +510,7 @@ def _get_os_user(self): LOGGER.error("An OS error occurred while retrieving the login name.") except Exception as e: # Catch any other unexpected exceptions - LOGGER.error("An exception occurred:", e) + LOGGER.error("An exception occurred:", e) return user def _get_user(self): @@ -520,15 +520,15 @@ def _get_user(self): except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: # Handle specific exceptions individually if isinstance(e, KeyError): - LOGGER.error("USER environment variable not set or unavailable.") + LOGGER.error("USER environment variable not set or unavailable.") elif isinstance(e, ImportError): - LOGGER.error("Unable to import the getpass module.") + LOGGER.error("Unable to import the getpass module.") elif isinstance(e, ModuleNotFoundError): - LOGGER.error("The getpass module was not found.") + LOGGER.error("The getpass module was not found.") elif isinstance(e, OSError): - LOGGER.error("An OS error occurred while retrieving the username.") + LOGGER.error("An OS error occurred while retrieving the username.") else: - LOGGER.error("An exception occurred:", e) + LOGGER.error("An exception occurred:", e) return user def _stop_service_module(self, net_module, kill=False): @@ -666,9 +666,18 @@ def _attach_service_to_network(self, net_module): # Container network namespace name container_net_ns = 'tr-ctns-' + net_module.dir_name - # Create interface pair - util.run_command('ip link add ' + bridge_intf + ' type veth peer name ' + - container_intf) + # Resolve the interface information + mac_addr = '9a:02:57:1e:8f:' + str(net_module.net_config.ip_index) + ipv4_addr = net_module.net_config.get_ipv4_addr_with_prefix() + ipv6_addr = net_module.net_config.get_ipv6_addr_with_prefix() + + # Add and configure the interface container + if not self._ip_ctrl.configure_container_interface( + bridge_intf, container_intf, "veth0", container_net_ns, mac_addr, + net_module.container_name, ipv4_addr, ipv6_addr): + LOGGER.error('Failed to configure local networking for ' + + net_module.name + '. Exiting.') + sys.exit(1) # Add bridge interface to device bridge if self._ovs.add_port(port=bridge_intf, bridge_name=DEVICE_BRIDGE): @@ -677,42 +686,6 @@ def _attach_service_to_network(self, net_module): DEVICE_BRIDGE + '. Exiting.') sys.exit(1) - # Get PID for running container - # TODO: Some error checking around missing PIDs might be required - container_pid = util.run_command('docker inspect -f {{.State.Pid}} ' + - net_module.container_name)[0] - - # Create symlink for container network namespace - util.run_command('ln -sf /proc/' + container_pid + - '/ns/net /var/run/netns/' + container_net_ns) - - # Attach container interface to container network namespace - util.run_command('ip link set ' + container_intf + ' netns ' + - container_net_ns) - - # Rename container interface name to veth0 - util.run_command('ip netns exec ' + container_net_ns + ' ip link set dev ' + - container_intf + ' name veth0') - - # Set MAC address of container interface - util.run_command('ip netns exec ' + container_net_ns + - ' ip link set dev veth0 address 9a:02:57:1e:8f:' + - str(net_module.net_config.ip_index)) - - # Set IP address of container interface - util.run_command('ip netns exec ' + container_net_ns + ' ip addr add ' + - net_module.net_config.get_ipv4_addr_with_prefix() + - ' dev veth0') - - util.run_command('ip netns exec ' + container_net_ns + ' ip addr add ' + - net_module.net_config.get_ipv6_addr_with_prefix() + - ' dev veth0') - - # Set interfaces up - util.run_command('ip link set dev ' + bridge_intf + ' up') - util.run_command('ip netns exec ' + container_net_ns + - ' ip link set dev veth0 up') - if net_module.net_config.enable_wan: LOGGER.debug('Attaching net service ' + net_module.display_name + ' to internet bridge') @@ -725,9 +698,11 @@ def _attach_service_to_network(self, net_module): # tr-cti-dhcp (Test Run Container Interface for DHCP container) container_intf = 'tr-cti-' + net_module.dir_name - # Create interface pair - util.run_command('ip link add ' + bridge_intf + ' type veth peer name ' + - container_intf) + if not self._ip_ctrl.configure_container_interface( + bridge_intf, container_intf, "eth1", container_net_ns, mac_addr): + LOGGER.error('Failed to configure internet networking for ' + + net_module.name + '. Exiting.') + sys.exit(1) # Attach bridge interface to internet bridge if self._ovs.add_port(port=bridge_intf, bridge_name=INTERNET_BRIDGE): @@ -737,24 +712,6 @@ def _attach_service_to_network(self, net_module): ' to internet bridge ' + DEVICE_BRIDGE + '. Exiting.') sys.exit(1) - # Attach container interface to container network namespace - util.run_command('ip link set ' + container_intf + ' netns ' + - container_net_ns) - - # Rename container interface name to eth1 - util.run_command('ip netns exec ' + container_net_ns + - ' ip link set dev ' + container_intf + ' name eth1') - - # Set MAC address of container interface - util.run_command('ip netns exec ' + container_net_ns + - ' ip link set dev eth1 address 9a:02:57:1e:8f:0' + - str(net_module.net_config.ip_index)) - - # Set interfaces up - util.run_command('ip link set dev ' + bridge_intf + ' up') - util.run_command('ip netns exec ' + container_net_ns + - ' ip link set dev eth1 up') - def restore_net(self): LOGGER.info('Clearing baseline network') @@ -776,6 +733,9 @@ def restore_net(self): # Clear the virtual network self._ovs.restore_net() + # Clean up any existing network artifacts + self._ip_ctrl.clean_all() + # Restart internet interface if util.interface_exists(self._int_intf): util.run_command('ip link set ' + self._int_intf + ' down') From b0d14c2ac75278fcede8fe2f889105bf2b8f9774 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Fri, 23 Jun 2023 13:28:41 +0100 Subject: [PATCH 037/400] Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location --- .gitignore | 1 - conf/.gitignore | 1 - framework/python/src/core/testrun.py | 4 ++-- framework/python/src/net_orc/network_orchestrator.py | 5 ++--- framework/python/src/net_orc/network_validator.py | 2 +- framework/python/src/net_orc/ovs_control.py | 2 +- local/.gitignore | 2 ++ {conf => local}/system.json.example | 0 testing/test_baseline | 2 +- 9 files changed, 9 insertions(+), 10 deletions(-) delete mode 100644 conf/.gitignore create mode 100644 local/.gitignore rename {conf => local}/system.json.example (100%) diff --git a/.gitignore b/.gitignore index ad8f26d34..e168ec07a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,5 @@ venv/ .vscode/ error pylint.out -local/ __pycache__/ build/ \ No newline at end of file diff --git a/conf/.gitignore b/conf/.gitignore deleted file mode 100644 index 41b89ceb1..000000000 --- a/conf/.gitignore +++ /dev/null @@ -1 +0,0 @@ -system.json \ No newline at end of file diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index e59b7cda2..d613410e9 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -39,8 +39,8 @@ from device import Device LOGGER = logger.get_logger('test_run') -CONFIG_FILE = 'conf/system.json' -EXAMPLE_CONFIG_FILE = 'conf/system.json.example' +CONFIG_FILE = 'local/system.json' +EXAMPLE_CONFIG_FILE = 'local/system.json.example' RUNTIME = 120 LOCAL_DEVICES_DIR = 'local/devices' diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index f3c07e8e4..643dc4def 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -25,7 +25,6 @@ import threading import docker from docker.types import Mount -from collections import OrderedDict from common import logger from common import util from net_orc.listener import Listener @@ -36,8 +35,8 @@ from net_orc.ip_control import IPControl LOGGER = logger.get_logger('net_orc') -CONFIG_FILE = 'conf/system.json' -EXAMPLE_CONFIG_FILE = 'conf/system.json.example' +CONFIG_FILE = 'local/system.json' +EXAMPLE_CONFIG_FILE = 'local/system.json.example' RUNTIME_DIR = 'runtime' TEST_DIR = 'test' MONITOR_PCAP = 'monitor.pcap' diff --git a/framework/python/src/net_orc/network_validator.py b/framework/python/src/net_orc/network_validator.py index 4ee46124d..a4c51eb2d 100644 --- a/framework/python/src/net_orc/network_validator.py +++ b/framework/python/src/net_orc/network_validator.py @@ -28,7 +28,7 @@ DEVICES_DIR = 'modules/devices' DEVICE_METADATA = 'conf/module_config.json' DEVICE_BRIDGE = 'tr-d' -CONF_DIR = 'conf' +CONF_DIR = 'local' CONF_FILE = 'system.json' diff --git a/framework/python/src/net_orc/ovs_control.py b/framework/python/src/net_orc/ovs_control.py index 3c950d4af..83823e8fa 100644 --- a/framework/python/src/net_orc/ovs_control.py +++ b/framework/python/src/net_orc/ovs_control.py @@ -18,7 +18,7 @@ from common import logger from common import util -CONFIG_FILE = 'conf/system.json' +CONFIG_FILE = 'local/system.json' DEVICE_BRIDGE = 'tr-d' INTERNET_BRIDGE = 'tr-c' LOGGER = logger.get_logger('ovs_ctrl') diff --git a/local/.gitignore b/local/.gitignore new file mode 100644 index 000000000..4fb365c03 --- /dev/null +++ b/local/.gitignore @@ -0,0 +1,2 @@ +system.json +devices \ No newline at end of file diff --git a/conf/system.json.example b/local/system.json.example similarity index 100% rename from conf/system.json.example rename to local/system.json.example diff --git a/testing/test_baseline b/testing/test_baseline index bf191b88f..36d21fa5e 100755 --- a/testing/test_baseline +++ b/testing/test_baseline @@ -23,7 +23,7 @@ sudo /usr/share/openvswitch/scripts/ovs-ctl start # Build Test Container sudo docker build ./testing/docker/ci_baseline -t ci1 -f ./testing/docker/ci_baseline/Dockerfile -cat <conf/system.json +cat <local/system.json { "network": { "device_intf": "endev0a", From 94e937fb657954c77c364f20adc1d56a5f15c975 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Fri, 23 Jun 2023 14:18:42 +0100 Subject: [PATCH 038/400] Add documentation (#53) --- docs/configure_device.md | 41 +++++++++++++++++++++++++++++++ docs/get_started.md | 53 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 docs/configure_device.md create mode 100644 docs/get_started.md diff --git a/docs/configure_device.md b/docs/configure_device.md new file mode 100644 index 000000000..ad58521a4 --- /dev/null +++ b/docs/configure_device.md @@ -0,0 +1,41 @@ +# Device Configuration + +The device configuration file allows you to customize the testing behavior for a specific device. This file is located at `local/devices/{Device Name}/device_config.json`. Below is an overview of how to configure the device tests. + +## Device Information + +The device information section includes the manufacturer, model, and MAC address of the device. These details help identify the specific device being tested. + +## Test Modules + +Test modules are groups of tests that can be enabled or disabled as needed. You can choose which test modules to include for your device. The device configuration file contains the following test module: + +- DNS Test Module + +### Enabling and Disabling Test Modules + +To enable or disable a test module, modify the `enabled` field within the respective module. Setting it to `true` enables the module, while setting it to `false` disables the module. + +## Individual Tests + +Within the DNS test module, there are individual tests that can be enabled or disabled. These tests focus on specific aspects of network behavior. You can customize the tests based on your device and testing requirements. + +### Enabling and Disabling Tests + +To enable or disable an individual test, modify the `enabled` field within the respective test. Setting it to `true` enables the test, while setting it to `false` disables the test. + +> Note: The example device configuration file (`resources/devices/template/device_config.json`) provides a complete usage example, including the structure and configuration options for the DNS test module and its tests. You can refer to this file to understand how to configure your device tests effectively. + +## Customizing the Device Configuration + +To customize the device configuration for your specific device, follow these steps: + +1. Copy the default configuration file provided in the `resources/devices/template` folder. + - Create a new folder for your device under `local/devices` directory. + - Copy the `device_config.json` file from `resources/devices/template` to the newly created device folder. + +This ensures that you have a copy of the default configuration file, which you can then modify for your specific device. + +> Note: Ensure that the device configuration file is properly formatted, and the changes made align with the intended test behavior. Incorrect settings or syntax may lead to unexpected results during testing. + +If you encounter any issues or need assistance with the device configuration, refer to the Test Run documentation or ask a question on the Issues page. diff --git a/docs/get_started.md b/docs/get_started.md new file mode 100644 index 000000000..7b8cf9e13 --- /dev/null +++ b/docs/get_started.md @@ -0,0 +1,53 @@ +# Getting Started + +## Prerequisites + +### Hardware + +Before starting with Test Run, ensure you have the following hardware: + +- PC running Ubuntu LTS (laptop or desktop) +- 2x USB Ethernet adapter (one may be a built-in Ethernet port) +- Internet connection + +### Software + +Ensure the following software is installed on your Ubuntu LTS PC: + +- Python 3 (already available on Ubuntu LTS) +- Docker - Installation Guide: [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) +- Open vSwitch ``sudo apt-get install openvswitch-common openvswitch-switch`` + +## Installation + +1. Download Test Run from the releases page or the appropriate source. + +2. Run the install script. + +## Configuration + +1. Copy the default configuration file. + +2. Open the `local/system.json` file and modify the configuration as needed. Specify the interface names for the internet and device interfaces. + +## Test Your Device + +1. Attach network interfaces: + + - Connect one USB Ethernet adapter to the internet source (e.g., router or switch) using an Ethernet cable. + - Connect the other USB Ethernet adapter directly to the IoT device you want to test using an Ethernet cable. + +2. Start Test Run. + + - To run Test Run in network-only mode (without running any tests), use the `--net-only` option. + + - To skip network validation before use and not launch the faux device on startup, use the `--no-validate` option. + +# Troubleshooting + +If you encounter any issues or need assistance, consider the following: + +- Ensure that all hardware and software prerequisites are met. +- Verify that the network interfaces are connected correctly. +- Check the configuration in the `local/system.json` file. +- Refer to the Test Run documentation or ask for further assistance from the support team. From 098de20e3774db3a381dafb564190561e40f5270 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 28 Jun 2023 11:22:59 +0100 Subject: [PATCH 039/400] Sync dev to main (#56) * Merge dev into main (Sprint 7 and 8) (#33) * Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey * Add issue report templates (#7) * Add issue templates * Update README.md * Discover devices on the network (#5) * Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- * Quick refactor (#9) * Fix duplicate sleep calls * Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- * Add baseline and pylint tests (#25) * Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot * Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot * Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues * Fix device configs * Remove unecessary files * Cleanup duplicate properties * Cleanup install script * Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev * Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled * Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test * Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot * Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey * Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * remove ovs files added back in during merge * Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Create startup capture (#37) * Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test * Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures * File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions * Add connection single ip test (#47) * Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range * Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot * Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location * Add documentation (#53) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Sprint 8 Hotfix (#54) * Fix connection results.json * Re add try/catch * Fix log level * Debug test module load order * Add depends on to nmap module * Remove logging change --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron --- cmd/start | 21 ----- framework/python/src/common/logger.py | 2 +- framework/python/src/common/util.py | 44 ++++++++++- framework/python/src/core/device.py | 2 +- framework/python/src/core/testrun.py | 37 ++++++--- .../src/net_orc/network_orchestrator.py | 76 +++---------------- .../python/src/test_orc/test_orchestrator.py | 61 +++------------ modules/test/base/python/src/test_module.py | 1 - modules/test/nmap/conf/module_config.json | 1 + resources/devices/template/device_config.json | 11 ++- 10 files changed, 98 insertions(+), 158 deletions(-) diff --git a/cmd/start b/cmd/start index 55d2e52eb..17bc2af6c 100755 --- a/cmd/start +++ b/cmd/start @@ -22,25 +22,4 @@ source venv/bin/activate export PYTHONPATH="$PWD/framework/python/src" python -u framework/python/src/core/test_runner.py $@ -# TODO: Work in progress code for containerization of OVS module -# asyncRun() { -# "$@" & -# pid="$!" -# echo "PID Running: " $pid -# trap "echo 'Stopping PID $pid'; kill -SIGTERM $pid" SIGINT SIGTERM - -# sleep 10 - -# # A signal emitted while waiting will make the wait command return code > 128 -# # Let's wrap it in a loop that doesn't end before the process is indeed stopped -# while kill -0 $pid > /dev/null 2>&1; do -# #while $(kill -0 $pid 2>/dev/null); do -# wait -# done -# } - -# # -u flag allows python print statements -# # to be logged by docker by running unbuffered -# asyncRun python3 -u python/src/run.py $@ - deactivate \ No newline at end of file diff --git a/framework/python/src/common/logger.py b/framework/python/src/common/logger.py index 539767f53..8dd900fea 100644 --- a/framework/python/src/common/logger.py +++ b/framework/python/src/common/logger.py @@ -21,7 +21,7 @@ _LOG_FORMAT = '%(asctime)s %(name)-8s %(levelname)-7s %(message)s' _DATE_FORMAT = '%b %02d %H:%M:%S' _DEFAULT_LEVEL = logging.INFO -_CONF_DIR = 'conf' +_CONF_DIR = 'local' _CONF_FILE_NAME = 'system.json' # Set log level diff --git a/framework/python/src/common/util.py b/framework/python/src/common/util.py index 1ffe70651..441b93224 100644 --- a/framework/python/src/common/util.py +++ b/framework/python/src/common/util.py @@ -13,6 +13,8 @@ # limitations under the License. """Provides basic utilities for the network orchestrator.""" +import getpass +import os import subprocess import shlex from common import logger @@ -37,7 +39,7 @@ def run_command(cmd, output=True): if process.returncode != 0 and output: err_msg = f'{stderr.strip()}. Code: {process.returncode}' - LOGGER.error('Command Failed: ' + cmd) + LOGGER.error('Command failed: ' + cmd) LOGGER.error('Error: ' + err_msg) else: success = True @@ -50,6 +52,44 @@ def run_command(cmd, output=True): def interface_exists(interface): return interface in netifaces.interfaces() - def prettify(mac_string): return ':'.join([f'{ord(b):02x}' for b in mac_string]) + +def get_host_user(): + user = get_os_user() + + # If primary method failed, try secondary + if user is None: + user = get_user() + + return user + +def get_os_user(): + user = None + try: + user = os.getlogin() + except OSError: + # Handle the OSError exception + LOGGER.error('An OS error occured whilst calling os.getlogin()') + except Exception: + # Catch any other unexpected exceptions + LOGGER.error('An unknown exception occured whilst calling os.getlogin()') + return user + +def get_user(): + user = None + try: + user = getpass.getuser() + except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: + # Handle specific exceptions individually + if isinstance(e, KeyError): + LOGGER.error('USER environment variable not set or unavailable.') + elif isinstance(e, ImportError): + LOGGER.error('Unable to import the getpass module.') + elif isinstance(e, ModuleNotFoundError): + LOGGER.error('The getpass module was not found.') + elif isinstance(e, OSError): + LOGGER.error('An OS error occurred while retrieving the username.') + else: + LOGGER.error('An exception occurred:', e) + return user diff --git a/framework/python/src/core/device.py b/framework/python/src/core/device.py index 44f275bdf..efce2dba1 100644 --- a/framework/python/src/core/device.py +++ b/framework/python/src/core/device.py @@ -22,6 +22,6 @@ class Device(NetworkDevice): """Represents a physical device and it's configuration.""" - make: str = None + manufacturer: str = None model: str = None test_modules: str = None diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index d613410e9..a91736e95 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -25,7 +25,7 @@ import json import signal import time -from common import logger +from common import logger, util # Locate parent directory current_dir = os.path.dirname(os.path.realpath(__file__)) @@ -46,7 +46,7 @@ LOCAL_DEVICES_DIR = 'local/devices' RESOURCE_DEVICES_DIR = 'resources/devices' DEVICE_CONFIG = 'device_config.json' -DEVICE_MAKE = 'make' +DEVICE_MANUFACTURER = 'manufacturer' DEVICE_MODEL = 'model' DEVICE_MAC_ADDR = 'mac_addr' DEVICE_TEST_MODULES = 'test_modules' @@ -76,7 +76,6 @@ def __init__(self, self._net_orc = net_orc.NetworkOrchestrator( config_file=config_file_abs, validate=validate, - async_monitor=not self._net_only, single_intf = self._single_intf) self._test_orc = test_orc.TestOrchestrator(self._net_orc) @@ -85,17 +84,30 @@ def start(self): self._load_all_devices() + self._start_network() + if self._net_only: LOGGER.info('Network only option configured, no tests will be run') - self._start_network() + + self._net_orc.listener.register_callback( + self._device_discovered, + [NetworkEvent.DEVICE_DISCOVERED] + ) + + self._net_orc.start_listener() + LOGGER.info('Waiting for devices on the network...') + + while True: + time.sleep(RUNTIME) + else: - self._start_network() self._test_orc.start() self._net_orc.listener.register_callback( self._device_stable, [NetworkEvent.DEVICE_STABLE] ) + self._net_orc.listener.register_callback( self._device_discovered, [NetworkEvent.DEVICE_DISCOVERED] @@ -106,13 +118,13 @@ def start(self): time.sleep(RUNTIME) - if not self._test_orc.test_in_progress(): - LOGGER.info('Timed out whilst waiting for device') + if not (self._test_orc.test_in_progress() or self._net_orc.monitor_in_progress()): + LOGGER.info('Timed out whilst waiting for device or stopping due to test completion') else: - while self._test_orc.test_in_progress(): + while self._test_orc.test_in_progress() or self._net_orc.monitor_in_progress(): time.sleep(5) - self.stop() + self.stop() def stop(self, kill=False): self._stop_tests() @@ -157,18 +169,19 @@ def _load_devices(self, device_dir): LOGGER.debug('Loading devices from ' + device_dir) os.makedirs(device_dir, exist_ok=True) + util.run_command(f'chown -R {util.get_host_user()} {device_dir}') for device_folder in os.listdir(device_dir): with open(os.path.join(device_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_manufacturer = device_config_json.get(DEVICE_MANUFACTURER) device_model = device_config_json.get(DEVICE_MODEL) mac_addr = device_config_json.get(DEVICE_MAC_ADDR) test_modules = device_config_json.get(DEVICE_TEST_MODULES) - device = Device(make=device_make, + device = Device(manufacturer=device_manufacturer, model=device_model, mac_addr=mac_addr, test_modules=json.dumps(test_modules)) @@ -184,7 +197,7 @@ 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') + f'Discovered {device.manufacturer} {device.model} on the network') else: device = Device(mac_addr=mac_addr) self._devices.append(device) diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index 643dc4def..499ce954b 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -21,8 +21,6 @@ import shutil import subprocess import sys -import time -import threading import docker from docker.types import Mount from common import logger @@ -41,7 +39,6 @@ TEST_DIR = 'test' MONITOR_PCAP = 'monitor.pcap' NET_DIR = 'runtime/network' -#NETWORK_MODULES_DIR = 'network/modules' NETWORK_MODULES_DIR = 'modules/network' NETWORK_MODULE_METADATA = 'conf/module_config.json' DEVICE_BRIDGE = 'tr-d' @@ -56,21 +53,18 @@ DEFAULT_RUNTIME = 1200 DEFAULT_MONITOR_PERIOD = 300 -RUNTIME = 1500 - - class NetworkOrchestrator: """Manage and controls a virtual testing network.""" def __init__(self, config_file=CONFIG_FILE, validate=True, - async_monitor=False, single_intf=False): self._runtime = DEFAULT_RUNTIME self._startup_timeout = DEFAULT_STARTUP_TIMEOUT self._monitor_period = DEFAULT_MONITOR_PERIOD + self._monitor_in_progress = False self._int_intf = None self._dev_intf = None @@ -80,7 +74,6 @@ def __init__(self, self._net_modules = [] self._devices = [] self.validate = validate - self.async_monitor = async_monitor self._path = os.path.dirname( os.path.dirname( @@ -99,7 +92,7 @@ def start(self): LOGGER.debug('Starting network orchestrator') - self._host_user = self._get_host_user() + self._host_user = util.get_host_user() # Get all components ready self.load_network_modules() @@ -109,14 +102,6 @@ def start(self): self.start_network() - if self.async_monitor: - # Run the monitor method asynchronously to keep this method non-blocking - self._monitor_thread = threading.Thread(target=self.monitor_network) - self._monitor_thread.daemon = True - self._monitor_thread.start() - else: - self.monitor_network() - def start_network(self): """Start the virtual testing network.""" LOGGER.info('Starting network') @@ -130,7 +115,7 @@ def start_network(self): self.validator.start() # Get network ready (via Network orchestrator) - LOGGER.info('Network is ready.') + LOGGER.debug('Network is ready') def start_listener(self): self.listener.start_listener() @@ -151,13 +136,6 @@ def stop_network(self, kill=False): self.stop_networking_services(kill=kill) self.restore_net() - def monitor_network(self): - # TODO: This time should be configurable (How long to hold before exiting, - # this could be infinite too) - time.sleep(RUNTIME) - - self.stop() - def load_config(self, config_file=None): if config_file is None: # If not defined, use relative pathing to local file @@ -178,8 +156,11 @@ def load_config(self, config_file=None): def _device_discovered(self, mac_addr): + self._monitor_in_progress = True + LOGGER.debug( f'Discovered device {mac_addr}. Waiting for device to obtain IP') + device = self._get_device(mac_addr=mac_addr) device_runtime_dir = os.path.join(RUNTIME_DIR, TEST_DIR, @@ -204,6 +185,9 @@ def _device_discovered(self, mac_addr): self._start_device_monitor(device) + def monitor_in_progress(self): + return self._monitor_in_progress + def _device_has_ip(self, packet): device = self._get_device(mac_addr=packet.src) if device is None or device.ip_addr is None: @@ -225,6 +209,8 @@ def _start_device_monitor(self, device): wrpcap( os.path.join(RUNTIME_DIR, TEST_DIR, device.mac_addr.replace(':', ''), 'monitor.pcap'), packet_capture) + + self._monitor_in_progress = False self.listener.call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) def _get_device(self, mac_addr): @@ -490,46 +476,6 @@ def _start_network_service(self, net_module): if network != 'host': self._attach_service_to_network(net_module) - def _get_host_user(self): - user = self._get_os_user() - - # If primary method failed, try secondary - if user is None: - user = self._get_user() - - LOGGER.debug("Network orchestrator host user: " + user) - return user - - def _get_os_user(self): - user = None - try: - user = os.getlogin() - except OSError as e: - # Handle the OSError exception - LOGGER.error("An OS error occurred while retrieving the login name.") - except Exception as e: - # Catch any other unexpected exceptions - LOGGER.error("An exception occurred:", e) - return user - - def _get_user(self): - user = None - try: - user = getpass.getuser() - except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: - # Handle specific exceptions individually - if isinstance(e, KeyError): - LOGGER.error("USER environment variable not set or unavailable.") - elif isinstance(e, ImportError): - LOGGER.error("Unable to import the getpass module.") - elif isinstance(e, ModuleNotFoundError): - LOGGER.error("The getpass module was not found.") - elif isinstance(e, OSError): - LOGGER.error("An OS error occurred while retrieving the username.") - else: - LOGGER.error("An exception occurred:", e) - return user - def _stop_service_module(self, net_module, kill=False): LOGGER.debug('Stopping Service container ' + net_module.container_name) try: diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index 58c1944f8..4bc9fc003 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -59,7 +59,7 @@ def start(self): LOGGER.debug("Starting test orchestrator") # Setup the output directory - self._host_user = self._get_host_user() + self._host_user = util.get_host_user() os.makedirs(RUNTIME_DIR, exist_ok=True) util.run_command(f'chown -R {self._host_user} {RUNTIME_DIR}') @@ -78,19 +78,16 @@ def run_test_modules(self, device): for module in self._test_modules: self._run_test_module(module, device) LOGGER.info("All tests complete") - LOGGER.info( - f"""Completed running test \ -modules on device with mac \ -addr {device.mac_addr}""") + self._generate_results(device) self._test_in_progress = False def _generate_results(self, device): results = {} results["device"] = {} - if device.make is not None: - results["device"]["make"] = device.make - if device.make is not None: + if device.manufacturer is not None: + results["device"]["manufacturer"] = device.manufacturer + if device.model is not None: results["device"]["model"] = device.model results["device"]["mac_addr"] = device.mac_addr for module in self._test_modules: @@ -100,12 +97,12 @@ def _generate_results(self, device): device.mac_addr.replace(":", "") + "/" + module.name) results_file = f"{container_runtime_dir}/{module.name}-result.json" try: - with open(results_file, "r", encoding="UTF-8") as f: + with open(results_file, "r", encoding="utf-8-sig") as f: module_results = json.load(f) results[module.name] = module_results except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: - LOGGER.error("Error occured whilst running module " + module.name) + LOGGER.error("Error occured whilst obbtaining results for module " + module.name) LOGGER.debug(results_error) out_file = os.path.join( @@ -237,47 +234,6 @@ def _get_module_container(self, module): LOGGER.error(error) return container - def _get_host_user(self): - user = self._get_os_user() - - # If primary method failed, try secondary - if user is None: - user = self._get_user() - - LOGGER.debug("Test orchestrator host user: " + user) - return user - - def _get_os_user(self): - user = None - try: - user = os.getlogin() - except OSError as e: - # Handle the OSError exception - LOGGER.error("An OS error occurred while retrieving the login name.") - except Exception as e: - # Catch any other unexpected exceptions - LOGGER.error("An exception occurred:", e) - return user - - def _get_user(self): - user = None - try: - user = getpass.getuser() - except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: - # Handle specific exceptions individually - if isinstance(e, KeyError): - LOGGER.error("USER environment variable not set or unavailable.") - elif isinstance(e, ImportError): - LOGGER.error("Unable to import the getpass module.") - elif isinstance(e, ModuleNotFoundError): - LOGGER.error("The getpass module was not found.") - elif isinstance(e, OSError): - LOGGER.error("An OS error occurred while retrieving the username.") - else: - LOGGER.error("An exception occurred:", e) - return user - - def _load_test_modules(self): """Load network modules from module_config.json.""" LOGGER.debug("Loading test modules from /" + TEST_MODULES_DIR) @@ -296,6 +252,8 @@ def _load_test_modules(self): def _load_test_module(self, module_dir): """Import module configuration from module_config.json.""" + LOGGER.debug("Loading test module " + module_dir) + modules_dir = os.path.join(self._path, TEST_MODULES_DIR) # Load basic module information @@ -337,6 +295,7 @@ def build_test_modules(self): def _build_test_module(self, module): LOGGER.debug("Building docker image for module " + module.dir_name) + client = docker.from_env() try: client.images.build( diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index f29668bb2..5342e36f8 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -65,7 +65,6 @@ def _get_device_tests(self, device_test_module): return module_tests def _get_device_test_module(self): - # TODO: Make DEVICE_TEST_MODULES a static string if 'DEVICE_TEST_MODULES' in os.environ: test_modules = json.loads(os.environ['DEVICE_TEST_MODULES']) if self._module_name in test_modules: diff --git a/modules/test/nmap/conf/module_config.json b/modules/test/nmap/conf/module_config.json index aafde4c03..292eced8b 100644 --- a/modules/test/nmap/conf/module_config.json +++ b/modules/test/nmap/conf/module_config.json @@ -7,6 +7,7 @@ }, "network": true, "docker": { + "depends_on": "base", "enable_container": true, "timeout": 600 }, diff --git a/resources/devices/template/device_config.json b/resources/devices/template/device_config.json index 7a3d4441c..3bb804b22 100644 --- a/resources/devices/template/device_config.json +++ b/resources/devices/template/device_config.json @@ -1,5 +1,5 @@ { - "make": "Manufacturer X", + "manufacturer": "Manufacturer X", "model": "Device X", "mac_addr": "aa:bb:cc:dd:ee:ff", "test_modules": { @@ -15,9 +15,9 @@ } }, "baseline": { - "enabled": true, + "enabled": false, "tests": { - "baseline.passe": { + "baseline.non-compliant": { "enabled": true }, "baseline.pass": { @@ -74,6 +74,9 @@ "tcp_ports": { "80": { "allowed": false + }, + "443": { + "allowed": true } } }, @@ -144,4 +147,4 @@ } } } -} \ No newline at end of file +} From f185bb15018391368156b6ff0bd5753da2c1d8f6 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 29 Jun 2023 08:48:03 -0700 Subject: [PATCH 040/400] Fix missing results on udp tests when tcp ports are also defined (#59) --- modules/test/nmap/python/src/nmap_module.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/modules/test/nmap/python/src/nmap_module.py b/modules/test/nmap/python/src/nmap_module.py index ea013f413..f998f302a 100644 --- a/modules/test/nmap/python/src/nmap_module.py +++ b/modules/test/nmap/python/src/nmap_module.py @@ -153,13 +153,17 @@ def _add_unknown_ports(self,tests,unallowed_port): unknown_service = {port_style:{unallowed_port['port']:result}} tests[service_name]=unknown_service - def _check_scan_results(self, test_config,scan_results): - port_config = {} - if "tcp_ports" in test_config: - port_config.update(test_config["tcp_ports"]) - elif "udp_ports" in test_config: - port_config.update(test_config["udp_ports"]) + def _check_scan_results(self,test_config,scan_results): + if "tcp_ports" in test_config: + port_config = test_config["tcp_ports"] + self._check_scan_result(port_config=port_config,scan_results=scan_results) + if "udp_ports" in test_config: + port_config = test_config["udp_ports"] + self._check_scan_result(port_config=port_config,scan_results=scan_results) + + + def _check_scan_result(self,port_config,scan_results): if port_config is not None: for port, config in port_config.items(): result = None From 355c838112a10b1eab31f15f2db76281836b481a Mon Sep 17 00:00:00 2001 From: J Boddey Date: Mon, 3 Jul 2023 12:04:49 +0100 Subject: [PATCH 041/400] Add licence header (#61) --- cmd/install | 14 ++++++++++++++ cmd/start | 14 ++++++++++++++ modules/devices/faux-dev/bin/get_default_gateway | 14 ++++++++++++++ modules/devices/faux-dev/bin/start_dhcp_client | 14 ++++++++++++++ .../devices/faux-dev/bin/start_network_service | 14 ++++++++++++++ modules/devices/faux-dev/faux-dev.Dockerfile | 14 ++++++++++++++ modules/network/base/base.Dockerfile | 14 ++++++++++++++ modules/network/base/bin/capture | 14 ++++++++++++++ modules/network/base/bin/setup_binaries | 14 ++++++++++++++ modules/network/base/bin/start_grpc | 14 ++++++++++++++ modules/network/base/bin/start_module | 14 ++++++++++++++ modules/network/base/bin/start_network_service | 14 ++++++++++++++ modules/network/base/bin/wait_for_interface | 14 ++++++++++++++ modules/network/dhcp-1/bin/start_network_service | 14 ++++++++++++++ modules/network/dhcp-1/dhcp-1.Dockerfile | 14 ++++++++++++++ modules/network/dhcp-2/bin/start_network_service | 14 ++++++++++++++ modules/network/dhcp-2/dhcp-2.Dockerfile | 14 ++++++++++++++ modules/network/dns/bin/start_network_service | 14 ++++++++++++++ modules/network/dns/dns.Dockerfile | 14 ++++++++++++++ .../network/gateway/bin/start_network_service | 14 ++++++++++++++ modules/network/gateway/gateway.Dockerfile | 14 ++++++++++++++ modules/network/ntp/bin/start_network_service | 14 ++++++++++++++ modules/network/ntp/ntp.Dockerfile | 14 ++++++++++++++ modules/network/radius/bin/start_network_service | 14 ++++++++++++++ modules/network/radius/radius.Dockerfile | 14 ++++++++++++++ .../network/template/bin/start_network_service | 14 ++++++++++++++ modules/network/template/template.Dockerfile | 14 ++++++++++++++ modules/test/base/base.Dockerfile | 14 ++++++++++++++ modules/test/base/bin/capture | 14 ++++++++++++++ modules/test/base/bin/get_ipv4_addr | 14 ++++++++++++++ modules/test/base/bin/setup_binaries | 14 ++++++++++++++ modules/test/base/bin/start_grpc | 14 ++++++++++++++ modules/test/base/bin/start_module | 14 ++++++++++++++ modules/test/base/bin/wait_for_interface | 14 ++++++++++++++ modules/test/baseline/baseline.Dockerfile | 14 ++++++++++++++ modules/test/baseline/bin/start_test_module | 14 ++++++++++++++ modules/test/conn/bin/start_test_module | 14 ++++++++++++++ modules/test/conn/conn.Dockerfile | 14 ++++++++++++++ modules/test/dns/bin/start_test_module | 14 ++++++++++++++ modules/test/dns/dns.Dockerfile | 14 ++++++++++++++ modules/test/nmap/bin/start_test_module | 14 ++++++++++++++ modules/test/nmap/nmap.Dockerfile | 14 ++++++++++++++ testing/docker/ci_baseline/Dockerfile | 16 +++++++++++++++- testing/docker/ci_baseline/entrypoint.sh | 14 ++++++++++++++ testing/test_baseline | 15 ++++++++++++++- testing/test_pylint | 14 ++++++++++++++ 46 files changed, 645 insertions(+), 2 deletions(-) diff --git a/cmd/install b/cmd/install index 37c03e113..4e8639a66 100755 --- a/cmd/install +++ b/cmd/install @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + python3 -m venv venv source venv/bin/activate diff --git a/cmd/start b/cmd/start index 17bc2af6c..64ac197eb 100755 --- a/cmd/start +++ b/cmd/start @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + if [[ "$EUID" -ne 0 ]]; then echo "Must run as root. Use sudo cmd/start" exit 1 diff --git a/modules/devices/faux-dev/bin/get_default_gateway b/modules/devices/faux-dev/bin/get_default_gateway index f6f1e2a0d..f4d1a4a23 100644 --- a/modules/devices/faux-dev/bin/get_default_gateway +++ b/modules/devices/faux-dev/bin/get_default_gateway @@ -1,3 +1,17 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + route | grep default | awk '{print $2}' \ No newline at end of file diff --git a/modules/devices/faux-dev/bin/start_dhcp_client b/modules/devices/faux-dev/bin/start_dhcp_client index de9270c82..90362c4a4 100644 --- a/modules/devices/faux-dev/bin/start_dhcp_client +++ b/modules/devices/faux-dev/bin/start_dhcp_client @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Fetch the interface INTF=$1 diff --git a/modules/devices/faux-dev/bin/start_network_service b/modules/devices/faux-dev/bin/start_network_service index 80a587684..d4bb8a92d 100644 --- a/modules/devices/faux-dev/bin/start_network_service +++ b/modules/devices/faux-dev/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Directory where all binaries will be loaded BIN_DIR="/testrun/bin" diff --git a/modules/devices/faux-dev/faux-dev.Dockerfile b/modules/devices/faux-dev/faux-dev.Dockerfile index 0a4f02f38..ecfdfc5c2 100644 --- a/modules/devices/faux-dev/faux-dev.Dockerfile +++ b/modules/devices/faux-dev/faux-dev.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/faux-dev FROM test-run/base:latest diff --git a/modules/network/base/base.Dockerfile b/modules/network/base/base.Dockerfile index d14713c59..f8fa43c57 100644 --- a/modules/network/base/base.Dockerfile +++ b/modules/network/base/base.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/base FROM ubuntu:jammy diff --git a/modules/network/base/bin/capture b/modules/network/base/bin/capture index bc6c425e5..59ffb4118 100644 --- a/modules/network/base/bin/capture +++ b/modules/network/base/bin/capture @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Fetch module name MODULE_NAME=$1 diff --git a/modules/network/base/bin/setup_binaries b/modules/network/base/bin/setup_binaries index 3535ead3c..6af744693 100644 --- a/modules/network/base/bin/setup_binaries +++ b/modules/network/base/bin/setup_binaries @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Directory where all binaries will be loaded BIN_DIR=$1 diff --git a/modules/network/base/bin/start_grpc b/modules/network/base/bin/start_grpc index 9792b4bd4..56f915db7 100644 --- a/modules/network/base/bin/start_grpc +++ b/modules/network/base/bin/start_grpc @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + GRPC_DIR="/testrun/python/src/grpc" GRPC_PROTO_DIR="proto" GRPC_PROTO_FILE="grpc.proto" diff --git a/modules/network/base/bin/start_module b/modules/network/base/bin/start_module index 7fdcbc404..e00747b43 100644 --- a/modules/network/base/bin/start_module +++ b/modules/network/base/bin/start_module @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Directory where all binaries will be loaded BIN_DIR="/testrun/bin" diff --git a/modules/network/base/bin/start_network_service b/modules/network/base/bin/start_network_service index 7d13750b8..9cd0a70c2 100644 --- a/modules/network/base/bin/start_network_service +++ b/modules/network/base/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Place holder function for testing and validation # Each network module should include a start_networkig_service # file that overwrites this one to boot all of the its specific diff --git a/modules/network/base/bin/wait_for_interface b/modules/network/base/bin/wait_for_interface index 1377705d8..a0c8a63b8 100644 --- a/modules/network/base/bin/wait_for_interface +++ b/modules/network/base/bin/wait_for_interface @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Default interface should be veth0 for all containers DEFAULT_IFACE=veth0 diff --git a/modules/network/dhcp-1/bin/start_network_service b/modules/network/dhcp-1/bin/start_network_service index a60806684..fbeede871 100644 --- a/modules/network/dhcp-1/bin/start_network_service +++ b/modules/network/dhcp-1/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + CONFIG_FILE=/etc/dhcp/dhcpd.conf DHCP_PID_FILE=/var/run/dhcpd.pid DHCP_LOG_FILE=/runtime/network/dhcp1-dhcpd.log diff --git a/modules/network/dhcp-1/dhcp-1.Dockerfile b/modules/network/dhcp-1/dhcp-1.Dockerfile index 766f18c57..a4eb8d90a 100644 --- a/modules/network/dhcp-1/dhcp-1.Dockerfile +++ b/modules/network/dhcp-1/dhcp-1.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/dhcp-primary FROM test-run/base:latest diff --git a/modules/network/dhcp-2/bin/start_network_service b/modules/network/dhcp-2/bin/start_network_service index ad5ff09e7..550854d49 100644 --- a/modules/network/dhcp-2/bin/start_network_service +++ b/modules/network/dhcp-2/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + CONFIG_FILE=/etc/dhcp/dhcpd.conf DHCP_PID_FILE=/var/run/dhcpd.pid DHCP_LOG_FILE=/runtime/network/dhcp2-dhcpd.log diff --git a/modules/network/dhcp-2/dhcp-2.Dockerfile b/modules/network/dhcp-2/dhcp-2.Dockerfile index 231d0c558..df77cb811 100644 --- a/modules/network/dhcp-2/dhcp-2.Dockerfile +++ b/modules/network/dhcp-2/dhcp-2.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/dhcp-primary FROM test-run/base:latest diff --git a/modules/network/dns/bin/start_network_service b/modules/network/dns/bin/start_network_service index 4537033c0..98e75ccff 100644 --- a/modules/network/dns/bin/start_network_service +++ b/modules/network/dns/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + CONFIG_FILE=/etc/dnsmasq.conf PID_FILE=/var/run/dnsmasq.pid LOG_FILE=/runtime/network/dns.log diff --git a/modules/network/dns/dns.Dockerfile b/modules/network/dns/dns.Dockerfile index edfd4dd03..d59b8a391 100644 --- a/modules/network/dns/dns.Dockerfile +++ b/modules/network/dns/dns.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/dns FROM test-run/base:latest diff --git a/modules/network/gateway/bin/start_network_service b/modules/network/gateway/bin/start_network_service index b1b31d335..dc456d380 100644 --- a/modules/network/gateway/bin/start_network_service +++ b/modules/network/gateway/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + LOCAL_INTF=veth0 EXT_INTF=eth1 diff --git a/modules/network/gateway/gateway.Dockerfile b/modules/network/gateway/gateway.Dockerfile index 9bfa77dae..d15d31610 100644 --- a/modules/network/gateway/gateway.Dockerfile +++ b/modules/network/gateway/gateway.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/gateway FROM test-run/base:latest diff --git a/modules/network/ntp/bin/start_network_service b/modules/network/ntp/bin/start_network_service index b20cf8831..91129b18f 100644 --- a/modules/network/ntp/bin/start_network_service +++ b/modules/network/ntp/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + PYTHON_SRC_DIR=/testrun/python/src LOG_FILE="/runtime/network/ntp.log" diff --git a/modules/network/ntp/ntp.Dockerfile b/modules/network/ntp/ntp.Dockerfile index 1add3178e..cfd78c05e 100644 --- a/modules/network/ntp/ntp.Dockerfile +++ b/modules/network/ntp/ntp.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/ntp FROM test-run/base:latest diff --git a/modules/network/radius/bin/start_network_service b/modules/network/radius/bin/start_network_service index 399a90ae5..d285c20d9 100644 --- a/modules/network/radius/bin/start_network_service +++ b/modules/network/radius/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + PYTHON_SRC_DIR=/testrun/python/src CONF_DIR="/testrun/conf" LOG_FILE="/runtime/network/radius.log" diff --git a/modules/network/radius/radius.Dockerfile b/modules/network/radius/radius.Dockerfile index c44c5f0cc..4c8f8fac5 100644 --- a/modules/network/radius/radius.Dockerfile +++ b/modules/network/radius/radius.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/radius FROM test-run/base:latest diff --git a/modules/network/template/bin/start_network_service b/modules/network/template/bin/start_network_service index 94ae0def9..f184338a0 100644 --- a/modules/network/template/bin/start_network_service +++ b/modules/network/template/bin/start_network_service @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Place holder function for testing and validation # Each network module should include a start_networkig_service # file that overwrites this one to boot all of the its specific diff --git a/modules/network/template/template.Dockerfile b/modules/network/template/template.Dockerfile index 9efbfb230..1c3060496 100644 --- a/modules/network/template/template.Dockerfile +++ b/modules/network/template/template.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/template FROM test-run/base:latest diff --git a/modules/test/base/base.Dockerfile b/modules/test/base/base.Dockerfile index b8398eae9..9c7f2bac2 100644 --- a/modules/test/base/base.Dockerfile +++ b/modules/test/base/base.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/base-test FROM ubuntu:jammy diff --git a/modules/test/base/bin/capture b/modules/test/base/bin/capture index 45cfcd42f..69fa916c3 100644 --- a/modules/test/base/bin/capture +++ b/modules/test/base/bin/capture @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Fetch module name MODULE_NAME=$1 diff --git a/modules/test/base/bin/get_ipv4_addr b/modules/test/base/bin/get_ipv4_addr index 09a19bc13..c244b157d 100644 --- a/modules/test/base/bin/get_ipv4_addr +++ b/modules/test/base/bin/get_ipv4_addr @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + NET=$1 MAC=$2 diff --git a/modules/test/base/bin/setup_binaries b/modules/test/base/bin/setup_binaries index 3535ead3c..6af744693 100644 --- a/modules/test/base/bin/setup_binaries +++ b/modules/test/base/bin/setup_binaries @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Directory where all binaries will be loaded BIN_DIR=$1 diff --git a/modules/test/base/bin/start_grpc b/modules/test/base/bin/start_grpc index 917381e89..7852b8ae3 100644 --- a/modules/test/base/bin/start_grpc +++ b/modules/test/base/bin/start_grpc @@ -1,5 +1,19 @@ #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + GRPC_DIR="/testrun/python/src/grpc" GRPC_PROTO_DIR="proto" GRPC_PROTO_FILE="grpc.proto" diff --git a/modules/test/base/bin/start_module b/modules/test/base/bin/start_module index 3e4737d8b..5f6e1ee35 100644 --- a/modules/test/base/bin/start_module +++ b/modules/test/base/bin/start_module @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Define the local mount point to store local files to OUTPUT_DIR="/runtime/output" diff --git a/modules/test/base/bin/wait_for_interface b/modules/test/base/bin/wait_for_interface index c9c1682f0..4c336c8fb 100644 --- a/modules/test/base/bin/wait_for_interface +++ b/modules/test/base/bin/wait_for_interface @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Allow a user to define an interface by passing it into this script INTF=$1 diff --git a/modules/test/baseline/baseline.Dockerfile b/modules/test/baseline/baseline.Dockerfile index c2b32e7b7..f7d21f8c8 100644 --- a/modules/test/baseline/baseline.Dockerfile +++ b/modules/test/baseline/baseline.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/baseline-test FROM test-run/base-test:latest diff --git a/modules/test/baseline/bin/start_test_module b/modules/test/baseline/bin/start_test_module index a09349cf9..a529c2fcf 100644 --- a/modules/test/baseline/bin/start_test_module +++ b/modules/test/baseline/bin/start_test_module @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # An example startup script that does the bare minimum to start # a test module via a pyhon script. Each test module should include a # start_test_module file that overwrites this one to boot all of its diff --git a/modules/test/conn/bin/start_test_module b/modules/test/conn/bin/start_test_module index 8290c0764..0df510b86 100644 --- a/modules/test/conn/bin/start_test_module +++ b/modules/test/conn/bin/start_test_module @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Setup and start the connection test module # Define where the python source files are located diff --git a/modules/test/conn/conn.Dockerfile b/modules/test/conn/conn.Dockerfile index 2526b0046..1714f49f2 100644 --- a/modules/test/conn/conn.Dockerfile +++ b/modules/test/conn/conn.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/conn-test FROM test-run/base-test:latest diff --git a/modules/test/dns/bin/start_test_module b/modules/test/dns/bin/start_test_module index a09349cf9..a529c2fcf 100644 --- a/modules/test/dns/bin/start_test_module +++ b/modules/test/dns/bin/start_test_module @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # An example startup script that does the bare minimum to start # a test module via a pyhon script. Each test module should include a # start_test_module file that overwrites this one to boot all of its diff --git a/modules/test/dns/dns.Dockerfile b/modules/test/dns/dns.Dockerfile index f831d0e2b..b832c2afb 100644 --- a/modules/test/dns/dns.Dockerfile +++ b/modules/test/dns/dns.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/conn-test FROM test-run/base-test:latest diff --git a/modules/test/nmap/bin/start_test_module b/modules/test/nmap/bin/start_test_module index 333566342..d8cede486 100644 --- a/modules/test/nmap/bin/start_test_module +++ b/modules/test/nmap/bin/start_test_module @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # An example startup script that does the bare minimum to start # a test module via a pyhon script. Each test module should include a # start_test_module file that overwrites this one to boot all of its diff --git a/modules/test/nmap/nmap.Dockerfile b/modules/test/nmap/nmap.Dockerfile index c1a2f96ce..1789da382 100644 --- a/modules/test/nmap/nmap.Dockerfile +++ b/modules/test/nmap/nmap.Dockerfile @@ -1,3 +1,17 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # Image name: test-run/nmap-test FROM test-run/base-test:latest diff --git a/testing/docker/ci_baseline/Dockerfile b/testing/docker/ci_baseline/Dockerfile index 7c3c1eebd..468c6f7a0 100644 --- a/testing/docker/ci_baseline/Dockerfile +++ b/testing/docker/ci_baseline/Dockerfile @@ -1,6 +1,20 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + FROM ubuntu:jammy -#Update and get all additional requirements not contained in the base image +# Update and get all additional requirements not contained in the base image RUN apt-get update && apt-get -y upgrade RUN apt-get install -y isc-dhcp-client ntpdate coreutils moreutils inetutils-ping curl jq dnsutils diff --git a/testing/docker/ci_baseline/entrypoint.sh b/testing/docker/ci_baseline/entrypoint.sh index bc2da3ec2..0f3301cd8 100755 --- a/testing/docker/ci_baseline/entrypoint.sh +++ b/testing/docker/ci_baseline/entrypoint.sh @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + OUT=/out/testrun_ci.json NTP_SERVER=10.10.10.5 diff --git a/testing/test_baseline b/testing/test_baseline index 36d21fa5e..ac47a5cfa 100755 --- a/testing/test_baseline +++ b/testing/test_baseline @@ -1,6 +1,19 @@ - #!/bin/bash -e +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + TESTRUN_OUT=/tmp/testrun.log ifconfig diff --git a/testing/test_pylint b/testing/test_pylint index e3ade62b5..5cd1dff73 100755 --- a/testing/test_pylint +++ b/testing/test_pylint @@ -1,5 +1,19 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + ERROR_LIMIT=1100 sudo cmd/install From 8d653860caf4b9d954255308a38d9c1f28d19c58 Mon Sep 17 00:00:00 2001 From: Jacob Boddey Date: Mon, 3 Jul 2023 12:31:08 +0100 Subject: [PATCH 042/400] Resolve merge conflict --- modules/network/dns/dns.Dockerfile | 3 --- 1 file changed, 3 deletions(-) diff --git a/modules/network/dns/dns.Dockerfile b/modules/network/dns/dns.Dockerfile index b68129f7c..d59b8a391 100644 --- a/modules/network/dns/dns.Dockerfile +++ b/modules/network/dns/dns.Dockerfile @@ -1,4 +1,3 @@ -<<<<<<< HEAD # Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -13,8 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -======= ->>>>>>> main # Image name: test-run/dns FROM test-run/base:latest From 26f8c5b89162083a67978436a2affd10e4400b68 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Tue, 4 Jul 2023 09:32:03 +0100 Subject: [PATCH 043/400] Add network docs (#63) * Add network docs * Rename to readme * Add link to template module --- docs/network/README.md | 41 ++++++++++++++ docs/network/add_new_service.md | 94 +++++++++++++++++++++++++++++++++ docs/network/addresses.md | 18 +++++++ 3 files changed, 153 insertions(+) create mode 100644 docs/network/README.md create mode 100644 docs/network/add_new_service.md create mode 100644 docs/network/addresses.md diff --git a/docs/network/README.md b/docs/network/README.md new file mode 100644 index 000000000..2d66d3e6a --- /dev/null +++ b/docs/network/README.md @@ -0,0 +1,41 @@ +# Network Overview + +## Table of Contents +1) Network Overview (this page) +2) [Addresses](addresses.md) +3) [Add a new network service](add_new_service.md) + +Test Run provides several built-in network services that can be utilized for testing purposes. These services are already available and can be used without any additional configuration. + +The following network services are provided: + +### Internet Connectivity (Gateway Service) + +The gateway service provides internet connectivity to the test network. It allows devices in the network to access external resources and communicate with the internet. + +### DHCPv4 Service + +The DHCPv4 service provides Dynamic Host Configuration Protocol (DHCP) functionality for IPv4 addressing. It includes the following components: + +- Primary DHCP Server: A primary DHCP server is available to assign IPv4 addresses to DHCP clients in the network. +- Secondary DHCP Server (Failover Configuration): A secondary DHCP server operates in failover configuration with the primary server to provide high availability and redundancy. + +#### Configuration + +The configuration of the DHCPv4 service can be modified using the provided GRPC (gRPC Remote Procedure Call) service. + +### IPv6 SLAAC Addressing + +The primary DHCP server also provides IPv6 Stateless Address Autoconfiguration (SLAAC) addressing for devices in the network. IPv6 addresses are automatically assigned to devices using SLAAC where test devices support it. + +### NTP Service + +The Network Time Protocol (NTP) service provides time synchronization for devices in the network. It ensures that all devices have accurate and synchronized time information. + +### DNS Service + +The DNS (Domain Name System) service resolves domain names to their corresponding IP addresses. It allows devices in the network to access external resources using domain names. + +### 802.1x Authentication (Radius Module) + +The radius module provides 802.1x authentication for devices in the network. It ensures secure and authenticated access to the network. The issuing CA (Certificate Authority) certificate can be specified by the user if required. \ No newline at end of file diff --git a/docs/network/add_new_service.md b/docs/network/add_new_service.md new file mode 100644 index 000000000..1ad07b60d --- /dev/null +++ b/docs/network/add_new_service.md @@ -0,0 +1,94 @@ +# Adding a New Network Service + +The Test Run framework allows users to add their own network services with ease. A template network service can be used to get started quickly, this can be found at [modules/network/template](../../modules/network/template). Otherwise, see below for details of the requirements for new network services. + +To add a new network service to Test Run, follow the procedure below: + +1. Create a folder under `modules/network/` with the name of the network service in lowercase, using only alphanumeric characters and hyphens (`-`). +2. Inside the created folder, include the following files and folders: + - `{module}.Dockerfile`: Dockerfile for building the network service image. Replace `{module}` with the name of the module. + - `conf/`: Folder containing the module configuration files. + - `bin/`: Folder containing the startup script for the network service. + - Any additional application code can be placed in its own folder. + +### Example `module_config.json` + +```json +{ + "config": { + "meta": { + "name": "{module}", + "display_name": "Network Service Name", + "description": "Description of the network service" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 2 + }, + "grpc": { + "port": 5001 + }, + "docker": { + "depends_on": "base", + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } +} +``` + +### Example of {module}.Dockerfile + +```Dockerfile +# Image name: test-run/{module} +FROM test-run/base:latest + +ARG MODULE_NAME={module} +ARG MODULE_DIR=modules/network/$MODULE_NAME + +# Install network service dependencies +# ... + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python + +# Do not specify a CMD or Entrypoint as Test Run will automatically start your service as required +``` + +### Example of start_network_service script + +```bash +#!/bin/bash + +CONFIG_FILE=/etc/network_service/config.conf +# ... + +echo "Starting Network Service..." + +# Perform any required setup steps +# ... + +# Start the network service +# ... + +# Monitor for changes in the config file +# ... + +# Restart the network service when the config changes +# ... +``` + + + + diff --git a/docs/network/addresses.md b/docs/network/addresses.md new file mode 100644 index 000000000..ecaacfd36 --- /dev/null +++ b/docs/network/addresses.md @@ -0,0 +1,18 @@ +# Network Addresses + +Each network service is configured with an IPv4 and IPv6 address. For IPv4 addressing, the last number in the IPv4 address is fixed (ensuring the IP is unique). See below for a table of network addresses: + +| Name | Mac address | IPv4 address | IPv6 address | +|---------------------|----------------------|--------------|------------------------------| +| Internet gateway | 9a:02:57:1e:8f:01 | 10.10.10.1 | fd10:77be:4186::1 | +| DHCP primary | 9a:02:57:1e:8f:02 | 10.10.10.2 | fd10:77be:4186::2 | +| DHCP secondary | 9a:02:57:1e:8f:03 | 10.10.10.3 | fd10:77be:4186::3 | +| DNS server | 9a:02:57:1e:8f:04 | 10.10.10.4 | fd10:77be:4186::4 | +| NTP server | 9a:02:57:1e:8f:05 | 10.10.10.5 | fd10:77be:4186::5 | +| Radius authenticator| 9a:02:57:1e:8f:07 | 10.10.10.7 | fd10:77be:4186::7 | +| Active test module | 9a:02:57:1e:8f:09 | 10.10.10.9 | fd10:77be:4186::9 | + + +The default network range is 10.10.10.0/24 and devices will be assigned addresses in that range via DHCP. The range may change when requested by a test module. In which case, network services will be restarted and accessible on the new range, with the same final host ID. The default IPv6 network is fd10:77be:4186::/64 and addresses will be assigned to devices on the network using IPv6 SLAAC. + +When creating a new network module, please ensure that the ip_index value in the module_config.json is unique otherwise unexpected behaviour will occur. \ No newline at end of file From 4a5c1eaa532ba9970391c75ade52c6befb8719bd Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Wed, 5 Jul 2023 07:26:08 -0700 Subject: [PATCH 044/400] Dhcp (#64) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup --- local/system.json.example | 18 +- modules/network/base/base.Dockerfile | 4 + modules/network/base/bin/setup_python_path | 25 + modules/network/base/bin/start_grpc | 6 +- modules/network/base/bin/start_module | 12 +- modules/network/base/python/requirements.txt | 3 +- .../src/{grpc => grpc_server}/start_server.py | 0 modules/network/base/python/src/logger.py | 2 +- .../network/dhcp-1/bin/start_network_service | 2 +- modules/network/dhcp-1/conf/dhcpd.conf | 54 +- modules/network/dhcp-1/dhcp-1.Dockerfile | 8 +- .../dhcp-1/python/src/grpc/dhcp_config.py | 303 ----------- .../dhcp-1/python/src/grpc/network_service.py | 58 --- .../dhcp-1/python/src/grpc/proto/grpc.proto | 36 -- .../src/{grpc => grpc_server}/__init__.py | 0 .../python/src/grpc_server/dhcp_config.py | 493 ++++++++++++++++++ .../src/grpc_server/dhcp_config_test.py | 103 ++++ .../python/src/grpc_server/dhcp_lease.py | 75 +++ .../python/src/grpc_server/dhcp_leases.py | 107 ++++ .../python/src/grpc_server/network_service.py | 157 ++++++ .../python/src/grpc_server/proto/grpc.proto | 59 +++ .../network/dhcp-2/bin/start_network_service | 2 +- modules/network/dhcp-2/conf/dhcpd.conf | 35 +- .../dhcp-2/python/src/grpc/dhcp_config.py | 303 ----------- .../dhcp-2/python/src/grpc/network_service.py | 58 --- .../dhcp-2/python/src/grpc/proto/grpc.proto | 36 -- .../src/{grpc => grpc_server}/__init__.py | 0 .../python/src/grpc_server/dhcp_config.py | 493 ++++++++++++++++++ .../src/grpc_server/dhcp_config_test.py | 103 ++++ .../python/src/grpc_server/dhcp_lease.py | 75 +++ .../python/src/grpc_server/dhcp_leases.py | 107 ++++ .../python/src/grpc_server/network_service.py | 157 ++++++ .../python/src/grpc_server/proto/grpc.proto | 59 +++ modules/test/base/base.Dockerfile | 8 + modules/test/base/bin/setup_grpc_clients | 34 ++ modules/test/base/bin/setup_python_path | 25 + modules/test/base/bin/start_module | 17 +- .../python/src/grpc/proto/dhcp1/client.py | 98 ++++ modules/test/conn/conn.Dockerfile | 4 +- .../test/conn/python/src/connection_module.py | 29 ++ testing/test_baseline | 2 +- testing/unit_test/run_tests.sh | 18 + 42 files changed, 2326 insertions(+), 862 deletions(-) create mode 100644 modules/network/base/bin/setup_python_path rename modules/network/base/python/src/{grpc => grpc_server}/start_server.py (100%) delete mode 100644 modules/network/dhcp-1/python/src/grpc/dhcp_config.py delete mode 100644 modules/network/dhcp-1/python/src/grpc/network_service.py delete mode 100644 modules/network/dhcp-1/python/src/grpc/proto/grpc.proto rename modules/network/dhcp-1/python/src/{grpc => grpc_server}/__init__.py (100%) create mode 100644 modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py create mode 100644 modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py create mode 100644 modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py create mode 100644 modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py create mode 100644 modules/network/dhcp-1/python/src/grpc_server/network_service.py create mode 100644 modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto delete mode 100644 modules/network/dhcp-2/python/src/grpc/dhcp_config.py delete mode 100644 modules/network/dhcp-2/python/src/grpc/network_service.py delete mode 100644 modules/network/dhcp-2/python/src/grpc/proto/grpc.proto rename modules/network/dhcp-2/python/src/{grpc => grpc_server}/__init__.py (100%) create mode 100644 modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py create mode 100644 modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py create mode 100644 modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py create mode 100644 modules/network/dhcp-2/python/src/grpc_server/dhcp_leases.py create mode 100644 modules/network/dhcp-2/python/src/grpc_server/network_service.py create mode 100644 modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto create mode 100644 modules/test/base/bin/setup_grpc_clients create mode 100644 modules/test/base/bin/setup_python_path create mode 100644 modules/test/base/python/src/grpc/proto/dhcp1/client.py create mode 100644 testing/unit_test/run_tests.sh diff --git a/local/system.json.example b/local/system.json.example index ecf480104..e99e013f3 100644 --- a/local/system.json.example +++ b/local/system.json.example @@ -1,10 +1,10 @@ -{ - "network": { - "device_intf": "enx123456789123", - "internet_intf": "enx123456789124" - }, - "log_level": "INFO", - "startup_timeout": 60, - "monitor_period": 300, - "runtime": 1200 +{ + "network": { + "device_intf": "enx123456789123", + "internet_intf": "enx123456789124" + }, + "log_level": "INFO", + "startup_timeout": 60, + "monitor_period": 300, + "runtime": 1200 } \ No newline at end of file diff --git a/modules/network/base/base.Dockerfile b/modules/network/base/base.Dockerfile index f8fa43c57..ac964a99d 100644 --- a/modules/network/base/base.Dockerfile +++ b/modules/network/base/base.Dockerfile @@ -17,10 +17,14 @@ FROM ubuntu:jammy ARG MODULE_NAME=base ARG MODULE_DIR=modules/network/$MODULE_NAME +ARG COMMON_DIR=framework/python/src/common # Install common software RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix +# Install common python modules +COPY $COMMON_DIR/ /testrun/python/src/common + # Setup the base python requirements COPY $MODULE_DIR/python /testrun/python diff --git a/modules/network/base/bin/setup_python_path b/modules/network/base/bin/setup_python_path new file mode 100644 index 000000000..3e30e965d --- /dev/null +++ b/modules/network/base/bin/setup_python_path @@ -0,0 +1,25 @@ +#!/bin/bash + +ROOT_DIRECTORY="/testrun/python/src" + +# Function to recursively add subdirectories to PYTHONPATH +add_subdirectories_to_pythonpath() { + local directory=$1 + local subdirectories=( "$directory"/* ) + local subdirectory + + for subdirectory in "${subdirectories[@]}"; do + if [[ -d "$subdirectory" && ! "$subdirectory" = *'__pycache__' ]]; then + export PYTHONPATH="$PYTHONPATH:$subdirectory" + add_subdirectories_to_pythonpath "$subdirectory" + fi + done +} + +# Set PYTHONPATH initially to an empty string +export PYTHONPATH="$ROOT_DIRECTORY" + +# Add all subdirectories to PYTHONPATH +add_subdirectories_to_pythonpath "$ROOT_DIRECTORY" + +echo "$PYTHONPATH" \ No newline at end of file diff --git a/modules/network/base/bin/start_grpc b/modules/network/base/bin/start_grpc index 56f915db7..840bea65f 100644 --- a/modules/network/base/bin/start_grpc +++ b/modules/network/base/bin/start_grpc @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -GRPC_DIR="/testrun/python/src/grpc" +GRPC_DIR="/testrun/python/src/grpc_server" GRPC_PROTO_DIR="proto" GRPC_PROTO_FILE="grpc.proto" @@ -22,10 +22,10 @@ GRPC_PROTO_FILE="grpc.proto" pushd $GRPC_DIR >/dev/null 2>&1 #Build the grpc proto file every time before starting server -python3 -m grpc_tools.protoc --proto_path=. ./$GRPC_PROTO_DIR/$GRPC_PROTO_FILE --python_out=. --grpc_python_out=. +python3 -u -m grpc_tools.protoc --proto_path=. ./$GRPC_PROTO_DIR/$GRPC_PROTO_FILE --python_out=. --grpc_python_out=. popd >/dev/null 2>&1 #Start the grpc server -python3 -u $GRPC_DIR/start_server.py $@ +python3 -u $GRPC_DIR/start_server.py $@ & diff --git a/modules/network/base/bin/start_module b/modules/network/base/bin/start_module index e00747b43..6de62f1a5 100644 --- a/modules/network/base/bin/start_module +++ b/modules/network/base/bin/start_module @@ -60,10 +60,16 @@ else INTF=$DEFINED_IFACE fi -echo "Starting module $MODULE_NAME on local interface $INTF..." +# Setup the PYTHONPATH so all imports work as expected +echo "Setting up PYTHONPATH..." +export PYTHONPATH=$($BIN_DIR/setup_python_path) +echo "PYTHONPATH: $PYTHONPATH" +echo "Configuring binary files..." $BIN_DIR/setup_binaries $BIN_DIR +echo "Starting module $MODULE_NAME on local interface $INTF..." + # Wait for interface to become ready $BIN_DIR/wait_for_interface $INTF @@ -80,9 +86,9 @@ then if [[ ! -z $GRPC_PORT && ! $GRPC_PORT == "null" ]] then echo "gRPC port resolved from config: $GRPC_PORT" - $BIN_DIR/start_grpc "-p $GRPC_PORT" & + $BIN_DIR/start_grpc "-p $GRPC_PORT" else - $BIN_DIR/start_grpc & + $BIN_DIR/start_grpc fi fi diff --git a/modules/network/base/python/requirements.txt b/modules/network/base/python/requirements.txt index 9c4e2b056..9d9473d74 100644 --- a/modules/network/base/python/requirements.txt +++ b/modules/network/base/python/requirements.txt @@ -1,2 +1,3 @@ grpcio -grpcio-tools \ No newline at end of file +grpcio-tools +netifaces \ No newline at end of file diff --git a/modules/network/base/python/src/grpc/start_server.py b/modules/network/base/python/src/grpc_server/start_server.py similarity index 100% rename from modules/network/base/python/src/grpc/start_server.py rename to modules/network/base/python/src/grpc_server/start_server.py diff --git a/modules/network/base/python/src/logger.py b/modules/network/base/python/src/logger.py index 8893b1e8d..998a4aaae 100644 --- a/modules/network/base/python/src/logger.py +++ b/modules/network/base/python/src/logger.py @@ -35,7 +35,7 @@ log_level = logging.getLevelName(log_level_str) except OSError: # TODO: Print out warning that log level is incorrect or missing - LOG_LEVEL = _DEFAULT_LEVEL + log_level = _DEFAULT_LEVEL log_format = logging.Formatter(fmt=_LOG_FORMAT, datefmt=_DATE_FORMAT) diff --git a/modules/network/dhcp-1/bin/start_network_service b/modules/network/dhcp-1/bin/start_network_service index fbeede871..9f4a3dc51 100644 --- a/modules/network/dhcp-1/bin/start_network_service +++ b/modules/network/dhcp-1/bin/start_network_service @@ -20,7 +20,7 @@ DHCP_LOG_FILE=/runtime/network/dhcp1-dhcpd.log RA_PID_FILE=/var/run/radvd/radvd.pid RA_LOG_FILE=/runtime/network/dhcp1-radvd.log -echo "Starrting Network Service..." +echo "Starting Network Service..." #Enable IPv6 Forwarding sysctl net.ipv6.conf.all.forwarding=1 diff --git a/modules/network/dhcp-1/conf/dhcpd.conf b/modules/network/dhcp-1/conf/dhcpd.conf index 9f4fe1c28..ee171279c 100644 --- a/modules/network/dhcp-1/conf/dhcpd.conf +++ b/modules/network/dhcp-1/conf/dhcpd.conf @@ -1,26 +1,28 @@ -default-lease-time 300; - -failover peer "failover-peer" { - primary; - address 10.10.10.2; - port 847; - peer address 10.10.10.3; - peer port 647; - max-response-delay 60; - max-unacked-updates 10; - mclt 3600; - split 128; - load balance max seconds 3; -} - -subnet 10.10.10.0 netmask 255.255.255.0 { - option ntp-servers 10.10.10.5; - option subnet-mask 255.255.255.0; - option broadcast-address 10.10.10.255; - option routers 10.10.10.1; - option domain-name-servers 10.10.10.4; - pool { - failover peer "failover-peer"; - range 10.10.10.10 10.10.10.20; - } -} +default-lease-time 300; + +failover peer "failover-peer" { + primary; + address 10.10.10.2; + port 847; + peer address 10.10.10.3; + peer port 647; + max-response-delay 60; + max-unacked-updates 10; + mclt 3600; + split 128; + load balance max seconds 3; +} + +subnet 10.10.10.0 netmask 255.255.255.0 { + option ntp-servers 10.10.10.5; + option subnet-mask 255.255.255.0; + option broadcast-address 10.10.10.255; + option routers 10.10.10.1; + option domain-name-servers 10.10.10.4; + interface veth0; + authoritative; + pool { + failover peer "failover-peer"; + range 10.10.10.10 10.10.10.20; + } +} \ No newline at end of file diff --git a/modules/network/dhcp-1/dhcp-1.Dockerfile b/modules/network/dhcp-1/dhcp-1.Dockerfile index a4eb8d90a..b47378045 100644 --- a/modules/network/dhcp-1/dhcp-1.Dockerfile +++ b/modules/network/dhcp-1/dhcp-1.Dockerfile @@ -18,6 +18,12 @@ FROM test-run/base:latest ARG MODULE_NAME=dhcp-1 ARG MODULE_DIR=modules/network/$MODULE_NAME +# Install all necessary packages +RUN apt-get install -y wget + +#Update the oui.txt file from ieee +RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ + # Install dhcp server RUN apt-get install -y isc-dhcp-server radvd @@ -28,4 +34,4 @@ COPY $MODULE_DIR/conf /testrun/conf COPY $MODULE_DIR/bin /testrun/bin # Copy over all python files -COPY $MODULE_DIR/python /testrun/python +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/modules/network/dhcp-1/python/src/grpc/dhcp_config.py b/modules/network/dhcp-1/python/src/grpc/dhcp_config.py deleted file mode 100644 index 99d6bdebd..000000000 --- a/modules/network/dhcp-1/python/src/grpc/dhcp_config.py +++ /dev/null @@ -1,303 +0,0 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Contains all the necessary classes to maintain the -DHCP server's configuration""" -import re - -CONFIG_FILE = '/etc/dhcp/dhcpd.conf' -CONFIG_FILE_TEST = 'network/modules/dhcp-1/conf/dhcpd.conf' - -DEFAULT_LEASE_TIME_KEY = 'default-lease-time' - - -class DHCPConfig: - """Represents the DHCP Servers configuration and gives access to modify it""" - - def __init__(self): - self._default_lease_time = 300 - self.subnets = [] - self._peer = None - - def write_config(self): - conf = str(self) - print('Writing config: \n' + conf) - with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: - conf_file.write(conf) - - def resolve_config(self): - with open(CONFIG_FILE, 'r', encoding='UTF-8') as f: - conf = f.read() - self.resolve_subnets(conf) - self._peer = DHCPFailoverPeer(conf) - - def resolve_subnets(self, conf): - self.subnets = [] - regex = r'(subnet.*)' - subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) - for subnet in subnets: - dhcp_subnet = DHCPSubnet(subnet) - self.subnets.append(dhcp_subnet) - - def set_range(self, start, end, subnet=0, pool=0): - print('Setting Range for pool ') - print(self.subnets[subnet].pools[pool]) - self.subnets[subnet].pools[pool].range_start = start - self.subnets[subnet].pools[pool].range_end = end - - # def resolve_settings(self, conf): - # lines = conf.split('\n') - # for line in lines: - # if DEFAULT_LEASE_TIME_KEY in line: - # self._default_lease_time = line.strip().split( - # DEFAULT_LEASE_TIME_KEY)[1].strip().split(';')[0] - - # self.peer = peer - - def __str__(self): - - config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" - - config = config.format(length='multi-line', - DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, - DEFAULT_LEASE_TIME=self._default_lease_time) - - config += '\n\n' + str(self.peer) - for subnet in self._subnets: - config += '\n\n' + str(subnet) - return str(config) - - -FAILOVER_PEER_KEY = 'failover peer' -PRIMARY_KEY = 'primary' -ADDRESS_KEY = 'address' -PORT_KEY = 'port' -PEER_ADDRESS_KEY = 'peer address' -PEER_PORT_KEY = 'peer port' -MAX_RESPONSE_DELAY_KEY = 'max-response-delay' -MAX_UNACKED_UPDATES_KEY = 'max-unacked-updates' -MCLT_KEY = 'mclt' -SPLIT_KEY = 'split' -LOAD_BALANCE_MAX_SECONDS_KEY = 'load balance max seconds' - - -class DHCPFailoverPeer: - """Contains all information to define the DHCP failover peer""" - - def __init__(self, config): - self.name = None - self.primary = False - self.address = None - self.port = None - self.peer_address = None - self.peer_port = None - self.max_response_delay = None - self.max_unacked_updates = None - self.mclt = None - self.split = None - self.load_balance_max_seconds = None - self.peer = None - - self.resolve_peer(config) - - def __str__(self): - config = '{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n' - config += '\tprimary;' if self.primary else 'secondary;' - config += """\n\t{ADDRESS_KEY} {ADDRESS}; - {PORT_KEY} {PORT}; - {PEER_ADDRESS_KEY} {PEER_ADDRESS}; - {PEER_PORT_KEY} {PEER_PORT}; - {MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY}; - {MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES}; - {MCLT_KEY} {MCLT}; - {SPLIT_KEY} {SPLIT}; - {LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS}; - \r}}""" - - return config.format( - length='multi-line', - FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, - FAILOVER_PEER=self.name, - ADDRESS_KEY=ADDRESS_KEY, - ADDRESS=self.address, - PORT_KEY=PORT_KEY, - PORT=self.port, - PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, - PEER_ADDRESS=self.peer_address, - PEER_PORT_KEY=PEER_PORT_KEY, - PEER_PORT=self.peer_port, - MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, - MAX_RESPONSE_DELAY=self.max_response_delay, - MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, - MAX_UNACKED_UPDATES=self.max_unacked_updates, - MCLT_KEY=MCLT_KEY, - MCLT=self.mclt, - SPLIT_KEY=SPLIT_KEY, - SPLIT=self.split, - LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, - LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds) - - def resolve_peer(self, conf): - peer = '' - lines = conf.split('\n') - for line in lines: - if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: - if len(peer) <= 0: - self.name = line.strip().split(FAILOVER_PEER_KEY)[1].strip().split( - '{')[0].split('\"')[1] - peer += line + '\n' - if PRIMARY_KEY in line: - self.primary = True - elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: - self.address = line.strip().split(ADDRESS_KEY)[1].strip().split( - ';')[0] - elif PORT_KEY in line and PEER_PORT_KEY not in line: - self.port = line.strip().split(PORT_KEY)[1].strip().split(';')[0] - elif PEER_ADDRESS_KEY in line: - self.peer_address = line.strip().split( - PEER_ADDRESS_KEY)[1].strip().split(';')[0] - elif PEER_PORT_KEY in line: - self.peer_port = line.strip().split(PEER_PORT_KEY)[1].strip().split( - ';')[0] - elif MAX_RESPONSE_DELAY_KEY in line: - self.max_response_delay = line.strip().split( - MAX_RESPONSE_DELAY_KEY)[1].strip().split(';')[0] - elif MAX_UNACKED_UPDATES_KEY in line: - self.max_unacked_updates = line.strip().split( - MAX_UNACKED_UPDATES_KEY)[1].strip().split(';')[0] - elif MCLT_KEY in line: - self.mclt = line.strip().split(MCLT_KEY)[1].strip().split(';')[0] - elif SPLIT_KEY in line: - self.split = line.strip().split(SPLIT_KEY)[1].strip().split(';')[0] - elif LOAD_BALANCE_MAX_SECONDS_KEY in line: - self.load_balance_max_seconds = line.strip().split( - LOAD_BALANCE_MAX_SECONDS_KEY)[1].strip().split(';')[0] - if line.endswith('}') and len(peer) > 0: - break - self.peer = peer - - -NTP_OPTION_KEY = 'option ntp-servers' -SUBNET_MASK_OPTION_KEY = 'option subnet-mask' -BROADCAST_OPTION_KEY = 'option broadcast-address' -ROUTER_OPTION_KEY = 'option routers' -DNS_OPTION_KEY = 'option domain-name-servers' - - -class DHCPSubnet: - """Represents the DHCP Servers subnet configuration""" - - def __init__(self, subnet): - self._ntp_servers = None - self._subnet_mask = None - self._broadcast = None - self._routers = None - self._dns_servers = None - self.pools = [] - - self.resolve_subnet(subnet) - self.resolve_pools(subnet) - - def __str__(self): - config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ - \r\t{NTP_OPTION_KEY} {NTP_OPTION}; - \r\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION}; - \r\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION}; - \r\t{ROUTER_OPTION_KEY} {ROUTER_OPTION}; - \r\t{DNS_OPTION_KEY} {DNS_OPTION};""" - - config = config.format(length='multi-line', - NTP_OPTION_KEY=NTP_OPTION_KEY, - NTP_OPTION=self._ntp_servers, - SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, - SUBNET_MASK_OPTION=self._subnet_mask, - BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, - BROADCAST_OPTION=self._broadcast, - ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, - ROUTER_OPTION=self._routers, - DNS_OPTION_KEY=DNS_OPTION_KEY, - DNS_OPTION=self._dns_servers) - for pool in self.pools: - config += '\n\t' + str(pool) - - config += '\n\r}' - return config - - def resolve_subnet(self, subnet): - subnet_parts = subnet.split('\n') - for part in subnet_parts: - if NTP_OPTION_KEY in part: - self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[1].strip().split( - ';')[0] - elif SUBNET_MASK_OPTION_KEY in part: - self._subnet_mask = part.strip().split( - SUBNET_MASK_OPTION_KEY)[1].strip().split(';')[0] - elif BROADCAST_OPTION_KEY in part: - self._broadcast = part.strip().split( - BROADCAST_OPTION_KEY)[1].strip().split(';')[0] - elif ROUTER_OPTION_KEY in part: - self._routers = part.strip().split(ROUTER_OPTION_KEY)[1].strip().split( - ';')[0] - elif DNS_OPTION_KEY in part: - self._dns_servers = part.strip().split(DNS_OPTION_KEY)[1].strip().split( - ';')[0] - - def resolve_pools(self, subnet): - regex = r'(pool.*)\}' - pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) - for pool in pools: - dhcp_pool = DHCPPool(pool) - self.pools.append(dhcp_pool) - - -FAILOVER_KEY = 'failover peer' -RANGE_KEY = 'range' - - -class DHCPPool: - """Represents a DHCP Servers subnet pool configuration""" - - def __init__(self, pool): - self.failover_peer = None - self.range_start = None - self.range_end = None - self.resolve_pool(pool) - - def __str__(self): - - config = """pool {{ - \r\t\t{FAILOVER_KEY} "{FAILOVER}"; - \r\t\t{RANGE_KEY} {RANGE_START} {RANGE_END}; - \r\t}}""" - - return config.format( - length='multi-line', - FAILOVER_KEY=FAILOVER_KEY, - FAILOVER=self.failover_peer, - RANGE_KEY=RANGE_KEY, - RANGE_START=self.range_start, - RANGE_END=self.range_end, - ) - - def resolve_pool(self, pool): - pool_parts = pool.split('\n') - # pool_parts = pool.split("\n") - for part in pool_parts: - if FAILOVER_KEY in part: - self.failover_peer = part.strip().split(FAILOVER_KEY)[1].strip().split( - ';')[0].replace('\"', '') - if RANGE_KEY in part: - pool_range = part.strip().split(RANGE_KEY)[1].strip().split(';')[0] - self.range_start = pool_range.split(' ')[0].strip() - self.range_end = pool_range.split(' ')[1].strip() diff --git a/modules/network/dhcp-1/python/src/grpc/network_service.py b/modules/network/dhcp-1/python/src/grpc/network_service.py deleted file mode 100644 index 64aab8a07..000000000 --- a/modules/network/dhcp-1/python/src/grpc/network_service.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""gRPC Network Service for the DHCP Server network module""" -import proto.grpc_pb2_grpc as pb2_grpc -import proto.grpc_pb2 as pb2 - -from dhcp_config import DHCPConfig - - -class NetworkService(pb2_grpc.NetworkModule): - """gRPC endpoints for the DHCP Server""" - - def __init__(self): - self._dhcp_config = DHCPConfig() - - def GetDHCPRange(self, request, context): # pylint: disable=W0613 - """ - Resolve the current DHCP configuration and return - the first range from the first subnet in the file - """ - self._dhcp_config.resolve_config() - pool = self._dhcp_config.subnets[0].pools[0] - return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) - - def SetDHCPRange(self, request, context): # pylint: disable=W0613 - """ - Change DHCP configuration and set the - the first range from the first subnet in the configuration - """ - - print('Setting DHCPRange') - print('Start: ' + request.start) - print('End: ' + request.end) - self._dhcp_config.resolve_config() - self._dhcp_config.set_range(request.start, request.end, 0, 0) - self._dhcp_config.write_config() - return pb2.Response(code=200, message='DHCP Range Set') - - def GetStatus(self, request, context): # pylint: disable=W0613 - """ - Return the current status of the network module - """ - # ToDo: Figure out how to resolve the current DHCP status - dhcp_status = True - message = str({'dhcpStatus': dhcp_status}) - return pb2.Response(code=200, message=message) diff --git a/modules/network/dhcp-1/python/src/grpc/proto/grpc.proto b/modules/network/dhcp-1/python/src/grpc/proto/grpc.proto deleted file mode 100644 index 8e2732620..000000000 --- a/modules/network/dhcp-1/python/src/grpc/proto/grpc.proto +++ /dev/null @@ -1,36 +0,0 @@ -syntax = "proto3"; - -service NetworkModule { - - rpc GetDHCPRange(GetDHCPRangeRequest) returns (DHCPRange) {}; - - rpc SetDHCPRange(DHCPRange) returns (Response) {}; - - rpc GetStatus(GetStatusRequest) returns (Response) {}; - - rpc GetIPAddress(GetIPAddressRequest) returns (Response) {}; - - rpc SetLeaseAddress(SetLeaseAddressRequest) returns (Response) {}; - -} - -message Response { - int32 code = 1; - string message = 2; -} - -message DHCPRange { - int32 code = 1; - string start = 2; - string end = 3; -} - -message GetDHCPRangeRequest {} - -message GetIPAddressRequest {} - -message GetStatusRequest {} - -message SetLeaseAddressRequest { - string ipAddress = 1; -} \ No newline at end of file diff --git a/modules/network/dhcp-1/python/src/grpc/__init__.py b/modules/network/dhcp-1/python/src/grpc_server/__init__.py similarity index 100% rename from modules/network/dhcp-1/python/src/grpc/__init__.py rename to modules/network/dhcp-1/python/src/grpc_server/__init__.py diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py new file mode 100644 index 000000000..444faa87c --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py @@ -0,0 +1,493 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +DHCP server's configuration""" +import re +from common import logger + +LOG_NAME = 'dhcp_config' +LOGGER = None + +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' + +DEFAULT_LEASE_TIME_KEY = 'default-lease-time' + + +class DHCPConfig: + """Represents the DHCP Servers configuration and gives access to modify it""" + + def __init__(self): + self._default_lease_time = 300 + self._subnets = [] + self._peer = None + self._reserved_hosts = [] + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + + def add_reserved_host(self, hostname, hw_addr, ip_addr): + host = DHCPReservedHost(hostname=hostname, + hw_addr=hw_addr, + fixed_addr=ip_addr) + self._reserved_hosts.append(host) + + def delete_reserved_host(self, hw_addr): + for host in self._reserved_hosts: + if hw_addr == host.hw_addr: + self._reserved_hosts.remove(host) + + def disable_failover(self): + self._peer.disable() + for subnet in self._subnets: + subnet.disable_peer() + + def enable_failover(self): + self._peer.enable() + for subnet in self._subnets: + subnet.enable_peer() + + def get_reserved_host(self, hw_addr): + for host in self._reserved_hosts: + if hw_addr == host.hw_addr: + return host + + def write_config(self, config=None): + if config is None: + conf = str(self) + with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: + conf_file.write(conf) + else: + with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: + conf_file.write(config) + + def _get_config(self, config_file=CONFIG_FILE): + content = None + with open(config_file, 'r', encoding='UTF-8') as f: + content = f.read() + return content + + def make(self, conf): + try: + self._subnets = self.resolve_subnets(conf) + self._peer = DHCPFailoverPeer(conf) + self._reserved_hosts = self.resolve_reserved_hosts(conf) + except Exception as e: # pylint: disable=W0718 + print('Failed to make DHCPConfig: ' + str(e)) + + def resolve_config(self, config_file=CONFIG_FILE): + try: + conf = self._get_config(config_file) + self._subnets = self.resolve_subnets(conf) + self._peer = DHCPFailoverPeer(conf) + self._reserved_hosts = self.resolve_reserved_hosts(conf) + except Exception as e: # pylint: disable=W0718 + print('Failed to resolve config: ' + str(e)) + + def resolve_subnets(self, conf): + subnets = [] + regex = r'(subnet.*)' + subnets_conf = re.findall(regex, conf, re.MULTILINE | re.DOTALL) + for subnet in subnets_conf: + dhcp_subnet = DHCPSubnet(subnet) + subnets.append(dhcp_subnet) + return subnets + + def resolve_reserved_hosts(self, conf): + hosts = [] + host_start = 0 + while True: + host_start = conf.find('host', host_start) + if host_start < 0: + break + else: + host_end = conf.find('}', host_start) + host = DHCPReservedHost(config=conf[host_start:host_end + 1]) + hosts.append(host) + host_start = host_end + 1 + return hosts + + def set_range(self, start, end, subnet=0, pool=0): + # Calculate the subnet from the range + octets = start.split('.') + octets[-1] = '0' + dhcp_subnet = '.'.join(octets) + + #Update the subnet and range + self._subnets[subnet].set_subnet(dhcp_subnet) + self._subnets[subnet].pools[pool].set_range(start, end) + + def __str__(self): + + # Encode the top level config options + config = """{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + config = config.format(length='multi-line', + DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, + DEFAULT_LEASE_TIME=self._default_lease_time) + + # Encode the failover peer + config += '\n\n' + str(self._peer) + + # Encode the subnets + for subnet in self._subnets: + config += '\n\n' + str(subnet) + + # Encode the reserved hosts + for host in self._reserved_hosts: + config += '\n' + str(host) + + return str(config) + + +FAILOVER_PEER_KEY = 'failover peer' +PRIMARY_KEY = 'primary' +ADDRESS_KEY = 'address' +PORT_KEY = 'port' +PEER_ADDRESS_KEY = 'peer address' +PEER_PORT_KEY = 'peer port' +MAX_RESPONSE_DELAY_KEY = 'max-response-delay' +MAX_UNACKED_UPDATES_KEY = 'max-unacked-updates' +MCLT_KEY = 'mclt' +SPLIT_KEY = 'split' +LOAD_BALANCE_MAX_SECONDS_KEY = 'load balance max seconds' + + +class DHCPFailoverPeer: + """Contains all information to define the DHCP failover peer""" + + def __init__(self, config): + self.name = None + self.primary = False + self.address = None + self.port = None + self.peer_address = None + self.peer_port = None + self.max_response_delay = None + self.max_unacked_updates = None + self.mclt = None + self.split = None + self.load_balance_max_seconds = None + self.peer = None + self.enabled = True + + self.resolve_peer(config) + + def __str__(self): + config = '{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n' + config += '\tprimary;' if self.primary else 'secondary;' + config += '\n\t{ADDRESS_KEY} {ADDRESS};' if self.address is not None else '' + config += '\n\t{PORT_KEY} {PORT};' if self.port is not None else '' + config += '\n\t{PEER_ADDRESS_KEY} {PEER_ADDRESS};' if self.peer_address is not None else '' + config += '\n\t{PEER_PORT_KEY} {PEER_PORT};' if self.peer_port is not None else '' + config += '\n\t{MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY};' if self.max_response_delay is not None else '' + config += '\n\t{MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES};' if self.max_unacked_updates is not None else '' + config += '\n\t{MCLT_KEY} {MCLT};' if self.mclt is not None else '' + config += '\n\t{SPLIT_KEY} {SPLIT};' if self.split is not None else '' + config += '\n\t{LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS};' if self.load_balance_max_seconds is not None else '' + config += '\n\r}}' + + config = config.format( + length='multi-line', + FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, + FAILOVER_PEER=self.name, + ADDRESS_KEY=ADDRESS_KEY, + ADDRESS=self.address, + PORT_KEY=PORT_KEY, + PORT=self.port, + PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, + PEER_ADDRESS=self.peer_address, + PEER_PORT_KEY=PEER_PORT_KEY, + PEER_PORT=self.peer_port, + MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, + MAX_RESPONSE_DELAY=self.max_response_delay, + MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, + MAX_UNACKED_UPDATES=self.max_unacked_updates, + MCLT_KEY=MCLT_KEY, + MCLT=self.mclt, + SPLIT_KEY=SPLIT_KEY, + SPLIT=self.split, + LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, + LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds) + + if not self.enabled: + lines = config.strip().split('\n') + for i in range(len(lines)-1): + lines[i] = '#' + lines[i] + lines[-1] = '#' + lines[-1].strip() # Handle the last line separately + config = '\n'.join(lines) + + return config + + def disable(self): + self.enabled = False + + def enable(self): + self.enabled = True + + def resolve_peer(self, conf): + peer = '' + lines = conf.split('\n') + for line in lines: + if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: + if len(peer) <= 0: + self.name = line.strip().split(FAILOVER_PEER_KEY)[1].strip().split( + '{')[0].split('\"')[1] + peer += line + '\n' + if PRIMARY_KEY in line: + self.primary = True + elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: + self.address = line.strip().split(ADDRESS_KEY)[1].strip().split( + ';')[0] + elif PORT_KEY in line and PEER_PORT_KEY not in line: + self.port = line.strip().split(PORT_KEY)[1].strip().split(';')[0] + elif PEER_ADDRESS_KEY in line: + self.peer_address = line.strip().split( + PEER_ADDRESS_KEY)[1].strip().split(';')[0] + elif PEER_PORT_KEY in line: + self.peer_port = line.strip().split(PEER_PORT_KEY)[1].strip().split( + ';')[0] + elif MAX_RESPONSE_DELAY_KEY in line: + self.max_response_delay = line.strip().split( + MAX_RESPONSE_DELAY_KEY)[1].strip().split(';')[0] + elif MAX_UNACKED_UPDATES_KEY in line: + self.max_unacked_updates = line.strip().split( + MAX_UNACKED_UPDATES_KEY)[1].strip().split(';')[0] + elif MCLT_KEY in line: + self.mclt = line.strip().split(MCLT_KEY)[1].strip().split(';')[0] + elif SPLIT_KEY in line: + self.split = line.strip().split(SPLIT_KEY)[1].strip().split(';')[0] + elif LOAD_BALANCE_MAX_SECONDS_KEY in line: + self.load_balance_max_seconds = line.strip().split( + LOAD_BALANCE_MAX_SECONDS_KEY)[1].strip().split(';')[0] + if line.endswith('}') and len(peer) > 0: + break + self.peer = peer + + +SUBNET_KEY = 'subnet' +NTP_OPTION_KEY = 'option ntp-servers' +SUBNET_MASK_OPTION_KEY = 'option subnet-mask' +BROADCAST_OPTION_KEY = 'option broadcast-address' +ROUTER_OPTION_KEY = 'option routers' +DNS_OPTION_KEY = 'option domain-name-servers' +INTERFACE_KEY = 'interface' +AUTHORITATIVE_KEY = 'authoritative' + + +class DHCPSubnet: + """Represents the DHCP Servers subnet configuration""" + + def __init__(self, subnet): + self._authoritative = False + self._subnet = None + self._ntp_servers = None + self._subnet_mask = None + self._broadcast = None + self._routers = None + self._dns_servers = None + self._interface = None + self.pools = [] + + self.resolve_subnet(subnet) + self.resolve_pools(subnet) + + def __str__(self): + config = 'subnet {SUBNET_OPTION} netmask {SUBNET_MASK_OPTION} {{' + config += '\n\t{NTP_OPTION_KEY} {NTP_OPTION};' if self._ntp_servers is not None else '' + config += '\n\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION};' if self._subnet_mask is not None else '' + config += '\n\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION};' if self._broadcast is not None else '' + config += '\n\t{ROUTER_OPTION_KEY} {ROUTER_OPTION};' if self._routers is not None else '' + config += '\n\t{DNS_OPTION_KEY} {DNS_OPTION};' if self._dns_servers is not None else '' + config += '\n\t{INTERFACE_KEY} {INTERFACE_OPTION};' if self._interface is not None else '' + config += '\n\t{AUTHORITATIVE_KEY};' if self._authoritative else '' + + + config = config.format(length='multi-line', + SUBNET_OPTION=self._subnet, + NTP_OPTION_KEY=NTP_OPTION_KEY, + NTP_OPTION=self._ntp_servers, + SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, + SUBNET_MASK_OPTION=self._subnet_mask, + BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, + BROADCAST_OPTION=self._broadcast, + ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, + ROUTER_OPTION=self._routers, + DNS_OPTION_KEY=DNS_OPTION_KEY, + DNS_OPTION=self._dns_servers, + INTERFACE_KEY=INTERFACE_KEY, + INTERFACE_OPTION=self._interface, + AUTHORITATIVE_KEY=AUTHORITATIVE_KEY) + + # if not self._authoritative: + # config = config.replace(AUTHORITATIVE_KEY, '#' + AUTHORITATIVE_KEY) + + for pool in self.pools: + config += '\n\t' + str(pool) + + config += '\n}' + return config + + def disable_peer(self): + for pool in self.pools: + pool.disable_peer() + + def enable_peer(self): + for pool in self.pools: + pool.enable_peer() + + def set_subnet(self, subnet, netmask=None): + if netmask is None: + netmask = '255.255.255.0' + self._subnet = subnet + self._subnet_mask = netmask + + # Calculate the broadcast from the subnet + octets = subnet.split('.') + octets[-1] = '255' + dhcp_broadcast = '.'.join(octets) + + self._broadcast = dhcp_broadcast + + def resolve_subnet(self, subnet): + subnet_parts = subnet.split('\n') + for part in subnet_parts: + if part.strip().startswith(SUBNET_KEY): + self._subnet = part.strip().split()[1] + elif NTP_OPTION_KEY in part: + self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[1].strip().split( + ';')[0] + elif SUBNET_MASK_OPTION_KEY in part: + self._subnet_mask = part.strip().split( + SUBNET_MASK_OPTION_KEY)[1].strip().split(';')[0] + elif BROADCAST_OPTION_KEY in part: + self._broadcast = part.strip().split( + BROADCAST_OPTION_KEY)[1].strip().split(';')[0] + elif ROUTER_OPTION_KEY in part: + self._routers = part.strip().split(ROUTER_OPTION_KEY)[1].strip().split( + ';')[0] + elif DNS_OPTION_KEY in part: + self._dns_servers = part.strip().split(DNS_OPTION_KEY)[1].strip().split( + ';')[0] + elif INTERFACE_KEY in part: + self._interface = part.strip().split(INTERFACE_KEY)[1].strip().split( + ';')[0] + elif AUTHORITATIVE_KEY in part: + self._authoritative = True + + def resolve_pools(self, subnet): + regex = r'(pool.*)\}' + pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) + for pool in pools: + dhcp_pool = DHCPPool(pool) + self.pools.append(dhcp_pool) + + +FAILOVER_KEY = 'failover peer' +RANGE_KEY = 'range' + + +class DHCPPool: + """Represents a DHCP Servers subnet pool configuration""" + + def __init__(self, pool): + self.failover_peer = None + self.range_start = None + self.range_end = None + self.resolve_pool(pool) + self._peer_enabled = True + + def __str__(self): + config = 'pool {{' + config += '\n\t\t{FAILOVER_KEY} "{FAILOVER}";' if self.failover_peer is not None else '' + config += '\n\t\t{RANGE_KEY} {RANGE_START} {RANGE_END};' if self.range_start is not None and self.range_end is not None else '' + config += '\n\t}}' + + config = config.format( + length='multi-line', + FAILOVER_KEY=FAILOVER_KEY, + FAILOVER=self.failover_peer, + RANGE_KEY=RANGE_KEY, + RANGE_START=self.range_start, + RANGE_END=self.range_end, + ) + + if not self._peer_enabled: + config = config.replace(FAILOVER_KEY, '#' + FAILOVER_KEY) + + return config + + def disable_peer(self): + self._peer_enabled = False + + def enable_peer(self): + self._peer_enabled = True + + def set_range(self, start, end): + self.range_start = start + self.range_end = end + + def resolve_pool(self, pool): + pool_parts = pool.split('\n') + for part in pool_parts: + if FAILOVER_KEY in part: + self.failover_peer = part.strip().split(FAILOVER_KEY)[1].strip().split( + ';')[0].replace('\"', '') + if RANGE_KEY in part: + pool_range = part.strip().split(RANGE_KEY)[1].strip().split(';')[0] + self.range_start = pool_range.split(' ')[0].strip() + self.range_end = pool_range.split(' ')[1].strip() + + +HOST_KEY = 'host' +HARDWARE_KEY = 'hardware ethernet' +FIXED_ADDRESS_KEY = 'fixed-address' + + +class DHCPReservedHost: + """Represents a DHCP Servers subnet pool configuration""" + + def __init__(self, hostname=None, hw_addr=None, fixed_addr=None, config=None): + if config is None: + self.host = hostname + self.hw_addr = hw_addr + self.fixed_addr = fixed_addr + else: + self.resolve_host(config) + + def __str__(self): + + config = """{HOST_KEY} {HOSTNAME} {{ + \r\t{HARDWARE_KEY} {HW_ADDR}; + \r\t{FIXED_ADDRESS_KEY} {RESERVED_IP}; + \r}}""" + + config = config.format( + length='multi-line', + HOST_KEY=HOST_KEY, + HOSTNAME=self.host, + HARDWARE_KEY=HARDWARE_KEY, + HW_ADDR=self.hw_addr, + FIXED_ADDRESS_KEY=FIXED_ADDRESS_KEY, + RESERVED_IP=self.fixed_addr, + ) + return config + + def resolve_host(self, reserved_host): + host_parts = reserved_host.split('\n') + for part in host_parts: + if HOST_KEY in part: + self.host = part.strip().split(HOST_KEY)[1].strip().split('{')[0] + elif HARDWARE_KEY in part: + self.hw_addr = part.strip().split(HARDWARE_KEY)[1].strip().split(';')[0] + elif FIXED_ADDRESS_KEY in part: + self.fixed_addr = part.strip().split( + FIXED_ADDRESS_KEY)[1].strip().split(';')[0] diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py new file mode 100644 index 000000000..2cc78403a --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py @@ -0,0 +1,103 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Unit Testing for the DHCP Server config""" +import unittest +from dhcp_config import DHCPConfig +import os + +CONFIG_FILE = 'conf/dhcpd.conf' + +DHCP_CONFIG = None + +def get_config_file_path(): + dhcp_config = DHCPConfig() + current_dir = os.path.dirname(os.path.abspath(__file__)) + module_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(current_dir)))) + conf_file = os.path.join(module_dir,CONFIG_FILE) + return conf_file + +def get_config(): + dhcp_config = DHCPConfig() + dhcp_config.resolve_config(get_config_file_path()) + return dhcp_config + +class DHCPConfigTest(unittest.TestCase): + + @classmethod + def setUpClass(cls): + # Resolve the config + global DHCP_CONFIG + DHCP_CONFIG = get_config() + + def test_resolve_config(self): + print('Test Resolve Config:\n' + str(DHCP_CONFIG)) + + # Resolve the raw config file + with open(get_config_file_path(),'r') as f: + lines = f.readlines() + + # Get the resolved config as a + conf_parts = str(DHCP_CONFIG).split('\n') + + # dhcpd conf is not picky about spacing so we just + # need to check contents of each line for matching + # to make sure evertying matches + for i in range(len(lines)): + self.assertEqual(lines[i].strip(),conf_parts[i].strip()) + + def test_disable_failover(self): + DHCP_CONFIG.disable_failover() + print('Test Disable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertTrue(line.startswith('#')) + + def test_enable_failover(self): + DHCP_CONFIG.enable_failover() + print('Test Enable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertFalse(line.startswith('#')) + + def test_add_reserved_host(self): + DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print('AddHostConfig:\n' + str(DHCP_CONFIG)) + + def test_delete_reserved_host(self): + DHCP_CONFIG.delete_reserved_host('00:11:22:33:44:55') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNone(host) + print('DeleteHostConfig:\n' + str(DHCP_CONFIG)) + + def test_resolve_config_with_hosts(self): + DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') + config_with_hosts = DHCPConfig() + config_with_hosts.make(str(DHCP_CONFIG)) + host = config_with_hosts.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print("ResolveConfigWithHosts:\n" + str(config_with_hosts)) + +if __name__ == '__main__': + suite = unittest.TestSuite() + suite.addTest(DHCPConfigTest('test_resolve_config')) + suite.addTest(DHCPConfigTest('test_disable_failover')) + suite.addTest(DHCPConfigTest('test_enable_failover')) + suite.addTest(DHCPConfigTest('test_add_reserved_host')) + suite.addTest(DHCPConfigTest('test_delete_reserved_host')) + suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) + + runner = unittest.TextTestRunner() + runner.run(suite) \ No newline at end of file diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py new file mode 100644 index 000000000..0d2f43e3b --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py @@ -0,0 +1,75 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary methods to create and monitor DHCP +leases on the server""" +from datetime import datetime +import time + +time_format = '%Y-%m-%d %H:%M:%S' + + +class DHCPLease(object): + """Represents a DHCP Server lease""" + hw_addr = None + ip = None + hostname = None + expires = None + + def __init__(self, lease): + self._make_lease(lease) + + def _make_lease(self, lease): + if lease is not None: + sections_raw = lease.split(' ') + sections = [] + for section in sections_raw: + if section.strip(): + sections.append(section) + self.hw_addr = sections[0] + self.ip = sections[1] + self.hostname = sections[2] + self.expires = sections[3] + '' '' + sections[4] + self.manufacturer = ' '.join(sections[5:]) + + def get_millis(self, timestamp): + dt_obj = datetime.strptime(timestamp, time_format) + millis = dt_obj.timestamp() * 1000 + return millis + + def get_expires_millis(self): + return self.get_millis(self.expires) + + def is_expired(self): + expires_millis = self.get_expires_millis() + cur_time = int(round(time.time()) * 1000) + return cur_time >= expires_millis + + def __str__(self): + lease = {} + if self.hw_addr is not None: + lease['hw_addr'] = self.hw_addr + + if self.ip is not None: + lease['ip'] = self.ip + + if self.hostname is not None: + lease['hostname'] = self.hostname + + if self.expires is not None: + lease['expires'] = self.expires + + if self.manufacturer is not None: + lease['manufacturer'] = self.manufacturer + + return str(lease) diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py new file mode 100644 index 000000000..698277a02 --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py @@ -0,0 +1,107 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Used to resolve the DHCP servers lease information""" +import os +from dhcp_lease import DHCPLease +import logger +from common import util + +LOG_NAME = 'dhcp_lease' +LOGGER = None + +DHCP_LEASE_FILES = [ + '/var/lib/dhcp/dhcpd.leases', '/var/lib/dhcp/dhcpd.leases~', + '/var/lib/dhcp/dhcpd6.leases', '/var/lib/dhcp/dhcpd6.leases~' +] +DHCP_CONFIG_FILE = '/etc/dhcp/dhcpd.conf' + + +class DHCPLeases: + """Leases for the DHCP server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + + def delete_all_hosts(self): + LOGGER.info('Deleting hosts') + for lease in DHCP_LEASE_FILES: + LOGGER.info('Checking file: ' + lease) + if os.path.exists(lease): + LOGGER.info('File Exists: ' + lease) + try: + # Delete existing lease file + os.remove(lease) + except OSError as e: + LOGGER.info(f'Error occurred while deleting the file: {e}') + # Create an empty lease file + with open(lease, 'w', encoding='UTF-8'): + pass + + def get_lease(self, hw_addr): + for lease in self.get_leases(): + if lease.hw_addr == hw_addr: + return lease + + def get_leases(self): + leases = [] + lease_list_raw = self._get_lease_list() + LOGGER.info('Raw Leases:\n' + str(lease_list_raw) + '\n') + lease_list_start = lease_list_raw.find('=========',0) + lease_list_start = lease_list_raw.find('\n',lease_list_start) + lease_list = lease_list_raw[lease_list_start+1:] + lines = lease_list.split('\n') + for line in lines: + try: + lease = DHCPLease(line) + leases.append(lease) + except Exception as e: # pylint: disable=W0718 + # Let non lease lines file without extra checks + LOGGER.error('Making Lease Error: ' + str(e)) + LOGGER.error('Not a valid lease line: ' + line) + return leases + + def delete_lease(self, ip_addr): + LOGGER.info('Deleting lease') + for lease in DHCP_LEASE_FILES: + LOGGER.info('Checking file: ' + lease) + if os.path.exists(lease): + LOGGER.info('File Exists: ' + lease) + try: + # Delete existing lease file + with (open(lease, 'r', encoding='UTF-8')) as f: + contents = f.read() + + while ip_addr in contents: + ix_ip = contents.find(ip_addr) + lease_start = contents.rindex('lease', 0, ix_ip) + lease_end = contents.find('}', lease_start) + LOGGER.info('Lease Location: ' + str(lease_start) + ':' + + str(lease_end)) + contents = contents[0:lease_start] + contents[lease_end + 1:] + + except OSError as e: + LOGGER.info(f'Error occurred while deleting the lease: {e}') + + def _get_lease_list(self): + LOGGER.info('Running lease list command') + try: + result = util.run_command('dhcp-lease-list') + return result[0] + except Exception as e: # pylint: disable=W0718 + LOGGER.error('Error lease list: ' + str(e)) + + def _write_config(self, config): + with open(DHCP_CONFIG_FILE, 'w', encoding='UTF-8') as f: + f.write(config) diff --git a/modules/network/dhcp-1/python/src/grpc_server/network_service.py b/modules/network/dhcp-1/python/src/grpc_server/network_service.py new file mode 100644 index 000000000..bf2b98803 --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/network_service.py @@ -0,0 +1,157 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""gRPC Network Service for the DHCP Server network module""" +import proto.grpc_pb2_grpc as pb2_grpc +import proto.grpc_pb2 as pb2 + +from dhcp_config import DHCPConfig +from dhcp_leases import DHCPLeases + +import traceback +from common import logger + +LOG_NAME = 'network_service' +LOGGER = None + +class NetworkService(pb2_grpc.NetworkModule): + """gRPC endpoints for the DHCP Server""" + + def __init__(self): + self._dhcp_config = None + self.dhcp_leases = DHCPLeases() + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + + def _get_dhcp_config(self): + if self._dhcp_config is None: + self._dhcp_config = DHCPConfig() + self._dhcp_config.resolve_config() + return self._dhcp_config + + def AddReservedLease(self, request, context): # pylint: disable=W0613 + LOGGER.info('Add reserved lease called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.add_reserved_host(request.hostname, request.hw_addr, + request.ip_addr) + dhcp_config.write_config() + LOGGER.info('Reserved lease added') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to add reserved lease: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def DeleteReservedLease(self, request, context): # pylint: disable=W0613 + LOGGER.info('Delete reserved lease called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.delete_reserved_host(request.hw_addr) + dhcp_config.write_config() + LOGGER.info('Reserved lease deleted') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to delete reserved lease: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def DisableFailover(self, request, contest): # pylint: disable=W0613 + LOGGER.info('Disable failover called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.disable_failover() + dhcp_config.write_config() + LOGGER.info('Failover disabled') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to disable failover: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def EnableFailover(self, request, contest): # pylint: disable=W0613 + LOGGER.info('Enable failover called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.enable_failover() + dhcp_config.write_config() + LOGGER.info('Failover enabled') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to enable failover: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def GetDHCPRange(self, request, context): # pylint: disable=W0613 + """ + Resolve the current DHCP configuration and return + the first range from the first subnet in the file + """ + LOGGER.info('Get DHCP range called') + try: + pool = self._get_dhcp_config()._subnets[0].pools[0] + return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to get DHCP range: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def GetLease(self, request, context): # pylint: disable=W0613 + """ + Resolve the current DHCP leased address for the + provided MAC address + """ + LOGGER.info('Get lease called') + try: + lease = self.dhcp_leases.get_lease(request.hw_addr) + if lease is not None: + return pb2.Response(code=200, message=str(lease)) + else: + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to get lease: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def SetDHCPRange(self, request, context): # pylint: disable=W0613 + """ + Change DHCP configuration and set the + the first range from the first subnet in the configuration + """ + LOGGER.info('Set DHCP range called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.set_range(request.start, request.end, 0, 0) + dhcp_config.write_config() + LOGGER.info('DHCP range set') + return pb2.Response(code=200, message='DHCP Range Set') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to set DHCP range: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def GetStatus(self, request, context): # pylint: disable=W0613 + """ + Return the current status of the network module + """ + # ToDo: Figure out how to resolve the current DHCP status + dhcp_status = True + message = str({'dhcpStatus': dhcp_status}) + return pb2.Response(code=200, message=message) diff --git a/modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto b/modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto new file mode 100644 index 000000000..d9f56213e --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto @@ -0,0 +1,59 @@ +syntax = "proto3"; + +service NetworkModule { + + rpc AddReservedLease(AddReservedLeaseRequest) returns (Response) {}; + + rpc DeleteReservedLease(DeleteReservedLeaseRequest) returns (Response) {}; + + rpc DisableFailover(DisableFailoverRequest) returns (Response) {}; + + rpc EnableFailover(EnableFailoverRequest) returns (Response) {}; + + rpc GetDHCPRange(GetDHCPRangeRequest) returns (DHCPRange) {}; + + rpc GetLease(GetLeaseRequest) returns (Response) {}; + + rpc GetStatus(GetStatusRequest) returns (Response) {}; + + rpc SetDHCPRange(SetDHCPRangeRequest) returns (Response) {}; +} + +message AddReservedLeaseRequest { + string hostname = 1; + string hw_addr = 2; + string ip_addr = 3; +} + +message DeleteReservedLeaseRequest { + string hw_addr = 1; +} + +message DisableFailoverRequest {} + +message EnableFailoverRequest {} + +message GetDHCPRangeRequest {} + +message GetLeaseRequest { + string hw_addr = 1; +} + +message GetStatusRequest {} + +message SetDHCPRangeRequest { + int32 code = 1; + string start = 2; + string end = 3; +} + +message Response { + int32 code = 1; + string message = 2; +} + +message DHCPRange { + int32 code = 1; + string start = 2; + string end = 3; +} diff --git a/modules/network/dhcp-2/bin/start_network_service b/modules/network/dhcp-2/bin/start_network_service index 550854d49..723689278 100644 --- a/modules/network/dhcp-2/bin/start_network_service +++ b/modules/network/dhcp-2/bin/start_network_service @@ -20,7 +20,7 @@ DHCP_LOG_FILE=/runtime/network/dhcp2-dhcpd.log RA_PID_FILE=/var/run/radvd/radvd.pid RA_LOG_FILE=/runtime/network/dhcp2-radvd.log -echo "Starrting Network Service..." +echo "Starting Network Service..." #Enable IPv6 Forwarding sysctl net.ipv6.conf.all.forwarding=1 diff --git a/modules/network/dhcp-2/conf/dhcpd.conf b/modules/network/dhcp-2/conf/dhcpd.conf index e73a81441..dcc47a4fe 100644 --- a/modules/network/dhcp-2/conf/dhcpd.conf +++ b/modules/network/dhcp-2/conf/dhcpd.conf @@ -1,24 +1,25 @@ default-lease-time 300; failover peer "failover-peer" { - secondary; - address 10.10.10.3; - port 647; - peer address 10.10.10.2; - peer port 847; - max-response-delay 60; - max-unacked-updates 10; - load balance max seconds 3; + secondary; + address 10.10.10.3; + port 647; + peer address 10.10.10.2; + peer port 847; + max-response-delay 60; + max-unacked-updates 10; + load balance max seconds 3; } subnet 10.10.10.0 netmask 255.255.255.0 { - option ntp-servers 10.10.10.5; - option subnet-mask 255.255.255.0; - option broadcast-address 10.10.10.255; - option routers 10.10.10.1; - option domain-name-servers 10.10.10.4; - pool { - failover peer "failover-peer"; - range 10.10.10.10 10.10.10.20; - } + option ntp-servers 10.10.10.5; + option subnet-mask 255.255.255.0; + option broadcast-address 10.10.10.255; + option routers 10.10.10.1; + option domain-name-servers 10.10.10.4; + interface veth0; + pool { + failover peer "failover-peer"; + range 10.10.10.10 10.10.10.20; + } } diff --git a/modules/network/dhcp-2/python/src/grpc/dhcp_config.py b/modules/network/dhcp-2/python/src/grpc/dhcp_config.py deleted file mode 100644 index f6e79a2ec..000000000 --- a/modules/network/dhcp-2/python/src/grpc/dhcp_config.py +++ /dev/null @@ -1,303 +0,0 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Contains all the necessary classes to maintain the -DHCP server's configuration""" -import re - -CONFIG_FILE = '/etc/dhcp/dhcpd.conf' -CONFIG_FILE_TEST = 'network/modules/dhcp-2/conf/dhcpd.conf' - -DEFAULT_LEASE_TIME_KEY = 'default-lease-time' - - -class DHCPConfig: - """Represents the DHCP Servers configuration and gives access to modify it""" - - def __init__(self): - self._default_lease_time = 300 - self.subnets = [] - self._peer = None - - def write_config(self): - conf = str(self) - print('Writing config: \n' + conf) - with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: - conf_file.write(conf) - - def resolve_config(self): - with open(CONFIG_FILE, 'r', encoding='UTF-8') as f: - conf = f.read() - self.resolve_subnets(conf) - self._peer = DHCPFailoverPeer(conf) - - def resolve_subnets(self, conf): - self.subnets = [] - regex = r'(subnet.*)' - subnets = re.findall(regex, conf, re.MULTILINE | re.DOTALL) - for subnet in subnets: - dhcp_subnet = DHCPSubnet(subnet) - self.subnets.append(dhcp_subnet) - - def set_range(self, start, end, subnet=0, pool=0): - print('Setting Range for pool ') - print(self.subnets[subnet].pools[pool]) - self.subnets[subnet].pools[pool].range_start = start - self.subnets[subnet].pools[pool].range_end = end - - # def resolve_settings(self, conf): - # lines = conf.split('\n') - # for line in lines: - # if DEFAULT_LEASE_TIME_KEY in line: - # self._default_lease_time = line.strip().split( - # DEFAULT_LEASE_TIME_KEY)[1].strip().split(';')[0] - - # self.peer = peer - - def __str__(self): - - config = """\r{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" - - config = config.format(length='multi-line', - DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, - DEFAULT_LEASE_TIME=self._default_lease_time) - - config += '\n\n' + str(self.peer) - for subnet in self._subnets: - config += '\n\n' + str(subnet) - return str(config) - - -FAILOVER_PEER_KEY = 'failover peer' -PRIMARY_KEY = 'primary' -ADDRESS_KEY = 'address' -PORT_KEY = 'port' -PEER_ADDRESS_KEY = 'peer address' -PEER_PORT_KEY = 'peer port' -MAX_RESPONSE_DELAY_KEY = 'max-response-delay' -MAX_UNACKED_UPDATES_KEY = 'max-unacked-updates' -MCLT_KEY = 'mclt' -SPLIT_KEY = 'split' -LOAD_BALANCE_MAX_SECONDS_KEY = 'load balance max seconds' - - -class DHCPFailoverPeer: - """Contains all information to define the DHCP failover peer""" - - def __init__(self, config): - self.name = None - self.primary = False - self.address = None - self.port = None - self.peer_address = None - self.peer_port = None - self.max_response_delay = None - self.max_unacked_updates = None - self.mclt = None - self.split = None - self.load_balance_max_seconds = None - self.peer = None - - self.resolve_peer(config) - - def __str__(self): - config = '{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n' - config += '\tprimary;' if self.primary else 'secondary;' - config += """\n\t{ADDRESS_KEY} {ADDRESS}; - {PORT_KEY} {PORT}; - {PEER_ADDRESS_KEY} {PEER_ADDRESS}; - {PEER_PORT_KEY} {PEER_PORT}; - {MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY}; - {MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES}; - {MCLT_KEY} {MCLT}; - {SPLIT_KEY} {SPLIT}; - {LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS}; - \r}}""" - - return config.format( - length='multi-line', - FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, - FAILOVER_PEER=self.name, - ADDRESS_KEY=ADDRESS_KEY, - ADDRESS=self.address, - PORT_KEY=PORT_KEY, - PORT=self.port, - PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, - PEER_ADDRESS=self.peer_address, - PEER_PORT_KEY=PEER_PORT_KEY, - PEER_PORT=self.peer_port, - MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, - MAX_RESPONSE_DELAY=self.max_response_delay, - MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, - MAX_UNACKED_UPDATES=self.max_unacked_updates, - MCLT_KEY=MCLT_KEY, - MCLT=self.mclt, - SPLIT_KEY=SPLIT_KEY, - SPLIT=self.split, - LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, - LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds) - - def resolve_peer(self, conf): - peer = '' - lines = conf.split('\n') - for line in lines: - if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: - if len(peer) <= 0: - self.name = line.strip().split(FAILOVER_PEER_KEY)[1].strip().split( - '{')[0].split('\"')[1] - peer += line + '\n' - if PRIMARY_KEY in line: - self.primary = True - elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: - self.address = line.strip().split(ADDRESS_KEY)[1].strip().split( - ';')[0] - elif PORT_KEY in line and PEER_PORT_KEY not in line: - self.port = line.strip().split(PORT_KEY)[1].strip().split(';')[0] - elif PEER_ADDRESS_KEY in line: - self.peer_address = line.strip().split( - PEER_ADDRESS_KEY)[1].strip().split(';')[0] - elif PEER_PORT_KEY in line: - self.peer_port = line.strip().split(PEER_PORT_KEY)[1].strip().split( - ';')[0] - elif MAX_RESPONSE_DELAY_KEY in line: - self.max_response_delay = line.strip().split( - MAX_RESPONSE_DELAY_KEY)[1].strip().split(';')[0] - elif MAX_UNACKED_UPDATES_KEY in line: - self.max_unacked_updates = line.strip().split( - MAX_UNACKED_UPDATES_KEY)[1].strip().split(';')[0] - elif MCLT_KEY in line: - self.mclt = line.strip().split(MCLT_KEY)[1].strip().split(';')[0] - elif SPLIT_KEY in line: - self.split = line.strip().split(SPLIT_KEY)[1].strip().split(';')[0] - elif LOAD_BALANCE_MAX_SECONDS_KEY in line: - self.load_balance_max_seconds = line.strip().split( - LOAD_BALANCE_MAX_SECONDS_KEY)[1].strip().split(';')[0] - if line.endswith('}') and len(peer) > 0: - break - self.peer = peer - - -NTP_OPTION_KEY = 'option ntp-servers' -SUBNET_MASK_OPTION_KEY = 'option subnet-mask' -BROADCAST_OPTION_KEY = 'option broadcast-address' -ROUTER_OPTION_KEY = 'option routers' -DNS_OPTION_KEY = 'option domain-name-servers' - - -class DHCPSubnet: - """Represents the DHCP Servers subnet configuration""" - - def __init__(self, subnet): - self._ntp_servers = None - self._subnet_mask = None - self._broadcast = None - self._routers = None - self._dns_servers = None - self.pools = [] - - self.resolve_subnet(subnet) - self.resolve_pools(subnet) - - def __str__(self): - config = """subnet 10.10.10.0 netmask {SUBNET_MASK_OPTION} {{ - \r\t{NTP_OPTION_KEY} {NTP_OPTION}; - \r\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION}; - \r\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION}; - \r\t{ROUTER_OPTION_KEY} {ROUTER_OPTION}; - \r\t{DNS_OPTION_KEY} {DNS_OPTION};""" - - config = config.format(length='multi-line', - NTP_OPTION_KEY=NTP_OPTION_KEY, - NTP_OPTION=self._ntp_servers, - SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, - SUBNET_MASK_OPTION=self._subnet_mask, - BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, - BROADCAST_OPTION=self._broadcast, - ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, - ROUTER_OPTION=self._routers, - DNS_OPTION_KEY=DNS_OPTION_KEY, - DNS_OPTION=self._dns_servers) - for pool in self.pools: - config += '\n\t' + str(pool) - - config += '\n\r}' - return config - - def resolve_subnet(self, subnet): - subnet_parts = subnet.split('\n') - for part in subnet_parts: - if NTP_OPTION_KEY in part: - self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[1].strip().split( - ';')[0] - elif SUBNET_MASK_OPTION_KEY in part: - self._subnet_mask = part.strip().split( - SUBNET_MASK_OPTION_KEY)[1].strip().split(';')[0] - elif BROADCAST_OPTION_KEY in part: - self._broadcast = part.strip().split( - BROADCAST_OPTION_KEY)[1].strip().split(';')[0] - elif ROUTER_OPTION_KEY in part: - self._routers = part.strip().split(ROUTER_OPTION_KEY)[1].strip().split( - ';')[0] - elif DNS_OPTION_KEY in part: - self._dns_servers = part.strip().split(DNS_OPTION_KEY)[1].strip().split( - ';')[0] - - def resolve_pools(self, subnet): - regex = r'(pool.*)\}' - pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) - for pool in pools: - dhcp_pool = DHCPPool(pool) - self.pools.append(dhcp_pool) - - -FAILOVER_KEY = 'failover peer' -RANGE_KEY = 'range' - - -class DHCPPool: - """Represents a DHCP Servers subnet pool configuration""" - - def __init__(self, pool): - self.failover_peer = None - self.range_start = None - self.range_end = None - self.resolve_pool(pool) - - def __str__(self): - - config = """pool {{ - \r\t\t{FAILOVER_KEY} "{FAILOVER}"; - \r\t\t{RANGE_KEY} {RANGE_START} {RANGE_END}; - \r\t}}""" - - return config.format( - length='multi-line', - FAILOVER_KEY=FAILOVER_KEY, - FAILOVER=self.failover_peer, - RANGE_KEY=RANGE_KEY, - RANGE_START=self.range_start, - RANGE_END=self.range_end, - ) - - def resolve_pool(self, pool): - pool_parts = pool.split('\n') - # pool_parts = pool.split("\n") - for part in pool_parts: - if FAILOVER_KEY in part: - self.failover_peer = part.strip().split(FAILOVER_KEY)[1].strip().split( - ';')[0].replace('\"', '') - if RANGE_KEY in part: - pool_range = part.strip().split(RANGE_KEY)[1].strip().split(';')[0] - self.range_start = pool_range.split(' ')[0].strip() - self.range_end = pool_range.split(' ')[1].strip() diff --git a/modules/network/dhcp-2/python/src/grpc/network_service.py b/modules/network/dhcp-2/python/src/grpc/network_service.py deleted file mode 100644 index 64aab8a07..000000000 --- a/modules/network/dhcp-2/python/src/grpc/network_service.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""gRPC Network Service for the DHCP Server network module""" -import proto.grpc_pb2_grpc as pb2_grpc -import proto.grpc_pb2 as pb2 - -from dhcp_config import DHCPConfig - - -class NetworkService(pb2_grpc.NetworkModule): - """gRPC endpoints for the DHCP Server""" - - def __init__(self): - self._dhcp_config = DHCPConfig() - - def GetDHCPRange(self, request, context): # pylint: disable=W0613 - """ - Resolve the current DHCP configuration and return - the first range from the first subnet in the file - """ - self._dhcp_config.resolve_config() - pool = self._dhcp_config.subnets[0].pools[0] - return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) - - def SetDHCPRange(self, request, context): # pylint: disable=W0613 - """ - Change DHCP configuration and set the - the first range from the first subnet in the configuration - """ - - print('Setting DHCPRange') - print('Start: ' + request.start) - print('End: ' + request.end) - self._dhcp_config.resolve_config() - self._dhcp_config.set_range(request.start, request.end, 0, 0) - self._dhcp_config.write_config() - return pb2.Response(code=200, message='DHCP Range Set') - - def GetStatus(self, request, context): # pylint: disable=W0613 - """ - Return the current status of the network module - """ - # ToDo: Figure out how to resolve the current DHCP status - dhcp_status = True - message = str({'dhcpStatus': dhcp_status}) - return pb2.Response(code=200, message=message) diff --git a/modules/network/dhcp-2/python/src/grpc/proto/grpc.proto b/modules/network/dhcp-2/python/src/grpc/proto/grpc.proto deleted file mode 100644 index 8e2732620..000000000 --- a/modules/network/dhcp-2/python/src/grpc/proto/grpc.proto +++ /dev/null @@ -1,36 +0,0 @@ -syntax = "proto3"; - -service NetworkModule { - - rpc GetDHCPRange(GetDHCPRangeRequest) returns (DHCPRange) {}; - - rpc SetDHCPRange(DHCPRange) returns (Response) {}; - - rpc GetStatus(GetStatusRequest) returns (Response) {}; - - rpc GetIPAddress(GetIPAddressRequest) returns (Response) {}; - - rpc SetLeaseAddress(SetLeaseAddressRequest) returns (Response) {}; - -} - -message Response { - int32 code = 1; - string message = 2; -} - -message DHCPRange { - int32 code = 1; - string start = 2; - string end = 3; -} - -message GetDHCPRangeRequest {} - -message GetIPAddressRequest {} - -message GetStatusRequest {} - -message SetLeaseAddressRequest { - string ipAddress = 1; -} \ No newline at end of file diff --git a/modules/network/dhcp-2/python/src/grpc/__init__.py b/modules/network/dhcp-2/python/src/grpc_server/__init__.py similarity index 100% rename from modules/network/dhcp-2/python/src/grpc/__init__.py rename to modules/network/dhcp-2/python/src/grpc_server/__init__.py diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py new file mode 100644 index 000000000..444faa87c --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py @@ -0,0 +1,493 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +DHCP server's configuration""" +import re +from common import logger + +LOG_NAME = 'dhcp_config' +LOGGER = None + +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' + +DEFAULT_LEASE_TIME_KEY = 'default-lease-time' + + +class DHCPConfig: + """Represents the DHCP Servers configuration and gives access to modify it""" + + def __init__(self): + self._default_lease_time = 300 + self._subnets = [] + self._peer = None + self._reserved_hosts = [] + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + + def add_reserved_host(self, hostname, hw_addr, ip_addr): + host = DHCPReservedHost(hostname=hostname, + hw_addr=hw_addr, + fixed_addr=ip_addr) + self._reserved_hosts.append(host) + + def delete_reserved_host(self, hw_addr): + for host in self._reserved_hosts: + if hw_addr == host.hw_addr: + self._reserved_hosts.remove(host) + + def disable_failover(self): + self._peer.disable() + for subnet in self._subnets: + subnet.disable_peer() + + def enable_failover(self): + self._peer.enable() + for subnet in self._subnets: + subnet.enable_peer() + + def get_reserved_host(self, hw_addr): + for host in self._reserved_hosts: + if hw_addr == host.hw_addr: + return host + + def write_config(self, config=None): + if config is None: + conf = str(self) + with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: + conf_file.write(conf) + else: + with open(CONFIG_FILE, 'w', encoding='UTF-8') as conf_file: + conf_file.write(config) + + def _get_config(self, config_file=CONFIG_FILE): + content = None + with open(config_file, 'r', encoding='UTF-8') as f: + content = f.read() + return content + + def make(self, conf): + try: + self._subnets = self.resolve_subnets(conf) + self._peer = DHCPFailoverPeer(conf) + self._reserved_hosts = self.resolve_reserved_hosts(conf) + except Exception as e: # pylint: disable=W0718 + print('Failed to make DHCPConfig: ' + str(e)) + + def resolve_config(self, config_file=CONFIG_FILE): + try: + conf = self._get_config(config_file) + self._subnets = self.resolve_subnets(conf) + self._peer = DHCPFailoverPeer(conf) + self._reserved_hosts = self.resolve_reserved_hosts(conf) + except Exception as e: # pylint: disable=W0718 + print('Failed to resolve config: ' + str(e)) + + def resolve_subnets(self, conf): + subnets = [] + regex = r'(subnet.*)' + subnets_conf = re.findall(regex, conf, re.MULTILINE | re.DOTALL) + for subnet in subnets_conf: + dhcp_subnet = DHCPSubnet(subnet) + subnets.append(dhcp_subnet) + return subnets + + def resolve_reserved_hosts(self, conf): + hosts = [] + host_start = 0 + while True: + host_start = conf.find('host', host_start) + if host_start < 0: + break + else: + host_end = conf.find('}', host_start) + host = DHCPReservedHost(config=conf[host_start:host_end + 1]) + hosts.append(host) + host_start = host_end + 1 + return hosts + + def set_range(self, start, end, subnet=0, pool=0): + # Calculate the subnet from the range + octets = start.split('.') + octets[-1] = '0' + dhcp_subnet = '.'.join(octets) + + #Update the subnet and range + self._subnets[subnet].set_subnet(dhcp_subnet) + self._subnets[subnet].pools[pool].set_range(start, end) + + def __str__(self): + + # Encode the top level config options + config = """{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + config = config.format(length='multi-line', + DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, + DEFAULT_LEASE_TIME=self._default_lease_time) + + # Encode the failover peer + config += '\n\n' + str(self._peer) + + # Encode the subnets + for subnet in self._subnets: + config += '\n\n' + str(subnet) + + # Encode the reserved hosts + for host in self._reserved_hosts: + config += '\n' + str(host) + + return str(config) + + +FAILOVER_PEER_KEY = 'failover peer' +PRIMARY_KEY = 'primary' +ADDRESS_KEY = 'address' +PORT_KEY = 'port' +PEER_ADDRESS_KEY = 'peer address' +PEER_PORT_KEY = 'peer port' +MAX_RESPONSE_DELAY_KEY = 'max-response-delay' +MAX_UNACKED_UPDATES_KEY = 'max-unacked-updates' +MCLT_KEY = 'mclt' +SPLIT_KEY = 'split' +LOAD_BALANCE_MAX_SECONDS_KEY = 'load balance max seconds' + + +class DHCPFailoverPeer: + """Contains all information to define the DHCP failover peer""" + + def __init__(self, config): + self.name = None + self.primary = False + self.address = None + self.port = None + self.peer_address = None + self.peer_port = None + self.max_response_delay = None + self.max_unacked_updates = None + self.mclt = None + self.split = None + self.load_balance_max_seconds = None + self.peer = None + self.enabled = True + + self.resolve_peer(config) + + def __str__(self): + config = '{FAILOVER_PEER_KEY} \"{FAILOVER_PEER}\" {{\n' + config += '\tprimary;' if self.primary else 'secondary;' + config += '\n\t{ADDRESS_KEY} {ADDRESS};' if self.address is not None else '' + config += '\n\t{PORT_KEY} {PORT};' if self.port is not None else '' + config += '\n\t{PEER_ADDRESS_KEY} {PEER_ADDRESS};' if self.peer_address is not None else '' + config += '\n\t{PEER_PORT_KEY} {PEER_PORT};' if self.peer_port is not None else '' + config += '\n\t{MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY};' if self.max_response_delay is not None else '' + config += '\n\t{MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES};' if self.max_unacked_updates is not None else '' + config += '\n\t{MCLT_KEY} {MCLT};' if self.mclt is not None else '' + config += '\n\t{SPLIT_KEY} {SPLIT};' if self.split is not None else '' + config += '\n\t{LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS};' if self.load_balance_max_seconds is not None else '' + config += '\n\r}}' + + config = config.format( + length='multi-line', + FAILOVER_PEER_KEY=FAILOVER_PEER_KEY, + FAILOVER_PEER=self.name, + ADDRESS_KEY=ADDRESS_KEY, + ADDRESS=self.address, + PORT_KEY=PORT_KEY, + PORT=self.port, + PEER_ADDRESS_KEY=PEER_ADDRESS_KEY, + PEER_ADDRESS=self.peer_address, + PEER_PORT_KEY=PEER_PORT_KEY, + PEER_PORT=self.peer_port, + MAX_RESPONSE_DELAY_KEY=MAX_RESPONSE_DELAY_KEY, + MAX_RESPONSE_DELAY=self.max_response_delay, + MAX_UNACKED_UPDATES_KEY=MAX_UNACKED_UPDATES_KEY, + MAX_UNACKED_UPDATES=self.max_unacked_updates, + MCLT_KEY=MCLT_KEY, + MCLT=self.mclt, + SPLIT_KEY=SPLIT_KEY, + SPLIT=self.split, + LOAD_BALANCE_MAX_SECONDS_KEY=LOAD_BALANCE_MAX_SECONDS_KEY, + LOAD_BALANCE_MAX_SECONDS=self.load_balance_max_seconds) + + if not self.enabled: + lines = config.strip().split('\n') + for i in range(len(lines)-1): + lines[i] = '#' + lines[i] + lines[-1] = '#' + lines[-1].strip() # Handle the last line separately + config = '\n'.join(lines) + + return config + + def disable(self): + self.enabled = False + + def enable(self): + self.enabled = True + + def resolve_peer(self, conf): + peer = '' + lines = conf.split('\n') + for line in lines: + if line.startswith(FAILOVER_PEER_KEY) or len(peer) > 0: + if len(peer) <= 0: + self.name = line.strip().split(FAILOVER_PEER_KEY)[1].strip().split( + '{')[0].split('\"')[1] + peer += line + '\n' + if PRIMARY_KEY in line: + self.primary = True + elif ADDRESS_KEY in line and PEER_ADDRESS_KEY not in line: + self.address = line.strip().split(ADDRESS_KEY)[1].strip().split( + ';')[0] + elif PORT_KEY in line and PEER_PORT_KEY not in line: + self.port = line.strip().split(PORT_KEY)[1].strip().split(';')[0] + elif PEER_ADDRESS_KEY in line: + self.peer_address = line.strip().split( + PEER_ADDRESS_KEY)[1].strip().split(';')[0] + elif PEER_PORT_KEY in line: + self.peer_port = line.strip().split(PEER_PORT_KEY)[1].strip().split( + ';')[0] + elif MAX_RESPONSE_DELAY_KEY in line: + self.max_response_delay = line.strip().split( + MAX_RESPONSE_DELAY_KEY)[1].strip().split(';')[0] + elif MAX_UNACKED_UPDATES_KEY in line: + self.max_unacked_updates = line.strip().split( + MAX_UNACKED_UPDATES_KEY)[1].strip().split(';')[0] + elif MCLT_KEY in line: + self.mclt = line.strip().split(MCLT_KEY)[1].strip().split(';')[0] + elif SPLIT_KEY in line: + self.split = line.strip().split(SPLIT_KEY)[1].strip().split(';')[0] + elif LOAD_BALANCE_MAX_SECONDS_KEY in line: + self.load_balance_max_seconds = line.strip().split( + LOAD_BALANCE_MAX_SECONDS_KEY)[1].strip().split(';')[0] + if line.endswith('}') and len(peer) > 0: + break + self.peer = peer + + +SUBNET_KEY = 'subnet' +NTP_OPTION_KEY = 'option ntp-servers' +SUBNET_MASK_OPTION_KEY = 'option subnet-mask' +BROADCAST_OPTION_KEY = 'option broadcast-address' +ROUTER_OPTION_KEY = 'option routers' +DNS_OPTION_KEY = 'option domain-name-servers' +INTERFACE_KEY = 'interface' +AUTHORITATIVE_KEY = 'authoritative' + + +class DHCPSubnet: + """Represents the DHCP Servers subnet configuration""" + + def __init__(self, subnet): + self._authoritative = False + self._subnet = None + self._ntp_servers = None + self._subnet_mask = None + self._broadcast = None + self._routers = None + self._dns_servers = None + self._interface = None + self.pools = [] + + self.resolve_subnet(subnet) + self.resolve_pools(subnet) + + def __str__(self): + config = 'subnet {SUBNET_OPTION} netmask {SUBNET_MASK_OPTION} {{' + config += '\n\t{NTP_OPTION_KEY} {NTP_OPTION};' if self._ntp_servers is not None else '' + config += '\n\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION};' if self._subnet_mask is not None else '' + config += '\n\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION};' if self._broadcast is not None else '' + config += '\n\t{ROUTER_OPTION_KEY} {ROUTER_OPTION};' if self._routers is not None else '' + config += '\n\t{DNS_OPTION_KEY} {DNS_OPTION};' if self._dns_servers is not None else '' + config += '\n\t{INTERFACE_KEY} {INTERFACE_OPTION};' if self._interface is not None else '' + config += '\n\t{AUTHORITATIVE_KEY};' if self._authoritative else '' + + + config = config.format(length='multi-line', + SUBNET_OPTION=self._subnet, + NTP_OPTION_KEY=NTP_OPTION_KEY, + NTP_OPTION=self._ntp_servers, + SUBNET_MASK_OPTION_KEY=SUBNET_MASK_OPTION_KEY, + SUBNET_MASK_OPTION=self._subnet_mask, + BROADCAST_OPTION_KEY=BROADCAST_OPTION_KEY, + BROADCAST_OPTION=self._broadcast, + ROUTER_OPTION_KEY=ROUTER_OPTION_KEY, + ROUTER_OPTION=self._routers, + DNS_OPTION_KEY=DNS_OPTION_KEY, + DNS_OPTION=self._dns_servers, + INTERFACE_KEY=INTERFACE_KEY, + INTERFACE_OPTION=self._interface, + AUTHORITATIVE_KEY=AUTHORITATIVE_KEY) + + # if not self._authoritative: + # config = config.replace(AUTHORITATIVE_KEY, '#' + AUTHORITATIVE_KEY) + + for pool in self.pools: + config += '\n\t' + str(pool) + + config += '\n}' + return config + + def disable_peer(self): + for pool in self.pools: + pool.disable_peer() + + def enable_peer(self): + for pool in self.pools: + pool.enable_peer() + + def set_subnet(self, subnet, netmask=None): + if netmask is None: + netmask = '255.255.255.0' + self._subnet = subnet + self._subnet_mask = netmask + + # Calculate the broadcast from the subnet + octets = subnet.split('.') + octets[-1] = '255' + dhcp_broadcast = '.'.join(octets) + + self._broadcast = dhcp_broadcast + + def resolve_subnet(self, subnet): + subnet_parts = subnet.split('\n') + for part in subnet_parts: + if part.strip().startswith(SUBNET_KEY): + self._subnet = part.strip().split()[1] + elif NTP_OPTION_KEY in part: + self._ntp_servers = part.strip().split(NTP_OPTION_KEY)[1].strip().split( + ';')[0] + elif SUBNET_MASK_OPTION_KEY in part: + self._subnet_mask = part.strip().split( + SUBNET_MASK_OPTION_KEY)[1].strip().split(';')[0] + elif BROADCAST_OPTION_KEY in part: + self._broadcast = part.strip().split( + BROADCAST_OPTION_KEY)[1].strip().split(';')[0] + elif ROUTER_OPTION_KEY in part: + self._routers = part.strip().split(ROUTER_OPTION_KEY)[1].strip().split( + ';')[0] + elif DNS_OPTION_KEY in part: + self._dns_servers = part.strip().split(DNS_OPTION_KEY)[1].strip().split( + ';')[0] + elif INTERFACE_KEY in part: + self._interface = part.strip().split(INTERFACE_KEY)[1].strip().split( + ';')[0] + elif AUTHORITATIVE_KEY in part: + self._authoritative = True + + def resolve_pools(self, subnet): + regex = r'(pool.*)\}' + pools = re.findall(regex, subnet, re.MULTILINE | re.DOTALL) + for pool in pools: + dhcp_pool = DHCPPool(pool) + self.pools.append(dhcp_pool) + + +FAILOVER_KEY = 'failover peer' +RANGE_KEY = 'range' + + +class DHCPPool: + """Represents a DHCP Servers subnet pool configuration""" + + def __init__(self, pool): + self.failover_peer = None + self.range_start = None + self.range_end = None + self.resolve_pool(pool) + self._peer_enabled = True + + def __str__(self): + config = 'pool {{' + config += '\n\t\t{FAILOVER_KEY} "{FAILOVER}";' if self.failover_peer is not None else '' + config += '\n\t\t{RANGE_KEY} {RANGE_START} {RANGE_END};' if self.range_start is not None and self.range_end is not None else '' + config += '\n\t}}' + + config = config.format( + length='multi-line', + FAILOVER_KEY=FAILOVER_KEY, + FAILOVER=self.failover_peer, + RANGE_KEY=RANGE_KEY, + RANGE_START=self.range_start, + RANGE_END=self.range_end, + ) + + if not self._peer_enabled: + config = config.replace(FAILOVER_KEY, '#' + FAILOVER_KEY) + + return config + + def disable_peer(self): + self._peer_enabled = False + + def enable_peer(self): + self._peer_enabled = True + + def set_range(self, start, end): + self.range_start = start + self.range_end = end + + def resolve_pool(self, pool): + pool_parts = pool.split('\n') + for part in pool_parts: + if FAILOVER_KEY in part: + self.failover_peer = part.strip().split(FAILOVER_KEY)[1].strip().split( + ';')[0].replace('\"', '') + if RANGE_KEY in part: + pool_range = part.strip().split(RANGE_KEY)[1].strip().split(';')[0] + self.range_start = pool_range.split(' ')[0].strip() + self.range_end = pool_range.split(' ')[1].strip() + + +HOST_KEY = 'host' +HARDWARE_KEY = 'hardware ethernet' +FIXED_ADDRESS_KEY = 'fixed-address' + + +class DHCPReservedHost: + """Represents a DHCP Servers subnet pool configuration""" + + def __init__(self, hostname=None, hw_addr=None, fixed_addr=None, config=None): + if config is None: + self.host = hostname + self.hw_addr = hw_addr + self.fixed_addr = fixed_addr + else: + self.resolve_host(config) + + def __str__(self): + + config = """{HOST_KEY} {HOSTNAME} {{ + \r\t{HARDWARE_KEY} {HW_ADDR}; + \r\t{FIXED_ADDRESS_KEY} {RESERVED_IP}; + \r}}""" + + config = config.format( + length='multi-line', + HOST_KEY=HOST_KEY, + HOSTNAME=self.host, + HARDWARE_KEY=HARDWARE_KEY, + HW_ADDR=self.hw_addr, + FIXED_ADDRESS_KEY=FIXED_ADDRESS_KEY, + RESERVED_IP=self.fixed_addr, + ) + return config + + def resolve_host(self, reserved_host): + host_parts = reserved_host.split('\n') + for part in host_parts: + if HOST_KEY in part: + self.host = part.strip().split(HOST_KEY)[1].strip().split('{')[0] + elif HARDWARE_KEY in part: + self.hw_addr = part.strip().split(HARDWARE_KEY)[1].strip().split(';')[0] + elif FIXED_ADDRESS_KEY in part: + self.fixed_addr = part.strip().split( + FIXED_ADDRESS_KEY)[1].strip().split(';')[0] diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py new file mode 100644 index 000000000..2cc78403a --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py @@ -0,0 +1,103 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Unit Testing for the DHCP Server config""" +import unittest +from dhcp_config import DHCPConfig +import os + +CONFIG_FILE = 'conf/dhcpd.conf' + +DHCP_CONFIG = None + +def get_config_file_path(): + dhcp_config = DHCPConfig() + current_dir = os.path.dirname(os.path.abspath(__file__)) + module_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(current_dir)))) + conf_file = os.path.join(module_dir,CONFIG_FILE) + return conf_file + +def get_config(): + dhcp_config = DHCPConfig() + dhcp_config.resolve_config(get_config_file_path()) + return dhcp_config + +class DHCPConfigTest(unittest.TestCase): + + @classmethod + def setUpClass(cls): + # Resolve the config + global DHCP_CONFIG + DHCP_CONFIG = get_config() + + def test_resolve_config(self): + print('Test Resolve Config:\n' + str(DHCP_CONFIG)) + + # Resolve the raw config file + with open(get_config_file_path(),'r') as f: + lines = f.readlines() + + # Get the resolved config as a + conf_parts = str(DHCP_CONFIG).split('\n') + + # dhcpd conf is not picky about spacing so we just + # need to check contents of each line for matching + # to make sure evertying matches + for i in range(len(lines)): + self.assertEqual(lines[i].strip(),conf_parts[i].strip()) + + def test_disable_failover(self): + DHCP_CONFIG.disable_failover() + print('Test Disable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertTrue(line.startswith('#')) + + def test_enable_failover(self): + DHCP_CONFIG.enable_failover() + print('Test Enable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertFalse(line.startswith('#')) + + def test_add_reserved_host(self): + DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print('AddHostConfig:\n' + str(DHCP_CONFIG)) + + def test_delete_reserved_host(self): + DHCP_CONFIG.delete_reserved_host('00:11:22:33:44:55') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNone(host) + print('DeleteHostConfig:\n' + str(DHCP_CONFIG)) + + def test_resolve_config_with_hosts(self): + DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') + config_with_hosts = DHCPConfig() + config_with_hosts.make(str(DHCP_CONFIG)) + host = config_with_hosts.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print("ResolveConfigWithHosts:\n" + str(config_with_hosts)) + +if __name__ == '__main__': + suite = unittest.TestSuite() + suite.addTest(DHCPConfigTest('test_resolve_config')) + suite.addTest(DHCPConfigTest('test_disable_failover')) + suite.addTest(DHCPConfigTest('test_enable_failover')) + suite.addTest(DHCPConfigTest('test_add_reserved_host')) + suite.addTest(DHCPConfigTest('test_delete_reserved_host')) + suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) + + runner = unittest.TextTestRunner() + runner.run(suite) \ No newline at end of file diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py new file mode 100644 index 000000000..0d2f43e3b --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py @@ -0,0 +1,75 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary methods to create and monitor DHCP +leases on the server""" +from datetime import datetime +import time + +time_format = '%Y-%m-%d %H:%M:%S' + + +class DHCPLease(object): + """Represents a DHCP Server lease""" + hw_addr = None + ip = None + hostname = None + expires = None + + def __init__(self, lease): + self._make_lease(lease) + + def _make_lease(self, lease): + if lease is not None: + sections_raw = lease.split(' ') + sections = [] + for section in sections_raw: + if section.strip(): + sections.append(section) + self.hw_addr = sections[0] + self.ip = sections[1] + self.hostname = sections[2] + self.expires = sections[3] + '' '' + sections[4] + self.manufacturer = ' '.join(sections[5:]) + + def get_millis(self, timestamp): + dt_obj = datetime.strptime(timestamp, time_format) + millis = dt_obj.timestamp() * 1000 + return millis + + def get_expires_millis(self): + return self.get_millis(self.expires) + + def is_expired(self): + expires_millis = self.get_expires_millis() + cur_time = int(round(time.time()) * 1000) + return cur_time >= expires_millis + + def __str__(self): + lease = {} + if self.hw_addr is not None: + lease['hw_addr'] = self.hw_addr + + if self.ip is not None: + lease['ip'] = self.ip + + if self.hostname is not None: + lease['hostname'] = self.hostname + + if self.expires is not None: + lease['expires'] = self.expires + + if self.manufacturer is not None: + lease['manufacturer'] = self.manufacturer + + return str(lease) diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_leases.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_leases.py new file mode 100644 index 000000000..08e6feabe --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_leases.py @@ -0,0 +1,107 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Used to resolve the DHCP servers lease information""" +import os +from dhcp_lease import DHCPLease +import logger +from common import util + +LOG_NAME = 'dhcp_lease' +LOGGER = None + +DHCP_LEASE_FILES = [ + '/var/lib/dhcp/dhcpd.leases', '/var/lib/dhcp/dhcpd.leases~', + '/var/lib/dhcp/dhcpd6.leases', '/var/lib/dhcp/dhcpd6.leases~' +] +DHCP_CONFIG_FILE = '/etc/dhcp/dhcpd.conf' + + +class DHCPLeases: + """Leases for the DHCP server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') + + def delete_all_hosts(self): + LOGGER.info('Deleting hosts') + for lease in DHCP_LEASE_FILES: + LOGGER.info('Checking file: ' + lease) + if os.path.exists(lease): + LOGGER.info('File Exists: ' + lease) + try: + # Delete existing lease file + os.remove(lease) + except OSError as e: + LOGGER.info(f'Error occurred while deleting the file: {e}') + # Create an empty lease file + with open(lease, 'w', encoding='UTF-8'): + pass + + def get_lease(self, hw_addr): + for lease in self.get_leases(): + if lease.hw_addr == hw_addr: + return lease + + def get_leases(self): + leases = [] + lease_list_raw = self._get_lease_list() + LOGGER.info('Raw Leases:\n' + str(lease_list_raw) + '\n') + lease_list_start = lease_list_raw.find('=========',0) + lease_list_start = lease_list_raw.find('\n',lease_list_start) + lease_list = lease_list_raw[lease_list_start+1:] + lines = lease_list.split('\n') + for line in lines: + try: + lease = DHCPLease(line) + leases.append(lease) + except Exception as e: # pylint: disable=W0718 + # Let non lease lines file without extra checks + LOGGER.error('Making Lease Error: ' + str(e)) + LOGGER.error('Not a valid lease line: ' + line) + return leases + + def delete_lease(self, ip_addr): + LOGGER.info('Deleting lease') + for lease in DHCP_LEASE_FILES: + LOGGER.info('Checking file: ' + lease) + if os.path.exists(lease): + LOGGER.info('File Exists: ' + lease) + try: + # Delete existing lease file + with (open(lease, 'r', encoding='UTF-8')) as f: + contents = f.read() + + while ip_addr in contents: + ix_ip = contents.find(ip_addr) + lease_start = contents.rindex('lease', 0, ix_ip) + lease_end = contents.find('}', lease_start) + LOGGER.info('Lease Location: ' + str(lease_start) + ':' + + str(lease_end)) + contents = contents[0:lease_start] + contents[lease_end + 1:] + + except OSError as e: + LOGGER.info(f'Error occurred while deleting the lease: {e}') + + def _get_lease_list(self): + LOGGER.info('Running lease list command') + try: + result = util.run_command('dhcp-lease-list') + return result[0] + except Exception as e: # pylint: disable=W0718 + LOGGER.error('Error lease list: ' + str(e)) + + def _write_config(self, config): + with open(DHCP_CONFIG_FILE, 'w', encoding='UTF-8') as f: + f.write(config) diff --git a/modules/network/dhcp-2/python/src/grpc_server/network_service.py b/modules/network/dhcp-2/python/src/grpc_server/network_service.py new file mode 100644 index 000000000..053d26d6b --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/network_service.py @@ -0,0 +1,157 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""gRPC Network Service for the DHCP Server network module""" +import proto.grpc_pb2_grpc as pb2_grpc +import proto.grpc_pb2 as pb2 + +from dhcp_config import DHCPConfig +from dhcp_leases import DHCPLeases + +import traceback +from common import logger + +LOG_NAME = 'network_service' +LOGGER = None + +class NetworkService(pb2_grpc.NetworkModule): + """gRPC endpoints for the DHCP Server""" + + def __init__(self): + self._dhcp_config = None + self.dhcp_leases = DHCPLeases() + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') + + def _get_dhcp_config(self): + if self._dhcp_config is None: + self._dhcp_config = DHCPConfig() + self._dhcp_config.resolve_config() + return self._dhcp_config + + def AddReservedLease(self, request, context): # pylint: disable=W0613 + LOGGER.info('Add reserved lease called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.add_reserved_host(request.hostname, request.hw_addr, + request.ip_addr) + dhcp_config.write_config() + LOGGER.info('Reserved lease added') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to add reserved lease: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def DeleteReservedLease(self, request, context): # pylint: disable=W0613 + LOGGER.info('Delete reserved lease called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.delete_reserved_host(request.hw_addr) + dhcp_config.write_config() + LOGGER.info('Reserved lease deleted') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to delete reserved lease: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def DisableFailover(self, request, contest): # pylint: disable=W0613 + LOGGER.info('Disable failover called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.disable_failover() + dhcp_config.write_config() + LOGGER.info('Failover disabled') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to disable failover: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def EnableFailover(self, request, contest): # pylint: disable=W0613 + LOGGER.info('Enable failover called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.enable_failover() + dhcp_config.write_config() + LOGGER.info('Failover enabled') + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to enable failover: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def GetDHCPRange(self, request, context): # pylint: disable=W0613 + """ + Resolve the current DHCP configuration and return + the first range from the first subnet in the file + """ + LOGGER.info('Get DHCP range called') + try: + pool = self._get_dhcp_config()._subnets[0].pools[0] + return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to get DHCP range: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def GetLease(self, request, context): # pylint: disable=W0613 + """ + Resolve the current DHCP leased address for the + provided MAC address + """ + LOGGER.info('Get lease called') + try: + lease = self.dhcp_leases.get_lease(request.hw_addr) + if lease is not None: + return pb2.Response(code=200, message=str(lease)) + else: + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to get lease: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def SetDHCPRange(self, request, context): # pylint: disable=W0613 + """ + Change DHCP configuration and set the + the first range from the first subnet in the configuration + """ + LOGGER.info('Set DHCP range called') + try: + dhcp_config = self._get_dhcp_config() + dhcp_config.set_range(request.start, request.end, 0, 0) + dhcp_config.write_config() + LOGGER.info('DHCP range set') + return pb2.Response(code=200, message='DHCP Range Set') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to set DHCP range: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def GetStatus(self, request, context): # pylint: disable=W0613 + """ + Return the current status of the network module + """ + # ToDo: Figure out how to resolve the current DHCP status + dhcp_status = True + message = str({'dhcpStatus': dhcp_status}) + return pb2.Response(code=200, message=message) diff --git a/modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto b/modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto new file mode 100644 index 000000000..b6a11a75b --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto @@ -0,0 +1,59 @@ +syntax = "proto3"; + +service NetworkModule { + + rpc AddReservedLease(AddReservedLeaseRequest) returns (Response) {}; + + rpc DeleteReservedLease(DeleteReservedLeaseRequest) returns (Response) {}; + + rpc DisableFailover(DisableFailoverRequest) returns (Response) {}; + + rpc EnableFailover(EnableFailoverRequest) returns (Response) {}; + + rpc GetDHCPRange(GetDHCPRangeRequest) returns (DHCPRange) {}; + + rpc GetLease(GetLeaseRequest) returns (Response) {}; + + rpc GetStatus(GetStatusRequest) returns (Response) {}; + + rpc SetDHCPRange(SetDHCPRangeRequest) returns (Response) {}; +} + +message AddReservedLeaseRequest { + string hostname = 1; + string hw_addr = 2; + string ip_addr = 3; +} + +message DeleteReservedLeaseRequest { + string hw_addr = 1; +} + +message DisableFailoverRequest {} + +message EnableFailoverRequest {} + +message GetDHCPRangeRequest {} + +message GetLeaseRequest { + string hw_addr = 1; +} + +message GetStatusRequest {} + +message SetDHCPRangeRequest { + int32 code = 1; + string start = 2; + string end = 3; +} + +message Response { + int32 code = 1; + string message = 2; +} + +message DHCPRange { + int32 code = 1; + string start = 2; + string end = 3; +} diff --git a/modules/test/base/base.Dockerfile b/modules/test/base/base.Dockerfile index 9c7f2bac2..10344cbc7 100644 --- a/modules/test/base/base.Dockerfile +++ b/modules/test/base/base.Dockerfile @@ -36,5 +36,13 @@ RUN dos2unix /testrun/bin/* # Make sure all the bin files are executable RUN chmod u+x /testrun/bin/* +# Copy over all network module gRPC proto files +ARG NET_MODULE_DIR=modules/network +ARG NET_MODULE_PROTO_DIR=python/src/grpc_server/proto/grpc.proto +ARG CONTAINER_PROTO_DIR=testrun/python/src/grpc_server/proto + +COPY $NET_MODULE_DIR/dhcp-1/$NET_MODULE_PROTO_DIR $CONTAINER_PROTO_DIR/dhcp1/ +COPY $NET_MODULE_DIR/dhcp-2/$NET_MODULE_PROTO_DIR $CONTAINER_PROTO_DIR/dhcp2/ + # Start the test module ENTRYPOINT [ "/testrun/bin/start_module" ] \ No newline at end of file diff --git a/modules/test/base/bin/setup_grpc_clients b/modules/test/base/bin/setup_grpc_clients new file mode 100644 index 000000000..30efe5002 --- /dev/null +++ b/modules/test/base/bin/setup_grpc_clients @@ -0,0 +1,34 @@ +#!/bin/bash -e + +GRPC_DIR="/testrun/python/src/grpc_server" +GRPC_PROTO_DIR="proto" +GRPC_PROTO_FILE="grpc.proto" + +# Build the grpc proto file +build_grpc_client(){ + MODULE=$1 + echo "Building gRPC proto: $MODULE" + python3 -m grpc_tools.protoc --proto_path=. ./$GRPC_PROTO_DIR/$MODULE/$GRPC_PROTO_FILE --python_out=. --grpc_python_out=. +} + +# Build the grpc proto files for every module that has a proto defined +build_grpc_clients(){ + + for dir in "$GRPC_DIR/$GRPC_PROTO_DIR"/*/;do + if [ -f $dir/$GRPC_PROTO_FILE ];then + # Extract the last folder name + last_folder="${dir%%/}" + last_folder="${last_folder##*/}" + build_grpc_client "$last_folder" + fi + done +} + +# Move into the grpc directory. +# This is necessary to build the proto files +# with the correct import paths +pushd $GRPC_DIR >/dev/null 2>&1 + +build_grpc_clients + +popd >/dev/null 2>&1 \ No newline at end of file diff --git a/modules/test/base/bin/setup_python_path b/modules/test/base/bin/setup_python_path new file mode 100644 index 000000000..8201bbb36 --- /dev/null +++ b/modules/test/base/bin/setup_python_path @@ -0,0 +1,25 @@ +#!/bin/bash + +ROOT_DIRECTORY="/testrun/python/src" + +# Function to recursively add subdirectories to PYTHONPATH +add_subdirectories_to_pythonpath() { + local directory=$1 + local subdirectories=( "$directory"/* ) + local subdirectory + + for subdirectory in "${subdirectories[@]}"; do + if [ -d "$subdirectory" ]; then + export PYTHONPATH="$PYTHONPATH:$subdirectory" + add_subdirectories_to_pythonpath "$subdirectory" + fi + done +} + +# Set PYTHONPATH initially to an empty string +export PYTHONPATH="" + +# Add all subdirectories to PYTHONPATH +add_subdirectories_to_pythonpath "$ROOT_DIRECTORY" + +echo "$PYTHONPATH" \ No newline at end of file diff --git a/modules/test/base/bin/start_module b/modules/test/base/bin/start_module index 5f6e1ee35..82c9d26bf 100644 --- a/modules/test/base/bin/start_module +++ b/modules/test/base/bin/start_module @@ -57,10 +57,21 @@ then exit 1 fi -echo "Starting module $MODULE_NAME..." +# Setup the PYTHONPATH so all imports work as expected +echo "Setting up PYTHONPATH..." +export PYTHONPATH=$($BIN_DIR/setup_python_path) +echo "PYTHONPATH: $PYTHONPATH" + +# Build all gRPC files from the proto for use in +# gRPC clients for communications to network modules +echo "Building gRPC files from available proto files..." +$BIN_DIR/setup_grpc_clients +echo "Configuring binary files..." $BIN_DIR/setup_binaries $BIN_DIR +echo "Starting module $MODULE_NAME..." + # Only start network services if the test container needs # a network connection to run its tests if [ $NETWORK_REQUIRED == "true" ];then @@ -78,9 +89,9 @@ then if [[ ! -z $GRPC_PORT && ! $GRPC_PORT == "null" ]] then echo "gRPC port resolved from config: $GRPC_PORT" - $BIN_DIR/start_grpc "-p $GRPC_PORT" & + $BIN_DIR/start_grpc "-p $GRPC_PORT" else - $BIN_DIR/start_grpc & + $BIN_DIR/start_grpc fi fi diff --git a/modules/test/base/python/src/grpc/proto/dhcp1/client.py b/modules/test/base/python/src/grpc/proto/dhcp1/client.py new file mode 100644 index 000000000..921929edb --- /dev/null +++ b/modules/test/base/python/src/grpc/proto/dhcp1/client.py @@ -0,0 +1,98 @@ +import grpc +import grpc_pb2_grpc as pb2_grpc +import grpc_pb2 as pb2 + +DEFAULT_PORT = '5001' +DEFAULT_HOST = '10.10.10.2' # Default DHCP1 server + + +class Client(): + + def __init__(self, port=DEFAULT_PORT, host=DEFAULT_HOST): + self._port = port + self._host = host + + # Create a gRPC channel to connect to the server + self._channel = grpc.insecure_channel(self._host + ':' + self._port) + + # Create a gRPC stub + self._stub = pb2_grpc.NetworkModuleStub(self._channel) + + def add_reserved_lease(self, hostname, hw_addr, ip_addr): + # Create a request message + request = pb2.AddReservedLeaseRequest() + request.hostname = hostname + request.hw_addr = hw_addr + request.ip_addr = ip_addr + + # Make the RPC call + response = self._stub.AddReservedLease(request) + + return response + + def delete_reserved_lease(self, hw_addr): + # Create a request message + request = pb2.DeleteReservedLeaseRequest() + request.hw_addr = hw_addr + + # Make the RPC call + response = self._stub.DeleteReservedLease(request) + + return response + + def disable_failover(self): + # Create a request message + request = pb2.DisableFailoverRequest() + + # Make the RPC call + response = self._stub.DisableFailover(request) + + return response + + def enable_failover(self): + # Create a request message + request = pb2.EnableFailoverRequest() + + # Make the RPC call + response = self._stub.EnableFailover(request) + + return response + + def get_dhcp_range(self): + # Create a request message + request = pb2.GetDHCPRangeRequest() + + # Make the RPC call + response = self._stub.GetDHCPRange(request) + + return response + + def get_lease(self,hw_addr): + # Create a request message + request = pb2.GetLeaseRequest() + request.hw_addr=hw_addr + + # Make the RPC call + response = self._stub.GetLease(request) + + return response + + def get_status(self): + # Create a request message + request = pb2.GetStatusRequest() + + # Make the RPC call + response = self._stub.GetStatus(request) + + return response + + def set_dhcp_range(self,start,end): + # Create a request message + request = pb2.SetDHCPRangeRequest() + request.start=start + request.end=end + + # Make the RPC call + response = self._stub.SetDHCPRange(request) + + return response diff --git a/modules/test/conn/conn.Dockerfile b/modules/test/conn/conn.Dockerfile index 1714f49f2..5d8148335 100644 --- a/modules/test/conn/conn.Dockerfile +++ b/modules/test/conn/conn.Dockerfile @@ -17,6 +17,8 @@ FROM test-run/base-test:latest ARG MODULE_NAME=conn ARG MODULE_DIR=modules/test/$MODULE_NAME +ARG GRPC_PROTO_DIR=/testrun/python/src/grpc/proto/dhcp +ARG GRPC_PROTO_FILE="grpc.proto" # Install all necessary packages RUN apt-get install -y wget @@ -37,4 +39,4 @@ COPY $MODULE_DIR/conf /testrun/conf COPY $MODULE_DIR/bin /testrun/bin # Copy over all python files -COPY $MODULE_DIR/python /testrun/python +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 196c335d8..a1727df23 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -17,6 +17,7 @@ import sys from scapy.all import * from test_module import TestModule +from dhcp1.client import Client as DHCPClient1 LOG_NAME = "test_connection" LOGGER = None @@ -33,6 +34,34 @@ def __init__(self, module): super().__init__(module_name=module, log_name=LOG_NAME) global LOGGER LOGGER = self._get_logger() + self.dhcp1_client = DHCPClient1() + + # ToDo: Move this into some level of testing, leave for + # reference until tests are implemented with these calls + # response = self.dhcp1_client.add_reserved_lease('test','00:11:22:33:44:55','10.10.10.21') + # print("AddLeaseResp: " + str(response)) + + # response = self.dhcp1_client.delete_reserved_lease('00:11:22:33:44:55') + # print("DelLeaseResp: " + str(response)) + + # response = self.dhcp1_client.disable_failover() + # print("FailoverDisabled: " + str(response)) + + # response = self.dhcp1_client.enable_failover() + # print("FailoverEnabled: " + str(response)) + + # response = self.dhcp1_client.get_dhcp_range() + # print("DHCP Range: " + str(response)) + + # response = self.dhcp1_client.get_lease(self._device_mac) + # print("Lease: " + str(response)) + + # response = self.dhcp1_client.get_status() + # print("Status: " + str(response)) + + # response = self.dhcp1_client.set_dhcp_range('10.10.10.20','10.10.10.30') + # print("Set Range: " + str(response)) + def _connection_mac_address(self): LOGGER.info("Running connection.mac_address") diff --git a/testing/test_baseline b/testing/test_baseline index ac47a5cfa..f12d124de 100755 --- a/testing/test_baseline +++ b/testing/test_baseline @@ -82,4 +82,4 @@ more $TESTRUN_OUT pytest testing/ -exit $? +exit $? \ No newline at end of file diff --git a/testing/unit_test/run_tests.sh b/testing/unit_test/run_tests.sh new file mode 100644 index 000000000..5b1ed6257 --- /dev/null +++ b/testing/unit_test/run_tests.sh @@ -0,0 +1,18 @@ +#!/bin/bash -e + +# This script should be run from within the unit_test directory. If +# it is run outside this directory, paths will not be resolved correctly. + +# Move into the root directory of test-run +pushd ../../ >/dev/null 2>&1 + +echo "Root Dir: $PWD" + +# Setup the python path +export PYTHONPATH="$PWD/framework/python/src" + +# Run the DHCP Unit tests +python3 -u $PWD/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py +python3 -u $PWD/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py + +popd >/dev/null 2>&1 \ No newline at end of file From af8367c704ca02acd4e2b1937f667610986618d6 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 6 Jul 2023 12:31:31 -0700 Subject: [PATCH 045/400] Dhcp (#67) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Move isc-dhcp-server and radvd to services Move DHCP server monitoring and booting to python script * Add grpc methods to interact with dhcp_server module Update dhcp_server to control radvd server directly from calls Fix radvd service status method * Add updates to dhcp2 module Update radvd service * Add license headers --- modules/network/dhcp-1/bin/radvd-service | 55 ++++++++ .../network/dhcp-1/bin/start_network_service | 56 ++------ modules/network/dhcp-1/conf/isc-dhcp-server | 4 + modules/network/dhcp-1/dhcp-1.Dockerfile | 2 +- .../python/src/grpc_server/dhcp_server.py | 130 ++++++++++++++++++ .../python/src/grpc_server/network_service.py | 43 +++++- .../python/src/grpc_server/proto/grpc.proto | 16 ++- .../python/src/grpc_server/radvd_server.py | 55 ++++++++ modules/network/dhcp-2/bin/radvd-service | 55 ++++++++ .../network/dhcp-2/bin/start_network_service | 56 ++------ modules/network/dhcp-2/conf/isc-dhcp-server | 4 + modules/network/dhcp-2/dhcp-2.Dockerfile | 11 +- .../python/src/grpc_server/dhcp_config.py | 4 +- .../python/src/grpc_server/dhcp_server.py | 130 ++++++++++++++++++ .../python/src/grpc_server/network_service.py | 43 +++++- .../python/src/grpc_server/proto/grpc.proto | 14 +- .../python/src/grpc_server/radvd_server.py | 55 ++++++++ 17 files changed, 622 insertions(+), 111 deletions(-) create mode 100644 modules/network/dhcp-1/bin/radvd-service create mode 100644 modules/network/dhcp-1/conf/isc-dhcp-server create mode 100644 modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py create mode 100644 modules/network/dhcp-1/python/src/grpc_server/radvd_server.py create mode 100644 modules/network/dhcp-2/bin/radvd-service create mode 100644 modules/network/dhcp-2/conf/isc-dhcp-server create mode 100644 modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py create mode 100644 modules/network/dhcp-2/python/src/grpc_server/radvd_server.py diff --git a/modules/network/dhcp-1/bin/radvd-service b/modules/network/dhcp-1/bin/radvd-service new file mode 100644 index 000000000..1cfe499cb --- /dev/null +++ b/modules/network/dhcp-1/bin/radvd-service @@ -0,0 +1,55 @@ +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +RA_PID_FILE=/var/run/radvd/radvd.pid +RA_LOG_FILE=/runtime/network/dhcp1-radvd.log + +stop_radvd(){ + # Directly kill by PID file reference + if [ -f "$RA_PID_FILE" ]; then + kill -9 $(cat $RA_PID_FILE) || true + rm -f $RA_PID_FILE + fi +} + +start_radvd(){ + /usr/sbin/radvd -m logfile -l $RA_LOG_FILE -p $RA_PID_FILE +} + +case "$1" in + start) + start_radvd + ;; + stop) + stop_radvd + ;; + restart) + stop_radvd + sleep 1 + start_radvd + ;; + status) + if [ -f "$RA_PID_FILE" ]; then + echo "radvd service is running." + else + echo "radvd service is not running." + fi + ;; + *) + echo "Usage: $0 {start|stop|status|restart}" + exit 1 + ;; +esac \ No newline at end of file diff --git a/modules/network/dhcp-1/bin/start_network_service b/modules/network/dhcp-1/bin/start_network_service index 9f4a3dc51..82b4c6e33 100644 --- a/modules/network/dhcp-1/bin/start_network_service +++ b/modules/network/dhcp-1/bin/start_network_service @@ -29,63 +29,23 @@ sysctl -p # Create leases file if needed touch /var/lib/dhcp/dhcpd.leases -#Create directory for radvd +# Create directory for radvd mkdir /var/run/radvd -#Create and set permissions on the log files +# Create and set permissions on the log files touch $DHCP_LOG_FILE touch $RA_LOG_FILE chown $HOST_USER $DHCP_LOG_FILE chown $HOST_USER $RA_LOG_FILE -#Move the config files to the correct location +# Move the config files to the correct location +cp /testrun/conf/isc-dhcp-server /etc/default/ cp /testrun/conf/dhcpd.conf /etc/dhcp/dhcpd.conf cp /testrun/conf/radvd.conf /etc/radvd.conf -# Restart dhcp server when config changes -while true; do +# Move the radvd-sevice file to the correct location +cp /testrun/bin/radvd-service /usr/local/bin/ - new_checksum=$(md5sum $CONFIG_FILE) - - if [ "$checksum" == "$new_checksum" ]; then - sleep 2 - continue - fi - - echo Config changed. Restarting dhcp server at $(date).. - - if [ -f $DHCP_PID_FILE ]; then - kill -9 $(cat $DHCP_PID_FILE) || true - rm -f $DHCP_PID_FILE - fi - - if [ -f $RA_PID_FILE ]; then - kill -9 $(cat $RA_PID_FILE) || true - rm -f $RA_PID_FILE - fi - - checksum=$new_checksum - - echo Starting isc-dhcp-server at $(date) - - radvd -m logfile -l $RA_LOG_FILE -p $RA_PID_FILE - dhcpd -d &> $DHCP_LOG_FILE & - - while [ ! -f $DHCP_PID_FILE ]; do - echo Waiting for $DHCP_PID_FILE... - sleep 2 - done - - echo $DHCP_PID_FILE now available - - while [ ! -f $RA_PID_FILE ]; do - echo Waiting for $RA_PID_FILE... - sleep 2 - done - - echo $RA_PID_FILE now available - - echo Server now stable - -done \ No newline at end of file +# Start the DHCP Server +python3 -u /testrun/python/src/grpc_server/dhcp_server.py \ No newline at end of file diff --git a/modules/network/dhcp-1/conf/isc-dhcp-server b/modules/network/dhcp-1/conf/isc-dhcp-server new file mode 100644 index 000000000..44db95cd9 --- /dev/null +++ b/modules/network/dhcp-1/conf/isc-dhcp-server @@ -0,0 +1,4 @@ +# On what interfaces should the DHCP server (dhcpd) serve DHCP requests? +# Separate multiple interfaces with spaces, e.g. "eth0 eth1". +INTERFACESv4="veth0" +#INTERFACESv6="veth0" diff --git a/modules/network/dhcp-1/dhcp-1.Dockerfile b/modules/network/dhcp-1/dhcp-1.Dockerfile index b47378045..6b941d878 100644 --- a/modules/network/dhcp-1/dhcp-1.Dockerfile +++ b/modules/network/dhcp-1/dhcp-1.Dockerfile @@ -25,7 +25,7 @@ RUN apt-get install -y wget RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ # Install dhcp server -RUN apt-get install -y isc-dhcp-server radvd +RUN apt-get install -y isc-dhcp-server radvd systemd # Copy over all configuration files COPY $MODULE_DIR/conf /testrun/conf diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py new file mode 100644 index 000000000..2f67b0c2d --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py @@ -0,0 +1,130 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +DHCP server""" +import time +from common import logger +from common import util +from dhcp_config import DHCPConfig +from radvd_server import RADVDServer + +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' +LOG_NAME = 'dhcp_server' +LOGGER = None + + +class DHCPServer: + """Represents the DHCP Server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + self.dhcp_config = DHCPConfig() + self.radvd = RADVDServer() + self.dhcp_config.resolve_config() + + def restart(self): + LOGGER.info("Restarting DHCP Server") + isc_started = util.run_command("service isc-dhcp-server restart", False) + radvd_started = self.radvd.restart() + started = isc_started and radvd_started + LOGGER.info("DHCP Restarted: " + str(started)) + return started + + def start(self): + LOGGER.info("Starting DHCP Server") + isc_started = util.run_command("service isc-dhcp-server start", False) + radvd_started = self.radvd.start() + started = isc_started and radvd_started + LOGGER.info("DHCP Started: " + str(started)) + return started + + def stop(self): + LOGGER.info("Stopping DHCP Server") + isc_stopped = util.run_command("service isc-dhcp-server stop", False) + radvd_stopped = self.radvd.stop() + stopped = isc_stopped and radvd_stopped + LOGGER.info("DHCP Stopped: " + str(stopped)) + return stopped + + def is_running(self): + LOGGER.info("Checking DHCP Status") + response = util.run_command("service isc-dhcp-server status") + isc_running = response[0] == 'Status of ISC DHCPv4 server: dhcpd is running.' + radvd_running = self.radvd.is_running() + running = isc_running and radvd_running + LOGGER.info("DHCP Status: " + str(running)) + return running + + def boot(self): + LOGGER.info("Booting DHCP Server") + isc_booted = False + radvd_booted = False + if self.is_running(): + LOGGER.info("Stopping isc-dhcp-server") + stopped = self.stop() + LOGGER.info("isc-dhcp-server stopped: " + str(stopped)) + + if self.radvd.is_running(): + LOGGER.info("Stopping RADVD") + stopped = self.radvd.stop() + LOGGER.info("radvd stopped: " + str(stopped)) + + LOGGER.info("Starting isc-dhcp-server") + if self.start(): + isc_booted = False + # Scan for 5 seconds if not yet ready + for i in range(5): + time.sleep(1) + isc_booted = self.is_running() + if isc_booted: + break; + LOGGER.info("isc-dhcp-server started: " + str(isc_booted)) + + LOGGER.info("Starting RADVD") + if self.radvd.start(): + radvd_booted = False + # Scan for 5 seconds if not yet ready + for i in range(5): + time.sleep(1) + radvd_booted = self.radvd.is_running() + if radvd_booted: + break; + LOGGER.info("RADVD started: " + str(radvd_booted)) + + + + return isc_booted and radvd_booted + +def run(): + dhcp_server = DHCPServer() + booted = dhcp_server.boot() + + if not booted: + LOGGER.error('DHCP Server Failed to boot. Exiting') + sys.exit(1) + + config = str(dhcp_server.dhcp_config) + while True: + dhcp_server.dhcp_config.resolve_config() + new_config = str(dhcp_server.dhcp_config) + if config != new_config: + LOGGER.info("DHCP Config Changed") + config = new_config + success = dhcp_server.restart() + success = dhcp_server.radvd.restart() + time.sleep(1) + +if __name__ == '__main__': + run() diff --git a/modules/network/dhcp-1/python/src/grpc_server/network_service.py b/modules/network/dhcp-1/python/src/grpc_server/network_service.py index bf2b98803..a693ac3a1 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/network_service.py +++ b/modules/network/dhcp-1/python/src/grpc_server/network_service.py @@ -15,6 +15,7 @@ import proto.grpc_pb2_grpc as pb2_grpc import proto.grpc_pb2 as pb2 +from dhcp_server import DHCPServer from dhcp_config import DHCPConfig from dhcp_leases import DHCPLeases @@ -28,6 +29,7 @@ class NetworkService(pb2_grpc.NetworkModule): """gRPC endpoints for the DHCP Server""" def __init__(self): + self._dhcp_server = DHCPServer() self._dhcp_config = None self.dhcp_leases = DHCPLeases() global LOGGER @@ -39,6 +41,42 @@ def _get_dhcp_config(self): self._dhcp_config.resolve_config() return self._dhcp_config + def RestartDHCPServer(self, request, context): # pylint: disable=W0613 + LOGGER.info('Restarting DHCP server') + try: + started = self._dhcp_server.restart() + LOGGER.info('DHCP server restarted: ' + (str(started))) + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to restart DHCP server: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def StartDHCPServer(self, request, context): # pylint: disable=W0613 + LOGGER.info('Starting DHCP server') + try: + started = self._dhcp_server.start() + LOGGER.info('DHCP server started: ' + (str(started))) + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to start DHCP server: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def StopDHCPServer(self, request, context): # pylint: disable=W0613 + LOGGER.info('Stopping DHCP server') + try: + stopped = self._dhcp_server.stop() + LOGGER.info('DHCP server stopped: ' + (str(stopped))) + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to stop DHCP server: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + def AddReservedLease(self, request, context): # pylint: disable=W0613 LOGGER.info('Add reserved lease called') try: @@ -151,7 +189,6 @@ def GetStatus(self, request, context): # pylint: disable=W0613 """ Return the current status of the network module """ - # ToDo: Figure out how to resolve the current DHCP status - dhcp_status = True + dhcp_status = self._dhcp_server.is_running() message = str({'dhcpStatus': dhcp_status}) - return pb2.Response(code=200, message=message) + return pb2.Response(code=200, message=message) \ No newline at end of file diff --git a/modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto b/modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto index d9f56213e..e6abda674 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto +++ b/modules/network/dhcp-1/python/src/grpc_server/proto/grpc.proto @@ -2,6 +2,12 @@ syntax = "proto3"; service NetworkModule { + rpc RestartDHCPServer(RestartDHCPServerRequest) returns (Response) {}; + + rpc StartDHCPServer(StartDHCPServerRequest) returns (Response) {}; + + rpc StopDHCPServer(StopDHCPServerRequest) returns (Response) {}; + rpc AddReservedLease(AddReservedLeaseRequest) returns (Response) {}; rpc DeleteReservedLease(DeleteReservedLeaseRequest) returns (Response) {}; @@ -29,6 +35,12 @@ message DeleteReservedLeaseRequest { string hw_addr = 1; } +message RestartDHCPServerRequest {} + +message StartDHCPServerRequest {} + +message StopDHCPServerRequest {} + message DisableFailoverRequest {} message EnableFailoverRequest {} @@ -53,7 +65,7 @@ message Response { } message DHCPRange { - int32 code = 1; + int32 code = 1; string start = 2; string end = 3; -} +} \ No newline at end of file diff --git a/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py b/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py new file mode 100644 index 000000000..48e063e61 --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py @@ -0,0 +1,55 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +DHCP server""" +import time +from common import logger +from common import util +from dhcp_config import DHCPConfig + +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' +LOG_NAME = 'radvd' +LOGGER = None + + +class RADVDServer: + """Represents the RADVD Server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + + def restart(self): + LOGGER.info("Restarting RADVD Server") + response = util.run_command("radvd-service restart", False) + LOGGER.info("RADVD Restarted: " + str(response)) + return response + + def start(self): + LOGGER.info("Starting RADVD Server") + response = util.run_command("radvd-service start", False) + LOGGER.info("RADVD Started: " + str(response)) + return response + + def stop(self): + LOGGER.info("Stopping RADVD Server") + response = util.run_command("radvd-service stop", False) + LOGGER.info("RADVD Stopped: " + str(response)) + return response + + def is_running(self): + LOGGER.info("Checking RADVD Status") + response = util.run_command("radvd-service status") + LOGGER.info("RADVD Status: " + str(response)) + return response[0] == 'radvd service is running.' diff --git a/modules/network/dhcp-2/bin/radvd-service b/modules/network/dhcp-2/bin/radvd-service new file mode 100644 index 000000000..912c64ee3 --- /dev/null +++ b/modules/network/dhcp-2/bin/radvd-service @@ -0,0 +1,55 @@ +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +RA_PID_FILE=/var/run/radvd/radvd.pid +RA_LOG_FILE=/runtime/network/dhcp2-radvd.log + +stop_radvd(){ + # Directly kill by PID file reference + if [ -f "$RA_PID_FILE" ]; then + kill -9 $(cat $RA_PID_FILE) || true + rm -f $RA_PID_FILE + fi +} + +start_radvd(){ + /usr/sbin/radvd -m logfile -l $RA_LOG_FILE -p $RA_PID_FILE +} + +case "$1" in + start) + start_radvd + ;; + stop) + stop_radvd + ;; + restart) + stop_radvd + sleep 1 + start_radvd + ;; + status) + if [ -f "$RA_PID_FILE" ]; then + echo "radvd service is running." + else + echo "radvd service is not running." + fi + ;; + *) + echo "Usage: $0 {start|stop|status|restart}" + exit 1 + ;; +esac \ No newline at end of file diff --git a/modules/network/dhcp-2/bin/start_network_service b/modules/network/dhcp-2/bin/start_network_service index 723689278..ed7d3125e 100644 --- a/modules/network/dhcp-2/bin/start_network_service +++ b/modules/network/dhcp-2/bin/start_network_service @@ -29,63 +29,23 @@ sysctl -p # Create leases file if needed touch /var/lib/dhcp/dhcpd.leases -#Create directory for radvd +# Create directory for radvd mkdir /var/run/radvd -#Create and set permissions on the log files +# Create and set permissions on the log files touch $DHCP_LOG_FILE touch $RA_LOG_FILE chown $HOST_USER $DHCP_LOG_FILE chown $HOST_USER $RA_LOG_FILE -#Move the config files to the correct location +# Move the config files to the correct location +cp /testrun/conf/isc-dhcp-server /etc/default/ cp /testrun/conf/dhcpd.conf /etc/dhcp/dhcpd.conf cp /testrun/conf/radvd.conf /etc/radvd.conf -# Restart dhcp server when config changes -while true; do +# Move the radvd-sevice file to the correct location +cp /testrun/bin/radvd-service /usr/local/bin/ - new_checksum=$(md5sum $CONFIG_FILE) - - if [ "$checksum" == "$new_checksum" ]; then - sleep 2 - continue - fi - - echo Config changed. Restarting dhcp server at $(date).. - - if [ -f $DHCP_PID_FILE ]; then - kill -9 $(cat $DHCP_PID_FILE) || true - rm -f $DHCP_PID_FILE - fi - - if [ -f $RA_PID_FILE ]; then - kill -9 $(cat $RA_PID_FILE) || true - rm -f $RA_PID_FILE - fi - - checksum=$new_checksum - - echo Starting isc-dhcp-server at $(date) - - radvd -m logfile -l $RA_LOG_FILE -p $RA_PID_FILE - dhcpd -d &> $DHCP_LOG_FILE & - - while [ ! -f $DHCP_PID_FILE ]; do - echo Waiting for $DHCP_PID_FILE... - sleep 2 - done - - echo $DHCP_PID_FILE now available - - while [ ! -f $RA_PID_FILE ]; do - echo Waiting for $RA_PID_FILE... - sleep 2 - done - - echo $RA_PID_FILE now available - - echo Server now stable - -done \ No newline at end of file +# Start the DHCP Server +python3 -u /testrun/python/src/grpc_server/dhcp_server.py \ No newline at end of file diff --git a/modules/network/dhcp-2/conf/isc-dhcp-server b/modules/network/dhcp-2/conf/isc-dhcp-server new file mode 100644 index 000000000..44db95cd9 --- /dev/null +++ b/modules/network/dhcp-2/conf/isc-dhcp-server @@ -0,0 +1,4 @@ +# On what interfaces should the DHCP server (dhcpd) serve DHCP requests? +# Separate multiple interfaces with spaces, e.g. "eth0 eth1". +INTERFACESv4="veth0" +#INTERFACESv6="veth0" diff --git a/modules/network/dhcp-2/dhcp-2.Dockerfile b/modules/network/dhcp-2/dhcp-2.Dockerfile index df77cb811..153aa50e7 100644 --- a/modules/network/dhcp-2/dhcp-2.Dockerfile +++ b/modules/network/dhcp-2/dhcp-2.Dockerfile @@ -18,8 +18,14 @@ FROM test-run/base:latest ARG MODULE_NAME=dhcp-2 ARG MODULE_DIR=modules/network/$MODULE_NAME +# Install all necessary packages +RUN apt-get install -y wget + +#Update the oui.txt file from ieee +RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ + # Install dhcp server -RUN apt-get install -y isc-dhcp-server radvd +RUN apt-get install -y isc-dhcp-server radvd systemd # Copy over all configuration files COPY $MODULE_DIR/conf /testrun/conf @@ -28,5 +34,4 @@ COPY $MODULE_DIR/conf /testrun/conf COPY $MODULE_DIR/bin /testrun/bin # Copy over all python files -COPY $MODULE_DIR/python /testrun/python - +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py index 444faa87c..33cb5938c 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py @@ -33,7 +33,7 @@ def __init__(self): self._peer = None self._reserved_hosts = [] global LOGGER - LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') def add_reserved_host(self, hostname, hw_addr, ip_addr): host = DHCPReservedHost(hostname=hostname, @@ -490,4 +490,4 @@ def resolve_host(self, reserved_host): self.hw_addr = part.strip().split(HARDWARE_KEY)[1].strip().split(';')[0] elif FIXED_ADDRESS_KEY in part: self.fixed_addr = part.strip().split( - FIXED_ADDRESS_KEY)[1].strip().split(';')[0] + FIXED_ADDRESS_KEY)[1].strip().split(';')[0] \ No newline at end of file diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py new file mode 100644 index 000000000..1431d6ddd --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py @@ -0,0 +1,130 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +DHCP server""" +import time +from common import logger +from common import util +from dhcp_config import DHCPConfig +from radvd_server import RADVDServer + +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' +LOG_NAME = 'dhcp_server' +LOGGER = None + + +class DHCPServer: + """Represents the DHCP Server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') + self.dhcp_config = DHCPConfig() + self.radvd = RADVDServer() + self.dhcp_config.resolve_config() + + def restart(self): + LOGGER.info("Restarting DHCP Server") + isc_started = util.run_command("service isc-dhcp-server restart", False) + radvd_started = self.radvd.restart() + started = isc_started and radvd_started + LOGGER.info("DHCP Restarted: " + str(started)) + return started + + def start(self): + LOGGER.info("Starting DHCP Server") + isc_started = util.run_command("service isc-dhcp-server start", False) + radvd_started = self.radvd.start() + started = isc_started and radvd_started + LOGGER.info("DHCP Started: " + str(started)) + return started + + def stop(self): + LOGGER.info("Stopping DHCP Server") + isc_stopped = util.run_command("service isc-dhcp-server stop", False) + radvd_stopped = self.radvd.stop() + stopped = isc_stopped and radvd_stopped + LOGGER.info("DHCP Stopped: " + str(stopped)) + return stopped + + def is_running(self): + LOGGER.info("Checking DHCP Status") + response = util.run_command("service isc-dhcp-server status") + isc_running = response[0] == 'Status of ISC DHCPv4 server: dhcpd is running.' + radvd_running = self.radvd.is_running() + running = isc_running and radvd_running + LOGGER.info("DHCP Status: " + str(running)) + return running + + def boot(self): + LOGGER.info("Booting DHCP Server") + isc_booted = False + radvd_booted = False + if self.is_running(): + LOGGER.info("Stopping isc-dhcp-server") + stopped = self.stop() + LOGGER.info("isc-dhcp-server stopped: " + str(stopped)) + + if self.radvd.is_running(): + LOGGER.info("Stopping RADVD") + stopped = self.radvd.stop() + LOGGER.info("radvd stopped: " + str(stopped)) + + LOGGER.info("Starting isc-dhcp-server") + if self.start(): + isc_booted = False + # Scan for 5 seconds if not yet ready + for i in range(5): + time.sleep(1) + isc_booted = self.is_running() + if isc_booted: + break; + LOGGER.info("isc-dhcp-server started: " + str(isc_booted)) + + LOGGER.info("Starting RADVD") + if self.radvd.start(): + radvd_booted = False + # Scan for 5 seconds if not yet ready + for i in range(5): + time.sleep(1) + radvd_booted = self.radvd.is_running() + if radvd_booted: + break; + LOGGER.info("RADVD started: " + str(radvd_booted)) + + + + return isc_booted and radvd_booted + +def run(): + dhcp_server = DHCPServer() + booted = dhcp_server.boot() + + if not booted: + LOGGER.error('DHCP Server Failed to boot. Exiting') + sys.exit(1) + + config = str(dhcp_server.dhcp_config) + while True: + dhcp_server.dhcp_config.resolve_config() + new_config = str(dhcp_server.dhcp_config) + if config != new_config: + LOGGER.info("DHCP Config Changed") + config = new_config + success = dhcp_server.restart() + success = dhcp_server.radvd.restart() + time.sleep(1) + +if __name__ == '__main__': + run() diff --git a/modules/network/dhcp-2/python/src/grpc_server/network_service.py b/modules/network/dhcp-2/python/src/grpc_server/network_service.py index 053d26d6b..5af9e6c44 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/network_service.py +++ b/modules/network/dhcp-2/python/src/grpc_server/network_service.py @@ -15,6 +15,7 @@ import proto.grpc_pb2_grpc as pb2_grpc import proto.grpc_pb2 as pb2 +from dhcp_server import DHCPServer from dhcp_config import DHCPConfig from dhcp_leases import DHCPLeases @@ -28,6 +29,7 @@ class NetworkService(pb2_grpc.NetworkModule): """gRPC endpoints for the DHCP Server""" def __init__(self): + self._dhcp_server = DHCPServer() self._dhcp_config = None self.dhcp_leases = DHCPLeases() global LOGGER @@ -39,6 +41,42 @@ def _get_dhcp_config(self): self._dhcp_config.resolve_config() return self._dhcp_config + def RestartDHCPServer(self, request, context): # pylint: disable=W0613 + LOGGER.info('Restarting DHCP server') + try: + started = self._dhcp_server.restart() + LOGGER.info('DHCP server restarted: ' + (str(started))) + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to restart DHCP server: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def StartDHCPServer(self, request, context): # pylint: disable=W0613 + LOGGER.info('Starting DHCP server') + try: + started = self._dhcp_server.start() + LOGGER.info('DHCP server started: ' + (str(started))) + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to start DHCP server: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + + def StopDHCPServer(self, request, context): # pylint: disable=W0613 + LOGGER.info('Stopping DHCP server') + try: + stopped = self._dhcp_server.stop() + LOGGER.info('DHCP server stopped: ' + (str(stopped))) + return pb2.Response(code=200, message='{}') + except Exception as e: # pylint: disable=W0718 + fail_message = 'Failed to stop DHCP server: ' + str(e) + LOGGER.error(fail_message) + LOGGER.error(traceback.format_exc()) + return pb2.Response(code=500, message=fail_message) + def AddReservedLease(self, request, context): # pylint: disable=W0613 LOGGER.info('Add reserved lease called') try: @@ -151,7 +189,6 @@ def GetStatus(self, request, context): # pylint: disable=W0613 """ Return the current status of the network module """ - # ToDo: Figure out how to resolve the current DHCP status - dhcp_status = True + dhcp_status = self._dhcp_server.is_running() message = str({'dhcpStatus': dhcp_status}) - return pb2.Response(code=200, message=message) + return pb2.Response(code=200, message=message) \ No newline at end of file diff --git a/modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto b/modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto index b6a11a75b..e6abda674 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto +++ b/modules/network/dhcp-2/python/src/grpc_server/proto/grpc.proto @@ -2,6 +2,12 @@ syntax = "proto3"; service NetworkModule { + rpc RestartDHCPServer(RestartDHCPServerRequest) returns (Response) {}; + + rpc StartDHCPServer(StartDHCPServerRequest) returns (Response) {}; + + rpc StopDHCPServer(StopDHCPServerRequest) returns (Response) {}; + rpc AddReservedLease(AddReservedLeaseRequest) returns (Response) {}; rpc DeleteReservedLease(DeleteReservedLeaseRequest) returns (Response) {}; @@ -29,6 +35,12 @@ message DeleteReservedLeaseRequest { string hw_addr = 1; } +message RestartDHCPServerRequest {} + +message StartDHCPServerRequest {} + +message StopDHCPServerRequest {} + message DisableFailoverRequest {} message EnableFailoverRequest {} @@ -56,4 +68,4 @@ message DHCPRange { int32 code = 1; string start = 2; string end = 3; -} +} \ No newline at end of file diff --git a/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py b/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py new file mode 100644 index 000000000..0c6ef90d6 --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py @@ -0,0 +1,55 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +DHCP server""" +import time +from common import logger +from common import util +from dhcp_config import DHCPConfig + +CONFIG_FILE = '/etc/dhcp/dhcpd.conf' +LOG_NAME = 'radvd' +LOGGER = None + + +class RADVDServer: + """Represents the RADVD Server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') + + def restart(self): + LOGGER.info("Restarting RADVD Server") + response = util.run_command("radvd-service restart", False) + LOGGER.info("RADVD Restarted: " + str(response)) + return response + + def start(self): + LOGGER.info("Starting RADVD Server") + response = util.run_command("radvd-service start", False) + LOGGER.info("RADVD Started: " + str(response)) + return response + + def stop(self): + LOGGER.info("Stopping RADVD Server") + response = util.run_command("radvd-service stop", False) + LOGGER.info("RADVD Stopped: " + str(response)) + return response + + def is_running(self): + LOGGER.info("Checking RADVD Status") + response = util.run_command("radvd-service status") + LOGGER.info("RADVD Status: " + str(response)) + return response[0] == 'radvd service is running.' From 7dd5772a275ac6530b594c7b149da1677e026a6c Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 6 Jul 2023 15:22:52 -0700 Subject: [PATCH 046/400] Add connection.dhcp_address test (#68) --- modules/test/conn/conf/module_config.json | 5 +++++ .../test/conn/python/src/connection_module.py | 19 +++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index 0f599c5d3..4053b4e26 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -12,6 +12,11 @@ "timeout": 30 }, "tests": [ + { + "name": "connection.dhcp_address", + "description": "The device under test has received an IP address from the DHCP server and responds to an ICMP echo (ping) request", + "expected_behavior": "The device is not setup with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds succesfully to an ICMP echo (ping) request." + }, { "name": "connection.mac_address", "description": "Check and note device physical address.", diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index a1727df23..5b3bf7038 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -62,6 +62,25 @@ def __init__(self, module): # response = self.dhcp1_client.set_dhcp_range('10.10.10.20','10.10.10.30') # print("Set Range: " + str(response)) + def _connection_dhcp_address(self): + LOGGER.info("Running connection.dhcp_address") + response = self.dhcp1_client.get_lease(self._device_mac) + LOGGER.info("DHCP Lease resolved:\n" + str(response)) + if response.code == 200: + lease = eval(response.message) + if 'ip' in lease: + ip_addr = lease['ip'] + LOGGER.info("IP Resolved: " + ip_addr) + LOGGER.info("Attempting to ping device..."); + ping_success = self._ping(self._device_ipv4_addr) + LOGGER.info("Ping Success: " + str(ping_success)) + if ping_success: + return True, "Device responded to leased ip address" + else: + return False, "Device did not respond to leased ip address" + else: + LOGGER.info("No DHCP lease found for: " + self._device_mac) + return False, "No DHCP lease found for: " + self._device_mac def _connection_mac_address(self): LOGGER.info("Running connection.mac_address") From 9ef0d4fad7d4d0fadd0fcb56b4a850757f04cd6b Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 12 Jul 2023 09:37:20 +0100 Subject: [PATCH 047/400] Add NTP tests (#60) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * Pylint (#69) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> --- .../python/src/net_orc/network_validator.py | 12 +- .../python/src/test_orc/test_orchestrator.py | 17 +- .../python/src/grpc_server/dhcp_config.py | 47 +++--- .../src/grpc_server/dhcp_config_test.py | 150 +++++++++--------- .../python/src/grpc_server/dhcp_server.py | 72 ++++----- .../python/src/grpc_server/network_service.py | 24 +-- .../python/src/grpc_server/radvd_server.py | 26 ++- .../python/src/grpc_server/dhcp_config.py | 47 ++++-- .../src/grpc_server/dhcp_config_test.py | 147 +++++++++-------- .../python/src/grpc_server/dhcp_server.py | 72 ++++----- .../python/src/grpc_server/network_service.py | 25 +-- .../python/src/grpc_server/radvd_server.py | 26 ++- modules/test/base/python/src/test_module.py | 9 +- .../test/conn/python/src/connection_module.py | 99 ++++++------ modules/test/nmap/nmap.Dockerfile | 4 +- modules/test/ntp/bin/start_test_module | 42 +++++ modules/test/ntp/conf/module_config.json | 27 ++++ modules/test/ntp/ntp.Dockerfile | 20 +++ modules/test/ntp/python/requirements.txt | 1 + modules/test/ntp/python/src/ntp_module.py | 79 +++++++++ modules/test/ntp/python/src/run.py | 75 +++++++++ resources/devices/template/device_config.json | 29 ++++ testing/test_pylint | 2 +- 23 files changed, 672 insertions(+), 380 deletions(-) create mode 100644 modules/test/ntp/bin/start_test_module create mode 100644 modules/test/ntp/conf/module_config.json create mode 100644 modules/test/ntp/ntp.Dockerfile create mode 100644 modules/test/ntp/python/requirements.txt create mode 100644 modules/test/ntp/python/src/ntp_module.py create mode 100644 modules/test/ntp/python/src/run.py diff --git a/framework/python/src/net_orc/network_validator.py b/framework/python/src/net_orc/network_validator.py index a4c51eb2d..f82787af5 100644 --- a/framework/python/src/net_orc/network_validator.py +++ b/framework/python/src/net_orc/network_validator.py @@ -193,7 +193,7 @@ def _get_os_user(self): LOGGER.error('An OS error occurred while retrieving the login name.') except Exception as error: # Catch any other unexpected exceptions - LOGGER.error('An exception occurred:', error) + LOGGER.error('An exception occurred:', error) return user def _get_user(self): @@ -203,15 +203,15 @@ def _get_user(self): except (KeyError, ImportError, ModuleNotFoundError, OSError) as e: # Handle specific exceptions individually if isinstance(e, KeyError): - LOGGER.error("USER environment variable not set or unavailable.") + LOGGER.error('USER environment variable not set or unavailable.') elif isinstance(e, ImportError): - LOGGER.error("Unable to import the getpass module.") + LOGGER.error('Unable to import the getpass module.') elif isinstance(e, ModuleNotFoundError): - LOGGER.error("The getpass module was not found.") + LOGGER.error('The getpass module was not found.') elif isinstance(e, OSError): - LOGGER.error("An OS error occurred while retrieving the username.") + LOGGER.error('An OS error occurred while retrieving the username.') else: - LOGGER.error("An exception occurred:", e) + LOGGER.error('An exception occurred:', e) return user def _get_device_status(self, module): diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index 4bc9fc003..fef4e5bb5 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -13,16 +13,14 @@ # limitations under the License. """Provides high level management of the test orchestrator.""" -import getpass import os import json import time import shutil import docker from docker.types import Mount -from common import logger +from common import logger, util from test_orc.module import TestModule -from common import util LOG_NAME = "test_orc" LOGGER = logger.get_logger("test_orc") @@ -61,7 +59,7 @@ def start(self): # Setup the output directory self._host_user = util.get_host_user() os.makedirs(RUNTIME_DIR, exist_ok=True) - util.run_command(f'chown -R {self._host_user} {RUNTIME_DIR}') + util.run_command(f"chown -R {self._host_user} {RUNTIME_DIR}") self._load_test_modules() self.build_test_modules() @@ -102,7 +100,7 @@ def _generate_results(self, device): results[module.name] = module_results except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: - LOGGER.error("Error occured whilst obbtaining results for module " + module.name) + LOGGER.error(f"Error occured whilst obbtaining results for module {module.name}") LOGGER.debug(results_error) out_file = os.path.join( @@ -110,7 +108,7 @@ def _generate_results(self, device): "runtime/test/" + device.mac_addr.replace(":", "") + "/results.json") with open(out_file, "w", encoding="utf-8") as f: json.dump(results, f, indent=2) - util.run_command(f'chown -R {self._host_user} {out_file}') + util.run_command(f"chown -R {self._host_user} {out_file}") return results def test_in_progress(self): @@ -140,18 +138,19 @@ def _run_test_module(self, module, device): container_runtime_dir = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/" + module.name) - network_runtime_dir = os.path.join(self._root_path, "runtime/network") os.makedirs(container_runtime_dir) + network_runtime_dir = os.path.join(self._root_path, "runtime/network") + device_startup_capture = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/startup.pcap") - util.run_command(f'chown -R {self._host_user} {device_startup_capture}') + util.run_command(f"chown -R {self._host_user} {device_startup_capture}") device_monitor_capture = os.path.join( self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + "/monitor.pcap") - util.run_command(f'chown -R {self._host_user} {device_monitor_capture}') + util.run_command(f"chown -R {self._host_user} {device_monitor_capture}") client = docker.from_env() diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py index 444faa87c..6f003014c 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py @@ -18,9 +18,7 @@ LOG_NAME = 'dhcp_config' LOGGER = None - CONFIG_FILE = '/etc/dhcp/dhcpd.conf' - DEFAULT_LEASE_TIME_KEY = 'default-lease-time' @@ -186,13 +184,18 @@ def __str__(self): config += '\tprimary;' if self.primary else 'secondary;' config += '\n\t{ADDRESS_KEY} {ADDRESS};' if self.address is not None else '' config += '\n\t{PORT_KEY} {PORT};' if self.port is not None else '' - config += '\n\t{PEER_ADDRESS_KEY} {PEER_ADDRESS};' if self.peer_address is not None else '' - config += '\n\t{PEER_PORT_KEY} {PEER_PORT};' if self.peer_port is not None else '' - config += '\n\t{MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY};' if self.max_response_delay is not None else '' - config += '\n\t{MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES};' if self.max_unacked_updates is not None else '' + config += ('\n\t{PEER_ADDRESS_KEY} {PEER_ADDRESS};' + if self.peer_address is not None else '') + config += ('\n\t{PEER_PORT_KEY} {PEER_PORT};' + if self.peer_port is not None else '') + config += ('\n\t{MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY};' + if self.max_response_delay is not None else '') + config += ('\n\t{MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES};' + if self.max_unacked_updates is not None else '') config += '\n\t{MCLT_KEY} {MCLT};' if self.mclt is not None else '' config += '\n\t{SPLIT_KEY} {SPLIT};' if self.split is not None else '' - config += '\n\t{LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS};' if self.load_balance_max_seconds is not None else '' + config += ('\n\t{LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS};' + if self.load_balance_max_seconds is not None else '') config += '\n\r}}' config = config.format( @@ -220,9 +223,9 @@ def __str__(self): if not self.enabled: lines = config.strip().split('\n') - for i in range(len(lines)-1): + for i in range(len(lines) - 1): lines[i] = '#' + lines[i] - lines[-1] = '#' + lines[-1].strip() # Handle the last line separately + lines[-1] = '#' + lines[-1].strip() # Handle the last line separately config = '\n'.join(lines) return config @@ -302,15 +305,20 @@ def __init__(self, subnet): def __str__(self): config = 'subnet {SUBNET_OPTION} netmask {SUBNET_MASK_OPTION} {{' - config += '\n\t{NTP_OPTION_KEY} {NTP_OPTION};' if self._ntp_servers is not None else '' - config += '\n\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION};' if self._subnet_mask is not None else '' - config += '\n\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION};' if self._broadcast is not None else '' - config += '\n\t{ROUTER_OPTION_KEY} {ROUTER_OPTION};' if self._routers is not None else '' - config += '\n\t{DNS_OPTION_KEY} {DNS_OPTION};' if self._dns_servers is not None else '' - config += '\n\t{INTERFACE_KEY} {INTERFACE_OPTION};' if self._interface is not None else '' + config += ('\n\t{NTP_OPTION_KEY} {NTP_OPTION};' + if self._ntp_servers is not None else '') + config += ('\n\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION};' + if self._subnet_mask is not None else '') + config += ('\n\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION};' + if self._broadcast is not None else '') + config += ('\n\t{ROUTER_OPTION_KEY} {ROUTER_OPTION};' + if self._routers is not None else '') + config += ('\n\t{DNS_OPTION_KEY} {DNS_OPTION};' + if self._dns_servers is not None else '') + config += ('\n\t{INTERFACE_KEY} {INTERFACE_OPTION};' + if self._interface is not None else '') config += '\n\t{AUTHORITATIVE_KEY};' if self._authoritative else '' - config = config.format(length='multi-line', SUBNET_OPTION=self._subnet, NTP_OPTION_KEY=NTP_OPTION_KEY, @@ -407,8 +415,11 @@ def __init__(self, pool): def __str__(self): config = 'pool {{' - config += '\n\t\t{FAILOVER_KEY} "{FAILOVER}";' if self.failover_peer is not None else '' - config += '\n\t\t{RANGE_KEY} {RANGE_START} {RANGE_END};' if self.range_start is not None and self.range_end is not None else '' + config += ('\n\t\t{FAILOVER_KEY} "{FAILOVER}";' + if self.failover_peer is not None else '') + config += ('\n\t\t{RANGE_KEY} {RANGE_START} {RANGE_END};' + if self.range_start is not None and self.range_end is not None + else '') config += '\n\t}}' config = config.format( diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py index 2cc78403a..a34ff4e31 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py @@ -17,87 +17,89 @@ import os CONFIG_FILE = 'conf/dhcpd.conf' - DHCP_CONFIG = None def get_config_file_path(): - dhcp_config = DHCPConfig() - current_dir = os.path.dirname(os.path.abspath(__file__)) - module_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(current_dir)))) - conf_file = os.path.join(module_dir,CONFIG_FILE) - return conf_file + current_dir = os.path.dirname(os.path.abspath(__file__)) + module_dir = os.path.dirname( + os.path.dirname(os.path.dirname(os.path.abspath(current_dir)))) + conf_file = os.path.join(module_dir, CONFIG_FILE) + return conf_file + def get_config(): - dhcp_config = DHCPConfig() - dhcp_config.resolve_config(get_config_file_path()) - return dhcp_config + dhcp_config = DHCPConfig() + dhcp_config.resolve_config(get_config_file_path()) + return dhcp_config + class DHCPConfigTest(unittest.TestCase): - @classmethod - def setUpClass(cls): - # Resolve the config - global DHCP_CONFIG - DHCP_CONFIG = get_config() - - def test_resolve_config(self): - print('Test Resolve Config:\n' + str(DHCP_CONFIG)) - - # Resolve the raw config file - with open(get_config_file_path(),'r') as f: - lines = f.readlines() - - # Get the resolved config as a - conf_parts = str(DHCP_CONFIG).split('\n') - - # dhcpd conf is not picky about spacing so we just - # need to check contents of each line for matching - # to make sure evertying matches - for i in range(len(lines)): - self.assertEqual(lines[i].strip(),conf_parts[i].strip()) - - def test_disable_failover(self): - DHCP_CONFIG.disable_failover() - print('Test Disable Config:\n' + str(DHCP_CONFIG)) - config_lines = str(DHCP_CONFIG._peer).split('\n') - for line in config_lines: - self.assertTrue(line.startswith('#')) - - def test_enable_failover(self): - DHCP_CONFIG.enable_failover() - print('Test Enable Config:\n' + str(DHCP_CONFIG)) - config_lines = str(DHCP_CONFIG._peer).split('\n') - for line in config_lines: - self.assertFalse(line.startswith('#')) - - def test_add_reserved_host(self): - DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') - host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') - self.assertIsNotNone(host) - print('AddHostConfig:\n' + str(DHCP_CONFIG)) - - def test_delete_reserved_host(self): - DHCP_CONFIG.delete_reserved_host('00:11:22:33:44:55') - host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') - self.assertIsNone(host) - print('DeleteHostConfig:\n' + str(DHCP_CONFIG)) - - def test_resolve_config_with_hosts(self): - DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') - config_with_hosts = DHCPConfig() - config_with_hosts.make(str(DHCP_CONFIG)) - host = config_with_hosts.get_reserved_host('00:11:22:33:44:55') - self.assertIsNotNone(host) - print("ResolveConfigWithHosts:\n" + str(config_with_hosts)) + @classmethod + def setUpClass(cls): + # Resolve the config + global DHCP_CONFIG + DHCP_CONFIG = get_config() + + def test_resolve_config(self): + print('Test Resolve Config:\n' + str(DHCP_CONFIG)) + + # Resolve the raw config file + with open(get_config_file_path(), 'r', encoding='UTF-8') as f: + lines = f.readlines() + + # Get the resolved config as a + conf_parts = str(DHCP_CONFIG).split('\n') + + # dhcpd conf is not picky about spacing so we just + # need to check contents of each line for matching + # to make sure evertying matches + for i in range(len(lines)): + self.assertEqual(lines[i].strip(), conf_parts[i].strip()) + + def test_disable_failover(self): + DHCP_CONFIG.disable_failover() + print('Test Disable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertTrue(line.startswith('#')) + + def test_enable_failover(self): + DHCP_CONFIG.enable_failover() + print('Test Enable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertFalse(line.startswith('#')) + + def test_add_reserved_host(self): + DHCP_CONFIG.add_reserved_host('test', '00:11:22:33:44:55', '192.168.10.5') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print('AddHostConfig:\n' + str(DHCP_CONFIG)) + + def test_delete_reserved_host(self): + DHCP_CONFIG.delete_reserved_host('00:11:22:33:44:55') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNone(host) + print('DeleteHostConfig:\n' + str(DHCP_CONFIG)) + + def test_resolve_config_with_hosts(self): + DHCP_CONFIG.add_reserved_host('test', '00:11:22:33:44:55', '192.168.10.5') + config_with_hosts = DHCPConfig() + config_with_hosts.make(str(DHCP_CONFIG)) + host = config_with_hosts.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print('ResolveConfigWithHosts:\n' + str(config_with_hosts)) + if __name__ == '__main__': - suite = unittest.TestSuite() - suite.addTest(DHCPConfigTest('test_resolve_config')) - suite.addTest(DHCPConfigTest('test_disable_failover')) - suite.addTest(DHCPConfigTest('test_enable_failover')) - suite.addTest(DHCPConfigTest('test_add_reserved_host')) - suite.addTest(DHCPConfigTest('test_delete_reserved_host')) - suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) - - runner = unittest.TextTestRunner() - runner.run(suite) \ No newline at end of file + suite = unittest.TestSuite() + suite.addTest(DHCPConfigTest('test_resolve_config')) + suite.addTest(DHCPConfigTest('test_disable_failover')) + suite.addTest(DHCPConfigTest('test_enable_failover')) + suite.addTest(DHCPConfigTest('test_add_reserved_host')) + suite.addTest(DHCPConfigTest('test_delete_reserved_host')) + suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) + + runner = unittest.TextTestRunner() + runner.run(suite) diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py index 2f67b0c2d..5e88d59fe 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py @@ -13,6 +13,7 @@ # limitations under the License. """Contains all the necessary classes to maintain the DHCP server""" +import sys import time from common import logger from common import util @@ -35,75 +36,74 @@ def __init__(self): self.dhcp_config.resolve_config() def restart(self): - LOGGER.info("Restarting DHCP Server") - isc_started = util.run_command("service isc-dhcp-server restart", False) + LOGGER.info('Restarting DHCP Server') + isc_started = util.run_command('service isc-dhcp-server restart', False) radvd_started = self.radvd.restart() started = isc_started and radvd_started - LOGGER.info("DHCP Restarted: " + str(started)) + LOGGER.info('DHCP Restarted: ' + str(started)) return started def start(self): - LOGGER.info("Starting DHCP Server") - isc_started = util.run_command("service isc-dhcp-server start", False) + LOGGER.info('Starting DHCP Server') + isc_started = util.run_command('service isc-dhcp-server start', False) radvd_started = self.radvd.start() started = isc_started and radvd_started - LOGGER.info("DHCP Started: " + str(started)) + LOGGER.info('DHCP Started: ' + str(started)) return started def stop(self): - LOGGER.info("Stopping DHCP Server") - isc_stopped = util.run_command("service isc-dhcp-server stop", False) + LOGGER.info('Stopping DHCP Server') + isc_stopped = util.run_command('service isc-dhcp-server stop', False) radvd_stopped = self.radvd.stop() stopped = isc_stopped and radvd_stopped - LOGGER.info("DHCP Stopped: " + str(stopped)) + LOGGER.info('DHCP Stopped: ' + str(stopped)) return stopped def is_running(self): - LOGGER.info("Checking DHCP Status") - response = util.run_command("service isc-dhcp-server status") - isc_running = response[0] == 'Status of ISC DHCPv4 server: dhcpd is running.' + LOGGER.info('Checking DHCP Status') + response = util.run_command('service isc-dhcp-server status') + isc_running = response[ + 0] == 'Status of ISC DHCPv4 server: dhcpd is running.' radvd_running = self.radvd.is_running() running = isc_running and radvd_running - LOGGER.info("DHCP Status: " + str(running)) + LOGGER.info('DHCP Status: ' + str(running)) return running def boot(self): - LOGGER.info("Booting DHCP Server") + LOGGER.info('Booting DHCP Server') isc_booted = False radvd_booted = False if self.is_running(): - LOGGER.info("Stopping isc-dhcp-server") + LOGGER.info('Stopping isc-dhcp-server') stopped = self.stop() - LOGGER.info("isc-dhcp-server stopped: " + str(stopped)) + LOGGER.info('isc-dhcp-server stopped: ' + str(stopped)) if self.radvd.is_running(): - LOGGER.info("Stopping RADVD") + LOGGER.info('Stopping RADVD') stopped = self.radvd.stop() - LOGGER.info("radvd stopped: " + str(stopped)) + LOGGER.info('radvd stopped: ' + str(stopped)) - LOGGER.info("Starting isc-dhcp-server") + LOGGER.info('Starting isc-dhcp-server') if self.start(): isc_booted = False # Scan for 5 seconds if not yet ready - for i in range(5): + for _ in range(5): time.sleep(1) isc_booted = self.is_running() if isc_booted: - break; - LOGGER.info("isc-dhcp-server started: " + str(isc_booted)) + break + LOGGER.info('isc-dhcp-server started: ' + str(isc_booted)) - LOGGER.info("Starting RADVD") + LOGGER.info('Starting RADVD') if self.radvd.start(): radvd_booted = False # Scan for 5 seconds if not yet ready - for i in range(5): + for _ in range(5): time.sleep(1) radvd_booted = self.radvd.is_running() if radvd_booted: - break; - LOGGER.info("RADVD started: " + str(radvd_booted)) - - + break + LOGGER.info('RADVD started: ' + str(radvd_booted)) return isc_booted and radvd_booted @@ -117,14 +117,14 @@ def run(): config = str(dhcp_server.dhcp_config) while True: - dhcp_server.dhcp_config.resolve_config() - new_config = str(dhcp_server.dhcp_config) - if config != new_config: - LOGGER.info("DHCP Config Changed") - config = new_config - success = dhcp_server.restart() - success = dhcp_server.radvd.restart() - time.sleep(1) + dhcp_server.dhcp_config.resolve_config() + new_config = str(dhcp_server.dhcp_config) + if config != new_config: + LOGGER.info('DHCP Config Changed') + config = new_config + dhcp_server.restart() + dhcp_server.radvd.restart() + time.sleep(1) if __name__ == '__main__': run() diff --git a/modules/network/dhcp-1/python/src/grpc_server/network_service.py b/modules/network/dhcp-1/python/src/grpc_server/network_service.py index a693ac3a1..043ca49b3 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/network_service.py +++ b/modules/network/dhcp-1/python/src/grpc_server/network_service.py @@ -47,7 +47,7 @@ def RestartDHCPServer(self, request, context): # pylint: disable=W0613 started = self._dhcp_server.restart() LOGGER.info('DHCP server restarted: ' + (str(started))) return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to restart DHCP server: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -59,7 +59,7 @@ def StartDHCPServer(self, request, context): # pylint: disable=W0613 started = self._dhcp_server.start() LOGGER.info('DHCP server started: ' + (str(started))) return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to start DHCP server: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -71,12 +71,12 @@ def StopDHCPServer(self, request, context): # pylint: disable=W0613 stopped = self._dhcp_server.stop() LOGGER.info('DHCP server stopped: ' + (str(stopped))) return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to stop DHCP server: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) return pb2.Response(code=500, message=fail_message) - + def AddReservedLease(self, request, context): # pylint: disable=W0613 LOGGER.info('Add reserved lease called') try: @@ -86,7 +86,7 @@ def AddReservedLease(self, request, context): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Reserved lease added') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to add reserved lease: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -100,7 +100,7 @@ def DeleteReservedLease(self, request, context): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Reserved lease deleted') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to delete reserved lease: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -114,7 +114,7 @@ def DisableFailover(self, request, contest): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Failover disabled') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to disable failover: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -128,7 +128,7 @@ def EnableFailover(self, request, contest): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Failover enabled') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to enable failover: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -143,7 +143,7 @@ def GetDHCPRange(self, request, context): # pylint: disable=W0613 try: pool = self._get_dhcp_config()._subnets[0].pools[0] return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to get DHCP range: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -161,7 +161,7 @@ def GetLease(self, request, context): # pylint: disable=W0613 return pb2.Response(code=200, message=str(lease)) else: return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to get lease: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -179,7 +179,7 @@ def SetDHCPRange(self, request, context): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('DHCP range set') return pb2.Response(code=200, message='DHCP Range Set') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to set DHCP range: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -191,4 +191,4 @@ def GetStatus(self, request, context): # pylint: disable=W0613 """ dhcp_status = self._dhcp_server.is_running() message = str({'dhcpStatus': dhcp_status}) - return pb2.Response(code=200, message=message) \ No newline at end of file + return pb2.Response(code=200, message=message) diff --git a/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py b/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py index 48e063e61..8bb1d0539 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py +++ b/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py @@ -13,10 +13,8 @@ # limitations under the License. """Contains all the necessary classes to maintain the DHCP server""" -import time from common import logger from common import util -from dhcp_config import DHCPConfig CONFIG_FILE = '/etc/dhcp/dhcpd.conf' LOG_NAME = 'radvd' @@ -31,25 +29,25 @@ def __init__(self): LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') def restart(self): - LOGGER.info("Restarting RADVD Server") - response = util.run_command("radvd-service restart", False) - LOGGER.info("RADVD Restarted: " + str(response)) + LOGGER.info('Restarting RADVD Server') + response = util.run_command('radvd-service restart', False) + LOGGER.info('RADVD Restarted: ' + str(response)) return response def start(self): - LOGGER.info("Starting RADVD Server") - response = util.run_command("radvd-service start", False) - LOGGER.info("RADVD Started: " + str(response)) + LOGGER.info('Starting RADVD Server') + response = util.run_command('radvd-service start', False) + LOGGER.info('RADVD Started: ' + str(response)) return response def stop(self): - LOGGER.info("Stopping RADVD Server") - response = util.run_command("radvd-service stop", False) - LOGGER.info("RADVD Stopped: " + str(response)) + LOGGER.info('Stopping RADVD Server') + response = util.run_command('radvd-service stop', False) + LOGGER.info('RADVD Stopped: ' + str(response)) return response def is_running(self): - LOGGER.info("Checking RADVD Status") - response = util.run_command("radvd-service status") - LOGGER.info("RADVD Status: " + str(response)) + LOGGER.info('Checking RADVD Status') + response = util.run_command('radvd-service status') + LOGGER.info('RADVD Status: ' + str(response)) return response[0] == 'radvd service is running.' diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py index 33cb5938c..5da5e4cf2 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py @@ -186,13 +186,18 @@ def __str__(self): config += '\tprimary;' if self.primary else 'secondary;' config += '\n\t{ADDRESS_KEY} {ADDRESS};' if self.address is not None else '' config += '\n\t{PORT_KEY} {PORT};' if self.port is not None else '' - config += '\n\t{PEER_ADDRESS_KEY} {PEER_ADDRESS};' if self.peer_address is not None else '' - config += '\n\t{PEER_PORT_KEY} {PEER_PORT};' if self.peer_port is not None else '' - config += '\n\t{MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY};' if self.max_response_delay is not None else '' - config += '\n\t{MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES};' if self.max_unacked_updates is not None else '' + config += ('\n\t{PEER_ADDRESS_KEY} {PEER_ADDRESS};' + if self.peer_address is not None else '') + config += ('\n\t{PEER_PORT_KEY} {PEER_PORT};' + if self.peer_port is not None else '') + config += ('\n\t{MAX_RESPONSE_DELAY_KEY} {MAX_RESPONSE_DELAY};' + if self.max_response_delay is not None else '') + config += ('\n\t{MAX_UNACKED_UPDATES_KEY} {MAX_UNACKED_UPDATES};' + if self.max_unacked_updates is not None else '') config += '\n\t{MCLT_KEY} {MCLT};' if self.mclt is not None else '' config += '\n\t{SPLIT_KEY} {SPLIT};' if self.split is not None else '' - config += '\n\t{LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS};' if self.load_balance_max_seconds is not None else '' + config += ('\n\t{LOAD_BALANCE_MAX_SECONDS_KEY} {LOAD_BALANCE_MAX_SECONDS};' + if self.load_balance_max_seconds is not None else '') config += '\n\r}}' config = config.format( @@ -220,9 +225,9 @@ def __str__(self): if not self.enabled: lines = config.strip().split('\n') - for i in range(len(lines)-1): + for i in range(len(lines) - 1): lines[i] = '#' + lines[i] - lines[-1] = '#' + lines[-1].strip() # Handle the last line separately + lines[-1] = '#' + lines[-1].strip() # Handle the last line separately config = '\n'.join(lines) return config @@ -302,15 +307,20 @@ def __init__(self, subnet): def __str__(self): config = 'subnet {SUBNET_OPTION} netmask {SUBNET_MASK_OPTION} {{' - config += '\n\t{NTP_OPTION_KEY} {NTP_OPTION};' if self._ntp_servers is not None else '' - config += '\n\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION};' if self._subnet_mask is not None else '' - config += '\n\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION};' if self._broadcast is not None else '' - config += '\n\t{ROUTER_OPTION_KEY} {ROUTER_OPTION};' if self._routers is not None else '' - config += '\n\t{DNS_OPTION_KEY} {DNS_OPTION};' if self._dns_servers is not None else '' - config += '\n\t{INTERFACE_KEY} {INTERFACE_OPTION};' if self._interface is not None else '' + config += ('\n\t{NTP_OPTION_KEY} {NTP_OPTION};' + if self._ntp_servers is not None else '') + config += ('\n\t{SUBNET_MASK_OPTION_KEY} {SUBNET_MASK_OPTION};' + if self._subnet_mask is not None else '') + config += ('\n\t{BROADCAST_OPTION_KEY} {BROADCAST_OPTION};' + if self._broadcast is not None else '') + config += ('\n\t{ROUTER_OPTION_KEY} {ROUTER_OPTION};' + if self._routers is not None else '') + config += ('\n\t{DNS_OPTION_KEY} {DNS_OPTION};' + if self._dns_servers is not None else '') + config += ('\n\t{INTERFACE_KEY} {INTERFACE_OPTION};' + if self._interface is not None else '') config += '\n\t{AUTHORITATIVE_KEY};' if self._authoritative else '' - config = config.format(length='multi-line', SUBNET_OPTION=self._subnet, NTP_OPTION_KEY=NTP_OPTION_KEY, @@ -407,8 +417,11 @@ def __init__(self, pool): def __str__(self): config = 'pool {{' - config += '\n\t\t{FAILOVER_KEY} "{FAILOVER}";' if self.failover_peer is not None else '' - config += '\n\t\t{RANGE_KEY} {RANGE_START} {RANGE_END};' if self.range_start is not None and self.range_end is not None else '' + config += ('\n\t\t{FAILOVER_KEY} "{FAILOVER}";' + if self.failover_peer is not None else '') + config += ('\n\t\t{RANGE_KEY} {RANGE_START} {RANGE_END};' + if self.range_start is not None and self.range_end is not None + else '') config += '\n\t}}' config = config.format( @@ -490,4 +503,4 @@ def resolve_host(self, reserved_host): self.hw_addr = part.strip().split(HARDWARE_KEY)[1].strip().split(';')[0] elif FIXED_ADDRESS_KEY in part: self.fixed_addr = part.strip().split( - FIXED_ADDRESS_KEY)[1].strip().split(';')[0] \ No newline at end of file + FIXED_ADDRESS_KEY)[1].strip().split(';')[0] diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py index 2cc78403a..b07f57b27 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py @@ -17,87 +17,86 @@ import os CONFIG_FILE = 'conf/dhcpd.conf' - DHCP_CONFIG = None def get_config_file_path(): - dhcp_config = DHCPConfig() - current_dir = os.path.dirname(os.path.abspath(__file__)) - module_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(current_dir)))) - conf_file = os.path.join(module_dir,CONFIG_FILE) - return conf_file + current_dir = os.path.dirname(os.path.abspath(__file__)) + module_dir = os.path.dirname( + os.path.dirname(os.path.dirname(os.path.abspath(current_dir)))) + conf_file = os.path.join(module_dir, CONFIG_FILE) + return conf_file def get_config(): - dhcp_config = DHCPConfig() - dhcp_config.resolve_config(get_config_file_path()) - return dhcp_config + dhcp_config = DHCPConfig() + dhcp_config.resolve_config(get_config_file_path()) + return dhcp_config class DHCPConfigTest(unittest.TestCase): - @classmethod - def setUpClass(cls): - # Resolve the config - global DHCP_CONFIG - DHCP_CONFIG = get_config() - - def test_resolve_config(self): - print('Test Resolve Config:\n' + str(DHCP_CONFIG)) - - # Resolve the raw config file - with open(get_config_file_path(),'r') as f: - lines = f.readlines() - - # Get the resolved config as a - conf_parts = str(DHCP_CONFIG).split('\n') - - # dhcpd conf is not picky about spacing so we just - # need to check contents of each line for matching - # to make sure evertying matches - for i in range(len(lines)): - self.assertEqual(lines[i].strip(),conf_parts[i].strip()) - - def test_disable_failover(self): - DHCP_CONFIG.disable_failover() - print('Test Disable Config:\n' + str(DHCP_CONFIG)) - config_lines = str(DHCP_CONFIG._peer).split('\n') - for line in config_lines: - self.assertTrue(line.startswith('#')) - - def test_enable_failover(self): - DHCP_CONFIG.enable_failover() - print('Test Enable Config:\n' + str(DHCP_CONFIG)) - config_lines = str(DHCP_CONFIG._peer).split('\n') - for line in config_lines: - self.assertFalse(line.startswith('#')) - - def test_add_reserved_host(self): - DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') - host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') - self.assertIsNotNone(host) - print('AddHostConfig:\n' + str(DHCP_CONFIG)) - - def test_delete_reserved_host(self): - DHCP_CONFIG.delete_reserved_host('00:11:22:33:44:55') - host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') - self.assertIsNone(host) - print('DeleteHostConfig:\n' + str(DHCP_CONFIG)) - - def test_resolve_config_with_hosts(self): - DHCP_CONFIG.add_reserved_host('test','00:11:22:33:44:55','192.168.10.5') - config_with_hosts = DHCPConfig() - config_with_hosts.make(str(DHCP_CONFIG)) - host = config_with_hosts.get_reserved_host('00:11:22:33:44:55') - self.assertIsNotNone(host) - print("ResolveConfigWithHosts:\n" + str(config_with_hosts)) + @classmethod + def setUpClass(cls): + # Resolve the config + global DHCP_CONFIG + DHCP_CONFIG = get_config() + + def test_resolve_config(self): + print('Test Resolve Config:\n' + str(DHCP_CONFIG)) + + # Resolve the raw config file + with open(get_config_file_path(), 'r', encoding='UTF-8') as f: + lines = f.readlines() + + # Get the resolved config as a + conf_parts = str(DHCP_CONFIG).split('\n') + + # dhcpd conf is not picky about spacing so we just + # need to check contents of each line for matching + # to make sure evertying matches + for i in range(len(lines)): + self.assertEqual(lines[i].strip(), conf_parts[i].strip()) + + def test_disable_failover(self): + DHCP_CONFIG.disable_failover() + print('Test Disable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertTrue(line.startswith('#')) + + def test_enable_failover(self): + DHCP_CONFIG.enable_failover() + print('Test Enable Config:\n' + str(DHCP_CONFIG)) + config_lines = str(DHCP_CONFIG._peer).split('\n') + for line in config_lines: + self.assertFalse(line.startswith('#')) + + def test_add_reserved_host(self): + DHCP_CONFIG.add_reserved_host('test', '00:11:22:33:44:55', '192.168.10.5') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print('AddHostConfig:\n' + str(DHCP_CONFIG)) + + def test_delete_reserved_host(self): + DHCP_CONFIG.delete_reserved_host('00:11:22:33:44:55') + host = DHCP_CONFIG.get_reserved_host('00:11:22:33:44:55') + self.assertIsNone(host) + print('DeleteHostConfig:\n' + str(DHCP_CONFIG)) + + def test_resolve_config_with_hosts(self): + DHCP_CONFIG.add_reserved_host('test', '00:11:22:33:44:55', '192.168.10.5') + config_with_hosts = DHCPConfig() + config_with_hosts.make(str(DHCP_CONFIG)) + host = config_with_hosts.get_reserved_host('00:11:22:33:44:55') + self.assertIsNotNone(host) + print('ResolveConfigWithHosts:\n' + str(config_with_hosts)) if __name__ == '__main__': - suite = unittest.TestSuite() - suite.addTest(DHCPConfigTest('test_resolve_config')) - suite.addTest(DHCPConfigTest('test_disable_failover')) - suite.addTest(DHCPConfigTest('test_enable_failover')) - suite.addTest(DHCPConfigTest('test_add_reserved_host')) - suite.addTest(DHCPConfigTest('test_delete_reserved_host')) - suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) - - runner = unittest.TextTestRunner() - runner.run(suite) \ No newline at end of file + suite = unittest.TestSuite() + suite.addTest(DHCPConfigTest('test_resolve_config')) + suite.addTest(DHCPConfigTest('test_disable_failover')) + suite.addTest(DHCPConfigTest('test_enable_failover')) + suite.addTest(DHCPConfigTest('test_add_reserved_host')) + suite.addTest(DHCPConfigTest('test_delete_reserved_host')) + suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) + + runner = unittest.TextTestRunner() + runner.run(suite) diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py index 1431d6ddd..67a31c2cb 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py @@ -13,6 +13,7 @@ # limitations under the License. """Contains all the necessary classes to maintain the DHCP server""" +import sys import time from common import logger from common import util @@ -35,75 +36,74 @@ def __init__(self): self.dhcp_config.resolve_config() def restart(self): - LOGGER.info("Restarting DHCP Server") - isc_started = util.run_command("service isc-dhcp-server restart", False) + LOGGER.info('Restarting DHCP Server') + isc_started = util.run_command('service isc-dhcp-server restart', False) radvd_started = self.radvd.restart() started = isc_started and radvd_started - LOGGER.info("DHCP Restarted: " + str(started)) + LOGGER.info('DHCP Restarted: ' + str(started)) return started def start(self): - LOGGER.info("Starting DHCP Server") - isc_started = util.run_command("service isc-dhcp-server start", False) + LOGGER.info('Starting DHCP Server') + isc_started = util.run_command('service isc-dhcp-server start', False) radvd_started = self.radvd.start() started = isc_started and radvd_started - LOGGER.info("DHCP Started: " + str(started)) + LOGGER.info('DHCP Started: ' + str(started)) return started def stop(self): - LOGGER.info("Stopping DHCP Server") - isc_stopped = util.run_command("service isc-dhcp-server stop", False) + LOGGER.info('Stopping DHCP Server') + isc_stopped = util.run_command('service isc-dhcp-server stop', False) radvd_stopped = self.radvd.stop() stopped = isc_stopped and radvd_stopped - LOGGER.info("DHCP Stopped: " + str(stopped)) + LOGGER.info('DHCP Stopped: ' + str(stopped)) return stopped def is_running(self): - LOGGER.info("Checking DHCP Status") - response = util.run_command("service isc-dhcp-server status") - isc_running = response[0] == 'Status of ISC DHCPv4 server: dhcpd is running.' + LOGGER.info('Checking DHCP Status') + response = util.run_command('service isc-dhcp-server status') + isc_running = response[ + 0] == 'Status of ISC DHCPv4 server: dhcpd is running.' radvd_running = self.radvd.is_running() running = isc_running and radvd_running - LOGGER.info("DHCP Status: " + str(running)) + LOGGER.info('DHCP Status: ' + str(running)) return running def boot(self): - LOGGER.info("Booting DHCP Server") + LOGGER.info('Booting DHCP Server') isc_booted = False radvd_booted = False if self.is_running(): - LOGGER.info("Stopping isc-dhcp-server") + LOGGER.info('Stopping isc-dhcp-server') stopped = self.stop() - LOGGER.info("isc-dhcp-server stopped: " + str(stopped)) + LOGGER.info('isc-dhcp-server stopped: ' + str(stopped)) if self.radvd.is_running(): - LOGGER.info("Stopping RADVD") + LOGGER.info('Stopping RADVD') stopped = self.radvd.stop() - LOGGER.info("radvd stopped: " + str(stopped)) + LOGGER.info('radvd stopped: ' + str(stopped)) - LOGGER.info("Starting isc-dhcp-server") + LOGGER.info('Starting isc-dhcp-server') if self.start(): isc_booted = False # Scan for 5 seconds if not yet ready - for i in range(5): + for _ in range(5): time.sleep(1) isc_booted = self.is_running() if isc_booted: - break; - LOGGER.info("isc-dhcp-server started: " + str(isc_booted)) + break + LOGGER.info('isc-dhcp-server started: ' + str(isc_booted)) - LOGGER.info("Starting RADVD") + LOGGER.info('Starting RADVD') if self.radvd.start(): radvd_booted = False # Scan for 5 seconds if not yet ready - for i in range(5): + for _ in range(5): time.sleep(1) radvd_booted = self.radvd.is_running() if radvd_booted: - break; - LOGGER.info("RADVD started: " + str(radvd_booted)) - - + break + LOGGER.info('RADVD started: ' + str(radvd_booted)) return isc_booted and radvd_booted @@ -117,14 +117,14 @@ def run(): config = str(dhcp_server.dhcp_config) while True: - dhcp_server.dhcp_config.resolve_config() - new_config = str(dhcp_server.dhcp_config) - if config != new_config: - LOGGER.info("DHCP Config Changed") - config = new_config - success = dhcp_server.restart() - success = dhcp_server.radvd.restart() - time.sleep(1) + dhcp_server.dhcp_config.resolve_config() + new_config = str(dhcp_server.dhcp_config) + if config != new_config: + LOGGER.info('DHCP Config Changed') + config = new_config + dhcp_server.restart() + dhcp_server.radvd.restart() + time.sleep(1) if __name__ == '__main__': run() diff --git a/modules/network/dhcp-2/python/src/grpc_server/network_service.py b/modules/network/dhcp-2/python/src/grpc_server/network_service.py index 5af9e6c44..f9deba965 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/network_service.py +++ b/modules/network/dhcp-2/python/src/grpc_server/network_service.py @@ -25,6 +25,7 @@ LOG_NAME = 'network_service' LOGGER = None + class NetworkService(pb2_grpc.NetworkModule): """gRPC endpoints for the DHCP Server""" @@ -47,7 +48,7 @@ def RestartDHCPServer(self, request, context): # pylint: disable=W0613 started = self._dhcp_server.restart() LOGGER.info('DHCP server restarted: ' + (str(started))) return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to restart DHCP server: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -59,7 +60,7 @@ def StartDHCPServer(self, request, context): # pylint: disable=W0613 started = self._dhcp_server.start() LOGGER.info('DHCP server started: ' + (str(started))) return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to start DHCP server: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -71,12 +72,12 @@ def StopDHCPServer(self, request, context): # pylint: disable=W0613 stopped = self._dhcp_server.stop() LOGGER.info('DHCP server stopped: ' + (str(stopped))) return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to stop DHCP server: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) return pb2.Response(code=500, message=fail_message) - + def AddReservedLease(self, request, context): # pylint: disable=W0613 LOGGER.info('Add reserved lease called') try: @@ -86,7 +87,7 @@ def AddReservedLease(self, request, context): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Reserved lease added') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to add reserved lease: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -100,7 +101,7 @@ def DeleteReservedLease(self, request, context): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Reserved lease deleted') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to delete reserved lease: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -114,7 +115,7 @@ def DisableFailover(self, request, contest): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Failover disabled') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to disable failover: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -128,7 +129,7 @@ def EnableFailover(self, request, contest): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('Failover enabled') return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to enable failover: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -143,7 +144,7 @@ def GetDHCPRange(self, request, context): # pylint: disable=W0613 try: pool = self._get_dhcp_config()._subnets[0].pools[0] return pb2.DHCPRange(code=200, start=pool.range_start, end=pool.range_end) - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to get DHCP range: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -161,7 +162,7 @@ def GetLease(self, request, context): # pylint: disable=W0613 return pb2.Response(code=200, message=str(lease)) else: return pb2.Response(code=200, message='{}') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to get lease: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -179,7 +180,7 @@ def SetDHCPRange(self, request, context): # pylint: disable=W0613 dhcp_config.write_config() LOGGER.info('DHCP range set') return pb2.Response(code=200, message='DHCP Range Set') - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 fail_message = 'Failed to set DHCP range: ' + str(e) LOGGER.error(fail_message) LOGGER.error(traceback.format_exc()) @@ -191,4 +192,4 @@ def GetStatus(self, request, context): # pylint: disable=W0613 """ dhcp_status = self._dhcp_server.is_running() message = str({'dhcpStatus': dhcp_status}) - return pb2.Response(code=200, message=message) \ No newline at end of file + return pb2.Response(code=200, message=message) diff --git a/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py b/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py index 0c6ef90d6..bc5d8b55f 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py +++ b/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py @@ -13,10 +13,8 @@ # limitations under the License. """Contains all the necessary classes to maintain the DHCP server""" -import time from common import logger from common import util -from dhcp_config import DHCPConfig CONFIG_FILE = '/etc/dhcp/dhcpd.conf' LOG_NAME = 'radvd' @@ -31,25 +29,25 @@ def __init__(self): LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') def restart(self): - LOGGER.info("Restarting RADVD Server") - response = util.run_command("radvd-service restart", False) - LOGGER.info("RADVD Restarted: " + str(response)) + LOGGER.info('Restarting RADVD Server') + response = util.run_command('radvd-service restart', False) + LOGGER.info('RADVD Restarted: ' + str(response)) return response def start(self): - LOGGER.info("Starting RADVD Server") - response = util.run_command("radvd-service start", False) - LOGGER.info("RADVD Started: " + str(response)) + LOGGER.info('Starting RADVD Server') + response = util.run_command('radvd-service start', False) + LOGGER.info('RADVD Started: ' + str(response)) return response def stop(self): - LOGGER.info("Stopping RADVD Server") - response = util.run_command("radvd-service stop", False) - LOGGER.info("RADVD Stopped: " + str(response)) + LOGGER.info('Stopping RADVD Server') + response = util.run_command('radvd-service stop', False) + LOGGER.info('RADVD Stopped: ' + str(response)) return response def is_running(self): - LOGGER.info("Checking RADVD Status") - response = util.run_command("radvd-service status") - LOGGER.info("RADVD Status: " + str(response)) + LOGGER.info('Checking RADVD Status') + response = util.run_command('radvd-service status') + LOGGER.info('RADVD Status: ' + str(response)) return response[0] == 'radvd service is running.' diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index 5342e36f8..2a892b810 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -89,14 +89,13 @@ def run_tests(self): else: result = getattr(self, test_method_name)() else: - LOGGER.info('Test ' + test['name'] + ' not resolved. Skipping') + LOGGER.info(f'Test {test["name"]} not resolved. Skipping') result = None else: - LOGGER.info('Test ' + test['name'] + ' disabled. Skipping') + LOGGER.info(f'Test {test["name"]} disabled. Skipping') if result is not None: - success = None - if isinstance(result,bool): - test['result'] = 'compliant' if result else 'non-compliant' + if isinstance(result, bool): + test['result'] = 'compliant' if result else 'non-compliant' else: test['result'] = 'compliant' if result[0] else 'non-compliant' test['result_details'] = result[1] diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 5b3bf7038..b4635ffb8 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -11,17 +11,17 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """Connection test module""" import util import sys -from scapy.all import * +import json +from scapy.all import rdpcap, DHCP, Ether from test_module import TestModule from dhcp1.client import Client as DHCPClient1 -LOG_NAME = "test_connection" +LOG_NAME = 'test_connection' LOGGER = None -OUI_FILE="/usr/local/etc/oui.txt" +OUI_FILE = '/usr/local/etc/oui.txt' DHCP_SERVER_CAPTURE_FILE = '/runtime/network/dhcp-1.pcap' STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' @@ -35,10 +35,11 @@ def __init__(self, module): global LOGGER LOGGER = self._get_logger() self.dhcp1_client = DHCPClient1() - - # ToDo: Move this into some level of testing, leave for + + # ToDo: Move this into some level of testing, leave for # reference until tests are implemented with these calls - # response = self.dhcp1_client.add_reserved_lease('test','00:11:22:33:44:55','10.10.10.21') + # response = self.dhcp1_client.add_reserved_lease( + # 'test','00:11:22:33:44:55','10.10.10.21') # print("AddLeaseResp: " + str(response)) # response = self.dhcp1_client.delete_reserved_lease('00:11:22:33:44:55') @@ -63,52 +64,52 @@ def __init__(self, module): # print("Set Range: " + str(response)) def _connection_dhcp_address(self): - LOGGER.info("Running connection.dhcp_address") + LOGGER.info('Running connection.dhcp_address') response = self.dhcp1_client.get_lease(self._device_mac) - LOGGER.info("DHCP Lease resolved:\n" + str(response)) + LOGGER.info('DHCP Lease resolved:\n' + str(response)) if response.code == 200: - lease = eval(response.message) + lease = eval(response.message) # pylint: disable=E0203 if 'ip' in lease: ip_addr = lease['ip'] - LOGGER.info("IP Resolved: " + ip_addr) - LOGGER.info("Attempting to ping device..."); + LOGGER.info('IP Resolved: ' + ip_addr) + LOGGER.info('Attempting to ping device...') ping_success = self._ping(self._device_ipv4_addr) - LOGGER.info("Ping Success: " + str(ping_success)) + LOGGER.info('Ping Success: ' + str(ping_success)) if ping_success: - return True, "Device responded to leased ip address" + return True, 'Device responded to leased ip address' else: - return False, "Device did not respond to leased ip address" + return False, 'Device did not respond to leased ip address' else: - LOGGER.info("No DHCP lease found for: " + self._device_mac) - return False, "No DHCP lease found for: " + self._device_mac + LOGGER.info('No DHCP lease found for: ' + self._device_mac) + return False, 'No DHCP lease found for: ' + self._device_mac def _connection_mac_address(self): - LOGGER.info("Running connection.mac_address") + LOGGER.info('Running connection.mac_address') if self._device_mac is not None: - LOGGER.info("MAC address found: " + self._device_mac) - return True, "MAC address found: " + self._device_mac + LOGGER.info('MAC address found: ' + self._device_mac) + return True, 'MAC address found: ' + self._device_mac else: - LOGGER.info("No MAC address found: " + self._device_mac) - return False, "No MAC address found." + LOGGER.info('No MAC address found: ' + self._device_mac) + return False, 'No MAC address found.' def _connection_mac_oui(self): - LOGGER.info("Running connection.mac_oui") + LOGGER.info('Running connection.mac_oui') manufacturer = self._get_oui_manufacturer(self._device_mac) if manufacturer is not None: - LOGGER.info("OUI Manufacturer found: " + manufacturer) - return True, "OUI Manufacturer found: " + manufacturer + LOGGER.info('OUI Manufacturer found: ' + manufacturer) + return True, 'OUI Manufacturer found: ' + manufacturer else: - LOGGER.info("No OUI Manufacturer found for: " + self._device_mac) - return False, "No OUI Manufacturer found for: " + self._device_mac + LOGGER.info('No OUI Manufacturer found for: ' + self._device_mac) + return False, 'No OUI Manufacturer found for: ' + self._device_mac def _connection_single_ip(self): - LOGGER.info("Running connection.single_ip") + LOGGER.info('Running connection.single_ip') result = None if self._device_mac is None: - LOGGER.info("No MAC address found: ") - return result, "No MAC address found." - + LOGGER.info('No MAC address found: ') + return result, 'No MAC address found.' + # Read all the pcap files containing DHCP packet information packets = rdpcap(DHCP_SERVER_CAPTURE_FILE) packets.append(rdpcap(STARTUP_CAPTURE_FILE)) @@ -116,50 +117,48 @@ def _connection_single_ip(self): # Extract MAC addresses from DHCP packets mac_addresses = set() - LOGGER.info("Inspecting: " + str(len(packets)) + " packets") + LOGGER.info('Inspecting: ' + str(len(packets)) + ' packets') for packet in packets: # Option[1] = message-type, option 3 = DHCPREQUEST - if DHCP in packet and packet[DHCP].options[0][1] == 3: - mac_address = packet[Ether].src - mac_addresses.add(mac_address.upper()) + if DHCP in packet and packet[DHCP].options[0][1] == 3: + mac_address = packet[Ether].src + mac_addresses.add(mac_address.upper()) # Check if the device mac address is in the list of DHCPREQUESTs result = self._device_mac.upper() in mac_addresses - LOGGER.info("DHCPREQUEST detected from device: " + str(result)) + LOGGER.info('DHCPREQUEST detected from device: ' + str(result)) # Check the unique MAC addresses to see if they match the device for mac_address in mac_addresses: - LOGGER.info("DHCPREQUEST from MAC address: " + mac_address) - result &= self._device_mac.upper() == mac_address + LOGGER.info('DHCPREQUEST from MAC address: ' + mac_address) + result &= self._device_mac.upper() == mac_address return result - def _connection_target_ping(self): - LOGGER.info("Running connection.target_ping") + LOGGER.info('Running connection.target_ping') # If the ipv4 address wasn't resolved yet, try again if self._device_ipv4_addr is None: - self._device_ipv4_addr = self._get_device_ipv4(self) + self._device_ipv4_addr = self._get_device_ipv4(self) if self._device_ipv4_addr is None: - LOGGER.error("No device IP could be resolved") + LOGGER.error('No device IP could be resolved') sys.exit(1) else: return self._ping(self._device_ipv4_addr) - def _get_oui_manufacturer(self,mac_address): + def _get_oui_manufacturer(self, mac_address): # Do some quick fixes on the format of the mac_address # to match the oui file pattern - mac_address = mac_address.replace(":","-").upper() - with open(OUI_FILE, "r") as file: - for line in file: - if mac_address.startswith(line[:8]): - start = line.index("(hex)") + len("(hex)") - return line[start:].strip() # Extract the company name + mac_address = mac_address.replace(':', '-').upper() + with open(OUI_FILE, 'r', encoding='UTF-8') as file: + for line in file: + if mac_address.startswith(line[:8]): + start = line.index('(hex)') + len('(hex)') + return line[start:].strip() # Extract the company name return None def _ping(self, host): cmd = 'ping -c 1 ' + str(host) success = util.run_command(cmd, output=False) return success - \ No newline at end of file diff --git a/modules/test/nmap/nmap.Dockerfile b/modules/test/nmap/nmap.Dockerfile index 1789da382..ea90ee06f 100644 --- a/modules/test/nmap/nmap.Dockerfile +++ b/modules/test/nmap/nmap.Dockerfile @@ -18,10 +18,10 @@ FROM test-run/base-test:latest ARG MODULE_NAME=nmap ARG MODULE_DIR=modules/test/$MODULE_NAME -#Load the requirements file +# Load the requirements file COPY $MODULE_DIR/python/requirements.txt /testrun/python -#Install all python requirements for the module +# Install all python requirements for the module RUN pip3 install -r /testrun/python/requirements.txt # Copy over all configuration files diff --git a/modules/test/ntp/bin/start_test_module b/modules/test/ntp/bin/start_test_module new file mode 100644 index 000000000..a09349cf9 --- /dev/null +++ b/modules/test/ntp/bin/start_test_module @@ -0,0 +1,42 @@ +#!/bin/bash + +# An example startup script that does the bare minimum to start +# a test module via a pyhon script. Each test module should include a +# start_test_module file that overwrites this one to boot all of its +# specific requirements to run. + +# Define where the python source files are located +PYTHON_SRC_DIR=/testrun/python/src + +# Fetch module name +MODULE_NAME=$1 + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No interface defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +# Create and set permissions on the log files +LOG_FILE=/runtime/output/$MODULE_NAME.log +RESULT_FILE=/runtime/output/$MODULE_NAME-result.json +touch $LOG_FILE +touch $RESULT_FILE +chown $HOST_USER $LOG_FILE +chown $HOST_USER $RESULT_FILE + +# Run the python scrip that will execute the tests for this module +# -u flag allows python print statements +# to be logged by docker by running unbuffered +python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" + +echo Module has finished \ No newline at end of file diff --git a/modules/test/ntp/conf/module_config.json b/modules/test/ntp/conf/module_config.json new file mode 100644 index 000000000..288474868 --- /dev/null +++ b/modules/test/ntp/conf/module_config.json @@ -0,0 +1,27 @@ +{ + "config": { + "meta": { + "name": "ntp", + "display_name": "NTP", + "description": "NTP test" + }, + "network": false, + "docker": { + "depends_on": "base", + "enable_container": true, + "timeout": 30 + }, + "tests":[ + { + "name": "ntp.network.ntp_support", + "description": "Does the device request network time sync as client as per RFC 5905 - Network Time Protocol Version 4: Protocol and Algorithms Specification", + "expected_behavior": "The device sends an NTPv4 request to the configured NTP server." + }, + { + "name": "ntp.network.ntp_dhcp", + "description": "Accept NTP address over DHCP", + "expected_behavior": "Device can accept NTP server address, provided by the DHCP server (DHCP OFFER PACKET)" + } + ] + } +} diff --git a/modules/test/ntp/ntp.Dockerfile b/modules/test/ntp/ntp.Dockerfile new file mode 100644 index 000000000..33b06287e --- /dev/null +++ b/modules/test/ntp/ntp.Dockerfile @@ -0,0 +1,20 @@ +# Image name: test-run/ntp-test +FROM test-run/base-test:latest + +ARG MODULE_NAME=ntp +ARG MODULE_DIR=modules/test/$MODULE_NAME + +# Load the requirements file +COPY $MODULE_DIR/python/requirements.txt /testrun/python + +# Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python \ No newline at end of file diff --git a/modules/test/ntp/python/requirements.txt b/modules/test/ntp/python/requirements.txt new file mode 100644 index 000000000..93b351f44 --- /dev/null +++ b/modules/test/ntp/python/requirements.txt @@ -0,0 +1 @@ +scapy \ No newline at end of file diff --git a/modules/test/ntp/python/src/ntp_module.py b/modules/test/ntp/python/src/ntp_module.py new file mode 100644 index 000000000..4053ce98a --- /dev/null +++ b/modules/test/ntp/python/src/ntp_module.py @@ -0,0 +1,79 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""NTP test module""" +from test_module import TestModule +from scapy.all import rdpcap, NTP, IP + +LOG_NAME = 'test_ntp' +NTP_SERVER_CAPTURE_FILE = '/runtime/network/ntp.pcap' +STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' +MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' +LOGGER = None + +class NTPModule(TestModule): + """NTP Test module""" + + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + # TODO: This should be fetched dynamically + self._ntp_server = '10.10.10.5' + + global LOGGER + LOGGER = self._get_logger() + + def _ntp_network_ntp_support(self): + LOGGER.info('Running ntp.network.ntp_support') + + packet_capture = rdpcap(STARTUP_CAPTURE_FILE) + rdpcap(MONITOR_CAPTURE_FILE) + + device_sends_ntp4 = False + device_sends_ntp3 = False + + for packet in packet_capture: + + if NTP in packet and packet.src == self._device_mac: + if packet[NTP].version == 4: + device_sends_ntp4 = True + LOGGER.info(f'Device sent NTPv4 request to {packet[IP].dst}') + elif packet[NTP].version == 3: + device_sends_ntp3 = True + LOGGER.info(f'Device sent NTPv3 request to {packet[IP].dst}') + + if not (device_sends_ntp3 or device_sends_ntp4): + LOGGER.info('Device has not sent any NTP requests') + + return device_sends_ntp4 and not device_sends_ntp3 + + def _ntp_network_ntp_dhcp(self): + LOGGER.info('Running ntp.network.ntp_dhcp') + + packet_capture = rdpcap(STARTUP_CAPTURE_FILE) + rdpcap(MONITOR_CAPTURE_FILE) + + device_sends_ntp = False + + for packet in packet_capture: + + if NTP in packet and packet.src == self._device_mac: + device_sends_ntp = True + if packet[IP].dst == self._ntp_server: + LOGGER.info('Device sent NTP request to DHCP provided NTP server') + return True + + if not device_sends_ntp: + LOGGER.info('Device has not sent any NTP requests') + else: + LOGGER.info('Device has not sent NTP requests to DHCP provided NTP server') + + return False diff --git a/modules/test/ntp/python/src/run.py b/modules/test/ntp/python/src/run.py new file mode 100644 index 000000000..685bb4083 --- /dev/null +++ b/modules/test/ntp/python/src/run.py @@ -0,0 +1,75 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Run NTP test module""" +import argparse +import signal +import sys +import logger + +from ntp_module import NTPModule + +LOG_NAME = "ntp_runner" +LOGGER = logger.get_logger(LOG_NAME) + + +class NTPModuleRunner: + """Run the NTP module tests.""" + def __init__(self, module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + self.add_logger(module) + + LOGGER.info("Starting NTP test module") + + self._test_module = NTPModule(module) + self._test_module.run_tests() + + LOGGER.info("NTP test module finished") + + def add_logger(self, module): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, module) + + def _handler(self, signum): + LOGGER.debug("SigtermEnum: " + str(signal.SIGTERM)) + LOGGER.debug("Exit signal received: " + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info("Exit signal received. Stopping test module...") + LOGGER.info("Test module stopped") + sys.exit(1) + + +def run(): + parser = argparse.ArgumentParser( + description="NTP Module Help", + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + "-m", + "--module", + help="Define the module name to be used to create the log file") + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + NTPModuleRunner(args.module.strip()) + + +if __name__ == "__main__": + run() diff --git a/resources/devices/template/device_config.json b/resources/devices/template/device_config.json index 3bb804b22..1e92de25d 100644 --- a/resources/devices/template/device_config.json +++ b/resources/devices/template/device_config.json @@ -14,6 +14,35 @@ } } }, + "connection": { + "enabled": true, + "tests": { + "connection.mac_address": { + "enabled": true + }, + "connection.mac_oui": { + "enabled": true + }, + "connection.target_ping": { + "enabled": true + } + , + "connection.single_ip": { + "enabled": true + } + } + }, + "ntp": { + "enabled": true, + "tests": { + "ntp.network.ntp_support": { + "enabled": true + }, + "ntp.network.ntp_dhcp": { + "enabled": true + } + } + }, "baseline": { "enabled": false, "tests": { diff --git a/testing/test_pylint b/testing/test_pylint index 5cd1dff73..2ba696af5 100755 --- a/testing/test_pylint +++ b/testing/test_pylint @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -ERROR_LIMIT=1100 +ERROR_LIMIT=100 sudo cmd/install From 2ae337d8ab458a12eebfb81ef13154b5bae16f51 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 12 Jul 2023 10:24:22 +0100 Subject: [PATCH 048/400] Add ipv6 tests (#65) * Add ipv6 tests * Check for ND_NS --- modules/network/base/bin/start_module | 6 +-- .../network/dhcp-1/bin/start_network_service | 1 - modules/network/dhcp-1/conf/radvd.conf | 1 + modules/test/conn/conf/module_config.json | 10 +++++ .../test/conn/python/src/connection_module.py | 41 ++++++++++++++++++- 5 files changed, 54 insertions(+), 5 deletions(-) diff --git a/modules/network/base/bin/start_module b/modules/network/base/bin/start_module index 6de62f1a5..8e8cb5e4b 100644 --- a/modules/network/base/bin/start_module +++ b/modules/network/base/bin/start_module @@ -29,7 +29,7 @@ useradd $HOST_USER sysctl net.ipv6.conf.all.disable_ipv6=0 sysctl -p -#Read in the config file +# Read in the config file CONF_FILE="/testrun/conf/module_config.json" CONF=`cat $CONF_FILE` @@ -92,8 +92,8 @@ then fi fi -#Small pause to let all core services stabalize +# Small pause to let all core services stabalize sleep 3 -#Start the networking service +# Start the networking service $BIN_DIR/start_network_service $MODULE_NAME $INTF \ No newline at end of file diff --git a/modules/network/dhcp-1/bin/start_network_service b/modules/network/dhcp-1/bin/start_network_service index 82b4c6e33..413c48ceb 100644 --- a/modules/network/dhcp-1/bin/start_network_service +++ b/modules/network/dhcp-1/bin/start_network_service @@ -38,7 +38,6 @@ touch $RA_LOG_FILE chown $HOST_USER $DHCP_LOG_FILE chown $HOST_USER $RA_LOG_FILE - # Move the config files to the correct location cp /testrun/conf/isc-dhcp-server /etc/default/ cp /testrun/conf/dhcpd.conf /etc/dhcp/dhcpd.conf diff --git a/modules/network/dhcp-1/conf/radvd.conf b/modules/network/dhcp-1/conf/radvd.conf index f6d6f30d9..89995785f 100644 --- a/modules/network/dhcp-1/conf/radvd.conf +++ b/modules/network/dhcp-1/conf/radvd.conf @@ -8,5 +8,6 @@ interface veth0 AdvOnLink on; AdvAutonomous on; AdvRouterAddr on; + AdvSourceLLAddress off; }; }; \ No newline at end of file diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index 4053b4e26..496b6aada 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -36,6 +36,16 @@ "name": "connection.target_ping", "description": "The device under test responds to an ICMP echo (ping) request.", "expected_behavior": "The device under test responds to an ICMP echo (ping) request." + }, + { + "name": "connection.ipv6_slaac", + "description": "The device forms a valid IPv6 address as a combination of the IPv6 router prefix and the device interface identifier", + "expected_behavior": "The device under test complies with RFC4862 and forms a valid IPv6 SLAAC address" + }, + { + "name": "connection.ipv6_ping", + "description": "The device responds to an IPv6 ping (ICMPv6 Echo) request to the SLAAC address", + "expected_behavior": "The device responds to the ping as per RFC4443" } ] } diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index b4635ffb8..0b11fde24 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -25,6 +25,7 @@ DHCP_SERVER_CAPTURE_FILE = '/runtime/network/dhcp-1.pcap' STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' +SLAAC_PREFIX = "fd10:77be:4186" class ConnectionModule(TestModule): @@ -83,6 +84,8 @@ def _connection_dhcp_address(self): LOGGER.info('No DHCP lease found for: ' + self._device_mac) return False, 'No DHCP lease found for: ' + self._device_mac + self._ipv6_addr = None + def _connection_mac_address(self): LOGGER.info('Running connection.mac_address') if self._device_mac is not None: @@ -158,7 +161,43 @@ def _get_oui_manufacturer(self, mac_address): return line[start:].strip() # Extract the company name return None + def _connection_ipv6_slaac(self): + LOGGER.info("Running connection.ipv6_slaac") + packet_capture = rdpcap(MONITOR_CAPTURE_FILE) + + sends_ipv6 = False + + for packet in packet_capture: + if IPv6 in packet and packet.src == self._device_mac: + sends_ipv6 = True + if ICMPv6ND_NS in packet: + ipv6_addr = str(packet[ICMPv6ND_NS].tgt) + if ipv6_addr.startswith(SLAAC_PREFIX): + self._ipv6_addr = ipv6_addr + LOGGER.info(f"Device has formed SLAAC address {ipv6_addr}") + return True + + if sends_ipv6: + LOGGER.info("Device does not support IPv6 SLAAC") + else: + LOGGER.info("Device does not support IPv6") + return False + + def _connection_ipv6_ping(self): + LOGGER.info("Running connection.ipv6_ping") + + if self._ipv6_addr is None: + LOGGER.info("No IPv6 SLAAC address found. Cannot ping") + return + + if self._ping(self._ipv6_addr): + LOGGER.info(f"Device responds to IPv6 ping on {self._ipv6_addr}") + return True + else: + LOGGER.info("Device does not respond to IPv6 ping") + return False + def _ping(self, host): - cmd = 'ping -c 1 ' + str(host) + cmd = "ping -c 1 " + str(host) success = util.run_command(cmd, output=False) return success From fe4bf43b652e8a6ac1f91bca21a10209fa3699d1 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 13 Jul 2023 07:25:13 -0700 Subject: [PATCH 049/400] Connection private address (#71) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * formatting * Change isc-dhcp service setup Fix dhcpd logging Add start and stop methods to grpc dhcp client Add dhcp2 client Inttial private_addr test * Add max lease time Add unit tests * fix last commit * finish initial work on test * pylinting * Breakup test and allow better failure reporting * restore network after test * Wait for device to get a lease from original dhcp range after network restore * pylinting * Fix ipv6 tests --------- Co-authored-by: Jacob Boddey --- modules/network/dhcp-1/bin/isc-dhcp-service | 56 ++++ .../network/dhcp-1/bin/start_network_service | 4 +- modules/network/dhcp-1/conf/dhcpd.conf | 5 +- modules/network/dhcp-1/conf/isc-dhcp-server | 2 +- modules/network/dhcp-1/conf/radvd.conf | 23 +- .../python/src/grpc_server/dhcp_config.py | 67 ++++- .../src/grpc_server/dhcp_config_test.py | 12 +- .../python/src/grpc_server/dhcp_lease.py | 2 +- .../python/src/grpc_server/dhcp_leases.py | 6 +- .../python/src/grpc_server/dhcp_server.py | 13 +- .../python/src/grpc_server/network_service.py | 1 + modules/network/dhcp-2/bin/isc-dhcp-service | 56 ++++ .../network/dhcp-2/bin/start_network_service | 4 +- modules/network/dhcp-2/conf/dhcpd.conf | 51 ++-- .../python/src/grpc_server/dhcp_config.py | 67 ++++- .../src/grpc_server/dhcp_config_test.py | 15 +- .../python/src/grpc_server/dhcp_lease.py | 2 +- .../python/src/grpc_server/dhcp_server.py | 12 +- .../python/src/grpc/proto/dhcp1/client.py | 35 ++- .../python/src/grpc/proto/dhcp2/client.py | 130 +++++++++ modules/test/conn/conf/module_config.json | 21 +- .../test/conn/python/src/connection_module.py | 246 +++++++++++++++++- testing/test_pylint | 2 +- 23 files changed, 739 insertions(+), 93 deletions(-) create mode 100644 modules/network/dhcp-1/bin/isc-dhcp-service create mode 100644 modules/network/dhcp-2/bin/isc-dhcp-service create mode 100644 modules/test/base/python/src/grpc/proto/dhcp2/client.py diff --git a/modules/network/dhcp-1/bin/isc-dhcp-service b/modules/network/dhcp-1/bin/isc-dhcp-service new file mode 100644 index 000000000..de029515b --- /dev/null +++ b/modules/network/dhcp-1/bin/isc-dhcp-service @@ -0,0 +1,56 @@ +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +CONFIG_FILE=/etc/dhcp/dhcpd.conf +DHCP_PID_FILE=/var/run/dhcpd.pid +DHCP_LOG_FILE=/runtime/network/dhcp1-dhcpd.log + +stop_dhcp(){ + # Directly kill by PID file reference + if [ -f "$DHCP_PID_FILE" ]; then + kill -9 $(cat $DHCP_PID_FILE) || true + rm -f $DHCP_PID_FILE + fi +} + +start_dhcp(){ + /usr/sbin/dhcpd -d &> $DHCP_LOG_FILE & +} + +case "$1" in + start) + start_dhcp + ;; + stop) + stop_dhcp + ;; + restart) + stop_dhcp + sleep 1 + start_dhcp + ;; + status) + if [ -f "$DHCP_PID_FILE" ]; then + echo "isc-dhcp service is running." + else + echo "isc-dhcp service is not running." + fi + ;; + *) + echo "Usage: $0 {start|stop|status|restart}" + exit 1 + ;; +esac \ No newline at end of file diff --git a/modules/network/dhcp-1/bin/start_network_service b/modules/network/dhcp-1/bin/start_network_service index 413c48ceb..a9ff445e4 100644 --- a/modules/network/dhcp-1/bin/start_network_service +++ b/modules/network/dhcp-1/bin/start_network_service @@ -43,7 +43,9 @@ cp /testrun/conf/isc-dhcp-server /etc/default/ cp /testrun/conf/dhcpd.conf /etc/dhcp/dhcpd.conf cp /testrun/conf/radvd.conf /etc/radvd.conf -# Move the radvd-sevice file to the correct location + +# Move the service files to the correct location +cp /testrun/bin/isc-dhcp-service /usr/local/bin/ cp /testrun/bin/radvd-service /usr/local/bin/ # Start the DHCP Server diff --git a/modules/network/dhcp-1/conf/dhcpd.conf b/modules/network/dhcp-1/conf/dhcpd.conf index ee171279c..df804acf9 100644 --- a/modules/network/dhcp-1/conf/dhcpd.conf +++ b/modules/network/dhcp-1/conf/dhcpd.conf @@ -1,4 +1,5 @@ -default-lease-time 300; +default-lease-time 30; +max-lease-time 30; failover peer "failover-peer" { primary; @@ -8,7 +9,7 @@ failover peer "failover-peer" { peer port 647; max-response-delay 60; max-unacked-updates 10; - mclt 3600; + mclt 30; split 128; load balance max seconds 3; } diff --git a/modules/network/dhcp-1/conf/isc-dhcp-server b/modules/network/dhcp-1/conf/isc-dhcp-server index 44db95cd9..161f52d80 100644 --- a/modules/network/dhcp-1/conf/isc-dhcp-server +++ b/modules/network/dhcp-1/conf/isc-dhcp-server @@ -1,4 +1,4 @@ # On what interfaces should the DHCP server (dhcpd) serve DHCP requests? # Separate multiple interfaces with spaces, e.g. "eth0 eth1". INTERFACESv4="veth0" -#INTERFACESv6="veth0" +#INTERFACESv6="veth0" \ No newline at end of file diff --git a/modules/network/dhcp-1/conf/radvd.conf b/modules/network/dhcp-1/conf/radvd.conf index 89995785f..2f0c75d9d 100644 --- a/modules/network/dhcp-1/conf/radvd.conf +++ b/modules/network/dhcp-1/conf/radvd.conf @@ -1,13 +1,12 @@ -interface veth0 -{ - AdvSendAdvert on; - AdvManagedFlag off; - MinRtrAdvInterval 30; - MaxRtrAdvInterval 60; - prefix fd10:77be:4186::/64 { - AdvOnLink on; - AdvAutonomous on; - AdvRouterAddr on; - AdvSourceLLAddress off; - }; +interface veth0 +{ + AdvSendAdvert on; + AdvManagedFlag off; + MinRtrAdvInterval 30; + MaxRtrAdvInterval 60; + prefix fd10:77be:4186::/64 { + AdvOnLink on; + AdvAutonomous on; + AdvRouterAddr on; + }; }; \ No newline at end of file diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py index 6f003014c..877d49610 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config.py @@ -20,13 +20,15 @@ LOGGER = None CONFIG_FILE = '/etc/dhcp/dhcpd.conf' DEFAULT_LEASE_TIME_KEY = 'default-lease-time' +MAX_LEASE_TIME_KEY = 'max-lease-time' class DHCPConfig: """Represents the DHCP Servers configuration and gives access to modify it""" def __init__(self): - self._default_lease_time = 300 + self._default_lease_time = 30 + self._max_lease_time = 30 self._subnets = [] self._peer = None self._reserved_hosts = [] @@ -120,17 +122,50 @@ def set_range(self, start, end, subnet=0, pool=0): octets[-1] = '0' dhcp_subnet = '.'.join(octets) - #Update the subnet and range - self._subnets[subnet].set_subnet(dhcp_subnet) + # Calcualte the netmask from the range + prefix = self.calculate_prefix_length(start, end) + netmask = self.calculate_netmask(prefix) + + #Update the subnet, range and netmask + self._subnets[subnet].set_subnet(dhcp_subnet, netmask) self._subnets[subnet].pools[pool].set_range(start, end) + def calculate_prefix_length(self, start_ip, end_ip): + start_octets = start_ip.split('.') + end_octets = end_ip.split('.') + + start_int = int( + ''.join(format(int(octet), '08b') for octet in start_octets), 2) + end_int = int(''.join(format(int(octet), '08b') for octet in end_octets), 2) + + xor_result = start_int ^ end_int + prefix_length = 32 - xor_result.bit_length() + + return prefix_length + + def calculate_netmask(self, prefix_length): + num_network_bits = prefix_length + num_host_bits = 32 - num_network_bits + + netmask_int = (2**num_network_bits - 1) << num_host_bits + netmask_octets = [(netmask_int >> (i * 8)) & 0xff for i in range(3, -1, -1)] + + return '.'.join(str(octet) for octet in netmask_octets) + def __str__(self): + config = ('{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};' + if self._default_lease_time is not None else '') + config += ('\n\r{MAX_LEASE_TIME_KEY} {MAX_LEASE_TIME};' + if self._max_lease_time is not None else '') + # Encode the top level config options - config = """{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + #config = """{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" config = config.format(length='multi-line', DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, - DEFAULT_LEASE_TIME=self._default_lease_time) + DEFAULT_LEASE_TIME=self._default_lease_time, + MAX_LEASE_TIME_KEY=MAX_LEASE_TIME_KEY, + MAX_LEASE_TIME=self._max_lease_time) # Encode the failover peer config += '\n\n' + str(self._peer) @@ -358,12 +393,24 @@ def set_subnet(self, subnet, netmask=None): self._subnet = subnet self._subnet_mask = netmask - # Calculate the broadcast from the subnet - octets = subnet.split('.') - octets[-1] = '255' - dhcp_broadcast = '.'.join(octets) + # Calculate the broadcast from the subnet and netmask + broadcast = self.calculate_broadcast_address(subnet, netmask) + self._broadcast = broadcast + + def calculate_broadcast_address(self, subnet_address, netmask): + subnet_octets = subnet_address.split('.') + netmask_octets = netmask.split('.') + + subnet_int = int( + ''.join(format(int(octet), '08b') for octet in subnet_octets), 2) + netmask_int = int( + ''.join(format(int(octet), '08b') for octet in netmask_octets), 2) + + broadcast_int = subnet_int | (~netmask_int & 0xffffffff) + broadcast_octets = [(broadcast_int >> (i * 8)) & 0xff + for i in range(3, -1, -1)] - self._broadcast = dhcp_broadcast + return '.'.join(str(octet) for octet in broadcast_octets) def resolve_subnet(self, subnet): subnet_parts = subnet.split('\n') diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py index a34ff4e31..c283f0726 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py @@ -19,6 +19,7 @@ CONFIG_FILE = 'conf/dhcpd.conf' DHCP_CONFIG = None + def get_config_file_path(): current_dir = os.path.dirname(os.path.abspath(__file__)) module_dir = os.path.dirname( @@ -91,6 +92,15 @@ def test_resolve_config_with_hosts(self): self.assertIsNotNone(host) print('ResolveConfigWithHosts:\n' + str(config_with_hosts)) + def test_set_subnet_range(self): + range_start = '10.0.0.100' + range_end = '10.0.0.200' + DHCP_CONFIG.set_range(range_start, range_end) + subnets = DHCP_CONFIG.resolve_subnets(str(DHCP_CONFIG)) + pool = subnets[0].pools[0] + self.assertTrue(pool.range_start == range_start + and pool.range_end == range_end) + print('SetSubnetRange:\n' + str(DHCP_CONFIG)) if __name__ == '__main__': suite = unittest.TestSuite() @@ -100,6 +110,6 @@ def test_resolve_config_with_hosts(self): suite.addTest(DHCPConfigTest('test_add_reserved_host')) suite.addTest(DHCPConfigTest('test_delete_reserved_host')) suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) - + suite.addTest(DHCPConfigTest('test_set_subnet_range')) runner = unittest.TextTestRunner() runner.run(suite) diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py index 0d2f43e3b..dd7ba9516 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_lease.py @@ -39,7 +39,7 @@ def _make_lease(self, lease): self.hw_addr = sections[0] self.ip = sections[1] self.hostname = sections[2] - self.expires = sections[3] + '' '' + sections[4] + self.expires = sections[3] + ' ' + sections[4] self.manufacturer = ' '.join(sections[5:]) def get_millis(self, timestamp): diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py index 698277a02..aa2945759 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_leases.py @@ -58,9 +58,9 @@ def get_leases(self): leases = [] lease_list_raw = self._get_lease_list() LOGGER.info('Raw Leases:\n' + str(lease_list_raw) + '\n') - lease_list_start = lease_list_raw.find('=========',0) - lease_list_start = lease_list_raw.find('\n',lease_list_start) - lease_list = lease_list_raw[lease_list_start+1:] + lease_list_start = lease_list_raw.find('=========', 0) + lease_list_start = lease_list_raw.find('\n', lease_list_start) + lease_list = lease_list_raw[lease_list_start + 1:] lines = lease_list.split('\n') for line in lines: try: diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py index 5e88d59fe..aa6afb8c1 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py @@ -37,7 +37,7 @@ def __init__(self): def restart(self): LOGGER.info('Restarting DHCP Server') - isc_started = util.run_command('service isc-dhcp-server restart', False) + isc_started = util.run_command('isc-dhcp-service restart', False) radvd_started = self.radvd.restart() started = isc_started and radvd_started LOGGER.info('DHCP Restarted: ' + str(started)) @@ -45,7 +45,7 @@ def restart(self): def start(self): LOGGER.info('Starting DHCP Server') - isc_started = util.run_command('service isc-dhcp-server start', False) + isc_started = util.run_command('isc-dhcp-service start', False) radvd_started = self.radvd.start() started = isc_started and radvd_started LOGGER.info('DHCP Started: ' + str(started)) @@ -53,7 +53,7 @@ def start(self): def stop(self): LOGGER.info('Stopping DHCP Server') - isc_stopped = util.run_command('service isc-dhcp-server stop', False) + isc_stopped = util.run_command('isc-dhcp-service stop', False) radvd_stopped = self.radvd.stop() stopped = isc_stopped and radvd_stopped LOGGER.info('DHCP Stopped: ' + str(stopped)) @@ -61,9 +61,8 @@ def stop(self): def is_running(self): LOGGER.info('Checking DHCP Status') - response = util.run_command('service isc-dhcp-server status') - isc_running = response[ - 0] == 'Status of ISC DHCPv4 server: dhcpd is running.' + response = util.run_command('isc-dhcp-service status') + isc_running = response[0] == 'isc-dhcp service is running.' radvd_running = self.radvd.is_running() running = isc_running and radvd_running LOGGER.info('DHCP Status: ' + str(running)) @@ -107,6 +106,7 @@ def boot(self): return isc_booted and radvd_booted + def run(): dhcp_server = DHCPServer() booted = dhcp_server.boot() @@ -126,5 +126,6 @@ def run(): dhcp_server.radvd.restart() time.sleep(1) + if __name__ == '__main__': run() diff --git a/modules/network/dhcp-1/python/src/grpc_server/network_service.py b/modules/network/dhcp-1/python/src/grpc_server/network_service.py index 043ca49b3..92726025d 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/network_service.py +++ b/modules/network/dhcp-1/python/src/grpc_server/network_service.py @@ -25,6 +25,7 @@ LOG_NAME = 'network_service' LOGGER = None + class NetworkService(pb2_grpc.NetworkModule): """gRPC endpoints for the DHCP Server""" diff --git a/modules/network/dhcp-2/bin/isc-dhcp-service b/modules/network/dhcp-2/bin/isc-dhcp-service new file mode 100644 index 000000000..ee6df0341 --- /dev/null +++ b/modules/network/dhcp-2/bin/isc-dhcp-service @@ -0,0 +1,56 @@ +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +CONFIG_FILE=/etc/dhcp/dhcpd.conf +DHCP_PID_FILE=/var/run/dhcpd.pid +DHCP_LOG_FILE=/runtime/network/dhcp2-dhcpd.log + +stop_dhcp(){ + # Directly kill by PID file reference + if [ -f "$DHCP_PID_FILE" ]; then + kill -9 $(cat $DHCP_PID_FILE) || true + rm -f $DHCP_PID_FILE + fi +} + +start_dhcp(){ + /usr/sbin/dhcpd -d &> $DHCP_LOG_FILE & +} + +case "$1" in + start) + start_dhcp + ;; + stop) + stop_dhcp + ;; + restart) + stop_dhcp + sleep 1 + start_dhcp + ;; + status) + if [ -f "$DHCP_PID_FILE" ]; then + echo "isc-dhcp service is running." + else + echo "isc-dhcp service is not running." + fi + ;; + *) + echo "Usage: $0 {start|stop|status|restart}" + exit 1 + ;; +esac \ No newline at end of file diff --git a/modules/network/dhcp-2/bin/start_network_service b/modules/network/dhcp-2/bin/start_network_service index ed7d3125e..5acea606b 100644 --- a/modules/network/dhcp-2/bin/start_network_service +++ b/modules/network/dhcp-2/bin/start_network_service @@ -44,7 +44,9 @@ cp /testrun/conf/isc-dhcp-server /etc/default/ cp /testrun/conf/dhcpd.conf /etc/dhcp/dhcpd.conf cp /testrun/conf/radvd.conf /etc/radvd.conf -# Move the radvd-sevice file to the correct location + +# Move the service files to the correct location +cp /testrun/bin/isc-dhcp-service /usr/local/bin/ cp /testrun/bin/radvd-service /usr/local/bin/ # Start the DHCP Server diff --git a/modules/network/dhcp-2/conf/dhcpd.conf b/modules/network/dhcp-2/conf/dhcpd.conf index dcc47a4fe..5a6c82410 100644 --- a/modules/network/dhcp-2/conf/dhcpd.conf +++ b/modules/network/dhcp-2/conf/dhcpd.conf @@ -1,25 +1,26 @@ -default-lease-time 300; - -failover peer "failover-peer" { - secondary; - address 10.10.10.3; - port 647; - peer address 10.10.10.2; - peer port 847; - max-response-delay 60; - max-unacked-updates 10; - load balance max seconds 3; -} - -subnet 10.10.10.0 netmask 255.255.255.0 { - option ntp-servers 10.10.10.5; - option subnet-mask 255.255.255.0; - option broadcast-address 10.10.10.255; - option routers 10.10.10.1; - option domain-name-servers 10.10.10.4; - interface veth0; - pool { - failover peer "failover-peer"; - range 10.10.10.10 10.10.10.20; - } -} +default-lease-time 30; +max-lease-time 30; + +failover peer "failover-peer" { + secondary; + address 10.10.10.3; + port 647; + peer address 10.10.10.2; + peer port 847; + max-response-delay 60; + max-unacked-updates 10; + load balance max seconds 3; +} + +subnet 10.10.10.0 netmask 255.255.255.0 { + option ntp-servers 10.10.10.5; + option subnet-mask 255.255.255.0; + option broadcast-address 10.10.10.255; + option routers 10.10.10.1; + option domain-name-servers 10.10.10.4; + interface veth0; + pool { + failover peer "failover-peer"; + range 10.10.10.10 10.10.10.20; + } +} diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py index 5da5e4cf2..5357ba7ed 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config.py @@ -22,13 +22,15 @@ CONFIG_FILE = '/etc/dhcp/dhcpd.conf' DEFAULT_LEASE_TIME_KEY = 'default-lease-time' +MAX_LEASE_TIME_KEY = 'max-lease-time' class DHCPConfig: """Represents the DHCP Servers configuration and gives access to modify it""" def __init__(self): - self._default_lease_time = 300 + self._default_lease_time = 30 + self._max_lease_time = 30 self._subnets = [] self._peer = None self._reserved_hosts = [] @@ -122,17 +124,50 @@ def set_range(self, start, end, subnet=0, pool=0): octets[-1] = '0' dhcp_subnet = '.'.join(octets) - #Update the subnet and range - self._subnets[subnet].set_subnet(dhcp_subnet) + # Calcualte the netmask from the range + prefix = self.calculate_prefix_length(start, end) + netmask = self.calculate_netmask(prefix) + + #Update the subnet, range and netmask + self._subnets[subnet].set_subnet(dhcp_subnet, netmask) self._subnets[subnet].pools[pool].set_range(start, end) + def calculate_prefix_length(self, start_ip, end_ip): + start_octets = start_ip.split('.') + end_octets = end_ip.split('.') + + start_int = int( + ''.join(format(int(octet), '08b') for octet in start_octets), 2) + end_int = int(''.join(format(int(octet), '08b') for octet in end_octets), 2) + + xor_result = start_int ^ end_int + prefix_length = 32 - xor_result.bit_length() + + return prefix_length + + def calculate_netmask(self, prefix_length): + num_network_bits = prefix_length + num_host_bits = 32 - num_network_bits + + netmask_int = (2**num_network_bits - 1) << num_host_bits + netmask_octets = [(netmask_int >> (i * 8)) & 0xff for i in range(3, -1, -1)] + + return '.'.join(str(octet) for octet in netmask_octets) + def __str__(self): + config = ('{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};' + if self._default_lease_time is not None else '') + config += ('\n\r{MAX_LEASE_TIME_KEY} {MAX_LEASE_TIME};' + if self._max_lease_time is not None else '') + # Encode the top level config options - config = """{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" + #config = """{DEFAULT_LEASE_TIME_KEY} {DEFAULT_LEASE_TIME};""" config = config.format(length='multi-line', DEFAULT_LEASE_TIME_KEY=DEFAULT_LEASE_TIME_KEY, - DEFAULT_LEASE_TIME=self._default_lease_time) + DEFAULT_LEASE_TIME=self._default_lease_time, + MAX_LEASE_TIME_KEY=MAX_LEASE_TIME_KEY, + MAX_LEASE_TIME=self._max_lease_time) # Encode the failover peer config += '\n\n' + str(self._peer) @@ -360,12 +395,24 @@ def set_subnet(self, subnet, netmask=None): self._subnet = subnet self._subnet_mask = netmask - # Calculate the broadcast from the subnet - octets = subnet.split('.') - octets[-1] = '255' - dhcp_broadcast = '.'.join(octets) + # Calculate the broadcast from the subnet and netmask + broadcast = self.calculate_broadcast_address(subnet, netmask) + self._broadcast = broadcast + + def calculate_broadcast_address(self, subnet_address, netmask): + subnet_octets = subnet_address.split('.') + netmask_octets = netmask.split('.') + + subnet_int = int( + ''.join(format(int(octet), '08b') for octet in subnet_octets), 2) + netmask_int = int( + ''.join(format(int(octet), '08b') for octet in netmask_octets), 2) + + broadcast_int = subnet_int | (~netmask_int & 0xffffffff) + broadcast_octets = [(broadcast_int >> (i * 8)) & 0xff + for i in range(3, -1, -1)] - self._broadcast = dhcp_broadcast + return '.'.join(str(octet) for octet in broadcast_octets) def resolve_subnet(self, subnet): subnet_parts = subnet.split('\n') diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py index b07f57b27..c283f0726 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py @@ -19,6 +19,7 @@ CONFIG_FILE = 'conf/dhcpd.conf' DHCP_CONFIG = None + def get_config_file_path(): current_dir = os.path.dirname(os.path.abspath(__file__)) module_dir = os.path.dirname( @@ -26,11 +27,13 @@ def get_config_file_path(): conf_file = os.path.join(module_dir, CONFIG_FILE) return conf_file + def get_config(): dhcp_config = DHCPConfig() dhcp_config.resolve_config(get_config_file_path()) return dhcp_config + class DHCPConfigTest(unittest.TestCase): @classmethod @@ -89,6 +92,16 @@ def test_resolve_config_with_hosts(self): self.assertIsNotNone(host) print('ResolveConfigWithHosts:\n' + str(config_with_hosts)) + def test_set_subnet_range(self): + range_start = '10.0.0.100' + range_end = '10.0.0.200' + DHCP_CONFIG.set_range(range_start, range_end) + subnets = DHCP_CONFIG.resolve_subnets(str(DHCP_CONFIG)) + pool = subnets[0].pools[0] + self.assertTrue(pool.range_start == range_start + and pool.range_end == range_end) + print('SetSubnetRange:\n' + str(DHCP_CONFIG)) + if __name__ == '__main__': suite = unittest.TestSuite() suite.addTest(DHCPConfigTest('test_resolve_config')) @@ -97,6 +110,6 @@ def test_resolve_config_with_hosts(self): suite.addTest(DHCPConfigTest('test_add_reserved_host')) suite.addTest(DHCPConfigTest('test_delete_reserved_host')) suite.addTest(DHCPConfigTest('test_resolve_config_with_hosts')) - + suite.addTest(DHCPConfigTest('test_set_subnet_range')) runner = unittest.TextTestRunner() runner.run(suite) diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py index 0d2f43e3b..dd7ba9516 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_lease.py @@ -39,7 +39,7 @@ def _make_lease(self, lease): self.hw_addr = sections[0] self.ip = sections[1] self.hostname = sections[2] - self.expires = sections[3] + '' '' + sections[4] + self.expires = sections[3] + ' ' + sections[4] self.manufacturer = ' '.join(sections[5:]) def get_millis(self, timestamp): diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py index 67a31c2cb..270a2c700 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py @@ -37,7 +37,7 @@ def __init__(self): def restart(self): LOGGER.info('Restarting DHCP Server') - isc_started = util.run_command('service isc-dhcp-server restart', False) + isc_started = util.run_command('isc-dhcp-service restart', False) radvd_started = self.radvd.restart() started = isc_started and radvd_started LOGGER.info('DHCP Restarted: ' + str(started)) @@ -45,7 +45,7 @@ def restart(self): def start(self): LOGGER.info('Starting DHCP Server') - isc_started = util.run_command('service isc-dhcp-server start', False) + isc_started = util.run_command('isc-dhcp-service start', False) radvd_started = self.radvd.start() started = isc_started and radvd_started LOGGER.info('DHCP Started: ' + str(started)) @@ -53,7 +53,7 @@ def start(self): def stop(self): LOGGER.info('Stopping DHCP Server') - isc_stopped = util.run_command('service isc-dhcp-server stop', False) + isc_stopped = util.run_command('isc-dhcp-service stop', False) radvd_stopped = self.radvd.stop() stopped = isc_stopped and radvd_stopped LOGGER.info('DHCP Stopped: ' + str(stopped)) @@ -61,9 +61,8 @@ def stop(self): def is_running(self): LOGGER.info('Checking DHCP Status') - response = util.run_command('service isc-dhcp-server status') - isc_running = response[ - 0] == 'Status of ISC DHCPv4 server: dhcpd is running.' + response = util.run_command('isc-dhcp-service status') + isc_running = response[0] == 'isc-dhcp service is running.' radvd_running = self.radvd.is_running() running = isc_running and radvd_running LOGGER.info('DHCP Status: ' + str(running)) @@ -107,6 +106,7 @@ def boot(self): return isc_booted and radvd_booted + def run(): dhcp_server = DHCPServer() booted = dhcp_server.boot() diff --git a/modules/test/base/python/src/grpc/proto/dhcp1/client.py b/modules/test/base/python/src/grpc/proto/dhcp1/client.py index 921929edb..8707957ce 100644 --- a/modules/test/base/python/src/grpc/proto/dhcp1/client.py +++ b/modules/test/base/python/src/grpc/proto/dhcp1/client.py @@ -1,13 +1,28 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +"""gRPC client module for the primary DHCP Server""" import grpc import grpc_pb2_grpc as pb2_grpc import grpc_pb2 as pb2 + DEFAULT_PORT = '5001' DEFAULT_HOST = '10.10.10.2' # Default DHCP1 server class Client(): - + """gRPC Client for the primary DHCP server""" def __init__(self, port=DEFAULT_PORT, host=DEFAULT_HOST): self._port = port self._host = host @@ -86,6 +101,24 @@ def get_status(self): return response + def stop_dhcp_server(self): + # Create a request message + request = pb2.StopDHCPServerRequest() + + # Make the RPC call + response = self._stub.StopDHCPServer(request) + + return response + + def start_dhcp_server(self): + # Create a request message + request = pb2.StartDHCPServerRequest() + + # Make the RPC call + response = self._stub.StartDHCPServer(request) + + return response + def set_dhcp_range(self,start,end): # Create a request message request = pb2.SetDHCPRangeRequest() diff --git a/modules/test/base/python/src/grpc/proto/dhcp2/client.py b/modules/test/base/python/src/grpc/proto/dhcp2/client.py new file mode 100644 index 000000000..e0d953ee5 --- /dev/null +++ b/modules/test/base/python/src/grpc/proto/dhcp2/client.py @@ -0,0 +1,130 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License +"""gRPC client module for the secondary DHCP Server""" +import grpc +import grpc_pb2_grpc as pb2_grpc +import grpc_pb2 as pb2 + +DEFAULT_PORT = '5001' +DEFAULT_HOST = '10.10.10.3' # Default DHCP2 server + + +class Client(): + """gRPC Client for the secondary DHCP server""" + def __init__(self, port=DEFAULT_PORT, host=DEFAULT_HOST): + self._port = port + self._host = host + + # Create a gRPC channel to connect to the server + self._channel = grpc.insecure_channel(self._host + ':' + self._port) + + # Create a gRPC stub + self._stub = pb2_grpc.NetworkModuleStub(self._channel) + + def add_reserved_lease(self, hostname, hw_addr, ip_addr): + # Create a request message + request = pb2.AddReservedLeaseRequest() + request.hostname = hostname + request.hw_addr = hw_addr + request.ip_addr = ip_addr + + # Make the RPC call + response = self._stub.AddReservedLease(request) + + return response + + def delete_reserved_lease(self, hw_addr): + # Create a request message + request = pb2.DeleteReservedLeaseRequest() + request.hw_addr = hw_addr + + # Make the RPC call + response = self._stub.DeleteReservedLease(request) + + return response + + def disable_failover(self): + # Create a request message + request = pb2.DisableFailoverRequest() + + # Make the RPC call + response = self._stub.DisableFailover(request) + + return response + + def enable_failover(self): + # Create a request message + request = pb2.EnableFailoverRequest() + + # Make the RPC call + response = self._stub.EnableFailover(request) + + return response + + def get_dhcp_range(self): + # Create a request message + request = pb2.GetDHCPRangeRequest() + + # Make the RPC call + response = self._stub.GetDHCPRange(request) + + return response + + def get_lease(self,hw_addr): + # Create a request message + request = pb2.GetLeaseRequest() + request.hw_addr=hw_addr + + # Make the RPC call + response = self._stub.GetLease(request) + + return response + + def get_status(self): + # Create a request message + request = pb2.GetStatusRequest() + + # Make the RPC call + response = self._stub.GetStatus(request) + + return response + + def stop_dhcp_server(self): + # Create a request message + request = pb2.StopDHCPServerRequest() + + # Make the RPC call + response = self._stub.StopDHCPServer(request) + + return response + + def start_dhcp_server(self): + # Create a request message + request = pb2.StartDHCPServerRequest() + + # Make the RPC call + response = self._stub.StartDHCPServer(request) + + return response + + def set_dhcp_range(self,start,end): + # Create a request message + request = pb2.SetDHCPRangeRequest() + request.start=start + request.end=end + + # Make the RPC call + response = self._stub.SetDHCPRange(request) + + return response diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index 496b6aada..b82879544 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -9,7 +9,7 @@ "docker": { "depends_on": "base", "enable_container": true, - "timeout": 30 + "timeout": 600 }, "tests": [ { @@ -27,6 +27,25 @@ "description": "The device under test hs a MAC address prefix that is registered against a known manufacturer.", "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database." }, + { + "name": "connection.private_address", + "description": "The device under test accepts an IP address that is compliant with RFC 1918 Address Allocation for Private Internets.", + "expected_behavior": "The device under test accepts IP addresses within all ranges specified in RFC 1918 and communicates using these addresses. The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of the IP address space for private internets. 10.0.0.0 - 10.255.255.255.255 (10/8 prefix). 172.16.0.0 - 172.31.255.255 (172.16/12 prefix). 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)", + "config": [ + { + "start": "10.0.0.100", + "end": "10.0.0.200" + }, + { + "start":"172.16.0.0", + "end":"172.16.255.255" + }, + { + "start":"192.168.0.0", + "end":"192.168.255.255" + } + ] + }, { "name": "connection.single_ip", "description": "The network switch port connected to the device reports only one IP address for the device under test.", diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 0b11fde24..387b19773 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -14,10 +14,12 @@ """Connection test module""" import util import sys -import json -from scapy.all import rdpcap, DHCP, Ether +import time +from datetime import datetime +from scapy.all import rdpcap, DHCP, Ether, IPv6 from test_module import TestModule from dhcp1.client import Client as DHCPClient1 +from dhcp2.client import Client as DHCPClient2 LOG_NAME = 'test_connection' LOGGER = None @@ -36,6 +38,7 @@ def __init__(self, module): global LOGGER LOGGER = self._get_logger() self.dhcp1_client = DHCPClient1() + self.dhcp2_client = DHCPClient2() # ToDo: Move this into some level of testing, leave for # reference until tests are implemented with these calls @@ -64,12 +67,79 @@ def __init__(self, module): # response = self.dhcp1_client.set_dhcp_range('10.10.10.20','10.10.10.30') # print("Set Range: " + str(response)) + def _connection_private_address(self, config): + # Shutdown the secondary DHCP Server + LOGGER.info('Running connection.private_address') + response = self.dhcp1_client.get_dhcp_range() + cur_range = {} + if response.code == 200: + cur_range['start'] = response.start + cur_range['end'] = response.end + LOGGER.info('Current DHCP subnet range: ' + str(cur_range)) + else: + LOGGER.error('Failed to resolve current subnet range required ' + 'for restoring network') + return None, ('Failed to resolve current subnet range required ' + 'for restoring network') + + results = [] + dhcp_setup = self.setup_single_dhcp_server() + if dhcp_setup[0]: + LOGGER.info(dhcp_setup[1]) + lease = self._get_cur_lease() + if lease is not None: + if self._is_lease_active(lease): + results = self.test_subnets(config) + else: + return None, 'Failed to confirm a valid active lease for the device' + else: + LOGGER.error(dhcp_setup[1]) + return None, 'Failed to setup DHCP server for test' + + # Process and return final results + final_result = None + final_result_details = '' + for result in results: + if final_result is None: + final_result = result['result'] + else: + final_result &= result['result'] + final_result_details += result['details'] + '\n' + + try: + # Restore failover configuration of DHCP servers + self.restore_failover_dhcp_server(cur_range) + + # Wait for the current lease to expire + self._wait_for_lease_expire(self._get_cur_lease()) + + # Wait for a new lease to be provided before exiting test + # to prevent other test modules from failing + for _ in range(5): + LOGGER.info('Checking for new lease') + lease = self._get_cur_lease() + if lease is not None: + LOGGER.info('New Lease found: ' + str(lease)) + LOGGER.info('Validating subnet for new lease...') + in_range = self.is_ip_in_range(lease['ip'], cur_range['start'], + cur_range['end']) + LOGGER.info('Lease within subnet: ' + str(in_range)) + break + else: + LOGGER.info('New lease not found. Waiting to check again') + time.sleep(5) + + except Exception as e: # pylint: disable=W0718 + LOGGER.error('Failed to restore DHCP server configuration: ' + str(e)) + + return final_result, final_result_details + def _connection_dhcp_address(self): LOGGER.info('Running connection.dhcp_address') response = self.dhcp1_client.get_lease(self._device_mac) LOGGER.info('DHCP Lease resolved:\n' + str(response)) if response.code == 200: - lease = eval(response.message) # pylint: disable=E0203 + lease = eval(response.message) # pylint: disable=W0123 if 'ip' in lease: ip_addr = lease['ip'] LOGGER.info('IP Resolved: ' + ip_addr) @@ -84,8 +154,6 @@ def _connection_dhcp_address(self): LOGGER.info('No DHCP lease found for: ' + self._device_mac) return False, 'No DHCP lease found for: ' + self._device_mac - self._ipv6_addr = None - def _connection_mac_address(self): LOGGER.info('Running connection.mac_address') if self._device_mac is not None: @@ -173,7 +241,7 @@ def _connection_ipv6_slaac(self): if ICMPv6ND_NS in packet: ipv6_addr = str(packet[ICMPv6ND_NS].tgt) if ipv6_addr.startswith(SLAAC_PREFIX): - self._ipv6_addr = ipv6_addr + self._device_ipv6_addr = ipv6_addr LOGGER.info(f"Device has formed SLAAC address {ipv6_addr}") return True @@ -186,12 +254,12 @@ def _connection_ipv6_slaac(self): def _connection_ipv6_ping(self): LOGGER.info("Running connection.ipv6_ping") - if self._ipv6_addr is None: + if self._device_ipv6_addr is None: LOGGER.info("No IPv6 SLAAC address found. Cannot ping") return - if self._ping(self._ipv6_addr): - LOGGER.info(f"Device responds to IPv6 ping on {self._ipv6_addr}") + if self._ping(self._device_ipv6_addr): + LOGGER.info(f"Device responds to IPv6 ping on {self._device_ipv6_addr}") return True else: LOGGER.info("Device does not respond to IPv6 ping") @@ -201,3 +269,163 @@ def _ping(self, host): cmd = "ping -c 1 " + str(host) success = util.run_command(cmd, output=False) return success + + def restore_failover_dhcp_server(self, subnet): + # Configure the subnet range + if self._change_subnet(subnet): + if self.enable_failover(): + response = self.dhcp2_client.start_dhcp_server() + if response.code == 200: + LOGGER.info('DHCP server configuration restored') + return True + else: + LOGGER.error('Failed to start secondary DHCP server') + return False + else: + LOGGER.error('Failed to enabled failover in primary DHCP server') + return False + else: + LOGGER.error('Failed to restore original subnet') + return False + + def setup_single_dhcp_server(self): + # Shutdown the secondary DHCP Server + LOGGER.info('Stopping secondary DHCP server') + response = self.dhcp2_client.stop_dhcp_server() + if response.code == 200: + LOGGER.info('Secondary DHCP server stop command success') + time.sleep(3) # Give some time for the server to stop + LOGGER.info('Checking secondary DHCP server status') + response = self.dhcp2_client.get_status() + if response.code == 200: + LOGGER.info('Secondary DHCP server stopped') + return True, 'Single DHCP server configured' + else: + return False, 'DHCP server still running' + else: + return False, 'DHCP server stop command failed' + + # Move primary DHCP server from failover into a single DHCP server config + LOGGER.info('Configuring primary DHCP server') + response = self.dhcp1_client.disable_failover() + if response.code == 200: + LOGGER.info('Primary DHCP server failover disabled') + else: + return False, 'Failed to disable primary DHCP server failover' + + def enable_failover(self): + # Move primary DHCP server to primary failover + LOGGER.info('Configuring primary failover DHCP server') + response = self.dhcp1_client.enable_failover() + if response.code == 200: + LOGGER.info('Primary DHCP server enabled') + return True + else: + LOGGER.error('Failed to disable primary DHCP server failover') + return False + + def is_ip_in_range(self, ip, start_ip, end_ip): + ip_int = int(''.join(format(int(octet), '08b') for octet in ip.split('.')), + 2) + start_int = int( + ''.join(format(int(octet), '08b') for octet in start_ip.split('.')), 2) + end_int = int( + ''.join(format(int(octet), '08b') for octet in end_ip.split('.')), 2) + + return start_int <= ip_int <= end_int + + def _test_subnet(self, subnet, lease): + if self._change_subnet(subnet): + expiration = datetime.strptime(lease['expires'], '%Y-%m-%d %H:%M:%S') + time_to_expire = expiration - datetime.now() + LOGGER.info('Time until lease expiration: ' + str(time_to_expire)) + LOGGER.info('Waiting for current lease to expire: ' + str(expiration)) + if time_to_expire.total_seconds() > 0: + time.sleep(time_to_expire.total_seconds() + + 5) # Wait until the expiration time and padd 5 seconds + LOGGER.info('Current lease expired. Checking for new lease') + for _ in range(5): + LOGGER.info('Checking for new lease') + lease = self._get_cur_lease() + if lease is not None: + LOGGER.info('New Lease found: ' + str(lease)) + LOGGER.info('Validating subnet for new lease...') + in_range = self.is_ip_in_range(lease['ip'], subnet['start'], + subnet['end']) + LOGGER.info('Lease within subnet: ' + str(in_range)) + return in_range + else: + LOGGER.info('New lease not found. Waiting to check again') + time.sleep(5) + + def _wait_for_lease_expire(self, lease): + expiration = datetime.strptime(lease['expires'], '%Y-%m-%d %H:%M:%S') + time_to_expire = expiration - datetime.now() + LOGGER.info('Time until lease expiration: ' + str(time_to_expire)) + LOGGER.info('Waiting for current lease to expire: ' + str(expiration)) + if time_to_expire.total_seconds() > 0: + time.sleep(time_to_expire.total_seconds() + + 5) # Wait until the expiration time and padd 5 seconds + LOGGER.info('Current lease expired.') + + def _change_subnet(self, subnet): + LOGGER.info('Changing subnet to: ' + str(subnet)) + response = self.dhcp1_client.set_dhcp_range(subnet['start'], subnet['end']) + if response.code == 200: + LOGGER.info('Subnet change request accepted. Confirming change...') + response = self.dhcp1_client.get_dhcp_range() + if response.code == 200: + if response.start == subnet['start'] and response.end == subnet['end']: + LOGGER.info('Subnet change confirmed') + return True + LOGGER.error('Failed to confirm subnet change') + else: + LOGGER.error('Subnet change request failed.') + return False + + def _get_cur_lease(self): + LOGGER.info('Checking current device lease') + response = self.dhcp1_client.get_lease(self._device_mac) + if response.code == 200: + lease = eval(response.message) # pylint: disable=W0123 + if lease: # Check if non-empty lease + return lease + else: + return None + + def _is_lease_active(self, lease): + if 'ip' in lease: + ip_addr = lease['ip'] + LOGGER.info('Lease IP Resolved: ' + ip_addr) + LOGGER.info('Attempting to ping device...') + ping_success = self._ping(self._device_ipv4_addr) + LOGGER.info('Ping Success: ' + str(ping_success)) + LOGGER.info('Current lease confirmed active in device') + return ping_success + + def test_subnets(self, subnets): + results = [] + for subnet in subnets: + result = {} + try: + lease = self._get_cur_lease() + if lease is not None: + result = self._test_subnet(subnet, lease) + if result: + result = { + 'result': + True, + 'details': + 'Subnet ' + subnet['start'] + '-' + subnet['end'] + ' passed' + } + else: + result = { + 'result': + False, + 'details': + 'Subnet ' + subnet['start'] + '-' + subnet['end'] + ' failed' + } + except Exception as e: # pylint: disable=W0718 + result = {'result': False, 'details': 'Subnet test failed: ' + str(e)} + results.append(result) + return results diff --git a/testing/test_pylint b/testing/test_pylint index 2ba696af5..3f4063812 100755 --- a/testing/test_pylint +++ b/testing/test_pylint @@ -38,4 +38,4 @@ if (( $new_errors > $ERROR_LIMIT)); then exit 1 fi -exit 0 +exit 0 \ No newline at end of file From 0c550c808e092176e17aa04dd4724f5410e44aa9 Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Thu, 13 Jul 2023 09:17:17 -0600 Subject: [PATCH 050/400] fix windows line ending --- modules/network/dhcp-1/conf/radvd.conf | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/modules/network/dhcp-1/conf/radvd.conf b/modules/network/dhcp-1/conf/radvd.conf index 2f0c75d9d..f6d6f30d9 100644 --- a/modules/network/dhcp-1/conf/radvd.conf +++ b/modules/network/dhcp-1/conf/radvd.conf @@ -1,12 +1,12 @@ -interface veth0 -{ - AdvSendAdvert on; - AdvManagedFlag off; - MinRtrAdvInterval 30; - MaxRtrAdvInterval 60; - prefix fd10:77be:4186::/64 { - AdvOnLink on; - AdvAutonomous on; - AdvRouterAddr on; - }; +interface veth0 +{ + AdvSendAdvert on; + AdvManagedFlag off; + MinRtrAdvInterval 30; + MaxRtrAdvInterval 60; + prefix fd10:77be:4186::/64 { + AdvOnLink on; + AdvAutonomous on; + AdvRouterAddr on; + }; }; \ No newline at end of file From 2df6b4aca96bc689a606669870162c68e64edcb7 Mon Sep 17 00:00:00 2001 From: Jacob Boddey Date: Thu, 13 Jul 2023 16:44:29 +0100 Subject: [PATCH 051/400] Fix python import --- modules/test/base/python/src/test_module.py | 9 +++++---- modules/test/conn/python/src/connection_module.py | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index 2a892b810..b0898aa20 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -58,10 +58,11 @@ def _get_device_tests(self, device_test_module): for test in module_tests: # Resolve device specific configurations for the test if it exists # and update module test config with device config options - if test['name'] in device_test_module['tests']: - dev_test_config = device_test_module['tests'][test['name']] - if 'config' in test: - test['config'].update(dev_test_config) + if 'tests' in device_test_module: + if test['name'] in device_test_module['tests']: + dev_test_config = device_test_module['tests'][test['name']] + if 'config' in test: + test['config'].update(dev_test_config) return module_tests def _get_device_test_module(self): diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 387b19773..5a15a8f83 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -16,7 +16,7 @@ import sys import time from datetime import datetime -from scapy.all import rdpcap, DHCP, Ether, IPv6 +from scapy.all import rdpcap, DHCP, Ether, IPv6, ICMPv6ND_NS from test_module import TestModule from dhcp1.client import Client as DHCPClient1 from dhcp2.client import Client as DHCPClient2 From bfae1e0e9e3775c6bc58bc2ca16e5e83e167f8ad Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Thu, 13 Jul 2023 11:45:04 -0600 Subject: [PATCH 052/400] move isc-dhcp service commands to their own class update logging pylinting --- .../python/src/grpc_server/dhcp_server.py | 71 ++++-------- .../python/src/grpc_server/isc_dhcp_server.py | 108 ++++++++++++++++++ .../python/src/grpc_server/radvd_server.py | 23 ++-- .../python/src/grpc_server/dhcp_server.py | 72 ++++-------- .../python/src/grpc_server/isc_dhcp_server.py | 52 +++++++++ .../python/src/grpc_server/radvd_server.py | 23 ++-- .../test/conn/python/src/connection_module.py | 20 ++-- 7 files changed, 241 insertions(+), 128 deletions(-) create mode 100644 modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py create mode 100644 modules/network/dhcp-2/python/src/grpc_server/isc_dhcp_server.py diff --git a/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py index aa6afb8c1..4955d8eed 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py +++ b/modules/network/dhcp-1/python/src/grpc_server/dhcp_server.py @@ -16,15 +16,13 @@ import sys import time from common import logger -from common import util from dhcp_config import DHCPConfig from radvd_server import RADVDServer +from isc_dhcp_server import ISCDHCPServer -CONFIG_FILE = '/etc/dhcp/dhcpd.conf' LOG_NAME = 'dhcp_server' LOGGER = None - class DHCPServer: """Represents the DHCP Server""" @@ -33,78 +31,57 @@ def __init__(self): LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') self.dhcp_config = DHCPConfig() self.radvd = RADVDServer() + self.isc_dhcp = ISCDHCPServer() self.dhcp_config.resolve_config() def restart(self): - LOGGER.info('Restarting DHCP Server') - isc_started = util.run_command('isc-dhcp-service restart', False) + LOGGER.info('Restarting DHCP server') + isc_started = self.isc_dhcp.restart() radvd_started = self.radvd.restart() started = isc_started and radvd_started - LOGGER.info('DHCP Restarted: ' + str(started)) + LOGGER.info('DHCP server restarted: ' + str(started)) return started def start(self): - LOGGER.info('Starting DHCP Server') - isc_started = util.run_command('isc-dhcp-service start', False) + LOGGER.info('Starting DHCP server') + isc_started = self.isc_dhcp.start() radvd_started = self.radvd.start() started = isc_started and radvd_started - LOGGER.info('DHCP Started: ' + str(started)) + LOGGER.info('DHCP server started: ' + str(started)) return started def stop(self): - LOGGER.info('Stopping DHCP Server') - isc_stopped = util.run_command('isc-dhcp-service stop', False) + LOGGER.info('Stopping DHCP server') + isc_stopped = self.isc_dhcp.stop() radvd_stopped = self.radvd.stop() stopped = isc_stopped and radvd_stopped - LOGGER.info('DHCP Stopped: ' + str(stopped)) + LOGGER.info('DHCP server stopped: ' + str(stopped)) return stopped def is_running(self): - LOGGER.info('Checking DHCP Status') - response = util.run_command('isc-dhcp-service status') - isc_running = response[0] == 'isc-dhcp service is running.' + LOGGER.info('Checking DHCP server status') + isc_running = self.isc_dhcp.is_running() radvd_running = self.radvd.is_running() running = isc_running and radvd_running - LOGGER.info('DHCP Status: ' + str(running)) + LOGGER.info('DHCP server status: ' + str(running)) return running def boot(self): - LOGGER.info('Booting DHCP Server') - isc_booted = False - radvd_booted = False + LOGGER.info('Booting DHCP server') + booted = False if self.is_running(): - LOGGER.info('Stopping isc-dhcp-server') + LOGGER.info('Stopping DHCP server') stopped = self.stop() - LOGGER.info('isc-dhcp-server stopped: ' + str(stopped)) - - if self.radvd.is_running(): - LOGGER.info('Stopping RADVD') - stopped = self.radvd.stop() - LOGGER.info('radvd stopped: ' + str(stopped)) - - LOGGER.info('Starting isc-dhcp-server') + LOGGER.info('DHCP server stopped: ' + str(stopped)) if self.start(): - isc_booted = False # Scan for 5 seconds if not yet ready for _ in range(5): time.sleep(1) - isc_booted = self.is_running() - if isc_booted: + booted = self.is_running() + if booted: break - LOGGER.info('isc-dhcp-server started: ' + str(isc_booted)) - - LOGGER.info('Starting RADVD') - if self.radvd.start(): - radvd_booted = False - # Scan for 5 seconds if not yet ready - for _ in range(5): - time.sleep(1) - radvd_booted = self.radvd.is_running() - if radvd_booted: - break - LOGGER.info('RADVD started: ' + str(radvd_booted)) - - return isc_booted and radvd_booted + LOGGER.info('DHCP server booted: ' + str(booted)) + return booted def run(): @@ -112,7 +89,7 @@ def run(): booted = dhcp_server.boot() if not booted: - LOGGER.error('DHCP Server Failed to boot. Exiting') + LOGGER.error('DHCP server failed to boot. Exiting') sys.exit(1) config = str(dhcp_server.dhcp_config) @@ -120,7 +97,7 @@ def run(): dhcp_server.dhcp_config.resolve_config() new_config = str(dhcp_server.dhcp_config) if config != new_config: - LOGGER.info('DHCP Config Changed') + LOGGER.info('DHCP server config changed') config = new_config dhcp_server.restart() dhcp_server.radvd.restart() diff --git a/modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py b/modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py new file mode 100644 index 000000000..4955d8eed --- /dev/null +++ b/modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py @@ -0,0 +1,108 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +DHCP server""" +import sys +import time +from common import logger +from dhcp_config import DHCPConfig +from radvd_server import RADVDServer +from isc_dhcp_server import ISCDHCPServer + +LOG_NAME = 'dhcp_server' +LOGGER = None + +class DHCPServer: + """Represents the DHCP Server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') + self.dhcp_config = DHCPConfig() + self.radvd = RADVDServer() + self.isc_dhcp = ISCDHCPServer() + self.dhcp_config.resolve_config() + + def restart(self): + LOGGER.info('Restarting DHCP server') + isc_started = self.isc_dhcp.restart() + radvd_started = self.radvd.restart() + started = isc_started and radvd_started + LOGGER.info('DHCP server restarted: ' + str(started)) + return started + + def start(self): + LOGGER.info('Starting DHCP server') + isc_started = self.isc_dhcp.start() + radvd_started = self.radvd.start() + started = isc_started and radvd_started + LOGGER.info('DHCP server started: ' + str(started)) + return started + + def stop(self): + LOGGER.info('Stopping DHCP server') + isc_stopped = self.isc_dhcp.stop() + radvd_stopped = self.radvd.stop() + stopped = isc_stopped and radvd_stopped + LOGGER.info('DHCP server stopped: ' + str(stopped)) + return stopped + + def is_running(self): + LOGGER.info('Checking DHCP server status') + isc_running = self.isc_dhcp.is_running() + radvd_running = self.radvd.is_running() + running = isc_running and radvd_running + LOGGER.info('DHCP server status: ' + str(running)) + return running + + def boot(self): + LOGGER.info('Booting DHCP server') + booted = False + if self.is_running(): + LOGGER.info('Stopping DHCP server') + stopped = self.stop() + LOGGER.info('DHCP server stopped: ' + str(stopped)) + if self.start(): + # Scan for 5 seconds if not yet ready + for _ in range(5): + time.sleep(1) + booted = self.is_running() + if booted: + break + LOGGER.info('DHCP server booted: ' + str(booted)) + return booted + + +def run(): + dhcp_server = DHCPServer() + booted = dhcp_server.boot() + + if not booted: + LOGGER.error('DHCP server failed to boot. Exiting') + sys.exit(1) + + config = str(dhcp_server.dhcp_config) + while True: + dhcp_server.dhcp_config.resolve_config() + new_config = str(dhcp_server.dhcp_config) + if config != new_config: + LOGGER.info('DHCP server config changed') + config = new_config + dhcp_server.restart() + dhcp_server.radvd.restart() + time.sleep(1) + + +if __name__ == '__main__': + run() diff --git a/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py b/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py index 8bb1d0539..38eec4985 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py +++ b/modules/network/dhcp-1/python/src/grpc_server/radvd_server.py @@ -12,15 +12,13 @@ # See the License for the specific language governing permissions and # limitations under the License. """Contains all the necessary classes to maintain the -DHCP server""" +RADVD server booted from the radvd-service file""" from common import logger from common import util -CONFIG_FILE = '/etc/dhcp/dhcpd.conf' LOG_NAME = 'radvd' LOGGER = None - class RADVDServer: """Represents the RADVD Server""" @@ -29,25 +27,26 @@ def __init__(self): LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') def restart(self): - LOGGER.info('Restarting RADVD Server') + LOGGER.info('Restarting RADVD server') response = util.run_command('radvd-service restart', False) - LOGGER.info('RADVD Restarted: ' + str(response)) + LOGGER.info('RADVD restarted: ' + str(response)) return response def start(self): - LOGGER.info('Starting RADVD Server') + LOGGER.info('Starting RADVD server') response = util.run_command('radvd-service start', False) - LOGGER.info('RADVD Started: ' + str(response)) + LOGGER.info('RADVD started: ' + str(response)) return response def stop(self): - LOGGER.info('Stopping RADVD Server') + LOGGER.info('Stopping RADVD server') response = util.run_command('radvd-service stop', False) - LOGGER.info('RADVD Stopped: ' + str(response)) + LOGGER.info('RADVD stopped: ' + str(response)) return response def is_running(self): - LOGGER.info('Checking RADVD Status') + LOGGER.info('Checking RADVD status') response = util.run_command('radvd-service status') - LOGGER.info('RADVD Status: ' + str(response)) - return response[0] == 'radvd service is running.' + running = response[0] == 'radvd service is running.' + LOGGER.info('RADVD status: ' + str(running)) + return running diff --git a/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py index 270a2c700..199e26b79 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py +++ b/modules/network/dhcp-2/python/src/grpc_server/dhcp_server.py @@ -16,15 +16,13 @@ import sys import time from common import logger -from common import util from dhcp_config import DHCPConfig from radvd_server import RADVDServer +from isc_dhcp_server import ISCDHCPServer -CONFIG_FILE = '/etc/dhcp/dhcpd.conf' LOG_NAME = 'dhcp_server' LOGGER = None - class DHCPServer: """Represents the DHCP Server""" @@ -33,78 +31,57 @@ def __init__(self): LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') self.dhcp_config = DHCPConfig() self.radvd = RADVDServer() + self.isc_dhcp = ISCDHCPServer() self.dhcp_config.resolve_config() def restart(self): - LOGGER.info('Restarting DHCP Server') - isc_started = util.run_command('isc-dhcp-service restart', False) + LOGGER.info('Restarting DHCP server') + isc_started = self.isc_dhcp.restart() radvd_started = self.radvd.restart() started = isc_started and radvd_started - LOGGER.info('DHCP Restarted: ' + str(started)) + LOGGER.info('DHCP server restarted: ' + str(started)) return started def start(self): - LOGGER.info('Starting DHCP Server') - isc_started = util.run_command('isc-dhcp-service start', False) + LOGGER.info('Starting DHCP server') + isc_started = self.isc_dhcp.start() radvd_started = self.radvd.start() started = isc_started and radvd_started - LOGGER.info('DHCP Started: ' + str(started)) + LOGGER.info('DHCP server started: ' + str(started)) return started def stop(self): - LOGGER.info('Stopping DHCP Server') - isc_stopped = util.run_command('isc-dhcp-service stop', False) + LOGGER.info('Stopping DHCP server') + isc_stopped = self.isc_dhcp.stop() radvd_stopped = self.radvd.stop() stopped = isc_stopped and radvd_stopped - LOGGER.info('DHCP Stopped: ' + str(stopped)) + LOGGER.info('DHCP server stopped: ' + str(stopped)) return stopped def is_running(self): - LOGGER.info('Checking DHCP Status') - response = util.run_command('isc-dhcp-service status') - isc_running = response[0] == 'isc-dhcp service is running.' + LOGGER.info('Checking DHCP server status') + isc_running = self.isc_dhcp.is_running() radvd_running = self.radvd.is_running() running = isc_running and radvd_running - LOGGER.info('DHCP Status: ' + str(running)) + LOGGER.info('DHCP server status: ' + str(running)) return running def boot(self): - LOGGER.info('Booting DHCP Server') - isc_booted = False - radvd_booted = False + LOGGER.info('Booting DHCP server') + booted = False if self.is_running(): - LOGGER.info('Stopping isc-dhcp-server') + LOGGER.info('Stopping DHCP server') stopped = self.stop() - LOGGER.info('isc-dhcp-server stopped: ' + str(stopped)) - - if self.radvd.is_running(): - LOGGER.info('Stopping RADVD') - stopped = self.radvd.stop() - LOGGER.info('radvd stopped: ' + str(stopped)) - - LOGGER.info('Starting isc-dhcp-server') + LOGGER.info('DHCP server stopped: ' + str(stopped)) if self.start(): - isc_booted = False - # Scan for 5 seconds if not yet ready - for _ in range(5): - time.sleep(1) - isc_booted = self.is_running() - if isc_booted: - break - LOGGER.info('isc-dhcp-server started: ' + str(isc_booted)) - - LOGGER.info('Starting RADVD') - if self.radvd.start(): - radvd_booted = False # Scan for 5 seconds if not yet ready for _ in range(5): time.sleep(1) - radvd_booted = self.radvd.is_running() - if radvd_booted: + booted = self.is_running() + if booted: break - LOGGER.info('RADVD started: ' + str(radvd_booted)) - - return isc_booted and radvd_booted + LOGGER.info('DHCP server booted: ' + str(booted)) + return booted def run(): @@ -112,7 +89,7 @@ def run(): booted = dhcp_server.boot() if not booted: - LOGGER.error('DHCP Server Failed to boot. Exiting') + LOGGER.error('DHCP server failed to boot. Exiting') sys.exit(1) config = str(dhcp_server.dhcp_config) @@ -120,11 +97,12 @@ def run(): dhcp_server.dhcp_config.resolve_config() new_config = str(dhcp_server.dhcp_config) if config != new_config: - LOGGER.info('DHCP Config Changed') + LOGGER.info('DHCP server config changed') config = new_config dhcp_server.restart() dhcp_server.radvd.restart() time.sleep(1) + if __name__ == '__main__': run() diff --git a/modules/network/dhcp-2/python/src/grpc_server/isc_dhcp_server.py b/modules/network/dhcp-2/python/src/grpc_server/isc_dhcp_server.py new file mode 100644 index 000000000..429c06da0 --- /dev/null +++ b/modules/network/dhcp-2/python/src/grpc_server/isc_dhcp_server.py @@ -0,0 +1,52 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Contains all the necessary classes to maintain the +isc-dhcp server booted from the isc-dhcp service file""" +from common import logger +from common import util + +LOG_NAME = 'isc-dhcp' +LOGGER = None + +class ISCDHCPServer: + """Represents the isc-dhcp server""" + + def __init__(self): + global LOGGER + LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') + + def restart(self): + LOGGER.info('Restarting isc-dhcp server') + response = util.run_command('isc-dhcp-service restart', False) + LOGGER.info('isc-dhcp server restarted: ' + str(response)) + return response + + def start(self): + LOGGER.info('Starting isc-dhcp server') + response = util.run_command('isc-dhcp-service start', False) + LOGGER.info('isc-dhcp server started: ' + str(response)) + return response + + def stop(self): + LOGGER.info('Stopping isc-dhcp server') + response = util.run_command('isc-dhcp-service stop', False) + LOGGER.info('isc-dhcp server stopped: ' + str(response)) + return response + + def is_running(self): + LOGGER.info('Checking isc-dhcp server') + response = util.run_command('isc-dhcp-service status') + running = response[0] == 'isc-dhcp service is running.' + LOGGER.info('isc-dhcp server status: ' + str(running)) + return running diff --git a/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py b/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py index bc5d8b55f..910354e31 100644 --- a/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py +++ b/modules/network/dhcp-2/python/src/grpc_server/radvd_server.py @@ -12,15 +12,13 @@ # See the License for the specific language governing permissions and # limitations under the License. """Contains all the necessary classes to maintain the -DHCP server""" +RADVD server booted from the radvd-service file""" from common import logger from common import util -CONFIG_FILE = '/etc/dhcp/dhcpd.conf' LOG_NAME = 'radvd' LOGGER = None - class RADVDServer: """Represents the RADVD Server""" @@ -29,25 +27,26 @@ def __init__(self): LOGGER = logger.get_logger(LOG_NAME, 'dhcp-2') def restart(self): - LOGGER.info('Restarting RADVD Server') + LOGGER.info('Restarting RADVD server') response = util.run_command('radvd-service restart', False) - LOGGER.info('RADVD Restarted: ' + str(response)) + LOGGER.info('RADVD restarted: ' + str(response)) return response def start(self): - LOGGER.info('Starting RADVD Server') + LOGGER.info('Starting RADVD server') response = util.run_command('radvd-service start', False) - LOGGER.info('RADVD Started: ' + str(response)) + LOGGER.info('RADVD started: ' + str(response)) return response def stop(self): - LOGGER.info('Stopping RADVD Server') + LOGGER.info('Stopping RADVD server') response = util.run_command('radvd-service stop', False) - LOGGER.info('RADVD Stopped: ' + str(response)) + LOGGER.info('RADVD stopped: ' + str(response)) return response def is_running(self): - LOGGER.info('Checking RADVD Status') + LOGGER.info('Checking RADVD status') response = util.run_command('radvd-service status') - LOGGER.info('RADVD Status: ' + str(response)) - return response[0] == 'radvd service is running.' + running = response[0] == 'radvd service is running.' + LOGGER.info('RADVD status: ' + str(running)) + return running diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 5a15a8f83..87b7c2d18 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -27,7 +27,7 @@ DHCP_SERVER_CAPTURE_FILE = '/runtime/network/dhcp-1.pcap' STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' -SLAAC_PREFIX = "fd10:77be:4186" +SLAAC_PREFIX = 'fd10:77be:4186' class ConnectionModule(TestModule): @@ -230,7 +230,7 @@ def _get_oui_manufacturer(self, mac_address): return None def _connection_ipv6_slaac(self): - LOGGER.info("Running connection.ipv6_slaac") + LOGGER.info('Running connection.ipv6_slaac') packet_capture = rdpcap(MONITOR_CAPTURE_FILE) sends_ipv6 = False @@ -242,31 +242,31 @@ def _connection_ipv6_slaac(self): ipv6_addr = str(packet[ICMPv6ND_NS].tgt) if ipv6_addr.startswith(SLAAC_PREFIX): self._device_ipv6_addr = ipv6_addr - LOGGER.info(f"Device has formed SLAAC address {ipv6_addr}") + LOGGER.info(f'Device has formed SLAAC address {ipv6_addr}') return True if sends_ipv6: - LOGGER.info("Device does not support IPv6 SLAAC") + LOGGER.info('Device does not support IPv6 SLAAC') else: - LOGGER.info("Device does not support IPv6") + LOGGER.info('Device does not support IPv6') return False def _connection_ipv6_ping(self): - LOGGER.info("Running connection.ipv6_ping") + LOGGER.info('Running connection.ipv6_ping') if self._device_ipv6_addr is None: - LOGGER.info("No IPv6 SLAAC address found. Cannot ping") + LOGGER.info('No IPv6 SLAAC address found. Cannot ping') return if self._ping(self._device_ipv6_addr): - LOGGER.info(f"Device responds to IPv6 ping on {self._device_ipv6_addr}") + LOGGER.info(f'Device responds to IPv6 ping on {self._device_ipv6_addr}') return True else: - LOGGER.info("Device does not respond to IPv6 ping") + LOGGER.info('Device does not respond to IPv6 ping') return False def _ping(self, host): - cmd = "ping -c 1 " + str(host) + cmd = 'ping -c 1 ' + str(host) success = util.run_command(cmd, output=False) return success From 4bdacf34f1d307cb29955ca3711e7ee6cfcbc813 Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Thu, 13 Jul 2023 11:51:34 -0600 Subject: [PATCH 053/400] fix dhcp1 --- .../python/src/grpc_server/isc_dhcp_server.py | 98 ++++--------------- 1 file changed, 21 insertions(+), 77 deletions(-) diff --git a/modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py b/modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py index 4955d8eed..1a0e34186 100644 --- a/modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py +++ b/modules/network/dhcp-1/python/src/grpc_server/isc_dhcp_server.py @@ -12,97 +12,41 @@ # See the License for the specific language governing permissions and # limitations under the License. """Contains all the necessary classes to maintain the -DHCP server""" -import sys -import time +isc-dhcp server booted from the isc-dhcp service file""" from common import logger -from dhcp_config import DHCPConfig -from radvd_server import RADVDServer -from isc_dhcp_server import ISCDHCPServer +from common import util -LOG_NAME = 'dhcp_server' +LOG_NAME = 'isc-dhcp' LOGGER = None -class DHCPServer: - """Represents the DHCP Server""" +class ISCDHCPServer: + """Represents the isc-dhcp server""" def __init__(self): global LOGGER LOGGER = logger.get_logger(LOG_NAME, 'dhcp-1') - self.dhcp_config = DHCPConfig() - self.radvd = RADVDServer() - self.isc_dhcp = ISCDHCPServer() - self.dhcp_config.resolve_config() def restart(self): - LOGGER.info('Restarting DHCP server') - isc_started = self.isc_dhcp.restart() - radvd_started = self.radvd.restart() - started = isc_started and radvd_started - LOGGER.info('DHCP server restarted: ' + str(started)) - return started + LOGGER.info('Restarting isc-dhcp server') + response = util.run_command('isc-dhcp-service restart', False) + LOGGER.info('isc-dhcp server restarted: ' + str(response)) + return response def start(self): - LOGGER.info('Starting DHCP server') - isc_started = self.isc_dhcp.start() - radvd_started = self.radvd.start() - started = isc_started and radvd_started - LOGGER.info('DHCP server started: ' + str(started)) - return started + LOGGER.info('Starting isc-dhcp server') + response = util.run_command('isc-dhcp-service start', False) + LOGGER.info('isc-dhcp server started: ' + str(response)) + return response def stop(self): - LOGGER.info('Stopping DHCP server') - isc_stopped = self.isc_dhcp.stop() - radvd_stopped = self.radvd.stop() - stopped = isc_stopped and radvd_stopped - LOGGER.info('DHCP server stopped: ' + str(stopped)) - return stopped + LOGGER.info('Stopping isc-dhcp server') + response = util.run_command('isc-dhcp-service stop', False) + LOGGER.info('isc-dhcp server stopped: ' + str(response)) + return response def is_running(self): - LOGGER.info('Checking DHCP server status') - isc_running = self.isc_dhcp.is_running() - radvd_running = self.radvd.is_running() - running = isc_running and radvd_running - LOGGER.info('DHCP server status: ' + str(running)) + LOGGER.info('Checking isc-dhcp server') + response = util.run_command('isc-dhcp-service status') + running = response[0] == 'isc-dhcp service is running.' + LOGGER.info('isc-dhcp server status: ' + str(running)) return running - - def boot(self): - LOGGER.info('Booting DHCP server') - booted = False - if self.is_running(): - LOGGER.info('Stopping DHCP server') - stopped = self.stop() - LOGGER.info('DHCP server stopped: ' + str(stopped)) - if self.start(): - # Scan for 5 seconds if not yet ready - for _ in range(5): - time.sleep(1) - booted = self.is_running() - if booted: - break - LOGGER.info('DHCP server booted: ' + str(booted)) - return booted - - -def run(): - dhcp_server = DHCPServer() - booted = dhcp_server.boot() - - if not booted: - LOGGER.error('DHCP server failed to boot. Exiting') - sys.exit(1) - - config = str(dhcp_server.dhcp_config) - while True: - dhcp_server.dhcp_config.resolve_config() - new_config = str(dhcp_server.dhcp_config) - if config != new_config: - LOGGER.info('DHCP server config changed') - config = new_config - dhcp_server.restart() - dhcp_server.radvd.restart() - time.sleep(1) - - -if __name__ == '__main__': - run() From d37665583c71e12a3740934e34deac4f28561218 Mon Sep 17 00:00:00 2001 From: Noureddine Date: Fri, 14 Jul 2023 09:51:17 +0000 Subject: [PATCH 054/400] Initial CI testing for tests (#72) --- .github/workflows/testing.yml | 18 +- testing/docker/ci_test_device1/Dockerfile | 11 + testing/docker/ci_test_device1/entrypoint.sh | 91 +++++++ testing/example/mac | 0 testing/example/mac1/results.json | 252 +++++++++++++++++++ testing/test_baseline | 4 +- testing/test_baseline.py | 13 +- testing/test_pylint | 2 +- testing/test_tests | 120 +++++++++ testing/test_tests.json | 19 ++ testing/test_tests.py | 102 ++++++++ 11 files changed, 620 insertions(+), 12 deletions(-) create mode 100644 testing/docker/ci_test_device1/Dockerfile create mode 100755 testing/docker/ci_test_device1/entrypoint.sh create mode 100644 testing/example/mac create mode 100644 testing/example/mac1/results.json create mode 100755 testing/test_tests create mode 100644 testing/test_tests.json create mode 100644 testing/test_tests.py diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index fbdbe442c..c981dbd56 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -7,7 +7,7 @@ on: - cron: '0 13 * * *' jobs: - testrun: + testrun_baseline: name: Baseline runs-on: ubuntu-20.04 timeout-minutes: 20 @@ -17,11 +17,21 @@ jobs: - name: Run tests shell: bash {0} run: testing/test_baseline - + + testrun_tests: + name: Tests + runs-on: ubuntu-20.04 + timeout-minutes: 40 + steps: + - name: Checkout source + uses: actions/checkout@v2.3.4 + - name: Run tests + shell: bash {0} + run: testing/test_tests pylint: name: Pylint - runs-on: ubuntu-20.04 - timeout-minutes: 20 + runs-on: ubuntu-22.04 + timeout-minutes: 5 steps: - name: Checkout source uses: actions/checkout@v2.3.4 diff --git a/testing/docker/ci_test_device1/Dockerfile b/testing/docker/ci_test_device1/Dockerfile new file mode 100644 index 000000000..0bb697509 --- /dev/null +++ b/testing/docker/ci_test_device1/Dockerfile @@ -0,0 +1,11 @@ + +FROM ubuntu:jammy + +#Update and get all additional requirements not contained in the base image +RUN apt-get update && apt-get -y upgrade + +RUN apt-get update && apt-get install -y isc-dhcp-client ntpdate coreutils moreutils inetutils-ping curl jq dnsutils openssl netcat-openbsd + +COPY entrypoint.sh /entrypoint.sh + +ENTRYPOINT ["/entrypoint.sh"] \ No newline at end of file diff --git a/testing/docker/ci_test_device1/entrypoint.sh b/testing/docker/ci_test_device1/entrypoint.sh new file mode 100755 index 000000000..8113704be --- /dev/null +++ b/testing/docker/ci_test_device1/entrypoint.sh @@ -0,0 +1,91 @@ +#!/bin/bash + +ip a + +declare -A options +for option in $*; do + if [[ $option == *"="* ]]; then + k=$(echo $option | cut -d'=' -f1) + v=$(echo $option | cut -d'=' -f2) + options[$k]=$v + else + options[$option]=$option + fi +done + +OUT=/out/testrun_ci.json + +NTP_SERVER=10.10.10.5 +DNS_SERVER=10.10.10.4 + +function wout(){ + temp=${1//./\".\"} + key=${temp:1}\" + echo $key + value=$2 + jq "$key+=\"$value\"" $OUT | sponge $OUT +} + + +dig @8.8.8.8 +short www.google.com + +# DHCP +ip addr flush dev eth0 +PID_FILE=/var/run/dhclient.pid +if [ -f $PID_FILE ]; then + kill -9 $(cat $PID_FILE) || true + rm -f $PID_FILE +fi +dhclient -v eth0 + + +if [ -n "${options[oddservices]}" ]; then + echo Running services on non standard ports and open default ports + + echo Starting FTP 21514 and open default 20,21 + nc -nvlt -p 20 & + nc -nvlt -p 21 & + (while true; do echo -e "220 ProFTPD 1.3.5e Server (Debian) $(hostname)" | nc -l -w 1 21514; done) & + + echo Starting SMTP 1256 and open default 25, 465, 587 + nc -nvlt -p 25 & + nc -nvlt -p 465 & + nc -nvlt -p 587 & + (while true; do echo -e "220 $(hostname) ESMTP Postfix (Ubuntu)" | nc -l -w 1 1256; done) & + + echo Starting IMAP 5361 and open default ports 143, 993 + nc -nvlt -p 143 & + nc -nvlt -p 993 & + (while true; do echo -e "* OK [CAPABILITY IMAP4rev1 LITERAL+ SASL-IR LOGIN-REFERRALS ID ENABLE IDLE STARTTLS AUTH=PLAIN] Dovecot (Ubuntu) ready.\r\n" \ + | nc -l -w 1 5361; done) & + + echo Starting POP3 23451 and open default 110, 995 + nc -nvlt -p 110 & + nc -nvlt -p 995 & + (while true; do echo -ne "+OK POP3 Server ready\r\n" | nc -l -w 1 23451; done) & + + echo starting TFTP UDP 69 + (while true; do echo -ne "\0\x05\0\0\x07\0" | nc -u -l -w 1 69; done) & + +fi + +if [ -n "${options[snmp]}" ]; then + echo starting mock none snmpv3 on port UDP 161 + (while true; do echo -ne " \x02\x01\ " | nc -u -l -w 1 161; done) & +fi + +if [ -n "${options[snmpv3]}" ]; then + echo starting mock SNMPv3 UDP 161 + (while true; do echo -ne " \x02\x01\x030 \x02\x02Ji\x02 \x04\x01 \x02\x01\x03\x04" | nc -u -l -w 1 161; done) & +fi + +if [ -n "${options[ssh]}" ]; then + echo Starting SSH server + /usr/local/sbin/sshd +elif [ -n "${options[sshv1]}" ]; then + echo Starting SSHv1 server + echo 'Protocol 1' >> /usr/local/etc/sshd_config + /usr/local/sbin/sshd +fi + +tail -f /dev/null \ No newline at end of file diff --git a/testing/example/mac b/testing/example/mac new file mode 100644 index 000000000..e69de29bb diff --git a/testing/example/mac1/results.json b/testing/example/mac1/results.json new file mode 100644 index 000000000..e1b837225 --- /dev/null +++ b/testing/example/mac1/results.json @@ -0,0 +1,252 @@ +{ + "device": { + "mac_addr": "7e:41:12:d2:35:6a" + }, + "dns": { + "results": [ + { + "name": "dns.network.from_device", + "description": "Verify the device sends DNS requests", + "expected_behavior": "The device sends DNS requests.", + "start": "2023-07-03T13:35:48.990574", + "result": "compliant", + "end": "2023-07-03T13:35:49.035528", + "duration": "0:00:00.044954" + }, + { + "name": "dns.network.from_dhcp", + "description": "Verify the device allows for a DNS server to be entered automatically", + "expected_behavior": "The device sends DNS requests to the DNS server provided by the DHCP server", + "start": "2023-07-03T13:35:49.035701", + "result": "non-compliant", + "end": "2023-07-03T13:35:49.041532", + "duration": "0:00:00.005831" + }, + { + "name": "dns.mdns", + "description": "If the device has MDNS (or any kind of IP multicast), can it be disabled", + "start": "2023-07-03T13:35:49.041679", + "result": "non-compliant", + "end": "2023-07-03T13:35:49.057430", + "duration": "0:00:00.015751" + } + ] + }, + "nmap": { + "results": [ + { + "name": "security.nmap.ports", + "description": "Run an nmap scan of open ports", + "expected_behavior": "Report all open ports", + "config": { + "security.services.ftp": { + "tcp_ports": { + "20": { + "allowed": false, + "description": "File Transfer Protocol (FTP) Server Data Transfer", + "result": "compliant" + }, + "21": { + "allowed": false, + "description": "File Transfer Protocol (FTP) Server Data Transfer", + "result": "compliant" + } + }, + "description": "Check FTP port 20/21 is disabled and FTP is not running on any port", + "expected_behavior": "There is no FTP service running on any port" + }, + "security.services.ssh": { + "tcp_ports": { + "22": { + "allowed": true, + "description": "Secure Shell (SSH) server", + "version": "2.0", + "result": "compliant" + } + }, + "description": "Check TELNET port 23 is disabled and TELNET is not running on any port", + "expected_behavior": "There is no FTP service running on any port" + }, + "security.services.telnet": { + "tcp_ports": { + "23": { + "allowed": false, + "description": "Telnet Server", + "result": "compliant" + } + }, + "description": "Check TELNET port 23 is disabled and TELNET is not running on any port", + "expected_behavior": "There is no FTP service running on any port" + }, + "security.services.smtp": { + "tcp_ports": { + "25": { + "allowed": false, + "description": "Simple Mail Transfer Protocol (SMTP) Server", + "result": "compliant" + }, + "465": { + "allowed": false, + "description": "Simple Mail Transfer Protocol over SSL (SMTPS) Server", + "result": "compliant" + }, + "587": { + "allowed": false, + "description": "Simple Mail Transfer Protocol via TLS (SMTPS) Server", + "result": "compliant" + } + }, + "description": "Check SMTP port 25 is disabled and ports 465 or 587 with SSL encryption are (not?) enabled and SMTP is not running on any port.", + "expected_behavior": "There is no smtp service running on any port" + }, + "security.services.http": { + "tcp_ports": { + "80": { + "service_scan": { + "script": "http-methods" + }, + "allowed": false, + "description": "Administrative Insecure Web-Server", + "result": "compliant" + } + }, + "description": "Check that there is no HTTP server running on any port", + "expected_behavior": "Device is unreachable on port 80 (or any other port) and only responds to HTTPS requests on port 443 (or any other port if HTTP is used at all)" + }, + "security.services.pop": { + "tcp_ports": { + "110": { + "allowed": false, + "description": "Post Office Protocol v3 (POP3) Server", + "result": "compliant" + } + }, + "description": "Check POP port 110 is disalbed and POP is not running on any port", + "expected_behavior": "There is no pop service running on any port" + }, + "security.services.imap": { + "tcp_ports": { + "143": { + "allowed": false, + "description": "Internet Message Access Protocol (IMAP) Server", + "result": "compliant" + } + }, + "description": "Check IMAP port 143 is disabled and IMAP is not running on any port", + "expected_behavior": "There is no imap service running on any port" + }, + "security.services.snmpv3": { + "tcp_ports": { + "161": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP)", + "result": "compliant" + }, + "162": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP) Trap", + "result": "compliant" + } + }, + "udp_ports": { + "161": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP)" + }, + "162": { + "allowed": false, + "description": "Simple Network Management Protocol (SNMP) Trap" + } + }, + "description": "Check SNMP port 161/162 is disabled. If SNMP is an essential service, check it supports version 3", + "expected_behavior": "Device is unreachable on port 161 (or any other port) and device is unreachable on port 162 (or any other port) unless SNMP is essential in which case it is SNMPv3 is used." + }, + "security.services.https": { + "tcp_ports": { + "80": { + "allowed": false, + "description": "Administrative Secure Web-Server", + "result": "compliant" + } + }, + "description": "Check that if there is a web server running it is running on a secure port.", + "expected_behavior": "Device only responds to HTTPS requests on port 443 (or any other port if HTTP is used at all)" + }, + "security.services.vnc": { + "tcp_ports": { + "5800": { + "allowed": false, + "description": "Virtual Network Computing (VNC) Remote Frame Buffer Protocol Over HTTP", + "result": "compliant" + }, + "5500": { + "allowed": false, + "description": "Virtual Network Computing (VNC) Remote Frame Buffer Protocol", + "result": "compliant" + } + }, + "description": "Check VNC is disabled on any port", + "expected_behavior": "Device cannot be accessed /connected to via VNc on any port" + }, + "security.services.tftp": { + "udp_ports": { + "69": { + "allowed": false, + "description": "Trivial File Transfer Protocol (TFTP) Server", + "result": "compliant" + } + }, + "description": "Check TFTP port 69 is disabled (UDP)", + "expected_behavior": "There is no tftp service running on any port" + }, + "security.services.ntp": { + "udp_ports": { + "123": { + "allowed": false, + "description": "Network Time Protocol (NTP) Server", + "result": "compliant" + } + }, + "description": "Check NTP port 123 is disabled and the device is not operating as an NTP server", + "expected_behavior": "The device dos not respond to NTP requests when it's IP is set as the NTP server on another device" + } + }, + "start": "2023-07-03T13:36:26.923704", + "result": "compliant", + "end": "2023-07-03T13:36:52.965535", + "duration": "0:00:26.041831" + } + ] + }, + "baseline": { + "results": [ + { + "name": "baseline.pass", + "description": "Simulate a compliant test", + "expected_behavior": "A compliant test result is generated", + "start": "2023-07-03T13:37:29.100681", + "result": "compliant", + "end": "2023-07-03T13:37:29.100869", + "duration": "0:00:00.000188" + }, + { + "name": "baseline.fail", + "description": "Simulate a non-compliant test", + "expected_behavior": "A non-compliant test result is generated", + "start": "2023-07-03T13:37:29.100961", + "result": "non-compliant", + "end": "2023-07-03T13:37:29.101089", + "duration": "0:00:00.000128" + }, + { + "name": "baseline.skip", + "description": "Simulate a skipped test", + "expected_behavior": "A skipped test result is generated", + "start": "2023-07-03T13:37:29.101164", + "result": "skipped", + "end": "2023-07-03T13:37:29.101283", + "duration": "0:00:00.000119" + } + ] + } + } \ No newline at end of file diff --git a/testing/test_baseline b/testing/test_baseline index f12d124de..2b95ded23 100755 --- a/testing/test_baseline +++ b/testing/test_baseline @@ -20,7 +20,7 @@ ifconfig # Setup requirements sudo apt-get update -sudo apt-get install openvswitch-common openvswitch-switch tcpdump jq moreutils coreutils +sudo apt-get install openvswitch-common openvswitch-switch tcpdump jq moreutils coreutils isc-dhcp-client pip3 install pytest @@ -80,6 +80,6 @@ echo "Done baseline test" more $TESTRUN_OUT -pytest testing/ +pytest testing/test_baseline.py exit $? \ No newline at end of file diff --git a/testing/test_baseline.py b/testing/test_baseline.py index 246857581..520f909f7 100644 --- a/testing/test_baseline.py +++ b/testing/test_baseline.py @@ -12,6 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +""" Test assertions for CI network baseline test """ +# Temporarily disabled because using Pytest fixtures +# TODO refactor fixtures to not trigger error +# pylint: disable=redefined-outer-name + import json import pytest import re @@ -24,14 +29,13 @@ @pytest.fixture def container_data(): - dir = os.path.dirname(os.path.abspath(__file__)) with open(CI_BASELINE_OUT, encoding='utf-8') as f: return json.load(f) @pytest.fixture def validator_results(): - dir = os.path.dirname(os.path.abspath(__file__)) - with open(os.path.join(dir, + basedir = os.path.dirname(os.path.abspath(__file__)) + with open(os.path.join(basedir, '../', 'runtime/validation/faux-dev/result.json'), encoding='utf-8') as f: @@ -63,6 +67,5 @@ def test_dns_server_resolves(container_data): @pytest.mark.skip(reason='requires internet') def test_validator_results_compliant(validator_results): - results = [True if x['result'] == 'compliant' else False - for x in validator_results['results']] + results = [x['result'] == 'compliant' for x in validator_results['results']] assert all(results) diff --git a/testing/test_pylint b/testing/test_pylint index 3f4063812..3f4d8a3ed 100755 --- a/testing/test_pylint +++ b/testing/test_pylint @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -ERROR_LIMIT=100 +ERROR_LIMIT=175 sudo cmd/install diff --git a/testing/test_tests b/testing/test_tests new file mode 100755 index 000000000..6ba9fef94 --- /dev/null +++ b/testing/test_tests @@ -0,0 +1,120 @@ +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +set -o xtrace +ip a +TEST_DIR=/tmp/results +MATRIX=testing/test_tests.json + +mkdir -p $TEST_DIR + +# Setup requirements +sudo apt-get update +sudo apt-get install openvswitch-common openvswitch-switch tcpdump jq moreutils coreutils isc-dhcp-client + +pip3 install pytest + +# Start OVS +# Setup device network +sudo ip link add dev endev0a type veth peer name endev0b +sudo ip link set dev endev0a up +sudo ip link set dev endev0b up +sudo docker network create -d macvlan -o parent=endev0b endev1 + +sudo /usr/share/openvswitch/scripts/ovs-ctl start + +# Build Test Container +sudo docker build ./testing/docker/ci_test_device1 -t ci_test_device1 -f ./testing/docker/ci_test_device1/Dockerfile + +cat <local/system.json +{ + "network": { + "device_intf": "endev0a", + "internet_intf": "eth0" + }, + "log_level": "DEBUG", + "monitor_period": 30 +} +EOF + +sudo cmd/install + +TESTERS=$(jq -r 'keys[]' $MATRIX) +for tester in $TESTERS; do + testrun_log=$TEST_DIR/${tester}_testrun.log + device_log=$TEST_DIR/${tester}_device.log + + image=$(jq -r .$tester.image $MATRIX) + ethmac=$(jq -r .$tester.ethmac $MATRIX) + args=$(jq -r .$tester.args $MATRIX) + + touch $testrun_log + sudo timeout 900 cmd/start --single-intf > $testrun_log 2>&1 & + TPID=$! + + # Time to wait for testrun to be ready + WAITING=600 + for i in `seq 1 $WAITING`; do + tail -1 $testrun_log + if [[ -n $(fgrep "Waiting for devices on the network" $testrun_log) ]]; then + break + fi + + if [[ ! -d /proc/$TPID ]]; then + cat $testrun_log + echo "error encountered starting test run" + exit 1 + fi + + sleep 1 + done + + if [[ $i -eq $WAITING ]]; then + cat $testrun_log + echo "failed after waiting $WAITING seconds for test-run start" + exit 1 + fi + + # Load Test Container + sudo docker run -d \ + --network=endev1 \ + --mac-address=$ethmac \ + --cap-add=NET_ADMIN \ + -v /tmp:/out \ + --privileged \ + --name=$tester \ + ci_test_device1 $args + + wait $TPID + # Following line indicates that tests are completed but wait till it exits + # Completed running test modules on device with mac addr 7e:41:12:d2:35:6a + #Change this line! - LOGGER.info(f"""Completed running test modules on device + # with mac addr {device.mac_addr}""") + + ls runtime + more runtime/network/*.log + sudo docker kill $tester + sudo docker logs $tester | cat + + cp runtime/test/${ethmac//:/}/results.json $TEST_DIR/$tester.json + more $TEST_DIR/$tester.json + more $testrun_log + +done + +pytest -s testing/test_tests.py + +exit $? diff --git a/testing/test_tests.json b/testing/test_tests.json new file mode 100644 index 000000000..076e9149e --- /dev/null +++ b/testing/test_tests.json @@ -0,0 +1,19 @@ +{ + "tester1": { + "image": "test-run/ci_test1", + "args": "oddservices", + "ethmac": "02:42:aa:00:00:01", + "expected_results": { + "security.nmap.ports": "non-compliant" + } + }, + "tester2": { + "image": "test-run/ci_test1", + "args": "", + "ethmac": "02:42:aa:00:00:02", + "expected_results": { + "security.nmap.ports": "compliant" + } + } + +} \ No newline at end of file diff --git a/testing/test_tests.py b/testing/test_tests.py new file mode 100644 index 000000000..7c60484f0 --- /dev/null +++ b/testing/test_tests.py @@ -0,0 +1,102 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +""" Test assertions for CI testing of tests """ +# Temporarily disabled because using Pytest fixtures +# TODO refactor fixtures to not trigger error +# pylint: disable=redefined-outer-name + +import json +import pytest +import os +import glob +import itertools + +from pathlib import Path +from dataclasses import dataclass + +TEST_MATRIX = 'test_tests.json' +RESULTS_PATH = '/tmp/results/*.json' + +@dataclass(frozen=True) +class TestResult: + name: str + result: str + __test__ = False + + +def collect_expected_results(expected_results): + """ Yields results from expected_results property of the test matrix""" + for name, result in expected_results.items(): + yield TestResult(name, result) + + +def collect_actual_results(results_dict): + """ Yields results from an already loaded testrun results file """ + # "module"."results".[list]."result" + for maybe_module, child in results_dict.items(): + if 'results' in child and maybe_module != 'baseline': + for test in child['results']: + yield TestResult(test['name'], test['result']) + + +@pytest.fixture +def test_matrix(): + basedir = os.path.dirname(os.path.abspath(__file__)) + with open(os.path.join(basedir, TEST_MATRIX), encoding='utf-8') as f: + return json.load(f) + + +@pytest.fixture +def results(): + results = {} + for file in [Path(x) for x in glob.glob(RESULTS_PATH)]: + with open(file, encoding='utf-8') as f: + results[file.stem] = json.load(f) + return results + + +def test_tests(results, test_matrix): + """ Check if each testers expect results were obtained """ + for tester, props in test_matrix.items(): + expected = set(collect_expected_results(props['expected_results'])) + actual = set(collect_actual_results(results[tester])) + + assert expected.issubset(actual), f'{tester} expected results not obtained' + +def test_list_tests(capsys, results, test_matrix): + all_tests = set(itertools.chain.from_iterable( + [collect_actual_results(results[x]) for x in results.keys()])) + + ci_pass = set([test + for testers in test_matrix.values() + for test, result in testers['expected_results'].items() + if result == 'compliant']) + + ci_fail = set([test + for testers in test_matrix.values() + for test, result in testers['expected_results'].items() + if result == 'non-compliant']) + + with capsys.disabled(): + print('============') + print('============') + print('tests seen:') + print('\n'.join([x.name for x in all_tests])) + print('\ntesting for pass:') + print('\n'.join(ci_pass)) + print('\ntesting for pass:') + print('\n'.join(ci_pass)) + + assert True From 01761dde686db83eabf5a9194699e9327b2cd8c5 Mon Sep 17 00:00:00 2001 From: Jacob Boddey Date: Fri, 14 Jul 2023 11:07:07 +0100 Subject: [PATCH 055/400] Fix radvd conf --- modules/network/dhcp-1/conf/dhcpd.conf | 56 +++++++++---------- modules/network/dhcp-1/conf/isc-dhcp-server | 8 +-- .../network/dhcp-1/conf/module_config.json | 50 ++++++++--------- modules/network/dhcp-1/conf/radvd.conf | 5 +- 4 files changed, 59 insertions(+), 60 deletions(-) diff --git a/modules/network/dhcp-1/conf/dhcpd.conf b/modules/network/dhcp-1/conf/dhcpd.conf index df804acf9..39f67c3b8 100644 --- a/modules/network/dhcp-1/conf/dhcpd.conf +++ b/modules/network/dhcp-1/conf/dhcpd.conf @@ -1,29 +1,29 @@ -default-lease-time 30; -max-lease-time 30; - -failover peer "failover-peer" { - primary; - address 10.10.10.2; - port 847; - peer address 10.10.10.3; - peer port 647; - max-response-delay 60; - max-unacked-updates 10; - mclt 30; - split 128; - load balance max seconds 3; -} - -subnet 10.10.10.0 netmask 255.255.255.0 { - option ntp-servers 10.10.10.5; - option subnet-mask 255.255.255.0; - option broadcast-address 10.10.10.255; - option routers 10.10.10.1; - option domain-name-servers 10.10.10.4; - interface veth0; - authoritative; - pool { - failover peer "failover-peer"; - range 10.10.10.10 10.10.10.20; - } +default-lease-time 30; +max-lease-time 30; + +failover peer "failover-peer" { + primary; + address 10.10.10.2; + port 847; + peer address 10.10.10.3; + peer port 647; + max-response-delay 60; + max-unacked-updates 10; + mclt 30; + split 128; + load balance max seconds 3; +} + +subnet 10.10.10.0 netmask 255.255.255.0 { + option ntp-servers 10.10.10.5; + option subnet-mask 255.255.255.0; + option broadcast-address 10.10.10.255; + option routers 10.10.10.1; + option domain-name-servers 10.10.10.4; + interface veth0; + authoritative; + pool { + failover peer "failover-peer"; + range 10.10.10.10 10.10.10.20; + } } \ No newline at end of file diff --git a/modules/network/dhcp-1/conf/isc-dhcp-server b/modules/network/dhcp-1/conf/isc-dhcp-server index 44db95cd9..4a4aa09f9 100644 --- a/modules/network/dhcp-1/conf/isc-dhcp-server +++ b/modules/network/dhcp-1/conf/isc-dhcp-server @@ -1,4 +1,4 @@ -# On what interfaces should the DHCP server (dhcpd) serve DHCP requests? -# Separate multiple interfaces with spaces, e.g. "eth0 eth1". -INTERFACESv4="veth0" -#INTERFACESv6="veth0" +# On what interfaces should the DHCP server (dhcpd) serve DHCP requests? +# Separate multiple interfaces with spaces, e.g. "eth0 eth1". +INTERFACESv4="veth0" +#INTERFACESv6="veth0" diff --git a/modules/network/dhcp-1/conf/module_config.json b/modules/network/dhcp-1/conf/module_config.json index 4a41eee3f..cf1f59a1e 100644 --- a/modules/network/dhcp-1/conf/module_config.json +++ b/modules/network/dhcp-1/conf/module_config.json @@ -1,26 +1,26 @@ -{ - "config": { - "meta": { - "name": "dhcp-1", - "display_name": "DHCP Primary", - "description": "Primary DHCP server with IPv6 SLAAC" - }, - "network": { - "interface": "veth0", - "enable_wan": false, - "ip_index": 2 - }, - "grpc":{ - "port": 5001 - }, - "docker": { - "depends_on": "base", - "mounts": [ - { - "source": "runtime/network", - "target": "/runtime/network" - } - ] - } - } +{ + "config": { + "meta": { + "name": "dhcp-1", + "display_name": "DHCP Primary", + "description": "Primary DHCP server with IPv6 SLAAC" + }, + "network": { + "interface": "veth0", + "enable_wan": false, + "ip_index": 2 + }, + "grpc":{ + "port": 5001 + }, + "docker": { + "depends_on": "base", + "mounts": [ + { + "source": "runtime/network", + "target": "/runtime/network" + } + ] + } + } } \ No newline at end of file diff --git a/modules/network/dhcp-1/conf/radvd.conf b/modules/network/dhcp-1/conf/radvd.conf index 89995785f..0cc500fd5 100644 --- a/modules/network/dhcp-1/conf/radvd.conf +++ b/modules/network/dhcp-1/conf/radvd.conf @@ -7,7 +7,6 @@ interface veth0 prefix fd10:77be:4186::/64 { AdvOnLink on; AdvAutonomous on; - AdvRouterAddr on; - AdvSourceLLAddress off; + AdvRouterAddr on; }; -}; \ No newline at end of file +}; From c23f258d4b7edf90af6319ed107434ac29325b9c Mon Sep 17 00:00:00 2001 From: jhughesbiot Date: Fri, 14 Jul 2023 07:40:38 -0600 Subject: [PATCH 056/400] Fix individual test disable --- modules/test/base/python/src/test_module.py | 8 +++-- modules/test/conn/conf/module_config.json | 30 ++++++++++--------- .../test/conn/python/src/connection_module.py | 11 ++++++- 3 files changed, 31 insertions(+), 18 deletions(-) diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index b0898aa20..e949976fa 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -61,8 +61,10 @@ def _get_device_tests(self, device_test_module): if 'tests' in device_test_module: if test['name'] in device_test_module['tests']: dev_test_config = device_test_module['tests'][test['name']] - if 'config' in test: - test['config'].update(dev_test_config) + if 'enabled' in dev_test_config: + test['enabled'] = dev_test_config['enabled'] + if 'config' in test and 'config' in dev_test_config: + test['config'].update(dev_test_config['config']) return module_tests def _get_device_test_module(self): @@ -80,9 +82,9 @@ def run_tests(self): for test in tests: test_method_name = '_' + test['name'].replace('.', '_') result = None + test['start'] = datetime.now().isoformat() if ('enabled' in test and test['enabled']) or 'enabled' not in test: LOGGER.info('Attempting to run test: ' + test['name']) - test['start'] = datetime.now().isoformat() # Resolve the correct python method by test name and run test if hasattr(self, test_method_name): if 'config' in test: diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index b82879544..37714f7bf 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -31,20 +31,22 @@ "name": "connection.private_address", "description": "The device under test accepts an IP address that is compliant with RFC 1918 Address Allocation for Private Internets.", "expected_behavior": "The device under test accepts IP addresses within all ranges specified in RFC 1918 and communicates using these addresses. The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of the IP address space for private internets. 10.0.0.0 - 10.255.255.255.255 (10/8 prefix). 172.16.0.0 - 172.31.255.255 (172.16/12 prefix). 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)", - "config": [ - { - "start": "10.0.0.100", - "end": "10.0.0.200" - }, - { - "start":"172.16.0.0", - "end":"172.16.255.255" - }, - { - "start":"192.168.0.0", - "end":"192.168.255.255" - } - ] + "config": { + "ranges": [ + { + "start": "10.0.0.100", + "end": "10.0.0.200" + }, + { + "start": "172.16.0.0", + "end": "172.16.255.255" + }, + { + "start": "192.168.0.0", + "end": "192.168.255.255" + } + ] + } }, { "name": "connection.single_ip", diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 87b7c2d18..58cc9ddeb 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -70,6 +70,15 @@ def __init__(self, module): def _connection_private_address(self, config): # Shutdown the secondary DHCP Server LOGGER.info('Running connection.private_address') + + # Resolve the configured dhcp subnet ranges + ranges = None + if 'ranges' in config: + ranges = config['ranges'] + else: + LOGGER.error('No subnet ranges configured for test. Skipping') + return None, 'No subnet ranges configured for test. Skipping' + response = self.dhcp1_client.get_dhcp_range() cur_range = {} if response.code == 200: @@ -89,7 +98,7 @@ def _connection_private_address(self, config): lease = self._get_cur_lease() if lease is not None: if self._is_lease_active(lease): - results = self.test_subnets(config) + results = self.test_subnets(ranges) else: return None, 'Failed to confirm a valid active lease for the device' else: From 5d24497ca77ef3e4e68232e89d59b430ff6aaaa4 Mon Sep 17 00:00:00 2001 From: Noureddine Date: Mon, 17 Jul 2023 11:19:57 +0000 Subject: [PATCH 057/400] Add NTP Pass CI test (#76) --- testing/docker/ci_test_device1/Dockerfile | 2 +- testing/docker/ci_test_device1/entrypoint.sh | 20 ++++++++++++++++++++ testing/test_tests | 2 +- testing/test_tests.json | 6 ++++-- testing/test_tests.py | 11 +++++++++-- 5 files changed, 35 insertions(+), 6 deletions(-) diff --git a/testing/docker/ci_test_device1/Dockerfile b/testing/docker/ci_test_device1/Dockerfile index 0bb697509..4328946fd 100644 --- a/testing/docker/ci_test_device1/Dockerfile +++ b/testing/docker/ci_test_device1/Dockerfile @@ -1,6 +1,6 @@ FROM ubuntu:jammy - +ENV DEBIAN_FRONTEND=noninteractive #Update and get all additional requirements not contained in the base image RUN apt-get update && apt-get -y upgrade diff --git a/testing/docker/ci_test_device1/entrypoint.sh b/testing/docker/ci_test_device1/entrypoint.sh index 8113704be..9152af0c8 100755 --- a/testing/docker/ci_test_device1/entrypoint.sh +++ b/testing/docker/ci_test_device1/entrypoint.sh @@ -88,4 +88,24 @@ elif [ -n "${options[sshv1]}" ]; then /usr/local/sbin/sshd fi +# still testing - using fixed +if [ -n "${options[ntpv4_dhcp]}" ]; then + (while true; do + dhcp_ntp=$(fgrep NTPSERVERS= /run/ntpdate.dhcp) + if [ -n "${dhcp_ntp}" ]; then + ntp_server=`echo $dhcp_ntp | cut -d "'" -f 2` + echo NTP server from DHCP $ntp_server + fi + ntpdate -q -p 1 $ntp_server + sleep 5 + done) & +fi + +if [ -n "${options[ntpv3_time_google_com]}" ]; then + (while true; do + ntpdate -q -p 1 -o 3 time.google.com + sleep 5 + done) & +fi + tail -f /dev/null \ No newline at end of file diff --git a/testing/test_tests b/testing/test_tests index 6ba9fef94..ed14f1043 100755 --- a/testing/test_tests +++ b/testing/test_tests @@ -115,6 +115,6 @@ for tester in $TESTERS; do done -pytest -s testing/test_tests.py +pytest -v testing/test_tests.py exit $? diff --git a/testing/test_tests.json b/testing/test_tests.json index 076e9149e..179a3f7fc 100644 --- a/testing/test_tests.json +++ b/testing/test_tests.json @@ -9,10 +9,12 @@ }, "tester2": { "image": "test-run/ci_test1", - "args": "", + "args": "ntpv4_dhcp", "ethmac": "02:42:aa:00:00:02", "expected_results": { - "security.nmap.ports": "compliant" + "security.nmap.ports": "compliant", + "ntp.network.ntp_support": "compliant", + "ntp.network.ntp_dhcp": "compliant" } } diff --git a/testing/test_tests.py b/testing/test_tests.py index 7c60484f0..b61fdf064 100644 --- a/testing/test_tests.py +++ b/testing/test_tests.py @@ -29,6 +29,7 @@ TEST_MATRIX = 'test_tests.json' RESULTS_PATH = '/tmp/results/*.json' +#TODO add reason @dataclass(frozen=True) class TestResult: name: str @@ -90,13 +91,19 @@ def test_list_tests(capsys, results, test_matrix): if result == 'non-compliant']) with capsys.disabled(): + #TODO print matching the JSON schema for easy copy/paste print('============') print('============') print('tests seen:') print('\n'.join([x.name for x in all_tests])) print('\ntesting for pass:') print('\n'.join(ci_pass)) - print('\ntesting for pass:') - print('\n'.join(ci_pass)) + print('\ntesting for fail:') + print('\n'.join(ci_fail)) + print('\ntester results') + for tester in test_matrix.keys(): + print(f'\n{tester}:') + for test in collect_actual_results(results[tester]): + print(f'{test.name}: {test.result}') assert True From 006aa11a74698ed9c67fb6c3b8bd7bf578849ba4 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Mon, 17 Jul 2023 06:40:07 -0700 Subject: [PATCH 058/400] add shared address test (#75) --- modules/test/conn/conf/module_config.json | 13 ++ .../test/conn/python/src/connection_module.py | 150 +++++++++--------- 2 files changed, 91 insertions(+), 72 deletions(-) diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index 37714f7bf..86e1849af 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -48,6 +48,19 @@ ] } }, + { + "name": "connection.shared_address", + "description": "Ensure the device supports RFC 6598 IANA-Reserved IPv4 Prefix for Shared Address Space", + "expected_behavior": "The device under test accepts IP addresses within the ranges specified in RFC 6598 and communicates using these addresses", + "config": { + "ranges": [ + { + "start": "100.64.0.1", + "end": "100.64.255.254" + } + ] + } + }, { "name": "connection.single_ip", "description": "The network switch port connected to the device reports only one IP address for the device under test.", diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index e9ec4946d..220bdce20 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -68,80 +68,12 @@ def __init__(self, module): # print("Set Range: " + str(response)) def _connection_private_address(self, config): - # Shutdown the secondary DHCP Server LOGGER.info('Running connection.private_address') + return self._run_subnet_test(config) - # Resolve the configured dhcp subnet ranges - ranges = None - if 'ranges' in config: - ranges = config['ranges'] - else: - LOGGER.error('No subnet ranges configured for test. Skipping') - return None, 'No subnet ranges configured for test. Skipping' - - response = self.dhcp1_client.get_dhcp_range() - cur_range = {} - if response.code == 200: - cur_range['start'] = response.start - cur_range['end'] = response.end - LOGGER.info('Current DHCP subnet range: ' + str(cur_range)) - else: - LOGGER.error('Failed to resolve current subnet range required ' - 'for restoring network') - return None, ('Failed to resolve current subnet range required ' - 'for restoring network') - - results = [] - dhcp_setup = self.setup_single_dhcp_server() - if dhcp_setup[0]: - LOGGER.info(dhcp_setup[1]) - lease = self._get_cur_lease() - if lease is not None: - if self._is_lease_active(lease): - results = self.test_subnets(ranges) - else: - return None, 'Failed to confirm a valid active lease for the device' - else: - LOGGER.error(dhcp_setup[1]) - return None, 'Failed to setup DHCP server for test' - - # Process and return final results - final_result = None - final_result_details = '' - for result in results: - if final_result is None: - final_result = result['result'] - else: - final_result &= result['result'] - final_result_details += result['details'] + '\n' - - try: - # Restore failover configuration of DHCP servers - self.restore_failover_dhcp_server(cur_range) - - # Wait for the current lease to expire - self._wait_for_lease_expire(self._get_cur_lease()) - - # Wait for a new lease to be provided before exiting test - # to prevent other test modules from failing - for _ in range(5): - LOGGER.info('Checking for new lease') - lease = self._get_cur_lease() - if lease is not None: - LOGGER.info('New Lease found: ' + str(lease)) - LOGGER.info('Validating subnet for new lease...') - in_range = self.is_ip_in_range(lease['ip'], cur_range['start'], - cur_range['end']) - LOGGER.info('Lease within subnet: ' + str(in_range)) - break - else: - LOGGER.info('New lease not found. Waiting to check again') - time.sleep(5) - - except Exception as e: # pylint: disable=W0718 - LOGGER.error('Failed to restore DHCP server configuration: ' + str(e)) - - return final_result, final_result_details + def _connection_shared_address(self, config): + LOGGER.info('Running connection.shared_address') + return self._run_subnet_test(config) def _connection_dhcp_address(self): LOGGER.info('Running connection.dhcp_address') @@ -343,6 +275,80 @@ def is_ip_in_range(self, ip, start_ip, end_ip): return start_int <= ip_int <= end_int + def _run_subnet_test(self,config): + # Resolve the configured dhcp subnet ranges + ranges = None + if 'ranges' in config: + ranges = config['ranges'] + else: + LOGGER.error('No subnet ranges configured for test. Skipping') + return None, 'No subnet ranges configured for test. Skipping' + + response = self.dhcp1_client.get_dhcp_range() + cur_range = {} + if response.code == 200: + cur_range['start'] = response.start + cur_range['end'] = response.end + LOGGER.info('Current DHCP subnet range: ' + str(cur_range)) + else: + LOGGER.error('Failed to resolve current subnet range required ' + 'for restoring network') + return None, ('Failed to resolve current subnet range required ' + 'for restoring network') + + results = [] + dhcp_setup = self.setup_single_dhcp_server() + if dhcp_setup[0]: + LOGGER.info(dhcp_setup[1]) + lease = self._get_cur_lease() + if lease is not None: + if self._is_lease_active(lease): + results = self.test_subnets(ranges) + else: + return None, 'Failed to confirm a valid active lease for the device' + else: + LOGGER.error(dhcp_setup[1]) + return None, 'Failed to setup DHCP server for test' + + # Process and return final results + final_result = None + final_result_details = '' + for result in results: + if final_result is None: + final_result = result['result'] + else: + final_result &= result['result'] + final_result_details += result['details'] + '\n' + + try: + # Restore failover configuration of DHCP servers + self.restore_failover_dhcp_server(cur_range) + + # Wait for the current lease to expire + self._wait_for_lease_expire(self._get_cur_lease()) + + # Wait for a new lease to be provided before exiting test + # to prevent other test modules from failing + for _ in range(5): + LOGGER.info('Checking for new lease') + lease = self._get_cur_lease() + if lease is not None: + LOGGER.info('New Lease found: ' + str(lease)) + LOGGER.info('Validating subnet for new lease...') + in_range = self.is_ip_in_range(lease['ip'], cur_range['start'], + cur_range['end']) + LOGGER.info('Lease within subnet: ' + str(in_range)) + break + else: + LOGGER.info('New lease not found. Waiting to check again') + time.sleep(5) + + except Exception as e: # pylint: disable=W0718 + LOGGER.error('Failed to restore DHCP server configuration: ' + str(e)) + + return final_result, final_result_details + + def _test_subnet(self, subnet, lease): if self._change_subnet(subnet): expiration = datetime.strptime(lease['expires'], '%Y-%m-%d %H:%M:%S') From 153de1925867996e6d3c39d5e46456dcc5220160 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Mon, 17 Jul 2023 07:01:28 -0700 Subject: [PATCH 059/400] Fix single ip test (#58) * Fix single ip test from detecting faux-device during validation as a failure * remove dhcp server capture file from scan --------- Co-authored-by: J Boddey --- framework/python/src/net_orc/network_validator.py | 7 ++++++- modules/test/conn/python/src/connection_module.py | 13 +++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/framework/python/src/net_orc/network_validator.py b/framework/python/src/net_orc/network_validator.py index f82787af5..2a4112764 100644 --- a/framework/python/src/net_orc/network_validator.py +++ b/framework/python/src/net_orc/network_validator.py @@ -30,7 +30,7 @@ DEVICE_BRIDGE = 'tr-d' CONF_DIR = 'local' CONF_FILE = 'system.json' - +TR_CONTAINER_MAC_PREFIX = '9a:02:57:1e:8f:' class NetworkValidator: """Perform validation of network services.""" @@ -238,6 +238,10 @@ def _attach_device_to_network(self, device): util.run_command('ip link add ' + bridge_intf + ' type veth peer name ' + container_intf) + mac_addr = TR_CONTAINER_MAC_PREFIX + '10' + + util.run_command('ip link set dev ' + container_intf + ' address ' + mac_addr) + # Add bridge interface to device bridge util.run_command('ovs-vsctl add-port ' + DEVICE_BRIDGE + ' ' + bridge_intf) @@ -258,6 +262,7 @@ def _attach_device_to_network(self, device): util.run_command('ip netns exec ' + container_net_ns + ' ip link set dev ' + container_intf + ' name veth0') + # Set interfaces up util.run_command('ip link set dev ' + bridge_intf + ' up') util.run_command('ip netns exec ' + container_net_ns + diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 220bdce20..419fba68a 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -24,11 +24,12 @@ LOG_NAME = 'test_connection' LOGGER = None OUI_FILE = '/usr/local/etc/oui.txt' -DHCP_SERVER_CAPTURE_FILE = '/runtime/network/dhcp-1.pcap' STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' SLAAC_PREFIX = 'fd10:77be:4186' +TR_CONTAINER_MAC_PREFIX = '9a:02:57:1e:8f:' + class ConnectionModule(TestModule): """Connection Test module""" @@ -123,8 +124,7 @@ def _connection_single_ip(self): return result, 'No MAC address found.' # Read all the pcap files containing DHCP packet information - packets = rdpcap(DHCP_SERVER_CAPTURE_FILE) - packets.append(rdpcap(STARTUP_CAPTURE_FILE)) + packets = rdpcap(STARTUP_CAPTURE_FILE) packets.append(rdpcap(MONITOR_CAPTURE_FILE)) # Extract MAC addresses from DHCP packets @@ -132,9 +132,10 @@ def _connection_single_ip(self): LOGGER.info('Inspecting: ' + str(len(packets)) + ' packets') for packet in packets: # Option[1] = message-type, option 3 = DHCPREQUEST - if DHCP in packet and packet[DHCP].options[0][1] == 3: - mac_address = packet[Ether].src - mac_addresses.add(mac_address.upper()) + if DHCP in packet and packet[DHCP].options[0][1] == 3: + mac_address = packet[Ether].src + if not mac_address.startswith(TR_CONTAINER_MAC_PREFIX): + mac_addresses.add(mac_address.upper()) # Check if the device mac address is in the list of DHCPREQUESTs result = self._device_mac.upper() in mac_addresses From e2c934eeaea89428eda9ade805f5964dde86408e Mon Sep 17 00:00:00 2001 From: J Boddey Date: Mon, 24 Jul 2023 13:27:29 +0100 Subject: [PATCH 060/400] Merge API into dev (#70) * Start API * Write interfaces * Get current configuration * Set versions * Add more API methods * Correct no-ui flag * Do not launch API on baseline test * Move loading devices back to Test Run core * Merge dev into api (#74) * Merge dev into main (Add license header) (#62) Add license header * Add network docs (#63) * Add network docs * Rename to readme * Add link to template module * Dhcp (#64) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Dhcp (#67) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Move isc-dhcp-server and radvd to services Move DHCP server monitoring and booting to python script * Add grpc methods to interact with dhcp_server module Update dhcp_server to control radvd server directly from calls Fix radvd service status method * Add updates to dhcp2 module Update radvd service * Add license headers * Add connection.dhcp_address test (#68) * Add NTP tests (#60) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * Pylint (#69) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> * Add ipv6 tests (#65) * Add ipv6 tests * Check for ND_NS * Merge dev into main (Sprint 9) (#66) * Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey * Add issue report templates (#7) * Add issue templates * Update README.md * Discover devices on the network (#5) * Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- * Quick refactor (#9) * Fix duplicate sleep calls * Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- * Add baseline and pylint tests (#25) * Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot * Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot * Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues * Fix device configs * Remove unecessary files * Cleanup duplicate properties * Cleanup install script * Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev * Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled * Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test * Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot * Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey * Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * remove ovs files added back in during merge * Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Create startup capture (#37) * Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test * Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures * File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions * Add connection single ip test (#47) * Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range * Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot * Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location * Add documentation (#53) * Sync dev to main (#56) * Merge dev into main (Sprint 7 and 8) (#33) * Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey * Add issue report templates (#7) * Add issue templates * Update README.md * Discover devices on the network (#5) * Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- * Quick refactor (#9) * Fix duplicate sleep calls * Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- * Add baseline and pylint tests (#25) * Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot * Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot * Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues * Fix device configs * Remove unecessary files * Cleanup duplicate properties * Cleanup install script * Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev * Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled * Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test * Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot * Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey * Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * remove ovs files added back in during merge * Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Create startup capture (#37) * Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test * Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures * File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions * Add connection single ip test (#47) * Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range * Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot * Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location * Add documentation (#53) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Sprint 8 Hotfix (#54) * Fix connection results.json * Re add try/catch * Fix log level * Debug test module load order * Add depends on to nmap module * Remove logging change --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Fix missing results on udp tests when tcp ports are also defined (#59) * Add licence header (#61) * Resolve merge conflict * Add network docs (#63) * Add network docs * Rename to readme * Add link to template module * Dhcp (#64) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Dhcp (#67) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Move isc-dhcp-server and radvd to services Move DHCP server monitoring and booting to python script * Add grpc methods to interact with dhcp_server module Update dhcp_server to control radvd server directly from calls Fix radvd service status method * Add updates to dhcp2 module Update radvd service * Add license headers * Add connection.dhcp_address test (#68) * Add NTP tests (#60) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * Pylint (#69) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> * Add ipv6 tests (#65) * Add ipv6 tests * Check for ND_NS --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Connection private address (#71) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * formatting * Change isc-dhcp service setup Fix dhcpd logging Add start and stop methods to grpc dhcp client Add dhcp2 client Inttial private_addr test * Add max lease time Add unit tests * fix last commit * finish initial work on test * pylinting * Breakup test and allow better failure reporting * restore network after test * Wait for device to get a lease from original dhcp range after network restore * pylinting * Fix ipv6 tests --------- Co-authored-by: Jacob Boddey * fix windows line ending * Fix python import * move isc-dhcp service commands to their own class update logging pylinting * fix dhcp1 * Initial CI testing for tests (#72) * Fix radvd conf --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Fix testing command * Disable API on testing * Add API session * Remove old method * Remove local vars * Replace old var * Add device config * Add device configs * Fix paths * Change MAC address * Revert mac * Fix copy path * Debug loading devices * Remove reference * Changes * Re-add checks to prevent null values * Fix variable * Fix * Use dict instead of string * Try without json conversion * Container output to log * Undo changes to nmap module * Add post devices route --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron --- .github/workflows/testing.yml | 6 +- cmd/start => bin/testrun | 17 +- framework/python/src/api/api.py | 197 ++++++++++++++++++ .../python/src/{core => common}/device.py | 6 +- framework/python/src/common/session.py | 169 +++++++++++++++ framework/python/src/core/test_runner.py | 18 +- framework/python/src/core/testrun.py | 172 ++++++++++----- framework/python/src/net_orc/listener.py | 8 +- .../src/net_orc/network_orchestrator.py | 180 +++++++--------- framework/python/src/net_orc/ovs_control.py | 33 +-- .../python/src/test_orc/test_orchestrator.py | 19 +- framework/requirements.txt | 8 +- modules/test/base/base.Dockerfile | 2 +- modules/test/base/bin/capture | 2 +- modules/test/base/bin/setup_binaries | 2 +- .../test/base/bin/start | 41 ++-- modules/test/base/bin/start_module | 2 +- modules/test/base/python/src/test_module.py | 22 +- modules/test/conn/bin/start_test_module | 2 +- .../test/conn/python/src/connection_module.py | 10 +- modules/test/dns/python/src/dns_module.py | 3 +- modules/ui/conf/nginx.conf | 13 ++ modules/ui/ui.Dockerfile | 19 ++ resources/devices/template/device_config.json | 167 +-------------- testing/{ => baseline}/test_baseline | 4 +- testing/{ => baseline}/test_baseline.py | 0 .../device_configs/tester1/device_config.json | 22 ++ .../device_configs/tester2/device_config.json | 22 ++ testing/docker/ci_test_device1/Dockerfile | 8 +- testing/{ => pylint}/test_pylint | 0 testing/{ => tests}/example/mac | 0 testing/{ => tests}/example/mac1/results.json | 0 testing/{ => tests}/test_tests | 9 +- testing/{ => tests}/test_tests.json | 0 testing/{ => tests}/test_tests.py | 14 +- testing/{unit_test => unit}/run_tests.sh | 0 ui/index.html | 1 + 37 files changed, 750 insertions(+), 448 deletions(-) rename cmd/start => bin/testrun (72%) create mode 100644 framework/python/src/api/api.py rename framework/python/src/{core => common}/device.py (88%) create mode 100644 framework/python/src/common/session.py rename framework/python/src/net_orc/network_device.py => modules/test/base/bin/start (71%) mode change 100644 => 100755 create mode 100644 modules/ui/conf/nginx.conf create mode 100644 modules/ui/ui.Dockerfile rename testing/{ => baseline}/test_baseline (95%) rename testing/{ => baseline}/test_baseline.py (100%) create mode 100644 testing/device_configs/tester1/device_config.json create mode 100644 testing/device_configs/tester2/device_config.json rename testing/{ => pylint}/test_pylint (100%) rename testing/{ => tests}/example/mac (100%) rename testing/{ => tests}/example/mac1/results.json (100%) rename testing/{ => tests}/test_tests (93%) rename testing/{ => tests}/test_tests.json (100%) rename testing/{ => tests}/test_tests.py (92%) rename testing/{unit_test => unit}/run_tests.sh (100%) create mode 100644 ui/index.html diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index c981dbd56..9e6f35323 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -16,7 +16,7 @@ jobs: uses: actions/checkout@v2.3.4 - name: Run tests shell: bash {0} - run: testing/test_baseline + run: testing/baseline/test_baseline testrun_tests: name: Tests @@ -27,7 +27,7 @@ jobs: uses: actions/checkout@v2.3.4 - name: Run tests shell: bash {0} - run: testing/test_tests + run: testing/tests/test_tests pylint: name: Pylint runs-on: ubuntu-22.04 @@ -37,4 +37,4 @@ jobs: uses: actions/checkout@v2.3.4 - name: Run tests shell: bash {0} - run: testing/test_pylint + run: testing/pylint/test_pylint diff --git a/cmd/start b/bin/testrun similarity index 72% rename from cmd/start rename to bin/testrun index 64ac197eb..9281c1ac6 100755 --- a/cmd/start +++ b/bin/testrun @@ -15,23 +15,26 @@ # limitations under the License. if [[ "$EUID" -ne 0 ]]; then - echo "Must run as root. Use sudo cmd/start" + echo "Must run as root. Use sudo testrun" exit 1 fi +# TODO: Obtain TESTRUNPATH from user environment variables +# TESTRUNPATH="/home/boddey/Desktop/test-run" +# cd $TESTRUNPATH + # Ensure that /var/run/netns folder exists -mkdir -p /var/run/netns +sudo mkdir -p /var/run/netns -# Clear up existing runtime files -rm -rf runtime +# Create device folder if it doesn't exist +mkdir -p local/devices -# Check if python modules exist. Install if not -[ ! -d "venv" ] && cmd/install +# Check if Python modules exist. Install if not +[ ! -d "venv" ] && sudo cmd/install # Activate Python virtual environment source venv/bin/activate -# TODO: Execute python code # Set the PYTHONPATH to include the "src" directory export PYTHONPATH="$PWD/framework/python/src" python -u framework/python/src/core/test_runner.py $@ diff --git a/framework/python/src/api/api.py b/framework/python/src/api/api.py new file mode 100644 index 000000000..d877a5b33 --- /dev/null +++ b/framework/python/src/api/api.py @@ -0,0 +1,197 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from fastapi import FastAPI, APIRouter, Response, Request, status +import json +from json import JSONDecodeError +import psutil +import threading +import uvicorn + +from common import logger +from common.device import Device + +LOGGER = logger.get_logger("api") + +DEVICE_MAC_ADDR_KEY = "mac_addr" +DEVICE_MANUFACTURER_KEY = "manufacturer" +DEVICE_MODEL_KEY = "model" + +class Api: + """Provide REST endpoints to manage Test Run""" + + def __init__(self, test_run): + + self._test_run = test_run + self._name = "TestRun API" + self._router = APIRouter() + + self._session = self._test_run.get_session() + + self._router.add_api_route("/system/interfaces", self.get_sys_interfaces) + self._router.add_api_route("/system/config", self.post_sys_config, + methods=["POST"]) + self._router.add_api_route("/system/config", self.get_sys_config) + self._router.add_api_route("/system/start", self.start_test_run, + methods=["POST"]) + self._router.add_api_route("/system/stop", self.stop_test_run, + methods=["POST"]) + self._router.add_api_route("/system/status", self.get_status) + + self._router.add_api_route("/devices", self.get_devices) + self._router.add_api_route("/device", self.save_device, methods=["POST"]) + + self._app = FastAPI() + self._app.include_router(self._router) + + self._api_thread = threading.Thread(target=self._start, + name="Test Run API", + daemon=True) + + def start(self): + LOGGER.info("Starting API") + self._api_thread.start() + LOGGER.info("API waiting for requests") + + def _start(self): + uvicorn.run(self._app, log_config=None) + + def stop(self): + LOGGER.info("Stopping API") + + async def get_sys_interfaces(self): + addrs = psutil.net_if_addrs() + ifaces = [] + for iface in addrs: + ifaces.append(iface) + return ifaces + + async def post_sys_config(self, request: Request, response: Response): + try: + config = (await request.body()).decode("UTF-8") + config_json = json.loads(config) + self._session.set_config(config_json) + # Catch JSON Decode error etc + except JSONDecodeError: + response.status_code = status.HTTP_400_BAD_REQUEST + return self._generate_msg(False, "Invalid JSON received") + return self._session.get_config() + + async def get_sys_config(self): + return self._session.get_config() + + async def get_devices(self): + return self._session.get_device_repository() + + async def start_test_run(self, request: Request, response: Response): + + LOGGER.debug("Received start command") + + # Check request is valid + body = (await request.body()).decode("UTF-8") + body_json = None + + try: + body_json = json.loads(body) + except JSONDecodeError: + response.status_code = status.HTTP_400_BAD_REQUEST + return self._generate_msg(False, "Invalid JSON received") + + if "device" not in body_json or "mac_addr" not in body_json["device"]: + response.status_code = status.HTTP_400_BAD_REQUEST + return self._generate_msg(False, "Invalid request received") + + device = self._session.get_device(body_json["device"]["mac_addr"]) + + # Check Test Run is not already running + if self._test_run.get_session().get_status() != "Idle": + LOGGER.debug("Test Run is already running. Cannot start another instance") + response.status_code = status.HTTP_409_CONFLICT + return self._generate_msg(False, "Test Run is already running") + + # Check if requested device is known in the device repository + if device is None: + response.status_code = status.HTTP_404_NOT_FOUND + return self._generate_msg(False, "A device with that MAC address could not be found") + + # Check Test Run is able to start + if self._test_run.get_net_orc().check_config() is False: + response.status_code = status.HTTP_500_INTERNAL_SERVER_ERROR + return self._generate_msg(False, "Configured interfaces are not ready for use. Ensure both interfaces are connected.") + + self._test_run.get_session().set_target_device(device) + LOGGER.info(f"Starting Test Run with device target {device.manufacturer} {device.model} with MAC address {device.mac_addr}") + + thread = threading.Thread(target=self._start_test_run, + name="Test Run") + thread.start() + return self._test_run.get_session().to_json() + + def _generate_msg(self, success, message): + msg_type = "success" + if not success: + msg_type = "error" + return json.loads('{"' + msg_type + '": "' + message + '"}') + + def _start_test_run(self): + self._test_run.start() + + async def stop_test_run(self): + LOGGER.debug("Received stop command. Stopping Test Run") + self._test_run.stop() + return self._generate_msg(True, "Test Run stopped") + + async def get_status(self): + return self._test_run.get_session().to_json() + + async def get_history(self): + LOGGER.info("Returning previous Test Runs to UI") + + async def save_device(self, request: Request, response: Response): + LOGGER.debug("Received device post request") + + try: + device_raw = (await request.body()).decode("UTF-8") + device_json = json.loads(device_raw) + + if not self._validate_device_json(device_json): + response.status_code = status.HTTP_400_BAD_REQUEST + return self._generate_msg(False, "Invalid request received") + + device = self._session.get_device(device_json.get(DEVICE_MAC_ADDR_KEY)) + if device is None: + # Create new device + device = Device() + device.mac_addr = device_json.get(DEVICE_MAC_ADDR_KEY) + response.status_code = status.HTTP_201_CREATED + + device.manufacturer = device_json.get(DEVICE_MANUFACTURER_KEY) + device.model = device_json.get(DEVICE_MODEL_KEY) + + self._session.save_device(device) + + return device + + # Catch JSON Decode error etc + except JSONDecodeError: + response.status_code = status.HTTP_400_BAD_REQUEST + return self._generate_msg(False, "Invalid JSON received") + + def _validate_device_json(self, json_obj): + if not (DEVICE_MAC_ADDR_KEY in json_obj and + DEVICE_MANUFACTURER_KEY in json_obj and + DEVICE_MODEL_KEY in json_obj + ): + return False + return True diff --git a/framework/python/src/core/device.py b/framework/python/src/common/device.py similarity index 88% rename from framework/python/src/core/device.py rename to framework/python/src/common/device.py index efce2dba1..b70099519 100644 --- a/framework/python/src/core/device.py +++ b/framework/python/src/common/device.py @@ -14,14 +14,14 @@ """Track device object information.""" -from net_orc.network_device import NetworkDevice from dataclasses import dataclass - @dataclass -class Device(NetworkDevice): +class Device(): """Represents a physical device and it's configuration.""" + mac_addr: str = None manufacturer: str = None model: str = None test_modules: str = None + ip_addr: str = None diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py new file mode 100644 index 000000000..a0f6118ff --- /dev/null +++ b/framework/python/src/common/session.py @@ -0,0 +1,169 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Track testing status.""" + +import datetime +import json +import os + +NETWORK_KEY = 'network' +DEVICE_INTF_KEY = 'device_intf' +INTERNET_INTF_KEY = 'internet_intf' +RUNTIME_KEY = 'runtime' +MONITOR_PERIOD_KEY = 'monitor_period' +STARTUP_TIMEOUT_KEY = 'startup_timeout' +LOG_LEVEL_KEY = 'log_level' + +class TestRunSession(): + """Represents the current session of Test Run.""" + + def __init__(self, config_file): + self._status = 'Idle' + self._device = None + self._started = None + self._finished = None + self._tests = [] + + self._config_file = config_file + + self._config = self._get_default_config() + self._load_config() + + self._device_repository = [] + + def start(self): + self._status = 'Starting' + self._started = datetime.datetime.now() + + def get_started(self): + return self._started + + def get_finished(self): + return self._finished + + def _get_default_config(self): + return { + 'network': { + 'device_intf': '', + 'internet_intf': '' + }, + 'log_level': 'INFO', + 'startup_timeout': 60, + 'monitor_period': 30, + 'runtime': 120 + } + + def get_config(self): + return self._config + + def _load_config(self): + + if not os.path.isfile(self._config_file): + return + + with open(self._config_file, 'r', encoding='utf-8') as f: + config_file_json = json.load(f) + + # Network interfaces + if (NETWORK_KEY in config_file_json + and DEVICE_INTF_KEY in config_file_json.get(NETWORK_KEY) + and INTERNET_INTF_KEY in config_file_json.get(NETWORK_KEY)): + self._config[NETWORK_KEY][DEVICE_INTF_KEY] = config_file_json.get(NETWORK_KEY, {}).get(DEVICE_INTF_KEY) + self._config[NETWORK_KEY][INTERNET_INTF_KEY] = config_file_json.get(NETWORK_KEY, {}).get(INTERNET_INTF_KEY) + + if RUNTIME_KEY in config_file_json: + self._config[RUNTIME_KEY] = config_file_json.get(RUNTIME_KEY) + + if STARTUP_TIMEOUT_KEY in config_file_json: + self._config[STARTUP_TIMEOUT_KEY] = config_file_json.get(STARTUP_TIMEOUT_KEY) + + if MONITOR_PERIOD_KEY in config_file_json: + self._config[MONITOR_PERIOD_KEY] = config_file_json.get(MONITOR_PERIOD_KEY) + + if LOG_LEVEL_KEY in config_file_json: + self._config[LOG_LEVEL_KEY] = config_file_json.get(LOG_LEVEL_KEY) + + def _save_config(self): + with open(self._config_file, 'w', encoding='utf-8') as f: + f.write(json.dumps(self._config, indent=2)) + + def get_runtime(self): + return self._config.get(RUNTIME_KEY) + + def get_log_level(self): + return self._config.get(LOG_LEVEL_KEY) + + def get_device_interface(self): + return self._config.get(NETWORK_KEY, {}).get(DEVICE_INTF_KEY) + + def get_internet_interface(self): + return self._config.get(NETWORK_KEY, {}).get(INTERNET_INTF_KEY) + + def get_monitor_period(self): + return self._config.get(MONITOR_PERIOD_KEY) + + def get_startup_timeout(self): + return self._config.get(STARTUP_TIMEOUT_KEY) + + def set_config(self, config_json): + self._config = config_json + self._save_config() + + def set_target_device(self, device): + self._device = device + + def get_target_device(self): + return self._device + + def get_device_repository(self): + return self._device_repository + + def add_device(self, device): + self._device_repository.append(device) + + def get_device(self, mac_addr): + for device in self._device_repository: + if device.mac_addr == mac_addr: + return device + return None + + def save_device(self, device): + # TODO: We need to save the folder path of the device config + return + + def get_status(self): + return self._status + + def set_status(self, status): + self._status = status + + def get_tests(self): + return self._tests + + def reset(self): + self.set_status('Idle') + self.set_target_device(None) + self._tests = [] + self._started = None + self._finished = None + + def to_json(self): + return { + 'status': self.get_status(), + 'device': self.get_target_device(), + 'started': self.get_started(), + 'finished': self.get_finished(), + 'tests': self.get_tests() + } diff --git a/framework/python/src/core/test_runner.py b/framework/python/src/core/test_runner.py index 226f874cc..9962c3995 100644 --- a/framework/python/src/core/test_runner.py +++ b/framework/python/src/core/test_runner.py @@ -36,12 +36,14 @@ def __init__(self, config_file=None, validate=True, net_only=False, - single_intf=False): + single_intf=False, + no_ui=False): self._register_exits() self.test_run = TestRun(config_file=config_file, validate=validate, net_only=net_only, - single_intf=single_intf) + single_intf=single_intf, + no_ui=no_ui) def _register_exits(self): signal.signal(signal.SIGINT, self._exit_handler) @@ -62,10 +64,6 @@ def _exit_handler(self, signum, arg): # pylint: disable=unused-argument def stop(self, kill=False): self.test_run.stop(kill) - def start(self): - self.test_run.start() - LOGGER.info("Test Run has finished") - def parse_args(): parser = argparse.ArgumentParser( @@ -88,6 +86,10 @@ def parse_args(): parser.add_argument("--single-intf", action="store_true", help="Single interface mode (experimental)") + parser.add_argument("--no-ui", + default=False, + action="store_true", + help="Do not launch the user interface") parsed_args = parser.parse_known_args()[0] return parsed_args @@ -97,5 +99,5 @@ def parse_args(): runner = TestRunner(config_file=args.config_file, validate=not args.no_validate, net_only=args.net_only, - single_intf=args.single_intf) - runner.start() + single_intf=args.single_intf, + no_ui=args.no_ui) diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index a91736e95..6016fbfe7 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -20,31 +20,34 @@ Run using the provided command scripts in the cmd folder. E.g sudo cmd/start """ +import json import os import sys -import json import signal import time from common import logger, util +from common.device import Device +from common.session import TestRunSession +from api.api import Api +from net_orc.listener import NetworkEvent +from net_orc import network_orchestrator as net_orc +from test_orc import test_orchestrator as test_orc # Locate parent directory current_dir = os.path.dirname(os.path.realpath(__file__)) # Locate the test-run root directory, 4 levels, src->python->framework->test-run -root_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(current_dir)))) - -from net_orc.listener import NetworkEvent -from test_orc import test_orchestrator as test_orc -from net_orc import network_orchestrator as net_orc -from device import Device +root_dir = os.path.dirname(os.path.dirname( + os.path.dirname(os.path.dirname(current_dir)))) LOGGER = logger.get_logger('test_run') -CONFIG_FILE = 'local/system.json' + +DEFAULT_CONFIG_FILE = 'local/system.json' EXAMPLE_CONFIG_FILE = 'local/system.json.example' -RUNTIME = 120 LOCAL_DEVICES_DIR = 'local/devices' RESOURCE_DEVICES_DIR = 'resources/devices' + DEVICE_CONFIG = 'device_config.json' DEVICE_MANUFACTURER = 'manufacturer' DEVICE_MODEL = 'model' @@ -59,77 +62,134 @@ class TestRun: # pylint: disable=too-few-public-methods """ def __init__(self, - config_file=CONFIG_FILE, + config_file, validate=True, net_only=False, - single_intf=False): - self._devices = [] + single_intf=False, + no_ui=False): + + if config_file is None: + self._config_file = self._get_config_abs(DEFAULT_CONFIG_FILE) + else: + self._config_file = self._get_config_abs(config_file) + self._net_only = net_only self._single_intf = single_intf + self._no_ui = no_ui # Catch any exit signals self._register_exits() - # Expand the config file to absolute pathing - config_file_abs = self._get_config_abs(config_file=config_file) + self._session = TestRunSession(config_file=self._config_file) + self._load_all_devices() self._net_orc = net_orc.NetworkOrchestrator( - config_file=config_file_abs, + session=self._session, validate=validate, single_intf = self._single_intf) + self._test_orc = test_orc.TestOrchestrator( + self._session, + self._net_orc) - self._test_orc = test_orc.TestOrchestrator(self._net_orc) + if self._no_ui: + self.start() + else: + self._api = Api(self) + self._api.start() + + # Hold until API ends + while True: + time.sleep(1) + + def _load_all_devices(self): + self._load_devices(device_dir=LOCAL_DEVICES_DIR) + self._load_devices(device_dir=RESOURCE_DEVICES_DIR) + return self.get_session().get_device_repository() + + def _load_devices(self, device_dir): + LOGGER.debug('Loading devices from ' + device_dir) + + util.run_command(f'chown -R {util.get_host_user()} {device_dir}') + + for device_folder in os.listdir(device_dir): + with open(os.path.join(device_dir, device_folder, DEVICE_CONFIG), + encoding='utf-8') as device_config_file: + device_config_json = json.load(device_config_file) + + device_manufacturer = device_config_json.get(DEVICE_MANUFACTURER) + device_model = device_config_json.get(DEVICE_MODEL) + mac_addr = device_config_json.get(DEVICE_MAC_ADDR) + test_modules = device_config_json.get(DEVICE_TEST_MODULES) + + device = Device(manufacturer=device_manufacturer, + model=device_model, + mac_addr=mac_addr, + test_modules=test_modules) + self.get_session().add_device(device) + LOGGER.debug(f'Loaded device {device.manufacturer} {device.model} with MAC address {device.mac_addr}') def start(self): - self._load_all_devices() + self._session.start() self._start_network() if self._net_only: LOGGER.info('Network only option configured, no tests will be run') - self._net_orc.listener.register_callback( + self.get_net_orc().listener.register_callback( self._device_discovered, [NetworkEvent.DEVICE_DISCOVERED] ) - self._net_orc.start_listener() + self.get_net_orc().start_listener() LOGGER.info('Waiting for devices on the network...') while True: - time.sleep(RUNTIME) + time.sleep(self._session.get_runtime()) else: self._test_orc.start() - self._net_orc.listener.register_callback( + self.get_net_orc().get_listener().register_callback( self._device_stable, [NetworkEvent.DEVICE_STABLE] ) - self._net_orc.listener.register_callback( + self.get_net_orc().get_listener().register_callback( self._device_discovered, [NetworkEvent.DEVICE_DISCOVERED] ) - self._net_orc.start_listener() + self.get_net_orc().start_listener() + self._set_status('Waiting for device') LOGGER.info('Waiting for devices on the network...') - time.sleep(RUNTIME) + time.sleep(self._session.get_runtime()) - if not (self._test_orc.test_in_progress() or self._net_orc.monitor_in_progress()): - LOGGER.info('Timed out whilst waiting for device or stopping due to test completion') + if not (self._test_orc.test_in_progress() or + self.get_net_orc().monitor_in_progress()): + LOGGER.info('''Timed out whilst waiting for + device or stopping due to test completion''') else: - while self._test_orc.test_in_progress() or self._net_orc.monitor_in_progress(): + while (self._test_orc.test_in_progress() or + self.get_net_orc().monitor_in_progress()): time.sleep(5) self.stop() def stop(self, kill=False): + self._set_status('Stopping') + + # Prevent discovering new devices whilst stopping + if self.get_net_orc().get_listener() is not None: + self.get_net_orc().get_listener().stop_listener() + self._stop_tests() self._stop_network(kill=kill) + self.get_session().reset() + def _register_exits(self): signal.signal(signal.SIGINT, self._exit_handler) signal.signal(signal.SIGTERM, self._exit_handler) @@ -146,54 +206,44 @@ def _exit_handler(self, signum, arg): # pylint: disable=unused-argument def _get_config_abs(self, config_file=None): if config_file is None: # If not defined, use relative pathing to local file - config_file = os.path.join(root_dir, CONFIG_FILE) + config_file = os.path.join(root_dir, self._config_file) # Expand the config file to absolute pathing return os.path.abspath(config_file) + def get_config_file(self): + return self._get_config_abs() + + def get_net_orc(self): + return self._net_orc + def _start_network(self): # Start the network orchestrator - self._net_orc.start() + if not self.get_net_orc().start(): + self.stop(kill=True) + sys.exit(1) def _stop_network(self, kill=False): - self._net_orc.stop(kill=kill) + self.get_net_orc().stop(kill=kill) def _stop_tests(self): self._test_orc.stop() - def _load_all_devices(self): - self._load_devices(device_dir=LOCAL_DEVICES_DIR) - self._load_devices(device_dir=RESOURCE_DEVICES_DIR) - - def _load_devices(self, device_dir): - LOGGER.debug('Loading devices from ' + device_dir) - - os.makedirs(device_dir, exist_ok=True) - util.run_command(f'chown -R {util.get_host_user()} {device_dir}') - - for device_folder in os.listdir(device_dir): - with open(os.path.join(device_dir, device_folder, DEVICE_CONFIG), - encoding='utf-8') as device_config_file: - device_config_json = json.load(device_config_file) - - device_manufacturer = device_config_json.get(DEVICE_MANUFACTURER) - device_model = device_config_json.get(DEVICE_MODEL) - mac_addr = device_config_json.get(DEVICE_MAC_ADDR) - test_modules = device_config_json.get(DEVICE_TEST_MODULES) - - device = Device(manufacturer=device_manufacturer, - model=device_model, - mac_addr=mac_addr, - test_modules=json.dumps(test_modules)) - self._devices.append(device) - def get_device(self, mac_addr): """Returns a loaded device object from the device mac address.""" - for device in self._devices: + for device in self._session.get_device_repository(): if device.mac_addr == mac_addr: return device + return None def _device_discovered(self, mac_addr): + + if self.get_session().get_target_device() is not None: + if mac_addr != self.get_session().get_target_device().mac_addr: + # Ignore discovered device + return + + self._set_status('Identifying device') device = self.get_device(mac_addr) if device is not None: LOGGER.info( @@ -207,4 +257,12 @@ def _device_discovered(self, mac_addr): def _device_stable(self, mac_addr): device = self.get_device(mac_addr) LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') + self._set_status('In progress') self._test_orc.run_test_modules(device) + self._set_status('Complete') + + def _set_status(self, status): + self._session.set_status(status) + + def get_session(self): + return self._session diff --git a/framework/python/src/net_orc/listener.py b/framework/python/src/net_orc/listener.py index 4f8e1961f..83805f908 100644 --- a/framework/python/src/net_orc/listener.py +++ b/framework/python/src/net_orc/listener.py @@ -31,8 +31,9 @@ class Listener: """Methods to start and stop the network listener.""" - def __init__(self, device_intf): - self._device_intf = device_intf + def __init__(self, session): + self._session = session + self._device_intf = self._session.get_device_interface() self._device_intf_mac = get_if_hwaddr(self._device_intf) self._sniffer = AsyncSniffer(iface=self._device_intf, @@ -47,7 +48,8 @@ def start_listener(self): def stop_listener(self): """Stop sniffing packets on the device interface.""" - self._sniffer.stop() + if self._sniffer.running: + self._sniffer.stop() def is_running(self): """Determine whether the sniffer is running.""" diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index 499ce954b..7d550d4ae 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -11,9 +11,9 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. + """Network orchestrator is responsible for managing all of the virtual network services""" -import getpass import ipaddress import json import os @@ -23,57 +23,42 @@ import sys import docker from docker.types import Mount -from common import logger -from common import util +from common import logger, util from net_orc.listener import Listener -from net_orc.network_device import NetworkDevice from net_orc.network_event import NetworkEvent from net_orc.network_validator import NetworkValidator from net_orc.ovs_control import OVSControl from net_orc.ip_control import IPControl LOGGER = logger.get_logger('net_orc') -CONFIG_FILE = 'local/system.json' -EXAMPLE_CONFIG_FILE = 'local/system.json.example' RUNTIME_DIR = 'runtime' TEST_DIR = 'test' -MONITOR_PCAP = 'monitor.pcap' NET_DIR = 'runtime/network' NETWORK_MODULES_DIR = 'modules/network' + +MONITOR_PCAP = 'monitor.pcap' NETWORK_MODULE_METADATA = 'conf/module_config.json' + DEVICE_BRIDGE = 'tr-d' INTERNET_BRIDGE = 'tr-c' PRIVATE_DOCKER_NET = 'tr-private-net' CONTAINER_NAME = 'network_orchestrator' -RUNTIME_KEY = 'runtime' -MONITOR_PERIOD_KEY = 'monitor_period' -STARTUP_TIMEOUT_KEY = 'startup_timeout' -DEFAULT_STARTUP_TIMEOUT = 60 -DEFAULT_RUNTIME = 1200 -DEFAULT_MONITOR_PERIOD = 300 - class NetworkOrchestrator: """Manage and controls a virtual testing network.""" def __init__(self, - config_file=CONFIG_FILE, + session, validate=True, single_intf=False): - self._runtime = DEFAULT_RUNTIME - self._startup_timeout = DEFAULT_STARTUP_TIMEOUT - self._monitor_period = DEFAULT_MONITOR_PERIOD + self._session = session self._monitor_in_progress = False - - self._int_intf = None - self._dev_intf = None + self._validate = validate self._single_intf = single_intf - self.listener = None + self._listener = None self._net_modules = [] - self._devices = [] - self.validate = validate self._path = os.path.dirname( os.path.dirname( @@ -83,8 +68,7 @@ def __init__(self, self.validator = NetworkValidator() shutil.rmtree(os.path.join(os.getcwd(), NET_DIR), ignore_errors=True) self.network_config = NetworkConfig() - self.load_config(config_file) - self._ovs = OVSControl() + self._ovs = OVSControl(self._session) self._ip_ctrl = IPControl() def start(self): @@ -102,23 +86,38 @@ def start(self): self.start_network() + return True + + def check_config(self): + + if not util.interface_exists(self._session.get_internet_interface()) or not util.interface_exists( + self._session.get_device_interface()): + LOGGER.error('Configured interfaces are not ready for use. ' + + 'Ensure both interfaces are connected.') + return False + return True + def start_network(self): """Start the virtual testing network.""" LOGGER.info('Starting network') self.build_network_modules() + self.create_net() self.start_network_services() - if self.validate: + if self._validate: # Start the validator after network is ready self.validator.start() # Get network ready (via Network orchestrator) LOGGER.debug('Network is ready') + def get_listener(self): + return self._listener + def start_listener(self): - self.listener.start_listener() + self.get_listener().start_listener() def stop(self, kill=False): """Stop the network orchestrator.""" @@ -136,43 +135,35 @@ def stop_network(self, kill=False): self.stop_networking_services(kill=kill) self.restore_net() - def load_config(self, config_file=None): - if config_file is None: - # If not defined, use relative pathing to local file - self._config_file = os.path.join(self._path, CONFIG_FILE) - else: - # If defined, use as provided - self._config_file = config_file - - if not os.path.isfile(self._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) + def _device_discovered(self, mac_addr): - LOGGER.info('Loading config file: ' + os.path.abspath(self._config_file)) - with open(self._config_file, encoding='UTF-8') as config_json_file: - config_json = json.load(config_json_file) - self.import_config(config_json) + device = self._session.get_device(mac_addr) - def _device_discovered(self, mac_addr): + if self._session.get_target_device() is not None: + if mac_addr != self._session.get_target_device().mac_addr: + # Ignore discovered device + return self._monitor_in_progress = True LOGGER.debug( f'Discovered device {mac_addr}. Waiting for device to obtain IP') - device = self._get_device(mac_addr=mac_addr) + if device is None: + LOGGER.debug(f'Device with MAC address {mac_addr} does not exist in device repository') + # Ignore device if not registered + return device_runtime_dir = os.path.join(RUNTIME_DIR, TEST_DIR, - device.mac_addr.replace(':', '')) + mac_addr.replace(':', '')) os.makedirs(device_runtime_dir) util.run_command(f'chown -R {self._host_user} {device_runtime_dir}') - packet_capture = sniff(iface=self._dev_intf, - timeout=self._startup_timeout, + packet_capture = sniff(iface=self._session.get_device_interface(), + timeout=self._session.get_startup_timeout(), stop_filter=self._device_has_ip) wrpcap( - os.path.join(RUNTIME_DIR, TEST_DIR, device.mac_addr.replace(':', ''), + os.path.join(RUNTIME_DIR, TEST_DIR, mac_addr.replace(':', ''), 'startup.pcap'), packet_capture) if device.ip_addr is None: @@ -189,49 +180,35 @@ def monitor_in_progress(self): return self._monitor_in_progress def _device_has_ip(self, packet): - device = self._get_device(mac_addr=packet.src) + device = self._session.get_device(mac_addr=packet.src) if device is None or device.ip_addr is None: return False return True def _dhcp_lease_ack(self, packet): mac_addr = packet[BOOTP].chaddr.hex(':')[0:17] - device = self._get_device(mac_addr=mac_addr) + device = self._session.get_device(mac_addr=mac_addr) + + # Ignore devices that are not registered + if device is None: + return + + # TODO: Check if device is None device.ip_addr = packet[BOOTP].yiaddr def _start_device_monitor(self, device): """Start a timer until the steady state has been reached and callback the steady state method for this device.""" LOGGER.info(f'Monitoring device with mac addr {device.mac_addr} ' - f'for {str(self._monitor_period)} seconds') + f'for {str(self._session.get_monitor_period())} seconds') - packet_capture = sniff(iface=self._dev_intf, timeout=self._monitor_period) + packet_capture = sniff(iface=self._session.get_device_interface(), timeout=self._session.get_monitor_period()) wrpcap( os.path.join(RUNTIME_DIR, TEST_DIR, device.mac_addr.replace(':', ''), 'monitor.pcap'), packet_capture) self._monitor_in_progress = False - self.listener.call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) - - def _get_device(self, mac_addr): - for device in self._devices: - if device.mac_addr == mac_addr: - return device - - device = NetworkDevice(mac_addr=mac_addr) - self._devices.append(device) - return device - - def import_config(self, json_config): - self._int_intf = json_config['network']['internet_intf'] - self._dev_intf = json_config['network']['device_intf'] - - if RUNTIME_KEY in json_config: - self._runtime = json_config[RUNTIME_KEY] - if STARTUP_TIMEOUT_KEY in json_config: - self._startup_timeout = json_config[STARTUP_TIMEOUT_KEY] - if MONITOR_PERIOD_KEY in json_config: - self._monitor_period = json_config[MONITOR_PERIOD_KEY] + self.get_listener().call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) def _check_network_services(self): LOGGER.debug('Checking network modules...') @@ -278,30 +255,30 @@ def _ci_pre_network_create(self): """ self._ethmac = subprocess.check_output( - f'cat /sys/class/net/{self._int_intf}/address', + f'cat /sys/class/net/{self._session.get_internet_interface()}/address', shell=True).decode('utf-8').strip() self._gateway = subprocess.check_output( 'ip route | head -n 1 | awk \'{print $3}\'', shell=True).decode('utf-8').strip() self._ipv4 = subprocess.check_output( - f'ip a show {self._int_intf} | grep \"inet \" | awk \'{{print $2}}\'', + f'ip a show {self._session.get_internet_interface()} | grep \"inet \" | awk \'{{print $2}}\'', shell=True).decode('utf-8').strip() self._ipv6 = subprocess.check_output( - f'ip a show {self._int_intf} | grep inet6 | awk \'{{print $2}}\'', + f'ip a show {self._session.get_internet_interface()} | grep inet6 | awk \'{{print $2}}\'', shell=True).decode('utf-8').strip() self._brd = subprocess.check_output( - f'ip a show {self._int_intf} | grep \"inet \" | awk \'{{print $4}}\'', + f'ip a show {self._session.get_internet_interface()} | grep \"inet \" | awk \'{{print $4}}\'', shell=True).decode('utf-8').strip() def _ci_post_network_create(self): """ Restore network connection in CI environment """ LOGGER.info('post cr') - util.run_command(f'ip address del {self._ipv4} dev {self._int_intf}') - util.run_command(f'ip -6 address del {self._ipv6} dev {self._int_intf}') + util.run_command(f'ip address del {self._ipv4} dev {self._session.get_internet_interface()}') + util.run_command(f'ip -6 address del {self._ipv6} dev {self._session.get_internet_interface()}') util.run_command( - f'ip link set dev {self._int_intf} address 00:B0:D0:63:C2:26') - util.run_command(f'ip addr flush dev {self._int_intf}') - util.run_command(f'ip addr add dev {self._int_intf} 0.0.0.0') + f'ip link set dev {self._session.get_internet_interface()} address 00:B0:D0:63:C2:26') + util.run_command(f'ip addr flush dev {self._session.get_internet_interface()}') + util.run_command(f'ip addr add dev {self._session.get_internet_interface()} 0.0.0.0') util.run_command( f'ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}') util.run_command(f'ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ') @@ -316,17 +293,11 @@ def _ci_post_network_create(self): def create_net(self): LOGGER.info('Creating baseline network') - if not util.interface_exists(self._int_intf) or not util.interface_exists( - self._dev_intf): - LOGGER.error('Configured interfaces are not ready for use. ' + - 'Ensure both interfaces are connected.') - sys.exit(1) - if self._single_intf: self._ci_pre_network_create() # Remove IP from internet adapter - util.run_command('ifconfig ' + self._int_intf + ' 0.0.0.0') + util.run_command('ifconfig ' + self._session.get_internet_interface() + ' 0.0.0.0') # Setup the virtual network if not self._ovs.create_baseline_net(verify=True): @@ -339,10 +310,10 @@ def create_net(self): self._create_private_net() - self.listener = Listener(self._dev_intf) - self.listener.register_callback(self._device_discovered, + self._listener = Listener(self._session) + self.get_listener().register_callback(self._device_discovered, [NetworkEvent.DEVICE_DISCOVERED]) - self.listener.register_callback(self._dhcp_lease_ack, + self.get_listener().register_callback(self._dhcp_lease_ack, [NetworkEvent.DHCP_LEASE_ACK]) def load_network_modules(self): @@ -661,9 +632,8 @@ def restore_net(self): LOGGER.info('Clearing baseline network') - if hasattr(self, 'listener' - ) and self.listener is not None and self.listener.is_running(): - self.listener.stop_listener() + if hasattr(self, 'listener') and self.get_listener() is not None and self.get_listener().is_running(): + self.get_listener().stop_listener() client = docker.from_env() @@ -681,10 +651,12 @@ def restore_net(self): # Clean up any existing network artifacts self._ip_ctrl.clean_all() + internet_intf = self._session.get_internet_interface() + # Restart internet interface - if util.interface_exists(self._int_intf): - util.run_command('ip link set ' + self._int_intf + ' down') - util.run_command('ip link set ' + self._int_intf + ' up') + if util.interface_exists(internet_intf): + util.run_command('ip link set ' + internet_intf + ' down') + util.run_command('ip link set ' + internet_intf + ' up') LOGGER.info('Network is restored') @@ -712,10 +684,6 @@ def __init__(self): self.net_config = NetworkModuleNetConfig() - -# The networking configuration for a network module - - class NetworkModuleNetConfig: """Define all the properties of the network config for a network module""" @@ -738,10 +706,6 @@ def get_ipv4_addr_with_prefix(self): def get_ipv6_addr_with_prefix(self): return format(self.ipv6_address) + '/' + str(self.ipv6_network.prefixlen) - -# Represents the current configuration of the network for the device bridge - - class NetworkConfig: """Define all the properties of the network configuration""" diff --git a/framework/python/src/net_orc/ovs_control.py b/framework/python/src/net_orc/ovs_control.py index 83823e8fa..c48e58e3b 100644 --- a/framework/python/src/net_orc/ovs_control.py +++ b/framework/python/src/net_orc/ovs_control.py @@ -18,7 +18,6 @@ from common import logger from common import util -CONFIG_FILE = 'local/system.json' DEVICE_BRIDGE = 'tr-d' INTERNET_BRIDGE = 'tr-c' LOGGER = logger.get_logger('ovs_ctrl') @@ -27,10 +26,8 @@ class OVSControl: """OVS Control""" - def __init__(self): - self._int_intf = None - self._dev_intf = None - self._load_config() + def __init__(self, session): + self._session = session def add_bridge(self, bridge_name): LOGGER.debug('Adding OVS bridge: ' + bridge_name) @@ -80,11 +77,11 @@ def validate_baseline_network(self): LOGGER.debug('Validating baseline network') # Verify the device bridge - dev_bridge = self.verify_bridge(DEVICE_BRIDGE, [self._dev_intf]) + dev_bridge = self.verify_bridge(DEVICE_BRIDGE, [self._session.get_device_interface()]) LOGGER.debug('Device bridge verified: ' + str(dev_bridge)) # Verify the internet bridge - int_bridge = self.verify_bridge(INTERNET_BRIDGE, [self._int_intf]) + int_bridge = self.verify_bridge(INTERNET_BRIDGE, [self._session.get_internet_interface()]) LOGGER.debug('Internet bridge verified: ' + str(int_bridge)) return dev_bridge and int_bridge @@ -107,7 +104,7 @@ def create_baseline_net(self, verify=True): LOGGER.debug('Creating baseline network') # Remove IP from internet adapter - self.set_interface_ip(interface=self._int_intf, ip_addr='0.0.0.0') + self.set_interface_ip(interface=self._session.get_internet_interface(), ip_addr='0.0.0.0') # Create data plane self.add_bridge(DEVICE_BRIDGE) @@ -116,11 +113,11 @@ def create_baseline_net(self, verify=True): self.add_bridge(INTERNET_BRIDGE) # Remove IP from internet adapter - self.set_interface_ip(self._int_intf, '0.0.0.0') + self.set_interface_ip(self._session.get_internet_interface(), '0.0.0.0') # Add external interfaces to data and control plane - self.add_port(self._dev_intf, DEVICE_BRIDGE) - self.add_port(self._int_intf, INTERNET_BRIDGE) + self.add_port(self._session.get_device_interface(), DEVICE_BRIDGE) + self.add_port(self._session.get_internet_interface(), INTERNET_BRIDGE) # Enable forwarding of eapol packets self.add_flow(bridge_name=DEVICE_BRIDGE, @@ -145,20 +142,6 @@ def delete_bridge(self, bridge_name): success = util.run_command('ovs-vsctl --if-exists del-br ' + bridge_name) return success - def _load_config(self): - path = os.path.dirname(os.path.dirname( - os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) - config_file = os.path.join(path, CONFIG_FILE) - LOGGER.debug('Loading configuration: ' + config_file) - with open(config_file, 'r', encoding='utf-8') as conf_file: - config_json = json.load(conf_file) - self._int_intf = config_json['network']['internet_intf'] - self._dev_intf = config_json['network']['device_intf'] - LOGGER.debug('Configuration loaded') - LOGGER.debug('Internet interface: ' + self._int_intf) - LOGGER.debug('Device interface: ' + self._dev_intf) - def restore_net(self): LOGGER.debug('Restoring network...') # Delete data plane diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index fef4e5bb5..74e399df1 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -32,9 +32,10 @@ class TestOrchestrator: """Manages and controls the test modules.""" - def __init__(self, net_orc): + def __init__(self, session, net_orc): self._test_modules = [] self._module_config = None + self._session = session self._net_orc = net_orc self._test_in_progress = False @@ -45,7 +46,6 @@ def __init__(self, net_orc): # Resolve the path to the test-run folder #self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) - self._root_path = os.path.dirname(os.path.dirname( os.path.dirname( os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) @@ -117,7 +117,7 @@ def test_in_progress(self): def _is_module_enabled(self, module, device): enabled = True if device.test_modules is not None: - test_modules = json.loads(device.test_modules) + test_modules = device.test_modules if module.name in test_modules: if "enabled" in test_modules[module.name]: enabled = test_modules[module.name]["enabled"] @@ -182,7 +182,7 @@ def _run_test_module(self, module, device): environment={ "HOST_USER": self._host_user, "DEVICE_MAC": device.mac_addr, - "DEVICE_TEST_MODULES": device.test_modules, + "DEVICE_TEST_MODULES": json.dumps(device.test_modules), "IPV4_SUBNET": self._net_orc.network_config.ipv4_network, "IPV6_SUBNET": self._net_orc.network_config.ipv6_network }) @@ -201,8 +201,15 @@ def _run_test_module(self, module, device): test_module_timeout = time.time() + module.timeout status = self._get_module_status(module) - while time.time() < test_module_timeout and status == "running": - time.sleep(1) + log_stream = module.container.logs(stream=True, stdout=True, stderr=True) + while (time.time() < test_module_timeout and + status == "running" and + self._session.get_status() == "In progress"): + try: + line = next(log_stream).decode("utf-8").strip() + print(line) + except Exception: + time.sleep(1) status = self._get_module_status(module) LOGGER.info("Test module " + module.name + " has finished") diff --git a/framework/requirements.txt b/framework/requirements.txt index 03eab9796..560c2baf9 100644 --- a/framework/requirements.txt +++ b/framework/requirements.txt @@ -5,4 +5,10 @@ requests<2.29.0 docker ipaddress netifaces -scapy \ No newline at end of file +scapy + +# Requirements for the API +fastapi==0.99.1 +psutil +uvicorn +pydantic==1.10.11 \ No newline at end of file diff --git a/modules/test/base/base.Dockerfile b/modules/test/base/base.Dockerfile index 10344cbc7..62ff54d6c 100644 --- a/modules/test/base/base.Dockerfile +++ b/modules/test/base/base.Dockerfile @@ -45,4 +45,4 @@ COPY $NET_MODULE_DIR/dhcp-1/$NET_MODULE_PROTO_DIR $CONTAINER_PROTO_DIR/dhcp1/ COPY $NET_MODULE_DIR/dhcp-2/$NET_MODULE_PROTO_DIR $CONTAINER_PROTO_DIR/dhcp2/ # Start the test module -ENTRYPOINT [ "/testrun/bin/start_module" ] \ No newline at end of file +ENTRYPOINT [ "/testrun/bin/start" ] \ No newline at end of file diff --git a/modules/test/base/bin/capture b/modules/test/base/bin/capture index 69fa916c3..e237f3d72 100644 --- a/modules/test/base/bin/capture +++ b/modules/test/base/bin/capture @@ -27,7 +27,7 @@ INTERFACE=$2 # Create the output directory and start the capture mkdir -p $PCAP_DIR chown $HOST_USER $PCAP_DIR -tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & +tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & 2>&1 /dev/null # Small pause to let the capture to start sleep 1 \ No newline at end of file diff --git a/modules/test/base/bin/setup_binaries b/modules/test/base/bin/setup_binaries index 6af744693..eaccf9de6 100644 --- a/modules/test/base/bin/setup_binaries +++ b/modules/test/base/bin/setup_binaries @@ -18,7 +18,7 @@ BIN_DIR=$1 # Remove incorrect line endings -dos2unix $BIN_DIR/* +dos2unix $BIN_DIR/* >/dev/null 2>&1 # Make sure all the bin files are executable chmod u+x $BIN_DIR/* \ No newline at end of file diff --git a/framework/python/src/net_orc/network_device.py b/modules/test/base/bin/start old mode 100644 new mode 100755 similarity index 71% rename from framework/python/src/net_orc/network_device.py rename to modules/test/base/bin/start index f17ac0f0d..6869d1116 --- a/framework/python/src/net_orc/network_device.py +++ b/modules/test/base/bin/start @@ -1,24 +1,17 @@ -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Track device object information.""" -from dataclasses import dataclass - - -@dataclass -class NetworkDevice: - """Represents a physical device and it's configuration.""" - - mac_addr: str - ip_addr: str = None +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +/testrun/bin/start_module > /dev/null \ No newline at end of file diff --git a/modules/test/base/bin/start_module b/modules/test/base/bin/start_module index 82c9d26bf..69f399feb 100644 --- a/modules/test/base/bin/start_module +++ b/modules/test/base/bin/start_module @@ -99,4 +99,4 @@ fi sleep 3 # Start the networking service -$BIN_DIR/start_test_module $MODULE_NAME $IFACE \ No newline at end of file +$BIN_DIR/start_test_module $MODULE_NAME $IFACE > /runtime/output/container.log \ No newline at end of file diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index e949976fa..6ff4f815b 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -61,8 +61,6 @@ def _get_device_tests(self, device_test_module): if 'tests' in device_test_module: if test['name'] in device_test_module['tests']: dev_test_config = device_test_module['tests'][test['name']] - if 'enabled' in dev_test_config: - test['enabled'] = dev_test_config['enabled'] if 'config' in test and 'config' in dev_test_config: test['config'].update(dev_test_config['config']) return module_tests @@ -83,19 +81,17 @@ def run_tests(self): test_method_name = '_' + test['name'].replace('.', '_') result = None test['start'] = datetime.now().isoformat() - if ('enabled' in test and test['enabled']) or 'enabled' not in test: - LOGGER.info('Attempting to run test: ' + test['name']) - # Resolve the correct python method by test name and run test - if hasattr(self, test_method_name): - if 'config' in test: - result = getattr(self, test_method_name)(config=test['config']) - else: - result = getattr(self, test_method_name)() + LOGGER.info('Attempting to run test: ' + test['name']) + # Resolve the correct python method by test name and run test + if hasattr(self, test_method_name): + if 'config' in test: + result = getattr(self, test_method_name)(config=test['config']) else: - LOGGER.info(f'Test {test["name"]} not resolved. Skipping') - result = None + result = getattr(self, test_method_name)() else: - LOGGER.info(f'Test {test["name"]} disabled. Skipping') + LOGGER.info(f'Test {test["name"]} not resolved. Skipping') + result = None + if result is not None: if isinstance(result, bool): test['result'] = 'compliant' if result else 'non-compliant' diff --git a/modules/test/conn/bin/start_test_module b/modules/test/conn/bin/start_test_module index 0df510b86..d85ae7d6b 100644 --- a/modules/test/conn/bin/start_test_module +++ b/modules/test/conn/bin/start_test_module @@ -45,7 +45,7 @@ touch $RESULT_FILE chown $HOST_USER $LOG_FILE chown $HOST_USER $RESULT_FILE -# Run the python scrip that will execute the tests for this module +# Run the python script that will execute the tests for this module # -u flag allows python print statements # to be logged by docker by running unbuffered python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 419fba68a..d432d2131 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -27,7 +27,6 @@ STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' SLAAC_PREFIX = 'fd10:77be:4186' - TR_CONTAINER_MAC_PREFIX = '9a:02:57:1e:8f:' @@ -132,10 +131,10 @@ def _connection_single_ip(self): LOGGER.info('Inspecting: ' + str(len(packets)) + ' packets') for packet in packets: # Option[1] = message-type, option 3 = DHCPREQUEST - if DHCP in packet and packet[DHCP].options[0][1] == 3: - mac_address = packet[Ether].src - if not mac_address.startswith(TR_CONTAINER_MAC_PREFIX): - mac_addresses.add(mac_address.upper()) + if DHCP in packet and packet[DHCP].options[0][1] == 3: + mac_address = packet[Ether].src + if not mac_address.startswith(TR_CONTAINER_MAC_PREFIX): + mac_addresses.add(mac_address.upper()) # Check if the device mac address is in the list of DHCPREQUESTs result = self._device_mac.upper() in mac_addresses @@ -349,7 +348,6 @@ def _run_subnet_test(self,config): return final_result, final_result_details - def _test_subnet(self, subnet, lease): if self._change_subnet(subnet): expiration = datetime.strptime(lease['expires'], '%Y-%m-%d %H:%M:%S') diff --git a/modules/test/dns/python/src/dns_module.py b/modules/test/dns/python/src/dns_module.py index 8d32d4dfb..aecbd5bd1 100644 --- a/modules/test/dns/python/src/dns_module.py +++ b/modules/test/dns/python/src/dns_module.py @@ -55,8 +55,7 @@ def _dns_network_from_dhcp(self): self._dns_server) # Check if the device DNS traffic is to appropriate server - tcpdump_filter = (f'dst port 53 and dst host {self._dns_server}', - f' and ether src {self._device_mac}') + tcpdump_filter = f'dst port 53 and dst host {self._dns_server} and ether src {self._device_mac}' result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) diff --git a/modules/ui/conf/nginx.conf b/modules/ui/conf/nginx.conf new file mode 100644 index 000000000..ade6ad17a --- /dev/null +++ b/modules/ui/conf/nginx.conf @@ -0,0 +1,13 @@ +events{} +http { + include /etc/nginx/mime.types; + server { + listen 80; + server_name localhost; + root /usr/share/nginx/html; + index index.html; + location / { + try_files $uri $uri/ /index.html; + } + } +} \ No newline at end of file diff --git a/modules/ui/ui.Dockerfile b/modules/ui/ui.Dockerfile new file mode 100644 index 000000000..f65f4c48b --- /dev/null +++ b/modules/ui/ui.Dockerfile @@ -0,0 +1,19 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Image name: test-run/ui +FROM nginx:1.25.1 + +COPY modules/ui/conf/nginx.conf /etc/nginx/nginx.conf +COPY ui /usr/share/nginx/html \ No newline at end of file diff --git a/resources/devices/template/device_config.json b/resources/devices/template/device_config.json index 1e92de25d..7ee63cf95 100644 --- a/resources/devices/template/device_config.json +++ b/resources/devices/template/device_config.json @@ -4,176 +4,19 @@ "mac_addr": "aa:bb:cc:dd:ee:ff", "test_modules": { "dns": { - "enabled": true, - "tests": { - "dns.network.from_device": { - "enabled": true - }, - "dns.network.from_dhcp": { - "enabled": true - } - } + "enabled": true }, "connection": { - "enabled": true, - "tests": { - "connection.mac_address": { - "enabled": true - }, - "connection.mac_oui": { - "enabled": true - }, - "connection.target_ping": { - "enabled": true - } - , - "connection.single_ip": { - "enabled": true - } - } + "enabled": true }, "ntp": { - "enabled": true, - "tests": { - "ntp.network.ntp_support": { - "enabled": true - }, - "ntp.network.ntp_dhcp": { - "enabled": true - } - } + "enabled": true }, "baseline": { - "enabled": false, - "tests": { - "baseline.non-compliant": { - "enabled": true - }, - "baseline.pass": { - "enabled": true - }, - "baseline.skip": { - "enabled": true - } - } + "enabled": false }, "nmap": { - "enabled": true, - "tests": { - "security.nmap.ports": { - "enabled": true, - "security.services.ftp": { - "tcp_ports": { - "20": { - "allowed": false - }, - "21": { - "allowed": false - } - } - }, - "security.services.ssh": { - "tcp_ports": { - "22": { - "allowed": true - } - } - }, - "security.services.telnet": { - "tcp_ports": { - "23": { - "allowed": false - } - } - }, - "security.services.smtp": { - "tcp_ports": { - "25": { - "allowed": false - }, - "465": { - "allowed": false - }, - "587": { - "allowed": false - } - } - }, - "security.services.http": { - "tcp_ports": { - "80": { - "allowed": false - }, - "443": { - "allowed": true - } - } - }, - "security.services.pop": { - "tcp_ports": { - "110": { - "allowed": false - } - } - }, - "security.services.imap": { - "tcp_ports": { - "143": { - "allowed": false - } - } - }, - "security.services.snmpv3": { - "tcp_ports": { - "161": { - "allowed": false - }, - "162": { - "allowed": false - } - }, - "udp_ports": { - "161": { - "allowed": false - }, - "162": { - "allowed": false - } - } - }, - "security.services.https": { - "tcp_ports": { - "80": { - "allowed": false - } - } - }, - "security.services.vnc": { - "tcp_ports": { - "5500": { - "allowed": false - }, - "5800": { - "allowed": false - } - } - }, - "security.services.tftp": { - "udp_ports": { - "69": { - "allowed": false - } - } - }, - "security.services.ntp": { - "udp_ports": { - "123": { - "allowed": false - } - } - } - } - } + "enabled": true } } } diff --git a/testing/test_baseline b/testing/baseline/test_baseline similarity index 95% rename from testing/test_baseline rename to testing/baseline/test_baseline index 2b95ded23..61d0f9b56 100755 --- a/testing/test_baseline +++ b/testing/baseline/test_baseline @@ -48,7 +48,7 @@ EOF sudo cmd/install -sudo cmd/start --single-intf > $TESTRUN_OUT 2>&1 & +sudo bin/testrun --single-intf --no-ui > $TESTRUN_OUT 2>&1 & TPID=$! # Time to wait for testrun to be ready @@ -80,6 +80,6 @@ echo "Done baseline test" more $TESTRUN_OUT -pytest testing/test_baseline.py +pytest testing/baseline/test_baseline.py exit $? \ No newline at end of file diff --git a/testing/test_baseline.py b/testing/baseline/test_baseline.py similarity index 100% rename from testing/test_baseline.py rename to testing/baseline/test_baseline.py diff --git a/testing/device_configs/tester1/device_config.json b/testing/device_configs/tester1/device_config.json new file mode 100644 index 000000000..268399b72 --- /dev/null +++ b/testing/device_configs/tester1/device_config.json @@ -0,0 +1,22 @@ +{ + "manufacturer": "Google", + "model": "Tester 1", + "mac_addr": "02:42:aa:00:00:01", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": false + }, + "ntp": { + "enabled": false + }, + "baseline": { + "enabled": false + }, + "nmap": { + "enabled": true + } + } +} diff --git a/testing/device_configs/tester2/device_config.json b/testing/device_configs/tester2/device_config.json new file mode 100644 index 000000000..8b090d80a --- /dev/null +++ b/testing/device_configs/tester2/device_config.json @@ -0,0 +1,22 @@ +{ + "manufacturer": "Google", + "model": "Tester 2", + "mac_addr": "02:42:aa:00:00:02", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": false + }, + "ntp": { + "enabled": true + }, + "baseline": { + "enabled": false + }, + "nmap": { + "enabled": true + } + } +} diff --git a/testing/docker/ci_test_device1/Dockerfile b/testing/docker/ci_test_device1/Dockerfile index 4328946fd..93c0e7131 100644 --- a/testing/docker/ci_test_device1/Dockerfile +++ b/testing/docker/ci_test_device1/Dockerfile @@ -1,10 +1,12 @@ FROM ubuntu:jammy -ENV DEBIAN_FRONTEND=noninteractive -#Update and get all additional requirements not contained in the base image + +ENV DEBIAN_FRONTEND=noninteractive + +#Update and get all additional requirements not contained in the base image RUN apt-get update && apt-get -y upgrade -RUN apt-get update && apt-get install -y isc-dhcp-client ntpdate coreutils moreutils inetutils-ping curl jq dnsutils openssl netcat-openbsd +RUN apt-get update && apt-get install -y isc-dhcp-client ntpdate coreutils moreutils inetutils-ping curl jq dnsutils openssl netcat-openbsd COPY entrypoint.sh /entrypoint.sh diff --git a/testing/test_pylint b/testing/pylint/test_pylint similarity index 100% rename from testing/test_pylint rename to testing/pylint/test_pylint diff --git a/testing/example/mac b/testing/tests/example/mac similarity index 100% rename from testing/example/mac rename to testing/tests/example/mac diff --git a/testing/example/mac1/results.json b/testing/tests/example/mac1/results.json similarity index 100% rename from testing/example/mac1/results.json rename to testing/tests/example/mac1/results.json diff --git a/testing/test_tests b/testing/tests/test_tests similarity index 93% rename from testing/test_tests rename to testing/tests/test_tests index ed14f1043..be7a3cef3 100755 --- a/testing/test_tests +++ b/testing/tests/test_tests @@ -17,7 +17,7 @@ set -o xtrace ip a TEST_DIR=/tmp/results -MATRIX=testing/test_tests.json +MATRIX=testing/tests/test_tests.json mkdir -p $TEST_DIR @@ -50,6 +50,9 @@ cat <local/system.json } EOF +mkdir -p local/devices +cp -r testing/device_configs/* local/devices + sudo cmd/install TESTERS=$(jq -r 'keys[]' $MATRIX) @@ -62,7 +65,7 @@ for tester in $TESTERS; do args=$(jq -r .$tester.args $MATRIX) touch $testrun_log - sudo timeout 900 cmd/start --single-intf > $testrun_log 2>&1 & + sudo timeout 900 bin/testrun --single-intf --no-ui > $testrun_log 2>&1 & TPID=$! # Time to wait for testrun to be ready @@ -115,6 +118,6 @@ for tester in $TESTERS; do done -pytest -v testing/test_tests.py +pytest -v testing/tests/test_tests.py exit $? diff --git a/testing/test_tests.json b/testing/tests/test_tests.json similarity index 100% rename from testing/test_tests.json rename to testing/tests/test_tests.json diff --git a/testing/test_tests.py b/testing/tests/test_tests.py similarity index 92% rename from testing/test_tests.py rename to testing/tests/test_tests.py index b61fdf064..1f484647a 100644 --- a/testing/test_tests.py +++ b/testing/tests/test_tests.py @@ -29,7 +29,7 @@ TEST_MATRIX = 'test_tests.json' RESULTS_PATH = '/tmp/results/*.json' -#TODO add reason +#TODO add reason @dataclass(frozen=True) class TestResult: name: str @@ -80,14 +80,14 @@ def test_list_tests(capsys, results, test_matrix): all_tests = set(itertools.chain.from_iterable( [collect_actual_results(results[x]) for x in results.keys()])) - ci_pass = set([test - for testers in test_matrix.values() - for test, result in testers['expected_results'].items() + ci_pass = set([test + for testers in test_matrix.values() + for test, result in testers['expected_results'].items() if result == 'compliant']) - ci_fail = set([test - for testers in test_matrix.values() - for test, result in testers['expected_results'].items() + ci_fail = set([test + for testers in test_matrix.values() + for test, result in testers['expected_results'].items() if result == 'non-compliant']) with capsys.disabled(): diff --git a/testing/unit_test/run_tests.sh b/testing/unit/run_tests.sh similarity index 100% rename from testing/unit_test/run_tests.sh rename to testing/unit/run_tests.sh diff --git a/ui/index.html b/ui/index.html new file mode 100644 index 000000000..285fce5ad --- /dev/null +++ b/ui/index.html @@ -0,0 +1 @@ +Test Run \ No newline at end of file From 0023003ed0a709e1880e287102b6e22f4091a344 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Wed, 2 Aug 2023 09:55:06 -0700 Subject: [PATCH 061/400] Dhcp tests (#81) * Separate dhcp control methods into their own module Implement ip change test Add place holder for dhcp failover test * Stabilize network before leaving ip_change test Add dhcp_failover test * fix regression issue with individual test enable/disable setting * fix gitignore --- .gitignore | 3 +- local/.gitignore | 3 +- modules/test/base/python/src/test_module.py | 22 +- modules/test/conn/conf/module_config.json | 10 + .../test/conn/python/src/connection_module.py | 99 +++++++- modules/test/conn/python/src/dhcp_util.py | 214 ++++++++++++++++++ 6 files changed, 331 insertions(+), 20 deletions(-) create mode 100644 modules/test/conn/python/src/dhcp_util.py diff --git a/.gitignore b/.gitignore index e168ec07a..5a216522f 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ venv/ error pylint.out __pycache__/ -build/ \ No newline at end of file +build/ +testing/unit_test/temp \ No newline at end of file diff --git a/local/.gitignore b/local/.gitignore index 4fb365c03..f13ce8d85 100644 --- a/local/.gitignore +++ b/local/.gitignore @@ -1,2 +1,3 @@ system.json -devices \ No newline at end of file +devices +root_certs \ No newline at end of file diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index 6ff4f815b..e949976fa 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -61,6 +61,8 @@ def _get_device_tests(self, device_test_module): if 'tests' in device_test_module: if test['name'] in device_test_module['tests']: dev_test_config = device_test_module['tests'][test['name']] + if 'enabled' in dev_test_config: + test['enabled'] = dev_test_config['enabled'] if 'config' in test and 'config' in dev_test_config: test['config'].update(dev_test_config['config']) return module_tests @@ -81,17 +83,19 @@ def run_tests(self): test_method_name = '_' + test['name'].replace('.', '_') result = None test['start'] = datetime.now().isoformat() - LOGGER.info('Attempting to run test: ' + test['name']) - # Resolve the correct python method by test name and run test - if hasattr(self, test_method_name): - if 'config' in test: - result = getattr(self, test_method_name)(config=test['config']) + if ('enabled' in test and test['enabled']) or 'enabled' not in test: + LOGGER.info('Attempting to run test: ' + test['name']) + # Resolve the correct python method by test name and run test + if hasattr(self, test_method_name): + if 'config' in test: + result = getattr(self, test_method_name)(config=test['config']) + else: + result = getattr(self, test_method_name)() else: - result = getattr(self, test_method_name)() + LOGGER.info(f'Test {test["name"]} not resolved. Skipping') + result = None else: - LOGGER.info(f'Test {test["name"]} not resolved. Skipping') - result = None - + LOGGER.info(f'Test {test["name"]} disabled. Skipping') if result is not None: if isinstance(result, bool): test['result'] = 'compliant' if result else 'non-compliant' diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index 86e1849af..3e06cc891 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -71,6 +71,16 @@ "description": "The device under test responds to an ICMP echo (ping) request.", "expected_behavior": "The device under test responds to an ICMP echo (ping) request." }, + { + "name": "connection.ipaddr.ip_change", + "description": "The device responds to a ping (ICMP echo request) to the new IP address it has received after the initial dHCP lease has expired.", + "expected_behavior": "If the lease expires before the client receiveds a DHCPACK, the client moves to INIT state, MUST immediately stop any other network processing and requires network initialization parameters as if the client were uninitialized. If the client then receives a DHCPACK allocating the client its previous network addres, the client SHOULD continue network processing. If the client is given a new network address, it MUST NOT continue using the previous network address and SHOULD notify the local users of the problem." + }, + { + "name": "connection.ipaddr.dhcp_failover", + "description": "The device has requested a DHCPREQUEST/REBIND to the DHCP failover server after the primary DHCP server has been brought down.", + "expected_behavior": "" + }, { "name": "connection.ipv6_slaac", "description": "The device forms a valid IPv6 address as a combination of the IPv6 router prefix and the device interface identifier", diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index d432d2131..169fb98c3 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -20,6 +20,7 @@ from test_module import TestModule from dhcp1.client import Client as DHCPClient1 from dhcp2.client import Client as DHCPClient2 +from dhcp_util import DHCPUtil LOG_NAME = 'test_connection' LOGGER = None @@ -39,6 +40,7 @@ def __init__(self, module): LOGGER = self._get_logger() self.dhcp1_client = DHCPClient1() self.dhcp2_client = DHCPClient2() + self._dhcp_util = DHCPUtil(self.dhcp1_client, self.dhcp2_client, LOGGER) # ToDo: Move this into some level of testing, leave for # reference until tests are implemented with these calls @@ -131,7 +133,7 @@ def _connection_single_ip(self): LOGGER.info('Inspecting: ' + str(len(packets)) + ' packets') for packet in packets: # Option[1] = message-type, option 3 = DHCPREQUEST - if DHCP in packet and packet[DHCP].options[0][1] == 3: + if DHCP in packet and packet[DHCP].options[0][1] == 3: mac_address = packet[Ether].src if not mac_address.startswith(TR_CONTAINER_MAC_PREFIX): mac_addresses.add(mac_address.upper()) @@ -151,7 +153,7 @@ def _connection_target_ping(self): # If the ipv4 address wasn't resolved yet, try again if self._device_ipv4_addr is None: - self._device_ipv4_addr = self._get_device_ipv4(self) + self._device_ipv4_addr = self._get_device_ipv4() if self._device_ipv4_addr is None: LOGGER.error('No device IP could be resolved') @@ -159,6 +161,85 @@ def _connection_target_ping(self): else: return self._ping(self._device_ipv4_addr) + def _connection_ipaddr_ip_change(self): + result = None + LOGGER.info('Running connection.ipaddr.ip_change') + if self._dhcp_util.setup_single_dhcp_server(): + lease = self._dhcp_util.get_cur_lease(self._device_mac) + if lease is not None: + LOGGER.info('Current device lease resolved: ' + str(lease)) + # Figure out how to calculate a valid IP address + ip_address = '10.10.10.30' + if self._dhcp_util.add_reserved_lease(lease['hostname'], + lease['hw_addr'], ip_address): + self._dhcp_util.wait_for_lease_expire(lease) + LOGGER.info('Checking device accepted new ip') + for _ in range(5): + LOGGER.info('Pinging device at IP: ' + ip_address) + if self._ping(ip_address): + LOGGER.info('Ping Success') + LOGGER.info('Reserved lease confirmed active in device') + result = True, 'Device has accepted an IP address change' + LOGGER.info('Restoring DHCP failover configuration') + break + else: + LOGGER.info('Device did not respond to ping') + result = False, 'Device did not accept IP address change' + time.sleep(5) # Wait 5 seconds before trying again + self._dhcp_util.delete_reserved_lease(lease['hw_addr']) + else: + result = None, 'Failed to create reserved lease for device' + else: + result = None, 'Device has no current DHCP lease' + # Restore the network + self._dhcp_util.restore_failover_dhcp_server() + LOGGER.info("Waiting 30 seconds for reserved lease to expire") + time.sleep(30) + self._dhcp_util.get_new_lease(self._device_mac) + else: + result = None, 'Failed to configure network for test' + return result + + def _connection_ipaddr_dhcp_failover(self): + result = None + # Confirm that both servers are online + primary_status = self._dhcp_util.get_dhcp_server_status( + dhcp_server_primary=True) + secondary_status = self._dhcp_util.get_dhcp_server_status( + dhcp_server_primary=False) + if primary_status and secondary_status: + lease = self._dhcp_util.get_cur_lease(self._device_mac) + if lease is not None: + LOGGER.info('Current device lease resolved: ' + str(lease)) + if self._dhcp_util.is_lease_active(lease): + # Shutdown the primary server + if self._dhcp_util.stop_dhcp_server(dhcp_server_primary=True): + # Wait until the current lease is expired + self._dhcp_util.wait_for_lease_expire(lease) + # Make sure the device has received a new lease from the + # secondary server + if self._dhcp_util.get_new_lease(self._device_mac, + dhcp_server_primary=False): + if self._dhcp_util.is_lease_active(lease): + result = True, ('Secondary DHCP server lease confirmed active ' + 'in device') + else: + result = False, 'Could not validate lease is active in device' + else: + result = False, ('Device did not recieve a new lease from ' + 'secondary DHCP server') + self._dhcp_util.start_dhcp_server(dhcp_server_primary=True) + else: + result = None, 'Failed to shutdown primary DHCP server' + else: + result = False, 'Device did not respond to ping' + else: + result = None, 'Device has no current DHCP lease' + else: + LOGGER.error('Network is not ready for this test. Skipping') + result = None, 'Network is not ready for this test' + return result + def _get_oui_manufacturer(self, mac_address): # Do some quick fixes on the format of the mac_address # to match the oui file pattern @@ -207,7 +288,7 @@ def _connection_ipv6_ping(self): return False def _ping(self, host): - cmd = "ping -c 1 " + str(host) + cmd = 'ping -c 1 ' + str(host) success = util.run_command(cmd, output=False) return success @@ -275,7 +356,7 @@ def is_ip_in_range(self, ip, start_ip, end_ip): return start_int <= ip_int <= end_int - def _run_subnet_test(self,config): + def _run_subnet_test(self, config): # Resolve the configured dhcp subnet ranges ranges = None if 'ranges' in config: @@ -292,9 +373,9 @@ def _run_subnet_test(self,config): LOGGER.info('Current DHCP subnet range: ' + str(cur_range)) else: LOGGER.error('Failed to resolve current subnet range required ' - 'for restoring network') + 'for restoring network') return None, ('Failed to resolve current subnet range required ' - 'for restoring network') + 'for restoring network') results = [] dhcp_setup = self.setup_single_dhcp_server() @@ -343,7 +424,7 @@ def _run_subnet_test(self,config): LOGGER.info('New lease not found. Waiting to check again') time.sleep(5) - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 LOGGER.error('Failed to restore DHCP server configuration: ' + str(e)) return final_result, final_result_details @@ -401,7 +482,7 @@ def _get_cur_lease(self): LOGGER.info('Checking current device lease') response = self.dhcp1_client.get_lease(self._device_mac) if response.code == 200: - lease = eval(response.message) # pylint: disable=W0123 + lease = eval(response.message) # pylint: disable=W0123 if lease: # Check if non-empty lease return lease else: @@ -439,7 +520,7 @@ def test_subnets(self, subnets): 'details': 'Subnet ' + subnet['start'] + '-' + subnet['end'] + ' failed' } - except Exception as e: # pylint: disable=W0718 + except Exception as e: # pylint: disable=W0718 result = {'result': False, 'details': 'Subnet test failed: ' + str(e)} results.append(result) return results diff --git a/modules/test/conn/python/src/dhcp_util.py b/modules/test/conn/python/src/dhcp_util.py new file mode 100644 index 000000000..6bc4d8401 --- /dev/null +++ b/modules/test/conn/python/src/dhcp_util.py @@ -0,0 +1,214 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Module that contains various methods for validating the DHCP +device behaviors""" + +import time +from datetime import datetime +import util + +LOG_NAME = 'dhcp_util' +LOGGER = None + +class DHCPUtil(): + """Helper class for various tests concerning DHCP behavior""" + + def __init__(self, dhcp_primary_client, dhcp_secondary_client, logger): + global LOGGER + LOGGER = logger + self._dhcp1_client = dhcp_primary_client + self._dhcp2_client = dhcp_secondary_client + + # Move primary DHCP server from failover into a single DHCP server config + def disable_failover(self, dhcp_server_primary=True): + LOGGER.info('Disabling primary DHCP server failover') + response = self.get_dhcp_client(dhcp_server_primary).disable_failover() + if response.code == 200: + LOGGER.info('Primary DHCP server failover disabled') + return True + else: + LOGGER.error('Failed to disable primary DHCP server failover') + return False + + # Move primary DHCP server to primary failover + def enable_failover(self, dhcp_server_primary=True): + LOGGER.info('Enabling primary failover DHCP server') + response = self.get_dhcp_client(dhcp_server_primary).enable_failover() + if response.code == 200: + LOGGER.info('Primary DHCP server failover enabled') + return True + else: + LOGGER.error('Failed to enable primary DHCP server failover') + return False + + # Resolve the requested dhcp client + def get_dhcp_client(self, dhcp_server_primary=True): + if dhcp_server_primary: + return self._dhcp1_client + else: + return self._dhcp2_client + + # Read the DHCP range + def get_dhcp_range(self, dhcp_server_primary=True): + response = self.get_dhcp_client(dhcp_server_primary).get_dhcp_range() + cur_range = None + if response.code == 200: + cur_range = {} + cur_range['start'] = response.start + cur_range['end'] = response.end + LOGGER.info('Current DHCP subnet range: ' + str(cur_range)) + else: + LOGGER.error('Failed to resolve current subnet range required ' + 'for restoring network') + return cur_range + + def restore_failover_dhcp_server(self): + if self.enable_failover(): + response = self.get_dhcp_client(False).start_dhcp_server() + if response.code == 200: + LOGGER.info('Secondary DHCP server started') + return True + else: + LOGGER.error('Failed to start secondary DHCP server') + return False + else: + LOGGER.error('Failed to enabled failover in primary DHCP server') + return False + + # Resolve the requested dhcp client + def start_dhcp_server(self, dhcp_server_primary=True): + LOGGER.info('Starting DHCP server') + response = self.get_dhcp_client(dhcp_server_primary).start_dhcp_server() + if response.code == 200: + LOGGER.info('DHCP server start command success') + return True + else: + LOGGER.error('DHCP server start command failed') + return False + + # Resolve the requested dhcp client + def stop_dhcp_server(self, dhcp_server_primary=True): + LOGGER.info('Stopping DHCP server') + response = self.get_dhcp_client(dhcp_server_primary).stop_dhcp_server() + if response.code == 200: + LOGGER.info('DHCP server stop command success') + return True + else: + LOGGER.error('DHCP server stop command failed') + return False + + def get_dhcp_server_status(self, dhcp_server_primary=True): + LOGGER.info('Checking DHCP server status') + response = self.get_dhcp_client(dhcp_server_primary).get_status() + if response.code == 200: + LOGGER.info('DHCP server status: ' + str(response.message)) + status = eval(response.message) # pylint: disable=W0123 + return status['dhcpStatus'] + else: + return False + + def get_cur_lease(self, mac_address, dhcp_server_primary=True): + LOGGER.info('Checking current device lease') + response = self.get_dhcp_client(dhcp_server_primary).get_lease(mac_address) + if response.code == 200: + lease = eval(response.message) # pylint: disable=W0123 + if lease: # Check if non-empty lease + return lease + else: + return None + + def get_new_lease(self, mac_address, dhcp_server_primary=True): + lease = None + for _ in range(5): + LOGGER.info('Checking for new lease') + if lease is None: + lease = self.get_cur_lease(mac_address,dhcp_server_primary) + LOGGER.info('New Lease found: ' + str(lease)) + break + else: + LOGGER.info('New lease not found. Waiting to check again') + time.sleep(5) + return lease + + def is_lease_active(self, lease): + if 'ip' in lease: + ip_addr = lease['ip'] + LOGGER.info('Lease IP Resolved: ' + ip_addr) + LOGGER.info('Attempting to ping device...') + ping_success = self.ping(ip_addr) + LOGGER.info('Ping Success: ' + str(ping_success)) + LOGGER.info('Current lease confirmed active in device') + else: + LOGGER.error('Failed to confirm a valid active lease for the device') + return ping_success + + def ping(self, host): + cmd = 'ping -c 1 ' + str(host) + success = util.run_command(cmd, output=False) + return success + + def add_reserved_lease(self, + hostname, + mac_address, + ip_address, + dhcp_server_primary=True): + response = self.get_dhcp_client(dhcp_server_primary).add_reserved_lease( + hostname, mac_address, ip_address) + if response.code == 200: + LOGGER.info('Reserved lease ' + ip_address + ' added for ' + mac_address) + return True + else: + LOGGER.error('Failed to add reserved lease for ' + mac_address) + return False + + def delete_reserved_lease(self, mac_address, dhcp_server_primary=True): + response = self.get_dhcp_client(dhcp_server_primary).delete_reserved_lease( + mac_address) + if response.code == 200: + LOGGER.info('Reserved lease deleted for ' + mac_address) + return True + else: + LOGGER.error('Failed to delete reserved lease for ' + mac_address) + return False + + def setup_single_dhcp_server(self): + # Shutdown the secondary DHCP Server + LOGGER.info('Stopping secondary DHCP server') + if self.stop_dhcp_server(False): + LOGGER.info('Secondary DHCP server stop command success') + time.sleep(3) # Give some time for the server to stop + if not self.get_dhcp_server_status(False): + LOGGER.info('Secondary DHCP server stopped') + if self.disable_failover(True): + LOGGER.info('Primary DHCP server failover disabled') + return True + else: + LOGGER.error('Failed to disable primary DHCP server failover') + return False + else: + LOGGER.error('Secondary DHCP server still running') + return False + else: + LOGGER.error('Failed to stop secondary DHCP server') + return False + + def wait_for_lease_expire(self, lease): + expiration = datetime.strptime(lease['expires'], '%Y-%m-%d %H:%M:%S') + time_to_expire = expiration - datetime.now() + LOGGER.info('Time until lease expiration: ' + str(time_to_expire)) + LOGGER.info('Waiting for current lease to expire: ' + str(expiration)) + if time_to_expire.total_seconds() > 0: + time.sleep(time_to_expire.total_seconds() + + 5) # Wait until the expiration time and padd 5 seconds + LOGGER.info('Current lease expired.') From 4b1d69ca7bc969bd3535f159bbe4112b493e0337 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 2 Aug 2023 17:57:28 +0100 Subject: [PATCH 062/400] Merge tls tests into dev (#80) * initial add of security module and tls tests * Fix server test and implement 1.3 version * pylinting * More work on client tests * Add client tls tests Add unit tets Add common python code to base test module * re-enable dhcp unit tests disabled during dev * rename module to tls * fix renaming * Fix unit tests broken by module rename Add TLS 1.3 tests to config * Add TLS 1.3 tests to config fix unit tests * Add certificate signature checks * Add local cert mounting for signature validatoin Fix test results * Update tls 1.2 server to pass with tls 1.3 compliance Add unit tests around tls 1.2 server Misc updates and cleanup * pylinting * Update cipher checks and add test * Fix test results when None is returned with details * Fix duplicate results --------- Co-authored-by: jhughesbiot --- .gitignore | 2 +- .../python/src/test_orc/test_orchestrator.py | 4 + local/.gitignore | 6 +- modules/test/base/base.Dockerfile | 4 + modules/test/base/python/requirements.txt | 3 +- modules/test/base/python/src/test_module.py | 5 +- modules/test/conn/python/requirements.txt | 2 +- modules/test/tls/bin/check_cert_signature.sh | 11 + modules/test/tls/bin/get_ciphers.sh | 10 + .../test/tls/bin/get_client_hello_packets.sh | 19 + .../test/tls/bin/get_handshake_complete.sh | 19 + modules/test/tls/bin/start_test_module | 56 +++ modules/test/tls/conf/module_config.json | 37 ++ modules/test/tls/python/requirements.txt | 2 + modules/test/tls/python/src/run.py | 68 +++ modules/test/tls/python/src/tls_module.py | 108 +++++ .../test/tls/python/src/tls_module_test.py | 268 ++++++++++++ modules/test/tls/python/src/tls_util.py | 393 ++++++++++++++++++ modules/test/tls/tls.Dockerfile | 48 +++ testing/unit/run_tests.sh | 4 + 20 files changed, 1062 insertions(+), 7 deletions(-) create mode 100644 modules/test/tls/bin/check_cert_signature.sh create mode 100644 modules/test/tls/bin/get_ciphers.sh create mode 100644 modules/test/tls/bin/get_client_hello_packets.sh create mode 100644 modules/test/tls/bin/get_handshake_complete.sh create mode 100644 modules/test/tls/bin/start_test_module create mode 100644 modules/test/tls/conf/module_config.json create mode 100644 modules/test/tls/python/requirements.txt create mode 100644 modules/test/tls/python/src/run.py create mode 100644 modules/test/tls/python/src/tls_module.py create mode 100644 modules/test/tls/python/src/tls_module_test.py create mode 100644 modules/test/tls/python/src/tls_util.py create mode 100644 modules/test/tls/tls.Dockerfile diff --git a/.gitignore b/.gitignore index 5a216522f..7ef392c5e 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,4 @@ error pylint.out __pycache__/ build/ -testing/unit_test/temp \ No newline at end of file +testing/unit_test/temp/ diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index 74e399df1..61b94a995 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -27,6 +27,7 @@ RUNTIME_DIR = "runtime/test" TEST_MODULES_DIR = "modules/test" MODULE_CONFIG = "conf/module_config.json" +DEVICE_ROOT_CERTS = "local/root_certs" class TestOrchestrator: @@ -61,6 +62,9 @@ def start(self): os.makedirs(RUNTIME_DIR, exist_ok=True) util.run_command(f"chown -R {self._host_user} {RUNTIME_DIR}") + # Setup the root_certs folder + os.makedirs(DEVICE_ROOT_CERTS, exist_ok=True) + self._load_test_modules() self.build_test_modules() diff --git a/local/.gitignore b/local/.gitignore index f13ce8d85..d3086d4df 100644 --- a/local/.gitignore +++ b/local/.gitignore @@ -1,3 +1,3 @@ -system.json -devices -root_certs \ No newline at end of file +system.json +devices +root_certs diff --git a/modules/test/base/base.Dockerfile b/modules/test/base/base.Dockerfile index 62ff54d6c..707136f6d 100644 --- a/modules/test/base/base.Dockerfile +++ b/modules/test/base/base.Dockerfile @@ -17,10 +17,14 @@ FROM ubuntu:jammy ARG MODULE_NAME=base ARG MODULE_DIR=modules/test/$MODULE_NAME +ARG COMMON_DIR=framework/python/src/common # Install common software RUN apt-get update && apt-get install -y net-tools iputils-ping tcpdump iproute2 jq python3 python3-pip dos2unix nmap --fix-missing +# Install common python modules +COPY $COMMON_DIR/ /testrun/python/src/common + # Setup the base python requirements COPY $MODULE_DIR/python /testrun/python diff --git a/modules/test/base/python/requirements.txt b/modules/test/base/python/requirements.txt index 9c4e2b056..9d9473d74 100644 --- a/modules/test/base/python/requirements.txt +++ b/modules/test/base/python/requirements.txt @@ -1,2 +1,3 @@ grpcio -grpcio-tools \ No newline at end of file +grpcio-tools +netifaces \ No newline at end of file diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index e949976fa..8bee611b9 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -100,7 +100,10 @@ def run_tests(self): if isinstance(result, bool): test['result'] = 'compliant' if result else 'non-compliant' else: - test['result'] = 'compliant' if result[0] else 'non-compliant' + if result[0] is None: + test['result'] = 'skipped' + else: + test['result'] = 'compliant' if result[0] else 'non-compliant' test['result_details'] = result[1] else: test['result'] = 'skipped' diff --git a/modules/test/conn/python/requirements.txt b/modules/test/conn/python/requirements.txt index 93b351f44..2b8d18750 100644 --- a/modules/test/conn/python/requirements.txt +++ b/modules/test/conn/python/requirements.txt @@ -1 +1 @@ -scapy \ No newline at end of file +pyOpenSSL \ No newline at end of file diff --git a/modules/test/tls/bin/check_cert_signature.sh b/modules/test/tls/bin/check_cert_signature.sh new file mode 100644 index 000000000..ebd4a7549 --- /dev/null +++ b/modules/test/tls/bin/check_cert_signature.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +ROOT_CERT=$1 +DEVICE_CERT=$2 + +echo "ROOT: $ROOT_CERT" +echo "DEVICE_CERT: $DEVICE_CERT" + +response=$(openssl verify -CAfile $ROOT_CERT $DEVICE_CERT) + +echo "$response" diff --git a/modules/test/tls/bin/get_ciphers.sh b/modules/test/tls/bin/get_ciphers.sh new file mode 100644 index 000000000..e82bbc180 --- /dev/null +++ b/modules/test/tls/bin/get_ciphers.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +CAPTURE_FILE=$1 +DST_IP=$2 +DST_PORT=$3 + +TSHARK_FILTER="ssl.handshake.ciphersuites and ip.dst==$DST_IP and tcp.dstport==$DST_PORT" +response=$(tshark -r $CAPTURE_FILE -Y "$TSHARK_FILTER" -Vx | grep 'Cipher Suite:' | awk '{$1=$1};1' | sed 's/Cipher Suite: //') + +echo "$response" diff --git a/modules/test/tls/bin/get_client_hello_packets.sh b/modules/test/tls/bin/get_client_hello_packets.sh new file mode 100644 index 000000000..13e42f791 --- /dev/null +++ b/modules/test/tls/bin/get_client_hello_packets.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +CAPTURE_FILE=$1 +SRC_IP=$2 +TLS_VERSION=$3 + +TSHARK_OUTPUT="-T json -e ip.src -e tcp.dstport -e ip.dst" +TSHARK_FILTER="ssl.handshake.type==1 and ip.src==$SRC_IP" + +if [[ $TLS_VERSION == '1.2' || -z $TLS_VERSION ]];then + TSHARK_FILTER=$TSHARK_FILTER "and ssl.handshake.version==0x0303" +elif [ $TLS_VERSION == '1.2' ];then + TSHARK_FILTER=$TSHARK_FILTER "and ssl.handshake.version==0x0304" +fi + +response=$(tshark -r $CAPTURE_FILE $TSHARK_OUTPUT $TSHARK_FILTER) + +echo "$response" + \ No newline at end of file diff --git a/modules/test/tls/bin/get_handshake_complete.sh b/modules/test/tls/bin/get_handshake_complete.sh new file mode 100644 index 000000000..de1eb887d --- /dev/null +++ b/modules/test/tls/bin/get_handshake_complete.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +CAPTURE_FILE=$1 +SRC_IP=$2 +DST_IP=$3 +TLS_VERSION=$4 + +TSHARK_FILTER="ip.src==$SRC_IP and ip.dst==$DST_IP " + +if [[ $TLS_VERSION == '1.2' || -z $TLS_VERSION ]];then + TSHARK_FILTER=$TSHARK_FILTER " and ssl.handshake.type==2 and tls.handshake.type==14 " +elif [ $TLS_VERSION == '1.2' ];then + TSHARK_FILTER=$TSHARK_FILTER "and ssl.handshake.type==2 and tls.handshake.extensions.supported_version==0x0304" +fi + +response=$(tshark -r $CAPTURE_FILE $TSHARK_FILTER) + +echo "$response" + \ No newline at end of file diff --git a/modules/test/tls/bin/start_test_module b/modules/test/tls/bin/start_test_module new file mode 100644 index 000000000..d8cede486 --- /dev/null +++ b/modules/test/tls/bin/start_test_module @@ -0,0 +1,56 @@ +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# An example startup script that does the bare minimum to start +# a test module via a pyhon script. Each test module should include a +# start_test_module file that overwrites this one to boot all of its +# specific requirements to run. + +# Define where the python source files are located +PYTHON_SRC_DIR=/testrun/python/src + +# Fetch module name +MODULE_NAME=$1 + +# Default interface should be veth0 for all containers +DEFAULT_IFACE=veth0 + +# Allow a user to define an interface by passing it into this script +DEFINED_IFACE=$2 + +# Select which interace to use +if [[ -z $DEFINED_IFACE || "$DEFINED_IFACE" == "null" ]] +then + echo "No interface defined, defaulting to veth0" + INTF=$DEFAULT_IFACE +else + INTF=$DEFINED_IFACE +fi + +# Create and set permissions on the log files +LOG_FILE=/runtime/output/$MODULE_NAME.log +RESULT_FILE=/runtime/output/$MODULE_NAME-result.json +touch $LOG_FILE +touch $RESULT_FILE +chown $HOST_USER $LOG_FILE +chown $HOST_USER $RESULT_FILE + +# Run the python scrip that will execute the tests for this module +# -u flag allows python print statements +# to be logged by docker by running unbuffered +python3 -u $PYTHON_SRC_DIR/run.py "-m $MODULE_NAME" + +echo Module has finished \ No newline at end of file diff --git a/modules/test/tls/conf/module_config.json b/modules/test/tls/conf/module_config.json new file mode 100644 index 000000000..59e5a839d --- /dev/null +++ b/modules/test/tls/conf/module_config.json @@ -0,0 +1,37 @@ +{ + "config": { + "meta": { + "name": "tls", + "display_name": "TLS", + "description": "TLS tests" + }, + "network": true, + "docker": { + "depends_on": "base", + "enable_container": true, + "timeout": 300 + }, + "tests":[ + { + "name": "security.tls.v1_2_server", + "description": "Check the device web server TLS 1.2 & certificate is valid", + "expected_behavior": "TLS 1.2 certificate is issued to the web browser client when accessed" + }, + { + "name": "security.tls.v1_3_server", + "description": "Check the device web server TLS 1.3 & certificate is valid", + "expected_behavior": "TLS 1.3 certificate is issued to the web browser client when accessed" + }, + { + "name": "security.tls.v1_2_client", + "description": "Device uses TLS with connection to an external service on port 443 (or any other port which could be running the webserver-HTTPS)", + "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.2 and support for ECDH and ECDSA ciphers" + }, + { + "name": "security.tls.v1_3_client", + "description": "Device uses TLS with connection to an external service on port 443 (or any other port which could be running the webserver-HTTPS)", + "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.3" + } + ] + } +} \ No newline at end of file diff --git a/modules/test/tls/python/requirements.txt b/modules/test/tls/python/requirements.txt new file mode 100644 index 000000000..432116ff2 --- /dev/null +++ b/modules/test/tls/python/requirements.txt @@ -0,0 +1,2 @@ +cryptography +pyOpenSSL \ No newline at end of file diff --git a/modules/test/tls/python/src/run.py b/modules/test/tls/python/src/run.py new file mode 100644 index 000000000..51bc82f8f --- /dev/null +++ b/modules/test/tls/python/src/run.py @@ -0,0 +1,68 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Run Baseline module""" +import argparse +import signal +import sys +import logger + +from tls_module import TLSModule + +LOGGER = logger.get_logger('test_module') +RUNTIME = 1500 + + +class TLSModuleRunner: + """An example runner class for test modules.""" + + def __init__(self, module): + + signal.signal(signal.SIGINT, self._handler) + signal.signal(signal.SIGTERM, self._handler) + signal.signal(signal.SIGABRT, self._handler) + signal.signal(signal.SIGQUIT, self._handler) + + LOGGER.info('Starting TLS Module') + + self._test_module = TLSModule(module) + self._test_module.run_tests() + + def _handler(self, signum): + LOGGER.debug('SigtermEnum: ' + str(signal.SIGTERM)) + LOGGER.debug('Exit signal received: ' + str(signum)) + if signum in (2, signal.SIGTERM): + LOGGER.info('Exit signal received. Stopping test module...') + LOGGER.info('Test module stopped') + sys.exit(1) + + +def run(): + parser = argparse.ArgumentParser( + description='Security Module Help', + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + + parser.add_argument( + '-m', + '--module', + help='Define the module name to be used to create the log file') + + args = parser.parse_args() + + # For some reason passing in the args from bash adds an extra + # space before the argument so we'll just strip out extra space + TLSModuleRunner(args.module.strip()) + + +if __name__ == '__main__': + run() diff --git a/modules/test/tls/python/src/tls_module.py b/modules/test/tls/python/src/tls_module.py new file mode 100644 index 000000000..d58163266 --- /dev/null +++ b/modules/test/tls/python/src/tls_module.py @@ -0,0 +1,108 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Baseline test module""" +from test_module import TestModule +from tls_util import TLSUtil + +LOG_NAME = 'test_tls' +LOGGER = None +STARTUP_CAPTURE_FILE = '/runtime/device/startup.pcap' +MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' + + +class TLSModule(TestModule): + """An example testing module.""" + + def __init__(self, module): + super().__init__(module_name=module, log_name=LOG_NAME) + global LOGGER + LOGGER = self._get_logger() + self._tls_util = TLSUtil(LOGGER) + + def _security_tls_v1_2_server(self): + LOGGER.info('Running security.tls.v1_2_server') + self._resolve_device_ip() + # If the ipv4 address wasn't resolved yet, try again + if self._device_ipv4_addr is not None: + tls_1_2_results = self._tls_util.validate_tls_server( + self._device_ipv4_addr, tls_version='1.2') + tls_1_3_results = self._tls_util.validate_tls_server( + self._device_ipv4_addr, tls_version='1.3') + return self._tls_util.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + else: + LOGGER.error('Could not resolve device IP address. Skipping') + return None, 'Could not resolve device IP address. Skipping' + + def _security_tls_v1_3_server(self): + LOGGER.info('Running security.tls.v1_3_server') + self._resolve_device_ip() + # If the ipv4 address wasn't resolved yet, try again + if self._device_ipv4_addr is not None: + return self._tls_util.validate_tls_server(self._device_ipv4_addr, + tls_version='1.3') + else: + LOGGER.error('Could not resolve device IP address. Skipping') + return None, 'Could not resolve device IP address. Skipping' + + def _security_tls_v1_2_client(self): + LOGGER.info('Running security.tls.v1_2_client') + self._resolve_device_ip() + # If the ipv4 address wasn't resolved yet, try again + if self._device_ipv4_addr is not None: + return self._validate_tls_client(self._device_ipv4_addr, '1.2') + else: + LOGGER.error('Could not resolve device IP address. Skipping') + return None, 'Could not resolve device IP address. Skipping' + + def _security_tls_v1_3_client(self): + LOGGER.info('Running security.tls.v1_3_client') + self._resolve_device_ip() + # If the ipv4 address wasn't resolved yet, try again + if self._device_ipv4_addr is not None: + return self._validate_tls_client(self._device_ipv4_addr, '1.3') + else: + LOGGER.error('Could not resolve device IP address. Skipping') + return None, 'Could not resolve device IP address. Skipping' + + def _validate_tls_client(self, client_ip, tls_version): + monitor_result = self._tls_util.validate_tls_client( + client_ip=client_ip, + tls_version=tls_version, + capture_file=MONITOR_CAPTURE_FILE) + startup_result = self._tls_util.validate_tls_client( + client_ip=client_ip, + tls_version=tls_version, + capture_file=STARTUP_CAPTURE_FILE) + + LOGGER.info('Montor: ' + str(monitor_result)) + LOGGER.info('Startup: ' + str(startup_result)) + + if (not monitor_result[0] and monitor_result[0] is not None) or ( + not startup_result[0] and startup_result[0] is not None): + result = False, startup_result[1] + monitor_result[1] + elif monitor_result[0] and startup_result[0]: + result = True, startup_result[1] + monitor_result[1] + elif monitor_result[0] and startup_result[0] is None: + result = True, monitor_result[1] + elif startup_result[0] and monitor_result[0] is None: + result = True, monitor_result[1] + else: + result = None, startup_result[1] + return result + + def _resolve_device_ip(self): + # If the ipv4 address wasn't resolved yet, try again + if self._device_ipv4_addr is None: + self._device_ipv4_addr = self._get_device_ipv4() diff --git a/modules/test/tls/python/src/tls_module_test.py b/modules/test/tls/python/src/tls_module_test.py new file mode 100644 index 000000000..84a1c70eb --- /dev/null +++ b/modules/test/tls/python/src/tls_module_test.py @@ -0,0 +1,268 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Module run all the TLS related unit tests""" +from tls_util import TLSUtil +import unittest +from common import logger +from scapy.all import sniff, wrpcap +import os +import threading +import time +import netifaces +import ssl +import http.client + +CAPTURE_DIR = 'testing/unit_test/temp' +MODULE_NAME = 'tls_module_test' +TLS_UTIL = None +PACKET_CAPTURE = None + + +class TLSModuleTest(unittest.TestCase): + """Contains and runs all the unit tests concerning TLS behaviors""" + @classmethod + def setUpClass(cls): + log = logger.get_logger(MODULE_NAME) + global TLS_UTIL + TLS_UTIL = TLSUtil(log, + bin_dir='modules/test/tls/bin', + cert_out_dir='testing/unit_test/temp', + root_certs_dir='local/root_certs') + + # Test 1.2 server when only 1.2 connection is established + def security_tls_v1_2_server_test(self): + tls_1_2_results = TLS_UTIL.validate_tls_server('google.com', + tls_version='1.2') + tls_1_3_results = None, 'No TLS 1.3' + test_results = TLS_UTIL.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + self.assertTrue(test_results[0]) + + # Test 1.2 server when 1.3 connection is established + def security_tls_v1_2_for_1_3_server_test(self): + tls_1_2_results = None, 'No TLS 1.2' + tls_1_3_results = TLS_UTIL.validate_tls_server('google.com', + tls_version='1.3') + test_results = TLS_UTIL.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + self.assertTrue(test_results[0]) + + # Test 1.2 server when 1.2 and 1.3 connection is established + def security_tls_v1_2_for_1_2_and_1_3_server_test(self): + tls_1_2_results = TLS_UTIL.validate_tls_server('google.com', + tls_version='1.2') + tls_1_3_results = TLS_UTIL.validate_tls_server('google.com', + tls_version='1.3') + test_results = TLS_UTIL.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + self.assertTrue(test_results[0]) + + # Test 1.2 server when 1.2 and failed 1.3 connection is established + def security_tls_v1_2_for_1_2_and_1_3_fail_server_test(self): + tls_1_2_results = TLS_UTIL.validate_tls_server('google.com', + tls_version='1.2') + tls_1_3_results = False, 'Signature faild' + test_results = TLS_UTIL.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + self.assertTrue(test_results[0]) + + # Test 1.2 server when 1.3 and failed 1.2 connection is established + def security_tls_v1_2_for_1_3_and_1_2_fail_server_test(self): + tls_1_3_results = TLS_UTIL.validate_tls_server('google.com', + tls_version='1.3') + tls_1_2_results = False, 'Signature faild' + test_results = TLS_UTIL.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + self.assertTrue(test_results[0]) + + # Test 1.2 server when 1.3 and 1.2 failed connection is established + def security_tls_v1_2_fail_server_test(self): + tls_1_2_results = False, 'Signature faild' + tls_1_3_results = False, 'Signature faild' + test_results = TLS_UTIL.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + self.assertFalse(test_results[0]) + + # Test 1.2 server when 1.3 and 1.2 failed connection is established + def security_tls_v1_2_none_server_test(self): + tls_1_2_results = None, 'No cert' + tls_1_3_results = None, 'No cert' + test_results = TLS_UTIL.process_tls_server_results(tls_1_2_results, + tls_1_3_results) + self.assertIsNone(test_results[0]) + + def security_tls_v1_3_server_test(self): + test_results = TLS_UTIL.validate_tls_server('google.com', tls_version='1.3') + self.assertTrue(test_results[0]) + + def security_tls_v1_2_client_test(self): + test_results = self.test_client_tls('1.2') + print(str(test_results)) + self.assertTrue(test_results[0]) + + def security_tls_v1_2_client_cipher_fail_test(self): + test_results = self.test_client_tls('1.2', disable_valid_ciphers=True) + print(str(test_results)) + self.assertFalse(test_results[0]) + + def security_tls_client_skip_test(self): + # 1.1 will fail to connect and so no hello client will exist + # which should result in a skip result + test_results = self.test_client_tls('1.2', tls_generate='1.1') + print(str(test_results)) + self.assertIsNone(test_results[0]) + + def security_tls_v1_3_client_test(self): + test_results = self.test_client_tls('1.3') + print(str(test_results)) + self.assertTrue(test_results[0]) + + def client_hello_packets_test(self): + packet_fail = {'dst_ip': '10.10.10.1', 'src_ip': '10.10.10.14', 'dst_port': '443', 'cipher_support': {'ecdh': False, 'ecdsa': True}} + packet_success = {'dst_ip': '10.10.10.1', 'src_ip': '10.10.10.14', 'dst_port': '443', 'cipher_support': {'ecdh': True, 'ecdsa': True}} + hello_packets = [packet_fail,packet_success] + hello_results = TLS_UTIL.process_hello_packets(hello_packets,'1.2') + print("Hello packets test results: " + str(hello_results)) + expected = {'valid':[packet_success],'invalid':[]} + self.assertEqual(hello_results,expected) + + def test_client_tls(self, + tls_version, + tls_generate=None, + disable_valid_ciphers=False): + # Make the capture file + os.makedirs(CAPTURE_DIR, exist_ok=True) + capture_file = CAPTURE_DIR + '/client_tls.pcap' + + # Resolve the client ip used + client_ip = self.get_interface_ip('eth0') + + # Genrate TLS outbound traffic + if tls_generate is None: + tls_generate = tls_version + self.generate_tls_traffic(capture_file, tls_generate, disable_valid_ciphers) + + # Run the client test + return TLS_UTIL.validate_tls_client(client_ip=client_ip, + tls_version=tls_version, + capture_file=capture_file) + + def generate_tls_traffic(self, + capture_file, + tls_version, + disable_valid_ciphers=False): + capture_thread = self.start_capture_thread(10) + print('Capture Started') + + # Generate some TLS 1.2 outbound traffic + while capture_thread.is_alive(): + self.make_tls_connection('www.google.com', 443, tls_version, + disable_valid_ciphers) + time.sleep(1) + + # Save the captured packets to the file. + wrpcap(capture_file, PACKET_CAPTURE) + + def make_tls_connection(self, + hostname, + port, + tls_version, + disable_valid_ciphers=False): + # Create the SSL context with the desired TLS version and options + context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) + context.check_hostname = False + context.verify_mode = ssl.CERT_NONE + context.options |= ssl.PROTOCOL_TLS + + if disable_valid_ciphers: + # Create a list of ciphers that do not use ECDH or ECDSA + ciphers_str = [ + 'TLS_AES_256_GCM_SHA384', 'TLS_CHACHA20_POLY1305_SHA256', + 'TLS_AES_128_GCM_SHA256', 'AES256-GCM-SHA384', + 'PSK-AES256-GCM-SHA384', 'PSK-CHACHA20-POLY1305', + 'RSA-PSK-AES128-GCM-SHA256', 'DHE-PSK-AES128-GCM-SHA256', + 'AES128-GCM-SHA256', 'PSK-AES128-GCM-SHA256', 'AES256-SHA256', + 'AES128-SHA' + ] + context.set_ciphers(':'.join(ciphers_str)) + + if tls_version != '1.1': + context.options |= ssl.OP_NO_TLSv1 # Disable TLS 1.0 + context.options |= ssl.OP_NO_TLSv1_1 # Disable TLS 1.1 + else: + context.options |= ssl.OP_NO_TLSv1_2 # Disable TLS 1.2 + context.options |= ssl.OP_NO_TLSv1_3 # Disable TLS 1.3 + + if tls_version == '1.3': + context.options |= ssl.OP_NO_TLSv1_2 # Disable TLS 1.2 + elif tls_version == '1.2': + context.options |= ssl.OP_NO_TLSv1_3 # Disable TLS 1.3 + + # Create the HTTPS connection with the SSL context + connection = http.client.HTTPSConnection(hostname, port, context=context) + + # Perform the TLS handshake manually + try: + connection.connect() + except ssl.SSLError as e: + print('Failed to make connection: ' + str(e)) + + # At this point, the TLS handshake is complete. + # You can do any further processing or just close the connection. + connection.close() + + def start_capture(self, timeout): + global PACKET_CAPTURE + PACKET_CAPTURE = sniff(iface='eth0', timeout=timeout) + + def start_capture_thread(self, timeout): + # Start the packet capture in a separate thread to avoid blocking. + capture_thread = threading.Thread(target=self.start_capture, + args=(timeout, )) + capture_thread.start() + + return capture_thread + + def get_interface_ip(self, interface_name): + try: + addresses = netifaces.ifaddresses(interface_name) + ipv4 = addresses[netifaces.AF_INET][0]['addr'] + return ipv4 + except (ValueError, KeyError) as e: + print(f'Error: {e}') + return None + + +if __name__ == '__main__': + suite = unittest.TestSuite() + suite.addTest(TLSModuleTest('client_hello_packets_test')) + # TLS 1.2 server tests + suite.addTest(TLSModuleTest('security_tls_v1_2_server_test')) + suite.addTest(TLSModuleTest('security_tls_v1_2_for_1_3_server_test')) + suite.addTest(TLSModuleTest('security_tls_v1_2_for_1_2_and_1_3_server_test')) + suite.addTest( + TLSModuleTest('security_tls_v1_2_for_1_2_and_1_3_fail_server_test')) + suite.addTest( + TLSModuleTest('security_tls_v1_2_for_1_3_and_1_2_fail_server_test')) + suite.addTest(TLSModuleTest('security_tls_v1_2_fail_server_test')) + suite.addTest(TLSModuleTest('security_tls_v1_2_none_server_test')) + # # TLS 1.3 server tests + suite.addTest(TLSModuleTest('security_tls_v1_3_server_test')) + # TLS client tests + suite.addTest(TLSModuleTest('security_tls_v1_2_client_test')) + suite.addTest(TLSModuleTest('security_tls_v1_3_client_test')) + suite.addTest(TLSModuleTest('security_tls_client_skip_test')) + suite.addTest(TLSModuleTest('security_tls_v1_2_client_cipher_fail_test')) + runner = unittest.TextTestRunner() + runner.run(suite) diff --git a/modules/test/tls/python/src/tls_util.py b/modules/test/tls/python/src/tls_util.py new file mode 100644 index 000000000..c83c131af --- /dev/null +++ b/modules/test/tls/python/src/tls_util.py @@ -0,0 +1,393 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +"""Module that contains various metehods for validating TLS communications""" +import ssl +import socket +from datetime import datetime +from OpenSSL import crypto +import json +import os +from common import util + +LOG_NAME = 'tls_util' +LOGGER = None +DEFAULT_BIN_DIR = '/testrun/bin' +DEFAULT_CERTS_OUT_DIR = '/runtime/output' +DEFAULT_ROOT_CERTS_DIR = '/testrun/root_certs' + + +class TLSUtil(): + """Helper class for various tests concerning TLS communications""" + + def __init__(self, + logger, + bin_dir=DEFAULT_BIN_DIR, + cert_out_dir=DEFAULT_CERTS_OUT_DIR, + root_certs_dir=DEFAULT_ROOT_CERTS_DIR): + global LOGGER + LOGGER = logger + self._bin_dir = bin_dir + self._dev_cert_file = cert_out_dir + '/device_cert.crt' + self._root_certs_dir = root_certs_dir + + def get_public_certificate(self, + host, + port=443, + validate_cert=False, + tls_version='1.2'): + try: + #context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) + context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) + context.check_hostname = False + if not validate_cert: + # Disable certificate verification + context.verify_mode = ssl.CERT_NONE + else: + # Use host CA certs for validation + context.load_default_certs() + context.verify_mode = ssl.CERT_REQUIRED + + # Set the correct TLS version + context.options |= ssl.PROTOCOL_TLS + context.options |= ssl.OP_NO_TLSv1 # Disable TLS 1.0 + context.options |= ssl.OP_NO_TLSv1_1 # Disable TLS 1.1 + if tls_version == '1.3': + context.options |= ssl.OP_NO_TLSv1_2 # Disable TLS 1.2 + elif tls_version == '1.2': + context.options |= ssl.OP_NO_TLSv1_3 # Disable TLS 1.3 + + # Create an SSL/TLS socket + with socket.create_connection((host, port), timeout=5) as sock: + with context.wrap_socket(sock, server_hostname=host) as secure_sock: + # Get the server's certificate in PEM format + cert_pem = ssl.DER_cert_to_PEM_cert(secure_sock.getpeercert(True)) + + except ConnectionRefusedError: + LOGGER.info(f'Connection to {host}:{port} was refused.') + return None + except socket.gaierror: + LOGGER.info(f'Failed to resolve the hostname {host}.') + return None + except ssl.SSLError as e: + LOGGER.info(f'SSL error occurred: {e}') + return None + + return cert_pem + + def get_public_key(self, public_cert): + # Extract and return the public key from the certificate + public_key = public_cert.get_pubkey() + return public_key + + def verify_certificate_timerange(self, public_cert): + # Extract the notBefore and notAfter dates from the certificate + not_before = datetime.strptime(public_cert.get_notBefore().decode(), + '%Y%m%d%H%M%SZ') + not_after = datetime.strptime(public_cert.get_notAfter().decode(), + '%Y%m%d%H%M%SZ') + + LOGGER.info('Certificate valid from: ' + str(not_before) + ' To ' + + str(not_after)) + + # Get the current date + current_date = datetime.utcnow() + + # Check if today's date is within the certificate's validity range + if not_before <= current_date <= not_after: + return True, 'Certificate has a valid time range' + elif current_date <= not_before: + return False, 'Certificate is not yet valid' + else: + return False, 'Certificate has expired' + + def verify_public_key(self, public_key): + + # Get the key length based bits + key_length = public_key.bits() + LOGGER.info('Key Length: ' + str(key_length)) + + # Check the key type + key_type = 'Unknown' + if public_key.type() == crypto.TYPE_RSA: + key_type = 'RSA' + elif public_key.type() == crypto.TYPE_EC: + key_type = 'EC' + elif public_key.type() == crypto.TYPE_DSA: + key_type = 'DSA' + elif public_key.type() == crypto.TYPE_DH: + key_type = 'Diffie-Hellman' + LOGGER.info('Key Type: ' + key_type) + + # Check if the public key is of RSA type + if key_type == 'RSA': + if key_length >= 2048: + return True, 'RSA key length passed: ' + str(key_length) + ' >= 2048' + else: + return False, 'RSA key length too short: ' + str(key_length) + ' < 2048' + + # Check if the public key is of EC type + elif key_type == 'EC': + if key_length >= 224: + return True, 'EC key length passed: ' + str(key_length) + ' >= 224' + else: + return False, 'EC key length too short: ' + str(key_length) + ' < 224' + else: + return False, 'Key is not RSA or EC type' + + def validate_signature(self, host): + # Reconnect to the device but with validate signature option + # set to true which will check for proper cert chains + # within the valid CA root certs stored on the server + LOGGER.info( + 'Checking for valid signature from authorized Certificate Authorities') + public_cert = self.get_public_certificate(host, + validate_cert=True, + tls_version='1.2') + if public_cert: + LOGGER.info('Authorized Certificate Authority signature confirmed') + return True, 'Authorized Certificate Authority signature confirmed' + else: + LOGGER.info('Authorized Certificate Authority signature not present') + LOGGER.info('Resolving configured root certificates') + bin_file = self._bin_dir + '/check_cert_signature.sh' + # Get a list of all root certificates + root_certs = os.listdir(self._root_certs_dir) + LOGGER.info('Root Certs Found: ' + str(len(root_certs))) + for root_cert in root_certs: + try: + # Create the file path + root_cert_path = os.path.join(self._root_certs_dir, root_cert) + LOGGER.info('Checking root cert: ' + str(root_cert_path)) + args = f'{root_cert_path} {self._dev_cert_file}' + command = f'{bin_file} {args}' + response = util.run_command(command) + if 'device_cert.crt: OK' in str(response): + LOGGER.info('Device signed by cert:' + root_cert) + return True, 'Device signed by cert:' + root_cert + else: + LOGGER.info('Device not signed by cert: ' + root_cert) + except Exception as e: # pylint: disable=W0718 + LOGGER.error('Failed to check cert:' + root_cert) + LOGGER.error(str(e)) + return False, 'Device certificate has not been signed' + + def process_tls_server_results(self, tls_1_2_results, tls_1_3_results): + results = '' + if tls_1_2_results[0] is None and tls_1_3_results[0]: + results = True, 'TLS 1.3 validated:\n' + tls_1_3_results[1] + elif tls_1_3_results[0] is None and tls_1_2_results[0]: + results = True, 'TLS 1.2 validated:\n' + tls_1_2_results[1] + elif tls_1_2_results[0] and tls_1_3_results[0]: + description = 'TLS 1.2 validated:\n' + tls_1_2_results[1] + description += '\nTLS 1.3 validated:\n' + tls_1_3_results[1] + results = True, description + elif tls_1_2_results[0] and not tls_1_3_results[0]: + description = 'TLS 1.2 validated:\n' + tls_1_2_results[1] + description += '\nTLS 1.3 not validated:\n' + tls_1_3_results[1] + results = True, description + elif tls_1_3_results[0] and not tls_1_2_results[0]: + description = 'TLS 1.2 not validated:\n' + tls_1_2_results[1] + description += '\nTLS 1.3 validated:\n' + tls_1_3_results[1] + results = True, description + elif not tls_1_3_results[0] and not tls_1_2_results[0] and tls_1_2_results[ + 0] is not None and tls_1_3_results is not None: + description = 'TLS 1.2 not validated:\n' + tls_1_2_results[1] + description += '\nTLS 1.3 not validated:\n' + tls_1_3_results[1] + results = False, description + else: + description = 'TLS 1.2 not validated:\n' + tls_1_2_results[1] + description += '\nTLS 1.3 not validated:\n' + tls_1_3_results[1] + results = None, description + LOGGER.info('TLS 1.2 server test results: ' + str(results)) + return results + + def validate_tls_server(self, host, tls_version): + cert_pem = self.get_public_certificate(host, + validate_cert=False, + tls_version=tls_version) + if cert_pem: + + # Write pem encoding to a file + self.write_cert_to_file(cert_pem) + + # Load pem encoding into a certifiate so we can process the contents + public_cert = crypto.load_certificate(crypto.FILETYPE_PEM, cert_pem) + + # Print the certificate information + cert_text = crypto.dump_certificate(crypto.FILETYPE_TEXT, + public_cert).decode() + LOGGER.info('Device Certificate:\n' + cert_text) + + # Validate the certificates time range + tr_valid = self.verify_certificate_timerange(public_cert) + + # Resolve the public key + public_key = self.get_public_key(public_cert) + if public_key: + key_valid = self.verify_public_key(public_key) + + sig_valid = self.validate_signature(host) + + # Check results + cert_valid = tr_valid[0] and key_valid[0] and sig_valid[0] + test_details = tr_valid[1] + '\n' + key_valid[1] + '\n' + sig_valid[1] + LOGGER.info('Certificate validated: ' + str(cert_valid)) + LOGGER.info('Test Details:\n' + test_details) + return cert_valid, test_details + else: + LOGGER.info('Failed to resolve public certificate') + return None, 'Failed to resolve public certificate' + + def write_cert_to_file(self, pem_cert): + with open(self._dev_cert_file, 'w', encoding='UTF-8') as f: + f.write(pem_cert) + + def get_ciphers(self, capture_file, dst_ip, dst_port): + bin_file = self._bin_dir + '/get_ciphers.sh' + args = f'{capture_file} {dst_ip} {dst_port}' + command = f'{bin_file} {args}' + response = util.run_command(command) + ciphers = response[0].split('\n') + return ciphers + + def get_hello_packets(self, capture_file, src_ip, tls_version): + bin_file = self._bin_dir + '/get_client_hello_packets.sh' + args = f'{capture_file} {src_ip} {tls_version}' + command = f'{bin_file} {args}' + response = util.run_command(command) + packets = response[0].strip() + return self.parse_hello_packets(json.loads(packets), capture_file) + + def get_handshake_complete(self, capture_file, src_ip, dst_ip, tls_version): + bin_file = self._bin_dir + '/get_handshake_complete.sh' + args = f'{capture_file} {src_ip} {dst_ip} {tls_version}' + command = f'{bin_file} {args}' + response = util.run_command(command) + return response + + def parse_hello_packets(self, packets, capture_file): + hello_packets = [] + for packet in packets: + # Extract all the basic IP information about the packet + packet_layers = packet['_source']['layers'] + dst_ip = packet_layers['ip.dst'][0] if 'ip.dst' in packet_layers else '' + src_ip = packet_layers['ip.src'][0] if 'ip.src' in packet_layers else '' + dst_port = packet_layers['tcp.dstport'][ + 0] if 'tcp.dstport' in packet_layers else '' + + # Resolve the ciphers used in this packet and validate expected ones exist + ciphers = self.get_ciphers(capture_file, dst_ip, dst_port) + cipher_support = self.is_ecdh_and_ecdsa(ciphers) + + # Put result together + hello_packet = {} + hello_packet['dst_ip'] = dst_ip + hello_packet['src_ip'] = src_ip + hello_packet['dst_port'] = dst_port + hello_packet['cipher_support'] = cipher_support + + hello_packets.append(hello_packet) + return hello_packets + + def process_hello_packets(self,hello_packets, tls_version = '1.2'): + # Validate the ciphers only for tls 1.2 + client_hello_results = {'valid': [], 'invalid': []} + if tls_version == '1.2': + for packet in hello_packets: + if packet['dst_ip'] not in str(client_hello_results['valid']): + LOGGER.info('Checking client ciphers: ' + str(packet)) + if packet['cipher_support']['ecdh'] and packet['cipher_support'][ + 'ecdsa']: + LOGGER.info('Valid ciphers detected') + client_hello_results['valid'].append(packet) + # If a previous hello packet to the same destination failed, + # we can now remove it as it has passed on a different attempt + if packet['dst_ip'] in str(client_hello_results['invalid']): + LOGGER.info(str(client_hello_results['invalid'])) + for invalid_packet in client_hello_results['invalid']: + if packet['dst_ip'] in str(invalid_packet): + client_hello_results['invalid'].remove(invalid_packet) + else: + LOGGER.info('Invalid ciphers detected') + if packet['dst_ip'] not in str(client_hello_results['invalid']): + client_hello_results['invalid'].append(packet) + else: + # No cipher check for TLS 1.3 + client_hello_results['valid'] = hello_packets + return client_hello_results + + def validate_tls_client(self, client_ip, tls_version, capture_file): + LOGGER.info('Validating client for TLS: ' + tls_version) + hello_packets = self.get_hello_packets(capture_file, client_ip, tls_version) + client_hello_results = self.process_hello_packets(hello_packets,tls_version) + + handshakes = {'complete': [], 'incomplete': []} + for packet in client_hello_results['valid']: + # Filter out already tested IP's since only 1 handshake success is needed + if not packet['dst_ip'] in handshakes['complete'] and not packet[ + 'dst_ip'] in handshakes['incomplete']: + handshake_complete = self.get_handshake_complete( + capture_file, packet['src_ip'], packet['dst_ip'], tls_version) + + # One of the responses will be a complaint about running as root so + # we have to have at least 2 entries to consider a completed handshake + if len(handshake_complete) > 1: + LOGGER.info('TLS handshake completed from: ' + packet['dst_ip']) + handshakes['complete'].append(packet['dst_ip']) + else: + LOGGER.warning('No TLS handshakes completed from: ' + + packet['dst_ip']) + handshakes['incomplete'].append(packet['dst_ip']) + + for handshake in handshakes['complete']: + LOGGER.info('Valid TLS client connection to server: ' + str(handshake)) + + # Process and return the results + tls_client_details = '' + tls_client_valid = None + if len(hello_packets) > 0: + if len(client_hello_results['invalid']) > 0: + tls_client_valid = False + for result in client_hello_results['invalid']: + tls_client_details += 'Client hello packet to ' + result[ + 'dst_ip'] + ' did not have expected ciphers:' + if not result['cipher_support']['ecdh']: + tls_client_details += ' ecdh ' + if not result['cipher_support']['ecdsa']: + tls_client_details += 'ecdsa' + tls_client_details += '\n' + if len(handshakes['incomplete']) > 0: + for result in handshakes['incomplete']: + tls_client_details += 'Incomplete handshake detected from server: ' + tls_client_details += result + '\n' + if len(handshakes['complete']) > 0: + # If we haven't already failed the test from previous checks + # allow a passing result + if tls_client_valid is None: + tls_client_valid = True + for result in handshakes['complete']: + tls_client_details += 'Completed handshake detected from server: ' + tls_client_details += result + '\n' + else: + LOGGER.info('No client hello packets detected. Skipping') + tls_client_details = 'No client hello packets detected. Skipping' + return tls_client_valid, tls_client_details + + def is_ecdh_and_ecdsa(self, ciphers): + ecdh = False + ecdsa = False + for cipher in ciphers: + ecdh |= 'ECDH' in cipher + ecdsa |= 'ECDSA' in cipher + return {'ecdh': ecdh, 'ecdsa': ecdsa} diff --git a/modules/test/tls/tls.Dockerfile b/modules/test/tls/tls.Dockerfile new file mode 100644 index 000000000..92fa6028c --- /dev/null +++ b/modules/test/tls/tls.Dockerfile @@ -0,0 +1,48 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Image name: test-run/tls-test +FROM test-run/base-test:latest + +# Set DEBIAN_FRONTEND to noninteractive mode +ENV DEBIAN_FRONTEND=noninteractive + +# Install required software +RUN apt-get update && apt-get install -y tshark + +ARG MODULE_NAME=tls +ARG MODULE_DIR=modules/test/$MODULE_NAME +ARG CERTS_DIR=local/root_certs + +# Copy over all configuration files +COPY $MODULE_DIR/conf /testrun/conf + +# Copy over all binary files +COPY $MODULE_DIR/bin /testrun/bin + +# Copy over all python files +COPY $MODULE_DIR/python /testrun/python + +#Install all python requirements for the module +RUN pip3 install -r /testrun/python/requirements.txt + +# Create a directory inside the container to store the root certificates +RUN mkdir -p /testrun/root_certs + +# Copy over all the local certificates for device signature +# checks if the folder exists +COPY $CERTS_DIR /testrun/root_certs + + + diff --git a/testing/unit/run_tests.sh b/testing/unit/run_tests.sh index 5b1ed6257..5fa1179b1 100644 --- a/testing/unit/run_tests.sh +++ b/testing/unit/run_tests.sh @@ -15,4 +15,8 @@ export PYTHONPATH="$PWD/framework/python/src" python3 -u $PWD/modules/network/dhcp-1/python/src/grpc_server/dhcp_config_test.py python3 -u $PWD/modules/network/dhcp-2/python/src/grpc_server/dhcp_config_test.py +# Run the Security Module Unit Tests +python3 -u $PWD/modules/test/tls/python/src/tls_module_test.py + + popd >/dev/null 2>&1 \ No newline at end of file From 4ce26a17b9cf4740d4f6c30fe69d8306eb734a71 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Thu, 3 Aug 2023 09:21:05 -0700 Subject: [PATCH 063/400] Test output restructure (#79) * Change runtime test structure to allow for multiple old tests * fix current test move * logging changes * Add device test count to device config * Change max report naming Add optional default value to system.json * Copy current test instead of moving to keep a consistent location of the most recent test * fix merge issue * pylint * Use local device folder and use session for config --------- Co-authored-by: Jacob Boddey --- framework/python/src/common/device.py | 2 + framework/python/src/common/session.py | 10 +- framework/python/src/core/testrun.py | 20 +- .../src/net_orc/network_orchestrator.py | 33 +++- .../python/src/test_orc/test_orchestrator.py | 172 ++++++++++++++---- local/.gitignore | 6 +- local/system.json.example | 3 +- resources/devices/template/device_config.json | 1 + 8 files changed, 193 insertions(+), 54 deletions(-) diff --git a/framework/python/src/common/device.py b/framework/python/src/common/device.py index b70099519..83f0c1a15 100644 --- a/framework/python/src/common/device.py +++ b/framework/python/src/common/device.py @@ -25,3 +25,5 @@ class Device(): model: str = None test_modules: str = None ip_addr: str = None + device_folder: str = None + max_device_reports: int = None diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py index a0f6118ff..7306d5cc8 100644 --- a/framework/python/src/common/session.py +++ b/framework/python/src/common/session.py @@ -25,6 +25,7 @@ MONITOR_PERIOD_KEY = 'monitor_period' STARTUP_TIMEOUT_KEY = 'startup_timeout' LOG_LEVEL_KEY = 'log_level' +MAX_DEVICE_REPORTS_KEY = 'max_device_reports' class TestRunSession(): """Represents the current session of Test Run.""" @@ -62,7 +63,8 @@ def _get_default_config(self): 'log_level': 'INFO', 'startup_timeout': 60, 'monitor_period': 30, - 'runtime': 120 + 'runtime': 120, + 'max_device_reports': 5 } def get_config(self): @@ -95,6 +97,9 @@ def _load_config(self): if LOG_LEVEL_KEY in config_file_json: self._config[LOG_LEVEL_KEY] = config_file_json.get(LOG_LEVEL_KEY) + if MAX_DEVICE_REPORTS_KEY in config_file_json: + self._config[MAX_DEVICE_REPORTS_KEY] = config_file_json.get(MAX_DEVICE_REPORTS_KEY) + def _save_config(self): with open(self._config_file, 'w', encoding='utf-8') as f: f.write(json.dumps(self._config, indent=2)) @@ -116,6 +121,9 @@ def get_monitor_period(self): def get_startup_timeout(self): return self._config.get(STARTUP_TIMEOUT_KEY) + + def get_max_device_reports(self): + return self._config.get(MAX_DEVICE_REPORTS_KEY) def set_config(self, config_json): self._config = config_json diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index 6016fbfe7..0c3de6db4 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -53,6 +53,7 @@ DEVICE_MODEL = 'model' DEVICE_MAC_ADDR = 'mac_addr' DEVICE_TEST_MODULES = 'test_modules' +MAX_DEVICE_REPORTS_KEY = 'max_device_reports' class TestRun: # pylint: disable=too-few-public-methods """Test Run controller. @@ -112,7 +113,15 @@ def _load_devices(self, device_dir): util.run_command(f'chown -R {util.get_host_user()} {device_dir}') for device_folder in os.listdir(device_dir): - with open(os.path.join(device_dir, device_folder, DEVICE_CONFIG), + + device_config_file_path = os.path.join(device_dir, + device_folder, + DEVICE_CONFIG) + if not os.path.exists(device_config_file_path): + LOGGER.error(f'Device configuration file missing from device {device_folder}') + continue + + with open(device_config_file_path, encoding='utf-8') as device_config_file: device_config_json = json.load(device_config_file) @@ -120,11 +129,18 @@ def _load_devices(self, device_dir): device_model = device_config_json.get(DEVICE_MODEL) mac_addr = device_config_json.get(DEVICE_MAC_ADDR) test_modules = device_config_json.get(DEVICE_TEST_MODULES) + max_device_reports = None + if 'max_device_reports' in device_config_json: + max_device_reports = device_config_json.get(MAX_DEVICE_REPORTS_KEY) device = Device(manufacturer=device_manufacturer, model=device_model, mac_addr=mac_addr, - test_modules=test_modules) + test_modules=test_modules, + max_device_reports=max_device_reports, + device_folder=device_folder) + self.get_session().add_device(device) + self.get_session().add_device(device) LOGGER.debug(f'Loaded device {device.manufacturer} {device.model} with MAC address {device.mac_addr}') diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index 7d550d4ae..4c56a05f0 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -154,17 +154,25 @@ def _device_discovered(self, mac_addr): # Ignore device if not registered return - device_runtime_dir = os.path.join(RUNTIME_DIR, TEST_DIR, - mac_addr.replace(':', '')) - os.makedirs(device_runtime_dir) + device_runtime_dir = os.path.join(RUNTIME_DIR, + TEST_DIR, + mac_addr.replace(':', '') + ) + + # Cleanup any old current test files + shutil.rmtree(device_runtime_dir, ignore_errors=True) + os.makedirs(device_runtime_dir, exist_ok=True) + util.run_command(f'chown -R {self._host_user} {device_runtime_dir}') packet_capture = sniff(iface=self._session.get_device_interface(), timeout=self._session.get_startup_timeout(), stop_filter=self._device_has_ip) wrpcap( - os.path.join(RUNTIME_DIR, TEST_DIR, mac_addr.replace(':', ''), - 'startup.pcap'), packet_capture) + os.path.join(device_runtime_dir, + 'startup.pcap' + ), + packet_capture) if device.ip_addr is None: LOGGER.info( @@ -201,14 +209,23 @@ def _start_device_monitor(self, device): callback the steady state method for this device.""" LOGGER.info(f'Monitoring device with mac addr {device.mac_addr} ' f'for {str(self._session.get_monitor_period())} seconds') + + device_runtime_dir = os.path.join(RUNTIME_DIR, + TEST_DIR, + device.mac_addr.replace(':', '') + ) packet_capture = sniff(iface=self._session.get_device_interface(), timeout=self._session.get_monitor_period()) wrpcap( - os.path.join(RUNTIME_DIR, TEST_DIR, device.mac_addr.replace(':', ''), - 'monitor.pcap'), packet_capture) + os.path.join(device_runtime_dir, + 'monitor.pcap' + ), + packet_capture) self._monitor_in_progress = False - self.get_listener().call_callback(NetworkEvent.DEVICE_STABLE, device.mac_addr) + self.get_listener().call_callback( + NetworkEvent.DEVICE_STABLE, + device.mac_addr) def _check_network_services(self): LOGGER.debug('Checking network modules...') diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index 61b94a995..cfa4b6e29 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -11,13 +11,13 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """Provides high level management of the test orchestrator.""" import os import json import time import shutil import docker +from datetime import datetime from docker.types import Mount from common import logger, util from test_orc.module import TestModule @@ -27,6 +27,7 @@ RUNTIME_DIR = "runtime/test" TEST_MODULES_DIR = "modules/test" MODULE_CONFIG = "conf/module_config.json" +SAVED_DEVICE_REPORTS = "local/devices/{device_folder}/reports" DEVICE_ROOT_CERTS = "local/root_certs" @@ -35,24 +36,18 @@ class TestOrchestrator: def __init__(self, session, net_orc): self._test_modules = [] - self._module_config = None self._session = session self._net_orc = net_orc self._test_in_progress = False + self._path = os.path.dirname( + os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) - self._path = os.path.dirname(os.path.dirname( - os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) - - # Resolve the path to the test-run folder - #self._root_path = os.path.abspath(os.path.join(self._path, os.pardir)) - - self._root_path = os.path.dirname(os.path.dirname( - os.path.dirname( - os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) - - shutil.rmtree(os.path.join(self._root_path, RUNTIME_DIR), - ignore_errors=True) + self._root_path = os.path.dirname( + os.path.dirname( + os.path.dirname( + os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))) def start(self): LOGGER.debug("Starting test orchestrator") @@ -82,38 +77,128 @@ def run_test_modules(self, device): LOGGER.info("All tests complete") self._generate_results(device) + self._timestamp_results(device) + LOGGER.debug("Cleaning old test results...") + self._cleanup_old_test_results(device) + LOGGER.debug("Old test results cleaned") self._test_in_progress = False + def _cleanup_old_test_results(self, device): + + if device.max_device_reports is not None: + max_device_reports = device.max_device_reports + else: + max_device_reports = self._session.get_max_device_reports() + + completed_results_dir = os.path.join( + self._root_path, + SAVED_DEVICE_REPORTS.replace("{device_folder}", + device.device_folder) + ) + + completed_tests = os.listdir(completed_results_dir) + cur_test_count = len(completed_tests) + if cur_test_count > max_device_reports: + LOGGER.debug("Current device has more than max tests results allowed: " + + str(cur_test_count) + ">" + str(max_device_reports)) + + # Find and delete the oldest test + oldest_test = self._find_oldest_test(completed_results_dir) + if oldest_test is not None: + LOGGER.debug("Oldest test found, removing: " + str(oldest_test)) + shutil.rmtree(oldest_test, ignore_errors=True) + # Confirm the delete was succesful + new_test_count = len(os.listdir(completed_results_dir)) + if (new_test_count != cur_test_count + and new_test_count > max_device_reports): + # Continue cleaning up until we're under the max + self._cleanup_old_test_results(device) + + def _find_oldest_test(self, completed_tests_dir): + oldest_timestamp = None + oldest_directory = None + for completed_test in os.listdir(completed_tests_dir): + timestamp = datetime.strptime(str(completed_test), "%Y-%m-%dT%H:%M:%S") + if oldest_timestamp is None or timestamp < oldest_timestamp: + oldest_timestamp = timestamp + oldest_directory = completed_test + if oldest_directory: + return os.path.join(completed_tests_dir, oldest_directory) + else: + return None + + def _timestamp_results(self, device): + + # Define the current device results directory + cur_results_dir = os.path.join( + self._root_path, + RUNTIME_DIR, + device.mac_addr.replace(":", "") + ) + + # Define the destination results directory with timestamp + cur_time = datetime.now().strftime("%Y-%m-%dT%H:%M:%S") + completed_results_dir = os.path.join( + SAVED_DEVICE_REPORTS.replace("{device_folder}", + device.device_folder), + cur_time) + + # Copy the results to the timestamp directory + # leave current copy in place for quick reference to + # most recent test + shutil.copytree(cur_results_dir, completed_results_dir) + util.run_command(f"chown -R {self._host_user} '{completed_results_dir}'") + def _generate_results(self, device): - results = {} - results["device"] = {} + + report = {} + + report["device"] = {} if device.manufacturer is not None: - results["device"]["manufacturer"] = device.manufacturer + report["device"]["manufacturer"] = device.manufacturer if device.model is not None: - results["device"]["model"] = device.model - results["device"]["mac_addr"] = device.mac_addr + report["device"]["model"] = device.model + report["device"]["mac_addr"] = device.mac_addr + + results = [] + for module in self._test_modules: if module.enable_container and self._is_module_enabled(module, device): + container_runtime_dir = os.path.join( - self._root_path, "runtime/test/" + - device.mac_addr.replace(":", "") + "/" + module.name) + self._root_path, + RUNTIME_DIR, + device.mac_addr.replace(":", ""), + module.name + ) + results_file = f"{container_runtime_dir}/{module.name}-result.json" try: with open(results_file, "r", encoding="utf-8-sig") as f: module_results = json.load(f) - results[module.name] = module_results + for result in module_results["results"]: + results.append(result) except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: - LOGGER.error(f"Error occured whilst obbtaining results for module {module.name}") + LOGGER.error( + f("Error occured whilst obbtaining results " + "for module {module.name}") + ) LOGGER.debug(results_error) + report["results"] = results + out_file = os.path.join( - self._root_path, - "runtime/test/" + device.mac_addr.replace(":", "") + "/results.json") + self._root_path, + RUNTIME_DIR, + device.mac_addr.replace(":", ""), + "report.json" + ) + with open(out_file, "w", encoding="utf-8") as f: - json.dump(results, f, indent=2) + json.dump(report, f, indent=2) util.run_command(f"chown -R {self._host_user} {out_file}") - return results + return report def test_in_progress(self): return self._test_in_progress @@ -139,21 +224,31 @@ def _run_test_module(self, module, device): LOGGER.info("Running test module " + module.name) try: + + device_test_dir = os.path.join( + self._root_path, + RUNTIME_DIR, + device.mac_addr.replace(":", "") + ) + container_runtime_dir = os.path.join( - self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + - "/" + module.name) - os.makedirs(container_runtime_dir) + device_test_dir, + module.name + ) + os.makedirs(container_runtime_dir, exist_ok=True) network_runtime_dir = os.path.join(self._root_path, "runtime/network") device_startup_capture = os.path.join( - self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + - "/startup.pcap") + device_test_dir, + "startup.pcap" + ) util.run_command(f"chown -R {self._host_user} {device_startup_capture}") device_monitor_capture = os.path.join( - self._root_path, "runtime/test/" + device.mac_addr.replace(":", "") + - "/monitor.pcap") + device_test_dir, + "monitor.pcap" + ) util.run_command(f"chown -R {self._host_user} {device_monitor_capture}") client = docker.from_env() @@ -206,13 +301,12 @@ def _run_test_module(self, module, device): status = self._get_module_status(module) log_stream = module.container.logs(stream=True, stdout=True, stderr=True) - while (time.time() < test_module_timeout and - status == "running" and - self._session.get_status() == "In progress"): + while (time.time() < test_module_timeout and status == "running" + and self._session.get_status() == "In progress"): try: line = next(log_stream).decode("utf-8").strip() print(line) - except Exception: + except Exception: # pylint: disable=W0718 time.sleep(1) status = self._get_module_status(module) diff --git a/local/.gitignore b/local/.gitignore index d3086d4df..06f79c1ca 100644 --- a/local/.gitignore +++ b/local/.gitignore @@ -1,3 +1,3 @@ -system.json -devices -root_certs +system.json +devices +root_certs diff --git a/local/system.json.example b/local/system.json.example index e99e013f3..17e5b0891 100644 --- a/local/system.json.example +++ b/local/system.json.example @@ -6,5 +6,6 @@ "log_level": "INFO", "startup_timeout": 60, "monitor_period": 300, - "runtime": 1200 + "runtime": 1200, + "max_device_reports": 5 } \ No newline at end of file diff --git a/resources/devices/template/device_config.json b/resources/devices/template/device_config.json index 7ee63cf95..ac8ff197c 100644 --- a/resources/devices/template/device_config.json +++ b/resources/devices/template/device_config.json @@ -2,6 +2,7 @@ "manufacturer": "Manufacturer X", "model": "Device X", "mac_addr": "aa:bb:cc:dd:ee:ff", + "max_device_tests":5, "test_modules": { "dns": { "enabled": true From c78f2dee22f8e8f4d73a54acc366b5c0ef39ec2b Mon Sep 17 00:00:00 2001 From: J Boddey Date: Thu, 3 Aug 2023 17:56:49 +0100 Subject: [PATCH 064/400] Keep test results in memory (#82) * Keep results in memory * More useful debug message * Fix file path --- framework/python/src/api/api.py | 10 +- framework/python/src/common/device.py | 10 ++ framework/python/src/common/session.py | 23 +++- framework/python/src/core/testrun.py | 42 ++++--- .../src/net_orc/network_orchestrator.py | 42 +++++-- framework/python/src/net_orc/ovs_control.py | 20 ++-- .../python/src/test_orc/test_orchestrator.py | 110 +++++++++--------- modules/test/base/bin/capture | 2 +- modules/test/base/bin/setup_binaries | 2 +- modules/test/base/bin/start | 2 +- 10 files changed, 159 insertions(+), 104 deletions(-) diff --git a/framework/python/src/api/api.py b/framework/python/src/api/api.py index d877a5b33..f63f1825a 100644 --- a/framework/python/src/api/api.py +++ b/framework/python/src/api/api.py @@ -108,11 +108,14 @@ async def start_test_run(self, request: Request, response: Response): response.status_code = status.HTTP_400_BAD_REQUEST return self._generate_msg(False, "Invalid JSON received") - if "device" not in body_json or "mac_addr" not in body_json["device"]: + if "device" not in body_json or not ( + "mac_addr" in body_json["device"] and + "firmware" in body_json["device"]): response.status_code = status.HTTP_400_BAD_REQUEST return self._generate_msg(False, "Invalid request received") device = self._session.get_device(body_json["device"]["mac_addr"]) + device.firmware = body_json["device"]["firmware"] # Check Test Run is not already running if self._test_run.get_session().get_status() != "Idle": @@ -123,12 +126,13 @@ async def start_test_run(self, request: Request, response: Response): # Check if requested device is known in the device repository if device is None: response.status_code = status.HTTP_404_NOT_FOUND - return self._generate_msg(False, "A device with that MAC address could not be found") + return self._generate_msg(False, + "A device with that MAC address could not be found") # Check Test Run is able to start if self._test_run.get_net_orc().check_config() is False: response.status_code = status.HTTP_500_INTERNAL_SERVER_ERROR - return self._generate_msg(False, "Configured interfaces are not ready for use. Ensure both interfaces are connected.") + return self._generate_msg(False,"Configured interfaces are not ready for use. Ensure required interfaces are connected.") self._test_run.get_session().set_target_device(device) LOGGER.info(f"Starting Test Run with device target {device.manufacturer} {device.model} with MAC address {device.mac_addr}") diff --git a/framework/python/src/common/device.py b/framework/python/src/common/device.py index 83f0c1a15..e2552d75a 100644 --- a/framework/python/src/common/device.py +++ b/framework/python/src/common/device.py @@ -25,5 +25,15 @@ class Device(): model: str = None test_modules: str = None ip_addr: str = None + firmware: str = None device_folder: str = None max_device_reports: int = None + + def to_json(self): + device_json = {} + device_json['mac_addr'] = self.mac_addr + device_json['manufacturer'] = self.manufacturer + device_json['model'] = self.model + if self.firmware is not None: + device_json['firmware'] = self.firmware + return device_json diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py index 7306d5cc8..13e4b09fb 100644 --- a/framework/python/src/common/session.py +++ b/framework/python/src/common/session.py @@ -35,7 +35,8 @@ def __init__(self, config_file): self._device = None self._started = None self._finished = None - self._tests = [] + self._results = [] + self._runtime_params = [] self._config_file = config_file @@ -54,6 +55,9 @@ def get_started(self): def get_finished(self): return self._finished + def stop(self): + self._finished = datetime.datetime.now() + def _get_default_config(self): return { 'network': { @@ -110,6 +114,12 @@ def get_runtime(self): def get_log_level(self): return self._config.get(LOG_LEVEL_KEY) + def get_runtime_params(self): + return self._runtime_params + + def add_runtime_param(self, param): + self._runtime_params.append(param) + def get_device_interface(self): return self._config.get(NETWORK_KEY, {}).get(DEVICE_INTF_KEY) @@ -157,13 +167,16 @@ def get_status(self): def set_status(self, status): self._status = status - def get_tests(self): - return self._tests + def get_test_results(self): + return self._results + + def add_test_result(self, test_result): + self._results.append(test_result) def reset(self): self.set_status('Idle') self.set_target_device(None) - self._tests = [] + self._results = [] self._started = None self._finished = None @@ -173,5 +186,5 @@ def to_json(self): 'device': self.get_target_device(), 'started': self.get_started(), 'finished': self.get_finished(), - 'tests': self.get_tests() + 'results': self.get_test_results() } diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index 0c3de6db4..6e3a6da5d 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -81,7 +81,14 @@ def __init__(self, # Catch any exit signals self._register_exits() + # Create session self._session = TestRunSession(config_file=self._config_file) + + if single_intf: + self._session.add_runtime_param('single_intf') + if net_only: + self._session.add_runtime_param('net_only') + self._load_all_devices() self._net_orc = net_orc.NetworkOrchestrator( @@ -93,6 +100,12 @@ def __init__(self, self._net_orc) if self._no_ui: + # Check Test Run is able to start + if self.get_net_orc().check_config() is False: + return + + # Any additional checks that need to be performed go here + self.start() else: self._api = Api(self) @@ -192,7 +205,7 @@ def start(self): self.get_net_orc().monitor_in_progress()): time.sleep(5) - self.stop() + self.stop() def stop(self, kill=False): self._set_status('Stopping') @@ -254,27 +267,26 @@ def get_device(self, mac_addr): def _device_discovered(self, mac_addr): - if self.get_session().get_target_device() is not None: - if mac_addr != self.get_session().get_target_device().mac_addr: - # Ignore discovered device - return + device = self.get_session().get_target_device() - self._set_status('Identifying device') - device = self.get_device(mac_addr) if device is not None: - LOGGER.info( - f'Discovered {device.manufacturer} {device.model} on the network') + if mac_addr != device.mac_addr: + # Ignore discovered device because it is not the target device + return else: - device = Device(mac_addr=mac_addr) - self._devices.append(device) - LOGGER.info( - f'A new device has been discovered with mac address {mac_addr}') + device = self.get_device(mac_addr) + if device is None: + return + + self.get_session().set_target_device(device) + + LOGGER.info( + f'Discovered {device.manufacturer} {device.model} on the network') def _device_stable(self, mac_addr): - device = self.get_device(mac_addr) LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') self._set_status('In progress') - self._test_orc.run_test_modules(device) + self._test_orc.run_test_modules() self._set_status('Complete') def _set_status(self, status): diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index 4c56a05f0..ebeeba2dd 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -90,11 +90,30 @@ def start(self): def check_config(self): - if not util.interface_exists(self._session.get_internet_interface()) or not util.interface_exists( - self._session.get_device_interface()): - LOGGER.error('Configured interfaces are not ready for use. ' + - 'Ensure both interfaces are connected.') - return False + device_interface_ready = util.interface_exists( + self._session.get_device_interface()) + internet_interface_ready = util.interface_exists( + self._session.get_internet_interface()) + + if 'single_intf' in self._session.get_runtime_params(): + # Check for device interface only + if not device_interface_ready: + LOGGER.error('Device interface is not ready for use. ' + + 'Ensure device interface is connected.') + return False + else: + if not device_interface_ready and not internet_interface_ready: + LOGGER.error('Both device and internet interfaces are not ready for use. ' + + 'Ensure both interfaces are connected.') + return False + elif not device_interface_ready: + LOGGER.error('Device interface is not ready for use. ' + + 'Ensure device interface is connected.') + return False + elif not internet_interface_ready: + LOGGER.error('Internet interface is not ready for use. ' + + 'Ensure internet interface is connected.') + return False return True def start_network(self): @@ -310,11 +329,9 @@ def _ci_post_network_create(self): def create_net(self): LOGGER.info('Creating baseline network') - if self._single_intf: - self._ci_pre_network_create() - - # Remove IP from internet adapter - util.run_command('ifconfig ' + self._session.get_internet_interface() + ' 0.0.0.0') + # TODO: This is not just for CI + #if self._single_intf: + #self._ci_pre_network_create() # Setup the virtual network if not self._ovs.create_baseline_net(verify=True): @@ -322,8 +339,9 @@ def create_net(self): self.stop() sys.exit(1) - if self._single_intf: - self._ci_post_network_create() + # TODO: This is not just for CI + #if self._single_intf: + #self._ci_post_network_create() self._create_private_net() diff --git a/framework/python/src/net_orc/ovs_control.py b/framework/python/src/net_orc/ovs_control.py index c48e58e3b..a2769632c 100644 --- a/framework/python/src/net_orc/ovs_control.py +++ b/framework/python/src/net_orc/ovs_control.py @@ -76,13 +76,17 @@ def validate_baseline_network(self): # Verify the OVS setup of the virtual network LOGGER.debug('Validating baseline network') + dev_bridge = True + int_bridge = True + # Verify the device bridge dev_bridge = self.verify_bridge(DEVICE_BRIDGE, [self._session.get_device_interface()]) LOGGER.debug('Device bridge verified: ' + str(dev_bridge)) # Verify the internet bridge - int_bridge = self.verify_bridge(INTERNET_BRIDGE, [self._session.get_internet_interface()]) - LOGGER.debug('Internet bridge verified: ' + str(int_bridge)) + if 'single_intf' not in self._session.get_runtime_params(): + int_bridge = self.verify_bridge(INTERNET_BRIDGE, [self._session.get_internet_interface()]) + LOGGER.debug('Internet bridge verified: ' + str(int_bridge)) return dev_bridge and int_bridge @@ -103,21 +107,19 @@ def verify_bridge(self, bridge_name, ports): def create_baseline_net(self, verify=True): LOGGER.debug('Creating baseline network') - # Remove IP from internet adapter - self.set_interface_ip(interface=self._session.get_internet_interface(), ip_addr='0.0.0.0') - # Create data plane self.add_bridge(DEVICE_BRIDGE) # Create control plane self.add_bridge(INTERNET_BRIDGE) - # Remove IP from internet adapter - self.set_interface_ip(self._session.get_internet_interface(), '0.0.0.0') - # Add external interfaces to data and control plane self.add_port(self._session.get_device_interface(), DEVICE_BRIDGE) - self.add_port(self._session.get_internet_interface(), INTERNET_BRIDGE) + + # Remove IP from internet adapter + if not 'single_intf' in self._session.get_runtime_params(): + self.set_interface_ip(interface=self._session.get_internet_interface(), ip_addr='0.0.0.0') + self.add_port(self._session.get_internet_interface(), INTERNET_BRIDGE) # Enable forwarding of eapol packets self.add_flow(bridge_name=DEVICE_BRIDGE, diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index cfa4b6e29..7a7d19bdb 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -14,6 +14,7 @@ """Provides high level management of the test orchestrator.""" import os import json +import re import time import shutil import docker @@ -27,6 +28,7 @@ RUNTIME_DIR = "runtime/test" TEST_MODULES_DIR = "modules/test" MODULE_CONFIG = "conf/module_config.json" +LOG_REGEX = r'^[A-Z][a-z]{2} [0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} test_' SAVED_DEVICE_REPORTS = "local/devices/{device_folder}/reports" DEVICE_ROOT_CERTS = "local/root_certs" @@ -67,22 +69,48 @@ def stop(self): """Stop any running tests""" self._stop_modules() - def run_test_modules(self, device): + def run_test_modules(self): """Iterates through each test module and starts the container.""" + + device = self._session.get_target_device() self._test_in_progress = True LOGGER.info( f"Running test modules on device with mac addr {device.mac_addr}") for module in self._test_modules: - self._run_test_module(module, device) + self._run_test_module(module) LOGGER.info("All tests complete") - - self._generate_results(device) + + self._session.stop() + self._generate_report() + self._test_in_progress = False self._timestamp_results(device) LOGGER.debug("Cleaning old test results...") self._cleanup_old_test_results(device) LOGGER.debug("Old test results cleaned") self._test_in_progress = False + def _generate_report(self): + + # TODO: Calculate the status result + # We need to know the required result of each test + + report = {} + report["device"] = self._session.get_target_device().to_json() + report["started"] = self._session.get_started().strftime("%Y-%m-%d %H:%M:%S") + report["finished"] = self._session.get_finished().strftime("%Y-%m-%d %H:%M:%S") + report["status"] = self._session.get_status() + report["results"] = self._session.get_test_results() + out_file = os.path.join( + self._root_path, + RUNTIME_DIR, + self._session.get_target_device().mac_addr.replace(":", ""), + "report.json") + + with open(out_file, "w", encoding="utf-8") as f: + json.dump(report, f, indent=2) + util.run_command(f"chown -R {self._host_user} {out_file}") + return report + def _cleanup_old_test_results(self, device): if device.max_device_reports is not None: @@ -149,57 +177,6 @@ def _timestamp_results(self, device): shutil.copytree(cur_results_dir, completed_results_dir) util.run_command(f"chown -R {self._host_user} '{completed_results_dir}'") - def _generate_results(self, device): - - report = {} - - report["device"] = {} - if device.manufacturer is not None: - report["device"]["manufacturer"] = device.manufacturer - if device.model is not None: - report["device"]["model"] = device.model - report["device"]["mac_addr"] = device.mac_addr - - results = [] - - for module in self._test_modules: - if module.enable_container and self._is_module_enabled(module, device): - - container_runtime_dir = os.path.join( - self._root_path, - RUNTIME_DIR, - device.mac_addr.replace(":", ""), - module.name - ) - - results_file = f"{container_runtime_dir}/{module.name}-result.json" - try: - with open(results_file, "r", encoding="utf-8-sig") as f: - module_results = json.load(f) - for result in module_results["results"]: - results.append(result) - except (FileNotFoundError, PermissionError, - json.JSONDecodeError) as results_error: - LOGGER.error( - f("Error occured whilst obbtaining results " - "for module {module.name}") - ) - LOGGER.debug(results_error) - - report["results"] = results - - out_file = os.path.join( - self._root_path, - RUNTIME_DIR, - device.mac_addr.replace(":", ""), - "report.json" - ) - - with open(out_file, "w", encoding="utf-8") as f: - json.dump(report, f, indent=2) - util.run_command(f"chown -R {self._host_user} {out_file}") - return report - def test_in_progress(self): return self._test_in_progress @@ -212,9 +189,11 @@ def _is_module_enabled(self, module, device): enabled = test_modules[module.name]["enabled"] return enabled - def _run_test_module(self, module, device): + def _run_test_module(self, module): """Start the test container and extract the results.""" + device = self._session.get_target_device() + if module is None or not module.enable_container: return @@ -305,11 +284,28 @@ def _run_test_module(self, module, device): and self._session.get_status() == "In progress"): try: line = next(log_stream).decode("utf-8").strip() - print(line) + if re.search(LOG_REGEX, line): + print(line) except Exception: # pylint: disable=W0718 time.sleep(1) status = self._get_module_status(module) + # Get test results from module + container_runtime_dir = os.path.join( + self._root_path, "runtime/test/" + + device.mac_addr.replace(":", "") + "/" + module.name) + results_file = f"{container_runtime_dir}/{module.name}-result.json" + try: + with open(results_file, "r", encoding="utf-8-sig") as f: + module_results_json = json.load(f) + module_results = module_results_json['results'] + for test_result in module_results: + self._session.add_test_result(test_result) + except (FileNotFoundError, PermissionError, + json.JSONDecodeError) as results_error: + LOGGER.error(f"Error occured whilst obbtaining results for module {module.name}") + LOGGER.debug(results_error) + LOGGER.info("Test module " + module.name + " has finished") def _get_module_status(self, module): diff --git a/modules/test/base/bin/capture b/modules/test/base/bin/capture index e237f3d72..69fa916c3 100644 --- a/modules/test/base/bin/capture +++ b/modules/test/base/bin/capture @@ -27,7 +27,7 @@ INTERFACE=$2 # Create the output directory and start the capture mkdir -p $PCAP_DIR chown $HOST_USER $PCAP_DIR -tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & 2>&1 /dev/null +tcpdump -i $INTERFACE -w $PCAP_DIR/$PCAP_FILE -Z $HOST_USER & # Small pause to let the capture to start sleep 1 \ No newline at end of file diff --git a/modules/test/base/bin/setup_binaries b/modules/test/base/bin/setup_binaries index eaccf9de6..6af744693 100644 --- a/modules/test/base/bin/setup_binaries +++ b/modules/test/base/bin/setup_binaries @@ -18,7 +18,7 @@ BIN_DIR=$1 # Remove incorrect line endings -dos2unix $BIN_DIR/* >/dev/null 2>&1 +dos2unix $BIN_DIR/* # Make sure all the bin files are executable chmod u+x $BIN_DIR/* \ No newline at end of file diff --git a/modules/test/base/bin/start b/modules/test/base/bin/start index 6869d1116..37902b868 100755 --- a/modules/test/base/bin/start +++ b/modules/test/base/bin/start @@ -14,4 +14,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -/testrun/bin/start_module > /dev/null \ No newline at end of file +/testrun/bin/start_module \ No newline at end of file From 11c97408d8a7354ee559ecfe0f4681a614412f8f Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Fri, 11 Aug 2023 09:38:16 -0700 Subject: [PATCH 065/400] Result descriptions (#92) * Add short descriptions to conn module Add result_description to results with shorter wording for UI usage * Add result details to ipv6 tests * Update test descriptions in baseline module * Update dns test result details * Update skip results to include details when present * dns module formatting * add result details to nmap tests * add result details to ntp tests * Add short descriptions to tls module and formatting * misc test module formatting * fix typo --- modules/test/base/python/src/test_module.py | 16 +++- modules/test/baseline/conf/module_config.json | 9 +- .../baseline/python/src/baseline_module.py | 19 ++-- modules/test/conn/conf/module_config.json | 44 +++++++--- modules/test/conn/python/requirements.txt | 3 +- .../test/conn/python/src/connection_module.py | 35 ++++---- modules/test/dns/conf/module_config.json | 9 +- modules/test/dns/python/src/dns_module.py | 87 ++++++++++++------- modules/test/nmap/conf/module_config.json | 1 + modules/test/nmap/python/src/nmap_module.py | 9 +- modules/test/nmap/python/src/run.py | 4 +- modules/test/ntp/conf/module_config.json | 6 +- modules/test/ntp/python/src/ntp_module.py | 45 +++++++--- modules/test/tls/conf/module_config.json | 12 ++- .../test/tls/python/src/tls_module_test.py | 31 +++++-- 15 files changed, 226 insertions(+), 104 deletions(-) diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index 8bee611b9..519fb2433 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -11,7 +11,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """Base class for all core test module functions""" import json import logger @@ -102,11 +101,26 @@ def run_tests(self): else: if result[0] is None: test['result'] = 'skipped' + if len(result)>1: + test['result_details'] = result[1] else: test['result'] = 'compliant' if result[0] else 'non-compliant' test['result_details'] = result[1] else: test['result'] = 'skipped' + + # Generate the short result description based on result value + if test['result'] == 'compliant': + test['result_description'] = test[ + 'short_description'] if 'short_description' in test else test[ + 'name'] + ' passed - see result details for more info' + elif test['result'] == 'non-compliant': + test['result_description'] = test[ + 'name'] + ' failed - see result details for more info' + else: + test['result_description'] = test[ + 'name'] + ' skipped - see result details for more info' + test['end'] = datetime.now().isoformat() duration = datetime.fromisoformat(test['end']) - datetime.fromisoformat( test['start']) diff --git a/modules/test/baseline/conf/module_config.json b/modules/test/baseline/conf/module_config.json index 4c0cd08d8..f4daf0e36 100644 --- a/modules/test/baseline/conf/module_config.json +++ b/modules/test/baseline/conf/module_config.json @@ -15,17 +15,20 @@ { "name": "baseline.pass", "description": "Simulate a compliant test", - "expected_behavior": "A compliant test result is generated" + "expected_behavior": "A compliant test result is generated", + "short_description": "A compliant test result is generated" }, { "name": "baseline.fail", "description": "Simulate a non-compliant test", - "expected_behavior": "A non-compliant test result is generated" + "expected_behavior": "A non-compliant test result is generated", + "short_description": "A non-compliant test result is generated" }, { "name": "baseline.skip", "description": "Simulate a skipped test", - "expected_behavior": "A skipped test result is generated" + "expected_behavior": "A skipped test result is generated", + "short_description": "A skipped test result is generated" } ] } diff --git a/modules/test/baseline/python/src/baseline_module.py b/modules/test/baseline/python/src/baseline_module.py index 22555d369..978f916fe 100644 --- a/modules/test/baseline/python/src/baseline_module.py +++ b/modules/test/baseline/python/src/baseline_module.py @@ -15,7 +15,7 @@ """Baseline test module""" from test_module import TestModule -LOG_NAME = "test_baseline" +LOG_NAME = 'test_baseline' LOGGER = None @@ -28,15 +28,16 @@ def __init__(self, module): LOGGER = self._get_logger() def _baseline_pass(self): - LOGGER.info("Running baseline pass test") - LOGGER.info("Baseline pass test finished") - return True + LOGGER.info('Running baseline pass test') + LOGGER.info('Baseline pass test finished') + return True, 'Baseline pass test ran successfully' def _baseline_fail(self): - LOGGER.info("Running baseline pass test") - LOGGER.info("Baseline pass test finished") - return False + LOGGER.info('Running baseline fail test') + LOGGER.info('Baseline fail test finished') + return False, 'Baseline fail test ran successfully' def _baseline_skip(self): - LOGGER.info("Running baseline pass test") - LOGGER.info("Baseline pass test finished") + LOGGER.info('Running baseline skip test') + LOGGER.info('Baseline skip test finished') + return None, 'Baseline skip test ran successfully' diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index 3e06cc891..860b04e0b 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -6,31 +6,48 @@ "description": "Connection tests" }, "network": true, + "interface_control": true, "docker": { "depends_on": "base", "enable_container": true, "timeout": 600 }, "tests": [ + { + "name": "connection.dhcp.disconnect", + "description": "The device under test has received an IP address from the DHCP server and responds to an ICMP echo (ping) request", + "expected_behavior": "The device is not setup with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds succesfully to an ICMP echo (ping) request.", + "short_description": "Device has received an IP address after port disconnect" + }, + { + "name": "connection.dhcp.disconnect_ip_change", + "description": "Update device IP on the DHCP server and reconnect the device. Does the device receive the new IP address?", + "expected_behavior": "Device recieves a new IP address within the range that is specified on the DHCP server. Device should respond to aping on this new address.", + "short_description": "Device has received new IP address after port disconnect" + }, { "name": "connection.dhcp_address", "description": "The device under test has received an IP address from the DHCP server and responds to an ICMP echo (ping) request", - "expected_behavior": "The device is not setup with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds succesfully to an ICMP echo (ping) request." + "expected_behavior": "The device is not setup with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds succesfully to an ICMP echo (ping) request.", + "short_description": "Device has received a DHCP provided IP address" }, { "name": "connection.mac_address", "description": "Check and note device physical address.", - "expected_behavior": "N/A" + "expected_behavior": "N/A", + "short_description": "Device MAC address resolved" }, { "name": "connection.mac_oui", "description": "The device under test hs a MAC address prefix that is registered against a known manufacturer.", - "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database." + "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database.", + "short_description": "OUI for MAC address resolved" }, { "name": "connection.private_address", "description": "The device under test accepts an IP address that is compliant with RFC 1918 Address Allocation for Private Internets.", "expected_behavior": "The device under test accepts IP addresses within all ranges specified in RFC 1918 and communicates using these addresses. The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of the IP address space for private internets. 10.0.0.0 - 10.255.255.255.255 (10/8 prefix). 172.16.0.0 - 172.31.255.255 (172.16/12 prefix). 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)", + "short_description": "Device supports private addresses", "config": { "ranges": [ { @@ -52,6 +69,7 @@ "name": "connection.shared_address", "description": "Ensure the device supports RFC 6598 IANA-Reserved IPv4 Prefix for Shared Address Space", "expected_behavior": "The device under test accepts IP addresses within the ranges specified in RFC 6598 and communicates using these addresses", + "short_description": "Device supports shared address space", "config": { "ranges": [ { @@ -64,32 +82,38 @@ { "name": "connection.single_ip", "description": "The network switch port connected to the device reports only one IP address for the device under test.", - "expected_behavior": "The device under test does not behave as a network switch and only requets one IP address. This test is to avoid that devices implement network switches that allow connecting strings of daisy chained devices to one single network port, as this would not make 802.1x port based authentication possible." + "expected_behavior": "The device under test does not behave as a network switch and only requets one IP address. This test is to avoid that devices implement network switches that allow connecting strings of daisy chained devices to one single network port, as this would not make 802.1x port based authentication possible.", + "short_description": "Device only reports one IP address" }, { "name": "connection.target_ping", "description": "The device under test responds to an ICMP echo (ping) request.", - "expected_behavior": "The device under test responds to an ICMP echo (ping) request." + "expected_behavior": "The device under test responds to an ICMP echo (ping) request.", + "short_description": "Device responds to a ping request" }, { "name": "connection.ipaddr.ip_change", - "description": "The device responds to a ping (ICMP echo request) to the new IP address it has received after the initial dHCP lease has expired.", - "expected_behavior": "If the lease expires before the client receiveds a DHCPACK, the client moves to INIT state, MUST immediately stop any other network processing and requires network initialization parameters as if the client were uninitialized. If the client then receives a DHCPACK allocating the client its previous network addres, the client SHOULD continue network processing. If the client is given a new network address, it MUST NOT continue using the previous network address and SHOULD notify the local users of the problem." + "description": "The device responds to a ping (ICMP echo request) to the new IP address it has received after the initial DHCP lease has expired.", + "expected_behavior": "If the lease expires before the client receiveds a DHCPACK, the client moves to INIT state, MUST immediately stop any other network processing and requires network initialization parameters as if the client were uninitialized. If the client then receives a DHCPACK allocating the client its previous network addres, the client SHOULD continue network processing. If the client is given a new network address, it MUST NOT continue using the previous network address and SHOULD notify the local users of the problem.", + "short_description": "Device receives an IP change from the DHCP server" }, { "name": "connection.ipaddr.dhcp_failover", "description": "The device has requested a DHCPREQUEST/REBIND to the DHCP failover server after the primary DHCP server has been brought down.", - "expected_behavior": "" + "expected_behavior": "", + "short_description": "Device receives IP address from primary and failover DHCP servers" }, { "name": "connection.ipv6_slaac", "description": "The device forms a valid IPv6 address as a combination of the IPv6 router prefix and the device interface identifier", - "expected_behavior": "The device under test complies with RFC4862 and forms a valid IPv6 SLAAC address" + "expected_behavior": "The device under test complies with RFC4862 and forms a valid IPv6 SLAAC address", + "short_description": "Device uses an IPv6 address using SLAAC" }, { "name": "connection.ipv6_ping", "description": "The device responds to an IPv6 ping (ICMPv6 Echo) request to the SLAAC address", - "expected_behavior": "The device responds to the ping as per RFC4443" + "expected_behavior": "The device responds to the ping as per RFC4443", + "short_description": "Device responds to an IPv6 SLAAC address ping request" } ] } diff --git a/modules/test/conn/python/requirements.txt b/modules/test/conn/python/requirements.txt index 2b8d18750..c523787b9 100644 --- a/modules/test/conn/python/requirements.txt +++ b/modules/test/conn/python/requirements.txt @@ -1 +1,2 @@ -pyOpenSSL \ No newline at end of file +pyOpenSSL +scapy \ No newline at end of file diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 169fb98c3..248edc536 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -253,6 +253,7 @@ def _get_oui_manufacturer(self, mac_address): def _connection_ipv6_slaac(self): LOGGER.info('Running connection.ipv6_slaac') + result = None packet_capture = rdpcap(MONITOR_CAPTURE_FILE) sends_ipv6 = False @@ -265,27 +266,31 @@ def _connection_ipv6_slaac(self): if ipv6_addr.startswith(SLAAC_PREFIX): self._device_ipv6_addr = ipv6_addr LOGGER.info(f'Device has formed SLAAC address {ipv6_addr}') - return True - - if sends_ipv6: - LOGGER.info('Device does not support IPv6 SLAAC') - else: - LOGGER.info('Device does not support IPv6') - return False + result = True, f'Device has formed SLAAC address {ipv6_addr}' + if result is None: + if sends_ipv6: + LOGGER.info('Device does not support IPv6 SLAAC') + result = False, 'Device does not support IPv6 SLAAC' + else: + LOGGER.info('Device does not support IPv6') + result = False, 'Device does not support IPv6' + return result def _connection_ipv6_ping(self): LOGGER.info('Running connection.ipv6_ping') - + result = None + if self._device_ipv6_addr is None: LOGGER.info('No IPv6 SLAAC address found. Cannot ping') - return - - if self._ping(self._device_ipv6_addr): - LOGGER.info(f'Device responds to IPv6 ping on {self._device_ipv6_addr}') - return True + result = None, 'No IPv6 SLAAc address found. Cannot ping' else: - LOGGER.info('Device does not respond to IPv6 ping') - return False + if self._ping(self._device_ipv6_addr): + LOGGER.info(f'Device responds to IPv6 ping on {self._device_ipv6_addr}') + result = True, f'Device responds to IPv6 ping on {self._device_ipv6_addr}' + else: + LOGGER.info('Device does not respond to IPv6 ping') + result = False, 'Device does not respond to IPv6 ping' + return result def _ping(self, host): cmd = 'ping -c 1 ' + str(host) diff --git a/modules/test/dns/conf/module_config.json b/modules/test/dns/conf/module_config.json index 177537b69..b5e3c8420 100644 --- a/modules/test/dns/conf/module_config.json +++ b/modules/test/dns/conf/module_config.json @@ -15,16 +15,19 @@ { "name": "dns.network.from_device", "description": "Verify the device sends DNS requests", - "expected_behavior": "The device sends DNS requests." + "expected_behavior": "The device sends DNS requests.", + "short_description": "The device sends DNS requests." }, { "name": "dns.network.from_dhcp", "description": "Verify the device allows for a DNS server to be entered automatically", - "expected_behavior": "The device sends DNS requests to the DNS server provided by the DHCP server" + "expected_behavior": "The device sends DNS requests to the DNS server provided by the DHCP server", + "short_description": "The device sends DNS requests to local DNS server." }, { "name": "dns.mdns", - "description": "If the device has MDNS (or any kind of IP multicast), can it be disabled" + "description": "If the device has MDNS (or any kind of IP multicast), can it be disabled", + "short_description": "MDNS traffic detected from device" } ] } diff --git a/modules/test/dns/python/src/dns_module.py b/modules/test/dns/python/src/dns_module.py index aecbd5bd1..bc56c3718 100644 --- a/modules/test/dns/python/src/dns_module.py +++ b/modules/test/dns/python/src/dns_module.py @@ -11,7 +11,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """DNS test module""" import subprocess from test_module import TestModule @@ -32,60 +31,84 @@ def __init__(self, module): global LOGGER LOGGER = self._get_logger() - def _check_dns_traffic(self, tcpdump_filter): - dns_server_queries = self._exec_tcpdump(tcpdump_filter,DNS_SERVER_CAPTURE_FILE) + def _has_dns_traffic(self, tcpdump_filter): + dns_server_queries = self._exec_tcpdump(tcpdump_filter, + DNS_SERVER_CAPTURE_FILE) LOGGER.info('DNS Server queries found: ' + str(len(dns_server_queries))) - dns_startup_queries = self._exec_tcpdump(tcpdump_filter,STARTUP_CAPTURE_FILE) + dns_startup_queries = self._exec_tcpdump(tcpdump_filter, + STARTUP_CAPTURE_FILE) LOGGER.info('Startup DNS queries found: ' + str(len(dns_startup_queries))) - dns_monitor_queries = self._exec_tcpdump(tcpdump_filter,MONITOR_CAPTURE_FILE) + dns_monitor_queries = self._exec_tcpdump(tcpdump_filter, + MONITOR_CAPTURE_FILE) LOGGER.info('Monitor DNS queries found: ' + str(len(dns_monitor_queries))) - num_query_dns = len(dns_server_queries) + len(dns_startup_queries) + len(dns_monitor_queries) - + num_query_dns = len(dns_server_queries) + len(dns_startup_queries) + len( + dns_monitor_queries) LOGGER.info('DNS queries found: ' + str(num_query_dns)) - dns_traffic_detected = num_query_dns > 0 - LOGGER.info('DNS traffic detected: ' + str(dns_traffic_detected)) - return dns_traffic_detected + + return num_query_dns > 0 def _dns_network_from_dhcp(self): - LOGGER.info("Running dns.network.from_dhcp") + LOGGER.info('Running dns.network.from_dhcp') + result = None LOGGER.info('Checking DNS traffic for configured DHCP DNS server: ' + self._dns_server) - # Check if the device DNS traffic is to appropriate server - tcpdump_filter = f'dst port 53 and dst host {self._dns_server} and ether src {self._device_mac}' - - result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) - - LOGGER.info('DNS traffic detected to configured DHCP DNS server: ' + - str(result)) + # Check if the device DNS traffic is to appropriate local + # DHCP provided server + tcpdump_filter = (f'dst port 53 and dst host {self._dns_server} ' + + 'and ether src {self._device_mac}') + dns_packets_local = self._has_dns_traffic(tcpdump_filter=tcpdump_filter) + + # Check if the device sends any DNS traffic to non-DHCP provided server + tcpdump_filter = (f'dst port 53 and dst not host {self._dns_server} ' + + 'ether src {self._device_mac}') + dns_packets_not_local = self._has_dns_traffic(tcpdump_filter=tcpdump_filter) + + if dns_packets_local or dns_packets_not_local: + if dns_packets_not_local: + result = False, 'DNS traffic detected to non-DHCP provided server' + else: + LOGGER.info('DNS traffic detected only to configured DHCP DNS server') + result = True, 'DNS traffic detected only to DHCP provided server' + else: + LOGGER.info('No DNS traffic detected from the device') + result = None, 'No DNS traffic detected from the device' return result def _dns_network_from_device(self): - LOGGER.info("Running dns.network.from_device") + LOGGER.info('Running dns.network.from_device') + result = None LOGGER.info('Checking DNS traffic from device: ' + self._device_mac) - # Check if the device DNS traffic is to appropriate server + # Check if the device DNS traffic tcpdump_filter = f'dst port 53 and ether src {self._device_mac}' - - result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) - - LOGGER.info('DNS traffic detected from device: ' + str(result)) + dns_packetes = self._has_dns_traffic(tcpdump_filter=tcpdump_filter) + + if dns_packetes: + LOGGER.info('DNS traffic detected from device') + result = True, 'DNS traffic detected from device' + else: + LOGGER.info('No DNS traffic detected from the device') + result = False, 'No DNS traffic detected from the device' return result def _dns_mdns(self): - LOGGER.info("Running dns.mdns") - + LOGGER.info('Running dns.mdns') + result = None # Check if the device sends any MDNS traffic tcpdump_filter = f'udp port 5353 and ether src {self._device_mac}' - - result = self._check_dns_traffic(tcpdump_filter=tcpdump_filter) - - LOGGER.info('MDNS traffic detected from device: ' + str(result)) - return not result - + dns_packetes = self._has_dns_traffic(tcpdump_filter=tcpdump_filter) + + if dns_packetes: + LOGGER.info('MDNS traffic detected from device') + result = True, 'MDNS traffic detected from device' + else: + LOGGER.info('No MDNS traffic detected from the device') + result = None, 'No MDNS traffic detected from the device' + return result def _exec_tcpdump(self, tcpdump_filter, capture_file): """ diff --git a/modules/test/nmap/conf/module_config.json b/modules/test/nmap/conf/module_config.json index 292eced8b..b03e9511c 100644 --- a/modules/test/nmap/conf/module_config.json +++ b/modules/test/nmap/conf/module_config.json @@ -16,6 +16,7 @@ "name": "security.nmap.ports", "description": "Run an nmap scan of open ports", "expected_behavior": "Report all open ports", + "short_description": "NMAP scan reports no unallowed ports open", "config": { "security.services.ftp": { "tcp_ports": { diff --git a/modules/test/nmap/python/src/nmap_module.py b/modules/test/nmap/python/src/nmap_module.py index f998f302a..6bcbd141a 100644 --- a/modules/test/nmap/python/src/nmap_module.py +++ b/modules/test/nmap/python/src/nmap_module.py @@ -40,6 +40,7 @@ def __init__(self, module): def _security_nmap_ports(self, config): LOGGER.info("Running security.nmap.ports test") + result = None # Delete the enabled key from the config if it exists # to prevent it being treated as a test key @@ -74,10 +75,14 @@ def _security_nmap_ports(self, config): LOGGER.info("Unallowed Ports Detected: " + str(self._unallowed_ports)) self._check_unallowed_port(self._unallowed_ports,config) LOGGER.info("Unallowed Ports: " + str(self._unallowed_ports)) - return len(self._unallowed_ports) == 0 + if len(self._unallowed_ports) > 0: + result = False, 'Some allowed ports detected: ' + str(self._unallowed_ports) + else: + result = True, 'No unallowed ports detected' else: LOGGER.info("Device ip address not resolved, skipping") - return None + result = None, "Device ip address not resolved" + return result def _process_port_results(self, tests): scan_results = {} diff --git a/modules/test/nmap/python/src/run.py b/modules/test/nmap/python/src/run.py index 5e33451d9..e68b52525 100644 --- a/modules/test/nmap/python/src/run.py +++ b/modules/test/nmap/python/src/run.py @@ -20,7 +20,7 @@ from nmap_module import NmapModule -LOG_NAME = "nmap_runner" +LOG_NAME = 'nmap_runner' LOGGER = logger.get_logger(LOG_NAME) class NmapModuleRunner: @@ -39,7 +39,7 @@ def __init__(self, module): self._test_module = NmapModule(module) self._test_module.run_tests() - LOGGER.info("nmap test module finished") + LOGGER.info('nmap test module finished') def add_logger(self, module): global LOGGER diff --git a/modules/test/ntp/conf/module_config.json b/modules/test/ntp/conf/module_config.json index 288474868..c20d2067b 100644 --- a/modules/test/ntp/conf/module_config.json +++ b/modules/test/ntp/conf/module_config.json @@ -15,12 +15,14 @@ { "name": "ntp.network.ntp_support", "description": "Does the device request network time sync as client as per RFC 5905 - Network Time Protocol Version 4: Protocol and Algorithms Specification", - "expected_behavior": "The device sends an NTPv4 request to the configured NTP server." + "expected_behavior": "The device sends an NTPv4 request to the configured NTP server.", + "short_description": "The device sends NTPv4 requests" }, { "name": "ntp.network.ntp_dhcp", "description": "Accept NTP address over DHCP", - "expected_behavior": "Device can accept NTP server address, provided by the DHCP server (DHCP OFFER PACKET)" + "expected_behavior": "Device can accept NTP server address, provided by the DHCP server (DHCP OFFER PACKET)", + "short_descriiption": "Accepts NTP address over DHCP" } ] } diff --git a/modules/test/ntp/python/src/ntp_module.py b/modules/test/ntp/python/src/ntp_module.py index 4053ce98a..6a577d1a6 100644 --- a/modules/test/ntp/python/src/ntp_module.py +++ b/modules/test/ntp/python/src/ntp_module.py @@ -11,7 +11,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """NTP test module""" from test_module import TestModule from scapy.all import rdpcap, NTP, IP @@ -22,6 +21,7 @@ MONITOR_CAPTURE_FILE = '/runtime/device/monitor.pcap' LOGGER = None + class NTPModule(TestModule): """NTP Test module""" @@ -35,7 +35,7 @@ def __init__(self, module): def _ntp_network_ntp_support(self): LOGGER.info('Running ntp.network.ntp_support') - + result = None packet_capture = rdpcap(STARTUP_CAPTURE_FILE) + rdpcap(MONITOR_CAPTURE_FILE) device_sends_ntp4 = False @@ -52,28 +52,47 @@ def _ntp_network_ntp_support(self): LOGGER.info(f'Device sent NTPv3 request to {packet[IP].dst}') if not (device_sends_ntp3 or device_sends_ntp4): - LOGGER.info('Device has not sent any NTP requests') - - return device_sends_ntp4 and not device_sends_ntp3 + result = False, 'Device has not sent any NTP requests' + elif device_sends_ntp3 and device_sends_ntp4: + result = False, ('Device sent NTPv3 and NTPv4 packets. ' + + 'NTPv3 is not allowed.') + elif device_sends_ntp3: + result = False, ('Device sent NTPv3 packets. ' + 'NTPv3 is not allowed.') + elif device_sends_ntp4: + result = True, 'Device sent NTPv4 packets.' + LOGGER.info(result[1]) + return result def _ntp_network_ntp_dhcp(self): LOGGER.info('Running ntp.network.ntp_dhcp') - + result = None packet_capture = rdpcap(STARTUP_CAPTURE_FILE) + rdpcap(MONITOR_CAPTURE_FILE) device_sends_ntp = False + ntp_to_local = False + ntp_to_remote = False for packet in packet_capture: - if NTP in packet and packet.src == self._device_mac: device_sends_ntp = True if packet[IP].dst == self._ntp_server: LOGGER.info('Device sent NTP request to DHCP provided NTP server') - return True - - if not device_sends_ntp: - LOGGER.info('Device has not sent any NTP requests') + ntp_to_local = True + else: + LOGGER.info('Device sent NTP request to non-DHCP provided NTP server') + ntp_to_remote = True + + if device_sends_ntp: + if ntp_to_local and ntp_to_remote: + result = False, ('Device sent NTP request to DHCP provided ' + + 'server and non-DHCP provided server') + elif ntp_to_remote: + result = False, 'Device sent NTP request to non-DHCP provided server' + elif ntp_to_local: + result = True, 'Device sent NTP request to DHCP provided server' else: - LOGGER.info('Device has not sent NTP requests to DHCP provided NTP server') + result = False, 'Device has not sent any NTP requests' - return False + LOGGER.info(result[1]) + return result diff --git a/modules/test/tls/conf/module_config.json b/modules/test/tls/conf/module_config.json index 59e5a839d..f71f39914 100644 --- a/modules/test/tls/conf/module_config.json +++ b/modules/test/tls/conf/module_config.json @@ -15,22 +15,26 @@ { "name": "security.tls.v1_2_server", "description": "Check the device web server TLS 1.2 & certificate is valid", - "expected_behavior": "TLS 1.2 certificate is issued to the web browser client when accessed" + "expected_behavior": "TLS 1.2 certificate is issued to the web browser client when accessed", + "short_description": "TLS 1.2 server certificate is valid" }, { "name": "security.tls.v1_3_server", "description": "Check the device web server TLS 1.3 & certificate is valid", - "expected_behavior": "TLS 1.3 certificate is issued to the web browser client when accessed" + "expected_behavior": "TLS 1.3 certificate is issued to the web browser client when accessed", + "short_description": "TLS 1.3 server certificate is valid" }, { "name": "security.tls.v1_2_client", "description": "Device uses TLS with connection to an external service on port 443 (or any other port which could be running the webserver-HTTPS)", - "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.2 and support for ECDH and ECDSA ciphers" + "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.2 and support for ECDH and ECDSA ciphers", + "short_description": "TLS 1.2 outbound connection valid" }, { "name": "security.tls.v1_3_client", "description": "Device uses TLS with connection to an external service on port 443 (or any other port which could be running the webserver-HTTPS)", - "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.3" + "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.3", + "short_description": "TLS 1.3 outbound connection valid" } ] } diff --git a/modules/test/tls/python/src/tls_module_test.py b/modules/test/tls/python/src/tls_module_test.py index 84a1c70eb..099956f4e 100644 --- a/modules/test/tls/python/src/tls_module_test.py +++ b/modules/test/tls/python/src/tls_module_test.py @@ -31,6 +31,7 @@ class TLSModuleTest(unittest.TestCase): """Contains and runs all the unit tests concerning TLS behaviors""" + @classmethod def setUpClass(cls): log = logger.get_logger(MODULE_NAME) @@ -129,13 +130,29 @@ def security_tls_v1_3_client_test(self): self.assertTrue(test_results[0]) def client_hello_packets_test(self): - packet_fail = {'dst_ip': '10.10.10.1', 'src_ip': '10.10.10.14', 'dst_port': '443', 'cipher_support': {'ecdh': False, 'ecdsa': True}} - packet_success = {'dst_ip': '10.10.10.1', 'src_ip': '10.10.10.14', 'dst_port': '443', 'cipher_support': {'ecdh': True, 'ecdsa': True}} - hello_packets = [packet_fail,packet_success] - hello_results = TLS_UTIL.process_hello_packets(hello_packets,'1.2') - print("Hello packets test results: " + str(hello_results)) - expected = {'valid':[packet_success],'invalid':[]} - self.assertEqual(hello_results,expected) + packet_fail = { + 'dst_ip': '10.10.10.1', + 'src_ip': '10.10.10.14', + 'dst_port': '443', + 'cipher_support': { + 'ecdh': False, + 'ecdsa': True + } + } + packet_success = { + 'dst_ip': '10.10.10.1', + 'src_ip': '10.10.10.14', + 'dst_port': '443', + 'cipher_support': { + 'ecdh': True, + 'ecdsa': True + } + } + hello_packets = [packet_fail, packet_success] + hello_results = TLS_UTIL.process_hello_packets(hello_packets, '1.2') + print('Hello packets test results: ' + str(hello_results)) + expected = {'valid': [packet_success], 'invalid': []} + self.assertEqual(hello_results, expected) def test_client_tls(self, tls_version, From 9046ffdb1741b0a5a2db3009f74593da60417284 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Fri, 11 Aug 2023 09:39:47 -0700 Subject: [PATCH 066/400] Misc cleanup (#93) * Fix network request from module config Misc formatting issues in test orchestrator * fix misc network orchestrator formatting issues * fix misc ovs control formatting issues * fix misc ip control formatting issues --- framework/python/src/net_orc/ip_control.py | 20 ++-- .../src/net_orc/network_orchestrator.py | 92 +++++++++---------- framework/python/src/net_orc/ovs_control.py | 12 +-- .../python/src/test_orc/test_orchestrator.py | 74 +++++++-------- 4 files changed, 90 insertions(+), 108 deletions(-) diff --git a/framework/python/src/net_orc/ip_control.py b/framework/python/src/net_orc/ip_control.py index eb683c46b..5c9f86d18 100644 --- a/framework/python/src/net_orc/ip_control.py +++ b/framework/python/src/net_orc/ip_control.py @@ -34,7 +34,7 @@ def add_link(self, interface_name, peer_name): def add_namespace(self, namespace): """Add a network namespace""" exists = self.namespace_exists(namespace) - LOGGER.info("Namespace exists: " + str(exists)) + LOGGER.info('Namespace exists: ' + str(exists)) if exists: return True else: @@ -58,14 +58,11 @@ def link_exists(self, link_name): def namespace_exists(self, namespace): """Check if a namespace already exists""" namespaces = self.get_namespaces() - if namespace in namespaces: - return True - else: - return False + return namespace in namespaces def get_links(self): - stdout, stderr = util.run_command('ip link list') - links = stdout.strip().split('\n') + result = util.run_command('ip link list') + links = result[0].strip().split('\n') netns_links = [] for link in links: match = re.search(r'\d+:\s+(\S+)', link) @@ -78,9 +75,9 @@ def get_links(self): return netns_links def get_namespaces(self): - stdout, stderr = util.run_command('ip netns list') + result = util.run_command('ip netns list') #Strip ID's from the namespace results - namespaces = re.findall(r'(\S+)(?:\s+\(id: \d+\))?', stdout) + namespaces = re.findall(r'(\S+)(?:\s+\(id: \d+\))?', result[0]) return namespaces def set_namespace(self, interface_name, namespace): @@ -187,9 +184,8 @@ def configure_container_interface(self, # Rename container interface name if not self.rename_interface(container_intf, namespace, namespace_intf): - LOGGER.error( - f'Failed to rename container interface {container_intf} to {namespace_intf}' - ) + LOGGER.error((f'Failed to rename container interface {container_intf} ' + + 'to {namespace_intf}')) return False # Set MAC address of container interface diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index ebeeba2dd..19cf0081a 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -11,7 +11,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """Network orchestrator is responsible for managing all of the virtual network services""" import ipaddress @@ -44,13 +43,11 @@ PRIVATE_DOCKER_NET = 'tr-private-net' CONTAINER_NAME = 'network_orchestrator' + class NetworkOrchestrator: """Manage and controls a virtual testing network.""" - def __init__(self, - session, - validate=True, - single_intf=False): + def __init__(self, session, validate=True, single_intf=False): self._session = session self._monitor_in_progress = False @@ -103,8 +100,9 @@ def check_config(self): return False else: if not device_interface_ready and not internet_interface_ready: - LOGGER.error('Both device and internet interfaces are not ready for use. ' + - 'Ensure both interfaces are connected.') + LOGGER.error( + 'Both device and internet interfaces are not ready for use. ' + + 'Ensure both interfaces are connected.') return False elif not device_interface_ready: LOGGER.error('Device interface is not ready for use. ' + @@ -169,14 +167,13 @@ def _device_discovered(self, mac_addr): f'Discovered device {mac_addr}. Waiting for device to obtain IP') if device is None: - LOGGER.debug(f'Device with MAC address {mac_addr} does not exist in device repository') + LOGGER.debug(f'Device with MAC address {mac_addr} does not exist' + + ' in device repository') # Ignore device if not registered return - device_runtime_dir = os.path.join(RUNTIME_DIR, - TEST_DIR, - mac_addr.replace(':', '') - ) + device_runtime_dir = os.path.join(RUNTIME_DIR, TEST_DIR, + mac_addr.replace(':', '')) # Cleanup any old current test files shutil.rmtree(device_runtime_dir, ignore_errors=True) @@ -187,11 +184,7 @@ def _device_discovered(self, mac_addr): packet_capture = sniff(iface=self._session.get_device_interface(), timeout=self._session.get_startup_timeout(), stop_filter=self._device_has_ip) - wrpcap( - os.path.join(device_runtime_dir, - 'startup.pcap' - ), - packet_capture) + wrpcap(os.path.join(device_runtime_dir, 'startup.pcap'), packet_capture) if device.ip_addr is None: LOGGER.info( @@ -228,23 +221,17 @@ def _start_device_monitor(self, device): callback the steady state method for this device.""" LOGGER.info(f'Monitoring device with mac addr {device.mac_addr} ' f'for {str(self._session.get_monitor_period())} seconds') - - device_runtime_dir = os.path.join(RUNTIME_DIR, - TEST_DIR, - device.mac_addr.replace(':', '') - ) - - packet_capture = sniff(iface=self._session.get_device_interface(), timeout=self._session.get_monitor_period()) - wrpcap( - os.path.join(device_runtime_dir, - 'monitor.pcap' - ), - packet_capture) + + device_runtime_dir = os.path.join(RUNTIME_DIR, TEST_DIR, + device.mac_addr.replace(':', '')) + + packet_capture = sniff(iface=self._session.get_device_interface(), + timeout=self._session.get_monitor_period()) + wrpcap(os.path.join(device_runtime_dir, 'monitor.pcap'), packet_capture) self._monitor_in_progress = False - self.get_listener().call_callback( - NetworkEvent.DEVICE_STABLE, - device.mac_addr) + self.get_listener().call_callback(NetworkEvent.DEVICE_STABLE, + device.mac_addr) def _check_network_services(self): LOGGER.debug('Checking network modules...') @@ -297,24 +284,32 @@ def _ci_pre_network_create(self): 'ip route | head -n 1 | awk \'{print $3}\'', shell=True).decode('utf-8').strip() self._ipv4 = subprocess.check_output( - f'ip a show {self._session.get_internet_interface()} | grep \"inet \" | awk \'{{print $2}}\'', + (f'ip a show {self._session.get_internet_interface()} | ' + + 'grep \"inet \" | awk \'{{print $2}}\''), shell=True).decode('utf-8').strip() self._ipv6 = subprocess.check_output( - f'ip a show {self._session.get_internet_interface()} | grep inet6 | awk \'{{print $2}}\'', + (f'ip a show {self._session.get_internet_interface()} | grep inet6 | ' + + 'awk \'{{print $2}}\''), shell=True).decode('utf-8').strip() self._brd = subprocess.check_output( - f'ip a show {self._session.get_internet_interface()} | grep \"inet \" | awk \'{{print $4}}\'', + (f'ip a show {self._session.get_internet_interface()} | grep \"inet \" ' + + '| awk \'{{print $4}}\''), shell=True).decode('utf-8').strip() def _ci_post_network_create(self): """ Restore network connection in CI environment """ LOGGER.info('post cr') - util.run_command(f'ip address del {self._ipv4} dev {self._session.get_internet_interface()}') - util.run_command(f'ip -6 address del {self._ipv6} dev {self._session.get_internet_interface()}') + util.run_command(((f'ip address del {self._ipv4} ' + + 'dev {self._session.get_internet_interface()}'))) + util.run_command((f'ip -6 address del {self._ipv6} ' + + 'dev {self._session.get_internet_interface()}')) util.run_command( - f'ip link set dev {self._session.get_internet_interface()} address 00:B0:D0:63:C2:26') - util.run_command(f'ip addr flush dev {self._session.get_internet_interface()}') - util.run_command(f'ip addr add dev {self._session.get_internet_interface()} 0.0.0.0') + (f'ip link set dev {self._session.get_internet_interface()} ' + + 'address 00:B0:D0:63:C2:26')) + util.run_command( + f'ip addr flush dev {self._session.get_internet_interface()}') + util.run_command( + f'ip addr add dev {self._session.get_internet_interface()} 0.0.0.0') util.run_command( f'ip addr add dev {INTERNET_BRIDGE} {self._ipv4} broadcast {self._brd}') util.run_command(f'ip -6 addr add {self._ipv6} dev {INTERNET_BRIDGE} ') @@ -331,7 +326,7 @@ def create_net(self): # TODO: This is not just for CI #if self._single_intf: - #self._ci_pre_network_create() + #self._ci_pre_network_create() # Setup the virtual network if not self._ovs.create_baseline_net(verify=True): @@ -341,15 +336,15 @@ def create_net(self): # TODO: This is not just for CI #if self._single_intf: - #self._ci_post_network_create() + #self._ci_post_network_create() self._create_private_net() self._listener = Listener(self._session) self.get_listener().register_callback(self._device_discovered, - [NetworkEvent.DEVICE_DISCOVERED]) + [NetworkEvent.DEVICE_DISCOVERED]) self.get_listener().register_callback(self._dhcp_lease_ack, - [NetworkEvent.DHCP_LEASE_ACK]) + [NetworkEvent.DHCP_LEASE_ACK]) def load_network_modules(self): """Load network modules from module_config.json.""" @@ -624,7 +619,7 @@ def _attach_service_to_network(self, net_module): # Add and configure the interface container if not self._ip_ctrl.configure_container_interface( - bridge_intf, container_intf, "veth0", container_net_ns, mac_addr, + bridge_intf, container_intf, 'veth0', container_net_ns, mac_addr, net_module.container_name, ipv4_addr, ipv6_addr): LOGGER.error('Failed to configure local networking for ' + net_module.name + '. Exiting.') @@ -650,7 +645,7 @@ def _attach_service_to_network(self, net_module): container_intf = 'tr-cti-' + net_module.dir_name if not self._ip_ctrl.configure_container_interface( - bridge_intf, container_intf, "eth1", container_net_ns, mac_addr): + bridge_intf, container_intf, 'eth1', container_net_ns, mac_addr): LOGGER.error('Failed to configure internet networking for ' + net_module.name + '. Exiting.') sys.exit(1) @@ -667,7 +662,8 @@ def restore_net(self): LOGGER.info('Clearing baseline network') - if hasattr(self, 'listener') and self.get_listener() is not None and self.get_listener().is_running(): + if hasattr(self, 'listener') and self.get_listener( + ) is not None and self.get_listener().is_running(): self.get_listener().stop_listener() client = docker.from_env() @@ -719,6 +715,7 @@ def __init__(self): self.net_config = NetworkModuleNetConfig() + class NetworkModuleNetConfig: """Define all the properties of the network config for a network module""" @@ -741,6 +738,7 @@ def get_ipv4_addr_with_prefix(self): def get_ipv6_addr_with_prefix(self): return format(self.ipv6_address) + '/' + str(self.ipv6_network.prefixlen) + class NetworkConfig: """Define all the properties of the network configuration""" diff --git a/framework/python/src/net_orc/ovs_control.py b/framework/python/src/net_orc/ovs_control.py index a2769632c..80f76e85f 100644 --- a/framework/python/src/net_orc/ovs_control.py +++ b/framework/python/src/net_orc/ovs_control.py @@ -11,10 +11,7 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - """OVS Control Module""" -import json -import os from common import logger from common import util @@ -80,12 +77,14 @@ def validate_baseline_network(self): int_bridge = True # Verify the device bridge - dev_bridge = self.verify_bridge(DEVICE_BRIDGE, [self._session.get_device_interface()]) + dev_bridge = self.verify_bridge(DEVICE_BRIDGE, + [self._session.get_device_interface()]) LOGGER.debug('Device bridge verified: ' + str(dev_bridge)) # Verify the internet bridge if 'single_intf' not in self._session.get_runtime_params(): - int_bridge = self.verify_bridge(INTERNET_BRIDGE, [self._session.get_internet_interface()]) + int_bridge = self.verify_bridge(INTERNET_BRIDGE, + [self._session.get_internet_interface()]) LOGGER.debug('Internet bridge verified: ' + str(int_bridge)) return dev_bridge and int_bridge @@ -118,7 +117,8 @@ def create_baseline_net(self, verify=True): # Remove IP from internet adapter if not 'single_intf' in self._session.get_runtime_params(): - self.set_interface_ip(interface=self._session.get_internet_interface(), ip_addr='0.0.0.0') + self.set_interface_ip(interface=self._session.get_internet_interface(), + ip_addr='0.0.0.0') self.add_port(self._session.get_internet_interface(), INTERNET_BRIDGE) # Enable forwarding of eapol packets diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index 7a7d19bdb..b9353c995 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -28,7 +28,7 @@ RUNTIME_DIR = "runtime/test" TEST_MODULES_DIR = "modules/test" MODULE_CONFIG = "conf/module_config.json" -LOG_REGEX = r'^[A-Z][a-z]{2} [0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} test_' +LOG_REGEX = r"^[A-Z][a-z]{2} [0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} test_" SAVED_DEVICE_REPORTS = "local/devices/{device_folder}/reports" DEVICE_ROOT_CERTS = "local/root_certs" @@ -79,7 +79,7 @@ def run_test_modules(self): for module in self._test_modules: self._run_test_module(module) LOGGER.info("All tests complete") - + self._session.stop() self._generate_report() self._test_in_progress = False @@ -96,16 +96,17 @@ def _generate_report(self): report = {} report["device"] = self._session.get_target_device().to_json() - report["started"] = self._session.get_started().strftime("%Y-%m-%d %H:%M:%S") - report["finished"] = self._session.get_finished().strftime("%Y-%m-%d %H:%M:%S") + report["started"] = self._session.get_started().strftime( + "%Y-%m-%d %H:%M:%S") + report["finished"] = self._session.get_finished().strftime( + "%Y-%m-%d %H:%M:%S") report["status"] = self._session.get_status() report["results"] = self._session.get_test_results() out_file = os.path.join( - self._root_path, - RUNTIME_DIR, + self._root_path, RUNTIME_DIR, self._session.get_target_device().mac_addr.replace(":", ""), "report.json") - + with open(out_file, "w", encoding="utf-8") as f: json.dump(report, f, indent=2) util.run_command(f"chown -R {self._host_user} {out_file}") @@ -119,10 +120,8 @@ def _cleanup_old_test_results(self, device): max_device_reports = self._session.get_max_device_reports() completed_results_dir = os.path.join( - self._root_path, - SAVED_DEVICE_REPORTS.replace("{device_folder}", - device.device_folder) - ) + self._root_path, + SAVED_DEVICE_REPORTS.replace("{device_folder}", device.device_folder)) completed_tests = os.listdir(completed_results_dir) cur_test_count = len(completed_tests) @@ -138,7 +137,7 @@ def _cleanup_old_test_results(self, device): # Confirm the delete was succesful new_test_count = len(os.listdir(completed_results_dir)) if (new_test_count != cur_test_count - and new_test_count > max_device_reports): + and new_test_count > max_device_reports): # Continue cleaning up until we're under the max self._cleanup_old_test_results(device) @@ -158,18 +157,14 @@ def _find_oldest_test(self, completed_tests_dir): def _timestamp_results(self, device): # Define the current device results directory - cur_results_dir = os.path.join( - self._root_path, - RUNTIME_DIR, - device.mac_addr.replace(":", "") - ) + cur_results_dir = os.path.join(self._root_path, RUNTIME_DIR, + device.mac_addr.replace(":", "")) # Define the destination results directory with timestamp cur_time = datetime.now().strftime("%Y-%m-%dT%H:%M:%S") completed_results_dir = os.path.join( - SAVED_DEVICE_REPORTS.replace("{device_folder}", - device.device_folder), - cur_time) + SAVED_DEVICE_REPORTS.replace("{device_folder}", device.device_folder), + cur_time) # Copy the results to the timestamp directory # leave current copy in place for quick reference to @@ -204,30 +199,18 @@ def _run_test_module(self, module): try: - device_test_dir = os.path.join( - self._root_path, - RUNTIME_DIR, - device.mac_addr.replace(":", "") - ) - - container_runtime_dir = os.path.join( - device_test_dir, - module.name - ) + device_test_dir = os.path.join(self._root_path, RUNTIME_DIR, + device.mac_addr.replace(":", "")) + + container_runtime_dir = os.path.join(device_test_dir, module.name) os.makedirs(container_runtime_dir, exist_ok=True) network_runtime_dir = os.path.join(self._root_path, "runtime/network") - device_startup_capture = os.path.join( - device_test_dir, - "startup.pcap" - ) + device_startup_capture = os.path.join(device_test_dir, "startup.pcap") util.run_command(f"chown -R {self._host_user} {device_startup_capture}") - device_monitor_capture = os.path.join( - device_test_dir, - "monitor.pcap" - ) + device_monitor_capture = os.path.join(device_test_dir, "monitor.pcap") util.run_command(f"chown -R {self._host_user} {device_monitor_capture}") client = docker.from_env() @@ -286,24 +269,25 @@ def _run_test_module(self, module): line = next(log_stream).decode("utf-8").strip() if re.search(LOG_REGEX, line): print(line) - except Exception: # pylint: disable=W0718 + except Exception: # pylint: disable=W0718 time.sleep(1) status = self._get_module_status(module) # Get test results from module container_runtime_dir = os.path.join( - self._root_path, "runtime/test/" + - device.mac_addr.replace(":", "") + "/" + module.name) + self._root_path, + "runtime/test/" + device.mac_addr.replace(":", "") + "/" + module.name) results_file = f"{container_runtime_dir}/{module.name}-result.json" try: with open(results_file, "r", encoding="utf-8-sig") as f: module_results_json = json.load(f) - module_results = module_results_json['results'] + module_results = module_results_json["results"] for test_result in module_results: self._session.add_test_result(test_result) except (FileNotFoundError, PermissionError, json.JSONDecodeError) as results_error: - LOGGER.error(f"Error occured whilst obbtaining results for module {module.name}") + LOGGER.error( + f"Error occured whilst obbtaining results for module {module.name}") LOGGER.debug(results_error) LOGGER.info("Test module " + module.name + " has finished") @@ -379,6 +363,10 @@ def _load_test_module(self, module_dir): module.enable_container = module_json["config"]["docker"][ "enable_container"] + # Determine if this module needs network access + if "network" in module_json["config"]: + module.network = module_json["config"]["network"] + if "depends_on" in module_json["config"]["docker"]: depends_on_module = module_json["config"]["docker"]["depends_on"] if self._get_test_module(depends_on_module) is None: From 5c9c7ccc9caaa2a8f4e1c221325c05e9a4f62e71 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 16 Aug 2023 10:58:45 +0100 Subject: [PATCH 067/400] Allow CORS (#91) * Allow CORS * Fix add device * Configurable API port --- framework/python/src/api/api.py | 13 ++++++++++++- framework/python/src/common/device.py | 1 + framework/python/src/common/session.py | 10 +++++++++- framework/python/src/core/testrun.py | 3 ++- 4 files changed, 24 insertions(+), 3 deletions(-) diff --git a/framework/python/src/api/api.py b/framework/python/src/api/api.py index f63f1825a..379652574 100644 --- a/framework/python/src/api/api.py +++ b/framework/python/src/api/api.py @@ -13,6 +13,7 @@ # limitations under the License. from fastapi import FastAPI, APIRouter, Response, Request, status +from fastapi.middleware.cors import CORSMiddleware import json from json import JSONDecodeError import psutil @@ -52,8 +53,18 @@ def __init__(self, test_run): self._router.add_api_route("/devices", self.get_devices) self._router.add_api_route("/device", self.save_device, methods=["POST"]) + # TODO: Make this configurable in system.json + origins = ["http://localhost:4200"] + self._app = FastAPI() self._app.include_router(self._router) + self._app.add_middleware( + CORSMiddleware, + allow_origins=origins, + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], + ) self._api_thread = threading.Thread(target=self._start, name="Test Run API", @@ -65,7 +76,7 @@ def start(self): LOGGER.info("API waiting for requests") def _start(self): - uvicorn.run(self._app, log_config=None) + uvicorn.run(self._app, log_config=None, port=self._session.get_api_port()) def stop(self): LOGGER.info("Stopping API") diff --git a/framework/python/src/common/device.py b/framework/python/src/common/device.py index e2552d75a..bd5a8562f 100644 --- a/framework/python/src/common/device.py +++ b/framework/python/src/common/device.py @@ -20,6 +20,7 @@ class Device(): """Represents a physical device and it's configuration.""" + folder_url: str = None mac_addr: str = None manufacturer: str = None model: str = None diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py index 13e4b09fb..1eef8b98d 100644 --- a/framework/python/src/common/session.py +++ b/framework/python/src/common/session.py @@ -25,6 +25,7 @@ MONITOR_PERIOD_KEY = 'monitor_period' STARTUP_TIMEOUT_KEY = 'startup_timeout' LOG_LEVEL_KEY = 'log_level' +API_PORT_KEY = 'api_port' MAX_DEVICE_REPORTS_KEY = 'max_device_reports' class TestRunSession(): @@ -68,7 +69,8 @@ def _get_default_config(self): 'startup_timeout': 60, 'monitor_period': 30, 'runtime': 120, - 'max_device_reports': 5 + 'max_device_reports': 5, + 'api_port': 8000 } def get_config(self): @@ -101,6 +103,9 @@ def _load_config(self): if LOG_LEVEL_KEY in config_file_json: self._config[LOG_LEVEL_KEY] = config_file_json.get(LOG_LEVEL_KEY) + if API_PORT_KEY in config_file_json: + self._config[API_PORT_KEY] = config_file_json.get(API_PORT_KEY) + if MAX_DEVICE_REPORTS_KEY in config_file_json: self._config[MAX_DEVICE_REPORTS_KEY] = config_file_json.get(MAX_DEVICE_REPORTS_KEY) @@ -132,6 +137,9 @@ def get_monitor_period(self): def get_startup_timeout(self): return self._config.get(STARTUP_TIMEOUT_KEY) + def get_api_port(self): + return self._config.get(API_PORT_KEY) + def get_max_device_reports(self): return self._config.get(MAX_DEVICE_REPORTS_KEY) diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index 6e3a6da5d..5875c8e44 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -146,7 +146,8 @@ def _load_devices(self, device_dir): if 'max_device_reports' in device_config_json: max_device_reports = device_config_json.get(MAX_DEVICE_REPORTS_KEY) - device = Device(manufacturer=device_manufacturer, + device = Device(folder_url=os.path.join(device_dir, device_folder), + manufacturer=device_manufacturer, model=device_model, mac_addr=mac_addr, test_modules=test_modules, From 29242c469cc3558e874233b745c397a63ec00487 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 16 Aug 2023 22:17:49 +0100 Subject: [PATCH 068/400] Add /history and device config endpoints (#88) * Add /history and device config endpoints * Add total tests * Add report to device * Only run tests if baseline passes --- .github/workflows/testing.yml | 2 + framework/python/src/api/api.py | 24 ++-- framework/python/src/common/device.py | 26 +++- framework/python/src/common/session.py | 59 +++++++-- framework/python/src/common/testreport.py | 84 +++++++++++++ framework/python/src/core/testrun.py | 114 ++++++++++++++++-- framework/python/src/test_orc/module.py | 4 +- .../python/src/test_orc/test_orchestrator.py | 17 ++- testing/tests/test_tests | 2 +- 9 files changed, 290 insertions(+), 42 deletions(-) create mode 100644 framework/python/src/common/testreport.py diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index 9e6f35323..87c8a814a 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -21,6 +21,7 @@ jobs: testrun_tests: name: Tests runs-on: ubuntu-20.04 + needs: testrun_baseline timeout-minutes: 40 steps: - name: Checkout source @@ -28,6 +29,7 @@ jobs: - name: Run tests shell: bash {0} run: testing/tests/test_tests + pylint: name: Pylint runs-on: ubuntu-22.04 diff --git a/framework/python/src/api/api.py b/framework/python/src/api/api.py index 379652574..6b89da795 100644 --- a/framework/python/src/api/api.py +++ b/framework/python/src/api/api.py @@ -49,7 +49,7 @@ def __init__(self, test_run): self._router.add_api_route("/system/stop", self.stop_test_run, methods=["POST"]) self._router.add_api_route("/system/status", self.get_status) - + self._router.add_api_route("/history", self.get_history) self._router.add_api_route("/devices", self.get_devices) self._router.add_api_route("/device", self.save_device, methods=["POST"]) @@ -126,7 +126,6 @@ async def start_test_run(self, request: Request, response: Response): return self._generate_msg(False, "Invalid request received") device = self._session.get_device(body_json["device"]["mac_addr"]) - device.firmware = body_json["device"]["firmware"] # Check Test Run is not already running if self._test_run.get_session().get_status() != "Idle": @@ -140,11 +139,14 @@ async def start_test_run(self, request: Request, response: Response): return self._generate_msg(False, "A device with that MAC address could not be found") + device.firmware = body_json["device"]["firmware"] + # Check Test Run is able to start if self._test_run.get_net_orc().check_config() is False: response.status_code = status.HTTP_500_INTERNAL_SERVER_ERROR return self._generate_msg(False,"Configured interfaces are not ready for use. Ensure required interfaces are connected.") + self._test_run.get_session().reset() self._test_run.get_session().set_target_device(device) LOGGER.info(f"Starting Test Run with device target {device.manufacturer} {device.model} with MAC address {device.mac_addr}") @@ -171,7 +173,8 @@ async def get_status(self): return self._test_run.get_session().to_json() async def get_history(self): - LOGGER.info("Returning previous Test Runs to UI") + LOGGER.debug("Received history list request") + return self._session.get_all_reports() async def save_device(self, request: Request, response: Response): LOGGER.debug("Received device post request") @@ -185,18 +188,25 @@ async def save_device(self, request: Request, response: Response): return self._generate_msg(False, "Invalid request received") device = self._session.get_device(device_json.get(DEVICE_MAC_ADDR_KEY)) + if device is None: + # Create new device device = Device() device.mac_addr = device_json.get(DEVICE_MAC_ADDR_KEY) + device.manufacturer = device_json.get(DEVICE_MANUFACTURER_KEY) + device.model = device_json.get(DEVICE_MODEL_KEY) + device.device_folder = device.manufacturer + " " + device.model + + self._test_run.create_device(device) response.status_code = status.HTTP_201_CREATED - device.manufacturer = device_json.get(DEVICE_MANUFACTURER_KEY) - device.model = device_json.get(DEVICE_MODEL_KEY) + else: - self._session.save_device(device) + self._test_run.save_device(device, device_json) + response.status_code = status.HTTP_200_OK - return device + return device.to_config_json() # Catch JSON Decode error etc except JSONDecodeError: diff --git a/framework/python/src/common/device.py b/framework/python/src/common/device.py index bd5a8562f..41a9022cd 100644 --- a/framework/python/src/common/device.py +++ b/framework/python/src/common/device.py @@ -14,7 +14,8 @@ """Track device object information.""" -from dataclasses import dataclass +from typing import Dict +from dataclasses import dataclass, field @dataclass class Device(): @@ -24,13 +25,24 @@ class Device(): mac_addr: str = None manufacturer: str = None model: str = None - test_modules: str = None + test_modules: Dict = field(default_factory=dict) ip_addr: str = None firmware: str = None device_folder: str = None + reports = [] max_device_reports: int = None + def add_report(self, report): + self.reports.append(report) + + def get_reports(self): + return self.reports + + # TODO: Add ability to remove reports once test reports have been cleaned up + def to_json(self): + """Returns the device as a python dictionary. This is used for the + # system status API endpoint and in the report.""" device_json = {} device_json['mac_addr'] = self.mac_addr device_json['manufacturer'] = self.manufacturer @@ -38,3 +50,13 @@ def to_json(self): if self.firmware is not None: device_json['firmware'] = self.firmware return device_json + + def to_config_json(self): + """Returns the device as a python dictionary. Fields relevant to the device + config json file are exported.""" + device_json = {} + device_json['mac_addr'] = self.mac_addr + device_json['manufacturer'] = self.manufacturer + device_json['model'] = self.model + device_json['test_modules'] = self.test_modules + return device_json diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py index 1eef8b98d..f8c8d04b5 100644 --- a/framework/python/src/common/session.py +++ b/framework/python/src/common/session.py @@ -38,16 +38,14 @@ def __init__(self, config_file): self._finished = None self._results = [] self._runtime_params = [] - + self._device_repository = [] + self._total_tests = 0 self._config_file = config_file - self._config = self._get_default_config() self._load_config() - self._device_repository = [] - def start(self): - self._status = 'Starting' + self._status = 'Waiting for device' self._started = datetime.datetime.now() def get_started(self): @@ -136,7 +134,7 @@ def get_monitor_period(self): def get_startup_timeout(self): return self._config.get(STARTUP_TIMEOUT_KEY) - + def get_api_port(self): return self._config.get(API_PORT_KEY) @@ -159,16 +157,15 @@ def get_device_repository(self): def add_device(self, device): self._device_repository.append(device) + def clear_device_repository(self): + self._device_repository = [] + def get_device(self, mac_addr): for device in self._device_repository: if device.mac_addr == mac_addr: return device return None - def save_device(self, device): - # TODO: We need to save the folder path of the device config - return - def get_status(self): return self._status @@ -178,21 +175,57 @@ def set_status(self, status): def get_test_results(self): return self._results + def get_report_tests(self): + return { + 'total': self.get_total_tests(), + 'results': self.get_test_results() + } + def add_test_result(self, test_result): self._results.append(test_result) + def get_all_reports(self): + + reports = [] + + for device in self.get_device_repository(): + device_reports = device.get_reports() + for device_report in device_reports: + reports.append(device_report.to_json()) + + return reports + + def add_total_tests(self, no_tests): + self._total_tests += no_tests + + def get_total_tests(self): + return self._total_tests + def reset(self): self.set_status('Idle') self.set_target_device(None) - self._results = [] + self._tests = { + 'total': 0, + 'results': [] + } self._started = None self._finished = None def to_json(self): - return { + + # TODO: Add report URL + + results = { + 'total': self.get_total_tests(), + 'results': self.get_test_results() + } + + session_json = { 'status': self.get_status(), 'device': self.get_target_device(), 'started': self.get_started(), 'finished': self.get_finished(), - 'results': self.get_test_results() + 'tests': results } + + return session_json diff --git a/framework/python/src/common/testreport.py b/framework/python/src/common/testreport.py new file mode 100644 index 000000000..ba35ff27a --- /dev/null +++ b/framework/python/src/common/testreport.py @@ -0,0 +1,84 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Store previous test run information.""" + +from datetime import datetime + +DATE_TIME_FORMAT = '%Y-%m-%d %H:%M:%S' + +class TestReport(): + """Represents a previous Test Run report.""" + + def __init__(self, + status='Non-Compliant', + started=None, + finished=None, + total_tests=0 + ): + self._device = {} + self._status: str = status + self._started = started + self._finished = finished + self._total_tests = total_tests + self._results = [] + + def get_status(self): + return self._status + + def get_started(self): + return self._started + + def get_finished(self): + return self._finished + + def get_duration_seconds(self): + diff = self._finished - self._started + return diff.total_seconds() + + def get_duration(self): + return str(datetime.timedelta(seconds=self.get_duration_seconds())) + + def add_test(self, test): + self._results.append(test) + + def to_json(self): + report_json = {} + report_json['device'] = self._device + report_json['status'] = self._status + report_json['started'] = self._started.strftime(DATE_TIME_FORMAT) + report_json['finished'] = self._finished.strftime(DATE_TIME_FORMAT) + report_json['tests'] = {'total': self._total_tests, + 'results': self._results} + return report_json + + def from_json(self, json_file): + + self._device['mac_addr'] = json_file['device']['mac_addr'] + self._device['manufacturer'] = json_file['device']['manufacturer'] + self._device['model'] = json_file['device']['model'] + + if 'firmware' in self._device: + self._device['firmware'] = json_file['device']['firmware'] + + self._status = json_file['status'] + self._started = datetime.strptime(json_file['started'], DATE_TIME_FORMAT) + self._finished = datetime.strptime(json_file['finished'], DATE_TIME_FORMAT) + self._total_tests = json_file['tests']['total'] + + # Loop through test results + for test_result in json_file['tests']['results']: + self.add_test(test_result) + + return self diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index 5875c8e44..c3809ffd6 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -28,6 +28,7 @@ from common import logger, util from common.device import Device from common.session import TestRunSession +from common.testreport import TestReport from api.api import Api from net_orc.listener import NetworkEvent from net_orc import network_orchestrator as net_orc @@ -89,7 +90,7 @@ def __init__(self, if net_only: self._session.add_runtime_param('net_only') - self._load_all_devices() + self.load_all_devices() self._net_orc = net_orc.NetworkOrchestrator( session=self._session, @@ -100,6 +101,7 @@ def __init__(self, self._net_orc) if self._no_ui: + # Check Test Run is able to start if self.get_net_orc().check_config() is False: return @@ -107,17 +109,25 @@ def __init__(self, # Any additional checks that need to be performed go here self.start() + else: + + # Build UI image self._api = Api(self) self._api.start() + # Start UI container - # Hold until API ends - while True: - time.sleep(1) + # Hold until API ends + while True: + time.sleep(1) - def _load_all_devices(self): + def load_all_devices(self): + self._session.clear_device_repository() self._load_devices(device_dir=LOCAL_DEVICES_DIR) - self._load_devices(device_dir=RESOURCE_DEVICES_DIR) + + # Temporarily removing loading of template device + # configs (feature not required yet) + # self._load_devices(device_dir=RESOURCE_DEVICES_DIR) return self.get_session().get_device_repository() def _load_devices(self, device_dir): @@ -130,10 +140,13 @@ def _load_devices(self, device_dir): device_config_file_path = os.path.join(device_dir, device_folder, DEVICE_CONFIG) + + # Check if device config file exists before loading if not os.path.exists(device_config_file_path): LOGGER.error(f'Device configuration file missing from device {device_folder}') continue + # Open device config file with open(device_config_file_path, encoding='utf-8') as device_config_file: device_config_json = json.load(device_config_file) @@ -153,10 +166,90 @@ def _load_devices(self, device_dir): test_modules=test_modules, max_device_reports=max_device_reports, device_folder=device_folder) - self.get_session().add_device(device) + # Load reports for this device + self._load_test_reports(device) + + # Add device to device repository self.get_session().add_device(device) - LOGGER.debug(f'Loaded device {device.manufacturer} {device.model} with MAC address {device.mac_addr}') + LOGGER.debug(f'Loaded device {device.manufacturer} ' + + f'{device.model} with MAC address {device.mac_addr}') + + def _load_test_reports(self, device: Device): + + LOGGER.debug(f'Loading test reports for device {device.model}') + + # Locate reports folder + reports_folder = os.path.join(root_dir, + LOCAL_DEVICES_DIR, + device.device_folder, 'reports') + + # Check if reports folder exists (device may have no reports) + if not os.path.exists(reports_folder): + return + + for report_folder in os.listdir(reports_folder): + report_json_file_path = os.path.join( + reports_folder, + report_folder, + 'report.json') + + # Check if the report.json file exists + if not os.path.isfile(report_json_file_path): + # Some error may have occured during this test run + continue + + with open(report_json_file_path, encoding='utf-8') as report_json_file: + report_json = json.load(report_json_file) + test_report = TestReport().from_json(report_json) + device.add_report(test_report) + + def create_device(self, device: Device): + + # Define the device folder location + device_folder_path = os.path.join(root_dir, + LOCAL_DEVICES_DIR, + device.device_folder) + + # Create the directory + os.makedirs(device_folder_path) + + config_file_path = os.path.join(device_folder_path, + DEVICE_CONFIG) + + with open(config_file_path, 'w', encoding='utf-8') as config_file: + config_file.writelines(json.dumps(device.to_config_json(), indent=4)) + + # Ensure new folder has correct permissions + util.run_command(f"chown -R {util.get_host_user()} '{device_folder_path}'") + + # Add new device to the device repository + self._session.add_device(device) + + return device.to_config_json() + + def save_device(self, device: Device, device_json): + """Edit and save an existing device config.""" + + # Update device properties + device.manufacturer = device_json['manufacturer'] + device.model = device_json['model'] + + if 'test_modules' in device_json: + device.test_modules = device_json['test_modules'] + else: + device.test_modules = {} + + # Obtain the config file path + config_file_path = os.path.join(root_dir, + LOCAL_DEVICES_DIR, + device.device_folder, + DEVICE_CONFIG) + + with open(config_file_path, 'w+', encoding='utf-8') as config_file: + config_file.writelines(json.dumps(device.to_config_json(), indent=4)) + + return device.to_config_json() def start(self): @@ -209,7 +302,6 @@ def start(self): self.stop() def stop(self, kill=False): - self._set_status('Stopping') # Prevent discovering new devices whilst stopping if self.get_net_orc().get_listener() is not None: @@ -218,8 +310,6 @@ def stop(self, kill=False): self._stop_tests() self._stop_network(kill=kill) - self.get_session().reset() - def _register_exits(self): signal.signal(signal.SIGINT, self._exit_handler) signal.signal(signal.SIGTERM, self._exit_handler) @@ -282,7 +372,7 @@ def _device_discovered(self, mac_addr): self.get_session().set_target_device(device) LOGGER.info( - f'Discovered {device.manufacturer} {device.model} on the network') + f'Discovered {device.manufacturer} {device.model} on the network. Waiting for device to obtain IP') def _device_stable(self, mac_addr): LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') diff --git a/framework/python/src/test_orc/module.py b/framework/python/src/test_orc/module.py index 185940dd8..27dcfa8da 100644 --- a/framework/python/src/test_orc/module.py +++ b/framework/python/src/test_orc/module.py @@ -31,12 +31,12 @@ class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-at image_name: str = None enable_container: bool = True network: bool = True - + total_tests: int = 0 timeout: int = 60 # Absolute path dir: str = None dir_name: str = None - #Set IP Index for all test modules + # Set IP Index for all test modules ip_index: str = 9 diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index b9353c995..db32840b1 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -21,6 +21,7 @@ from datetime import datetime from docker.types import Mount from common import logger, util +from common.testreport import TestReport from test_orc.module import TestModule LOG_NAME = "test_orc" @@ -81,19 +82,20 @@ def run_test_modules(self): LOGGER.info("All tests complete") self._session.stop() - self._generate_report() + report = TestReport().from_json(self._generate_report()) + device.add_report(report) + self._test_in_progress = False self._timestamp_results(device) + LOGGER.debug("Cleaning old test results...") self._cleanup_old_test_results(device) + LOGGER.debug("Old test results cleaned") self._test_in_progress = False def _generate_report(self): - # TODO: Calculate the status result - # We need to know the required result of each test - report = {} report["device"] = self._session.get_target_device().to_json() report["started"] = self._session.get_started().strftime( @@ -101,7 +103,7 @@ def _generate_report(self): report["finished"] = self._session.get_finished().strftime( "%Y-%m-%d %H:%M:%S") report["status"] = self._session.get_status() - report["results"] = self._session.get_test_results() + report["tests"] = self._session.get_report_tests() out_file = os.path.join( self._root_path, RUNTIME_DIR, self._session.get_target_device().mac_addr.replace(":", ""), @@ -290,6 +292,8 @@ def _run_test_module(self, module): f"Error occured whilst obbtaining results for module {module.name}") LOGGER.debug(results_error) + self._session.add_total_tests(module.total_tests) + LOGGER.info("Test module " + module.name + " has finished") def _get_module_status(self, module): @@ -355,6 +359,9 @@ def _load_test_module(self, module_dir): module.container_name = "tr-ct-" + module.dir_name + "-test" module.image_name = "test-run/" + module.dir_name + "-test" + if "tests" in module_json["config"]: + module.total_tests = len(module_json["config"]["tests"]) + if "timeout" in module_json["config"]["docker"]: module.timeout = module_json["config"]["docker"]["timeout"] diff --git a/testing/tests/test_tests b/testing/tests/test_tests index be7a3cef3..49c77d4e4 100755 --- a/testing/tests/test_tests +++ b/testing/tests/test_tests @@ -65,7 +65,7 @@ for tester in $TESTERS; do args=$(jq -r .$tester.args $MATRIX) touch $testrun_log - sudo timeout 900 bin/testrun --single-intf --no-ui > $testrun_log 2>&1 & + sudo timeout 900 bin/testrun --single-intf --no-ui --no-validate > $testrun_log 2>&1 & TPID=$! # Time to wait for testrun to be ready From 290ba5013be5aae1a0a9db9c9d6744d77e682eb5 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 16 Aug 2023 22:18:30 +0100 Subject: [PATCH 069/400] Re-enable actions, fix conn module (#89) * Re-enable actions, fix conn module * Fix net_orc init * Update report file name in testing --- framework/python/src/core/testrun.py | 7 +++--- .../src/net_orc/network_orchestrator.py | 24 +++++++------------ modules/test/conn/python/requirements.txt | 2 +- testing/tests/test_tests | 2 +- 4 files changed, 15 insertions(+), 20 deletions(-) diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index c3809ffd6..9034f5796 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -85,17 +85,18 @@ def __init__(self, # Create session self._session = TestRunSession(config_file=self._config_file) + # Register runtime parameters if single_intf: self._session.add_runtime_param('single_intf') if net_only: self._session.add_runtime_param('net_only') + if not validate: + self._session.add_runtime_param('no-validate') self.load_all_devices() self._net_orc = net_orc.NetworkOrchestrator( - session=self._session, - validate=validate, - single_intf = self._single_intf) + session=self._session) self._test_orc = test_orc.TestOrchestrator( self._session, self._net_orc) diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index 19cf0081a..4abdb9651 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -47,13 +47,11 @@ class NetworkOrchestrator: """Manage and controls a virtual testing network.""" - def __init__(self, session, validate=True, single_intf=False): + def __init__(self, + session): self._session = session self._monitor_in_progress = False - self._validate = validate - self._single_intf = single_intf - self._listener = None self._net_modules = [] @@ -73,8 +71,6 @@ def start(self): LOGGER.debug('Starting network orchestrator') - self._host_user = util.get_host_user() - # Get all components ready self.load_network_modules() @@ -123,7 +119,7 @@ def start_network(self): self.create_net() self.start_network_services() - if self._validate: + if 'no-validate' not in self._session.get_runtime_params(): # Start the validator after network is ready self.validator.start() @@ -179,7 +175,7 @@ def _device_discovered(self, mac_addr): shutil.rmtree(device_runtime_dir, ignore_errors=True) os.makedirs(device_runtime_dir, exist_ok=True) - util.run_command(f'chown -R {self._host_user} {device_runtime_dir}') + util.run_command(f'chown -R {util.get_host_user()} {device_runtime_dir}') packet_capture = sniff(iface=self._session.get_device_interface(), timeout=self._session.get_startup_timeout(), @@ -324,9 +320,8 @@ def _ci_post_network_create(self): def create_net(self): LOGGER.info('Creating baseline network') - # TODO: This is not just for CI - #if self._single_intf: - #self._ci_pre_network_create() + if os.getenv('GITHUB_ACTIONS'): + self._ci_pre_network_create() # Setup the virtual network if not self._ovs.create_baseline_net(verify=True): @@ -334,9 +329,8 @@ def create_net(self): self.stop() sys.exit(1) - # TODO: This is not just for CI - #if self._single_intf: - #self._ci_post_network_create() + if os.getenv("GITHUB_ACTIONS"): + self._ci_post_network_create() self._create_private_net() @@ -469,7 +463,7 @@ def _start_network_service(self, net_module): privileged=True, detach=True, mounts=net_module.mounts, - environment={'HOST_USER': self._host_user}) + environment={'HOST_USER': util.get_host_user()}) except docker.errors.ContainerError as error: LOGGER.error('Container run error') LOGGER.error(error) diff --git a/modules/test/conn/python/requirements.txt b/modules/test/conn/python/requirements.txt index c523787b9..c2275b3e0 100644 --- a/modules/test/conn/python/requirements.txt +++ b/modules/test/conn/python/requirements.txt @@ -1,2 +1,2 @@ -pyOpenSSL +pyOpenSSL scapy \ No newline at end of file diff --git a/testing/tests/test_tests b/testing/tests/test_tests index 49c77d4e4..04f76daee 100755 --- a/testing/tests/test_tests +++ b/testing/tests/test_tests @@ -112,7 +112,7 @@ for tester in $TESTERS; do sudo docker kill $tester sudo docker logs $tester | cat - cp runtime/test/${ethmac//:/}/results.json $TEST_DIR/$tester.json + cp runtime/test/${ethmac//:/}/report.json $TEST_DIR/$tester.json more $TEST_DIR/$tester.json more $testrun_log From 38792e8b9c20238ff34a88be6ddf7af5bf09bcb8 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Wed, 16 Aug 2023 22:44:39 +0100 Subject: [PATCH 070/400] Add required result to module configs (#95) --- framework/python/src/common/device.py | 4 +- framework/python/src/test_orc/module.py | 8 +-- framework/python/src/test_orc/test_case.py | 26 ++++++++++ .../python/src/test_orc/test_orchestrator.py | 52 +++++++++++++++++-- modules/test/baseline/conf/module_config.json | 6 +-- modules/test/conn/conf/module_config.json | 27 +++++----- modules/test/dns/conf/module_config.json | 9 ++-- modules/test/nmap/conf/module_config.json | 52 +++++++++---------- modules/test/ntp/conf/module_config.json | 4 +- modules/test/tls/conf/module_config.json | 8 +-- 10 files changed, 136 insertions(+), 60 deletions(-) create mode 100644 framework/python/src/test_orc/test_case.py diff --git a/framework/python/src/common/device.py b/framework/python/src/common/device.py index 41a9022cd..5d41fbef1 100644 --- a/framework/python/src/common/device.py +++ b/framework/python/src/common/device.py @@ -40,9 +40,9 @@ def get_reports(self): # TODO: Add ability to remove reports once test reports have been cleaned up - def to_json(self): + def to_dict(self): """Returns the device as a python dictionary. This is used for the - # system status API endpoint and in the report.""" + system status API endpoint and in the report.""" device_json = {} device_json['mac_addr'] = self.mac_addr device_json['manufacturer'] = self.manufacturer diff --git a/framework/python/src/test_orc/module.py b/framework/python/src/test_orc/module.py index 27dcfa8da..6f3c544a1 100644 --- a/framework/python/src/test_orc/module.py +++ b/framework/python/src/test_orc/module.py @@ -12,19 +12,21 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Represemts a test module.""" -from dataclasses import dataclass +"""Represents a test module.""" +from dataclasses import dataclass, field from docker.models.containers import Container - @dataclass class TestModule: # pylint: disable=too-few-public-methods,too-many-instance-attributes """Represents a test module.""" + # General test module information name: str = None display_name: str = None description: str = None + tests: list = field(default_factory=lambda: []) + # Docker settings build_file: str = None container: Container = None container_name: str = None diff --git a/framework/python/src/test_orc/test_case.py b/framework/python/src/test_orc/test_case.py new file mode 100644 index 000000000..7c9eb6c20 --- /dev/null +++ b/framework/python/src/test_orc/test_case.py @@ -0,0 +1,26 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Represents an individual test case.""" +from dataclasses import dataclass + + +@dataclass +class TestCase: # pylint: disable=too-few-public-methods,too-many-instance-attributes + """Represents a test case.""" + + name: str = "test.undefined" + description: str = "" + expected_behavior: str = "" + required_result: str = "Recommended" diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index db32840b1..eb5676e17 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -23,6 +23,7 @@ from common import logger, util from common.testreport import TestReport from test_orc.module import TestModule +from test_orc.test_case import TestCase LOG_NAME = "test_orc" LOGGER = logger.get_logger("test_orc") @@ -97,12 +98,12 @@ def run_test_modules(self): def _generate_report(self): report = {} - report["device"] = self._session.get_target_device().to_json() + report["device"] = self._session.get_target_device().to_dict() report["started"] = self._session.get_started().strftime( "%Y-%m-%d %H:%M:%S") report["finished"] = self._session.get_finished().strftime( "%Y-%m-%d %H:%M:%S") - report["status"] = self._session.get_status() + report["status"] = self._calculate_result() report["tests"] = self._session.get_report_tests() out_file = os.path.join( self._root_path, RUNTIME_DIR, @@ -114,6 +115,15 @@ def _generate_report(self): util.run_command(f"chown -R {self._host_user} {out_file}") return report + def _calculate_result(self): + result = "Compliant" + for test_result in self._session.get_test_results(): + test_case = self.get_test_case(test_result["name"]) + if (test_case.required_result.lower() == "required" + and test_result["result"].lower() == "non-compliant"): + result = "non-compliant" + return result + def _cleanup_old_test_results(self, device): if device.max_device_reports is not None: @@ -340,7 +350,7 @@ def _load_test_modules(self): def _load_test_module(self, module_dir): """Import module configuration from module_config.json.""" - LOGGER.debug("Loading test module " + module_dir) + LOGGER.debug(f"Loading test module {module_dir}") modules_dir = os.path.join(self._path, TEST_MODULES_DIR) @@ -359,8 +369,21 @@ def _load_test_module(self, module_dir): module.container_name = "tr-ct-" + module.dir_name + "-test" module.image_name = "test-run/" + module.dir_name + "-test" + # Load test cases if "tests" in module_json["config"]: module.total_tests = len(module_json["config"]["tests"]) + for test_case_json in module_json["config"]["tests"]: + try: + test_case = TestCase( + name=test_case_json["name"], + description=test_case_json["description"], + expected_behavior=test_case_json["expected_behavior"], + required_result=test_case_json["required_result"] + ) + module.tests.append(test_case) + except Exception as error: + LOGGER.debug("Failed to load test case. See error for details") + LOGGER.error(error) if "timeout" in module_json["config"]["docker"]: module.timeout = module_json["config"]["docker"]["timeout"] @@ -374,6 +397,7 @@ def _load_test_module(self, module_dir): if "network" in module_json["config"]: module.network = module_json["config"]["network"] + # Ensure container is built after any dependencies if "depends_on" in module_json["config"]["docker"]: depends_on_module = module_json["config"]["docker"]["depends_on"] if self._get_test_module(depends_on_module) is None: @@ -424,3 +448,25 @@ def _stop_module(self, module, kill=False): LOGGER.debug("Container stopped:" + module.container_name) except docker.errors.NotFound: pass + + def get_test_modules(self): + return self._test_modules + + def get_test_module(self, name): + for test_module in self.get_test_modules(): + if test_module.name == name: + return test_module + return None + + def get_test_cases(self): + test_cases = [] + for test_module in self.get_test_modules(): + for test_case in test_module.tests: + test_cases.append(test_case) + return test_cases + + def get_test_case(self, name): + for test_case in self.get_test_cases(): + if test_case.name == name: + return test_case + return None diff --git a/modules/test/baseline/conf/module_config.json b/modules/test/baseline/conf/module_config.json index f4daf0e36..83b920ea6 100644 --- a/modules/test/baseline/conf/module_config.json +++ b/modules/test/baseline/conf/module_config.json @@ -16,19 +16,19 @@ "name": "baseline.pass", "description": "Simulate a compliant test", "expected_behavior": "A compliant test result is generated", - "short_description": "A compliant test result is generated" + "required_result": "Required" }, { "name": "baseline.fail", "description": "Simulate a non-compliant test", "expected_behavior": "A non-compliant test result is generated", - "short_description": "A non-compliant test result is generated" + "required_result": "Recommended" }, { "name": "baseline.skip", "description": "Simulate a skipped test", "expected_behavior": "A skipped test result is generated", - "short_description": "A skipped test result is generated" + "required_result": "Roadmap" } ] } diff --git a/modules/test/conn/conf/module_config.json b/modules/test/conn/conf/module_config.json index d721b1616..c358ba1c2 100644 --- a/modules/test/conn/conf/module_config.json +++ b/modules/test/conn/conf/module_config.json @@ -17,37 +17,37 @@ "name": "connection.dhcp.disconnect", "description": "The device under test has received an IP address from the DHCP server and responds to an ICMP echo (ping) request", "expected_behavior": "The device is not setup with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds succesfully to an ICMP echo (ping) request.", - "short_description": "Device has received an IP address after port disconnect" + "required_result": "Required" }, { "name": "connection.dhcp.disconnect_ip_change", "description": "Update device IP on the DHCP server and reconnect the device. Does the device receive the new IP address?", "expected_behavior": "Device recieves a new IP address within the range that is specified on the DHCP server. Device should respond to aping on this new address.", - "short_description": "Device has received new IP address after port disconnect" + "required_result": "Required" }, { "name": "connection.dhcp_address", "description": "The device under test has received an IP address from the DHCP server and responds to an ICMP echo (ping) request", "expected_behavior": "The device is not setup with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds succesfully to an ICMP echo (ping) request.", - "short_description": "Device has received a DHCP provided IP address" + "required_result": "Required" }, { "name": "connection.mac_address", "description": "Check and note device physical address.", "expected_behavior": "N/A", - "short_description": "Device MAC address resolved" + "required_result": "Required" }, { "name": "connection.mac_oui", "description": "The device under test hs a MAC address prefix that is registered against a known manufacturer.", "expected_behavior": "The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database.", - "short_description": "OUI for MAC address resolved" + "required_result": "Required" }, { "name": "connection.private_address", "description": "The device under test accepts an IP address that is compliant with RFC 1918 Address Allocation for Private Internets.", "expected_behavior": "The device under test accepts IP addresses within all ranges specified in RFC 1918 and communicates using these addresses. The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of the IP address space for private internets. 10.0.0.0 - 10.255.255.255.255 (10/8 prefix). 172.16.0.0 - 172.31.255.255 (172.16/12 prefix). 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)", - "short_description": "Device supports private addresses", + "required_result": "Required", "config": { "ranges": [ { @@ -69,7 +69,7 @@ "name": "connection.shared_address", "description": "Ensure the device supports RFC 6598 IANA-Reserved IPv4 Prefix for Shared Address Space", "expected_behavior": "The device under test accepts IP addresses within the ranges specified in RFC 6598 and communicates using these addresses", - "short_description": "Device supports shared address space", + "required_result": "Required", "config": { "ranges": [ { @@ -83,6 +83,7 @@ "name": "connection.private_address", "description": "The device under test accepts an IP address that is compliant with RFC 1918 Address Allocation for Private Internets.", "expected_behavior": "The device under test accepts IP addresses within all ranges specified in RFC 1918 and communicates using these addresses. The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of the IP address space for private internets. 10.0.0.0 - 10.255.255.255.255 (10/8 prefix). 172.16.0.0 - 172.31.255.255 (172.16/12 prefix). 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)", + "required_result": "Required", "config": [ { "start": "10.0.0.100", @@ -102,37 +103,37 @@ "name": "connection.single_ip", "description": "The network switch port connected to the device reports only one IP address for the device under test.", "expected_behavior": "The device under test does not behave as a network switch and only requets one IP address. This test is to avoid that devices implement network switches that allow connecting strings of daisy chained devices to one single network port, as this would not make 802.1x port based authentication possible.", - "short_description": "Device only reports one IP address" + "required_result": "Required" }, { "name": "connection.target_ping", "description": "The device under test responds to an ICMP echo (ping) request.", "expected_behavior": "The device under test responds to an ICMP echo (ping) request.", - "short_description": "Device responds to a ping request" + "required_result": "Required" }, { "name": "connection.ipaddr.ip_change", "description": "The device responds to a ping (ICMP echo request) to the new IP address it has received after the initial DHCP lease has expired.", "expected_behavior": "If the lease expires before the client receiveds a DHCPACK, the client moves to INIT state, MUST immediately stop any other network processing and requires network initialization parameters as if the client were uninitialized. If the client then receives a DHCPACK allocating the client its previous network addres, the client SHOULD continue network processing. If the client is given a new network address, it MUST NOT continue using the previous network address and SHOULD notify the local users of the problem.", - "short_description": "Device receives an IP change from the DHCP server" + "required_result": "Required" }, { "name": "connection.ipaddr.dhcp_failover", "description": "The device has requested a DHCPREQUEST/REBIND to the DHCP failover server after the primary DHCP server has been brought down.", "expected_behavior": "", - "short_description": "Device receives IP address from primary and failover DHCP servers" + "required_result": "Required" }, { "name": "connection.ipv6_slaac", "description": "The device forms a valid IPv6 address as a combination of the IPv6 router prefix and the device interface identifier", "expected_behavior": "The device under test complies with RFC4862 and forms a valid IPv6 SLAAC address", - "short_description": "Device uses an IPv6 address using SLAAC" + "required_result": "Required" }, { "name": "connection.ipv6_ping", "description": "The device responds to an IPv6 ping (ICMPv6 Echo) request to the SLAAC address", "expected_behavior": "The device responds to the ping as per RFC4443", - "short_description": "Device responds to an IPv6 SLAAC address ping request" + "required_result": "Required" } ] } diff --git a/modules/test/dns/conf/module_config.json b/modules/test/dns/conf/module_config.json index b5e3c8420..e00061047 100644 --- a/modules/test/dns/conf/module_config.json +++ b/modules/test/dns/conf/module_config.json @@ -13,21 +13,22 @@ }, "tests":[ { - "name": "dns.network.from_device", + "name": "dns.network.hostname_resolution", "description": "Verify the device sends DNS requests", "expected_behavior": "The device sends DNS requests.", - "short_description": "The device sends DNS requests." + "required_result": "Required" }, { "name": "dns.network.from_dhcp", "description": "Verify the device allows for a DNS server to be entered automatically", "expected_behavior": "The device sends DNS requests to the DNS server provided by the DHCP server", - "short_description": "The device sends DNS requests to local DNS server." + "required_result": "Roadmap" }, { "name": "dns.mdns", "description": "If the device has MDNS (or any kind of IP multicast), can it be disabled", - "short_description": "MDNS traffic detected from device" + "expected_behavior": "Device may send MDNS requests", + "required_result": "Recommended" } ] } diff --git a/modules/test/nmap/conf/module_config.json b/modules/test/nmap/conf/module_config.json index b03e9511c..8a90febc1 100644 --- a/modules/test/nmap/conf/module_config.json +++ b/modules/test/nmap/conf/module_config.json @@ -16,7 +16,6 @@ "name": "security.nmap.ports", "description": "Run an nmap scan of open ports", "expected_behavior": "Report all open ports", - "short_description": "NMAP scan reports no unallowed ports open", "config": { "security.services.ftp": { "tcp_ports": { @@ -30,9 +29,10 @@ } }, "description": "Check FTP port 20/21 is disabled and FTP is not running on any port", - "expected_behavior": "There is no FTP service running on any port" + "expected_behavior": "There is no FTP service running on any port", + "required_result": "Required" }, - "security.services.ssh": { + "security.ssh.version": { "tcp_ports": { "22": { "allowed": true, @@ -40,8 +40,9 @@ "version": "2.0" } }, - "description": "Check TELNET port 23 is disabled and TELNET is not running on any port", - "expected_behavior": "There is no FTP service running on any port" + "description": "If the device is running a SSH server ensure it is SSHv2", + "expected_behavior": "SSH server is not running or server is SSHv2", + "required_result": "Required" }, "security.services.telnet": { "tcp_ports": { @@ -51,7 +52,8 @@ } }, "description": "Check TELNET port 23 is disabled and TELNET is not running on any port", - "expected_behavior": "There is no FTP service running on any port" + "expected_behavior": "There is no FTP service running on any port", + "required_result": "Required" }, "security.services.smtp": { "tcp_ports": { @@ -68,8 +70,9 @@ "description": "Simple Mail Transfer Protocol via TLS (SMTPS) Server" } }, - "description": "Check SMTP port 25 is disabled and ports 465 or 587 with SSL encryption are (not?) enabled and SMTP is not running on any port.", - "expected_behavior": "There is no smtp service running on any port" + "description": "Check SMTP ports 25, 465 and 587 are not enabled and SMTP is not running on any port.", + "expected_behavior": "There is no smtp service running on any port", + "required_result": "Required" }, "security.services.http": { "tcp_ports": { @@ -82,7 +85,8 @@ } }, "description": "Check that there is no HTTP server running on any port", - "expected_behavior": "Device is unreachable on port 80 (or any other port) and only responds to HTTPS requests on port 443 (or any other port if HTTP is used at all)" + "expected_behavior": "Device is unreachable on port 80 (or any other port) and only responds to HTTPS requests on port 443 (or any other port if HTTP is used at all)", + "required_result": "Required" }, "security.services.pop": { "tcp_ports": { @@ -92,7 +96,8 @@ } }, "description": "Check POP port 110 is disalbed and POP is not running on any port", - "expected_behavior": "There is no pop service running on any port" + "expected_behavior": "There is no pop service running on any port", + "required_result": "Required" }, "security.services.imap": { "tcp_ports": { @@ -102,7 +107,8 @@ } }, "description": "Check IMAP port 143 is disabled and IMAP is not running on any port", - "expected_behavior": "There is no imap service running on any port" + "expected_behavior": "There is no imap service running on any port", + "required_result": "Required" }, "security.services.snmpv3": { "tcp_ports": { @@ -126,17 +132,8 @@ } }, "description": "Check SNMP port 161/162 is disabled. If SNMP is an essential service, check it supports version 3", - "expected_behavior": "Device is unreachable on port 161 (or any other port) and device is unreachable on port 162 (or any other port) unless SNMP is essential in which case it is SNMPv3 is used." - }, - "security.services.https": { - "tcp_ports": { - "80": { - "allowed": false, - "description": "Administrative Secure Web-Server" - } - }, - "description": "Check that if there is a web server running it is running on a secure port.", - "expected_behavior": "Device only responds to HTTPS requests on port 443 (or any other port if HTTP is used at all)" + "expected_behavior": "Device is unreachable on port 161 (or any other port) and device is unreachable on port 162 (or any other port) unless SNMP is essential in which case it is SNMPv3 is used.", + "required_result": "Required" }, "security.services.vnc": { "tcp_ports": { @@ -150,7 +147,8 @@ } }, "description": "Check VNC is disabled on any port", - "expected_behavior": "Device cannot be accessed /connected to via VNc on any port" + "expected_behavior": "Device cannot be accessed /connected to via VNC on any port", + "required_result": "Required" }, "security.services.tftp": { "udp_ports": { @@ -160,9 +158,10 @@ } }, "description": "Check TFTP port 69 is disabled (UDP)", - "expected_behavior": "There is no tftp service running on any port" + "expected_behavior": "There is no tftp service running on any port", + "required_result": "Required" }, - "security.services.ntp": { + "ntp.network.ntp_server": { "udp_ports": { "123": { "allowed": false, @@ -172,7 +171,8 @@ "description": "Check NTP port 123 is disabled and the device is not operating as an NTP server", "expected_behavior": "The device dos not respond to NTP requests when it's IP is set as the NTP server on another device" } - } + }, + "required_result": "Required" } ] } diff --git a/modules/test/ntp/conf/module_config.json b/modules/test/ntp/conf/module_config.json index c20d2067b..a1a297f06 100644 --- a/modules/test/ntp/conf/module_config.json +++ b/modules/test/ntp/conf/module_config.json @@ -16,13 +16,13 @@ "name": "ntp.network.ntp_support", "description": "Does the device request network time sync as client as per RFC 5905 - Network Time Protocol Version 4: Protocol and Algorithms Specification", "expected_behavior": "The device sends an NTPv4 request to the configured NTP server.", - "short_description": "The device sends NTPv4 requests" + "required_result": "Required" }, { "name": "ntp.network.ntp_dhcp", "description": "Accept NTP address over DHCP", "expected_behavior": "Device can accept NTP server address, provided by the DHCP server (DHCP OFFER PACKET)", - "short_descriiption": "Accepts NTP address over DHCP" + "required_result": "Roadmap" } ] } diff --git a/modules/test/tls/conf/module_config.json b/modules/test/tls/conf/module_config.json index f71f39914..7f0305d19 100644 --- a/modules/test/tls/conf/module_config.json +++ b/modules/test/tls/conf/module_config.json @@ -16,25 +16,25 @@ "name": "security.tls.v1_2_server", "description": "Check the device web server TLS 1.2 & certificate is valid", "expected_behavior": "TLS 1.2 certificate is issued to the web browser client when accessed", - "short_description": "TLS 1.2 server certificate is valid" + "required_result": "Required" }, { "name": "security.tls.v1_3_server", "description": "Check the device web server TLS 1.3 & certificate is valid", "expected_behavior": "TLS 1.3 certificate is issued to the web browser client when accessed", - "short_description": "TLS 1.3 server certificate is valid" + "required_result": "Recommended" }, { "name": "security.tls.v1_2_client", "description": "Device uses TLS with connection to an external service on port 443 (or any other port which could be running the webserver-HTTPS)", "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.2 and support for ECDH and ECDSA ciphers", - "short_description": "TLS 1.2 outbound connection valid" + "required_result": "Required" }, { "name": "security.tls.v1_3_client", "description": "Device uses TLS with connection to an external service on port 443 (or any other port which could be running the webserver-HTTPS)", "expected_behavior": "The packet indicates a TLS connection with at least TLS 1.3", - "short_description": "TLS 1.3 outbound connection valid" + "required_result": "Recommended" } ] } From 6afd9ea3988a2b7d52d41695083e6987da2b324f Mon Sep 17 00:00:00 2001 From: J Boddey Date: Thu, 31 Aug 2023 15:31:52 +0100 Subject: [PATCH 071/400] Fix DNS test name (#110) --- modules/test/dns/python/src/dns_module.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/test/dns/python/src/dns_module.py b/modules/test/dns/python/src/dns_module.py index bc56c3718..37393ca42 100644 --- a/modules/test/dns/python/src/dns_module.py +++ b/modules/test/dns/python/src/dns_module.py @@ -78,8 +78,8 @@ def _dns_network_from_dhcp(self): result = None, 'No DNS traffic detected from the device' return result - def _dns_network_from_device(self): - LOGGER.info('Running dns.network.from_device') + def _dns_network_hostname_resolution(self): + LOGGER.info('Running dns.network.hostname_resolution') result = None LOGGER.info('Checking DNS traffic from device: ' + self._device_mac) From 2cbc3439697ac3356bc301b81d649888bbac1665 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Thu, 31 Aug 2023 15:32:13 +0100 Subject: [PATCH 072/400] Clear runtime folder on start (#111) --- bin/testrun | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bin/testrun b/bin/testrun index 9281c1ac6..5fb8bf232 100755 --- a/bin/testrun +++ b/bin/testrun @@ -32,6 +32,9 @@ mkdir -p local/devices # Check if Python modules exist. Install if not [ ! -d "venv" ] && sudo cmd/install +# Remove existing runtime data +rm -rf runtime/* + # Activate Python virtual environment source venv/bin/activate From f98ea1890bc83402dad4075a7dc45069bc3bbf74 Mon Sep 17 00:00:00 2001 From: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Date: Fri, 1 Sep 2023 02:26:29 -0700 Subject: [PATCH 073/400] Initial work on pdf report output and format via html (#103) --- cmd/install | 6 +- framework/python/src/common/testreport.py | 90 +++++++++++++++++++ .../python/src/test_orc/test_orchestrator.py | 29 ++++-- framework/requirements.txt | 3 + 4 files changed, 119 insertions(+), 9 deletions(-) diff --git a/cmd/install b/cmd/install index 4e8639a66..6477b85fb 100755 --- a/cmd/install +++ b/cmd/install @@ -20,4 +20,8 @@ source venv/bin/activate pip3 install -r framework/requirements.txt -deactivate +# Dependency for printing reports to pdf +# required by python package weasyprint +sudo apt-get install libpangocairo-1.0-0 + +deactivate \ No newline at end of file diff --git a/framework/python/src/common/testreport.py b/framework/python/src/common/testreport.py index ba35ff27a..d57db58cf 100644 --- a/framework/python/src/common/testreport.py +++ b/framework/python/src/common/testreport.py @@ -15,6 +15,8 @@ """Store previous test run information.""" from datetime import datetime +from weasyprint import HTML +from io import BytesIO DATE_TIME_FORMAT = '%Y-%m-%d %H:%M:%S' @@ -82,3 +84,91 @@ def from_json(self, json_file): self.add_test(test_result) return self + + # Create a pdf file in memory and return the bytes + def to_pdf(self): + # Resolve the data as html first + report_html = self.to_html() + + # Convert HTML to PDF in memory using weasyprint + pdf_bytes = BytesIO() + HTML(string=report_html).write_pdf(pdf_bytes) + return pdf_bytes + + def to_html(self): + json_data = self.to_json() + return f''' + + + {self.generate_header()} + +

Test Results Summary

+ +
+

Device Information

+

MAC Address: {json_data["device"]["mac_addr"]}

+

Manufacturer: {json_data["device"]["manufacturer"] or "Unknown"}

+

Model: {json_data["device"]["model"]}

+
+ +

Test Results

+ {self.generate_test_sections(json_data)} + + + ''' + + def generate_test_sections(self,json_data): + results = json_data["tests"]["results"] + sections = "" + for result in results: + sections += self.generate_test_section(result) + return sections + + def generate_test_section(self, result): + section_content = '
\n' + for key, value in result.items(): + if value is not None: # Check if the value is not None + formatted_key = key.replace('_', ' ').title() # Replace underscores and capitalize + section_content += f'

{formatted_key}: {value}

\n' + section_content += '
\n
\n' + return section_content + + def generate_header(self): + return f''' + + + + Test Results Summary + + + ''' + + def generate_css(self): + return ''' + body { + font-family: Arial, sans-serif; + margin: 20px; + } + h1 { + margin-bottom: 10px; + } + .summary { + border: 1px solid #ccc; + padding: 10px; + margin-bottom: 20px; + background-color: #f5f5f5; + } + .test-list { + list-style: none; + padding: 0; + } + .test-item { + margin-bottom: 10px; + } + .test-link { + text-decoration: none; + color: #007bff; + } + ''' \ No newline at end of file diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index eb5676e17..5835a4fed 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -86,6 +86,8 @@ def run_test_modules(self): report = TestReport().from_json(self._generate_report()) device.add_report(report) + self._write_reports(report) + self._test_in_progress = False self._timestamp_results(device) @@ -95,6 +97,25 @@ def run_test_modules(self): LOGGER.debug("Old test results cleaned") self._test_in_progress = False + def _write_reports(self, test_report): + out_dir = os.path.join( + self._root_path, RUNTIME_DIR, + self._session.get_target_device().mac_addr.replace(":", "")) + + # Write the json report + with open(os.path.join(out_dir,"report.json"),"w", encoding="utf-8") as f: + json.dump(test_report.to_json(), f, indent=2) + + # Write the html report + with open(os.path.join(out_dir,"report.html"),"w", encoding="utf-8") as f: + f.write(test_report.to_html()) + + # Write the pdf report + with open(os.path.join(out_dir,"report.pdf"),"wb") as f: + f.write(test_report.to_pdf().getvalue()) + + util.run_command(f"chown -R {self._host_user} {out_dir}") + def _generate_report(self): report = {} @@ -105,14 +126,6 @@ def _generate_report(self): "%Y-%m-%d %H:%M:%S") report["status"] = self._calculate_result() report["tests"] = self._session.get_report_tests() - out_file = os.path.join( - self._root_path, RUNTIME_DIR, - self._session.get_target_device().mac_addr.replace(":", ""), - "report.json") - - with open(out_file, "w", encoding="utf-8") as f: - json.dump(report, f, indent=2) - util.run_command(f"chown -R {self._host_user} {out_file}") return report def _calculate_result(self): diff --git a/framework/requirements.txt b/framework/requirements.txt index 560c2baf9..7141ae706 100644 --- a/framework/requirements.txt +++ b/framework/requirements.txt @@ -7,6 +7,9 @@ ipaddress netifaces scapy +# Requirments for the test_orc module +weasyprint + # Requirements for the API fastapi==0.99.1 psutil From 8d7c6f778f36b8f709dd83611497c7073e30b01c Mon Sep 17 00:00:00 2001 From: J Boddey Date: Fri, 1 Sep 2023 18:51:49 +0100 Subject: [PATCH 074/400] Add user interface (#98) * Add UI, small changes * Update UI * Update expected tests --- framework/python/src/api/api.py | 2 +- framework/python/src/common/logger.py | 9 +- framework/python/src/common/session.py | 8 +- framework/python/src/common/util.py | 3 + framework/python/src/core/testrun.py | 71 +- .../src/net_orc/network_orchestrator.py | 3 +- .../python/src/test_orc/test_orchestrator.py | 6 +- modules/test/base/python/src/test_module.py | 20 +- .../test/conn/python/src/connection_module.py | 39 +- modules/ui/.editorconfig | 16 + modules/ui/.gitignore | 42 + modules/ui/README.md | 27 + modules/ui/angular.json | 107 + modules/ui/{conf => }/nginx.conf | 2 +- modules/ui/package-lock.json | 12407 ++++++++++++++++ modules/ui/package.json | 42 + modules/ui/src/app/app-routing.module.ts | 32 + modules/ui/src/app/app.component.html | 70 + modules/ui/src/app/app.component.scss | 100 + modules/ui/src/app/app.component.spec.ts | 122 + modules/ui/src/app/app.component.ts | 57 + modules/ui/src/app/app.module.ts | 38 + .../device-item/device-item.component.html | 8 + .../device-item/device-item.component.scss | 80 + .../device-item/device-item.component.spec.ts | 53 + .../device-item/device-item.component.ts | 17 + .../device-tests/device-tests.component.html | 9 + .../device-tests/device-tests.component.scss | 8 + .../device-tests.component.spec.ts | 79 + .../device-tests/device-tests.component.ts | 43 + .../download-report.component.html | 11 + .../download-report.component.scss | 3 + .../download-report.component.spec.ts | 98 + .../download-report.component.ts | 32 + .../general-settings.component.html | 60 + .../general-settings.component.scss | 105 + .../general-settings.component.spec.ts | 126 + .../general-settings.component.ts | 150 + .../only-different-values.validator.ts | 29 + .../device-form/device-form.component.html | 45 + .../device-form/device-form.component.scss | 46 + .../device-form/device-form.component.spec.ts | 369 + .../device-form/device-form.component.ts | 151 + .../device-string-format.validator.ts | 23 + .../device-repository-routing.module.ts | 12 + .../device-repository.component.html | 25 + .../device-repository.component.scss | 32 + .../device-repository.component.spec.ts | 174 + .../device-repository.component.ts | 53 + .../device-repository.module.ts | 41 + .../guards/allow-to-run-test.guard.spec.ts | 46 + .../src/app/guards/allow-to-run-test.guard.ts | 18 + .../src/app/history/history-routing.module.ts | 12 + .../ui/src/app/history/history.component.html | 74 + .../ui/src/app/history/history.component.scss | 85 + .../src/app/history/history.component.spec.ts | 103 + .../ui/src/app/history/history.component.ts | 35 + modules/ui/src/app/history/history.module.ts | 25 + modules/ui/src/app/mocks/device.mock.ts | 12 + modules/ui/src/app/mocks/progress.mock.ts | 44 + modules/ui/src/app/model/device.ts | 24 + modules/ui/src/app/model/setting.ts | 6 + modules/ui/src/app/model/testrun-status.ts | 57 + .../progress-breadcrumbs.component.html | 15 + .../progress-breadcrumbs.component.scss | 40 + .../progress-breadcrumbs.component.spec.ts | 23 + .../progress-breadcrumbs.component.ts | 12 + .../progress-initiate-form.component.html | 64 + .../progress-initiate-form.component.scss | 50 + .../progress-initiate-form.component.spec.ts | 191 + .../progress-initiate-form.component.ts | 71 + .../app/progress/progress-routing.module.ts | 12 + .../progress-status-card.component.html | 30 + .../progress-status-card.component.scss | 57 + .../progress-status-card.component.spec.ts | 259 + .../progress-status-card.component.ts | 54 + .../progress-table.component.html | 27 + .../progress-table.component.scss | 43 + .../progress-table.component.spec.ts | 94 + .../progress-table.component.ts | 22 + .../src/app/progress/progress.component.html | 63 + .../src/app/progress/progress.component.scss | 72 + .../app/progress/progress.component.spec.ts | 306 + .../ui/src/app/progress/progress.component.ts | 85 + .../ui/src/app/progress/progress.module.ts | 47 + modules/ui/src/app/test-run.service.spec.ts | 316 + modules/ui/src/app/test-run.service.ts | 170 + modules/ui/src/assets/.gitkeep | 0 modules/ui/src/assets/icons/close.svg | 3 + modules/ui/src/assets/icons/devices.svg | 5 + modules/ui/src/assets/icons/devices_add.svg | 9 + modules/ui/src/assets/icons/menu.svg | 10 + modules/ui/src/assets/icons/reports.svg | 5 + .../src/assets/icons/testrun_logo_color.svg | 40 + .../src/assets/icons/testrun_logo_small.svg | 40 + modules/ui/src/favicon.ico | Bin 0 -> 948 bytes modules/ui/src/index.html | 19 + modules/ui/src/main.ts | 7 + modules/ui/src/styles.scss | 63 + modules/ui/src/theming/colors.scss | 141 + modules/ui/src/theming/theme.scss | 49 + modules/ui/src/theming/variables.scss | 3 + modules/ui/tsconfig.app.json | 14 + modules/ui/tsconfig.json | 33 + modules/ui/tsconfig.spec.json | 14 + modules/ui/ui.Dockerfile | 7 +- testing/tests/test_tests.json | 8 +- testing/tests/test_tests.py | 4 +- ui/index.html | 1 - 109 files changed, 18188 insertions(+), 56 deletions(-) create mode 100644 modules/ui/.editorconfig create mode 100644 modules/ui/.gitignore create mode 100644 modules/ui/README.md create mode 100644 modules/ui/angular.json rename modules/ui/{conf => }/nginx.conf (99%) create mode 100644 modules/ui/package-lock.json create mode 100644 modules/ui/package.json create mode 100644 modules/ui/src/app/app-routing.module.ts create mode 100644 modules/ui/src/app/app.component.html create mode 100644 modules/ui/src/app/app.component.scss create mode 100644 modules/ui/src/app/app.component.spec.ts create mode 100644 modules/ui/src/app/app.component.ts create mode 100644 modules/ui/src/app/app.module.ts create mode 100644 modules/ui/src/app/components/device-item/device-item.component.html create mode 100644 modules/ui/src/app/components/device-item/device-item.component.scss create mode 100644 modules/ui/src/app/components/device-item/device-item.component.spec.ts create mode 100644 modules/ui/src/app/components/device-item/device-item.component.ts create mode 100644 modules/ui/src/app/components/device-tests/device-tests.component.html create mode 100644 modules/ui/src/app/components/device-tests/device-tests.component.scss create mode 100644 modules/ui/src/app/components/device-tests/device-tests.component.spec.ts create mode 100644 modules/ui/src/app/components/device-tests/device-tests.component.ts create mode 100644 modules/ui/src/app/components/download-report/download-report.component.html create mode 100644 modules/ui/src/app/components/download-report/download-report.component.scss create mode 100644 modules/ui/src/app/components/download-report/download-report.component.spec.ts create mode 100644 modules/ui/src/app/components/download-report/download-report.component.ts create mode 100644 modules/ui/src/app/components/general-settings/general-settings.component.html create mode 100644 modules/ui/src/app/components/general-settings/general-settings.component.scss create mode 100644 modules/ui/src/app/components/general-settings/general-settings.component.spec.ts create mode 100644 modules/ui/src/app/components/general-settings/general-settings.component.ts create mode 100644 modules/ui/src/app/components/general-settings/only-different-values.validator.ts create mode 100644 modules/ui/src/app/device-repository/device-form/device-form.component.html create mode 100644 modules/ui/src/app/device-repository/device-form/device-form.component.scss create mode 100644 modules/ui/src/app/device-repository/device-form/device-form.component.spec.ts create mode 100644 modules/ui/src/app/device-repository/device-form/device-form.component.ts create mode 100644 modules/ui/src/app/device-repository/device-form/device-string-format.validator.ts create mode 100644 modules/ui/src/app/device-repository/device-repository-routing.module.ts create mode 100644 modules/ui/src/app/device-repository/device-repository.component.html create mode 100644 modules/ui/src/app/device-repository/device-repository.component.scss create mode 100644 modules/ui/src/app/device-repository/device-repository.component.spec.ts create mode 100644 modules/ui/src/app/device-repository/device-repository.component.ts create mode 100644 modules/ui/src/app/device-repository/device-repository.module.ts create mode 100644 modules/ui/src/app/guards/allow-to-run-test.guard.spec.ts create mode 100644 modules/ui/src/app/guards/allow-to-run-test.guard.ts create mode 100644 modules/ui/src/app/history/history-routing.module.ts create mode 100644 modules/ui/src/app/history/history.component.html create mode 100644 modules/ui/src/app/history/history.component.scss create mode 100644 modules/ui/src/app/history/history.component.spec.ts create mode 100644 modules/ui/src/app/history/history.component.ts create mode 100644 modules/ui/src/app/history/history.module.ts create mode 100644 modules/ui/src/app/mocks/device.mock.ts create mode 100644 modules/ui/src/app/mocks/progress.mock.ts create mode 100644 modules/ui/src/app/model/device.ts create mode 100644 modules/ui/src/app/model/setting.ts create mode 100644 modules/ui/src/app/model/testrun-status.ts create mode 100644 modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.html create mode 100644 modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.scss create mode 100644 modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.spec.ts create mode 100644 modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.ts create mode 100644 modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.html create mode 100644 modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.scss create mode 100644 modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.spec.ts create mode 100644 modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.ts create mode 100644 modules/ui/src/app/progress/progress-routing.module.ts create mode 100644 modules/ui/src/app/progress/progress-status-card/progress-status-card.component.html create mode 100644 modules/ui/src/app/progress/progress-status-card/progress-status-card.component.scss create mode 100644 modules/ui/src/app/progress/progress-status-card/progress-status-card.component.spec.ts create mode 100644 modules/ui/src/app/progress/progress-status-card/progress-status-card.component.ts create mode 100644 modules/ui/src/app/progress/progress-table/progress-table.component.html create mode 100644 modules/ui/src/app/progress/progress-table/progress-table.component.scss create mode 100644 modules/ui/src/app/progress/progress-table/progress-table.component.spec.ts create mode 100644 modules/ui/src/app/progress/progress-table/progress-table.component.ts create mode 100644 modules/ui/src/app/progress/progress.component.html create mode 100644 modules/ui/src/app/progress/progress.component.scss create mode 100644 modules/ui/src/app/progress/progress.component.spec.ts create mode 100644 modules/ui/src/app/progress/progress.component.ts create mode 100644 modules/ui/src/app/progress/progress.module.ts create mode 100644 modules/ui/src/app/test-run.service.spec.ts create mode 100644 modules/ui/src/app/test-run.service.ts create mode 100644 modules/ui/src/assets/.gitkeep create mode 100644 modules/ui/src/assets/icons/close.svg create mode 100644 modules/ui/src/assets/icons/devices.svg create mode 100644 modules/ui/src/assets/icons/devices_add.svg create mode 100644 modules/ui/src/assets/icons/menu.svg create mode 100644 modules/ui/src/assets/icons/reports.svg create mode 100644 modules/ui/src/assets/icons/testrun_logo_color.svg create mode 100644 modules/ui/src/assets/icons/testrun_logo_small.svg create mode 100644 modules/ui/src/favicon.ico create mode 100644 modules/ui/src/index.html create mode 100644 modules/ui/src/main.ts create mode 100644 modules/ui/src/styles.scss create mode 100644 modules/ui/src/theming/colors.scss create mode 100644 modules/ui/src/theming/theme.scss create mode 100644 modules/ui/src/theming/variables.scss create mode 100644 modules/ui/tsconfig.app.json create mode 100644 modules/ui/tsconfig.json create mode 100644 modules/ui/tsconfig.spec.json delete mode 100644 ui/index.html diff --git a/framework/python/src/api/api.py b/framework/python/src/api/api.py index 6b89da795..044a72178 100644 --- a/framework/python/src/api/api.py +++ b/framework/python/src/api/api.py @@ -54,7 +54,7 @@ def __init__(self, test_run): self._router.add_api_route("/device", self.save_device, methods=["POST"]) # TODO: Make this configurable in system.json - origins = ["http://localhost:4200"] + origins = ["http://localhost:8080", "http://localhost:4200"] self._app = FastAPI() self._app.include_router(self._router) diff --git a/framework/python/src/common/logger.py b/framework/python/src/common/logger.py index 8dd900fea..9bc8ecc04 100644 --- a/framework/python/src/common/logger.py +++ b/framework/python/src/common/logger.py @@ -24,14 +24,19 @@ _CONF_DIR = 'local' _CONF_FILE_NAME = 'system.json' + + # Set log level +log_level = _DEFAULT_LEVEL + try: with open(os.path.join(_CONF_DIR, _CONF_FILE_NAME), encoding='UTF-8') as config_json_file: system_conf_json = json.load(config_json_file) - log_level_str = system_conf_json['log_level'] - log_level = logging.getLevelName(log_level_str) + if 'log_level' in system_conf_json: + log_level_str = system_conf_json['log_level'] + log_level = logging.getLevelName(log_level_str) except OSError: # TODO: Print out warning that log level is incorrect or missing log_level = _DEFAULT_LEVEL diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py index f8c8d04b5..d3d0ca9f4 100644 --- a/framework/python/src/common/session.py +++ b/framework/python/src/common/session.py @@ -17,6 +17,7 @@ import datetime import json import os +from common import util NETWORK_KEY = 'network' DEVICE_INTF_KEY = 'device_intf' @@ -45,7 +46,7 @@ def __init__(self, config_file): self._load_config() def start(self): - self._status = 'Waiting for device' + self._status = 'Waiting for Device' self._started = datetime.datetime.now() def get_started(self): @@ -83,7 +84,7 @@ def _load_config(self): config_file_json = json.load(f) # Network interfaces - if (NETWORK_KEY in config_file_json + if (NETWORK_KEY in config_file_json and DEVICE_INTF_KEY in config_file_json.get(NETWORK_KEY) and INTERNET_INTF_KEY in config_file_json.get(NETWORK_KEY)): self._config[NETWORK_KEY][DEVICE_INTF_KEY] = config_file_json.get(NETWORK_KEY, {}).get(DEVICE_INTF_KEY) @@ -110,6 +111,7 @@ def _load_config(self): def _save_config(self): with open(self._config_file, 'w', encoding='utf-8') as f: f.write(json.dumps(self._config, indent=2)) + util.set_file_owner(owner=util.get_host_user(), path=self._config_file) def get_runtime(self): return self._config.get(RUNTIME_KEY) @@ -193,7 +195,7 @@ def get_all_reports(self): for device_report in device_reports: reports.append(device_report.to_json()) - return reports + return sorted(reports, key=lambda report: report['started'], reverse=True) def add_total_tests(self, no_tests): self._total_tests += no_tests diff --git a/framework/python/src/common/util.py b/framework/python/src/common/util.py index 441b93224..3916ce141 100644 --- a/framework/python/src/common/util.py +++ b/framework/python/src/common/util.py @@ -93,3 +93,6 @@ def get_user(): else: LOGGER.error('An exception occurred:', e) return user + +def set_file_owner(path, owner): + run_command(f'chown -R {owner} {path}') diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index 9034f5796..8eadcf441 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -20,6 +20,7 @@ Run using the provided command scripts in the cmd folder. E.g sudo cmd/start """ +import docker import json import os import sys @@ -113,10 +114,12 @@ def __init__(self, else: + # Start UI container + self.start_ui() + # Build UI image self._api = Api(self) self._api.start() - # Start UI container # Hold until API ends while True: @@ -254,14 +257,14 @@ def save_device(self, device: Device, device_json): def start(self): - self._session.start() + self.get_session().start() self._start_network() if self._net_only: LOGGER.info('Network only option configured, no tests will be run') - self.get_net_orc().listener.register_callback( + self.get_net_orc().get_listener().register_callback( self._device_discovered, [NetworkEvent.DEVICE_DISCOVERED] ) @@ -286,10 +289,10 @@ def start(self): ) self.get_net_orc().start_listener() - self._set_status('Waiting for device') + self._set_status('Waiting for Device') LOGGER.info('Waiting for devices on the network...') - time.sleep(self._session.get_runtime()) + time.sleep(self.get_session().get_runtime()) if not (self._test_orc.test_in_progress() or self.get_net_orc().monitor_in_progress()): @@ -310,6 +313,7 @@ def stop(self, kill=False): self._stop_tests() self._stop_network(kill=kill) + self._stop_ui() def _register_exits(self): signal.signal(signal.SIGINT, self._exit_handler) @@ -352,7 +356,7 @@ def _stop_tests(self): def get_device(self, mac_addr): """Returns a loaded device object from the device mac address.""" - for device in self._session.get_device_repository(): + for device in self.get_session().get_device_repository(): if device.mac_addr == mac_addr: return device return None @@ -377,12 +381,59 @@ def _device_discovered(self, mac_addr): def _device_stable(self, mac_addr): LOGGER.info(f'Device with mac address {mac_addr} is ready for testing.') - self._set_status('In progress') - self._test_orc.run_test_modules() - self._set_status('Complete') + self._set_status('In Progress') + result = self._test_orc.run_test_modules() + self._set_status(result) def _set_status(self, status): - self._session.set_status(status) + self.get_session().set_status(status) def get_session(self): return self._session + + def start_ui(self): + + LOGGER.info('Starting UI') + + self._build_ui() + + client = docker.from_env() + + client.containers.run( + image='test-run/ui', + auto_remove=True, + name='tr-ui', + hostname='testrun.io', + detach=True, + ports={ + '80': 8080 + } + ) + + # TODO: Make port configurable + LOGGER.info('User interface is ready on http://localhost:8080') + + def _build_ui(self): + + # TODO: Improve this process + build_file = os.path.join(root_dir, + 'modules', + 'ui', + 'ui.Dockerfile') + client = docker.from_env() + + LOGGER.debug('Building user interface') + + client.images.build(dockerfile=build_file, + path=root_dir, + forcerm=True, + tag='test-run/ui') + + def _stop_ui(self): + client = docker.from_env() + try: + container = client.containers.get('tr-ui') + if container is not None: + container.kill() + except docker.errors.NotFound: + return diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index 4abdb9651..d1fd9cdb0 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -656,8 +656,7 @@ def restore_net(self): LOGGER.info('Clearing baseline network') - if hasattr(self, 'listener') and self.get_listener( - ) is not None and self.get_listener().is_running(): + if self.get_listener() is not None and self.get_listener().is_running(): self.get_listener().stop_listener() client = docker.from_env() diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index 5835a4fed..94b0e4446 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -97,6 +97,8 @@ def run_test_modules(self): LOGGER.debug("Old test results cleaned") self._test_in_progress = False + return report.get_status() + def _write_reports(self, test_report): out_dir = os.path.join( self._root_path, RUNTIME_DIR, @@ -134,7 +136,7 @@ def _calculate_result(self): test_case = self.get_test_case(test_result["name"]) if (test_case.required_result.lower() == "required" and test_result["result"].lower() == "non-compliant"): - result = "non-compliant" + result = "Non-Compliant" return result def _cleanup_old_test_results(self, device): @@ -289,7 +291,7 @@ def _run_test_module(self, module): log_stream = module.container.logs(stream=True, stdout=True, stderr=True) while (time.time() < test_module_timeout and status == "running" - and self._session.get_status() == "In progress"): + and self._session.get_status() == "In Progress"): try: line = next(log_stream).decode("utf-8").strip() if re.search(LOG_REGEX, line): diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index 519fb2433..fe654decd 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -83,7 +83,7 @@ def run_tests(self): result = None test['start'] = datetime.now().isoformat() if ('enabled' in test and test['enabled']) or 'enabled' not in test: - LOGGER.info('Attempting to run test: ' + test['name']) + LOGGER.debug('Attempting to run test: ' + test['name']) # Resolve the correct python method by test name and run test if hasattr(self, test_method_name): if 'config' in test: @@ -91,35 +91,35 @@ def run_tests(self): else: result = getattr(self, test_method_name)() else: - LOGGER.info(f'Test {test["name"]} not resolved. Skipping') + LOGGER.info(f'Test {test["name"]} not implemented. Skipping') result = None else: - LOGGER.info(f'Test {test["name"]} disabled. Skipping') + LOGGER.debug(f'Test {test["name"]} is disabled. Skipping') if result is not None: if isinstance(result, bool): - test['result'] = 'compliant' if result else 'non-compliant' + test['result'] = 'Compliant' if result else 'Non-Compliant' else: if result[0] is None: - test['result'] = 'skipped' + test['result'] = 'Skipped' if len(result)>1: test['result_details'] = result[1] else: - test['result'] = 'compliant' if result[0] else 'non-compliant' + test['result'] = 'Compliant' if result[0] else 'Non-Compliant' test['result_details'] = result[1] else: - test['result'] = 'skipped' + test['result'] = 'Skipped' # Generate the short result description based on result value - if test['result'] == 'compliant': + if test['result'] == 'Compliant': test['result_description'] = test[ 'short_description'] if 'short_description' in test else test[ 'name'] + ' passed - see result details for more info' - elif test['result'] == 'non-compliant': + elif test['result'] == 'Non-Compliant': test['result_description'] = test[ 'name'] + ' failed - see result details for more info' else: test['result_description'] = test[ - 'name'] + ' skipped - see result details for more info' + 'name'] + ' Skipped - see result details for more info' test['end'] = datetime.now().isoformat() duration = datetime.fromisoformat(test['end']) - datetime.fromisoformat( diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 248edc536..779dd7d4c 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -130,7 +130,7 @@ def _connection_single_ip(self): # Extract MAC addresses from DHCP packets mac_addresses = set() - LOGGER.info('Inspecting: ' + str(len(packets)) + ' packets') + LOGGER.debug('Inspecting: ' + str(len(packets)) + ' packets') for packet in packets: # Option[1] = message-type, option 3 = DHCPREQUEST if DHCP in packet and packet[DHCP].options[0][1] == 3: @@ -140,11 +140,11 @@ def _connection_single_ip(self): # Check if the device mac address is in the list of DHCPREQUESTs result = self._device_mac.upper() in mac_addresses - LOGGER.info('DHCPREQUEST detected from device: ' + str(result)) + LOGGER.debug('DHCPREQUEST detected from device: ' + str(result)) # Check the unique MAC addresses to see if they match the device for mac_address in mac_addresses: - LOGGER.info('DHCPREQUEST from MAC address: ' + mac_address) + LOGGER.debug('DHCPREQUEST from MAC address: ' + mac_address) result &= self._device_mac.upper() == mac_address return result @@ -167,7 +167,8 @@ def _connection_ipaddr_ip_change(self): if self._dhcp_util.setup_single_dhcp_server(): lease = self._dhcp_util.get_cur_lease(self._device_mac) if lease is not None: - LOGGER.info('Current device lease resolved: ' + str(lease)) + LOGGER.info('Current device lease resolved') + LOGGER.debug(str(lease)) # Figure out how to calculate a valid IP address ip_address = '10.10.10.30' if self._dhcp_util.add_reserved_lease(lease['hostname'], @@ -177,10 +178,10 @@ def _connection_ipaddr_ip_change(self): for _ in range(5): LOGGER.info('Pinging device at IP: ' + ip_address) if self._ping(ip_address): - LOGGER.info('Ping Success') + LOGGER.debug('Ping success') LOGGER.info('Reserved lease confirmed active in device') result = True, 'Device has accepted an IP address change' - LOGGER.info('Restoring DHCP failover configuration') + LOGGER.debug('Restoring DHCP failover configuration') break else: LOGGER.info('Device did not respond to ping') @@ -210,7 +211,8 @@ def _connection_ipaddr_dhcp_failover(self): if primary_status and secondary_status: lease = self._dhcp_util.get_cur_lease(self._device_mac) if lease is not None: - LOGGER.info('Current device lease resolved: ' + str(lease)) + LOGGER.info('Current device lease resolved') + LOGGER.debug(str(lease)) if self._dhcp_util.is_lease_active(lease): # Shutdown the primary server if self._dhcp_util.stop_dhcp_server(dhcp_server_primary=True): @@ -282,7 +284,7 @@ def _connection_ipv6_ping(self): if self._device_ipv6_addr is None: LOGGER.info('No IPv6 SLAAC address found. Cannot ping') - result = None, 'No IPv6 SLAAc address found. Cannot ping' + result = None, 'No IPv6 SLAAC address found. Cannot ping' else: if self._ping(self._device_ipv6_addr): LOGGER.info(f'Device responds to IPv6 ping on {self._device_ipv6_addr}') @@ -332,6 +334,8 @@ def setup_single_dhcp_server(self): else: return False, 'DHCP server stop command failed' + + # TODO: This code is unreachable. # Move primary DHCP server from failover into a single DHCP server config LOGGER.info('Configuring primary DHCP server') response = self.dhcp1_client.disable_failover() @@ -419,11 +423,12 @@ def _run_subnet_test(self, config): LOGGER.info('Checking for new lease') lease = self._get_cur_lease() if lease is not None: - LOGGER.info('New Lease found: ' + str(lease)) + LOGGER.info('New lease found') + LOGGER.debug(str(lease)) LOGGER.info('Validating subnet for new lease...') in_range = self.is_ip_in_range(lease['ip'], cur_range['start'], cur_range['end']) - LOGGER.info('Lease within subnet: ' + str(in_range)) + LOGGER.debug('Lease within subnet: ' + str(in_range)) break else: LOGGER.info('New lease not found. Waiting to check again') @@ -438,7 +443,7 @@ def _test_subnet(self, subnet, lease): if self._change_subnet(subnet): expiration = datetime.strptime(lease['expires'], '%Y-%m-%d %H:%M:%S') time_to_expire = expiration - datetime.now() - LOGGER.info('Time until lease expiration: ' + str(time_to_expire)) + LOGGER.debug('Time until lease expiration: ' + str(time_to_expire)) LOGGER.info('Waiting for current lease to expire: ' + str(expiration)) if time_to_expire.total_seconds() > 0: time.sleep(time_to_expire.total_seconds() + @@ -448,7 +453,7 @@ def _test_subnet(self, subnet, lease): LOGGER.info('Checking for new lease') lease = self._get_cur_lease() if lease is not None: - LOGGER.info('New Lease found: ' + str(lease)) + LOGGER.info('New lease found: ' + str(lease)) LOGGER.info('Validating subnet for new lease...') in_range = self.is_ip_in_range(lease['ip'], subnet['start'], subnet['end']) @@ -457,6 +462,8 @@ def _test_subnet(self, subnet, lease): else: LOGGER.info('New lease not found. Waiting to check again') time.sleep(5) + else: + LOGGER.error('Failed to change subnet') def _wait_for_lease_expire(self, lease): expiration = datetime.strptime(lease['expires'], '%Y-%m-%d %H:%M:%S') @@ -472,15 +479,15 @@ def _change_subnet(self, subnet): LOGGER.info('Changing subnet to: ' + str(subnet)) response = self.dhcp1_client.set_dhcp_range(subnet['start'], subnet['end']) if response.code == 200: - LOGGER.info('Subnet change request accepted. Confirming change...') + LOGGER.debug('Subnet change request accepted. Confirming change...') response = self.dhcp1_client.get_dhcp_range() if response.code == 200: if response.start == subnet['start'] and response.end == subnet['end']: - LOGGER.info('Subnet change confirmed') + LOGGER.debug('Subnet change confirmed') return True - LOGGER.error('Failed to confirm subnet change') + LOGGER.debug('Failed to confirm subnet change') else: - LOGGER.error('Subnet change request failed.') + LOGGER.debug('Subnet change request failed.') return False def _get_cur_lease(self): diff --git a/modules/ui/.editorconfig b/modules/ui/.editorconfig new file mode 100644 index 000000000..59d9a3a3e --- /dev/null +++ b/modules/ui/.editorconfig @@ -0,0 +1,16 @@ +# Editor configuration, see https://editorconfig.org +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 2 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.ts] +quote_type = single + +[*.md] +max_line_length = off +trim_trailing_whitespace = false diff --git a/modules/ui/.gitignore b/modules/ui/.gitignore new file mode 100644 index 000000000..0711527ef --- /dev/null +++ b/modules/ui/.gitignore @@ -0,0 +1,42 @@ +# See http://help.github.com/ignore-files/ for more about ignoring files. + +# Compiled output +/dist +/tmp +/out-tsc +/bazel-out + +# Node +/node_modules +npm-debug.log +yarn-error.log + +# IDEs and editors +.idea/ +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace + +# Visual Studio Code +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +.history/* + +# Miscellaneous +/.angular/cache +.sass-cache/ +/connect.lock +/coverage +/libpeerconnection.log +testem.log +/typings + +# System files +.DS_Store +Thumbs.db diff --git a/modules/ui/README.md b/modules/ui/README.md new file mode 100644 index 000000000..cef441386 --- /dev/null +++ b/modules/ui/README.md @@ -0,0 +1,27 @@ +# TestRunUi + +This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.1.3. + +## Development server + +Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. + +## Code scaffolding + +Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. + +## Build + +Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. + +## Running unit tests + +Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). + +## Running end-to-end tests + +Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. + +## Further help + +To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page. diff --git a/modules/ui/angular.json b/modules/ui/angular.json new file mode 100644 index 000000000..90a6df04c --- /dev/null +++ b/modules/ui/angular.json @@ -0,0 +1,107 @@ +{ + "$schema": "./node_modules/@angular/cli/lib/config/schema.json", + "version": 1, + "newProjectRoot": "projects", + "projects": { + "test-run-ui": { + "projectType": "application", + "schematics": { + "@schematics/angular:component": { + "style": "scss" + } + }, + "root": "", + "sourceRoot": "src", + "prefix": "app", + "architect": { + "build": { + "builder": "@angular-devkit/build-angular:browser", + "options": { + "outputPath": "dist", + "index": "src/index.html", + "main": "src/main.ts", + "polyfills": [ + "zone.js" + ], + "tsConfig": "tsconfig.app.json", + "inlineStyleLanguage": "scss", + "assets": [ + "src/favicon.ico", + "src/assets" + ], + "styles": [ + "src/styles.scss" + ], + "scripts": [] + }, + "configurations": { + "production": { + "budgets": [ + { + "type": "initial", + "maximumWarning": "1000kb", + "maximumError": "2000kb" + }, + { + "type": "anyComponentStyle", + "maximumWarning": "2kb", + "maximumError": "4kb" + } + ], + "outputHashing": "all" + }, + "development": { + "buildOptimizer": false, + "optimization": false, + "vendorChunk": true, + "extractLicenses": false, + "sourceMap": true, + "namedChunks": true + } + }, + "defaultConfiguration": "production" + }, + "serve": { + "builder": "@angular-devkit/build-angular:dev-server", + "configurations": { + "production": { + "browserTarget": "test-run-ui:build:production" + }, + "development": { + "browserTarget": "test-run-ui:build:development" + } + }, + "defaultConfiguration": "development" + }, + "extract-i18n": { + "builder": "@angular-devkit/build-angular:extract-i18n", + "options": { + "browserTarget": "test-run-ui:build" + } + }, + "test": { + "builder": "@angular-devkit/build-angular:karma", + "options": { + "polyfills": [ + "zone.js", + "zone.js/testing" + ], + "tsConfig": "tsconfig.spec.json", + "inlineStyleLanguage": "scss", + "assets": [ + "src/favicon.ico", + "src/assets" + ], + "styles": [ + "src/styles.scss" + ], + "scripts": [] + } + } + } + } + }, + "cli": { + "analytics": false + } +} diff --git a/modules/ui/conf/nginx.conf b/modules/ui/nginx.conf similarity index 99% rename from modules/ui/conf/nginx.conf rename to modules/ui/nginx.conf index ade6ad17a..a31729236 100644 --- a/modules/ui/conf/nginx.conf +++ b/modules/ui/nginx.conf @@ -10,4 +10,4 @@ http { try_files $uri $uri/ /index.html; } } -} \ No newline at end of file +} diff --git a/modules/ui/package-lock.json b/modules/ui/package-lock.json new file mode 100644 index 000000000..e07c4fd91 --- /dev/null +++ b/modules/ui/package-lock.json @@ -0,0 +1,12407 @@ +{ + "name": "test-run-ui", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "test-run-ui", + "version": "0.0.0", + "dependencies": { + "@angular/animations": "^16.1.0", + "@angular/cdk": "^16.1.4", + "@angular/common": "^16.1.0", + "@angular/compiler": "^16.1.0", + "@angular/core": "^16.1.0", + "@angular/forms": "^16.1.0", + "@angular/material": "^16.1.4", + "@angular/platform-browser": "^16.1.0", + "@angular/platform-browser-dynamic": "^16.1.0", + "@angular/router": "^16.1.0", + "rxjs": "~7.8.0", + "tslib": "^2.3.0", + "zone.js": "~0.13.0" + }, + "devDependencies": { + "@angular-devkit/build-angular": "^16.1.3", + "@angular/cli": "~16.1.3", + "@angular/compiler-cli": "^16.1.0", + "@types/jasmine": "~4.3.0", + "jasmine-core": "~4.6.0", + "karma": "~6.4.0", + "karma-chrome-launcher": "~3.2.0", + "karma-coverage": "~2.2.0", + "karma-jasmine": "~5.1.0", + "karma-jasmine-html-reporter": "~2.1.0", + "typescript": "~5.1.3" + } + }, + "node_modules/@ampproject/remapping": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.1.tgz", + "integrity": "sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg==", + "dev": true, + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.0", + "@jridgewell/trace-mapping": "^0.3.9" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@angular-devkit/architect": { + "version": "0.1601.3", + "resolved": "https://registry.npmjs.org/@angular-devkit/architect/-/architect-0.1601.3.tgz", + "integrity": "sha512-HvW51cCEoIYe2mYqcmnm2RZiMMFbFn7iIdsjbCJe7etFhcG+Y3hGDZMh4IFSiQiss+pwPSYOvQY2zwGrndMgLw==", + "dev": true, + "dependencies": { + "@angular-devkit/core": "16.1.3", + "rxjs": "7.8.1" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + } + }, + "node_modules/@angular-devkit/build-angular": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular-devkit/build-angular/-/build-angular-16.1.3.tgz", + "integrity": "sha512-1scrdUdKRa9TkJ9jev/KRzFttbLUVACQvVRL0G67nUAdtJ/bQX8eui85axpCNPFihK4ReSW3R4lrgcVC2NUSoA==", + "dev": true, + "dependencies": { + "@ampproject/remapping": "2.2.1", + "@angular-devkit/architect": "0.1601.3", + "@angular-devkit/build-webpack": "0.1601.3", + "@angular-devkit/core": "16.1.3", + "@babel/core": "7.22.5", + "@babel/generator": "7.22.5", + "@babel/helper-annotate-as-pure": "7.22.5", + "@babel/helper-split-export-declaration": "7.22.5", + "@babel/plugin-proposal-async-generator-functions": "7.20.7", + "@babel/plugin-transform-async-to-generator": "7.22.5", + "@babel/plugin-transform-runtime": "7.22.5", + "@babel/preset-env": "7.22.5", + "@babel/runtime": "7.22.5", + "@babel/template": "7.22.5", + "@discoveryjs/json-ext": "0.5.7", + "@ngtools/webpack": "16.1.3", + "@vitejs/plugin-basic-ssl": "1.0.1", + "ansi-colors": "4.1.3", + "autoprefixer": "10.4.14", + "babel-loader": "9.1.2", + "babel-plugin-istanbul": "6.1.1", + "browserslist": "^4.21.5", + "cacache": "17.1.3", + "chokidar": "3.5.3", + "copy-webpack-plugin": "11.0.0", + "critters": "0.0.19", + "css-loader": "6.8.1", + "esbuild-wasm": "0.17.19", + "fast-glob": "3.2.12", + "https-proxy-agent": "5.0.1", + "inquirer": "8.2.4", + "jsonc-parser": "3.2.0", + "karma-source-map-support": "1.4.0", + "less": "4.1.3", + "less-loader": "11.1.0", + "license-webpack-plugin": "4.0.2", + "loader-utils": "3.2.1", + "magic-string": "0.30.0", + "mini-css-extract-plugin": "2.7.6", + "mrmime": "1.0.1", + "open": "8.4.2", + "ora": "5.4.1", + "parse5-html-rewriting-stream": "7.0.0", + "picomatch": "2.3.1", + "piscina": "3.2.0", + "postcss": "8.4.24", + "postcss-loader": "7.3.2", + "resolve-url-loader": "5.0.0", + "rxjs": "7.8.1", + "sass": "1.63.2", + "sass-loader": "13.3.1", + "semver": "7.5.3", + "source-map-loader": "4.0.1", + "source-map-support": "0.5.21", + "terser": "5.17.7", + "text-table": "0.2.0", + "tree-kill": "1.2.2", + "tslib": "2.5.3", + "vite": "4.3.9", + "webpack": "5.86.0", + "webpack-dev-middleware": "6.1.1", + "webpack-dev-server": "4.15.0", + "webpack-merge": "5.9.0", + "webpack-subresource-integrity": "5.1.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + }, + "optionalDependencies": { + "esbuild": "0.17.19" + }, + "peerDependencies": { + "@angular/compiler-cli": "^16.0.0", + "@angular/localize": "^16.0.0", + "@angular/platform-server": "^16.0.0", + "@angular/service-worker": "^16.0.0", + "jest": "^29.5.0", + "jest-environment-jsdom": "^29.5.0", + "karma": "^6.3.0", + "ng-packagr": "^16.0.0", + "protractor": "^7.0.0", + "tailwindcss": "^2.0.0 || ^3.0.0", + "typescript": ">=4.9.3 <5.2" + }, + "peerDependenciesMeta": { + "@angular/localize": { + "optional": true + }, + "@angular/platform-server": { + "optional": true + }, + "@angular/service-worker": { + "optional": true + }, + "jest": { + "optional": true + }, + "jest-environment-jsdom": { + "optional": true + }, + "karma": { + "optional": true + }, + "ng-packagr": { + "optional": true + }, + "protractor": { + "optional": true + }, + "tailwindcss": { + "optional": true + } + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/cli-width": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", + "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==", + "dev": true, + "engines": { + "node": ">= 10" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/@angular-devkit/build-angular/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/inquirer": { + "version": "8.2.4", + "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.4.tgz", + "integrity": "sha512-nn4F01dxU8VeKfq192IjLsxu0/OmMZ4Lg3xKAns148rCaXP6ntAoEkVYZThWjwON8AlzdZZi6oqnhNbxUG9hVg==", + "dev": true, + "dependencies": { + "ansi-escapes": "^4.2.1", + "chalk": "^4.1.1", + "cli-cursor": "^3.1.0", + "cli-width": "^3.0.0", + "external-editor": "^3.0.3", + "figures": "^3.0.0", + "lodash": "^4.17.21", + "mute-stream": "0.0.8", + "ora": "^5.4.1", + "run-async": "^2.4.0", + "rxjs": "^7.5.5", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0", + "through": "^2.3.6", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/mute-stream": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", + "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", + "dev": true + }, + "node_modules/@angular-devkit/build-angular/node_modules/run-async": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz", + "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==", + "dev": true, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@angular-devkit/build-angular/node_modules/tslib": { + "version": "2.5.3", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.5.3.tgz", + "integrity": "sha512-mSxlJJwl3BMEQCUNnxXBU9jP4JBktcEGhURcPR6VQVlnP0FdDEsIaz0C35dXNGLyRfrATNofF0F5p2KPxQgB+w==", + "dev": true + }, + "node_modules/@angular-devkit/build-webpack": { + "version": "0.1601.3", + "resolved": "https://registry.npmjs.org/@angular-devkit/build-webpack/-/build-webpack-0.1601.3.tgz", + "integrity": "sha512-744+72vi/Vx010VxizGgilhpnDCOG29qyhMmu7BkUhtpq8E8eQn2HU3nPpxAqrg3bKVAwD7v3F111MVIhub8kA==", + "dev": true, + "dependencies": { + "@angular-devkit/architect": "0.1601.3", + "rxjs": "7.8.1" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + }, + "peerDependencies": { + "webpack": "^5.30.0", + "webpack-dev-server": "^4.0.0" + } + }, + "node_modules/@angular-devkit/core": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular-devkit/core/-/core-16.1.3.tgz", + "integrity": "sha512-cFhNdJHumNMZGD3NYxOtNuMGRQXeDnKbwvK+IJmKAttXt8na6EvURR/ZxZOI7rl/YRVX+vcNSdtXz3hE6g+Isw==", + "dev": true, + "dependencies": { + "ajv": "8.12.0", + "ajv-formats": "2.1.1", + "jsonc-parser": "3.2.0", + "rxjs": "7.8.1", + "source-map": "0.7.4" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + }, + "peerDependencies": { + "chokidar": "^3.5.2" + }, + "peerDependenciesMeta": { + "chokidar": { + "optional": true + } + } + }, + "node_modules/@angular-devkit/schematics": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular-devkit/schematics/-/schematics-16.1.3.tgz", + "integrity": "sha512-hWEuQnfQOgcSs4YX6iF4QR/34ROeSPaMi7lQOYg33hStg+pnk/JDdIU0f2nrIIz3t0jqAj+5VXVLBJvOCd84vg==", + "dev": true, + "dependencies": { + "@angular-devkit/core": "16.1.3", + "jsonc-parser": "3.2.0", + "magic-string": "0.30.0", + "ora": "5.4.1", + "rxjs": "7.8.1" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + } + }, + "node_modules/@angular/animations": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/animations/-/animations-16.1.3.tgz", + "integrity": "sha512-ET6ahrlbOyTYXOTouKs2VJxx0CMTrYkfz0HfI6IHnSKBC6wguDxXYnamMouHgrCkDDEB5qClfGHyS9se0AOX4w==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/core": "16.1.3" + } + }, + "node_modules/@angular/cdk": { + "version": "16.1.4", + "resolved": "https://registry.npmjs.org/@angular/cdk/-/cdk-16.1.4.tgz", + "integrity": "sha512-05m0+NoAkV5O15GUEX2GQLySe8iC6P0GXVqUjLipdGmZ2/pNndJ/DGbqkX8dAAo/Z3ss2TEyRNYMOJdLIjV5vw==", + "dependencies": { + "tslib": "^2.3.0" + }, + "optionalDependencies": { + "parse5": "^7.1.2" + }, + "peerDependencies": { + "@angular/common": "^16.0.0 || ^17.0.0", + "@angular/core": "^16.0.0 || ^17.0.0", + "rxjs": "^6.5.3 || ^7.4.0" + } + }, + "node_modules/@angular/cli": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/cli/-/cli-16.1.3.tgz", + "integrity": "sha512-D0gU12z/N2oJ+s6pggAnWYrTUZ+2duGb3Y5oUyClsubz7JWpAwHjSZpb8exPUrgYhr+qIEMGO685y1JazJQ2tA==", + "dev": true, + "dependencies": { + "@angular-devkit/architect": "0.1601.3", + "@angular-devkit/core": "16.1.3", + "@angular-devkit/schematics": "16.1.3", + "@schematics/angular": "16.1.3", + "@yarnpkg/lockfile": "1.1.0", + "ansi-colors": "4.1.3", + "ini": "4.1.1", + "inquirer": "8.2.4", + "jsonc-parser": "3.2.0", + "npm-package-arg": "10.1.0", + "npm-pick-manifest": "8.0.1", + "open": "8.4.2", + "ora": "5.4.1", + "pacote": "15.2.0", + "resolve": "1.22.2", + "semver": "7.5.3", + "symbol-observable": "4.0.0", + "yargs": "17.7.2" + }, + "bin": { + "ng": "bin/ng.js" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + } + }, + "node_modules/@angular/cli/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/@angular/cli/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/@angular/cli/node_modules/cli-width": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", + "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==", + "dev": true, + "engines": { + "node": ">= 10" + } + }, + "node_modules/@angular/cli/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/@angular/cli/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/@angular/cli/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/@angular/cli/node_modules/inquirer": { + "version": "8.2.4", + "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.4.tgz", + "integrity": "sha512-nn4F01dxU8VeKfq192IjLsxu0/OmMZ4Lg3xKAns148rCaXP6ntAoEkVYZThWjwON8AlzdZZi6oqnhNbxUG9hVg==", + "dev": true, + "dependencies": { + "ansi-escapes": "^4.2.1", + "chalk": "^4.1.1", + "cli-cursor": "^3.1.0", + "cli-width": "^3.0.0", + "external-editor": "^3.0.3", + "figures": "^3.0.0", + "lodash": "^4.17.21", + "mute-stream": "0.0.8", + "ora": "^5.4.1", + "run-async": "^2.4.0", + "rxjs": "^7.5.5", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0", + "through": "^2.3.6", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@angular/cli/node_modules/mute-stream": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", + "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", + "dev": true + }, + "node_modules/@angular/cli/node_modules/run-async": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz", + "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==", + "dev": true, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/@angular/cli/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@angular/common": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/common/-/common-16.1.3.tgz", + "integrity": "sha512-ZzJ6EwQHUkiZYV0zH/UxyUYW5uxomsyk7tdtqZIxAR5m2ktYkQ5XlqgPjBO8voF54Rs5Ot43RkPCLesbZyJDsw==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/core": "16.1.3", + "rxjs": "^6.5.3 || ^7.4.0" + } + }, + "node_modules/@angular/compiler": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/compiler/-/compiler-16.1.3.tgz", + "integrity": "sha512-7Ckvssk9+s5xLyXvp72IwAw5vd/Osa3tR6oiQatdbw+O3XjLO04QycoGXwkp/fYVexGsjFyOn6QJ5n1F/PYPbQ==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/core": "16.1.3" + }, + "peerDependenciesMeta": { + "@angular/core": { + "optional": true + } + } + }, + "node_modules/@angular/compiler-cli": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/compiler-cli/-/compiler-cli-16.1.3.tgz", + "integrity": "sha512-aUqnIV9rRTBNgiQRS0Gv6lhghaGj1vpVRyXgiE4VnTR9uBONSsGKMNALYBBhXRTSk2e0cvutt0ubLgmNpdyWyQ==", + "dev": true, + "dependencies": { + "@babel/core": "7.22.5", + "@jridgewell/sourcemap-codec": "^1.4.14", + "chokidar": "^3.0.0", + "convert-source-map": "^1.5.1", + "reflect-metadata": "^0.1.2", + "semver": "^7.0.0", + "tslib": "^2.3.0", + "yargs": "^17.2.1" + }, + "bin": { + "ng-xi18n": "bundles/src/bin/ng_xi18n.js", + "ngc": "bundles/src/bin/ngc.js", + "ngcc": "bundles/ngcc/index.js" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/compiler": "16.1.3", + "typescript": ">=4.9.3 <5.2" + } + }, + "node_modules/@angular/core": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/core/-/core-16.1.3.tgz", + "integrity": "sha512-yhRo9hVS8KhfcEgzciWuRWF4Pnnko98bmSJTqd7u8Kys6z3Uj0qgXMssXHIPUALe3mQKjVkdSZPLIZ9/CaVn/Q==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "rxjs": "^6.5.3 || ^7.4.0", + "zone.js": "~0.13.0" + } + }, + "node_modules/@angular/forms": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/forms/-/forms-16.1.3.tgz", + "integrity": "sha512-9tJHgoi/Jmeo30zfnReVZWFcd1WthR+QwYUNwPev+ys58u1mB0cDGORvROySmC2YUyXFSpXt8sxwyWCkYvaV2w==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/common": "16.1.3", + "@angular/core": "16.1.3", + "@angular/platform-browser": "16.1.3", + "rxjs": "^6.5.3 || ^7.4.0" + } + }, + "node_modules/@angular/material": { + "version": "16.1.4", + "resolved": "https://registry.npmjs.org/@angular/material/-/material-16.1.4.tgz", + "integrity": "sha512-1SKWB14J+IorRL6uzq4a9cBLpVOMONTzso05LoVLGKrmtMCL5cRYLM/otT0IjY+oqG/fnTpsYDwV7E6n7AljeA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/auto-init": "15.0.0-canary.b994146f6.0", + "@material/banner": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/button": "15.0.0-canary.b994146f6.0", + "@material/card": "15.0.0-canary.b994146f6.0", + "@material/checkbox": "15.0.0-canary.b994146f6.0", + "@material/chips": "15.0.0-canary.b994146f6.0", + "@material/circular-progress": "15.0.0-canary.b994146f6.0", + "@material/data-table": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dialog": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/drawer": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/fab": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/floating-label": "15.0.0-canary.b994146f6.0", + "@material/form-field": "15.0.0-canary.b994146f6.0", + "@material/icon-button": "15.0.0-canary.b994146f6.0", + "@material/image-list": "15.0.0-canary.b994146f6.0", + "@material/layout-grid": "15.0.0-canary.b994146f6.0", + "@material/line-ripple": "15.0.0-canary.b994146f6.0", + "@material/linear-progress": "15.0.0-canary.b994146f6.0", + "@material/list": "15.0.0-canary.b994146f6.0", + "@material/menu": "15.0.0-canary.b994146f6.0", + "@material/menu-surface": "15.0.0-canary.b994146f6.0", + "@material/notched-outline": "15.0.0-canary.b994146f6.0", + "@material/radio": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/segmented-button": "15.0.0-canary.b994146f6.0", + "@material/select": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/slider": "15.0.0-canary.b994146f6.0", + "@material/snackbar": "15.0.0-canary.b994146f6.0", + "@material/switch": "15.0.0-canary.b994146f6.0", + "@material/tab": "15.0.0-canary.b994146f6.0", + "@material/tab-bar": "15.0.0-canary.b994146f6.0", + "@material/tab-indicator": "15.0.0-canary.b994146f6.0", + "@material/tab-scroller": "15.0.0-canary.b994146f6.0", + "@material/textfield": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tooltip": "15.0.0-canary.b994146f6.0", + "@material/top-app-bar": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.3.0" + }, + "peerDependencies": { + "@angular/animations": "^16.0.0 || ^17.0.0", + "@angular/cdk": "16.1.4", + "@angular/common": "^16.0.0 || ^17.0.0", + "@angular/core": "^16.0.0 || ^17.0.0", + "@angular/forms": "^16.0.0 || ^17.0.0", + "@angular/platform-browser": "^16.0.0 || ^17.0.0", + "rxjs": "^6.5.3 || ^7.4.0" + } + }, + "node_modules/@angular/platform-browser": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/platform-browser/-/platform-browser-16.1.3.tgz", + "integrity": "sha512-qZA6Lua2fpBe+KD/QArY/4hilypSZFcTcJsPjZwIzo5pavXqYDI8BVghwh5dcZoUa56hVRDJjv+XW6kl8m9Tdw==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/animations": "16.1.3", + "@angular/common": "16.1.3", + "@angular/core": "16.1.3" + }, + "peerDependenciesMeta": { + "@angular/animations": { + "optional": true + } + } + }, + "node_modules/@angular/platform-browser-dynamic": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/platform-browser-dynamic/-/platform-browser-dynamic-16.1.3.tgz", + "integrity": "sha512-UHxSWpPB5+FSv8zm8T+4ZikLqyy+VE6GlOLp/DdgEz77j81rz2C1pMqozwTnVbD16XbI4rhTp+RFY3C9ArWOtw==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/common": "16.1.3", + "@angular/compiler": "16.1.3", + "@angular/core": "16.1.3", + "@angular/platform-browser": "16.1.3" + } + }, + "node_modules/@angular/router": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@angular/router/-/router-16.1.3.tgz", + "integrity": "sha512-bkn8cWGBKKZidDaP+R7g/S/6miSfH8iP24d2k86Awo+vaO+7G/5WWGfKJMKK8UNM/A5ueX6ugAZrMHpQ9e6Y4w==", + "dependencies": { + "tslib": "^2.3.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0" + }, + "peerDependencies": { + "@angular/common": "16.1.3", + "@angular/core": "16.1.3", + "@angular/platform-browser": "16.1.3", + "rxjs": "^6.5.3 || ^7.4.0" + } + }, + "node_modules/@assemblyscript/loader": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@assemblyscript/loader/-/loader-0.10.1.tgz", + "integrity": "sha512-H71nDOOL8Y7kWRLqf6Sums+01Q5msqBW2KhDUTemh1tvY04eSkSXrK0uj/4mmY0Xr16/3zyZmsrxN7CKuRbNRg==", + "dev": true + }, + "node_modules/@babel/code-frame": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.22.5.tgz", + "integrity": "sha512-Xmwn266vad+6DAqEB2A6V/CcZVp62BbwVmcOJc2RPuwih1kw02TjQvWVWlcKGbBPd+8/0V5DEkOcizRGYsspYQ==", + "dev": true, + "dependencies": { + "@babel/highlight": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.22.5.tgz", + "integrity": "sha512-4Jc/YuIaYqKnDDz892kPIledykKg12Aw1PYX5i/TY28anJtacvM1Rrr8wbieB9GfEJwlzqT0hUEao0CxEebiDA==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.22.5.tgz", + "integrity": "sha512-SBuTAjg91A3eKOvD+bPEz3LlhHZRNu1nFOVts9lzDJTXshHTjII0BAtDS3Y2DAkdZdDKWVZGVwkDfc4Clxn1dg==", + "dev": true, + "dependencies": { + "@ampproject/remapping": "^2.2.0", + "@babel/code-frame": "^7.22.5", + "@babel/generator": "^7.22.5", + "@babel/helper-compilation-targets": "^7.22.5", + "@babel/helper-module-transforms": "^7.22.5", + "@babel/helpers": "^7.22.5", + "@babel/parser": "^7.22.5", + "@babel/template": "^7.22.5", + "@babel/traverse": "^7.22.5", + "@babel/types": "^7.22.5", + "convert-source-map": "^1.7.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.2", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/core/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/generator": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.22.5.tgz", + "integrity": "sha512-+lcUbnTRhd0jOewtFSedLyiPsD5tswKkbgcezOqqWFUVNEwoUTlpPOBmvhG7OXWLR4jMdv0czPGH5XbflnD1EA==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5", + "@jridgewell/gen-mapping": "^0.3.2", + "@jridgewell/trace-mapping": "^0.3.17", + "jsesc": "^2.5.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-annotate-as-pure": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.22.5.tgz", + "integrity": "sha512-LvBTxu8bQSQkcyKOU+a1btnNFQ1dMAd0R6PyW3arXes06F6QLWLIrd681bxRPIXlrMGR3XYnW9JyML7dP3qgxg==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-builder-binary-assignment-operator-visitor": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-builder-binary-assignment-operator-visitor/-/helper-builder-binary-assignment-operator-visitor-7.22.5.tgz", + "integrity": "sha512-m1EP3lVOPptR+2DwD125gziZNcmoNSHGmJROKoy87loWUQyJaVXDgpmruWqDARZSmtYQ+Dl25okU8+qhVzuykw==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.22.5.tgz", + "integrity": "sha512-Ji+ywpHeuqxB8WDxraCiqR0xfhYjiDE/e6k7FuIaANnoOFxAHskHChz4vA1mJC9Lbm01s1PVAGhQY4FUKSkGZw==", + "dev": true, + "dependencies": { + "@babel/compat-data": "^7.22.5", + "@babel/helper-validator-option": "^7.22.5", + "browserslist": "^4.21.3", + "lru-cache": "^5.1.1", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-compilation-targets/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-class-features-plugin": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.22.5.tgz", + "integrity": "sha512-xkb58MyOYIslxu3gKmVXmjTtUPvBU4odYzbiIQbWwLKIHCsx6UGZGX6F1IznMFVnDdirseUZopzN+ZRt8Xb33Q==", + "dev": true, + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.22.5", + "@babel/helper-environment-visitor": "^7.22.5", + "@babel/helper-function-name": "^7.22.5", + "@babel/helper-member-expression-to-functions": "^7.22.5", + "@babel/helper-optimise-call-expression": "^7.22.5", + "@babel/helper-replace-supers": "^7.22.5", + "@babel/helper-skip-transparent-expression-wrappers": "^7.22.5", + "@babel/helper-split-export-declaration": "^7.22.5", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-class-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.22.5.tgz", + "integrity": "sha512-1VpEFOIbMRaXyDeUwUfmTIxExLwQ+zkW+Bh5zXpApA3oQedBx9v/updixWxnx/bZpKw7u8VxWjb/qWpIcmPq8A==", + "dev": true, + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.22.5", + "regexpu-core": "^5.3.1", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-define-polyfill-provider": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.4.0.tgz", + "integrity": "sha512-RnanLx5ETe6aybRi1cO/edaRH+bNYWaryCEmjDDYyNr4wnSzyOp8T0dWipmqVHKEY3AbVKUom50AKSlj1zmKbg==", + "dev": true, + "dependencies": { + "@babel/helper-compilation-targets": "^7.17.7", + "@babel/helper-plugin-utils": "^7.16.7", + "debug": "^4.1.1", + "lodash.debounce": "^4.0.8", + "resolve": "^1.14.2", + "semver": "^6.1.2" + }, + "peerDependencies": { + "@babel/core": "^7.4.0-0" + } + }, + "node_modules/@babel/helper-define-polyfill-provider/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-environment-visitor": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.22.5.tgz", + "integrity": "sha512-XGmhECfVA/5sAt+H+xpSg0mfrHq6FzNr9Oxh7PSEBBRUb/mL7Kz3NICXb194rCqAEdxkhPT1a88teizAFyvk8Q==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-function-name": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.22.5.tgz", + "integrity": "sha512-wtHSq6jMRE3uF2otvfuD3DIvVhOsSNshQl0Qrd7qC9oQJzHvOL4qQXlQn2916+CXGywIjpGuIkoyZRRxHPiNQQ==", + "dev": true, + "dependencies": { + "@babel/template": "^7.22.5", + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-hoist-variables": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-hoist-variables/-/helper-hoist-variables-7.22.5.tgz", + "integrity": "sha512-wGjk9QZVzvknA6yKIUURb8zY3grXCcOZt+/7Wcy8O2uctxhplmUPkOdlgoNhmdVee2c92JXbf1xpMtVNbfoxRw==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-member-expression-to-functions": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.22.5.tgz", + "integrity": "sha512-aBiH1NKMG0H2cGZqspNvsaBe6wNGjbJjuLy29aU+eDZjSbbN53BaxlpB02xm9v34pLTZ1nIQPFYn2qMZoa5BQQ==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.22.5.tgz", + "integrity": "sha512-8Dl6+HD/cKifutF5qGd/8ZJi84QeAKh+CEe1sBzz8UayBBGg1dAIJrdHOcOM5b2MpzWL2yuotJTtGjETq0qjXg==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.22.5.tgz", + "integrity": "sha512-+hGKDt/Ze8GFExiVHno/2dvG5IdstpzCq0y4Qc9OJ25D4q3pKfiIP/4Vp3/JvhDkLKsDK2api3q3fpIgiIF5bw==", + "dev": true, + "dependencies": { + "@babel/helper-environment-visitor": "^7.22.5", + "@babel/helper-module-imports": "^7.22.5", + "@babel/helper-simple-access": "^7.22.5", + "@babel/helper-split-export-declaration": "^7.22.5", + "@babel/helper-validator-identifier": "^7.22.5", + "@babel/template": "^7.22.5", + "@babel/traverse": "^7.22.5", + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-optimise-call-expression": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.22.5.tgz", + "integrity": "sha512-HBwaojN0xFRx4yIvpwGqxiV2tUfl7401jlok564NgB9EHS1y6QT17FmKWm4ztqjeVdXLuC4fSvHc5ePpQjoTbw==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.22.5.tgz", + "integrity": "sha512-uLls06UVKgFG9QD4OeFYLEGteMIAa5kpTPcFL28yuCIIzsf6ZyKZMllKVOCZFhiZ5ptnwX4mtKdWCBE/uT4amg==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-remap-async-to-generator": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.22.5.tgz", + "integrity": "sha512-cU0Sq1Rf4Z55fgz7haOakIyM7+x/uCFwXpLPaeRzfoUtAEAuUZjZvFPjL/rk5rW693dIgn2hng1W7xbT7lWT4g==", + "dev": true, + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.22.5", + "@babel/helper-environment-visitor": "^7.22.5", + "@babel/helper-wrap-function": "^7.22.5", + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-replace-supers": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.22.5.tgz", + "integrity": "sha512-aLdNM5I3kdI/V9xGNyKSF3X/gTyMUBohTZ+/3QdQKAA9vxIiy12E+8E2HoOP1/DjeqU+g6as35QHJNMDDYpuCg==", + "dev": true, + "dependencies": { + "@babel/helper-environment-visitor": "^7.22.5", + "@babel/helper-member-expression-to-functions": "^7.22.5", + "@babel/helper-optimise-call-expression": "^7.22.5", + "@babel/template": "^7.22.5", + "@babel/traverse": "^7.22.5", + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-simple-access": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.22.5.tgz", + "integrity": "sha512-n0H99E/K+Bika3++WNL17POvo4rKWZ7lZEp1Q+fStVbUi8nxPQEBOlTmCOxW/0JsS56SKKQ+ojAe2pHKJHN35w==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-skip-transparent-expression-wrappers": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.22.5.tgz", + "integrity": "sha512-tK14r66JZKiC43p8Ki33yLBVJKlQDFoA8GYN67lWCDCqoL6EMMSuM9b+Iff2jHaM/RRFYl7K+iiru7hbRqNx8Q==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-split-export-declaration": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.22.5.tgz", + "integrity": "sha512-thqK5QFghPKWLhAV321lxF95yCg2K3Ob5yw+M3VHWfdia0IkPXUtoLH8x/6Fh486QUvzhb8YOWHChTVen2/PoQ==", + "dev": true, + "dependencies": { + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.22.5.tgz", + "integrity": "sha512-mM4COjgZox8U+JcXQwPijIZLElkgEpO5rsERVDJTc2qfCDfERyob6k5WegS14SX18IIjv+XD+GrqNumY5JRCDw==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.22.5.tgz", + "integrity": "sha512-aJXu+6lErq8ltp+JhkJUfk1MTGyuA4v7f3pA+BJ5HLfNC6nAQ0Cpi9uOquUj8Hehg0aUiHzWQbOVJGao6ztBAQ==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.22.5.tgz", + "integrity": "sha512-R3oB6xlIVKUnxNUxbmgq7pKjxpru24zlimpE8WK47fACIlM0II/Hm1RS8IaOI7NgCr6LNS+jl5l75m20npAziw==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-wrap-function": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.22.5.tgz", + "integrity": "sha512-bYqLIBSEshYcYQyfks8ewYA8S30yaGSeRslcvKMvoUk6HHPySbxHq9YRi6ghhzEU+yhQv9bP/jXnygkStOcqZw==", + "dev": true, + "dependencies": { + "@babel/helper-function-name": "^7.22.5", + "@babel/template": "^7.22.5", + "@babel/traverse": "^7.22.5", + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.22.5.tgz", + "integrity": "sha512-pSXRmfE1vzcUIDFQcSGA5Mr+GxBV9oiRKDuDxXvWQQBCh8HoIjs/2DlDB7H8smac1IVrB9/xdXj2N3Wol9Cr+Q==", + "dev": true, + "dependencies": { + "@babel/template": "^7.22.5", + "@babel/traverse": "^7.22.5", + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.22.5.tgz", + "integrity": "sha512-BSKlD1hgnedS5XRnGOljZawtag7H1yPfQp0tdNJCHoH6AZ+Pcm9VvkrK59/Yy593Ypg0zMxH2BxD1VPYUQ7UIw==", + "dev": true, + "dependencies": { + "@babel/helper-validator-identifier": "^7.22.5", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.22.5.tgz", + "integrity": "sha512-DFZMC9LJUG9PLOclRC32G63UXwzqS2koQC8dkx+PLdmt1xSePYpbT/NbsrJy8Q/muXz7o/h/d4A7Fuyixm559Q==", + "dev": true, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.22.5.tgz", + "integrity": "sha512-NP1M5Rf+u2Gw9qfSO4ihjcTGW5zXTi36ITLd4/EoAcEhIZ0yjMqmftDNl3QC19CX7olhrjpyU454g/2W7X0jvQ==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.22.5.tgz", + "integrity": "sha512-31Bb65aZaUwqCbWMnZPduIZxCBngHFlzyN6Dq6KAJjtx+lx6ohKHubc61OomYi7XwVD4Ol0XCVz4h+pYFR048g==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-skip-transparent-expression-wrappers": "^7.22.5", + "@babel/plugin-transform-optional-chaining": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.13.0" + } + }, + "node_modules/@babel/plugin-proposal-async-generator-functions": { + "version": "7.20.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.20.7.tgz", + "integrity": "sha512-xMbiLsn/8RK7Wq7VeVytytS2L6qE69bXPB10YCmMdDZbKF4okCqY74pI/jJQ/8U0b/F6NrT2+14b8/P9/3AMGA==", + "dev": true, + "dependencies": { + "@babel/helper-environment-visitor": "^7.18.9", + "@babel/helper-plugin-utils": "^7.20.2", + "@babel/helper-remap-async-to-generator": "^7.18.9", + "@babel/plugin-syntax-async-generators": "^7.8.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-private-property-in-object": { + "version": "7.21.0-placeholder-for-preset-env.2", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", + "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", + "dev": true, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-unicode-property-regex": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-unicode-property-regex/-/plugin-proposal-unicode-property-regex-7.18.6.tgz", + "integrity": "sha512-2BShG/d5yoZyXZfVePH91urL5wTG6ASZU9M4o03lKK8u8UW1y08OMttBSOADTcJrnPMpvDXRG3G8fyLh4ovs8w==", + "dev": true, + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-async-generators": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz", + "integrity": "sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-properties": { + "version": "7.12.13", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz", + "integrity": "sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.12.13" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-static-block": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz", + "integrity": "sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-dynamic-import": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz", + "integrity": "sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-export-namespace-from": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-export-namespace-from/-/plugin-syntax-export-namespace-from-7.8.3.tgz", + "integrity": "sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.3" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-assertions": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.22.5.tgz", + "integrity": "sha512-rdV97N7KqsRzeNGoWUOK6yUsWarLjE5Su/Snk9IYPU9CwkWHs4t+rTGOvffTR8XGkJMTAdLfO0xVnXm8wugIJg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-attributes": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.22.5.tgz", + "integrity": "sha512-KwvoWDeNKPETmozyFE0P2rOLqh39EoQHNjqizrI5B8Vt0ZNS7M56s7dAiAqbYfiAYOuIzIh96z3iR2ktgu3tEg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-meta": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz", + "integrity": "sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-json-strings": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz", + "integrity": "sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-logical-assignment-operators": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz", + "integrity": "sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-nullish-coalescing-operator": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz", + "integrity": "sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-numeric-separator": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz", + "integrity": "sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-object-rest-spread": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz", + "integrity": "sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-catch-binding": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz", + "integrity": "sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-chaining": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz", + "integrity": "sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-private-property-in-object": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz", + "integrity": "sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-top-level-await": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz", + "integrity": "sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-unicode-sets-regex": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", + "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", + "dev": true, + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-arrow-functions": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.22.5.tgz", + "integrity": "sha512-26lTNXoVRdAnsaDXPpvCNUq+OVWEVC6bx7Vvz9rC53F2bagUWW4u4ii2+h8Fejfh7RYqPxn+libeFBBck9muEw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-generator-functions": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.22.5.tgz", + "integrity": "sha512-gGOEvFzm3fWoyD5uZq7vVTD57pPJ3PczPUD/xCFGjzBpUosnklmXyKnGQbbbGs1NPNPskFex0j93yKbHt0cHyg==", + "dev": true, + "dependencies": { + "@babel/helper-environment-visitor": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-remap-async-to-generator": "^7.22.5", + "@babel/plugin-syntax-async-generators": "^7.8.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-to-generator": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.22.5.tgz", + "integrity": "sha512-b1A8D8ZzE/VhNDoV1MSJTnpKkCG5bJo+19R4o4oy03zM7ws8yEMK755j61Dc3EyvdysbqH5BOOTquJ7ZX9C6vQ==", + "dev": true, + "dependencies": { + "@babel/helper-module-imports": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-remap-async-to-generator": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoped-functions": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.22.5.tgz", + "integrity": "sha512-tdXZ2UdknEKQWKJP1KMNmuF5Lx3MymtMN/pvA+p/VEkhK8jVcQ1fzSy8KM9qRYhAf2/lV33hoMPKI/xaI9sADA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoping": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.22.5.tgz", + "integrity": "sha512-EcACl1i5fSQ6bt+YGuU/XGCeZKStLmyVGytWkpyhCLeQVA0eu6Wtiw92V+I1T/hnezUv7j74dA/Ro69gWcU+hg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-properties": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.22.5.tgz", + "integrity": "sha512-nDkQ0NfkOhPTq8YCLiWNxp1+f9fCobEjCb0n8WdbNUBc4IB5V7P1QnX9IjpSoquKrXF5SKojHleVNs2vGeHCHQ==", + "dev": true, + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-static-block": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.22.5.tgz", + "integrity": "sha512-SPToJ5eYZLxlnp1UzdARpOGeC2GbHvr9d/UV0EukuVx8atktg194oe+C5BqQ8jRTkgLRVOPYeXRSBg1IlMoVRA==", + "dev": true, + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-class-static-block": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0" + } + }, + "node_modules/@babel/plugin-transform-classes": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.22.5.tgz", + "integrity": "sha512-2edQhLfibpWpsVBx2n/GKOz6JdGQvLruZQfGr9l1qes2KQaWswjBzhQF7UDUZMNaMMQeYnQzxwOMPsbYF7wqPQ==", + "dev": true, + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.22.5", + "@babel/helper-compilation-targets": "^7.22.5", + "@babel/helper-environment-visitor": "^7.22.5", + "@babel/helper-function-name": "^7.22.5", + "@babel/helper-optimise-call-expression": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-replace-supers": "^7.22.5", + "@babel/helper-split-export-declaration": "^7.22.5", + "globals": "^11.1.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-computed-properties": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.22.5.tgz", + "integrity": "sha512-4GHWBgRf0krxPX+AaPtgBAlTgTeZmqDynokHOX7aqqAB4tHs3U2Y02zH6ETFdLZGcg9UQSD1WCmkVrE9ErHeOg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/template": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-destructuring": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.22.5.tgz", + "integrity": "sha512-GfqcFuGW8vnEqTUBM7UtPd5A4q797LTvvwKxXTgRsFjoqaJiEg9deBG6kWeQYkVEL569NpnmpC0Pkr/8BLKGnQ==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dotall-regex": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.22.5.tgz", + "integrity": "sha512-5/Yk9QxCQCl+sOIB1WelKnVRxTJDSAIxtJLL2/pqL14ZVlbH0fUQUZa/T5/UnQtBNgghR7mfB8ERBKyKPCi7Vw==", + "dev": true, + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-duplicate-keys": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.22.5.tgz", + "integrity": "sha512-dEnYD+9BBgld5VBXHnF/DbYGp3fqGMsyxKbtD1mDyIA7AkTSpKXFhCVuj/oQVOoALfBs77DudA0BE4d5mcpmqw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dynamic-import": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.22.5.tgz", + "integrity": "sha512-0MC3ppTB1AMxd8fXjSrbPa7LT9hrImt+/fcj+Pg5YMD7UQyWp/02+JWpdnCymmsXwIx5Z+sYn1bwCn4ZJNvhqQ==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-dynamic-import": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-exponentiation-operator": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.22.5.tgz", + "integrity": "sha512-vIpJFNM/FjZ4rh1myqIya9jXwrwwgFRHPjT3DkUA9ZLHuzox8jiXkOLvwm1H+PQIP3CqfC++WPKeuDi0Sjdj1g==", + "dev": true, + "dependencies": { + "@babel/helper-builder-binary-assignment-operator-visitor": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-export-namespace-from": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.22.5.tgz", + "integrity": "sha512-X4hhm7FRnPgd4nDA4b/5V280xCx6oL7Oob5+9qVS5C13Zq4bh1qq7LU0GgRU6b5dBWBvhGaXYVB4AcN6+ol6vg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-export-namespace-from": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-for-of": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.22.5.tgz", + "integrity": "sha512-3kxQjX1dU9uudwSshyLeEipvrLjBCVthCgeTp6CzE/9JYrlAIaeekVxRpCWsDDfYTfRZRoCeZatCQvwo+wvK8A==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-function-name": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.22.5.tgz", + "integrity": "sha512-UIzQNMS0p0HHiQm3oelztj+ECwFnj+ZRV4KnguvlsD2of1whUeM6o7wGNj6oLwcDoAXQ8gEqfgC24D+VdIcevg==", + "dev": true, + "dependencies": { + "@babel/helper-compilation-targets": "^7.22.5", + "@babel/helper-function-name": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-json-strings": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.22.5.tgz", + "integrity": "sha512-DuCRB7fu8MyTLbEQd1ew3R85nx/88yMoqo2uPSjevMj3yoN7CDM8jkgrY0wmVxfJZyJ/B9fE1iq7EQppWQmR5A==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-json-strings": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-literals": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.22.5.tgz", + "integrity": "sha512-fTLj4D79M+mepcw3dgFBTIDYpbcB9Sm0bpm4ppXPaO+U+PKFFyV9MGRvS0gvGw62sd10kT5lRMKXAADb9pWy8g==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-logical-assignment-operators": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.22.5.tgz", + "integrity": "sha512-MQQOUW1KL8X0cDWfbwYP+TbVbZm16QmQXJQ+vndPtH/BoO0lOKpVoEDMI7+PskYxH+IiE0tS8xZye0qr1lGzSA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-member-expression-literals": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.22.5.tgz", + "integrity": "sha512-RZEdkNtzzYCFl9SE9ATaUMTj2hqMb4StarOJLrZRbqqU4HSBE7UlBw9WBWQiDzrJZJdUWiMTVDI6Gv/8DPvfew==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-amd": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.22.5.tgz", + "integrity": "sha512-R+PTfLTcYEmb1+kK7FNkhQ1gP4KgjpSO6HfH9+f8/yfp2Nt3ggBjiVpRwmwTlfqZLafYKJACy36yDXlEmI9HjQ==", + "dev": true, + "dependencies": { + "@babel/helper-module-transforms": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-commonjs": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.22.5.tgz", + "integrity": "sha512-B4pzOXj+ONRmuaQTg05b3y/4DuFz3WcCNAXPLb2Q0GT0TrGKGxNKV4jwsXts+StaM0LQczZbOpj8o1DLPDJIiA==", + "dev": true, + "dependencies": { + "@babel/helper-module-transforms": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-simple-access": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-systemjs": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.22.5.tgz", + "integrity": "sha512-emtEpoaTMsOs6Tzz+nbmcePl6AKVtS1yC4YNAeMun9U8YCsgadPNxnOPQ8GhHFB2qdx+LZu9LgoC0Lthuu05DQ==", + "dev": true, + "dependencies": { + "@babel/helper-hoist-variables": "^7.22.5", + "@babel/helper-module-transforms": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-validator-identifier": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-umd": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.22.5.tgz", + "integrity": "sha512-+S6kzefN/E1vkSsKx8kmQuqeQsvCKCd1fraCM7zXm4SFoggI099Tr4G8U81+5gtMdUeMQ4ipdQffbKLX0/7dBQ==", + "dev": true, + "dependencies": { + "@babel/helper-module-transforms": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.22.5.tgz", + "integrity": "sha512-YgLLKmS3aUBhHaxp5hi1WJTgOUb/NCuDHzGT9z9WTt3YG+CPRhJs6nprbStx6DnWM4dh6gt7SU3sZodbZ08adQ==", + "dev": true, + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-new-target": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.22.5.tgz", + "integrity": "sha512-AsF7K0Fx/cNKVyk3a+DW0JLo+Ua598/NxMRvxDnkpCIGFh43+h/v2xyhRUYf6oD8gE4QtL83C7zZVghMjHd+iw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.22.5.tgz", + "integrity": "sha512-6CF8g6z1dNYZ/VXok5uYkkBBICHZPiGEl7oDnAx2Mt1hlHVHOSIKWJaXHjQJA5VB43KZnXZDIexMchY4y2PGdA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-numeric-separator": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.22.5.tgz", + "integrity": "sha512-NbslED1/6M+sXiwwtcAB/nieypGw02Ejf4KtDeMkCEpP6gWFMX1wI9WKYua+4oBneCCEmulOkRpwywypVZzs/g==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-numeric-separator": "^7.10.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-rest-spread": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.22.5.tgz", + "integrity": "sha512-Kk3lyDmEslH9DnvCDA1s1kkd3YWQITiBOHngOtDL9Pt6BZjzqb6hiOlb8VfjiiQJ2unmegBqZu0rx5RxJb5vmQ==", + "dev": true, + "dependencies": { + "@babel/compat-data": "^7.22.5", + "@babel/helper-compilation-targets": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-transform-parameters": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-super": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.22.5.tgz", + "integrity": "sha512-klXqyaT9trSjIUrcsYIfETAzmOEZL3cBYqOYLJxBHfMFFggmXOv+NYSX/Jbs9mzMVESw/WycLFPRx8ba/b2Ipw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-replace-supers": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-catch-binding": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.22.5.tgz", + "integrity": "sha512-pH8orJahy+hzZje5b8e2QIlBWQvGpelS76C63Z+jhZKsmzfNaPQ+LaW6dcJ9bxTpo1mtXbgHwy765Ro3jftmUg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-chaining": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.22.5.tgz", + "integrity": "sha512-AconbMKOMkyG+xCng2JogMCDcqW8wedQAqpVIL4cOSescZ7+iW8utC6YDZLMCSUIReEA733gzRSaOSXMAt/4WQ==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-skip-transparent-expression-wrappers": "^7.22.5", + "@babel/plugin-syntax-optional-chaining": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-parameters": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.22.5.tgz", + "integrity": "sha512-AVkFUBurORBREOmHRKo06FjHYgjrabpdqRSwq6+C7R5iTCZOsM4QbcB27St0a4U6fffyAOqh3s/qEfybAhfivg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-methods": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.22.5.tgz", + "integrity": "sha512-PPjh4gyrQnGe97JTalgRGMuU4icsZFnWkzicB/fUtzlKUqvsWBKEpPPfr5a2JiyirZkHxnAqkQMO5Z5B2kK3fA==", + "dev": true, + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-property-in-object": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.22.5.tgz", + "integrity": "sha512-/9xnaTTJcVoBtSSmrVyhtSvO3kbqS2ODoh2juEU72c3aYonNF0OMGiaz2gjukyKM2wBBYJP38S4JiE0Wfb5VMQ==", + "dev": true, + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.22.5", + "@babel/helper-create-class-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-property-literals": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.22.5.tgz", + "integrity": "sha512-TiOArgddK3mK/x1Qwf5hay2pxI6wCZnvQqrFSqbtg1GLl2JcNMitVH/YnqjP+M31pLUeTfzY1HAXFDnUBV30rQ==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-regenerator": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.22.5.tgz", + "integrity": "sha512-rR7KePOE7gfEtNTh9Qw+iO3Q/e4DEsoQ+hdvM6QUDH7JRJ5qxq5AA52ZzBWbI5i9lfNuvySgOGP8ZN7LAmaiPw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "regenerator-transform": "^0.15.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-reserved-words": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.22.5.tgz", + "integrity": "sha512-DTtGKFRQUDm8svigJzZHzb/2xatPc6TzNvAIJ5GqOKDsGFYgAskjRulbR/vGsPKq3OPqtexnz327qYpP57RFyA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.22.5.tgz", + "integrity": "sha512-bg4Wxd1FWeFx3daHFTWk1pkSWK/AyQuiyAoeZAOkAOUBjnZPH6KT7eMxouV47tQ6hl6ax2zyAWBdWZXbrvXlaw==", + "dev": true, + "dependencies": { + "@babel/helper-module-imports": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "babel-plugin-polyfill-corejs2": "^0.4.3", + "babel-plugin-polyfill-corejs3": "^0.8.1", + "babel-plugin-polyfill-regenerator": "^0.5.0", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/plugin-transform-shorthand-properties": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.22.5.tgz", + "integrity": "sha512-vM4fq9IXHscXVKzDv5itkO1X52SmdFBFcMIBZ2FRn2nqVYqw6dBexUgMvAjHW+KXpPPViD/Yo3GrDEBaRC0QYA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-spread": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.22.5.tgz", + "integrity": "sha512-5ZzDQIGyvN4w8+dMmpohL6MBo+l2G7tfC/O2Dg7/hjpgeWvUx8FzfeOKxGog9IimPa4YekaQ9PlDqTLOljkcxg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-skip-transparent-expression-wrappers": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-sticky-regex": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.22.5.tgz", + "integrity": "sha512-zf7LuNpHG0iEeiyCNwX4j3gDg1jgt1k3ZdXBKbZSoA3BbGQGvMiSvfbZRR3Dr3aeJe3ooWFZxOOG3IRStYp2Bw==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-template-literals": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.22.5.tgz", + "integrity": "sha512-5ciOehRNf+EyUeewo8NkbQiUs4d6ZxiHo6BcBcnFlgiJfu16q0bQUw9Jvo0b0gBKFG1SMhDSjeKXSYuJLeFSMA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typeof-symbol": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.22.5.tgz", + "integrity": "sha512-bYkI5lMzL4kPii4HHEEChkD0rkc+nvnlR6+o/qdqR6zrm0Sv/nodmyLhlq2DO0YKLUNd2VePmPRjJXSBh9OIdA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-escapes": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.22.5.tgz", + "integrity": "sha512-biEmVg1IYB/raUO5wT1tgfacCef15Fbzhkx493D3urBI++6hpJ+RFG4SrWMn0NEZLfvilqKf3QDrRVZHo08FYg==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-property-regex": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.22.5.tgz", + "integrity": "sha512-HCCIb+CbJIAE6sXn5CjFQXMwkCClcOfPCzTlilJ8cUatfzwHlWQkbtV0zD338u9dZskwvuOYTuuaMaA8J5EI5A==", + "dev": true, + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-regex": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.22.5.tgz", + "integrity": "sha512-028laaOKptN5vHJf9/Arr/HiJekMd41hOEZYvNsrsXqJ7YPYuX2bQxh31fkZzGmq3YqHRJzYFFAVYvKfMPKqyg==", + "dev": true, + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-sets-regex": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.22.5.tgz", + "integrity": "sha512-lhMfi4FC15j13eKrh3DnYHjpGj6UKQHtNKTbtc1igvAhRy4+kLhV07OpLcsN0VgDEw/MjAvJO4BdMJsHwMhzCg==", + "dev": true, + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/preset-env": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.22.5.tgz", + "integrity": "sha512-fj06hw89dpiZzGZtxn+QybifF07nNiZjZ7sazs2aVDcysAZVGjW7+7iFYxg6GLNM47R/thYfLdrXc+2f11Vi9A==", + "dev": true, + "dependencies": { + "@babel/compat-data": "^7.22.5", + "@babel/helper-compilation-targets": "^7.22.5", + "@babel/helper-plugin-utils": "^7.22.5", + "@babel/helper-validator-option": "^7.22.5", + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.22.5", + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.22.5", + "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", + "@babel/plugin-syntax-async-generators": "^7.8.4", + "@babel/plugin-syntax-class-properties": "^7.12.13", + "@babel/plugin-syntax-class-static-block": "^7.14.5", + "@babel/plugin-syntax-dynamic-import": "^7.8.3", + "@babel/plugin-syntax-export-namespace-from": "^7.8.3", + "@babel/plugin-syntax-import-assertions": "^7.22.5", + "@babel/plugin-syntax-import-attributes": "^7.22.5", + "@babel/plugin-syntax-import-meta": "^7.10.4", + "@babel/plugin-syntax-json-strings": "^7.8.3", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3", + "@babel/plugin-syntax-numeric-separator": "^7.10.4", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", + "@babel/plugin-syntax-optional-chaining": "^7.8.3", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5", + "@babel/plugin-syntax-top-level-await": "^7.14.5", + "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", + "@babel/plugin-transform-arrow-functions": "^7.22.5", + "@babel/plugin-transform-async-generator-functions": "^7.22.5", + "@babel/plugin-transform-async-to-generator": "^7.22.5", + "@babel/plugin-transform-block-scoped-functions": "^7.22.5", + "@babel/plugin-transform-block-scoping": "^7.22.5", + "@babel/plugin-transform-class-properties": "^7.22.5", + "@babel/plugin-transform-class-static-block": "^7.22.5", + "@babel/plugin-transform-classes": "^7.22.5", + "@babel/plugin-transform-computed-properties": "^7.22.5", + "@babel/plugin-transform-destructuring": "^7.22.5", + "@babel/plugin-transform-dotall-regex": "^7.22.5", + "@babel/plugin-transform-duplicate-keys": "^7.22.5", + "@babel/plugin-transform-dynamic-import": "^7.22.5", + "@babel/plugin-transform-exponentiation-operator": "^7.22.5", + "@babel/plugin-transform-export-namespace-from": "^7.22.5", + "@babel/plugin-transform-for-of": "^7.22.5", + "@babel/plugin-transform-function-name": "^7.22.5", + "@babel/plugin-transform-json-strings": "^7.22.5", + "@babel/plugin-transform-literals": "^7.22.5", + "@babel/plugin-transform-logical-assignment-operators": "^7.22.5", + "@babel/plugin-transform-member-expression-literals": "^7.22.5", + "@babel/plugin-transform-modules-amd": "^7.22.5", + "@babel/plugin-transform-modules-commonjs": "^7.22.5", + "@babel/plugin-transform-modules-systemjs": "^7.22.5", + "@babel/plugin-transform-modules-umd": "^7.22.5", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.22.5", + "@babel/plugin-transform-new-target": "^7.22.5", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.22.5", + "@babel/plugin-transform-numeric-separator": "^7.22.5", + "@babel/plugin-transform-object-rest-spread": "^7.22.5", + "@babel/plugin-transform-object-super": "^7.22.5", + "@babel/plugin-transform-optional-catch-binding": "^7.22.5", + "@babel/plugin-transform-optional-chaining": "^7.22.5", + "@babel/plugin-transform-parameters": "^7.22.5", + "@babel/plugin-transform-private-methods": "^7.22.5", + "@babel/plugin-transform-private-property-in-object": "^7.22.5", + "@babel/plugin-transform-property-literals": "^7.22.5", + "@babel/plugin-transform-regenerator": "^7.22.5", + "@babel/plugin-transform-reserved-words": "^7.22.5", + "@babel/plugin-transform-shorthand-properties": "^7.22.5", + "@babel/plugin-transform-spread": "^7.22.5", + "@babel/plugin-transform-sticky-regex": "^7.22.5", + "@babel/plugin-transform-template-literals": "^7.22.5", + "@babel/plugin-transform-typeof-symbol": "^7.22.5", + "@babel/plugin-transform-unicode-escapes": "^7.22.5", + "@babel/plugin-transform-unicode-property-regex": "^7.22.5", + "@babel/plugin-transform-unicode-regex": "^7.22.5", + "@babel/plugin-transform-unicode-sets-regex": "^7.22.5", + "@babel/preset-modules": "^0.1.5", + "@babel/types": "^7.22.5", + "babel-plugin-polyfill-corejs2": "^0.4.3", + "babel-plugin-polyfill-corejs3": "^0.8.1", + "babel-plugin-polyfill-regenerator": "^0.5.0", + "core-js-compat": "^3.30.2", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-env/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/preset-modules": { + "version": "0.1.5", + "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.5.tgz", + "integrity": "sha512-A57th6YRG7oR3cq/yt/Y84MvGgE0eJG2F1JLhKuyG+jFxEgrd/HAMJatiFtmOiZurz+0DkrvbheCLaV5f2JfjA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@babel/plugin-proposal-unicode-property-regex": "^7.4.4", + "@babel/plugin-transform-dotall-regex": "^7.4.4", + "@babel/types": "^7.4.4", + "esutils": "^2.0.2" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/regjsgen": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@babel/regjsgen/-/regjsgen-0.8.0.tgz", + "integrity": "sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA==", + "dev": true + }, + "node_modules/@babel/runtime": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.22.5.tgz", + "integrity": "sha512-ecjvYlnAaZ/KVneE/OdKYBYfgXV3Ptu6zQWmgEF7vwKhQnvVS6bjMD2XYgj+SNvQ1GfK/pjgokfPkC/2CO8CuA==", + "dev": true, + "dependencies": { + "regenerator-runtime": "^0.13.11" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/template": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.22.5.tgz", + "integrity": "sha512-X7yV7eiwAxdj9k94NEylvbVHLiVG1nvzCV2EAowhxLTwODV1jl9UzZ48leOC0sH7OnuHrIkllaBgneUykIcZaw==", + "dev": true, + "dependencies": { + "@babel/code-frame": "^7.22.5", + "@babel/parser": "^7.22.5", + "@babel/types": "^7.22.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.22.5.tgz", + "integrity": "sha512-7DuIjPgERaNo6r+PZwItpjCZEa5vyw4eJGufeLxrPdBXBoLcCJCIasvK6pK/9DVNrLZTLFhUGqaC6X/PA007TQ==", + "dev": true, + "dependencies": { + "@babel/code-frame": "^7.22.5", + "@babel/generator": "^7.22.5", + "@babel/helper-environment-visitor": "^7.22.5", + "@babel/helper-function-name": "^7.22.5", + "@babel/helper-hoist-variables": "^7.22.5", + "@babel/helper-split-export-declaration": "^7.22.5", + "@babel/parser": "^7.22.5", + "@babel/types": "^7.22.5", + "debug": "^4.1.0", + "globals": "^11.1.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.22.5.tgz", + "integrity": "sha512-zo3MIHGOkPOfoRXitsgHLjEXmlDaD/5KU1Uzuc9GNiZPhSqVxVRtxuPaSBZDsYZ9qV88AjtMtWW7ww98loJ9KA==", + "dev": true, + "dependencies": { + "@babel/helper-string-parser": "^7.22.5", + "@babel/helper-validator-identifier": "^7.22.5", + "to-fast-properties": "^2.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@colors/colors": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@discoveryjs/json-ext": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", + "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", + "dev": true, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.17.19.tgz", + "integrity": "sha512-rIKddzqhmav7MSmoFCmDIb6e2W57geRsM94gV2l38fzhXMwq7hZoClug9USI2pFRGL06f4IOPHHpFNOkWieR8A==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.17.19.tgz", + "integrity": "sha512-KBMWvEZooR7+kzY0BtbTQn0OAYY7CsiydT63pVEaPtVYF0hXbUaOyZog37DKxK7NF3XacBJOpYT4adIJh+avxA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.17.19.tgz", + "integrity": "sha512-uUTTc4xGNDT7YSArp/zbtmbhO0uEEK9/ETW29Wk1thYUJBz3IVnvgEiEwEa9IeLyvnpKrWK64Utw2bgUmDveww==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.17.19.tgz", + "integrity": "sha512-80wEoCfF/hFKM6WE1FyBHc9SfUblloAWx6FJkFWTWiCoht9Mc0ARGEM47e67W9rI09YoUxJL68WHfDRYEAvOhg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.17.19.tgz", + "integrity": "sha512-IJM4JJsLhRYr9xdtLytPLSH9k/oxR3boaUIYiHkAawtwNOXKE8KoU8tMvryogdcT8AU+Bflmh81Xn6Q0vTZbQw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.17.19.tgz", + "integrity": "sha512-pBwbc7DufluUeGdjSU5Si+P3SoMF5DQ/F/UmTSb8HXO80ZEAJmrykPyzo1IfNbAoaqw48YRpv8shwd1NoI0jcQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.17.19.tgz", + "integrity": "sha512-4lu+n8Wk0XlajEhbEffdy2xy53dpR06SlzvhGByyg36qJw6Kpfk7cp45DR/62aPH9mtJRmIyrXAS5UWBrJT6TQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.17.19.tgz", + "integrity": "sha512-cdmT3KxjlOQ/gZ2cjfrQOtmhG4HJs6hhvm3mWSRDPtZ/lP5oe8FWceS10JaSJC13GBd4eH/haHnqf7hhGNLerA==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.17.19.tgz", + "integrity": "sha512-ct1Tg3WGwd3P+oZYqic+YZF4snNl2bsnMKRkb3ozHmnM0dGWuxcPTTntAF6bOP0Sp4x0PjSF+4uHQ1xvxfRKqg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.17.19.tgz", + "integrity": "sha512-w4IRhSy1VbsNxHRQpeGCHEmibqdTUx61Vc38APcsRbuVgK0OPEnQ0YD39Brymn96mOx48Y2laBQGqgZ0j9w6SQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.17.19.tgz", + "integrity": "sha512-2iAngUbBPMq439a+z//gE+9WBldoMp1s5GWsUSgqHLzLJ9WoZLZhpwWuym0u0u/4XmZ3gpHmzV84PonE+9IIdQ==", + "cpu": [ + "loong64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.17.19.tgz", + "integrity": "sha512-LKJltc4LVdMKHsrFe4MGNPp0hqDFA1Wpt3jE1gEyM3nKUvOiO//9PheZZHfYRfYl6AwdTH4aTcXSqBerX0ml4A==", + "cpu": [ + "mips64el" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.17.19.tgz", + "integrity": "sha512-/c/DGybs95WXNS8y3Ti/ytqETiW7EU44MEKuCAcpPto3YjQbyK3IQVKfF6nbghD7EcLUGl0NbiL5Rt5DMhn5tg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.17.19.tgz", + "integrity": "sha512-FC3nUAWhvFoutlhAkgHf8f5HwFWUL6bYdvLc/TTuxKlvLi3+pPzdZiFKSWz/PF30TB1K19SuCxDTI5KcqASJqA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.17.19.tgz", + "integrity": "sha512-IbFsFbxMWLuKEbH+7sTkKzL6NJmG2vRyy6K7JJo55w+8xDk7RElYn6xvXtDW8HCfoKBFK69f3pgBJSUSQPr+4Q==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.17.19.tgz", + "integrity": "sha512-68ngA9lg2H6zkZcyp22tsVt38mlhWde8l3eJLWkyLrp4HwMUr3c1s/M2t7+kHIhvMjglIBrFpncX1SzMckomGw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.17.19.tgz", + "integrity": "sha512-CwFq42rXCR8TYIjIfpXCbRX0rp1jo6cPIUPSaWwzbVI4aOfX96OXY8M6KNmtPcg7QjYeDmN+DD0Wp3LaBOLf4Q==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.17.19.tgz", + "integrity": "sha512-cnq5brJYrSZ2CF6c35eCmviIN3k3RczmHz8eYaVlNasVqsNY+JKohZU5MKmaOI+KkllCdzOKKdPs762VCPC20g==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.17.19.tgz", + "integrity": "sha512-vCRT7yP3zX+bKWFeP/zdS6SqdWB8OIpaRq/mbXQxTGHnIxspRtigpkUcDMlSCOejlHowLqII7K2JKevwyRP2rg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.17.19.tgz", + "integrity": "sha512-yYx+8jwowUstVdorcMdNlzklLYhPxjniHWFKgRqH7IFlUEa0Umu3KuYplf1HUZZ422e3NU9F4LGb+4O0Kdcaag==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.17.19.tgz", + "integrity": "sha512-eggDKanJszUtCdlVs0RB+h35wNlb5v4TWEkq4vZcmVt5u/HiDZrTXe2bWFQUez3RgNHwx/x4sk5++4NSSicKkw==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.17.19.tgz", + "integrity": "sha512-lAhycmKnVOuRYNtRtatQR1LPQf2oYCkRGkSFnseDAKPl8lu5SOsK/e1sXe5a0Pc5kHIHe6P2I/ilntNv2xf3cA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@isaacs/cliui": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", + "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", + "dev": true, + "dependencies": { + "string-width": "^5.1.2", + "string-width-cjs": "npm:string-width@^4.2.0", + "strip-ansi": "^7.0.1", + "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", + "wrap-ansi": "^8.1.0", + "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@isaacs/cliui/node_modules/ansi-regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", + "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/@isaacs/cliui/node_modules/ansi-styles": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/@isaacs/cliui/node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "dev": true + }, + "node_modules/@isaacs/cliui/node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "dev": true, + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@isaacs/cliui/node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "dev": true, + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/@isaacs/cliui/node_modules/wrap-ansi": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", + "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/@istanbuljs/load-nyc-config": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", + "integrity": "sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==", + "dev": true, + "dependencies": { + "camelcase": "^5.3.1", + "find-up": "^4.1.0", + "get-package-type": "^0.1.0", + "js-yaml": "^3.13.1", + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/schema": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", + "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.3.tgz", + "integrity": "sha512-HLhSWOLRi875zjjMG/r+Nv0oCW8umGb0BgEhyX3dDX3egwZtB8PqLnjz3yedt8R5StBrzcg4aBpnh8UA9D1BoQ==", + "dev": true, + "dependencies": { + "@jridgewell/set-array": "^1.0.1", + "@jridgewell/sourcemap-codec": "^1.4.10", + "@jridgewell/trace-mapping": "^0.3.9" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.0.tgz", + "integrity": "sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==", + "dev": true, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/set-array": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.1.2.tgz", + "integrity": "sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==", + "dev": true, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/source-map": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.3.tgz", + "integrity": "sha512-b+fsZXeLYi9fEULmfBrhxn4IrPlINf8fiNarzTof004v3lFdntdwa9PF7vFJqm3mg7s+ScJMxXaE3Acp1irZcg==", + "dev": true, + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.0", + "@jridgewell/trace-mapping": "^0.3.9" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.15", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", + "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==", + "dev": true + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.18", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.18.tgz", + "integrity": "sha512-w+niJYzMHdd7USdiH2U6869nqhD2nbfZXND5Yp93qIbEmnDNk7PD48o+YchRVpzMU7M6jVCbenTR7PA1FLQ9pA==", + "dev": true, + "dependencies": { + "@jridgewell/resolve-uri": "3.1.0", + "@jridgewell/sourcemap-codec": "1.4.14" + } + }, + "node_modules/@jridgewell/trace-mapping/node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.14", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.14.tgz", + "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==", + "dev": true + }, + "node_modules/@leichtgewicht/ip-codec": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/@leichtgewicht/ip-codec/-/ip-codec-2.0.4.tgz", + "integrity": "sha512-Hcv+nVC0kZnQ3tD9GVu5xSMR4VVYOteQIr/hwFPVEvPdlXqgGEuRjiheChHgdM+JyqdgNcmzZOX/tnl0JOiI7A==", + "dev": true + }, + "node_modules/@material/animation": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/animation/-/animation-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-kqqzG54tabYJ5VsBur5k1bqCFQCEpaW3hmLRMiSVVxRY7XgTt7qkuOOz48gs+MPqR6P8VIi6gFpuscV1+DWDhw==", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@material/auto-init": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/auto-init/-/auto-init-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-8nLe/XeueJg5yyYx5e4UxWQXpTDyUhibKfyroGwnRKc8pdpOCOulHSOj/fIVGJAIbxkEJoebwMadWUNCjUhc9A==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/banner": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/banner/-/banner-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-gJ4/VdP4dJgHP72Kdjy2f/UjHB45J4CuxoGvI0NIQYUjOSsr4kQiQHsjVgyEPZR/5wa7kBhM7/0mJ+zF7Ghv2A==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/button": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/base": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/base/-/base-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-rW2upYD5YjRFBL6DzYn3SCRhtvpEDkwplDS810e3vt71uLMRyqXyw4OQJH+Nab/t+32TFDtKNUphXIzwICXGDQ==", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@material/button": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/button/-/button-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-SMyqtsvJuCqpXBz2JgciuR6wddNJSGpTXUFxmLbGluBy5/hHm06JWlOFcUOxGDv46OdRGGrRfkg6A9JtvtsJsw==", + "dependencies": { + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/card": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/card/-/card-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-WSggGon91HcDhJyatnYLFkoM9glkkeJjyjFDWrcJkwN1rdrPJU+GH+PNjvmArz5hGv9WkmjDjhOdAuPnL4Mb7g==", + "dependencies": { + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/checkbox": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/checkbox/-/checkbox-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-pulRiwG9S/dS6WBG+GteODBltddFiL0Sb7HAqdzF2BTKNKv25q1ZIR3ftoEa09TNeWM88AOzTJ4aBHiADfJn2w==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/chips": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/chips/-/chips-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-3yJPj7x+eKLA4LMKG7aTWI+itAnKRVGOcniuR6aiXVy0OKr5asNuWNeZc9J0/VErjjxF3tdybDzDSPo01qPy9w==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/checkbox": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "safevalues": "^0.3.4", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/circular-progress": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/circular-progress/-/circular-progress-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-6YUvGXdtZKJoE7AuovR4xk1aiWp/EDZ6j2U3TOeynd1assQQCg5XT4abqAoHtpJrRPaCFgUAp836HyiDVVuYug==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/progress-indicator": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/data-table": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/data-table/-/data-table-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-v4hIduIe/wzyibuL/RPM/ErYrt8XpB7fxyQqtV+0JsMpFa8E81QYyvMCS9EJj9m4YdkrQnZgA+vXQlOkhWvmdQ==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/checkbox": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/icon-button": "15.0.0-canary.b994146f6.0", + "@material/linear-progress": "15.0.0-canary.b994146f6.0", + "@material/list": "15.0.0-canary.b994146f6.0", + "@material/menu": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/select": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/density": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/density/-/density-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-m8l0vuoWSoAPItBpWp5eZDvitUcB2JWoO8V486hLgdveVcKgXG09xWM43ScH+PLXAWjzr5olDEuJ2tvfkN3SpQ==", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@material/dialog": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/dialog/-/dialog-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-JucU92yh8cfZQpyRBunHr6uohacePLYmhcPaGpkAGQ1b+zCznEsNs55tjhaVQNoj91XA9rrBqtL6Otg+fxFJtQ==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/button": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/icon-button": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/dom": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/dom/-/dom-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-DiUsTezrCi4iytjIn7xXoXZSNFvuTrVVZgc7cR9cW8yu2Hpz8bPf87PacVn4IP9OsNwy/dCDMk1Kcq/DMh7gXQ==", + "dependencies": { + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/drawer": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/drawer/-/drawer-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-Kbuf32V0eX69amvCVbAjNSabNDerZWyG8ip466EfQHRh0OUZwvsbhLp9FZOB7AyR+/bQiHf3mVLcombOdmdkcQ==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/list": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/elevation": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/elevation/-/elevation-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-l2YDNgBajSI6oA2l6gaeYCTGHRao657syqQ/tv95/Hkcee9900A4RrsxCwSxOqqAs5pZZDEJ33kFJjj27nqZDw==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/fab": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/fab/-/fab-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-ExyDVkNWINpns41Ahj4u8I/OhiVkqI0nmcqjFRtgTJMmKEd4NhlvqIxE7gakAlyS68riJu5UleqTSTVmt8mv2Q==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/feature-targeting": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/feature-targeting/-/feature-targeting-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-HR/FjSQmza98B1DF80MRjODyfOI9r7wXkPSts/cLQsYkpwZ5uJmxhvQKjDCeYVpMV0lQuvuvVOQo7uD44TdWEg==", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@material/floating-label": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/floating-label/-/floating-label-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-g64talBNWCS0FUfLWal0uB637gUciSIqYxFzSW//LglTtbZLGK2J4+9gAEswQGnKeO4ux08EN2n1ZcMDYQ58ow==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/focus-ring": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/focus-ring/-/focus-ring-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-87qEMuXsCvlQfTiimnzJUZoebnIXWcMtRZevNLymN9Y0t9jGckQxZPmrI0llRkpyiR/Ewhec5SI/JGrFlYHnsA==", + "dependencies": { + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0" + } + }, + "node_modules/@material/form-field": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/form-field/-/form-field-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-Tg1SQQaopvXMyDEYxGTWnhCWQmNcWVIoKMLmle9P/gi2p8ulcj0iOCPYf+3ECqUBVozOmTPKlYOOiRwtKStAeA==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/icon-button": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/icon-button/-/icon-button-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-X6DvOv4jpymHUjI7ZAbO946nDgGYKDwPZfkRzBE84gv2XEr2qfMuABhojxkYubRbt03oauBdcJVVMFCXkVhArQ==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/image-list": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/image-list/-/image-list-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-kf903XFF1P+V5ZPXCt+7R6c55g4UyQE1ZHkTViCIJfd52gU40bHODMhTQy/ywBkwDeJfNk8uf1V1IM24WQYpxA==", + "dependencies": { + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/layout-grid": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/layout-grid/-/layout-grid-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-OALBSGue8g1/mEwLYYi2d950dJFpNYKW87jPS9/KM65JKMyxoU7tU2d4An1BuyqK0r9sopGq6Pn/zhill0iLaw==", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@material/line-ripple": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/line-ripple/-/line-ripple-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-evjZxCu4iodiKtW8N0xjY8ACRXm3sY+4rAmq3vV5BmHWAJ3BobjbFYslDMZQ+4mu3HmwMatbJehKxHegahitNg==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/linear-progress": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/linear-progress/-/linear-progress-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-jlXh+tIj+/o0Ks7fHdC/24fH6IXCAl2vF52U6NwT39ESrlwmlLhp3gtag5GSBHN5E7Z09nK871Yo1G/b1F+COg==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/progress-indicator": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/list": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/list/-/list-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-kY/i6VvFBb/W3VvCPvWRMzWvu7mvNFJ+R8ijfawDoAXiv4fj42GO4iFyTcFXaUevEPKp791pN/09BMJQ6jYEvA==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/menu": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/menu/-/menu-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-y6smNmLJ+U0DoXWbyqzW+VW/uWDuklhdGHc5MbZrTOhsKkhvoTVNMSOa+NFPU4gTwrplvUjaUvnIsQ0wygwD3g==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/list": "15.0.0-canary.b994146f6.0", + "@material/menu-surface": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/menu-surface": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/menu-surface/-/menu-surface-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-StmM3lrRn1iMEZfq532jpMNppqyBBy68FbPurKEsHuP/3q+CscfnwjrS9ym+JcHqXKMHnQXbL/49ymffRGX2AQ==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/notched-outline": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/notched-outline/-/notched-outline-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-UZxU8jXM2t/bk/CiO0K+TSPspuJRZIyrYlIS0gd+qq/u8Gi2DpALBlLAh9Jeu46IUg4YGlPsNWYfe8p3QAVyoA==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/floating-label": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/progress-indicator": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/progress-indicator/-/progress-indicator-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-VT+mOQhohaM+pBX1rknbVOI6JCGKg9NiOHBoYljIvnexNeILE+mW9g6mtQ0ZCJPz0oMmiSAMLcuxMIcBXx84Xw==", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@material/radio": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/radio/-/radio-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-U/RR2lVNWwEO2+kJtGz9XzvnOF0gAZn1krMY0z/eU9Wnl0OgPZbqQrxXMoVNv1pzKYSEwZQEGado/rv8qp7piA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/ripple": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/ripple/-/ripple-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-WzIbc8wYTzMOczqGXVCBPdNcv/73Ef8FwcQYsscGMaqCzgVsdpoqilTfsx7Ryyz6dQbyfmJqp7s+YpPujcezOA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/rtl": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/rtl/-/rtl-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-H/W6BVn4Ygfkrf/FgSrNhbu1uY7PST2wlsjEYQt06EfAM0CDHEwSL1MwV4FmpQA/r40Q0PqoLN6moDrtCe5S8g==", + "dependencies": { + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/segmented-button": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/segmented-button/-/segmented-button-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-jd+f4BTnU0tghxBpAM/XdVmruDXSoQ88TYSFWbrhulS+/c/ooCZURWvVC4mHNej+QR/fODkx4adbqkBiwwCtMw==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/touch-target": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/select": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/select/-/select-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-5thEQS+B17JSm3I8D+mqQe2G3ArVnXJALTEEE9FmMUKwKYkrsLplm3FYuEXERZGJnYeTRdkdmhYY/YeocfZoyA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/floating-label": "15.0.0-canary.b994146f6.0", + "@material/line-ripple": "15.0.0-canary.b994146f6.0", + "@material/list": "15.0.0-canary.b994146f6.0", + "@material/menu": "15.0.0-canary.b994146f6.0", + "@material/menu-surface": "15.0.0-canary.b994146f6.0", + "@material/notched-outline": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/shape": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/shape/-/shape-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-sINM3gr3aLgdvqZVfqfXV5EB77owLLJjy+2NqchJ8ZPqucCJ+F/BsCBfLA2Wu3O4Sc9IpAEn/o1hzYm/CWAFAw==", + "dependencies": { + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/slider": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/slider/-/slider-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-dyT72+Kp//AEajJxDUVoMoizUjf2uggVMGXOaQ7FhpGHuf7LC3EyEjrrJ15efFzYgTjdJUU1YQkCwGmdt6CQsA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/snackbar": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/snackbar/-/snackbar-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-fEhPASJossScNpcrNYrrH8uU+rUf6+kw7/ZMrpUzzz1lVXliL28jTNEmU1nFpcDI4M2GXH+Z64f7vl2hiMDG8g==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/button": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/icon-button": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/switch": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/switch/-/switch-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-czCXTUa30ILIf1J3exiuSVIRcodGATHexd3eWDq4sfHo4iMh4rBMaIxcqkmnb2iwE/mMTNyVfoauijx2QiNKrA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "safevalues": "^0.3.4", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/tab": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/tab/-/tab-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-ygswooiNdBNNDnQdbPX0nzDQu7oQlHo8vWZ0/xL4IPVEXabY5zCzsEbGNZw2u/syo56c/NHPyMsUmXDGRSXOvQ==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/focus-ring": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/tab-indicator": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/tab-bar": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/tab-bar/-/tab-bar-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-F9NegACnFEWMu1pAAypV4Jd7qROeffkvEgVO28Xxk/CvzZxFz8kAjYJZ+rI6RUhPX3BhXzwsz/AlLwsJMT2tnA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/tab": "15.0.0-canary.b994146f6.0", + "@material/tab-indicator": "15.0.0-canary.b994146f6.0", + "@material/tab-scroller": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/tab-indicator": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/tab-indicator/-/tab-indicator-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-8IH/DmwlZhQlw/2Y3aKrEvjEhZB+qbKUiyaij3BkTAexvyFeDBh5cLNjRpYkUJSGeSPhS6yu4SYzMHPmQEwQmA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/tab-scroller": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/tab-scroller/-/tab-scroller-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-1MeWkr62OICfTv8oqhIZe6jFo0dKeMlUfB+/WcgnpoeMBszCOSlx5tQ4pedxUkuR3I+Z7rsTfSN0LavgF8bATA==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/tab": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/textfield": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/textfield/-/textfield-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-Kxb3DoJ5o8u3Y1gRMHKmWrDl1TirVxuf/UFrxPFiCE3J1SqiE2VQpakiD1emZwp+LSKtbRsQ/iILYLB/h7Wuvw==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/density": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/floating-label": "15.0.0-canary.b994146f6.0", + "@material/line-ripple": "15.0.0-canary.b994146f6.0", + "@material/notched-outline": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/theme": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/theme/-/theme-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-5tsZ92dAeUcZ9g9CrIkqX/GYc0M5DIfsydtI1PAidaBzr1Uokuh4rTZVQZBv7gyglF0yDua59lkb0I6wI9vxXg==", + "dependencies": { + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/tokens": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/tokens/-/tokens-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-jFqU7PtvGkrP8b8i2soCrYQInTrnZ1/rIPDi+Xm3sa/qSghCNwFrdJEqwcwtv1fPlJIOtzkIuVRYRmAP9rXQIQ==", + "dependencies": { + "@material/elevation": "15.0.0-canary.b994146f6.0" + } + }, + "node_modules/@material/tooltip": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/tooltip/-/tooltip-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-bVzydXGn3fauHJ8pkh32DsdyRJXleeFQ4t7jZ/rcRik+n4G1BvYiblfuu3Z/OCC0m3TJDyMdJhd+sLqRDqLUUg==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/button": "15.0.0-canary.b994146f6.0", + "@material/dom": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/tokens": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "safevalues": "^0.3.4", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/top-app-bar": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/top-app-bar/-/top-app-bar-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-VHq0wX3OJE1TKvjO8Qtlu+rv5EGoqAhNLBcEjpUUGoqHH/gpd356FEuIqJId4pUh5jaWf8T4ZU9xVbQGMtntzw==", + "dependencies": { + "@material/animation": "15.0.0-canary.b994146f6.0", + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/elevation": "15.0.0-canary.b994146f6.0", + "@material/ripple": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/shape": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "@material/typography": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/touch-target": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/touch-target/-/touch-target-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-X26Y9OWvIqYOHo+sC2VMvOoeQWlUR3/yb7uPdfq92Y44zlQ4Vexgq7nEUblEiXQ8Fj+d0T9rIhRh1y9PP3Z2dw==", + "dependencies": { + "@material/base": "15.0.0-canary.b994146f6.0", + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/rtl": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@material/typography": { + "version": "15.0.0-canary.b994146f6.0", + "resolved": "https://registry.npmjs.org/@material/typography/-/typography-15.0.0-canary.b994146f6.0.tgz", + "integrity": "sha512-sWU5W30WWqdw5P6bsRx9AbvMNcz/QvQg56Syr06V6nfgSztpeuo7TfPk2J+N0ArRALo1mUrkAPk66iWYQ2p/QA==", + "dependencies": { + "@material/feature-targeting": "15.0.0-canary.b994146f6.0", + "@material/theme": "15.0.0-canary.b994146f6.0", + "tslib": "^2.1.0" + } + }, + "node_modules/@ngtools/webpack": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@ngtools/webpack/-/webpack-16.1.3.tgz", + "integrity": "sha512-YTL1RzP7ErJqskx+ZwdC/nWsOSBfC4yYWmMyWL2J0d+oJ3N2XIzrKVoDcZ4IVzv3Du+3zoGp0ups/wWXvfzM/Q==", + "dev": true, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + }, + "peerDependencies": { + "@angular/compiler-cli": "^16.0.0", + "typescript": ">=4.9.3 <5.2", + "webpack": "^5.54.0" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@npmcli/fs": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-3.1.0.tgz", + "integrity": "sha512-7kZUAaLscfgbwBQRbvdMYaZOWyMEcPTH/tJjnyAWJ/dvvs9Ef+CERx/qJb9GExJpl1qipaDGn7KqHnFGGixd0w==", + "dev": true, + "dependencies": { + "semver": "^7.3.5" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/git": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@npmcli/git/-/git-4.1.0.tgz", + "integrity": "sha512-9hwoB3gStVfa0N31ymBmrX+GuDGdVA/QWShZVqE0HK2Af+7QGGrCTbZia/SW0ImUTjTne7SP91qxDmtXvDHRPQ==", + "dev": true, + "dependencies": { + "@npmcli/promise-spawn": "^6.0.0", + "lru-cache": "^7.4.4", + "npm-pick-manifest": "^8.0.0", + "proc-log": "^3.0.0", + "promise-inflight": "^1.0.1", + "promise-retry": "^2.0.1", + "semver": "^7.3.5", + "which": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/git/node_modules/lru-cache": { + "version": "7.18.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", + "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", + "dev": true, + "engines": { + "node": ">=12" + } + }, + "node_modules/@npmcli/git/node_modules/which": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", + "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/which.js" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/installed-package-contents": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/@npmcli/installed-package-contents/-/installed-package-contents-2.0.2.tgz", + "integrity": "sha512-xACzLPhnfD51GKvTOOuNX2/V4G4mz9/1I2MfDoye9kBM3RYe5g2YbscsaGoTlaWqkxeiapBWyseULVKpSVHtKQ==", + "dev": true, + "dependencies": { + "npm-bundled": "^3.0.0", + "npm-normalize-package-bin": "^3.0.0" + }, + "bin": { + "installed-package-contents": "lib/index.js" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/node-gyp": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@npmcli/node-gyp/-/node-gyp-3.0.0.tgz", + "integrity": "sha512-gp8pRXC2oOxu0DUE1/M3bYtb1b3/DbJ5aM113+XJBgfXdussRAsX0YOrOhdd8WvnAR6auDBvJomGAkLKA5ydxA==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/promise-spawn": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/@npmcli/promise-spawn/-/promise-spawn-6.0.2.tgz", + "integrity": "sha512-gGq0NJkIGSwdbUt4yhdF8ZrmkGKVz9vAdVzpOfnom+V8PLSmSOVhZwbNvZZS1EYcJN5hzzKBxmmVVAInM6HQLg==", + "dev": true, + "dependencies": { + "which": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/promise-spawn/node_modules/which": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", + "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/which.js" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/run-script": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/@npmcli/run-script/-/run-script-6.0.2.tgz", + "integrity": "sha512-NCcr1uQo1k5U+SYlnIrbAh3cxy+OQT1VtqiAbxdymSlptbzBb62AjH2xXgjNCoP073hoa1CfCAcwoZ8k96C4nA==", + "dev": true, + "dependencies": { + "@npmcli/node-gyp": "^3.0.0", + "@npmcli/promise-spawn": "^6.0.0", + "node-gyp": "^9.0.0", + "read-package-json-fast": "^3.0.0", + "which": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@npmcli/run-script/node_modules/which": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", + "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/which.js" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@pkgjs/parseargs": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", + "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", + "dev": true, + "optional": true, + "engines": { + "node": ">=14" + } + }, + "node_modules/@schematics/angular": { + "version": "16.1.3", + "resolved": "https://registry.npmjs.org/@schematics/angular/-/angular-16.1.3.tgz", + "integrity": "sha512-bNSxCLf6f+/dsQ1k3PhcZhrC/qgJSCpM6h3m6ATpjR+tYW/v7WR1OyE5r3DQmDe7NJSazBvpbrRtg8xjRsMzvw==", + "dev": true, + "dependencies": { + "@angular-devkit/core": "16.1.3", + "@angular-devkit/schematics": "16.1.3", + "jsonc-parser": "3.2.0" + }, + "engines": { + "node": "^16.14.0 || >=18.10.0", + "npm": "^6.11.0 || ^7.5.6 || >=8.0.0", + "yarn": ">= 1.13.0" + } + }, + "node_modules/@sigstore/protobuf-specs": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/@sigstore/protobuf-specs/-/protobuf-specs-0.1.0.tgz", + "integrity": "sha512-a31EnjuIDSX8IXBUib3cYLDRlPMU36AWX4xS8ysLaNu4ZzUesDiPt83pgrW2X1YLMe5L2HbDyaKK5BrL4cNKaQ==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@sigstore/tuf": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@sigstore/tuf/-/tuf-1.0.0.tgz", + "integrity": "sha512-bLzi9GeZgMCvjJeLUIfs8LJYCxrPRA8IXQkzUtaFKKVPTz0mucRyqFcV2U20yg9K+kYAD0YSitzGfRZCFLjdHQ==", + "dev": true, + "dependencies": { + "@sigstore/protobuf-specs": "^0.1.0", + "make-fetch-happen": "^11.0.1", + "tuf-js": "^1.1.3" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@socket.io/component-emitter": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@socket.io/component-emitter/-/component-emitter-3.1.0.tgz", + "integrity": "sha512-+9jVqKhRSpsc591z5vX+X5Yyw+he/HCB4iQ/RYxw35CEPaY1gnsNE43nf9n9AaYjAQrTiI/mOwKUKdUs9vf7Xg==", + "dev": true + }, + "node_modules/@tootallnate/once": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-2.0.0.tgz", + "integrity": "sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A==", + "dev": true, + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tufjs/canonical-json": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@tufjs/canonical-json/-/canonical-json-1.0.0.tgz", + "integrity": "sha512-QTnf++uxunWvG2z3UFNzAoQPHxnSXOwtaI3iJ+AohhV+5vONuArPjJE7aPXPVXfXJsqrVbZBu9b81AJoSd09IQ==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@tufjs/models": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@tufjs/models/-/models-1.0.4.tgz", + "integrity": "sha512-qaGV9ltJP0EO25YfFUPhxRVK0evXFIAGicsVXuRim4Ed9cjPxYhNnNJ49SFmbeLgtxpslIkX317IgpfcHPVj/A==", + "dev": true, + "dependencies": { + "@tufjs/canonical-json": "1.0.0", + "minimatch": "^9.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/@types/body-parser": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.2.tgz", + "integrity": "sha512-ALYone6pm6QmwZoAgeyNksccT9Q4AWZQ6PvfwR37GT6r6FWUPguq6sUmNGSMV2Wr761oQoBxwGGa6DR5o1DC9g==", + "dev": true, + "dependencies": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "node_modules/@types/bonjour": { + "version": "3.5.10", + "resolved": "https://registry.npmjs.org/@types/bonjour/-/bonjour-3.5.10.tgz", + "integrity": "sha512-p7ienRMiS41Nu2/igbJxxLDWrSZ0WxM8UQgCeO9KhoVF7cOVFkrKsiDr1EsJIla8vV3oEEjGcz11jc5yimhzZw==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect": { + "version": "3.4.35", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.35.tgz", + "integrity": "sha512-cdeYyv4KWoEgpBISTxWvqYsVy444DOqehiF3fM3ne10AmJ62RSyNkUnxMJXHQWRQQX2eR94m5y1IZyDwBjV9FQ==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect-history-api-fallback": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.0.tgz", + "integrity": "sha512-4x5FkPpLipqwthjPsF7ZRbOv3uoLUFkTA9G9v583qi4pACvq0uTELrB8OLUzPWUI4IJIyvM85vzkV1nyiI2Lig==", + "dev": true, + "dependencies": { + "@types/express-serve-static-core": "*", + "@types/node": "*" + } + }, + "node_modules/@types/cookie": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@types/cookie/-/cookie-0.4.1.tgz", + "integrity": "sha512-XW/Aa8APYr6jSVVA1y/DEIZX0/GMKLEVekNG727R8cs56ahETkRAy/3DR7+fJyh7oUgGwNQaRfXCun0+KbWY7Q==", + "dev": true + }, + "node_modules/@types/cors": { + "version": "2.8.13", + "resolved": "https://registry.npmjs.org/@types/cors/-/cors-2.8.13.tgz", + "integrity": "sha512-RG8AStHlUiV5ysZQKq97copd2UmVYw3/pRMLefISZ3S1hK104Cwm7iLQ3fTKx+lsUH2CE8FlLaYeEA2LSeqYUA==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/eslint": { + "version": "8.40.2", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.40.2.tgz", + "integrity": "sha512-PRVjQ4Eh9z9pmmtaq8nTjZjQwKFk7YIHIud3lRoKRBgUQjgjRmoGxxGEPXQkF+lH7QkHJRNr5F4aBgYCW0lqpQ==", + "dev": true, + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/@types/eslint-scope": { + "version": "3.7.4", + "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.4.tgz", + "integrity": "sha512-9K4zoImiZc3HlIp6AVUDE4CWYx22a+lhSZMYNpbjW04+YF0KWj4pJXnEMjdnFTiQibFFmElcsasJXDbdI/EPhA==", + "dev": true, + "dependencies": { + "@types/eslint": "*", + "@types/estree": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.1.tgz", + "integrity": "sha512-LG4opVs2ANWZ1TJoKc937iMmNstM/d0ae1vNbnBvBhqCSezgVUOzcLCqbI5elV8Vy6WKwKjaqR+zO9VKirBBCA==", + "dev": true + }, + "node_modules/@types/express": { + "version": "4.17.17", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.17.tgz", + "integrity": "sha512-Q4FmmuLGBG58btUnfS1c1r/NQdlp3DMfGDGig8WhfpA2YRUtEkxAjkZb0yvplJGYdF1fsQ81iMDcH24sSCNC/Q==", + "dev": true, + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.33", + "@types/qs": "*", + "@types/serve-static": "*" + } + }, + "node_modules/@types/express-serve-static-core": { + "version": "4.17.35", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.35.tgz", + "integrity": "sha512-wALWQwrgiB2AWTT91CB62b6Yt0sNHpznUXeZEcnPU3DRdlDIz74x8Qg1UUYKSVFi+va5vKOLYRBI1bRKiLLKIg==", + "dev": true, + "dependencies": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*", + "@types/send": "*" + } + }, + "node_modules/@types/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-/K3ds8TRAfBvi5vfjuz8y6+GiAYBZ0x4tXv1Av6CWBWn0IlADc+ZX9pMq7oU0fNQPnBwIZl3rmeLp6SBApbxSQ==", + "dev": true + }, + "node_modules/@types/http-proxy": { + "version": "1.17.11", + "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.11.tgz", + "integrity": "sha512-HC8G7c1WmaF2ekqpnFq626xd3Zz0uvaqFmBJNRZCGEZCXkvSdJoNFn/8Ygbd9fKNQj8UzLdCETaI0UWPAjK7IA==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/jasmine": { + "version": "4.3.5", + "resolved": "https://registry.npmjs.org/@types/jasmine/-/jasmine-4.3.5.tgz", + "integrity": "sha512-9YHUdvuNDDRJYXZwHqSsO72Ok0vmqoJbNn73ttyITQp/VA60SarnZ+MPLD37rJAhVoKp+9BWOvJP5tHIRfZylQ==", + "dev": true + }, + "node_modules/@types/json-schema": { + "version": "7.0.12", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.12.tgz", + "integrity": "sha512-Hr5Jfhc9eYOQNPYO5WLDq/n4jqijdHNlDXjuAQkkt+mWdQR+XJToOHrsD4cPaMXpn6KO7y2+wM8AZEs8VpBLVA==", + "dev": true + }, + "node_modules/@types/mime": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", + "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", + "dev": true + }, + "node_modules/@types/node": { + "version": "20.3.2", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.3.2.tgz", + "integrity": "sha512-vOBLVQeCQfIcF/2Y7eKFTqrMnizK5lRNQ7ykML/5RuwVXVWxYkgwS7xbt4B6fKCUPgbSL5FSsjHQpaGQP/dQmw==", + "dev": true + }, + "node_modules/@types/qs": { + "version": "6.9.7", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.7.tgz", + "integrity": "sha512-FGa1F62FT09qcrueBA6qYTrJPVDzah9a+493+o2PCXsesWHIn27G98TsSMs3WPNbZIEj4+VJf6saSFpvD+3Zsw==", + "dev": true + }, + "node_modules/@types/range-parser": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.4.tgz", + "integrity": "sha512-EEhsLsD6UsDM1yFhAvy0Cjr6VwmpMWqFBCb9w07wVugF7w9nfajxLuVmngTIpgS6svCnm6Vaw+MZhoDCKnOfsw==", + "dev": true + }, + "node_modules/@types/retry": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.0.tgz", + "integrity": "sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA==", + "dev": true + }, + "node_modules/@types/send": { + "version": "0.17.1", + "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.1.tgz", + "integrity": "sha512-Cwo8LE/0rnvX7kIIa3QHCkcuF21c05Ayb0ZfxPiv0W8VRiZiNW/WuRupHKpqqGVGf7SUA44QSOUKaEd9lIrd/Q==", + "dev": true, + "dependencies": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "node_modules/@types/serve-index": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/@types/serve-index/-/serve-index-1.9.1.tgz", + "integrity": "sha512-d/Hs3nWDxNL2xAczmOVZNj92YZCS6RGxfBPjKzuu/XirCgXdpKEb88dYNbrYGint6IVWLNP+yonwVAuRC0T2Dg==", + "dev": true, + "dependencies": { + "@types/express": "*" + } + }, + "node_modules/@types/serve-static": { + "version": "1.15.2", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.2.tgz", + "integrity": "sha512-J2LqtvFYCzaj8pVYKw8klQXrLLk7TBZmQ4ShlcdkELFKGwGMfevMLneMMRkMgZxotOD9wg497LpC7O8PcvAmfw==", + "dev": true, + "dependencies": { + "@types/http-errors": "*", + "@types/mime": "*", + "@types/node": "*" + } + }, + "node_modules/@types/sockjs": { + "version": "0.3.33", + "resolved": "https://registry.npmjs.org/@types/sockjs/-/sockjs-0.3.33.tgz", + "integrity": "sha512-f0KEEe05NvUnat+boPTZ0dgaLZ4SfSouXUgv5noUiefG2ajgKjmETo9ZJyuqsl7dfl2aHlLJUiki6B4ZYldiiw==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/ws": { + "version": "8.5.5", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.5.tgz", + "integrity": "sha512-lwhs8hktwxSjf9UaZ9tG5M03PGogvFaH8gUgLNbN9HKIg0dvv6q+gkSuJ8HN4/VbyxkuLzCjlN7GquQ0gUJfIg==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@vitejs/plugin-basic-ssl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-basic-ssl/-/plugin-basic-ssl-1.0.1.tgz", + "integrity": "sha512-pcub+YbFtFhaGRTo1832FQHQSHvMrlb43974e2eS8EKleR3p1cDdkJFPci1UhwkEf1J9Bz+wKBSzqpKp7nNj2A==", + "dev": true, + "engines": { + "node": ">=14.6.0" + }, + "peerDependencies": { + "vite": "^3.0.0 || ^4.0.0" + } + }, + "node_modules/@webassemblyjs/ast": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.6.tgz", + "integrity": "sha512-IN1xI7PwOvLPgjcf180gC1bqn3q/QaOCwYUahIOhbYUu8KA/3tw2RT/T0Gidi1l7Hhj5D/INhJxiICObqpMu4Q==", + "dev": true, + "dependencies": { + "@webassemblyjs/helper-numbers": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6" + } + }, + "node_modules/@webassemblyjs/floating-point-hex-parser": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.6.tgz", + "integrity": "sha512-ejAj9hfRJ2XMsNHk/v6Fu2dGS+i4UaXBXGemOfQ/JfQ6mdQg/WXtwleQRLLS4OvfDhv8rYnVwH27YJLMyYsxhw==", + "dev": true + }, + "node_modules/@webassemblyjs/helper-api-error": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.6.tgz", + "integrity": "sha512-o0YkoP4pVu4rN8aTJgAyj9hC2Sv5UlkzCHhxqWj8butaLvnpdc2jOwh4ewE6CX0txSfLn/UYaV/pheS2Txg//Q==", + "dev": true + }, + "node_modules/@webassemblyjs/helper-buffer": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.11.6.tgz", + "integrity": "sha512-z3nFzdcp1mb8nEOFFk8DrYLpHvhKC3grJD2ardfKOzmbmJvEf/tPIqCY+sNcwZIY8ZD7IkB2l7/pqhUhqm7hLA==", + "dev": true + }, + "node_modules/@webassemblyjs/helper-numbers": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.6.tgz", + "integrity": "sha512-vUIhZ8LZoIWHBohiEObxVm6hwP034jwmc9kuq5GdHZH0wiLVLIPcMCdpJzG4C11cHoQ25TFIQj9kaVADVX7N3g==", + "dev": true, + "dependencies": { + "@webassemblyjs/floating-point-hex-parser": "1.11.6", + "@webassemblyjs/helper-api-error": "1.11.6", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/helper-wasm-bytecode": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.6.tgz", + "integrity": "sha512-sFFHKwcmBprO9e7Icf0+gddyWYDViL8bpPjJJl0WHxCdETktXdmtWLGVzoHbqUcY4Be1LkNfwTmXOJUFZYSJdA==", + "dev": true + }, + "node_modules/@webassemblyjs/helper-wasm-section": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.11.6.tgz", + "integrity": "sha512-LPpZbSOwTpEC2cgn4hTydySy1Ke+XEu+ETXuoyvuyezHO3Kjdu90KK95Sh9xTbmjrCsUwvWwCOQQNta37VrS9g==", + "dev": true, + "dependencies": { + "@webassemblyjs/ast": "1.11.6", + "@webassemblyjs/helper-buffer": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/wasm-gen": "1.11.6" + } + }, + "node_modules/@webassemblyjs/ieee754": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.6.tgz", + "integrity": "sha512-LM4p2csPNvbij6U1f19v6WR56QZ8JcHg3QIJTlSwzFcmx6WSORicYj6I63f9yU1kEUtrpG+kjkiIAkevHpDXrg==", + "dev": true, + "dependencies": { + "@xtuc/ieee754": "^1.2.0" + } + }, + "node_modules/@webassemblyjs/leb128": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.6.tgz", + "integrity": "sha512-m7a0FhE67DQXgouf1tbN5XQcdWoNgaAuoULHIfGFIEVKA6tu/edls6XnIlkmS6FrXAquJRPni3ZZKjw6FSPjPQ==", + "dev": true, + "dependencies": { + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/utf8": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.6.tgz", + "integrity": "sha512-vtXf2wTQ3+up9Zsg8sa2yWiQpzSsMyXj0qViVP6xKGCUT8p8YJ6HqI7l5eCnWx1T/FYdsv07HQs2wTFbbof/RA==", + "dev": true + }, + "node_modules/@webassemblyjs/wasm-edit": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.11.6.tgz", + "integrity": "sha512-Ybn2I6fnfIGuCR+Faaz7YcvtBKxvoLV3Lebn1tM4o/IAJzmi9AWYIPWpyBfU8cC+JxAO57bk4+zdsTjJR+VTOw==", + "dev": true, + "dependencies": { + "@webassemblyjs/ast": "1.11.6", + "@webassemblyjs/helper-buffer": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/helper-wasm-section": "1.11.6", + "@webassemblyjs/wasm-gen": "1.11.6", + "@webassemblyjs/wasm-opt": "1.11.6", + "@webassemblyjs/wasm-parser": "1.11.6", + "@webassemblyjs/wast-printer": "1.11.6" + } + }, + "node_modules/@webassemblyjs/wasm-gen": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.11.6.tgz", + "integrity": "sha512-3XOqkZP/y6B4F0PBAXvI1/bky7GryoogUtfwExeP/v7Nzwo1QLcq5oQmpKlftZLbT+ERUOAZVQjuNVak6UXjPA==", + "dev": true, + "dependencies": { + "@webassemblyjs/ast": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" + } + }, + "node_modules/@webassemblyjs/wasm-opt": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.11.6.tgz", + "integrity": "sha512-cOrKuLRE7PCe6AsOVl7WasYf3wbSo4CeOk6PkrjS7g57MFfVUF9u6ysQBBODX0LdgSvQqRiGz3CXvIDKcPNy4g==", + "dev": true, + "dependencies": { + "@webassemblyjs/ast": "1.11.6", + "@webassemblyjs/helper-buffer": "1.11.6", + "@webassemblyjs/wasm-gen": "1.11.6", + "@webassemblyjs/wasm-parser": "1.11.6" + } + }, + "node_modules/@webassemblyjs/wasm-parser": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.11.6.tgz", + "integrity": "sha512-6ZwPeGzMJM3Dqp3hCsLgESxBGtT/OeCvCZ4TA1JUPYgmhAx38tTPR9JaKy0S5H3evQpO/h2uWs2j6Yc/fjkpTQ==", + "dev": true, + "dependencies": { + "@webassemblyjs/ast": "1.11.6", + "@webassemblyjs/helper-api-error": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" + } + }, + "node_modules/@webassemblyjs/wast-printer": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.11.6.tgz", + "integrity": "sha512-JM7AhRcE+yW2GWYaKeHL5vt4xqee5N2WcezptmgyhNS+ScggqcT1OtXykhAb13Sn5Yas0j2uv9tHgrjwvzAP4A==", + "dev": true, + "dependencies": { + "@webassemblyjs/ast": "1.11.6", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@xtuc/ieee754": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", + "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", + "dev": true + }, + "node_modules/@xtuc/long": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", + "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", + "dev": true + }, + "node_modules/@yarnpkg/lockfile": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@yarnpkg/lockfile/-/lockfile-1.1.0.tgz", + "integrity": "sha512-GpSwvyXOcOOlV70vbnzjj4fW5xW/FdUF6nQEt1ENy7m4ZCczi1+/buVUPAqmGfqznsORNFzUMjctTIp8a9tuCQ==", + "dev": true + }, + "node_modules/abab": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.6.tgz", + "integrity": "sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvHoRGU2zzP8cPoqys+xHTRDWW8L+/BA==", + "dev": true + }, + "node_modules/abbrev": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", + "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", + "dev": true + }, + "node_modules/accepts": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", + "dev": true, + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/acorn": { + "version": "8.9.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.9.0.tgz", + "integrity": "sha512-jaVNAFBHNLXspO543WnNNPZFRtavh3skAkITqD0/2aeMkKZTN+254PyhwxFYrk3vQ1xfY+2wbesJMs/JC8/PwQ==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-import-assertions": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/acorn-import-assertions/-/acorn-import-assertions-1.9.0.tgz", + "integrity": "sha512-cmMwop9x+8KFhxvKrKfPYmN6/pKTYYHBqLa0DfvVZcKMJWNyWLnaqND7dx/qn66R7ewM1UX5XMaDVP5wlVTaVA==", + "dev": true, + "peerDependencies": { + "acorn": "^8" + } + }, + "node_modules/adjust-sourcemap-loader": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/adjust-sourcemap-loader/-/adjust-sourcemap-loader-4.0.0.tgz", + "integrity": "sha512-OXwN5b9pCUXNQHJpwwD2qP40byEmSgzj8B4ydSN0uMNYWiFmJ6x6KwUllMmfk8Rwu/HJDFR7U8ubsWBoN0Xp0A==", + "dev": true, + "dependencies": { + "loader-utils": "^2.0.0", + "regex-parser": "^2.2.11" + }, + "engines": { + "node": ">=8.9" + } + }, + "node_modules/adjust-sourcemap-loader/node_modules/loader-utils": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.4.tgz", + "integrity": "sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==", + "dev": true, + "dependencies": { + "big.js": "^5.2.2", + "emojis-list": "^3.0.0", + "json5": "^2.1.2" + }, + "engines": { + "node": ">=8.9.0" + } + }, + "node_modules/agent-base": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", + "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", + "dev": true, + "dependencies": { + "debug": "4" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/agentkeepalive": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/agentkeepalive/-/agentkeepalive-4.3.0.tgz", + "integrity": "sha512-7Epl1Blf4Sy37j4v9f9FjICCh4+KAQOyXgHEwlyBiAQLbhKdq/i2QQU3amQalS/wPhdPzDXPL5DMR5bkn+YeWg==", + "dev": true, + "dependencies": { + "debug": "^4.1.0", + "depd": "^2.0.0", + "humanize-ms": "^1.2.1" + }, + "engines": { + "node": ">= 8.0.0" + } + }, + "node_modules/aggregate-error": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", + "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "dev": true, + "dependencies": { + "clean-stack": "^2.0.0", + "indent-string": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ajv": { + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", + "integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", + "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", + "dev": true, + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ajv-keywords": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-5.1.0.tgz", + "integrity": "sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.3" + }, + "peerDependencies": { + "ajv": "^8.8.2" + } + }, + "node_modules/ansi-colors": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", + "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-escapes": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", + "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "dev": true, + "dependencies": { + "type-fest": "^0.21.3" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-html-community": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/ansi-html-community/-/ansi-html-community-0.0.8.tgz", + "integrity": "sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw==", + "dev": true, + "engines": [ + "node >= 0.8.0" + ], + "bin": { + "ansi-html": "bin/ansi-html" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "dev": true, + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/aproba": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/aproba/-/aproba-2.0.0.tgz", + "integrity": "sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ==", + "dev": true + }, + "node_modules/are-we-there-yet": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-3.0.1.tgz", + "integrity": "sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg==", + "dev": true, + "dependencies": { + "delegates": "^1.0.0", + "readable-stream": "^3.6.0" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" + } + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/array-flatten": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-2.1.2.tgz", + "integrity": "sha512-hNfzcOV8W4NdualtqBFPyVO+54DSJuZGY9qT4pRroB6S9e3iiido2ISIC5h9R2sPJ8H3FHCIiEnsv1lPXO3KtQ==", + "dev": true + }, + "node_modules/autoprefixer": { + "version": "10.4.14", + "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.14.tgz", + "integrity": "sha512-FQzyfOsTlwVzjHxKEqRIAdJx9niO6VCBCoEwax/VLSoQF29ggECcPuBqUMZ+u8jCZOPSy8b8/8KnuFbp0SaFZQ==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/autoprefixer" + } + ], + "dependencies": { + "browserslist": "^4.21.5", + "caniuse-lite": "^1.0.30001464", + "fraction.js": "^4.2.0", + "normalize-range": "^0.1.2", + "picocolors": "^1.0.0", + "postcss-value-parser": "^4.2.0" + }, + "bin": { + "autoprefixer": "bin/autoprefixer" + }, + "engines": { + "node": "^10 || ^12 || >=14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/babel-loader": { + "version": "9.1.2", + "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-9.1.2.tgz", + "integrity": "sha512-mN14niXW43tddohGl8HPu5yfQq70iUThvFL/4QzESA7GcZoC0eVOhvWdQ8+3UlSjaDE9MVtsW9mxDY07W7VpVA==", + "dev": true, + "dependencies": { + "find-cache-dir": "^3.3.2", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0", + "webpack": ">=5" + } + }, + "node_modules/babel-plugin-istanbul": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz", + "integrity": "sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@istanbuljs/load-nyc-config": "^1.0.0", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-instrument": "^5.0.4", + "test-exclude": "^6.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/babel-plugin-polyfill-corejs2": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.3.tgz", + "integrity": "sha512-bM3gHc337Dta490gg+/AseNB9L4YLHxq1nGKZZSHbhXv4aTYU2MD2cjza1Ru4S6975YLTaL1K8uJf6ukJhhmtw==", + "dev": true, + "dependencies": { + "@babel/compat-data": "^7.17.7", + "@babel/helper-define-polyfill-provider": "^0.4.0", + "semver": "^6.1.1" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.8.1.tgz", + "integrity": "sha512-ikFrZITKg1xH6pLND8zT14UPgjKHiGLqex7rGEZCH2EvhsneJaJPemmpQaIZV5AL03II+lXylw3UmddDK8RU5Q==", + "dev": true, + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.4.0", + "core-js-compat": "^3.30.1" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/babel-plugin-polyfill-regenerator": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.5.0.tgz", + "integrity": "sha512-hDJtKjMLVa7Z+LwnTCxoDLQj6wdc+B8dun7ayF2fYieI6OzfuvcLMB32ihJZ4UhCBwNYGl5bg/x/P9cMdnkc2g==", + "dev": true, + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.4.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/base64id": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/base64id/-/base64id-2.0.0.tgz", + "integrity": "sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog==", + "dev": true, + "engines": { + "node": "^4.5.0 || >= 5.9" + } + }, + "node_modules/batch": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/batch/-/batch-0.6.1.tgz", + "integrity": "sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw==", + "dev": true + }, + "node_modules/big.js": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", + "integrity": "sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/binary-extensions": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.2.0.tgz", + "integrity": "sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/bl": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", + "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "dev": true, + "dependencies": { + "buffer": "^5.5.0", + "inherits": "^2.0.4", + "readable-stream": "^3.4.0" + } + }, + "node_modules/body-parser": { + "version": "1.20.2", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.2.tgz", + "integrity": "sha512-ml9pReCu3M61kGlqoTm2umSXTlRTuGTx0bfYj+uIUKKYycG5NtSbeetV3faSU6R7ajOPw0g/J1PvK4qNy7s5bA==", + "dev": true, + "dependencies": { + "bytes": "3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "on-finished": "2.4.1", + "qs": "6.11.0", + "raw-body": "2.5.2", + "type-is": "~1.6.18", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/body-parser/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/body-parser/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/bonjour-service": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/bonjour-service/-/bonjour-service-1.1.1.tgz", + "integrity": "sha512-Z/5lQRMOG9k7W+FkeGTNjh7htqn/2LMnfOvBZ8pynNZCM9MwkQkI3zeI4oz09uWdcgmgHugVvBqxGg4VQJ5PCg==", + "dev": true, + "dependencies": { + "array-flatten": "^2.1.2", + "dns-equal": "^1.0.0", + "fast-deep-equal": "^3.1.3", + "multicast-dns": "^7.2.5" + } + }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", + "dev": true + }, + "node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "dependencies": { + "fill-range": "^7.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browserslist": { + "version": "4.21.9", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.21.9.tgz", + "integrity": "sha512-M0MFoZzbUrRU4KNfCrDLnvyE7gub+peetoTid3TBIqtunaDJyXlwhakT+/VkvSXcfIzFfK/nkCs4nmyTmxdNSg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "caniuse-lite": "^1.0.30001503", + "electron-to-chromium": "^1.4.431", + "node-releases": "^2.0.12", + "update-browserslist-db": "^1.0.11" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/buffer": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", + "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.1.13" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true + }, + "node_modules/builtins": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", + "integrity": "sha512-qwVpFEHNfhYJIzNRBvd2C1kyo6jz3ZSMPyyuR47OPdiKWlbYnZNyDWuyR175qDnAJLiCo5fBBqPb3RiXgWlkOQ==", + "dev": true, + "dependencies": { + "semver": "^7.0.0" + } + }, + "node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/cacache": { + "version": "17.1.3", + "resolved": "https://registry.npmjs.org/cacache/-/cacache-17.1.3.tgz", + "integrity": "sha512-jAdjGxmPxZh0IipMdR7fK/4sDSrHMLUV0+GvVUsjwyGNKHsh79kW/otg+GkbXwl6Uzvy9wsvHOX4nUoWldeZMg==", + "dev": true, + "dependencies": { + "@npmcli/fs": "^3.1.0", + "fs-minipass": "^3.0.0", + "glob": "^10.2.2", + "lru-cache": "^7.7.1", + "minipass": "^5.0.0", + "minipass-collect": "^1.0.2", + "minipass-flush": "^1.0.5", + "minipass-pipeline": "^1.2.4", + "p-map": "^4.0.0", + "ssri": "^10.0.0", + "tar": "^6.1.11", + "unique-filename": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/cacache/node_modules/lru-cache": { + "version": "7.18.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", + "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", + "dev": true, + "engines": { + "node": ">=12" + } + }, + "node_modules/call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001509", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001509.tgz", + "integrity": "sha512-2uDDk+TRiTX5hMcUYT/7CSyzMZxjfGu0vAUjS2g0LSD8UoXOv0LtpH4LxGMemsiPq6LCVIUjNwVM0erkOkGCDA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ] + }, + "node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/chardet": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz", + "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==", + "dev": true + }, + "node_modules/chokidar": { + "version": "3.5.3", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", + "integrity": "sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://paulmillr.com/funding/" + } + ], + "dependencies": { + "anymatch": "~3.1.2", + "braces": "~3.0.2", + "glob-parent": "~5.1.2", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.6.0" + }, + "engines": { + "node": ">= 8.10.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/chownr": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", + "integrity": "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/chrome-trace-event": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.3.tgz", + "integrity": "sha512-p3KULyQg4S7NIHixdwbGX+nFHkoBiA4YQmyWtjb8XngSKV124nJmRysgAeujbUVb15vh+RvFUfCPqU7rXk+hZg==", + "dev": true, + "engines": { + "node": ">=6.0" + } + }, + "node_modules/clean-stack": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", + "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/cli-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", + "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "dev": true, + "dependencies": { + "restore-cursor": "^3.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cli-spinners": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.0.tgz", + "integrity": "sha512-4/aL9X3Wh0yiMQlE+eeRhWP6vclO3QRtw1JHKIT0FFUs5FjpFmESqtMvYZ0+lbzBw900b95mS0hohy+qn2VK/g==", + "dev": true, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "dev": true, + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/clone": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", + "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==", + "dev": true, + "engines": { + "node": ">=0.8" + } + }, + "node_modules/clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "dev": true, + "dependencies": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "dev": true + }, + "node_modules/color-support": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-support/-/color-support-1.1.3.tgz", + "integrity": "sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg==", + "dev": true, + "bin": { + "color-support": "bin.js" + } + }, + "node_modules/colorette": { + "version": "2.0.20", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", + "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", + "dev": true + }, + "node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "dev": true + }, + "node_modules/commondir": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/commondir/-/commondir-1.0.1.tgz", + "integrity": "sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==", + "dev": true + }, + "node_modules/compressible": { + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/compressible/-/compressible-2.0.18.tgz", + "integrity": "sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==", + "dev": true, + "dependencies": { + "mime-db": ">= 1.43.0 < 2" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/compression": { + "version": "1.7.4", + "resolved": "https://registry.npmjs.org/compression/-/compression-1.7.4.tgz", + "integrity": "sha512-jaSIDzP9pZVS4ZfQ+TzvtiWhdpFhE2RDHz8QJkpX9SIpLq88VueF5jJw6t+6CUQcAoA6t+x89MLrWAqpfDE8iQ==", + "dev": true, + "dependencies": { + "accepts": "~1.3.5", + "bytes": "3.0.0", + "compressible": "~2.0.16", + "debug": "2.6.9", + "on-headers": "~1.0.2", + "safe-buffer": "5.1.2", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/compression/node_modules/bytes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", + "integrity": "sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/compression/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/compression/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/compression/node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "dev": true + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true + }, + "node_modules/connect": { + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/connect/-/connect-3.7.0.tgz", + "integrity": "sha512-ZqRXc+tZukToSNmh5C2iWMSoV3X1YUcPbqEM4DkEG5tNQXrQUZCNVGGv3IuicnkMtPfGf3Xtp8WCXs295iQ1pQ==", + "dev": true, + "dependencies": { + "debug": "2.6.9", + "finalhandler": "1.1.2", + "parseurl": "~1.3.3", + "utils-merge": "1.0.1" + }, + "engines": { + "node": ">= 0.10.0" + } + }, + "node_modules/connect-history-api-fallback": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz", + "integrity": "sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA==", + "dev": true, + "engines": { + "node": ">=0.8" + } + }, + "node_modules/connect/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/connect/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/console-control-strings": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", + "integrity": "sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==", + "dev": true + }, + "node_modules/content-disposition": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "dev": true, + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/convert-source-map": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.9.0.tgz", + "integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==", + "dev": true + }, + "node_modules/cookie": { + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.4.2.tgz", + "integrity": "sha512-aSWTXFzaKWkvHO1Ny/s+ePFpvKsPnjc551iI41v3ny/ow6tBG5Vd+FuqGNhh1LxOmVzOlGUriIlOaokOvhaStA==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz", + "integrity": "sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==", + "dev": true + }, + "node_modules/copy-anything": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/copy-anything/-/copy-anything-2.0.6.tgz", + "integrity": "sha512-1j20GZTsvKNkc4BY3NpMOM8tt///wY3FpIzozTOFO2ffuZcV61nojHXVKIy3WM+7ADCy5FVhdZYHYDdgTU0yJw==", + "dev": true, + "dependencies": { + "is-what": "^3.14.1" + }, + "funding": { + "url": "https://github.com/sponsors/mesqueeb" + } + }, + "node_modules/copy-webpack-plugin": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz", + "integrity": "sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ==", + "dev": true, + "dependencies": { + "fast-glob": "^3.2.11", + "glob-parent": "^6.0.1", + "globby": "^13.1.1", + "normalize-path": "^3.0.0", + "schema-utils": "^4.0.0", + "serialize-javascript": "^6.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + } + }, + "node_modules/copy-webpack-plugin/node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", + "dev": true, + "dependencies": { + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/core-js-compat": { + "version": "3.31.0", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.31.0.tgz", + "integrity": "sha512-hM7YCu1cU6Opx7MXNu0NuumM0ezNeAeRKadixyiQELWY3vT3De9S4J5ZBMraWV2vZnrE1Cirl0GtFtDtMUXzPw==", + "dev": true, + "dependencies": { + "browserslist": "^4.21.5" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-util-is": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", + "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", + "dev": true + }, + "node_modules/cors": { + "version": "2.8.5", + "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.5.tgz", + "integrity": "sha512-KIHbLJqu73RGr/hnbrO9uBeixNGuvSQjul/jdFvS/KFSIH1hWVd1ng7zOHx+YrEfInLG7q4n6GHQ9cDtxv/P6g==", + "dev": true, + "dependencies": { + "object-assign": "^4", + "vary": "^1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/cosmiconfig": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.2.0.tgz", + "integrity": "sha512-3rTMnFJA1tCOPwRxtgF4wd7Ab2qvDbL8jX+3smjIbS4HlZBagTlpERbdN7iAbWlrfxE3M8c27kTwTawQ7st+OQ==", + "dev": true, + "dependencies": { + "import-fresh": "^3.2.1", + "js-yaml": "^4.1.0", + "parse-json": "^5.0.0", + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + } + }, + "node_modules/cosmiconfig/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/cosmiconfig/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/critters": { + "version": "0.0.19", + "resolved": "https://registry.npmjs.org/critters/-/critters-0.0.19.tgz", + "integrity": "sha512-Fm4ZAXsG0VzWy1U30rP4qxbaWGSsqXDgSupJW1OUJGDAs0KWC+j37v7p5a2kZ9BPJvhRzWm3be+Hc9WvQOBUOw==", + "dev": true, + "dependencies": { + "chalk": "^4.1.0", + "css-select": "^5.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.2", + "htmlparser2": "^8.0.2", + "postcss": "^8.4.23", + "pretty-bytes": "^5.3.0" + } + }, + "node_modules/critters/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/critters/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/critters/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/critters/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/critters/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/critters/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/css-loader": { + "version": "6.8.1", + "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-6.8.1.tgz", + "integrity": "sha512-xDAXtEVGlD0gJ07iclwWVkLoZOpEvAWaSyf6W18S2pOC//K8+qUDIx8IIT3D+HjnmkJPQeesOPv5aiUaJsCM2g==", + "dev": true, + "dependencies": { + "icss-utils": "^5.1.0", + "postcss": "^8.4.21", + "postcss-modules-extract-imports": "^3.0.0", + "postcss-modules-local-by-default": "^4.0.3", + "postcss-modules-scope": "^3.0.0", + "postcss-modules-values": "^4.0.0", + "postcss-value-parser": "^4.2.0", + "semver": "^7.3.8" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + } + }, + "node_modules/css-select": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.1.0.tgz", + "integrity": "sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg==", + "dev": true, + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.1.0", + "domhandler": "^5.0.2", + "domutils": "^3.0.1", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/css-what": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.1.0.tgz", + "integrity": "sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==", + "dev": true, + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/cssesc": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", + "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", + "dev": true, + "bin": { + "cssesc": "bin/cssesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/custom-event": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/custom-event/-/custom-event-1.0.1.tgz", + "integrity": "sha512-GAj5FOq0Hd+RsCGVJxZuKaIDXDf3h6GQoNEjFgbLLI/trgtavwUbSnZ5pVfg27DVCaWjIohryS0JFwIJyT2cMg==", + "dev": true + }, + "node_modules/date-format": { + "version": "4.0.14", + "resolved": "https://registry.npmjs.org/date-format/-/date-format-4.0.14.tgz", + "integrity": "sha512-39BOQLs9ZjKh0/patS9nrT8wc3ioX3/eA/zgbKNopnF2wCqJEoxywwwElATYvRsXdnOxA/OQeQoFZ3rFjVajhg==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/debug": { + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", + "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/default-gateway": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/default-gateway/-/default-gateway-6.0.3.tgz", + "integrity": "sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg==", + "dev": true, + "dependencies": { + "execa": "^5.0.0" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/defaults": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", + "integrity": "sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==", + "dev": true, + "dependencies": { + "clone": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/define-lazy-prop": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", + "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/delegates": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delegates/-/delegates-1.0.0.tgz", + "integrity": "sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==", + "dev": true + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "dev": true, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/detect-node": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.1.0.tgz", + "integrity": "sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==", + "dev": true + }, + "node_modules/di": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/di/-/di-0.0.1.tgz", + "integrity": "sha512-uJaamHkagcZtHPqCIHZxnFrXlunQXgBOsZSUOWwFw31QJCAbyTBoHMW75YOTur5ZNx8pIeAKgf6GWIgaqqiLhA==", + "dev": true + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/dns-equal": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/dns-equal/-/dns-equal-1.0.0.tgz", + "integrity": "sha512-z+paD6YUQsk+AbGCEM4PrOXSss5gd66QfcVBFTKR/HpFL9jCqikS94HYwKww6fQyO7IxrIIyUu+g0Ka9tUS2Cg==", + "dev": true + }, + "node_modules/dns-packet": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/dns-packet/-/dns-packet-5.6.0.tgz", + "integrity": "sha512-rza3UH1LwdHh9qyPXp8lkwpjSNk/AMD3dPytUoRoqnypDUhY0xvbdmVhWOfxO68frEfV9BU8V12Ez7ZsHGZpCQ==", + "dev": true, + "dependencies": { + "@leichtgewicht/ip-codec": "^2.0.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/dom-serialize": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/dom-serialize/-/dom-serialize-2.2.1.tgz", + "integrity": "sha512-Yra4DbvoW7/Z6LBN560ZwXMjoNOSAN2wRsKFGc4iBeso+mpIA6qj1vfdf9HpMaKAqG6wXTy+1SYEzmNpKXOSsQ==", + "dev": true, + "dependencies": { + "custom-event": "~1.0.0", + "ent": "~2.2.0", + "extend": "^3.0.0", + "void-elements": "^2.0.0" + } + }, + "node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "dev": true, + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ] + }, + "node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "dev": true, + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.1.0.tgz", + "integrity": "sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA==", + "dev": true, + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "dev": true + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", + "dev": true + }, + "node_modules/electron-to-chromium": { + "version": "1.4.445", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.445.tgz", + "integrity": "sha512-++DB+9VK8SBJwC+X1zlMfJ1tMA3F0ipi39GdEp+x3cV2TyBihqAgad8cNMWtLDEkbH39nlDQP7PfGrDr3Dr7HA==", + "dev": true + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "node_modules/emojis-list": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", + "integrity": "sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/encodeurl": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", + "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/encoding": { + "version": "0.1.13", + "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", + "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==", + "dev": true, + "optional": true, + "dependencies": { + "iconv-lite": "^0.6.2" + } + }, + "node_modules/encoding/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "dev": true, + "optional": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/engine.io": { + "version": "6.5.1", + "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.5.1.tgz", + "integrity": "sha512-mGqhI+D7YxS9KJMppR6Iuo37Ed3abhU8NdfgSvJSDUafQutrN+sPTncJYTyM9+tkhSmWodKtVYGPPHyXJEwEQA==", + "dev": true, + "dependencies": { + "@types/cookie": "^0.4.1", + "@types/cors": "^2.8.12", + "@types/node": ">=10.0.0", + "accepts": "~1.3.4", + "base64id": "2.0.0", + "cookie": "~0.4.1", + "cors": "~2.8.5", + "debug": "~4.3.1", + "engine.io-parser": "~5.1.0", + "ws": "~8.11.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/engine.io-parser": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-5.1.0.tgz", + "integrity": "sha512-enySgNiK5tyZFynt3z7iqBR+Bto9EVVVvDFuTT0ioHCGbzirZVGDGiQjZzEp8hWl6hd5FSVytJGuScX1C1C35w==", + "dev": true, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/enhanced-resolve": { + "version": "5.15.0", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.15.0.tgz", + "integrity": "sha512-LXYT42KJ7lpIKECr2mAXIaMldcNCh/7E0KBKOu4KSfkHmP+mZmSs+8V5gBAqisWBy0OO4W5Oyys0GO1Y8KtdKg==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.2.4", + "tapable": "^2.2.0" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/ent": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/ent/-/ent-2.2.0.tgz", + "integrity": "sha512-GHrMyVZQWvTIdDtpiEXdHZnFQKzeO09apj8Cbl4pKWy4i0Oprcq17usfDt5aO63swf0JOeMWjWQE/LzgSRuWpA==", + "dev": true + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "devOptional": true, + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/env-paths": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/env-paths/-/env-paths-2.2.1.tgz", + "integrity": "sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/err-code": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz", + "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==", + "dev": true + }, + "node_modules/errno": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/errno/-/errno-0.1.8.tgz", + "integrity": "sha512-dJ6oBr5SQ1VSd9qkk7ByRgb/1SH4JZjCHSW/mr63/QcXO9zLVxvJ6Oy13nio03rxpSnVDDjFor75SjVeZWPW/A==", + "dev": true, + "optional": true, + "dependencies": { + "prr": "~1.0.1" + }, + "bin": { + "errno": "cli.js" + } + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-module-lexer": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.3.0.tgz", + "integrity": "sha512-vZK7T0N2CBmBOixhmjdqx2gWVbFZ4DXZ/NyRMZVlJXPa7CyFS+/a4QQsDGDQy9ZfEzxFuNEsMLeQJnKP2p5/JA==", + "dev": true + }, + "node_modules/esbuild": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.17.19.tgz", + "integrity": "sha512-XQ0jAPFkK/u3LcVRcvVHQcTIqD6E2H1fvZMA5dQPSOWb3suUbWbfbRf94pjc0bNzRYLfIrDRQXr7X+LHIm5oHw==", + "dev": true, + "hasInstallScript": true, + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/android-arm": "0.17.19", + "@esbuild/android-arm64": "0.17.19", + "@esbuild/android-x64": "0.17.19", + "@esbuild/darwin-arm64": "0.17.19", + "@esbuild/darwin-x64": "0.17.19", + "@esbuild/freebsd-arm64": "0.17.19", + "@esbuild/freebsd-x64": "0.17.19", + "@esbuild/linux-arm": "0.17.19", + "@esbuild/linux-arm64": "0.17.19", + "@esbuild/linux-ia32": "0.17.19", + "@esbuild/linux-loong64": "0.17.19", + "@esbuild/linux-mips64el": "0.17.19", + "@esbuild/linux-ppc64": "0.17.19", + "@esbuild/linux-riscv64": "0.17.19", + "@esbuild/linux-s390x": "0.17.19", + "@esbuild/linux-x64": "0.17.19", + "@esbuild/netbsd-x64": "0.17.19", + "@esbuild/openbsd-x64": "0.17.19", + "@esbuild/sunos-x64": "0.17.19", + "@esbuild/win32-arm64": "0.17.19", + "@esbuild/win32-ia32": "0.17.19", + "@esbuild/win32-x64": "0.17.19" + } + }, + "node_modules/esbuild-wasm": { + "version": "0.17.19", + "resolved": "https://registry.npmjs.org/esbuild-wasm/-/esbuild-wasm-0.17.19.tgz", + "integrity": "sha512-X9UQEMJMZXwlGCfqcBmJ1jEa+KrLfd+gCBypO/TSzo5hZvbVwFqpxj1YCuX54ptTF75wxmrgorR4RL40AKtLVg==", + "dev": true, + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/escalade": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", + "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", + "dev": true + }, + "node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse/node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/eventemitter-asyncresource": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/eventemitter-asyncresource/-/eventemitter-asyncresource-1.0.0.tgz", + "integrity": "sha512-39F7TBIV0G7gTelxwbEqnwhp90eqCPON1k0NwNfwhgKn4Co4ybUbj2pECcXT0B3ztRKZ7Pw1JujUUgmQJHcVAQ==", + "dev": true + }, + "node_modules/eventemitter3": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", + "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", + "dev": true + }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "dev": true, + "engines": { + "node": ">=0.8.x" + } + }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dev": true, + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/execa/node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "dev": true + }, + "node_modules/exponential-backoff": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/exponential-backoff/-/exponential-backoff-3.1.1.tgz", + "integrity": "sha512-dX7e/LHVJ6W3DE1MHWi9S1EYzDESENfLrYohG2G++ovZrYOkm4Knwa0mc1cn84xJOR4KEU0WSchhLbd0UklbHw==", + "dev": true + }, + "node_modules/express": { + "version": "4.18.2", + "resolved": "https://registry.npmjs.org/express/-/express-4.18.2.tgz", + "integrity": "sha512-5/PsL6iGPdfQ/lKM1UuielYgv3BUoJfz1aUwU9vHZ+J7gyvwdQXFEBIEIaxeGf0GIcreATNyBExtalisDbuMqQ==", + "dev": true, + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "1.20.1", + "content-disposition": "0.5.4", + "content-type": "~1.0.4", + "cookie": "0.5.0", + "cookie-signature": "1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "1.2.0", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "merge-descriptors": "1.0.1", + "methods": "~1.1.2", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "0.1.7", + "proxy-addr": "~2.0.7", + "qs": "6.11.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "0.18.0", + "serve-static": "1.15.0", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + } + }, + "node_modules/express/node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "dev": true + }, + "node_modules/express/node_modules/body-parser": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.1.tgz", + "integrity": "sha512-jWi7abTbYwajOytWCQc37VulmWiRae5RyTpaCyDcS5/lMdtwSz5lOpDE67srw/HYe35f1z3fDQw+3txg7gNtWw==", + "dev": true, + "dependencies": { + "bytes": "3.1.2", + "content-type": "~1.0.4", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "on-finished": "2.4.1", + "qs": "6.11.0", + "raw-body": "2.5.1", + "type-is": "~1.6.18", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/express/node_modules/cookie": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.5.0.tgz", + "integrity": "sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/express/node_modules/finalhandler": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.2.0.tgz", + "integrity": "sha512-5uXcUVftlQMFnWC9qu/svkWv3GTd2PfUhK/3PLkYNAe7FbqJMt3515HaxE6eRL74GdsriiwujiawdaB1BpEISg==", + "dev": true, + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "statuses": "2.0.1", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/express/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/express/node_modules/raw-body": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.1.tgz", + "integrity": "sha512-qqJBtEyVgS0ZmPGdCFPWJ3FreoqvG4MVQln/kCgF7Olq95IbOp0/BWyMwbdtn4VTvkM8Y7khCQ2Xgk/tcrCXig==", + "dev": true, + "dependencies": { + "bytes": "3.1.2", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/express/node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "dev": true + }, + "node_modules/external-editor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", + "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==", + "dev": true, + "dependencies": { + "chardet": "^0.7.0", + "iconv-lite": "^0.4.24", + "tmp": "^0.0.33" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true + }, + "node_modules/fast-glob": { + "version": "3.2.12", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz", + "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, + "node_modules/fastq": { + "version": "1.15.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz", + "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==", + "dev": true, + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/faye-websocket": { + "version": "0.11.4", + "resolved": "https://registry.npmjs.org/faye-websocket/-/faye-websocket-0.11.4.tgz", + "integrity": "sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g==", + "dev": true, + "dependencies": { + "websocket-driver": ">=0.5.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/figures": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", + "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", + "dev": true, + "dependencies": { + "escape-string-regexp": "^1.0.5" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/finalhandler": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.2.tgz", + "integrity": "sha512-aAWcW57uxVNrQZqFXjITpW3sIUQmHGG3qSb9mUah9MgMC4NeWhNOlNjXEYq3HjRAvL6arUviZGGJsBg6z0zsWA==", + "dev": true, + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "on-finished": "~2.3.0", + "parseurl": "~1.3.3", + "statuses": "~1.5.0", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/finalhandler/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/finalhandler/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/finalhandler/node_modules/on-finished": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", + "integrity": "sha512-ikqdkGAAyf/X/gPhXGvfgAytDZtDbr+bkNUJ0N9h5MI/dmdgCs3l6hoHrcUv41sRKew3jIwrp4qQDXiK99Utww==", + "dev": true, + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/find-cache-dir": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-3.3.2.tgz", + "integrity": "sha512-wXZV5emFEjrridIgED11OoUKLxiYjAcqot/NJdAkOhlJ+vGzwhOAfcG5OX1jP+S0PcjEn8bdMJv+g2jwQ3Onig==", + "dev": true, + "dependencies": { + "commondir": "^1.0.1", + "make-dir": "^3.0.2", + "pkg-dir": "^4.1.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/avajs/find-cache-dir?sponsor=1" + } + }, + "node_modules/find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "dependencies": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/flatted": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.7.tgz", + "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==", + "dev": true + }, + "node_modules/follow-redirects": { + "version": "1.15.2", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", + "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/foreground-child": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz", + "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==", + "dev": true, + "dependencies": { + "cross-spawn": "^7.0.0", + "signal-exit": "^4.0.1" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fraction.js": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/fraction.js/-/fraction.js-4.2.0.tgz", + "integrity": "sha512-MhLuK+2gUcnZe8ZHlaaINnQLl0xRIGRfcGk2yl8xoQAfHrSsL3rYu6FCmBdkdbhc9EPlwyGHewaRsvwRMJtAlA==", + "dev": true, + "engines": { + "node": "*" + }, + "funding": { + "type": "patreon", + "url": "https://www.patreon.com/infusion" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fs-extra": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", + "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/fs-minipass": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-3.0.2.tgz", + "integrity": "sha512-2GAfyfoaCDRrM6jaOS3UsBts8yJ55VioXdWcOL7dK9zdAuKT71+WBA4ifnNYqVjYv+4SsPxjK0JT4yIIn4cA/g==", + "dev": true, + "dependencies": { + "minipass": "^5.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/fs-monkey": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/fs-monkey/-/fs-monkey-1.0.4.tgz", + "integrity": "sha512-INM/fWAxMICjttnD0DX1rBvinKskj5G1w+oy/pnm9u/tSlnBrzFonJMcalKJ30P8RRsPzKcCG7Q8l0jx5Fh9YQ==", + "dev": true + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true + }, + "node_modules/fsevents": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", + "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", + "dev": true, + "hasInstallScript": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "node_modules/gauge": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/gauge/-/gauge-4.0.4.tgz", + "integrity": "sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg==", + "dev": true, + "dependencies": { + "aproba": "^1.0.3 || ^2.0.0", + "color-support": "^1.1.3", + "console-control-strings": "^1.1.0", + "has-unicode": "^2.0.1", + "signal-exit": "^3.0.7", + "string-width": "^4.2.3", + "strip-ansi": "^6.0.1", + "wide-align": "^1.1.5" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" + } + }, + "node_modules/gauge/node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "dev": true + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-intrinsic": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.1.tgz", + "integrity": "sha512-2DcsyfABl+gVHEfCOaTrWgyt+tb6MSEGmKq+kI5HwLbIYgjgmMcV8KQ41uaKz1xxUcn9tJtgFbQUEVcEbd0FYw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-proto": "^1.0.1", + "has-symbols": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-package-type": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", + "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==", + "dev": true, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/glob": { + "version": "10.3.1", + "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.1.tgz", + "integrity": "sha512-9BKYcEeIs7QwlCYs+Y3GBvqAMISufUS0i2ELd11zpZjxI5V9iyRj0HgzB5/cLf2NY4vcYBTYzJ7GIui7j/4DOw==", + "dev": true, + "dependencies": { + "foreground-child": "^3.1.0", + "jackspeak": "^2.0.3", + "minimatch": "^9.0.1", + "minipass": "^5.0.0 || ^6.0.2", + "path-scurry": "^1.10.0" + }, + "bin": { + "glob": "dist/cjs/src/bin.js" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/glob-to-regexp": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", + "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==", + "dev": true + }, + "node_modules/globals": { + "version": "11.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", + "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/globby": { + "version": "13.2.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-13.2.0.tgz", + "integrity": "sha512-jWsQfayf13NvqKUIL3Ta+CIqMnvlaIDFveWE/dpOZ9+3AMEJozsxDvKA02zync9UuvOM8rOXzsD5GqKP4OnWPQ==", + "dev": true, + "dependencies": { + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.11", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true + }, + "node_modules/handle-thing": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/handle-thing/-/handle-thing-2.0.1.tgz", + "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==", + "dev": true + }, + "node_modules/has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/has-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.1.tgz", + "integrity": "sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", + "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-unicode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz", + "integrity": "sha512-8Rf9Y83NBReMnx0gFzA8JImQACstCYWUplepDa9xprwwtmgEZUF0h/i5xSA625zB/I37EtrswSST6OXxwaaIJQ==", + "dev": true + }, + "node_modules/hdr-histogram-js": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/hdr-histogram-js/-/hdr-histogram-js-2.0.3.tgz", + "integrity": "sha512-Hkn78wwzWHNCp2uarhzQ2SGFLU3JY8SBDDd3TAABK4fc30wm+MuPOrg5QVFVfkKOQd6Bfz3ukJEI+q9sXEkK1g==", + "dev": true, + "dependencies": { + "@assemblyscript/loader": "^0.10.1", + "base64-js": "^1.2.0", + "pako": "^1.0.3" + } + }, + "node_modules/hdr-histogram-percentiles-obj": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hdr-histogram-percentiles-obj/-/hdr-histogram-percentiles-obj-3.0.0.tgz", + "integrity": "sha512-7kIufnBqdsBGcSZLPJwqHT3yhk1QTsSlFsVD3kx5ixH/AlgBs9yM1q6DPhXZ8f8gtdqgh7N7/5btRLpQsS2gHw==", + "dev": true + }, + "node_modules/hosted-git-info": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-6.1.1.tgz", + "integrity": "sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w==", + "dev": true, + "dependencies": { + "lru-cache": "^7.5.1" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/hosted-git-info/node_modules/lru-cache": { + "version": "7.18.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", + "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", + "dev": true, + "engines": { + "node": ">=12" + } + }, + "node_modules/hpack.js": { + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/hpack.js/-/hpack.js-2.1.6.tgz", + "integrity": "sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ==", + "dev": true, + "dependencies": { + "inherits": "^2.0.1", + "obuf": "^1.0.0", + "readable-stream": "^2.0.1", + "wbuf": "^1.1.0" + } + }, + "node_modules/hpack.js/node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "dev": true, + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/hpack.js/node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "dev": true + }, + "node_modules/hpack.js/node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, + "node_modules/html-entities": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/html-entities/-/html-entities-2.4.0.tgz", + "integrity": "sha512-igBTJcNNNhvZFRtm8uA6xMY6xYleeDwn3PeBCkDz7tHttv4F2hsDI2aPgNERWzvRcNYHNT3ymRaQzllmXj4YsQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/mdevils" + }, + { + "type": "patreon", + "url": "https://patreon.com/mdevils" + } + ] + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true + }, + "node_modules/htmlparser2": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz", + "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==", + "dev": true, + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1", + "entities": "^4.4.0" + } + }, + "node_modules/http-cache-semantics": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", + "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==", + "dev": true + }, + "node_modules/http-deceiver": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/http-deceiver/-/http-deceiver-1.2.7.tgz", + "integrity": "sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw==", + "dev": true + }, + "node_modules/http-errors": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz", + "integrity": "sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==", + "dev": true, + "dependencies": { + "depd": "2.0.0", + "inherits": "2.0.4", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "toidentifier": "1.0.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/http-errors/node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/http-parser-js": { + "version": "0.5.8", + "resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.5.8.tgz", + "integrity": "sha512-SGeBX54F94Wgu5RH3X5jsDtf4eHyRogWX1XGT3b4HuW3tQPM4AaBzoUji/4AAJNXCEOWZ5O0DgZmJw1947gD5Q==", + "dev": true + }, + "node_modules/http-proxy": { + "version": "1.18.1", + "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz", + "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==", + "dev": true, + "dependencies": { + "eventemitter3": "^4.0.0", + "follow-redirects": "^1.0.0", + "requires-port": "^1.0.0" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/http-proxy-agent": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-5.0.0.tgz", + "integrity": "sha512-n2hY8YdoRE1i7r6M0w9DIw5GgZN0G25P8zLCRQ8rjXtTU3vsNFBI/vWK/UIeE6g5MUUz6avwAPXmL6Fy9D/90w==", + "dev": true, + "dependencies": { + "@tootallnate/once": "2", + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/http-proxy-middleware": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.6.tgz", + "integrity": "sha512-ya/UeJ6HVBYxrgYotAZo1KvPWlgB48kUJLDePFeneHsVujFaW5WNj2NgWCAE//B1Dl02BIfYlpNgBy8Kf8Rjmw==", + "dev": true, + "dependencies": { + "@types/http-proxy": "^1.17.8", + "http-proxy": "^1.18.1", + "is-glob": "^4.0.1", + "is-plain-obj": "^3.0.0", + "micromatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "@types/express": "^4.17.13" + }, + "peerDependenciesMeta": { + "@types/express": { + "optional": true + } + } + }, + "node_modules/https-proxy-agent": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", + "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", + "dev": true, + "dependencies": { + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "dev": true, + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/humanize-ms": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz", + "integrity": "sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ==", + "dev": true, + "dependencies": { + "ms": "^2.0.0" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dev": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/icss-utils": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", + "integrity": "sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA==", + "dev": true, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/ignore": { + "version": "5.2.4", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz", + "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/ignore-walk": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-6.0.3.tgz", + "integrity": "sha512-C7FfFoTA+bI10qfeydT8aZbvr91vAEU+2W5BZUlzPec47oNb07SsOfwYrtxuvOYdUApPP/Qlh4DtAO51Ekk2QA==", + "dev": true, + "dependencies": { + "minimatch": "^9.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/image-size": { + "version": "0.5.5", + "resolved": "https://registry.npmjs.org/image-size/-/image-size-0.5.5.tgz", + "integrity": "sha512-6TDAlDPZxUFCv+fuOkIoXT/V/f3Qbq8e37p+YOiYrUv3v9cc3/6x78VdfPgFVaB9dZYeLUfKgHRebpkm/oP2VQ==", + "dev": true, + "optional": true, + "bin": { + "image-size": "bin/image-size.js" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/immutable": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/immutable/-/immutable-4.3.0.tgz", + "integrity": "sha512-0AOCmOip+xgJwEVTQj1EfiDDOkPmuyllDuTuEX+DDXUgapLAsBIfkg3sxCYyCEA8mQqZrrxPUGjcOQ2JS3WLkg==", + "dev": true + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/import-fresh/node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "node_modules/ini": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.1.tgz", + "integrity": "sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/ip": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ip/-/ip-2.0.0.tgz", + "integrity": "sha512-WKa+XuLG1A1R0UWhl2+1XQSi+fZWMsYKffMZTTYsiZaUD8k2yDAj5atimTUD2TZkyCkNEeYE5NhFZmupOGtjYQ==", + "dev": true + }, + "node_modules/ipaddr.js": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.1.0.tgz", + "integrity": "sha512-LlbxQ7xKzfBusov6UMi4MFpEg0m+mAm9xyNGEduwXMEDuf4WfzB/RZwMVYEd7IKGvh4IUkEXYxtAVu9T3OelJQ==", + "dev": true, + "engines": { + "node": ">= 10" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "dev": true + }, + "node_modules/is-binary-path": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "dev": true, + "dependencies": { + "binary-extensions": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-core-module": { + "version": "2.12.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.12.1.tgz", + "integrity": "sha512-Q4ZuBAe2FUsKtyQJoQHlvP8OvBERxO3jEmy1I7hcRXcJBGGHFh/aJBswbXuS9sgrDH2QUO8ilkwNPHvHMd8clg==", + "dev": true, + "dependencies": { + "has": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-docker": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", + "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==", + "dev": true, + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-interactive": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", + "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-lambda": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-lambda/-/is-lambda-1.0.1.tgz", + "integrity": "sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ==", + "dev": true + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-plain-obj": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz", + "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "dev": true, + "dependencies": { + "isobject": "^3.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-unicode-supported": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", + "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-what": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/is-what/-/is-what-3.14.1.tgz", + "integrity": "sha512-sNxgpk9793nzSs7bA6JQJGeIuRBQhAaNGG77kzYQgMkrID+lS6SlK07K5LaptscDlSaIgH+GPFzf+d75FVxozA==", + "dev": true + }, + "node_modules/is-wsl": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", + "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==", + "dev": true, + "dependencies": { + "is-docker": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "dev": true + }, + "node_modules/isbinaryfile": { + "version": "4.0.10", + "resolved": "https://registry.npmjs.org/isbinaryfile/-/isbinaryfile-4.0.10.tgz", + "integrity": "sha512-iHrqe5shvBUcFbmZq9zOQHBoeOhZJu6RQGrDpBgenUm/Am+F3JM2MgQj+rK3Z601fzrL5gLZWtAPH2OBaSVcyw==", + "dev": true, + "engines": { + "node": ">= 8.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/gjtorikian/" + } + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true + }, + "node_modules/isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/istanbul-lib-coverage": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.0.tgz", + "integrity": "sha512-eOeJ5BHCmHYvQK7xt9GkdHuzuCGS1Y6g9Gvnx3Ym33fz/HpLRYxiS0wHNr+m/MBC8B647Xt608vCDEvhl9c6Mw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-instrument": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.2.1.tgz", + "integrity": "sha512-pzqtp31nLv/XFOzXGuvhCb8qhjmTVo5vjVk19XE4CRlSWz0KoeJ3bw9XsA7nOp9YBf4qHjwBxkDzKcME/J29Yg==", + "dev": true, + "dependencies": { + "@babel/core": "^7.12.3", + "@babel/parser": "^7.14.7", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-coverage": "^3.2.0", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-instrument/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/istanbul-lib-report": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.0.tgz", + "integrity": "sha512-wcdi+uAKzfiGT2abPpKZ0hSU1rGQjUQnLvtY5MpQ7QCTahD3VODhcu4wcfY1YtkGaDD5yuydOLINXsfbus9ROw==", + "dev": true, + "dependencies": { + "istanbul-lib-coverage": "^3.0.0", + "make-dir": "^3.0.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-report/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-report/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-source-maps": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz", + "integrity": "sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw==", + "dev": true, + "dependencies": { + "debug": "^4.1.1", + "istanbul-lib-coverage": "^3.0.0", + "source-map": "^0.6.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-lib-source-maps/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/istanbul-reports": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.5.tgz", + "integrity": "sha512-nUsEMa9pBt/NOHqbcbeJEgqIlY/K7rVWUX6Lql2orY5e9roQOthbR3vtY4zzf2orPELg80fnxxk9zUyPlgwD1w==", + "dev": true, + "dependencies": { + "html-escaper": "^2.0.0", + "istanbul-lib-report": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/jackspeak": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-2.2.1.tgz", + "integrity": "sha512-MXbxovZ/Pm42f6cDIDkl3xpwv1AGwObKwfmjs2nQePiy85tP3fatofl3FC1aBsOtP/6fq5SbtgHwWcMsLP+bDw==", + "dev": true, + "dependencies": { + "@isaacs/cliui": "^8.0.2" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + }, + "optionalDependencies": { + "@pkgjs/parseargs": "^0.11.0" + } + }, + "node_modules/jasmine-core": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/jasmine-core/-/jasmine-core-4.6.0.tgz", + "integrity": "sha512-O236+gd0ZXS8YAjFx8xKaJ94/erqUliEkJTDedyE7iHvv4ZVqi+q+8acJxu05/WJDKm512EUNn809In37nWlAQ==", + "dev": true + }, + "node_modules/jest-worker": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", + "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", + "dev": true, + "dependencies": { + "@types/node": "*", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/jest-worker/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/jest-worker/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/jiti": { + "version": "1.18.2", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.18.2.tgz", + "integrity": "sha512-QAdOptna2NYiSSpv0O/BwoHBSmz4YhpzJHyi+fnMRTXFjp7B8i/YG5Z8IfusxB1ufjcD2Sre1F3R+nX3fvy7gg==", + "dev": true, + "bin": { + "jiti": "bin/jiti.js" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsesc": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", + "integrity": "sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==", + "dev": true, + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "dev": true, + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonc-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", + "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", + "dev": true + }, + "node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/jsonparse": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/jsonparse/-/jsonparse-1.3.1.tgz", + "integrity": "sha512-POQXvpdL69+CluYsillJ7SUhKvytYjW9vG/GKpnf+xP8UWgYEM/RaMzHHofbALDiKbbP1W8UEYmgGl39WkPZsg==", + "dev": true, + "engines": [ + "node >= 0.2.0" + ] + }, + "node_modules/karma": { + "version": "6.4.2", + "resolved": "https://registry.npmjs.org/karma/-/karma-6.4.2.tgz", + "integrity": "sha512-C6SU/53LB31BEgRg+omznBEMY4SjHU3ricV6zBcAe1EeILKkeScr+fZXtaI5WyDbkVowJxxAI6h73NcFPmXolQ==", + "dev": true, + "dependencies": { + "@colors/colors": "1.5.0", + "body-parser": "^1.19.0", + "braces": "^3.0.2", + "chokidar": "^3.5.1", + "connect": "^3.7.0", + "di": "^0.0.1", + "dom-serialize": "^2.2.1", + "glob": "^7.1.7", + "graceful-fs": "^4.2.6", + "http-proxy": "^1.18.1", + "isbinaryfile": "^4.0.8", + "lodash": "^4.17.21", + "log4js": "^6.4.1", + "mime": "^2.5.2", + "minimatch": "^3.0.4", + "mkdirp": "^0.5.5", + "qjobs": "^1.2.0", + "range-parser": "^1.2.1", + "rimraf": "^3.0.2", + "socket.io": "^4.4.1", + "source-map": "^0.6.1", + "tmp": "^0.2.1", + "ua-parser-js": "^0.7.30", + "yargs": "^16.1.1" + }, + "bin": { + "karma": "bin/karma" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/karma-chrome-launcher": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/karma-chrome-launcher/-/karma-chrome-launcher-3.2.0.tgz", + "integrity": "sha512-rE9RkUPI7I9mAxByQWkGJFXfFD6lE4gC5nPuZdobf/QdTEJI6EU4yIay/cfU/xV4ZxlM5JiTv7zWYgA64NpS5Q==", + "dev": true, + "dependencies": { + "which": "^1.2.1" + } + }, + "node_modules/karma-chrome-launcher/node_modules/which": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", + "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "which": "bin/which" + } + }, + "node_modules/karma-coverage": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/karma-coverage/-/karma-coverage-2.2.1.tgz", + "integrity": "sha512-yj7hbequkQP2qOSb20GuNSIyE//PgJWHwC2IydLE6XRtsnaflv+/OSGNssPjobYUlhVVagy99TQpqUt3vAUG7A==", + "dev": true, + "dependencies": { + "istanbul-lib-coverage": "^3.2.0", + "istanbul-lib-instrument": "^5.1.0", + "istanbul-lib-report": "^3.0.0", + "istanbul-lib-source-maps": "^4.0.1", + "istanbul-reports": "^3.0.5", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/karma-coverage/node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/karma-coverage/node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/karma-jasmine": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/karma-jasmine/-/karma-jasmine-5.1.0.tgz", + "integrity": "sha512-i/zQLFrfEpRyQoJF9fsCdTMOF5c2dK7C7OmsuKg2D0YSsuZSfQDiLuaiktbuio6F2wiCsZSnSnieIQ0ant/uzQ==", + "dev": true, + "dependencies": { + "jasmine-core": "^4.1.0" + }, + "engines": { + "node": ">=12" + }, + "peerDependencies": { + "karma": "^6.0.0" + } + }, + "node_modules/karma-jasmine-html-reporter": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/karma-jasmine-html-reporter/-/karma-jasmine-html-reporter-2.1.0.tgz", + "integrity": "sha512-sPQE1+nlsn6Hwb5t+HHwyy0A1FNCVKuL1192b+XNauMYWThz2kweiBVW1DqloRpVvZIJkIoHVB7XRpK78n1xbQ==", + "dev": true, + "peerDependencies": { + "jasmine-core": "^4.0.0 || ^5.0.0", + "karma": "^6.0.0", + "karma-jasmine": "^5.0.0" + } + }, + "node_modules/karma-source-map-support": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/karma-source-map-support/-/karma-source-map-support-1.4.0.tgz", + "integrity": "sha512-RsBECncGO17KAoJCYXjv+ckIz+Ii9NCi+9enk+rq6XC81ezYkb4/RHE6CTXdA7IOJqoF3wcaLfVG0CPmE5ca6A==", + "dev": true, + "dependencies": { + "source-map-support": "^0.5.5" + } + }, + "node_modules/karma/node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/karma/node_modules/cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", + "dev": true, + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, + "node_modules/karma/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/karma/node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/karma/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/karma/node_modules/tmp": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.1.tgz", + "integrity": "sha512-76SUhtfqR2Ijn+xllcI5P1oyannHNHByD80W1q447gU3mp9G9PSpGdWmjUOHRDPiHYacIk66W7ubDTuPF3BEtQ==", + "dev": true, + "dependencies": { + "rimraf": "^3.0.0" + }, + "engines": { + "node": ">=8.17.0" + } + }, + "node_modules/karma/node_modules/yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", + "dev": true, + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/karma/node_modules/yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/kind-of": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/klona": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/klona/-/klona-2.0.6.tgz", + "integrity": "sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/launch-editor": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/launch-editor/-/launch-editor-2.6.0.tgz", + "integrity": "sha512-JpDCcQnyAAzZZaZ7vEiSqL690w7dAEyLao+KC96zBplnYbJS7TYNjvM3M7y3dGz+v7aIsJk3hllWuc0kWAjyRQ==", + "dev": true, + "dependencies": { + "picocolors": "^1.0.0", + "shell-quote": "^1.7.3" + } + }, + "node_modules/less": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/less/-/less-4.1.3.tgz", + "integrity": "sha512-w16Xk/Ta9Hhyei0Gpz9m7VS8F28nieJaL/VyShID7cYvP6IL5oHeL6p4TXSDJqZE/lNv0oJ2pGVjJsRkfwm5FA==", + "dev": true, + "dependencies": { + "copy-anything": "^2.0.1", + "parse-node-version": "^1.0.1", + "tslib": "^2.3.0" + }, + "bin": { + "lessc": "bin/lessc" + }, + "engines": { + "node": ">=6" + }, + "optionalDependencies": { + "errno": "^0.1.1", + "graceful-fs": "^4.1.2", + "image-size": "~0.5.0", + "make-dir": "^2.1.0", + "mime": "^1.4.1", + "needle": "^3.1.0", + "source-map": "~0.6.0" + } + }, + "node_modules/less-loader": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/less-loader/-/less-loader-11.1.0.tgz", + "integrity": "sha512-C+uDBV7kS7W5fJlUjq5mPBeBVhYpTIm5gB09APT9o3n/ILeaXVsiSFTbZpTJCJwQ/Crczfn3DmfQFwxYusWFug==", + "dev": true, + "dependencies": { + "klona": "^2.0.4" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "less": "^3.5.0 || ^4.0.0", + "webpack": "^5.0.0" + } + }, + "node_modules/less/node_modules/make-dir": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz", + "integrity": "sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA==", + "dev": true, + "optional": true, + "dependencies": { + "pify": "^4.0.1", + "semver": "^5.6.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/less/node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "dev": true, + "optional": true, + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/less/node_modules/semver": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", + "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "dev": true, + "optional": true, + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/less/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "optional": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/license-webpack-plugin": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/license-webpack-plugin/-/license-webpack-plugin-4.0.2.tgz", + "integrity": "sha512-771TFWFD70G1wLTC4oU2Cw4qvtmNrIw+wRvBtn+okgHl7slJVi7zfNcdmqDL72BojM30VNJ2UHylr1o77U37Jw==", + "dev": true, + "dependencies": { + "webpack-sources": "^3.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + }, + "webpack-sources": { + "optional": true + } + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "dev": true + }, + "node_modules/loader-runner": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.0.tgz", + "integrity": "sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg==", + "dev": true, + "engines": { + "node": ">=6.11.5" + } + }, + "node_modules/loader-utils": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-3.2.1.tgz", + "integrity": "sha512-ZvFw1KWS3GVyYBYb7qkmRM/WwL2TQQBxgCK62rlvm4WpVQ23Nb4tYjApUlfjrEGvOs7KHEsmyUn75OHZrJMWPw==", + "dev": true, + "engines": { + "node": ">= 12.13.0" + } + }, + "node_modules/locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "dependencies": { + "p-locate": "^4.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "node_modules/lodash.debounce": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", + "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", + "dev": true + }, + "node_modules/log-symbols": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", + "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==", + "dev": true, + "dependencies": { + "chalk": "^4.1.0", + "is-unicode-supported": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/log-symbols/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/log-symbols/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/log-symbols/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/log-symbols/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/log-symbols/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/log-symbols/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/log4js": { + "version": "6.9.1", + "resolved": "https://registry.npmjs.org/log4js/-/log4js-6.9.1.tgz", + "integrity": "sha512-1somDdy9sChrr9/f4UlzhdaGfDR2c/SaD2a4T7qEkG4jTS57/B3qmnjLYePwQ8cqWnUHZI0iAKxMBpCZICiZ2g==", + "dev": true, + "dependencies": { + "date-format": "^4.0.14", + "debug": "^4.3.4", + "flatted": "^3.2.7", + "rfdc": "^1.3.0", + "streamroller": "^3.1.5" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/magic-string": { + "version": "0.30.0", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.0.tgz", + "integrity": "sha512-LA+31JYDJLs82r2ScLrlz1GjSgu66ZV518eyWT+S8VhyQn/JL0u9MeBOvQMGYiPk1DBiSN9DDMOcXvigJZaViQ==", + "dev": true, + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.4.13" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/make-dir": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", + "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", + "dev": true, + "dependencies": { + "semver": "^6.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/make-dir/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/make-fetch-happen": { + "version": "11.1.1", + "resolved": "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-11.1.1.tgz", + "integrity": "sha512-rLWS7GCSTcEujjVBs2YqG7Y4643u8ucvCJeSRqiLYhesrDuzeuFIk37xREzAsfQaqzl8b9rNCE4m6J8tvX4Q8w==", + "dev": true, + "dependencies": { + "agentkeepalive": "^4.2.1", + "cacache": "^17.0.0", + "http-cache-semantics": "^4.1.1", + "http-proxy-agent": "^5.0.0", + "https-proxy-agent": "^5.0.0", + "is-lambda": "^1.0.1", + "lru-cache": "^7.7.1", + "minipass": "^5.0.0", + "minipass-fetch": "^3.0.0", + "minipass-flush": "^1.0.5", + "minipass-pipeline": "^1.2.4", + "negotiator": "^0.6.3", + "promise-retry": "^2.0.1", + "socks-proxy-agent": "^7.0.0", + "ssri": "^10.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/make-fetch-happen/node_modules/lru-cache": { + "version": "7.18.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", + "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", + "dev": true, + "engines": { + "node": ">=12" + } + }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/memfs": { + "version": "3.5.3", + "resolved": "https://registry.npmjs.org/memfs/-/memfs-3.5.3.tgz", + "integrity": "sha512-UERzLsxzllchadvbPs5aolHh65ISpKpM+ccLbOJ8/vvpBKmAWf+la7dXFy7Mr0ySHbdHrFv5kGFCUHHe6GFEmw==", + "dev": true, + "dependencies": { + "fs-monkey": "^1.0.4" + }, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", + "integrity": "sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w==", + "dev": true + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/micromatch": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", + "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "dev": true, + "dependencies": { + "braces": "^3.0.2", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-2.6.0.tgz", + "integrity": "sha512-USPkMeET31rOMiarsBNIHZKLGgvKc/LrjofAnBlOttf5ajRvqiRA8QsenbcooctK6d6Ts6aqZXBA+XbkKthiQg==", + "dev": true, + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dev": true, + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/mini-css-extract-plugin": { + "version": "2.7.6", + "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.7.6.tgz", + "integrity": "sha512-Qk7HcgaPkGG6eD77mLvZS1nmxlao3j+9PkrT9Uc7HAE1id3F41+DdBRYRYkbyfNRGzm8/YWtzhw7nVPmwhqTQw==", + "dev": true, + "dependencies": { + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + } + }, + "node_modules/minimalistic-assert": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", + "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==", + "dev": true + }, + "node_modules/minimatch": { + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.2.tgz", + "integrity": "sha512-PZOT9g5v2ojiTL7r1xF6plNHLtOeTpSlDI007As2NlA2aYBMfVom17yqa6QzhmDP8QOhn7LjHTg7DFCVSSa6yg==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/minipass": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", + "integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-collect": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/minipass-collect/-/minipass-collect-1.0.2.tgz", + "integrity": "sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA==", + "dev": true, + "dependencies": { + "minipass": "^3.0.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/minipass-collect/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-collect/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/minipass-fetch": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/minipass-fetch/-/minipass-fetch-3.0.3.tgz", + "integrity": "sha512-n5ITsTkDqYkYJZjcRWzZt9qnZKCT7nKCosJhHoj7S7zD+BP4jVbWs+odsniw5TA3E0sLomhTKOKjF86wf11PuQ==", + "dev": true, + "dependencies": { + "minipass": "^5.0.0", + "minipass-sized": "^1.0.3", + "minizlib": "^2.1.2" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + }, + "optionalDependencies": { + "encoding": "^0.1.13" + } + }, + "node_modules/minipass-flush": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/minipass-flush/-/minipass-flush-1.0.5.tgz", + "integrity": "sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw==", + "dev": true, + "dependencies": { + "minipass": "^3.0.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/minipass-flush/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-flush/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/minipass-json-stream": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/minipass-json-stream/-/minipass-json-stream-1.0.1.tgz", + "integrity": "sha512-ODqY18UZt/I8k+b7rl2AENgbWE8IDYam+undIJONvigAz8KR5GWblsFTEfQs0WODsjbSXWlm+JHEv8Gr6Tfdbg==", + "dev": true, + "dependencies": { + "jsonparse": "^1.3.1", + "minipass": "^3.0.0" + } + }, + "node_modules/minipass-json-stream/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-json-stream/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/minipass-pipeline": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz", + "integrity": "sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==", + "dev": true, + "dependencies": { + "minipass": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-pipeline/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-pipeline/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/minipass-sized": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/minipass-sized/-/minipass-sized-1.0.3.tgz", + "integrity": "sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g==", + "dev": true, + "dependencies": { + "minipass": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-sized/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minipass-sized/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/minizlib": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz", + "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==", + "dev": true, + "dependencies": { + "minipass": "^3.0.0", + "yallist": "^4.0.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/minizlib/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/minizlib/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/mkdirp": { + "version": "0.5.6", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz", + "integrity": "sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==", + "dev": true, + "dependencies": { + "minimist": "^1.2.6" + }, + "bin": { + "mkdirp": "bin/cmd.js" + } + }, + "node_modules/mrmime": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-1.0.1.tgz", + "integrity": "sha512-hzzEagAgDyoU1Q6yg5uI+AorQgdvMCur3FcKf7NhMKWsaYg+RnbTyHRa/9IlLF9rf455MOCtcqqrQQ83pPP7Uw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/multicast-dns": { + "version": "7.2.5", + "resolved": "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz", + "integrity": "sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==", + "dev": true, + "dependencies": { + "dns-packet": "^5.2.2", + "thunky": "^1.0.2" + }, + "bin": { + "multicast-dns": "cli.js" + } + }, + "node_modules/nanoid": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", + "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/needle": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/needle/-/needle-3.2.0.tgz", + "integrity": "sha512-oUvzXnyLiVyVGoianLijF9O/RecZUf7TkBfimjGrLM4eQhXyeJwM6GeAWccwfQ9aa4gMCZKqhAOuLaMIcQxajQ==", + "dev": true, + "optional": true, + "dependencies": { + "debug": "^3.2.6", + "iconv-lite": "^0.6.3", + "sax": "^1.2.4" + }, + "bin": { + "needle": "bin/needle" + }, + "engines": { + "node": ">= 4.4.x" + } + }, + "node_modules/needle/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "optional": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/needle/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "dev": true, + "optional": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/negotiator": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "dev": true + }, + "node_modules/nice-napi": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/nice-napi/-/nice-napi-1.0.2.tgz", + "integrity": "sha512-px/KnJAJZf5RuBGcfD+Sp2pAKq0ytz8j+1NehvgIGFkvtvFrDM3T8E4x/JJODXK9WZow8RRGrbA9QQ3hs+pDhA==", + "dev": true, + "hasInstallScript": true, + "optional": true, + "os": [ + "!win32" + ], + "dependencies": { + "node-addon-api": "^3.0.0", + "node-gyp-build": "^4.2.2" + } + }, + "node_modules/node-addon-api": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-3.2.1.tgz", + "integrity": "sha512-mmcei9JghVNDYydghQmeDX8KoAm0FAiYyIcUt/N4nhyAipB17pllZQDOJD2fotxABnt4Mdz+dKTO7eftLg4d0A==", + "dev": true, + "optional": true + }, + "node_modules/node-forge": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.3.1.tgz", + "integrity": "sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA==", + "dev": true, + "engines": { + "node": ">= 6.13.0" + } + }, + "node_modules/node-gyp": { + "version": "9.4.0", + "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-9.4.0.tgz", + "integrity": "sha512-dMXsYP6gc9rRbejLXmTbVRYjAHw7ppswsKyMxuxJxxOHzluIO1rGp9TOQgjFJ+2MCqcOcQTOPB/8Xwhr+7s4Eg==", + "dev": true, + "dependencies": { + "env-paths": "^2.2.0", + "exponential-backoff": "^3.1.1", + "glob": "^7.1.4", + "graceful-fs": "^4.2.6", + "make-fetch-happen": "^11.0.3", + "nopt": "^6.0.0", + "npmlog": "^6.0.0", + "rimraf": "^3.0.2", + "semver": "^7.3.5", + "tar": "^6.1.2", + "which": "^2.0.2" + }, + "bin": { + "node-gyp": "bin/node-gyp.js" + }, + "engines": { + "node": "^12.13 || ^14.13 || >=16" + } + }, + "node_modules/node-gyp-build": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-4.6.0.tgz", + "integrity": "sha512-NTZVKn9IylLwUzaKjkas1e4u2DLNcV4rdYagA4PWdPwW87Bi7z+BznyKSRwS/761tV/lzCGXplWsiaMjLqP2zQ==", + "dev": true, + "optional": true, + "bin": { + "node-gyp-build": "bin.js", + "node-gyp-build-optional": "optional.js", + "node-gyp-build-test": "build-test.js" + } + }, + "node_modules/node-gyp/node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/node-gyp/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/node-gyp/node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/node-releases": { + "version": "2.0.12", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.12.tgz", + "integrity": "sha512-QzsYKWhXTWx8h1kIvqfnC++o0pEmpRQA/aenALsL2F4pqNVr7YzcdMlDij5WBnwftRbJCNJL/O7zdKaxKPHqgQ==", + "dev": true + }, + "node_modules/nopt": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/nopt/-/nopt-6.0.0.tgz", + "integrity": "sha512-ZwLpbTgdhuZUnZzjd7nb1ZV+4DoiC6/sfiVKok72ym/4Tlf+DFdlHYmT2JPmcNNWV6Pi3SDf1kT+A4r9RTuT9g==", + "dev": true, + "dependencies": { + "abbrev": "^1.0.0" + }, + "bin": { + "nopt": "bin/nopt.js" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" + } + }, + "node_modules/normalize-package-data": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-5.0.0.tgz", + "integrity": "sha512-h9iPVIfrVZ9wVYQnxFgtw1ugSvGEMOlyPWWtm8BMJhnwyEL/FLbYbTY3V3PpjI/BUK67n9PEWDu6eHzu1fB15Q==", + "dev": true, + "dependencies": { + "hosted-git-info": "^6.0.0", + "is-core-module": "^2.8.1", + "semver": "^7.3.5", + "validate-npm-package-license": "^3.0.4" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/normalize-range": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/normalize-range/-/normalize-range-0.1.2.tgz", + "integrity": "sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/npm-bundled": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/npm-bundled/-/npm-bundled-3.0.0.tgz", + "integrity": "sha512-Vq0eyEQy+elFpzsKjMss9kxqb9tG3YHg4dsyWuUENuzvSUWe1TCnW/vV9FkhvBk/brEDoDiVd+M1Btosa6ImdQ==", + "dev": true, + "dependencies": { + "npm-normalize-package-bin": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/npm-install-checks": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/npm-install-checks/-/npm-install-checks-6.1.1.tgz", + "integrity": "sha512-dH3GmQL4vsPtld59cOn8uY0iOqRmqKvV+DLGwNXV/Q7MDgD2QfOADWd/mFXcIE5LVhYYGjA3baz6W9JneqnuCw==", + "dev": true, + "dependencies": { + "semver": "^7.1.1" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/npm-normalize-package-bin": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/npm-normalize-package-bin/-/npm-normalize-package-bin-3.0.1.tgz", + "integrity": "sha512-dMxCf+zZ+3zeQZXKxmyuCKlIDPGuv8EF940xbkC4kQVDTtqoh6rJFO+JTKSA6/Rwi0getWmtuy4Itup0AMcaDQ==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/npm-package-arg": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-10.1.0.tgz", + "integrity": "sha512-uFyyCEmgBfZTtrKk/5xDfHp6+MdrqGotX/VoOyEEl3mBwiEE5FlBaePanazJSVMPT7vKepcjYBY2ztg9A3yPIA==", + "dev": true, + "dependencies": { + "hosted-git-info": "^6.0.0", + "proc-log": "^3.0.0", + "semver": "^7.3.5", + "validate-npm-package-name": "^5.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/npm-packlist": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/npm-packlist/-/npm-packlist-7.0.4.tgz", + "integrity": "sha512-d6RGEuRrNS5/N84iglPivjaJPxhDbZmlbTwTDX2IbcRHG5bZCdtysYMhwiPvcF4GisXHGn7xsxv+GQ7T/02M5Q==", + "dev": true, + "dependencies": { + "ignore-walk": "^6.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/npm-pick-manifest": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/npm-pick-manifest/-/npm-pick-manifest-8.0.1.tgz", + "integrity": "sha512-mRtvlBjTsJvfCCdmPtiu2bdlx8d/KXtF7yNXNWe7G0Z36qWA9Ny5zXsI2PfBZEv7SXgoxTmNaTzGSbbzDZChoA==", + "dev": true, + "dependencies": { + "npm-install-checks": "^6.0.0", + "npm-normalize-package-bin": "^3.0.0", + "npm-package-arg": "^10.0.0", + "semver": "^7.3.5" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/npm-registry-fetch": { + "version": "14.0.5", + "resolved": "https://registry.npmjs.org/npm-registry-fetch/-/npm-registry-fetch-14.0.5.tgz", + "integrity": "sha512-kIDMIo4aBm6xg7jOttupWZamsZRkAqMqwqqbVXnUqstY5+tapvv6bkH/qMR76jdgV+YljEUCyWx3hRYMrJiAgA==", + "dev": true, + "dependencies": { + "make-fetch-happen": "^11.0.0", + "minipass": "^5.0.0", + "minipass-fetch": "^3.0.0", + "minipass-json-stream": "^1.0.1", + "minizlib": "^2.1.2", + "npm-package-arg": "^10.0.0", + "proc-log": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/npmlog": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-6.0.2.tgz", + "integrity": "sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg==", + "dev": true, + "dependencies": { + "are-we-there-yet": "^3.0.0", + "console-control-strings": "^1.1.0", + "gauge": "^4.0.3", + "set-blocking": "^2.0.0" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" + } + }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "dev": true, + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.12.3", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.3.tgz", + "integrity": "sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/obuf": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/obuf/-/obuf-1.1.2.tgz", + "integrity": "sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg==", + "dev": true + }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "dev": true, + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/on-headers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.0.2.tgz", + "integrity": "sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dev": true, + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/open": { + "version": "8.4.2", + "resolved": "https://registry.npmjs.org/open/-/open-8.4.2.tgz", + "integrity": "sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==", + "dev": true, + "dependencies": { + "define-lazy-prop": "^2.0.0", + "is-docker": "^2.1.1", + "is-wsl": "^2.2.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ora": { + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", + "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", + "dev": true, + "dependencies": { + "bl": "^4.1.0", + "chalk": "^4.1.0", + "cli-cursor": "^3.1.0", + "cli-spinners": "^2.5.0", + "is-interactive": "^1.0.0", + "is-unicode-supported": "^0.1.0", + "log-symbols": "^4.1.0", + "strip-ansi": "^6.0.0", + "wcwidth": "^1.0.1" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ora/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/ora/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/ora/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/ora/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/ora/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/ora/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/os-tmpdir": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", + "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "dependencies": { + "p-limit": "^2.2.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/p-map": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", + "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", + "dev": true, + "dependencies": { + "aggregate-error": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-retry": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/p-retry/-/p-retry-4.6.2.tgz", + "integrity": "sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ==", + "dev": true, + "dependencies": { + "@types/retry": "0.12.0", + "retry": "^0.13.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/p-retry/node_modules/retry": { + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", + "integrity": "sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/pacote": { + "version": "15.2.0", + "resolved": "https://registry.npmjs.org/pacote/-/pacote-15.2.0.tgz", + "integrity": "sha512-rJVZeIwHTUta23sIZgEIM62WYwbmGbThdbnkt81ravBplQv+HjyroqnLRNH2+sLJHcGZmLRmhPwACqhfTcOmnA==", + "dev": true, + "dependencies": { + "@npmcli/git": "^4.0.0", + "@npmcli/installed-package-contents": "^2.0.1", + "@npmcli/promise-spawn": "^6.0.1", + "@npmcli/run-script": "^6.0.0", + "cacache": "^17.0.0", + "fs-minipass": "^3.0.0", + "minipass": "^5.0.0", + "npm-package-arg": "^10.0.0", + "npm-packlist": "^7.0.0", + "npm-pick-manifest": "^8.0.0", + "npm-registry-fetch": "^14.0.0", + "proc-log": "^3.0.0", + "promise-retry": "^2.0.1", + "read-package-json": "^6.0.0", + "read-package-json-fast": "^3.0.0", + "sigstore": "^1.3.0", + "ssri": "^10.0.0", + "tar": "^6.1.11" + }, + "bin": { + "pacote": "lib/bin.js" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/pako": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz", + "integrity": "sha512-4hLB8Py4zZce5s4yd9XzopqwVv/yGNhV1Bl8NTmCq1763HeK2+EwVTv+leGeL13Dnh2wfbqowVPXCIO0z4taYw==", + "dev": true + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dev": true, + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse-node-version": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parse-node-version/-/parse-node-version-1.0.1.tgz", + "integrity": "sha512-3YHlOa/JgH6Mnpr05jP9eDG254US9ek25LyIxZlDItp2iJtwyaXQb57lBYLdT3MowkUFYEV2XXNAYIPlESvJlA==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/parse5": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.1.2.tgz", + "integrity": "sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw==", + "devOptional": true, + "dependencies": { + "entities": "^4.4.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-html-rewriting-stream": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse5-html-rewriting-stream/-/parse5-html-rewriting-stream-7.0.0.tgz", + "integrity": "sha512-mazCyGWkmCRWDI15Zp+UiCqMp/0dgEmkZRvhlsqqKYr4SsVm/TvnSpD9fCvqCA2zoWJcfRym846ejWBBHRiYEg==", + "dev": true, + "dependencies": { + "entities": "^4.3.0", + "parse5": "^7.0.0", + "parse5-sax-parser": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-sax-parser": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse5-sax-parser/-/parse5-sax-parser-7.0.0.tgz", + "integrity": "sha512-5A+v2SNsq8T6/mG3ahcz8ZtQ0OUFTatxPbeidoMB7tkJSGDY3tdfl4MHovtLQHkEn5CGxijNWRQHhRQ6IRpXKg==", + "dev": true, + "dependencies": { + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true + }, + "node_modules/path-scurry": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.0.tgz", + "integrity": "sha512-tZFEaRQbMLjwrsmidsGJ6wDMv0iazJWk6SfIKnY4Xru8auXgmJkOBa5DUbYFcFD2Rzk2+KDlIiF0GVXNCbgC7g==", + "dev": true, + "dependencies": { + "lru-cache": "^9.1.1 || ^10.0.0", + "minipass": "^5.0.0 || ^6.0.2" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/path-scurry/node_modules/lru-cache": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.0.0.tgz", + "integrity": "sha512-svTf/fzsKHffP42sujkO/Rjs37BCIsQVRCeNYIm9WN8rgT7ffoUnRtZCqU+6BqcSBdv8gwJeTz8knJpgACeQMw==", + "dev": true, + "engines": { + "node": "14 || >=16.14" + } + }, + "node_modules/path-to-regexp": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.7.tgz", + "integrity": "sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==", + "dev": true + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/picocolors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", + "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", + "dev": true + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pify": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", + "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", + "dev": true, + "optional": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/piscina": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/piscina/-/piscina-3.2.0.tgz", + "integrity": "sha512-yn/jMdHRw+q2ZJhFhyqsmANcbF6V2QwmD84c6xRau+QpQOmtrBCoRGdvTfeuFDYXB5W2m6MfLkjkvQa9lUSmIA==", + "dev": true, + "dependencies": { + "eventemitter-asyncresource": "^1.0.0", + "hdr-histogram-js": "^2.0.1", + "hdr-histogram-percentiles-obj": "^3.0.0" + }, + "optionalDependencies": { + "nice-napi": "^1.0.2" + } + }, + "node_modules/pkg-dir": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", + "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", + "dev": true, + "dependencies": { + "find-up": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/postcss": { + "version": "8.4.24", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.24.tgz", + "integrity": "sha512-M0RzbcI0sO/XJNucsGjvWU9ERWxb/ytp1w6dKtxTKgixdtQDq4rmx/g8W1hnaheq9jgwL/oyEdH5Bc4WwJKMqg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "nanoid": "^3.3.6", + "picocolors": "^1.0.0", + "source-map-js": "^1.0.2" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postcss-loader": { + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/postcss-loader/-/postcss-loader-7.3.2.tgz", + "integrity": "sha512-c7qDlXErX6n0VT+LUsW+nwefVtTu3ORtVvK8EXuUIDcxo+b/euYqpuHlJAvePb0Af5e8uMjR/13e0lTuYifaig==", + "dev": true, + "dependencies": { + "cosmiconfig": "^8.1.3", + "jiti": "^1.18.2", + "klona": "^2.0.6", + "semver": "^7.3.8" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "postcss": "^7.0.0 || ^8.0.1", + "webpack": "^5.0.0" + } + }, + "node_modules/postcss-modules-extract-imports": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.0.0.tgz", + "integrity": "sha512-bdHleFnP3kZ4NYDhuGlVK+CMrQ/pqUm8bx/oGL93K6gVwiclvX5x0n76fYMKuIGKzlABOy13zsvqjb0f92TEXw==", + "dev": true, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-local-by-default": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.0.3.tgz", + "integrity": "sha512-2/u2zraspoACtrbFRnTijMiQtb4GW4BvatjaG/bCjYQo8kLTdevCUlwuBHx2sCnSyrI3x3qj4ZK1j5LQBgzmwA==", + "dev": true, + "dependencies": { + "icss-utils": "^5.0.0", + "postcss-selector-parser": "^6.0.2", + "postcss-value-parser": "^4.1.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-scope": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/postcss-modules-scope/-/postcss-modules-scope-3.0.0.tgz", + "integrity": "sha512-hncihwFA2yPath8oZ15PZqvWGkWf+XUfQgUGamS4LqoP1anQLOsOJw0vr7J7IwLpoY9fatA2qiGUGmuZL0Iqlg==", + "dev": true, + "dependencies": { + "postcss-selector-parser": "^6.0.4" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-values": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz", + "integrity": "sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ==", + "dev": true, + "dependencies": { + "icss-utils": "^5.0.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-selector-parser": { + "version": "6.0.13", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.0.13.tgz", + "integrity": "sha512-EaV1Gl4mUEV4ddhDnv/xtj7sxwrwxdetHdWUGnT4VJQf+4d05v6lHYZr8N573k5Z0BViss7BDhfWtKS3+sfAqQ==", + "dev": true, + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-value-parser": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz", + "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==", + "dev": true + }, + "node_modules/pretty-bytes": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", + "integrity": "sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg==", + "dev": true, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/proc-log": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-3.0.0.tgz", + "integrity": "sha512-++Vn7NS4Xf9NacaU9Xq3URUuqZETPsf8L4j5/ckhaRYsfPeRyzGw+iDjFhV/Jr3uNmTvvddEJFWh5R1gRgUH8A==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/process-nextick-args": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", + "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", + "dev": true + }, + "node_modules/promise-inflight": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz", + "integrity": "sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==", + "dev": true + }, + "node_modules/promise-retry": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", + "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==", + "dev": true, + "dependencies": { + "err-code": "^2.0.2", + "retry": "^0.12.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/proxy-addr": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", + "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", + "dev": true, + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/proxy-addr/node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/prr": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/prr/-/prr-1.0.1.tgz", + "integrity": "sha512-yPw4Sng1gWghHQWj0B3ZggWUm4qVbPwPFcRG8KyxiU7J2OHFSoEHKS+EZ3fv5l1t9CyCiop6l/ZYeWbrgoQejw==", + "dev": true, + "optional": true + }, + "node_modules/punycode": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.0.tgz", + "integrity": "sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/qjobs": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/qjobs/-/qjobs-1.2.0.tgz", + "integrity": "sha512-8YOJEHtxpySA3fFDyCRxA+UUV+fA+rTWnuWvylOK/NCjhY+b4ocCtmu8TtsWb+mYeU+GCHf/S66KZF/AsteKHg==", + "dev": true, + "engines": { + "node": ">=0.9" + } + }, + "node_modules/qs": { + "version": "6.11.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.0.tgz", + "integrity": "sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q==", + "dev": true, + "dependencies": { + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/randombytes": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", + "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", + "dev": true, + "dependencies": { + "safe-buffer": "^5.1.0" + } + }, + "node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.2.tgz", + "integrity": "sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==", + "dev": true, + "dependencies": { + "bytes": "3.1.2", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/read-package-json": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/read-package-json/-/read-package-json-6.0.4.tgz", + "integrity": "sha512-AEtWXYfopBj2z5N5PbkAOeNHRPUg5q+Nen7QLxV8M2zJq1ym6/lCz3fYNTCXe19puu2d06jfHhrP7v/S2PtMMw==", + "dev": true, + "dependencies": { + "glob": "^10.2.2", + "json-parse-even-better-errors": "^3.0.0", + "normalize-package-data": "^5.0.0", + "npm-normalize-package-bin": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/read-package-json-fast": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/read-package-json-fast/-/read-package-json-fast-3.0.2.tgz", + "integrity": "sha512-0J+Msgym3vrLOUB3hzQCuZHII0xkNGCtz/HJH9xZshwv9DbDwkw1KaE3gx/e2J5rpEY5rtOy6cyhKOPrkP7FZw==", + "dev": true, + "dependencies": { + "json-parse-even-better-errors": "^3.0.0", + "npm-normalize-package-bin": "^3.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/read-package-json-fast/node_modules/json-parse-even-better-errors": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-3.0.0.tgz", + "integrity": "sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/read-package-json/node_modules/json-parse-even-better-errors": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-3.0.0.tgz", + "integrity": "sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA==", + "dev": true, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "dev": true, + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/readdirp": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "dev": true, + "dependencies": { + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/reflect-metadata": { + "version": "0.1.13", + "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.1.13.tgz", + "integrity": "sha512-Ts1Y/anZELhSsjMcU605fU9RE4Oi3p5ORujwbIKXfWa+0Zxs510Qrmrce5/Jowq3cHSZSJqBjypxmHarc+vEWg==", + "dev": true + }, + "node_modules/regenerate": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", + "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", + "dev": true + }, + "node_modules/regenerate-unicode-properties": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.1.0.tgz", + "integrity": "sha512-d1VudCLoIGitcU/hEg2QqvyGZQmdC0Lf8BqdOMXGFSvJP4bNV1+XqbPQeHHLD51Jh4QJJ225dlIFvY4Ly6MXmQ==", + "dev": true, + "dependencies": { + "regenerate": "^1.4.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/regenerator-runtime": { + "version": "0.13.11", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz", + "integrity": "sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg==", + "dev": true + }, + "node_modules/regenerator-transform": { + "version": "0.15.1", + "resolved": "https://registry.npmjs.org/regenerator-transform/-/regenerator-transform-0.15.1.tgz", + "integrity": "sha512-knzmNAcuyxV+gQCufkYcvOqX/qIIfHLv0u5x79kRxuGojfYVky1f15TzZEu2Avte8QGepvUNTnLskf8E6X6Vyg==", + "dev": true, + "dependencies": { + "@babel/runtime": "^7.8.4" + } + }, + "node_modules/regex-parser": { + "version": "2.2.11", + "resolved": "https://registry.npmjs.org/regex-parser/-/regex-parser-2.2.11.tgz", + "integrity": "sha512-jbD/FT0+9MBU2XAZluI7w2OBs1RBi6p9M83nkoZayQXXU9e8Robt69FcZc7wU4eJD/YFTjn1JdCk3rbMJajz8Q==", + "dev": true + }, + "node_modules/regexpu-core": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-5.3.2.tgz", + "integrity": "sha512-RAM5FlZz+Lhmo7db9L298p2vHP5ZywrVXmVXpmAD9GuL5MPH6t9ROw1iA/wfHkQ76Qe7AaPF0nGuim96/IrQMQ==", + "dev": true, + "dependencies": { + "@babel/regjsgen": "^0.8.0", + "regenerate": "^1.4.2", + "regenerate-unicode-properties": "^10.1.0", + "regjsparser": "^0.9.1", + "unicode-match-property-ecmascript": "^2.0.0", + "unicode-match-property-value-ecmascript": "^2.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/regjsparser": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.9.1.tgz", + "integrity": "sha512-dQUtn90WanSNl+7mQKcXAgZxvUe7Z0SqXlgzv0za4LwiUhyzBC58yQO3liFoUgu8GiJVInAhJjkj1N0EtQ5nkQ==", + "dev": true, + "dependencies": { + "jsesc": "~0.5.0" + }, + "bin": { + "regjsparser": "bin/parser" + } + }, + "node_modules/regjsparser/node_modules/jsesc": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz", + "integrity": "sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==", + "dev": true, + "bin": { + "jsesc": "bin/jsesc" + } + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", + "dev": true + }, + "node_modules/resolve": { + "version": "1.22.2", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.2.tgz", + "integrity": "sha512-Sb+mjNHOULsBv818T40qSPeRiuWLyaGMa5ewydRLFimneixmVy2zdivRl+AF6jaYPC8ERxGDmFSiqui6SfPd+g==", + "dev": true, + "dependencies": { + "is-core-module": "^2.11.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve-url-loader": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-url-loader/-/resolve-url-loader-5.0.0.tgz", + "integrity": "sha512-uZtduh8/8srhBoMx//5bwqjQ+rfYOUq8zC9NrMUGtjBiGTtFJM42s58/36+hTqeqINcnYe08Nj3LkK9lW4N8Xg==", + "dev": true, + "dependencies": { + "adjust-sourcemap-loader": "^4.0.0", + "convert-source-map": "^1.7.0", + "loader-utils": "^2.0.0", + "postcss": "^8.2.14", + "source-map": "0.6.1" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/resolve-url-loader/node_modules/loader-utils": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.4.tgz", + "integrity": "sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==", + "dev": true, + "dependencies": { + "big.js": "^5.2.2", + "emojis-list": "^3.0.0", + "json5": "^2.1.2" + }, + "engines": { + "node": ">=8.9.0" + } + }, + "node_modules/resolve-url-loader/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/restore-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", + "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "dev": true, + "dependencies": { + "onetime": "^5.1.0", + "signal-exit": "^3.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/restore-cursor/node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "dev": true + }, + "node_modules/retry": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", + "integrity": "sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rfdc": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.3.0.tgz", + "integrity": "sha512-V2hovdzFbOi77/WajaSMXk2OLm+xNIeQdMMuB7icj7bk6zi2F8GGAxigcnDFpJHbNyNcgyJDiP+8nOrY5cZGrA==", + "dev": true + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/rimraf/node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/rimraf/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/rimraf/node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/rollup": { + "version": "3.25.3", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.25.3.tgz", + "integrity": "sha512-ZT279hx8gszBj9uy5FfhoG4bZx8c+0A1sbqtr7Q3KNWIizpTdDEPZbV2xcbvHsnFp4MavCQYZyzApJ+virB8Yw==", + "dev": true, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=14.18.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/rxjs": { + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.1.tgz", + "integrity": "sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "dev": true + }, + "node_modules/safevalues": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/safevalues/-/safevalues-0.3.4.tgz", + "integrity": "sha512-LRneZZRXNgjzwG4bDQdOTSbze3fHm1EAKN/8bePxnlEZiBmkYEDggaHbuvHI9/hoqHbGfsEA7tWS9GhYHZBBsw==" + }, + "node_modules/sass": { + "version": "1.63.2", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.63.2.tgz", + "integrity": "sha512-u56TU0AIFqMtauKl/OJ1AeFsXqRHkgO7nCWmHaDwfxDo9GUMSqBA4NEh6GMuh1CYVM7zuROYtZrHzPc2ixK+ww==", + "dev": true, + "dependencies": { + "chokidar": ">=3.0.0 <4.0.0", + "immutable": "^4.0.0", + "source-map-js": ">=0.6.2 <2.0.0" + }, + "bin": { + "sass": "sass.js" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/sass-loader": { + "version": "13.3.1", + "resolved": "https://registry.npmjs.org/sass-loader/-/sass-loader-13.3.1.tgz", + "integrity": "sha512-cBTxmgyVA1nXPvIK4brjJMXOMJ2v2YrQEuHqLw3LylGb3gsR6jAvdjHMcy/+JGTmmIF9SauTrLLR7bsWDMWqgg==", + "dev": true, + "dependencies": { + "klona": "^2.0.6", + "neo-async": "^2.6.2" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "fibers": ">= 3.1.0", + "node-sass": "^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0", + "sass": "^1.3.0", + "sass-embedded": "*", + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "fibers": { + "optional": true + }, + "node-sass": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + } + } + }, + "node_modules/sax": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", + "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", + "dev": true, + "optional": true + }, + "node_modules/schema-utils": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.2.0.tgz", + "integrity": "sha512-L0jRsrPpjdckP3oPug3/VxNKt2trR8TcabrM6FOAAlvC/9Phcmm+cuAgTlxBqdBR1WJx7Naj9WHw+aOmheSVbw==", + "dev": true, + "dependencies": { + "@types/json-schema": "^7.0.9", + "ajv": "^8.9.0", + "ajv-formats": "^2.1.1", + "ajv-keywords": "^5.1.0" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/select-hose": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/select-hose/-/select-hose-2.0.0.tgz", + "integrity": "sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg==", + "dev": true + }, + "node_modules/selfsigned": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/selfsigned/-/selfsigned-2.1.1.tgz", + "integrity": "sha512-GSL3aowiF7wa/WtSFwnUrludWFoNhftq8bUkH9pkzjpN2XSPOAYEgg6e0sS9s0rZwgJzJiQRPU18A6clnoW5wQ==", + "dev": true, + "dependencies": { + "node-forge": "^1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver": { + "version": "7.5.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.3.tgz", + "integrity": "sha512-QBlUtyVk/5EeHbi7X0fw6liDZc7BBmEaSYn01fMU1OUYbf6GPsbTtd8WmnqbI20SeycoHSeiybkE/q1Q+qlThQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver/node_modules/lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/send": { + "version": "0.18.0", + "resolved": "https://registry.npmjs.org/send/-/send-0.18.0.tgz", + "integrity": "sha512-qqWzuOjSFOuqPjFe4NOsMLafToQQwBSOEpS+FwEt3A2V3vKubTquT3vmLTQpFgMXp8AlFWFuP1qKaJZOtPpVXg==", + "dev": true, + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "2.4.1", + "range-parser": "~1.2.1", + "statuses": "2.0.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/send/node_modules/debug/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/send/node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "dev": true, + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/send/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true + }, + "node_modules/send/node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/serialize-javascript": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.1.tgz", + "integrity": "sha512-owoXEFjWRllis8/M1Q+Cw5k8ZH40e3zhp/ovX+Xr/vi1qj6QesbyXXViFbpNvWvPNAD62SutwEXavefrLJWj7w==", + "dev": true, + "dependencies": { + "randombytes": "^2.1.0" + } + }, + "node_modules/serve-index": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/serve-index/-/serve-index-1.9.1.tgz", + "integrity": "sha512-pXHfKNP4qujrtteMrSBb0rc8HJ9Ms/GrXwcUtUtD5s4ewDJI8bT3Cz2zTVRMKtri49pLx2e0Ya8ziP5Ya2pZZw==", + "dev": true, + "dependencies": { + "accepts": "~1.3.4", + "batch": "0.6.1", + "debug": "2.6.9", + "escape-html": "~1.0.3", + "http-errors": "~1.6.2", + "mime-types": "~2.1.17", + "parseurl": "~1.3.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/serve-index/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/serve-index/node_modules/depd": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", + "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/http-errors": { + "version": "1.6.3", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz", + "integrity": "sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A==", + "dev": true, + "dependencies": { + "depd": "~1.1.2", + "inherits": "2.0.3", + "setprototypeof": "1.1.0", + "statuses": ">= 1.4.0 < 2" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==", + "dev": true + }, + "node_modules/serve-index/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/serve-index/node_modules/setprototypeof": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz", + "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==", + "dev": true + }, + "node_modules/serve-static": { + "version": "1.15.0", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.15.0.tgz", + "integrity": "sha512-XGuRDNjXUijsUL0vl6nSD7cwURuzEgglbOaFuZM9g3kwDXOWVTck0jLzjPzGD+TazWbboZYu52/9/XPdUgne9g==", + "dev": true, + "dependencies": { + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "0.18.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/set-blocking": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", + "integrity": "sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw==", + "dev": true + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", + "dev": true + }, + "node_modules/shallow-clone": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", + "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", + "dev": true, + "dependencies": { + "kind-of": "^6.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/shell-quote": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.1.tgz", + "integrity": "sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", + "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.0.2.tgz", + "integrity": "sha512-MY2/qGx4enyjprQnFaZsHib3Yadh3IXyV2C321GY0pjGfVBu4un0uDJkwgdxqO+Rdx8JMT8IfJIRwbYVz3Ob3Q==", + "dev": true, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/sigstore": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/sigstore/-/sigstore-1.6.0.tgz", + "integrity": "sha512-QODKff/qW/TXOZI6V/Clqu74xnInAS6it05mufj4/fSewexLtfEntgLZZcBtUK44CDQyUE5TUXYy1ARYzlfG9g==", + "dev": true, + "dependencies": { + "@sigstore/protobuf-specs": "^0.1.0", + "@sigstore/tuf": "^1.0.0", + "make-fetch-happen": "^11.0.1", + "tuf-js": "^1.1.3" + }, + "bin": { + "sigstore": "bin/sigstore.js" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/slash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", + "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/smart-buffer": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz", + "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==", + "dev": true, + "engines": { + "node": ">= 6.0.0", + "npm": ">= 3.0.0" + } + }, + "node_modules/socket.io": { + "version": "4.7.1", + "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-4.7.1.tgz", + "integrity": "sha512-W+utHys2w//dhFjy7iQQu9sGd3eokCjGbl2r59tyLqNiJJBdIebn3GAKEXBr3osqHTObJi2die/25bCx2zsaaw==", + "dev": true, + "dependencies": { + "accepts": "~1.3.4", + "base64id": "~2.0.0", + "cors": "~2.8.5", + "debug": "~4.3.2", + "engine.io": "~6.5.0", + "socket.io-adapter": "~2.5.2", + "socket.io-parser": "~4.2.4" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/socket.io-adapter": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-2.5.2.tgz", + "integrity": "sha512-87C3LO/NOMc+eMcpcxUBebGjkpMDkNBS9tf7KJqcDsmL936EChtVva71Dw2q4tQcuVC+hAUy4an2NO/sYXmwRA==", + "dev": true, + "dependencies": { + "ws": "~8.11.0" + } + }, + "node_modules/socket.io-parser": { + "version": "4.2.4", + "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.2.4.tgz", + "integrity": "sha512-/GbIKmo8ioc+NIWIhwdecY0ge+qVBSMdgxGygevmdHj24bsfgtCmcUUcQ5ZzcylGFHsN3k4HB4Cgkl96KVnuew==", + "dev": true, + "dependencies": { + "@socket.io/component-emitter": "~3.1.0", + "debug": "~4.3.1" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/sockjs": { + "version": "0.3.24", + "resolved": "https://registry.npmjs.org/sockjs/-/sockjs-0.3.24.tgz", + "integrity": "sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ==", + "dev": true, + "dependencies": { + "faye-websocket": "^0.11.3", + "uuid": "^8.3.2", + "websocket-driver": "^0.7.4" + } + }, + "node_modules/socks": { + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/socks/-/socks-2.7.1.tgz", + "integrity": "sha512-7maUZy1N7uo6+WVEX6psASxtNlKaNVMlGQKkG/63nEDdLOWNbiUMoLK7X4uYoLhQstau72mLgfEWcXcwsaHbYQ==", + "dev": true, + "dependencies": { + "ip": "^2.0.0", + "smart-buffer": "^4.2.0" + }, + "engines": { + "node": ">= 10.13.0", + "npm": ">= 3.0.0" + } + }, + "node_modules/socks-proxy-agent": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-7.0.0.tgz", + "integrity": "sha512-Fgl0YPZ902wEsAyiQ+idGd1A7rSFx/ayC1CQVMw5P+EQx2V0SgpGtf6OKFhVjPflPUl9YMmEOnmfjCdMUsygww==", + "dev": true, + "dependencies": { + "agent-base": "^6.0.2", + "debug": "^4.3.3", + "socks": "^2.6.2" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/source-map": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", + "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/source-map-js": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", + "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-loader": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/source-map-loader/-/source-map-loader-4.0.1.tgz", + "integrity": "sha512-oqXpzDIByKONVY8g1NUPOTQhe0UTU5bWUl32GSkqK2LjJj0HmwTMVKxcUip0RgAYhY1mqgOxjbQM48a0mmeNfA==", + "dev": true, + "dependencies": { + "abab": "^2.0.6", + "iconv-lite": "^0.6.3", + "source-map-js": "^1.0.2" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.72.1" + } + }, + "node_modules/source-map-loader/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "dev": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "dev": true, + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/source-map-support/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/spdx-correct": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.2.0.tgz", + "integrity": "sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==", + "dev": true, + "dependencies": { + "spdx-expression-parse": "^3.0.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/spdx-exceptions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", + "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", + "dev": true + }, + "node_modules/spdx-expression-parse": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", + "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", + "dev": true, + "dependencies": { + "spdx-exceptions": "^2.1.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/spdx-license-ids": { + "version": "3.0.13", + "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.13.tgz", + "integrity": "sha512-XkD+zwiqXHikFZm4AX/7JSCXA98U5Db4AFd5XUg/+9UNtnH75+Z9KxtpYiJZx36mUDVOwH83pl7yvCer6ewM3w==", + "dev": true + }, + "node_modules/spdy": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/spdy/-/spdy-4.0.2.tgz", + "integrity": "sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA==", + "dev": true, + "dependencies": { + "debug": "^4.1.0", + "handle-thing": "^2.0.0", + "http-deceiver": "^1.2.7", + "select-hose": "^2.0.0", + "spdy-transport": "^3.0.0" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/spdy-transport": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/spdy-transport/-/spdy-transport-3.0.0.tgz", + "integrity": "sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw==", + "dev": true, + "dependencies": { + "debug": "^4.1.0", + "detect-node": "^2.0.4", + "hpack.js": "^2.1.6", + "obuf": "^1.1.2", + "readable-stream": "^3.0.6", + "wbuf": "^1.7.3" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "dev": true + }, + "node_modules/ssri": { + "version": "10.0.4", + "resolved": "https://registry.npmjs.org/ssri/-/ssri-10.0.4.tgz", + "integrity": "sha512-12+IR2CB2C28MMAw0Ncqwj5QbTcs0nGIhgJzYWzDkb21vWmfNI83KS4f3Ci6GI98WreIfG7o9UXp3C0qbpA8nQ==", + "dev": true, + "dependencies": { + "minipass": "^5.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/statuses": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", + "integrity": "sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/streamroller": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/streamroller/-/streamroller-3.1.5.tgz", + "integrity": "sha512-KFxaM7XT+irxvdqSP1LGLgNWbYN7ay5owZ3r/8t77p+EtSUAfUgtl7be3xtqtOmGUl9K9YPO2ca8133RlTjvKw==", + "dev": true, + "dependencies": { + "date-format": "^4.0.14", + "debug": "^4.3.4", + "fs-extra": "^8.1.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "dev": true, + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width-cjs": { + "name": "string-width", + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi-cjs": { + "name": "strip-ansi", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/symbol-observable": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/symbol-observable/-/symbol-observable-4.0.0.tgz", + "integrity": "sha512-b19dMThMV4HVFynSAM1++gBHAbk2Tc/osgLIBZMKsyqh34jb2e8Os7T6ZW/Bt3pJFdBTd2JwAnAAEQV7rSNvcQ==", + "dev": true, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/tapable": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", + "integrity": "sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/tar": { + "version": "6.1.15", + "resolved": "https://registry.npmjs.org/tar/-/tar-6.1.15.tgz", + "integrity": "sha512-/zKt9UyngnxIT/EAGYuxaMYgOIJiP81ab9ZfkILq4oNLPFX50qyYmu7jRj9qeXoxmJHjGlbH0+cm2uy1WCs10A==", + "dev": true, + "dependencies": { + "chownr": "^2.0.0", + "fs-minipass": "^2.0.0", + "minipass": "^5.0.0", + "minizlib": "^2.1.1", + "mkdirp": "^1.0.3", + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/tar/node_modules/fs-minipass": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-2.1.0.tgz", + "integrity": "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==", + "dev": true, + "dependencies": { + "minipass": "^3.0.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/tar/node_modules/fs-minipass/node_modules/minipass": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", + "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/tar/node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/tar/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/terser": { + "version": "5.17.7", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.17.7.tgz", + "integrity": "sha512-/bi0Zm2C6VAexlGgLlVxA0P2lru/sdLyfCVaRMfKVo9nWxbmz7f/sD8VPybPeSUJaJcwmCJis9pBIhcVcG1QcQ==", + "dev": true, + "dependencies": { + "@jridgewell/source-map": "^0.3.3", + "acorn": "^8.8.2", + "commander": "^2.20.0", + "source-map-support": "~0.5.20" + }, + "bin": { + "terser": "bin/terser" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/terser-webpack-plugin": { + "version": "5.3.9", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.9.tgz", + "integrity": "sha512-ZuXsqE07EcggTWQjXUj+Aot/OMcD0bMKGgF63f7UxYcu5/AJF53aIpK1YoP5xR9l6s/Hy2b+t1AM0bLNPRuhwA==", + "dev": true, + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.17", + "jest-worker": "^27.4.5", + "schema-utils": "^3.1.1", + "serialize-javascript": "^6.0.1", + "terser": "^5.16.8" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "uglify-js": { + "optional": true + } + } + }, + "node_modules/terser-webpack-plugin/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/terser-webpack-plugin/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "dev": true, + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/terser-webpack-plugin/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/terser-webpack-plugin/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dev": true, + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/test-exclude": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", + "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "dev": true, + "dependencies": { + "@istanbuljs/schema": "^0.1.2", + "glob": "^7.1.4", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/test-exclude/node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/test-exclude/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/test-exclude/node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", + "dev": true + }, + "node_modules/through": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", + "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", + "dev": true + }, + "node_modules/thunky": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz", + "integrity": "sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==", + "dev": true + }, + "node_modules/tmp": { + "version": "0.0.33", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", + "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", + "dev": true, + "dependencies": { + "os-tmpdir": "~1.0.2" + }, + "engines": { + "node": ">=0.6.0" + } + }, + "node_modules/to-fast-properties": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz", + "integrity": "sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "dev": true, + "engines": { + "node": ">=0.6" + } + }, + "node_modules/tree-kill": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/tree-kill/-/tree-kill-1.2.2.tgz", + "integrity": "sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==", + "dev": true, + "bin": { + "tree-kill": "cli.js" + } + }, + "node_modules/tslib": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.0.tgz", + "integrity": "sha512-7At1WUettjcSRHXCyYtTselblcHl9PJFFVKiCAy/bY97+BPZXSQ2wbq0P9s8tK2G7dFQfNnlJnPAiArVBVBsfA==" + }, + "node_modules/tuf-js": { + "version": "1.1.7", + "resolved": "https://registry.npmjs.org/tuf-js/-/tuf-js-1.1.7.tgz", + "integrity": "sha512-i3P9Kgw3ytjELUfpuKVDNBJvk4u5bXL6gskv572mcevPbSKCV3zt3djhmlEQ65yERjIbOSncy7U4cQJaB1CBCg==", + "dev": true, + "dependencies": { + "@tufjs/models": "1.0.4", + "debug": "^4.3.4", + "make-fetch-happen": "^11.1.1" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "dev": true, + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/typed-assert": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/typed-assert/-/typed-assert-1.0.9.tgz", + "integrity": "sha512-KNNZtayBCtmnNmbo5mG47p1XsCyrx6iVqomjcZnec/1Y5GGARaxPs6r49RnSPeUP3YjNYiU9sQHAtY4BBvnZwg==", + "dev": true + }, + "node_modules/typescript": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.1.6.tgz", + "integrity": "sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/ua-parser-js": { + "version": "0.7.35", + "resolved": "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-0.7.35.tgz", + "integrity": "sha512-veRf7dawaj9xaWEu9HoTVn5Pggtc/qj+kqTOFvNiN1l0YdxwC1kvel57UCjThjGa3BHBihE8/UJAHI+uQHmd/g==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/ua-parser-js" + }, + { + "type": "paypal", + "url": "https://paypal.me/faisalman" + } + ], + "engines": { + "node": "*" + } + }, + "node_modules/unicode-canonical-property-names-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", + "integrity": "sha512-yY5PpDlfVIU5+y/BSCxAJRBIS1Zc2dDG3Ujq+sR0U+JjUevW2JhocOF+soROYDSaAezOzOKuyyixhD6mBknSmQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", + "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "dev": true, + "dependencies": { + "unicode-canonical-property-names-ecmascript": "^2.0.0", + "unicode-property-aliases-ecmascript": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-value-ecmascript": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.1.0.tgz", + "integrity": "sha512-qxkjQt6qjg/mYscYMC0XKRn3Rh0wFPlfxB0xkt9CfyTvpX1Ra0+rAmdX2QyAobptSEvuy4RtpPRui6XkV+8wjA==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-property-aliases-ecmascript": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.1.0.tgz", + "integrity": "sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/unique-filename": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unique-filename/-/unique-filename-3.0.0.tgz", + "integrity": "sha512-afXhuC55wkAmZ0P18QsVE6kp8JaxrEokN2HGIoIVv2ijHQd419H0+6EigAFcIzXeMIkcIkNBpB3L/DXB3cTS/g==", + "dev": true, + "dependencies": { + "unique-slug": "^4.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/unique-slug": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unique-slug/-/unique-slug-4.0.0.tgz", + "integrity": "sha512-WrcA6AyEfqDX5bWige/4NQfPZMtASNVxdmWR76WESYQVAACSgWcR6e9i0mofqqBxYFtL4oAxPIptY73/0YE1DQ==", + "dev": true, + "dependencies": { + "imurmurhash": "^0.1.4" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/update-browserslist-db": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.11.tgz", + "integrity": "sha512-dCwEFf0/oT85M1fHBg4F0jtLwJrutGoHSQXCh7u4o2t1drG+c0a9Flnqww6XUKSfQMPpJBRjU8d4RXB09qtvaA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "escalade": "^3.1.1", + "picocolors": "^1.0.0" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "dev": true + }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "dev": true, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/uuid": { + "version": "8.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", + "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", + "dev": true, + "bin": { + "uuid": "dist/bin/uuid" + } + }, + "node_modules/validate-npm-package-license": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", + "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", + "dev": true, + "dependencies": { + "spdx-correct": "^3.0.0", + "spdx-expression-parse": "^3.0.0" + } + }, + "node_modules/validate-npm-package-name": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/validate-npm-package-name/-/validate-npm-package-name-5.0.0.tgz", + "integrity": "sha512-YuKoXDAhBYxY7SfOKxHBDoSyENFeW5VvIIQp2TGQuit8gpK6MnWaQelBKxso72DoxTZfZdcP3W90LqpSkgPzLQ==", + "dev": true, + "dependencies": { + "builtins": "^5.0.0" + }, + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/vite": { + "version": "4.3.9", + "resolved": "https://registry.npmjs.org/vite/-/vite-4.3.9.tgz", + "integrity": "sha512-qsTNZjO9NoJNW7KnOrgYwczm0WctJ8m/yqYAMAK9Lxt4SoySUfS5S8ia9K7JHpa3KEeMfyF8LoJ3c5NeBJy6pg==", + "dev": true, + "dependencies": { + "esbuild": "^0.17.5", + "postcss": "^8.4.23", + "rollup": "^3.21.0" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^14.18.0 || >=16.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + }, + "peerDependencies": { + "@types/node": ">= 14", + "less": "*", + "sass": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.4.0" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "less": { + "optional": true + }, + "sass": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + } + } + }, + "node_modules/void-elements": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/void-elements/-/void-elements-2.0.1.tgz", + "integrity": "sha512-qZKX4RnBzH2ugr8Lxa7x+0V6XD9Sb/ouARtiasEQCHB1EVU4NXtmHsDDrx1dO4ne5fc3J6EW05BP1Dl0z0iung==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/watchpack": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.0.tgz", + "integrity": "sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==", + "dev": true, + "dependencies": { + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.1.2" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/wbuf": { + "version": "1.7.3", + "resolved": "https://registry.npmjs.org/wbuf/-/wbuf-1.7.3.tgz", + "integrity": "sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA==", + "dev": true, + "dependencies": { + "minimalistic-assert": "^1.0.0" + } + }, + "node_modules/wcwidth": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", + "integrity": "sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==", + "dev": true, + "dependencies": { + "defaults": "^1.0.3" + } + }, + "node_modules/webpack": { + "version": "5.86.0", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.86.0.tgz", + "integrity": "sha512-3BOvworZ8SO/D4GVP+GoRC3fVeg5MO4vzmq8TJJEkdmopxyazGDxN8ClqN12uzrZW9Tv8EED8v5VSb6Sqyi0pg==", + "dev": true, + "dependencies": { + "@types/eslint-scope": "^3.7.3", + "@types/estree": "^1.0.0", + "@webassemblyjs/ast": "^1.11.5", + "@webassemblyjs/wasm-edit": "^1.11.5", + "@webassemblyjs/wasm-parser": "^1.11.5", + "acorn": "^8.7.1", + "acorn-import-assertions": "^1.9.0", + "browserslist": "^4.14.5", + "chrome-trace-event": "^1.0.2", + "enhanced-resolve": "^5.14.1", + "es-module-lexer": "^1.2.1", + "eslint-scope": "5.1.1", + "events": "^3.2.0", + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.2.9", + "json-parse-even-better-errors": "^2.3.1", + "loader-runner": "^4.2.0", + "mime-types": "^2.1.27", + "neo-async": "^2.6.2", + "schema-utils": "^3.1.2", + "tapable": "^2.1.1", + "terser-webpack-plugin": "^5.3.7", + "watchpack": "^2.4.0", + "webpack-sources": "^3.2.3" + }, + "bin": { + "webpack": "bin/webpack.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependenciesMeta": { + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-dev-middleware": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-6.1.1.tgz", + "integrity": "sha512-y51HrHaFeeWir0YO4f0g+9GwZawuigzcAdRNon6jErXy/SqV/+O6eaVAzDqE6t3e3NpGeR5CS+cCDaTC+V3yEQ==", + "dev": true, + "dependencies": { + "colorette": "^2.0.10", + "memfs": "^3.4.12", + "mime-types": "^2.1.31", + "range-parser": "^1.2.1", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + } + } + }, + "node_modules/webpack-dev-server": { + "version": "4.15.0", + "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-4.15.0.tgz", + "integrity": "sha512-HmNB5QeSl1KpulTBQ8UT4FPrByYyaLxpJoQ0+s7EvUrMc16m0ZS1sgb1XGqzmgCPk0c9y+aaXxn11tbLzuM7NQ==", + "dev": true, + "dependencies": { + "@types/bonjour": "^3.5.9", + "@types/connect-history-api-fallback": "^1.3.5", + "@types/express": "^4.17.13", + "@types/serve-index": "^1.9.1", + "@types/serve-static": "^1.13.10", + "@types/sockjs": "^0.3.33", + "@types/ws": "^8.5.1", + "ansi-html-community": "^0.0.8", + "bonjour-service": "^1.0.11", + "chokidar": "^3.5.3", + "colorette": "^2.0.10", + "compression": "^1.7.4", + "connect-history-api-fallback": "^2.0.0", + "default-gateway": "^6.0.3", + "express": "^4.17.3", + "graceful-fs": "^4.2.6", + "html-entities": "^2.3.2", + "http-proxy-middleware": "^2.0.3", + "ipaddr.js": "^2.0.1", + "launch-editor": "^2.6.0", + "open": "^8.0.9", + "p-retry": "^4.5.0", + "rimraf": "^3.0.2", + "schema-utils": "^4.0.0", + "selfsigned": "^2.1.1", + "serve-index": "^1.9.1", + "sockjs": "^0.3.24", + "spdy": "^4.0.2", + "webpack-dev-middleware": "^5.3.1", + "ws": "^8.13.0" + }, + "bin": { + "webpack-dev-server": "bin/webpack-dev-server.js" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.37.0 || ^5.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + }, + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-dev-server/node_modules/webpack-dev-middleware": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-5.3.3.tgz", + "integrity": "sha512-hj5CYrY0bZLB+eTO+x/j67Pkrquiy7kWepMHmUMoPsmcUaeEnQJqFzHJOyxgWlq746/wUuA64p9ta34Kyb01pA==", + "dev": true, + "dependencies": { + "colorette": "^2.0.10", + "memfs": "^3.4.3", + "mime-types": "^2.1.31", + "range-parser": "^1.2.1", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/webpack-dev-server/node_modules/ws": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.13.0.tgz", + "integrity": "sha512-x9vcZYTrFPC7aSIbj7sRCYo7L/Xb8Iy+pW0ng0wt2vCJv7M9HOMy0UoN3rr+IFC7hb7vXoqS+P9ktyLLLhO+LA==", + "dev": true, + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/webpack-merge": { + "version": "5.9.0", + "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.9.0.tgz", + "integrity": "sha512-6NbRQw4+Sy50vYNTw7EyOn41OZItPiXB8GNv3INSoe3PSFaHJEz3SHTrYVaRm2LilNGnFUzh0FAwqPEmU/CwDg==", + "dev": true, + "dependencies": { + "clone-deep": "^4.0.1", + "wildcard": "^2.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/webpack-sources": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.2.3.tgz", + "integrity": "sha512-/DyMEOrDgLKKIG0fmvtz+4dUX/3Ghozwgm6iPp8KRhvn+eQf9+Q7GWxVNMk3+uCPWfdXYC4ExGBckIXdFEfH1w==", + "dev": true, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/webpack-subresource-integrity": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/webpack-subresource-integrity/-/webpack-subresource-integrity-5.1.0.tgz", + "integrity": "sha512-sacXoX+xd8r4WKsy9MvH/q/vBtEHr86cpImXwyg74pFIpERKt6FmB8cXpeuh0ZLgclOlHI4Wcll7+R5L02xk9Q==", + "dev": true, + "dependencies": { + "typed-assert": "^1.0.8" + }, + "engines": { + "node": ">= 12" + }, + "peerDependencies": { + "html-webpack-plugin": ">= 5.0.0-beta.1 < 6", + "webpack": "^5.12.0" + }, + "peerDependenciesMeta": { + "html-webpack-plugin": { + "optional": true + } + } + }, + "node_modules/webpack/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/webpack/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "dev": true, + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/webpack/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/webpack/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dev": true, + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/websocket-driver": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/websocket-driver/-/websocket-driver-0.7.4.tgz", + "integrity": "sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==", + "dev": true, + "dependencies": { + "http-parser-js": ">=0.5.1", + "safe-buffer": ">=5.1.0", + "websocket-extensions": ">=0.1.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/websocket-extensions": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/websocket-extensions/-/websocket-extensions-0.1.4.tgz", + "integrity": "sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg==", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/wide-align": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.5.tgz", + "integrity": "sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg==", + "dev": true, + "dependencies": { + "string-width": "^1.0.2 || 2 || 3 || 4" + } + }, + "node_modules/wildcard": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/wildcard/-/wildcard-2.0.1.tgz", + "integrity": "sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==", + "dev": true + }, + "node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs": { + "name": "wrap-ansi", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/wrap-ansi/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/wrap-ansi/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true + }, + "node_modules/ws": { + "version": "8.11.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.11.0.tgz", + "integrity": "sha512-HPG3wQd9sNQoT9xHyNCXoDUa+Xw/VevmY9FoHyQ+g+rrMn4j6FB4np7Z0OhdTgjx6MgQLK7jwSy1YecU1+4Asg==", + "dev": true, + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + }, + "node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "dev": true, + "dependencies": { + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "dev": true, + "engines": { + "node": ">=12" + } + }, + "node_modules/zone.js": { + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/zone.js/-/zone.js-0.13.1.tgz", + "integrity": "sha512-+bIeDAFEBYuXRuU3qGQvzdPap+N1zjM4KkBAiiQuVVCrHrhjDuY6VkUhNa5+U27+9w0q3fbKiMCbpJ0XzMmSWA==", + "dependencies": { + "tslib": "^2.3.0" + } + } + } +} diff --git a/modules/ui/package.json b/modules/ui/package.json new file mode 100644 index 000000000..05add0189 --- /dev/null +++ b/modules/ui/package.json @@ -0,0 +1,42 @@ +{ + "name": "test-run-ui", + "version": "0.0.0", + "scripts": { + "ng": "ng", + "start": "ng serve", + "build": "ng build", + "watch": "ng build --watch --configuration development", + "test": "ng test", + "test:coverage": "ng test --code-coverage", + "docker": "docker rm -f test-run-ui && docker rmi test-run-ui && docker build -t test-run-ui . && docker run -d -p 80:80 --name test-run-ui test-run-ui" + }, + "private": true, + "dependencies": { + "@angular/animations": "^16.1.0", + "@angular/cdk": "^16.1.4", + "@angular/common": "^16.1.0", + "@angular/compiler": "^16.1.0", + "@angular/core": "^16.1.0", + "@angular/forms": "^16.1.0", + "@angular/material": "^16.1.4", + "@angular/platform-browser": "^16.1.0", + "@angular/platform-browser-dynamic": "^16.1.0", + "@angular/router": "^16.1.0", + "rxjs": "~7.8.0", + "tslib": "^2.3.0", + "zone.js": "~0.13.0" + }, + "devDependencies": { + "@angular-devkit/build-angular": "^16.1.3", + "@angular/cli": "~16.1.3", + "@angular/compiler-cli": "^16.1.0", + "@types/jasmine": "~4.3.0", + "jasmine-core": "~4.6.0", + "karma": "~6.4.0", + "karma-chrome-launcher": "~3.2.0", + "karma-coverage": "~2.2.0", + "karma-jasmine": "~5.1.0", + "karma-jasmine-html-reporter": "~2.1.0", + "typescript": "~5.1.3" + } +} diff --git a/modules/ui/src/app/app-routing.module.ts b/modules/ui/src/app/app-routing.module.ts new file mode 100644 index 000000000..20e8c8bbf --- /dev/null +++ b/modules/ui/src/app/app-routing.module.ts @@ -0,0 +1,32 @@ +import {NgModule} from '@angular/core'; +import {RouterModule, Routes} from '@angular/router'; +import {allowToRunTestGuard} from './guards/allow-to-run-test.guard'; + +const routes: Routes = [ + { + path: 'runtime', + canActivate: [allowToRunTestGuard], + loadChildren: () => import('./progress/progress.module').then(m => m.ProgressModule) + }, + { + path: 'device-repository', + loadChildren: () => import('./device-repository/device-repository.module').then(m => m.DeviceRepositoryModule) + }, + { + path: 'results', + canActivate: [allowToRunTestGuard], + loadChildren: () => import('./history/history.module').then(m => m.HistoryModule) + }, + { + path: '', + redirectTo: 'runtime', + pathMatch: 'full' + } +]; + +@NgModule({ + imports: [RouterModule.forRoot(routes)], + exports: [RouterModule] +}) +export class AppRoutingModule { +} diff --git a/modules/ui/src/app/app.component.html b/modules/ui/src/app/app.component.html new file mode 100644 index 000000000..de0baf85f --- /dev/null +++ b/modules/ui/src/app/app.component.html @@ -0,0 +1,70 @@ + + +
+ + + + + + + + +
+ + + + + + + Testrun + + + + +
+ +
+ + + + + + + + + + + + + diff --git a/modules/ui/src/app/app.component.scss b/modules/ui/src/app/app.component.scss new file mode 100644 index 000000000..ccc5c0ee6 --- /dev/null +++ b/modules/ui/src/app/app.component.scss @@ -0,0 +1,100 @@ +@use '@angular/material' as mat; +@import "../theming/colors"; + +.app-container { + height: 100%; +} + +.spacer { + flex: 1 1 auto; +} + +.mat-drawer-content { + background: $white; +} + +.mat-drawer-side { + border-right: none; +} + +.app-sidebar { + display: flex; + flex-direction: column; + background-color: $color-background-grey; + height: 100%; + gap: 8px; + width: 80px; + align-items: center; +} + +.app-sidebar-button, .app-toolbar-button { + border-radius: 20px; + border: 1px solid transparent; + min-width: 48px; + padding: 0; + box-sizing: border-box; + height: 34px; + margin: 6px 0; + line-height: 50%; +} + +.app-sidebar-button > .mat-icon, .app-toolbar-button > .mat-icon { + margin-right: 0; + width: 24px; + font-size: 24px; + color: $dark-grey; +} + +.app-sidebar-button > .mat-icon { + line-height: 18px; +} + +.app-sidebar-button-active { + border: 1px solid mat.get-color-from-palette($color-primary, 500); + background-color: mat.get-color-from-palette($color-primary, 500); +} + +.app-sidebar-button-active > .mat-icon { + color: $white; +} + +.logo-link { + color: $grey-800; + text-decoration: none; + font-size: 18px; + display: flex; + flex-wrap: nowrap; + align-items: center; + justify-content: center; + gap: 16px; +} + +.logo-link .mat-icon { + width: 36px; + height: 23px; +} + +.app-toolbar { + height: 56px; + padding: 0 6px 0 16px; + background-color: $white; + border-bottom: 1px solid $light-grey; + color: $grey-800; +} + +.app-content { + display: grid; + grid-template-rows: auto 1fr; +} + +.app-content-main { + display: grid; + grid-template-rows: 0 auto; + overflow: hidden; +} + +.settings-drawer { + width: 320px; + box-shadow: none; + border-left: 1px solid $light-grey; +} diff --git a/modules/ui/src/app/app.component.spec.ts b/modules/ui/src/app/app.component.spec.ts new file mode 100644 index 000000000..bedef40f4 --- /dev/null +++ b/modules/ui/src/app/app.component.spec.ts @@ -0,0 +1,122 @@ +import {HttpClientTestingModule} from '@angular/common/http/testing'; +import {ComponentFixture, fakeAsync, TestBed, tick} from '@angular/core/testing'; +import {Router} from '@angular/router'; +import {RouterTestingModule} from '@angular/router/testing'; +import {AppComponent} from './app.component'; +import {AppModule} from './app.module'; + +describe('AppComponent', () => { + let component: AppComponent; + let fixture: ComponentFixture; + let compiled: HTMLElement; + let router: Router; + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [RouterTestingModule, AppModule, HttpClientTestingModule], + declarations: [AppComponent] + }); + fixture = TestBed.createComponent(AppComponent); + component = fixture.componentInstance; + router = TestBed.get(Router); + fixture.detectChanges(); + compiled = fixture.nativeElement as HTMLElement; + }); + + it('should create the app', () => { + const app = fixture.componentInstance; + expect(app).toBeTruthy(); + }); + + it('should render side bar', () => { + const sideBar = compiled.querySelector('.app-sidebar'); + + expect(sideBar).toBeDefined(); + }); + + it('should render menu button', () => { + const button = compiled.querySelector('.app-sidebar-button-menu'); + + expect(button).toBeDefined(); + }); + + it('should render runtime button', () => { + const button = compiled.querySelector('.app-sidebar-button-runtime'); + + expect(button).toBeDefined(); + }); + + it('should render device repository button', () => { + const button = compiled.querySelector( + '.app-sidebar-button-device-repository' + ); + + expect(button).toBeDefined(); + }); + + it('should render results button', () => { + const button = compiled.querySelector('.app-sidebar-button-results'); + + expect(button).toBeDefined(); + }); + + it('should render toolbar', () => { + const toolBar = compiled.querySelector('.app-toolbar'); + + expect(toolBar).toBeDefined(); + }); + + it('should render logo link', () => { + const logoLink = compiled.querySelector('.logo-link'); + + expect(logoLink).toBeDefined(); + }); + + it('should render general settings button', () => { + const generalSettingsButton = compiled.querySelector( + '.app-toolbar-button-general-settings' + ); + + expect(generalSettingsButton).toBeDefined(); + }); + + it('should navigate to device repository', fakeAsync(() => { + const button = compiled.querySelector( + '.app-sidebar-button-device-repository' + ) as HTMLButtonElement; + button?.click(); + tick(); + + expect(router.url).toBe(`/device-repository`); + })); + + it('should call settingsDrawer close on closeSetting', fakeAsync(() => { + spyOn(component.settingsDrawer, 'close'); + + component.closeSetting(); + tick(); + + expect(component.settingsDrawer.close).toHaveBeenCalledTimes(1); + })); + + it('should call settingsDrawer open on openSetting', fakeAsync(() => { + spyOn(component.settingsDrawer, 'open'); + + component.openSetting(); + tick(); + + expect(component.settingsDrawer.open).toHaveBeenCalledTimes(1); + })); + + it('should call settingsDrawer toggle on click settings button', () => { + const settingsBtn = compiled.querySelector( + '.app-toolbar-button-general-settings' + ) as HTMLButtonElement; + spyOn(component.settingsDrawer, 'toggle'); + + settingsBtn.click(); + + expect(component.settingsDrawer.toggle).toHaveBeenCalledTimes(1); + }); + +}); diff --git a/modules/ui/src/app/app.component.ts b/modules/ui/src/app/app.component.ts new file mode 100644 index 000000000..91317c425 --- /dev/null +++ b/modules/ui/src/app/app.component.ts @@ -0,0 +1,57 @@ +import {Component, ViewChild} from '@angular/core'; +import {MatIconRegistry} from '@angular/material/icon'; +import {DomSanitizer} from '@angular/platform-browser'; +import {MatDrawer, MatDrawerToggleResult} from '@angular/material/sidenav'; +import {TestRunService} from './test-run.service'; + +const DEVICES_LOGO_URL = '/assets/icons/devices.svg'; +const REPORTS_LOGO_URL = '/assets/icons/reports.svg'; +const TESTRUN_LOGO_URL = '/assets/icons/testrun_logo_small.svg'; +const TESTRUN_LOGO_COLOR_URL = '/assets/icons/testrun_logo_color.svg'; +const CLOSE_URL = '/assets/icons/close.svg'; + +@Component({ + selector: 'app-root', + templateUrl: './app.component.html', + styleUrls: ['./app.component.scss'] +}) +export class AppComponent { + @ViewChild('settingsDrawer') public settingsDrawer!: MatDrawer; + + constructor( + private matIconRegistry: MatIconRegistry, + private domSanitizer: DomSanitizer, + private testRunService: TestRunService + ) { + testRunService.fetchDevices(); + this.matIconRegistry.addSvgIcon( + 'devices', + this.domSanitizer.bypassSecurityTrustResourceUrl(DEVICES_LOGO_URL) + ); + this.matIconRegistry.addSvgIcon( + 'reports', + this.domSanitizer.bypassSecurityTrustResourceUrl(REPORTS_LOGO_URL) + ); + this.matIconRegistry.addSvgIcon( + 'testrun_logo_small', + this.domSanitizer.bypassSecurityTrustResourceUrl(TESTRUN_LOGO_URL) + ); + this.matIconRegistry.addSvgIcon( + 'testrun_logo_color', + this.domSanitizer.bypassSecurityTrustResourceUrl(TESTRUN_LOGO_COLOR_URL) + ); + this.matIconRegistry.addSvgIcon( + 'close', + this.domSanitizer.bypassSecurityTrustResourceUrl(CLOSE_URL) + ); + } + + async closeSetting(): Promise { + return await this.settingsDrawer.close(); + } + + async openSetting(): Promise { + return await this.settingsDrawer.open(); + } + +} diff --git a/modules/ui/src/app/app.module.ts b/modules/ui/src/app/app.module.ts new file mode 100644 index 000000000..6ecdc54ac --- /dev/null +++ b/modules/ui/src/app/app.module.ts @@ -0,0 +1,38 @@ +import {HttpClientModule} from '@angular/common/http'; +import {NgModule} from '@angular/core'; +import {MatButtonModule} from '@angular/material/button'; +import {MatButtonToggleModule} from '@angular/material/button-toggle'; +import {MatIconModule} from '@angular/material/icon'; +import {MatSidenavModule} from '@angular/material/sidenav'; +import {MatToolbarModule} from '@angular/material/toolbar'; +import {MatRadioModule} from '@angular/material/radio'; +import {BrowserModule} from '@angular/platform-browser'; +import {NoopAnimationsModule} from '@angular/platform-browser/animations'; + +import {AppRoutingModule} from './app-routing.module'; +import {AppComponent} from './app.component'; +import {GeneralSettingsComponent} from './components/general-settings/general-settings.component'; +import {ReactiveFormsModule} from '@angular/forms'; +import {MatFormFieldModule} from '@angular/material/form-field'; + +@NgModule({ + declarations: [AppComponent, GeneralSettingsComponent], + imports: [ + BrowserModule, + AppRoutingModule, + NoopAnimationsModule, + MatButtonModule, + MatIconModule, + MatToolbarModule, + MatSidenavModule, + MatButtonToggleModule, + MatRadioModule, + HttpClientModule, + ReactiveFormsModule, + MatFormFieldModule + ], + providers: [], + bootstrap: [AppComponent] +}) +export class AppModule { +} diff --git a/modules/ui/src/app/components/device-item/device-item.component.html b/modules/ui/src/app/components/device-item/device-item.component.html new file mode 100644 index 000000000..8db6874b7 --- /dev/null +++ b/modules/ui/src/app/components/device-item/device-item.component.html @@ -0,0 +1,8 @@ + diff --git a/modules/ui/src/app/components/device-item/device-item.component.scss b/modules/ui/src/app/components/device-item/device-item.component.scss new file mode 100644 index 000000000..cc6b17240 --- /dev/null +++ b/modules/ui/src/app/components/device-item/device-item.component.scss @@ -0,0 +1,80 @@ +@import "../../../theming/colors"; +@import "../../../theming/variables"; + +$icon-width: 80px; +$border-radius: 12px; + +.device-item { + display: grid; + width: $device-item-width; + border-radius: $border-radius; + border: 1px solid #C4C7C5; + background: $white; + box-sizing: border-box; + grid-template-columns: 1fr 1fr $icon-width; + padding: 0; + grid-column-gap: 8px; + grid-row-gap: 4px; + font-family: 'Open Sans', sans-serif; + grid-template-areas: + "name name icon" + "manufacturer address icon"; + + &:hover { + cursor: pointer; + } +} + +.item-name { + padding: 0 16px; + grid-area: name; + justify-self: start; + align-self: end; + color: #1F1F1F; + justify-content: start; + font-size: 16px; + font-weight: 500; + line-height: 24px; + text-overflow: ellipsis; + white-space: nowrap; + overflow: hidden; + width: 230px; + text-align: start; +} + +.item-manufacturer { + padding: 0 16px; + grid-area: manufacturer; + justify-self: start; + color: $grey-800; + font-size: 14px; + font-style: normal; + font-weight: 400; + line-height: 20px; + max-width: 112px; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.item-mac-address { + padding-right: 16px; + grid-area: address; + justify-self: end; + color: #80868B; + font-family: Roboto, sans-serif; + font-size: 12px; + padding-top: 2px; + line-height: 20px; +} + +.item-icon { + grid-area: icon; + width: $icon-width; + height: calc($icon-width - 2px); + background-color: #E8F0FE; + justify-self: end; + border-top-right-radius: $border-radius; + border-bottom-right-radius: $border-radius; + background-image: url(/assets/icons/devices_add.svg); +} diff --git a/modules/ui/src/app/components/device-item/device-item.component.spec.ts b/modules/ui/src/app/components/device-item/device-item.component.spec.ts new file mode 100644 index 000000000..2aa87e416 --- /dev/null +++ b/modules/ui/src/app/components/device-item/device-item.component.spec.ts @@ -0,0 +1,53 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; +import {Device} from '../../model/device'; + +import {DeviceItemComponent} from './device-item.component'; +import {DeviceRepositoryModule} from '../../device-repository/device-repository.module'; + +describe('DeviceItemComponent', () => { + let component: DeviceItemComponent; + let fixture: ComponentFixture; + let compiled: HTMLElement; + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [DeviceRepositoryModule, DeviceItemComponent] + }); + fixture = TestBed.createComponent(DeviceItemComponent); + component = fixture.componentInstance; + compiled = fixture.nativeElement as HTMLElement; + component.device = { + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "dns": { + "enabled": true, + } + } + } as Device; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should display information about device', () => { + const name = compiled.querySelector('.item-name'); + const manufacturer = compiled.querySelector('.item-manufacturer'); + const mac = compiled.querySelector('.item-mac-address'); + + expect(name?.textContent).toEqual("O3-DIN-CPU"); + expect(manufacturer?.textContent).toEqual("Delta"); + expect(mac?.textContent).toEqual("00:1e:42:35:73:c4"); + }); + + it('should emit mac address', () => { + const clickSpy = spyOn(component.itemClicked, 'emit'); + const item = compiled.querySelector('.device-item') as HTMLElement; + item.click(); + + expect(clickSpy).toHaveBeenCalledWith(component.device); + }); +}); diff --git a/modules/ui/src/app/components/device-item/device-item.component.ts b/modules/ui/src/app/components/device-item/device-item.component.ts new file mode 100644 index 000000000..88f6ad3cb --- /dev/null +++ b/modules/ui/src/app/components/device-item/device-item.component.ts @@ -0,0 +1,17 @@ +import {Component, EventEmitter, Input, Output} from '@angular/core'; +import {Device} from '../../model/device'; + +@Component({ + selector: 'app-device-item', + templateUrl: './device-item.component.html', + styleUrls: ['./device-item.component.scss'], + standalone: true +}) +export class DeviceItemComponent { + @Input() device!: Device; + @Output() itemClicked = new EventEmitter(); + + itemClick(): void { + this.itemClicked.emit(this.device); + } +} diff --git a/modules/ui/src/app/components/device-tests/device-tests.component.html b/modules/ui/src/app/components/device-tests/device-tests.component.html new file mode 100644 index 000000000..5544111b8 --- /dev/null +++ b/modules/ui/src/app/components/device-tests/device-tests.component.html @@ -0,0 +1,9 @@ +
+
+

+ + {{testModules[i].displayName}} + +

+
+
diff --git a/modules/ui/src/app/components/device-tests/device-tests.component.scss b/modules/ui/src/app/components/device-tests/device-tests.component.scss new file mode 100644 index 000000000..40d1fcae3 --- /dev/null +++ b/modules/ui/src/app/components/device-tests/device-tests.component.scss @@ -0,0 +1,8 @@ +:host { + overflow: auto; +} + +.disabled { + pointer-events: none; + opacity: 0.6; +} diff --git a/modules/ui/src/app/components/device-tests/device-tests.component.spec.ts b/modules/ui/src/app/components/device-tests/device-tests.component.spec.ts new file mode 100644 index 000000000..19ce496e3 --- /dev/null +++ b/modules/ui/src/app/components/device-tests/device-tests.component.spec.ts @@ -0,0 +1,79 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {DeviceTestsComponent} from './device-tests.component'; +import {TestModule} from '../../model/device'; +import {FormArray, FormBuilder} from '@angular/forms'; + +describe('DeviceTestsComponent', () => { + let component: DeviceTestsComponent; + let fixture: ComponentFixture; + let compiled: HTMLElement; + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [DeviceTestsComponent], + providers: [ + FormBuilder + ] + }); + fixture = TestBed.createComponent(DeviceTestsComponent); + component = fixture.componentInstance; + component.testModules = [ + { + displayName: "Connection", + name: "connection", + enabled: true + }, + { + displayName: "DNS", + name: "dns", + enabled: false + }, + ] as TestModule[]; + component.deviceForm = new FormBuilder().group({ + test_modules: new FormArray([]) + }); + fixture.detectChanges(); + compiled = fixture.nativeElement; + }); + + describe('component tests', () => { + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should fill tests with default values if device is not present', () => { + expect(component.test_modules.controls.length).toEqual(2); + expect(component.test_modules.controls[0].value).toEqual(true); + expect(component.test_modules.controls[1].value).toEqual(false); + }); + + it('should fill tests with device test values if device not present', () => { + component.deviceTestModules = { + "connection": { + "enabled": false, + }, + "dns": { + "enabled": true, + } + }; + component.ngOnInit(); + + expect(component.test_modules.controls[0].value).toEqual(false); + expect(component.test_modules.controls[1].value).toEqual(true); + }); + }) + + describe('DOM tests', () => { + it('should have checkboxes', () => { + const test = compiled.querySelectorAll('mat-checkbox input')!; + const testLabel = compiled.querySelectorAll('mat-checkbox label')!; + + expect(test.length).toEqual(2); + expect((test[0] as HTMLInputElement).checked).toBeTrue(); + expect((test[1] as HTMLInputElement).checked).toBeFalse(); + expect(testLabel[0].innerHTML.trim()).toEqual('Connection'); + expect(testLabel[1].innerHTML.trim()).toEqual('DNS'); + }); + }); +}); diff --git a/modules/ui/src/app/components/device-tests/device-tests.component.ts b/modules/ui/src/app/components/device-tests/device-tests.component.ts new file mode 100644 index 000000000..4c649f364 --- /dev/null +++ b/modules/ui/src/app/components/device-tests/device-tests.component.ts @@ -0,0 +1,43 @@ +import {ChangeDetectionStrategy, Component, Input, OnInit} from '@angular/core'; +import {CommonModule} from '@angular/common'; +import {FormArray, FormControl, FormGroup, ReactiveFormsModule} from '@angular/forms'; +import {TestModule, TestModules} from '../../model/device'; +import {MatCheckboxModule} from '@angular/material/checkbox'; + +@Component({ + selector: 'app-device-tests', + standalone: true, + imports: [CommonModule, MatCheckboxModule, ReactiveFormsModule,], + templateUrl: './device-tests.component.html', + styleUrls: ['./device-tests.component.scss'], + changeDetection: ChangeDetectionStrategy.OnPush +}) +export class DeviceTestsComponent implements OnInit { + @Input() deviceForm!: FormGroup; + @Input() deviceTestModules?: TestModules | null; + @Input() testModules: TestModule[] = []; + // For initiate test run form tests should be displayed and disabled for change + @Input() disabled = false; + + get test_modules() { + return this.deviceForm?.controls['test_modules']! as FormArray; + } + + ngOnInit() { + this.fillTestModulesFormControls() + } + + fillTestModulesFormControls() { + this.test_modules.controls = []; + if (this.deviceTestModules) { + this.testModules.forEach(test => { + this.test_modules.push(new FormControl(this.deviceTestModules![test.name]?.enabled || false)); + }); + } else { + this.testModules.forEach(test => { + this.test_modules.push(new FormControl(test.enabled)); + }); + } + } + +} diff --git a/modules/ui/src/app/components/download-report/download-report.component.html b/modules/ui/src/app/components/download-report/download-report.component.html new file mode 100644 index 000000000..aab6d89ed --- /dev/null +++ b/modules/ui/src/app/components/download-report/download-report.component.html @@ -0,0 +1,11 @@ + + + + + diff --git a/modules/ui/src/app/components/download-report/download-report.component.scss b/modules/ui/src/app/components/download-report/download-report.component.scss new file mode 100644 index 000000000..23500eff1 --- /dev/null +++ b/modules/ui/src/app/components/download-report/download-report.component.scss @@ -0,0 +1,3 @@ +.download-report-link { + display: inline-block; +} diff --git a/modules/ui/src/app/components/download-report/download-report.component.spec.ts b/modules/ui/src/app/components/download-report/download-report.component.spec.ts new file mode 100644 index 000000000..5ed6e9940 --- /dev/null +++ b/modules/ui/src/app/components/download-report/download-report.component.spec.ts @@ -0,0 +1,98 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {DownloadReportComponent} from './download-report.component'; +import {MOCK_PROGRESS_DATA_COMPLIANT} from '../../mocks/progress.mock'; + +describe('DownloadReportComponent', () => { + let component: DownloadReportComponent; + let fixture: ComponentFixture; + + describe('Class tests', () => { + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [DownloadReportComponent] + }); + fixture = TestBed.createComponent(DownloadReportComponent); + component = fixture.componentInstance; + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('#getTestRunId should return data for title of link', () => { + const expectedResult = 'Delta 03-DIN-CPU 1.2.2 22 Jun 2023 9:20'; + + const result = component.getTestRunId(MOCK_PROGRESS_DATA_COMPLIANT); + + expect(result).toEqual(expectedResult); + }); + + it('#getReportTitle should return data for download property of link', () => { + const expectedResult = 'delta_03-din-cpu_1.2.2_compliant_22_jun_2023_9:20'; + + const result = component.getReportTitle(MOCK_PROGRESS_DATA_COMPLIANT); + + expect(result).toEqual(expectedResult); + }); + + it('#getFormattedDateString should return date as string in the format "d MMM y H:mm"', () => { + const expectedResult = '22 Jun 2023 9:20'; + + const result = component.getFormattedDateString(MOCK_PROGRESS_DATA_COMPLIANT.started); + + expect(result).toEqual(expectedResult); + }); + + it('#getFormattedDateString should return empty string when no date', () => { + const expectedResult = ''; + + const result = component.getFormattedDateString(null); + + expect(result).toEqual(expectedResult); + }); + }); + + describe('DOM tests', () => { + let compiled: HTMLElement; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [DownloadReportComponent] + }).compileComponents(); + fixture = TestBed.createComponent(DownloadReportComponent); + compiled = fixture.nativeElement as HTMLElement; + component = fixture.componentInstance; + }); + + describe('with not data provided', () => { + beforeEach(() => { + (component.data as any) = null; + fixture.detectChanges(); + }); + + it('should not have content', () => { + const downloadReportLink = compiled.querySelector('.download-report-link'); + + expect(downloadReportLink).toBeNull(); + }); + }); + + describe('with data provided', () => { + beforeEach(() => { + (component.data) = MOCK_PROGRESS_DATA_COMPLIANT; + fixture.detectChanges(); + }); + + it('should have download report link', () => { + const downloadReportLink = compiled.querySelector('.download-report-link') as HTMLAnchorElement; + + expect(downloadReportLink).not.toBeNull(); + expect(downloadReportLink.href).toEqual('https://api.testrun.io/report.pdf'); + expect(downloadReportLink.download).toEqual('delta_03-din-cpu_1.2.2_compliant_22_jun_2023_9:20'); + expect(downloadReportLink.title).toEqual('Download report for Test Run # Delta 03-DIN-CPU 1.2.2 22 Jun 2023 9:20'); + }); + }); + }); + +}); diff --git a/modules/ui/src/app/components/download-report/download-report.component.ts b/modules/ui/src/app/components/download-report/download-report.component.ts new file mode 100644 index 000000000..f74542609 --- /dev/null +++ b/modules/ui/src/app/components/download-report/download-report.component.ts @@ -0,0 +1,32 @@ +import {ChangeDetectionStrategy, Component, Input} from '@angular/core'; +import {TestrunStatus} from '../../model/testrun-status'; +import {CommonModule, DatePipe} from '@angular/common'; + +@Component({ + selector: 'app-download-report', + templateUrl: './download-report.component.html', + styleUrls: ['./download-report.component.scss'], + standalone: true, + imports: [CommonModule], + providers: [DatePipe], + changeDetection: ChangeDetectionStrategy.OnPush +}) +export class DownloadReportComponent { + @Input() data!: TestrunStatus; + + constructor(private datePipe: DatePipe) { + } + + getTestRunId(data: TestrunStatus) { + return `${data.device.manufacturer} ${data.device.model} ${data.device.firmware} ${this.getFormattedDateString(data.started)}`; + } + + getReportTitle(data: TestrunStatus) { + return `${data.device.manufacturer} ${data.device.model} ${data.device.firmware} ${data.status} ${this.getFormattedDateString(data.started)}`.replace(/ /g, "_").toLowerCase(); + } + + getFormattedDateString(date: string | null) { + return date ? this.datePipe.transform(date, 'd MMM y H:mm') : ''; + } + +} diff --git a/modules/ui/src/app/components/general-settings/general-settings.component.html b/modules/ui/src/app/components/general-settings/general-settings.component.html new file mode 100644 index 000000000..1082a36cb --- /dev/null +++ b/modules/ui/src/app/components/general-settings/general-settings.component.html @@ -0,0 +1,60 @@ +
+
+

Settings

+ +
+
+
+ + + + {{ interface }} + + + + + + {{ interface }} + + + + + Both interfaces must have different values + + +
+
+
+
+ + +
+ diff --git a/modules/ui/src/app/components/general-settings/general-settings.component.scss b/modules/ui/src/app/components/general-settings/general-settings.component.scss new file mode 100644 index 000000000..479559d7d --- /dev/null +++ b/modules/ui/src/app/components/general-settings/general-settings.component.scss @@ -0,0 +1,105 @@ +@use '@angular/material' as mat; +@import "../../../theming/colors"; + +:host { + display: flex; + flex-direction: column; + height: 100%; +} + +.setting-container-content { + flex: 1 0 auto; +} + +.settings-drawer-header { + display: flex; + justify-content: space-between; + align-items: center; + padding: 12px 12px 16px 24px; + + &-title { + margin: 0; + font-size: 22px; + font-style: normal; + font-weight: 400; + line-height: 28px; + } + + &-button { + min-width: 24px; + width: 24px; + height: 24px; + margin: 4px; + padding: 8px; + box-sizing: content-box; + + .close-button-icon { + width: 24px; + height: 24px; + margin: 0; + } + } +} + +.setting-drawer-content { + padding: 11px 16px 16px; +} + +.error-message-container { + display: block; +} + +.setting-form-label { + font-size: 18px; + + &.device-label { + display: inline-block; + padding-top: 16px; + } +} + +.setting-radio-group { + display: flex; + flex-direction: column; + margin-left: -10px; + align-items: flex-start; +} + +.setting-radio-button { + padding: 8px 0; + + ::ng-deep .mdc-form-field > label { + font-family: Roboto; + font-size: 16px; + font-style: normal; + font-weight: 400; + line-height: 24px; + letter-spacing: 0.1px; + color: $grey-800; + max-width: 240px; + overflow: hidden; + text-overflow: ellipsis; + } +} + +.setting-drawer-footer { + display: flex; + flex-shrink: 0; + justify-content: flex-end; + padding: 16px 24px 8px 24px; + + .close-button, .save-button { + padding: 0 24px; + font-size: 14px; + font-weight: 500; + line-height: 20px; + letter-spacing: 0.25px; + } + + .close-button { + margin-right: 10px; + &:enabled { + color: $secondary; + } + } +} diff --git a/modules/ui/src/app/components/general-settings/general-settings.component.spec.ts b/modules/ui/src/app/components/general-settings/general-settings.component.spec.ts new file mode 100644 index 000000000..8e8d09813 --- /dev/null +++ b/modules/ui/src/app/components/general-settings/general-settings.component.spec.ts @@ -0,0 +1,126 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {GeneralSettingsComponent} from './general-settings.component'; +import {TestRunService} from '../../test-run.service'; +import {of} from 'rxjs'; +import {SystemConfig} from '../../model/setting'; +import {MatRadioModule} from '@angular/material/radio'; +import {ReactiveFormsModule} from '@angular/forms'; +import {MatButtonModule} from '@angular/material/button'; +import {MatIcon, MatIconModule} from '@angular/material/icon'; +import {MatIconTestingModule} from '@angular/material/icon/testing'; + +const MOCK_SYSTEM_CONFIG_EMPTY: SystemConfig = { + network: { + device_intf: '', + internet_intf: '' + } +} + +const MOCK_SYSTEM_CONFIG_WITH_DATA: SystemConfig = { + network: { + device_intf: 'mockDeviceValue', + internet_intf: 'mockInternetValue' + } +}; + +describe('GeneralSettingsComponent', () => { + let component: GeneralSettingsComponent; + let fixture: ComponentFixture; + let testRunServiceMock: jasmine.SpyObj; + + beforeEach(async () => { + testRunServiceMock = jasmine.createSpyObj(['getSystemInterfaces', 'getSystemConfig', 'setSystemConfig', 'createSystemConfig']); + testRunServiceMock.getSystemInterfaces.and.returnValue(of([])); + testRunServiceMock.getSystemConfig.and.returnValue(of(MOCK_SYSTEM_CONFIG_EMPTY)); + testRunServiceMock.createSystemConfig.and.returnValue(of({})); + + await TestBed.configureTestingModule({ + declarations: [GeneralSettingsComponent, MatIcon], + providers: [{provide: TestRunService, useValue: testRunServiceMock}], + imports: [MatButtonModule, MatIconModule, MatRadioModule, ReactiveFormsModule, MatIconTestingModule] + }).compileComponents(); + + fixture = TestBed.createComponent(GeneralSettingsComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should call openSetting if not systemConfig data', () => { + spyOn(component.openSettingEvent, 'emit'); + + component.ngOnInit(); + + expect(component.openSettingEvent.emit).toHaveBeenCalled(); + }); + + it('should set default values to form if systemConfig data', () => { + testRunServiceMock.getSystemConfig.and.returnValue(of(MOCK_SYSTEM_CONFIG_WITH_DATA)); + + component.ngOnInit(); + + expect(component.deviceControl.value).toBe(MOCK_SYSTEM_CONFIG_WITH_DATA.network.device_intf); + expect(component.internetControl.value).toBe(MOCK_SYSTEM_CONFIG_WITH_DATA.network.internet_intf); + }); + + describe('#closeSetting', () => { + beforeEach(() => { + testRunServiceMock.systemConfig$ = of(MOCK_SYSTEM_CONFIG_WITH_DATA); + }); + + it('should emit closeSettingEvent', () => { + spyOn(component.closeSettingEvent, 'emit'); + + component.closeSetting(); + + expect(component.closeSettingEvent.emit).toHaveBeenCalled(); + }); + + it('should call reset settingForm', () => { + spyOn(component.settingForm, 'reset'); + + component.closeSetting(); + + expect(component.settingForm.reset).toHaveBeenCalled(); + }); + + it('should set value of settingForm on setSystemSetting', () => { + component.closeSetting(); + + expect(component.settingForm.value).toEqual(MOCK_SYSTEM_CONFIG_WITH_DATA.network); + }); + }); + + describe('#saveSetting', () => { + beforeEach(() => { + testRunServiceMock.systemConfig$ = of(MOCK_SYSTEM_CONFIG_WITH_DATA); + }); + + it('should have form error if form has the same value', () => { + const mockSameValue = 'sameValue'; + component.deviceControl.setValue(mockSameValue); + component.internetControl.setValue(mockSameValue); + + component.saveSetting(); + + expect(component.settingForm.invalid).toBeTrue(); + expect(component.isSubmitting).toBeTrue(); + expect(component.isFormError).toBeTrue(); + }); + + it('should call createSystemConfig when setting form valid', () => { + const {device_intf, internet_intf} = MOCK_SYSTEM_CONFIG_WITH_DATA.network; + component.deviceControl.setValue(device_intf); + component.internetControl.setValue(internet_intf); + + component.saveSetting(); + + expect(component.settingForm.invalid).toBeFalse(); + expect(testRunServiceMock.createSystemConfig).toHaveBeenCalledWith(MOCK_SYSTEM_CONFIG_WITH_DATA); + }); + }); +}); diff --git a/modules/ui/src/app/components/general-settings/general-settings.component.ts b/modules/ui/src/app/components/general-settings/general-settings.component.ts new file mode 100644 index 000000000..0e3900da4 --- /dev/null +++ b/modules/ui/src/app/components/general-settings/general-settings.component.ts @@ -0,0 +1,150 @@ +import {Component, EventEmitter, OnDestroy, OnInit, Output} from '@angular/core'; +import {FormBuilder, FormControl, FormGroup, Validators} from '@angular/forms'; +import {Subject, takeUntil, tap} from 'rxjs'; +import {TestRunService} from '../../test-run.service'; +import {OnlyDifferentValuesValidator} from './only-different-values.validator'; + +@Component({ + selector: 'app-general-settings', + templateUrl: './general-settings.component.html', + styleUrls: ['./general-settings.component.scss'] +}) +export class GeneralSettingsComponent implements OnInit, OnDestroy { + @Output() closeSettingEvent = new EventEmitter(); + @Output() openSettingEvent = new EventEmitter(); + public readonly systemInterfaces$ = this.testRunService.getSystemInterfaces(); + public settingForm!: FormGroup; + public isSubmitting = false; + public hasSetting = false; + private destroy$: Subject = new Subject(); + + get deviceControl(): FormControl { + return this.settingForm.get('device_intf') as FormControl; + } + + get internetControl(): FormControl { + return this.settingForm.get('internet_intf') as FormControl; + } + + get isFormValues(): boolean { + return this.internetControl.value && this.deviceControl.value; + } + + get isFormError(): boolean { + return this.settingForm.hasError('hasSameValues'); + } + + constructor( + private readonly testRunService: TestRunService, + private readonly fb: FormBuilder, + private readonly onlyDifferentValuesValidator: OnlyDifferentValuesValidator + ) { + } + + ngOnInit() { + this.createSettingForm(); + + this.setSettingView(); + + this.cleanFormErrorMessage(); + } + + closeSetting(): void { + this.resetForm(); + this.closeSettingEvent.emit(); + this.setSystemSetting(); + } + + saveSetting(): void { + if (this.settingForm.invalid) { + this.isSubmitting = true; + this.settingForm.markAllAsTouched(); + } else { + this.createSystemConfig(); + } + } + + private createSettingForm(): FormGroup { + return this.settingForm = this.fb.group({ + device_intf: ['', Validators.required], + internet_intf: ['', Validators.required], + }, + { + validators: [this.onlyDifferentValuesValidator.onlyDifferentSetting()], + updateOn: 'change', + } + ) + } + + private setSettingView(): void { + this.testRunService.getSystemConfig() + .pipe(takeUntil(this.destroy$)) + .subscribe( + config => { + const {device_intf, internet_intf} = config.network; + if (device_intf && internet_intf) { + this.setDefaultFormValues(device_intf, internet_intf); + this.hasSetting = true; + } else { + this.openSetting(); + } + this.testRunService.setSystemConfig(config); + } + ); + } + + private setDefaultFormValues(device: string, internet: string): void { + this.deviceControl.setValue(device); + this.internetControl.setValue(internet); + } + + private cleanFormErrorMessage(): void { + this.settingForm.valueChanges + .pipe( + takeUntil(this.destroy$), + tap(() => this.isSubmitting = false), + ).subscribe(); + } + + private createSystemConfig(): void { + const {device_intf, internet_intf} = this.settingForm.value; + const data = { + network: { + device_intf, + internet_intf + } + } + + this.testRunService.createSystemConfig(data) + .pipe(takeUntil(this.destroy$)) + .subscribe(() => { + this.closeSetting(); + this.testRunService.setSystemConfig(data); + this.hasSetting = true; + }); + } + + private openSetting(): void { + this.openSettingEvent.emit(); + } + + private setSystemSetting(): void { + this.testRunService.systemConfig$ + .pipe(takeUntil(this.destroy$)) + .subscribe(config => { + const {device_intf, internet_intf} = config.network; + if (device_intf && internet_intf) { + this.setDefaultFormValues(device_intf, internet_intf); + } + }) + } + + private resetForm(): void { + this.settingForm.reset(); + } + + ngOnDestroy() { + this.destroy$.next(true); + this.destroy$.unsubscribe(); + } +} diff --git a/modules/ui/src/app/components/general-settings/only-different-values.validator.ts b/modules/ui/src/app/components/general-settings/only-different-values.validator.ts new file mode 100644 index 000000000..c075b5578 --- /dev/null +++ b/modules/ui/src/app/components/general-settings/only-different-values.validator.ts @@ -0,0 +1,29 @@ +import {Injectable} from '@angular/core'; +import {AbstractControl, FormControl, ValidationErrors, ValidatorFn} from '@angular/forms'; + +@Injectable({providedIn: 'root'}) + +export class OnlyDifferentValuesValidator { + public onlyDifferentSetting(): ValidatorFn { + return (form: AbstractControl): ValidationErrors | null => { + const deviceControl = form.get('device_intf') as FormControl; + const internetControl = form.get('internet_intf') as FormControl; + + if (!deviceControl || !internetControl) { + return null; + } + + const deviceControlValue = deviceControl.value; + const internetControlValue = internetControl.value; + + if (!deviceControlValue || !internetControlValue) { + return null; + } + + if (deviceControlValue === internetControlValue) { + return {'hasSameValues': true} + } + return null; + } + } +} diff --git a/modules/ui/src/app/device-repository/device-form/device-form.component.html b/modules/ui/src/app/device-repository/device-form/device-form.component.html new file mode 100644 index 000000000..dfa6d9924 --- /dev/null +++ b/modules/ui/src/app/device-repository/device-form/device-form.component.html @@ -0,0 +1,45 @@ +
+ {{data.title}} + + Device Manufacturer + + Please enter device manufacturer name + + Device Manufacturer is required + + + + Device Model + + Please enter device name + + Device Model is required + + + + MAC address + + Please enter MAC address + + MAC address is required + + + Please, check. A MAC address consists of 12 hexadecimal digits (0 to 9, a to f, or A to F). + + + + + + + {{error$| async}} + + + + + + +
diff --git a/modules/ui/src/app/device-repository/device-form/device-form.component.scss b/modules/ui/src/app/device-repository/device-form/device-form.component.scss new file mode 100644 index 000000000..0d54182b3 --- /dev/null +++ b/modules/ui/src/app/device-repository/device-form/device-form.component.scss @@ -0,0 +1,46 @@ +@import "../../../theming/colors"; + +$device-form-max-width: 549px; +$device-form-min-width: 285px; + +:host { + display: grid; + grid-template-rows: 1fr; + overflow: auto; + grid-template-columns: minmax(285px, $device-form-max-width); +} + +.device-form { + display: grid; + padding: 24px; + max-width: $device-form-max-width; + min-width: $device-form-min-width; + gap: 10px; + overflow: auto; +} + +.device-form-title { + color: $grey-800; + font-size: 22px; + line-height: 28px; + padding-bottom: 14px; +} + +.device-form-test-modules { + overflow: auto; + min-height: 78px; +} + +.device-form-actions { + padding: 0; + min-height: 30px; +} + +.close-button { + color: #5F6368; +} + +.device-form-mac-address-error { + white-space: nowrap; + margin-left: -22px; +} diff --git a/modules/ui/src/app/device-repository/device-form/device-form.component.spec.ts b/modules/ui/src/app/device-repository/device-form/device-form.component.spec.ts new file mode 100644 index 000000000..33495f0cc --- /dev/null +++ b/modules/ui/src/app/device-repository/device-form/device-form.component.spec.ts @@ -0,0 +1,369 @@ +import {ComponentFixture, fakeAsync, flush, TestBed} from '@angular/core/testing'; + +import {DeviceFormComponent} from './device-form.component'; +import {TestRunService} from '../../test-run.service'; +import {MatButtonModule} from '@angular/material/button'; +import {FormControl, ReactiveFormsModule} from '@angular/forms'; +import {MatCheckboxModule} from '@angular/material/checkbox'; +import {MatInputModule} from '@angular/material/input'; +import {MAT_DIALOG_DATA, MatDialogModule, MatDialogRef} from '@angular/material/dialog'; +import {BrowserAnimationsModule} from '@angular/platform-browser/animations'; +import {Device} from '../../model/device'; +import {of, throwError} from 'rxjs'; +import {DeviceTestsComponent} from '../../components/device-tests/device-tests.component'; + +describe('DeviceFormComponent', () => { + let component: DeviceFormComponent; + let fixture: ComponentFixture; + let testRunServiceMock: jasmine.SpyObj; + let compiled: HTMLElement; + + beforeEach(() => { + testRunServiceMock = jasmine.createSpyObj(['getTestModules', 'hasDevice', 'saveDevice']); + testRunServiceMock.getTestModules.and.returnValue([ + { + displayName: "Connection", + name: "connection", + enabled: true + }, + { + displayName: "Smart Ready", + name: "udmi", + enabled: false + }, + ]); + TestBed.configureTestingModule({ + declarations: [DeviceFormComponent], + providers: [ + { + provide: TestRunService, + useValue: testRunServiceMock + }, + { + provide: MatDialogRef, + useValue: { + close: (result: any) => { + } + } + }, + {provide: MAT_DIALOG_DATA, useValue: {}},], + imports: [MatButtonModule, ReactiveFormsModule, MatCheckboxModule, MatInputModule, MatDialogModule, BrowserAnimationsModule, DeviceTestsComponent] + }); + fixture = TestBed.createComponent(DeviceFormComponent); + component = fixture.componentInstance; + compiled = fixture.nativeElement as HTMLElement; + component.data = {}; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should contain device form', () => { + const form = compiled.querySelector('.device-form'); + + expect(form).toBeTruthy(); + }); + + it('should close dialog on "cancel" click', () => { + const closeSpy = spyOn(component.dialogRef, 'close'); + const closeButton = compiled.querySelector('.close-button') as HTMLButtonElement; + + closeButton?.click(); + + expect(closeSpy).toHaveBeenCalledWith(); + + closeSpy.calls.reset(); + }); + + it('should not save data when fields are empty', () => { + const closeSpy = spyOn(component.dialogRef, 'close'); + const saveButton = compiled.querySelector('.save-button') as HTMLButtonElement; + const model: HTMLInputElement = compiled.querySelector('.device-form-model')!; + const manufacturer: HTMLInputElement = compiled.querySelector('.device-form-manufacturer')!; + const macAddress: HTMLInputElement = compiled.querySelector('.device-form-mac-address')!; + + ['', ' '].forEach(value => { + model.value = value; + model.dispatchEvent(new Event('input')); + manufacturer.value = value; + manufacturer.dispatchEvent(new Event('input')); + macAddress.value = value; + macAddress.dispatchEvent(new Event('input')); + saveButton?.click(); + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const requiredErrors = compiled.querySelectorAll('mat-error')!; + expect(requiredErrors.length).toEqual(3); + + requiredErrors.forEach(error => { + expect(error?.innerHTML).toContain('required'); + }) + }); + + expect(closeSpy).not.toHaveBeenCalled(); + + closeSpy.calls.reset(); + }); + }); + + it('should not save data if no test selected', fakeAsync(() => { + const closeSpy = spyOn(component.dialogRef, 'close'); + component.model.setValue('model'); + component.manufacturer.setValue('manufacturer'); + component.mac_addr.setValue('07:07:07:07:07:07'); + component.test_modules.setValue([false, false]); + testRunServiceMock.hasDevice.and.returnValue(true); + + component.saveDevice(); + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const error = compiled.querySelector('mat-error')!; + expect(error.innerHTML).toContain('At least one test has to be selected.'); + }); + + expect(closeSpy).not.toHaveBeenCalled(); + + closeSpy.calls.reset(); + flush(); + })); + + it('should not save data when device with mac address is already exist', fakeAsync(() => { + const closeSpy = spyOn(component.dialogRef, 'close'); + component.model.setValue('model'); + component.manufacturer.setValue('manufacturer'); + component.mac_addr.setValue('07:07:07:07:07:07'); + testRunServiceMock.hasDevice.and.returnValue(true); + + component.saveDevice(); + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const error = compiled.querySelector('mat-error')!; + expect(error.innerHTML).toContain('This MAC address is already used for another device in the repository.'); + }); + + expect(closeSpy).not.toHaveBeenCalled(); + + closeSpy.calls.reset(); + flush(); + })); + + it('should not save data when server response with error', fakeAsync(() => { + const closeSpy = spyOn(component.dialogRef, 'close'); + component.model.setValue('model'); + component.manufacturer.setValue('manufacturer'); + component.mac_addr.setValue('07:07:07:07:07:07'); + testRunServiceMock.hasDevice.and.returnValue(false); + testRunServiceMock.saveDevice.and.returnValue(throwError({error: 'some error'})); + + component.saveDevice(); + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const error = compiled.querySelector('mat-error')!; + expect(error.innerHTML).toContain('some error'); + }); + expect(closeSpy).not.toHaveBeenCalled(); + + closeSpy.calls.reset(); + flush(); + })); + + it('should save data when form is valid', () => { + const device: Device = { + "manufacturer": "manufacturer", + "model": "model", + "mac_addr": "07:07:07:07:07:07", + "test_modules": { + "connection": { + "enabled": true + }, + "udmi": { + "enabled": false + } + } + }; + const closeSpy = spyOn(component.dialogRef, 'close'); + component.model.setValue('model'); + component.manufacturer.setValue('manufacturer'); + component.mac_addr.setValue('07:07:07:07:07:07'); + testRunServiceMock.hasDevice.and.returnValue(false); + testRunServiceMock.saveDevice.and.returnValue(of(true)); + + component.saveDevice(); + + expect(closeSpy).toHaveBeenCalledTimes(1); + expect(closeSpy).toHaveBeenCalledWith(device); + + closeSpy.calls.reset(); + }); + + describe('test modules', () => { + it('should be present', () => { + const test = compiled.querySelectorAll('mat-checkbox'); + + expect(test.length).toEqual(2); + }); + + it('should be enabled', () => { + const testsForm = compiled.querySelector('app-device-tests form'); + + expect(testsForm?.classList.contains('disabled')).toEqual(false); + }); + }); + + describe('device model', () => { + it('should not contain errors when input is correct', fakeAsync(() => { + const model: HTMLInputElement = compiled.querySelector('.device-form-model')!; + ['model', 'Gebäude', 'jardín'].forEach(value => { + model.value = value; + model.dispatchEvent(new Event('input')); + + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const errors = component.model.errors; + const uiValue = model.value; + const formValue = component.model.value; + + expect(uiValue).toEqual(formValue); + expect(errors).toBeNull(); + }); + + flush(); + }); + + })); + }); + + describe('device manufacturer', () => { + it('should not contain errors when input is correct', fakeAsync(() => { + const manufacturer: HTMLInputElement = compiled.querySelector('.device-form-manufacturer')!; + ['manufacturer', 'Gebäude', 'jardín'].forEach(value => { + manufacturer.value = value; + manufacturer.dispatchEvent(new Event('input')); + + fixture.whenStable().then(() => { + const errors = component.manufacturer.errors; + const uiValue = manufacturer.value; + const formValue = component.manufacturer.value; + + expect(uiValue).toEqual(formValue); + expect(errors).toBeNull(); + }); + + flush(); + }) + })); + }); + + describe('mac address', () => { + it('should not contain errors when input is correct', fakeAsync(() => { + const macAddress: HTMLInputElement = compiled.querySelector('.device-form-mac-address')!; + ['07:07:07:07:07:07', ' 07:07:07:07:07:07 '].forEach(value => { + macAddress.value = value; + macAddress.dispatchEvent(new Event('input')); + + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const errors = component.mac_addr.errors; + const uiValue = macAddress.value; + const formValue = component.mac_addr.value; + + expect(uiValue).toEqual(formValue); + expect(errors).toBeNull(); + }); + + flush(); + }) + })); + + it('should have "pattern" error when field does not satisfy pattern', fakeAsync(() => { + const macAddress: HTMLInputElement = compiled.querySelector('.device-form-mac-address')!; + ['value', '001e423573c4', ' '].forEach(value => { + macAddress.value = value; + macAddress.dispatchEvent(new Event('input')); + component.mac_addr.markAsTouched(); + + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const macAddressError = compiled.querySelector('mat-error')!.innerHTML; + const error = component.mac_addr.errors!['pattern']; + + expect(error).toBeTruthy(); + expect(macAddressError).toContain('Please, check. A MAC address consists of 12 hexadecimal digits (0 to 9, a to f, or A to F).'); + }); + + flush(); + }) + })); + }); + + describe('when device is present', () => { + beforeEach(() => { + component.data = { + device: { + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "udmi": { + "enabled": true, + } + } + } + } + component.ngOnInit(); + fixture.detectChanges(); + }); + + it('should fill form values with device values', () => { + const model: HTMLInputElement = compiled.querySelector('.device-form-model')!; + const manufacturer: HTMLInputElement = compiled.querySelector('.device-form-manufacturer')!; + const macAddress: HTMLInputElement = compiled.querySelector('.device-form-mac-address')!; + + expect(model.value).toEqual('O3-DIN-CPU'); + expect(manufacturer.value).toEqual('Delta'); + expect(macAddress.value).toEqual('00:1e:42:35:73:c4'); + }); + + it('should save data even mac address already exist', fakeAsync(() => { + const closeSpy = spyOn(component.dialogRef, 'close'); + testRunServiceMock.saveDevice.and.returnValue(of(true)); + testRunServiceMock.hasDevice.and.returnValue(true); + // fill the test controls + component.test_modules.push(new FormControl(false)); + component.test_modules.push(new FormControl(true)); + component.saveDevice(); + fixture.detectChanges(); + + fixture.whenStable().then(() => { + const error = compiled.querySelector('mat-error')!; + expect(error).toBeFalse(); + }); + + expect(closeSpy).toHaveBeenCalledWith({ + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "connection": { + "enabled": false, + }, + "udmi": { + "enabled": true, + } + } + }); + + closeSpy.calls.reset(); + flush(); + })); + }); +}); diff --git a/modules/ui/src/app/device-repository/device-form/device-form.component.ts b/modules/ui/src/app/device-repository/device-form/device-form.component.ts new file mode 100644 index 000000000..342f83264 --- /dev/null +++ b/modules/ui/src/app/device-repository/device-form/device-form.component.ts @@ -0,0 +1,151 @@ +import {Component, Inject, OnDestroy, OnInit} from '@angular/core'; +import {AbstractControl, FormArray, FormBuilder, FormGroup, Validators} from '@angular/forms'; +import {MAT_DIALOG_DATA, MatDialogRef} from '@angular/material/dialog'; +import {Device, TestModule} from '../../model/device'; +import {TestRunService} from '../../test-run.service'; +import {DeviceStringFormatValidator} from './device-string-format.validator'; +import {catchError, of, retry, Subject, takeUntil} from 'rxjs'; +import {BehaviorSubject} from 'rxjs/internal/BehaviorSubject'; + +const MAC_ADDRESS_PATTERN = '^[\\s]*[a-fA-F0-9]{2}(?:[:][a-fA-F0-9]{2}){5}[\\s]*$'; + +interface DialogData { + title?: string; + device?: Device; +} + +@Component({ + selector: 'app-device-form', + templateUrl: './device-form.component.html', + styleUrls: ['./device-form.component.scss'] +}) +export class DeviceFormComponent implements OnInit, OnDestroy { + deviceForm!: FormGroup; + testModules: TestModule[] = []; + error$: BehaviorSubject = new BehaviorSubject(null); + private destroy$: Subject = new Subject(); + + constructor( + public dialogRef: MatDialogRef, + @Inject(MAT_DIALOG_DATA) public data: DialogData, + private fb: FormBuilder, + private testRunService: TestRunService, + private deviceStringFormatValidator: DeviceStringFormatValidator, + ) { + } + + get model() { + return this.deviceForm.get('model')!; + } + + get manufacturer() { + return this.deviceForm.get('manufacturer')!; + } + + get mac_addr() { + return this.deviceForm.get('mac_addr')!; + } + + get test_modules() { + return this.deviceForm.controls['test_modules']! as FormArray; + } + + ngOnInit() { + this.createDeviceForm(); + this.testModules = this.testRunService.getTestModules(); + if (this.data.device) { + this.model.setValue(this.data.device.model); + this.manufacturer.setValue(this.data.device.manufacturer); + this.mac_addr.setValue(this.data.device.mac_addr); + } + } + + ngOnDestroy() { + this.destroy$.next(true); + this.destroy$.unsubscribe(); + } + + cancel(): void { + this.dialogRef.close(); + } + + saveDevice() { + this.checkMandatoryFields(); + if (this.deviceForm.invalid) { + this.deviceForm.markAllAsTouched(); + return; + } + + if (this.isAllTestsDisabled()) { + this.error$.next('At least one test has to be selected.'); + return; + } + + if (!this.data.device && this.testRunService.hasDevice(this.mac_addr.value)) { + this.error$.next('This MAC address is already used for another device in the repository.'); + return; + } + + const device = this.createDeviceFromForm(); + + this.testRunService.saveDevice(device) + .pipe( + takeUntil(this.destroy$), + retry(1), + catchError(error => { + this.error$.next(error.error); + return of(null); + })) + .subscribe((deviceSaved: boolean | null) => { + if (deviceSaved) { + this.dialogRef.close(device); + } + }); + } + + private isAllTestsDisabled(): boolean { + return this.deviceForm.value.test_modules.every((enabled: boolean) => { + return !enabled; + }); + } + + private createDeviceFromForm(): Device { + const testModules: { [key: string]: { enabled: boolean } } = {}; + this.deviceForm.value.test_modules.forEach((enabled: boolean, i: number) => { + testModules[this.testModules[i]?.name] = { + enabled: enabled + } + }); + return { + model: this.model.value.trim(), + manufacturer: this.manufacturer.value.trim(), + mac_addr: this.mac_addr.value.trim(), + test_modules: testModules + } as Device; + } + + /** + * Model, manufacturer, MAC address are mandatory. + * It should be checked on submit. Other validation happens on blur. + */ + private checkMandatoryFields() { + this.setRequiredErrorIfEmpty(this.model); + this.setRequiredErrorIfEmpty(this.manufacturer); + this.setRequiredErrorIfEmpty(this.mac_addr); + } + + private setRequiredErrorIfEmpty(control: AbstractControl) { + if (!control.value.trim()) { + control.setErrors({required: true}); + } + } + + private createDeviceForm() { + this.deviceForm = this.fb.group({ + model: ['', [this.deviceStringFormatValidator.deviceStringFormat()]], + manufacturer: ['', [this.deviceStringFormatValidator.deviceStringFormat()]], + mac_addr: ['', [Validators.pattern(MAC_ADDRESS_PATTERN)]], + test_modules: new FormArray([]) + }); + } +} diff --git a/modules/ui/src/app/device-repository/device-form/device-string-format.validator.ts b/modules/ui/src/app/device-repository/device-form/device-string-format.validator.ts new file mode 100644 index 000000000..b98b1d4f0 --- /dev/null +++ b/modules/ui/src/app/device-repository/device-form/device-string-format.validator.ts @@ -0,0 +1,23 @@ +import {Injectable} from '@angular/core'; +import {AbstractControl, ValidationErrors, ValidatorFn} from '@angular/forms'; + +@Injectable({providedIn: 'root'}) + +/** + * Validator uses for Device Name and Device Manufacturer inputs + */ +export class DeviceStringFormatValidator { + + readonly STRING_FORMAT_REGEXP = new RegExp('^([a-z0-9\\p{L}\\p{M}.\',-_ ]{1,64})$', 'u'); + + public deviceStringFormat(): ValidatorFn { + return (control: AbstractControl): ValidationErrors | null => { + const value = control.value?.trim(); + if (value) { + let result = this.STRING_FORMAT_REGEXP.test(value); + return !result ? {'invalid_format': true} : null; + } + return null; + } + } +} diff --git a/modules/ui/src/app/device-repository/device-repository-routing.module.ts b/modules/ui/src/app/device-repository/device-repository-routing.module.ts new file mode 100644 index 000000000..79f2d1d14 --- /dev/null +++ b/modules/ui/src/app/device-repository/device-repository-routing.module.ts @@ -0,0 +1,12 @@ +import {NgModule} from '@angular/core'; +import {RouterModule, Routes} from '@angular/router'; +import {DeviceRepositoryComponent} from './device-repository.component'; + +const routes: Routes = [{path: '', component: DeviceRepositoryComponent}]; + +@NgModule({ + imports: [RouterModule.forChild(routes)], + exports: [RouterModule] +}) +export class DeviceRepositoryRoutingModule { +} diff --git a/modules/ui/src/app/device-repository/device-repository.component.html b/modules/ui/src/app/device-repository/device-repository.component.html new file mode 100644 index 000000000..f7e27265f --- /dev/null +++ b/modules/ui/src/app/device-repository/device-repository.component.html @@ -0,0 +1,25 @@ + + + Device Repository + + +
+ + + +
+ + + +
+ +
+ + + + + diff --git a/modules/ui/src/app/device-repository/device-repository.component.scss b/modules/ui/src/app/device-repository/device-repository.component.scss new file mode 100644 index 000000000..3c969f181 --- /dev/null +++ b/modules/ui/src/app/device-repository/device-repository.component.scss @@ -0,0 +1,32 @@ +@import "../../theming/colors"; +@import "../../theming/variables"; + +:host { + overflow: hidden; + flex-direction: column; + display: flex; +} + +.device-repository-content-empty { + height: 100%; + display: flex; + align-items: center; + justify-content: center; +} + +.device-repository-toolbar { + padding-left: 41px; + gap: 10px; + background: $white; + height: 76px; +} + +.device-repository-content { + align-content: start; + padding: 24px; + display: grid; + grid-template-columns: repeat(auto-fit, $device-item-width); + gap: 16px; + overflow-y: auto; + height: 100%; +} diff --git a/modules/ui/src/app/device-repository/device-repository.component.spec.ts b/modules/ui/src/app/device-repository/device-repository.component.spec.ts new file mode 100644 index 000000000..46e6704bd --- /dev/null +++ b/modules/ui/src/app/device-repository/device-repository.component.spec.ts @@ -0,0 +1,174 @@ +import {ComponentFixture, fakeAsync, TestBed} from '@angular/core/testing'; +import {of} from 'rxjs'; +import {Device} from '../model/device'; +import {TestRunService} from '../test-run.service'; + +import {DeviceRepositoryComponent} from './device-repository.component'; +import {DeviceRepositoryModule} from './device-repository.module'; +import {BrowserAnimationsModule} from '@angular/platform-browser/animations'; +import {DeviceFormComponent} from './device-form/device-form.component'; +import {MatDialogRef} from '@angular/material/dialog'; +import {BehaviorSubject} from 'rxjs/internal/BehaviorSubject'; +import SpyObj = jasmine.SpyObj; +import {device} from '../mocks/device.mock'; + +describe('DeviceRepositoryComponent', () => { + let service: TestRunService; + let component: DeviceRepositoryComponent; + let fixture: ComponentFixture; + let compiled: HTMLElement; + let mockService: SpyObj; + + beforeEach(() => { + mockService = jasmine.createSpyObj(['getDevices', 'fetchDevices', 'setDevices', 'getTestModules', 'addDevice', 'updateDevice']); + mockService.getDevices.and.returnValue(new BehaviorSubject([])); + mockService.getTestModules.and.returnValue([ + { + displayName: "Connection", + name: "connection", + enabled: true + }, + { + displayName: "Smart Ready", + name: "udmi", + enabled: false + }, + ]); + + TestBed.configureTestingModule({ + imports: [DeviceRepositoryModule, BrowserAnimationsModule], + providers: [{provide: TestRunService, useValue: mockService}], + declarations: [DeviceRepositoryComponent] + }); + fixture = TestBed.createComponent(DeviceRepositoryComponent); + component = fixture.componentInstance; + compiled = fixture.nativeElement as HTMLElement; + service = fixture.debugElement.injector.get(TestRunService); + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + describe('with no devices devices', () => { + beforeEach(() => { + mockService.getDevices = jasmine.createSpy().and.returnValue(of([])); + component.ngOnInit(); + }); + + it('should show only add device button if no device added', () => { + fixture.detectChanges(); + const button = compiled.querySelector('.device-repository-content-empty button'); + + expect(button).toBeTruthy(); + }); + }); + + describe('with devices', () => { + beforeEach(() => { + mockService.getDevices.and.returnValue(new BehaviorSubject([device, device, device])); + component.ngOnInit(); + }); + + it('should show device item', fakeAsync(() => { + fixture.detectChanges(); + const item = compiled.querySelectorAll('app-device-item'); + + expect(item.length).toEqual(3); + })); + + it('should open device dialog on item click', () => { + const openSpy = spyOn(component.dialog, 'open').and + .returnValue({ + afterClosed: () => of(true) + } as MatDialogRef); + fixture.detectChanges(); + + component.openDialog(device); + + expect(openSpy).toHaveBeenCalled(); + expect(openSpy).toHaveBeenCalledWith(DeviceFormComponent, { + data: { + device: device, + title: 'Edit device' + }, + autoFocus: true, + hasBackdrop: true, + disableClose: true, + panelClass: 'device-form-dialog' + }); + + openSpy.calls.reset(); + }); + }); + + it('should open device dialog on "add device button click"', () => { + const openSpy = spyOn(component.dialog, 'open').and + .returnValue({ + afterClosed: () => of(true) + } as MatDialogRef); + fixture.detectChanges(); + const button = compiled.querySelector('.device-repository-content-empty button') as HTMLButtonElement; + button?.click(); + + expect(button).toBeTruthy(); + expect(openSpy).toHaveBeenCalled(); + expect(openSpy).toHaveBeenCalledWith(DeviceFormComponent, { + data: {device: null, title: 'Create device'}, + autoFocus: true, + hasBackdrop: true, + disableClose: true, + panelClass: 'device-form-dialog' + }); + + openSpy.calls.reset(); + }); + + it('should not add device if dialog closes with null', () => { + spyOn(component.dialog, 'open').and + .returnValue({ + afterClosed: () => of(null) + } as MatDialogRef); + mockService.addDevice.and.callThrough(); + + component.openDialog(); + + expect(mockService.addDevice).not.toHaveBeenCalled(); + }); + + it('should add device if dialog closes with object', () => { + const device = { + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": true + }, + "ntp": { + "enabled": false + }, + "baseline": { + "enabled": false + }, + "nmap": { + "enabled": false + } + } + } as Device; + spyOn(component.dialog, 'open').and + .returnValue({ + afterClosed: () => of(device) + } as MatDialogRef); + mockService.addDevice.and.callThrough(); + + component.openDialog(); + + expect(mockService.addDevice).toHaveBeenCalledWith(device); + }); + +}); diff --git a/modules/ui/src/app/device-repository/device-repository.component.ts b/modules/ui/src/app/device-repository/device-repository.component.ts new file mode 100644 index 000000000..e0c5441e1 --- /dev/null +++ b/modules/ui/src/app/device-repository/device-repository.component.ts @@ -0,0 +1,53 @@ +import {Component, OnInit} from '@angular/core'; +import {MatDialog} from '@angular/material/dialog'; +import {Observable} from 'rxjs/internal/Observable'; +import {Device} from '../model/device'; +import {TestRunService} from '../test-run.service'; +import {DeviceFormComponent} from './device-form/device-form.component'; +import {Subject, takeUntil} from 'rxjs'; + +@Component({ + selector: 'app-device-repository', + templateUrl: './device-repository.component.html', + styleUrls: ['./device-repository.component.scss'], +}) +export class DeviceRepositoryComponent implements OnInit { + devices$!: Observable; + private destroy$: Subject = new Subject(); + + constructor(private testRunService: TestRunService, public dialog: MatDialog) { + } + + ngOnInit(): void { + this.devices$ = this.testRunService.getDevices(); + } + + ngOnDestroy() { + this.destroy$.next(true); + this.destroy$.unsubscribe(); + } + + openDialog(selectedDevice?: Device): void { + const dialogRef = this.dialog.open(DeviceFormComponent, { + data: { + device: selectedDevice || null, + title: selectedDevice ? 'Edit device' : 'Create device' + }, + autoFocus: true, + hasBackdrop: true, + disableClose: true, + panelClass: 'device-form-dialog' + }); + + dialogRef?.afterClosed() + .pipe(takeUntil(this.destroy$)) + .subscribe(device => { + if (!selectedDevice && device) { + this.testRunService.addDevice(device); + } + if (selectedDevice && device) { + this.testRunService.updateDevice(selectedDevice, device); + } + }); + } +} diff --git a/modules/ui/src/app/device-repository/device-repository.module.ts b/modules/ui/src/app/device-repository/device-repository.module.ts new file mode 100644 index 000000000..70765aebc --- /dev/null +++ b/modules/ui/src/app/device-repository/device-repository.module.ts @@ -0,0 +1,41 @@ +import {ScrollingModule} from '@angular/cdk/scrolling'; +import {CommonModule} from '@angular/common'; +import {HttpClientModule} from '@angular/common/http'; +import {NgModule} from '@angular/core'; +import {ReactiveFormsModule} from '@angular/forms'; +import {MatButtonModule} from '@angular/material/button'; +import {MatCheckboxModule} from '@angular/material/checkbox'; +import {MatDialogModule} from '@angular/material/dialog'; +import {MatIconModule} from '@angular/material/icon'; +import {MatInputModule} from '@angular/material/input'; +import {MatToolbarModule} from '@angular/material/toolbar'; +import {DeviceFormComponent} from './device-form/device-form.component'; + +import {DeviceRepositoryRoutingModule} from './device-repository-routing.module'; +import {DeviceRepositoryComponent} from './device-repository.component'; +import {DeviceItemComponent} from '../components/device-item/device-item.component'; +import {DeviceTestsComponent} from '../components/device-tests/device-tests.component'; + +@NgModule({ + declarations: [ + DeviceRepositoryComponent, + DeviceFormComponent, + ], + imports: [ + CommonModule, + DeviceRepositoryRoutingModule, + MatToolbarModule, + MatButtonModule, + MatIconModule, + ScrollingModule, + HttpClientModule, + MatDialogModule, + ReactiveFormsModule, + MatCheckboxModule, + MatInputModule, + DeviceItemComponent, + DeviceTestsComponent, + ], +}) +export class DeviceRepositoryModule { +} diff --git a/modules/ui/src/app/guards/allow-to-run-test.guard.spec.ts b/modules/ui/src/app/guards/allow-to-run-test.guard.spec.ts new file mode 100644 index 000000000..f60f148de --- /dev/null +++ b/modules/ui/src/app/guards/allow-to-run-test.guard.spec.ts @@ -0,0 +1,46 @@ +import {TestBed} from '@angular/core/testing'; +import {Router} from '@angular/router'; + +import {allowToRunTestGuard} from './allow-to-run-test.guard'; +import {TestRunService} from '../test-run.service'; +import {Device} from '../model/device'; +import {BehaviorSubject} from 'rxjs/internal/BehaviorSubject'; +import {device} from '../mocks/device.mock'; + +describe('allowToRunTestGuard', () => { + const mockRouter = jasmine.createSpyObj(['parseUrl']) + + const setup = (testRunServiceMock: unknown) => { + TestBed.configureTestingModule({ + providers: [ + allowToRunTestGuard, + {provide: TestRunService, useValue: testRunServiceMock}, + {provide: Router, useValue: mockRouter} + ] + }); + + return TestBed.runInInjectionContext(allowToRunTestGuard); + } + + it('should allow to continue', () => { + const mockTestRunService: unknown = {getDevices: () => new BehaviorSubject([device])} + + const guard = setup(mockTestRunService) + + guard.subscribe(res => { + expect(res).toBeTrue(); + }); + }); + + it('should redirect to the "/device-repository" path', () => { + + const mockTestRunService: unknown = {getDevices: () => new BehaviorSubject([])} + + const guard = setup(mockTestRunService) + + guard.subscribe(res => { + expect(res).toBeFalsy(); + expect(mockRouter.parseUrl).toHaveBeenCalledWith('/device-repository'); + }); + }); +}); diff --git a/modules/ui/src/app/guards/allow-to-run-test.guard.ts b/modules/ui/src/app/guards/allow-to-run-test.guard.ts new file mode 100644 index 000000000..b5af12c1b --- /dev/null +++ b/modules/ui/src/app/guards/allow-to-run-test.guard.ts @@ -0,0 +1,18 @@ +import {inject} from '@angular/core'; +import {TestRunService} from '../test-run.service'; +import {Router} from '@angular/router'; +import {Device} from '../model/device'; +import {map} from 'rxjs'; + +export const allowToRunTestGuard = () => { + const testRunService = inject(TestRunService); + const router = inject(Router); + + return testRunService.getDevices().pipe( + map((devices: Device[] | null) => { + return !(devices?.length) + ? router.parseUrl('/device-repository') + : !!devices; + }), + ); +}; diff --git a/modules/ui/src/app/history/history-routing.module.ts b/modules/ui/src/app/history/history-routing.module.ts new file mode 100644 index 000000000..f81bcd3a1 --- /dev/null +++ b/modules/ui/src/app/history/history-routing.module.ts @@ -0,0 +1,12 @@ +import {NgModule} from '@angular/core'; +import {RouterModule, Routes} from '@angular/router'; +import {HistoryComponent} from './history.component'; + +const routes: Routes = [{path: '', component: HistoryComponent}]; + +@NgModule({ + imports: [RouterModule.forChild(routes)], + exports: [RouterModule] +}) +export class HistoryRoutingModule { +} diff --git a/modules/ui/src/app/history/history.component.html b/modules/ui/src/app/history/history.component.html new file mode 100644 index 000000000..3c98e6986 --- /dev/null +++ b/modules/ui/src/app/history/history.component.html @@ -0,0 +1,74 @@ + + + Results + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Test Run # + {{getTestRunId(data)}}Started{{getFormattedDateString(data.started)}}Finished{{getFormattedDateString(data.finished)}}Manufacturer {{data.device.manufacturer}} Model {{data.device.model}} Result + + {{data.status}} + + + + + file_download + + +
+
+ + + +
+
+ Sorry, there are no reports yet! + Reports will automatically generate following a testrun completion. +
+
+ diff --git a/modules/ui/src/app/history/history.component.scss b/modules/ui/src/app/history/history.component.scss new file mode 100644 index 000000000..e049d19ff --- /dev/null +++ b/modules/ui/src/app/history/history.component.scss @@ -0,0 +1,85 @@ +@import "../../theming/colors"; +@import "../../theming/variables"; + +:host { + overflow: hidden; + display: grid; + grid-template-rows: auto 1fr; +} + +.history-toolbar { + padding-left: 32px; + gap: 10px; + background: $white; + height: 93px; + + span { + font-size: 36px; + font-weight: 400; + line-height: 44px; + } +} + +.history-content { + margin: 0 32px 39px 32px; + overflow-y: auto; + border-radius: 4px; + border: 1px solid $lighter-grey; + height: -webkit-fit-content; + height: -moz-fit-content; + height: fit-content; + max-height: -webkit-fill-available; + max-height: -moz-available; + max-height: stretch; +} + +.history-content table { + th { + font-weight: 700; + } + + td { + font-weight: 400; + } + + th, td { + font-family: Roboto, sans-serif; + font-size: 14px; + line-height: 20px; + letter-spacing: 0.2px; + } +} + +.results-content-empty { + display: flex; + align-items: center; + justify-content: center; + grid-row: 1/3; +} + +.results-content-empty-message { + display: flex; + flex-direction: column; + align-items: center; + gap: 16px; +} + +.results-content-empty-message-header { + font-weight: 400; + line-height: 28px; + font-size: 22px; + color: $black; +} + +.results-content-empty-message-main { + font-family: Roboto, sans-serif; + font-weight: 400; + font-size: 16px; + line-height: 24px; + letter-spacing: 0.1px; + color: #202124; +} + +.download-report-icon { + color: $dark-grey; +} diff --git a/modules/ui/src/app/history/history.component.spec.ts b/modules/ui/src/app/history/history.component.spec.ts new file mode 100644 index 000000000..53189b6e7 --- /dev/null +++ b/modules/ui/src/app/history/history.component.spec.ts @@ -0,0 +1,103 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {HistoryComponent} from './history.component'; +import {TestRunService} from '../test-run.service'; +import {BrowserAnimationsModule} from '@angular/platform-browser/animations'; +import {HistoryModule} from './history.module'; +import {of} from 'rxjs'; +import {TestrunStatus} from '../model/testrun-status'; +import SpyObj = jasmine.SpyObj; + +const history = [{ + "status": "compliant", + "device": { + "manufacturer": "Delta", + "model": "03-DIN-SRC", + "mac_addr": "01:02:03:04:05:06", + "firmware": "1.2.2" + }, + "report": "https://api.testrun.io/report.pdf", + "started": "2023-06-23T10:11:00.123Z", + "finished": "2023-06-23T10:17:00.123Z" +}] as TestrunStatus[]; + +describe('HistoryComponent', () => { + let component: HistoryComponent; + let fixture: ComponentFixture; + let compiled: HTMLElement; + let mockService: SpyObj; + + beforeEach(() => { + mockService = jasmine.createSpyObj(['fetchHistory', 'getHistory', 'getResultClass']); + TestBed.configureTestingModule({ + imports: [HistoryModule, BrowserAnimationsModule], + providers: [{provide: TestRunService, useValue: mockService}], + declarations: [HistoryComponent] + }); + fixture = TestBed.createComponent(HistoryComponent); + component = fixture.componentInstance; + compiled = fixture.nativeElement as HTMLElement; + fixture.detectChanges(); + }); + + describe('Class tests', () => { + beforeEach(() => { + mockService.getHistory.and.returnValue(of(history)); + }) + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should set history value', () => { + component.ngOnInit(); + + component.history$.subscribe(res => { + expect(res).toEqual(history) + }) + }); + }); + + describe('DOM tests', () => { + describe('with no devices', () => { + beforeEach(() => { + mockService.getHistory.and.returnValue(of([])); + fixture.detectChanges(); + }) + + it('should have empty message', () => { + const empty = compiled.querySelector('.results-content-empty'); + expect(empty).toBeTruthy(); + }); + }); + + describe('with devices', () => { + beforeEach(() => { + mockService.getHistory.and.returnValue(of(history)); + mockService.getResultClass.and.returnValue({green: false, red: true, grey: false}); + component.ngOnInit(); + fixture.detectChanges(); + }) + + it('should have data table', () => { + const table = compiled.querySelector('table'); + + expect(table).toBeTruthy(); + }); + + it('should have addition valid class on table cell "Status"', () => { + const statusResultEl = compiled.querySelector('.table-cell-result-text'); + + expect(statusResultEl?.classList).toContain('red'); + }); + + it('should have report link', () => { + const link = compiled.querySelector('.download-report-link') as HTMLAnchorElement; + + expect(link.href).toEqual('https://api.testrun.io/report.pdf'); + expect(link.download).toEqual('delta_03-din-src_1.2.2_compliant_23_jun_2023_10:11'); + expect(link.title).toEqual('Download report for Test Run # Delta 03-DIN-SRC 1.2.2 23 Jun 2023 10:11'); + }); + }); + }); +}); diff --git a/modules/ui/src/app/history/history.component.ts b/modules/ui/src/app/history/history.component.ts new file mode 100644 index 000000000..b9460e8fa --- /dev/null +++ b/modules/ui/src/app/history/history.component.ts @@ -0,0 +1,35 @@ +import {Component, OnInit} from '@angular/core'; +import {TestRunService} from '../test-run.service'; +import {Observable} from 'rxjs/internal/Observable'; +import {StatusResultClassName, TestrunStatus} from '../model/testrun-status'; +import {DatePipe} from '@angular/common'; + +@Component({ + selector: 'app-history', + templateUrl: './history.component.html', + styleUrls: ['./history.component.scss'] +}) +export class HistoryComponent implements OnInit { + history$!: Observable; + displayedColumns: string[] = ['#', 'started', 'finished', 'manufacturer', 'model', 'result', 'report'] + + constructor(private testRunService: TestRunService, private datePipe: DatePipe) { + this.testRunService.fetchHistory(); + } + + ngOnInit() { + this.history$ = this.testRunService.getHistory(); + } + + getTestRunId(data: TestrunStatus) { + return `${data.device.manufacturer} ${data.device.model} ${data.device.firmware} ${this.getFormattedDateString(data.started)}`; + } + + getFormattedDateString(date: string | null) { + return date ? this.datePipe.transform(date, 'd MMM y H:mm') : ''; + } + + public getResultClass(status: string): StatusResultClassName { + return this.testRunService.getResultClass(status); + } +} diff --git a/modules/ui/src/app/history/history.module.ts b/modules/ui/src/app/history/history.module.ts new file mode 100644 index 000000000..f32d670d0 --- /dev/null +++ b/modules/ui/src/app/history/history.module.ts @@ -0,0 +1,25 @@ +import {NgModule} from '@angular/core'; +import {CommonModule, DatePipe} from '@angular/common'; +import {HistoryComponent} from './history.component'; +import {HistoryRoutingModule} from './history-routing.module'; +import {MatTableModule} from '@angular/material/table'; +import {MatIconModule} from '@angular/material/icon'; +import {MatToolbarModule} from '@angular/material/toolbar'; +import {DownloadReportComponent} from '../components/download-report/download-report.component'; + +@NgModule({ + declarations: [ + HistoryComponent, + ], + imports: [ + CommonModule, + HistoryRoutingModule, + MatTableModule, + MatIconModule, + MatToolbarModule, + DownloadReportComponent + ], + providers: [DatePipe] +}) +export class HistoryModule { +} diff --git a/modules/ui/src/app/mocks/device.mock.ts b/modules/ui/src/app/mocks/device.mock.ts new file mode 100644 index 000000000..ee648393d --- /dev/null +++ b/modules/ui/src/app/mocks/device.mock.ts @@ -0,0 +1,12 @@ +import {Device} from '../model/device'; + +export const device = { + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "dns": { + "enabled": true, + } + } +} as Device; diff --git a/modules/ui/src/app/mocks/progress.mock.ts b/modules/ui/src/app/mocks/progress.mock.ts new file mode 100644 index 000000000..360399b65 --- /dev/null +++ b/modules/ui/src/app/mocks/progress.mock.ts @@ -0,0 +1,44 @@ +import {IResult, StatusOfTestrun, TestrunStatus, TestsData} from '../model/testrun-status'; + +const TEST_DATA_RESULT: IResult[] = [ + { + name: 'dns.network.hostname_resolution', + description: 'The device should resolve hostnames', + result: 'Compliant' + }, + { + name: 'dns.network.from_dhcp', + description: 'The device should use the DNS server provided by the DHCP server', + result: 'Non-Compliant' + } +] + +export const TEST_DATA: TestsData = { + total: 26, + results: TEST_DATA_RESULT +} + +const PROGRESS_DATA_RESPONSE = ((status: string, finished: string | null, tests: TestsData | IResult[], report?: string) => { + return { + status, + device: { + manufacturer: 'Delta', + model: '03-DIN-CPU', + mac_addr: '01:02:03:04:05:06', + firmware: '1.2.2' + }, + started: '2023-06-22T09:20:00.123Z', + finished, + tests, + report + } +}); + +export const MOCK_PROGRESS_DATA_IN_PROGRESS: TestrunStatus = PROGRESS_DATA_RESPONSE(StatusOfTestrun.InProgress, null, TEST_DATA); +export const MOCK_PROGRESS_DATA_COMPLIANT: TestrunStatus = PROGRESS_DATA_RESPONSE( + StatusOfTestrun.Compliant,'2023-06-22T09:20:00.123Z', TEST_DATA_RESULT, 'https://api.testrun.io/report.pdf' +); + +export const MOCK_PROGRESS_DATA_CANCELLED: TestrunStatus = PROGRESS_DATA_RESPONSE(StatusOfTestrun.Cancelled, null, TEST_DATA); + +export const MOCK_PROGRESS_DATA_NOT_STARTED: TestrunStatus = {...MOCK_PROGRESS_DATA_IN_PROGRESS, status: StatusOfTestrun.Idle, started: null}; diff --git a/modules/ui/src/app/model/device.ts b/modules/ui/src/app/model/device.ts new file mode 100644 index 000000000..03f4e8619 --- /dev/null +++ b/modules/ui/src/app/model/device.ts @@ -0,0 +1,24 @@ +export interface Device { + manufacturer: string; + model: string; + mac_addr: string; + test_modules?: TestModules +} + +/** + * Test Modules interface used to send on backend + */ +export interface TestModules { + [key: string]: { + enabled: boolean; + } +} + +/** + * Test Module interface used on ui + */ +export interface TestModule { + displayName: string, + name: string, + enabled: boolean, +} diff --git a/modules/ui/src/app/model/setting.ts b/modules/ui/src/app/model/setting.ts new file mode 100644 index 000000000..a7eb451d8 --- /dev/null +++ b/modules/ui/src/app/model/setting.ts @@ -0,0 +1,6 @@ +export interface SystemConfig { + network: { + device_intf?: string; + internet_intf?: string; + } +} diff --git a/modules/ui/src/app/model/testrun-status.ts b/modules/ui/src/app/model/testrun-status.ts new file mode 100644 index 000000000..b2a90bef4 --- /dev/null +++ b/modules/ui/src/app/model/testrun-status.ts @@ -0,0 +1,57 @@ +import {Device} from './device'; + +export interface TestrunStatus { + status: string; + device: IDevice; + started: string | null; + finished: string | null; + tests?: TestsResponse; + report?: string; +} + +export interface TestsData { + total?: number; + results?: IResult[]; +} + +type TestsResponse = TestsData | IResult[]; + +export interface IDevice extends Device { + firmware: string; +} + +export interface IResult { + name: string; + description: string; + result: string; +} + +export enum StatusOfTestrun { + InProgress = 'In Progress', + WaitingForDevice = 'Waiting for Device', + Cancelled = 'Cancelled', + Failed = 'Failed', + Compliant = 'Compliant', // used for Completed + NonCompliant = 'Non-Compliant', // used for Completed + SmartReady = 'Smart Ready', // used for Completed + Idle = 'Idle' +} + +export enum StatusOfTestResult { + Compliant = 'Compliant', + SmartReady = 'Smart Ready', + NonCompliant = 'Non-Compliant', + Skipped = 'Skipped', + NotStarted = 'Not Started' +} + +export interface StatusResultClassName { + green: boolean, + red: boolean, + grey: boolean +} + +export type TestrunStatusKey = keyof typeof StatusOfTestrun; +export type TestrunStatusValue = typeof StatusOfTestrun[TestrunStatusKey]; +export type TestResultKey = keyof typeof StatusOfTestResult; +export type TestResultValue = typeof StatusOfTestResult[TestResultKey]; diff --git a/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.html b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.html new file mode 100644 index 000000000..14122bb83 --- /dev/null +++ b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.html @@ -0,0 +1,15 @@ +
    +
  • + home +
    • +
  • + + keyboard_arrow_right + + + local_taxi + + {{breadcrumb}} +
    • +
+ diff --git a/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.scss b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.scss new file mode 100644 index 000000000..62ad7cfb1 --- /dev/null +++ b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.scss @@ -0,0 +1,40 @@ +@use '@angular/material' as mat; +@import "../../../theming/colors"; + +ul { + display: flex; + flex-wrap: wrap; + list-style: none; + margin: 0; + padding: 0 8px; + + .breadcrumb-item { + display: flex; + align-items: center; + justify-content: center; + gap: 8px; + margin-right: 16px; + + &.first { + margin-right: 6px; + } + } + + .icon-home { + color: $dark-grey; + } + + .icon { + color: $secondary; + } + + .breadcrumb-text { + color: mat.get-color-from-palette($color-primary, 600); + text-align: center; + /* font-family: SF Pro Text; */ + font-size: 12px; + font-weight: 700; + line-height: 16px; + letter-spacing: 0.3px; + } +} diff --git a/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.spec.ts b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.spec.ts new file mode 100644 index 000000000..922b7dcd4 --- /dev/null +++ b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.spec.ts @@ -0,0 +1,23 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {ProgressBreadcrumbsComponent} from './progress-breadcrumbs.component'; +import {MatIconModule} from '@angular/material/icon'; + +describe('ProgressBreadcrumbsComponent', () => { + let component: ProgressBreadcrumbsComponent; + let fixture: ComponentFixture; + + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ProgressBreadcrumbsComponent], + imports: [MatIconModule] + }); + fixture = TestBed.createComponent(ProgressBreadcrumbsComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); +}); diff --git a/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.ts b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.ts new file mode 100644 index 000000000..c4ed37822 --- /dev/null +++ b/modules/ui/src/app/progress/progress-breadcrumbs/progress-breadcrumbs.component.ts @@ -0,0 +1,12 @@ +import {ChangeDetectionStrategy, Component, Input} from '@angular/core'; +import {Observable} from 'rxjs/internal/Observable'; + +@Component({ + selector: 'app-progress-breadcrumbs', + templateUrl: './progress-breadcrumbs.component.html', + styleUrls: ['./progress-breadcrumbs.component.scss'], + changeDetection: ChangeDetectionStrategy.OnPush +}) +export class ProgressBreadcrumbsComponent { + @Input() breadcrumbs$!: Observable; +} diff --git a/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.html b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.html new file mode 100644 index 000000000..82dc94be4 --- /dev/null +++ b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.html @@ -0,0 +1,64 @@ +
+ Create new Testrun + +
+ + + + + + + + Firmware + + Please enter device firmware + + Firmware is required + + + + + + +
+ + + + + + +
+ + + + + + Firmware + + Please enter device firmware + + Firmware is required + + + + diff --git a/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.scss b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.scss new file mode 100644 index 000000000..b09be89a5 --- /dev/null +++ b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.scss @@ -0,0 +1,50 @@ +@import "../../../theming/colors"; +@import "../../../theming/variables"; + +:host { + display: grid; + grid-template-rows: 1fr; + overflow: hidden; + width: 450px; +} + +.progress-initiate-form { + display: grid; + overflow: auto; + max-height: 100vh; +} + +.progress-initiate-form-title { + color: $grey-800; + font-size: 22px; + line-height: 28px; + padding: 24px; + border-bottom: 1px solid $light-grey; +} + +.progress-initiate-form-content { + overflow: auto; + min-height: 78px; + padding: 32px 0; + display: grid; + gap: 32px; + justify-content: center; + justify-items: center; + grid-template-columns: 1fr; + + & > * { + width: $device-item-width; + box-sizing: border-box; + } +} + +.progress-initiate-form-actions { + min-height: 30px; + justify-content: space-between; + padding: 16px; + border-top: 1px solid $lighter-grey; +} + +.hidden { + display: none; +} diff --git a/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.spec.ts b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.spec.ts new file mode 100644 index 000000000..8fd4ac1f9 --- /dev/null +++ b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.spec.ts @@ -0,0 +1,191 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {ProgressInitiateFormComponent} from './progress-initiate-form.component'; +import {MatDialogModule, MatDialogRef} from '@angular/material/dialog'; +import {TestRunService} from '../../test-run.service'; +import {BehaviorSubject} from 'rxjs/internal/BehaviorSubject'; +import {Device} from '../../model/device'; +import {DeviceItemComponent} from '../../components/device-item/device-item.component'; +import {ReactiveFormsModule} from '@angular/forms'; +import {MatInputModule} from '@angular/material/input'; +import {BrowserAnimationsModule} from '@angular/platform-browser/animations'; +import {DeviceTestsComponent} from '../../components/device-tests/device-tests.component'; +import {device} from '../../mocks/device.mock'; + +describe('ProgressInitiateFormComponent', () => { + let component: ProgressInitiateFormComponent; + let fixture: ComponentFixture; + let compiled: HTMLElement; + let testRunServiceMock: jasmine.SpyObj; + + testRunServiceMock = jasmine.createSpyObj(['getDevices', 'fetchDevices', 'getTestModules']); + testRunServiceMock.getTestModules.and.returnValue([ + { + displayName: "Connection", + name: "connection", + enabled: true + }, + { + displayName: "DNS", + name: "dns", + enabled: false + }, + ]); + testRunServiceMock.getDevices.and.returnValue(new BehaviorSubject([device, device])); + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ProgressInitiateFormComponent], + providers: [ + {provide: TestRunService, useValue: testRunServiceMock}, + { + provide: MatDialogRef, + useValue: { + close: () => { + } + } + }], + imports: [ + MatDialogModule, + DeviceItemComponent, + ReactiveFormsModule, + MatInputModule, + BrowserAnimationsModule, + DeviceTestsComponent, + ] + }); + fixture = TestBed.createComponent(ProgressInitiateFormComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + compiled = fixture.nativeElement as HTMLElement; + }); + + describe('Class tests', () => { + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should close dialog', () => { + spyOn(component.dialogRef, 'close'); + component.cancel(); + expect(component.dialogRef.close).toHaveBeenCalled(); + }); + + it('should set devices$ value', () => { + component.ngOnInit(); + + component.devices$.subscribe(res => { + expect(res).toEqual([device, device]) + }) + }); + + it('should update selectedDevice on deviceSelected', () => { + const newDevice = Object.assign(device, {manufacturer: 'Gamma'}) + component.deviceSelected(newDevice); + + expect(component.selectedDevice).toEqual(newDevice); + }); + + it('should reset selectedDevice and firmware on changeDevice', () => { + component.changeDevice(); + + expect(component.selectedDevice).toEqual(null); + expect(component.firmware.value).toEqual(''); + }); + + describe('#startNewTestRun', () => { + it('should add required error if firmware is empty', () => { + component.firmware.setValue(''); + component.startTestRun(); + + expect(component.firmware.errors).toBeTruthy(); + expect(component.firmware.errors ? component.firmware.errors['required'] : false).toEqual(true); + }); + + //test will be updated + it('should close dialog if selectedDevice is present and firmware is filled', () => { + spyOn(component.dialogRef, 'close'); + component.firmware.setValue('firmware'); + component.selectedDevice = device; + component.startTestRun(); + + expect(component.dialogRef.close).toHaveBeenCalled(); + }); + }); + }); + + describe('DOM tests', () => { + describe('empty device', () => { + beforeEach(() => { + component.selectedDevice = null; + fixture.detectChanges(); + }); + + it('should have device list', () => { + const deviceList = compiled.querySelectorAll('app-device-item'); + + expect(deviceList.length).toEqual(2); + }); + + it('should select device on device click', () => { + spyOn(component, 'deviceSelected'); + const deviceList = compiled.querySelector('app-device-item button') as HTMLButtonElement; + deviceList.click(); + + expect(component.deviceSelected).toHaveBeenCalled(); + }); + + it('should disable change device and start buttons', () => { + const changeDevice = compiled.querySelector('.progress-initiate-form-actions-change-device') as HTMLButtonElement; + const start = compiled.querySelector('.progress-initiate-form-actions-start') as HTMLButtonElement; + + expect(changeDevice.disabled).toEqual(true); + expect(start.disabled).toEqual(true); + }); + }) + + describe('with device', () => { + beforeEach(() => { + component.selectedDevice = device; + fixture.detectChanges(); + }); + + it('should display selected device if device selected', () => { + const deviceItem = compiled.querySelector('app-device-item'); + + expect(deviceItem).toBeTruthy(); + }); + + it('should display firmware if device selected', () => { + const firmware = compiled.querySelector('input'); + + expect(firmware).toBeTruthy(); + }); + + it('should display tests if device selected', () => { + const testsForm = compiled.querySelector('app-device-tests form'); + const tests = compiled.querySelectorAll('app-device-tests mat-checkbox'); + + expect(testsForm).toBeTruthy(); + expect(testsForm?.classList.contains('disabled')).toEqual(true); + expect(tests.length).toEqual(2); + }); + + it('should change device on change device button click', () => { + spyOn(component, 'changeDevice'); + const button = compiled.querySelector('.progress-initiate-form-actions-change-device') as HTMLButtonElement; + button.click(); + + expect(component.changeDevice).toHaveBeenCalled(); + }); + + it('should start test run on start button click', () => { + spyOn(component, 'startTestRun'); + const button = compiled.querySelector('.progress-initiate-form-actions-start') as HTMLButtonElement; + button.click(); + + expect(component.startTestRun).toHaveBeenCalled(); + }); + + }); + }); +}); diff --git a/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.ts b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.ts new file mode 100644 index 000000000..7b109da07 --- /dev/null +++ b/modules/ui/src/app/progress/progress-initiate-form/progress-initiate-form.component.ts @@ -0,0 +1,71 @@ +import {Component, OnInit} from '@angular/core'; +import {MatDialogRef} from '@angular/material/dialog'; +import {TestRunService} from '../../test-run.service'; +import {Observable} from 'rxjs/internal/Observable'; +import {Device, TestModule} from '../../model/device'; +import {FormArray, FormBuilder, FormGroup} from '@angular/forms'; +import {DeviceStringFormatValidator} from '../../device-repository/device-form/device-string-format.validator'; + +@Component({ + selector: 'app-progress-initiate-form', + templateUrl: './progress-initiate-form.component.html', + styleUrls: ['./progress-initiate-form.component.scss'] +}) +export class ProgressInitiateFormComponent implements OnInit { + initiateForm!: FormGroup; + devices$!: Observable; + selectedDevice: Device | null = null; + testModules: TestModule[] = []; + + constructor( + public dialogRef: MatDialogRef, + private readonly testRunService: TestRunService, + private fb: FormBuilder, + private deviceStringFormatValidator: DeviceStringFormatValidator) { + } + + get firmware() { + return this.initiateForm.get('firmware')!; + } + + cancel(): void { + this.dialogRef.close(); + } + + ngOnInit() { + this.devices$ = this.testRunService.getDevices(); + this.createInitiateForm(); + this.testModules = this.testRunService.getTestModules(); + } + + deviceSelected(device: Device) { + this.selectedDevice = device; + } + + changeDevice() { + this.selectedDevice = null; + this.firmware.setValue(''); + } + + startTestRun() { + if (!this.firmware.value.trim()) { + this.firmware.setErrors({required: true}); + } + + if (this.initiateForm.invalid) { + this.initiateForm.markAllAsTouched(); + return; + } + + if (this.selectedDevice) { + this.dialogRef.close(); + } + } + + private createInitiateForm() { + this.initiateForm = this.fb.group({ + firmware: ['', [this.deviceStringFormatValidator.deviceStringFormat()]], + test_modules: new FormArray([]) + }); + } +} diff --git a/modules/ui/src/app/progress/progress-routing.module.ts b/modules/ui/src/app/progress/progress-routing.module.ts new file mode 100644 index 000000000..fb0d286b3 --- /dev/null +++ b/modules/ui/src/app/progress/progress-routing.module.ts @@ -0,0 +1,12 @@ +import {NgModule} from '@angular/core'; +import {RouterModule, Routes} from '@angular/router'; +import {ProgressComponent} from './progress.component'; + +const routes: Routes = [{path: '', component: ProgressComponent}]; + +@NgModule({ + imports: [RouterModule.forChild(routes)], + exports: [RouterModule] +}) +export class ProgressRoutingModule { +} diff --git a/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.html b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.html new file mode 100644 index 000000000..bc6b1d1bf --- /dev/null +++ b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.html @@ -0,0 +1,30 @@ + +
+
+

+ Test status +

+

+ {{getTestStatus(data)}} + {{getTestsResult(data)}} +

+
+
+ + +
+

+ Test result +

+

+ {{data.status}} +

+
+
+
+ diff --git a/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.scss b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.scss new file mode 100644 index 000000000..da7ad6a6e --- /dev/null +++ b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.scss @@ -0,0 +1,57 @@ +@use '@angular/material' as mat; +@import "../../../theming/colors"; + +:host { + height: 152px; +} + +.progress-card { + display: flex; + flex-direction: column; + justify-content: space-between; + width: 295px; + height: 100%; + box-sizing: border-box; + padding: 16px 32px; + + &.progress { + background-color: mat.get-color-from-palette($color-primary, 700); + } + + &.completed-success { + background-color: mat.get-color-from-palette($color-accent, 700); + } + + &.completed-failed { + background-color: $red-800; + } + + &.canceled { + background-color: $secondary; + } + + p { + margin: 0; + } + + .progress-card-status-title, + .progress-card-result-title { + color: $white; + font-size: 14px; + line-height: 20px; + } + + .progress-card-status-text, + .progress-card-result-text { + display: flex; + justify-content: space-between; + color: $white; + font-size: 24px; + font-weight: 400; + line-height: 32px; + } + + .progress-bar { + padding-bottom: 28px; + } +} diff --git a/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.spec.ts b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.spec.ts new file mode 100644 index 000000000..48181b5c1 --- /dev/null +++ b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.spec.ts @@ -0,0 +1,259 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {ProgressStatusCardComponent} from './progress-status-card.component'; +import {StatusOfTestrun, TestrunStatus} from '../../model/testrun-status'; +import {MOCK_PROGRESS_DATA_CANCELLED, MOCK_PROGRESS_DATA_COMPLIANT, MOCK_PROGRESS_DATA_IN_PROGRESS} from '../../mocks/progress.mock'; +import {ProgressModule} from '../progress.module'; +import {of} from 'rxjs'; + +describe('ProgressStatusCardComponent', () => { + let component: ProgressStatusCardComponent; + let fixture: ComponentFixture; + + describe('Class tests', () => { + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ProgressStatusCardComponent] + }); + fixture = TestBed.createComponent(ProgressStatusCardComponent); + component = fixture.componentInstance; + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + describe('#getClass', () => { + it('should have class "progress" if status "In Progress"', () => { + const expectedResult = { + progress: true, + 'completed-success': false, + 'completed-failed': false, + canceled: false + }; + + const result = component.getClass(StatusOfTestrun.InProgress); + + expect(result).toEqual(expectedResult); + }); + + it('should have class "completed-success" if status "Compliant"', () => { + const expectedResult = { + progress: false, + 'completed-success': true, + 'completed-failed': false, + canceled: false + }; + + const result = component.getClass(StatusOfTestrun.Compliant); + + expect(result).toEqual(expectedResult); + }); + + it('should have class "completed-failed" if status "Non Compliant"', () => { + const expectedResult = { + progress: false, + 'completed-success': false, + 'completed-failed': true, + canceled: false + }; + + const result = component.getClass(StatusOfTestrun.NonCompliant); + + expect(result).toEqual(expectedResult); + }); + + it('should have class "canceled" if status "Cancelled"', () => { + const expectedResult = { + progress: false, + 'completed-success': false, + 'completed-failed': false, + canceled: true + }; + + const result = component.getClass(StatusOfTestrun.Cancelled); + + expect(result).toEqual(expectedResult); + }); + }); + + describe('#getTestsResult', () => { + it('should return correct test result if status "In Progress"', () => { + const expectedResult = '2/26'; + + const result = component.getTestsResult(MOCK_PROGRESS_DATA_IN_PROGRESS); + + expect(result).toEqual(expectedResult); + }); + + it('should return correct test result if status "Compliant"', () => { + const expectedResult = '2/2'; + + const result = component.getTestsResult(MOCK_PROGRESS_DATA_COMPLIANT); + + expect(result).toEqual(expectedResult); + }); + + it('should return correct test result if status "Cancelled"', () => { + const expectedResult = '2/26'; + + const result = component.getTestsResult(MOCK_PROGRESS_DATA_CANCELLED); + + expect(result).toEqual(expectedResult); + }); + + it('should return empty string if no data', () => { + const expectedResult = ''; + + const result = component.getTestsResult({} as TestrunStatus); + + expect(result).toEqual(expectedResult); + }); + }); + + describe('#getTestStatus', () => { + it('should return test status "Complete" if testrun is finished', () => { + const expectedResult = 'Complete'; + + const result = component.getTestStatus(MOCK_PROGRESS_DATA_COMPLIANT); + + expect(result).toEqual(expectedResult); + }); + + it('should return test status "Incomplete" if status "Cancelled"', () => { + const expectedResult = 'Incomplete'; + + const result = component.getTestStatus(MOCK_PROGRESS_DATA_CANCELLED); + + expect(result).toEqual(expectedResult); + }); + + it('should return test status "In Progress" if status "In Progress"', () => { + const expectedResult = 'In Progress'; + + const result = component.getTestStatus(MOCK_PROGRESS_DATA_IN_PROGRESS); + + expect(result).toEqual(expectedResult); + }); + }); + + describe('#getProgressValue', () => { + it('should return correct progress value if status "In Progress"', () => { + const expectedResult = Math.round(2 / 26 * 100); + + const result = component.getProgressValue(MOCK_PROGRESS_DATA_IN_PROGRESS); + + expect(result).toEqual(expectedResult); + }); + + it('should return zero if no data', () => { + const expectedResult = 0; + + const result = component.getProgressValue({} as TestrunStatus); + + expect(result).toEqual(expectedResult); + }); + }); + }); + + describe('DOM tests', () => { + let compiled: HTMLElement; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + declarations: [ProgressStatusCardComponent], + imports: [ProgressModule] + }).compileComponents(); + + fixture = TestBed.createComponent(ProgressStatusCardComponent); + compiled = fixture.nativeElement as HTMLElement; + component = fixture.componentInstance; + }); + + describe('with not systemStatus$ data', () => { + beforeEach(() => { + (component.systemStatus$ as any) = of(null); + fixture.detectChanges(); + }); + + it('should not have content', () => { + const progressCardEl = compiled.querySelector('.progress-card'); + + expect(progressCardEl).toBeNull(); + }); + }); + + describe('with available systemStatus$ data, as Cancelled', () => { + beforeEach(() => { + component.systemStatus$ = of(MOCK_PROGRESS_DATA_CANCELLED); + fixture.detectChanges(); + }); + + it('should have progress card content', () => { + const progressCardEl = compiled.querySelector('.progress-card'); + + expect(progressCardEl).not.toBeNull(); + }); + + it('should have class "canceled" on progress card element', () => { + const progressCardEl = compiled.querySelector('.progress-card'); + + expect(progressCardEl?.classList).toContain('canceled'); + }); + + it('should not have progress bar element', () => { + const progressBarEl = compiled.querySelector('.progress-bar'); + + expect(progressBarEl).toBeNull(); + }); + + it('should have progress card result', () => { + const progressCardResultEl = compiled.querySelector('.progress-card-result-text span'); + + expect(progressCardResultEl).not.toBeNull(); + expect(progressCardResultEl?.textContent).toEqual('Cancelled'); + }); + + it('should have progress card status text as "Incomplete"', () => { + const progressCardStatusText = compiled.querySelector('.progress-card-status-text > span'); + + expect(progressCardStatusText).not.toBeNull(); + expect(progressCardStatusText?.textContent).toEqual('Incomplete'); + }); + }); + + describe('with available systemStatus$ data, as "In Progress"', () => { + beforeEach(() => { + component.systemStatus$ = of(MOCK_PROGRESS_DATA_IN_PROGRESS); + fixture.detectChanges(); + }); + + + it('should have class "progress" on progress card element', () => { + const progressCardEl = compiled.querySelector('.progress-card'); + + expect(progressCardEl?.classList).toContain('progress'); + }); + + it('should have progress bar element', () => { + const progressBarEl = compiled.querySelector('.progress-bar'); + + expect(progressBarEl).not.toBeNull(); + }); + + it('should not have progress card result', () => { + const progressCardResultEl = compiled.querySelector('.progress-card-result-text span'); + + expect(progressCardResultEl).toBeNull(); + }); + + it('should have progress card status text as "In Progress"', () => { + const progressCardStatusText = compiled.querySelector('.progress-card-status-text > span'); + + expect(progressCardStatusText).not.toBeNull(); + expect(progressCardStatusText?.textContent).toEqual('In Progress'); + }); + }); + }); + +}); diff --git a/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.ts b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.ts new file mode 100644 index 000000000..d6fa261c2 --- /dev/null +++ b/modules/ui/src/app/progress/progress-status-card/progress-status-card.component.ts @@ -0,0 +1,54 @@ +import {ChangeDetectionStrategy, Component, Input} from '@angular/core'; +import {Observable} from 'rxjs/internal/Observable'; +import {TestrunStatus, StatusOfTestrun, TestsData, IResult} from '../../model/testrun-status'; + +@Component({ + selector: 'app-progress-status-card', + templateUrl: './progress-status-card.component.html', + styleUrls: ['./progress-status-card.component.scss'], + changeDetection: ChangeDetectionStrategy.OnPush +}) +export class ProgressStatusCardComponent { + @Input() systemStatus$!: Observable; + + public readonly StatusOfTestrun = StatusOfTestrun; + + public getClass(status: string): { progress: boolean, 'completed-success': boolean, 'completed-failed': boolean, canceled: boolean } { + return { + 'progress': status === StatusOfTestrun.InProgress, + 'completed-success': status === StatusOfTestrun.Compliant || status === StatusOfTestrun.SmartReady, + 'completed-failed': status === StatusOfTestrun.NonCompliant, + 'canceled': status === StatusOfTestrun.Cancelled + } + } + + public getTestsResult(data: TestrunStatus): string { + if (data.status === StatusOfTestrun.InProgress || data.status === StatusOfTestrun.Cancelled || data.finished) { + if ((data.tests as TestsData)?.results?.length && (data.tests as TestsData)?.total) { + return `${(data.tests as TestsData)?.results?.length}/${(data.tests as TestsData)?.total}` + } else if ((data.tests as IResult[])?.length) { + return `${(data.tests as IResult[])?.length}/${(data.tests as IResult[])?.length}` + } + } + return ''; + } + + public getTestStatus(data: TestrunStatus): string { + if (data.finished) { + return 'Complete'; + } else if (data.status === StatusOfTestrun.Cancelled) { + return 'Incomplete'; + } else { + return data.status; + } + } + + public getProgressValue(data: TestrunStatus): number { + const testData = data.tests as TestsData; + + if (testData && testData.total && testData.results?.length) { + return Math.round(testData.results.length / testData.total * 100); + } + return 0; + } +} diff --git a/modules/ui/src/app/progress/progress-table/progress-table.component.html b/modules/ui/src/app/progress/progress-table/progress-table.component.html new file mode 100644 index 000000000..eb615ae5b --- /dev/null +++ b/modules/ui/src/app/progress/progress-table/progress-table.component.html @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + +
Name {{element.name}} Description {{element.description}} Result + + {{element.result}} + +
+ diff --git a/modules/ui/src/app/progress/progress-table/progress-table.component.scss b/modules/ui/src/app/progress/progress-table/progress-table.component.scss new file mode 100644 index 000000000..687e2c8d3 --- /dev/null +++ b/modules/ui/src/app/progress/progress-table/progress-table.component.scss @@ -0,0 +1,43 @@ +@import "../../../theming/colors"; +@import "../../../theming/variables"; + +:host { + overflow-y: auto; + padding: 10px 0 12px; +} + +table, tr { + border: 1px solid $lighter-grey; + border-collapse: collapse; +} + +.progress-table { + .table-header-row { + height: 57px; + } + + .table-row { + height: 73px; + } + + .table-cell, + .table-header-cell { + font-family: $font-secondary; + font-size: 14px; + line-height: 20px; + } + + .table-header-cell { + font-weight: 500; + letter-spacing: 0.25px; + } + + .table-cell { + padding: 16px; + letter-spacing: 0.2px; + } + + .table-cell-result { + min-width: 140px; + } +} diff --git a/modules/ui/src/app/progress/progress-table/progress-table.component.spec.ts b/modules/ui/src/app/progress/progress-table/progress-table.component.spec.ts new file mode 100644 index 000000000..0eb3b0038 --- /dev/null +++ b/modules/ui/src/app/progress/progress-table/progress-table.component.spec.ts @@ -0,0 +1,94 @@ +import {ComponentFixture, TestBed} from '@angular/core/testing'; + +import {ProgressTableComponent} from './progress-table.component'; +import {IResult, StatusOfTestResult} from '../../model/testrun-status'; +import {MatTableModule} from '@angular/material/table'; +import {of} from 'rxjs'; +import {TEST_DATA} from '../../mocks/progress.mock'; +import {TestRunService} from '../../test-run.service'; + +describe('ProgressTableComponent', () => { + let component: ProgressTableComponent; + let fixture: ComponentFixture; + let testRunServiceMock: jasmine.SpyObj; + + testRunServiceMock = jasmine.createSpyObj(['getResultClass']); + + describe('Class tests', () => { + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ProgressTableComponent], + providers: [{provide: TestRunService, useValue: testRunServiceMock}], + }); + fixture = TestBed.createComponent(ProgressTableComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('#getResultClass should call the service method getResultClass"', () => { + const expectedResult = { + green: false, red: true, grey: false + }; + + testRunServiceMock.getResultClass.and.returnValue(expectedResult); + + const result = component.getResultClass(StatusOfTestResult.NonCompliant); + + expect(testRunServiceMock.getResultClass).toHaveBeenCalledWith(StatusOfTestResult.NonCompliant); + expect(result).toEqual(expectedResult); + }); + }); + + describe('DOM tests', () => { + let compiled: HTMLElement; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + declarations: [ProgressTableComponent], + providers: [{provide: TestRunService, useValue: testRunServiceMock}], + imports: [MatTableModule] + }).compileComponents(); + + fixture = TestBed.createComponent(ProgressTableComponent); + component = fixture.componentInstance; + compiled = fixture.nativeElement as HTMLElement; + }); + + describe('with not dataSource$ data', () => { + beforeEach(() => { + component.dataSource$ = of(undefined); + fixture.detectChanges(); + }); + + it('should be unavailable', () => { + const table = compiled.querySelector('.progress-table'); + + expect(table).toBeNull(); + }); + }); + + describe('with dataSource$ data', () => { + beforeEach(() => { + component.dataSource$ = of(TEST_DATA.results); + fixture.detectChanges(); + }); + + it('should be available', () => { + const table = compiled.querySelector('.progress-table'); + + expect(table).not.toBeNull(); + }); + + it('should have table rows as provided from data', () => { + const expectedRowsLength = (TEST_DATA.results as IResult[]).length; + const tableRows = compiled.querySelectorAll('.table-row'); + + expect(tableRows.length).toBe(expectedRowsLength); + }); + }); + }); +}); diff --git a/modules/ui/src/app/progress/progress-table/progress-table.component.ts b/modules/ui/src/app/progress/progress-table/progress-table.component.ts new file mode 100644 index 000000000..fe23972a6 --- /dev/null +++ b/modules/ui/src/app/progress/progress-table/progress-table.component.ts @@ -0,0 +1,22 @@ +import {ChangeDetectionStrategy, Component, Input} from '@angular/core'; +import {Observable} from 'rxjs/internal/Observable'; +import {IResult, StatusResultClassName} from '../../model/testrun-status'; +import {TestRunService} from '../../test-run.service'; + +@Component({ + selector: 'app-progress-table', + templateUrl: './progress-table.component.html', + styleUrls: ['./progress-table.component.scss'], + changeDetection: ChangeDetectionStrategy.OnPush +}) +export class ProgressTableComponent { + @Input() dataSource$!: Observable; + + displayedColumns: string[] = ['name', 'description', 'result']; + + constructor(private readonly testRunService: TestRunService) {} + + public getResultClass(result: string): StatusResultClassName { + return this.testRunService.getResultClass(result); + } +} diff --git a/modules/ui/src/app/progress/progress.component.html b/modules/ui/src/app/progress/progress.component.html new file mode 100644 index 000000000..bdd9b0ad0 --- /dev/null +++ b/modules/ui/src/app/progress/progress.component.html @@ -0,0 +1,63 @@ + + + +
+
+ + + + +
+
+ +

+ {{data.device.manufacturer}} {{data.device.model}} {{data.device.firmware}} {{data.started | date: 'd MMM y H:mm'}} +

+ + + + +
+
+ + + + + + + + + + + +
+ +
+ + + + + diff --git a/modules/ui/src/app/progress/progress.component.scss b/modules/ui/src/app/progress/progress.component.scss new file mode 100644 index 000000000..ae03c8b7e --- /dev/null +++ b/modules/ui/src/app/progress/progress.component.scss @@ -0,0 +1,72 @@ +@use '@angular/material' as mat; +@import "../../theming/colors"; + +:host { + display: flex; + flex-direction: column; + overflow: hidden; + padding: 0 32px; +} + +.progress-content-empty { + height: 100%; + display: flex; + align-items: center; + justify-content: center; +} + +.progress-toolbar { + display: flex; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: 0; + background: $white; + + .toolbar-col-left { + padding: 0 10px; + } + + .toolbar-row { + display: flex; + align-items: center; + + &.top { + gap: 15px; + padding: 10px 0; + } + + &.bottom { + gap: 10px; + padding: 24px 0 8px; + + p { + margin: 0; + } + } + } + + .vertical-divider { + width: 1px; + height: 35px; + background-color: $lighter-grey; + } +} + +.progress-title { + font-size: 36px; + font-weight: 400; + line-height: 44px; +} + +.report-button, +.stop-button, +.start-button { + letter-spacing: 0.25px; + padding: 0 24px; +} + +.report-button { + background-color: mat.get-color-from-palette($color-primary, 50); + color: mat.get-color-from-palette($color-primary, 700); +} diff --git a/modules/ui/src/app/progress/progress.component.spec.ts b/modules/ui/src/app/progress/progress.component.spec.ts new file mode 100644 index 000000000..d0925cd37 --- /dev/null +++ b/modules/ui/src/app/progress/progress.component.spec.ts @@ -0,0 +1,306 @@ +import {ComponentFixture, discardPeriodicTasks, fakeAsync, TestBed, tick} from '@angular/core/testing'; + +import {ProgressComponent} from './progress.component'; +import {TestRunService} from '../test-run.service'; +import {of} from 'rxjs'; +import {MOCK_PROGRESS_DATA_CANCELLED, MOCK_PROGRESS_DATA_COMPLIANT, MOCK_PROGRESS_DATA_IN_PROGRESS, MOCK_PROGRESS_DATA_NOT_STARTED, TEST_DATA} from '../mocks/progress.mock'; +import {MatButtonModule} from '@angular/material/button'; +import {MatIconModule} from '@angular/material/icon'; +import {MatToolbarModule} from '@angular/material/toolbar'; +import {Component, Input} from '@angular/core'; +import {Observable} from 'rxjs/internal/Observable'; +import {IResult, TestrunStatus} from '../model/testrun-status'; +import {MatDialogModule, MatDialogRef} from '@angular/material/dialog'; +import {BehaviorSubject} from 'rxjs/internal/BehaviorSubject'; +import {Device} from '../model/device'; +import {ProgressInitiateFormComponent} from './progress-initiate-form/progress-initiate-form.component'; +import {DownloadReportComponent} from '../components/download-report/download-report.component'; + +describe('ProgressComponent', () => { + let component: ProgressComponent; + let fixture: ComponentFixture; + let compiled: HTMLElement; + let testRunServiceMock: jasmine.SpyObj; + + testRunServiceMock = jasmine.createSpyObj(['getSystemStatus', 'setSystemStatus', 'systemStatus$', 'stopTestrun', 'getDevices']); + testRunServiceMock.getDevices.and.returnValue(new BehaviorSubject([])); + + describe('Class tests', () => { + beforeEach(() => { + testRunServiceMock.systemStatus$ = of(MOCK_PROGRESS_DATA_IN_PROGRESS); + testRunServiceMock.stopTestrun.and.returnValue(of(true)); + + TestBed.configureTestingModule({ + declarations: [ProgressComponent], + providers: [ + {provide: TestRunService, useValue: testRunServiceMock}, + { + provide: MatDialogRef, + useValue: {} + },], + imports: [MatButtonModule, MatIconModule, MatToolbarModule, MatDialogModule] + }); + fixture = TestBed.createComponent(ProgressComponent); + component = fixture.componentInstance; + }); + + afterEach(() => { + testRunServiceMock.getSystemStatus.calls.reset(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('#stopTestrun should call service method stopTestrun', () => { + component.stopTestrun(); + + expect(testRunServiceMock.stopTestrun).toHaveBeenCalled(); + }) + + describe('#ngOnInit', () => { + it('should set systemStatus$ value', () => { + component.ngOnInit(); + + component.systemStatus$.subscribe(res => { + expect(res).toEqual(MOCK_PROGRESS_DATA_IN_PROGRESS) + }) + }); + + it('should set breadcrumbs$ value', () => { + const expectedResult = [ + MOCK_PROGRESS_DATA_IN_PROGRESS.device.manufacturer, + MOCK_PROGRESS_DATA_IN_PROGRESS.device.model, + MOCK_PROGRESS_DATA_IN_PROGRESS.device.firmware + ] + + component.ngOnInit(); + + component.breadcrumbs$.subscribe(res => { + expect(res).toEqual(expectedResult); + }) + }); + + it('should set dataSource$ value', () => { + const expectedResult = TEST_DATA.results; + + component.ngOnInit(); + + component.dataSource$.subscribe(res => { + expect(res).toEqual(expectedResult); + }) + }); + }); + }); + + describe('DOM tests', () => { + beforeEach(async () => { + testRunServiceMock.stopTestrun.and.returnValue(of(true)); + + await TestBed.configureTestingModule({ + declarations: [ + ProgressComponent, + FakeProgressBreadcrumbsComponent, + FakeProgressStatusCardComponent, + FakeProgressTableComponent], + providers: [ + {provide: TestRunService, useValue: testRunServiceMock}, { + provide: MatDialogRef, + useValue: {} + },], + imports: [MatButtonModule, MatIconModule, MatToolbarModule, MatDialogModule, DownloadReportComponent] + }).compileComponents(); + + fixture = TestBed.createComponent(ProgressComponent); + compiled = fixture.nativeElement as HTMLElement; + component = fixture.componentInstance; + }); + + afterEach(() => { + testRunServiceMock.getSystemStatus.calls.reset(); + }); + + describe('with not systemStatus$ data', () => { + beforeEach(() => { + (testRunServiceMock.systemStatus$ as any) = of(null); + fixture.detectChanges(); + }); + + it('should have empty state content', () => { + const emptyContentEl = compiled.querySelector('.progress-content-empty'); + const toolbarEl = compiled.querySelector('.progress-toolbar'); + + expect(emptyContentEl).not.toBeNull(); + expect(toolbarEl).toBeNull(); + }); + + it('should have enabled "Start" button', () => { + const startBtn = compiled.querySelector('.start-button') as HTMLButtonElement; + + expect(startBtn.disabled).toBeFalse(); + }); + + it('should open initiate test run modal when start button clicked', () => { + const openSpy = spyOn(component.dialog, 'open').and + .returnValue({ + afterClosed: () => of(true) + } as MatDialogRef); + const startBtn = compiled.querySelector('.start-button') as HTMLButtonElement; + startBtn.click(); + + expect(openSpy).toHaveBeenCalled(); + expect(openSpy).toHaveBeenCalledWith(ProgressInitiateFormComponent, { + autoFocus: true, + hasBackdrop: true, + disableClose: true, + panelClass: 'initiate-test-run-dialog' + }); + + openSpy.calls.reset(); + }); + }); + + describe('with available systemStatus$ data, status "In Progress"', () => { + beforeEach(() => { + testRunServiceMock.systemStatus$ = of(MOCK_PROGRESS_DATA_IN_PROGRESS); + fixture.detectChanges(); + }); + + it('should have toolbar content', () => { + const emptyContentEl = compiled.querySelector('.progress-content-empty'); + const toolbarEl = compiled.querySelector('.progress-toolbar'); + + expect(toolbarEl).not.toBeNull(); + expect(emptyContentEl).toBeNull(); + }); + + it('should have "Stop" button', () => { + const stopBtn = compiled.querySelector('.stop-button'); + + expect(stopBtn).not.toBeNull(); + }); + + it('should call stopTestrun on click "Stop" button', () => { + const stopBtn = compiled.querySelector('.stop-button') as HTMLButtonElement; + + stopBtn.click(); + + expect(testRunServiceMock.stopTestrun).toHaveBeenCalled(); + }) + + it('should have disabled "Start" button', () => { + const startBtn = compiled.querySelector('.start-button') as HTMLButtonElement; + + expect(startBtn.disabled).toBeTrue(); + }); + + it('should not have "Download Report" button', () => { + const reportBtn = compiled.querySelector('.report-button'); + + expect(reportBtn).toBeNull(); + }); + }); + + describe('pullingSystemStatusData with available status "In Progress"', () => { + it('should call again getSystemStatus)', fakeAsync(() => { + testRunServiceMock.systemStatus$ = of(MOCK_PROGRESS_DATA_IN_PROGRESS); + fixture.detectChanges(); + tick(5000); + + expect(testRunServiceMock.getSystemStatus).toHaveBeenCalledTimes(2); + discardPeriodicTasks(); + })); + }) + + describe('with available systemStatus$ data, as Completed', () => { + beforeEach(() => { + testRunServiceMock.systemStatus$ = of(MOCK_PROGRESS_DATA_COMPLIANT); + fixture.detectChanges(); + }); + + it('should not have "Stop" button', () => { + const stopBtn = compiled.querySelector('.stop-button'); + + expect(stopBtn).toBeNull(); + }); + + it('should have anable "Start" button', () => { + const startBtn = compiled.querySelector('.start-button') as HTMLButtonElement; + + expect(startBtn.disabled).toBeFalse(); + }); + + it('should have "Download Report" button', () => { + const reportBtn = compiled.querySelector('.report-button'); + + expect(reportBtn).not.toBeNull(); + }); + + it('should have report link', () => { + const link = compiled.querySelector('.download-report-link') as HTMLAnchorElement; + + expect(link.href).toEqual('https://api.testrun.io/report.pdf'); + expect(link.download).toEqual('delta_03-din-cpu_1.2.2_compliant_22_jun_2023_9:20'); + expect(link.title).toEqual('Download report for Test Run # Delta 03-DIN-CPU 1.2.2 22 Jun 2023 9:20'); + }); + }); + + describe('with available systemStatus$ data, as Cancelled', () => { + beforeEach(() => { + testRunServiceMock.systemStatus$ = of(MOCK_PROGRESS_DATA_CANCELLED); + fixture.detectChanges(); + }); + + it('should have anable "Start" button', () => { + const startBtn = compiled.querySelector('.start-button') as HTMLButtonElement; + + expect(startBtn.disabled).toBeFalse(); + }); + + it('should not have "Download Report" button', () => { + const reportBtn = compiled.querySelector('.report-button'); + + expect(reportBtn).toBeNull(); + }); + }); + + describe('with available systemStatus$ data, when Testrun not started on Idle status', () => { + beforeEach(() => { + testRunServiceMock.systemStatus$ = of(MOCK_PROGRESS_DATA_NOT_STARTED); + fixture.detectChanges(); + }); + + it('should have empty state content', () => { + const emptyContentEl = compiled.querySelector('.progress-content-empty'); + const toolbarEl = compiled.querySelector('.progress-toolbar'); + + expect(emptyContentEl).not.toBeNull(); + expect(toolbarEl).toBeNull(); + }); + }); + }); +}); + +@Component({ + selector: 'app-progress-breadcrumbs', + template: '
' +}) +class FakeProgressBreadcrumbsComponent { + @Input() breadcrumbs$!: Observable; +} + +@Component({ + selector: 'app-progress-status-card', + template: '
' +}) +class FakeProgressStatusCardComponent { + @Input() systemStatus$!: Observable; +} + +@Component({ + selector: 'app-progress-table', + template: '
' +}) +class FakeProgressTableComponent { + @Input() dataSource$!: Observable; +} diff --git a/modules/ui/src/app/progress/progress.component.ts b/modules/ui/src/app/progress/progress.component.ts new file mode 100644 index 000000000..d0ca4389a --- /dev/null +++ b/modules/ui/src/app/progress/progress.component.ts @@ -0,0 +1,85 @@ +import {ChangeDetectionStrategy, Component, OnDestroy, OnInit} from '@angular/core'; +import {Observable} from 'rxjs/internal/Observable'; +import {TestRunService} from '../test-run.service'; +import {IDevice, IResult, StatusOfTestrun, TestrunStatus, TestsData} from '../model/testrun-status'; +import {interval, map, shareReplay, Subject, takeUntil, tap} from 'rxjs'; +import {MatDialog} from '@angular/material/dialog'; +import {ProgressInitiateFormComponent} from './progress-initiate-form/progress-initiate-form.component'; + +@Component({ + selector: 'app-progress', + templateUrl: './progress.component.html', + styleUrls: ['./progress.component.scss'], + changeDetection: ChangeDetectionStrategy.OnPush +}) +export class ProgressComponent implements OnInit, OnDestroy { + public systemStatus$!: Observable; + public breadcrumbs$!: Observable; + public dataSource$!: Observable; + public readonly StatusOfTestrun = StatusOfTestrun; + + private destroy$: Subject = new Subject(); + private startInterval = false; + + constructor(private readonly testRunService: TestRunService, public dialog: MatDialog) { + this.testRunService.getSystemStatus(); + } + + ngOnInit(): void { + this.systemStatus$ = this.testRunService.systemStatus$.pipe( + tap((res) => { + if (res.status === StatusOfTestrun.InProgress && !this.startInterval) { + this.pullingSystemStatusData(); + } + if (res.status !== StatusOfTestrun.InProgress) { + this.destroy$.next(true); + this.startInterval = false; + } + }), + shareReplay({refCount: true, bufferSize: 1}) + ); + + this.breadcrumbs$ = this.systemStatus$.pipe( + map((res: TestrunStatus) => res?.device), + map((res: IDevice) => [res?.manufacturer, res?.model, res?.firmware]) + ) + + this.dataSource$ = this.systemStatus$.pipe( + map((res: TestrunStatus) => (res.tests as TestsData)?.results) + ); + } + + private pullingSystemStatusData(): void { + this.startInterval = true; + interval(5000).pipe( + takeUntil(this.destroy$), + tap(() => this.testRunService.getSystemStatus()), + ).subscribe(); + } + + public stopTestrun(): void { + this.testRunService.stopTestrun() + .pipe(takeUntil(this.destroy$)) + .subscribe(); + } + + ngOnDestroy() { + this.destroy$.next(true); + this.destroy$.unsubscribe(); + } + + openTestRunModal(): void { + const dialogRef = this.dialog.open(ProgressInitiateFormComponent, { + autoFocus: true, + hasBackdrop: true, + disableClose: true, + panelClass: 'initiate-test-run-dialog' + }); + + dialogRef?.afterClosed() + .pipe(takeUntil(this.destroy$)) + .subscribe((result: any) => { + console.log(result); + }); + } +} diff --git a/modules/ui/src/app/progress/progress.module.ts b/modules/ui/src/app/progress/progress.module.ts new file mode 100644 index 000000000..5c1350683 --- /dev/null +++ b/modules/ui/src/app/progress/progress.module.ts @@ -0,0 +1,47 @@ +import {NgModule} from '@angular/core'; +import {CommonModule} from '@angular/common'; +import {MatButtonModule} from '@angular/material/button'; +import {MatIconModule} from '@angular/material/icon'; +import {MatToolbarModule} from '@angular/material/toolbar'; +import {MatProgressBarModule} from '@angular/material/progress-bar'; +import {MatTableModule} from '@angular/material/table'; + +import {ProgressRoutingModule} from './progress-routing.module'; +import {ProgressComponent} from './progress.component'; +import {ProgressBreadcrumbsComponent} from './progress-breadcrumbs/progress-breadcrumbs.component'; +import {ProgressStatusCardComponent} from './progress-status-card/progress-status-card.component'; +import {ProgressTableComponent} from './progress-table/progress-table.component'; +import {ProgressInitiateFormComponent} from './progress-initiate-form/progress-initiate-form.component'; +import {MatDialogModule} from '@angular/material/dialog'; +import {DeviceItemComponent} from '../components/device-item/device-item.component'; +import {MatInputModule} from '@angular/material/input'; +import {ReactiveFormsModule} from '@angular/forms'; +import {DeviceTestsComponent} from '../components/device-tests/device-tests.component'; +import {DownloadReportComponent} from '../components/download-report/download-report.component'; + +@NgModule({ + declarations: [ + ProgressComponent, + ProgressBreadcrumbsComponent, + ProgressStatusCardComponent, + ProgressTableComponent, + ProgressInitiateFormComponent + ], + imports: [ + CommonModule, + ProgressRoutingModule, + MatButtonModule, + MatIconModule, + MatToolbarModule, + MatProgressBarModule, + MatTableModule, + MatDialogModule, + DeviceItemComponent, + MatInputModule, + ReactiveFormsModule, + DeviceTestsComponent, + DownloadReportComponent + ] +}) +export class ProgressModule { +} diff --git a/modules/ui/src/app/test-run.service.spec.ts b/modules/ui/src/app/test-run.service.spec.ts new file mode 100644 index 000000000..9bd0bee6a --- /dev/null +++ b/modules/ui/src/app/test-run.service.spec.ts @@ -0,0 +1,316 @@ +import {HttpClientTestingModule, HttpTestingController} from '@angular/common/http/testing'; +import {fakeAsync, getTestBed, TestBed, tick} from '@angular/core/testing'; +import {Device, TestModule} from './model/device'; + +import {TestRunService} from './test-run.service'; +import {SystemConfig} from './model/setting'; +import {MOCK_PROGRESS_DATA_IN_PROGRESS} from './mocks/progress.mock'; +import {StatusOfTestResult, TestrunStatus} from './model/testrun-status'; + +const MOCK_SYSTEM_CONFIG: SystemConfig = { + network: { + device_intf: 'mockDeviceValue', + internet_intf: 'mockInternetValue' + } +} + +describe('TestRunService', () => { + let injector: TestBed; + let httpTestingController: HttpTestingController; + let service: TestRunService; + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [HttpClientTestingModule], + providers: [TestRunService] + }); + injector = getTestBed(); + httpTestingController = injector.get(HttpTestingController); + service = injector.get(TestRunService); + }); + + afterEach(() => { + httpTestingController.verify(); + }); + + it('should be created', () => { + expect(service).toBeTruthy(); + }); + + it('should have test modules', () => { + expect(service.getTestModules()).toEqual([ + { + displayName: "Connection", + name: "connection", + enabled: true + }, + { + displayName: "NTP", + name: "ntp", + enabled: true + }, + { + displayName: "DHCP", + name: "dhcp", + enabled: true + }, + { + displayName: "DNS", + name: "dns", + enabled: true + }, + { + displayName: "Services", + name: "nmap", + enabled: true + }, + { + displayName: "Security", + name: "security", + enabled: true + }, + { + displayName: "TLS", + name: "tls", + enabled: true + }, + { + displayName: "Smart Ready", + name: "udmi", + enabled: false + }, + ] as TestModule[]); + }); + + it('getDevices should return devices', () => { + let result: Device[] | null = null; + const deviceArray = [{ + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": true + }, + "ntp": { + "enabled": false + }, + "baseline": { + "enabled": false + }, + "nmap": { + "enabled": false + } + } + }] as Device[]; + + service.getDevices().subscribe((res) => { + expect(res).toEqual(result); + }); + + result = deviceArray; + service.fetchDevices(); + const req = httpTestingController.expectOne('http://localhost:8000/devices'); + + expect(req.request.method).toBe('GET'); + + req.flush(deviceArray); + }); + + it('setSystemConfig should update the systemConfig data', () => { + service.setSystemConfig(MOCK_SYSTEM_CONFIG); + + service.systemConfig$.subscribe(data => { + expect(data).toEqual(MOCK_SYSTEM_CONFIG); + }) + + }) + + it('getSystemConfig should return systemConfig data', () => { + const apiUrl = 'http://localhost:8000/system/config' + + service.getSystemConfig().subscribe((res) => { + expect(res).toEqual(MOCK_SYSTEM_CONFIG); + }); + + const req = httpTestingController.expectOne(apiUrl); + expect(req.request.method).toBe('GET'); + req.flush(MOCK_SYSTEM_CONFIG); + }); + + it('createSystemConfig should call systemConfig data', () => { + const apiUrl = 'http://localhost:8000/system/config' + + service.createSystemConfig(MOCK_SYSTEM_CONFIG).subscribe((res) => { + expect(res).toEqual({}); + }); + + const req = httpTestingController.expectOne(apiUrl); + expect(req.request.method).toBe('POST'); + expect(req.request.body).toEqual(MOCK_SYSTEM_CONFIG); + req.flush({}); + }); + + it('getSystemInterfaces should return array of interfaces', () => { + const apiUrl = 'http://localhost:8000/system/interfaces' + const mockSystemInterfaces: string[] = ['mockValue', 'mockValue']; + + service.getSystemInterfaces().subscribe((res) => { + expect(res).toEqual(mockSystemInterfaces); + }); + + const req = httpTestingController.expectOne(apiUrl); + expect(req.request.method).toBe('GET'); + req.flush(mockSystemInterfaces); + }); + + it('hasDevice should return true if device with mac address already exist', fakeAsync(() => { + const deviceArray = [{ + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": true + }, + "ntp": { + "enabled": false + }, + "baseline": { + "enabled": false + }, + "nmap": { + "enabled": false + } + } + }] as Device[]; + service.setDevices(deviceArray); + tick(); + + expect(service.hasDevice("00:1e:42:35:73:c4")).toEqual(true); + expect(service.hasDevice(" 00:1e:42:35:73:c4 ")).toEqual(true); + })); + + it('getSystemStatus should get system status data', () => { + const result = MOCK_PROGRESS_DATA_IN_PROGRESS; + + service.systemStatus$.subscribe((res) => { + expect(res).toEqual(result); + }); + + service.getSystemStatus(); + const req = httpTestingController.expectOne('http://localhost:8000/system/status'); + expect(req.request.method).toBe('GET'); + req.flush(result); + }); + + it('stopTestrun should have necessary request data', () => { + const apiUrl = 'http://localhost:8000/system/stop' + + service.stopTestrun().subscribe((res) => { + expect(res).toEqual(true); + }); + + const req = httpTestingController.expectOne(apiUrl); + expect(req.request.method).toBe('POST'); + expect(req.request.body).toEqual({}); + req.flush({}); + }); + + it('getHistory should return history', () => { + let result: TestrunStatus[] = []; + + const history = [{ + "status": "Completed", + "device": { + "manufacturer": "Delta", + "model": "03-DIN-SRC", + "mac_addr": "01:02:03:04:05:06", + "firmware": "1.2.2" + }, + "report": "https://api.testrun.io/report.pdf", + "started": "2023-06-22T10:11:00.123Z", + "finished": "2023-06-22T10:17:00.123Z", + }] as TestrunStatus[]; + + service.getHistory().subscribe((res) => { + expect(res).toEqual(result); + }); + + result = history; + service.fetchHistory(); + const req = httpTestingController.expectOne('http://localhost:8000/history'); + + expect(req.request.method).toBe('GET'); + + req.flush(history); + }); + + describe('#getResultClass', () => { + it('should return class "green" if test result is "Compliant" or "Smart Ready"', () => { + const expectedResult = { + green: true, red: false, grey: false + }; + + const result1 = service.getResultClass(StatusOfTestResult.Compliant); + const result2 = service.getResultClass(StatusOfTestResult.SmartReady); + + expect(result1).toEqual(expectedResult); + expect(result2).toEqual(expectedResult); + }); + + it('should return class "read" if test result is "Non Compliant"', () => { + const expectedResult = { + green: false, red: true, grey: false + }; + + const result = service.getResultClass(StatusOfTestResult.NonCompliant); + + expect(result).toEqual(expectedResult); + }); + + it('should return class "grey" if test result is "Skipped" or "Not Started"', () => { + const expectedResult = { + green: false, red: false, grey: true + }; + + const result1 = service.getResultClass(StatusOfTestResult.Skipped); + const result2 = service.getResultClass(StatusOfTestResult.NotStarted); + + expect(result1).toEqual(expectedResult); + expect(result2).toEqual(expectedResult); + }); + }); + + describe('#addDevice', () => { + it('should create array with new value if previous value is null', function () { + const device = { + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + } as Device; + service.addDevice(device); + + expect(service.getDevices().value).toEqual([device]); + }); + + it('should add new value if previous value is array', function () { + const device = { + "manufacturer": "Delta", + "model": "O3-DIN-CPU", + "mac_addr": "00:1e:42:35:73:c4", + } as Device; + service.setDevices([device, device]); + service.addDevice(device); + + expect(service.getDevices().value).toEqual([device, device, device]); + }); + + }); +}); diff --git a/modules/ui/src/app/test-run.service.ts b/modules/ui/src/app/test-run.service.ts new file mode 100644 index 000000000..7ebc3f50d --- /dev/null +++ b/modules/ui/src/app/test-run.service.ts @@ -0,0 +1,170 @@ +import {HttpClient} from '@angular/common/http'; +import {Injectable} from '@angular/core'; +import {BehaviorSubject} from 'rxjs/internal/BehaviorSubject'; +import {Observable} from 'rxjs/internal/Observable'; +import {Device, TestModule} from './model/device'; +import {map, ReplaySubject, retry} from 'rxjs'; +import {SystemConfig} from './model/setting'; +import {StatusOfTestResult, StatusResultClassName, TestrunStatus} from './model/testrun-status'; + +const API_URL = 'http://localhost:8000' + +@Injectable({ + providedIn: 'root' +}) +export class TestRunService { + private readonly testModules: TestModule[] = [ + { + displayName: "Connection", + name: "connection", + enabled: true + }, + { + displayName: "NTP", + name: "ntp", + enabled: true + }, + { + displayName: "DHCP", + name: "dhcp", + enabled: true + }, + { + displayName: "DNS", + name: "dns", + enabled: true + }, + { + displayName: "Services", + name: "nmap", + enabled: true + }, + { + displayName: "Security", + name: "security", + enabled: true + }, + { + displayName: "TLS", + name: "tls", + enabled: true + }, + { + displayName: "Smart Ready", + name: "udmi", + enabled: false + }, + ]; + + private devices = new BehaviorSubject(null); + private _systemConfig = new BehaviorSubject({network: {}}); + public systemConfig$ = this._systemConfig.asObservable(); + private systemStatusSubject = new ReplaySubject(1); + public systemStatus$ = this.systemStatusSubject.asObservable(); + private history = new BehaviorSubject([]); + + constructor(private http: HttpClient) { + } + + getDevices(): BehaviorSubject { + return this.devices; + } + + setDevices(devices: Device[]): void { + this.devices.next(devices); + } + + setSystemConfig(config: SystemConfig): void { + this._systemConfig.next(config); + } + + setSystemStatus(status: TestrunStatus): void { + this.systemStatusSubject.next(status); + } + + fetchDevices(): void { + this.http.get(`${API_URL}/devices`).subscribe((devices: Device[]) => { + this.setDevices(devices); + }); + } + + getSystemConfig(): Observable { + return this.http + .get(`${API_URL}/system/config`) + .pipe(retry(1)) + } + + createSystemConfig(data: SystemConfig): Observable { + return this.http + .post(`${API_URL}/system/config`, data) + .pipe(retry(1)); + } + + getSystemInterfaces(): Observable { + return this.http + .get(`${API_URL}/system/interfaces`) + .pipe(retry(1)); + } + + getSystemStatus(): void { + this.http + .get(`${API_URL}/system/status`) + .subscribe((res: TestrunStatus) => { + this.setSystemStatus(res); + }); + } + + stopTestrun(): Observable { + return this.http + .post(`${API_URL}/system/stop`, {}) + .pipe(retry(1), map(() => true)); + } + + getTestModules(): TestModule[] { + return this.testModules; + } + + saveDevice(device: Device): Observable { + return this.http + .post(`${API_URL}/device`, JSON.stringify(device)) + .pipe(retry(1), map(() => true)); + } + + hasDevice(macAddress: string): boolean { + return this.devices.value?.some(device => device.mac_addr === macAddress.trim()) || false; + } + + addDevice(device: Device): void { + this.devices.next(this.devices.value ? this.devices.value.concat([device]) : [device]); + } + + updateDevice(deviceToUpdate: Device, update: Device): void { + const device = this.devices.value?.find(device => update.mac_addr === device.mac_addr)!; + device.model = update.model + device.manufacturer = update.manufacturer + device.test_modules = update.test_modules; + + this.devices.next(this.devices.value); + } + + fetchHistory(): void { + this.http + .get(`${API_URL}/history`) + .pipe(retry(1)) + .subscribe(data => { + this.history.next(data) + }); + } + + getHistory(): Observable { + return this.history; + } + + public getResultClass(result: string): StatusResultClassName { + return { + 'green': result === StatusOfTestResult.Compliant || result === StatusOfTestResult.SmartReady, + 'red': result === StatusOfTestResult.NonCompliant, + 'grey': result === StatusOfTestResult.Skipped || result === StatusOfTestResult.NotStarted + } + } +} diff --git a/modules/ui/src/assets/.gitkeep b/modules/ui/src/assets/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/modules/ui/src/assets/icons/close.svg b/modules/ui/src/assets/icons/close.svg new file mode 100644 index 000000000..ce01e8b2d --- /dev/null +++ b/modules/ui/src/assets/icons/close.svg @@ -0,0 +1,3 @@ + + + diff --git a/modules/ui/src/assets/icons/devices.svg b/modules/ui/src/assets/icons/devices.svg new file mode 100644 index 000000000..7bb8bafc7 --- /dev/null +++ b/modules/ui/src/assets/icons/devices.svg @@ -0,0 +1,5 @@ + + + diff --git a/modules/ui/src/assets/icons/devices_add.svg b/modules/ui/src/assets/icons/devices_add.svg new file mode 100644 index 000000000..1992e6298 --- /dev/null +++ b/modules/ui/src/assets/icons/devices_add.svg @@ -0,0 +1,9 @@ + + + + + + diff --git a/modules/ui/src/assets/icons/menu.svg b/modules/ui/src/assets/icons/menu.svg new file mode 100644 index 000000000..e33f5fc43 --- /dev/null +++ b/modules/ui/src/assets/icons/menu.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/modules/ui/src/assets/icons/reports.svg b/modules/ui/src/assets/icons/reports.svg new file mode 100644 index 000000000..944b31409 --- /dev/null +++ b/modules/ui/src/assets/icons/reports.svg @@ -0,0 +1,5 @@ + + + diff --git a/modules/ui/src/assets/icons/testrun_logo_color.svg b/modules/ui/src/assets/icons/testrun_logo_color.svg new file mode 100644 index 000000000..00ded5e09 --- /dev/null +++ b/modules/ui/src/assets/icons/testrun_logo_color.svg @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + diff --git a/modules/ui/src/assets/icons/testrun_logo_small.svg b/modules/ui/src/assets/icons/testrun_logo_small.svg new file mode 100644 index 000000000..96909375b --- /dev/null +++ b/modules/ui/src/assets/icons/testrun_logo_small.svg @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + diff --git a/modules/ui/src/favicon.ico b/modules/ui/src/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..997406ad22c29aae95893fb3d666c30258a09537 GIT binary patch literal 948 zcmV;l155mgP)CBYU7IjCFmI-B}4sMJt3^s9NVg!P0 z6hDQy(L`XWMkB@zOLgN$4KYz;j0zZxq9KKdpZE#5@k0crP^5f9KO};h)ZDQ%ybhht z%t9#h|nu0K(bJ ztIkhEr!*UyrZWQ1k2+YkGqDi8Z<|mIN&$kzpKl{cNP=OQzXHz>vn+c)F)zO|Bou>E z2|-d_=qY#Y+yOu1a}XI?cU}%04)zz%anD(XZC{#~WreV!a$7k2Ug`?&CUEc0EtrkZ zL49MB)h!_K{H(*l_93D5tO0;BUnvYlo+;yss%n^&qjt6fZOa+}+FDO(~2>G z2dx@=JZ?DHP^;b7*Y1as5^uphBsh*s*z&MBd?e@I>-9kU>63PjP&^#5YTOb&x^6Cf z?674rmSHB5Fk!{Gv7rv!?qX#ei_L(XtwVqLX3L}$MI|kJ*w(rhx~tc&L&xP#?cQow zX_|gx$wMr3pRZIIr_;;O|8fAjd;1`nOeu5K(pCu7>^3E&D2OBBq?sYa(%S?GwG&_0-s%_v$L@R!5H_fc)lOb9ZoOO#p`Nn`KU z3LTTBtjwo`7(HA6 z7gmO$yTR!5L>Bsg!X8616{JUngg_@&85%>W=mChTR;x4`P=?PJ~oPuy5 zU-L`C@_!34D21{fD~Y8NVnR3t;aqZI3fIhmgmx}$oc-dKDC6Ap$Gy>a!`A*x2L1v0 WcZ@i?LyX}70000 + + + + TestRunUi + + + + + + + + + + + + diff --git a/modules/ui/src/main.ts b/modules/ui/src/main.ts new file mode 100644 index 000000000..cd5b60424 --- /dev/null +++ b/modules/ui/src/main.ts @@ -0,0 +1,7 @@ +import {platformBrowserDynamic} from '@angular/platform-browser-dynamic'; + +import {AppModule} from './app/app.module'; + +platformBrowserDynamic() + .bootstrapModule(AppModule) + .catch((err) => console.error(err)); diff --git a/modules/ui/src/styles.scss b/modules/ui/src/styles.scss new file mode 100644 index 000000000..31e46a795 --- /dev/null +++ b/modules/ui/src/styles.scss @@ -0,0 +1,63 @@ +@import './theming/theme'; + +html, body { + height: 100%; +} + +body { + margin: 0; + font-family: 'Open Sans', sans-serif; +} + +.app-sidebar-button-active .mat-icon path { + fill: $white; +} + +.app-sidebar-button.mat-mdc-icon-button .mat-mdc-button-persistent-ripple, +.app-toolbar-button.mat-mdc-icon-button .mat-mdc-button-persistent-ripple { + border-radius: inherit; +} + +.device-form-dialog, .initiate-test-run-dialog { + max-height: 100vh; +} + +.device-form-dialog .mat-mdc-dialog-container .mdc-dialog__surface { + overflow: hidden; + display: grid; + grid-template-rows: 1fr; + min-width: 300px; +} + +.device-form-dialog .mat-mdc-dialog-container { + --mdc-dialog-container-shape: 12px; + border-radius: 12px; +} + +mat-hint { + color: #5F6368; +} + +.table-cell-result-text { + margin: 0; + padding: 4px; + border-radius: 2px; + font-size: 12px; + line-height: 16px; + letter-spacing: 0.3px; + + &.green { + background: $green-50; + color: $green-800; + } + + &.red { + background: $red-50; + color: $red-700; + } + + &.grey { + background: $color-background-grey; + color: $grey-800; + } +} diff --git a/modules/ui/src/theming/colors.scss b/modules/ui/src/theming/colors.scss new file mode 100644 index 000000000..e258a90c6 --- /dev/null +++ b/modules/ui/src/theming/colors.scss @@ -0,0 +1,141 @@ +$black: #000000; +$white: #ffffff; +$primary: #4285F4; +$secondary: #5f6368; +$accent: #008B00; +$warn: #C5221F; +$color-background-grey: #F8F9FA; +$dark-grey: #444746; +$grey-800: #3C4043; +$light-grey: #BDC1C6; +$lighter-grey: #DADCE0; +$green-50: #E6F4EA; +$green-800: #137333; +$red-50: #FCE8E6; +$red-700: #C5221F; +$red-800: #B31412; + +$color-primary: ( + 50: #E8F0FE, + 100: #b9dafa, + 200: #8cc3f8, + 300: #5eacf4, + 400: #3b9bf3, + 500: $primary, + 600: #1A73E8, + 700: #1967D2, + 800: #185ABC, + 900: #143b9d, + contrast: ( + 50: $black, + 100: $black, + 200: $black, + 300: $black, + 400: $white, + 500: $white, + 600: $white, + 700: $white, + 800: $white, + 900: $white + ) +); + +$color-blue-light: ( + 50 : #fcfdff, + 100 : #f8fbff, + 200 : #f4f8ff, + 300 : #eff5fe, + 400 : #ebf2fe, + 500 : #e8f0fe, + 600 : #e5eefe, + 700 : #e2ecfe, + 800 : #dee9fe, + 900 : #d8e5fd, + contrast: ( + 50 : $black, + 100 : $black, + 200 : $black, + 300 : $black, + 400 : $black, + 500 : $black, + 600 : $black, + 700 : $black, + 800 : $black, + 900 : $black + ) +); + +$color-secondary: ( + 50: #fafbfa, + 100: #f5f6f6, + 200: #f1f2f1, + 300: #e6e7e7, + 400: #c4c5c4, + 500: $secondary, + 600: #595858, + 700: #545555, + 800: #363737, + 900: #171717, + contrast: ( + 50: $black, + 100: $black, + 200: $black, + 300: $black, + 400: $white, + 500: $white, + 600: $white, + 700: $white, + 800: $white, + 900: $white + ) +); + +$color-accent: ( + 50: #e6f5e5, + 100: #CEEAD6, + 200: #9cd494, + 300: #72c568, + 400: #4fb846, + 500: $accent, + 600: #1a9d12, + 700: #188038, + 800: #007a00, + 900: #005c00, + contrast: ( + 50: $black, + 100: $black, + 200: $black, + 300: $white, + 400: $white, + 500: $white, + 600: $white, + 700: $white, + 800: $white, + 900: $white + ) +); + +$color-warn: ( + 50: #ffeaed, + 100: #ffccd0, + 200: #ef9896, + 300: #e5706d, + 400: #ee4f48, + 500: $warn, + 600: #e4342c, + 700: #C5221F, + 800: #b61312, + 900: #b61312, + contrast: ( + 50: $black, + 100: $black, + 200: $black, + 300: $black, + 400: $black, + 500: $white, + 600: $white, + 700: $white, + 800: $white, + 900: $white + ) +); diff --git a/modules/ui/src/theming/theme.scss b/modules/ui/src/theming/theme.scss new file mode 100644 index 000000000..fe91cd1dd --- /dev/null +++ b/modules/ui/src/theming/theme.scss @@ -0,0 +1,49 @@ +@use '@angular/material' as mat; +@import url('https://fonts.googleapis.com/css2?family=Open+Sans&display=swap'); +@import "colors"; + +@include mat.core(); +@include mat.strong-focus-indicators(( + outline-style: solid, + outline-width: 2px, + outline-color: $black, +)); + +$app-primary: mat.define-palette($color-primary); +$app-accent: mat.define-palette($color-accent); +$app-warn: mat.define-palette($color-warn); +$app-secondary: mat.define-palette($color-secondary); +$app-blue-light-palette: mat.define-palette($color-blue-light); + +$app-typography: mat.define-typography-config( + $font-family: 'Open Sans' +); + +$brand-light-theme: mat.define-light-theme(( + color: ( + primary: $app-primary, + accent: $app-accent, + warn: $app-warn, + ), + typography: $app-typography, + density: 0, +)); + +$brand-light-theme-secondary: mat.define-light-theme(( + color: ( + primary: $app-primary, + accent: $app-secondary, + warn: $app-warn, + ), + typography: $app-typography, + density: 0, +)); + +@include mat.all-component-themes($brand-light-theme); +@include mat.radio-color($brand-light-theme-secondary); +@include mat.checkbox-color($brand-light-theme-secondary); +@include mat.progress-bar-color((color: ( + primary: $app-blue-light-palette, + accent: $app-secondary, + warn: $app-warn, +))); diff --git a/modules/ui/src/theming/variables.scss b/modules/ui/src/theming/variables.scss new file mode 100644 index 000000000..d9fbbb1a2 --- /dev/null +++ b/modules/ui/src/theming/variables.scss @@ -0,0 +1,3 @@ +$device-item-width: 352px; + +$font-secondary: 'Roboto'; diff --git a/modules/ui/tsconfig.app.json b/modules/ui/tsconfig.app.json new file mode 100644 index 000000000..374cc9d29 --- /dev/null +++ b/modules/ui/tsconfig.app.json @@ -0,0 +1,14 @@ +/* To learn more about this file see: https://angular.io/config/tsconfig. */ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "./out-tsc/app", + "types": [] + }, + "files": [ + "src/main.ts" + ], + "include": [ + "src/**/*.d.ts" + ] +} diff --git a/modules/ui/tsconfig.json b/modules/ui/tsconfig.json new file mode 100644 index 000000000..ed966d43a --- /dev/null +++ b/modules/ui/tsconfig.json @@ -0,0 +1,33 @@ +/* To learn more about this file see: https://angular.io/config/tsconfig. */ +{ + "compileOnSave": false, + "compilerOptions": { + "baseUrl": "./", + "outDir": "./dist/out-tsc", + "forceConsistentCasingInFileNames": true, + "strict": true, + "noImplicitOverride": true, + "noPropertyAccessFromIndexSignature": true, + "noImplicitReturns": true, + "noFallthroughCasesInSwitch": true, + "sourceMap": true, + "declaration": false, + "downlevelIteration": true, + "experimentalDecorators": true, + "moduleResolution": "node", + "importHelpers": true, + "target": "ES2022", + "module": "ES2022", + "useDefineForClassFields": false, + "lib": [ + "ES2022", + "dom" + ] + }, + "angularCompilerOptions": { + "enableI18nLegacyMessageIdFormat": false, + "strictInjectionParameters": true, + "strictInputAccessModifiers": true, + "strictTemplates": true + } +} diff --git a/modules/ui/tsconfig.spec.json b/modules/ui/tsconfig.spec.json new file mode 100644 index 000000000..be7e9da76 --- /dev/null +++ b/modules/ui/tsconfig.spec.json @@ -0,0 +1,14 @@ +/* To learn more about this file see: https://angular.io/config/tsconfig. */ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "./out-tsc/spec", + "types": [ + "jasmine" + ] + }, + "include": [ + "src/**/*.spec.ts", + "src/**/*.d.ts" + ] +} diff --git a/modules/ui/ui.Dockerfile b/modules/ui/ui.Dockerfile index f65f4c48b..24ad08969 100644 --- a/modules/ui/ui.Dockerfile +++ b/modules/ui/ui.Dockerfile @@ -15,5 +15,8 @@ # Image name: test-run/ui FROM nginx:1.25.1 -COPY modules/ui/conf/nginx.conf /etc/nginx/nginx.conf -COPY ui /usr/share/nginx/html \ No newline at end of file +COPY modules/ui/dist/ /usr/share/nginx/html + +EXPOSE 8080 + +CMD ["nginx", "-g", "daemon off;"] \ No newline at end of file diff --git a/testing/tests/test_tests.json b/testing/tests/test_tests.json index 179a3f7fc..7d2b88678 100644 --- a/testing/tests/test_tests.json +++ b/testing/tests/test_tests.json @@ -4,7 +4,7 @@ "args": "oddservices", "ethmac": "02:42:aa:00:00:01", "expected_results": { - "security.nmap.ports": "non-compliant" + "security.nmap.ports": "Non-Compliant" } }, "tester2": { @@ -12,9 +12,9 @@ "args": "ntpv4_dhcp", "ethmac": "02:42:aa:00:00:02", "expected_results": { - "security.nmap.ports": "compliant", - "ntp.network.ntp_support": "compliant", - "ntp.network.ntp_dhcp": "compliant" + "security.nmap.ports": "Compliant", + "ntp.network.ntp_support": "Compliant", + "ntp.network.ntp_dhcp": "Compliant" } } diff --git a/testing/tests/test_tests.py b/testing/tests/test_tests.py index 1f484647a..666e65783 100644 --- a/testing/tests/test_tests.py +++ b/testing/tests/test_tests.py @@ -83,12 +83,12 @@ def test_list_tests(capsys, results, test_matrix): ci_pass = set([test for testers in test_matrix.values() for test, result in testers['expected_results'].items() - if result == 'compliant']) + if result == 'Compliant']) ci_fail = set([test for testers in test_matrix.values() for test, result in testers['expected_results'].items() - if result == 'non-compliant']) + if result == 'Non-Compliant']) with capsys.disabled(): #TODO print matching the JSON schema for easy copy/paste diff --git a/ui/index.html b/ui/index.html deleted file mode 100644 index 285fce5ad..000000000 --- a/ui/index.html +++ /dev/null @@ -1 +0,0 @@ -Test Run \ No newline at end of file From 13ec5b82697f8d002ecfedb03581c20d33733fa9 Mon Sep 17 00:00:00 2001 From: Jacob Boddey Date: Mon, 4 Sep 2023 21:02:54 +0100 Subject: [PATCH 075/400] Add some documentation --- docs/configure_device.md | 2 +- docs/test/modules.md | 13 ++++++++ docs/test/new_module.md | 0 docs/test/new_test.md | 0 modules/test/base/README.md | 19 ++++++++++++ modules/test/baseline/README.md | 21 +++++++++++++ modules/test/baseline/conf/module_config.json | 14 ++++----- modules/test/conn/README.md | 30 +++++++++++++++++++ 8 files changed, 91 insertions(+), 8 deletions(-) create mode 100644 docs/test/modules.md create mode 100644 docs/test/new_module.md create mode 100644 docs/test/new_test.md create mode 100644 modules/test/base/README.md create mode 100644 modules/test/baseline/README.md create mode 100644 modules/test/conn/README.md diff --git a/docs/configure_device.md b/docs/configure_device.md index ad58521a4..320d3c325 100644 --- a/docs/configure_device.md +++ b/docs/configure_device.md @@ -38,4 +38,4 @@ This ensures that you have a copy of the default configuration file, which you c > Note: Ensure that the device configuration file is properly formatted, and the changes made align with the intended test behavior. Incorrect settings or syntax may lead to unexpected results during testing. -If you encounter any issues or need assistance with the device configuration, refer to the Test Run documentation or ask a question on the Issues page. +If you encounter any issues or need assistance with the device configuration, refer to the Testrun documentation or ask a question on the Issues page. diff --git a/docs/test/modules.md b/docs/test/modules.md new file mode 100644 index 000000000..a3016e17f --- /dev/null +++ b/docs/test/modules.md @@ -0,0 +1,13 @@ +# Test Modules + +Testrun provides some pre-built test modules for you to use when testing your own device. These test modules are listed below: + +| Name | Description | Read more | +|---|---|---| +| Base | Template for all test modules | [Base module](/modules/test/base/README.md) | +| Baseline | A sample test module | [Baseline module](/modules/test/baseline/README.md) | +| Connection | Verify IP and DHCP based behavior | [Connection module](/modules/test/conn/README.md) | +| DNS | Verify DNS functionality | [DNS module](/modules/test/dns/README.md) | +| NMAP | Ensure unsecure services are disabled | [NMAP module](/modules/test/nmap/README.md) | +| NTP | Verify NTP functionality | [NTP module](/modules/test/ntp/README.md) | +| TLS | Determine TLS client and server behavior | [TLS module](/modules/test/tls/README.md) | \ No newline at end of file diff --git a/docs/test/new_module.md b/docs/test/new_module.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/test/new_test.md b/docs/test/new_test.md new file mode 100644 index 000000000..e69de29bb diff --git a/modules/test/base/README.md b/modules/test/base/README.md new file mode 100644 index 000000000..e7f05d80e --- /dev/null +++ b/modules/test/base/README.md @@ -0,0 +1,19 @@ +# Base Test Module + +The base test module is a template image for other test modules. No actual tests are run by this module. + +Other test modules utilise this module as a base image to ensure consistency between the test modules and accuracy of the inputs and outputs. + +There is no requirement to re-use this module when creating your own test module, but it can speed up development. + +## What's inside? + +The ```bin``` folder contains multiple useful scripts that can be executed by test modules which use 'base' as a template. + +The ```config/module_config.json``` provides the name and description of the module, but prevents the image from being run as a container during the testing of the device. + +Within the ```python/src``` directory, basic logging and environment variables are provided to the test module. + +## Tests covered + +No tests are run by this module \ No newline at end of file diff --git a/modules/test/baseline/README.md b/modules/test/baseline/README.md new file mode 100644 index 000000000..96a700572 --- /dev/null +++ b/modules/test/baseline/README.md @@ -0,0 +1,21 @@ +# Baseline Test Module + +The baseline test module runs a test for each result status type. This is used for testing purposes - to ensure that the test framework is operational. + +This module is disabled by default when testing a physical device and there is no need for this to be enabled. + +## What's inside? + +The ```bin``` folder contains the startup script for the module. + +The ```config/module_config.json``` provides the name and description of the module, and specifies which tests will be caried out. + +Within the ```python/src``` directory, the below tests are executed. + +## Tests covered + +| ID | Description | Expected behavior | Required result +|---|---|---|---| +| baseline.compliant | Simulate a compliant test | A compliant test result is generated | Required | +| baseline.informational | Simulate an informational test | An informational test result is generated | Informational | +| baseline.non-compliant | Simulate a non-compliant test | A non-compliant test result is generated | Required | \ No newline at end of file diff --git a/modules/test/baseline/conf/module_config.json b/modules/test/baseline/conf/module_config.json index 83b920ea6..f3a832ed0 100644 --- a/modules/test/baseline/conf/module_config.json +++ b/modules/test/baseline/conf/module_config.json @@ -13,22 +13,22 @@ }, "tests":[ { - "name": "baseline.pass", + "name": "baseline.compliant", "description": "Simulate a compliant test", "expected_behavior": "A compliant test result is generated", "required_result": "Required" }, { - "name": "baseline.fail", + "name": "baseline.non-compliant", "description": "Simulate a non-compliant test", "expected_behavior": "A non-compliant test result is generated", - "required_result": "Recommended" + "required_result": "Required" }, { - "name": "baseline.skip", - "description": "Simulate a skipped test", - "expected_behavior": "A skipped test result is generated", - "required_result": "Roadmap" + "name": "baseline.informational", + "description": "Simulate an informational test", + "expected_behavior": "An informational test result is generated", + "required_result": "Informational" } ] } diff --git a/modules/test/conn/README.md b/modules/test/conn/README.md new file mode 100644 index 000000000..48729f388 --- /dev/null +++ b/modules/test/conn/README.md @@ -0,0 +1,30 @@ +# Connection Test Module + +The connection test module runs a collection of tests around the IP and DHCP connectivity between the device and the provided network services. + +## What's inside? + +The ```bin``` folder contains the startup script for the module. + +The ```config/module_config.json``` file provides the name and description of the module, and specifies which tests will be caried out. + +Within the ```python/src``` directory, the below tests are executed. A few dhcp utility methods are included in ```python/src/dhcp_util.py```. + +## Tests covered + +| ID | Description | Expected Behavior | Required Result | +|------------------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| connection.dhcp.disconnect | The device under test has received an IP address from the DHCP server and responds to an ICMP echo (ping) request | The device is not set up with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds successfully to an ICMP echo (ping) request. | Required | +| connection.dhcp.disconnect_ip_change | Update device IP on the DHCP server and reconnect the device. Does the device receive the new IP address? | Device receives a new IP address within the range specified on the DHCP server. Device should respond to a ping on this new address. | Required | +| connection.dhcp_address | The device under test has received an IP address from the DHCP server and responds to an ICMP echo (ping) request | The device is not set up with a static IP address. The device accepts an IP address from a DHCP server (RFC 2131) and responds successfully to an ICMP echo (ping) request. | Required | +| connection.mac_address | Check and note device physical address. | N/A | Required | +| connection.mac_oui | The device under test has a MAC address prefix that is registered against a known manufacturer. | The MAC address prefix is registered in the IEEE Organizationally Unique Identifier database. | Required | +| connection.private_address | The device under test accepts an IP address that is compliant with RFC 1918 Address Allocation for Private Internets. | The device under test accepts IP addresses within all ranges specified in RFC 1918 and communicates using these addresses. The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of the IP address space for private internets: 10.0.0.0 - 10.255.255.255 (10/8 prefix), 172.16.0.0 - 172.31.255.255 (172.16/12 prefix), 192.168.0.0 - 192.168.255.255 (192.168/16 prefix). | Required | +| connection.shared_address | Ensure the device supports RFC 6598 IANA-Reserved IPv4 Prefix for Shared Address Space | The device under test accepts IP addresses within the range specified in RFC 6598 and communicates using these addresses. | Required | +| connection.private_address | The device under test accepts an IP address that is compliant with RFC 1918 Address Allocation for Private Internets. | The device under test accepts IP addresses within all ranges specified in RFC 1918 and communicates using these addresses. The Internet Assigned Numbers Authority (IANA) has reserved the following three blocks of the IP address space for private internets: 10.0.0.0 - 10.255.255.255.255 (10/8 prefix), 172.16.0.0 - 172.31.255.255 (172.16/12 prefix), 192.168.0.0 - 192.168.255.255 (192.168/16 prefix). | Required | +| connection.single_ip | The network switch port connected to the device reports only one IP address for the device under test. | The device under test does not behave as a network switch and only requests one IP address. This test is to avoid that devices implement network switches that allow connecting strings of daisy-chained devices to one single network port, as this would not make 802.1x port-based authentication possible. | Required | +| connection.target_ping | The device under test responds to an ICMP echo (ping) request. | The device under test responds to an ICMP echo (ping) request. | Required | +| connection.ipaddr.ip_change | The device responds to a ping (ICMP echo request) to the new IP address it has received after the initial DHCP lease has expired. | If the lease expires before the client receives a DHCPACK, the client moves to the INIT state, MUST immediately stop any other network processing, and requires network initialization parameters as if the client were uninitialized. If the client then receives a DHCPACK allocating the client its previous network address, the client SHOULD continue network processing. If the client is given a new network address, it MUST NOT continue using the previous network address and SHOULD notify the local users of the problem. | Required | +| connection.ipaddr.dhcp_failover | The device has requested a DHCPREQUEST/REBIND to the DHCP failover server after the primary DHCP server has been brought down. | | Required | +| connection.ipv6_slaac | The device forms a valid IPv6 address as a combination of the IPv6 router prefix and the device interface identifier | The device under test complies with RFC4862 and forms a valid IPv6 SLAAC address. | Required | +| connection.ipv6_ping | The device responds to an IPv6 ping (ICMPv6 Echo) request to the SLAAC address | The device responds to the ping as per RFC4443 | Required | From 702147cf8c24f1d149d7165161d4a7d922885a1c Mon Sep 17 00:00:00 2001 From: J Boddey Date: Sat, 9 Sep 2023 20:18:42 +0100 Subject: [PATCH 076/400] Save test modules (#115) --- framework/python/src/api/api.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/framework/python/src/api/api.py b/framework/python/src/api/api.py index 044a72178..e978f4cf7 100644 --- a/framework/python/src/api/api.py +++ b/framework/python/src/api/api.py @@ -28,6 +28,7 @@ DEVICE_MAC_ADDR_KEY = "mac_addr" DEVICE_MANUFACTURER_KEY = "manufacturer" DEVICE_MODEL_KEY = "model" +DEVICE_TEST_MODULES_KEY = "test_modules" class Api: """Provide REST endpoints to manage Test Run""" @@ -197,6 +198,7 @@ async def save_device(self, request: Request, response: Response): device.manufacturer = device_json.get(DEVICE_MANUFACTURER_KEY) device.model = device_json.get(DEVICE_MODEL_KEY) device.device_folder = device.manufacturer + " " + device.model + device.test_modules = device_json.get(DEVICE_TEST_MODULES_KEY) self._test_run.create_device(device) response.status_code = status.HTTP_201_CREATED From 5d41edb82b8873a94b12ea14802bf8dc96761355 Mon Sep 17 00:00:00 2001 From: Noureddine Date: Mon, 11 Sep 2023 11:44:24 +0000 Subject: [PATCH 077/400] Expand testing to include API and more testing (#96) --- .github/workflows/testing.yml | 23 +- bin/testrun | 2 +- cmd/install | 3 + framework/python/src/common/session.py | 15 +- framework/python/src/common/testreport.py | 17 +- framework/requirements.txt | 6 +- modules/network/dhcp-1/dhcp-1.Dockerfile | 2 +- modules/network/dhcp-2/dhcp-2.Dockerfile | 2 +- .../baseline/python/src/baseline_module.py | 6 +- testing/api/mockito/get_devices.json | 46 ++ testing/api/mockito/invalid_request.json | 3 + .../api/mockito/running_system_status.json | 26 + testing/api/test_api | 57 ++ testing/api/test_api.py | 557 ++++++++++++++++++ testing/baseline/test_baseline | 2 +- .../only_baseline/device_config.json | 25 + .../device_configs/tester1/device_config.json | 8 +- .../device_configs/tester2/device_config.json | 6 +- .../device_configs/tester3/device_config.json | 22 + testing/docker/ci_test_device1/Dockerfile | 2 +- testing/docker/ci_test_device1/entrypoint.sh | 42 +- testing/pylint/test_pylint | 2 +- testing/tests/test_tests | 52 +- testing/tests/test_tests.json | 20 +- testing/tests/test_tests.py | 20 +- 25 files changed, 908 insertions(+), 58 deletions(-) create mode 100644 testing/api/mockito/get_devices.json create mode 100644 testing/api/mockito/invalid_request.json create mode 100644 testing/api/mockito/running_system_status.json create mode 100755 testing/api/test_api create mode 100644 testing/api/test_api.py create mode 100644 testing/device_configs/only_baseline/device_config.json create mode 100644 testing/device_configs/tester3/device_config.json diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index 87c8a814a..bf1d6ecc0 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -1,7 +1,6 @@ name: Testrun test suite on: - push: pull_request: schedule: - cron: '0 13 * * *' @@ -21,7 +20,6 @@ jobs: testrun_tests: name: Tests runs-on: ubuntu-20.04 - needs: testrun_baseline timeout-minutes: 40 steps: - name: Checkout source @@ -29,6 +27,27 @@ jobs: - name: Run tests shell: bash {0} run: testing/tests/test_tests + - name: Archive runtime results + if: ${{ always() }} + run: sudo tar --exclude-vcs -czf runtime.tgz runtime/ + - name: Upload runtime results + uses: actions/upload-artifact@v3 + if: ${{ always() }} + with: + if-no-files-found: error + name: runtime_${{ github.workflow }}_${{ github.run_id }} + path: runtime.tgz + + testrun_api: + name: API + runs-on: ubuntu-20.04 + timeout-minutes: 40 + steps: + - name: Checkout source + uses: actions/checkout@v2.3.4 + - name: Run tests + shell: bash {0} + run: testing/api/test_api pylint: name: Pylint diff --git a/bin/testrun b/bin/testrun index 5fb8bf232..ea65d3565 100755 --- a/bin/testrun +++ b/bin/testrun @@ -15,7 +15,7 @@ # limitations under the License. if [[ "$EUID" -ne 0 ]]; then - echo "Must run as root. Use sudo testrun" + echo "Must run as root. Use sudo $0" exit 1 fi diff --git a/cmd/install b/cmd/install index 6477b85fb..7997f37fa 100755 --- a/cmd/install +++ b/cmd/install @@ -24,4 +24,7 @@ pip3 install -r framework/requirements.txt # required by python package weasyprint sudo apt-get install libpangocairo-1.0-0 +#TODO move into docker build process +(cd modules/ui && npm install && npm run build) + deactivate \ No newline at end of file diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py index d3d0ca9f4..edf3ce5da 100644 --- a/framework/python/src/common/session.py +++ b/framework/python/src/common/session.py @@ -87,17 +87,21 @@ def _load_config(self): if (NETWORK_KEY in config_file_json and DEVICE_INTF_KEY in config_file_json.get(NETWORK_KEY) and INTERNET_INTF_KEY in config_file_json.get(NETWORK_KEY)): - self._config[NETWORK_KEY][DEVICE_INTF_KEY] = config_file_json.get(NETWORK_KEY, {}).get(DEVICE_INTF_KEY) - self._config[NETWORK_KEY][INTERNET_INTF_KEY] = config_file_json.get(NETWORK_KEY, {}).get(INTERNET_INTF_KEY) + self._config[NETWORK_KEY][DEVICE_INTF_KEY] = config_file_json.get( + NETWORK_KEY, {}).get(DEVICE_INTF_KEY) + self._config[NETWORK_KEY][INTERNET_INTF_KEY] = config_file_json.get( + NETWORK_KEY, {}).get(INTERNET_INTF_KEY) if RUNTIME_KEY in config_file_json: self._config[RUNTIME_KEY] = config_file_json.get(RUNTIME_KEY) if STARTUP_TIMEOUT_KEY in config_file_json: - self._config[STARTUP_TIMEOUT_KEY] = config_file_json.get(STARTUP_TIMEOUT_KEY) + self._config[STARTUP_TIMEOUT_KEY] = config_file_json.get( + STARTUP_TIMEOUT_KEY) if MONITOR_PERIOD_KEY in config_file_json: - self._config[MONITOR_PERIOD_KEY] = config_file_json.get(MONITOR_PERIOD_KEY) + self._config[MONITOR_PERIOD_KEY] = config_file_json.get( + MONITOR_PERIOD_KEY) if LOG_LEVEL_KEY in config_file_json: self._config[LOG_LEVEL_KEY] = config_file_json.get(LOG_LEVEL_KEY) @@ -106,7 +110,8 @@ def _load_config(self): self._config[API_PORT_KEY] = config_file_json.get(API_PORT_KEY) if MAX_DEVICE_REPORTS_KEY in config_file_json: - self._config[MAX_DEVICE_REPORTS_KEY] = config_file_json.get(MAX_DEVICE_REPORTS_KEY) + self._config[MAX_DEVICE_REPORTS_KEY] = config_file_json.get( + MAX_DEVICE_REPORTS_KEY) def _save_config(self): with open(self._config_file, 'w', encoding='utf-8') as f: diff --git a/framework/python/src/common/testreport.py b/framework/python/src/common/testreport.py index d57db58cf..af05f2a2f 100644 --- a/framework/python/src/common/testreport.py +++ b/framework/python/src/common/testreport.py @@ -94,7 +94,7 @@ def to_pdf(self): pdf_bytes = BytesIO() HTML(string=report_html).write_pdf(pdf_bytes) return pdf_bytes - + def to_html(self): json_data = self.to_json() return f''' @@ -118,18 +118,19 @@ def to_html(self): ''' def generate_test_sections(self,json_data): - results = json_data["tests"]["results"] - sections = "" + results = json_data['tests']['results'] + sections = '' for result in results: - sections += self.generate_test_section(result) + sections += self.generate_test_section(result) return sections def generate_test_section(self, result): section_content = '
\n' for key, value in result.items(): - if value is not None: # Check if the value is not None - formatted_key = key.replace('_', ' ').title() # Replace underscores and capitalize - section_content += f'

{formatted_key}: {value}

\n' + if value is not None: # Check if the value is not None + # Replace underscores and capitalize + formatted_key = key.replace('_', ' ').title() + section_content += f'

{formatted_key}: {value}

\n' section_content += '
\n
\n' return section_content @@ -171,4 +172,4 @@ def generate_css(self): text-decoration: none; color: #007bff; } - ''' \ No newline at end of file + ''' diff --git a/framework/requirements.txt b/framework/requirements.txt index 7141ae706..d833aca06 100644 --- a/framework/requirements.txt +++ b/framework/requirements.txt @@ -14,4 +14,8 @@ weasyprint fastapi==0.99.1 psutil uvicorn -pydantic==1.10.11 \ No newline at end of file +pydantic==1.10.11 + +# Requirements for testing +pytest +pytest-timeout \ No newline at end of file diff --git a/modules/network/dhcp-1/dhcp-1.Dockerfile b/modules/network/dhcp-1/dhcp-1.Dockerfile index 6b941d878..49845cc3b 100644 --- a/modules/network/dhcp-1/dhcp-1.Dockerfile +++ b/modules/network/dhcp-1/dhcp-1.Dockerfile @@ -25,7 +25,7 @@ RUN apt-get install -y wget RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ # Install dhcp server -RUN apt-get install -y isc-dhcp-server radvd systemd +RUN apt-get update && apt-get install -y isc-dhcp-server radvd systemd # Copy over all configuration files COPY $MODULE_DIR/conf /testrun/conf diff --git a/modules/network/dhcp-2/dhcp-2.Dockerfile b/modules/network/dhcp-2/dhcp-2.Dockerfile index 153aa50e7..e91465f36 100644 --- a/modules/network/dhcp-2/dhcp-2.Dockerfile +++ b/modules/network/dhcp-2/dhcp-2.Dockerfile @@ -25,7 +25,7 @@ RUN apt-get install -y wget RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ # Install dhcp server -RUN apt-get install -y isc-dhcp-server radvd systemd +RUN apt-get update && apt-get install -y isc-dhcp-server radvd systemd # Copy over all configuration files COPY $MODULE_DIR/conf /testrun/conf diff --git a/modules/test/baseline/python/src/baseline_module.py b/modules/test/baseline/python/src/baseline_module.py index 978f916fe..0e6222361 100644 --- a/modules/test/baseline/python/src/baseline_module.py +++ b/modules/test/baseline/python/src/baseline_module.py @@ -27,17 +27,17 @@ def __init__(self, module): global LOGGER LOGGER = self._get_logger() - def _baseline_pass(self): + def _baseline_compliant(self): LOGGER.info('Running baseline pass test') LOGGER.info('Baseline pass test finished') return True, 'Baseline pass test ran successfully' - def _baseline_fail(self): + def _baseline_non_compliant(self): LOGGER.info('Running baseline fail test') LOGGER.info('Baseline fail test finished') return False, 'Baseline fail test ran successfully' - def _baseline_skip(self): + def _baseline_informational(self): LOGGER.info('Running baseline skip test') LOGGER.info('Baseline skip test finished') return None, 'Baseline skip test ran successfully' diff --git a/testing/api/mockito/get_devices.json b/testing/api/mockito/get_devices.json new file mode 100644 index 000000000..2609eda35 --- /dev/null +++ b/testing/api/mockito/get_devices.json @@ -0,0 +1,46 @@ +[ + { + "mac_addr": "00:1e:42:35:73:c4", + "manufacturer": "Teltonika", + "model": "TRB 140", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": true + }, + "ntp": { + "enabled": false + }, + "baseline": { + "enabled": false + }, + "nmap": { + "enabled": false + } + } + }, + { + "mac_addr": "aa:bb:cc:dd:ee:ff", + "manufacturer": "Manufacturer X", + "model": "Device X", + "test_modules": { + "dns": { + "enabled": true + }, + "connection": { + "enabled": true + }, + "ntp": { + "enabled": true + }, + "baseline": { + "enabled": false + }, + "nmap": { + "enabled": true + } + } + } + ] \ No newline at end of file diff --git a/testing/api/mockito/invalid_request.json b/testing/api/mockito/invalid_request.json new file mode 100644 index 000000000..5104263fd --- /dev/null +++ b/testing/api/mockito/invalid_request.json @@ -0,0 +1,3 @@ +{ + "error": "Invalid request received" +} \ No newline at end of file diff --git a/testing/api/mockito/running_system_status.json b/testing/api/mockito/running_system_status.json new file mode 100644 index 000000000..68a758b9c --- /dev/null +++ b/testing/api/mockito/running_system_status.json @@ -0,0 +1,26 @@ +{ + "status": "In Progress", + "device": { + "manufacturer": "Delta", + "model": "03-DIN-CPU", + "mac_addr": "01:02:03:04:05:06", + "firmware": "1.2.2" + }, + "started": "2023-06-22T09:20:00.123Z", + "finished": null, + "tests": { + "total": 26, + "results": [ + { + "name": "dns.network.hostname_resolution", + "description": "The device should resolve hostnames", + "result": "Compliant" + }, + { + "name": "dns.network.from_dhcp", + "description": "The device should use the DNS server provided by the DHCP server", + "result": "Non-Compliant" + } + ] + } + } \ No newline at end of file diff --git a/testing/api/test_api b/testing/api/test_api new file mode 100755 index 000000000..146b04156 --- /dev/null +++ b/testing/api/test_api @@ -0,0 +1,57 @@ +#!/bin/bash + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +ifconfig + +# Setup requirements +sudo apt-get update +sudo apt-get install openvswitch-common openvswitch-switch tcpdump jq moreutils coreutils isc-dhcp-client + +pip3 install pytest + +# Setup device network +sudo ip link add dev dummynet type dummy +sudo ip link add dev endev0a type veth peer name endev0b +sudo ip link set dev endev0a up +sudo ip link set dev endev0b up +sudo docker network create -d macvlan -o parent=endev0b endev0 + +sudo ip link add dev dummynet type dummy + +# Start OVS +sudo /usr/share/openvswitch/scripts/ovs-ctl start + +# Build Test Container +sudo docker build ./testing/docker/ci_test_device1 -t ci_test_device1 -f ./testing/docker/ci_test_device1/Dockerfile + +sudo chown -R $USER local + +cat <local/system.json +{ + "network": { + "device_intf": "endev0a", + "internet_intf": "dummynet" + }, + "log_level": "DEBUG" +} +EOF + +sudo cmd/install + +# Needs to be sudo because this invokes bin/testrun +sudo venv/bin/python -m pytest -v testing/api/test_api.py + +exit $? \ No newline at end of file diff --git a/testing/api/test_api.py b/testing/api/test_api.py new file mode 100644 index 000000000..f5f5b516b --- /dev/null +++ b/testing/api/test_api.py @@ -0,0 +1,557 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Test assertions for CI network baseline test""" +# Temporarily disabled because using Pytest fixtures +# TODO refactor fixtures to not trigger error +# pylint: disable=redefined-outer-name + +from collections.abc import Awaitable, Callable +import copy +import json +import os +from pathlib import Path +import re +import shutil +import shutil +import signal +import subprocess +import time +from typing import Iterator +import pytest +import requests + +ALL_DEVICES = "*" +API = "http://127.0.0.1:8000" +LOG_PATH = "/tmp/testrun.log" +TEST_SITE_DIR = ".." + +DEVICES_DIRECTORY = "../../local/devices" +TESTING_DEVICES = "../device_configs/" +SYSTEM_CONFIG_PATH = "../../local/system.json" + +BASELINE_MAC_ADDR = "02:42:aa:00:01:01" +ALL_MAC_ADDR = "02:42:aa:00:00:01" + + +def pretty_print(dictionary: dict): + """ Pretty print dictionary """ + print(json.dumps(dictionary, indent=4)) + + +def query_system_status() -> str: + """Query system status from API and returns this""" + r = requests.get(f"{API}/system/status") + response = json.loads(r.text) + return response["status"] + + +def query_test_count() -> int: + """Queries status and returns number of test results""" + r = requests.get(f"{API}/system/status") + response = json.loads(r.text) + return len(response["tests"]["results"]) + + +def start_test_device( + device_name, mac_address, image_name="ci_test_device1", args="" +): + """ Start test device container with given name """ + cmd = subprocess.run( + f"docker run -d --network=endev0 --mac-address={mac_address}" + f" --cap-add=NET_ADMIN -v /tmp:/out --privileged --name={device_name}" + f" {image_name} {args}", + shell=True, + check=True, + capture_output=True, + ) + print(cmd.stdout) + + +def stop_test_device(device_name): + """ Stop docker container with given name """ + cmd = subprocess.run( + f"docker stop {device_name}", shell=True, capture_output=True + ) + print(cmd.stdout) + cmd = subprocess.run( + f"docker rm {device_name}", shell=True, capture_output=True + ) + print(cmd.stdout) + + +def docker_logs(device_name): + """ Print docker logs from given docker container name """ + cmd = subprocess.run( + f"docker logs {device_name}", shell=True, capture_output=True + ) + print(cmd.stdout) + + +@pytest.fixture +def empty_devices_dir(): + """ Use e,pty devices directory """ + local_delete_devices(ALL_DEVICES) + + +@pytest.fixture +def testing_devices(): + """ Use devices from the testing/device_configs directory """ + local_delete_devices(ALL_DEVICES) + shutil.copytree( + os.path.join(os.path.dirname(__file__), TESTING_DEVICES), + os.path.join(os.path.dirname(__file__), DEVICES_DIRECTORY), + dirs_exist_ok=True, + ) + return local_get_devices() + + +@pytest.fixture +def testrun(request): + """ Start intstance of testrun """ + test_name = request.node.originalname + proc = subprocess.Popen( + "bin/testrun", + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + encoding="utf-8", + preexec_fn=os.setsid, + ) + + while True: + try: + outs, errs = proc.communicate(timeout=1) + except subprocess.TimeoutExpired as e: + if e.output is not None: + output = e.output.decode("utf-8") + if re.search("API waiting for requests", output): + break + except Exception as e: + pytest.fail("testrun terminated") + + time.sleep(2) + + yield + + os.killpg(os.getpgid(proc.pid), signal.SIGTERM) + try: + outs, errs = proc.communicate(timeout=60) + except Exception as e: + print(e.output) + os.killpg(os.getpgid(proc.pid), signal.SIGKILL) + pytest.exit( + "waited 60s but test run did not cleanly exit .. terminating all tests" + ) + + print(outs) + + cmd = subprocess.run( + f"docker stop $(docker ps -a -q)", shell=True, capture_output=True + ) + print(cmd.stdout) + cmd = subprocess.run( + f"docker rm $(docker ps -a -q)", shell=True, capture_output=True + ) + print(cmd.stdout) + + +def until_true(func: Callable, message: str, timeout: int): + """ Blocks until given func returns True + + Raises: + Exception if timeout has elapsed + """ + expiry_time = time.time() + timeout + while time.time() < expiry_time: + if func(): + return True + time.sleep(1) + raise Exception(f"Timed out waiting {timeout}s for {message}") + + +def dict_paths(thing: dict, stem: str = "") -> Iterator[str]: + """Returns json paths (in dot notation) from a given dictionary""" + for k, v in thing.items(): + path = f"{stem}.{k}" if stem else k + if isinstance(v, dict): + yield from dict_paths(v, path) + else: + yield path + + +def get_network_interfaces(): + """return list of network interfaces on machine + + uses /sys/class/net rather than inetfaces as test-run uses the latter + """ + path = Path("/sys/class/net") + return [i.stem for i in path.iterdir() if i.is_dir()] + + +def local_delete_devices(path): + """ Deletes all local devices + """ + devices_path = os.path.join(os.path.dirname(__file__), DEVICES_DIRECTORY) + for thing in Path(devices_path).glob(path): + if thing.is_file(): + thing.unlink() + else: + shutil.rmtree(thing) + + +def local_get_devices(): + """ Returns path to device configs of devices in local/devices directory""" + return sorted( + Path(os.path.join(os.path.dirname(__file__), DEVICES_DIRECTORY)).glob( + "*/device_config.json" + ) + ) + + +def test_get_system_interfaces(testrun): + """Tests API system interfaces against actual local interfaces""" + r = requests.get(f"{API}/system/interfaces") + response = json.loads(r.text) + local_interfaces = get_network_interfaces() + assert set(response) == set(local_interfaces) + + # schema expects a flat list + assert all([isinstance(x, str) for x in response]) + + +def test_modify_device(testing_devices, testrun): + with open( + os.path.join( + os.path.dirname(__file__), DEVICES_DIRECTORY, testing_devices[1] + ) + ) as f: + local_device = json.load(f) + + mac_addr = local_device["mac_addr"] + new_model = "Alphabet" + + r = requests.get(f"{API}/devices") + all_devices = json.loads(r.text) + + api_device = next(x for x in all_devices if x["mac_addr"] == mac_addr) + + updated_device = copy.deepcopy(api_device) + updated_device["model"] = new_model + + new_test_modules = { + k: {"enabled": not v["enabled"]} + for k, v in updated_device["test_modules"].items() + } + updated_device["test_modules"] = new_test_modules + + print("updated_device") + pretty_print(updated_device) + print("api_device") + pretty_print(api_device) + + # update device + r = requests.post(f"{API}/device", data=json.dumps(updated_device)) + + assert r.status_code == 200 + + r = requests.get(f"{API}/devices") + all_devices = json.loads(r.text) + updated_device_api = next(x for x in all_devices if x["mac_addr"] == mac_addr) + + assert updated_device_api["model"] == new_model + assert updated_device_api["test_modules"] == new_test_modules + + + +def test_create_get_devices(empty_devices_dir, testrun): + device_1 = { + "manufacturer": "Google", + "model": "First", + "mac_addr": "00:1e:42:35:73:c4", + "test_modules": { + "dns": {"enabled": True}, + "connection": {"enabled": True}, + "ntp": {"enabled": True}, + "baseline": {"enabled": True}, + "nmap": {"enabled": True}, + }, + } + + r = requests.post(f"{API}/device", data=json.dumps(device_1)) + print(r.text) + device1_response = r.text + assert r.status_code == 201 + assert len(local_get_devices()) == 1 + + device_2 = { + "manufacturer": "Google", + "model": "Second", + "mac_addr": "00:1e:42:35:73:c6", + "test_modules": { + "dns": {"enabled": True}, + "connection": {"enabled": True}, + "ntp": {"enabled": True}, + "baseline": {"enabled": True}, + "nmap": {"enabled": True}, + }, + } + r = requests.post(f"{API}/device", data=json.dumps(device_2)) + device2_response = json.loads(r.text) + assert r.status_code == 201 + assert len(local_get_devices()) == 2 + + # Test that returned devices API endpoint matches expected structure + r = requests.get(f"{API}/devices") + all_devices = json.loads(r.text) + pretty_print(all_devices) + + with open( + os.path.join(os.path.dirname(__file__), "mockito/get_devices.json") + ) as f: + mockito = json.load(f) + + print(mockito) + + # Validate structure + assert all([isinstance(x, dict) for x in all_devices]) + + # TOOO uncomment when is done + # assert set(dict_paths(mockito[0])) == set(dict_paths(all_devices[0])) + + # Validate contents of given keys matches + for key in ["mac_addr", "manufacturer", "model"]: + assert set([all_devices[0][key], all_devices[1][key]]) == set( + [device_1[key], device_2[key]] + ) + + +def test_get_system_config(testrun): + r = requests.get(f"{API}/system/config") + + with open(os.path.join(os.path.dirname(__file__), SYSTEM_CONFIG_PATH)) as f: + local_config = json.load(f) + + api_config = json.loads(r.text) + + # validate structure + assert set(dict_paths(api_config)) | set(dict_paths(local_config)) == set( + dict_paths(api_config) + ) + + assert ( + local_config["network"]["device_intf"] + == api_config["network"]["device_intf"] + ) + assert ( + local_config["network"]["internet_intf"] + == api_config["network"]["internet_intf"] + ) + + +# TODO change to invalid jsdon request +@pytest.mark.skip() +def test_invalid_path_get(testrun): + r = requests.get(f"{API}/blah/blah") + response = json.loads(r.text) + assert r.status_code == 404 + with open( + os.path.join(os.path.dirname(__file__), "mockito/invalid_request.json") + ) as f: + mockito = json.load(f) + + # validate structure + assert set(dict_paths(mockito)) == set(dict_paths(response)) + + +def test_trigger_run(testing_devices, testrun): + payload = {"device": {"mac_addr": BASELINE_MAC_ADDR, "firmware": "asd"}} + r = requests.post(f"{API}/system/start", data=json.dumps(payload)) + assert r.status_code == 200 + + until_true( + lambda: query_system_status().lower() == "waiting for device", + "system status is `waiting for device`", + 30, + ) + + start_test_device("x123", BASELINE_MAC_ADDR) + + until_true( + lambda: query_system_status().lower() == "compliant", + "system status is `complete`", + 900, + ) + + stop_test_device("x123") + + # Validate response + r = requests.get(f"{API}/system/status") + response = json.loads(r.text) + pretty_print(response) + + # Validate results + results = {x["name"]: x for x in response["tests"]["results"]} + print(results) + # there are only 3 baseline tests + assert len(results) == 3 + + # Validate structure + with open( + os.path.join( + os.path.dirname(__file__), "mockito/running_system_status.json" + ) + ) as f: + mockito = json.load(f) + + # validate structure + assert set(dict_paths(mockito)).issubset(set(dict_paths(response))) + + # Validate results structure + assert set(dict_paths(mockito["tests"]["results"][0])).issubset( + set(dict_paths(response["tests"]["results"][0])) + ) + + # Validate a result + assert results["baseline.compliant"]["result"] == "Compliant" + +def test_stop_running_test(testing_devices, testrun): + payload = {"device": {"mac_addr": ALL_MAC_ADDR, "firmware": "asd"}} + r = requests.post(f"{API}/system/start", data=json.dumps(payload)) + assert r.status_code == 200 + + until_true( + lambda: query_system_status().lower() == "waiting for device", + "system status is `waiting for device`", + 30, + ) + + start_test_device("x12345", ALL_MAC_ADDR) + + until_true( + lambda: query_test_count() > 1, + "system status is `complete`", + 1000, + ) + + stop_test_device("x12345") + + # Validate response + r = requests.post(f"{API}/system/stop") + response = json.loads(r.text) + pretty_print(response) + assert response == {"success": "Test Run stopped"} + time.sleep(1) + # Validate response + r = requests.get(f"{API}/system/status") + response = json.loads(r.text) + pretty_print(response) + + #TODO uncomment when bug is fixed + #assert len(response["tests"]["results"]) == response["tests"]["total"] + assert len(response["tests"]["results"]) < 15 + #TODO uncomment when bug is fixed + #assert response["status"] == "Stopped" + + +@pytest.mark.skip() +def test_stop_running_not_running(testrun): + # Validate response + r = requests.post(f"{API}/system/stop") + response = json.loads(r.text) + pretty_print(response) + + assert False + +# TODO enable test because functionality is broken +@pytest.mark.skip() +def test_multiple_runs(testing_devices, testrun): + payload = {"device": {"mac_addr": BASELINE_MAC_ADDR, "firmware": "asd"}} + r = requests.post(f"{API}/system/start", data=json.dumps(payload)) + assert r.status_code == 200 + print(r.text) + + until_true( + lambda: query_system_status().lower() == "waiting for device", + "system status is `waiting for device`", + 30, + ) + + start_test_device("x123", BASELINE_MAC_ADDR) + + until_true( + lambda: query_system_status().lower() == "compliant", + "system status is `complete`", + 900, + ) + + stop_test_device("x123") + + # Validate response + r = requests.get(f"{API}/system/status") + response = json.loads(r.text) + pretty_print(response) + + # Validate results + results = {x["name"]: x for x in response["tests"]["results"]} + print(results) + # there are only 3 baseline tests + assert len(results) == 3 + + payload = {"device": {"mac_addr": BASELINE_MAC_ADDR, "firmware": "asd"}} + r = requests.post(f"{API}/system/start", data=json.dumps(payload)) + # assert r.status_code == 200 + # returns 409 + print(r.text) + + until_true( + lambda: query_system_status().lower() == "waiting for device", + "system status is `waiting for device`", + 30, + ) + + start_test_device("x123", BASELINE_MAC_ADDR) + + until_true( + lambda: query_system_status().lower() == "compliant", + "system status is `complete`", + 900, + ) + + stop_test_device("x123") + +#TODO uncomment when functionality is implemented +@pytest.mark.skip() +def test_create_invalid_chars(empty_devices_dir, testrun): + # local_delete_devices(ALL_DEVICES) + # We must start test run with no devices in local/devices for this test to function as expected! + assert len(local_get_devices()) == 0 + + # Test adding device + device_1 = { + "manufacturer": "/'disallowed characters///", + "model": "First", + "mac_addr": BASELINE_MAC_ADDR, + "test_modules": { + "dns": {"enabled": False}, + "connection": {"enabled": True}, + "ntp": {"enabled": True}, + "baseline": {"enabled": True}, + "nmap": {"enabled": True}, + }, + } + + r = requests.post(f"{API}/device", data=json.dumps(device_1)) + print(r.text) + print(r.status_code) + diff --git a/testing/baseline/test_baseline b/testing/baseline/test_baseline index 61d0f9b56..196b5f280 100755 --- a/testing/baseline/test_baseline +++ b/testing/baseline/test_baseline @@ -52,7 +52,7 @@ sudo bin/testrun --single-intf --no-ui > $TESTRUN_OUT 2>&1 & TPID=$! # Time to wait for testrun to be ready -WAITING=600 +WAITING=750 for i in `seq 1 $WAITING`; do if [[ -n $(fgrep "Waiting for devices on the network" $TESTRUN_OUT) ]]; then break diff --git a/testing/device_configs/only_baseline/device_config.json b/testing/device_configs/only_baseline/device_config.json new file mode 100644 index 000000000..925929f81 --- /dev/null +++ b/testing/device_configs/only_baseline/device_config.json @@ -0,0 +1,25 @@ +{ + "manufacturer": "Google", + "model": "Baseline", + "mac_addr": "02:42:aa:00:01:01", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": false + }, + "ntp": { + "enabled": false + }, + "baseline": { + "enabled": true + }, + "nmap": { + "enabled": false + }, + "tls": { + "enabled": false + } + } +} diff --git a/testing/device_configs/tester1/device_config.json b/testing/device_configs/tester1/device_config.json index 268399b72..55a5036ca 100644 --- a/testing/device_configs/tester1/device_config.json +++ b/testing/device_configs/tester1/device_config.json @@ -4,16 +4,16 @@ "mac_addr": "02:42:aa:00:00:01", "test_modules": { "dns": { - "enabled": false + "enabled": true }, "connection": { - "enabled": false + "enabled": true }, "ntp": { - "enabled": false + "enabled": true }, "baseline": { - "enabled": false + "enabled": true }, "nmap": { "enabled": true diff --git a/testing/device_configs/tester2/device_config.json b/testing/device_configs/tester2/device_config.json index 8b090d80a..b037feb6d 100644 --- a/testing/device_configs/tester2/device_config.json +++ b/testing/device_configs/tester2/device_config.json @@ -4,16 +4,16 @@ "mac_addr": "02:42:aa:00:00:02", "test_modules": { "dns": { - "enabled": false + "enabled": true }, "connection": { - "enabled": false + "enabled": true }, "ntp": { "enabled": true }, "baseline": { - "enabled": false + "enabled": true }, "nmap": { "enabled": true diff --git a/testing/device_configs/tester3/device_config.json b/testing/device_configs/tester3/device_config.json new file mode 100644 index 000000000..b7792027e --- /dev/null +++ b/testing/device_configs/tester3/device_config.json @@ -0,0 +1,22 @@ +{ + "manufacturer": "Google", + "model": "Tester 3", + "mac_addr": "02:42:aa:00:00:03", + "test_modules": { + "dns": { + "enabled": false + }, + "connection": { + "enabled": true + }, + "ntp": { + "enabled": false + }, + "baseline": { + "enabled": true + }, + "nmap": { + "enabled": false + } + } +} diff --git a/testing/docker/ci_test_device1/Dockerfile b/testing/docker/ci_test_device1/Dockerfile index a362e2a4d..1c62d231d 100644 --- a/testing/docker/ci_test_device1/Dockerfile +++ b/testing/docker/ci_test_device1/Dockerfile @@ -6,7 +6,7 @@ ENV DEBIAN_FRONTEND=noninteractive # Update and get all additional requirements not contained in the base image RUN apt-get update && apt-get -y upgrade -RUN apt-get update && apt-get install -y isc-dhcp-client ntpdate coreutils moreutils inetutils-ping curl jq dnsutils openssl netcat-openbsd +RUN apt-get update && apt-get install -y isc-dhcp-client ntpdate coreutils moreutils inetutils-ping curl jq dnsutils openssl netcat-openbsd arping COPY entrypoint.sh /entrypoint.sh diff --git a/testing/docker/ci_test_device1/entrypoint.sh b/testing/docker/ci_test_device1/entrypoint.sh index 9152af0c8..dee51d50e 100755 --- a/testing/docker/ci_test_device1/entrypoint.sh +++ b/testing/docker/ci_test_device1/entrypoint.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#!/bin/bash -x ip a @@ -17,6 +17,7 @@ OUT=/out/testrun_ci.json NTP_SERVER=10.10.10.5 DNS_SERVER=10.10.10.4 +INTF=eth0 function wout(){ temp=${1//./\".\"} @@ -30,13 +31,15 @@ function wout(){ dig @8.8.8.8 +short www.google.com # DHCP -ip addr flush dev eth0 +ip addr flush dev $INTF PID_FILE=/var/run/dhclient.pid if [ -f $PID_FILE ]; then kill -9 $(cat $PID_FILE) || true rm -f $PID_FILE fi -dhclient -v eth0 +dhclient -v $INTF +DHCP_TPID=$! +echo $DHCP_TPID if [ -n "${options[oddservices]}" ]; then @@ -108,4 +111,37 @@ if [ -n "${options[ntpv3_time_google_com]}" ]; then done) & fi +if [ -n "${options[dns_google]}" ]; then + echo starting dns requests to 8.8.8.8 + (while true; do dig @8.8.8.8 +short www.google.com; sleep 3; done) & +fi + +if [ -n "${options[dns_dhcp]}" ]; then + echo starting dns requests to $DNS_SERVER + (while true; do dig @$DNS_SERVER +short www.google.com; sleep 3; done) & +fi + +if [ -n "${options[kill_dhcp]}" ]; then + echo killing DHCP + ipv4=$(ip a show $INTF | grep "inet " | awk '{print $2}') + pkill -f dhclient + ip addr change $ipv4 dev $INTF valid_lft forever preferred_lft forever +fi + +if [ -n "${options[request_fixed]}" ]; then + ipv4=$(ip a show $INTF | grep "inet " | awk '{print $2}') + + cat <>/etc/dhcp/dhclient.conf +interface "$INTF" { + send dhcp-requested-address ${ipv4%\/*} +} +EOF +dhclient -v $INTF + +fi + + + +(while true; do arping 10.10.10.1; sleep 10; done) & +(while true; do ip a | cat; sleep 10; done) & tail -f /dev/null \ No newline at end of file diff --git a/testing/pylint/test_pylint b/testing/pylint/test_pylint index 3f4d8a3ed..6d28226cc 100755 --- a/testing/pylint/test_pylint +++ b/testing/pylint/test_pylint @@ -21,7 +21,7 @@ sudo cmd/install source venv/bin/activate sudo pip3 install pylint -files=$(find . -path ./venv -prune -o -name '*.py' -print) +files=$(find ./framework -path ./venv -prune -o -name '*.py' -print) OUT=pylint.out diff --git a/testing/tests/test_tests b/testing/tests/test_tests index 04f76daee..9f997f10c 100755 --- a/testing/tests/test_tests +++ b/testing/tests/test_tests @@ -19,6 +19,7 @@ ip a TEST_DIR=/tmp/results MATRIX=testing/tests/test_tests.json +rm -rf $TEST_DIR/ mkdir -p $TEST_DIR # Setup requirements @@ -29,27 +30,33 @@ pip3 install pytest # Start OVS # Setup device network +sudo ip link add dev xyz type dummy sudo ip link add dev endev0a type veth peer name endev0b sudo ip link set dev endev0a up sudo ip link set dev endev0b up -sudo docker network create -d macvlan -o parent=endev0b endev1 +sudo docker network remove endev0 +sudo docker network create -d macvlan -o parent=endev0b endev0 sudo /usr/share/openvswitch/scripts/ovs-ctl start # Build Test Container sudo docker build ./testing/docker/ci_test_device1 -t ci_test_device1 -f ./testing/docker/ci_test_device1/Dockerfile +sudo chown -R $USER local + cat <local/system.json { "network": { "device_intf": "endev0a", - "internet_intf": "eth0" + "internet_intf": "xyz" }, "log_level": "DEBUG", "monitor_period": 30 } EOF +cat local/system.json + mkdir -p local/devices cp -r testing/device_configs/* local/devices @@ -57,6 +64,9 @@ sudo cmd/install TESTERS=$(jq -r 'keys[]' $MATRIX) for tester in $TESTERS; do + if [ -n $1 ] && [ $1 != $tester ]; then + continue + fi testrun_log=$TEST_DIR/${tester}_testrun.log device_log=$TEST_DIR/${tester}_device.log @@ -65,11 +75,11 @@ for tester in $TESTERS; do args=$(jq -r .$tester.args $MATRIX) touch $testrun_log - sudo timeout 900 bin/testrun --single-intf --no-ui --no-validate > $testrun_log 2>&1 & + sudo timeout 1800 bin/testrun --single-intf --no-ui --no-validate > $testrun_log 2>&1 & TPID=$! # Time to wait for testrun to be ready - WAITING=600 + WAITING=800 for i in `seq 1 $WAITING`; do tail -1 $testrun_log if [[ -n $(fgrep "Waiting for devices on the network" $testrun_log) ]]; then @@ -91,9 +101,12 @@ for tester in $TESTERS; do exit 1 fi + # helps unclean exits when running locally + sudo docker stop $tester && sudo docker rm $tester + # Load Test Container sudo docker run -d \ - --network=endev1 \ + --network=endev0 \ --mac-address=$ethmac \ --cap-add=NET_ADMIN \ -v /tmp:/out \ @@ -101,20 +114,35 @@ for tester in $TESTERS; do --name=$tester \ ci_test_device1 $args - wait $TPID +wait $TPID +#WAITING=600 +#for i in `seq 1 $WAITING`; do +# tail -1 $testrun_log +# if [[ -n $(fgrep "All tests complete" $testrun_log) ]]; then +# sleep 10 +# kill -9 $TPID +# fi +# +# if [[ ! -d /proc/$TPID ]]; then +# break +# fi +# +# sleep 1 +# done + + # Following line indicates that tests are completed but wait till it exits # Completed running test modules on device with mac addr 7e:41:12:d2:35:6a #Change this line! - LOGGER.info(f"""Completed running test modules on device # with mac addr {device.mac_addr}""") - ls runtime - more runtime/network/*.log - sudo docker kill $tester + #more runtime/network/*.log | cat sudo docker logs $tester | cat - + sudo docker kill $tester && sudo docker rm $tester + cp runtime/test/${ethmac//:/}/report.json $TEST_DIR/$tester.json - more $TEST_DIR/$tester.json - more $testrun_log + more $TEST_DIR/$tester.json | cat + more $testrun_log | cat done diff --git a/testing/tests/test_tests.json b/testing/tests/test_tests.json index 7d2b88678..728f7764f 100644 --- a/testing/tests/test_tests.json +++ b/testing/tests/test_tests.json @@ -1,21 +1,35 @@ { "tester1": { "image": "test-run/ci_test1", - "args": "oddservices", + "args": "oddservices dns_static", "ethmac": "02:42:aa:00:00:01", "expected_results": { "security.nmap.ports": "Non-Compliant" } }, "tester2": { + "description": "expected to pass most things", "image": "test-run/ci_test1", - "args": "ntpv4_dhcp", + "args": "ntpv4_dhcp dns_dhcp", "ethmac": "02:42:aa:00:00:02", "expected_results": { "security.nmap.ports": "Compliant", "ntp.network.ntp_support": "Compliant", - "ntp.network.ntp_dhcp": "Compliant" + "ntp.network.ntp_dhcp": "Compliant", + "connection.shared_address": "Compliant", + "connection.dhcp_address": "Compliant", + "connection.mac_address": "Compliant", + "connection.target_ping": "Compliant", + "connection.single_ip": "Compliant", + "connection.ipaddr.ip_change": "Compliant" } + }, + "tester3": { + "description": "", + "image": "test-run/ci_test1", + "args": "kill_dhcp", + "ethmac": "02:42:aa:00:00:03", + "expected_results": {} } } \ No newline at end of file diff --git a/testing/tests/test_tests.py b/testing/tests/test_tests.py index 666e65783..a14afb2cb 100644 --- a/testing/tests/test_tests.py +++ b/testing/tests/test_tests.py @@ -46,10 +46,8 @@ def collect_expected_results(expected_results): def collect_actual_results(results_dict): """ Yields results from an already loaded testrun results file """ # "module"."results".[list]."result" - for maybe_module, child in results_dict.items(): - if 'results' in child and maybe_module != 'baseline': - for test in child['results']: - yield TestResult(test['name'], test['result']) + for test in results_dict.get('tests', {}).get('results', []): + yield TestResult(test['name'], test['result']) @pytest.fixture @@ -73,8 +71,7 @@ def test_tests(results, test_matrix): for tester, props in test_matrix.items(): expected = set(collect_expected_results(props['expected_results'])) actual = set(collect_actual_results(results[tester])) - - assert expected.issubset(actual), f'{tester} expected results not obtained' + assert expected & actual == expected def test_list_tests(capsys, results, test_matrix): all_tests = set(itertools.chain.from_iterable( @@ -95,7 +92,7 @@ def test_list_tests(capsys, results, test_matrix): print('============') print('============') print('tests seen:') - print('\n'.join([x.name for x in all_tests])) + print('\n'.join(set([x.name for x in all_tests]))) print('\ntesting for pass:') print('\n'.join(ci_pass)) print('\ntesting for fail:') @@ -103,7 +100,14 @@ def test_list_tests(capsys, results, test_matrix): print('\ntester results') for tester in test_matrix.keys(): print(f'\n{tester}:') + print(' expected results:') + for test in collect_expected_results(test_matrix[tester]['expected_results']): + print(f' {test.name}: {test.result}') + print(' actual results:') for test in collect_actual_results(results[tester]): - print(f'{test.name}: {test.result}') + if test.name in test_matrix[tester]['expected_results']: + print(f' {test.name}: {test.result} (exp: {test_matrix[tester]["expected_results"][test.name]})') + else: + print(f' {test.name}: {test.result}') assert True From b4dd4404c91c26cbdecb876939d23a0c2330bd97 Mon Sep 17 00:00:00 2001 From: J Boddey Date: Tue, 12 Sep 2023 12:26:35 +0100 Subject: [PATCH 078/400] Create Testrun package (#114) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Merge dev into main (Sprint 10 and 11) (#86) * Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey * Add issue report templates (#7) * Add issue templates * Update README.md * Discover devices on the network (#5) * Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- * Quick refactor (#9) * Fix duplicate sleep calls * Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- * Add baseline and pylint tests (#25) * Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot * Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot * Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues * Fix device configs * Remove unecessary files * Cleanup duplicate properties * Cleanup install script * Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev * Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled * Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test * Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot * Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey * Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * remove ovs files added back in during merge * Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Create startup capture (#37) * Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test * Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures * File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions * Add connection single ip test (#47) * Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range * Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot * Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location * Add documentation (#53) * Sync dev to main (#56) * Merge dev into main (Sprint 7 and 8) (#33) * Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey * Add issue report templates (#7) * Add issue templates * Update README.md * Discover devices on the network (#5) * Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- * Quick refactor (#9) * Fix duplicate sleep calls * Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- * Add baseline and pylint tests (#25) * Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot * Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot * Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues * Fix device configs * Remove unecessary files * Cleanup duplicate properties * Cleanup install script * Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev * Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled * Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test * Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot * Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey * Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * remove ovs files added back in during merge * Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Create startup capture (#37) * Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test * Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures * File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions * Add connection single ip test (#47) * Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range * Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot * Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location * Add documentation (#53) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Sprint 8 Hotfix (#54) * Fix connection results.json * Re add try/catch * Fix log level * Debug test module load order * Add depends on to nmap module * Remove logging change --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Fix missing results on udp tests when tcp ports are also defined (#59) * Add licence header (#61) * Resolve merge conflict * Add network docs (#63) * Add network docs * Rename to readme * Add link to template module * Dhcp (#64) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Dhcp (#67) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Move isc-dhcp-server and radvd to services Move DHCP server monitoring and booting to python script * Add grpc methods to interact with dhcp_server module Update dhcp_server to control radvd server directly from calls Fix radvd service status method * Add updates to dhcp2 module Update radvd service * Add license headers * Add connection.dhcp_address test (#68) * Add NTP tests (#60) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * Pylint (#69) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> * Add ipv6 tests (#65) * Add ipv6 tests * Check for ND_NS * Connection private address (#71) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * formatting * Change isc-dhcp service setup Fix dhcpd logging Add start and stop methods to grpc dhcp client Add dhcp2 client Inttial private_addr test * Add max lease time Add unit tests * fix last commit * finish initial work on test * pylinting * Breakup test and allow better failure reporting * restore network after test * Wait for device to get a lease from original dhcp range after network restore * pylinting * Fix ipv6 tests --------- Co-authored-by: Jacob Boddey * fix windows line ending * Fix python import * move isc-dhcp service commands to their own class update logging pylinting * fix dhcp1 * Initial CI testing for tests (#72) * Fix radvd conf * Fix individual test disable * Add NTP Pass CI test (#76) * add shared address test (#75) * Fix single ip test (#58) * Fix single ip test from detecting faux-device during validation as a failure * remove dhcp server capture file from scan --------- Co-authored-by: J Boddey * Merge API into dev (#70) * Start API * Write interfaces * Get current configuration * Set versions * Add more API methods * Correct no-ui flag * Do not launch API on baseline test * Move loading devices back to Test Run core * Merge dev into api (#74) * Merge dev into main (Add license header) (#62) Add license header * Add network docs (#63) * Add network docs * Rename to readme * Add link to template module * Dhcp (#64) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Dhcp (#67) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Move isc-dhcp-server and radvd to services Move DHCP server monitoring and booting to python script * Add grpc methods to interact with dhcp_server module Update dhcp_server to control radvd server directly from calls Fix radvd service status method * Add updates to dhcp2 module Update radvd service * Add license headers * Add connection.dhcp_address test (#68) * Add NTP tests (#60) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * Pylint (#69) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> * Add ipv6 tests (#65) * Add ipv6 tests * Check for ND_NS * Merge dev into main (Sprint 9) (#66) * Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey * Add issue report templates (#7) * Add issue templates * Update README.md * Discover devices on the network (#5) * Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- * Quick refactor (#9) * Fix duplicate sleep calls * Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- * Add baseline and pylint tests (#25) * Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot * Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot * Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues * Fix device configs * Remove unecessary files * Cleanup duplicate properties * Cleanup install script * Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev * Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled * Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test * Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot * Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey * Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * remove ovs files added back in during merge * Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Create startup capture (#37) * Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test * Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures * File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions * Add connection single ip test (#47) * Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range * Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot * Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location * Add documentation (#53) * Sync dev to main (#56) * Merge dev into main (Sprint 7 and 8) (#33) * Implement test orchestrator (#4) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level --------- Co-authored-by: Jacob Boddey * Add issue report templates (#7) * Add issue templates * Update README.md * Discover devices on the network (#5) * Test run sync (#8) * Initial work on test-orchestrator * Ignore runtime folder * Update runtime directory for test modules * Fix logging Add initial framework for running tests * logging and misc cleanup * logging changes * Add a stop hook after all tests complete * Refactor test_orc code * Add arg passing Add option to use locally cloned via install or remote via main project network orchestrator * Fix baseline module Fix orchestrator exiting only after timeout * Add result file to baseline test module Change result format to match closer to design doc * Refactor pylint * Skip test module if it failed to start * Refactor * Check for valid log level * Add config file arg Misc changes to network start procedure * fix merge issues * Update runner and test orch procedure Add useful runtiem args * Restructure test run startup process Misc updates to work with net orch updates * Refactor --------- * Quick refactor (#9) * Fix duplicate sleep calls * Add net orc (#11) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add the DNS test module (#12) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Refactor --------- * Add baseline and pylint tests (#25) * Discover devices on the network (#22) * Discover devices on the network * Add defaults when missing from config Implement monitor wait period from config * Add steady state monitor Remove duplicate callback registrations * Load devices into network orchestrator during testrun start --------- Co-authored-by: jhughesbiot * Build dependencies first (#21) * Build dependencies first * Remove debug message * Add depend on option to test modules * Re-add single interface option * Import subprocess --------- Co-authored-by: jhughesbiot * Port scan test module (#23) * Add network orchestrator repository * cleanup duplicate start and install scripts * Temporary fix for python dependencies * Remove duplicate python requirements * remove duplicate conf files * remove remote-net option * cleanp unecessary files * Add dns test module Fix test module build process * Add mac address of device under test to test container Update dns test to use mac address filter * Update dns module tests * Change result output * logging update * Update test module for better reusability * Load in module config to test module * logging cleanup * Update baseline module to new template Misc cleanup * Add ability to disable individual tests * remove duplicate readme * Update device directories * Remove local folder * Update device template Update test module to work with new device config file format * Change test module network config options Do not start network services for modules not configured for network * Initial nmap test module add Add device ip resolving to base module Add network mounting for test modules * Update ipv4 device resolving in test modules * Map in ip subnets and remove hard coded references * Add ftp port test * Add ability to pass config for individual tests within a module Update nmap module scan to run tests based on config * Add full module check for compliance * Add all tcp port scans to config * Update nmap commands to match existing DAQ tests Add udp scanning and tests * logging cleanup * Update TCP port scanning range Update logging * Merge device config into module config Update device template * fix merge issues * Update timeouts Add multi-threading for multiple scanns to run simultaneously Add option to use scan scripts for services * Fix merge issues * Fix device configs * Remove unecessary files * Cleanup duplicate properties * Cleanup install script * Formatting (#26) * Fix pylint issues in net orc * more pylint fixes * fix listener lint issues * fix logger lint issues * fix validator lint issues * fix util lint issues * Update base network module linting issues * Cleanup linter issues for dhcp modules Remove old code testing code * change to single quote delimeter * Cleanup linter issues for ntp module * Cleanup linter issues for radius module * Cleanup linter issues for template module * fix linter issues with faux-dev * Test results (#27) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Test results (#28) * Collect all module test results * Fix test modules without config options * Add timestamp to test results * Add attempt timing and device info to test results * Ignore disabled test containers when generating results * Fully skip modules that are disabled * Fix pylint test and skip internet tests so CI passes (#29) * disable internet checks for pass * fix pylint test * Increase pylint score (#31) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger --------- Co-authored-by: jhughesbiot * Pylint (#32) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting --------- Co-authored-by: Jacob Boddey * Add license header (#36) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Ovs (#35) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * remove ovs files added back in during merge * Nmap (#38) * More formatting fixes * More formatting fixes * More formatting fixes * More formatting fixes * Misc pylint fixes Fix test module logger * remove unused files * more formatting * revert breaking pylint changes * more formatting * fix results file * More formatting * ovs module formatting * Add ovs control into network orchestrator * Add verification methods for the base network * Add network validation and misc logging updates * remove ovs module * add license header to all python files * Update tcp scans to speed up full port range scan Add version checking Implement ssh version checking * Add unknown port checks Match unknown ports to existing services Add unknown ports without existing services to results file --------- Co-authored-by: Jacob Boddey Co-authored-by: SuperJonotron * Create startup capture (#37) * Connection (#40) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Conn mac oui (#42) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Con mac address (#43) * Initial add of connection test module with ping test * Update host user resolving * Update host user resolving for validator * add get user method to validator * Add mac_oui test Add option to return test result and details of test for reporting * Add connection.mac_address test * Dns (#44) * Add MDNS test * Update existing mdns logging to be more consistent with other tests * Add startup and monitor captures * File permissions (#45) * Fix validator file permissions * Fix test module permissions * Fix device capture file permissions * Fix device results permissions * Add connection single ip test (#47) * Nmap results (#49) * Update processing of nmap results to use xml output and json conversions for stability * Update matching with regex to prevent wrong service matches and duplicate processing for partial matches * Update max port scan range * Framework restructure (#50) * Restructure framework and modules * Fix CI paths * Fix base module * Add build script * Remove build logs * Update base and template docker files to fit the new format Implement a template option on network modules Fix skipping of base image build * remove base image build in ci * Remove group from chown --------- Co-authored-by: jhughesbiot * Ip control (#51) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * Move config to /local (#52) * Move config to /local * Fix testing config * Fix ovs_control config location * Fix faux dev config location * Add documentation (#53) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Sprint 8 Hotfix (#54) * Fix connection results.json * Re add try/catch * Fix log level * Debug test module load order * Add depends on to nmap module * Remove logging change --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Fix missing results on udp tests when tcp ports are also defined (#59) * Add licence header (#61) * Resolve merge conflict * Add network docs (#63) * Add network docs * Rename to readme * Add link to template module * Dhcp (#64) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Dhcp (#67) * Add initial work for ip control module * Implement ip control module with additional cleanup methods * Update link check to not use error stream * Add error checking around container network configurations * Add network cleanup for namespaces and links * formatting * initial work on adding grpc functions for dhcp tests * rework code to allow for better usage and unit testing * working poc for test containers and grpc client to dhcp-1 * Move grpc client code into base image * Move grpc proto builds outside of dockerfile into module startup script * Setup pythonpath var in test module base startup process misc cleanup * pylinting and logging updates * Add python path resolving to network modules Update grpc path to prevent conflicts misc pylinting * Change lease resolving method to fix pylint issue * cleanup unit tests * cleanup unit tests * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * Add grpc updates to dhcp2 module Update dhcp_config to deal with missing optional variables * fix line endings * misc cleanup * Move isc-dhcp-server and radvd to services Move DHCP server monitoring and booting to python script * Add grpc methods to interact with dhcp_server module Update dhcp_server to control radvd server directly from calls Fix radvd service status method * Add updates to dhcp2 module Update radvd service * Add license headers * Add connection.dhcp_address test (#68) * Add NTP tests (#60) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * Pylint (#69) --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> * Add ipv6 tests (#65) * Add ipv6 tests * Check for ND_NS --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Connection private address (#71) * Add ntp support test * Add extra log message * Modify descriptions * Pylint * formatting * Change isc-dhcp service setup Fix dhcpd logging Add start and stop methods to grpc dhcp client Add dhcp2 client Inttial private_addr test * Add max lease time Add unit tests * fix last commit * finish initial work on test * pylinting * Breakup test and allow better failure reporting * restore network after test * Wait for device to get a lease from original dhcp range after network restore * pylinting * Fix ipv6 tests --------- Co-authored-by: Jacob Boddey * fix windows line ending * Fix python import * move isc-dhcp service commands to their own class update logging pylinting * fix dhcp1 * Initial CI testing for tests (#72) * Fix radvd conf --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Fix testing command * Disable API on testing * Add API session * Remove old method * Remove local vars * Replace old var * Add device config * Add device configs * Fix paths * Change MAC address * Revert mac * Fix copy path * Debug loading devices * Remove reference * Changes * Re-add checks to prevent null values * Fix variable * Fix * Use dict instead of string * Try without json conversion * Container output to log * Undo changes to nmap module * Add post devices route --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron * Dhcp tests (#81) * Separate dhcp control methods into their own module Implement ip change test Add place holder for dhcp failover test * Stabilize network before leaving ip_change test Add dhcp_failover test * fix regression issue with individual test enable/disable setting * fix gitignore * Merge tls tests into dev (#80) * initial add of security module and tls tests * Fix server test and implement 1.3 version * pylinting * More work on client tests * Add client tls tests Add unit tets Add common python code to base test module * re-enable dhcp unit tests disab… * Create package * Update baseline test * Add sudo * Correct file url * Add sudo * Update README.md * Correct sudo user * Create temporary file * Fix baseline test * Copy device configs * Install pytest * Create devices folder * Update test_tests * Install testrun * Add missing name * Allow more time for Testrun to start * Add depends * Install dependencies * Build containers separately * Create root_certs folder * Correct tag name * Update test api * Install Testrun * Add dir var * Fix command * Fix command * Change * API test changes * Try again * Try again * Try again * Fix path --------- Co-authored-by: jhughesbiot <50999916+jhughesbiot@users.noreply.github.com> Co-authored-by: jhughesbiot Co-authored-by: Noureddine Co-authored-by: SuperJonotron --- .github/workflows/testing.yml | 33 ++++- .gitignore | 1 + README.md | 29 +++-- bin/testrun | 8 +- cmd/build | 52 ++++++++ cmd/install | 18 ++- cmd/package | 53 ++++++++ cmd/prepare | 24 ++++ docs/configure_device.md | 14 +-- docs/dev/architecture.png | Bin 0 -> 133010 bytes docs/get_started.md | 20 ++- docs/network/add_new_service.md | 4 +- framework/python/src/common/session.py | 12 +- framework/python/src/core/testrun.py | 26 +--- .../src/net_orc/network_orchestrator.py | 5 +- .../python/src/net_orc/network_validator.py | 2 +- .../python/src/test_orc/test_orchestrator.py | 14 ++- make/.gitignore | 2 + make/DEBIAN/control | 6 + make/DEBIAN/postinst | 36 ++++++ modules/network/dhcp-1/dhcp-1.Dockerfile | 6 +- modules/network/dhcp-2/dhcp-2.Dockerfile | 2 +- modules/test/base/python/src/test_module.py | 2 +- .../test/conn/python/src/connection_module.py | 3 +- modules/test/nmap/python/src/nmap_module.py | 47 ++++--- modules/ui/.gitignore | 6 +- modules/ui/conf/nginx.conf | 13 ++ modules/ui/src/app/app.component.html | 1 + modules/ui/src/app/app.component.spec.ts | 10 +- modules/ui/src/app/app.component.ts | 5 +- modules/ui/src/app/app.module.ts | 4 +- .../device-tests/device-tests.component.html | 1 + .../device-tests/device-tests.component.scss | 9 ++ .../download-report.component.scss | 4 + .../device-form/device-form.component.html | 3 + .../device-form/device-form.component.spec.ts | 42 +++---- .../device-form/device-form.component.ts | 18 ++- ...rmat.validator.ts => device.validators.ts} | 18 ++- .../device-repository.component.html | 2 +- .../device-repository.component.scss | 7 +- .../ui/src/app/history/history.component.html | 41 +++--- .../ui/src/app/history/history.component.scss | 12 +- .../src/app/history/history.component.spec.ts | 34 ++++- .../ui/src/app/history/history.component.ts | 24 +++- modules/ui/src/app/mocks/progress.mock.ts | 14 ++- modules/ui/src/app/model/device.ts | 3 +- .../ui/src/app/notification.service.spec.ts | 46 +++++++ modules/ui/src/app/notification.service.ts | 17 +++ .../progress-breadcrumbs.component.html | 3 - .../progress-breadcrumbs.component.scss | 14 ++- .../progress-initiate-form.component.html | 2 +- .../progress-initiate-form.component.spec.ts | 118 ++++++++++++++++-- .../progress-initiate-form.component.ts | 69 +++++++++- .../progress-table.component.scss | 5 +- .../src/app/progress/progress.component.html | 4 +- .../src/app/progress/progress.component.scss | 20 ++- .../app/progress/progress.component.spec.ts | 7 +- .../ui/src/app/progress/progress.component.ts | 8 +- modules/ui/src/app/test-run.service.spec.ts | 96 +++++--------- modules/ui/src/app/test-run.service.ts | 19 ++- modules/ui/src/index.html | 3 + modules/ui/src/styles.scss | 31 +++++ modules/ui/src/theming/theme.scss | 10 +- modules/ui/ui.Dockerfile | 10 +- testing/api/system.json | 7 ++ testing/api/test_api | 19 +-- testing/api/test_api.py | 23 ++-- testing/baseline/system.json | 7 ++ testing/baseline/test_baseline | 21 ++-- testing/baseline/test_baseline.py | 5 +- testing/tests/system.json | 8 ++ testing/tests/test_tests | 36 ++---- 72 files changed, 911 insertions(+), 387 deletions(-) create mode 100755 cmd/build create mode 100755 cmd/package create mode 100755 cmd/prepare create mode 100644 docs/dev/architecture.png create mode 100644 make/.gitignore create mode 100644 make/DEBIAN/control create mode 100755 make/DEBIAN/postinst create mode 100644 modules/ui/conf/nginx.conf rename modules/ui/src/app/device-repository/device-form/{device-string-format.validator.ts => device.validators.ts} (54%) create mode 100644 modules/ui/src/app/notification.service.spec.ts create mode 100644 modules/ui/src/app/notification.service.ts create mode 100644 testing/api/system.json create mode 100644 testing/baseline/system.json create mode 100644 testing/tests/system.json diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index bf1d6ecc0..6fef99953 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -13,7 +13,16 @@ jobs: steps: - name: Checkout source uses: actions/checkout@v2.3.4 - - name: Run tests + - name: Install dependencies + shell: bash {0} + run: cmd/prepare + - name: Package Testrun + shell: bash {0} + run: cmd/package + - name: Install Testrun + shell: bash {0} + run: sudo dpkg -i testrun*.deb + - name: Run baseline tests shell: bash {0} run: testing/baseline/test_baseline @@ -24,12 +33,21 @@ jobs: steps: - name: Checkout source uses: actions/checkout@v2.3.4 + - name: Install dependencies + shell: bash {0} + run: cmd/prepare + - name: Package Testrun + shell: bash {0} + run: cmd/package + - name: Install Testrun + shell: bash {0} + run: sudo dpkg -i testrun*.deb - name: Run tests shell: bash {0} run: testing/tests/test_tests - name: Archive runtime results if: ${{ always() }} - run: sudo tar --exclude-vcs -czf runtime.tgz runtime/ + run: sudo tar --exclude-vcs -czf runtime.tgz /usr/local/testrun/runtime/ - name: Upload runtime results uses: actions/upload-artifact@v3 if: ${{ always() }} @@ -45,6 +63,15 @@ jobs: steps: - name: Checkout source uses: actions/checkout@v2.3.4 + - name: Install dependencies + shell: bash {0} + run: cmd/prepare + - name: Package Testrun + shell: bash {0} + run: cmd/package + - name: Install Testrun + shell: bash {0} + run: sudo dpkg -i testrun*.deb - name: Run tests shell: bash {0} run: testing/api/test_api @@ -56,6 +83,6 @@ jobs: steps: - name: Checkout source uses: actions/checkout@v2.3.4 - - name: Run tests + - name: Run pylint shell: bash {0} run: testing/pylint/test_pylint diff --git a/.gitignore b/.gitignore index 7ef392c5e..336202f24 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ pylint.out __pycache__/ build/ testing/unit_test/temp/ +*.deb diff --git a/README.md b/README.md index 41c559499..5ed2d03de 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ - Testrun logo + Testrun logo ## Introduction :wave: -Test Run is a tool to automate the validation of network-based functionality of IoT devices. Any device which is capable of receiving an IP address via DHCP is considered an IoT device by Test Run and can be tested. +Testrun is a tool to automate the validation of network-based functionality of IoT devices. Any device which is capable of receiving an IP address via DHCP is considered an IoT device by Testrun and can be tested. ## Motivation :bulb: -Without tools like Test Run, testing labs may be maintaining a large and complex network using equipment such as: A managed layer 3 switch, an enterprise-grade network router, virtualized or physical servers to provide DNS, NTP, 802.1x etc. With this amount of moving parts, all with dynamic configuration files and constant software updates, more time is likely to be spent on preparation and clean up of functinality or penetration testing - not forgetting the number of software tools required to perform the testing. The major issues which can and should be solved: +Without tools like Testrun, testing labs may be maintaining a large and complex network using equipment such as: A managed layer 3 switch, an enterprise-grade network router, virtualized or physical servers to provide DNS, NTP, 802.1x etc. With this amount of moving parts, all with dynamic configuration files and constant software updates, more time is likely to be spent on preparation and clean up of functinality or penetration testing - not forgetting the number of software tools required to perform the testing. The major issues which can and should be solved: 1) The complexity of managing a testing network 2) The time required to perform testing of network functionality 3) The accuracy and consistency of testing network functionality ## How it works :triangular_ruler: -Test Run creates an isolated and controlled network environment to fully simulate enterprise network deployments in your device testing lab. +Testrun creates an isolated and controlled network environment to fully simulate enterprise network deployments in your device testing lab. This removes the necessity for complex hardware, advanced knowledge and networking experience whilst enabling semi-technical engineers to validate device behaviour against industry cyber standards. -Two runtime modes will be supported by Test Run: +Two runtime modes will be supported by Testrun: 1) Automated Testing @@ -22,7 +22,7 @@ Once the device has become operational (steady state), automated testing of the 2) Lab network -Test Run cannot automate everything, and so additional manual testing may be required (or configuration changes may be required on the device). Rather than having to maintain a separate but idential lab network, Test Run will provide the network and some tools to assist an engineer performing the additional testing. At the same time, packet captures of the device behaviour will be recorded, alongside logs for each network service, for further debugging. +Testrun cannot automate everything, and so additional manual testing may be required (or configuration changes may be required on the device). Rather than having to maintain a separate but idential lab network, Testrun will provide the network and some tools to assist an engineer performing the additional testing. At the same time, packet captures of the device behaviour will be recorded, alongside logs for each network service, for further debugging. ## Minimum Requirements :computer: ### Hardware @@ -34,8 +34,11 @@ Test Run cannot automate everything, and so additional manual testing may be req - Docker - [Install guide](https://docs.docker.com/engine/install/ubuntu/) - Open vSwitch ``sudo apt-get install openvswitch-common openvswitch-switch`` +## Get started ▶️ +Once you have met the hardware and software requirements, you can get started with Testrun by following the [Get started guide](docs/get_started.md). + ## Roadmap :chart_with_upwards_trend: -Test Run will constantly evolve to further support end-users by automating device network behaviour against industry standards. +Testrun will constantly evolve to further support end-users by automating device network behaviour against industry standards. ## Issue reporting :triangular_flag_on_post: If the application has come across a problem at any point during setup or use, please raise an issue under the [issues tab](https://github.com/auto-iot/test-run/issues). Issue templates exist for both bug reports and feature requests. If neither of these are appropriate for your issue, raise a blank issue instead. @@ -44,11 +47,11 @@ If the application has come across a problem at any point during setup or use, p The contributing requirements can be found in [CONTRIBUTING.md](CONTRIBUTING.md). In short, checkout the [Google CLA](https://cla.developers.google.com/) site to get started. ## FAQ :raising_hand: -1) What device networking functionality is validated by Test Run? +1) What device networking functionality is validated by Testrun? Best practices and requirements for IoT devices are constantly changing due to technological advances and discovery of vulnerabilities. The current expectations for IoT devices on Google deployments can be found in the [Application Security Requirements for IoT Devices](https://partner-security.withgoogle.com/docs/iot_requirements). - Test Run aims to automate as much of the Application Security Requirements as possible. + Testrun aims to automate as much of the Application Security Requirements as possible. 2) What services are provided on the virtual network? @@ -58,11 +61,11 @@ The contributing requirements can be found in [CONTRIBUTING.md](CONTRIBUTING.md) - NTPv4 - 802.1x Port Based Authentication -3) Can I run Test Run on a virtual machine? +3) Can I run Testrun on a virtual machine? - Probably. Provided that the required 2x USB ethernet adapters are passed to the virtual machine as USB devices rather than network adapters, Test Run should - still work. We will look to test and approve the use of virtualisation to run Test Run in the future. + Probably. Provided that the required 2x USB ethernet adapters are passed to the virtual machine as USB devices rather than network adapters, Testrun should + still work. We will look to test and approve the use of virtualisation to run Testrun in the future. - 4) Can I connect multiple devices to Test Run? + 4) Can I connect multiple devices to Testrun? In short, Yes you can. The way in which multiple devices could be tested simultaneously is yet to be decided. However, if you simply want to add field/peer devices during runtime (even another laptop performing manual testing) then you may connect the USB ethernet adapter to an unmanaged switch. diff --git a/bin/testrun b/bin/testrun index ea65d3565..82c8ab237 100755 --- a/bin/testrun +++ b/bin/testrun @@ -26,12 +26,12 @@ fi # Ensure that /var/run/netns folder exists sudo mkdir -p /var/run/netns +export TESTRUNPATH=/usr/local/testrun +cd $TESTRUNPATH + # Create device folder if it doesn't exist mkdir -p local/devices -# Check if Python modules exist. Install if not -[ ! -d "venv" ] && sudo cmd/install - # Remove existing runtime data rm -rf runtime/* @@ -39,7 +39,7 @@ rm -rf runtime/* source venv/bin/activate # Set the PYTHONPATH to include the "src" directory -export PYTHONPATH="$PWD/framework/python/src" +export PYTHONPATH="$TESTRUNPATH/framework/python/src" python -u framework/python/src/core/test_runner.py $@ deactivate \ No newline at end of file diff --git a/cmd/build b/cmd/build new file mode 100755 index 000000000..7e69393c8 --- /dev/null +++ b/cmd/build @@ -0,0 +1,52 @@ +#!/bin/bash -e + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Builds all docker images +echo Building docker images + +# Build user interface +echo Building user interface +mkdir -p build/ui +docker build -t test-run/ui -f modules/ui/ui.Dockerfile . > build/ui/ui.log 2>&1 + +# Build network modules +echo Building network modules +mkdir -p build/network +for dir in modules/network/* ; do + module=$(basename $dir) + echo Building network module $module... + docker build -f modules/network/$module/$module.Dockerfile -t test-run/$module . > build/network/$module.log 2>&1 +done + +# Build validators +echo Building network validators +mkdir -p build/devices +for dir in modules/devices/* ; do + module=$(basename $dir) + echo Building validator module $module... + docker build -f modules/devices/$module/$module.Dockerfile -t test-run/$module . > build/devices/$module.log 2>&1 +done + +# Build test modules +echo Building test modules +mkdir -p build/test +for dir in modules/test/* ; do + module=$(basename $dir) + echo Building test module $module... + docker build -f modules/test/$module/$module.Dockerfile -t test-run/$module-test . > build/test/$module.log 2>&1 +done + +echo Finished building modules \ No newline at end of file diff --git a/cmd/install b/cmd/install index 7997f37fa..929f9136c 100755 --- a/cmd/install +++ b/cmd/install @@ -14,17 +14,23 @@ # See the License for the specific language governing permissions and # limitations under the License. +echo Installing application dependencies + +TESTRUN_DIR=/usr/local/testrun +cd $TESTRUN_DIR + python3 -m venv venv source venv/bin/activate pip3 install -r framework/requirements.txt -# Dependency for printing reports to pdf -# required by python package weasyprint -sudo apt-get install libpangocairo-1.0-0 +# Copy the default configuration +cp -u local/system.json.example local/system.json + +deactivate -#TODO move into docker build process -(cd modules/ui && npm install && npm run build) +# Build docker images +sudo cmd/build -deactivate \ No newline at end of file +echo Finished installing Testrun diff --git a/cmd/package b/cmd/package new file mode 100755 index 000000000..d134896d3 --- /dev/null +++ b/cmd/package @@ -0,0 +1,53 @@ +#!/bin/bash -e + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Creates a package for Testrun + +MAKE_SRC_DIR=make + +# Copy testrun script to /bin +mkdir -p $MAKE_SRC_DIR/bin +cp bin/testrun $MAKE_SRC_DIR/bin/testrun + +# Create testrun folder +mkdir -p $MAKE_SRC_DIR/usr/local/testrun + +# Create postinst script +cp cmd/install $MAKE_SRC_DIR/DEBIAN/postinst + +# Copy other commands +mkdir -p $MAKE_SRC_DIR/usr/local/testrun/cmd +cp cmd/{prepare,build} $MAKE_SRC_DIR/usr/local/testrun/cmd + +# Create local folder +mkdir -p $MAKE_SRC_DIR/usr/local/testrun/local +cp local/system.json.example $MAKE_SRC_DIR/usr/local/testrun/local/system.json.example + +# Create device repository +mkdir -p $MAKE_SRC_DIR/usr/local/testrun/local/devices + +# Copy root_certs folder +mkdir -p local/root_certs +cp -r local/root_certs $MAKE_SRC_DIR/usr/local/testrun/local/root_certs + +# Copy framework and modules into testrun folder +cp -r {framework,modules} $MAKE_SRC_DIR/usr/local/testrun + +# Build .deb file +dpkg-deb --build --root-owner-group make + +# Rename the .deb file +mv make.deb testrun_1-0_amd64.deb \ No newline at end of file diff --git a/cmd/prepare b/cmd/prepare new file mode 100755 index 000000000..950051bd3 --- /dev/null +++ b/cmd/prepare @@ -0,0 +1,24 @@ +#!/bin/bash -e + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Optional script to prepare your system for use with Testrun. +# Installs system dependencies + +echo Installing system dependencies + +sudo apt-get install openvswitch-common openvswitch-switch python3 libpangocairo-1.0-0 + +echo Finished installing system dependencies diff --git a/docs/configure_device.md b/docs/configure_device.md index 320d3c325..9eefcd866 100644 --- a/docs/configure_device.md +++ b/docs/configure_device.md @@ -8,24 +8,12 @@ The device information section includes the manufacturer, model, and MAC address ## Test Modules -Test modules are groups of tests that can be enabled or disabled as needed. You can choose which test modules to include for your device. The device configuration file contains the following test module: - -- DNS Test Module +Test modules are groups of tests that can be enabled or disabled as needed. You can choose which test modules to run on your device. ### Enabling and Disabling Test Modules To enable or disable a test module, modify the `enabled` field within the respective module. Setting it to `true` enables the module, while setting it to `false` disables the module. -## Individual Tests - -Within the DNS test module, there are individual tests that can be enabled or disabled. These tests focus on specific aspects of network behavior. You can customize the tests based on your device and testing requirements. - -### Enabling and Disabling Tests - -To enable or disable an individual test, modify the `enabled` field within the respective test. Setting it to `true` enables the test, while setting it to `false` disables the test. - -> Note: The example device configuration file (`resources/devices/template/device_config.json`) provides a complete usage example, including the structure and configuration options for the DNS test module and its tests. You can refer to this file to understand how to configure your device tests effectively. - ## Customizing the Device Configuration To customize the device configuration for your specific device, follow these steps: diff --git a/docs/dev/architecture.png b/docs/dev/architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..e349141b66596362ae4626ae4b05d758b3ddc5e1 GIT binary patch literal 133010 zcmeFZcTiJX^gkN)s#j1@sYAj-VnSASLt=?o|+}Dov$H2_mJ6X*1B4Qi@b-z`dGmXJym>S4y_xrBzRYM&l5_T1d!4n{`mE1dJ1-3N zwU4l!WP`zAM{eD`VGM&E(t^SE*Zp|_d?LniG61|BdUDg$0|sN~g8uD+y-VT;AMWum z*1ira>=c{>Z~m~qrgsenD~V>O-`fw{dr<7wjcW*>J&U7Gp=T7sb$D!u~NT&FcuN!l*4X%YaB#`FU z-~F4K{~f~aN7!)x_vWSIKSuu@U!DF_YtMgg-k#;(|KIWbsQZkD>NkTH=SsmTR{@8o63R9UrioNnK z(bQpiE$7CHD?V-cZwyuCq00t89AaUFh^u-ADksew);bD9W@df3hEg_c#`<^tuFp}Nq6ehqqn0|=G%@_QR zB>#W2DI(Y{hiE(du0aJg%tR&YYSox9R=hs@twOSXz)l=~%b8kX?TwCT_}4@>_MJ#| z)+2Fv>n=qk!j-LM z;yzGMBbusr$fd#3_lRNN-~LYma$e8TiR0cmka!scQgq zv5l_#b|RBUKx7uJj~A!94;EL+s;!F{G;_wQ$#Bd4Av|noz4cgqUBt;;-6>TDjCDVb zWm}*AG{)}qSj}V_A{rT+O@_A$=;_M}b)8PW8+@{{g}$Emiad;c@LoIB{4RV}CHgk@ z{F$(!1ZQc>5j_&?tgo>y+yY3q6mbH8ZQbcX9;fxQzwsv=xe$ zi6g;zSb@g5`ab1n=^?MW1i*Erx)&fEZ1e19+`E&g!dc=-OWfvRQ{}p8r26vONSb4| zH(CU*S#DZNo95S7C=?u$5ApO~c_#$ng!|FIC(vD7id~}2^KKSYBX+&2m29q2_PODd7;G>q&^X=_C)3hT3%F3r@$L?Q=CG?9zrbt+3>fMV%_rY_ zIMd6oqbon!-O&`QxsIyJ(~`0%|BL1{J})XO=wc$}IM|_T<9R#P0$Lyc`{l}oE7s*X z@@NIA2zLi7jP|4>jjvN@)xe5(3K-75ZtH~w0k*iTke-l^NVkQv!%xSl6^-YhgyE&$ zFKm7GDxP`yC^fvDKf;Wf!T%Dhv(+y>;?G5$R_470>NcEFBteb2F*)Ub#uYY$WLf%) zIoS`0yhVHfV zpMG?&-=Oe%Q`-|bl=%DTTan$Rc6!~Ek!Ou(b{F@(%5zwDQ)ytf<@it&4)ExhRXUrT z$IuGX$wbKt!g}ima>`8VvRiG%J#+f<+%P%vl0me)?rGfLcOsOqW0JNTW$$K-Qb$Xw zRQahDRb=*^xjceGuQ$6=GWuKQ7qxQ{%T}4prhzCYp~U0X^wvw1txMFU1(OSN>{una z0~6^Yg#w-zbOcm^$Y13P*1-$xVj)7HZe;6_EM)>Kp~7cU>0@;GPT}}a4|&ImUzQd- z!DXymHxwt!FDb8P=uZFoHkg#!I3Y%BJoou$INu zkUkk}2n9P+g0RN0AOyis%6;{vHNqCid=hS;bsp(s|~n)fEqrB!hoxy%2w+dRjC zS^u1%c(4lyGENw$j0RWBxfy!fi*as(;W->d=~VK^MU$>E}DQ;5EqNN_8b6Z3P|9Tfq$x zXNg`1{%%R$nJL*OipVI*AR|vcQm&($gs0mYYk;S0Wq-rv+qay-6`t-|H}^Cpgn^mk z3Q18u$jdJ`(keI1=u*oPk84uN2eaN+CY%yVl@&Op_QDh_q zIkHlHmOnd{vD%d%PMgvVk3ub~s%q77d*PLS{(D`y4l$Z5=Aceiw=yrCvg%&Di+wPu z6M?!tY$|~-UOBW9>N9>&)!;GY&QV&;%+ye(S@lNeYx2t5dh4Cl+7sGwhmEAn{9R3- z8mZTK*z~2pzCM*%-5D2SY+f4`_tN;MBj&}w$N_o3+>^buz(2~fydOPJs953;(~*Dd z64CDBSMj}iWvoxxPj#2eidYp!wClROz7Rk=Q~r~v#R*Nopx_bogd!a8`Wm!SqIljL zi#x36HV=QreL^snbTb-^uSm`Zngo2AefuiWPiv>W&2%Nw*er#idAO-Bnt`9(YCTws z!}xyAH?h4=9ZdHyc?87{@dW>NizB&C=C#}r^CWr*f6mjazV(l4!MN&>^srkz8A_=J znAqWweOd>>?O$SkIkgi=Z<9HBKf5lK8sfq`@{HyjLn?yV_A9_pC=zScbuJEm54yLd zWX?+tITpPEaV82lY+fOC+lh~FC~X--)&~4?(ot{xZpM~Ap}J-W8VBQ!JSYsg>_3#F zUo_zAuslE~&`#W#zoL%B(`LL4!X07`Smo5)89IqyH@Y>jfd%4RmH&lD?i=EJdq28s zc2jz_WXii1#E~!Ieefc;DOFALB_87X&Pu#s(HrL9Y6T18yS)#(MNsO-N~bDpQX6Xu zlxP0kFIox3G4bbx&NFRkc22duS%sBPx<~dYp&luXmy;(7JkG6ey;1()kHe*o_EquN zI2vsd!ymTHbPeVaw(H)Grp@=#q^6EUisnX+ja%Z4p*8j6@=xngC> zDMT_&c11qebS~tWwPAH#|$K=gE1geXCL&eSJ z@gxe1D>7U5)l{x1yU(8v_VO!_9QGfXP8lko%zoHx{#^7<;Hld}<8b;2&D_l)KyQYW zO#hOqFQv3;@BKJxr@t3%mVmcn*vzrJF>57~`x~5>o4(jFrdzh!WaP_T2K*)KqS6X0 zFbTsiiiDu(|LN;{TPO}+JvGWrn%*yPDOX(W?QZ-#-i)m`|S_m(15e@E$9b3&MIU3s%^ z!HQDnieAYRB7j07*4xc3!oz#@Q!RuNQWVa1Dm^q_&$7#r^bOF^h#fX1+~$B(dH*O2 z)_i@FB_

ePjWw<1WQB@N7Mqi(dEd)xH4$Vf*dG&ayaa2dfL#_~wfVyANZ0xU$F6 zmdElsz94mVqEZ9?tqF@>^6-px@4!#V@>d?YR-RMHlOVs|6SfTeX}Ws9tAn&s{LtR| zogO*2Zk`3d$H#oe9g60?0xdh1-PNM0X%k3nCfOi0KU57!6~Vm>J!jbcZ&6lw%}6!$ zwN?sul+KBC?JMyA%sUqEMn!Yh zn^W_n38@nG9kdSI(>twodEVT@xpiZ>na){Heb>ZGYSQKwDvOr^wpeO6Us!!mltV34 zL$H8$sYbInkUJ&Un_f4(qu6t>2DP!B;?mC9+((ABQ*y*jlOBhMO3)X^oBdcu%0siBLhiyeFf)8^F+@V_Lt0hsH1XGyPHRkJo4R=jcl- zS~b-AlxIy7TqELzoWi1JvXXk8a9NqFIA`Z7PZvu1&o^TA?TU)CfX90``I; zb#G-|99!@B<|dDwU5LMd%`EVyYJXs{elK_^4Q;@{1(^}&&e^yjz_hyramaDqfjwQO zB}u8_Lc^Qt=I}6)?C~LSQH7DD_$xXHb7`LXt)o)A8NH%w?UNS4?7zXM4X(#=GC8Z(&LPK$?WmD#5v`VA4 zA3JrYX^tSAO$cmST6xmD^)`8i=Jaxe1u&Ek%GMES-^(X@Fm-PF zHl{?*V@`9Zd*9w!XyoMQQm=dTFrPGn_)|xZe{|dXq6scv0L8mI<6)K{?>+Sxx7n}A zr4;-Lh#vIn^C)-$i{+7c_n7nv%n*Gx8n|>z_u6c{(RMbkW^?9*)OUAc*OCV?0o#Uc z(V5ELF;YRYm1719Z`&K;=HKj;l`4plyVv`%XKCFGZ#Rzbxt1@VTQ^F6aG37d3*@Cq zbuiwM5({TA0D=cUL7<3YC@Oy#v|5bXt`U_g_l%gOM!PFg57KHEKQ#!pE9wNQP21^_6q5 zA;PtQqI96#PpSW^ULv9(QW$6^!q99EvcvmV8{7PKqEMTcxceTi=dRfir~~U);;$P~ zD`lLMKfM2`6#M~Xvd5a)jzy-NsLExqYl+5v7!&A_p}(K?Y5&j=I=IWVRK!xr%5lZD<%OG$x zJe*VGVAM((8=BxT@u1hHf6nHSP;q;;; zDTZ-gt$?{m$;AVI1!pfiGXg@s3{UI-2_&((-=hPeJsZvhxSU*}g^{O9d3PQ_sQjS_ z2e>mSrgvI;fA-L22D3(V6DiBsCu_)au(op2hnd?xl)(2*scN=%|Bj&WzH*y8b6$Ru zDRg8jCGByBb{EL?8+U$OJPHQ?%JFNusurWG4@3!s6kq+rEwe=4^^bwQZfk7gImu!r zO73wDk|i;3_Z9NTmGvee{pi8CrFPsuMy@Kwo}cis5Jkd;C-4e2WP3TK;jCn%Rf$Ir z7jaoDLqt)~tKakiC(4`ACrU60a=4(CI^=Nyc%-%A1cCT~OFFrO3laPg_yIv7DP(h= zD$dK#c|7L?Ig9uDZOab-sopnZO7i?`{&^?MU3|Msj>ud-(6~_GQO0t}uWtWhCpi1p zn=-m@HHpkdF9_e?!X_C78>v;FIKB zTZ~3q_ypJ0?TUeE&AuiNQ-aRJDqfK76Qbk#(?g%H-Kujg0`xcH!x1q;{j$@>@6(=ilj&K(ktBjqwOGIHm0O)V=oS6;vX}q9uU)!10`6njhpCj zS8+uv4~rA~Zk2qHvSzc3R9#EjKzBrw_@$Klxkt|dYOxgQr~|j&NqOYAtQ$OUsM=c8 za1n0Bz+Fe@#%wCW>rGYVTNKmxY1`sVH`&ycwbqDf6Y8|}w+dz6t%jM@2WF(bR@Jf+t&evj1 zIw)(l3k?RLMnZd0QeD>j_l=)ctU0v=i*#3Mm=_sNFaYLv#lAt|MwQeXv<`rc@8JFVkOv4F zKmFS<@HM%fryRh-u@jG&GYrO0Z9f3PF>Q8aWZk3PDmV8%E%fz{b8cNjU7wYsuY%o> zdHRU49KLMDn75GT49WL%_1G^%Zp_rt156UP5Xd#Oj$CWbahWM$w!J3v6v46OIe#Gw z+w`_=D2MbC&o&gUSH(5{_@Mi|D_#wQ`d>%6oL`$g=|g?;EIq}P&uBAof=jC_Vx%|i zkd`RVP8^45xynvBzhka#@3Z+5O#=JUx}(TpXap)MGJKQ^<-MPN{^tsMWvuSH2lTpW zh}?9fjc$T4w}{p{{2cOQRjpz?LIz9gA!h~A8=rBFk91S&m7#g_2mYRSC?HX90M=cT zkT)ZEERL8(Fl?W4l~AoG1e8r_3SRt@xMsz>!T9_I#JPT z=-J^}xuW{B?sCyQLS2!mTvf7{>^>qo>rb6TG3*u;Iv>^5$SJ}%)ard654ga|sn70~qg6_nL=&&Xk&L-tvad$|OtoK;Rj* zszyJ!SX$IPe*CzgozE)O<0t*~T7pZ!Wk-QZf}xpdrWrz8pkk7JJiDQ;qJDGtzWd6(z|_!%q3v1R5xZeaJ*f_8D8BGwWfR^ACmAun-JtpgH*3JF6rt< z4G30BzC-}x0OAJy#dEjQoX()OEdc!%8#4qt6;L~8nwu+6eE02Tl3tUm9A+wHR%V}Y%+cF%1(u_#<>nb1+r!?4 z`R@d`mk8V>@p59G<%uaz64{QeOQCRtIyT*L1wSbt-ajUwk!x2xyY)100?*!3q0a1j z-qKVh=INq0P~vQPZ%3Nvy&t<68ZX@^$4$MhR?%PSIeZRTZdR4${~)h$ZRVTj|3O-6 z9U}Z>Uz!=h9GCUQt34rJDmHd#ZE7H%!wh*_H3L%xxT4@0Pr9f6lzT@8`)~rE*Pkbm zB0DJ2%Jw1}K|J9>o=CL4yq@@ZQl+1^zjEDvKx-W8vkP}gxNfP@r(fh$Jo~B6L)Lk< zkZ_F%pQw$|YEEKE4$ow=83B%R=;19_0|EJ&a2M~fRQYB?LGoBZwDbHr4e&0!DJIHwPqV+ltCqeHbWo!w za|*9z7CJ8tc@{Lqelc=h_Am7i&3>v=*0TVT?S(**m80)Ysw)jh%$Ct#Ww~6-*{Mdn z`h`u!5B@d*yIf-vavP5(L2@HSIAdDy2eZ1s*d(z!kyp#K(~c1*N|3ZF&oe^+$E6er z?DeiG9A(M4ITJLfs*E2Rp2KQO;NTtMW;4a&x$f8zFS<9z)EhSaZhxLW7 z$nj+h-RX0nSJ#{j?=&DR`&dB+yHE62I2CZ3J?=S=pWd=`Ua!96=xDAmXlUF%oqgs% z?sVb1R#D(~Y3FdIaD$8693F)!0fnB?eoF>nYN?%Pr$eR+1LY{6%{B<-ukupI94sBP zEAOp!Zag_?p!R;i%Wom2M!BuPsW>M)%*dfrZ*#@bPQiXROn*FEOx}~@Qe2N*Xk65f z?vM^4jXONSHVA^9CDwZeZv-+Iug5^tp!#36yTQn%kIVC~$#!GD`aA9eI(jwzoYJwe zBu|Y=$9Lht48AQq$q!aNPyztXi_bUzP6q_5mwCgJrMe}l)gIr=>I!wUYM|C9KkMb! zP+wU>pb8Dob)=$oaxI&_Q1jA9ln#Wq^i56x&+6$HFpsa^`ifneE$i6tn(JV#FGW>4 z5XX^phgNaV^;*7|(jVCyDYYJ*%F%`Mp0!b@3!>KiSy=z7byYj0;NnCb=XGO&YFj8Q z!?Tyz_M!`V%bXam`Fnj;HkJU$AgX__x9~RUI-URdPNCUH$6L`00|N?8D=GDL3^Y|h zT@W{!T7CY2BOpsa0jgS<;9^m=P?ucW)s6GwVi(!<1;n9E_a*aHx8{P#WMRnxPmYRY z|Lf>%;Hxa*S35=SpF#xIuzZlCQCoq?9s;rJRB3aQCm8n85R z4_H+0a&|^8z|V>T%f5iZ2O*^`pK9VV9gX>F zeGy6CJvsUdBBYlq@P>?4WFD+`};l?f(&If?*`N~S)R{-Z+a4u1X$RBW>; z9(e%ibx==k#7e2jM0Mut#uUB3Ky;>mwCuux^f_;mq@q>Hz=@^yDmN~jPAQ&u@Tm}_ zE`-#(DFxe>aiMrC4^N1=^K=17_WP6GuI0e2$*q2&n!VTTMQYzqj))qNgryvx|Im_A2-Kf!`LQ$WQLiW+K4hznJh zl(GHh-it~tf1A`iPtsS;U!x~3yTTP&BESDn=0w|I1mm8JUsZd zpBX93g_1rS9Y2(sAlRihC)_z-;En`bU?8#(UX~;|zQ`bbC({Dje~4B({aA0G&GYXs z2#@T#Ev1w)G%KX$al4Yr{xJDCE;Gys6hQ1Q7$42GBe&H=m4+0 zr(;oN0XmU8jJ6?lBzZd7djb@clta>ASM7Kgjl|*2(1#yW<^LDGUOG~lQ24Od1mr-$ zueF2}ie|kSheYMnJ@qExsUUYubT{7A(UUphy_~8ofhn+v8=8&7^UK-w=J<33Vu#3g zsUsiQ;xfWOHd|__h?j8*u+eL!6oOud+W>Tdkid?L;|Qc?Rh}{)IBHyiH?qvT;ym~| zdNa`9KVY)Ki(7bwQ7JTf-DpJx56{wDw%DGd97*o7U%9193cUSyK?-*wloMV!x_lYD zz!tTPeR7wxCgPIe8!1+o`QsuK3p^!jmIikJqNN`dgr5csZ@L}wpzw&(6n232H6fC1XQ#QlLoB9|4eon`&9kf^J_9 z_j}snKSrY!n2EOmB+8YcVeE%4q&NbIDK?m zDR>QaGk2BUUR-ygX7niEaOG`DrNHlFaM^K0zB_p9UGq26tqCNI=nLm`sQ6OFRS+`|?oAWXbZ{(p=_Cr!$AvmLloV6oB zrX=7s0mpibthI7jI{Bs9a-?)%l7~S~)RnaAfwf!H-|{1h8eBb#W}poDg5j@Jv*raN zR|4q?KZmr%zmv~EkI{^4B+5!9aZvX2Ij2{v2yp{v`z7g7t~r-z*SK6!SQsiQlJ233 z(r^Ss)aguQesy18bSy`x&~_L`_dxbg#EIQy{)TOJfIkN;Pw?zu(+MT$Vfp4&_1;+e z`7FKMFu=y7$12oMJOelImsdTy5B4~v#R4uro$3Gz=FdT&~lkmE67QPH4#OLL!@{rTGW z2A{LX1dSMv1N?iIAm%_ntnIAJoZF&EyroFx`L|qC-!Cj>cdO+3%r4brTL^0FtNsPu zP&~Dsp~DJR8q(zn0@9$|V6d9#66&6-xW4_h?=qi|L0q0+>HQ_k2ZuC8H!s)YsT5Gd z0W_Ik@hU~uNE#_4Z0a7+-10Xn5;CIq_W$V`6eGjOdjJ=yTIl-YiFvH9i>C*o;h`?K z`tuahN=70|TakeeY9enW|)XUe1 zqZOa^v#^%k&J$zp1U~(pbKZ-iU`%ac5|ZbA?eECLMV8q@9DWWp_(4qZl{?$jAI{=Aquu9$7F|Z3 z@dMYmd1d!&?(?R9_UXTHr?p1y^UpttlqK&wris7L_~CX?QH@yX6%8Z;xRvz!A5ZG;iI`+$)Pip`ZoB{RE>$FL{$hW1hn@ zNEz;Cl+A5#0$no+^OG)~fRLLeOtDG$tU!fMytL{d=QCvAM(Dsx$8tK#Q2pwM@VsFRsz)AFz+=eAjQ>Ajk9P zhY-$b))$tNW{O>gTYT1o`;3M^svdCCYOc7FPOD0m0kx{CGjZwFc;^w`%|d**vohYU z*bF|O?n{5F++{yv6+C|zy5r#^fWrz>{S+?K-!hav&@xnRP$}Io$P}N7;j`ptPz!XW zmj>vZ$=JZ#NmtUWhXZzZ)I<54oOV>OrwAW6su#@F^U5(P*#5UG5tz+U1zJV};R;pC z^~FE~6WuKm&PNjDR9iPpo#CA1_a1SxA90&W2B$B|5}HZ~!d#4Ql3gv6TI7n6agAd7 z{QP{-j?z)N?#sLy^@_=;0prtDuq4dJiw~Vjm!PrVTyX=0=~P1d>V zn_XPkhufF(WJ1VY=YvvIw*J-7V9rcDv9Lcf$=~Rf+()uIOhETvjgl1{FlDG}T?8-t z6kEXe)J^DnxtGxQ@#-H!mid|As%yK}p3gU^69b8MB+RBnZ6IU8inO9`091wAo)6jw zyKuipufKuz&7NJsfEbzhf=jIGZwS}J>IS#NLpXU;VhjRTzg+*x0pmY`VDX*Mm#~Z3 zXTbl^di}4q9MUc1J$548wO$nZEJ(Fc$b00+SQsa0Z-u%B4?pD&Rhp?=iH;7OB$sUD zmO~Z_TRhQUXelt0v{t|M&0Y=lvFjjgQIXZJ8g%-VORR-^>x1A6z1uUXeD=xchv3OU zU6^3-_VNKM)W-qu#S%i3CV0L(%QXftSd9W?1E+sZgqIg6+>(|WIj^`&=WG#E_q_*Q z2J=_jBLN%qc!WC$Gki$eWlp(G+!Eu9cdbLeFogJR*!`P$HY~MIJ?s#dSd-!k25aFz zO5FonOo3)D9)l2_&k))1sr@+Byw#IXe|IaACC;gu-;)UJ%K#V+2bw&to`4>lEcWvW z3T>cHnpcX3`*nv17!cJp&5^FQvuKhd9JkE17goc`lL3O~DaOM=V72TwAkBRG6HO5E z=7nqFin(FM{=b$oBqHphHmj+Ob$rU>mm`7R1bzEON3*`TsLf*PS;t=mS?n(B`2YNZ z_s(+Vw6}Xx1An!y}c>4Cn!w}Wch|Ss;^PHqb2b9Reg3=%& zz_3X)!Q!NS@^;jfjX^t>al9AoVYF1%PGOt0)i)?GSV%nJi?4DP)-BUMlB1N#>EY6> z^fAbtHY~%?W2u(O8ORU&^u4vb43t2IaJ+sqwVMn#YIG56Vg3?LiedZEG1q&cR8-b& z;u+AM0qD61k~U_qGa;=$OoIxKFq^NL@qYFx+fiQ_H(@r9AS?8IiPyxDdX;wRYb^0> z#4)Ss?BpS*qHyKq+DovYRfv(EJ;m_q*W|-oFaJG`9x%L4_1&iho1!x8u=jLG>sGJf znmB@~eKITd!5YV7Qfn{ttCipB6NmBdg+h)@)pGR$dtW+B;t(RR;%rB5*x@~pk=}6{ zP%ALw2CS6ha9u<6!Dx*6h^3rr;4Y2JcGz+gfR6jOs%5tS-N%VPxgYibDrX&);4i-e zBnlce)V0Lq(>^pr6nKwuNp)-wQoh?!zS1`<3yau6Aud_AhXR1i53g_w^odjv0O5dyzYRJV0<69)hm|4)JL1VvK zpf3dUTZ&LV&765xp{0UBH%*f?YsaOIc^E`rzv9@Y7R>7>>$TdsjV?cykix^WyYnok zYTU$#y43HRP@92f^jmSp!OuGn7N-$Pgp|FSE_JDx`!%R0 zJE^70Al|{LEEG`stIZ~8yaa=6(!la{mpRWYOw&RMOt~|pqm(gMt$?|T(D0S0t>Ilh z3a8{5HTu)gePjHuoa%zhm&Zfn!q21xo|+hcaBP>c^!mAu)QrB`_T-g`(6bZq<}P!W zGMz+f*E?qNr=i3t3RTJ)KDYuE8nwSlxSh1ab%D>V?7u?(;hLGT5a* zp5joa|NJ=lTDLm6(O!M$hYw@HS_Hehi6u$BT>sg~NvI()mVHJStWZ~4k`z5Azyu>w zcj+_9)4*?jaO*YFZU)L2sb3DarrX|21R*MBX~B4F{;bIM&3jmsg_~xj$M(K233 zlGfWg(36YcuHtQA^^kvh@^Lpkv>fGar9e4yOuM`=??=sy^J>SjhOL>wQ{yJCx5kG#wOnvt=4RH#@yBbmNBqVfT*_A_Hk39xTY!Mfohsw5kv(M{P6n9W}4qNOWyRb+SkRxfXu4&e%8oyd+%d(E9gTWDY|T%U!%RrU8e z{Ui>qR$le<3p@FpQ=!DOGQS>TRT)ND;xM!XFBtz`Mwj2spG~P&w`~szwLsqJuu3M_ zW8t>+&zRu>|N4`%_Z(-?oAiqzZCezw-H*}-6lxJxl~>w=-!*V8k$oZ6f4ORFbS02) zA9afyO;Ft&F}bVnywbCpt{HAS*Mp;^abj|c)sUXmloo;E%3D%DjT7tSC2mktHfzPK z81pEo3JGie1@jF9ot9s0<^4FuCo)V6Fl-VEKf|%x724LVOvn?{T*Ua1Hc_M1qa`bI zwJxI?$GVCl-RJJ!f+Jt(^u2q1i0fPvWV0J3$}6>(4#3N6^9l;2&Sw|*tRJ)L5{Hp;60{}c!5c|T6z1K#_9eF4Q)}D$c0!UG=p>Ypk&#bw zON~oR%h2V^mv5j{g))||IPVDQIP5wTZqB@p8YS8rnwqkr-Pzzfey~rW>l5KJEkaKp z{k<1yOh*VOHpl#j6SDOZ@AwF-`g!hbA(Q|1Mm7VJxKPwk zUz~K^z#3dMG?VNz@gjJJLM9Myi6tZM>Mv2%wmx&VfJJXKxPe*mw|+cYU49{c=qEb= ziri5ovWBfe9eB9W7DAMefGh9;?ClbNQdKFY5K$N!hlkeQQ!;9C&{WKxW>j6w|Vc|E23uZ%F*3tTk zqS~cv@(pG2dX9|){i}rqO2|YBldQ7nrAks@a*Hv0Eq9xayz>yZ!kCX;+9+usr^+Ew;Jl|7Wh4HwojN*3*MW=GlIEb|~0+ zx+_(rudfeS#S-W_uoB!PVX>2I+i#S;U6OpK-%`R*o-Wjc7Gt?=f(TYcx_)cIWoHN2 zsPUui&1RWE*>igH^fBY|AntE|TjS3GpKBBxW|aHD+H6_8uB-R@%4WkZW*n`Q;9a+1 zIl6HW_Gx)Zgh@%Y1sQ52XY%f6P_>6Z3;(NnbSo}+#=y!Gm>I6_b|}YMNkuvWWJn z20;GOHr3lO{#rcb_k+d_FUd_Du_m2}avV8sq$+CLpQ^2E=b^Hl+Ynh$NviX(a;zH| z_uht!=|$Yi-i_w>|LT+;*g?!)G_GA`*aK$+n2s~73h1YwZv$>L8L3C!rTiUg%6B6| z{fazh^LY)}RPo#p(UE80vbcafYG)rE?sHGGDRcW6`Qgf8R(sRcL%+QB;iA^(+Jac! z8xQm@JNrq?2arkrN$~)W%9Ng_U0m~EYvNII|B(}^D#2z z&LiBw*5aD%MyR5!Bk9B_{%WM^I#rfAJD`=%j7|W8=r-By9`F7MwS&X1O2ApM;%DiJ zwdx;k-{p42-lbsF=2Pwp9mz`#i_dDw@#~XJpYA(&qcHt+x`TN_!D_*Rymo}2ChKz9 ze~h4}$4~82`_oz~)h6DYt>)DCv260FT=G+OxzqH9!6FfKx>=2vL8HUtr0~I+#nAcI zW5iwiCZmBHlk|Fs;D+I*%*>gBvnuLd|^$>#(Pru9PDrk ztMiE^>HkZ6_aTVz>Cc{?p5q--9j~I}zs?YMwI|JcJal)iz#=YJS-8x2(5x5Sn{~V5 zs={)7=Jwz+b#tZz7HccoDr?sTyL;{l!nEEcNSB=1>~YsDT&kk_<=M_S{Z7MSZ{x2U zb`+4>G0qPBIoebaXwfG3ayDmpzh@U6?bhed?>5m^>N~}G?>jG zveL>7iNyc4A9jHsT3L%FJ-EkqU^|^-!hj$!SjqBX0i>zrpE@Noj(Hq$dySMO0f8u! z-Rt6tKuY89f8PV6=>hK(q^f`VXq;uI@wIhw+bHUzgv!+^M9G4@cM-8@zof1Gq`)%XkM(86_ zzuy90<1J*eHMk16ku+-0sYFM(lPv<*bD*)HL=hS0cnIA1rJh`0RZbz`WUL^^_Q@r? zKKI&!3XFe`v3XsuRrI(KDF-bKi}<4tc}xzeqrC_A7wgXQJ-E53Y1*Ssg@dpQ7atWU ztoMvIRJX+UJLQ8;@IMQvpq34phE3&5*H*$tmQukQ%;t~dQ74tQ`*rh#j+o8t0bTck z`(fYx^ni>%FLH(L4SLm4{^|SCUkAWlL&D2kvVOJ~_QL6()m2S#*vpUS!01YVP_el| z>laPn6|SxA;Y+QD?S~EhsU4>sE^~EH5XZBO4U6S_dq4dP;rySalx8v5cO;wk(xXDo z1D$-Su&XEuLFB;f-aRmWUx?Z9G3`~53SFzWXm?d-l2DmBqyK!Tt<0M(8S3^FDp=fh~S14bT|(osW=<31V zLu-zG;JD`ucw_V4_@mOw#l5hvS0F|(MAI?`kdhakpz&JNociv{x3Ev2s^b3}~@W>P^MjVB&e6nC_8_rMf3C z&mhD1!rCM)tuqh8uJ%J0UAPY>z7O_(WL|qqPRlL^!3{GEJW?nNHsi9)@aClXYWL+Y zd5Yl9c7LI8-zw{u&h-fb_V_(q6!ub+^~_$p8k;x(<2Q@k&fcIYr8M-h zX)i3~=>iArlrBpy$u#Jy$XL7)@UB7Qy^9n3U|;`aiG;7xtV6?WwkEZ2H;Y^A?}arI z09XE!2WSIid!U3Or6S%?3r#vgtF2snOq3TKS@6dz2oFi7kz@XH*)-u1ywfbjfbvl(8X``VW1PGILL z`oHKD=-&V5Ec$Qh{;$*S|F5oz8AGL~|zFo@71pbM4x>A2Kh?m8?@9gnrb08dJ3=M&PXB%2Tpw0(_iBsYI~9p@ zdP5$=RWMlXh%q&rOFwDA8N-I!WiodrTIHOS3L18qal!LOx#du+^RKS|pa|vl;>HP- z0tt{ghrcl|*|+R&k8%150#Q8zmOrFMh=WV71@iKtDi3d){95bq}CA zk>D!cWm&pB5Y=t7l?&DYjJtd`f!(fsT573iQ{86w%6KLhdwZo+ja*^%gmyt!<&t1x z6*hp*g+0dJdG|ZHzK0&%aQCjySShYi&Ac)Z+cL~PjGOwLWH7XwF2L(GwCUf4!6pqV zWiQmHTCCk4saWs-vI=QfNHTJFD=bf`Ad%!3l`D78pvRY|b38$z412B>P)QTt6`%8r zk?3bq^%6;>-JLB4W^-kzf_m3^ICE{g6GvKJ-^Ojm!vC>+GH$(2`+@FF=+fEIgw57) zhv{HvvgeI3anoRvjYvyDdpz$DrFAt>6r_oYO62C<0t2kKg$fGQMeHWP6AI!H| zT_2oDjNE_Y0@X;{8=}E$dMh8Ct)F)Srow;sAUh#x(eDt@Yh?nf8RG1>O6jVypY&Ex zY--B`?XW*r-`%}bPh8*@Jo!knZrjz@d?DdlWko|E>EIaO?v8Z>FP4Eybz=0)X^&20 znXdImQ+Ip#lnQiDCl%4j3Cc^^Z`jo+e8CuQb`i8{YQ<)J=Zta!re-#fnBbvazcGJh zvAA()z!Kezq)^m%AFUHagfZ`niwb-E>4VSJ`)N4SxwfMY!=Clc*Kf~x(Av~7RYbby zxAn0e|MTZCR*(oov^8IB?CUQ`k=>u#y3F%KYI)oz7yQ22u890QB@Z?`eyuJ*yNn;n zK4hoFH>5tE>FY+;Ymlnys3%%?OYkEd6N~6;&6H$p&0q4Hr*EP^i%EwS1uiAlb?RPw z--VerDZqBg%%NS_{=|%jV+ZVDbL%D~?#i+1Ok(wr(6-B(@!i>VqW;{S6Ov17C6MAKf*I89fz&SVUGl-;_r?Y@L?bqBT$N>>KRPZ@e$GOd z5ik@eZHZl$xJ(^g!KlMZZNTn`pR4YiT(AQMP8zOAz7FU=ResN0ESlN|TNt zA|SojhzQaGN|hQwQ3M5*rXZbA0-=ZA6%df#LzgBcpp?+bzJt$x-*=qvjB&p4jkEXq zA&!h>t-H>7&1+usUeZOaO3tA&JL*3Uc2~lxm3IZ0f|a{>ceY;1=sDG7vgo3G&&^-Z zhM-kte2+n{cl*pF@GtA}@jxGyD?6*nkW_!qV9HC?lQO0yqD{3<>_vRw;bwFH{+AC- zfzYNt*QIwdvu1}iSa~f>hWtx9F!{s!w)fKCbBZXuhm&h=QpTf6`kJ5)AF_Z-`}VWN zr!t$LYL+(U!hQL{L$TMvPIg04i#7lLFkTSgZ}{v>vUEw%JibNq2J&M#tz_#;d6o4{ zhDfGX58CIHDRw{2dBLd5_PUleQrBZaX}HXt-U2(YMz^v;*&rV9$2sTkZ%*gR?3b}; zJ;x>vi9L=RP5-4gEOy`}U@iz@R?=b}jyGy#GHMvm_vHeg3-?^%Nq60@#hE@_*rz$gj^Rsl1 zP=B@g zk_F%UL?J`*DBregIy^i3Ev9|JT8wkNl=VpV&G*D{HqXJN8)X|IIqOhE@tPc_WSD;< zX2&T>$^?adrzxILynnFOl2zWe-CpBU(U~I<=M_U4W2khT+qK<4;@k&XL$;2q&@gH8WEeTC!CZW9vzp>_MW!TfvEOC) zeA?O)65jVTK?!%1oT{t|>14*&@?$Y14lN;Yn&cyWV~Y3 zSEsHYt;DRwz2eQ$b85<*cuL1uT&<#Eyw}B=`qN7HG-P!yAI(;Qp2^nbRjKXwp;@v~ zXR-@Y#H)lU8R3<)WC9J@j_%zS>y2coK4C5t)zI=sJ4XP+;5{$ z?x3?<&6vO^@t(8lB3vmBgZDU-K2>jA+%X-6DZtJmzxL|rUMX9CB|2DDlf#-^e$dEj zV#!4bRxL*rSAV~IIqb>YWL(IxlSiIwS~P~{zdHD}do1kyHTcHFMfT!WpN_XRf7$%K zWIpZ-$E{-Cz;57;%DP3b->Q#E<`|;O<;SggNBeZG@?ZZ})VX9j~S63<2 zxS-745*S2_<3YkVezb-xN-7dXW_Gnl#KOe)r^N@}*U8v(Q4FdS$5wKmJ=eX#A> z3ST;TO5ruFHcS|qarPc(oJRZA>+mao-+hzU9E~z_JivX>?boWSzl)P*Vh&yv-5_Uf z7#-m^$?J?sZrbcc9q6oV>tXpR5FJukWIw&K)HBR})HB?RjrBqdY)9&|cf(8@t{0$< z>eMLr=>5$r{EWRHGi74gh2S$QI~QkrV-W_wZEW5ZdoxfD@{c{gBR(65P|fpNj zOxb+#?8bR>-Ov#;vn8)(Il4%yz6BzFnkssMK!ieYFyXtA?`X5=kwQYruUqcHrjF{N zjkfmcxxxkpS0`;$^)1BVD#6jcvC%hgHN<;*JERO_Pbud|&Y+4f=+M=taes~Imi78V zCs5t#P&FSVzQ)6|ptoSeG|kMgKWT3FeR>7u;OrBoFs=fDXlRRZBaxY7-h?Uo><^hZ zwa1@*3+VcUz~q1X88|mL+``0bvcc{CIrY)NnG&mt1&-l}{xMWpa;lkz&HCV}@r}AW zc5ecd+FZGlxKEyPK;A1_-*{+j+d%Jd7V(P^k0K!Kd1_t1(2LRYvkG#hnAypZL^F$h z%=cT=!v#9**FO^VXbRUl#CoWmhfIbXqC>_R9V~Z*8`@zsb((9S>{oIKi)po!!ahfP zAVReIE%#o^+B(B(HbWBhfyHEcM4f8Mqy#)GK(g@xej{c~y{9jWOH?b62X0A&C+qm* zk`g0j0&@Q$QA@;vM9Zep{iB$?Huono=)ZB;o` z7BR;EY0?SS#UnUYg%9#4&(N#0I-pf=i%|SN9Ro^F*~N;3S3|A=n#p=j2Xz^rYCirY z1jh#Jd{IoT_(hNtSBZujU)F$fOQmJX#GUKjp(k9nSJoadR8sOee1hMDKTojMtvi;Z z1GT;1_>rrG-hQ`V#}yZPCY!Cb08{x_)LfSH2E$!EL%y6so|`||`sQ`GbI4oMhAT$P zedq*HZp*x?tyR06g@~HfRVPG2`7S~*o3pN7*7l_6&`mracct+5?kBg!HW{2CWx2v? z5Nykgfd&4-wHw>3_bWE54bM3Q5YG2+s^M2zQW%Z%L=K65zh7N{EDh7!6IxK4Nfbh) zY_xkIx|fc0YQ;~)BZ)a)k5b9LM>?YFfKaxp?H76Y^_S-yW6P$+@>yqay2y)mnWHnB zfvLn9-UR{u$jn-eh|9ahbf;LLEP^5_W0hs(S+w>=alBkOmf*Xh_C8bxa z#0*V{*e1D?bO-ulWwwKx`!!owY!=-o8xZ|oZx{}i{qGvn@VpaR=oPdde0r5&_tVNMX_pJh*%!nQk#VcS5^uD&yj< zZpoD!w&lyXi=}?OXU1<3W8%NmGDf%Go;%Cj+3jIQj#H7x`2zOjTGzN5p^ok|{72c$ ztO;ToNq2^)nuCKGZr%JLIdP3JUR&%{XF}fJL9emzp?y0w-Ump-6y_yctF0H^yHCp7 zTM2%Vf;pRF#7;azeF%=Aujy8LiRT;-?d}zXB zazm(pWkHPuIWxy}7$*>LC%#Nway~6WfQXCG*AW`zQP{N>fSrEJF3}j6w1@nTZ5H(W z9^DrW+=u`va1POL6PA9v$Gpj>@9rCB^Di~l$c#MAUl1Jv9flw*RXpq~(x>acItMKh zLXpTW@s>KTL3V)~Y7xWQc|PLiApa&Ef1i$ec|p54?BtcJS1KTp0Yvdoqf#lx)E%ws z(HKmy)W+8f#s#UR?cM^VGlVJQn(CrD#*XP$L3~--fqjgGI)&_Cp4Q{M4&1ukTp42@ zL*b%sxYoqIwYy>G^;tDA=97DgbIgOGx%iR9HE)iZF@lYAJn$r-<6BA8^SpwTJhnG0 zPRb5@EC{HJGVf((>S**o0Oi36s^}71&G_bVN3&sRXlT4AS^ai&WiPzu0Y`GBy!_s{84c=zQvw0#xr4U<#77xfdFuQCWiOcw#`{JNOwESK>WZH#uC^ zPq;02OG>{Rec&s-oNG_DELcI|$EyeP!z&!O~wB1xSc0C?HD z>0S;@PAj$`aCc1e@|U#6oNr`F;nAjerx=E5`u{B@faB?lkM||3yVW%yUKZuBcSvpS z1DS>F+FSN;^VWj{x6a!4a&k#JvRZ?)#R+PK8mXm>{XeYq^~&d}$BVdKgshfI6Y;A7 zgkG^`Mk zD}n7#=Viw7BI?lNvkVYF>qN%3Uw_%S?b8qCDEB7opEGtkQpbYNV$`|6g2S5z-Y4lciR90tk)HC#YSqHh$VC4LZeWQF*3UY)F*FXdtvo_n6QlrQc_a z2~JqY+U$CQgZ2~U=N2h~cT0?o%QWyNn$Gbzt$!uHYgfnXMx7II4ePQi{IGOPMX|K$ z!6+q z=AH{?&X)@}Evr+Aum2i)_Fz z9(Np69piAJev_6oq)$CEL{?k;Jhe&xy6&9+KQ?v$dd7ceeg8K{`yVg$&#mkKS}~`E zbUOV%H_LyynHqvRxQzY5!NJ+3rGpSi*X`WJT?Y2+70zjF!T)#>T1c{Dv|1eAE83wg{=jjbwYccnYZ`0zoOB4s zj>|Iq@o0qzhB`~d)2{Ue;L-U3hsTb~9%UAF_^cW$(gvC^rGXmQTpG87#Dpy(Awklw zyrl@aL~1)(|3f}P?dt!;VEmUc_%B;Bor-(DCQ_Fg^&#M@XZkaq|4|`B{rJCOp8lIp zg9I5VC@AQenAijEAZcJW%D#d!K~pI4*hu9~JF^9#Rc=63r#xYhdUciD^wSrzi$A#= zhP*i+I~m(ZUAOgz))>MOd^iiCtfK8;9FtVi+xx3jL?v{_WG~fma|nS2FS|ZJf^08$ ze_JTOF|*N2-CMHH{=Apqju`!qKQl0iy^`C;=VLlvh{>fn!8V``VT>1F_q0V(t9m&0 zTyIi4|F0|P=Ktq1`!7R$=o`%IZ={b2QwBNBBHrmCM$|*c9LL2?=vt1eXgRI2G)t?ckMfq}q-O6D&;Q4$WTc6B zgh^7WrB(+hr8tfB&z<83-g9MqIVbw`LKhG#X}?jdKdTQ0yo~MZKDdfZ7T1)$i=fq- zixcVeY%0OLqe}OKF8_PK$m(dhat9_w;fW8=HlE5i6b;SP{)E)p(vMh`)2i|GjLf>^ z+JpU)c?mFj5TQef%%5E|{4eWt2LVlnUoaxL#i~m0KHD|ypJ(gl%H?~;i6jhrW&C2> z-RZ*+DAIzFesIRXXCO1<7xnM=klea#OwqP)U1ocHLLkM#(B4O#`EmX|zBLER7i02| zanVxQUIEN4E?Zhn|6bdbc00AgMJ{@0noP%;%4wse(e)~G-~%9u$Nn{qwVaC*LZj_l zlaBP0=0ivFjdiEr&yBn5Ci6=yJ~LjA4M`DUWco&TZ(ILe%w~wAmK1fyuK(NBas*^5 z_eOlm9ezB#IdsuMswY%^-Xb6TVBfV_Jod@(_)#b+a9d0z>Au(Eeut@7RamhO)mAcQ{o_Tf5tb5U}Oizsb$l(apLrHoVWG}VoluGsib|`u5CbExFnA6%6rN& zuxaju$kY_KFMHWW?mzf(9dWEaT1SdU;PD$Np%u1@>2yrWVOII!xs?+~PAEAz{#f9#tS&(hsbS6y=A<}y!82%G&h*kz(HMuzI=m(1Gn2@vy!p#>uzTi_5M zje9Ms)y~Q*18r?8i^F}?uAc`Kg!?j2Yb(2IWX4?+_vY)1Y~ydAP;&$isj3%FO>SI9 z#<$Ugo0h@C(Zw49nlm#qR5$-EEwL*Y?`67i6`B|Uv3kb5W6@`ow55Ah zfYQ%wQ9V9l!TqeHdsJYkd?m!0WIq+Uyu6&gLDDmRO`Yh;+oUyL@=s&(_qe(8mV4GC z)6SuVU(HNU0-+g%gX^DtD`eBq?~}9o0TIA6?p)iw>*m~-0QYNAQ^`gfB9?7=?s`zz zawND@6Qkv{8(237_k=4(rr1U*?9c|bBem>0RMYZP_98m7Ap4WbQdmix5;yLAukDkm zbm5LsN~^>GXo;V}?LWbYMi}A+53#g~(5SN9-`q&QWOZI~GtVZSi(m-N2u z(v|4YZP;;1U~(KmLs#?+=R=QF&m~LT2KK@4bRtd>5vq*!8ROJ2uG$=MEF7k66_0Mq zT&14=#z^;%^)Rukgxa|qbv2HPVA>oIFJf-#;D31%mmJy7{S}!=3`Ru7toFqOAH{KF z^Lhga6($-uZ^sP;XXdhq`8@%n6)-?W?-k=Q9?2%4i z1gt9%$b;m_pF#9v)-ATEu|tSrNc@O(O}on1@?Ljc6*BrK2tU?v%1CZ3&S-65sp#`S zN#BbMwKwj4gx&z^aT$E+=RCs>HhjFMqXg++@#pJ{RycG&+3oAevL6$uwgKOeEt-mR z06hzLDsU8n1S#N7MWPD6=)TlqR;G!!NhiCR#~b9p`p&?VRJU!TiNRX7w{Oi=@x&f% z!c>;KhBhy3Iz^_QPy!vgP%f&6&VS#uQIfLLz-nZ*D%Lb4ADFfD*1Z_W%uYC0zB&n! zZ3P`-)C&#?K_BdG>*?q`0xQzN%*m+$o1Q)#fz-bC_unaoyFA?7Pj**@9;4{aUCWSq z1?qK5(HpM5zSYBzZEP}QMW6n-6Dxu?ibEe6SPPYU_Ul23ua#9Abx;w3NwbyuhQ{Yx z=;YtB4u0v}S+Df$z#~4i7*~HecGVSBJ^`67r|0xGWiX6iYN%73E5WC-YJHRb(2O%~ zfC)Z92V=0bwCp>1W1AO=e9Czh8Ulp%OAf~60?3B9L*|T9DwRcS1$o|E@kh)vt*5tW2H@LHHPL`rsMV_wGJQv0e4=l~;|0O~NbuKCDw0@`47nG-( z!WfK(l)_~KKNLAUxP^S;F;NZog`JW`ruGh2?}189{#4iJfypi-Pp2Bo)_%#T2WEqs z5DPHVc%{B1tID#`oju#-YI{bdV!)(-{=`)3|bjqcRqk(kx3!O92)3btf{sl~M;+Hm1QKMEN zri;?blAv(B=aKYS^k7QT5oX)j7sG<4L|LcOjX?CL&HnOjDuxYBljRXm~btS_lj&m$1Q_yVTiJSs61k=qDP z1l{$Go!qT{>%DU}_Eu_iYtii++^WZZ$dYIO~Mj6d==*Ty^S=?w@8DD(VI&!I+@>XN^I|L(cS&5aGI zegC&&c?cJ!-<6%>r)$BtS?S}!$)mcxy?uLg9urE8Hd=w|<*)v%Z>KQZMk4Mt>7Gz& z>Q_kU2NP%g8kh+~v*y!?yk;f!qI$ZW@(KD&Una&(O_(wby-pK>wX<*GO)zu{Yp-6h z46uy<1_Am?KOG$sLAvVfDf}WpPUNmA<#8z^IIXO)HupD-WHxf__;2CR)Zbb6PT%ur zIDTi;q*qlz0q9k$emRJN_M4tkQdU-ezBr$(o^%Ns55K;e{v@2|wg(GLVSB}nyfj2W zEzfv$^Qh$IHi}Q9#tF}Zj*!{(>+MxwY>v!Zd|7yv) zMBs1T^trE+7vP>{5?dv<(nSQquLoXz(ke@Rz##<*v+OFXsuD&h0`DYp?5B%%v@8zJ=mTe}Yka zRZn*Zd(PWlfz_?T%_F2{G$G1E^DYh22eq-^w>d<2FVaEg0hnuGAXmYP&l#I$I^Owe z`$$u&kh-aE%+5Q^t<~Jq*!-e5Z%!TYBLkhL?5o)8=5iz-)4|NP&jD&}Wu0XA5AJ_D62pOW*_Ec%ym6@tB|2c``1{Jf ziLC8jCExPgVGAI4MBb`H)mX;0IFxT+f~LZwv~EDc8smjtp0jasa(3@SrNQoaAhO3AvNvxX zLL0dxSsmZz)2(Z&XJ4)7%|x@CKlfT2FEvP6DWlcG4sQ;>5#=?3X3nQ?6n{TE1waRf z-qK)MM`!snH5!gen-Lo@;ZadhdJ^Q+-`7V6p6OiXJOxesTk{4?)<7fdk?9E3j2X!x z?6c#7;MQWWq(pff)MH&TXbqKrAD2E2inCavc+@xMdzuOg3NnCFAHt&h%OUcux2-n1 zRT64(LZLxKfMZ7Y-Kx8dj3@kM?_;RvjweR=kFYG zzjsB7fq(1jcc;G7dHOV;PGK80=)v?69sxTiz4|lYIuh9&lSSxWfIZE;oY9V{3xF>7 z*Ca>&ykYBWZl09I1)4DNzm2LM8W=F3G?JGxlU1I~$kvzH+^@7R0UOQ8vnB^%9Y*}Y z_Sm`I0Zj2A^6I*1(a4Vy5v?0A$fclq&9RT+({pp8hQi7g=(V{H_i)82AC~Cu2x>+Yov&#rrz6h|+%W@qHKj6L4J2py1O7h|G7~^Qy zh%9~)o5}R$MVsn`xVkC{fK6nJ#Bh$4Qrq3fkER$k%LlHM&cPv!Vrif*lXY3MQxSEX z6}8&fwf9{1KxjFQBwTzho6#Q=#GPlPYatYsj#ilR9y53d_5-OjA+*ony0X6j(>?19 z?Kker!~}MX#qCs$gjX75Y`zqUchJMb!p}3uWtoWZ`y~gIVVs(jhw2YDQqs24zqo34 zeP()wc# z3~$X98yJn}6z_G@yh!f6rd`dlLaT**9fzLoi5=-UOYLLX-sdUO{>HFLA9vAr`L(g9 zG=;ed_r9Gv;SSIRX6Je}WlJmXxA=PU@ zKE=hM+prHJ>lF@~dZy^zmc<36+Fu&M7H-VvL-k&ZNBG!m17+pH=V)?Lesir4k{JtO z0v!crY+%euG`HJkXUshRe$Mih0USBKR>;5|%SQr()&W=8I@ZF$u zudB+5ary~XB{HjAd=o|!Q+QqS0CsVyTt0!9O3%sTQR8e6^i6D|AGgc*W-*QJZvuVyqF+$WChJgA==I>LOaRNn%HFTxzJ2s zlx}HjqepV)*xm!l_uAF><<~m{Uy|`YFP+%yGA^W-+}~ZVxn~okFDEE0OsHFpPFm%^ z5Gg%S9RoAQrl$4|odXskYE`N)YS*(&)nh|2)<^Fm7?T5$Qqj2fE~g!_7@z)05mN71 z)XeU7i|2;(K-yoxqOp7iaXqL`?c%=>I193E7^~`8IZefl6lFfhol6v$g8#+Jfx(ZW z(%237h~`XMZN6~evpwUVHlKN(n6y!j9KiI2E!#hf-7cXIY#)+=WApFCp&sNz<8u3Z zZidAlp;&}8vK~ozRqHb^cG8=@NcBN9BCvjM6We~hu3d$bSIU8;KQ}(|fZ4BD0W5=W z>x!cl&$8k9@FqbRT-6sg0pZRa-hEnTE+*EUwv;Q_-Dqgdi1UyZ%r75A{h z-)qH#pEq$py1>D*H@zB;ZfdV0Kbe$x*_qj*r#7Y)d!4I~pR5W(x@k(C7ltK#mEn3D zsPP^9_*q8a`_xJMPjllibqnjaKHpGH=DnQb>dn5ynv1dpS)U+;w&!wAjuj z={Q8QxyCiNv16~Pl_hy&uZg%P(|d7Hi7W5Jhnm_4+Rk#fS=857B&THh`!ms~U_#>wrJOMf%xx;x4v zE}9LtsF*J%*ViB%<#*{CvutPL!pVIG&1$(zmfVQDs$GHM^{6puV*J%OMfr}f_MRHd z4bW~gYQP(zFI@uSIpR{`>Ax8R-LPcO#ez_$Np9V+7-6oV{c9lpy@UH|Ho6q1-Qi+> zQ8%pIW3~C^M6a}ZWbz3G8d;alSHGTXngh_0#bP9&VS(Qknw<%JA@mZF4GGvf{+h)o zos%bYqRZozxK+Ofq?vLJ-K9O%a^O9ECD3q{qD^Mrr@&L+IPFw_#rRK4>l6` zbU@J<_Y^As8|K1yOm!o!=vqWG<;%W5X;mm{=4}#GPivL?-3(iWSRGdw=3S<6T12p~322jG=#O8re02v{4zX=V=D&ftvb$S6N(a z3FHJbC24CYa!|%cjgE|c=OMJ3C+Mb*k@FhHmmLMivO$cmZV!+l`pHT=6?43Xhwe1b zT&*yM`sKt5eWx;4`D*wzc77Af+$z9JR_+K%%zQmK1_?S%4}DE5ulnlJptMl@ESolI zotEy%(c&Dt*HOhuc5ml627N1^%DBGyjj3eW?U@e5t&emfkDX8l(P~jpbgDyJi=w~O z+b@==HY{CtfA(E~jV>ut(W0@L&CvYGD8ZXueovD7JqtU;M>Yk^zch9X+l$S=u1?VP zRRc(Wx_tSAxrq6F+2mwL-A#cCV$|4*KN)Vlm|NU z_>o>RKNX|#8eB(8NDKop5fUm=pMgFD`%U#35+zq5F9@yFg#1E3488C+B(Qlh9_}@6j(z; zgDbHVs&{!c*J&E1ixYmv$?==#&TEXuq6Y8fZT+g%@y(=F3_C5aI02gLGqyU@x_H4D zeVpb6!#`su2MkB4hSKcoD*OJyM^rFDU=&+l6SuR!*s7+INA(&YvOE<87ua)6YV-M_ zw0W#tntqAWC<)4cu&J zu~{E?oO8w`H=A)}3@u>jJbp8L5LO7wOq#39is)m`?Te=zKwdD6;lb$MKwjOwD@r4) zlIc1IEJh(P>dyFPzkAq(@p`(`B_jhR+rBv^tc)ie%I42iO#Gljg9CG-K7E=W+hP}U zdi3o%FepD~p{eKgcP>fHyf}yoFZoJcBBWfEeuYO&$iO5W8oPBuM_H8rl)7|`ESzx$ zaOOD4R0jWNlqOBcRRdQpX!_ofyGh>GcW!f#B!q?gbSKeE6wQOWY$)Bi-ji&|jJ`8~ z;U#Q3J3Gtcj%7EcPc4k>U(CX|@&<;>Wsamy&Hp~`#a>i3yJ(#>Zx_`(_4N`A;I)qcPW8YuFOnH7TO&Kez3cD6jmR zde$bS)ViEkq$os33nu(t*wnZlgKX2{L+W1fvqFw*qo)#vAKLg-lrx^huQ93~+gyIw zD!}?ctYJoEHM33cnK^2_vi;bL@D0mF5|Bm`Eyok=kw_$AZNsWux;aa<`MFOp3&c-b zZE1z8uxAOig3gDk^bds#U?!sC-gP&ri6teltvKu&dkyD1Csft=##W(<+s@TgbsbDq zNcn2Cm5q38*q}a(0?5R@4*w?e;_N-XAH6tyKJE^TCX*CDKvuoYzCV6%ttv5;oa?$b zOhTT}F)%Q=$_T&Lx{kruiumy1&&^=Gb8kigtP{!QNE!2%Vvnm)q^zvvTFta+`!yS@ zhoR=!wj{ZaV)voPI`)u7SXUQ&eERiI?Mh9(JL2waicM<_cH8=Ow4J~IkjAotAe@_! z)BJR`ad^GQiDldMt zzKa-YO3*7?xKG);bPda+1-rsFDlq0AyR>|@(H&ogHjm^Y{B{ms`6wQ`%zKnzF=tkS zfffO3^Yh9`XyPR}t@0;;3N!u-WtBy~e#cE5&;crGz}{c>m6TJ9h; z&3%9B_`u6iLzK)V41v^@x_RwunYK!W@hBs+Q-5^_T(Ps`6`v<(R8y0Zu^XYeWzyaI zwT$8YJ>-JlJv{D|R&+%_l3xk)>68GTGqIv zU_&!&o`^LqjSvkuqwhZ*JrOLroR7@)cIZ)CL~B>K_(31Os@DX2dngqlO&A&%9|0)` z2U*4PjkJWp#E9GEA6X&U01Lmo=&lu4M=Kpi2eIZe6V3#AMFYoAI7w0l?xgr@gy(Ad zuW(xJvTu%MU+){ye9Q zTU>(Cu?32&_$G)xOPvSGY(LSW+D?XebUd#&8LPgtyGCYeS?eUuK@)xcNhEN6_sDH= zG8>;IzD9D;evJXZvs}*;_c1Lo!bpjh&3t*v84YB|MD31)W*=}cK=_An`^NS2%WZBe zJ$)Y%5?03c`eP}ce}B${LlT9{7Swc}(L!E`>6*i^s%E8K6q1mz9urQi(pI0Z@9?=U zhw=j1=c_7igX^Na_S@JaClol-=I1cKOLm9XYxGOU>13m-tG^O^M%~+rTB~J-_$#;S zi5^Ny!ne7rhH^C`0yO?s40YiR-p1$APt5b3)KW8|>E>wl zPK@nsp6p!luh*p7p&2insh!f-9ICM)X8Aq<+6%(4L&5@am_R_7`Q(pPrlzKf`=* zs}PYym&RfG%iI=KOG@)}jI|aeRS!Odhi4ZR^^OjpZ{PN(yMsIt85ubidRDu5iNz2ij;7yjQs;(%zZlBx*Dx(gr!M16Q^I(YT;nu2qSiAf{v6j zXQoY08pxdYQ}d9qHQw7!vA3QkXI-1ojR&y}xMW=>;(Vz&sMXaK_Y$ha67mfMz1MOd z9Z%v;{8ag*mr4yeZK_3iJglS%&n+EM6I4h`C9qo zt(W~yEYpi*Kl$mv6tGXM6j;g36Q4YHb&PkyM6>lJ2>&g~jb|67ER}z*BsrDlfLB0Zq7WvUB zns$$KRps@;1b#jSc7%n))^+pOMPEmde{!ocoEsW-Z+9V)sUq~^jHaSPkTQl8z3~l8i;J1A*WB5s z-9vJ0v>#s~qGc-D+GQ3^s1t|w8S=DK2WEvIg0CM?oPKU701;&{zoXh8ua~{k*}}_nsH@yw2AUy+3%c#9VO zDLx6lIuLqLwl^70j$ zH^n`2PWWht<`WYeqT;Z6jm*qUhlQT>Fgl4$@rZg2930yj(NC8O(FK`*8taQ?+AAg9 z8wrDU9pjFRdeU~sOZf8hQ+h}rTGNYFn9|>L{mr*aTrrrnoIBJaa@_o5f*GBiPy!`I z)utyEXwcR>^GeH`_iG$w<$KLmCS~@^f|Qs~)T9uHdu@osX6+e_?6xrWZ9{+HB$7q>NrFE_*FSVU4 zxEx2CwTn~pX*B4k7aYdcgWMU&rAq&ak{&jK7$|$9ipSVn2}6yMUilTLjThF_?Hbip zMCuiphta5h0ws3jdf=srn=5;T?RINqPqRU!l+>tCTtvjQ123pf%Z>(a&jB28I7@rz zh)7#jZ80-E_n3fEH8EnA##*Y->LAxkN~2S0GWiDwXIen|Im7-9LB6$aXEZ7J@e*m^ zqO(5_dMfZek9Uc4yl-=GR5b~wDn+hEM@jGTM%}dbn~~YGkK3PThRIo)x#jGZ_vYS= zpw*c2*==KvH1oPPs&6MF@BsU(?{m7@I@=t=fsH`Zdo!?*+FJ-I?ET^28%Zv^Gy~mP z0CS0yx+9KsO0VyxJ?TwF6qk?7CnC+fs({1mih|cT07sCiN~;A^Ku)LTg)7n^bwjia zYymx5{Gg6jpPolRprfF$(3HR}0KvKnWipL}02FMCG7(v5qH9Lr=#RM-_sPElL*U9< zSGXv)8o2fdk9iLQ-wOO$%zmv7Z|R8d=dtLk| zW>9UJ6Y~lplY2LA56|sO4(79eUZ6F3ew_Zv9M(du;!3M7pReJDij zp=>YjKhXu1*%-@>rLjisRK>d4I>r_~$>KXG<|%GC-w7As5Z?TKm9#8@F;@wR9z+9Q zcN_UUTbLVyO$_J4K%r1Vc)gl!NxCaFKW9ur-pA%eq&0*fDrR8!GMyqYoiN!}q)F

3|NIYhB1PL*0G`O$8mO`Y$^mVVC=|;y&hh#S(kAp zf>s@Xg5|~ep7e@g*Tw#_Jh1&DxzPzRF$+K#B0JNyuN2NzwxCs3R>prHnmD5~Z?nBv zIO-GlNry@K*hRrwE!s3>biCbJ0cO(*bVBM2&s`OATWd90LWI(QUAEK3YR#mdM7+r? z$#Kt4vra(XZdcSz?S6UDjyffNWCf}c{~z^8K4;CNS8b?@o+y-fEyN|;CjAPP*dCe~ zi{q1sOS}~Gc!8viUS$dglk=De`ZI@9R6RI&WM>DH-_~Z8QUy6YP9DNcEHElrH?P1H zY|3!=Y~rIlBC(Jccl%=b%e-+}ovCgv?9i|e-r+pAGHD~K)h_zlqx;fkwN5DOroe-{ z@c~+O&ziJUBq?iu#f3y+=_$b#xz0+b&wLGbg}uk&*mDCRjN)TojzSV={z%6-Y^nKV zk5*pv?<=;W4H%4HXxg|up}UoLXwp~4e|D9)SoLcmggmj&Fqk)`R-ntPZ{(%fspNkZ znk30GkpN6EowNs2h7PB45)ul5XLpOkj&Aix>!4w>PjDltklskq5t5u%yqLN`!Oigj zGnMl1DjkJ;uP9oN*$AB~s=GOK62c0*&CF8WzCs%%Ieg<^Ir@?%VXB8_!D9a4TfROK zc->MT>{h!3Zz4W{R$spRG+!x`DjcqRrD|`_n+h-d$Z~(mA~fyxoQ!h;G{#e!-$w633a2y%pbt4u!uFqt^1>)l)d3Ocw2C z90MuTxWIOJRJCG5nb$~9t0I(}(X|0P*O#@_%Lt9viBsm})qQFEq-wF+?#fCwSXFN{ z=LvJ#ThsSrr-!2hG;oiw6A|r(k-7D6G2aTSxNqSGnkp+LH^m1vRJ5s!&YJJdVf|{5 zGL>mA^&h?V_%f;7?@7vd>j(ACA&?HIl43_r_kl7f_nzFxV{in$DU&A4=HF~66{)FOw5LJ>;fmEwneuX3bJ z^ZGqoQJ8EuHq9q37&df|ft>_?m$rQ)(l4jFCdZ zE6pe&meOEdSQ!=R${PRCYH}=mM-{eGnNOpiG$+(O&Nl;QL=`B*)LBLIDroqU65r!Q zJxKG!a@gy7jY6w7oS?d{M&n!7IUXg|kJpom3nGku&Q~igP6Nr2v8pYfLIWHKh#UtD zLMqbwe-oF5@A#)b=)%BaL4&hpVCX2@4sLTAq+d(xpInDkon5b0|w;LC2RzbSco z#EaSQSK4^bYk5zD{;UMU$v_`^YkC-)&4g*>N1c2nU0|IQlCZ^T8c_r69a+b)Q=X*c zbwa(7xQtDhGp*l~zYJ`s`Zfsh2!MH-=<(nZ^d>JI+OgT#?aA6z2Qw47WY_bapIybs zy#0$GRPa52O`?bw0GEEXqc?nEZS(K-(zt~f2^&>_hfYzA292mLo zYFzSGi`#B{btVUkGBbN0g}%_Ht2*!KP(n>9KrS^!^KBHD!L*u3r%qY(!78{(Dqh}-b}0z$gx@?e)@BFWaE&fyVJV-H7Pnk*jlqpk}xvl2^YJ z5)q&blO?1|J$%rR@t~4N$BbD;MzA~%M1K;}RJkR%F3Dd#;>X=Rq7k7OiEY7n$B|HL z{xl$wq+R(m%q~fkR5W&s<7OsyY)@DMZ~cY+2r*cW4;=PeNEHQ=J;CB5=sqVJxw#e7 zO})7wR$%5O>aAo>El78qOK?u3mv|afwYkC+6&q^-xMOEDjLF(A%8AN!sN7Y2H1BI0S;j66acQ7nW#3jqn=%vTrlR{)>ANR-*bUjjom#QB$sP< z=^=LlpU27+o36zdM`_Juw7jwcVMWjd+bUs)2coT#H^zVxiO|dXd2ndct7_D*c$P4r zZJ>ni*3#A!fkqwZnQS$OY+fH?Y(}>AUCEiR&su$aVrfW9ljn4Km6eoUZ#_^c zU1hlAQT&AtbZIH@N=a1}!#?@CRVJj|J9{lLZQ_Aq%#%9if$p5?klOGJo(SR$ zQiw3oP+pg@U7dTJfn_2#G+R(6g6#Qgp|CM57!lMh)TBLpyze>qZO7y|S{KH!=z5~^B*7hj}Q zYUnf+#oALA7@j+nI5tojse0q)bT7R1lmlRI9gi@Y7WAC8^KBAcx{+7~$e}8=JOzAL zr;~F6cb;Z?mQP>@-KTUB z510%911-dN5sw>ieNi_ST5UB!pW2KhWRuZg|1 zZF3_uaqhkAm(gmHO#VQ8%{W^BSMMc6M){YL6=ZbW965zCic-z%z4pJDdhd9)zc*|= zs%WXw)@bc+TNjEN)f%O?*rTW|Xc050+0xRQtv!nvsS&YLIux}>NRVo6Vv7;uck=l@ zzvuPjul66w`@GLN_kCaYbzS!cU+{>p;^eHnOm!}@r-A9rqX<5_#3_wSrmDyI2e7R0+NldrV+ zrR(F`^fKvroI9|=qu^eL<>wZsA^tNQ&H(tSJ%=$2G(yZp16?QJfdOMTYi$qDQkq_3 z!MFhPdoi(hmr_T&qgXV){H|0R`(k&Vx!(i8NU)wjsC&#dn9j{3A&{pO4{F%$h)3HQ z>bbT4EJxx*c}I|`a+Gdu=1INVm(d4|!2CFOtvQ{kn-V7r1yVV!24zx`BXyX*yqSxK z=jOMUeST-vKQLnia!-s~+n$}){o2ci{7x zauH&p+Sv*t9xof4l*_R{ZsCag8+>i_EYIZuXRO#yN^-V6Lq7ag$)6>)VnJJ?Q z&4)!BC0HM^&6t#wI+v$N$n^^djH&c*Z}xPykDV8jS5ibWz*}RR>2Ct>w~|gmyo6b` zkmqhrzitwFhCf4pMle%zA%_M&!+dwCEITR5q^JRk|AJzTVZ6)8gs2J5Y(#bHGTz-Y ze$jAPYr%O>|Lc?T-J?L~N~W9L<|fkwshL z*OEvMYS1SRP1p|8qRKFe;*(C5i}A72btzAA!Lgo(HK2}&X4YPI+q*7jq0Tt(#Q0cf z{4bsPmJg6gOlcxnxBskeSVR_^RGc4XMKx!&sU!Ic=hSlx$e)#xb~ejgjE-IvdnN;L z3Qb+@&v$FS`J(8?x*fY6qRR1rIZE5<^P z&CJgY<_h-agH3GBpYYt8`@Fo(C(uJP0kJ#X@W&&uclSEJzqtSd9Yl^;w%2J}ZH_6K zS?a@r5p)uxc|<5kt-h)x!)=>|^&?k(G|M-wOzOS@)phat;gfWETlfmkB&#LDl4J`| zVbkS3R>Vw!rkIe+ry`A~E~(P4v&SPn#wT-P2Re4IL?amJUMIAiViF4S?uc~UZ_$1U#1+r< z)k}mX;dyHYj|l#ki@y3Z$_}6Wgj}i_Fj$g@zTTLBu*o0vJ2In1#-V`8sKh=?8QO5{ zL2Pj8-`PG_(yCpptq!tVp#K3SVV)A^?wzon)ntFIOpumO6@!eSyj_O#B#~JBhXSG| zuj|irc2F?>nXIH-ig!HnNPPHB%|Qpd{zl~vD)K`ZJLoT0Zf$uR*FU<<6v_Cw^+b7* zKgiTMVhtr-{=Vm{aA9NB-jXZTkVBI5J!6B_ns3>a=`A&F_FnQxmg{uR#GMJq+6sCj z{2o2i8&59BO7F|%XPcteV{3Gi1m_LcwytnK7(j$v=;eob1$D8hbM5@N1O23N>0VB4 zcb3|cn4irXt@`Dr8}SS1(LwKaG1HXezUm6gY}bC@1^<-eHS03(!&IE(^-?1OxS$(+ zShHMCJXNX4ODML_3{yR}sP92{8!XlPGg-U7RGftKCm|;1;Z|L8A?((_4K8ZZ2vy&w z;5yN0iXP!X$lP8JbZ$q7C@Vb?5G@xXkyIFCBpa_a!w{~`3~i#;y|#4JA~n~MmZpg0 zJ8l7PD82hGIIj?-Ge(%L8o!#h9W=+fvs742tKfvQn2aN%Xt z6FgHGa~Ua{|H=iLqxUPXp#eYP(r1>~#;LEX%UTT>9g}m(%U=MomOg^}@MzH&TK;RR zvHYu@=(@5VC@{QH1|Rwo#4_gh^wEOo=UYfM^o>Z@;e9=dwx*`nLs2L)#t^}bvIlIiQQpnryyr`Ch$yaX=n7i> zFIqxhQjj@92Y3?D2`iVB{pF84A6absCU~_OspnG809K7pWIRvf0b_3Qeta;I9sb6l z)F@@N5V!#Hm0Ivb%kn72zpl)CPT-dfj9*(jG%<6^f$WH{zSd?*vi`gx+N&9zAG&v~Tx6hzZ)w zu*p`pLBzzVm^a7eY5-^dk1pUc%{-yTc)sLLqS|F4y4P&l`fKwaqBj=lVw#YezT+wX zgtba$GDmO$lI0|C>{krz(6g*f(=_qs*f4IUZgV%$qd5d6TzR~s0u{`R57P+=7XC(8 z&Q=i6A@Q_uQGaKTFS^H)qU$OzhI`>-#i+4RhZLAW;|3ejcH}vaVpgy!)N9q?zgl?R z*upL_rP-Z9nm<4@ndE5woC1C7G3da=`R4TLl=rM2Ap2|hKLCbfXpyXP48tBn-aQk9 zASsruU;xg@_ub{b@aA{F^#9$aPE=^)lp15!ysrVaXmYh#`F;PWnLF??TVAn#>N}PG z==6GyLi5k1dPAR^XkD207wzQFY@LI>W)>D1l)Vdw4^(Ztntt9hdQ*~X&!`5@`!9No zL07ZxTp(=wpd=yLxLbG#kq;BPIbBD?)v%am1teF@j>1r=BU)`Rd>RY}WGb8KtGpj+TDN<2azSD&~lM z{SPfM@TZm@$#R`4w^sRKd!H(eO_{`qK=WD8v3d3v5JMs@wi@}hXoMp3RzAsu>l$*e zA?2t|R0OZfeT@(gwzz=;BmaGWgGM6(qmr0}&$@y^1&sPf(1PcaZ7+OUS{6nY+&6GT za7NKL$fwji)b(`=o%l{Idu07l?elucy^Cj*YNq~YJf%km(JR~x&0qdPRCI>ME1rL8 z-dwl)cCzDVXt{~57*YQk-$ziY5hmd9>G}oHYOHn0ez=uW;UlL0>TH8`$Jr| zGCYM!Nl4XmZOUHJ17CWz~m2CUCs7Hty{+FE}Myf3=&dD-|3SM z7#m1~A16>QR1Gg+Q(6Ve(^+oGrGw^*nVV`J@Pu6+0j_j5HkWgYr9RIY_f{W8B_$=@ zYp4kGJz`7h>@5Q07N{R8Ft4XMoDZtcv_@=5Hv|03%jk*ZbXUc6$*zX8@;!9Ltc`5J zW+n}zG13Qv@a0k@=0T-vll_?o!xb_Mjqv9|inI{#j01K#(VLlA!s|0!uZuJyFk>jQI=0-!B3v82C|xUu}>;GZBZ$oKo_E<*I`0}!vYz<7ymw6b0rUZmij z>xd|4neHtOu~ggKm*9OTyAwUAyb8dRj-dj^Kp9fE_%eWWYKJ(HraR=fllDjuAgOyJ zOHH_}|2k!mdsKIMrQf=O8n23r6#a5d3Gy2~ccu1{(gi`V?>wWZQ17^??i4Omu6mND=fP4E3QCoKeGN_ynVLis1 zLi2s+Y{hsAgA zBWC$y02EiWUHtD0Pw`S8@Tsm`(<5dTf9fu!7~Cz@qJf;9$k-8vfvhQIT)rpNvk($4 z?EjWqy5id-TJUrlE0Z0cGcJ07ME}fddeFaY&cfa4b_L{!rMLsj;5FYpa$6hSN>ktZ z#>R#lh*vh}K2qZ+L_nYF&h@xCzEr`7v}X40>Tz&XN&uu!dq~xT3%12NYp9}PxPG1I zyZ(Kbw)a^nU`DZ?>cg(Kwl=&}z&`IvG2_FfE)7yEai-qIsH3AJDz0cXyoH}p-9P!q ze-EVe4}=X!-ej9kEJ@e$zMn-V%6GZEs)%Uq1k||DrWY9Im5DKFpW6Z!LS;FS1fbg> zpBJ~i&I3vt7R^<{Ffb;#Es%E7h!%{W#P*U%2VOrLrE;gX_M_4kZO6vO(5)8#eNo?i zRggaEq5S?SF6%y(+oqQjml@_r;TQ%6*G0!t5G8^>x>(5iowR_3zgR_+RKV0v*QKJh zls2HTTett)mnHSDn-LUDSekyNhd+U2RGO~GL&uj0-NffUV{40VkpL=mPtT~E z3o6MQH%vz6cY?_;c=T$PNYNi<{ORG%nC>L2P?p-WL@=iSv;ANUB z2I5Rhxn`>NiTWbdi->x3;^8IZfav#7Y%42GuD#hoAgIJ_3UpY+?%qvATK)HQ_rk#R zM*Q&2bSVP$KAl>Wq_2tQr69}d4<6|;!;YT}bI?L+-sLej!aCnHpOO)9D={+!j5Akz zww3VyBiQ!6&?LNUrMj)g)H>YRHmRv@ra1?D`~L_k5T}cP1_cDu zox*|S`nlyX?C)ycWb3mg*KS-J^*vfT-__aF*0*2Lw9jy|F9>--?vvJvrAM$W#;;2& z+qOETx0aUzAL(Ja&K5cUJ~af}*iDUL5velAB^%9rH!rbPG`Z+~7_b#KnJIQ+d{FE% z1Vn%4@PIrTr%&}dY@=k-OaaaH=ZJD=@2i!ANXi#V3YED(2MkoM$JT&Qs)w@W#Wfu-gBwMIL{T4*LE*iN94ez zMA(x1#9G1O)`4wlU{*mJs*#&Dj{2+4$80?I`Y)(TEku@s=`LoiRG=KVI7R)Mg1$=w z;^85*CLQ&Sm3;mtJ4VOi1Dx!iRT;1j19{le6uS5#vd=V>2;r0 z;bkYHS`jB8W)7|R%nC6M)(XQ#Y%BWrh12khS~9mM0Xgzw=p)}9OUc$J zX7eg3K)Y`m5YR9)H%E1yfIy1l0Z1T~uc50InfIVqLAqD?5Wh@QzA%0CjmrWEYU19m z^1q}sB~r4VgR`Z#W|eH8r4ChyK!Lug^eNtw)>lrKpnOpMCV=HK6)uL&j?HD2N_#l1rV&#yZ5(?KMk#jU4HdYx8|K@ zd}B`k45L~kS4;vEL%cLFxa)kD`0Xh_NQkOej(Xy!W9^^aEH#O zQ@-;cRa9;vh&Qw|KrQ{>_k{@n>wxZJl`KWN9C3{|)frPS;1f??z-LasklGV@0Vm&n zVFXhm?3o=Wjt_BZuiyeGCm=(GE)q5UkM3{c=RvR0q~L$w)D3#7AWjVD<%PF|fJOt@ zKkf}9UESSi1;l=xt746KmbE|tAYt{*8eY->@O2EMYL~FcqtYQ-9wdLEPUZKC=CbQG zU_h?>EpTak+~mj4Uv8qZe2_f-`g+&#ZF(+6;2Lyl0nUtiV#18`lp-UP;XCD;MPA}C z@I`WTvJB7;yy<-xn2iqlSh=_$8?k_`+11f;yCw^a@(jdm3>@d$ z=VRPx>r%wzS3e^6#RGnB-uXI(5_0|rQ>lOaETg#%|7!U0AJz|D!fd>agF|ejtqQ8IZK>O33AI+RqfU2o* z>%?Or0P30zFU!Oe?C9cgpD+h^tApja`97|_3pZ0%ZpuAeCSr+X{`Et!`+iZt|g-nD>X+mOB}!Tf}I8jPkh1&B$*tefMobF zEz4N4@$pwJ1CMNnSgU{^eNsj(l$Pf8S%S~!c&T99%4g$W4M-hc!SW@WLeDwuPT3fq!oSv{qR|dPIkDGWv?LNxyX2{kREN);g6;PNphof>R7bv$mlz13r8pGW52*is8N)aUP*K2 zgTL1_wO3%#i^aP~QY5f*hQGDA{@^~E;(kCWLg;UonAbXQ-rx>AaIV;%ENr)a_QtYA zD)g7{W;ezJPJSol`KO;gq7=9l1);j5kMME71_})_wsjUA!uQEF(^i&cnsfK%{QBH* zle9+llu(3GJ#GZiKtPt3idh&M8rBh#lGtL67}bP!3w55Vy37=xeiVS;0>bWPk4vF9 z$|OY4g_<#>J?wz0MA~x)hX$M%^KS73BdeIGJBbTrGj~#)_FK|5-hO7;u<)K{&4Af+Aehv3!yk!cN+uy(KzxQn4rM z#_(^ia&k~tBZdCElpzp)j2Tmgo}vy&GL2OQ-&eA?T{YF!Z`H(AWXef591JB6igE}F z_$;h*Har1Aro;Vrb4Rexuo(U0MC=3U-lL;g#UR=VgXPY$r?hQa9Yqw;dbJGZmF^H7 zJRYYXNMLD^?8A3%dLUeSv4_rm_NV1#2|tRqFnaCR&G9*pmxi0ymp&Xal#+=2P<(o+ zh}+75j$8Z6VN~rLH15q1fDF|V8htjJE0)n)!4qeczNIu-u_cop+GW!FZkZ`K_V5q| z>}qNHA79SGikkwb*5n6!8w}*{y+64i-q$8EWqP0wN|gwlCL>oe=KFfbO{bU+as`QB+a`NbxD!hg{gR(v}ruZ%0l0!{+E(+l()Cu zzClR=6R0aeK&1TRKYmt}b;R8DJHysh6Gy;@wKI!h0(aa4w`Ww0z=Z@DH-Ez~E1dys zot)te-<2`)ve#yqQ5?QywTr^2mWgQ#vaj!JY@C$k=rSWp&9>>) z`d^q5%y~ESoappgVQ&wMo_zDB;+l{4S)yG;cHX;2*oetw#%opMY=3VO z`qtT&gI8J#bN3%@%3JKlS(3{y!=HvIWQ6@{qonk|*%3qhvo6YXH`cCi>w^P@HZ{e8 zA|y#?($|+fMrjJu4=i4EYmr+&Rxhus1;e_GJ!;=x{pZ#VuU={~+g#8o$0AbqKD!VG zuJ`P3#rV<`mz9P*o4~kNen7ak=^fU3)ViV$Umfm#PKW)T*Q19x;gegWISiv3d{-yw zBhslHIAAa|9x?yYJ9`CA!q7|BPxi<&kTyFJD*s)8|xY#W)?CoN5`q zw4J!-!y^vLp;i$$B!YGla}rX+pvn)aVVucP*gwc&l9HURyD+$1VH!_3Za#`>*4-`0 zRB(vcUIf4BN#Kq#VU{#Jl5Z|S*+yV%`H2U1)#c`8fsS6Joq!coO$kN^{Hy8?$`j+1 zg_IvQswdbQDYI1XuDqcC9z*arE}@x1{&zbOhWiw1S7o1dY5Lx4=vh}IS6MZzF?xP! zz#An&r5Z>#X98VTt)=$WV_m0vNkql6FAP?u9;@zURf~%fsLO#n%eF+W;JVDc;cv^_ z?br9n=lDXZB?ZJkaB;}8O+LdKi-{z>Khk!kYn8y{QC97b&57g-U2CPJ z0E9#dP`zSFa?gy&V-E>vjBLR+_BPo~nlx@YJRi`Apva9DVpqGHG~Igs#hc@CJzsLe zqej=PPQy*GSC^~H(@86VtJUp%h|%-s&!5SqOq2#9Xww-)jhNMAs)-hpg8=?P0eTjW z%t*?gpXi+!`ly1*;<8f4Ddu$$6j%lfF zFSwiji>tVhu_$OY%pxJm#?;i#K#~dQ9{}er0|w?fDgctAEIc%xDX9;G#xfQhx=-i< zvVIA#bq=$=>vE-x&VQNLsR=PoI4GIg9xlWkrl|fXF23ijgrZNC-`vsSh>6FLDy`Wn z(4K#oZ?)@#*((LtY-wr!(Zey9jz`@gi{|xJ*Yd*dAio!Q#@~RFT%B{eu!{zEtZ$Wv_E+y3l=}u5cQuE+nFt!|kUDZz<6bnNJV5DFmE-_%&(o%dL>FHN z^H}a9mQBg6fg)i>9~=H8tP_(ir%u1a2%1d0Ko>u(z3(E9MtP|xbE?O#ZNY5oX61OAe-5n>rj#(AUp4S%t} zcA(my&h{RBKHOixkfz%DO4EOaftq3rNXH#Sj6E)cBpDL=Q57Jb(FM)QdIP1#Veb?j z6U2h+`@}zb`#0Oq>Fl>0l3y{9j!dzDqr@s>1Zu~NmYd$K%8hkQlMbZ7}jP^}X?g`1tfeidU_pqLF| zOJ{$(WWBIV)XvAN&;X*l(Z+(6u{`6~RKVX+F^qkB%&1fTVlu#TTNt7Z@Ns~PiQc_C znD@czo8#|~HcB-Hf7DvDt>v3LsU8*N_7X?D9>PxUJ8TAt835yjgw24r0R9I<=%q z^{L2sHrdXep0oaP%o;!|-aL5_78WKOzRp};L=z-&@jbw*YncjilERF*=J^$agPK!9 zjwq)hIh!_EEL76Af-Nl}Ad6ZnjM;bz=4#xtMYb-We>0J59CWL{eCca85>}T5qM{vq zX$m5M7pDFC-uOc0{Owv*Ftf?c(!e&Po7YZBP4B+2BE_4sNgTmT?ld_7r%ZHgd%;f& zrA3f9z}xdZ@Sl5;%f2#2W0$_ggDUztVN2z{)7Q|eWmQ$33Kq=`JtiMhTqi&F=Zl_q zcJt_{lD4?$vb`v2RF6&las6|e&pS*V-{Df3c{4?$c-qLSa|k8Vy7s4Dwm)KI zbFWIU6~1yM1^)g1#$CXCDd2JuAZgYCCdutU@-iOb++vK-Xcg)<_@e=2w*BK|11s)k z^|Pl6wn+{@_*bPM)@JoDRUStGHb5cnNn}bBPN{i?F5l<{qm1O^cwfLQ*q#-$ZfTNI zM*=3b7UQ#pIzSTaq?q@o5O-Q`J|B%3s}Wc6+gpA5&Bi9p*iIvuwW|m*xcz7YGbWWoF(OKOq*;FQk7W8l6RHSOL1lQ~4xjOuBZ)s| z!@{p)huh+FjQ(IqhO_k1TEL@0E35imDd=NzdP+NAe}^h>d-iR}>*s~Qvsc5`@sW1` zc{P1`qhHNTIX>#xYKJVA{$O9Qac%m@=wM}z{5?U(tve-?qo=9!O0E%c&Ew4+RIXnD z9Wrx)*(7jEhp4Td3$PXwNa)v)Xn>XCJ$%_K z(1GIe6&*f_0X~(nIt#0x6RLROb4`-9?p@+cYRK7w)(xO4p_;5FE){|Hj5*yqLw4a& zsmah5m0WUOshw%|zsl#6=eZP#$;iF4^IJ-o3_xzjTfxfi^q$%q+XPk6I zj8h&zRZ@K=7^%12Kp1uX#HV8iJxF5=^S3dGL~ZROaW1HsBw-DqFI?_6RkLeH;*d(g zTLRl%^&W&z*4$2sy)u(={A~4D+y?aqj%FfOQf+x%#bvXoD=!08ZlFwB{i(40PfnnV2F3AFpa)tV6w zTs78bokR#4?2JDK)d(EL`)RyG-Vs90nADR5iAKZT_1&3rrEcq8k>s(W^yL^=_o@`X zgB|QkXkN?9zpvke27IYG>)ZVvj6@|y)5xsOIku%QKW_DJ`kB|xREN9&{JoVZrKeTa ze?A+NZ-K*UTLT|`!@HF|upEm;k3~$#4diW&=;r`Uo_ib)$j4K5h zgwJq&F}~R8np`CO6mPZJ^ePy-u{HvG8)o3LSzs5KT)KtE&-+sbzP2D$gkC3u?qqF0 zn~SC(bJh|M`dA&6kTBky2o_#W0>VD6X37n-cZwdbbvvV|4~v+P<#_^Z68}fE<$_ta|{s1 z#uD*POetmPsYm;xDvmrbFAsiA0mj!a0eG)x-lQUdU3Pcu^>2e4u6)r-#|(+{-*u_E ze(gJ9pwMHKT0JgGx-K_)_0$&d@gCD``ftvT9klt^Hm-ge+2+PHXz0MoH}#0#gR_!4 zgys6)PmDwQ4;f#>n(m&;c|w32fqFoTMZM(Y?7#S}<0IgHb>Drlp-8Sa0!nW2s;6K7wN8=`@pxbJ+)5t65 z7oXMBk4pAcJcL89>aD3`7*9C;A-ZBX86!`!Md%Z5lG=e)BPpv!al)8gc-1eB?ary| z&vIZ*?H8HZzKY_%wBOO0-ll&K%w5pQ%WZE$SiL}XD)n;u7ams`=O;g~1P6TDK*TUx z2kH$VOF54aFA1ax2~gePC$@efyUBC7kuk}gpg+p`){2$bcgOgC_(6_B%BaYLFjbdC z%x*a|`Dp(oXB3zBm+7N5hJ>{D3(7jeWJORpy)rJdy>OTU-0u`jlGyOCUh{@L9edat9i6X_*NS6O4RRKgh3;{$v_ z->pceAyxc`v{6Aieo$W8zWdD;LLaX+K)+N=E})HGm3}6d;>9v;~tfKpVs@Me)&2y2+Z6xHT_grIBfAvIH>@6O$$A@ zNlZ01EzG3}j?5TB>a-8ZBBh2|}S39oys===k)-D=KgK0*Zv1`^bhXx27FtT@)P9qyeBqSQB~>!%uSq}oaU;k zsxbB&k$Fvs;)LiMFjTD`^=kjhq$xC118h7o4?L~8=E+DUe~M9^MlM77RWmipruEH> zu%aiIQBEZs*AW5URRb}!^f^)ZZ`ZG1H@&tNmK{KHbw7o^&G>c^ZI1Fs{=xMvVRrBf z(Ct`Ie}v9%hUw!hf|N;3z9a6{U~ED|&QO$?9BgJ$thU)D8)`@@_u_tQJXHb;Owc}RL$jqiMh5{1aIi8`IY^M(+m{KO&6UBN{fm*MV7S*gY<+Z?y zQh`;ONLB9qTOW7uNSu2l$mEM$4Dp!brAnNO&XRfoRvgF~%%YLfdab7+p;3rhpX!vjA6CBhTEgAMT%{BXuo?Kq!X}EVv7pr zO_=|yyp}eJmaVEtZu!~U`D$RN^%r=z2Mep_j^rhj*G_H98+nqRaDZLpoq1Vp>rCUb zB>HqFCMHXj3z6C0itp*yC9T8BE~g7&Z2F8me{fAyIe1Poref9^fjZ2j--JHVfaY~# zPf4F#(WDW9p_Ed55;P9B#SHRcL6cI}y(h$O(&x@k9bw zDTrq=o4&3I%^Jq#@GMmwB4@9@#-TG|wrN|WQ4C1(ZFaCaiPcGW# zGBc+1Ls~vZ3G(C!tv%pM0Hn+?8phL)4VdIZ!Y?$MT(Ws8V2f7Kly9C~@aZi*188TQ zg6xq+Te4g*=oWZ{(AqU>X1MWvy#i`k&{yw1i5_#9q-b)+onW2tGiFr^-~aAgB?eqo zUI|RB4`^Sqm*@!@;Aq~8$prlYcdMfNu9A&NVX?~!t#|`-1L7(cJlsM!Lx^`Vz$b?sR5&a?0?_zE)-?!+kU{MCw-b!|vjU(Mj7<||0# z*)(MB`HqCZ?_;$S44_W}iTLn2EQ=5N5?N7k{4>I;(M*3qdrA<7!nr};Y~Z^W{9cJ^ zap${)fag&%S6}Rpq4j`GciiO1ut@XPR1{g5IUW`NYcK(DsMgFd{PD|-=Blch;f!9s z{vRYYiWT|cH;PZT83zAfRg+q=UZh%hJ23 z=p=8PDbsi7Zd@&cwWWsyYPYOoJAQF+Vt`@C-E(h*mm-=0=zr>`)%K$EluzGyT(#9= z2?HZU{xf_~50p77*26Y1$hYs45mjVK;n(g!BmfWxwb?p<1`GK6AMjFdD zwRRZb);MZ6v*MyT&*zvfjD&Tkggdn4{>r75ttUieIe0XM^oj2UaGLAE`{L&9YW>qa z8Vl}Yx{LqG?$s_$$5k#L(yka$`h(fOBe!_}y)Muu!-(YcPL}_-^o;Gh-dm^WMJS$be+f4N+@)UMnWmGHSHMrmJPo;jM-^N7h zvV}Gz1fiY;@SeipZq)F$5W(^}iNtsNkIS+&{Q4U}W@$Kxxov6bxiCs2IaSe~x?H`4 z9qy*fWqU3g=y$Vp+#Hr4zvQ+q|JUNRkhpjcUCx01Z()R8;vUChew zK{#fw*9_6-@#LR_q}}_XlTkit0b|MvY_k##8aQ%Q&tQIwGEI45m~m*ocgI-9<*#px zhj`}%BYdT-Dk8!Uz_$HGLA?)wtHDv>*Zu&u_YFSEfOg>f;$xMKi_D@>X`&t2u2W9H`O8aH*-HEqhbE+WO# z5=MW-C{Ds4zY`MoM?tev^!oK5tlXWQolfkhAWA3y$^RbZ=*d1OB4lcl8Eu9C^Ahzg z%MT!)6p_xeL6s|$IfUT~%#jl5@HBRE!9APO-V)HoKi-6CC5^Xa6J1-s`@GqaPg$+M z!g_Tu-1yxPoLY2(P>pj6usq2M3TIQ{!bUumzM zY;nKQeV*Gx^qPp(+Tsb(Mc91%B7@)zhQR( z>5|F=yfSPY$GiC1Gk?8iEF`$2fmv}dPh~E@#kq^~xDt4vHly-(e4c}S3-y9%UIKg>6+mUQg z;fe9et~jl>z2YKuYtrqv4V3ITd4}>+TGe!bvwZFRg}>poKT6BSZOvD0c8w1Ozc*vJhXQa<6{ugso)Z=w61gh1g#7YTu3Gujd4iF~{1nVEX&wHj+g z=BKe1+%TjKmy^_55yoT707N6;)!`P0U6(;yTXY5~1S6|@=bhzl>OlpTeBzU%m6&zOG?=}MRWQ}0XOS_eL7yz5}*bQAg3_P&k z;LESeV+;ZKS_NWW5!vwqn6u~tF7r!gyKPQelB%W3^1LVIJ4fnF@PQ1cjaiRxTAff zW_StrZ5e>bW^8Y{eFP34Y6MT#v@J8`2fFGx7ln;I0VK5(cW1J3MLU!q3Cj zv5FY=Y6LFWT(9<<+2HGkA1*<5fL`|w)%`s(ZR^Qnt-NPRZTgc43Bf{P-N^#jA;CuI zWMS0`^6ZbBmuT)i-+k>JxZ6r$u6z_Cl8}&ahU9v%yDnb0tdnaGjRi;W6!bn^w*J_c z#mpkxMyta2$9#py>LswpUyXOj5bi-0`_; zIqjZjIg*d+#7J9mL{t2XP|}dpW`Mj^Xx^p^QU0JT()=+WD`qvyL2?8KKP4^AjDp4~ za{{vU0Cn5TZtrO)F2N?PV2(Vvv3Hl_HYWH!@i?Y;mcr&kdw>9%Mw9zFeED3ao57EV zoH>k~nP<6I0^jz6)QdWMBDUDl99QmIRy9x-IG2`k-xdDx(1WRz4UDHi8YCxI4l|ww zgV1yv?69t|$VXnC?8&;69^ZHmhUnc+ID1mgD-LkjI?+#t^4-ktqt>mcP%ul{OYz zTs8l#`cAR&N1;60T7rk#DQu`X9Jvi2{-kD}@gr-+QnvotsE;G)H3dtcPp%7 zB_7|T`{P72@Pf^o9M%h(G_`;cW~_qzZ^kX;%7>rJf6wcSRcHn!F0}v&dFh$$-2{Zx zDnEr(AF^DXYE1Iol!h8oS|&li8BH|uI9vTJX|)ncTD8x1!@K>@-BRq%X3wRRpe^0O z``JxsNP2fO8CF+cIQCAaFVjg_n-zbwFHbG`nXow*3te|Ki|D z^w?^}gMPYiV0Mv%pIJlcwTSs5NQSb^{6$6;>J(P=uz`}+lpsPLwAi{jJM+q~19s~D z#f|eg^n$M8_oYl1Ku(f^^oJj@L(Cp0XYvJZ?NBe?bpKU^)MiRH6(==uy?8eusXJ@4 z4qX(!v;tVCB4wK|uu@Cs`i!21)bmKRAZ%3`4Z;7ypT$_y5HeNs{Twa``J>O~z+6N~tV95|1*R3>(0zz#BPJE%);r(>-=(H3UENb((x z<4qPHAucf7*UJlDaqx8! zqft9LlKHhix(gQn0y3QX#VZ^`D334Sg6M^VG|nh@NPmHqf)qjuKkn|ynG9|Lz)%?smN$RBTTLkM0Vu8x*OL^KGyk_c$8 za=n>ze@=TmXp@wl;Ta3iCnTPBy{ByR$=SWY%C8HX9Ym?l)+f(llU-^IOsW$-_-zOV z{66_xZGRIt`5RpfBD1%XUbck%lzb8i-L^Dm3;lOP$A8E&j!Q-vEP|3?{c=o8#X}+8 za6S0S&$RS1d6&s1f0eVUrt{yqK5IXpO6t#7YqT>}`ax!zrsogjK~Tu-2iZIFGIl@D zaK5inN~haArA`AmlWjvUot~kel4ugteKfV7X0H}ogQ814%hzEP5LNTHRMaxaJtE5# z{?ylsuP{|n202N}ySJTb$F*Oo5wM5-T! zu&~5b`BBAdFKZ){cZuO999A*+Da3XRC#%Ivf}FU1#N0)j4>yf>&Hr@NMsu>Jz1*=> zoY^J+JO~8^7zDDG$?dNGqVB8!%Wj2_*b3y zB+oz5=*xK`8l7BjQLhh5)EED@-G1|dl@-u@&4g>cDue%!QXVn-C9#$u6=}L#l0a#& zSN_;gd)7F%A?t_N1YK@R&p-^S+G}S4v9dmy3V(NXsL(!w{+dd|*JQNb*byoyp(H7r zOb3ww7fNRYT6XWsu)AcQh;gblNSPtKRu(h2NL_!dfyKVAp6$QC-aRrT4c;5bQ&LjB zCfo^6T;l|JLCFExeeu z#CQM96VpiKO1l;HL?&fZkt8wNMx&SAhVaH*Y|Oyo(7-!fmrPUFrpbkq0)DrE+~kwz zJH27ek&9@zJ%-30y;?gX6dy@-dw8?87?@P+9{tU`k_5k}`67Am#mUfB*jRSS=i3Je z+KgX67eIllC~d-a>i^^Ey~C;g|Nrrmh*D{A#K|a)W2YR7L<(iEgJUM!F_Jxxl!jSm zk-d*`a;%JFh9Y|$4#y$cGkYGt$9cU!-{1M?xLlXZ^Z6L}al75__q!1M&ly+m)=`vP z+aRhbI-EyP7`^aMnO6QCD`!z?IQZaAy;Yh7`f-W15FgUlO4snOKD#tBm*^}(E4+n-v@3d&m^2`}-mP;Cy`PKzO}196Fo$}fGNL7~ zO_5Etp+#%lO%WWqj^Ij*Gc&NGAx1S`#nn#7_*)i0x2KS2lT+z@XZdfI*cNKN`pIq7 z`Ksf(z-!2O-T$*bX>Tt49w}?d?ell-sr8pGG$t5=i0`g=czE};I7QF&cwjt?%+cJ+ zBlmEb+IN>I!pamUVv;Zta|iH&ej_z}8wFxm_!$GE3MU!6;z`fh?kn359Kuk%`1;cp z8$r>YHOUN_i-hFQpP$HqSBjC|mL?o;7~!-^%iUTcos@eq5&aNi^}IDA39BFET`e7Q zE*DQEST$nbJF z?+(ZlH0=lXbfe1Q>m4oO3VSD-TILE3r$z>I3Hw{<^+D%#;p*)JICzZmgu(aSgU7$n z1+G0i<36a%nELFIGt8TGOG}{y3U@9+K6HEn4OuG^wfosF9pyaL7R!mSkD>cSh=9gC zwEeby01m@I=F^Lkrp_C)J@lC%cmzF0NDB9SiAf%HuS^8+p*;>zn)3D8+=CxQZY0tU+r0Vs;{CG_zcYERmu&{yk;L;hnXaSO? zaa6(~lk{~!sN(4_9u&My`f68@21BrH&4NRh_ zgwQoaz=0R=3pgEZZIIE7GwWGuE)7AgEVBiLZdY|5dSp-KqR216JEhIX%GA9cNtvwV z&VJ3Iy(yrr-{lkh^j@<6{?S$Klf@IH?{|#cCmT1~Zhl!_cpd8+(|zst(h=UqgpknM zq_vcInIcIl3Fzy*JoP3|_3!23tg2Yg>Q*M+@BeL}#94qiz%mLPvAN+|7AyV=!2cr^ z?!CPBNbtdKN}JKr9s9Xai9*n(@S82?#XRACJFx8!wyZ1#i(Yd0E1#lI8~T2i2#(|_ zSl3jfb?4VFzGP|b6B6@>qKs)>r9nc zG+0ZkLXDNs&9*juww?o0qvzVerLkI0EE}tqQR!56E%fegA#w88#tXWM$L^>;9%aKRsO>Fts4Q>? z$Fc-ET)>usk6J(U1=P z-v9GF$XOel+o?jEwgw82Q!|d?oH9P8=r8|n>SU|B#6uVFk}HS56A}>Us`f0Ec!7KO zP-%hX@UK4=7lxmAXnpwbVL3`H6mstK&gqNPpV>8Twj=WBin^TDJ$8Xhmd<9G9)YGloOL|4g!syA>ej zF@pNj<#%>NfvBUhT_?O{9sd@-5)ge;Ll3@Mu7Fx)xciA9D&ah~IK~G}1>OcO_*&q$^t99R$4zo)u?`z1YO z%3Q@T?t%p${dhn4x68gQyGXA_!xW(%i-PlcaEH<4V&3-%C5CF?NG^ml@}r^+w1R@c zv1>Lj)LJqk>TC__v(4U?l)>Gm#>_*lM+e7+w9BhES0;JJBr{+^q%v;* z-vzkC0RCtDD^*0^dH&QIRBo%hB9LRVN*oyP z%eBwDfQ~W!Ehv_U1mfMcO)$CxJnVuqKZ~NvX@=|A(@*ogx3!mGO194`l;{1IyJQn9 z_U)2PByh0hqLEtf%_D_OBQwIw&mrkPvA3@Oc$??s(6c4!v3$?SY~UFwJup>~_S}AT z7D^vT>8dV?*$!qZXrpt?fh%11KNn%{OCW)jQA0nrUpUsN1@UW_{|s%RZ;M7;MukQq z*oQCOtyWc4{q6W*&9g80>oVtifjz$^Dxo3wkN8!T=Fbt%DT4nk{7h?*CkX36Wq#V* zF5zQGnxa=8zQ(QK3fylVy?!H7cy(iXUI;YCl+V{LF*cYhM95;GLs{-`B$j^;wj>R6 zu7*C5DOvoSo=^4jWxiXM3oBx&l?pIoemblzxixccpm|2IN^_txoKJj1Uu%B!cB4t% z0x^~>!K^#%sNUS^-@SQ!)Z*B=8kz?NhS>wFu>Pk);Y*ab+OR(g%?hC;JXq&2abMc> z`6r8Gg7~G`70f*PL~f;r)LI_RD*aM(@EvoyG`>7qBtk7HIV zuaBD*RlN)(AwFmhX3uDl2Fu*voV8~4tF9ng+P6|KZ)$|}H}JK>GOJ1tc4xMaC%g0b zB^8d%Jobs;SvJfe`7YngGRidF{o$0jv@2yiAgFTE#XNccS5IfD1OM;!YL%|3PXBwH zBthjlj^LE)@a_`c0ku+vV-F)S5+_r23pVopng$cjQ+m-pS~SGYc%X|AazzdZ$Z;*niNswPTU_#?g_Ir>!35ez{{)wV9z9 zuAO>mKgVUhH}5q}LGtC_Ck=H&3wX<4Q5W9T0OaklpA(1F&gkvcp(lj%8P3GzrGFv0 z81rQxv=8Y^T=affcoiDTQv?#XqPbsckH=iQ;% zaDlL5$)zadm%!OSJN2B82PdcZ(VI>-~j-J8%8J zeayIgED#4Q)f8ujcIO4i&hL2{CGxC#y*`+!G9RS5L@INAm|I#ZUNL6qCsgyCZ=6)& zypoWyc>5e@M$L51UHy2ImuXLI38;{vauu z$d4ES`O8m2#o%REHSL>i_r9T!75B50QV!VpHUiHz0t|I=nt90AXfJ^l#B-4o4DR9!4d(4db%7_m1Cb;f9dY7OgI=2+ZezXph zE+sBs4w$(hwdY`LMZ)`cz?~?y!o;0OGEtC2mAnWEPbeAWwy+>M_!&7k6zo?$dUsZY z9^tucygA#`RA^M?mRDWtxnjzmzUJwaIo5sNi9VH~nr`Cj>m)+X;^sG~XrnzOP_tZ$QwH~xJ6Bb{Q!8J?{E z{z96MWDZDs9?m0c3i9+bxy4~1x<)*xpg+)ex@*6&BsKcCVz*^}_c$y?|N7=VGNx+@ zYjV>RH9Q=`#KImp-kRbD$X5Wm&b^!d-8PsMMj^T8pb? zR+#K9E6vv|^_~uvIpNFnZN2jY`K}|WLbGnqhiH@7oT?GZD3zEc=Z32=jP(dz$B=K! z9OlSqPX1o*-K_(o?;__YkN)4o#UGwsnY+oOpTv`_4=l};=xv!9ZS>4#_7G)NRb4&3 z@~!2O6=2+hXxv5C^M>p{5)ZzB@D=O7?@@Uy516k)V>OTr2g(sk--6x&Cn0_lUT|zw zU@!hfA871s!W>iV;tln~r?vs4$JkdFOx0n7LZ=mHQJVJu{xlnw*~g+I@lgJ1r-g#0 zo83QJn(aD6T{ky2<`V9?W@}Oxy;H<2-ukl8q#@MK#?VN0pT{$UJH}s9#xlP0RqJXk z)-GMfF8LvoqN0r9ZJ{q%&q-YZrP@CVgxg|D#jxmjk-h1}Z~>A1w^*Oe*$eORz*}Nw zdu}P`Z+B1A)k~Ih|8zU1nwlwe(2p~d6-MEI_&XMALRE{uMTg%mNewCfrlYJJGU6nx z1&!mBbovS_v1$F*+^Ag}GhG>3TIz2+R{5_>0UadHF{pKB$;XGU(i6vBgc297iaN&~V9~@Yd zs(HyeFtG*}f#qOtGLYeY|1Sq7_rd?LL-Bgdt9j6VDPHcoR*Zxrsy4{LGp1`+L-w{7W*VhdWqgyDWNco6$(2Au zc;i9SfnC+ z7%^0o5aWzV$Os$mz$Gt9lQAma#C;rD0~g z?V#-mk~@x2x8cQWKX*ac4_)l^T}+|YW4Ut4eS2u%I6BU=l-I8**~~Xt*h}dVU{xS= zUxK4(*Gz}IM#YgY{(GPN46atU?cH=@R_I|&|#?643o zmAz}p4UCG;XmZBn9`C9xB8w6Vzpi&751jYs!v1oHy#D|l*AVjhm8%}}1|f_3`74Ou z+sLQj@R#D>VF~A*Uxt}A4wN<9EmXC2?DF0uPpLD-RL%E!6)iQNn%jdhR;r+HubpVs zEEjra1LBH06b$u^ByJOdm2@iDDKcT8&mR_?&i}`8roV8L7IO5v+fq7%V}bvB)Ms-) zBR2mi(}csFRj;J55uL<0@I=?Zvgd&ro;T*KgWlGdd)uxHXhkzp@POc(Kk`ksdY?ZG zI8BSq(-xb7-88BDhox1&$*7N-2QBdGqzXF_Q%#G&k;Yr$p%sqc8qUlAqkjo+^IIA7 z1>4Qr-Hbe|Z>;+rTt(ez&I8*&6)#`L{G)72-8w{O)#0C@s<*h!mUbz%St(W5YYdSC z^L?l?+)~D!0P-Vqt(xRq1BvVsJJrmYl`prBa_G6p#*{07ZA;a|zVt2q; zo-;bFy|J#(O49lIWa=y&(&Cm9^NolNIj0}7xg7xwUw32907TiLwKJ)CPq9hR*&>Ea z4VR>Ntow(yJ5@XEp4zPZ`#jCdAsf_lQB#$g;KIXkX)z@`JwGUy_oa}G$q6|d3@Zym zGl}Yz&Rc0sr1iC{6}nF6aE9?FsdobUREo*c0tFXv!fh#K3W)13KJb7jS z0ZWtgUbCzi+S^^9sV?@uc_P^%GnpZ%CXL@r^09Zr)Gf5{SGVBmhG&(}7g$dGcpmI?lFI}o9|{$|PgL2CoH?mHof2`Hwp^dxZ)g1nuf1Sdm)rJZ)UuQ&7R(f7>-~{}a zpL3ZU#=eYzV*1TnJgYYjFCMw5xQ#$V=131uR-D#!dv}K+CO(T|m8;a$Mt92Mj21Ki zugA@t?giXr;mR1Hdc^uzE-kD4=VJE^Ssq^bWQ5pAhp`$Jz6HtOgkiZYwXf_C`yEzxU{2gtb1nh1Xum(>tQpdo zkX`fCiCGVc<2Ffm@$sMt>f^u^2qt4POt&Y>Q7Jeidh-z&1F-bn;f?l1QDUUU(VXH; z>@`;R^bL2)?0&0RZ`)C|;t{&fY=k?ZD6DXVVTXj3QIf&bfm+asf>*!j)B#{>4dR8} zawFchM(zErrS^)H;8?$5lI0aXW~<>t1E%)I+f)Fe;n#f*3!8mNuE`8C`gak&wGQGL z46E{2Sgi`KU|-D~a*@BiGBP|{Bj#DaeNG7c&L+_e`>>F{Vsxm`Y}r5tfKjqF6S>>* z1RT4W4?ji1`L2MVv=M|327-#~&mFb0?84f70n$pU+-+#Ka@3LbSah2K9-mHUUn;g# zl&`(yFVob`8M&&nguPl1^3KgHiJHgNj1=4>oT$F~+ZB2HcMm9;!WP-Heb(`IYVoW~ z-V?%Be$|iUP$PKRcHzM%jI7oJSY+@CO`$MLi?uL@ETQkuEjHU;lj9ML?z7zuWqOWd zHM^Nw0o0$3S_^ff1sPxNEsqKh1^1QA{7M#O9u8K9w~^94L`<-H{Ks91!<%X))^^0T zDY~FnWeUQ>tDm&1Sbmz=5K~OVG}~l}Cubzr>Dz`jx}MFl5kTg;_@7wSFHo@`c0m* z9O)8G?<%w5xZKZ|$~Fr!5T_cR|NJd$XRyLbWSwHuDXX#}%NYXCzN!Pv-#C;X0zXEC zvY8x|!=0;j###XQJTlkQy7=goEcQF;s9(ZrLV#5b^p~z3E4@ys`uU!z%po~f?%$|B z^Tyw*c(-wby{98*-*ENXR1a1+kM?c}kVmHljzJFeBj3iB*>8(weZ9U@Uo0w#KHAWa zrH&f4ZIrytE@)EPXsT&;I*HRpm0|i++!?8cV(d5gh3>1$J^el6HFQXz8#0iDX-L@j z!?!oXIPMs){uGIhjz$2B+41$>9kbbAjoKbC=6o;I`?h#sA`)Oh3DTZUa^jDZ+8mpd z=GFxF=7D`MxkLQ!GAW;aGB0;g#yVqN2*NHPtYw-w{ab5qxG-;er90i7$F`wu+s*qOGax$-LM1OFo^LEIFXRWT zCyqLfz0mFWeo5g?pUiQ3PJo;#|1eBgguVHLFV6)O=I-FI3syhUqtyZR8!Ev3SS@8Y zOw;Yl7gREF;_ruB9CUREG-Z+dn8 z!?K$wK_EwcgokWure#XeB23}gZ`MARtuu0cree<$%2hd13bfR%hmS(b@4Pk5Ds44$ zJELiJW&g=r51HzE;ek%4?C;Fcy4w|ptmN9Vz&{3MGr5Z8qEy*Ga;x9s;Al#5pw8I% zhu|b3A*+Y{XiI#3M0iKZsye0C-{e^{OcTFZYrSnVW3lZV{?OxWL!-3eN<-b~is7e4 zZ{f&6VT_Hi)|T;*uh=MO zpiqS!Af;794e%AX4DlH<$t)ly_K>kJR;$y(UAl%;rc>+iBCIeD0 zTZYqlx_=vAx+#~P&_Ave6V*0`(VW8x>FupM&#k6w#7s7QbhVtMZ>C`K14gS%eAz{G zP|_Q_H!2*CX4bJD>M8@3d(WFGFDeBj^KOpomM?a#9r#Br?fPC=XLu#7#X+6k#4zTJ1h5{j=i#OMC%L` zqm10`wY>VCX@`2)qhz&!!|x^6abE@I4s+_1(y$kyIXMN<>Kl-qdG8d{{e!_{av%Ik zTr&1HY7LsL!nGKJQ>xsT{v@OnRpIMGni@67Ua(GXgxt7&Ti&Hu>}Elz+vG+~0>bVZ zW_>%hPX&w_$Af{b8dT5%FOUQA@(pAsvbF1)(yw{7*LRDb&*X=};1e(Dr#SZbszNT($stu2GAt-Vnb`UBss2W}Uj z>YG~y5evf{^UL0&>|2W*wh5?1(7w=7N8wYpVfg7BMjrV0U#%@GGCSQ(4BU12 z8Q<{BNc|L*5Q=GV{lC9^>`1*u17H&Bj|@JVZ{Yn&@t-ojx0%aNoF&v6ON;R2g=kM^ zTPjH0f1rKu_j-fI>mJG3g@#GpWIPL3PqIF=GOJ1x# z58GPU%hBvRM?=5pUTjH?+*R_81cA%F%;Q=uAUg3$jvrf}VcV4`)IKr4^f!Q1=2!Wr z+JkL;r9jyJ*V{<(qllX!eu**5$NRUPD{P0~Y5-FR@;?Zb-}x>U;0{g&$+S@P1&znM zD!fjg6vhzKS;Rk(cNGzNMrSG|8?Uy1U&%y<=lOt2t}n>~I=0i_$$;Zj;?`}NoqU!1 zIX4AkzPCHWX!0aq5u|ym!^yQH2$|R)9gaoX;mQLW+sHd>m!0FKO4lVZF0B?`PIZ@v4-dh&}xxyQrg(J36~TvAHTPbh!L} zX5|ySG4_h(QUU@LY!_EHL=WWaSAVh^ldJ+{a)2=b+89a(+NMH2vE@egWw#gev zNOd)8(p#>T{PP(L?8k4%&xZW9M5w5`S)4g8eBT~)3rY@)@I{g)&LIl)5K(VVpY*o&Ae z;2d&O-RR&K-LcB#g?Dp{hO+O{Z{s6G6;3K7si%yw3*Jy(-U0FVv_qFoczYa%mp%u# z<)ru20FG69eNCp4niX9xyt`aS2if64hvUTz?v^PR!c@%JE*|9eE*-HBNMPh12wjyw zLw%7Upgb_B#_*XVg{L>QBqMmd^x)7cVg0v*=iI<%kQ1kCt4URXKF>e_N@r=L!n1*s z`5_Aa%kX^--+~a66_H)k^s97lr+xt9lyIWa(UkRJz)vQ^#+vcA z;aTqcLo$)n-<@4So`B>NVYPZyP4L}b^O-5O>%6?L_UXd@wvNlNfk#iB^pJOIpRlV77rcyV zL^tPN?e`lWq$3g!O)$awg`cx=%KysfKVKiY-A_0c?%Hs}9gVFzNG~Zm>_GUein7f2 zn);7Mm5ZwNCHol1AMV{o*!K>q`(es$h8a{z>#zu)2!@@E(npNOlYJ!>hbGq%HJ%|YH9PvA zfDRa^fF$BoDCi%ZGK}e8SCc2x$1=c5Jh$#Gl@+s!ti4 z$yP`A-xBiBUxK&o~aEIY;f*1uka5AK4&v#EXzwP? zt=bGO>@zdf|L_Lj9bPF5)apddn|Y;4s3r;2^Qf6@6i7*+^G}p1Q+I7ZWK#95V>j8N z1IQ{?F(BWl|8esz#Ls$r;&KvFFBVIVeAVHHVt61H+0&0b@bUXuz=dj7_Y zV1(=M%$X6GvCVD^O=1bxy5$r$h6?LpzBafcJ|W6tKQGJe%J=X2u(y+d$fFj!u6xck>56|qi*tK?BGy9Mcxr##r$69FMB^le~_*p0Sqks zl7IF79+q-&!!uFxGV+dy;`s@;eh4+_za#AbxGMehYpr5M zY`)&bu(k{U4OY#Jxg@vOQyF?{A9soBk0jLuG)y-aA?E)jPnw*YU(1#Wy&Pf>YIMQ> z6UY0Xx!$>B8Z9!;-kx(|pepaSUV)bPNt~7%!b$nT)PtTSL&5S^(bAPA7Nn_wq`Ia7 ztL$K$Vua1G2d~Zo=6C;$EO%c^sjB0a&`4j245iCvuD<6oS4Ue<@#1CVDQ2D6pSPNk zC-u3ywA)L>i_WK&*dw)JT`xTfpCEu1;8v_GIsrz^d#2=xGvpt9pfNAxJYkQQW0Nb8O_R>+-!KMBAWumeW)BD}oje<1V%)pmMVc zjti^Ai@5Wx3*EQawwd7ANhTDP8|XwA%SAJMS?s0Lfrgc6M*lmJe9Hb*39+MkXdi51 zgP`-i!I&IUA@U!yxP&|osjQqwO0P+O{=C1`8UKLu_G5NoV|cyU5ECJW`9us>xJ@wI z-u-$CQKdq?P9I14=SL^T-A8=)2MsbZu-7D5L!5OCTK~9wmLW^#@I8kB(qV;vkAg7huLz93Wl$~Ajq1nbF<#2~O zc*C9ST+~AidoA*KbNu+xO3b#+m2CVoa~Q1MCcZC6!^YB-VZB_61MMai`=8p+FvSlI zQg%|MTb_tn%@eCEWSg9$w^fmcuvrleS=TKM&WEBwthF&laMjfVs8ILl(O9|_>;bZ3 za0X0{+NlE~X6okOI>hQ8dY5p0oN=fBTws@hg>L(82f(&7AuPuP=QWLX4Ko&fj5{CF zNFRXCtADijs_ns^r>8g!=$H%`Ak`QnxCCBQ2WQlhs+-qC37ZPsDa2wYBN_-onMNYk z+h5aXs9(WfZfy-FhG~UA)MvG$B(SI8X3yFP_)o%B%5Bq1y6keo84j2?r^R{! zKF`!Jlb{!$@^U|Fb0tk5prwVKV6(h>01UGmb?IR#MAhLx0spuYB zgCQ7UGS;-qtSr)ANI+LKc(Uid4omlYHgI>0z4)1vmK(I#@zY})y-l&)+pb!FE$(S* zWtB3s17Z>V?GyC;$2)!~ardrm$J>3e5tEQ`{>|lCSq?`B-iC%$?Q2++4VF0lTyb)b zALO;#?+EaS%a+;v-u9Xy{ldkICU@ zq;x}Z(UEdEu7Usf=I&TDM$3M3W6W#8@yZSjLmLP!%IL+e+-nhbEV=+3-tb*QHsUH` zJ@mDFgFu->`pfgv-ZIOzc?Obsu9H?+R?OSBMh$s7y^c$yM@I#>FVl#qsls)*SFd*B%522WUpYe2mc_9F8@nPK?Mni%_A zLn^f^{MMidV(C|F+2Y|g`3a%CkYw92k1*WXf;nv@iwc`m>B{(S_0#zGNBx;kqnREb z3x1-ZHb6RgvEO`=ycWBaY%$`0Sxx1l=6UUH2jUxIww*&=+FER}zq9N1Cy&`cn(XQ) zEaECF!w%1XtHPP#hiK_goEoqjRv%G^GlhIuJIIQ2(F7t_Xi(RrOly4A++1y@IhLJE zv|crNE!POLljD-~{H2o1gys1uarq+B6gwQNRzg={wKQflzV{xB)LkiGJ9$-UK+yk% z)aQbuiO)se7LlD8mw3~i`HyF<_G}gsl8Ecc>(WPACL;A^c9>tUjqcQ`f}30V3TW2+ zlvPG@PGWX3oVOiv<1l!65S_j}vrAqvf!J@Al#m06EHw?`y(LTNIzt?h;{AwRwGSeW zIAJ4kuhnN~IK_VogUTkoNNySW)E7{Lkd+~=o-?qY`u55GaS1nWR`1gZ1Tn<@FJ`*% zSI`DwTSUvLK|A~=o6mCN-vCvuK@HVp9e)R8QL7)w?_B%SgPl1ueqSeu4k}4A+lOCh z$mK=KN{t0)DED5rdWCg)T9Ier2RjC#dldN=S!&;+Dvm*?rmTSn%!N%}Vl_SZHedeKt%i#v>UzF17xJ ztLk4N4|x(EA-rF5UnM&#ahFOsLHX8_lh)+qN_2(=Bz8J_7I9s)AaBdCFYRAE=d0>h0QBhYRIo6I^((xk5#EGWAXh+4i~#hCZSq^aEPW9Kmc~$g!iK7nx6GDm{i-E8Ei%yW+b$} zwHvSx(rUmWJ07z~2&mWRAv>~{CE{;xfsrrY!tBi+txNWBB0nqJ>@WKYUvyVjQP{5j zR_~}37m)pEC7>Ybj+yXI`Q`$gTJ>Np@7pb;qlr2n!{Ja2l5xOe>+Io7ViO4?ev3}) zrc_)~1`5_Y;L&+jW@DIom9e@7^ELaS&A(R`sU=$8*1*b46_sd4N%A7xb~H@_ny1zf zuy|tHBgR6*vNptHGUn(otmAmdPtLDGtW)j43j7Dwj}nz0y=8)H435)sT8)wPn&()( z?NOo}S?bV~rn-R3&>)qieJ*J>9sZ-LL#3=Y^b~(hO@fd6p|u>wzgF@{RE<+nB?V_v z_?nUBRKu^4%kE~qj(c@d!Hk&>iDi#FYImGPG#MaF_xVPM-C?4=!06s;;;x0F>dO82 zofg%CouqF~0;+!h?{M&P-}u%mk($4PvG&bykk`o%Y`sQRt;Ui$H>svvTYaCro85N| zB3k@DW(%6`Hy|D+wbh0>bd0z?;kOY}6zy(qX}15<#9{}oN$Dae^e?Ye%u4}CDBf*O zn|KZZYUaTFVH2P@M1rz0hE!XLjxUp>bXxN2ZHIs>FiJWP7EQG?#JmF*wz@o*`jmh) zJ>kxi+Tp8R=FpS_z>@!W7!Zm81Q9f=ns1{j%jlVKpmvFpxGMze^oab6efQ@YhYOAW zd~ipq>@hyy+mot9?LJ$Z9egvg8L|C9_n+F-cnPiF`&*RhKKr#A>odE`meG6Iy?k{B zr*;xSe{MbQ`vS*^hdm`dl6e$ozmOeLog3}fY?vn>i^xm5x8N&0=JB{;HoWlNz;2dF z0%1ZkZ6A;r2L6diWZ&l}S5{4AS5LSTQWJ07UrlWb4ex*fjndxM5*UGMNxU$Sp~P|w z&h2cZ>#dS-_aRR&XYk8Ej-dk17jXoYN7e^V!FxiKY0Uv{+c;_s&gzm|UEK(UT7uhu zkJ#5F)SY)3d6?4D6tiq44RK0M*AAtM-_gV+kihX(m7#?8k};P73u)za zB$fwM3IZ&HoSQu&c59@sqf=#t_xAP@!%4*!IlyT=Tj==~LaRE6a^#Q?h&7am5`BXV z(f$1`pLy(abjEAfvELQ*t;BdizRi6)&&Z`+=7GDo)t-thKyUg7N3F0}&9xCR-F31o zg{k8uW|<2?M~l6YN_bad$Ig8d7i8mojI1s+s1?-C<+tN@%KUz{Orv=1e??sf%|El2 z>y84No10I{{maV9wqIWyX6uDcSrux*veo)}O2yNjjd|4kioRK0w||0#TU8EwiRSzk z*>Ltd*QY4ZDa1dLG(et(vbdypX)k@9)77>L!SQ~)!Y+MAO^2>?jf6%! zv@Wsww0fl$AmR0C%4kWDXN4bqHuFk?&lf!2l@F(EBE5_oEcVV44$~qWhkSbXR;XL5 zulC<5JkDKS@$0*)l~w5+WKOkh8nc++Y;z(+bAHWOSGQ^2=GdDGl`gv{+~+T|-tHD| zzf!Fg#qo|I*#e_Vva_@Gjnih|o}tOSjLz148qAef1=B== zABLAr4)+$BNN;ba1!plmNlHc_OkBor{i%9E0wLt>aPnRcC#^szhK{zm>FVtsQu$qS z6$fTGDoySk8$Umg;XeM%r`BEHc%x*j~Y-tHB~-2Jgdq4jzo!se*8}ucMBbAh@Z$f#gXQj4)ENK#Sm}9 z@(G>)4E6(>!FFr~EhYM@D}d&`TNqSe3~VR6gNQ~?ffH1?IAv1a_f#x2yyNzm+@zgt zP6c%TQvjjCYpe^}vxCnCTwwEkBDZ3YcU(BO4Ej0meS4@k395Vxh6RWhqH{+*ROKXesHSs|ZK{ z30z%+-W6S-KgOYnow>kYPjaai2>7$)|Ihh+ZU2ueh6G-qb>{^s>F6Bk%i4T*E#U^x zA9MRVBy_dYWuCAWVdqPj1+T zw~5}rK?=@j(_WOR6LcGSl{4d8o7Kkew%?gE4Xu)ym=9Ioqv;Lia#h&6n!a8tGHVE1;#K{-WnKhc+G*^jt0JE;oSxypabAmt)Buz`PQ+ST8Olf`*^)O{|_uP-w$%(tL-W@Tryj%u!&+B*Op6I&b6Zu^&VLd&i-S(F@%O_EH+vv2m zDVVyDcIsH^2$&f3BRF5k(yEo&YVh~QkQyegj$=$(!NT+)zxON`Z46^zI&DBkzk`FR zeB(buJG8kEW|wiV^{*1Z<;H-EJ?7)q%jffNO5YDECuMR=KolJh4n&g3=GVmFERi|? zV(!Bk-D6BL8Hy1vm;>uUCC0i0*Go02yCQh=nl|Odp9{uASl&6&n!-gM_4Uw}#mh?p zTV?W+t&|sE!0pzBUbTPh8^MGXTI$RAx3Sq`AWS&*Ns##oX^DoiTMER$?;0#|f92+uQoJSS)#MZ6}vaf_ASJ zs-%BHx>lHXhTZ*i+IMU^b>RuCBwcrhK|K(9U%^C!1kP|!qrYFFgdXUCIBq~7S?pg^ zt{sPq!Nm0YKYog5NCrn=-}4YuB37kFA;hL)m+xg4O1u0uMSa^hF0(H~V+B4OXYA9E zGDFAWA)uOKm1k@)_a9G=oeyr@ky#+({mvcml8J*l8=LXaD*vNs(R{ea{d@Z1t!K0> zkE!VmNGBJ5H?8X*lYF3Qr*J){V{%KW4zr@<|LrjMg^#nNOuDSlNPbR0GlenDe(O#N zVmi`u4sT{Q9q^^==ly!mULBn>r$%}c>e$uY{IlC(1Ak&3{tr65{FTpBxK!L{!?tVY zS-$ZltTUxnKt;mTd2eH`QrHg~hd=Sai09P*vNdj^?{;TgT~*GCW|k`95z$j!Z}QGO zZJc!d93VkIb~&He(04hbuGMYVlU@nV%~A1S?hlTUSiGu9Eeg=qI#~_k z)Cc51g*Wnwn-B)`g%&y$h&ptJcI6puJ7LeW2}5cv_%=wVVcEbd{lzVg(n!jgy>`1k zR#k`6r0|YJpjHOLL(sE2-dvMee%MQLLXQLV_OfTJdeX-Q>xbso2=!qM- z=5E7b_HT}q$qDmxTJ2*PGf#@N9+Bep8nQDsR)#Kfozpg{9l`(;Y?yVrf8^I;DSG#1 zv*!}_*|UjES`zg_+q*)NmRgo+t0mtb4kyAuK_&AOhKw>wK;CuOgI=(4pXyZR9?1D0 zd4$F}?&y*YQ*MG6gXDlZBJd?A2eyhMB?tYhJnW-$cu20=n$Za(X$&YR!qosM&H zx6ebfPh=DkiFE|Ctn&k@5kbEI4olt}izKo<;vZp9dN52Nmw%bL@v5kLf6&<+=ni|l;MZNeSXcM%4y&|&K#3c?`oMo1E@9x0(I$^ zVY+|-Yiv9MiIPJDrJl&80U%L#9L6g&JlhJ{4Jk549!C2Jf9HKv@_^>Il?fb{X%TAY(Nes%eyGP#6|5S7^)krnJdeUyg) zGl!1-7p%~tZ`%6W8RuLgAN>nhYX7MP4}AjneggLxLSUITWwv3aWtJA_ni`vsdCMH9 zpxc<3Y`!mPhuk89?_|0rlXw;{(j|iQhQ@SmNfKv!1x1JpD>Z3OQy z>(+GQlsLf9`o-^|Xj)C)Z^how_l9`O59s%J#Tyvs*7b4}2lEr4^U`@`yY+6pA81{G z;2>3wW}U%JRRG0cK>EuGfB^8J&*VOnpXg5G~!0^ce-@*DxgA^t3BAQ;U3&Y+!Axd*`xbUaP(TtVkF;#^ihbPS z>#U_OU0=f>7wv9>#vS(Cv>L(_0$L8mPhm)OC9EJ3m^SG z9!~Hqph#vx8ai9L5lci--v5j4{*Q2=wzN!#bIXu|(;cpn+hPT2sV0Mfvz$GxBixdJ zX3N6xrK*6sS+0+cTBc&i{OZA6qa2DL?I{^R5CFb-pCQ6O^rx1jBX*K_Sh0;N-N~%O zrL|a-fQM-#o;joW9a>Lwj0cqt<#`?_dA3=(_nv9vzqX^Zv}lbT&It_>yjt`&r~%{2 z?Y^W4_Z7vsJ~<-0>#k}@+;E#RswL~a4)w^gKE9U5P`w+U}l;j zEaN)=9XuONMKM0zK~qr(1O>kqqK_rgidagbh8OQiqC-zXB}}`xqYq7-(nOgtNtZsZ z#n<;YB16k8o0N``p;NKF{(%xJPY3X4QfTI{{ui+C;G4;IQmWa$ovKO`b!)P6n5i_g zxvF4-6%?S~g?%wqXFI)B?zP@lAza>ZAe;>-&F)^$m0UDr)3@vxXHq;|!tBR#JhRe5 z2n6#Ny`*L-TYf%Jvo4?6JrpWca@Z4OmZw3=G{*%?BwnBMbFWNI9Q5C;ta4wu0ijNm zh*{A2yfHN$I5Hp1Trqdq# z=R=zoT2$YG@IBP-Ir7ZzJ=)F+ z!75MsoN}XNTG=;D^PLh8W&Dxv?Ldt@4|Td%02|xWqFTS2sgYQ2*ImE+U~Bbe{MP)W zh~wAf@D8JDa~ZyMh-?XvBs7=VXZ@favI_l?zMiK&fF<2>OfZa}G$3$*>6y*cWFy+u zSH`=zzPf)KceiG8bJ1mcf!GzC73S|~E(WXC*RsZa#_4Td7?91Y2vPu;0oE`pBwHjQ zD~+AZ3tki=n;`}^_D$w59d38#!13-3bGA)KJ%veGb)DP~QYCgS9{QVTAHn-YJ`FI} z%)`hdC965#u79^N@b7HA1=^YOECl6dt);JVr`-BvWpf|B(qo@;QH*`jjO?uI&*Qv; zaho-WNTyyjS>-87`BK$6uK{@hQQo2>!_^x%Us zkP*sP5GyBMA_ZFR*5{u1cgj);|8nE66rJ>x`C$AzAl+W2vu&^k{Q#?$TNc)ZafH1D zPyxeymKHLD2#VF={~^+?2HXYw0?w;8z}7jPM1nRc=(u=>=9-4$HS2~n0Nl_7 zoZ|Xx-h@#L+JRfWBQ-_4QS=OG+!wcp9UozN?A-c~%m?!MXU5a|mW>?i6|ipB&(lWQ ztAyLo#1dvC=Ib^yux{8PBz`Jkx_*0_Jl*jwl<5U{hX&#%xD2t z^IyxDv>xOjzD!}s7|;$W{)!DWt8Cc4eiczo^%=N7b9pzx)9q_~@GJRPhK&CzdVPG= z+gvlT|I>sg6P8v^={1Qy?FnWv#w|#hrMbeA_`wrH{?Cbgs_n?PpJrzSM8{M17>X!L zz)&~Qx^2gcY_}cC<)W50g5O?5?j2lT3x1vAUv!+OKsQ{3>(r$lWW zF*fJ+tXhc!BsNhyWL5iY+6v0A~4k{>0lio$7hAK6L zCW3{kRHYZ`O0!b3^snrqH?zGaN@ zp8mF+7F{Fx1o&J5!(h92nQeScvJPAh2zalmhcVesBorE!*e82rCDEyH72kB<6_B(4 z6G#iN+7WwymZdwma{idr9~#=(HL+bjXtY5c0J;OCdy!5OjbEWqq1Lx!gM*SS>*TzGj3wMtzy>*f3gjTu3q9X*s}FRNgiZlT1y6h8 zi91$8YxRp z6HHBeWSs>1y@+LO9#2U6%`;Y78DUMGRf=z^VO+g2@6XZ?6{a$6&s_Eo*id>Dp!Bfq zO_rK}o4`nE)=Y11o|m(dmVdw(hWQAU;t*g6uYzH-cP%Mj+uMX`pd{99+vpvgH4;c#%xd>LnaQ9ytZaLe(B=WV4jjmX*NTGQ>i!M>s3I>liLhrKe|2Um`SQ z%c+;`uByh|D)L|sbr)WHhunSbop}v*E;P6e?*5BDz_wR9xt`Urv!-!t=+n(D09}<` zEIQ+^6-VL`%%tx?-?vlHp2}1J zky}B&{+EM2MVAefm!KK!l5@^X&O3HXaChvEVgI>C?@>_j{%k<(4KP?jxmPm$D$9PN-49es#>@8TIRXsiv8cqu>|uQgfFf!=&%-)=++G zMZU9!VAe;98)|p6;PhAORwA??lIB?q8PUXS;tol=doUY7#D=8QB zbK6Q?sezl1-VSX@ze?%<{9Yl>>8+Jv$AjfiofGr?>ei*hJ8v&b3yj`=0!mW+`rvM1bX2@;H%UePGiduz z)ExiTMu9Ygv&-#ngyICM)0Kc$v& z;=Azy6C%Dl$=_ZdIED*%KUY{pfnoWmfVv8JmHs^ijQG>m+;lIRbqgc83mWZ5e7NIr zS-Z>A*(-kz2UtH<-n~+#OE1Xkn$wCaQ*q8Grhd&F<`vpqdN@@zbmHZ(1quarg-B!l za=ezX0=;+>4GU<#Lc@AkPKhp@0p$18p`jd=zcsHv6|}8-5-jwm`$G7FigvJ7 zwu-TFHqz01XQ(2&dt+CR{sQ9whlH2N1CytjpK2rxey#ni7#&Jym%0ej)G&ZIYx!yn znZ4hbgz$9F@U^~AH)Wp{pK<@;POJV}_b*wm^|&hlYX*f3d*k>!j&crSTf>yT*E>6Z zD!w-+g)aaH$2o;MZu#pjUC!BFHg@wY6u;Ad^poQ5z16U-t5Yv_H5c@>FG~^gYdxP> zePM#_PdPF5PIq7{g_taqW@$YR>=fH{HIi_g`oGC?v7ZB=d2nNNVGOkITt_kiMS!VKvJ4k+;%`;b$?gPq z^mB^+Yp;#5D=abS`!$;Lxn@>di(K7RC9%wr3<^ygjLu`9yPdqMn?$>BDd~B1}uAMKLc|K zgp*}7@@pQ5=*onbnkBNTX$-*;0wkj7a=R|$hbHYB1yjBv&D_7)So1c%H(p|Vw=5bp zk9*ddrkFGJIS`|gM7AcW4w6T_stePs_5R!{{!8xAaRZ3-mNsQ^b)Co=r~AXOwgY=R zu^nKTy4-)$U9$fJP~z>8IoaM%?MAwQf5F(|K`~V{xbyfPe}xPfob*?kz2)MUnSS$Q z3=&~8NO6eKoR>^j(VU1TWPb0+Pv$kiFNS5Dbr7|aO56xB)T%r(MP50%F!(^WV$_`w5W~*1qKc&!&57`=$ zp7z(POCV6f`mFZaQFza_0OHuf-N#~1(tATXNK$-(gsP@%v(pj^<~pKwCIpCo68+!u zh?c))@{||~?hAZZkQR14=iGFEau}*QuYSy{;H$mYYS6NS0OxJaMW&CZ%_l8Z$w)!d z?nBkfEtfot`PFKk-t{H1`?ReB-{AnYbNsf4=**IQNJXhy`l;j*4?1csdDEL zU;p*ZD#L|x$UXOE0lHS;^*93L!P~#sI{2k}0l|(>mugjCQ(83VScJKGE3DdW880N? z-db0Gi%C$+$!OqN4$>YeV~X@3kGbl~p{QEw_};Ef7!LU-F9+mYtgtbK$%6RDCRS=l zkUiP0Kj?fqKO6Fo#M?!?9tJ`02{9(GM*%A0>v20PgXWQ2KU^SJ@Ouyd`-02uq^OuK z2Tp_YVx;_w*A=2;BkfjYTL_KX3hZ@Ko)^APl)UCWlUp9H4q{+guhQ(T^#&sG^wA!q z5RaHVt+%FEs-BgWaTKdho5|R)ZrYbN1`R6Jn>VchPJ`{#h07bl%*Uc%euwp^D6oTN zjd8>pL7-Of$F`*{;|nOm`h|g%$iI*xzV!Qh>-X5MQT^W`-1j5DpsW^0o^;2PT{Ubw zWfkjbRWpcq(6#r5!x%}WZ1QG}rxz+?4~0za8}#SmV7W(PliCT3BrND5&8V8=C~$Wr=YjQE5q8YV4sTs~gcX^7RTeBr8K z1(9?jNBqZPzV6fFlQAw!I778_U{sq zh5TNtt)~vHI*+;lVE3sffxUO% znEJ?Si&(v=oB?lZWz&4=)5^@`k7a_f``v_a<{GDh5VL5CPJ-i6Fv-c^sl-pYuS02G z*}kuYBFmRWNZS!M-fx}7E&O}CMQE=4iDW@E(iSXHpJ)5$G)&1@{Vfwy^trJ*)f^YL zvnqcpns7MF(GTq&-)*UR!bfS9(o5w%=R5>jah9cRH|%tWhNy%yfq0m18`SNg^$>YW zg-h=MNLJ!Hubcc_M-MtEuBVY<$<{iDvBf--mMv%_==?o?ZGWDI?||HV9xxqQUNo+7 zeEkoq0G>a^t5*6CYS!zpZ^uKg6^JGslgj(l&RhE~^r`kI82gl`$cuN($yyz#OixS8 zt(76x_HE%IUVHK%Mnf*ASgBY_eXRSWKcfZ{v_WPOwiG}uQ7L@$XFD8t$H{z6#~@gj zIQp>Qq(6xEKnCLMeqvbV2xKk>nyuiFDFQGXs({(5iW)Y85FzJYf0dNl?zqwH>6rz3 z%cj<>Pcq(&!b_g)r(oRupnMTggD8fOQ;+6xwL{dYUScmJP+sKuN4P}9$kpntdOhxt zqT^R1qx{QxyEJqGU!!$9r`XxM-e z!UB?k?g%(E^}fpMt(#kQPz%y)eZFfTQa$PLG21{;A9>om8MH;XWe`8}z;fztw}xuS zi;1ZP+VyF+oX*HdHHYL(;6ytwT<};u#9o&7SwwY-MGRuMG}U#gU4ws1id~%wSGM}u zBAocr2>!W9ldH2tmBX3n;kAIu8?sf4F(=oQ>@2uj&n-zKVhFR>f|(}8LR^vhPoC76 zB$g37=-I5A(L>xfgf!=Iar1pWQ(sKZi*e#OH^cD$39d2(2hsJ5@|;&JespDt5*8}` zmv0{g`=X^51p$k7a|Fi%JKR>@b8%wnr?Rn;GPz*p=tlxGEz|{YO3hBi%p17+$1vRz zHQ5%?7~lji?5@#4&+b)-^0B>V_=)#o>2k#pVaTKtifV#TlH>i#qPG@D^_|l17;NgDE zVO!o8+|BH^*1cJ$fXFjMD>1Isb{L?g!>GgiOKrwt(&vO)yq6qRn)CH6W+tYUD`#Ck z4-o!FxA-dYd9^p%U~o^@-Xe*PHfpHW^$P+U*D#*>uEy7B1a%gtKOU>+*$f+ND2(DE z7bMNY3D0l2T1!n=*^nRX94jLu-J8zQM+-Vav|b?c(ZQsl1l6rU;a-rm-k_l>sYB6O zSmPnDIvZy`qPVM@PPbt3UFfVKO*eri$izWKZQ$Fy>Vc|WN2=_hIRe!E{uC%!fE7J4 zau0;9lZu>%SkRRp-O)oxqgOaS{VwlCMJBfvjsBJH=>Cl%<<%B%sh*mWk^!9cs)r3A zx3Tv*!&8a`!aa9pV(lha;nM;1Hy)bWsPv4Fugx&qaZk+T3_8=?xR)l;+x*im|Fnk;no z+(7X}^9R#J=M9%(i;$z$E2&gPDu^AViWHqDH};__SS~jNmZsA#yNZ3PaIrtp|-QwiE)-9n59vPGCVEE+d$L?lNPXJ@?xOd8mc z0$2XZClEs;?fg(s`3%0iSZ-ijY{zAM%0p4ftb1$ihQ+zhDpEtw$uT8rC4(ocwz%h4 ztkK^h1)u0F0;!A}0u$x7leJ54XasaVH8CagE_RLkC50ERAztgv<4}Byl6=~x$y}9B z7CPnA=;_a<0^Epmu)$*9W47`~Kio4i<+^8<%^BPRg5NuHkgO5rzmT9@>R>|p^R`*C zO)XR+xiM5~rVpiUjn|-vf*4a;d79C zOr`S$e3fm>{K#wvqGv!WhSuhZ| zm_P|3-D*y?N?P;AM2*0cokZLgiC^VV(j9<2<}fwAUg#~g873$#u~HZ4zWSb1xgX&E zEMLAt7q4g3xiw4!L3jV0s$@>)O46Ue23-1N?PhxYpo9E^O~*PTYe_&$=Vgua0N!5B z$apqqDC8pO0aT;*tPKbVmJcmA0pjkR$_3Hnxqs1dcmK#L3+*mUtU1!3Wt{B+q*v{5 zHp*Lf=Nc8Bs5}*Ll&m4{y><<%zD;sZy%v0KtgiuubM`jI>KZmV>l}QD2toJlx_1a;QXv-M;i)U>CsDKrl#+GwbFr;G63w z(c>D|#h<9233KK(B|QAx*U>)r&04DRa$z@ z%R|?8&Rw%2mhS>%Rq<6GzvRLo&8?u7Sb7gAU8V;!XCb3oZQ}*ib-I)NzvlKe)~PjM z6APp$^JlOpC)OK(P^n8OX={COvB8xsA@Y-(9AjhULON2k3^grvOt8m(yvZ3cjlMpU zF-+4W*PnbiKWnNFw|m1IZQCO1+LzUWptc=~ipg%p8jUff)DNz4N(inQSvj`etr*8f zPjO@1y@dg9_l+W3Ml;SRv)5|d8U$rN-+pib`6B?LH%S%k0=oM`x^|0VQdZ4g6kDv! zW@YNVpvybfO*nvZNn>kvNL|it;a0h)`Y}OSba&BvyW_O<;@0#2I|tP=b=KU*#=1vB z9j(pvBRXoGOG{2e70x{{QzH_ahuVS{Lrf8_Z*&l&KLW5}#qEge2__Q~`Tj{&CaXdI z$#Zb#PIHoRu0~UxVo$zFo@U0_DLb9EX5IWbkx)1-ks z#bWbH>`_w=5bi@Utl)OoIci@a0;<~!ljv`!R_koCSoPRiKNp4Q0qQ0@mgKe3Il|z( z>KwZ=xp2xFt;Eju$!d{VYT-ASq2PJfShKuO8C`5B2(fnj&T11BnfuW8SyV5aIt>Sp z-lDCqTMz)`VU9)_+STQ2?@nJl^~da*_lv9gXGI(Sg84>*T0&&lXgG?C=DO)Zui+F* z!pIZRQ4vhpxu1j0b3CQAzV`moRiY$=bby3$m%dEu9B+ww+g-QVgj|-U5YtO}V1*~x zS5Y$AT`JG+?7WhyOyj+eXic*mdf|EJ#XATN#U;U<3<75#AIrd*fxJLqD0NcpSn?Y~ zDL)L*>|GBrVB;8OxJr6pf^o%fGVRb_Ik<-1_CecfbAu<=LC;4+C?3zEXBl%>a*c@j z!dCiKZHfH9)bk(`(R9x=Y387C$o`>i56=OU>^V52_{gEx9qLIzJ+C`anpf9spTO01 zW`muhJ>vjy<)4s zU(;63qr^9R&oWWkj0RjBSK9RSRkF1R2{-Of*g<^FNr|j~pwzGYlxg<7*o(au)j+wU zEeO-uy)qF$gR6>x&|sKf9Lq?ou0M7mZzGgA$aSF_q;4<_A+c5e1AehmiB>3 zo+^k!%H;TUQxzJR-oIH}C#rOL<3G7}h=TqYOKyM&$Fasc*R?*deW*sP9-pQ6X4i1G zC*KjrENnYoKL>;@tCb}we@Yd8)o&R!=a$MTR;}N_PIc!A=0VV&;}`Gj;Yy_MGC8@F zz(avPN!n@5d>e%QZ8M#hqYypnd7}KuVb3Kn=6*2t^ENTJ<-7m>JEFHXaX1lxBd!ys zRBb*9DRO-Vuwh+?^@Hq3}B{{~f0^SJyf_e=nGDU+C)V)FO8hgLX za`edeTAkGBYEAjh4!_Yy5IXFPV%37u_u5m$_))_gpoahzZjMkLM5!|FcXCr&UeD${ z3O?@awtx(#xYg3dn62ffO+BpVj=C>fYA=B=PUrSt**>XCzSQ;VDpTi`r?35E(<(&-y3H30_{aCf@cN zMV7(im>(U7egEB`f@(=5#=N6D|4&A&+J%b=9vD-*%yO#s%7f!4*LDA$5!(&fKPNX1 z5#6fGqvJ>FXLY0j&ftRV)D*TV+g9YZE>{J!1O~g7hiHWz;RhYbxv%=8GGTuMr%3bl z)7AD5mt@;}wNZe>-NryK4aM?RW;@Qat4Jtd-VocLrD1sxFuxpItH1ioq75fyv3Jz$ z@?N?l-Xo#JD4fq5XBh1sDG1;>{x@Z4r9VKDpe~T4-Rq;-W$W`p1@eh*PitB3>Vkmk zsdt%OTvYysis>}Q8wpHL0i#ln%Z32UK$Q+uJ5;iP3i3rG9BEE$>_-^j!TnX78vDw3 zuy2WbFp^7_%MtQ}RIpvEw!U`I#;RJz6l9k<4`tDvQM;>u+dV#6$XtMFL0z~0!AvQS z6^}3IFUt=2c~>tao4?9rAY3gU4vR=l4`#Ajt8lK!q`-jZ$;BAMO>^UXX)Eb_W*U#? zR6A#)y3Xf=WPl8?tb_gJ$XT%m5)b#hSv`Au%L8GKkLE}P~?(%2EDC>tl4@> zNx0R=7ifsk8QLb9@aYuF9zJ?Xlf5uK2TY=Zsp)R4ofU{Weq*5>CVJ^R^?=G(0MX1c zDMkTJluB(hE)iv^8#kcOvJ-$fXuGM#Zpd$U}vr(-%yR|SEx zjc2-^qaWC8uInixmLCneHn52|vvAtj^=Ezrz~ts|^sC1HRFqd`ivb$e0kTP}9y>M* zHrBBKUG8b<64W_ACb14uP267#n~+kdou6dVf*rP+U^QDcTivkk6;JX|y2xgMRxZY+ z&tqKYd|Ow3HoP45WLVc;2E6W5o$1pSx-lP&K&CHdYk^ldBu^y4W6nsyYQ@`qoFb8X z5raL&EZk8c2p0q~P;iB_-+FYr8FLbOPiXW`F5ma>Rl0Q(}C1 zkc;<`8V$b>&B<{(pp7j!HTMvES#WH{Y0c9H9aHaKBgvzCJ%ReWG1zGpl(9Q`{hsQi zE8T5>FtpRS*Cl>B=dHdMz;i%_;E=RH@tfqM5=ia}`llW> z^o(TY6ds+7HF(%0H`gahbSoz>lnwHEmyskTw#L=0Ix>?xIzrz1R^h5N^YjSofx*Fz zg9IXNkZXewL(kUy?{?dWMAyVJAjKsh^F_g=V z@wI|RI=7=F@MWLQGpdO0_U?|cVwTSME?+G82!d~-?aFkD>p+dmN&ZTF^~&ZA-bo2% zF*D;(ENg~;nsv3S-!SOLHX5RL9(fAzrP{00SvZx>d6}KMCxP333e4WQO`*L-EETkq zy0FNL@T?Tn0EcDgF#PEBgzzM{igssrU~wY01wEKjv^WX3o56M2Id`AJW>)pW-AvG4 z3xe@(Yw?if-#!(*hb*P@sp43F+8Wd|9(fEhnJwFw4L}#jC=N0ggX0xkct-?FNx);cMnC=8V{3NP1==#yl4xx5hW@rXF^ zEUa*r;o6pUyI46{f26OWPCNhAb-tE)lLpj0N_#94{eHSy%dqF2o~_GBI&iCc7Vr1GCYNNNitJ@d4FQv1TnDfIaFzwjcLLba+aCv@;-2>1ZW=i6}`ZnVGIHsT1fy=)Bp(7Y|AHp z;A~{E0_o?N5yX5yHvh|XwN#=C4XRBTTvB8ehnexj;xHQav;T zj(MbA;wvqqozC+WHa9-J;8SNXD_XzC4}Vr9-JN4sH7)zp>~X>eIs8o@7csjw9^%ca z-Q91Aj%ZvO3FSiRp)$Snb^P&-&FceBm11(a=2A2-5TWMD0yIdS58M<4e#BRWAq1=u z45kGnc+BbLBM7_w?uKfRaMy^e4AZR@Wr$>^ZKEpm(iTcxPMm8|Ur&%3Z;P-QMBl-H;1ivbGHWGn(%X-cxe5SC zWog3Xgyu`@5H~hz;7{^1$FCO1AXf!HD*~=BiCro^*Q9~ zOy39cW}Nue_7QRC275v}mr{(T(?4=5J~qXQQ%>DkE?VcMQ9{tCUCL&MN(qqH%5gpo z_^j~G1v^lhaxJtajgWctd#9XaSa5_NrflPS=7&-!RX4S8v?Sflwm1z`Q08Fn|9 zEA8&=CLa@@Wphd9=EpV2D&aldjqnZgW2RUezeMVAFFfII#`+>3)fn?al?WCb%6oa! z910-x1sbcix5Njz^)`$FMyB_5q=EtJvy1^drk|E1-{l@o>#?A zg81@DvP`D$eLw%{ETit_f%GE41xjamTXZfrTkAyUA5g3ZaW^$AxsJ&{?3$9wBb^V8 zAlMFZdj9Ns!F6THY2AnuW2c_X^E|tv?a-?&W}^6nI+zr=bA9-E%afivrZU`c+X~BZ zF4qvyL^LGehp(oK9*r&t${Ab}djj@y>n6(zm-8YpGKM`z)*Cc z3o5cq@B}ln(XNcM95x?GZ5^yAo9*FVtD9q7t;Bg564uM-NjFqLM3nf$n<1sC64NcL zKQH%3r&&$u)9Pq0!5}=GrE_+@&~*lEPNzdWG*3TQnanPnC$E^Gr6U9t5e11;7}}ky zu9XJvc5sqiLkV5))!K!zIz==xlz_17BljT1;oe1#g^QYCKbiFX7N?PS_A*&ma$FR5 zbxBOS2}!VtQ?#7nJ2byEb1s3W@Qv*tmX&G3T{gA3&+ra9)gbk$*F&4_{!YWlb@5Oy z??kKJSuxT!x_~7u65B0dD%O?d=5;KC857iVtoA+js$zgQS-P#**whnYA^~lurhi~Y z0Hywg_hdIX)ggbu|L7}g-ndekK9R~g?ZEI-&T7!cg43qB{pEvG7Z5+R@P*C@MzIiK zUQ=w|PNT1ZvhwFSIik)(ZaXzKRX1Ew7CWdnIm8SHqP=rT6m!3*F1UT`j4mc{c(VRB}tL3Aur=y7Z8XL^M=A-t>0yJ z4j1eO(?lQ|HV}4jg1K>CQO8I^;U3$k<(?wsDOXsa-WY|Ygnd2Zz#!Blww1@OtmIi& zY&Q~Y!SMAKf;mm04tLE=@re*>;pZ>i>>$D0eaFR^;f!bX?xlK3$ySRRWsVlT$y7y$ z*r%=zXiGA`N6*9Khf0eTn#4K^atAwIGyj#ST0FL&t7G@me%MrZm#5&d{iW-6;Sv6B zTYLj!a-at&TNOvYhw<#IClI<9O5*{_<=~2C>awOGvg$%pJyXwY+yH!$hC zdiv&Dt7^Pr3N2bet)LrjRv9=SlFlqVN1K?(@YB-AhHAeG_)CBgI>SjlI>W!mNjPc6zEC|+Km|l3FDvC$kFWkfQzO8(o)&| z-61b!*e;sqsjLXIK-I)McAdr;tj-KBHyiTO2b#0Dt{idZeqZ>}eY&H+A29z4+2%T% z6RfgcG%4g(v8oSs@L};KZBBeNsa#~q4Zl)F40S!{jw`YXfv^>JoTN_RQPU5V z=Exo>?c*z5Lll1KMju_BCe&kfHX6lFV`Sx&pX@~A-RDp3d@rtPx0I{XneCX;lh0Hg zlUopBxZ!TxCz8$MoB8_k*zfDN{_JI?@l=M|-r%HUB-KLGj$ z&=cLOMQwccNAR+n2I>GMT;{)o$5vkJj+R?9sWnokf!tT_x^qfbzRT1Ro!m24ji{5D z75kr#h%V}6&=g<}aU*@a>#&}Zs=u_5B7qwaF`Mh{&k0k7YU`eB4lO# z%eUUZS8c4a4L_|_iA5FqbZoq3ZPR#g`~hNTGnqoT!FMqd84}D~zVg+v^jFB{xQTL{ zlN5e2YB14;tu3Pf^nN~H;|q=sTl0~;3~@4&Z3Xh+5WKjTq~bGPb~Wp7+?^Musnpgz z6cO8O6~uhxfTPPcLd=U*SxR`N|}z36elYNnczC$X`YNO?a3)JE7*ied-%f#U~(1J zjVn-3T9~~q=g~Cl)dcEyn#8-4x@kawzJnX%jBBW05X?I>?W@M{si+{fYcY{cD)en) z$j<8d5X)v|BfGxD=~f)GuYxVZ*o|i79YY<<3tEr7?@DQsb}!4>ePQi+Y{b?xt9QB* zrj5t~Fd2}WOySW}@Af~H!zCo0_!!0oZ|LaIH&MZuC!UcFFO~BYurAv}i7yAO(pfuJy-5r5Pvd>|;#JmFTu9ls2))xUCf|ISLxBQI&c(_6 z$^w(ij-l|`mgzcmhQ&u>F_GlbLCjL~pMl4fLt})ewASl$Lj_=;dpL2L8~uj&l|0_TS7_+(9&&4<3wr*~nyUM}M3# ztPQA?EHX&*IFzeG&w4FhuQE*UO@f}m`jZUz1cEa%#BwmSVYQ`Ztf1WxGy9cbA40hG zSYDj}2PBZXJWy6d$jUoIzd)t3mh-l9QMb7FVd>q}u>PLxFZBrpKkAOaMEpU<-)4g# z)s5U0zf|H}MzF0OwDXBE@UBi_7SJ&@DAVO=7?$ zT`qz@|0^_k_vfuA47NoRML)BFI(EWdwG7l-&VfWZ1V9Igawy!VKD$@p0?^PTKnjTj zoEu2atlFyq66uCTp!ab%;9C#d12xb7kn`8Rl>ljjPwG zo+ywG{VTzpRJG5O1aIK;auI;ut!~GufIQoNsfQ%@wQSb^EdX36b8Y|mN5m4(4BZ9d z!2W>mB~kyArFvu>60C~M)`a98&rSV{dFoRIp{u&NHNYa^h1T!H^{3$L-j(=hU-@ug zf+nx^oXQ7JW+ASnirI7Y%sJ8#fERVGN=Ol?*lEqSGycW(`^|i;)6Qn&KYTL;`+jW> zyp!a)!Lq_IY(72RA0}*mf%94XUgBuutladT&vEc^u;Y*l-oLLSERcuJenoLl6>NZp=zQ2&yyKg2cVQ0{@WPesEjdKppTgKrZB|3Qe~9sv&eLBZ9|@AHyRQ zl$0bVj*A1RRg#7(2?Jl7>0WRF4MLl33YJlNeK&*SjYtcF%A)d>HsRM42RvI6rH1D1 z$nhI)2cHqae{efVb=vR<>eTcnpTqbcLV_x2$pX;Vto)a4xa(?ye>jl-nyX)lFRS%0 zu%@V801|09{;O9X+&24TKZ~;N8;!}IyTwl<)i)(&H{2wv>VkJcR_3{SGoO99k7k6y zGPU=)p1@4jQz?Xq#ezNWn)FHqlKvNh%Sp)$wl!z41Mq zG=|_tDuaVJnD4%Pu^?0#TBZ2U&fsR<&rQR=*}383PcVBE4D7yN8DmM*YTISdEV5UV znO6kiEcMsrHz`5>CA`C3K$Od7utIPsEG}+ty%A?`Iw#_naxniCStyZu{1MO=0#Zeb zv<$b3o~aje9hLc+xeiUt)}jtq5=fsW)f-k9!bzaLEwrTm>wZxG z1lnd-*mt~_;nLI6?#)aRP;=1cYSR5;)sqWypgm6`U3n8gsN`R&dBIm@e+WL5f0i+~ zA9Wlc8jt5A?>)r(MEFPZ#yMTqOB8-+8ZETd8s)pr&-HAACD9ybeJ(M$tN088|AwoQ zcW(D!A0G)huzV4>;Q=#1bB*~CXb@<})ff}U`x~sNDXQ3H>*^&Tah;^bAU3JpFP`(g zETT?;FiM>oG>8E$WCnLmvWkniR{ED(8^|=2uxmVjo` zTJTSZ9mFpTt(Thg7VB$-i`U^gP0g|oKp+l# zDsza#?n9HW0$wGo(3$gSR*-+>AJEzXv`DQY^BY!elyEHZo{V(;k`PQN#`W#!NjEX@ zi$#?_`Hw~4hI*Ys*YH^e_M)^aymY34rFZ(Y#q1ud;U}}Ic)MP_x()~4v)!Q#-w?!Q zvB}An*p<9u9Ijl?0*Ly9NT=Uk>TMSdv65PhJlje-nWZ-8E|A%GnLY>zFMyH zu?O4YNdA8gq`kkA{_wvT%Y8un!P^0vk<&i0^*=xO|7V-u?~N`Il0#8Qy@TeT_dE=1 zO4u13*prDAtx2SUjsGI4fluS&-ZMr%w9fPR76Y>vtUxx+%>4Q-aakb!_^kHlEWWxD zc1{sZ6GA~WibSP`fesI<_uW1LTF5IR&{2e`sP7*lY%?x0!sv*m!?f8iUqsXgGiQWx zx7dJ%#QhXa1I+Fn*6l#`@~7vAl=l`F-Sd4Rp8wpi%$tKLJ@|=F(gCLbpTGETPMrVu zlNb+0-F```9P)d$SMc83^!t>De^&az$Nk^T|38BPufC@b*3~~hli}R6SKIiotB=+H zzFN%!T1NE^%}Thh()o;zk*~viM!*-CPuo6wZ_&}9($z8g!e@C6{m*?m0VhN0VC*8j z{7V(C#2c_*o%6n9-nO?wCNj&4iX6|KVZ8>EwjchlZ!macYBK6?#ITG;NKgk*qyi8N zx@^!j^atP7rD3BlO_6mQUVDeK5A58He}=jDdi>UZd-OxUgXG(w7wiA6EAoHW2G}3m z-q-*20sONo5B|s}=`5IU7)-_nsBTihzBTVw+IwMJsZ^Xiq^M!Pn?0qv(;z$OKq0CdphxZ#L*ZhW_~v9QEJ;@N0d- zrd?!c(a@&>l;GK@u}k2aq@ar;F<{<(meo19b-ynRpOLHs0J4c3_ecS-43AX&pRy8r z!`T1w|6r2-ckQ!(XiEDZ3~KrRhLrv@r2jM9de3kD=Oe)D|ChVox0&oOS`cQa$|~F8 zwPjZtBZH*gGHpn8x9JBEfWPkic*c@cITz48i13dAjk17TJ};!pD`?xHO@9?An1SXh zdT^}*7bDksuU8caJV%BYC(;v}YZ!~HtXGW51hRAfHMIdqsdX;{l+)*qj`eaAt<@C> z8wD=El&=@}T4S4ze`|L-bo?a4$#T$&%hhv4%&zRiTPZj$JD4V_YT+(+Szz3?)>YZDpTNE;}t?i6Q%FJQDmt^cl^8b8sNuV+jsM08dLUlp4>j}}_K~hNfpf?jwL^YFY z`w5q0p^ImL=gwu+o#O{8S?p~$6=afuSY#ZYIo52jEYSSULY--++Z= z*?goO{7_iFf6!3zwItKW(UoV+8CaK4C;I03)W=!WTt>0}gT$sC{DJEu+@80AxpA&2r^Iax5if%fWtne1xg!tnd zl)1rU9_r2&lqKSqa4N13M;?5*QkL=|39oT{IA5W-bG6{{nR4#uu6$ep6*)Q2iN9y) zEoTfY;W}y4&aYq#*;k(FJgRF-xl*Va))r0?=X~qmHQ zugVlBvg+W5XT%_1a$zc}M|9+!F+`PhNtST?5)2XXi|k&^VnRV#OBL^+ByEn4#Fo7~ zPhD9z=-~(4S|%;)h{s^|S`6MnlL_N%+WN!GSvHdO$K-pAYO1^#J<{6C8IK?vYZ>NASBypB;_ajTLxc!+4k*)Z zpWGu+)E~sVkzRR9CJ_ zWDLd>qMkE6yhW^8LpfTG(9#gxvPCs6l1H06yKk3fP)(O2>_n1za^kvBHhSg>r7Fmc zLisqAF0r?MTD-l_G2gS9`%G5EYqpk4*u+Z|qBt$gF5Oht;DqK>LX9m^7k{*s6)hpe ztmPoV@T>@1JPNlX6_Wei`P?S5K24ODn9>{3R@(jIe#DTTZ5tn+@x+BSx>}k3p6NOs zH*1aQtWR|PzL^~yjAs9shhcrI=wd`8+2?NLHn~|OkU;hnAr5S#t1 z+E8w+2{2XmQkzcAf|eM)p2=1TovVqciM$DJbgvl6cO_f=t@PIqm~uiQ;Yc#~(SY1r z;aLl7izNv;zgcmJV_1{W!EBX2Q)SYu^(o#t_g{^jFEM9fE9$Ufn9{E%Bl;n8Ohulr zhI4^Gb#S`m?!z>8EoY*q&D;`e|LHdEsmArfa>q%o54_u@Gi(B07xx|XBmk8(XDfy?kI0{E|5AOG&4}XMW<+``;13Ur|nBafl^numXdvcWZ#QO4_=R_ z^XoiE{HR*gJe#>iF3{BWjupdNl9MkZ=iw)q)>i#mcB^%8=xBc%-Z|6m_ow5p8S3;b zx1Mb(9R6&BLBWmVP5u_uuq01r#dTrcTIt}cNc3qvPcP(Brgx~AG_y+vUq?3P7KQr{ z^In`pNQsjZ%-Qm2m8Tj}E0s4>d2BK&3K<6a7uOgkY$&H~G!8+3nr{bup5ObOGjrz5nRn(rXXfOeK$82u_g;JLwb#1Vwbw4n z&nvVfa2un>DhFo>q7yDg)dW>FSo71$qT+U?XOsd%(t5E)MTD6hr2s?WBC8A0#hbT` z=fC7dbQD+Pjpiyvv#KL@T+&AD`YLxT!@7$ih9a2uPggkIzj%nyLTpw4Dpwd6%2LQv zH_EEB_UGNX-e#$WGPn}MY$;qR{6xx9Wmp)`+HvK(&;XvYgrM;Pfg(4s@2A5UC61&J z$q%=coTxia{fchvuEZBSg`!UK4BUCj&KU5o|@BZJw??Y)<>c zC!8DFreE?T7}ArxXO7Rg?sAfhDMIE5wH&W$enukft?;@qQgeWy0^AY z2am8JuefoB8d#)W)_hDHl2}HUx7}K;ao~l51Cc0dfYR5qrW5Vnb8RgaRZn4(f%xh{qS5un`Xq%I1cj27?ylnPxq;`+L>YY(ir%J z4`^h;M4< z>c?Ql19q4>Z&=+sYyRVpS7HNj5LCHPAFcQtt=KNnZ0SB`J5K{Qux-`Jg-3!QLOsr_F=1POb!XQ%OJzEoaU0DN^|ApsTLK zo=ei3!z?uz=9;vxfS0^7((1FHJ~wShypNwV(s@K?j6lw`*Z|nAKLgRP2L9te#mXa; zn&uaI9MU>m>NA{V_~mo6;hY#WB2TYS!5SKvTH5C6$@Aw=^Tf_@z;=3av7KOj!9He{ zAEHN#@VBCK{VeEHO|3&fPb_z+3@p~a_Dj`dQ0gd+5I zY}Mk1-r^SnPQJ(YvYkdM?E+?fQ7qw6V+{edv>|JEPtfoOtgkq40RLohv{-Ni{v{og zPoE{a@(eXn*cEts;miVFT-{oI=`c zqLxnWuk!7j!3H7I#HY2N z3tJz@LIuhOp61!uYt)OZz=YWePR#l}lFpc^inl6ixzL=kI;~%Z+T< z3Lc%2V{UJj&1sE>yPJ^up6>{+&Ip7V8W=UY$c>TxdGJqD zu--x4#eX~d{{#a1p8+Wk@V7>%uf5j3)~%|4HMMc_rt|($(04r`G?xRk@gq7qvae4= zCWl$l^Y20qVHyD+Ak@>M0X>}Z$^nk>wB9cx4?kAxFuuD*j(5Q;xb-nMTU~Nl7l!Ls z`uBcUJo=&r9ZoE79R3I*bQ{4S>^2QR$>7EVCX>q>Xq3eEd`?=zKcelvco&=Po8g%Z zp!5w~Wd?k$+p2$!35qU{^`d<_D+0oH)?DpXWe!c_0dZ z_BuF5>E2&~$=?6C;gyrt#a75b0g?T5FqE26t5bsdCMK!icN+i5Le>{oXp_d^dtH&7 z{<9T3c(VQPxdlP7+#4>ue)qCh?J4qb#mEV4s^}qU_Md?)2fTzLt&&9NucL@8ZytFU;G^v{$S`U z31S@$VT;jxe#~paO_~$Tezow!HH`8-NZd=tlS?fZbO^G7W4ELARLb0)--6aM>6kot z9b!89^Z+xD;uUFU?{{pAPQ!OWGF+u;>Q-AX3kB|q0g>i~N07DZh=|)XWxj9!CbOi+ z!ioY=e~Q12K6hnF~ixa?RF-XnqXFgsYj)6^q=`j6r zlG^jY%a4jWxa~8=mV)*ox&FGXbz!SkRpx*Vt(t|_%l)-PJ8*lo0|G;^LdlcwM)_{K zDwGfZ52k6mg%?!^&(HAD8>?m2xC(Um$w8t^_Ieq$Hkc=u`&rWug!mt8w%q~}NZ1;f z!%@&Jq5B8=c}|o3CTn$&H$I##vNtKu|Cdn(&7DNfHFih6Azx z&Bz}p(R|@sdFLBJ06v&+yKIG<#Sm>SZw8L+;E_3_JN;q!00di=h0IBX7-n|!rO{Fy z_b1;8zI8GqH~Z54dh%CkQME=5Yp~1vyLTsT5{Q42W~2h2_;ihA7@p6X?94@rUJBY0 z+iD-Q%4`+uT(h}cZc~rz>ngfs)dmQ19fM9LVjk~zZ1gy{exV{6=0}_{2RHxoXiGbQ zfYmpPky$S~g3mAcOdHSlJ+G zuWP@SqQiX2yimNw$w{T%|83a4f zr=S0&2Pqkx=jl7IZM&zUKh;O+KdHkJ{=AS#D7R`~#lF0@oCpid{rmC&@O5{_+gq1IoHHUi;q^=>H-q`1g1JA6r!a z)4TtcoIeq)=^ zEN7bo{IhemSyuo>DfsFkkpg`CUArK%+>`tq23+=I5EW3e94wpQlkTO^7olHTlqAVr zrG{mQPag>EZ@EO^vw1d~PJ-vjJ_^%$1Dw3$m;MnY_(o35;qZBEagpFRO=16VRFdOM z-rO9XC(G5qfXfNE(6Yb(8NT2r?5Xw#9tmSB8`&?H`?oEQp&v=*2W|!BmBma(h0A1_ zg#Ig&p_i1W$@OuM@`j9xgA29)y^s$$!M`;-hsh6or^C+^M}ELnu>)rVTp(L6izfRs zjX6f-&OiD0x@j%oHbbudE&xt3C@K5zNc!lK`$KsbP8RW_f4QA%Ob2+`(HQdWGui*4 zlm>I~OWaik&!H^RJ5T1({fCDc%+X;qUu}|F0irX?8xC1*o%wf&IN18>vkOYd z35KgKa$`2fu73h2w1Zo`N}dMSfS1^k+$af69eLs0>xhVmxY$_aERVRj;jLSxMPPTl#HJ7U-Ju5${;>4`(vJXY)!l2r zWxp2Z7xykT`;(LDlRQ2DkE(#NGi7W+*X3WxbMf8Kl~svLOk4@gP7lDj zGC$qxx_A}PkSJZ_!?NY>Qv!)Wbm^{v$ADMn`OvUXZi%}kFtu-$%iU*i<}j+oq?Ys*z3SOk)tGzO`s{5&=(KSTVy){ zs}!7A@RtT099$}^izwle53d48%kr`#h^9QMLP%<-e@gBXE~pi9MArQYHcQSl3k+joN6S}`J_v#f@dq>A0 z?;V@Mpa~Dc%Ah__dT<1&1)D`DU2~E|rUE!idmvkW9X9u2Bt9)I2PJL9MO<*=Zy(Px z0})T=1sXX+Siwyq`!jd4!8x2!nR?EhDJZ0mkFx5+?mwg_&oxiGOrw$y@SxHlOYD9&_m-GNoGXD|<8Wtm-*d&6PW!M);XijYt5^7hD1bj%D#rP|6Xyi*eWT$%Wq+wgyml4gj=beJYs9M zG+4Cw)0z_F_Wa$PX8XEXxI}nwXeJm(CfY+o3#DVAmsnm`b#z>6x~bc6=aNP)SJ(ST zo)?bXthlOvmE*=|Dw(i2eX3tYr-KtL2)I+6{c&&JWWIiVYVJ0$H38cnYV(H?k3o@k z!jevm@{$>@u;*}Vrz=Fos;zIlG6 zK+`A}hzJsO$gB+JDZ19ri|W)?0aX?xee4otOUedp!MNjTJ+eAs5ZhO7Zf-&W+d|B& z@AA`pdb^_qW|qG6jGq?wwS>Je3lLVjbqmXS*5JK;XX=o87?*>jN!q15HVfsTY|*#a zn8cIc1FVkiVkxPmUCsd46Tu1a%S<+3}jiC|JE@m;5;W!N%jiF zOb)GQ!8LaAmO@Xkp!qawPU2tLQ$UO)XhiC_dxZ$X)2f+WN?PPv5jELRQcZFpY zNU`@SPQ=3}dTu2XWCVG*xeXEeHnt1BEfO|g9)bL6bp#@7tT-(D>BlVwn7D{i%-yw* zv>(=5C{|2zqI*F8HG*cN>9=8gv-*IgbN?@6#B0G({Q{j|e)BznRWtx%eF^LdB>Ch& za*}@#I#{zS`)a3XDe#E&^>Y*u7;tNlXSblcEnU6u_;brFqcG~Pd*Y==>?}4#O#POz z5`Mq0=8u)2KOJ^9;&xN zRj&Nr_jw>M4_7mJ9h`Ud^Pc%*gHYh7)>A^pA3l88A6*|mw>Qg`D82nOks&B&?U8P{ zo`pJPoyZEmS+@R@Z~ZF@QP{?3&*^OSF4@mDT+6@E4-8B~SJ1*bW?ob=!zlM1U2r3n ztJ2%a&0NZZ)lAm?5EPV^1x}$&x^FWgLN&Yt%xt*3s-0aSla492P+5hExOzO0&g0S0R}s{abdW~B!a_TV+u~4%wLyf}uHbs? z$j1tc6e8xi&9~HCuLFzX+BaX)WvFU&Ec1*$UjY-wfAmrGb7`y#m5*vwQC12ci+W-7LH6wSSh zkS1Zm({AlW@AOoAEWeeD7*LUEK=gh;>(E8z4rS`o`OON=hGYf`)VX}bV`NnP&OGEq zdx=Xwjc# zIszu)aJ^!SpJ!pAQH@7+y8luV&pIQ&|ISY|OD8GgN^GH-X(g0tYPjA|D`Rsoz28f> zH!tI7t)~7PO&`uh54)q1K=)u>y_iBpvR9SU(&r{DhLH$iOo|GKKXmHuB(nnguM4VzDuy%bci z>-x&8%QR&8n+3TJM9g;%?KpIyey!I7rmCuIX4arr+^(tYR;I1pK0Ik?U=LhJODiiZ zKl@OUO;aIQ0VI&?9I77`j-5Oqow_#Q)7PK6Jb^I}lW&Qim6uoG;fa_q9xv-QYtih_ z%G1cmlMd)T#`NX>C8Ig=;`C2Q)hM{NMbX|qtU34bvq)|HJ57Trx552o>XF-OJMUO8 z)X|=2D*n<IAmZGU9TpLFN@p@1XPysMFitUHV9eQEt~EOXUl26@pQ8H^%wuaL z(SFoApH$md1B+x`ps~A@C9GkgO>U4gL7i^@Q`?^Ih6Z8 zGVexV$1VGj%7sw!GKfX&1Dj5V?-E3o0FdC8Z$G1|@y2u-B@uaYVVB>Io~? zimH@Kg(aVlI2ycNdi53hs^4ZI9BeUq%_=%zSLoHoT!n)piuE$20}#wMO$i@9Oxu6b zxm@l}$2{BnhnG_fn-d-VBfqJwa$vrJ8P=gV!F@3_EDWd&4~VMV1d!JTzS?n83xiBx zslZCly;3cUnyn~7hax8Vn>;QD0S2V$ko^_RVb#>OBjny9P5heCtGs>(^L93<&fLya zPI#g2A$x_L1t(fQZM{Lt)t!&LHNi3#%`#$<5i1)jrm z)UK_$u%W!qm9_Oo`C&QAVaeynJxsY{lhAqT_7{|9oFXYOAb!4qG|f#E!<C_%6v)VFK{SI@5(Ro*oKC7C7LP#9^@Q7vR>xe{`FVJF z`U|wIc=*jR(tT3Sj=4TV;^IctJooovqM>sG@j-c{5^xB4pz(*xFHT)BsvI4?lFPiV zVvPAL^0sCwwd_q=Sk7$FJN<@lJPL-Cg2KXTzt0|a=g(nxTz-5vDn)eyagJ|Z7`x*f zlV^TD_s5q6*9+Hg-#uK*RedfcZ|-^L}Ot%?EUu!8pG(9vNB=Rgc-kFlbpn zs49`bZ~W`HzGFK2jfyjCc2*m!mYr0~j><;wb_M`w2!)TsepY#ZBI2zkrQ&CY0@ZG| z%S>h+#B;$3nKS+^e31jgn9j~C3(T1m*(SwV8c6}PT7EYn~XV%(S!~oo||`Z)k|wcj4v8 zZV}l1Ur}89G{iSIcVUioov;|&x6yqps6XOt;zIWM>#6OUt<9Pl3`@Nc&XF74Z4|ie z#lB-q!*c7^NV;{er9#i4oy&m*x4S~TA{qGU{H;t2$T$X|ha5ZPRb0{ICBbC(4SvV$ z)f5FyQ7BkiS?cPV6xHw4Asp$KE?khX&48z?;wn%-s&~cU&ndWQa5y;WEIT+ z<~r&FHU#NG=ZYnt#-fUpe+|^#&4-z(@qM`s0yU#jw|H%B?No>!On^n)#JSTvbFg98 z5E00yg{m-%SU!g^ZadqnR3C!))dde)9$fDTplJ}*kL`@oHA>W^P}bHi`&GNEtTWL8 z9lqt-S(h4Oi5&e?-lvR`=*!3aJU)2xR3?3nC?6fb4cN(uBZyTGxBCZwvd1crLbSqa zRpQgkv*V6aPqLg@rJ~|FL#6+gSCw=o23s}R!=$@m3O4PoTaB(jwa^`#UJcJhe6avz z;{@jW$j?HC8I3<*jHcDn-D0+hi}|aGQLb{D!V429XXIkpj+v0<$Jy`ZnQ_x}QX7q| zbVb|yJgQ%*p3%?MPeUJge-BEJzry9(npF3T)nm2y@=TP2-@f{F?V}^NzkGsUNR?WW<2T-Zw*4U^ z50%J=xSc0dR&L@a0xB7BnQrw4+4XLj+dVW2%)P}BF+4bPCaVnKVqxKHoRW~^AsB47 zs-0lvH5(q=sqd*@zduo+AH~Ps`lZq!1{e2c&q#>rg&YN zI1!X#767ZXw6qMvg@xB>M1+<(lLG{Ps*E!7yKSXqPXEuqU7v7wp9d)er+byV2C7iD ziPx@Qr(-nUqe2}!c_z-;Yo#GzO>eTP((|-+^Jm`Fg_>8Qb|~Hlq>&nj+!@gZp9Yp% z!UJ}H$?pMf9#ykJqhF~M=I%uGxQxJ6^IzlzF*9{r?F+Z;(GRD}g$Kj*7!&&QnXUw*glfkjctL&F(-A?L*O z`0aN;HikanyNb=%s0kdeEbqi=F}yHJOez$e)MbBOD6c2juoJ@ljk@Hd9TMnY?6V1XNoa z{zB8p2>#}YTLOm+Mpi?5vqI#Fv-ZmV^M0hFOw>iu!uF5z^9E{xkCM~}o$7rLEq{kp=I5a}GRCHrN2om59)tJ4K~xJVay=9Jpk2rXK`LV~b`* zGE%!Q)ujs)1(+8K>he)zCERlFQ-I`@h*HIp$t z$ShbfFtC9`tp>{N>L>K)^XB&4?3Ji10q9}0h9+YE;xbRM)D4Zx^|-JX-DKz)Vq5s9 zf_x@%qlK`Tue&5{t9-s;xNrm(fN@c>S==zz@!C+>dHh3TH!Af&Hr2#|TxAxV4V+ldV1@FK6 zB=n(85P4qbR}LC4v(-ts6Mm{MnO=p^cXms-_`0;TRsrALI4~#3vvI&XfD`-y@wUb< ziF$OPMHdnlpZ1Q5JI9582r&ff%$)J|_(OHd9#+K@8ql=v?l(`)zc2*xo5&N=$edZiyE=k(nIUm~l4-D~s@70KKf9j*2OtN8rik%w6i(AL&L za*`^Tqg5Radzs+5^j6w$4))z|878$qs&mg=s+~vHki9^0d?@GJcc?M4qv0emn=`I)64XW zW6C}w%5h*ZP7S%xqEM5{qs5K?I*iX+MFLEG@1%*kO5L`yB)jQ)L%a45japr8oc7C| z&%#R|Oh1AojRn2?Q6ql)86MbjvWXQJxhLsTeRQ<6yp8(qv)_8ZR8%TE>Qsl=k4H-l z*YO(ZV_icYAWJ}E?3nCTKGT{9hK7dt45UCk##?D?_w(lmEv>C^E4dJD?ROwD zZV8ZVMZk&;;C+@19a`!1~JEK2Unp%cf_M2-zIUtJQO)mCdC&XhVyojSs76d#a0;hPbcWS*Iw zeXZrQx7W3^1t@=_G;zTuWARyOEFEP}PbscnTxlXOHfO+9ib|n6td^Vtd{*W-WI5Ms zG?7FlI+kO4a-_;=q?9mZOc-B_A1)JDOp8|5RaTDJCaMi8)%#*E#+5~AkyhRfA8Tf4 zO}?3h+O>$mu6v)YTAezoZ^!%NvCZ843O*pqSh;MQxV};^9f$7r`}L~LW6UruO<98; zICHVmoishiV*StN$Lyk_lS?IXT2AH^ku$#_LOs|_k^DZS?&$J=Uv2021!4=QuBhBRG>VjVgd2KENV*@|>b$9`}bL0Nl=;Bzt=mV|u?DmBq zi*%T+efBOcZYeZQb!Gq97{=ZHOo`(bhoX5zd zyQti|*PyM_Hyr~ad|`@ly>5yAC{dCb|2+$fx1KEis9%;=i~jY)UJr|4)d52my&sH) zZ-}ezX-5}Td^4JtB27L?^IL_jDWa^5c)cb$I~$S!grD$b=ADlC0d4y*3RhE2-#PvQ z-FwH}F&328#)V%0u!?cxUV9YyD>6f5K4HdZTo%$&Qogu?gIAsy-}Md?%k5A&6!KZ zte7srvr1AsyF#XcLk4M5kKX`bAuKE|EQdVE!3P*>_va0z6{Ij?(0+Irtz9T| z`)lqQBu|X^BxR!K5`Qmkj1;mkW?#v+0eCe!Sy^lmuk3Px6R_2R&hM}0i`tzz^#?cDI6l2VlJ)(pj#&GE%@i_M>tVPz^CbjBB*^>w{9-n{6dv&z+QNkL6GbZrdnSYC`Lq?<$+Q)ISF6P98yB!p~ht7 za4cx$hSbd^F?#$siYV%jYL+?)wAxh2ZHGmQ*aV#J$_I>QVya)ie#LX=4pa`NYwBV` z$FSkqw=1tWW_h7^&(lIZ9eYqC=lN^W%(%$h3y_sPg!F}OZ7#2I6V*NCG}z1oHQDLV z`JZ_dl#C-rbp}q%O)EQbnltsa$0K&1e(Jqg=I$2vOWFb(_xXXM9qHMz;mUw~5H%?5 zmuTuvzh0&m!ho0ix8jUAj9X(HPFW^I^in!%pp9VYIz_s6v`Y9D_|zJ{B=x z+n8DI@i9%xyQHDBQ%mOwXP7z;>W4^q`THi>t2NeoI|+|@`O-z6%S4hUaz+qw0ZqbW z)2+K^shc#&8%sy(1iGbeGA6)B@(4!1HH&9E1IMTy5|m`V7v6}E>qig3hTro~1fUQO zc9U!P<{>7(8RXhPg0mYMRK2HCVD|EdH|+CtB$} z_7-;h*(7i^n1KWcmqz>GADx+c3A zm9hM>O^aS}2~B5ObFlF-n|#XI*h>cxKE0-^LPEMuznD-sEZCxhw&@!8Mfcoccs*R2 zuR9S`qi-`4fXEKHNgo!v@bZ`+Y-8V&-f_5aNJn(>RX10Ddn~$CMIDdRy{zJ9-pcuz z_ZHi|)mN+Pw(TLh11}0V((Sdz>@Vr0JRR%Xz&DF`5`Ias@o>YqKSSXOH@>xGOarD5 zLLb#@w|9c4yS-T}cUbF9&Nq$Q?Q_OA;SE`_&CS=A`S^72FTOV*l^Cdq_-+`Sz9RPU z(j~-()4gZXL&^Ces>F@uMD>xH3aekKDl|6?4chYp$D;W#L6hlw?IR6?NkLpR@=|+2 zTgkhP6~1BH5s{Ip%YFvIyfQN8{Aw2|#K|#_ZexB4c$1|C6N}wvnDW zxiXcn7^w-nvyUtNW2dB_>CKxw9o5Y|OIl%7m(S-iKjJffZ+k~oIm5tq#Ngz2= z)}Y8+3Y($+VEwER&e~?og&T@l6Siy5AryN&X>(n^9;8G;zbuuRz!gg72!ZlGhg2RR zt^47oKSOn9JALj4NG9^kd=WDp;8og_Sa%{la(fJdhY$6PpK%?pHTM=Loajq;f-O}x zxj`h;|cI}e8`Zpl=#?OtXFvPo#i+Wr!BAO zJ1F+bJ{or|u%r6u*Jf@-FLmmNm+Oa9rCr`fzw|6b`WaQ&g3~*2`nPbu-d;~F6bBfm zw#9YbS_u=7wn&>=9X2qq|0$btLXwT!Va~fRn;mztROPu}g&^u0G;J$mdf|JQmjgg{ z=&%Axenj5PqTGqxuV3x$>V& zX@rajh%@azsO)rdIrO;g-#RAz=cNbzG`;Qi2I(#0!SEkw!cM5`82<}RT7~0qnh016c2X;-yQzf!l33m}=^_r=%SB>MdnQ+R4{x)i`71 z4{cm%_EKORHGo}|R}KJ~P>sW&nu^d_$k)d&6P&v$m_H!U;iNN8B8Xp;2$ zaS^tdZe#_4OQbXSifRN3J>pD|+GMpgoLJ%n%#dd`P8$MsA7(2(*JoAxiho@r$Ko0o zlD*sGwi{6y-jPN%U%f_)V|}qGdp(^BVL^?-iD}Y~1O11)&<{n)L!9`%_3!jU_>t<) zwXFN$i(8W6l1(*ZJ9IbMPI@9-GOHEZ)d4s{yu;RCq z={RD^c)axdB$KNg=zTmUR%cGUEGlSbZ-+1U7${$s(?>H{SR}E~{ zc3pn!N;O=H&_x=rx-(-DKkQK)ew&FrZ}Rq?Vtq4Qi-8-0Nccn%#Njw(4oNYeoCZR>`!07b^Q`W_EV|y#P$V=dSagi*svV zPdfJ{Jr7^FLR{X~yH`=^3wE>|z4UuzAHsZM?@vGj18L{v^6UA`S`JlRmCu;_K%|iH zzithiyA3951{~#i|Lks$ozfa$rb&s-JgxV*$J(M0%8hbKl;Gg7|MK&muk|cn?k0}A z(VU8Ebq4x@?<(4H;iNi!VTDdFY;@HcDs)@sd-rC>n$T>!G0cSc!XdV=273g3gG^(n0#Muh=pLY$cv!Z%F1WF05g?1*(IERt5wD@F? zT0Cauo|NcvA%~W*eM>tOftf8;-s^!+=T8BU%;2=S3zp<1{ zZN4z@a(|aR(3ixaS|@i2I4U}L4x4>a?H>~Y@P_$i6lyfK;p4wXmija#KUH8pEEPdt zB6OXsHhC*^DRMrO9kLIE#XH!!Q!8+$r@K5VRsxr@K74p={kW(%gLGGo9M-sp#}sM{ z_ZXkV4N)OIh@#e*OW8HLrXPb+{D$#^Wxb|<m0;<*6uq=jAr8Qk^o|?($&Y023JY z0de94up*QhWDd-~^TGg3iG1z;I~vk>a4vD{k|RLJQR%QQzngb-?hMY%mzjM%m?-bX zJ1+V8Vgi%z?3`BnxQ&5*B$LTN)y_42N5}7z#c!{NJA8T5Wd9NtQ|nly5PdO=ERDx( zl8CFYf|73SWtpF(R~!z@y=>C=dfuK)wOeT@gN22~hvgV0p97ZXoF+&J+YhppcDl;! zzd@Cp6VKv`1+G%k?6;)ce3rWJD>$u5!u%Vf8d%;Lf7dW~sf}rCH|Et8^MnABKJynQ z!{yt{`&DO(_Rz{iXPtQ}(sli|Qmg=tIG!r(ihIC}b;cQ&5G`l|#Y?CZdI~%HYpDqw z)YZL*)t?jF$%NuxN56u>GYAVZU+i3$B28e3|u}wKKOW*#F)#7JbXQo z(E%Yf{)vx`O$)O;G3fKXD0v}#rL!mY>=WEae4#{*dzt$sW@f~7$s4-EqWnu$h=MQm z&NdSFHWEzu+Yh+oke>(pmLS2Omb&`P2L8AvLaF6_Ql%c3c-ClaN(m9P)Y3g_X`{iq zVjdvbw&=Vf*wYS0cC@=w)oXOt0|D={-c#Bw^x}*+ zqM3vh06N_hm(nJIBmi`*rW00a2gTe__;O3M;PIRUQE;Tv4fe65_jaORQb)6vK%xn= zAfm456NQ^o+5#WVg0IGm^(tdc;`eu+K{_x)lVo>uLrPw|2qxw1ogV`s`)X;>Dtl^> zNGwtjV4B=jb6NdzzVmU=Nq~Ha#jLIe@wv+dGe~rFbfG*ZK76>5o445;K-|AaMRj^z zp3D${*cKng|KXtaZ3if4fgyZ(E*ze`^x>g}h1QHqzlIEM`p3n&k>xRMZ90YvaQVpb zf$priMVC@q5z$fq$X#pB&LXKtFc$wm=j*GyU+n^-qg5Kt2wNIqvWfH$lJX|8riz3# zkxwMdEG#Q|h_GFOPy5%3D{|)Ma`W;cT5qkczGAw0Rf|;RofYlKh?3499Jl1>F(Fvq z%kA!yE(|n8SnU}-VMBE5Bn;N^!5X?frsw8(MMbOHZ-E0a(N@#LN1t@vC5A*hX8hcj zd<4)s@PZz$PG@qe%O|?Wyj0=tshs`mfP^P@?+T6b5Y;=_;_Wo&x5kM24peI9vtwPl zs;aMdwceNmcB8NnARVw3Yi_l(bb&l)A)9K$l&6h7<)*I)r((PSo#FHp%h1_xf%j>P_nlD#fCD(1s@DE>>;oZbF@6WDul(96cPYaYu5Xk~3yhXA z{fpV|6S?eLPWd{#W8-MQmlwx} z9!~v~(ZuTNl(>d9GSk5A~q`6agJ_Vp{%N>z(Zg)txV6#*j|xwu1s&5kI&jZ`=@m|^a3 zc=r&Phu;seq7vms5QUKB*X%cHd6SH;U^>#`CZQ_-w7U#mG$aewN2_gIx`VU$(xSfsybePxokT9nJyq&f#R3RIyDOHrq0X z5)A9@+jg)!BiSTbzQ6lk9S?iA z3)TExPum~)>eYF$-aNwIK@O|eZlc5A@0W`!TCi!$$z|hid*L1Thy>z*1P70aJ-zx( zY65W(BhYW^HJZ2mP)VsLsDV&?l!vUU6+(wYDlG(`y6w;O1czq2DvW0;GJ3P18%z(kdZ9AYq3LYzN^W`eoK+r)YVA^X&?Q-hKUM~uWqNAJ)eOs zCC6#xVYpP?xsT46uTXpYF^d&YtGVF&+f`hD?k22~>JhqNZ-?jrP_+Z98g-MPsHmcV zzFqx@@W=#&v@4`T?ocrNaGaz|>_y$5V6v=L5*%V9uQ_PyU+0Fe;DyqYz0d{LDl*;BskT9}))AMuD!{A;TDFxe8uZNfLwbSAi*!_fMfy?yxAEw# zfxUst^}e|aL1t-SoBz=k9=td7mi?i^OOWmCh$kJqYXMy)Bz;YygnwgmMN)IUY;Om> z9~o3wnmR45_h8BpBdyXUO?W>zwZ67S7^;EA0~C5c@Jm-0dCwCh^KT_$M!s)CHk*q~ z5=*qV5$s!#$Q&04m8huDB$jd!-?=lFO&2dB80at4|9GTpU{Fwz|7*EK zc`#;qR4FR!muJs!zL$)Qj8lE9SewP$Fl{4(6OoS(s;fIM-5Np814Di??xM*hG5Rfv z(VfOMCOY^ula)trk&Adq4j^RA?P|;?3y9<9*?=5rXEUkJ8QjacClrujel>CD zZaTE?sK15NhP?#U9OComTMB%Rpt00jli&&qvuaiaYv`C5~w? z)*J=gr&M3%WsFsf?T7-UG{fg|y}<@==ha_KB#r~hbIZY|IY@B(p{}BThi0<`ZfGb! ze5oH`fK5A>sKQBDlYV45v0K@$MW&TT4H0oKz-$X)7d9-teZNbZ6tYvwG2f|FC2pl( zWHM7R_Q#tbGsdYx9iJ9Eb-WH7MBgT-y;*l*bZTwP%FSJrThu1DPh|O*iXzp`N}0R6 zjeF8#ZJX6mLqj+~pvm0=4o%$Dc-ybVE%LEu7glJ+|BrmOpz#jp9H_ zZv*6_-Aj8d+iI}>bR^qJmUDGZ$TCXQw2K{rBPFVX~)>UW&M_2W!hn z@CJ0Oy9=JC9t&L7Hgg3*7?0DJ?i!G(05is8oJxAdCNuuecWaS8HQv*dQLMxc&!x>Q zk($BSIq6c%XNZP0$pV*^K$}2J=c+_*0I#X^G$!ui2;9GpKWKjn)t{?@kuavh50@$~ zk1(?x4@KaBGB80R88GE;GH||-qz_e^Db@G^WF5b z8~xaW8$)d-_@4$VAHR-5D-WR4{w|Cf2U~Bj+f|`^-yfNWkb4HvJtzqQDQLxE9gZ&DnacIWs7YMXy`NeflK4cT)GhKVO zO59rk3cld8IHax&T;wyrjFQTY_gmdIe&>83(6dZ6;$`0 z!DgR(2zD2cm*zSa=b*Fxl~2=le%QZ0=u5-lexNJOa;km#^+kn8sO6JDsWLM8Kcj&j zzX~9Mv>)roPhauQbKfCWjTPZRa(--MBT1jPwzl4Z z(F$CsqXz*(S0OdDv_7fNvTJymAftANMXZDBQPxc9o6I1m4L7(G;R563oNL5=N{DO# zfNSRGJJI?=qkrTR-o-kwmfQBo9r_`=oRTVSslzI=R}F5qCyMy$@#8??x3_J4U@QM7 zjT_na?=D-PzUc9!QBG?XMKeC2HfYWn^vxxMvU+h`67>5BoJGpdb{640pL^*J$OAk? zW?S_a2ZTt#lswI2u(#6u3fxs+pNM+@bF^)?h4oTy<*glh1|y!vKO+iV&HlhG)vpDl z$(da?&3xK}~S@>7~ygo>qXg1+qqtzp8xQS}Tp4I#v-#ejlmLY&< z^G1}G5s*#@ z5SnxdgkA&TPT-vH`xEZH&vWt;Frd&?CgP>YV~!1ibfa}q4E9m zfQcd}S2>9Um)eE~d7M~Lo)>C^IK&kQsx5gi?Jr3zf%qA4S#d72UyFbV@^EK@D_lDH zoET)9-uTMeT8+;-Rt&u{P_Vw9pdS~1h7D>Y)XCqPLdu+KHN1W8 zJiFUNC z>`t?9+5Rd@m?K%jVAsMzqhe}}uJa>hH8^>B5ySWudF^N4fBur4L@q7mZ0CL|>#QV2 zJpo=1&Z38JOnMpQq1iqFqXs)jOss+hpFIVC18ykeyTeZ&=SixYGi8N^on#_NwUtZs_6a?1X^SWqEVr@WEEM9tu?tct zMU7@ZZrNsewol-zS@wrXO354bxtpt!c?X5&+lRQcygCCvm5RlC(`c^qWgr&H&P~g? zvpJj(&hoZza;HXIxF0lyn`!Ix9yf*zzwJ_?)vucXcYVUxNTi#?qJVS0m*-<|%RHH5 z8E^~2h{hFoZzpY!ItRy3>?PjU*h_c-OmxpNGyi+bch9fTZ3ECXp?3;5NP5^j>dl?; zqkTp6R2|-gc)n0j90@C3#RqRW5HjS28;>v6)M$_Zh-nK)j%BUEj7Q zi(b69eH9FNA&|h_o3H?^ z$Loh_(kEq6+dBok#$Kumd@YEV?cXew))D|XKjXFq#-2GA*zq@JKLE7Ty0*o_Z$pG~ zmLsMKkw9aH5ECx%1?h#$vEd<4xHcZc00{}5-NUv*$-Vs>q2-x1`+qF6YjSDGZ6s`> zhV*Wow~XgECTe$I7R)2sXtWGkv|rUE(TS0cdwF=2YhAaoP*vStf0uVj<@>A&6VYZ@ z@zKad#`|$a2z#^ixY+nP5_`agjol-!?@=#UxdIo4OLXy|86QOCE{BmlehXD-Pqd%! zA2%lbxG_-fA&t!0&+YpL?jkt^P|1yu~LTi5IMO_6TlQQ6(d^YWQpUh zGXA@X376Dp(jEqSMgl@We$w|&f1?d>RZ$g}v@OJS{Zu(|<kKpTdQ&d@;0`Hd{?V*+&o1v zOa<~u+_RkQJE+H%7mx=4K2{*ANqhb$IiG@1)5_IkxIpNhiX=VQcXS;0w;A0Kf= zY)(!S4$?mV2+h?g0hfs0KX(oqm#Nw9(<>&$V_U5iTqk>t0!R&mUG~}EYf!xfasyr1 zGGE6tEJ7K*AAPPG)--iiRS0k|Ot^vSNsg*}X;eOPIQLvn;?^wvrlK&=MQd2aH&OlB9gGPxe0}eyBMwS4R0dwHM%$_CLFYT8$ zkOwdL`V}0jwr6i!2E=3(6eZ=Yxh)RF!>k6s3jv6RMy|~{b#|RH#P{zV1vbe@?L1~n z-sFUY1k>rgyx$EkD_Hgy7{TlgfDuuLc_f z6-ve1&1%Ac{{!HxIb2vwfzZW?gmiJzfYqqKoKRZLignYNuAq&bA~~8w2G7 zuoj0!p$;mJHiXRm6~L>Zp!$4qRmXl z1sJtA9nm7U(0h9>{vRz5zr)MwK`^|IqjB_xcmQ-qGP5sJe^Z>URrQxb!&9XSXW9)G z`rW49|7~0NW}{iKK9y_@;A^-~R?*A(xkS$*L(-=fj7k3R9xc|u{_o)5to5BieK19} zm3YzXsWE%EpkH-uu-uw23=lLEAm>J0_bRYk8YY1R(Qp&de=-nAggq>|=1_UIOxGnW z%qd?=2WgUh$McVxn&^{1S_fvB82uKt zSS1VW%t%_AF1lP!v|#kBIp*30J^^!|00{}?M^$95^$BSj+b@x8T;f2P(a@gM2*7>b z2T||8e)x>I^HW$F#Zf_tWnzvqp_nvhgK2%iXLDIF9v->ZaW40SSb=b`b9)wA4#`l~aC1X&4tk|st@6z@@mjva zhAn<2rC0UX>g-j6@vSWAE!)|cNss`chUBn`hr5l+bkoJt#I*RoLD+xJ(F*;!F+DgK z=sP6e4wv)a>9_LvE*n>RX%i4=O-jR#P^C*H>-ZSkIArUl*=Ri9+fj~Wf#@ua1lA0} zf1b?P`P!lGzTgt^^QXZurjuDm5s_sOTO6hl8j7VQ^9ovGOv;{sd>*SKKTt;mx7)ji zCVYlMG5H5;1vhrE$AJ5U6I>nu_~k*Aulz_a)I95Ko|9)@(#e7=mV7Jme8xq1$bGNWnrW$QuL6isATfqzc_qi=VBsr| z-Aqv*eca2#n%Z%W$CLR%W5>zYnNTh)loKi&P%oN`lNXR9@CEnJQRiDToK-*wSN;*T_p;AeUSY4tiGoh}~NW>AVuMe1N)}A~bOv&7H z&4Z-=gI8@G05?51_%zG*(&rrgK(dLxKIGC0h;ds8apZ(NW7~q1Bj-u8T05SllTGgM=f-Ul2AJIlxw#4&tU1EAIVZR0lPz3DO99-@) z$@6Q;dqo<`Sbs!=SnrC_z_M122%d1aE_v0%uF)?NQ!X>@&4drZj6P37J%GlFy9YO_q#x_xdd0gzi1Njl- zbisP>p6!GSfRJ~1rWC)bqxT{oS~ikpAM#YyuzKhCmw?@jdDg#xVSogvRtiXDZ!{HE z@LkP-w`!PH~8?qe({6Adyw zsMpAZm;0<66zZ4d^a_Q9$f5n_<5W*@i*U+czHB>WHTeZ{**3Y!w82-_Jw3jLO?q!h zi6>%gjDu_DnM82j)~g4gX-NMwt_Nr~Lh3YB^HUn47dSU{i*+umy^-mHhr0qT0#`hO z!su3z~(KhP(=tr&Rjb`@Xvz+`!}rqD^Mj`!fAlzE2r?s~IQxBIVF z)cxAee_qq!dMdlLbaXgD&dO=yRyg|E^u!Fx>NLXD2oyB{eGOY17?|SL)kNVUPt}rl zjB+XZS^txZe$mPM?4DDHz70HHU{B`B9pkv<!h|F$4bfpNuP?T~~y;q!v zAd@D!1FF{$Ce@1mJ6<>g=B4-r)X-d>`IHKeWHi7*S#Pgc&JFJ!(|sqz}S%d*WlXctSbxfV}eYASThC z9MJ`b8BmgV(#veWeuYbMle-HEbp}2Ime=PNS-?1Ctca#{9er@uS50 zsk-m7M#{m-Mm1bny!FotFRCr#PzNScR(#UV+naJsA4`Sx=$CN*qLW=Gd?uE5u9iBk zmv^b!g9jliOZ}JrSS-ypJ%jBCXjNWZ_IouxBn#m_3|j1^D5lP%D9flWd?2ew^`L$r zlMN?X)++?IAmF;Hy2_v{9FV!|8SqgsC{omzoF$4f`vKNbt8 zEi5b;BmC%iV3>g!toxr5Y_)*l?-g}T29hZ0TFZ-buzrS*~1Y#vs0t2R`C>1k?*AG@F><>p)|6MJD$jf{3@jA#Y zNgy~>t@GC?$=eY#hw8rK}4oi9t>l5yq!sR~Izgk#>a=N&j1xSD3)Vcwn z-%S&VNfGP;yfO3ypoaO{sTn=8H)qmyx$rC=bh-KGe7-59u)XZ$uvEesICp5AEtC_2x&0-TSc zq?Ye}lrJD|``GG^$E13;2fFtvnb06Q?&-5i`l=D&^J^f<=V$Zj(&DkK7qiqqemEe_AF!1T-Rj4aajG;qtO_$VR`FceQ3qvb!c&wFWodz$sEPQ=M!k2jR@ zshb{#!7pFa82hAXu0DwaWQ&faztb(cM~@%ed+*fRAIUERTo7Wi=xZ=8{?s0x!d{`? z)ZYm<8jakMSXfydw_<~q{b{Pvx8TGf?4D{im|GY!g|`{Uxcv?Jq?kC-C@(EI#KSC`KtOnk_DHrI@{Za;|NMpKU^5o{_pt?+1I5Dv?&vAXVGXiUnz=()?bnl{K~9ju?6Q{BW(Wj9 z(kTi5vcIMvGnnxuJ6jCvLP=omd<&Bb+#|?l=j70xxOeIm4y)*BQ6BiCDmM1n<_>CZ zYdl)_!4dliih-qb9#qMLu6>oVeH8^Dvg0cr3k>cgW6u^-|1P!eu(*O|p40m2Q$J|Q zGq0_NeFKY4KCiw3-FdN)`~rqpj+@w0z>d(eVwF4?P8(AfXvWtObXQpTDDyLLoziYk zeVy4M$ousfMjKLW!5LT(C#R4Ai?G4M<5pHrQLLLP?~q@1?Zh+7BHg(r2r9ZbT{CyX zegX-SJzZNZMJ@v~uxAhMsOdG=ERd(Fw$a3-&-cJ#P@%Ts#+1ZaaLFCJwG83kM1l0t zcwkDA1?UiNnJho^JiEBQo!0psag zH=Ef(hD=q^1|)lTHfupqF(LjvWoYV$V!JX7s5@340lCYj1O!sX&U@@OMr19r{NC=+ zS*(Jaa_RFbs1ne$gG3d-*ETXjD+l36 zHJ=bF21YT6$OB>hz@v z-c4PdUMQQdo$fkuNI^s612OR8A;uy7u!DLKC&F{by7{*rK^by~o41R6l;3?WMtfmJ zvLVD^D?yB#zeo%*cBTNj9t{fMKD){NNO3+gxqJ&L+pVF?T1}}H$8^!x0=vSit*qD- zT`KGLcM%k!Bz@|nb^bQ}WCwt6xIn?z8*ykrBG4_SU3yd2tz^fRpU}AO^izY=k#rTf z49D7%z@q@~GY6XXY6&%SYf&tX3jPl~_bCOTuUtlCYc+8yhojwIdL4 zZ4B`}`(jvnHMWma6VMo&dCt;3cF(PJ9RL( zak9AZ>DeToBRQ%Q^_kb z7xYtBiRMxPzm6emwTyQ7-B7ya=C-z?a&v7!@-u&tO-r@(3O3x-+ImJWE;l*ZC_5YY z*fUoB-);?jy{^?RvF+t8xL4x-$!9iBA07<~P#{G!2UL0D+baQ5DVZYH4ZixH+Iy>B z5$W}CTS^1qd(U&XfQn#e-$)8yT~@h>PcVWR)cSa-U~J+~FES_rHqK}z0-@}_z>+B9 zQ_gQ|$qX2;*VI8g3KT~dQe8@)tGoeqGj8DQOiWVg_v}RN08QQ?cedNK2k0#F@F^)j zcA`Fnsr=8^SCNiAHZm&hMd-~9664}?+&_InZ^yGTva&ubyB!Nq5H#B~=;bLxaF2hG zQ%S6T7;MIrk?K#T0g#)Lfysq&aZqwM)i3zEwpLeKV_5AI2YNly9D7;TQZlCwP$fX* zvFAy3ms`W6MM}#<`_`7tin!DT5}@h2ywthVbcaRSAp)rA98lhZ(Eq^L#ZFcBiFRsf z#xPxEEdaU;>OLdGr92OB^~$%$#w+fT*0H|f3HOhnzf2TOTF}#vF`Z!GG|9;LCD8Hh zRtv# z9?t-M1cjsR7X1aA;WB&M?E*a&WRS_<>;rK%c>Pm9yk|iu5xEb`7QyfBT%nGXUCRZ+rf`%0!En1nFd*%Ud{G$D?9{9<*1&zBxmt@TsZNOCt z#*J6&*IHFGrCHe7A#zmxBjP_$MrUyEF!3S`=ogV7Tb0*UML<@|d#Y9_6blJa=zTy; z@mkjxJW;c@#vk~LpYz@Bply1)mZqjIg_#OWm_!b zGKu@YUO_#7p9g>nrOI@0)%O|Ac#C~+ho|TeRW2rKn{>`oHi~uQ=_6ETC+ISS^kv?? zKS(8&N*o?}&u#ptj)Pt%TA2EJ?iRb@&&YP{$gn8_H@zzt_$Q#l`m+ciFsg`!}u;kge}q9BnlaH@MV(^`Qfi6L4HD;|3%QUbIh9qD#uF zaY+)Kk_Oz}KPV z@20a;tPbi%cE5Dxzs{*sG%RF|GE}!_!&(G9rQb|&fpL0+G@T8e}+F5^9t!vMo+p9Zk6oVX%;dCEB)?%e< zs_CoyMglI@Gqr&ZB*&;~ZV$F9cu}b*fSx&&>8EoXUQZ(HxF?Pc)CF5X6MWCjukT2u zL`yb)I%~-k_@WrM_9Z73D9gP-Hf}s#xNf?Ov(CM(?$^Ju%tdY{6!)%B1TYR>frp!z zpTDoXUo0mSrR0Dk|-2Yl)&y|=!9rtmN2e-B5+~{SSw51ju+12n5N)`<$z-tHd2-sv#sKbv&JAmcEX4F$VPi!COY|43)}u=J zSp$hQ)3D1{<&K~!BfiffuP?Q2%F41x!1Qh5X2*uR$kaZ{Gw_Fd>UuDSJ;n8=xXcGn zM-LAV+g#sbe1C(-n{bERdLg%*mV3nvW?Kvxx?6U#^Y{B>L&l_q=y6I4UFA%J^c$$)Ex3MP*2RFg|or6FF zcD>-HxHbrGU#dkH@q0RNpACu|BKu%)=JXd2)=kj+Cy2ssE7#xq>{!jWu(wiEN&qeO z>K=b#C=c{gIO`xX;$jHBOMe8*(G!Y9(cZ^PeS@$eqeiyKk=P0%yXS7WH2LY-cVpjo z{G9i`ha{M8>yv%zWkjo{cZzU+qiXERgn_Y)g8k8Rt1LSSd`iAGUw!{9Y;-09;YkI5K7 z0AqrY3D;laig9AZdJuQ|E~ZMyl>5685?AX9rnSQd6RQh>fYiDAmsXTrbNAa+uN8vW zT7}EPQcvzXm#C|fN#zTJAC8lWj$Hz3WbQ!8?2IeQSPiX(`cTt}t(j2AE59-9zLQqg zt89iYRN5F#yj0DNg}ttet7#S|wRgoF_V!v<{N0UW*#Sq!(6NPJ?Kw00*M^ODRmge% z6j+heF}Lq%q-6ZSe%YSbwYkMW3#oFGku#$9f7+#c1EdxRQL8wDNx=5XsUq>3-WsCH z{(8AzV0F}Y@Fg`>Z&-(`pSs}E|^pI&eDzEK*6yB8HXt-Vh=EuF@?ii18B zqB0|%z7hyo2%PV9M%|G13NT8S{QL&FZIpzZBJF^6&@=LR!wu@<&wooN?_lcZ-<`P4 zk=fU1ufM;Q|KRiDU<}tKEJluTeT64bawE}D1jeo-nVNgYzG}8n$TWOmq-Zx~q(w+e z+2<(Cb{k1vD=VF+Na%kB7LVT^-AiL>e)pLnW z(Y?3(iAY^(Pv-KG8DD?u#4yw9DFv?tgJbHtwR`r)wdLjwld~J*#Aa0g25SPOtC3au z{f7VShkNV|J4IDC_C6cpBhrh`%K_ZO-5Z`&o-f0f-(*XIWlK*91<}&iy81^iw_cR4 z_Et0uY($;7^Js$cDa>kuk%JfQ|BPOHy4QIqD!TA56ctIBTKatq4)Hd}E(@Wy`Zzct zY|#52iZDd6uv^&lMZ;F?#{_di<$Vlh1>SQxJI8?=u^VbQ#n}=)l3$x{qZEX&)6^i ziq>9ic+=G@z3l{DThj_{^6qxr*Fls07nOk>2!1vI)6r8eU#t?h_uFqgbrt2ey`^_M zGc{6IWw%f0LObln^ejD_iX59-!&-jR+~VB}1>KYJmeM4JpIlUQwy6$)52ZrE9Rz4mvf{Q z!HjtADBe@=k$H@UogvEeB@&0n6jqsACfzBXG_q?&&6}=GOSi|qd;jzAE80rcjxfFa zVGl=W&Nt#iHTFNXn2nGH{7%E$w2R`-r>GM5IjSyS+VVE2*a;KbwD%gRY;4dho*a%! z+00q+91)))OP=$WTG(0RQpn0X9~gaq`bWE;!_Pah*QqmYhsmVbNZ^w;0;Veij!B>M zn`&=VE=TVyI4ZF^?#iqWXG<>>^>*^h79CX!AiT6aL%K?CrWqmGk!Id@f4I?p21&|J zo3eeY=lR-9OW#vs@yw#X6?C|`+Vu*l{^Q7%GxZ!{VFWv*$>uLL>A3x2Z{X#;r1tTp z;nQ1V(E%>QI1m;GZ5M)jOpu(#xC*N)Z;$;;jn|Jz?7kAT3I+TeW>Axq+#v|Au%&in zKc5I(!rX>LskjQvZ^mO1X4{pKdu}o)UrX63Da^;V#-N&5$bLC6watBV^IV`_?`3n9 zHG`v6r*xISM4Zp9X;{m6=P=fe_Z$@V8T|1|ZSwmx*x!o#`;Plkd%uwFIT!a=xV9z# z>}~qHC~uV%?D#$stF7>pJNtUhLUedb0ZS@T=Fze#zFB-F%=r%tw1sy$7* z9R}PL%GHSRLRVC!v=Hd4CQ!7TGeY*nl0NOjQuaS|A{*9nF9xiA>~yVPAMev6oWfR= z4?64CNax&cAf;>&8j>suo%d7Uwz1P=k(iuw{(|ha#Xc!E>*yQbe3nYm2xy``)|Nf+ ztN?k^G}1w%kBr8UO7*NBX)hoH>*p7`k>!KinAxQtb4d!R?YP0>Rfeo~u(x)-p>9jF z5?GLU4+>GD^acrk{93ZzZ?V60J&V1iJ7Y{I{Qhm(ET)Ua>xL5KH=d@_e#02^lXcC0 zHM9k!@qu%Lo`C~PsRV`S=vi$_Km$52sw71v+A&?%H4-*Q8rx6%j|tS64Anl>oUZ6| z$34(bwpisuMP9v#1l&i@hj@#O+#Q;_pG<}=g+}fTiKGo_GPZR4p=hpY>Xuxpn|AnZ zE>1saIPPfZM)FPo$ORIi=IuqWY+`|jkhVRo_Oe4rgrM+ilA zhWTA0QCrOmojA@h*1tI^FlEM-!_x3NJ5Cod&+;h6(MKDFl*?PAL?1g3bVy>J+PKQS zHhgz+Leym8j82h>zW)nIKue8j>MktlcMEdY?x*clZ}Q^+{uTjKDW72njHfUIfoP;a zvK=5NbHpdjh&9$e8AN}YcYR7;&0wqhS?;hW-Y9oZ+++B25m~^o<>MC)masfd&Iee- zdF%%jJ7HbNMIA>rUB@#hkdMBnfApwyyM}hX&O_`-!g}->_;C}q05t}TvJPTVcFulf zAXhL_4DvNZWY%5oH|&9$b&`5f9Jvf z9NH7oHl*VB7&0`ge(^5DbV{f@P#(y-BH4U9h(nH->Eqk8Y`Y%h)f_|V#H_sPbJ8&= z&w>UWXV&4(A~zxPld#t?Jh4X9kqr6P;r~gPK~9 zBOjV*?!3$l;8Qd5z-H?r!p`l!ee(vKzrtKnOPkELf8XV+D?~{ofWT)V@iupTX||6| z&(a7k$2d(@EDw;3*4ACt*|?H}Wj^TDqFCx?h5IO$*87 z(E72SrGw`yOL@M3nn_hRsW>~9^4SF0I5YmR{?h2_6P#;?*t&L?hCN4{9J5tW z!^s=c8!u`?d`?w?vwb=dgDkk}IT{!!tY#FZp2w`waWrkOq;xV$T52(AY+1-Y-(RVk zR+?1NGcuCq;lC63<;zeeB0_8xX%#N8K-4mEgUKH0}CW)d1`eN(VyEM2%Ng zwB1NrHBPEVTkTqt5l?;UMEDQkJJlWo(aTimP-_jOVP+V3d!ukIJ5|tS?94JVgBeG8 z=h2)N)VZM0?W-V)R;~{O;55N3j)-q^j53~usn4ksqY~eY@iEJI@};=}n`c-`1N-mK z_ndR&Bj~$AC%<1(8Ih$z+uVxn)oKqvjwmZVcyCya#TA82Pks155m`pJ3=^FrKVb*((RYfZ+NY3#|iNKLRUlK1_+Ax0Y3w;EJ-L!NA z?8oOYZ9L?Vkc6ih;u*PiZJP(zkL`2|QbRpL=4j@Dz(DJIDA$xk zhR9U;IombPpe{(kqGxrh4t3(GU)@^tGRx+&CI$HvE6F+Vu*v#eb1lJ)GWkAm(}c2k z&Y%iLydtEOTIPqjVvi=n3YeSqQa%`=>)f~Am@8+gVt+IH)MbAwMPfEIWs2=6eeRSK zD61}JsU(@M4Icd2EGqtxs%#VCBaFGI%c3yK^du?Mn=&#j5T!jvmHk4yHoiRmW{^@o z3j6UWb&%$xwTgO*I&PiZd9aR7Paes1%r7^weO&^#d-QNNotf0Tp!8X;0GT5kVQ7RJ z5JRUjx+2YaglaUV0xanIP3f8A%tc#QnKiW4q8Baec8g0cajs=8ZT;2rcDj9=B?Wd(&iq73HGo74u!pacp}vl1NgX(6bZ># z)wCy6t6`LubBQVkYnH9`D!03-B$vL(g}-op|MZ&1C3f?^BJ*3=jWOl{`ACHr@HhXt=&2z_^Be7%izk7WGxK9{yUyxld zuqIWWE=$@__YF7dM5WeLc{IY3AdzmAd;BfjkUCMTRbElaS0xmD!_*tfH_-f8yKPpK zNKeDdnWJ#TwILQf*-=f(bNiZ}EaeJKK{!y~F%wx6F|dA8(jI%;tW(VYxtC9D8Y6W{ z2I{g#>>Y}k4l+>w;2PbRpij^651J>^r>U;ikv>Y6Qig`&rl`QnO||l;ix|tonsV5LO%T&1PiE6I3rvyy?!VplQ|BpK(2d zk(b{6L|pDeh(WpYk;JD~104Bt(Xw~+ZqA*DcU~e7t*L;&t2vl=Uh-wAp}&`?UpVUL z_9iqT?A-cmt*_VCv}@(b3FEn2zGVNK?^dp})eVMG?b#XLgzcNumaH&5*1I%^Qs0); zv6x>Jy3lOM3qCM|GLU~>4c0gR{W0h#WqOCNpt1jcrmVz&>+qjF{AUCI*}#7`@c+II u(5tgh0?R3vNm^8Wxl-gMRg literal 0 HcmV?d00001 diff --git a/docs/get_started.md b/docs/get_started.md index 7b8cf9e13..fcdd21fe7 100644 --- a/docs/get_started.md +++ b/docs/get_started.md @@ -4,7 +4,7 @@ ### Hardware -Before starting with Test Run, ensure you have the following hardware: +Before starting with Testrun, ensure you have the following hardware: - PC running Ubuntu LTS (laptop or desktop) - 2x USB Ethernet adapter (one may be a built-in Ethernet port) @@ -20,15 +20,9 @@ Ensure the following software is installed on your Ubuntu LTS PC: ## Installation -1. Download Test Run from the releases page or the appropriate source. +1. Download the latest version of Testrun from the [releases page](https://github.com/google/test-run/releases) -2. Run the install script. - -## Configuration - -1. Copy the default configuration file. - -2. Open the `local/system.json` file and modify the configuration as needed. Specify the interface names for the internet and device interfaces. +2. Install the package using ``sudo dpkg -i testrun_*.deb`` ## Test Your Device @@ -37,9 +31,11 @@ Ensure the following software is installed on your Ubuntu LTS PC: - Connect one USB Ethernet adapter to the internet source (e.g., router or switch) using an Ethernet cable. - Connect the other USB Ethernet adapter directly to the IoT device you want to test using an Ethernet cable. -2. Start Test Run. +2. Start Testrun. + +Start Testrun with the command `sudo testrun` - - To run Test Run in network-only mode (without running any tests), use the `--net-only` option. + - To run Testrun in network-only mode (without running any tests), use the `--net-only` option. - To skip network validation before use and not launch the faux device on startup, use the `--no-validate` option. @@ -49,5 +45,5 @@ If you encounter any issues or need assistance, consider the following: - Ensure that all hardware and software prerequisites are met. - Verify that the network interfaces are connected correctly. -- Check the configuration in the `local/system.json` file. +- Check the configuration settings. - Refer to the Test Run documentation or ask for further assistance from the support team. diff --git a/docs/network/add_new_service.md b/docs/network/add_new_service.md index 1ad07b60d..5f7b470cd 100644 --- a/docs/network/add_new_service.md +++ b/docs/network/add_new_service.md @@ -1,8 +1,8 @@ # Adding a New Network Service -The Test Run framework allows users to add their own network services with ease. A template network service can be used to get started quickly, this can be found at [modules/network/template](../../modules/network/template). Otherwise, see below for details of the requirements for new network services. +The Testrun framework allows users to add their own network services with ease. A template network service can be used to get started quickly, this can be found at [modules/network/template](../../modules/network/template). Otherwise, see below for details of the requirements for new network services. -To add a new network service to Test Run, follow the procedure below: +To add a new network service to Testrun, follow the procedure below: 1. Create a folder under `modules/network/` with the name of the network service in lowercase, using only alphanumeric characters and hyphens (`-`). 2. Inside the created folder, include the following files and folders: diff --git a/framework/python/src/common/session.py b/framework/python/src/common/session.py index edf3ce5da..638d213a8 100644 --- a/framework/python/src/common/session.py +++ b/framework/python/src/common/session.py @@ -17,7 +17,7 @@ import datetime import json import os -from common import util +from common import util, logger NETWORK_KEY = 'network' DEVICE_INTF_KEY = 'device_intf' @@ -29,6 +29,8 @@ API_PORT_KEY = 'api_port' MAX_DEVICE_REPORTS_KEY = 'max_device_reports' +LOGGER = logger.get_logger('session') + class TestRunSession(): """Represents the current session of Test Run.""" @@ -77,7 +79,10 @@ def get_config(self): def _load_config(self): + LOGGER.debug(f'Loading configuration file at {self._config_file}') if not os.path.isfile(self._config_file): + LOGGER.error(f'No configuration file present at {self._config_file}. ' + + 'Default configuration will be used.') return with open(self._config_file, 'r', encoding='utf-8') as f: @@ -113,6 +118,8 @@ def _load_config(self): self._config[MAX_DEVICE_REPORTS_KEY] = config_file_json.get( MAX_DEVICE_REPORTS_KEY) + LOGGER.debug(self._config) + def _save_config(self): with open(self._config_file, 'w', encoding='utf-8') as f: f.write(json.dumps(self._config, indent=2)) @@ -149,7 +156,7 @@ def get_max_device_reports(self): return self._config.get(MAX_DEVICE_REPORTS_KEY) def set_config(self, config_json): - self._config = config_json + self._config.update(config_json) self._save_config() def set_target_device(self, device): @@ -199,7 +206,6 @@ def get_all_reports(self): device_reports = device.get_reports() for device_report in device_reports: reports.append(device_report.to_json()) - return sorted(reports, key=lambda report: report['started'], reverse=True) def add_total_tests(self, no_tests): diff --git a/framework/python/src/core/testrun.py b/framework/python/src/core/testrun.py index 8eadcf441..e10c888ae 100644 --- a/framework/python/src/core/testrun.py +++ b/framework/python/src/core/testrun.py @@ -117,7 +117,6 @@ def __init__(self, # Start UI container self.start_ui() - # Build UI image self._api = Api(self) self._api.start() @@ -291,7 +290,6 @@ def start(self): self.get_net_orc().start_listener() self._set_status('Waiting for Device') LOGGER.info('Waiting for devices on the network...') - time.sleep(self.get_session().get_runtime()) if not (self._test_orc.test_in_progress() or @@ -384,19 +382,17 @@ def _device_stable(self, mac_addr): self._set_status('In Progress') result = self._test_orc.run_test_modules() self._set_status(result) + + def get_session(self): + return self._session def _set_status(self, status): self.get_session().set_status(status) - def get_session(self): - return self._session - def start_ui(self): LOGGER.info('Starting UI') - self._build_ui() - client = docker.from_env() client.containers.run( @@ -413,22 +409,6 @@ def start_ui(self): # TODO: Make port configurable LOGGER.info('User interface is ready on http://localhost:8080') - def _build_ui(self): - - # TODO: Improve this process - build_file = os.path.join(root_dir, - 'modules', - 'ui', - 'ui.Dockerfile') - client = docker.from_env() - - LOGGER.debug('Building user interface') - - client.images.build(dockerfile=build_file, - path=root_dir, - forcerm=True, - tag='test-run/ui') - def _stop_ui(self): client = docker.from_env() try: diff --git a/framework/python/src/net_orc/network_orchestrator.py b/framework/python/src/net_orc/network_orchestrator.py index d1fd9cdb0..975cde112 100644 --- a/framework/python/src/net_orc/network_orchestrator.py +++ b/framework/python/src/net_orc/network_orchestrator.py @@ -114,7 +114,7 @@ def start_network(self): """Start the virtual testing network.""" LOGGER.info('Starting network') - self.build_network_modules() + #self.build_network_modules() self.create_net() self.start_network_services() @@ -130,6 +130,7 @@ def get_listener(self): return self._listener def start_listener(self): + LOGGER.debug("Starting network listener") self.get_listener().start_listener() def stop(self, kill=False): @@ -329,7 +330,7 @@ def create_net(self): self.stop() sys.exit(1) - if os.getenv("GITHUB_ACTIONS"): + if os.getenv('GITHUB_ACTIONS'): self._ci_post_network_create() self._create_private_net() diff --git a/framework/python/src/net_orc/network_validator.py b/framework/python/src/net_orc/network_validator.py index 2a4112764..3866bd3ae 100644 --- a/framework/python/src/net_orc/network_validator.py +++ b/framework/python/src/net_orc/network_validator.py @@ -56,7 +56,7 @@ def start(self): util.run_command(f'chown -R {host_user} {OUTPUT_DIR}') self._load_devices() - self._build_network_devices() + #self._build_network_devices() self._start_network_devices() def stop(self, kill=False): diff --git a/framework/python/src/test_orc/test_orchestrator.py b/framework/python/src/test_orc/test_orchestrator.py index 94b0e4446..8fb0b1c85 100644 --- a/framework/python/src/test_orc/test_orchestrator.py +++ b/framework/python/src/test_orc/test_orchestrator.py @@ -65,7 +65,7 @@ def start(self): os.makedirs(DEVICE_ROOT_CERTS, exist_ok=True) self._load_test_modules() - self.build_test_modules() + #self.build_test_modules() def stop(self): """Stop any running tests""" @@ -85,9 +85,7 @@ def run_test_modules(self): self._session.stop() report = TestReport().from_json(self._generate_report()) device.add_report(report) - self._write_reports(report) - self._test_in_progress = False self._timestamp_results(device) @@ -128,6 +126,14 @@ def _generate_report(self): "%Y-%m-%d %H:%M:%S") report["status"] = self._calculate_result() report["tests"] = self._session.get_report_tests() + out_file = os.path.join( + self._root_path, RUNTIME_DIR, + self._session.get_target_device().mac_addr.replace(":", ""), + "report.json") + + with open(out_file, "w", encoding="utf-8") as f: + json.dump(report, f, indent=2) + util.run_command(f"chown -R {self._host_user} {out_file}") return report def _calculate_result(self): @@ -466,7 +472,7 @@ def _stop_module(self, module, kill=False): def get_test_modules(self): return self._test_modules - + def get_test_module(self, name): for test_module in self.get_test_modules(): if test_module.name == name: diff --git a/make/.gitignore b/make/.gitignore new file mode 100644 index 000000000..1be953b79 --- /dev/null +++ b/make/.gitignore @@ -0,0 +1,2 @@ +usr/ +bin/ \ No newline at end of file diff --git a/make/DEBIAN/control b/make/DEBIAN/control new file mode 100644 index 000000000..20463e996 --- /dev/null +++ b/make/DEBIAN/control @@ -0,0 +1,6 @@ +Package: Testrun +Version: 1.0 +Architecture: amd64 +Maintainer: Google +Description: Automatically verify IoT device network behavior +Depends: libpangocairo-1.0-0, openvswitch-common, openvswitch-switch, python3 diff --git a/make/DEBIAN/postinst b/make/DEBIAN/postinst new file mode 100755 index 000000000..929f9136c --- /dev/null +++ b/make/DEBIAN/postinst @@ -0,0 +1,36 @@ +#!/bin/bash -e + +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +echo Installing application dependencies + +TESTRUN_DIR=/usr/local/testrun +cd $TESTRUN_DIR + +python3 -m venv venv + +source venv/bin/activate + +pip3 install -r framework/requirements.txt + +# Copy the default configuration +cp -u local/system.json.example local/system.json + +deactivate + +# Build docker images +sudo cmd/build + +echo Finished installing Testrun diff --git a/modules/network/dhcp-1/dhcp-1.Dockerfile b/modules/network/dhcp-1/dhcp-1.Dockerfile index 49845cc3b..272405ccd 100644 --- a/modules/network/dhcp-1/dhcp-1.Dockerfile +++ b/modules/network/dhcp-1/dhcp-1.Dockerfile @@ -19,13 +19,13 @@ ARG MODULE_NAME=dhcp-1 ARG MODULE_DIR=modules/network/$MODULE_NAME # Install all necessary packages -RUN apt-get install -y wget +RUN apt-get update && apt-get install -y wget apt-transport-https -#Update the oui.txt file from ieee +# Update the oui.txt file from ieee RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ # Install dhcp server -RUN apt-get update && apt-get install -y isc-dhcp-server radvd systemd +RUN apt-get install -y --fix-missing isc-dhcp-server radvd systemd # Copy over all configuration files COPY $MODULE_DIR/conf /testrun/conf diff --git a/modules/network/dhcp-2/dhcp-2.Dockerfile b/modules/network/dhcp-2/dhcp-2.Dockerfile index e91465f36..dc6f6da2c 100644 --- a/modules/network/dhcp-2/dhcp-2.Dockerfile +++ b/modules/network/dhcp-2/dhcp-2.Dockerfile @@ -19,7 +19,7 @@ ARG MODULE_NAME=dhcp-2 ARG MODULE_DIR=modules/network/$MODULE_NAME # Install all necessary packages -RUN apt-get install -y wget +RUN apt-get update && apt-get install -y wget apt-transport-https #Update the oui.txt file from ieee RUN wget http://standards-oui.ieee.org/oui.txt -P /usr/local/etc/ diff --git a/modules/test/base/python/src/test_module.py b/modules/test/base/python/src/test_module.py index fe654decd..26a6decdf 100644 --- a/modules/test/base/python/src/test_module.py +++ b/modules/test/base/python/src/test_module.py @@ -119,7 +119,7 @@ def run_tests(self): 'name'] + ' failed - see result details for more info' else: test['result_description'] = test[ - 'name'] + ' Skipped - see result details for more info' + 'name'] + ' skipped - see result details for more info' test['end'] = datetime.now().isoformat() duration = datetime.fromisoformat(test['end']) - datetime.fromisoformat( diff --git a/modules/test/conn/python/src/connection_module.py b/modules/test/conn/python/src/connection_module.py index 779dd7d4c..558748bbd 100644 --- a/modules/test/conn/python/src/connection_module.py +++ b/modules/test/conn/python/src/connection_module.py @@ -194,7 +194,7 @@ def _connection_ipaddr_ip_change(self): result = None, 'Device has no current DHCP lease' # Restore the network self._dhcp_util.restore_failover_dhcp_server() - LOGGER.info("Waiting 30 seconds for reserved lease to expire") + LOGGER.info('Waiting 30 seconds for reserved lease to expire') time.sleep(30) self._dhcp_util.get_new_lease(self._device_mac) else: @@ -281,7 +281,6 @@ def _connection_ipv6_slaac(self): def _connection_ipv6_ping(self): LOGGER.info('Running connection.ipv6_ping') result = None - if self._device_ipv6_addr is None: LOGGER.info('No IPv6 SLAAC address found. Cannot ping') result = None, 'No IPv6 SLAAC address found. Cannot ping' diff --git a/modules/test/nmap/python/src/nmap_module.py b/modules/test/nmap/python/src/nmap_module.py index 6bcbd141a..94597f03e 100644 --- a/modules/test/nmap/python/src/nmap_module.py +++ b/modules/test/nmap/python/src/nmap_module.py @@ -109,10 +109,10 @@ def _check_unknown_ports(self,tests,scan_results): for test in tests: if "tcp_ports" in tests[test]: for port in tests[test]['tcp_ports']: - known_ports.append(port) + known_ports.append(port) if "udp_ports" in tests[test]: for port in tests[test]['udp_ports']: - known_ports.append(port) + known_ports.append(port) for port_result in scan_results: if not port_result in known_ports: @@ -134,7 +134,7 @@ def _add_unknown_ports(self,tests,unallowed_port): LOGGER.info("Unknown Port Service: " + unallowed_port['service']) for test in tests: LOGGER.debug("Checking for known service: " + test) - # Create a regular expression pattern to match the variable at the + # Create a regular expression pattern to match the variable at the # end of the string port_service = r"\b" + re.escape(unallowed_port['service']) + r"\b$" service_match = re.search(port_service, test) @@ -166,7 +166,6 @@ def _check_scan_results(self,test_config,scan_results): if "udp_ports" in test_config: port_config = test_config["udp_ports"] self._check_scan_result(port_config=port_config,scan_results=scan_results) - def _check_scan_result(self,port_config,scan_results): if port_config is not None: @@ -213,16 +212,16 @@ def _check_unallowed_port(self,unallowed_ports,tests): version = None service = None for port in unallowed_ports: - LOGGER.info('Checking unallowed port: ' + port['port']) - LOGGER.info('Looking for service: ' + port['service']) - LOGGER.debug('Unallowed Port Config: ' + str(port)) - if port['tcp_udp'] == 'tcp': - port_style = 'tcp_ports' - elif port['tcp_udp'] == 'udp': - port_style = 'udp_ports' + LOGGER.info("Checking unallowed port: " + port["port"]) + LOGGER.info("Looking for service: " + port["service"]) + LOGGER.debug("Unallowed Port Config: " + str(port)) + if port["tcp_udp"] == "tcp": + port_style = "tcp_ports" + elif port["tcp_udp"] == "udp": + port_style = "udp_ports" for test in tests: - LOGGER.debug('Checking test: ' + str(test)) - # Create a regular expression pattern to match the variable at the + LOGGER.debug("Checking test: " + str(test)) + # Create a regular expression pattern to match the variable at the # end of the string port_service = r"\b" + re.escape(port['service']) + r"\b$" service_match = re.search(port_service, test) @@ -247,7 +246,7 @@ def _check_unallowed_port(self,unallowed_ports,tests): for u_port in self._unallowed_ports: if port['port'] in u_port['port']: self._unallowed_ports.remove(u_port) - break + break break def _check_version(self,service,version_detected,version_expected): @@ -259,8 +258,8 @@ def _check_version(self,service,version_detected,version_expected): result. """ LOGGER.info("Checking version for service: " + service) - LOGGER.info("NMAP Version Detected: " + version_detected) - LOGGER.info("Version Expected: " + version_expected) + LOGGER.info("NMAP Version Detected: " + version_detected) + LOGGER.info("Version Expected: " + version_expected) version_check = None match service: case "ssh": @@ -355,12 +354,12 @@ def _scan_udp_ports(self, tests): def _nmap_results_to_json(self,nmap_results): try: - xml_data = xmltodict.parse(nmap_results) - json_data = json.dumps(xml_data, indent=4) - return json.loads(json_data) + xml_data = xmltodict.parse(nmap_results) + json_data = json.dumps(xml_data, indent=4) + return json.loads(json_data) except Exception as e: - LOGGER.error(f"Error parsing Nmap output: {e}") + LOGGER.error(f"Error parsing Nmap output: {e}") def _process_nmap_json_results(self,nmap_results_json): LOGGER.debug("nmap results\n" + json.dumps(nmap_results_json,indent=2)) @@ -369,10 +368,10 @@ def _process_nmap_json_results(self,nmap_results_json): ports = nmap_results_json["nmaprun"]["host"]["ports"] # Checking if an object is a JSON object if isinstance(ports["port"], dict): - results.update(self._json_port_to_dict(ports["port"])) + results.update(self._json_port_to_dict(ports["port"])) elif isinstance(ports["port"], list): - for port in ports["port"]: - results.update(self._json_port_to_dict(port)) + for port in ports["port"]: + results.update(self._json_port_to_dict(port)) return results def _json_port_to_dict(self,port_json): @@ -387,4 +386,4 @@ def _json_port_to_dict(self,port_json): if "@extrainfo" in port_json["service"]: port["version"] += " " + port_json["service"]["@extrainfo"] port_result = {port_json["@portid"]:port} - return port_result \ No newline at end of file + return port_result diff --git a/modules/ui/.gitignore b/modules/ui/.gitignore index 0711527ef..57fa6bf61 100644 --- a/modules/ui/.gitignore +++ b/modules/ui/.gitignore @@ -1,3 +1,7 @@ +node_modules/ +.angular/ +dist/ + # See http://help.github.com/ignore-files/ for more about ignoring files. # Compiled output @@ -39,4 +43,4 @@ testem.log # System files .DS_Store -Thumbs.db +Thumbs.db \ No newline at end of file diff --git a/modules/ui/conf/nginx.conf b/modules/ui/conf/nginx.conf new file mode 100644 index 000000000..ade6ad17a --- /dev/null +++ b/modules/ui/conf/nginx.conf @@ -0,0 +1,13 @@ +events{} +http { + include /etc/nginx/mime.types; + server { + listen 80; + server_name localhost; + root /usr/share/nginx/html; + index index.html; + location / { + try_files $uri $uri/ /index.html; + } + } +} \ No newline at end of file diff --git a/modules/ui/src/app/app.component.html b/modules/ui/src/app/app.component.html index de0baf85f..2edb798b0 100644 --- a/modules/ui/src/app/app.component.html +++ b/modules/ui/src/app/app.component.html @@ -24,6 +24,7 @@