feat!: Edition 2024; ssh2-config 0.4

Author: veeso

.github/workflows/linux.yml

@@ -18,7 +18,6 @@ jobs:
       - uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: stable
-          override: true
           components: rustfmt, clippy
       - name: Build
         run: cargo build --all-features
@@ -29,6 +28,6 @@ jobs:
       - name: Clippy
         run: cargo clippy --features find -- -Dwarnings
       - name: Run tests
-        run: cargo test --all-features --features find,github-actions,with-containers
+        run: cargo test --all-features --features find,github-actions
         env:
           RUST_LOG: trace

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 - [Changelog](#changelog)
+  - [0.6.0](#060)
   - [0.5.0](#050)
   - [0.4.1](#041)
   - [0.4.0](#040)
@@ -17,9 +18,16 @@
 
 ---
 
+## 0.6.0
+
+Released on 15/03/2025
+
+- bump `ssh2-config` to `0.4.0`
+- edition `2024`
+
 ## 0.5.0
 
-Released on 26/102/2024
+Released on 26/10/2024
 
 - `SshKeyStorage` must be `Sync` and `Send`
 

Cargo.toml

@@ -3,30 +3,30 @@ authors = ["Christian Visintin <[email protected]>"]
 categories = ["network-programming"]
 description = "remotefs SSH client library"
 documentation = "https://docs.rs/remotefs-ssh"
-edition = "2021"
+edition = "2024"
 include = ["src/**/*", "LICENSE", "README.md", "CHANGELOG.md"]
 keywords = ["remotefs", "ssh-client", "scp-client", "sftp-client"]
 license = "MIT"
 name = "remotefs-ssh"
 readme = "README.md"
 repository = "https://github.com/remotefs-rs/remotefs-rs-ssh"
-version = "0.5.0"
-rust-version = "1.71.1"
+version = "0.6.0"
+rust-version = "1.85.0"
 
 [dependencies]
 chrono = "^0.4"
 lazy-regex = "3"
 log = "^0.4"
 remotefs = "^0.3"
-ssh2-config = "^0.2"
+ssh2-config = "^0.4"
 ssh2 = "^0.9"
 
 [dev-dependencies]
 env_logger = "^0.11"
 pretty_assertions = "^1"
-rand = "^0.8.4"
-serial_test = "^3"
+rand = "^0.9"
 tempfile = "^3"
+testcontainers = { version = "0.23", features = ["blocking"] }
 
 [features]
 default = ["find"]
@@ -36,7 +36,6 @@ no-log = ["log/max_level_off"]
 ssh2-vendored = ["ssh2/vendored-openssl"]
 # tests
 github-actions = []
-with-containers = []
 
 [target."cfg(target_os = \"windows\")"]
 [target."cfg(target_os = \"windows\")".dependencies]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Christian Visintin
+Copyright (c) 2021-2025 Christian Visintin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -11,7 +11,7 @@
 <p align="center">~ Remotefs SSH client ~</p>
 
 <p align="center">Developed by <a href="https://veeso.github.io/" target="_blank">@veeso</a></p>
-<p align="center">Current version: 0.5.0 (26/10/2024)</p>
+<p align="center">Current version: 0.6.0 (15/03/2025)</p>
 
 <p align="center">
   <a href="https://opensource.org/licenses/MIT"
@@ -82,7 +82,7 @@ First of all, add `remotefs-ssh` to your project dependencies:
 
 ```toml
 remotefs = "0.3"
-remotefs-ssh = "^0.5"
+remotefs-ssh = "^0.6"
 ```
 
 these features are supported:

src/lib.rs

@@ -11,7 +11,7 @@
 //!
 //! ```toml
 //! remotefs = "^0.3"
-//! remotefs-ssh = "^0.5"
+//! remotefs-ssh = "^0.6"
 //! ```
 //!
 //! these features are supported:

src/mock/mod.rs

@@ -6,5 +6,15 @@ pub mod ssh;
 // -- logger
 
 pub fn logger() {
-    let _ = env_logger::builder().is_test(true).try_init();
+    use std::sync::Once;
+
+    static INIT: Once = Once::new();
+
+    INIT.call_once(|| {
+        let _ = env_logger::builder()
+            .filter_level(log::LevelFilter::Trace)
+            .is_test(true)
+            .format_line_number(true)
+            .try_init();
+    });
 }

src/mock/ssh.rs

@@ -16,9 +16,10 @@ pub struct MockSshKeyStorage {
 impl Default for MockSshKeyStorage {
     fn default() -> Self {
         let mut key = NamedTempFile::new().expect("Failed to create tempfile");
-        assert!(writeln!(
-            key,
-            r"-----BEGIN OPENSSH PRIVATE KEY-----
+        assert!(
+            writeln!(
+                key,
+                r"-----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABFwAAAAdzc2gtcn
 NhAAAAAwEAAQAAAQEAxKyYUMRCNPlb4ZV1VMofrzApu2l3wgP4Ot9wBvHsw/+RMpcHIbQK
 9iQqAVp8Z+M1fJyPXTKjoJtIzuCLF6Sjo0KI7/tFTh+yPnA5QYNLZOIRZb8skumL4gwHww
@@ -45,8 +46,9 @@ ruVXgkd7RJFbsIiD4dDcF4VCjwWHfTK21EOgJUA5pN6TNvAAAAgQDbcJWRx8Uyhkj2+srb
 TNKCN34QCWkyuYRHGhcNc0quEDayPw5QWGXlP4BzjfRUcPxY9cCXLe5wDLYsX33HwOAc59
 RorU9FCmS/654wAAABFyb290QDhjNTBmZDRjMzQ1YQECAw==
 -----END OPENSSH PRIVATE KEY-----"
-        )
-        .is_ok());
+            )
+            .is_ok()
+        );
         Self { key }
     }
 }
@@ -64,9 +66,10 @@ impl SshKeyStorage for MockSshKeyStorage {
 // -- config file
 
 /// Create ssh config file
-pub fn create_ssh_config() -> NamedTempFile {
+pub fn create_ssh_config(port: u16) -> NamedTempFile {
     let mut temp = NamedTempFile::new().expect("Failed to create tempfile");
-    let config = r##"
+    let config = format!(
+        r##"
 # ssh config
 Compression yes
 ConnectionAttempts  3
@@ -77,13 +80,14 @@ MACs                hmac-sha2-512,hmac-sha2-256,hmac-ripemd160
 # Hosts
 Host sftp
     HostName    127.0.0.1
-    Port        10022
+    Port        {port}
     User        sftp
 Host scp
     HostName    127.0.0.1
-    Port        10222
+    Port        {port}
     User        sftp
-"##;
+"##
+    );
     temp.write_all(config.as_bytes()).unwrap();
     temp
 }

src/ssh/commons.rs

@@ -11,8 +11,8 @@ use std::time::Duration;
 use remotefs::{RemoteError, RemoteErrorType, RemoteResult};
 use ssh2::{MethodType as SshMethodType, Session};
 
-use super::config::Config;
 use super::SshOpts;
+use super::config::Config;
 use crate::SshAgentIdentity;
 
 // -- connect
@@ -30,7 +30,7 @@ pub fn connect(opts: &SshOpts) -> RemoteResult<Session> {
             return Err(RemoteError::new_ex(
                 RemoteErrorType::BadAddress,
                 err.to_string(),
-            ))
+            ));
         }
     };
     let mut stream = None;
@@ -312,7 +312,7 @@ pub fn perform_shell_cmd<S: AsRef<str>>(session: &mut Session, cmd: S) -> Remote
             return Err(RemoteError::new_ex(
                 RemoteErrorType::ProtocolError,
                 format!("Could not open channel: {err}"),
-            ))
+            ));
         }
     };
     // Execute command
@@ -364,7 +364,7 @@ pub fn perform_shell_cmd_with_rc<S: AsRef<str>>(
                 return Err(RemoteError::new_ex(
                     RemoteErrorType::ProtocolError,
                     "Failed to get command exit code",
-                ))
+                ));
             }
         };
         debug!(r#"Command output: "{}"; exit code: {}"#, actual_output, rc);
@@ -383,18 +383,21 @@ pub fn perform_shell_cmd_with_rc<S: AsRef<str>>(
 #[cfg(test)]
 mod test {
 
-    #[cfg(feature = "with-containers")]
     use ssh2_config::ParseRule;
 
     use super::*;
-    #[cfg(feature = "with-containers")]
     use crate::mock::ssh as ssh_mock;
 
     #[test]
-    #[cfg(feature = "with-containers")]
+
     fn should_connect_to_ssh_server_auth_user_password() {
+        use crate::ssh::container::OpensshServer;
+
+        let container = OpensshServer::start();
+        let port = container.port();
+
         crate::mock::logger();
-        let config_file = ssh_mock::create_ssh_config();
+        let config_file = ssh_mock::create_ssh_config(port);
         let opts = SshOpts::new("sftp")
             .config_file(config_file.path(), ParseRule::ALLOW_UNKNOWN_FIELDS)
             .password("password");
@@ -404,13 +407,20 @@ mod test {
         }
         let session = connect(&opts).unwrap();
         assert!(session.authenticated());
+
+        drop(container);
     }
 
     #[test]
-    #[cfg(feature = "with-containers")]
+
     fn should_connect_to_ssh_server_auth_key() {
+        use crate::ssh::container::OpensshServer;
+
+        let container = OpensshServer::start();
+        let port = container.port();
+
         crate::mock::logger();
-        let config_file = ssh_mock::create_ssh_config();
+        let config_file = ssh_mock::create_ssh_config(port);
         let opts = SshOpts::new("sftp")
             .config_file(config_file.path(), ParseRule::ALLOW_UNKNOWN_FIELDS)
             .key_storage(Box::new(ssh_mock::MockSshKeyStorage::default()));
@@ -419,11 +429,14 @@ mod test {
     }
 
     #[test]
-    #[cfg(feature = "with-containers")]
+
     fn should_perform_shell_command_on_server() {
         crate::mock::logger();
+        let container = crate::ssh::container::OpensshServer::start();
+        let port = container.port();
+
         let opts = SshOpts::new("127.0.0.1")
-            .port(10022)
+            .port(port)
             .username("sftp")
             .password("password");
         let mut session = connect(&opts).unwrap();
@@ -433,11 +446,14 @@ mod test {
     }
 
     #[test]
-    #[cfg(feature = "with-containers")]
+
     fn should_perform_shell_command_on_server_and_return_exit_code() {
         crate::mock::logger();
+        let container = crate::ssh::container::OpensshServer::start();
+        let port = container.port();
+
         let opts = SshOpts::new("127.0.0.1")
-            .port(10022)
+            .port(port)
             .username("sftp")
             .password("password");
         let mut session = connect(&opts).unwrap();
@@ -459,11 +475,14 @@ mod test {
     }
 
     #[test]
-    #[cfg(feature = "with-containers")]
+
     fn should_fail_authentication() {
         crate::mock::logger();
+        let container = crate::ssh::container::OpensshServer::start();
+        let port = container.port();
+
         let opts = SshOpts::new("127.0.0.1")
-            .port(10022)
+            .port(port)
             .username("sftp")
             .password("ippopotamo");
         assert!(connect(&opts).is_err());

src/ssh/config.rs

@@ -160,21 +160,21 @@ mod test {
 
     #[test]
     fn should_init_config_from_file() {
-        let config_file = ssh_mock::create_ssh_config();
+        let config_file = ssh_mock::create_ssh_config(22);
         let opts = SshOpts::new("sftp").config_file(config_file.path(), ParseRule::STRICT);
         let config = Config::try_from(&opts).ok().unwrap();
         assert_eq!(config.connection_attempts, 3);
         assert_eq!(config.connection_timeout, Duration::from_secs(60));
         assert_eq!(config.host.as_str(), "sftp");
         assert_eq!(config.resolved_host.as_str(), "127.0.0.1");
-        assert_eq!(config.address.as_str(), "127.0.0.1:10022");
+        assert_eq!(config.address.as_str(), "127.0.0.1:22");
         assert_eq!(config.username.as_str(), "sftp");
         assert_ne!(config.params, HostParams::default());
     }
 
     #[test]
     fn should_init_config_from_file_with_override() {
-        let config_file = ssh_mock::create_ssh_config();
+        let config_file = ssh_mock::create_ssh_config(22);
         let opts = SshOpts::new("sftp")
             .config_file(config_file.path(), ParseRule::STRICT)
             .connection_timeout(Duration::from_secs(10))