bssh 1.1.0

Parallel SSH command execution tool for cluster management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

// Copyright 2025 Lablup Inc. and Jeongkyu Shin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use bssh::executor::ParallelExecutor;
use bssh::node::Node;
use std::fs;
use std::path::PathBuf;
use std::process::Command;
use tempfile::TempDir;

/// Check if SSH is available and can connect to localhost
fn can_ssh_to_localhost() -> bool {
    // Check if SSH server is running and we can connect to localhost
    let output = Command::new("ssh")
        .args([
            "-o",
            "ConnectTimeout=2",
            "-o",
            "StrictHostKeyChecking=no",
            "-o",
            "UserKnownHostsFile=/dev/null",
            "-o",
            "PasswordAuthentication=no",
            "-o",
            "BatchMode=yes",
            "localhost",
            "echo",
            "test",
        ])
        .output();

    match output {
        Ok(result) => result.status.success(),
        Err(_) => false,
    }
}

#[tokio::test]
async fn test_localhost_upload_download_roundtrip() {
    if !can_ssh_to_localhost() {
        eprintln!("Skipping integration test: Cannot SSH to localhost");
        return;
    }

    // Create temporary directories for testing
    let local_temp = TempDir::new().unwrap();
    let remote_temp = TempDir::new().unwrap();

    // Create a test file
    let test_content = "Integration test content for bssh SFTP";
    let local_file = local_temp.path().join("test_file.txt");
    fs::write(&local_file, test_content).unwrap();

    // Create executor with localhost node
    let nodes = vec![Node::new(
        "localhost".to_string(),
        22,
        std::env::var("USER").unwrap_or_else(|_| "root".to_string()),
    )];
    // Try to find an SSH key - use None if not found (will try SSH agent)
    let ssh_key = dirs::home_dir().and_then(|h| {
        let key_path = h.join(".ssh/id_rsa");
        if key_path.exists() {
            Some(key_path.to_string_lossy().to_string())
        } else {
            None
        }
    });
    let executor = ParallelExecutor::new(nodes, 1, ssh_key);

    // Test upload
    let remote_path = format!("{}/uploaded_file.txt", remote_temp.path().display());
    let upload_results = executor
        .upload_file(&local_file, &remote_path)
        .await
        .unwrap();

    assert_eq!(upload_results.len(), 1);
    if !upload_results[0].is_success() {
        eprintln!("Upload failed: {:?}", upload_results[0].result);
        return;
    }

    // Verify file was uploaded
    assert!(PathBuf::from(&remote_path).exists());
    let uploaded_content = fs::read_to_string(&remote_path).unwrap();
    assert_eq!(uploaded_content, test_content);

    // Test download
    let download_temp = TempDir::new().unwrap();
    let download_results = executor
        .download_file(&remote_path, download_temp.path())
        .await
        .unwrap();

    assert_eq!(download_results.len(), 1);
    assert!(download_results[0].is_success());

    // Verify downloaded file
    if let Ok(downloaded_path) = &download_results[0].result {
        assert!(downloaded_path.exists());
        let downloaded_content = fs::read_to_string(downloaded_path).unwrap();
        assert_eq!(downloaded_content, test_content);
    }
}

