@camperaid/watest 2.4.7 → 2.4.8

package/core/series.js

@@ -1,21 +1,18 @@
-'use strict';
-
-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');
-const { ProcessArgs } = require('./process_args.js');
-const settings = require('./settings.js');
-const { spawn } = require('./spawn');
-const { stringify } = require('./util.js');
-
-const { assert, fail } = testflow;
-
-const {
+import fs from 'fs';
+import nodepath from 'path';
+import { fileURLToPath } from 'url';
+
+import { assert, fail, testflow } from './core.js';
+import { parse, parse_failure } from './format.js';
+import { ProcessArgs } from './process_args.js';
+import settings from './settings.js';
+import { spawn } from './spawn.js';
+import { stringify } from './util.js';
+import { log, log_error } from '../logging/logging.js';
+import { LogPipe } from '../logging/logpipe.js';
+import { DriverBase } from '../webdriver/driver_base.js';
+
+import {
   format_started,
   format_completed,
   format_failure,
@@ -25,10 +22,13 @@ const {
   format_todos,
   format_warnings,
   colorify,
-} = require('./format.js');
+} from './format.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = nodepath.dirname(__filename);
 
 const root_folder = 'tests';
-const root_dir = path.resolve('.');
+const root_dir = nodepath.resolve('.');
 
 const kKungFuDeathGripTimeout = {};
 const kKungFuDeathGripCancelled = {};
@@ -44,7 +44,7 @@ process.on('unhandledRejection', error => {
 class Series {
   static run(patterns, options) {
     if (!('LogPipe' in options)) {
-      options.LogPipe = require('../logging/logpipe.js').LogPipe;
+      options.LogPipe = LogPipe;
     }
     options.LogPipe.suppress_logging = options.childProcess;
 
@@ -57,7 +57,7 @@ class Series {
           .run()
           .then(() =>
             // shutdown returns list of failures or null if no failures
-            options.LogPipe.release()
+            options.LogPipe.release(),
           )
           .then(
             () => series.shutdown(),
@@ -66,7 +66,7 @@ class Series {
               fail(e.message);
               log_error(e);
               return failures;
-            }
+            },
           );
       });
   }
@@ -86,7 +86,7 @@ class Series {
       LogPipe,
       webdriver,
       webdrivers = settings.webdrivers,
-    }
+    },
   ) {
     this.debunk = debunk;
     this.invocation = invocation || settings.invocation;
@@ -107,7 +107,7 @@ class Series {
     this.ocnt = 0;
 
     this.core = core || testflow.core;
-    testflow.lock(this.core);
+    testflow.lock({ core: this.core });
 
     this.core.setTimeout(timeout);
     this.core.clearStats();
@@ -128,7 +128,7 @@ class Series {
       this.patterns.map(pattern => ({
         path: pattern,
         webdriver: this.webdriver,
-      }))
+      })),
     );
 
     // In debunk mode re-run tests until it fails.
@@ -171,8 +171,8 @@ class Series {
         colorify(
           'failures',
           '!Failed:',
-          `no tests matching '${stringify(patterns)}' pattern(s) found`
-        )
+          `no tests matching '${stringify(patterns)}' pattern(s) found`,
+        ),
       );
       return Promise.resolve();
     }
@@ -206,7 +206,7 @@ class Series {
 
       if (test_module.expected_failures) {
         inherited_expected_failures = inherited_expected_failures.concat(
-          test_module.expected_failures.filter(v => v[0] == '**')
+          test_module.expected_failures.filter(v => v[0] == '**'),
         );
       }
 
@@ -251,7 +251,7 @@ class Series {
       // A separate folder for the webdriver tests.
       assert(
         this.webdrivers instanceof Array,
-        `Webdrivers are misconfigured, got: ${JSON.stringify(this.webdrivers)}`
+        `Webdrivers are misconfigured, got: ${JSON.stringify(this.webdrivers)}`,
       );
 
       // Build the tests for webdrivers. Filter the list according traversed
@@ -378,8 +378,8 @@ class Series {
         }).then(subtests => ({
           subfolder,
           subtests,
-        }))
-      )
+        })),
+      ),
     );
 
     return subtests_for_subfolders
@@ -425,7 +425,7 @@ class Series {
     }
 
     const expected_failures = inherited_expected_failures.concat(
-      test_module.expected_failures || []
+      test_module.expected_failures || [],
     );
 
     // Initialize
