monochromatic-git-policy-cli 0.5.14

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

//! Controls for the doctor's configuration findings against real repositories.

use super::*;
use crate::test_support::{fixture, git, git_context, remove, repository};

/// Configured hooks are found, listed one per line, and explained with the ways forward.
#[test]
fn configured_hooks_are_listed_and_explained() {
    let root: PathBuf = fixture("doctor-config-hooks");
    let repo: PathBuf = repository(root.as_path(), "repo");
    git(repo.as_path(), &["config", "hook.review.event", "post-commit"]);
    git(repo.as_path(), &["config", "hook.review.command", "run it"]);
    let findings: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert_eq!(findings.hooks.len(), 1);
    assert_eq!(render_hook_lines(&findings), "hook.review (events: post-commit)\n");
    let notes: String = render_notes(&findings);
    assert!(notes.contains("runs no program named by any configuration") && notes.contains("--unset-all"), "{notes}");
    assert!(!findings.retired_hooks_key);
    remove(root.as_path());
}

/// A repository with no hook and no `hooks` key has nothing to report.
#[test]
fn a_clean_repository_reports_nothing() {
    let root: PathBuf = fixture("doctor-config-clean");
    let repo: PathBuf = repository(root.as_path(), "repo");
    let findings: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert_eq!(render_hook_lines(&findings), "");
    assert_eq!(render_notes(&findings), "");
    remove(root.as_path());
}

/// The retired `indexLock` and `landing` keys are named with the remedy, each alone and both together, and a file
/// without them reports nothing.
#[test]
fn the_inert_index_lock_and_landing_keys_are_named_with_the_remedy() {
    let root: PathBuf = fixture("doctor-config-inert");
    let repo: PathBuf = repository(root.as_path(), "repo");
    let config: PathBuf = repo.join("cli-git.config.jsonc");
    std::fs::write(&config, "{ \"policies\": {} }\n").expect("config");
    let neither: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert!(!neither.retired_index_lock_key && !neither.retired_landing_key);
    assert_eq!(render_notes(&neither), "");
    std::fs::write(&config, "{ \"indexLock\": { \"unprovenOwnerTimeoutMs\": 5000 } }\n").expect("config");
    let lock_only: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert!(lock_only.retired_index_lock_key && !lock_only.retired_landing_key && !lock_only.retired_hooks_key);
    let lock_notes: String = render_notes(&lock_only);
    assert!(lock_notes.contains("`indexLock.unprovenOwnerTimeoutMs`") && lock_notes.contains("does nothing"), "{lock_notes}");
    assert!(lock_notes.contains("CLI_GIT_LOCK_WAIT_SECONDS") && lock_notes.contains("Remove the key"), "{lock_notes}");
    assert!(!lock_notes.contains("landing.reserveAfterLostRaces"), "{lock_notes}");
    std::fs::write(&config, "{ \"landing\": { \"reserveAfterLostRaces\": 3 } }\n").expect("config");
    let landing_only: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert!(landing_only.retired_landing_key && !landing_only.retired_index_lock_key);
    let landing_notes: String = render_notes(&landing_only);
    assert!(landing_notes.contains("`landing.reserveAfterLostRaces`") && landing_notes.contains("does nothing"), "{landing_notes}");
    assert!(landing_notes.contains("Remove the key") && !landing_notes.contains("indexLock"), "{landing_notes}");
    std::fs::write(
        &config,
        "{ \"hooks\": { \"concurrentCommits\": false }, \"indexLock\": { \"unprovenOwnerTimeoutMs\": 0 }, \"landing\": { \"reserveAfterLostRaces\": 1 } }\n",
    )
    .expect("config");
    let all: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert!(all.retired_hooks_key && all.retired_index_lock_key && all.retired_landing_key);
    let all_notes: String = render_notes(&all);
    assert_eq!(all_notes.lines().count(), 3, "one note per key: {all_notes}");
    remove(root.as_path());
}

/// The retired `hooks` key is accepted and reported as ignored, and an unreadable file is named.
#[test]
fn the_retired_key_and_a_broken_file_are_reported() {
    let root: PathBuf = fixture("doctor-config-retired");
    let repo: PathBuf = repository(root.as_path(), "repo");
    std::fs::write(repo.join("cli-git.config.jsonc"), "{ \"hooks\": { \"concurrentCommits\": true } }\n").expect("config");
    let findings: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert!(findings.retired_hooks_key);
    assert!(render_notes(&findings).contains("accepted so older files still load, and ignored"));
    std::fs::write(repo.join("cli-git.config.jsonc"), "{ not json").expect("config");
    let broken: ConfigFindings = config_findings(&git_context(), repo.as_path());
    assert!(!broken.retired_hooks_key);
    assert_eq!(render_notes(&broken), "");
    remove(root.as_path());
}