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

94 lines
2.7 KiB
PHP

<?php
/**
* Check images to see if they exist, are readable, etc.
*
* 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 MediaWiki\FileRepo\File\FileSelectQueryBuilder;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script to check images to see if they exist, are readable, etc.
*
* @ingroup Maintenance
*/
class CheckImages extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'Check images to see if they exist, are readable, etc' );
$this->setBatchSize( 1000 );
}
public function execute() {
$start = '';
$dbr = $this->getReplicaDB();
$numImages = 0;
$numGood = 0;
$repo = $this->getServiceContainer()->getRepoGroup()->getLocalRepo();
do {
$queryBuilder = FileSelectQueryBuilder::newForFile( $dbr );
$res = $queryBuilder->where( $dbr->expr( 'img_name', '>', $start ) )
->limit( $this->getBatchSize() )
->caller( __METHOD__ )->fetchResultSet();
foreach ( $res as $row ) {
$numImages++;
$start = $row->img_name;
$file = $repo->newFileFromRow( $row );
$path = $file->getPath();
if ( !$path ) {
$this->output( "{$row->img_name}: not locally accessible\n" );
continue;
}
$size = $repo->getFileSize( $file->getPath() );
if ( $size === false ) {
$this->output( "{$row->img_name}: missing\n" );
continue;
}
if ( $size == 0 && $row->img_size != 0 ) {
$this->output( "{$row->img_name}: truncated, was {$row->img_size}\n" );
continue;
}
if ( $size != $row->img_size ) {
$this->output( "{$row->img_name}: size mismatch DB={$row->img_size}, "
. "actual={$size}\n" );
continue;
}
$numGood++;
}
} while ( $res->numRows() );
$this->output( "Good images: $numGood/$numImages\n" );
}
}
// @codeCoverageIgnoreStart
$maintClass = CheckImages::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd