ContextMenuOverlay components cannot be accessed in UI Unit Tests

[Brazhnyk-IOn]

While writing UI unit tests, I discovered that I cannot access the components within a ContextMenuOverlay after it has been opened:

[TatuLund]

The most likely fix is that attachMenuUI() that is called in open() should attach the components as children to UI (now it does not, it just fires simulated event)

https://github.com/vaadin/testbench/blob/main/vaadin-testbench-unit-shared/src/main/java/com/vaadin/flow/component/contextmenu/ContextMenuTester.java#L55

And equally the close() method should detach them.

[mcollovati]

@Brazhnyk-IOn can you show how you currently tried to get the component?
I did the following test and I could find the component in the context menu

View

menu = new ContextMenu();
....
menu.addItem(new VerticalLayout(new Div("Component Item")), ev -> clickedItems.add("Component Item"));

Test

var menuTester = test(view.menu);
menuTester.open();
var div = menuTester.find(Div.class).withText("Component Item").single();
Assertions.assertTrue(div.isAttached());

menuTester.close();
div = menuTester.find(Div.class).withText("Component Item").single();
Assertions.assertFalse(div.isAttached());

Is your use case different?

[TatuLund]

It is about added components. There is discussion in the Forum.

[mcollovati]

Thanks for pointing out Tatu. Here's the link to the discussion: https://vaadin.com/forum/t/cannot-get-a-component-from-contextmenu/178609

However, I'm still missing something here: why should menuTester.find(ComboBox.class).single() or menuTester.find(HorizontalLayout.class).withId("test-content").thenOnFirst(ComboBox.class).single() not work?

[TatuLund]

var div = menuTester.find(Div.class).withText("Component Item").single();

Ah, there is specific find method in ContextMenuTester, I think the original issue was that the generic $(..) method does not find the components.

[mcollovati]

The find method is a feature of base ComponentTester and it searches on component children.
For ContextMenu it makes sense to me to search starting from the menu itself, instead of globally, even if the DOM structure could be different.

[mcollovati]

ContextMenuTester Javadoc should be improved to explain how to find elements on it.