Test Suite

An extension of Deno’s built-in test runner to add setup/teardown hooks and the ability to organize tests. Includes describe/it functions for creating nested tests in a format similar to Jasmine, Jest, and Mocha.

Features

Ability to group tests together into test suites
Setup/teardown hooks for test suites(beforeAll, afterAll, beforeEach, afterEach)
Tests within a test suite inherit configuration options
describe/it functions similar to Jasmine, Jest, and Mocha

Installation

To include this module in a Deno project, you can import directly from the TS files. This module is available in Deno’s third part module registry but can also be imported directly from GitHub using raw content URLs.

// Import from Deno's third party module registry
import { TestSuite, test } from "https://deno.land/x/test_suite@0.9.5/mod.ts";
// Import from GitHub
import { TestSuite, test } "https://raw.githubusercontent.com/udibo/test_suite/0.9.5/mod.ts";

Usage

Below are some examples of how to use TestSuite and test in tests.

See deno docs for more information.

TestSuite

When you have a set of tests that are related, you can group them together by creating a test suite. A test suite can contain other test suites and tests. All tests within a suite will inherit their options from the suite unless they specifically set them.

The beforeAll and afterAll hook options can be used to do something before and after all the tests in the suite run. If you would like to set values for all tests within the suite, you can create a context interface that defines all the values available to the tests that are defined in the beforeAll function.

The beforeEach and afterEach hook options are similar to beforeAll and afterAll except they are called before and after each individual test.

The example test below can be found in the example directory.

import { test, TestSuite } from "https://deno.land/x/test_suite@0.9.5/mod.ts";
import { assertEquals } from "https://deno.land/std@0.120.0/testing/asserts.ts";
import {
  getUser,
  resetUsers,
  User,
} from "https://deno.land/x/test_suite@0.9.5/example/user.ts";

interface UserSuiteContext {
  user: User;
}
const userSuite: TestSuite<UserSuiteContext> = new TestSuite({
  name: "user",
  beforeEach(context: UserSuiteContext) {
    context.user = new User("Kyle June");
  },
  afterEach() {
    resetUsers();
  },
});

test(userSuite, "create", () => {
  const user = new User("John Doe");
  assertEquals(user.name, "John Doe");
});

const getUserSuite: TestSuite<UserSuiteContext> = new TestSuite({
  name: "getUser",
  suite: userSuite,
});

test(getUserSuite, "user does not exist", () => {
  assertEquals(getUser("John Doe"), undefined);
});

test(getUserSuite, "user exists", (context: UserSuiteContext) => {
  assertEquals(getUser("Kyle June"), context.user);
});

test(userSuite, "resetUsers", (context: UserSuiteContext) => {
  assertEquals(getUser("Kyle June"), context.user);
  resetUsers();
  assertEquals(getUser("Kyle June"), undefined);
});

If you run the above tests using deno test, you will get the following output. Each test name is prefixed with the suite name.

$ deno test
running 4 tests
test user create ... ok (4ms)
test user getUser user does not exist ... ok (1ms)
test user getUser user exists ... ok (2ms)
test user resetUsers ... ok (2ms)

test result: ok. 4 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out (11ms)

describe/it

When you have a set of tests that are related, you can group them together by creating a test suite with describe. A test suite can contain other test suites and tests. All tests within a suite will inherit their options from the suite unless they specifically set them.

The beforeEach and afterEach hook options are similar to beforeAll and afterAll except they are called before and after each individual test.

The example test below can be found in the example directory.

import {
  afterEach,
  beforeEach,
  describe,
  it,
} from "https://deno.land/x/test_suite@0.9.5/mod.ts";
import { assertEquals } from "https://deno.land/std@0.120.0/testing/asserts.ts";
import {
  getUser,
  resetUsers,
  User,
} from "https://deno.land/x/test_suite@0.9.5/examples/user.ts";

describe("user describe", () => {
  let user: User;

  beforeEach(() => {
    user = new User("Kyle June");
  });

  afterEach(() => {
    resetUsers();
  });

  it("create", () => {
    const user = new User("John Doe");
    assertEquals(user.name, "John Doe");
  });

  describe("getUser", () => {
    it("user does not exist", () => {
      assertEquals(getUser("John Doe"), undefined);
    });

    it("user exists", () => {
      assertEquals(getUser("Kyle June"), user);
    });
  });

  it("resetUsers", () => {
    assertEquals(getUser("Kyle June"), user);
    resetUsers();
    assertEquals(getUser("Kyle June"), undefined);
  });
});

If you run the above tests using deno test, you will get the following output. Each test name is prefixed with the suite name.

$ deno test
running 4 tests
test user describe create ... ok (4ms)
test user describe getUser user does not exist ... ok (1ms)
test user describe getUser user exists ... ok (2ms)
test user describe resetUsers ... ok (2ms)

test result: ok. 4 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out (11ms)

License

MIT