Merge pull request #195 from cybertk/0.5.0

0.5.0

README.md

@@ -221,11 +221,15 @@ Options:
                                                                        [boolean]
   --grep, -g        Only run tests matching <pattern>                   [string]
   --invert, -i      Invert --grep matches                              [boolean]
+  --sorted          Sorts requests in a sensible way so that objects are not
+                    modified before they are created. Order: CONNECT, OPTIONS,
+                    POST, GET, HEAD, PUT, PATCH, DELETE, TRACE.        [boolean]
   --timeout, -t     Set test-case timeout in milliseconds
                                                         [number] [default: 2000]
   --template        Specify the template file to use for generating hooks
-                                                                        [string]                                                      
+                                                                        [string]
   --names, -n       List names of requests and exit                    [boolean]
+  --generate-hooks  Output hooks generated from template file and exit [boolean]
   --reporters       Display available reporters and exit               [boolean]
   --help            Show usage information and exit                    [boolean]
   --version         Show version number and exit                       [boolean]

lib/abao.coffee

@@ -42,7 +42,7 @@ class Abao
         if !config.options.server
           if raml.baseUri
             config.options.server = raml.baseUri
-        addTests raml, tests, hooks, callback, factory
+        addTests raml, tests, hooks, callback, factory, config.options.sorted
       ,
       # Run tests
       (callback) ->

lib/add-tests.coffee

@@ -1,5 +1,5 @@
 async = require 'async'
-_ = require 'underscore'
+_ = require 'lodash'
 csonschema = require 'csonschema'
 
 
@@ -21,11 +21,11 @@ parseHeaders = (raml) ->
 
   headers
 
-# addTests(raml, tests, [parent], callback, config)
-addTests = (raml, tests, hooks, parent, callback, testFactory) ->
+addTests = (raml, tests, hooks, parent, callback, testFactory, sortFirst) ->
 
   # Handle 4th optional param
   if _.isFunction(parent)
+    sortFirst = testFactory
     testFactory = callback
     callback = parent
     parent = null
@@ -41,7 +41,7 @@ addTests = (raml, tests, hooks, parent, callback, testFactory) ->
     # Apply parent properties
     if parent
       path = parent.path + path
-      params = _.clone parent.params
+      params = _.clone parent.params      # shallow copy
 
     # Setup param
     if resource.uriParameters
@@ -52,6 +52,49 @@ addTests = (raml, tests, hooks, parent, callback, testFactory) ->
     # In case of issue #8, resource does not define methods
     resource.methods ?= []
 
+    if sortFirst && resource.methods.length > 1
+      methodTests = [
+          method: 'CONNECT', tests: []
+        ,
+          method: 'OPTIONS', tests: []
+        ,
+          method: 'POST',    tests: []
+        ,
+          method: 'GET',     tests: []
+        ,
+          method: 'HEAD',    tests: []
+        ,
+          method: 'PUT',     tests: []
+        ,
+          method: 'PATCH',   tests: []
+        ,
+          method: 'DELETE',  tests: []
+        ,
+          method: 'TRACE',   tests: []
+      ]
+
+      # Group endpoint tests by method name
+      _.each methodTests, (methodTest) ->
+        isSameMethod = (test) ->
+          return methodTest.method == test.method.toUpperCase()
+
+        ans = _.partition resource.methods, isSameMethod
+        if ans[0].length != 0
+          _.each ans[0], (test) -> methodTest.tests.push test
+          resource.methods = ans[1]
+
+      # Shouldn't happen unless new HTTP method introduced...
+      leftovers = resource.methods
+      if leftovers.length > 1
+        console.error 'unknown method calls present!', leftovers
+
+      # Now put them back, but in order of methods listed above
+      sortedTests = _.map methodTests, (methodTest) -> return methodTest.tests
+      leftoverTests = _.map leftovers, (leftover) -> return leftover
+      reassembled = _.flattenDeep [_.reject sortedTests,   _.isEmpty,
+                                   _.reject leftoverTests, _.isEmpty]
+      resource.methods = reassembled
+
     # Iterate response method
     async.each resource.methods, (api, callback) ->
       method = api.method.toUpperCase()
@@ -108,7 +151,7 @@ addTests = (raml, tests, hooks, parent, callback, testFactory) ->
       return callback(err) if err
 
       # Recursive
-      addTests resource, tests, hooks, {path, params}, callback, testFactory
+      addTests resource, tests, hooks, {path, params}, callback, testFactory, sortFirst
   , callback
 
 

lib/apply-configuration.coffee

@@ -33,6 +33,7 @@ applyConfiguration = (config) ->
       grep: ''
       invert: false
       'hooks-only': false
+      sorted: false
 
   # Normalize options and config
   for own key, value of config

lib/options.coffee

@@ -40,6 +40,12 @@ options =
     description: 'Invert --grep matches'
     type: 'boolean'
 
+  sorted:
+    description: 'Sorts requests in a sensible way so that objects are not ' +
+                 'modified before they are created.\nOrder: ' +
+                 'CONNECT, OPTIONS, POST, GET, HEAD, PUT, PATCH, DELETE, TRACE.'
+    type: 'boolean'
+
   timeout:
     alias: 't'
     description: 'Set test-case timeout in milliseconds'

lib/test.coffee

@@ -18,8 +18,7 @@ class TestFactory
     if schemaLocation
 
       files = glob.sync schemaLocation
-      console.error 'Found JSON ref schemas: ' + files
-      console.error ''
+      console.log '\tJSON ref schemas: ' + files.join(', ')
 
       tv4.banUnknown = true
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "abao",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "RAML testing tool",
   "bin": "bin/abao",
   "main": "lib/index.js",
