From f4a1c0201ed7d87502bbcf3eb10beccecae67f10 Mon Sep 17 00:00:00 2001
From: Adam G-H <32250-phenaproxima@users.noreply.drupalcode.org>
Date: Fri, 21 Feb 2025 19:11:45 +0000
Subject: [PATCH] Issue #3508090 by phenaproxima, tim.plunkett: Add
assertElementIsVisible() as a more assertive waitForElementVisible()
---
.../ProjectBrowserExamplePluginTest.php | 2 +-
.../ProjectBrowserInstallerUiTest.php | 14 +-
.../ProjectBrowserPluginTest.php | 10 +-
.../ProjectBrowserUiTest.php | 124 ++++++++----------
.../ProjectBrowserUiTestJsonApi.php | 22 ++--
.../ProjectBrowserUiTestTrait.php | 15 +++
6 files changed, 92 insertions(+), 95 deletions(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php b/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
index 8265c2911..29c01642e 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
@@ -51,7 +51,7 @@ class ProjectBrowserExamplePluginTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_source_example');
$this->svelteInitHelper('css', '#project-browser .pb-project--grid');
$this->assertEquals('Grid', $this->getElementText('#project-browser .pb-display__button[value="Grid"]'));
- $assert_session->waitForElementVisible('css', '#project-browser .pb-project');
+ $this->assertElementIsVisible('css', '#project-browser .pb-project');
$this->assertTrue($assert_session->waitForText('Project 1'));
$assert_session->pageTextNotContains('No modules found');
$this->svelteInitHelper('css', '.pb-filter__checkbox');
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
index 9673f0e00..eaf989a41 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
@@ -93,13 +93,10 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
* such as via the terminal with Compose or a direct file addition.
*/
public function testInstallModuleAlreadyInFilesystem(): void {
- $assert_session = $this->assertSession();
-
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->waitForProject('Pinky and the Brain')
->pressButton('Install Pinky and the Brain');
- $popup = $assert_session->waitForElementVisible('css', '.project-browser-popup');
- $this->assertNotEmpty($popup);
+ $popup = $this->assertElementIsVisible('css', '.project-browser-popup');
// The Pinky and the Brain module doesn't actually exist in the filesystem,
// but the test activator pretends it does, in order to test the presence
// of the "Install" button as opposed vs. the default "Add and Install"
@@ -123,7 +120,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/recipes');
$this->svelteInitHelper('css', '.pb-projects-list');
$this->inputSearchField('image', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
// Apply a recipe that ships with core.
$card = $this->waitForProject('Image media type');
@@ -133,8 +130,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
// If we reload, the installation status should be remembered.
$this->getSession()->reload();
$this->inputSearchField('image', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")
- ?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$card = $this->waitForProject('Image media type');
$this->waitForProjectToBeInstalled($card);
@@ -144,7 +140,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
$this->markTestSkipped('This test cannot continue because this version of Drupal does not support collecting recipe input.');
}
$this->inputSearchField('test', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->waitForProject('Test Recipe')->pressButton('Install');
$field = $assert_session->waitForField('test_recipe[new_name]');
$this->assertNotEmpty($field);
@@ -152,7 +148,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
$page->pressButton('Continue');
$this->checkForMetaRefresh();
$this->inputSearchField('test', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->waitForProjectToBeInstalled('Test Recipe');
$this->assertSame('Y halo thar!', $this->config('system.site')->get('name'));
}
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
index 6976e05ff..d0ea21375 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
@@ -59,7 +59,7 @@ class ProjectBrowserPluginTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/random_data');
$this->svelteInitHelper('css', '#project-browser .pb-project--grid');
$this->assertEquals('Grid', $this->getElementText('#project-browser .pb-display__button[value="Grid"]'));
- $assert_session->waitForElementVisible('css', '#project-browser .pb-project');
+ $this->assertElementIsVisible('css', '#project-browser .pb-project');
$this->assertTrue($assert_session->waitForText('Results'));
$assert_session->pageTextNotContains('No modules found');
}
@@ -155,15 +155,13 @@ class ProjectBrowserPluginTest extends WebDriverTestBase {
*/
public function testDetailPageRandomDataPlugin(): void {
$assert_session = $this->assertSession();
- $page = $this->getSession()->getPage();
$this->drupalGet('admin/modules/browse/random_data');
- $this->assertNotEmpty($assert_session->waitForElementVisible('css', '#project-browser .pb-project'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project');
$this->assertTrue($assert_session->waitForText('Results'));
- $assert_session->waitForElementVisible('css', '.pb-project .pb-project__title');
- $first_project_selector = $page->find('css', '.pb-project .pb-project__title .pb-project__link');
- $first_project_selector?->click();
+ $this->assertElementIsVisible('css', '.pb-project .pb-project__title .pb-project__link')
+ ->click();
$this->assertTrue($assert_session->waitForText('sites report using this module'));
}
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
index fa833827f..5966812df 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
@@ -75,16 +75,16 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertTrue($assert_session->waitForText('Results'));
$assert_session->pageTextNotContains('No modules found');
$page->pressButton('List');
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--list');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 10);
$page->pressButton('Grid');
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--grid'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--grid');
$this->getSession()->resizeWindow(1100, 1000);
$assert_session->assertNoElementAfterWait('css', '.pb-display__button[value="List"]');
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--list');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 10);
$this->getSession()->resizeWindow(1210, 1210);
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--grid'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--grid');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--grid', 10);
}
@@ -131,9 +131,9 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// @todo Move this into a trait for testing Project Browser's UI in a
// stable, consistent fashion.
- $assert_category_filters_applied = function (array $expected_categories) use ($assert_session): void {
+ $assert_category_filters_applied = function (array $expected_categories): void {
$selector = '.filter-applied__label';
- $this->assertNotEmpty($assert_session->waitForElementVisible('css', $selector));
+ $this->assertElementIsVisible('css', $selector);
$applied_categories = array_map(
fn ($element) => $element->getText(),
$this->getSession()->getPage()->findAll('css', $selector),
@@ -210,12 +210,11 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
*/
public function testReadonlyFields(): void {
$page = $this->getSession()->getPage();
- $assert_session = $this->assertSession();
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('text', 'Helvetica');
- $assert_session->waitForElementVisible('css', '.project__action_button');
- $page->pressButton('View Commands for Helvetica');
+ $this->assertElementIsVisible('named', ['button', 'View Commands for Helvetica'])
+ ->press();
$command_boxes = $page->waitFor(10, fn ($page) => $page->findAll('css', '.command-box textarea[readonly]'));
$this->assertCount(2, $command_boxes);
@@ -337,7 +336,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 12);
$assert_session->waitForText('Modules per page');
$page->selectFieldOption('num-projects', '24');
- $assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list');
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--list');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 24);
}
@@ -543,8 +542,6 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
* Tests search with strings that need URI encoding.
*/
public function testSearchForSpecialChar(): void {
- $assert_session = $this->assertSession();
-
// Clear filters.
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('text', '10 Results');
@@ -553,7 +550,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Fill in the search field.
$this->inputSearchField('', TRUE);
$this->inputSearchField('&', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Vitamin&C;$?',
'Unwritten&:/',
@@ -562,7 +559,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Fill in the search field.
$this->inputSearchField('', TRUE);
$this->inputSearchField('n&', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Vitamin&C;$?',
'Unwritten&:/',
@@ -570,28 +567,28 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->inputSearchField('', TRUE);
$this->inputSearchField('$', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Vitamin&C;$?',
]);
$this->inputSearchField('', TRUE);
$this->inputSearchField('?', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Vitamin&C;$?',
]);
$this->inputSearchField('', TRUE);
$this->inputSearchField('&:', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Unwritten&:/',
]);
$this->inputSearchField('', TRUE);
$this->inputSearchField('$?', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Vitamin&C;$?',
]);
@@ -606,7 +603,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->svelteInitHelper('text', 'Helvetica');
$assert_session->waitForButton('Helvetica')?->click();
// Check the detail modal displays.
- $assert_session->waitForElementVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Helvetica"]');
+ $this->assertElementIsVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Helvetica"]');
$assert_session->elementExists('css', 'button.pb__action_button');
// Close the modal.
$assert_session->waitForButton('Close')?->click();
@@ -622,18 +619,19 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->svelteInitHelper('text', 'Helvetica');
$assert_session->waitForButton('Helvetica')?->click();
// Check the detail modal displays.
- $assert_session->waitForElementVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Helvetica"]');
+ $this->assertElementIsVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Helvetica"]');
$assert_session->elementExists('css', 'button.pb__action_button');
// Close the modal and check it no longer exists.
$assert_session->waitForButton('Close')?->click();
$assert_session->elementNotExists('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Helvetica"]');
// Check that a different module modal can be opened.
$assert_session->waitForButton('Octopus')?->click();
- $assert_session->waitForElementVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Octopus"]');
+ $this->assertElementIsVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Octopus"]');
$assert_session->waitForButton('Close')?->click();
$assert_session->elementNotExists('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Octopus"]');
// Check that first detail modal can be reopened.
- $assert_session->waitForElementVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Helvetica"]');
+ $assert_session->waitForButton('Helvetica')?->click();
+ $this->assertElementIsVisible('xpath', '//span[contains(@class, "ui-dialog-title") and text()="Helvetica"]');
$assert_session->elementExists('css', 'button.pb__action_button');
}
@@ -652,18 +650,18 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->sortBy('z_a');
// Select the active development status filter.
- $assert_session->waitForElementVisible('css', self::DEVELOPMENT_OPTION_SELECTOR);
+ $this->assertElementIsVisible('css', self::DEVELOPMENT_OPTION_SELECTOR);
$this->clickWithWait(self::DEVELOPMENT_OPTION_SELECTOR . self::OPTION_FIRST_CHILD);
// Open category drop-down.
$assert_session->elementExists('css', '.pb-filter__multi-dropdown')?->click();
// Select the E-commerce filter.
- $assert_session->waitForElementVisible('css', '#104');
+ $this->assertElementIsVisible('css', '#104');
$this->clickWithWait('#104', '', TRUE);
// Select the Media filter.
- $assert_session->waitForElementVisible('css', '#67');
+ $this->assertElementIsVisible('css', '#67');
$this->clickWithWait('#67', '', TRUE);
$this->assertTrue($assert_session->waitForText('15 Results'));
@@ -789,7 +787,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->pressWithWait('random_data');
$this->svelteInitHelper('css', '.pb-filter__checkbox');
$assert_session->elementsCount('css', '.pb-filter__multi-dropdown__items > div input', 20);
- $assert_session->waitForElementVisible('css', '#project-browser .pb-project');
+ $this->assertElementIsVisible('css', '#project-browser .pb-project');
$this->assertNotEquals('9 Results Sorted by Active installs', $this->getElementText('.pb-search-results'));
// Switching tab will not change result count.
$this->assertEquals($second_tab_text . ' (active tab)', $page->findButton('random_data')->getText());
@@ -836,7 +834,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->pressWithWait('project_browser_test_mock');
// Filter by search text.
$this->inputSearchField('Number', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertTrue($assert_session->waitForText('2 Results'));
$this->assertProjectsVisible([
'9 Starts With a Higher Number',
@@ -1030,7 +1028,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->svelteInitHelper('css', '.pb-project.pb-project--list');
$this->inputSearchField('inline form errors', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->svelteInitHelper('text', 'Inline Form Errors');
$install_link = $page->find('css', '.pb-layout__main .pb-actions a');
@@ -1039,7 +1037,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertIsString($href);
$this->assertStringEndsWith('/admin/modules#module-inline-form-errors', $href);
$this->drupalGet($href);
- $assert_session->waitForElementVisible('css', "#edit-modules-inline-form-errors-enable");
+ $this->assertElementIsVisible('css', "#edit-modules-inline-form-errors-enable");
$assert_session->assertVisibleInViewport('css', '#edit-modules-inline-form-errors-enable');
}
@@ -1080,7 +1078,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Search for something to change it.
$this->inputSearchField('abcdefghijklmnop', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertTrue($results->waitFor(10, fn (NodeElement $element) => $element->getText() !== $original_text));
// Remove the search text and make sure it auto-updates.
@@ -1096,13 +1094,12 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
*/
public function testSearchClearNoTabIndex(): void {
$page = $this->getSession()->getPage();
- $assert_session = $this->assertSession();
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('css', '.pb-search-results');
// Search and confirm clear button has no focus after tabbing.
$this->inputSearchField('abcdefghijklmnop', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->getSession()->getDriver()->keyPress($page->getXpath(), '9');
$has_focus_id = $this->getSession()->evaluateScript('document.activeElement.id');
@@ -1113,8 +1110,6 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
* Tests that recipes show instructions for applying them.
*/
public function testRecipeInstructions(): void {
- $assert_session = $this->assertSession();
-
$this->config('project_browser.admin_settings')
->set('enabled_sources', ['recipes'])
->save();
@@ -1122,15 +1117,14 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/recipes');
$this->svelteInitHelper('css', '.pb-projects-list');
$this->inputSearchField('image', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
// Look for a recipe that ships with core.
- $card = $assert_session->waitForElementVisible('css', '.pb-project:contains("Image media type")');
- $this->assertNotEmpty($card);
- $assert_session->buttonExists('View Commands', $card)->press();
- $input = $assert_session->waitForElementVisible('css', '.command-box textarea');
- $this->assertNotEmpty($input);
- $command = $input->getValue();
+ $this->assertElementIsVisible('css', '.pb-project:contains("Image media type")')
+ ->pressButton('View Commands');
+ $command = $this->assertElementIsVisible('css', '.command-box textarea')
+ ->getValue();
+ assert(is_string($command));
// A full path to the PHP executable should be in the command.
$this->assertMatchesRegularExpression('/[^\s]+\/php /', $command);
$drupal_root = $this->getDrupalRoot();
@@ -1142,14 +1136,12 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
* Test that items with 0 active installs don't show, and >0 do.
*/
public function testActiveInstallVisibility(): void {
- $page = $this->getSession()->getPage();
- $assert_session = $this->assertSession();
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('css', '.pb-search-results');
- $assert_session->waitForElementVisible('css', '.pb-project');
+ $this->assertElementIsVisible('css', '.pb-project');
// Find the first and last .pb-project elements.
- $projects = $page->findAll('css', '.pb-project');
+ $projects = $this->getSession()->getPage()->findAll('css', '.pb-project');
// Assert that there are pb-project elements on the page.
$this->assertNotEmpty($projects, 'No .pb-project elements found on the page.');
@@ -1171,8 +1163,6 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
* Tests that each source plugin has its own dedicated route.
*/
public function testSourcePluginRoutes(): void {
- $assert_session = $this->assertSession();
-
// Enable module for extra source plugin.
$this->container->get('module_installer')->install(['project_browser_devel'], TRUE);
$this->rebuildContainer();
@@ -1182,7 +1172,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
foreach (array_keys($current_sources) as $plugin_id) {
$this->drupalGet("/admin/modules/browse/{$plugin_id}");
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--list');
}
}
@@ -1197,11 +1187,11 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('text', 'Helvetica');
// This asserts that status icon is present on the cards.
- $this->assertNotNull($assert_session->waitForElementVisible('css', '.pb-project__maintenance-icon .pb-project__status-icon-btn'));
+ $this->assertElementIsVisible('css', '.pb-project__maintenance-icon .pb-project__status-icon-btn');
$assert_session->waitForButton('Helvetica')?->click();
$this->assertTrue($assert_session->waitForText('The module is actively maintained by the maintainers'));
// This asserts that status icon is present in detail's modal.
- $this->assertNotNull($assert_session->waitForElementVisible('css', '.pb-detail-modal__sidebar .pb-project__status-icon-btn'));
+ $this->assertElementIsVisible('css', '.pb-detail-modal__sidebar .pb-project__status-icon-btn');
$page->find('css', '.ui-dialog-titlebar-close')?->click();
$this->clickWithWait(self::MAINTENANCE_OPTION_SELECTOR . self::OPTION_LAST_CHILD);
@@ -1221,11 +1211,11 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
// Ensure the project list is loaded.
- $this->assertNotEmpty($assert_session->waitForElementVisible('css', '#project-browser .pb-project'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project');
$this->assertTrue($assert_session->waitForText('Results'));
// Expect Grapefruit to have 1 install.
- $assert_session->waitForElementVisible('xpath', '//span[contains(@class, "pb-project__install-count") and text()="1 install"]');
+ $this->assertElementIsVisible('xpath', '//span[contains(@class, "pb-project__install-count") and text()="1 install"]');
// Locate and click the Grapefruit project link.
$grapefruit_link = $page->find('xpath', '//button[contains(@class, "pb-project__link") and contains(text(), "Grapefruit")]');
@@ -1255,10 +1245,9 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
public function testEnterDoesNotReloadThePage(): void {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$assert_session = $this->assertSession();
- $search_box = $assert_session->waitForElementVisible('css', '#pb-text');
- $this->assertNotEmpty($search_box);
- $session = $this->getSession();
- $session->executeScript('document.body.classList.add("same-page")');
+ $search_box = $this->assertElementIsVisible('css', '#pb-text');
+ $this->getSession()
+ ->executeScript('document.body.classList.add("same-page")');
// Enter some nonsense in the search box and press Enter ("\r\n" in PHP).
$search_box->focus();
$search_box->setValue("foo\r\n");
@@ -1278,36 +1267,37 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->svelteInitHelper('text', '10 Results');
// Locate the search box and verify it is visible.
- $assert_session = $this->assertSession();
- $search_box = $assert_session->waitForElementVisible('css', '#pb-text');
- $this->assertNotEmpty($search_box, 'Search box is visible.');
+ $this->assertElementIsVisible('css', '#pb-text');
// Fill in the search field.
$this->inputSearchField('', TRUE);
// Set the search term to "Astronaut Simulator" to narrow the results.
$this->inputSearchField('Astronaut Simulator', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
// Verify the singular result count text is displayed correctly.
- $result_count_text = $assert_session->waitForElementVisible('css', '.pb-search-results')?->getText();
- $this->assertSame('1 Result', $result_count_text);
+ $result_count = $this->assertElementIsVisible('css', '.pb-search-results');
+ $this->assertTrue(
+ $result_count->waitFor(
+ 10,
+ fn (NodeElement $element) => $element->getText() === '1 Result',
+ ),
+ );
}
/**
* Tests clicking the X next to search, or clear filters resets search.
*/
public function testClearSearch(): void {
- $assert_session = $this->assertSession();
-
// Clear filters.
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('text', '10 Results');
$this->pressWithWait('Clear filters', '25 Results');
// Fill in the search field.
- $search_field = $assert_session->waitForElementVisible('css', '#pb-text');
+ $search_field = $this->assertElementIsVisible('css', '#pb-text');
$this->inputSearchField('Tooth Fairy', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Tooth Fairy',
]);
@@ -1320,7 +1310,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Run search again.
$this->inputSearchField('Tooth Fairy', TRUE);
- $assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
+ $this->assertElementIsVisible('css', ".search__search-submit")->click();
$this->assertProjectsVisible([
'Tooth Fairy',
]);
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
index 323b1d466..33d802b69 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
@@ -74,22 +74,22 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->getSession()->resizeWindow(1250, 1000);
$this->drupalGet('admin/modules/browse/drupalorg_jsonapi');
$this->svelteInitHelper('css', '.pb-project.pb-project--grid');
- $assert_session->waitForElementVisible('css', '#project-browser .pb-display__button[value="Grid"]');
+ $this->assertElementIsVisible('css', '#project-browser .pb-display__button[value="Grid"]');
$grid_text = $this->getElementText('#project-browser .pb-display__button[value="Grid"]');
$this->assertEquals('Grid', $grid_text);
$this->assertTrue($assert_session->waitForText('Results'));
$assert_session->pageTextNotContains('No records available');
$page->pressButton('List');
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--list');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 12);
$page->pressButton('Grid');
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--grid'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--grid');
$this->getSession()->resizeWindow(1100, 1000);
$assert_session->assertNoElementAfterWait('css', '.toggle.list-button');
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--list');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 12);
$this->getSession()->resizeWindow(1210, 1210);
- $this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--grid'));
+ $this->assertElementIsVisible('css', '#project-browser .pb-project.pb-project--grid');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--grid', 12);
}
@@ -249,7 +249,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$assert_session->pageTextNotContains(' 0 Results');
// Click the Active filter.
- $assert_session->waitForElementVisible('css', self::DEVELOPMENT_OPTION_SELECTOR);
+ $this->assertElementIsVisible('css', self::DEVELOPMENT_OPTION_SELECTOR);
$this->clickWithWait(self::DEVELOPMENT_OPTION_SELECTOR . self::OPTION_FIRST_CHILD);
// Make sure the correct filter was applied.
@@ -353,11 +353,11 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
// Drupal.org test mock defines only two filters (actively maintained filter
// and security coverage filter).
- $assert_session->waitForElementVisible('css', '.search__form-filters-container');
+ $this->assertElementIsVisible('css', '.search__form-filters-container');
$this->assertTrue($assert_session->waitForText('Maintenance status'));
- $assert_session->waitForElementVisible('css', self::MAINTENANCE_OPTION_SELECTOR);
+ $this->assertElementIsVisible('css', self::MAINTENANCE_OPTION_SELECTOR);
$this->assertTrue($assert_session->waitForText('Security advisory coverage'));
- $assert_session->waitForElementVisible('css', self::SECURITY_OPTION_SELECTOR);
+ $this->assertElementIsVisible('css', self::SECURITY_OPTION_SELECTOR);
// Make sure no other filters are displayed.
$this->assertFalse($assert_session->waitForText('Development status'));
$this->assertNull($assert_session->waitForElementVisible('css', self::DEVELOPMENT_OPTION_SELECTOR));
@@ -412,7 +412,6 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->assertCount(2, $local_tasks);
// Verify that the mocked source is first tab.
$this->assertSame('Contrib modules', $local_tasks[0]->getText());
- $assert_session->waitForElementVisible('css', '.pb-display__button');
// Re-order plugins.
$this->drupalGet('admin/config/development/project_browser');
@@ -426,8 +425,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Verify that Random data is first tab.
$this->drupalGet('admin/modules/browse/drupalorg_jsonapi');
- $assert_session->waitForElementVisible('css', '#project-browser .pb-project');
- $first_tab = $page->find('css', '.pb-tabs__link:nth-child(1)');
+ $this->assertElementIsVisible('css', '#project-browser .pb-project');
$this->assertSame('Random data', $local_tasks[0]->getText());
// Disable the mock plugin.
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
index b7f40a120..0816594aa 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
@@ -11,6 +11,21 @@ use Behat\Mink\Element\NodeElement;
*/
trait ProjectBrowserUiTestTrait {
+ /**
+ * Waits for an element to be visible, and returns it.
+ *
+ * @param mixed ...$arguments
+ * Arguments to pass to JSWebAssert::waitForElementVisible().
+ *
+ * @return \Behat\Mink\Element\NodeElement
+ * The element we were waiting for.
+ */
+ protected function assertElementIsVisible(mixed ...$arguments): NodeElement {
+ $element = $this->assertSession()->waitForElementVisible(...$arguments);
+ $this->assertInstanceOf(NodeElement::class, $element);
+ return $element;
+ }
+
/**
* Installs a specific project.
*
--
GitLab