mirror of
https://github.com/denoland/deno.git
synced 2024-11-23 15:16:54 -05:00
caa383a583
After some discussion it was found that assertEquals is more common
in JS (vs assertEqual, assertEq) and sounds better in the negated form:
assertNotEquals vs assertNE.
Original: 4cf39d4a14
133 lines
3.3 KiB
Markdown
133 lines
3.3 KiB
Markdown
# Testing
|
|
|
|
This module provides a few basic utilities to make testing easier and
|
|
consistent in Deno.
|
|
|
|
## Usage
|
|
|
|
The module exports a `test` function which is the test harness in Deno. It
|
|
accepts either a function (including async functions) or an object which
|
|
contains a `name` property and a `fn` property. When running tests and
|
|
outputting the results, the name of the past function is used, or if the
|
|
object is passed, the `name` property is used to identify the test.
|
|
|
|
Asserts are exposed in `testing/asserts.ts` module.
|
|
|
|
- `equal` - Deep comparision function, where `actual` and `expected` are
|
|
compared deeply, and if they vary, `equal` returns `false`.
|
|
- `assert()` - Expects a boolean value, throws if the value is `false`.
|
|
- `assertEquals()` - Uses the `equal` comparison and throws if the `actual` and
|
|
`expected` are not equal.
|
|
- `assertStrictEq()` - Compares `actual` and `expected` strictly, therefore
|
|
for non-primitives the values must reference the same instance.
|
|
- `assertThrows()` - Expects the passed `fn` to throw. If `fn` does not throw,
|
|
this function does. Also compares any errors thrown to an optional expected
|
|
`Error` class and checks that the error `.message` includes an optional
|
|
string.
|
|
- `assertThrowsAsync()` - Expects the passed `fn` to be async and throw (or
|
|
return a `Promise` that rejects). If the `fn` does not throw or reject, this
|
|
function will throw asynchronously. Also compares any errors thrown to an
|
|
optional expected `Error` class and checks that the error `.message` includes
|
|
an optional string.
|
|
|
|
`runTests()` executes the declared tests.
|
|
|
|
Basic usage:
|
|
|
|
```ts
|
|
import { runTests, test } from "https://deno.land/std/testing/mod.ts";
|
|
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
|
|
|
|
test({
|
|
name: "testing example",
|
|
fn() {
|
|
assertEquals("world", "world"));
|
|
assertEquals({ hello: "world" }, { hello: "world" }));
|
|
}
|
|
});
|
|
|
|
runTests();
|
|
```
|
|
|
|
Short syntax (named function instead of object):
|
|
|
|
```ts
|
|
test(function example() {
|
|
assertEquals("world", "world"));
|
|
assertEquals({ hello: "world" }, { hello: "world" }));
|
|
});
|
|
```
|
|
|
|
Using `assertStrictEq()`:
|
|
|
|
```ts
|
|
test(function isStrictlyEqual() {
|
|
const a = {};
|
|
const b = a;
|
|
assertStrictEq(a, b);
|
|
});
|
|
|
|
// This test fails
|
|
test(function isNotStrictlyEqual() {
|
|
const a = {};
|
|
const b = {};
|
|
assertStrictEq(a, b);
|
|
});
|
|
```
|
|
|
|
Using `assertThrows()`:
|
|
|
|
```ts
|
|
test(function doesThrow() {
|
|
assertThrows(() => {
|
|
throw new TypeError("hello world!");
|
|
});
|
|
assertThrows(() => {
|
|
throw new TypeError("hello world!");
|
|
}, TypeError);
|
|
assertThrows(
|
|
() => {
|
|
throw new TypeError("hello world!");
|
|
},
|
|
TypeError,
|
|
"hello"
|
|
);
|
|
});
|
|
|
|
// This test will not pass
|
|
test(function fails() {
|
|
assertThrows(() => {
|
|
console.log("Hello world");
|
|
});
|
|
});
|
|
```
|
|
|
|
Using `assertThrowsAsync()`:
|
|
|
|
```ts
|
|
test(async function doesThrow() {
|
|
assertThrowsAsync(async () => {
|
|
throw new TypeError("hello world!");
|
|
});
|
|
assertThrowsAsync(async () => {
|
|
throw new TypeError("hello world!");
|
|
}, TypeError);
|
|
assertThrowsAsync(
|
|
async () => {
|
|
throw new TypeError("hello world!");
|
|
},
|
|
TypeError,
|
|
"hello"
|
|
);
|
|
assertThrowsAsync(async () => {
|
|
return Promise.reject(new Error());
|
|
});
|
|
});
|
|
|
|
// This test will not pass
|
|
test(async function fails() {
|
|
assertThrowsAsync(async () => {
|
|
console.log("Hello world");
|
|
});
|
|
});
|
|
```
|