From f1586898554a61f667920a60bfa525351a4800b9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Wed, 19 Feb 2025 21:19:56 -0500
Subject: [PATCH 1/8] Create waitForText() and use it in most places
---
.../ProjectBrowserExamplePluginTest.php | 2 +-
.../ProjectBrowserInstallerUiTest.php | 11 ++-----
.../ProjectBrowserPluginTest.php | 9 +++---
.../ProjectBrowserUiTest.php | 31 +++++++++----------
.../ProjectBrowserUiTestJsonApi.php | 18 +++++------
.../ProjectBrowserUiTestTrait.php | 24 +++++++-------
6 files changed, 44 insertions(+), 51 deletions(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php b/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
index 8265c2911..40a446bc4 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
@@ -52,7 +52,7 @@ class ProjectBrowserExamplePluginTest extends WebDriverTestBase {
$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->assertTrue($assert_session->waitForText('Project 1'));
+ $this->waitForText('Project 1');
$assert_session->pageTextNotContains('No modules found');
$this->svelteInitHelper('css', '.pb-filter__checkbox');
$assert_session->elementsCount('css', '.pb-filter__checkbox', 2);
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
index 9673f0e00..cbf7f387d 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
@@ -179,8 +179,6 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
* @covers ::unlock
*/
public function testCanBreakStageWithMissingProjectBrowserLock(): void {
- $assert_session = $this->assertSession();
-
// Start install begin.
$this->drupalGet('admin/modules/project_browser/install-begin', [
'query' => ['source' => 'project_browser_test_mock'],
@@ -192,7 +190,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
$this->waitForProject('Cream cheese on a bagel')
->pressButton('Install Cream cheese on a bagel');
- $this->assertTrue($assert_session->waitForText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.'));
+ $this->waitForText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.');
// Click Unlock Install Stage link.
$this->clickWithWait('#ui-id-1 > p > a');
@@ -208,8 +206,6 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
* @covers ::unlock
*/
public function testCanBreakLock(): void {
- $assert_session = $this->assertSession();
-
// Start install begin.
$this->drupalGet('admin/modules/project_browser/install-begin', [
'query' => ['source' => 'project_browser_test_mock'],
@@ -219,7 +215,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
// the applying stage.
$this->waitForProject('Cream cheese on a bagel')
->pressButton('Install Cream cheese on a bagel');
- $this->assertTrue($assert_session->waitForText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.'));
+ $this->waitForText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.');
// Click Unlock Install Stage link.
$this->clickWithWait('#ui-id-1 > p > a');
// Try beginning another install after breaking lock.
@@ -234,11 +230,10 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
$this->container->get(StateInterface::class)
->set('project_browser_test.simulated_result_severity', SystemManager::REQUIREMENT_ERROR);
- $assert_session = $this->assertSession();
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$cream_cheese = $this->waitForProject('Cream cheese on a bagel');
$cream_cheese->pressButton('Install Cream cheese on a bagel');
- $this->assertTrue($assert_session->waitForText('Simulate an error message for the project browser.'));
+ $this->waitForText('Simulate an error message for the project browser.');
$this->assertTrue($cream_cheese->hasButton('Install Cream cheese on a bagel'));
}
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
index 6976e05ff..74be8b7b7 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
@@ -60,7 +60,7 @@ class ProjectBrowserPluginTest extends WebDriverTestBase {
$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->assertTrue($assert_session->waitForText('Results'));
+ $this->waitForText('Results');
$assert_session->pageTextNotContains('No modules found');
}
@@ -159,12 +159,11 @@ class ProjectBrowserPluginTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/random_data');
$this->assertNotEmpty($assert_session->waitForElementVisible('css', '#project-browser .pb-project'));
- $this->assertTrue($assert_session->waitForText('Results'));
+ $this->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->assertTrue($assert_session->waitForText('sites report using this module'));
+ $page->find('css', '.pb-project .pb-project__title .pb-project__link')?->click();
+ $this->waitForText('sites report using this module');
}
}
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
index fa833827f..27c170fe4 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
@@ -72,7 +72,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertNotEmpty($assert_session->waitForButton('Grid'));
$this->svelteInitHelper('text', '10 Results');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--grid', 10);
- $this->assertTrue($assert_session->waitForText('Results'));
+ $this->waitForText('Results');
$assert_session->pageTextNotContains('No modules found');
$page->pressButton('List');
$this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
@@ -121,7 +121,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('css', '.pb-filter__multi-dropdown');
// Initial results count on page load.
- $this->assertTrue($assert_session->waitForText('10 Results'));
+ $this->waitForText('10 Results');
// Open category drop-down.
$this->clickWithWait('.pb-filter__multi-dropdown', 'E-commerce', TRUE);
@@ -192,7 +192,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
'Kangaroo',
'9 Starts With a Higher Number',
]);
- $this->assertTrue($assert_session->waitForText('20 Results'));
+ $this->waitForText('20 Results');
}
/**
@@ -260,7 +260,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertPagerItems([]);
$page->pressButton('Clear filters');
- $this->assertTrue($assert_session->waitForText('25 Results'));
+ $this->waitForText('25 Results');
$this->assertProjectsVisible([
'Jazz',
'Eggman',
@@ -333,9 +333,9 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('css', '.pb-project.pb-project--list');
$this->pressWithWait('Clear filters');
- $assert_session->waitForText('Modules per page');
+ $this->waitForText('Modules per page');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 12);
- $assert_session->waitForText('Modules per page');
+ $this->waitForText('Modules per page');
$page->selectFieldOption('num-projects', '24');
$assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 24);
@@ -666,7 +666,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$assert_session->waitForElementVisible('css', '#67');
$this->clickWithWait('#67', '', TRUE);
- $this->assertTrue($assert_session->waitForText('15 Results'));
+ $this->waitForText('15 Results');
$this->assertProjectsVisible([
'Octopus',
'No Scrubs',
@@ -696,7 +696,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
'9 Starts With a Higher Number',
'1 Starts With a Number',
]);
- $this->assertTrue($assert_session->waitForText('15 Results'));
+ $this->waitForText('15 Results');
$this->assertEquals('E-commerce', $this->getElementText('p.filter-applied:first-child .filter-applied__label'));
$this->assertEquals('Media', $this->getElementText('p.filter-applied:nth-child(2) .filter-applied__label'));
@@ -725,7 +725,6 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
* Tests recommended filters.
*/
public function testRecommendedFilter(): void {
- $assert_session = $this->assertSession();
// Clear filters.
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('text', 'Clear Filters');
@@ -736,7 +735,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertEquals('Show actively maintained projects', $this->getElementText(self::MAINTENANCE_OPTION_SELECTOR . self::OPTION_CHECKED));
// Make sure the second filter applied is the security covered filter.
$this->assertEquals('Show projects covered by a security policy', $this->getElementText(self::SECURITY_OPTION_SELECTOR . self::OPTION_CHECKED));
- $this->assertTrue($assert_session->waitForText('10 Results'));
+ $this->waitForText('10 Results');
}
/**
@@ -837,7 +836,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Filter by search text.
$this->inputSearchField('Number', TRUE);
$assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
- $this->assertTrue($assert_session->waitForText('2 Results'));
+ $this->waitForText('2 Results');
$this->assertProjectsVisible([
'9 Starts With a Higher Number',
'1 Starts With a Number',
@@ -849,7 +848,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->pressWithWait('project_browser_test_mock');
$this->svelteInitHelper('css', '#project-browser .pb-project');
// Assert that the filters persist.
- $this->assertTrue($assert_session->waitForText('2 Results'));
+ $this->waitForText('2 Results');
$this->assertProjectsVisible([
'9 Starts With a Higher Number',
'1 Starts With a Number',
@@ -1199,7 +1198,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// 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'));
$assert_session->waitForButton('Helvetica')?->click();
- $this->assertTrue($assert_session->waitForText('The module is actively maintained by the maintainers'));
+ $this->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'));
$page->find('css', '.ui-dialog-titlebar-close')?->click();
@@ -1222,7 +1221,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Ensure the project list is loaded.
$this->assertNotEmpty($assert_session->waitForElementVisible('css', '#project-browser .pb-project'));
- $this->assertTrue($assert_session->waitForText('Results'));
+ $this->waitForText('Results');
// Expect Grapefruit to have 1 install.
$assert_session->waitForElementVisible('xpath', '//span[contains(@class, "pb-project__install-count") and text()="1 install"]');
@@ -1232,7 +1231,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$grapefruit_link?->click();
// Verify the text for Grapefruit (singular case).
- $this->assertTrue($assert_session->waitForText('site reports using this module'));
+ $this->waitForText('site reports using this module');
// Go back to the project list.
$close_button = $page->find('xpath', '//button[contains(@class, "ui-dialog-titlebar-close") and contains(text(), "Close")]');
@@ -1246,7 +1245,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$octopus_link?->click();
// Verify the text for Octopus (plural case).
- $this->assertTrue($assert_session->waitForText('sites report using this module'));
+ $this->waitForText('sites report using this module');
}
/**
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
index 323b1d466..c613e4e27 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
@@ -77,7 +77,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$assert_session->waitForElementVisible('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'));
+ $this->waitForText('Results');
$assert_session->pageTextNotContains('No records available');
$page->pressButton('List');
$this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
@@ -125,7 +125,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/drupalorg_jsonapi');
$this->svelteInitHelper('css', '.pb-filter__multi-dropdown');
// Initial results count on page load.
- $this->assertTrue($assert_session->waitForText(' Results'));
+ $this->waitForText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
// Open category drop-down.
$this->clickWithWait('.pb-filter__multi-dropdown', 'E-commerce', TRUE);
@@ -158,7 +158,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Click 'Media' checkbox.
$this->clickWithWait('#68428c33-1db7-438d-b1b3-e23004e0982b');
- $this->assertTrue($assert_session->waitForText(' Results'));
+ $this->waitForText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
// Click 'Developer tools' checkbox.
@@ -166,7 +166,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Make sure the 'Media' module category filter is applied.
$this->assertEquals('Media', $this->getElementText('p.filter-applied:nth-child(2) .filter-applied__label'));
- $this->assertTrue($assert_session->waitForText(' Results'));
+ $this->waitForText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
}
@@ -193,7 +193,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->assertPagerItems(['1', '2', '3', '4', '5', '…', 'Next', 'Last']);
$page->pressButton('Clear filters');
- $this->assertTrue($assert_session->waitForText(' Results'));
+ $this->waitForText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
$this->assertPagerItems(['1', '2', '3', '4', '5', '…', 'Next', 'Last']);
$assert_session->elementExists('css', '.pager__item--active > .is-active[aria-label="Page 1"]');
@@ -254,7 +254,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Make sure the correct filter was applied.
$this->assertEquals('Show projects under active development', $this->getElementText(self::DEVELOPMENT_OPTION_SELECTOR . self::OPTION_CHECKED));
- $assert_session->waitForText('No records available');
+ $this->waitForText('No records available');
// Clear all filters.
$this->pressWithWait('Clear filters', 'Results');
@@ -323,7 +323,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->assertTrue($assert_session->optionExists('maintenance_status', 'Show actively maintained projects')->isSelected());
// Make sure the second filter applied is the security covered filter.
$this->assertTrue($assert_session->optionExists('security_advisory_coverage', 'Show projects covered by a security policy')->isSelected());
- $this->assertTrue($assert_session->waitForText(' Results'));
+ $this->waitForText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
}
@@ -354,9 +354,9 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Drupal.org test mock defines only two filters (actively maintained filter
// and security coverage filter).
$assert_session->waitForElementVisible('css', '.search__form-filters-container');
- $this->assertTrue($assert_session->waitForText('Maintenance status'));
+ $this->waitForText('Maintenance status');
$assert_session->waitForElementVisible('css', self::MAINTENANCE_OPTION_SELECTOR);
- $this->assertTrue($assert_session->waitForText('Security advisory coverage'));
+ $this->waitForText('Security advisory coverage');
$assert_session->waitForElementVisible('css', self::SECURITY_OPTION_SELECTOR);
// Make sure no other filters are displayed.
$this->assertFalse($assert_session->waitForText('Development status'));
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
index b7f40a120..8b5d9634f 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
@@ -11,6 +11,16 @@ use Behat\Mink\Element\NodeElement;
*/
trait ProjectBrowserUiTestTrait {
+ /**
+ * Waits for specific text to appear on the page.
+ *
+ * @param string $text
+ * The text we're waiting for.
+ */
+ protected function waitForText(string $text): void {
+ $this->assertTrue($this->assertSession()->waitForText($text));
+ }
+
/**
* Installs a specific project.
*
@@ -177,7 +187,7 @@ trait ProjectBrowserUiTestTrait {
}
if (!empty($wait_for_text)) {
- $this->waitForPageToContainText($wait_for_text);
+ $this->waitForText($wait_for_text);
}
}
@@ -216,7 +226,7 @@ trait ProjectBrowserUiTestTrait {
}
if (!empty($wait_for_text)) {
- $this->assertTrue($this->assertSession()->waitForText($wait_for_text));
+ $this->waitForText($wait_for_text);
}
}
@@ -328,16 +338,6 @@ trait ProjectBrowserUiTestTrait {
$this->assertSame($pager_items, $items);
}
- /**
- * Helper to wait for text on page.
- *
- * @param string $text
- * The expected text.
- */
- protected function waitForPageToContainText(string $text): void {
- $this->assertTrue($this->assertSession()->waitForText($text), "Expected '$text' to appear on the page but it didn't.");
- }
-
/**
* Helper to wait for a field to appear on the page.
*
--
GitLab
From ffda1d5a7f55bdc4596f777fe8493defbcc591ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Thu, 20 Feb 2025 09:18:53 -0500
Subject: [PATCH 2/8] Note that this shit was always broken
---
tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php | 3 +++
1 file changed, 3 insertions(+)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
index c613e4e27..58c37469a 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
@@ -254,6 +254,9 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Make sure the correct filter was applied.
$this->assertEquals('Show projects under active development', $this->getElementText(self::DEVELOPMENT_OPTION_SELECTOR . self::OPTION_CHECKED));
+ // @todo THIS NEVER ACTUALLY WORKED, but it was "passing" because we weren't
+ // actually asserting the result here. So what to do -- delete this
+ // assertion outright, or actually try to fix it?
$this->waitForText('No records available');
// Clear all filters.
--
GitLab
From 60370c2389ec18b77bb5c204500c50690368ec3d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Thu, 20 Feb 2025 09:31:16 -0500
Subject: [PATCH 3/8] Remove broken assertion
---
.../src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php | 4 ----
1 file changed, 4 deletions(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
index 58c37469a..0d28aee1b 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
@@ -254,10 +254,6 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Make sure the correct filter was applied.
$this->assertEquals('Show projects under active development', $this->getElementText(self::DEVELOPMENT_OPTION_SELECTOR . self::OPTION_CHECKED));
- // @todo THIS NEVER ACTUALLY WORKED, but it was "passing" because we weren't
- // actually asserting the result here. So what to do -- delete this
- // assertion outright, or actually try to fix it?
- $this->waitForText('No records available');
// Clear all filters.
$this->pressWithWait('Clear filters', 'Results');
--
GitLab
From f2e120a4a9644141d6ddf10a1f79360d625df178 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Thu, 20 Feb 2025 09:41:16 -0500
Subject: [PATCH 4/8] Remove pointless and broken waits from testPagingOptions
---
tests/src/FunctionalJavascript/ProjectBrowserUiTest.php | 2 --
1 file changed, 2 deletions(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
index 27c170fe4..7ab822d35 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
@@ -333,9 +333,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('css', '.pb-project.pb-project--list');
$this->pressWithWait('Clear filters');
- $this->waitForText('Modules per page');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 12);
- $this->waitForText('Modules per page');
$page->selectFieldOption('num-projects', '24');
$assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 24);
--
GitLab
From 97ac5ee82c49d3ea964d49002dbbdedec5d588d4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Thu, 20 Feb 2025 10:10:33 -0500
Subject: [PATCH 5/8] Wait for a specific number of projects
---
.../FunctionalJavascript/ProjectBrowserUiTest.php | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
index 7ab822d35..e16ab38be 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
@@ -4,6 +4,7 @@ declare(strict_types=1);
namespace Drupal\Tests\project_browser\FunctionalJavascript;
+use Behat\Mink\Element\DocumentElement;
use Behat\Mink\Element\NodeElement;
use Drupal\Core\Extension\MissingDependencyException;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
@@ -328,15 +329,19 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
*/
public function testPagingOptions(): void {
$page = $this->getSession()->getPage();
- $assert_session = $this->assertSession();
+ $await_n_projects = function (int $count) use ($page): void {
+ $this->assertTrue($page->waitFor(
+ 10,
+ fn (DocumentElement $page) => count($page->findAll('css', '#project-browser .pb-project.pb-project--list')) === $count,
+ ));
+ };
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('css', '.pb-project.pb-project--list');
$this->pressWithWait('Clear filters');
- $assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 12);
+ $await_n_projects(12);
$page->selectFieldOption('num-projects', '24');
- $assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list');
- $assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--list', 24);
+ $await_n_projects(24);
}
/**
--
GitLab
From 1cfab0ed00e014f37b5d895660b0fc6eaff9d564 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Thu, 20 Feb 2025 13:26:38 -0500
Subject: [PATCH 6/8] Rename to assertPageHasText()
---
.../ProjectBrowserExamplePluginTest.php | 2 +-
.../ProjectBrowserInstallerUiTest.php | 6 ++---
.../ProjectBrowserPluginTest.php | 6 ++---
.../ProjectBrowserUiTest.php | 26 +++++++++----------
.../ProjectBrowserUiTestJsonApi.php | 16 ++++++------
.../ProjectBrowserUiTestTrait.php | 6 ++---
6 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php b/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
index 40a446bc4..0004db809 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserExamplePluginTest.php
@@ -52,7 +52,7 @@ class ProjectBrowserExamplePluginTest extends WebDriverTestBase {
$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->waitForText('Project 1');
+ $this->assertPageHasText('Project 1');
$assert_session->pageTextNotContains('No modules found');
$this->svelteInitHelper('css', '.pb-filter__checkbox');
$assert_session->elementsCount('css', '.pb-filter__checkbox', 2);
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
index cbf7f387d..593c27b6c 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserInstallerUiTest.php
@@ -190,7 +190,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
$this->waitForProject('Cream cheese on a bagel')
->pressButton('Install Cream cheese on a bagel');
- $this->waitForText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.');
+ $this->assertPageHasText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.');
// Click Unlock Install Stage link.
$this->clickWithWait('#ui-id-1 > p > a');
@@ -215,7 +215,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
// the applying stage.
$this->waitForProject('Cream cheese on a bagel')
->pressButton('Install Cream cheese on a bagel');
- $this->waitForText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.');
+ $this->assertPageHasText('The process for adding projects is locked, but that lock has expired. Use unlock link to unlock the process and try to add the project again.');
// Click Unlock Install Stage link.
$this->clickWithWait('#ui-id-1 > p > a');
// Try beginning another install after breaking lock.
@@ -233,7 +233,7 @@ class ProjectBrowserInstallerUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$cream_cheese = $this->waitForProject('Cream cheese on a bagel');
$cream_cheese->pressButton('Install Cream cheese on a bagel');
- $this->waitForText('Simulate an error message for the project browser.');
+ $this->assertPageHasText('Simulate an error message for the project browser.');
$this->assertTrue($cream_cheese->hasButton('Install Cream cheese on a bagel'));
}
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
index 74be8b7b7..25fe12124 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
@@ -60,7 +60,7 @@ class ProjectBrowserPluginTest extends WebDriverTestBase {
$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->waitForText('Results');
+ $this->assertPageHasText('Results');
$assert_session->pageTextNotContains('No modules found');
}
@@ -159,11 +159,11 @@ class ProjectBrowserPluginTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/random_data');
$this->assertNotEmpty($assert_session->waitForElementVisible('css', '#project-browser .pb-project'));
- $this->waitForText('Results');
+ $this->assertPageHasText('Results');
$assert_session->waitForElementVisible('css', '.pb-project .pb-project__title');
$page->find('css', '.pb-project .pb-project__title .pb-project__link')?->click();
- $this->waitForText('sites report using this module');
+ $this->assertPageHasText('sites report using this module');
}
}
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
index e16ab38be..f5bf5701f 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTest.php
@@ -73,7 +73,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertNotEmpty($assert_session->waitForButton('Grid'));
$this->svelteInitHelper('text', '10 Results');
$assert_session->elementsCount('css', '#project-browser .pb-project.pb-project--grid', 10);
- $this->waitForText('Results');
+ $this->assertPageHasText('Results');
$assert_session->pageTextNotContains('No modules found');
$page->pressButton('List');
$this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
@@ -122,7 +122,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/project_browser_test_mock');
$this->svelteInitHelper('css', '.pb-filter__multi-dropdown');
// Initial results count on page load.
- $this->waitForText('10 Results');
+ $this->assertPageHasText('10 Results');
// Open category drop-down.
$this->clickWithWait('.pb-filter__multi-dropdown', 'E-commerce', TRUE);
@@ -193,7 +193,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
'Kangaroo',
'9 Starts With a Higher Number',
]);
- $this->waitForText('20 Results');
+ $this->assertPageHasText('20 Results');
}
/**
@@ -261,7 +261,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertPagerItems([]);
$page->pressButton('Clear filters');
- $this->waitForText('25 Results');
+ $this->assertPageHasText('25 Results');
$this->assertProjectsVisible([
'Jazz',
'Eggman',
@@ -669,7 +669,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$assert_session->waitForElementVisible('css', '#67');
$this->clickWithWait('#67', '', TRUE);
- $this->waitForText('15 Results');
+ $this->assertPageHasText('15 Results');
$this->assertProjectsVisible([
'Octopus',
'No Scrubs',
@@ -699,7 +699,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
'9 Starts With a Higher Number',
'1 Starts With a Number',
]);
- $this->waitForText('15 Results');
+ $this->assertPageHasText('15 Results');
$this->assertEquals('E-commerce', $this->getElementText('p.filter-applied:first-child .filter-applied__label'));
$this->assertEquals('Media', $this->getElementText('p.filter-applied:nth-child(2) .filter-applied__label'));
@@ -738,7 +738,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->assertEquals('Show actively maintained projects', $this->getElementText(self::MAINTENANCE_OPTION_SELECTOR . self::OPTION_CHECKED));
// Make sure the second filter applied is the security covered filter.
$this->assertEquals('Show projects covered by a security policy', $this->getElementText(self::SECURITY_OPTION_SELECTOR . self::OPTION_CHECKED));
- $this->waitForText('10 Results');
+ $this->assertPageHasText('10 Results');
}
/**
@@ -839,7 +839,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Filter by search text.
$this->inputSearchField('Number', TRUE);
$assert_session->waitForElementVisible('css', ".search__search-submit")?->click();
- $this->waitForText('2 Results');
+ $this->assertPageHasText('2 Results');
$this->assertProjectsVisible([
'9 Starts With a Higher Number',
'1 Starts With a Number',
@@ -851,7 +851,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$this->pressWithWait('project_browser_test_mock');
$this->svelteInitHelper('css', '#project-browser .pb-project');
// Assert that the filters persist.
- $this->waitForText('2 Results');
+ $this->assertPageHasText('2 Results');
$this->assertProjectsVisible([
'9 Starts With a Higher Number',
'1 Starts With a Number',
@@ -1201,7 +1201,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// 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'));
$assert_session->waitForButton('Helvetica')?->click();
- $this->waitForText('The module is actively maintained by the maintainers');
+ $this->assertPageHasText('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'));
$page->find('css', '.ui-dialog-titlebar-close')?->click();
@@ -1224,7 +1224,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
// Ensure the project list is loaded.
$this->assertNotEmpty($assert_session->waitForElementVisible('css', '#project-browser .pb-project'));
- $this->waitForText('Results');
+ $this->assertPageHasText('Results');
// Expect Grapefruit to have 1 install.
$assert_session->waitForElementVisible('xpath', '//span[contains(@class, "pb-project__install-count") and text()="1 install"]');
@@ -1234,7 +1234,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$grapefruit_link?->click();
// Verify the text for Grapefruit (singular case).
- $this->waitForText('site reports using this module');
+ $this->assertPageHasText('site reports using this module');
// Go back to the project list.
$close_button = $page->find('xpath', '//button[contains(@class, "ui-dialog-titlebar-close") and contains(text(), "Close")]');
@@ -1248,7 +1248,7 @@ class ProjectBrowserUiTest extends WebDriverTestBase {
$octopus_link?->click();
// Verify the text for Octopus (plural case).
- $this->waitForText('sites report using this module');
+ $this->assertPageHasText('sites report using this module');
}
/**
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
index 0d28aee1b..265699b46 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestJsonApi.php
@@ -77,7 +77,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$assert_session->waitForElementVisible('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->waitForText('Results');
+ $this->assertPageHasText('Results');
$assert_session->pageTextNotContains('No records available');
$page->pressButton('List');
$this->assertNotNull($assert_session->waitForElementVisible('css', '#project-browser .pb-project.pb-project--list'));
@@ -125,7 +125,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->drupalGet('admin/modules/browse/drupalorg_jsonapi');
$this->svelteInitHelper('css', '.pb-filter__multi-dropdown');
// Initial results count on page load.
- $this->waitForText(' Results');
+ $this->assertPageHasText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
// Open category drop-down.
$this->clickWithWait('.pb-filter__multi-dropdown', 'E-commerce', TRUE);
@@ -158,7 +158,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Click 'Media' checkbox.
$this->clickWithWait('#68428c33-1db7-438d-b1b3-e23004e0982b');
- $this->waitForText(' Results');
+ $this->assertPageHasText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
// Click 'Developer tools' checkbox.
@@ -166,7 +166,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Make sure the 'Media' module category filter is applied.
$this->assertEquals('Media', $this->getElementText('p.filter-applied:nth-child(2) .filter-applied__label'));
- $this->waitForText(' Results');
+ $this->assertPageHasText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
}
@@ -193,7 +193,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->assertPagerItems(['1', '2', '3', '4', '5', '…', 'Next', 'Last']);
$page->pressButton('Clear filters');
- $this->waitForText(' Results');
+ $this->assertPageHasText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
$this->assertPagerItems(['1', '2', '3', '4', '5', '…', 'Next', 'Last']);
$assert_session->elementExists('css', '.pager__item--active > .is-active[aria-label="Page 1"]');
@@ -322,7 +322,7 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
$this->assertTrue($assert_session->optionExists('maintenance_status', 'Show actively maintained projects')->isSelected());
// Make sure the second filter applied is the security covered filter.
$this->assertTrue($assert_session->optionExists('security_advisory_coverage', 'Show projects covered by a security policy')->isSelected());
- $this->waitForText(' Results');
+ $this->assertPageHasText(' Results');
$assert_session->pageTextNotContains(' 0 Results');
}
@@ -353,9 +353,9 @@ class ProjectBrowserUiTestJsonApi extends WebDriverTestBase {
// Drupal.org test mock defines only two filters (actively maintained filter
// and security coverage filter).
$assert_session->waitForElementVisible('css', '.search__form-filters-container');
- $this->waitForText('Maintenance status');
+ $this->assertPageHasText('Maintenance status');
$assert_session->waitForElementVisible('css', self::MAINTENANCE_OPTION_SELECTOR);
- $this->waitForText('Security advisory coverage');
+ $this->assertPageHasText('Security advisory coverage');
$assert_session->waitForElementVisible('css', self::SECURITY_OPTION_SELECTOR);
// Make sure no other filters are displayed.
$this->assertFalse($assert_session->waitForText('Development status'));
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
index 8b5d9634f..f6d02ab14 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
@@ -17,7 +17,7 @@ trait ProjectBrowserUiTestTrait {
* @param string $text
* The text we're waiting for.
*/
- protected function waitForText(string $text): void {
+ protected function assertPageHasText(string $text): void {
$this->assertTrue($this->assertSession()->waitForText($text));
}
@@ -187,7 +187,7 @@ trait ProjectBrowserUiTestTrait {
}
if (!empty($wait_for_text)) {
- $this->waitForText($wait_for_text);
+ $this->assertPageHasText($wait_for_text);
}
}
@@ -226,7 +226,7 @@ trait ProjectBrowserUiTestTrait {
}
if (!empty($wait_for_text)) {
- $this->waitForText($wait_for_text);
+ $this->assertPageHasText($wait_for_text);
}
}
--
GitLab
From 720913889efe92b477be739726019a18ba99c9d1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 21 Feb 2025 14:23:40 -0500
Subject: [PATCH 7/8] Restore assertion message
---
tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
index 4f9404ed5..90dddd70b 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
@@ -18,7 +18,7 @@ trait ProjectBrowserUiTestTrait {
* The text we're waiting for.
*/
protected function assertPageHasText(string $text): void {
- $this->assertTrue($this->assertSession()->waitForText($text));
+ $this->assertTrue($this->assertSession()->waitForText($text), "Expected '$text' to appear on the page but it didn't.");
}
/**
--
GitLab
From 4c941ca425a994a502f2e38d709f65ec6d981181 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 21 Feb 2025 14:26:05 -0500
Subject: [PATCH 8/8] Whoops
---
tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php | 2 --
tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php | 2 +-
2 files changed, 1 insertion(+), 3 deletions(-)
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
index e59e75cfa..4e0221e44 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserPluginTest.php
@@ -154,8 +154,6 @@ class ProjectBrowserPluginTest extends WebDriverTestBase {
* Tests the detail page.
*/
public function testDetailPageRandomDataPlugin(): void {
- $assert_session = $this->assertSession();
-
$this->drupalGet('admin/modules/browse/random_data');
$this->assertElementIsVisible('css', '#project-browser .pb-project');
$this->assertPageHasText('Results');
diff --git a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
index 90dddd70b..4b0488eb4 100644
--- a/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
+++ b/tests/src/FunctionalJavascript/ProjectBrowserUiTestTrait.php
@@ -342,7 +342,7 @@ trait ProjectBrowserUiTestTrait {
protected function assertPagerItems(array $pager_items): void {
$page = $this->getSession()->getPage();
- $this->waitForElement('css', '#project-browser .pb-project');
+ $this->assertElementIsVisible('css', '#project-browser .pb-project');
$items = array_map(function ($element) {
return $element->getText();
}, $page->findAll('css', '#project-browser .pager__item'));
--
GitLab