migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-09-02 06:40:06 -04:00
Code Activity

Add diagnostic_max_steps for a betterExceededMaxStepsError (#8421)

Browse Source 
This allows you to see how many more steps it would have taken for the
harness to settle.
Useful to see if you're in a infinite repaint loop or just need a
`harness.run_steps(3)` to give it some more frames to settle.
Should make it easier to make the default step count tighter, which
should make tests faster.
This commit is contained in:
Lucas Meurer
2026-08-31 15:29:10 +02:00
committed by GitHub
parent 7b34fc0e03
commit 47fa50d9a7
3 changed files with 86 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
crates/egui_kittest/src/config.rs
View File

@@ -1,5 +1,3 @@
#![cfg(feature = "snapshot")]
use std::io;
use std::path::PathBuf;
@@ -30,6 +28,14 @@ pub struct Config {
#[serde(alias = "failed_pixel_count_threshold")]
max_failed_pixels: usize,
/// How far past `max_steps` [`crate::Harness::try_run`] keeps stepping to find out how many
/// steps the ui would have needed.
///
/// This tells a budget which is slightly too tight apart from a ui that never stops repainting.
///
/// Default is 100.
diagnostic_max_steps: u64,
windows: OsConfig,
mac: OsConfig,
linux: OsConfig,
@@ -41,6 +47,7 @@ impl Default for Config {
output_path: PathBuf::from("tests/snapshots"),
threshold: 0.6,
max_failed_pixels: 0,
diagnostic_max_steps: 100,
windows: Default::default(),
mac: Default::default(),
linux: Default::default(),
@@ -144,16 +151,24 @@ impl Config {
&INSTANCE
}
/// How far past `max_steps` [`crate::Harness::try_run`] keeps stepping to find out how many
/// steps the ui would have needed.
///
/// Default is 100.
pub fn diagnostic_max_steps(&self) -> u64 {
self.diagnostic_max_steps
}
}
#[cfg(feature = "snapshot")]
impl Config {
/// The output path for image snapshots.
///
/// Default is "tests/snapshots".
pub fn output_path(&self) -> PathBuf {
self.output_path.clone()
}
}
#[cfg(feature = "snapshot")]
impl Config {
pub fn os_threshold(&self) -> crate::OsThreshold<f32> {
let fallback = self.threshold;
crate::OsThreshold {