@jsenv/test 3.2.1 → 3.3.0

package/src/execution/report_as_json.js

@@ -0,0 +1,121 @@
+import { assertAndNormalizeFileUrl, writeFileSync } from "@jsenv/filesystem";
+import { urlToFileSystemPath } from "@jsenv/urls";
+
+import { replaceUrls } from "./replace_urls.js";
+
+export const reportAsJson = (
+  testPlanResult,
+  fileUrl,
+  { mockFluctuatingValues } = {},
+) => {
+  fileUrl = assertAndNormalizeFileUrl(fileUrl);
+
+  if (!mockFluctuatingValues) {
+    writeFileSync(fileUrl, JSON.stringify(testPlanResult, null, "  "));
+    return;
+  }
+  const testPlanResultCopy = deepCopy(testPlanResult, {});
+  testPlanResultCopy.os.name = "<mock>";
+  testPlanResultCopy.os.version = "<mock>";
+  testPlanResultCopy.os.availableCpu = "<mock>";
+  testPlanResultCopy.os.availableMemory = "<mock>";
+  testPlanResultCopy.process.version = "<mock>";
+  testPlanResultCopy.memoryUsage = "<mock>";
+  testPlanResultCopy.cpuUsage = "<mock>";
+  testPlanResultCopy.rootDirectoryUrl = "/mock/";
+  testPlanResultCopy.timings = "<mock>";
+  for (const group of Object.keys(testPlanResultCopy.groups)) {
+    testPlanResultCopy.groups[group].runtimeVersion = "<mock>";
+  }
+
+  for (const relativeUrl of Object.keys(testPlanResultCopy.results)) {
+    const fileResults = testPlanResultCopy.results[relativeUrl];
+    for (const groupName of Object.keys(fileResults)) {
+      const executionResult = fileResults[groupName];
+      const { consoleCalls } = executionResult;
+      if (consoleCalls) {
+        for (const consoleCall of consoleCalls) {
+          consoleCall.text = mockFluctuatingValuesInMessage(consoleCall.text, {
+            rootDirectoryUrl: testPlanResult.rootDirectoryUrl,
+          });
+          consoleCall.text = consoleCall.text.replace(/\r\n/g, "\n");
+        }
+      }
+      const { errors } = executionResult;
+      if (errors) {
+        for (const error of errors) {
+          if (error.message) {
+            error.message = mockFluctuatingValuesInMessage(error.message, {
+              rootDirectoryUrl: testPlanResult.rootDirectoryUrl,
+            });
+          }
+          if (error.stack) {
+            error.stack = mockFluctuatingValuesInMessage(error.stack, {
+              rootDirectoryUrl: testPlanResult.rootDirectoryUrl,
+            });
+          }
+        }
+      }
+      if (executionResult.timings) {
+        executionResult.timings = "<mock>";
+      }
+      if (Object.hasOwn(executionResult, "memoryUsage")) {
+        executionResult.memoryUsage = "<mock>";
+      }
+      if (executionResult.performance) {
+        executionResult.performance = "<mock>";
+      }
+      if (executionResult.coverageFileUrl) {
+        executionResult.coverageFileUrl = "<mock>";
+      }
+    }
+  }
+  writeFileSync(fileUrl, JSON.stringify(testPlanResultCopy, null, "  "));
+};
+
+const mockFluctuatingValuesInMessage = (message, { rootDirectoryUrl }) => {
+  return replaceUrls(message, ({ url, line, column }) => {
+    let urlAsPath = String(url).startsWith("file:")
+      ? urlToFileSystemPath(url)
+      : url;
+    const rootDirectoryPath = urlToFileSystemPath(rootDirectoryUrl);
+    urlAsPath = urlAsPath.replace(rootDirectoryPath, "/mock/");
+    if (process.platform === "win32") {
+      urlAsPath = urlAsPath.replace(/\\/g, "/");
+    }
+    if (typeof line === "number" && typeof column === "number") {
+      return `${urlAsPath}:${line}:${column}`;
+    }
+    if (typeof line === "number") {
+      return `${urlAsPath}:${line}`;
+    }
+    return urlAsPath;
+  });
+};
+
+const deepCopy = (from, into) => {
+  const copyValue = (value) => {
+    if (value === null) {
+      return null;
+    }
+    if (typeof value === "object") {
+      if (Array.isArray(value)) {
+        return deepCopy(value, []);
+      }
+      return deepCopy(value, {});
+    }
+    return value;
+  };
+
+  if (Array.isArray(from)) {
+    let i = 0;
+    while (i < from.length) {
+      into[i] = copyValue(from[i]);
+      i++;
+    }
+  }
+  for (const key of Object.keys(from)) {
+    into[key] = copyValue(from[key]);
+  }
+  return into;
+};

