test: Updated unit tests to use node:test (#282)

Author: svetlanabrennan

package.json

@@ -8,7 +8,7 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "lint:lockfile": "lockfile-lint --path package-lock.json --type npm --allowed-hosts npm --validate-https --validate-integrity",
-    "unit": "c8 -o ./coverage/unit tap --expose-gc --jobs=1 --no-coverage tests/unit/*.tap.js",
+    "unit": "c8 -o ./coverage/unit borp --expose-gc --timeout 180000 'tests/unit/*.test.js'",
     "integration": "c8 -o ./coverage/integration tap --timeout 360000 --jobs=1 --no-coverage tests/integration/*.tap.js",
     "native": "node tests/native/*.js",
     "test": "npm run unit && npm run integration",
@@ -80,6 +80,7 @@
     "@newrelic/proxy": "^2.0.0",
     "async": "^3.2.2",
     "aws-sdk": "^2.266.1",
+    "borp": "^0.19.0",
     "c8": "^8.0.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",

tests/unit/gc-metrics.tap.js

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const test = require('node:test')
+const assert = require('node:assert')
+
+test('GC Metrics', async () => {
+  const metricEmitter = require('../..')()
+
+  global.gc()
+
+  const gcs = metricEmitter.getGCMetrics()
+  const keys = Object.keys(gcs)
+  assert.ok(keys.length > 0, 'should notice at least one GC')
+  assert.equal(typeof keys[0], 'string', 'should have strings as keys')
+
+  // GC stats objects
+  const stats = gcs[keys[0]]
+  assert.equal(typeof stats, 'object', 'should have stats objects')
+  assert.equal(typeof stats.typeId, 'number', 'should have the type ID')
+  assert.equal(typeof stats.type, 'string', 'should have the type name')
+  assert.equal(typeof stats.metrics, 'object', 'should have a metrics object')
+
+  // GC stats metrics
+  const metrics = gcs[keys[0]].metrics
+  assert.equal(typeof metrics.total, 'number', 'should have total field')
+  assert.equal(typeof metrics.min, 'number', 'should have min field')
+  assert.equal(typeof metrics.max, 'number', 'should have max field')
+  assert.equal(typeof metrics.sumOfSquares, 'number', 'should have sumOfSquares field')
+  assert.equal(typeof metrics.count, 'number', 'should have count field')
+
+  assert.ok(metrics.total > 0, 'should have reasonable values for total')
+  assert.ok(metrics.min > 0, 'should have reasonable values for min')
+  assert.ok(metrics.max > 0, 'should have reasonable values for max')
+  assert.ok(metrics.max >= metrics.min, 'should have a max larger than a min')
+  assert.ok(metrics.sumOfSquares > 0, 'should have reasonable values for sumOfSquares')
+  assert.ok(metrics.count > 0, 'should have reasonable values for count')
+})

tests/unit/gc-metrics.test.js

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const test = require('node:test')
+const assert = require('node:assert')
+
+test('Loop Metrics', async (t) => {
+  const MICRO_TO_MILLIS = 1e-3
+  const SPIN_TIME = 2000
+  const CPU_EPSILON = SPIN_TIME * 0.05 // Allowed fudge factor for CPU times in MS
+  const metricEmitter = require('../..')({ timeout: 10 })
+  const testStart = Date.now()
+
+  t.after(() => {
+    metricEmitter.unbind()
+  })
+
+  // Check the structure of the metric object.
+  let metric = metricEmitter.getLoopMetrics().usage
+  assert.strictEqual(typeof metric, 'object', 'should provide a metric object')
+  assert.strictEqual(typeof metric.total, 'number', 'should have a total')
+  assert.strictEqual(typeof metric.min, 'number', 'should have a min')
+  assert.strictEqual(typeof metric.max, 'number', 'should have a max')
+  assert.strictEqual(typeof metric.sumOfSquares, 'number', 'should have a sumOfSquares')
+  assert.strictEqual(typeof metric.count, 'number', 'should have a count')
+
+  // Check that the values are reset after the first call. Since this is
+  // synchronous with the previous call, all results should be zero.
+  metric = metricEmitter.getLoopMetrics().usage
+  assert.deepStrictEqual(
+    metric,
+    {
+      total: 0,
+      min: 0,
+      max: 0,
+      sumOfSquares: 0,
+      count: 0
+    },
+    'should reset all the values'
+  )
+
+  // Queue up a loop with some CPU burn.
+  await new Promise((resolve) => setTimeout(resolve, 100))
+
+  // spinning cpu...
+  const start = Date.now()
+  while (Date.now() - start < SPIN_TIME) {} // Spin the CPU for 2 seconds.
+
+  // Wait another tick and then check the loop stats.
+  await new Promise((resolve) => setTimeout(resolve, 100))
+
+  metric = metricEmitter.getLoopMetrics()
+  const testDuration = Date.now() - testStart + CPU_EPSILON
+  const durationSquare = testDuration * testDuration
+  const usage = metric.usage
+
+  const meanTime = usage.total / usage.count
+
+  assert.ok(
+    usage.total * MICRO_TO_MILLIS > SPIN_TIME - CPU_EPSILON,
+    'should have total greater than spin time'
+  )
+  assert.ok(
+    usage.total * MICRO_TO_MILLIS <= testDuration,
+    'should have total less than wall-clock time'
+  )
+  assert.ok(usage.min <= meanTime, 'should have min less than the mean usage time')
+  assert.ok(usage.max >= meanTime, 'should have max greater than the mean usage time')
+  assert.ok(usage.max * MICRO_TO_MILLIS > SPIN_TIME - CPU_EPSILON, 'should have expected max')
+  assert.ok(
+    usage.sumOfSquares * MICRO_TO_MILLIS * MICRO_TO_MILLIS < durationSquare,
+    'should have expected sumOfSquares'
+  )
+  assert.ok(usage.count >= 2, 'should have expected count')
+})