Merge release v2.1 into main

.github/workflows/package.yml

@@ -49,6 +49,20 @@ jobs:
       - name: Install package
         shell: bash {0}
         run: sudo apt install ./testrun*.deb
+      - name: Start testrun
+        shell: bash {0}
+        run: sudo testrun > >(tee testrun_output.log) 2>&1 &
+      - name: Verify testrun started
+        shell: bash {0}
+        run: |
+          sleep 5  
+          if grep -q "API waiting for requests" testrun_output.log; then
+            echo "Testrun started successfully."
+          else
+            echo "Testrun did not start correctly."
+            cat testrun_output.log
+            exit 1
+          fi 
 
   install_package_22:
     permissions: {}
@@ -69,6 +83,20 @@ jobs:
       - name: Install package
         shell: bash {0}
         run: sudo apt install ./testrun*.deb
+      - name: Start testrun
+        shell: bash {0}
+        run: sudo testrun > >(tee testrun_output.log) 2>&1 &
+      - name: Verify testrun started
+        shell: bash {0}
+        run: |
+          sleep 5  
+          if grep -q "API waiting for requests" testrun_output.log; then
+            echo "Testrun started successfully."
+          else
+            echo "Testrun did not start correctly."
+            cat testrun_output.log
+            exit 1
+          fi 
 
   install_package_24:
     permissions: {}
@@ -89,3 +117,17 @@ jobs:
       - name: Install package
         shell: bash {0}
         run: sudo apt install ./testrun*.deb
+      - name: Start testrun
+        shell: bash {0}
+        run: sudo testrun > >(tee testrun_output.log) 2>&1 &
+      - name: Verify testrun started
+        shell: bash {0}
+        run: |
+          sleep 5  
+          if grep -q "API waiting for requests" testrun_output.log; then
+            echo "Testrun started successfully."
+          else
+            echo "Testrun did not start correctly."
+            cat testrun_output.log
+            exit 1
+          fi 

.github/workflows/testing.yml

@@ -97,16 +97,13 @@ jobs:
       - name: Run tests for reports
         shell: bash {0}
         run: bash testing/unit/run_report_test.sh testing/unit/report/report_test.py
-      - name: Archive HTML reports for modules
-        if: ${{ always() }}
-        run: sudo tar --exclude-vcs -czf html_reports.tgz testing/unit/report/output/
-      - name: Upload HTML reports
+      - name: Upload reports
         uses: actions/upload-artifact@694cdabd8bdb0f10b2cea11669e1bf5453eed0a6 # v4.2.0
         if: ${{ always() }}
         with:
           if-no-files-found: error
-          name: html-reports_${{ github.run_id }}
-          path: html_reports.tgz
+          name: reports_${{ github.run_id }}
+          path: testing/unit/report/output
 
   pylint:
     permissions: {}
@@ -138,7 +135,7 @@ jobs:
     - name: Run tests
       run: |
         export CHROME_BIN=/usr/bin/chromium-browser
-        CI=true npm run test-headless
+        CI=true npm run test-ci
       env:
         CI: true
       working-directory: ./modules/ui

.gitignore

@@ -18,6 +18,11 @@ testing/unit/report/output/
 testing/unit/risk_profile/output/
 testing/unit/services/output/
 
+# Ignore generated files from requirements generation
+*requirements_freeze.txt
+*unique_freeze.txt
+*requirements_gen.txt
+
 *.deb
 make/DEBIAN/postinst
 

README.md

@@ -35,7 +35,7 @@ Testrun provides the network and assistive tools for engineers when manual testi
 ## Hardware
 
 -  PC running Ubuntu LTS 20.04, 22.04, or 24.04 (laptop or desktop)
--  2x USB Ethernet adapter (one may be built-in Ethernet)
+-  2x ethernet ports (USB ethernet adapters work too)
 -  Internet connection
 
 ## Software
@@ -72,7 +72,7 @@ We strongly encourage contributions from the community. Review the requirements
 
  You can resolve most issues by reinstalling Testrun using these commands:
 - `sudo docker system prune -a`
-- `sudo apt install ./testrun-*.deb`
+- `sudo apt install ./testrun*.deb`
 
 If this doesn't resolve the problem, [raise an issue](https://github.com/google/testrun/issues).
 

cmd/build_ui

@@ -30,8 +30,8 @@ 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"
+# 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

@@ -74,7 +74,7 @@ mkdir -p local/{devices,root_certs,risk_profiles}
 # This does not work on GitHub actions
 if logname ; then
   USER_NAME=$(logname)
-  sudo chown -R "$USER_NAME" local || true
+  sudo chown -R "$USER_NAME" local resources || true
 fi
 
 echo Finished installing Testrun

cmd/package

@@ -22,6 +22,12 @@ if [[ "$EUID" == 0 ]]; then
     exit 1
 fi
 
+# 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
+
 MAKE_SRC_DIR=make
 MAKE_CONTROL_DIR=make/DEBIAN/control
 

cmd/update_requirements

