e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
65 lines
1.9 KiB
PHP
65 lines
1.9 KiB
PHP
<?php
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/../includes/Benchmarker.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Benchmark any provided code for ad-hoc benchmarks.
|
|
*
|
|
* Usage:
|
|
*
|
|
* $ php benchmarkEval.php --code "Html::openElement( 'a', [ 'class' => 'foo' ] );"
|
|
* $ echo "Html::openElement( 'a', [ 'class' => 'foo' ] );" | php benchmarkEval.php
|
|
* $ php benchmarkEval.php input.txt
|
|
*
|
|
* @ingroup Benchmark
|
|
*/
|
|
class BenchmarkEval extends Benchmarker {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addOption( 'inner',
|
|
'Inner loop iterations', false, true );
|
|
$this->addOption( 'code',
|
|
'The code to run',
|
|
false, true, 'e' );
|
|
$this->addOption( 'setup',
|
|
'Code to run once before the first iteration',
|
|
false, true );
|
|
$this->addArg( 'input-file', 'Input file for measured code body', false );
|
|
}
|
|
|
|
public function execute() {
|
|
if ( $this->hasOption( 'setup' ) ) {
|
|
$setupCode = $this->getOption( 'setup' ) . ';';
|
|
// phpcs:ignore MediaWiki.Usage.ForbiddenFunctions.eval
|
|
eval( $setupCode );
|
|
}
|
|
|
|
if ( $this->hasOption( 'code' ) ) {
|
|
$code = $this->getOption( 'code' );
|
|
} elseif ( $this->hasArg( 0 ) ) {
|
|
$code = file_get_contents( $this->getArg( 0 ) );
|
|
if ( $code === false ) {
|
|
$this->fatalError( "Unable to read input file" );
|
|
}
|
|
} else {
|
|
fwrite( STDERR, "Reading from stdin...\n" );
|
|
$code = stream_get_contents( STDIN );
|
|
}
|
|
$code .= ';';
|
|
$inner = $this->getOption( 'inner', 1 );
|
|
if ( $inner > 1 ) {
|
|
$code = "for ( \$__i = 0; \$__i < $inner; \$__i++ ) { $code }";
|
|
}
|
|
$code = "function wfBenchmarkEvalBody () { $code }";
|
|
// phpcs:ignore MediaWiki.Usage.ForbiddenFunctions.eval
|
|
eval( $code );
|
|
$this->bench( [ 'eval' => [ 'function' => 'wfBenchmarkEvalBody' ] ] );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = BenchmarkEval::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|