Merge release v1.1.1 into main

.github/workflows/testing.yml

@@ -7,12 +7,13 @@ on:
 
 jobs:
   testrun_baseline:
+    permissions: {}
     name:  Baseline
     runs-on: ubuntu-20.04
     timeout-minutes: 20
     steps:
       - name: Checkout source
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v4.1.1
       - name: Install dependencies
         shell: bash {0}
         run: cmd/prepare
@@ -28,13 +29,14 @@ jobs:
         run: testing/baseline/test_baseline
 
   testrun_tests:
+    permissions: {}
     name:  Tests
     runs-on: ubuntu-20.04
     needs: testrun_baseline
     timeout-minutes: 45
     steps:
       - name: Checkout source
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v4.1.1
       - name: Install dependencies
         shell: bash {0}
         run: cmd/prepare
@@ -51,20 +53,21 @@ jobs:
         if: ${{ always() }}
         run: sudo tar --exclude-vcs -czf runtime.tgz /usr/local/testrun/runtime/
       - name: Upload runtime results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ always() }}
         with:
           if-no-files-found: error
-          name: runtime_${{ github.workflow }}_${{ github.run_id }}
+          name: runtime_tests_${{ github.run_id }}
           path: runtime.tgz
 
   testrun_api:
+    permissions: {}
     name:  API
     runs-on: ubuntu-20.04
     timeout-minutes: 40
     steps:
       - name: Checkout source
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v4.1.1
       - name: Install dependencies
         shell: bash {0}
         run: cmd/prepare
@@ -82,47 +85,50 @@ jobs:
         if: ${{ always() }}
         run: sudo tar --exclude-vcs -czf runtime.tgz /usr/local/testrun/runtime/ /usr/local/testrun/local/
       - name: Upload runtime results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ always() }}
         with:
           if-no-files-found: error
-          name: runtime_${{ github.workflow }}_${{ github.run_id }}
+          name: runtime_api_${{ github.run_id }}
           path: runtime.tgz
 
   pylint:
+    permissions: {}
     name:  Pylint
     runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
       - name: Checkout source
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v4.1.1
       - name: Run pylint
         shell: bash {0}
         run: testing/pylint/test_pylint
 
   testrun_package:
+    permissions: {}
     name: Package
     runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
       - name: Checkout source
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v4.1.1
       - name: Package Testrun
         shell: bash {0}
         run: cmd/package
       - name: Archive package
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: Testrun Installer
+          name: testrun_installer
           path: testrun*.deb
 
   testrun_ui:
+    permissions: {}
     name: UI
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4.1.1
     - name: Install Node
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 18.10.0
     - name: Install Chromium Browser

.gitignore

@@ -6,4 +6,6 @@ pylint.out
 __pycache__/
 build/
 testing/unit_test/temp/
-*.deb
+*.deb
+
+make/DEBIAN/postinst

cmd/install

@@ -28,6 +28,13 @@ pip3 install -r framework/requirements.txt
 # Copy the default configuration
 cp -n local/system.json.example local/system.json
 
+# Set file permissions
+# This does not work on GitHub actions
+if logname ; then
+  USER_NAME=$(logname)
+  sudo chown "$USER_NAME" local/system.json
+fi
+
 deactivate
 
 # Build docker images

cmd/package

@@ -53,4 +53,4 @@ 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_1-1_amd64.deb
+mv make.deb testrun_1-1-1_amd64.deb

docs/get_started.md

@@ -49,9 +49,10 @@ However, to achieve a compliant test outcome, your device must be configured cor
    - 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.
 
-   **NOTE: The device under test should be powered off until prompted**
-
-   **NOTE: Both adapters should be disabled in the host system (IPv4, IPv6 and general). You can do this by going to Settings > Network** 
+  Some things to remember:
+  - The device under test should be powered off until prompted
+  - Both adapters should be disabled in the host system (IPv4, IPv6 and general). You can do this by going to Settings > Network
+  - Struggling to identify the correct interfaces? See [this guide](network/identify_interfaces.md).
 
 2. Start Testrun.
 

docs/network/README.md

@@ -2,8 +2,9 @@
 
 ## Table of Contents
 1) Network Overview (this page)
