class CssCollectionRendererUnitTest

Same name and namespace in other branches
  1. 9 core/tests/Drupal/Tests/Core/Asset/CssCollectionRendererUnitTest.php \Drupal\Tests\Core\Asset\CssCollectionRendererUnitTest

Tests the CSS asset collection renderer.

@group Asset

Hierarchy

Expanded class hierarchy of CssCollectionRendererUnitTest

File

core/tests/Drupal/Tests/Core/Asset/CssCollectionRendererUnitTest.php, line 17

Namespace

Drupal\Tests\Core\Asset
View on git.drupalcode.org
View source 
class CssCollectionRendererUnitTest extends UnitTestCase {
  
  /**
   * A CSS asset renderer.
   *
   * @var \Drupal\Core\Asset\CssCollectionRenderer
   */
  protected $renderer;
  
  /**
   * A valid file CSS asset group.
   *
   * @var array
   */
  protected $fileCssGroup;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $assetQueryString = $this->prophesize(AssetQueryStringInterface::class);
    $file_url_generator = $this->createMock(FileUrlGeneratorInterface::class);
    $file_url_generator->expects($this->any())
      ->method('generateString')
      ->with($this->isType('string'))
      ->willReturnCallback(function ($uri) {
      return 'generated-relative-url:' . $uri;
    });
    $assetQueryString->get()
      ->shouldBeCalledOnce()
      ->willReturn('');
    $this->renderer = new CssCollectionRenderer($assetQueryString->reveal(), $file_url_generator);
    $this->fileCssGroup = [
      'group' => -100,
      'type' => 'file',
      'media' => 'all',
      'preprocess' => TRUE,
      'items' => [
        0 => [
          'group' => -100,
          'type' => 'file',
          'weight' => 0.012,
          'media' => 'all',
          'preprocess' => TRUE,
          'data' => 'tests/Drupal/Tests/Core/Asset/foo.css',
          'basename' => 'foo.css',
        ],
        1 => [
          'group' => -100,
          'type' => 'file',
          'weight' => 0.013,
          'media' => 'all',
          'preprocess' => TRUE,
          'data' => 'tests/Drupal/Tests/Core/Asset/bar.css',
          'basename' => 'bar.css',
        ],
      ],
    ];
  }
  
  /**
   * Provides data for the CSS asset rendering test.
   *
   * @see testRender
   */
  public static function providerTestRender() {
    $create_link_element = function ($href, $media = 'all', $custom_attributes = []) {
      $attributes = [
        'rel' => 'stylesheet',
        'media' => $media,
        'href' => $href,
      ];
      return [
        '#type' => 'html_tag',
        '#tag' => 'link',
        '#attributes' => array_replace($attributes, $custom_attributes),
      ];
    };
    $create_file_css_asset = function ($data, $media = 'all', $preprocess = TRUE) {
      return [
        'group' => 0,
        'type' => 'file',
        'media' => $media,
        'preprocess' => $preprocess,
        'data' => $data,
      ];
    };
    // cspell:disable-next-line
    $custom_attributes = [
      'integrity' => 'sha384-psK1OYPAYjYUhtDYW+Pj2yc',
      'crossorigin' => 'anonymous',
      'random-attribute' => 'test',
    ];
    return [
      // Single external CSS asset.
0 => [
        // CSS assets.
[
          0 => [
            'group' => 0,
            'type' => 'external',
            'media' => 'all',
            'preprocess' => TRUE,
            'data' => 'http://example.com/popular.js',
          ],
        ],
        // Render elements.
[
          0 => $create_link_element('http://example.com/popular.js', 'all'),
        ],
      ],
      // Single file CSS asset.
1 => [
        [
          0 => [
            'group' => 0,
            'type' => 'file',
            'media' => 'all',
            'preprocess' => TRUE,
            'data' => 'public://css/file-all',
          ],
        ],
        [
          0 => $create_link_element('generated-relative-url:public://css/file-all?', 'all'),
        ],
      ],
      // Single file CSS asset with custom attributes.
2 => [
        [
          0 => [
            'group' => 0,
            'type' => 'file',
            'media' => 'all',
            'preprocess' => TRUE,
            'data' => 'public://css/file-all',
            'attributes' => $custom_attributes,
          ],
        ],
        [
          0 => $create_link_element('generated-relative-url:public://css/file-all?', 'all', $custom_attributes),
        ],
      ],
      // 31 file CSS assets: expect 31 link elements.
3 => [
        [
          0 => $create_file_css_asset('public://css/1.css'),
          1 => $create_file_css_asset('public://css/2.css'),
          2 => $create_file_css_asset('public://css/3.css'),
          3 => $create_file_css_asset('public://css/4.css'),
          4 => $create_file_css_asset('public://css/5.css'),
          5 => $create_file_css_asset('public://css/6.css'),
          6 => $create_file_css_asset('public://css/7.css'),
          7 => $create_file_css_asset('public://css/8.css'),
          8 => $create_file_css_asset('public://css/9.css'),
          9 => $create_file_css_asset('public://css/10.css'),
          10 => $create_file_css_asset('public://css/11.css'),
          11 => $create_file_css_asset('public://css/12.css'),
          12 => $create_file_css_asset('public://css/13.css'),
          13 => $create_file_css_asset('public://css/14.css'),
          14 => $create_file_css_asset('public://css/15.css'),
          15 => $create_file_css_asset('public://css/16.css'),
          16 => $create_file_css_asset('public://css/17.css'),
          17 => $create_file_css_asset('public://css/18.css'),
          18 => $create_file_css_asset('public://css/19.css'),
          19 => $create_file_css_asset('public://css/20.css'),
          20 => $create_file_css_asset('public://css/21.css'),
          21 => $create_file_css_asset('public://css/22.css'),
          22 => $create_file_css_asset('public://css/23.css'),
          23 => $create_file_css_asset('public://css/24.css'),
          24 => $create_file_css_asset('public://css/25.css'),
          25 => $create_file_css_asset('public://css/26.css'),
          26 => $create_file_css_asset('public://css/27.css'),
          27 => $create_file_css_asset('public://css/28.css'),
          28 => $create_file_css_asset('public://css/29.css'),
          29 => $create_file_css_asset('public://css/30.css'),
          30 => $create_file_css_asset('public://css/31.css'),
        ],
        [
          0 => $create_link_element('generated-relative-url:public://css/1.css?'),
          1 => $create_link_element('generated-relative-url:public://css/2.css?'),
          2 => $create_link_element('generated-relative-url:public://css/3.css?'),
          3 => $create_link_element('generated-relative-url:public://css/4.css?'),
          4 => $create_link_element('generated-relative-url:public://css/5.css?'),
          5 => $create_link_element('generated-relative-url:public://css/6.css?'),
          6 => $create_link_element('generated-relative-url:public://css/7.css?'),
          7 => $create_link_element('generated-relative-url:public://css/8.css?'),
          8 => $create_link_element('generated-relative-url:public://css/9.css?'),
          9 => $create_link_element('generated-relative-url:public://css/10.css?'),
          10 => $create_link_element('generated-relative-url:public://css/11.css?'),
          11 => $create_link_element('generated-relative-url:public://css/12.css?'),
          12 => $create_link_element('generated-relative-url:public://css/13.css?'),
          13 => $create_link_element('generated-relative-url:public://css/14.css?'),
          14 => $create_link_element('generated-relative-url:public://css/15.css?'),
          15 => $create_link_element('generated-relative-url:public://css/16.css?'),
          16 => $create_link_element('generated-relative-url:public://css/17.css?'),
          17 => $create_link_element('generated-relative-url:public://css/18.css?'),
          18 => $create_link_element('generated-relative-url:public://css/19.css?'),
          19 => $create_link_element('generated-relative-url:public://css/20.css?'),
          20 => $create_link_element('generated-relative-url:public://css/21.css?'),
          21 => $create_link_element('generated-relative-url:public://css/22.css?'),
          22 => $create_link_element('generated-relative-url:public://css/23.css?'),
          23 => $create_link_element('generated-relative-url:public://css/24.css?'),
          24 => $create_link_element('generated-relative-url:public://css/25.css?'),
          25 => $create_link_element('generated-relative-url:public://css/26.css?'),
          26 => $create_link_element('generated-relative-url:public://css/27.css?'),
          27 => $create_link_element('generated-relative-url:public://css/28.css?'),
          28 => $create_link_element('generated-relative-url:public://css/29.css?'),
          29 => $create_link_element('generated-relative-url:public://css/30.css?'),
          30 => $create_link_element('generated-relative-url:public://css/31.css?'),
        ],
      ],
      // 32 file CSS assets with the same properties, except for the 10th and
      // 20th files, they have different 'media' properties.
4 => [
        [
          0 => $create_file_css_asset('public://css/1.css'),
          1 => $create_file_css_asset('public://css/2.css'),
          2 => $create_file_css_asset('public://css/3.css'),
          3 => $create_file_css_asset('public://css/4.css'),
          4 => $create_file_css_asset('public://css/5.css'),
          5 => $create_file_css_asset('public://css/6.css'),
          6 => $create_file_css_asset('public://css/7.css'),
          7 => $create_file_css_asset('public://css/8.css'),
          8 => $create_file_css_asset('public://css/9.css'),
          9 => $create_file_css_asset('public://css/10.css', 'screen'),
          10 => $create_file_css_asset('public://css/11.css'),
          11 => $create_file_css_asset('public://css/12.css'),
          12 => $create_file_css_asset('public://css/13.css'),
          13 => $create_file_css_asset('public://css/14.css'),
          14 => $create_file_css_asset('public://css/15.css'),
          15 => $create_file_css_asset('public://css/16.css'),
          16 => $create_file_css_asset('public://css/17.css'),
          17 => $create_file_css_asset('public://css/18.css'),
          18 => $create_file_css_asset('public://css/19.css'),
          19 => $create_file_css_asset('public://css/20.css', 'print'),
          20 => $create_file_css_asset('public://css/21.css'),
          21 => $create_file_css_asset('public://css/22.css'),
          22 => $create_file_css_asset('public://css/23.css'),
          23 => $create_file_css_asset('public://css/24.css'),
          24 => $create_file_css_asset('public://css/25.css'),
          25 => $create_file_css_asset('public://css/26.css'),
          26 => $create_file_css_asset('public://css/27.css'),
          27 => $create_file_css_asset('public://css/28.css'),
          28 => $create_file_css_asset('public://css/29.css'),
          29 => $create_file_css_asset('public://css/30.css'),
          30 => $create_file_css_asset('public://css/31.css'),
          31 => $create_file_css_asset('public://css/32.css'),
        ],
        [
          0 => $create_link_element('generated-relative-url:public://css/1.css?'),
          1 => $create_link_element('generated-relative-url:public://css/2.css?'),
          2 => $create_link_element('generated-relative-url:public://css/3.css?'),
          3 => $create_link_element('generated-relative-url:public://css/4.css?'),
          4 => $create_link_element('generated-relative-url:public://css/5.css?'),
          5 => $create_link_element('generated-relative-url:public://css/6.css?'),
          6 => $create_link_element('generated-relative-url:public://css/7.css?'),
          7 => $create_link_element('generated-relative-url:public://css/8.css?'),
          8 => $create_link_element('generated-relative-url:public://css/9.css?'),
          9 => $create_link_element('generated-relative-url:public://css/10.css?', 'screen'),
          10 => $create_link_element('generated-relative-url:public://css/11.css?'),
          11 => $create_link_element('generated-relative-url:public://css/12.css?'),
          12 => $create_link_element('generated-relative-url:public://css/13.css?'),
          13 => $create_link_element('generated-relative-url:public://css/14.css?'),
          14 => $create_link_element('generated-relative-url:public://css/15.css?'),
          15 => $create_link_element('generated-relative-url:public://css/16.css?'),
          16 => $create_link_element('generated-relative-url:public://css/17.css?'),
          17 => $create_link_element('generated-relative-url:public://css/18.css?'),
          18 => $create_link_element('generated-relative-url:public://css/19.css?'),
          19 => $create_link_element('generated-relative-url:public://css/20.css?', 'print'),
          20 => $create_link_element('generated-relative-url:public://css/21.css?'),
          21 => $create_link_element('generated-relative-url:public://css/22.css?'),
          22 => $create_link_element('generated-relative-url:public://css/23.css?'),
          23 => $create_link_element('generated-relative-url:public://css/24.css?'),
          24 => $create_link_element('generated-relative-url:public://css/25.css?'),
          25 => $create_link_element('generated-relative-url:public://css/26.css?'),
          26 => $create_link_element('generated-relative-url:public://css/27.css?'),
          27 => $create_link_element('generated-relative-url:public://css/28.css?'),
          28 => $create_link_element('generated-relative-url:public://css/29.css?'),
          29 => $create_link_element('generated-relative-url:public://css/30.css?'),
          30 => $create_link_element('generated-relative-url:public://css/31.css?'),
          31 => $create_link_element('generated-relative-url:public://css/32.css?'),
        ],
      ],
    ];
  }
  
  /**
   * Tests CSS asset rendering.
   *
   * @dataProvider providerTestRender
   */
  public function testRender(array $css_assets, array $render_elements) : void {
    $this->assertSame($render_elements, $this->renderer
      ->render($css_assets));
  }
  
  /**
   * Tests a CSS asset group with the invalid 'type' => 'internal'.
   */
  public function testRenderInvalidType() : void {
    $this->expectException('Exception');
    $this->expectExceptionMessage('Invalid CSS asset type.');
    $css_group = [
      'group' => 0,
      'type' => 'internal',
      'media' => 'all',
      'preprocess' => TRUE,
      'data' => 'http://example.com/popular.js',
    ];
    $this->renderer
      ->render([
      $css_group,
    ]);
  }

}

Members

Title Modifiers Object type Summary Overriden Title
CssCollectionRendererUnitTest::$fileCssGroup protected property A valid file CSS asset group.
CssCollectionRendererUnitTest::$renderer protected property A CSS asset renderer.
CssCollectionRendererUnitTest::providerTestRender public static function Provides data for the CSS asset rendering test.
CssCollectionRendererUnitTest::setUp protected function Overrides UnitTestCase::setUp
CssCollectionRendererUnitTest::testRender public function Tests CSS asset rendering.
CssCollectionRendererUnitTest::testRenderInvalidType public function Tests a CSS asset group with the invalid 'type' => 'internal'.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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.
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.
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
UnitTestCase::setupMockIterator protected function Set up a traversable class mock to return specific items when iterated.

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