Merge pull request #184 from apiaryio/netmilk/dredd-yml-override

Dredd init fix

Author: Adam Kliment

README.md

@@ -20,25 +20,25 @@ to Gavel's [behavior specification][].
 
 ## Get Started Testing API Documentation and backend
 
-1. I you don't have [Node.js](https://nodejs.org/) installed, you may want to use [NVM](https://github.com/creationix/nvm)
-1. Create an API blueprint in `blueprint.md`
-1. Install Dredd
+- I you don't have [Node.js](https://nodejs.org/) installed, you may want to use [NVM](https://github.com/creationix/nvm)
+- Create an API blueprint in `blueprint.md`
+- Install Dredd
 
-    ```
-    $ npm install -g dredd
-    ```
+```
+$ npm install -g dredd
+```
 
-1. Run interactive configuration:
+- Run interactive configuration:
 
-    ```
-    $ dredd init
-    ```
+```
+$ dredd init
+```
 
-1. Run dredd
+- Run dredd
 
-    ```
-    $ dredd
-    ```
+```
+$ dredd
+```
 
 ## Documentation
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dredd",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "API Blueprint testing tool",
   "main": "lib/dredd.js",
   "bin": {

src/dredd-command.coffee

@@ -32,6 +32,7 @@ class DreddCommand
 
   setOptimistArgv: ->
     @optimist = optimist(@custom['argv'], @custom['cwd'])
+    @cliArgv = @optimist.argv
 
     @optimist.usage(
       """
@@ -134,6 +135,12 @@ class DreddCommand
       console.log 'Configuration dredd.yml found, ignoring other arguments.'
       @argv = configUtils.load()
 
+    # overwrite saved config with cli arguments
+    for key, value of @cliArgv
+      if key != "_" and key != "$0"
+        @argv[key] = value
+
+
   parseCustomConfig: () ->
     @argv.custom = configUtils.parseCustom @argv.custom
 

src/dredd.coffee

@@ -28,6 +28,10 @@ removeDuplicates = (arr) ->
 
 class Dredd
   constructor: (config) ->
+    @init(config)
+
+  # this is here only because there there is no way how to spy a constructor in CoffeScript
+  init: (config) ->
     @tests = []
     @stats =
       tests: 0

src/interactive-config.coffee

@@ -40,18 +40,28 @@ interactiveConfig.prompt = (config = {}, callback) ->
     name: "apiaryApiKey"
     message: "Please enter Apiary API key or leave empty for anonymous reporter"
     default: config['custom']?['apiaryApiKey']
-    when: (answers) -> (answers['apiary'] == true && ! config['custom']?['apiaryApiKey']?)
+    when: (answers) ->
+      # it's not GA on the Apiary side yet
+      if process.env['APIARY_BETA']?
+        (answers['apiary'] == true && ! config['custom']?['apiaryApiKey']?)
+      else
+        false
   }
 
   questions.push {
     type: "input"
     name: "apiaryApiName"
     message: "Please enter Apiary API name"
     default: config['custom']?['apiaryApiName']
-    when: (answers) -> (
-      (answers['apiary'] == true && ! config['custom']?['apiaryApiName']?) &&
-      (answers['apiary'] == true && answers['apiaryApiKey'] != '')
-    )
+    when: (answers) ->
+      # it's not GA on the Apiary side yet
+      if process.env['APIARY_BETA']?
+        (
+          (answers['apiary'] == true && ! config['custom']?['apiaryApiName']?) &&
+          (answers['apiary'] == true && answers['apiaryApiKey'] != '')
+        )
+      else
+        false
   }
 
   questions.push {

test/integration/cli-test.coffee

@@ -962,7 +962,7 @@ describe "Command line interface", () ->
     it 'stdout shoud contain sandbox messagae', () ->
       assert.include stdout, 'Loading hookfiles in sandboxed context'
 
-  # WARNING: this text is excluded from code coverage
+  # WARNING: this test is excluded from code coverage
   # it for some reason decreases coverage on local and in coveralls
   describe 'when using --server', () ->
     resourceRequested = false

test/unit/dredd-command-test.coffee

@@ -1,16 +1,16 @@
 {assert} = require 'chai'
 sinon = require 'sinon'
 express = require 'express'
-
 proxyquire = require('proxyquire').noCallThru()
 
+options = require '../../src/options'
 packageJson = require '../../package.json'
+
+childProcessStub = require 'child_process'
 loggerStub = require '../../src/logger'
 interactiveConfigStub = require '../../src/interactive-config'
 configUtilsStub = require '../../src/config-utils'
-options = require '../../src/options'
-
-childProcessStub = require 'child_process'
+fsStub = require 'fs'
 
 PORT = 9876
 
@@ -22,19 +22,24 @@ stdout = ''
 addHooksStub = proxyquire '../../src/add-hooks', {
   './logger': loggerStub
 }
+
 transactionRunner = proxyquire '../../src/transaction-runner', {
   './add-hooks': addHooksStub
   './logger': loggerStub
 }
+
 dreddStub = proxyquire '../../src/dredd', {
   './transaction-runner': transactionRunner
   './logger': loggerStub
 }
+
 DreddCommand = proxyquire '../../src/dredd-command', {
   './dredd': dreddStub
   'console': loggerStub
   './interactive-init': interactiveConfigStub
   'child_process': childProcessStub
+  './config-utils': configUtilsStub
+  'fs': fsStub
 }
 
 
@@ -173,25 +178,6 @@ describe "DreddCommand class", () ->
 
         assert.isObject dc.dreddInstance
 
-    describe "when custom option is present", () ->
-      it 'should parse custom options'
-      it 'the custom option should become an object'
-
-    describe "when .dredd.yml file is present", () ->
-      it 'should load it'
-
-    describe "when load option is present", () ->
-      it 'should load given file instead of .dredd.yml'
-
-    describe "when config file is not parseable", () ->
-      it 'should gracefuly end'
-
-    describe "when server option is given", () ->
-      it 'should run the server'
-
-      describe "when test run finishes", () ->
-        it 'should kill the server'
-
   describe 'run with argv set to load regular blueprint', ->
     dc = null
     runDreddStub = null
@@ -294,7 +280,85 @@ describe "DreddCommand class", () ->
       it 'prints out an error message', ->
         assert.include stderr, 'Error: Must specify'
 
-  # describe.only 'when using --server', () ->
+
+  describe 'when configuration was saved', () ->
+    before (done) ->
+      sinon.spy dreddStub.prototype, 'init'
+      sinon.stub dreddStub.prototype, 'run', (cb) ->
+        stats =
+          tests: 0
+          failures: 0
+          errors: 0
+          passes: 0
+          skipped: 0
+          start: 0
+          end: 0
+          duration: 0
+        cb(null, stats)
+
+      sinon.stub interactiveConfigStub, 'run', (config, cb) ->
+        cb()
+
+      sinon.stub fsStub, 'existsSync', () -> true
+
+      sinon.stub configUtilsStub, 'load', () ->
+        {
+          "_": [ 'blueprint', 'endpoint' ]
+          'dry-run': true
+          hookfiles: null
+          sandbox: false
+          save: null
+          load: null
+          server: null
+          init: false
+          custom: []
+          names: false
+          only: []
+          reporter: []
+          output: []
+          header: []
+          sorted: false
+          user: null
+          'inline-errors': false
+          details: false
+          method: []
+          color: true
+          level: 'info'
+          timestamp: false
+          silent: false
+          path: []
+          '$0': 'node ./bin/dredd'
+        }
+
+      execCommand argv: ['--names'], ->
+        done()
+
+    after () ->
+      dreddStub.prototype.run.restore()
+      dreddStub.prototype.init.restore()
+      interactiveConfigStub.run.restore()
+      configUtilsStub.load.restore()
+      fsStub.existsSync.restore()
+
+    describe 'and I pass another CLI argument', () ->
+      it 'should want to exit with status 0', () ->
+        console.log stderr
+        assert.equal exitStatus, 0
+
+      it 'should call dredd run', () ->
+        assert.isTrue dreddStub.prototype.run.called
+
+      it 'should override existing configuration', () ->
+        assert.isTrue dreddStub.prototype.init.called
+        call = dreddStub.prototype.init.getCall(0)
+        passedConf = call.args[0]
+        assert.propertyVal passedConf.options, 'names', true
+
+
+
+
+
+  # describe 'when using --server', () ->
 
   #   beforeEach (done) ->