robotframework-okw-kafka

Robot Framework keyword library for Apache Kafka integration testing — produce, consume, and verify messages using the OKW keyword pattern.

Deutsche Version: README_de.md

Signal vs. NOISE

Install

pip install robotframework-okw-kafka

Minimal Example

*** Settings ***
Library    okw_kafka.library.OkwKafkaLibrary

*** Test Cases ***
Order Event Roundtrip
    KafkaStart          kafka-local
    KafkaSetTopic       order-commands
    KafkaSetValue       $.action       create
    KafkaSetValue       $.item         Widget-42
    KafkaProduce

    KafkaConsume        order-events    FILTER=$.item=Widget-42    TIMEOUT=30
    KafkaVerifyValue    $.status        created
    KafkaMemorizeValue  $.orderId       ORDER_ID

    KafkaStop

Keyword Pattern

The same pattern across all OKW technologies:

YAML Configuration

# configs/kafka-local.yaml
bootstrap_servers: "localhost:9092"
consumer_group: "okw-test"
auto_offset_reset: "latest"
value_serializer: "json"
value_deserializer: "json"

Keywords

Session

• KafkaStart / KafkaStop

Produce

• KafkaSetTopic, KafkaSetValue, KafkaSetValueAsString
• KafkaSetHeader, KafkaSetKey, KafkaProduce

Consume

• KafkaConsume (timeout-based polling, optional JSONPath filter)
• KafkaConsumeLatest

Verify

• KafkaVerifyValue / KafkaVerifyValueWCM / KafkaVerifyValueREGX
• KafkaVerifyHeader, KafkaVerifyKey

Memorize

• KafkaMemorizeValue, KafkaMemorizeKey

Admin

• KafkaVerifyTopicExists, KafkaVerifyPartitionCount, KafkaLogTopics

Keyword Documentation

Libdoc (GitHub Pages)

Runnable Examples

okw-examples/kafka/

License

AGPL-3.0 — see LICENSE.