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, 62 insertions, 0 deletions

diff --git a/test/async-hooks/test-zlib.zlib-binding.deflate.js b/test/async-hooks/test-zlib.zlib-binding.deflate.js
new file mode 100644
index 0000000000..715d1652b9
--- /dev/null
+++ b/test/async-hooks/test-zlib.zlib-binding.deflate.js
@@ -0,0 +1,62 @@
+'use strict';
+
+const common = require('../common');
+const assert = require('assert');
+const initHooks = require('./init-hooks');
+const { checkInvocations } = require('./hook-checks');
+
+const hooks = initHooks();
+
+hooks.enable();
+const Zlib = process.binding('zlib').Zlib;
+const constants = process.binding('constants').zlib;
+
+const handle = new Zlib(constants.DEFLATE);
+
+const as = hooks.activitiesOfTypes('ZLIB');
+assert.strictEqual(as.length, 1, 'one zlib on when created handle');
+const hdl = as[0];
+assert.strictEqual(hdl.type, 'ZLIB', 'zlib');
+assert.strictEqual(typeof hdl.uid, 'number', 'uid is a number');
+assert.strictEqual(typeof hdl.triggerId, 'number', 'triggerId is a number');
+checkInvocations(hdl, { init: 1 }, 'when created handle');
+
+handle.init(
+  constants.Z_DEFAULT_WINDOWBITS,
+  constants.Z_MIN_LEVEL,
+  constants.Z_DEFAULT_MEMLEVEL,
+  constants.Z_DEFAULT_STRATEGY,
+  Buffer.from('')
+);
+checkInvocations(hdl, { init: 1 }, 'when initialized handle');
+
+const inBuf = Buffer.from('x');
+const outBuf = Buffer.allocUnsafe(1);
+
+let count = 2;
+handle.callback = common.mustCall(onwritten, 2);
+handle.write(true, inBuf, 0, 1, outBuf, 0, 1);
+checkInvocations(hdl, { init: 1 }, 'when invoked write() on handle');
+
+function onwritten() {
+  if (--count) {
+    // first write
+    checkInvocations(hdl, { init: 1, before: 1 },
+                     'when wrote to handle the first time');
+    handle.write(true, inBuf, 0, 1, outBuf, 0, 1);
+  } else {
+    // second write
+    checkInvocations(hdl, { init: 1, before: 2, after: 1 },
+                     'when wrote to handle the second time');
+  }
+}
+
+process.on('exit', onexit);
+
+function onexit() {
+  hooks.disable();
+  hooks.sanityCheck('ZLIB');
+  // TODO: destroy never called here even with large amounts of ticks
+  // is that correct?
+  checkInvocations(hdl, { init: 1, before: 2, after: 2 }, 'when process exits');
+}