Merge release v2.2.1 into main

.github/workflows/testing.yml

@@ -11,7 +11,7 @@ jobs:
     permissions: {}
     name:  Tests
     runs-on: ubuntu-22.04
-    timeout-minutes: 30
+    timeout-minutes: 60
     steps:
       - name: Checkout source
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

framework/python/src/api/api.py

@@ -15,6 +15,7 @@
 from fastapi import (FastAPI, APIRouter, Response, Request, status, UploadFile)
 from fastapi.responses import FileResponse
 from fastapi.middleware.cors import CORSMiddleware
+import asyncio
 from datetime import datetime
 import json
 from json import JSONDecodeError
@@ -350,9 +351,17 @@ async def stop_testrun(self, response: Response):
       response.status_code = 404
       return self._generate_msg(False, "Testrun is not currently running")
 
-    self._testrun.stop()
+    # Launch stop in the background
+    asyncio.create_task(self._run_stop())
 
-    return self._generate_msg(True, "Testrun stopped")
+    # Return response immediately
+    return self._generate_msg(True, "Testrun stop initiated")
+
+  async def _run_stop(self):
+    try:
+      await self._testrun.stop()  # Assuming .stop is async
+    except Exception as e:
+      LOGGER.exception("Error while stopping testrun: %s", e)
 
   async def get_status(self):
     return self._testrun.get_session().to_json()
@@ -700,6 +709,9 @@ async def get_report(self, response: Response, device_name, timestamp):
       response.status_code = 404
       return self._generate_msg(False, "Device not found")
 
+    # Regenerate the pdf if the device profile has been updated
+    self._get_testrun().get_test_orc().regenerate_pdf(device, timestamp)
+
     # 1.3 file path
     file_path = os.path.join(
       DEVICES_PATH,

framework/python/src/common/testreport.py

@@ -180,6 +180,11 @@ def from_json(self, json_file):
     if 'additional_info' in json_file['device']:
       self._device['device_profile'] = json_file['device']['additional_info']
 
+    # Used for regenerating the report since after initial report creation the
+    # 'additional_info' field is changed to 'device_profile' in the report
+    if 'device_profile' in json_file['device']:
+      self._device['device_profile'] = json_file['device']['device_profile']
+
     self._status = json_file['status']
 
     if 'result' in json_file:

framework/python/src/core/testrun.py

@@ -382,7 +382,10 @@ def start(self):
     while True:
       time.sleep(5)
 
-  def stop(self):
+  async def stop(self):
+
+    # First, change the status to stopping
+    self.get_session().stop()
 
     # First, change the status to stopping
     self.get_session().stop()

framework/python/src/test_orc/test_orchestrator.py

@@ -360,14 +360,67 @@ def zip_results(self, device, timestamp: str, profile):
           LOCAL_DEVICE_REPORTS.replace("{device_folder}", device.device_folder),
           timestamp)
 
-      # Report file path
+      # Regenerate the report if the device profile has been updated
+      self._regenerate_report_files(device, timestamp)
+
+      # Define temp directory to store files before zipping
+      results_dir = os.path.join(f"/tmp/testrun/{time.time()}")
+
+      # Define where to save the zip file
+      zip_location = os.path.join("/tmp/testrun", timestamp)
+
+      # Delete zip_temp if it already exists
+      if os.path.exists(results_dir):
+        os.remove(results_dir)
+
+      # Delete ZIP if it already exists
+      if os.path.exists(zip_location + ".zip"):
+        os.remove(zip_location + ".zip")
+
+      shutil.copytree(src_path, results_dir)
+
+      # Include profile if specified
+      if profile is not None:
+        LOGGER.debug(f"Copying profile {profile.name} to results directory")
+        shutil.copy(profile.get_file_path(),
+                    os.path.join(results_dir, "profile.json"))
+
+        with open(os.path.join(results_dir, "profile.pdf"), "wb") as f:
+          f.write(profile.to_pdf(device).getvalue())
+
+      # Create ZIP archive
+      shutil.make_archive(zip_location, "zip", results_dir)
+
+      # Delete the temp results directory
+      shutil.rmtree(results_dir)
+
+      # Check that the ZIP was successfully created
+      zip_file = zip_location + ".zip"
+      LOGGER.info(f"""Archive {"created at " + zip_file
+                                if os.path.exists(zip_file)
+                                else "creation failed"}""")
+
+      return zip_file
+
+    except Exception as error:  # pylint: disable=W0703
+      LOGGER.error("Failed to create zip file")
+      LOGGER.debug(error)
+      return None
+
+  def regenerate_pdf(self, device, timestamp):
+    """Regenerate the pdf report"""
+    self._regenerate_report_files(device, timestamp)
+
+  def _regenerate_report_files(self, device, timestamp):
+    '''Regenerate the report if the device profile has been updated'''
+
+    try:
+
+      # Report files path
       report_path = os.path.join(
           LOCAL_DEVICE_REPORTS.replace("{device_folder}", device.device_folder),
           timestamp, "test", device.mac_addr.replace(":", ""))
 
