Merge pull request #20 from ExpediaDotCom/integration-tests

shreyaa-sharma · web-flow · commit 17b7c1b6fadd · 2018-08-06T11:36:25.000-07:00
Adding integration tests using docker and haystack-agent
diff --git a/.travis.yml b/.travis.yml
@@ -2,6 +2,9 @@ sudo: required
 
 language: node_js
 
+services:
+  - docker
+
 node_js:
   - "6"
 
@@ -11,12 +14,8 @@ env:
     - TAG=${TRAVIS_TAG}
     - SHA=${TRAVIS_COMMIT}
 
-cache:
-  directories:
-  - node_modules
-
 script:
-  - make build
+  - make build integration_tests
 
 before_deploy:
   - make prepare_publish
diff --git a/Makefile b/Makefile
@@ -22,7 +22,20 @@ prepare_publish:
 
 .PHONY: test
 test:
-	./node_modules/mocha/bin/mocha -r ./node_modules/ts-node/register tests/**/*.ts
+	./node_modules/mocha/bin/mocha -r ./node_modules/ts-node/register tests/unit/**/*.ts
+
+.PHONY: integration_tests
+integration_tests:
+	docker-compose -f integration-tests/docker-compose.yml -p sandbox up -d
+	sleep 15
+	docker run -it \
+	    --rm \
+		--network=sandbox_default \
+		-v $(PWD):/ws \
+		-w /ws \
+		node:6-alpine \
+		/bin/sh -c 'mkdir -p ws2 && cp -a src tests package.json  tsconfig.json ws2/ && cd ws2 && npm i && ./node_modules/mocha/bin/mocha -r ./node_modules/ts-node/register tests/integration/**/*.ts'
+	docker-compose -f integration-tests/docker-compose.yml -p sandbox stop
 
 .PHONY: compile
 compile:
diff --git a/integration-tests/docker-compose.yml b/integration-tests/docker-compose.yml
@@ -0,0 +1,31 @@
+version: '3'
+services:
+   haystack_agent:
+    image: expediadotcom/haystack-agent:0.1
+    depends_on:
+    - zookeeper
+    - kafkasvc
+    environment:
+      haystack_env_agents_spans_port: 35000
+      haystack_env_agents_spans_dispatchers_kafka_bootstrap_servers: "kafkasvc:9092"
+    ports:
+    - "35000:35000"
+    entrypoint:
+    - /bin/sh
+    - -c
+    - 'sleep 10 && java -jar /app/bin/haystack-agent.jar --config-provider file --file-path /app/bin/dev.conf'
+   zookeeper:
+    image: wurstmeister/zookeeper
+    ports:
+    - "2181:2181"
+   kafkasvc:
+     image: wurstmeister/kafka:2.11-1.1.1
+     depends_on:
+     - zookeeper
+     environment:
+       KAFKA_ADVERTISED_HOST_NAME: "kafkasvc"
+       KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181 
+     volumes:
+     - /var/run/docker.sock:/var/run/docker.sock
+     ports:
+     - "9092:9092"
diff --git a/package.json b/package.json
@@ -13,9 +13,6 @@
     "type": "git",
     "url": "git://github.com/ExpediaDotCom/haystack-client-node.git"
   },
-  "scripts": {
-    "lint": "tslint -t msbuild -c tslint.json 'src/**/*.ts'"
-  },
   "contributors": [
     "Haystack <haystack@expedia.com>"
   ],
@@ -29,6 +26,8 @@
     "@types/node": "7.0.12",
     "@types/chai": "3.4.35",
     "@types/mocha": "2.2.40",
+    "@types/kafka-node": "2.0.7",
+    "kafka-node": "2.6.1",
     "chai": "^3.5.0",
     "grpc-tools": "1.6.6",
     "mocha": "^2.5.3",
diff --git a/scripts/version.js b/scripts/version.js
@@ -1,8 +1,8 @@
 const pkginfo = require('npm-registry-package-info');
 const semver = require('semver');
+const { resolve }  = require('path');
 const fs = require('fs');
 
