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

88 lines
2 KiB
PHP

<?php
/**
* Initialize a user preference based on the value
* of another preference.
*
* @ingroup Maintenance
*/
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script that initializes a user preference
* based on the value of another preference.
*
* @ingroup Maintenance
*/
class InitUserPreference extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption(
'target',
'Name of the user preference to initialize',
true,
true,
't'
);
$this->addOption(
'source',
'Name of the user preference to take the value from',
true,
true,
's'
);
$this->setBatchSize( 300 );
}
public function execute() {
$target = $this->getOption( 'target' );
$source = $this->getOption( 'source' );
$this->output( "Initializing '$target' based on the value of '$source'\n" );
$dbr = $this->getReplicaDB();
$dbw = $this->getPrimaryDB();
$iterator = new BatchRowIterator(
$dbr,
'user_properties',
[ 'up_user', 'up_property' ],
$this->getBatchSize()
);
$iterator->setFetchColumns( [ 'up_user', 'up_value' ] );
$iterator->addConditions( [
'up_property' => $source,
$dbr->expr( 'up_value', '!=', null ),
$dbr->expr( 'up_value', '!=', 0 ),
] );
$iterator->setCaller( __METHOD__ );
$processed = 0;
foreach ( $iterator as $batch ) {
foreach ( $batch as $row ) {
$dbw->newInsertQueryBuilder()
->insertInto( 'user_properties' )
->row( [
'up_user' => $row->up_user,
'up_property' => $target,
'up_value' => $row->up_value,
] )
->onDuplicateKeyUpdate()
->uniqueIndexFields( [ 'up_user', 'up_property' ] )
->set( [ 'up_value' => $row->up_value ] )
->caller( __METHOD__ )->execute();
$processed += $dbw->affectedRows();
}
}
$this->output( "Processed $processed user(s)\n" );
$this->output( "Finished!\n" );
}
}
// @codeCoverageIgnoreStart
$maintClass = InitUserPreference::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd