tests/phpunit/structure/ResourcesTest.php

   1 <?php
   2 /**
   3  * Sanity checks for making sure registered resources are sane.
   4  *
   5  * @file
   6  * @author Antoine Musso
   7  * @author Niklas Laxström
   8  * @author Santhosh Thottingal
   9  * @author Timo Tijhof
  10  * @copyright © 2012, Antoine Musso
  11  * @copyright © 2012, Niklas Laxström
  12  * @copyright © 2012, Santhosh Thottingal
  13  * @copyright © 2012, Timo Tijhof
  14  *
  15  */
  16 class ResourcesTest extends MediaWikiTestCase {
  17
  18         /**
  19          * @dataProvider provideResourceFiles
  20          */
  21         public function testFileExistence( $filename, $module, $resource ) {
  22                 $this->assertFileExists( $filename,
  23                         "File '$resource' referenced by '$module' must exist."
  24                 );
  25         }
  26
  27         /**
  28          * @dataProvider provideMediaStylesheets
  29          */
  30         public function testStyleMedia( $moduleName, $media, $filename, $css ) {
  31                 $cssText = CSSMin::minify( $css->cssText );
  32
  33                 $this->assertTrue(
  34                         strpos( $cssText, '@media' ) === false,
  35                         'Stylesheets should not both specify "media" and contain @media'
  36                 );
  37         }
  38
  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" );
  44                 }
  45         }
  46
  47         /**
  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().
  53          */
  54         public function testIllegalDependencies() {
  55                 $data = self::getAllModules();
  56                 $illegalDeps = array( 'jquery', 'mediawiki' );
  57
  58                 /** @var ResourceLoaderModule $module */
  59                 foreach ( $data['modules'] as $moduleName => $module ) {
  60                         foreach ( $illegalDeps as $illegalDep ) {
  61                                 $this->assertNotContains(
  62                                         $illegalDep,
  63                                         $module->getDependencies( $data['context'] ),
  64                                         "Module '$moduleName' must not depend on '$illegalDep'"
  65                                 );
  66                         }
  67                 }
  68         }
  69
  70         /**
  71          * Verify that all modules specified as dependencies of other modules actually exist.
  72          */
  73         public function testMissingDependencies() {
  74                 $data = self::getAllModules();
  75                 $validDeps = array_keys( $data['modules'] );
  76
  77                 /** @var ResourceLoaderModule $module */
  78                 foreach ( $data['modules'] as $moduleName => $module ) {
  79                         foreach ( $module->getDependencies( $data['context'] ) as $dep ) {
  80                                 $this->assertContains(
  81                                         $dep,
  82                                         $validDeps,
  83                                         "The module '$dep' required by '$moduleName' must exist"
  84                                 );
  85                         }
  86                 }
  87         }
  88
  89         /**
  90          * Verify that all dependencies of all modules are always satisfiable with the 'targets' defined
  91          * for the involved modules.
  92          *
  93          * Example: A depends on B. A has targets: mobile, desktop. B has targets: desktop. Therefore the
  94          * dependency is sometimes unsatisfiable: it's impossible to load module A on mobile.
  95          */
  96         public function testUnsatisfiableDependencies() {
  97                 $data = self::getAllModules();
  98                 $validDeps = array_keys( $data['modules'] );
  99
 100                 /** @var ResourceLoaderModule $module */
 101                 foreach ( $data['modules'] as $moduleName => $module ) {
 102                         $moduleTargets = $module->getTargets();
 103                         foreach ( $module->getDependencies( $data['context'] ) as $dep ) {
 104                                 if ( !isset( $data['modules'][$dep] ) ) {
 105                                         // Missing dependencies reported by testMissingDependencies
 106                                         continue;
 107                                 }
 108                                 $targets = $data['modules'][$dep]->getTargets();
 109                                 foreach ( $moduleTargets as $moduleTarget ) {
 110                                         $this->assertContains(
 111                                                 $moduleTarget,
 112                                                 $targets,
 113                                                 "The module '$moduleName' must not have target '$moduleTarget' "
 114                                                         . "because its dependency '$dep' does not have it"
 115                                         );
 116                                 }
 117                         }
 118                 }
 119         }
 120
 121         /**
 122          * CSSMin::getAllLocalFileReferences should ignore url(...) expressions
 123          * that have been commented out.
 124          */
 125         public function testCommentedLocalFileReferences() {
 126                 $basepath = __DIR__ . '/../data/css/';
 127                 $css = file_get_contents( $basepath . 'comments.css' );
 128                 $files = CSSMin::getAllLocalFileReferences( $css, $basepath );
 129                 $expected = array( $basepath . 'not-commented.gif' );
 130                 $this->assertArrayEquals(
 131                         $expected,
 132                         $files,
 133                         'Url(...) expression in comment should be omitted.'
 134                 );
 135         }
 136
 137         /**
 138          * Get all registered modules from ResouceLoader.
 139          * @return array
 140          */
 141         protected static function getAllModules() {
 142                 global $wgEnableJavaScriptTest;
 143
 144                 // Test existance of test suite files as well
 145                 // (can't use setUp or setMwGlobals because providers are static)
 146                 $org_wgEnableJavaScriptTest = $wgEnableJavaScriptTest;
 147                 $wgEnableJavaScriptTest = true;
 148
 149                 // Initialize ResourceLoader
 150                 $rl = new ResourceLoader();
 151
 152                 $modules = array();
 153
 154                 foreach ( $rl->getModuleNames() as $moduleName ) {
 155                         $modules[$moduleName] = $rl->getModule( $moduleName );
 156                 }
 157
 158                 // Restore settings
 159                 $wgEnableJavaScriptTest = $org_wgEnableJavaScriptTest;
 160
 161                 return array(
 162                         'modules' => $modules,
 163                         'resourceloader' => $rl,
 164                         'context' => new ResourceLoaderContext( $rl, new FauxRequest() )
 165                 );
 166         }
 167
 168         /**
 169          * Get all stylesheet files from modules that are an instance of
 170          * ResourceLoaderFileModule (or one of its subclasses).
 171          */
 172         public static function provideMediaStylesheets() {
 173                 $data = self::getAllModules();
 174                 $cases = array();
 175
 176                 foreach ( $data['modules'] as $moduleName => $module ) {
 177                         if ( !$module instanceof ResourceLoaderFileModule ) {
 178                                 continue;
 179                         }
 180
 181                         $reflectedModule = new ReflectionObject( $module );
 182
 183                         $getStyleFiles = $reflectedModule->getMethod( 'getStyleFiles' );
 184                         $getStyleFiles->setAccessible( true );
 185
 186                         $readStyleFile = $reflectedModule->getMethod( 'readStyleFile' );
 187                         $readStyleFile->setAccessible( true );
 188
 189                         $styleFiles = $getStyleFiles->invoke( $module, $data['context'] );
 190
 191                         $flip = $module->getFlip( $data['context'] );
 192
 193                         foreach ( $styleFiles as $media => $files ) {
 194                                 if ( $media && $media !== 'all' ) {
 195                                         foreach ( $files as $file ) {
 196                                                 $cases[] = array(
 197                                                         $moduleName,
 198                                                         $media,
 199                                                         $file,
 200                                                         // XXX: Wrapped in an object to keep it out of PHPUnit output
 201                                                         (object)array( 'cssText' => $readStyleFile->invoke( $module, $file, $flip ) ),
 202                                                 );
 203                                         }
 204                                 }
 205                         }
 206                 }
 207
 208                 return $cases;
 209         }
 210
 211         /**
 212          * Get all resource files from modules that are an instance of
 213          * ResourceLoaderFileModule (or one of its subclasses).
 214          *
 215          * Since the raw data is stored in protected properties, we have to
 216          * overrride this through ReflectionObject methods.
 217          */
 218         public static function provideResourceFiles() {
 219                 $data = self::getAllModules();
 220                 $cases = array();
 221
 222                 // See also ResourceLoaderFileModule::__construct
 223                 $filePathProps = array(
 224                         // Lists of file paths
 225                         'lists' => array(
 226                                 'scripts',
 227                                 'debugScripts',
 228                                 'loaderScripts',
 229                                 'styles',
 230                         ),
 231
 232                         // Collated lists of file paths
 233                         'nested-lists' => array(
 234                                 'languageScripts',
 235                                 'skinScripts',
 236                                 'skinStyles',
 237                         ),
 238                 );
 239
 240                 foreach ( $data['modules'] as $moduleName => $module ) {
 241                         if ( !$module instanceof ResourceLoaderFileModule ) {
 242                                 continue;
 243                         }
 244
 245                         $reflectedModule = new ReflectionObject( $module );
 246
 247                         $files = array();
 248
 249                         foreach ( $filePathProps['lists'] as $propName ) {
 250                                 $property = $reflectedModule->getProperty( $propName );
 251                                 $property->setAccessible( true );
 252                                 $list = $property->getValue( $module );
 253                                 foreach ( $list as $key => $value ) {
 254                                         // 'scripts' are numeral arrays.
 255                                         // 'styles' can be numeral or associative.
 256                                         // In case of associative the key is the file path
 257                                         // and the value is the 'media' attribute.
 258                                         if ( is_int( $key ) ) {
 259                                                 $files[] = $value;
 260                                         } else {
 261                                                 $files[] = $key;
 262                                         }
 263                                 }
 264                         }
 265
 266                         foreach ( $filePathProps['nested-lists'] as $propName ) {
 267                                 $property = $reflectedModule->getProperty( $propName );
 268                                 $property->setAccessible( true );
 269                                 $lists = $property->getValue( $module );
 270                                 foreach ( $lists as $list ) {
 271                                         foreach ( $list as $key => $value ) {
 272                                                 // We need the same filter as for 'lists',
 273                                                 // due to 'skinStyles'.
 274                                                 if ( is_int( $key ) ) {
 275                                                         $files[] = $value;
 276                                                 } else {
 277                                                         $files[] = $key;
 278                                                 }
 279                                         }
 280                                 }
 281                         }
 282
 283                         // Get method for resolving the paths to full paths
 284                         $method = $reflectedModule->getMethod( 'getLocalPath' );
 285                         $method->setAccessible( true );
 286
 287                         // Populate cases
 288                         foreach ( $files as $file ) {
 289                                 $cases[] = array(
 290                                         $method->invoke( $module, $file ),
 291                                         $moduleName,
 292                                         ( $file instanceof ResourceLoaderFilePath ? $file->getPath() : $file ),
 293                                 );
 294                         }
 295
 296                         // To populate missingLocalFileRefs. Not sure how sane this is inside this test...
 297                         $module->readStyleFiles(
 298                                 $module->getStyleFiles( $data['context'] ),
 299                                 $module->getFlip( $data['context'] ),
 300                                 $data['context']
 301                         );
 302
 303                         $property = $reflectedModule->getProperty( 'missingLocalFileRefs' );
 304                         $property->setAccessible( true );
 305                         $missingLocalFileRefs = $property->getValue( $module );
 306
 307                         foreach ( $missingLocalFileRefs as $file ) {
 308                                 $cases[] = array(
 309                                         $file,
 310                                         $moduleName,
 311                                         $file,
 312                                 );
 313                         }
 314                 }
 315
 316                 return $cases;
 317         }
 318 }