monochromatic-git-policy-cli 0.5.30

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
120
121
122
123
124
125
126
127
128
129

//! Binary-level controls for the ways a configuration could still make a Git the wrapper started run a program that a
//!  hook is: an alias that carries its own `-c` options and the editor of `git config --edit`; and the control that
//!  `core.fsmonitor` is left as configured.
//! Each control has a positive control that runs the same setup through real Git started directly and must write the
//!  marker, so an empty marker file proves the wrapper's options, not a setup that never fires.

use super::commit::{remove_settled, wrapped_commit};
use super::support::{Fixture, Observed, direct, executable, fixture, git, observe, repository, stderr_of};
use std::ffi::OsStr;
use std::path::PathBuf;

/// A repository with one commit, a branch `other`, and the file the programs write their markers to.
struct Scene {
    /// The working repository, on `main`.
    repo: PathBuf,
    /// The markers the programs write.
    markers: PathBuf,
}

/// Create the scene.
fn scene(fixture: &Fixture) -> Scene {
    let repo: PathBuf = repository(fixture, OsStr::new("repo"));
    git(fixture, repo.as_path(), &["branch", "other"]);
    return Scene { repo, markers: fixture.root.join("markers.txt") };
}

/// The markers written so far.
fn markers(scene: &Scene) -> String {
    return std::fs::read_to_string(&scene.markers).unwrap_or_default();
}

/// Write an executable `name` under the fixture that appends `word` to the markers, then runs `rest`.
fn program(fixture: &Fixture, scene: &Scene, name: &str, word: &str, rest: &str) -> PathBuf {
    let path: PathBuf = fixture.root.join(name);
    executable(
        path.as_path(),
        format!("#!/bin/sh\necho {word} >> '{}'\n{rest}\n", scene.markers.display()).as_bytes(),
    );
    return path;
}

/// Run a wrapped command in the scene's repository.
fn wrapped(fixture: &Fixture, scene: &Scene, arguments: &[&str]) -> Observed {
    return observe(&mut wrapped_commit(fixture, scene.repo.as_path(), arguments), b"");
}

/// Define a hook file and a configured hook for `post-checkout`, each writing its own marker.
fn post_checkout_hooks(fixture: &Fixture, scene: &Scene) -> PathBuf {
    let hooks: PathBuf = fixture.root.join("alias-hooks");
    std::fs::create_dir(&hooks).expect("hooks directory");
    executable(
        hooks.join("post-checkout").as_path(),
        format!("#!/bin/sh\necho file >> '{}'\n", scene.markers.display()).as_bytes(),
    );
    let configured: PathBuf = program(fixture, scene, "configured-hook", "configured", "");
    git(fixture, scene.repo.as_path(), &["config", "hook.control.event", "post-checkout"]);
    git(fixture, scene.repo.as_path(), &["config", "hook.control.command", configured.to_str().expect("UTF-8")]);
    return hooks;
}

/// An alias whose value carries `-c core.hooksPath` and `-c hook.post-checkout.enabled=true` cannot bring a hook back:
///  the wrapper hands Git the alias already expanded, so its options come after the alias's own.
#[test]
fn an_alias_that_carries_hook_options_cannot_bring_a_hook_back() {
    let fixture: Fixture = fixture("hooks-off-alias-escape");
    let scene: Scene = scene(&fixture);
    let hooks: PathBuf = post_checkout_hooks(&fixture, &scene);
    let value: String = format!(
        "-c core.hooksPath={} -c hook.post-checkout.enabled=true checkout --quiet other",
        hooks.display()
    );
    git(&fixture, scene.repo.as_path(), &["config", "alias.escape", value.as_str()]);
    let control = direct(&fixture).current_dir(&scene.repo).args(["escape"]).output().expect("git starts");
    assert!(control.status.success(), "{}", String::from_utf8_lossy(&control.stderr));
    let ran: String = markers(&scene);
    assert!(ran.contains("file") && ran.contains("configured"), "real Git must run both hooks: {ran:?}");
    std::fs::remove_file(&scene.markers).expect("clear the markers");
    git(&fixture, scene.repo.as_path(), &["checkout", "--quiet", "--force", "main"]);
    std::fs::remove_file(&scene.markers).expect("clear the markers of the reset");
    let switched: Observed = wrapped(&fixture, &scene, &["escape"]);
    assert_eq!(switched.code, Some(0), "{}", stderr_of(&switched));
    assert_eq!(markers(&scene), "", "no hook runs through an alias");
    remove_settled(&fixture);
}

