@brillout/test-e2e 0.4.0 → 0.4.2

package/dist/Logs.js

@@ -46,7 +46,7 @@ function clearLogs() {
 function logErrors(failOnWarning) {
     if (!exports.Logs.hasErrorLogs(failOnWarning))
         return;
-    (0, logSection_1.logSection)(`ERROR${!failOnWarning ? '' : '/WARNING'} LOG(S)`);
+    (0, logSection_1.logSection)(`ERROR${!failOnWarning ? '' : '/WARNING'} LOGS`);
     const errorLogs = getErrorLogs(failOnWarning);
     errorLogs.forEach((logEntry) => printLog(logEntry));
 }

package/dist/logSection.js

@@ -6,6 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.logSection = void 0;
 const picocolors_1 = __importDefault(require("picocolors"));
 function logSection(sectionTitle) {
-    console.log(picocolors_1.default.bold(`vvvvvv ${sectionTitle} vvvvvv`));
+    const title = `------ ${sectionTitle} ------`;
+    const width = title.length;
+    console.log(picocolors_1.default.bold('='.repeat(width)));
+    console.log(picocolors_1.default.bold(title));
+    console.log(picocolors_1.default.bold('v'.repeat(width)));
 }
 exports.logSection = logSection;

package/dist/runTests.js

@@ -73,8 +73,7 @@ async function runTestFile(browser) {
         await testInfo.startServer();
     }
     catch (err) {
-        logResult(false);
-        logFailureReason('during server start', false);
+        logFailureReason('an error occurred while starting the server');
         logError(err);
         Logs_1.Logs.flushLogs();
         await abort();
@@ -100,14 +99,12 @@ async function runTestFile(browser) {
             const hasErrorLog = Logs_1.Logs.hasErrorLogs(failOnWarning);
             const isFailure = err || hasErrorLog;
             if (isFailure) {
-                logResult(false);
-                const failureContext = 'while running the tests';
                 if (err) {
-                    logFailureReason(failureContext, false);
+                    logFailureReason(`the test "${testDesc}" threw an error`);
                     logError(err);
                 }
                 else if (hasErrorLog) {
-                    logFailureReason(failureContext, true, failOnWarning);
+                    logFailureReason(`${getErrorType(failOnWarning)} occurred while running the test "${testDesc}"`);
                 }
                 else {
                     (0, utils_1.assert)(false);
@@ -121,23 +118,23 @@ async function runTestFile(browser) {
         Logs_1.Logs.clearLogs();
     }
     await clean();
-    // Handle case that an error occured during `testInfo.terminateServer()`
-    if (Logs_1.Logs.hasErrorLogs(true)) {
-        /* TODO: implement more precise workaround
-        if (isWindows()) {
-          // On Windows, the sever sometimes terminates with an exit code of `1`. I don't know why.
-          Logs.clearLogs()
-        } else {
-        */
-        const failOnWarning = false;
-        logFailureReason('during server termination', true, failOnWarning);
-        Logs_1.Logs.logErrors(failOnWarning);
-        Logs_1.Logs.flushLogs();
-        await abort();
-        return;
+    // 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();
+            await abort();
+            return;
+        }
     }
+    Logs_1.Logs.clearLogs();
     logResult(true);
 }
+function getErrorType(failOnWarning) {
+    return !failOnWarning ? 'error(s)' : 'error(s)/warning(s)';
+}
 function runTest(testFn, testFunctionTimeout) {
     let resolve;
     let reject;
@@ -178,13 +175,11 @@ function logResult(success) {
         console.log(`${FAIL} ${testInfo.testFile}`);
     }
 }
-function logFailureReason(context, isErrorLog, failOnWarning) {
+function logFailureReason(reason) {
+    logResult(false);
     const { FAIL } = getStatusTags();
     const color = (s) => picocolors_1.default.red(picocolors_1.default.bold(s));
-    (0, utils_1.assert)((isErrorLog === false && failOnWarning === undefined) ||
-        (isErrorLog === true && (failOnWarning === true || failOnWarning === false)));
-    const errType = isErrorLog ? 'error' : !failOnWarning ? 'error(s)' : 'error(s)/warning(s)';
-    const msg = `Test ${FAIL} because encountered ${errType} ${context}, see below.`;
+    const msg = `Test ${FAIL} because ${reason}, see below.`;
     console.log(color(msg));
 }
 function logError(err) {
@@ -192,8 +187,8 @@ function logError(err) {
     console.log(err);
 }
 function getStatusTags() {
-    const PASS = picocolors_1.default.bold(picocolors_1.default.bgGreen('PASS'));
-    const FAIL = picocolors_1.default.bold(picocolors_1.default.bgRed('FAIL'));
-    const WARN = picocolors_1.default.bold(picocolors_1.default.bgYellow('WARN'));
+    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.js

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "expectError", { enumerable: true, get: function
 const serverUrlDefault = 'http://localhost:3000';
 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.isLinux)() ? 1 : 4);
+const TIMEOUT_PROCESS_TERMINATION = 10 * 1000 * (!(0, utils_1.isCI)() ? 1 : (0, utils_1.isWindows)() ? 3 : !(0, utils_1.isLinux)() ? 3 : 1);
 const TIMEOUT_AUTORETRY = TIMEOUT_TEST_FUNCTION / 2;
 const TIMEOUT_PLAYWRIGHT = TIMEOUT_TEST_FUNCTION / 2;
 function skip(reason) {
@@ -87,7 +87,7 @@ additionalTimeout = 0, serverIsReadyMessage, serverIsReadyDelay = 1000, inspect
         page_1.page.off('pageerror', onPageError);
         // `runProcess` is `undefined` if `start()` failed.
         if (runProcess) {
-            await runProcess.terminate('SIGINT');
+            await runProcess.terminate();
         }
     };
     return;
@@ -169,7 +169,7 @@ async function start() {
             logSource: 'run() failure',
             logText: errMsg,
         });
-        await terminate();
+        await terminate(true);
         rejectServerStart(new Error(errMsg));
     }, timeoutTotal);
     // Kill any process that listens to the server port
@@ -210,7 +210,7 @@ async function start() {
     });
     return promise;
 }
