girt 0.10.0

An incremental, idiomatic Rust implementation of Git
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
#![warn(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    clippy::unreachable,
    clippy::indexing_slicing,
    reason = "parses untrusted repository or network input (#103)"
)]
use std::cmp::Ordering;
use std::collections::HashSet;

use crate::ObjectId;

/// An owned, in-memory Git tree in an explicitly selected object format: names, modes, and
/// references to other objects.
///
/// A tree payload can be readable even when its entries violate tree rules. For example, two
/// records can both name `hello.txt`, or their names can be out of Git order. Inspection tools need
/// to read those records to report the problem, and an object's identity depends on its exact
/// encoded bytes, including entry order. Sorting or removing entries would create a different
/// object; rejecting them during parsing would prevent inspection through this API.
///
/// The operations therefore make separate promises:
///
/// - [`Tree::parse`] decodes supported records and preserves their bytes. Success means the modes,
///   delimiters, and format-sized IDs can be read; it does not establish valid names or ordering.
/// - [`Tree::validate`] checks component names, uniqueness, and Git order without changing entries.
///   Use it after parsing when your operation requires those properties. Inspection, hashing, and
///   exact re-encoding do not require it.
/// - [`Tree::new`] constructs a tree from caller-supplied entries. It rejects invalid or duplicate
///   names and sorts entries into Git order. Its result already passes validation.
///
/// A parsed tree remains available when validation fails, so callers can inspect its entries and
/// decide what to report or repair. A caller choosing to reconstruct it with [`Tree::new`] must
/// expect a changed identity if sorting changes the payload; invalid or duplicate names still need
/// an explicit correction. Validation returns a result, not a new type or a repaired tree.
///
/// Parsing interprets octal modes by type and owner-execute bits, including historical permission
/// bits and leading zeros. Other numeric types follow Git's gitlink interpretation. Only the low
/// mode bits affect interpretation; arbitrarily padded or large octal text is accepted, while
/// non-octal digits are rejected. [`Tree::new`] emits canonical [`EntryMode`] spellings. Every
/// accepted payload encodes byte-for-byte unchanged.
///
/// Names are bytes, without UTF-8 conversion. No operation resolves object references or checks
/// their existence or type. This API does not traverse directories, access storage, validate
/// checkout safety on a particular filesystem. Memory use is proportional
/// to the supplied payload; callers must bound input size when reading untrusted objects.
/// [`crate::LooseObjects::read_tree`] provides a payload limit for loose storage.
/// Use [`crate::LooseObjects::write_tree`] to store an existing tree without normalization.
///
/// ```
/// use girt::{EntryMode, ObjectId, Tree, TreeEntry};
///
/// let tree = Tree::new(
///     girt::ObjectFormat::Sha1,
///     vec![TreeEntry {
///         mode: EntryMode::Blob,
///         name: b"hello.txt".to_vec(),
///         id: ObjectId::for_blob(girt::ObjectFormat::Sha1, b"hello\n"),
///     }],
/// )?;
///
/// let payload = tree.encode();
/// let parsed = Tree::parse(girt::ObjectFormat::Sha1, &payload)?;
///
/// // Require valid names and ordering when accepting a payload from another source.
/// // This check is redundant for the unchanged encoding of Tree::new above.
/// parsed.validate()?;
///
/// assert_eq!(parsed.entries()[0].name, b"hello.txt");
/// assert_eq!(parsed.id(), tree.id());
/// # Ok::<(), girt::TreeError>(())
/// ```
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Tree {
    format: crate::ObjectFormat,
    entries: Vec<TreeEntry>,
    original: Vec<u8>,
}

impl Tree {
    /// Consumes entries in the selected format, validates them, and sorts them into Git's tree
    /// order.
    ///
    /// # Errors
    ///
    /// Returns [`TreeError::InvalidName`] for empty names, NUL, `/`, `.` or `..`, and
    /// [`TreeError::DuplicateName`] for repeated byte-identical names, regardless of mode.
    /// Names such as `.git` and platform-specific aliases are not checked: this is structural
    /// validation, not a complete `git fsck` or checkout-safety check. Object IDs are not validated
    /// against a database, and even all-zero IDs are preserved. Foreign-format IDs return
    /// [`TreeError::ObjectFormat`] before encoding.
    pub fn new(
        format: crate::ObjectFormat,
        mut entries: Vec<TreeEntry>,
    ) -> Result<Self, TreeError> {
        for entry in &entries {
            entry.id.require_format(format)?;
        }
        validate_names(&entries)?;
        entries.sort_by(TreeEntry::git_cmp);
        let original = encode_entries(&entries);
        let tree = Self {
            format,
            entries,
            original,
        };
        Ok(tree)
    }

