Class Assert

Object
   |
   +--Assert

Direct Known Subclasses:

Test

class Assert

Defined in assert.js

Field Detail

Expected

var Expected

actual

var actual

Assert

function Assert()

assertArraysEqual

void assertArraysEqual(<Array> expected, <Array> actual, <string> msg)

Asserts that two arrays contain equal objects in the same order. First calls this.assertEqual(expected.length, actual.length, msg) and then calls this.assertEqual(expected[i], actual[i], msg) for each i between 0 and expected.length.

Parameters:
expected - the array of expected values
actual - the array of actual values
msg - (Optional) - a message to display if expected and actual are of different lengths or if any corresponding pair of elements in expected and actual do not match. The default value is the same as the default message for assertEqual().

assertArraysIdentical

void assertArraysIdentical(<Array> expected, <Array> actual, <string> msg)

Asserts that two arrays contain identical objects in the same order. Works the same way as assertArraysEqual() but calls assertIdentical() instead of assertEqual(). To assert that two objects refer to the same array reference, use assertIdentical() instead.

Parameters:
expected - the array of expected values
actual - the array of actual values
msg - (Optional) - a message to display if expected and actual are of different lengths or if any corresponding pair of elements in expected and actual do not match. The default value is the same as the default message for assertIdentical().

assertDefined

void assertDefined(<Object> object, <string> msg)

Checks to see if object is something other than undefined and throws an AssertionFailedError if not.

Parameters:
object - the thing that should be defined
msg - (Optional) - the message to display if object is undefined. Defaults to the empty string.

Throws:
- AssertionFailedError

assertEqual

void assertEqual(<Object> expected, <Object> actual, <string> msg)

Checks to see if expected and actual are equal. Note that the string "5" is equal to the integer 5 according to the JavaScript spec. To avoid type coercion, use assertIdentical().

Parameters:
expected - the expected value of actual
actual - the value to test
msg - (Optional) - the message to display if actual is not equal to expected. Defaults to "<" + actual + "> not equal to <" + expected + ">".

Throws:
- AssertionFailedError

assertFalse

void assertFalse(<boolean> condition, <string> msg)

Checks to see if condition is false and calls fail() if not. This is a convenience function to avoid this.assertTrue(!condition, msg) and (hopefully) aid readability.

Parameters:
condition - the boolean condition to check. If condition is true, an AssertionFailedError will be thrown.
msg - (Optional) - a message to display if condition is true. Defaults to the empty string.

void assertIdentical(<Object> expected, <Object> actual, <string> msg)

void assertNotIdentical(<Object> expected, <Object> actual, <string> msg)

void assertNotNull(<Object> object, <string> msg)

void assertNull(<Object> object, <string> msg)

void assertTrue(<boolean> condition, <string> msg)

void assertUndefined(<Object> object, <string> msg)

void fail(<string> msg)