nils-plan-issue 1.12.0

CLI crate for nils-plan-issue in the nils-cli workspace.
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

use serde::Serialize;
use serde_json::Value;

#[derive(Debug, Serialize)]
struct JsonSuccessEnvelope<'a> {
    schema_version: &'a str,
    command: &'a str,
    status: &'a str,
    payload: &'a Value,
}

#[derive(Debug, Serialize)]
struct JsonErrorEnvelope<'a> {
    schema_version: &'a str,
    command: &'a str,
    status: &'a str,
    error: JsonError<'a>,
}

#[derive(Debug, Serialize)]
struct JsonError<'a> {
    code: &'a str,
    message: &'a str,
}

pub(crate) fn render_success(
    schema_version: &str,
    command: &str,
    payload: &Value,
) -> Result<String, String> {
    let envelope = JsonSuccessEnvelope {
        schema_version,
        command,
        status: "ok",
        payload,
    };
    serde_json::to_string(&envelope)
        .map_err(|err| format!("failed to serialize JSON output: {err}"))
}

pub(crate) fn render_error(
    schema_version: &str,
    command: &str,
    code: &str,
    message: &str,
) -> Result<String, String> {
    let envelope = JsonErrorEnvelope {
        schema_version,
        command,
        status: "error",
        error: JsonError { code, message },
    };
    serde_json::to_string(&envelope)
        .map_err(|err| format!("failed to serialize JSON error output: {err}"))
}

pub fn print_success(schema_version: &str, command: &str, payload: &Value) -> Result<(), String> {
    let rendered = render_success(schema_version, command, payload)?;
    println!("{rendered}");
    Ok(())
}

pub fn print_error(
    schema_version: &str,
    command: &str,
    code: &str,
    message: &str,
) -> Result<(), String> {
    let rendered = render_error(schema_version, command, code, message)?;
    println!("{rendered}");
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;
    use serde_json::json;

    #[test]
    fn success_envelope_carries_schema_command_status_and_payload() {
        let payload = json!({"item_count": 3});
        let rendered = render_success("cli.plan-issue.list.v1", "list", &payload).expect("render");
        assert_eq!(
            rendered,
            "{\"schema_version\":\"cli.plan-issue.list.v1\",\"command\":\"list\",\"status\":\"ok\",\"payload\":{\"item_count\":3}}"
        );
    }

    #[test]
    fn error_envelope_carries_schema_command_status_and_error_pair() {
        let rendered = render_error(
            "cli.plan-issue.list.v1",
            "list",
            "missing-issue",
            "issue not found",
        )
        .expect("render");
        assert_eq!(
            rendered,
            "{\"schema_version\":\"cli.plan-issue.list.v1\",\"command\":\"list\",\"status\":\"error\",\"error\":{\"code\":\"missing-issue\",\"message\":\"issue not found\"}}"
        );
    }

    #[test]
    fn error_envelope_does_not_emit_data_field() {
        let rendered = render_error("v1", "cmd", "bad-input", "x").expect("render");
        assert!(
            !rendered.contains("\"data\""),
            "must not carry data field: {rendered}"
        );
        assert!(
            !rendered.contains("\"ok\""),
            "must not carry ok field: {rendered}"
        );
    }
}