    /// Parses a tree payload, excluding the `tree <length>\0` object header.
    ///
    /// Copies names and IDs into owned entries. Does not sort or validate names or duplicates;
    /// [`Tree::validate`] provides that separate check. This allows inspection of readable but
    /// invalid trees, such as those containing duplicate names. Every accepted payload
    /// round-trips exactly.
    ///
    /// # Errors
    ///
    /// Returns an error for a missing mode/name delimiter, unsupported or malformed mode spelling,
    /// or fewer than `format.digest_len()` bytes for an entry's ID. The caller must select the
    /// payload's format; these binary records have no reliable format autodetection. Empty trees
    /// also retain the selected format for hashing.
    pub fn parse(format: crate::ObjectFormat, payload: &[u8]) -> Result<Self, TreeError> {
        let original = payload.to_vec();
        let mut entries = Vec::new();
        for entry in RawEntries::new(format, payload) {
            let (mode, name, id) = entry?;
            entries.push(TreeEntry {
                mode,
                name: name.to_vec(),
                id,
            });
        }

        Ok(Self {
            format,
            entries,
            original,
        })
    }

    /// The format selected for this tree, including an empty tree.
    pub fn object_format(&self) -> crate::ObjectFormat {
        self.format
    }

    /// Borrows entries in their stored order, without allowing mutation of the tree.
    pub fn entries(&self) -> &[TreeEntry] {
        &self.entries
    }

    /// Checks structural names, unique names, and Git order without changing the tree.
    ///
    /// Call this after [`Tree::parse`] when accepting a tree for operations that rely on these
    /// properties. It is unnecessary for inspection or exact re-encoding, and redundant for a tree
    /// returned by [`Tree::new`]. Returns `Ok(())` on success; on failure, the tree remains
    /// available for inspection. Does not repair entries or check object references or checkout
    /// safety.
    ///
    /// # Errors
    ///
    /// Returns the name errors documented by [`Tree::new`], or [`TreeError::Unsorted`] if entries
    /// are out of Git order. The same object-reference and checkout-safety exclusions apply.
    pub fn validate(&self) -> Result<(), TreeError> {
        validate_names(&self.entries)?;

        if !self.entries.is_sorted_by(|a, b| a.git_cmp(b).is_le()) {
            return Err(TreeError::Unsorted);
        }

        Ok(())
    }

    /// Encodes the payload as repeated `mode SP name NUL raw-id` records.
    ///
    /// Returns an owned buffer without an object header or compression. Preserves parsed order and
    /// names even when [`Tree::validate`] would fail; never silently repairs an existing object.
    pub fn encode(&self) -> Vec<u8> {
        self.original.clone()
    }

    /// Hashes `tree <decimal payload length>\0` followed by the exact encoded payload.
    ///
    /// Hashes retained bytes directly without validation, normalization, or a temporary buffer.
    pub fn id(&self) -> ObjectId {
        self.format
            .hash_object(crate::ObjectKind::Tree, &self.original)
    }
}

fn encode_entries(entries: &[TreeEntry]) -> Vec<u8> {
    let mut payload = Vec::new();
    for entry in entries {
        payload.extend_from_slice(entry.mode.bytes());
        payload.push(b' ');
        payload.extend_from_slice(&entry.name);
        payload.push(0);
        payload.extend_from_slice(entry.id.as_bytes());
    }
    payload
}

/// Entries of a tree payload in stored order, borrowing their names.
///
/// Yields exactly what [`Tree::parse`] accepts and stops after the first error, which is the
/// error `Tree::parse` returns. Walks over many trees use this to avoid copying each payload and
/// name.
pub(crate) struct RawEntries<'a> {
    format: crate::ObjectFormat,
    payload: &'a [u8],
}

impl<'a> RawEntries<'a> {
    pub(crate) fn new(format: crate::ObjectFormat, payload: &'a [u8]) -> Self {
        Self { format, payload }
    }

