Page MenuHomeWickedGov Phorge
Files F2750877

checkComposerLockUpToDate.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

checkComposerLockUpToDate.php
View Options

<?php
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
use MediaWiki\Composer\LockFileChecker;
use MediaWiki\Maintenance\Maintenance;
use Wikimedia\Composer\ComposerJson;
use Wikimedia\Composer\ComposerLock;
/**
* Checks whether your composer-installed dependencies are up to date
*
* Composer creates a "composer.lock" file which specifies which versions are installed
* (via `composer install`). It has a hash, which can be compared to the value of
* the composer.json file to see if dependencies are up to date.
*/
class CheckComposerLockUpToDate extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription(
'Checks whether your composer.lock file is up to date with the current composer.json' );
}
public function canExecuteWithoutLocalSettings(): bool {
return true;
}
/**
* @return string The value of the constant MW_INSTALL_PATH. This method mocked in phpunit tests.
*/
protected function getMwInstallPath(): string {
return MW_INSTALL_PATH;
}
public function execute() {
$installPath = $this->getMwInstallPath();
$lockLocation = "$installPath/composer.lock";
$jsonLocation = "$installPath/composer.json";
if ( !file_exists( $lockLocation ) ) {
// Maybe they're using mediawiki/vendor?
$lockLocation = "$installPath/vendor/composer.lock";
if ( !file_exists( $lockLocation ) ) {
$this->fatalError(
'Could not find composer.lock file. Have you run "composer install --no-dev"?'
);
}
}
$lock = new ComposerLock( $lockLocation );
$json = new ComposerJson( $jsonLocation );
// Check all the dependencies to see if any are old
$checker = new LockFileChecker( $json, $lock );
$errors = $checker->check();
// NOTE: This is used by TestSetup before MediaWikiServices is initialized and thus
// may not rely on global singletons.
// NOTE: This is used by maintenance/update.php and thus may not rely on
// database connections, including e.g. interface messages without useDatabase=false,
// which would call MessageCache.
if ( $errors ) {
foreach ( $errors as $error ) {
$this->error( $error . "\n" );
}
$suggestedCommand = 'composer update';
if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
$suggestedCommand .= ' --no-dev';
}
$this->fatalError(
'Error: your composer.lock file is not up to date. ' .
'Run "' . $suggestedCommand . '" to install newer dependencies'
);
} else {
// We couldn't find any out-of-date dependencies, so assume everything is ok!
$this->output( "Your composer.lock file is up to date with current dependencies!\n" );
}
}
}
// @codeCoverageIgnoreStart
$maintClass = CheckComposerLockUpToDate::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 17:19 (16 h, 36 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
9a/13/7771a71176000ecd3532e1dd6508
Default Alt Text
checkComposerLockUpToDate.php (2 KB)

Event Timeline