Add the possibility to predefine objects and states for unit tests

Fixes #14

README.md

@@ -59,11 +59,26 @@ tests.unit(path.join(__dirname, ".."), {
         "{CONTROLLER_DIR}/lib/tools.js": {}, 
     },
 
-    // Define your own tests inside defineAdditionalTests
-    defineAdditionalTests() {
-        it("works", () => {
-            // see below how these could look like
-        });
+    // optionally define an array of objects that need to be present in the objects DB
+    // instance objects from io-package.json are pre-loaded by default
+    predefinedObjects: [
+        {
+            _id: "test.0.object1",
+            common: { /* ... */ },
+            native: { /* ... */ },
+        },
+        {
+            _id: "test.0.object2",
+            common: { /* ... */ },
+            native: { /* ... */ },
+        }
+    ],
+
+    // Optionally define which states need to exist in the states DB
+    // You can set all properties that are usually available on a state
+    predefinedStates: {
+        "test.0.object1": { val: true, ack: false },
+        "test.0.object2": { val: 2, ack: false, ts: 1 },
     },
 
     // If the startup tests need require specific behavior of the mocks 
@@ -76,6 +91,14 @@ tests.unit(path.join(__dirname, ".."), {
         adapter.objects.getUserGroup.returns("a string");
     }
 
+    // Define your own tests inside defineAdditionalTests. 
+    // If you need predefined objects etc. here, you need to take care of it yourself
+    defineAdditionalTests() {
+        it("works", () => {
+            // see below how these could look like
+        });
+    },
+
 });
 ```
 

build/tests/unit/harness/startMockAdapter.d.ts

@@ -8,8 +8,10 @@ export interface StartMockAdapterOptions {
     compact?: boolean;
     /** The adapter config */
     config?: Record<string, any>;
-    /** An array of instance objects that should be populated before starting the adapter */
-    instanceObjects?: ioBroker.Object[];
+    /** An array of objects that should be populated before starting the adapter */
+    predefinedObjects?: ioBroker.Object[];
+    /** A dictionary of states that should be populated before starting the adapter */
+    predefinedStates?: Record<string, ioBroker.State>;
     /** Mocks for loaded modules. This should be a dictionary of module name to module.exports */
     additionalMockedModules?: Record<string, any>;
     /** Allows you to modifiy the behavior of predefined mocks in the predefined methods */

build/tests/unit/harness/startMockAdapter.js

@@ -36,9 +36,12 @@ function startMockAdapter(adapterMainFile, options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
         // Setup the mocks
         const databaseMock = new mockDatabase_1.MockDatabase();
-        // If instance objects are defined, populate the database mock with them
-        if (options.instanceObjects && options.instanceObjects.length) {
-            databaseMock.publishObjects(...options.instanceObjects);
+        // If objects and/or states are predefined, populate the database mock with them
+        if (options.predefinedObjects && options.predefinedObjects.length) {
+            databaseMock.publishObjects(...options.predefinedObjects);
+        }
+        if (options.predefinedStates) {
+            databaseMock.publishStates(options.predefinedStates);
         }
         let adapterMock;
         const adapterCoreMock = mockAdapterCore_1.mockAdapterCore(databaseMock, {

build/tests/unit/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="iobroker" />
 import { StartMockAdapterOptions } from "./harness/startMockAdapter";
 import { MockAdapter } from "./mocks/mockAdapter";
 import { MockDatabase } from "./mocks/mockDatabase";
@@ -6,6 +7,10 @@ export interface TestAdapterOptions {
     additionalMockedModules?: StartMockAdapterOptions["additionalMockedModules"];
     /** Change the default test timeout of 15000ms for the startup tests */
     startTimeout?: number;
+    /** An array of objects that should be populated before starting the adapter */
+    predefinedObjects?: ioBroker.Object[];
+    /** A dictionary of states that should be populated before starting the adapter */
+    predefinedStates?: Record<string, ioBroker.State>;
     /** Allows you to define additional tests */
     defineAdditionalTests?: () => void;
     /** Allows you to modifiy the behavior of predefined mocks in the predefined methods */

build/tests/unit/index.js

@@ -46,7 +46,11 @@ function testAdapterWithMocks(adapterDir, options = {}) {
                     this.timeout(options.startTimeout);
                 const { adapterMock, databaseMock, processExitCode, terminateReason } = yield startMockAdapter_1.startMockAdapter(mainFilename, {
                     config: adapterConfig,
-                    instanceObjects,
+                    predefinedObjects: [
+                        ...instanceObjects,
+                        ...(options.predefinedObjects || []),
+                    ],
+                    predefinedStates: options.predefinedStates,
                     additionalMockedModules: options.additionalMockedModules,
                     defineMockBehavior: options.defineMockBehavior,
                     adapterDir,
@@ -68,7 +72,11 @@ function testAdapterWithMocks(adapterDir, options = {}) {
                     const { adapterMock, databaseMock, processExitCode, terminateReason } = yield startMockAdapter_1.startMockAdapter(mainFilename, {
                         compact: true,
                         config: adapterConfig,
-                        instanceObjects,
+                        predefinedObjects: [
+                            ...instanceObjects,
+                            ...(options.predefinedObjects || []),
+                        ],
+                        predefinedStates: options.predefinedStates,
                         additionalMockedModules: options.additionalMockedModules,
                         defineMockBehavior: options.defineMockBehavior,
                         adapterDir,

build/tests/unit/mocks/mockDatabase.d.ts

@@ -18,6 +18,7 @@ export declare class MockDatabase {
     deleteObject(objID: string): void;
     publishState(id: string, state: Partial<ioBroker.State> | null | undefined): void;
     deleteState(id: string): void;
+    publishStates(states: Record<string, Partial<ioBroker.State> | null | undefined>): void;
     hasObject(id: string): boolean;
     hasObject(namespace: string, id: string): boolean;
     getObject(id: string): ioBroker.Object | undefined;

build/tests/unit/mocks/mockDatabase.js

@@ -72,6 +72,11 @@ class MockDatabase {
     deleteState(id) {
         this.states.delete(id);
     }
+    publishStates(states) {
+        for (const id of Object.keys(states)) {
+            this.publishState(id, states[id]);
+        }
+    }
     hasObject(namespaceOrId, id) {
         id = namespaceOrId + (id ? "." + id : "");
         return this.objects.has(id);

src/tests/unit/harness/startMockAdapter.ts

@@ -16,8 +16,10 @@ export interface StartMockAdapterOptions {
 	compact?: boolean;
 	/** The adapter config */
 	config?: Record<string, any>;
-	/** An array of instance objects that should be populated before starting the adapter */
-	instanceObjects?: ioBroker.Object[];
+	/** An array of objects that should be populated before starting the adapter */
+	predefinedObjects?: ioBroker.Object[];
+	/** A dictionary of states that should be populated before starting the adapter */
+	predefinedStates?: Record<string, ioBroker.State>;
 	/** Mocks for loaded modules. This should be a dictionary of module name to module.exports */
 	additionalMockedModules?: Record<string, any>;
 	/** Allows you to modifiy the behavior of predefined mocks in the predefined methods */
@@ -37,9 +39,12 @@ export async function startMockAdapter(adapterMainFile: string, options: StartMo
 
 	// Setup the mocks
 	const databaseMock = new MockDatabase();
-	// If instance objects are defined, populate the database mock with them
-	if (options.instanceObjects && options.instanceObjects.length) {
-		databaseMock.publishObjects(...options.instanceObjects);
+	// If objects and/or states are predefined, populate the database mock with them
+	if (options.predefinedObjects && options.predefinedObjects.length) {
+		databaseMock.publishObjects(...options.predefinedObjects);
+	}
+	if (options.predefinedStates) {
+		databaseMock.publishStates(options.predefinedStates);
 	}
 	let adapterMock: MockAdapter | undefined;
 	const adapterCoreMock = mockAdapterCore(databaseMock, {

src/tests/unit/index.ts

@@ -12,6 +12,10 @@ export interface TestAdapterOptions {
 	additionalMockedModules?: StartMockAdapterOptions["additionalMockedModules"];
 	/** Change the default test timeout of 15000ms for the startup tests */
 	startTimeout?: number;
+	/** An array of objects that should be populated before starting the adapter */
+	predefinedObjects?: ioBroker.Object[];
+	/** A dictionary of states that should be populated before starting the adapter */
+	predefinedStates?: Record<string, ioBroker.State>;
 	/** Allows you to define additional tests */
 	defineAdditionalTests?: () => void;
 	/** Allows you to modifiy the behavior of predefined mocks in the predefined methods */
@@ -57,7 +61,11 @@ export function testAdapterWithMocks(adapterDir: string, options: TestAdapterOpt
 
 			const { adapterMock, databaseMock, processExitCode, terminateReason } = await startMockAdapter(mainFilename, {
 				config: adapterConfig,
-				instanceObjects,
+				predefinedObjects: [
+					...instanceObjects,
+					...(options.predefinedObjects || []),
+				],
+				predefinedStates: options.predefinedStates,
 				additionalMockedModules: options.additionalMockedModules,
 				defineMockBehavior: options.defineMockBehavior,
 				adapterDir,
@@ -78,7 +86,11 @@ export function testAdapterWithMocks(adapterDir: string, options: TestAdapterOpt
 				const { adapterMock, databaseMock, processExitCode, terminateReason } = await startMockAdapter(mainFilename, {
 					compact: true,
 					config: adapterConfig,
-					instanceObjects,
+					predefinedObjects: [
+						...instanceObjects,
+						...(options.predefinedObjects || []),
+					],
+					predefinedStates: options.predefinedStates,
 					additionalMockedModules: options.additionalMockedModules,
 					defineMockBehavior: options.defineMockBehavior,
 					adapterDir,

src/tests/unit/mocks/mockDatabase.ts

@@ -82,6 +82,11 @@ export class MockDatabase {
 	public deleteState(id: string) {
 		this.states.delete(id);
 	}
+	public publishStates(states: Record<string, Partial<ioBroker.State> | null | undefined>) {
+		for (const id of Object.keys(states)) {
+			this.publishState(id, states[id]);
+		}
+	}
 
 	public hasObject(id: string): boolean;
 	public hasObject(namespace: string, id: string): boolean;