@nsshunt/ststestrunner 1.1.14 → 1.1.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsshunt/ststestrunner",
-  "version": "1.1.14",
+  "version": "1.1.15",
   "description": "STS Test Runner Module",
   "type": "module",
   "main": "./dist/ststestrunner.cjs",

package/types/libmodule/asyncRunnerFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"asyncRunnerFactory.d.ts","sourceRoot":"","sources":["../../src/libmodule/asyncRunnerFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,6BAA6B,EAAE,MAAM,6BAA6B,CAAA;AAazH,qBAAa,kBAAkB;IAC3B,MAAM,CAAC,iBAAiB,GAAU,uBAAuB,6BAA6B,EAAE,4BAA4B,2BAA2B,KAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAyBhL;CACJ"}
+{"version":3,"file":"asyncRunnerFactory.d.ts","sourceRoot":"","sources":["../../src/libmodule/asyncRunnerFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,6BAA6B,EAAE,MAAM,6BAA6B,CAAA;AAgBzH,qBAAa,kBAAkB;IAC3B,MAAM,CAAC,iBAAiB,GAAU,uBAAuB,6BAA6B,EAAE,4BAA4B,2BAA2B,KAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CA6BhL;CACJ"}

package/types/libmodule/testCase01.d.ts

@@ -0,0 +1,188 @@
+import { AbstractRunnerExecutionWorker, IRunnerInstance, IRunnerOptions, IRunner } from '@nsshunt/stsrunnerframework';
+/**
+ * Extended runner options used specifically by `TestCase01`.
+ *
+ * In addition to standard framework runner options, this test case supports:
+ *
+ * - `sleepDuration`
+ * - `logMessageMod`
+ * - `colourIndex`
+ *
+ * These fields allow the test runner to simulate work and produce predictable
+ * telemetry/logging behaviour.
+ */
+export interface IRunnerOptionsEx extends IRunnerOptions {
+    /**
+     * Simulated work delay in milliseconds for each execution iteration.
+     *
+     * If greater than zero, the runner sleeps for this duration inside `ExecuteRunner()`.
+     * If zero, it yields immediately instead.
+     */
+    sleepDuration: number;
+    /**
+     * Frequency for generating animated log messages.
+     *
+     * Example:
+     * - if `logMessageMod` is `5`, a generated log message is emitted every 5 requests.
+     */
+    logMessageMod: number;
+    /**
+     * Placeholder/example option for colour selection.
+     *
+     * Currently present for test flexibility but not actively used in the logic shown here.
+     */
+    colourIndex: number;
+}
+/**
+ * Concrete synthetic test runner implementation.
+ *
+ * This runner:
+ * - simulates work
+ * - updates telemetry counters
+ * - batches telemetry publishing
+ * - emits lifecycle log messages
+ */
+export declare class TestCase01 implements IRunnerInstance {
+    #private;
+    /**
+     * Construct a new synthetic test runner.
+     *
+     * @param runnerExecutionWorker Owning worker-side execution host.
+     * @param runner Live runner model/state for this test runner.
+     */
+    constructor(runnerExecutionWorker: AbstractRunnerExecutionWorker, runner: IRunner);
+    /**
+     * Yield immediately to the event loop/microtask queue.
+     *
+     * Used when the runner wants to behave asynchronously but does not need
+     * a real delay.
+     *
+     * @returns Resolved promise.
+     */
+    SleepImmediate(): Promise<void>;
+    /**
+     * Execute one synthetic unit of work for this runner.
+     *
+     * Behaviour
+     * ---------
+     * - captures start time
+     * - reads extended runner options
+     * - updates telemetry counters/metrics
+     * - optionally generates log messages
+     * - optionally emits status/progress messages
+     * - simulates actual work using:
+     *   - `Sleep(options.sleepDuration)`, or
+     *   - immediate yield
+     * - decrements active request count
+     * - records duration
+     * - publishes telemetry using buffered publish logic
+     *
+     * Telemetry updates performed
+     * ---------------------------
+     * - `coreCount = 1`
+     * - `activeRequestCount++`
+     * - `requestCount++`
+     * - `velocity++`
+     * - `tx += 256000`
+     * - `rx += 6500000`
+     * - `duration = measured execution time`
+     *
+     * Notes
+     * -----
+     * - This method simulates real work rather than performing domain logic
+     * - It is intended to validate the framework's runner/telemetry lifecycle
+     * - After the awaited work delay, the actual framework runner state may have
+     *   changed externally, but this test implementation does not directly react here
+     *
+     * @returns `true` when the synthetic work cycle completes.
+     */
+    ExecuteRunner: () => Promise<any>;
+    /**
+     * Handle framework "start" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    StartRunner: () => Promise<any>;
+    /**
+     * Handle framework "stop" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    StopRunner: () => Promise<any>;
+    /**
+     * Handle framework "terminate" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    TerminateRunner: () => Promise<any>;
+    /**
+     * Handle framework "completed" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a completion lifecycle message including current telemetry snapshot
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    Completed: () => Promise<any>;
+    /**
+     * Handle framework "pause" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     * - returns a descriptive diagnostic string
+     *
+     * @returns Diagnostic pause message.
+     */
+    PauseRunner: () => Promise<any>;
+    /**
+     * Handle framework "resume" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     * - returns a descriptive diagnostic string
+     *
+     * @returns Diagnostic resume message.
+     */
+    ResumeRunner: () => Promise<any>;
+    /**
+     * Handle framework "reset" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - resets `requestCount` to zero
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    ResetRunner: () => Promise<any>;
+    /**
+     * Handle framework "update" lifecycle event for this runner.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * Note:
+     * - this implementation does not directly apply option changes itself;
+     *   it simply acknowledges the lifecycle event for framework testing
+     *
+     * @returns `true`
+     */
+    UpdateRunner: () => Promise<any>;
+}
+//# sourceMappingURL=testCase01.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"testCase01.d.ts","sourceRoot":"","sources":["../../src/libmodule/testCase01.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AAEH,OAAO,EAAE,6BAA6B,EAAE,eAAe,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAyCtH;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,qBAAa,UAAW,YAAW,eAAe;;IAqD9C;;;;;OAKG;gBACS,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,EAAE,OAAO;IA0KjF;;;;;;;OAOG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAM/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,aAAa,QAAa,OAAO,CAAC,GAAG,CAAC,CA+CpC;IAeF;;;;;;;;OAQG;IACH,WAAW,QAAa,OAAO,CAAC,GAAG,CAAC,CAIlC;IAEF;;;;;;;;OAQG;IACH,UAAU,QAAa,OAAO,CAAC,GAAG,CAAC,CAIjC;IAEF;;;;;;;;OAQG;IACH,eAAe,QAAa,OAAO,CAAC,GAAG,CAAC,CAItC;IAEF;;;;;;;;OAQG;IACH,SAAS,QAAa,OAAO,CAAC,GAAG,CAAC,CAIhC;IAEF;;;;;;;;;OASG;IACH,WAAW,QAAa,OAAO,CAAC,GAAG,CAAC,CAIlC;IAEF;;;;;;;;;OASG;IACH,YAAY,QAAa,OAAO,CAAC,GAAG,CAAC,CAInC;IAEF;;;;;;;;;OASG;IACH,WAAW,QAAa,OAAO,CAAC,GAAG,CAAC,CAKlC;IAEF;;;;;;;;;;;;OAYG;IACH,YAAY,QAAa,OAAO,CAAC,GAAG,CAAC,CAInC;CACL"}

package/types/libmodule/testCase02.d.ts

@@ -0,0 +1,178 @@
+import { AbstractRunnerExecutionWorker, IRunnerInstance, IRunnerOptions, IRunner } from '@nsshunt/stsrunnerframework';
+/**
+ * Extended runner options used by `TestCase02`.
+ *
+ * In addition to the standard runner options, this test runner supports:
+ *
+ * - `sleepDuration`
+ * - `logMessageMod`
+ * - `colourIndex`
+ */
+export interface IRunnerOptionsEx extends IRunnerOptions {
+    /**
+     * Simulated work delay in milliseconds for each execution cycle.
+     */
+    sleepDuration: number;
+    /**
+     * Frequency used for generated "Hello World" log messages.
+     *
+     * Example:
+     * - if set to `10`, an animated log message is generated every 10 requests.
+     */
+    logMessageMod: number;
+    /**
+     * Placeholder/example option for colour selection.
+     *
+     * Present for testing/extensibility, though not directly used in the logic shown.
+     */
+    colourIndex: number;
+}
+/**
+ * Concrete synthetic test runner implementation.
+ *
+ * This runner simulates work, updates telemetry, batches telemetry publishing,
+ * and writes both internal telemetry messages and visible console progress.
+ */
+export declare class TestCase02 implements IRunnerInstance {
+    #private;
+    /**
+     * Construct a new `TestCase02` runner.
+     *
+     * @param runnerExecutionWorker Owning worker-side execution host.
+     * @param runner Live runner model/state.
+     */
+    constructor(runnerExecutionWorker: AbstractRunnerExecutionWorker, runner: IRunner);
+    /**
+     * Yield immediately to the event loop/microtask queue.
+     *
+     * Used when asynchronous behaviour is desired but no real delay is needed.
+     *
+     * @returns Resolved promise.
+     */
+    SleepImmediate(): Promise<void>;
+    /**
+     * Execute one synthetic unit of work for this runner.
+     *
+     * Behaviour
+     * ---------
+     * - captures start time
+     * - reads extended test options
+     * - updates runner telemetry
+     * - optionally generates animated telemetry messages
+     * - always generates a progress message for telemetry
+     * - always writes a progress message to `console.log(...)`
+     * - simulates work with either:
+     *   - `Sleep(options.sleepDuration)`, or
+     *   - immediate yield
+     * - decrements active request count
+     * - calculates and stores execution duration
+     * - performs buffered telemetry publication
+     *
+     * Telemetry fields updated
+     * ------------------------
+     * - `coreCount = 1`
+     * - `activeRequestCount++`
+     * - `requestCount++`
+     * - `velocity++`
+     * - `tx += 256000`
+     * - `rx += 6500000`
+     * - `duration = measured elapsed time`
+     *
+     * Additional visible behaviour
+     * ----------------------------
+     * Unlike `TestCase01`, this implementation always writes a progress message
+     * directly to the process/browser console using `console.log(...)`.
+     *
+     * This makes it more useful for manually watching test progress while the
+     * framework is running.
+     *
+     * @returns `true` when the simulated work cycle completes.
+     */
+    ExecuteRunner: () => Promise<boolean>;
+    /**
+     * Handle framework "start" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    StartRunner: () => Promise<boolean>;
+    /**
+     * Handle framework "stop" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    StopRunner: () => Promise<boolean>;
+    /**
+     * Handle framework "terminate" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    TerminateRunner: () => Promise<boolean>;
+    /**
+     * Handle framework "completed" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a completion message including the current telemetry snapshot
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    Completed: () => Promise<boolean>;
+    /**
+     * Handle framework "pause" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    PauseRunner: () => Promise<boolean>;
+    /**
+     * Handle framework "resume" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    ResumeRunner: () => Promise<boolean>;
+    /**
+     * Handle framework "reset" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - resets `requestCount` to zero
+     * - forces immediate telemetry publication
+     *
+     * @returns `true`
+     */
+    ResetRunner: () => Promise<boolean>;
+    /**
+     * Handle framework "update" lifecycle event.
+     *
+     * Behaviour:
+     * - writes a lifecycle message
+     * - forces immediate telemetry publication
+     *
+     * Note:
+     * - this implementation acknowledges the update event but does not apply
+     *   custom update logic itself
+     *
+     * @returns `true`
+     */
+    UpdateRunner: () => Promise<boolean>;
+}
+//# sourceMappingURL=testCase02.d.ts.map

package/types/libmodule/testCase02.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testCase02.d.ts","sourceRoot":"","sources":["../../src/libmodule/testCase02.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAEH,OAAO,EAAE,6BAA6B,EAAE,eAAe,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAwCtH;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,eAAe;;IAmD9C;;;;;OAKG;gBACS,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,EAAE,OAAO;IA8JjF;;;;;;OAMG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAM/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,QAAa,OAAO,CAAC,OAAO,CAAC,CAyDxC;IAeF;;;;;;;;OAQG;IACH,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAItC;IAEF;;;;;;;;OAQG;IACH,UAAU,QAAa,OAAO,CAAC,OAAO,CAAC,CAIrC;IAEF;;;;;;;;OAQG;IACH,eAAe,QAAa,OAAO,CAAC,OAAO,CAAC,CAI1C;IAEF;;;;;;;;OAQG;IACH,SAAS,QAAa,OAAO,CAAC,OAAO,CAAC,CAIpC;IAEF;;;;;;;;OAQG;IACH,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAItC;IAEF;;;;;;;;OAQG;IACH,YAAY,QAAa,OAAO,CAAC,OAAO,CAAC,CAIvC;IAEF;;;;;;;;;OASG;IACH,WAAW,QAAa,OAAO,CAAC,OAAO,CAAC,CAKtC;IAEF;;;;;;;;;;;;OAYG;IACH,YAAY,QAAa,OAAO,CAAC,OAAO,CAAC,CAIvC;CACL"}