MGunit documentation

Unit testing for IDL

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

./

mgutclirunner__define.pro

Results for tests, test cases, and test suites are reported to the test runner. The MGutCliRunner displays the results in the output log or in a log file.

Class description for mgutclirunner

Inheritance

Properties

_extra init
filename init
color init

Fields

indent 0L

number of spaces a single indent should be

space 0B

byte value of the space character

ISTTY 0B
logLun 0L

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

Fields in mguttestrunner

Routines

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

Report a test suite has begun.

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

Report the results of a test suite.

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

Report a test case has begun.

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

Report the results of a test case.

mgutclirunner::reportTestStart, testname, level=integer

Report the start of single test.

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

Report the result of a single test.

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

Prints a message to a LUN.

result = mgutclirunner::_findIfTty()

Safe method of determining if the current terminal is TTY.

mgutclirunner::cleanup

Free resources.

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

Initialize the test runner.

mgutclirunner__define

Define member variables.

Routine details

topmgutclirunner::reportTestSuiteStart

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

topmgutclirunner::reportTestSuiteResult

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

topmgutclirunner::reportTestCaseStart

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

topmgutclirunner::reportTestCaseResult

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

topmgutclirunner::reportTestStart

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

topmgutclirunner::reportTestResult

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

topmgutclirunner::_print

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

topmgutclirunner::_findIfTty

result = mgutclirunner::_findIfTty()

Safe method of determining if the current terminal is TTY.

Return value

1 if the terminal is TTY, 0 if not

topmgutclirunner::cleanup

mgutclirunner::cleanup

Free resources.

topmgutclirunner::init

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

Initialize the test runner.

Return value

1 for success, 0 for failure

Keywords

filename in optional type=string

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

color in optional type=boolean

set to print color output

_extra

topmgutclirunner__define

mgutclirunner__define

Define member variables.

File attributes

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