    fn parse_one(&mut self) -> Result<(EntryMode, &'a [u8], ObjectId), TreeError> {
        let (mode, rest) =
            crate::bytes::split_once(self.payload, b' ').ok_or(TreeError::MissingModeDelimiter)?;
        let mode = EntryMode::parse(mode)?;
        let (name, rest) =
            crate::bytes::split_once(rest, 0).ok_or(TreeError::MissingNameDelimiter)?;
        let (raw_id, rest) = rest
            .split_at_checked(self.format.digest_len())
            .ok_or(TreeError::TruncatedObjectId)?;
        let id =
            ObjectId::from_bytes(self.format, raw_id).map_err(|_| TreeError::TruncatedObjectId)?;
        self.payload = rest;
        Ok((mode, name, id))
    }
}

impl<'a> Iterator for RawEntries<'a> {
    type Item = Result<(EntryMode, &'a [u8], ObjectId), TreeError>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.payload.is_empty() {
            return None;
        }
        let entry = self.parse_one();
        if entry.is_err() {
            self.payload = &[];
        }
        Some(entry)
    }
}

/// One tree entry, with an uninterpreted byte name and a format-bearing reference.
///
/// Fields are freely editable before construction. [`Tree::new`] checks names and duplicates.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct TreeEntry {
    /// The entry's Git type and executable status.
    pub mode: EntryMode,

    /// A single path component as bytes, without text conversion.
    pub name: Vec<u8>,

    /// Referenced blob, tree, or commit identity; existence and type are not checked.
    pub id: ObjectId,
}

impl TreeEntry {
    /// Compares names using Git's byte order, treating a tree's name as ending in `/`.
    ///
    /// Other modes, including gitlinks, use a NUL terminator. IDs do not affect order. For example,
    /// file `a.c` precedes tree `a`, which precedes file `a0`. This does not validate names; the
    /// Git ordering contract applies to valid single-component names.
    pub fn git_cmp(&self, other: &Self) -> Ordering {
        let left = self
            .name
            .iter()
            .copied()
            .chain(std::iter::once(self.mode.terminator()));
        let right = other
            .name
            .iter()
            .copied()
            .chain(std::iter::once(other.mode.terminator()));

        left.cmp(right)
    }
}

/// Supported modes with their exact octal spelling in an encoded tree payload.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[non_exhaustive]
pub enum EntryMode {
    /// Regular, non-executable blob (`100644`).
    Blob,
    /// Executable blob (`100755`).
    Executable,
    /// Symbolic link whose target bytes are stored in a blob (`120000`).
    Symlink,
    /// Subtree (`40000`, without a leading zero).
    Tree,
    /// Submodule commit reference (`160000`); ordered like a file, not a subtree.
    Gitlink,
}

impl EntryMode {
    fn bytes(self) -> &'static [u8] {
        match self {
            Self::Blob => b"100644",
            Self::Executable => b"100755",
            Self::Symlink => b"120000",
            Self::Tree => b"40000",
            Self::Gitlink => b"160000",
        }
    }

    fn parse(bytes: &[u8]) -> Result<Self, TreeError> {
        if bytes.is_empty() {
            return Err(TreeError::UnsupportedMode);
        }
        let mut mode = 0u32;
        for &byte in bytes {
            if !(b'0'..=b'7').contains(&byte) {
                return Err(TreeError::UnsupportedMode);
            }
            mode = mode.wrapping_mul(8).wrapping_add(u32::from(byte - b'0'));
        }
        // Interpret the type and owner-execute bit as Git's tree readers do.
        Ok(match mode & 0o170000 {
            0o040000 => Self::Tree,
            0o100000 if mode & 0o100 != 0 => Self::Executable,
            0o100000 => Self::Blob,
            0o120000 => Self::Symlink,
            _ => Self::Gitlink,
        })
    }

    fn terminator(self) -> u8 {
        if self == Self::Tree { b'/' } else { 0 }
    }
}

