wiki.techinc.nl/maintenance/purgeModuleDeps.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

76 lines
2.4 KiB
PHP

<?php
/**
* 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 Maintenance
*/
use Wikimedia\Rdbms\IDatabase;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script to purge the module_deps database cache table for ResourceLoader.
*
* @ingroup Maintenance
*/
class PurgeModuleDeps extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription(
'Remove all cache entries for ResourceLoader modules from the database' );
$this->setBatchSize( 500 );
}
public function execute() {
$this->output( "Cleaning up module_deps table...\n" );
$dbw = $this->getPrimaryDB();
$res = $dbw->newSelectQueryBuilder()
->select( [ 'md_module', 'md_skin' ] )
->from( 'module_deps' )
->caller( __METHOD__ )->fetchResultSet();
$rows = iterator_to_array( $res, false );
$modDeps = $dbw->tableName( 'module_deps' );
$i = 1;
foreach ( array_chunk( $rows, $this->getBatchSize() ) as $chunk ) {
// WHERE ( mod=A AND skin=A ) OR ( mod=A AND skin=B) ..
$conds = array_map( static function ( stdClass $row ) use ( $dbw ) {
return $dbw->makeList( (array)$row, IDatabase::LIST_AND );
}, $chunk );
$conds = $dbw->makeList( $conds, IDatabase::LIST_OR );
$this->beginTransaction( $dbw, __METHOD__ );
$dbw->query( "DELETE FROM $modDeps WHERE $conds", __METHOD__ );
$numRows = $dbw->affectedRows();
$this->output( "Batch $i: $numRows rows\n" );
$this->commitTransaction( $dbw, __METHOD__ );
$i++;
}
$this->output( "Done\n" );
}
}
// @codeCoverageIgnoreStart
$maintClass = PurgeModuleDeps::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd