Merge dev into main (Sprint 7 and 8)

.gitignore

@@ -3,5 +3,5 @@ venv/
 .vscode/
 error
 pylint.out
-local/
-__pycache__/
+__pycache__/
+build/

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

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() {

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.

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.

framework/python/src/common/logger.py

@@ -0,0 +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.
+
+"""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]

net_orc/python/src/util.py → framework/python/src/common/util.py

@@ -1,41 +1,55 @@
-"""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])

framework/python/src/core/device.py

@@ -0,0 +1,27 @@
+# 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 net_orc.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
+  test_modules: str = None