Skip to content

test: consolidate frame garbage rejection checks #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DragonFSKY wants to merge 1 commit into
base: main
Choose a base branch
from
Open

test: consolidate frame garbage rejection checks #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions zstd/src/test/java/io/github/dfa1/zstd/ZstdFrameTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ class ZstdFrameTest {

private static final byte[] PAYLOAD =
"frame inspection payload ".repeat(500).getBytes(StandardCharsets.UTF_8);
private static final byte[] GARBAGE = "xx".getBytes(StandardCharsets.UTF_8);

@Nested
class IsFrame {
Expand All @@ -30,7 +31,13 @@ void recognizesAZstdFrame() {

@Test
void rejectsGarbage() {
assertThat(ZstdFrame.isZstdFrame("not a frame".getBytes(StandardCharsets.UTF_8))).isFalse();
// Given bytes that are not a zstd frame

// When checking whether they are a frame
boolean result = ZstdFrame.isZstdFrame(ZstdFrameTest.GARBAGE);

// Then it reports false rather than throwing
assertThat(result).isFalse();
}
}

Expand Down Expand Up @@ -62,13 +69,11 @@ void locatesFirstFrameBoundaryWhenConcatenated() throws Exception {
@Test
void rejectsGarbage() {
// Given bytes that are not a zstd frame
byte[] garbage = "xxxx".getBytes(StandardCharsets.UTF_8);

// When asking for the first frame's compressed size
ThrowingCallable result = () -> ZstdFrame.compressedSize(garbage);
ThrowingCallable result = () -> ZstdFrame.compressedSize(ZstdFrameTest.GARBAGE);

// Then it fails
assertThatThrownBy(result).isInstanceOf(ZstdException.class);
ZstdFrameTest.rejectsGarbage(result);
}
}

Expand All @@ -84,13 +89,11 @@ void boundsTheDecompressedSize() {
@Test
void rejectsGarbage() {
// Given bytes that are not valid zstd data
byte[] garbage = "xx".getBytes(StandardCharsets.UTF_8);

// When asking for the decompressed bound
ThrowingCallable result = () -> ZstdFrame.decompressedBound(garbage);
ThrowingCallable result = () -> ZstdFrame.decompressedBound(ZstdFrameTest.GARBAGE);

// Then it fails
assertThatThrownBy(result).isInstanceOf(ZstdException.class);
ZstdFrameTest.rejectsGarbage(result);
}
}

Expand Down Expand Up @@ -152,13 +155,11 @@ void failsWhenAFrameDoesNotRecordItsSize() throws Exception {
@Test
void rejectsGarbage() {
// Given bytes that are not valid zstd data
byte[] garbage = "xx".getBytes(StandardCharsets.UTF_8);

// When the exact total is requested
ThrowingCallable result = () -> ZstdFrame.decompressedSize(garbage);
ThrowingCallable result = () -> ZstdFrame.decompressedSize(ZstdFrameTest.GARBAGE);

// Then it fails
assertThatThrownBy(result).isInstanceOf(ZstdException.class);
ZstdFrameTest.rejectsGarbage(result);
}
}

Expand Down Expand Up @@ -256,13 +257,11 @@ void enablesInPlaceDecompression() {
@Test
void rejectsGarbage() {
// Given bytes that are not valid zstd data
byte[] garbage = "xx".getBytes(StandardCharsets.UTF_8);

// When the margin is requested
ThrowingCallable result = () -> ZstdFrame.decompressionMargin(garbage);
ThrowingCallable result = () -> ZstdFrame.decompressionMargin(ZstdFrameTest.GARBAGE);

// Then it fails
assertThatThrownBy(result).isInstanceOf(ZstdException.class);
ZstdFrameTest.rejectsGarbage(result);
}
}

Expand Down Expand Up @@ -475,4 +474,8 @@ void standardNativeFrameIsNotSkippable() {
}
}
}

private static void rejectsGarbage(ThrowingCallable result) {
assertThatThrownBy(result).isInstanceOf(ZstdException.class);
}
}