@camperaid/watest 2.4.7 → 2.4.9

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();

package/logging/filestream.js

@@ -1,7 +1,5 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
 
 /**
  * Writes to a local file.
@@ -37,6 +35,4 @@ class FileStream {
   }
 }
 
-module.exports = {
-  FileStream,
-};
+export { FileStream };

package/logging/logging.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const { ProcessArgs } = require('../core/process_args.js');
+import { ProcessArgs } from '../core/process_args.js';
 
 function log(...args) {
   console.log(...args);
@@ -15,13 +13,9 @@ function log_error(...args) {
   // 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);
+  ProcessArgs.asObject().childProcess
+    ? console.log(...args)
+    : console.error(...args);
 }
 
-module.exports = {
-  log,
-  log_trace,
-  log_error
-};
+export { log, log_trace, log_error };

package/logging/logpipe.js

@@ -1,23 +1,21 @@
-'use strict';
+import path from 'path';
 
-const path = require('path');
-
-const settings = require('../core/settings.js');
-const { log, log_error } = require('./logging.js');
-const { log_dir, run } = settings;
+import { FileStream as DefaultFileStream } from './filestream.js';
+import { log, log_error } from './logging.js';
+import settings from '../core/settings.js';
 
 /**
  * A single instance of a logpipe writing to std and file streams.
  */
 class LogPipeInstance {
   constructor({ FileStream, suppress_logging }) {
-    this.FS = FileStream || require('./filestream.js').FileStream;
+    this.FS = FileStream || DefaultFileStream;
     this.suppress_logging = suppress_logging;
   }
 
   attach(invocation) {
     this.invocation = invocation;
-    this.log_dir = path.join(log_dir, this.invocation);
+    this.log_dir = path.join(settings.log_dir, this.invocation);
     if (this.suppress_logging) {
       return;
     }
@@ -30,7 +28,7 @@ class LogPipeInstance {
       log_error(e);
     });
 
-    return settings.logger.testRunStarted({ run, invocation });
+    return settings.logger.testRunStarted({ run: settings.run, invocation });
   }
 
   async logScreenshot(pic) {
@@ -43,7 +41,7 @@ class LogPipeInstance {
     log(`Screenshot is captured and written to ${stream.filepath}`);
 
     await settings.logger.writeLogFile({
-      run,
+      run: settings.run,
       invocation: this.invocation,
       name,
       content,
@@ -51,7 +49,10 @@ class LogPipeInstance {
   }
 
   logSourceMap() {
-    return settings.logger.writeSourceMap({ run, invocation: this.invocation });
+    return settings.logger.writeSourceMap({
+      run: settings.run,
+      invocation: this.invocation,
+    });
   }
 
   release() {
@@ -62,12 +63,12 @@ class LogPipeInstance {
         .then(() => this.fstream.readFile())
         .then(content =>
           settings.logger.writeLogFile({
-            run,
+            run: settings.run,
             invocation: this.invocation,
             name: this.fname,
             content,
             zip: true,
-          })
+          }),
         )
         .catch(e => {
           log_error(`Logging shutdown rejected: ${e}`);
@@ -82,7 +83,7 @@ class LogPipeInstance {
  */
 class LogPipe {
   static attach(invocation, options = {}) {
-    if (!log_dir) {
+    if (!settings.log_dir) {
       return Promise.resolve();
     }
 
@@ -100,13 +101,15 @@ class LogPipe {
   }
 
   static logScreenshot(...args) {
-    return log_dir
+    return settings.log_dir
       ? this.pipeOnStack.logScreenshot(...args)
       : Promise.resolve();
   }
 
   static logSourceMap(...args) {
-    return log_dir ? this.pipeOnStack.logSourceMap(...args) : Promise.resolve();
+    return settings.log_dir
+      ? this.pipeOnStack.logSourceMap(...args)
+      : Promise.resolve();
   }
 
   static logToFile(msg) {
@@ -117,7 +120,7 @@ class LogPipe {
   }
 
   static async release(...args) {
-    if (!log_dir) {
+    if (!settings.log_dir) {
       return Promise.resolve();
     }
 
@@ -184,9 +187,6 @@ class LogPipe {
   }
 }
 
-LogPipe.FileStream = require('./filestream.js').FileStream;
 LogPipe.stack = [];
 
-module.exports = {
-  LogPipe,
-};
+export { LogPipe };

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@camperaid/watest",
-  "version": "2.4.7",
+  "version": "2.4.9",
   "description": "Web Application Testsuite",
+  "type": "module",
   "engines": {
-    "node": ">=14.15.1"
+    "node": ">=20.16.0"
   },
   "main": "index.js",
-  "module": "index.mjs",
   "bin": {
     "watest": "./bin/watest.js"
   },
   "scripts": {
+    "prepare": "husky || true",
     "postprepare": "bash tests/install.sh",
     "lint": "eslint '**/*.js'",
     "lint:staged": "eslint --",
@@ -35,16 +36,16 @@
   },
   "homepage": "https://github.com/camperaid/watest#readme",
   "dependencies": {
-    "selenium-webdriver": "^4.0.0-beta.2"
+    "selenium-webdriver": "^4.23.0"
   },
   "devDependencies": {
-    "dotenv": "^16.0.1",
-    "eslint": "^8.22.0",
-    "eslint-plugin-node": "^11.1.0",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "prettier": "^2.7.1",
-    "prettifier": "^0.4.0"
+    "dotenv": "^16.4.5",
+    "eslint": "^9.8.0",
+    "@eslint/js": "^9.8.0",
+    "eslint-plugin-n": "^17.10.1",
+    "husky": "^9.1.4",
+    "lint-staged": "^15.2.7",
+    "prettier": "^3.3.3"
   },
   "lint-staged": {
     "*.js": [

package/tests/base/t_api.js

@@ -1,9 +1,7 @@
-'use strict';
-
-const api = require('../../index.js');
+import * as api from '../../index.js';
 const { ok } = api;
 
-module.exports.test = async () => {
+export async function test() {
   const props = [
     'AppDriver',
     'ControlDriver',
@@ -24,11 +22,10 @@ module.exports.test = async () => {
     'todo',
     'test_is',
     'test_contains',
-    'tmp_storage_dir',
     'warn',
   ];
 
   for (let prop of props) {
     ok(prop in api, `${prop} present`);
   }
-};
+}

package/tests/base/t_contains.js

@@ -1,14 +1,12 @@
-'use strict';
+import { contains, is_output } from './test.js';
 
-const { contains, is_output } = require('./test.js');
-
-module.exports.test = async () => {
+export async function test() {
   // string: success
   await is_output(
     () => contains('green cat', 'cat', `String contains`),
     [`Ok: String contains, got: 'green cat'`],
     [],
-    `success`
+    `success`,
   );
 
   // string: failure: expected string, got array
@@ -16,7 +14,7 @@ module.exports.test = async () => {
     () => contains([], 'green cat', `String contains`),
     [],
     [`Failed: String contains, expected string, got object: []`],
-    `failure`
+    `failure`,
   );
 
   // string: failure: got string, expected array
@@ -24,15 +22,17 @@ module.exports.test = async () => {
     () => contains('cat', [], `String contains`),
     [],
     [`Failed: String contains, got string, expected object: []`],
-    `failure`
+    `failure`,
   );
 
   // string: failure: doesn't contains
   await is_output(
     () => contains('cat', 'green cat', `String contains`),
     [],
-    [`Failed: String contains, got string doesn't contain expected string, got: 'cat', expected: 'green cat'`],
-    `failure`
+    [
+      `Failed: String contains, got string doesn't contain expected string, got: 'cat', expected: 'green cat'`,
+    ],
+    `failure`,
   );
 
   // array: success
@@ -40,7 +40,7 @@ module.exports.test = async () => {
     () => contains([0, 1], [1], `Array contains`),
     [`Ok: Array contains, got: [0, 1]`],
     [],
-    `success`
+    `success`,
   );
 
   // array: failure
@@ -48,6 +48,6 @@ module.exports.test = async () => {
     () => contains([0, 1], [1, 3], `Array contains`),
     [],
     [`Failed: Array contains, array has no expected item 3, got: [0, 1]`],
-    `failure`
+    `failure`,
   );
-};
+}

package/tests/base/t_core.js

@@ -1,20 +1,23 @@
-'use strict';
+import { colorify, group, fail, success, is_output } from './test.js';
 
-const { colorify, group, fail, success, is_output } = require('./test.js');
-
-module.exports.test = async () => {
+export async function test() {
   // console.log
   await is_output(() => console.log(3), [`3\n`], [], `console.log(3)`);
 
   // console.error
-  await is_output(() => console.error(3), [], [`3\n`], `console.error(3)`);
+  await is_output(
+    () => console.error(3),
+    [],
+    [`3\n`],
+    `console.error(3)`,
+  );
 
   // group(msg)
   await is_output(
     () => group('message'),
     [colorify('group', `Group:`, 'message')],
     [],
-    `group(msg)`
+    `group(msg)`,
   );
 
   // group(msg, label);
@@ -22,7 +25,7 @@ module.exports.test = async () => {
     () => group('message', 'Block'),
     [colorify('group', `Block:`, 'message')],
     [],
-    `group(msg, label)`
+    `group(msg, label)`,
   );
 
   // success()
@@ -30,4 +33,4 @@ module.exports.test = async () => {
 
   // fail()
   await is_output(() => fail('Fail'), [], [`Failed: Fail`], `fail()`);
-};
+}

package/tests/base/t_format.js

@@ -1,16 +1,15 @@
-'use strict';
-
-const {
+import {
   format_completed,
   format_failure,
   format_failures,
   format_success,
   parse,
   parse_failure,
-} = require('../../core/format.js');
-const { is } = require('../../index.js');
+} from '../../core/format.js';
+
+import { is } from '../../index.js';
 
-module.exports.test = () => {
+export function test() {
   // parse: failure
   is(
     parse(format_failure('Oops')),
@@ -19,7 +18,7 @@ module.exports.test = () => {
       label: 'Failed:',
       msg: 'Oops',
     },
-    'parse: failure'
+    'parse: failure',
   );
 
   // parse: completed
@@ -30,7 +29,7 @@ module.exports.test = () => {
       label: 'Completed',
       msg: 'Yes',
     },
-    'parse: completed'
+    'parse: completed',
   );
 
   // parse: failures
@@ -41,7 +40,7 @@ module.exports.test = () => {
       label: '>mac/webdriver/chrome/t_locmarker_click.js',
       msg: 'Failure count: 1',
     },
-    'parse: failures'
+    'parse: failures',
   );
 
   // parse: success
@@ -52,7 +51,7 @@ module.exports.test = () => {
       label: 'mac/webdriver',
       msg: 'Total: 1',
     },
-    'parse: success'
+    'parse: success',
   );
 
   // parse_failure
@@ -60,12 +59,12 @@ module.exports.test = () => {
     parse_failure(
       format_failure(
         'has 4 failure(s)',
-        '>mac/webdriver/ui-blocks/firefox/map/t_locmarker_click.js'
-      )
+        '>mac/webdriver/ui-blocks/firefox/map/t_locmarker_click.js',
+      ),
     ),
     {
       name: 'mac/webdriver/ui-blocks/firefox/map/t_locmarker_click.js',
       count: '4',
-    }
+    },
   );
-};
+}