mirror of
https://github.com/Microsoft/vscode
synced 2024-08-27 04:49:35 +00:00
tests - move readme around
This commit is contained in:
parent
0c94b3ade0
commit
a9c4a4397c
|
@ -1,32 +1,8 @@
|
|||
# Tests
|
||||
# VSCode Tests
|
||||
|
||||
## Run
|
||||
## Contents
|
||||
|
||||
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:
|
||||
|
||||
**OS X and Linux**
|
||||
|
||||
./scripts/test.sh
|
||||
|
||||
**Windows**
|
||||
|
||||
scripts\test
|
||||
|
||||
|
||||
## Debug
|
||||
|
||||
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:
|
||||
|
||||
./scripts/test.sh --debug --runGrep **/extHost*.test.js
|
||||
|
||||
## Coverage
|
||||
|
||||
The following command will create a `coverage` folder at the root of the workspace:
|
||||
|
||||
**OS X and Linux**
|
||||
|
||||
./scripts/test.sh --coverage
|
||||
|
||||
**Windows**
|
||||
|
||||
scripts\test --coverage
|
||||
This folder contains the various test runners for VSCode. Please refer to the documentation within for how to run them:
|
||||
* `unit`: our suite of unit tests
|
||||
* `integration`: our suite of API tests
|
||||
* `smoke`: our suite of UI tests
|
||||
|
|
45
test/unit/README.md
Normal file
45
test/unit/README.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
# Unit Tests
|
||||
|
||||
## Run (inside Electron)
|
||||
|
||||
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:
|
||||
|
||||
**OS X and Linux**
|
||||
|
||||
./scripts/test.sh
|
||||
|
||||
**Windows**
|
||||
|
||||
scripts\test
|
||||
|
||||
|
||||
## Run (inside browser)
|
||||
|
||||
You can run tests inside a browser instance too:
|
||||
|
||||
**OS X and Linux**
|
||||
|
||||
node test/unit/browser/index.js
|
||||
|
||||
**Windows**
|
||||
|
||||
node test\unit\browser\index.js
|
||||
|
||||
|
||||
## Debug
|
||||
|
||||
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:
|
||||
|
||||
./scripts/test.sh --debug --runGrep **/extHost*.test.js
|
||||
|
||||
## Coverage
|
||||
|
||||
The following command will create a `coverage` folder at the root of the workspace:
|
||||
|
||||
**OS X and Linux**
|
||||
|
||||
./scripts/test.sh --coverage
|
||||
|
||||
**Windows**
|
||||
|
||||
scripts\test --coverage
|
Loading…
Reference in a new issue