@brillout/test-e2e 0.6.20 → 0.6.22

package/dist/Logs.d.ts

@@ -33,11 +33,13 @@ declare function add({ logSource, logText, logInfo, loggedAfterExit, }: {
 /**
  * Expect a log to be printed.
  *
+ * @param pattern String or RegExp to search for in logs.
+ *
  * @param filter Only search in certain types of logs, e.g. only in browser- or server-side logs.
  *
  * @param allLogs Search in all logs, including the logs of previous tests as well as the logs of the setup/prepare scripts. Usually used in combination with the `filter` parameter.
  */
-declare function expectLog(logText: string, { filter: logFilter, allLogs }?: {
+declare function expectLog(pattern: string | RegExp, { filter: logFilter, allLogs }?: {
     filter?: (logEntry: LogEntry) => boolean;
     allLogs?: boolean;
 }): void;

package/dist/Logs.js

@@ -115,28 +115,34 @@ async function terminateUponErrorLog(logSource) {
 /**
  * Expect a log to be printed.
  *
+ * @param pattern String or RegExp to search for in logs.
+ *
  * @param filter Only search in certain types of logs, e.g. only in browser- or server-side logs.
  *
  * @param allLogs Search in all logs, including the logs of previous tests as well as the logs of the setup/prepare scripts. Usually used in combination with the `filter` parameter.
  */
-function expectLog(logText, { filter: logFilter, allLogs } = {}) {
+function expectLog(pattern, { filter: logFilter, allLogs } = {}) {
     const logList = allLogs ? logEntriesAll : logEntries;
+    const isRegex = pattern instanceof RegExp;
+    const patternStr = isRegex ? pattern.toString() : `"${pattern}"`;
     const logsFound = logList.filter((logEntry) => {
-        if (removeAnsi(logEntry).logText.includes(logText)) {
+        const logText = removeAnsi(logEntry).logText;
+        const matches = isRegex ? pattern.test(logText) : logText.includes(pattern);
+        if (matches) {
             logEntry.isNotFailure = true;
             return true;
         }
         return false;
     });
     if (logsFound.length === 0) {
-        throw new Error(`The following log is expected but it wasn't logged: "${logText}"`);
+        throw new Error(`The following log is expected but it wasn't logged: ${patternStr}`);
     }
     if (!logFilter)
         return;
     const logsFoundAfterFilter = logsFound.filter((logEntry) => logFilter(removeAnsi(logEntry)));
     if (logsFoundAfterFilter.length === 0) {
         console.log(JSON.stringify(logsFound, null, 2));
-        throw new Error(`Logs above are matching "${logText}" but don't match the filter you provided.`);
+        throw new Error(`Logs above are matching ${patternStr} but don't match the filter you provided.`);
     }
 }
 function removeAnsi(logEntry) {

package/dist/run.d.ts

@@ -1,6 +1,6 @@
 export { run };
 import type { TolerateError } from './Logs/isTolerateError.js';
-declare function run(cmd: string, { additionalTimeout, serverIsReadyMessage, serverIsReadyDelay, inspect, verbose, cwd, tolerateError, serverUrl, isFlaky, }?: {
+declare function run(cmd: string, { additionalTimeout, serverIsReadyMessage, serverIsReadyDelay, inspect, verbose, cwd, tolerateError, serverUrl, isFlaky, tolerateExitCode, }?: {
     additionalTimeout?: number;
     serverIsReadyMessage?: string | ((log: string) => boolean);
     serverIsReadyDelay?: number;
@@ -11,4 +11,5 @@ declare function run(cmd: string, { additionalTimeout, serverIsReadyMessage, ser
     tolerateError?: TolerateError;
     serverUrl?: string;
     isFlaky?: boolean;
+    tolerateExitCode?: number[];
 }): void;

package/dist/run.js

@@ -8,7 +8,7 @@ import { page } from './page.js';
 import { TIMEOUT_NPM_SCRIPT, TIMEOUT_PLAYWRIGHT, TIMEOUT_PROCESS_TERMINATION } from './TIMEOUTS.js';
 function run(cmd, { 
 //baseUrl = '',
-additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect = cliOptions.inspect, verbose = cliOptions.verbose, cwd, tolerateError, serverUrl, isFlaky, } = {}) {
+additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect = cliOptions.inspect, verbose = cliOptions.verbose, cwd, tolerateError, serverUrl, isFlaky, tolerateExitCode, } = {}) {
     assert(cwd === undefined);
     additionalTimeout += serverIsReadyDelay;
     setRunInfo({
@@ -32,6 +32,7 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
             additionalTimeout,
             serverIsReadyMessage,
             serverIsReadyDelay,
+            tolerateExitCode,
         });
         page.on('console', onConsole);
         page.on('pageerror', onPageError);
@@ -104,7 +105,7 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
         });
     }
 }
-async function startProcess({ serverIsReadyMessage, serverIsReadyDelay, additionalTimeout, cmd, }) {
+async function startProcess({ serverIsReadyMessage, serverIsReadyDelay, additionalTimeout, cmd, tolerateExitCode, }) {
     const cwd = getCwd();
     if (!serverIsReadyMessage) {
         serverIsReadyMessage = (log) => {
@@ -129,6 +130,7 @@ async function startProcess({ serverIsReadyMessage, serverIsReadyDelay, addition
         isReadyLog: serverIsReadyMessage,
         isReadyTimeout: TIMEOUT_NPM_SCRIPT + additionalTimeout,
         killPort: process.env.CI || !isLinux() ? false : getServerPort(),
+        tolerateExitCode,
         onStderr(data, { loggedAfterExit }) {
             Logs.add({
                 logSource: 'stderr',

package/dist/utils/runCommandLongRunning.d.ts

@@ -1,5 +1,5 @@
 export { runCommandLongRunning };
-declare function runCommandLongRunning({ cmd, cwd, killPort, isReadyLog, isReadyTimeout, onStdout, onStderr, onExit, onTerminationError, terminationTimeout, }: {
+declare function runCommandLongRunning({ cmd, cwd, killPort, isReadyLog, isReadyTimeout, onStdout, onStderr, onExit, onTerminationError, terminationTimeout, tolerateExitCode, }: {
     cmd: string;
     cwd: string;
     killPort: false | number;
@@ -14,6 +14,7 @@ declare function runCommandLongRunning({ cmd, cwd, killPort, isReadyLog, isReady
     onExit: (errMsg?: string) => void;
     onTerminationError: (errMsg: string) => void;
     terminationTimeout: number;
+    tolerateExitCode?: number[];
 }): {
     terminate: (force?: true) => Promise<void>;
     isReadyPromise: Promise<void>;

package/dist/utils/runCommandLongRunning.js

@@ -2,7 +2,7 @@ export { runCommandLongRunning };
 import { spawn } from 'child_process';
 import stripAnsi from 'strip-ansi';
 import { assert, runCommandShortLived, humanizeTime, isWindows, isLinux, isCallable } from '../utils.js';
-function runCommandLongRunning({ cmd, cwd, killPort, isReadyLog, isReadyTimeout, onStdout, onStderr, onExit, onTerminationError, terminationTimeout, }) {
+function runCommandLongRunning({ cmd, cwd, killPort, isReadyLog, isReadyTimeout, onStdout, onStderr, onExit, onTerminationError, terminationTimeout, tolerateExitCode, }) {
     if (killPort)
         killByPort(killPort);
     let onError;
@@ -82,7 +82,7 @@ function runCommandLongRunning({ cmd, cwd, killPort, isReadyLog, isReadyTimeout,
         let errMsg;
         {
             const exitIsExpected = isReady === true || isReadyPromiseTimedOut;
-            if (!isSuccessCode(code)) {
+            if (!isSuccessCode(code, tolerateExitCode)) {
                 errMsg = `Unexpected termination of command \`${cmd}\` with exit code ${code}`;
             }
             else if (!exitIsExpected) {
@@ -219,8 +219,14 @@ async function killByPort(port) {
     assert(port);
     await runCommandShortLived(`fuser -k ${port}/tcp`, { swallowError: true, timeout: 10 * 1000 });
 }
-function isSuccessCode(code) {
-    return code === 0 || code === null || (code === 1 && isWindows());
+function isSuccessCode(code, tolerateExitCode) {
+    if (code === 0 || code === null || (code === 1 && isWindows())) {
+        return true;
+    }
+    if (tolerateExitCode?.includes(code)) {
+        return true;
+    }
+    return false;
 }
 // Workaround for Node.js regression:
 //  - https://github.com/nodejs/node/issues/52475

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/test-e2e",
-  "version": "0.6.20",
+  "version": "0.6.22",
   "bin": "./bin.js",
   "main": "./dist/index.js",
   "type": "module",