Merge be74a5d into 8753847

cybertk · Apr 8, 2015 · dfb4ce6 · dfb4ce6
2 parents 8753847 + be74a5d
commit dfb4ce6
Show file tree

Hide file tree

Showing 8 changed files with 174 additions and 41 deletions.
diff --git a/src/add-tests.coffee b/src/add-tests.coffee
@@ -1,8 +1,18 @@
 async = require 'async'
 _ = require 'underscore'
+csonschema = require 'csonschema'
 
 Test = require './test'
 
+parseSchema = (source) ->
+  if source.contains('$schema')
+    #jsonschema
+    # @response.schema = JSON.parse @response.schema
+    JSON.parse source
+  else
+    csonschema.parse source
+    # @response.schema = csonschema.parse @response.schema
+
 parseHeaders = (raml) ->
   return {} unless raml
 
@@ -68,8 +78,12 @@ addTests = (raml, tests, parent, callback) ->
 
         # Update test.response
         test.response.status = status
-        test.response.schema = res?.body?['application/json']?.schema
-
+        test.response.schema = []
+        if (raml.schemas)
+          test.response.schema = raml.schemas
+        if (res?.body?['application/json']?.schema)
+          test.response.schema.push parseSchema res.body['application/json'].schema
+
       callback()
     , (err) ->
       return callback(err) if err

diff --git a/src/test.coffee b/src/test.coffee
@@ -1,5 +1,4 @@
 chai = require 'chai'
-csonschema = require 'csonschema'
 request = require 'request'
 _ = require 'underscore'
 async = require 'async'
@@ -57,15 +56,6 @@ class Test
         callback()
     ], callback
 
-  parseSchema: (source) =>
-    if source.contains('$schema')
-      #jsonschema
-      # @response.schema = JSON.parse @response.schema
-      JSON.parse source
-    else
-      csonschema.parse source
-      # @response.schema = csonschema.parse @response.schema
-
   assertResponse: (error, response, body) =>
     assert.isNull error
     assert.isNotNull response, 'Response'
@@ -79,7 +69,7 @@ class Test
 
     # Body
     if @response.schema
-      schema = @parseSchema @response.schema
+      schema = @response.schema
       validateJson = _.partial JSON.parse, body
       body = '[empty]' if body is ''
       assert.doesNotThrow validateJson, JSON.SyntaxError, """

diff --git a/test/fixtures/inline_and_included_schemas.raml b/test/fixtures/inline_and_included_schemas.raml
@@ -0,0 +1,25 @@
+#%RAML 0.8
+
+title: World Music API
+baseUri: http://example.api.com/{version}
+version: v1
+
+schemas:
+  - type1: !include ./type1.json
+  - type2: !include ./type2.json
+
+/machines:
+  get:
+    responses:
+      200:
+        body:
+          application/json:
+            schema: |
+              {
+                "type": "object",
+                "$schema": "http://json-schema.org/draft-03/schema",
+                "properties": {
+                  "type": {"$ref": "type2"},
+                  "name": "string"
+                }
+              }
diff --git a/test/fixtures/ref_other_schemas.raml b/test/fixtures/ref_other_schemas.raml
@@ -0,0 +1,17 @@
+#%RAML 0.8
+
+title: World Music API
+baseUri: http://example.api.com/{version}
+version: v1
+
+schemas:
+  - type1: !include ./type1.json
+  - type2: !include ./type2.json
+
+/machines:
+  get:
+    responses:
+      200:
+        body:
+          application/json:
+            schema: type2
diff --git a/test/fixtures/type1.json b/test/fixtures/type1.json
@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "type": "object",
+  "description": "A type",
+  "properties": {
+    "type": "string",
+    "name": "string",
+    "chick": { "type": "string"}
+  }
+}
diff --git a/test/fixtures/type2.json b/test/fixtures/type2.json
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "type": "object",
+  "description": "Another type",
+  "properties": {
+    "chick": { "type": "string"}
+  }
+}
+
diff --git a/test/unit/add-tests-test.coffee b/test/unit/add-tests-test.coffee
@@ -56,12 +56,9 @@ describe '#addTests', ->
         res = tests[0].response
 
         assert.equal res.status, 200
-        assert.equal res.schema, """[
-          type: 'string'
-          name: 'string'
-        ]
-
-        """
+        schema = res.schema[0]
+        assert.equal schema.items.properties.type.type, 'string'
+        assert.equal schema.items.properties.name.type, 'string'
         assert.isNull res.headers
         assert.isNull res.body
 
@@ -105,11 +102,96 @@ describe '#addTests', ->
         res = tests[1].response
 
         assert.equal res.status, 201
-        assert.equal res.schema, """
-          type: 'string'
-          name: 'string'
+        schema = res.schema[0]
+        assert.equal schema.properties.type.type, 'string'
+        assert.equal schema.properties.name.type, 'string'
+        assert.isNull res.headers
+        assert.isNull res.body
 
