Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
BDD style assertions for node.js -- test framework agnostic
JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
support
test
.gitmodules
History.md
Makefile
Readme.md
index.js
package.json

Readme.md

Should.js

should is a test framework agnostic assertion library for node, following BDD-style conventions. For example user.age.should.be.within(1, 90) vs assert.ok(user.age >= 1 && user.age <= 90).

should literally extends node's assert module, infact, it is node's assert module, for example should.equal(str, 'foo') will work, just as assert.equal(str, 'foo') would, and should.AssertionError is asset.AssertionError, meaning any test framework supporting this constructor will function properly with should.

Installation

$ npm install should

modifiers

should's assertion chaining provides an expressive way to build up an assertion, along with dummy getters such as an, have, and be, provided are what I am simply calling modifiers, which have a meaning effect on the assertion. An example of this is the not getter, which negates the meaning, aka user.should.not.have.property('name'), note the user of have as we could omit it and still construct a valid assertion.

Some modifiers such as include only have an effect with specific assertion methods, for example when asserting a substring like so: str.should.include.string('test'), we could omit include, but it helps express the meaning, however keys has a strict effect, unless the include modifier is used.

empty

Asserts that length is 0:

[].should.be.empty
''.should.be.empty
({ length: 0 }).should.be.empty

eql

equality:

({ foo: 'bar' }).should.eql({ foo: 'bar' })
[1,2,3].should.eql([1,2,3])

equal

strict equality:

should.strictEqual(undefined, value)
should.strictEqual(false, value)
(4).should.equal(4)
'test'.should.equal('test')
[1,2,3].should.not.equal([1,2,3])

within

Assert inclusive numeric range:

user.age.should.be.within(5, 50)

a

Assert typeof:

user.should.be.a('object')
'test'.should.be.a('string')

instanceof

Assert instanceof:

user.should.be.an.instanceof(User)
[].should.be.an.instanceof(Array)

above

Assert numeric value above the given value:

user.age.should.be.above(5)
user.age.should.not.be.above(100)

below

Assert numeric value below the given value:

user.age.should.be.below(100)
user.age.should.not.be.below(5)

match

Assert regexp match:

username.should.match(/^\w+$/)

length

Assert length property exists and has a value of the given number:

user.pets.should.have.length(5)
user.pets.should.have.a.lengthOf(5)

Aliases: lengthOf

string

Substring assertion:

'foobar'.should.include.string('foo')
'foobar'.should.include.string('bar')
'foobar'.should.not.include.string('baz')

property

Assert property exists and has optional value:

user.should.have.property('name')
user.should.have.property('age', 15)
user.should.not.have.property('rawr')
user.should.not.have.property('age', 0)

ownProperty

Assert own property (on the immediate object):

({ foo: 'bar' }).should.have.ownProperty('foo')

contain

Assert array value:

[1,2,3].should.contain(3)
[1,2,3].should.contain(2)
[1,2,3].should.not.contain(4)

keys

Assert own object keys, which must match exactly, and will fail if you omit a key or two:

var obj = { foo: 'bar', baz: 'raz' };
obj.should.have.keys('foo', 'bar');
obj.should.have.keys(['foo', 'bar']);

using the include modifier, we can check inclusion of a key, but not fail when we omit a few:

obj.should.have.keys('foo')
obj.should.have.keys('bar')
obj.should.not.have.keys('baz')

respondTo

Assert that the given property is a function:

user.should.respondTo('email')

Running tests

To run the tests for should simple update your git submodules and run:

$ make test

License

(The MIT License)

Copyright (c) 2010 TJ Holowaychuk <tj@vision-media.ca>

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.

Something went wrong with that request. Please try again.