mirror of
https://github.com/seaweedfs/seaweedfs.git
synced 2026-08-16 04:06:44 +00:00
chrislu
5f8b632ff2
## Test Results ✅ SeekToBeginningTest.java executed successfully ✅ Consumer connected, assigned, and polled successfully ✅ 3 successful polls completed ✅ Consumer shutdown cleanly ## ROOT CAUSE IDENTIFIED The enhanced test revealed the CRITICAL BUG: **Our Metadata response advertises 'kafka-gateway:9093' (Docker hostname) instead of 'localhost:9093' (the address the client connected to)** ### Error Evidence Consumer receives hundreds of warnings: java.net.UnknownHostException: kafka-gateway at java.base/java.net.DefaultHostResolver.resolve() ### Why This Causes Schema Registry to Timeout 1. Client (Schema Registry) connects to kafka-gateway:9093 2. Gateway responds with Metadata 3. Metadata says broker is at 'kafka-gateway:9093' 4. Client tries to use that hostname 5. Name resolution works (Docker network) 6. BUT: Protocol response format or connectivity issue persists 7. Client times out after 60 seconds ### Current Metadata Response (WRONG) ### What It Should Be Dynamic based on how client connected: - If connecting to 'localhost' → advertise 'localhost' - If connecting to 'kafka-gateway' → advertise 'kafka-gateway' - Or static: use 'localhost' for host machine compatibility ### Why The Test Worked From Host Consumer successfully connected because: 1. Connected to localhost:9093 ✅ 2. Metadata said broker is kafka-gateway:9093 ❌ 3. Tried to resolve kafka-gateway from host ❌ 4. Failed resolution, but fallback polling worked anyway ✅ 5. Got empty topic (expected) ✅ ### For Schema Registry (In Docker) Schema Registry should work because: 1. Connects to kafka-gateway:9093 (both in Docker network) ✅ 2. Metadata says broker is kafka-gateway:9093 ✅ 3. Can resolve kafka-gateway (same Docker network) ✅ 4. Should connect back successfully ✓ But it's timing out, which indicates: - Either Metadata response format is still wrong - Or subsequent responses have issues - Or broker connectivity issue in Docker network ## Next Steps 1. Fix Metadata response to advertise correct hostname 2. Verify hostname matches client connection 3. Test again with Schema Registry 4. Debug if it still times out This is NOT a Kafka client bug. This is a **SeaweedFS Metadata advertisement bug**.
Kafka Gateway Tests with SMQ Integration
This directory contains tests for the SeaweedFS Kafka Gateway with full SeaweedMQ (SMQ) integration.
Test Types
Unit Tests (./unit/)
- Basic gateway functionality
- Protocol compatibility
- No SeaweedFS backend required
- Uses mock handlers
Integration Tests (./integration/)
- Mock Mode (default): Uses in-memory handlers for protocol testing
- SMQ Mode (with
SEAWEEDFS_MASTERS): Uses real SeaweedFS backend for full integration
E2E Tests (./e2e/)
- End-to-end workflows
- Automatically detects SMQ availability
- Falls back to mock mode if SMQ unavailable
Running Tests Locally
Quick Protocol Testing (Mock Mode)
# Run all integration tests with mock backend
cd test/kafka
go test ./integration/...
# Run specific test
go test -v ./integration/ -run TestClientCompatibility
Full Integration Testing (SMQ Mode)
Requires running SeaweedFS instance:
- Start SeaweedFS with MQ support:
# Terminal 1: Start SeaweedFS server
weed server -ip="127.0.0.1" -ip.bind="0.0.0.0" -dir=/tmp/seaweedfs-data -master.port=9333 -volume.port=8081 -filer.port=8888 -filer=true
# Terminal 2: Start MQ broker
weed mq.broker -master="127.0.0.1:9333" -ip="127.0.0.1" -port=17777
- Run tests with SMQ backend:
cd test/kafka
SEAWEEDFS_MASTERS=127.0.0.1:9333 go test ./integration/...
# Run specific SMQ integration tests
SEAWEEDFS_MASTERS=127.0.0.1:9333 go test -v ./integration/ -run TestSMQIntegration
Test Broker Startup
If you're having broker startup issues:
# Debug broker startup locally
./scripts/test-broker-startup.sh
CI/CD Integration
GitHub Actions Jobs
- Unit Tests - Fast protocol tests with mock backend
- Integration Tests - Mock mode by default
- E2E Tests (with SMQ) - Full SeaweedFS + MQ broker stack
- Client Compatibility (with SMQ) - Tests different Kafka clients against real backend
- Consumer Group Tests (with SMQ) - Tests consumer group persistence
- SMQ Integration Tests - Dedicated SMQ-specific functionality tests
What Gets Tested with SMQ
When SEAWEEDFS_MASTERS is available, tests exercise:
- Real Message Persistence - Messages stored in SeaweedFS volumes
- Offset Persistence - Consumer group offsets stored in SeaweedFS filer
- Topic Persistence - Topic metadata persisted in SeaweedFS filer
- Consumer Group Coordination - Distributed coordinator assignment
- Cross-Client Compatibility - Sarama, kafka-go with real backend
- Broker Discovery - Gateway discovers MQ brokers via masters
Test Infrastructure
testutil.NewGatewayTestServerWithSMQ(t, mode)
Smart gateway creation that automatically:
- Detects SMQ availability via
SEAWEEDFS_MASTERS - Uses production handler when available
- Falls back to mock when unavailable
- Provides timeout protection against hanging
Modes:
SMQRequired- Skip test if SMQ unavailableSMQAvailable- Use SMQ if available, otherwise mockSMQUnavailable- Always use mock
Timeout Protection
Gateway creation includes timeout protection to prevent CI hanging:
- 20 second timeout for
SMQRequiredmode - 15 second timeout for
SMQAvailablemode - Clear error messages when broker discovery fails
Debugging Failed Tests
CI Logs to Check
- "SeaweedFS master is up" - Master started successfully
- "SeaweedFS filer is up" - Filer ready
- "SeaweedFS MQ broker is up" - Broker started successfully
- Broker/Server logs - Shown on broker startup failure
Local Debugging
- Run
./scripts/test-broker-startup.shto test broker startup - Check logs at
/tmp/weed-*.log - Test individual components:
# Test master curl http://127.0.0.1:9333/cluster/status # Test filer curl http://127.0.0.1:8888/status # Test broker nc -z 127.0.0.1 17777
Common Issues
- Broker fails to start: Check filer is ready before starting broker
- Gateway timeout: Broker discovery fails, check broker is accessible
- Test hangs: Timeout protection not working, reduce timeout values
Architecture
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ Kafka Client │───▶│ Kafka Gateway │───▶│ SeaweedMQ Broker│
│ (Sarama, │ │ (Protocol │ │ (Message │
│ kafka-go) │ │ Handler) │ │ Persistence) │
└─────────────────┘ └─────────────────┘ └─────────────────┘
│ │
▼ ▼
┌─────────────────┐ ┌─────────────────┐
│ SeaweedFS Filer │ │ SeaweedFS Master│
│ (Offset Storage)│ │ (Coordination) │
└─────────────────┘ └─────────────────┘
│ │
▼ ▼
┌─────────────────────────────────────────┐
│ SeaweedFS Volumes │
│ (Message Storage) │
└─────────────────────────────────────────┘
This architecture ensures full integration testing of the entire Kafka → SeaweedFS message path.