/// `core.fsmonitor` is left as configured: a program it names is Git's own feature, not a hook of the wrapper's
///  report, and the per-event switch `hook.fsmonitor-watchman.enabled=false` the wrapper passes does not stop it.
#[test]
fn a_core_fsmonitor_program_is_left_as_configured() {
    let fixture: Fixture = fixture("hooks-off-fsmonitor");
    let scene: Scene = scene(&fixture);
    let monitor: PathBuf = program(&fixture, &scene, "fsmonitor", "fsmonitor", "exit 1");
    git(&fixture, scene.repo.as_path(), &["config", "core.fsmonitor", monitor.to_str().expect("UTF-8")]);
    let control = direct(&fixture).current_dir(&scene.repo).args(["status", "--short"]).output().expect("git starts");
    assert!(control.status.success());
    let direct_runs: String = markers(&scene);
    assert!(direct_runs.contains("fsmonitor"), "real Git must run the program");
    std::fs::remove_file(&scene.markers).expect("clear the markers");
    let switched: Observed = wrapped(&fixture, &scene, &["status", "--short"]);
    assert_eq!(switched.code, Some(0), "{}", stderr_of(&switched));
    assert_eq!(markers(&scene), direct_runs, "the wrapper must leave the program exactly as configured");
    assert!(!stderr_of(&switched).contains("external-hooks-unsupported"), "{}", stderr_of(&switched));
    remove_settled(&fixture);
}

/// The editor of `git config --edit` is a child of a wrapper-started Git, so a Git it starts directly inherits the
///  options and runs no hook; `git config` goes without the options only when it just reports configuration.
#[test]
fn a_git_started_by_the_config_editor_runs_no_hook() {
    let fixture: Fixture = fixture("hooks-off-config-edit");
    let scene: Scene = scene(&fixture);
    let configured: PathBuf = program(&fixture, &scene, "configured-hook", "configured", "");
    git(&fixture, scene.repo.as_path(), &["config", "hook.control.event", "post-checkout"]);
    git(&fixture, scene.repo.as_path(), &["config", "hook.control.command", configured.to_str().expect("UTF-8")]);
    let editor: PathBuf = program(&fixture, &scene, "editor", "editor", "/usr/bin/git checkout --quiet other");
    let mut control = direct(&fixture);
    control.current_dir(&scene.repo).args(["config", "--edit"]).env("GIT_EDITOR", &editor).env("TERM", "xterm");
    assert!(control.status().expect("git starts").success());
    assert!(markers(&scene).contains("configured"), "real Git must run the hook: {:?}", markers(&scene));
    std::fs::remove_file(&scene.markers).expect("clear the markers");
    git(&fixture, scene.repo.as_path(), &["checkout", "--quiet", "main"]);
    std::fs::remove_file(&scene.markers).expect("clear the markers of the reset");
    let mut command = wrapped_commit(&fixture, scene.repo.as_path(), &["config", "--edit"]);
    command.env("GIT_EDITOR", &editor).env("TERM", "xterm");
    let switched: Observed = observe(&mut command, b"");
    assert_eq!(switched.code, Some(0), "{}", stderr_of(&switched));
    assert_eq!(markers(&scene), "editor\n", "the editor ran and its Git ran no hook");
    remove_settled(&fixture);
}