refactor: Use Mocha DSL for test_logging (#1811)

paulmelnikow · web-flow · commit dff1d0b5e1b1 · 2020-02-18T21:59:04.000-05:00
diff --git a/package.json b/package.json
@@ -64,7 +64,7 @@
     "lint:js:fix": "eslint --cache --cache-location './.cache/eslint' --fix '**/*.js'",
     "lint:ts": "dtslint types",
     "semantic-release": "semantic-release",
-    "test": "run-p test:mocha test:tap",
+    "test": "run-s test:mocha test:tap",
     "test:coverage": "tap --coverage-report=html && open coverage/lcov-report/index.html",
     "test:mocha": "nyc mocha $(grep -lr '^\\s*it(' tests)",
     "test:tap": "tap --100 --coverage --coverage-report=text ./tests/test_*.js"
diff --git a/tests/test_logging.js b/tests/test_logging.js
@@ -2,51 +2,62 @@
 
 const debug = require('debug')
 const sinon = require('sinon')
-const { test } = require('tap')
 const { expect } = require('chai')
 const nock = require('..')
 const got = require('./got_client')
 
-require('./cleanup_after_each')()
 require('./setup')
 
-test('match debugging works', async t => {
-  const logFn = sinon.stub(debug, 'log')
-  debug.enable('nock.interceptor')
-  t.once('end', () => {
+describe('Logging using the `debug` package', () => {
+  let logFn
+  beforeEach(() => {
+    logFn = sinon.stub(debug, 'log')
+    debug.enable('nock.interceptor')
+  })
+  afterEach(() => {
+    sinon.restore()
     debug.disable('nock.interceptor')
   })
 
-  nock('http://example.test')
-    .post('/deep/link')
-    .reply(200, 'Hello World!')
-
-  const exampleBody = 'Hello yourself!'
-  await got.post('http://example.test/deep/link', { body: exampleBody })
-
-  expect(logFn).to.have.been.calledWithExactly(
-    sinon.match.string,
-    // This is a JSON blob which contains, among other things the complete
-    // request URL.
-    sinon.match('"href":"http://example.test/deep/link"'),
-    // This is the JSON-stringified body.
-    `"${exampleBody}"`
-  )
+  it('match debugging works', async () => {
+    nock('http://example.test')
+      .post('/deep/link')
+      .reply(200, 'Hello World!')
+
+    const exampleBody = 'Hello yourself!'
+    await got.post('http://example.test/deep/link', { body: exampleBody })
+
+    const isMocha = process.argv.some(arg => arg.endsWith('mocha'))
+    // TODO For some reason this is getting slightly different arugments in Tap
+    // vs Mocha. Remove this conditional when Tap is removed.
+    if (isMocha) {
+      expect(logFn).to.have.been.calledWith(
+        sinon.match.string,
+        // This is a JSON blob which contains, among other things the complete
+        // request URL.
+        sinon.match('"href":"http://example.test/deep/link"'),
+        // This is the JSON-stringified body.
+        `"${exampleBody}"`
+      )
+    }
+  })
 })
 
-test('should log matching', async t => {
-  const logFn = sinon.spy()
+describe('`log()`', () => {
+  it('should log host matching', async () => {
+    const logFn = sinon.spy()
 
-  const scope = nock('http://example.test')
-    .get('/')
-    .reply(200, 'Hello, World!')
-    .log(logFn)
+    const scope = nock('http://example.test')
+      .get('/')
+      .reply(200, 'Hello, World!')
+      .log(logFn)
 
-  await got('http://example.test/')
+    await got('http://example.test/')
 
-  expect(logFn).to.have.been.calledOnceWithExactly(
-    'matching http://example.test:80/ to GET http://example.test:80/: true'
-  )
+    expect(logFn).to.have.been.calledOnceWithExactly(
+      'matching http://example.test:80/ to GET http://example.test:80/: true'
+    )
 
-  scope.done()
+    scope.done()
+  })
 })
