wikimedia/mediawiki-extensions-Gadgets
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets synced 2024-11-30 18:14:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

tests: Improve validateScriptFile coverage and tolerate valid ES6

Browse source 
Remove the test that expects ES6 to fail by default, instead assert
that invalid syntax fails (as it should). Also add various other
test cases, including a commented-out test for valid ES6 by default,
to be enabled after Ie309e761f8b20640f7c0 in MediaWiki core.

Change-Id: If45856c563518255189687e3b1f620973349fb27
This commit is contained in:
Timo Tijhof 2024-01-05 21:48:58 +00:00
parent 5113f84909
commit 3e871f2015
2 changed files with 32 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
includes/GadgetResourceLoaderModule.php
View file

@ -101,7 +101,7 @@ class GadgetResourceLoaderModule extends RL\WikiModule {
* @return bool
*/
public function isPackaged(): bool {
return $this->gadget->isPackaged();
return $this->getGadget()->isPackaged();
}
/**

55
tests/phpunit/integration/GadgetResourceLoaderModuleTest.php
View file

@ -15,19 +15,16 @@ use Wikimedia\TestingAccessWrapper;
class GadgetResourceLoaderModuleTest extends MediaWikiIntegrationTestCase {
use GadgetTestTrait;
/**
* @var Gadget
*/
/** @var Gadget */
private $gadget;
/**
* @var TestingAccessWrapper
*/
/** @var TestingAccessWrapper */
private $gadgetModule;
protected function setUp(): void {
parent::setUp();
$this->gadget = $this->makeGadget( '*foo [ResourceLoader|package]|foo.js|foo.css|foo.json' );
$this->gadgetModule = $this->makeGadgetModule( $this->gadget );
$this->overrideConfigValue( MainConfigNames::ResourceLoaderValidateJS, true );
}
/**
@ -51,25 +48,35 @@ class GadgetResourceLoaderModuleTest extends MediaWikiIntegrationTestCase {
$nonPackageGadgetModule->getPages( $context ) );
}
public function testEs6Gadget() {
$this->editPage( 'MediaWiki:Gadget-foo.js', '(() => {})();' );
$repo = new StaticGadgetRepo( [
'g1' => $this->makeGadget( '*g1 [ResourceLoader]|foo.js' ),
'g2' => $this->makeGadget( '*g1 [ResourceLoader|requiresES6]|foo.js' )
] );
$this->setService( 'GadgetsRepo', $repo );
$this->overrideConfigValue( MainConfigNames::ResourceLoaderValidateJS, true );
$rlContext = RL\Context::newDummyContext();
public static function provideValidateScript() {
yield 'valid ES5' => [ true, '[ResourceLoader]', 'var quux = function() {};' ];
// TODO: T75714
// yield 'valid ES6' => [ true, '[ResourceLoader]', 'let quux = (() => {})();' ];
yield 'invalid' => [ false, '[ResourceLoader]', 'boom quux = <3;' ];
$m1 = new GadgetResourceLoaderModule( [ 'id' => 'g1' ] );
$this->assertFalse( $m1->requiresES6() );
$m1->setConfig( $this->getServiceContainer()->getMainConfig() );
$this->assertStringContainsString( 'mw.log.error', $m1->getScript( $rlContext ) );
$m2 = new GadgetResourceLoaderModule( [ 'id' => 'g2' ] );
$this->assertTrue( $m2->requiresES6() );
$m2->setConfig( $this->getServiceContainer()->getMainConfig() );
$this->assertStringNotContainsString( 'mw.log.error', $m2->getScript( $rlContext ) );
yield 'requiresES6 allows ES5' => [ true, '[ResourceLoader|requiresES6]', 'var quux = function() {};' ];
yield 'requiresES6 allows ES6' => [ true, '[ResourceLoader|requiresES6]', 'let quux = (() => {})();' ];
yield 'requiresES6 allows invalid' => [ true, '[ResourceLoader|requiresES6]', 'boom quux = <3;' ];
}
/**
* @dataProvider provideValidateScript
*/
public function testValidateScriptFile( $valid, $options, $content ) {
$this->editPage( 'MediaWiki:Gadget-foo.js', $content );
$repo = new StaticGadgetRepo( [
'example' => $this->makeGadget( "* example $options | foo.js" ),
] );
$this->setService( 'GadgetsRepo', $repo );
$rlContext = RL\Context::newDummyContext();
$module = new GadgetResourceLoaderModule( [ 'id' => 'example' ] );
$module->setConfig( $this->getServiceContainer()->getMainConfig() );
$actual = $module->getScript( $rlContext );
$expect = $valid ? 'quux' : 'mw.log.error';
$expectNot = $valid ? 'mw.log.error' : 'quux';
$this->assertStringContainsString( $expect, $actual );
$this->assertStringNotContainsString( $expectNot, $actual );
}
}