@camperaid/watest 2.2.4 → 2.3.3

package/core/base.js

@@ -2,8 +2,9 @@
 
 const core = require('./core.js');
 const { success, fail, failed } = core;
-const { format_failure } = require('./format.js');
 
+const { log, log_error } = require('../logging/logging.js');
+const { format_failure } = require('./format.js');
 const { stringify } = require('./util.js');
 
 const limit = 100;
@@ -411,12 +412,12 @@ async function is_test_output(func, out, err, msg) {
   if (!stdout_matched || !stderr_matched) {
     let formatted = format_test_output({ stdout, stderr });
     if (!stdout_matched) {
-      console.log(`Test ready stdout for '${msg}':`);
-      console.log(formatted.stdout);
+      log(`Test ready stdout for '${msg}':`);
+      log(formatted.stdout);
     }
     if (!stderr_matched) {
-      console.log(`Test ready stderr for '${msg}':`);
-      console.log(formatted.stderr);
+      log(`Test ready stderr for '${msg}':`);
+      log(formatted.stderr);
     }
   }
 }
@@ -508,7 +509,7 @@ function is_out(got, expected, msg) {
 
     if (typeof exp_i == 'function') {
       if (!exp_i(got_i)) {
-        console.error(
+        log_error(
           format_failure(
             `got: ${stringify(got_i)}, expected: ${exp_i}`,
             `Unexpected output at index ${i},`
@@ -522,7 +523,7 @@ function is_out(got, expected, msg) {
       continue;
     }
 
-    console.error(
+    log_error(
       format_failure(
         `got: ${stringify(got_i)}, expected: ${exp_i}, got len: ${
           got_i.length
@@ -530,23 +531,23 @@ function is_out(got, expected, msg) {
         `Unexpected output at index ${i},`
       )
     );
-    console.error(
+    log_error(
       `index\tgot\texpected\tequal ${Math.min(got_i.length, exp_i.length)}`
     );
 
     let min = Math.min(got_i.length, exp_i.length);
     for (let j = 0; j < min; j++) {
-      console.error(
+      log_error(
         `${j}\t'${got_i[j]}'\t'${exp_i[j]}'\t${exp_i[j] == got_i[j]}`
       );
     }
 
     for (let j = min; j < got_i.length; j++) {
-      console.error(`${j}\t'${got_i[j]}'`);
+      log_error(`${j}\t'${got_i[j]}'`);
     }
 
     for (let j = min; j < exp_i.length; j++) {
-      console.error(`${j}\t\t'${exp_i[j]}'`);
+      log_error(`${j}\t\t'${exp_i[j]}'`);
     }
   }
   return false;

package/core/core.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { log, log_error, log_trace } = require('../logging/logging.js');
 const {
   format_failure,
   format_intermittent,
@@ -29,29 +30,29 @@ class Core {
   }
 
   info(msg) {
-    console.log(`Info: ${msg}`);
+    log(`Info: ${msg}`);
   }
 
   assert(cond, msg) {
     if (!cond) {
-      console.trace(msg);
+      log_trace(msg);
       this.fail(msg);
     }
   }
 
   not_reached(msg) {
-    console.trace(msg);
+    log_trace(msg);
     this.fail(msg);
   }
 
   group(msg, label) {
     this.currgroup = msg;
     label = label || 'Group';
-    console.log(colorify('group', `${label}:`, msg));
+    log(colorify('group', `${label}:`, msg));
   }
 
   success(msg) {
-    console.log(format_ok(msg));
+    log(format_ok(msg));
     this.kcnt++;
   }
 
@@ -86,22 +87,22 @@ class Core {
   }
 
   unconditional_fail(msg) {
-    console.error(format_failure(msg));
+    log_error(format_failure(msg));
     this.fcnt++;
   }
 
   intermittent(msg) {
-    console.log(format_intermittent(msg));
+    log(format_intermittent(msg));
     this.intermittentcnt++;
   }
 
   todo(msg) {
-    console.log(colorify('todo', 'Todo:', msg));
+    log(colorify('todo', 'Todo:', msg));
     this.todocnt++;
   }
 
   warn(msg) {
-    console.log(format_warning(msg));
+    log(format_warning(msg));
     this.warningcnt++;
   }
 

package/core/series.js

@@ -4,6 +4,7 @@ const fs = require('fs');
 const path = require('path');
 const nodepath = path;
 
+const { log, log_error } = require('../logging/logging.js');
 const { DriverBase } = require('../webdriver/driver_base.js');
 const testflow = require('./core.js');
 const { parse, parse_failure } = require('./format.js');
@@ -30,7 +31,7 @@ const root_folder = 'tests';
 const root_dir = path.resolve('.');
 
 process.on('unhandledRejection', error => {
-  console.error(error);
+  log_error(error);
   fail(`Unhandled Promise rejection`);
 });
 
@@ -60,7 +61,7 @@ class Series {
             e => {
               let failures = series.shutdown();
               fail(e.message);
-              console.error(e);
+              log_error(e);
               return failures;
             }
           );
@@ -144,7 +145,7 @@ class Series {
 
     await settings.servicer.shutdown();
 
-    console.log(`Elapsed: ${Date.now() - start_time}ms`);
+    log(`Elapsed: ${Date.now() - start_time}ms`);
   }
 
   /**
@@ -163,7 +164,7 @@ class Series {
     }
 
     if (tests.length == 0) {
-      console.log(
+      log(
         colorify(
           'failures',
           '!Failed:',
@@ -184,7 +185,13 @@ class Series {
   /**
    * Returns tests as an array of { name, func, ... } objects.
    */
-  async build({ patterns, folder, virtual_folder, webdriver = '' }) {
+  async build({
+    patterns,
+    folder,
+    virtual_folder,
+    webdriver = '',
+    inherited_expected_failures = [],
+  }) {
     let tests = [];
     try {
       let test_module = await this.loadTestMeta(folder);
@@ -194,6 +201,12 @@ class Series {
         throw new Error(`No tests found in ${folder}`);
       }
 
+      if (test_module.expected_failures) {
+        inherited_expected_failures = inherited_expected_failures.concat(
+          test_module.expected_failures.filter(v => v[0] == '**')
+        );
+      }
+
       if (
         !this.childProcess &&
         !this.suppressChildProcessInitiation &&
@@ -226,7 +239,9 @@ class Series {
             virtual_folder,
             subfolders,
             webdriver,
+            inherited_expected_failures,
           }),
+          inherited_expected_failures,
         });
       }
 
@@ -270,7 +285,9 @@ class Series {
             virtual_folder: wd_virtual_folder,
             subfolders,
             webdriver,
+            inherited_expected_failures,
           }),
+          inherited_expected_failures,
         });
         if (wdtests.length > 0) {
           tests.push({
@@ -285,7 +302,7 @@ class Series {
         name: virtual_folder,
         path: folder,
         func: () => {
-          console.error(e);
+          log_error(e);
           fail(`Failed to process tests in '${folder}' folder`);
         },
         failures_info: [],
@@ -341,6 +358,7 @@ class Series {
     virtual_folder,
     subfolders,
     webdriver,
+    inherited_expected_failures,
   }) {
     if (!subfolders) {
       return [];
@@ -353,6 +371,7 @@ class Series {
           folder: `${folder}/${subfolder}`,
           virtual_folder: `${virtual_folder}/${subfolder}`,
           webdriver,
+          inherited_expected_failures,
         }).then(subtests => ({
           subfolder,
           subtests,
@@ -384,6 +403,7 @@ class Series {
     patterns,
     webdriver,
     subtests,
+    inherited_expected_failures,
   }) {
     const { include_list, exclude_list } = test_module;
     let list = this.buildList({
@@ -401,7 +421,9 @@ class Series {
       return tests;
     }
 
-    const expected_failures = test_module.expected_failures || [];
+    const expected_failures = inherited_expected_failures.concat(
+      test_module.expected_failures || []
+    );
 
     // Initialize
     if (test_module.services || test_module.init) {
@@ -572,7 +594,7 @@ class Series {
       !this.rootFolder.startsWith(folder);
 
     if (should_report) {
-      console.log(format_started(folder));
+      log(format_started(folder));
     }
 
     let stop = false;
@@ -590,9 +612,7 @@ class Series {
       } = test;
 
       if (stop && !name.endsWith('uninit')) {
-        console.log(
-          `\x1b[31m!Skipped:\x1b[0m ${name}, because of previous failures\n`
-        );
+        log(`\x1b[31m!Skipped:\x1b[0m ${name}, because of previous failures\n`);
         continue;
       }
 
@@ -613,7 +633,7 @@ class Series {
       }
 
       // Invoke a test.
-      console.log(`\n!Running: ${name}, path: ${path}\n`);
+      log(`\n!Running: ${name}, path: ${path}\n`);
       let start_time = new Date();
       try {
         this.core.setExpectedFailures(failures_info);
@@ -621,7 +641,7 @@ class Series {
       } catch (e) {
         let failmsg = e;
         if (e instanceof Error) {
-          console.error(e);
+          log_error(e);
           failmsg = e.message;
         }
         fail(failmsg);
@@ -640,7 +660,7 @@ class Series {
           stop = true; // print skipped tests
         }
 
-        console.log(`>${name} completed in ${new Date() - start_time}ms\n`);
+        log(`>${name} completed in ${new Date() - start_time}ms\n`);
       }
     }
 
@@ -654,7 +674,7 @@ class Series {
         wcnt,
         ocnt,
       });
-      console.log(format_completed(folder));
+      log(format_completed(folder));
     }
 
     // Stop nested logging.
@@ -668,7 +688,7 @@ class Series {
     // Record intermittents.
     let delta = this.core.intermittentCount - this.icnt;
     if (delta > 0) {
-      console.log(`>${name} has ${delta} intermittent(s)`);
+      log(`>${name} has ${delta} intermittent(s)`);
       this.icnt = this.core.intermittentCount;
       hasChanged = true;
     }
@@ -676,7 +696,7 @@ class Series {
     // Record todos.
     delta = this.core.todoCount - this.tcnt;
     if (delta > 0) {
-      console.log(`>${name} has ${delta} todo(s)`);
+      log(`>${name} has ${delta} todo(s)`);
       this.tcnt = this.core.todoCount;
       hasChanged = true;
     }
@@ -684,7 +704,7 @@ class Series {
     // Record warnings.
     delta = this.core.warningCount - this.wcnt;
     if (delta > 0) {
-      console.log(`>${name} has ${delta} warnings(s)`);
+      log(`>${name} has ${delta} warnings(s)`);
       this.wcnt = this.core.warningCount;
       hasChanged = true;
     }
@@ -707,7 +727,7 @@ class Series {
 
     // Record failures.
     if (delta > 0) {
-      console.error(format_failure(`has ${delta} failure(s)`, `>${name}`));
+      log_error(format_failure(`has ${delta} failure(s)`, `>${name}`));
       this.failures.push({
         name,
         path,
@@ -727,28 +747,28 @@ class Series {
     // Do not log interim test results into console to reduce noice. Keep
     // file logging. In case of a child process log into console, the main
     // process will take care of that.
-    const log =
+    const log_func =
       is_root || this.childProcess
-        ? console.log.bind(console)
+        ? log
         : this.LogPipe.logToFile.bind(this.LogPipe);
 
     let hasChanged = this.failures.length > fidx || this.core.okCount > ocnt;
 
     let delta = this.core.warningCount - wcnt;
     if (delta > 0) {
-      log(format_warnings(delta, is_root ? '' : folder));
+      log_func(format_warnings(delta, is_root ? '' : folder));
       hasChanged = true;
     }
 
     delta = this.core.intermittentCount - icnt;
     if (delta > 0) {
-      log(format_intermittents(delta, is_root ? '' : folder));
+      log_func(format_intermittents(delta, is_root ? '' : folder));
       hasChanged = true;
     }
 
     delta = this.core.todoCount - tcnt;
     if (delta > 0) {
-      log(format_todos(delta, is_root ? '' : folder));
+      log_func(format_todos(delta, is_root ? '' : folder));
       hasChanged = true;
     }
 
@@ -765,9 +785,9 @@ class Series {
     if (this.failures.length > fidx) {
       for (let i = fidx; i < this.failures.length; i++) {
         let f = this.failures[i];
-        log(format_failures(f.count, f.name));
+        log_func(format_failures(f.count, f.name));
       }
-      log(
+      log_func(
         format_failures(
           this.core.failureCount - fcnt,
           this.core.okCount - ocnt,
@@ -775,13 +795,13 @@ class Series {
         )
       );
     } else {
-      log(format_success(this.core.okCount - ocnt, !is_root && folder));
+      log_func(format_success(this.core.okCount - ocnt, !is_root && folder));
     }
   }
 
   static failuresInfo({ failures, webdriver, platform, testname }) {
     let filtered_failures = failures.filter(
-      v => testname.includes(v[0]) || v[0] == '*'
+      v => testname.includes(v[0]) || v[0] == '*' || v[0] == '**'
     );
 
     return (
@@ -825,7 +845,7 @@ class Series {
         return test_module.test;
       },
       e => {
-        console.error(e);
+        log_error(e);
         throw new Error(`Failed to load test: ${test_path}`);
       }
     );
@@ -867,7 +887,7 @@ class Series {
     return spawn('node', args, {}, buffer =>
       this.processChildProcessOutput(name, buffer)
     ).catch(e => {
-      console.error(e);
+      log_error(e);
       fail(`Failed to process child process output`);
     });
   }
@@ -881,8 +901,7 @@ class Series {
           continue;
         }
 
-        let log_func = msg =>
-          is_stdout ? console.log(msg) : console.error(msg);
+        let log_func = msg => (is_stdout ? log(msg) : log_error(msg));
 
         if (line.startsWith('console.debug')) {
           line = line.replace(

package/core/spawn.js

@@ -2,6 +2,8 @@
 
 const { spawn } = require('child_process');
 
+const { log_error } = require('../logging/logging.js');
+
 class ChildProcess {
   constructor(on_output) {
     this.on_output = on_output;
@@ -44,8 +46,8 @@ class ChildProcess {
     if (!this.processChildProcessOutputPromise) {
       this.processChildProcessOutputPromise = this.processChildProcessBuffer()
         .catch(e => {
-          console.error(`Unexpected error when parsing a child process output`);
-          console.error(e);
+          log_error(`Unexpected error when parsing a child process output`);
+          log_error(e);
           cp.kill('SIGUSR1');
         })
         .then(() => {

package/core/util.js

@@ -1,13 +1,14 @@
 'use strict';
 
 const fs = require('fs');
+const { log } = require('../logging/logging.js');
 const cfg = require('./settings.js');
 
 /**
  * Logs object in console colored.
  */
 function inspect(obj) {
-  console.log(
+  log(
     require('util').inspect(obj, false, null, true /* enable colors */)
   );
 }

package/index.js

@@ -26,7 +26,8 @@ const { inspect } = require('./core/util.js');
 
 const { tmp_storage_dir } = require('./core/settings.js');
 
-const { AppDriver, ControlDriver } = require('./webdriver/app_driver.js');
+const { AppDriver } = require('./webdriver/app_driver.js');
+const { ControlDriver } = require('./webdriver/control_driver.js');
 const { start_session, scope } = require('./webdriver/session.js');
 
 module.exports = {

package/logging/logging.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const { ProcessArgs } = require('../core/process_args.js');
+
+function log(...args) {
+  console.log(...args);
+}
+
+function log_trace(...args) {
+  console.trace(...args);
+}
+
+function log_error(...args) {
+  // No stderr in a child process, becuase stdout/stderr streams buffer the data
+  // before sending it via callbacks, which may make buffers to contain output
+  // from multiple console.log/error calls, which makes the child process output
+  // processing messy.
+  ProcessArgs.asObject().childProcess ?
+    console.log(...args) :
+    console.error(...args);
+}
+
+module.exports = {
+  log,
+  log_trace,
+  log_error
+};

package/logging/logpipe.js

@@ -3,6 +3,7 @@
 const path = require('path');
 
 const settings = require('../core/settings.js');
+const { log, log_error } = require('./logging.js');
 const { log_dir, run } = settings;
 
 /**
@@ -25,8 +26,8 @@ class LogPipeInstance {
     this.fstream = new this.FS(this.log_dir, this.fname);
 
     this.fstream.on('error', e => {
-      console.error(`Failed to write to ${this.fstream.filepath}`);
-      console.error(e);
+      log_error(`Failed to write to ${this.fstream.filepath}`);
+      log_error(e);
     });
 
     return settings.logger.testRunStarted({ run, invocation });
@@ -39,7 +40,7 @@ class LogPipeInstance {
     let stream = new this.FS(this.log_dir, name);
     stream.write(content);
     await stream.end();
-    console.log(`Screenshot is captured and written to ${stream.filepath}`);
+    log(`Screenshot is captured and written to ${stream.filepath}`);
 
     await settings.logger.writeLogFile({
       run,
@@ -69,7 +70,7 @@ class LogPipeInstance {
           })
         )
         .catch(e => {
-          console.error(`Logging shutdown rejected: ${e}`);
+          log_error(`Logging shutdown rejected: ${e}`);
         })
     );
   }
@@ -130,7 +131,7 @@ class LogPipe {
     }
 
     this.suppress_fstream = true;
-    console.log(`Logs are written to ${pipeToRelease.fstream.filepath}`);
+    log(`Logs are written to ${pipeToRelease.fstream.filepath}`);
     this.suppress_fstream = false;
 
     if (this.stack.length == 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camperaid/watest",
-  "version": "2.2.4",
+  "version": "2.3.3",
   "description": "Web Application Testsuite",
   "engines": {
     "node": ">=14.15.1"
@@ -11,7 +11,7 @@
     "watest": "./bin/watest.js"
   },
   "scripts": {
-    "postinstall": "bash tests/install.sh",
+    "prepare": "bash tests/install.sh",
     "lint": "eslint '**/*.js'",
     "lint:staged": "eslint --",
     "pretty": "prettier --write",

package/tests/e2e/samples/folder/node_modules/.package-lock.json

@@ -6,9 +6,8 @@
   "packages": {
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.2.3",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"

package/tests/e2e/samples/folder/package-lock.json

@@ -16,9 +16,8 @@
     },
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.1.5",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"

package/tests/e2e/samples/loader/node_modules/.package-lock.json

@@ -6,9 +6,8 @@
   "packages": {
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.2.3",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"

package/tests/e2e/samples/loader/package-lock.json

@@ -16,9 +16,8 @@
     },
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.1.5",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"

package/tests/e2e/samples/loader_mixed/node_modules/.package-lock.json

@@ -6,9 +6,8 @@
   "packages": {
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.2.3",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"

package/tests/e2e/samples/loader_mixed/package-lock.json

@@ -16,9 +16,8 @@
     },
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.1.5",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"

package/tests/e2e/samples/loader_multiple/node_modules/.package-lock.json

@@ -6,9 +6,8 @@
   "packages": {
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.2.3",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"

package/tests/e2e/samples/loader_multiple/package-lock.json

@@ -16,9 +16,8 @@
     },
     "../../../..": {
       "name": "@camperaid/watest",
-      "version": "2.1.5",
+      "version": "2.3.3",
       "dev": true,
-      "hasInstallScript": true,
       "license": "MPL",
       "dependencies": {
         "selenium-webdriver": "^4.0.0-beta.2"