@brillout/test-e2e 0.3.12 → 0.4.1

package/dist/Logs.js

@@ -16,6 +16,7 @@ const utils_1 = require("./utils");
 const picocolors_1 = __importDefault(require("picocolors"));
 const getCurrentTest_1 = require("./getCurrentTest");
 const getConfig_1 = require("./getConfig");
+const logSection_1 = require("./logSection");
 let logEntries = [];
 function hasErrorLogs(failOnWarning) {
     const errorLogs = getErrorLogs(failOnWarning);
@@ -43,11 +44,14 @@ function clearLogs() {
     logEntries = [];
 }
 function logErrors(failOnWarning) {
+    if (!exports.Logs.hasErrorLogs(failOnWarning))
+        return;
+    (0, logSection_1.logSection)(`ERROR${!failOnWarning ? '' : '/WARNING'} LOGS`);
     const errorLogs = getErrorLogs(failOnWarning);
     errorLogs.forEach((logEntry) => printLog(logEntry));
 }
 function flushLogs() {
-    console.log(picocolors_1.default.bold('vvvv ALL LOGS vvvv'));
+    (0, logSection_1.logSection)('ALL LOGS');
     logEntries.forEach((logEntry) => printLog(logEntry));
     logEntries = [];
 }

package/dist/cli.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const source_map_support_1 = __importDefault(require("source-map-support"));
 const utils_1 = require("./utils");
-const runTestSuites_1 = require("./runTestSuites");
+const runTests_1 = require("./runTests");
 const buildTs_1 = require("./buildTs");
 const Logs_1 = require("./Logs");
 initSourceMap();
@@ -14,7 +14,7 @@ initUserExitHandler();
 cli();
 function cli() {
     const filter = (0, utils_1.findFilesParseCliArgs)();
-    (0, runTestSuites_1.runTestSuites)(filter);
+    (0, runTests_1.runTests)(filter);
 }
 function initPromiseRejectionHandler() {
     process.on('unhandledRejection', function (err) {

package/dist/findTestFiles.js

@@ -1,24 +1,17 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findTestFiles = void 0;
-const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
-const fs_1 = __importDefault(require("fs"));
-const cwd = process.cwd();
-// Unit tests `**/*.spec.*` are handled by Vitesse
+const github_action_1 = require("./github-action");
+// Unit tests `**/*.spec.*` are handled by Vitest
 const testFilenamePattern = '**/*.test.ts';
 async function findTestFiles(findFilter) {
-    if (process.env.TEST_FILES) {
-        const testFiles = process.env.TEST_FILES.split(' ').map((filePathRelative) => path_1.default.join(cwd, filePathRelative));
-        testFiles.forEach((testFile) => {
-            (0, utils_1.assert)(fs_1.default.existsSync(testFile), testFile);
-        });
-        return testFiles;
+    {
+        const testFiles = (0, github_action_1.getTestFiles)();
+        if (testFiles)
+            return testFiles;
     }
-    else {
+    {
         const testFiles = (0, utils_1.findFiles)(testFilenamePattern, findFilter);
         return testFiles;
     }

package/dist/github-action.d.ts

@@ -0,0 +1,4 @@
+export { abortIfGitHubAction };
+export { getTestFiles };
+declare function abortIfGitHubAction(): void;
+declare function getTestFiles(): null | string[];

package/dist/github-action.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTestFiles = exports.abortIfGitHubAction = void 0;
+const utils_1 = require("./utils");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const cwd = process.cwd();
+function abortIfGitHubAction() {
+    if (isGitHubAction()) {
+        process.exit(1);
+    }
+}
+exports.abortIfGitHubAction = abortIfGitHubAction;
+function isGitHubAction() {
+    return getTestFiles() !== null;
+}
+function getTestFiles() {
+    if (!('TEST_FILES' in process.env))
+        return null;
+    (0, utils_1.assert)(process.env.TEST_FILES);
+    const testFiles = process.env.TEST_FILES.split(' ').map((filePathRelative) => path_1.default.join(cwd, filePathRelative));
+    testFiles.forEach((testFile) => {
+        (0, utils_1.assert)(fs_1.default.existsSync(testFile), testFile);
+    });
+    return testFiles;
+}
+exports.getTestFiles = getTestFiles;

package/dist/logSection.d.ts

@@ -0,0 +1,2 @@
+export { logSection };
+declare function logSection(sectionTitle: string): void;

package/dist/logSection.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logSection = void 0;
+const picocolors_1 = __importDefault(require("picocolors"));
+function logSection(sectionTitle) {
+    console.log();
+    console.log();
+    console.log();
+    console.log(picocolors_1.default.bold(`vvvvvv ${sectionTitle} vvvvvv`));
+}
+exports.logSection = logSection;

package/dist/runTests.d.ts

@@ -1,3 +1,3 @@
 export { runTests };
-import type { Browser } from 'playwright-chromium';
-declare function runTests(browser: Browser): Promise<void>;
+import { type FindFilter } from './utils';
+declare function runTests(filter: null | FindFilter): Promise<void>;

package/dist/runTests.js

@@ -7,8 +7,38 @@ exports.runTests = void 0;
 const getCurrentTest_1 = require("./getCurrentTest");
 const Logs_1 = require("./Logs");
 const utils_1 = require("./utils");
+const utils_2 = require("./utils");
 const picocolors_1 = __importDefault(require("picocolors"));
-async function runTests(browser) {
+const github_action_1 = require("./github-action");
+const logSection_1 = require("./logSection");
+const getCurrentTest_2 = require("./getCurrentTest");
+const getBrowser_1 = require("./getBrowser");
+const buildTs_1 = require("./buildTs");
+const findTestFiles_1 = require("./findTestFiles");
+const getConfig_1 = require("./getConfig");
+async function runTests(filter) {
+    await (0, getConfig_1.loadConfig)();
+    const testFiles = await (0, findTestFiles_1.findTestFiles)(filter);
+    const browser = await (0, getBrowser_1.getBrowser)();
+    for (const testFile of testFiles) {
+        (0, utils_1.assert)(testFile.endsWith('.ts'));
+        const testFileJs = testFile.replace('.ts', '.mjs');
+        const clean = await (0, buildTs_1.buildTs)(testFile, testFileJs);
+        (0, getCurrentTest_2.setCurrentTest)(testFile);
+        try {
+            await import((0, utils_2.fsWindowsBugWorkaround)(testFileJs));
+        }
+        finally {
+            clean();
+        }
+        await runTestFile(browser);
+        (0, getCurrentTest_2.setCurrentTest)(null);
+        (0, utils_1.assert)(testFileJs.endsWith('.mjs'));
+    }
+    await browser.close();
+}
+exports.runTests = runTests;
+async function runTestFile(browser) {
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
     if (utils_1.isTTY) {
         console.log();
@@ -18,7 +48,7 @@ async function runTests(browser) {
     testInfo.page = page;
     // Set when user calls `skip()`
     if (testInfo.skipped) {
-        logTestsResult(false);
+        logResult(false);
         (0, utils_1.assertUsage)(!testInfo.runInfo, 'You cannot call `run()` after calling `skip()`');
         (0, utils_1.assertUsage)(testInfo.tests === undefined, 'You cannot call `test()` after calling `skip()`');
         return;
@@ -30,15 +60,25 @@ async function runTests(browser) {
     (0, utils_1.assert)(testInfo.afterEach);
     // Set when user calls `test()`
     (0, utils_1.assert)(testInfo.tests);
+    const clean = async () => {
+        await testInfo.terminateServer?.();
+        await page.close();
+    };
+    const abort = async () => {
+        await clean();
+        (0, github_action_1.abortIfGitHubAction)();
+    };
     // TODO: resolve a success flag instead rejecting
     try {
         await testInfo.startServer();
     }
     catch (err) {
-        logTestsResult(false);
-        console.log(err);
+        logResult(false);
+        logFailureReason('an error occurred while starting the server');
+        logError(err);
         Logs_1.Logs.flushLogs();
-        process.exit(1);
+        await abort();
+        return;
     }
     for (const { testDesc, testFn } of testInfo.tests) {
         Logs_1.Logs.add({
@@ -55,41 +95,48 @@ async function runTests(browser) {
         }
         done(!!err);
         testInfo.afterEach(!!err);
-        const { doNotFailOnWarning } = testInfo.runInfo;
-        const hasErrorLog = Logs_1.Logs.hasErrorLogs(!doNotFailOnWarning);
-        const isFailure = err || hasErrorLog;
-        if (isFailure) {
-            logTestsResult(false);
-            if (err) {
-                console.log(err);
-            }
-            else if (hasErrorLog) {
-                logIsFailure(false, !doNotFailOnWarning);
+        {
+            const failOnWarning = !testInfo.runInfo.doNotFailOnWarning;
+            const hasErrorLog = Logs_1.Logs.hasErrorLogs(failOnWarning);
+            const isFailure = err || hasErrorLog;
+            if (isFailure) {
+                logResult(false);
+                if (err) {
+                    logFailureReason(`the test "${testDesc}" threw an error`);
+                    logError(err);
+                }
+                else if (hasErrorLog) {
+                    logFailureReason(`${getErrorType(failOnWarning)} occurred while running the test "${testDesc}"`);
+                }
+                else {
+                    (0, utils_1.assert)(false);
+                }
+                Logs_1.Logs.logErrors(failOnWarning);
+                Logs_1.Logs.flushLogs();
+                await abort();
+                return;
             }
-            Logs_1.Logs.flushLogs();
-            process.exit(1);
-        }
-        else {
-            Logs_1.Logs.clearLogs();
         }
+        Logs_1.Logs.clearLogs();
     }
-    await testInfo.terminateServer();
-    await page.close();
-    // Handle case that an error occured during `terminateServer()`
-    if (Logs_1.Logs.hasErrorLogs(true)) {
-        if ((0, utils_1.isWindows)()) {
-            // On Windows, the sever sometimes terminates with an exit code of `1`. I don't know why.
-            Logs_1.Logs.clearLogs();
-        }
-        else {
-            logIsFailure(true, false);
+    await clean();
+    // Check whether stderr emitted during testInfo.terminateServer()
+    {
+        const failOnWarning = true;
+        if (Logs_1.Logs.hasErrorLogs(failOnWarning)) {
+            logFailureReason(`${getErrorType(failOnWarning)} occurred during server termination`);
+            Logs_1.Logs.logErrors(failOnWarning);
             Logs_1.Logs.flushLogs();
-            process.exit(1);
+            await abort();
+            return;
         }
     }
-    logTestsResult(true);
+    Logs_1.Logs.clearLogs();
+    logResult(true);
+}
+function getErrorType(failOnWarning) {
+    return !failOnWarning ? 'error(s)' : 'error(s)/warning(s)';
 }
-exports.runTests = runTests;
 function runTest(testFn, testFunctionTimeout) {
     let resolve;
     let reject;
@@ -115,30 +162,35 @@ function runTest(testFn, testFunctionTimeout) {
     })();
     return promise;
 }
-function logTestsResult(success) {
+function logResult(success) {
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    const passStyle = (t) => picocolors_1.default.bold(picocolors_1.default.bgGreen(t));
-    const failStyle = (t) => picocolors_1.default.bold(picocolors_1.default.bgRed(t));
-    const skipStyle = (t) => picocolors_1.default.bold(picocolors_1.default.bgYellow(t));
+    const { PASS, FAIL, WARN } = getStatusTags();
     if (success) {
         (0, utils_1.assert)(!testInfo.skipped);
-        console.log(`${passStyle(' PASS ')} ${testInfo.testFile}`);
+        console.log(`${PASS} ${testInfo.testFile}`);
         return;
     }
     if (testInfo.skipped) {
-        console.log(`${skipStyle(' WARN ')} ${testInfo.testFile} (${testInfo.skipped})`);
+        console.log(`${WARN} ${testInfo.testFile} (${testInfo.skipped})`);
     }
     else {
-        console.log(`${failStyle(' FAIL ')} ${testInfo.testFile}`);
+        console.log(`${FAIL} ${testInfo.testFile}`);
     }
 }
-function logIsFailure(isTermination, failOnWarning) {
-    console.log(picocolors_1.default.red(picocolors_1.default.bold([
-        'Test FAIL because encountered an error',
-        !failOnWarning ? '' : ' or warning',
-        !isTermination ? '' : ' during termination',
-        ', see logs below.',
-    ].join(''))));
-    console.log(picocolors_1.default.bold('vvvv FAIL LOG vvvv'));
-    Logs_1.Logs.logErrors(failOnWarning);
+function logFailureReason(reason) {
+    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
+    const { FAIL } = getStatusTags();
+    const color = (s) => picocolors_1.default.red(picocolors_1.default.bold(s));
+    const msg = `Test ${testInfo.testFile} ${FAIL} because ${reason}, see below.`;
+    console.log(color(msg));
+}
+function logError(err) {
+    (0, logSection_1.logSection)('ERROR');
+    console.log(err);
+}
+function getStatusTags() {
+    const PASS = picocolors_1.default.bold(picocolors_1.default.bgGreen(picocolors_1.default.white(' PASS ')));
+    const FAIL = picocolors_1.default.bold(picocolors_1.default.bgRed(picocolors_1.default.white(' FAIL ')));
+    const WARN = picocolors_1.default.bold(picocolors_1.default.bgYellow(picocolors_1.default.white(' WARN ')));
+    return { PASS, FAIL, WARN };
 }

package/dist/setup.d.ts

@@ -1,4 +1,4 @@
-import { sleep, isWindows, isLinux, isGithubAction, isMac } from './utils';
+import { sleep, isWindows, isLinux, isCI, isMac } from './utils';
 import fetch_ from 'node-fetch';
 export { partRegex } from '@brillout/part-regex';
 export { autoRetry };
@@ -8,7 +8,7 @@ export { expectError } from './Logs';
 export { run };
 export { skip };
 export { isMinNodeVersion };
-export { isGithubAction };
+export { isCI };
 export { isLinux };
 export { isWindows };
 export { isMac };

package/dist/setup.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getServerUrl = exports.sleep = exports.isMac = exports.isWindows = exports.isLinux = exports.isGithubAction = exports.isMinNodeVersion = exports.skip = exports.run = exports.expectError = exports.fetch = exports.fetchHtml = exports.autoRetry = exports.partRegex = void 0;
+exports.getServerUrl = exports.sleep = exports.isMac = exports.isWindows = exports.isLinux = exports.isCI = exports.isMinNodeVersion = exports.skip = exports.run = exports.expectError = exports.fetch = exports.fetchHtml = exports.autoRetry = exports.partRegex = void 0;
 const child_process_1 = require("child_process");
 const path_1 = require("path");
 const utils_1 = require("./utils");
 Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return utils_1.sleep; } });
 Object.defineProperty(exports, "isWindows", { enumerable: true, get: function () { return utils_1.isWindows; } });
 Object.defineProperty(exports, "isLinux", { enumerable: true, get: function () { return utils_1.isLinux; } });
-Object.defineProperty(exports, "isGithubAction", { enumerable: true, get: function () { return utils_1.isGithubAction; } });
+Object.defineProperty(exports, "isCI", { enumerable: true, get: function () { return utils_1.isCI; } });
 Object.defineProperty(exports, "isMac", { enumerable: true, get: function () { return utils_1.isMac; } });
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const utils_2 = require("./utils");
@@ -24,9 +24,9 @@ Object.defineProperty(exports, "partRegex", { enumerable: true, get: function ()
 var Logs_2 = require("./Logs");
 Object.defineProperty(exports, "expectError", { enumerable: true, get: function () { return Logs_2.expectError; } });
 const serverUrlDefault = 'http://localhost:3000';
-const TIMEOUT_NPM_SCRIPT = 2 * 60 * 1000 * (!(0, utils_1.isGithubAction)() ? 1 : (0, utils_1.isWindows)() ? 2 : 1);
-const TIMEOUT_TEST_FUNCTION = 60 * 1000 * (!(0, utils_1.isGithubAction)() ? 1 : (0, utils_1.isWindows)() ? 5 : 3);
-const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!(0, utils_1.isGithubAction)() ? 1 : (0, utils_1.isLinux)() ? 1 : 4);
+const TIMEOUT_NPM_SCRIPT = 2 * 60 * 1000 * (!(0, utils_1.isCI)() ? 1 : (0, utils_1.isWindows)() ? 2 : 1);
+const TIMEOUT_TEST_FUNCTION = 60 * 1000 * (!(0, utils_1.isCI)() ? 1 : (0, utils_1.isWindows)() ? 5 : 3);
+const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!(0, utils_1.isCI)() ? 1 : (0, utils_1.isWindows)() ? 10 : !(0, utils_1.isLinux)() ? 3 : 1);
 const TIMEOUT_AUTORETRY = TIMEOUT_TEST_FUNCTION / 2;
 const TIMEOUT_PLAYWRIGHT = TIMEOUT_TEST_FUNCTION / 2;
 function skip(reason) {
@@ -357,7 +357,10 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
                 logSource: 'run() failure',
                 logText: errMsg,
             });
-            reject(new Error(errMsg));
+            /* Don't interrupt the test runner, as the test runner may recover thanks to the process-killing-by-port
+            reject(new Error(errMsg))
+            */
+            resolve();
         }, TIMEOUT_PROCESS_TERMINATION);
         (0, utils_2.assert)(proc);
         try {

package/dist/utils/platform.d.ts

@@ -1,8 +1,8 @@
-export { isGithubAction };
+export { isCI };
 export { isLinux };
 export { isWindows };
 export { isMac };
 declare function isWindows(): boolean;
 declare function isLinux(): boolean;
 declare function isMac(): boolean;
-declare function isGithubAction(): boolean;
+declare function isCI(): boolean;

package/dist/utils/platform.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isMac = exports.isWindows = exports.isLinux = exports.isGithubAction = void 0;
+exports.isMac = exports.isWindows = exports.isLinux = exports.isCI = void 0;
 const assert_1 = require("./assert");
 function isWindows() {
     return process.platform === 'win32';
@@ -18,7 +18,7 @@ function isMac() {
     return false;
 }
 exports.isMac = isMac;
-function isGithubAction() {
+function isCI() {
     return !!process.env.CI;
 }
-exports.isGithubAction = isGithubAction;
+exports.isCI = isCI;

package/dist/utils/runCommand.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.runCommand = void 0;
 const child_process_1 = require("child_process");
 function runCommand(cmd, { swallowError = false, timeout = 5000, cwd = process.cwd(), } = {}) {
-    const { promise, resolvePromise } = genPromise();
+    const { promise, resolvePromise, rejectPromise } = genPromise();
     const t = setTimeout(() => {
         console.error(`Command call \`${cmd}\` timeout [${timeout / 1000} seconds][${cwd}].`);
-        process.exit(1);
+        rejectPromise();
     }, timeout);
     const options = { cwd };
     (0, child_process_1.exec)(cmd, options, (err, stdout, stderr) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/test-e2e",
-  "version": "0.3.12",
+  "version": "0.4.1",
   "bin": "./bin.js",
   "main": "./dist/index.js",
   "scripts": {

package/dist/runTestSuites.d.ts

@@ -1,3 +0,0 @@
-export { runTestSuites };
-import { FindFilter } from './utils';
-declare function runTestSuites(filter: null | FindFilter): Promise<void>;

package/dist/runTestSuites.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runTestSuites = void 0;
-const utils_1 = require("./utils");
-const getCurrentTest_1 = require("./getCurrentTest");
-const runTests_1 = require("./runTests");
-const getBrowser_1 = require("./getBrowser");
-const buildTs_1 = require("./buildTs");
-const findTestFiles_1 = require("./findTestFiles");
-const getConfig_1 = require("./getConfig");
-async function runTestSuites(filter) {
-    await (0, getConfig_1.loadConfig)();
-    const testFiles = await (0, findTestFiles_1.findTestFiles)(filter);
-    const browser = await (0, getBrowser_1.getBrowser)();
-    for (const testFile of testFiles) {
-        (0, utils_1.assert)(testFile.endsWith('.ts'));
-        const testFileJs = testFile.replace('.ts', '.mjs');
-        const clean = await (0, buildTs_1.buildTs)(testFile, testFileJs);
-        (0, getCurrentTest_1.setCurrentTest)(testFile);
-        try {
-            await import((0, utils_1.fsWindowsBugWorkaround)(testFileJs));
-        }
-        finally {
-            clean();
-        }
-        await (0, runTests_1.runTests)(browser);
-        (0, getCurrentTest_1.setCurrentTest)(null);
-        (0, utils_1.assert)(testFileJs.endsWith('.mjs'));
-    }
-    await browser.close();
-}
-exports.runTestSuites = runTestSuites;