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( 8, 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.
51 public function testIllegalDependencies() {
52 $data = self
::getAllModules();
53 $illegalDeps = array( 'jquery', 'mediawiki' );
55 /** @var ResourceLoaderModule $module */
56 foreach ( $data['modules'] as $moduleName => $module ) {
57 foreach ( $illegalDeps as $illegalDep ) {
58 $this->assertNotContains(
60 $module->getDependencies(),
61 "Module '$moduleName' must not depend on '$illegalDep'"
68 * Verify that all modules specified as dependencies of other modules actually exist.
70 public function testMissingDependencies() {
71 $data = self
::getAllModules();
72 $validDeps = array_keys( $data['modules'] );
74 /** @var ResourceLoaderModule $module */
75 foreach ( $data['modules'] as $moduleName => $module ) {
76 foreach ( $module->getDependencies() as $dep ) {
77 $this->assertContains(
80 "The module '$dep' required by '$moduleName' must exist"
87 * Verify that all dependencies of all modules are always satisfiable with the 'targets' defined
88 * for the involved modules.
90 * Example: A depends on B. A has targets: mobile, desktop. B has targets: desktop. Therefore the
91 * dependency is sometimes unsatisfiable: it's impossible to load module A on mobile.
93 public function testUnsatisfiableDependencies() {
94 $data = self
::getAllModules();
95 $validDeps = array_keys( $data['modules'] );
97 /** @var ResourceLoaderModule $module */
98 foreach ( $data['modules'] as $moduleName => $module ) {
99 $moduleTargets = $module->getTargets();
100 foreach ( $module->getDependencies() as $dep ) {
101 if ( !isset( $data['modules'][$dep] ) ) {
102 // Missing dependencies reported by testMissingDependencies
105 $targets = $data['modules'][$dep]->getTargets();
106 foreach ( $moduleTargets as $moduleTarget ) {
107 $this->assertContains(
110 "The module '$moduleName' must not have target '$moduleTarget' "
111 . "because its dependency '$dep' does not have it"
119 * Get all registered modules from ResouceLoader.
122 protected static function getAllModules() {
123 global $wgEnableJavaScriptTest;
125 // Test existance of test suite files as well
126 // (can't use setUp or setMwGlobals because providers are static)
127 $org_wgEnableJavaScriptTest = $wgEnableJavaScriptTest;
128 $wgEnableJavaScriptTest = true;
130 // Initialize ResourceLoader
131 $rl = new ResourceLoader();
135 foreach ( $rl->getModuleNames() as $moduleName ) {
136 $modules[$moduleName] = $rl->getModule( $moduleName );
140 $wgEnableJavaScriptTest = $org_wgEnableJavaScriptTest;
143 'modules' => $modules,
144 'resourceloader' => $rl,
145 'context' => new ResourceLoaderContext( $rl, new FauxRequest() )
150 * Get all stylesheet files from modules that are an instance of
151 * ResourceLoaderFileModule (or one of its subclasses).
153 public static function provideMediaStylesheets() {
154 $data = self
::getAllModules();
157 foreach ( $data['modules'] as $moduleName => $module ) {
158 if ( !$module instanceof ResourceLoaderFileModule
) {
162 $reflectedModule = new ReflectionObject( $module );
164 $getStyleFiles = $reflectedModule->getMethod( 'getStyleFiles' );
165 $getStyleFiles->setAccessible( true );
167 $readStyleFile = $reflectedModule->getMethod( 'readStyleFile' );
168 $readStyleFile->setAccessible( true );
170 $styleFiles = $getStyleFiles->invoke( $module, $data['context'] );
172 $flip = $module->getFlip( $data['context'] );
174 foreach ( $styleFiles as $media => $files ) {
175 if ( $media && $media !== 'all' ) {
176 foreach ( $files as $file ) {
181 // XXX: Wrapped in an object to keep it out of PHPUnit output
182 (object)array( 'cssText' => $readStyleFile->invoke( $module, $file, $flip ) ),
193 * Get all resource files from modules that are an instance of
194 * ResourceLoaderFileModule (or one of its subclasses).
196 * Since the raw data is stored in protected properties, we have to
197 * overrride this through ReflectionObject methods.
199 public static function provideResourceFiles() {
200 $data = self
::getAllModules();
203 // See also ResourceLoaderFileModule::__construct
204 $filePathProps = array(
205 // Lists of file paths
213 // Collated lists of file paths
214 'nested-lists' => array(
221 foreach ( $data['modules'] as $moduleName => $module ) {
222 if ( !$module instanceof ResourceLoaderFileModule
) {
226 $reflectedModule = new ReflectionObject( $module );
230 foreach ( $filePathProps['lists'] as $propName ) {
231 $property = $reflectedModule->getProperty( $propName );
232 $property->setAccessible( true );
233 $list = $property->getValue( $module );
234 foreach ( $list as $key => $value ) {
235 // 'scripts' are numeral arrays.
236 // 'styles' can be numeral or associative.
237 // In case of associative the key is the file path
238 // and the value is the 'media' attribute.
239 if ( is_int( $key ) ) {
247 foreach ( $filePathProps['nested-lists'] as $propName ) {
248 $property = $reflectedModule->getProperty( $propName );
249 $property->setAccessible( true );
250 $lists = $property->getValue( $module );
251 foreach ( $lists as $list ) {
252 foreach ( $list as $key => $value ) {
253 // We need the same filter as for 'lists',
254 // due to 'skinStyles'.
255 if ( is_int( $key ) ) {
264 // Get method for resolving the paths to full paths
265 $method = $reflectedModule->getMethod( 'getLocalPath' );
266 $method->setAccessible( true );
269 foreach ( $files as $file ) {
271 $method->invoke( $module, $file ),
273 ( $file instanceof ResourceLoaderFilePath ?
$file->getPath() : $file ),