Interactive parser test runner and test file editor. More...

Inheritance diagram for ParserEditTests:

Collaboration diagram for ParserEditTests:

[legend]

Public Member Functions
	__construct ()
	Default constructor.

	execute ()
	Do the actual work.

	finalSetup ()
	Handle some last-minute setup here.

Public Member Functions inherited from Maintenance
function	__construct ()

	checkRequiredExtensions ()
	Verify that the required extensions are installed.

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

function	execute ()

	getConfig ()

	getDbType ()
	Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

	getName ()
	Get the script's name.

	globals ()
	Potentially debug globals.

	isQuiet ()

	loadParamsAndArgs ( $self=null, $opts=null, $args=null)
	Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments.

	loadSettings ()
	Generic setup for most installs.

	loadWithArgv ( $argv)
	Load params and arguments from a given array of command-line arguments.

	memoryLimit ()
	Normally we disable the memory_limit when running admin scripts.

	outputChanneled ( $msg, $channel=null)
	Message outputter with channeled message support.

	purgeRedundantText ( $delete=true)
	Support function for cleaning up redundant text records.

	runChild ( $maintClass, $classFile=null)
	Run a child maintenance script.

	setAgentAndTriggers ()
	Set triggers like when to try to run deferred updates.

	setConfig (Config $config)

	setDB (IDatabase $db)
	Sets database object to be returned by getDB().

	setup ()
	Do some sanity checking and basic setup.

	updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
	Perform a search index update with locking.

	updateSearchIndexForPage ( $dbw, $pageId)
	Update the searchindex table for a given pageid.

Protected Member Functions
	alternatingAligned ( $expectedStr, $actualStr)

	deleteSubtest ( $testInfo)

	deleteTest ( $testInfo)

	dwdiff ( $expected, $actual)

	editTest ( $fileName, $deletions, $changes)

	findTest ( $file, $testInfo)

	getOutputFileName ( $inputFileName)

	handleFailure ( $index, $testInfo, $result)

	heading ( $text)

	reload ( $testInfo)

	runTests ()

	setupFileData ()

	showProgress ()

	showResults ()

	switchTidy ( $testInfo)

	unifiedDiff ( $left, $right)

	update ( $testInfo, $result)

Protected Member Functions inherited from Maintenance
	activateProfiler ()
	Activate the profiler (assuming $wgProfiler is set)

	addArg ( $arg, $description, $required=true)
	Add some args that are needed.

	addDefaultParams ()
	Add the default parameters to the scripts.

	addDescription ( $text)
	Set the description text.

	addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
	Add a parameter to the script.

	adjustMemoryLimit ()
	Adjusts PHP's memory limit to better suit our needs, if needed.

	afterFinalSetup ()
	Execute a callback function at the end of initialisation.

	beginTransaction (IDatabase $dbw, $fname)
	Begin a transcation on a DB.

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transcation on a DB handle and wait for replica DBs to catch up.

	countDown ( $seconds)
	Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.

	deleteOption ( $name)
	Remove an option.

	error ( $err, $die=0)
	Throw an error to the user.

	fatalError ( $msg, $exitCode=1)
	Output a message and terminate the current script.

	getArg ( $argId=0, $default=null)
	Get an argument.

	getBatchSize ()
	Returns batch size.

	getDB ( $db, $groups=[], $wiki=false)
	Returns a database to be used by current maintenance script.

	getDir ()
	Get the maintenance directory.

	getOption ( $name, $default=null)
	Get an option, or return the default.

	getStdin ( $len=null)
	Return input from stdin.

	hasArg ( $argId=0)
	Does a given argument exist?

	hasOption ( $name)
	Checks to see if a particular param exists.

	loadSpecialVars ()
	Handle the special variables that are global to all scripts.

	maybeHelp ( $force=false)
	Maybe show the help.

	output ( $out, $channel=null)
	Throw some output to the user.

	requireExtension ( $name)
	Indicate that the specified extension must be loaded before the script can run.

	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transcation on a DB handle.

	setBatchSize ( $s=0)
	Set the batch size.

	validateParamsAndArgs ()
	Run some validation checks on the params, etc.

Private Attributes
	$numExecuted

	$numFailed

	$numSkipped

	$recorder

	$runner

	$termWidth

	$testCount

	$testFiles

Additional Inherited Members
Static Public Member Functions inherited from Maintenance
static	getTermSize ()
	Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows).

static	posix_isatty ( $fd)
	Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes.

static	readconsole ( $prompt='> ')
	Prompt the console for input.

static	requireTestsAutoloader ()
	Call this to set up the autoloader to allow classes to be used from the tests directory.

static	setLBFactoryTriggers (LBFactory $LBFactory, Config $config)

static	shouldExecute ()
	Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope)

Public Attributes inherited from Maintenance
resource	$fileHandle
	Used when creating separate schema files.

array	$orderedOptions = []
	Used to read the options in the order they were passed.

const	DB_ADMIN = 2

const	DB_NONE = 0
	Constants for DB access type.

const	DB_STD = 1

const	STDIN_ALL = 'all'

Protected Attributes inherited from Maintenance
	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

	$mParams = []

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Detailed Description

Interactive parser test runner and test file editor.

Definition at line 10 of file editTests.php.

Constructor & Destructor Documentation

◆ __construct()

ParserEditTests::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 20 of file editTests.php.

References Maintenance\addOption().

Member Function Documentation

◆ alternatingAligned()

