class MediaLibraryTestBase
Same name in other branches
- 8.9.x core/modules/media_library/tests/src/FunctionalJavascript/MediaLibraryTestBase.php \Drupal\Tests\media_library\FunctionalJavascript\MediaLibraryTestBase
- 10 core/modules/media_library/tests/src/FunctionalJavascript/MediaLibraryTestBase.php \Drupal\Tests\media_library\FunctionalJavascript\MediaLibraryTestBase
- 11.x core/modules/media_library/tests/src/FunctionalJavascript/MediaLibraryTestBase.php \Drupal\Tests\media_library\FunctionalJavascript\MediaLibraryTestBase
Base class for functional tests of Media Library functionality.
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\FunctionalTests\AssertLegacyTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase extends \Drupal\Tests\BrowserTestBase
- class \Drupal\Tests\media_library\FunctionalJavascript\MediaLibraryTestBase extends \Drupal\FunctionalJavascriptTests\WebDriverTestBase
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of MediaLibraryTestBase
File
-
core/
modules/ media_library/ tests/ src/ FunctionalJavascript/ MediaLibraryTestBase.php, line 11
Namespace
Drupal\Tests\media_library\FunctionalJavascriptView source
abstract class MediaLibraryTestBase extends WebDriverTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'media_library_test',
'hold_test',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* Create media items.
*
* @param array $media_items
* A nested array of media item names keyed by media type.
*
* @return \Drupal\media\MediaInterface[]
* An array of media entities keyed by the names passed in.
*/
protected function createMediaItems(array $media_items) {
$created_items = [];
$time = time();
foreach ($media_items as $type => $names) {
foreach ($names as $name) {
/** @var \Drupal\media\MediaInterface $media */
$media = Media::create([
'name' => $name,
'bundle' => $type,
]);
$source_field = $media->getSource()
->getSourceFieldDefinition($media->bundle->entity)
->getName();
$media->set($source_field, $name)
->setCreatedTime(++$time)
->save();
$created_items[$name] = $media;
}
}
return $created_items;
}
/**
* Asserts that text appears on page after a wait.
*
* @param string $text
* The text that should appear on the page.
* @param int $timeout
* Timeout in milliseconds, defaults to 10000.
*
* @todo replace with whatever gets added in
* https://www.drupal.org/node/3061852
*/
protected function waitForText($text, $timeout = 10000) {
$result = $this->assertSession()
->waitForText($text, $timeout);
$this->assertNotEmpty($result, "\"{$text}\" not found");
}
/**
* Asserts that text does not appear on page after a wait.
*
* @param string $text
* The text that should not be on the page.
* @param int $timeout
* Timeout in milliseconds, defaults to 10000.
*
* @todo replace with whatever gets added in
* https://www.drupal.org/node/3061852
*/
protected function waitForNoText($text, $timeout = 10000) {
$page = $this->getSession()
->getPage();
$result = $page->waitFor($timeout / 1000, function ($page) use ($text) {
$actual = preg_replace('/\\s+/u', ' ', $page->getText());
$regex = '/' . preg_quote($text, '/') . '/ui';
return (bool) (!preg_match($regex, $actual));
});
$this->assertNotEmpty($result, "\"{$text}\" was found but shouldn't be there.");
}
/**
* Checks for a specified number of specific elements on page after wait.
*
* @param string $selector_type
* Element selector type (css, xpath)
* @param string|array $selector
* Element selector.
* @param int $count
* Expected count.
* @param int $timeout
* Timeout in milliseconds, defaults to 10000.
*
* @todo replace with whatever gets added in
* https://www.drupal.org/node/3061852
*/
protected function waitForElementsCount($selector_type, $selector, $count, $timeout = 10000) {
$page = $this->getSession()
->getPage();
$start = microtime(TRUE);
$end = $start + $timeout / 1000;
do {
$nodes = $page->findAll($selector_type, $selector);
if (count($nodes) === $count) {
return;
}
usleep(100000);
} while (microtime(TRUE) < $end);
$this->assertSession()
->elementsCount($selector_type, $selector, $count);
}
/**
* Asserts that text appears in an element after a wait.
*
* @param string $selector
* The CSS selector of the element to check.
* @param string $text
* The text that should appear in the element.
* @param int $timeout
* Timeout in milliseconds, defaults to 10000.
*
* @todo replace with whatever gets added in
* https://www.drupal.org/node/3061852
*/
protected function waitForElementTextContains($selector, $text, $timeout = 10000) {
$element = $this->assertSession()
->waitForElement('css', "{$selector}:contains('{$text}')", $timeout);
$this->assertNotEmpty($element);
}
/**
* Waits for the specified selector and returns it if not empty.
*
* @param string $selector
* The selector engine name. See ElementInterface::findAll() for the
* supported selectors.
* @param string|array $locator
* The selector locator.
* @param int $timeout
* Timeout in milliseconds, defaults to 10000.
*
* @return \Behat\Mink\Element\NodeElement
* The page element node if found. If not found, the test fails.
*
* @todo replace with whatever gets added in
* https://www.drupal.org/node/3061852
*/
protected function assertElementExistsAfterWait($selector, $locator, $timeout = 10000) {
$element = $this->assertSession()
->waitForElement($selector, $locator, $timeout);
$this->assertNotEmpty($element);
return $element;
}
/**
* Gets the menu of available media types.
*
* @return \Behat\Mink\Element\NodeElement
* The menu of available media types.
*/
protected function getTypesMenu() {
return $this->assertSession()
->elementExists('css', '.js-media-library-menu');
}
/**
* Clicks a media type tab and waits for it to appear.
*/
protected function switchToMediaType($type) {
$link = $this->assertSession()
->elementExists('named', [
'link',
"Type {$type}",
], $this->getTypesMenu());
if ($link->hasClass('active')) {
// There is nothing to do as the type is already active.
return;
}
$link->click();
$result = $link->waitFor(10, function ($link) {
/** @var \Behat\Mink\Element\NodeElement $link */
return $link->hasClass('active');
});
$this->assertNotEmpty($result);
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$this->assertSession()
->assertWaitOnAjaxRequest();
}
/**
* Checks for the existence of a field on page after wait.
*
* @param string $field
* The field to find.
* @param int $timeout
* Timeout in milliseconds, defaults to 10000.
*
* @return \Behat\Mink\Element\NodeElement|null
* The element if found, otherwise null.
*
* @todo replace with whatever gets added in
* https://www.drupal.org/node/3061852
*/
protected function waitForFieldExists($field, $timeout = 10000) {
$assert_session = $this->assertSession();
$assert_session->waitForField($field, $timeout);
return $assert_session->fieldExists($field);
}
/**
* Waits for a file field to exist before uploading.
*/
public function addMediaFileToField($locator, $path) {
$page = $this->getSession()
->getPage();
$this->waitForFieldExists($locator);
$page->attachFileToField($locator, $path);
}
/**
* Clicks "Save and select||insert" button and waits for AJAX completion.
*
* @param string $operation
* The final word of the button to be clicked.
*/
protected function saveAnd($operation) {
$this->assertElementExistsAfterWait('css', '.ui-dialog-buttonpane')
->pressButton("Save and {$operation}");
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$this->assertSession()
->assertWaitOnAjaxRequest();
}
/**
* Clicks "Save" button and waits for AJAX completion.
*
* @param bool $expect_errors
* Whether validation errors are expected after the "Save" button is
* pressed. Defaults to FALSE.
*/
protected function pressSaveButton($expect_errors = FALSE) {
$buttons = $this->assertElementExistsAfterWait('css', '.ui-dialog-buttonpane');
$buttons->pressButton('Save');
// If no validation errors are expected, wait for the "Insert selected"
// button to return.
if (!$expect_errors) {
$result = $buttons->waitFor(10, function ($buttons) {
/** @var \Behat\Mink\Element\NodeElement $buttons */
return $buttons->findButton('Insert selected');
});
$this->assertNotEmpty($result);
}
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$this->assertSession()
->assertWaitOnAjaxRequest();
}
/**
* Clicks a button that opens a media widget and confirms it is open.
*
* @param string $field_name
* The machine name of the field for which to open the media library.
* @param string $after_open_selector
* The selector to look for after the button is clicked.
*
* @return \Behat\Mink\Element\NodeElement
* The NodeElement found via $after_open_selector.
*/
protected function openMediaLibraryForField($field_name, $after_open_selector = '.js-media-library-menu') {
$this->assertElementExistsAfterWait('css', "#{$field_name}-media-library-wrapper.js-media-library-widget")
->pressButton('Add media');
$this->waitForText('Add or select media');
// Assert that the grid display is visible and the links to toggle between
// the grid and table displays are present.
$this->assertMediaLibraryGrid();
$assert_session = $this->assertSession();
$assert_session->linkExists('Grid');
$assert_session->linkExists('Table');
// The "select all" checkbox should never be present in the modal.
$assert_session->elementNotExists('css', '.media-library-select-all');
return $this->assertElementExistsAfterWait('css', $after_open_selector);
}
/**
* Gets the "Additional selected media" area after adding new media.
*
* @param bool $open
* Whether or not to open the area before returning it. Defaults to TRUE.
*
* @return \Behat\Mink\Element\NodeElement
* The "additional selected media" area.
*/
protected function getSelectionArea($open = TRUE) {
$summary = $this->assertElementExistsAfterWait('css', 'summary:contains("Additional selected media")');
if ($open) {
$summary->click();
}
return $summary->getParent();
}
/**
* Asserts a media item was added, but not yet saved.
*
* @param int $index
* (optional) The index of the media item, if multiple items can be added at
* once. Defaults to 0.
*/
protected function assertMediaAdded($index = 0) {
$selector = '.js-media-library-add-form-added-media';
// Assert that focus is shifted to the new media items.
$this->assertJsCondition('jQuery("' . $selector . '").is(":focus")');
$assert_session = $this->assertSession();
$assert_session->pageTextMatches('/The media items? ha(s|ve) been created but ha(s|ve) not yet been saved. Fill in any required fields and save to add (it|them) to the media library./');
$assert_session->elementAttributeContains('css', $selector, 'aria-label', 'Added media items');
$fields = $this->assertElementExistsAfterWait('css', '[data-drupal-selector="edit-media-' . $index . '-fields"]');
$assert_session->elementNotExists('css', '.js-media-library-menu');
// Assert extraneous components were removed in
// FileUploadForm::hideExtraSourceFieldComponents().
$assert_session->elementNotExists('css', '[data-drupal-selector$="preview"]', $fields);
$assert_session->buttonNotExists('Remove', $fields);
$assert_session->elementNotExists('css', '[data-drupal-selector$="filename"]', $fields);
}
/**
* Asserts that media was not added, i.e. due to a validation error.
*/
protected function assertNoMediaAdded() {
// Assert the focus is shifted to the first tabbable element of the add
// form, which should be the source field.
$this->assertJsCondition('jQuery(tabbable.tabbable(document.getElementById("media-library-add-form-wrapper"))[0]).is(":focus")');
$this->assertSession()
->elementNotExists('css', '[data-drupal-selector="edit-media-0-fields"]');
$this->getTypesMenu();
}
/**
* Presses the modal's "Insert selected" button.
*
* @param string $expected_announcement
* (optional) The expected screen reader announcement once the modal is
* closed.
*
* @todo Consider requiring screen reader assertion every time "Insert
* selected" is pressed in
* https://www.drupal.org/project/drupal/issues/3087227.
*/
protected function pressInsertSelected($expected_announcement = NULL) {
$this->assertSession()
->elementExists('css', '.ui-dialog-buttonpane')
->pressButton('Insert selected');
$this->waitForNoText('Add or select media');
if ($expected_announcement) {
$this->waitForText($expected_announcement);
}
}
/**
* Gets all available media item checkboxes.
*
* @return \Behat\Mink\Element\NodeElement[]
* The available checkboxes.
*/
protected function getCheckboxes() {
return $this->getSession()
->getPage()
->findAll('css', '.js-media-library-view .js-click-to-select-checkbox input');
}
/**
* Selects an item in the media library modal.
*
* @param int $index
* The zero-based index of the item to select.
* @param string $expected_selected_count
* (optional) The expected text of the selection counter.
*/
protected function selectMediaItem($index, $expected_selected_count = NULL) {
$checkboxes = $this->getCheckboxes();
$this->assertGreaterThan($index, count($checkboxes));
$checkboxes[$index]->check();
if ($expected_selected_count) {
$this->assertSelectedMediaCount($expected_selected_count);
}
}
/**
* Switches to the grid display of the widget view.
*/
protected function switchToMediaLibraryGrid() {
$this->getSession()
->getPage()
->clickLink('Grid');
// Assert the display change is correctly announced for screen readers.
$this->waitForText('Loading grid view.');
$this->waitForText('Changed to grid view.');
$this->assertMediaLibraryGrid();
}
/**
* Switches to the table display of the widget view.
*/
protected function switchToMediaLibraryTable() {
hold_test_response(TRUE);
$this->getSession()
->getPage()
->clickLink('Table');
// Assert the display change is correctly announced for screen readers.
$this->waitForText('Loading table view.');
hold_test_response(FALSE);
$this->waitForText('Changed to table view.');
$this->assertMediaLibraryTable();
}
/**
* Asserts that the grid display of the widget view is visible.
*/
protected function assertMediaLibraryGrid() {
$this->assertSession()
->elementExists('css', '.js-media-library-view[data-view-display-id="widget"]');
}
/**
* Asserts that the table display of the widget view is visible.
*/
protected function assertMediaLibraryTable() {
$this->assertSession()
->elementExists('css', '.js-media-library-view[data-view-display-id="widget_table"]');
}
/**
* Asserts the current text of the selected item counter.
*
* @param string $text
* The expected text of the counter.
*/
protected function assertSelectedMediaCount($text) {
$selected_count = $this->assertSession()
->elementExists('css', '.js-media-library-selected-count');
$this->assertSame('status', $selected_count->getAttribute('role'));
$this->assertSame('polite', $selected_count->getAttribute('aria-live'));
$this->assertSame('true', $selected_count->getAttribute('aria-atomic'));
$this->assertSame($text, $selected_count->getText());
}
}
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'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 | ||||
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::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::$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::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::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 | 511 | ||||
BrowserTestBase::setUpAppRoot | protected | function | Sets up the root application path. | ||||
BrowserTestBase::setUpBeforeClass | public static | function | 1 | ||||
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 | ||
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::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::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 | |||
MediaLibraryTestBase::$defaultTheme | protected | property | Overrides BrowserTestBase::$defaultTheme | 10 | |||
MediaLibraryTestBase::$modules | protected static | property | Overrides BrowserTestBase::$modules | 6 | |||
MediaLibraryTestBase::addMediaFileToField | public | function | Waits for a file field to exist before uploading. | ||||
MediaLibraryTestBase::assertElementExistsAfterWait | protected | function | Waits for the specified selector and returns it if not empty. | ||||
MediaLibraryTestBase::assertMediaAdded | protected | function | Asserts a media item was added, but not yet saved. | ||||
MediaLibraryTestBase::assertMediaLibraryGrid | protected | function | Asserts that the grid display of the widget view is visible. | ||||
MediaLibraryTestBase::assertMediaLibraryTable | protected | function | Asserts that the table display of the widget view is visible. | ||||
MediaLibraryTestBase::assertNoMediaAdded | protected | function | Asserts that media was not added, i.e. due to a validation error. | ||||
MediaLibraryTestBase::assertSelectedMediaCount | protected | function | Asserts the current text of the selected item counter. | ||||
MediaLibraryTestBase::createMediaItems | protected | function | Create media items. | ||||
MediaLibraryTestBase::getCheckboxes | protected | function | Gets all available media item checkboxes. | ||||
MediaLibraryTestBase::getSelectionArea | protected | function | Gets the "Additional selected media" area after adding new media. | ||||
MediaLibraryTestBase::getTypesMenu | protected | function | Gets the menu of available media types. | ||||
MediaLibraryTestBase::openMediaLibraryForField | protected | function | Clicks a button that opens a media widget and confirms it is open. | ||||
MediaLibraryTestBase::pressInsertSelected | protected | function | Presses the modal's "Insert selected" button. | ||||
MediaLibraryTestBase::pressSaveButton | protected | function | Clicks "Save" button and waits for AJAX completion. | ||||
MediaLibraryTestBase::saveAnd | protected | function | Clicks "Save and select||insert" button and waits for AJAX completion. | ||||
MediaLibraryTestBase::selectMediaItem | protected | function | Selects an item in the media library modal. | ||||
MediaLibraryTestBase::switchToMediaLibraryGrid | protected | function | Switches to the grid display of the widget view. | ||||
MediaLibraryTestBase::switchToMediaLibraryTable | protected | function | Switches to the table display of the widget view. | ||||
MediaLibraryTestBase::switchToMediaType | protected | function | Clicks a media type tab and waits for it to appear. | ||||
MediaLibraryTestBase::waitForElementsCount | protected | function | Checks for a specified number of specific elements on page after wait. | ||||
MediaLibraryTestBase::waitForElementTextContains | protected | function | Asserts that text appears in an element after a wait. | ||||
MediaLibraryTestBase::waitForFieldExists | protected | function | Checks for the existence of a field on page after wait. | ||||
MediaLibraryTestBase::waitForNoText | protected | function | Asserts that text does not appear on page after a wait. | ||||
MediaLibraryTestBase::waitForText | protected | function | Asserts that text appears on page after a wait. | ||||
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::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. | 2 | |||
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. | ||||
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::$failOnJavascriptConsoleErrors | protected | property | Determines if a test should fail on JavaScript console errors. | 3 | |||
WebDriverTestBase::$minkDefaultDriverClass | protected | property | Overrides BrowserTestBase::$minkDefaultDriverClass | ||||
WebDriverTestBase::assertJsCondition | protected | function | Waits for the given time or until the given JS condition becomes TRUE. | ||||
WebDriverTestBase::assertSession | public | function | Overrides UiHelperTrait::assertSession | ||||
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 | Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders | ||||
WebDriverTestBase::getMinkDriverArgs | protected | function | Overrides BrowserTestBase::getMinkDriverArgs | ||||
WebDriverTestBase::initFrontPage | protected | function | Overrides BrowserTestBase::initFrontPage | ||||
WebDriverTestBase::initMink | protected | function | Overrides BrowserTestBase::initMink | ||||
WebDriverTestBase::installModulesFromClassProperty | protected | function | 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.