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
|
"""Event tests."""
from __future__ import annotations
import asyncio
from unittest.mock import AsyncMock, MagicMock, call
import pytest
from zigpy.event import EventBase
from zigpy.event.event_base import EventListener
class EventGenerator(EventBase):
"""Event generator for testing."""
class Event:
"""Event class for testing."""
event = "test"
event_type = "testing"
def test_event_base_unsubs():
"""Test event base class."""
event = EventGenerator()
assert not event._listeners
assert not event._global_listeners
callback = MagicMock()
unsub = event.on_event("test", callback)
assert event._listeners == {
"test": [EventListener(callback=callback, with_context=False)]
}
unsub()
assert event._listeners == {"test": []}
unsub = event.on_all_events(callback)
assert event._global_listeners == [
EventListener(callback=callback, with_context=False)
]
unsub()
assert not event._global_listeners
unsub = event.once("test", callback)
assert "test" in event._listeners
assert len(event._listeners["test"]) == 1
unsub()
assert event._listeners == {"test": []}
def test_event_base_emit():
"""Test event base class."""
event = EventGenerator()
assert not event._listeners
assert not event._global_listeners
callback = MagicMock()
event.once("test", callback)
event.emit("test")
assert callback.called
callback.reset_mock()
event.emit("test")
assert not callback.called
unsub = event.on_event("test", callback)
event.emit("test")
assert callback.called
unsub()
callback.reset_mock()
unsub = event.on_all_events(callback)
event.emit("test")
assert callback.called
unsub()
assert "test" in event._listeners
assert event._listeners == {"test": []}
assert not event._global_listeners
def test_event_base_emit_data():
"""Test event base class."""
event = EventGenerator()
assert not event._listeners
assert not event._global_listeners
callback = MagicMock()
event.once("test", callback)
event.emit("test", "data")
assert callback.called
assert callback.call_args[0] == ("data",)
callback.reset_mock()
event.emit("test", "data")
assert not callback.called
unsub = event.on_event("test", callback)
event.emit("test", "data")
assert callback.called
assert callback.call_args[0] == ("data",)
unsub()
callback.reset_mock()
unsub = event.on_all_events(callback)
event.emit("test", "data")
assert callback.called
assert callback.call_args[0] == ("data",)
unsub()
assert "test" in event._listeners
assert event._listeners == {"test": []}
assert not event._global_listeners
async def test_event_base_emit_coro():
"""Test event base class."""
event = EventGenerator()
assert not event._listeners
assert not event._global_listeners
callback = AsyncMock()
event.once("test", callback)
event.emit("test", "data")
await asyncio.gather(*event._event_tasks)
assert callback.await_count == 1
assert callback.mock_calls == [call("data")]
assert not event._event_tasks
callback.reset_mock()
unsub = event.on_event("test", callback)
event.emit("test", "data")
await asyncio.gather(*event._event_tasks)
assert callback.await_count == 1
assert callback.mock_calls == [call("data")]
unsub()
assert not event._event_tasks
callback.reset_mock()
unsub = event.on_all_events(callback)
event.emit("test", "data")
await asyncio.gather(*event._event_tasks)
assert callback.await_count == 1
assert callback.mock_calls == [call("data")]
unsub()
assert not event._event_tasks
test_event = Event()
event.on_event(test_event.event, event._handle_event_protocol)
event.handle_test = AsyncMock()
event.emit(test_event.event, test_event)
await asyncio.gather(*event._event_tasks)
assert event.handle_test.await_count == 1
assert event.handle_test.mock_calls == [call(test_event)]
assert not event._event_tasks
async def test_event_emit_with_context():
"""Test event emitting with context."""
event = EventGenerator()
async_callback = AsyncMock()
sync_callback = MagicMock()
event.once("test", sync_callback, with_context=True)
event.once("test", async_callback, with_context=True)
event.emit("test", "data")
await asyncio.gather(*event._event_tasks)
sync_callback.assert_called_once_with("test", "data")
async_callback.assert_awaited_once_with("test", "data")
def test_handle_event_protocol():
"""Test event base class."""
event_handler = EventGenerator()
event_handler.handle_test = MagicMock()
event_handler.on_event("test", event_handler._handle_event_protocol)
event = Event()
event_handler.emit(event.event, event)
assert event_handler.handle_test.called
assert event_handler.handle_test.call_args[0] == (event,)
def test_handle_event_protocol_no_event(caplog: pytest.LogCaptureFixture):
"""Test event base class."""
event_handler = EventGenerator()
event_handler.on_event("not_test", event_handler._handle_event_protocol)
event = Event()
event_handler.emit("not_test", event)
assert "Received unknown event:" in caplog.text
|