Release v1.4 into main

.github/workflows/package.yml

@@ -7,9 +7,13 @@ on:
   push:
     branches:
       - 'dev'
+      - 'release/*'
+
+permissions:
+  contents: read
 
 jobs:
-  testrun_package:
+  create_package:
     permissions: {}
     name: Package
     runs-on: ubuntu-22.04
@@ -24,4 +28,64 @@ jobs:
         uses: actions/upload-artifact@694cdabd8bdb0f10b2cea11669e1bf5453eed0a6 # v4.2.0
         with:
           name: testrun_package
-          path: testrun*.deb
+          path: testrun*.deb
+
+  install_package_20:
+    permissions: {}
+    needs: create_package
+    name: Install on Ubuntu 20.04
+    runs-on: ubuntu-20.04
+    timeout-minutes: 15
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Download package
+        uses: actions/download-artifact@v4
+        with:
+          name: testrun_package
+      - name: Install dependencies
+        shell: bash {0}
+        run: sudo cmd/prepare
+      - name: Install package
+        shell: bash {0}
+        run: sudo apt install ./testrun*.deb
+
+  install_package_22:
+    permissions: {}
+    needs: create_package
+    name: Install on Ubuntu 22.04
+    runs-on: ubuntu-22.04
+    timeout-minutes: 15
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Download package
+        uses: actions/download-artifact@v4
+        with:
+          name: testrun_package
+      - name: Install dependencies
+        shell: bash {0}
+        run: sudo cmd/prepare
+      - name: Install package
+        shell: bash {0}
+        run: sudo apt install ./testrun*.deb
+
+  install_package_24:
+    permissions: {}
+    needs: create_package
+    name: Install on Ubuntu 24.04
+    runs-on: ubuntu-24.04
+    timeout-minutes: 15
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Download package
+        uses: actions/download-artifact@v4
+        with:
+          name: testrun_package
+      - name: Install dependencies
+        shell: bash {0}
+        run: sudo cmd/prepare
+      - name: Install package
+        shell: bash {0}
+        run: sudo apt install ./testrun*.deb

.github/workflows/scorecard.yml

@@ -7,10 +7,6 @@ on:
   # For Branch-Protection check. Only the default branch is supported. See
   # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
   branch_protection_rule:
-  # To guarantee Maintained check is occasionally updated. See
-  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
-  schedule:
-    - cron: '20 6 * * 4'
   push:
     branches: [ "main" ]
 
@@ -70,4 +66,4 @@ jobs:
       - name: "Upload to code-scanning"
         uses: github/codeql-action/upload-sarif@1b1aada464948af03b950897e5eb522f92603cc2 # v3.24.9
         with:
-          sarif_file: results.sarif
+          sarif_file: results.sarif

.github/workflows/testing.yml

@@ -39,7 +39,7 @@ jobs:
         run: cmd/prepare
       - name: Install Testrun
         shell: bash {0}
-        run: TESTRUN_DIR=. cmd/install
+        run: cmd/install -l
         timeout-minutes: 30
       - name: Run tests
         shell: bash {0}
@@ -55,6 +55,28 @@ jobs:
           name: runtime_api_${{ github.run_id }}
           path: runtime.tgz
 
+  testrun_unit:
+    permissions: {}
+    name:  Unit
+    runs-on: ubuntu-20.04
+    timeout-minutes: 15
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Install dependencies
+        shell: bash {0}
+        run: cmd/prepare
+      - name: Install Testrun
+        shell: bash {0}
+        run: cmd/install -l
+      - name: Build Testrun
+        shell: bash {0}
+        run: cmd/build
+        timeout-minutes: 10
+      - name: Run tests
+        shell: bash {0}
+        run: bash testing/unit/run.sh
+
   pylint:
     permissions: {}
     name:  Pylint

.gitignore

@@ -8,13 +8,15 @@ build/
 
 # Ignore generated files from unit tests
 testing/unit_test/temp/
+testing/unit/conn/output/
 testing/unit/dns/output/
 testing/unit/nmap/output/
 testing/unit/ntp/output/
 testing/unit/tls/output/
 testing/unit/tls/tmp/
 testing/unit/report/output/
 testing/unit/risk_profile/output/
