add 'test' support, allows content of responses to be checked

README.md

@@ -108,6 +108,18 @@ afterAll (done) ->
 
 If `beforeAll`, `afterAll`, `before` and `after` are called multiple times, the callbacks are executed serially in the order they were called.
 
+**Abao** provides hook to allow the content of the response to be
+checked within the test:
+
+```coffee
+{test} = require 'hooks'
+
+test 'GET /machines -> 200', (response, body, done) ->
+    assert.deepEqual(JSON.parse(body), ["machine1", "machine2"])
+    assert.equal(headers["content-type"], 'application/json; charset=utf-8')
+	return done()
+```
+
 ### test.request
 
 - `server` - Server address, provided from CLI.

lib/abao.coffee

@@ -27,6 +27,11 @@ class Abao
     factory = new TestFactory(config.options.schemas)
 
     async.waterfall [
+      # Parse hooks
+      (callback) ->
+        addHooks hooks, config.options.hookfiles
+        callback()
+      ,
       # Load RAML
       (callback) ->
         raml.loadFile(config.ramlPath).then (raml) ->
@@ -35,12 +40,7 @@ class Abao
       ,
       # Parse tests from RAML
       (raml, callback) ->
-        addTests raml, tests, callback, factory
-      ,
-      # Parse hooks
-      (callback) ->
-        addHooks hooks, config.options.hookfiles
-        callback()
+        addTests raml, tests, hooks, callback, factory
       ,
       # Run tests
       (callback) ->

lib/add-hooks.coffee

@@ -3,7 +3,6 @@ path = require 'path'
 require 'coffee-script/register'
 proxyquire = require('proxyquire').noCallThru()
 glob = require 'glob'
-async = require 'async'
 
 
 addHooks = (hooks, pattern) ->

lib/add-tests.coffee

@@ -21,9 +21,9 @@ parseHeaders = (raml) ->
   headers
 
 # addTests(raml, tests, [parent], callback, config)
-addTests = (raml, tests, parent, callback, testFactory) ->
+addTests = (raml, tests, hooks, parent, callback, testFactory) ->
 
-  # Handle 3th optional param
+  # Handle 4th optional param
   if _.isFunction(parent)
     testFactory = callback
     callback = parent
@@ -56,13 +56,12 @@ addTests = (raml, tests, parent, callback, testFactory) ->
       # Iterate response status
       for status, res of api.responses
 
+        testName = "#{method} #{path} -> #{status}"
+
         # Append new test to tests
-        test = testFactory.create()
+        test = testFactory.create(testName, hooks.contentTests[testName])
         tests.push test
 
-        # Update test
-        test.name = "#{method} #{path} -> #{status}"
-
         # Update test.request
         test.request.path = path
         test.request.method = method
@@ -86,7 +85,7 @@ addTests = (raml, tests, parent, callback, testFactory) ->
       return callback(err) if err
 
       # Recursive
-      addTests resource, tests, {path, params}, callback, testFactory
+      addTests resource, tests, hooks, {path, params}, callback, testFactory
   , callback
 
 

lib/hooks.coffee

@@ -9,6 +9,7 @@ class Hooks
     @afterAllHooks = []
     @beforeEachHooks = []
     @afterEachHooks = []
+    @contentTests = {}
 
   before: (name, hook) =>
     @addHook(@beforeHooks, name, hook)
@@ -34,6 +35,11 @@ class Hooks
     else
       hooks[name] = [hook]
 
+  test: (name, hook) =>
+    if @contentTests[name]?
+      throw new Error("Cannot have more than one test with the name: #{name}")
+    @contentTests[name] = hook
+
   runBeforeAll: (callback) =>
     async.series @beforeAllHooks, (err, results) ->
       callback(err)

lib/test.coffee

@@ -24,12 +24,12 @@ class TestFactory
       for file in files
         tv4.addSchema(JSON.parse(fs.readFileSync(file, 'utf8')))
 
-  create: () ->
-    return new Test()
+  create: (name, contentTest) ->
+    return new Test(name, contentTest)
 
 class Test
-  constructor: () ->
-    @name = ''
+  constructor: (@name, @contentTest) ->
+    @name ?= ''
     @skip = false
 
     @request =
@@ -47,6 +47,9 @@ class Test
       headers: null
       body: null
 
+    @contentTest ?= (response, body, done) ->
+        done()
+
   url: () ->
     path = @request.server + @request.path
 
@@ -56,6 +59,7 @@ class Test
 
   run: (callback) ->
     assertResponse = @assertResponse
+    contentTest = @contentTest
 
     options = _.pick @request, 'headers', 'method'
     options['url'] = @url()
@@ -69,7 +73,7 @@ class Test
       ,
       (error, response, body, callback) ->
         assertResponse(error, response, body)
-        callback()
+        contentTest(response, body, callback)
     ], callback
 
   assertResponse: (error, response, body) =>
