Skip to content

test zlib API for all compatible backends #525

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

Merged
Byron merged 6 commits into from
Jan 11, 2026
+277 −126
Merged

test zlib API for all compatible backends #525

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b9e2979
Remove C-binding specific restriction from CI for `zlib-rs` test.
Byron Jan 2, 2026
22c77ee
Describe `unreachable!("...")` branch in `Deflate::set_level()` of `z…
Byron Jan 2, 2026
af7a0b3
Add capabilties test for functions reserved to zlib-implementations.
Byron Jan 2, 2026
106cbcc
Bump patch level in preparation for release
Byron Jan 2, 2026
3196dd0
refactor internal feature toggles to better represent the status quo
Byron Jan 8, 2026
5e752c9
Address PR review
Byron Jan 10, 2026
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
1 change: 0 additions & 1 deletion .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ jobs:
- run: cargo test --features zlib-ng --no-default-features
if: matrix.build != 'mingw'
- run: cargo test --features zlib-rs --no-default-features
if: matrix.build != 'mingw'
- run: cargo test --features cloudflare_zlib --no-default-features
if: matrix.build != 'mingw'
- run: |
Expand Down
7 changes: 3 additions & 4 deletions src/ffi/zlib_rs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,12 +242,11 @@ impl Deflate {
match self.inner.set_level(level.level() as i32) {
Ok(status) => match status {
Status::Ok => Ok(()),

Status::BufError => compress_failed(ErrorMessage(Some("insufficient space"))),

Status::StreamEnd => unreachable!(),
Status::StreamEnd => {
unreachable!("zlib-rs is known to never return the StreamEnd status")
}
},

Err(_) => self.compress_error(),
}
}
Expand Down
100 changes: 10 additions & 90 deletions src/mem.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ impl Compress {
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
#[cfg(feature = "any_zlib")]
/// this function will panic.
#[cfg(any(feature = "any_zlib", feature = "zlib-rs"))]
pub fn new_with_window_bits(
level: Compression,
zlib_header: bool,
Expand All @@ -239,8 +239,8 @@ impl Compress {
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
#[cfg(feature = "any_zlib")]
/// this function will panic.
#[cfg(any(feature = "any_zlib", feature = "zlib-rs"))]
pub fn new_gzip(level: Compression, window_bits: u8) -> Compress {
assert!(
window_bits > 8 && window_bits < 16,
Expand Down Expand Up @@ -415,8 +415,8 @@ impl Decompress {
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
#[cfg(feature = "any_zlib")]
/// this function will panic.
#[cfg(any(feature = "any_zlib", feature = "zlib-rs"))]
pub fn new_with_window_bits(zlib_header: bool, window_bits: u8) -> Decompress {
assert!(
window_bits > 8 && window_bits < 16,
Expand All @@ -435,8 +435,8 @@ impl Decompress {
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
#[cfg(feature = "any_zlib")]
/// this function will panic.
#[cfg(any(feature = "any_zlib", feature = "zlib-rs"))]
pub fn new_gzip(window_bits: u8) -> Decompress {
assert!(
window_bits > 8 && window_bits < 16,
Expand Down Expand Up @@ -663,7 +663,7 @@ mod tests {
use crate::write;
use crate::{Compression, Decompress, FlushDecompress};

#[cfg(feature = "any_zlib")]
#[cfg(any(feature = "any_zlib", feature = "zlib-rs"))]
use crate::{Compress, FlushCompress};

#[test]
Expand Down Expand Up @@ -723,87 +723,7 @@ mod tests {
assert!(dst.starts_with(string));
}

#[cfg(feature = "any_zlib")]
#[test]
fn set_dictionary_with_zlib_header() {
let string = "hello, hello!".as_bytes();
let dictionary = "hello".as_bytes();

let mut encoded = Vec::with_capacity(1024);

let mut encoder = Compress::new(Compression::default(), true);

let dictionary_adler = encoder.set_dictionary(&dictionary).unwrap();

encoder
.compress_vec(string, &mut encoded, FlushCompress::Finish)
.unwrap();

assert_eq!(encoder.total_in(), string.len() as u64);
assert_eq!(encoder.total_out(), encoded.len() as u64);

let mut decoder = Decompress::new(true);
let mut decoded = [0; 1024];
let decompress_error = decoder
.decompress(&encoded, &mut decoded, FlushDecompress::Finish)
.expect_err("decompression should fail due to requiring a dictionary");

let required_adler = decompress_error.needs_dictionary()
.expect("the first call to decompress should indicate a dictionary is required along with the required Adler-32 checksum");

assert_eq!(required_adler, dictionary_adler,
"the Adler-32 checksum should match the value when the dictionary was set on the compressor");

let actual_adler = decoder.set_dictionary(&dictionary).unwrap();

assert_eq!(required_adler, actual_adler);

// Decompress the rest of the input to the remainder of the output buffer
let total_in = decoder.total_in();
let total_out = decoder.total_out();

let decompress_result = decoder.decompress(
&encoded[total_in as usize..],
&mut decoded[total_out as usize..],
FlushDecompress::Finish,
);
assert!(decompress_result.is_ok());

assert_eq!(&decoded[..decoder.total_out() as usize], string);
}

#[cfg(feature = "any_zlib")]
#[test]
fn set_dictionary_raw() {
let string = "hello, hello!".as_bytes();
let dictionary = "hello".as_bytes();

let mut encoded = Vec::with_capacity(1024);

let mut encoder = Compress::new(Compression::default(), false);

encoder.set_dictionary(&dictionary).unwrap();

encoder
.compress_vec(string, &mut encoded, FlushCompress::Finish)
.unwrap();

assert_eq!(encoder.total_in(), string.len() as u64);
assert_eq!(encoder.total_out(), encoded.len() as u64);

let mut decoder = Decompress::new(false);

decoder.set_dictionary(&dictionary).unwrap();

let mut decoded = [0; 1024];
let decompress_result = decoder.decompress(&encoded, &mut decoded, FlushDecompress::Finish);

assert!(decompress_result.is_ok());

assert_eq!(&decoded[..decoder.total_out() as usize], string);
}

#[cfg(feature = "any_zlib")]
#[cfg(any(feature = "any_zlib", feature = "zlib-rs"))]
#[test]
fn test_gzip_flate() {
let string = "hello, hello!".as_bytes();
Expand Down
Loading