0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-10-31 09:14:20 -04:00
denoland-deno/cli/js/tests
Bartek Iwańczuk 6e2df8c64f
feat: Deno.test() sanitizes ops and resources (#4399)
This PR brings assertOps and assertResources sanitizers to Deno.test() API.

assertOps checks that test doesn't leak async ops, ie. there are no unresolved
promises originating from Deno APIs. Enabled by default, can be disabled using 
Deno.TestDefinition.disableOpSanitizer.

assertResources checks that test doesn't leak resources, ie. all resources used
in test are closed. For example; if a file is opened during a test case it must be
explicitly closed before test case finishes. It's most useful for asynchronous
generators. Enabled by default, can be disabled using 
Deno.TestDefinition.disableResourceSanitizer.

We've used those sanitizers in internal runtime tests and it proved very useful in
surfacing incorrect tests which resulted in interference between the tests.

All tests have been sanitized.

Closes #4208
2020-03-18 19:25:55 -04:00
..
blob_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
body_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
buffer_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
build_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
chmod_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
chown_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
console_test.ts console: Symbol.toStringTag and display Object symbol entries (#4388) 2020-03-16 09:05:39 -04:00
copy_file_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
custom_event_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
dir_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
dispatch_json_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
dispatch_minimal_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
dom_iterable_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
error_stack_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
event_target_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
event_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
fetch_test.ts feat: fetch should accept a FormData body (#4363) 2020-03-17 02:32:43 -04:00
file_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
files_test.ts Add mode option to open/create (#4289) 2020-03-16 15:02:41 -04:00
form_data_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
format_error_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
fs_events_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
get_random_values_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
globals_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
headers_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
internals_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
link_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
location_test.ts refactor: unit test runner communicates using TCP socket (#4336) 2020-03-13 15:57:32 +01:00
make_temp_test.ts Stricter permissions for Deno.makeTemp* (#4318) 2020-03-11 15:05:42 -04:00
metrics_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
mkdir_test.ts support permission mode in mkdir (#4286) 2020-03-11 16:14:23 -04:00
net_test.ts Add waker to StreamResource to fix hang on close bugs (#4293) 2020-03-11 18:19:24 -04:00
os_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
performance_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
permissions_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
process_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
read_dir_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
read_file_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
read_link_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
README.md refactor: change test reporter output (#4371) 2020-03-15 17:58:59 +01:00
realpath_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
remove_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
rename_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
request_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
resources_test.ts refactor: unit test runner communicates using TCP socket (#4336) 2020-03-13 15:57:32 +01:00
signal_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
stat_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
symbols_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
symlink_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
test_util.ts feat: Deno.test() sanitizes ops and resources (#4399) 2020-03-18 19:25:55 -04:00
testing_test.ts feat(cli/js/testing): Add TestDefinition::skip (#4351) 2020-03-15 10:34:24 +01:00
text_encoding_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
timers_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
tls_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
truncate_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
tty_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
umask_test.ts Add Deno.umask (#4290) 2020-03-10 15:11:27 -04:00
unit_test_runner.ts Fix unit test runner ConnectionReset bug (#4424) 2020-03-18 12:13:01 -07:00
unit_tests.ts refactor: unit test runner communicates using TCP socket (#4336) 2020-03-13 15:57:32 +01:00
url_search_params_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
url_test.ts refactor: uncomment tests broken tests, use skip (#4311) 2020-03-10 16:38:02 +01:00
utime_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
version_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00
write_file_test.ts reorg: move js runtime tests to cli/js/tests/ (#4250) 2020-03-10 01:06:47 +01:00

Deno runtime tests

Files in this directory are unit tests for Deno runtime.

They are run under compiled Deno binary as opposed to files in cli/js/ which are bundled and snapshotted using deno_typescript crate.

Testing Deno runtime code requires checking API under different runtime permissions (ie. running with different --allow-* flags). To accomplish this all tests exercised are created using unitTest() function.

import { unitTest } from "./test_util.ts";

unitTest(function simpleTestFn(): void {
  // test code here
});

unitTest({
    skip: Deno.build.os === "win",
    perms: { read: true, write: true },
  },
  function complexTestFn(): void {
    // test code here
  }
);

unitTest is is a wrapper function that enhances Deno.test() API in several ways:

  • ability to conditionally skip tests using UnitTestOptions.skip
  • ability to register required set of permissions for given test case using UnitTestOptions.perms
  • sanitization of resources - ensuring that tests close all opened resources preventing interference between tests
  • sanitization of async ops - ensuring that tests don't leak async ops by ensuring that all started async ops are done before test finishes

Running tests

unit_test_runner.ts is the main script used to run unit tests.

Runner discoveres required permissions combinations by loading cli/js/tests/unit_tests.ts and going through all registered instances of unitTest.

There are three ways to run unit_test_runner.ts:

# Run all tests. Spawns worker processes for each discovered permission
# combination:
target/debug/deno -A cli/js/tests/unit_test_runner.ts --master

# By default all output of worker processes is discarded; for debug purposes
# the --verbose flag preserves output from the worker
target/debug/deno -A cli/js/tests/unit_test_runner.ts --master --verbose

# Run subset of tests that don't require any permissions
target/debug/deno cli/js/tests/unit_test_runner.ts

# Run subset tests that require "net" and "read" permissions
target/debug/deno --allow-net --allow-read cli/js/tests/unit_test_runner.ts

# "worker" mode communicates with parent using TCP socket on provided address;
# after initial setup drops permissions to specified set. It shouldn't be used
# directly, only be "master" process.
target/debug/deno -A cli/js/tests/unit_test_runner.ts --worker --addr=127.0.0.1:4500 --perms=net,write,run

# Run specific tests
target/debug/deno --allow-net cli/js/tests/unit_test_runner.ts -- netTcpListenClose

Http server

tools/http_server.py is required to run when one's running unit tests. During CI it's spawned automatically, but if you want to run tests manually make sure that server is spawned otherwise there'll be cascade of test failures.