Skip to content

Commit

Permalink
feat(test): Add "name", "origin" and "parent" to "Deno.TestContext" (#…
Browse files Browse the repository at this point in the history
…14007)

This commit adds following fields to "Deno.TestContext" interface:
- name
- origin
- parent

These are prerequisites for supporting snapshot functionality in
"std/testing".
  • Loading branch information
hyp3rflow authored Apr 6, 2022
1 parent e33329b commit 0df1854
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 2 deletions.
19 changes: 19 additions & 0 deletions cli/dts/lib.deno.ns.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,19 @@ declare namespace Deno {
}

export interface TestContext {
/**
* The current test name.
*/
name: string;
/**
* File Uri of the current test code.
*/
origin: string;
/**
* Parent test context.
*/
parent?: TestContext;

/** Run a sub step of the parent test or step. Returns a promise
* that resolves to a boolean signifying if the step completed successfully.
* The returned promise never rejects unless the arguments are invalid.
Expand All @@ -270,6 +283,9 @@ declare namespace Deno {

export interface TestStepDefinition {
fn: (t: TestContext) => void | Promise<void>;
/**
* The current test name.
*/
name: string;
ignore?: boolean;
/** Check that the number of async completed ops after the test step is the same
Expand All @@ -287,6 +303,9 @@ declare namespace Deno {

export interface TestDefinition {
fn: (t: TestContext) => void | Promise<void>;
/**
* The current test name.
*/
name: string;
ignore?: boolean;
/** If at least one test has `only` set to true, only run tests that have
Expand Down
32 changes: 31 additions & 1 deletion cli/tests/unit/testing_test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
import { assertRejects, assertThrows } from "./test_util.ts";
import { assertEquals, assertRejects, assertThrows } from "./test_util.ts";

Deno.test(function testWrongOverloads() {
assertThrows(
Expand Down Expand Up @@ -117,3 +117,33 @@ Deno.test(async function invalidStepArguments(t) {
"Expected a test definition or name and function.",
);
});

Deno.test(async function nameOnTextContext(t1) {
await assertEquals(t1.name, "nameOnTextContext");
await t1.step("step", async (t2) => {
await assertEquals(t2.name, "step");
await t2.step("nested step", async (t3) => {
await assertEquals(t3.name, "nested step");
});
});
});

Deno.test(async function originOnTextContext(t1) {
await assertEquals(t1.origin, Deno.mainModule);
await t1.step("step", async (t2) => {
await assertEquals(t2.origin, Deno.mainModule);
await t2.step("nested step", async (t3) => {
await assertEquals(t3.origin, Deno.mainModule);
});
});
});

Deno.test(async function parentOnTextContext(t1) {
await assertEquals(t1.parent, undefined);
await t1.step("step", async (t2) => {
await assertEquals(t1, t2.parent);
await t2.step("nested step", async (t3) => {
await assertEquals(t2, t3.parent);
});
});
});
21 changes: 20 additions & 1 deletion runtime/js/40_testing.js
Original file line number Diff line number Diff line change
Expand Up @@ -792,6 +792,7 @@
const step = new TestStep({
name: test.name,
parent: undefined,
parentContext: undefined,
rootTestDescription: description,
sanitizeOps: test.sanitizeOps,
sanitizeResources: test.sanitizeResources,
Expand Down Expand Up @@ -1064,8 +1065,9 @@
* }} TestStepDefinition
*
* @typedef {{
* name: string;
* name: string,
* parent: TestStep | undefined,
* parentContext: TestContext | undefined,
* rootTestDescription: { origin: string; name: string };
* sanitizeOps: boolean,
* sanitizeResources: boolean,
Expand Down Expand Up @@ -1099,6 +1101,10 @@
return this.#params.parent;
}

get parentContext() {
return this.#params.parentContext;
}

get rootTestDescription() {
return this.#params.rootTestDescription;
}
Expand Down Expand Up @@ -1268,6 +1274,18 @@
function createTestContext(parentStep) {
return {
[SymbolToStringTag]: "TestContext",
/**
* The current test name.
*/
name: parentStep.name,
/**
* Parent test context.
*/
parent: parentStep.parentContext ?? undefined,
/**
* File Uri of the test code.
*/
origin: parentStep.rootTestDescription.origin,
/**
* @param nameOrTestDefinition {string | TestStepDefinition}
* @param fn {(t: TestContext) => void | Promise<void>}
Expand All @@ -1284,6 +1302,7 @@
const subStep = new TestStep({
name: definition.name,
parent: parentStep,
parentContext: this,
rootTestDescription: parentStep.rootTestDescription,
sanitizeOps: getOrDefault(
definition.sanitizeOps,
Expand Down

0 comments on commit 0df1854

Please sign in to comment.