Skip to content

Commit a9c4a43

Browse files
committed
tests - move readme around
1 parent 0c94b3a commit a9c4a43

File tree

2 files changed

+51
-30
lines changed

2 files changed

+51
-30
lines changed

test/README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,8 @@
1-
# Tests
1+
# VSCode Tests
22

3-
## Run
3+
## Contents
44

5-
The best way to run the Code tests is from the terminal. To make development changes to unit tests you need to be running `yarn run watch`. See [Development Workflow](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#incremental-build) for more details. From the `vscode` folder run:
6-
7-
**OS X and Linux**
8-
9-
./scripts/test.sh
10-
11-
**Windows**
12-
13-
scripts\test
14-
15-
16-
## Debug
17-
18-
To debug tests use `--debug` when running the test script. Also, the set of tests can be reduced with the `--run` and `--runGlob` flags. Both require a file path/pattern. Like so:
19-
20-
./scripts/test.sh --debug --runGrep **/extHost*.test.js
21-
22-
## Coverage
23-
24-
The following command will create a `coverage` folder at the root of the workspace:
25-
26-
**OS X and Linux**
27-
28-
./scripts/test.sh --coverage
29-
30-
**Windows**
31-
32-
scripts\test --coverage
5+
This folder contains the various test runners for VSCode. Please refer to the documentation within for how to run them:
6+
* `unit`: our suite of unit tests
7+
* `integration`: our suite of API tests
8+
* `smoke`: our suite of UI tests

test/unit/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Unit Tests
2+
3+
## Run (inside Electron)
4+
5+
The best way to run the unit tests is from the terminal. To make development changes to unit tests you need to be running `yarn watch`. See [Development Workflow](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#incremental-build) for more details. From the `vscode` folder run:
6+
7+
**OS X and Linux**
8+
9+
./scripts/test.sh
10+
11+
**Windows**
12+
13+
scripts\test
14+
15+
16+
## Run (inside browser)
17+
18+
You can run tests inside a browser instance too:
19+
20+
**OS X and Linux**
21+
22+
node test/unit/browser/index.js
23+
24+
**Windows**
25+
26+
node test\unit\browser\index.js
27+
28+
29+
## Debug
30+
31+
To debug tests use `--debug` when running the test script. Also, the set of tests can be reduced with the `--run` and `--runGlob` flags. Both require a file path/pattern. Like so:
32+
33+
./scripts/test.sh --debug --runGrep **/extHost*.test.js
34+
35+
## Coverage
36+
37+
The following command will create a `coverage` folder at the root of the workspace:
38+
39+
**OS X and Linux**
40+
41+
./scripts/test.sh --coverage
42+
43+
**Windows**
44+
45+
scripts\test --coverage

0 commit comments

Comments
 (0)