UI integration tests setup (#31)

* add find child util function

* create test fixtures for UI testing

* Create test_window_gui.py

* Update pytest.yml

* uxe xvfb

* Update pytest.yml

* Update pytest.yml

* Update pytest.yml

* Update pytest.yml

* temp break

* repair

* Update conftest.py

* rename test_app_controls

* make find_child_by_attribute generic

* StyleTextEdit debounce ms attribute

* Create test_initiative_controls.py

* Update test_initiative_controls.py

* rename app_instance

* use a pyside6 Signal for text debouncing

* use qtbot.waitSignal in test

Author: Conengmo

.github/workflows/pytest.yml

@@ -11,25 +11,37 @@ permissions:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
+    env:
+      # Display must be available globally for linux to know where xvfb is
+      DISPLAY: ":99.0"
+      QT_SELECT: "qt6"
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Install Pyside6 dependencies
+    - name: Install Linux dependencies
       run: |
-        sudo apt update && sudo apt install -y libegl1-mesa-dev
+        # Copied from https://stackoverflow.com/a/77480795/4082914
+        sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 \
+            libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 \
+            libxcb-xfixes0 libxcb-shape0 libglib2.0-0 libgl1-mesa-dev
+        
+        sudo apt-get install '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev \
+            libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
+
+        # start xvfb in the background
+        sudo /usr/bin/Xvfb $DISPLAY -screen 0 1280x1024x24 &
 
     - name: Set up Python 3
       uses: actions/setup-python@v3
 
-    - name: Install dependencies
+    - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-        pip install pytest
+        pip install pytest pytest-qt
 
     - name: Run tests with Pytest
       run: |
-        pytest .
+        pytest tests

battle_map_tv/layouts/initiative_controls.py

@@ -18,7 +18,7 @@ def __init__(self):
         super().__init__()
         self.image_window = get_image_window()
         self.setPlaceholderText("Display initiative order")
-        self.on_text_changed(self.callback)
+        self.textChangedDebounced.connect(self.callback)
 
     def callback(self):
         text = self.toPlainText().strip()

battle_map_tv/utils.py

@@ -1,6 +1,6 @@
-from typing import TYPE_CHECKING, Optional, Tuple
+from typing import TYPE_CHECKING, Optional, Tuple, Type
 
-from PySide6.QtCore import QSize
+from PySide6.QtCore import QObject, QSize
 from PySide6.QtWidgets import QApplication
 
 if TYPE_CHECKING:
@@ -31,3 +31,16 @@ def get_image_window_size_px() -> Tuple[int, int]:
 def get_image_filename() -> Optional[str]:
     image_window = get_image_window()
     return image_window.image.image_filename if image_window.image else None
+
+
+def find_child_by_attribute(parent: QObject, child_type: Type[QObject], text: Optional[str] = None):
+    child: QObject
+    for child in parent.findChildren(child_type):
+        if text:
+            if child.text() == text:  # type: ignore
+                return child
+        else:
+            return child
+    raise AttributeError(
+        f"Could not find child of type {child_type} with text '{text}' in {parent}"
+    )

battle_map_tv/widgets/text_based.py

@@ -1,6 +1,4 @@
-from typing import Callable
-
-from PySide6.QtCore import QTimer
+from PySide6.QtCore import QTimer, Signal
 from PySide6.QtWidgets import QLineEdit, QTextEdit
 
 
@@ -35,6 +33,9 @@ def __init__(
 
 
 class StyledTextEdit(QTextEdit):
+    text_changed_debounce_ms = 700
+    textChangedDebounced = Signal()
+
     def __init__(self):
         super().__init__()
         self.setStyleSheet(
@@ -46,13 +47,11 @@ def __init__(self):
             border-radius: 6px;
         """
         )
+        self._typing_timer = QTimer()
+        self._typing_timer.setSingleShot(True)
+        self._typing_timer.timeout.connect(self.textChangedDebounced.emit)
 
-    def on_text_changed(self, callback: Callable):
-        typing_timer = QTimer()
-        typing_timer.setSingleShot(True)
-        typing_timer.timeout.connect(callback)
-
-        def reset_typing_timer():
-            typing_timer.start(700)
+        self.textChanged.connect(self._reset_typing_timer)
 
-        self.textChanged.connect(reset_typing_timer)
+    def _reset_typing_timer(self):
+        self._typing_timer.start(self.text_changed_debounce_ms)

requirements-dev.txt

@@ -3,4 +3,5 @@ hatch-vcs
 mypy
 pre-commit
 pytest
+pytest-qt
 ruff

tests/conftest.py

@@ -0,0 +1,29 @@
+import pytest
+from PySide6.QtWidgets import QApplication
+
+from battle_map_tv.window_gui import GuiWindow
+from battle_map_tv.window_image import ImageWindow
+
+
+@pytest.fixture
+def app_instance(qtbot):
+    app = QApplication.instance() or QApplication([])
+    return app
+
+
+@pytest.fixture
+def image_window(app_instance, qtbot):
+    image_window = ImageWindow()
+    qtbot.addWidget(image_window)
+    image_window.move(image_window.screen().geometry().center())
+    yield image_window
+    image_window.close()
+
+
+@pytest.fixture
+def gui_window(app_instance, image_window, qtbot):
+    gui_window = GuiWindow()
+    qtbot.addWidget(gui_window)
+    gui_window.move(gui_window.screen().geometry().topLeft())
+    yield gui_window
+    gui_window.close()

tests/ui/test_app_controls.py

@@ -0,0 +1,17 @@
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QPushButton
+
+from battle_map_tv.utils import find_child_by_attribute
+
+
+def test_fullscreen_button(image_window, gui_window, qtbot):
+    fullscreen_button = find_child_by_attribute(gui_window, QPushButton, "Fullscreen")
+    assert fullscreen_button
+
+    # Check if the fullscreen mode is toggled
+    qtbot.mouseClick(fullscreen_button, Qt.LeftButton)  # type: ignore
+    assert image_window.isFullScreen()
+
+    # now click again to make it normal again
+    qtbot.mouseClick(fullscreen_button, Qt.LeftButton)  # type: ignore
+    assert not image_window.isFullScreen()

tests/ui/test_initiative_controls.py

@@ -0,0 +1,18 @@
+from battle_map_tv.layouts.initiative_controls import InitiativeTextArea
+from battle_map_tv.utils import find_child_by_attribute
+
+
+def test_initiative_text_area_updates_image_window(image_window, gui_window, qtbot):
+    text_area = find_child_by_attribute(parent=gui_window, child_type=InitiativeTextArea)
+    text_area.setFocus()
+    assert len(image_window.initiative_overlay_manager.overlays) == 0
+
+    # Simulate writing text in the text area
+    with qtbot.waitSignal(text_area.textChangedDebounced, timeout=5000):
+        qtbot.keyClicks(text_area, "Test Initiative Order")
+    assert len(image_window.initiative_overlay_manager.overlays) == 2
+
+    # Simulate clearing the text area
+    with qtbot.waitSignal(text_area.textChangedDebounced, timeout=5000):
+        qtbot.keyClicks(text_area, "\b" * len("Test Initiative Order"))
+    assert len(image_window.initiative_overlay_manager.overlays) == 0