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
15 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
17 class ResourcesTest
extends MediaWikiTestCase
{
20 * @dataProvider provideResourceFiles
22 public function testFileExistence( $filename, $module, $resource ) {
23 $this->assertFileExists( $filename,
24 "File '$resource' referenced by '$module' must exist."
29 * @dataProvider provideMediaStylesheets
31 public function testStyleMedia( $moduleName, $media, $filename, $css ) {
32 $cssText = CSSMin
::minify( $css->cssText
);
35 strpos( $cssText, '@media' ) === false,
36 'Stylesheets should not both specify "media" and contain @media'
41 * Verify that nothing explicitly depends on the 'jquery' and 'mediawiki' modules.
42 * They are always loaded, depending on them is unsupported and leads to unexpected behaviour.
44 public function testIllegalDependencies() {
45 $data = self
::getAllModules();
46 $illegalDeps = array( 'jquery', 'mediawiki' );
48 foreach ( $data['modules'] as $moduleName => $module ) {
49 foreach ( $illegalDeps as $illegalDep ) {
50 $this->assertNotContains(
52 $module->getDependencies(),
53 "Module '$moduleName' must not depend on '$illegalDep'"
60 * Verify that all modules specified as dependencies of other modules actually exist.
62 public function testMissingDependencies() {
63 $data = self
::getAllModules();
64 $validDeps = array_keys( $data['modules'] );
66 foreach ( $data['modules'] as $moduleName => $module ) {
67 foreach ( $module->getDependencies() as $dep ) {
68 $this->assertContains(
71 "The module '$dep' required by '$moduleName' must exist"
78 * Verify that all dependencies of all modules are always satisfiable with the 'targets' defined
79 * for the involved modules.
81 * Example: A depends on B. A has targets: mobile, desktop. B has targets: desktop. Therefore the
82 * dependency is sometimes unsatisfiable: it's impossible to load module A on mobile.
84 public function testUnsatisfiableDependencies() {
85 $data = self
::getAllModules();
86 $validDeps = array_keys( $data['modules'] );
88 foreach ( $data['modules'] as $moduleName => $module ) {
89 $moduleTargets = $module->getTargets();
90 foreach ( $module->getDependencies() as $dep ) {
91 $targets = $data['modules'][$dep]->getTargets();
92 foreach ( $moduleTargets as $moduleTarget ) {
93 $this->assertContains(
96 "The module '$moduleName' must not have target '$moduleTarget' "
97 . "because its dependency '$dep' does not have it"
105 * Get all registered modules from ResouceLoader.
107 protected static function getAllModules() {
108 global $wgEnableJavaScriptTest;
110 // Test existance of test suite files as well
111 // (can't use setUp or setMwGlobals because providers are static)
112 $org_wgEnableJavaScriptTest = $wgEnableJavaScriptTest;
113 $wgEnableJavaScriptTest = true;
115 // Initialize ResourceLoader
116 $rl = new ResourceLoader();
120 foreach ( $rl->getModuleNames() as $moduleName ) {
121 $modules[$moduleName] = $rl->getModule( $moduleName );
125 $wgEnableJavaScriptTest = $org_wgEnableJavaScriptTest;
128 'modules' => $modules,
129 'resourceloader' => $rl,
130 'context' => new ResourceLoaderContext( $rl, new FauxRequest() )
135 * Get all stylesheet files from modules that are an instance of
136 * ResourceLoaderFileModule (or one of its subclasses).
138 public static function provideMediaStylesheets() {
139 $data = self
::getAllModules();
142 foreach ( $data['modules'] as $moduleName => $module ) {
143 if ( !$module instanceof ResourceLoaderFileModule
) {
147 $reflectedModule = new ReflectionObject( $module );
149 $getStyleFiles = $reflectedModule->getMethod( 'getStyleFiles' );
150 $getStyleFiles->setAccessible( true );
152 $readStyleFile = $reflectedModule->getMethod( 'readStyleFile' );
153 $readStyleFile->setAccessible( true );
155 $styleFiles = $getStyleFiles->invoke( $module, $data['context'] );
157 $flip = $module->getFlip( $data['context'] );
159 foreach ( $styleFiles as $media => $files ) {
160 if ( $media && $media !== 'all' ) {
161 foreach ( $files as $file ) {
166 // XXX: Wrapped in an object to keep it out of PHPUnit output
167 (object)array( 'cssText' => $readStyleFile->invoke( $module, $file, $flip ) ),
178 * Get all resource files from modules that are an instance of
179 * ResourceLoaderFileModule (or one of its subclasses).
181 * Since the raw data is stored in protected properties, we have to
182 * overrride this through ReflectionObject methods.
184 public static function provideResourceFiles() {
185 $data = self
::getAllModules();
188 // See also ResourceLoaderFileModule::__construct
189 $filePathProps = array(
190 // Lists of file paths
198 // Collated lists of file paths
199 'nested-lists' => array(
206 foreach ( $data['modules'] as $moduleName => $module ) {
207 if ( !$module instanceof ResourceLoaderFileModule
) {
211 $reflectedModule = new ReflectionObject( $module );
215 foreach ( $filePathProps['lists'] as $propName ) {
216 $property = $reflectedModule->getProperty( $propName );
217 $property->setAccessible( true );
218 $list = $property->getValue( $module );
219 foreach ( $list as $key => $value ) {
220 // 'scripts' are numeral arrays.
221 // 'styles' can be numeral or associative.
222 // In case of associative the key is the file path
223 // and the value is the 'media' attribute.
224 if ( is_int( $key ) ) {
232 foreach ( $filePathProps['nested-lists'] as $propName ) {
233 $property = $reflectedModule->getProperty( $propName );
234 $property->setAccessible( true );
235 $lists = $property->getValue( $module );
236 foreach ( $lists as $list ) {
237 foreach ( $list as $key => $value ) {
238 // We need the same filter as for 'lists',
239 // due to 'skinStyles'.
240 if ( is_int( $key ) ) {
249 // Get method for resolving the paths to full paths
250 $method = $reflectedModule->getMethod( 'getLocalPath' );
251 $method->setAccessible( true );
254 foreach ( $files as $file ) {
256 $method->invoke( $module, $file ),