MediaWiki  REL1_31
TestRecorder Class Reference

Interface to record parser test results. More...

Inheritance diagram for TestRecorder:

Public Member Functions

 end ()
 Called at the end of the parser test run. More...
 
 endSuite ( $path)
 Called after ending an input file. More...
 
 record ( $test, ParserTestResult $result)
 Called after each test. More...
 
 report ()
 Called before finishing the test run. More...
 
 skipped ( $test, $subtest)
 Mark a test skipped. More...
 
 start ()
 Called at beginning of the parser test run. More...
 
 startSuite ( $path)
 Called before starting an input file. More...
 
 startTest ( $test)
 Called before starting a test. More...
 
 warning ( $message)
 Show a warning to the user. More...
 

Detailed Description

Interface to record parser test results.

The TestRecorder is an class hierarchy to record the result of MediaWiki parser tests. One should call start() before running the full parser tests and end() once all the tests have been finished. After each test, you should use record() to keep track of your tests results. Finally, report() is used to generate a summary of your test run, one could dump it to the console for human consumption or register the result in a database for tracking purposes.

Since
1.22

Definition at line 35 of file TestRecorder.php.

Member Function Documentation

◆ end()

TestRecorder::end ( )

Called at the end of the parser test run.

Reimplemented in MultiTestRecorder, and DbTestRecorder.

Definition at line 90 of file TestRecorder.php.

◆ endSuite()

TestRecorder::endSuite (   $path)

Called after ending an input file.

Reimplemented in ParserTestPrinter, and MultiTestRecorder.

Definition at line 58 of file TestRecorder.php.

◆ record()

TestRecorder::record (   $test,
ParserTestResult  $result 
)

Called after each test.

Parameters
array$test
ParserTestResult$result

Reimplemented in ParserTestPrinter, MultiTestRecorder, DbTestRecorder, and DbTestPreviewer.

Definition at line 66 of file TestRecorder.php.

◆ report()

TestRecorder::report ( )

Called before finishing the test run.

Reimplemented in ParserTestPrinter, MultiTestRecorder, and DbTestPreviewer.

Definition at line 84 of file TestRecorder.php.

◆ skipped()

TestRecorder::skipped (   $test,
  $subtest 
)

Mark a test skipped.

Reimplemented in ParserTestPrinter, MultiTestRecorder, and PhpunitTestRecorder.

Definition at line 78 of file TestRecorder.php.

◆ start()

TestRecorder::start ( )

Called at beginning of the parser test run.

Reimplemented in ParserTestPrinter, MultiTestRecorder, DbTestRecorder, and DbTestPreviewer.

Definition at line 40 of file TestRecorder.php.

◆ startSuite()

TestRecorder::startSuite (   $path)

Called before starting an input file.

Reimplemented in ParserTestPrinter, and MultiTestRecorder.

Definition at line 52 of file TestRecorder.php.

◆ startTest()

TestRecorder::startTest (   $test)

Called before starting a test.

Reimplemented in ParserTestPrinter, and MultiTestRecorder.

Definition at line 46 of file TestRecorder.php.

◆ warning()

TestRecorder::warning (   $message)

Show a warning to the user.

Reimplemented in ParserTestPrinter, and MultiTestRecorder.

Definition at line 72 of file TestRecorder.php.

Referenced by ParserTestRunner\__construct().


The documentation for this class was generated from the following file: