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

77 lines
2.5 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 ExternalStorage
*/
use MediaWiki\Storage\SqlBlobStore;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeValue;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/moveToExternal.php';
// @codeCoverageIgnoreEnd
class FixLegacyEncoding extends MoveToExternal {
public function __construct() {
parent::__construct();
$this->addDescription( 'Change encoding of stored content from legacy encoding to UTF-8' );
}
protected function getConditions( $blockStart, $blockEnd, $dbr ) {
return [
$dbr->expr( 'old_id', '>=', $blockStart ),
$dbr->expr( 'old_id', '<=', $blockEnd ),
$dbr->expr( 'old_flags', IExpression::NOT_LIKE,
new LikeValue( $dbr->anyString(), 'utf-8', $dbr->anyString() ) ),
$dbr->expr( 'old_flags', IExpression::NOT_LIKE,
new LikeValue( $dbr->anyString(), 'utf8', $dbr->anyString() ) ),
];
}
protected function resolveText( $text, $flags ) {
if ( in_array( 'error', $flags ) ) {
return [ $text, $flags ];
}
$blobStore = $this->getServiceContainer()->getBlobStore();
if ( in_array( 'external', $flags ) && $blobStore instanceof SqlBlobStore ) {
$newText = $blobStore->expandBlob( $text, $flags );
if ( $newText === false ) {
return [ false, $flags ];
}
$text = $newText;
// It will be put back in external storage again
$flags = array_diff( $flags, [ 'external' ] );
}
if ( in_array( 'gzip', $flags ) ) {
$newText = gzinflate( $text );
if ( $newText === false ) {
return [ false, $flags ];
}
$text = $newText;
$flags = array_diff( $flags, [ 'gzip' ] );
}
return [ $text, $flags ];
}
}
// @codeCoverageIgnoreStart
$maintClass = FixLegacyEncoding::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd