feat: Support archive files and folders

package.json

@@ -25,7 +25,7 @@
     "dotenv": "16.3.1",
     "lodash": "^4.17.21",
     "mocha-junit-reporter": "^2.2.1",
-    "sauce-testrunner-utils": "2.0.0",
+    "sauce-testrunner-utils": "2.1.1",
     "shelljs": "^0.8.5",
     "testcafe": "3.5.0",
     "testcafe-browser-provider-ios": "0.5.0",

src/testcafe-runner.ts

@@ -8,6 +8,7 @@ import {
   getAbsolutePath,
   prepareNpmEnv,
   preExec,
+  zip,
 } from 'sauce-testrunner-utils';
 
 import { TestCafeConfig, Suite, CompilerOptions, second } from './type';
@@ -27,6 +28,7 @@ async function prepareConfiguration(
     runCfg.projectPath || '.',
   );
   const assetsPath = path.join(path.dirname(runCfgPath), '__assets__');
+  runCfg.assetsPath = assetsPath;
   const suite = getSuite(runCfg, suiteName) as Suite | undefined;
   if (!suite) {
     throw new Error(`Could not find suite '${suiteName}'`);
@@ -66,7 +68,7 @@ async function prepareConfiguration(
   // Install NPM dependencies
   await prepareNpmEnv(runCfg, nodeCtx);
 
-  return { projectPath, assetsPath, suite };
+  return { runCfg, projectPath, assetsPath, suite };
 }
 
 // Build --compiler-options argument
@@ -318,10 +320,26 @@ async function runTestCafe(
   return false;
 }
 
+function zipArtifacts(runCfg: TestCafeConfig) {
+  if (!runCfg.artifacts || !runCfg.artifacts.retain) {
+    return;
+  }
+  Object.keys(runCfg.artifacts.retain).forEach((source) => {
+    const dest = path.join(runCfg.assetsPath, runCfg.artifacts.retain[source]);
+    try {
+      zip(path.dirname(runCfg.path), source, dest);
+    } catch (err) {
+      console.error(
+        `Zip file creation failed for destination: "${dest}", source: "${source}". Error: ${err}.`,
+      );
+    }
+  });
+}
+
 async function run(nodeBin: string, runCfgPath: string, suiteName: string) {
   const preExecTimeout = 300;
 
-  const { projectPath, assetsPath, suite } = await prepareConfiguration(
+  const { runCfg, projectPath, assetsPath, suite } = await prepareConfiguration(
     nodeBin,
     runCfgPath,
     suiteName,
@@ -377,6 +395,7 @@ async function run(nodeBin: string, runCfgPath: string, suiteName: string) {
   } catch (e) {
     console.warn('Skipping JUnit file generation:', e);
   }
+  zipArtifacts(runCfg);
 
   return passed;
 }

src/type.ts

@@ -103,4 +103,11 @@ export type TestCafeConfig = {
     version: string;
     configFile?: string;
   };
+  artifacts: Artifacts;
+};
+
+export type Artifacts = {
+  retain: {
+    [key: string]: string;
+  };
 };