pytest-arrakis

Pytest plugin providing Arrakis fixtures for testing

Resources

• Source Code
• Issue Tracker

Installation

pip install pytest-arrakis

To enable publish fixtures (including a real Kafka-backed server), install the publish extra:

pip install pytest-arrakis[publish]

Fixtures

Core fixtures

These are available out of the box:

Replay fixtures

These provide replay-specific resources for testing replay functionality:

Publish fixtures (requires publish extra)

These are conditionally registered when arrakis-backend-kafka and pytest-kafka-broker are installed:

Usage

Fetching data from a mock server

def test_fetch(arrakis_server):
    import arrakis

    block = arrakis.fetch(["H1:TEST-CHANNEL_SIN"], 0, 1)
    for channel, series in block.items():
        assert len(series) > 0

Testing a publisher without a real broker

def test_publish(arrakis_mock_publisher):
    publisher, fake_producer, published_blocks = arrakis_mock_publisher

    # publish a block through your code under test ...
    assert len(published_blocks) == 1

End-to-end publish testing (requires publish extra)

def test_roundtrip(arrakis_publisher):
    # arrakis_publisher is a real Publisher connected to an embedded Kafka broker
    ...

Testing replay channel discovery

def test_replay_find(arrakis_server, arrakis_replay_params):
    from arrakis import Client

    client = Client(arrakis_server.url)
    # replay channels are only visible when querying with the replay ID
    replay_channels = list(client.find(replay_id="FAKE_REPLAY"))
    assert len(replay_channels) > 0

Testing a replay publisher without a real broker

def test_replay_publish(arrakis_replay_mock_publisher):
    publisher, fake_producer, published_blocks = arrakis_replay_mock_publisher

    # publish a block through your code under test ...
    assert len(published_blocks) == 1

Bundled test channels

The plugin ships with a set of test channel definitions:

Regular channels

Replay channels

These are tagged with replay_id = "FAKE_REPLAY" and are only visible when querying with the corresponding replay ID:

CI setup

GitLab CI

The core fixtures work without any extra system dependencies. However, the publish extra uses pytest-kafka-broker, which starts an embedded Kafka broker that requires a JVM at runtime. In Debian/Ubuntu-based CI images (including the standard python: Docker images), install it in a before_script:

test:
  image: python:3.13
  before_script:
    - apt-get update && apt-get install -y --no-install-recommends default-jre-headless

If you only use the core fixtures (no publish extra), the JVM is not needed.