Skip to content

Skip socket creation if add_multicast_member fails (windows) #341

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 3 commits into from
May 3, 2021
Merged

Skip socket creation if add_multicast_member fails (windows) #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd1c063
Skip socket creation if add_multicast_member fails (windows)
TTimo Apr 26, 2021
cc2405f
Ensure known socket errors cause add_multicast_member to return False
bdraco Apr 28, 2021
0c3cea3
Merge branch 'master' into issues/337
bdraco May 3, 2021
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
15 changes: 9 additions & 6 deletions zeroconf/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2239,7 +2239,7 @@ def new_socket(
def add_multicast_member(
listen_socket: socket.socket,
interface: Union[str, Tuple[Tuple[str, int, int], int]],
) -> None:
) -> bool:
# This is based on assumptions in normalize_interface_choice
is_v6 = isinstance(interface, tuple)
err_einval = {errno.EINVAL}
Expand All @@ -2263,19 +2263,20 @@ def add_multicast_member(
'it is expected to happen on some systems',
interface,
)
return None
return False
elif _errno == errno.EADDRNOTAVAIL:
log.info(
'Address not available when adding %s to multicast '
'group, it is expected to happen on some systems',
interface,
)
return None
return False
elif _errno in err_einval:
log.info('Interface of %s does not support multicast, ' 'it is expected in WSL', interface)
return None
return False
else:
raise
return True


def new_respond_socket(
Expand Down Expand Up @@ -2323,8 +2324,10 @@ def create_sockets(

for i in normalized_interfaces:
if not unicast:
add_multicast_member(cast(socket.socket, listen_socket), i)
respond_socket = new_respond_socket(i, apple_p2p=apple_p2p)
if add_multicast_member(cast(socket.socket, listen_socket), i):
respond_socket = new_respond_socket(i, apple_p2p=apple_p2p)
else:
respond_socket = None
else:
respond_socket = new_socket(
port=0,
Expand Down
19 changes: 17 additions & 2 deletions zeroconf/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
""" Unit tests for zeroconf.py """

import copy
import errno
import itertools
import logging
import os
Expand All @@ -16,8 +17,7 @@
import unittest
import unittest.mock
from threading import Event
from typing import Dict, Optional # noqa # used in type hints
from typing import cast
from typing import Dict, Optional, cast # noqa # used in type hints

import pytest

Expand Down Expand Up @@ -2105,3 +2105,18 @@ def test_dns_compression_rollback_for_corruption():
# ensure there is no corruption with the dns compression
incoming = r.DNSIncoming(packet)
assert incoming.valid is True


@pytest.mark.parametrize(
"errno,expected_result",
[(errno.EADDRINUSE, False), (errno.EADDRNOTAVAIL, False), (errno.EINVAL, False), (0, True)],
)
def test_add_multicast_member_socket_errors(errno, expected_result):
"""Test we handle socket errors when adding multicast members."""
if errno:
setsockopt_mock = unittest.mock.Mock(side_effect=OSError(errno, "Error: {}".format(errno)))
else:
setsockopt_mock = unittest.mock.Mock()
fileno_mock = unittest.mock.PropertyMock(return_value=10)
socket_mock = unittest.mock.Mock(setsockopt=setsockopt_mock, fileno=fileno_mock)
assert r.add_multicast_member(socket_mock, "0.0.0.0") == expected_result