MGunit documentation

Unit testing for IDL

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

./

mgutguirunner__define.pro


Results for tests, test cases, and test suites are reported to the test runner. The MGutGUIRunner displays the results in an interactive GUI.

Class description for mgutguirunner

Inheritance

Properties

_extra init
filename init
color init

Routines

mgutguirunner_event, event

Event handler for GUI runner.

mgutguirunner_cleanup, tlb

Widget cleanup routine.

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

Report a test suite has begun.

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

Report the results of a test suite.

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

Report a test case has begun.

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

Report the results of a test case.

mgutguirunner::reportTestStart, testname, level=integer

Report the start of single test.

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

Report the result of a single test.

mgutguirunner::_print, text [, /continued] [, _extra=keywords]

Routine to display the results of a test.

mgutguirunner::cleanup

Free resources.

mgutguirunner::_createWidgets

Creates the user-interface for the GUI test runner.

mgutguirunner::_realizeWidgets

Realizes the user-interface for the GUI test runner.

mgutguirunner::_startXManager

Starts up XMANAGER.

mgutguirunner::_eventHandler, event

Handles all events from the GUI test runner.

mgutguirunner::_cleanupWidgets

Widget cleanup routine.

result = mgutguirunner::init(filename=filename, color=color, _extra=_extra)

Initialize the test runner.

mgutguirunner__define

Define member variables.

Routine details

top mgutguirunner_event

mgutguirunner_event, event

Event handler for GUI runner.

Parameters

event in required type=event structure

event structure for any event generated by GUI runner

top mgutguirunner_cleanup

mgutguirunner_cleanup, tlb

Widget cleanup routine.

Parameters

tlb in required type=long

top-level widget identifier

top mgutguirunner::reportTestSuiteStart

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

top mgutguirunner::reportTestSuiteResult

mgutguirunner::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 mgutguirunner::reportTestCaseStart

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

top mgutguirunner::reportTestCaseResult

mgutguirunner::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 mgutguirunner::reportTestStart

mgutguirunner::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 mgutguirunner::reportTestResult

mgutguirunner::reportTestResult, msg, /passed, time=float, /skipped, 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

time in required type=float

time for the test to run

skipped in required type=boolean

indicates whether the test should be counted in the results

level in required type=integer

level of test case

top mgutguirunner::_print

mgutguirunner::_print, text [, /continued] [, _extra=keywords]

Routine to display the results of a test.

Parameters

text in required type=string

message to display

Keywords

continued in optional type=boolean

set to indicate that the text is not finished

_extra in optional type=keywords

extra keywords present for compatibility with other runners

top mgutguirunner::cleanup

mgutguirunner::cleanup

Free resources.

top mgutguirunner::_createWidgets

mgutguirunner::_createWidgets

Creates the user-interface for the GUI test runner.

top mgutguirunner::_realizeWidgets

mgutguirunner::_realizeWidgets

Realizes the user-interface for the GUI test runner.

top mgutguirunner::_startXManager

mgutguirunner::_startXManager

Starts up XMANAGER.

top mgutguirunner::_eventHandler

mgutguirunner::_eventHandler, event

Handles all events from the GUI test runner.

Parameters

event in required type=structure

event structure from any widget generating events in the GUI test runner

top mgutguirunner::_cleanupWidgets

mgutguirunner::_cleanupWidgets

Widget cleanup routine.

top mgutguirunner::init

result = mgutguirunner::init(filename=filename, color=color, _extra=_extra)

Initialize the test runner.

Return value

1 for success, 0 for failure

Keywords

filename
color
_extra

top mgutguirunner__define

mgutguirunner__define

Define member variables.

File attributes

Modification date: Tue Jan 25 23:00:45 2011
Lines: 376
Docformat: rst rst