@brillout/test-e2e 0.1.21 → 0.2.0

package/dist/Logs.d.ts

@@ -1,9 +1,9 @@
 export { expectError };
 export declare const Logs: {
     add: typeof add;
-    flush: typeof flush;
-    clear: typeof clear;
-    hasError: typeof hasError;
+    flushLogs: typeof flushLogs;
+    clearLogs: typeof clearLogs;
+    hasErrorLogs: typeof hasErrorLogs;
     flushEagerly: boolean;
 };
 declare type LogSource = 'stdout' | 'stderr' | 'Browser Error' | 'Browser Warning' | 'Browser Log' | 'Playwright' | 'run()' | 'run() failure' | 'test()' | 'Connection Error';
@@ -13,9 +13,9 @@ declare type LogEntry = {
     logTimestamp: string;
     isNotFailure: boolean;
 };
-declare function hasError(onlyFailOnBrowserError?: boolean): boolean;
-declare function clear(): void;
-declare function flush(): void;
+declare function hasErrorLogs(onlyFailOnBrowserError?: boolean): boolean;
+declare function clearLogs(): void;
+declare function flushLogs(): void;
 declare function add({ logSource, logText }: {
     logSource: LogSource;
     logText: string;

package/dist/Logs.js

@@ -6,9 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logs = exports.expectError = void 0;
 exports.Logs = {
     add,
-    flush,
-    clear,
-    hasError,
+    flushLogs,
+    clearLogs,
+    hasErrorLogs,
     flushEagerly: false,
 };
 const utils_1 = require("./utils");
@@ -16,8 +16,7 @@ const picocolors_1 = __importDefault(require("picocolors"));
 const getCurrentTest_1 = require("./getCurrentTest");
 const getConfig_1 = require("./getConfig");
 let logEntries = [];
-let logEntriesNotPrinted = [];
-function hasError(onlyFailOnBrowserError = false) {
+function hasErrorLogs(onlyFailOnBrowserError = false) {
     const logErrors = logEntries.filter(({ logSource, isNotFailure }) => {
         if (isNotFailure) {
             return;
@@ -35,13 +34,12 @@ function hasError(onlyFailOnBrowserError = false) {
     });
     return logErrors.length > 0;
 }
-function clear() {
+function clearLogs() {
     logEntries = [];
-    logEntriesNotPrinted = [];
 }
-function flush() {
-    logEntriesNotPrinted.forEach((logEntry) => printLog(logEntry));
-    logEntriesNotPrinted = [];
+function flushLogs() {
+    logEntries.forEach((logEntry) => printLog(logEntry));
+    logEntries = [];
 }
 function add({ logSource, logText }) {
     const logTimestamp = getTimestamp();
@@ -61,10 +59,9 @@ function add({ logSource, logText }) {
         logTimestamp,
         isNotFailure,
     };
-    logEntriesNotPrinted.push(logEntry);
     logEntries.push(logEntry);
     if (exports.Logs.flushEagerly) {
-        flush();
+        flushLogs();
     }
 }
 function expectError(logFilter) {

package/dist/cli.js

@@ -7,8 +7,10 @@ const source_map_support_1 = __importDefault(require("source-map-support"));
 const utils_1 = require("./utils");
 const runTestSuites_1 = require("./runTestSuites");
 const buildTs_1 = require("./buildTs");
+const Logs_1 = require("./Logs");
 initSourceMap();
 initPromiseRejectionHandler();
+initUserExitHandler();
 cli();
 function cli() {
     const filter = (0, utils_1.findFilesParseCliArgs)();
@@ -20,6 +22,11 @@ function initPromiseRejectionHandler() {
         process.exit(1);
     });
 }
+function initUserExitHandler() {
+    process.on('SIGINT', function () {
+        Logs_1.Logs.flushLogs();
+    });
+}
 function initSourceMap() {
     source_map_support_1.default.install({
         retrieveSourceMap: function (source) {

package/dist/getCurrentTest.d.ts

@@ -18,6 +18,7 @@ declare type TestInfo = {
         serverIsReadyDelay: number;
         inspect: boolean;
         onlyFailOnBrowserError: boolean;
+        serverUrl: string;
     };
     hasStartedRunning?: boolean;
     skipped?: string;

package/dist/runTests.js

@@ -1,11 +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.runTests = void 0;
 const getCurrentTest_1 = require("./getCurrentTest");
 const Logs_1 = require("./Logs");
 const utils_1 = require("./utils");
-const picocolors_1 = require("picocolors");
-const logsContainError_errMsg = 'The browser/server threw/logged one or more error/warning, see logs below.';
+const picocolors_1 = __importDefault(require("picocolors"));
+const logsContainError_errMsg = (isTermination) => [picocolors_1.default.bold('Encountered an error or warning'), !isTermination ? '' : ' during termination', ', see logs below.'].join('');
 async function runTests(browser) {
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
     if (utils_1.isTTY) {
@@ -35,7 +38,7 @@ async function runTests(browser) {
     catch (err) {
         logTestsResult(false);
         console.log(err);
-        Logs_1.Logs.flush();
+        Logs_1.Logs.flushLogs();
         process.exit(1);
     }
     for (const { testDesc, testFn } of testInfo.tests) {
@@ -53,7 +56,7 @@ async function runTests(browser) {
         }
         done(!!err);
         testInfo.afterEach(!!err);
-        const hasErrorLog = Logs_1.Logs.hasError(testInfo.runInfo.onlyFailOnBrowserError);
+        const hasErrorLog = Logs_1.Logs.hasErrorLogs(testInfo.runInfo.onlyFailOnBrowserError);
         const isFailure = err || hasErrorLog;
         if (isFailure) {
             logTestsResult(false);
@@ -61,21 +64,28 @@ async function runTests(browser) {
                 console.error(err);
             }
             if (hasErrorLog) {
-                console.log(new Error(logsContainError_errMsg));
+                console.log(logsContainError_errMsg(false));
             }
-            Logs_1.Logs.flush();
+            Logs_1.Logs.flushLogs();
             process.exit(1);
         }
         else {
-            Logs_1.Logs.clear();
+            Logs_1.Logs.clearLogs();
         }
     }
     await testInfo.terminateServer();
     await page.close();
     // Handle case that an error occured during `terminateServer()`
-    if (Logs_1.Logs.hasError()) {
-        console.log(new Error(logsContainError_errMsg));
-        Logs_1.Logs.flush();
+    if (Logs_1.Logs.hasErrorLogs()) {
+        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 {
+            console.log(logsContainError_errMsg(true));
+            Logs_1.Logs.flushLogs();
+            process.exit(1);
+        }
     }
     logTestsResult(true);
 }
@@ -107,18 +117,18 @@ function runTest(testFn, testFunctionTimeout) {
 }
 function logTestsResult(success) {
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
-    const passStyle = (t) => (0, picocolors_1.bold)((0, picocolors_1.white)((0, picocolors_1.bgGreen)(t)));
-    const failStyle = (t) => (0, picocolors_1.bold)((0, picocolors_1.white)((0, picocolors_1.bgRed)(t)));
-    const skipStyle = (t) => (0, picocolors_1.bold)((0, picocolors_1.white)((0, picocolors_1.bgYellow)(t)));
+    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));
     if (success) {
         (0, utils_1.assert)(!testInfo.skipped);
-        console.log(`${passStyle('PASS')} ${testInfo.testFile}`);
+        console.log(`${passStyle(' PASS ')} ${testInfo.testFile}`);
         return;
     }
     if (testInfo.skipped) {
-        console.log(`${skipStyle('WARN')} ${testInfo.testFile} (${testInfo.skipped})`);
+        console.log(`${skipStyle(' WARN ')} ${testInfo.testFile} (${testInfo.skipped})`);
     }
     else {
-        console.log(`${failStyle('FAIL')} ${testInfo.testFile}`);
+        console.log(`${failStyle(' FAIL ')} ${testInfo.testFile}`);
     }
 }

package/dist/setup.d.ts

@@ -1,4 +1,4 @@
-import { sleep } from './utils';
+import { sleep, isWindows, isLinux, isGithubAction, isMac } from './utils';
 import fetch_ from 'node-fetch';
 export { partRegex } from '@brillout/part-regex';
 export { autoRetry };
@@ -13,17 +13,17 @@ export { isLinux };
 export { isWindows };
 export { isMac };
 export { sleep };
-export declare let urlBase: string;
-export declare const urlBaseChange: (url: string) => string;
+export { getServerUrl };
 export { editFile, editFileRevert } from './editFile';
 declare function skip(reason: string): void;
-declare function run(cmd: string, { additionalTimeout, serverIsReadyMessage, serverIsReadyDelay, inspect, cwd, onlyFailOnBrowserError, }?: {
+declare function run(cmd: string, { additionalTimeout, serverIsReadyMessage, serverIsReadyDelay, inspect, cwd, onlyFailOnBrowserError, serverUrl, }?: {
     additionalTimeout?: number;
     serverIsReadyMessage?: string;
     serverIsReadyDelay?: number;
     inspect?: boolean;
     cwd?: string;
     onlyFailOnBrowserError?: boolean;
+    serverUrl?: string;
 }): void;
 declare function autoRetry(test: () => void | Promise<void>, { timeout }?: {
     timeout?: number;
@@ -31,7 +31,4 @@ declare function autoRetry(test: () => void | Promise<void>, { timeout }?: {
 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;
-declare function isWindows(): boolean;
-declare function isLinux(): boolean;
-declare function isMac(): boolean;
-declare function isGithubAction(): boolean;
+declare function getServerUrl(): string;

package/dist/setup.js

@@ -3,11 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.editFileRevert = exports.editFile = exports.urlBaseChange = exports.urlBase = 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.editFileRevert = exports.editFile = 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;
 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, "isMac", { enumerable: true, get: function () { return utils_1.isMac; } });
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const utils_2 = require("./utils");
 const Logs_1 = require("./Logs");
@@ -19,15 +23,13 @@ var part_regex_1 = require("@brillout/part-regex");
 Object.defineProperty(exports, "partRegex", { enumerable: true, get: function () { return part_regex_1.partRegex; } });
 var Logs_2 = require("./Logs");
 Object.defineProperty(exports, "expectError", { enumerable: true, get: function () { return Logs_2.expectError; } });
-exports.urlBase = 'http://localhost:3000';
-const urlBaseChange = (url) => (exports.urlBase = url);
-exports.urlBaseChange = urlBaseChange;
 var editFile_2 = require("./editFile");
 Object.defineProperty(exports, "editFile", { enumerable: true, get: function () { return editFile_2.editFile; } });
 Object.defineProperty(exports, "editFileRevert", { enumerable: true, get: function () { return editFile_2.editFileRevert; } });
+const serverUrlDefault = 'http://localhost:3000';
 const TIMEOUT_NPM_SCRIPT = 2 * 60 * 1000;
-const TIMEOUT_TEST_FUNCTION = 60 * 1000 * (!isGithubAction() ? 1 : isWindows() ? 5 : 3);
-const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!isGithubAction() ? 1 : isLinux() ? 1 : 4);
+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_AUTORETRY = TIMEOUT_TEST_FUNCTION / 2;
 const TIMEOUT_PLAYWRIGHT = TIMEOUT_TEST_FUNCTION / 2;
 function skip(reason) {
@@ -37,7 +39,7 @@ function skip(reason) {
 exports.skip = skip;
 function run(cmd, { 
 //baseUrl = '',
-additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect = utils_1.cliConfig.inspect, cwd, onlyFailOnBrowserError = false, } = {}) {
+additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect = utils_1.cliConfig.inspect, cwd, onlyFailOnBrowserError = false, serverUrl = serverUrlDefault, } = {}) {
     additionalTimeout += serverIsReadyDelay;
     const testInfo = (0, getCurrentTest_1.getCurrentTest)();
     testInfo.runInfo = {
@@ -49,6 +51,7 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
         serverIsReadyDelay,
         inspect,
         onlyFailOnBrowserError,
+        serverUrl,
     };
     if (inspect) {
         Logs_1.Logs.flushEagerly = true;
@@ -172,9 +175,11 @@ async function start() {
         await terminate();
         rejectServerStart(new Error(errMsg));
     }, timeoutTotal);
-    // Kill any process that listens to port `3000`
-    if (!process.env.CI && isLinux()) {
-        await (0, utils_1.runCommand)('fuser -k 3000/tcp', { swallowError: true, timeout: 10 * 1000 });
+    // Kill any process that listens to the server port
+    if (!process.env.CI && (0, utils_1.isLinux)()) {
+        const port = getPort();
+        (0, utils_2.assert)(/\d+/.test(port));
+        await (0, utils_1.runCommand)(`fuser -k ${port}/tcp`, { swallowError: true, timeout: 10 * 1000 });
     }
     const { terminate, processHasExited } = execRunScript({
         async onFailure(err) {
@@ -216,7 +221,7 @@ function stopProcess({ proc, cwd, cmd, signal, }) {
         reject = _reject;
     });
     const onProcessClose = (code) => {
-        if (code === 0 || code === null || (code === 1 && isWindows())) {
+        if (code === 0 || code === null || (code === 1 && (0, utils_1.isWindows)())) {
             resolve();
         }
         else {
@@ -225,7 +230,7 @@ function stopProcess({ proc, cwd, cmd, signal, }) {
     };
     proc.on('close', onProcessClose);
     proc.on('exit', onProcessClose);
-    if (isWindows()) {
+    if ((0, utils_1.isWindows)()) {
         // - https://github.com/nodejs/node/issues/3617#issuecomment-377731194
         // - https://stackoverflow.com/questions/23706055/why-can-i-not-kill-my-child-process-in-nodejs-on-windows/28163919#28163919
         (0, child_process_1.spawn)('taskkill', ['/pid', String(proc.pid), '/f', '/t'], {
@@ -268,7 +273,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
     const { cwd, cmd } = getRunInfo();
     let [command, ...args] = cmd.split(' ');
     let detached = true;
-    if (isWindows()) {
+    if ((0, utils_1.isWindows)()) {
         detached = false;
         if (command === 'npm' || command === 'pnpm') {
             command = command + '.cmd';
@@ -319,7 +324,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
         procExited = true;
         (0, utils_2.assert)(getRunInfo().cmd === cmd);
         const exitIsPossible = onExit();
-        const isSuccessCode = [0, null].includes(code) || (isWindows() && code === 1);
+        const isSuccessCode = [0, null].includes(code) || ((0, utils_1.isWindows)() && code === 1);
         const isExpected = isSuccessCode && exitIsPossible;
         if (!isExpected) {
             const errMsg = `Unexpected premature process termination, exit code: ${code}`;
@@ -397,7 +402,7 @@ async function autoRetry(test, { timeout = TIMEOUT_AUTORETRY } = {}) {
 }
 exports.autoRetry = autoRetry;
 async function fetchHtml(pathname) {
-    const response = await fetch(exports.urlBase + pathname);
+    const response = await fetch(getServerUrl() + pathname);
     const html = await response.text();
     return html;
 }
@@ -444,28 +449,20 @@ function isMinNodeVersion(minNodeVersion) {
     return major >= minNodeVersion;
 }
 exports.isMinNodeVersion = isMinNodeVersion;
-function isWindows() {
-    return process.platform === 'win32';
-}
-exports.isWindows = isWindows;
-function isLinux() {
-    return process.platform === 'linux';
-}
-exports.isLinux = isLinux;
-function isMac() {
-    if (process.platform === 'darwin') {
-        return true;
-    }
-    (0, utils_2.assert)(isLinux() || isWindows());
-    return false;
-}
-exports.isMac = isMac;
-function isGithubAction() {
-    return !!process.env.CI;
-}
-exports.isGithubAction = isGithubAction;
 function getCwd() {
     const { testFile } = (0, getCurrentTest_1.getCurrentTest)();
     const cwd = (0, path_1.dirname)(testFile);
     return cwd;
 }
+function getServerUrl() {
+    const testInfo = (0, getCurrentTest_1.getCurrentTest)();
+    const serverUrl = testInfo.runInfo?.serverUrl;
+    return serverUrl;
+}
+exports.getServerUrl = getServerUrl;
+function getPort() {
+    const serverUrl = getServerUrl();
+    const port = serverUrl.split(':').slice(-1)[0].split('/')[0];
+    (0, utils_2.assert)(/\d+/.test(port), { serverUrl });
+    return port;
+}

package/dist/utils/index.d.ts

@@ -9,3 +9,4 @@ export * from './cliConfig';
 export * from './fsWindowsBugWorkaround';
 export * from './isObject';
 export * from './isCallable';
+export * from './platform';

package/dist/utils/index.js

@@ -25,3 +25,4 @@ __exportStar(require("./cliConfig"), exports);
 __exportStar(require("./fsWindowsBugWorkaround"), exports);
 __exportStar(require("./isObject"), exports);
 __exportStar(require("./isCallable"), exports);
+__exportStar(require("./platform"), exports);

package/dist/utils/platform.d.ts

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

package/dist/utils/platform.js

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

package/dist/utils/runCommand.d.ts

@@ -1,6 +1,6 @@
 export { runCommand };
-declare function runCommand(cmd: string, { swallowError, timeout, cwd }?: {
-    swallowError?: true;
+declare function runCommand(cmd: string, { swallowError, timeout, cwd, }?: {
+    swallowError?: boolean;
     timeout?: number;
     cwd?: string;
 }): Promise<string>;

package/dist/utils/runCommand.js

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

package/package.json

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