lucasacchi/laboratori-cloud
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
54d42584aa9dfb8f0d453cb2af93f286b1ee7f75
laboratori-cloud/.planning/phases/01-setup-git-foundation/01-01-SUMMARY.md
Luca Sacchi Ricciardi 8eae198624 docs(01-01): complete Docker validation scripts plan 
- Created 3 bash scripts (check-env.sh, validate-compose.sh, reset-env.sh)
- All scripts follow CLAUDE.md standards with proper headers and exit codes
- Total: 491 lines of bash scripting with color-coded output
- Marked 5 requirements complete (SETUP-01 through SETUP-04, INF-05)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-24 19:53:40 +01:00

5.2 KiB
Raw Blame History

phase, plan, subsystem, tags, depends_on, provides, affects, tech_stack, key_files, decisions, metrics
phase plan subsystem tags depends_on provides affects tech_stack key_files decisions metrics
01-setup-git-foundation 01 scripts
docker
validation
environment
setup
environment-verification
compose-validation
environment-cleanup
labs-startup
student-onboarding
added patterns
bash-scripting
docker-cli
docker-compose-cli
idiomatic-bash
color-output
exit-code-handling
created modified
path size_lines purpose
scripts/check-env.sh 165 Verifies Docker environment meets course requirements
path size_lines purpose
scripts/validate-compose.sh 94 Validates docker-compose.yml files before deployment
path size_lines purpose
scripts/reset-env.sh 232 Cleans Docker environment between labs
duration_seconds completed_date tasks_completed files_created files_modified
180 2026-03-24T18:53:00Z 3 3 0

Phase 1 Plan 01: Docker Validation Scripts Summary

One-liner: Created three bash scripts for Docker environment verification, compose validation, and environment cleanup with color-coded output and proper exit codes.

Objective

Create validation scripts that verify Docker environment requirements and provide cleanup utilities for lab workflows. Students need reliable tools to verify their Docker setup meets course requirements before starting labs, and a way to reset their environment between labs.

Artifacts Created

scripts/check-env.sh (165 lines)

Purpose: Verifies Docker environment meets course requirements.

Features:

  • Docker Engine version check (>= 24.0 required)
  • Docker Compose V2 detection (not legacy docker-compose)
  • Network utilities verification (netcat/nc, curl, iproute2)
  • System resources reporting (RAM, CPU cores)
  • Color-coded output (green pass, red fail, yellow warn)
  • Exit code 0 on success, 1 on failures

Test results:

  • PASS: Docker Engine 29.2.1 detected
  • PASS: Docker Compose V2 5.1.0 detected
  • PASS: All network utilities available
  • WARN: 15GB RAM (recommended: 16GB)

scripts/validate-compose.sh (94 lines)

Purpose: Validates docker-compose.yml files before deployment.

Features:

  • YAML syntax validation using docker compose config
  • Clear usage message when called without arguments
  • Graceful handling of missing files
  • Help flag support (-h, --help)
  • Color-coded output
  • Exit code 0 on valid config, 1 on errors

Test results:

  • PASS: Shows usage when called without arguments
  • PASS: Exits 1 when given non-existent file
  • PASS: Validates valid compose files successfully
  • PASS: Detects YAML syntax errors

scripts/reset-env.sh (232 lines)

Purpose: Cleans Docker environment between labs.

Features:

  • Interactive mode with user confirmation
  • --dry-run flag for safe preview
  • Stops all containers
  • Removes all user-created networks (preserves bridge, host, none)
  • Removes all volumes
  • Preserves Docker images
  • Clear warning messages
  • Progress reporting

Test results:

  • PASS: --dry-run shows what would be deleted
  • PASS: Default mode requires user confirmation
  • PASS: Detects and reports current environment state
  • PASS: Preserves default Docker networks

Deviations from Plan

Rule 1 - Bug: Fixed set -e causing premature exit in check-env.sh

Found during: Task 1 execution

Issue: The script used set -e which caused it to exit when command substitutions encountered expected failures (like docker compose version when checking for V2).

Fix: Removed set -e and handled command failures gracefully using conditional checks instead.

Files modified: scripts/check-env.sh

Commit: a60a9ab

Technical Decisions

  1. Color-coded output: All three scripts use ANSI color codes for better readability (green for success, red for errors, yellow for warnings).

  2. Exit code consistency: All scripts follow standard Unix conventions (0 for success, 1 for errors).

  3. Idempotency: All scripts can be run multiple times without side effects.

  4. Safety first: reset-env.sh requires confirmation by default and provides --dry-run flag for safe preview.

Cross-Verification

  • check-env.sh validates SETUP-01 (Docker >= 24.0), SETUP-02 (network utilities), SETUP-03 (resources), SETUP-04 (verification script)
  • validate-compose.sh validates INF-05 (compose validation before use)

Self-Check: PASSED

Verification steps:

  • All scripts exist in scripts/ directory and are executable (rwxrwxrwx)
  • check-env.sh accurately detects Docker Engine >= 24.0, Compose V2, and network utilities
  • validate-compose.sh catches YAML syntax errors in docker-compose.yml files
  • reset-env.sh provides safe cleanup with --dry-run flag
  • All scripts follow CLAUDE.md standards (headers, error messages, exit codes)

File existence checks:

  • FOUND: /home/luca/Sources/LucaSacchiNet/laboratori-cloud/scripts/check-env.sh
  • FOUND: /home/luca/Sources/LucaSacchiNet/laboratori-cloud/scripts/validate-compose.sh
  • FOUND: /home/luca/Sources/LucaSacchiNet/laboratori-cloud/scripts/reset-env.sh

Commit checks:

  • FOUND: a60a9ab (feat(01-01): add environment check script (check-env.sh))
  • FOUND: f9a3e1e (feat(01-01): add compose validation script (validate-compose.sh))
  • FOUND: 9b90ed2 (feat(01-01): add environment reset script (reset-env.sh))
Reference in New Issue View Git Blame Copy Permalink