kitest 0.5.0

A composable test harness toolkit with room to fly.
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
109
110
111
112
113
114
115
116
117
118

use std::{
    any::Any,
    fmt::{self, Debug, Display, Formatter},
};

/// Type erased user data with a fixed set of trait bounds.
///
/// [`Whatever`] is a small type erasure container.
/// It stores a value of any `'static` type, as long as it implements:
///
/// - [`Debug`]
/// - [`Display`]
/// - [`Clone`]
/// - [`PartialEq`]
/// - [`Send`] and [`Sync`]
///
/// The main purpose of `Whatever` is to allow attaching "nice to have" user data in places where
/// it is useful for reporting or formatting, but not required for executing tests.
/// In those cases, the runtime indirection is acceptable.
///
/// Why this exists:
///
/// Kitest already carries `Extra` through most types so strategies can use metadata without
/// downcasting.
/// Adding more generic parameters everywhere for occasional optional data would make signatures
/// even heavier and would spread type parameters through the whole crate.
///
/// `Whatever` avoids that by erasing the type when the value is not essential for the core test
/// execution path.
///
/// Note: this is intentionally not something the built-in Rust test harness needs. It is a
/// Kitest specific tradeoff to keep the generic surface area under control.
pub struct Whatever(Box<dyn WhateverImpl>);

trait WhateverImpl: Debug + Display + Any + Send + Sync {
    fn clone_whatever(&self) -> Whatever;
    fn eq_whatever(&self, other: &Whatever) -> bool;
}

impl<T> WhateverImpl for T
where
    T: Debug + Display + Clone + PartialEq + Send + Sync + 'static,
{
    fn clone_whatever(&self) -> Whatever {
        Whatever(Box::new(self.clone()))
    }

    fn eq_whatever(&self, other: &Whatever) -> bool {
        let Some(other) = other.as_any_ref().downcast_ref() else {
            return false;
        };
        self.eq(other)
    }
}

impl Clone for Whatever {
    fn clone(&self) -> Self {
        self.0.clone_whatever()
    }
}

impl Debug for Whatever {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        Debug::fmt(&self.0, f)
    }
}

impl Display for Whatever {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        Display::fmt(&self.0, f)
    }
}

impl PartialEq for Whatever {
    fn eq(&self, other: &Self) -> bool {
        self.0.eq_whatever(other)
    }
}

impl Whatever {
    /// Create a new [`Whatever`] from a concrete value.
    ///
    /// The value must implement the full set of traits required by `Whatever`:
    /// [`Debug`], [`Display`], [`Clone`], [`PartialEq`], [`Send`], and [`Sync`].
    ///
    /// This constructor performs type erasure.
    /// The original type information can later be recovered using the `Any` based accessors if
    /// both producer and consumer agree on the concrete type.
    pub fn from<T: Debug + Display + Clone + PartialEq + Send + Sync + 'static>(
        value: T,
    ) -> Whatever {
        Self(Box::new(value))
    }

    /// Convert this [`Whatever`] into a boxed [`Any`].
    ///
    /// This consumes the `Whatever` and returns the underlying value as a trait object.
    /// It can later be downcast to the original concrete type.
    ///
    /// This is useful when ownership of the erased value is needed.
    pub fn into_any(self) -> Box<dyn Any + Send + Sync> {
        self.0
    }

    /// Get a shared reference to the underlying value as [`Any`].
    ///
    /// This allows inspecting or downcasting the stored value without taking ownership.
    pub fn as_any_ref(&self) -> &dyn Any {
        &self.0
    }

    /// Get a mutable reference to the underlying value as [`Any`].
    ///
    /// This allows mutating or downcasting the stored value without taking ownership.
    pub fn as_any_mut(&mut self) -> &mut dyn Any {
        &mut self.0
    }
}