@iobroker/testing 2.5.6 → 2.6.0

package/CHANGELOG.md

@@ -4,6 +4,9 @@
 	PLACEHOLDER for next version:
 	## __WORK IN PROGRESS__
 -->
+## 2.6.0 (2022-04-18)
+* The loglevel for the adapter and DB instances is now configurable and defaults to `"debug"` in both cases
+
 ## 2.5.6 (2022-03-05)
 * Allow immediate exit with code `0` for `once` and `subscribe` adapters too
 

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

@@ -1,6 +1,9 @@
+/// <reference types="iobroker" />
 import { TestHarness } from "./lib/harness";
 export interface TestAdapterOptions {
     allowedExitCodes?: (number | string)[];
+    /** The loglevel to use for DB and adapter related logs */
+    loglevel?: ioBroker.LogLevel;
     /** How long to wait before the adapter startup is considered successful */
     waitBeforeStartupSuccess?: number;
     /** Allows you to define additional tests */

package/build/tests/integration/index.js

@@ -32,6 +32,7 @@ const adapterSetup_1 = require("./lib/adapterSetup");
 const controllerSetup_1 = require("./lib/controllerSetup");
 const dbConnection_1 = require("./lib/dbConnection");
 const harness_1 = require("./lib/harness");
+const logger_1 = require("./lib/logger");
 function testAdapter(adapterDir, options = {}) {
     const appName = (0, adapterTools_1.getAppName)(adapterDir);
     const adapterName = (0, adapterTools_1.getAdapterName)(adapterDir);
@@ -47,6 +48,7 @@ function testAdapter(adapterDir, options = {}) {
         let objectsBackup;
         let statesBackup;
         before(async function () {
+            var _a;
             // Installation may take a while - especially if rsa-compat needs to be installed
             const oneMinute = 60000;
             this.timeout(30 * oneMinute);
@@ -61,7 +63,7 @@ function testAdapter(adapterDir, options = {}) {
             // Only then we can install the adapter, because some (including VIS) try to access
             // the databases if JS Controller is installed
             await adapterSetup.installAdapterInTestDir();
-            const dbConnection = new dbConnection_1.DBConnection(appName, testDir);
+            const dbConnection = new dbConnection_1.DBConnection(appName, testDir, (0, logger_1.createLogger)((_a = options.loglevel) !== null && _a !== void 0 ? _a : "debug"));
             await dbConnection.start();
             controllerSetup.setupSystemConfig(dbConnection);
             await controllerSetup.disableAdminInstances(dbConnection);
@@ -73,8 +75,9 @@ function testAdapter(adapterDir, options = {}) {
                 await dbConnection.backup());
         });
         beforeEach(async function () {
+            var _a, _b;
             this.timeout(30000);
-            dbConnection = new dbConnection_1.DBConnection(appName, testDir);
+            dbConnection = new dbConnection_1.DBConnection(appName, testDir, (0, logger_1.createLogger)((_a = options.loglevel) !== null && _a !== void 0 ? _a : "debug"));
             // Clean up before every single test
             await Promise.all([
                 controllerSetup.clearDBDir(),
@@ -84,11 +87,11 @@ function testAdapter(adapterDir, options = {}) {
             // Create a new test harness
             await dbConnection.start();
             harness = new harness_1.TestHarness(adapterDir, testDir, dbConnection);
-            // Enable the adapter and set its loglevel to debug
+            // Enable the adapter and set its loglevel to the selected one
             await harness.changeAdapterConfig(adapterName, {
                 common: {
                     enabled: true,
-                    loglevel: "debug",
+                    loglevel: (_b = options.loglevel) !== null && _b !== void 0 ? _b : "debug",
                 },
             });
             // And enable the sendTo emulation

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

@@ -11,11 +11,12 @@ export interface DBConnection {
 export declare class DBConnection extends EventEmitter {
     private appName;
     private testDir;
+    private logger;
     /**
      * @param appName The branded name of "iobroker"
      * @param testDir The directory the integration tests are executed in
      */
-    constructor(appName: string, testDir: string);
+    constructor(appName: string, testDir: string, logger: ioBroker.Logger);
     private testDataDir;
     private testControllerDir;
     private _objectsServer;

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

@@ -33,24 +33,17 @@ const fs_extra_1 = require("fs-extra");
 const path = __importStar(require("path"));
 const tools_1 = require("./tools");
 const debug = (0, debug_1.default)("testing:integration:DBConnection");
-/** The logger instance for the objects and states DB */
-const logger = {
-    silly: console.log,
-    debug: console.log,
-    info: console.log,
-    warn: console.warn,
-    error: console.error,
-};
 /** The DB connection capsules access to the states and objects DB */
 class DBConnection extends events_1.default {
     /**
      * @param appName The branded name of "iobroker"
      * @param testDir The directory the integration tests are executed in
      */
-    constructor(appName, testDir) {
+    constructor(appName, testDir, logger) {
         super();
         this.appName = appName;
         this.testDir = testDir;
+        this.logger = logger;
         this._isRunning = false;
         this.getObject = async (id) => {
             if (!this._objectsClient) {
@@ -192,7 +185,7 @@ class DBConnection extends events_1.default {
                 noFileCache: false,
                 connectTimeout: 2000,
             },
-            logger,
+            logger: this.logger,
         };
         const objectsDbPath = require.resolve(`@iobroker/db-objects-${objectsType}`, {
             paths: [
@@ -240,7 +233,7 @@ class DBConnection extends events_1.default {
                     retry_max_delay: 15000,
                 },
             },
-            logger,
+            logger: this.logger,
         };
         const statesDbPath = require.resolve(`@iobroker/db-states-${statesType}`, {
             paths: [

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

@@ -0,0 +1,2 @@
+/// <reference types="iobroker" />
+export declare function createLogger(loglevel: ioBroker.LogLevel): ioBroker.Logger;

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = void 0;
+var LoglevelOrder;
+(function (LoglevelOrder) {
+    LoglevelOrder[LoglevelOrder["error"] = 0] = "error";
+    LoglevelOrder[LoglevelOrder["warn"] = 1] = "warn";
+    LoglevelOrder[LoglevelOrder["info"] = 2] = "info";
+    LoglevelOrder[LoglevelOrder["debug"] = 3] = "debug";
+    LoglevelOrder[LoglevelOrder["silly"] = 4] = "silly";
+})(LoglevelOrder || (LoglevelOrder = {}));
+function createLogger(loglevel) {
+    var _a;
+    const loglevelNumeric = (_a = LoglevelOrder[loglevel !== null && loglevel !== void 0 ? loglevel : "debug"]) !== null && _a !== void 0 ? _a : LoglevelOrder.debug;
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    const ignore = () => { };
+    return {
+        error: loglevelNumeric >= LoglevelOrder.error ? console.error : ignore,
+        warn: loglevelNumeric >= LoglevelOrder.warn ? console.warn : ignore,
+        info: loglevelNumeric >= LoglevelOrder.info ? console.log : ignore,
+        debug: loglevelNumeric >= LoglevelOrder.debug ? console.log : ignore,
+        silly: loglevelNumeric >= LoglevelOrder.silly ? console.log : ignore,
+        level: loglevel,
+    };
+}
+exports.createLogger = createLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/testing",
-  "version": "2.5.6",
+  "version": "2.6.0",
   "description": "Shared utilities for adapter and module testing in ioBroker",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -38,7 +38,7 @@
   },
   "homepage": "https://github.com/AlCalzone/testing#readme",
   "devDependencies": {
-    "@alcalzone/release-script": "^3.5.4",
+    "@alcalzone/release-script": "^3.5.6",
     "@alcalzone/release-script-plugin-license": "^3.5.3",
     "@iobroker/adapter-core": "^2.6.0",
     "@tsconfig/node12": "^1.0.9",
@@ -51,12 +51,12 @@
     "@types/node": "^16.11.26",
     "@types/sinon": "^10.0.11",
     "@types/sinon-chai": "^3.2.8",
-    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
     "@typescript-eslint/parser": "^5.13.0",
-    "eslint": "^8.10.0",
+    "eslint": "^8.12.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "prettier": "^2.5.1",
+    "prettier": "^2.6.1",
     "rimraf": "^3.0.2",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.6.0",
@@ -68,7 +68,7 @@
     "chai-as-promised": "^7.1.1",
     "debug": "^4.3.3",
     "fs-extra": "^10.0.1",
-    "mocha": "^9.2.1",
+    "mocha": "^9.2.2",
     "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0"
   }