+testing/unit/services/output/
 
 *.deb
 make/DEBIAN/postinst

README.md

@@ -47,7 +47,7 @@ When manual testing or configuration changes are required, Testrun will provide
  - DHCP client - The device must be able to obtain an IP address via DHCP
 
 ## 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).
+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). Further docs are available in the [docs directory](docs)
 
 ## Roadmap :chart_with_upwards_trend:
 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).
@@ -59,7 +59,7 @@ We are proud of our tool and strive to provide an enjoyable experience for all o
 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.
+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. After that, check out our [developer documentation](docs/dev/README.md).
 
 ## FAQ :raising_hand:
 1) I have an issue whilst installing/upgrading Testrun, what do I do?

cmd/build

@@ -36,15 +36,28 @@ fi
 # Builds all docker images
 echo Building docker images
 
-# Build user interface
-echo Building user interface
-if docker build -t test-run/ui -f modules/ui/ui.Dockerfile . ; then
+# Check if UI has already been built (if -l was used during install)
+if [ ! -d "modules/ui/dist" ]; then
+  cmd/build_ui
+fi
+
+# Build UI image
+if docker build -t testrun/ui -f modules/ui/ui.Dockerfile . ; then
   echo Successully built the user interface
 else
   echo An error occured whilst building the user interface
   exit 1
 fi
 
+# Build websockets server
+echo Building websockets server
+if docker build -t testrun/ws -f modules/ws/ws.Dockerfile . ; then
+  echo Successully built the web sockets server
+else
+  echo An error occured whilst building the websockets server
+  exit 1
+fi
+
 # Build network modules
 echo Building network modules
 mkdir -p build/network

cmd/build_ui

@@ -0,0 +1,37 @@
+#!/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.
+
+# Build the UI
+echo Building the ui builder
+
+# Build UI builder image
+if docker build -t testrun/build-ui -f modules/ui/build.Dockerfile . ; then
+  echo Successully built the ui builder
+else
+  echo An error occured whilst building the ui builder
+  exit 1
+fi
+
+# Check that the container is not already running
+docker kill tr-ui-build 2> /dev/null || true
+
+echo "Building the user interface"
+
+# Start build container and build the ui dist 
+docker run --rm -v $PWD/modules/ui:/modules/ui testrun/build-ui /bin/sh -c "npm install && npm run build"
+
+# Kill the container (Should not be running anymore)
+docker kill tr-ui-build 2> /dev/null || true

cmd/install

@@ -20,15 +20,29 @@ echo Installing application dependencies
 while getopts ":l" option; do
    case $option in
       l) # Install Testrun in local directory
-         TESTRUN_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")"/.. && pwd)
+        TESTRUN_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")"/.. && pwd)
    esac
 done
 
 # Check if TESTRUN_DIR has been set, otherwise install in /usr/local/testrun
 if [[ -z "${TESTRUN_DIR}" ]]; then
   TESTRUN_DIR=/usr/local/testrun
+
+  # Check that user is sudo
+  if [[ "$EUID" -ne 0 ]]; then
+    echo "Installing Testrun in the default location requires sudo. Run using sudo cmd/install"
+    exit 1
+  fi
+
 else
   TESTRUN_DIR="${TESTRUN_DIR}"
+
+  # Check that user is in docker group
+  if ! (id -nGz "$USER" | grep -qzxF "docker"); then
+    echo User is not in docker group. Follow https://docs.docker.com/engine/install/linux-postinstall/ to finish setting up docker.
+    exit 1
+  fi
+
 fi
 
 echo Installing Testrun at $TESTRUN_DIR
@@ -51,7 +65,7 @@ cp -n local/system.json.example local/system.json
 deactivate
 
 # Build docker images
-sudo cmd/build
+cmd/build
 
 # Create local folders
 mkdir -p local/devices

cmd/package

@@ -16,6 +16,12 @@
 
 # Creates a package for Testrun
 
+# Check that user is not root
+if [[ "$EUID" == 0 ]]; then
+    echo "Must not run as root. Use cmd/package as regular user"
+    exit 1
+fi
+
 MAKE_SRC_DIR=make
 MAKE_CONTROL_DIR=make/DEBIAN/control
 
