class WidgetOEmbedTest
Same name in other branches
- 8.9.x core/modules/media_library/tests/src/FunctionalJavascript/WidgetOEmbedTest.php \Drupal\Tests\media_library\FunctionalJavascript\WidgetOEmbedTest
- 10 core/modules/media_library/tests/src/FunctionalJavascript/WidgetOEmbedTest.php \Drupal\Tests\media_library\FunctionalJavascript\WidgetOEmbedTest
- 11.x core/modules/media_library/tests/src/FunctionalJavascript/WidgetOEmbedTest.php \Drupal\Tests\media_library\FunctionalJavascript\WidgetOEmbedTest
Tests that oEmbed media can be added in the Media library's widget.
@group media_library
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\Tests\media_library\FunctionalJavascript\WidgetOEmbedTest extends \Drupal\Tests\media_library\FunctionalJavascript\MediaLibraryTestBase uses \Drupal\Tests\media\Traits\OEmbedTestTrait
- class \Drupal\Tests\media_library\FunctionalJavascript\MediaLibraryTestBase extends \Drupal\FunctionalJavascriptTests\WebDriverTestBase
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of WidgetOEmbedTest
File
-
core/
modules/ media_library/ tests/ src/ FunctionalJavascript/ WidgetOEmbedTest.php, line 14
Namespace
Drupal\Tests\media_library\FunctionalJavascriptView source
class WidgetOEmbedTest extends MediaLibraryTestBase {
use OEmbedTestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'media_test_oembed',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->lockHttpClientToFixtures();
$this->hijackProviderEndpoints();
// Create a user who can use the Media library.
$user = $this->drupalCreateUser([
'access content',
'create basic_page content',
'view media',
'create media',
'administer media',
]);
$this->drupalLogin($user);
}
/**
* Tests that oEmbed media can be added in the Media library's widget.
*/
public function testWidgetOEmbed() {
$this->hijackProviderEndpoints();
$assert_session = $this->assertSession();
$page = $this->getSession()
->getPage();
$youtube_title = "Everyday I'm Drupalin' Drupal Rap (Rick Ross - Hustlin)";
$youtube_url = 'https://www.youtube.com/watch?v=PWjcqE3QKBg';
$vimeo_title = "Drupal Rap Video - Schipulcon09";
$vimeo_url = 'https://vimeo.com/7073899';
ResourceController::setResourceUrl($youtube_url, $this->getFixturesDirectory() . '/video_youtube.json');
ResourceController::setResourceUrl($vimeo_url, $this->getFixturesDirectory() . '/video_vimeo.json');
ResourceController::setResource404('https://www.youtube.com/watch?v=PWjcqE3QKBg1');
// Visit a node create page.
$this->drupalGet('node/add/basic_page');
// Add to the unlimited media field.
$this->openMediaLibraryForField('field_unlimited_media');
// Assert the default tab for media type one does not have an oEmbed form.
$assert_session->fieldNotExists('Add Type Five via URL');
// Assert other media types don't have the oEmbed form fields.
$this->switchToMediaType('Three');
$assert_session->fieldNotExists('Add Type Five via URL');
// Assert we can add an oEmbed video to media type five.
$this->switchToMediaType('Five');
$page->fillField('Add Type Five via URL', $youtube_url);
$assert_session->pageTextContains('Allowed providers: YouTube, Vimeo.');
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('The media item has been created but has not yet been saved.');
// There is no other selected media and this is not the advanced ui.
// Assert that the Additional selected media element does not appear.
$assert_session->pageTextNotContains('Additional selected media');
$assert_session->elementNotExists('css', '[data-drupal-selector="edit-selection"]');
// Assert the name field contains the remote video title.
$assert_session->fieldValueEquals('Name', $youtube_title);
$this->pressSaveButton();
$this->waitForText('Add Type Five via URL');
// Load the created media item.
$media_items = Media::loadMultiple();
$added_media = array_pop($media_items);
// Ensure the media item was saved to the library and automatically
// selected. The added media items should be in the first position of the
// add form.
$assert_session->pageTextContains('Add or select media');
$assert_session->pageTextContains($youtube_title);
$assert_session->fieldValueEquals('media_library_select_form[0]', $added_media->id());
$assert_session->checkboxChecked('media_library_select_form[0]');
// Assert the created oEmbed video is correctly added to the widget.
$this->pressInsertSelected('Added one media item.');
$this->waitForText($youtube_title);
// Open the media library again for the unlimited field and go to the tab
// for media type five.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
// Assert the video is available on the tab.
$assert_session->pageTextContains($youtube_title);
// Assert we can only add supported URLs.
$page->fillField('Add Type Five via URL', 'https://www.youtube.com/');
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('No matching provider found.');
// Assert we can not add a video ID that doesn't exist. We need to use a
// video ID that will not be filtered by the regex, because otherwise the
// message 'No matching provider found.' will be returned.
$page->fillField('Add Type Five via URL', 'https://www.youtube.com/watch?v=PWjcqE3QKBg1');
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('Could not retrieve the oEmbed resource.');
// Select a media item to check if the selection is persisted when adding
// new items.
$checkbox = $page->findField("Select {$youtube_title}");
$selected_item_id = $checkbox->getAttribute('value');
$checkbox->click();
$assert_session->pageTextContains('1 item selected');
$assert_session->hiddenFieldValueEquals('current_selection', $selected_item_id);
// Assert we can add a oEmbed video with a custom name.
$page->fillField('Add Type Five via URL', $youtube_url);
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('The media item has been created but has not yet been saved.');
$page->fillField('Name', 'Custom video title');
// The non-advanced ui should not show the Additional selected media.
$assert_session->pageTextNotContains('Additional selected media');
$assert_session->elementNotExists('css', '[data-drupal-selector="edit-selection"]');
$this->pressSaveButton();
// Load the created media item.
$media_items = Media::loadMultiple();
$added_media = array_pop($media_items);
// Ensure the media item was saved to the library and automatically
// selected. The added media items should be in the first position of the
// add form.
$assert_session->pageTextContains('Add or select media');
$assert_session->pageTextContains('Custom video title');
$assert_session->fieldValueEquals('media_library_select_form[0]', $added_media->id());
$assert_session->checkboxChecked('media_library_select_form[0]');
// Assert the item that was selected before uploading the file is still
// selected.
$assert_session->pageTextContains('2 items selected');
$assert_session->checkboxChecked("Select Custom video title");
$assert_session->checkboxChecked("Select {$youtube_title}");
$assert_session->hiddenFieldValueEquals('current_selection', implode(',', [
$selected_item_id,
$added_media->id(),
]));
$selected_checkboxes = [];
foreach ($this->getCheckboxes() as $checkbox) {
if ($checkbox->isChecked()) {
$selected_checkboxes[] = $checkbox->getAttribute('value');
}
}
$this->assertCount(2, $selected_checkboxes);
// Ensure the created item is added in the widget.
$this->pressInsertSelected('Added 2 media items.');
$this->waitForText('Custom video title');
// Assert we can directly insert added oEmbed media in the widget.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
$page->fillField('Add Type Five via URL', $vimeo_url);
$page->pressButton('Add');
$this->waitForText('The media item has been created but has not yet been saved.');
$this->pressSaveButton();
$this->waitForText('Add or select media');
$this->pressInsertSelected();
$this->waitForText($vimeo_title);
// Assert we can remove selected items from the selection area in the oEmbed
// form.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
$checkbox = $page->findField("Select {$vimeo_title}");
$selected_item_id = $checkbox->getAttribute('value');
$checkbox->click();
$assert_session->hiddenFieldValueEquals('current_selection', $selected_item_id);
$page->fillField('Add Type Five via URL', $youtube_url);
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('The media item has been created but has not yet been saved');
$page->fillField('Name', 'Another video');
$this->pressSaveButton();
$page->uncheckField('media_library_select_form[1]');
$this->waitForText('1 item selected');
$this->pressInsertSelected('Added one media item.');
$this->waitForText('Another video');
// Assert removing an added oEmbed media item before save works as expected.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
$page->fillField('Add Type Five via URL', $youtube_url);
$page->pressButton('Add');
// Assert the media item fields are shown and the vertical tabs are no
// longer shown.
$this->assertMediaAdded();
// Press the 'Remove button' and assert the user is sent back to the media
// library.
$page->pressButton('media-0-remove-button');
// Assert the remove message is shown.
$this->waitForText("The media item {$youtube_title} has been removed.");
$this->assertNoMediaAdded();
}
/**
* Tests that oEmbed media can be added in the widget's advanced UI.
*
* @todo Merge this with testWidgetOEmbed() in
* https://www.drupal.org/project/drupal/issues/3087227
*/
public function testWidgetOEmbedAdvancedUi() {
$this->config('media_library.settings')
->set('advanced_ui', TRUE)
->save();
$this->hijackProviderEndpoints();
$assert_session = $this->assertSession();
$page = $this->getSession()
->getPage();
$youtube_title = "Everyday I'm Drupalin' Drupal Rap (Rick Ross - Hustlin)";
$youtube_url = 'https://www.youtube.com/watch?v=PWjcqE3QKBg';
$vimeo_title = "Drupal Rap Video - Schipulcon09";
$vimeo_url = 'https://vimeo.com/7073899';
ResourceController::setResourceUrl($youtube_url, $this->getFixturesDirectory() . '/video_youtube.json');
ResourceController::setResourceUrl($vimeo_url, $this->getFixturesDirectory() . '/video_vimeo.json');
ResourceController::setResource404('https://www.youtube.com/watch?v=PWjcqE3QKBg1');
// Visit a node create page.
$this->drupalGet('node/add/basic_page');
// Add to the unlimited media field.
$this->openMediaLibraryForField('field_unlimited_media');
// Assert the default tab for media type one does not have an oEmbed form.
$assert_session->fieldNotExists('Add Type Five via URL');
// Assert other media types don't have the oEmbed form fields.
$this->switchToMediaType('Three');
$assert_session->fieldNotExists('Add Type Five via URL');
// Assert we can add an oEmbed video to media type five.
$this->switchToMediaType('Five');
$page->fillField('Add Type Five via URL', $youtube_url);
$assert_session->pageTextContains('Allowed providers: YouTube, Vimeo.');
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('The media item has been created but has not yet been saved.');
// Assert that Additional selected media does not appear.
$assert_session->pageTextNotContains('Additional selected media');
$assert_session->elementNotExists('css', '[data-drupal-selector="edit-selection"]');
// Assert the name field contains the remote video title.
$assert_session->fieldValueEquals('Name', $youtube_title);
$this->saveAnd('select');
$this->waitForText('Add Type Five via URL');
// Load the created media item.
$media_items = Media::loadMultiple();
$added_media = array_pop($media_items);
// Ensure the media item was saved to the library and automatically
// selected. The added media items should be in the first position of the
// add form.
$assert_session->pageTextContains('Add or select media');
$assert_session->pageTextContains($youtube_title);
$assert_session->fieldValueEquals('media_library_select_form[0]', $added_media->id());
$assert_session->checkboxChecked('media_library_select_form[0]');
// Assert the created oEmbed video is correctly added to the widget.
$this->pressInsertSelected('Added one media item.');
$this->waitForText($youtube_title);
// Open the media library again for the unlimited field and go to the tab
// for media type five.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
// Assert the video is available on the tab.
$assert_session->pageTextContains($youtube_title);
// Assert we can only add supported URLs.
$page->fillField('Add Type Five via URL', 'https://www.youtube.com/');
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('No matching provider found.');
// Assert we can not add a video ID that doesn't exist. We need to use a
// video ID that will not be filtered by the regex, because otherwise the
// message 'No matching provider found.' will be returned.
$page->fillField('Add Type Five via URL', 'https://www.youtube.com/watch?v=PWjcqE3QKBg1');
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('Could not retrieve the oEmbed resource.');
// Select a media item to check if the selection is persisted when adding
// new items.
$checkbox = $page->findField("Select {$youtube_title}");
$selected_item_id = $checkbox->getAttribute('value');
$checkbox->click();
$assert_session->pageTextContains('1 item selected');
$assert_session->hiddenFieldValueEquals('current_selection', $selected_item_id);
// Assert we can add a oEmbed video with a custom name.
$page->fillField('Add Type Five via URL', $youtube_url);
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('The media item has been created but has not yet been saved.');
// The advanced ui should show the Additional selected media.
$assert_session->pageTextContains('Additional selected media');
$assert_session->elementExists('css', '[data-drupal-selector="edit-selection"]');
$page->fillField('Name', 'Custom video title');
$assert_session->checkboxChecked("Select {$youtube_title}", $this->getSelectionArea());
$this->saveAnd('select');
$this->waitForNoText('Save and select');
// Load the created media item.
$media_items = Media::loadMultiple();
$added_media = array_pop($media_items);
// Ensure the media item was saved to the library and automatically
// selected. The added media items should be in the first position of the
// add form.
$assert_session->pageTextContains('Add or select media');
$assert_session->pageTextContains('Custom video title');
$assert_session->fieldValueEquals('media_library_select_form[0]', $added_media->id());
$assert_session->checkboxChecked('media_library_select_form[0]');
// Assert the item that was selected before uploading the file is still
// selected.
$assert_session->pageTextContains('2 items selected');
$assert_session->checkboxChecked("Select Custom video title");
$assert_session->checkboxChecked("Select {$youtube_title}");
$assert_session->hiddenFieldValueEquals('current_selection', implode(',', [
$selected_item_id,
$added_media->id(),
]));
$selected_checkboxes = [];
foreach ($this->getCheckboxes() as $checkbox) {
if ($checkbox->isChecked()) {
$selected_checkboxes[] = $checkbox->getAttribute('value');
}
}
$this->assertCount(2, $selected_checkboxes);
// Ensure the created item is added in the widget.
$this->pressInsertSelected('Added 2 media items.');
$this->waitForText('Custom video title');
// Assert we can directly insert added oEmbed media in the widget.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
$page->fillField('Add Type Five via URL', $vimeo_url);
$page->pressButton('Add');
$this->waitForText('The media item has been created but has not yet been saved.');
$this->saveAnd('insert');
$this->waitForText('Added one media item.');
$this->waitForNoText('Add or select media');
$this->waitForText($vimeo_title);
// Assert we can remove selected items from the selection area in the oEmbed
// form.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
$checkbox = $page->findField("Select {$vimeo_title}");
$selected_item_id = $checkbox->getAttribute('value');
$checkbox->click();
$assert_session->hiddenFieldValueEquals('current_selection', $selected_item_id);
$page->fillField('Add Type Five via URL', $youtube_url);
$page->pressButton('Add');
// assertWaitOnAjaxRequest() required for input "id" attributes to
// consistently match their label's "for" attribute.
$assert_session->assertWaitOnAjaxRequest();
$this->waitForText('The media item has been created but has not yet been saved');
$page->fillField('Name', 'Another video');
$selection_area = $this->getSelectionArea();
$assert_session->checkboxChecked("Select {$vimeo_title}", $selection_area);
$page->uncheckField("Select {$vimeo_title}");
$assert_session->hiddenFieldValueEquals('current_selection', '');
// Close the details element so that clicking the Save and select works.
// @todo Fix dialog or test so this is not necessary to prevent random
// fails. https://www.drupal.org/project/drupal/issues/3055648
$selection_area->find('css', 'summary')
->click();
$this->saveAnd('select');
$media_items = Media::loadMultiple();
$added_media = array_pop($media_items);
$this->waitForText('1 item selected');
$assert_session->checkboxChecked('Select Another video');
$assert_session->checkboxNotChecked("Select {$vimeo_title}");
$assert_session->hiddenFieldValueEquals('current_selection', $added_media->id());
$this->pressInsertSelected('Added one media item.');
$this->waitForText('Another video');
// Assert removing an added oEmbed media item before save works as expected.
$this->openMediaLibraryForField('field_unlimited_media');
$this->switchToMediaType('Five');
$page->fillField('Add Type Five via URL', $youtube_url);
$page->pressButton('Add');
// Assert the media item fields are shown and the vertical tabs are no
// longer shown.
$this->assertMediaAdded();
// Press the 'Remove button' and assert the user is sent back to the media
// library.
$page->pressButton('media-0-remove-button');
// Assert the remove message is shown.
$this->waitForText("The media item {$youtube_title} has been removed.");
$this->assertNoMediaAdded();
}
}
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::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::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 | |||
OEmbedTestTrait::getFixturesDirectory | protected | function | Returns the relative path to the oEmbed fixtures directory. | ||||
OEmbedTestTrait::getFixturesUrl | protected | function | Returns the absolute URL of the oEmbed fixtures directory. | ||||
OEmbedTestTrait::hijackProviderEndpoints | protected | function | Ensures that oEmbed provider endpoints use the test resource route. | ||||
OEmbedTestTrait::lockHttpClientToFixtures | protected | function | Configures the HTTP client to always use the fixtures directory. | ||||
OEmbedTestTrait::useFixtureProviders | protected | function | Forces Media to use the provider database in the fixtures directory. | ||||
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 | Mink class for the default driver to use. | Overrides BrowserTestBase::$minkDefaultDriverClass | |||
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 | |||
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 | Gets the Mink driver args from an environment variable. | 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 | |||
WebDriverTestBase::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | Overrides FunctionalTestSetupTrait::installModulesFromClassProperty | |||
WebDriverTestBase::tearDown | protected | function | Overrides BrowserTestBase::tearDown | 1 | |||
WidgetOEmbedTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides MediaLibraryTestBase::$defaultTheme | |||
WidgetOEmbedTest::$modules | protected static | property | Modules to enable. | Overrides MediaLibraryTestBase::$modules | |||
WidgetOEmbedTest::setUp | protected | function | Overrides BrowserTestBase::setUp | ||||
WidgetOEmbedTest::testWidgetOEmbed | public | function | Tests that oEmbed media can be added in the Media library's widget. | ||||
WidgetOEmbedTest::testWidgetOEmbedAdvancedUi | public | function | Tests that oEmbed media can be added in the widget's advanced UI. | ||||
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.