refactor: remove deprecated stage concept from codebase

josecelano · josecelano · commit f22d88f2bbab · 2025-09-16T17:22:27.000+01:00
- Remove all 'stage = "..."' fields from logging statements throughout src/
- Remove 'stages = N' fields from workflow logging
- Remove Stage N: comments as functions are now self-explanatory
- Update documentation references from 'stages' to 'workflows'
- Update template renderer comments to use 'deployment workflows' terminology
- Update template module to use 'sequential template resolution'

This aligns the codebase with the three-level architecture (commands, steps, remote actions)
documented in docs/three-level-architecture.md, removing references to the old stage concept.
diff --git a/docs/current-implementation.md b/docs/current-implementation.md
@@ -96,7 +96,7 @@ These features are fully working in the E2E test environment:
 
 ### 4. State Management
 
-- **Deployment States**: Track progression through deployment stages
+- **Deployment States**: Track progression through deployment workflow
 - **State Persistence**: Save/load state between command invocations
 - **State Validation**: Ensure commands are run in correct sequence
 - **Error Recovery**: Handle partial deployments and failures
diff --git a/docs/decisions/docker-testing-rejection.md b/docs/decisions/docker-testing-rejection.md
@@ -157,7 +157,7 @@ Despite Docker's speed advantage, the performance difference is not significant
 **Approach**: Mock Docker daemon and systemd services in Docker containers
 **Rejection Reason**: Testing mocks instead of real services provides false confidence
 
-### 2. Staged Testing Pipeline
+### 2. Sequential Testing Pipeline
 
 **Approach**: Basic tests in Docker, comprehensive tests in LXD
 **Rejection Reason**: Dual infrastructure complexity outweighs benefits; inconsistent results between environments
diff --git a/src/ansible/template_renderer.rs b/src/ansible/template_renderer.rs
@@ -1,6 +1,6 @@
 //! # Ansible Template Renderer
 //!
-//! This module handles `Ansible` template rendering for deployment stages.
+//! This module handles `Ansible` template rendering for deployment workflows.
 //! It manages the creation of build directories, copying static template files (playbooks and configs),
 //! and processing dynamic Tera templates with runtime variables (like inventory.yml.tera).
 //!
