wiki.techinc.nl/maintenance/benchmarks/benchmarkSettings.php
Dreamy Jazz e7393b3cc7 Exclude boilerplate maintenance code from code coverage reports
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
2024-08-27 13:22:29 +01:00

144 lines
4.5 KiB
PHP

<?php
/**
* Benchmark %MediaWiki hooks.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Benchmark
*/
use MediaWiki\MainConfigSchema;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\Settings\Config\ArrayConfigBuilder;
use MediaWiki\Settings\Config\NullIniSink;
use MediaWiki\Settings\SettingsBuilder;
use MediaWiki\Settings\Source\PhpSettingsSource;
use MediaWiki\Settings\Source\ReflectionSchemaSource;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../includes/Benchmarker.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script that benchmarks loading of settings files.
*
* @ingroup Benchmark
*/
class BenchmarkSettings extends Benchmarker {
public function __construct() {
parent::__construct();
$this->defaultCount = 100;
$this->addDescription( 'Benchmark loading settings files.' );
}
private function newSettingsBuilder() {
$extReg = new ExtensionRegistry();
$configBuilder = new ArrayConfigBuilder();
$phpIniSink = new NullIniSink();
return new SettingsBuilder( MW_INSTALL_PATH, $extReg, $configBuilder, $phpIniSink, null );
}
public function execute() {
$benches = [];
$schemaSource = new ReflectionSchemaSource( MainConfigSchema::class );
$schema = $schemaSource->load();
$defaults = [];
foreach ( $schema['config-schema'] as $key => $sch ) {
if ( array_key_exists( 'default', $sch ) ) {
$defaults[$key] = $sch['default'];
}
}
$benches['DefaultSettings.php'] = [
'setup' => static function () {
// do this once beforehand
include MW_INSTALL_PATH . '/includes/DefaultSettings.php';
},
'function' => static function () {
include MW_INSTALL_PATH . '/includes/DefaultSettings.php';
}
];
$benches['config-schema.php'] = [
'function' => function () {
$settingsBuilder = $this->newSettingsBuilder();
$settingsBuilder->load(
new PhpSettingsSource( MW_INSTALL_PATH . '/includes/config-schema.php' )
);
$settingsBuilder->apply();
}
];
$benches['config-schema.php + merge'] = [
'function' => function () use ( $defaults ) {
$settingsBuilder = $this->newSettingsBuilder();
// worst case: all config is set before defaults are applied
$settingsBuilder->loadArray( [ 'config' => $defaults ] );
$settingsBuilder->load(
new PhpSettingsSource( MW_INSTALL_PATH . '/includes/config-schema.php' )
);
$settingsBuilder->apply();
}
];
$benches['MainConfigSchema::class'] = [
'function' => function () {
$settingsBuilder = $this->newSettingsBuilder();
$settingsBuilder->load( new ReflectionSchemaSource( MainConfigSchema::class ) );
$settingsBuilder->apply();
}
];
$benches['DefaultSettings.php + SetupDynamicConfig.php'] = [
'function' => static function () {
$IP = MW_INSTALL_PATH;
include MW_INSTALL_PATH . '/includes/DefaultSettings.php';
// phpcs:ignore MediaWiki.VariableAnalysis.MisleadingGlobalNames.Misleading$wgLocaltimezone
$wgLocaltimezone = 'utc';
include MW_INSTALL_PATH . '/includes/SetupDynamicConfig.php';
}
];
$benches['config-schema.php + finalize'] = [
'function' => function () {
$settingsBuilder = $this->newSettingsBuilder();
$settingsBuilder->load(
new PhpSettingsSource( MW_INSTALL_PATH . '/includes/config-schema.php' )
);
$settingsBuilder->enterRegistrationStage(); // applies some dynamic defaults
// phpcs:ignore MediaWiki.Usage.ForbiddenFunctions.extract
extract( $GLOBALS );
// phpcs:ignore MediaWiki.VariableAnalysis.MisleadingGlobalNames.Misleading$wgDummyLanguageCodes
$wgDummyLanguageCodes = [];
include MW_INSTALL_PATH . '/includes/SetupDynamicConfig.php';
}
];
$this->bench( $benches );
}
}
// @codeCoverageIgnoreStart
$maintClass = BenchmarkSettings::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd