@brillout/test-e2e 0.1.22 → 0.2.1

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

@@ -14,10 +14,11 @@ declare type TestInfo = {
         cwd: string;
         testFunctionTimeout: number;
         additionalTimeout: number;
-        serverIsReadyMessage?: string;
+        serverIsReadyMessage?: string | ((log: string) => boolean);
         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) {
@@ -61,7 +64,7 @@ async function runTests(browser) {
                 console.error(err);
             }
             if (hasErrorLog) {
-                console.log(new Error(logsContainError_errMsg));
+                console.log(logsContainError_errMsg(false));
             }
             Logs_1.Logs.flushLogs();
             process.exit(1);
@@ -79,7 +82,7 @@ async function runTests(browser) {
             Logs_1.Logs.clearLogs();
         }
         else {
-            console.log(new Error(logsContainError_errMsg));
+            console.log(logsContainError_errMsg(true));
             Logs_1.Logs.flushLogs();
             process.exit(1);
         }
@@ -114,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

@@ -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;
+    serverIsReadyMessage?: string | ((log: string) => boolean);
     serverIsReadyDelay?: number;
     inspect?: boolean;
     cwd?: string;
     onlyFailOnBrowserError?: boolean;
+    serverUrl?: string;
 }): void;
 declare function autoRetry(test: () => void | Promise<void>, { timeout }?: {
     timeout?: number;
@@ -31,3 +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 getServerUrl(): string;

package/dist/setup.js

@@ -3,7 +3,7 @@ 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");
@@ -23,12 +23,10 @@ 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 * (!(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);
@@ -41,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 = {
@@ -53,6 +51,7 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
         serverIsReadyDelay,
         inspect,
         onlyFailOnBrowserError,
+        serverUrl,
     };
     if (inspect) {
         Logs_1.Logs.flushEagerly = true;
@@ -68,7 +67,7 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
         /*
         await bailOnTimeout(
           async () => {
-            await page.goto(urlBase + baseUrl)
+            await page.goto(getServerUrl() + baseUrl)
           },
           { timeout: TIMEOUT_PAGE_LOAD + additionalTimeout },
         )
@@ -176,9 +175,11 @@ async function start() {
         await terminate();
         rejectServerStart(new Error(errMsg));
     }, timeoutTotal);
-    // Kill any process that listens to port `3000`
+    // Kill any process that listens to the server port
     if (!process.env.CI && (0, utils_1.isLinux)()) {
-        await (0, utils_1.runCommand)('fuser -k 3000/tcp', { swallowError: true, timeout: 10 * 1000 });
+        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) {
@@ -194,7 +195,8 @@ async function start() {
             const text = (0, strip_ansi_1.default)(data);
             const isServerReady = 
             // Custom
-            (serverIsReadyMessage && text.includes(serverIsReadyMessage)) ||
+            (typeof serverIsReadyMessage === 'string' && text.includes(serverIsReadyMessage)) ||
+                ((0, utils_1.isCallable)(serverIsReadyMessage) && serverIsReadyMessage(text)) ||
                 // Express.js server
                 text.includes('Server running at') ||
                 // npm package `serve`
@@ -401,7 +403,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;
 }
@@ -453,3 +455,15 @@ function getCwd() {
     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/isCallable.d.ts

@@ -1 +1 @@
-export declare function isCallable<T extends Function>(thing: T | unknown): thing is T;
+export declare function isCallable(thing: unknown): thing is Function;

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.22",
+  "version": "0.2.1",
   "bin": "./bin.js",
   "main": "./dist/index.js",
   "scripts": {