This is a TestRecorder responsible for printing information about progress, success and failure to the console. More...

Inheritance diagram for ParserTestPrinter:

Collaboration diagram for ParserTestPrinter:

Public Member Functions
	__construct ( $term, $options)

	endSuite ( $path)
	Called after ending an input file.

	record ( $test, ParserTestResult $result)
	Called after each test.

	report ()
	Called before finishing the test run.

	skipped ( $test, $subtest)
	Mark a test skipped.

	start ()
	Called at beginning of the parser test run.

	startSuite ( $path)
	Show "Reading tests from ...".

	startTest ( $test)
	Called before starting a test.

	warning ( $message)
	Show a warning to the user.

Public Member Functions inherited from TestRecorder
	end ()
	Called at the end of the parser test run.

Private Member Functions
	colorDiff ( $text)
	Colorize unified diff output if set for ANSI color output.

	dumpToFile ( $data, $filename)
	Write the given string to a file, adding a final newline.

	extractFragment ( $text, $position)

	quickDiff ( $input, $output, $inFileTail='expected', $outFileTail='actual')
	Run given strings through a diff and return the (colorized) output.

	reportPercentage ( $success, $total)

	showFailure (ParserTestResult $testResult)
	Print a failure message and provide some explanatory output about what went wrong if so configured.

	showSuccess (ParserTestResult $testResult)
	Print a happy success message.

	showTesting ( $desc)

	wellFormed ( $text)

Private Attributes
	$markWhitespace

	$showDiffs

	$showFailure

	$showOutput

	$showProgress

	$skipped

	$success

	$term

	$total

	$useDwdiff

	$xmlError

Detailed Description

This is a TestRecorder responsible for printing information about progress, success and failure to the console.

It is specific to the parserTests.php frontend.

Definition at line 27 of file ParserTestPrinter.php.

Constructor & Destructor Documentation

◆ __construct()

ParserTestPrinter::__construct	(		$term,
			$options )

Definition at line 40 of file ParserTestPrinter.php.

References $options, $term, showFailure(), and term().

Member Function Documentation

◆ colorDiff()

ParserTestPrinter::colorDiff ( $text )

private

Colorize unified diff output if set for ANSI color output.

Subtractions are colored blue, additions red.

Parameters

string $text

Returns: string

Definition at line 221 of file ParserTestPrinter.php.

References term().

Referenced by quickDiff().

◆ dumpToFile()

ParserTestPrinter::dumpToFile	(		$data,
			$filename )

private

Write the given string to a file, adding a final newline.

Parameters

string	$data
string	$filename

Definition at line 208 of file ParserTestPrinter.php.

Referenced by quickDiff().

◆ endSuite()

ParserTestPrinter::endSuite ( $path )

Called after ending an input file.

Reimplemented from TestRecorder.

Definition at line 86 of file ParserTestPrinter.php.

References print.

◆ extractFragment()

ParserTestPrinter::extractFragment	(		$text,
			$position )

private

Definition at line 256 of file ParserTestPrinter.php.

References term().

Referenced by wellFormed().

◆ quickDiff()

ParserTestPrinter::quickDiff	(	$input,
		$output,
		$inFileTail = 'expected',
		$outFileTail = 'actual' )

private

Run given strings through a diff and return the (colorized) output.

Requires writable /tmp directory and a 'diff' command in the PATH.

Parameters

string	$input
string	$output
string	$inFileTail	Tailing for the input file name
string	$outFileTail	Tailing for the output file name

Returns: string

Definition at line 156 of file ParserTestPrinter.php.

References $input, $output, $wgDiff3, colorDiff(), dumpToFile(), wfEscapeShellArg(), wfIsWindows(), wfShellExec(), and wfTempDir().

Referenced by showFailure().

◆ record()

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

Called after each test.

Parameters

array	$test
ParserTestResult	$result

Reimplemented from TestRecorder.

Definition at line 90 of file ParserTestPrinter.php.

References showFailure(), and showSuccess().

◆ report()

ParserTestPrinter::report ( )

Called before finishing the test run.

Reimplemented from TestRecorder.

Definition at line 301 of file ParserTestPrinter.php.

References print, reportPercentage(), and term().

◆ reportPercentage()

ParserTestPrinter::reportPercentage	(		$success,
			$total )

private

Definition at line 309 of file ParserTestPrinter.php.

References $success, $total, print, skipped(), term(), and wfPercent().

Referenced by report().

◆ showFailure()

