standout 9.0.0

Styled CLI template rendering with automatic terminal detection
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

use clap::Command;
use serde_json::json;
use standout::cli::FnHandler;
use standout::cli::{App, ExitStatus, HelpResult, Output, RunErrorKind, SuccessKind};
use standout::EmbeddedTemplates;

const TEMPLATES: &[(&str, &str)] = &[("go", "{{ message }}")];

fn versionless_command() -> Command {
    Command::new("app").subcommand(Command::new("go"))
}

fn app_with(version: Option<&str>) -> App {
    let builder = App::builder()
        .templates(EmbeddedTemplates::new(TEMPLATES, ""))
        .command_with(
            "go",
            FnHandler::new(|_matches, _ctx| Ok(Output::Render(json!({ "message": "ok" })))),
            |cfg| cfg,
        )
        .unwrap();
    match version {
        Some(version) => builder.version(version),
        None => builder,
    }
    .build()
    .unwrap()
}

fn app_with_owned_version(version: String) -> App {
    App::builder()
        .templates(EmbeddedTemplates::new(TEMPLATES, ""))
        .command_with(
            "go",
            FnHandler::new(|_matches, _ctx| Ok(Output::Render(json!({ "message": "ok" })))),
            |cfg| cfg,
        )
        .unwrap()
        .version(version)
        .build()
        .unwrap()
}

#[test]
fn a_configured_version_is_answered_as_a_clap_display_success() {
    let result = app_with(Some("9.9.9")).run_with(
        versionless_command(),
        ["app", "--version"],
        standout::TargetProperties::detect(),
        standout::InputSources::from_process(),
    );

    assert_eq!(result.exit_status(), Some(ExitStatus::SUCCESS));
    assert_eq!(result.success_kind(), Some(SuccessKind::ClapVersion));
    assert_eq!(result.output().unwrap().trim(), "app 9.9.9");
}

#[test]
fn an_owned_string_version_is_accepted() {
    let result = app_with_owned_version(String::from("8.8.8")).run_with(
        versionless_command(),
        ["app", "--version"],
        standout::TargetProperties::detect(),
        standout::InputSources::from_process(),
    );

    assert_eq!(result.exit_status(), Some(ExitStatus::SUCCESS));
    assert_eq!(result.success_kind(), Some(SuccessKind::ClapVersion));
    assert_eq!(result.output().unwrap().trim(), "app 8.8.8");
}

#[test]
fn the_parse_only_path_sees_the_same_version() {
    let result = app_with(Some("9.9.9")).get_matches_from(
        versionless_command(),
        ["app", "--version"],
        &standout::InputSources::from_process(),
    );

    match result {
        HelpResult::Error(error) => {
            assert_eq!(error.kind(), clap::error::ErrorKind::DisplayVersion);
            assert!(
                error.to_string().contains("9.9.9"),
                "unexpected version display: {error}"
            );
        }
        other => panic!("expected clap's version display, got {other:?}"),
    }
}

#[test]
fn an_unset_version_leaves_a_version_configured_on_the_command() {
    let command = versionless_command().version("1.2.3");
    let result = app_with(None).run_with(
        command,
        ["app", "--version"],
        standout::TargetProperties::detect(),
        standout::InputSources::from_process(),
    );

    assert_eq!(result.success_kind(), Some(SuccessKind::ClapVersion));
    assert_eq!(result.output().unwrap().trim(), "app 1.2.3");
}

#[test]
fn an_unset_version_leaves_a_versionless_command_versionless() {
    let result = app_with(None).run_with(
        versionless_command(),
        ["app", "--version"],
        standout::TargetProperties::detect(),
        standout::InputSources::from_process(),
    );

    assert_eq!(result.error_kind(), Some(RunErrorKind::ClapUsage));
    assert!(
        result.error().unwrap().contains("unexpected argument"),
        "a versionless command has no --version: {}",
        result.error().unwrap()
    );
}

#[test]
fn a_configured_version_wins_over_one_set_on_the_command() {
    let command = versionless_command().version("1.2.3");
    let result = app_with(Some("9.9.9")).run_with(
        command,
        ["app", "--version"],
        standout::TargetProperties::detect(),
        standout::InputSources::from_process(),
    );

    assert_eq!(result.output().unwrap().trim(), "app 9.9.9");
}

#[test]
fn a_configured_version_leaves_dispatch_alone() {
    let result = app_with(Some("9.9.9")).run_with(
        versionless_command(),
        ["app", "go"],
        standout::TargetProperties::detect(),
        standout::InputSources::from_process(),
    );

    assert_eq!(result.exit_status(), Some(ExitStatus::SUCCESS));
    assert_eq!(result.output(), Some("ok"));
}