@iobroker/testing 4.1.3 → 5.0.2

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;

package/build/tests/integration/lib/adapterSetup.js

@@ -15,20 +15,30 @@ 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 };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdapterSetup = void 0;
-/* eslint-disable @typescript-eslint/no-empty-function */
 // Add debug logging for tests
+// @ts-expect-error no types
 const objects_1 = require("alcalzone-shared/objects");
 const debug_1 = __importDefault(require("debug"));
 const fs_extra_1 = require("fs-extra");
@@ -36,12 +46,12 @@ const path = __importStar(require("path"));
 const adapterTools_1 = require("../../../lib/adapterTools");
 const executeCommand_1 = require("../../../lib/executeCommand");
 const tools_1 = require("./tools");
-const debug = (0, debug_1.default)("testing:integration:AdapterSetup");
+const debug = (0, debug_1.default)('testing:integration:AdapterSetup');
 class AdapterSetup {
     constructor(adapterDir, testDir) {
         this.adapterDir = adapterDir;
         this.testDir = testDir;
-        debug("Creating AdapterSetup...");
+        debug('Creating AdapterSetup...');
         this.adapterName = (0, adapterTools_1.getAdapterName)(this.adapterDir);
         this.adapterFullName = (0, adapterTools_1.getAdapterFullName)(this.adapterDir);
         this.appName = (0, adapterTools_1.getAppName)(this.adapterDir);
@@ -62,82 +72,85 @@ class AdapterSetup {
     }
     /** Copies all adapter files (except a few) to the test directory */
     async installAdapterInTestDir() {
-        debug("Copying adapter files to test directory...");
+        debug('Copying adapter files to test directory...');
         // We install the adapter almost like it would be installed in the real world
         // Therefore pack it into a tarball and put it in the test dir for installation
-        const packResult = await (0, executeCommand_1.executeCommand)("npm", ["pack", "--loglevel", "silent"], {
-            stdout: "pipe",
+        const packResult = await (0, executeCommand_1.executeCommand)('npm', ['pack', '--loglevel', 'silent'], {
+            stdout: 'pipe',
         });
-        if (packResult.exitCode !== 0 || typeof packResult.stdout !== "string")
+        if (packResult.exitCode !== 0 || typeof packResult.stdout !== 'string') {
             throw new Error(`Packing the adapter tarball failed!`);
+        }
         // The last non-empty line of `npm pack`s STDOUT contains the tarball path
         const stdoutLines = packResult.stdout.trim().split(/[\r\n]+/);
         const tarballName = stdoutLines[stdoutLines.length - 1].trim();
         const tarballPath = path.resolve(this.adapterDir, tarballName);
         await (0, fs_extra_1.copy)(tarballPath, path.resolve(this.testDir, tarballName));
         await (0, fs_extra_1.unlink)(tarballPath);
+        // Let npm remove the adapter in the package-lock.json file(s),
+        // so that the installation in the following step
+        // won't grab the cached files.
+        // See https://github.com/ioBroker/testing/issues/612
+        debug('Removing the adapter from package-lock.json');
+        await (0, executeCommand_1.executeCommand)('npm', ['uninstall', this.adapterFullName, '--package-lock-only', '--omit=dev'], {
+            cwd: this.testDir,
+        });
         // Complete the package.json, so npm can do it's magic
-        debug("Saving the adapter in package.json");
-        const packageJsonPath = path.join(this.testDir, "package.json");
+        debug('Saving the adapter in package.json');
+        const packageJsonPath = path.join(this.testDir, 'package.json');
         const packageJson = await (0, fs_extra_1.readJSON)(packageJsonPath);
         packageJson.dependencies[this.adapterFullName] = `file:./${tarballName}`;
         for (const [dep, version] of (0, objects_1.entries)((0, adapterTools_1.getAdapterDependencies)(this.adapterDir))) {
-            // Don't overwrite the js-controller github dependency with a probably lower one
-            if (dep === "js-controller")
+            // Don't overwrite the js-controller GitHub dependency with a probably lower one
+            if (dep === 'js-controller') {
                 continue;
+            }
             packageJson.dependencies[`${this.appName}.${dep}`] = version;
         }
         await (0, fs_extra_1.writeJSON)(packageJsonPath, packageJson, { spaces: 2 });
-        debug("Deleting old remains of this adapter");
-        if (await (0, fs_extra_1.pathExists)(this.testAdapterDir))
+        debug('Deleting old remains of this adapter');
+        if (await (0, fs_extra_1.pathExists)(this.testAdapterDir)) {
             await (0, fs_extra_1.remove)(this.testAdapterDir);
-        debug("Installing adapter");
+        }
+        debug('Installing adapter');
         // Defer to npm to install the controller (if it wasn't already)
-        await (0, executeCommand_1.executeCommand)("npm", ["i", "--production"], {
+        await (0, executeCommand_1.executeCommand)('npm', ['i', '--omit=dev'], {
             cwd: this.testDir,
         });
-        debug("  => done!");
+        debug('  => done!');
     }
     /**
      * Adds an instance for an already installed adapter in the test directory
      */
     async addAdapterInstance() {
-        debug("Adding adapter instance...");
+        debug('Adding adapter instance...');
         // execute iobroker add <adapter> -- This also installs missing dependencies
-        const addResult = await (0, executeCommand_1.executeCommand)("node", [
-            `${this.appName}.js`,
-            "add",
-            this.adapterName,
-            "--enabled",
-            "false",
-        ], {
+        const addResult = await (0, executeCommand_1.executeCommand)('node', [`${this.appName}.js`, 'add', this.adapterName, '--enabled', 'false'], {
             cwd: this.testControllerDir,
-            stdout: "ignore",
+            stdout: 'ignore',
         });
-        if (addResult.exitCode !== 0)
+        if (addResult.exitCode !== 0) {
             throw new Error(`Adding the adapter instance failed!`);
-        debug("  => done!");
+        }
+        debug('  => done!');
     }
     async deleteOldInstances(dbConnection) {
-        debug("Removing old adapter instances...");
-        const allKeys = new Set([
-            ...(await dbConnection.getObjectIDs()),
-            ...(await dbConnection.getStateIDs()),
-        ]);
+        debug('Removing old adapter instances...');
+        const allKeys = new Set([...(await dbConnection.getObjectIDs()), ...(await dbConnection.getStateIDs())]);
         const instanceRegex = new RegExp(`^system\\.adapter\\.${this.adapterName}\\.\\d+`);
-        const instanceObjsRegex = new RegExp(`^${this.adapterName}\\.\\d+\.`);
+        const instanceObjsRegex = new RegExp(`^${this.adapterName}\\.\\d+\\.`);
         const belongsToAdapter = (id) => {
             return (instanceRegex.test(id) ||
                 instanceObjsRegex.test(id) ||
                 id === this.adapterName ||
                 id === `${this.adapterName}.admin`);
         };
-        const idsToDelete = [...allKeys].filter((id) => belongsToAdapter(id));
+        const idsToDelete = [...allKeys].filter(id => belongsToAdapter(id));
         for (const id of idsToDelete) {
             await dbConnection.delObject(id).catch(() => { });
             await dbConnection.delState(id).catch(() => { });
         }
-        debug("  => done!");
+        debug('  => done!');
     }
 }
 exports.AdapterSetup = AdapterSetup;

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

@@ -1,4 +1,4 @@
-import type { DBConnection } from "./dbConnection";
+import type { DBConnection } from './dbConnection';
 export declare class ControllerSetup {
     private adapterDir;
     private testDir;
@@ -11,8 +11,6 @@ export declare class ControllerSetup {
     prepareTestDir(controllerVersion?: string): Promise<void>;
     /**
      * Tests if JS-Controller is already installed
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     isJsControllerInstalled(): Promise<boolean>;
     /**
@@ -25,25 +23,18 @@ export declare class ControllerSetup {
     setupJsController(): Promise<void>;
     /**
      * Changes the objects and states db to use alternative ports
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     setupSystemConfig(dbConnection: DBConnection): void;
     /**
      * Clears the log dir for integration tests (and creates it if it doesn't exist)
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     clearLogDir(): Promise<void>;
     /**
      * Clears the sqlite DB dir for integration tests (and creates it if it doesn't exist)
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     clearDBDir(): Promise<void>;
     /**
      * Disables all admin instances in the objects DB
-     * @param objects The contents of objects.json
      */
     disableAdminInstances(dbConnection: DBConnection): Promise<void>;
 }

package/build/tests/integration/lib/controllerSetup.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 };
 };
@@ -35,12 +45,12 @@ const path = __importStar(require("path"));
 const adapterTools_1 = require("../../../lib/adapterTools");
 const executeCommand_1 = require("../../../lib/executeCommand");
 const tools_1 = require("./tools");
-const debug = (0, debug_1.default)("testing:integration:ControllerSetup");
+const debug = (0, debug_1.default)('testing:integration:ControllerSetup');
 class ControllerSetup {
     constructor(adapterDir, testDir) {
         this.adapterDir = adapterDir;
         this.testDir = testDir;
-        debug("Creating ControllerSetup...");
+        debug('Creating ControllerSetup...');
         this.adapterName = (0, adapterTools_1.getAdapterName)(this.adapterDir);
         this.appName = (0, adapterTools_1.getAppName)(this.adapterDir);
         this.testAdapterDir = (0, tools_1.getTestAdapterDir)(this.adapterDir, this.testDir);
@@ -53,60 +63,59 @@ class ControllerSetup {
         debug(`  appName:      ${this.appName}`);
         debug(`  adapterName:  ${this.adapterName}`);
     }
-    async prepareTestDir(controllerVersion = "dev") {
+    async prepareTestDir(controllerVersion = 'dev') {
         debug(`Preparing the test directory. JS-Controller version: "${controllerVersion}"...`);
         // Make sure the test dir exists
         await (0, fs_extra_1.ensureDir)(this.testDir);
         // Write the package.json
         const packageJson = {
             name: path.basename(this.testDir),
-            version: "1.0.0",
-            main: "index.js",
+            version: '1.0.0',
+            main: 'index.js',
             scripts: {
                 test: 'echo "Error: no test specified" && exit 1',
             },
             keywords: [],
-            author: "",
-            license: "ISC",
+            author: '',
+            license: 'ISC',
             dependencies: {
                 [`${this.appName}.js-controller`]: controllerVersion,
             },
-            description: "",
+            description: '',
         };
-        await (0, fs_extra_1.writeJSON)(path.join(this.testDir, "package.json"), packageJson, {
+        await (0, fs_extra_1.writeJSON)(path.join(this.testDir, 'package.json'), packageJson, {
             spaces: 2,
         });
         // Delete a possible package-lock.json as it can mess with future installations
-        const pckLockPath = path.join(this.testDir, "package-lock.json");
-        if (await (0, fs_extra_1.pathExists)(pckLockPath))
+        const pckLockPath = path.join(this.testDir, 'package-lock.json');
+        if (await (0, fs_extra_1.pathExists)(pckLockPath)) {
             await (0, fs_extra_1.unlink)(pckLockPath);
+        }
         // Set the engineStrict flag on new Node.js versions to be in line with newer ioBroker installations
-        const nodeMajorVersion = parseInt(process.versions.node.split(".")[0], 10);
+        const nodeMajorVersion = parseInt(process.versions.node.split('.')[0], 10);
         if (nodeMajorVersion >= 10) {
-            await (0, fs_extra_1.writeFile)(path.join(this.testDir, ".npmrc"), "engine-strict=true", "utf8");
+            await (0, fs_extra_1.writeFile)(path.join(this.testDir, '.npmrc'), 'engine-strict=true', 'utf8');
         }
         // Remember if JS-Controller is installed already. If so, we need to call `setup first` afterwards
         const wasJsControllerInstalled = await this.isJsControllerInstalled();
         // Defer to npm to install the controller (if it wasn't already)
-        debug("(Re-)installing JS Controller...");
-        await (0, executeCommand_1.executeCommand)("npm", ["i", "--production"], {
+        debug('(Re-)installing JS Controller...');
+        await (0, executeCommand_1.executeCommand)('npm', ['i', '--omit=dev'], {
             cwd: this.testDir,
         });
         // Prepare/clean the databases and config
-        if (wasJsControllerInstalled)
+        if (wasJsControllerInstalled) {
             await this.setupJsController();
-        debug("  => done!");
+        }
+        debug('  => done!');
     }
     /**
      * Tests if JS-Controller is already installed
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     async isJsControllerInstalled() {
-        debug("Testing if JS-Controller is installed...");
+        debug('Testing if JS-Controller is installed...');
         // We expect js-controller to be installed if the dir in <testDir>/node_modules and the data directory exist
-        const isInstalled = (await (0, fs_extra_1.pathExists)(this.testControllerDir)) &&
-            (await (0, fs_extra_1.pathExists)(this.testDataDir));
+        const isInstalled = (await (0, fs_extra_1.pathExists)(this.testControllerDir)) && (await (0, fs_extra_1.pathExists)(this.testDataDir));
         debug(`  => ${isInstalled}`);
         return isInstalled;
     }
@@ -114,8 +123,8 @@ class ControllerSetup {
      * Tests if an instance of JS-Controller is already running by attempting to connect to the Objects DB
      */
     isJsControllerRunning() {
-        debug("Testing if JS-Controller is running...");
-        return new Promise((resolve) => {
+        debug('Testing if JS-Controller is running...');
+        return new Promise(resolve => {
             const client = new net_1.Socket();
             const timeout = setTimeout(() => {
                 // Assume the connection failed after 1 s
@@ -127,16 +136,16 @@ class ControllerSetup {
             client
                 .connect({
                 port: 9000,
-                host: "127.0.0.1",
+                host: '127.0.0.1',
             })
-                .on("connect", () => {
+                .on('connect', () => {
                 // The connection succeeded
                 client.destroy();
                 debug(`  => true`);
                 clearTimeout(timeout);
                 resolve(true);
             })
-                .on("error", () => {
+                .on('error', () => {
                 client.destroy();
                 debug(`  => false`);
                 clearTimeout(timeout);
@@ -168,24 +177,23 @@ class ControllerSetup {
      * Sets up an existing JS-Controller instance for testing by executing "iobroker setup first"
      */
     async setupJsController() {
-        debug("Initializing JS-Controller installation...");
+        debug('Initializing JS-Controller installation...');
         // Stop the controller before calling setup first
-        await (0, executeCommand_1.executeCommand)("node", [`${this.appName}.js`, "stop"], {
+        await (0, executeCommand_1.executeCommand)('node', [`${this.appName}.js`, 'stop'], {
             cwd: this.testControllerDir,
-            stdout: "ignore",
+            stdout: 'ignore',
         });
-        const setupResult = await (0, executeCommand_1.executeCommand)("node", [`${this.appName}.js`, "setup", "first", "--console"], {
+        const setupResult = await (0, executeCommand_1.executeCommand)('node', [`${this.appName}.js`, 'setup', 'first', '--console'], {
             cwd: this.testControllerDir,
-            stdout: "ignore",
+            stdout: 'ignore',
         });
-        if (setupResult.exitCode !== 0)
+        if (setupResult.exitCode !== 0) {
             throw new Error(`${this.appName} setup first failed!`);
-        debug("  => done!");
+        }
+        debug('  => done!');
     }
     /**
      * Changes the objects and states db to use alternative ports
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     setupSystemConfig(dbConnection) {
         debug(`Moving databases to different ports...`);
@@ -193,35 +201,30 @@ class ControllerSetup {
         systemConfig.objects.port = 19001;
         systemConfig.states.port = 19000;
         dbConnection.setSystemConfig(systemConfig);
-        debug("  => done!");
+        debug('  => done!');
     }
     /**
      * Clears the log dir for integration tests (and creates it if it doesn't exist)
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     clearLogDir() {
-        debug("Cleaning log directory...");
+        debug('Cleaning log directory...');
         return (0, fs_extra_1.emptyDir)((0, tools_1.getTestLogDir)(this.appName, this.testDir));
     }
     /**
      * Clears the sqlite DB dir for integration tests (and creates it if it doesn't exist)
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
     clearDBDir() {
-        debug("Cleaning SQLite directory...");
+        debug('Cleaning SQLite directory...');
         return (0, fs_extra_1.emptyDir)((0, tools_1.getTestDBDir)(this.appName, this.testDir));
     }
     /**
      * Disables all admin instances in the objects DB
-     * @param objects The contents of objects.json
      */
     async disableAdminInstances(dbConnection) {
-        debug("Disabling admin instances...");
-        const instanceObjects = await dbConnection.getObjectViewAsync("system", "instance", {
-            startkey: "system.adapter.admin.",
-            endkey: "system.adapter.admin.\u9999",
+        debug('Disabling admin instances...');
+        const instanceObjects = await dbConnection.getObjectViewAsync('system', 'instance', {
+            startkey: 'system.adapter.admin.',
+            endkey: 'system.adapter.admin.\u9999',
         });
         for (const { id, value: obj } of instanceObjects.rows) {
             if (obj && obj.common) {
@@ -229,7 +232,7 @@ class ControllerSetup {
                 await dbConnection.setObject(id, obj);
             }
         }
-        debug("  => done!");
+        debug('  => done!');
     }
 }
 exports.ControllerSetup = ControllerSetup;

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

@@ -1,13 +1,9 @@
-/// <reference types="iobroker" />
-/// <reference types="iobroker" />
-/// <reference types="node" />
-/// <reference types="node" />
-import EventEmitter from "events";
+import EventEmitter from 'events';
 export type ObjectsDB = Record<string, ioBroker.Object>;
 export type StatesDB = Record<string, ioBroker.State>;
 export interface DBConnection {
-    on(event: "objectChange", handler: ioBroker.ObjectChangeHandler): this;
-    on(event: "stateChange", handler: ioBroker.StateChangeHandler): this;
+    on(event: 'objectChange', handler: ioBroker.ObjectChangeHandler): this;
+    on(event: 'stateChange', handler: ioBroker.StateChangeHandler): this;
 }
 /** The DB connection capsules access to the states and objects DB */
 export declare class DBConnection extends EventEmitter {
@@ -29,9 +25,9 @@ export declare class DBConnection extends EventEmitter {
     private _statesClient;
     /** The underlying states client instance that can be used to access the states DB */
     get statesClient(): any;
-    get objectsType(): "file" | "jsonl";
+    get objectsType(): 'file' | 'jsonl';
     get objectsPath(): string;
-    get statesType(): "file" | "jsonl";
+    get statesType(): 'file' | 'jsonl';
     get statesPath(): string;
     getSystemConfig(): any;
     backup(): Promise<{
@@ -48,15 +44,15 @@ export declare class DBConnection extends EventEmitter {
     private createObjectsDB;
     /** Creates the states DB and sets up listeners for it */
     private createStatesDB;
-    readonly getObject: ioBroker.Adapter["getForeignObjectAsync"];
-    readonly setObject: ioBroker.Adapter["setForeignObjectAsync"];
-    readonly delObject: ioBroker.Adapter["delForeignObjectAsync"];
-    readonly getState: ioBroker.Adapter["getForeignStateAsync"];
-    readonly setState: ioBroker.Adapter["setForeignStateAsync"];
-    readonly delState: ioBroker.Adapter["delForeignStateAsync"];
+    readonly getObject: ioBroker.Adapter['getForeignObjectAsync'];
+    readonly setObject: ioBroker.Adapter['setForeignObjectAsync'];
+    readonly delObject: ioBroker.Adapter['delForeignObjectAsync'];
+    readonly getState: ioBroker.Adapter['getForeignStateAsync'];
+    readonly setState: ioBroker.Adapter['setForeignStateAsync'];
+    readonly delState: ioBroker.Adapter['delForeignStateAsync'];
     subscribeMessage(id: string): void;
     pushMessage(instanceId: string, msg: any, callback: (err: Error | null, id: any) => void): void;
-    readonly getObjectViewAsync: ioBroker.Adapter["getObjectViewAsync"];
+    readonly getObjectViewAsync: ioBroker.Adapter['getObjectViewAsync'];
     getStateIDs(pattern?: string): Promise<string[]>;
     getObjectIDs(pattern?: string): Promise<string[]>;
 }