Files
dance-lessons-coach/scripts/test-graceful-shutdown.sh
Gabriel Radureau 7c5e61c386 Implement comprehensive graceful shutdown with JSON logging
- Added signal.NotifyContext for modern signal handling in cmd/server/main.go
- Implemented BaseContext for proper context propagation to HTTP handlers
- Added readiness drain delay before shutdown for graceful degradation
- Fixed PID detection in start-server.sh to target actual server process
- Added Logging.JSON configuration option with DLC_LOGGING_JSON environment variable
- Created comprehensive test script that validates entire server lifecycle
- Updated documentation with JSON logging configuration examples
- All shutdown logs now appear correctly in JSON format
- Server terminates gracefully on SIGTERM with proper log flushing

The graceful shutdown implementation follows VictoriaMetrics best practices:
1. Catches termination signals (SIGTERM, SIGINT)
2. Stops accepting new requests but allows ongoing requests to complete
3. Waits for active requests to finish within configured timeout
4. Releases resources and performs cleanup
5. Logs all shutdown steps for observability

Test script validates:
- Server startup and API functionality
- Graceful shutdown sequence
- JSON log format validation
- Complete log sequence verification
- Proper signal handling and context propagation

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
2026-04-03 19:23:23 +02:00

183 lines
5.3 KiB
Bash
Executable File

#!/bin/bash
# DanceLessonsCoach Graceful Shutdown Test Script
# This script tests the complete server lifecycle with JSON logging
# and validates that all shutdown logs are present
set -e
# Configuration
PROJECT_DIR="/Users/gabrielradureau/Work/Vibe/DanceLessonsCoach"
SERVER_CMD="./scripts/start-server.sh"
LOG_FILE="server.log"
PID_FILE="server.pid"
TEST_LOG="shutdown_test.log"
# Colors for output - use simple echo -e with inline ANSI codes
echo -e "\\033[1;34m=== DanceLessonsCoach Graceful Shutdown Test ===\\033[0m"
echo ""
# Clean up any existing server
cd "$PROJECT_DIR"
echo "Cleaning up any existing server..."
if [ -f "$PID_FILE" ]; then
echo "Found existing PID file, stopping previous server..."
$SERVER_CMD stop > /dev/null 2>&1 || true
rm -f "$PID_FILE" "$LOG_FILE"
fi
# Kill any processes on port 8080
pkill -9 -f "go run" > /dev/null 2>&1 || true
lsof -ti :8080 | xargs -I {} kill -9 {} > /dev/null 2>&1 || true
sleep 1
echo "Starting server with JSON logging..."
DLC_LOGGING_JSON=true $SERVER_CMD start
sleep 3
echo "Testing API endpoints..."
# Test health endpoint
echo "Testing /api/health:"
HEALTH_RESPONSE=$(curl -s http://localhost:8080/api/health)
echo "Response: $HEALTH_RESPONSE"
# Test greet endpoint
echo "Testing /api/v1/greet/:"
GREET_RESPONSE=$(curl -s http://localhost:8080/api/v1/greet/)
echo "Response: $GREET_RESPONSE"
# Test greet with name
echo "Testing /api/v1/greet/TestUser:"
GREET_NAME_RESPONSE=$(curl -s http://localhost:8080/api/v1/greet/TestUser)
echo "Response: $GREET_NAME_RESPONSE"
echo ""
echo "Stopping server gracefully..."
$SERVER_CMD stop
sleep 3
echo ""
echo "Analyzing server logs..."
# Check if log file exists and is not empty
if [ ! -f "$LOG_FILE" ] || [ ! -s "$LOG_FILE" ]; then
echo -e "\\033[0;31m❌ FAIL: Log file is missing or empty\\033[0m"
exit 1
fi
# Validate all lines are proper JSON
if ! cat "$LOG_FILE" | jq -e '.' >/dev/null 2>&1; then
echo -e "\\033[0;31m❌ FAIL: Some log lines are not valid JSON\\033[0m"
exit 1
fi
echo -e "\\033[0;32m✅ All log lines are valid JSON\033[0m"
# Check for required startup logs
if ! grep -q "Config file loaded" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Config file loaded' log\033[0m"
exit 1
fi
if ! grep -q "Configuration loaded" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Configuration loaded' log\033[0m"
exit 1
fi
if ! grep -q "Logging configured" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Logging configured' log\033[0m"
exit 1
fi
if ! grep -q "Registering greet routes" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Registering greet routes' log\033[0m"
exit 1
fi
if ! grep -q "Server running" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Server running' log\033[0m"
exit 1
fi
echo -e "\\033[0;32m✅ All startup logs present\033[0m"
# Check for API call logs
if ! grep -q "Health check requested" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Health check requested' log\033[0m"
exit 1
fi
if ! grep -q "TestUser" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'TestUser' greet log\033[0m"
exit 1
fi
echo -e "\\033[0;32m✅ All API call logs present\033[0m"
# Check for required shutdown logs - THIS IS THE CRITICAL PART
MISSING_LOGS=0
if ! grep -q "Shutdown signal received" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Shutdown signal received' log\033[0m"
MISSING_LOGS=1
fi
if ! grep -q "Readiness check propagated" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Readiness check propagated' log\033[0m"
MISSING_LOGS=1
fi
if ! grep -q "Server shutdown complete" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Server shutdown complete' log\033[0m"
MISSING_LOGS=1
fi
if ! grep -q "Server exited" "$LOG_FILE"; then
echo -e "\\033[0;31m❌ FAIL: Missing 'Server exited' log\033[0m"
MISSING_LOGS=1
fi
if [ $MISSING_LOGS -eq 1 ]; then
echo ""
echo -e "\\033[1;33mCurrent log file contents:\033[0m"
echo "================================"
cat "$LOG_FILE"
echo "================================"
echo ""
echo -e "\\033[0;31m❌ GRACEFUL SHUTDOWN TEST FAILED\033[0m"
echo "Shutdown logs are missing!"
exit 1
fi
echo -e "\\033[0;32m✅ All shutdown logs present\033[0m"
# Additional validation: Check that logs appear in correct order
echo "Validating log sequence..."
# Extract just the message fields for sequence validation
LOG_MESSAGES=$(cat "$LOG_FILE" | jq -r '.message')
# Check that startup comes before API calls
if echo "$LOG_MESSAGES" | grep -n "Server running" | head -1 | cut -d: -f1 | xargs expr 1000 \>; then
# Check that API calls come before shutdown
HEALTH_LINE=$(echo "$LOG_MESSAGES" | grep -n "Health check requested" | head -1 | cut -d: -f1)
SHUTDOWN_LINE=$(echo "$LOG_MESSAGES" | grep -n "Shutdown signal received" | head -1 | cut -d: -f1)
if [ "$HEALTH_LINE" -lt "$SHUTDOWN_LINE" ]; then
echo -e "\\033[0;32m✅ Log sequence is correct\033[0m"
else
echo -e "\\033[0;31m❌ FAIL: Log sequence is incorrect\033[0m"
exit 1
fi
fi
echo ""
echo -e "\\033[0;32m🎉 GRACEFUL SHUTDOWN TEST PASSED!\033[0m"
echo "All required logs are present and in correct order."
echo ""
# Clean up
rm -f "$PID_FILE" "$LOG_FILE"
exit 0