MGunit documentation

Unit testing for IDL

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

./

mgutxmlrunner__define.pro


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

Class description for mgutxmlrunner

Inheritance

Properties

_extra init
filename init
color init

Routines

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

Report a test suite has begun.

mgutxmlrunner::reportTestSuiteResult, npass=integer, nfail=integer, nskip=integer, level=integer

Report the results of a test suite.

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

Report a test case has begun.

mgutxmlrunner::reportTestCaseResult, npass=integer, nfail=integer, nskip=integer, level=integer

Report the results of a test case.

mgutxmlrunner::reportTestStart, testname, level=integer

Report the start of single test.

mgutxmlrunner::reportTestResult, msg, /passed, /skipped, time=float, level=integer

Report the result of a single test.

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

Prints a message to a LUN.

mgutxmlrunner::cleanup

Free resources.

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

Initialize the test runner.

mgutxmlrunner__define

Define member variables.

Routine details

top mgutxmlrunner::reportTestSuiteStart

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

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=integer

level of test suite

top mgutxmlrunner::reportTestSuiteResult

mgutxmlrunner::reportTestSuiteResult, npass=integer, nfail=integer, nskip=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

nskip in required type=integer

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

level in required type=integer

level of test suite

top mgutxmlrunner::reportTestCaseStart

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

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=integer

level of test case

top mgutxmlrunner::reportTestCaseResult

mgutxmlrunner::reportTestCaseResult, npass=integer, nfail=integer, nskip=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

nskip in required type=integer

number of skipped tests

level in required type=integer

level of test case

top mgutxmlrunner::reportTestStart

mgutxmlrunner::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

top mgutxmlrunner::reportTestResult

mgutxmlrunner::reportTestResult, msg, /passed, /skipped, time=float, level=integer

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

skipped in required type=boolean

indicates whether the test should be counted in the results

time in required type=float

time for the test to run

level in required type=integer

level of test case

top mgutxmlrunner::_print

mgutxmlrunner::_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

top mgutxmlrunner::cleanup

mgutxmlrunner::cleanup

Free resources.

top mgutxmlrunner::init

result = mgutxmlrunner::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 MGutXMLRunner

_extra in optional type=keywords

keywords to MGutTestRunner::init

top mgutxmlrunner__define

mgutxmlrunner__define

Define member variables.

File attributes

Modification date: Tue Jan 25 23:07:19 2011
Lines: 248
Docformat: rst rst