MediaWiki  1.29.1
ParserEditTests Class Reference

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

Inheritance diagram for ParserEditTests:
Collaboration diagram for ParserEditTests:

Public Member Functions

 __construct ()
 Default constructor. More...
 
 execute ()
 Do the actual work. More...
 
 finalSetup ()
 Handle some last-minute setup here. More...
 
- Public Member Functions inherited from Maintenance
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 getConfig ()
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...
 
 getName ()
 Get the script's name. More...
 
 globals ()
 Potentially debug globals. More...
 
 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. More...
 
 loadSettings ()
 Generic setup for most installs. More...
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments. More...
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts. More...
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support. More...
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records. More...
 
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script. More...
 
 setAgentAndTriggers ()
 Set triggers like when to try to run deferred updates. More...
 
 setConfig (Config $config)
 
 setDB (IDatabase $db)
 Sets database object to be returned by getDB(). More...
 
 setup ()
 Do some sanity checking and basic setup. More...
 
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking. More...
 
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid. More...
 

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) More...
 
 addArg ( $arg, $description, $required=true)
 Add some args that are needed. More...
 
 addDefaultParams ()
 Add the default parameters to the scripts. More...
 
 addDescription ( $text)
 Set the description text. More...
 
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script. More...
 
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed. More...
 
 afterFinalSetup ()
 Execute a callback function at the end of initialisation. More...
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
 getDB ( $db, $groups=[], $wiki=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. More...
 
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 
 getStdin ( $len=null)
 Return input from stdin. More...
 
 hasArg ( $argId=0)
 Does a given argument exist? More...
 
 hasOption ( $name)
 Checks to see if a particular param exists. More...
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 
 maybeHelp ( $force=false)
 Maybe show the help. More...
 
 output ( $out, $channel=null)
 Throw some output to the user. More...
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

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). More...
 
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. More...
 
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
 
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
 
static setLBFactoryTriggers (LBFactory $LBFactory)
 
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) More...
 
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type. More...
 
const DB_STD = 1
 
const STDIN_ALL = 'all'
 
- Protected Attributes inherited from Maintenance
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $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 308 of file editTests.php.

References captcha-old\count.

Referenced by handleFailure().

◆ deleteSubtest()

ParserEditTests::deleteSubtest (   $testInfo)
protected

Definition at line 475 of file editTests.php.

References editTest().

Referenced by handleFailure().

◆ deleteTest()

ParserEditTests::deleteTest (   $testInfo)
protected

Definition at line 444 of file editTests.php.

References editTest().

Referenced by handleFailure().

◆ dwdiff()

ParserEditTests::dwdiff (   $expected,
  $actual 
)
protected

Definition at line 276 of file editTests.php.

References unifiedDiff().

Referenced by handleFailure().

◆ editTest()

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

Definition at line 406 of file editTests.php.

References TestFileEditor\edit(), 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(), 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 368 of file editTests.php.

References $line.

◆ getOutputFileName()

ParserEditTests::getOutputFileName (   $inputFileName)
protected

Definition at line 396 of file editTests.php.

References wfTempDir().

◆ handleFailure()

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

◆ heading()

ParserEditTests::heading (   $text)
protected

Definition at line 157 of file editTests.php.

References $term.

Referenced by handleFailure().

◆ reload()

ParserEditTests::reload (   $testInfo)
protected

Definition at line 354 of file editTests.php.

References $argv, and global.

Referenced by handleFailure().

◆ runTests()

ParserEditTests::runTests ( )
protected

Definition at line 75 of file editTests.php.

References as, and showProgress().

Referenced by execute().

◆ setupFileData()

ParserEditTests::setupFileData ( )
protected

Definition at line 64 of file editTests.php.

References as, captcha-old\count, global, and TestFileReader\read().

Referenced by execute().

◆ showProgress()

ParserEditTests::showProgress ( )
protected

Definition at line 102 of file editTests.php.

References $numExecuted, and $testCount.

Referenced by runTests().

◆ showResults()

ParserEditTests::showResults ( )
protected

Definition at line 111 of file editTests.php.

References as, captcha-old\count, and handleFailure().

Referenced by execute().

◆ switchTidy()

ParserEditTests::switchTidy (   $testInfo)
protected

Definition at line 451 of file editTests.php.

References editTest().

Referenced by handleFailure().

◆ unifiedDiff()

ParserEditTests::unifiedDiff (   $left,
  $right 
)
protected

Definition at line 165 of file editTests.php.

References DiffFormatter\format().

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

◆ update()

ParserEditTests::update (   $testInfo,
  $result 
)
protected

Definition at line 430 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: