pytest-kafka-broker 0.4.0__tar.gz → 0.6.0__tar.gz

{pytest_kafka_broker-0.4.0 → pytest_kafka_broker-0.6.0}/.gitignore

@@ -5,3 +5,4 @@ _build
 api
 build
 dist
+version.py

{pytest_kafka_broker-0.4.0 → pytest_kafka_broker-0.6.0}/.pre-commit-config.yaml

@@ -35,14 +35,8 @@ repos:
           - tomli
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.14
+    rev: v0.15.0
     hooks:
       - id: ruff-check
         args: ["--extend-select", "I", "--fix"]
       - id: ruff-format
-
-  - repo: https://github.com/tofuutils/pre-commit-opentofu
-    rev: v2.2.2
-    hooks:
-      - id: tofu_fmt
-      - id: tofu_validate

{pytest_kafka_broker-0.4.0 → pytest_kafka_broker-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-kafka-broker
-Version: 0.4.0
+Version: 0.6.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.4.0 → pytest_kafka_broker-0.6.0}/pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
 ]
 
 [project.entry-points.pytest11]
-kafka_broker = "pytest_kafka_broker"
+kafka_broker = "pytest_kafka_broker.plugin"
 
 [project.optional-dependencies]
 docs = [
@@ -50,3 +50,9 @@ exclude = [
 exclude_gitignore = true
 
 [tool.setuptools_scm]
+version_file = "src/pytest_kafka_broker/version.py"
+
+[tool.pytest]
+kafka_broker_extra_config = [
+    "message.max.bytes = 123456",
+]

pytest_kafka_broker-0.6.0/src/pytest_kafka_broker/__init__.py

@@ -0,0 +1,61 @@
+from dataclasses import dataclass
+
+from confluent_kafka import Consumer, Producer
+from confluent_kafka.admin import AdminClient
+from confluent_kafka.aio import AIOConsumer, AIOProducer
+
+from .version import __version__  # noqa: F401
+
+__all__ = ("KafkaBrokerContext",)
+
+_doc = """{}
+
+Parameters
+----------
+config
+    Extra Kafka client configuration properties. See list in the
+    `librdkafka documentation <https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md>`_.
+"""
+
+
+@dataclass
+class KafkaBrokerContext:
+    """Information and convenience methods for a temporary Kafka cluster.
+
+    This object is returned by :func:`kafka_broker`.
+    """
+
+    bootstrap_server: str
+    """Kafka bootstrap server in the form :samp:`{host}:{port}`."""
+
+    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))
+
+    def consumer(self, config: dict | None = None) -> Consumer:
+        return Consumer(self.config(config))
+
+    def aio_producer(self, config: dict | None = None) -> AIOProducer:
+        return AIOProducer(self.config(config))
+
+    def aio_consumer(self, config: dict | None = None) -> AIOConsumer:
+        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(
+        "Create an asynchronous Kafka producer connected to the cluster."
+    )
+    aio_consumer.__doc__ = _doc.format(
+        "Create an asynchronous Kafka consumer connected to the cluster."
+    )
+
+
+del _doc

pytest_kafka_broker-0.4.0/src/pytest_kafka_broker/__init__.py → pytest_kafka_broker-0.6.0/src/pytest_kafka_broker/plugin.py

@@ -1,7 +1,6 @@
 import asyncio
 import subprocess
 from collections.abc import AsyncGenerator
-from dataclasses import dataclass
 from errno import EADDRINUSE
 from pathlib import Path
 from socket import socket
@@ -13,16 +12,9 @@ import pytest
 import pytest_asyncio
 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
 
-__all__ = (
-    "kafka_broker",
-    "KafkaBrokerContext",
-)
-
+from . import KafkaBrokerContext
 
 SCALA_VERSION = "2.13"
 KAFKA_VERSION = "4.1.1"
@@ -107,52 +99,9 @@ def find_unused_tcp_port():
     return factory
 
 
-@dataclass
-class KafkaBrokerContext:
-    """Information and convenience methods for a temporary Kafka cluster.
-
-    This object is returned by :func:`kafka_broker`.
-    """
-
-    bootstrap_server: str
-    """Kafka bootstrap server in the form :samp:`{host}:{port}`."""
-
-    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))
-
-    def consumer(self, config: dict | None = None) -> Consumer:
-        return Consumer(self.config(config))
-
-    def aio_producer(self, config: dict | None = None) -> AIOProducer:
-        return AIOProducer(self.config(config))
-
-    def aio_consumer(self, config: dict | None = None) -> AIOConsumer:
-        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(
-        "Create an asynchronous Kafka producer connected to the cluster."
-    )
-    aio_consumer.__doc__ = _doc.format(
-        "Create an asynchronous Kafka consumer connected to the cluster."
-    )
-
-
-del _doc
-
-
 @pytest_asyncio.fixture
 async def kafka_broker(
-    kafka_home, tmp_path, find_unused_tcp_port
+    kafka_home, tmp_path, find_unused_tcp_port, pytestconfig
 ) -> AsyncGenerator[KafkaBrokerContext]:
     """Pytest fixture to run a local, temporary Kafka broker."""
     kafka_storage = kafka_home / "bin" / "kafka-storage.sh"
@@ -165,6 +114,7 @@ async def kafka_broker(
     env = {"LOG_DIR": str(log_path)}
     plaintext_port = find_unused_tcp_port(9092)
     controller_port = find_unused_tcp_port(9093)
+    extra_config = "\n".join(pytestconfig.getini("kafka_broker_extra_config"))
     config_path.write_text(
         f"""
         process.roles=broker,controller
@@ -180,6 +130,7 @@ async def kafka_broker(
         share.coordinator.state.topic.min.isr=1
         transaction.state.log.replication.factor=1
         transaction.state.log.min.isr=1
+        {extra_config}
         """
     )
     with Status("Starting Kafka broker"):
@@ -215,7 +166,9 @@ async def kafka_broker(
             port.cancel()
             raise RuntimeError("Kafka broker terminated unexpectedly")
     try:
-        yield KafkaBrokerContext(f"127.0.0.1:{plaintext_port}")
+        bootstrap_server = f"127.0.0.1:{plaintext_port}"
+        print(f"Kafka broker running at {bootstrap_server}")
+        yield KafkaBrokerContext(bootstrap_server)
     finally:
         with Status("Stopping Kafka broker"):
             try:
@@ -223,3 +176,11 @@ async def kafka_broker(
             except ProcessLookupError:
                 pass  # Process has already terminated
             await exited
+
+
+def pytest_addoption(parser: pytest.Parser):
+    parser.addini(
+        "kafka_broker_extra_config",
+        type="linelist",
+        help="Extra broker configuration settings. See https://kafka.apache.org/41/configuration/broker-configs/",
+    )

pytest_kafka_broker-0.6.0/src/pytest_kafka_broker/version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.6.0'
+__version_tuple__ = version_tuple = (0, 6, 0)
+
+__commit_id__ = commit_id = 'g025e5871a'

{pytest_kafka_broker-0.4.0 → pytest_kafka_broker-0.6.0}/src/pytest_kafka_broker.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-kafka-broker
-Version: 0.4.0
+Version: 0.6.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.4.0 → pytest_kafka_broker-0.6.0}/src/pytest_kafka_broker.egg-info/SOURCES.txt

@@ -9,7 +9,9 @@ docs/conf.py
 docs/index.rst
 docs/make.bat
 src/pytest_kafka_broker/__init__.py
+src/pytest_kafka_broker/plugin.py
 src/pytest_kafka_broker/py.typed
+src/pytest_kafka_broker/version.py
 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
@@ -17,4 +19,5 @@ src/pytest_kafka_broker.egg-info/entry_points.txt
 src/pytest_kafka_broker.egg-info/requires.txt
 src/pytest_kafka_broker.egg-info/top_level.txt
 tests/__init__.py
+tests/test_config.py
 tests/test_kafka.py

pytest_kafka_broker-0.6.0/src/pytest_kafka_broker.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+kafka_broker = pytest_kafka_broker.plugin

pytest_kafka_broker-0.6.0/tests/test_config.py

@@ -0,0 +1,11 @@
+from confluent_kafka.admin import ConfigResource, ResourceType
+
+from pytest_kafka_broker import KafkaBrokerContext
+
+
+def test_kafka_broker_extra_config(kafka_broker: KafkaBrokerContext):
+    with kafka_broker.admin() as admin:
+        (future,) = admin.describe_configs(
+            [ConfigResource(ResourceType.BROKER, name="1")]
+        ).values()
+        assert future.result()["message.max.bytes"].value == "123456"

pytest_kafka_broker-0.4.0/src/pytest_kafka_broker.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[pytest11]
-kafka_broker = pytest_kafka_broker