refactoring Single Source of Truth
This commit is contained in:
@@ -71,6 +71,9 @@ sync_to_env_files() {
|
||||
local spring_default=$(get_version "spring-profiles-default")
|
||||
local spring_docker=$(get_version "spring-profiles-docker")
|
||||
local alpine_version=$(get_version "alpine")
|
||||
local prometheus_version=$(get_version "prometheus")
|
||||
local grafana_version=$(get_version "grafana")
|
||||
local keycloak_version=$(get_version "keycloak")
|
||||
|
||||
# Update global.env
|
||||
cat > "$BUILD_ARGS_DIR/global.env" << EOF
|
||||
@@ -92,6 +95,11 @@ VERSION=$app_version
|
||||
ALPINE_VERSION=$alpine_version
|
||||
ECLIPSE_TEMURIN_JDK_VERSION=$java_version-jdk-alpine
|
||||
ECLIPSE_TEMURIN_JRE_VERSION=$java_version-jre-alpine
|
||||
|
||||
# --- Monitoring & Infrastructure Services ---
|
||||
DOCKER_PROMETHEUS_VERSION=$prometheus_version
|
||||
DOCKER_GRAFANA_VERSION=$grafana_version
|
||||
DOCKER_KEYCLOAK_VERSION=$keycloak_version
|
||||
EOF
|
||||
print_success "Updated global.env"
|
||||
|
||||
@@ -220,6 +228,9 @@ show_current_versions() {
|
||||
echo " Node.js: $(get_version "node")"
|
||||
echo " Nginx: $(get_version "nginx")"
|
||||
echo " Alpine: $(get_version "alpine")"
|
||||
echo " Prometheus: $(get_version "prometheus")"
|
||||
echo " Grafana: $(get_version "grafana")"
|
||||
echo " Keycloak: $(get_version "keycloak")"
|
||||
echo " App Version: $(get_version "app-version")"
|
||||
echo " Spring Profile (Default): $(get_version "spring-profiles-default")"
|
||||
echo " Spring Profile (Docker): $(get_version "spring-profiles-docker")"
|
||||
@@ -242,6 +253,9 @@ show_help() {
|
||||
echo " node Node.js version"
|
||||
echo " nginx Nginx version"
|
||||
echo " alpine Alpine Linux version"
|
||||
echo " prometheus Prometheus version"
|
||||
echo " grafana Grafana version"
|
||||
echo " keycloak Keycloak version"
|
||||
echo " app-version Application version"
|
||||
echo " spring-profiles-default Default Spring profile"
|
||||
echo " spring-profiles-docker Docker Spring profile"
|
||||
|
||||
Executable
+504
@@ -0,0 +1,504 @@
|
||||
#!/bin/bash
|
||||
# ===================================================================
|
||||
# Docker Compose Template Generator
|
||||
# Generates docker-compose files from docker/versions.toml templates
|
||||
# ===================================================================
|
||||
|
||||
set -e
|
||||
|
||||
# Script directory and project root
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
|
||||
DOCKER_DIR="$PROJECT_ROOT/docker"
|
||||
VERSIONS_TOML="$DOCKER_DIR/versions.toml"
|
||||
TEMPLATES_DIR="$DOCKER_DIR/compose-templates"
|
||||
OUTPUT_DIR="$PROJECT_ROOT"
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Function to print colored output
|
||||
print_info() {
|
||||
echo -e "${BLUE}[INFO]${NC} $1"
|
||||
}
|
||||
|
||||
print_success() {
|
||||
echo -e "${GREEN}[SUCCESS]${NC} $1"
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}[WARNING]${NC} $1"
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}[ERROR]${NC} $1"
|
||||
}
|
||||
|
||||
# Function to extract version from TOML file
|
||||
get_version() {
|
||||
local key=$1
|
||||
grep "^$key = " "$VERSIONS_TOML" | sed 's/.*= "\(.*\)"/\1/' || echo ""
|
||||
}
|
||||
|
||||
# Function to extract port from TOML file
|
||||
get_port() {
|
||||
local service=$1
|
||||
grep "^$service = " "$VERSIONS_TOML" | grep -A 50 "\[service-ports\]" | grep "^$service = " | sed 's/.*= \(.*\)/\1/' || echo ""
|
||||
}
|
||||
|
||||
# Function to extract environment config from TOML file
|
||||
get_env_config() {
|
||||
local env=$1
|
||||
local key=$2
|
||||
awk "/\[environments\.$env\]/,/^\[/ {if (/^$key = /) {gsub(/.*= \"?|\"?$/, \"\"); print}}" "$VERSIONS_TOML" || echo ""
|
||||
}
|
||||
|
||||
# Function to generate build args section for a service category
|
||||
generate_build_args_section() {
|
||||
local category=$1
|
||||
|
||||
cat << EOF
|
||||
args:
|
||||
# Global build arguments (from docker/build-args/global.env)
|
||||
GRADLE_VERSION: \${DOCKER_GRADLE_VERSION:-$(get_version "gradle")}
|
||||
JAVA_VERSION: \${DOCKER_JAVA_VERSION:-$(get_version "java")}
|
||||
BUILD_DATE: \${BUILD_DATE}
|
||||
VERSION: \${DOCKER_APP_VERSION:-$(get_version "app-version")}
|
||||
EOF
|
||||
|
||||
case $category in
|
||||
"services")
|
||||
cat << EOF
|
||||
# Service-specific arguments (from docker/build-args/services.env)
|
||||
SPRING_PROFILES_ACTIVE: \${DOCKER_SPRING_PROFILES_DOCKER:-$(get_version "spring-profiles-docker")}
|
||||
EOF
|
||||
;;
|
||||
"infrastructure")
|
||||
cat << EOF
|
||||
# Infrastructure-specific arguments (from docker/build-args/infrastructure.env)
|
||||
SPRING_PROFILES_ACTIVE: \${DOCKER_SPRING_PROFILES_DEFAULT:-$(get_version "spring-profiles-default")}
|
||||
EOF
|
||||
;;
|
||||
"clients")
|
||||
cat << EOF
|
||||
# Client-specific arguments (from docker/build-args/clients.env)
|
||||
NODE_VERSION: \${DOCKER_NODE_VERSION:-$(get_version "node")}
|
||||
NGINX_VERSION: \${DOCKER_NGINX_VERSION:-$(get_version "nginx")}
|
||||
EOF
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
# Function to generate environment variables section
|
||||
generate_environment_vars_for_service() {
|
||||
local service=$1
|
||||
local environment=${2:-development}
|
||||
|
||||
local spring_profiles=$(get_env_config $environment "spring-profiles")
|
||||
local debug_enabled=$(get_env_config $environment "debug-enabled")
|
||||
local log_level=$(get_env_config $environment "log-level")
|
||||
local debug_port=$(get_env_config $environment "jvm-debug-port")
|
||||
local service_port=$(get_port $service)
|
||||
|
||||
cat << EOF
|
||||
environment:
|
||||
SPRING_PROFILES_ACTIVE: \${SPRING_PROFILES_ACTIVE:-$spring_profiles}
|
||||
SERVER_PORT: \${${service^^}_PORT:-$service_port}
|
||||
DEBUG: \${DEBUG:-$debug_enabled}
|
||||
LOGGING_LEVEL_ROOT: \${LOGGING_LEVEL_ROOT:-$log_level}
|
||||
EOF
|
||||
|
||||
# Add debug port if enabled
|
||||
if [[ "$debug_port" != "false" && "$debug_port" != "" ]]; then
|
||||
echo " JVM_DEBUG_PORT: ${debug_port}"
|
||||
fi
|
||||
}
|
||||
|
||||
# Function to generate health check section
|
||||
generate_health_check() {
|
||||
local service=$1
|
||||
local environment=${2:-development}
|
||||
|
||||
local interval=$(get_env_config $environment "health-check-interval")
|
||||
local timeout=$(get_env_config $environment "health-check-timeout")
|
||||
local retries=$(get_env_config $environment "health-check-retries")
|
||||
local start_period=$(get_env_config $environment "health-check-start-period")
|
||||
local service_port=$(get_port $service)
|
||||
|
||||
cat << EOF
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "--fail", "http://localhost:${service_port}/actuator/health/readiness"]
|
||||
interval: ${interval:-30s}
|
||||
timeout: ${timeout:-5s}
|
||||
retries: ${retries:-3}
|
||||
start_period: ${start_period:-40s}
|
||||
EOF
|
||||
}
|
||||
|
||||
# Function to generate service definition
|
||||
generate_service_definition() {
|
||||
local service=$1
|
||||
local category=$2
|
||||
local environment=${3:-development}
|
||||
|
||||
local service_port=$(get_port $service)
|
||||
local debug_port=$(get_env_config $environment "jvm-debug-port")
|
||||
|
||||
cat << EOF
|
||||
$service:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: dockerfiles/$category/$service/Dockerfile
|
||||
$(generate_build_args_section $category)
|
||||
container_name: meldestelle-$service
|
||||
$(generate_environment_vars_for_service $service $environment)
|
||||
ports:
|
||||
- "\${${service^^}_PORT:-$service_port}:$service_port"
|
||||
EOF
|
||||
|
||||
# Add debug port if enabled
|
||||
if [[ "$debug_port" != "false" && "$debug_port" != "" ]]; then
|
||||
echo " - \"${debug_port}:${debug_port}\" # Debug-Port"
|
||||
fi
|
||||
|
||||
cat << EOF
|
||||
networks:
|
||||
- meldestelle-network
|
||||
$(generate_health_check $service $environment)
|
||||
restart: unless-stopped
|
||||
EOF
|
||||
}
|
||||
|
||||
# Function to generate main infrastructure compose file
|
||||
generate_infrastructure_compose() {
|
||||
local environment=${1:-development}
|
||||
|
||||
print_info "Generating docker-compose.yml (Infrastructure)..."
|
||||
|
||||
cat > "$OUTPUT_DIR/docker-compose.yml" << EOF
|
||||
# ===================================================================
|
||||
# Docker Compose - Infrastructure Services
|
||||
# Generated from docker/versions.toml
|
||||
# Environment: $environment
|
||||
# Generated: $(date -u +'%Y-%m-%d %H:%M:%S UTC')
|
||||
# ===================================================================
|
||||
|
||||
services:
|
||||
# ===================================================================
|
||||
# Database
|
||||
# ===================================================================
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
container_name: meldestelle-postgres
|
||||
environment:
|
||||
POSTGRES_USER: \${POSTGRES_USER:-meldestelle}
|
||||
POSTGRES_PASSWORD: \${POSTGRES_PASSWORD:-meldestelle}
|
||||
POSTGRES_DB: \${POSTGRES_DB:-meldestelle}
|
||||
ports:
|
||||
- "$(get_port postgres):$(get_port postgres)"
|
||||
volumes:
|
||||
- postgres-data:/var/lib/postgresql/data
|
||||
- ./docker/services/postgres:/docker-entrypoint-initdb.d
|
||||
networks:
|
||||
- meldestelle-network
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U meldestelle -d meldestelle"]
|
||||
interval: $(get_env_config $environment "health-check-interval")
|
||||
timeout: $(get_env_config $environment "health-check-timeout")
|
||||
retries: $(get_env_config $environment "health-check-retries")
|
||||
start_period: $(get_env_config $environment "health-check-start-period")
|
||||
restart: unless-stopped
|
||||
|
||||
# ===================================================================
|
||||
# Cache
|
||||
# ===================================================================
|
||||
redis:
|
||||
image: redis:7-alpine
|
||||
container_name: meldestelle-redis
|
||||
ports:
|
||||
- "\${REDIS_PORT:-$(get_port redis)}:$(get_port redis)"
|
||||
volumes:
|
||||
- redis-data:/data
|
||||
command: redis-server --appendonly yes
|
||||
networks:
|
||||
- meldestelle-network
|
||||
healthcheck:
|
||||
test: ["CMD", "redis-cli", "ping"]
|
||||
interval: $(get_env_config $environment "health-check-interval")
|
||||
timeout: $(get_env_config $environment "health-check-timeout")
|
||||
retries: $(get_env_config $environment "health-check-retries")
|
||||
start_period: $(get_env_config $environment "health-check-start-period")
|
||||
restart: unless-stopped
|
||||
|
||||
# ===================================================================
|
||||
# Authentication
|
||||
# ===================================================================
|
||||
keycloak:
|
||||
image: quay.io/keycloak/keycloak:\${DOCKER_KEYCLOAK_VERSION:-$(get_version "keycloak")}
|
||||
container_name: meldestelle-keycloak
|
||||
environment:
|
||||
KEYCLOAK_ADMIN: \${KEYCLOAK_ADMIN:-admin}
|
||||
KEYCLOAK_ADMIN_PASSWORD: \${KEYCLOAK_ADMIN_PASSWORD:-admin}
|
||||
KC_DB: postgres
|
||||
KC_DB_URL: jdbc:postgresql://postgres:$(get_port postgres)/\${POSTGRES_DB:-meldestelle}
|
||||
KC_DB_USERNAME: \${POSTGRES_USER:-meldestelle}
|
||||
KC_DB_PASSWORD: \${POSTGRES_PASSWORD:-meldestelle}
|
||||
ports:
|
||||
- "$(get_port keycloak):8080"
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
volumes:
|
||||
- ./docker/services/keycloak:/opt/keycloak/data/import
|
||||
command: start-dev --import-realm
|
||||
networks:
|
||||
- meldestelle-network
|
||||
healthcheck:
|
||||
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:8080/"]
|
||||
interval: $(get_env_config $environment "health-check-interval")
|
||||
timeout: $(get_env_config $environment "health-check-timeout")
|
||||
retries: $(get_env_config $environment "health-check-retries")
|
||||
start_period: $(get_env_config $environment "health-check-start-period")
|
||||
restart: unless-stopped
|
||||
|
||||
# ===================================================================
|
||||
# Monitoring
|
||||
# ===================================================================
|
||||
prometheus:
|
||||
image: prom/prometheus:\${DOCKER_PROMETHEUS_VERSION:-$(get_version "prometheus")}
|
||||
container_name: meldestelle-prometheus
|
||||
ports:
|
||||
- "\${PROMETHEUS_PORT:-$(get_port prometheus)}:$(get_port prometheus)"
|
||||
volumes:
|
||||
- prometheus-data:/prometheus
|
||||
- ./docker/monitoring/prometheus:/etc/prometheus:ro
|
||||
command:
|
||||
- '--config.file=/etc/prometheus/prometheus.yml'
|
||||
- '--storage.tsdb.path=/prometheus'
|
||||
- '--web.console.libraries=/etc/prometheus/console_libraries'
|
||||
- '--web.console.templates=/etc/prometheus/consoles'
|
||||
- '--storage.tsdb.retention.time=200h'
|
||||
- '--web.enable-lifecycle'
|
||||
networks:
|
||||
- meldestelle-network
|
||||
healthcheck:
|
||||
test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:$(get_port prometheus)/-/healthy"]
|
||||
interval: $(get_env_config $environment "health-check-interval")
|
||||
timeout: $(get_env_config $environment "health-check-timeout")
|
||||
retries: $(get_env_config $environment "health-check-retries")
|
||||
start_period: $(get_env_config $environment "health-check-start-period")
|
||||
restart: unless-stopped
|
||||
|
||||
grafana:
|
||||
image: grafana/grafana:\${DOCKER_GRAFANA_VERSION:-$(get_version "grafana")}
|
||||
container_name: meldestelle-grafana
|
||||
environment:
|
||||
GF_SECURITY_ADMIN_USER: \${GF_SECURITY_ADMIN_USER:-admin}
|
||||
GF_SECURITY_ADMIN_PASSWORD: \${GF_SECURITY_ADMIN_PASSWORD:-admin}
|
||||
GF_USERS_ALLOW_SIGN_UP: \${GF_USERS_ALLOW_SIGN_UP:-false}
|
||||
GF_INSTALL_PLUGINS: grafana-piechart-panel
|
||||
ports:
|
||||
- "\${GRAFANA_PORT:-$(get_port grafana)}:$(get_port grafana)"
|
||||
volumes:
|
||||
- grafana-data:/var/lib/grafana
|
||||
- ./docker/monitoring/grafana:/etc/grafana/provisioning:ro
|
||||
depends_on:
|
||||
- prometheus
|
||||
networks:
|
||||
- meldestelle-network
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "--fail", "http://localhost:$(get_port grafana)/api/health"]
|
||||
interval: $(get_env_config $environment "health-check-interval")
|
||||
timeout: $(get_env_config $environment "health-check-timeout")
|
||||
retries: $(get_env_config $environment "health-check-retries")
|
||||
start_period: $(get_env_config $environment "health-check-start-period")
|
||||
restart: unless-stopped
|
||||
|
||||
# ===================================================================
|
||||
# Volumes
|
||||
# ===================================================================
|
||||
volumes:
|
||||
postgres-data:
|
||||
driver: local
|
||||
redis-data:
|
||||
driver: local
|
||||
prometheus-data:
|
||||
driver: local
|
||||
grafana-data:
|
||||
driver: local
|
||||
|
||||
# ===================================================================
|
||||
# Networks
|
||||
# ===================================================================
|
||||
networks:
|
||||
meldestelle-network:
|
||||
driver: bridge
|
||||
EOF
|
||||
|
||||
print_success "Generated docker-compose.yml"
|
||||
}
|
||||
|
||||
# Function to generate services compose file
|
||||
generate_services_compose() {
|
||||
local environment=${1:-development}
|
||||
|
||||
print_info "Generating docker-compose.services.yml..."
|
||||
|
||||
cat > "$OUTPUT_DIR/docker-compose.services.yml" << EOF
|
||||
# ===================================================================
|
||||
# Docker Compose - Application Services
|
||||
# Generated from docker/versions.toml
|
||||
# Environment: $environment
|
||||
# Generated: $(date -u +'%Y-%m-%d %H:%M:%S UTC')
|
||||
# ===================================================================
|
||||
|
||||
services:
|
||||
$(generate_service_definition "ping-service" "services" $environment)
|
||||
|
||||
$(generate_service_definition "api-gateway" "infrastructure" $environment)
|
||||
|
||||
# ===================================================================
|
||||
# Networks (shared network from main compose file)
|
||||
# ===================================================================
|
||||
networks:
|
||||
meldestelle-network:
|
||||
driver: bridge
|
||||
EOF
|
||||
|
||||
print_success "Generated docker-compose.services.yml"
|
||||
}
|
||||
|
||||
# Function to generate clients compose file
|
||||
generate_clients_compose() {
|
||||
local environment=${1:-development}
|
||||
|
||||
print_info "Generating docker-compose.clients.yml..."
|
||||
|
||||
cat > "$OUTPUT_DIR/docker-compose.clients.yml" << EOF
|
||||
# ===================================================================
|
||||
# Docker Compose - Client Applications
|
||||
# Generated from docker/versions.toml
|
||||
# Environment: $environment
|
||||
# Generated: $(date -u +'%Y-%m-%d %H:%M:%S UTC')
|
||||
# ===================================================================
|
||||
|
||||
services:
|
||||
# ===================================================================
|
||||
# Web Application (Compose for Web)
|
||||
# ===================================================================
|
||||
web-app:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: dockerfiles/clients/web-app/Dockerfile
|
||||
$(generate_build_args_section "clients")
|
||||
# Application-specific arguments
|
||||
CLIENT_PATH: client
|
||||
CLIENT_MODULE: client
|
||||
CLIENT_NAME: meldestelle-web-app
|
||||
container_name: meldestelle-web-app
|
||||
environment:
|
||||
NODE_ENV: \${NODE_ENV:-$(get_env_config $environment "spring-profiles")}
|
||||
API_BASE_URL: http://api-gateway:\${GATEWAY_PORT:-$(get_port "api-gateway")}
|
||||
WS_URL: ws://api-gateway:\${GATEWAY_PORT:-$(get_port "api-gateway")}/ws
|
||||
APP_TITLE: \${APP_NAME:-Meldestelle}
|
||||
APP_VERSION: \${APP_VERSION:-$(get_version "app-version")}
|
||||
ports:
|
||||
- "$(get_port "web-app"):$(get_port "web-app")"
|
||||
networks:
|
||||
- meldestelle-network
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "--fail", "http://localhost:$(get_port "web-app")/health"]
|
||||
interval: $(get_env_config $environment "health-check-interval")
|
||||
timeout: $(get_env_config $environment "health-check-timeout")
|
||||
retries: $(get_env_config $environment "health-check-retries")
|
||||
start_period: $(get_env_config $environment "health-check-start-period")
|
||||
restart: unless-stopped
|
||||
|
||||
# ===================================================================
|
||||
# Networks (shared network from main compose file)
|
||||
# ===================================================================
|
||||
networks:
|
||||
meldestelle-network:
|
||||
driver: bridge
|
||||
EOF
|
||||
|
||||
print_success "Generated docker-compose.clients.yml"
|
||||
}
|
||||
|
||||
# Function to show help
|
||||
show_help() {
|
||||
echo "Docker Compose Template Generator"
|
||||
echo ""
|
||||
echo "Usage: $0 [COMMAND] [ENVIRONMENT]"
|
||||
echo ""
|
||||
echo "Commands:"
|
||||
echo " all Generate all compose files"
|
||||
echo " infrastructure Generate docker-compose.yml (infrastructure)"
|
||||
echo " services Generate docker-compose.services.yml"
|
||||
echo " clients Generate docker-compose.clients.yml"
|
||||
echo ""
|
||||
echo "Environments:"
|
||||
echo " development Development environment (default)"
|
||||
echo " production Production environment"
|
||||
echo " testing Testing environment"
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 all # Generate all files for development"
|
||||
echo " $0 all production # Generate all files for production"
|
||||
echo " $0 infrastructure development # Generate infrastructure compose for dev"
|
||||
echo " $0 services production # Generate services compose for prod"
|
||||
}
|
||||
|
||||
# Main execution
|
||||
main() {
|
||||
# Check if versions.toml exists
|
||||
if [[ ! -f "$VERSIONS_TOML" ]]; then
|
||||
print_error "Versions file not found: $VERSIONS_TOML"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
local command=${1:-all}
|
||||
local environment=${2:-development}
|
||||
|
||||
# Validate environment
|
||||
if [[ ! "$environment" =~ ^(development|production|testing)$ ]]; then
|
||||
print_error "Invalid environment: $environment"
|
||||
print_error "Valid environments: development, production, testing"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
print_info "Generating Docker Compose files for environment: $environment"
|
||||
|
||||
case $command in
|
||||
"all")
|
||||
generate_infrastructure_compose $environment
|
||||
generate_services_compose $environment
|
||||
generate_clients_compose $environment
|
||||
print_success "All compose files generated successfully!"
|
||||
;;
|
||||
"infrastructure")
|
||||
generate_infrastructure_compose $environment
|
||||
;;
|
||||
"services")
|
||||
generate_services_compose $environment
|
||||
;;
|
||||
"clients")
|
||||
generate_clients_compose $environment
|
||||
;;
|
||||
"-h"|"--help"|"help")
|
||||
show_help
|
||||
;;
|
||||
*)
|
||||
print_error "Unknown command: $command"
|
||||
show_help
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
# Run main function with all arguments
|
||||
main "$@"
|
||||
Executable
+433
@@ -0,0 +1,433 @@
|
||||
#!/bin/bash
|
||||
# ===================================================================
|
||||
# Docker Consistency Validator
|
||||
# Validates Dockerfiles and docker-compose files against docker/versions.toml
|
||||
# ===================================================================
|
||||
|
||||
set -e
|
||||
|
||||
# Script directory and project root
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
|
||||
DOCKER_DIR="$PROJECT_ROOT/docker"
|
||||
VERSIONS_TOML="$DOCKER_DIR/versions.toml"
|
||||
DOCKERFILES_DIR="$PROJECT_ROOT/dockerfiles"
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Counters
|
||||
ERRORS=0
|
||||
WARNINGS=0
|
||||
CHECKS_PASSED=0
|
||||
|
||||
# Function to print colored output
|
||||
print_info() {
|
||||
echo -e "${BLUE}[INFO]${NC} $1"
|
||||
}
|
||||
|
||||
print_success() {
|
||||
echo -e "${GREEN}[SUCCESS]${NC} $1"
|
||||
((CHECKS_PASSED++))
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}[WARNING]${NC} $1"
|
||||
((WARNINGS++))
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}[ERROR]${NC} $1"
|
||||
((ERRORS++))
|
||||
}
|
||||
|
||||
# Function to extract version from TOML file
|
||||
get_version() {
|
||||
local key=$1
|
||||
grep "^$key = " "$VERSIONS_TOML" | sed 's/.*= "\(.*\)"/\1/' || echo ""
|
||||
}
|
||||
|
||||
# Function to get valid ARG names from TOML
|
||||
get_valid_args() {
|
||||
# Extract all version keys from [versions] section
|
||||
awk '/^\[versions\]/,/^\[/ {if (/^[a-zA-Z].*= /) print $1}' "$VERSIONS_TOML" | grep -v "^\[" || true
|
||||
|
||||
# Extract all build-args from [build-args] section
|
||||
awk '/^\[build-args\]/,/^\[/ {
|
||||
if (/^[a-zA-Z].*= \[/) {
|
||||
in_array = 1
|
||||
line = $0
|
||||
gsub(/.*= \[/, "", line)
|
||||
}
|
||||
if (in_array) {
|
||||
gsub(/[\[\]",]/, " ", line)
|
||||
split(line, args, " ")
|
||||
for (i in args) {
|
||||
if (args[i] != "" && args[i] != "]") {
|
||||
print args[i]
|
||||
}
|
||||
}
|
||||
if (/\]/) in_array = 0
|
||||
}
|
||||
}' "$VERSIONS_TOML" || true
|
||||
|
||||
# Extract service ports
|
||||
awk '/^\[service-ports\]/,/^\[/ {if (/^[a-zA-Z].*= /) print $1}' "$VERSIONS_TOML" | grep -v "^\[" || true
|
||||
}
|
||||
|
||||
# Function to get environment variable mappings from TOML
|
||||
get_env_mappings() {
|
||||
awk '/^\[environment-mapping\]/,/^\[/ {
|
||||
if (/^[a-zA-Z].*= /) {
|
||||
key = $1
|
||||
value = $3
|
||||
gsub(/"/, "", value)
|
||||
print key ":" value
|
||||
}
|
||||
}' "$VERSIONS_TOML" || true
|
||||
}
|
||||
|
||||
# Function to validate Dockerfile ARGs
|
||||
validate_dockerfile_args() {
|
||||
local dockerfile=$1
|
||||
local relative_path=${dockerfile#$PROJECT_ROOT/}
|
||||
|
||||
print_info "Validating Dockerfile: $relative_path"
|
||||
|
||||
if [[ ! -f "$dockerfile" ]]; then
|
||||
print_error "Dockerfile not found: $relative_path"
|
||||
return
|
||||
fi
|
||||
|
||||
# Get all ARG declarations from Dockerfile
|
||||
local dockerfile_args=$(grep "^ARG " "$dockerfile" | sed 's/^ARG //' | sed 's/=.*//' | sort -u)
|
||||
|
||||
# Get valid ARG names from TOML
|
||||
local valid_args=$(get_valid_args | sort -u)
|
||||
|
||||
local has_errors=false
|
||||
local has_centralized_args=false
|
||||
|
||||
# Check each ARG in Dockerfile
|
||||
while IFS= read -r arg; do
|
||||
[[ -z "$arg" ]] && continue
|
||||
|
||||
# Skip empty lines
|
||||
if [[ -z "$arg" ]]; then
|
||||
continue
|
||||
fi
|
||||
|
||||
# Check if ARG is defined in versions.toml or is a standard Docker ARG
|
||||
case "$arg" in
|
||||
# Standard Docker build args
|
||||
BUILDPLATFORM|TARGETPLATFORM|BUILDOS|TARGETOS|BUILDARCH|TARGETARCH)
|
||||
print_success " ✓ Standard Docker ARG: $arg"
|
||||
has_centralized_args=true
|
||||
;;
|
||||
# Application-specific args that should be centralized
|
||||
GRADLE_VERSION|JAVA_VERSION|NODE_VERSION|NGINX_VERSION|BUILD_DATE|VERSION|SPRING_PROFILES_ACTIVE|SERVICE_PATH|SERVICE_NAME|SERVICE_PORT|CLIENT_PATH|CLIENT_MODULE|CLIENT_NAME)
|
||||
if echo "$valid_args" | grep -q "^$arg$"; then
|
||||
print_success " ✓ Centralized ARG: $arg"
|
||||
has_centralized_args=true
|
||||
else
|
||||
print_warning " ⚠ ARG $arg should be defined in versions.toml"
|
||||
fi
|
||||
;;
|
||||
# Runtime configuration args (acceptable)
|
||||
APP_USER|APP_GROUP|APP_UID|APP_GID)
|
||||
print_success " ✓ Runtime configuration ARG: $arg"
|
||||
;;
|
||||
*)
|
||||
# Check if it's a version-related ARG that should be centralized
|
||||
if [[ "$arg" =~ _(VERSION|PORT)$ ]] || [[ "$arg" =~ ^(DOCKER_|SERVICE_|CLIENT_) ]]; then
|
||||
print_warning " ⚠ ARG $arg might need to be centralized in versions.toml"
|
||||
else
|
||||
print_success " ✓ Custom ARG: $arg"
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
done <<< "$dockerfile_args"
|
||||
|
||||
# Check if Dockerfile uses centralized version management
|
||||
if [[ "$has_centralized_args" == true ]]; then
|
||||
print_success " ✓ Dockerfile uses centralized version management"
|
||||
else
|
||||
print_warning " ⚠ Dockerfile should use centralized ARGs from versions.toml"
|
||||
fi
|
||||
|
||||
# Check for hardcoded versions
|
||||
local hardcoded_versions=$(grep -E "ARG.*=.*(alpine|[0-9]+\.[0-9]+)" "$dockerfile" | grep -v "APP_" || true)
|
||||
if [[ -n "$hardcoded_versions" ]]; then
|
||||
print_error " ❌ Hardcoded versions found (should use versions.toml):"
|
||||
echo "$hardcoded_versions" | while read -r line; do
|
||||
print_error " $line"
|
||||
done
|
||||
else
|
||||
print_success " ✓ No hardcoded versions found"
|
||||
fi
|
||||
}
|
||||
|
||||
# Function to validate docker-compose version references
|
||||
validate_compose_versions() {
|
||||
local compose_file=$1
|
||||
local relative_path=${compose_file#$PROJECT_ROOT/}
|
||||
|
||||
print_info "Validating Docker Compose file: $relative_path"
|
||||
|
||||
if [[ ! -f "$compose_file" ]]; then
|
||||
print_error "Compose file not found: $relative_path"
|
||||
return
|
||||
fi
|
||||
|
||||
# Get environment variable mappings
|
||||
local env_mappings=$(get_env_mappings)
|
||||
|
||||
# Check for version references in compose file
|
||||
local version_refs=$(grep -o '\${DOCKER_[^}]*}' "$compose_file" | sort -u || true)
|
||||
|
||||
if [[ -z "$version_refs" ]]; then
|
||||
print_warning " ⚠ No centralized version references found"
|
||||
return
|
||||
fi
|
||||
|
||||
# Validate each version reference
|
||||
while IFS= read -r ref; do
|
||||
[[ -z "$ref" ]] && continue
|
||||
|
||||
local var_name=${ref#\$\{}
|
||||
var_name=${var_name%\}}
|
||||
|
||||
# Check if mapping exists in TOML
|
||||
local mapping_found=false
|
||||
while IFS=':' read -r toml_key env_var; do
|
||||
if [[ "$env_var" == "$var_name" ]]; then
|
||||
mapping_found=true
|
||||
local toml_version=$(get_version "$toml_key")
|
||||
if [[ -n "$toml_version" ]]; then
|
||||
print_success " ✓ Version reference $ref maps to $toml_key = $toml_version"
|
||||
else
|
||||
print_error " ❌ TOML key $toml_key has no value"
|
||||
fi
|
||||
break
|
||||
fi
|
||||
done <<< "$env_mappings"
|
||||
|
||||
if [[ "$mapping_found" == false ]]; then
|
||||
print_warning " ⚠ Version reference $ref has no mapping in environment-mapping section"
|
||||
fi
|
||||
done <<< "$version_refs"
|
||||
|
||||
# Check for hardcoded image versions
|
||||
local hardcoded_images=$(grep -E "image:.*:[0-9]" "$compose_file" | grep -v "\${" || true)
|
||||
if [[ -n "$hardcoded_images" ]]; then
|
||||
print_error " ❌ Hardcoded image versions found:"
|
||||
echo "$hardcoded_images" | while read -r line; do
|
||||
print_error " $line"
|
||||
done
|
||||
else
|
||||
print_success " ✓ No hardcoded image versions found"
|
||||
fi
|
||||
}
|
||||
|
||||
# Function to validate port consistency
|
||||
validate_port_consistency() {
|
||||
print_info "Validating port consistency..."
|
||||
|
||||
# Get ports from TOML
|
||||
local toml_ports=$(awk '/^\[service-ports\]/,/^\[/ {
|
||||
if (/^[a-zA-Z].*= [0-9]/) {
|
||||
service = $1
|
||||
port = $3
|
||||
print service ":" port
|
||||
}
|
||||
}' "$VERSIONS_TOML")
|
||||
|
||||
# Check docker-compose files for port consistency
|
||||
local compose_files=("docker-compose.yml" "docker-compose.services.yml" "docker-compose.clients.yml")
|
||||
|
||||
for compose_file in "${compose_files[@]}"; do
|
||||
local full_path="$PROJECT_ROOT/$compose_file"
|
||||
if [[ -f "$full_path" ]]; then
|
||||
# Extract port mappings from compose file
|
||||
local compose_ports=$(grep -E "- \".*:[0-9]+\"" "$full_path" | sed 's/.*- "\([^"]*\)".*/\1/' || true)
|
||||
|
||||
# Compare with TOML ports
|
||||
while IFS=':' read -r service expected_port; do
|
||||
[[ -z "$service" ]] && continue
|
||||
|
||||
# Convert service name for grep (handle different naming conventions)
|
||||
local service_pattern="$service"
|
||||
case "$service" in
|
||||
"api-gateway") service_pattern="api-gateway" ;;
|
||||
"ping-service") service_pattern="ping-service" ;;
|
||||
*) ;;
|
||||
esac
|
||||
|
||||
# Check if service exists in compose file and port matches
|
||||
if grep -q "$service_pattern" "$full_path"; then
|
||||
local found_port=$(echo "$compose_ports" | grep ":$expected_port" | head -1 || true)
|
||||
if [[ -n "$found_port" ]]; then
|
||||
print_success " ✓ Port consistency for $service: $expected_port"
|
||||
else
|
||||
print_warning " ⚠ Port mismatch for $service (expected: $expected_port)"
|
||||
fi
|
||||
fi
|
||||
done <<< "$toml_ports"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
# Function to validate build args environment files
|
||||
validate_build_args_files() {
|
||||
print_info "Validating build-args environment files..."
|
||||
|
||||
local build_args_files=("global.env" "services.env" "infrastructure.env" "clients.env")
|
||||
|
||||
for env_file in "${build_args_files[@]}"; do
|
||||
local full_path="$DOCKER_DIR/build-args/$env_file"
|
||||
|
||||
if [[ -f "$full_path" ]]; then
|
||||
print_success " ✓ Build args file exists: $env_file"
|
||||
|
||||
# Check if file is not empty
|
||||
if [[ -s "$full_path" ]]; then
|
||||
print_success " ✓ Build args file is not empty: $env_file"
|
||||
else
|
||||
print_warning " ⚠ Build args file is empty: $env_file"
|
||||
fi
|
||||
|
||||
# Check for DOCKER_ environment variables
|
||||
local docker_vars=$(grep "^DOCKER_" "$full_path" | wc -l || echo "0")
|
||||
if [[ "$docker_vars" -gt 0 ]]; then
|
||||
print_success " ✓ Found $docker_vars centralized version variables in $env_file"
|
||||
else
|
||||
print_warning " ⚠ No DOCKER_ version variables found in $env_file"
|
||||
fi
|
||||
else
|
||||
print_error " ❌ Build args file missing: $env_file"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
# Function to show validation summary
|
||||
show_summary() {
|
||||
echo ""
|
||||
echo "==============================================="
|
||||
echo "Docker Consistency Validation Summary"
|
||||
echo "==============================================="
|
||||
echo -e "${GREEN}Checks Passed: $CHECKS_PASSED${NC}"
|
||||
echo -e "${YELLOW}Warnings: $WARNINGS${NC}"
|
||||
echo -e "${RED}Errors: $ERRORS${NC}"
|
||||
echo "==============================================="
|
||||
|
||||
if [[ $ERRORS -eq 0 ]]; then
|
||||
if [[ $WARNINGS -eq 0 ]]; then
|
||||
print_success "All consistency checks passed! ✨"
|
||||
return 0
|
||||
else
|
||||
print_warning "Validation completed with warnings. Consider addressing them for optimal consistency."
|
||||
return 0
|
||||
fi
|
||||
else
|
||||
print_error "Validation failed with $ERRORS errors. Please fix them before proceeding."
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
# Function to show help
|
||||
show_help() {
|
||||
echo "Docker Consistency Validator"
|
||||
echo ""
|
||||
echo "Usage: $0 [COMMAND]"
|
||||
echo ""
|
||||
echo "Commands:"
|
||||
echo " all Run all validation checks (default)"
|
||||
echo " dockerfiles Validate Dockerfile ARG declarations"
|
||||
echo " compose Validate docker-compose version references"
|
||||
echo " ports Validate port consistency"
|
||||
echo " build-args Validate build-args environment files"
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 # Run all validations"
|
||||
echo " $0 dockerfiles # Validate only Dockerfiles"
|
||||
echo " $0 compose # Validate only compose files"
|
||||
echo " $0 ports # Validate only port consistency"
|
||||
}
|
||||
|
||||
# Main execution
|
||||
main() {
|
||||
# Check if versions.toml exists
|
||||
if [[ ! -f "$VERSIONS_TOML" ]]; then
|
||||
print_error "Versions file not found: $VERSIONS_TOML"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
local command=${1:-all}
|
||||
|
||||
print_info "Docker Consistency Validation - Starting..."
|
||||
print_info "Versions file: $VERSIONS_TOML"
|
||||
echo ""
|
||||
|
||||
case $command in
|
||||
"all")
|
||||
# Validate Dockerfiles
|
||||
find "$DOCKERFILES_DIR" -name "Dockerfile" -type f | while read -r dockerfile; do
|
||||
validate_dockerfile_args "$dockerfile"
|
||||
echo ""
|
||||
done
|
||||
|
||||
# Validate docker-compose files
|
||||
for compose_file in docker-compose*.yml; do
|
||||
if [[ -f "$PROJECT_ROOT/$compose_file" ]]; then
|
||||
validate_compose_versions "$PROJECT_ROOT/$compose_file"
|
||||
echo ""
|
||||
fi
|
||||
done
|
||||
|
||||
# Validate port consistency
|
||||
validate_port_consistency
|
||||
echo ""
|
||||
|
||||
# Validate build args files
|
||||
validate_build_args_files
|
||||
;;
|
||||
"dockerfiles")
|
||||
find "$DOCKERFILES_DIR" -name "Dockerfile" -type f | while read -r dockerfile; do
|
||||
validate_dockerfile_args "$dockerfile"
|
||||
echo ""
|
||||
done
|
||||
;;
|
||||
"compose")
|
||||
for compose_file in docker-compose*.yml; do
|
||||
if [[ -f "$PROJECT_ROOT/$compose_file" ]]; then
|
||||
validate_compose_versions "$PROJECT_ROOT/$compose_file"
|
||||
echo ""
|
||||
fi
|
||||
done
|
||||
;;
|
||||
"ports")
|
||||
validate_port_consistency
|
||||
;;
|
||||
"build-args")
|
||||
validate_build_args_files
|
||||
;;
|
||||
"-h"|"--help"|"help")
|
||||
show_help
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
print_error "Unknown command: $command"
|
||||
show_help
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
show_summary
|
||||
}
|
||||
|
||||
# Run main function with all arguments
|
||||
main "$@"
|
||||
Reference in New Issue
Block a user