user.should_see doesn't work with ui.tree

[davetapley]

First Check

• I added a very descriptive title here.
• This is not a Q&A. I am sure something is wrong with NiceGUI or its documentation.
• I used the GitHub search to find a similar issue and came up empty.

Example Code

# main.py

from nicegui import ui

ui.label('Hello World!')

ui.tree([
    {'id': 'numbers', 'children': [{'id': '1'}, {'id': '2'}]},
    {'id': 'letters', 'children': [{'id': 'A'}, {'id': 'B'}]},
], label_key='id', on_select=lambda e: ui.notify(e.value))

ui.run()

# test_tree.py

import pytest
from nicegui import ui
from nicegui.testing import User
from . import main

pytest_plugins = ['nicegui.testing.user_plugin']


@pytest.mark.module_under_test(main)
async def test_click(user: User) -> None:
    await user.open('/')

    # sanity check
    await user.should_see('Hello World!')

    # verify the tree is there
    tree = list(user.find(ui.tree).elements)[0]
    nodes = tree.props['nodes']
    assert len(nodes) == 2
    first = nodes[0]
    assert first['id'] == 'numbers'

    # this fails:
    await user.should_see('numbers')

E       AssertionError: expected to see at least one element with marker=numbers or content=numbers on the page:
E       q-layout
E        q-page-container
E         q-page
E          div
E           Label [text=Hello World!]
E           Tree [nodes=[{'id': 'numbers', '..., node-key=id, label-key=id, children-key=children]

Description

I can see 'numbers' here ⬇️ so I'd expect user.should_see('numbers') to pass.

NiceGUI Version

2.20.0

Python Version

3.12.3

Browser

Other

Operating System

Linux

Additional Context

Test per the docs, tree per the docs.

[falkoschindler]

Hi @davetapley,

I converted your issue into a feature request. As mentioned in the documentation here:

There are some elements with complex visualization and interaction behaviors (ui.upload, ui.table, ...). Not every aspect of these elements can be tested with should_see and UserInteraction. Still, you can grab them with user.find(...) and do the testing on the elements themselves.

Adding full support for user-testing ui.tree is probably a bit advanced because we need to traverse nodes, correctly use the label_key to get the displayed label text, ignore collapsed nodes, and - to support .click() - act depending on the tick_strategy.

Let's see if there is demand by counting votes for this feature request.

[falkoschindler]

Quick update: PR #5069 is in review.