foundation_deployment_platform 0.1.1

Foundation deployment platform — VM/container orchestration, Docker runtime, guest infrastructure
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

//! Log tailing and error extraction from VMs.
//!
//! Supports dump, follow (live tail), and error extraction modes
//! for both build and run logs.

use crate::config::{GuestOs, Result, VmProfile};
use crate::ssh::VmSession;

/// Log kinds available on the VM.
#[derive(Debug, Clone, Copy)]
pub enum LogKind {
    Build,
    Run,
}

impl std::str::FromStr for LogKind {
    type Err = String;
    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        match s {
            "build" => Ok(LogKind::Build),
            "run" => Ok(LogKind::Run),
            _ => Err(format!("unknown log kind: {s}")),
        }
    }
}

/// Log mode.
#[derive(Debug, Clone, Copy)]
pub enum LogMode {
    /// Dump the full log.
    Dump,
    /// Follow (live tail) the log.
    Follow,
    /// Extract error stanzas only.
    Errors,
    /// Show last N lines.
    Tail(u32),
}

/// Options for log retrieval.
#[derive(Debug)]
pub struct LogOpts {
    pub kind: LogKind,
    pub mode: LogMode,
}

/// Get the log file path on the VM.
pub fn log_path(profile: &VmProfile, kind: LogKind) -> String {
    match (profile.os, kind) {
        (GuestOs::Linux, LogKind::Build) => "/home/vagrant/.testbed-build/build.log".to_string(),
        (GuestOs::Linux, LogKind::Run) => "/home/vagrant/.testbed-run/run.log".to_string(),
        (GuestOs::MacOS, LogKind::Build) => "/Users/vagrant/.testbed-build/build.log".to_string(),
        (GuestOs::MacOS, LogKind::Run) => "/Users/vagrant/.testbed-run/run.log".to_string(),
        (GuestOs::Windows, LogKind::Build) => "C:\\Users\\vagrant\\.testbed-build\\build.log".to_string(),
        (GuestOs::Windows, LogKind::Run) => "C:\\Users\\vagrant\\.testbed-run\\run.log".to_string(),
    }
}

/// Retrieve logs from the VM according to options.
pub fn get_logs(profile: &VmProfile, session: &mut VmSession, opts: &LogOpts) -> Result<String> {
    let path = log_path(profile, opts.kind);

    match opts.mode {
        LogMode::Dump => dump_log(session, &path),
        LogMode::Follow => follow_log(profile, session, &path),
        LogMode::Errors => extract_errors(session, &path),
        LogMode::Tail(n) => tail_log(session, &path, n),
    }
}

/// Dump the full log file.
fn dump_log(session: &mut VmSession, path: &str) -> Result<String> {
    crate::ssh::exec(session, &format!("cat {path}"))
}

/// Follow (live tail) the log file.
///
/// Uses `tail -F` on Linux or `Get-Content -Wait` on Windows.
/// This blocks until the user interrupts.
fn follow_log(profile: &VmProfile, session: &mut VmSession, path: &str) -> Result<String> {
    let cmd = match profile.os {
        GuestOs::Linux | GuestOs::MacOS => format!("tail -F {path}"),
        GuestOs::Windows => format!("Get-Content -Path '{path}' -Wait"),
    };
    crate::ssh::exec(session, &cmd)
}

/// Extract error stanzas from the log.
fn extract_errors(session: &mut VmSession, path: &str) -> Result<String> {
    // Read the log content
    let content = crate::ssh::exec(session, &format!("cat {path}"))?;
    crate::build::logs::extract_errors(&content)
}

/// Show the last N lines of the log.
fn tail_log(session: &mut VmSession, path: &str, n: u32) -> Result<String> {
    crate::ssh::exec(session, &format!("tail -n {n} {path}"))
}