tests/phpunit/ResourceLoaderTestCase.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\ResourceLoader;
   4
   5 use MediaWiki\Config\Config;
   6 use MediaWiki\Config\HashConfig;
   7 use MediaWiki\MainConfigNames;
   8 use MediaWiki\Request\FauxRequest;
   9 use MediaWiki\ResourceLoader\Context;
  10 use MediaWiki\ResourceLoader\FileModule;
  11 use MediaWiki\ResourceLoader\Module;
  12 use MediaWiki\ResourceLoader\ResourceLoader;
  13 use MediaWikiIntegrationTestCase;
  14 use Psr\Log\LoggerInterface;
  15
  16 abstract class ResourceLoaderTestCase extends MediaWikiIntegrationTestCase {
  17         // Version hash for a blank file module.
  18         // Result of ResourceLoader::makeHash(), ResourceLoaderTestModule
  19         // and FileModule::getDefinitionSummary().
  20         public const BLANK_VERSION = 'dukpe';
  21         // Result of ResourceLoader::makeVersionQuery() for a blank file module.
  22         // In other words, result of ResourceLoader::makeHash( BLANK_VERSION );
  23         public const BLANK_COMBI = '1xz0a';
  24
  25         /**
  26          * @param array|string $options Language code or options array
  27          * - string 'lang' Language code
  28          * - string 'dir' Language direction (ltr or rtl)
  29          * - string 'modules' Pipe-separated list of module names
  30          * - string|null 'only' "scripts" (unwrapped script), "styles" (stylesheet), or null
  31          *    (mw.loader.implement).
  32          * @param ResourceLoader|null $rl
  33          * @return Context
  34          */
  35         protected function getResourceLoaderContext( $options = [], ?ResourceLoader $rl = null ) {
  36                 if ( is_string( $options ) ) {
  37                         // Back-compat for extension tests
  38                         $options = [ 'lang' => $options ];
  39                 }
  40                 $options += [
  41                         'debug' => 'true',
  42                         'lang' => 'en',
  43                         'dir' => 'ltr',
  44                         'skin' => 'fallback',
  45                         'modules' => 'startup',
  46                         'only' => 'scripts',
  47                         'safemode' => null,
  48                         'sourcemap' => null,
  49                 ];
  50                 $resourceLoader = $rl ?: new ResourceLoader(
  51                         $this->getServiceContainer()->getMainConfig(),
  52                         null,
  53                         null,
  54                         [
  55                                 'loadScript' => '/w/load.php',
  56                         ]
  57                 );
  58                 $request = new FauxRequest( [
  59                         'debug' => $options['debug'],
  60                         'lang' => $options['lang'],
  61                         'modules' => $options['modules'],
  62                         'only' => $options['only'],
  63                         'safemode' => $options['safemode'],
  64                         'skin' => $options['skin'],
  65                         'sourcemap' => $options['sourcemap'],
  66                         'target' => 'phpunit',
  67                 ] );
  68                 $ctx = $this->getMockBuilder( Context::class )
  69                         ->setConstructorArgs( [ $resourceLoader, $request ] )
  70                         ->onlyMethods( [ 'getDirection' ] )
  71                         ->getMock();
  72                 $ctx->method( 'getDirection' )->willReturn( $options['dir'] );
  73                 return $ctx;
  74         }
  75
  76         public static function getSettings() {
  77                 return [
  78                         // For ResourceLoader::respond
  79                         MainConfigNames::ResourceLoaderEnableSourceMapLinks => false,
  80
  81                         // For Module
  82                         MainConfigNames::ResourceLoaderValidateJS => false,
  83
  84                         // For SkinModule
  85                         MainConfigNames::Logos => false,
  86                         MainConfigNames::Logo => '/logo.png',
  87                         MainConfigNames::ResourceBasePath => '/w',
  88                         MainConfigNames::ParserEnableLegacyMediaDOM => true,
  89
  90                         // For ResourceLoader::getSiteConfigSettings and StartUpModule
  91                         MainConfigNames::Server => 'https://example.org',
  92                         MainConfigNames::ScriptPath => '/w',
  93                         MainConfigNames::Script => '/w/index.php',
  94                         MainConfigNames::ResourceLoaderEnableJSProfiler => false,
  95
  96                         // For CodexModule
  97                         MainConfigNames::CodexDevelopmentDir => null,
  98                 ];
  99         }
 100
 101         public static function getMinimalConfig() {
 102                 return new HashConfig( self::getSettings() );
 103         }
 104
 105         /**
 106          * The annotation causes this to be called immediately before setUp()
 107          * @before
 108          */
 109         final protected function mediaWikiResourceLoaderSetUp(): void {
 110                 ResourceLoader::clearCache();
 111
 112                 $this->overrideConfigValues( self::getSettings() );
 113         }
 114 }
 115
 116 /* Stubs */
 117
 118 class ResourceLoaderTestModule extends Module {
 119         /** @var string[] */
 120         protected $messages = [];
 121         /** @var string[] */
 122         protected $dependencies = [];
 123         /** @var string|null */
 124         protected $group = null;
 125         /** @var string */
 126         protected $source = 'local';
 127         /** @var string */
 128         protected $script = '';
 129         /** @var string */
 130         protected $styles = '';
 131         /** @var string|null */
 132         protected $skipFunction = null;
 133         /** @var bool */
 134         protected $isRaw = false;
 135         /** @var bool */
 136         protected $isKnownEmpty = false;
 137         /** @var string */
 138         protected $type = Module::LOAD_GENERAL;
 139         /** @var bool|null */
 140         protected $shouldEmbed = null;
 141         /** @var bool */
 142         protected $mayValidateScript = false;
 143
 144         public function __construct( $options = [] ) {
 145                 foreach ( $options as $key => $value ) {
 146                         if ( $key === 'class' || $key === 'factory' ) {
 147                                 continue;
 148                         }
 149                         $this->$key = $value;
 150                 }
 151         }
 152
 153         public function getScript( Context $context ) {
 154                 if ( $this->mayValidateScript ) {
 155                         // This enables the validation check that replaces invalid
 156                         // scripts with a warning message.
 157                         // Based on $wgResourceLoaderValidateJS
 158                         return $this->validateScriptFile( 'input', $this->script );
 159                 } else {
 160                         return $this->script;
 161                 }
 162         }
 163
 164         public function getStyles( Context $context ) {
 165                 return [ '' => $this->styles ];
 166         }
 167
 168         public function getMessages() {
 169                 return $this->messages;
 170         }
 171
 172         public function getDependencies( ?Context $context = null ) {
 173                 return $this->dependencies;
 174         }
 175
 176         public function getGroup() {
 177                 return $this->group;
 178         }
 179
 180         public function getSource() {
 181                 return $this->source;
 182         }
 183
 184         public function getType() {
 185                 return $this->type;
 186         }
 187
 188         public function getSkipFunction() {
 189                 return $this->skipFunction;
 190         }
 191
 192         public function requiresES6() {
 193                 return true;
 194         }
 195
 196         public function isRaw() {
 197                 return $this->isRaw;
 198         }
 199
 200         public function isKnownEmpty( Context $context ) {
 201                 return $this->isKnownEmpty;
 202         }
 203
 204         public function shouldEmbedModule( Context $context ) {
 205                 return $this->shouldEmbed ?? parent::shouldEmbedModule( $context );
 206         }
 207
 208         public function enableModuleContentVersion() {
 209                 return true;
 210         }
 211 }
 212
 213 /**
 214  * A more constrained and testable variant of FileModule.
 215  *
 216  * - Implements getLessVars() support.
 217  * - Disables database persistance of discovered file dependencies.
 218  */
 219 class ResourceLoaderFileTestModule extends FileModule {
 220         /** @var array */
 221         protected $lessVars = [];
 222
 223         public function __construct( $options = [] ) {
 224                 if ( isset( $options['lessVars'] ) ) {
 225                         $this->lessVars = $options['lessVars'];
 226                         unset( $options['lessVars'] );
 227                 }
 228
 229                 parent::__construct( $options );
 230         }
 231
 232         public function getLessVars( Context $context ) {
 233                 return $this->lessVars;
 234         }
 235
 236 }
 237
 238 class ResourceLoaderFileModuleTestingSubclass extends FileModule {
 239 }
 240
 241 class EmptyResourceLoader extends ResourceLoader {
 242         public function __construct( ?Config $config = null, ?LoggerInterface $logger = null ) {
 243                 parent::__construct( $config ?: ResourceLoaderTestCase::getMinimalConfig(), $logger );
 244         }
 245 }
 246
 247 /** @deprecated class alias since 1.42 */
 248 class_alias( ResourceLoaderTestModule::class, 'ResourceLoaderTestModule' );
 249
 250 /** @deprecated class alias since 1.42 */
 251 class_alias( ResourceLoaderTestCase::class, 'ResourceLoaderTestCase' );
 252
 253 /** @deprecated class alias since 1.42 */
 254 class_alias( ResourceLoaderFileTestModule::class, 'ResourceLoaderFileTestModule' );
 255
 256 /** @deprecated class alias since 1.42 */
 257 class_alias( ResourceLoaderFileModuleTestingSubclass::class, 'ResourceLoaderFileModuleTestingSubclass' );
 258
 259 /** @deprecated class alias since 1.42 */
 260 class_alias( EmptyResourceLoader::class, 'EmptyResourceLoader' );