wikimedia/mediawiki-extensions-Gadgets
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets synced 2024-12-24 04:32:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Gadgets/tests/phpunit/unit/GadgetTest.php
Siddharth VP 087ab65e24 Avoid caching serialized PHP object 
Cache array representation of the Gadget object instead of the
php-serialized representation. Gadget::toArray() is an inverse of the
constructor which already constructs an object from an array of config
values.

Also, the static Gadget::newFromDefinitionContent method which accesses
the service container is replaced with the dependency-less
serializeDefinition() method.

Bug: T303194
Change-Id: Ieae6706537143d766777b2299c31726e2a1dfd29
2023-06-22 06:01:28 +00:00

318 lines
12 KiB
PHP
Raw Blame History

<?php
use MediaWiki\Extension\Gadgets\Gadget;
use MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo;
/**
* @group Gadgets
*/
class GadgetTest extends MediaWikiUnitTestCase {
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::toArray
*/
public function testToArray() {
$g = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|rights=test]|bar.js|foo.css | foo.json' );
$gNewFromSerialized = new Gadget( $g->toArray() );
$this->assertArrayEquals( $g->toArray(), $gNewFromSerialized->toArray() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\Gadget::serializeDefinition
*/
public function testGadgetFromDefinitionContent() {
$gArray = Gadget::serializeDefinition( 'bar', [
'settings' => [
'rights' => [],
'default' => true,
'package' => true,
'hidden' => false,
'actions' => [],
'targets' => [ 'desktop' ],
'skins' => [],
'category' => 'misc',
'supportsUrlLoad' => false,
'requiresES6' => false,
],
'module' => [
'scripts' => [ 'foo.js' ],
'styles' => [ 'bar.css' ],
'datas' => [],
'dependencies' => [ 'moment' ],
'peers' => [],
'messages' => [ 'blanknamespace' ],
'type' => 'general',
]
] );
$g = new Gadget( $gArray );
$this->assertTrue( $g->isOnByDefault() );
$this->assertTrue( $g->isPackaged() );
$this->assertFalse( $g->isHidden() );
$this->assertFalse( $g->supportsUrlLoad() );
$this->assertTrue( $g->supportsResourceLoader() );
$this->assertCount( 1, $g->getTargets() );
$this->assertCount( 1, $g->getScripts() );
$this->assertCount( 1, $g->getStyles() );
$this->assertCount( 0, $g->getJSONs() );
$this->assertCount( 1, $g->getDependencies() );
$this->assertCount( 1, $g->getMessages() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
*/
public function testInvalidLines() {
$repo = new MediaWikiGadgetsDefinitionRepo();
$this->assertFalse( $repo->newFromDefinition( '', 'misc' ) );
$this->assertFalse( $repo->newFromDefinition( '<foo|bar>', 'misc' ) );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget
*/
public function testSimpleCases() {
$g = GadgetTestUtils::makeGadget( '* foo bar| foo.css|foo.js|foo.bar' );
$this->assertEquals( 'foo_bar', $g->getName() );
$this->assertEquals( 'ext.gadget.foo_bar', Gadget::getModuleName( $g->getName() ) );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.js' ], $g->getScripts() );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.css' ], $g->getStyles() );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.js', 'MediaWiki:Gadget-foo.css' ], $g->getScriptsAndStyles() );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.js' ], $g->getLegacyScripts() );
$this->assertFalse( $g->supportsResourceLoader() );
$this->assertTrue( $g->hasModule() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::supportsResourceLoader
* @covers \MediaWiki\Extension\Gadgets\Gadget::getLegacyScripts
*/
public function testRLtag() {
$g = GadgetTestUtils::makeGadget( '*foo [ResourceLoader]|foo.js|foo.css' );
$this->assertEquals( 'foo', $g->getName() );
$this->assertTrue( $g->supportsResourceLoader() );
$this->assertCount( 0, $g->getLegacyScripts() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget
*/
public function testPackaged() {
$g = GadgetTestUtils::makeGadget( '* foo bar[ResourceLoader|package]| foo.css|foo.js|foo.bar|foo.json' );
$this->assertEquals( 'foo_bar', $g->getName() );
$this->assertEquals( 'ext.gadget.foo_bar', Gadget::getModuleName( $g->getName() ) );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.js' ], $g->getScripts() );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.css' ], $g->getStyles() );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.json' ], $g->getJSONs() );
$this->assertEquals( [ 'MediaWiki:Gadget-foo.js', 'MediaWiki:Gadget-foo.css', 'MediaWiki:Gadget-foo.json' ],
$g->getScriptsAndStyles() );
$this->assertEquals( [], $g->getLegacyScripts() );
$this->assertTrue( $g->supportsResourceLoader() );
$this->assertTrue( $g->hasModule() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget
*/
public function testSupportsUrlLoad() {
$directLoadAllowedByDefault = GadgetTestUtils::makeGadget( '*foo[ResourceLoader]|foo.js' );
$directLoadAllowed1 = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|supportsUrlLoad]|bar.js' );
$directLoadAllowed2 = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|supportsUrlLoad=true]|bar.js' );
$directLoadNotAllowed = GadgetTestUtils::makeGadget( '*baz[ResourceLoader|supportsUrlLoad=false]|baz.js' );
$this->assertFalse( $directLoadAllowedByDefault->supportsUrlLoad() );
$this->assertTrue( $directLoadAllowed1->supportsUrlLoad() );
$this->assertTrue( $directLoadAllowed2->supportsUrlLoad() );
$this->assertFalse( $directLoadNotAllowed->supportsUrlLoad() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::isAllowed
*/
public function testIsAllowed() {
$user = $this->getMockBuilder( User::class )
->onlyMethods( [ 'isAllowedAll' ] )
->getMock();
$user->method( 'isAllowedAll' )
->willReturnCallback(
static function ( ...$rights ) {
return array_diff( $rights, [ 'test' ] ) === [];
}
);
/** @var User $user */
$gUnset = GadgetTestUtils::makeGadget( '*foo[ResourceLoader]|foo.js' );
$gAllowed = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|rights=test]|bar.js' );
$gNotAllowed = GadgetTestUtils::makeGadget( '*baz[ResourceLoader|rights=nope]|baz.js' );
$this->assertTrue( $gUnset->isAllowed( $user ) );
$this->assertTrue( $gAllowed->isAllowed( $user ) );
$this->assertFalse( $gNotAllowed->isAllowed( $user ) );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::isSkinSupported
*/
public function testSkinsTag() {
$gUnset = GadgetTestUtils::makeGadget( '*foo[ResourceLoader]|foo.js' );
$gSkinSupported = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|skins=fallback]|bar.js' );
$gSkinNotSupported = GadgetTestUtils::makeGadget( '*baz[ResourceLoader|skins=bar]|baz.js' );
$skin = new SkinFallback();
$this->assertTrue( $gUnset->isSkinSupported( $skin ) );
$this->assertTrue( $gSkinSupported->isSkinSupported( $skin ) );
$this->assertFalse( $gSkinNotSupported->isSkinSupported( $skin ) );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::isActionSupported
*/
public function testActionsTag() {
$gUnset = GadgetTestUtils::makeGadget( '*foo[ResourceLoader]|foo.js' );
$gActionSupported = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|actions=edit]|bar.js' );
$gActionNotSupported = GadgetTestUtils::makeGadget( '*baz[ResourceLoader|actions=history]|baz.js' );
$this->assertTrue( $gUnset->isActionSupported( 'edit' ) );
$this->assertTrue( $gActionSupported->isActionSupported( 'edit' ) );
$this->assertFalse( $gActionNotSupported->isActionSupported( 'edit' ) );
// special case
$this->assertTrue( $gActionSupported->isActionSupported( 'submit' ) );
$gMultiActions = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|actions=unknown,history]|bar.js' );
$this->assertTrue( $gMultiActions->isActionSupported( 'history' ) );
$this->assertFalse( $gMultiActions->isActionSupported( 'view' ) );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::getTargets
*/
public function testTargets() {
$g = GadgetTestUtils::makeGadget( '*foo[ResourceLoader]|foo.js' );
$g2 = GadgetTestUtils::makeGadget( '*bar[ResourceLoader|targets=desktop,mobile]|bar.js' );
$this->assertEquals( [ 'desktop', 'mobile' ], $g->getTargets() );
$this->assertEquals( [ 'desktop', 'mobile' ], $g2->getTargets() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::getDependencies
*/
public function testDependencies() {
$g = GadgetTestUtils::makeGadget( '* foo[ResourceLoader|dependencies=jquery.ui]|bar.js' );
$this->assertEquals( [ 'MediaWiki:Gadget-bar.js' ], $g->getScripts() );
$this->assertTrue( $g->supportsResourceLoader() );
$this->assertEquals( [ 'jquery.ui' ], $g->getDependencies() );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::requiresES6
*/
public function testES6() {
$es6gadget = GadgetTestUtils::makeGadget( '* foo[ResourceLoader|requiresES6]|bar.js' );
$es5gadget = GadgetTestUtils::makeGadget( '* foo[ResourceLoader]|bar.js' );
$this->assertTrue( $es6gadget->requiresES6() );
$this->assertFalse( $es5gadget->requiresES6() );
}
public static function provideGetType() {
return [
[
'Default (mixed)',
'* foo[ResourceLoader]|bar.css|bar.js',
'general',
ResourceLoaderModule::LOAD_GENERAL,
],
[
'Default (styles only)',
'* foo[ResourceLoader]|bar.css',
'styles',
ResourceLoaderModule::LOAD_STYLES,
],
[
'Default (scripts only)',
'* foo[ResourceLoader]|bar.js',
'general',
ResourceLoaderModule::LOAD_GENERAL,
],
[
'Default (styles only with dependencies)',
'* foo[ResourceLoader|dependencies=jquery.ui]|bar.css',
'general',
ResourceLoaderModule::LOAD_GENERAL,
],
[
'Styles type (mixed)',
'* foo[ResourceLoader|type=styles]|bar.css|bar.js',
'styles',
ResourceLoaderModule::LOAD_STYLES,
],
[
'Styles type (styles only)',
'* foo[ResourceLoader|type=styles]|bar.css',
'styles',
ResourceLoaderModule::LOAD_STYLES,
],
[
'Styles type (scripts only)',
'* foo[ResourceLoader|type=styles]|bar.js',
'styles',
ResourceLoaderModule::LOAD_STYLES,
],
[
'General type (mixed)',
'* foo[ResourceLoader|type=general]|bar.css|bar.js',
'general',
ResourceLoaderModule::LOAD_GENERAL,
],
[
'General type (styles only)',
'* foo[ResourceLoader|type=general]|bar.css',
'general',
ResourceLoaderModule::LOAD_GENERAL,
],
[
'General type (scripts only)',
'* foo[ResourceLoader|type=general]|bar.js',
'general',
ResourceLoaderModule::LOAD_GENERAL,
],
];
}
/**
* @dataProvider provideGetType
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::getType
* @covers \MediaWiki\Extension\Gadgets\GadgetResourceLoaderModule::getType
*/
public function testType( $message, $definition, $gType, $mType ) {
$g = GadgetTestUtils::makeGadget( $definition );
$this->assertEquals( $gType, $g->getType(), "Gadget: $message" );
$this->assertEquals( $mType, GadgetTestUtils::makeGadgetModule( $g )->getType(), "Module: $message" );
}
/**
* @covers \MediaWiki\Extension\Gadgets\MediaWikiGadgetsDefinitionRepo::newFromDefinition
* @covers \MediaWiki\Extension\Gadgets\Gadget::isHidden
*/
public function testIsHidden() {
$g = GadgetTestUtils::makeGadget( '* foo[hidden]|bar.js' );
$this->assertTrue( $g->isHidden() );
$g = GadgetTestUtils::makeGadget( '* foo[ResourceLoader|hidden]|bar.js' );
$this->assertTrue( $g->isHidden() );
$g = GadgetTestUtils::makeGadget( '* foo[ResourceLoader]|bar.js' );
$this->assertFalse( $g->isHidden() );
}
}
Reference in a new issue View git blame Copy permalink