type Result = std::result::Result<(), Box<dyn std::error::Error>>;
mod reference {
use super::Result;
use crate::{
FullNameRef,
store_impl::{packed, packed::decode},
};
const HASH_KIND: gix_hash::Kind = gix_hash::Kind::Sha1;
fn hex_to_id(hex: &str) -> gix_hash::ObjectId {
gix_hash::ObjectId::from_hex(hex.as_bytes()).expect("40 bytes hex")
}
#[test]
fn invalid() {
let mut input = b"# what looks like a comment".as_slice();
assert!(decode::reference(&mut input, HASH_KIND).is_err());
let mut input = b"^e9cdc958e7ce2290e2d7958cdb5aa9323ef35d37\n".as_slice();
assert!(decode::reference(&mut input, HASH_KIND).is_err(), "lonely peel");
let mut input =
b"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa refs/heads/main\n".as_slice();
assert!(
decode::reference(&mut input, gix_hash::Kind::Sha1).is_err(),
"sha1 refs reject sha256-sized ids"
);
let mut input = b"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa refs/heads/main\n".as_slice();
assert!(
decode::reference(&mut input, gix_hash::Kind::Sha256).is_err(),
"sha256 refs reject sha1-sized ids"
);
}
#[test]
fn uppercase_hex() -> Result {
let mut input: &[u8] = b"D53C4B0F91F1B29769C9430F2D1C0BCAB1170C75 refs/heads/uppercase
^E9CDC958E7CE2290E2D7958CDB5AA9323EF35D37\n";
let parsed = decode::reference(&mut input, HASH_KIND).unwrap();
assert!(input.is_empty(), "exhausted");
assert_eq!(parsed.name, FullNameRef::new_unchecked("refs/heads/uppercase".into()));
assert_eq!(parsed.target(), hex_to_id("d53c4b0f91f1b29769c9430f2d1c0bcab1170c75"));
assert_eq!(parsed.object(), hex_to_id("e9cdc958e7ce2290e2d7958cdb5aa9323ef35d37"));
Ok(())
}
#[test]
fn sha256_hex() -> Result {
let mut input: &[u8] = b"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa refs/heads/main\n";
let parsed = decode::reference(&mut input, gix_hash::Kind::Sha256).unwrap();
assert!(input.is_empty(), "exhausted");
assert_eq!(parsed.name, FullNameRef::new_unchecked("refs/heads/main".into()));
assert_eq!(parsed.target().kind(), gix_hash::Kind::Sha256);
Ok(())
}
#[test]
fn two_refs_in_a_row() -> Result {
let mut input: &[u8] = b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75 refs/heads/alternates-after-packs-and-loose
^e9cdc958e7ce2290e2d7958cdb5aa9323ef35d37\neaae9c1bc723209d793eb93f5587fa2604d5cd92 refs/heads/avoid-double-lookup\n";
let parsed = decode::reference(&mut input, HASH_KIND).unwrap();
assert_eq!(
parsed,
packed::Reference {
name: FullNameRef::new_unchecked("refs/heads/alternates-after-packs-and-loose".into()),
target: "d53c4b0f91f1b29769c9430f2d1c0bcab1170c75".into(),
object: Some("e9cdc958e7ce2290e2d7958cdb5aa9323ef35d37".into())
}
);
assert_eq!(parsed.target(), hex_to_id("d53c4b0f91f1b29769c9430f2d1c0bcab1170c75"));
assert_eq!(parsed.object(), hex_to_id("e9cdc958e7ce2290e2d7958cdb5aa9323ef35d37"));
let parsed = decode::reference(&mut input, HASH_KIND).unwrap();
assert!(input.is_empty(), "exhausted");
assert_eq!(
parsed.name,
FullNameRef::new_unchecked("refs/heads/avoid-double-lookup".into())
);
assert_eq!(parsed.target, "eaae9c1bc723209d793eb93f5587fa2604d5cd92");
assert!(parsed.object.is_none());
Ok(())
}
}
mod record_at_offset {
use crate::store_impl::packed::decode;
const INPUT: &[u8] = b"1111111111111111111111111111111111111111 refs/heads/main
2222222222222222222222222222222222222222 refs/tags/v1
^3333333333333333333333333333333333333333
4444444444444444444444444444444444444444 refs/tags/v2\n";
fn offset_of(needle: &[u8]) -> usize {
INPUT
.windows(needle.len())
.position(|window| window == needle)
.expect("needle is present in input")
}
#[test]
fn first_record_starts_at_zero() {
let offset = offset_of(b"refs/heads/main");
assert_eq!(
decode::record_start_at_offset(INPUT, offset),
0,
"offsets before the first line ending belong to the first record",
);
assert_eq!(decode::record_at_offset(INPUT, offset), INPUT);
}
#[test]
fn offset_on_later_record_finds_that_record_start() {
let record_start = offset_of(b"2222222222222222222222222222222222222222");
let offset = offset_of(b"refs/tags/v1");
assert_eq!(
decode::record_start_at_offset(INPUT, offset),
record_start,
"offsets within a later ref line resolve to that ref line",
);
assert_eq!(decode::record_at_offset(INPUT, offset), &INPUT[record_start..]);
}
#[test]
fn offset_on_peeled_line_finds_owning_record_start() {
let record_start = offset_of(b"2222222222222222222222222222222222222222");
let offset = offset_of(b"^3333333333333333333333333333333333333333");
assert_eq!(
decode::record_start_at_offset(INPUT, offset),
record_start,
"peeled lines are part of the preceding packed-ref record",
);
assert_eq!(decode::record_at_offset(INPUT, offset), &INPUT[record_start..]);
}
#[test]
fn offset_after_peeled_record_finds_next_record_start() {
let record_start = offset_of(b"4444444444444444444444444444444444444444");
let offset = offset_of(b"refs/tags/v2");
assert_eq!(
decode::record_start_at_offset(INPUT, offset),
record_start,
"the record after a peeled line starts at its own hash",
);
assert_eq!(decode::record_at_offset(INPUT, offset), &INPUT[record_start..]);
}
}
mod name_at_record_start {
use crate::store_impl::packed::decode;
const SHA1: gix_hash::Kind = gix_hash::Kind::Sha1;
const SHA256: gix_hash::Kind = gix_hash::Kind::Sha256;
#[test]
fn extracts_name_terminated_by_lf() {
let input = b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75 refs/heads/main\n";
assert_eq!(
decode::name_at_record_start(input, SHA1),
Some(b"refs/heads/main".as_slice()),
);
}
#[test]
fn extracts_name_terminated_by_crlf() {
let input = b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75 refs/heads/main\r\n";
assert_eq!(
decode::name_at_record_start(input, SHA1),
Some(b"refs/heads/main".as_slice()),
"CRLF is accepted, matching `parse::newline`",
);
}
#[test]
fn rejects_name_terminated_by_bare_cr() {
let input = b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75 refs/heads/main\rrefs/heads/next\n";
assert_eq!(
decode::name_at_record_start(input, SHA1),
None,
"bare CR is rejected so the binary-search fast path agrees with the full record parser",
);
}
#[test]
fn does_not_validate_name_or_hash_contents() {
let input = b"ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ not!a!valid!refname\n";
assert_eq!(
decode::name_at_record_start(input, SHA1),
Some(b"not!a!valid!refname".as_slice()),
"the binary-search comparator only needs name bytes; validation happens at the match site",
);
}
#[test]
fn rejects_missing_space_after_hash() {
let input = b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75-refs/heads/main\n";
assert_eq!(
decode::name_at_record_start(input, SHA1),
None,
"lines that do not have the expected shape are reported as a parse failure",
);
}
#[test]
fn rejects_truncated_input_without_newline() {
let input = b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75 refs/heads/main";
assert_eq!(
decode::name_at_record_start(input, SHA1),
None,
"missing line terminator means we can't bound the name",
);
}
#[test]
fn rejects_empty_name() {
let input = b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75 \n";
assert_eq!(
decode::name_at_record_start(input, SHA1),
None,
"an empty name is treated as a shape mismatch so the slow path can surface it as a parse error",
);
}
#[test]
fn rejects_input_shorter_than_hash() {
assert_eq!(decode::name_at_record_start(b"", SHA1), None);
assert_eq!(decode::name_at_record_start(b"short", SHA1), None);
assert_eq!(
decode::name_at_record_start(b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75", SHA1),
None,
"input must be at least <hash><space> to be considered",
);
}
#[test]
fn sha256_record() {
let input = b"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa refs/heads/main\n";
assert_eq!(
decode::name_at_record_start(input, SHA256),
Some(b"refs/heads/main".as_slice()),
);
assert_eq!(
decode::name_at_record_start(input, SHA1),
None,
"with a SHA1 hash kind the SHA256-sized prefix is not followed by a space at the expected offset",
);
}
#[test]
fn ignores_trailing_peeled_line() {
let input =
b"d53c4b0f91f1b29769c9430f2d1c0bcab1170c75 refs/tags/v1\n^e9cdc958e7ce2290e2d7958cdb5aa9323ef35d37\n";
assert_eq!(
decode::name_at_record_start(input, SHA1),
Some(b"refs/tags/v1".as_slice()),
"only the first line is considered; the peeled line is parsed by the match-site decoder",
);
}
}
mod header {
use gix_object::bstr::ByteSlice;
use super::Result;
use crate::store_impl::packed::{
decode,
decode::{Header, Peeled},
};
#[test]
fn invalid() {
let mut input = b"# some user comment".as_slice();
assert!(decode::header(&mut input).is_err(), "something the user put there");
assert_eq!(input[0], b'#', "it consumed nothing");
let mut input = b"# pack-refs: ".as_slice();
assert!(decode::header(&mut input).is_err(), "looks right but isn't");
let mut input = b" # pack-refs with: ".as_slice();
assert!(decode::header(&mut input).is_err(), "does not start with #");
}
#[test]
fn valid_fully_peeled_stored() -> Result {
let mut input: &[u8] = b"# pack-refs with: peeled fully-peeled sorted \nsomething else";
let header = decode::header(&mut input).expect("valid input");
assert_eq!(input.as_bstr(), "something else", "remainder starts after newline");
assert_eq!(
header,
Header {
peeled: Peeled::Fully,
sorted: true
}
);
Ok(())
}
#[test]
fn valid_peeled_unsorted() -> Result {
let mut input: &[u8] = b"# pack-refs with: peeled\n";
let header = decode::header(&mut input).unwrap();
assert!(input.is_empty());
assert_eq!(
header,
Header {
peeled: Peeled::Partial,
sorted: false
}
);
Ok(())
}
#[test]
fn valid_empty() -> Result {
let mut input: &[u8] = b"# pack-refs with: \n";
let header = decode::header(&mut input).unwrap();
assert!(input.is_empty());
assert_eq!(
header,
Header {
peeled: Peeled::Unspecified,
sorted: false
}
);
Ok(())
}
}