-2) [Addresses](addresses.md)
-3) [Add a new network service](add_new_service.md)
+2) [How to identify network interfaces](identify_interfaces.md)
+3) [Addresses](addresses.md)
+4) [Add a new network service](add_new_service.md)
 
 Test Run provides several built-in network services that can be utilized for testing purposes. These services are already available and can be used without any additional configuration. 
 

docs/network/identify_interfaces.md

@@ -0,0 +1,18 @@
+# Identifying network interfaces
+
+For Testrun to operate correctly, you must select the correct network interfaces within the settings panel of the user interface. There are 2 methods to identify the correct network interfaces:
+
+A) Find the printed MAC address on your interface
+
+Some USB network interfaces will have the MAC address printed on the interface itself. This will look something like: ```00:e0:4c:02:0f:a8```.
+
+Compare this printed MAC address against the MAC address provided in the settings panel in the user interface.
+
+B) Connect your interfaces one at a time
+
+  1) Ensure both interfaces are disconnected from your PC and open the settings panel in the user interface.
+
+  2) Connect your internet interface to your PC and refresh the settings panel. One interface, which was not previously present, should now be visibile.
+
+  3) Repeat the previous step for the devices interface.
+

framework/python/src/api/api.py

@@ -11,7 +11,7 @@
 # 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 Testrun data via REST API."""
 from fastapi import FastAPI, APIRouter, Response, Request, status
 from fastapi.responses import FileResponse
 from fastapi.middleware.cors import CORSMiddleware
@@ -37,7 +37,8 @@
 DEVICES_PATH = "/usr/local/testrun/local/devices"
 DEFAULT_DEVICE_INTF = "enx123456789123"
 
-LATEST_RELEASE_CHECK = "https://api.github.com/repos/google/testrun/releases/latest"
+LATEST_RELEASE_CHECK = ("https://api.github.com/repos/google/" +
+                        "testrun/releases/latest")
 
 class Api:
   """Provide REST endpoints to manage Testrun"""
@@ -77,6 +78,9 @@ def __init__(self, test_run):
                                self.delete_device,
                                methods=["DELETE"])
     self._router.add_api_route("/device", self.save_device, methods=["POST"])
+    self._router.add_api_route("/device/edit",
+                               self.edit_device,
+                               methods=["POST"])
 
     # Allow all origins to access the API
     origins = ["*"]
@@ -111,14 +115,17 @@ def stop(self):
 
   async def get_sys_interfaces(self):
     addrs = psutil.net_if_addrs()
-    ifaces = []
-    for iface in addrs:
+    ifaces = {}
+
+    # pylint: disable=consider-using-dict-items
+    for key in addrs.keys():
+      nic = addrs[key]
 
       # Ignore any interfaces that are not ethernet
-      if not (iface.startswith("en") or iface.startswith("eth")):
+      if not (key.startswith("en") or key.startswith("eth")):
         continue
 
-      ifaces.append(iface)
+      ifaces[key] = nic[0].address
 
     return ifaces
 
@@ -240,32 +247,38 @@ async def get_version(self, response: Response):
     json_response["installed_version"] = "v" + current_version
 
     # Check latest version number from GitHub API
-    version_check = requests.get(LATEST_RELEASE_CHECK, timeout=5)
+    try:
+      version_check = requests.get(LATEST_RELEASE_CHECK, timeout=5)
+
+      # Check OK response was received
+      if version_check.status_code != 200:
+        response.status_code = 500
+        LOGGER.error(version_check.content)
+        return self._generate_msg(False, "Failed to fetch latest version")
+
+      # Extract version number from response, removing the leading 'v'
+      latest_version_no = version_check.json()["name"].strip("v")
+      LOGGER.debug(f"Latest version available is {latest_version_no}")
+
+      # Craft JSON response
+      json_response["latest_version"] = "v" + latest_version_no
+      json_response["latest_version_url"] = version_check.json()["html_url"]
+
+      # String comparison between current and latest version
+      if latest_version_no > current_version:
+        json_response["update_available"] = True
+        LOGGER.debug("An update is available")
+      else:
+        json_response["update_available"] = False
+        LOGGER.debug("The latest version is installed")
 
-    # Check OK response was received
-    if version_check.status_code != 200:
+      return json_response
+    except Exception as e:
       response.status_code = 500
