Skip to content

Adjust test-http-content-length and docs to consider countdown #17201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Bamieh wants to merge 3 commits into from
Closed

Adjust test-http-content-length and docs to consider countdown #17201

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9fc0e2
Document countdown module in the 'writing tests' guide
Bamieh Dec 12, 2017
879f939
Fixes: https://github.com/nodejs/node/issues/17169
Bamieh Dec 12, 2017
85f8194
fixing linting issues in doc
Bamieh Dec 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Document countdown module in the 'writing tests' guide
  • Loading branch information
@Bamieh
Bamieh committed Dec 12, 2017
commit d9fc0e279efc3463668f23d78ef4b014160b7075
22 changes: 19 additions & 3 deletions doc/guides/writing-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,11 @@ platforms.

### The *common* API

Make use of the helpers from the `common` module as much as possible.
Make use of the helpers from the `common` module as much as possible. Please refer to the [common file documentation](https://github.com/nodejs/node/tree/master/test/common) for the full details of the helpers.

One interesting case is `common.mustCall`. The use of `common.mustCall` may
avoid the use of extra variables and the corresponding assertions. Let's explain
#### common.mustCall

One interesting case is `common.mustCall`. The use of `common.mustCall` may avoid the use of extra variables and the corresponding assertions. Let's explain
this with a real test from the test suite.

```javascript
Expand Down Expand Up @@ -189,6 +190,21 @@ const server = http.createServer(common.mustCall(function(req, res) {
});

```
#### Countdown Module

The common [Countdown module](https://github.com/nodejs/node/tree/master/test/common#countdown-module) provides a simple countdown mechanism for tests that require a particular action to be taken after a given number of completed tasks (for instance, shutting down an HTTP server after a specific number of requests).

```
const Countdown = require('../common/countdown');

const countdown = new Countdown(2, function() {
console.log('.');
});

countdown.dec();
countdown.dec(); // The countdown callback will be invoked now.
```


### Flags

Expand Down