Snapshot utility function in TestContext (#11328)

### What

Bikeshedding: replaces copies of the `run_view_ui_and_save_snapshot`
function and adds it to TestContext.

Some of the snapshots had to be updated because the new utility function
has one more `harness.run()`.

Author: aedm

crates/viewer/re_test_viewport/src/lib.rs

@@ -4,7 +4,7 @@ mod test_view;
 
 use ahash::HashMap;
 
-use re_test_context::TestContext;
+use re_test_context::{TestContext, external::egui_kittest::SnapshotOptions};
 use re_viewer_context::{Contents, ViewId, ViewerContext, VisitorControlFlow};
 
 use re_viewport_blueprint::{DataQueryPropertyResolver, ViewBlueprint, ViewportBlueprint};
@@ -26,6 +26,14 @@ pub trait TestContextExt {
 
     /// [`TestContext::run`] inside a central panel that displays the ui for a single given view.
     fn run_with_single_view(&mut self, ui: &mut egui::Ui, view_id: ViewId);
+
+    fn run_view_ui_and_save_snapshot(
+        &mut self,
+        view_id: ViewId,
+        snapshot_name: &str,
+        size: egui::Vec2,
+        snapshot_options: Option<SnapshotOptions>,
+    );
 }
 
 impl TestContextExt for TestContext {
@@ -166,4 +174,22 @@ impl TestContextExt for TestContext {
 
         self.handle_system_commands();
     }
+
+    fn run_view_ui_and_save_snapshot(
+        &mut self,
+        view_id: ViewId,
+        snapshot_name: &str,
+        size: egui::Vec2,
+        snapshot_options: Option<SnapshotOptions>,
+    ) {
+        let snapshot_options = snapshot_options.unwrap_or_default();
+        let mut harness = self
+            .setup_kittest_for_rendering()
+            .with_size(size)
+            .build_ui(|ui| {
+                self.run_with_single_view(ui, view_id);
+            });
+        harness.run();
+        harness.snapshot_options(snapshot_name, &snapshot_options);
+    }
 }

crates/viewer/re_view_bar_chart/tests/tensor_1d.rs renamed to crates/viewer/re_view_bar_chart/tests/bar_chart_test.rs

@@ -15,7 +15,7 @@ fn x() -> Vec<f32> {
 fn test_bar_chart() {
     let mut test_context = TestContext::new_with_view_class::<BarChartView>();
 
-    test_context.log_entity("tensor", |builder| {
+    test_context.log_entity("time_series", |builder| {
         builder.with_archetype(
             RowId::new(),
             TimePoint::STATIC,
@@ -24,11 +24,11 @@ fn test_bar_chart() {
     });
 
     let view_id = setup_blueprint(&mut test_context);
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
+    test_context.run_view_ui_and_save_snapshot(
         view_id,
-        "tensor_1d",
+        "bar_chart_1d",
         egui::vec2(400.0, 300.0),
+        None,
     );
 }
 
@@ -39,19 +39,3 @@ fn setup_blueprint(test_context: &mut TestContext) -> ViewId {
         ))
     })
 }
-
-fn run_view_ui_and_save_snapshot(
-    test_context: &mut TestContext,
-    view_id: ViewId,
-    name: &str,
-    size: egui::Vec2,
-) {
-    let mut harness = test_context
-        .setup_kittest_for_rendering()
-        .with_size(size)
-        .build_ui(|ui| {
-            test_context.run_with_single_view(ui, view_id);
-        });
-    harness.run();
-    harness.snapshot(name);
-}

crates/viewer/re_view_bar_chart/tests/snapshots/bar_chart_1d.png

@@ -28,11 +28,11 @@ pub fn test_null_timeline() {
     });
 
     let view_id = setup_blueprint(&mut test_context, timeline_a.name());
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
+    test_context.run_view_ui_and_save_snapshot(
         view_id,
         "null_timeline",
         egui::vec2(400.0, 200.0),
+        None,
     );
 }
 
@@ -51,11 +51,11 @@ pub fn test_unknown_timeline() {
 
     let view_id = setup_blueprint(&mut test_context, &TimelineName::from("unknown_timeline"));
 
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
+    test_context.run_view_ui_and_save_snapshot(
         view_id,
         "unknown_timeline_view_ui",
         egui::vec2(300.0, 150.0),
+        None,
     );
 
     run_view_selection_panel_ui_and_save_snapshot(
@@ -89,23 +89,6 @@ fn setup_blueprint(test_context: &mut TestContext, timeline_name: &TimelineName)
     })
 }
 
