Skip to content

Commit 5f453cd

Browse files
PeterJCLawKartik Raj
PeterJCLaw
authored and
Kartik Raj
committed
Explicitly clarify the difference between unit and system test files (microsoft#9419)
* Explicitly clarify the difference between unit and system test files This aims to clarify for new contributors how to run the tests they've may have edited. * There can be more than just `.test.ts` For example: `.testvirtualenvs.ts`. * Also mention functional tests
1 parent e83448b commit 5f453cd

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ Use the `Extension` launch option.
7474

7575
### Running Unit Tests
7676

77+
Note: Unit tests are those in files with extension `.unit.test.ts`.
78+
7779
1. Make sure you have compiled all code (done automatically when using incremental building)
7880
1. Ensure you have disabled breaking into 'Uncaught Exceptions' when running the Unit Tests
7981
1. For the linters and formatters tests to pass successfully, you will need to have those corresponding Python libraries installed locally
@@ -97,8 +99,20 @@ Alter the `launch.json` file in the `"Debug Unit Tests"` section by setting the
9799
```
98100
...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).
99101

102+
### Running Functional Tests
103+
104+
Functional tests are those in files with extension `.functional.test.ts`.
105+
These tests are similar to system tests in scope, but are run like unit tests.
106+
107+
You can run functional tests in a similar way to that for unit tests:
108+
109+
* via the "Functional Tests" launch option, or
110+
* on the command line via `npm run test:functional`
111+
100112
### Running System Tests
101113

114+
Note: System tests are those in files with extension `.test*.ts` but which are neither `.functional.test.ts` nor `.unit.test.ts`.
115+
102116
1. Make sure you have compiled all code (done automatically when using incremental building)
103117
1. Ensure you have disabled breaking into 'Uncaught Exceptions' when running the Unit Tests
104118
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

0 commit comments

Comments
 (0)