Minispec : mini BDD framework in coffeescript

Just another test framework

During the catastrophe of Sandy storm, my place have no electricity and water, so I stay in my friends place for whole week. And I need to find something to do except eating, surfing internet and boardgame. So I just wrote another test framework.

Inspired by Zach Holoman’s gist I try to host the framework in the gist form. Because every gist is also a git repository.

gist source

Spec

The README.md file is also a runnable spec in coffeescript. run

npm test

in project can execute the spec

# Minispec #### minispec is a mini bdd test framework example # npm install git://gist.github.com/4033566.git # require('minispec') in your project require('./minispec') # use expect.js for assertion (http://n37.co/aemDq) expect = require('expect.js') user = "" describe "Minispec", -> before -> user = name: "Jimmy" it 'can success', -> expect(true).to.be.ok() it 'can fail', -> expect().fail -> it 'have before', -> expect(user.name).to.equal "Jimmy" describe 'after', -> after -> throw new Error('in after') it 'will be executed', -> expect(true).to.be.ok() describe 'nested describe', -> before -> user.password = '123' it 'with nested before', -> expect(user.password).to.be '123' it 'with nested after', -> expect(user.password).to.be '123' it 'can also have error', -> expect().fail -> describe 'nested in nested', -> it 'is nested', -> expect(1).to.be.ok() describe 'async function', -> it 'have callback', (done)-> expect(1).to.be.ok() done()

Global delegation

One of the problem is the format of syntax. Because I want to write syntax without extra this keyword, so instead of calling the test block with ‘call’, I have to declare test syntax globally.

#Instead this
describe = (title, block)->
  @it = (desc, fn)->
    #add test to test suite
  block.call(@)

describe "syntax", ->
  @it "have this keyword", ->

#Got to do it Globally
global.it = (desc, fn)->
  #add test to test suite
describe = (title, block)->
  block()

describe "syntax", ->
  it "have no this keyword", ->

But there’s 2 problem of declaring global, one is the confrontation of global keywords, which is a tradeoff for simpler syntax. Another problem is when implementing nested block, test need to be delegated into right suite. Using a stack to track the current suite can solve this problem.

suites = []
global.it = (desc, fn)-> 
  suites[0].tests.push title: desc, fn: fn

describe = (title, block)->
  suite = new Suite(title)
  suites.unshift(suite)
  block()
  suites.shift()

So the global it will always add test to the top of stack, which is the current test suite.

Hook and run

For the before/after function, I use the EventEmitter to trigger the hooks, and delegate event to the parent suite:

class Suite extends EventEmitter
  constructor: (@title, @parent)->
    ...
    @delegate ['before', 'after']
    @on 'result', @reportResult
    @on 'end', @reportSummary

  delegate: (events)->
    events.forEach (event)=>
      @on event, => @parent?.emit event

  run: ->
    @emit 'start'
    @tests.forEach (test)->
      try
        @emit 'before'
        test.fn()
        @emit 'result', test
        @emit 'after'
      catch err
        @emit 'result', test, err
    @emit 'end'

Async

For testing the async callback, it also provide a done callback for the async function. And I use async module to handle the test execution sequence. It will detect the function param, if there is a specific callback param in function, execute in async mode.

Source

{EventEmitter} = require 'events' async = require 'async' #utils color = (code)-> (text = "")-> code + text + '\u001b[0m' red = color('\u001b[31m') green = color('\u001b[32m') yellow = color('\u001b[33m') pluralize = (count, noun)-> if count > 1 then noun + 's' else noun indent = (level)-> (' ' for i in [0...level]).join('') class Suite extends EventEmitter constructor: (@title, @parent)-> @errors = 0 @tests = [] @childs = [] @parent?.childs.push @ @level = @parent?.level + 1 or 0 @on 'start', => @report yellow @title @delegate ['before', 'after'] if @parent? @on 'result', (test, err)=> if err? @errors += 1 @report red " ✗ #{test.title} (#{err})" else @report green " ✓ #{test.title}" @on 'end', => count = @tests.length errors = @errors (reduce = (suites)-> suites.forEach (suite)-> count += suite.tests.length errors += suite.errors reduce suite.childs if suite.childs? )(@childs) console.log yellow "run #{count} #{pluralize(count, 'test') } , #{count - errors} success, #{errors} failed" delegate: (events)-> events.forEach (event)=> @on event, ()=> @parent?.emit event report: (text)-> console.log indent(@level) + text run: -> @emit 'start' async.forEachSeries @tests, (test, next)=> callback = => @emit('after') @emit('result', test) next() try @emit('before') if test.isAsync test.fn callback else test.fn() callback() catch err @emit('result', test, err) next() , => @childs.forEach (spec)-> spec.run() @emit 'end' unless @parent? class Runner constructor: (context)-> suites = [] context.it = (desc, fn)-> suites[0].tests.push title: desc, fn: fn, isAsync: !!fn.length context.before = (fn)-> suites[0].on 'before', fn context.after = (fn)-> suites[0].on 'after', fn context.describe = (title, block)-> suite = new Suite(title, suites[0]) suites.unshift(suite) block() suites.shift() suite.run() if suites.length is 0 new Runner(global or window)

Summary

Credit to VisionMedia’s mocha framework, lots of solution is comming from there.

But still this is an intersting small project to do in the storm days.

And I am so happy to back to the normal life.

Neethack

Minispec : Mini BDD Framework in Coffeescript