Skip to content

Explicitly clarify the difference between unit and system test files #9419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karrtikr merged 3 commits into from
Jan 16, 2020
Merged

Explicitly clarify the difference between unit and system test files #9419

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5283a2
Explicitly clarify the difference between unit and system test files
PeterJCLaw Jan 7, 2020
b0d0fca
There can be more than just `.test.ts`
PeterJCLaw Jan 7, 2020
f6a9b10
Also mention functional tests
PeterJCLaw Jan 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ Use the `Extension` launch option.

### Running Unit Tests

Note: Unit tests are those in files with extension `.unit.test.ts`.

1. Make sure you have compiled all code (done automatically when using incremental building)
1. Ensure you have disabled breaking into 'Uncaught Exceptions' when running the Unit Tests
1. For the linters and formatters tests to pass successfully, you will need to have those corresponding Python libraries installed locally
Expand All @@ -97,8 +99,20 @@ Alter the `launch.json` file in the `"Debug Unit Tests"` section by setting the
```
...this will only run the suite with the tests you care about during a test run (be sure to set the debugger to run the `Debug Unit Tests` launcher).

### Running Functional Tests

Functional tests are those in files with extension `.functional.test.ts`.
These tests are similar to system tests in scope, but are run like unit tests.

You can run functional tests in a similar way to that for unit tests:

* via the "Functional Tests" launch option, or
* on the command line via `npm run test:functional`

### Running System Tests

Note: System tests are those in files with extension `.test*.ts` but which are neither `.functional.test.ts` nor `.unit.test.ts`.

1. Make sure you have compiled all code (done automatically when using incremental building)
1. Ensure you have disabled breaking into 'Uncaught Exceptions' when running the Unit Tests
1. For the linters and formatters tests to pass successfully, you will need to have those corresponding Python libraries installed locally by using the `./requirements.txt` and `build/test-requirements.txt` files
Expand Down