@overkill-dev/engine 0.0.31 → 0.0.33

package/readme.md

@@ -5,6 +5,7 @@ Core Overkill primitives for defining executable test values and running an alre
 Top-level API:
 
 - `createTestCase(options)`
+- `createThrowingTestCase(options)`
 - `createSkippedTestCase(options)`
 - `createRoot(options)`
 - `createSuite(options)`
@@ -22,7 +23,7 @@ Top-level API:
 - `CaseId`, `TestId`, `TestRoot`, `TestPlan`, `ExecuteOptions`, `NonEmptyReadonlyArray`, `DeepComparable`
 - `Reporter`, `DefinedReporter`, `ReporterEvent`, `RealTimeReporter`, `FinalResultReporter`, `RunFacts`, `SinkDeclaration`, `OutputLineIntent`, `OutputRenderer`, `DefinedOutputRenderer`, `ReportingContext`
 - `RunResult`, `TestOutcome`, `PassOutcome`, `FailOutcome`, `SkipOutcome`, `InconclusiveOutcome`
-- `AssertionNode`, `AssertionResult`, `AssertAssertionFacade`, `TestScopeAssertContext`
+- `AssertionNode`, `AssertionResult`, `AssertAssertionFacade`, `InFlightTask`, `TestScopeAssertContext`
 - `ThrownMatcher`, `ErrorMatcher`, `ExactThrownMatcher`
 - `RequireAssertionFacade`, `FailedCheck`, `TestFailure`, `RunnerError`
 - `Diff`, `DiffPathSegment`, `SerializedValue`, `SerializationBudget`
@@ -36,7 +37,14 @@ The top-level constructors share one default engine instance. Use
 Direct execution:
 
 ```ts
-import { createRoot, createSkippedTestCase, createTestCase, createTestPlan, execute } from '@overkill-dev/engine';
+import {
+    createRoot,
+    createSkippedTestCase,
+    createTestCase,
+    createThrowingTestCase,
+    createTestPlan,
+    execute
+} from '@overkill-dev/engine';
 
 export const testNode = createTestCase({
     body(scope) {
@@ -56,8 +64,18 @@ const skippedNode = createSkippedTestCase({
     title: 'platform-specific'
 });
 
+const throwingNode = createThrowingTestCase({
+    body(scope) {
+        scope.assert.equal(1, 1);
+    },
+    annotations: {},
+    controls: {},
+    definitionLocations: [ { kind: 'unknown' } ],
+    title: 'legacy assertion'
+});
+
 const root = createRoot({
-    children: [ testNode, skippedNode ],
+    children: [ testNode, throwingNode, skippedNode ],
     annotations: {},
     controls: {},
     title: 'direct'
@@ -104,6 +122,18 @@ during test construction or collection. `TestPlanCase.annotations` and
 `TestPlanCase.controls` contain the resolved data after root, suite, table,
 and case propagation.
 
+Test scope lifecycle:
+
+- `scope.signal` is aborted after the body returns or throws and before
+  cleanup callbacks run.
+- `scope.cleanup(callback)` registers teardown callbacks. Callbacks run in
+  reverse registration order and may be async.
+- `scope.drainMicrotasks()`, `scope.yieldToNextTurn()`, and
+  `scope.settleAsyncWork()` replace ad-hoc queue waits in test bodies.
+- `scope.startInFlight(operation)` starts background Promise work now and
+  returns a handle with `wait()` and `rejects(...)`. The task must settle and
+  be observed before the test ends.
+
 Reporter lifecycle:
 
 - `RealTimeReporter` receives `ReporterEvent` values while a run executes.

package/sbom.cdx.json

@@ -16,9 +16,9 @@
         "component": {
             "type": "library",
             "name": "@overkill-dev/engine",
-            "version": "0.0.31",
-            "bom-ref": "pkg:npm/@overkill-dev/engine@0.0.31",
-            "purl": "pkg:npm/@overkill-dev/engine@0.0.31"
+            "version": "0.0.33",
+            "bom-ref": "pkg:npm/@overkill-dev/engine@0.0.33",
+            "purl": "pkg:npm/@overkill-dev/engine@0.0.33"
         }
     },
     "components": [
@@ -54,7 +54,7 @@
             "ref": "pkg:npm/@enormora/wall-clock@0.0.3"
         },
         {
-            "ref": "pkg:npm/@overkill-dev/engine@0.0.31",
+            "ref": "pkg:npm/@overkill-dev/engine@0.0.33",
             "dependsOn": [
                 "pkg:npm/@enormora/wall-clock@0.0.3",
                 "pkg:npm/diff@9.0.0"