@@ -494,7 +494,7 @@ class Series {
         await Promise.all(
           [...(test_module.services || [])]
             .reverse()
-            .map(s => settings.servicer.stop(s))
+            .map(s => settings.servicer.stop(s)),
         );
       };
       tests.push({
@@ -533,7 +533,7 @@ class Series {
       list = list.filter(
         test =>
           this.matchedPatterns({ path: test.path, webdriver, patterns })
-            .length != 0
+            .length != 0,
       );
     }
 
@@ -545,7 +545,7 @@ class Series {
       pattern =>
         (!webdriver || !pattern.webdriver || pattern.webdriver == webdriver) &&
         (path.startsWith(pattern.path) ||
-          (path_is_not_final && pattern.path.startsWith(path)))
+          (path_is_not_final && pattern.path.startsWith(path))),
     );
   }
 
@@ -647,18 +647,18 @@ class Series {
         // If timeout is given then race it against the test.
         if (settings.timeout) {
           kungFuDeathGrip = new Promise(
-            resolve => (kungFuDeathGripResolve = resolve)
+            resolve => (kungFuDeathGripResolve = resolve),
           ).then(value => {
             if (value != kKungFuDeathGripCancelled) {
               fail(
-                `Test ${name} takes longer than ${settings.timeout}ms. It's either slow or never ends.`
+                `Test ${name} takes longer than ${settings.timeout}ms. It's either slow or never ends.`,
               );
               return kKungFuDeathGripTimeout;
             }
           });
           kungFuDeathGripTimer = setTimeout(
             kungFuDeathGripResolve,
-            settings.timeout
+            settings.timeout,
           );
           let retval = await Promise.race([func(), kungFuDeathGrip]);
           if (retval != kKungFuDeathGripTimeout) {
@@ -825,8 +825,8 @@ class Series {
         format_failures(
           this.core.failureCount - fcnt,
           this.core.okCount - ocnt,
-          !is_root && folder
-        )
+          !is_root && folder,
+        ),
       );
     } else {
       log_func(format_success(this.core.okCount - ocnt, !is_root && folder));
@@ -835,7 +835,7 @@ class Series {
 
   static failuresInfo({ failures, webdriver, platform, testname }) {
     let filtered_failures = failures.filter(
-      v => testname.includes(v[0]) || v[0] == '*' || v[0] == '**'
+      v => testname.includes(v[0]) || v[0] == '*' || v[0] == '**',
     );
 
     return (
@@ -865,13 +865,14 @@ class Series {
   async loadTestMeta(folder) {
     try {
       return await import(this.getTestMetaPath(folder));
+      // eslint-disable-next-line no-unused-vars
     } catch (e) {
       return {}; // no meta.js
     }
   }
 
   loadTest(test_path) {
-    return import(path.join(root_dir, test_path)).then(
+    return import(nodepath.join(root_dir, test_path)).then(
       test_module => {
         if (!test_module.test) {
           throw new Error(`No test was found in ${test_path}`);
@@ -881,25 +882,25 @@ class Series {
       e => {
         log_error(e);
         throw new Error(`Failed to load test: ${test_path}`);
-      }
+      },
     );
   }
 
   getTestMetaPath(folder) {
-    let meta_path = path.join(root_dir, `${folder}/meta.js`);
+    let meta_path = nodepath.join(root_dir, `${folder}/meta.js`);
     return (
       (fs.existsSync(meta_path) && meta_path) ||
-      path.join(root_dir, `${folder}/meta.mjs`)
+      nodepath.join(root_dir, `${folder}/meta.mjs`)
     );
   }
 
   getTestFileList(folder) {
     return fs
-      .readdirSync(path.join(root_dir, folder))
+      .readdirSync(nodepath.join(root_dir, folder))
       .filter(
         n =>
           n.startsWith('t_') &&
-          (!settings.ignorePattern || !settings.ignorePattern.test(n))
+          (!settings.ignorePattern || !settings.ignorePattern.test(n)),
       );
   }
 
@@ -916,14 +917,14 @@ class Series {
       '--root-folder',
       nodepath.join(name, '../'),
       ...ProcessArgs.controlArguments,
-      path
+      path,
     );
     if (webdriver) {
       args.push('--webdriver', webdriver);
     }
 
     return spawn('node', args, {}, buffer =>
-      this.processChildProcessOutput(name, buffer)
+      this.processChildProcessOutput(name, buffer),
     ).catch(e => {
       log_error(e);
       fail(`Failed to process child process output`);
@@ -944,22 +945,22 @@ class Series {
         if (line.startsWith('console.debug')) {
           line = line.replace(
             /console\.debug: "(.+)"/,
-            (match, p) => `[DEBUG] ${p}`
+            (match, p) => `[DEBUG] ${p}`,
           );
         } else if (line.startsWith('console.log')) {
           line = line.replace(
             /console\.log: "(.+)"/,
-            (match, p) => `[INFO] ${p}`
+            (match, p) => `[INFO] ${p}`,
           );
         } else if (line.startsWith('console.assert')) {
           line = line.replace(
             /console\.assert: "(.+)"/,
-            (match, p) => `[SEVERE] ${p}`
+            (match, p) => `[SEVERE] ${p}`,
           );
         } else if (line.startsWith('console.error')) {
           line = line.replace(
             /console\.error: "(.+)"/,
-            (match, p) => `[SEVERE] ${p}`
+            (match, p) => `[SEVERE] ${p}`,
           );
         } else if (line.startsWith('data:text/html,')) {
           line = line.replace(/\S*/, '@dataurl_placeholder');
@@ -1018,5 +1019,8 @@ class Series {
   }
 }
 
-module.exports.Series = Series;
-module.exports.runSeries = (...args) => Series.run(...args);
+export { Series };
+
+export function runSeries(...args) {
+  return Series.run(...args);
+}

package/core/settings.js

@@ -1,13 +1,4 @@
-'use strict';
-
-const path = require('path');
-
-let rc = null;
-try {
-  rc = require(path.resolve('.', './.watestrc.js'));
-} catch (e) {
-  rc = require(path.resolve('.', './.watestrc.cjs'));
-}
+import path from 'path';
 
 class Settings {
   constructor() {
@@ -16,20 +7,22 @@ class Settings {
     this.tmp_storage_dir = '';
     this.logger = null;
     this.servicer = null;
-
-    this.setupTmpStorageDir();
-    this.setupLogDir();
-    this.setupWebdrivers();
   }
 
   async initialize() {
+    this.rc = (await import(path.resolve('.', './.watestrc.js'))).default;
+
     this.logger = (
-      await import(rc.logger || '../interfaces/logger.js')
+      await import(this.rc.logger || '../interfaces/logger.js')
     ).default;
 
     this.servicer = (
-      await import(rc.servicer || '../interfaces/servicer.js')
+      await import(this.rc.servicer || '../interfaces/servicer.js')
     ).default;
+
+    this.setupTmpStorageDir();
+    this.setupLogDir();
+    this.setupWebdrivers();
   }
 
   get invocation() {
@@ -41,64 +34,66 @@ class Settings {
           break;
       }
 
-      this._invocation = rc.invocation || `${platform}`;
+      this._invocation = this.rc.invocation || `${platform}`;
     }
     return this._invocation;
   }
 
   get ignorePattern() {
-    return rc.ignore_pattern && new RegExp(rc.ignore_pattern);
+    return this.rc.ignore_pattern && new RegExp(this.rc.ignore_pattern);
   }
 
   get debunkLimit() {
-    return parseInt(rc.debunk_limit) || 5;
+    return parseInt(this.rc.debunk_limit) || 5;
   }
 
   get timeout() {
-    return parseInt(rc.timeout) || 0;
+    return parseInt(this.rc.timeout) || 0;
   }
 
   setupTmpStorageDir() {
-    if (!rc.tmp_dir) {
+    if (!this.rc.tmp_dir) {
       console.log(`Settings: no temporary storage dir`);
       return;
     }
 
-    this.tmp_storage_dir = path.join(rc.tmp_dir, 'watest-tmpstorage');
+    this.tmp_storage_dir = path.join(this.rc.tmp_dir, 'watest-tmpstorage');
     console.log(
-      `Settings: temporary storage dir is at ${this.tmp_storage_dir}`
+      `Settings: temporary storage dir is at ${this.tmp_storage_dir}`,
     );
   }
 
   setupLogDir() {
-    const log_dir = rc.log_dir;
+    const log_dir = this.rc.log_dir;
     if (!log_dir) {
       console.log('Settings: no file logging');
       return;
     }
 
-    this.run = rc.run || `${parseInt(Date.now() / 1000)}`;
+    this.run = this.rc.run || `${parseInt(Date.now() / 1000)}`;
 
     this.log_dir = path.join(log_dir, this.run);
     console.log(`Settings: logging into ${log_dir}`);
   }
 
   setupWebdrivers() {
-    this.webdrivers = rc.webdrivers;
-    if (typeof rc.webdrivers == 'string') {
+    this.webdrivers = this.rc.webdrivers;
+    if (typeof this.rc.webdrivers == 'string') {
       try {
-        this.webdrivers = JSON.parse(rc.webdrivers);
+        this.webdrivers = JSON.parse(this.rc.webdrivers);
       } catch (e) {
         console.error(
-          `Settings: failed to parse webdrivers '${rc.webdrivers}'`
+          `Settings: failed to parse webdrivers '${this.rc.webdrivers}'`,
+          e,
         );
       }
     }
 
     this.webdriver = null;
     this.webdriver_headless =
-      rc.webdriver_headless == true || rc.webdriver_headless == 'true';
-    this.webdriver_loglevel = rc.webdriver_loglevel;
+      this.rc.webdriver_headless == true ||
+      this.rc.webdriver_headless == 'true';
+    this.webdriver_loglevel = this.rc.webdriver_loglevel;
 
     if (this.webdrivers) {
       console.log(`Settings: ${this.webdrivers.join(', ')} webdrivers`);
@@ -106,4 +101,4 @@ class Settings {
   }
 }
 
-module.exports = new Settings();
+export default new Settings();

package/core/spawn.js

@@ -1,8 +1,5 @@
-'use strict';
-
-const { spawn } = require('child_process');
-
-const { log_error } = require('../logging/logging.js');
+import { spawn as spawn_process } from 'child_process';
+import { log_error } from '../logging/logging.js';
 
 class ChildProcess {
   constructor(on_output) {
@@ -12,17 +9,17 @@ class ChildProcess {
 
   spawn(cmd, args, options) {
     return new Promise((resolve, reject) => {
-      const cp = spawn(cmd, args, options);
+      const cp = spawn_process(cmd, args, options);
       cp.on('close', (code, signal) =>
         Promise.resolve(this.processChildProcessOutputPromise).then(() =>
-          signal == 'SIGUSR1' ? reject(code) : resolve(code)
-        )
+          signal == 'SIGUSR1' ? reject(code) : resolve(code),
+        ),
       );
       cp.stdout.on('data', data =>
-        this.bufferizeChildProcesOutput(cp, data, true)
+        this.bufferizeChildProcesOutput(cp, data, true),
       );
       cp.stderr.on('data', data =>
-        this.bufferizeChildProcesOutput(cp, data, false)
+        this.bufferizeChildProcesOutput(cp, data, false),
       );
       cp.on('error', reject);
     });
@@ -31,9 +28,8 @@ class ChildProcess {
   bufferizeChildProcesOutput(cp, data, is_stdout) {
     let str_data = data.toString();
 
-    let lastChunk = this.childProcessOutputBuffer[
-      this.childProcessOutputBuffer.length - 1
-    ];
+    let lastChunk =
+      this.childProcessOutputBuffer[this.childProcessOutputBuffer.length - 1];
     if (lastChunk && lastChunk.is_stdout == is_stdout) {
       lastChunk.str_data += str_data;
     } else {
@@ -57,9 +53,8 @@ class ChildProcess {
   }
 
   async processChildProcessBuffer() {
-    let lastChunk = this.childProcessOutputBuffer[
-      this.childProcessOutputBuffer.length - 1
-    ];
+    let lastChunk =
+      this.childProcessOutputBuffer[this.childProcessOutputBuffer.length - 1];
     if (!lastChunk || !lastChunk.str_data.endsWith('\n')) {
       return null;
     }
@@ -72,8 +67,6 @@ class ChildProcess {
   }
 }
 
-module.exports = {
-  spawn(cmd, args, options, on_output) {
-    return new ChildProcess(on_output).spawn(cmd, args, options);
-  },
-};
+export function spawn(cmd, args, options, on_output) {
+  return new ChildProcess(on_output).spawn(cmd, args, options);
+}

package/core/util.js

@@ -1,14 +1,15 @@
-'use strict';
+import fs from 'fs';
+import querystring from 'querystring';
+import util from 'util';
 
-const fs = require('fs');
-const { log } = require('../logging/logging.js');
-const cfg = require('./settings.js');
+import { log } from '../logging/logging.js';
+import settings from './settings.js';
 
 /**
  * Logs object in console colored.
  */
 function inspect(obj) {
-  log(require('util').inspect(obj, false, null, true /* enable colors */));
+  log(util.inspect(obj, false, null, true /* enable colors */));
 }
 
 /**
@@ -38,7 +39,7 @@ function stringify(obj, traces = new Set()) {
   }
   if (obj instanceof Map) {
     let entries = Array.from(obj.entries()).map(
-      ([k, v]) => `${k}: ${stringify(v, traces)}`
+      ([k, v]) => `${k}: ${stringify(v, traces)}`,
     );
     return `Map{${entries.join(', ')}}`;
   }
@@ -74,9 +75,9 @@ function stringify(obj, traces = new Set()) {
  * A temporary storage dir.
  */
 function initTmpStorage() {
-  if (cfg.tmp_storage_dir) {
-    removeDir(cfg.tmp_storage_dir);
-    fs.mkdirSync(cfg.tmp_storage_dir);
+  if (settings.tmp_storage_dir) {
+    removeDir(settings.tmp_storage_dir);
+    fs.mkdirSync(settings.tmp_storage_dir);
   }
 }
 
@@ -102,15 +103,7 @@ function is_mac() {
 }
 
 function toDataURL(html) {
-  return `data:text/html,${require('querystring').escape(html)}`;
+  return `data:text/html,${querystring.escape(html)}`;
 }
 
-module.exports = {
-  inspect,
-  stringify,
-  is_mac,
-  toDataURL,
-
-  removeDir,
-  initTmpStorage,
-};
+export { inspect, stringify, is_mac, toDataURL, removeDir, initTmpStorage };

package/eslint.config.js

@@ -0,0 +1,27 @@
+import js from '@eslint/js'; // eslint-disable-line n/no-unpublished-import
+import nodePlugin from 'eslint-plugin-n'; // eslint-disable-line n/no-unpublished-import
+
+export default [
+  js.configs.recommended,
+  nodePlugin.configs['flat/recommended-script'],
+  {
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: 'module',
+    },
+  },
+  {
+    files: ['bin/watest.js'],
+    rules: {
+      'n/no-process-exit': 'off',
+    },
+  },
+  {
+    files: ['tests/e2e/samples/**'],
+    settings: {
+      node: {
+        allowModules: ['watest'],
+      },
+    },
+  },
+];

package/index.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const {
+import {
   assert,
   group,
   fail,
@@ -10,32 +8,28 @@ const {
   success,
   todo,
   warn,
-} = require('./core/core.js');
+} from './core/core.js';
 
-const {
+import {
   ok,
   is,
   contains,
   is_output,
   no_throws,
   throws,
-
   test_is,
   test_contains,
-} = require('./core/base.js');
-
-const { inspect } = require('./core/util.js');
+} from './core/base.js';
 
-const { tmp_storage_dir } = require('./core/settings.js');
+import settings from './core/settings.js';
+import { inspect } from './core/util.js';
+import { AppDriver } from './webdriver/app_driver.js';
+import { ControlDriver } from './webdriver/control_driver.js';
+import { start_session, scope } from './webdriver/session.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 = {
+export {
   AppDriver,
   ControlDriver,
-
   assert,
   contains,
   failed,
@@ -55,6 +49,6 @@ module.exports = {
   test_is,
   test_contains,
   throws,
-  tmp_storage_dir,
   warn,
+  settings,
 };

package/interfaces/logger.js

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * Logging hook interface. Allows to connect logging servers to the testsuite.
  */
@@ -26,4 +24,4 @@ class Logger {
   }
 }
 
-module.exports = new Logger();
+export default new Logger();

package/interfaces/servicer.js

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * Manages services requested by a testsuite.
  */
@@ -31,4 +29,4 @@ class Servicer {
   get(/* service */) {}
 }
 
-module.exports = new Servicer();
+export default new Servicer();