#![cfg(feature = "snapshot")]
#![cfg(feature = "wgpu")]
use egui::{Modifiers, ScrollArea, Vec2, include_image};
use egui_kittest::{Harness, SnapshotResults};
use kittest::Queryable as _;
#[test]
fn test_shrink() {
let mut harness = Harness::new_ui(|ui| {
ui.label("Hello, world!");
ui.separator();
ui.label("This is a test");
});
harness.fit_contents();
#[cfg(all(feature = "snapshot", feature = "wgpu"))]
harness.snapshot("test_shrink");
}
#[test]
fn test_tooltip() {
let mut harness = Harness::new_ui(|ui| {
ui.label("Hello, world!");
ui.separator();
ui.label("This is a test")
.on_hover_text("This\nis\na\nvery\ntall\ntooltip!");
});
harness.fit_contents();
#[cfg(all(feature = "snapshot", feature = "wgpu"))]
harness.snapshot("test_tooltip_hidden");
harness.get_by_label("This is a test").hover();
harness.run_ok();
harness.fit_contents();
#[cfg(all(feature = "snapshot", feature = "wgpu"))]
harness.snapshot("test_tooltip_shown");
}
#[test]
fn test_modifiers() {
#[derive(Default)]
struct State {
cmd_clicked: bool,
cmd_z_pressed: bool,
cmd_y_pressed: bool,
}
let mut harness = Harness::new_ui_state(
|ui, state| {
if ui.button("Click me").clicked() && ui.input(|i| i.modifiers.command) {
state.cmd_clicked = true;
}
if ui.input(|i| i.modifiers.command && i.key_pressed(egui::Key::Z)) {
state.cmd_z_pressed = true;
}
if ui.input(|i| i.modifiers.command && i.key_pressed(egui::Key::Y)) {
state.cmd_y_pressed = true;
}
},
State::default(),
);
harness
.get_by_label("Click me")
.click_modifiers(Modifiers::COMMAND);
harness.run();
harness.key_press_modifiers(Modifiers::COMMAND, egui::Key::Z);
harness.run();
harness.key_combination_modifiers(Modifiers::COMMAND, &[egui::Key::Y]);
harness.run();
let state = harness.state();
assert!(state.cmd_clicked, "The button wasn't command-clicked");
assert!(state.cmd_z_pressed, "Cmd+Z wasn't pressed");
assert!(state.cmd_y_pressed, "Cmd+Y wasn't pressed");
}
#[test]
fn should_wait_for_images() {
let mut harness = Harness::builder()
.with_size(Vec2::new(60.0, 120.0))
.build_ui(|ui| {
egui_extras::install_image_loaders(ui.ctx());
let size = Vec2::splat(30.0);
ui.label("Url:");
ui.add_sized(
size,
egui::Image::new(
"https://raw.githubusercontent.com\
/emilk/egui/refs/heads/main/crates/eframe/data/icon.png",
),
);
ui.label("Include:");
ui.add_sized(
size,
egui::Image::new(include_image!("../../eframe/data/icon.png")),
);
});
harness.snapshot("should_wait_for_images");
}
fn test_scroll_harness() -> Harness<'static, bool> {
Harness::builder()
.with_size(Vec2::new(100.0, 200.0))
.build_ui_state(
|ui, state| {
ScrollArea::vertical().show(ui, |ui| {
for i in 0..20 {
ui.label(format!("Item {i}"));
}
if ui.button("Hidden Button").clicked() {
*state = true;
}
});
},
false,
)
}
#[cfg(feature = "snapshot")]
#[test]
fn test_scroll_to_me() {
let mut harness = test_scroll_harness();
let mut results = SnapshotResults::new();
results.add(harness.try_snapshot("test_scroll_initial"));
harness.get_by_label("Hidden Button").scroll_to_me();
harness.run();
results.add(harness.try_snapshot("test_scroll_scrolled"));
harness.get_by_label("Hidden Button").click();
harness.run();
assert!(
harness.state(),
"The button was not clicked after scrolling."
);
}
#[test]
fn test_scroll_down() {
let mut harness = test_scroll_harness();
let button = harness.get_by_label("Hidden Button");
button.scroll_down();
button.scroll_down();
harness.run();
harness.get_by_label("Hidden Button").click();
harness.run();
assert!(
harness.state(),
"The button was not clicked after scrolling down. (Probably not scrolled enough / at all)"
);
}
#[test]
fn test_masking() {
let mut harness = Harness::new_ui(|ui| {
let timestamp = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap()
.as_millis();
ui.label("I should not be masked.");
ui.label(format!("Timestamp: {timestamp}"));
ui.label("I should also not be masked.");
});
harness.fit_contents();
let to_be_masked = harness.get_by_label_contains("Timestamp: ");
harness.mask(to_be_masked.rect());
harness.snapshot("test_masking");
}
#[test]
fn test_remove_cursor() {
let hovered = false;
let mut harness = Harness::new_ui_state(
|ui, state| {
let response = ui.button("Click me");
*state = response.hovered();
},
hovered,
);
harness.fit_contents();
harness.get_by_label("Click me").click();
harness.run();
assert!(harness.state(), "The button should be hovered");
let hovered_button_snapshot = harness.render().expect("Failed to render");
harness.remove_cursor();
harness.run();
assert!(
!harness.state(),
"The button should not be hovered after removing cursor"
);
let non_hovered_button_snapshot = harness.render().expect("Failed to render");
assert_ne!(
hovered_button_snapshot, non_hovered_button_snapshot,
"The button appearance should change"
);
}
#[test]
fn test_ime_composition_visuals() {
let mut harness = Harness::new_ui_state(
|ui, state| {
egui::TextEdit::multiline(state)
.desired_width(120.0)
.desired_rows(5)
.show(ui);
},
"Hello. Bye.".to_owned(),
);
harness.fit_contents();
let text_edit = harness.get_by_role(egui::accesskit::Role::MultilineTextInput);
text_edit.focus();
harness.run();
harness.key_press(egui::Key::Home);
for _ in 0.."Hello. ".len() {
harness.key_press(egui::Key::ArrowRight);
}
let text = "Have you ever seen an IME composing English text? You now see it. ";
let text_index_1 = "Have you ever ".chars().count();
let text_index_2 = "Have you ever seen an IME composing English text? "
.chars()
.count();
harness.event(egui::Event::Ime(egui::ImeEvent::Preedit {
text: text.to_owned(),
active_range_chars: Some(text_index_1..text_index_2),
}));
harness.run();
harness.snapshot("test_ime_composition_visuals_segment");
harness.event(egui::Event::Ime(egui::ImeEvent::Preedit {
text: text.to_owned(),
active_range_chars: Some(text_index_2..text_index_2),
}));
harness.run();
harness.snapshot("test_ime_composition_visuals_cursor");
}
#[test]
fn inner_size_viewport_command() {
let new_size = Vec2::new(300.0, 200.0);
#[derive(Default)]
struct State {
requested: bool,
observed_size: Option<Vec2>,
}
let mut harness = Harness::builder()
.with_size(Vec2::new(100.0, 80.0))
.build_ui_state(
|ui, state: &mut State| {
if !state.requested {
state.requested = true;
ui.ctx()
.send_viewport_cmd(egui::ViewportCommand::InnerSize(new_size));
}
state.observed_size = Some(ui.ctx().viewport_rect().size());
},
State::default(),
);
harness.run();
assert_eq!(harness.state().observed_size, Some(new_size));
}