ResourcesTest.php

Go to the documentation of this file.

<?php
class ResourcesTest extends MediaWikiTestCase {

        public function testFileExistence( $filename, $module, $resource ) {
                $this->assertFileExists( $filename,
                        "File '$resource' referenced by '$module' must exist."
                );
        }

        public static function provideResourceFiles() {
                global $wgEnableJavaScriptTest;

                // Test existance of test suite files as well
                // (can't use setUp or setMwGlobals because providers are static)
                $live_wgEnableJavaScriptTest = $wgEnableJavaScriptTest;
                $wgEnableJavaScriptTest = true;

                // Array with arguments for the test function
                $cases = array();

                // Initialize ResourceLoader
                $rl = new ResourceLoader();

                // See also ResourceLoaderFileModule::__construct
                $filePathProps = array(
                        // Lists of file paths
                        'lists' => array(
                                'scripts',
                                'debugScripts',
                                'loaderScripts',
                                'styles',
                        ),

                        // Collated lists of file paths
                        'nested-lists' => array(
                                'languageScripts',
                                'skinScripts',
                                'skinStyles',
                        ),
                );

                foreach ( $rl->getModuleNames() as $moduleName ) {
                        $module = $rl->getModule( $moduleName );
                        if ( !$module instanceof ResourceLoaderFileModule ) {
                                continue;
                        }

                        $reflectedModule = new ReflectionObject( $module );

                        $files = array();

                        foreach ( $filePathProps['lists'] as $propName ) {
                                $property = $reflectedModule->getProperty( $propName );
                                $property->setAccessible( true );
                                $list = $property->getValue( $module );
                                foreach ( $list as $key => $value ) {
                                        // 'scripts' are numeral arrays.
                                        // 'styles' can be numeral or associative.
                                        // In case of associative the key is the file path
                                        // and the value is the 'media' attribute.
                                        if ( is_int( $key ) ) {
                                                $files[] = $value;
                                        } else {
                                                $files[] = $key;
                                        }
                                }
                        }

                        foreach ( $filePathProps['nested-lists'] as $propName ) {
                                $property = $reflectedModule->getProperty( $propName );
                                $property->setAccessible( true );
                                $lists = $property->getValue( $module );
                                foreach ( $lists as $group => $list ) {
                                        foreach ( $list as $key => $value ) {
                                                // We need the same filter as for 'lists',
                                                // due to 'skinStyles'.
                                                if ( is_int( $key ) ) {
                                                        $files[] = $value;
                                                } else {
                                                        $files[] = $key;
                                                }
                                        }
                                }
                        }

                        // Get method for resolving the paths to full paths
                        $method = $reflectedModule->getMethod( 'getLocalPath' );
                        $method->setAccessible( true );

                        // Populate cases
                        foreach ( $files as $file ) {
                                $cases[] = array(
                                        $method->invoke( $module, $file ),
                                        $module->getName(),
                                        $file,
                                );
                        }

                }

                // Restore settings
                $wgEnableJavaScriptTest = $live_wgEnableJavaScriptTest;

                return $cases;
        }

}