class QuickEditJavascriptTestBase

Same name in other branches
  1. 9 core/modules/quickedit/tests/src/FunctionalJavascript/QuickEditJavascriptTestBase.php \Drupal\Tests\quickedit\FunctionalJavascript\QuickEditJavascriptTestBase

Base class for testing the QuickEdit.

Hierarchy

Expanded class hierarchy of QuickEditJavascriptTestBase

2 files declare their use of QuickEditJavascriptTestBase
LayoutBuilderQuickEditTest.php in core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderQuickEditTest.php
QuickEditImageTest.php in core/modules/image/tests/src/FunctionalJavascript/QuickEditImageTest.php

File

core/modules/quickedit/tests/src/FunctionalJavascript/QuickEditJavascriptTestBase.php, line 11

Namespace

Drupal\Tests\quickedit\FunctionalJavascript
View source
class QuickEditJavascriptTestBase extends WebDriverTestBase {
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'contextual',
        'quickedit',
        'toolbar',
    ];
    
    /**
     * A user with permissions to edit Articles and use Quick Edit.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $contentAuthorUser;
    protected static $expectedFieldStateAttributes = [
        'inactive' => '.quickedit-field:not(.quickedit-editable):not(.quickedit-candidate):not(.quickedit-highlighted):not(.quickedit-editing):not(.quickedit-changed)',
        // A field in 'candidate' state may still have the .quickedit-changed class
        // because when its changes were saved to tempstore, it'll still be changed.
        // It's just not currently being edited, so that's why it is not in the
        // 'changed' state.
'candidate' => '.quickedit-field.quickedit-editable.quickedit-candidate:not(.quickedit-highlighted):not(.quickedit-editing)',
        'highlighted' => '.quickedit-field.quickedit-editable.quickedit-candidate.quickedit-highlighted:not(.quickedit-editing)',
        'activating' => '.quickedit-field.quickedit-editable.quickedit-candidate.quickedit-highlighted.quickedit-editing:not(.quickedit-changed)',
        'active' => '.quickedit-field.quickedit-editable.quickedit-candidate.quickedit-highlighted.quickedit-editing:not(.quickedit-changed)',
        'changed' => '.quickedit-field.quickedit-editable.quickedit-candidate.quickedit-highlighted.quickedit-editing.quickedit-changed',
        'saving' => '.quickedit-field.quickedit-editable.quickedit-candidate.quickedit-highlighted.quickedit-editing.quickedit-changed',
    ];
    
    /**
     * Starts in-place editing of the given entity instance.
     *
     * @param string $entity_type_id
     *   The entity type ID.
     * @param int $entity_id
     *   The entity ID.
     * @param int $entity_instance_id
     *   The entity instance ID. (Instance on the page.)
     */
    protected function startQuickEditViaToolbar($entity_type_id, $entity_id, $entity_instance_id) {
        $page = $this->getSession()
            ->getPage();
        $toolbar_edit_button_selector = '#toolbar-bar .contextual-toolbar-tab button';
        $entity_instance_selector = '[data-quickedit-entity-id="' . $entity_type_id . '/' . $entity_id . '"][data-quickedit-entity-instance-id="' . $entity_instance_id . '"]';
        $contextual_links_trigger_selector = '[data-contextual-id] > .trigger';
        // Assert the original page state does not have the toolbar's "Edit" button
        // pressed/activated, and hence none of the contextual link triggers should
        // be visible.
        $toolbar_edit_button = $page->find('css', $toolbar_edit_button_selector);
        $this->assertSame('false', $toolbar_edit_button->getAttribute('aria-pressed'), 'The "Edit" button in the toolbar is not yet pressed.');
        $this->assertFalse($toolbar_edit_button->hasClass('is-active'), 'The "Edit" button in the toolbar is not yet marked as active.');
        foreach ($page->findAll('css', $contextual_links_trigger_selector) as $dom_node) {
            
            /** @var \Behat\Mink\Element\NodeElement $dom_node */
            $this->assertTrue($dom_node->hasClass('visually-hidden'), 'The contextual links trigger "' . $dom_node->getParent()
                ->getAttribute('data-contextual-id') . '" is hidden.');
        }
        $this->assertTrue(TRUE, 'All contextual links triggers are hidden.');
        // Click the "Edit" button in the toolbar.
        $this->click($toolbar_edit_button_selector);
        // Assert the toolbar's "Edit" button is now pressed/activated, and hence
        // all of the contextual link triggers should be visible.
        $this->assertSame('true', $toolbar_edit_button->getAttribute('aria-pressed'), 'The "Edit" button in the toolbar is pressed.');
        $this->assertTrue($toolbar_edit_button->hasClass('is-active'), 'The "Edit" button in the toolbar is marked as active.');
        foreach ($page->findAll('css', $contextual_links_trigger_selector) as $dom_node) {
            
            /** @var \Behat\Mink\Element\NodeElement $dom_node */
            $this->assertFalse($dom_node->hasClass('visually-hidden'), 'The contextual links trigger "' . $dom_node->getParent()
                ->getAttribute('data-contextual-id') . '" is visible.');
        }
        $this->assertTrue(TRUE, 'All contextual links triggers are visible.');
        // @todo Press tab key to verify that tabbing is now contrained to only
        // contextual links triggers: https://www.drupal.org/node/2834776
        // Assert that the contextual links associated with the entity's contextual
        // links trigger are not visible.
        
        /** @var \Behat\Mink\Element\NodeElement $entity_contextual_links_container */
        $entity_contextual_links_container = $page->find('css', $entity_instance_selector)
            ->find('css', $contextual_links_trigger_selector)
            ->getParent();
        $this->assertFalse($entity_contextual_links_container->hasClass('open'));
        $this->assertTrue($entity_contextual_links_container->find('css', 'ul.contextual-links')
            ->hasAttribute('hidden'));
        // Click the contextual link trigger for the entity we want to Quick Edit.
        $this->click($entity_instance_selector . ' ' . $contextual_links_trigger_selector);
        $this->assertTrue($entity_contextual_links_container->hasClass('open'));
        $this->assertFalse($entity_contextual_links_container->find('css', 'ul.contextual-links')
            ->hasAttribute('hidden'));
        // Click the "Quick edit" contextual link.
        $this->click($entity_instance_selector . ' [data-contextual-id] ul.contextual-links li.quickedit a');
        // Assert the Quick Edit internal state is correct.
        $js_condition = <<<JS
Drupal.quickedit.collections.entities.where({isActive: true}).length === 1 && Drupal.quickedit.collections.entities.where({isActive: true})[0].get('entityID') === '{<span class="php-variable">$entity_type_id</span>}/{<span class="php-variable">$entity_id</span>}';
JS;
        $this->assertJsCondition($js_condition);
    }
    
    /**
     * Clicks the 'Save' button in the Quick Edit entity toolbar.
     */
    protected function saveQuickEdit() {
        $quickedit_entity_toolbar = $this->getSession()
            ->getPage()
            ->findById('quickedit-entity-toolbar');
        $save_button = $quickedit_entity_toolbar->find('css', 'button.action-save');
        $save_button->press();
        $this->assertSame('Saving', $save_button->getText());
    }
    
    /**
     * Awaits Quick Edit to be initiated for all instances of the given entity.
     *
     * @param string $entity_type_id
     *   The entity type ID.
     * @param int $entity_id
     *   The entity ID.
     */
    protected function awaitQuickEditForEntity($entity_type_id, $entity_id) {
        $entity_selector = '[data-quickedit-entity-id="' . $entity_type_id . '/' . $entity_id . '"]';
        $condition = "document.querySelectorAll('" . $entity_selector . "').length === document.querySelectorAll('" . $entity_selector . " .quickedit').length";
        $this->assertJsCondition($condition, 10000);
    }
    
    /**
     * Awaits a particular field instance to reach a particular state.
     *
     * @param string $entity_type_id
     *   The entity type ID.
     * @param int $entity_id
     *   The entity ID.
     * @param int $entity_instance_id
     *   The entity instance ID. (Instance on the page.)
     * @param string $field_name
     *   The field name.
     * @param string $langcode
     *   The language code.
     * @param string $awaited_state
     *   One of the possible field states.
     */
    protected function awaitEntityInstanceFieldState($entity_type_id, $entity_id, $entity_instance_id, $field_name, $langcode, $awaited_state) {
        $entity_page_id = $entity_type_id . '/' . $entity_id . '[' . $entity_instance_id . ']';
        $logical_field_id = $entity_type_id . '/' . $entity_id . '/' . $field_name . '/' . $langcode;
        $this->assertJsCondition("Drupal.quickedit.collections.entities.get('{$entity_page_id}').get('fields').findWhere({logicalFieldID: '{$logical_field_id}'}).get('state') === '{$awaited_state}';");
    }
    
    /**
     * Asserts the state of the Quick Edit entity toolbar.
     *
     * @param string $expected_entity_label
     *   The expected label in the Quick Edit Entity Toolbar.
     */
    protected function assertQuickEditEntityToolbar($expected_entity_label, $expected_field_label) {
        $quickedit_entity_toolbar = $this->getSession()
            ->getPage()
            ->findById('quickedit-entity-toolbar');
        // We cannot use ->getText() because it also returns the text of all child
        // nodes. We also cannot use XPath to select text node in Selenium. So we
        // use JS expression to select only the text node.
        $this->assertSame($expected_entity_label, $this->getSession()
            ->evaluateScript("return window.jQuery('#quickedit-entity-toolbar .quickedit-toolbar-label').clone().children().remove().end().text();"));
        if ($expected_field_label !== NULL) {
            $field_label = $quickedit_entity_toolbar->find('css', '.quickedit-toolbar-label > .field');
            // Only try to find the text content of the element if it was actually
            // found; otherwise use the returned value for assertion. This helps
            // us find a more useful stack/error message from testbot instead of the
            // trimmed partial exception stack.
            if ($field_label) {
                $field_label = $field_label->getText();
            }
            $this->assertSame($expected_field_label, $field_label);
        }
        else {
            $this->assertEmpty($quickedit_entity_toolbar->find('css', '.quickedit-toolbar-label > .field'));
        }
    }
    
    /**
     * Asserts all EntityModels (entity instances) on the page.
     *
     * @param array $expected_entity_states
     *   Must describe the expected state of all in-place editable entity
     *   instances on the page.
     *
     * @see Drupal.quickedit.EntityModel
     */
    protected function assertEntityInstanceStates(array $expected_entity_states) {
        $js_get_all_field_states_for_entity = <<<JS
function () {
    Drupal.quickedit.collections.entities.reduce(function (result, fieldModel) { result[fieldModel.get('id')] = fieldModel.get('state'); return result; }, {})
  var entityCollection = Drupal.quickedit.collections.entities;
  return entityCollection.reduce(function (result, entityModel) {
    result[entityModel.id] = entityModel.get('state');
    return result;
  }, {});
}()
JS;
        $this->assertSame($expected_entity_states, $this->getSession()
            ->evaluateScript($js_get_all_field_states_for_entity));
    }
    
    /**
     * Asserts all FieldModels for the given entity instance.
     *
     * @param string $entity_type_id
     *   The entity type ID.
     * @param int $entity_id
     *   The entity ID.
     * @param int $entity_instance_id
     *   The entity instance ID. (Instance on the page.)
     * @param array $expected_field_states
     *   Must describe the expected state of all in-place editable fields of the
     *   given entity instance.
     */
    protected function assertEntityInstanceFieldStates($entity_type_id, $entity_id, $entity_instance_id, array $expected_field_states) {
        // Get all FieldModel states for the entity instance being asserted. This
        // ensures that $expected_field_states must describe the state of all fields
        // of the entity instance.
        $entity_page_id = $entity_type_id . '/' . $entity_id . '[' . $entity_instance_id . ']';
        $js_get_all_field_states_for_entity = <<<JS
function () {
  var entityCollection = Drupal.quickedit.collections.entities;
  var entityModel = entityCollection.get('{<span class="php-variable">$entity_page_id</span>}');
  return entityModel.get('fields').reduce(function (result, fieldModel) {
    result[fieldModel.get('fieldID')] = fieldModel.get('state');
    return result;
  }, {});
}()
JS;
        $this->assertEquals($expected_field_states, $this->getSession()
            ->evaluateScript($js_get_all_field_states_for_entity));
        // Assert that those fields also have the appropriate DOM decorations.
        $expected_field_attributes = [];
        foreach ($expected_field_states as $quickedit_field_id => $expected_field_state) {
            $expected_field_attributes[$quickedit_field_id] = static::$expectedFieldStateAttributes[$expected_field_state];
        }
        $this->assertEntityInstanceFieldMarkup($entity_type_id, $entity_id, $entity_instance_id, $expected_field_attributes);
    }
    
    /**
     * Asserts all in-place editable fields with markup expectations.
     *
     * @param string $entity_type_id
     *   The entity type ID.
     * @param int $entity_id
     *   The entity ID.
     * @param int $entity_instance_id
     *   The entity instance ID. (Instance on the page.)
     * @param array $expected_field_attributes
     *   Must describe the expected markup attributes for all given in-place
     *   editable fields.
     */
    protected function assertEntityInstanceFieldMarkup($entity_type_id, $entity_id, $entity_instance_id, array $expected_field_attributes) {
        $entity_page_id = $entity_type_id . '/' . $entity_id . '[' . $entity_instance_id . ']';
        $expected_field_attributes_json = json_encode($expected_field_attributes);
        $js_match_field_element_attributes = <<<JS
function () {
  var expectations = {<span class="php-variable">$expected_field_attributes_json</span>};
  var entityCollection = Drupal.quickedit.collections.entities;
  var entityModel = entityCollection.get('{<span class="php-variable">$entity_page_id</span>}');
  return entityModel.get('fields').reduce(function (result, fieldModel) {
    var fieldID = fieldModel.get('fieldID');
    var element = fieldModel.get('el');
    var matches = element.webkitMatchesSelector(expectations[fieldID]);
    result[fieldID] = matches ? matches : element.outerHTML;
    return result;
  }, {});
}()
JS;
        $result = $this->getSession()
            ->evaluateScript($js_match_field_element_attributes);
        foreach ($expected_field_attributes as $quickedit_field_id => $expectation) {
            $this->assertSame(TRUE, $result[$quickedit_field_id], 'Field ' . $quickedit_field_id . ' did not match its expectation selector (' . $expectation . '), actual HTML: ' . $result[$quickedit_field_id]);
        }
    }
    
    /**
     * Simulates typing in a 'plain_text' in-place editor.
     *
     * @param string $css_selector
     *   The CSS selector to find the DOM element (with the 'contenteditable=true'
     *   attribute set), to type in.
     * @param string $text
     *   The text to type.
     *
     * @see \Drupal\quickedit\Plugin\InPlaceEditor\PlainTextEditor
     */
    protected function typeInPlainTextEditor($css_selector, $text) {
        $field = $this->getSession()
            ->getPage()
            ->find('css', $css_selector);
        $field->setValue(Key::END . $text);
    }
    
    /**
     * Simulates typing in an input[type=text] inside a 'form' in-place editor.
     *
     * @param string $input_name
     *   The "name" attribute of the input[type=text] to type in.
     * @param string $text
     *   The text to type.
     *
     * @see \Drupal\quickedit\Plugin\InPlaceEditor\FormEditor
     */
    protected function typeInFormEditorTextInputField($input_name, $text) {
        $input = $this->cssSelect('.quickedit-form-container > .quickedit-form[role="dialog"] form.quickedit-field-form input[type=text][name="' . $input_name . '"]')[0];
        $input->setValue($text);
        $js_simulate_user_typing = <<<JS
function () {
  var el = document.querySelector('.quickedit-form-container > .quickedit-form[role="dialog"] form.quickedit-field-form input[name="{<span class="php-variable">$input_name</span>}"]');
  window.jQuery(el).trigger('formUpdated');
}()
JS;
        $this->getSession()
            ->evaluateScript($js_simulate_user_typing);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
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 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::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::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
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. 39
BrowserTestBase::$root protected property The app root.
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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUp protected function 475
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
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
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
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. 2
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.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
QuickEditJavascriptTestBase::$contentAuthorUser protected property A user with permissions to edit Articles and use Quick Edit. 3
QuickEditJavascriptTestBase::$expectedFieldStateAttributes protected static property
QuickEditJavascriptTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 4
QuickEditJavascriptTestBase::assertEntityInstanceFieldMarkup protected function Asserts all in-place editable fields with markup expectations. 1
QuickEditJavascriptTestBase::assertEntityInstanceFieldStates protected function Asserts all FieldModels for the given entity instance. 1
QuickEditJavascriptTestBase::assertEntityInstanceStates protected function Asserts all EntityModels (entity instances) on the page.
QuickEditJavascriptTestBase::assertQuickEditEntityToolbar protected function Asserts the state of the Quick Edit entity toolbar.
QuickEditJavascriptTestBase::awaitEntityInstanceFieldState protected function Awaits a particular field instance to reach a particular state.
QuickEditJavascriptTestBase::awaitQuickEditForEntity protected function Awaits Quick Edit to be initiated for all instances of the given entity.
QuickEditJavascriptTestBase::saveQuickEdit protected function Clicks the &#039;Save&#039; button in the Quick Edit entity toolbar.
QuickEditJavascriptTestBase::startQuickEditViaToolbar protected function Starts in-place editing of the given entity instance.
QuickEditJavascriptTestBase::typeInFormEditorTextInputField protected function Simulates typing in an input[type=text] inside a &#039;form&#039; in-place editor.
QuickEditJavascriptTestBase::typeInPlainTextEditor protected function Simulates typing in a &#039;plain_text&#039; in-place editor.
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. 3
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. 1
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.
TestSetupTrait::$container protected property The dependency injection container used in the test.
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::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
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. 2
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::buildUrl protected function Builds an a 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::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::drupalPostForm 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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can
be overridden in a derived class so it is possible to use a different
value for a subset of tests, e.g. the JavaScript tests.
Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
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.