@nsshunt/stsrunnerframework 1.0.67 → 1.0.69

package/README.md

@@ -4,7 +4,7 @@ terminated - this means the process has been terminated and no end-of-process st
 
 stopped - end the test and report as if completed normnally
 
-
+# State Machine
 ```mermaid
 ---
 config:
@@ -32,3 +32,151 @@ stateDiagram
   Error --> [*]
   Stopped --> [*]
 ```
+
+# Nodejs Factory Instance Example
+```typescript
+/* eslint @typescript-eslint/no-unused-vars: 0,  @typescript-eslint/no-explicit-any: 0 */  // --> OFF
+import { IRunnerInstance, ITestRunnerTelemetryPayload, eIWMessageCommands, WorkerInstance } from './../index'
+import { TestCase01 } from './testCase01'
+
+import isNode from 'detect-node'
+
+import { parentPort } from 'worker_threads';
+
+export class WorkerTestCases extends WorkerInstance {
+    constructor() {
+        super()
+    }
+
+    override CreateAsyncRunner = (testRunnerTelemetryPayload: ITestRunnerTelemetryPayload): IRunnerInstance | null => {
+        const { runner } = testRunnerTelemetryPayload;
+        switch (runner.options.testType) {
+        case 'TestCase01' :
+            return new TestCase01(this, runner)
+        }
+        return null;
+    }
+}
+
+const worker = new WorkerTestCases();
+
+parentPort?.on('message', (data: any) => {
+    if (isNode) {
+        const { command, payload } = data;
+        if (command === eIWMessageCommands.MessagePort) {
+            payload.port.on('message', (data: any) => {
+                worker.ProcessMessage(data);
+            });
+            worker.ProcessMessage(data);
+        } else {
+            throw new Error(`Invalid command: [${command}]`)
+        }
+    } else {
+        const { command, payload } = data.data;
+        if (command === eIWMessageCommands.MessagePort) {
+            payload.port.on('message', (data: any) => {
+                // const payloadMessage: IIWMessagePayload = data.data as IIWMessagePayload; // browser version
+                worker.ProcessMessage(data.data); // browser version
+            });
+            worker.ProcessMessage(data.data);
+        } else {
+            throw new Error(`Invalid command: [${command}]`)
+        }
+    }
+});
+```
+
+# Agent Factory Instance Example
+```typescript
+/* eslint @typescript-eslint/no-unused-vars: 0,  @typescript-eslint/no-explicit-any: 0 */  // --> OFF
+import { IRunnerInstance, ITestRunnerTelemetryPayload, WorkerInstance, eIWMessageCommands } from './../index'
+import { TestCase01 } from './testCase01'
+
+import isNode from 'detect-node'
+
+export class WorkerTestCases extends WorkerInstance {
+    constructor() {
+        super()
+    }
+
+    override CreateAsyncRunner = (testRunnerTelemetryPayload: ITestRunnerTelemetryPayload): IRunnerInstance | null => {
+        const { runner } = testRunnerTelemetryPayload;
+        switch (runner.options.testType) {
+        case 'TestCase01' :
+            return new TestCase01(this, runner)
+        }
+        return null;
+    }
+}
+
+const worker = new WorkerTestCases();
+
+onmessage = async function(data: any) {
+    if (isNode) {
+        const { command, payload } = data;
+        if (command === eIWMessageCommands.MessagePort) {
+            payload.port.on('message', (data: any) => {
+                worker.ProcessMessage(data);
+            });
+            worker.ProcessMessage(data);
+        } else {
+            throw new Error(`Invalid command: [${command}]`)
+        }
+    } else {
+        const { command, payload } = data.data;
+        if (command === eIWMessageCommands.MessagePort) {
+            payload.port.on('message', (data: any) => {
+                // const payloadMessage: IIWMessagePayload = data.data as IIWMessagePayload; // browser version
+                worker.ProcessMessage(data.data); // browser version
+            });
+            worker.ProcessMessage(data.data);
+        } else {
+            throw new Error(`Invalid command: [${command}]`)
+        }
+    }
+}
+```
+
+# Mocked Factory Instance Example (for testing only)
+```typescript
+/* eslint @typescript-eslint/no-unused-vars: 0,  @typescript-eslint/no-explicit-any: 0 */  // --> OFF
+import { IRunnerInstance, ITestRunnerTelemetryPayload, WorkerInstance } from './../index'
+import { TestCase01 } from './testCase01'
+
+import { MessagePort } from 'worker_threads';
+
+import isNode from 'detect-node'
+import { JSONObject } from '@nsshunt/stsutils';
+
+export class WorkerTestCases extends WorkerInstance {
+    #port: MessagePort | null = null;
+
+    constructor() {
+        super()
+    }
+
+    SetPort = (message: JSONObject) => {
+        this.#port = message.payload.port as MessagePort;
+
+        this.#port.on('message', (data: any) => {
+            if (isNode) {
+                this.ProcessMessage(data);
+            } else {
+                // const payloadMessage: IIWMessagePayload = data.data as IIWMessagePayload; // browser version
+                this.ProcessMessage(data.data); // browser version
+            }
+        });
+
+        this.ProcessMessage(message);
+    }
+
+    override CreateAsyncRunner = (testRunnerTelemetryPayload: ITestRunnerTelemetryPayload): IRunnerInstance | null => {
+        const { runner } = testRunnerTelemetryPayload;
+        switch (runner.options.testType) {
+        case 'TestCase01' :
+            return new TestCase01(this, runner)
+        }
+        return null;
+    }
+}
+```