Simple Unit Testing Toolbox

Simple unit testing framework for MATLAB.

Simple Unit Testing Toolbox

This toolbox defines a simple unit testing framework for MATLAB.

Installation

1. Download the toolbox from File Exchange or GitHub.
2. Open the INSTALL folder.
3. Double-click on Simple Unit Testing Toolbox.mltbx.

MATLAB will automatically perform the installation and add all the contents of the toolbox folder to the MATLAB search path.

Documentation

Toolbox Documentation

To open the home page of the toolbox documentation in MATLAB, type the following in the Command Window:

doc_SUTT

To open the documentation of a specific function or class with name name, type the following in the Command Window:

doc_SUTT name

Test Suites

Creating a test suite.

test_suite = TestSuite(name,terminate,color)

Adding tests to a test suite.

test_suite.add_test(TestEqual(X1,X2,name,n))
test_suite.add_test(TestNotEqual(X1,X2,name,n))
test_suite.add_test(TestError(f,args,name))
test_suite.add_test(TestNoError(f,args,name))
test_suite.add_test(TestSpeed(f1,f2,args,name))
test_suite.add_test(TestFunctionCount(f,g,name))

Running a test suite.

test_suite.run

Individual Unit Testing Functions

Testing for array equality/inequality.

TEST_EQUAL(X1,X2,n)
TEST_NOT_EQUAL(X1,X2,n)

Testing for correct error handling.

TEST_ERROR(f,args)
TEST_NO_ERROR(f,args)

Testing speed.

TEST_SPEED(f_fast,f_slow,args,n_eval)
TIME_EVALUATION(f,args,n_eval)

Testing counting the number of function evaluations.

TEST_FUNCTION_COUNT(f,g)

Printing to Command Window

Note that in the examples in the documentation, all of the test output is in black. However, when you run the tests locally in MATLAB, passed tests will print in green, while failed tests will print in red; this is accomplished using the cprintf function.