diff options
| author | juggernaut451 <singhjug1994@gmail.com> | 2018-02-15 21:31:52 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2018-12-04 00:54:45 +0300 |
| commit | 8338700d05a911c0784e833381f1c727bed4f281 (patch) | |
| tree | 452fbc7b155cac9d17250a3254a2ddb0cd9bf10a /doc | |
| parent | 63d86326113c808cea7a902e2309b75f02a7ca5f (diff) | |
doc: add directory structure in writing-tests.md
PR-URL: https://github.com/nodejs/node/pull/18802
Fixes: https://github.com/nodejs/node/issues/18774
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matheus Marchini <matheus@sthima.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/writing-tests.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/guides/writing-tests.md b/doc/guides/writing-tests.md index ec9398dcb92..b5f641289f7 100644 --- a/doc/guides/writing-tests.md +++ b/doc/guides/writing-tests.md @@ -18,6 +18,13 @@ Add tests when: - Fixing regressions and bugs. - Expanding test coverage. +## Test directory structure + +See [directory structure overview][] for outline of existing test & locations. +When deciding on whether to expand an existing test file or create a new one, +consider going through the files related to the subsystem. +For example, look for `test-streams` when writing a test for `lib/streams.js`. + ## Test structure Let's analyze this basic test from the Node.js test suite: @@ -376,3 +383,4 @@ will depend on what is being tested if this is required or not. [all maintained branches]: https://github.com/nodejs/lts [node.green]: http://node.green/ [test fixture]: https://github.com/google/googletest/blob/master/googletest/docs/Primer.md#test-fixtures-using-the-same-data-configuration-for-multiple-tests +[directory structure overview]: https://github.com/nodejs/node/blob/master/test/README.md#test-directories |