@brillout/test-e2e 0.5.8 → 0.5.9

package/dist/Logs.d.ts

@@ -25,4 +25,4 @@ declare function add({ logSource, logText, loggedAfterExit, }: {
     logText: string;
     loggedAfterExit?: boolean;
 }): void;
-declare function expectError(logFilter: (browserLog: LogEntry) => boolean): void;
+declare function expectError(userFilter: (logEntry: LogEntry) => boolean): void;

package/dist/Logs.js

@@ -17,6 +17,7 @@ const picocolors_1 = __importDefault(require("picocolors"));
 const getCurrentTest_1 = require("./getCurrentTest");
 const logSection_1 = require("./logSection");
 const isTolerateError_1 = require("./Logs/isTolerateError");
+const expect_1 = require("./chai/expect");
 let logEntries = [];
 function hasFailLogs(failOnWarning) {
     const failLogs = getErrorLogs(failOnWarning);
@@ -74,16 +75,15 @@ function add({ logSource, logText, loggedAfterExit = false, }) {
         printLog(logEntry);
     }
 }
-function expectError(logFilter) {
+function expectError(userFilter) {
     const logFounds = logEntries.filter((logEntry) => {
-        if (logFilter(logEntry)) {
+        if (userFilter(logEntry)) {
             logEntry.isNotFailure = true;
             return true;
         }
         return false;
     });
-    //expect(logFounds.length).not.toBe(0)
-    (0, utils_1.assert)(logFounds.length > 0);
+    (0, expect_1.expect)(logFounds.length).not.toBe(0);
 }
 exports.expectError = expectError;
 function getTimestamp() {

package/dist/TIMEOUTS.d.ts

@@ -0,0 +1,5 @@
+export declare const TIMEOUT_NPM_SCRIPT: number;
+export declare const TIMEOUT_TEST_FUNCTION: number;
+export declare const TIMEOUT_PROCESS_TERMINATION: number;
+export declare const TIMEOUT_AUTORETRY: number;
+export declare const TIMEOUT_PLAYWRIGHT: number;

package/dist/TIMEOUTS.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TIMEOUT_PLAYWRIGHT = exports.TIMEOUT_AUTORETRY = exports.TIMEOUT_PROCESS_TERMINATION = exports.TIMEOUT_TEST_FUNCTION = exports.TIMEOUT_NPM_SCRIPT = void 0;
+const platform_1 = require("./utils/platform");
+exports.TIMEOUT_NPM_SCRIPT = 2 * 60 * 1000 * (!(0, platform_1.isCI)() ? 1 : (0, platform_1.isWindows)() ? 2 : 1);
+exports.TIMEOUT_TEST_FUNCTION = 60 * 1000 * (!(0, platform_1.isCI)() ? 1 : (0, platform_1.isWindows)() ? 5 : 3);
+exports.TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!(0, platform_1.isCI)() ? 1 : (0, platform_1.isWindows)() ? 3 : !(0, platform_1.isLinux)() ? 3 : 1);
+exports.TIMEOUT_AUTORETRY = exports.TIMEOUT_TEST_FUNCTION / 2;
+exports.TIMEOUT_PLAYWRIGHT = exports.TIMEOUT_TEST_FUNCTION / 2;

package/dist/autoRetry.d.ts

@@ -0,0 +1,4 @@
+export { autoRetry };
+declare function autoRetry(test: () => void | Promise<void>, { timeout }?: {
+    timeout?: number;
+}): Promise<void>;

package/dist/autoRetry.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.autoRetry = void 0;
+const TIMEOUTS_1 = require("./TIMEOUTS");
+const utils_1 = require("./utils");
+async function autoRetry(test, { timeout = TIMEOUTS_1.TIMEOUT_AUTORETRY } = {}) {
+    const period = 100;
+    const numberOfTries = timeout / period;
+    let i = 0;
+    while (true) {
+        try {
+            await test();
+            return;
+        }
+        catch (err) {
+            i = i + 1;
+            if (i > numberOfTries) {
+                throw err;
+            }
+        }
+        await (0, utils_1.sleep)(period);
+    }
+}
+exports.autoRetry = autoRetry;

package/dist/buildTs.js

@@ -17,7 +17,7 @@ async function buildTs(entry, outfile) {
         outfile,
         logLevel: 'warning',
         format: 'esm',
-        target: 'es2020',
+        target: 'es2022',
         bundle: true,
         packages: 'external',
         minify: false,

package/dist/cli.js

@@ -30,6 +30,7 @@ function initUserExitHandler() {
         Logs_1.Logs.flushLogs();
     });
 }
+// Much simpler alternative: https://github.com/brillout/vite-plugin-ssr/blob/77b1b0e8b6c1ed4efe3e3039f7c0b23a00651663/vite-plugin-ssr/node/plugin/plugins/importUserCode/v1-design/transpileAndLoadFile.ts#L200-L208
 function initSourceMap() {
     source_map_support_1.default.install({
         retrieveSourceMap: function (source) {

package/dist/getCurrentTest.d.ts

@@ -1,6 +1,9 @@
 export { getCurrentTest };
 export { getCurrentTestOptional };
 export { setCurrentTest };
+export { getRunInfo };
+export { setRunInfo };
+export { getCwd };
 export type { TestInfo };
 import type { Page } from 'playwright-chromium';
 declare type TestInfo = {
@@ -10,17 +13,18 @@ declare type TestInfo = {
         testDesc: string;
         testFn: Function;
     }[];
+    testOptions?: {
+        doNotFailOnWarning: boolean;
+        testFunctionTimeout: number;
+        isFlaky: boolean;
+    };
     runInfo?: {
         cmd: string;
-        cwd: string;
-        testFunctionTimeout: number;
-        additionalTimeout: number;
-        serverIsReadyMessage?: string | ((log: string) => boolean);
-        serverIsReadyDelay: number;
-        inspect: boolean;
-        doNotFailOnWarning: boolean;
         serverUrl: string;
+        doNotFailOnWarning: boolean;
+        testFunctionTimeout: number;
         isFlaky: boolean;
+        isRunCommandThatTerminates: boolean;
     };
     hasStartedRunning?: boolean;
     skipped?: {
@@ -34,3 +38,20 @@ declare type TestInfo = {
 declare function getCurrentTest(): TestInfo;
 declare function getCurrentTestOptional(): null | TestInfo;
 declare function setCurrentTest(testFile: null | string): void;
+declare function getRunInfo(): {
+    cmd: string;
+    serverUrl: string;
+    doNotFailOnWarning: boolean;
+    testFunctionTimeout: number;
+    isFlaky: boolean;
+    isRunCommandThatTerminates: boolean;
+};
+declare function setRunInfo({ cmd, serverUrl, additionalTimeout, doNotFailOnWarning, isFlaky, isRunCommandThatTerminates, }: {
+    cmd: string;
+    serverUrl?: string;
+    additionalTimeout?: number;
+    doNotFailOnWarning?: boolean;
+    isFlaky?: boolean;
+    isRunCommandThatTerminates?: boolean;
+}): void;
+declare function getCwd(): string;

package/dist/getCurrentTest.js

@@ -3,9 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setCurrentTest = exports.getCurrentTestOptional = exports.getCurrentTest = void 0;
+exports.getCwd = exports.setRunInfo = exports.getRunInfo = exports.setCurrentTest = exports.getCurrentTestOptional = exports.getCurrentTest = void 0;
 const utils_1 = require("./utils");
 const path_1 = __importDefault(require("path"));
+const TIMEOUTS_1 = require("./TIMEOUTS");
 let testInfo = null;
 function getCurrentTest() {
     (0, utils_1.assert)(testInfo);
@@ -42,3 +43,29 @@ function removeRootDir(filePath) {
     (0, utils_1.assert)(filePath.startsWith(rootDir));
     return filePath.slice(rootDir.length);
 }
+function getRunInfo() {
+    const testInfo = getCurrentTest();
+    (0, utils_1.assert)(testInfo.runInfo);
+    return testInfo.runInfo;
+}
+exports.getRunInfo = getRunInfo;
+const serverUrlDefault = 'http://localhost:3000';
+function setRunInfo({ cmd, serverUrl = serverUrlDefault, additionalTimeout = 0, doNotFailOnWarning = false, isFlaky = false, isRunCommandThatTerminates = false, }) {
+    const testInfo = getCurrentTest();
+    const testFunctionTimeout = TIMEOUTS_1.TIMEOUT_TEST_FUNCTION + additionalTimeout;
+    testInfo.runInfo = {
+        cmd,
+        serverUrl,
+        testFunctionTimeout,
+        doNotFailOnWarning,
+        isFlaky,
+        isRunCommandThatTerminates,
+    };
+}
+exports.setRunInfo = setRunInfo;
+function getCwd() {
+    const { testFile } = getCurrentTest();
+    const cwd = path_1.default.dirname(testFile);
+    return cwd;
+}
+exports.getCwd = getCwd;

package/dist/logTestStatus.js

@@ -51,8 +51,11 @@ function getStatusTags() {
     return { PASS, FAIL, WARN, BOOT };
 }
 function logBoot() {
+    if (!utils_1.isTTY)
+        return;
     const { testFile } = (0, getCurrentTest_1.getCurrentTest)();
     const { BOOT } = getStatusTags();
+    console.log();
     console.log(`${BOOT} ${testFile}`);
 }
 exports.logBoot = logBoot;

package/dist/runAll.js

@@ -59,25 +59,48 @@ async function buildAndTest(testFile, browser, isSecondAttempt) {
     (0, utils_1.assert)(testFileJs.endsWith('.mjs'));
     const cleanBuild = await (0, buildTs_1.buildTs)(testFile, testFileJs);
     (0, getCurrentTest_2.setCurrentTest)(testFile);
+    (0, logTestStatus_1.logBoot)();
+    let execErr;
     try {
         await import((0, utils_2.fsWindowsBugWorkaround)(testFileJs) + `?cacheBuster=${Date.now()}`);
     }
+    catch (err) {
+        (0, utils_1.assert)(err);
+        execErr = err;
+    }
     finally {
         cleanBuild();
     }
+    if (execErr) {
+        (0, logTestStatus_1.logFail)(`an error was thrown while executing the file ${testFile}`, true);
+        (0, logError_1.logError)(execErr);
+        return false;
+    }
+    // When user calls run runCommandThatTerminates()
+    {
+        const testInfo = (0, getCurrentTest_1.getCurrentTest)();
+        // Set when user calls run() or runCommandThatTerminates()
+        (0, utils_1.assert)(testInfo.runInfo);
+        if (testInfo.runInfo.isRunCommandThatTerminates) {
+            (0, utils_1.assertUsage)(!testInfo.tests, "Can't call test() when calling runCommandThatTerminates()");
+            (0, utils_1.assertUsage)(!testInfo.startServer, "Can't call run() when calling runCommandThatTerminates()");
+            (0, logTestStatus_1.logPass)();
+            return true;
+        }
+    }
     const success = await runServerAndTests(browser, isSecondAttempt);
     (0, getCurrentTest_2.setCurrentTest)(null);
     return success;
 }
 async function runServerAndTests(browser, isSecondAttempt) {
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    // Set when user calls `skip()`
+    // Set when user calls skip()
     if (testInfo.skipped) {
         assertSkipUsage(testInfo);
         (0, logTestStatus_1.logWarn)(testInfo.skipped.reason);
         return true;
     }
-    // Set when user calls `run()`
+    // Set when user calls run()
     (0, utils_1.assert)(testInfo.runInfo);
     (0, utils_1.assert)(testInfo.startServer);
     (0, utils_1.assert)(testInfo.terminateServer);
@@ -123,9 +146,12 @@ async function runTests(testInfo, isFinalAttempt) {
     // Set when user calls `run()`
     (0, utils_1.assert)(testInfo.runInfo);
     (0, utils_1.assert)(testInfo.afterEach);
-    // Set when user calls `test()`
-    (0, utils_1.assert)(testInfo.tests);
-    for (const { testDesc, testFn } of testInfo.tests) {
+    const tests = 
+    // Set when user calls test()
+    testInfo.tests ??
+        // When user hasn't any test() call
+        [];
+    for (const { testDesc, testFn } of tests) {
         Logs_1.Logs.add({
             logSource: 'test()',
             logText: testDesc,

package/dist/runCommandThatTerminates.d.ts

@@ -0,0 +1,4 @@
+export { runCommandThatTerminates };
+declare function runCommandThatTerminates(cmd: string, { timeout }?: {
+    timeout?: number;
+}): Promise<void>;

package/dist/runCommandThatTerminates.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCommandThatTerminates = void 0;
+const getCurrentTest_1 = require("./getCurrentTest");
+const utils_1 = require("./utils");
+async function runCommandThatTerminates(cmd, { timeout = 2 * 60 * 1000 } = {}) {
+    (0, getCurrentTest_1.setRunInfo)({ cmd, isRunCommandThatTerminates: true });
+    const cwd = (0, getCurrentTest_1.getCwd)();
+    await (0, utils_1.runCommand)(cmd, { timeout, cwd });
+}
+exports.runCommandThatTerminates = runCommandThatTerminates;

package/dist/setup.d.ts

@@ -1,7 +1,5 @@
-import { sleep, isWindows, isLinux, isCI, isMac } from './utils';
-import fetch_ from 'node-fetch';
 export { partRegex } from '@brillout/part-regex';
-export { autoRetry };
+export { autoRetry } from './autoRetry';
 export { fetchHtml };
 export { fetch };
 export { expectError } from './Logs';
@@ -14,20 +12,21 @@ export { isWindows };
 export { isMac };
 export { sleep };
 export { getServerUrl };
+export { runCommandThatTerminates } from './runCommandThatTerminates';
+import { sleep, isWindows, isLinux, isCI, isMac } from './utils';
+import fetch_ from 'node-fetch';
 declare function skip(reason: string): void;
 declare function run(cmd: string, { additionalTimeout, serverIsReadyMessage, serverIsReadyDelay, inspect, cwd, doNotFailOnWarning, serverUrl, isFlaky, }?: {
     additionalTimeout?: number;
     serverIsReadyMessage?: string | ((log: string) => boolean);
     serverIsReadyDelay?: number;
     inspect?: boolean;
+    /** deprecated */
     cwd?: string;
     doNotFailOnWarning?: boolean;
     serverUrl?: string;
     isFlaky?: boolean;
 }): void;
-declare function autoRetry(test: () => void | Promise<void>, { timeout }?: {
-    timeout?: number;
-}): Promise<void>;
 declare function fetchHtml(pathname: string): Promise<string>;
 declare function fetch(...args: Parameters<typeof fetch_>): Promise<import("node-fetch").Response>;
 declare function isMinNodeVersion(minNodeVersion: 14): boolean;