wiki.techinc.nl/tests/phpunit/structure/BundleSizeTest.php
Tim Starling 0e1cdb23e5 BundleSizeTest: use a provider
Because I want to know all modules which need to be updated after
running the test only once.

Change-Id: I9c19a72030c80a89ac1c296c5ebcba9cb489ca00
2023-05-16 00:42:48 +00:00

80 lines
2.6 KiB
PHP

<?php
namespace MediaWiki\Tests\Structure;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Request\FauxRequest;
use MediaWiki\ResourceLoader\Context;
use MediaWiki\ResourceLoader\DerivativeContext;
use MediaWiki\ResourceLoader\Module;
use MediaWikiIntegrationTestCase;
/**
* Compare bundle sizes from each skin/extension bundlesize.config.json with ResourceLoader output.
*
* Extensions and skins can subclass this and override getTestCases with just their own bundlesize
* file. This allows one to run that test suite by its own, for faster CLI feedback.
*/
abstract class BundleSizeTest extends MediaWikiIntegrationTestCase {
public function provideBundleSize() {
foreach ( json_decode( file_get_contents( $this->getBundleSizeConfig() ), true ) as $testCase ) {
yield $testCase['resourceModule'] => [ $testCase ];
}
}
/**
* @dataProvider provideBundleSize
* @coversNothing
*/
public function testBundleSize( $testCase ) {
$maxSize = $testCase['maxSize'];
$projectName = $testCase['projectName'] ?? '';
$moduleName = $testCase['resourceModule'];
if ( is_string( $maxSize ) ) {
if ( strpos( $maxSize, 'KB' ) !== false || strpos( $maxSize, 'kB' ) !== false ) {
$maxSize = (float)str_replace( [ 'KB', 'kB', ' KB', ' kB' ], '', $maxSize );
$maxSize = $maxSize * 1024;
} elseif ( strpos( $maxSize, 'B' ) !== false ) {
$maxSize = (float)str_replace( [ ' B', 'B' ], '', $maxSize );
}
}
$resourceLoader = MediaWikiServices::getInstance()->getResourceLoader();
$request = new FauxRequest(
[
'lang' => 'en',
'modules' => $moduleName,
'skin' => $this->getSkinName(),
]
);
$context = new Context( $resourceLoader, $request );
$module = $resourceLoader->getModule( $moduleName );
$contentContext = new DerivativeContext( $context );
$contentContext->setOnly(
$module->getType() === Module::LOAD_STYLES
? Module::TYPE_STYLES
: Module::TYPE_COMBINED
);
$content = $resourceLoader->makeModuleResponse( $context, [ $moduleName => $module ] );
$contentTransferSize = strlen( gzencode( $content, 9 ) );
$message = $projectName ?
"$projectName: $moduleName is less than $maxSize" :
"$moduleName is less than $maxSize";
$this->assertLessThan( $maxSize, $contentTransferSize, $message );
}
/**
* @return string Path to bundlesize.config.json
*/
abstract public function getBundleSizeConfig(): string;
/**
* @return string Skin name
*/
public function getSkinName(): string {
return MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::DefaultSkin );
}
}