@iobroker/testing 3.0.1 → 3.0.2

package/CHANGELOG.md

@@ -4,6 +4,9 @@
 	PLACEHOLDER for next version:
 	## __WORK IN PROGRESS__
 -->
+## 3.0.2 (2022-05-15)
+* Fix: Replace the `harness` argument to the `suite()` function with a `getHarness()` function to avoid accessing a stale harness.
+
 ## 3.0.1 (2022-05-09)
 * BREAKING: The function signature of `defineAdditionalTests` in integration tests has changed. All user-defined integration tests must now be grouped in one or more `suite` blocks. The adapter will now only be started at the beginning of each suite. See the documentation for details.
 * BREAKING: The function signature of `harness.startAdapterAndWait` has changed. It now accepts a boolean as the first parameter which controls whether to wait for the `alive` state (`false`) or the `info.connection` state (`true`).

package/README.md

@@ -50,7 +50,13 @@ tests.integration(path.join(__dirname, ".."), {
 		// The adapter will run until the end of each suite.
 
 		// Since the tests are heavily instrumented, each suite gives access to a so called "harness" to control the tests.
-		suite("Test sendTo()", (harness) => {
+		suite("Test sendTo()", (getHarness) => {
+			// For convenience, get the current suite's harness before all tests
+			let harness;
+			before(() => {
+				harness = getHarness();
+			});
+
 			it("Should work", () => {
 				return new Promise(async (resolve) => {
 					// Start the adapter and wait until it has started

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

@@ -15,9 +15,9 @@ export interface TestContext {
      * Defines a test suite. At the start of each suite, the adapter will be started with a fresh environment.
      * To define tests in each suite, use describe and it as usual.
      *
-     * Each suite has its own test harness, which gets passed as an argument.
+     * Each suite has its own test harness, which can be retrieved using the function that is passed to the suite callback.
      */
-    suite: (name: string, fn: (harness: TestHarness) => void) => void;
+    suite: (name: string, fn: (getHarness: () => TestHarness) => void) => void;
     describe: Mocha.SuiteFunction;
     it: Mocha.TestFunction;
 }

package/build/tests/integration/index.js

@@ -175,18 +175,13 @@ function testAdapter(adapterDir, options = {}) {
             describe("User-defined tests", () => {
                 // patch the global it() function so nobody can bypass the checks
                 global.it = patchedIt;
-                const lazyHarness = new Proxy({}, {
-                    get(target, propKey) {
-                        return harness[propKey];
-                    },
-                });
                 const args = {
                     // a test suite is a special describe which sets up and tears down the test environment before and after ALL tests
                     suite: (name, fn) => {
                         describe(name, () => {
                             isInSuite = true;
                             before(resetDbAndStartHarness);
-                            fn(lazyHarness);
+                            fn(() => harness);
                             after(shutdownTests);
                             isInSuite = false;
                         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/testing",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Shared utilities for adapter and module testing in ioBroker",
   "main": "build/index.js",
   "types": "build/index.d.ts",