Module

std/testing/bdd.ts

Deno standard library
Go to Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/** A [BDD](https://en.wikipedia.org/wiki/Behavior-driven_development) interface * to `Deno.test()` API. * * With the `bdd.ts` module you can write your tests in a familiar format for * grouping tests and adding setup/teardown hooks used by other JavaScript testing * frameworks like Jasmine, Jest, and Mocha. * * The `describe` function creates a block that groups together several related * tests. The `it` function registers an individual test case. * * ## Hooks * * There are 4 types of hooks available for test suites. A test suite can have * multiples of each type of hook, they will be called in the order that they are * registered. The `afterEach` and `afterAll` hooks will be called whether or not * the test case passes. The *All hooks will be called once for the whole group * while the *Each hooks will be called for each individual test case. * * - `beforeAll`: Runs before all of the tests in the test suite. * - `afterAll`: Runs after all of the tests in the test suite finish. * - `beforeEach`: Runs before each of the individual test cases in the test suite. * - `afterEach`: Runs after each of the individual test cases in the test suite. * * If a hook is registered at the top level, a global test suite will be registered * and all tests will belong to it. Hooks registered at the top level must be * registered before any individual test cases or test suites. * * ## Focusing tests * * If you would like to run only specific test cases, you can do so by calling * `it.only` instead of `it`. If you would like to run only specific test suites, * you can do so by calling `describe.only` instead of `describe`. * * There is one limitation to this when using the flat test grouping style. When * `describe` is called without being nested, it registers the test with * `Deno.test`. If a child test case or suite is registered with `it.only` or * `describe.only`, it will be scoped to the top test suite instead of the file. To * make them the only tests that run in the file, you would need to register the * top test suite with `describe.only` too. * * ## Ignoring tests * * If you would like to not run specific individual test cases, you can do so by * calling `it.ignore` instead of `it`. If you would like to not run specific test * suites, you can do so by calling `describe.ignore` instead of `describe`. * * ## Sanitization options * * Like `Deno.TestDefinition`, the `DescribeDefinition` and `ItDefinition` have * sanitization options. They work in the same way. * * - `sanitizeExit`: Ensure the test case does not prematurely cause the process to * exit, for example via a call to Deno.exit. Defaults to true. * - `sanitizeOps`: Check that the number of async completed ops after the test is * the same as number of dispatched ops. Defaults to true. * - `sanitizeResources`: Ensure the test case does not "leak" resources - ie. the * resource table after the test has exactly the same contents as before the * test. Defaults to true. * * ## Permissions option * * Like `Deno.TestDefinition`, the `DescribeDefintion` and `ItDefinition` have a * `permissions` option. They specify the permissions that should be used to run an * individual test case or test suite. Set this to `"inherit"` to keep the calling * thread's permissions. Set this to `"none"` to revoke all permissions. * * This setting defaults to `"inherit"`. * * There is currently one limitation to this, you cannot use the permissions option * on an individual test case or test suite that belongs to another test suite. * That's because internally those tests are registered with `t.step` which does * not support the permissions option. * * ## Comparing to Deno\.test * * The default way of writing tests is using `Deno.test` and `t.step`. The * `describe` and `it` functions have similar call signatures to `Deno.test`, * making it easy to switch between the default style and the behavior-driven * development style of writing tests. Internally, `describe` and `it` are * registering tests with `Deno.test` and `t.step`. * * Below is an example of a test file using `Deno.test` and `t.step`. In the * following sections there are examples of how the same test could be written with * `describe` and `it` using nested test grouping, flat test grouping, or a mix of * both styles. * * ```ts * // https://deno.land/std@$STD_VERSION/testing/bdd_examples/user_test.ts * import { * assertEquals, * assertStrictEquals, * assertThrows, * } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts"; * import { User } from "https://deno.land/std@$STD_VERSION/testing/bdd_examples/user.ts"; * * Deno.test("User.users initially empty", () => { * assertEquals(User.users.size, 0); * }); * * Deno.test("User constructor", () => { * try { * const user = new User("Kyle"); * assertEquals(user.name, "Kyle"); * assertStrictEquals(User.users.get("Kyle"), user); * } finally { * User.users.clear(); * } * }); * * Deno.test("User age", async (t) => { * const user = new User("Kyle"); * * await t.step("getAge", () => { * assertThrows(() => user.getAge(), Error, "Age unknown"); * user.age = 18; * assertEquals(user.getAge(), 18); * }); * * await t.step("setAge", () => { * user.setAge(18); * assertEquals(user.getAge(), 18); * }); * }); * ``` * * ### Nested test grouping * * Tests created within the callback of a `describe` function call will belong to * the new test suite it creates. The hooks can be created within it or be added to * the options argument for describe. * * ```ts * // https://deno.land/std@$STD_VERSION/testing/bdd_examples/user_nested_test.ts * import { * assertEquals, * assertStrictEquals, * assertThrows, * } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts"; * import { * afterEach, * beforeEach, * describe, * it, * } from "https://deno.land/std@$STD_VERSION/testing/bdd.ts"; * import { User } from "https://deno.land/std@$STD_VERSION/testing/bdd_examples/user.ts"; * * describe("User", () => { * it("users initially empty", () => { * assertEquals(User.users.size, 0); * }); * * it("constructor", () => { * try { * const user = new User("Kyle"); * assertEquals(user.name, "Kyle"); * assertStrictEquals(User.users.get("Kyle"), user); * } finally { * User.users.clear(); * } * }); * * describe("age", () => { * let user: User; * * beforeEach(() => { * user = new User("Kyle"); * }); * * afterEach(() => { * User.users.clear(); * }); * * it("getAge", function () { * assertThrows(() => user.getAge(), Error, "Age unknown"); * user.age = 18; * assertEquals(user.getAge(), 18); * }); * * it("setAge", function () { * user.setAge(18); * assertEquals(user.getAge(), 18); * }); * }); * }); * ``` * * ### Flat test grouping * * The `describe` function returns a unique symbol that can be used to reference * the test suite for adding tests to it without having to create them within a * callback. The gives you the ability to have test grouping without any extra * indentation in front of the grouped tests. * * ```ts * // https://deno.land/std@$STD_VERSION/testing/bdd_examples/user_flat_test.ts * import { * assertEquals, * assertStrictEquals, * assertThrows, * } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts"; * import { * describe, * it, * } from "https://deno.land/std@$STD_VERSION/testing/bdd.ts"; * import { User } from "https://deno.land/std@$STD_VERSION/testing/bdd_examples/user.ts"; * * const userTests = describe("User"); * * it(userTests, "users initially empty", () => { * assertEquals(User.users.size, 0); * }); * * it(userTests, "constructor", () => { * try { * const user = new User("Kyle"); * assertEquals(user.name, "Kyle"); * assertStrictEquals(User.users.get("Kyle"), user); * } finally { * User.users.clear(); * } * }); * * const ageTests = describe({ * name: "age", * suite: userTests, * beforeEach(this: { user: User }) { * this.user = new User("Kyle"); * }, * afterEach() { * User.users.clear(); * }, * }); * * it(ageTests, "getAge", function () { * const { user } = this; * assertThrows(() => user.getAge(), Error, "Age unknown"); * user.age = 18; * assertEquals(user.getAge(), 18); * }); * * it(ageTests, "setAge", function () { * const { user } = this; * user.setAge(18); * assertEquals(user.getAge(), 18); * }); * ``` * * ### Mixed test grouping * * Both nested test grouping and flat test grouping can be used together. This can * be useful if you'd like to create deep groupings without all the extra * indentation in front of each line. * * ```ts * // https://deno.land/std@$STD_VERSION/testing/bdd_examples/user_mixed_test.ts * import { * assertEquals, * assertStrictEquals, * assertThrows, * } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts"; * import { * describe, * it, * } from "https://deno.land/std@$STD_VERSION/testing/bdd.ts"; * import { User } from "https://deno.land/std@$STD_VERSION/testing/bdd_examples/user.ts"; * * describe("User", () => { * it("users initially empty", () => { * assertEquals(User.users.size, 0); * }); * * it("constructor", () => { * try { * const user = new User("Kyle"); * assertEquals(user.name, "Kyle"); * assertStrictEquals(User.users.get("Kyle"), user); * } finally { * User.users.clear(); * } * }); * * const ageTests = describe({ * name: "age", * beforeEach(this: { user: User }) { * this.user = new User("Kyle"); * }, * afterEach() { * User.users.clear(); * }, * }); * * it(ageTests, "getAge", function () { * const { user } = this; * assertThrows(() => user.getAge(), Error, "Age unknown"); * user.age = 18; * assertEquals(user.getAge(), 18); * }); * * it(ageTests, "setAge", function () { * const { user } = this; * user.setAge(18); * assertEquals(user.getAge(), 18); * }); * }); * ``` * * @module */
import { DescribeDefinition, HookNames, ItDefinition, TestSuite, TestSuiteInternal,} from "./_test_suite.ts";export type { DescribeDefinition, ItDefinition, TestSuite };
/** The arguments for an ItFunction. */export type ItArgs<T> = | [options: ItDefinition<T>] | [ name: string, options: Omit<ItDefinition<T>, "name">, ] | [ name: string, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [fn: (this: T, t: Deno.TestContext) => void | Promise<void>] | [ name: string, options: Omit<ItDefinition<T>, "fn" | "name">, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [ options: Omit<ItDefinition<T>, "fn">, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [ options: Omit<ItDefinition<T>, "fn" | "name">, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [ suite: TestSuite<T>, name: string, options: Omit<ItDefinition<T>, "name" | "suite">, ] | [ suite: TestSuite<T>, name: string, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [ suite: TestSuite<T>, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [ suite: TestSuite<T>, name: string, options: Omit<ItDefinition<T>, "fn" | "name" | "suite">, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [ suite: TestSuite<T>, options: Omit<ItDefinition<T>, "fn" | "suite">, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ] | [ suite: TestSuite<T>, options: Omit<ItDefinition<T>, "fn" | "name" | "suite">, fn: (this: T, t: Deno.TestContext) => void | Promise<void>, ];
/** Generates an ItDefinition from ItArgs. */function itDefinition<T>(...args: ItArgs<T>): ItDefinition<T> { let [ suiteOptionsOrNameOrFn, optionsOrNameOrFn, optionsOrFn, fn, ] = args; let suite: TestSuite<T> | undefined = undefined; let name: string; let options: | ItDefinition<T> | Omit<ItDefinition<T>, "fn"> | Omit<ItDefinition<T>, "name"> | Omit<ItDefinition<T>, "fn" | "name">; if ( typeof suiteOptionsOrNameOrFn === "object" && typeof (suiteOptionsOrNameOrFn as TestSuite<T>).symbol === "symbol" ) { suite = suiteOptionsOrNameOrFn as TestSuite<T>; } else { fn = optionsOrFn as typeof fn; optionsOrFn = optionsOrNameOrFn as typeof optionsOrFn; optionsOrNameOrFn = suiteOptionsOrNameOrFn as typeof optionsOrNameOrFn; } if (typeof optionsOrNameOrFn === "string") { name = optionsOrNameOrFn; if (typeof optionsOrFn === "function") { fn = optionsOrFn; options = {}; } else { options = optionsOrFn!; if (!fn) fn = (options as Omit<ItDefinition<T>, "name">).fn; } } else if (typeof optionsOrNameOrFn === "function") { fn = optionsOrNameOrFn; name = fn.name; options = {}; } else { options = optionsOrNameOrFn!; if (typeof optionsOrFn === "function") { fn = optionsOrFn; } else { fn = (options as ItDefinition<T>).fn; } name = (options as ItDefinition<T>).name ?? fn.name; }
return { suite, ...options, name, fn, };}
/** Registers an individual test case. */export interface it { <T>(...args: ItArgs<T>): void;
/** Registers an individual test case with only set to true. */ only<T>(...args: ItArgs<T>): void;
/** Registers an individual test case with ignore set to true. */ ignore<T>(...args: ItArgs<T>): void;}
/** Registers an individual test case. */export function it<T>(...args: ItArgs<T>) { if (TestSuiteInternal.runningCount > 0) { throw new Error( "cannot register new test cases after already registered test cases start running", ); } const options = itDefinition(...args); const { suite } = options; const testSuite = suite ? TestSuiteInternal.suites.get(suite.symbol) : TestSuiteInternal.current;
if (!TestSuiteInternal.started) TestSuiteInternal.started = true; if (testSuite) { TestSuiteInternal.addStep(testSuite, options); } else { const { name, fn, ignore, only, permissions, sanitizeExit, sanitizeOps, sanitizeResources, } = options; TestSuiteInternal.registerTest({ name, ignore, only, permissions, sanitizeExit, sanitizeOps, sanitizeResources, async fn(t) { TestSuiteInternal.runningCount++; try { await fn.call({} as T, t); } finally { TestSuiteInternal.runningCount--; } }, }); }}
it.only = function itOnly<T>(...args: ItArgs<T>) { const options = itDefinition(...args); return it({ ...options, only: true, });};
it.ignore = function itIgnore<T>(...args: ItArgs<T>) { const options = itDefinition(...args); return it({ ...options, ignore: true, });};
function addHook<T>( name: HookNames, fn: (this: T) => void | Promise<void>,) { if (!TestSuiteInternal.current) { if (TestSuiteInternal.started) { throw new Error( "cannot add global hooks after a global test is registered", ); } TestSuiteInternal.current = new TestSuiteInternal({ name: "global", [name]: fn, }); } else { TestSuiteInternal.setHook(TestSuiteInternal.current!, name, fn); }}
/** Run some shared setup before all of the tests in the suite. */export function beforeAll<T>( fn: (this: T) => void | Promise<void>,) { addHook("beforeAll", fn);}
/** Run some shared teardown after all of the tests in the suite. */export function afterAll<T>( fn: (this: T) => void | Promise<void>,) { addHook("afterAll", fn);}
/** Run some shared setup before each test in the suite. */export function beforeEach<T>( fn: (this: T) => void | Promise<void>,) { addHook("beforeEach", fn);}
/** Run some shared teardown after each test in the suite. */export function afterEach<T>( fn: (this: T) => void | Promise<void>,) { addHook("afterEach", fn);}
/** The arguments for a DescribeFunction. */export type DescribeArgs<T> = | [options: DescribeDefinition<T>] | [name: string] | [ name: string, options: Omit<DescribeDefinition<T>, "name">, ] | [name: string, fn: () => void] | [fn: () => void] | [ name: string, options: Omit<DescribeDefinition<T>, "fn" | "name">, fn: () => void, ] | [ options: Omit<DescribeDefinition<T>, "fn">, fn: () => void, ] | [ options: Omit<DescribeDefinition<T>, "fn" | "name">, fn: () => void, ] | [ suite: TestSuite<T>, name: string, ] | [ suite: TestSuite<T>, name: string, options: Omit<DescribeDefinition<T>, "name" | "suite">, ] | [ suite: TestSuite<T>, name: string, fn: () => void, ] | [ suite: TestSuite<T>, fn: () => void, ] | [ suite: TestSuite<T>, name: string, options: Omit<DescribeDefinition<T>, "fn" | "name" | "suite">, fn: () => void, ] | [ suite: TestSuite<T>, options: Omit<DescribeDefinition<T>, "fn" | "suite">, fn: () => void, ] | [ suite: TestSuite<T>, options: Omit<DescribeDefinition<T>, "fn" | "name" | "suite">, fn: () => void, ];
/** Generates a DescribeDefinition from DescribeArgs. */function describeDefinition<T>( ...args: DescribeArgs<T>): DescribeDefinition<T> { let [ suiteOptionsOrNameOrFn, optionsOrNameOrFn, optionsOrFn, fn, ] = args; let suite: TestSuite<T> | undefined = undefined; let name: string; let options: | DescribeDefinition<T> | Omit<DescribeDefinition<T>, "fn"> | Omit<DescribeDefinition<T>, "name"> | Omit<DescribeDefinition<T>, "fn" | "name">; if ( typeof suiteOptionsOrNameOrFn === "object" && typeof (suiteOptionsOrNameOrFn as TestSuite<T>).symbol === "symbol" ) { suite = suiteOptionsOrNameOrFn as TestSuite<T>; } else { fn = optionsOrFn as typeof fn; optionsOrFn = optionsOrNameOrFn as typeof optionsOrFn; optionsOrNameOrFn = suiteOptionsOrNameOrFn as typeof optionsOrNameOrFn; } if (typeof optionsOrNameOrFn === "string") { name = optionsOrNameOrFn; if (typeof optionsOrFn === "function") { fn = optionsOrFn; options = {}; } else { options = optionsOrFn ?? {}; if (!fn) fn = (options as Omit<DescribeDefinition<T>, "name">).fn; } } else if (typeof optionsOrNameOrFn === "function") { fn = optionsOrNameOrFn; name = fn.name; options = {}; } else { options = optionsOrNameOrFn ?? {}; if (typeof optionsOrFn === "function") { fn = optionsOrFn; } else { fn = (options as DescribeDefinition<T>).fn; } name = (options as DescribeDefinition<T>).name ?? fn?.name ?? ""; }
if (!suite) { suite = options.suite; } if (!suite && TestSuiteInternal.current) { const { symbol } = TestSuiteInternal.current; suite = { symbol }; }
return { ...options, suite, name, fn, };}
/** Registers a test suite. */export interface describe { <T>(...args: DescribeArgs<T>): TestSuite<T>;
/** Registers a test suite with only set to true. */ only<T>(...args: DescribeArgs<T>): TestSuite<T>;
/** Registers a test suite with ignore set to true. */ ignore<T>(...args: DescribeArgs<T>): TestSuite<T>;}
/** Registers a test suite. */export function describe<T>( ...args: DescribeArgs<T>): TestSuite<T> { if (TestSuiteInternal.runningCount > 0) { throw new Error( "cannot register new test suites after already registered test cases start running", ); } const options = describeDefinition(...args); if (!TestSuiteInternal.started) TestSuiteInternal.started = true; const { symbol } = new TestSuiteInternal(options); return { symbol };}
describe.only = function describeOnly<T>( ...args: DescribeArgs<T>): TestSuite<T> { const options = describeDefinition(...args); return describe({ ...options, only: true, });};
describe.ignore = function describeIgnore<T>( ...args: DescribeArgs<T>): TestSuite<T> { const options = describeDefinition(...args); return describe({ ...options, ignore: true, });};