@iobroker/testing 2.5.4 → 2.5.5

package/CHANGELOG.md

@@ -4,6 +4,11 @@
 	PLACEHOLDER for next version:
 	## __WORK IN PROGRESS__
 -->
+## 2.5.5 (2022-03-04)
+* Allow immediate exit with code `0` for schedule adapters
+* Check that `npm` is not listed as a local dependency in `package.json`
+* Updated dependencies
+
 ## 2.5.4 (2022-02-02)
 * Modifying ioBroker databases now uses the same methods that JS-Controller uses internally. This ensures that the testing is compatible with the `jsonl` database format.
 * Testing adapters with adapter dependencies that try to access the databases during installation now works.

package/build/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/build/lib/adapterTools.d.ts

@@ -9,16 +9,7 @@ export declare function loadNpmPackage(adapterDir: string): Record<string, any>;
  * @param adapterDir The directory the adapter resides in
  */
 export declare function loadIoPackage(adapterDir: string): Record<string, any>;
-/**
- * Checks if an adapter claims that it supports compact mode
- * @param ioPackage The contents of io-package.json in object format
- */
-export declare function adapterShouldSupportCompactMode(ioPackage: Record<string, any>): boolean;
-/**
- * Checks if an adapter claims that it supports compact mode
- * @param adapterDir The directory the adapter resides in
- */
-export declare function adapterShouldSupportCompactMode(adapterDir: string): boolean;
+export declare function getAdapterExecutionMode(adapterDir: string): ioBroker.AdapterCommon["mode"];
 /**
  * Locates an adapter's main file
  * @param adapterDir The directory the adapter resides in

package/build/lib/adapterTools.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -22,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAdapterDependencies = exports.getAdapterFullName = exports.getAdapterName = exports.getAppName = exports.loadInstanceObjects = exports.loadAdapterCommon = exports.loadAdapterConfig = exports.locateAdapterMainFile = exports.adapterShouldSupportCompactMode = exports.loadIoPackage = exports.loadNpmPackage = void 0;
+exports.getAdapterDependencies = exports.getAdapterFullName = exports.getAdapterName = exports.getAppName = exports.loadInstanceObjects = exports.loadAdapterCommon = exports.loadAdapterConfig = exports.locateAdapterMainFile = exports.getAdapterExecutionMode = exports.loadIoPackage = exports.loadNpmPackage = void 0;
 // Add debug logging for tests
 const typeguards_1 = require("alcalzone-shared/typeguards");
 const debug_1 = __importDefault(require("debug"));
@@ -45,12 +49,11 @@ function loadIoPackage(adapterDir) {
     return require(path.join(adapterDir, "io-package.json"));
 }
 exports.loadIoPackage = loadIoPackage;
-function adapterShouldSupportCompactMode(dirOrIoPack) {
-    if (typeof dirOrIoPack === "string")
-        dirOrIoPack = loadIoPackage(dirOrIoPack);
-    return dirOrIoPack.common.compact === true;
+function getAdapterExecutionMode(adapterDir) {
+    const ioPackage = loadIoPackage(adapterDir);
+    return ioPackage.common.mode;
 }
-exports.adapterShouldSupportCompactMode = adapterShouldSupportCompactMode;
+exports.getAdapterExecutionMode = getAdapterExecutionMode;
 /**
  * Locates an adapter's main file
  * @param adapterDir The directory the adapter resides in

package/build/tests/integration/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -98,7 +102,13 @@ function testAdapter(adapterDir, options = {}) {
             harness.removeAllListeners();
         });
         it("The adapter starts", function () {
+            var _a;
             this.timeout(60000);
+            const allowedExitCodes = new Set((_a = options.allowedExitCodes) !== null && _a !== void 0 ? _a : []);
+            // Schedule adapters are allowed to "immediately" exit with code 0
+            if (harness.getAdapterExecutionMode() === "schedule") {
+                allowedExitCodes.add(0);
+            }
             return new Promise((resolve, reject) => {
                 // Register a handler to check the alive state and exit codes
                 harness
@@ -114,8 +124,7 @@ function testAdapter(adapterDir, options = {}) {
                     }
                 })
                     .on("failed", (code) => {
-                    if (options.allowedExitCodes == undefined ||
-                        options.allowedExitCodes.indexOf(code) === -1) {
+                    if (!allowedExitCodes.has(code)) {
                         reject(new Error(`The adapter startup was interrupted unexpectedly with ${typeof code === "number"
                             ? "code"
                             : "signal"} ${code}`));

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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -136,7 +140,6 @@ class DBConnection extends events_1.default {
         if (wasRunning)
             await this.start();
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     setSystemConfig(systemConfig) {
         const systemFilename = path.join(this.testDataDir, `${this.appName}.json`);
         (0, fs_extra_1.writeJSONSync)(systemFilename, systemConfig, { spaces: 2 });
@@ -276,9 +279,7 @@ class DBConnection extends events_1.default {
         }
         return this._statesClient.subscribeMessage(id);
     }
-    pushMessage(instanceId, 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    msg, callback) {
+    pushMessage(instanceId, msg, callback) {
         if (!this._statesClient) {
             throw new Error("States DB is not running");
         }

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

@@ -61,6 +61,7 @@ export declare class TestHarness extends EventEmitter {
      * Updates the adapter config. The changes can be a subset of the target object
      */
     changeAdapterConfig(adapterName: string, changes: Record<string, any>): Promise<void>;
