Improve testing framework

.gitattributes

@@ -0,0 +1 @@
+*.stdout text eol=lf

Cargo.toml

@@ -27,6 +27,8 @@ bevy = { version = "0.8", default-features = false }
 
 [dev-dependencies]
 bevy-inspector-egui = "0.12"
+goldenfile = "1.4.3"
+rstest = "0.15.0"
 
 [[example]]
 name = "menu"

src/lens.rs

@@ -36,6 +36,7 @@
 //! [`Quat::slerp()`]: https://docs.rs/bevy/0.8.0/bevy/math/struct.Quat.html#method.slerp
 
 use bevy::prelude::*;
+use std::fmt::Debug;
 
 /// A lens over a subset of a component.
 ///
@@ -65,6 +66,7 @@ use bevy::prelude::*;
 ///   }
 /// }
 /// ```
+#[cfg(not(test))]
 pub trait Lens<T> {
     /// Perform a linear interpolation (lerp) over the subset of fields of a
     /// component or asset the lens focuses on, based on the linear ratio
@@ -74,6 +76,11 @@ pub trait Lens<T> {
     fn lerp(&mut self, target: &mut T, ratio: f32);
 }
 
+#[cfg(test)]
+pub trait Lens<T>: Debug {
+    fn lerp(&mut self, target: &mut T, ratio: f32);
+}
+
 /// A lens to manipulate the [`color`] field of a section of a [`Text`]
 /// component.
 ///

src/lib.rs

@@ -468,6 +468,7 @@ mod tests {
 
     use super::{lens::*, *};
 
+    #[derive(Debug)]
     struct DummyLens {
         start: f32,
         end: f32,

testdata/tween_tick_loop_finite.stdout

@@ -0,0 +1,117 @@
+Initial tween state:
+Lens=TransformPositionLens {
+    start: Vec3(
+        0.0,
+        0.0,
+        0.0,
+    ),
+    end: Vec3(
+        1.0,
+        1.0,
+        1.0,
+    ),
+}
+Clock=AnimClock {
+    elapsed: 0ns,
+    duration: 1s,
+    times_completed: 0,
+    total_duration: Finite(
+        3s,
+    ),
+    strategy: Repeat,
+}
+Direction=Forward
+
+Tick by 0ns:
+0ns/1s elapsed
+Direction: Forward
+State: Active
+Progress: 0.0
+Total completions: 0
+Transform: Transform { translation: Vec3(0.0, 0.0, 0.0), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+333.333333ms/1s elapsed
+Direction: Forward
+State: Active
+Progress: 0.33333334
+Total completions: 0
+Transform: Transform { translation: Vec3(0.33333334, 0.33333334, 0.33333334), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+666.666666ms/1s elapsed
+Direction: Forward
+State: Active
+Progress: 0.6666667
+Total completions: 0
+Transform: Transform { translation: Vec3(0.6666667, 0.6666667, 0.6666667), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+999.999999ms/1s elapsed
+Direction: Forward
+State: Active
+Progress: 1.0
+Total completions: 0
+Transform: Transform { translation: Vec3(1.0, 1.0, 1.0), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+Completion received for 42v0
+1.333333332s/1s elapsed
+Direction: Forward
+State: Active
+Progress: 1.3333334
+Total completions: 1
+Transform: Transform { translation: Vec3(1.3333334, 1.3333334, 1.3333334), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 333.333333ms:
+1.666666665s/1s elapsed
+Direction: Forward
+State: Active
+Progress: 1.6666667
+Total completions: 1
+Transform: Transform { translation: Vec3(1.6666667, 1.6666667, 1.6666667), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+1.999999998s/1s elapsed
+Direction: Forward
+State: Active
+Progress: 2.0
+Total completions: 1
+Transform: Transform { translation: Vec3(2.0, 2.0, 2.0), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+Completion received for 42v0
+2.333333331s/1s elapsed
+Direction: Forward
+State: Active
+Progress: 2.3333333
+Total completions: 2
+Transform: Transform { translation: Vec3(2.3333333, 2.3333333, 2.3333333), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 333.333333ms:
+2.666666664s/1s elapsed
+Direction: Forward
+State: Active
+Progress: 2.6666667
+Total completions: 2
+Transform: Transform { translation: Vec3(2.6666667, 2.6666667, 2.6666667), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+2.999999997s/1s elapsed
+Direction: Forward
+State: Active
+Progress: 3.0
+Total completions: 2
+Transform: Transform { translation: Vec3(3.0, 3.0, 3.0), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 333.333333ms:
+Completion received for 42v0
+3.33333333s/1s elapsed
+Direction: Forward
+State: Completed
+Progress: 3.0
+Total completions: 3
+Transform: Transform { translation: Vec3(3.0, 3.0, 3.0), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }

testdata/tween_tick_loop_finite_large_jump.stdout

@@ -0,0 +1,51 @@
+Initial tween state:
+Lens=TransformPositionLens {
+    start: Vec3(
+        0.0,
+        0.0,
+        0.0,
+    ),
+    end: Vec3(
+        1.0,
+        1.0,
+        1.0,
+    ),
+}
+Clock=AnimClock {
+    elapsed: 0ns,
+    duration: 1.333333333s,
+    times_completed: 0,
+    total_duration: Finite(
+        133.3333333s,
+    ),
+    strategy: Repeat,
+}
+Direction=Forward
+
+Tick by 13.33333333s:
+Completion received for 42v0
+13.33333333s/1.333333333s elapsed
+Direction: Forward
+State: Active
+Progress: 9.999999
+Total completions: 10
+Transform: Transform { translation: Vec3(9.999999, 9.999999, 9.999999), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 18446744073709551615.999999999s:
+Completion received for 42v0
+18446744073709551615.999999999s/1.333333333s elapsed
+Direction: Forward
+State: Completed
+Progress: 99.99999
+Total completions: 100
+Transform: Transform { translation: Vec3(99.99999, 99.99999, 99.99999), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 18446744073709551615.999999999s:
+18446744073709551615.999999999s/1.333333333s elapsed
+Direction: Forward
+State: Completed
+Progress: 99.99999
+Total completions: 100
+Transform: Transform { translation: Vec3(99.99999, 99.99999, 99.99999), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }

testdata/tween_tick_loop_infinite_large_jump.stdout

@@ -0,0 +1,49 @@
+Initial tween state:
+Lens=TransformPositionLens {
+    start: Vec3(
+        0.0,
+        0.0,
+        0.0,
+    ),
+    end: Vec3(
+        1.0,
+        1.0,
+        1.0,
+    ),
+}
+Clock=AnimClock {
+    elapsed: 0ns,
+    duration: 1.333333333s,
+    times_completed: 0,
+    total_duration: Infinite,
+    strategy: Repeat,
+}
+Direction=Forward
+
+Tick by 13.33333333s:
+Completion received for 42v0
+13.33333333s/1.333333333s elapsed
+Direction: Forward
+State: Active
+Progress: 9.999999
+Total completions: 10
+Transform: Transform { translation: Vec3(9.999999, 9.999999, 9.999999), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 18446744073709551615.999999999s:
+Completion received for 42v0
+18446744073709551615.999999999s/1.333333333s elapsed
+Direction: Forward
+State: Active
+Progress: 1.3835058e19
+Total completions: 3458764514
+Transform: Transform { translation: Vec3(1.3835058e19, 1.3835058e19, 1.3835058e19), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 18446744073709551615.999999999s:
+18446744073709551615.999999999s/1.333333333s elapsed
+Direction: Forward
+State: Active
+Progress: 1.3835058e19
+Total completions: 3458764514
+Transform: Transform { translation: Vec3(1.3835058e19, 1.3835058e19, 1.3835058e19), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }

testdata/tween_tick_loop_partial_completion.stdout

@@ -0,0 +1,59 @@
+Initial tween state:
+Lens=TransformPositionLens {
+    start: Vec3(
+        0.0,
+        0.0,
+        0.0,
+    ),
+    end: Vec3(
+        1.0,
+        1.0,
+        1.0,
+    ),
+}
+Clock=AnimClock {
+    elapsed: 0ns,
+    duration: 666.666666ms,
+    times_completed: 0,
+    total_duration: Finite(
+        1.42s,
+    ),
+    strategy: Repeat,
+}
+Direction=Forward
+
+Tick by 400ms:
+400ms/666.666666ms elapsed
+Direction: Forward
+State: Active
+Progress: 0.59999996
+Total completions: 0
+Transform: Transform { translation: Vec3(0.59999996, 0.59999996, 0.59999996), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 400ms:
+Completion received for 42v0
+800ms/666.666666ms elapsed
+Direction: Forward
+State: Active
+Progress: 1.1999999
+Total completions: 1
+Transform: Transform { translation: Vec3(1.1999999, 1.1999999, 1.1999999), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 400ms:
+1.2s/666.666666ms elapsed
+Direction: Forward
+State: Active
+Progress: 1.8000001
+Total completions: 1
+Transform: Transform { translation: Vec3(1.8000001, 1.8000001, 1.8000001), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 400ms:
+Completion received for 42v0
+1.6s/666.666666ms elapsed
+Direction: Forward
+State: Completed
+Progress: 2.1299999
+Total completions: 2
+Transform: Transform { translation: Vec3(2.1299999, 2.1299999, 2.1299999), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }

testdata/tween_tick_loop_ping_pong.stdout

@@ -0,0 +1,57 @@
+Initial tween state:
+Lens=TransformPositionLens {
+    start: Vec3(
+        0.0,
+        0.0,
+        0.0,
+    ),
+    end: Vec3(
+        1.0,
+        1.0,
+        1.0,
+    ),
+}
+Clock=AnimClock {
+    elapsed: 0ns,
+    duration: 333.333333ms,
+    times_completed: 0,
+    total_duration: Infinite,
+    strategy: MirroredRepeat,
+}
+Direction=Forward
+
+Tick by 200ms:
+200ms/333.333333ms elapsed
+Direction: Forward
+State: Active
+Progress: 0.59999996
+Total completions: 0
+Transform: Transform { translation: Vec3(0.59999996, 0.59999996, 0.59999996), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 200ms:
+Completion received for 42v0
+400ms/333.333333ms elapsed
+Direction: Backward
+State: Active
+Progress: 1.1999999
+Total completions: 1
+Transform: Transform { translation: Vec3(-0.19999993, -0.19999993, -0.19999993), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }
+
+Tick by 200ms:
+600ms/333.333333ms elapsed
+Direction: Backward
+State: Active
+Progress: 1.8000001
+Total completions: 1
+Transform: Transform { translation: Vec3(-0.8000001, -0.8000001, -0.8000001), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+
+Tick by 200ms:
+Completion received for 42v0
+800ms/333.333333ms elapsed
+Direction: Forward
+State: Active
+Progress: 2.3999999
+Total completions: 2
+Transform: Transform { translation: Vec3(2.3999999, 2.3999999, 2.3999999), rotation: Quat(0.0, 0.0, 0.0, 1.0), scale: Vec3(1.0, 1.0, 1.0) }
+Event received: TweenCompleted { entity: 42v0, user_data: 69420 }