unify testing docs for all platforms

This commit is contained in:
Zeke Sikelianos 2016-10-05 22:21:42 -07:00
parent 156d823b7f
commit a4832c304e
4 changed files with 44 additions and 60 deletions

View file

@ -121,17 +121,7 @@ $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5
## Tests ## Tests
Test your changes conform to the project coding style using: See [Build System Overview: Tests](docs/development/build-system-overview.md#tests)
```bash
$ npm run lint
```
Test functionality using:
```bash
$ ./script/test.py
```
## Advanced topics ## Advanced topics

View file

@ -61,31 +61,4 @@ $ npm run clean
## Tests ## Tests
Test your changes conform to the project coding style using: See [Build System Overview: Tests](docs/development/build-system-overview.md#tests)
```bash
$ npm run lint
```
Test functionality using:
```bash
$ npm test
```
You can make the test suite run faster by isolating the specific test or block
you're currently working on using Mocha's
[exclusive tests](https://mochajs.org/#exclusive-tests) feature:
```js
describe.only('some feature', function () {
// ... only tests in this block will be run
})
```
Alternatively, you can use mocha's `grep` option to only run tests matching the
given regular expression pattern:
```sh
npm test -- --grep child_process
```

View file

@ -87,27 +87,7 @@ $ npm run clean
## Tests ## Tests
Test your changes conform to the project coding style using: See [Build System Overview: Tests](docs/development/build-system-overview.md#tests)
```powershell
$ python script\cpplint.py
```
Test functionality using:
```powershell
$ python script\test.py
```
Tests that include native modules (e.g. `runas`) can't be executed with the
debug build (see [#2558](https://github.com/electron/electron/issues/2558) for
details), but they will work with the release build.
To run the tests with the release build use:
```powershell
$ python script\test.py -R
```
## Troubleshooting ## Troubleshooting

View file

@ -71,3 +71,44 @@ to generate one target at a time as stated above.
This only affects developers, if you are just building Electron for rebranding This only affects developers, if you are just building Electron for rebranding
you are not affected. you are not affected.
## Tests
Test your changes conform to the project coding style using:
```bash
$ npm run lint
```
Test functionality using:
```bash
$ npm test
```
You can make the test suite run faster by isolating the specific test or block
you're currently working on using Mocha's
[exclusive tests](https://mochajs.org/#exclusive-tests) feature:
```js
describe.only('some feature', function () {
// ... only tests in this block will be run
})
```
Alternatively, you can use mocha's `grep` option to only run tests matching the
given regular expression pattern:
```sh
$ npm test -- --grep child_process
```
Tests that include native modules (e.g. `runas`) can't be executed with the
debug build (see [#2558](https://github.com/electron/electron/issues/2558) for
details), but they will work with the release build.
To run the tests with the release build use:
```bash
$ npm test -- -R
```