re_viewer 0.31.2

The Rerun viewer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

mod app_testing_ext;

#[cfg(feature = "testing")]
pub use app_testing_ext::AppTestingExt;
use egui_kittest::Harness;
use re_build_info::build_info;
use re_viewer_context::AppOptions;

use crate::{
    App, AppEnvironment, AsyncRuntimeHandle, MainThreadToken, StartupOptions,
    customize_eframe_and_setup_renderer,
};

pub type AppOptionsEditor = Box<dyn Fn(&mut AppOptions)>;

#[derive(Default)]
pub struct HarnessOptions {
    pub window_size: Option<egui::Vec2>,
    pub max_steps: Option<u64>,
    pub step_dt: Option<f32>,
    pub startup_url: Option<String>,
    pub enable_component_mapping: bool,
}

/// Convenience function for creating a kittest harness of the viewer App.
pub fn viewer_harness(options: &HarnessOptions) -> Harness<'static, App> {
    let window_size = options.window_size.unwrap_or(egui::vec2(1024.0, 768.0));

    let mut harness_builder =
        re_ui::testing::new_harness(re_ui::testing::TestOptions::Rendering3D, window_size);
    if let Some(max_steps) = options.max_steps {
        harness_builder = harness_builder.with_max_steps(max_steps);
    }
    if let Some(step_dt) = options.step_dt {
        harness_builder = harness_builder.with_step_dt(step_dt);
    }

    harness_builder.build_eframe(|cc| {
        cc.egui_ctx.set_os(egui::os::OperatingSystem::Nix);
        customize_eframe_and_setup_renderer(cc).expect("Failed to customize eframe");
        let mut app = App::new(
            MainThreadToken::i_promise_i_am_only_using_this_for_a_test(),
            build_info!(),
            AppEnvironment::Test,
            StartupOptions {
                // Don't show the welcome / example screen in tests.
                // See also: https://github.com/rerun-io/rerun/issues/10989
                hide_welcome_screen: true,
                // Don't calculate memory limit in tests.
                memory_limit: re_memory::MemoryLimit::UNLIMITED,
                ..Default::default()
            },
            cc,
            Some(re_redap_client::ConnectionRegistry::new_without_stored_credentials()),
            AsyncRuntimeHandle::from_current_tokio_runtime_or_wasmbindgen()
                .expect("Failed to create AsyncRuntimeHandle"),
        );
        // Force the FFmpeg path to be wrong so we have a reproducible behavior.
        app.app_options_mut().video.ffmpeg_path = "/fake/ffmpeg/path".to_owned();
        app.app_options_mut().video.override_ffmpeg_path = true;

        // This is slightly different than calling this after we created the harness since
        // the harness will do some stepping upon creation.
        // Opening a URL directly after creation is much closer to the behavior when opening URL from command line start.
        if let Some(startup_url) = &options.startup_url {
            app.open_url_or_file(startup_url);
        }

        app
    })
}

/// Steps through the harness until the `predicate` closure returns `true`.
#[track_caller]
pub fn step_until<'app, 'harness, Predicate>(
    test_description: &'static str,
    harness: &'harness mut egui_kittest::Harness<'app, App>,
    mut predicate: Predicate,
    step_duration: std::time::Duration,
    max_duration: std::time::Duration,
) where
    Predicate: for<'a> FnMut(&'a egui_kittest::Harness<'app, App>) -> bool,
{
    let start_time = std::time::Instant::now();
    let mut success = predicate(harness);
    while !success && start_time.elapsed() <= max_duration {
        harness.step();
        std::thread::sleep(step_duration);
        harness.step();
        success = predicate(harness);
    }

    if !success {
        // Take a screenshot of the state of the harness if we failed the test.
        // This is invaluable for debugging test failures.
        let snapshot_path = "tests/failures";
        harness
            .try_snapshot_options(
                test_description,
                &egui_kittest::SnapshotOptions::default().output_path(snapshot_path),
            )
            .ok();

        panic!(
            "Timed out waiting for predicate to be true for {test_description:?}. A screenshot of the harness has been saved to `{snapshot_path}/{test_description}.new.png`."
        );
    }
}