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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

//! Entry comparison and source-stability checks on real filesystem trees.

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

/// A file length that spans two comparison chunks with a short last chunk.
const LARGE_LENGTH: usize = 64 * 1_024 + 17;

/// One manifest entry for a path and kind, with the mode the path currently has.
fn entry_of(root: &Path, kind: EntryKind, relative_path: &str) -> WorktreeCopyEntry {
    let metadata: std::fs::Metadata =
        std::fs::symlink_metadata(root.join(relative_path)).expect("metadata");
    return WorktreeCopyEntry {
        kind,
        mode: retained_mode(&metadata),
        relative_path: String::from(relative_path),
    };
}

/// A missing path reads as absent and a present one reads as its metadata.
#[test]
fn lstat_distinguishes_absence_from_presence() {
    let root: PathBuf = fixture("compare-lstat");
    assert!(
        lstat_or_absent(root.join("missing").as_path())
            .expect("absent")
            .is_none()
    );
    std::fs::write(root.join("present"), b"x").expect("present");
    assert!(
        lstat_or_absent(root.join("present").as_path())
            .expect("present")
            .is_some()
    );
    remove(root.as_path());
}

/// An absent destination never matches, whatever the expected entry.
#[test]
fn absent_entry_never_matches() {
    let root: PathBuf = fixture("compare-absent");
    let stage: PathBuf = root.join("stage");
    std::fs::create_dir(stage.as_path()).expect("stage");
    std::fs::write(stage.join("file"), b"x").expect("staged");
    let target: PathBuf = root.join("target");
    std::fs::create_dir(target.as_path()).expect("target");
    let staged: WorktreeCopyEntry = entry_of(stage.as_path(), EntryKind::File, "file");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged).expect("compare"));
    remove(root.as_path());
}

/// A directory matches a directory with the same mode and nothing else; a file never matches a directory.
#[test]
fn directory_entries_compare_kind_and_mode() {
    let root: PathBuf = fixture("compare-directory");
    let stage: PathBuf = root.join("stage");
    std::fs::create_dir_all(stage.join("dir")).expect("stage dir");
    let target: PathBuf = root.join("target");
    std::fs::create_dir_all(target.join("dir")).expect("target dir");
    let staged: WorktreeCopyEntry = entry_of(stage.as_path(), EntryKind::Directory, "dir");
    assert!(entry_matches(stage.as_path(), target.as_path(), &staged).expect("same"));
    std::fs::remove_dir(target.join("dir")).expect("replace");
    std::fs::write(target.join("dir"), b"file").expect("file in place of directory");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged).expect("kind"));
    remove(root.as_path());
}

/// A file matches only identical bytes with the same mode; a different size, a different byte, or a different mode does not.
#[cfg(unix)]
#[test]
fn file_entries_compare_bytes_and_mode() {
    use std::os::unix::fs::PermissionsExt;
    let root: PathBuf = fixture("compare-file");
    let stage: PathBuf = root.join("stage");
    let target: PathBuf = root.join("target");
    std::fs::create_dir_all(stage.as_path()).expect("stage");
    std::fs::create_dir_all(target.as_path()).expect("target");
    std::fs::write(stage.join("file"), b"same bytes").expect("staged");
    std::fs::write(target.join("file"), b"same bytes").expect("target");
    let staged: WorktreeCopyEntry = entry_of(stage.as_path(), EntryKind::File, "file");
    assert!(entry_matches(stage.as_path(), target.as_path(), &staged).expect("equal"));
    std::fs::write(target.join("file"), b"same bytez").expect("one byte differs");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged).expect("byte"));
    std::fs::write(target.join("file"), b"longer than staged").expect("size differs");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged).expect("size"));
    std::fs::write(target.join("file"), b"same bytes").expect("restore bytes");
    std::fs::set_permissions(target.join("file"), std::fs::Permissions::from_mode(0o600))
        .expect("mode");
    std::fs::set_permissions(stage.join("file"), std::fs::Permissions::from_mode(0o644))
        .expect("staged mode");
    let staged_with_mode: WorktreeCopyEntry = entry_of(stage.as_path(), EntryKind::File, "file");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged_with_mode).expect("mode"));
    remove(root.as_path());
}

/// Files longer than one comparison chunk are compared chunk by chunk, and a difference in the last chunk is found.
#[test]
fn large_files_are_compared_across_chunks() {
    let root: PathBuf = fixture("compare-large");
    let stage: PathBuf = root.join("stage");
    let target: PathBuf = root.join("target");
    std::fs::create_dir_all(stage.as_path()).expect("stage");
    std::fs::create_dir_all(target.as_path()).expect("target");
    let mut bytes: Vec<u8> = vec![7; LARGE_LENGTH];
    std::fs::write(stage.join("big"), bytes.as_slice()).expect("staged");
    std::fs::write(target.join("big"), bytes.as_slice()).expect("target");
    let staged: WorktreeCopyEntry = entry_of(stage.as_path(), EntryKind::File, "big");
    assert!(entry_matches(stage.as_path(), target.as_path(), &staged).expect("equal"));
    let last: usize = bytes.len() - 1;
    bytes[last] = 8;
    std::fs::write(target.join("big"), bytes.as_slice()).expect("last byte");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged).expect("last chunk"));
    remove(root.as_path());
}