ParserTestPrinter::showFailure ( ParserTestResult $testResult )

private

Print a failure message and provide some explanatory output about what went wrong if so configured.

Parameters

ParserTestResult $testResult

Returns: bool

Definition at line 120 of file ParserTestPrinter.php.

References ParserTestResult\getDescription(), print, quickDiff(), showFailure(), showTesting(), term(), and wellFormed().

Referenced by __construct(), record(), and showFailure().

◆ showSuccess()

ParserTestPrinter::showSuccess ( ParserTestResult $testResult )

private

Print a happy success message.

Parameters

ParserTestResult $testResult

Returns: bool

Definition at line 107 of file ParserTestPrinter.php.

References print, and term().

Referenced by record().

◆ showTesting()

ParserTestPrinter::showTesting ( $desc )

private

Definition at line 70 of file ParserTestPrinter.php.

References print.

Referenced by showFailure(), and startTest().

◆ skipped()

ParserTestPrinter::skipped	(		$test,
			$subtest )

Mark a test skipped.

Parameters

string	$test
string	$subtest

Reimplemented from TestRecorder.

Definition at line 294 of file ParserTestPrinter.php.

References print, skipped(), and term().

Referenced by reportPercentage(), skipped(), and start().

◆ start()

ParserTestPrinter::start ( )

Called at beginning of the parser test run.

Reimplemented from TestRecorder.

Definition at line 58 of file ParserTestPrinter.php.

References skipped().

◆ startSuite()

ParserTestPrinter::startSuite ( $path )

Show "Reading tests from ...".

Parameters

string $path

Reimplemented from TestRecorder.

Definition at line 79 of file ParserTestPrinter.php.

References print, and term().

◆ startTest()

ParserTestPrinter::startTest ( $test )

Called before starting a test.

Reimplemented from TestRecorder.

Definition at line 64 of file ParserTestPrinter.php.

References showTesting().

◆ warning()

ParserTestPrinter::warning ( $message )

Show a warning to the user.

Parameters

string $message

Reimplemented from TestRecorder.

Definition at line 285 of file ParserTestPrinter.php.

◆ wellFormed()

ParserTestPrinter::wellFormed ( $text )

private

Definition at line 229 of file ParserTestPrinter.php.

References $html, $parser, and extractFragment().

Referenced by showFailure().

Member Data Documentation

◆ $markWhitespace

ParserTestPrinter::$markWhitespace

private

Definition at line 37 of file ParserTestPrinter.php.

◆ $showDiffs

ParserTestPrinter::$showDiffs

private

Definition at line 32 of file ParserTestPrinter.php.

◆ $showFailure

ParserTestPrinter::$showFailure

private

Definition at line 34 of file ParserTestPrinter.php.

◆ $showOutput

ParserTestPrinter::$showOutput

private

Definition at line 35 of file ParserTestPrinter.php.

◆ $showProgress

ParserTestPrinter::$showProgress

private

Definition at line 33 of file ParserTestPrinter.php.

◆ $skipped

ParserTestPrinter::$skipped

private

Definition at line 30 of file ParserTestPrinter.php.

◆ $success

ParserTestPrinter::$success

private

Definition at line 29 of file ParserTestPrinter.php.

Referenced by reportPercentage().

◆ $term

ParserTestPrinter::$term

private

Definition at line 31 of file ParserTestPrinter.php.

Referenced by __construct().

◆ $total

ParserTestPrinter::$total

private

Definition at line 28 of file ParserTestPrinter.php.

Referenced by reportPercentage().

◆ $useDwdiff

ParserTestPrinter::$useDwdiff

private

Definition at line 36 of file ParserTestPrinter.php.

◆ $xmlError

ParserTestPrinter::$xmlError

private

Definition at line 38 of file ParserTestPrinter.php.

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

tests/parser/ParserTestPrinter.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ colorDiff()

◆ dumpToFile()

◆ endSuite()

◆ extractFragment()

◆ quickDiff()

◆ record()

◆ report()

◆ reportPercentage()

◆ showFailure()

◆ showSuccess()

◆ showTesting()

◆ skipped()

◆ start()

◆ startSuite()

◆ startTest()

◆ warning()

◆ wellFormed()

Member Data Documentation

◆ $markWhitespace

◆ $showDiffs

◆ $showFailure

◆ $showOutput

◆ $showProgress

◆ $skipped

◆ $success

◆ $term

◆ $total

◆ $useDwdiff

◆ $xmlError