@iobroker/testing 5.1.1 → 5.2.1

package/build/lib/adapterTools.js

@@ -94,11 +94,28 @@ async function locateAdapterMainFile(adapterDir) {
         debug(`  => found ${mainFile}`);
         return ret;
     }
+    // If the specified file doesn't exist and ends with .js, try the .ts equivalent
+    if (mainFile.endsWith('.js')) {
+        const tsFile = mainFile.replace(/\.js$/, '.ts');
+        ret = path.join(adapterDir, tsFile);
+        debug(`  => trying ${ret}`);
+        if (await (0, fs_extra_1.pathExists)(ret)) {
+            debug(`  => found ${tsFile}`);
+            return ret;
+        }
+    }
     // If both don't exist, JS-Controller uses <adapter name>.js as another fallback
     ret = path.join(adapterDir, `${ioPackage.common.name}.js`);
     debug(`  => trying ${ret}`);
     if (await (0, fs_extra_1.pathExists)(ret)) {
-        debug(`  => found ${mainFile}`);
+        debug(`  => found ${ioPackage.common.name}.js`);
+        return ret;
+    }
+    // Also try <adapter name>.ts as a fallback
+    ret = path.join(adapterDir, `${ioPackage.common.name}.ts`);
+    debug(`  => trying ${ret}`);
+    if (await (0, fs_extra_1.pathExists)(ret)) {
+        debug(`  => found ${ioPackage.common.name}.ts`);
         return ret;
     }
     throw new Error(`The adapter main file was not found in ${adapterDir}`);

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

@@ -75,9 +75,13 @@ class AdapterSetup {
         // Therefore pack it into a tarball and put it in the test dir for installation
         const packResult = await (0, executeCommand_1.executeCommand)('npm', ['pack', '--loglevel', 'silent'], {
             stdout: 'pipe',
+            stderr: 'pipe',
         });
         if (packResult.exitCode !== 0 || typeof packResult.stdout !== 'string') {
-            throw new Error(`Packing the adapter tarball failed!`);
+            const errorMessage = packResult.stderr
+                ? `Packing the adapter tarball failed!\nstderr: ${packResult.stderr}`
+                : `Packing the adapter tarball failed!`;
+            throw new Error(errorMessage);
         }
         // The last non-empty line of `npm pack`s STDOUT contains the tarball path
         const stdoutLines = packResult.stdout.trim().split(/[\r\n]+/);
@@ -92,6 +96,7 @@ class AdapterSetup {
         debug('Removing the adapter from package-lock.json');
         await (0, executeCommand_1.executeCommand)('npm', ['uninstall', this.adapterFullName, '--package-lock-only', '--omit=dev'], {
             cwd: this.testDir,
+            stderr: 'pipe',
         });
         // Complete the package.json, so npm can do it's magic
         debug('Saving the adapter in package.json');
@@ -114,6 +119,7 @@ class AdapterSetup {
         // Defer to npm to install the controller (if it wasn't already)
         await (0, executeCommand_1.executeCommand)('npm', ['i', '--omit=dev'], {
             cwd: this.testDir,
+            stderr: 'pipe',
         });
         debug('  => done!');
     }
@@ -126,9 +132,13 @@ class AdapterSetup {
         const addResult = await (0, executeCommand_1.executeCommand)('node', [`${this.appName}.js`, 'add', this.adapterName, '--enabled', 'false'], {
             cwd: this.testControllerDir,
             stdout: 'ignore',
+            stderr: 'pipe',
         });
         if (addResult.exitCode !== 0) {
-            throw new Error(`Adding the adapter instance failed!`);
+            const errorMessage = addResult.stderr
+                ? `Adding the adapter instance failed!\nstderr: ${addResult.stderr}`
+                : `Adding the adapter instance failed!`;
+            throw new Error(errorMessage);
         }
         debug('  => done!');
     }

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

@@ -80,6 +80,8 @@ class ControllerSetup {
             license: 'ISC',
             dependencies: {
                 [`${this.appName}.js-controller`]: controllerVersion,
+                // @alcalzone/esbuild-register is needed to run TypeScript adapters
+                '@alcalzone/esbuild-register': '^2.5.1-1',
             },
             description: '',
         };
@@ -102,6 +104,7 @@ class ControllerSetup {
         debug('(Re-)installing JS Controller...');
         await (0, executeCommand_1.executeCommand)('npm', ['i', '--omit=dev'], {
             cwd: this.testDir,
+            stderr: 'pipe',
         });
         // Prepare/clean the databases and config
         if (wasJsControllerInstalled) {
@@ -182,13 +185,18 @@ class ControllerSetup {
         await (0, executeCommand_1.executeCommand)('node', [`${this.appName}.js`, 'stop'], {
             cwd: this.testControllerDir,
             stdout: 'ignore',
+            stderr: 'pipe',
         });
         const setupResult = await (0, executeCommand_1.executeCommand)('node', [`${this.appName}.js`, 'setup', 'first', '--console'], {
             cwd: this.testControllerDir,
             stdout: 'ignore',
+            stderr: 'pipe',
         });
         if (setupResult.exitCode !== 0) {
-            throw new Error(`${this.appName} setup first failed!`);
+            const errorMessage = setupResult.stderr
+                ? `${this.appName} setup first failed!\nstderr: ${setupResult.stderr}`
+                : `${this.appName} setup first failed!`;
+            throw new Error(errorMessage);
         }
         debug('  => done!');
     }

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

@@ -164,7 +164,13 @@ class TestHarness extends node_events_1.EventEmitter {
             this._adapterExit = code != undefined ? code : signal;
             this.emit('failed', this._adapterExit);
         };
-        this._adapterProcess = (0, node_child_process_1.spawn)(isWindows ? 'node.exe' : 'node', [mainFileRelative, '--console'], {
+        // Determine if we need to use esbuild-register for TypeScript files
+        const isTypeScript = mainFileAbsolute.endsWith('.ts');
+        const command = isWindows ? 'node.exe' : 'node';
+        const args = isTypeScript
+            ? ['-r', '@alcalzone/esbuild-register', mainFileRelative, '--console']
+            : [mainFileRelative, '--console'];
+        this._adapterProcess = (0, node_child_process_1.spawn)(command, args, {
             cwd: this.testAdapterDir,
             stdio: ['inherit', 'inherit', 'inherit'],
             env: { ...process.env, ...env },

package/build/tests/packageFiles/index.js

@@ -32,11 +32,15 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validatePackageFiles = validatePackageFiles;
 const typeguards_1 = require("alcalzone-shared/typeguards");
 const chai_1 = require("chai");
 const fs = __importStar(require("fs"));
+const json5_1 = __importDefault(require("json5"));
 const path = __importStar(require("path"));
 /**
  * Tests if the adapter files are valid.
@@ -72,6 +76,26 @@ function validatePackageFiles(adapterDir) {
             }
         });
     }
+    /**
+     * Recursively find all files matching a pattern in a directory
+     */
+    function findFiles(dir, pattern, results = []) {
+        if (!fs.existsSync(dir)) {
+            return results;
+        }
+        const files = fs.readdirSync(dir);
+        for (const file of files) {
+            const filePath = path.join(dir, file);
+            const stat = fs.statSync(filePath);
+            if (stat.isDirectory()) {
+                findFiles(filePath, pattern, results);
+            }
+            else if (pattern.test(file)) {
+                results.push(filePath);
+            }
+        }
+        return results;
+    }
     describe(`Validate the package files`, () => {
         describe(`Ensure they are readable`, () => {
             for (const filename of ['package.json', 'io-package.json']) {
@@ -142,6 +166,19 @@ function validatePackageFiles(adapterDir) {
                     }
                 }
             });
+            it('iobroker.js-controller is not listed as a dependency', () => {
+                for (const depType of [
+                    'dependencies',
+                    'devDependencies',
+                    'optionalDependencies',
+                    'peerDependencies',
+                ]) {
+                    if ((0, typeguards_1.isObject)(packageContent[depType]) && 'iobroker.js-controller' in packageContent[depType]) {
+                        // eslint-disable-next-line @typescript-eslint/only-throw-error
+                        throw new chai_1.AssertionError(`iobroker.js-controller must not be listed in ${depType}, found "${packageContent[depType]['iobroker.js-controller']}"!`);
+                    }
+                }
+            });
         });
         describe(`Check contents of io-package.json`, () => {
             beforeEach(function () {
@@ -253,22 +290,63 @@ function validatePackageFiles(adapterDir) {
                 }
             });
         });
+        describe(`Validate JSON files`, () => {
+            // Find all JSON and JSON5 files in admin/ directory (recursively)
+            const adminDir = path.join(adapterDir, 'admin');
+            const allAdminJsonFiles = findFiles(adminDir, /\.json$/);
+            const allAdminJson5Files = findFiles(adminDir, /\.json5$/);
+            // Split JSON files into admin/*.json and admin/i18n/**/*.json
+            const adminDirectJsonFiles = allAdminJsonFiles.filter(file => !file.includes(`${path.sep}i18n${path.sep}`));
+            const i18nJsonFiles = allAdminJsonFiles.filter(file => file.includes(`${path.sep}i18n${path.sep}`));
+            if (adminDirectJsonFiles.length > 0) {
+                describe(`admin/*.json files`, () => {
+                    for (const filePath of adminDirectJsonFiles) {
+                        const relativePath = path.relative(adapterDir, filePath);
+                        it(`${relativePath} contains valid JSON`, () => {
+                            (0, chai_1.expect)(() => {
+                                JSON.parse(fs.readFileSync(filePath, 'utf8'));
+                            }, `${relativePath} contains invalid JSON!`).not.to.throw();
+                        });
+                    }
+                });
+            }
+            if (allAdminJson5Files.length > 0) {
+                describe(`admin/*.json5 files`, () => {
+                    for (const filePath of allAdminJson5Files) {
+                        const relativePath = path.relative(adapterDir, filePath);
+                        it(`${relativePath} contains valid JSON5`, () => {
+                            (0, chai_1.expect)(() => {
+                                json5_1.default.parse(fs.readFileSync(filePath, 'utf8'));
+                            }, `${relativePath} contains invalid JSON5!`).not.to.throw();
+                        });
+                    }
+                });
+            }
+            if (i18nJsonFiles.length > 0) {
+                describe(`admin/i18n/**/*.json files`, () => {
+                    for (const filePath of i18nJsonFiles) {
+                        const relativePath = path.relative(adapterDir, filePath);
+                        it(`${relativePath} contains valid JSON`, () => {
+                            (0, chai_1.expect)(() => {
+                                JSON.parse(fs.readFileSync(filePath, 'utf8'));
+                            }, `${relativePath} contains invalid JSON!`).not.to.throw();
+                        });
+                    }
+                });
+            }
+        });
+    });
+    describe(`Check additional files`, () => {
+        it('README.md exists', () => {
+            (0, chai_1.expect)(fs.existsSync(path.join(adapterDir, 'README.md')), `README.md is missing in the adapter dir. Please create it!`).to.be.true;
+        });
+        it('LICENSE exists or is present in the README.md', () => {
+            const licenseExists = fs.existsSync(path.join(adapterDir, 'LICENSE'));
+            if (licenseExists) {
+                return;
+            }
+            const readmeContent = fs.readFileSync(path.join(adapterDir, 'README.md'), 'utf8');
+            (0, chai_1.expect)(readmeContent).to.match(/## LICENSE/i, `The license should be in a file "LICENSE" or be included in "README.md" as a 2nd level headline!`);
+        });
     });
-    // describe(`Check additional files`, () => {
-    // 	it("README.md exists", () => {
-    // 		expect(
-    // 			fs.existsSync(path.join(adapterDir, "README.md")),
-    // 			`README.md is missing in the adapter dir. Please create it!`,
-    // 		).to.be.true;
-    // 	});
-    // 	it("LICENSE exists or is present in the README.md", () => {
-    // 		const licenseExists = fs.existsSync(path.join(adapterDir, "LICENSE"));
-    // 		if (licenseExists) return;
-    // 		const readmeContent = fs.readFileSync(path.join(adapterDir, "README.md"), "utf8");
-    // 		expect(readmeContent).to.match(
-    // 			/## LICENSE/i,
-    // 			`The license should be in a file "LICENSE" or be included in "README.md" as a 2nd level headline!`,
-    // 		);
-    // 	});
-    // });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/testing",
-  "version": "5.1.1",
+  "version": "5.2.1",
   "description": "Shared utilities for adapter and module testing in ioBroker",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -8,8 +8,8 @@
     "build/"
   ],
   "scripts": {
-    "test": "mocha src/**/*.test.ts",
-    "test:watch": "mocha src/**/*.test.ts --watch",
+    "test": "mocha \"src/**/*.test.ts\"",
+    "test:watch": "mocha \"src/**/*.test.ts\" --watch",
     "prebuild": "rimraf ./build",
     "build": "tsc -p tsconfig.build.json",
     "prewatch": "rimraf ./build",
@@ -22,7 +22,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AlCalzone/testing.git"
+    "url": "https://github.com/ioBroker/testing"
   },
   "publishConfig": {
     "access": "public"
@@ -39,21 +39,22 @@
   },
   "homepage": "https://github.com/AlCalzone/testing#readme",
   "devDependencies": {
-    "@alcalzone/release-script": "^3.8.0",
-    "@alcalzone/release-script-plugin-license": "^3.7.0",
+    "@alcalzone/release-script": "^5.0.0",
+    "@alcalzone/release-script-plugin-license": "^4.0.0",
     "@iobroker/adapter-core": "^3.3.2",
-    "@iobroker/eslint-config": "^2.1.0",
+    "@iobroker/eslint-config": "^2.2.0",
     "@iobroker/types": "^7.0.7",
-    "@tsconfig/node16": "^16.1.4",
+    "@tsconfig/node16": "^16.1.6",
     "@types/debug": "^4.1.12",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^24.3.0",
-    "rimraf": "^6.0.1",
+    "@types/node": "^24.6.1",
+    "rimraf": "^6.1.0",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.2",
-    "typescript": "~5.9.2"
+    "typescript": "~5.9.3"
   },
   "dependencies": {
+    "@alcalzone/esbuild-register": "^2.5.1-1",
     "@types/chai": "^4.3.20",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.10",
@@ -62,9 +63,10 @@
     "alcalzone-shared": "~5.0.0",
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
-    "debug": "^4.4.1",
-    "fs-extra": "^11.3.1",
-    "mocha": "^11.7.1",
+    "debug": "^4.4.3",
+    "fs-extra": "^11.3.2",
+    "json5": "^2.2.3",
+    "mocha": "^11.7.3",
     "sinon": "^21.0.0",
     "sinon-chai": "^3.7.0"
   }