@@ -82,6 +86,7 @@ class Test
       #{body}
       Error
     """
+    response.status = response.statusCode
 
     # Body
     if @response.schema

test/unit/add-tests-test.coffee

@@ -7,6 +7,7 @@ proxyquire = require('proxyquire').noCallThru()
 mochaStub = require 'mocha'
 
 TestFactory = require '../../lib/test'
+hooks = require '../../lib/hooks'
 addTests = proxyquire '../../lib/add-tests', {
   'mocha': mochaStub
 }
@@ -22,13 +23,12 @@ describe '#addTests', ->
       callback = ''
 
       before (done) ->
-
         ramlParser.loadFile("#{__dirname}/../fixtures/single-get.raml")
         .then (data) ->
           callback = sinon.stub()
           callback.returns(done())
 
-          addTests data, tests, callback, testFactory
+          addTests data, tests, hooks, callback, testFactory
         , done
       after ->
         tests = []
@@ -76,7 +76,7 @@ describe '#addTests', ->
           callback = sinon.stub()
           callback.returns(done())
 
-          addTests data, tests, callback, testFactory
+          addTests data, tests, hooks, callback, testFactory
         , done
       after ->
         tests = []
@@ -123,7 +123,7 @@ describe '#addTests', ->
           callback = sinon.stub()
           callback.returns(done())
 
-          addTests data, tests, callback, testFactory
+          addTests data, tests, hooks, callback, testFactory
         , done
       after ->
         tests = []
@@ -167,7 +167,7 @@ describe '#addTests', ->
           callback = sinon.stub()
           callback.returns(done())
 
-          addTests data, tests, callback, testFactory
+          addTests data, tests, hooks, callback, testFactory
         , done
       after ->
         tests = []
@@ -211,7 +211,7 @@ describe '#addTests', ->
           callback = sinon.stub()
           callback.returns(done())
 
-          addTests data, tests, callback, testFactory
+          addTests data, tests, hooks, callback, testFactory
         , done
 
       after ->
@@ -251,7 +251,7 @@ describe '#addTests', ->
           callback = sinon.stub()
           callback.returns(done())
 
-          addTests data, tests, callback, testFactory
+          addTests data, tests, hooks, callback, testFactory
         , done
 
       after ->
@@ -295,7 +295,7 @@ describe '#addTests', ->
           callback.returns(done())
 
           sinon.stub console, 'warn'
-          addTests data, tests, callback, testFactory
+          addTests data, tests, hooks, callback, testFactory
         , done
 
       after ->

test/unit/hooks-test.coffee

@@ -340,3 +340,27 @@ describe 'Hooks', () ->
       it 'should run hook', ->
         assert.ok funcs[2].called
         assert.ok funcs[3].called
+
+  describe 'when successfully adding test hook', () ->
+
+    afterEach () ->
+      hooks.contentTests = {}
+
+    test_name = "content_test_test"
+
+    it 'should get added to the set of hooks', () ->
+      hooks.test(test_name, () ->)
+      assert.isDefined(hooks.contentTests[test_name])
+
+  describe 'adding two content tests fails', () ->
+    afterEach () ->
+      hooks.contentTests = {}
+
+    test_name = "content_test_test"
+
+    it 'should assert when adding a second content test', () ->
+      f = () ->
+        hooks.test(test_name, () ->)
+      f()
+      assert.throw f,
+        "Cannot have more than one test with the name: #{test_name}"

test/unit/test-test.coffee

@@ -26,11 +26,13 @@ describe 'Test', ->
       testFact = ''
       test = ''
       machine = ''
+      contentTestCalled = null
 
       before (done) ->
 
         testFact = new TestFactory()
         test = testFact.create()
+        contentTestCalled = false
         test.name = 'POST /machines -> 201'
         test.request.server = 'http://abao.io'
         test.request.path = '/machines'
@@ -50,6 +52,12 @@ describe 'Test', ->
           type: 'foo'
           name: 'bar'
 
+        test.contentTest = (response, body, done) ->
+          contentTestCalled = true
+          assert.equal(response.status, 201)
+          assert.deepEqual(JSON.parse(body), machine)
+          return done()
+
         requestStub.callsArgWith(1, null, {statusCode: 201}, JSON.stringify(machine))
         test.run done
 
@@ -88,6 +96,9 @@ describe 'Test', ->
         # assert.equal response.headers, 201
         assert.deepEqual response.body, machine
 
+      it 'should call contentTest', ->
+        assert.isTrue contentTestCalled
+
 
     describe 'of test contains params', ->