sprawl-guard 0.1.0

Repository sprawl checker CLI.
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

use serde_json::{Value, json};

use super::common::{assert_exit_code, exit_codes, json_stdout, sprawl_guard_no_root, stderr};

fn command<'document>(document: &'document Value, path: &[&str]) -> &'document Value {
    document["commands"]
        .as_array()
        .unwrap()
        .iter()
        .find(|command| command["path"] == json!(path))
        .unwrap()
}

fn argument<'command>(command: &'command Value, id: &str) -> &'command Value {
    command["arguments"]
        .as_array()
        .unwrap()
        .iter()
        .find(|argument| argument["id"] == id)
        .unwrap()
}

mod when_the_hidden_cli_reference_generator_is_requested {
    use super::*;

    #[test]
    fn it_renders_the_public_mechanical_reference_as_json() {
        let output = sprawl_guard_no_root()
            .args(["machine", "generate-cli-reference-json"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert_eq!(stderr(&output), "");
        let document = json_stdout(&output);

        assert_eq!(document["schema_version"], 2);
        assert_eq!(
            argument(command(&document, &["sprawl-guard"]), "version")["syntax"],
            "-V, --version",
        );
        assert_eq!(
            argument(command(&document, &["sprawl-guard", "init"]), "languages")["syntax"],
            "--languages <LANGUAGES>",
        );
        assert_eq!(
            argument(command(&document, &["sprawl-guard", "check"]), "paths")["syntax"],
            "[PATHS]...",
        );
        assert_eq!(
            argument(command(&document, &["sprawl-guard", "check"]), "format")["possible_values"],
            json!([
                {"name": "human", "help": "Human-readable text output"},
                {"name": "json", "help": "JSON output"},
                {"name": "sarif", "help": "SARIF output"},
            ]),
        );
        assert_eq!(
            argument(
                command(&document, &["sprawl-guard", "check"]),
                "require_ratchet_current",
            )["conflicts_with"],
            json!(["--no-require-ratchet-current"]),
        );
    }

    #[test]
    fn it_omits_hidden_commands_and_claps_synthesized_help_tree() {
        let output = sprawl_guard_no_root()
            .args(["machine", "generate-cli-reference-json"])
            .output()
            .unwrap();
        let document = json_stdout(&output);
        let commands = document["commands"].as_array().unwrap();

        assert!(commands.iter().all(|command| {
            command["path"]
                .as_array()
                .unwrap()
                .iter()
                .all(|part| part != "help")
        }));
        assert!(commands.iter().all(|command| command["path"]
            != json!(["sprawl-guard", "machine", "generate-cli-reference-json"])));
    }
}