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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
"""Test server functionality."""
import asyncio
import socket
import xml.etree.ElementTree as ET
from contextlib import asynccontextmanager, suppress
from typing import (
Any,
AsyncGenerator,
AsyncIterator,
Awaitable,
Callable,
NamedTuple,
cast,
)
from unittest.mock import Mock
import aiohttp
import pytest
import pytest_asyncio
from aiohttp.test_utils import TestClient
from aiohttp.web import Application, Request
from pytest_aiohttp.plugin import AiohttpClient
import async_upnp_client.aiohttp
import async_upnp_client.server
from async_upnp_client.client import UpnpStateVariable
from async_upnp_client.const import DeviceInfo, ServiceInfo
from async_upnp_client.server import (
UpnpServer,
UpnpServerDevice,
UpnpServerService,
callable_action,
create_event_var,
create_state_var,
)
from async_upnp_client.utils import CaseInsensitiveDict
from .conftest import read_file
class ServerServiceTest(UpnpServerService):
"""Test Service."""
SERVICE_DEFINITION = ServiceInfo(
service_id="urn:upnp-org:serviceId:TestServerService",
service_type="urn:schemas-upnp-org:service:TestServerService:1",
control_url="/upnp/control/TestServerService",
event_sub_url="/upnp/event/TestServerService",
scpd_url="/ContentDirectory.xml",
xml=ET.Element("server_service"),
)
STATE_VARIABLE_DEFINITIONS = {
"TestVariable_str": create_state_var("string"),
"EventableTextVariable_ui4": create_event_var("ui4", default="0"),
"A_ARG_TYPE_In_Var1_str": create_state_var("string"),
"A_ARG_TYPE_In_Var2_ui4": create_state_var("ui4"),
}
@callable_action(
name="SetValues",
in_args={
"In_Var1_str": "A_ARG_TYPE_In_Var1_str",
},
out_args={
"TestVariable_str": "TestVariable_str",
"EventableTextVariable_ui4": "EventableTextVariable_ui4",
},
)
async def set_values(
self, In_Var1_str: str # pylint: disable=invalid-name
) -> dict[str, UpnpStateVariable]:
"""Handle action."""
self.state_variable("TestVariable_str").value = In_Var1_str
return {
"TestVariable_str": self.state_variable("TestVariable_str"),
"EventableTextVariable_ui4": self.state_variable(
"EventableTextVariable_ui4"
),
}
def set_eventable(self, value: int) -> None:
"""Eventable state-variable assignment."""
event_var = self.state_variable("EventableTextVariable_ui4")
event_var.value = value
class ServerDeviceTest(UpnpServerDevice):
"""Test device."""
DEVICE_DEFINITION = DeviceInfo(
device_type=":urn:schemas-upnp-org:device:TestServerDevice:1",
friendly_name="Test Server",
manufacturer="Test",
manufacturer_url=None,
model_name="TestServer",
model_url=None,
udn="uuid:adca2e25-cbe4-427a-a5c3-9b5931e7b79b",
upc=None,
model_description="Test Server",
model_number="v0.0.1",
serial_number="0000001",
presentation_url=None,
url="/device.xml",
icons=[],
xml=ET.Element("server_device"),
)
EMBEDDED_DEVICES = []
SERVICES = [ServerServiceTest]
class AppRunnerMock:
"""Mock AppRunner."""
# pylint: disable=too-few-public-methods
def __init__(self, app: Any, *_args: Any, **_kwargs: Any) -> None:
"""Initialize."""
self.app = app
async def setup(self) -> None:
"""Configure AppRunner."""
class MockSocket:
"""Mock socket without 'bind'."""
def __init__(self, sock: socket.socket) -> None:
"""Initialize."""
self.sock = sock
def bind(self, addr: Any) -> None:
"""Ignore bind."""
def __getattr__(self, name: str) -> Any:
"""Passthrough."""
return getattr(self.sock, name)
class Callback:
"""HTTP server to process callbacks."""
def __init__(self) -> None:
"""Initialize."""
self.callback: (
Callable[[aiohttp.web.Request], Awaitable[aiohttp.web.Response]] | None
) = None
self.session: TestClient[Request, Application] | None = None
self.app = aiohttp.web.Application()
self.app.router.add_route("NOTIFY", "/{tail:.*}", self.handler)
async def start(self, aiohttp_client: AiohttpClient) -> None:
"""Generate session."""
self.session = await aiohttp_client(self.app)
def set_callback(
self, callback: Callable[[aiohttp.web.Request], Awaitable[aiohttp.web.Response]]
) -> None:
"""Assign callback."""
self.callback = callback
async def handler(self, request: aiohttp.web.Request) -> aiohttp.web.Response:
"""Handle callback."""
if self.callback:
return await self.callback(request) # pylint: disable=not-callable
return aiohttp.web.Response(status=200)
@asynccontextmanager
async def ClientSession(self) -> AsyncIterator: # pylint: disable=invalid-name
"""Test session."""
if self.session:
yield self.session
class UpnpServerTuple(NamedTuple):
"""Upnp server tuple."""
http_client: TestClient
ssdp_sockets: list[socket.socket]
callback: Callback
server: UpnpServer
@pytest_asyncio.fixture
async def upnp_server(
monkeypatch: Any, aiohttp_client: AiohttpClient
) -> AsyncGenerator[UpnpServerTuple, None]:
"""Fixture to initialize device."""
# pylint: disable=too-few-public-methods
ssdp_sockets: list[socket.socket] = []
http_client = None
def get_ssdp_socket_mock(
*_args: Any, **_kwargs: Any
) -> tuple[MockSocket, None, None]:
sock1, sock2 = socket.socketpair(socket.AF_UNIX, socket.SOCK_DGRAM)
ssdp_sockets.append(sock2)
return MockSocket(sock1), None, None
class TCPSiteMock:
"""Mock TCP connection."""
def __init__(
self, runner: aiohttp.web.AppRunner, *_args: Any, **_kwargs: Any
) -> None:
self.app = runner.app
self.name = "TCPSiteMock"
async def start(self) -> Any:
"""Create HTTP server."""
nonlocal http_client
http_client = await aiohttp_client(self.app)
return http_client
callback = Callback()
monkeypatch.setattr(async_upnp_client.server, "AppRunner", AppRunnerMock)
monkeypatch.setattr(async_upnp_client.server, "TCPSite", TCPSiteMock)
monkeypatch.setattr(
async_upnp_client.server, "get_ssdp_socket", get_ssdp_socket_mock
)
monkeypatch.setattr(
async_upnp_client.aiohttp, "ClientSession", callback.ClientSession
)
server = UpnpServer(
ServerDeviceTest, ("127.0.0.1", 0), http_port=80, boot_id=1, config_id=1
)
await server.async_start()
assert http_client
assert aiohttp_client
await callback.start(aiohttp_client)
yield UpnpServerTuple(http_client, ssdp_sockets, callback, server)
# await server.async_stop()
for sock in ssdp_sockets:
sock.close()
@pytest.mark.asyncio
async def test_init(upnp_server: UpnpServerTuple) -> None:
"""Test device query."""
# pylint: disable=redefined-outer-name
http_client = upnp_server.http_client
response = await http_client.get("/device.xml")
assert response.status == 200
data = await response.text()
assert data == read_file("server/device.xml").strip()
@pytest.mark.asyncio
async def test_action(upnp_server: UpnpServerTuple) -> None:
"""Test action execution."""
# pylint: disable=redefined-outer-name
http_client = upnp_server.http_client
response = await http_client.post(
"/upnp/control/TestServerService",
data=read_file("server/action_request.xml"),
headers={
"content-type": 'text/xml; charset="utf-8"',
"user-agent": "Linux/1.0 UPnP/1.1 test/1.0",
"soapaction": "urn:schemas-upnp-org:service:TestServerService:1#SetValues",
},
)
assert response.status == 200
data = await response.text()
assert data == read_file("server/action_response.xml").strip()
@pytest.mark.asyncio
async def test_subscribe(upnp_server: UpnpServerTuple) -> None:
"""Test subscription to server event."""
# pylint: disable=redefined-outer-name
event = asyncio.Event()
expect = 0
async def on_callback(request: aiohttp.web.Request) -> aiohttp.web.Response:
nonlocal expect
data = await request.read()
assert (
data
== read_file(f"server/subscribe_response_{expect}.xml").strip().encode()
)
expect += 1
event.set()
return aiohttp.web.Response(status=200)
http_client = upnp_server.http_client
callback = upnp_server.callback
server = upnp_server.server
server_device = server._device # pylint: disable=protected-access
assert server_device
service = cast(
ServerServiceTest,
server_device.service("urn:schemas-upnp-org:service:TestServerService:1"),
)
callback.set_callback(on_callback)
response = await http_client.request(
"SUBSCRIBE",
"/upnp/event/TestServerService",
headers={"CALLBACK": "</foo/bar>", "NT": "upnp:event", "TIMEOUT": "Second-30"},
)
assert response.status == 200
data = await response.text()
assert not data
sid = response.headers.get("SID")
assert sid
with suppress(asyncio.TimeoutError):
await asyncio.wait_for(event.wait(), 2)
assert event.is_set()
event.clear()
while not service.get_subscriber(sid):
await asyncio.sleep(0)
service.set_eventable(1)
with suppress(asyncio.TimeoutError):
await asyncio.wait_for(event.wait(), 2)
assert event.is_set()
def test_send_search_response_ok(upnp_server: UpnpServerTuple) -> None:
"""Test sending search response without any failure."""
# pylint: disable=redefined-outer-name, protected-access
server = upnp_server.server
search_responser = server._search_responder
assert search_responser
assert search_responser._response_transport
response_transport = cast(Mock, search_responser._response_transport)
assert response_transport
response_transport.sendto = Mock(side_effect=None)
headers = CaseInsensitiveDict(
{
"HOST": "192.168.1.100",
"man": '"ssdp:discover"',
"st": "upnp:rootdevice",
"_remote_addr": ("192.168.1.101", 31234),
}
)
search_responser._on_data("M-SEARCH * HTTP/1.1", headers)
response_transport.sendto.assert_called()
def test_send_search_response_oserror(upnp_server: UpnpServerTuple) -> None:
"""Test sending search response and failing, but the error is handled."""
# pylint: disable=redefined-outer-name, protected-access
server = upnp_server.server
search_responser = server._search_responder
assert search_responser
assert search_responser._response_transport
response_transport = cast(Mock, search_responser._response_transport)
assert response_transport
response_transport.sendto = Mock(side_effect=None)
headers = CaseInsensitiveDict(
{
"HOST": "192.168.1.100",
"man": '"ssdp:discover"',
"st": "upnp:rootdevice",
"_remote_addr": ("192.168.1.101", 31234),
}
)
search_responser._on_data("M-SEARCH * HTTP/1.1", headers)
response_transport.sendto.assert_called()
|