Merge dev into main (release v1.3)

.github/workflows/testing.yml

@@ -30,7 +30,7 @@ jobs:
     permissions: {}
     name:  API
     runs-on: ubuntu-20.04
-    timeout-minutes: 40
+    timeout-minutes: 60
     steps:
       - name: Checkout source
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
@@ -76,7 +76,7 @@ jobs:
     - name: Install Node
       uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
       with:
-        node-version: 18.13.0
+        node-version: 18.18.0
     - name: Install Chromium Browser
       run: sudo apt install chromium-browser
     - name: Install dependencies
@@ -99,7 +99,7 @@ jobs:
     - name: Install Node
       uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
       with:
-        node-version: 18.13.0
+        node-version: 18.18.0
     - name: Install dependencies
       run: npm install && npm ci
       working-directory: ./modules/ui

.gitignore

@@ -14,6 +14,7 @@ testing/unit/ntp/output/
 testing/unit/tls/output/
 testing/unit/tls/tmp/
 testing/unit/report/output/
+testing/unit/risk_profile/output/
 
 *.deb
 make/DEBIAN/postinst

README.md

@@ -18,17 +18,27 @@ Testrun creates an isolated and controlled network environment on a linux machin
 
 Two modes are supported by Testrun:
 
-1) <strong>Automated testing</strong>
+<details>
+  <summary>
+    <strong>Automated testing</strong>
+  </summary>
 
 Once the device has become operational (steady state), automated testing of the DUT (device under test) will begin. Containerized test modules will then execute against the device, one module at a time. Once all test modules have been executed, a report will be produced - presenting the results.
+</details>
 
-2) <strong>Lab network</strong>
+<details>
+
+  <summary>
+    <strong>Lab network</strong>
+  </summary>
 
 When manual testing or configuration changes are required, Testrun will provide the network and some tools to assist an engineer performing the additional testing. This reduces the need to maintain a separate but identical lab network. Testrun will take care of packet captures and logs for each network service for further debugging.
 
+</details>
+
 ## Minimum requirements :computer:
 ### Hardware
- - PC running Ubuntu LTS 20.04 or 22.04 (laptop or desktop)
+ - PC running Ubuntu LTS 20.04, 22.04 or 24.04 (laptop or desktop)
  - 2x USB ethernet adapter (One may be built in ethernet)
  - Internet connection
 ### Software
@@ -43,10 +53,10 @@ Once you have met the hardware and software requirements, you can get started wi
 Testrun will constantly evolve to further support end-users by automating device network behaviour against industry standards. For further information on upcoming features, check out the [Roadmap](docs/roadmap.pdf).
 
 ## Accessibility :busts_in_silhouette:
-We are proud of our tool and strive to provide an enjoyable experience for all of our users. Testrun goes through rigorous accessibility testing at each release. You can read more about [Google and Accessibility here](https://www.google.co.uk/accessibility). You are welcome to submit a new issue and provide feedback on our implementations.
+We are proud of our tool and strive to provide an enjoyable experience for all of our users. Testrun goes through rigorous accessibility testing at each release. You can read more about [Google and Accessibility here](https://www.google.co.uk/accessibility). You are welcome to submit a new issue and provide feedback on our implementations. To find out how Testrun implements accessibility features, you can view a [short video here](docs/ui/accessibility.mp4).
 
 ## 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.
+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/google/testrun/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.
@@ -74,8 +84,4 @@ The contributing requirements can be found in [CONTRIBUTING.md](CONTRIBUTING.md)
 
 4) Can I run Testrun on a virtual machine?
 
-  Testrun can be virtualized if the 2x ethernet adapters are passed through to a VirtualBox VM as a USB device rather than managed network adapters. A full guide will be provided once virtualization of Testrun has been fully tested.
-
- 5) 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.
+  Testrun can be virtualized if the 2x ethernet adapters are passed through to a VirtualBox VM as a USB device rather than managed network adapters. You can view the guide to working on a [virtual machine here](docs/virtual_machine.md).

