mgunit 1.2 API documentation

Unit testing framework for IDL

Index

.     A     C     E     F     G     H     I     J     L     M     N     P     R     S     T     V     X    

.

./ directory

classes and launch/helper routines which comprise mgunit

A

all keyword in routine mguttestsuite::add in file mguttestsuite__define.pro

set to add all the files in the current directory that end in "_ut__define.pro" (the current directory is defined to be the directory where the method calling this method is located)

arg1 parameter in routine assert in file assert.pro

first argument for any C format codes in msg

arg2 parameter in routine assert in file assert.pro

second argument for any C format codes in msg

arg3 parameter in routine assert in file assert.pro

third argument for any C format codes in msg

assert routine in assert.pro

Raises an error if the given condition is not met.

assert.pro .pro file in ./ directory

C

color keyword in routine mgunit in file mgunit.pro

set to print color output to the output log

condition parameter in routine assert in file assert.pro

condition to assert

E

error_is_fail.pro .pro file in ./ directory
error_is_pass.pro .pro file in ./ directory
event parameter in routine mgunit_event_recorder in file mgunit_event_recorder.pro

widget event

event_handler keyword in routine mgunit_event_setup in file mgunit_event_setup.pro

F

failures_only property in class mguttestcase
failures_only property in class mguttestsuite

set to report only failed tests

failures_only keyword in routine mguttestsuite::init in file mguttestsuite__define.pro

set to report only failed tests

failures_only keyword in routine mgunit in file mgunit.pro

report only failed tests

failures_only keyword in routine mguttestcase::init in file mguttestcase__define.pro

set to report only failed tests

failuresOnly field in class mguttestcase

flag to indicate only failed tests should be reported

failuresOnly field in class mguttestsuite

flag to indicate only failed tests should be reported

filename keyword in routine mgunit_event_setup in file mgunit_event_setup.pro
filename keyword in routine mgunit in file mgunit.pro

name of file to send output to; if not present sends output to the output log

full keyword in routine mgunit_version in file mgunit_version.pro

set to return Subversion revision as well

G

gui keyword in routine mgunit in file mgunit.pro

set to bring up an interactive GUI to run the tests

gui/ directory

H

home property in class mguttestsuite

location of the root of the test suite

home field in class mguttestsuite

directory (with trailing slash) containing the source code for this test suite

home keyword in routine mguttestsuite::init in file mguttestsuite__define.pro

location of the root of the test suite

html keyword in routine mgunit in file mgunit.pro

set to indicate HTML output instead of plain text

I

IDL_CONTAINER_BOTTOM field in class IDL_CONTAINER
IDL_CONTAINER_TOP field in class IDL_CONTAINER
IDLCONTAINERVERSION field in class IDL_CONTAINER

J

junit keyword in routine mgunit in file mgunit.pro

set to indicate XML output in JUnit format instead of plain text

L

level field in class mguttestcase

number of layers down from the top-containing suite

level field in class mguttestsuite

number of layers below the top-most containing test suite

logmsgs field in class mguttestcase

pointer to string array of log message for each test

M

mgunit routine in mgunit.pro

Runs unit tests provided.

mgunit.pro .pro file in ./ directory
mgunit_event_player routine in mgunit_event_player.pro

Event handler for a GUI application which will play back a sequence of previously recorded events.

mgunit_event_player.pro .pro file in gui/ directory
mgunit_event_recorder routine in mgunit_event_recorder.pro

Record the events for a

mgunit_event_recorder.pro .pro file in gui/ directory
mgunit_event_setup routine in mgunit_event_setup.pro

Setup the state of the event recorder/players.

mgunit_event_setup.pro .pro file in gui/ directory
mgunit_version routine in mgunit_version.pro

Returns mgunit version.

mgunit_version.pro .pro file in ./ directory
mgunit_wrapper routine in mgunit_wrapper.pro

Command line wrapper for mgunit.

mgunit_wrapper.pro .pro file in ./ directory
mguttestcase class
mguttestcase::cleanup routine in mguttestcase__define.pro

Free resources.

mguttestcase::getProperty routine in mguttestcase__define.pro

Get properties of the object.

mguttestcase::init routine in mguttestcase__define.pro

Intialize test case.

mguttestcase::setProperty routine in mguttestcase__define.pro

Set properties of the object.

mguttestcase::setup routine in mguttestcase__define.pro

Override in subclasses to perform setup actions before each test.

mguttestcase::teardown routine in mguttestcase__define.pro

Override in subclasses to perform teardown actions after each test.

mguttestcase__define routine in mguttestcase__define.pro

Define member variables.

mguttestcase__define.pro .pro file in ./ directory

Subclass MGutTestCase to actually write tests.

mguttestsuite class
mguttestsuite::add routine in mguttestsuite__define.pro

Add a scalar or array of test suites or test cases.

mguttestsuite::cleanup routine in mguttestsuite__define.pro

Free resources.

mguttestsuite::getProperty routine in mguttestsuite__define.pro

Get properties of the object.

