qs 0.3.0

Quick SSH - Dead simple, zero-friction SSH wrapper that makes working with remote machines effortless
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

#![cfg(unix)]

use std::fs;
use std::os::unix::fs::PermissionsExt;
use std::path::Path;
use std::process::{Command, Output};

use tempfile::TempDir;

const QS_BIN: &str = env!("CARGO_BIN_EXE_qs");

fn write_config(home: &Path) {
    let config_dir = home.join(".config").join("qs");
    fs::create_dir_all(&config_dir).unwrap();
    fs::write(
        config_dir.join("config.toml"),
        "default = \"test\"\n\n\
         [profiles.test]\n\
         host = \"stub.invalid\"\n\
         user = \"tester\"\n\
         port = 22\n",
    )
    .unwrap();
}

fn write_ssh_stub(dir: &Path, body: &str) {
    let stub = dir.join("ssh");
    fs::write(&stub, format!("#!/bin/sh\n{body}\n")).unwrap();
    fs::set_permissions(&stub, fs::Permissions::from_mode(0o755)).unwrap();
}

fn run_qs(home: &Path, path_dir: &Path, args: &[&str]) -> Output {
    Command::new(QS_BIN)
        .args(args)
        .env("HOME", home)
        .env("PATH", path_dir)
        .output()
        .unwrap()
}

#[test]
fn exec_propagates_remote_exit_code() {
    let home = TempDir::new().unwrap();
    write_config(home.path());
    let stubs = TempDir::new().unwrap();
    write_ssh_stub(stubs.path(), "exit 42");

    let out = run_qs(home.path(), stubs.path(), &["exec", "--", "true"]);
    assert_eq!(out.status.code(), Some(42));
}

#[test]
fn exec_success_exits_zero() {
    let home = TempDir::new().unwrap();
    write_config(home.path());
    let stubs = TempDir::new().unwrap();
    write_ssh_stub(stubs.path(), "exit 0");

    let out = run_qs(home.path(), stubs.path(), &["exec", "--", "true"]);
    assert_eq!(out.status.code(), Some(0));
}

#[test]
fn connect_propagates_exit_code() {
    let home = TempDir::new().unwrap();
    write_config(home.path());
    let stubs = TempDir::new().unwrap();
    write_ssh_stub(stubs.path(), "exit 7");

    let out = run_qs(home.path(), stubs.path(), &["connect"]);
    assert_eq!(out.status.code(), Some(7));
}

#[test]
fn exec_spawn_failure_exits_one() {
    let home = TempDir::new().unwrap();
    write_config(home.path());
    let empty = TempDir::new().unwrap();

    let out = run_qs(home.path(), empty.path(), &["exec", "--", "true"]);
    assert_eq!(out.status.code(), Some(1));
    let stderr = String::from_utf8_lossy(&out.stderr);
    assert!(stderr.contains("Failed to run ssh"), "{stderr}");
}

#[test]
fn exec_detach_sends_wrapped_command() {
    let home = TempDir::new().unwrap();
    write_config(home.path());
    let stubs = TempDir::new().unwrap();
    write_ssh_stub(stubs.path(), r#"printf '%s\n' "$@""#);

    let out = run_qs(
        home.path(),
        stubs.path(),
        &["exec", "-d", "--", "sleep", "5"],
    );
    assert_eq!(out.status.code(), Some(0));
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(stdout.contains("nohup sh -c 'sleep 5'"), "{stdout}");
    assert!(stdout.contains("mktemp /tmp/qs-detach.XXXXXX"), "{stdout}");
    assert!(stdout.contains("</dev/null"), "{stdout}");
}

#[test]
fn exec_tmux_sends_wrapped_command() {
    let home = TempDir::new().unwrap();
    write_config(home.path());
    let stubs = TempDir::new().unwrap();
    write_ssh_stub(stubs.path(), r#"printf '%s\n' "$@""#);

    let out = run_qs(
        home.path(),
        stubs.path(),
        &["exec", "--tmux", "job", "--", "sleep", "5"],
    );
    assert_eq!(out.status.code(), Some(0));
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("tmux new-session -d -s 'job' 'sleep 5'"),
        "{stdout}"
    );
}

#[test]
fn exec_tmux_invalid_session_rejected_before_spawn() {
    let home = TempDir::new().unwrap();
    write_config(home.path());
    let empty = TempDir::new().unwrap();

    let out = run_qs(
        home.path(),
        empty.path(),
        &["exec", "--tmux", "bad name", "--", "true"],
    );
    assert_eq!(out.status.code(), Some(1));
    let stderr = String::from_utf8_lossy(&out.stderr);
    assert!(stderr.contains("tmux session name"), "{stderr}");
}