Add a zip option for the results.

README.md

@@ -42,6 +42,7 @@ Options:
   --html                        Generate HTML report (default: false)
   --openHtml                    Open HTML report in browser (requires --html) (default: false)
   --list                        Generate a list of test results as HTML (default: false)
+  --zip                         Zip the results of the test into the results directory. (default: false)
   --help                        display help for command
 ```
 

index.js

@@ -33,6 +33,7 @@ import { DEFAULT_OPTIONS } from './lib/defaultOptions.js';
  * @property {boolean=} html
  * @property {boolean=} openHtml
  * @property {boolean=} list
+ * @property {boolean=} zip
  */
 
 /**
@@ -260,6 +261,12 @@ export default function browserAgent() {
         DEFAULT_OPTIONS.list,
       ),
     )
+    .addOption(
+      new Option(
+        '--zip',
+        'Zip the results of the test into the results directory.',
+      ).default(DEFAULT_OPTIONS.zip),
+    )
     .parse(process.argv);
 
   const cliOptions = program.opts();

lib/config.js

@@ -25,6 +25,7 @@ export function normalizeCLIConfig(options) {
     list: options.list || DEFAULT_OPTIONS.list,
     connectionType: options.connectionType || DEFAULT_OPTIONS.connectionType,
     auth: options.auth || DEFAULT_OPTIONS.auth,
+    zip: options.zip || DEFAULT_OPTIONS.zip,
   };
 
   // Parse JSON strings from CLI (pass through objects from programmatic)

lib/defaultOptions.js

@@ -31,4 +31,6 @@ export const DEFAULT_OPTIONS = {
   connectionType: false,
   // HTTP basic auth credentials (false = no auth)
   auth: false,
+  // Compress output to zip file (false = no zip)
+  zip: false,
 };

lib/testRunner.js

@@ -18,6 +18,7 @@ import { networkTypes } from './connectivity.js';
 import ffmpeg from 'ffmpeg';
 import ejs from 'ejs';
 import { log, logTimer, generateTestID } from './helpers.js';
+import AdmZip from 'adm-zip';
 
 class TestRunner {
   args = [];
@@ -531,6 +532,18 @@ class TestRunner {
       }
     }
 
+    // handle the zipping
+    if (this.options.zip) {
+      try {
+        const outputZip = `./results/${this.TESTID}.zip`;
+        const zip = new AdmZip();
+        zip.addLocalFolder(this.paths['results']);
+        zip.writeZip(outputZip);
+      } catch (err) {
+        console.error('Error creating zip file:', err);
+      }
+    }
+
     //run cleanup
     this.cleanup();
   }

package.json

@@ -27,6 +27,7 @@
   },
   "dependencies": {
     "@sitespeed.io/throttle": "^5.0.0",
+    "adm-zip": "^0.5.16",
     "commander": "^10.0.0",
     "ejs": "^3.1.10",
     "ffmpeg": "^0.0.4",