mguttestsuite::init routine in mguttestsuite__define.pro

Initialize test suite.

mguttestsuite__define routine in mguttestsuite__define.pro

Define member variables.

mguttestsuite__define.pro .pro file in ./ directory

Test suites are containers for test cases.

msg parameter in routine assert in file assert.pro

message to throw if condition is not met

N

name keyword in routine mguttestsuite::init in file mguttestsuite__define.pro

name of the test suite

name property in class mguttestsuite

name of the object

name field in class mguttestsuite

name of the object

name keyword in routine mguttestsuite::getProperty in file mguttestsuite__define.pro

name of the object

nfail keyword in routine mguttestsuite::getProperty in file mguttestsuite__define.pro

number of failing tests contained in the hierarchy below this object

nfail keyword in routine mgunit in file mgunit.pro

number of tests that failed

nfail property in class mguttestcase

number of failing tests

nfail field in class mguttestcase

number of failing tests

nfail field in class mguttestsuite

number of failing tests contained in the hierarchy below this test suite

nfail property in class mguttestsuite

number of failing tests contained in the hierarchy below this object

nfail keyword in routine mguttestcase::getProperty in file mguttestcase__define.pro

number of failing tests

NLIST field in class IDL_CONTAINER
npass keyword in routine mguttestsuite::getProperty in file mguttestsuite__define.pro

number of passing tests contained in the hierarchy below this object

npass property in class mguttestcase

number of passing tests

npass property in class mguttestsuite

number of passing tests contained in the hierarchy below this object

npass field in class mguttestcase

number of passing tests

npass keyword in routine mguttestcase::getProperty in file mguttestcase__define.pro

number of passing tests

npass field in class mguttestsuite

number of passing tests contained in the hierarchy below this test suite

npass keyword in routine mgunit in file mgunit.pro

number of tests that passed

nskip field in class mguttestsuite

number of skipped tests contained in the hierarchy below this test suite

nskip property in class mguttestsuite

number of skipped tests contained in the hierarchy below this object

nskip keyword in routine mgunit in file mgunit.pro

number of tests that were skipped

NSKIP field in class mguttestcase
nskip property in class mguttestcase

number of skipped tests

nskip keyword in routine mguttestsuite::getProperty in file mguttestsuite__define.pro

number of skipped tests contained in the hierarchy below this object

nskip keyword in routine mguttestcase::getProperty in file mguttestcase__define.pro

number of skipped tests

ntestcases property in class mguttestsuite

number of directly contained test suites or test cases

ntestcases keyword in routine mguttestsuite::getProperty in file mguttestsuite__define.pro

number of directly contained test suites or test cases

ntests keyword in routine mgunit in file mgunit.pro

number of tests

ntests keyword in routine mguttestcase::getProperty in file mguttestcase__define.pro

number of tests

ntests field in class mguttestcase

total number of tests

ntests property in class mguttestsuite

number of tests contained in the hierarchy below this object

ntests keyword in routine mguttestsuite::getProperty in file mguttestsuite__define.pro

number of tests contained in the hierarchy below this object

ntests property in class mguttestcase

number of tests

P

passes field in class mguttestcase

point to byte array of pass/fail status for each test

PHEAD field in class IDL_CONTAINER
play keyword in routine mgunit_event_setup in file mgunit_event_setup.pro

set to start playback

PTAIL field in class IDL_CONTAINER

R

record keyword in routine mgunit_event_setup in file mgunit_event_setup.pro

set to begin recording

S

skip keyword in routine assert in file assert.pro

set to skip the current test instead of passing or failing

SKIPPED field in class mguttestcase
stop keyword in routine mgunit_event_setup in file mgunit_event_setup.pro

set to stop playing or recording

T

test_runner keyword in routine mguttestsuite::init in file mguttestsuite__define.pro

subclass of MGtestRunner

test_runner keyword in routine mguttestcase::init in file mguttestcase__define.pro

subclass of MGutTestRunner

test_runner property in class mguttestcase
test_runner property in class mguttestsuite

subclass of MGtestRunner

testcases field in class mguttestsuite

IDL_Container holding test suites or test cases

testnames field in class mguttestcase

pointer to string array of method names that start with "test"

testnames keyword in routine mguttestcase::setProperty in file mguttestcase__define.pro

array of method names which begin with "test"

testnames property in class mguttestcase

array of method names which begin with "test"

testnames keyword in routine mguttestcase::getProperty in file mguttestcase__define.pro

array of method names which begin with "test"

testRunner field in class mguttestsuite

subclass of MGutTestRunner

testRunner field in class mguttestcase

subclass of MGtestRunner

tests parameter in routine mgunit in file mgunit.pro

array of test suite and/or test case classnames

tests parameter in routine mguttestsuite::add in file mguttestsuite__define.pro

classnames of test suites or test cases

time field in class mguttestcase

time for the current test to run

V

version keyword in routine mgunit in file mgunit.pro

set to report version and exit

X

xml keyword in routine mgunit in file mgunit.pro

set to indicate XML output instead of plain text