MGunit documentation

Unit testing for IDL

single page | use frames     summary     class     fields     routine details     file attributes

./

mguthtmlrunner__define.pro

Results for tests, test cases, and test suites are reported to the test runner. The MGutHTMLRunner displays the results in the output HTML file.

Class description for mguthtmlrunner

Inheritance

Properties

_extra init
filename init
color init

Fields

lun 0L

the logical unit number to send output to (-1L by default)

Fields in mguttestrunner

Routines

mguthtmlrunner::reportTestSuiteStart, testsuite, ntestcases=integer, ntests=integer, level=level

Report a test suite has begun.

mguthtmlrunner::reportTestSuiteResult, npass=integer, nfail=integer, level=integer

Report the results of a test suite.

mguthtmlrunner::reportTestCaseStart, testcase, ntests=integer, level=level

Report a test case has begun.

mguthtmlrunner::reportTestCaseResult, npass=integer, nfail=integer, level=integer

Report the results of a test case.

mguthtmlrunner::reportTestStart, testname, level=integer

Report the start of single test.

mguthtmlrunner::reportTestResult, msg, /passed, time=float

Report the result of a single test.

mguthtmlrunner::_print, lun, text [, _extra=keywords]

Prints a message to a LUN.

mguthtmlrunner::cleanup

Free resources.

result = mguthtmlrunner::init( [filename=string] [, /color] [, _extra=keywords])

Initialize the test runner.

mguthtmlrunner__define

Define member variables.

Routine details

topmguthtmlrunner::reportTestSuiteStart

mguthtmlrunner::reportTestSuiteStart, testsuite, ntestcases=integer, ntests=integer, level=level

Report a test suite has begun.

Parameters

testsuite in required type=string

name of test suite

Keywords

ntestcases in required type=integer

number of test suites/cases contained by the test suite

ntests in required type=integer

number of tests contained in the hierarchy below this test suite

level in required type=level

level of test suite

topmguthtmlrunner::reportTestSuiteResult

mguthtmlrunner::reportTestSuiteResult, npass=integer, nfail=integer, level=integer

Report the results of a test suite.

Keywords

npass in required type=integer

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

nfail in required type=integer

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

level in required type=integer

level of test suite

topmguthtmlrunner::reportTestCaseStart

mguthtmlrunner::reportTestCaseStart, testcase, ntests=integer, level=level

Report a test case has begun.

Parameters

testcase in required type=string

name of test case

Keywords

ntests in required type=integer

number of tests contained in this test case

level in required type=level

level of test case

topmguthtmlrunner::reportTestCaseResult

mguthtmlrunner::reportTestCaseResult, npass=integer, nfail=integer, level=integer

Report the results of a test case.

Keywords

npass in required type=integer

number of passing tests

nfail in required type=integer

number of failing tests

level in required type=integer

level of test case

topmguthtmlrunner::reportTestStart

mguthtmlrunner::reportTestStart, testname, level=integer

Report the start of single test.

Parameters

testname in required type=string

name of test

Keywords

level in required type=integer

level of test case

topmguthtmlrunner::reportTestResult

mguthtmlrunner::reportTestResult, msg, /passed, time=float

Report the result of a single test.

Parameters

msg in required type=string

message to display when test fails

Keywords

passed in required type=boolean

whether the test passed

time in required type=float

time for the test to run

topmguthtmlrunner::_print

mguthtmlrunner::_print, lun, text [, _extra=keywords]

Prints a message to a LUN.

Parameters

lun in required type=long

logical unit number to print to

text in required type=string

text to print

Keywords

_extra in optional type=keywords

keywords to MG_ANSICODE i.e. RED or GREEN

topmguthtmlrunner::cleanup

mguthtmlrunner::cleanup

Free resources.

topmguthtmlrunner::init

result = mguthtmlrunner::init( [filename=string] [, /color] [, _extra=keywords])

Initialize the test runner.

Return value

1 for success, 0 for failure

Keywords

filename in optional type=string

if present, output is sent that file, otherwise output is sent to stdout

color in optional type=boolean

unused for MGutHtmlRunner

_extra in optional type=keywords

keywords to MGutTestRunner::init

topmguthtmlrunner__define

mguthtmlrunner__define

Define member variables.

File attributes

Modification date: Wed Apr 22 23:28:57 2009
Lines: 257
Docformat: rst rst