@@ -0,0 +1,115 @@
+# #!/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.
+
+# update_requirements(){
+# 	modules_dir="$1"
+# 	for dir in $modules_dir/* ; do
+# 	  echo "dir: $dir"
+# 	  module=$(basename "$dir")
+# 	  MODULE_DIR="$PWD/$modules_dir/$module/python"
+# 	  IMAGE=testrun/$module
+# 	  # Check if updating the test modules
+# 	  if [[ $modules_dir == *test* ]]; then
+# 	    # Append '-test' to the variable
+# 		IMAGE="${IMAGE}-test"
+# 	  fi
+# 	  echo "Module dir: $MODULE_DIR"
+# 	  echo "Image: $IMAGE"
+# 	  echo Updating requirements for module $modules_dir/$module...
+
+# 	  if [ -e "$MODULE_DIR/requirements.txt" ]; then
+# 	    if docker run --rm -v "$PWD/$modules_dir/$module/python/:/testrun/python/" --entrypoint /bin/bash $IMAGE -c "pip3 freeze > /testrun/python/requirements_freeze.txt" ; then
+# 	      echo Successfully built requirements file for module $modules_dir/$module
+
+# 	      # Normalize line endings and remove extra spaces
+# 	      dos2unix "$MODULE_DIR/requirements.txt" "$MODULE_DIR/requirements_freeze.txt"
+# 	      sed -i 's/^[ \t]*//;s/[ \t]*$//' "$MODULE_DIR/requirements.txt" "$MODULE_DIR/requirements_freeze.txt"
+
+# 	      # Temporary file to store unique packages
+# 	      > "$MODULE_DIR/unique_freeze.txt"
+
+# 	      # Find unique packages in requirements_freeze.txt that are not in requirements.txt
+# 	      while IFS= read -r freeze_line; do
+# 	        # Extract the package name from freeze_line
+# 	        freeze_package=$(echo "$freeze_line" | cut -d'=' -f1 | xargs)
+
+# 	        echo "Frozen package: $freeze_package"
+# 	        # Search for the package name in requirements.txt, ignoring case and whitespace
+# 	        if ! grep -iq "^${freeze_package}$" "$MODULE_DIR/requirements.txt"; then
+# 	          echo "$freeze_line" >> "$MODULE_DIR/unique_freeze.txt"
+# 	        fi
+# 	      done < "$MODULE_DIR/requirements_freeze.txt"
+
+#  		  # Temporary file to store generated requirements
+# 	      > "$MODULE_DIR/requirements_gen.txt"
+
+# 	      # Add the downstream packages at the top of requirements_gen.txt
+# 	      # so we pull in package dependencies before the defined dependency
+# 	      # to prevent auto-upgrades in the package pipeline
+# 	      echo "# Dependencies to user defined packages" > "$MODULE_DIR/requirements_gen.txt"
+# 	      echo -e "# Package dependencies should always be defined before the user defined" >> "$MODULE_DIR/requirements_gen.txt"
+# 	      echo -e "# packages to prevent auto-upgrades of stable dependencies" >> "$MODULE_DIR/requirements_gen.txt"
+# 	      cat "$MODULE_DIR/unique_freeze.txt" >> "$MODULE_DIR/requirements_gen.txt"
+
+# 	      # Create the requirements_gen.txt file
+# 	      echo -e "\n# User defined packages" >> "$MODULE_DIR/requirements_gen.txt"
+
+# 	      # Loop through each package in requirements.txt
+# 	      while IFS= read -r package; do
+# 	        # Trim leading and trailing whitespace from package
+# 	        package=$(echo "$package" | xargs)
+# 	        echo "Package: $package"
+
+# 	        # Extract the base package name (without version or any comparison operator)
+# 	        base_package=$(echo "$package" | sed -E 's/[<>=!].*//')
+# 	        echo "Base package: $base_package"
+
+# 	        # Check if the base package is a comment and non-empty
+# 			if [[ -n "$base_package" && "$base_package" != \#* ]]; then
+# 			  # Perform the grep only if it is not a comment
+# 			  versioned_package=$(grep -i "^${base_package}==" "$MODULE_DIR/requirements_freeze.txt")
+# 			else
+# 			  # Set versioned_package to empty if it's a comment
+# 			  versioned_package=""
+# 			fi
+
+# 	        # Debug output: Print the result of matching
+# 	        echo "Versioned Package: '$versioned_package'"
+
+# 	        if [ -n "$versioned_package" ]; then
+# 	          # If the package with the version is found, add it to requirements_gen.txt
+# 	          echo "$versioned_package" >> "$MODULE_DIR/requirements_gen.txt"
+# 	        else
+# 	          # If not found, just add the package as is from requirements.txt
+# 	          echo "$package" >> "$MODULE_DIR/requirements_gen.txt"
+# 	        fi
+# 	      done < "$MODULE_DIR/requirements.txt"
+# 	      echo "Module done"
+
+# 	    else
+# 	      echo An error occurred while building requirements file for network module $module
+# 	      exit 1
+# 	    fi
+# 	  else
+# 	    echo No requirements.txt file defined for this module
+# 	  fi
+# 	done
+# }
+# echo Updating python requirements in network modules
+# update_requirements modules/network
+
+# echo Updating python requirements in test modules
+# update_requirements modules/test