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
|
"""Fixtures for AsusRouter."""
from __future__ import annotations
from collections.abc import Generator
from typing import Any
from unittest.mock import AsyncMock, Mock, patch
import pytest
from asusrouter.connection import Connection
from tests.helpers import (
TCONST_HOST,
TCONST_PASS,
TCONST_USER,
AsyncPatch,
ConnectionFactory,
SyncPatch,
)
@pytest.fixture(name="connection_factory")
def connection_factory() -> ConnectionFactory:
"""Fixture to create a Connection object."""
def _factory(**kwargs: Any) -> Connection:
"""Create a Connection object."""
return Connection(
hostname=TCONST_HOST,
username=TCONST_USER,
password=TCONST_PASS,
**kwargs,
)
return _factory
class UniversalMockPatcher:
"""Universal mock patcher for async methods."""
def __init__(self) -> None:
"""Initialize the UniversalMockPatcher."""
self.patches: list[Any] = []
def patch(
self,
obj: Any,
method_name: str,
side_effect: Any = None,
return_value: Any = None,
mock_type: type = AsyncMock,
) -> AsyncMock | Mock:
"""Patch a method on the provided object."""
patcher = patch.object(obj, method_name, new_callable=mock_type)
mock_method = patcher.start()
self.patches.append(patcher)
if side_effect is not None:
mock_method.side_effect = side_effect
elif return_value is not None:
mock_method.return_value = return_value
return mock_method
def stop(self) -> None:
"""Stop all patches."""
for patcher in self.patches:
patcher.stop()
@pytest.fixture
def universal_mock() -> Generator[UniversalMockPatcher, None, None]:
"""Fixture for a universal mock patcher."""
patcher = UniversalMockPatcher()
yield patcher
patcher.stop()
@pytest.fixture(name="async_connect")
def mock_async_connect(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> AsyncPatch:
"""Fixture to patch the `async_connect` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> AsyncMock:
return universal_mock.patch(
connection, "async_connect", side_effect, return_value
)
return _patch
@pytest.fixture(name="async_connect_with_lock")
def mock_async_connect_with_lock(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> AsyncPatch:
"""Fixture to patch the `_async_connect_with_lock` method with a lock."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> AsyncMock:
return universal_mock.patch(
connection, "_async_connect_with_lock", side_effect, return_value
)
return _patch
@pytest.fixture(name="fallback")
def mock_fallback(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> AsyncPatch:
"""Fixture to patch the `_fallback` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> AsyncMock:
return universal_mock.patch(
connection, "_fallback", side_effect, return_value
)
return _patch
@pytest.fixture(name="log_request")
def mock_log_request(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> SyncPatch:
"""Fixture to patch the `_log_request` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> Mock:
return universal_mock.patch(
connection, "_log_request", side_effect, return_value, Mock
)
return _patch
@pytest.fixture(name="make_request")
def mock_make_request(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> AsyncPatch:
"""Fixture to patch the `_make_request` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> AsyncMock:
return universal_mock.patch(
connection, "_make_request", side_effect, return_value
)
return _patch
@pytest.fixture(name="new_session")
def mock_new_session(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> SyncPatch:
"""Fixture to patch the `_new_session` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> Mock:
return universal_mock.patch(
connection, "_new_session", side_effect, return_value, Mock
)
return _patch
@pytest.fixture(name="payload_for_logging")
def mock_payload_for_logging(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> SyncPatch:
"""Fixture to patch the `_payload_for_logging` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> Mock:
return universal_mock.patch(
connection, "_payload_for_logging", side_effect, return_value, Mock
)
return _patch
@pytest.fixture(name="reset_connection")
def mock_reset_connection(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> SyncPatch:
"""Fixture to patch the `reset_connection` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> Mock:
return universal_mock.patch(
connection, "reset_connection", side_effect, return_value, Mock
)
return _patch
@pytest.fixture(name="send_request")
def mock_send_request(
universal_mock: UniversalMockPatcher, # noqa: F811
) -> AsyncPatch:
"""Fixture to patch the `_send_request` method."""
def _patch(
connection: Any, side_effect: Any = None, return_value: Any = None
) -> AsyncMock:
return universal_mock.patch(
connection, "_send_request", side_effect, return_value
)
return _patch
|