test(instrumentation/http): cover with tests

Author: Peter Marton

Diff for: package-lock.json

@@ -46,6 +46,7 @@
     "knex": "0.13.0",
     "mocha": "3.4.2",
     "monk": "6.0.1",
+    "nock": "9.0.13",
     "npm-run-all": "4.0.2",
     "pg": "6.4.0",
     "request": "2.81.0",

Diff for: package.json

@@ -0,0 +1,100 @@
+'use strict'
+
+const http = require('http')
+const https = require('https')
+const request = require('request-promise-native')
+const nock = require('nock')
+const { expect } = require('chai')
+const { Tracer, Tags } = require('opentracing')
+const cls = require('../cls')
+const instrumentation = require('./httpClient')
+
+describe('instrumentation: httpClient', () => {
+  let tracer
+  let mockChildSpan
+
+  beforeEach(function () {
+    tracer = new Tracer()
+    mockChildSpan = {
+      setTag: this.sandbox.spy(),
+      log: this.sandbox.spy(),
+      finish: this.sandbox.spy()
+    }
+
+    this.sandbox.stub(cls, 'startChildSpan').callsFake(() => mockChildSpan)
+
+    instrumentation.patch(http, tracer)
+    instrumentation.patch(https, tracer)
+
+    nock.disableNetConnect()
+  })
+
+  afterEach(() => {
+    instrumentation.unpatch(http)
+    instrumentation.unpatch(https)
+    nock.enableNetConnect()
+    nock.cleanAll()
+  })
+
+  describe('#patch', () => {
+    it('should start and finish span with http', () => {
+      nock('http://risingstack.com')
+        .get('/')
+        .reply(200)
+
+      return request('http://risingstack.com')
+        .then(() => {
+          expect(cls.startChildSpan).to.be.calledWith(tracer, instrumentation.OPERATION_NAME)
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.HTTP_URL, 'http://risingstack.com:80')
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.HTTP_METHOD, 'GET')
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.SPAN_KIND_RPC_CLIENT, true)
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.HTTP_STATUS_CODE, 200)
+          expect(mockChildSpan.finish).to.have.callCount(1)
+        })
+    })
+
+    it('should start and finish span with https', () => {
+      nock('https://risingstack.com')
+        .get('/')
+        .reply(200)
+
+      return request('https://risingstack.com')
+        .then(() => {
+          expect(cls.startChildSpan).to.be.calledWith(tracer, instrumentation.OPERATION_NAME)
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.HTTP_URL, 'http://risingstack.com:443')
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.HTTP_METHOD, 'GET')
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.SPAN_KIND_RPC_CLIENT, true)
+          expect(mockChildSpan.setTag).to.have.calledWith(Tags.HTTP_STATUS_CODE, 200)
+          expect(mockChildSpan.finish).to.have.callCount(1)
+        })
+    })
+
+    it('should flag wrong status codes as error', () => {
+      nock('https://risingstack.com')
+        .get('/')
+        .reply(400)
+
+      return request('https://risingstack.com')
+        .catch(() => {
+          expect(mockChildSpan.setTag).to.be.calledWith(Tags.ERROR, true)
+        })
+    })
+
+    it('should flag error', () => {
+      nock('https://risingstack.com')
+        .get('/')
+        .replyWithError('My Error')
+
+      return request('https://risingstack.com')
+        .catch((err) => {
+          expect(mockChildSpan.setTag).to.be.calledWith(Tags.ERROR, true)
+          expect(mockChildSpan.log).to.be.calledWith({
+            event: 'error',
+            'error.object': err.cause,
+            message: err.cause.message,
+            stack: err.cause.stack
+          })
+        })
+    })
+  })
+})