@iobroker/testing 5.0.0 → 5.0.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 AlCalzone <d.griesel@gmx.net>
+Copyright (c) 2024-2025 AlCalzone <d.griesel@gmx.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -2,7 +2,7 @@
 
 This repo provides utilities for testing of ioBroker adapters and other ioBroker-related modules. It supports:
 
--   **Unit tests** using mocks (without a running JS-Controller)
+-   **Unit tests** using mocks (without a running JS-Controller) **deprecated** and no longer used
 -   **Integration tests** that test against a running JS-Controller instance.
 
 The unit tests are realized using the following tools that are provided by this module:

package/build/index.d.ts

@@ -1 +1 @@
-export * from "./tests";
+export * from './tests';

package/build/lib/adapterTools.d.ts

@@ -1,31 +1,37 @@
 /**
  * Loads an adapter's package.json
+ *
  * @param adapterDir The directory the adapter resides in
  */
 export declare function loadNpmPackage(adapterDir: string): Record<string, any>;
 /**
  * Loads an adapter's io-package.json
+ *
  * @param adapterDir The directory the adapter resides in
  */
 export declare function loadIoPackage(adapterDir: string): Record<string, any>;
-export declare function getAdapterExecutionMode(adapterDir: string): ioBroker.AdapterCommon["mode"];
+export declare function getAdapterExecutionMode(adapterDir: string): ioBroker.AdapterCommon['mode'];
 /**
  * Locates an adapter's main file
+ *
  * @param adapterDir The directory the adapter resides in
  */
 export declare function locateAdapterMainFile(adapterDir: string): Promise<string>;
 /**
  * Locates an adapter's config to populate the `adapter.config` object with
+ *
  * @param adapterDir The directory the adapter resides in
  */
 export declare function loadAdapterConfig(adapterDir: string): Record<string, any>;
 /**
  * Loads the adapter's common configuration from `io-package.json`
+ *
  * @param adapterDir The directory the adapter resides in
  */
 export declare function loadAdapterCommon(adapterDir: string): Record<string, any>;
 /**
  * Loads the instanceObjects for an adapter from its `io-package.json`
+ *
  * @param adapterDir The directory the adapter resides in
  */
 export declare function loadInstanceObjects(adapterDir: string): ioBroker.Object[];

package/build/lib/adapterTools.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -42,22 +52,22 @@ const typeguards_1 = require("alcalzone-shared/typeguards");
 const debug_1 = __importDefault(require("debug"));
 const fs_extra_1 = require("fs-extra");
 const path = __importStar(require("path"));