ParserEditTests::alternatingAligned	(		$expectedStr,
			$actualStr )

protected

Definition at line 307 of file editTests.php.

References $result.

Referenced by handleFailure().

◆ deleteSubtest()

ParserEditTests::deleteSubtest ( $testInfo )

protected

Definition at line 473 of file editTests.php.

References editTest().

Referenced by handleFailure().

◆ deleteTest()

ParserEditTests::deleteTest ( $testInfo )

protected

Definition at line 442 of file editTests.php.

References editTest().

Referenced by handleFailure().

◆ dwdiff()

ParserEditTests::dwdiff	(		$expected,
			$actual )

protected

Definition at line 275 of file editTests.php.

References $result, and unifiedDiff().

Referenced by handleFailure().

◆ editTest()

ParserEditTests::editTest	(	$fileName,
		$deletions,
		$changes )

protected

Definition at line 405 of file editTests.php.

References TestFileEditor\edit(), print, and unifiedDiff().

Referenced by deleteSubtest(), deleteTest(), switchTidy(), and update().

◆ execute()

ParserEditTests::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 34 of file editTests.php.

References Maintenance\getOption(), Maintenance\getTermSize(), Maintenance\hasOption(), print, runTests(), setupFileData(), and showResults().

◆ finalSetup()

ParserEditTests::finalSetup ( )

Handle some last-minute setup here.

Reimplemented from Maintenance.

Definition at line 28 of file editTests.php.

References TestSetup\applyInitialConfig(), and Maintenance\requireTestsAutoloader().

◆ findTest()

ParserEditTests::findTest	(		$file,
			$testInfo )

protected

Definition at line 367 of file editTests.php.

References $line, and print.

◆ getOutputFileName()

ParserEditTests::getOutputFileName ( $inputFileName )

protected

Definition at line 395 of file editTests.php.

References print, and wfTempDir().

◆ handleFailure()

ParserEditTests::handleFailure	(	$index,
		$testInfo,
		$result )

protected

Definition at line 171 of file editTests.php.

References $options, $response, $term, alternatingAligned(), deleteSubtest(), deleteTest(), dwdiff(), heading(), print, Maintenance\readconsole(), reload(), switchTidy(), unifiedDiff(), and update().

Referenced by showResults().

◆ heading()

ParserEditTests::heading ( $text )

protected

Definition at line 156 of file editTests.php.

References $term.

Referenced by handleFailure().

◆ reload()

ParserEditTests::reload ( $testInfo )

protected

Definition at line 353 of file editTests.php.

References $argv, and print.

Referenced by handleFailure().

◆ runTests()

ParserEditTests::runTests ( )

protected

Definition at line 74 of file editTests.php.

References $result, print, and showProgress().

Referenced by execute().

◆ setupFileData()

ParserEditTests::setupFileData ( )

protected

Definition at line 64 of file editTests.php.

References ParserTestRunner\getParserTestFiles(), and TestFileReader\read().

Referenced by execute().

◆ showProgress()

ParserEditTests::showProgress ( )

protected

Definition at line 101 of file editTests.php.

References $numExecuted, and $testCount.

Referenced by runTests().

◆ showResults()

ParserEditTests::showResults ( )

protected

Definition at line 110 of file editTests.php.

References handleFailure(), print, and showResults().

Referenced by execute(), and showResults().

◆ switchTidy()

ParserEditTests::switchTidy ( $testInfo )

protected

Definition at line 449 of file editTests.php.

References editTest(), and print.

Referenced by handleFailure().

◆ unifiedDiff()

ParserEditTests::unifiedDiff	(		$left,
			$right )

protected

Definition at line 164 of file editTests.php.

References DiffFormatter\format().

Referenced by dwdiff(), editTest(), and handleFailure().

◆ update()

ParserEditTests::update	(		$testInfo,
			$result )

protected

Definition at line 428 of file editTests.php.

References editTest().

Referenced by handleFailure().

Member Data Documentation

◆ $numExecuted

ParserEditTests::$numExecuted

private

Definition at line 16 of file editTests.php.

Referenced by showProgress().

◆ $numFailed

ParserEditTests::$numFailed

private

Definition at line 18 of file editTests.php.

◆ $numSkipped

ParserEditTests::$numSkipped

private

Definition at line 17 of file editTests.php.

◆ $recorder

ParserEditTests::$recorder

private

Definition at line 14 of file editTests.php.

◆ $runner

ParserEditTests::$runner

private

Definition at line 15 of file editTests.php.

◆ $termWidth

ParserEditTests::$termWidth

private

Definition at line 11 of file editTests.php.

◆ $testCount

ParserEditTests::$testCount

private

Definition at line 13 of file editTests.php.

Referenced by showProgress().

◆ $testFiles

ParserEditTests::$testFiles

private

Definition at line 12 of file editTests.php.

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

tests/parser/editTests.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alternatingAligned()

◆ deleteSubtest()

◆ deleteTest()

◆ dwdiff()

◆ editTest()

◆ execute()

◆ finalSetup()

◆ findTest()

◆ getOutputFileName()

◆ handleFailure()

◆ heading()

◆ reload()

◆ runTests()

◆ setupFileData()

◆ showProgress()

◆ showResults()

◆ switchTidy()

◆ unifiedDiff()

◆ update()

Member Data Documentation

◆ $numExecuted

◆ $numFailed

◆ $numSkipped

◆ $recorder

◆ $runner

◆ $termWidth

◆ $testCount

◆ $testFiles