Tests passing

This commit is contained in:
Simon Curtis 2024-11-19 11:19:54 +00:00
parent 2b0db63d1e
commit 6733f7331b
5 changed files with 110 additions and 65 deletions

View File

@ -5,18 +5,27 @@ pub fn returns_error_for_relative_range_on_infinite_stream() {
let actual = nu!("nu --testbin iecho 3 | bytes at ..-3"); let actual = nu!("nu --testbin iecho 3 | bytes at ..-3");
assert!( assert!(
actual.err.contains( actual.err.contains(
"Relative range values cannot be used with streams that don't specify a length" "Relative range values cannot be used with streams that don't have a known length"
), ),
"Expected error message for negative range with infinite stream" "Expected error message for negative range with infinite stream"
); );
} }
#[test] #[test]
pub fn returns_bytes_for_fixed_range_on_infinite_stream() { pub fn returns_bytes_for_fixed_range_on_infinite_stream_including_end() {
let actual = nu!("nu --testbin iecho 3 | bytes at ..10 | decode"); let actual = nu!("nu --testbin iecho 3 | bytes at ..10 | decode");
assert_eq!( assert_eq!(
actual.out, "33333", actual.out, "33333",
"Expected bytes from index 1 to 10, but got different output" "Expected bytes from index 0 to 10, but got different output"
);
}
#[test]
pub fn returns_bytes_for_fixed_range_on_infinite_stream_excluding_end() {
let actual = nu!("nu --testbin iecho 3 | bytes at ..<9 | decode");
assert_eq!(
actual.out, "3333",
"Expected bytes from index 0 to 8, but got different output"
); );
} }
@ -28,7 +37,7 @@ pub fn test_string_returns_correct_slice_for_simple_positive_slice() {
#[test] #[test]
pub fn test_string_returns_correct_slice_for_negative_start() { pub fn test_string_returns_correct_slice_for_negative_start() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at 6..11 | decode"); let actual = nu!("\"Hello World\" | encode utf8 | bytes at (-5)..10 | decode");
assert_eq!(actual.out, "World"); assert_eq!(actual.out, "World");
} }
@ -46,7 +55,7 @@ pub fn test_string_returns_correct_slice_for_empty_slice() {
#[test] #[test]
pub fn test_string_returns_correct_slice_for_out_of_bounds() { pub fn test_string_returns_correct_slice_for_out_of_bounds() {
let actual = nu!("\"Hello World\" | encode utf8 | bytes at 0..20 | decode"); let actual = nu!("\"Hello World\" | encode utf8 | bytes at ..20 | decode");
assert_eq!(actual.out, "Hello World"); assert_eq!(actual.out, "Hello World");
} }

View File

@ -653,6 +653,18 @@ pub enum ShellError {
creation_site: Span, creation_site: Span,
}, },
/// Attempted to us a relative range on an infinite stream
///
/// ## Resolution
///
/// Ensure that either the range is absolute or the stream has a known length.
#[error("Relative range values cannot be used with streams that don't have a known length")]
#[diagnostic(code(nu::shell::relative_range_on_infinite_stream))]
RelativeRangeOnInfiniteStream {
#[label = "Relative range values cannot be used with streams that don't have a known length"]
span: Span,
},
/// An error happened while performing an external command. /// An error happened while performing an external command.
/// ///
/// ## Resolution /// ## Resolution

View File

