@iobroker/testing 4.1.3 → 5.0.2

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

@@ -1,29 +1,34 @@
 /**
  * Locates the directory where JS-Controller is installed for integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 export declare function getTestControllerDir(appName: string, testDir: string): string;
 /**
  * Locates the directory where JS-Controller stores its data for integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 export declare function getTestDataDir(appName: string, testDir: string): string;
 /**
  * Locates the directory where JS-Controller stores its logs for integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 export declare function getTestLogDir(appName: string, testDir: string): string;
 /**
  * Locates the directory where JS-Controller stores its sqlite db during integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 export declare function getTestDBDir(appName: string, testDir: string): string;
 /**
- * Locates the directory where the adapter will be be stored for integration tests
+ * Locates the directory where the adapter will be stored for integration tests
+ *
  * @param adapterDir The root directory of the adapter
  * @param testDir The directory the integration tests are executed in
  */

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

@@ -15,60 +15,74 @@ 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.getTestAdapterDir = exports.getTestDBDir = exports.getTestLogDir = exports.getTestDataDir = exports.getTestControllerDir = void 0;
+exports.getTestControllerDir = getTestControllerDir;
+exports.getTestDataDir = getTestDataDir;
+exports.getTestLogDir = getTestLogDir;
+exports.getTestDBDir = getTestDBDir;
+exports.getTestAdapterDir = getTestAdapterDir;
 const path = __importStar(require("path"));
 const adapterTools_1 = require("../../../lib/adapterTools");
 /**
  * Locates the directory where JS-Controller is installed for integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 function getTestControllerDir(appName, testDir) {
-    return path.resolve(testDir, "node_modules", `${appName}.js-controller`);
+    return path.resolve(testDir, 'node_modules', `${appName}.js-controller`);
 }
-exports.getTestControllerDir = getTestControllerDir;
 /**
  * Locates the directory where JS-Controller stores its data for integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 function getTestDataDir(appName, testDir) {
     return path.resolve(testDir, `${appName}-data`);
 }
-exports.getTestDataDir = getTestDataDir;
 /**
  * Locates the directory where JS-Controller stores its logs for integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 function getTestLogDir(appName, testDir) {
-    return path.resolve(testDir, "log");
+    return path.resolve(testDir, 'log');
 }
-exports.getTestLogDir = getTestLogDir;
 /**
  * Locates the directory where JS-Controller stores its sqlite db during integration tests
+ *
  * @param appName The branded name of "iobroker"
  * @param testDir The directory the integration tests are executed in
  */
 function getTestDBDir(appName, testDir) {
-    return path.resolve(getTestDataDir(appName, testDir), "sqlite");
+    return path.resolve(getTestDataDir(appName, testDir), 'sqlite');
 }
-exports.getTestDBDir = getTestDBDir;
 /**
- * Locates the directory where the adapter will be be stored for integration tests
+ * Locates the directory where the adapter will be stored for integration tests
+ *
  * @param adapterDir The root directory of the adapter
  * @param testDir The directory the integration tests are executed in
  */
 function getTestAdapterDir(adapterDir, testDir) {
     const adapterName = (0, adapterTools_1.getAdapterFullName)(adapterDir);
-    return path.resolve(testDir, "node_modules", adapterName);
+    return path.resolve(testDir, 'node_modules', adapterName);
 }
-exports.getTestAdapterDir = getTestAdapterDir;

package/build/tests/packageFiles/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.validatePackageFiles = void 0;
-/* eslint-disable @typescript-eslint/no-var-requires */
+exports.validatePackageFiles = validatePackageFiles;
 const typeguards_1 = require("alcalzone-shared/typeguards");
 const chai_1 = require("chai");
 const fs = __importStar(require("fs"));
