test(instrumentations): make the instrumentation tests for mysql, pg and mongodb run on CI

Author: dszakallas

.editorconfig

@@ -11,11 +11,11 @@ indent_style = space
 indent_size = 4
 trim_trailing_whitespace = true
 
-[Makefile]
+[{Makefile,**.mk}]
 indent_style = tab
 indent_size = 4
 
-[*.{js,json,yaml,yml}]
+[**.{js,json,yaml,yml}]
 indent_style = space
 indent_size = 2
 charset = utf-8

circle.yml

@@ -2,12 +2,14 @@ machine:
   node:
     version: 4.4.4
   environment:
+    NODE_VERSION_FW: 6
     NODE_VERSIONS: 0.12 4 5 6 7
     RELEASE_REPONAME: trace-nodejs
     RELEASE_BRANCH: master
 
 dependencies:
   pre:
+    - NODE_VERSION=$NODE_VERSION_FW ./scripts/run-ci.sh ./scripts/install-node.sh
     - ./scripts/run-ci.sh ./scripts/node-matrix.sh ./scripts/install-node.sh
   override:
     - exit 0
@@ -16,6 +18,7 @@ test:
   override:
     - ./scripts/run-ci.sh ./scripts/node-matrix.sh ./scripts/prepare.sh ./scripts/lint.sh ./scripts/test-unit.sh ./scripts/test-cover.sh ./scripts/test-e2e.sh:
         parallel: true
+    - ./scripts/run-ci.sh ./scripts/test-instrumentations.sh
 
 deployment:
   release:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@risingstack/trace",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "author": "RisingStack, Inc.",
   "license": "SEE LICENSE IN LICENSE",
   "contributors": "RisingStack",
@@ -17,7 +17,7 @@
   ],
   "release": {
     "verifyConditions": {
-      "path":  "./node_modules/semantic-release/src/lib/plugin-noop.js"
+      "path": "./node_modules/semantic-release/src/lib/plugin-noop.js"
     }
   },
   "main": "lib/index.js",

scripts/test-instrumentations.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -e
+source ./scripts/util/env-node.sh
+
+nvm use $NODE_VERSION_FW
+
+if [[ -z $INSTR_TARGET_VERSIONS ]]; then
+    INSTR_TARGET_VERSIONS=some
+fi
+
+cd ./test/instrumentations
+make test TARGET_VERSIONS=$INSTR_TARGET_VERSIONS

scripts/util/env-essential.sh

@@ -22,6 +22,7 @@ if [[ -z $ENV_ESSENTIAL_SOURCED ]]; then
         if [[ -n "$REPOSITORY_URL" ]] && [[ -n "$GH_TOKEN" ]]; then
            export REPOSITORY_PUSH_URL=$(echo $REPOSITORY_URL | sed -r "s|https?://(.+)/|https://risingbot:$GH_TOKEN@\1/|")
         fi
+        export NODE_VERSION_FW=6
     else
         # local
         export CURRENT_BRANCH=$(git branch --no-color | awk '/\*/{ print $2 }')
@@ -35,6 +36,7 @@ if [[ -z $ENV_ESSENTIAL_SOURCED ]]; then
         export COMMIT_AUTHOR=$(git log -1 --pretty=%an)
         export REPOSITORY_URL=$(git config --get remote.origin.url)
         export REPOSITORY_PUSH_URL=$REPOSITORY_URL
+        export NODE_VERSION_FW=6
     fi
 fi
 

test/instrumentations/Makefile

