ServerJS/Unit Testing/A - Revision history

KrisKowal: run returns status code

2009-07-22T06:34:28Z

run returns status code

← Older revision		Revision as of 06:34, 22 July 2009
Line 62:		Line 62:
	== Test ==		== Test ==

	The "test" module provides a "run" method that runs unit tests and catalogs their results. The idiom for a self-running test module program would be:		The "test" module provides a "run" method that runs unit tests and catalogs their results. The "run" method must return the total number of failures, suitable for use as a process exit status code. The idiom for a self-running test module program would be:

	if (module.id == require.main)		if (module.id == require.main)

KrisKowal: typos and refinements

2009-07-22T06:31:38Z

typos and refinements

← Older revision		Revision as of 06:31, 22 July 2009
Line 30:		Line 30:
	The truth assertion tests whether a value is identical to <tt>true</tt>, as determined by the <tt>===</tt> operator.		The truth assertion tests whether a value is identical to <tt>true</tt>, as determined by the <tt>===</tt> operator.

	assert.isTrue(~~value~~, [message]);		assert.isTrue(actual, [message]);

	Falsity:		Falsity:

	assert.isFalse(~~value~~, [message]);		assert.isFalse(actual, [message]);

	The nullity assertion tests whether a value is identical to <tt>null</tt>, as determined by the <tt>===</tt> operator. <tt>undefined</tt> is ~~equal~~ but not ~~equivalent~~ to <tt>null</tt>, so checking whether a value is null or undefined can be determined by <tt>assert.eq(value)</tt>.		The nullity assertion tests whether a value is identical to <tt>null</tt>, as determined by the <tt>===</tt> operator. <tt>undefined</tt> is equivalent but not identical to <tt>null</tt>, so checking whether a value is null or undefined can be determined by <tt>assert.eq(value)</tt>.

	assert.isNull(~~value~~, [message]);		assert.isNull(actual, [message]);

	The truthiness assertion tests whether a value is equivalent to <tt>true</tt>, as determined by the <tt>==</tt> operator.		The truthiness assertion tests whether a value is equivalent to <tt>true</tt>, as determined by the <tt>==</tt> operator.

	assert.eqTrue(~~value~~, [message]);		assert.eqTrue(actual, [message]);

	Falsiness:		Falsiness:

	assert.eqFalse(~~value~~, [message]);		assert.eqFalse(actual, [message]);

	Not a number:		Not a number:

KrisKowal: Wrote up a unit testing proposal in normative terms.

2009-07-22T03:49:28Z

Wrote up a unit testing proposal in normative terms.

New page

== Assert ==

The <tt>assert</tt> module provides functions that throw <tt>AssertionError</tt>'s when particular conditions are not met. The <tt>assert</tt> module must conform to the following interface.

var assert = require("assert");

The AssertionError is defined in <tt>assert</tt>.

new assert.AssertionError(message, actual, expected)
assert.AssertionError instanceof Error

All of the following functions may throw an <tt>AssertionError</tt> when a corresponding condition is not met, with a message that may be undefined if not provided. All assertion methods provide both the actual and expected values to the assertion error for display purposes.

The equivalence assertion tests a deep equality relation. All identical values are equivalent, as determined by <tt>===</tt>. For pairs of values that both pass <tt>Array.isArray</tt>, equivalence is determined by identical length and the equivalence of all respective content. Other pairs that do not both pass <tt>typeof value == "object"</tt>, equivalence is determined by <tt>==</tt>. For all other <tt>Object</tt> pairs, equivalence is determined by having the same number of owned properties (as verified with <tt>Object.prototype.hasOwnProperty.call</tt>), the same set of keys (although not necessarily the same order), equivalent values for every corresponding key, and an identical "prototype" property.

assert.eq(expected, actual, [message]);

Non-equivalence:

assert.ne(expected, actual, [message]);

The identity assertion tests shallow identity with <tt>===</tt>.

assert.is(expected, actual, [message]);

Non-identity:

assert.isnt(expected, actual, [message]);

The truth assertion tests whether a value is identical to <tt>true</tt>, as determined by the <tt>===</tt> operator.

assert.isTrue(value, [message]);

Falsity:

assert.isFalse(value, [message]);

The nullity assertion tests whether a value is identical to <tt>null</tt>, as determined by the <tt>===</tt> operator. <tt>undefined</tt> is equal but not equivalent to <tt>null</tt>, so checking whether a value is null or undefined can be determined by <tt>assert.eq(value)</tt>.

assert.isNull(value, [message]);

The truthiness assertion tests whether a value is equivalent to <tt>true</tt>, as determined by the <tt>==</tt> operator.

assert.eqTrue(value, [message]);

Falsiness:

assert.eqFalse(value, [message]);

Not a number:

assert.isNaN(value, [message]);

Expected to throw an error:

assert.error(block, [message]);

Expected to throw a particular type of error, distinguished by arguments length.

assert.error(block, ErrorType, [message]);

== Test ==

The "test" module provides a "run" method that runs unit tests and catalogs their results. The idiom for a self-running test module program would be:

if (module.id == require.main)
require("test").run(exports);

<tt>run</tt> must accept any <tt>Object</tt>, usually a unit test module's exports. "run" will scan the object for all methods and object properties that have names that begin with "test", and certain flags. Sub-objects will be run as sub-tests.

exports.testPatience(function () {
require('os').sleep(1000);
});

exports.subTest = require("./subTest");

Test names may be any String that begins with "test", not necessarily respecting a case convention.

[
[{"a: 10}, {"a": 10}],
[[1, 2, 3], [1, 2, 3]]
].forEach(function (pair) {
exports['test ' + util.repr(pair[0])] = function () {
assert.eq.apply(assert, pair);
};
});

The <tt>addsGlobals</tt> flag must suppress the test runner from failing any test that adds a property to the global object. Otherwise, the test runner may make this check to spot likely missing <tt>var</tt> declarations.

exports.addsGlobals = true;