./
mgutjunitrunner__define.pro
Results for tests, test cases, and test suites are reported to the test
runner. The MGutJUnitRunner displays the results in the output XML file.
For example, a test that normally runs like:
IDL> mgunit, 'gpuradon_ut'
"All tests" test suite starting (1 test suite/case, 2 tests)
"gpuradon_ut" test case starting (2 tests)
test_basic_backprojection: passed (0.158287 seconds)
test_basic_forward: failed "incorrect result" (0.005014 seconds)
Results: 1 / 2 tests passed, 0 skipped
Results: 1 / 2 tests passed, 0 skipped
With MGutJUnitRunner, it would produce output like:
IDL> mgunit, 'gpuradon_ut', /junit
<testsuites name="All tests">
<testsuite name="gpuradon_ut">
<testcase name="test_basic_backprojection">
</testcase>
<testcase name="test_basic_forward">
<failure>incorrect result</failure>
</testcase>
</testsuite>
</testsuites>
Class description for mgutjunitrunner
Inheritance
Properties
- _extra init
- filename init
- color init
Routines
mgutjunitrunner::reportTestSuiteStart, testsuite, ntestcases=integer, ntests=integer, level=integerReport a test suite has begun.
mgutjunitrunner::reportTestSuiteResult, npass=integer, nfail=integer, nskip=integer, level=integerReport the results of a test suite.
mgutjunitrunner::reportTestCaseStart, testcase, ntests=integer, level=integerReport a test case has begun.
mgutjunitrunner::reportTestCaseResult, npass=integer, nfail=integer, nskip=integer, level=integerReport the results of a test case.
mgutjunitrunner::reportTestStart, testname, level=integerReport the start of single test.
mgutjunitrunner::reportTestResult, msg, /passed, time=float, /skipped, level=integerReport the result of a single test.
mgutjunitrunner::_print, lun, text [, _extra=keywords]Prints a message to a LUN.
mgutjunitrunner::cleanupFree resources.
result = mgutjunitrunner::init( [filename=string] [, /color] [, _extra=keywords])Initialize the test runner.
mgutjunitrunner__defineDefine member variables.
Routine details
top mgutjunitrunner::reportTestSuiteStart
mgutjunitrunner::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 mgutjunitrunner::reportTestSuiteResult
mgutjunitrunner::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 mgutjunitrunner::reportTestCaseStart
mgutjunitrunner::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 mgutjunitrunner::reportTestCaseResult
mgutjunitrunner::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 mgutjunitrunner::reportTestStart
mgutjunitrunner::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 mgutjunitrunner::reportTestResult
mgutjunitrunner::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 mgutjunitrunner::_print
mgutjunitrunner::_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 mgutjunitrunner::init
result = mgutjunitrunner::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 mgutjunitrunner
- _extra in optional type=keywords
keywords to MGutTestRunner::init
File attributes
| Modification date: | Tue Jan 25 22:43:51 2011 |
| Lines: | 268 |
| Docformat: | rst rst |