lemon lime software

Usage Patterns

Pattern 1: Just call some assertions

suiteJS.assertMatches(/234/, "12345")

Pattern 2: Tests in a Suite

var suite = suiteJS.createSuite("Optional Suite Name")
suite.testBar = function() {
    this.assert("All methods named 'testSomething' will be run as tests when you run this suite.")
}
suite.run()

Pattern 3: Asserts on a Suite

var suite = suiteJS.createSuite("Optional Suite Name")
suite.assert("This is pretty much the same as running a test with only this assertion.")

Main Functions

fail()

Fail right now. Any failure, be it by this function or by a failed assertion, will cause a test method to stop running in a test suite. This is because if you had one failure, the rest of the test is probably bogus, so it is not useful to continue. Other tests in the suite will still run. A failure that is not in a test method will not cause your program to stop running, though.

setPass(func)

Set the function that is called on a pass. The passed function takes 1 argument, the pass message, and doesn’t need to return anything. Works for both the suiteJS object and individual suites.

suiteJS.setPass(function(msg) {
    log.info("Test passed: " + msg)
}

setFail(func)

See setPass(func)

getPassCount()

Get number of passed assertions if called on suiteJS.

Get number of passed tests if called on a suite.

getFailCount()

See getPassCount()

resetCounts()

Reset pass and fail counts.

getStatus()

Get a string in the form “Passed 4 out of 10”

ok()

Returns true if last assertion passed, else false. Useful when chaining.

var dogIsRover = suiteJS.assert(dog).assertMatches(/[Rr]over/, dog.getName()).ok()
if (dogIsRover)
    suiteJS.assert(dog.respondTo("Rover"))

createSuite(name)

Create a test suite. The name is optional: If not provided, a generic name will be used.

Suite-Only Functions

setUp()

If it exists, this is called before every test in this suite.

var suite = suiteJS.createSuite()
suite.setUp = function() {
    this.testData = new ModelObject()
}

tearDown()

See setUp. Same thing, but called after every test in the suite.

Assertion Functions

Note that the “msg” (short for “message”) argument is always optional.

assert(obj, msg)

Basically if (obj) pass.

assertMatches(regex, string, msg)

Make sure the string is matched by the given regex.

assertEquals(obj1, obj2, msg)

Same as ==

assertNotEqual(obj1, obj2, msg)

Same as !=

assertSame(obj1, obj2, msg)

Same as ===. If you’re not familiar with that, it means “This is the same object as that object” or, for primatives such as strings and numbers, “This is the same type and value as that object”

assertSameType(obj1, obj2, msg)

Checks if objects have same type based on result of typeof operator. In JavaScript, these are the only possible types:

• function
• string
• number
• object
• undefined

Don’t get confused and think this will differentiate objects that were created different ways.

assertNull(obj, msg)

Pass if and only if the argument is null.

assertNotNull(obj, msg)

Pass if and only if the argument is not null.

assertDefined(obj, msg)

Pass if and only if the argument is defined. Note that null is defined.

assertUndefined(obj, msg)

Pass if and only if the argument is undefined.

assertTrue(obj, msg)

Pass if and only if the argument is true. Note that this is not the same as if (obj) pass. This only passes if you provide the actual true object. If you want the other behavior, use plain-old assert(obj, msg)

assertFalse(obj, msg)

See assertTrue(obj, msg)