Skip to content

Commit 9aa6abf

Browse files
authored
feat: add API to get sub menus in MenuBarElement (#3472)
1 parent b44e4d0 commit 9aa6abf

2 files changed

Lines changed: 90 additions & 47 deletions

File tree

  • vaadin-menu-bar-flow-parent
    • vaadin-menu-bar-flow-integration-tests/src/test/java/com/vaadin/flow/component/menubar/tests
    • vaadin-menu-bar-testbench/src/main/java/com/vaadin/flow/component/menubar/testbench

‎vaadin-menu-bar-flow-parent/vaadin-menu-bar-flow-integration-tests/src/test/java/com/vaadin/flow/component/menubar/tests/MenuBarPageIT.java‎

Lines changed: 33 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public void clickRootButton_hoverOnParentItem_subSubMenuRenders() {
7272
openSubSubMenu();
7373

7474
String[] menuItemContents = getOverlayMenuItemContents(
75-
getAllOverlays().get(1));
75+
menuBar.getAllSubMenus().get(1));
7676
Assert.assertArrayEquals(
7777
new String[] { "<p>sub sub item 1</p>", "checkable" },
7878
menuItemContents);
@@ -81,42 +81,43 @@ public void clickRootButton_hoverOnParentItem_subSubMenuRenders() {
8181
@Test
8282
public void openSubMenu_clickItem_listenerCalled() {
8383
menuBar.getButtons().get(0).click();
84-
getOverlayMenuItems().get(0).click();
84+
menuBar.getSubMenuItems().get(0).click();
8585
assertMessage("clicked sub item 1");
8686
}
8787

8888
@Test
8989
public void openSubSubMenu_clickCheckableItem_checkableStateChanges() {
9090
openSubSubMenu();
9191

92-
getOverlayMenuItems(getAllOverlays().get(1)).get(1).click();
92+
menuBar.getSubMenuItems(menuBar.getAllSubMenus().get(1)).get(1).click();
9393
verifyClosed();
9494

9595
assertMessage("true");
9696

9797
menuBar.$("vaadin-menu-bar-button").first().click();
98-
hoverOn(getOverlayMenuItems().get(1));
98+
hoverOn(menuBar.getSubMenuItems().get(1));
9999

100-
waitUntil(driver -> getAllOverlays().size() == 2);
101-
TestBenchElement checkableItem = getOverlayMenuItems(
102-
getAllOverlays().get(1)).get(1);
100+
waitUntil(driver -> menuBar.getAllSubMenus().size() == 2);
101+
TestBenchElement checkableItem = menuBar
102+
.getSubMenuItems(menuBar.getAllSubMenus().get(1)).get(1);
103103
Assert.assertTrue(checkableItem.hasAttribute("menu-item-checked"));
104104

105105
checkableItem.click();
106106
verifyClosed();
107107
assertMessage("false");
108108

109109
openSubSubMenu();
110-
checkableItem = getOverlayMenuItems(getAllOverlays().get(1)).get(1);
110+
checkableItem = menuBar.getSubMenuItems(menuBar.getAllSubMenus().get(1))
111+
.get(1);
111112
Assert.assertFalse(checkableItem.hasAttribute("menu-item-checked"));
112113
}
113114

114115
@Test
115116
public void setCheckedExternally_openSubMenu_itemChecked() {
116117
click("toggle-checked");
117118
openSubSubMenu();
118-
TestBenchElement checkableItem = getOverlayMenuItems(
119-
getAllOverlays().get(1)).get(1);
119+
TestBenchElement checkableItem = menuBar
120+
.getSubMenuItems(menuBar.getAllSubMenus().get(1)).get(1);
120121
Assert.assertTrue(checkableItem.hasAttribute("menu-item-checked"));
121122
}
122123

@@ -201,7 +202,7 @@ public void buttonWithClickListenerOverflows_clickListenerWorksInSubMenu() {
201202
click("set-width");
202203
waitForResizeObserver();
203204
menuBar.getOverflowButton().click();
204-
getOverlayMenuItems().get(0).click();
205+
menuBar.getSubMenuItems().get(0).click();
205206
assertMessage("clicked item 2");
206207
}
207208

@@ -269,7 +270,7 @@ public void disableItem_overflow_itemDisabled() {
269270
waitForResizeObserver();
270271
menuBar.getOverflowButton().click();
271272
verifyOpened();
272-
assertDisabled(getOverlayMenuItems().get(0), true);
273+
assertDisabled(menuBar.getSubMenuItems().get(0), true);
273274
}
274275

275276
@Test
@@ -279,12 +280,12 @@ public void overflow_disableItem_itemDisabled() {
279280
click("toggle-disable");
280281
menuBar.getOverflowButton().click();
281282
verifyOpened();
282-
assertDisabled(getOverlayMenuItems().get(0), true);
283+
assertDisabled(menuBar.getSubMenuItems().get(0), true);
283284
// repeat
284285
clickBody();
285286
menuBar.getOverflowButton().click();
286287
verifyOpened();
287-
assertDisabled(getOverlayMenuItems().get(0), true);
288+
assertDisabled(menuBar.getSubMenuItems().get(0), true);
288289
}
289290

290291
@Test
@@ -468,20 +469,23 @@ public void setMenuItemTheme_hide_resetTheme_show_themeIsUnset() {
468469
@Test
469470
public void toggleSubMenuItemTheme_themeIsToggled() {
470471
menuBar.getButtons().get(0).click();
471-
Assert.assertFalse(getOverlayMenuItems().get(1).hasAttribute("theme"));
472+
Assert.assertFalse(
473+
menuBar.getSubMenuItems().get(1).hasAttribute("theme"));
472474

473475
click("toggle-sub-theme");
474476
verifyClosed();
475477

476478
menuBar.getButtons().get(0).click();
477-
Assert.assertEquals(getOverlayMenuItems().get(1).getAttribute("theme"),
479+
Assert.assertEquals(
480+
menuBar.getSubMenuItems().get(1).getAttribute("theme"),
478481
MenuBarTestPage.SUB_ITEM_THEME);
479482

480483
click("toggle-sub-theme");
481484
verifyClosed();
482485

483486
menuBar.getButtons().get(0).click();
484-
Assert.assertFalse(getOverlayMenuItems().get(1).hasAttribute("theme"));
487+
Assert.assertFalse(
488+
menuBar.getSubMenuItems().get(1).hasAttribute("theme"));
485489
}
486490

487491
@Test
@@ -520,7 +524,7 @@ private void assertButtonContents(String... expectedInnerHTML) {
520524
private void openSubSubMenu() {
521525
menuBar.getButtons().get(0).click();
522526
verifyOpened();
523-
hoverOn(getOverlayMenuItems().get(1));
527+
hoverOn(menuBar.getSubMenuItems().get(1));
524528
verifyNumOfOverlays(2);
525529
}
526530

@@ -536,37 +540,20 @@ private void clickBody() {
536540
$("body").first().click();
537541
}
538542

539-
private TestBenchElement getOverlay() {
540-
verifyOpened();
541-
return $(OVERLAY_TAG).first();
542-
}
543-
544-
private List<TestBenchElement> getAllOverlays() {
545-
return $(OVERLAY_TAG).all();
546-
}
547-
548543
private void verifyNumOfOverlays(int expected) {
549-
waitUntil(driver -> getAllOverlays().size() == expected);
550-
}
551-
552-
private void verifyClosed() {
553-
waitForElementNotPresent(By.tagName(OVERLAY_TAG));
554-
}
555-
556-
private void verifyOpened() {
557-
waitForElementPresent(By.tagName(OVERLAY_TAG));
544+
waitUntil(driver -> menuBar.getAllSubMenus().size() == expected);
558545
}
559546

560547
private void assertOverlayContents(String... expected) {
561548
Assert.assertArrayEquals(expected, getOverlayMenuItemContents());
562549
}
563550

564551
private String[] getOverlayMenuItemContents() {
565-
return getOverlayMenuItemContents(getOverlayMenuItems());
552+
return getOverlayMenuItemContents(menuBar.getSubMenuItems());
566553
}
567554

568555
private String[] getOverlayMenuItemContents(TestBenchElement overlay) {
569-
return getOverlayMenuItemContents(getOverlayMenuItems(overlay));
556+
return getOverlayMenuItemContents(menuBar.getSubMenuItems(overlay));
570557
}
571558

572559
private String[] getOverlayMenuItemContents(
@@ -575,15 +562,6 @@ private String[] getOverlayMenuItemContents(
575562
.toArray(String[]::new);
576563
}
577564

578-
private List<TestBenchElement> getOverlayMenuItems() {
579-
return getOverlayMenuItems(getOverlay());
580-
}
581-
582-
private List<TestBenchElement> getOverlayMenuItems(
583-
TestBenchElement overlay) {
584-
return overlay.$("vaadin-context-menu-item").all();
585-
}
586-
587565
private void hoverOn(TestBenchElement hoverTarget) {
588566
executeScript(
589567
"arguments[0].dispatchEvent(new Event('mouseover', {bubbles:true}))",
@@ -596,4 +574,12 @@ private void waitForResizeObserver() {
596574
+ "requestAnimationFrame(callback)");
597575

598576
}
577+
578+
public void verifyClosed() {
579+
waitForElementNotPresent(By.tagName(OVERLAY_TAG));
580+
}
581+
582+
public void verifyOpened() {
583+
waitForElementPresent(By.tagName(OVERLAY_TAG));
584+
}
599585
}

‎vaadin-menu-bar-flow-parent/vaadin-menu-bar-testbench/src/main/java/com/vaadin/flow/component/menubar/testbench/MenuBarElement.java‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,13 @@
1515
*/
1616
package com.vaadin.flow.component.menubar.testbench;
1717

18+
import java.util.ArrayList;
1819
import java.util.List;
1920
import java.util.stream.Collectors;
2021

22+
import org.openqa.selenium.By;
23+
import org.openqa.selenium.support.ui.ExpectedConditions;
24+
2125
import com.vaadin.testbench.TestBenchElement;
2226
import com.vaadin.testbench.elementsbase.Element;
2327

@@ -28,6 +32,8 @@
2832
@Element("vaadin-menu-bar")
2933
public class MenuBarElement extends TestBenchElement {
3034

35+
public static final String OVERLAY_TAG = "vaadin-context-menu-overlay";
36+
3137
/**
3238
* Gets the button elements wrapping the root level items. This does not
3339
* include the overflowing items which are rendered in a sub menu, nor the
@@ -64,4 +70,55 @@ private boolean isVisible(TestBenchElement element) {
6470
"return arguments[0].style.visibility !== 'hidden'", element);
6571
}
6672

73+
/**
74+
* Get TestBenchElements representing sub menu items under the first sub
75+
* menu.
76+
*
77+
* @return List of TestBenchElements representing sub menu items.
78+
*/
79+
public List<TestBenchElement> getSubMenuItems() {
80+
return getSubMenuItems(getSubMenu());
81+
}
82+
83+
/**
84+
* Get TestBenchElements representing sub menu items under specific sub
85+
* menu.
86+
*
87+
* @param overlay
88+
* The sub menu overlay from which items are being collected.
89+
* @return List of TestBenchElements representing sub menu items.
90+
*/
91+
public List<TestBenchElement> getSubMenuItems(TestBenchElement overlay) {
92+
return overlay.$("vaadin-context-menu-item").all();
93+
}
94+
95+
/**
96+
* Get the sub menu overlay element.
97+
*
98+
* @return TestBenchElement for the first open sub menu.
99+
*/
100+
public TestBenchElement getSubMenu() {
101+
waitForSubMenu();
102+
return (TestBenchElement) getDriver()
103+
.findElement(By.tagName(OVERLAY_TAG));
104+
}
105+
106+
/**
107+
* Get all the open sub menu overlay elements.
108+
*
109+
* @return List of TestBenchElements representing currently open sub menus.
110+
*/
111+
public List<TestBenchElement> getAllSubMenus() {
112+
waitForSubMenu();
113+
List<TestBenchElement> elements = new ArrayList<>();
114+
getDriver().findElements(By.tagName(OVERLAY_TAG))
115+
.forEach(element -> elements.add((TestBenchElement) element));
116+
return elements;
117+
}
118+
119+
private void waitForSubMenu() {
120+
waitUntil(ExpectedConditions
121+
.presenceOfElementLocated(By.tagName(OVERLAY_TAG)));
122+
}
123+
67124
}

0 commit comments

Comments
 (0)