1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

test,doc: document where common modules go

Browse Source 
Keep the `require('../common')` separate from other common modules, as
it's the only line that must be there.

PR-URL: https://github.com/nodejs/node/pull/16089
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Gibson Fahnestock 2017-10-08 10:26:55 -07:00 committed by James M Snell
parent 272811247e
commit 17db46c483
1 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/guides/writing-tests.md
View File

@ -25,39 +25,44 @@ Let's analyze this basic test from the Node.js test suite:
```javascript ```javascript
'use strict'; // 1 'use strict'; // 1
const common = require('../common'); // 2 const common = require('../common'); // 2
const fixtures = require('../common/fixtures'); // 3
// This test ensures that the http-parser can handle UTF-8 characters // 4 // This test ensures that the http-parser can handle UTF-8 characters // 5
// in the http header. // 5 // in the http header. // 6
const assert = require('assert'); // 7 const assert = require('assert'); // 8
const http = require('http'); // 8 const http = require('http'); // 9
const server = http.createServer(common.mustCall((req, res) => { // 10 const server = http.createServer(common.mustCall((req, res) => { // 11
res.end('ok'); // 11 res.end('ok'); // 12
})); // 12 })); // 13
server.listen(0, () => { // 13 server.listen(0, () => { // 14
http.get({ // 14 http.get({ // 15
port: server.address().port, // 15 port: server.address().port, // 16
headers: { 'Test': 'Düsseldorf' } // 16 headers: { 'Test': 'Düsseldorf' } // 17
}, common.mustCall((res) => { // 17 }, common.mustCall((res) => { // 18
assert.strictEqual(res.statusCode, 200); // 18 assert.strictEqual(res.statusCode, 200); // 19
server.close(); // 19 server.close(); // 20
})); // 20 })); // 21
}); // 21 }); // 22
// ... // 23
``` ```
### **Lines 1-2** ### **Lines 1-3**
```javascript ```javascript
'use strict'; 'use strict';
const common = require('../common'); const common = require('../common');
const fixtures = require('../common/fixtures');
``` ```
The first line enables strict mode. All tests should be in strict mode unless The first line enables strict mode. All tests should be in strict mode unless
the nature of the test requires that the test run without it. the nature of the test requires that the test run without it.
The second line loads the `common` module. The [`common` module][] is a helper The second line loads the `common` module. The [`common` module][] is a helper
module that provides useful tools for the tests. module that provides useful tools for the tests. Some common functionality has
been extracted into submodules, which are required separately like the fixtures
module here.
Even if a test uses no functions or other properties exported by `common`, Even if a test uses no functions or other properties exported by `common`,
the test should still include the `common` module before any other modules. This the test should still include the `common` module before any other modules. This
@ -70,7 +75,7 @@ assigning it to an identifier:
require('../common'); require('../common');
``` ```
### **Lines 4-5** ### **Lines 5-6**
```javascript ```javascript
// This test ensures that the http-parser can handle UTF-8 characters // This test ensures that the http-parser can handle UTF-8 characters
@ -80,7 +85,7 @@ require('../common');
A test should start with a comment containing a brief description of what it is A test should start with a comment containing a brief description of what it is
designed to test. designed to test.
### **Lines 7-8** ### **Lines 8-9**
```javascript ```javascript
const assert = require('assert'); const assert = require('assert');
@ -95,7 +100,7 @@ The require statements are sorted in
[ASCII][] order (digits, upper [ASCII][] order (digits, upper
case, `_`, lower case). case, `_`, lower case).
### **Lines 10-21** ### **Lines 11-22**
This is the body of the test. This test is simple, it just tests that an This is the body of the test. This test is simple, it just tests that an
HTTP server accepts `non-ASCII` characters in the headers of an incoming HTTP server accepts `non-ASCII` characters in the headers of an incoming