logbrew-cli 0.1.2

Public command-line interface for LogBrew.
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

//! CLI help text discovery tests.

use logbrew_cli::{HelpTopic, help};

#[test]
fn root_help_surfaces_release_environment_pairing() {
    let text = help::help_text(HelpTopic::Root);

    assert!(text.contains("logbrew read logs [--severity error] [--search checkout]"));
    assert!(text.contains("logbrew logs checkout failed [--severity error]"));
    assert!(text.contains("logbrew logs error checkout failed [--release <release>]"));
    assert!(text.contains("logbrew search checkout [--release <release>]"));
    assert!(text.contains("logbrew find checkout [--release <release>]"));
    assert!(text.contains("logbrew grep checkout [--release <release>]"));
    assert!(text.contains("logbrew latest logs [--limit 20] [--json]"));
    assert!(text.contains("logbrew last 10 logs [--json]"));
    assert!(text.contains("logbrew last 5 open issues [--json]"));
    assert!(text.contains("[--environment production] [--since 24h] [--json]"));
    assert!(text.contains("logbrew read issues [--release <release>] [--environment production]"));
    assert!(text.contains("logbrew issues open [--release <release>]"));
    assert!(text.contains("logbrew issue open [--release <release>]"));
    assert!(text.contains("logbrew open issues [--release <release>]"));
    assert!(text.contains("logbrew open issue [--release <release>]"));
    assert!(text.contains("logbrew errors closed [--release <release>]"));
    assert!(text.contains("logbrew read actions [--release <release>] [--environment production]"));
    assert!(text.contains("logbrew events checkout_failed"));
    assert!(text.contains(
        "logbrew read trace <trace_id> [--release <release>] [--environment production]"
    ));
    assert!(text.contains("logbrew trace <trace_id>"));
    assert!(text.contains("logbrew issue <issue_id>"));
    assert!(text.contains("logbrew explain trace <trace_id> [--json]"));
    assert!(text.contains("logbrew explain <issue_id_or_trace_id> [--json]"));
    assert!(text.contains("logbrew resolve <issue_id> [--json]"));
    assert!(text.contains("logbrew close <issue_id> [--json]"));
    assert!(text.contains("logbrew whoami [--json]"));
    assert!(text.contains("logbrew health [--json]"));
    assert!(text.contains("logbrew doctor [--json]"));
    assert!(text.contains(
        "Setup aliases (non-mutating plan): logbrew init, logbrew install, logbrew configure, \
         logbrew sdk."
    ));
    assert!(text.contains("Shortcuts: logbrew auth, logbrew whoami, logbrew me"));
    assert!(text.contains("Health aliases: logbrew status, logbrew health, logbrew ping"));
    assert!(text.contains("logbrew errors"));
    assert!(text.contains("logbrew logs checkout failed"));
    assert!(text.contains("logbrew logs error checkout"));
    assert!(text.contains("logbrew events"));
    assert!(text.contains("Read verbs: logbrew show logs, logbrew latest logs"));
    assert!(text.contains("logbrew last 10 logs"));
    assert!(text.contains(
        "Singular read aliases: logbrew read log, read release, show log, list issue, get release."
    ));
    assert!(text.contains("Pasted IDs: logbrew issue_123 or logbrew <trace_id>."));
    assert!(text.contains("JSON mode: logbrew --json status and logbrew status --json both work"));
    assert!(text.contains(
        "Topic help: logbrew logs --help, logbrew help logs, logbrew help read logs, or logbrew \
         help json."
    ));
}

#[test]
fn setup_help_advertises_first_contact_aliases() {
    let text = help::help_text(HelpTopic::Setup);

    assert!(text.contains("logbrew setup [--auto] [--yes] [--json]"));
    assert!(text.contains(
        "Aliases (same non-mutating plan): logbrew init, logbrew install, logbrew configure, \
         logbrew sdk."
    ));
    assert!(text.contains(
        "Options: --auto records automatic detection preference; --yes records confirmation \
         preference; --json prints stable setup JSON."
    ));
}

#[test]
fn read_help_advertises_singular_read_aliases() {
    let text = help::help_text(HelpTopic::Read);

    assert!(text.contains(
        "Singular read aliases: logbrew read log, read release, show log, list issue, get release."
    ));
    assert!(text.contains(
        "Recency counts are limit shortcuts: logbrew last 10 logs or logbrew recent 5 issues."
    ));
}

#[test]
fn log_help_advertises_unquoted_search_after_explicit_filters() {
    let text = help::help_text(HelpTopic::ReadLogs);

    assert!(text.contains("Recency counts are limit shortcuts, such as logbrew last 10 logs."));
    assert!(text.contains("logbrew logs --level error checkout failed"));
    assert!(text.contains("logbrew logs --severity warning checkout failed"));
    assert!(text.contains("Severity values are info, warning, error, and critical."));
    assert!(text.contains("logbrew logs --search checkout failed"));
    assert!(text.contains("logbrew logs -- --timeout --json"));
}

#[test]
fn issue_help_advertises_status_word_shortcuts() {
    let text = help::help_text(HelpTopic::ReadIssues);

    assert!(text.contains("logbrew issues open [--release <release>]"));
    assert!(text.contains("logbrew issue open [--release <release>]"));
    assert!(text.contains("logbrew open issues [--release <release>]"));
    assert!(text.contains("logbrew open issue [--release <release>]"));
    assert!(text.contains("logbrew last 5 open issues [--json]"));
    assert!(text.contains("logbrew errors closed [--release <release>]"));
    assert!(text.contains("Issue shortcuts accept status words"));
    assert!(text.contains("Recency issue shortcuts can include status and count"));
}