@@ -0,0 +1,35 @@
+.PHONY: before test
+
+cur_path := $(abspath $(lastword $(MAKEFILE_LIST)))
+cur_dir := $(dir $(cur_path))
+cur_base := $(notdir $(cur_path))
+
+# Use this variable for invoking the test runner
+export MOCHA := $(shell npm bin)/mocha
+
+# You can have multiple set of target versions tested for each library.
+# Obviously we cannot accept a list of concrete versions, because then
+# it should be listed for every library. Instead, there are 3 target sets
+# all: all versions
+# some: important / recent versions
+# one: most important version, stable version for smoke test
+#
+# Default is all, but it can be overriden from the command line
+TARGET_VERSIONS?=all
+configure_targets = $(if $(filter one,$(TARGET_VERSIONS)),$(1),$(if $(filter some,$(TARGET_VERSIONS)),$(2),)$(if $(filter all,$(TARGET_VERSIONS)),$(3),))
+
+# Every library instrumentation should have a subrecipe in its directory
+# containing the target test_suite_<LIBRARY_NAME>
+# and should append <LIBRARY_NAME> to the variable `targets`
+include $(cur_dir)/*/*.mk
+
+# We have a common package json for every test suite, because it is much more
+# fast this way. Of course you could install other dependencies in the test
+# suites. This is actually needed for versioning.
+before :
+	npm i
+
+test : $(targets:%=test_suite_%)
+
+# On best practices for writing a test suite for an instrumentation, please
+# see mysql/mysql.mk

test/instrumentations/amqp/amqp.spec.cls.js

@@ -0,0 +1,54 @@
+target := pg
+
+all = 0.2.0 0.2.1 0.3.0 0.3.2 0.4.0 0.4.2 0.5.0 0.5.1
+some = 0.3.0 0.4.0 0.5.0
+one = 0.4.0
+
+versions := $(call configure_targets,$(one),$(some),$(all))
+
+targets := $(targets) $(target)
+
+# set up as target specific variables to avoid collision in other
+# makefiles
+test_suite_$(target) : target := $(target)
+test_suite_$(target) : versions := $(versions)
+test_suite_$(target) : cur_path := $(abspath $(lastword $(MAKEFILE_LIST)))
+test_suite_$(target) : cur_dir := $(dir $(cur_path))
+test_suite_$(target) : cur_base := $(notdir $(cur_path))
+test_suite_$(target) : amqp_url := amqp://localhost
+test_suite_$(target) : errors := 0
+
+# normally all tasks should be phony
+.PHONY : before_$(target) \
+	$(versions:%=before_version_$(target)_%) \
+	$(versions:%=test_$(target)_%) \
+	$(versions:%=after_version_$(target)_%) \
+	after_$(target) \
+	test_suite_$(target)
+
+# 'this should run before the test
+before_$(target) : before
+	@echo '*---------------*'
+	@echo '| amqplib       |'
+	@echo '*---------------*'
+	AMQP_URL=$(amqp_url) $(addprefix $(cur_dir), verify.js)
+
+# this should run after `before` for each of the version targets
+# before the test
+$(versions:%=before_version_$(target)_%) : before_$(target)
+	npm i amqplib@$(subst before_version_$(target)_,,$@)
+
+
+# run the test for each of the versions
+$(versions:%=test_$(target)_%) : test_% : before_version_%
+	AMQP_URL=$(db_host) $(MOCHA) $(addprefix $(cur_dir), *.spec.js) || exit 0;
+
+# this should run before `after` for each of the version targets
+# after the test suite
+$(versions:%=after_version_$(target)_%) : $(versions:%=test_$(target)_%)
+
+# this should run after the test
+after_$(target) : $(versions:%=after_version_$(target)_%)
+
+## this is the whole test suite
+test_suite_$(target) : after_$(target)

test/instrumentations/amqplib/amqplib.mk

@@ -1,42 +1,73 @@
 'use strict'
 
+require('../test-setup.spec.js')
+
 var expect = require('chai').expect
 var wrapper = require('@risingstack/trace/lib/instrumentations/amqplib')
 var microtime = require('@risingstack/trace/lib/optionalDependencies/microtime')
+var Storage = require('@risingstack/trace/lib/agent/storage')
+
+describe.only('amqplib', function () {
+  var fakeAgent
 
-describe('amqplib module wrapper', function () {
   beforeEach(function () {
-    delete require.cache[require.resolve('amqplib/lib/connection')]
-    delete require.cache[require.resolve('amqplib/lib/callback_model')]
-    delete require.cache[require.resolve('amqplib/lib/channel_model')]
-    delete require.cache[require.resolve('amqplib/callback_api')]
-    delete require.cache[require.resolve('amqplib/channel_api')]
-    delete require.cache[require.resolve('amqplib')]
+    fakeAgent = {
+      incomingEdgeMetrics: {
+        report: this.sandbox.spy()
+      },
+      getRequestId: this.sandbox.spy(),
+      generateRequestId: this.sandbox.stub().returns('42'),
+      generateCommId: this.sandbox.stub().returns('52'),
+      getServiceKey: this.sandbox.stub().returns('62'),
+      storage: new Storage()
+    }
+    this.sandbox.stub(microtime, 'now').returns(42)
   })
 
-  describe('channel api', function () {
+  describe('channel api module wrapper', function () {
     beforeEach(function () {
+      wrapper.instrumentations[5].post(require('amqplib/lib/connection'), fakeAgent)
+      wrapper.instrumentations[3].post(require('amqplib/lib/channel_model'), fakeAgent)
+    })
+
+    afterEach(function () {
       delete require.cache[require.resolve('amqplib/lib/connection')]
       delete require.cache[require.resolve('amqplib/lib/channel_model')]
       delete require.cache[require.resolve('amqplib/channel_api')]
       delete require.cache[require.resolve('amqplib')]
     })
 
-    it('instruments publish - consume', function (done) {
-      this.sandbox.stub(microtime, 'now').returns(42)
-      var fakeAgent = {
-        incomingEdgeMetrics: {
-          report: this.sandbox.spy()
-        },
-        getRequestId: this.sandbox.spy(),
-        generateRequestId: this.sandbox.stub().returns('42'),
-        generateCommId: this.sandbox.stub().returns('52'),
-        getServiceKey: this.sandbox.stub().returns('62')
-      }
-      wrapper.instrumentations[5].post(require('amqplib/lib/connection'), fakeAgent)
-      wrapper.instrumentations[3].post(require('amqplib/lib/channel_model'), fakeAgent)
+    it('looks transparent', function (done) {
+      var open = require('amqplib').connect(process.env.AMQP_URL)
+      open.then(function (conn) {
+        return conn.createChannel()
+      }).then(function (ch) {
+        ch.assertQueue('test').then(function (ok) {
+          return ch.sendToQueue('test', new Buffer('something'))
+        }).catch(function (err) {
+          done(err)
+        }).then(function () {
+          ch.consume('test', function (msg) {
+            try {
+              ch.ack(msg)
+              expect(fakeAgent.incomingEdgeMetrics.report).to.have.been.calledWith({
+                protocol: 'amqp',
+                serviceKey: 62,
+                transportDelay: 0
+              })
+              ch.close()
+              done()
+            } catch (err) {
+              ch.close()
+              done(err)
+            }
+          })
+        })
+      })
+    })
 
-      var open = require('amqplib').connect('amqp://localhost')
+    it('is instrumented for incoming edges', function (done) {
+      var open = require('amqplib').connect(process.env.AMQP_URL)
 
       // Publisher
       open.then(function (conn) {
@@ -55,9 +86,10 @@ describe('amqplib module wrapper', function () {
                 serviceKey: 62,
                 transportDelay: 0
               })
-              expect(msg.content.toString()).to.eql('something')
+              ch.close()
               done()
             } catch (err) {
+              ch.close()
               done(err)
             }
           })
@@ -66,35 +98,49 @@ describe('amqplib module wrapper', function () {
     })
   })
 
-  describe('callback api', function () {
+  describe('callback api module wrapper', function () {
     beforeEach(function () {
+      wrapper.instrumentations[5].post(require('amqplib/lib/connection'), fakeAgent)
+      wrapper.instrumentations[4].post(require('amqplib/lib/callback_model'), fakeAgent)
+    })
+
+    afterEach(function () {
       delete require.cache[require.resolve('amqplib/lib/connection')]
       delete require.cache[require.resolve('amqplib/lib/callback_model')]
       delete require.cache[require.resolve('amqplib/callback_api')]
       delete require.cache[require.resolve('amqplib')]
     })
 
-    it('instruments publish - consume', function (done) {
-      this.sandbox.stub(microtime, 'now').returns(42)
-      var fakeAgent = {
-        incomingEdgeMetrics: {
-          report: this.sandbox.spy()
-        },
-        getRequestId: this.sandbox.spy(),
-        generateRequestId: this.sandbox.stub().returns('42'),
-        generateCommId: this.sandbox.stub().returns('52'),
-        getServiceKey: this.sandbox.stub().returns('62')
-      }
-      wrapper.instrumentations[5].post(require('amqplib/lib/connection'), fakeAgent)
-      wrapper.instrumentations[4].post(require('amqplib/lib/callback_model'), fakeAgent)
+    it('looks transparent', function (done) {
+      require('amqplib/callback_api')
+        .connect(process.env.AMQP_URL, function (err, conn) {
+          if (err != null) done(err)
+          conn.createChannel(onOpen)
+          function onOpen (err, ch) {
+            if (err != null) done(err)
+            ch.consume('test-cb', function (msg) {
+              try {
+                ch.ack(msg)
+                expect(msg.content.toString()).to.eql('callback')
+                ch.close()
+                done()
+              } catch (err) {
+                ch.close()
+                done(err)
+              }
+            })
+            ch.sendToQueue('test-cb', new Buffer('callback'))
+          }
+        })
+    })
 
+    it('is instrumented for incoming edges', function (done) {
       require('amqplib/callback_api')
-        .connect('amqp://localhost', function (err, conn) {
+        .connect(process.env.AMQP_URL, function (err, conn) {
           if (err != null) done(err)
           conn.createChannel(onOpen)
           function onOpen (err, ch) {
             if (err != null) done(err)
-            ch.assertQueue('test-cb')
             ch.consume('test-cb', function (msg) {
               try {
                 ch.ack(msg)
@@ -103,13 +149,14 @@ describe('amqplib module wrapper', function () {
                   serviceKey: 62,
                   transportDelay: 0
                 })
-                expect(msg.content.toString()).to.eql('callback')
+                ch.close()
                 done()
               } catch (err) {
+                ch.close()
                 done(err)
               }
             })
-            ch.sendToQueue('test-cb', new Buffer('callback'))
+            ch.sendToQueue('test-cb', new Buffer(''))
           }
         })
     })