Test Drive Node.js

T E S T D R I V E N

View Slide

Node.js is a platform built on
Chrome's JavaScript runtime for
easily building fast, scalable network
applications.
“
”
What is node.js?

View Slide

View Slide

basicFundamentals

View Slide

packageManagement

View Slide

is not an acronym

View Slide

is an acronym
National Association of Pastoral Musicians

View Slide

github:
install:
isaacs/npm
comes with node

View Slide

npm install
localInstallation

View Slide

npm install --global
globalInstallation
-g or --global

View Slide

npm install --link
dualInstallation

View Slide

npm install --save[-dev|-optional]
dependencyReferences
--save or --save-dev or --save-optional

View Slide

npm install
updateDependencies

View Slide

testingNode.js

View Slide

TDD is to coding style as yoga is
to posture. Even when you're not
actively practicing, having done so
colors your whole life healthier.”
j. kerr
“

View Slide

assertingCorrectness

View Slide

var assert = require('assert');

View Slide

assert(value)
.ok(value)
.equal(actual, expected)
.notEqual(actual, expected)
.deepEqual(actual, expected)
.notDeepEqual(actual, expected)
.strictEqual(actual, expected)
.notStrictEqual(actual, expected)
.throws(block, [error])
.doesNotThrow(block, [error])
.ifError(value)

View Slide

// Will pass
assert.ok(true);
// Will throw an exception
assert.ok(false);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

// Will throw 'false == true' error
assert.ok(typeof 'hello' === 'number');
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

$ node test.js
assert.js:104
throw new assert.AssertionError({
^
AssertionError: false == true
at Object. (my-‐test.js:7:8)
at Module._compile (module.js:449:26)
at Object.Module._extensions..js (module.js:467:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Module.runMain (module.js:487:10)
at process.startup.processNextTick.process._tick...
$ _

View Slide

Chai Assertion Library

View Slide

github:
install:
chaijs/chai
npm install chai

View Slide

isTrue, isFalse,
isNull, isNotNull,
isUndefined, isDefined,
isFunction, isNotFunction,
isArray, isNotArray,
isBoolean, isNotBoolean,
isNumber, isNotNumber,
isString, isNotString,
include,
lengthOf,
operator,
closeTo
isObject, isNotObject,
typeOf, notTypeOf,
instanceOf, notInstanceOf,
match, notMatch,
property, notProperty,
deepProperty, notDeepProperty,
propertyVal, propertyNotVal,
deepPropertyVal, deepPropertyNotVal,
additional
assertions

View Slide

var assert = require('chai').assert;

View Slide

// Will throw 'expected 'hello' to be a number'
assert.isNumber('hello');
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

$ node test.js
expected 'hello' to be a number
$ _

View Slide

var chai = require('chai')
, assert = chai.assert;
chai.Assertion.includeStack = true;
// Will throw and display stack
assert.isNumber('hello');
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

testDriven

View Slide

Exceptions alone are insufﬁcient

View Slide

$ node my-‐test.js
assert.js:104
throw new assert.AssertionError({
^
at Object. (my-‐test.js:7:8)
at Module._compile (module.js:449:26)
at Object.Module._extensions..js (module.js:467:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Module.runMain (module.js:487:10)
at process.startup.processNextTick.process._tick...
$ _

View Slide

We need a testing framework!

View Slide

mocha simple, flexible, fun

View Slide

mocha
github:
install:
visionmedia/mocha
npm install -g mocha

View Slide

$ npm install -‐g mocha
$ mkdir test
$ mocha

✔ 0 tests complete (1ms)
$

View Slide

var mocha = require('mocha');

View Slide

suite('Testing out this thing', function() {
test('should do stuff', function() {
// Assertion tests
});
});
tddSyntax

View Slide

./test/my-test.js
suite('Assertions', function() {
test('should pass on truthiness', function() {
assert.ok(true);
});
test('should fail on falsiness', function() {
assert.ok(false);
});
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

View Slide

$ mocha -‐-‐ui tdd -‐-‐reporter spec
Assertions
✓ should pass on truthiness
1) should fail on falsiness
✖ 1 of 2 tests failed:
1) Assertions should fail on falsiness:

at (stack trace omitted for brevity)
$ _

View Slide

groupedTests

View Slide

suite('with a subset of this other thing', function() {
// Assertion tests
});
});
});
groupSyntax

View Slide

suite('of truthiness', function() {
test('should pass on true', function() {
assert.isTrue(true);
});
test('should pass on false', function() {
assert.isFalse(false);
});
});
suite('of type', function() {
test('should pass on number', function() {
assert.isNumber(5);
});
});
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

Assertions
of truthiness
✓ should pass on true
✓ should pass on false
of type
✓ should pass on number
$ _

View Slide

pendingTests

View Slide

test('should do stuff someday');
});
});
pendingSyntax