@@ -34,27 +43,27 @@ const path = __importStar(require("path"));
  * This is meant to be executed in a mocha context.
  */
 function validatePackageFiles(adapterDir) {
-    const packageJsonPath = path.join(adapterDir, "package.json");
-    const ioPackageJsonPath = path.join(adapterDir, "io-package.json");
+    const packageJsonPath = path.join(adapterDir, 'package.json');
+    const ioPackageJsonPath = path.join(adapterDir, 'io-package.json');
     // This allows us to skip tests that require valid JSON files
     const invalidFiles = {
-        "package.json": false,
-        "io-package.json": false,
+        'package.json': false,
+        'io-package.json': false,
     };
     function skipIfInvalid(...filenames) {
-        if (filenames.some((f) => invalidFiles[f]))
+        if (filenames.some(f => invalidFiles[f])) {
             return this.skip();
+        }
     }
     function markAsInvalid(filename) {
-        if (this.currentTest.state === "failed" &&
-            invalidFiles[filename] === false) {
+        if (this.currentTest.state === 'failed' && invalidFiles[filename] === false) {
             invalidFiles[filename] = true;
             console.error(`Skipping subsequent tests including "${filename}" because they require valid JSON files!`);
         }
     }
     /** Ensures that a given property exists on the target object */
     function ensurePropertyExists(propertyPath, targetObj) {
-        const propertyParts = propertyPath.split(".");
+        const propertyParts = propertyPath.split('.');
         it(`The property "${propertyPath}" exists`, () => {
             let prev = targetObj;
             for (const part of propertyParts) {
@@ -65,7 +74,7 @@ function validatePackageFiles(adapterDir) {
     }
     describe(`Validate the package files`, () => {
         describe(`Ensure they are readable`, () => {
-            for (const filename of ["package.json", "io-package.json"]) {
+            for (const filename of ['package.json', 'io-package.json']) {
                 const packagePath = path.join(adapterDir, filename);
                 describe(`${filename}`, () => {
                     afterEach(function () {
@@ -74,41 +83,41 @@ function validatePackageFiles(adapterDir) {
                     beforeEach(function () {
                         skipIfInvalid.call(this, filename);
                     });
-                    it("exists", () => {
+                    it('exists', () => {
                         (0, chai_1.expect)(fs.existsSync(packagePath), `${filename} is missing in the adapter dir. Please create it!`).to.be.true;
                     });
-                    it("contains valid JSON", () => {
+                    it('contains valid JSON', () => {
                         (0, chai_1.expect)(() => {
-                            JSON.parse(fs.readFileSync(packagePath, "utf8"));
+                            JSON.parse(fs.readFileSync(packagePath, 'utf8'));
                         }, `${filename} contains invalid JSON!`).not.to.throw();
                     });
-                    it("is an object", () => {
-                        (0, chai_1.expect)(require(packagePath), `${filename} must contain an object!`).to.be.an("object");
+                    it('is an object', () => {
+                        (0, chai_1.expect)(require(packagePath), `${filename} must contain an object!`).to.be.an('object');
                     });
                 });
             }
         });
         describe(`Check contents of package.json`, () => {
             beforeEach(function () {
-                skipIfInvalid.call(this, "package.json");
+                skipIfInvalid.call(this, 'package.json');
             });
             const packageContent = require(packageJsonPath);
             const iopackContent = require(ioPackageJsonPath);
             const requiredProperties = [
-                "name",
-                "version",
-                "description",
-                "author",
-                "license",
-                "repository",
-                "repository.type",
+                'name',
+                'version',
+                'description',
+                'author',
+                'license',
+                'repository',
+                'repository.type',
             ];
-            requiredProperties.forEach((prop) => ensurePropertyExists(prop, packageContent));
-            it("The package name is correct", () => {
+            requiredProperties.forEach(prop => ensurePropertyExists(prop, packageContent));
+            it('The package name is correct', () => {
                 let name = packageContent.name;
                 (0, chai_1.expect)(name).to.match(/^iobroker\./, `The npm package name must start with lowercase "iobroker."!`);
-                name = name.replace(/^iobroker\./, "");
-                (0, chai_1.expect)(name).to.match(/[a-z0-9_\-]+/, `The adapter name must only contain lowercase letters, numbers, "-" and "_"!`);
+                name = name.replace(/^iobroker\./, '');
+                (0, chai_1.expect)(name).to.match(/[-a-z0-9_]+/, `The adapter name must only contain lowercase letters, numbers, "-" and "_"!`);
                 (0, chai_1.expect)(name).to.match(/^[a-z]/, `The adapter name must start with a letter!`);
                 (0, chai_1.expect)(name).to.match(/[a-z0-9]$/, `The adapter name must end with a letter or number!`);
             });
@@ -118,17 +127,17 @@ function validatePackageFiles(adapterDir) {
                 });
             }
             it(`The repository type is "git"`, () => {
-                (0, chai_1.expect)(packageContent.repository.type).to.equal("git");
+                (0, chai_1.expect)(packageContent.repository.type).to.equal('git');
             });
-            it("npm is not listed as a dependency", () => {
+            it('npm is not listed as a dependency', () => {
                 for (const depType of [
-                    "dependencies",
-                    "devDependencies",
-                    "optionalDependencies",
-                    "peerDependencies",
+                    'dependencies',
+                    'devDependencies',
+                    'optionalDependencies',
+                    'peerDependencies',
                 ]) {
-                    if ((0, typeguards_1.isObject)(packageContent[depType]) &&
-                        "npm" in packageContent[depType]) {
+                    if ((0, typeguards_1.isObject)(packageContent[depType]) && 'npm' in packageContent[depType]) {
+                        // eslint-disable-next-line @typescript-eslint/only-throw-error
                         throw new chai_1.AssertionError(`npm must not be listed in ${depType}, found "${packageContent[depType].npm}"!`);
                     }
                 }
@@ -136,29 +145,30 @@ function validatePackageFiles(adapterDir) {
         });
         describe(`Check contents of io-package.json`, () => {
             beforeEach(function () {
-                skipIfInvalid.call(this, "io-package.json");
+                skipIfInvalid.call(this, 'io-package.json');
             });
             const iopackContent = require(ioPackageJsonPath);
             const requiredProperties = [
-                "common.name",
-                "common.titleLang",
-                "common.version",
-                "common.news",
-                "common.desc",
-                "common.icon",
-                "common.extIcon",
-                "common.type",
-                "common.authors",
-                "native",
+                'common.name',
+                'common.titleLang',
+                'common.version',
+                'common.news',
+                'common.desc',
+                'common.icon',
+                'common.extIcon',
+                'common.type',
+                'common.authors',
+                'native',
             ];
-            requiredProperties.forEach((prop) => ensurePropertyExists(prop, iopackContent));
+            requiredProperties.forEach(prop => ensurePropertyExists(prop, iopackContent));
             it(`The title does not contain "adapter" or "iobroker"`, () => {
-                if (!iopackContent.title)
+                if (!iopackContent.title) {
                     return;
+                }
                 (0, chai_1.expect)(iopackContent.common.title).not.to.match(/iobroker|adapter/i);
             });
             it(`titleLang is an object to support multiple languages`, () => {
-                (0, chai_1.expect)(iopackContent.common.titleLang).to.be.an("object");
+                (0, chai_1.expect)(iopackContent.common.titleLang).to.be.an('object');
             });
             it(`titleLang does not contain "adapter" or "iobroker"`, () => {
                 for (const title of Object.values(iopackContent.common.titleLang)) {
@@ -166,7 +176,7 @@ function validatePackageFiles(adapterDir) {
                 }
             });
             it(`The description is an object to support multiple languages`, () => {
-                (0, chai_1.expect)(iopackContent.common.desc).to.be.an("object");
+                (0, chai_1.expect)(iopackContent.common.desc).to.be.an('object');
             });
             it(`common.authors is an array that is not empty`, () => {
                 const authors = iopackContent.common.authors;
@@ -180,19 +190,25 @@ function validatePackageFiles(adapterDir) {
             });
             if (iopackContent.common.licenseInformation) {
                 it(`if common.licenseInformation exists, it is an object with required properties`, () => {
-                    (0, chai_1.expect)(iopackContent.common.licenseInformation).to.be.an("object");
-                    (0, chai_1.expect)(iopackContent.common.licenseInformation.type).to.be.oneOf(["free", "commercial", "paid", "limited"]);
-                    if (iopackContent.common.licenseInformation.type !== "free") {
-                        (0, chai_1.expect)(iopackContent.common.licenseInformation.link, "License link is missing").to.not.be.undefined;
+                    (0, chai_1.expect)(iopackContent.common.licenseInformation).to.be.an('object');
+                    (0, chai_1.expect)(iopackContent.common.licenseInformation.type).to.be.oneOf([
+                        'free',
+                        'commercial',
+                        'paid',
+                        'limited',
+                    ]);
+                    if (iopackContent.common.licenseInformation.type !== 'free') {
+                        (0, chai_1.expect)(iopackContent.common.licenseInformation.link, 'License link is missing').to.not.be
+                            .undefined;
                     }
                 });
                 it(`common.license should not exist together with common.licenseInformation`, () => {
-                    (0, chai_1.expect)(iopackContent.common.license, "common.license must be removed").to.be.undefined;
+                    (0, chai_1.expect)(iopackContent.common.license, 'common.license must be removed').to.be.undefined;
                 });
             }
             else {
                 it(`common.license must exist without common.licenseInformation`, () => {
-                    (0, chai_1.expect)(iopackContent.common.license, "common.licenseInformation (preferred) or common.license (deprecated) must exist").to.not.be.undefined;
+                    (0, chai_1.expect)(iopackContent.common.license, 'common.licenseInformation (preferred) or common.license (deprecated) must exist').to.not.be.undefined;
                 });
             }
             if (iopackContent.common.tier != undefined) {
@@ -203,31 +219,32 @@ function validatePackageFiles(adapterDir) {
             }
             // If the adapter has a configuration page, check that a supported admin UI is used
             const hasNoConfigPage = iopackContent.common.noConfig === true ||
-                iopackContent.common.noConfig === "true" ||
-                iopackContent.common.adminUI?.config === "none";
+                iopackContent.common.noConfig === 'true' ||
+                iopackContent.common.adminUI?.config === 'none';
             if (!hasNoConfigPage) {
-                it("The adapter uses a supported admin UI", () => {
+                it('The adapter uses a supported admin UI', () => {
                     const hasSupportedUI = !!iopackContent.common.materialize ||
-                        iopackContent.common.adminUI?.config === "html" ||
-                        iopackContent.common.adminUI?.config === "json" ||
-                        iopackContent.common.adminUI?.config === "materialize";
-                    (0, chai_1.expect)(hasSupportedUI, "Unsupported Admin UI, must be html, materialize or JSON config!").to.be.true;
+                        iopackContent.common.adminUI?.config === 'html' ||
+                        iopackContent.common.adminUI?.config === 'json' ||
+                        iopackContent.common.adminUI?.config === 'materialize';
+                    (0, chai_1.expect)(hasSupportedUI, 'Unsupported Admin UI, must be html, materialize or JSON config!').to.be
+                        .true;
                 });
             }
         });
         describe(`Compare contents of package.json and io-package.json`, () => {
             beforeEach(function () {
-                skipIfInvalid.call(this, "package.json", "io-package.json");
+                skipIfInvalid.call(this, 'package.json', 'io-package.json');
             });
             const packageContent = require(packageJsonPath);
             const iopackContent = require(ioPackageJsonPath);
-            it("The name matches", () => {
-                (0, chai_1.expect)("iobroker." + iopackContent.common.name).to.equal(packageContent.name);
+            it('The name matches', () => {
+                (0, chai_1.expect)(`iobroker.${iopackContent.common.name}`).to.equal(packageContent.name);
             });
-            it("The version matches", () => {
+            it('The version matches', () => {
                 (0, chai_1.expect)(iopackContent.common.version).to.equal(packageContent.version);
             });
-            it("The license matches", () => {
+            it('The license matches', () => {
                 if (iopackContent.common.licenseInformation) {
                     (0, chai_1.expect)(iopackContent.common.licenseInformation.license).to.equal(packageContent.license);
                 }
@@ -255,4 +272,3 @@ function validatePackageFiles(adapterDir) {
     // 	});
     // });
 }
-exports.validatePackageFiles = validatePackageFiles;

package/build/tests/unit/harness/createMocks.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="iobroker" />
-import { MockDatabase } from "../mocks/mockDatabase";
+import { type MockAdapter } from '../mocks/mockAdapter';
+import { MockDatabase } from '../mocks/mockDatabase';
 /**
  * Creates a new set of mocks, including a mock database and a mock adapter.
  * To test the startup of an adapter, use `startMockAdapter` instead.
  */
 export declare function createMocks(adapterOptions: Partial<ioBroker.AdapterOptions>): {
     database: MockDatabase;
-    adapter: import("../mocks/mockAdapter").MockAdapter;
+    adapter: MockAdapter;
 };

package/build/tests/unit/harness/createMocks.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMocks = void 0;
+exports.createMocks = createMocks;
 const mockAdapter_1 = require("../mocks/mockAdapter");
 const mockDatabase_1 = require("../mocks/mockDatabase");
 /**
  * Creates a new set of mocks, including a mock database and a mock adapter.
  * To test the startup of an adapter, use `startMockAdapter` instead.
  */
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function createMocks(adapterOptions) {
     const databaseMock = new mockDatabase_1.MockDatabase();
     const adapterMock = mockAdapter_1.createAdapterMock.bind(undefined)(databaseMock, adapterOptions);
@@ -16,4 +15,3 @@ function createMocks(adapterOptions) {
         adapter: adapterMock,
     };
 }
-exports.createMocks = createMocks;

package/build/tests/unit/index.js

@@ -1,24 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testAdapterWithMocks = void 0;
+exports.testAdapterWithMocks = testAdapterWithMocks;
 /**
  * @deprecated
  * Tests the adapter startup in offline mode (with mocks, no JS-Controller)
  * This is meant to be executed in a mocha context.
  */
 function testAdapterWithMocks(_adapterDir, options = {}) {
-    describe(`Unit tests`, async () => {
+    describe(`Unit tests`, () => {
         // Call the user's tests
-        if (typeof options.defineAdditionalTests === "function") {
+        if (typeof options.defineAdditionalTests === 'function') {
             options.defineAdditionalTests();
         }
         else {
-            it("DEPRECATED!", () => {
-                console.warn("\u001b[33mUnit tests for adapter startup are deprecated!");
+            it('DEPRECATED!', () => {
+                console.warn('\u001b[33mUnit tests for adapter startup are deprecated!');
                 console.warn(`If you do not define your own tests, you can remove the "test:unit" script`);
                 console.warn(`from package.json and from your Travis/Github Actions workflow.\u001b[0m`);
             });
         }
+        return Promise.resolve();
     });
 }
-exports.testAdapterWithMocks = testAdapterWithMocks;

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

@@ -1,7 +1,6 @@
-/// <reference types="iobroker" />
-import type { MockDatabase } from "./mockDatabase";
-import { MockLogger } from "./mockLogger";
-import { Mock } from "./tools";
+import type { MockDatabase } from './mockDatabase';
+import { type MockLogger } from './mockLogger';
+import { type Mock } from './tools';
 export type MockAdapter = Mock<ioBroker.Adapter> & {
     readyHandler: ioBroker.ReadyHandler | undefined;
     objectChangeHandler: ioBroker.ObjectChangeHandler | undefined;