-const debug = (0, debug_1.default)("testing:unit:adapterTools");
+const debug = (0, debug_1.default)('testing:unit:adapterTools');
 /**
  * Loads an adapter's package.json
+ *
  * @param adapterDir The directory the adapter resides in
  */
 function loadNpmPackage(adapterDir) {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    return require(path.join(adapterDir, "package.json"));
+    return require(path.join(adapterDir, 'package.json'));
 }
 /**
  * Loads an adapter's io-package.json
+ *
  * @param adapterDir The directory the adapter resides in
  */
 function loadIoPackage(adapterDir) {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    return require(path.join(adapterDir, "io-package.json"));
+    return require(path.join(adapterDir, 'io-package.json'));
 }
 function getAdapterExecutionMode(adapterDir) {
     const ioPackage = loadIoPackage(adapterDir);
@@ -65,6 +75,7 @@ function getAdapterExecutionMode(adapterDir) {
 }
 /**
  * Locates an adapter's main file
+ *
  * @param adapterDir The directory the adapter resides in
  */
 async function locateAdapterMainFile(adapterDir) {
@@ -72,11 +83,11 @@ async function locateAdapterMainFile(adapterDir) {
     const ioPackage = loadIoPackage(adapterDir);
     const npmPackage = loadNpmPackage(adapterDir);
     // First look for the file defined in io-package.json or package.json or use "main.js" as a fallback
-    const mainFile = typeof ioPackage.common.main === "string"
+    const mainFile = typeof ioPackage.common.main === 'string'
         ? ioPackage.common.main
-        : typeof npmPackage.main === "string"
+        : typeof npmPackage.main === 'string'
             ? npmPackage.main
-            : "main.js";
+            : 'main.js';
     let ret = path.join(adapterDir, mainFile);
     debug(`  => trying ${ret}`);
     if (await (0, fs_extra_1.pathExists)(ret)) {
@@ -84,7 +95,7 @@ async function locateAdapterMainFile(adapterDir) {
         return ret;
     }
     // If both don't exist, JS-Controller uses <adapter name>.js as another fallback
-    ret = path.join(adapterDir, ioPackage.common.name + ".js");
+    ret = path.join(adapterDir, `${ioPackage.common.name}.js`);
     debug(`  => trying ${ret}`);
     if (await (0, fs_extra_1.pathExists)(ret)) {
         debug(`  => found ${mainFile}`);
@@ -94,6 +105,7 @@ async function locateAdapterMainFile(adapterDir) {
 }
 /**
  * Locates an adapter's config to populate the `adapter.config` object with
+ *
  * @param adapterDir The directory the adapter resides in
  */
 function loadAdapterConfig(adapterDir) {
@@ -102,6 +114,7 @@ function loadAdapterConfig(adapterDir) {
 }
 /**
  * Loads the adapter's common configuration from `io-package.json`
+ *
  * @param adapterDir The directory the adapter resides in
  */
 function loadAdapterCommon(adapterDir) {
@@ -110,6 +123,7 @@ function loadAdapterCommon(adapterDir) {
 }
 /**
  * Loads the instanceObjects for an adapter from its `io-package.json`
+ *
  * @param adapterDir The directory the adapter resides in
  */
 function loadInstanceObjects(adapterDir) {
@@ -119,7 +133,7 @@ function loadInstanceObjects(adapterDir) {
 /** Returns the branded name of "iobroker" */
 function getAppName(adapterDir) {
     const npmPackage = loadNpmPackage(adapterDir);
-    return npmPackage.name.split(".")[0] || "iobroker";
+    return npmPackage.name.split('.')[0] || 'iobroker';
 }
 /** Returns the name of an adapter without the prefix */
 function getAdapterName(adapterDir) {
@@ -137,13 +151,14 @@ function getAdapterDependencies(adapterDir) {
     const ret = {};
     if ((0, typeguards_1.isArray)(ioPackage.common.dependencies)) {
         for (const dep of ioPackage.common.dependencies) {
-            if (typeof dep === "string") {
-                ret[dep] = "latest";
+            if (typeof dep === 'string') {
+                ret[dep] = 'latest';
             }
             else if ((0, typeguards_1.isObject)(dep)) {
                 const key = Object.keys(dep)[0];
-                if (key)
-                    ret[key] = dep[key] || "latest";
+                if (key) {
+                    ret[key] = dep[key] || 'latest';
+                }
             }
         }
     }

package/build/lib/executeCommand.d.ts

@@ -6,9 +6,9 @@ export interface ExecuteCommandOptions {
     /** 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 */
-    stdout: NodeJS.WriteStream | "pipe" | "ignore";
+    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 */
-    stderr: NodeJS.WriteStream | "pipe" | "ignore";
+    stderr: NodeJS.WriteStream | 'pipe' | 'ignore';
 }
 export interface ExecuteCommandResult {
     /** The exit code of the spawned process */
@@ -23,6 +23,7 @@ export interface ExecuteCommandResult {
 export declare function executeCommand(command: string, options?: Partial<ExecuteCommandOptions>): Promise<ExecuteCommandResult>;
 /**
  * Executes a command and returns the exit code and (if requested) the stdout
+ *
  * @param command The command to execute
  * @param args The command line arguments for the command
  * @param options (optional) Some options for the command execution

package/build/lib/executeCommand.js

@@ -1,55 +1,54 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCommand = executeCommand;
-const typeguards_1 = require("alcalzone-shared/typeguards");
 const child_process_1 = require("child_process");
 const isWindows = /^win/.test(process.platform);
 function executeCommand(command, argsOrOptions, options) {
-    return new Promise((resolve) => {
+    return new Promise(resolve => {
         let args;
-        if ((0, typeguards_1.isArray)(argsOrOptions)) {
+        if (Array.isArray(argsOrOptions)) {
             args = argsOrOptions;
         }
-        else if ((0, typeguards_1.isObject)(argsOrOptions)) {
+        else if (argsOrOptions && typeof argsOrOptions === 'object') {
             // no args were given
             options = argsOrOptions;
         }
-        if (options == null)
+        if (options == null) {
             options = {};
-        if (args == null)
+        }
+        if (args == null) {
             args = [];
+        }
         const spawnOptions = {
-            stdio: [
-                options.stdin || process.stdin,
-                options.stdout || process.stdout,
-                options.stderr || process.stderr,
-            ],
+            stdio: [options.stdin || process.stdin, options.stdout || process.stdout, options.stderr || process.stderr],
             windowsHide: true,
         };
-        if (options.cwd != null)
+        if (options.cwd != null) {
             spawnOptions.cwd = options.cwd;
+        }
         // Fix npm / node executable paths on Windows
         if (isWindows) {
-            if (command === "npm") {
-                command += ".cmd";
+            if (command === 'npm') {
+                command += '.cmd';
                 // Needed since Node.js v18.20.2 and v20.12.2
                 // https://github.com/nodejs/node/releases/tag/v18.20.2
                 spawnOptions.shell = true;
             }
-            else if (command === "node") {
-                command += ".exe";
+            else if (command === 'node') {
+                command += '.exe';
             }
         }
-        if (options.logCommandExecution == null)
+        if (options.logCommandExecution == null) {
             options.logCommandExecution = false;
+        }
         if (options.logCommandExecution) {
-            console.log("executing: " + `${command} ${args.join(" ")}`);
+            console.log(`executing: ${command} ${args.join(' ')}`);
         }
         // Now execute the npm process and avoid throwing errors
         try {
             let bufferedStdout;
             let bufferedStderr;
-            const cmd = (0, child_process_1.spawn)(command, args, spawnOptions).on("close", (code, signal) => {
+            const cmd = (0, child_process_1.spawn)(command, args, spawnOptions).on('close', (code, signal) => {
                 resolve({
                     exitCode: code ?? undefined,
                     signal: signal ?? undefined,
@@ -58,19 +57,21 @@ function executeCommand(command, argsOrOptions, options) {
                 });
             });
             // Capture stdout/stderr if requested
-            if (options.stdout === "pipe") {
-                bufferedStdout = "";
-                cmd.stdout.on("data", (chunk) => {
-                    if (Buffer.isBuffer(chunk))
-                        chunk = chunk.toString("utf8");
+            if (options.stdout === 'pipe') {
+                bufferedStdout = '';
+                cmd.stdout.on('data', (chunk) => {
+                    if (Buffer.isBuffer(chunk)) {
+                        chunk = chunk.toString('utf8');
+                    }
                     bufferedStdout += chunk;
                 });
             }
-            if (options.stderr === "pipe") {
-                bufferedStderr = "";
-                cmd.stderr.on("data", (chunk) => {
-                    if (Buffer.isBuffer(chunk))
-                        chunk = chunk.toString("utf8");
+            if (options.stderr === 'pipe') {
+                bufferedStderr = '';
+                cmd.stderr.on('data', (chunk) => {
+                    if (Buffer.isBuffer(chunk)) {
+                        chunk = chunk.toString('utf8');
+                    }
                     bufferedStderr += chunk;
                 });
             }

package/build/lib/str2regex.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.str2regex = str2regex;
 function str2regex(pattern) {
     return new RegExp(pattern
-        .replace(/\\/g, "\\\\") // Backslashes escapen
-        .replace(/\./g, "\\.") // Punkte als solche matchen
-        .replace(/\*/g, ".*") // Wildcard in Regex umsetzen
-        .replace(/!/g, "?!"));
+        .replace(/\\/g, '\\\\') // Backslashes escapen
+        .replace(/\./g, '\\.') // Punkte als solche matchen
+        .replace(/\*/g, '.*') // Wildcard in Regex umsetzen
+        .replace(/!/g, '?!'));
 }

package/build/tests/index.d.ts

@@ -1,11 +1,11 @@
-import { testAdapter } from "./integration";
-import { validatePackageFiles } from "./packageFiles";
-import { testAdapterWithMocks } from "./unit";
-import { createMocks } from "./unit/harness/createMocks";
-import { createAsserts } from "./unit/mocks/mockDatabase";
-export { TestHarness as IntegrationTestHarness } from "./integration/lib/harness";
-export { MockAdapter } from "./unit/mocks/mockAdapter";
-export { MockDatabase } from "./unit/mocks/mockDatabase";
+import { testAdapter } from './integration';
+import { validatePackageFiles } from './packageFiles';
+import { testAdapterWithMocks } from './unit';
+import { createMocks } from './unit/harness/createMocks';
+import { createAsserts } from './unit/mocks/mockDatabase';
+export { TestHarness as IntegrationTestHarness } from './integration/lib/harness';
+export type { MockAdapter } from './unit/mocks/mockAdapter';
+export { MockDatabase } from './unit/mocks/mockDatabase';
 /** Predefined test sets */
 export declare const tests: {
     /** @deprecated Adapter startup unit tests are no longer supported */
@@ -19,6 +19,6 @@ export declare const utils: {
         createMocks: typeof createMocks;
         createAsserts: typeof createAsserts;
         /** @deprecated Adapter startup unit tests are no longer supported */
-        startMockAdapter: () => {};
+        startMockAdapter: () => any;
     };
 };

package/build/tests/integration/index.d.ts

@@ -1,4 +1,4 @@
-import { TestHarness } from "./lib/harness";
+import { TestHarness } from './lib/harness';
 export interface TestAdapterOptions {
     allowedExitCodes?: (number | string)[];
     /** The loglevel to use for DB and adapter related logs */

package/build/tests/integration/index.js

@@ -15,16 +15,25 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testAdapter = testAdapter;
-const async_1 = require("alcalzone-shared/async");
 const os = __importStar(require("os"));
 const path = __importStar(require("path"));
 const adapterTools_1 = require("../../lib/adapterTools");
@@ -52,7 +61,7 @@ function testAdapter(adapterDir, options = {}) {
         const oneMinute = 60000;
         this.timeout(30 * oneMinute);
         if (await controllerSetup.isJsControllerRunning()) {
-            throw new Error("JS-Controller is already running! Stop it for the first test run and try again!");
+            throw new Error('JS-Controller is already running! Stop it for the first test run and try again!');
         }
         const adapterSetup = new adapterSetup_1.AdapterSetup(adapterDir, testDir);
         // Installation happens in two steps:
@@ -62,7 +71,7 @@ function testAdapter(adapterDir, options = {}) {
         // Only then we can install the adapter, because some (including VIS) try to access
         // the databases if JS Controller is installed
         await adapterSetup.installAdapterInTestDir();
-        const dbConnection = new dbConnection_1.DBConnection(appName, testDir, (0, logger_1.createLogger)(options.loglevel ?? "debug"));
+        const dbConnection = new dbConnection_1.DBConnection(appName, testDir, (0, logger_1.createLogger)(options.loglevel ?? 'debug'));
         await dbConnection.start();
         controllerSetup.setupSystemConfig(dbConnection);
         await controllerSetup.disableAdminInstances(dbConnection);
@@ -70,8 +79,7 @@ function testAdapter(adapterDir, options = {}) {
         await adapterSetup.addAdapterInstance();
         await dbConnection.stop();
         // Create a copy of the databases that we can restore later
-        ({ objects: objectsBackup, states: statesBackup } =
-            await dbConnection.backup());
+        ({ objects: objectsBackup, states: statesBackup } = await dbConnection.backup());
     }
     async function shutdownTests() {
         // Stopping the processes may take a while
@@ -82,7 +90,7 @@ function testAdapter(adapterDir, options = {}) {
     }
     async function resetDbAndStartHarness() {
         this.timeout(30000);
-        dbConnection = new dbConnection_1.DBConnection(appName, testDir, (0, logger_1.createLogger)(options.loglevel ?? "debug"));
+        dbConnection = new dbConnection_1.DBConnection(appName, testDir, (0, logger_1.createLogger)(options.loglevel ?? 'debug'));
         // Clean up before every single test
         await Promise.all([
             controllerSetup.clearDBDir(),
@@ -96,7 +104,7 @@ function testAdapter(adapterDir, options = {}) {
         await harness.changeAdapterConfig(adapterName, {
             common: {
                 enabled: true,
-                loglevel: options.loglevel ?? "debug",
+                loglevel: options.loglevel ?? 'debug',
             },
         });
         // And enable the sendTo emulation
@@ -104,60 +112,57 @@ function testAdapter(adapterDir, options = {}) {
     }
     describe(`Adapter integration tests`, () => {
         before(prepareTests);
-        describe("Adapter startup", () => {
+        describe('Adapter startup', () => {
             beforeEach(resetDbAndStartHarness);
             afterEach(shutdownTests);
-            it("The adapter starts", function () {
+            it('The adapter starts', function () {
                 this.timeout(60000);
                 const allowedExitCodes = new Set(options.allowedExitCodes ?? []);
                 // Adapters with these modes are allowed to "immediately" exit with code 0
                 switch (harness.getAdapterExecutionMode()) {
-                    case "schedule":
-                    case "once":
+                    case 'schedule':
+                        allowedExitCodes.add(0);
+                        break;
+                    case 'once':
+                        allowedExitCodes.add(0);
+                        break;
                     // @ts-expect-error subscribe was deprecated
-                    case "subscribe":
+                    case 'subscribe':
                         allowedExitCodes.add(0);
+                        break;
                 }
                 return new Promise((resolve, reject) => {
                     // Register a handler to check the alive state and exit codes
                     harness
-                        .on("stateChange", async (id, state) => {
-                        if (id ===
-                            `system.adapter.${adapterName}.0.alive` &&
-                            state &&
-                            state.val === true) {
+                        .on('stateChange', async (id, state) => {
+                        if (id === `system.adapter.${adapterName}.0.alive` && state && state.val === true) {
                             // Wait a bit so we can catch errors that do not happen immediately
-                            await (0, async_1.wait)(options.waitBeforeStartupSuccess !=
-                                undefined
+                            await new Promise(resolve => setTimeout(resolve, options.waitBeforeStartupSuccess !== undefined
                                 ? options.waitBeforeStartupSuccess
-                                : 5000);
+                                : 5000));
                             resolve(`The adapter started successfully.`);
                         }
                     })
-                        .on("failed", (code) => {
+                        .on('failed', code => {
                         if (!allowedExitCodes.has(code)) {
-                            reject(new Error(`The adapter startup was interrupted unexpectedly with ${typeof code === "number"
-                                ? "code"
-                                : "signal"} ${code}`));
+                            reject(new Error(`The adapter startup was interrupted unexpectedly with ${typeof code === 'number' ? 'code' : 'signal'} ${code}`));
                         }
                         else {
                             // This was a valid exit code
-                            resolve(`The expected ${typeof code === "number"
-                                ? "exit code"
-                                : "signal"} ${code} was received.`);
+                            resolve(`The expected ${typeof code === 'number' ? 'exit code' : 'signal'} ${code} was received.`);
                         }
                     });
-                    harness.startAdapter();
-                }).then((msg) => console.log(msg));
+                    void harness.startAdapter();
+                }).then(msg => console.log(msg));
             });
         });
         // Call the user's tests
-        if (typeof options.defineAdditionalTests === "function") {
+        if (typeof options.defineAdditionalTests === 'function') {
             const originalIt = global.it;
             // Ensure no it() gets called outside of a suite()
             function assertSuite() {
                 if (!isInSuite) {
-                    throw new Error("In user-defined adapter tests, it() must NOT be called outside of a suite()");
+                    throw new Error('In user-defined adapter tests, it() must NOT be called outside of a suite()');
                 }
             }
             const patchedIt = new Proxy(originalIt, {
@@ -170,7 +175,7 @@ function testAdapter(adapterDir, options = {}) {
                     return target[propKey];
                 },
             });
-            describe("User-defined tests", () => {
+            describe('User-defined tests', () => {
                 // patch the global it() function so nobody can bypass the checks
                 global.it = patchedIt;
                 // a test suite is a special describe which sets up and tears down the test environment before and after ALL tests

package/build/tests/integration/lib/adapterSetup.d.ts

@@ -1,4 +1,4 @@
-import type { DBConnection } from "./dbConnection";
+import type { DBConnection } from './dbConnection';
 export declare class AdapterSetup {
     private adapterDir;
     private testDir;