diff options
| author | Kitson Kelly <me@kitsonkelly.com> | 2018-11-05 06:52:31 +1100 |
|---|---|---|
| committer | Ryan Dahl <ry@tinyclouds.org> | 2018-11-04 11:52:31 -0800 |
| commit | 4e07783663d51877e7d41465cf5ef10d1540c4b3 (patch) | |
| tree | f02336f4f46e8330362f1409d1c298db50dcc98a /tests/README.md | |
| parent | e93d686e9d5e797f7e4e02bda56a8b6d535326ca (diff) | |
Improve integration test harness (#1142)
Diffstat (limited to 'tests/README.md')
| -rw-r--r-- | tests/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 000000000..080fcdd15 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,15 @@ +# Integration Tests + +This path contains integration tests. When the integration tests are run, the +test harness will execute tests which are defined in a `.test` file and located +in the base of this path. + +A `.test` file is a simple configuration format where each option is specified +on a single line. The key is the string to the left of the `:` deliminator and +the value is the string to the right. + +| Key | Required | Description | +| ----------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `args` | Yes | Specifies the command line arguments for the test. This should typically be input script for the test and a `--reload` to help ensure Deno doesn't leverage the cache. | +| `output` | Yes | This is a text file which represents the output of the command. The string `[WILDCARD]` can be used in the output to specify ranges of text which any output is accepted. | +| `exit_code` | No | If not present, it is assumed the script would exit normally (`0`). If specified, the harness will ensure the proper code is received. | |