Class SUnit

java.lang.Object

SUnit

public class SUnit
extends java.lang.Object

SUnit - A simple unit testing framework modeled after JUnit.

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertEquals(double expect, double actual, double epsilon) Verifies that two values are equal within a specified range.
static void	assertEquals(long expect, long actual) Verifies that two values are equal.
static void	assertEqualsObject(java.lang.Object expect, java.lang.Object actual) Verifies that two objects are equal as determined by their equals method.
static void	assertEqualsReference(java.lang.Object expect, java.lang.Object actual) Verifies that two references are equal.
static void	assertFalse(boolean actual) Verifies that a value is false.
static void	assertNotNull(java.lang.Object actual) Verifies that a reference is not null.
static void	assertNull(java.lang.Object actual) Verifies that a reference is null.
static void	assertTrue(boolean actual) Verifies that a value is true.
static void	fail() Explict failure - useful for tests that don't naturally fit the any of the assert methods.
static int	testsFailed() Returns the number of tests that have failed
static int	testsRun() Returns the total number of tests run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

testsRun

public static int testsRun()

Returns the total number of tests run.

Returns:

The total number of tests run.

testsFailed

public static int testsFailed()

Returns the number of tests that have failed

Returns:

The number of tests that have failed.

assertTrue

public static void assertTrue(boolean actual)

Verifies that a value is true. If the value is not true a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected true, found false"

Parameters:

actual - The value to verify as true.

assertFalse

public static void assertFalse(boolean actual)

Verifies that a value is false. If the value is not false a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected false, found true"

Parameters:

actual - The value to verify as false.

assertEquals

public static void assertEquals(long expect,
                long actual)

Verifies that two values are equal. If the values are not equal a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected X, found Y"

where X and Y are replace with the specified expect and actual values.

Parameters:

expect - The expected value.

actual - The actual value to verify as equal.

assertEquals

public static void assertEquals(double expect,
                double actual,
                double epsilon)

Verifies that two values are equal within a specified range. If the values are not equal a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected X +/-E, found Y"

where X, E, and Y are replace with the specified expect, epsilon, and actual values, respectively.

Parameters:

expect - The expected value.

actual - The actual value to verify as equal.

epsilon - The maximum difference allowed between expect and actual for them to be considered equal.

assertEqualsObject

public static void assertEqualsObject(java.lang.Object expect,
                      java.lang.Object actual)

Verifies that two objects are equal as determined by their equals method. If the values are not equal a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected object equality, found inequality"

Parameters:

expect - The expected object reference - must NOT be null.

actual - The actual object reference to verify as equal - may be null.

assertEqualsReference

public static void assertEqualsReference(java.lang.Object expect,
                         java.lang.Object actual)

Verifies that two references are equal. If the reference are not equal a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected reference equality, found inequality"

Parameters:

expect - The expected reference value.

actual - The actual reference value to verify as equal.

assertNull

public static void assertNull(java.lang.Object actual)

Verifies that a reference is null. If the value is not null then a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected null, found non-null"

Parameters:

actual - The actual value to verify as null.

assertNotNull

public static void assertNotNull(java.lang.Object actual)

Verifies that a reference is not null. If the value is null then a message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Expected non-null, found null"

Parameters:

actual - The actual value to verify as not null.

fail

public static void fail()

Explict failure - useful for tests that don't naturally fit the any of the assert methods. A message and stack trace is printed using the printStackTrace method of java.lang.Throwable. The message must be:

"Error: Explicit failure"