Merge pull request #363 from danjm/tests-option-tap-spec

Add tap-spec option to npm test commands for mocha style reporting

README.md

@@ -283,6 +283,23 @@ test docs), provided by the index of the array element in the test ``transaction
 Run a state test from a specified source file not under the ``tests`` directory:
 `node ./tests/tester -s --customStateTest='{path_to_file}'`
 
+#### Running tests with a reporter/formatter
+
+`npm run formatTest -t [npm script name OR node command]` will pipe to `tap-spec` by default.
+
+To pipe the results of the API tests through `tap-spec`:
+
+`npm run formatTest -- -t testAPI`
+
+To pipe the results of tests run with a node command through `tap-spec`:
+
+`npm run formatTest -- -t "./tests/tester -b --dir='bcBlockGasLimitTest'"`
+
+The `-with` flag allows the specification of a formatter of your choosing:
+
+`npm install -g tap-mocha-reporter`
+`npm run formatTest -- -t testAPI -with 'tap-mocha-reporter json'`
+
 #### Skipping Tests
 
 There are three types of skip lists (``BROKEN``, ``PERMANENT`` and ``SLOW``) which

package.json

@@ -23,7 +23,8 @@
     "test": "node ./tests/tester -a",
     "lint": "standard",
     "prepublishOnly": "npm run lint && npm run build:dist && npm run testBuildIntegrity",
-    "build:dist": "babel lib/ -d dist/"
+    "build:dist": "babel lib/ -d dist/",
+    "formatTest": "node ./scripts/formatTest"
   },
   "repository": {
     "type": "git",
@@ -60,6 +61,7 @@
     "minimist": "^1.1.1",
     "nyc": "^12.0.2",
     "standard": "^10.0.0",
+    "tap-spec": "^5.0.0",
     "tape": "4.6.3"
   },
   "author": "mjbecze <[email protected]>",

scripts/formatTest.js

@@ -0,0 +1,37 @@
+const { spawn } = require('child_process')
+const fs = require('fs')
+const path = require('path')
+
+const testScript = process.argv.find((arg, i, array) => array[i - 1] === '-t')
+const formatter = process.argv.find((arg, i, array) => array[i - 1] === '-with')
+
+runTestsWithFormatter(testScript, formatter)
+
+function runTestsWithFormatter (testScript, formatter = './node_modules/.bin/tap-spec') {
+  if (!testScript) {
+    console.log('No test script specified!')
+    return
+  }
+
+  const packageJson = fs.readFileSync(path.dirname(__dirname) + '/package.json', 'utf8')
+  const parsedPackageJson = JSON.parse(packageJson)
+  const npmTestScriptNames = Object.keys(parsedPackageJson.scripts)
+
+  const commandToRun = npmTestScriptNames.find(name => name === testScript)
+    ? `npm run ${testScript}`
+    : `node ${testScript}`
+
+  const child = spawn('sh', ['-c', `${commandToRun} | ${formatter}`])
+
+  child.stdout.on('data', (data) => {
+    process.stdout.write(data)
+  })
+
+  child.stderr.on('data', (data) => {
+    process.stdout.write(data)
+  })
+
+  child.on('exit', (data) => {
+    process.stdout.write('Done')
+  })
+}