feat: add configurable SSH port to Environment struct

- Add ssh_port: u16 field to Environment<S> struct after ssh_credentials
- Update Environment::new constructor to accept ssh_port parameter (3 args)
- Add ssh_port() getter method for accessing the field
- Make DEFAULT_SSH_PORT constant public and re-export from ssh module
- Update all three E2E binaries to import and use DEFAULT_SSH_PORT
- Update render_ansible_templates in provision.rs to accept ssh_port
- Update container start method to accept ssh_port parameter
- Update all Environment::new calls throughout codebase with ssh_port
- Fix all doc tests to include ssh_port parameter

This change enables configurable SSH port across the deployment system
while maintaining backward compatibility with default port 22.

Author: josecelano

src/application/commands/provision.rs

@@ -284,7 +284,8 @@ impl ProvisionCommand {
         let instance_ip = instance_info.ip_address;
 
         let current_step = ProvisionStep::RenderAnsibleTemplates;
-        self.render_ansible_templates(ssh_credentials, instance_ip)
+        let ssh_port = environment.ssh_port();
+        self.render_ansible_templates(ssh_credentials, instance_ip, ssh_port)
             .await
             .map_err(|e| (e, current_step))?;
 
@@ -363,8 +364,9 @@ impl ProvisionCommand {
         &self,
         ssh_credentials: &SshCredentials,
         instance_ip: IpAddr,
+        ssh_port: u16,
     ) -> Result<(), ProvisionCommandError> {
-        let socket_addr = std::net::SocketAddr::new(instance_ip, 22); // Default SSH port for VMs
+        let socket_addr = std::net::SocketAddr::new(instance_ip, ssh_port);
         RenderAnsibleTemplatesStep::new(
             Arc::clone(&self.ansible_template_renderer),
             ssh_credentials.clone(),

src/bin/e2e_config_tests.rs

@@ -75,7 +75,10 @@ use torrust_tracker_deploy::e2e::tasks::{
     run_configuration_validation::run_configuration_validation,
 };
 use torrust_tracker_deploy::logging::{self, LogFormat};
-use torrust_tracker_deploy::shared::{ssh::SshCredentials, Username};
+use torrust_tracker_deploy::shared::{
+    ssh::{SshCredentials, DEFAULT_SSH_PORT},
+    Username,
+};
 
 #[derive(Parser)]
 #[command(name = "e2e-config-tests")]
@@ -137,7 +140,8 @@ pub async fn main() -> Result<()> {
         ssh_user.clone(),
     );
 
-    let environment = Environment::new(env_name, ssh_credentials);
+    let ssh_port = DEFAULT_SSH_PORT;
+    let environment = Environment::new(env_name, ssh_credentials, ssh_port);
 
     // Create and initialize TestContext
     let test_context =

src/bin/e2e_provision_tests.rs

@@ -60,7 +60,10 @@ use torrust_tracker_deploy::e2e::tasks::virtual_machine::{
     run_provision_command::run_provision_command,
 };
 use torrust_tracker_deploy::logging::{self, LogFormat};
-use torrust_tracker_deploy::shared::{ssh::SshCredentials, Username};
+use torrust_tracker_deploy::shared::{
+    ssh::{SshCredentials, DEFAULT_SSH_PORT},
+    Username,
+};
 
 #[derive(Parser)]
 #[command(name = "e2e-provision-tests")]
@@ -131,7 +134,8 @@ pub async fn main() -> Result<()> {
         ssh_user.clone(),
     );
 
-    let environment = Environment::new(environment_name, ssh_credentials);
+    let ssh_port = DEFAULT_SSH_PORT;
+    let environment = Environment::new(environment_name, ssh_credentials, ssh_port);
 
     let test_context =
         TestContext::from_environment(cli.keep, environment, TestContextType::VirtualMachine)?

src/bin/e2e_tests_full.rs

@@ -72,7 +72,10 @@ use torrust_tracker_deploy::e2e::tasks::{
     },
 };
 use torrust_tracker_deploy::logging::{self, LogFormat};
-use torrust_tracker_deploy::shared::{ssh::SshCredentials, Username};
+use torrust_tracker_deploy::shared::{
+    ssh::{SshCredentials, DEFAULT_SSH_PORT},
+    Username,
+};
 
 #[derive(Parser)]
 #[command(name = "e2e-tests")]
@@ -138,7 +141,8 @@ pub async fn main() -> Result<()> {
         ssh_user.clone(),
     );
 
-    let environment = Environment::new(environment_name, ssh_credentials);
+    let ssh_port = DEFAULT_SSH_PORT;
+    let environment = Environment::new(environment_name, ssh_credentials, ssh_port);
 
     let test_context =
         TestContext::from_environment(cli.keep, environment, TestContextType::VirtualMachine)?

src/domain/environment/mod.rs

@@ -35,7 +35,7 @@
 //!     PathBuf::from("fixtures/testing_rsa.pub"),
 //!     ssh_username,
 //! );
-//! let environment = Environment::new(env_name, ssh_credentials);
+//! let environment = Environment::new(env_name, ssh_credentials, 22);
 //!
 //! // Environment automatically generates paths
 //! assert_eq!(*environment.data_dir(), PathBuf::from("data/e2e-config"));
@@ -120,6 +120,9 @@ pub struct Environment<S = Created> {
     /// SSH credentials for connecting to instances in this environment
     ssh_credentials: SshCredentials,
 
+    /// SSH port for connecting to instances in this environment
+    ssh_port: u16,
+
     /// Build directory for this environment (auto-generated)
     build_dir: PathBuf,
 
@@ -144,6 +147,7 @@ impl Environment {
     ///
     /// * `name` - The validated environment name
     /// * `ssh_credentials` - SSH credentials for connecting to instances
+    /// * `ssh_port` - SSH port for connecting to instances
     ///
     /// # Returns
     ///
@@ -164,7 +168,8 @@ impl Environment {
     ///     PathBuf::from("keys/prod_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let ssh_port = 22;
+    /// let environment = Environment::new(env_name, ssh_credentials, ssh_port);
     ///
     /// assert_eq!(environment.instance_name().as_str(), "torrust-tracker-vm-production");
     /// assert_eq!(*environment.data_dir(), PathBuf::from("data/production"));
@@ -178,7 +183,11 @@ impl Environment {
     /// This function does not panic. All instance name generation is guaranteed
     /// to succeed for valid environment names.
     #[must_use]
-    pub fn new(name: EnvironmentName, ssh_credentials: SshCredentials) -> Environment<Created> {
+    pub fn new(
+        name: EnvironmentName,
+        ssh_credentials: SshCredentials,
+        ssh_port: u16,
+    ) -> Environment<Created> {
         let env_str = name.as_str();
 
         // Generate instance name: torrust-tracker-vm-{env_name}
@@ -200,6 +209,7 @@ impl Environment {
             instance_name,
             profile_name,
             ssh_credentials,
+            ssh_port,
             build_dir,
             data_dir,
             instance_ip: None,
@@ -245,6 +255,7 @@ impl<S> Environment<S> {
             instance_name: self.instance_name,
             profile_name: self.profile_name,
             ssh_credentials: self.ssh_credentials,
+            ssh_port: self.ssh_port,
             build_dir: self.build_dir,
             data_dir: self.data_dir,
             instance_ip: self.instance_ip,
@@ -298,6 +309,12 @@ impl<S> Environment<S> {
         &self.ssh_credentials
     }
 
+    /// Returns the SSH port for this environment
+    #[must_use]
+    pub fn ssh_port(&self) -> u16 {
+        self.ssh_port
+    }
+
     /// Returns the SSH username for this environment
     #[must_use]
     pub fn ssh_username(&self) -> &Username {
@@ -353,7 +370,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/test_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// // Before provisioning
     /// assert_eq!(environment.instance_ip(), None);
@@ -398,7 +415,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/prod_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// // Set IP after provisioning
     /// let ip = IpAddr::V4(Ipv4Addr::new(10, 0, 0, 42));
@@ -433,7 +450,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/staging_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// assert_eq!(
     ///     environment.templates_dir(),
@@ -466,7 +483,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/prod_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// assert_eq!(
     ///     environment.traces_dir(),
@@ -496,7 +513,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/dev_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// assert_eq!(
     ///     environment.ansible_build_dir(),
@@ -526,7 +543,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/test_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// assert_eq!(
     ///     environment.tofu_build_dir(),
@@ -556,7 +573,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/integration_rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// assert_eq!(
     ///     environment.ansible_templates_dir(),
@@ -586,7 +603,7 @@ impl<S> Environment<S> {
     ///     PathBuf::from("keys/load-test-rsa.pub"),
     ///     ssh_username,
     /// );
-    /// let environment = Environment::new(env_name, ssh_credentials);
+    /// let environment = Environment::new(env_name, ssh_credentials, 22);
     ///
     /// assert_eq!(
     ///     environment.tofu_templates_dir(),
@@ -688,7 +705,9 @@ mod tests {
                 ssh_username,
             );
 
-            Environment::new(env_name, ssh_credentials)
+            let ssh_port = 22;
+
+            Environment::new(env_name, ssh_credentials, ssh_port)
         }
 
         /// Builds an Environment and returns the `TempDir`
@@ -707,7 +726,8 @@ mod tests {
                 ssh_username,
             );
 
-            let environment = Environment::new(env_name, ssh_credentials);
+            let ssh_port = 22;
+            let environment = Environment::new(env_name, ssh_credentials, ssh_port);
             (environment, self.temp_dir)
         }
 
@@ -737,6 +757,7 @@ mod tests {
                 instance_name,
                 profile_name,
                 ssh_credentials,
+                ssh_port: 22,
                 data_dir: data_dir.clone(),
                 build_dir: build_dir.clone(),
                 instance_ip: None,

src/domain/environment/state/configure_failed.rs

@@ -164,7 +164,7 @@ mod tests {
         fn create_test_environment_configure_failed() -> Environment<ConfigureFailed> {
             let name = EnvironmentName::new("test-env".to_string()).unwrap();
             let ssh_creds = create_test_ssh_credentials();
-            Environment::new(name, ssh_creds)
+            Environment::new(name, ssh_creds, 22)
                 .start_provisioning()
                 .provisioned()
                 .start_configuring()

src/domain/environment/state/configured.rs

@@ -90,7 +90,7 @@ mod tests {
         fn create_test_environment_configured() -> Environment<Configured> {
             let name = EnvironmentName::new("test-env".to_string()).unwrap();
             let ssh_creds = create_test_ssh_credentials();
-            Environment::new(name, ssh_creds)
+            Environment::new(name, ssh_creds, 22)
                 .start_provisioning()
                 .provisioned()
                 .start_configuring()
@@ -129,7 +129,7 @@ mod tests {
                 PathBuf::from("test_key.pub"),
                 ssh_username,
             );
-            Environment::new(env_name, ssh_credentials)
+            Environment::new(env_name, ssh_credentials, 22)
                 .start_provisioning()
                 .provisioned()
                 .start_configuring()

src/domain/environment/state/configuring.rs

@@ -107,7 +107,7 @@ mod tests {
         fn create_test_environment_configuring() -> Environment<Configuring> {
             let name = EnvironmentName::new("test-env".to_string()).unwrap();
             let ssh_creds = create_test_ssh_credentials();
-            Environment::new(name, ssh_creds)
+            Environment::new(name, ssh_creds, 22)
                 .start_provisioning()
                 .provisioned()
                 .start_configuring()
@@ -145,7 +145,7 @@ mod tests {
                 PathBuf::from("test_key.pub"),
                 ssh_username,
             );
-            Environment::new(env_name, ssh_credentials)
+            Environment::new(env_name, ssh_credentials, 22)
                 .start_provisioning()
                 .provisioned()
                 .start_configuring()

src/domain/environment/state/created.rs

@@ -112,7 +112,7 @@ mod tests {
         fn create_test_environment_created() -> Environment<Created> {
             let name = EnvironmentName::new("test-env".to_string()).unwrap();
             let ssh_creds = create_test_ssh_credentials();
-            Environment::new(name, ssh_creds)
+            Environment::new(name, ssh_creds, 22)
         }
 
         #[test]
@@ -176,7 +176,7 @@ mod tests {
         fn create_test_environment_created() -> Environment<Created> {
             let name = EnvironmentName::new("test-env".to_string()).unwrap();
             let ssh_creds = create_test_ssh_credentials();
-            Environment::new(name, ssh_creds)
+            Environment::new(name, ssh_creds, 22)
         }
 
         #[test]

src/domain/environment/state/destroyed.rs

@@ -77,7 +77,7 @@ mod tests {
         fn create_test_environment_destroyed() -> Environment<Destroyed> {
             let name = EnvironmentName::new("test-env".to_string()).unwrap();
             let ssh_creds = create_test_ssh_credentials();
-            Environment::new(name, ssh_creds).destroy()
+            Environment::new(name, ssh_creds, 22).destroy()
         }
 
         #[test]