redpanda-data / redpanda-data/redpanda

redpanda: add franz-go integration tests to nightly runs

Open
#6,981 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/tests area/transactions kind/enhance
Dominant language
C++
Stars
12.6k
Forks
792
PR merge metrics
No merged PRs in 30d

Description

franz-go integration tests are decent and relatively fast. They rely a bit on timing to catch a lot of errors (i.e. the client racing against the broker triggering certain edge cases), so we should loop these tests ~10 to 20 times. On my laptop, e2e tests run in about 1min.

A minimal docker compose that I've been using:

version: "3.7"
services:
  redpanda:
    image: vectorized/redpanda-nightly:latest
    network_mode: host

and then I use the following env vars for franz-go tests

KGO_TEST_RF: 1
KGO_SEEDS: redpanda:9092

both of these could be changed a bit; we could do a three node cluster, drop the RF env var, and add more seeds.

JIRA Link: CORE-1063

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the franz-go integration tests and the repository's nightly-run configuration. Use the provided Docker Compose service and KGO_TEST_RF/KGO_SEEDS settings as the initial test environment, then determine how to run the suite repeatedly. Done means the tests run 10–20 times in nightly runs and pass reliably against the Redpanda broker.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, go
Domain
ci-cd, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.