-      # report.json path
-      report_json_path = os.path.join(report_path, "report.json")
-
       # Parse string timestamp
       date_timestamp: datetime.datetime = datetime.strptime(
           timestamp, "%Y-%m-%dT%H:%M:%S")
@@ -382,21 +435,15 @@ def zip_results(self, device, timestamp: str, profile):
       if test_report is None:
         return None
 
-      # Load the report.json into TestReport
-      if os.path.exists(report_json_path):
-        with open(report_json_path, "r", encoding="utf-8") as report_json_file:
-          report_json = json.load(report_json_file)
-          test_report = TestReport()
-          test_report.from_json(report_json)
-
       # Copy the original report for comparison
       test_report_copy = copy.deepcopy(test_report)
 
       # Update the report with 'additional_info' field
       test_report.update_device_profile(device.additional_info)
 
-      # Overwrite report only if additional_info has been updated
+      # Overwrite report only if additional_info has been changed
       if test_report.to_json() != test_report_copy.to_json():
+        LOGGER.debug("Device profile has been updated, regenerating the report")
 
         # Store the jinja templates
         reload_templates = []
@@ -432,49 +479,11 @@ def zip_results(self, device, timestamp: str, profile):
         with open(os.path.join(report_path, "report.pdf"), "wb") as f:
           f.write(test_report.to_pdf().getvalue())
 
-      # Define temp directory to store files before zipping
-      results_dir = os.path.join(f"/tmp/testrun/{time.time()}")
-
-      # Define where to save the zip file
-      zip_location = os.path.join("/tmp/testrun", timestamp)
-
-      # Delete zip_temp if it already exists
-      if os.path.exists(results_dir):
-        os.remove(results_dir)
-
-      # Delete ZIP if it already exists
-      if os.path.exists(zip_location + ".zip"):
-        os.remove(zip_location + ".zip")
-
-      shutil.copytree(src_path, results_dir)
-
-      # Include profile if specified
-      if profile is not None:
-        LOGGER.debug(f"Copying profile {profile.name} to results directory")
-        shutil.copy(profile.get_file_path(),
-                    os.path.join(results_dir, "profile.json"))
-
-        with open(os.path.join(results_dir, "profile.pdf"), "wb") as f:
-          f.write(profile.to_pdf(device).getvalue())
-
-      # Create ZIP archive
-      shutil.make_archive(zip_location, "zip", results_dir)
-
-      # Delete the temp results directory
-      shutil.rmtree(results_dir)
+        LOGGER.debug("Report has been regenerated")
 
-      # Check that the ZIP was successfully created
-      zip_file = zip_location + ".zip"
-      LOGGER.info(f"""Archive {"created at " + zip_file
-                                if os.path.exists(zip_file)
-                                else "creation failed"}""")
-
-      return zip_file
-
-    except Exception as error:  # pylint: disable=W0703
-      LOGGER.error("Failed to create zip file")
+    except Exception as error:
+      LOGGER.error("Failed to regenerate the report")
       LOGGER.debug(error)
-      return None
 
   def test_in_progress(self):
     return self._test_in_progress

make/DEBIAN/control

@@ -1,5 +1,5 @@
 Package: Testrun
-Version: 2.2
+Version: 2.2.1
 Architecture: amd64
 Maintainer: Google <boddey@google.com>
 Homepage: https://github.com/google/testrun

modules/test/dns/README.md

@@ -16,4 +16,4 @@ Within the ```python/src``` directory, the below tests are executed.
 |---|---|---|---|
 | dns.network.hostname_resolution | Verifies that the device resolves hostnames | The device sends DNS requests | Required |
 | dns.network.from_dhcp | Verifies that the device allows for a DNS server to be provided by the DHCP server | The device sends DNS requests to the DNS server provided by the DHCP server | Informational |
-| dns.mdns | Does the device has MDNS (or any kind of IP multicast) | Device may send MDNS requests | Informational |
+| dns.mdns | Does the device has MDNS | Device may send MDNS requests | Informational |

modules/test/ntp/ntp.Dockerfile

@@ -15,6 +15,12 @@
 # Image name: testrun/ntp-test
 FROM testrun/base-test:latest
 
+# Set DEBIAN_FRONTEND to noninteractive mode
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install required software
+RUN apt-get update && apt-get install -y tshark
+
 ARG MODULE_NAME=ntp
 ARG MODULE_DIR=modules/test/$MODULE_NAME
 

modules/test/ntp/python/requirements.txt

@@ -4,3 +4,4 @@
 
 # User defined packages
 scapy==2.6.0
+pyshark==0.6