-
 const moduleName = 'haystack-client';
 
 const opts = {
@@ -23,8 +23,7 @@ pkginfo(opts, (error, data) => {
     if (semver.lte(releaseVersion, currentVersion)) {
         throw new Error(`Current haystack-client on npm registry has greater than or equal new release version ${releaseVersion}. Check your git tag version`);
     }
-    const rawPackageJson = fs.readFileSync('package.json');
-    const packageJson = JSON.parse(rawPackageJson);
+    const packageJson = require(resolve(process.cwd(), 'package.json'));
     packageJson.version = releaseVersion;
     fs.writeFileSync('package.json', JSON.stringify(packageJson, null, ' '));
 });
diff --git a/src/dispatchers/dispatcher.ts b/src/dispatchers/dispatcher.ts
@@ -18,6 +18,6 @@ import Span from '../span';
 
 export interface Dispatcher {
     name(): string;
-    dispatch(span: Span, callback: (error) => void): void;
+    dispatch(span: Span, callback?: (error) => void): void;
     close(callback: () => void): void;
 }
diff --git a/src/dispatchers/remote.ts b/src/dispatchers/remote.ts
@@ -15,7 +15,6 @@
  */
 
 import * as grpc from 'grpc';
-const messages  = require('../proto_idl_codegen/span_pb');
 const services  = require('../proto_idl_codegen/agent/spanAgent_grpc_pb');
 import {Dispatcher} from './dispatcher';
 import Span from '../span';
@@ -39,7 +38,7 @@ export default class RemoteDispatcher implements Dispatcher {
     }
 
     dispatch(span: Span, callback: (error) => void): void {
-        const proto = this._convertToProtoSpan(span);
+        const proto = Utils.convertToProtoSpan(span);
         this._client.dispatch(proto, (err, response) => {
             if (err) {
                 if (this._logger) {
@@ -59,73 +58,6 @@ export default class RemoteDispatcher implements Dispatcher {
         });
     }
 
-    private _convertToProtoSpan(span: Span): any {
-        const protoSpan = new messages.Span();
-        protoSpan.setServicename(span.serviceName());
-        protoSpan.setOperationname(span.operationName());
-        protoSpan.setTraceid(span.context().traceId);
-        protoSpan.setSpanid(span.context().spanId);
-        protoSpan.setParentspanid(span.context().parentSpanId);
-        protoSpan.setStarttime(span.startTime());
-        protoSpan.setDuration(span.duration());
-
-        const protoSpanTags = [];
-
-        const tags = span.tags();
-        for (const k in tags) {
-            if (tags.hasOwnProperty(k)) {
-                protoSpanTags.push(RemoteDispatcher._createProtoTag(k, tags[k]));
-            }
-        }
-
-        protoSpan.setTagsList(protoSpanTags);
-
-        const protoSpanLogs = [];
-        span.logs().forEach(log => {
-            const protoLog = new messages.Log();
-            const protoLogTags = [];
-            const kvPairs = log.keyValuePairs;
-            for (const k in kvPairs) {
-                if (kvPairs.hasOwnProperty(k)) {
-                    protoLogTags.push(RemoteDispatcher._createProtoTag(k, kvPairs[k]));
-                }
-            }
-            protoLog.setTimestamp(log.timestamp);
-            protoLog.setFieldsList(protoLogTags);
-            protoSpanLogs.push(protoLog);
-        });
-
-        protoSpan.setLogsList(protoSpanLogs);
-        return protoSpan;
-    }
-
-    private static _createProtoTag(key: string, value: any): any {
-        const protoTag = new messages.Tag();
-        protoTag.setKey(key);
-
-        const tagValue = value;
-        if (typeof tagValue === 'number') {
-            if (Utils.isFloatType(tagValue)) {
-                protoTag.setVdouble(tagValue);
-                protoTag.setType(messages.Tag.TagType.DOUBLE);
-            } else {
-                protoTag.setVlong(tagValue);
-                protoTag.setType(messages.Tag.TagType.LONG);
-            }
-        } else if (typeof tagValue === 'boolean') {
-            protoTag.setVbool(tagValue);
-            protoTag.setType(messages.Tag.TagType.BOOL);
-        } else if (typeof tagValue === 'string') {
-            protoTag.setVstr(tagValue);
-            protoTag.setType(messages.Tag.TagType.STRING);
-        } else {
-            protoTag.setVbytes(tagValue);
-            protoTag.setType(messages.Tag.TagType.BINARY);
-        }
-
-        return protoTag;
-    }
-
     close(callback: () => void): void {
         grpc.closeClient(this._client);
         if (callback) {
diff --git a/src/utils.ts b/src/utils.ts
@@ -14,11 +14,13 @@
  *       limitations under the License.
  */
 
-import uuidv4 = require('uuid/v4');
+import * as uuid from 'uuid';
+import Span from './span';
+const messages  = require('./proto_idl_codegen/span_pb');
 
 export default class Utils {
     static randomUUID(): string {
-        return uuidv4();
+        return uuid.v4();
     }
 
     static assign(origObject, key, value): any {
@@ -57,4 +59,71 @@ export default class Utils {
     static isFloatType(value: number): boolean {
         return (value % 1 !== 0);
     }
+
+    static convertToProtoSpan(span: Span): any {
+        const protoSpan = new messages.Span();
+        protoSpan.setServicename(span.serviceName());
+        protoSpan.setOperationname(span.operationName());
+        protoSpan.setTraceid(span.context().traceId);
+        protoSpan.setSpanid(span.context().spanId);
+        protoSpan.setParentspanid(span.context().parentSpanId);
+        protoSpan.setStarttime(span.startTime());
+        protoSpan.setDuration(span.duration());
+
+        const protoSpanTags = [];
+
+        const tags = span.tags();
+        for (const k in tags) {
+            if (tags.hasOwnProperty(k)) {
+                protoSpanTags.push(this._createProtoTag(k, tags[k]));
+            }
+        }
+
+        protoSpan.setTagsList(protoSpanTags);
+
+        const protoSpanLogs = [];
+        span.logs().forEach(log => {
+            const protoLog = new messages.Log();
+            const protoLogTags = [];
+            const kvPairs = log.keyValuePairs;
+            for (const k in kvPairs) {
+                if (kvPairs.hasOwnProperty(k)) {
+                    protoLogTags.push(this._createProtoTag(k, kvPairs[k]));
+                }
+            }
+            protoLog.setTimestamp(log.timestamp);
+            protoLog.setFieldsList(protoLogTags);
+            protoSpanLogs.push(protoLog);
+        });
+
+        protoSpan.setLogsList(protoSpanLogs);
+        return protoSpan;
+    }
+
+    private static _createProtoTag(key: string, value: any): any {
+        const protoTag = new messages.Tag();
+        protoTag.setKey(key);
+
+        const tagValue = value;
+        if (typeof tagValue === 'number') {
+            if (Utils.isFloatType(tagValue)) {
+                protoTag.setVdouble(tagValue);
+                protoTag.setType(messages.Tag.TagType.DOUBLE);
+            } else {
+                protoTag.setVlong(tagValue);
+                protoTag.setType(messages.Tag.TagType.LONG);
+            }
+        } else if (typeof tagValue === 'boolean') {
+            protoTag.setVbool(tagValue);
+            protoTag.setType(messages.Tag.TagType.BOOL);
+        } else if (typeof tagValue === 'string') {
+            protoTag.setVstr(tagValue);
+            protoTag.setType(messages.Tag.TagType.STRING);
+        } else {
+            protoTag.setVbytes(tagValue);
+            protoTag.setType(messages.Tag.TagType.BINARY);
+        }
+
+        return protoTag;
+    }
 }
diff --git a/tests/integration/agent-integration.spec.ts b/tests/integration/agent-integration.spec.ts
diff --git a/tests/unit/api-compat.spec.ts b/tests/unit/api-compat.spec.ts
diff --git a/tests/unit/tracer.spec.ts b/tests/unit/tracer.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,6 @@ import Span from '../span';`
`18`	`18`
`19`	`19`	`export interface Dispatcher {`
`20`	`20`	`name(): string;`
`21`		`- dispatch(span: Span, callback: (error) => void): void;`
	`21`	`+ dispatch(span: Span, callback?: (error) => void): void;`
`22`	`22`	`close(callback: () => void): void;`
`23`	`23`	`}`