@@ -60,6 +60,7 @@
     "source-map-support": "^0.4.0",
     "tv4": "^1.2.7",
     "underscore": "^1.8.2",
+    "lodash": "^4.16.4",
     "yargs": "~6.0.0"
   }
 }

test/cli-test.coffee

@@ -47,7 +47,7 @@ execCommand = (cmd, callback) ->
 
 describe 'Command line interface', ->
 
-  describe 'When run with "one and done" options', (done) ->
+  describe 'when run with "one and done" options', (done) ->
 
     describe 'when RAML argument unnecessary', () ->
 
@@ -161,7 +161,7 @@ describe 'Command line interface', ->
           assert.include stderr, 'template -> generate-hooks'
 
 
-  describe 'When RAML file not found', (done) ->
+  describe 'when RAML file not found', (done) ->
     before (done) ->
       ramlFile = "#{RAML_DIR}/nonexistent_path.raml"
       cmd = "#{ABAO_BIN} #{ramlFile} --server #{SERVER}"
@@ -177,9 +177,9 @@ describe 'Command line interface', ->
       assert.include stderr, 'Error: ENOENT'
 
 
-  describe 'Arguments with existing RAML and responding server', () ->
+  describe 'arguments with existing RAML and responding server', () ->
     describe 'when invoked without "--server" option', () ->
-      describe 'when RAML file hasn\'t correct baseUri', () ->
+      describe 'when RAML file does not specify "baseUri"', () ->
         before (done) ->
           ramlFile = "#{RAML_DIR}/no-base-uri.raml"
           cmd = "#{ABAO_BIN} #{ramlFile} --reporter json"
@@ -192,7 +192,7 @@ describe 'Command line interface', ->
         it 'should print error message to stderr', ->
           assert.include stderr, 'no API endpoint specified'
 
-      describe 'when RAML file has correct baseUri', () ->
+      describe 'when RAML file does specify "baseUri"', () ->
 
         before (done) ->
           ramlFile = "#{RAML_DIR}/single-get.raml"

test/fixtures/1-get-1-post.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -34,3 +34,4 @@ version: v1
               name: 'string'
             example: |
               { "type": "Kulu", "name": "Mike" }
+

test/fixtures/contacts.raml

@@ -0,0 +1,63 @@
+#%RAML 0.8
+
+title: Address Book API
+baseUri: http://example.api.com/{version}
+version: v1
+
+/contacts:
+  post:
+    body:
+      application/json:
+        schema: |
+          type: 'string'
+          name: 'string'
+        example: |
+              { "type": "Kulu", "name": "Mike" }
+    responses:
+      201:
+        body:
+          application/json:
+            schema: |
+              type: 'string'
+              name: 'string'
+            example: |
+              { "type": "Kulu", "name": "Mike" }
+  /contacts/{id}
+    delete:
+      responses:
+        204:
+    put:
+      body:
+        application/json:
+          schema: |
+            type: 'string'
+            name: 'string'
+          example: |
+                { "type": "Kulu", "name": "Mike" }
+      responses:
+        201:
+          body:
+            application/json:
+              schema: |
+                type: 'string'
+                name: 'string'
+              example: |
+                { "type": "Kulu", "name": "Mike" }
+    get:
+      responses:
+        200:
+          body:
+            application/json:
+              schema: |
+                [
+                  type: 'string'
+                  name: 'string'
+                  phone: 'string'
+                ]
+              example: |
+                {
+                  "type": "contact",
+                  "name": "Jenny",
+                  "phone": "867-5309"
+                }
+

test/fixtures/include_other_raml.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -20,3 +20,4 @@ securitySchemes:
               ]
             example: |
               { "type": "Kulu", "name": "Mike" }
+

test/fixtures/inline_and_included_schemas.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -23,3 +23,4 @@ schemas:
                   "name": "string"
                 }
               }
+

test/fixtures/no-base-uri.raml

@@ -37,3 +37,4 @@ traits:
     delete:
       description: |
         This method will *delete* an **individual song**
+

test/fixtures/no-method.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -18,3 +18,4 @@ version: v1
                 ]
               example: |
                 { "type": "Kulu", "name": "Mike" }
+

test/fixtures/non_required_query_parameter.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -22,3 +22,4 @@ version: v1
               ]
             example: |
               { "type": "Kulu", "name": "Mike" }
+

test/fixtures/ref_other_schemas.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -15,3 +15,4 @@ schemas:
         body:
           application/json:
             schema: type2
+

test/fixtures/required_query_parameter.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -22,3 +22,4 @@ version: v1
               ]
             example: |
               { "type": "Kulu", "name": "Mike" }
+

test/fixtures/simple.raml

@@ -38,3 +38,4 @@ traits:
     delete:
       description: |
         This method will *delete* an **individual song**
+

test/fixtures/single-get.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://localhost:3333
 
 /machines:
@@ -20,3 +20,4 @@ baseUri: http://localhost:3333
               ]
             example: |
               { "type": "Kulu", "name": "Mike" }
+

test/fixtures/three-levels.raml

@@ -1,6 +1,6 @@
 #%RAML 0.8
 
-title: World Music API
+title: Machines API
 baseUri: http://example.api.com/{version}
 version: v1
 
@@ -34,3 +34,4 @@ version: v1
                 schema: |
                   type: 'string'
                   name: 'string'
+

test/fixtures/vendor-content-type.raml

@@ -41,3 +41,4 @@ version: v1
             example: |
               { "title": "A Beautiful Day", "artist": "Mike" }
           text/plain:
+