-        """
+    describe 'when raml includes multiple referencing schemas', ->
+
+      tests = []
+      callback = ''
+
+      before (done) ->
+
+        ramlParser.loadFile("#{__dirname}/../fixtures/ref_other_schemas.raml")
+        .then (data) ->
+          callback = sinon.stub()
+          callback.returns(done())
+
+          addTests data, tests, callback
+        , done
+      after ->
+        tests = []
+
+      it 'should run callback', ->
+        assert.ok callback.called
+
+      it 'should added 1 test', ->
+        assert.lengthOf tests, 1
+
+      it 'should set test.name', ->
+        assert.equal tests[0].name, 'GET /machines -> 200'
+
+      it 'should setup test.request', ->
+        req = tests[0].request
+
+        assert.equal req.path, '/machines'
+        assert.deepEqual req.params, {}
+        assert.deepEqual req.query, {}
+        assert.deepEqual req.body, {}
+        assert.equal req.method, 'GET'
+
+      it 'should setup test.response', ->
+        res = tests[0].response
+
+        assert.equal res.status, 200
+        assert.lengthOf res.schema, 3
+        assert.isNull res.headers
+        assert.isNull res.body
+
+    describe 'when raml has inline and included schemas', ->
+
+      tests = []
+      callback = ''
+
+      before (done) ->
+
+        ramlParser.loadFile("#{__dirname}/../fixtures/inline_and_included_schemas.raml")
+        .then (data) ->
+          callback = sinon.stub()
+          callback.returns(done())
+
+          addTests data, tests, callback
+        , done
+      after ->
+        tests = []
+
+      it 'should run callback', ->
+        assert.ok callback.called
+
+      it 'should added 1 test', ->
+        assert.lengthOf tests, 1
+
+      it 'should set test.name', ->
+        assert.equal tests[0].name, 'GET /machines -> 200'
+
+      it 'should setup test.request', ->
+        req = tests[0].request
+
+        assert.equal req.path, '/machines'
+        assert.deepEqual req.params, {}
+        assert.deepEqual req.query, {}
+        assert.deepEqual req.body, {}
+        assert.equal req.method, 'GET'
+
+      it 'should setup test.response', ->
+        res = tests[0].response
+
+        assert.equal res.status, 200
+        # console.log res.schema
+        assert.lengthOf res.schema, 3
         assert.isNull res.headers
         assert.isNull res.body
 

diff --git a/test/unit/test-test.coffee b/test/unit/test-test.coffee
@@ -43,10 +43,7 @@ describe 'Test', ->
         test.request.body =
           body: 'value'
         test.response.status = 201
-        test.response.schema = """
-          type: 'string'
-          name: 'string'
-        """
+        test.response.schema = [{ type: 'object', properties: { type: 'string', name: 'string'}}]
 
         machine =
           type: 'foo'
@@ -85,10 +82,6 @@ describe 'Test', ->
         response = test.response
         # Unchanged properties
         assert.equal response.status, 201
-        assert.deepEqual response.schema, """
-          type: 'string'
-          name: 'string'
-        """
 
         # changed properties
         # assert.equal response.headers, 201
@@ -116,10 +109,7 @@ describe 'Test', ->
         test.request.body =
           body: 'value'
         test.response.status = 200
-        test.response.schema = """
-          type: 'string'
-          name: 'string'
-        """
+        test.response.schema = [{ type: 'object', properties: { type: 'string', name: 'string'}}]
 
         machine =
           type: 'foo'
@@ -158,10 +148,6 @@ describe 'Test', ->
         response = test.response
         # Unchanged properties
         assert.equal response.status, 200
-        assert.deepEqual response.schema, """
-          type: 'string'
-          name: 'string'
-        """
         assert.deepEqual response.body, machine
 
 
@@ -196,14 +182,14 @@ describe 'Test', ->
 
     test = new Test()
     test.response.status = 201
-    test.response.schema = JSON.stringify
+    test.response.schema = {
       $schema: 'http://json-schema.org/draft-04/schema#'
       type: 'object'
       properties:
         type:
           type: 'string'
         name:
-          type: 'string'
+          type: 'string'}
 
     describe 'when against valid response', ->