-function stopProcess({ proc, cwd, cmd, signal, }) {
+function stopProcess({ proc, cwd, cmd, force, }) {
     const prefix = `[Run Stop][${cwd}][${cmd}]`;
     let resolve;
     let reject;
@@ -235,19 +235,33 @@ function stopProcess({ proc, cwd, cmd, signal, }) {
             stdio: [
                 'ignore',
                 'ignore',
-                // Should we ignore `stderr`? Because `taskkill` somtimes throws:
-                // ```
-                // ERROR: The process with PID 6052 (child process of PID 3184) could not be terminated.
-                // Reason: There is no running instance of the task.
-                // ```
+                // We ignore stderr because taskkill somtimes throws:
+                //   ```
+                //   ERROR: The process with PID 6052 (child process of PID 3184) could not be terminated.
+                //   Reason: There is no running instance of the task.
+                //   ```
+                //   ```
+                //   ERROR: The process "6564" not found.
+                //   ```
                 // There doesn't seem to be an option to suppress that error: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/taskkill#parameters
-                'inherit', // stderr
+                // The error propagates to Node.js's stderr.
+                //   ```
+                //   [15:36:10.626][\examples\react][npm run preview][stderr] npm
+                //   [15:36:10.626][\examples\react][npm run preview][stderr]
+                //   [15:36:10.626][\examples\react][npm run preview][stderr] ERR!
+                //   [15:36:10.626][\examples\react][npm run preview][stderr]
+                //   [15:36:10.626][\examples\react][npm run preview][stderr] code
+                //   [15:36:10.626][\examples\react][npm run preview][stderr] ELIFECYCLE
+                //   ```
+                // Because stderr isn't empty, runTests() believes that the termination failed.
+                'ignore', // stderr
             ],
         });
     }
     else {
         (0, utils_2.assert)(proc.pid);
         const processGroup = -1 * proc.pid;
+        const signal = force ? 'SIGKILL' : 'SIGTERM';
         process.kill(processGroup, signal);
         /*
           try {
@@ -288,7 +302,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
             logText: err.message,
             logSource: 'run() failure',
         });
-        await terminate();
+        await terminate(true);
         onFailure(err);
     };
     proc.stdin.on('data', async (data) => {
@@ -344,7 +358,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
     function processHasExited() {
         return procExited;
     }
-    async function terminate(signal = 'SIGKILL') {
+    async function terminate(force) {
         let resolve;
         let reject;
         const promise = new Promise((_resolve, _reject) => {
@@ -357,7 +371,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 {
@@ -365,7 +382,7 @@ function execRunScript({ onStdout, onFailure, onExit, }) {
                 proc,
                 cwd,
                 cmd,
-                signal,
+                force,
             });
         }
         catch (err) {

package/package.json

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