pytest-kafka-broker 0.1.1__tar.gz → 0.3.0__tar.gz

{pytest_kafka_broker-0.1.1 → pytest_kafka_broker-0.3.0}/.gitlab-ci.yml

@@ -7,6 +7,10 @@ include:
         - "3.12"
         - "3.13"
         - "3.14"
+  - component: git.ligo.org/computing/gitlab/components/python/type-checking@2.3.2
+    inputs:
+      fail_on_findings: true
+      requirements: .
 
 python_test:
   before_script:

{pytest_kafka_broker-0.1.1 → pytest_kafka_broker-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-kafka-broker
-Version: 0.1.1
+Version: 0.3.0
 Summary: Pytest plugin to run a single-broker Kafka cluster
 Author-email: Leo Singer <leo.singer@ligo.org>
 License-Expression: Apache-2.0

{pytest_kafka_broker-0.1.1 → pytest_kafka_broker-0.3.0}/pyproject.toml

@@ -36,4 +36,10 @@ docs = [
 source = "https://git.ligo.org/ultra-swift/pytest-kafka-broker"
 documentation = "https://pytest-kafka-broker.readthedocs.io/"
 
+[tool.mypy]
+exclude = [
+    "^docs/conf.py$",
+]
+exclude_gitignore = true
+
 [tool.setuptools_scm]

pytest_kafka_broker-0.1.1/src/pytest_kafka_broker.py → pytest_kafka_broker-0.3.0/src/pytest_kafka_broker/__init__.py

@@ -1,5 +1,6 @@
 import asyncio
 import subprocess
+from collections.abc import AsyncGenerator
 from dataclasses import dataclass
 from pathlib import Path
 from tarfile import TarFile
@@ -8,9 +9,10 @@ from uuid import uuid4
 
 import pytest
 import pytest_asyncio
-from astropy.config import get_cache_dir_path
-from astropy.utils.data import get_readable_fileobj
+from astropy.config import get_cache_dir_path  # type: ignore[import-untyped]
+from astropy.utils.data import get_readable_fileobj  # type: ignore[import-untyped]
 from confluent_kafka import Consumer, Producer
+from confluent_kafka.admin import AdminClient
 from confluent_kafka.aio import AIOConsumer, AIOProducer
 from rich.status import Status
 
@@ -24,7 +26,7 @@ SCALA_VERSION = "2.13"
 KAFKA_VERSION = "4.1.1"
 
 
-async def wait_port(port: int, timeout: float = 0.25):
+async def wait_port(port: int, timeout: float = 0.25) -> None:
     """Wait until a connection is detected listening on the given port."""
     while True:
         try:
@@ -83,9 +85,12 @@ class KafkaBrokerContext:
     bootstrap_server: str
     """Kafka bootstrap server in the form :samp:`{host}:{port}`."""
 
-    def config(self, config: dict | None = None):
+    def config(self, config: dict | None = None) -> dict:
         return {**(config or {}), "bootstrap.servers": self.bootstrap_server}
 
+    def admin(self, config: dict | None = None) -> AdminClient:
+        return AdminClient(self.config(config))
+
     def producer(self, config: dict | None = None) -> Producer:
         return Producer(self.config(config))
 
@@ -99,6 +104,7 @@ class KafkaBrokerContext:
         return AIOConsumer(self.config(config))
 
     config.__doc__ = _doc.format("Get the configuration for a Kafka client.")
+    admin.__doc__ = _doc.format("Create a Kafka admin client connected to the cluster.")
     producer.__doc__ = _doc.format("Create a Kafka producer connected to the cluster.")
     consumer.__doc__ = _doc.format("Create a Kafka consumer connected to the cluster.")
     aio_producer.__doc__ = _doc.format(
@@ -113,13 +119,10 @@ del _doc
 
 
 @pytest_asyncio.fixture
-async def kafka_broker(kafka_home, tmp_path, unused_tcp_port_factory):
-    """Pytest fixture to run a local, temporary Kafka broker.
-
-    Returns
-    -------
-    : KafkaBrokerContext
-    """
+async def kafka_broker(
+    kafka_home, tmp_path, unused_tcp_port_factory
+) -> AsyncGenerator[KafkaBrokerContext]:
+    """Pytest fixture to run a local, temporary Kafka broker."""
     kafka_storage = kafka_home / "bin" / "kafka-storage.sh"
     kafka_server_start = kafka_home / "bin" / "kafka-server-start.sh"
     config_path = tmp_path / "server.properties"

{pytest_kafka_broker-0.1.1 → pytest_kafka_broker-0.3.0}/src/pytest_kafka_broker.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-kafka-broker
-Version: 0.1.1
+Version: 0.3.0
 Summary: Pytest plugin to run a single-broker Kafka cluster
 Author-email: Leo Singer <leo.singer@ligo.org>
 License-Expression: Apache-2.0

{pytest_kafka_broker-0.1.1 → pytest_kafka_broker-0.3.0}/src/pytest_kafka_broker.egg-info/SOURCES.txt

@@ -8,7 +8,8 @@ docs/Makefile
 docs/conf.py
 docs/index.rst
 docs/make.bat
-src/pytest_kafka_broker.py
+src/pytest_kafka_broker/__init__.py
+src/pytest_kafka_broker/py.typed
 src/pytest_kafka_broker.egg-info/PKG-INFO
 src/pytest_kafka_broker.egg-info/SOURCES.txt
 src/pytest_kafka_broker.egg-info/dependency_links.txt

{pytest_kafka_broker-0.1.1 → pytest_kafka_broker-0.3.0}/tests/test_kafka.py

@@ -1,20 +1,24 @@
 import pytest
 
-topic = "topic"
-payload = b"hello world"
-group_id = "group_id"
+TOPIC = "topic"
+PAYLOAD = b"hello world"
+GROUP_ID = "group_id"
 
 
 def test_sync(kafka_broker):
     """Demonstrate using the kafka_broker fixture in an ordinary test."""
     with kafka_broker.producer() as producer:
-        producer.produce(topic, payload)
+        producer.produce(TOPIC, PAYLOAD)
+
     with kafka_broker.consumer(
-        {"group.id": group_id, "auto.offset.reset": "earliest"}
+        {"group.id": GROUP_ID, "auto.offset.reset": "earliest"}
     ) as consumer:
-        consumer.subscribe([topic])
+        consumer.subscribe([TOPIC])
         (message,) = consumer.consume()
-        assert message.value() == payload
+        assert message.value() == PAYLOAD
+
+    with kafka_broker.admin() as admin:
+        assert TOPIC in admin.list_topics().topics
 
 
 @pytest.mark.asyncio
@@ -22,17 +26,21 @@ async def test_async(kafka_broker):
     """Demonstrate using the kafka_broker fixture in an async test."""
     producer = kafka_broker.aio_producer()
     try:
-        await producer.produce(topic, payload)
+        await producer.produce(TOPIC, PAYLOAD)
     finally:
         # FIXME: use async context manager; see https://github.com/confluentinc/confluent-kafka-python/pull/2180
         await producer.close()
     consumer = kafka_broker.aio_consumer(
-        {"group.id": group_id, "auto.offset.reset": "earliest"}
+        {"group.id": GROUP_ID, "auto.offset.reset": "earliest"}
     )
+
     try:
-        await consumer.subscribe([topic])
+        await consumer.subscribe([TOPIC])
         (message,) = await consumer.consume()
     finally:
         # FIXME: use async context manager; see https://github.com/confluentinc/confluent-kafka-python/pull/2180
         await consumer.close()
-    assert message.value() == payload
+    assert message.value() == PAYLOAD
+
+    with kafka_broker.admin() as admin:
+        assert TOPIC in admin.list_topics().topics