refactor: move SSH module from infrastructure/adapters to shared

josecelano · josecelano · commit 1e30ad6e40b2 · 2025-09-24T16:07:48.000+01:00
- Move SSH module from src/infrastructure/adapters/ssh to src/shared/ssh
- Update all import statements throughout codebase to use new shared location
- Update module references in config, application commands, steps, and e2e tests
- Update documentation examples within SSH module files
- Remove SSH module from infrastructure/adapters module exports
- All linters, unit tests, and e2e tests pass successfully

This enables SSH module reuse across different parts of the application including e2e tests.
diff --git a/src/application/commands/provision.rs b/src/application/commands/provision.rs
@@ -27,10 +27,10 @@ use crate::infrastructure::adapters::ansible::AnsibleClient;
 #[allow(unused_imports)]
 use crate::infrastructure::adapters::lxd::InstanceName;
 use crate::infrastructure::adapters::opentofu::client::{InstanceInfo, OpenTofuError};
-use crate::infrastructure::adapters::ssh::{credentials::SshCredentials, SshError};
 use crate::infrastructure::ansible::AnsibleTemplateRenderer;
 use crate::infrastructure::executor::CommandError;
 use crate::infrastructure::tofu::{ProvisionTemplateError, TofuTemplateRenderer};
+use crate::shared::ssh::{credentials::SshCredentials, SshError};
 
 /// Comprehensive error type for the `ProvisionCommand`
 #[derive(Debug, thiserror::Error)]
diff --git a/src/application/commands/test.rs b/src/application/commands/test.rs
@@ -20,9 +20,9 @@ use crate::application::steps::{
     ValidateDockerComposeInstallationStep,
     ValidateDockerInstallationStep,
 };
-use crate::infrastructure::adapters::ssh::credentials::SshCredentials;
 use crate::infrastructure::executor::CommandError;
 use crate::infrastructure::remote_actions::RemoteActionError;
+use crate::shared::ssh::credentials::SshCredentials;
 
 /// Comprehensive error type for the `TestCommand`
 #[derive(Debug, thiserror::Error)]
diff --git a/src/application/steps/connectivity/wait_ssh_connectivity.rs b/src/application/steps/connectivity/wait_ssh_connectivity.rs
@@ -20,7 +20,7 @@
 
 use tracing::{info, instrument};
 
