[DMS-808] Kafka e2e tests #704
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds Kafka end-to-end (E2E) testing capabilities to the Data Management Service (DMS), enabling automated testing of Kafka message production when DMS operations occur.
- Implements Kafka E2E test infrastructure with message collection and comparison utilities
- Adds test scenarios for Kafka connectivity and message validation
- Refactors existing test utilities to support reusable JSON comparison logic
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
StepDefinitions/KafkaStepDefinitions.cs |
New step definitions for Kafka connectivity testing and message validation |
Management/KafkaMessageCollector.cs |
Core Kafka consumer for collecting test messages with proper lifecycle management |
Management/JsonTestUtilities.cs |
Extracted reusable JSON comparison utilities from existing step definitions |
StepDefinitions/StepDefinitions.cs |
Refactored to use centralized JSON comparison utilities |
Features/General/KafkaMessaging.feature |
Test scenarios for Kafka functionality |
| Configuration files | Updates to support Kafka testing in CI environment |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/dms/tests/EdFi.DataManagementService.Tests.E2E/StepDefinitions/KafkaStepDefinitions.cs
Outdated
Show resolved
Hide resolved
src/dms/tests/EdFi.DataManagementService.Tests.E2E/StepDefinitions/KafkaStepDefinitions.cs
Outdated
Show resolved
Hide resolved
src/dms/tests/EdFi.DataManagementService.Tests.E2E/Management/KafkaMessageCollector.cs
Outdated
Show resolved
Hide resolved
src/dms/tests/EdFi.DataManagementService.Tests.E2E/Management/KafkaMessageCollector.cs
Outdated
Show resolved
Hide resolved
src/dms/tests/EdFi.DataManagementService.Tests.E2E/Management/KafkaMessageCollector.cs
Show resolved
Hide resolved
src/dms/tests/EdFi.DataManagementService.Tests.E2E/Management/ContainerSetupBase.cs
Show resolved
Hide resolved
simpat-adam
commented
Sep 5, 2025
|
|
||
| - name: Build | ||
| run: ./build-dms.ps1 Build -Configuration ${{ env.CONFIGURATION }} -IdentityProvider ${{matrix.identityprovider}} | ||
|
|
There was a problem hiding this comment.
Kafka E2E Test Connectivity Fix
Challenge
Kafka E2E tests passed locally but failed in CI with message consumption errors. The issue was a Docker networking mismatch between Kafka's advertised listeners and how clients connect in different environments.
Root Cause
- Kafka advertises
PLAINTEXT://dms-kafka1:9092 - E2E tests were hardcoded to
localhost:9092 - Local works with host file entry (
127.0.0.1 dms-kafka1) - CI fails because
dms-kafka1hostname doesn't resolve
Attempted Solutions
- Dual listeners (INTERNAL/EXTERNAL) - Failed due to topic isolation between listeners
- Single listener with localhost - Failed because containers can't reach each other via localhost
- Network aliases - Failed due to Kafka's advertised listener behavior
Final Solution
Made E2E test connection configurable via environment variable:
- Added
KAFKA_BOOTSTRAP_SERVERSenvironment variable toKafkaStepDefinitions.cs - CI uses
dms-kafka1:9092with host file entry - Local development continues using
localhost:9092with host file entry - Kept original Kafka configuration intact
simpat-adam
commented
Sep 5, 2025
| @@ -17,38 +17,17 @@ public static class SetupHooks | |||
| [BeforeTestRun] | |||
| public static async Task BeforeTestRun(PlaywrightContext context, TestLogger logger) | |||
| { | |||
| if (AppSettings.UseTestContainers) | |||
There was a problem hiding this comment.
I removed dead code from the TestContainers days. (It really trips up AI)
simpat-adam
force-pushed
the
DMS-808
branch
2 times, most recently
from
085368c to
4b33f44
Compare
bradbanister
reviewed
Sep 7, 2025
src/dms/tests/EdFi.DataManagementService.Tests.E2E/Management/JsonTestUtilities.cs
Show resolved
Hide resolved
bradbanister
reviewed
Sep 7, 2025
| namespace EdFi.DataManagementService.Tests.E2E.StepDefinitions; | ||
|
|
||
| [Binding] | ||
| public class KafkaStepDefinitions(TestLogger logger) : IDisposable |
bradbanister
reviewed
Sep 7, 2025
| private readonly TestLogger _logger; | ||
| private readonly DateTime _collectionStartTime; | ||
|
|
||
| public KafkaMessageCollector(string bootstrapServers, TestLogger logger) |
There was a problem hiding this comment.
How about a comment that this is the Kafka listener/consumer
JBrenesSimpat
approved these changes
Sep 9, 2025
bradbanister
approved these changes
Sep 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.