1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
|
from __future__ import annotations
import sys
from pathlib import Path
from typing import TYPE_CHECKING
from unittest.mock import Mock
import pytest
from app_model import Action, Application
from app_model.types import KeyCode, KeyMod, SubmenuItem
if TYPE_CHECKING:
from collections.abc import Iterator
from typing import NoReturn
try:
from fonticon_fa6 import FA6S
UNDO_ICON = FA6S.rotate_left
except ImportError:
UNDO_ICON = "fa6-solid:undo"
FIXTURES = Path(__file__).parent / "fixtures"
class Menus:
FILE = "file"
EDIT = "edit"
HELP = "help"
FILE_OPEN_FROM = "file/open_from"
class Commands:
TOP = "top"
OPEN = "open"
UNDO = "undo"
REDO = "redo"
COPY = "copy"
PASTE = "paste"
TOGGLE_THING = "toggle_thing"
OPEN_FROM_A = "open.from_a"
OPEN_FROM_B = "open.from_b"
UNIMPORTABLE = "unimportable"
NOT_CALLABLE = "not.callable"
RAISES = "raises.error"
def _raise_an_error() -> NoReturn:
raise ValueError("This is an error")
class Mocks:
def __init__(self) -> None:
self.open = Mock(name=Commands.OPEN)
self.undo = Mock(name=Commands.UNDO)
self.copy = Mock(name=Commands.COPY)
self.paste = Mock(name=Commands.PASTE)
self.open_from_a = Mock(name=Commands.OPEN_FROM_A)
self.open_from_b = Mock(name=Commands.OPEN_FROM_B)
@property
def redo(self) -> Mock:
"""This tests that we can lazily import a callback.
There is a function called `run_me` in fixtures/fake_module.py that calls the
global mock in that module. In the redo action below, we declare:
`callback="fake_module:run_me"`
So, whenever the redo action is triggered, it should import that module, and
then call the mock. We can also access it here at `mocks.redo`... but the
fixtures directory must be added to sys path during the test (as we do below)
"""
try:
from fake_module import GLOBAL_MOCK
return GLOBAL_MOCK
except ImportError as e:
raise ImportError(
"This mock must be run with the fixutres directory added to sys.path."
) from e
class FullApp(Application):
Menus = Menus
Commands = Commands
def __init__(self, name: str) -> None:
super().__init__(name)
self.mocks = Mocks()
def build_app(name: str = "complete_test_app") -> FullApp:
app = FullApp(name)
app.menus.append_menu_items(
[
(
Menus.FILE,
SubmenuItem(
submenu=Menus.FILE_OPEN_FROM,
title="Open From...",
icon="fa6s.folder-open",
when="not something_open",
enablement="friday",
),
)
]
)
actions: list[Action] = [
Action(
id=Commands.OPEN,
title="Open...",
callback=app.mocks.open,
menus=[{"id": Menus.FILE}],
keybindings=[{"primary": "Ctrl+O"}],
),
# putting these above undo redo to make sure that group sorting works
Action(
id=Commands.COPY,
title="Copy",
icon="fa6-solid:copy", # iconify font style works too
callback=app.mocks.copy,
menus=[{"id": Menus.EDIT, "group": "2_copy_paste"}],
keybindings=[{"primary": KeyMod.CtrlCmd | KeyCode.KeyC}],
),
Action(
id=Commands.PASTE,
title="Paste",
icon="fa6s.paste",
callback=app.mocks.paste,
menus=[{"id": Menus.EDIT, "group": "2_copy_paste"}],
keybindings=[{"primary": "Ctrl+V", "mac": "Cmd+V"}],
),
# putting this above UNDO to make sure that order sorting works
Action(
id=Commands.REDO,
title="Redo",
tooltip="Redo it!",
icon="fa6-solid:rotate-right",
enablement="allow_undo_redo",
callback="fake_module:run_me", # this is a function in fixtures
keybindings=[{"primary": "Ctrl+Shift+Z"}],
menus=[
{
"id": Menus.EDIT,
"group": "1_undo_redo",
"order": 1,
"when": "not something_to_undo",
}
],
),
Action(
id=Commands.UNDO,
tooltip="Undo it!",
title="Undo",
icon=UNDO_ICON, # testing alternate way to specify icon
enablement="allow_undo_redo",
callback=app.mocks.undo,
keybindings=[{"primary": "Ctrl+Z"}],
menus=[
{
"id": Menus.EDIT,
"group": "1_undo_redo",
"order": 0,
"when": "something_to_undo",
}
],
),
# test the navigation key
Action(
id=Commands.TOP,
title="AtTop",
callback=lambda: None,
menus=[{"id": Menus.EDIT, "group": "navigation"}],
),
# test submenus
Action(
id=Commands.OPEN_FROM_A,
title="Open from A",
callback=app.mocks.open_from_a,
menus=[{"id": Menus.FILE_OPEN_FROM}],
),
Action(
id=Commands.OPEN_FROM_B,
title="Open from B",
callback=app.mocks.open_from_b,
menus=[{"id": Menus.FILE_OPEN_FROM}],
enablement="sat",
),
Action(
id=Commands.UNIMPORTABLE,
title="Can't be found",
callback="unresolvable:function",
),
Action(
id=Commands.NOT_CALLABLE,
title="Will Never Work",
callback="fake_module:attr",
),
Action(
id=Commands.RAISES,
title="Will raise an error",
callback=_raise_an_error,
),
Action(
id=Commands.TOGGLE_THING,
title="Toggle Thing",
callback=lambda: None,
menus=[{"id": Menus.HELP}],
toggled="thing_toggled",
),
]
for action in actions:
app.register_action(action)
return app
@pytest.fixture
def full_app(monkeypatch: pytest.MonkeyPatch) -> Iterator[Application]:
"""Premade application."""
try:
app = build_app("complete_test_app")
with monkeypatch.context() as m:
# mock path to add fake_module
m.setattr(sys, "path", [str(FIXTURES), *sys.path])
# make sure it's not already in sys.modules
sys.modules.pop("fake_module", None)
yield app
# clear the global mock if it's been called
app.mocks.redo.reset_mock()
finally:
Application.destroy("complete_test_app")
@pytest.fixture
def simple_app() -> Iterator[Application]:
app = Application("test")
app.commands_changed = Mock()
app.commands.registered.connect(app.commands_changed)
app.keybindings_changed = Mock()
app.keybindings.registered.connect(app.keybindings_changed)
app.menus_changed = Mock()
app.menus.menus_changed.connect(app.menus_changed)
yield app
Application.destroy("test")
assert "test" not in Application._instances
|