Add assert and mock to context (#20)

Author: davidjgoss

api-report.md

@@ -1,82 +1,85 @@
-## API Report File for "@cucumber/node"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { Promisable } from 'type-fest';
-import { Readable } from 'node:stream';
-
-// @public
-export function After(fn: HookFunction): void;
-
-// @public
-export function After(options: HookOptions, fn: HookFunction): void;
-
-// @public
-export type AttachmentOptions = {
-    mediaType: string;
-    fileName?: string;
-};
-
-// @public
-export function Before(fn: HookFunction): void;
-
-// @public
-export function Before(options: HookOptions, fn: HookFunction): void;
-
-// @public
-export class DataTable {
-    constructor(cells: ReadonlyArray<ReadonlyArray<string>>);
-    hashes(): ReadonlyArray<Record<string, string>>;
-    list(): ReadonlyArray<string>;
-    raw(): ReadonlyArray<ReadonlyArray<string>>;
-    transpose(): DataTable;
-}
-
-// @public
-export function Given(text: string, fn: StepFunction): void;
-
-// @public
-export type HookFunction = (context: TestCaseContext) => Promisable<void>;
-
-// @public
-export type HookOptions = {
-    name?: string;
-    tagFilter?: string;
-};
-
-// @public
-export function ParameterType(options: ParameterTypeOptions): void;
-
-// @public
-export type ParameterTypeOptions = {
-    name: string;
-    regexp: RegExp | string | readonly RegExp[] | readonly string[];
-    transformer?: (...match: string[]) => unknown;
-    useForSnippets?: boolean;
-    preferForRegexpMatch?: boolean;
-};
-
-// @public
-export type StepFunction = (context: TestCaseContext, ...args: any) => Promisable<void>;
-
-// @public
-export type TestCaseContext = {
-    skip(): void;
-    todo(): void;
-    attach(data: Readable | Buffer | string, options: AttachmentOptions): Promise<void>;
-    log(text: string): Promise<void>;
-    link(url: string, title?: string): Promise<void>;
-    world: any;
-};
-
-// @public
-export function Then(text: string, fn: StepFunction): void;
-
-// @public
-export function When(text: string, fn: StepFunction): void;
-
-// (No @packageDocumentation comment for this package)
-
-```
+## API Report File for "@cucumber/node"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Promisable } from 'type-fest';
+import { Readable } from 'node:stream';
+import { TestContext } from 'node:test';
+
+// @public
+export function After(fn: HookFunction): void;
+
+// @public
+export function After(options: HookOptions, fn: HookFunction): void;
+
+// @public
+export type AttachmentOptions = {
+    mediaType: string;
+    fileName?: string;
+};
+
+// @public
+export function Before(fn: HookFunction): void;
+
+// @public
+export function Before(options: HookOptions, fn: HookFunction): void;
+
+// @public
+export class DataTable {
+    constructor(cells: ReadonlyArray<ReadonlyArray<string>>);
+    hashes(): ReadonlyArray<Record<string, string>>;
+    list(): ReadonlyArray<string>;
+    raw(): ReadonlyArray<ReadonlyArray<string>>;
+    transpose(): DataTable;
+}
+
+// @public
+export function Given(text: string, fn: StepFunction): void;
+
+// @public
+export type HookFunction = (context: TestCaseContext) => Promisable<void>;
+
+// @public
+export type HookOptions = {
+    name?: string;
+    tagFilter?: string;
+};
+
+// @public
+export function ParameterType(options: ParameterTypeOptions): void;
+
+// @public
+export type ParameterTypeOptions = {
+    name: string;
+    regexp: RegExp | string | readonly RegExp[] | readonly string[];
+    transformer?: (...match: string[]) => unknown;
+    useForSnippets?: boolean;
+    preferForRegexpMatch?: boolean;
+};
+
+// @public
+export type StepFunction = (context: TestCaseContext, ...args: any) => Promisable<void>;
+
+// @public
+export type TestCaseContext = {
+    assert: TestContext['assert'];
+    mock: TestContext['mock'];
+    skip(): void;
+    todo(): void;
+    attach(data: Readable | Buffer | string, options: AttachmentOptions): Promise<void>;
+    log(text: string): Promise<void>;
+    link(url: string, title?: string): Promise<void>;
+    world: any;
+};
+
+// @public
+export function Then(text: string, fn: StepFunction): void;
+
+// @public
+export function When(text: string, fn: StepFunction): void;
+
+// (No @packageDocumentation comment for this package)
+
+```

src/runner/ContextTracker.ts

@@ -16,6 +16,8 @@ export class ContextTracker {
 
   makeContext(nodeTestContext: TestContext, testStepId: string): TestCaseContext {
     return {
+      assert: nodeTestContext.assert,
+      mock: nodeTestContext.mock,
       skip: () => {
         nodeTestContext.skip()
         this.outcomeKnown = true

src/types.ts

@@ -1,4 +1,5 @@
 import { Readable } from 'node:stream'
+import { TestContext } from 'node:test'
 
 import { Promisable } from 'type-fest'
 
@@ -26,6 +27,17 @@ export type AttachmentOptions = {
  * @public
  */
 export type TestCaseContext = {
+  /**
+   * The `assert` object as provided by the test runner, including the normal methods from
+   * `node:assert` plus extras for dealing with snapshots.
+   * @see https://nodejs.org/api/test.html#contextassert
+   */
+  assert: TestContext['assert']
+  /**
+   * The `mock` object as provided by the test runner.
+   * @see https://nodejs.org/api/test.html#class-mocktracker
+   */
+  mock: TestContext['mock']
   /**
    * Mark this test step as skipped. This will cause all subsequent steps to be skipped,
    * except `After` hooks.