git-lfs-pointer 0.3.0

Parse and encode Git LFS pointer files
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
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
//! Parsing and encoding for git-lfs pointer files.
//!
//! See `docs/spec.md` for the format. Briefly: a pointer is a tiny UTF-8 text
//! file whose lines are sorted `key value` pairs, with `version` always first
//! and the rest in alphabetical order, terminated by `\n`. The whole file
//! must be < 1024 bytes.
//!
//! ```
//! use git_lfs_pointer::{Oid, Pointer};
//!
//! let oid: Oid = "4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393"
//!     .parse()
//!     .unwrap();
//! let pointer = Pointer::new(oid, 12345);
//!
//! let encoded = pointer.encode();
//! let parsed = Pointer::parse(encoded.as_bytes()).unwrap();
//! assert_eq!(parsed.oid, oid);
//! assert_eq!(parsed.size, 12345);
//! assert!(parsed.canonical);
//! ```

mod oid;

pub use oid::{EMPTY_HEX, Oid, OidParseError};

/// The version URL we always emit. Older aliases parse but re-encode to this.
pub const VERSION_LATEST: &str = "https://git-lfs.github.com/spec/v1";

/// Pointer files must be **smaller** than this (per `docs/spec.md`).
/// Inputs of this size or larger are not pointers.
pub const MAX_POINTER_SIZE: usize = 1024;

/// Recognized version URLs we accept on the read path.
const VERSION_ALIASES: &[&str] = &[
    "http://git-media.io/v/2",            // alpha
    "https://hawser.github.com/spec/v1",  // pre-release
    "https://git-lfs.github.com/spec/v1", // current
];

/// A parsed git-lfs pointer.
///
/// A pointer with `size == 0` is an *empty pointer*: it represents an empty
/// file and serializes to the empty byte string. The `oid` field of an empty
/// pointer is conventionally [`Oid::EMPTY`] (SHA-256 of zero bytes).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Pointer {
    pub oid: Oid,
    pub size: u64,
    /// Sorted by `priority` ascending. May be empty.
    pub extensions: Vec<Extension>,
    /// `true` if this was decoded from input that exactly matched the
    /// canonical encoding, or if it was constructed programmatically.
    /// Re-encoding a non-canonical parse produces canonical bytes.
    pub canonical: bool,
}

/// A pointer extension (see `docs/extensions.md`).
///
/// Extensions appear between the `version` and `oid` lines in the encoded
/// form, sorted by `priority`. Priorities are single decimal digits (0–9).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Extension {
    pub name: String,
    pub priority: u8,
    pub oid: Oid,
}

impl Pointer {
    /// Build a non-empty pointer with no extensions.
    pub fn new(oid: Oid, size: u64) -> Self {
        Self {
            oid,
            size,
            extensions: Vec::new(),
            canonical: true,
        }
    }

    /// The empty pointer (size 0, OID [`Oid::EMPTY`], no extensions). This is
    /// the parse result for empty input and the pointer representation of an
    /// empty file.
    pub fn empty() -> Self {
        Self {
            oid: Oid::EMPTY,
            size: 0,
            extensions: Vec::new(),
            canonical: true,
        }
    }

    /// `true` if this is the empty pointer (size 0).
    pub fn is_empty(&self) -> bool {
        self.size == 0
    }

    /// Encode to canonical text form. The empty pointer encodes to `""`.
    ///
    /// Extensions are emitted sorted by priority. The version line is always
    /// [`VERSION_LATEST`], regardless of what the source used.
    pub fn encode(&self) -> String {
        use std::fmt::Write as _;
        if self.size == 0 {
            return String::new();
        }
        let mut exts: Vec<&Extension> = self.extensions.iter().collect();
        exts.sort_by_key(|e| e.priority);

        let mut out = String::with_capacity(160 + 80 * exts.len());
        writeln!(out, "version {VERSION_LATEST}").unwrap();
        for ext in exts {
            writeln!(out, "ext-{}-{} sha256:{}", ext.priority, ext.name, ext.oid).unwrap();
        }
        writeln!(out, "oid sha256:{}", self.oid).unwrap();
        writeln!(out, "size {}", self.size).unwrap();
        out
    }

