ribir_dev_helper 0.4.0-alpha.65

use ribir_painter::{ColorFormat, GlyphRasterSource, PixelImage};
use ribir_types::Transform;

/// This macro generates image tests for the painter with every backend.
///
/// Accept a function returning a painter. The generated test name is the
/// function name composed a prefix(the backend name). The test will check if
/// the backend renders the painter result to generate the same content as the
/// image file.
///
/// The image file is read from the `test_cases` folder in the workspace root,
/// and its path relative to the `test_cases` is `{module path}\{backend
/// name}\{function name}.{fmt}`:
///
/// - the `{module path}` is where the generated test is placed.
/// - the `{backend name}` is the painter-backend name like `wgpu`.
/// - the `{function  name}` is the function you pass to the macro.
/// - the `{fmt}` is the file format the backend wants to check.
///
/// You can run the test with `RIBIR_IMG_TEST=overwrite` to overwrite the image
/// file, for example ```
/// RIBIR_IMG_TEST=overwrite cargo test -- smoke
#[cfg(not(target_arch = "wasm32"))]
#[macro_export]
macro_rules! painter_backend_eq_image_test {
  ($painter_fn:ident $(, comparison = $comparison:expr)?) => {
    paste::paste! {
      #[test]
      fn [<wgpu_ $painter_fn>]() {
        ribir_core::reset_test_env!();
        let mut painter = $painter_fn();
        let viewport = painter.viewport().to_i32().cast_unit();
        let glyph_provider = AppCtx::text_services().raster_source();
        let img = wgpu_render_commands(
          &painter.finish(),
          viewport,
          Color::TRANSPARENT,
          glyph_provider.as_ref().as_ref(),
        );
        let name = format!("{}_wgpu", std::stringify!($painter_fn));
        let file_path = test_case_name!(name, "webp");
        ImageTest::new(img, &file_path)
          $(.with_comparison($comparison))?
          .test();
      }
    }
  };
}

#[macro_export]
macro_rules! test_case_name {
  ($name:expr, $format:literal) => {{
    let mut path_buffer = std::path::PathBuf::from(env!("CARGO_WORKSPACE_DIR"));
    let module_path = std::module_path!();
    let path = module_path.replace("::", "/");
    path_buffer.push(&format!("test_cases/{path}/{}.{}", $name, $format));

    path_buffer
  }};
}

#[cfg(not(target_arch = "wasm32"))]
pub struct ImageTest<'a> {
  test_img: PixelImage,
  ref_path: &'a std::path::Path,
  comparison: f64,
}

#[cfg(not(target_arch = "wasm32"))]
impl<'a> ImageTest<'a> {
  pub fn new(test_img: PixelImage, ref_path: &'a std::path::Path) -> Self {
    Self { test_img, ref_path, comparison: 0.000025 }
  }

  pub fn with_comparison(mut self, comparison: f64) -> Self {
    self.comparison = comparison;
    self
  }

  #[track_caller]
  pub fn test(self) {
    let Self { test_img, ref_path, comparison } = self;

    let overwrite = std::ffi::OsStr::new("overwrite");
    let dir = ref_path.parent().unwrap();
    let stem = ref_path.file_stem().unwrap().to_str().unwrap();
    if std::env::var_os("RIBIR_IMG_TEST").is_some_and(|var| var == overwrite) {
      std::fs::create_dir_all(dir).unwrap();
      Self::write_webp(&test_img, ref_path);
    } else {
      let ref_img = PixelImage::from_webp(&std::fs::read(ref_path).unwrap()).unwrap();

      assert_eq!(test_img.pixel_bytes().len(), ref_img.pixel_bytes().len());
      assert_eq!(test_img.color_format(), ColorFormat::Rgba8);
      assert_eq!(ref_img.color_format(), ColorFormat::Rgba8);

      let mut dssim = dssim_core::Dssim::new();
      dssim.set_save_ssim_maps(1);
      let test_data = unsafe {
        let ptr = test_img.pixel_bytes().as_ptr() as *const _;
        std::slice::from_raw_parts(ptr, test_img.pixel_bytes().len() / 4)
      };
      let d_test = dssim
        .create_image_rgba(test_data, test_img.width() as usize, test_img.height() as usize)
        .unwrap();
      let ref_dat = unsafe {
        let ptr = ref_img.pixel_bytes().as_ptr() as *const _;
        std::slice::from_raw_parts(ptr, ref_img.pixel_bytes().len() / 4)
      };
      let d_ref = dssim
        .create_image_rgba(ref_dat, ref_img.width() as usize, ref_img.height() as usize)
        .unwrap();

      let (v, mut diffs) = dssim.compare(&d_ref, d_test);
      let dssim: f64 = v.into();

      let diff_path = dir.join(format!("{stem}_diff.webp"));
      let actual_path = dir.join(format!("{stem}_actual.webp"));
      if dssim > f64::EPSILON {
        Self::write_webp(&test_img, &actual_path);
        Self::write_ssim_maps(diffs.pop().unwrap(), &diff_path);
      }

      assert!(
        dssim < comparison,
        "Image test failed. Expected Diff({dssim}) to be less than {comparison}. The actual image \
         and difference image have been saved next to the expected image.
      Expected image location: {ref_path:?}
      Actual image location: {actual_path:?}
      Difference file location: {diff_path:?}"
      );
    }
  }

