class AttachedAssetsTest

Same name in other branches
  1. 8.9.x core/tests/Drupal/KernelTests/Core/Asset/AttachedAssetsTest.php \Drupal\KernelTests\Core\Asset\AttachedAssetsTest
  2. 10 core/tests/Drupal/KernelTests/Core/Asset/AttachedAssetsTest.php \Drupal\KernelTests\Core\Asset\AttachedAssetsTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Asset/AttachedAssetsTest.php \Drupal\KernelTests\Core\Asset\AttachedAssetsTest

Tests #attached assets: attached asset libraries and JavaScript settings.

I.e. tests:


$build['#attached']['library'] = …
$build['#attached']['drupalSettings'] = …

@group Common @group Asset

Hierarchy

Expanded class hierarchy of AttachedAssetsTest

File

core/tests/Drupal/KernelTests/Core/Asset/AttachedAssetsTest.php, line 22

Namespace

Drupal\KernelTests\Core\Asset
View source
class AttachedAssetsTest extends KernelTestBase {
    
    /**
     * The asset resolver service.
     *
     * @var \Drupal\Core\Asset\AssetResolverInterface
     */
    protected $assetResolver;
    
    /**
     * The renderer service.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * The file URL generator.
     *
     * @var \Drupal\Core\File\FileUrlGeneratorInterface
     */
    protected $fileUrlGenerator;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
        'common_test',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->assetResolver = $this->container
            ->get('asset.resolver');
        $this->renderer = $this->container
            ->get('renderer');
        $this->fileUrlGenerator = $this->container
            ->get('file_url_generator');
    }
    
    /**
     * Tests that default CSS and JavaScript is empty.
     */
    public function testDefault() {
        $assets = new AttachedAssets();
        $this->assertEquals([], $this->assetResolver
            ->getCssAssets($assets, FALSE), 'Default CSS is empty.');
        [
            $js_assets_header,
            $js_assets_footer,
        ] = $this->assetResolver
            ->getJsAssets($assets, FALSE);
        $this->assertEquals([], $js_assets_header, 'Default header JavaScript is empty.');
        $this->assertEquals([], $js_assets_footer, 'Default footer JavaScript is empty.');
    }
    
    /**
     * Tests non-existing libraries.
     */
    public function testLibraryUnknown() {
        $build['#attached']['library'][] = 'core/unknown';
        $assets = AttachedAssets::createFromRenderArray($build);
        $this->assertSame([], $this->assetResolver
            ->getJsAssets($assets, FALSE)[0], 'Unknown library was not added to the page.');
    }
    
    /**
     * Tests adding a CSS and a JavaScript file.
     */
    public function testAddFiles() {
        $build['#attached']['library'][] = 'common_test/files';
        $assets = AttachedAssets::createFromRenderArray($build);
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/bar.css', $css);
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/foo.js', $js);
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_css = $this->renderer
            ->renderPlain($css_render_array);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $query_string = $this->container
            ->get('state')
            ->get('system.css_js_query_string') ?: '0';
        $this->assertStringContainsString('<link rel="stylesheet" media="all" href="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/bar.css') . '?' . $query_string . '" />', $rendered_css, 'Rendering an external CSS file.');
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/foo.js') . '?' . $query_string . '"></script>', $rendered_js, 'Rendering an external JavaScript file.');
    }
    
    /**
     * Tests adding JavaScript settings.
     */
    public function testAddJsSettings() {
        // Add a file in order to test default settings.
        $build['#attached']['library'][] = 'core/drupalSettings';
        $assets = AttachedAssets::createFromRenderArray($build);
        $this->assertEquals([], $assets->getSettings(), 'JavaScript settings on $assets are empty.');
        $javascript = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $this->assertArrayHasKey('currentPath', $javascript['drupalSettings']['data']['path']);
        $this->assertArrayHasKey('currentPath', $assets->getSettings()['path']);
        $assets->setSettings([
            'drupal' => 'rocks',
            'dries' => 280342800,
        ]);
        $javascript = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $this->assertEquals(280342800, $javascript['drupalSettings']['data']['dries'], 'JavaScript setting is set correctly.');
        $this->assertEquals('rocks', $javascript['drupalSettings']['data']['drupal'], 'The other JavaScript setting is set correctly.');
    }
    
    /**
     * Tests adding external CSS and JavaScript files.
     */
    public function testAddExternalFiles() {
        $build['#attached']['library'][] = 'common_test/external';
        $assets = AttachedAssets::createFromRenderArray($build);
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $this->assertArrayHasKey('http://example.com/stylesheet.css', $css);
        $this->assertArrayHasKey('http://example.com/script.js', $js);
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_css = $this->renderer
            ->renderPlain($css_render_array);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $this->assertStringContainsString('<link rel="stylesheet" media="all" href="http://example.com/stylesheet.css" />', $rendered_css, 'Rendering an external CSS file.');
        $this->assertStringContainsString('<script src="http://example.com/script.js"></script>', $rendered_js, 'Rendering an external JavaScript file.');
    }
    
    /**
     * Tests adding JavaScript files with additional attributes.
     */
    public function testAttributes() {
        $build['#attached']['library'][] = 'common_test/js-attributes';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $expected_1 = '<script src="http://example.com/deferred-external.js" foo="bar" defer></script>';
        $expected_2 = '<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/deferred-internal.js') . '?v=1" defer bar="foo"></script>';
        $this->assertStringContainsString($expected_1, $rendered_js, 'Rendered external JavaScript with correct defer and random attributes.');
        $this->assertStringContainsString($expected_2, $rendered_js, 'Rendered internal JavaScript with correct defer and random attributes.');
    }
    
    /**
     * Tests that attributes are maintained when JS aggregation is enabled.
     */
    public function testAggregatedAttributes() {
        $build['#attached']['library'][] = 'common_test/js-attributes';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, TRUE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $expected_1 = '<script src="http://example.com/deferred-external.js" foo="bar" defer></script>';
        $expected_2 = '<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/deferred-internal.js') . '?v=1" defer bar="foo"></script>';
        $this->assertStringContainsString($expected_1, $rendered_js, 'Rendered external JavaScript with correct defer and random attributes.');
        $this->assertStringContainsString($expected_2, $rendered_js, 'Rendered internal JavaScript with correct defer and random attributes.');
    }
    
    /**
     * Integration test for CSS/JS aggregation.
     */
    public function testAggregation() {
        $build['#attached']['library'][] = 'core/drupal.timezone';
        $build['#attached']['library'][] = 'core/drupal.vertical-tabs';
        $assets = AttachedAssets::createFromRenderArray($build);
        $this->assertCount(1, $this->assetResolver
            ->getCssAssets($assets, TRUE), 'There is a sole aggregated CSS asset.');
        [
            $header_js,
            $footer_js,
        ] = $this->assetResolver
            ->getJsAssets($assets, TRUE);
        $this->assertEquals([], \Drupal::service('asset.js.collection_renderer')->render($header_js), 'There are 0 JavaScript assets in the header.');
        $rendered_footer_js = \Drupal::service('asset.js.collection_renderer')->render($footer_js);
        $this->assertCount(2, $rendered_footer_js, 'There are 2 JavaScript assets in the footer.');
        $this->assertEquals('drupal-settings-json', $rendered_footer_js[0]['#attributes']['data-drupal-selector'], 'The first of the two JavaScript assets in the footer has drupal settings.');
        $this->assertStringStartsWith(base_path(), $rendered_footer_js[1]['#attributes']['src'], 'The second of the two JavaScript assets in the footer has the sole aggregated JavaScript asset.');
    }
    
    /**
     * Tests JavaScript settings.
     */
    public function testSettings() {
        $build = [];
        $build['#attached']['library'][] = 'core/drupalSettings';
        // Nonsensical value to verify if it's possible to override path settings.
        $build['#attached']['drupalSettings']['path']['pathPrefix'] = 'yarhar';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        // Cast to string since this returns a \Drupal\Core\Render\Markup object.
        $rendered_js = (string) $this->renderer
            ->renderPlain($js_render_array);
        // Parse the generated drupalSettings <script> back to a PHP representation.
        $startToken = '{';
        $endToken = '}';
        $start = strpos($rendered_js, $startToken);
        $end = strrpos($rendered_js, $endToken);
        // Convert to a string, as $renderer_js is a \Drupal\Core\Render\Markup
        // object.
        $json = mb_substr($rendered_js, $start, $end - $start + 1);
        $parsed_settings = Json::decode($json);
        // Test whether the settings for core/drupalSettings are available.
        $this->assertTrue(isset($parsed_settings['path']['baseUrl']), 'drupalSettings.path.baseUrl is present.');
        $this->assertSame('yarhar', $parsed_settings['path']['pathPrefix'], 'drupalSettings.path.pathPrefix is present and has the correct (overridden) value.');
        $this->assertSame('', $parsed_settings['path']['currentPath'], 'drupalSettings.path.currentPath is present and has the correct value.');
        $this->assertFalse($parsed_settings['path']['currentPathIsAdmin'], 'drupalSettings.path.currentPathIsAdmin is present and has the correct value.');
        $this->assertFalse($parsed_settings['path']['isFront'], 'drupalSettings.path.isFront is present and has the correct value.');
        $this->assertSame('en', $parsed_settings['path']['currentLanguage'], 'drupalSettings.path.currentLanguage is present and has the correct value.');
        // Tests whether altering JavaScript settings via hook_js_settings_alter()
        // is working as expected.
        // @see common_test_js_settings_alter()
        $this->assertSame('☃', $parsed_settings['pluralDelimiter']);
        $this->assertSame('bar', $parsed_settings['foo']);
    }
    
    /**
     * Tests JS assets depending on the 'core/<head>' virtual library.
     */
    public function testHeaderHTML() {
        $build['#attached']['library'][] = 'common_test/js-header';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[0];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $query_string = $this->container
            ->get('state')
            ->get('system.css_js_query_string') ?: '0';
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/header.js') . '?' . $query_string . '"></script>', $rendered_js, 'The JS asset in common_test/js-header appears in the header.');
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/misc/drupal.js'), $rendered_js, 'The JS asset of the direct dependency (core/drupal) of common_test/js-header appears in the header.');
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/misc/drupalSettingsLoader.js'), $rendered_js, 'The JS asset of the indirect dependency (core/drupalSettings) of common_test/js-header appears in the header.');
    }
    
    /**
     * Tests that for assets with cache = FALSE, Drupal sets preprocess = FALSE.
     */
    public function testNoCache() {
        $build['#attached']['library'][] = 'common_test/no-cache';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $this->assertFalse($js['core/modules/system/tests/modules/common_test/nocache.js']['preprocess'], 'Setting cache to FALSE sets preprocess to FALSE when adding JavaScript.');
    }
    
    /**
     * Tests adding JavaScript within conditional comments.
     *
     * @group legacy
     * @see \Drupal\Core\Render\Element\HtmlTag::preRenderConditionalComments()
     */
    public function testBrowserConditionalComments() {
        $this->expectDeprecation('Support for IE Conditional Comments is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. See https://www.drupal.org/node/3102997');
        $default_query_string = $this->container
            ->get('state')
            ->get('system.css_js_query_string') ?: '0';
        $build['#attached']['library'][] = 'common_test/browsers';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $expected_1 = "<!--[if lte IE 8]>\n" . '<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/old-ie.js') . '?' . $default_query_string . '"></script>' . "\n<![endif]-->";
        $expected_2 = "<!--[if !IE]><!-->\n" . '<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/no-ie.js') . '?' . $default_query_string . '"></script>' . "\n<!--<![endif]-->";
        $this->assertStringContainsString($expected_1, $rendered_js, 'Rendered JavaScript within downlevel-hidden conditional comments.');
        $this->assertStringContainsString($expected_2, $rendered_js, 'Rendered JavaScript within downlevel-revealed conditional comments.');
    }
    
    /**
     * Tests JavaScript versioning.
     */
    public function testVersionQueryString() {
        $build['#attached']['library'][] = 'core/once';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $this->assertStringContainsString('core/assets/vendor/once/once.min.js?v=1.0.1', $rendered_js, 'JavaScript version identifiers correctly appended to URLs');
    }
    
    /**
     * Tests JavaScript and CSS asset ordering.
     */
    public function testRenderOrder() {
        $build['#attached']['library'][] = 'common_test/order';
        $assets = AttachedAssets::createFromRenderArray($build);
        // Construct the expected result from the regex.
        $expected_order_js = [
            "-8_1",
            "-8_2",
            "-8_3",
            "-8_4",
            // The external script.
"-5_1",
            "-3_1",
            "-3_2",
            "0_1",
            "0_2",
            "0_3",
        ];
        // Retrieve the rendered JavaScript and test against the regex.
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $matches = [];
        if (preg_match_all('/weight_([-0-9]+_[0-9]+)/', $rendered_js, $matches)) {
            $result = $matches[1];
        }
        else {
            $result = [];
        }
        $this->assertSame($expected_order_js, $result, 'JavaScript is added in the expected weight order.');
        // Construct the expected result from the regex.
        $expected_order_css = [
            // Base.
'base_weight_-101_1',
            'base_weight_-8_1',
            'layout_weight_-101_1',
            'base_weight_0_1',
            'base_weight_0_2',
            // Layout.
'layout_weight_-8_1',
            'component_weight_-101_1',
            'layout_weight_0_1',
            'layout_weight_0_2',
            // Component.
'component_weight_-8_1',
            'state_weight_-101_1',
            'component_weight_0_1',
            'component_weight_0_2',
            // State.
'state_weight_-8_1',
            'theme_weight_-101_1',
            'state_weight_0_1',
            'state_weight_0_2',
            // Theme.
'theme_weight_-8_1',
            'theme_weight_0_1',
            'theme_weight_0_2',
        ];
        // Retrieve the rendered CSS and test against the regex.
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE);
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $rendered_css = $this->renderer
            ->renderPlain($css_render_array);
        $matches = [];
        if (preg_match_all('/([a-z]+)_weight_([-0-9]+_[0-9]+)/', $rendered_css, $matches)) {
            $result = $matches[0];
        }
        else {
            $result = [];
        }
        $this->assertSame($expected_order_css, $result, 'CSS is added in the expected weight order.');
    }
    
    /**
     * Tests rendering the JavaScript with a file's weight above jQuery's.
     */
    public function testRenderDifferentWeight() {
        // If a library contains assets A and B, and A is listed first, then B can
        // still make itself appear first by defining a lower weight.
        $build['#attached']['library'][] = 'core/jquery';
        $build['#attached']['library'][] = 'common_test/weight';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        // Verify that lighter CSS assets are rendered first.
        $this->assertLessThan(strpos($rendered_js, 'first.js'), strpos($rendered_js, 'lighter.css'));
        // Verify that lighter JavaScript assets are rendered first.
        $this->assertLessThan(strpos($rendered_js, 'first.js'), strpos($rendered_js, 'lighter.js'));
        // Verify that a JavaScript file is rendered before jQuery.
        $this->assertLessThan(strpos($rendered_js, 'core/assets/vendor/jquery/jquery.min.js'), strpos($rendered_js, 'before-jquery.js'));
    }
    
    /**
     * Tests altering a JavaScript's weight via hook_js_alter().
     *
     * @see common_test_js_alter()
     */
    public function testAlter() {
        // Add both tableselect.js and alter.js.
        $build['#attached']['library'][] = 'core/drupal.tableselect';
        $build['#attached']['library'][] = 'common_test/hook_js_alter';
        $assets = AttachedAssets::createFromRenderArray($build);
        // Render the JavaScript, testing if alter.js was altered to be before
        // tableselect.js. See common_test_js_alter() to see where this alteration
        // takes place.
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        // Verify that JavaScript weight is correctly altered by the alter hook.
        $this->assertLessThan(strpos($rendered_js, 'core/misc/tableselect.js'), strpos($rendered_js, 'alter.js'));
    }
    
    /**
     * Adds a JavaScript library to the page and alters it.
     *
     * @see common_test_library_info_alter()
     */
    public function testLibraryAlter() {
        // Verify that common_test altered the title of loadjs.
        
        /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
        $library_discovery = \Drupal::service('library.discovery');
        $library = $library_discovery->getLibraryByName('core', 'loadjs');
        $this->assertEquals('0.0', $library['version'], 'Registered libraries were altered.');
        // common_test_library_info_alter() also added a dependency on jQuery Form.
        $build['#attached']['library'][] = 'core/loadjs';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $this->assertStringContainsString('core/assets/vendor/jquery-form/jquery.form.min.js', (string) $rendered_js, 'Altered library dependencies are added to the page.');
    }
    
    /**
     * Dynamically defines an asset library and alters it.
     */
    public function testDynamicLibrary() {
        
        /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
        $library_discovery = \Drupal::service('library.discovery');
        // Retrieve a dynamic library definition.
        // @see common_test_library_info_build()
        \Drupal::state()->set('common_test.library_info_build_test', TRUE);
        $library_discovery->clearCachedDefinitions();
        $dynamic_library = $library_discovery->getLibraryByName('common_test', 'dynamic_library');
        $this->assertIsArray($dynamic_library);
        $this->assertArrayHasKey('version', $dynamic_library);
        $this->assertSame('1.0', $dynamic_library['version']);
        // Make sure the dynamic library definition could be altered.
        // @see common_test_library_info_alter()
        $this->assertArrayHasKey('dependencies', $dynamic_library);
        $this->assertSame([
            'core/jquery',
        ], $dynamic_library['dependencies']);
    }
    
    /**
     * Tests that multiple modules can implement libraries with the same name.
     *
     * @see common_test.library.yml
     */
    public function testLibraryNameConflicts() {
        
        /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
        $library_discovery = \Drupal::service('library.discovery');
        $loadjs = $library_discovery->getLibraryByName('common_test', 'loadjs');
        $this->assertEquals('0.1', $loadjs['version'], 'Alternative libraries can be added to the page.');
    }
    
    /**
     * Tests JavaScript files that have query strings attached get added right.
     */
    public function testAddJsFileWithQueryString() {
        $build['#attached']['library'][] = 'common_test/querystring';
        $assets = AttachedAssets::createFromRenderArray($build);
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE)[1];
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/querystring.css?arg1=value1&arg2=value2', $css);
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/querystring.js?arg1=value1&arg2=value2', $js);
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $rendered_css = $this->renderer
            ->renderPlain($css_render_array);
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = $this->renderer
            ->renderPlain($js_render_array);
        $query_string = $this->container
            ->get('state')
            ->get('system.css_js_query_string') ?: '0';
        $this->assertStringContainsString('<link rel="stylesheet" media="all" href="' . str_replace('&', '&amp;', $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/querystring.css?arg1=value1&arg2=value2')) . '&amp;' . $query_string . '" />', $rendered_css, 'CSS file with query string gets version query string correctly appended..');
        $this->assertStringContainsString('<script src="' . str_replace('&', '&amp;', $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/querystring.js?arg1=value1&arg2=value2')) . '&amp;' . $query_string . '"></script>', $rendered_js, 'JavaScript file with query string gets version query string correctly appended.');
    }
    
    /**
     * Tests deprecated drupal_js_defaults() function.
     *
     * @group legacy
     */
    public function testDeprecatedDrupalJsDefaults() {
        $this->expectDeprecation('drupal_js_defaults() is deprecated in drupal:9.4.0 and is removed from drupal:10.0.0. No direct replacement is provided. See https://www.drupal.org/node/3197679');
        $this->assertIsArray(drupal_js_defaults());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
AttachedAssetsTest::$assetResolver protected property The asset resolver service.
AttachedAssetsTest::$fileUrlGenerator protected property The file URL generator.
AttachedAssetsTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
AttachedAssetsTest::$renderer protected property The renderer service.
AttachedAssetsTest::setUp protected function Overrides KernelTestBase::setUp
AttachedAssetsTest::testAddExternalFiles public function Tests adding external CSS and JavaScript files.
AttachedAssetsTest::testAddFiles public function Tests adding a CSS and a JavaScript file.
AttachedAssetsTest::testAddJsFileWithQueryString public function Tests JavaScript files that have query strings attached get added right.
AttachedAssetsTest::testAddJsSettings public function Tests adding JavaScript settings.
AttachedAssetsTest::testAggregatedAttributes public function Tests that attributes are maintained when JS aggregation is enabled.
AttachedAssetsTest::testAggregation public function Integration test for CSS/JS aggregation.
AttachedAssetsTest::testAlter public function Tests altering a JavaScript&#039;s weight via hook_js_alter().
AttachedAssetsTest::testAttributes public function Tests adding JavaScript files with additional attributes.
AttachedAssetsTest::testBrowserConditionalComments public function Tests adding JavaScript within conditional comments.
AttachedAssetsTest::testDefault public function Tests that default CSS and JavaScript is empty.
AttachedAssetsTest::testDeprecatedDrupalJsDefaults public function Tests deprecated drupal_js_defaults() function.
AttachedAssetsTest::testDynamicLibrary public function Dynamically defines an asset library and alters it.
AttachedAssetsTest::testHeaderHTML public function Tests JS assets depending on the &#039;core/&lt;head&gt;&#039; virtual library.
AttachedAssetsTest::testLibraryAlter public function Adds a JavaScript library to the page and alters it.
AttachedAssetsTest::testLibraryNameConflicts public function Tests that multiple modules can implement libraries with the same name.
AttachedAssetsTest::testLibraryUnknown public function Tests non-existing libraries.
AttachedAssetsTest::testNoCache public function Tests that for assets with cache = FALSE, Drupal sets preprocess = FALSE.
AttachedAssetsTest::testRenderDifferentWeight public function Tests rendering the JavaScript with a file&#039;s weight above jQuery&#039;s.
AttachedAssetsTest::testRenderOrder public function Tests JavaScript and CSS asset ordering.
AttachedAssetsTest::testSettings public function Tests JavaScript settings.
AttachedAssetsTest::testVersionQueryString public function Tests JavaScript versioning.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.