Build UI during package instead of install

.github/workflows/package.yml

@@ -7,12 +7,13 @@ on:
   push:
     branches:
       - 'dev'
+      - 'release/*'
 
 permissions:
   contents: read
 
 jobs:
-  testrun_package:
+  create_package:
     permissions: {}
     name: Package
     runs-on: ubuntu-22.04
@@ -28,3 +29,23 @@ jobs:
         with:
           name: testrun_package
           path: testrun*.deb
+
+  install_package:
+    permissions: {}
+    needs: create_package
+    name: Install
+    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

cmd/build

@@ -36,9 +36,13 @@ 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

cmd/build_ui

@@ -0,0 +1,35 @@
+#!/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 user interface
+
+# 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
+
+# Start build container and build the ui dist 
+docker run -it --rm -v $PWD/modules/ui:/modules/ui testrun/build-ui /bin/sh -c "npm install && npm run build"
+
+# Kill the container
+docker kill tr-ui-build

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
 

framework/python/src/core/testrun.py

@@ -482,7 +482,7 @@ def start_ui(self):
 
     try:
       client.containers.run(
-            image='test-run/ui',
+            image='testrun/ui',
             auto_remove=True,
             name='tr-ui',
             hostname='testrun.io',

modules/ui/angular.json

@@ -33,7 +33,7 @@
               "budgets": [
                 {
                   "type": "initial",
-                  "maximumWarning": "1000kb",
+                  "maximumWarning": "1500kb",
                   "maximumError": "3000kb"
                 },
                 {
@@ -94,6 +94,7 @@
     }
   },
   "cli": {
-    "schematicCollections": ["@angular-eslint/schematics"]
+    "schematicCollections": ["@angular-eslint/schematics"],
+    "analytics": false
   }
 }

modules/ui/build.Dockerfile

@@ -0,0 +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.
+
+# Image name: testrun/build-ui
+FROM node@sha256:ffebb4405810c92d267a764b21975fb2d96772e41877248a37bf3abaa0d3b590 as build
+
+# Set the working directory
+WORKDIR /modules/ui
+

modules/ui/ui.Dockerfile

@@ -12,17 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Image name: test-run/ui
-FROM node@sha256:ffebb4405810c92d267a764b21975fb2d96772e41877248a37bf3abaa0d3b590 as build
-
-WORKDIR /modules/ui
-COPY modules/ui/ /modules/ui
-RUN npm install
-RUN npm run build
-
+# Image name: testrun/ui
 FROM nginx@sha256:4c0fdaa8b6341bfdeca5f18f7837462c80cff90527ee35ef185571e1c327beac
 
-COPY --from=build /modules/ui/dist/ /usr/share/nginx/html
+COPY modules/ui/dist/ /usr/share/nginx/html
 
 EXPOSE 8080