-fn run_view_ui_and_save_snapshot(
-    test_context: &mut TestContext,
-    view_id: ViewId,
-    name: &str,
-    size: egui::Vec2,
-) {
-    let mut harness = test_context
-        .setup_kittest_for_rendering()
-        .with_size(size)
-        .build_ui(|ui| {
-            test_context.run_with_single_view(ui, view_id);
-        });
-
-    harness.run();
-    harness.snapshot(name);
-}
-
 fn run_view_selection_panel_ui_and_save_snapshot(
     test_context: &mut TestContext,
     view_id: ViewId,

crates/viewer/re_view_bar_chart/tests/snapshots/tensor_1d.png

@@ -13,7 +13,7 @@ use re_types::{
     Archetype as _, blueprint::components::BackgroundKind, datatypes::ColorModel,
     image::ImageChannelType,
 };
-use re_viewer_context::{ViewClass as _, ViewId};
+use re_viewer_context::ViewClass as _;
 use re_viewport_blueprint::ViewBlueprint;
 
 fn convert_pixels_to<T: From<u8> + Copy>(u8s: &[u8]) -> Vec<T> {
@@ -55,30 +55,11 @@ fn run_bgr_test<T: ImageChannelType>(image: &[T], size: [u32; 2], color_model: C
         color_model.to_string().to_lowercase(),
     );
 
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
+    test_context.run_view_ui_and_save_snapshot(
         view_id,
         &snapshot_name,
         egui::vec2(160.0, 120.0),
-    );
-}
-
-fn run_view_ui_and_save_snapshot(
-    test_context: &mut TestContext,
-    view_id: ViewId,
-    name: &str,
-    size: egui::Vec2,
-) {
-    let mut harness = test_context
-        .setup_kittest_for_rendering()
-        .with_size(size)
-        .build_ui(|ui| {
-            test_context.run_with_single_view(ui, view_id);
-        });
-    harness.run();
-    harness.snapshot_options(
-        name,
-        &SnapshotOptions::new().failed_pixel_count_threshold(OsThreshold::new(2)),
+        Some(SnapshotOptions::new().failed_pixel_count_threshold(OsThreshold::new(2))),
     );
 }
 

crates/viewer/re_view_dataframe/tests/basic.rs

@@ -16,11 +16,11 @@ pub fn test_blueprint_no_overrides_or_defaults_with_spatial_2d() {
     log_arrows(&mut test_context);
 
     let view_id = setup_blueprint(&mut test_context, None, None);
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
+    test_context.run_view_ui_and_save_snapshot(
         view_id,
         "blueprint_no_overrides_or_defaults_with_spatial_2d",
         SNAPSHOT_SIZE,
+        None,
     );
 }
 
@@ -31,11 +31,11 @@ pub fn test_blueprint_overrides_with_spatial_2d() {
     log_arrows(&mut test_context);
 
     let view_id = setup_blueprint(&mut test_context, Some(&arrow_overrides()), None);
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
+    test_context.run_view_ui_and_save_snapshot(
         view_id,
         "blueprint_overrides_with_spatial_2d",
         SNAPSHOT_SIZE,
+        None,
     );
 }
 
@@ -46,11 +46,11 @@ pub fn test_blueprint_defaults_with_spatial_2d() {
     log_arrows(&mut test_context);
 
     let view_id = setup_blueprint(&mut test_context, None, Some(&arrow_defaults()));
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
+    test_context.run_view_ui_and_save_snapshot(
         view_id,
         "blueprint_defaults_with_spatial_2d",
         SNAPSHOT_SIZE,
+        None,
     );
 }
 
@@ -114,19 +114,3 @@ fn setup_blueprint(
         blueprint.add_view_at_root(view)
     })
 }
-
-fn run_view_ui_and_save_snapshot(
-    test_context: &mut TestContext,
-    view_id: ViewId,
-    name: &str,
-    size: egui::Vec2,
-) {
-    let mut harness = test_context
-        .setup_kittest_for_rendering()
-        .with_size(size)
-        .build_ui(|ui| {
-            test_context.run_with_single_view(ui, view_id);
-        });
-    harness.run();
-    harness.snapshot(name);
-}

crates/viewer/re_view_spatial/tests/bgr_images.rs

@@ -304,7 +304,7 @@ fn run_visible_time_range_test(
     add_data(&mut test_context);
 
     let view_id = setup_blueprint(&mut test_context, view_time_range, green_time_range);
-    run_view_ui_and_save_snapshot(&mut test_context, view_id, name, egui::vec2(200.0, 200.0));
+    test_context.run_view_ui_and_save_snapshot(view_id, name, egui::vec2(200.0, 200.0), None);
 }
 
 fn setup_blueprint(
@@ -358,20 +358,3 @@ fn setup_blueprint(
         view_id
     })
 }
-
-fn run_view_ui_and_save_snapshot(
-    test_context: &mut TestContext,
-    view_id: ViewId,
-    name: &str,
-    size: egui::Vec2,
-) {
-    let mut harness = test_context
-        .setup_kittest_for_rendering()
-        .with_size(size)
-        .build_ui(|ui| {
-            test_context.run_with_single_view(ui, view_id);
-        });
-
-    harness.run();
-    harness.snapshot(name);
-}

crates/viewer/re_view_spatial/tests/blueprint_2d.rs

@@ -24,12 +24,7 @@ fn test_tensor() {
     });
 
     let view_id = setup_blueprint(&mut test_context);
-    run_view_ui_and_save_snapshot(
-        &mut test_context,
-        view_id,
-        "tensor_1d",
-        egui::vec2(300.0, 50.0),
-    );
+    test_context.run_view_ui_and_save_snapshot(view_id, "tensor_1d", egui::vec2(300.0, 50.0), None);
 }
 
 fn setup_blueprint(test_context: &mut TestContext) -> ViewId {
@@ -39,19 +34,3 @@ fn setup_blueprint(test_context: &mut TestContext) -> ViewId {
         ))
     })
 }
-
-fn run_view_ui_and_save_snapshot(
-    test_context: &mut TestContext,
-    view_id: ViewId,
-    name: &str,
-    size: egui::Vec2,
-) {
-    let mut harness = test_context
-        .setup_kittest_for_rendering()
-        .with_size(size)
-        .build_ui(|ui| {
-            test_context.run_with_single_view(ui, view_id);
-        });
-    harness.run();
-    harness.snapshot(name);
-}