This repository was archived by the owner on Oct 10, 2025. It is now read-only.
forked from torrust/torrust-demo
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathMakefile
More file actions
391 lines (341 loc) · 18.2 KB
/
Makefile
File metadata and controls
391 lines (341 loc) · 18.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
# Makefile for Torrust Tracker Demo - Twelve-Factor App Deployment
.PHONY: help install-deps test-e2e lint test-unit clean
.PHONY: infra-init infra-plan infra-apply infra-destroy infra-status infra-refresh-state
.PHONY: infra-config infra-validate-config
.PHONY: infra-test-prereq infra-test-ci infra-test-local
.PHONY: infra-providers infra-environments provider-info
.PHONY: app-config app-validate-config app-deploy app-redeploy app-health-check
.PHONY: app-test-config app-test-containers app-test-services
.PHONY: vm-ssh vm-console vm-gui-console vm-clean-ssh vm-prepare-ssh vm-status
.PHONY: dev-setup dev-deploy dev-test dev-clean
# Default environment variables
ENVIRONMENT_TYPE ?= development
ENVIRONMENT_FILE ?= development-libvirt
# Directory paths
INFRA_TESTS_DIR = infrastructure/tests
SCRIPTS_DIR = infrastructure/scripts
TERRAFORM_DIR = infrastructure/terraform
# Default target - show help when no target specified
.DEFAULT_GOAL := help
# Parameter validation target
check-infra-params:
@if [ -z "$(ENVIRONMENT_TYPE)" ]; then \
echo "❌ Error: ENVIRONMENT_TYPE not specified"; \
echo "Usage: make <target> ENVIRONMENT_TYPE=<type> ENVIRONMENT_FILE=<file>"; \
echo "Available environment types: development, testing, e2e, staging, production"; \
exit 1; \
fi
@if [ -z "$(ENVIRONMENT_FILE)" ]; then \
echo "❌ Error: ENVIRONMENT_FILE not specified"; \
echo "Usage: make <target> ENVIRONMENT_TYPE=<type> ENVIRONMENT_FILE=<file>"; \
echo "Example: make infra-apply ENVIRONMENT_TYPE=development ENVIRONMENT_FILE=development-libvirt"; \
exit 1; \
fi
# Help target
help: ## Show this help message
@echo "Torrust Tracker Demo - Twelve-Factor App Deployment"
@echo ""
@echo "🚀 QUICK DEVELOPMENT WORKFLOWS:"
@echo " dev-setup Complete development setup"
@echo " dev-deploy Full deployment workflow (infra + app)"
@echo " dev-test Quick validation (syntax + unit tests)"
@echo " dev-clean Complete cleanup"
@echo ""
@echo "📋 INFRASTRUCTURE LAYER:"
@awk 'BEGIN {FS = ":.*?## "} /^infra-.*:.*?## / {printf " %-20s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@echo ""
@echo "🐳 APPLICATION LAYER:"
@awk 'BEGIN {FS = ":.*?## "} /^app-.*:.*?## / {printf " %-20s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@echo ""
@echo "🖥️ VM ACCESS:"
@awk 'BEGIN {FS = ":.*?## "} /^vm-.*:.*?## / {printf " %-20s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@echo ""
@echo "🧪 TESTING (3-LAYER ARCHITECTURE):"
@awk 'BEGIN {FS = ":.*?## "} /^test.*:.*?## / {printf " %-20s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@awk 'BEGIN {FS = ":.*?## "} /^infra-test.*:.*?## / {printf " %-20s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@awk 'BEGIN {FS = ":.*?## "} /^app-test.*:.*?## / {printf " %-20s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@echo ""
@echo "⚙️ SYSTEM SETUP:"
@awk 'BEGIN {FS = ":.*?## "} /^(install-deps|clean).*:.*?## / {printf " %-20s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@echo ""
@echo "Development examples:"
@echo " make dev-deploy # Uses defaults: development + libvirt"
@echo " make infra-apply ENVIRONMENT_TYPE=development ENVIRONMENT_FILE=development-libvirt"
@echo " make infra-apply ENVIRONMENT_TYPE=production ENVIRONMENT_FILE=production-hetzner"
@echo " make app-deploy ENVIRONMENT_TYPE=development ENVIRONMENT_FILE=development-libvirt"
@echo ""
@echo "Enhanced Configuration Workflow (Phases 1-6 Completed):"
@echo " make infra-config ENVIRONMENT_TYPE=development PROVIDER=libvirt # Generate development-libvirt.env"
@echo " make infra-validate-config ENVIRONMENT_FILE=development-libvirt # Validate infrastructure config"
@echo " make app-config ENVIRONMENT_FILE=development-libvirt # Generate application configs"
@echo " make app-validate-config ENVIRONMENT_FILE=development-libvirt # Validate application configs"
@echo ""
@echo "Complete Deployment Workflow:"
@echo " make infra-apply ENVIRONMENT_TYPE=development ENVIRONMENT_FILE=development-libvirt # Build stage"
@echo " make app-deploy ENVIRONMENT_TYPE=development ENVIRONMENT_FILE=development-libvirt # Release + Run stages"
install-deps: ## Install required dependencies (Ubuntu/Debian)
@echo "Installing dependencies..."
sudo apt update
sudo apt install -y qemu-kvm libvirt-daemon-system libvirt-clients bridge-utils virt-manager virt-viewer genisoimage
sudo usermod -aG libvirt $$USER
sudo usermod -aG kvm $$USER
@echo "Dependencies installed. Please log out and log back in for group changes to take effect."
# =============================================================================
# INFRASTRUCTURE LAYER (PLATFORM SETUP & CONFIGURATION)
# =============================================================================
infra-init: check-infra-params ## Initialize infrastructure (Terraform init)
@echo "Initializing infrastructure with environment file: $(ENVIRONMENT_FILE)"
ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/provision-infrastructure.sh init
infra-plan: check-infra-params ## Plan infrastructure changes
@echo "Planning infrastructure with environment file: $(ENVIRONMENT_FILE)"
ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/provision-infrastructure.sh plan
infra-apply: check-infra-params ## Provision infrastructure (platform setup)
@echo "Provisioning infrastructure with environment file: $(ENVIRONMENT_FILE)"
@echo "⚠️ This command may prompt for your password for sudo operations"
@if [ "$(SKIP_WAIT)" = "true" ]; then \
echo "⚠️ SKIP_WAIT=true - Infrastructure will not wait for full readiness"; \
else \
echo "ℹ️ Infrastructure will wait for full readiness (use SKIP_WAIT=true to skip)"; \
fi
SKIP_WAIT=$(SKIP_WAIT) ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/provision-infrastructure.sh apply
infra-destroy: check-infra-params ## Destroy infrastructure
@echo "Destroying infrastructure with environment file: $(ENVIRONMENT_FILE)"
ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/provision-infrastructure.sh destroy
infra-status: ## Show infrastructure status
@echo "Infrastructure status:"
@cd $(TERRAFORM_DIR) && tofu show -no-color | grep -E "(vm_ip|vm_status)" || echo "No infrastructure found"
infra-refresh-state: check-infra-params ## Refresh Terraform state to detect IP changes
@echo "Refreshing Terraform state..."
@cd $(TERRAFORM_DIR) && tofu refresh
# Provider and environment information
infra-providers: ## List available infrastructure providers
@echo "Available Infrastructure Providers:"
@echo "Templates (infrastructure/config/templates/providers/):"
@ls infrastructure/config/templates/providers/*.env.tpl 2>/dev/null | \
xargs -I {} basename {} | sed 's/\.env.*//g' | sort | uniq || \
echo " No templates found"
@echo ""
@echo "User configurations (infrastructure/config/providers/):"
@ls infrastructure/config/providers/*.env 2>/dev/null | \
xargs -I {} basename {} | sed 's/\.env.*//g' | sort | uniq || \
echo " No user configs found"
@echo ""
@echo "Provider types:"
@echo " libvirt - Local KVM/libvirt virtualization for development"
@echo " hetzner - Hetzner Cloud for production deployments"
@echo ""
@echo "Usage examples:"
@echo " make infra-apply ENVIRONMENT_TYPE=development ENVIRONMENT_FILE=development-libvirt"
@echo " make infra-apply ENVIRONMENT_TYPE=staging ENVIRONMENT_FILE=staging-digitalocean"
@echo " make infra-apply ENVIRONMENT_TYPE=production ENVIRONMENT_FILE=production-hetzner"
infra-environments: ## List available environments and their providers
@echo "Available Environment Configurations:"
@echo ""
@echo "Templates (infrastructure/config/templates/environments/):"
@ls infrastructure/config/templates/environments/*.defaults 2>/dev/null | \
xargs -I {} basename {} .defaults | sort | sed 's/^/ /' || \
echo " No template defaults found"
@echo ""
@echo "User configurations (infrastructure/config/environments/):"
@if ls infrastructure/config/environments/*.env >/dev/null 2>&1; then \
for file in infrastructure/config/environments/*.env; do \
if [ -f "$$file" ]; then \
env=$$(grep "^ENVIRONMENT_TYPE=" "$$file" 2>/dev/null | cut -d'=' -f2 | tr -d '"' | tr -d "'"); \
provider=$$(grep "^PROVIDER=" "$$file" 2>/dev/null | cut -d'=' -f2 | tr -d '"' | tr -d "'"); \
filename=$$(basename "$$file" .env); \
echo " $$filename -> Environment: $$env, Provider: $$provider"; \
fi \
done; \
else \
echo " No user configs found"; \
fi
@echo ""
@echo "Environment types:"
@echo " development - Local development and testing"
@echo " testing - General testing (reserved for future use)"
@echo " e2e - End-to-end testing"
@echo " staging - Pre-production testing"
@echo " production - Production deployment"
@echo ""
@echo "Usage examples:"
@echo " make infra-config ENVIRONMENT_TYPE=development PROVIDER=libvirt # Create development-libvirt.env"
@echo " make infra-config ENVIRONMENT_TYPE=production PROVIDER=hetzner # Create production-hetzner.env"
@echo " make infra-apply ENVIRONMENT_TYPE=development ENVIRONMENT_FILE=development-libvirt"
@echo " make infra-apply ENVIRONMENT_TYPE=production ENVIRONMENT_FILE=production-hetzner"
provider-info: ## Show provider information (requires PROVIDER=<name>)
@if [ -z "$(PROVIDER)" ]; then \
echo "Error: PROVIDER not specified"; \
echo "Usage: make provider-info PROVIDER=<provider>"; \
exit 1; \
fi
@echo "Getting information for provider: $(PROVIDER)"
@$(SCRIPTS_DIR)/providers/provider-interface.sh info $(PROVIDER)
infra-config: ## Generate environment configuration (requires ENVIRONMENT_TYPE and PROVIDER)
@if [ -z "$(ENVIRONMENT_TYPE)" ]; then \
echo "Error: ENVIRONMENT_TYPE not specified"; \
echo "Usage: make infra-config ENVIRONMENT_TYPE=<type> PROVIDER=<provider>"; \
echo "Available environment types: development, testing, e2e, staging, production"; \
echo "Available providers: libvirt, hetzner"; \
echo "Example: make infra-config ENVIRONMENT_TYPE=development PROVIDER=libvirt"; \
exit 1; \
fi
@if [ -z "$(PROVIDER)" ]; then \
echo "Error: PROVIDER not specified"; \
echo "Usage: make infra-config ENVIRONMENT_TYPE=<type> PROVIDER=<provider>"; \
echo "Available environment types: development, testing, e2e, staging, production"; \
echo "Available providers: libvirt, hetzner"; \
echo "Example: make infra-config ENVIRONMENT_TYPE=development PROVIDER=libvirt"; \
exit 1; \
fi
@echo "Configuring $(ENVIRONMENT_TYPE) environment for $(PROVIDER)..."
$(SCRIPTS_DIR)/configure-env.sh $(ENVIRONMENT_TYPE) $(PROVIDER)
infra-validate-config: ## Validate configuration for all environments
@echo "Validating configuration..."
$(SCRIPTS_DIR)/validate-config.sh $(ENVIRONMENT_FILE)
infra-test-prereq: ## Test system prerequisites for development
@echo "Testing prerequisites..."
$(INFRA_TESTS_DIR)/test-unit-infrastructure.sh vm-prereq
infra-test-ci: ## Run infrastructure-only CI tests (no global concerns)
@echo "Running infrastructure-only CI tests..."
$(INFRA_TESTS_DIR)/test-unit-config.sh
$(INFRA_TESTS_DIR)/test-unit-scripts.sh
infra-test-local: ## Run local-only infrastructure tests (requires virtualization)
@echo "Running local-only infrastructure tests..."
$(INFRA_TESTS_DIR)/test-local.sh
# =============================================================================
# APPLICATION LAYER (BUILD + RELEASE + RUN STAGES)
# =============================================================================
app-config: ## Generate application configuration for environment (Release stage preparation)
@echo "Generating application configuration for environment: $(ENVIRONMENT_FILE)..."
@if [ -z "$(ENVIRONMENT_FILE)" ]; then \
echo "❌ Error: ENVIRONMENT_FILE parameter is required"; \
echo "Usage: make app-config ENVIRONMENT_FILE=staging-hetzner"; \
echo "Available environments:"; \
ls infrastructure/config/environments/*.env 2>/dev/null | \
xargs -I {} basename {} .env | sed 's/^/ /' || \
echo " No environments found - generate with make infra-config"; \
exit 1; \
fi
application/scripts/configure-app.sh $(ENVIRONMENT_FILE)
app-validate-config: ## Validate application configuration for environment
@echo "Validating application configuration for environment: $(ENVIRONMENT_FILE)..."
@if [ -z "$(ENVIRONMENT_FILE)" ]; then \
echo "❌ Error: ENVIRONMENT_FILE parameter is required"; \
echo "Usage: make app-validate-config ENVIRONMENT_FILE=staging-hetzner"; \
echo "Available environments:"; \
find infrastructure/config/environments/ -name "*.env" -exec basename {} .env \; 2>/dev/null | sort || true; \
exit 1; \
fi
application/scripts/configure-app.sh --validate $(ENVIRONMENT_FILE)
app-deploy: ## Deploy application (Twelve-Factor Build + Release + Run stages)
@echo "Deploying application for $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)..."
@if [ "$(SKIP_WAIT)" = "true" ]; then \
echo "⚠️ SKIP_WAIT=true - Application will not wait for service readiness"; \
else \
echo "ℹ️ Application will wait for service readiness (use SKIP_WAIT=true to skip)"; \
fi
SKIP_WAIT=$(SKIP_WAIT) ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/deploy-app.sh $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)
app-redeploy: ## Redeploy application without infrastructure changes
@echo "Redeploying application for $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)..."
ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/deploy-app.sh $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)
app-health-check: ## Validate deployment health
@echo "Running health check for environment type: $(ENVIRONMENT_TYPE), environment file: $(ENVIRONMENT_FILE)..."
ENVIRONMENT_TYPE=$(ENVIRONMENT_TYPE) ENVIRONMENT_FILE=$(ENVIRONMENT_FILE) $(SCRIPTS_DIR)/health-check.sh $(ENVIRONMENT_TYPE)-$(ENVIRONMENT_FILE)
app-test-config: ## Test application configuration
@echo "Testing application configuration..."
$(TESTS_DIR)/test-unit-application.sh config
app-test-containers: ## Test application containers
@echo "Testing application containers..."
$(TESTS_DIR)/test-unit-application.sh containers
app-test-services: ## Test application services
@echo "Testing application services..."
$(TESTS_DIR)/test-unit-application.sh services
app-test-ci: ## Run application-only CI tests (no global concerns)
@echo "Running application-only CI tests..."
application/tests/test-ci.sh
# =============================================================================
# VM ACCESS AND DEBUGGING
# =============================================================================
vm-ssh: ## SSH into the VM
@VM_IP=$$(cd $(TERRAFORM_DIR) && tofu output -raw vm_ip 2>/dev/null) && \
if [ -n "$$VM_IP" ] && [ "$$VM_IP" != "No IP assigned yet" ]; then \
echo "Connecting to VM: $$VM_IP"; \
ssh -o StrictHostKeyChecking=no torrust@$$VM_IP; \
else \
echo "Error: VM IP not available. Run 'make infra-status' to check infrastructure."; \
exit 1; \
fi
vm-clean-ssh: ## Clean SSH known_hosts for VM (fixes host key verification warnings)
@echo "Cleaning SSH known_hosts for VM..."
@$(SCRIPTS_DIR)/ssh-utils.sh clean
vm-prepare-ssh: ## Clean SSH known_hosts and test connectivity
@echo "Preparing SSH connection to VM..."
@$(SCRIPTS_DIR)/ssh-utils.sh prepare
vm-console: ## Access VM console (text-based)
@echo "Accessing VM console..."
@virsh console $(VM_NAME) || echo "VM console not accessible. Try 'make vm-gui-console' for graphical console."
vm-gui-console: ## Access VM graphical console (requires GUI)
@echo "Opening graphical VM console..."
@virt-viewer --connect qemu:///system $(VM_NAME) &
vm-status: ## Show detailed VM status
@echo "VM Status for $(VM_NAME):"
@echo "================================"
@virsh domstate $(VM_NAME) 2>/dev/null || echo "VM not found"
@virsh dominfo $(VM_NAME) 2>/dev/null | grep -E "(State|Memory|CPUs)" || true
@echo ""
@echo "Network Info:"
@virsh domifaddr $(VM_NAME) 2>/dev/null || echo "No network info available"
@echo ""
@echo "Terraform State:"
@cd $(TERRAFORM_DIR) && tofu output 2>/dev/null || echo "No Terraform state found"
# =============================================================================
# QUICK DEVELOPMENT WORKFLOWS
# =============================================================================
dev-setup: ## Complete development setup
@echo "Setting up development environment..."
@make install-deps
dev-deploy: ## Full deployment workflow (infra + app)
@echo "Running full deployment workflow for $(DEV_ENVIRONMENT) with $(DEV_PROVIDER)..."
@make infra-apply ENVIRONMENT=$(DEV_ENVIRONMENT) PROVIDER=$(DEV_PROVIDER)
@make app-deploy ENVIRONMENT=$(DEV_ENVIRONMENT)
@make app-health-check ENVIRONMENT=$(DEV_ENVIRONMENT)
@echo "✅ Development deployment complete"
dev-test: ## Quick validation (syntax + unit tests)
@echo "Running quick validation tests..."
@make lint
@make test-unit
@echo "✅ Quick tests passed"
dev-clean: ## Complete cleanup
@echo "Cleaning up development environment..."
@make infra-destroy ENVIRONMENT=$(DEV_ENVIRONMENT) PROVIDER=$(DEV_PROVIDER) || true
@make clean
@echo "✅ Development environment cleaned"
# =============================================================================
# GLOBAL TESTING AND QUALITY ASSURANCE
# =============================================================================
test-e2e: ## Run comprehensive end-to-end test (follows integration guide)
@echo "Running comprehensive end-to-end test..."
$(TESTS_DIR)/test-e2e.sh $(DEV_ENVIRONMENT)
test-ci: ## Run project-wide CI tests (global concerns)
@echo "Running project-wide CI tests..."
@echo "1. Global concerns (syntax, structure, Makefile)..."
tests/test-ci.sh
@echo "2. Infrastructure layer tests..."
@make infra-test-ci
@echo "3. Application layer tests..."
@make app-test-ci
@echo "✅ All CI tests passed!"
test-unit: ## Run unit tests (configuration, scripts, syntax)
@echo "Running unit tests..."
@echo "1. Configuration and syntax validation..."
$(INFRA_TESTS_DIR)/test-unit-config.sh
@echo "2. Infrastructure scripts validation..."
$(INFRA_TESTS_DIR)/test-unit-scripts.sh
lint: ## Run syntax validation only
@echo "Running syntax validation..."
./scripts/lint.sh
clean: ## Clean up temporary files and caches
@echo "Cleaning up..."
@rm -rf $(TERRAFORM_DIR)/.terraform
@rm -f $(TERRAFORM_DIR)/terraform.tfstate.backup
@echo "Clean completed"