+    getAdapterExecutionMode(): ioBroker.AdapterCommon["mode"];
     /** Enables the sendTo method */
     enableSendTo(): Promise<void>;
     private sendToID;

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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -222,6 +226,9 @@ class TestHarness extends events_1.EventEmitter {
             await this.dbConnection.setObject(adapterInstanceId, obj);
         }
     }
+    getAdapterExecutionMode() {
+        return (0, adapterTools_1.getAdapterExecutionMode)(this.testAdapterDir);
+    }
     /** Enables the sendTo method */
     async enableSendTo() {
         await this.dbConnection.setObject(fromAdapterID, {
@@ -232,9 +239,7 @@ class TestHarness extends events_1.EventEmitter {
         this.dbConnection.subscribeMessage(fromAdapterID);
     }
     /** Sends a message to an adapter instance */
-    sendTo(target, command, 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    message, callback) {
+    sendTo(target, command, message, callback) {
         const stateChangedHandler = (id, state) => {
             if (id === `messagebox.${fromAdapterID}`) {
                 callback(state.message);

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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/build/tests/packageFiles/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -111,6 +115,19 @@ function validatePackageFiles(adapterDir) {
             it(`The repository type is "git"`, () => {
                 (0, chai_1.expect)(packageContent.repository.type).to.equal("git");
             });
+            it("npm is not listed as a dependency", () => {
+                for (const depType of [
+                    "dependencies",
+                    "devDependencies",
+                    "optionalDependencies",
+                    "peerDependencies",
+                ]) {
+                    if ((0, typeguards_1.isObject)(packageContent[depType]) &&
+                        "npm" in packageContent[depType]) {
+                        throw new chai_1.AssertionError(`npm must not be listed in ${depType}, found "${packageContent[depType].npm}"!`);
+                    }
+                }
+            });
         });
         describe(`Check contents of io-package.json`, () => {
             var _a;

package/build/tests/unit/mocks/mockAdapterCore.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/testing",
-  "version": "2.5.4",
+  "version": "2.5.5",
   "description": "Shared utilities for adapter and module testing in ioBroker",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -38,38 +38,38 @@
   },
   "homepage": "https://github.com/AlCalzone/testing#readme",
   "devDependencies": {
-    "@alcalzone/release-script": "^3.5.0",
-    "@alcalzone/release-script-plugin-license": "^3.5.0",
-    "@iobroker/adapter-core": "^2.5.1",
+    "@alcalzone/release-script": "^3.5.4",
+    "@alcalzone/release-script-plugin-license": "^3.5.3",
+    "@iobroker/adapter-core": "^2.6.0",
     "@tsconfig/node12": "^1.0.9",
     "@types/chai": "^4.3.0",
-    "@types/chai-as-promised": "^7.1.4",
+    "@types/chai-as-promised": "^7.1.5",
     "@types/debug": "4.1.7",
     "@types/fs-extra": "^9.0.13",
-    "@types/iobroker": "^3.3.4",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^16.10.2",
-    "@types/sinon": "^10.0.6",
+    "@types/iobroker": "^4.0.1",
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^16.11.26",
+    "@types/sinon": "^10.0.11",
     "@types/sinon-chai": "^3.2.8",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
+    "eslint": "^8.10.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
     "prettier": "^2.5.1",
     "rimraf": "^3.0.2",
     "source-map-support": "^0.5.21",
-    "ts-node": "^10.2.1",
-    "typescript": "~4.5.5"
+    "ts-node": "^10.6.0",
+    "typescript": "~4.6.2"
   },
   "dependencies": {
     "alcalzone-shared": "~4.0.1",
-    "chai": "^4.3.4",
+    "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "debug": "^4.3.3",
-    "fs-extra": "^10.0.0",
-    "mocha": "^9.1.3",
-    "sinon": "^12.0.1",
+    "fs-extra": "^10.0.1",
+    "mocha": "^9.2.1",
+    "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0"
   }
 }