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
58 lines
1.3 KiB
PHP
58 lines
1.3 KiB
PHP
<?php
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
use MediaWiki\Site\SiteImporter;
|
|
|
|
/**
|
|
* Maintenance script for importing site definitions from XML into the sites table.
|
|
*
|
|
* @since 1.25
|
|
*
|
|
* @license GPL-2.0-or-later
|
|
* @author Daniel Kinzler
|
|
*/
|
|
class ImportSites extends Maintenance {
|
|
|
|
public function __construct() {
|
|
parent::__construct();
|
|
|
|
$this->addDescription( 'Imports site definitions from XML into the sites table.' );
|
|
|
|
$this->addArg( 'file', 'An XML file containing site definitions (see docs/sitelist.md). ' .
|
|
'Use "php://stdin" to read from stdin.', true
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Do the import.
|
|
*/
|
|
public function execute() {
|
|
$file = $this->getArg( 0 );
|
|
|
|
$siteStore = $this->getServiceContainer()->getSiteStore();
|
|
$importer = new SiteImporter( $siteStore );
|
|
$importer->setExceptionCallback( [ $this, 'reportException' ] );
|
|
|
|
$importer->importFromFile( $file );
|
|
|
|
$this->output( "Done.\n" );
|
|
}
|
|
|
|
/**
|
|
* Outputs a message via the output() method.
|
|
*
|
|
* @param Exception $ex
|
|
*/
|
|
public function reportException( Exception $ex ) {
|
|
$msg = $ex->getMessage();
|
|
$this->output( "$msg\n" );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = ImportSites::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|