node/test/async-hooks/test-tlswrap.js
Thorsten Lorenz e3e56f1d71
test: adding tests for initHooks API
Async wrap providers tested:

- crypto.randomBytes
- crypto.pbkdf2
- fs event wrap
- fsreqwrap access
- fsreqwrap readFile
- getaddrinforeq wrap
- getnameinforeq wrap
- pipe connect wrap
- query wrap
- pipewrap
- processwrap
- shutdown wrap
- tcpwrap
- udpwrap
- send wrap
- detailed signal wrap
- statwatcher
- timerwrap via setTimeout
- timerwrap via setInterval
- for Immediate
- http parser request
- http parser response
- connection via ssl server
- tls wrap
- write wrap
- ttywrap via readstream
- ttywrap via wriream
- zctx via zlib binding deflate

Embedder API:

-  async-event tests
  - one test looks at the happy paths
  - another ensures that in cases of events emitted in an order that
  doesn't make sense, the order is enforced by async hooks throwing a
  meaningful error
  - embedder enforcement tests are split up since async hook stack
  corruption now the process
  - therefore we launch a child and check for error output of the offending code

Additional tests:

- tests that show that we can enable/disable hooks inside their lifetime
events
- tests that verify the graph of resources triggering the creation of
other resources

Test Helpers:

- init-hooks:
  - returns one collector instance
  - when created an async hook is created and the lifetime events are
  registered to call the appropriate collector functions
  - the collector also exposes `enable` and `disable` functions which call
  through to the async hook

- hook checks:
  - checks invocations of life time hooks against the actual invocations
  that were collected
  - in some cases like `destroy` a min/max range of invocations can be
  supplied since in these cases the exact number is non-deterministic

- verify graph:
  - verifies the triggerIds of specific async resources are as expected,
  i.e. the creation of resources was triggered by the resource we expect
  - includes a printGraph function to generate easily readable test
  input for verify graph
  - both functions prune TickObjects to create less brittle and easier
  to understand tests

PR-URL: https://github.com/nodejs/node/pull/12892
Ref: https://github.com/nodejs/node/pull/11883
Ref: https://github.com/nodejs/node/pull/8531
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2017-05-10 22:22:33 +02:00

134 lines
4.2 KiB
JavaScript

'use strict';
const common = require('../common');
const assert = require('assert');
const tick = require('./tick');
const initHooks = require('./init-hooks');
const fs = require('fs');
const { checkInvocations } = require('./hook-checks');
if (!common.hasCrypto) {
common.skip('missing crypto');
return;
}
const tls = require('tls');
const hooks = initHooks();
hooks.enable();
//
// Creating server and listening on port
//
const server = tls
.createServer({
cert: fs.readFileSync(common.fixturesDir + '/test_cert.pem'),
key: fs.readFileSync(common.fixturesDir + '/test_key.pem')
})
.on('listening', common.mustCall(onlistening))
.on('secureConnection', common.mustCall(onsecureConnection))
.listen(common.PORT);
let svr, client;
function onlistening() {
//
// Creating client and connecting it to server
//
tls
.connect(common.PORT, { rejectUnauthorized: false })
.on('secureConnect', common.mustCall(onsecureConnect));
const as = hooks.activitiesOfTypes('TLSWRAP');
assert.strictEqual(as.length, 1, 'one TLSWRAP when client connecting');
svr = as[0];
assert.strictEqual(svr.type, 'TLSWRAP', 'tls wrap');
assert.strictEqual(typeof svr.uid, 'number', 'uid is a number');
assert.strictEqual(typeof svr.triggerId, 'number', 'triggerId is a number');
checkInvocations(svr, { init: 1 }, 'server: when client connecting');
}
function onsecureConnection() {
//
// Server received client connection
//
const as = hooks.activitiesOfTypes('TLSWRAP');
assert.strictEqual(as.length, 2,
'two TLSWRAPs when server has secure connection');
client = as[1];
assert.strictEqual(client.type, 'TLSWRAP', 'tls wrap');
assert.strictEqual(typeof client.uid, 'number', 'uid is a number');
assert.strictEqual(typeof client.triggerId, 'number',
'triggerId is a number');
// TODO(thlorenz) which callback did the server wrap execute that already
// finished as well?
checkInvocations(svr, { init: 1, before: 1, after: 1 },
'server: when server has secure connection');
checkInvocations(client, { init: 1, before: 2, after: 1 },
'client: when server has secure connection');
}
function onsecureConnect() {
//
// Client connected to server
//
checkInvocations(svr, { init: 1, before: 2, after: 1 },
'server: when client connected');
checkInvocations(client, { init: 1, before: 2, after: 2 },
'client: when client connected');
//
// Destroying client socket
//
this.destroy();
checkInvocations(svr, { init: 1, before: 2, after: 1 },
'server: when destroying client');
checkInvocations(client, { init: 1, before: 2, after: 2 },
'client: when destroying client');
tick(5, tick1);
function tick1() {
checkInvocations(svr, { init: 1, before: 2, after: 2 },
'server: when client destroyed');
// TODO: why is client not destroyed here even after 5 ticks?
// or could it be that it isn't actually destroyed until
// the server is closed?
checkInvocations(client, { init: 1, before: 3, after: 3 },
'client: when client destroyed');
//
// Closing server
//
server.close(common.mustCall(onserverClosed));
// No changes to invocations until server actually closed below
checkInvocations(svr, { init: 1, before: 2, after: 2 },
'server: when closing server');
checkInvocations(client, { init: 1, before: 3, after: 3 },
'client: when closing server');
}
}
function onserverClosed() {
//
// Server closed
//
tick(1E4, common.mustCall(() => {
checkInvocations(svr, { init: 1, before: 2, after: 2 },
'server: when server closed');
checkInvocations(client, { init: 1, before: 3, after: 3 },
'client: when server closed');
}));
}
process.on('exit', onexit);
function onexit() {
hooks.disable();
hooks.sanityCheck('TLSWRAP');
checkInvocations(svr, { init: 1, before: 2, after: 2 },
'server: when process exits');
checkInvocations(client, { init: 1, before: 3, after: 3 },
'client: when process exits');
}