@iobroker/testing 2.5.0 → 2.5.4

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

@@ -18,21 +18,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ControllerSetup = void 0;
-/* eslint-disable @typescript-eslint/no-var-requires */
 // Add debug logging for tests
 const debug_1 = __importDefault(require("debug"));
 const fs_extra_1 = require("fs-extra");
@@ -41,18 +31,17 @@ const path = __importStar(require("path"));
 const adapterTools_1 = require("../../../lib/adapterTools");
 const executeCommand_1 = require("../../../lib/executeCommand");
 const tools_1 = require("./tools");
-const debug = debug_1.default("testing:integration:ControllerSetup");
+const debug = (0, debug_1.default)("testing:integration:ControllerSetup");
 class ControllerSetup {
-    constructor(adapterDir, testDir, dbConnection) {
+    constructor(adapterDir, testDir) {
         this.adapterDir = adapterDir;
         this.testDir = testDir;
-        this.dbConnection = dbConnection;
         debug("Creating ControllerSetup...");
-        this.adapterName = adapterTools_1.getAdapterName(this.adapterDir);
-        this.appName = adapterTools_1.getAppName(this.adapterDir);
-        this.testAdapterDir = tools_1.getTestAdapterDir(this.adapterDir, this.testDir);
-        this.testControllerDir = tools_1.getTestControllerDir(this.appName, this.testDir);
-        this.testDataDir = tools_1.getTestDataDir(this.appName, this.testDir);
+        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);
+        this.testControllerDir = (0, tools_1.getTestControllerDir)(this.appName, this.testDir);
+        this.testDataDir = (0, tools_1.getTestDataDir)(this.appName, this.testDir);
         debug(`  directories:`);
         debug(`    controller: ${this.testControllerDir}`);
         debug(`    adapter:    ${this.testAdapterDir}`);
@@ -60,56 +49,62 @@ class ControllerSetup {
         debug(`  appName:      ${this.appName}`);
         debug(`  adapterName:  ${this.adapterName}`);
     }
-    prepareTestDir() {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug("Preparing the test directory...");
-            // Make sure the test dir exists
-            yield fs_extra_1.ensureDir(this.testDir);
-            // Write the package.json
-            const packageJson = {
-                name: path.basename(this.testDir),
-                version: "1.0.0",
-                main: "index.js",
-                scripts: {
-                    test: 'echo "Error: no test specified" && exit 1',
-                },
-                keywords: [],
-                author: "",
-                license: "ISC",
-                dependencies: {
-                    [`${this.appName}.js-controller`]: "dev",
-                },
-                description: "",
-            };
-            yield 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 (yield fs_extra_1.pathExists(pckLockPath))
-                yield 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);
-            if (nodeMajorVersion >= 10) {
-                yield fs_extra_1.writeFile(path.join(this.testDir, ".npmrc"), "engine-strict=true", "utf8");
-            }
-            debug("  => done!");
+    async prepareTestDir() {
+        debug("Preparing the test directory...");
+        // 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",
+            scripts: {
+                test: 'echo "Error: no test specified" && exit 1',
+            },
+            keywords: [],
+            author: "",
+            license: "ISC",
+            dependencies: {
+                [`${this.appName}.js-controller`]: "dev",
+            },
+            description: "",
+        };
+        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))
+            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);
+        if (nodeMajorVersion >= 10) {
+            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"], {
+            cwd: this.testDir,
         });
+        // Prepare/clean the databases and config
+        if (wasJsControllerInstalled)
+            await this.setupJsController();
+        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
      */
-    isJsControllerInstalled() {
-        return __awaiter(this, void 0, void 0, function* () {
-            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 = (yield fs_extra_1.pathExists(this.testControllerDir)) &&
-                (yield fs_extra_1.pathExists(this.testDataDir));
-            debug(`  => ${isInstalled}`);
-            return isInstalled;
-        });
+    async isJsControllerInstalled() {
+        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));
+        debug(`  => ${isInstalled}`);
+        return isInstalled;
     }
     /**
      * Tests if an instance of JS-Controller is already running by attempting to connect to the Objects DB
@@ -165,41 +160,34 @@ class ControllerSetup {
     // }
     /**
      * Sets up an existing JS-Controller instance for testing by executing "iobroker setup first"
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
      */
