Standardize tests

Author: justmobilize

tests/backoff_test.py renamed to tests/test_backoff.py

@@ -4,16 +4,16 @@
 
 """exponential back-off tests"""
 
+import pytest
 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):
+class TestExpBackOff:
     """basic exponential back-off test"""
 
     connect_times = []
@@ -42,9 +42,9 @@ def test_failing_connect(self) -> None:
                 connect_retries=connect_retries,
             )
             print("connecting")
-            with self.assertRaises(MQTT.MMQTTException) as context:
+            with pytest.raises(MQTT.MMQTTException) as context:
                 mqtt_client.connect()
-                self.assertTrue("Repeated connect failures" in str(context.exception))
+            assert "Repeated connect failures" in str(context)
 
             mock_method.assert_called()
             calls = [call((host, port)) for _ in range(0, connect_retries)]
@@ -53,7 +53,3 @@ def test_failing_connect(self) -> None:
             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()

tests/test_loop.py

@@ -4,13 +4,13 @@
 
 """loop() tests"""
 
+import pytest
 import random
 import socket
 import ssl
 import time
 import errno
 
-from unittest import TestCase, main
 from unittest.mock import patch
 from unittest import mock
 
@@ -101,7 +101,7 @@ def recv_into(self, retbuf, bufsize):
         raise exc
 
 
-class Loop(TestCase):
+class TestLoop:
     """basic loop() test"""
 
     connect_times = []
@@ -173,10 +173,10 @@ def test_loop_timeout_vs_socket_timeout(self):
         )
 
         mqtt_client.is_connected = lambda: True
-        with self.assertRaises(MQTT.MMQTTException) as context:
+        with pytest.raises(MQTT.MMQTTException) as context:
             mqtt_client.loop(timeout=0.5)
 
-        assert "loop timeout" in str(context.exception)
+        assert "loop timeout" in str(context)
 
     def test_loop_is_connected(self):
         """
@@ -189,10 +189,10 @@ def test_loop_is_connected(self):
             ssl_context=ssl.create_default_context(),
         )
 
-        with self.assertRaises(MQTT.MMQTTException) as context:
+        with pytest.raises(MQTT.MMQTTException) as context:
             mqtt_client.loop(timeout=1)
 
-        assert "not connected" in str(context.exception)
+        assert "not connected" in str(context)
 
     # pylint: disable=no-self-use
     def test_loop_ping_timeout(self):
@@ -258,7 +258,3 @@ def test_loop_ping_vs_msgs_sent(self):
 
         # This means no other messages than the PUBLISH messages generated by the code above.
         assert len(mocket.sent) == i * (2 + 2 + len(topic) + len(message))
-
-
-if __name__ == "__main__":
-    main()

tests/test_port_ssl.py

@@ -4,15 +4,15 @@
 
 """tests that verify the connect behavior w.r.t. port number and TLS"""
 
+import pytest
 import socket
 import ssl
-from unittest import TestCase, main
 from unittest.mock import Mock, call, patch
 
 import adafruit_minimqtt.adafruit_minimqtt as MQTT
 
 
-class PortSslSetup(TestCase):
+class TestPortSslSetup:
     """This class contains tests that verify how host/port and TLS is set for connect().
     These tests assume that there is no MQTT broker running on the hosts/ports they connect to.
     """
@@ -35,7 +35,7 @@ def test_default_port(self) -> None:
             ssl_mock = Mock()
             ssl_context.wrap_socket = ssl_mock
 
-            with self.assertRaises(MQTT.MMQTTException):
+            with pytest.raises(MQTT.MMQTTException):
                 mqtt_client.connect()
 
             ssl_mock.assert_not_called()
@@ -58,51 +58,51 @@ def test_connect_override(self):
                 connect_retries=1,
             )
 
-            with self.assertRaises(MQTT.MMQTTException):
+            with pytest.raises(MQTT.MMQTTException):
                 expected_host = "127.0.0.2"
                 expected_port = 1884
-                self.assertNotEqual(expected_port, port, "port override should differ")
-                self.assertNotEqual(expected_host, host, "host override should differ")
+                assert expected_port != port  # port override should differ
+                assert expected_host != host  # host override should differ
                 mqtt_client.connect(host=expected_host, port=expected_port)
 
             connect_mock.assert_called()
             # Assuming the repeated calls will have the same arguments.
             connect_mock.assert_has_calls([call((expected_host, expected_port))])
 
-    def test_tls_port(self) -> None:
+    @pytest.mark.parametrize("port", (None, 8883))
+    def test_tls_port(self, port) -> None:
         """verify that when is_ssl=True is set, the default port is 8883
         and the socket is TLS wrapped. Also test that the TLS port can be overridden."""
         host = "127.0.0.1"
 
-        for port in [None, 8884]:
-            if port is None:
-                expected_port = 8883
-            else:
-                expected_port = port
-            with self.subTest():
-                ssl_mock = Mock()
-                mqtt_client = MQTT.MQTT(
-                    broker=host,
-                    port=port,
-                    socket_pool=socket,
-                    is_ssl=True,
-                    ssl_context=ssl_mock,
-                    connect_retries=1,
-                )
-
-                socket_mock = Mock()
-                connect_mock = Mock(side_effect=OSError)
-                socket_mock.connect = connect_mock
-                ssl_mock.wrap_socket = Mock(return_value=socket_mock)
-
-                with self.assertRaises(MQTT.MMQTTException):
-                    mqtt_client.connect()
-
-                ssl_mock.wrap_socket.assert_called()
-
-                connect_mock.assert_called()
-                # Assuming the repeated calls will have the same arguments.
-                connect_mock.assert_has_calls([call((host, expected_port))])
+        if port is None:
+            expected_port = 8883
+        else:
+            expected_port = port
+
+        ssl_mock = Mock()
+        mqtt_client = MQTT.MQTT(
+            broker=host,
+            port=port,
+            socket_pool=socket,
+            is_ssl=True,
+            ssl_context=ssl_mock,
+            connect_retries=1,
+        )
+
+        socket_mock = Mock()
+        connect_mock = Mock(side_effect=OSError)
+        socket_mock.connect = connect_mock
+        ssl_mock.wrap_socket = Mock(return_value=socket_mock)
+
+        with pytest.raises(MQTT.MMQTTException):
+            mqtt_client.connect()
+
+        ssl_mock.wrap_socket.assert_called()
+
+        connect_mock.assert_called()
+        # Assuming the repeated calls will have the same arguments.
+        connect_mock.assert_has_calls([call((host, expected_port))])
 
     def test_tls_without_ssl_context(self) -> None:
         """verify that when is_ssl=True is set, the code will check that ssl_context is not None"""
@@ -116,10 +116,6 @@ def test_tls_without_ssl_context(self) -> None:
             connect_retries=1,
         )
 
-        with self.assertRaises(AttributeError) as context:
+        with pytest.raises(AttributeError) as context:
             mqtt_client.connect()
-            self.assertTrue("ssl_context must be set" in str(context))
-
-
-if __name__ == "__main__":
-    main()
+        assert "ssl_context must be set" in str(context)

tox.ini

@@ -10,15 +10,13 @@ envlist = py311
 description = run tests
 deps =
     pytest==7.4.3
-pytest-subtests==0.11.0
 commands = pytest
 
 [testenv:coverage]
 description = run coverage
 deps =
     pytest==7.4.3
     pytest-cov==4.1.0
-pytest-subtests==0.11.0
 package = editable
 commands =
     coverage run --source=. --omit=tests/* --branch {posargs} -m pytest