Merge pull request #774 from DaNish808/cmd-tool-returns-0-761

bring back correct exit code on validation w/ errors

Author: rwblair

bids-validator/cli.js

@@ -5,16 +5,30 @@ var colors = require('colors/safe')
 var fs = require('fs')
 const remoteFiles = require('./utils/files/remoteFiles')
 
+const exitProcess = issues => {
+  if (
+    issues === 'Invalid' ||
+    (issues.errors && issues.errors.length >= 1) ||
+    (issues.config && issues.config.length >= 1)
+  ) {
+    process.exit(1)
+  } else {
+    process.exit(0)
+  }
+}
+
 module.exports = function(dir, options) {
   if (fs.existsSync(dir)) {
     if (options.json) {
       validate.BIDS(dir, options, function(issues, summary) {
         console.log(JSON.stringify({ issues, summary }))
+        exitProcess(issues)
       })
     } else {
       validate.BIDS(dir, options, function(issues, summary) {
         console.log(validate.consoleFormat.issues(issues, options) + '\n')
         console.log(validate.consoleFormat.summary(summary, options))
+        exitProcess(issues)
       })
     }
   } else {

bids-validator/tests/cli.spec.js

@@ -3,6 +3,8 @@ const { spawn } = require('child_process')
 const dir = process.cwd()
 const data_dir = dir + '/bids-validator/tests/data/'
 const test_data = data_dir + 'valid_headers/'
+const data_with_errors = data_dir + 'empty_files'
+const data_without_errors = data_dir + 'valid_dataset'
 
 const cli_path = './bids-validator/bin/bids-validator'
 
@@ -55,6 +57,40 @@ describe('CLI', () => {
     })
   })
 
+  it('without errors should exit with code 0', done => {
+    const command = spawn(cli_path, [data_without_errors, '--json'])
+    command.on('exit', code => {
+      assert.equal(code, 0)
+      done()
+    })
+  })
+
+  it('with errors should not exit with code 0', done => {
+    const command = spawn(cli_path, [data_with_errors])
+    command.on('exit', code => {
+      assert.notEqual(code, 0)
+      done()
+    })
+  })
+
+  it('with errors should not exit with code 0 with --json argument', done => {
+    const command = spawn(cli_path, [data_with_errors, '--json'])
+    let commandOutput = []
+    let output = {}
+    command.stdout.on('data', data => {
+      const dataLines = data.toString().split('\n')
+      commandOutput = commandOutput.concat(dataLines)
+    })
+    command.stderr.on('end', () => {
+      output = JSON.parse(commandOutput.join(''))
+    })
+    command.on('exit', code => {
+      assert(output.issues.errors.length > 0)
+      assert.notEqual(code, 0)
+      done()
+    })
+  })
+
   it('should print valid json when the --json argument is provided', done => {
     const command = spawn(cli_path, [test_data, '--json'])
     let commandOutput = ''

bids-validator/tests/data/valid_dataset/dataset_description.json

@@ -0,0 +1,6 @@
+{
+	"Name": "Synthetic dataset for inclusion in BIDS-examples",
+	"BIDSVersion": "1.0.2",
+	"License": "PD",
+	"Authors": ["Markiewicz, C. J."]
+}