use indexmap::indexset; use oxipng::{internal_tests::*, *}; use serde_json::Value; use std::{ fs::remove_file, path::{Path, PathBuf}, process::Command, }; const GRAY: u8 = 0; const RGB: u8 = 2; const INDEXED: u8 = 3; fn get_opts(input: &Path) -> (OutFile, Options) { let options = Options { force: true, fast_evaluation: false, filters: indexset! {FilterStrategy::NONE}, ..Default::default() }; (OutFile::from_path(input.with_extension("out.png")), options) } /// Add callback to allow checks before the output file is deleted again #[allow(clippy::too_many_arguments)] fn test_it_converts_callbacks( input: PathBuf, output: &OutFile, opts: &oxipng::Options, color_type_in: u8, bit_depth_in: BitDepth, color_type_out: u8, bit_depth_out: BitDepth, mut callback_pre: CBPRE, mut callback_post: CBPOST, ) where CBPOST: FnMut(&PngData), CBPRE: FnMut(&PngData), { let parse_opts = Options { fix_errors: true, ..Default::default() }; let png = PngData::new(&input, &parse_opts).unwrap(); assert_eq!(png.raw.ihdr.color_type.png_header_code(), color_type_in); assert_eq!(png.raw.ihdr.bit_depth, bit_depth_in); callback_pre(&png); match oxipng::optimize(&InFile::Path(input), output, opts) { Ok(_) => (), Err(x) => panic!("{}", x), } let output = output.path().unwrap(); assert!(output.exists()); let png = match PngData::new(output, opts) { Ok(x) => x, Err(x) => { remove_file(output).ok(); panic!("{}", x) } }; callback_post(&png); assert_eq!(png.raw.ihdr.color_type.png_header_code(), color_type_out); assert_eq!(png.raw.ihdr.bit_depth, bit_depth_out); remove_file(output).ok(); } /// Shim for new callback functionality fn test_it_converts( input: PathBuf, output: &OutFile, opts: &oxipng::Options, color_type_in: u8, bit_depth_in: BitDepth, color_type_out: u8, bit_depth_out: BitDepth, ) { test_it_converts_callbacks( input, output, opts, color_type_in, bit_depth_in, color_type_out, bit_depth_out, |_| {}, |_| {}, ); } #[test] fn verbose_mode() { use log::{Level, LevelFilter, Log, Metadata, Record, set_logger, set_max_level}; use std::cell::RefCell; use std::sync::mpsc::{Sender, channel}; // Rust runs tests in parallel by default. // We want to make sure that we verify only logs from our test. // // For that, we store an Option in a thread-local variable and // initialise it with Some(sender) only on threads spawned within // our test. thread_local! { static VERBOSE_LOGS: RefCell>> = const { RefCell::new(None) }; } struct LogTester; impl Log for LogTester { fn enabled(&self, metadata: &Metadata) -> bool { metadata.level() <= Level::Debug } fn log(&self, record: &Record) { if record.level() == Level::Debug { VERBOSE_LOGS.with(|logs| { // If current thread has a storage for logs, add our line. // Otherwise our handler is invoked from an unrelated test. if let Some(logs) = logs.borrow().as_ref() { logs.send(record.args().to_string()).unwrap(); } }); } } fn flush(&self) {} } set_logger(&LogTester).unwrap(); set_max_level(LevelFilter::Debug); let input = PathBuf::from("tests/files/verbose_mode.png"); let (output, opts) = get_opts(&input); let (sender, receiver) = channel(); let thread_init = move || { // Initialise logs storage for all threads within our test. VERBOSE_LOGS.with(|logs| *logs.borrow_mut() = Some(sender.clone())); }; let thread_exec = move || { test_it_converts( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, ); }; #[cfg(feature = "parallel")] rayon::ThreadPoolBuilder::new() .start_handler(move |_| thread_init()) .num_threads(rayon::current_num_threads() + 1) .build() .unwrap() .install(move || rayon::spawn(thread_exec)); #[cfg(not(feature = "parallel"))] std::thread::spawn(move || { thread_init(); thread_exec(); }); let logs: Vec<_> = receiver.into_iter().collect(); let expected_prefixes = [ " 500x400 pixels, PNG format", " 8-bit RGB, non-interlaced", " IDAT size = 113794 bytes", " File size = 114708 bytes", "Trying 1 filters with zc = ", "Found better result:", " zc = 11, f = None", " IDAT size = ", " file size = ", ]; assert_eq!(logs.len(), expected_prefixes.len()); for (i, log) in logs.into_iter().enumerate() { let expected_prefix = expected_prefixes[i]; assert!( log.starts_with(expected_prefix), "logs[{i}] = {log:?} doesn't start with {expected_prefix:?}" ); } } fn count_chunk(png: &PngData, name: &[u8; 4]) -> usize { png.aux_chunks .iter() .filter(|chunk| &chunk.name == name) .count() } #[test] fn strip_chunks_list() { let input = PathBuf::from("tests/files/strip_chunks_list.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::Strip(indexset![*b"iCCP", *b"tEXt"]); test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"tEXt"), 3); assert_eq!(count_chunk(png, b"iTXt"), 1); assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"tEXt"), 0); assert_eq!(count_chunk(png, b"iTXt"), 1); assert_eq!(count_chunk(png, b"iCCP"), 0); }, ); } #[test] fn strip_chunks_safe() { let input = PathBuf::from("tests/files/strip_chunks_safe.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::Safe; test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"tEXt"), 3); assert_eq!(count_chunk(png, b"iTXt"), 1); assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"tEXt"), 0); assert_eq!(count_chunk(png, b"iTXt"), 0); assert_eq!(count_chunk(png, b"iCCP"), 0); }, ); } #[test] fn strip_chunks_all() { let input = PathBuf::from("tests/files/strip_chunks_all.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::All; test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"tEXt"), 3); assert_eq!(count_chunk(png, b"iTXt"), 1); assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"tEXt"), 0); assert_eq!(count_chunk(png, b"iTXt"), 0); assert_eq!(count_chunk(png, b"iCCP"), 0); }, ); } #[test] fn strip_chunks_none() { let input = PathBuf::from("tests/files/strip_chunks_none.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::None; test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"tEXt"), 3); assert_eq!(count_chunk(png, b"iTXt"), 1); assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"tEXt"), 3); assert_eq!(count_chunk(png, b"iTXt"), 1); assert_eq!(count_chunk(png, b"iCCP"), 1); }, ); } #[test] fn interlacing_0_to_1() { let input = PathBuf::from("tests/files/interlacing_0_to_1.png"); let (output, mut opts) = get_opts(&input); opts.interlace = Some(true); test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert!(!png.raw.ihdr.interlaced); }, |png| { assert!(png.raw.ihdr.interlaced); }, ); } #[test] fn interlacing_1_to_0() { let input = PathBuf::from("tests/files/interlacing_1_to_0.png"); let (output, mut opts) = get_opts(&input); opts.interlace = Some(false); test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert!(png.raw.ihdr.interlaced); }, |png| { assert!(!png.raw.ihdr.interlaced); }, ); } #[test] fn interlacing_0_to_1_small_files() { let input = PathBuf::from("tests/files/interlacing_0_to_1_small_files.png"); let (output, mut opts) = get_opts(&input); opts.interlace = Some(true); test_it_converts_callbacks( input, &output, &opts, INDEXED, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert!(!png.raw.ihdr.interlaced); }, |png| { assert!(png.raw.ihdr.interlaced); }, ); } #[test] fn interlacing_1_to_0_small_files() { let input = PathBuf::from("tests/files/interlacing_1_to_0_small_files.png"); let (output, mut opts) = get_opts(&input); opts.interlace = Some(false); test_it_converts_callbacks( input, &output, &opts, INDEXED, BitDepth::Eight, RGB, BitDepth::Eight, |png| { assert!(png.raw.ihdr.interlaced); }, |png| { assert!(!png.raw.ihdr.interlaced); }, ); } #[test] fn interlaced_0_to_1_other_filter_mode() { let input = PathBuf::from("tests/files/interlaced_0_to_1_other_filter_mode.png"); let (output, mut opts) = get_opts(&input); opts.interlace = Some(true); opts.filters = indexset! {FilterStrategy::PAETH}; test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Sixteen, GRAY, BitDepth::Sixteen, |png| { assert!(!png.raw.ihdr.interlaced); }, |png| { assert!(png.raw.ihdr.interlaced); }, ); } #[test] fn preserve_attrs() { let input = PathBuf::from("tests/files/preserve_attrs.png"); let meta_input = input .metadata() .expect("unable to get metadata for input file"); let (mut output, opts) = get_opts(&input); if let OutFile::Path { preserve_attrs, .. } = &mut output { *preserve_attrs = true; } match oxipng::optimize(&InFile::Path(input), &output, &opts) { Ok(_) => (), Err(x) => panic!("{}", x), } let output = output.path().unwrap(); assert!(output.exists()); match PngData::new(output, &opts) { Ok(x) => x, Err(x) => { remove_file(output).ok(); panic!("{}", x) } }; let meta_output = output .metadata() .expect("unable to get metadata for output file"); assert_eq!( meta_input.modified().ok(), meta_output.modified().ok(), "expected modification time to be identical to that of input", ); assert_eq!( meta_input.permissions(), meta_output.permissions(), "expected permissions to be identical to that of input", ); remove_file(output).ok(); } #[test] fn fix_errors() { let input = PathBuf::from("tests/files/fix_errors.png"); let (output, mut opts) = get_opts(&input); opts.fix_errors = true; test_it_converts( input, &output, &opts, INDEXED, BitDepth::Eight, INDEXED, BitDepth::Eight, ); } #[test] fn no_grayscale_change() { let input = PathBuf::from("tests/files/rgb_8_should_be_grayscale_8.png"); let (output, mut opts) = get_opts(&input); opts.grayscale_reduction = false; test_it_converts( input, &output, &opts, RGB, BitDepth::Eight, INDEXED, BitDepth::Eight, ); } #[test] fn profile_adobe_rgb_disallow_gray() { let input = PathBuf::from("tests/files/profile_adobe_rgb_disallow_gray.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::Safe; test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, INDEXED, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"iCCP"), 1); }, ); } #[test] fn profile_srgb_allow_gray() { let input = PathBuf::from("tests/files/profile_srgb_allow_gray.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::Safe; test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, GRAY, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"iCCP"), 0); assert_eq!(count_chunk(png, b"sRGB"), 0); }, ); } #[test] fn profile_srgb_no_strip_disallow_gray() { let input = PathBuf::from("tests/files/profile_srgb_no_strip_disallow_gray.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::None; test_it_converts_callbacks( input, &output, &opts, RGB, BitDepth::Eight, INDEXED, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"iCCP"), 1); }, ); } #[test] fn profile_gray_disallow_color() { let input = PathBuf::from("tests/files/profile_gray_disallow_color.png"); let (output, mut opts) = get_opts(&input); opts.strip = StripChunks::Safe; test_it_converts_callbacks( input, &output, &opts, GRAY, BitDepth::Eight, GRAY, BitDepth::Eight, |png| { assert_eq!(count_chunk(png, b"iCCP"), 1); }, |png| { assert_eq!(count_chunk(png, b"iCCP"), 1); }, ); } #[test] fn no_bit_depth_change() { let input = PathBuf::from("tests/files/palette_4_should_be_palette_2.png"); let (output, mut opts) = get_opts(&input); opts.bit_depth_reduction = false; test_it_converts( input, &output, &opts, INDEXED, BitDepth::Four, INDEXED, BitDepth::Four, ); } #[test] fn scale_16() { let input = PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"); let (output, mut opts) = get_opts(&input); opts.scale_16 = true; test_it_converts( input, &output, &opts, RGB, BitDepth::Sixteen, RGB, BitDepth::Eight, ); } #[test] fn max_size() { let result = oxipng::optimize( &"tests/files/max_size.png".into(), &OutFile::None, &Options { max_decompressed_size: Some(150_000), ..Options::default() }, ); assert!(matches!(result, Err(PngError::InflatedDataTooLong(_)))); } #[test] #[cfg(feature = "zopfli")] fn zopfli_mode() { let input = PathBuf::from("tests/files/zopfli_mode.png"); let (output, mut opts) = get_opts(&input); opts.deflater = Deflater::Zopfli(ZopfliOptions::default()); test_it_converts( input, &output, &opts, RGB, BitDepth::Eight, RGB, BitDepth::Eight, ); } #[test] fn json_success() { let path = "tests/files/json.png"; let output = Command::new(env!("CARGO_BIN_EXE_oxipng")) .args(["--json", "--nx", "--nz", path]) .output() .expect("Failed to run executable"); assert!(output.status.success()); let stdout = String::from_utf8_lossy(&output.stdout); let data: Value = serde_json::from_str(&stdout).expect("Failed to parse JSON"); let result = &data["results"][0]; assert_eq!(result["input"], path); assert_eq!(result["status"], "success"); assert_eq!(result["output"], path); assert_eq!(result["insize"], result["outsize"]); } #[test] fn json_dry_run() { let path = "tests/files/json.png"; let path2 = "tests/files/escape chars \\ \" \n \t \r \x08 \x0c.png"; let output = Command::new(env!("CARGO_BIN_EXE_oxipng")) .args(["--json", "--dry-run", path, path2]) .output() .expect("Failed to run executable"); assert!(output.status.success()); let stdout = String::from_utf8_lossy(&output.stdout); let data: Value = serde_json::from_str(&stdout).expect("Failed to parse JSON"); let result = &data["results"][0]; assert_eq!(result["input"], path); assert_eq!(result["status"], "success"); assert_eq!(result["output"], Value::Null); let result2 = &data["results"][1]; assert_eq!(result2["input"], path2); assert_eq!(result2["status"], "error"); }