#[tokio::test]
async fn test_localhost_multiple_file_upload() {
    if !can_ssh_to_localhost() {
        eprintln!("Skipping integration test: Cannot SSH to localhost");
        return;
    }

    // Create temporary directories
    let local_temp = TempDir::new().unwrap();
    let remote_temp = TempDir::new().unwrap();

    // Create multiple test files
    let files = vec![
        ("file1.txt", "Content of file 1"),
        ("file2.txt", "Content of file 2"),
        ("file3.log", "Log content"),
    ];

    for (name, content) in &files {
        fs::write(local_temp.path().join(name), content).unwrap();
    }

    // Create executor
    let nodes = vec![Node::new(
        "localhost".to_string(),
        22,
        std::env::var("USER").unwrap_or_else(|_| "root".to_string()),
    )];
    // Try to find an SSH key - use None if not found (will try SSH agent)
    let ssh_key = dirs::home_dir().and_then(|h| {
        let key_path = h.join(".ssh/id_rsa");
        if key_path.exists() {
            Some(key_path.to_string_lossy().to_string())
        } else {
            None
        }
    });
    let executor = ParallelExecutor::new(nodes, 1, ssh_key);

    // Upload each file
    for (name, content) in &files {
        let local_file = local_temp.path().join(name);
        let remote_path = format!("{}/{}", remote_temp.path().display(), name);

        let results = executor
            .upload_file(&local_file, &remote_path)
            .await
            .unwrap();
        assert!(results[0].is_success());

        // Verify upload
        let uploaded_content = fs::read_to_string(&remote_path).unwrap();
        assert_eq!(&uploaded_content, content);
    }
}

#[tokio::test]
async fn test_parallel_execution_with_multiple_nodes() {
    // This test simulates multiple nodes by using the same localhost multiple times
    // In a real scenario, these would be different hosts

    if !can_ssh_to_localhost() {
        eprintln!("Skipping integration test: Cannot SSH to localhost");
        return;
    }

    let user = std::env::var("USER").unwrap_or_else(|_| "root".to_string());
    let nodes = vec![
        Node::new("localhost".to_string(), 22, user.clone()),
        Node::new("127.0.0.1".to_string(), 22, user.clone()),
    ];

    // Try to find an SSH key - use None if not found (will try SSH agent)
    let ssh_key = dirs::home_dir().and_then(|h| {
        let key_path = h.join(".ssh/id_rsa");
        if key_path.exists() {
            Some(key_path.to_string_lossy().to_string())
        } else {
            None
        }
    });
    let executor = ParallelExecutor::new(nodes, 2, ssh_key);

    // Execute a simple command
    let results = executor.execute("echo 'test'").await.unwrap();

    assert_eq!(results.len(), 2);
    for result in &results {
        assert!(result.is_success());
        if let Ok(cmd_result) = &result.result {
            assert!(cmd_result.stdout_string().contains("test"));
        }
    }
}

#[tokio::test]
async fn test_download_with_unique_filenames() {
    if !can_ssh_to_localhost() {
        eprintln!("Skipping integration test: Cannot SSH to localhost");
        return;
    }

    // Create a file to download
    let source_temp = TempDir::new().unwrap();
    let source_file = source_temp.path().join("shared_file.txt");
    fs::write(&source_file, "Shared content").unwrap();

    // Create executor with two "different" nodes (both localhost)
    let user = std::env::var("USER").unwrap_or_else(|_| "root".to_string());
    let nodes = vec![
        Node::new("localhost".to_string(), 22, user.clone()),
        Node::new("127.0.0.1".to_string(), 22, user),
    ];

    // Try to find an SSH key - use None if not found (will try SSH agent)
    let ssh_key = dirs::home_dir().and_then(|h| {
        let key_path = h.join(".ssh/id_rsa");
        if key_path.exists() {
            Some(key_path.to_string_lossy().to_string())
        } else {
            None
        }
    });
    let executor = ParallelExecutor::new(nodes, 2, ssh_key);

    // Download from both nodes
    let download_temp = TempDir::new().unwrap();
    let results = executor
        .download_file(source_file.to_str().unwrap(), download_temp.path())
        .await
        .unwrap();

    assert_eq!(results.len(), 2);

    // Check that files have unique names
    let mut downloaded_files = Vec::new();
    for result in &results {
        if let Ok(path) = &result.result {
            downloaded_files.push(path.clone());
            assert!(path.exists());
        }
    }

    // Ensure filenames are unique
    assert_eq!(downloaded_files.len(), 2);
    assert_ne!(downloaded_files[0], downloaded_files[1]);

    // Both should contain the same content
    for path in &downloaded_files {
        let content = fs::read_to_string(path).unwrap();
        assert_eq!(content, "Shared content");
    }
}