1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-21 15:04:11 -05:00
denoland-deno/tests/specs
Asher Gomez 1a82b0f808
BREAKING(console): remove Deno.customInspect (#25348)
Note: this is implemented on Deploy. However, according to @magurotuna,
a thin compatibility layer might be in the works that'd prevent
breakages for PRs such as this one.

Towards #22079
2024-09-03 09:07:19 +00:00
..
add chore: remove DENO_FUTURE=1 from spec tests (#25329) 2024-08-31 21:25:32 +00:00
bench BREAKING: DENO_FUTURE=1 by default, or welcome to Deno 2.0 (#25213) 2024-08-30 13:58:58 -04:00
bundle/removed BREAKING: remove deno bundle (#25339) 2024-09-02 17:27:37 +02:00
cache BREAKING: DENO_FUTURE=1 by default, or welcome to Deno 2.0 (#25213) 2024-08-30 13:58:58 -04:00
cert BREAKING: remove deno bundle (#25339) 2024-09-02 17:27:37 +02:00
check feat: glob and directory support for deno check and deno cache cli arg paths (#25001) 2024-08-20 18:38:06 +00:00
clean/general feat(clean): add progress bar (#25026) 2024-08-14 13:04:07 +02:00
cli/help_and_version_broken_pipe fix: panic when piping "deno help" or "deno --version" (#22917) 2024-07-09 22:57:00 +00:00
compile chore: remove DENO_FUTURE=1 from spec tests (#25329) 2024-08-31 21:25:32 +00:00
coverage fix(coverage): Error if no files are included in the report (#22952) 2024-03-15 20:58:57 -07:00
eval/env_unparsable_file fix: --env flag confusing message on syntax error (#23915) 2024-05-27 15:06:18 +02:00
flags feat: add lowercase -v version flag (#23750) 2024-05-23 00:20:20 +00:00
fmt feat(fmt): support HTML, Svelte, Vue, Astro and Angular (#25019) 2024-08-14 22:58:48 +02:00
future BREAKING(console): remove Deno.customInspect (#25348) 2024-09-03 09:07:19 +00:00
import_map/import_map_config refactor: move importMap with imports/scopes diagnostic to deno_config (#24553) 2024-07-12 12:48:53 -04:00
info refactor: move redirect handling into deno_graph (#23444) 2024-04-19 01:43:28 +00:00
init/lib fix(init): use bare specifier for jsr:@std/assert (#24581) 2024-07-14 13:22:43 -04:00
install chore: remove DENO_FUTURE=1 from spec tests (#25329) 2024-08-31 21:25:32 +00:00
jsr fix: update dry run success message (#24885) 2024-08-06 08:14:06 +00:00
jupyter/install_command refactor(jupyter): use runtimelib for Jupyter structures and directory paths (#23826) 2024-05-21 22:35:21 +02:00
lint fix(lint): support linting jsr pkg without version field (#25230) 2024-08-30 18:05:44 -04:00
lockfile chore: remove DENO_FUTURE=1 from spec tests (#25329) 2024-08-31 21:25:32 +00:00
node chore: remove DENO_FUTURE=1 from spec tests (#25329) 2024-08-31 21:25:32 +00:00
npm fix: make some warnings more standard (#25324) 2024-09-03 10:45:01 +02:00
permission fix(runtime): Allow opening /dev/fd/XXX for unix (#23743) 2024-05-10 11:21:36 -06:00
publish fix: make some warnings more standard (#25324) 2024-09-03 10:45:01 +02:00
remove/basic feat: improve lockfile v4 to store normalized version constraints and be more terse (#25247) 2024-08-28 14:17:47 -04:00
run fix: remove entrypoint hack for Deno 2.0 (#25332) 2024-09-02 15:33:07 +00:00
serve feat: Add Deno.ServeDefaultExport type (#24879) 2024-08-05 23:19:09 +02:00
task chore: remove DENO_FUTURE=1 from spec tests (#25329) 2024-08-31 21:25:32 +00:00
test BREAKING: remove --allow-none flag (#25337) 2024-09-02 22:06:27 +00:00
vendor/removed BREAKING: remove deno vendor (#25343) 2024-09-03 17:00:57 +10:00
workspaces feat: improve lockfile v4 to store normalized version constraints and be more terse (#25247) 2024-08-28 14:17:47 -04:00
mod.rs test: add supporting for ignoring spec tests (#25242) 2024-08-28 00:19:29 +00:00
README.md chore: support -- --nocapture in the spec tests (#24113) 2024-06-06 08:37:13 -04:00
schema.json test: add supporting for ignoring spec tests (#25242) 2024-08-28 00:19:29 +00:00

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 ]