    /// Parse a pointer from the raw bytes of a blob.
    ///
    /// Returns [`DecodeError::NotAPointer`] if the input doesn't look like a
    /// pointer at all (callers like the smudge filter should pass the bytes
    /// through unchanged), or [`DecodeError::Malformed`] if the input has
    /// pointer shape but invalid contents (callers should error out).
    pub fn parse(input: &[u8]) -> Result<Self, DecodeError> {
        if input.is_empty() {
            return Ok(Self::empty());
        }
        if input.len() >= MAX_POINTER_SIZE {
            return Err(DecodeError::NotAPointer(NotAPointerReason::TooLarge {
                size: input.len(),
            }));
        }
        let text = std::str::from_utf8(input)
            .map_err(|_| DecodeError::NotAPointer(NotAPointerReason::NotUtf8))?;
        if !contains_spec_marker(text) {
            return Err(DecodeError::NotAPointer(NotAPointerReason::MissingHeader));
        }

        let mut pointer = parse_lines(text.trim())?;
        pointer.canonical = pointer.encode().as_bytes() == input;
        Ok(pointer)
    }
}

fn contains_spec_marker(text: &str) -> bool {
    text.contains("git-lfs") || text.contains("git-media") || text.contains("hawser")
}

fn parse_lines(text: &str) -> Result<Pointer, DecodeError> {
    const REQUIRED: [&str; 3] = ["version", "oid", "size"];
    let mut filled: [Option<&str>; 3] = [None, None, None];
    let mut consumed = 0usize;
    let mut extensions: Vec<Extension> = Vec::new();

    for (line_no, raw_line) in text.split('\n').enumerate() {
        // Tolerate CRLF: bufio.Scanner does this in upstream, so we match.
        let line = raw_line.strip_suffix('\r').unwrap_or(raw_line);
        if line.is_empty() {
            continue;
        }

        let (key, value) = line.split_once(' ').ok_or(DecodeError::NotAPointer(
            NotAPointerReason::MalformedLine { line: line_no },
        ))?;

        if consumed == REQUIRED.len() {
            return Err(DecodeError::NotAPointer(NotAPointerReason::ExtraLine {
                line: line_no,
                content: line.into(),
            }));
        }

        let expected = REQUIRED[consumed];
        if key == expected {
            filled[consumed] = Some(value);
            consumed += 1;
            continue;
        }

        // Mismatch: try to parse as an extension.
        if let Some((priority, name)) = parse_extension_key(key) {
            let ext_oid = parse_oid_value(value).map_err(DecodeError::Malformed)?;
            extensions.push(Extension {
                name: name.to_owned(),
                priority,
                oid: ext_oid,
            });
            continue;
        }

        // Not a required key, not an extension. If this happens before the
        // version line, treat as NotAPointer (matches upstream's
        // StandardizeBadPointerError); otherwise it's a malformed pointer.
        return Err(if expected == "version" {
            DecodeError::NotAPointer(NotAPointerReason::NotVersionFirst { got: key.into() })
        } else {
            DecodeError::Malformed(MalformedReason::UnexpectedKey {
                expected,
                got: key.into(),
            })
        });
    }

    let version = filled[0].ok_or(DecodeError::NotAPointer(NotAPointerReason::MissingVersion))?;
    if !VERSION_ALIASES.contains(&version) {
        return Err(DecodeError::Malformed(MalformedReason::InvalidVersion(
            version.into(),
        )));
    }

    let oid_value =
        filled[1].ok_or(DecodeError::Malformed(MalformedReason::MissingField("oid")))?;
    let oid = parse_oid_value(oid_value).map_err(DecodeError::Malformed)?;

    let size_value = filled[2].ok_or(DecodeError::Malformed(MalformedReason::MissingField(
        "size",
    )))?;
    let size = parse_size(size_value).map_err(DecodeError::Malformed)?;

    extensions.sort_by_key(|e| e.priority);
    for w in extensions.windows(2) {
        if w[0].priority == w[1].priority {
            return Err(DecodeError::Malformed(
                MalformedReason::DuplicateExtensionPriority(w[0].priority),
            ));
        }
    }

    Ok(Pointer {
        oid,
        size,
        extensions,
        canonical: true, // overwritten by Pointer::parse
    })
}