View Slide

suite('of truthiness', function() {
test('should pass on true', function() {
});
test('should pass on false', function() {
});
});
suite('of type', function() {
test('should pass on number', function() {
assert.isNumber(5);
});
test('should pass on object');
});
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

Assertions
of truthiness
✓ should pass on true
✓ should pass on false
of type
✓ should pass on number
-‐ should pass on object
• 1 test pending
$ _

View Slide

setupTeardown

View Slide

setup();
teardown();

View Slide

setup(function(){
// ...
};
// Assertion tests
});
teardown(function(){
// ...
};
});
});
setupTeardown

View Slide

asynchronousTests

View Slide

test('it should not error', function(done) {
search.find("Apples", done);
});
asynchronousSyntax

View Slide

});
test('it should return 2 items', function(done) {
search.find("Apples", function(err, res) {
if (err) return done(err);
res.should.have.length(2);
done();
});
});
asynchronousSyntax

View Slide

All Mocha functions accept this callback

View Slide

suite('When searching for Apples', function(done) {
setup(function(done){
items.save(['fiji apples',
'empire apples'], done);
});
});
test('it should return 2 items', function(done) {
search.find("Apples", function(err, res) {
if (err) return done(err);
res.should.have.length(2);
done();
});
});
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

simplifyExecution

View Slide

be nice to yourself:
should be simpliﬁed to
$ make test and $ npm test

View Slide

./makefile
# Makefile for sample module
test:
mocha --reporter spec --ui tdd
.PHONY: test
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

View Slide

./makefile
# Makefile for sample module
test:
mocha \
--reporter spec \
--ui tdd
.PHONY: test
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

View Slide

./package.json
{
"name": "sample",
"version": "0.1.0",
"devDependencies": {
"chai": "~1.2.0"
},
"scripts": {
"test": "make test"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

View Slide

$ make test
Assertions

$ _

View Slide

$ npm test
Assertions

$ _

View Slide

eliminate global dependency
$ npm install mocha -‐-‐link

View Slide

test:
@./node_modules/.bin/mocha \
--reporter spec \
--ui tdd
.PHONY: test
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

update dev dependencies
$ npm install mocha -‐-‐save-‐dev
$ npm install chai -‐-‐save-‐dev

View Slide

$ npm install mocha -‐-‐save-‐dev
$ npm install chai -‐-‐save-‐dev
$ git diff package.json
diff -‐-‐git a/package.json b/package.json
index 439cf44..3609bb9 100644
-‐-‐-‐ a/package.json
+++ b/package.json
@@ -‐1,5 +1,7 @@
{
"name": "sample",
-‐ "version": "0.1.0"
+ "version": "0.1.0",
+ "devDependencies": {
+ "mocha": "~1.4.0",
+ "chai": "~1.2.0"
+ }
}

View Slide

notiﬁcationSystems

View Slide

mocha --slow
slowThreshold
-s or --slow

View Slide

$ mocha -‐-‐reporter spec -‐-‐slow 5
When accessing the Ticket API
with valid Morale credentials,
and with a project that exists,
getting a list of tickets
✓ should return without an error
✓ should return a populated array (5ms)
✓ should contain a task or bug ticket
adding a new ticket
✓ should return without an error
✓ should return the new ticket (11ms)
$ _

View Slide

mocha --watch
continuousTesting
-w or --watch

View Slide

$ mocha -‐-‐watch
^ watching

View Slide

Growl

View Slide

mac:
win:
also:
apple app store
growlForWindows.com
growlNotify

View Slide

mocha --growl
growlNotiﬁcations
-G or --growl

View Slide

⌘S

View Slide

test:
--reporter spec \
--ui tdd
watch:
--reporter min \
--ui tdd \
--growl \
--watch
.PHONY: test watch
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

behaviorDriven

View Slide

suite('Test this thing', function() {
test('Do stuff', function() {
// Assertion tests
});
});
describe('Testing out this thing', function() {
it('should do stuff', function() {
// Assertion tests
});
});
bddSyntax
tddSyntax

View Slide

test:
--reporter spec \
--ui bdd
watch:
--reporter min \
--ui bdd \
--growl \
--watch
.PHONY: test
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

test:
--reporter spec
watch:
--reporter min \
--growl \
--watch
.PHONY: test
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

setupTeardown

View Slide

before();
beforeEach();
after();
afterEach();

View Slide

before(function(){
// ...
};
describe('with a subset of that thing', function() {
// Assertion tests
});
afterEach(function(){
// ...
};
});
});
setupTeardown

