class DisplayPathTest

Same name in other branches
  1. 8.9.x core/modules/views_ui/tests/src/Functional/DisplayPathTest.php \Drupal\Tests\views_ui\Functional\DisplayPathTest
  2. 10 core/modules/views_ui/tests/src/Functional/DisplayPathTest.php \Drupal\Tests\views_ui\Functional\DisplayPathTest
  3. 11.x core/modules/views_ui/tests/src/Functional/DisplayPathTest.php \Drupal\Tests\views_ui\Functional\DisplayPathTest

Tests the UI of generic display path plugin.

@group views_ui

Hierarchy

Expanded class hierarchy of DisplayPathTest

See also

\Drupal\views\Plugin\views\display\PathPluginBase

File

core/modules/views_ui/tests/src/Functional/DisplayPathTest.php, line 15

Namespace

Drupal\Tests\views_ui\Functional
View source
class DisplayPathTest extends UITestBase {
    use AssertPageCacheContextsAndTagsTrait;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->placeBlock('page_title_block');
    }
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view',
        'test_page_display_menu',
    ];
    
    /**
     * Runs the tests.
     */
    public function testPathUI() {
        $this->doBasicPathUITest();
        $this->doAdvancedPathsValidationTest();
        $this->doPathXssFilterTest();
    }
    
    /**
     * Tests basic functionality in configuring a view.
     */
    protected function doBasicPathUITest() {
        $this->drupalGet('admin/structure/views/view/test_view');
        // Add a new page display and check the appearing text.
        $this->submitForm([], 'Add Page');
        $this->assertSession()
            ->pageTextContains('No path is set');
        $this->assertSession()
            ->linkNotExists('View page', 'No view page link found on the page.');
        // Save a path and make sure the summary appears as expected.
        $random_path = $this->randomMachineName();
        // @todo Once https://www.drupal.org/node/2351379 is resolved, Views will no
        //   longer use Url::fromUri(), and this path will be able to contain ':'.
        $random_path = str_replace(':', '', $random_path);
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_1/path');
        $this->submitForm([
            'path' => $random_path,
        ], 'Apply');
        $this->assertSession()
            ->pageTextContains('/' . $random_path);
        $this->clickLink('View Page');
        $this->assertSession()
            ->addressEquals($random_path);
    }
    
    /**
     * Tests that View paths are properly filtered for XSS.
     */
    public function doPathXssFilterTest() {
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->submitForm([], 'Add Page');
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_2/path');
        $this->submitForm([
            'path' => '<object>malformed_path</object>',
        ], 'Apply');
        $this->submitForm([], 'Add Page');
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_3/path');
        $this->submitForm([
            'path' => '<script>alert("hello");</script>',
        ], 'Apply');
        $this->submitForm([], 'Add Page');
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_4/path');
        $this->submitForm([
            'path' => '<script>alert("hello I have placeholders %");</script>',
        ], 'Apply');
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->submitForm([], 'Save');
        $this->drupalGet('admin/structure/views');
        // The anchor text should be escaped.
        $this->assertSession()
            ->assertEscaped('/<object>malformed_path</object>');
        $this->assertSession()
            ->assertEscaped('/<script>alert("hello");</script>');
        $this->assertSession()
            ->assertEscaped('/<script>alert("hello I have placeholders %");</script>');
        // Links should be url-encoded.
        $this->assertSession()
            ->responseContains('/%3Cobject%3Emalformed_path%3C/object%3E');
        $this->assertSession()
            ->responseContains('/%3Cscript%3Ealert%28%22hello%22%29%3B%3C/script%3E');
    }
    
    /**
     * Tests a couple of invalid path patterns.
     */
    protected function doAdvancedPathsValidationTest() {
        $url = 'admin/structure/views/nojs/display/test_view/page_1/path';
        $this->drupalGet($url);
        $this->submitForm([
            'path' => '%/magrathea',
        ], 'Apply');
        $this->assertSession()
            ->addressEquals($url);
        $this->assertSession()
            ->pageTextContains('"%" may not be used for the first segment of a path.');
        $this->drupalGet($url);
        $this->submitForm([
            'path' => 'user/%1/example',
        ], 'Apply');
        $this->assertSession()
            ->addressEquals($url);
        $this->assertSession()
            ->pageTextContains("Numeric placeholders may not be used. Please use plain placeholders (%).");
    }
    
    /**
     * Tests deleting a page display that has no path.
     */
    public function testDeleteWithNoPath() {
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->submitForm([], 'Add Page');
        $this->submitForm([], 'Delete Page');
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains("The view Test view has been saved.");
    }
    
    /**
     * Tests the menu and tab option form.
     */
    public function testMenuOptions() {
        $this->drupalGet('admin/structure/views/view/test_view');
        // Add a new page display.
        $this->submitForm([], 'Add Page');
        // Add an invalid path (only fragment).
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_1/path');
        $this->submitForm([
            'path' => '#foo',
        ], 'Apply');
        $this->assertSession()
            ->pageTextContains('Path is empty');
        // Add an invalid path with a query.
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_1/path');
        $this->submitForm([
            'path' => 'foo?bar',
        ], 'Apply');
        $this->assertSession()
            ->pageTextContains('No query allowed.');
        // Add an invalid path with just a query.
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_1/path');
        $this->submitForm([
            'path' => '?bar',
        ], 'Apply');
        $this->assertSession()
            ->pageTextContains('Path is empty');
        // Provide a random, valid path string.
        $random_string = $this->randomMachineName();
        // Save a path.
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_1/path');
        $this->submitForm([
            'path' => $random_string,
        ], 'Apply');
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->drupalGet('admin/structure/views/nojs/display/test_view/page_1/menu');
        $this->submitForm([
            'menu[type]' => 'default tab',
            'menu[title]' => 'Test tab title',
        ], 'Apply');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('admin/structure/views/nojs/display/test_view/page_1/tab_options');
        $this->submitForm([
            'tab_options[type]' => 'tab',
            'tab_options[title]' => $this->randomString(),
        ], 'Apply');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('admin/structure/views/view/test_view/edit/page_1');
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->assertSession()
            ->linkExists('Tab: Test tab title');
        // If it's a default tab, it should also have an additional settings link.
        $this->assertSession()
            ->linkByHrefExists('admin/structure/views/nojs/display/test_view/page_1/tab_options');
        // Ensure that you can select a parent in case the parent does not exist.
        $this->drupalGet('admin/structure/views/nojs/display/test_page_display_menu/page_5/menu');
        $this->assertSession()
            ->statusCodeEquals(200);
        $menu_options = $this->assertSession()
            ->selectExists('edit-menu-parent')
            ->findAll('css', 'option');
        $menu_options = array_map(function ($element) {
            return $element->getText();
        }, $menu_options);
        $this->assertEquals([
            '<User account menu>',
            '-- My account',
            '-- Log out',
            '<Administration>',
            '<Footer>',
            '<Main navigation>',
            '<Tools>',
            '-- Compose tips (disabled)',
            '-- Test menu link',
        ], $menu_options);
        // The cache contexts associated with the (in)accessible menu links are
        // bubbled.
        $this->assertCacheContext('user.permissions');
    }
    
    /**
     * Tests the regression in https://www.drupal.org/node/2532490.
     */
    public function testDefaultMenuTabRegression() {
        $this->container
            ->get('module_installer')
            ->install([
            'menu_link_content',
            'toolbar',
            'system',
        ]);
        $this->resetAll();
        $admin_user = $this->drupalCreateUser([
            'administer views',
            'administer blocks',
            'bypass node access',
            'access user profiles',
            'view all revisions',
            'administer permissions',
            'administer menu',
            'link to any page',
            'access toolbar',
        ]);
        $this->drupalLogin($admin_user);
        $edit = [
            'title[0][value]' => 'Menu title',
            'link[0][uri]' => '/admin/foo',
            'menu_parent' => 'admin:system.admin',
        ];
        $this->drupalGet('admin/structure/menu/manage/admin/add');
        $this->submitForm($edit, 'Save');
        $menu_items = \Drupal::entityTypeManager()->getStorage('menu_link_content')
            ->getQuery()
            ->accessCheck(FALSE)
            ->sort('id', 'DESC')
            ->pager(1)
            ->execute();
        $menu_item = end($menu_items);
        
        /** @var \Drupal\menu_link_content\MenuLinkContentInterface $menu_link_content */
        $menu_link_content = MenuLinkContent::load($menu_item);
        $edit = [];
        $edit['label'] = $this->randomMachineName(16);
        $view_id = $edit['id'] = strtolower($this->randomMachineName(16));
        $edit['description'] = $this->randomMachineName(16);
        $edit['page[create]'] = TRUE;
        $edit['page[path]'] = 'admin/foo';
        $this->drupalGet('admin/structure/views/add');
        $this->submitForm($edit, 'Save and edit');
        $parameters = new MenuTreeParameters();
        $parameters->addCondition('id', $menu_link_content->getPluginId());
        $result = \Drupal::menuTree()->load('admin', $parameters);
        $plugin_definition = end($result)->link
            ->getPluginDefinition();
        $this->assertEquals('view.' . $view_id . '.page_1', $plugin_definition['route_name']);
        $this->clickLink('No menu');
        $this->submitForm([
            'menu[type]' => 'default tab',
            'menu[title]' => 'Menu title',
        ], 'Apply');
        $this->assertSession()
            ->pageTextContains('Default tab options');
        $this->submitForm([
            'tab_options[type]' => 'normal',
            'tab_options[title]' => 'Parent title',
        ], 'Apply');
        // Open the menu options again.
        $this->clickLink('Tab: Menu title');
        // Assert a menu can be selected as a parent.
        $this->assertSession()
            ->optionExists('menu[parent]', 'admin:');
        // Assert a parent menu item can be selected from within a menu.
        $this->assertSession()
            ->optionExists('menu[parent]', 'admin:system.admin');
        // Check that parent menu item can now be
        // added without the menu_ui module being enabled.
        $this->submitForm([
            'menu[type]' => 'normal',
            'menu[parent]' => 'admin:system.admin',
            'menu[title]' => 'Menu title',
        ], 'Apply');
        $this->submitForm([], 'Save');
        // Assert that saving the view will not cause an exception.
        $this->assertSession()
            ->statusCodeEquals(200);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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 drupal_rewrite_settings().
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. 37
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 Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Simpletest site. 1
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::__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
DisplayPathTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DisplayPathTest::$testViews public static property Views used by this test.
DisplayPathTest::doAdvancedPathsValidationTest protected function Tests a couple of invalid path patterns.
DisplayPathTest::doBasicPathUITest protected function Tests basic functionality in configuring a view.
DisplayPathTest::doPathXssFilterTest public function Tests that View paths are properly filtered for XSS.
DisplayPathTest::setUp protected function Sets up the test. Overrides UITestBase::setUp
DisplayPathTest::testDefaultMenuTabRegression public function Tests the regression in https://www.drupal.org/node/2532490.
DisplayPathTest::testDeleteWithNoPath public function Tests deleting a page display that has no path.
DisplayPathTest::testMenuOptions public function Tests the menu and tab option form.
DisplayPathTest::testPathUI public function Runs the tests.
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
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.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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
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::$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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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 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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 1
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. 1
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 public static function Returns the database connection to the site running Simpletest.
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::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::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::drupalPostForm Deprecated protected function Executes a form submission.
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.
UITestBase::$adminUser protected property An admin user with the &#039;administer views&#039; permission. 5
UITestBase::$fullAdminUser protected property An admin user with administrative permissions for views, blocks, and nodes.
UITestBase::$modules protected static property Modules to enable. Overrides ViewTestBase::$modules 24
UITestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. Overrides UiHelperTrait::drupalGet
UITestBase::randomView public function A helper method which creates a random view.
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.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 2
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 2
ViewTestBase::viewsData protected function Returns the views data definition. 9
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.