fn parse_oid_value(value: &str) -> Result<Oid, MalformedReason> {
    let (oid_type, hash) = value
        .split_once(':')
        .ok_or_else(|| MalformedReason::MalformedOidValue(value.into()))?;
    if oid_type != "sha256" {
        return Err(MalformedReason::UnsupportedOidType(oid_type.into()));
    }
    Oid::from_hex(hash).map_err(MalformedReason::InvalidOidHash)
}

fn parse_size(value: &str) -> Result<u64, MalformedReason> {
    // u64 parse already rejects leading '-', '+', whitespace, and non-digits.
    value
        .parse::<u64>()
        .map_err(|_| MalformedReason::InvalidSize(value.into()))
}

/// Returns `Some((priority, name))` if `key` is a valid extension key in the
/// form `ext-<digit>-<word>`. Word characters are ASCII alphanumeric or `_`.
fn parse_extension_key(key: &str) -> Option<(u8, &str)> {
    let rest = key.strip_prefix("ext-")?;
    let bytes = rest.as_bytes();
    if bytes.len() < 3 {
        return None;
    }
    if !bytes[0].is_ascii_digit() || bytes[1] != b'-' {
        return None;
    }
    let name = &rest[2..];
    if !name.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'_') {
        return None;
    }
    Some((bytes[0] - b'0', name))
}

#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum DecodeError {
    /// The input does not look like a pointer at all.
    #[error("not a git-lfs pointer: {0}")]
    NotAPointer(NotAPointerReason),
    /// The input has pointer shape but is invalid.
    #[error("malformed git-lfs pointer: {0}")]
    Malformed(MalformedReason),
}

impl DecodeError {
    /// `true` if the input doesn't look like a pointer; the smudge filter
    /// should pass the bytes through unchanged in this case.
    pub fn is_not_a_pointer(&self) -> bool {
        matches!(self, DecodeError::NotAPointer(_))
    }
}

#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum NotAPointerReason {
    #[error("size {size} bytes is not below the {MAX_POINTER_SIZE}-byte cutoff")]
    TooLarge { size: usize },
    #[error("input is not valid UTF-8")]
    NotUtf8,
    #[error("missing git-lfs spec marker")]
    MissingHeader,
    #[error("line {line} has no key/value separator")]
    MalformedLine { line: usize },
    #[error("missing version line")]
    MissingVersion,
    #[error("first key is {got:?}, expected version")]
    NotVersionFirst { got: String },
    #[error("extra content on line {line}: {content:?}")]
    ExtraLine { line: usize, content: String },
}

