3 * Sanity checks for making sure registered resources are sane.
6 * @author Antoine Musso
7 * @author Niklas Laxström
8 * @author Santhosh Thottingal
10 * @copyright © 2012, Antoine Musso
11 * @copyright © 2012, Niklas Laxström
12 * @copyright © 2012, Santhosh Thottingal
13 * @copyright © 2012, Timo Tijhof
16 class ResourcesTest
extends MediaWikiTestCase
{
19 * @dataProvider provideResourceFiles
21 public function testFileExistence( $filename, $module, $resource ) {
22 $this->assertFileExists( $filename,
23 "File '$resource' referenced by '$module' must exist."
28 * @dataProvider provideMediaStylesheets
30 public function testStyleMedia( $moduleName, $media, $filename, $css ) {
31 $cssText = CSSMin
::minify( $css->cssText
);
34 strpos( $cssText, '@media' ) === false,
35 'Stylesheets should not both specify "media" and contain @media'
39 public function testVersionHash() {
40 $data = self
::getAllModules();
41 foreach ( $data['modules'] as $moduleName => $module ) {
42 $version = $module->getVersionHash( $data['context'] );
43 $this->assertEquals( 7, strlen( $version ), "$moduleName must use ResourceLoader::makeHash" );
48 * Verify that nothing explicitly depends on the 'jquery' and 'mediawiki' modules.
49 * They are always loaded, depending on them is unsupported and leads to unexpected behaviour.
50 * TODO Modules can dynamically choose dependencies based on context. This method does not
51 * test such dependencies. The same goes for testMissingDependencies() and
52 * testUnsatisfiableDependencies().
54 public function testIllegalDependencies() {
55 $data = self
::getAllModules();
56 $illegalDeps = [ 'jquery', 'mediawiki' ];
58 /** @var ResourceLoaderModule $module */
59 foreach ( $data['modules'] as $moduleName => $module ) {
60 foreach ( $illegalDeps as $illegalDep ) {
61 $this->assertNotContains(
63 $module->getDependencies( $data['context'] ),
64 "Module '$moduleName' must not depend on '$illegalDep'"
71 * Verify that all modules specified as dependencies of other modules actually exist.
73 public function testMissingDependencies() {
74 $data = self
::getAllModules();
75 $validDeps = array_keys( $data['modules'] );
77 /** @var ResourceLoaderModule $module */
78 foreach ( $data['modules'] as $moduleName => $module ) {
79 foreach ( $module->getDependencies( $data['context'] ) as $dep ) {
80 $this->assertContains(
83 "The module '$dep' required by '$moduleName' must exist"
90 * Verify that all specified messages actually exist.
92 public function testMissingMessages() {
93 $data = self
::getAllModules();
94 $validDeps = array_keys( $data['modules'] );
95 $lang = Language
::factory( 'en' );
97 /** @var ResourceLoaderModule $module */
98 foreach ( $data['modules'] as $moduleName => $module ) {
99 foreach ( $module->getMessages() as $msgKey ) {
101 wfMessage( $msgKey )->useDatabase( false )->inLanguage( $lang )->exists(),
102 "Message '$msgKey' required by '$moduleName' must exist"
109 * Verify that all dependencies of all modules are always satisfiable with the 'targets' defined
110 * for the involved modules.
112 * Example: A depends on B. A has targets: mobile, desktop. B has targets: desktop. Therefore the
113 * dependency is sometimes unsatisfiable: it's impossible to load module A on mobile.
115 public function testUnsatisfiableDependencies() {
116 $data = self
::getAllModules();
117 $validDeps = array_keys( $data['modules'] );
119 /** @var ResourceLoaderModule $module */
120 foreach ( $data['modules'] as $moduleName => $module ) {
121 $moduleTargets = $module->getTargets();
122 foreach ( $module->getDependencies( $data['context'] ) as $dep ) {
123 if ( !isset( $data['modules'][$dep] ) ) {
124 // Missing dependencies reported by testMissingDependencies
127 $targets = $data['modules'][$dep]->getTargets();
128 foreach ( $moduleTargets as $moduleTarget ) {
129 $this->assertContains(
132 "The module '$moduleName' must not have target '$moduleTarget' "
133 . "because its dependency '$dep' does not have it"
141 * CSSMin::getLocalFileReferences should ignore url(...) expressions
142 * that have been commented out.
144 public function testCommentedLocalFileReferences() {
145 $basepath = __DIR__
. '/../data/css/';
146 $css = file_get_contents( $basepath . 'comments.css' );
147 $files = CSSMin
::getLocalFileReferences( $css, $basepath );
148 $expected = [ $basepath . 'not-commented.gif' ];
149 $this->assertArrayEquals(
152 'Url(...) expression in comment should be omitted.'
157 * Get all registered modules from ResouceLoader.
160 protected static function getAllModules() {
161 global $wgEnableJavaScriptTest;
163 // Test existance of test suite files as well
164 // (can't use setUp or setMwGlobals because providers are static)
165 $org_wgEnableJavaScriptTest = $wgEnableJavaScriptTest;
166 $wgEnableJavaScriptTest = true;
168 // Initialize ResourceLoader
169 $rl = new ResourceLoader();
173 foreach ( $rl->getModuleNames() as $moduleName ) {
174 $modules[$moduleName] = $rl->getModule( $moduleName );
178 $wgEnableJavaScriptTest = $org_wgEnableJavaScriptTest;
181 'modules' => $modules,
182 'resourceloader' => $rl,
183 'context' => new ResourceLoaderContext( $rl, new FauxRequest() )
188 * Get all stylesheet files from modules that are an instance of
189 * ResourceLoaderFileModule (or one of its subclasses).
191 public static function provideMediaStylesheets() {
192 $data = self
::getAllModules();
195 foreach ( $data['modules'] as $moduleName => $module ) {
196 if ( !$module instanceof ResourceLoaderFileModule
) {
200 $reflectedModule = new ReflectionObject( $module );
202 $getStyleFiles = $reflectedModule->getMethod( 'getStyleFiles' );
203 $getStyleFiles->setAccessible( true );
205 $readStyleFile = $reflectedModule->getMethod( 'readStyleFile' );
206 $readStyleFile->setAccessible( true );
208 $styleFiles = $getStyleFiles->invoke( $module, $data['context'] );
210 $flip = $module->getFlip( $data['context'] );
212 foreach ( $styleFiles as $media => $files ) {
213 if ( $media && $media !== 'all' ) {
214 foreach ( $files as $file ) {
219 // XXX: Wrapped in an object to keep it out of PHPUnit output
221 'cssText' => $readStyleFile->invoke(
238 * Get all resource files from modules that are an instance of
239 * ResourceLoaderFileModule (or one of its subclasses).
241 * Since the raw data is stored in protected properties, we have to
242 * overrride this through ReflectionObject methods.
244 public static function provideResourceFiles() {
245 $data = self
::getAllModules();
248 // See also ResourceLoaderFileModule::__construct
250 // Lists of file paths
257 // Collated lists of file paths
265 foreach ( $data['modules'] as $moduleName => $module ) {
266 if ( !$module instanceof ResourceLoaderFileModule
) {
270 $reflectedModule = new ReflectionObject( $module );
274 foreach ( $filePathProps['lists'] as $propName ) {
275 $property = $reflectedModule->getProperty( $propName );
276 $property->setAccessible( true );
277 $list = $property->getValue( $module );
278 foreach ( $list as $key => $value ) {
279 // 'scripts' are numeral arrays.
280 // 'styles' can be numeral or associative.
281 // In case of associative the key is the file path
282 // and the value is the 'media' attribute.
283 if ( is_int( $key ) ) {
291 foreach ( $filePathProps['nested-lists'] as $propName ) {
292 $property = $reflectedModule->getProperty( $propName );
293 $property->setAccessible( true );
294 $lists = $property->getValue( $module );
295 foreach ( $lists as $list ) {
296 foreach ( $list as $key => $value ) {
297 // We need the same filter as for 'lists',
298 // due to 'skinStyles'.
299 if ( is_int( $key ) ) {
308 // Get method for resolving the paths to full paths
309 $method = $reflectedModule->getMethod( 'getLocalPath' );
310 $method->setAccessible( true );
313 foreach ( $files as $file ) {
315 $method->invoke( $module, $file ),
317 ( $file instanceof ResourceLoaderFilePath ?
$file->getPath() : $file ),
321 // To populate missingLocalFileRefs. Not sure how sane this is inside this test...
322 $module->readStyleFiles(
323 $module->getStyleFiles( $data['context'] ),
324 $module->getFlip( $data['context'] ),
328 $property = $reflectedModule->getProperty( 'missingLocalFileRefs' );
329 $property->setAccessible( true );
330 $missingLocalFileRefs = $property->getValue( $module );
332 foreach ( $missingLocalFileRefs as $file ) {