feat: extract GetInstanceInfoStep from e2e tests

- Create new GetInstanceInfoStep in src/steps/infrastructure/get_instance_info.rs
- Extract OpenTofu instance info retrieval logic from src/bin/e2e_tests.rs
- Returns OpenTofuError directly instead of generic CommandError
- Add proper documentation with design rationale about provider consistency
- Include unit tests following project conventions
- Update module exports to include the new step
- Fix clippy documentation linting issues

Author: josecelano

docs/e2e-tests-refactoring-plan.md

@@ -164,7 +164,7 @@ ProvisionCommand:
 ├── ✅ InitializeInfrastructureStep  // tofu init - COMPLETED
 ├── ✅ PlanInfrastructureStep        // tofu plan - COMPLETED
 ├── ✅ ApplyInfrastructureStep       // tofu apply - COMPLETED
-├── GetInstanceInfoStep              // Extract IP from tofu outputs
+├── ✅ GetInstanceInfoStep           // Extract IP from tofu outputs - COMPLETED
 ├── WaitForSSHConnectivityStep       // Validate SSH access
 └── WaitForCloudInitStep             // Wait for cloud-init completion
 

src/bin/e2e_tests.rs

@@ -17,8 +17,8 @@ use torrust_tracker_deploy::actions::{
 };
 // Import steps
 use torrust_tracker_deploy::steps::{
-    ApplyInfrastructureStep, InitializeInfrastructureStep, PlanInfrastructureStep,
-    RenderAnsibleTemplatesStep, RenderOpenTofuTemplatesStep,
+    ApplyInfrastructureStep, GetInstanceInfoStep, InitializeInfrastructureStep,
+    PlanInfrastructureStep, RenderAnsibleTemplatesStep, RenderOpenTofuTemplatesStep,
 };
 
 #[derive(Parser)]
@@ -191,17 +191,11 @@ impl TestEnvironment {
             .map_err(anyhow::Error::from)
             .context("Failed to apply OpenTofu configuration")?;
 
-        // Get the instance IP from OpenTofu outputs
-        // NOTE: We prefer OpenTofu outputs over provider-specific methods because:
-        // - If we add more providers (different than LXD) in the future, we have two options:
-        //   1. Use the method that each provider provides to get the IP
-        //   2. Use OpenTofu for all of them, so the OpenTofu output has a contract with this app.
-        //      It has to return always the instance info we expect.
-        // Using OpenTofu outputs provides a consistent interface across all providers.
-        let opentofu_instance_info = self
-            .services
-            .opentofu_client
-            .get_instance_info()
+        // Get instance info using the step
+        let get_instance_info_step =
+            GetInstanceInfoStep::new(Arc::clone(&self.services.opentofu_client));
+        let opentofu_instance_info = get_instance_info_step
+            .execute()
             .map_err(anyhow::Error::from)
             .context("Failed to get container info from OpenTofu outputs")?;
 

src/steps/infrastructure/get_instance_info.rs

@@ -0,0 +1,79 @@
+use std::sync::Arc;
+
+use tracing::info;
+
+use crate::command_wrappers::opentofu::client::{InstanceInfo, OpenTofuClient, OpenTofuError};
+
+/// Simple step that retrieves instance information from `OpenTofu` outputs
+///
+/// This step gets the instance IP from `OpenTofu` outputs rather than provider-specific methods
+/// to provide a consistent interface across all providers. If we add more providers in the future,
+/// the `OpenTofu` output provides a contract that always returns the expected instance info.
+pub struct GetInstanceInfoStep {
+    opentofu_client: Arc<OpenTofuClient>,
+}
+
+impl GetInstanceInfoStep {
+    #[must_use]
+    pub fn new(opentofu_client: Arc<OpenTofuClient>) -> Self {
+        Self { opentofu_client }
+    }
+
+    /// Execute the get instance info step
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if:
+    /// * The `OpenTofu` output command fails
+    /// * The output cannot be parsed as JSON
+    /// * The `instance_info` section is missing or malformed
+    /// * The working directory does not exist or is not accessible
+    pub fn execute(&self) -> Result<InstanceInfo, OpenTofuError> {
+        info!(
+            step = "get_instance_info",
+            stage = 2,
+            "Getting instance information from OpenTofu outputs"
+        );
+
+        // Get the instance IP from OpenTofu outputs
+        // NOTE: We prefer OpenTofu outputs over provider-specific methods because:
+        // - If we add more providers (different than LXD) in the future, we have two options:
+        //   1. Use the method that each provider provides to get the IP
+        //   2. Use OpenTofu for all of them, so the OpenTofu output has a contract with this app.
+        //      It has to return always the instance info we expect.
+        // Using OpenTofu outputs provides a consistent interface across all providers.
+        let opentofu_instance_info = self.opentofu_client.get_instance_info()?;
+
+        info!(
+            step = "get_instance_info",
+            stage = 2,
+            status = "success",
+            ip_address = %opentofu_instance_info.ip_address,
+            instance_name = %opentofu_instance_info.name,
+            "Instance information retrieved successfully from OpenTofu outputs"
+        );
+
+        // Log output for debugging if needed
+        tracing::debug!(instance_info = ?opentofu_instance_info, "OpenTofu instance info");
+
+        Ok(opentofu_instance_info)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::sync::Arc;
+
+    use crate::command_wrappers::opentofu::client::OpenTofuClient;
+
+    use super::*;
+
+    #[test]
+    fn it_should_create_get_instance_info_step() {
+        let opentofu_client = Arc::new(OpenTofuClient::new("/tmp"));
+
+        let _step = GetInstanceInfoStep::new(opentofu_client);
+
+        // If we reach this point, the step was created successfully
+    }
+}

src/steps/infrastructure/mod.rs

@@ -1,7 +1,9 @@
 pub mod apply;
+pub mod get_instance_info;
 pub mod initialize;
 pub mod plan;
 
 pub use apply::ApplyInfrastructureStep;
+pub use get_instance_info::GetInstanceInfoStep;
 pub use initialize::InitializeInfrastructureStep;
 pub use plan::PlanInfrastructureStep;

src/steps/mod.rs

@@ -2,7 +2,8 @@ pub mod infrastructure;
 pub mod template;
 
 pub use infrastructure::{
-    ApplyInfrastructureStep, InitializeInfrastructureStep, PlanInfrastructureStep,
+    ApplyInfrastructureStep, GetInstanceInfoStep, InitializeInfrastructureStep,
+    PlanInfrastructureStep,
 };
 pub use template::{
     RenderAnsibleTemplatesError, RenderAnsibleTemplatesStep, RenderOpenTofuTemplatesStep,