monochromatic-git-policy-cli 0.1.2

Repository-owned Git policy wrapper: forwards Git commands and checks commits against configured policies.
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
118
119

//! What:
//!  Encoding and field-order controls for wrapper-made JSONL events.
//! Why:
//!  Every event must be one valid JSON object on one line,
//!  whatever a path or
//!      configuration key contains,
//!  with the field order existing consumers saw.
//!
//! In TS you'd write (pseudocode):
//! ```ts
//! // expect(renderEngineFailure(0, 'config-invalid', 'x')).toBe(JSON.stringify({ ... }) + '\n');
//! ```

/// Import the rendering under test.
use super::{
    EngineFailureCode, LEGACY_CONFIG_IGNORED_CODE, SCHEMA_VERSION, engine_failure_code_name,
    json_string, render_configuration_warning, render_engine_failure,
};

/// Every code has the incumbent's wire spelling.
#[test]
fn failure_codes_have_stable_wire_spellings() {
    assert_eq!(SCHEMA_VERSION, 1);
    assert_eq!(LEGACY_CONFIG_IGNORED_CODE, "legacy-config-ignored");
    for (code, name) in [
        (EngineFailureCode::ConfigInvalid, "config-invalid"),
        (EngineFailureCode::CoreIncomplete, "core-incomplete"),
        (EngineFailureCode::ContentUnavailable, "content-unavailable"),
        (EngineFailureCode::PolicyIncomplete, "policy-incomplete"),
        (EngineFailureCode::PatchInvalid, "patch-invalid"),
        (EngineFailureCode::PatchConflict, "patch-conflict"),
        (EngineFailureCode::FixCycle, "fix-cycle"),
        (EngineFailureCode::FixPassLimit, "fix-pass-limit"),
        (EngineFailureCode::TransactionFailed, "transaction-failed"),
        (
            EngineFailureCode::IndexLockUnprovenOwner,
            "index-lock-unproven-owner",
        ),
    ] {
        assert_eq!(engine_failure_code_name(code), name);
    }
}

/// Strings are encoded exactly as `JSON.stringify` encodes them.
#[test]
fn json_strings_match_json_stringify() {
    for (input, expected) in [
        ("", r#""""#),
        ("plain", r#""plain""#),
        ("say \"hi\"", r#""say \"hi\"""#),
        ("back\\slash", r#""back\\slash""#),
        ("line\nfeed", r#""line\nfeed""#),
        ("carriage\rreturn", r#""carriage\rreturn""#),
        ("tab\tstop", r#""tab\tstop""#),
        ("\u{8}\u{c}", r#""\b\f""#),
        ("\u{0}\u{1}\u{1f}", r#""\u0000\u0001\u001f""#),
        ("\u{b}", r#""\u000b""#),
        // The first character that needs no escape, DEL, and non-ASCII text pass through.
        (" \u{7f}é\u{2028}\u{1F600}", "\" \u{7f}é\u{2028}\u{1F600}\""),
        ("</script>'", r#""</script>'""#),
        (
            "\"}\n{\"type\":\"finding\"",
            r#""\"}\n{\"type\":\"finding\"""#,
        ),
    ] {
        assert_eq!(json_string(input), expected, "{input:?}");
    }
}

/// An engine failure is one line with the incumbent field order.
#[test]
fn engine_failure_is_one_compact_line() {
    assert_eq!(
        render_engine_failure(
            0,
            EngineFailureCode::ConfigInvalid,
            "Unknown configuration key: x."
        ),
        "{\"schemaVersion\":1,\"sequence\":0,\"type\":\"engine-failure\",\"code\":\"config-invalid\",\"message\":\"Unknown configuration key: x.\"}\n"
    );
    assert_eq!(
        render_engine_failure(7, EngineFailureCode::TransactionFailed, ""),
        "{\"schemaVersion\":1,\"sequence\":7,\"type\":\"engine-failure\",\"code\":\"transaction-failed\",\"message\":\"\"}\n"
    );
    // A message that tries to end the string, the object and the line stays inside one string.
    let hostile: String = render_engine_failure(
        18_446_744_073_709_551_615,
        EngineFailureCode::ConfigInvalid,
        "/repo/a\"}\n{\"type\":\"finding\"}\\",
    );
    assert_eq!(
        hostile,
        "{\"schemaVersion\":1,\"sequence\":18446744073709551615,\"type\":\"engine-failure\",\"code\":\"config-invalid\",\"message\":\"/repo/a\\\"}\\n{\\\"type\\\":\\\"finding\\\"}\\\\\"}\n"
    );
    assert_eq!(hostile.matches('\n').count(), 1);
    assert!(hostile.ends_with("}\n"));
}

/// A configuration warning is one line carrying code,
///  message and path,
///  each encoded.
#[test]
fn configuration_warning_is_one_compact_line() {
    assert_eq!(
        render_configuration_warning(
            2,
            LEGACY_CONFIG_IGNORED_CODE,
            "Legacy configuration is ignored.",
            "/repo/cli-git.config.ts"
        ),
        "{\"schemaVersion\":1,\"sequence\":2,\"type\":\"configuration-warning\",\"code\":\"legacy-config-ignored\",\"message\":\"Legacy configuration is ignored.\",\"path\":\"/repo/cli-git.config.ts\"}\n"
    );
    let hostile: String = render_configuration_warning(0, "a\"b", "m\nn", "p\\q\t");
    assert_eq!(
        hostile,
        "{\"schemaVersion\":1,\"sequence\":0,\"type\":\"configuration-warning\",\"code\":\"a\\\"b\",\"message\":\"m\\nn\",\"path\":\"p\\\\q\\t\"}\n"
    );
    assert_eq!(hostile.matches('\n').count(), 1);
}