Skip to content

test(utils): make keepalive tests pass on macOS #2749

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

Open
ArfiArfath21 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

test(utils): make keepalive tests pass on macOS #2749

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
22 changes: 17 additions & 5 deletions kubernetes/utils/keepalive_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@
from kubernetes.utils.keepalive import tcp_keepalive_socket_options


# Linux spells the idle time TCP_KEEPIDLE, macOS spells it TCP_KEEPALIVE, and
# some platforms have neither (keepalive.py skips the option there).
IDLE_OPTION = getattr(socket, 'TCP_KEEPIDLE',
getattr(socket, 'TCP_KEEPALIVE', None))
needs_idle_option = unittest.skipIf(
IDLE_OPTION is None, 'platform has no TCP keepalive idle option')


def fake_socket_module(**names):
"""A stand-in for the socket module exposing only the given names."""

Expand All @@ -39,12 +47,13 @@ def fake_socket_module(**names):

class TestTcpKeepaliveSocketOptions(unittest.TestCase):

@needs_idle_option
def test_defaults_match_client_go(self):
options = tcp_keepalive_socket_options()

self.assertIn((socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1), options)
self.assertIn(
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 30), options)
(socket.IPPROTO_TCP, IDLE_OPTION, 30), options)
self.assertIn(
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 15), options)
self.assertIn((socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 9), options)
Expand All @@ -56,10 +65,11 @@ def test_keeps_the_urllib3_defaults(self):
for default in defaults:
self.assertIn(default, options)

@needs_idle_option
def test_custom_timings(self):
options = tcp_keepalive_socket_options(idle=5, interval=2, count=3)

self.assertIn((socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 5), options)
self.assertIn((socket.IPPROTO_TCP, IDLE_OPTION, 5), options)
self.assertIn((socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 2), options)
self.assertIn((socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 3), options)

Expand All @@ -74,15 +84,17 @@ def test_options_are_setsockopt_triples(self):
for item in option:
self.assertIsInstance(item, int)

@needs_idle_option
def test_options_apply_to_a_socket(self):
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
for level, name, value in tcp_keepalive_socket_options():
sock.setsockopt(level, name, value)

# Boolean options read back as any non-zero value (8 on macOS)
self.assertNotEqual(
0, sock.getsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE))
self.assertEqual(
1, sock.getsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE))
self.assertEqual(
30, sock.getsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE))
30, sock.getsockopt(socket.IPPROTO_TCP, IDLE_OPTION))

def test_falls_back_to_tcp_keepalive_on_macos(self):
macos = fake_socket_module(
Expand Down