@iobroker/testing 5.3.0 → 6.0.0

package/README.md

@@ -7,7 +7,7 @@ This repo provides utilities for testing of ioBroker adapters and other ioBroker
 
 The unit tests are realized using the following tools that are provided by this module:
 
--   A mock database which implements the most basic functionality of `ioBroker`'s Objects and States DB by operating on `Map` objects.
+-   A mock database that implements the most basic functionality of `ioBroker`'s Objects and States DB by operating on `Map` objects.
 -   A mock `Adapter` that is connected to the mock database. It implements basic functionality of the real `Adapter` class, but only operates on the mock database.
 
 Predefined methods for both unit and integration tests are exported.
@@ -136,7 +136,7 @@ This method creates a mock database and a mock adapter. See below for a more det
 const asserts = utils.unit.createAsserts(database, adapter);
 ```
 
-These methods take a mock database and adapter and create a set of asserts for your tests. All IDs may either be a string, which is taken literally, or an array of strings which are concatenated with `"."`. If an ID is not fully qualified, the adapter namespace is prepended automatically.
+These methods take a mock database and adapter and create a set of assertions for your tests. All IDs may either be a string, which is taken literally, or an array of strings which are concatenated with `"."`. If an ID is not fully qualified, the adapter namespace is prepended automatically.
 
 -   `assertObjectExists(id: string | string[])` asserts that an object with the given ID exists in the database.
 -   `assertStateExists(id: string | string[])` asserts that a state with the given ID exists in the database.
@@ -217,7 +217,7 @@ Resetting the mock between tests:
 
 ### Example
 
-Here's an example how this can be used in a unit test:
+Here's an example of how this can be used in a unit test:
 
 ```ts
 import { tests, utils } from "@iobroker/testing";

package/build/lib/executeCommand.d.ts

@@ -5,9 +5,9 @@ export interface ExecuteCommandOptions {
     cwd: string;
     /** Where to redirect the stdin. Default: process.stdin */
     stdin: NodeJS.ReadStream;
-    /** A write stream to redirect the stdout, "ignore" to ignore it or "pipe" to return it as a string. Default: process.stdout */
+    /** A writing stream to redirect the stdout, "ignore" to ignore it or "pipe" to return it as a string. Default: process.stdout */
     stdout: NodeJS.WriteStream | 'pipe' | 'ignore';
-    /** A write stream to redirect the stderr, "ignore" to ignore it or "pipe" to return it as a string. Default: process.stderr */
+    /** A writing stream to redirect the stderr, "ignore" to ignore it or "pipe" to return it as a string. Default: process.stderr */
     stderr: NodeJS.WriteStream | 'pipe' | 'ignore';
 }
 export interface ExecuteCommandResult {
@@ -19,6 +19,8 @@ export interface ExecuteCommandResult {
     stdout?: string;
     /** If options.stderr was set to "buffer", this contains the stderr of the spawned process */
     stderr?: string;
+    /** The error that prevented the process from being spawned, if it could not be started at all */
+    error?: Error;
 }
 export declare function executeCommand(command: string, options?: Partial<ExecuteCommandOptions>): Promise<ExecuteCommandResult>;
 /**

package/build/lib/executeCommand.js

@@ -55,7 +55,22 @@ function executeCommand(command, argsOrOptions, options) {
         try {
             let bufferedStdout;
             let bufferedStderr;
-            const cmd = (0, node_child_process_1.spawn)(command, args, spawnOptions).on('close', (code, signal) => {
+            const cmd = (0, node_child_process_1.spawn)(command, args, spawnOptions)
+                .on('error', error => {
+                // The process could not be spawned at all - e.g. the command does not
+                // exist or the cwd is missing. Without a listener, Node treats this as
+                // an unhandled 'error' event and tears down the entire test process
+                // with a stack trace from node:internal, which tells the adapter
+                // developer nothing about the actual cause.
+                // Node emits 'close' after 'error' in this case; that second resolve
+                // is a no-op because the promise is already settled.
+                resolve({
+                    error,
+                    stdout: bufferedStdout,
+                    stderr: bufferedStderr,
+                });
+            })
+                .on('close', (code, signal) => {
                 resolve({
                     exitCode: code ?? undefined,
                     signal: signal ?? undefined,
@@ -83,8 +98,11 @@ function executeCommand(command, argsOrOptions, options) {
                 });
             }
         }
-        catch {
-            // doesn't matter, we return the exit code in the "close" handler
+        catch (error) {
+            // `spawn` can also throw synchronously, e.g. on invalid arguments. There is no
+            // child process in that case, so neither 'close' nor 'error' will ever fire and
+            // the promise would stay pending forever.
+            resolve({ error: error });
         }
     });
 }

package/build/tests/packageFiles/index.js

@@ -166,6 +166,12 @@ function validatePackageFiles(adapterDir) {
                     }
                 }
             });
+            it('No "prepare" script is defined in package.json', () => {
+                if ((0, typeguards_1.isObject)(packageContent.scripts) && 'prepare' in packageContent.scripts) {
+                    // eslint-disable-next-line @typescript-eslint/only-throw-error
+                    throw new chai_1.AssertionError(`The "prepare" script must not be defined in the "scripts" section of package.json, found "${packageContent.scripts.prepare}"! It runs on every "npm install" of the adapter (including for end users) and can break installations.`);
+                }
+            });
             it('iobroker.js-controller is not listed as a dependency', () => {
                 for (const depType of [
                     'dependencies',

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@iobroker/testing",
-  "version": "5.3.0",
+  "version": "6.0.0",
   "description": "Shared utilities for adapter and module testing in ioBroker",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [
     "build/"
   ],
+  "engines": {
+    "node": ">=22.19.0"
+  },
   "scripts": {
     "test": "mocha \"src/**/*.test.ts\"",
     "test:watch": "mocha \"src/**/*.test.ts\" --watch",
@@ -40,14 +43,14 @@
   "homepage": "https://github.com/AlCalzone/testing#readme",
   "devDependencies": {
     "@alcalzone/release-script": "^5.2.1",
-    "@alcalzone/release-script-plugin-license": "^5.2.0",
-    "@iobroker/adapter-core": "^3.4.1",
+    "@alcalzone/release-script-plugin-license": "^5.2.2",
+    "@iobroker/adapter-core": "^3.4.3",
     "@iobroker/eslint-config": "^2.3.4",
     "@iobroker/types": "^7.2.2",
-    "@tsconfig/node18": "^18.2.6",
+    "@tsconfig/node18": "^18.2.7",
     "@types/debug": "^4.1.13",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^26.1.1",
+    "@types/node": "^22.20.1",
     "rimraf": "^6.1.3",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.2",
@@ -64,10 +67,10 @@
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
     "debug": "^4.4.3",
-    "fs-extra": "^11.3.6",
+    "fs-extra": "^11.4.0",
     "json5": "^2.2.3",
-    "mocha": "^11.7.6",
-    "sinon": "^22.0.0",
+    "mocha": "^12.0.0",
+    "sinon": "^22.1.0",
     "sinon-chai": "^3.7.0"
   }
 }