@@ -25,10 +31,10 @@ 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
+echo Building package for testrun v${version}
 
 # Delete existing make files
+echo Cleaning up previous build files
 rm -rf $MAKE_SRC_DIR/usr
 
 # Copy testrun script to /bin
@@ -60,6 +66,9 @@ mkdir -p $MAKE_SRC_DIR/usr/local/testrun/local/risk_profiles
 mkdir -p local/root_certs
 cp -r local/root_certs $MAKE_SRC_DIR/usr/local/testrun/local/
 
+# Build the UI
+cmd/build_ui
+
 # Copy framework and modules into testrun folder
 cp -r {framework,modules} $MAKE_SRC_DIR/usr/local/testrun
 

docs/README.md

@@ -16,3 +16,6 @@
    - [Running on a virtual machine](virtual_machine.md)
    - [Accessibility](ui/accessibility.mp4)
    - [Roadmap](roadmap.pdf)
+
+## Something missing?
+If you feel there is some documentation that you would find useful, or have found an issue with existing documentation, please raise an issue on GitHub by navigating [here](https://github.com/google/testrun/issues/new/choose)

docs/dev/README.md

@@ -0,0 +1,25 @@
+<img width="200" alt="Testrun logo" src="https://user-images.githubusercontent.com/7399056/221927867-4190a4e8-a571-4e40-9c2b-65780ad9264c.png" alt="Testrun">
+
+## Developer docs
+
+## Table of Contents
+1) General guidelines (this page)
+2) [Code quality](code_quality.md)
+
+## General guidelines
+As an open source project, we absolutely encourage contributions from the community to help Testrun remain an expanding but stable product. However, before contributing there are a number of things to take into consideration.
+
+1) [Sign the Google CLA](https://cla.developers.google.com/): Whether you are an individual or contributing on behalf of your organisation, you must be covered by a Google CLA.
+
+2) Determine the scope of your contribution
+
+    - Your contribution is more likely to be accepted if fewer files are changed (keep it simple)
+    - Are you going to be fixing a bug, dependency issue or a new framework capability? Whatever it is, ensure your pull request fixes or changes just one thing.
+
+3) Get in touch to discuss whether your proposed changes are likely to be accepted
+
+    - It is best to get the opinion from the core maintainers whether your proposed changes meet our objectives and align with Testrun principles.
+
+4) Fork Testrun and get developing
+
+    - We aim to provide thorough and easy to ready developer documentation to help you contribute successfully.

docs/dev/code_quality.md

@@ -0,0 +1,16 @@
+<img width="200" alt="Testrun logo" src="https://user-images.githubusercontent.com/7399056/221927867-4190a4e8-a571-4e40-9c2b-65780ad9264c.png" alt="Testrun">
+
+## Code quality
+
+Whilst developing code for Testrun, there are some style guides that you should follow. 
+
+ - Python: https://google.github.io/styleguide/pyguide.html
+ - Angular: https://google.github.io/styleguide/angularjs-google-style.html
+ - Shell: https://google.github.io/styleguide/shellguide.html
+ - HTML/CSS: https://google.github.io/styleguide/htmlcssguide.html
+ - JSON: https://google.github.io/styleguide/jsoncstyleguide.xml
+ - Markdown: https://google.github.io/styleguide/docguide/style.html
+
+### Automated actions
+
+The current code base has been able to achieve 0 code lint issues. To maintain this, all lint checks are enforced on pull requests to dev and main. Please ensure that these lint checks are passing before marking your pull requests as 'Ready for review'.

docs/network/README.md

@@ -1,10 +1,9 @@
 <img width="200" alt="Testrun logo" src="https://user-images.githubusercontent.com/7399056/221927867-4190a4e8-a571-4e40-9c2b-65780ad9264c.png" alt="Testrun">
 
-
 ## Network Overview
 
 ## Table of Contents
-1) Network Overview (this page)
+1) Network overview (this page)
 2) [How to identify network interfaces](identify_interfaces.md)
 3) [Addresses](addresses.md)
 4) [Add a new network service](add_new_service.md)

docs/network/add_new_service.md

@@ -65,7 +65,7 @@ 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
+# Do not specify a CMD or Entrypoint as Testrun will automatically start your service as required
 ```
 
 ### Example of start_network_service script