View Slide

There is no tdd equivalent to ‘each’

View Slide

suite();
test();
setup();
teardown();
describe();
it();
before();
after();
beforeEach();
afterEach();
bddMethods
tddMethods

View Slide

expectAssertions

View Slide

expectSyntax
expect(person).to.be.an('object');
.with.property('age')
.that.is.a('number')
.that.equals(34);
assert.isObject(person);
assert.property(person, "age");
assert.isNumber(person.age);
assert.equals(person.age, 34);
assertSyntax

View Slide

var expect = require('chai').expect;

View Slide

assertionChains
for readability

View Slide

expect(person).to.exist
.and.be.an('object')
.that.is.to.exist
.and.is.a('number')
.and.equals(34);

View Slide

.to
.be
.been
.is
.that
.and
.have
.with
syntaxSugar
for readability

View Slide

expect(person).to.exist
.and.be.an('object')
.that.is.to.exist
.and.is.a('number')
.and.equals(34);

View Slide

.property
subjectChange
from original object

View Slide

expect(person)
.that.is.an('object')
.with.property('address')
.that.is.an('object')
.with.property('city')
.that.is.a('string')
.and.equals('Detroit')

View Slide

shouldAssertions

View Slide

person.should.be.an('object')
.that.is.a('number')
.that.equals(34);
shouldSyntax
assert.isObject(person);
assert.property(person, "age");
assert.isNumber(person.age);
assert.equals(person.age, 34);
assertSyntax

View Slide

var should = require('chai').should();

View Slide

var chai = require('chai')
, expect = chai.expect
, should = chai.should();

View Slide

assertionChains
same as expect style*
except for existence

View Slide

expect(foo).to.not.exist;
expect(bar).to.exist;
should.not.exist(foo);
should.exist(foo);

View Slide

skippedTests

View Slide

it.skip('should be skipped', function() {
// Assertion tests
});
});
describe.skip('This entire suite will be skipped', function() {
// Assertion tests
});
});
skipSyntax

View Slide

describe('Assertions', function() {
describe('of truthiness', function() {
it('should pass on truthiness', function() {
});
it('should pass on falsiness', function() {
});
});
describe('of type', function() {
it.skip('should pass on number', function() {
assert.isNumber(5);
});
it('should pass on object');
});
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

$ make test
Assertions
of truthiness
✓ should pass on falsiness
of type
-‐ should pass on number
-‐ should pass on object
• 2 test pending
$ _

View Slide

Skip is available in bdd only

View Slide

mockingObjects

View Slide

JavaScript ships with a mocking framework
...it’s called JavaScript

View Slide

nock HTTP Mocking Library

View Slide

nock github:
install:
ﬂatiron/nock
npm install nock

View Slide

var nock = require('nock');
var twitter = nock('http://api.twitter.com')
.get('/1/statuses/user_timeline.json?'+
'screen_name=jayharris')
.reply(200, "This worked");
// Returns "This worked"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

// Returns live Twitter data
var nock = require('nock');
var twitter = nock('http://api.twitter.com')
.get('/1/statuses/user_timeline.json?'+
'screen_name=jayharris')
.reply(200, "This worked");
// Returns "This worked"
// Returns live Twitter data
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

nock nock.recorder.rec( );
nock.recorder.play( );

View Slide

Spies, Stubs, & Mocks
Sinon.js

View Slide

github:
install:
cjohansen/Sinon.JS
npm install sinon
Sinon.js

View Slide

browserTesting

View Slide

Fast, headless browser
Zombie.js

View Slide

github:
install:
assaf/zombie
npm install zombie
Zombie.js

View Slide

loadTesting

View Slide

Performance Suite
nodeload

View Slide

github:
install:
benschmaus/nodeload
npm install nodeload
nodeload

View Slide

activelyPractice

View Slide

Color your whole life healthier

View Slide

jay harris
[email protected]
#testdrivennode
@jayharris
P R E S I D E N T

View Slide

Test Drive Node.js

Test Drive Node.js

Jay Harris

More Decks by Jay Harris

Other Decks in Technology

Featured

Transcript