assert-stdio v0.0.1

assert-stdio

assert-stdio is a BDD-style, test-framework-agnostic assertion library for Node that tests the contents of stdio streams. These stdio streams need not be Node applications and can be any shell command that interacts with the stdio stream.

##Getting Started

1. Install:

$ npm install assert-stdio

2. Require it and use it:

var assert = require('assert-stdio')
assert("cat", [ "path/to/helloworld.txt" ], "hello, world")

##How it works

The require returns an assertion function taking 1 to 3 parameters: a command String, an (optional) Array of flags/arguments and an expected output String.

It either returns an error (in the case of a failed assertion or invalid command) or the function call returns an EventEmitter and allows listeners to be attached to the various events triggered by the child process executing the desired command.

##Events API

###.send(msg, cb)

Sends a String msg to the stdin.

assert("telnet", [], "telnet> No connection.\nEscape character is '^]'.\ntelnet> ")
    .send("status")
    .end(done);

###.end(cb)

Terminates the child process in which the given command is running (also emits an 'end' event and triggers any chained comparisons)

###.equal(expected)

Compares stdout after executing the command to a given String

var assert = require('assert-stdio')
assert("cat", [ "path/to/helloworld.txt" ]).equals("hello, world").end()

###.contains(expected)

Searches for a given String or RegExp in the stdout after executing the command.

var assert = require('assert-stdio')
assert("cat", [ "path/to/helloworld.txt" ]).contains("hello, world").end()

##Examples

###'should' syntax

var cmd = require('assert-stdio')
cmd("cat", [ "path/to/helloworld.txt" ]).should.equal("hello, world").end();

###'expect' syntax

var expect = require('assert-stdio')
expect("cat", [ "path/to/helloworld.txt" ]).to.equal("hello, world").end();

###assertion chaining

var expect = require('assert-stdio')
expect("cat", [ "path/to/helloworld.txt" ]).to.equal("hello, world").end();

##Promises API

To use Promises, you must include the plugin after the assert-stdio library has been required. When used, the require function returns a Promise after being called.

var cmd = require('assert-stdio')
var Promises = require('assert-stdio/promises')
cmd.use(Promises)
cmd("cat", ["path/to/file"])
.then(function(result){
  // do something else when promise resolves
})
.nodeify(done)
// returns a promise

##Mocha Examples

describe(" 'assert' syntax can be used with plural methods", function(done){

    var assert = require('assert-stdio')
    var args = ["path/to/file.txt"];

    it(".equals() compares to a valid string ", function(done){
      assert("cat", args).equals("hello, world").end(done)
    })

    it(".contains() searches for RegExp match", function(done){
      assert("cat", args).contains(/ell/).end(done)
    })

    it(".contains() searches for String match", function(done){
      assert("cat", args).contains("hello").end(done)
    })

    it(".contains().and.contains() can be chained", function(done){
      assert("cat", args).contains("hello")
        .and.contains("world").end(done)
    })

  })
})

##TODO:

-add support for non-terminating processes such as telnet.