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
|
"""Tests for the base_character module including the BaseCharacter class and the EventHandler class."""
from __future__ import annotations
from typing import Any
import pytest
from terminaltexteffects.engine.base_character import EffectCharacter, EventHandler
from terminaltexteffects.engine.motion import Path
from terminaltexteffects.utils.exceptions.base_character_exceptions import (
DuplicateEventRegistrationError,
EventRegistrationCallerError,
EventRegistrationTargetError,
)
from terminaltexteffects.utils.geometry import Coord
pytestmark = [pytest.mark.engine, pytest.mark.base_character, pytest.mark.smoke]
@pytest.fixture
def effectcharacter() -> EffectCharacter:
"""Fixture for creating an EffectCharacter instance."""
return EffectCharacter(0, "a", 1, 1)
@pytest.fixture
def eventhandler(effectcharacter: EffectCharacter) -> EventHandler:
"""Fixture for creating an EventHandler instance."""
return EventHandler(effectcharacter)
def test_eventhandler_init(eventhandler: EventHandler, effectcharacter: EffectCharacter) -> None:
"""Test the initialization of EventHandler."""
assert eventhandler.character == effectcharacter
assert eventhandler.registered_events == {}
def test_eventhandler_callback_init(eventhandler: EventHandler) -> None:
"""Test the initialization of EventHandler.Callback."""
def func(*_: Any) -> None:
pass
cb = eventhandler.Callback(func, "a")
assert cb.callback == func
assert len(cb.args) == 1
@pytest.mark.parametrize(
"event",
[
EventHandler.Event.PATH_COMPLETE,
EventHandler.Event.PATH_ACTIVATED,
EventHandler.Event.PATH_HOLDING,
EventHandler.Event.SCENE_ACTIVATED,
EventHandler.Event.SCENE_COMPLETE,
EventHandler.Event.SEGMENT_ENTERED,
EventHandler.Event.SEGMENT_EXITED,
],
)
def test_eventhandler_register_event_invalid_event_caller(
event: EventHandler.Event,
eventhandler: EventHandler,
) -> None:
"""Test registering an event with an invalid event caller."""
with pytest.raises(EventRegistrationCallerError):
eventhandler.register_event(event, 1, EventHandler.Action.ACTIVATE_PATH, Path("a")) # type: ignore[call-overload]
@pytest.mark.parametrize(
"event_caller_action_target",
[
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.ACTIVATE_PATH, 1),
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.DEACTIVATE_PATH, 1),
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.ACTIVATE_SCENE, 1),
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.DEACTIVATE_SCENE, 1),
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.CALLBACK, 1),
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.SET_LAYER, ""),
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.SET_COORDINATE, 1),
(EventHandler.Event.PATH_COMPLETE, Path("a"), EventHandler.Action.RESET_APPEARANCE, 1),
],
)
def test_eventhandler_register_event_invalid_target(
eventhandler: EventHandler,
event_caller_action_target: tuple[EventHandler.Event, Path, EventHandler.Action, str],
) -> None:
"""Test registering an event with an invalid target."""
event, caller, action, target = event_caller_action_target
with pytest.raises(EventRegistrationTargetError):
eventhandler.register_event(event, caller, action, target) # type: ignore[call-overload]
def test_eventhandler_register_event(eventhandler: EventHandler) -> None:
"""Test registering a valid event."""
p1 = Path("a")
p2 = Path("b")
eventhandler.register_event(EventHandler.Event.PATH_COMPLETE, p1, EventHandler.Action.ACTIVATE_PATH, p2)
assert (
eventhandler.registered_events[(EventHandler.Event.PATH_COMPLETE, p1)][0][0]
is EventHandler.Action.ACTIVATE_PATH
)
assert eventhandler.registered_events[(EventHandler.Event.PATH_COMPLETE, p1)][0][1] is p2
def test_eventhandler_register_event_duplicate_raises_error(eventhandler: EventHandler) -> None:
"""Test that registering the same event-caller-action-target combination raises DuplicateEventRegistrationError."""
p1 = Path("a")
p2 = Path("b")
# Register the event once - should succeed
eventhandler.register_event(EventHandler.Event.PATH_COMPLETE, p1, EventHandler.Action.ACTIVATE_PATH, p2)
# Try to register the same combination again - should raise error
with pytest.raises(DuplicateEventRegistrationError):
eventhandler.register_event(EventHandler.Event.PATH_COMPLETE, p1, EventHandler.Action.ACTIVATE_PATH, p2)
def test_eventhandler_handle_event(eventhandler: EventHandler) -> None:
"""Test handling an event."""
p1 = Path("a")
p2 = Path("b")
p2.new_waypoint(Coord(0, 0))
eventhandler.register_event(EventHandler.Event.PATH_COMPLETE, p1, EventHandler.Action.ACTIVATE_PATH, p2)
eventhandler._handle_event(EventHandler.Event.PATH_COMPLETE, p1)
assert eventhandler.character.motion.active_path == p2
def test_effectcharacter_init(effectcharacter: EffectCharacter) -> None:
"""Test the initialization of EffectCharacter."""
assert effectcharacter.character_id == 0
assert effectcharacter._input_symbol == "a"
assert effectcharacter._input_coord == Coord(1, 1)
assert effectcharacter._input_ansi_sequences == {"fg_color": None, "bg_color": None}
assert effectcharacter._is_visible is False
assert effectcharacter.layer == 0
assert effectcharacter.is_fill_character is False
def test_effectcharacter_repr(effectcharacter: EffectCharacter) -> None:
"""Test the __repr__ method of EffectCharacter."""
assert repr(effectcharacter) == "EffectCharacter(character_id=0, symbol='a', input_column=1, input_row=1)"
def test_effectcharacter_hash_consistency(effectcharacter: EffectCharacter) -> None:
"""Test the consistency of the __hash__ method of EffectCharacter."""
assert hash(effectcharacter) == hash(effectcharacter)
def test_effectcharacter_objects_have_same_hash(effectcharacter: EffectCharacter) -> None:
"""Test that two EffectCharacter objects with the same attributes have the same hash."""
effectcharacter2 = EffectCharacter(0, "a", 1, 1)
assert hash(effectcharacter) == hash(effectcharacter2)
def test_effectcharacter_properties(effectcharacter: EffectCharacter) -> None:
"""Test the properties of EffectCharacter."""
assert effectcharacter.input_symbol == "a"
assert effectcharacter.input_coord == Coord(1, 1)
assert effectcharacter.is_visible is False
assert effectcharacter.character_id == 0
assert effectcharacter.is_active is False
def test_effectcharacter_is_active(effectcharacter: EffectCharacter) -> None:
"""Test the is_active property of EffectCharacter."""
assert effectcharacter.is_active is False
p = effectcharacter.motion.new_path()
p.new_waypoint(Coord(0, 0))
effectcharacter.motion.activate_path(p)
assert effectcharacter.is_active is True
def test_effectcharacter_tick_no_paths_or_scenes(effectcharacter: EffectCharacter) -> None:
"""Test that tick does not fail when there are no paths or scenes."""
effectcharacter.tick()
def test_effectcharacter_tick_scene_and_path(effectcharacter: EffectCharacter) -> None:
"""Test that tick updates both scene and path correctly."""
p = effectcharacter.motion.new_path()
p.new_waypoint(Coord(3, 3))
effectcharacter.motion.activate_path(p)
s = effectcharacter.animation.new_scene()
s.add_frame("a", duration=2)
effectcharacter.animation.activate_scene(s)
effectcharacter.tick()
assert effectcharacter.animation.active_scene.frames[0].ticks_elapsed == 1 # type: ignore[union-attr]
assert effectcharacter.motion.active_path.current_step == 1 # type: ignore[union-attr]
def test_effectcharacter_equal_invalid_type(effectcharacter: EffectCharacter) -> None:
"""Test that __eq__ returns NotImplemented when comparing with an invalid type."""
assert effectcharacter.__eq__("a") is NotImplemented
|