  fn write_webp(img: &PixelImage, path: &std::path::Path) {
    let mut file = std::fs::File::create(path).unwrap();
    img.write_as_webp(&mut file).unwrap();
  }

  #[track_caller]
  fn write_ssim_maps(ssim_map: dssim_core::SsimMap, out_file: &std::path::Path) {
    fn to_byte(i: f32) -> u8 {
      if i <= 0.0 {
        0
      } else if i >= 255.0 / 256.0 {
        255
      } else {
        (i * 256.0) as u8
      }
    }

    let avgssim = ssim_map.ssim as f32;
    let out = ssim_map
      .map
      .pixels()
      .flat_map(|ssim| {
        let max = 1_f32 - ssim;
        let maxsq = max * max;
        [to_byte(maxsq * 16.0), to_byte(max * 3.0), to_byte(max / ((1_f32 - avgssim) * 4_f32)), 255]
      })
      .collect();
    let diff_img = PixelImage::new(
      out,
      ssim_map.map.width() as u32,
      ssim_map.map.height() as u32,
      ColorFormat::Rgba8,
    );
    Self::write_webp(&diff_img, out_file);
  }
}

#[cfg(not(target_arch = "wasm32"))]
#[track_caller]
pub fn assert_texture_eq_png(test_img: PixelImage, ref_path: &std::path::Path) {
  ImageTest::new(test_img, ref_path).test();
}

/// Render painter by wgpu backend, and return the image.
pub fn wgpu_render_commands(
  commands: &[ribir_painter::PaintCommand], viewport: ribir_types::DeviceRect,
  surface: ribir_painter::Color, glyph_provider: &dyn GlyphRasterSource,
) -> PixelImage {
  use futures::executor::block_on;
  use ribir_gpu::{GPUBackend, GPUBackendImpl, Texture, WgpuImpl};
  use ribir_painter::PainterBackend;
  use ribir_types::{DeviceRect, DeviceSize};

  let draw_img = |backend: &mut GPUBackend<WgpuImpl>| {
    let rect = DeviceRect::from_size(DeviceSize::new(viewport.max_x() + 2, viewport.max_y() + 2));
    let mut texture = backend
      .get_impl_mut()
      .new_texture(rect.size, ColorFormat::Rgba8);
    backend.begin_frame(surface);
    backend.draw_commands(rect, commands, &Transform::identity(), &mut texture, glyph_provider);
    backend.end_frame();
    let img = texture.copy_as_image(&rect, backend.get_impl_mut());
    block_on(img).unwrap()
  };

  #[cfg(not(target_arch = "wasm32"))]
  {
    use std::sync::Mutex;

    // Let's ensure that the GPU tests run in single threads and reuse the
    // `WgpuImpl`. This is to account for the limited resources of the CI machine,
    // which may not support multiple tests simultaneously.
    static WGPU_IMPL: Mutex<Option<WgpuImpl>> = Mutex::new(None);

    let mut container = WGPU_IMPL.lock().unwrap();
    let wgpu_impl = container
      .take()
      .unwrap_or_else(|| block_on(ribir_gpu::WgpuImpl::headless()));
    let mut backend = GPUBackend::new(wgpu_impl);
    let img = draw_img(&mut backend);
    *container = Some(backend.into_impl());

    img
  }

  #[cfg(target_arch = "wasm32")]
  {
    let wgpu_impl = block_on(ribir_gpu::WgpuImpl::headless());
    let mut backend = GPUBackend::new(wgpu_impl);
    draw_img(&mut backend)
  }
}