/// A tree payload could not be parsed, or entries failed structural validation.
#[derive(Clone, Copy, Debug, Eq, PartialEq, thiserror::Error)]
#[non_exhaustive]
pub enum TreeError {
    /// An entry identity differs from the selected tree format.
    #[error(transparent)]
    ObjectFormat(#[from] crate::ObjectFormatError),
    /// No space separates the mode from the name.
    #[error("missing tree mode delimiter")]
    MissingModeDelimiter,
    /// The mode is empty or contains non-octal bytes.
    #[error("unsupported or malformed tree entry mode")]
    UnsupportedMode,
    /// No NUL separates the name from the raw identity.
    #[error("missing tree name delimiter")]
    MissingNameDelimiter,
    /// Fewer than the selected format's raw identity bytes follow the name delimiter.
    #[error("truncated tree entry object identity")]
    TruncatedObjectId,
    /// A name is empty, contains NUL or `/`, or is `.` or `..`.
    #[error("invalid tree entry name")]
    InvalidName,
    /// Two entries have byte-identical names, even if their modes differ.
    #[error("duplicate tree entry name")]
    DuplicateName,
    /// Entries are not in Git's tree order.
    #[error("tree entries are not in Git order")]
    Unsorted,
}

fn validate_names(entries: &[TreeEntry]) -> Result<(), TreeError> {
    let mut names = HashSet::with_capacity(entries.len());

    for entry in entries {
        let name = entry.name.as_slice();
        if name.is_empty()
            || name.contains(&0)
            || name.contains(&b'/')
            || name == b"."
            || name == b".."
        {
            return Err(TreeError::InvalidName);
        }

        // Duplicate file/tree names need not be adjacent in Git order (a, a.c, a/).
        if !names.insert(name) {
            return Err(TreeError::DuplicateName);
        }
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use rstest::rstest;

    use super::*;

    fn entry(mode: EntryMode, name: &[u8]) -> TreeEntry {
        TreeEntry {
            mode,
            name: name.to_vec(),
            id: ObjectId::Sha1([0x81; 20]),
        }
    }

    // Literal framing plus a fixed identity keeps expected bytes independent of the encoder.
    fn record(prefix: &[u8]) -> Vec<u8> {
        [prefix, &[0x81; 20]].concat()
    }

    #[rstest]
    #[case::mode_without_space(b"100644".as_slice(), TreeError::MissingModeDelimiter)]
    #[case::name_without_nul(b"100644 a", TreeError::MissingNameDelimiter)]
    #[case::delimiters_at_end(b"100644 \0", TreeError::TruncatedObjectId)]
    #[case::short_id(&[b"100644 a\0".as_slice(), &[0x81; 19]].concat(), TreeError::TruncatedObjectId)]
    fn rejects_truncated_entry(#[case] payload: &[u8], #[case] expected: TreeError) {
        assert_eq!(
            Tree::parse(crate::ObjectFormat::Sha1, payload),
            Err(expected)
        );
    }

    #[test]
    fn empty_tree_has_git_identity() {
        let tree = Tree::new(crate::ObjectFormat::Sha1, vec![]).unwrap();

        assert_eq!(tree.encode(), b"");
        assert_eq!(Tree::parse(crate::ObjectFormat::Sha1, b"").unwrap(), tree);
        assert_eq!(tree.validate(), Ok(()));
        assert_eq!(
            tree.id().to_string(),
            "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
        );
    }

    #[rstest]
    #[case::regular(EntryMode::Blob, b"100644 a\0")]
    #[case::executable(EntryMode::Executable, b"100755 a\0")]
    #[case::symlink(EntryMode::Symlink, b"120000 a\0")]
    #[case::directory(EntryMode::Tree, b"40000 a\0")]
    #[case::gitlink(EntryMode::Gitlink, b"160000 a\0")]
    fn preserves_supported_modes(#[case] mode: EntryMode, #[case] prefix: &[u8]) {
        let expected = record(prefix);
        let tree = Tree::new(crate::ObjectFormat::Sha1, vec![entry(mode, b"a")]).unwrap();

        assert_eq!(tree.encode(), expected);
        assert_eq!(
            Tree::parse(crate::ObjectFormat::Sha1, &expected)
                .unwrap()
                .entries(),
            &[entry(mode, b"a")]
        );
    }

    /// Delimiters inside the fixed-width ID must not split records or shift the next entry.
    #[test]
    fn preserves_delimiter_bytes_inside_object_id() {
        let raw_id = *b"\0 abcdefghijklmnop\0 ";
        let payload = [
            b"100644 a\0".as_slice(),
            &raw_id,
            b"100755 b\0",
            &[0x81; 20],
        ]
        .concat();

        let tree = Tree::parse(crate::ObjectFormat::Sha1, &payload).unwrap();

        assert_eq!(
            tree.entries(),
            &[
                TreeEntry {
                    mode: EntryMode::Blob,
                    name: b"a".to_vec(),
                    id: ObjectId::Sha1(raw_id),
                },
                entry(EntryMode::Executable, b"b"),
            ]
        );
        assert_eq!(tree.encode(), payload);
        assert_eq!(tree.validate(), Ok(()));
    }

    #[rstest]
    #[case::non_utf8(b"\xff\x80")]
    #[case::whitespace(b"a b\t\n")]
    #[case::backslash(b"a\\b")]
    fn preserves_name_bytes(#[case] name: &[u8]) {
        let expected = [b"100644 ".as_slice(), name, b"\0", &[0x81; 20]].concat();
        let tree = Tree::new(
            crate::ObjectFormat::Sha1,
            vec![entry(EntryMode::Blob, name)],
        )
        .unwrap();

        assert_eq!(tree.encode(), expected);
        assert_eq!(
            Tree::parse(crate::ObjectFormat::Sha1, &expected)
                .unwrap()
                .entries()[0]
                .name,
            name
        );
    }

    #[rstest]
    #[case::file_prefix(EntryMode::Blob, b"a", EntryMode::Blob, b"a.c")]
    #[case::directory_after_dot(EntryMode::Blob, b"a.c", EntryMode::Tree, b"a")]
    #[case::directory_before_zero(EntryMode::Tree, b"a", EntryMode::Blob, b"a0")]
    #[case::longer_directory(EntryMode::Tree, b"a", EntryMode::Tree, b"aa")]
    #[case::gitlink_is_file(EntryMode::Gitlink, b"a", EntryMode::Blob, b"a.c")]
    #[case::symlink_is_file(EntryMode::Symlink, b"a", EntryMode::Tree, b"a")]
    #[case::unsigned_bytes(EntryMode::Blob, b"z", EntryMode::Blob, b"\x80")]
    fn compares_git_names(
        #[case] left_mode: EntryMode,
        #[case] left_name: &[u8],
        #[case] right_mode: EntryMode,
        #[case] right_name: &[u8],
    ) {
        let left = entry(left_mode, left_name);
        let right = entry(right_mode, right_name);

        assert_eq!(left.git_cmp(&right), Ordering::Less);
        assert_eq!(right.git_cmp(&left), Ordering::Greater);
    }

    #[test]
    fn sorts_file_and_directory_prefixes() {
        let tree = Tree::new(
            crate::ObjectFormat::Sha1,
            vec![
                entry(EntryMode::Blob, b"a0"),
                entry(EntryMode::Tree, b"a"),
                entry(EntryMode::Blob, b"a.c"),
            ],
        )
        .unwrap();
        let names: Vec<_> = tree
            .entries()
            .iter()
            .map(|entry| entry.name.as_slice())
            .collect();

        assert_eq!(names, [b"a.c".as_slice(), b"a", b"a0"]);
        assert_eq!(tree.validate(), Ok(()));
    }

    #[rstest]
    #[case::empty(b"")]
    #[case::nul(b"a\0b")]
    #[case::slash(b"a/b")]
    #[case::dot(b".")]
    #[case::dot_dot(b"..")]
    fn rejects_invalid_new_names(#[case] name: &[u8]) {
        assert_eq!(
            Tree::new(
                crate::ObjectFormat::Sha1,
                vec![entry(EntryMode::Blob, name)]
            ),
            Err(TreeError::InvalidName)
        );
    }

    #[rstest]
    #[case::empty(b"100644 \0")]
    #[case::slash(b"100644 a/b\0")]
    #[case::dot(b"100644 .\0")]
    #[case::dot_dot(b"100644 ..\0")]
    fn parses_invalid_names_without_repair(#[case] prefix: &[u8]) {
        let payload = record(prefix);
        let tree = Tree::parse(crate::ObjectFormat::Sha1, &payload).unwrap();

        assert_eq!(tree.encode(), payload);
        assert_eq!(tree.validate(), Err(TreeError::InvalidName));
    }

    #[test]
    fn preserves_unsorted_input_until_explicit_reconstruction() {
        let payload = [record(b"40000 a\0"), record(b"100644 a.c\0")].concat();
        let tree = Tree::parse(crate::ObjectFormat::Sha1, &payload).unwrap();

        assert_eq!(tree.encode(), payload);
        assert_eq!(tree.validate(), Err(TreeError::Unsorted));

        let rebuilt = Tree::new(crate::ObjectFormat::Sha1, tree.entries().to_vec()).unwrap();

        assert_eq!(rebuilt.entries()[0].name, b"a.c");
        assert_ne!(rebuilt.id(), tree.id());
    }

    #[rstest]
    #[case::same_mode(b"100644 a\0")]
    #[case::different_mode(b"40000 a\0")]
    fn detects_duplicate_names_even_when_nonadjacent(#[case] last: &[u8]) {
        let payload = [record(b"100644 a\0"), record(b"100644 a.c\0"), record(last)].concat();
        let tree = Tree::parse(crate::ObjectFormat::Sha1, &payload).unwrap();

        assert_eq!(tree.encode(), payload);
        assert_eq!(tree.validate(), Err(TreeError::DuplicateName));
        assert_eq!(
            Tree::new(crate::ObjectFormat::Sha1, tree.entries().to_vec()),
            Err(TreeError::DuplicateName)
        );
    }

    #[rstest]
    #[case::empty(b" a\0")]
    #[case::non_octal(b"100648 a\0")]
    #[case::negative(b"-100644 a\0")]
    fn rejects_unsupported_mode_spellings(#[case] prefix: &[u8]) {
        assert_eq!(
            Tree::parse(crate::ObjectFormat::Sha1, &record(prefix)),
            Err(TreeError::UnsupportedMode)
        );
    }

    #[rstest]
    #[case::missing_space(b"100644", TreeError::MissingModeDelimiter)]
    #[case::missing_nul(b"100644 name", TreeError::MissingNameDelimiter)]
    #[case::no_id(b"100644 a\0", TreeError::TruncatedObjectId)]
    #[case::short_id(b"100644 a\0abcdefghijklmnopqrs", TreeError::TruncatedObjectId)]
    fn rejects_incomplete_records(#[case] payload: &[u8], #[case] error: TreeError) {
        assert_eq!(Tree::parse(crate::ObjectFormat::Sha1, payload), Err(error));
    }

    #[test]
    fn rejects_trailing_partial_entry() {
        let payload = [record(b"100644 a\0"), b"100644 b\0short".to_vec()].concat();

        assert_eq!(
            Tree::parse(crate::ObjectFormat::Sha1, &payload),
            Err(TreeError::TruncatedObjectId)
        );
    }
}

#[cfg(test)]
mod format_boundary_tests {
    use super::*;

    #[test]
    fn rejects_sha256_entry_before_encoding() {
        let result = Tree::new(
            crate::ObjectFormat::Sha1,
            vec![TreeEntry {
                mode: EntryMode::Blob,
                name: b"a".to_vec(),
                id: ObjectId::Sha256([1; 32]),
            }],
        );
        assert!(matches!(result, Err(TreeError::ObjectFormat(_))));
    }
}

#[cfg(test)]
mod dual_format_tests {
    use rstest::rstest;

    use super::*;
    use crate::ObjectFormat;

    #[rstest]
    #[case::sha1(ObjectFormat::Sha1, "4b825dc642cb6eb9a060e54bf8d69288fbee4904")]
    #[case::sha256(
        ObjectFormat::Sha256,
        "6ef19b41225c5369f1c104d45d8d85efa9b057b53b14b4b9b939dd74decc5321"
    )]
    fn empty_tree_retains_selected_identity(#[case] format: ObjectFormat, #[case] expected: &str) {
        let tree = Tree::new(format, vec![]).unwrap();
        assert_eq!(tree.id().to_string(), expected);
        assert_eq!(Tree::parse(format, b"").unwrap(), tree);
    }

    #[rstest]
    #[case::sha1(ObjectFormat::Sha1)]
    #[case::sha256(ObjectFormat::Sha256)]
    fn truncated_digest_is_rejected(#[case] format: ObjectFormat) {
        let mut bytes = b"160000 submodule\0".to_vec();
        bytes.extend(vec![1; format.digest_len() - 1]);
        assert_eq!(
            Tree::parse(format, &bytes),
            Err(TreeError::TruncatedObjectId)
        );
    }

    #[test]
    fn sha256_tree_rejects_sha1_gitlink() {
        assert!(matches!(
            Tree::new(
                ObjectFormat::Sha256,
                vec![TreeEntry {
                    mode: EntryMode::Gitlink,
                    name: b"submodule".to_vec(),
                    id: ObjectId::Sha1([1; 20])
                }]
            ),
            Err(TreeError::ObjectFormat(_))
        ));
    }
}