Update tests and docs

Author: jwulf

.circleci/config.yml

@@ -32,7 +32,7 @@ jobs:
   # Runs the tests, including integration
   test:
     docker:
-      - image: circleci/node:11.10.1
+      - image: circleci/node:14.2.0
       - image: camunda/zeebe:0.23.1
     working_directory: ~/zeebe-client-node-js
     steps:

.gitignore

@@ -5,4 +5,5 @@ docs
 .vscode
 cctest.ts
 t.ts
-yolo.bpmn
+yolo.bpmn
+crash-*.log

README.md

@@ -204,7 +204,7 @@ const { ZBClient, Duration } = require('zeebe-node')
 
 const zbc = new ZBClient(gatewayAddress, {
     retry: true,
-    maxRetries: 50,
+    maxRetries: -1, // infinite retries
     maxRetryTimeout: Duration.seconds.of(5)
 })
 ```

jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  testPathIgnorePatterns: ['node_modules', 'dist']
-};
+	preset: 'ts-jest',
+	testEnvironment: 'node',
+	testPathIgnorePatterns: ['node_modules', 'dist'],
+}

src/__tests__/BpmnParser.spec.ts

@@ -4,70 +4,65 @@ const testBpmnFile = __dirname + '/testdata/BpmnParser2.bpmn'
 const simpleTestBpmnFile = __dirname + '/testdata/BpmnParser.bpmn'
 const modeller7File = __dirname + '/testdata/modeller7File.bpmn'
 
-describe('parseBpmn', () => {
-	const parsed = BpmnParser.parseBpmn(testBpmnFile)
-	const parsedSimple = BpmnParser.parseBpmn(simpleTestBpmnFile)
-	describe('parseBpmn', () => {
-		it('parses a bpmn file to an Object', () => {
-			expect(typeof parsed).toBe('object')
-			expect(typeof parsedSimple).toBe('object')
-		})
-		it('can parse a file with a message with no name', async () => {
-			const parsedv7 = await BpmnParser.generateConstantsForBpmnFiles(
-				modeller7File
-			)
-			// console.log(parsedv7)
-			expect(typeof parsedv7).toBe('string')
-		})
-	})
-	describe('getTaskTypes', () => {
-		it('gets a unique list of task types when passed an object', async () => {
-			const taskTypes = await BpmnParser.getTaskTypes(parsed)
-			expect(taskTypes.length).toBe(2)
-		})
-		it('gets a list of unique task types when passed an array', async () => {
-			const taskTypes = await BpmnParser.getTaskTypes([
-				parsed,
-				parsedSimple,
-			])
-			expect(taskTypes.length).toBe(3)
-		})
-	})
-	describe('getMessageNames', () => {
-		it('gets a list of unique message names when passed an object', async () => {
-			const messageNames = await BpmnParser.getMessageNames(parsed)
-			expect(messageNames.length).toBe(2)
-		})
-		it('gets a list of unique message names when passed an array', async () => {
-			const messageNames = await BpmnParser.getMessageNames([
-				parsed,
-				parsedSimple,
-			])
-			expect(messageNames.length).toBe(3)
-		})
-	})
-	describe('generateConstantsForBpmnFiles', () => {
-		it('Returns a constants file for a single Bpmn file', async () => {
-			const constants = await BpmnParser.generateConstantsForBpmnFiles(
-				testBpmnFile
+const parsed = BpmnParser.parseBpmn(testBpmnFile)
+const parsedSimple = BpmnParser.parseBpmn(simpleTestBpmnFile)
+
+test('parses a bpmn file to an Object', () => {
+	expect(typeof parsed).toBe('object')
+	expect(typeof parsedSimple).toBe('object')
+})
+
+test('can parse a file with a message with no name', async () => {
+	const parsedv7 = await BpmnParser.generateConstantsForBpmnFiles(
+		modeller7File
+	)
+	// console.log(parsedv7)
+	expect(typeof parsedv7).toBe('string')
+})
+
+test('gets a unique list of task types when passed an object', async () => {
+	const taskTypes = await BpmnParser.getTaskTypes(parsed)
+	expect(taskTypes.length).toBe(2)
+})
+
+test('gets a list of unique task types when passed an array', async () => {
+	const taskTypes = await BpmnParser.getTaskTypes([parsed, parsedSimple])
+	expect(taskTypes.length).toBe(3)
+})
+
+test('gets a list of unique message names when passed an object', async () => {
+	const messageNames = await BpmnParser.getMessageNames(parsed)
+	expect(messageNames.length).toBe(2)
+})
+
+test('gets a list of unique message names when passed an array', async () => {
+	const messageNames = await BpmnParser.getMessageNames([
+		parsed,
+		parsedSimple,
+	])
+	expect(messageNames.length).toBe(3)
+})
+
+test('Returns a constants file for a single Bpmn file', async () => {
+	const constants = await BpmnParser.generateConstantsForBpmnFiles(
+		testBpmnFile
+	)
+	expect(constants.indexOf('console-log')).not.toBe(-1)
+})
+
+test('Returns a constants file for an array of Bpmn files', async () => {
+	const constants = await BpmnParser.generateConstantsForBpmnFiles([
+		testBpmnFile,
+		simpleTestBpmnFile,
+	])
+	expect(
+		constants
+			.split(' ')
+			.join('')
+			.split('\n')
+			.join('')
+			.indexOf(
+				`exportenumMessageName{MSG_EMIT_FRAME="MSG-EMIT_FRAME",MSG_EMIT_FRAME_1="MSG-EMIT_FRAME`
 			)
-			expect(constants.indexOf('console-log')).not.toBe(-1)
-		})
-		it('Returns a constants file for an array of Bpmn files', async () => {
-			const constants = await BpmnParser.generateConstantsForBpmnFiles([
-				testBpmnFile,
-				simpleTestBpmnFile,
-			])
-			expect(
-				constants
-					.split(' ')
-					.join('')
-					.split('\n')
-					.join('')
-					.indexOf(
-						`exportenumMessageName{MSG_EMIT_FRAME="MSG-EMIT_FRAME",MSG_EMIT_FRAME_1="MSG-EMIT_FRAME`
-					)
-			).not.toBe(-1)
-		})
-	})
+	).not.toBe(-1)
 })