Skip to content

add basic back-off test #153

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
merged 2 commits into from
Feb 27, 2023
Merged

add basic back-off test #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9aff9f4
add basic back-off test
vladak Feb 14, 2023
f60ff0c
Merge branch 'main' into back_off_tests
FoamyGuy Feb 27, 2023
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,6 @@ _build
.idea
.vscode
*~

# tox local cache
.tox
59 changes: 59 additions & 0 deletions tests/backoff_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# SPDX-FileCopyrightText: 2023 Vladimír Kotal
#
# SPDX-License-Identifier: Unlicense

"""exponential back-off tests"""

import socket
import ssl
import time
from unittest import TestCase, main
from unittest.mock import call, patch

import adafruit_minimqtt.adafruit_minimqtt as MQTT


class ExpBackOff(TestCase):
"""basic exponential back-off test"""

connect_times = []

# pylint: disable=unused-argument
def fake_connect(self, arg):
"""connect() replacement that records the call times and always raises OSError"""
self.connect_times.append(time.monotonic())
raise OSError("this connect failed")

def test_failing_connect(self) -> None:
"""test that exponential back-off is used when connect() always raises OSError"""
# use RFC 1918 address to avoid dealing with IPv6 in the call list below
host = "172.40.0.3"
port = 1883

with patch.object(socket.socket, "connect") as mock_method:
mock_method.side_effect = self.fake_connect

connect_retries = 3
mqtt_client = MQTT.MQTT(
broker=host,
port=port,
socket_pool=socket,
ssl_context=ssl.create_default_context(),
connect_retries=connect_retries,
)
print("connecting")
with self.assertRaises(MQTT.MMQTTException) as context:
mqtt_client.connect()
self.assertTrue("Repeated connect failures" in str(context.exception))

mock_method.assert_called()
calls = [call((host, port)) for _ in range(0, connect_retries)]
mock_method.assert_has_calls(calls)

print(f"connect() call times: {self.connect_times}")
for i in range(1, connect_retries):
assert self.connect_times[i] >= 2**i


if __name__ == "__main__":
main()