jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-04 09:06:46 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #19123 from SmolParascythe/SmolParascythe-update-test-README

Browse Source 
Fix grammar and clearer test readme
This commit is contained in:
Courtney Wilson
2022-07-27 12:53:24 -05:00
committed by GitHub
parent 4d96bcb5e5 3d00c55071
commit 77a8650096
1 changed files with 21 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
tests/README.md
View File

@@ -1,26 +1,26 @@
## Tests
It's not strictly necessary to run tests locally while developing: You can
It's not strictly necessary to run tests locally while developing. You can
always open a pull request and rely on the CI service to run tests for you,
but sometimes it's helpful to run tests locally before pushing your changes to
but it's helpful to run tests locally before pushing your changes to
GitHub.
Test are written using [jest](https://ghub.io/jest), a framework maintained
by Facebook and used by many teams at GitHub. Jest is convenient in that it
provides everything: a test runner, an assertion library, code coverage analysis,
Tests are written using [jest](https://ghub.io/jest), a framework maintained
by Facebook and used by many teams at GitHub.
Jest provides everything: a test runner, an assertion library, code coverage analysis,
custom reporters for different types of test output, etc.
### Install optional dependencies
We typically rely on CI to run our tests, so we consider some large test-only
dependencies **optional** (for example, puppeteer). In order to run the tests locally you'll
We typically rely on CI to run our tests, so some large test-only
dependencies are considered **optional** (for example, puppeteer). To run the tests locally, you'll
need to make sure optional dependencies are installed by running:
```sh
npm ci --include=optional
```
If you run into the error "Could not find expected browser (chrome) locally" you may need to manually install the expected chromium version with:
If you run into the error "Could not find expected browser (chrome) locally", you may need to install the expected chromium version manually with:
```
node node_modules/puppeteer/install.js
```
@@ -36,10 +36,10 @@ script/test # or `npm test`
### Watching all the tests
You can also run a script that will continually watch for changes and
re-run the tests any time a change is made. This command will notify you
when tests change to and from a passing or failing state, and will also print
out a test coverage report, so you can see what files are in need of tests.
You can run a script that continually watches for changes and
re-runs the tests whenever a change is made. This command notifies you
when tests change to and from a passing or failing state, and it prints
out a test coverage report so you can see what files need testing.
```sh
npm run test-watch
@@ -47,7 +47,7 @@ npm run test-watch
### Running individual tests
You can run specific tests in one of these two ways:
You can run specific tests in two ways:
```sh
# The TEST_NAME can be a filename, partial filename, or path to a file or directory
@@ -79,25 +79,26 @@ npm run lint
### Keeping the server running
When you run `jest` tests, that depend on making real HTTP requests
When you run `jest` tests that depend on making real HTTP requests
to `localhost:4000`, the `jest` tests have a hook that starts the
server before running all/any tests, and stops the server when it's done.
server before running all/any tests and stops the server when done.
You can disable that, which might make it easier when debugging tests
You can disable this, which might make it easier when debugging tests
since the server won't need to start and stop every time you run tests.
In one terminal type:
In one terminal, type:
```sh
NODE_ENV=test PORT=4000 node server.js
```
and then, in another terminal type:
In another terminal, type:
```sh
START_JEST_SERVER=false jest tests/rendering/foo/bar.js
```
Or whatever the testing command you use. Note the `START_JEST_SERVER=false`
environment variable that needs to be set or else, `jest` will try to start
Or whatever the testing command you use is.
The `START_JEST_SERVER` environment variable needs to be set to `false`, or else `jest` will try to start
a server on `:4000` too.