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

85 lines
2.4 KiB
PHP

<?php
/**
* Show the cached statistics.
* Give out the same output as [[Special:Statistics]]
*
* 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
* @author Antoine Musso <hashar at free dot fr>
* Based on initSiteStats.php by:
* @author Brooke Vibber
* @author Rob Church <robchur@gmail.com>
*
* @license GPL-2.0-or-later
*/
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script to show the cached statistics.
*
* @ingroup Maintenance
*/
class ShowSiteStats extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'Show the cached statistics' );
}
public function execute() {
$fields = [
'ss_total_edits' => 'Total edits',
'ss_good_articles' => 'Number of articles',
'ss_total_pages' => 'Total pages',
'ss_users' => 'Number of users',
'ss_active_users' => 'Active users',
'ss_images' => 'Number of images',
];
// Get cached stats from a replica DB
$dbr = $this->getReplicaDB();
$stats = $dbr->newSelectQueryBuilder()
->select( '*' )
->from( 'site_stats' )
->caller( __METHOD__ )->fetchRow();
// Get maximum size for each column
$max_length_value = $max_length_desc = 0;
foreach ( $fields as $field => $desc ) {
$max_length_value = max( $max_length_value, strlen( $stats->$field ) );
$max_length_desc = max( $max_length_desc, strlen( $desc ) );
}
// Show them
foreach ( $fields as $field => $desc ) {
$this->output( sprintf(
"%-{$max_length_desc}s: %{$max_length_value}d\n",
$desc,
$stats->$field
) );
}
}
}
// @codeCoverageIgnoreStart
$maintClass = ShowSiteStats::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd