microsandbox-cli 0.7.3

CLI binary for managing microsandbox environments.
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

//! `msb wait` command — wait for a sandbox to reach a terminal state.

use std::time::Duration;

use clap::Args;
use microsandbox::sandbox::{Sandbox, SandboxStatus, SandboxStopResult};

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// Wait for a sandbox to stop or crash.
#[derive(Debug, Args)]
pub struct WaitArgs {
    /// Sandbox to wait for.
    pub name: String,

    /// Stop waiting after this duration (e.g. 30s, 5m, 1h).
    #[arg(short = 't', long)]
    pub timeout: Option<String>,

    /// Output format (json). Exit code and signal are currently unavailable.
    #[arg(long, value_name = "FORMAT", value_parser = ["json"])]
    pub format: Option<String>,
}

//--------------------------------------------------------------------------------------------------
// Functions
//--------------------------------------------------------------------------------------------------

/// Execute the `msb wait` command.
pub async fn run(args: WaitArgs) -> anyhow::Result<()> {
    let wait = async {
        let handle = Sandbox::get(&args.name).await?;
        anyhow::Ok(handle.wait_until_stopped().await?)
    };
    let result = if let Some(timeout) = args.timeout.as_deref() {
        tokio::time::timeout(parse_timeout(timeout)?, wait)
            .await
            .map_err(|_| anyhow::anyhow!("timed out waiting for sandbox '{}'", args.name))??
    } else {
        wait.await?
    };

    print_result(&result, args.format.as_deref() == Some("json"))?;
    Ok(())
}

fn parse_timeout(value: &str) -> anyhow::Result<Duration> {
    super::common::parse_duration(value)
}

fn is_terminal(status: SandboxStatus) -> bool {
    matches!(status, SandboxStatus::Stopped | SandboxStatus::Crashed)
}

fn print_result(result: &SandboxStopResult, json: bool) -> anyhow::Result<()> {
    if json {
        println!(
            "{}",
            serde_json::to_string_pretty(&wait_result_json(result))?
        );
    } else {
        println!("{} {:?}", result.name, result.status);
    }
    Ok(())
}

fn wait_result_json(result: &SandboxStopResult) -> serde_json::Value {
    serde_json::json!({
        "name": result.name,
        "status": format!("{:?}", result.status),
        "terminal": is_terminal(result.status),
        "exit_code": result.exit_code,
        "signal": result.signal,
        "observed_at": result.observed_at.to_rfc3339(),
        "source": result.source,
    })
}

//--------------------------------------------------------------------------------------------------
// Tests
//--------------------------------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use std::time::Duration;

    use clap::Parser;
    use microsandbox::sandbox::SandboxStatus;

    use super::*;

    #[derive(Parser)]
    struct TestCli {
        #[command(flatten)]
        args: WaitArgs,
    }

    fn parse_wait_args(args: &[&str]) -> WaitArgs {
        TestCli::parse_from(std::iter::once("msb").chain(args.iter().copied())).args
    }

    #[test]
    fn parses_timeout_and_json_format() {
        let args = parse_wait_args(&["worker", "--timeout", "30s", "--format", "json"]);

        assert_eq!(args.name, "worker");
        assert_eq!(args.timeout.as_deref(), Some("30s"));
        assert_eq!(args.format.as_deref(), Some("json"));
    }

    #[test]
    fn parses_human_duration() {
        assert_eq!(
            parse_timeout("1500ms").unwrap(),
            Duration::from_millis(1500)
        );
        assert_eq!(parse_timeout("2m").unwrap(), Duration::from_secs(120));
    }

    #[test]
    fn classifies_only_stopped_and_crashed_as_terminal() {
        assert!(is_terminal(SandboxStatus::Stopped));
        assert!(is_terminal(SandboxStatus::Crashed));
        assert!(!is_terminal(SandboxStatus::Running));
        assert!(!is_terminal(SandboxStatus::Paused));
    }

    #[test]
    fn renders_terminal_result_as_json() {
        let result = SandboxStopResult {
            name: "worker".to_string(),
            status: SandboxStatus::Crashed,
            exit_code: None,
            signal: None,
            observed_at: "2026-08-18T09:30:00Z".parse().unwrap(),
            source: Some("refreshed backend state".to_string()),
        };
        let json = wait_result_json(&result);

        assert_eq!(
            json,
            serde_json::json!({
                "name": "worker",
                "status": "Crashed",
                "terminal": true,
                "exit_code": null,
                "signal": null,
                "observed_at": "2026-08-18T09:30:00+00:00",
                "source": "refreshed backend state",
            })
        );
    }
}