Merge pull request #484 from apiaryio/honzajavorek/ambiguous-paramete…

…rs-raise-exception

Ambiguous parameters raise exception (fix)

package.json

@@ -31,7 +31,7 @@
     "chai": "^3.4.1",
     "clone": "^1.0.0",
     "coffee-script": "^1.9.1",
-    "dredd-transactions": "0.0.4",
+    "dredd-transactions": "^0.0.5",
     "file": "~0.2.2",
     "gavel": "0.5.2",
     "glob": "^6.0.1",

scripts/test-hooks-handlers.coffee

@@ -59,7 +59,7 @@ yaml = require 'js-yaml'
 
 
 unless process.env.CI
-  console.error ''' \
+  console.error '''\
     This script is meant to be ran on Travis CI. It is not optimized (yet) for
     local usage. It could mess up your Git repository.
   '''

src/handle-runtime-problems.coffee

@@ -19,7 +19,7 @@ handleRuntimeProblems = (blueprintData) ->
       if annotation.component is 'apiDescriptionParser'
         ranges = blueprintUtils.warningLocationToRanges(annotation.location, apiDescriptionDocument)
 
-        message = """ \
+        message = """\
           Parser #{annotation.type} in file '#{filename}': \
           (#{annotation.type} code #{annotation.code}) #{annotation.message} \
         """
@@ -32,12 +32,11 @@ handleRuntimeProblems = (blueprintData) ->
           annotation.origin.actionName
         ].join(' > ')
 
-        log(""" \
+        log("""\
           Compilation #{annotation.type} in file '#{filename}': \
-          #{annotation.message} on #{transactionName} \
+          #{annotation.message} (#{transactionName}) \
         """)
 
-
   return new Error('Error when processing API description.') if error
 
 

src/hooks-worker-client.coffee

@@ -81,7 +81,7 @@ class HooksWorkerClient
     if @language == 'ruby'
       @handlerCommand = 'dredd-hooks-ruby'
       unless which.which @handlerCommand
-        msg = """ \
+        msg = """\
           Ruby hooks handler server command not found: #{@handlerCommand}
           Install ruby hooks handler by running:
           $ gem install dredd_hooks
@@ -93,7 +93,7 @@ class HooksWorkerClient
     else if @language == 'python'
       @handlerCommand = 'dredd-hooks-python'
       unless which.which @handlerCommand
-        msg = """ \
+        msg = """\
           Python hooks handler server command not found: #{@handlerCommand}
           Install python hooks handler by running:
           $ pip install dredd_hooks
@@ -105,7 +105,7 @@ class HooksWorkerClient
     else if @language == 'php'
       @handlerCommand = 'dredd-hooks-php'
       unless which.which @handlerCommand
-        msg = """ \
+        msg = """\
           PHP hooks handler server command not found: #{@handlerCommand}
           Install php hooks handler by running:
           $ composer require ddelnano/dredd-hooks-php --dev
@@ -117,7 +117,7 @@ class HooksWorkerClient
     else if @language == 'perl'
       @handlerCommand = 'dredd-hooks-perl'
       unless which.which @handlerCommand
-        msg = """ \
+        msg = """\
           Perl hooks handler server command not found: #{@handlerCommand}
           Install perl hooks handler by running:
           $ cpanm Dredd::Hooks
@@ -127,7 +127,7 @@ class HooksWorkerClient
         callback()
 
     else if @language == 'nodejs'
-      msg = ''' \
+      msg = '''\
         Hooks handler should not be used for nodejs. \
         Use Dredds' native node hooks instead.
       '''

test/fixtures/apiary.apib

@@ -1,4 +1,4 @@
-FORMAT: X-1A
+FORMAT: 1A
 
 # Machines API
 

test/fixtures/warning-ambiguous.apib

@@ -0,0 +1,38 @@
+FORMAT: 1A
+
+# Machines API
+# Group Machines
+# Machine [/machines/{name}]
+## Retrieve Single Machine [GET]
+
++ Response 200 (application/json; charset=utf-8)
+
+        {
+            "type": "bulldozer",
+            "name": "willy"
+        }
+
+# Machines [/machines/{?sort}]
+## Retrieve All Machines [GET]
+
++ Response 200 (application/json; charset=utf-8)
+
+        [{
+            "type": "bulldozer",
+            "name": "willy"
+        }]
+
+# Machine Types [/machine-types/]
+## Create a New Machine Type [POST]
+
++ Request (application/json; charset=utf-8)
+
+        {
+            "name": "bulldozer"
+        }
+
++ Response 200 (application/json; charset=utf-8)
+
+        [{
+            "name": "bulldozer"
+        }]

test/integration/cli/api-description-cli-test.coffee

@@ -29,6 +29,9 @@ describe 'CLI - API Description Document', ->
     app.get '/machines/caterpillar', (req, res) ->
       res.send {type: 'bulldozer', name: 'caterpillar'}
 
+    app.post '/machine-types', (req, res) ->
+      res.send [{name: 'bulldozer'}]
+
   beforeEach (done) ->
     startServer configureServer, PORT, (err, serverInfo) ->
       server = serverInfo
@@ -102,6 +105,40 @@ describe 'CLI - API Description Document', ->
       it 'should print error message to stderr', ->
         assert.include dreddCommand.stderr, 'Error when reading file'
 
+    describe 'When API description is loaded with errors', ->
+      dreddCommand = undefined
+      args = [
+        './test/fixtures/error-blueprint.apib'
+        "http://localhost:#{PORT}"
+      ]
+
+      beforeEach (done) ->
+        execDredd args, (err, commandInfo) ->
+          dreddCommand = commandInfo
+          done(err)
+
+      it 'should exit with status 1', ->
+        assert.equal dreddCommand.exitStatus, 1
+      it 'should print error message to stderr', ->
+        assert.include dreddCommand.stderr, 'Error when processing API description'
+
+    describe 'When API description is loaded with warnings', ->
+      dreddCommand = undefined
+      args = [
+        './test/fixtures/warning-ambiguous.apib'
+        "http://localhost:#{PORT}"
+      ]
+
+      beforeEach (done) ->
+        execDredd args, (err, commandInfo) ->
+          dreddCommand = commandInfo
+          done(err)
+
+      it 'should exit with status 0', ->
+        assert.equal dreddCommand.exitStatus, 0
+      it 'should print warning to stdout', ->
+        assert.include dreddCommand.stdout, 'warn: Compilation warning'
+
 
   describe 'When loaded from URL', ->