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 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
|
import asyncio
import socket
from collections.abc import AsyncGenerator, Generator
from ipaddress import IPv4Address, IPv6Address
from typing import Any, NoReturn
from unittest.mock import patch
import pytest
import pytest_asyncio
from aiohttp.resolver import ResolveResult
from zeroconf.asyncio import AsyncZeroconf
from aiohttp_asyncmdnsresolver._impl import (
_FAMILY_TO_RESOLVER_CLASS,
AddressResolver,
AddressResolverIPv4,
AddressResolverIPv6,
)
from aiohttp_asyncmdnsresolver.api import AsyncDualMDNSResolver, AsyncMDNSResolver
class IPv6orIPv4HostResolver(AddressResolver):
"""Patchable class for testing."""
class IPv4HostResolver(AddressResolverIPv4):
"""Patchable class for testing."""
class IPv6HostResolver(AddressResolverIPv6):
"""Patchable class for testing."""
@pytest.fixture(autouse=True)
def make_resolvers_patchable() -> Generator[None, None, None]:
"""Patch the resolvers."""
with patch.dict(
_FAMILY_TO_RESOLVER_CLASS,
{
socket.AF_INET: IPv4HostResolver,
socket.AF_INET6: IPv6HostResolver,
socket.AF_UNSPEC: IPv6orIPv4HostResolver,
},
):
yield
@pytest_asyncio.fixture
async def resolver() -> AsyncGenerator[AsyncMDNSResolver]:
"""Return a resolver."""
resolver = AsyncMDNSResolver(mdns_timeout=0.1)
yield resolver
await resolver.close()
@pytest_asyncio.fixture
async def dual_resolver() -> AsyncGenerator[AsyncDualMDNSResolver]:
"""Return a dual resolver."""
dual_resolver = AsyncDualMDNSResolver(mdns_timeout=0.1)
yield dual_resolver
await dual_resolver.close()
@pytest_asyncio.fixture
async def custom_resolver() -> AsyncGenerator[AsyncMDNSResolver]:
"""Return a resolver."""
aiozc = AsyncZeroconf()
resolver = AsyncMDNSResolver(mdns_timeout=0.1, async_zeroconf=aiozc)
yield resolver
await resolver.close()
await aiozc.async_close()
@pytest.mark.asyncio
async def test_resolve_localhost_with_async_mdns_resolver(
resolver: AsyncMDNSResolver,
) -> None:
"""Test the resolve method delegates to AsyncResolver for non MDNS."""
with patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
return_value=[ResolveResult(hostname="localhost", host="127.0.0.1")], # type: ignore[typeddict-item]
):
results = await resolver.resolve("localhost")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost"
assert result["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_resolve_localhost_with_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test the resolve method delegates to AsyncDualMDNSResolver for non MDNS."""
with patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
return_value=[ResolveResult(hostname="localhost", host="127.0.0.1")], # type: ignore[typeddict-item]
):
results = await dual_resolver.resolve("localhost")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost"
assert result["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_resolve_mdns_name_unspec(resolver: AsyncMDNSResolver) -> None:
"""Test the resolve method with unspecified family."""
with (
patch.object(IPv6orIPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv6orIPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.1"), IPv6Address("::1")],
),
):
result = await resolver.resolve("localhost.local", family=socket.AF_UNSPEC)
assert result is not None
assert len(result) == 2
assert result[0]["hostname"] == "localhost.local."
assert result[0]["host"] == "127.0.0.1"
assert result[1]["hostname"] == "localhost.local."
assert result[1]["host"] == "::1"
@pytest.mark.asyncio
async def test_resolve_mdns_name_unspec_from_cache(resolver: AsyncMDNSResolver) -> None:
"""Test the resolve method from_cache."""
with (
patch.object(IPv6orIPv4HostResolver, "load_from_cache", return_value=True),
patch.object(
IPv6orIPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.1"), IPv6Address("::1")],
),
):
result = await resolver.resolve("localhost.local", 80, family=socket.AF_UNSPEC)
assert result is not None
assert len(result) == 2
assert result[0]["hostname"] == "localhost.local."
assert result[0]["host"] == "127.0.0.1"
assert result[0]["port"] == 80
assert result[1]["hostname"] == "localhost.local."
assert result[1]["host"] == "::1"
assert result[1]["port"] == 80
@pytest.mark.asyncio
async def test_resolve_mdns_name_unspec_no_results(resolver: AsyncMDNSResolver) -> None:
"""Test the resolve method no results."""
with (
patch.object(IPv6orIPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv6orIPv4HostResolver,
"ip_addresses_by_version",
return_value=[],
),
pytest.raises(OSError, match="MDNS lookup failed"),
):
await resolver.resolve("localhost.local", family=socket.AF_UNSPEC)
@pytest.mark.asyncio
async def test_resolve_mdns_name_unspec_trailing_dot(
resolver: AsyncMDNSResolver,
) -> None:
"""Test the resolve method with unspecified family with trailing dot."""
with (
patch.object(IPv6orIPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv6orIPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.1"), IPv6Address("::1")],
),
):
result = await resolver.resolve("localhost.local.", family=socket.AF_UNSPEC)
assert result is not None
assert len(result) == 2
assert result[0]["hostname"] == "localhost.local."
assert result[0]["host"] == "127.0.0.1"
assert result[1]["hostname"] == "localhost.local."
assert result[1]["host"] == "::1"
@pytest.mark.asyncio
async def test_resolve_mdns_name_af_inet(resolver: AsyncMDNSResolver) -> None:
"""Test the resolve method with socket.AF_INET family."""
with (
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.1")],
),
):
result = await resolver.resolve("localhost.local", family=socket.AF_INET)
assert result is not None
assert len(result) == 1
assert result[0]["hostname"] == "localhost.local."
assert result[0]["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_resolve_mdns_name_af_inet6(resolver: AsyncMDNSResolver) -> None:
"""Test the resolve method with socket.AF_INET6 family."""
with (
patch.object(IPv6HostResolver, "async_request", return_value=True),
patch.object(
IPv6HostResolver,
"ip_addresses_by_version",
return_value=[IPv6Address("::1")],
),
):
result = await resolver.resolve("localhost.local", family=socket.AF_INET6)
assert result is not None
assert len(result) == 1
assert result[0]["hostname"] == "localhost.local."
assert result[0]["host"] == "::1"
@pytest.mark.asyncio
async def test_resolve_mdns_passed_in_asynczeroconf(
custom_resolver: AsyncMDNSResolver,
) -> None:
"""Test the resolve method with unspecified family with a passed in zeroconf."""
assert custom_resolver._aiozc_owner is False
assert custom_resolver._aiozc is not None
with (
patch.object(IPv6orIPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv6orIPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.1"), IPv6Address("::1")],
),
):
result = await custom_resolver.resolve(
"localhost.local", family=socket.AF_UNSPEC
)
assert result is not None
assert len(result) == 2
assert result[0]["hostname"] == "localhost.local."
assert result[0]["host"] == "127.0.0.1"
assert result[1]["hostname"] == "localhost.local."
assert result[1]["host"] == "::1"
@pytest.mark.asyncio
async def test_create_destroy_resolver() -> None:
"""Test the resolver can be created and destroyed."""
aiozc = AsyncZeroconf()
resolver = AsyncMDNSResolver(mdns_timeout=0.1, async_zeroconf=aiozc)
await resolver.close()
await aiozc.async_close()
assert resolver._aiozc is None
assert resolver._aiozc_owner is False
@pytest.mark.asyncio
async def test_create_destroy_resolver_no_aiozc() -> None:
"""Test the resolver can be created and destroyed."""
resolver = AsyncMDNSResolver(mdns_timeout=0.1)
await resolver.close()
assert resolver._aiozc is None
assert resolver._aiozc_owner is True
@pytest.mark.asyncio
async def test_same_results_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test when both resolvers return the same result.
"""
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
return_value=[
ResolveResult(hostname="localhost.local.", host="127.0.0.1", port=0) # type: ignore[typeddict-item]
],
),
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.1")],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_first_result_wins_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test the first result wins when one resolver takes longer
"""
async def _take_a_while_to_resolve(*args: Any, **kwargs: Any) -> NoReturn:
await asyncio.sleep(0.1)
raise RuntimeError("Should not be called")
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
_take_a_while_to_resolve,
),
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.2")],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.2"
@pytest.mark.asyncio
async def test_exception_mdns_before_result_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test that an exception is returned from mDNS resolver the other
resolver returns a result.
"""
async def _take_a_while_to_resolve_and_fail(*args: Any, **kwargs: Any) -> NoReturn:
await asyncio.sleep(0)
raise OSError(None, "NXDOMAIN")
async def _take_a_while_to_resolve(
*args: Any, **kwargs: Any
) -> list[ResolveResult]:
await asyncio.sleep(0.2)
return [ResolveResult(hostname="localhost.local.", host="127.0.0.1", port=0)] # type: ignore[typeddict-item]
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
_take_a_while_to_resolve,
),
patch.object(
IPv4HostResolver, "async_request", _take_a_while_to_resolve_and_fail
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_exception_dns_before_result_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test that an exception is returned from DNS resolver the other
mDNS resolver returns a result.
"""
async def _take_a_while_to_resolve_and_fail(*args: Any, **kwargs: Any) -> NoReturn:
await asyncio.sleep(0)
raise OSError(None, "NXDOMAIN")
async def _take_a_while_to_resolve(*args: Any, **kwargs: Any) -> bool:
await asyncio.sleep(0.2)
return True
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
_take_a_while_to_resolve_and_fail,
),
patch.object(IPv4HostResolver, "async_request", _take_a_while_to_resolve),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.2")],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.2"
@pytest.mark.asyncio
async def test_async_dual_mdns_resolver_from_cache(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver can resolve from cache."""
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
side_effect=OSError,
),
patch.object(IPv4HostResolver, "load_from_cache", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.2")],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.2"
@pytest.mark.asyncio
async def test_different_results_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test when both resolvers return different results
"""
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
return_value=[
ResolveResult(hostname="localhost.local.", host="127.0.0.1", port=0) # type: ignore[typeddict-item]
],
),
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.2")],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 2
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.2"
result = results[1]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_different_results_async_dual_mdns_resolver_zero_timeout(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test when both resolvers return different results with zero timeout
for mDNS.
"""
dual_resolver._mdns_timeout = 0
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
return_value=[
ResolveResult(hostname="localhost.local.", host="127.0.0.1", port=0) # type: ignore[typeddict-item]
],
),
patch.object(IPv4HostResolver, "load_from_cache", return_value=False),
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_failed_mdns_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test when mDNS fails, but DNS succeeds.
"""
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
return_value=[
ResolveResult(hostname="localhost.local.", host="127.0.0.1", port=0) # type: ignore[typeddict-item]
],
),
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.1"
@pytest.mark.asyncio
async def test_failed_dns_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test when DNS fails, but mDNS succeeds.
"""
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
side_effect=OSError(None, "DNS lookup failed"),
),
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[IPv4Address("127.0.0.2")],
),
):
results = await dual_resolver.resolve("localhost.local.")
assert results is not None
assert len(results) == 1
result = results[0]
assert result["hostname"] == "localhost.local."
assert result["host"] == "127.0.0.2"
@pytest.mark.asyncio
async def test_all_failed_async_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver resolves using mDNS and DNS.
Test when DNS fails, and mDNS fails.
"""
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
side_effect=OSError(None, "DNS lookup failed"),
),
patch.object(IPv4HostResolver, "async_request", return_value=True),
patch.object(
IPv4HostResolver,
"ip_addresses_by_version",
return_value=[],
),
pytest.raises(OSError, match="MDNS lookup failed, DNS lookup failed"),
):
await dual_resolver.resolve("localhost.local.")
@pytest.mark.asyncio
async def test_no_cancel_swallow_dual_mdns_resolver(
dual_resolver: AsyncMDNSResolver,
) -> None:
"""Test AsyncDualMDNSResolver does not swallow cancellation errors."""
async def _take_a_while_to_resolve(*args: Any, **kwargs: Any) -> NoReturn:
await asyncio.sleep(0.5)
raise RuntimeError("Should not be called")
with (
patch(
"aiohttp_asyncmdnsresolver._impl.AsyncResolver.resolve",
_take_a_while_to_resolve,
),
patch.object(IPv4HostResolver, "async_request", _take_a_while_to_resolve),
):
resolve_tasks = asyncio.create_task(dual_resolver.resolve("localhost.local."))
await asyncio.sleep(0.1)
resolve_tasks.cancel()
with pytest.raises(asyncio.CancelledError):
await resolve_tasks
|