3 use MediaWiki\MediaWikiServices
;
4 use Wikimedia\TestingAccessWrapper
;
7 * Sanity checks for making sure registered resources are sane.
9 * @author Antoine Musso
10 * @author Niklas Laxström
11 * @author Santhosh Thottingal
12 * @copyright © 2012, Antoine Musso
13 * @copyright © 2012, Niklas Laxström
14 * @copyright © 2012, Santhosh Thottingal
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 all modules specified as dependencies of other modules actually
49 * exist and are not illegal.
51 * @todo Modules can dynamically choose dependencies based on context. This method
52 * does not find all such variations. The same applies to testUnsatisfiableDependencies().
54 public function testValidDependencies() {
55 $data = self
::getAllModules();
56 $knownDeps = array_keys( $data['modules'] );
57 $illegalDeps = [ 'startup' ];
59 // Avoid an assert for each module to keep the test fast.
60 // Instead, perform a single assertion against everything at once.
61 // When all is good, actual/expected are both empty arrays.
62 // When we find issues, add the violations to 'actual' and add an empty
63 // key to 'expected'. These keys in expected are because the PHPUnit diff
64 // (as of 6.5) only goes one level deep.
66 $expectedUnknown = [];
68 $expectedIllegal = [];
70 /** @var ResourceLoaderModule $module */
71 foreach ( $data['modules'] as $moduleName => $module ) {
72 foreach ( $module->getDependencies( $data['context'] ) as $dep ) {
73 if ( !in_array( $dep, $knownDeps, true ) ) {
74 $actualUnknown[$moduleName][] = $dep;
75 $expectedUnknown[$moduleName] = [];
77 if ( in_array( $dep, $illegalDeps, true ) ) {
78 $actualIllegal[$moduleName][] = $dep;
79 $expectedIllegal[$moduleName] = [];
83 $this->assertEquals( $expectedUnknown, $actualUnknown, 'Dependencies that do not exist' );
84 $this->assertEquals( $expectedIllegal, $actualIllegal, 'Dependencies that are not legal' );
88 * Verify that all specified messages actually exist.
90 public function testMissingMessages() {
91 $data = self
::getAllModules();
92 $lang = Language
::factory( 'en' );
94 /** @var ResourceLoaderModule $module */
95 foreach ( $data['modules'] as $moduleName => $module ) {
96 foreach ( $module->getMessages() as $msgKey ) {
98 wfMessage( $msgKey )->useDatabase( false )->inLanguage( $lang )->exists(),
99 "Message '$msgKey' required by '$moduleName' must exist"
106 * Verify that all dependencies of all modules are always satisfiable with the 'targets' defined
107 * for the involved modules.
109 * Example: A depends on B. A has targets: mobile, desktop. B has targets: desktop. Therefore the
110 * dependency is sometimes unsatisfiable: it's impossible to load module A on mobile.
112 public function testUnsatisfiableDependencies() {
113 $data = self
::getAllModules();
115 /** @var ResourceLoaderModule $module */
116 foreach ( $data['modules'] as $moduleName => $module ) {
117 $moduleTargets = $module->getTargets();
118 foreach ( $module->getDependencies( $data['context'] ) as $dep ) {
119 if ( !isset( $data['modules'][$dep] ) ) {
120 // Missing dependencies reported by testMissingDependencies
123 $targets = $data['modules'][$dep]->getTargets();
124 foreach ( $moduleTargets as $moduleTarget ) {
125 $this->assertContains(
128 "The module '$moduleName' must not have target '$moduleTarget' "
129 . "because its dependency '$dep' does not have it"
137 * CSSMin::getLocalFileReferences should ignore url(...) expressions
138 * that have been commented out.
140 public function testCommentedLocalFileReferences() {
141 $basepath = __DIR__
. '/../data/css/';
142 $css = file_get_contents( $basepath . 'comments.css' );
143 $files = CSSMin
::getLocalFileReferences( $css, $basepath );
144 $expected = [ $basepath . 'not-commented.gif' ];
148 'Url(...) expression in comment should be omitted.'
153 * Get all registered modules from ResouceLoader.
156 protected static function getAllModules() {
157 global $wgEnableJavaScriptTest;
159 // Test existance of test suite files as well
160 // (can't use setUp or setMwGlobals because providers are static)
161 $org_wgEnableJavaScriptTest = $wgEnableJavaScriptTest;
162 $wgEnableJavaScriptTest = true;
164 // Get main ResourceLoader
165 $rl = MediaWikiServices
::getInstance()->getResourceLoader();
169 foreach ( $rl->getModuleNames() as $moduleName ) {
170 $modules[$moduleName] = $rl->getModule( $moduleName );
174 $wgEnableJavaScriptTest = $org_wgEnableJavaScriptTest;
177 'modules' => $modules,
178 'resourceloader' => $rl,
179 'context' => new ResourceLoaderContext( $rl, new FauxRequest() )
184 * Get all stylesheet files from modules that are an instance of
185 * ResourceLoaderFileModule (or one of its subclasses).
187 public static function provideMediaStylesheets() {
188 $data = self
::getAllModules();
191 foreach ( $data['modules'] as $moduleName => $module ) {
192 if ( !$module instanceof ResourceLoaderFileModule
) {
196 $reflectedModule = new ReflectionObject( $module );
198 $getStyleFiles = $reflectedModule->getMethod( 'getStyleFiles' );
199 $getStyleFiles->setAccessible( true );
201 $readStyleFile = $reflectedModule->getMethod( 'readStyleFile' );
202 $readStyleFile->setAccessible( true );
204 $styleFiles = $getStyleFiles->invoke( $module, $data['context'] );
206 $flip = $module->getFlip( $data['context'] );
208 foreach ( $styleFiles as $media => $files ) {
209 if ( $media && $media !== 'all' ) {
210 foreach ( $files as $file ) {
215 // XXX: Wrapped in an object to keep it out of PHPUnit output
217 'cssText' => $readStyleFile->invoke(
234 * Get all resource files from modules that are an instance of
235 * ResourceLoaderFileModule (or one of its subclasses).
237 public static function provideResourceFiles() {
238 $data = self
::getAllModules();
241 // See also ResourceLoaderFileModule::__construct
243 // Lists of file paths
250 // Collated lists of file paths
258 foreach ( $data['modules'] as $moduleName => $module ) {
259 if ( !$module instanceof ResourceLoaderFileModule
) {
263 $moduleProxy = TestingAccessWrapper
::newFromObject( $module );
267 foreach ( $filePathProps['lists'] as $propName ) {
268 $list = $moduleProxy->$propName;
269 foreach ( $list as $key => $value ) {
270 // 'scripts' are numeral arrays.
271 // 'styles' can be numeral or associative.
272 // In case of associative the key is the file path
273 // and the value is the 'media' attribute.
274 if ( is_int( $key ) ) {
282 foreach ( $filePathProps['nested-lists'] as $propName ) {
283 $lists = $moduleProxy->$propName;
284 foreach ( $lists as $list ) {
285 foreach ( $list as $key => $value ) {
286 // We need the same filter as for 'lists',
287 // due to 'skinStyles'.
288 if ( is_int( $key ) ) {
298 foreach ( $files as $file ) {
300 $moduleProxy->getLocalPath( $file ),
302 ( $file instanceof ResourceLoaderFilePath ?
$file->getPath() : $file ),
306 // To populate missingLocalFileRefs. Not sure how sane this is inside this test...
307 $moduleProxy->readStyleFiles(
308 $module->getStyleFiles( $data['context'] ),
309 $module->getFlip( $data['context'] ),
313 $missingLocalFileRefs = $moduleProxy->missingLocalFileRefs
;
315 foreach ( $missingLocalFileRefs as $file ) {