mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
427 lines
14 KiB
Python
427 lines
14 KiB
Python
from string import punctuation
|
|
|
|
import pytest
|
|
|
|
from textual import events, work
|
|
from textual.app import App, ComposeResult
|
|
from textual.binding import Binding
|
|
from textual.containers import Center, Middle
|
|
from textual.css.errors import StylesheetError
|
|
from textual.pilot import OutOfBounds
|
|
from textual.screen import Screen
|
|
from textual.widgets import Button, Label
|
|
from textual.worker import WorkerFailed
|
|
|
|
KEY_CHARACTERS_TO_TEST = "akTW03" + punctuation
|
|
"""Test some "simple" characters (letters + digits) and all punctuation."""
|
|
|
|
|
|
class CenteredButtonApp(App):
|
|
CSS = """ # Ensure the button is 16 x 3
|
|
Button {
|
|
min-width: 16;
|
|
max-width: 16;
|
|
width: 16;
|
|
min-height: 3;
|
|
max-height: 3;
|
|
height: 3;
|
|
}
|
|
"""
|
|
|
|
def compose(self):
|
|
with Center():
|
|
with Middle():
|
|
yield Button()
|
|
|
|
|
|
class ManyLabelsApp(App):
|
|
"""Auxiliary app with a button following many labels."""
|
|
|
|
AUTO_FOCUS = None # So that there's no auto-scrolling.
|
|
|
|
def compose(self):
|
|
for idx in range(100):
|
|
yield Label(f"label {idx}", id=f"label{idx}")
|
|
yield Button()
|
|
|
|
|
|
async def test_pilot_press_ascii_chars():
|
|
"""Test that the pilot can press most ASCII characters as keys."""
|
|
keys_pressed = []
|
|
|
|
class TestApp(App[None]):
|
|
def on_key(self, event: events.Key) -> None:
|
|
keys_pressed.append(event.character)
|
|
|
|
async with TestApp().run_test() as pilot:
|
|
for char in KEY_CHARACTERS_TO_TEST:
|
|
await pilot.press(char)
|
|
assert keys_pressed[-1] == char
|
|
|
|
|
|
async def test_pilot_exception_catching_app_compose():
|
|
"""Ensuring that test frameworks are aware of exceptions
|
|
inside compose methods when running via Pilot run_test()."""
|
|
|
|
class FailingApp(App):
|
|
def compose(self) -> ComposeResult:
|
|
1 / 0
|
|
yield Label("Beep")
|
|
|
|
with pytest.raises(ZeroDivisionError):
|
|
async with FailingApp().run_test():
|
|
pass
|
|
|
|
|
|
async def test_pilot_exception_catching_widget_compose():
|
|
class SomeScreen(Screen[None]):
|
|
def compose(self) -> ComposeResult:
|
|
1 / 0
|
|
yield Label("Beep")
|
|
|
|
class FailingApp(App[None]):
|
|
def on_mount(self) -> None:
|
|
self.push_screen(SomeScreen())
|
|
|
|
with pytest.raises(ZeroDivisionError):
|
|
async with FailingApp().run_test():
|
|
pass
|
|
|
|
|
|
async def test_pilot_exception_catching_action():
|
|
"""Ensure that exceptions inside action handlers are presented
|
|
to the test framework when running via Pilot run_test()."""
|
|
|
|
class FailingApp(App):
|
|
BINDINGS = [Binding("b", "beep", "beep")]
|
|
|
|
def action_beep(self) -> None:
|
|
1 / 0
|
|
|
|
with pytest.raises(ZeroDivisionError):
|
|
async with FailingApp().run_test() as pilot:
|
|
await pilot.press("b")
|
|
|
|
|
|
async def test_pilot_exception_catching_worker():
|
|
class SimpleAppThatCrashes(App[None]):
|
|
def on_mount(self) -> None:
|
|
self.crash()
|
|
|
|
@work(name="crash")
|
|
async def crash(self) -> None:
|
|
1 / 0
|
|
|
|
with pytest.raises(WorkerFailed) as exc:
|
|
async with SimpleAppThatCrashes().run_test():
|
|
pass
|
|
assert exc.type is ZeroDivisionError
|
|
|
|
|
|
async def test_pilot_click_screen():
|
|
"""Regression test for https://github.com/Textualize/textual/issues/3395.
|
|
|
|
Check we can use `Screen` as a selector for a click."""
|
|
|
|
async with App().run_test() as pilot:
|
|
await pilot.click("Screen")
|
|
|
|
|
|
async def test_pilot_hover_screen():
|
|
"""Regression test for https://github.com/Textualize/textual/issues/3395.
|
|
|
|
Check we can use `Screen` as a selector for a hover."""
|
|
|
|
async with App().run_test() as pilot:
|
|
await pilot.hover("Screen")
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
["method", "screen_size", "offset"],
|
|
[
|
|
#
|
|
("click", (80, 24), (100, 12)), # Right of screen.
|
|
("click", (80, 24), (100, 36)), # Bottom-right of screen.
|
|
("click", (80, 24), (50, 36)), # Under screen.
|
|
("click", (80, 24), (-10, 36)), # Bottom-left of screen.
|
|
("click", (80, 24), (-10, 12)), # Left of screen.
|
|
("click", (80, 24), (-10, -2)), # Top-left of screen.
|
|
("click", (80, 24), (50, -2)), # Above screen.
|
|
("click", (80, 24), (100, -2)), # Top-right of screen.
|
|
#
|
|
("click", (5, 5), (7, 3)), # Right of screen.
|
|
("click", (5, 5), (7, 7)), # Bottom-right of screen.
|
|
("click", (5, 5), (3, 7)), # Under screen.
|
|
("click", (5, 5), (-1, 7)), # Bottom-left of screen.
|
|
("click", (5, 5), (-1, 3)), # Left of screen.
|
|
("click", (5, 5), (-1, -1)), # Top-left of screen.
|
|
("click", (5, 5), (3, -1)), # Above screen.
|
|
("click", (5, 5), (7, -1)), # Top-right of screen.
|
|
#
|
|
("hover", (80, 24), (100, 12)), # Right of screen.
|
|
("hover", (80, 24), (100, 36)), # Bottom-right of screen.
|
|
("hover", (80, 24), (50, 36)), # Under screen.
|
|
("hover", (80, 24), (-10, 36)), # Bottom-left of screen.
|
|
("hover", (80, 24), (-10, 12)), # Left of screen.
|
|
("hover", (80, 24), (-10, -2)), # Top-left of screen.
|
|
("hover", (80, 24), (50, -2)), # Above screen.
|
|
("hover", (80, 24), (100, -2)), # Top-right of screen.
|
|
#
|
|
("hover", (5, 5), (7, 3)), # Right of screen.
|
|
("hover", (5, 5), (7, 7)), # Bottom-right of screen.
|
|
("hover", (5, 5), (3, 7)), # Under screen.
|
|
("hover", (5, 5), (-1, 7)), # Bottom-left of screen.
|
|
("hover", (5, 5), (-1, 3)), # Left of screen.
|
|
("hover", (5, 5), (-1, -1)), # Top-left of screen.
|
|
("hover", (5, 5), (3, -1)), # Above screen.
|
|
("hover", (5, 5), (7, -1)), # Top-right of screen.
|
|
#
|
|
("mouse_down", (80, 24), (100, 12)), # Right of screen.
|
|
("mouse_down", (80, 24), (100, 36)), # Bottom-right of screen.
|
|
("mouse_down", (80, 24), (50, 36)), # Under screen.
|
|
("mouse_down", (80, 24), (-10, 36)), # Bottom-left of screen.
|
|
("mouse_down", (80, 24), (-10, 12)), # Left of screen.
|
|
("mouse_down", (80, 24), (-10, -2)), # Top-left of screen.
|
|
("mouse_down", (80, 24), (50, -2)), # Above screen.
|
|
("mouse_down", (80, 24), (100, -2)), # Top-right of screen.
|
|
#
|
|
("mouse_down", (5, 5), (7, 3)), # Right of screen.
|
|
("mouse_down", (5, 5), (7, 7)), # Bottom-right of screen.
|
|
("mouse_down", (5, 5), (3, 7)), # Under screen.
|
|
("mouse_down", (5, 5), (-1, 7)), # Bottom-left of screen.
|
|
("mouse_down", (5, 5), (-1, 3)), # Left of screen.
|
|
("mouse_down", (5, 5), (-1, -1)), # Top-left of screen.
|
|
("mouse_down", (5, 5), (3, -1)), # Above screen.
|
|
("mouse_down", (5, 5), (7, -1)), # Top-right of screen.
|
|
#
|
|
("mouse_up", (80, 24), (100, 12)), # Right of screen.
|
|
("mouse_up", (80, 24), (100, 36)), # Bottom-right of screen.
|
|
("mouse_up", (80, 24), (50, 36)), # Under screen.
|
|
("mouse_up", (80, 24), (-10, 36)), # Bottom-left of screen.
|
|
("mouse_up", (80, 24), (-10, 12)), # Left of screen.
|
|
("mouse_up", (80, 24), (-10, -2)), # Top-left of screen.
|
|
("mouse_up", (80, 24), (50, -2)), # Above screen.
|
|
("mouse_up", (80, 24), (100, -2)), # Top-right of screen.
|
|
#
|
|
("mouse_up", (5, 5), (7, 3)), # Right of screen.
|
|
("mouse_up", (5, 5), (7, 7)), # Bottom-right of screen.
|
|
("mouse_up", (5, 5), (3, 7)), # Under screen.
|
|
("mouse_up", (5, 5), (-1, 7)), # Bottom-left of screen.
|
|
("mouse_up", (5, 5), (-1, 3)), # Left of screen.
|
|
("mouse_up", (5, 5), (-1, -1)), # Top-left of screen.
|
|
("mouse_up", (5, 5), (3, -1)), # Above screen.
|
|
("mouse_up", (5, 5), (7, -1)), # Top-right of screen.
|
|
],
|
|
)
|
|
async def test_pilot_target_outside_screen_errors(method, screen_size, offset):
|
|
"""Make sure that targeting a click/hover completely outside of the screen errors."""
|
|
app = App()
|
|
async with app.run_test(size=screen_size) as pilot:
|
|
pilot_method = getattr(pilot, method)
|
|
with pytest.raises(OutOfBounds):
|
|
await pilot_method(offset=offset)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
["method", "offset"],
|
|
[
|
|
("click", (0, 0)), # Top-left corner.
|
|
("click", (40, 0)), # Top edge.
|
|
("click", (79, 0)), # Top-right corner.
|
|
("click", (79, 12)), # Right edge.
|
|
("click", (79, 23)), # Bottom-right corner.
|
|
("click", (40, 23)), # Bottom edge.
|
|
("click", (40, 23)), # Bottom-left corner.
|
|
("click", (0, 12)), # Left edge.
|
|
("click", (40, 12)), # Right in the middle.
|
|
#
|
|
("hover", (0, 0)), # Top-left corner.
|
|
("hover", (40, 0)), # Top edge.
|
|
("hover", (79, 0)), # Top-right corner.
|
|
("hover", (79, 12)), # Right edge.
|
|
("hover", (79, 23)), # Bottom-right corner.
|
|
("hover", (40, 23)), # Bottom edge.
|
|
("hover", (40, 23)), # Bottom-left corner.
|
|
("hover", (0, 12)), # Left edge.
|
|
("hover", (40, 12)), # Right in the middle.
|
|
#
|
|
("mouse_down", (0, 0)), # Top-left corner.
|
|
("mouse_down", (40, 0)), # Top edge.
|
|
("mouse_down", (79, 0)), # Top-right corner.
|
|
("mouse_down", (79, 12)), # Right edge.
|
|
("mouse_down", (79, 23)), # Bottom-right corner.
|
|
("mouse_down", (40, 23)), # Bottom edge.
|
|
("mouse_down", (40, 23)), # Bottom-left corner.
|
|
("mouse_down", (0, 12)), # Left edge.
|
|
("mouse_down", (40, 12)), # Right in the middle.
|
|
#
|
|
("mouse_up", (0, 0)), # Top-left corner.
|
|
("mouse_up", (40, 0)), # Top edge.
|
|
("mouse_up", (79, 0)), # Top-right corner.
|
|
("mouse_up", (79, 12)), # Right edge.
|
|
("mouse_up", (79, 23)), # Bottom-right corner.
|
|
("mouse_up", (40, 23)), # Bottom edge.
|
|
("mouse_up", (40, 23)), # Bottom-left corner.
|
|
("mouse_up", (0, 12)), # Left edge.
|
|
("mouse_up", (40, 12)), # Right in the middle.
|
|
],
|
|
)
|
|
async def test_pilot_target_inside_screen_is_fine_with_correct_coordinate_system(
|
|
method, offset
|
|
):
|
|
"""Make sure that the coordinate system for the click is the correct one.
|
|
|
|
Especially relevant because I kept getting confused about the way it works.
|
|
"""
|
|
app = ManyLabelsApp()
|
|
async with app.run_test(size=(80, 24)) as pilot:
|
|
app.query_one("#label99").scroll_visible(animate=False)
|
|
await pilot.pause()
|
|
|
|
pilot_method = getattr(pilot, method)
|
|
await pilot_method(offset=offset)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
["method", "target"],
|
|
[
|
|
("click", "#label0"),
|
|
("click", "#label90"),
|
|
("click", Button),
|
|
#
|
|
("hover", "#label0"),
|
|
("hover", "#label90"),
|
|
("hover", Button),
|
|
#
|
|
("mouse_down", "#label0"),
|
|
("mouse_down", "#label90"),
|
|
("mouse_down", Button),
|
|
#
|
|
("mouse_up", "#label0"),
|
|
("mouse_up", "#label90"),
|
|
("mouse_up", Button),
|
|
],
|
|
)
|
|
async def test_pilot_target_on_widget_that_is_not_visible_errors(method, target):
|
|
"""Make sure that clicking a widget that is not scrolled into view raises an error."""
|
|
app = ManyLabelsApp()
|
|
async with app.run_test(size=(80, 5)) as pilot:
|
|
app.query_one("#label50").scroll_visible(animate=False)
|
|
await pilot.pause()
|
|
|
|
pilot_method = getattr(pilot, method)
|
|
with pytest.raises(OutOfBounds):
|
|
await pilot_method(target)
|
|
|
|
|
|
@pytest.mark.parametrize("method", ["click", "hover", "mouse_down", "mouse_up"])
|
|
async def test_pilot_target_widget_under_another_widget(method):
|
|
"""The targeting method should return False when the targeted widget is covered."""
|
|
|
|
class ObscuredButton(App):
|
|
CSS = """
|
|
Label {
|
|
width: 30;
|
|
height: 5;
|
|
}
|
|
"""
|
|
|
|
def compose(self):
|
|
yield Button()
|
|
yield Label()
|
|
|
|
def on_mount(self):
|
|
self.query_one(Label).styles.offset = (0, -3)
|
|
|
|
app = ObscuredButton()
|
|
async with app.run_test() as pilot:
|
|
await pilot.pause()
|
|
pilot_method = getattr(pilot, method)
|
|
assert (await pilot_method(Button)) is False
|
|
|
|
|
|
@pytest.mark.parametrize("method", ["click", "hover", "mouse_down", "mouse_up"])
|
|
async def test_pilot_target_visible_widget(method):
|
|
"""The targeting method should return True when the targeted widget is hit."""
|
|
|
|
class ObscuredButton(App):
|
|
def compose(self):
|
|
yield Button()
|
|
|
|
app = ObscuredButton()
|
|
async with app.run_test() as pilot:
|
|
await pilot.pause()
|
|
pilot_method = getattr(pilot, method)
|
|
assert (await pilot_method(Button)) is True
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
["method", "offset"],
|
|
[
|
|
("click", (0, 0)),
|
|
("click", (2, 0)),
|
|
("click", (10, 23)),
|
|
("click", (70, 0)),
|
|
#
|
|
("hover", (0, 0)),
|
|
("hover", (2, 0)),
|
|
("hover", (10, 23)),
|
|
("hover", (70, 0)),
|
|
#
|
|
("mouse_down", (0, 0)),
|
|
("mouse_down", (2, 0)),
|
|
("mouse_down", (10, 23)),
|
|
("mouse_down", (70, 0)),
|
|
#
|
|
("mouse_up", (0, 0)),
|
|
("mouse_up", (2, 0)),
|
|
("mouse_up", (10, 23)),
|
|
("mouse_up", (70, 0)),
|
|
],
|
|
)
|
|
async def test_pilot_target_screen_always_true(method, offset):
|
|
app = ManyLabelsApp()
|
|
async with app.run_test(size=(80, 24)) as pilot:
|
|
pilot_method = getattr(pilot, method)
|
|
assert (await pilot_method(offset=offset)) is True
|
|
|
|
|
|
async def test_pilot_resize_terminal():
|
|
app = App()
|
|
async with app.run_test(size=(80, 24)) as pilot:
|
|
# Sanity checks.
|
|
assert app.size == (80, 24)
|
|
assert app.screen.size == (80, 24)
|
|
await pilot.resize_terminal(27, 15)
|
|
await pilot.pause()
|
|
assert app.size == (27, 15)
|
|
assert app.screen.size == (27, 15)
|
|
|
|
|
|
async def test_fail_early():
|
|
# https://github.com/Textualize/textual/issues/3282
|
|
class MyApp(App):
|
|
CSS_PATH = "foo.tcss"
|
|
|
|
app = MyApp()
|
|
with pytest.raises(StylesheetError):
|
|
async with app.run_test() as pilot:
|
|
await pilot.press("enter")
|
|
|
|
|
|
async def test_click_by_widget():
|
|
"""Test that click accept a Widget instance."""
|
|
pressed = False
|
|
|
|
class TestApp(CenteredButtonApp):
|
|
def on_button_pressed(self):
|
|
nonlocal pressed
|
|
pressed = True
|
|
|
|
app = TestApp()
|
|
async with app.run_test() as pilot:
|
|
button = app.query_one(Button)
|
|
assert not pressed
|
|
await pilot.click(button)
|
|
assert pressed
|