Page MenuHomeWickedGov Phorge
Files F1430212

ComposerLaunchParallel.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

ComposerLaunchParallel.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\Composer;
use Composer\Script\Event;
use MediaWiki\Composer\PhpUnitSplitter\PhpUnitXml;
use MediaWiki\Maintenance\ForkController;
use Shellbox\Shellbox;
$basePath = getenv( 'MW_INSTALL_PATH' ) !== false ? getenv( 'MW_INSTALL_PATH' ) : __DIR__ . '/../..';
require_once $basePath . '/includes/BootstrapHelperFunctions.php';
require_once $basePath . '/maintenance/includes/ForkController.php';
/**
* Launch PHPUnit test suites in parallel.
*
* This class is run directly from composer.json,
* outside of any MediaWiki context;
* consequently, most MediaWiki code cannot be used here.
* We extend ForkController because it's convenient to do so and ForkController still works here,
* but we cannot use e.g. Shell::command() to run the composer sub-commands,
* nor anything else that requires MediaWiki services or config.
* (But we can use the underlying Shellbox library directly.)
*
* @license GPL-2.0-or-later
*/
class ComposerLaunchParallel extends ForkController {
private const ALWAYS_EXCLUDE = [ 'Broken', 'ParserFuzz', 'Stub' ];
private array $groups = [];
private array $excludeGroups = [];
public function __construct(
array $groups,
array $excludeGroups
) {
$this->groups = $groups;
$this->excludeGroups = $excludeGroups;
/**
* By default, the splitting process splits the tests into 8 groups. 7 of the groups are composed
* of evenly distributed test classes extracted from the `--list-tests-xml` phpunit function. The
* 8th group contains just the ExtensionsParserTestSuite.
*/
$splitGroupCount = 7;
if ( $this->isDatabaseRun() ) {
/**
* In the splitting, we put ExtensionsParserTestSuite in `split_group_7` on its own. We only
* need to run `split_group_7` when we run Database tests, since all Parser tests use the
* database. Running `split_group_7` when no matches tests get executed results in a phpunit
* error code.
*/
$splitGroupCount = 8;
}
parent::__construct( $splitGroupCount );
}
private function isDatabaseRun(): bool {
return in_array( 'Database', $this->groups ) &&
!in_array( 'Database', $this->excludeGroups );
}
/**
* @inheritDoc
*/
public function start(): string {
$status = parent::start();
if ( $status === 'child' ) {
$this->runTestSuite( $this->getChildNumber() );
}
return $status;
}
protected function prepareEnvironment() {
// Skip parent class method to avoid errors:
// this script does not run inside MediaWiki, so there is no environment to prepare
}
private function runTestSuite( int $groupId ) {
$executor = Shellbox::createUnboxedExecutor();
$command = $executor->createCommand()
->params(
'composer', 'run',
'--timeout=0',
'phpunit:entrypoint',
'--',
'--testsuite', "split_group_$groupId",
'--exclude-group', implode( ",", array_diff( $this->excludeGroups, $this->groups ) )
);
if ( count( $this->groups ) ) {
$command->params( '--group', implode( ',', $this->groups ) );
}
$groupName = $this->isDatabaseRun() ? "database" : "databaseless";
$command->params(
"--cache-result-file=.phpunit_group_{$groupId}_{$groupName}.result.cache"
);
$command->includeStderr( true );
$command->environment( [ 'MW_PHPUNIT_SPLIT_GROUP_ID' => $groupId ] );
print( "Running command '" . $command->getCommandString() . "' ..." . PHP_EOL );
$result = $command->execute();
print( $result->getStdout() );
exit( $result->getExitCode() );
}
private static function extractArgs(): array {
$options = [];
foreach ( [ "group", "exclude-group" ] as $argument ) {
$groupIndex = array_search( "--" . $argument, $_SERVER['argv'] );
if ( $groupIndex > 0 ) {
if ( count( $_SERVER['argv'] ) > $groupIndex + 1 ) {
$nextArg = $_SERVER['argv'][$groupIndex + 1];
if ( strpos( $nextArg, "--" ) === 0 ) {
throw new \InvalidArgumentException(
"parameter " . $argument . " takes a variable - none supplied"
);
}
$options[$argument] = $nextArg;
} else {
throw new \InvalidArgumentException(
"parameter " . $argument . " takes a variable - not enough arguments supplied"
);
}
}
}
return $options;
}
public static function launchTests( Event $event, array $groups, array $excludeGroups ): void {
$phpUnitConfig = getcwd() . DIRECTORY_SEPARATOR . 'phpunit.xml';
if ( !PhpUnitXml::isPhpUnitXmlPrepared( $phpUnitConfig ) ) {
$event->getIO()->error( "phpunit.xml is not present or does not contain split test suites" );
$event->getIO()->error( "run `composer phpunit:prepare-parallel:...` to generate the split suites" );
exit( 1 );
}
$event->getIO()->info( "Running 'split_group_X' suites in parallel..." );
$launcher = new ComposerLaunchParallel( $groups, $excludeGroups );
$launcher->start();
if ( $launcher->allSuccessful() ) {
$event->getIO()->info( "All split_groups succeeded!" );
exit( 0 );
} else {
$event->getIO()->warning( "Some split_groups failed - returning failure status" );
exit( 1 );
}
}
public static function launchTestsCustomGroups( Event $event ) {
$options = self::extractArgs();
if ( array_key_exists( 'exclude-group', $options ) ) {
$excludeGroups = explode( ',', $options['exclude-group'] );
} else {
$excludeGroups = [ 'Broken', 'ParserFuzz', 'Stub', 'Standalone', 'Database' ];
}
if ( array_key_exists( 'group', $options ) ) {
$groups = explode( ',', $options['group'] );
} else {
$groups = [];
}
self::launchTests( $event, $groups, $excludeGroups );
}
public static function launchTestsDatabase( Event $event ) {
self::launchTests(
$event,
[ 'Database' ],
array_merge( self::ALWAYS_EXCLUDE, [ 'Standalone' ] )
);
}
public static function launchTestsDatabaseless( Event $event ) {
self::launchTests(
$event,
[],
array_merge( self::ALWAYS_EXCLUDE, [ 'Standalone', 'Database' ] )
);
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 18:31 (4 h, 50 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
38/7e/bfd9a94e3d5286e05633b9583d0a
Default Alt Text
ComposerLaunchParallel.php (5 KB)

Event Timeline