cmd/install

@@ -47,13 +47,6 @@ pip3 install -r framework/requirements.txt
 # Copy the default configuration
 cp -n local/system.json.example local/system.json
 
-# Set file permissions on system config
-# This does not work on GitHub actions
-if logname ; then
-  USER_NAME=$(logname)
-  sudo chown "$USER_NAME" local/system.json
-fi
-
 # Exit out of python virtual environment
 deactivate
 
@@ -63,5 +56,13 @@ sudo cmd/build
 # Create local folders
 mkdir -p local/devices
 mkdir -p local/root_certs
+mkdir -p local/risk_profiles
+
+# Set file permissions on local
+# This does not work on GitHub actions
+if logname ; then
+  USER_NAME=$(logname)
+  sudo chown -R "$USER_NAME" local
+fi
 
 echo Finished installing Testrun

cmd/package

@@ -17,7 +17,13 @@
 # Creates a package for Testrun
 
 MAKE_SRC_DIR=make
-TESTRUN_VER="1-2-2"
+MAKE_CONTROL_DIR=make/DEBIAN/control
+
+# Edit the version in make/DEBIAN/control
+version=$(grep -R "Version: " $MAKE_CONTROL_DIR | awk '{print $2}')
+
+# Replace invalid characters
+version="${version//./_}"
 
 # Delete existing make files
 rm -rf $MAKE_SRC_DIR/usr
@@ -46,8 +52,9 @@ cp -r resources $MAKE_SRC_DIR/usr/local/testrun/
 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
+# Create device repository and risk profiles database
 mkdir -p $MAKE_SRC_DIR/usr/local/testrun/local/devices
+mkdir -p $MAKE_SRC_DIR/usr/local/testrun/local/risk_profiles
 
 # Copy root_certs folder
 mkdir -p local/root_certs
@@ -60,7 +67,7 @@ cp -r {framework,modules} $MAKE_SRC_DIR/usr/local/testrun
 dpkg-deb --build --root-owner-group make
 
 # Rename the .deb file
-mv make.deb testrun_${TESTRUN_VER}_amd64.deb
+mv make.deb testrun_${version}_amd64.deb
 
 # Echo package version
-echo Created installation package at testrun_${TESTRUN_VER}_amd64.deb
+echo Created installation package at testrun_${version}_amd64.deb

cmd/prepare

@@ -20,6 +20,6 @@
 echo Installing system dependencies
 
 # Install system dependencies
-sudo apt-get update && sudo apt-get install openvswitch-common openvswitch-switch python3 libpangocairo-1.0-0
+sudo apt-get update && sudo apt-get install openvswitch-common openvswitch-switch python3 libpangocairo-1.0-0 ethtool
 
 echo Finished installing system dependencies

docs/README.md

@@ -0,0 +1,18 @@
+<img width="200" alt="Testrun logo" src="https://user-images.githubusercontent.com/7399056/221927867-4190a4e8-a571-4e40-9c2b-65780ad9264c.png" alt="Testrun">
+
+
+## Contents
+
+ - [Get Started](get_started.md)
+ - [Network](network/README.md)
+   - [Network Overview](network/README.md)
+   - [How to identify network interfaces](network/identify_interfaces.md)
+   - [Addresses](network/addresses.md)
+   - [Add a new network service](network/add_new_service.md)
+ - [Testing](test/README.md)
+   - [Test modules](test/modules.md)
+   - [Test statuses](test/statuses.md)
+ - [Development](dev/README.md)
+   - [Running on a virtual machine](virtual_machine.md)
+   - [Accessibility](ui/accessibility.mp4)
+   - [Roadmap](roadmap.pdf)

docs/configure_device.md

@@ -1,4 +1,6 @@
-# Device Configuration
+<img width="200" alt="Testrun logo" src="https://user-images.githubusercontent.com/7399056/221927867-4190a4e8-a571-4e40-9c2b-65780ad9264c.png" alt="Testrun">
+
+## Device Configuration (Deprecated)
 
 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.