VODKA

A functional testing framework best suit for testing json api servers for coke

Requires

Checkout package.json for dependencies.

Installation

Install through npm

npm install vodka-coke -g

Usage

Command line tools

Usage: vodkac [command] [argument(s)]

Commands:
  -v, --version                Display vodka version
  h,  help                     Display usage information
  n,  new [project]            Create a new test project
  g,  generate [file] [method] Generate code templates
  r,  run                      Run tests

Generate a new test project

$ cd /path/to/the/test/folder/of/your/app
$ vodkac new your-project-name

Generate test actions

$ vodkac actions users signup login

Run test

# in the root dir of the test project
$ vodkac run

Run test without start coke server

$ vodkac r --without-coke

To print out the fixture

$ vodkac r -f

To log out server message to console ( default to file log/test.log )

$ vodkac r -d

To see server log with vodkac r

$ tail -f log/test.log

Tutorial

Define your configuration in configs

module.exports = {
  root    : 'http://127.0.0.1:4000',
  timeout : 60000, // 1 min,
  // add to this array if you have others route files that needs to split out
  routes  : [ 'default' ]
};

Define your routes in routes/default with node.flow

var Flow = require( 'node.flow' );

module.exports = function ( map, out ){
  flow.series( function ( next ){
    map.get( 'url/users/', 'action_file_name#function_name', next );
  });
};

Add your action in actions/action_file_name

module.exports = {
  function_name : function ( args, next , log ){
    return {
      headers : {},
      json    : {},
      handler : function ( err, res, body ){
        log( 'bla bla bla' );
      }
    };
  },
};

Please visit Request -- Simplified HTTP request method for detail

Globals

• CONF
  • base_dir
  • action_dir
  • data_dir
  • root
  • timeout
  • routes

Plus custom configs in configs.js

• UTILS
  • $update
  • $good
  • $fine
  • $alert
  • regex
    • begin_slash
    • has_format
    • has_none_characters
    • is_js_file
    • is_email
    • tail_slash
    • url
  • ran_no
  • typeof
  • uid

Check the source for detail

License

(The MIT License)

Copyright (c) 2012 dreamerslab <ben@dreamerslab.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.