#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum MalformedReason {
    #[error("unrecognized version: {0:?}")]
    InvalidVersion(String),
    #[error("expected key {expected:?}, got {got:?}")]
    UnexpectedKey { expected: &'static str, got: String },
    #[error("missing required {0:?} line")]
    MissingField(&'static str),
    #[error("oid value {0:?} is not in the form <type>:<hash>")]
    MalformedOidValue(String),
    #[error("unsupported oid type {0:?}; only sha256 is supported")]
    UnsupportedOidType(String),
    #[error("invalid oid hash: {0}")]
    InvalidOidHash(#[source] OidParseError),
    #[error("size value {0:?} is not a non-negative integer")]
    InvalidSize(String),
    #[error("duplicate extension priority {0}")]
    DuplicateExtensionPriority(u8),
}

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

    fn sha(hex: &str) -> Oid {
        Oid::from_hex(hex).unwrap()
    }

    const SAMPLE_OID_HEX: &str = "4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393";

    // ---------- encode ----------

    #[test]
    fn encode_simple() {
        let p = Pointer::new(sha(SAMPLE_OID_HEX), 12345);
        let expected =
            format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}\nsize 12345\n");
        assert_eq!(p.encode(), expected);
    }

    #[test]
    fn encode_empty() {
        // Per spec, the empty pointer encodes to the empty string.
        assert_eq!(Pointer::empty().encode(), "");
        // Any pointer with size 0 also encodes to "" (matches upstream).
        let p = Pointer::new(sha(SAMPLE_OID_HEX), 0);
        assert_eq!(p.encode(), "");
    }

    #[test]
    fn encode_extensions_sorted_on_output() {
        let exts = vec![
            Extension {
                name: "baz".into(),
                priority: 2,
                oid: sha("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"),
            },
            Extension {
                name: "foo".into(),
                priority: 0,
                oid: sha("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"),
            },
            Extension {
                name: "bar".into(),
                priority: 1,
                oid: sha("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"),
            },
        ];
        let p = Pointer {
            oid: sha(SAMPLE_OID_HEX),
            size: 12345,
            extensions: exts,
            canonical: true,
        };
        let expected = format!(
            "version {VERSION_LATEST}\n\
             ext-0-foo sha256:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             ext-1-bar sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n\
             ext-2-baz sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        assert_eq!(p.encode(), expected);
    }

    // ---------- parse: happy paths ----------

    #[test]
    fn parse_standard() {
        let input = format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}\nsize 12345\n");
        let p = Pointer::parse(input.as_bytes()).unwrap();
        assert_eq!(p.oid, sha(SAMPLE_OID_HEX));
        assert_eq!(p.size, 12345);
        assert!(p.extensions.is_empty());
        assert!(p.canonical);
    }

    #[test]
    fn parse_empty_input_is_empty_pointer() {
        let p = Pointer::parse(b"").unwrap();
        assert_eq!(p, Pointer::empty());
        assert!(p.canonical);
    }

    #[test]
    fn parse_extensions_sorted() {
        let input = format!(
            "version {VERSION_LATEST}\n\
             ext-0-foo sha256:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             ext-1-bar sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n\
             ext-2-baz sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let p = Pointer::parse(input.as_bytes()).unwrap();
        assert_eq!(p.extensions.len(), 3);
        assert_eq!(p.extensions[0].name, "foo");
        assert_eq!(p.extensions[0].priority, 0);
        assert_eq!(p.extensions[1].name, "bar");
        assert_eq!(p.extensions[2].name, "baz");
        assert!(p.canonical);
    }

    #[test]
    fn parse_unsorted_extensions_sorts_and_marks_noncanonical() {
        // Same content, but ext-2 listed first.
        let input = format!(
            "version {VERSION_LATEST}\n\
             ext-2-baz sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n\
             ext-0-foo sha256:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             ext-1-bar sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let p = Pointer::parse(input.as_bytes()).unwrap();
        assert_eq!(p.extensions[0].priority, 0);
        assert_eq!(p.extensions[1].priority, 1);
        assert_eq!(p.extensions[2].priority, 2);
        assert!(!p.canonical);
    }

    #[test]
    fn parse_pre_release_version_alias() {
        let input = format!(
            "version https://hawser.github.com/spec/v1\noid sha256:{SAMPLE_OID_HEX}\nsize 12345\n"
        );
        let p = Pointer::parse(input.as_bytes()).unwrap();
        assert_eq!(p.size, 12345);
        // Re-encoding rewrites version to latest, so input is NOT canonical.
        assert!(!p.canonical);
        assert!(
            p.encode()
                .starts_with(&format!("version {VERSION_LATEST}\n"))
        );
    }

    #[test]
    fn parse_round_trip() {
        let p = Pointer::new(sha(SAMPLE_OID_HEX), 12345);
        let encoded = p.encode();
        let parsed = Pointer::parse(encoded.as_bytes()).unwrap();
        assert_eq!(parsed.oid, p.oid);
        assert_eq!(parsed.size, p.size);
        assert!(parsed.canonical);
    }

    // ---------- canonical bytes ----------

    #[test]
    fn canonical_examples() {
        // Standard form, with trailing \n.
        let s = format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}\nsize 12345\n");
        assert!(Pointer::parse(s.as_bytes()).unwrap().canonical);

        // Empty input.
        assert!(Pointer::parse(b"").unwrap().canonical);
    }

    #[test]
    fn non_canonical_examples() {
        let cases: &[&str] = &[
            // missing trailing newline
            "version https://git-lfs.github.com/spec/v1\noid sha256:4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393\nsize 12345",
            // CRLF line endings
            "version https://git-lfs.github.com/spec/v1\r\noid sha256:4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393\r\nsize 12345\r\n",
            // trailing whitespace on a line
            "version https://git-lfs.github.com/spec/v1\noid sha256:4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393\nsize 12345   \n",
        ];
        for case in cases {
            let p = Pointer::parse(case.as_bytes())
                .unwrap_or_else(|e| panic!("failed to parse {case:?}: {e}"));
            assert!(!p.canonical, "expected non-canonical for {case:?}");
        }
    }

    // ---------- parse: NotAPointer ----------

    #[test]
    fn tiny_non_pointer_is_not_a_pointer() {
        let err = Pointer::parse(b"this is not a git-lfs file!").unwrap_err();
        assert!(err.is_not_a_pointer(), "expected NotAPointer, got {err:?}");
    }

    #[test]
    fn header_only_is_not_a_pointer() {
        // Mentions git-media so passes the marker check, but no key/value.
        let err = Pointer::parse(b"# git-media").unwrap_err();
        assert!(err.is_not_a_pointer(), "expected NotAPointer, got {err:?}");
    }

    #[test]
    fn oversized_input_is_not_a_pointer() {
        let big = vec![b'x'; MAX_POINTER_SIZE + 1];
        let err = Pointer::parse(&big).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::NotAPointer(NotAPointerReason::TooLarge { .. })
        ));
    }

    #[test]
    fn exactly_max_size_is_not_a_pointer() {
        // Spec: pointer files must be *less than* 1024 bytes. At-cutoff is too large.
        let exact = vec![b'x'; MAX_POINTER_SIZE];
        let err = Pointer::parse(&exact).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::NotAPointer(NotAPointerReason::TooLarge { .. })
        ));
    }

    #[test]
    fn equals_separator_is_not_a_pointer() {
        // From upstream's TestDecodeInvalid: bad `key value` format using '='.
        let s = "version=https://git-lfs.github.com/spec/v1\n\
                 oid=sha256:4d7a214614ab2935c943f9e0ff69d22eadbb8f32b1258daaa5e2ca24d17e2393\n\
                 size=fif";
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(err.is_not_a_pointer());
    }

    #[test]
    fn no_marker_is_not_a_pointer() {
        let err = Pointer::parse(b"version=http://wat.io/v/2\noid=foo\nsize=fif").unwrap_err();
        assert!(matches!(
            err,
            DecodeError::NotAPointer(NotAPointerReason::MissingHeader)
        ));
    }

    #[test]
    fn missing_version_first_is_not_a_pointer() {
        // OID line first, no version. From upstream's "no version" case.
        let s = format!("oid sha256:{SAMPLE_OID_HEX}\nsize 12345\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(err.is_not_a_pointer(), "got {err:?}");
    }

    #[test]
    fn extra_line_after_size_is_not_a_pointer() {
        let s =
            format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}\nsize 12345\nwat wat\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::NotAPointer(NotAPointerReason::ExtraLine { .. })
        ));
    }

    // ---------- parse: Malformed ----------

    #[test]
    fn invalid_version_is_malformed() {
        // Non-empty version that isn't an alias.
        let s = format!(
            "version http://git-media.io/v/whatever\noid sha256:{SAMPLE_OID_HEX}\nsize 12345\n"
        );
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::InvalidVersion(_))
        ));
    }

    #[test]
    fn missing_oid_is_malformed() {
        let s = format!("version {VERSION_LATEST}\nsize 12345\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(err, DecodeError::Malformed(_)));
    }

    #[test]
    fn missing_size_is_malformed() {
        let s = format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::MissingField("size"))
        ));
    }

    #[test]
    fn keys_out_of_order_is_malformed() {
        let s = format!("version {VERSION_LATEST}\nsize 12345\noid sha256:{SAMPLE_OID_HEX}\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::UnexpectedKey { .. })
        ));
    }

    #[test]
    fn bad_oid_hex_is_malformed() {
        let s = format!("version {VERSION_LATEST}\noid sha256:boom\nsize 12345\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::InvalidOidHash(_))
        ));
    }

    #[test]
    fn bad_oid_type_is_malformed() {
        let s = format!("version {VERSION_LATEST}\noid shazam:{SAMPLE_OID_HEX}\nsize 12345\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::UnsupportedOidType(_))
        ));
    }

    #[test]
    fn bad_size_is_malformed() {
        let s = format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}\nsize fif\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::InvalidSize(_))
        ));
    }

    #[test]
    fn negative_size_is_malformed() {
        let s = format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}\nsize -1\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::InvalidSize(_))
        ));
    }

    #[test]
    fn oid_with_trailing_garbage_is_malformed() {
        let s = format!("version {VERSION_LATEST}\noid sha256:{SAMPLE_OID_HEX}&\nsize 177735\n");
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::InvalidOidHash(_))
        ));
    }

    // ---------- parse: extensions ----------

    #[test]
    fn ext_priority_over_9_is_malformed() {
        // ext-10-foo: priority must be a single digit (matches upstream regex).
        let s = format!(
            "version {VERSION_LATEST}\n\
             ext-10-foo sha256:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(err, DecodeError::Malformed(_)), "got {err:?}");
    }

    #[test]
    fn ext_with_non_digit_priority_is_malformed() {
        let s = format!(
            "version {VERSION_LATEST}\n\
             ext-#-foo sha256:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(err, DecodeError::Malformed(_)), "got {err:?}");
    }

    #[test]
    fn ext_with_non_word_name_is_malformed() {
        let s = format!(
            "version {VERSION_LATEST}\n\
             ext-0-$$$$ sha256:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(err, DecodeError::Malformed(_)), "got {err:?}");
    }

    #[test]
    fn ext_bad_oid_is_malformed() {
        let s = format!(
            "version {VERSION_LATEST}\n\
             ext-0-foo sha256:boom\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::InvalidOidHash(_))
        ));
    }

    #[test]
    fn ext_bad_oid_type_is_malformed() {
        let s = format!(
            "version {VERSION_LATEST}\n\
             ext-0-foo boom:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::UnsupportedOidType(_))
        ));
    }

    #[test]
    fn duplicate_ext_priority_is_malformed() {
        let s = format!(
            "version {VERSION_LATEST}\n\
             ext-0-foo sha256:ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n\
             ext-0-bar sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n\
             oid sha256:{SAMPLE_OID_HEX}\n\
             size 12345\n",
        );
        let err = Pointer::parse(s.as_bytes()).unwrap_err();
        assert!(matches!(
            err,
            DecodeError::Malformed(MalformedReason::DuplicateExtensionPriority(0))
        ));
    }
}