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>

1 files changed, 69 insertions, 0 deletions

diff --git a/test/async-hooks/test-shutdownwrap.js b/test/async-hooks/test-shutdownwrap.js
new file mode 100644
index 0000000000..8ce2aae275
--- /dev/null
+++ b/test/async-hooks/test-shutdownwrap.js
@@ -0,0 +1,69 @@
+'use strict';
+
+const common = require('../common');
+const assert = require('assert');
+const initHooks = require('./init-hooks');
+const { checkInvocations } = require('./hook-checks');
+
+const net = require('net');
+
+const hooks = initHooks();
+hooks.enable();
+
+const server = net
+  .createServer(onconnection)
+  .on('listening', common.mustCall(onlistening));
+server.listen();
+function onlistening() {
+  net.connect(server.address().port, common.mustCall(onconnected));
+}
+
+// It is non-deterministic in which order onconnection and onconnected fire.
+// Therefore we track here if we ended the connection already or not.
+let endedConnection = false;
+function onconnection(c) {
+  assert.strictEqual(hooks.activitiesOfTypes('SHUTDOWNWRAP').length, 0,
+                     'no shutdown wrap before ending the client connection');
+  c.end();
+  endedConnection = true;
+  const as = hooks.activitiesOfTypes('SHUTDOWNWRAP');
+  assert.strictEqual(
+    as.length, 1,
+    'one shutdown wrap created sync after ending the client connection');
+  checkInvocations(as[0], { init: 1 }, 'after ending client connection');
+  this.close(onserverClosed);
+}
+
+function onconnected() {
+  if (endedConnection) {
+    assert.strictEqual(
+      hooks.activitiesOfTypes('SHUTDOWNWRAP').length, 1,
+      'one shutdown wrap when client connected but server ended connection');
+
+  } else {
+    assert.strictEqual(
+      hooks.activitiesOfTypes('SHUTDOWNWRAP').length, 0,
+      'no shutdown wrap when client connected and server did not end connection'
+    );
+  }
+}
+
+function onserverClosed() {
+  const as = hooks.activitiesOfTypes('SHUTDOWNWRAP');
+  checkInvocations(as[0], { init: 1, before: 1, after: 1, destroy: 1 },
+                   'when server closed');
+}
+
+process.on('exit', onexit);
+
+function onexit() {
+  hooks.disable();
+  hooks.sanityCheck('SHUTDOWNWRAP');
+  const as = hooks.activitiesOfTypes('SHUTDOWNWRAP');
+  const a = as[0];
+  assert.strictEqual(a.type, 'SHUTDOWNWRAP', 'shutdown wrap');
+  assert.strictEqual(typeof a.uid, 'number', 'uid is a number');
+  assert.strictEqual(typeof a.triggerId, 'number', 'triggerId is a number');
+  checkInvocations(as[0], { init: 1, before: 1, after: 1, destroy: 1 },
+                   'when process exits');
+}