@@ -111,7 +111,7 @@ pub enum ConfigurationTemplateError {
 
 /// Renders `Ansible` configuration templates to a build directory
 ///
-/// This collaborator is responsible for preparing `Ansible` templates for deployment stages.
+/// This collaborator is responsible for preparing `Ansible` templates for deployment workflows.
 /// It handles both static files (playbooks, configuration) and dynamic Tera templates that
 /// require runtime variable substitution (inventory files with IP addresses).
 pub struct AnsibleTemplateRenderer {
@@ -174,7 +174,6 @@ impl AnsibleTemplateRenderer {
         inventory_context: &InventoryContext,
     ) -> Result<(), ConfigurationTemplateError> {
         tracing::info!(
-            stage = "configuration_rendering",
             template_type = "ansible",
             "Rendering configuration templates with variables"
         );
@@ -194,26 +193,22 @@ impl AnsibleTemplateRenderer {
             .await?;
 
         tracing::debug!(
-            stage = "configuration_rendering",
             template_type = "ansible",
             output_dir = %build_ansible_dir.display(),
             "Configuration templates rendered"
         );
         tracing::debug!(
-            stage = "configuration_rendering",
             template_type = "ansible_inventory",
             ansible_host = %inventory_context.ansible_host(),
             "Inventory rendered with IP"
         );
         tracing::debug!(
-            stage = "configuration_rendering",
             template_type = "ansible_inventory",
             ssh_key = %inventory_context.ansible_ssh_private_key_file(),
             "Inventory rendered with SSH key"
         );
 
         tracing::info!(
-            stage = "configuration_rendering",
             template_type = "ansible",
             status = "complete",
             "Configuration templates ready"
diff --git a/src/bin/e2e_tests.rs b/src/bin/e2e_tests.rs
@@ -73,7 +73,6 @@ async fn main() -> Result<()> {
         (Ok(_), Err(validation_err)) => {
             error!(
                 test_suite = "e2e_tests",
-                stage = "validation",
                 status = "failed",
                 error = %validation_err,
                 "Deployment succeeded but validation failed"
@@ -83,7 +82,6 @@ async fn main() -> Result<()> {
         (Err(deployment_err), Ok(())) => {
             error!(
                 test_suite = "e2e_tests",
-                stage = "deployment",
                 status = "failed",
                 error = %deployment_err,
                 "Deployment failed"
@@ -93,7 +91,6 @@ async fn main() -> Result<()> {
         (Err(deployment_err), Err(_)) => {
             error!(
                 test_suite = "e2e_tests",
-                stage = "deployment",
                 status = "failed",
                 error = %deployment_err,
                 "Deployment failed (validation skipped)"
@@ -116,21 +113,14 @@ async fn run_full_deployment_test(env: &TestEnvironment) -> Result<IpAddr> {
     info!(
         test_type = "full_deployment",
         workflow = "template_based",
-        stages = 3,
         "Starting full deployment E2E test"
     );
 
-    // Stage 1: Provision infrastructure (includes template rendering, infrastructure creation, SSH wait, and Ansible template rendering)
     let instance_ip = provision_infrastructure(env).await?;
 
-    // Stage 2: Configure infrastructure (wait for cloud-init and install Docker/Docker Compose)
     configure_infrastructure(env)?;
 
-    info!(
-        stage = "deployment",
-        status = "success",
-        "Deployment stages completed successfully"
-    );
+    info!(status = "success", "Deployment completed successfully");
 
     info!(
         test_type = "full_deployment",
diff --git a/src/commands/configure.rs b/src/commands/configure.rs
@@ -41,7 +41,6 @@ impl ConfigureCommand {
     pub fn execute(&self) -> Result<(), ConfigureCommandError> {
         info!(
             command = "configure",
-            stage = "starting",
             "Starting complete infrastructure configuration workflow"
         );
 
@@ -51,7 +50,6 @@ impl ConfigureCommand {
 
         info!(
             command = "configure",
-            stage = "completed",
             "Infrastructure configuration completed successfully"
         );
 
diff --git a/src/commands/provision.rs b/src/commands/provision.rs
@@ -108,7 +108,6 @@ impl ProvisionCommand {
     pub async fn execute(&self) -> Result<IpAddr, ProvisionCommandError> {
         info!(
             command = "provision",
-            stage = "starting",
             "Starting complete infrastructure provisioning workflow"
         );
 
@@ -139,7 +138,6 @@ impl ProvisionCommand {
 
         info!(
             command = "provision",
-            stage = "completed",
             instance_ip = %instance_ip,
             "Infrastructure provisioning completed successfully"
         );
diff --git a/src/commands/test.rs b/src/commands/test.rs
@@ -53,7 +53,6 @@ impl TestCommand {
     pub async fn execute(&self) -> Result<(), TestCommandError> {
         info!(
             command = "test",
-            stage = "starting",
             instance_ip = %self.instance_ip,
             "Starting complete infrastructure testing workflow"
         );
@@ -74,7 +73,6 @@ impl TestCommand {
 
         info!(
             command = "test",
-            stage = "completed",
             instance_ip = %self.instance_ip,
             "Infrastructure testing workflow completed successfully"
         );
diff --git a/src/e2e/tasks/configure_infrastructure.rs b/src/e2e/tasks/configure_infrastructure.rs
@@ -13,10 +13,7 @@ use crate::e2e::environment::TestEnvironment;
 /// - `ConfigureCommand` execution fails
 /// - Infrastructure configuration fails
 pub fn configure_infrastructure(env: &TestEnvironment) -> Result<()> {
-    info!(
-        stage = "infrastructure_configuration",
-        "Configuring test infrastructure"
-    );
+    info!("Configuring test infrastructure");
 
     // Use the new ConfigureCommand to handle all infrastructure configuration steps
     let configure_command = ConfigureCommand::new(Arc::clone(&env.services.ansible_client));
@@ -27,7 +24,6 @@ pub fn configure_infrastructure(env: &TestEnvironment) -> Result<()> {
         .context("Failed to configure infrastructure")?;
 
     info!(
-        stage = "infrastructure_configuration",
         status = "complete",
         "Infrastructure configuration completed successfully"
     );
diff --git a/src/e2e/tasks/provision_infrastructure.rs b/src/e2e/tasks/provision_infrastructure.rs
@@ -15,10 +15,7 @@ use crate::e2e::environment::TestEnvironment;
 /// - Infrastructure provisioning fails
 /// - IP address cannot be obtained from `OpenTofu` outputs
 pub async fn provision_infrastructure(env: &TestEnvironment) -> Result<IpAddr> {
-    info!(
-        stage = "infrastructure_provisioning",
-        "Provisioning test infrastructure"
-    );
+    info!("Provisioning test infrastructure");
 
     // Use the new ProvisionCommand to handle all infrastructure provisioning steps
     let provision_command = ProvisionCommand::new(
@@ -36,7 +33,6 @@ pub async fn provision_infrastructure(env: &TestEnvironment) -> Result<IpAddr> {
         .context("Failed to provision infrastructure")?;
 
     info!(
-        stage = "infrastructure_provisioning",
         status = "complete",
         opentofu_ip = %opentofu_instance_ip,
         "Infrastructure provisioned successfully"
diff --git a/src/e2e/tasks/validate_deployment.rs b/src/e2e/tasks/validate_deployment.rs
@@ -13,7 +13,7 @@ use crate::e2e::environment::TestEnvironment;
 /// - `TestCommand` execution fails
 /// - Any validation check fails
 pub async fn validate_deployment(env: &TestEnvironment, instance_ip: &IpAddr) -> Result<()> {
-    info!(stage = "validation", "Starting deployment validation");
+    info!("Starting deployment validation");
 
     // Use the new TestCommand to handle all infrastructure validation steps
     let test_command = TestCommand::new(env.config.ssh_credentials.clone(), *instance_ip);
@@ -24,10 +24,6 @@ pub async fn validate_deployment(env: &TestEnvironment, instance_ip: &IpAddr) ->
         .map_err(anyhow::Error::from)
         .context("Failed to validate deployment")?;
 
-    info!(
-        stage = "validation",
-        status = "success",
-        "All deployment validations passed"
-    );
+    info!(status = "success", "All deployment validations passed");
     Ok(())
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -20,7 +20,7 @@
 //!   - `lxd` - LXD container management utilities
 //!
 //! ## Template Renderers
-//! - `ansible` - Ansible template rendering utilities for deployment stages
+//! - `ansible` - Ansible template rendering utilities for deployment workflows
 //! - `tofu` - `OpenTofu` template rendering utilities for infrastructure provisioning
 //!
 //! ## Configuration
diff --git a/src/steps/infrastructure/apply.rs b/src/steps/infrastructure/apply.rs
@@ -37,7 +37,6 @@ impl ApplyInfrastructureStep {
     pub fn execute(&self) -> Result<(), CommandError> {
         info!(
             step = "apply_infrastructure",
-            stage = 2,
             auto_approve = self.auto_approve,
             "Applying OpenTofu infrastructure"
         );
@@ -47,7 +46,6 @@ impl ApplyInfrastructureStep {
 
         info!(
             step = "apply_infrastructure",
-            stage = 2,
             status = "success",
             "OpenTofu infrastructure applied successfully"
         );
diff --git a/src/steps/infrastructure/get_instance_info.rs b/src/steps/infrastructure/get_instance_info.rs
@@ -31,7 +31,6 @@ impl GetInstanceInfoStep {
     pub fn execute(&self) -> Result<InstanceInfo, OpenTofuError> {
         info!(
             step = "get_instance_info",
-            stage = 2,
             "Getting instance information from OpenTofu outputs"
         );
 
@@ -46,7 +45,6 @@ impl GetInstanceInfoStep {
 
         info!(
             step = "get_instance_info",
-            stage = 2,
             status = "success",
             ip_address = %opentofu_instance_info.ip_address,
             instance_name = %opentofu_instance_info.name,
diff --git a/src/steps/infrastructure/initialize.rs b/src/steps/infrastructure/initialize.rs
@@ -27,7 +27,6 @@ impl InitializeInfrastructureStep {
     pub fn execute(&self) -> Result<(), CommandError> {
         info!(
             step = "initialize_infrastructure",
-            stage = 2,
             "Initializing OpenTofu infrastructure"
         );
 
@@ -36,7 +35,6 @@ impl InitializeInfrastructureStep {
 
         info!(
             step = "initialize_infrastructure",
-            stage = 2,
             status = "success",
             "OpenTofu infrastructure initialized successfully"
         );
diff --git a/src/steps/infrastructure/plan.rs b/src/steps/infrastructure/plan.rs
@@ -27,7 +27,6 @@ impl PlanInfrastructureStep {
     pub fn execute(&self) -> Result<(), CommandError> {
         info!(
             step = "plan_infrastructure",
-            stage = 2,
             "Planning OpenTofu infrastructure"
         );
 
@@ -36,7 +35,6 @@ impl PlanInfrastructureStep {
 
         info!(
             step = "plan_infrastructure",
-            stage = 2,
             status = "success",
             "OpenTofu infrastructure planned successfully"
         );
diff --git a/src/steps/rendering/ansible_templates.rs b/src/steps/rendering/ansible_templates.rs
@@ -57,7 +57,6 @@ impl RenderAnsibleTemplatesStep {
     pub async fn execute(&self) -> Result<(), RenderAnsibleTemplatesError> {
         info!(
             step = "render_ansible_templates",
-            stage = 3,
             "Rendering Ansible templates with runtime variables"
         );
 
@@ -71,7 +70,6 @@ impl RenderAnsibleTemplatesStep {
 
         info!(
             step = "render_ansible_templates",
-            stage = 3,
             status = "success",
             "Ansible templates rendered successfully"
         );
diff --git a/src/steps/rendering/opentofu_templates.rs b/src/steps/rendering/opentofu_templates.rs
@@ -26,15 +26,13 @@ impl RenderOpenTofuTemplatesStep {
     pub async fn execute(&self) -> Result<(), ProvisionTemplateError> {
         info!(
             step = "render_opentofu_templates",
-            stage = 1,
             "Rendering OpenTofu templates"
         );
 
         self.tofu_template_renderer.render().await?;
 
         info!(
             step = "render_opentofu_templates",
-            stage = 1,
             status = "success",
             "OpenTofu templates rendered successfully"
         );
diff --git a/src/steps/validation/cloud_init.rs b/src/steps/validation/cloud_init.rs
@@ -33,7 +33,6 @@ impl ValidateCloudInitCompletionStep {
     /// - Checks both cloud-init status and completion markers
     pub async fn execute(&self) -> Result<(), RemoteActionError> {
         info!(
-            stage = "validation",
             component = "cloud_init",
             "Validating cloud-init completion"
         );
diff --git a/src/steps/validation/docker.rs b/src/steps/validation/docker.rs
@@ -33,7 +33,6 @@ impl ValidateDockerInstallationStep {
     /// - The validation checks both Docker version and daemon status
     pub async fn execute(&self) -> Result<(), RemoteActionError> {
         info!(
-            stage = "validation",
             component = "docker",
             "Validating Docker installation"
         );
diff --git a/src/steps/validation/docker_compose.rs b/src/steps/validation/docker_compose.rs
@@ -33,7 +33,6 @@ impl ValidateDockerComposeInstallationStep {
     /// - The validation checks Docker Compose version and availability
     pub async fn execute(&self) -> Result<(), RemoteActionError> {
         info!(
-            stage = "validation",
             component = "docker_compose",
             "Validating Docker Compose installation"
         );
diff --git a/src/template/mod.rs b/src/template/mod.rs
@@ -1,8 +1,8 @@
 //! Template rendering system for configuration files
 //!
 //! This module provides template rendering using Tera.
-//! It supports staged template resolution where different templates are resolved
-//! at different lifecycle stages (e.g., static `OpenTofu` templates first, then
+//! It supports sequential template resolution where different templates are resolved
+//! at different points in the deployment workflow (e.g., static `OpenTofu` templates first, then
 //! dynamic Ansible templates after VMs are provisioned and their IP addresses known).
 //!
 //! ## Module Structure
diff --git a/src/tofu/template_renderer.rs b/src/tofu/template_renderer.rs
