Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.

Commit e8fa04c

Browse files
committed
fix: [#28] improve environment variable handling and terminology clarity
Environment Variable Construction Fixes: - Fix ENVIRONMENT variable construction in health-check.sh - Change from ${ENVIRONMENT_TYPE}-${ENVIRONMENT_FILE} to ${ENVIRONMENT_FILE} - ENVIRONMENT_FILE already contains full identifier (e.g., 'e2e-libvirt') - Prevents problematic patterns like 'e2e-e2e-libvirt' Command Suggestion Updates: - Update make command suggestions to use new ENVIRONMENT_TYPE/ENVIRONMENT_FILE format - Replace legacy ENVIRONMENT= format in error messages and help text - Provide clear guidance for infrastructure and application commands Terminology Improvements: - Change 'Environment:' to 'Environment type:' for clarity in logs - Update Makefile help text to be more descriptive - Improve user understanding of environment configuration structure Files updated: - Makefile: Update app-health-check help text for clarity - infrastructure/scripts/configure-env.sh: Improve logging terminology - infrastructure/scripts/health-check.sh: Fix environment variable construction and command suggestions
1 parent 36282c5 commit e8fa04c

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ app-redeploy: ## Redeploy application without infrastructure changes
271271
ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/deploy-app.sh $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)
272272

273273
app-health-check: ## Validate deployment health
274-
@echo "Running health check for $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)..."
274+
@echo "Running health check for environment type: $(ENVIRONMENT_TYPE), environment file: $(ENVIRONMENT_FILE)..."
275275
ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/health-check.sh $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)
276276

277277
app-test-config: ## Test application configuration

infrastructure/scripts/configure-env.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ generate_environment_config() {
9090
fi
9191

9292
log_info "Generating ${output_name}.env from base template..."
93-
log_info "Environment: ${environment}, Provider: ${provider}"
93+
log_info "Environment type: ${environment}, Provider: ${provider}"
9494

9595
# Generate environment-specific variables
9696
case "${environment}" in
@@ -510,7 +510,7 @@ generate_docker_env() {
510510

511511
# Main execution
512512
main() {
513-
log_info "Starting configuration generation for environment: ${ENVIRONMENT} with provider: ${PROVIDER}"
513+
log_info "Starting configuration generation for environment type: ${ENVIRONMENT} with provider: ${PROVIDER}"
514514

515515
# Validate inputs
516516
validate_environment_type "${ENVIRONMENT}"

infrastructure/scripts/health-check.sh

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ source "${PROJECT_ROOT}/scripts/shell-utils.sh"
1717
# Parse arguments - Support both new and legacy parameter formats
1818
if [[ -n "${ENVIRONMENT_TYPE:-}" && -n "${ENVIRONMENT_FILE:-}" ]]; then
1919
# New explicit configuration approach
20-
ENVIRONMENT="${ENVIRONMENT_TYPE}-${ENVIRONMENT_FILE}"
20+
# ENVIRONMENT_FILE already contains the full environment identifier (e.g., "e2e-libvirt")
21+
ENVIRONMENT="${ENVIRONMENT_FILE}"
2122
VM_IP="" # Get from Terraform, not parameter
2223
elif [ $# -lt 1 ]; then
2324
echo "ERROR: Environment argument required"
@@ -125,7 +126,7 @@ get_vm_ip() {
125126

126127
if [[ ! -d "${TERRAFORM_DIR}" ]]; then
127128
log_error "Terraform directory not found: ${TERRAFORM_DIR}"
128-
log_error "Run 'make infra-apply ENVIRONMENT=${ENVIRONMENT}' first"
129+
log_error "Run 'make infra-apply ENVIRONMENT_TYPE=${ENVIRONMENT_TYPE} ENVIRONMENT_FILE=${ENVIRONMENT_FILE}' first"
129130
exit 1
130131
fi
131132

@@ -382,7 +383,7 @@ generate_health_report() {
382383
echo "=== TROUBLESHOOTING SUGGESTIONS ==="
383384
echo "1. Check service logs: ssh torrust@${vm_ip} 'cd torrust-tracker-demo/application && docker compose logs'"
384385
echo "2. Restart services: ssh torrust@${vm_ip} 'cd torrust-tracker-demo/application && docker compose restart'"
385-
echo "3. Redeploy application: make app-deploy ENVIRONMENT=${ENVIRONMENT}"
386+
echo "3. Redeploy application: make app-deploy ENVIRONMENT_TYPE=${ENVIRONMENT_TYPE} ENVIRONMENT_FILE=${ENVIRONMENT_FILE}"
386387
echo
387388
return 1
388389
fi
@@ -446,7 +447,7 @@ Health Checks Performed:
446447
447448
Prerequisites:
448449
Application must be deployed first:
449-
make app-deploy ENVIRONMENT=${ENVIRONMENT}
450+
make app-deploy ENVIRONMENT_TYPE=${ENVIRONMENT_TYPE} ENVIRONMENT_FILE=${ENVIRONMENT_FILE}
450451
EOF
451452
}
452453

0 commit comments

Comments
 (0)