package/src/execution/reporters/reporter_list.js

@@ -86,9 +86,15 @@ export const reporterList = ({
           Object.keys(testPlanResult.results).length === 0
         ) {
           return {
-            afterEachInOrder: (execution) => {
-              const log = renderExecutionLog(execution, logOptions);
-              write(log);
+            afterEachInOrder: (execution, testPlanResult, testPlanHelpers) => {
+              const log = renderExecutionLog(
+                execution,
+                logOptions,
+                testPlanHelpers,
+              );
+              if (log) {
+                write(log);
+              }
             },
             afterAll: async () => {
               await write(renderOutro(testPlanResult, logOptions));
@@ -156,12 +162,18 @@ export const reporterList = ({
               console.warn(warning.message);
             });
           },
-          afterEachInOrder: (execution) => {
+          afterEachInOrder: (execution, testPlanResult, testPlanHelpers) => {
             oneExecutionWritten = true;
             dynamicLog.clearDuringFunctionCall(
               () => {
-                const log = renderExecutionLog(execution, logOptions);
-                write(log);
+                const log = renderExecutionLog(
+                  execution,
+                  logOptions,
+                  testPlanHelpers,
+                );
+                if (log) {
+                  write(log);
+                }
               },
               // regenerate the dynamic log to put the leading "\n"
               // because of oneExecutionWritten becoming true
@@ -218,11 +230,11 @@ const renderIntro = (testPlanResult, logOptions) => {
 
   let title;
   if (planified === 0) {
-    title = `no file to execute`;
+    title = `nothing to execute`;
   } else if (planified === 1) {
-    title = `1 execution planified`;
+    title = `1 execution ready`;
   } else {
-    title = `${planified} executions planified`;
+    title = `${planified} executions ready`;
   }
   const lines = [];
   lines.push(`directory: ${directory}`);
@@ -244,6 +256,11 @@ const renderIntro = (testPlanResult, logOptions) => {
     testPlanLog += "}";
     lines.push(`testPlan: ${testPlanLog}`);
   }
+  if (testPlanResult.fragment) {
+    lines.push(
+      `fragment: ${testPlanResult.fragment}, executing only ${testPlanResult.fragmentStart}:${testPlanResult.fragmentEnd}`,
+    );
+  }
   if (logOptions.platformInfo) {
     os_line: {
       let osLine = `os: `;
@@ -280,7 +297,36 @@ const renderIntro = (testPlanResult, logOptions) => {
   })}\n`;
 };
 
-const renderExecutionLog = (execution, logOptions) => {
+const renderExecutionLog = (
+  execution,
+  logOptions,
+  { getPreviousExecution, getNextExecution },
+) => {
+  if (execution.skipped) {
+    const skipReason = execution.skipReason;
+    const prev = getPreviousExecution(execution);
+    if (prev && prev.skipped && prev.skipReason === skipReason) {
+      return "";
+    }
+    let nextExecutionSkippedWithSameReason = 0;
+    let next = getNextExecution(execution);
+    while (next) {
+      if (!next.skipped || next.skipReason !== skipReason) {
+        break;
+      }
+      nextExecutionSkippedWithSameReason++;
+      next = getNextExecution(next);
+    }
+    if (nextExecutionSkippedWithSameReason) {
+      const skippedGroupLog = descriptionFormatters.skippedGroup({
+        from: execution.index,
+        to: execution.index + nextExecutionSkippedWithSameReason,
+        skipReason,
+      });
+      return `${skippedGroupLog}\n`;
+    }
+  }
+
   let log = "";
   // label
   {
@@ -361,15 +407,38 @@ const descriptionFormatters = {
   executing: ({ fileRelativeUrl }) => {
     return ANSI.color(`${fileRelativeUrl}`, COLOR_EXECUTING);
   },
+  skippedGroup: ({ from, to, skipReason }) => {
+    let description = `${UNICODE.CIRCLE_DOTTED_RAW} ${from + 1}:${to + 1} skipped`;
+    if (skipReason) {
+      description += ` (${skipReason})`;
+    }
+    return ANSI.color(description, COLOR_SKIPPED);
+  },
+  skipped: ({ index, countersInOrder, fileRelativeUrl, skipReason }) => {
+    const total = countersInOrder.planified;
+    const number = fillLeft(index + 1, total, "0");
+    let description = `${UNICODE.CIRCLE_DOTTED_RAW} ${number}/${total} skipped ${fileRelativeUrl}`;
+    if (skipReason) {
+      description += ` (${skipReason})`;
+    }
+    return ANSI.color(description, COLOR_SKIPPED);
+  },
   aborted: ({ index, countersInOrder, fileRelativeUrl }) => {
     const total = countersInOrder.planified;
     const number = fillLeft(index + 1, total, "0");
-
     return ANSI.color(
       `${UNICODE.FAILURE_RAW} ${number}/${total} ${fileRelativeUrl}`,
       COLOR_ABORTED,
     );
   },
+  cancelled: ({ index, countersInOrder, fileRelativeUrl }) => {
+    const total = countersInOrder.planified;
+    const number = fillLeft(index + 1, total, "0");
+    return ANSI.color(
+      `${UNICODE.FAILURE_RAW} ${number}/${total} ${fileRelativeUrl}`,
+      COLOR_CANCELLED,
+    );
+  },
   timedout: ({ index, countersInOrder, fileRelativeUrl, params }) => {
     const total = countersInOrder.planified;
     const number = fillLeft(index + 1, total, "0");
@@ -397,23 +466,15 @@ const descriptionFormatters = {
       COLOR_COMPLETED,
     );
   },
-  cancelled: ({ index, countersInOrder, fileRelativeUrl }) => {
-    const total = countersInOrder.planified;
-    const number = fillLeft(index + 1, total, "0");
-
-    return ANSI.color(
-      `${UNICODE.FAILURE_RAW} ${number}/${total} ${fileRelativeUrl}`,
-      COLOR_CANCELLED,
-    );
-  },
 };
 
 const COLOR_EXECUTING = ANSI.BLUE;
+const COLOR_SKIPPED = ANSI.GREY;
 const COLOR_ABORTED = ANSI.MAGENTA;
+const COLOR_CANCELLED = ANSI.GREY;
 const COLOR_TIMEOUT = ANSI.MAGENTA;
 const COLOR_FAILED = ANSI.RED;
 const COLOR_COMPLETED = ANSI.GREEN;
-const COLOR_CANCELLED = ANSI.GREY;
 const fillLeft = (value, biggestValue, char = " ") => {
   const width = String(value).length;
   const biggestWidth = String(biggestValue).length;
@@ -691,9 +752,15 @@ const renderStatusRepartition = (counters, { showProgression } = {}) => {
   if (counters.planified === 0) {
     return ``;
   }
+  if (counters.skipped === counters.planified) {
+    return `all ${ANSI.color(`skipped`, COLOR_SKIPPED)}`;
+  }
   if (counters.aborted === counters.planified) {
     return `all ${ANSI.color(`aborted`, COLOR_ABORTED)}`;
   }
+  if (counters.cancelled === counters.planified) {
+    return `all ${ANSI.color(`cancelled`, COLOR_CANCELLED)}`;
+  }
   if (counters.timedout === counters.planified) {
     return `all ${ANSI.color(`timed out`, COLOR_TIMEOUT)}`;
   }
@@ -703,9 +770,6 @@ const renderStatusRepartition = (counters, { showProgression } = {}) => {
   if (counters.completed === counters.planified) {
     return `all ${ANSI.color(`completed`, COLOR_COMPLETED)}`;
   }
-  if (counters.cancelled === counters.planified) {
-    return `all ${ANSI.color(`cancelled`, COLOR_CANCELLED)}`;
-  }
   const parts = [];
   if (counters.timedout) {
     parts.push(
@@ -728,6 +792,9 @@ const renderStatusRepartition = (counters, { showProgression } = {}) => {
       `${counters.cancelled} ${ANSI.color(`cancelled`, COLOR_CANCELLED)}`,
     );
   }
+  if (counters.skipped) {
+    parts.push(`${counters.skipped} ${ANSI.color(`skipped`, COLOR_SKIPPED)}`);
+  }
   if (showProgression) {
     if (counters.executing) {
       parts.push(`${counters.executing} executing`);

package/src/main.js

@@ -14,6 +14,7 @@ export { reportCoverageAsHtml } from "./coverage/report_coverage_as_html.js";
 export { reporterList } from "./execution/reporters/reporter_list.js";
 // other
 export { reportAsJunitXml } from "./execution/junit_xml_file/report_as_junit_xml.js";
+export { reportAsJson } from "./execution/report_as_json.js";
 // advanced
 export { execute } from "./execution/execute.js";
 

package/src/runtime_browsers/firefox.js

@@ -19,7 +19,7 @@ const createFirefoxRuntime = ({
     if (disableOnWindowsBecauseFlaky === undefined) {
       // https://github.com/microsoft/playwright/issues/1396
       console.warn(
-        `Windows + firefox detected: executions on firefox will be ignored  (firefox is flaky on windows).
+        `Windows + firefox detected: executions on firefox will be ignored (firefox is flaky on windows).
 To disable this warning, use disableOnWindowsBecauseFlaky: true
 To ignore potential flakyness, use disableOnWindowsBecauseFlaky: false`,
       );
@@ -28,6 +28,7 @@ To ignore potential flakyness, use disableOnWindowsBecauseFlaky: false`,
     if (disableOnWindowsBecauseFlaky) {
       return {
         disabled: true,
+        disabledReason: "flaky on windows",
       };
     }
   }

package/src/runtime_node/node_child_process.js

@@ -1,8 +1,7 @@
 import { fork } from "node:child_process";
 import { fileURLToPath } from "node:url";
-import supportsColor from "supports-color";
 import { Abort, raceCallbacks } from "@jsenv/abort";
-import { createDetailedMessage } from "@jsenv/humanize";
+import { UNICODE, ANSI, createDetailedMessage } from "@jsenv/humanize";
 import { memoize } from "@jsenv/utils/src/memoize/memoize.js";
 
 import { createChildExecOptions } from "./child_exec_options.js";
@@ -37,11 +36,8 @@ export const nodeChildProcess = ({
   env = {
     ...env,
     JSENV: true,
-    FORCE_COLOR:
-      supportsColor.stdout ||
-      // GitHub workflow does support ANSI but "supports-color" returns false
-      // because stream.isTTY returns false, see https://github.com/actions/runner/issues/241
-      process.env.GITHUB_WORKFLOW,
+    ...(ANSI.supported ? { FORCE_COLOR: "1" } : {}),
+    ...(UNICODE.supported ? { FORCE_UNICODE: "1" } : {}),
   };
 
   return {

package/src/runtime_node/node_worker_thread.js

@@ -3,8 +3,8 @@
 // https://github.com/avajs/ava/blob/576f534b345259055c95fa0c2b33bef10847a2af/lib/worker/base.js
 import { Worker } from "node:worker_threads";
 import { fileURLToPath } from "node:url";
-import supportsColor from "supports-color";
 import { Abort, raceCallbacks } from "@jsenv/abort";
+import { UNICODE, ANSI } from "@jsenv/humanize";
 import { memoize } from "@jsenv/utils/src/memoize/memoize.js";
 
 import { createChildExecOptions } from "./child_exec_options.js";
@@ -33,11 +33,8 @@ export const nodeWorkerThread = ({
   env = {
     ...env,
     JSENV: true,
-    FORCE_COLOR:
-      supportsColor.stdout ||
-      // GitHub workflow does support ANSI but "supports-color" returns false
-      // because stream.isTTY returns false, see https://github.com/actions/runner/issues/241
-      process.env.GITHUB_WORKFLOW,
+    ...(ANSI.supported ? { FORCE_COLOR: "1" } : {}),
+    ...(UNICODE.supported ? { FORCE_UNICODE: "1" } : {}),
   };
 
   return {