-use crate::infrastructure::adapters::ssh::{SshClient, SshConnection, SshError};
+use crate::shared::ssh::{SshClient, SshConnection, SshError};
 
 /// Step that waits for SSH connectivity to be established on a remote host
 pub struct WaitForSSHConnectivityStep {
@@ -78,7 +78,7 @@ impl WaitForSSHConnectivityStep {
 mod tests {
     use std::net::{IpAddr, Ipv4Addr};
 
-    use crate::infrastructure::adapters::ssh::SshCredentials;
+    use crate::shared::ssh::SshCredentials;
 
     use super::*;
 
diff --git a/src/application/steps/rendering/ansible_templates.rs b/src/application/steps/rendering/ansible_templates.rs
@@ -24,13 +24,13 @@ use std::sync::Arc;
 use thiserror::Error;
 use tracing::{info, instrument};
 
-use crate::infrastructure::adapters::ssh::credentials::SshCredentials;
 use crate::infrastructure::ansible::template::renderer::ConfigurationTemplateError;
 use crate::infrastructure::ansible::AnsibleTemplateRenderer;
 use crate::infrastructure::template::wrappers::ansible::inventory::{
     AnsibleHost, AnsiblePort, AnsiblePortError, InventoryContext, InventoryContextError,
     SshPrivateKeyFile, SshPrivateKeyFileError,
 };
+use crate::shared::ssh::credentials::SshCredentials;
 
 /// Errors that can occur during Ansible template rendering step execution
 #[derive(Error, Debug)]
diff --git a/src/application/steps/validation/cloud_init.rs b/src/application/steps/validation/cloud_init.rs
@@ -20,8 +20,8 @@
 
 use tracing::{info, instrument};
 
-use crate::infrastructure::adapters::ssh::SshConnection;
 use crate::infrastructure::remote_actions::{CloudInitValidator, RemoteAction, RemoteActionError};
+use crate::shared::ssh::SshConnection;
 
 /// Step that validates cloud-init completion on a remote host
 pub struct ValidateCloudInitCompletionStep {
@@ -74,7 +74,7 @@ mod tests {
     use std::net::{IpAddr, Ipv4Addr};
     use std::path::PathBuf;
 
-    use crate::infrastructure::adapters::ssh::SshCredentials;
+    use crate::shared::ssh::SshCredentials;
 
     use super::*;
 
diff --git a/src/application/steps/validation/docker.rs b/src/application/steps/validation/docker.rs
@@ -19,8 +19,8 @@
 
 use tracing::{info, instrument};
 
-use crate::infrastructure::adapters::ssh::SshConnection;
 use crate::infrastructure::remote_actions::{DockerValidator, RemoteAction, RemoteActionError};
+use crate::shared::ssh::SshConnection;
 
 /// Step that validates Docker installation on a remote host
 pub struct ValidateDockerInstallationStep {
@@ -73,7 +73,7 @@ mod tests {
     use std::net::{IpAddr, Ipv4Addr};
     use std::path::PathBuf;
 
-    use crate::infrastructure::adapters::ssh::SshCredentials;
+    use crate::shared::ssh::SshCredentials;
 
     use super::*;
 
diff --git a/src/application/steps/validation/docker_compose.rs b/src/application/steps/validation/docker_compose.rs
@@ -20,10 +20,10 @@
 
 use tracing::{info, instrument};
 
-use crate::infrastructure::adapters::ssh::SshConnection;
 use crate::infrastructure::remote_actions::{
     DockerComposeValidator, RemoteAction, RemoteActionError,
 };
+use crate::shared::ssh::SshConnection;
 
 /// Step that validates Docker Compose installation on a remote host
 pub struct ValidateDockerComposeInstallationStep {
@@ -79,7 +79,7 @@ mod tests {
     use std::net::{IpAddr, Ipv4Addr};
     use std::path::PathBuf;
 
-    use crate::infrastructure::adapters::ssh::SshCredentials;
+    use crate::shared::ssh::SshCredentials;
 
     use super::*;
 
diff --git a/src/config/mod.rs b/src/config/mod.rs
@@ -17,7 +17,7 @@
 use std::path::PathBuf;
 
 pub use crate::infrastructure::adapters::lxd::InstanceName;
-pub use crate::infrastructure::adapters::ssh::{SshConnection, SshCredentials};
+pub use crate::shared::ssh::{SshConnection, SshCredentials};
 
 /// Configuration parameters for deployment environments.
 ///
diff --git a/src/e2e/containers/actions/mod.rs b/src/e2e/containers/actions/mod.rs
@@ -20,7 +20,7 @@
 //!
 //! ```rust,no_run
 //! use torrust_tracker_deploy::e2e::containers::{ContainerExecutor, actions::{SshKeySetupAction, SshWaitAction}};
-//! use torrust_tracker_deploy::infrastructure::adapters::ssh::SshCredentials;
+//! use torrust_tracker_deploy::shared::ssh::SshCredentials;
 //! use std::time::Duration;
 //!
 //! fn setup_container_ssh<T: ContainerExecutor>(
diff --git a/src/e2e/containers/actions/ssh_key_setup.rs b/src/e2e/containers/actions/ssh_key_setup.rs
@@ -9,7 +9,7 @@ use testcontainers::core::ExecCommand;
 use tracing::info;
 
 use crate::e2e::containers::ContainerExecutor;
-use crate::infrastructure::adapters::ssh::SshCredentials;
+use crate::shared::ssh::SshCredentials;
 
 /// Specific error types for SSH key setup operations
 #[derive(Debug, thiserror::Error)]
@@ -89,7 +89,7 @@ pub type Result<T> = std::result::Result<T, SshKeySetupError>;
 ///
 /// ```rust,no_run
 /// use torrust_tracker_deploy::e2e::containers::{ContainerExecutor, actions::SshKeySetupAction};
-/// use torrust_tracker_deploy::infrastructure::adapters::ssh::SshCredentials;
+/// use torrust_tracker_deploy::shared::ssh::SshCredentials;
 ///
 /// fn setup_ssh<T: ContainerExecutor>(
 ///     container: &T,
diff --git a/src/e2e/containers/provisioned.rs b/src/e2e/containers/provisioned.rs
@@ -23,7 +23,7 @@
 //!     StoppedProvisionedContainer, ProvisionedContainerError,
 //!     actions::{SshWaitAction, SshKeySetupAction}
 //! };
-//! use torrust_tracker_deploy::infrastructure::adapters::ssh::SshCredentials;
+//! use torrust_tracker_deploy::shared::ssh::SshCredentials;
 //! use std::path::PathBuf;
 //! use std::time::Duration;
 //!
diff --git a/src/infrastructure/adapters/mod.rs b/src/infrastructure/adapters/mod.rs
@@ -12,19 +12,16 @@
 //! - `ansible` - Ansible playbook execution and configuration management
 //! - `lxd` - LXD container/VM management and operations  
 //! - `opentofu` - OpenTofu/Terraform infrastructure provisioning
-//! - `ssh` - SSH connectivity and remote command execution
 //!
 //! All adapters follow consistent patterns for error handling, logging, and configuration.
 
 pub mod ansible;
 pub mod lxd;
 pub mod opentofu;
-pub mod ssh;
 
 // Re-export public types for external use
 pub use ansible::AnsibleClient;
 pub use lxd::{InstanceInfo as LxdInstanceInfo, InstanceName, LxdClient};
 pub use opentofu::{
     InstanceInfo as OpenTofuInstanceInfo, OpenTofuClient, OpenTofuError, ParseError,
 };
-pub use ssh::{SshClient, SshError};
diff --git a/src/infrastructure/remote_actions/cloud_init.rs b/src/infrastructure/remote_actions/cloud_init.rs
@@ -20,9 +20,9 @@
 use std::net::IpAddr;
 use tracing::{info, instrument};
 
-use crate::infrastructure::adapters::ssh::SshClient;
-use crate::infrastructure::adapters::ssh::SshConnection;
 use crate::infrastructure::remote_actions::{RemoteAction, RemoteActionError};
+use crate::shared::ssh::SshClient;
+use crate::shared::ssh::SshConnection;
 
 /// Action that checks if cloud-init has completed successfully on the server
 pub struct CloudInitValidator {
diff --git a/src/infrastructure/remote_actions/docker.rs b/src/infrastructure/remote_actions/docker.rs
@@ -24,9 +24,9 @@
 use std::net::IpAddr;
 use tracing::{info, instrument, warn};
 
-use crate::infrastructure::adapters::ssh::SshClient;
-use crate::infrastructure::adapters::ssh::SshConnection;
 use crate::infrastructure::remote_actions::{RemoteAction, RemoteActionError};
+use crate::shared::ssh::SshClient;
+use crate::shared::ssh::SshConnection;
 
 /// Action that validates Docker installation and daemon status on the server
 pub struct DockerValidator {
diff --git a/src/infrastructure/remote_actions/docker_compose.rs b/src/infrastructure/remote_actions/docker_compose.rs
@@ -25,9 +25,9 @@
 use std::net::IpAddr;
 use tracing::{info, instrument, warn};
 
-use crate::infrastructure::adapters::ssh::SshClient;
-use crate::infrastructure::adapters::ssh::SshConnection;
 use crate::infrastructure::remote_actions::{RemoteAction, RemoteActionError};
+use crate::shared::ssh::SshClient;
+use crate::shared::ssh::SshConnection;
 
 /// Action that validates Docker Compose installation and basic functionality on the server
 pub struct DockerComposeValidator {
diff --git a/src/infrastructure/tofu/template/renderer/cloud_init.rs b/src/infrastructure/tofu/template/renderer/cloud_init.rs
@@ -21,7 +21,7 @@
 //! # use std::path::Path;
 //! # use torrust_tracker_deploy::infrastructure::tofu::template::renderer::cloud_init::CloudInitTemplateRenderer;
 //! # use torrust_tracker_deploy::domain::template::TemplateManager;
-//! # use torrust_tracker_deploy::infrastructure::adapters::ssh::credentials::SshCredentials;
+//! # use torrust_tracker_deploy::shared::ssh::credentials::SshCredentials;
 //! # use std::path::PathBuf;
 //! #
 //! # #[tokio::main]
@@ -46,10 +46,10 @@ use thiserror::Error;
 
 use crate::domain::template::file::File;
 use crate::domain::template::{TemplateManager, TemplateManagerError};
-use crate::infrastructure::adapters::ssh::credentials::SshCredentials;
 use crate::infrastructure::template::wrappers::tofu::lxd::cloud_init::{
     CloudInitContext, CloudInitTemplate,
 };
+use crate::shared::ssh::credentials::SshCredentials;
 
 /// Errors that can occur during cloud-init template rendering
 #[derive(Error, Debug)]
diff --git a/src/infrastructure/tofu/template/renderer/mod.rs b/src/infrastructure/tofu/template/renderer/mod.rs
@@ -47,13 +47,13 @@ use thiserror::Error;
 use crate::domain::template::{TemplateManager, TemplateManagerError};
 #[allow(unused_imports)]
 use crate::infrastructure::adapters::lxd::instance::InstanceName;
-use crate::infrastructure::adapters::ssh::credentials::SshCredentials;
 use crate::infrastructure::template::wrappers::tofu::lxd::variables::{
     VariablesContextBuilder, VariablesTemplate, VariablesTemplateError,
 };
 use crate::infrastructure::tofu::template::renderer::cloud_init::{
     CloudInitTemplateError, CloudInitTemplateRenderer,
 };
+use crate::shared::ssh::credentials::SshCredentials;
 
 /// Errors that can occur during provision template rendering
 #[derive(Error, Debug)]
diff --git a/src/lib.rs b/src/lib.rs
@@ -22,6 +22,7 @@
 //! - `container` - Service container for dependency injection
 //! - `e2e` - End-to-end testing utilities
 //! - `logging` - Logging configuration and utilities
+//! - `shared` - Shared modules used across different layers
 
 pub mod application;
 pub mod config;
@@ -30,3 +31,4 @@ pub mod domain;
 pub mod e2e;
 pub mod infrastructure;
 pub mod logging;
+pub mod shared;
diff --git a/src/shared/mod.rs b/src/shared/mod.rs
@@ -0,0 +1,7 @@
+//! Shared modules used across different parts of the application
+//!
+//! This module contains commonly used functionality that can be shared
+//! between different layers of the application, including infrastructure,
+//! e2e tests, and other components.
+
+pub mod ssh;
diff --git a/src/shared/ssh/client.rs b/src/shared/ssh/client.rs
diff --git a/src/shared/ssh/connection.rs b/src/shared/ssh/connection.rs
@@ -46,7 +46,7 @@ impl SshConnection {
     /// ```rust
     /// # use std::net::{IpAddr, Ipv4Addr};
     /// # use std::path::PathBuf;
-    /// # use torrust_tracker_deploy::infrastructure::adapters::ssh::{SshCredentials, SshConnection};
+    /// # use torrust_tracker_deploy::shared::ssh::{SshCredentials, SshConnection};
     /// let credentials = SshCredentials::new(
     ///     PathBuf::from("/home/user/.ssh/deploy_key"),
     ///     PathBuf::from("/home/user/.ssh/deploy_key.pub"),
@@ -70,7 +70,7 @@ impl SshConnection {
     /// ```rust
     /// # use std::net::{IpAddr, Ipv4Addr};
     /// # use std::path::PathBuf;
-    /// # use torrust_tracker_deploy::infrastructure::adapters::ssh::{SshCredentials, SshConnection};
+    /// # use torrust_tracker_deploy::shared::ssh::{SshCredentials, SshConnection};
     /// let credentials = SshCredentials::new(
     ///     PathBuf::from("/home/user/.ssh/deploy_key"),
     ///     PathBuf::from("/home/user/.ssh/deploy_key.pub"),
@@ -91,7 +91,7 @@ impl SshConnection {
     /// ```rust
     /// # use std::net::{IpAddr, Ipv4Addr};
     /// # use std::path::PathBuf;
-    /// # use torrust_tracker_deploy::infrastructure::adapters::ssh::{SshCredentials, SshConnection};
+    /// # use torrust_tracker_deploy::shared::ssh::{SshCredentials, SshConnection};
     /// let credentials = SshCredentials::new(
     ///     PathBuf::from("/home/user/.ssh/deploy_key"),
     ///     PathBuf::from("/home/user/.ssh/deploy_key.pub"),
diff --git a/src/shared/ssh/credentials.rs b/src/shared/ssh/credentials.rs
@@ -50,7 +50,7 @@ impl SshCredentials {
     ///
     /// ```rust
     /// # use std::path::PathBuf;
-    /// # use torrust_tracker_deploy::infrastructure::adapters::ssh::SshCredentials;
+    /// # use torrust_tracker_deploy::shared::ssh::SshCredentials;
     /// let credentials = SshCredentials::new(
     ///     PathBuf::from("/home/user/.ssh/deploy_key"),
     ///     PathBuf::from("/home/user/.ssh/deploy_key.pub"),
diff --git a/src/shared/ssh/mod.rs b/src/shared/ssh/mod.rs
