@iobroker/testing 4.0.0 → 4.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 AlCalzone <d.griesel@gmx.net>
+Copyright (c) 2024 AlCalzone <d.griesel@gmx.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -43,6 +43,10 @@ tests.integration(path.join(__dirname, ".."), {
 	// By default, termination during startup is not allowed.
 	allowedExitCodes: [11],
 
+	// To test against a different version of JS-Controller, you can change the version or dist-tag here.
+	// Make sure to remove this setting when you're done testing.
+	controllerVersion: "latest", // or a specific version like "4.0.1"
+
 	// Define your own tests inside defineAdditionalTests
 	defineAdditionalTests({ suite }) {
 		// All tests (it, describe) must be grouped in one or more suites. Each suite sets up a fresh environment for the adapter tests.

package/build/tests/integration/index.d.ts

@@ -7,6 +7,11 @@ export interface TestAdapterOptions {
     loglevel?: ioBroker.LogLevel;
     /** How long to wait before the adapter startup is considered successful */
     waitBeforeStartupSuccess?: number;
+    /**
+     * Which JS-Controller version or dist-tag should be used for the tests. Default: dev
+     * This should only be changed during active development.
+     */
+    controllerVersion?: string;
     /** Allows you to define additional tests */
     defineAdditionalTests?: (args: TestContext) => void;
 }

package/build/tests/integration/index.js

@@ -58,7 +58,7 @@ function testAdapter(adapterDir, options = {}) {
         // Installation happens in two steps:
         // First we need to set up JS Controller, so the databases etc. can be created
         // First we need to copy all files and execute an npm install
-        await controllerSetup.prepareTestDir();
+        await controllerSetup.prepareTestDir(options.controllerVersion);
         // Only then we can install the adapter, because some (including VIS) try to access
         // the databases if JS Controller is installed
         await adapterSetup.installAdapterInTestDir();

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

@@ -8,7 +8,7 @@ export declare class ControllerSetup {
     private testAdapterDir;
     private testControllerDir;
     private testDataDir;
-    prepareTestDir(): Promise<void>;
+    prepareTestDir(controllerVersion?: string): Promise<void>;
     /**
      * Tests if JS-Controller is already installed
      * @param appName The branded name of "iobroker"

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

@@ -53,8 +53,8 @@ class ControllerSetup {
         debug(`  appName:      ${this.appName}`);
         debug(`  adapterName:  ${this.adapterName}`);
     }
-    async prepareTestDir() {
-        debug("Preparing the test directory...");
+    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
@@ -69,7 +69,7 @@ class ControllerSetup {
             author: "",
             license: "ISC",
             dependencies: {
-                [`${this.appName}.js-controller`]: "dev",
+                [`${this.appName}.js-controller`]: controllerVersion,
             },
             description: "",
         };

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

@@ -3,8 +3,8 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import EventEmitter from "events";
-export declare type ObjectsDB = Record<string, ioBroker.Object>;
-export declare type StatesDB = Record<string, ioBroker.State>;
+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;

package/build/tests/packageFiles/index.js

@@ -93,13 +93,13 @@ function validatePackageFiles(adapterDir) {
                 skipIfInvalid.call(this, "package.json");
             });
             const packageContent = require(packageJsonPath);
+            const iopackContent = require(ioPackageJsonPath);
             const requiredProperties = [
                 "name",
                 "version",
                 "description",
                 "author",
                 "license",
-                "main",
                 "repository",
                 "repository.type",
             ];
@@ -112,6 +112,11 @@ function validatePackageFiles(adapterDir) {
                 (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!`);
             });
+            if (!iopackContent.common.onlyWWW) {
+                it(`property main is defined for non onlyWWW adapters`, () => {
+                    (0, chai_1.expect)(packageContent.main).to.not.be.undefined;
+                });
+            }
             it(`The repository type is "git"`, () => {
                 (0, chai_1.expect)(packageContent.repository.type).to.equal("git");
             });
@@ -142,7 +147,6 @@ function validatePackageFiles(adapterDir) {
                 "common.desc",
                 "common.icon",
                 "common.extIcon",
-                "common.license",
                 "common.type",
                 "common.authors",
                 "native",
@@ -174,6 +178,29 @@ function validatePackageFiles(adapterDir) {
                 (0, chai_1.expect)((0, typeguards_1.isObject)(news)).to.be.true;
                 (0, chai_1.expect)(Object.keys(news).length).to.be.at.most(20);
             });
+            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;
+                    }
+                });
+                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;
+                });
+            }
+            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;
+                });
+            }
+            if (iopackContent.common.tier != undefined) {
+                it(`common.tier must be 1, 2 or 3`, () => {
+                    (0, chai_1.expect)(iopackContent.common.tier).to.be.at.least(1);
+                    (0, chai_1.expect)(iopackContent.common.tier).to.be.at.most(3);
+                });
+            }
             // 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" ||
@@ -200,7 +227,12 @@ function validatePackageFiles(adapterDir) {
                 (0, chai_1.expect)(iopackContent.common.version).to.equal(packageContent.version);
             });
             it("The license matches", () => {
-                (0, chai_1.expect)(iopackContent.common.license).to.equal(packageContent.license);
+                if (iopackContent.common.licenseInformation) {
+                    (0, chai_1.expect)(iopackContent.common.licenseInformation.license).to.equal(packageContent.license);
+                }
+                else {
+                    (0, chai_1.expect)(iopackContent.common.license).to.equal(packageContent.license);
+                }
             });
         });
     });

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

@@ -2,7 +2,7 @@
 import type { MockDatabase } from "./mockDatabase";
 import { MockLogger } from "./mockLogger";
 import { Mock } from "./tools";
-export declare type MockAdapter = Mock<ioBroker.Adapter> & {
+export type MockAdapter = Mock<ioBroker.Adapter> & {
     readyHandler: ioBroker.ReadyHandler | undefined;
     objectChangeHandler: ioBroker.ObjectChangeHandler | undefined;
     stateChangeHandler: ioBroker.StateChangeHandler | undefined;

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

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

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

@@ -1,13 +1,13 @@
 /// <reference types="sinon" />
 import type { Equals, Overwrite } from "alcalzone-shared/types";
-export declare type IsAny<T> = Equals<T extends never ? false : true, boolean>;
-export declare type MockableMethods<T, All = Required<T>, NoAny = {
+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;
 }> = NoAny[keyof NoAny];
-export declare type Mock<T extends {}> = Overwrite<T, {
+export type Mock<T extends {}> = Overwrite<T, {
     [K in MockableMethods<T>]: sinon.SinonStub;
 }>;
 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 declare type ImplementedMethodDictionary<T> = Partial<Record<MockableMethods<T>, "none" | "normal" | "no error">>;
+export type ImplementedMethodDictionary<T> = Partial<Record<MockableMethods<T>, "none" | "normal" | "no error">>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/testing",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "Shared utilities for adapter and module testing in ioBroker",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -40,36 +40,36 @@
   "devDependencies": {
     "@alcalzone/release-script": "^3.5.9",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
-    "@iobroker/adapter-core": "^2.6.0",
+    "@iobroker/adapter-core": "^2.6.8",
     "@tsconfig/node14": "^1.0.3",
-    "@types/chai": "^4.3.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.4",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.26",
+    "@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.8",
-    "@typescript-eslint/eslint-plugin": "^5.35.1",
-    "@typescript-eslint/parser": "^5.35.1",
-    "eslint": "^8.23.0",
-    "eslint-config-prettier": "^8.5.0",
+    "@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.7.1",
+    "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typescript": "~4.8.2"
+    "typescript": "~4.9.3"
   },
   "dependencies": {
     "alcalzone-shared": "~4.0.3",
-    "chai": "^4.3.6",
+    "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "debug": "^4.3.4",
     "fs-extra": "^10.1.0",
-    "mocha": "^10.0.0",
-    "sinon": "^14.0.0",
+    "mocha": "^10.2.0",
+    "sinon": "^15.0.1",
     "sinon-chai": "^3.7.0"
   }
 }