@iobroker/testing 4.1.3 → 5.0.2

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

@@ -15,25 +15,34 @@ 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.mockAdapterCore = void 0;
+exports.mockAdapterCore = mockAdapterCore;
 const os = __importStar(require("os"));
 const path = __importStar(require("path"));
 const mockAdapter_1 = require("./mockAdapter");
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function mockAdapterCore(database, options = {}) {
     /**
      * The root directory of JS-Controller
      * If this has to exist in the test, the user/tester has to take care of it!
      */
-    const controllerDir = path.join(options.adapterDir || "", "..", "iobroker.js-controller");
+    const controllerDir = path.join(options.adapterDir || '', '..', 'iobroker.js-controller');
     const dataDir = path.join(os.tmpdir(), `test-iobroker-data`);
     /**
      * The test location for iobroker-data
@@ -55,14 +64,14 @@ function mockAdapterCore(database, options = {}) {
     }
     const AdapterConstructor = function (nameOrOptions) {
         // This needs to be a class with the correct `this` context or the ES6 tests won't work
-        if (!(this instanceof AdapterConstructor))
+        if (!(this instanceof AdapterConstructor)) {
             return new AdapterConstructor(nameOrOptions);
-        const createAdapterMockOptions = typeof nameOrOptions === "string"
-            ? { name: nameOrOptions }
-            : nameOrOptions;
+        }
+        const createAdapterMockOptions = typeof nameOrOptions === 'string' ? { name: nameOrOptions } : nameOrOptions;
         mockAdapter_1.createAdapterMock.bind(this)(database, createAdapterMockOptions);
-        if (typeof options.onAdapterCreated === "function")
+        if (typeof options.onAdapterCreated === 'function') {
             options.onAdapterCreated(this);
+        }
         return this;
     };
     return {
@@ -74,4 +83,3 @@ function mockAdapterCore(database, options = {}) {
         getAbsoluteInstanceDataDir,
     };
 }
-exports.mockAdapterCore = mockAdapterCore;

package/build/tests/unit/mocks/mockDatabase.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="iobroker" />
-/// <reference types="iobroker" />
-import type { MockAdapter } from "./mockAdapter";
+import type { MockAdapter } from './mockAdapter';
 /**
  * A minimalistic version of ioBroker's Objects and States DB that just operates on a Map
  */
@@ -35,19 +33,20 @@ export declare class MockDatabase {
 /**
  * Returns a collection of predefined assertions to be used in unit tests
  * Those include assertions for:
- * * State exists
- * * State has a certain value, ack flag, object property
- * * Object exists
- * * Object has a certain common or native part
+ * - State exists
+ * - State has a certain value, ack flag, object property
+ * - Object exists
+ * - Object has a certain common or native part
+ *
  * @param db The mock database to operate on
  * @param adapter The mock adapter to operate on
  */
 export declare function createAsserts(db: MockDatabase, adapter: MockAdapter): {
-    assertObjectExists(id: string | string[]): void;
-    assertStateExists(id: string | string[]): void;
-    assertStateHasValue(id: string | string[], value: any): void;
-    assertStateIsAcked(id: string | string[], ack?: boolean): void;
-    assertStateProperty(id: string | string[], property: string, value: any): void;
-    assertObjectCommon(id: string | string[], common: ioBroker.ObjectCommon): void;
-    assertObjectNative(id: string | string[], native: Record<string, any>): void;
+    assertObjectExists: (id: string | string[]) => void;
+    assertStateExists: (id: string | string[]) => void;
+    assertStateHasValue: (id: string | string[], value: any) => void;
+    assertStateIsAcked: (id: string | string[], ack: boolean) => void;
+    assertStateProperty: (id: string | string[], property: string, value: any) => void;
+    assertObjectCommon: (id: string | string[], common: ioBroker.ObjectCommon) => void;
+    assertObjectNative: (id: string | string[], native: Record<string, any>) => void;
 };

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

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAsserts = exports.MockDatabase = void 0;
+exports.MockDatabase = void 0;
+exports.createAsserts = createAsserts;
+// @ts-expect-error no types
 const objects_1 = require("alcalzone-shared/objects");
-const typeguards_1 = require("alcalzone-shared/typeguards");
 const str2regex_1 = require("../../../lib/str2regex");
 const objectTemplate = Object.freeze({
-    type: "state",
-    common: { name: "an object" },
+    type: 'state',
+    common: { name: 'an object' },
     native: {},
 });
 const stateTemplate = Object.freeze({
@@ -32,10 +33,12 @@ class MockDatabase {
         this.clearStates();
     }
     publishObject(obj) {
-        if (obj._id == null)
-            throw new Error("An object must have an ID");
-        if (obj.type == null)
-            throw new Error("An object must have a type");
+        if (obj._id == null) {
+            throw new Error('An object must have an ID');
+        }
+        if (obj.type == null) {
+            throw new Error('An object must have a type');
+        }
         const completeObject = (0, objects_1.extend)({}, objectTemplate, obj);
         this.objects.set(obj._id, completeObject);
     }
@@ -43,22 +46,16 @@ class MockDatabase {
         objects.forEach(this.publishObject.bind(this));
     }
     publishStateObjects(...objects) {
-        objects
-            .map((obj) => (0, objects_1.extend)({}, obj, { type: "state" }))
-            .forEach(this.publishObject.bind(this));
+        objects.map(obj => (0, objects_1.extend)({}, obj, { type: 'state' })).forEach(this.publishObject.bind(this));
     }
     publishChannelObjects(...objects) {
-        objects
-            .map((obj) => (0, objects_1.extend)({}, obj, { type: "channel" }))
-            .forEach(this.publishObject.bind(this));
+        objects.map(obj => (0, objects_1.extend)({}, obj, { type: 'channel' })).forEach(this.publishObject.bind(this));
     }
     publishDeviceObjects(...objects) {
-        objects
-            .map((obj) => (0, objects_1.extend)({}, obj, { type: "device" }))
-            .forEach(this.publishObject.bind(this));
+        objects.map(obj => (0, objects_1.extend)({}, obj, { type: 'device' })).forEach(this.publishObject.bind(this));
     }
     deleteObject(objOrID) {
-        this.objects.delete(typeof objOrID === "string" ? objOrID : objOrID._id);
+        this.objects.delete(typeof objOrID === 'string' ? objOrID : objOrID._id);
     }
     publishState(id, state) {
         // if (typeof id !== "string") throw new Error("The id must be given!");
@@ -78,37 +75,38 @@ class MockDatabase {
         }
     }
     hasObject(namespaceOrId, id) {
-        id = namespaceOrId + (id ? "." + id : "");
+        id = namespaceOrId + (id ? `.${id}` : '');
         return this.objects.has(id);
     }
     getObject(namespaceOrId, id) {
         // combines getObject and getForeignObject into one
-        id = namespaceOrId + (id ? "." + id : "");
+        id = namespaceOrId + (id ? `.${id}` : '');
         return this.objects.get(id);
     }
     hasState(namespaceOrId, id) {
-        id = namespaceOrId + (id ? "." + id : "");
+        id = namespaceOrId + (id ? `.${id}` : '');
         return this.states.has(id);
     }
     getState(namespaceOrId, id) {
         // combines getObject and getForeignObject into one
-        id = namespaceOrId + (id ? "." + id : "");
+        id = namespaceOrId + (id ? `.${id}` : '');
         return this.states.get(id);
     }
-    getObjects(namespaceOrPattern, patternOrType, type) {
+    getObjects(namespaceOrPattern, 
+    // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+    patternOrType, type) {
         // combines getObjects and getForeignObjects into one
         let pattern;
         if (type != null) {
-            pattern =
-                namespaceOrPattern + (patternOrType ? "." + patternOrType : "");
+            pattern = namespaceOrPattern + (patternOrType ? `.${patternOrType}` : '');
         }
         else if (patternOrType != null) {
-            if (["state", "channel", "device"].indexOf(patternOrType) > -1) {
+            if (['state', 'channel', 'device'].indexOf(patternOrType) > -1) {
                 type = patternOrType;
                 pattern = namespaceOrPattern;
             }
             else {
-                pattern = namespaceOrPattern + "." + patternOrType;
+                pattern = `${namespaceOrPattern}.${patternOrType}`;
             }
         }
         else {
@@ -129,21 +127,22 @@ exports.MockDatabase = MockDatabase;
 /**
  * Returns a collection of predefined assertions to be used in unit tests
  * Those include assertions for:
- * * State exists
- * * State has a certain value, ack flag, object property
- * * Object exists
- * * Object has a certain common or native part
+ * - State exists
+ * - State has a certain value, ack flag, object property
+ * - Object exists
+ * - Object has a certain common or native part
+ *
  * @param db The mock database to operate on
  * @param adapter The mock adapter to operate on
  */
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function createAsserts(db, adapter) {
     function normalizeID(id) {
-        if ((0, typeguards_1.isArray)(id))
-            id = id.join(".");
+        if (Array.isArray(id)) {
+            id = id.join('.');
+        }
         // Test if this ID is fully qualified
         if (!/^[a-z0-9\-_]+\.\d+\./.test(id)) {
-            id = adapter.namespace + "." + id;
+            id = `${adapter.namespace}.${id}`;
         }
         return id;
     }
@@ -157,33 +156,30 @@ function createAsserts(db, adapter) {
             db.hasState(id).should.equal(true, `The state "${adapter.namespace}.${id}" does not exist but it was expected to!`);
         },
         assertStateHasValue(id, value) {
-            ret.assertStateProperty(id, "val", value);
+            ret.assertStateProperty(id, 'val', value);
         },
         assertStateIsAcked(id, ack = true) {
-            ret.assertStateProperty(id, "ack", ack);
+            ret.assertStateProperty(id, 'ack', ack);
         },
         assertStateProperty(id, property, value) {
             id = normalizeID(id);
             ret.assertStateExists(id);
-            db.getState(id)
-                .should.be.an("object")
-                .that.has.property(property, value);
+            db.getState(id).should.be.an('object').that.has.property(property, value);
         },
         assertObjectCommon(id, common) {
             id = normalizeID(id);
             ret.assertObjectExists(id);
             const dbObj = db.getObject(id);
-            dbObj.should.be.an("object").that.has.property("common");
-            dbObj.common.should.be.an("object").that.nested.include(common);
+            dbObj.should.be.an('object').that.has.property('common');
+            dbObj.common.should.be.an('object').that.nested.include(common);
         },
         assertObjectNative(id, native) {
             id = normalizeID(id);
             ret.assertObjectExists(id);
             const dbObj = db.getObject(id);
-            dbObj.should.be.an("object").that.has.property("native");
-            dbObj.native.should.be.an("object").that.nested.include(native);
+            dbObj.should.be.an('object').that.has.property('native');
+            dbObj.native.should.be.an('object').that.nested.include(native);
         },
     };
     return ret;
 }
-exports.createAsserts = createAsserts;

package/build/tests/unit/mocks/mockLogger.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="iobroker" />
-import { Mock } from "./tools";
+import { type Mock } from './tools';
 export type MockLogger = Mock<ioBroker.Logger> & {
     resetMock(): void;
     resetMockHistory(): void;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLoggerMock = void 0;
+exports.createLoggerMock = createLoggerMock;
 const sinon_1 = require("sinon");
 const tools_1 = require("./tools");
 // Define here which methods were implemented manually, so we can hook them up with a real stub
@@ -16,7 +16,7 @@ function createLoggerMock() {
         error: (0, sinon_1.stub)(),
         debug: (0, sinon_1.stub)(),
         silly: (0, sinon_1.stub)(),
-        level: "info",
+        level: 'info',
         // Mock-specific methods
         resetMockHistory() {
             // reset Logger
@@ -34,4 +34,3 @@ function createLoggerMock() {
     (0, tools_1.stubAndPromisifyImplementedMethods)(ret, implementedMethods);
     return ret;
 }
-exports.createLoggerMock = createLoggerMock;

package/build/tests/unit/mocks/tools.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="sinon" />
-import type { Equals, Overwrite } from "alcalzone-shared/types";
+import type { Equals, Overwrite } from 'alcalzone-shared/types';
 export type IsAny<T> = Equals<T extends never ? false : true, boolean>;
 export type MockableMethods<T, All = Required<T>, NoAny = {
     [K in keyof All]: IsAny<All[K]> extends true ? never : All[K] extends (...args: any[]) => void ? K : never;
@@ -10,4 +9,4 @@ export type Mock<T extends {}> = Overwrite<T, {
 export declare function doResetHistory(parent: Record<string, any>): void;
 export declare function doResetBehavior(parent: Record<string, any>, implementedMethods: Record<string, any>): void;
 export declare function stubAndPromisifyImplementedMethods<T extends string>(parent: Record<T, any>, implementedMethods: Partial<Record<T, any>>, allowUserOverrides?: T[]): void;
-export type ImplementedMethodDictionary<T> = Partial<Record<MockableMethods<T>, "none" | "normal" | "no error">>;
+export type ImplementedMethodDictionary<T> = Partial<Record<MockableMethods<T>, 'none' | 'normal' | 'no error'>>;

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

@@ -1,57 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stubAndPromisifyImplementedMethods = exports.doResetBehavior = exports.doResetHistory = void 0;
+exports.doResetHistory = doResetHistory;
+exports.doResetBehavior = doResetBehavior;
+exports.stubAndPromisifyImplementedMethods = stubAndPromisifyImplementedMethods;
 const async_1 = require("alcalzone-shared/async");
 const sinon_1 = require("sinon");
 function doResetHistory(parent) {
     for (const prop of Object.keys(parent)) {
         const val = parent[prop];
-        if (val && typeof val.resetHistory === "function")
+        if (val && typeof val.resetHistory === 'function') {
             val.resetHistory();
+        }
     }
 }
-exports.doResetHistory = doResetHistory;
 function doResetBehavior(parent, implementedMethods) {
     for (const prop of Object.keys(parent)) {
-        if (prop in implementedMethods ||
-            (prop.endsWith("Async") && prop.slice(0, -5) in implementedMethods))
+        if (prop in implementedMethods || (prop.endsWith('Async') && prop.slice(0, -5) in implementedMethods)) {
             continue;
+        }
         const val = parent[prop];
-        if (val && typeof val.resetBehavior === "function")
+        if (val && typeof val.resetBehavior === 'function') {
             val.resetBehavior();
+        }
     }
 }
-exports.doResetBehavior = doResetBehavior;
 function dontOverwriteThis() {
-    throw new Error("You must not overwrite the behavior of this stub!");
+    throw new Error('You must not overwrite the behavior of this stub!');
 }
 function stubAndPromisifyImplementedMethods(parent, implementedMethods, allowUserOverrides = []) {
     // The methods implemented above are no stubs, but we claimed they are
     // Therefore hook them up with a real stub
     for (const methodName of Object.keys(implementedMethods)) {
-        if (methodName.endsWith("Async"))
+        if (methodName.endsWith('Async')) {
             continue;
+        }
         const originalMethod = parent[methodName];
         const callbackFake = (parent[methodName] = (0, sinon_1.stub)());
         callbackFake.callsFake(originalMethod);
         // Prevent the user from changing the stub's behavior
-        if (allowUserOverrides.indexOf(methodName) === -1) {
+        if (!allowUserOverrides.includes(methodName)) {
             callbackFake.returns = dontOverwriteThis;
             callbackFake.callsFake = dontOverwriteThis;
         }
         // Construct the async fake if there's any
         const asyncType = implementedMethods[methodName];
-        if (asyncType === "none")
+        if (asyncType === 'none') {
             continue;
-        const promisifyMethod = asyncType === "no error" ? async_1.promisifyNoError : async_1.promisify;
+        }
+        const promisifyMethod = asyncType === 'no error' ? async_1.promisifyNoError : async_1.promisify;
         const asyncFake = (0, sinon_1.stub)().callsFake(promisifyMethod(originalMethod, parent));
         parent[`${methodName}Async`] = asyncFake;
         // Prevent the user from changing the stub's behavior
-        if (allowUserOverrides.indexOf(methodName) === -1 ||
-            allowUserOverrides.indexOf((methodName + "Async")) === -1) {
+        if (!allowUserOverrides.includes(methodName) || !allowUserOverrides.includes(`${methodName}Async`)) {
             asyncFake.returns = dontOverwriteThis;
             asyncFake.callsFake = dontOverwriteThis;
         }
     }
 }
-exports.stubAndPromisifyImplementedMethods = stubAndPromisifyImplementedMethods;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/testing",
-  "version": "4.1.3",
+  "version": "5.0.2",
   "description": "Shared utilities for adapter and module testing in ioBroker",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -15,9 +15,10 @@
     "prewatch": "rimraf ./build",
     "watch": "tsc -p tsconfig.build.json --watch",
     "check": "npm run build -- --noEmit",
-    "lint:ts": "eslint --ext .ts src",
+    "lint:ts": "eslint -c eslint.config.mjs",
     "lint": "npm run lint:ts",
-    "release": "release-script"
+    "release": "release-script",
+    "update-packages": "npx -y npm-check-updates --upgrade"
   },
   "repository": {
     "type": "git",
@@ -38,38 +39,33 @@
   },
   "homepage": "https://github.com/AlCalzone/testing#readme",
   "devDependencies": {
-    "@alcalzone/release-script": "^3.7.0",
-    "@alcalzone/release-script-plugin-license": "^3.5.9",
-    "@iobroker/adapter-core": "^2.6.8",
-    "@tsconfig/node14": "^1.0.3",
-    "@types/chai": "^4.3.5",
-    "@types/chai-as-promised": "^7.1.5",
-    "@types/debug": "4.1.7",
-    "@types/fs-extra": "^9.0.13",
-    "@types/iobroker": "^4.0.5",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^18.16.3",
-    "@types/sinon": "^10.0.13",
-    "@types/sinon-chai": "^3.2.9",
-    "@typescript-eslint/eslint-plugin": "^5.54.0",
-    "@typescript-eslint/parser": "^5.59.8",
-    "eslint": "^8.44.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "prettier": "^2.8.8",
-    "rimraf": "^3.0.2",
+    "@alcalzone/release-script": "^3.8.0",
+    "@alcalzone/release-script-plugin-license": "^3.7.0",
+    "@iobroker/adapter-core": "^3.2.3",
+    "@iobroker/eslint-config": "^1.0.0",
+    "@iobroker/types": "^7.0.6",
+    "@tsconfig/node16": "^16.1.3",
+    "@types/chai": "^4.3.20",
+    "@types/chai-as-promised": "^8.0.1",
+    "@types/debug": "4.1.12",
+    "@types/fs-extra": "^11.0.4",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.10.7",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^3.2.12",
+    "rimraf": "^6.0.1",
     "source-map-support": "^0.5.21",
-    "ts-node": "^10.9.1",
-    "typescript": "~4.9.3"
+    "ts-node": "^10.9.2",
+    "typescript": "~5.7.3"
   },
   "dependencies": {
-    "alcalzone-shared": "~4.0.3",
-    "chai": "^4.3.7",
-    "chai-as-promised": "^7.1.1",
-    "debug": "^4.3.4",
-    "fs-extra": "^10.1.0",
-    "mocha": "^10.2.0",
-    "sinon": "^15.0.1",
+    "alcalzone-shared": "~5.0.0",
+    "chai": "^4.5.0",
+    "chai-as-promised": "^7.1.2",
+    "debug": "^4.4.0",
+    "fs-extra": "^11.3.0",
+    "mocha": "^11.0.1",
+    "sinon": "^19.0.2",
     "sinon-chai": "^3.7.0"
   }
 }