class JqueryUiLibraryAssetsTest

Same name in other branches
  1. 9 core/tests/Drupal/FunctionalTests/Libraries/JqueryUiLibraryAssetsTest.php \Drupal\FunctionalTests\Libraries\JqueryUiLibraryAssetsTest
  2. 11.x core/tests/Drupal/FunctionalTests/Libraries/JqueryUiLibraryAssetsTest.php \Drupal\FunctionalTests\Libraries\JqueryUiLibraryAssetsTest

Tests the loading of jQuery UI CSS and JS assets.

@group libraries @group legacy

Hierarchy

Expanded class hierarchy of JqueryUiLibraryAssetsTest

File

core/tests/Drupal/FunctionalTests/Libraries/JqueryUiLibraryAssetsTest.php, line 15

Namespace

Drupal\FunctionalTests\Libraries
View source 
class JqueryUiLibraryAssetsTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'jqueryui_library_assets_test',
    ];
    
    /**
     * The library discovery service.
     *
     * @var \Drupal\Core\Asset\LibraryDiscoveryInterface
     */
    protected $libraryDiscovery;
    
    /**
     * jQuery UI CSS and JS assets keyed by their weight.
     *
     * For example, the value of $weightGroupedAssets[-11] would be an array
     * of every jQuery UI CSS and JS file asset configured with a weight of -11.
     *
     * @var array
     */
    protected $weightGroupedAssets = [];
    
    /**
     * The core libraries that load assets from jQuery UI.
     *
     * @var array
     */
    protected $coreLibrariesWithJqueryUiAssets = [];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->libraryDiscovery = $this->container
            ->get('library.discovery');
        $core_libraries = $this->libraryDiscovery
            ->getLibrariesByExtension('core');
        // All the core libraries that use jQuery UI assets.
        $libraries_to_check = [
            'internal.jquery_ui',
            'drupal.autocomplete',
            'drupal.dialog',
        ];
        $this->coreLibrariesWithJqueryUiAssets = array_filter($core_libraries, function ($key) use ($libraries_to_check) {
            return in_array($key, $libraries_to_check);
        }, ARRAY_FILTER_USE_KEY);
        // Loop through the core libraries with jQuery assets to build an array that
        // groups assets by their weight value.
        foreach ($this->coreLibrariesWithJqueryUiAssets as $library) {
            foreach ([
                'js',
                'css',
            ] as $type) {
                foreach ($library[$type] as $asset) {
                    $file = $asset['data'];
                    if (!str_contains($file, 'jquery.ui')) {
                        continue;
                    }
                    $weight = $asset['weight'];
                    $this->weightGroupedAssets["{$weight}"][] = $file;
                }
            }
        }
        $this->weightGroupedAssets = array_map(function ($item) {
            return array_unique($item);
        }, $this->weightGroupedAssets);
        ksort($this->weightGroupedAssets);
    }
    
    /**
     * Confirm assets are weighted so they load in the correct order.
     *
     * The configured loading order is compared against the necessary loading
     * order. The necessary loading order was determined by the requirements
     * specified in each jQuery UI JavaScript file.
     */
    public function testProperlySetWeights() : void {
        $assets = [];
        // Confirm that no asset is assigned multiple weights.
        foreach ($this->weightGroupedAssets as $asset_array) {
            foreach ($asset_array as $asset) {
                $this->assertNotContains($asset, $assets);
                $assets[] = $asset;
            }
        }
        // The loading order that assets groups must be in, based on the
        // dependencies specified in every jQuery UI JavaScript file.
        $necessary_loading_order = [
            [
                'core/assets/vendor/jquery.ui/ui/version-min.js',
            ],
            [
                'core/assets/vendor/jquery.ui/ui/data-min.js',
                'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
                'core/assets/vendor/jquery.ui/ui/focusable-min.js',
                'core/assets/vendor/jquery.ui/ui/form-min.js',
                'core/assets/vendor/jquery.ui/ui/ie-min.js',
                'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
                'core/assets/vendor/jquery.ui/ui/keycode-min.js',
                'core/assets/vendor/jquery.ui/ui/plugin-min.js',
                'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
                'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
                'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
                'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
                'core/assets/vendor/jquery.ui/ui/widget-min.js',
                'core/assets/vendor/jquery.ui/themes/base/core.css',
            ],
            [
                'core/assets/vendor/jquery.ui/ui/widgets/autocomplete-min.js',
                'core/assets/vendor/jquery.ui/ui/labels-min.js',
                'core/assets/vendor/jquery.ui/ui/widgets/menu-min.js',
                'core/assets/vendor/jquery.ui/themes/base/autocomplete.css',
                'core/assets/vendor/jquery.ui/themes/base/menu.css',
                'core/assets/vendor/jquery.ui/ui/widgets/controlgroup-min.js',
                'core/assets/vendor/jquery.ui/ui/form-reset-mixin-min.js',
                'core/assets/vendor/jquery.ui/ui/widgets/mouse-min.js',
                'core/assets/vendor/jquery.ui/themes/base/controlgroup.css',
            ],
            [
                'core/assets/vendor/jquery.ui/ui/widgets/checkboxradio-min.js',
                'core/assets/vendor/jquery.ui/ui/widgets/draggable-min.js',
                'core/assets/vendor/jquery.ui/ui/widgets/resizable-min.js',
                'core/assets/vendor/jquery.ui/themes/base/checkboxradio.css',
                'core/assets/vendor/jquery.ui/themes/base/resizable.css',
            ],
            [
                'core/assets/vendor/jquery.ui/ui/widgets/button-min.js',
                'core/assets/vendor/jquery.ui/themes/base/button.css',
            ],
            [
                'core/assets/vendor/jquery.ui/ui/widgets/dialog-min.js',
                'core/assets/vendor/jquery.ui/themes/base/dialog.css',
            ],
            [
                'core/assets/vendor/jquery.ui/themes/base/theme.css',
            ],
        ];
        $configured_weights = array_keys($this->weightGroupedAssets);
        // Loop through the necessary loading order and compare to the configured
        // loading order.
        foreach ($necessary_loading_order as $stage => $assets) {
            $assets_loaded_in_stage = $this->weightGroupedAssets[$configured_weights[$stage]];
            foreach ($assets as $asset) {
                $this->assertContains($asset, $assets_loaded_in_stage);
            }
        }
    }
    
    /**
     * Confirm that uses of a jQuery UI asset are configured with the same weight.
     */
    public function testSameAssetSameWeight() : void {
        $asset_weights = [];
        $libraries_to_check = $this->coreLibrariesWithJqueryUiAssets;
        foreach ($libraries_to_check as $library) {
            foreach ([
                'js',
                'css',
            ] as $type) {
                foreach ($library[$type] as $asset) {
                    $file = $asset['data'];
                    if (str_contains($file, 'jquery.ui')) {
                        // If this is the first time a given file is checked, add the weight
                        // value to an array.
                        if (!isset($asset_weights[$file])) {
                            $asset_weights[$file] = $asset['weight'];
                        }
                        else {
                            // Confirm the weight of the file being loaded matches the weight
                            // of when it was loaded by a library that was checked earlier.
                            $this->assertEquals($asset_weights[$file], $asset['weight']);
                        }
                    }
                }
            }
        }
    }
    
    /**
     * Removes base_url() and query args from file paths.
     *
     * @param string $path
     *   The path being trimmed.
     *
     * @return string
     *   The trimmed path.
     */
    protected function trimFilePath($path) {
        $base_path_position = strpos($path, base_path());
        if ($base_path_position !== FALSE) {
            $path = substr_replace($path, '', $base_path_position, strlen(base_path()));
        }
        $query_pos = strpos($path, '?');
        return $query_pos !== FALSE ? substr($path, 0, $query_pos) : $path;
    }
    
    /**
     * Confirms that jQuery UI assets load on the page in the configured order.
     *
     * @dataProvider providerTestAssetLoading
     */
    public function testLibraryAssetLoadingOrder($library, array $expected_css, array $expected_js) : void {
        $this->drupalGet("jqueryui_library_assets_test/{$library}");
        $this->assertSession()
            ->statusCodeEquals(200);
        // A pipe character in $libraries is delimiting multiple library names.
        $libraries = str_contains($library, '|') ? explode('|', $library) : [
            $library,
        ];
        $files_to_check = [];
        // Populate an array with the filenames of every jQuery UI asset in the
        // libraries being tested. This will be used to confirm the configured
        // assets actually load on the test page.
        foreach ($libraries as $library_name) {
            foreach ([
                'css',
                'js',
            ] as $type) {
                $assets = $this->coreLibrariesWithJqueryUiAssets[$library_name][$type];
                foreach ($assets as $asset) {
                    if (str_contains($asset['data'], 'jquery.ui')) {
                        $files_to_check[$asset['data']] = TRUE;
                    }
                }
            }
        }
        $this->assertNotEmpty($files_to_check);
        // Find all jQuery UI CSS files loaded to the page, and compare their
        // loading order to the weights configured in core.libraries.yml.
        $css = $this->getSession()
            ->getPage()
            ->findAll('css', 'link[href*="jquery.ui"]');
        $css_weight = -100;
        foreach ($css as $item) {
            $file = $this->trimFilePath($item->getAttribute('href'));
            $found = FALSE;
            foreach ($this->weightGroupedAssets as $key => $array) {
                if (in_array($file, $array)) {
                    $found = TRUE;
                    $this->assertGreaterThanOrEqual($css_weight, $key, "The file {$file} not loading in the expected order based on its weight value.");
                    $css_weight = $key;
                    unset($files_to_check[$file]);
                }
            }
            $this->assertTrue($found, "A jQuery UI file: {$file} was loaded by the page, but is not taken into account by the test.");
        }
        $this->assertGreaterThan(-100, $css_weight);
        $js_weight = -100;
        $js = $this->getSession()
            ->getPage()
            ->findAll('css', 'script[src*="jquery.ui"]');
        foreach ($js as $item) {
            $file = $this->trimFilePath($item->getAttribute('src'));
            $found = FALSE;
            foreach ($this->weightGroupedAssets as $key => $array) {
                if (in_array($file, $array)) {
                    $found = TRUE;
                    $this->assertGreaterThanOrEqual($js_weight, $key, "The file {$file} not loading in the expected order based on its weight value.");
                    $js_weight = $key;
                    unset($files_to_check[$file]);
                }
            }
            $this->assertTrue($found, "A jQuery UI file: {$file} was loaded by the page, but is not taken into account by the test.");
        }
        $this->assertGreaterThan(-100, $js_weight);
        $this->assertEmpty($files_to_check);
    }
    
    /**
     * Confirms jQuery UI assets load as expected.
     *
     * Compares the jQuery assets that currently load against a list of the assets
     * that loaded prior to the deprecation of all remaining core jQuery UI
     * libraries.
     *
     * While this is similar to testLibraryAssetLoadingOrder(), it is a separate
     * test so it can be run in a test-only context, thus confirming that asset
     * loading is truly unchanged before and after the deprecations.
     *
     * @param string $library
     *   A pipe delimited list of libraries to check.
     * @param string[] $expected_css
     *   The jQuery UI CSS files expected to load.
     * @param string[] $expected_js
     *   The jQuery UI JavaScript files expected to load.
     *
     * @dataProvider providerTestAssetLoading
     */
    public function testAssetLoadingUnchanged($library, array $expected_css, array $expected_js) : void {
        $this->drupalGet("jqueryui_library_assets_test/{$library}");
        $this->assertSession()
            ->statusCodeEquals(200);
        // Find all jQuery UI CSS files loaded to the page.
        $css = $this->getSession()
            ->getPage()
            ->findAll('css', 'link[href*="jquery.ui"]');
        $css_loaded_by_page = [];
        foreach ($css as $item) {
            $file = $this->trimFilePath($item->getAttribute('href'));
            $css_loaded_by_page[] = $file;
        }
        $this->assertEmpty(array_diff($css_loaded_by_page, $expected_css));
        // Find all jQuery UI JavaScript files loaded to the page.
        $js = $this->getSession()
            ->getPage()
            ->findAll('css', 'script[src*="jquery.ui"]');
        $js_loaded_by_page = [];
        foreach ($js as $item) {
            $file = $this->trimFilePath($item->getAttribute('src'));
            $js_loaded_by_page[] = $file;
        }
        // assertEmpty() is used instead of assertSame() because we can only test
        // for the presence of assets, not their loading order. The test is designed
        // to pass before and after the jQuery UI asset changes in
        // http://drupal.org/node/3113400, which, by necessity, results in loading
        // order changes.
        $this->assertEmpty(array_diff($js_loaded_by_page, $expected_js));
    }
    
    /**
     * Data provider for confirming jQuery UI assets load as expected.
     *
     * Provides arrays that list how jQuery UI CSS and JavaScript dependencies
     * loaded prior to the change from dependencies to direct asset loading.
     *
     * @return array
     *   An array of test cases, where each test case is an array with the
     *   following values:
     *   - A pipe delimited string of the library/libraries to test.
     *   - An array of the jQuery UI CSS files that loaded for a given library
     *     prior to the change from jQuery UI library dependencies to direct file
     *     inclusion.
     *   - An array of the jQuery UI JavaScript files that loaded for a given
     *     library prior to the change from jQuery UI library dependencies to
     *     direct file inclusion.
     */
    public static function providerTestAssetLoading() {
        return [
            'drupal.autocomplete' => [
                'library' => 'drupal.autocomplete',
                'expected_css' => [
                    'core/assets/vendor/jquery.ui/themes/base/core.css',
                    'core/assets/vendor/jquery.ui/themes/base/menu.css',
                    'core/assets/vendor/jquery.ui/themes/base/autocomplete.css',
                    'core/assets/vendor/jquery.ui/themes/base/theme.css',
                ],
                'expected_js' => [
                    'core/assets/vendor/jquery.ui/ui/data-min.js',
                    'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
                    'core/assets/vendor/jquery.ui/ui/form-min.js',
                    'core/assets/vendor/jquery.ui/ui/labels-min.js',
                    'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
                    'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
                    'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
                    'core/assets/vendor/jquery.ui/ui/version-min.js',
                    'core/assets/vendor/jquery.ui/ui/focusable-min.js',
                    'core/assets/vendor/jquery.ui/ui/ie-min.js',
                    'core/assets/vendor/jquery.ui/ui/keycode-min.js',
                    'core/assets/vendor/jquery.ui/ui/plugin-min.js',
                    'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
                    'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
                    'core/assets/vendor/jquery.ui/ui/widget-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/menu-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/autocomplete-min.js',
                ],
            ],
            'drupal.dialog' => [
                'library' => 'drupal.dialog',
                'expected_css' => [
                    'core/assets/vendor/jquery.ui/themes/base/core.css',
                    'core/assets/vendor/jquery.ui/themes/base/resizable.css',
                    'core/assets/vendor/jquery.ui/themes/base/checkboxradio.css',
                    'core/assets/vendor/jquery.ui/themes/base/controlgroup.css',
                    'core/assets/vendor/jquery.ui/themes/base/button.css',
                    'core/assets/vendor/jquery.ui/themes/base/dialog.css',
                    'core/assets/vendor/jquery.ui/themes/base/theme.css',
                ],
                'expected_js' => [
                    'core/assets/vendor/jquery.ui/ui/data-min.js',
                    'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
                    'core/assets/vendor/jquery.ui/ui/form-min.js',
                    'core/assets/vendor/jquery.ui/ui/labels-min.js',
                    'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
                    'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
                    'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
                    'core/assets/vendor/jquery.ui/ui/version-min.js',
                    'core/assets/vendor/jquery.ui/ui/focusable-min.js',
                    'core/assets/vendor/jquery.ui/ui/keycode-min.js',
                    'core/assets/vendor/jquery.ui/ui/plugin-min.js',
                    'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
                    'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
                    'core/assets/vendor/jquery.ui/ui/widget-min.js',
                    'core/assets/vendor/jquery.ui/ui/ie-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/mouse-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/draggable-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/resizable-min.js',
                    'core/assets/vendor/jquery.ui/ui/form-reset-mixin-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/checkboxradio-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/controlgroup-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/button-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/dialog-min.js',
                ],
            ],
            // A few instances of multiple libraries being checked simultaneously are
            // here to ensure that multiple libraries requesting the same asset does
            // not impact the expected loading order.
'drupal.autocomplete|drupal.dialog' => [
                'library' => 'drupal.autocomplete|drupal.dialog',
                'expected_css' => [
                    'core/assets/vendor/jquery.ui/themes/base/core.css',
                    'core/assets/vendor/jquery.ui/themes/base/menu.css',
                    'core/assets/vendor/jquery.ui/themes/base/autocomplete.css',
                    'core/assets/vendor/jquery.ui/themes/base/resizable.css',
                    'core/assets/vendor/jquery.ui/themes/base/checkboxradio.css',
                    'core/assets/vendor/jquery.ui/themes/base/controlgroup.css',
                    'core/assets/vendor/jquery.ui/themes/base/button.css',
                    'core/assets/vendor/jquery.ui/themes/base/dialog.css',
                    'core/assets/vendor/jquery.ui/themes/base/theme.css',
                ],
                'expected_js' => [
                    'core/assets/vendor/jquery.ui/ui/data-min.js',
                    'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
                    'core/assets/vendor/jquery.ui/ui/form-min.js',
                    'core/assets/vendor/jquery.ui/ui/labels-min.js',
                    'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
                    'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
                    'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
                    'core/assets/vendor/jquery.ui/ui/version-min.js',
                    'core/assets/vendor/jquery.ui/ui/focusable-min.js',
                    'core/assets/vendor/jquery.ui/ui/keycode-min.js',
                    'core/assets/vendor/jquery.ui/ui/plugin-min.js',
                    'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
                    'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
                    'core/assets/vendor/jquery.ui/ui/widget-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/menu-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/autocomplete-min.js',
                    'core/assets/vendor/jquery.ui/ui/ie-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/mouse-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/draggable-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/resizable-min.js',
                    'core/assets/vendor/jquery.ui/ui/form-reset-mixin-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/checkboxradio-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/controlgroup-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/button-min.js',
                    'core/assets/vendor/jquery.ui/ui/widgets/dialog-min.js',
                ],
            ],
        ];
    }

}

