debezium/dbz

Implement automated testing framework for debezium-examples

Open

#1,810 opened on Apr 13, 2026

View on GitHub
 (16 comments) (0 reactions) (1 assignee)HTML (6 forks)auto 404
component/examplesgood first issuetype/task

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

Current Behaviour

Most examples in the repository lack automated tests, making it difficult to:

  • Verify examples work correctly after Debezium version upgrades
  • Catch breaking changes before they reach users
  • Ensure examples continue to work as Docker images and dependencies evolve
  • Maintain confidence in example code quality

Currently, only the postgres-failover-slots example has automated testing via GitHub Actions.

Expected Behaviour

Implement a test framework similar to the postgres-failover-slots example for all applicable examples.

Reference Implementation:

The postgres-failover-slots example demonstrates a working approach:

  • Test script: scripts/run-example-test.py - Python-based test runner
  • Test manifest: postgres-failover-slots/test.yaml - Declarative YAML DSL for test steps
  • GitHub Actions: .github/workflows/postgres-failover-slots-workflow.yml - CI integration

The test framework supports:

  • Docker Compose service orchestration
  • HTTP endpoint polling (for service readiness)
  • Database operations via docker compose exec
  • Kafka message consumption and verification
  • Flexible wait conditions and timeouts

Related

  • debezium/dbz#1165 PR discussion

Contributor guide

Research direction
Study the reference test framework in the 'postgres failover slots' example, understand the Python test runner, YAML test manifest, and GitHub Actions workflow. Then apply the same pattern to another example that currently lacks automated tests, selecting a simple one like 'postgres' or 'mysql' from the repository.
Tech stack
pythondockerpostgresqlkafka
Domain
testingdevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitDockerPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65