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
use git_hash::ObjectId;
use crate::store::file::log::Line;
impl<'a> Line<'a> {
pub fn previous_oid(&self) -> ObjectId {
ObjectId::from_hex(self.previous_oid).expect("parse validation")
}
pub fn new_oid(&self) -> ObjectId {
ObjectId::from_hex(self.new_oid).expect("parse validation")
}
}
pub mod decode {
use bstr::{BStr, ByteSlice};
use nom::{
bytes::complete::{tag, take_while},
combinator::opt,
error::{context, ContextError, ParseError},
sequence::{terminated, tuple},
IResult,
};
use crate::{file::log::Line, parse::hex_hash};
mod error {
use bstr::{BString, ByteSlice};
#[derive(Debug)]
pub struct Error {
pub input: BString,
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{:?} did not match '<old-hexsha> <new-hexsha> <name> <<email>> <timestamp> <tz>\\t<message>'",
self.input
)
}
}
impl<'a> std::error::Error for Error {}
impl Error {
pub(crate) fn new(input: &[u8]) -> Self {
Error {
input: input.as_bstr().to_owned(),
}
}
}
}
pub use error::Error;
impl<'a> Line<'a> {
pub fn from_bytes(input: &'a [u8]) -> Result<Line<'a>, Error> {
one::<()>(input).map(|(_, l)| l).map_err(|_| Error::new(input))
}
}
fn message<'a, E: ParseError<&'a [u8]>>(i: &'a [u8]) -> IResult<&'a [u8], &'a BStr, E> {
if i.is_empty() {
Ok((&[], i.as_bstr()))
} else {
terminated(take_while(|c| c != b'\n'), opt(tag(b"\n")))(i).map(|(i, o)| (i, o.as_bstr()))
}
}
fn one<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(bytes: &'a [u8]) -> IResult<&[u8], Line<'a>, E> {
let (i, (old, new, signature, message_sep, message)) = context(
"<old-hexsha> <new-hexsha> <name> <<email>> <timestamp> <tz>\\t<message>",
tuple((
context("<old-hexsha>", terminated(hex_hash, tag(b" "))),
context("<new-hexsha>", terminated(hex_hash, tag(b" "))),
context("<name> <<email>> <timestamp>", git_actor::immutable::signature::decode),
opt(tag(b"\t")),
context("<optional message>", message),
)),
)(bytes)?;
if message_sep.is_none() {
if let Some(first) = message.first() {
if !first.is_ascii_whitespace() {
return Err(nom::Err::Error(E::add_context(
i,
"log message must be separated from signature with whitespace",
E::from_error_kind(i, nom::error::ErrorKind::MapRes),
)));
}
}
}
Ok((
i,
Line {
previous_oid: old,
new_oid: new,
signature,
message,
},
))
}
#[cfg(test)]
mod test {
use bstr::ByteSlice;
use git_actor::{Sign, Time};
use git_hash::ObjectId;
use super::*;
fn hex_to_oid(hex: &str) -> ObjectId {
ObjectId::from_hex(hex.as_bytes()).unwrap()
}
fn with_newline(mut v: Vec<u8>) -> Vec<u8> {
v.push(b'\n');
v
}
mod invalid {
use git_testtools::to_bstr_err;
use nom::error::VerboseError;
use super::one;
#[test]
fn completely_bogus_shows_error_with_context() {
let err = one::<VerboseError<&[u8]>>(b"definitely not a log entry")
.map_err(to_bstr_err)
.expect_err("this should fail");
assert!(err.to_string().contains("<old-hexsha> <new-hexsha>"));
}
#[test]
fn missing_whitespace_between_signature_and_message() {
let line = "0000000000000000000000000000000000000000 0000000000000000000000000000000000000000 one <foo@example.com> 1234567890 -0000message";
let err = one::<VerboseError<&[u8]>>(line.as_bytes())
.map_err(to_bstr_err)
.expect_err("this should fail");
assert!(err
.to_string()
.contains("log message must be separated from signature with whitespace"));
}
}
const NULL_SHA1: &[u8] = b"0000000000000000000000000000000000000000";
#[test]
fn entry_with_empty_message() {
let line_without_nl: Vec<_> = b"0000000000000000000000000000000000000000 0000000000000000000000000000000000000000 name <foo@example.com> 1234567890 -0000".to_vec();
let line_with_nl = with_newline(line_without_nl.clone());
for input in &[line_without_nl, line_with_nl] {
assert_eq!(
one::<nom::error::Error<_>>(input).expect("successful parsing").1,
Line {
previous_oid: NULL_SHA1.as_bstr(),
new_oid: NULL_SHA1.as_bstr(),
signature: git_actor::immutable::Signature {
name: b"name".as_bstr(),
email: b"foo@example.com".as_bstr(),
time: Time {
time: 1234567890,
offset: 0,
sign: Sign::Minus
}
},
message: b"".as_bstr(),
}
);
}
}
#[test]
fn entry_with_message_without_newline_and_with_newline() {
let line_without_nl: Vec<_> = b"a5828ae6b52137b913b978e16cd2334482eb4c1f 89b43f80a514aee58b662ad606e6352e03eaeee4 Sebastian Thiel <foo@example.com> 1618030561 +0800\tpull --ff-only: Fast-forward".to_vec();
let line_with_nl = with_newline(line_without_nl.clone());
for input in &[line_without_nl, line_with_nl] {
let (remaining, res) = one::<nom::error::Error<_>>(input).expect("successful parsing");
assert!(remaining.is_empty(), "all consuming even without trailing newline");
let actual = Line {
previous_oid: b"a5828ae6b52137b913b978e16cd2334482eb4c1f".as_bstr(),
new_oid: b"89b43f80a514aee58b662ad606e6352e03eaeee4".as_bstr(),
signature: git_actor::immutable::Signature {
name: b"Sebastian Thiel".as_bstr(),
email: b"foo@example.com".as_bstr(),
time: Time {
time: 1618030561,
offset: 28800,
sign: Sign::Plus,
},
},
message: b"pull --ff-only: Fast-forward".as_bstr(),
};
assert_eq!(res, actual);
assert_eq!(
actual.previous_oid(),
hex_to_oid("a5828ae6b52137b913b978e16cd2334482eb4c1f")
);
assert_eq!(actual.new_oid(), hex_to_oid("89b43f80a514aee58b662ad606e6352e03eaeee4"));
}
}
#[test]
fn two_lines_in_a_row_with_and_without_newline() {
let lines = b"0000000000000000000000000000000000000000 0000000000000000000000000000000000000000 one <foo@example.com> 1234567890 -0000\t\n0000000000000000000000000000000000000000 0000000000000000000000000000000000000000 two <foo@example.com> 1234567890 -0000\thello";
let (remainder, parsed) = one::<nom::error::Error<_>>(lines).expect("parse single line");
assert_eq!(parsed.message, b"".as_bstr(), "first message is empty");
let (remainder, parsed) = one::<nom::error::Error<_>>(remainder).expect("parse single line");
assert_eq!(
parsed.message,
b"hello".as_bstr(),
"second message is not and contains no newline"
);
assert!(remainder.is_empty());
}
}
}