-      LOGGER.error(version_check.content)
+      LOGGER.error("Failed to fetch latest version")
+      LOGGER.debug(e)
       return self._generate_msg(False, "Failed to fetch latest version")
 
-    # Extract version number from response, removing the leading 'v'
-    latest_version_no = version_check.json()["name"].strip("v")
-    LOGGER.debug(f"Latest version available is {latest_version_no}")
-
-    # Craft JSON response
-    json_response["latest_version"] = "v" + latest_version_no
-    json_response["latest_version_url"] = version_check.json()["html_url"]
-
-    # String comparison between current and latest version
-    if latest_version_no > current_version:
-      json_response["update_available"] = True
-      LOGGER.debug("An update is available")
-    else:
-      json_response["update_available"] = False
-      LOGGER.debug("The latest version is installed")
-
-    return json_response
-
   async def get_reports(self, request: Request):
     LOGGER.debug("Received reports list request")
     # Resolve the server IP from the request so we
@@ -389,8 +402,76 @@ async def save_device(self, request: Request, response: Response):
 
       else:
 
-        self._test_run.save_device(device, device_json)
-        response.status_code = status.HTTP_200_OK
+        response.status_code = status.HTTP_409_CONFLICT
+        return self._generate_msg(False, "A device with that " +
+                                  "MAC address already exists")
+
+      return device.to_config_json()
+
+    # Catch JSON Decode error etc
+    except JSONDecodeError:
+      response.status_code = status.HTTP_400_BAD_REQUEST
+      return self._generate_msg(False, "Invalid JSON received")
+
+  async def edit_device(self, request: Request, response: Response):
+
+    LOGGER.debug("Received device edit request")
+
+    try:
+      req_raw = (await request.body()).decode("UTF-8")
+      req_json = json.loads(req_raw)
+
+      # Validate top level fields
+      if not (DEVICE_MAC_ADDR_KEY in req_json and
+          "device" in req_json):
+        response.status_code = status.HTTP_400_BAD_REQUEST
+        return self._generate_msg(False, "Invalid request received")
+
+      # Extract device information from request
+      device_json = req_json.get("device")
+
+      if not self._validate_device_json(device_json):
+        response.status_code = status.HTTP_400_BAD_REQUEST
+        return self._generate_msg(False, "Invalid request received")
+
+      # Get device from old MAC address
+      device = self._session.get_device(req_json.get(DEVICE_MAC_ADDR_KEY))
+
+      # Check if device exists
+      if device is None:
+        response.status_code = status.HTTP_404_NOT_FOUND
+        return self._generate_msg(False,
+                                  "A device with that MAC " +
+                                  "address could not be found")
+
+      if (self._session.get_target_device() == device and
+          self._session.get_status() not in [
+            "Cancelled",
+            "Compliant",
+            "Non-Compliant"]):
+        response.status_code = 403
+        return self._generate_msg(False, "Cannot edit this device whilst " +
+                                  "it is being tested")
+
+      # Check if a device exists with the new MAC address
+      check_new_device = self._session.get_device(
+        device_json.get(DEVICE_MAC_ADDR_KEY))
+
+      if not check_new_device is None and (device.mac_addr
+                                           != check_new_device.mac_addr):
+        response.status_code = status.HTTP_409_CONFLICT
+        return self._generate_msg(False,
+                                  "A device with that MAC address " +
+                                  "already exists")
+
+      # Update the device
+      device.mac_addr = device_json.get(DEVICE_MAC_ADDR_KEY).lower()
+      device.manufacturer = device_json.get(DEVICE_MANUFACTURER_KEY)
+      device.model = device_json.get(DEVICE_MODEL_KEY)
+      device.test_modules = device_json.get(DEVICE_TEST_MODULES_KEY)
+
+      self._test_run.save_device(device, device_json)
+      response.status_code = status.HTTP_200_OK
 
       return device.to_config_json()
 
@@ -399,6 +480,7 @@ async def save_device(self, request: Request, response: Response):
       response.status_code = status.HTTP_400_BAD_REQUEST
       return self._generate_msg(False, "Invalid JSON received")
 
+
   async def get_report(self, response: Response,
                        device_name, timestamp):