tests: add type annotations

Author: rnovatorov

tests/__init__.py

@@ -0,0 +1,3 @@
+from .fake_data_generator import FakeDataGenerator
+
+__all__ = ["FakeDataGenerator"]

tests/conftest.py

@@ -7,7 +7,7 @@
 
 
 @pytest.fixture(name="fake", scope="session")
-def fixture_fake_data_generator():
+def fixture_fake_data_generator() -> FakeDataGenerator:
     """A fixture that returns an instance of a fake data generator."""
     seed = int(os.getenv("FAKE_DATA_GENERATOR_SEED", time.time()))
     print(f"fake data generator seed: {seed}")

tests/fake_data_generator.py

@@ -4,7 +4,8 @@
 
 
 class FakeDataGenerator:
-    def __init__(self, seed: int):
+
+    def __init__(self, seed: int) -> None:
         self._random = random.Random(seed)
         self._fake = self._new_faker(seed)
 
@@ -19,7 +20,7 @@ def hardware_id(self) -> str:
     def channel_id(self) -> str:
         return self._fake.word()
 
-    def _new_faker(self, seed):
+    def _new_faker(self, seed) -> faker.Faker:
         fake = faker.Faker()
         fake.seed_instance(seed)
         return fake

tests/integration/conftest.py

@@ -1,8 +1,10 @@
 import asyncio
 import os
 import socket
+from typing import AsyncGenerator, Generator
 
 import docker
+import docker.models.containers
 import pytest
 
 import enapter
@@ -11,7 +13,9 @@
 
 
 @pytest.fixture(name="enapter_mqtt_client")
-async def fixture_enapter_mqtt_client(mosquitto_container):
+async def fixture_enapter_mqtt_client(
+    mosquitto_container: docker.models.containers.Container,
+) -> AsyncGenerator[enapter.mqtt.Client, None]:
     ports = mosquitto_container.ports[MOSQUITTO_PORT]
     assert ports
     async with asyncio.TaskGroup() as tg:
@@ -24,7 +28,9 @@ async def fixture_enapter_mqtt_client(mosquitto_container):
 
 
 @pytest.fixture(scope="session", name="mosquitto_container")
-def fixture_mosquitto_container(docker_client):
+def fixture_mosquitto_container(
+    docker_client: docker.DockerClient,
+) -> Generator[docker.models.containers.Container, None]:
     name = "enapter-python-sdk-integration-tests-mosquitto"
 
     try:
@@ -50,15 +56,15 @@ def fixture_mosquitto_container(docker_client):
         mosquitto.stop()
 
 
-def random_unused_port():
+def random_unused_port() -> int:
     with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
         s.bind(("", 0))
         addr = s.getsockname()
         return addr[1]
 
 
 @pytest.fixture(name="docker_client", scope="session")
-def fixture_docker_client():
+def fixture_docker_client() -> Generator[docker.DockerClient, None]:
     docker_client = docker.from_env()
     try:
         yield docker_client

tests/integration/test_mqtt.py

@@ -1,12 +1,14 @@
 import asyncio
 import time
 
+import docker.models.containers
+
 import enapter
 
 
 class TestClient:
 
-    async def test_sanity(self, enapter_mqtt_client):
+    async def test_sanity(self, enapter_mqtt_client: enapter.mqtt.Client) -> None:
         async with asyncio.TaskGroup() as tg:
             async with HeartbitSender(tg, enapter_mqtt_client) as heartbit_sender:
                 async with enapter_mqtt_client.subscribe(
@@ -15,7 +17,9 @@ async def test_sanity(self, enapter_mqtt_client):
                     msg = await messages.__anext__()
                     assert int(msg.payload) <= time.time()
 
-    async def test_consume_after_another_subscriber_left(self, enapter_mqtt_client):
+    async def test_consume_after_another_subscriber_left(
+        self, enapter_mqtt_client: enapter.mqtt.Client
+    ) -> None:
         async with asyncio.TaskGroup() as tg:
             async with HeartbitSender(tg, enapter_mqtt_client) as heartbit_sender:
                 async with enapter_mqtt_client.subscribe(
@@ -31,7 +35,9 @@ async def test_consume_after_another_subscriber_left(self, enapter_mqtt_client):
                     msg = await messages_1.__anext__()
                     assert int(msg.payload) <= time.time()
 
-    async def test_two_subscriptions(self, enapter_mqtt_client):
+    async def test_two_subscriptions(
+        self, enapter_mqtt_client: enapter.mqtt.Client
+    ) -> None:
         async with asyncio.TaskGroup() as tg:
             async with HeartbitSender(tg, enapter_mqtt_client) as heartbit_sender:
                 for i in range(2):
@@ -41,7 +47,9 @@ async def test_two_subscriptions(self, enapter_mqtt_client):
                         msg = await messages.__anext__()
                         assert int(msg.payload) <= time.time()
 
-    async def test_two_subscribers(self, enapter_mqtt_client):
+    async def test_two_subscribers(
+        self, enapter_mqtt_client: enapter.mqtt.Client
+    ) -> None:
         async with asyncio.TaskGroup() as tg:
             async with HeartbitSender(tg, enapter_mqtt_client) as heartbit_sender:
                 async with enapter_mqtt_client.subscribe(
@@ -54,7 +62,11 @@ async def test_two_subscribers(self, enapter_mqtt_client):
                             msg = await messages.__anext__()
                             assert int(msg.payload) <= time.time()
 
-    async def test_broker_restart(self, mosquitto_container, enapter_mqtt_client):
+    async def test_broker_restart(
+        self,
+        mosquitto_container: docker.models.containers.Container,
+        enapter_mqtt_client: enapter.mqtt.Client,
+    ) -> None:
         async with asyncio.TaskGroup() as tg:
             async with HeartbitSender(tg, enapter_mqtt_client) as heartbit_sender:
                 async with enapter_mqtt_client.subscribe(
@@ -72,16 +84,16 @@ class HeartbitSender(enapter.async_.Routine):
     def __init__(
         self,
         task_group: asyncio.TaskGroup,
-        enapter_mqtt_client,
-        topic="heartbits",
-        interval=0.5,
-    ):
+        enapter_mqtt_client: enapter.mqtt.Client,
+        topic: str = "heartbits",
+        interval: float = 0.5,
+    ) -> None:
         super().__init__(task_group=task_group)
         self.enapter_mqtt_client = enapter_mqtt_client
         self.topic = topic
         self.interval = interval
 
-    async def _run(self):
+    async def _run(self) -> None:
         while True:
             payload = str(int(time.time()))
             try:

tests/unit/test_async.py

@@ -5,7 +5,7 @@
 
 class TestGenerator:
 
-    async def test_aclose(self):
+    async def test_aclose(self) -> None:
         @enapter.async_.generator
         async def agen():
             yield 1

tests/unit/test_log.py

@@ -2,20 +2,22 @@
 import io
 import json
 import re
+from typing import Generator
 
 import enapter
 
 
 class TestJSONFormat:
-    def test_record_ends_with_newline(self):
+
+    def test_record_ends_with_newline(self) -> None:
         buf = io.StringIO()
 
         with self.configure(level="info", stream=buf):
             enapter.log.LOGGER.info("hello")
 
         assert buf.getvalue().endswith("\n")
 
-    def test_record_fields(self):
+    def test_record_fields(self) -> None:
         buf = io.StringIO()
 
         with self.configure(level="info", stream=buf):
@@ -30,7 +32,7 @@ def test_record_fields(self):
         assert record["name"] == "enapter"
         assert record["message"] == "hello"
 
-    def test_exc_info(self):
+    def test_exc_info(self) -> None:
         buf = io.StringIO()
 
         with self.configure(level="info", stream=buf):
@@ -45,7 +47,7 @@ def test_exc_info(self):
         assert "Traceback (most recent call last)" in record["exc_info"]
         assert 'RuntimeError("oops")' in record["exc_info"]
 
-    def test_stack_info(self):
+    def test_stack_info(self) -> None:
         buf = io.StringIO()
 
         with self.configure(level="info", stream=buf):
@@ -59,7 +61,7 @@ def test_stack_info(self):
 
     @staticmethod
     @contextlib.contextmanager
-    def configure(*args, **kwargs):
+    def configure(*args, **kwargs) -> Generator[None, None]:
         enapter.log.configure(*args, **kwargs)
         try:
             yield

tests/unit/test_mqtt/test_api/test_device.py

@@ -1,15 +1,16 @@
 from unittest import mock
 
 import enapter
+import tests
 
 
 class TestChannel:
 
-    async def test_publish_telemetry(self, fake) -> None:
+    async def test_publish_telemetry(self, fake: tests.FakeDataGenerator) -> None:
         hardware_id = fake.hardware_id()
         channel_id = fake.channel_id()
         timestamp = fake.timestamp()
-        mock_client = mock.Mock()
+        mock_client = mock.AsyncMock()
         channel = enapter.mqtt.api.device.Channel(
             client=mock_client, hardware_id=hardware_id, channel_id=channel_id
         )
@@ -21,11 +22,11 @@ async def test_publish_telemetry(self, fake) -> None:
             '{"timestamp": ' + str(timestamp) + ', "alerts": null}',
         )
 
-    async def test_publish_properties(self, fake) -> None:
+    async def test_publish_properties(self, fake: tests.FakeDataGenerator) -> None:
         hardware_id = fake.hardware_id()
         channel_id = fake.channel_id()
         timestamp = fake.timestamp()
-        mock_client = mock.Mock()
+        mock_client = mock.AsyncMock()
         channel = enapter.mqtt.api.device.Channel(
             client=mock_client, hardware_id=hardware_id, channel_id=channel_id
         )