/// Symbolic links match on exact target text, not on what they resolve to.
#[cfg(unix)]
#[test]
fn symbolic_links_compare_target_text() {
    let root: PathBuf = fixture("compare-link");
    let stage: PathBuf = root.join("stage");
    let target: PathBuf = root.join("target");
    std::fs::create_dir_all(stage.as_path()).expect("stage");
    std::fs::create_dir_all(target.as_path()).expect("target");
    std::os::unix::fs::symlink("../shared", stage.join("link")).expect("staged link");
    std::os::unix::fs::symlink("../shared", target.join("link")).expect("same link");
    let staged: WorktreeCopyEntry = entry_of(stage.as_path(), EntryKind::Symlink, "link");
    assert!(entry_matches(stage.as_path(), target.as_path(), &staged).expect("same target"));
    std::fs::remove_file(target.join("link")).expect("remove");
    std::os::unix::fs::symlink("../other", target.join("link")).expect("other link");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged).expect("other target"));
    std::fs::remove_file(target.join("link")).expect("remove again");
    std::fs::write(target.join("link"), b"plain").expect("plain file");
    assert!(!entry_matches(stage.as_path(), target.as_path(), &staged).expect("not a link"));
    remove(root.as_path());
}

/// A source that still matches the stage passes the final check.
#[test]
fn unchanged_source_passes_final_check() {
    let root: PathBuf = fixture("compare-final-same");
    let source: PathBuf = root.join("source");
    std::fs::create_dir_all(source.join("cache")).expect("cache");
    std::fs::write(source.join("cache/file"), b"x").expect("file");
    let selected: Vec<String> = vec![String::from("cache")];
    let entries: Vec<WorktreeCopyEntry> =
        collect_entry_manifest(source.as_path(), selected.as_slice(), &[]).expect("manifest");
    let stage: PathBuf = root.join("stage");
    std::fs::create_dir_all(stage.join("cache")).expect("stage cache");
    std::fs::write(stage.join("cache/file"), b"x").expect("stage file");
    assert_final_source_equivalence(
        source.as_path(),
        stage.as_path(),
        selected.as_slice(),
        &[],
        entries.as_slice(),
    )
    .expect("unchanged");
    remove(root.as_path());
}

/// A source file that changed after the manifest blocks the destination with the changed entry named.
#[test]
fn changed_source_entry_fails_final_check() {
    let root: PathBuf = fixture("compare-final-changed");
    let source: PathBuf = root.join("source");
    std::fs::create_dir_all(source.join("cache")).expect("cache");
    std::fs::write(source.join("cache/file"), b"x").expect("file");
    let selected: Vec<String> = vec![String::from("cache")];
    let entries: Vec<WorktreeCopyEntry> =
        collect_entry_manifest(source.as_path(), selected.as_slice(), &[]).expect("manifest");
    let stage: PathBuf = root.join("stage");
    std::fs::create_dir_all(stage.join("cache")).expect("stage cache");
    std::fs::write(stage.join("cache/file"), b"x").expect("stage file");
    std::fs::write(source.join("cache/file"), b"y").expect("source changed");
    let failure: WorktreeCopyError = assert_final_source_equivalence(
        source.as_path(),
        stage.as_path(),
        selected.as_slice(),
        &[],
        entries.as_slice(),
    )
    .expect_err("changed");
    assert_eq!(
        failure.0,
        "cli-git: ignored source entry changed while copying: \"cache/file\"."
    );
    remove(root.as_path());
}

/// A source that gained an entry after the manifest blocks the destination by count.
#[test]
fn added_source_entry_fails_final_check_by_count() {
    let root: PathBuf = fixture("compare-final-count");
    let source: PathBuf = root.join("source");
    std::fs::create_dir_all(source.join("cache")).expect("cache");
    std::fs::write(source.join("cache/file"), b"x").expect("file");
    let selected: Vec<String> = vec![String::from("cache")];
    let entries: Vec<WorktreeCopyEntry> =
        collect_entry_manifest(source.as_path(), selected.as_slice(), &[]).expect("manifest");
    let stage: PathBuf = root.join("stage");
    std::fs::create_dir_all(stage.join("cache")).expect("stage cache");
    std::fs::write(stage.join("cache/file"), b"x").expect("stage file");
    std::fs::write(source.join("cache/added"), b"new").expect("added");
    let failure: WorktreeCopyError = assert_final_source_equivalence(
        source.as_path(),
        stage.as_path(),
        selected.as_slice(),
        &[],
        entries.as_slice(),
    )
    .expect_err("count");
    assert_eq!(
        failure.0,
        "cli-git: ignored source paths changed while snapshot was staged."
    );
    remove(root.as_path());
}