-    setupJsController() {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug("Initializing JS-Controller installation...");
-            // Stop the controller before calling setup first
-            yield executeCommand_1.executeCommand("node", [`${this.appName}.js`, "stop"], {
-                cwd: this.testControllerDir,
-                stdout: "ignore",
-            });
-            const setupResult = yield executeCommand_1.executeCommand("node", [`${this.appName}.js`, "setup", "first", "--console"], {
-                cwd: this.testControllerDir,
-                stdout: "ignore",
-            });
-            if (setupResult.exitCode !== 0)
-                throw new Error(`${this.appName} setup first failed!`);
-            debug("  => done!");
+    async setupJsController() {
+        debug("Initializing JS-Controller installation...");
+        // Stop the controller before calling setup first
+        await (0, executeCommand_1.executeCommand)("node", [`${this.appName}.js`, "stop"], {
+            cwd: this.testControllerDir,
+            stdout: "ignore",
+        });
+        const setupResult = await (0, executeCommand_1.executeCommand)("node", [`${this.appName}.js`, "setup", "first", "--console"], {
+            cwd: this.testControllerDir,
+            stdout: "ignore",
         });
+        if (setupResult.exitCode !== 0)
+            throw new Error(`${this.appName} setup first failed!`);
+        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() {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug("Moving databases to different ports...");
-            const systemFilename = path.join(this.testDataDir, `${this.appName}.json`);
-            const systemConfig = require(systemFilename);
-            systemConfig.objects.port = 19001;
-            systemConfig.states.port = 19000;
-            yield fs_extra_1.writeFile(systemFilename, JSON.stringify(systemConfig, null, 2));
-            debug("  => done!");
-        });
+    setupSystemConfig(dbConnection) {
+        debug(`Moving databases to different ports...`);
+        const systemConfig = dbConnection.getSystemConfig();
+        systemConfig.objects.port = 19001;
+        systemConfig.states.port = 19000;
+        dbConnection.setSystemConfig(systemConfig);
+        debug("  => done!");
     }
     /**
      * Clears the log dir for integration tests (and creates it if it doesn't exist)
@@ -208,7 +196,7 @@ class ControllerSetup {
      */
     clearLogDir() {
         debug("Cleaning log directory...");
-        return fs_extra_1.emptyDir(tools_1.getTestLogDir(this.appName, this.testDir));
+        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)
@@ -217,28 +205,25 @@ class ControllerSetup {
      */
     clearDBDir() {
         debug("Cleaning SQLite directory...");
-        return fs_extra_1.emptyDir(tools_1.getTestDBDir(this.appName, this.testDir));
+        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
      */
-    disableAdminInstances() {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug("Disabling admin instances...");
-            const objects = yield this.dbConnection.readObjectsDB();
-            if (objects) {
-                for (const id of Object.keys(objects)) {
-                    if (/^system\.adapter\.admin\.\d.+$/.test(id)) {
-                        const obj = objects[id];
-                        if (obj && obj.common)
-                            obj.common.enabled = false;
-                    }
-                }
-                yield this.dbConnection.writeObjectsDB(objects);
-            }
-            debug("  => done!");
+    async disableAdminInstances(dbConnection) {
+        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) {
+                obj.common.enabled = false;
+                await dbConnection.setObject(id, obj);
+            }
+        }
+        debug("  => done!");
     }
 }
 exports.ControllerSetup = ControllerSetup;

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

@@ -1,8 +1,14 @@
 /// <reference types="iobroker" />
+/// <reference types="node" />
+import EventEmitter from "events";
 export declare type ObjectsDB = Record<string, ioBroker.Object>;
 export declare type StatesDB = Record<string, ioBroker.State>;
-/** The DB connection capsules access to the objects.json and states.json on disk */
-export declare class DBConnection {
+export interface DBConnection {
+    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 {
     private appName;
     private testDir;
     /**
@@ -11,25 +17,43 @@ export declare class DBConnection {
      */
     constructor(appName: string, testDir: string);
     private testDataDir;
-    private objectsPath;
-    private statesPath;
-    readObjectsDB(): Promise<Record<string, ioBroker.Object> | undefined>;
-    writeObjectsDB(objects: ObjectsDB | undefined): Promise<void>;
-    writeStatesDB(states: StatesDB | undefined): Promise<void>;
-    readStatesDB(): Promise<any>;
-    /**
-     * Creates a backup of the objects and states DB, so it can be restored after each test
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
-     */
-    readDB(): Promise<{
-        objects: Record<string, ioBroker.Object> | undefined;
-        states: any;
+    private testControllerDir;
+    private _objectsServer;
+    private _statesServer;
+    private _objectsClient;
+    /** The underlying objects client instance that can be used to access the objects DB */
+    get objectsClient(): any;
+    private _statesClient;
+    /** The underlying states client instance that can be used to access the states DB */
+    get statesClient(): any;
+    get objectsType(): "file" | "jsonl";
+    get objectsPath(): string;
+    get statesType(): "file" | "jsonl";
+    get statesPath(): string;
+    getSystemConfig(): any;
+    backup(): Promise<{
+        objects: Buffer;
+        states: Buffer;
     }>;
-    /**
-     * Restores a previous backup of the objects and states DB
-     * @param appName The branded name of "iobroker"
-     * @param testDir The directory the integration tests are executed in
-     */
-    writeDB(objects: any, states: any): Promise<void>;
+    restore(objects: Buffer, states: Buffer): Promise<void>;
+    setSystemConfig(systemConfig: any): void;
+    private _isRunning;
+    get isRunning(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /** Creates the objects DB and sets up listeners for it */
+    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"];
+    subscribeMessage(id: string): void;
+    pushMessage(instanceId: string, msg: any, callback: (err: Error | null, id: any) => void): void;
+    readonly getObjectViewAsync: ioBroker.Adapter["getObjectViewAsync"];
+    getStateIDs(pattern?: string): Promise<string[]>;
+    getObjectIDs(pattern?: string): Promise<string[]>;
 }