Showing expected header value in the message

apiaryio · May 25, 2015 · d01272a · d01272a
1 parent b4a771a
commit d01272a
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 12 deletions.
diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
   "dependencies": {
     "amanda": "^0.5.1",
     "async": "^1.0.0",
+    "caseless": "^0.10.0",
     "clone": "^1.0.0",
     "commander": "^2.6.0",
     "curl-trace-parser": "0.0.8",

diff --git a/src/mixins/validatable-http-message.coffee b/src/mixins/validatable-http-message.coffee
@@ -221,7 +221,7 @@ class Validatable
           @validation.body.validator = 'JsonExample'
         else
           message =
-            message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.realType}'."
+            message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.expectedType}'."
             severity: 'error'
 
           @validation.body.results.push message
@@ -231,14 +231,14 @@ class Validatable
           @validation.body.validator = 'TextDiff'
         else
           message =
-            message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.realType}'."
+            message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.expectedType}'."
             severity: 'error'
 
           @validation.body.results.push message
 
       else
         message =
-          message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.realType}'."
+          message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.expectedType}'."
           severity: 'error'
 
         @validation.body.results.push message

diff --git a/src/utils/tv4-to-headers-message.coffee b/src/utils/tv4-to-headers-message.coffee
@@ -1,4 +1,6 @@
-module.exports = (message) ->
+caseless = require 'caseless'
+
+module.exports = (message, expectedHeaders) ->
   if message.indexOf("Missing required property:") > 1
     headerName = message.split("Missing required property: ")[1]
     newMessage = "Header '#{headerName}' is missing"
@@ -12,8 +14,9 @@ module.exports = (message) ->
     headerValue = splitted[1]
     headerValue = headerValue.replace(/"$/, '')
 
+    expected = caseless(expectedHeaders).get headerName
 
-    newMessage = "Header '#{headerName}' doesn't have value '#{headerValue}'"
+    newMessage = "Header '#{headerName}' has value '#{headerValue}' instead of '#{expected}'"
 
   else
     throw new Error 'Unknown tv4 error message can\'t convert to headers message.'

diff --git a/src/validators/headers-json-example.coffee b/src/validators/headers-json-example.coffee
@@ -42,7 +42,7 @@ class HeadersJsonExample extends JsonSchema
     result = super()
     if result.length > 0
       for i in [0..(result.length - 1)]
-        result[i]['message'] = tv4ToHeadersMessage result[i]['message']
+        result[i]['message'] = tv4ToHeadersMessage result[i]['message'], @expected
 
     result
   #@private

diff --git a/test/unit/utils/tv4-to-headers-message-test.coffee b/test/unit/utils/tv4-to-headers-message-test.coffee
@@ -1,19 +1,21 @@
 {assert} = require 'chai'
+
 tv4ToHeadersMessage = require '../../../src/utils/tv4-to-headers-message'
+fixtures = require '../../fixtures'
 
 describe 'tv4ToHeadersMessages()', ->
-
+  expectedHeaders = fixtures.sampleHeaders
   describe 'when message for missing header', ->
     it 'should return message with right text', ->
       tv4Message = 'At \'/header2\' Missing required property: header2'
-      message = tv4ToHeadersMessage(tv4Message)
+      message = tv4ToHeadersMessage(tv4Message, expectedHeaders)
       assert.equal message, "Header 'header2' is missing"
 
   describe 'when message for different value', ->
     it 'should return message with right text', ->
       tv4Message = 'At \'/content-type\' No enum match for: "application/fancy-madiatype"'
-      message = tv4ToHeadersMessage(tv4Message)
-      assert.equal message, "Header 'content-type' doesn't have value 'application/fancy-madiatype'"
+      message = tv4ToHeadersMessage(tv4Message, expectedHeaders)
+      assert.equal message, "Header 'content-type' has value 'application/fancy-madiatype' instead of 'application/json'"
 
   describe 'when unknonw message', ->
     it 'should throw an error', ->

diff --git a/test/unit/validators/headers-json-example-validator-test.coffee b/test/unit/validators/headers-json-example-validator-test.coffee
@@ -75,8 +75,7 @@ describe 'HeadersJsonExample', ->
 
         it 'should have beautiful error message', ->
           result = headersValidator.validate()
-          console.log result
-          assert.equal result[0].message, "Header 'content-type' doesn't have value 'application/fancy-madiatype'"
+          assert.equal result[0].message, "Header 'content-type' has value 'application/fancy-madiatype' instead of 'application/json'"
 
     describe 'when key is added to provided headers', ->
       before ->