@nsshunt/stsrunnerframework 1.0.68 → 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;
+    }
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsshunt/stsrunnerframework",
-  "version": "1.0.68",
+  "version": "1.0.69",
   "description": "STS Runner Framework",
   "main": "./dist/stsrunnerframework.umd.js",
   "module": "./dist/stsrunnerframework.mjs",

package/types/{mockedWorkerTestRunner01.d.ts → testing/mockedWorkerTestRunner01.d.ts}

@@ -1,5 +1,4 @@
-import { IRunnerInstance, ITestRunnerTelemetryPayload } from './commonTypes';
-import { WorkerInstance } from './workerInstance';
+import { IRunnerInstance, ITestRunnerTelemetryPayload, WorkerInstance } from './../index';
 import { JSONObject } from '@nsshunt/stsutils';
 export declare class WorkerTestCases extends WorkerInstance {
     #private;

package/types/testing/mockedWorkerTestRunner01.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockedWorkerTestRunner01.d.ts","sourceRoot":"","sources":["../../src/testing/mockedWorkerTestRunner01.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAMzF,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,qBAAa,eAAgB,SAAQ,cAAc;;;IAO/C,OAAO,GAAI,SAAS,UAAU,UAa7B;IAEQ,iBAAiB,GAAI,4BAA4B,2BAA2B,KAAG,eAAe,GAAG,IAAI,CAO7G;CACJ"}

package/types/{testCase01.d.ts → testing/testCase01.d.ts}

@@ -1,5 +1,4 @@
-import { IRunnerInstance, IRunnerOptions, IRunner } from './commonTypes';
-import { WorkerInstance } from './workerInstance';
+import { IRunnerInstance, IRunnerOptions, IRunner, WorkerInstance } from './../index';
 export interface IRunnerOptionsEx extends IRunnerOptions {
     sleepDuration: number;
     logMessageMod: number;

package/types/testing/testCase01.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testCase01.d.ts","sourceRoot":"","sources":["../../src/testing/testCase01.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAcrF,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;CACtB;AAED,qBAAa,UAAW,YAAW,eAAe;;gBASlC,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO;IAmG3D,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAM/B,OAAO,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC,CAkCpD;IASD,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAIvC;IAED,UAAU,QAAa,OAAO,CAAC,OAAO,CAAC,CAItC;IAED,eAAe,QAAa,OAAO,CAAC,OAAO,CAAC,CAI3C;IAED,SAAS,QAAa,OAAO,CAAC,OAAO,CAAC,CAIrC;IAED,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAIvC;IAED,YAAY,QAAa,OAAO,CAAC,OAAO,CAAC,CAIxC;IAED,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAKvC;IAED,aAAa,QAAa,OAAO,CAAC,OAAO,CAAC,CAIzC;CACJ"}

package/types/testing/wmwokerProcess.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wmwokerProcess.test.d.ts","sourceRoot":"","sources":["../../src/testing/wmwokerProcess.test.ts"],"names":[],"mappings":""}

package/types/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/types/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/types/mockedWorkerTestRunner01.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mockedWorkerTestRunner01.d.ts","sourceRoot":"","sources":["../src/mockedWorkerTestRunner01.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAMjD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,qBAAa,eAAgB,SAAQ,cAAc;;;IAO/C,OAAO,GAAI,SAAS,UAAU,UAa7B;IAEQ,iBAAiB,GAAI,4BAA4B,2BAA2B,KAAG,eAAe,GAAG,IAAI,CAO7G;CACJ"}

package/types/testCase01.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"testCase01.d.ts","sourceRoot":"","sources":["../src/testCase01.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAIxE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAYjD,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;CACtB;AAED,qBAAa,UAAW,YAAW,eAAe;;gBASlC,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO;IAmG3D,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAM/B,OAAO,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC,CAkCpD;IASD,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAIvC;IAED,UAAU,QAAa,OAAO,CAAC,OAAO,CAAC,CAItC;IAED,eAAe,QAAa,OAAO,CAAC,OAAO,CAAC,CAI3C;IAED,SAAS,QAAa,OAAO,CAAC,OAAO,CAAC,CAIrC;IAED,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAIvC;IAED,YAAY,QAAa,OAAO,CAAC,OAAO,CAAC,CAIxC;IAED,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAKvC;IAED,aAAa,QAAa,OAAO,CAAC,OAAO,CAAC,CAIzC;CACJ"}

package/types/wmwokerProcess.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"wmwokerProcess.test.d.ts","sourceRoot":"","sources":["../src/wmwokerProcess.test.ts"],"names":[],"mappings":""}

package/types/workerWorkerTestRunner01.d.ts

@@ -1,7 +0,0 @@
-import { IRunnerInstance, ITestRunnerTelemetryPayload } from './commonTypes';
-import { WorkerInstance } from './workerInstance';
-export declare class WorkerTestCases extends WorkerInstance {
-    constructor();
-    CreateAsyncRunner: (testRunnerTelemetryPayload: ITestRunnerTelemetryPayload) => IRunnerInstance | null;
-}
-//# sourceMappingURL=workerWorkerTestRunner01.d.ts.map

package/types/workerWorkerTestRunner01.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"workerWorkerTestRunner01.d.ts","sourceRoot":"","sources":["../src/workerWorkerTestRunner01.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAsB,MAAM,eAAe,CAAA;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAQjD,qBAAa,eAAgB,SAAQ,cAAc;;IAKtC,iBAAiB,GAAI,4BAA4B,2BAA2B,KAAG,eAAe,GAAG,IAAI,CAO7G;CACJ"}

package/types/workerWorkerTestRunner01Agent.d.ts

@@ -1,7 +0,0 @@
-import { IRunnerInstance, ITestRunnerTelemetryPayload } from './commonTypes';
-import { WorkerInstance } from './workerInstance';
-export declare class WorkerTestCases extends WorkerInstance {
-    constructor();
-    CreateAsyncRunner: (testRunnerTelemetryPayload: ITestRunnerTelemetryPayload) => IRunnerInstance | null;
-}
-//# sourceMappingURL=workerWorkerTestRunner01Agent.d.ts.map

package/types/workerWorkerTestRunner01Agent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"workerWorkerTestRunner01Agent.d.ts","sourceRoot":"","sources":["../src/workerWorkerTestRunner01Agent.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAKjD,qBAAa,eAAgB,SAAQ,cAAc;;IAKtC,iBAAiB,GAAI,4BAA4B,2BAA2B,KAAG,eAAe,GAAG,IAAI,CAO7G;CACJ"}