MediaWiki  REL1_31
ResourceLoaderTestCase.php
Go to the documentation of this file.
1 <?php
2 
4 use Psr\Log\LoggerInterface;
5 use Psr\Log\NullLogger;
6 
7 abstract class ResourceLoaderTestCase extends MediaWikiTestCase {
8  // Version hash for a blank file module.
9  // Result of ResourceLoader::makeHash(), ResourceLoaderTestModule
10  // and ResourceLoaderFileModule::getDefinitionSummary().
11  const BLANK_VERSION = '09p30q0';
12 
23  protected function getResourceLoaderContext( $options = [], ResourceLoader $rl = null ) {
24  if ( is_string( $options ) ) {
25  // Back-compat for extension tests
26  $options = [ 'lang' => $options ];
27  }
28  $options += [
29  'lang' => 'en',
30  'dir' => 'ltr',
31  'skin' => 'vector',
32  'modules' => 'startup',
33  'only' => 'scripts',
34  ];
35  $resourceLoader = $rl ?: new ResourceLoader();
36  $request = new FauxRequest( [
37  'lang' => $options['lang'],
38  'modules' => $options['modules'],
39  'only' => $options['only'],
40  'skin' => $options['skin'],
41  'target' => 'phpunit',
42  ] );
43  $ctx = $this->getMockBuilder( ResourceLoaderContext::class )
44  ->setConstructorArgs( [ $resourceLoader, $request ] )
45  ->setMethods( [ 'getDirection' ] )
46  ->getMock();
47  $ctx->method( 'getDirection' )->willReturn( $options['dir'] );
48  return $ctx;
49  }
50 
51  public static function getSettings() {
52  return [
53  // For ResourceLoader::inDebugMode since it doesn't have context
54  'ResourceLoaderDebug' => true,
55 
56  // Avoid influence from wgInvalidateCacheOnLocalSettingsChange
57  'CacheEpoch' => '20140101000000',
58 
59  // For ResourceLoader::__construct()
60  'ResourceLoaderSources' => [],
61 
62  // For wfScript()
63  'ScriptPath' => '/w',
64  'Script' => '/w/index.php',
65  'LoadScript' => '/w/load.php',
66  ];
67  }
68 
69  protected function setUp() {
70  parent::setUp();
71 
73 
74  $globals = [];
75  foreach ( self::getSettings() as $key => $value ) {
76  $globals['wg' . $key] = $value;
77  }
78  $this->setMwGlobals( $globals );
79  }
80 }
81 
82 /* Stubs */
83 
85  protected $messages = [];
86  protected $dependencies = [];
87  protected $group = null;
88  protected $source = 'local';
89  protected $script = '';
90  protected $styles = '';
91  protected $skipFunction = null;
92  protected $isRaw = false;
93  protected $isKnownEmpty = false;
95  protected $targets = [ 'phpunit' ];
96  protected $shouldEmbed = null;
97 
98  public function __construct( $options = [] ) {
99  foreach ( $options as $key => $value ) {
100  $this->$key = $value;
101  }
102  }
103 
105  return $this->validateScriptFile( 'input', $this->script );
106  }
107 
109  return [ '' => $this->styles ];
110  }
111 
112  public function getMessages() {
113  return $this->messages;
114  }
115 
116  public function getDependencies( ResourceLoaderContext $context = null ) {
117  return $this->dependencies;
118  }
119 
120  public function getGroup() {
121  return $this->group;
122  }
123 
124  public function getSource() {
125  return $this->source;
126  }
127 
128  public function getType() {
129  return $this->type;
130  }
131 
132  public function getSkipFunction() {
133  return $this->skipFunction;
134  }
135 
136  public function isRaw() {
137  return $this->isRaw;
138  }
140  return $this->isKnownEmpty;
141  }
142 
144  return $this->shouldEmbed !== null ? $this->shouldEmbed : parent::shouldEmbedModule( $context );
145  }
146 
147  public function enableModuleContentVersion() {
148  return true;
149  }
150 }
151 
153  protected $lessVars = [];
154 
155  public function __construct( $options = [], $test = [] ) {
156  parent::__construct( $options );
157 
158  foreach ( $test as $key => $value ) {
159  $this->$key = $value;
160  }
161  }
162 
164  return $this->lessVars;
165  }
166 }
167 
169 }
170 
172  // TODO: This won't be needed once ResourceLoader is empty by default
173  // and default registrations are done from ServiceWiring instead.
174  public function __construct( Config $config = null, LoggerInterface $logger = null ) {
175  $this->setLogger( $logger ?: new NullLogger() );
176  $this->config = $config ?: MediaWikiServices::getInstance()->getMainConfig();
177  // Source "local" is required by StartupModule
178  $this->addSource( 'local', $this->config->get( 'LoadScript' ) );
179  $this->setMessageBlobStore( new MessageBlobStore( $this, $this->getLogger() ) );
180  }
181 
182  public function getErrors() {
183  return $this->errors;
184  }
185 }
ResourceLoaderTestModule\enableModuleContentVersion
enableModuleContentVersion()
Whether to generate version hash based on module content.
Definition: ResourceLoaderTestCase.php:147
ResourceLoaderModule\LOAD_GENERAL
const LOAD_GENERAL
Definition: ResourceLoaderModule.php:45
ResourceLoaderTestCase\setUp
setUp()
Definition: ResourceLoaderTestCase.php:69
ResourceLoaderContext
Object passed around to modules which contains information about the state of a specific loader reque...
Definition: ResourceLoaderContext.php:32
ResourceLoaderTestModule\$source
$source
Definition: ResourceLoaderTestCase.php:88
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
ResourceLoader\$errors
array $errors
Errors accumulated during current respond() call.
Definition: ResourceLoader.php:80
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ResourceLoaderFileTestModule
Definition: ResourceLoaderTestCase.php:152
ResourceLoaderFileTestModule\getLessVars
getLessVars(ResourceLoaderContext $context)
Get module-specific LESS variables, if any.
Definition: ResourceLoaderTestCase.php:163
ResourceLoaderTestModule\getStyles
getStyles(ResourceLoaderContext $context)
Get all CSS for this module for a given skin.
Definition: ResourceLoaderTestCase.php:108
ResourceLoader\getLogger
getLogger()
Definition: ResourceLoader.php:296
ResourceLoaderFileModuleTestModule
Definition: ResourceLoaderTestCase.php:168
ResourceLoaderTestModule\getGroup
getGroup()
Get the group this module is in.
Definition: ResourceLoaderTestCase.php:120
EmptyResourceLoader\getErrors
getErrors()
Definition: ResourceLoaderTestCase.php:182
ResourceLoaderTestCase\getSettings
static getSettings()
Definition: ResourceLoaderTestCase.php:51
$resourceLoader
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition: hooks.txt:2818
ResourceLoaderTestModule\getMessages
getMessages()
Get the messages needed for this module.
Definition: ResourceLoaderTestCase.php:112
ResourceLoaderTestModule\isRaw
isRaw()
Whether this module's JS expects to work without the client-side ResourceLoader module.
Definition: ResourceLoaderTestCase.php:136
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
ResourceLoaderFileModule
ResourceLoader module based on local JavaScript/CSS files.
Definition: ResourceLoaderFileModule.php:28
ResourceLoader\setMessageBlobStore
setMessageBlobStore(MessageBlobStore $blobStore)
Definition: ResourceLoader.php:312
Config
Interface for configuration instances.
Definition: Config.php:28
ResourceLoaderTestModule\$dependencies
$dependencies
Definition: ResourceLoaderTestCase.php:86
ResourceLoader\clearCache
static clearCache()
Reset static members used for caching.
Definition: ResourceLoader.php:1582
ResourceLoaderTestModule\shouldEmbedModule
shouldEmbedModule(ResourceLoaderContext $context)
Check whether this module should be embeded rather than linked.
Definition: ResourceLoaderTestCase.php:143
ResourceLoaderTestModule\$isKnownEmpty
$isKnownEmpty
Definition: ResourceLoaderTestCase.php:93
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:678
MediaWikiTestCase
Definition: MediaWikiTestCase.php:17
ResourceLoaderTestModule\$shouldEmbed
$shouldEmbed
Definition: ResourceLoaderTestCase.php:96
ResourceLoaderTestModule\$type
$type
Definition: ResourceLoaderTestCase.php:94
ResourceLoaderTestModule\isKnownEmpty
isKnownEmpty(ResourceLoaderContext $context)
Check whether this module is known to be empty.
Definition: ResourceLoaderTestCase.php:139
ResourceLoaderTestModule\$script
$script
Definition: ResourceLoaderTestCase.php:89
EmptyResourceLoader\__construct
__construct(Config $config=null, LoggerInterface $logger=null)
Register core modules and runs registration hooks.
Definition: ResourceLoaderTestCase.php:174
ResourceLoaderTestModule\$group
$group
Definition: ResourceLoaderTestCase.php:87
ResourceLoader\$logger
LoggerInterface $logger
Definition: ResourceLoader.php:99
ResourceLoaderTestModule\$styles
$styles
Definition: ResourceLoaderTestCase.php:90
ResourceLoaderTestModule\__construct
__construct( $options=[])
Definition: ResourceLoaderTestCase.php:98
ResourceLoaderTestModule
Definition: ResourceLoaderTestCase.php:84
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
ResourceLoaderTestModule\$messages
$messages
Definition: ResourceLoaderTestCase.php:85
$value
$value
Definition: styleTest.css.php:45
ResourceLoaderTestModule\getSource
getSource()
Get the origin of this module.
Definition: ResourceLoaderTestCase.php:124
ResourceLoaderTestModule\$isRaw
$isRaw
Definition: ResourceLoaderTestCase.php:92
ResourceLoaderModule\validateScriptFile
validateScriptFile( $fileName, $contents)
Validate a given script file; if valid returns the original source.
Definition: ResourceLoaderModule.php:979
ResourceLoaderTestModule\getScript
getScript(ResourceLoaderContext $context)
Get all JS for this module for a given language and skin.
Definition: ResourceLoaderTestCase.php:104
ResourceLoader\$config
$config
Definition: ResourceLoader.php:61
ResourceLoaderTestModule\$targets
$targets
Definition: ResourceLoaderTestCase.php:95
ResourceLoaderModule
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
Definition: ResourceLoaderModule.php:35
ResourceLoader
Dynamic JavaScript and CSS resource loading system.
Definition: ResourceLoader.php:38
EmptyResourceLoader
Definition: ResourceLoaderTestCase.php:171
ResourceLoaderFileTestModule\$lessVars
$lessVars
Definition: ResourceLoaderTestCase.php:153
ResourceLoaderTestModule\getSkipFunction
getSkipFunction()
Get the skip function.
Definition: ResourceLoaderTestCase.php:132
ResourceLoaderTestCase\getResourceLoaderContext
getResourceLoaderContext( $options=[], ResourceLoader $rl=null)
Definition: ResourceLoaderTestCase.php:23
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
MessageBlobStore
This class generates message blobs for use by ResourceLoader modules.
Definition: MessageBlobStore.php:37
ResourceLoader\addSource
addSource( $id, $loadUrl=null)
Add a foreign source of modules.
Definition: ResourceLoader.php:453
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
ResourceLoaderTestModule\getDependencies
getDependencies(ResourceLoaderContext $context=null)
Get a list of modules this module depends on.
Definition: ResourceLoaderTestCase.php:116
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
ResourceLoaderTestModule\getType
getType()
Get the module's load type.
Definition: ResourceLoaderTestCase.php:128
ResourceLoaderTestCase\BLANK_VERSION
const BLANK_VERSION
Definition: ResourceLoaderTestCase.php:11
ResourceLoaderFileTestModule\__construct
__construct( $options=[], $test=[])
Definition: ResourceLoaderTestCase.php:155
ResourceLoader\setLogger
setLogger(LoggerInterface $logger)
Definition: ResourceLoader.php:288
ResourceLoaderTestModule\$skipFunction
$skipFunction
Definition: ResourceLoaderTestCase.php:91
ResourceLoaderTestCase
Definition: ResourceLoaderTestCase.php:7