@ -213,15 +213,14 @@ impl ByteStream {
} }
pub fn skip(self, span: Span, n: u64) -> Result<Self, ShellError> { pub fn skip(self, span: Span, n: u64) -> Result<Self, ShellError> {
let known_size = self.known_size.map(|len| len.saturating_sub(n));
if let Some(mut reader) = self.reader() { if let Some(mut reader) = self.reader() {
// Copy the number of skipped bytes into the sink before proceeding // Copy the number of skipped bytes into the sink before proceeding
io::copy(&mut (&mut reader).take(n), &mut io::sink()).err_span(span)?; io::copy(&mut (&mut reader).take(n), &mut io::sink()).err_span(span)?;
Ok(ByteStream::read( Ok(
reader, ByteStream::read(reader, span, Signals::empty(), ByteStreamType::Binary)
span, .with_known_size(known_size),
Signals::empty(), )
ByteStreamType::Binary,
))
} else { } else {
Err(ShellError::TypeMismatch { Err(ShellError::TypeMismatch {
err_message: "expected readable stream".into(), err_message: "expected readable stream".into(),
@ -231,13 +230,15 @@ impl ByteStream {
} }
pub fn take(self, span: Span, n: u64) -> Result<Self, ShellError> { pub fn take(self, span: Span, n: u64) -> Result<Self, ShellError> {
let known_size = self.known_size.map(|s| s.min(n));
if let Some(reader) = self.reader() { if let Some(reader) = self.reader() {
Ok(ByteStream::read( Ok(ByteStream::read(
reader.take(n), reader.take(n),
span, span,
Signals::empty(), Signals::empty(),
ByteStreamType::Binary, ByteStreamType::Binary,
)) )
.with_known_size(known_size))
} else { } else {
Err(ShellError::TypeMismatch { Err(ShellError::TypeMismatch {
err_message: "expected readable stream".into(), err_message: "expected readable stream".into(),
@ -248,45 +249,38 @@ impl ByteStream {
pub fn slice( pub fn slice(
self, self,
range_span: Span, val_span: Span,
call_span: Span, call_span: Span,
range: IntRange, range: IntRange,
) -> Result<Self, ShellError> { ) -> Result<Self, ShellError> {
match self.known_size { if let Some(len) = self.known_size {
Some(len) => { let start = range.absolute_start(len);
let absolute_start = range.absolute_start(len); let stream = self.skip(val_span, start);
match range.absolute_end(len) {
Bound::Unbounded => self.skip(range_span, absolute_start), match range.absolute_end(len) {
Bound::Included(end) => self.skip(range_span, absolute_start) Bound::Unbounded => stream,
.and_then(|stream| stream.take(range_span, end.saturating_sub(absolute_start) + 1)), Bound::Included(end) | Bound::Excluded(end) if end < start => {
Bound::Excluded(end) => self.skip(range_span, absolute_start) stream.and_then(|s| s.take(val_span, 0))
.and_then(|stream| stream.take(range_span, end.saturating_sub(absolute_start))), }
Bound::Included(end) => {
let distance = end - start + 1;
stream.and_then(|s| s.take(val_span, distance.min(len)))
}
Bound::Excluded(end) => {
let distance = end - start;
stream.and_then(|s| s.take(val_span, distance.min(len)))
} }
} }
None => match range.is_relative() { } else if range.is_relative() {
true => Err(ShellError::IncorrectValue { Err(ShellError::RelativeRangeOnInfiniteStream { span: call_span })
msg: } else {
"Relative range values cannot be used with streams that don't specify a length" let start = range.start() as u64;
.into(), let stream = self.skip(val_span, start);
val_span: range_span,
call_span, match range.distance() {
}), Bound::Unbounded => stream,
false => { Bound::Included(distance) => stream.and_then(|s| s.take(val_span, distance)),
let skip = range.start(); Bound::Excluded(distance) => stream.and_then(|s| s.take(val_span, distance - 1)),
match range.end() {
std::ops::Bound::Unbounded => self.skip(range_span, skip as u64),
std::ops::Bound::Included(end) => match end - skip {
take if take < 0 => self.take(range_span, 0),
take => self.skip(range_span, skip as u64)
.and_then(|stream| stream.take(range_span, take as u64 + 1)),
},
std::ops::Bound::Excluded(end) => match end - skip {
take if take < 0 => self.take(range_span, 0),
take => self.skip(range_span, skip as u64)
.and_then(|stream| stream.take(range_span, take as u64)),
},
}
}
} }
} }
} }

View File

@ -82,9 +82,22 @@ mod int_range {
} }
pub fn absolute_start(&self, len: u64) -> u64 { pub fn absolute_start(&self, len: u64) -> u64 {
let max_index = len - 1;
match self.start { match self.start {
start if start < 0 => len.saturating_sub(start.unsigned_abs().into()), start if start < 0 => len.saturating_sub(start.unsigned_abs().into()),
start => start as u64, start => max_index.min(start as u64),
}
}
/// Returns the distance between the start and end of the range
/// The result will always be 0 or positive
pub fn distance(&self) -> Bound<u64> {
match self.end {
Bound::Unbounded => Bound::Unbounded,
Bound::Included(end) if self.start > end => Bound::Included(0),
Bound::Excluded(end) if self.start > end => Bound::Excluded(0),
Bound::Included(end) => Bound::Included((end - self.start) as u64),
Bound::Excluded(end) => Bound::Excluded((end - self.start) as u64),
} }
} }
@ -93,15 +106,16 @@ mod int_range {
} }
pub fn absolute_end(&self, len: u64) -> Bound<u64> { pub fn absolute_end(&self, len: u64) -> Bound<u64> {
let max_index = len - 1;
match self.end { match self.end {
Bound::Unbounded => Bound::Unbounded, Bound::Unbounded => Bound::Unbounded,
Bound::Included(i) => Bound::Included(match i { Bound::Included(i) => Bound::Included(match i {
i if i < 0 => len.saturating_sub(i.unsigned_abs() as u64), i if i < 0 => len.saturating_sub(i.unsigned_abs() as u64),
i => i as u64, i => max_index.min(i as u64),
}), }),
Bound::Excluded(i) => Bound::Excluded(match i { Bound::Excluded(i) => Bound::Excluded(match i {
i if i < 0 => len.saturating_sub(i.unsigned_abs() as u64), i if i < 0 => len.saturating_sub(i.unsigned_abs() as u64),
i => i as u64, i => len.min(i as u64),
}), }),
} }
} }

View File

@ -12,7 +12,8 @@ pub fn test_simple_positive_slice_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"Hello"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
} }
#[test] #[test]
@ -27,7 +28,8 @@ pub fn test_negative_start_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"World"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
} }
#[test] #[test]
@ -42,7 +44,8 @@ pub fn test_negative_end_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"Hello"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
} }
#[test] #[test]
@ -57,7 +60,8 @@ pub fn test_negative_start_and_end_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"Wor"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Wor");
} }
#[test] #[test]
@ -72,7 +76,8 @@ pub fn test_empty_slice_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, Vec::<u8>::new()); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "");
} }
#[test] #[test]
@ -87,7 +92,8 @@ pub fn test_out_of_bounds_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"Hello World"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello World");
} }
#[test] #[test]
@ -102,7 +108,8 @@ pub fn test_invalid_range_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, Vec::<u8>::new()); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "");
} }
#[test] #[test]
@ -117,7 +124,8 @@ pub fn test_max_end_exclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"World"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
} }
#[test] #[test]
@ -132,7 +140,8 @@ pub fn test_simple_positive_slice_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"Hello"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
} }
#[test] #[test]
@ -147,7 +156,8 @@ pub fn test_negative_start_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"World"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
} }
#[test] #[test]
@ -162,7 +172,8 @@ pub fn test_negative_end_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"Hello"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello");
} }
#[test] #[test]
@ -177,7 +188,8 @@ pub fn test_negative_start_and_end_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"World"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
} }
#[test] #[test]
@ -192,7 +204,8 @@ pub fn test_empty_slice_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b" "); let result = String::from_utf8(result).unwrap();
assert_eq!(result, " ");
} }
#[test] #[test]
@ -207,7 +220,8 @@ pub fn test_out_of_bounds_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"Hello World"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "Hello World");
} }
#[test] #[test]
@ -222,7 +236,8 @@ pub fn test_invalid_range_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, Vec::<u8>::new()); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "");
} }
#[test] #[test]
@ -237,7 +252,8 @@ pub fn test_max_end_inclusive() {
) )
.unwrap(); .unwrap();
let result = sliced.into_bytes().unwrap(); let result = sliced.into_bytes().unwrap();
assert_eq!(result, b"World"); let result = String::from_utf8(result).unwrap();
assert_eq!(result, "World");
} }
fn create_range(start: i64, end: i64, inclusion: RangeInclusion) -> IntRange { fn create_range(start: i64, end: i64, inclusion: RangeInclusion) -> IntRange {