9a859318d6
We would resolve the wrong package.json, resulting in an inability to run CJS (or other node-mode) scripts |
||
---|---|---|
.. | ||
bench | ||
bundle/lockfile | ||
cache | ||
cert | ||
check | ||
cli/help_and_version_broken_pipe | ||
compile | ||
coverage | ||
eval/env_unparsable_file | ||
flags | ||
fmt | ||
future | ||
import_map/import_map_config | ||
info | ||
init/lib | ||
install | ||
jsr | ||
jupyter/install_command | ||
lint | ||
lockfile | ||
node | ||
npm | ||
permission | ||
publish | ||
run | ||
serve | ||
task | ||
test | ||
workspaces | ||
mod.rs | ||
README.md | ||
schema.json |
specs
These are integration tests that execute the deno
binary. They supersede the
itest
macro found in the tests/integration
folder and are the preferred way
of writing tests that use the deno
binary.
Structure
Tests must have the following directory structure:
tests/specs/<category_name>/<test_name>/__test__.json
Test filtering
To run a specific test, run:
cargo test specs::category_name::test_name
Or just the following, though it might run other tests:
cargo test test_name
To run showing the output of every test use -- --nocapture
(note: this will
cause tests to run sequentially instead of in parallel):
cargo test test_name -- --nocapture
__test__.json
file
This file describes the test(s) to execute and the steps to execute. A basic example looks like:
{
"args": "run main.js",
"output": "main.out"
}
This will run deno run main.js
then assert that the output matches the text in
main.out
.
Or another example that runs multiple steps:
{
"tempDir": true,
"steps": [{
"args": "cache main.ts",
"output": "cache.out"
}, {
"args": "run main.ts",
"output": "error.out",
"exitCode": 1
}]
}
Or if you want to run several tests at the same time:
{
"tests": {
"ignore_dir": {
"args": "run script.ts",
"output": "script.out"
},
"some_other_test": {
"args": "run other.ts",
"output": "other.out"
}
}
}
Top level properties
repeat
(number) - Number of times to repeat a test.tempDir
(boolean) - Copy all the non-test files to a temporary directory and execute the command in that temporary directory.- By default, tests are executed with a current working directory of the test, but this may not be desirable for tests such as ones that create a node_modules directory.
Step properties
When writing a single step, these may be at the top level rather than nested in a "steps" array or "tests" object.
args
- A string (that will be spilt on whitespace into an args array) or an array of arguments.output
- Path to use to assert the output or text (must end with an .out extension) or text to pattern match against the output.flaky
- Step should be repeated until success a maximum of 3 times.if
("windows"
,"linux"
,"mac"
,"unix"
) - Whether to run this step.exitCode
(number) - Expected exit code.
Auto-complete
To get auto-complete for these files, add the following to a local
.vscode/settings.json
file:
{
"json.schemas": [{
"fileMatch": [
"__test__.jsonc"
],
"url": "./tests/specs/schema.json"
}]
}
.out
files
.out
files are used to assert the output when running a test or test step.
Within the file, you can use the following for matching:
[WILDCARD]
- match any text at the wildcard[WILDLINE]
- match any text on the current line[WILDCHAR]
- match the next character[WILDCHARS(5)]
- match any of the next 5 characters[UNORDERED_START]
followed by many lines then[UNORDERED_END]
will match the lines in any order (useful for non-deterministic output)[# example]
- line comments start with[#
and end with]