Skip to content

Convert test_integration to asyncio to avoid testing threading races #828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdraco merged 1 commit into from
Jun 25, 2021
Merged

Convert test_integration to asyncio to avoid testing threading races #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 0 additions & 92 deletions tests/services/test_browser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,98 +647,6 @@ def on_service_state_change(zeroconf, service_type, state_change, name):
zeroconf_browser.close()


def test_integration():
service_added = Event()
service_removed = Event()
unexpected_ttl = Event()
got_query = Event()

type_ = "_http._tcp.local."
registration_name = "xxxyyy.%s" % type_

def on_service_state_change(zeroconf, service_type, state_change, name):
if name == registration_name:
if state_change is ServiceStateChange.Added:
service_added.set()
elif state_change is ServiceStateChange.Removed:
service_removed.set()

zeroconf_browser = Zeroconf(interfaces=['127.0.0.1'])
_wait_for_start(zeroconf_browser)

# we are going to patch the zeroconf send to check packet sizes
old_send = zeroconf_browser.async_send

time_offset = 0.0

def current_time_millis():
"""Current system time in milliseconds"""
return time.time() * 1000 + time_offset * 1000

expected_ttl = const._DNS_HOST_TTL
nbr_answers = 0

def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = r.DNSIncoming(out.packets()[0])
nonlocal nbr_answers
for answer in pout.answers:
nbr_answers += 1
if not answer.ttl > expected_ttl / 2:
unexpected_ttl.set()

got_query.set()
got_query.clear()

old_send(out, addr=addr, port=port, v6_flow_scope=v6_flow_scope)

# patch the zeroconf send
# patch the zeroconf current_time_millis
# patch the backoff limit to ensure we always get one query every 1/4 of the DNS TTL
with unittest.mock.patch.object(zeroconf_browser, "async_send", send), unittest.mock.patch.object(
_services_browser, "current_time_millis", current_time_millis
), unittest.mock.patch.object(_services_browser, "_BROWSER_BACKOFF_LIMIT", int(expected_ttl / 4)):
service_added = Event()
service_removed = Event()

browser = ServiceBrowser(zeroconf_browser, type_, [on_service_state_change])

zeroconf_registrar = Zeroconf(interfaces=['127.0.0.1'])
desc = {'path': '/~paulsm/'}
info = ServiceInfo(
type_, registration_name, 80, 0, 0, desc, "ash-2.local.", addresses=[socket.inet_aton("10.0.1.2")]
)
zeroconf_registrar.register_service(info)

try:
service_added.wait(1)
assert service_added.is_set()

# Test that we receive queries containing answers only if the remaining TTL
# is greater than half the original TTL
sleep_count = 0
test_iterations = 50

while nbr_answers < test_iterations:
# Increase simulated time shift by 1/4 of the TTL in seconds
time_offset += expected_ttl / 4
zeroconf_browser.loop.call_soon_threadsafe(browser.query_scheduler.set_schedule_changed)
sleep_count += 1
got_query.wait(0.5)
# Prevent the test running indefinitely in an error condition
assert sleep_count < test_iterations * 4
assert not unexpected_ttl.is_set()

# Don't remove service, allow close() to cleanup

finally:
zeroconf_registrar.close()
service_removed.wait(1)
assert service_removed.is_set()
browser.cancel()
zeroconf_browser.close()


def test_legacy_record_update_listener():
"""Test a RecordUpdateListener that does not implement update_records."""

Expand Down
97 changes: 96 additions & 1 deletion tests/test_aio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,18 @@
import asyncio
import logging
import socket
import time
import threading
import unittest.mock

import pytest

from zeroconf.aio import AsyncServiceBrowser, AsyncServiceInfo, AsyncZeroconf, AsyncZeroconfServiceTypes
from zeroconf import Zeroconf
from zeroconf import DNSIncoming, ServiceStateChange, Zeroconf, const
from zeroconf.const import _LISTENER_TIME
from zeroconf._exceptions import BadTypeInNameException, NonUniqueNameException, ServiceNameAlreadyRegistered
from zeroconf._services import ServiceListener
import zeroconf._services.browser as _services_browser
from zeroconf._services.info import ServiceInfo
from zeroconf._utils.time import current_time_millis

Expand Down Expand Up @@ -657,3 +659,96 @@ def update_service(self, zc, type_, name) -> None:
await browser.async_cancel()

await aiozc.async_close()


@pytest.mark.asyncio
async def test_integration():
service_added = asyncio.Event()
service_removed = asyncio.Event()
unexpected_ttl = asyncio.Event()
got_query = asyncio.Event()

type_ = "_http._tcp.local."
registration_name = "xxxyyy.%s" % type_

def on_service_state_change(zeroconf, service_type, state_change, name):
if name == registration_name:
if state_change is ServiceStateChange.Added:
service_added.set()
elif state_change is ServiceStateChange.Removed:
service_removed.set()

aiozc = AsyncZeroconf(interfaces=['127.0.0.1'])
zeroconf_browser = aiozc.zeroconf
await zeroconf_browser.async_wait_for_start()

# we are going to patch the zeroconf send to check packet sizes
old_send = zeroconf_browser.async_send

time_offset = 0.0

def current_time_millis():
"""Current system time in milliseconds"""
return (time.time() * 1000) + (time_offset * 1000)

expected_ttl = const._DNS_HOST_TTL
nbr_answers = 0

def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = DNSIncoming(out.packets()[0])
nonlocal nbr_answers
for answer in pout.answers:
nbr_answers += 1
if not answer.ttl > expected_ttl / 2:
unexpected_ttl.set()

got_query.set()
got_query.clear()

old_send(out, addr=addr, port=port, v6_flow_scope=v6_flow_scope)

# patch the zeroconf send
# patch the zeroconf current_time_millis
# patch the backoff limit to ensure we always get one query every 1/4 of the DNS TTL
with unittest.mock.patch.object(zeroconf_browser, "async_send", send), unittest.mock.patch(
"zeroconf._services.browser.current_time_millis", current_time_millis
), unittest.mock.patch.object(_services_browser, "_BROWSER_BACKOFF_LIMIT", int(expected_ttl / 4)):
service_added = asyncio.Event()
service_removed = asyncio.Event()

browser = AsyncServiceBrowser(zeroconf_browser, type_, [on_service_state_change])

aio_zeroconf_registrar = AsyncZeroconf(interfaces=['127.0.0.1'])
desc = {'path': '/~paulsm/'}
info = ServiceInfo(
type_, registration_name, 80, 0, 0, desc, "ash-2.local.", addresses=[socket.inet_aton("10.0.1.2")]
)
task = await aio_zeroconf_registrar.async_register_service(info)
await task

try:
await asyncio.wait_for(service_added.wait(), 1)
assert service_added.is_set()

# Test that we receive queries containing answers only if the remaining TTL
# is greater than half the original TTL
sleep_count = 0
test_iterations = 50

while nbr_answers < test_iterations:
# Increase simulated time shift by 1/4 of the TTL in seconds
time_offset += expected_ttl / 4
browser.query_scheduler.set_schedule_changed()
sleep_count += 1
await asyncio.wait_for(got_query.wait(), 0.5)
# Prevent the test running indefinitely in an error condition
assert sleep_count < test_iterations * 4
assert not unexpected_ttl.is_set()
# Don't remove service, allow close() to cleanup
finally:
await aio_zeroconf_registrar.async_close()
await asyncio.wait_for(service_removed.wait(), 1)
assert service_removed.is_set()
await browser.async_cancel()
await aiozc.async_close()