You are here

DeprecatedJqueryUiAssetsTest.php in Drupal 9

File

core/tests/Drupal/KernelTests/Core/Asset/DeprecatedJqueryUiAssetsTest.php
View source
<?php

namespace Drupal\KernelTests\Core\Asset;

use Drupal\KernelTests\KernelTestBase;

/**
 * Checks the deprecation status and contents of jQuery UI libraries.
 *
 * @group Asset
 */
class DeprecatedJqueryUiAssetsTest extends KernelTestBase {

  /**
   * Confirm deprecation status and contents of jQuery UI libraries.
   *
   * @group legacy
   */
  public function testDeprecatedJqueryUi() {

    /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
    $library_discovery = $this->container
      ->get('library.discovery');
    $deprecated_jquery_ui_libraries = [
      'jquery.ui' => '291c28f873a71cd6b3116218d1f5da22',
      'jquery.ui.autocomplete' => '153f2836f8f2da39767208b6e09cb5b4',
      'jquery.ui.button' => 'ad23e5de0fa1de1f511d10ba2e10d2dd',
      'jquery.ui.dialog' => '6521b8917536afe00f35055da4ec466c',
      'jquery.ui.draggable' => 'af0f2bdc8aa4ade1e3de8042f31a9312',
      'jquery.ui.menu' => '7d0c4d57f43d2f881d2cd5e5b79effbb',
      'jquery.ui.mouse' => '626bb203807fa2cdc62510412685df4a',
      'jquery.ui.position' => 'fec1ca376f2b1cb9b0ca3db36be848c2',
      'jquery.ui.resizable' => 'a2448fa87071a17a9756f39c9becb70d',
      'jquery.ui.widget' => 'eacd675de09572383b58e52309ba2245',
    ];

    // DrupalCI uses a precision of 100 in certain environments which breaks
    // this test.
    ini_set('serialize_precision', -1);
    foreach ($deprecated_jquery_ui_libraries as $library => $expected_hashed_library_definition) {
      $this
        ->expectDeprecation("The \"core/{$library}\" asset library is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. See https://www.drupal.org/node/3067969");
      $library_definition = $library_discovery
        ->getLibraryByName('core', $library);
      $this
        ->assertNotEmpty($library_definition['dependencies'], "{$library} must declare dependencies");

      // Confirm that the libraries extending jQuery UI functionality depend on
      // core/jquery.ui directly or via a dependency on core/jquery.ui.widget.
      if (!in_array($library, [
        'jquery.ui',
        'jquery.ui.dialog',
        'jquery.ui.position',
      ])) {
        $has_main_or_widget = in_array('core/jquery.ui', $library_definition['dependencies']) || in_array('core/jquery.ui.widget', $library_definition['dependencies']);
        $this
          ->assertTrue($has_main_or_widget, "{$library} must depend on core/jquery.ui or core/jquery.ui.widget");
      }
      elseif ($library === 'jquery.ui.dialog') {

        // jquery.ui.dialog must be evaluated differently due to it loading
        // jQuery UI assets directly instead of depending on core/jquery.ui.
        // This makes it necessary to depend on core/jquery as that dependency
        // is not inherited from depending on core/jquery.ui.
        //
        // @todo Remove the tests specific to only jquery.ui.dialog as part of
        //   https://drupal.org/node/3192804
        $dialog_depends_on_jquery_core = in_array('core/jquery', $library_definition['dependencies']) && $library === 'jquery.ui.dialog';
        $this
          ->assertTrue($dialog_depends_on_jquery_core, 'core/jquery.ui.dialog must depend on core/jquery');
      }
      $this
        ->assertEquals($expected_hashed_library_definition, md5(serialize($library_definition)));
    }
  }

}

Classes

Namesort descending Description
DeprecatedJqueryUiAssetsTest Checks the deprecation status and contents of jQuery UI libraries.