Added optional descriptions to tests, and properly display them

README.md

@@ -265,6 +265,7 @@ To test them, you'll need to add a yaml file (or files, as you can define as man
 
 ~~~yaml
 - name: operatorName
+  description: An optional description of your test
   input:
     # ...
   output:
@@ -281,6 +282,7 @@ Note that it's an array, so you can set as many tests as you want for each opera
 Let's see what's every part:
 
 - `operatorName`: The operator name to be tested. Note that it must be `operatorName` not `operator-file-name`!
+- `description`: Is shown during the tests, so you can properly know where the logs come from.
 - `input`: The payload the queue should receive as input.
 - `output`: How should it look after exiting.
 - `response`: Used by the HTTP plugin mock. Mocks responses for every specified `actionName`.

package.json

@@ -48,6 +48,7 @@
   "dependencies": {
     "axios": "^0.18.0",
     "axios-mock-adapter": "^1.15.0",
+    "chalk": "^2.4.1",
     "config": "^1.27.0",
     "deepmerge": "^2.2.1",
     "express": "^4.16.2",

src/worker/execution-plugins/__mocks__/http.ts

@@ -1,5 +1,4 @@
 import { HTTPPluginOptionsSchema } from '../../../schemas/PluginOptionsSchema'
-import json from '../../../../test/operators-tester.json'
 import logger from '../../../services/logger'
 
 export default class HttpPlugin {

test/members-signup-1.yml

@@ -1,4 +1,5 @@
 - name: membersSignup
+  description: Case email template is specified in privateMeta
   input:
     member:
       name: John Doe

test/members-signup-2.yml

@@ -1,4 +1,5 @@
 - name: membersSignup
+  description: Case email template is NOT specified in privateMeta
   input:
     member:
       name: John Doe

test/operators-tester.spec.ts

@@ -1,5 +1,6 @@
 import fs from 'fs'
 import yaml from 'js-yaml'
+import chalk from 'chalk'
 
 import { loadOperators } from '../src/services/OperatorsLoader'
 import ActionCreator, { extractMessage } from '../src/worker/ActionCreator'
@@ -92,6 +93,14 @@ describe('Test operators', () => {
       const job = jobs[key]
       const { test, operator } = job
 
+      process.stdout.write(`\n${chalk.yellow('━')} Running actions for operator ${operator.name}...\n`)
+
+      if (test.description) {
+        process.stdout.write(`${chalk.yellow('┗')} ${test.description}\n`)
+      }
+
+      process.stdout.write('\n')
+
       const results = await executeActions(new Event(operator), test)
 
       expect(results).toEqual(test.output)

yarn.lock

@@ -744,7 +744,7 @@ chalk@^1.1.3:
     strip-ansi "^3.0.0"
     supports-color "^2.0.0"
 
-chalk@^2.0.0, chalk@^2.0.1:
+chalk@^2.0.0, chalk@^2.0.1, chalk@^2.4.1:
   version "2.4.1"
   resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.1.tgz#18c49ab16a037b6eb0152cc83e3471338215b66e"
   integrity sha512-ObN6h1v2fTJSmUXoS3nMQ92LbDK9be4TV+6G+omQlGJFdcUX5heKi1LZ1YnRMIgwTLEj3E24bT6tYni50rlCfQ==