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
);
34 $this->assertTrue( strpos( $cssText, '@media' ) === false, 'Stylesheets should not both specify "media" and contain @media' );
38 * Get all registered modules from ResouceLoader.
40 protected static function getAllModules() {
41 global $wgEnableJavaScriptTest;
43 // Test existance of test suite files as well
44 // (can't use setUp or setMwGlobals because providers are static)
45 $org_wgEnableJavaScriptTest = $wgEnableJavaScriptTest;
46 $wgEnableJavaScriptTest = true;
48 // Initialize ResourceLoader
49 $rl = new ResourceLoader();
53 foreach ( $rl->getModuleNames() as $moduleName ) {
54 $modules[$moduleName] = $rl->getModule( $moduleName );
58 $wgEnableJavaScriptTest = $org_wgEnableJavaScriptTest;
61 'modules' => $modules,
62 'resourceloader' => $rl,
63 'context' => new ResourceLoaderContext( $rl, new FauxRequest() )
68 * Get all stylesheet files from modules that are an instance of
69 * ResourceLoaderFileModule (or one of its subclasses).
71 public static function provideMediaStylesheets() {
72 $data = self
::getAllModules();
75 foreach ( $data['modules'] as $moduleName => $module ) {
76 if ( !$module instanceof ResourceLoaderFileModule
) {
80 $reflectedModule = new ReflectionObject( $module );
82 $getStyleFiles = $reflectedModule->getMethod( 'getStyleFiles' );
83 $getStyleFiles->setAccessible( true );
85 $readStyleFile = $reflectedModule->getMethod( 'readStyleFile' );
86 $readStyleFile->setAccessible( true );
88 $styleFiles = $getStyleFiles->invoke( $module, $data['context'] );
90 $flip = $module->getFlip( $data['context'] );
92 foreach ( $styleFiles as $media => $files ) {
93 if ( $media && $media !== 'all' ) {
94 foreach ( $files as $file ) {
99 // XXX: Wrapped in an object to keep it out of PHPUnit output
100 (object) array( 'cssText' => $readStyleFile->invoke( $module, $file, $flip ) ),
111 * Get all resource files from modules that are an instance of
112 * ResourceLoaderFileModule (or one of its subclasses).
114 * Since the raw data is stored in protected properties, we have to
115 * overrride this through ReflectionObject methods.
117 public static function provideResourceFiles() {
118 $data = self
::getAllModules();
121 // See also ResourceLoaderFileModule::__construct
122 $filePathProps = array(
123 // Lists of file paths
131 // Collated lists of file paths
132 'nested-lists' => array(
139 foreach ( $data['modules'] as $moduleName => $module ) {
140 if ( !$module instanceof ResourceLoaderFileModule
) {
144 $reflectedModule = new ReflectionObject( $module );
148 foreach ( $filePathProps['lists'] as $propName ) {
149 $property = $reflectedModule->getProperty( $propName );
150 $property->setAccessible( true );
151 $list = $property->getValue( $module );
152 foreach ( $list as $key => $value ) {
153 // 'scripts' are numeral arrays.
154 // 'styles' can be numeral or associative.
155 // In case of associative the key is the file path
156 // and the value is the 'media' attribute.
157 if ( is_int( $key ) ) {
165 foreach ( $filePathProps['nested-lists'] as $propName ) {
166 $property = $reflectedModule->getProperty( $propName );
167 $property->setAccessible( true );
168 $lists = $property->getValue( $module );
169 foreach ( $lists as $list ) {
170 foreach ( $list as $key => $value ) {
171 // We need the same filter as for 'lists',
172 // due to 'skinStyles'.
173 if ( is_int( $key ) ) {
182 // Get method for resolving the paths to full paths
183 $method = $reflectedModule->getMethod( 'getLocalPath' );
184 $method->setAccessible( true );
187 foreach ( $files as $file ) {
189 $method->invoke( $module, $file ),