summaryrefslogtreecommitdiffhomepage
path: root/test/test-manager/src/vm/provision.rs
blob: b3b39a2c18ee08187f8583bc33e46d8070a75886 (plain)
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
use crate::config::{OsType, Provisioner, VmConfig};
use crate::package;
use anyhow::{Context, Result};
use ssh2::Session;
use std::fs::File;
use std::io::{self, Read};
use std::net::IpAddr;
use std::net::TcpStream;
use std::{net::SocketAddr, path::Path};

pub async fn provision(
    config: &VmConfig,
    instance: &dyn super::VmInstance,
    app_manifest: &package::Manifest,
) -> Result<String> {
    match config.provisioner {
        Provisioner::Ssh => {
            log::info!("SSH provisioning");

            let (user, password) = config.get_ssh_options().context("missing SSH config")?;
            ssh(
                instance,
                config.os_type,
                config.get_runner_dir(),
                app_manifest,
                user,
                password,
            )
            .await
            .context("Failed to provision runner over SSH")
        }
        Provisioner::Noop => {
            let dir = config
                .artifacts_dir
                .as_ref()
                .context("'artifacts_dir' must be set to a mountpoint")?;
            Ok(dir.clone())
        }
    }
}

async fn ssh(
    instance: &dyn super::VmInstance,
    os_type: OsType,
    local_runner_dir: &Path,
    local_app_manifest: &package::Manifest,
    user: &str,
    password: &str,
) -> Result<String> {
    let guest_ip = *instance.get_ip();

    let user = user.to_owned();
    let password = password.to_owned();

    let remote_dir = match os_type {
        OsType::Windows => r"C:\testing",
        OsType::Macos | OsType::Linux => r"/opt/testing",
    };

    let local_runner_dir = local_runner_dir.to_owned();
    let local_app_manifest = local_app_manifest.to_owned();

    tokio::task::spawn_blocking(move || {
        blocking_ssh(
            user,
            password,
            guest_ip,
            &local_runner_dir,
            local_app_manifest,
            remote_dir,
        )
    })
    .await
    .context("Failed to join SSH task")??;

    Ok(remote_dir.to_string())
}

fn blocking_ssh(
    user: String,
    password: String,
    guest_ip: IpAddr,
    local_runner_dir: &Path,
    local_app_manifest: package::Manifest,
    remote_dir: &str,
) -> Result<()> {
    // Directory that receives the payload. Any directory that the SSH user has access to.
    const REMOTE_TEMP_DIR: &str = "/tmp/";
    const SCRIPT_PAYLOAD: &[u8] = include_bytes!("../../../scripts/ssh-setup.sh");
    const OPENVPN_CERT: &[u8] = include_bytes!("../../../openvpn.ca.crt");

    let temp_dir = Path::new(REMOTE_TEMP_DIR);

    let stream = TcpStream::connect(SocketAddr::new(guest_ip, 22)).context("TCP connect failed")?;

    let mut session = Session::new().context("Failed to connect to SSH server")?;
    session.set_tcp_stream(stream);
    session.handshake()?;

    session
        .userauth_password(&user, &password)
        .context("SSH auth failed")?;

    // Transfer a test runner
    let source = local_runner_dir.join("test-runner");
    ssh_send_file_path(&session, &source, temp_dir)
        .context("Failed to send test runner to remote")?;

    // Transfer app packages
    ssh_send_file_path(&session, &local_app_manifest.current_app_path, temp_dir)
        .context("Failed to send current app package to remote")?;
    ssh_send_file_path(&session, &local_app_manifest.previous_app_path, temp_dir)
        .context("Failed to send previous app package to remote")?;
    ssh_send_file_path(&session, &local_app_manifest.ui_e2e_tests_path, temp_dir)
        .context("Failed to send UI test runner to remote")?;

    // Transfer openvpn cert
    let dest: std::path::PathBuf = temp_dir.join("openvpn.ca.crt");
    log::debug!("Copying remote openvpn.ca.crt -> {}", dest.display());
    #[allow(const_item_mutation)]
    ssh_send_file(
        &session,
        &mut OPENVPN_CERT,
        u64::try_from(OPENVPN_CERT.len()).expect("cert too long"),
        &dest,
    )
    .context("failed to send openvpn crt to remote")?;

    // Transfer setup script
    let dest = temp_dir.join("ssh-setup.sh");
    log::debug!("Copying remote setup script -> {}", dest.display());
    #[allow(const_item_mutation)]
    ssh_send_file(
        &session,
        &mut SCRIPT_PAYLOAD,
        u64::try_from(SCRIPT_PAYLOAD.len()).expect("script too long"),
        &dest,
    )
    .context("failed to send bootstrap script to remote")?;

    // Run setup script

    let args = format!(
        "{remote_dir} \"{}\" \"{}\" \"{}\"",
        local_app_manifest
            .current_app_path
            .file_name()
            .unwrap()
            .to_string_lossy(),
        local_app_manifest
            .previous_app_path
            .file_name()
            .unwrap()
            .to_string_lossy(),
        local_app_manifest
            .ui_e2e_tests_path
            .file_name()
            .unwrap()
            .to_string_lossy(),
    );

    log::debug!("Running setup script on remote, args: {args}");
    ssh_exec(&session, &format!("sudo {} {args}", dest.display()))
        .map(drop)
        .context("Failed to run setup script")
}

fn ssh_send_file_path(session: &Session, source: &Path, dest_dir: &Path) -> Result<()> {
    let dest = dest_dir.join(source.file_name().context("Missing source file name")?);

    log::debug!(
        "Copying file to remote: {} -> {}",
        source.display(),
        dest.display(),
    );

    let mut file = File::open(source).context("Failed to open file")?;
    let file_len = file.metadata().context("Failed to get file size")?.len();
    ssh_send_file(session, &mut file, file_len, &dest)
}

fn ssh_send_file<R: Read>(
    session: &Session,
    source: &mut R,
    source_len: u64,
    dest: &Path,
) -> Result<()> {
    let mut remote_file = session.scp_send(dest, 0o744, source_len, None)?;
    io::copy(source, &mut remote_file).context("failed to write file")?;
    remote_file.send_eof()?;
    remote_file.wait_eof()?;
    remote_file.close()?;
    remote_file.wait_close()?;
    Ok(())
}

/// Execute an arbitrary string of commands via ssh.
fn ssh_exec(session: &Session, command: &str) -> Result<String> {
    let mut channel = session.channel_session()?;
    channel.exec(command)?;
    let mut output = String::new();
    channel.read_to_string(&mut output)?;
    channel.send_eof()?;
    channel.wait_eof()?;
    channel.wait_close()?;
    Ok(output)
}