Members

Title Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
JqueryUiLibraryAssetsTest::$coreLibrariesWithJqueryUiAssets protected property The core libraries that load assets from jQuery UI.
JqueryUiLibraryAssetsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
JqueryUiLibraryAssetsTest::$libraryDiscovery protected property The library discovery service.
JqueryUiLibraryAssetsTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
JqueryUiLibraryAssetsTest::$weightGroupedAssets protected property jQuery UI CSS and JS assets keyed by their weight.
JqueryUiLibraryAssetsTest::providerTestAssetLoading public static function Data provider for confirming jQuery UI assets load as expected.
JqueryUiLibraryAssetsTest::setUp protected function Overrides BrowserTestBase::setUp
JqueryUiLibraryAssetsTest::testAssetLoadingUnchanged public function Confirms jQuery UI assets load as expected.
JqueryUiLibraryAssetsTest::testLibraryAssetLoadingOrder public function Confirms that jQuery UI assets load on the page in the configured order.
JqueryUiLibraryAssetsTest::testProperlySetWeights public function Confirm assets are weighted so they load in the correct order.
JqueryUiLibraryAssetsTest::testSameAssetSameWeight public function Confirm that uses of a jQuery UI asset are configured with the same weight.
JqueryUiLibraryAssetsTest::trimFilePath protected function Removes base_url() and query args from file paths.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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::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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 5
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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