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

//! Utilities for deriving display labels for groups.

use std::{fmt::Display, marker::PhantomData};

use crate::formatter::{FmtGroupStart, FmtListGroupStart};

/// Marker type indicating that a group label should be derived from the group key.
///
/// Requires the `GroupKey` to implement [`Display`].
#[derive(Debug, Default, Clone, Copy, Hash, PartialEq, Eq)]
pub struct FromGroupKey;

/// Marker type indicating that a group label should be derived from the group context.
///
/// Requires the `GroupCtx` to implement [`Display`].
#[derive(Debug, Default, Clone, Copy, Hash, PartialEq, Eq)]
pub struct FromGroupCtx;

/// A displayable label for a test group.
///
/// - `GroupLabel<FromGroupKey>` derives its label from the group key
/// - `GroupLabel<FromGroupCtx>` derives its label from the group context
///
/// In both cases, the respective type must implement [`Display`].
#[derive(Debug, Default, Clone, Hash, PartialEq, Eq)]
pub struct GroupLabel<M> {
    marker: PhantomData<M>,

    /// The computed label string.
    pub label: String,
}

impl<'g, GroupKey: Display, GroupCtx> From<&FmtGroupStart<'g, GroupKey, GroupCtx>>
    for GroupLabel<FromGroupKey>
{
    fn from(value: &FmtGroupStart<'g, GroupKey, GroupCtx>) -> Self {
        GroupLabel {
            marker: PhantomData,
            label: value.key.to_string(),
        }
    }
}

impl<'g, GroupKey: Display, GroupCtx> From<&FmtListGroupStart<'g, GroupKey, GroupCtx>>
    for GroupLabel<FromGroupKey>
{
    fn from(value: &FmtListGroupStart<'g, GroupKey, GroupCtx>) -> Self {
        GroupLabel {
            marker: PhantomData,
            label: value.key.to_string(),
        }
    }
}

impl<GroupKey: Display, GroupCtx> From<(&GroupKey, Option<&GroupCtx>)>
    for GroupLabel<FromGroupKey>
{
    fn from(value: (&GroupKey, Option<&GroupCtx>)) -> Self {
        GroupLabel {
            marker: PhantomData,
            label: value.0.to_string(),
        }
    }
}

// TODO: implement this conversion for other types

impl<'g, GroupKey, GroupCtx: Display> From<&FmtGroupStart<'g, GroupKey, GroupCtx>>
    for GroupLabel<FromGroupCtx>
{
    fn from(value: &FmtGroupStart<'g, GroupKey, GroupCtx>) -> Self {
        GroupLabel {
            marker: PhantomData,
            label: value.ctx.map(|ctx| ctx.to_string()).unwrap_or_default(),
        }
    }
}

impl<'g, GroupKey, GroupCtx: Display> From<&FmtListGroupStart<'g, GroupKey, GroupCtx>>
    for GroupLabel<FromGroupCtx>
{
    fn from(value: &FmtListGroupStart<'g, GroupKey, GroupCtx>) -> Self {
        GroupLabel {
            marker: PhantomData,
            label: value.ctx.map(|ctx| ctx.to_string()).unwrap_or_default(),
        }
    }
}

impl<GroupKey, GroupCtx: Display> From<(&GroupKey, Option<&GroupCtx>)>
    for GroupLabel<FromGroupCtx>
{
    fn from(value: (&GroupKey, Option<&GroupCtx>)) -> Self {
        GroupLabel {
            marker: PhantomData,
            label: value.1.map(|ctx| ctx.to_string()).unwrap_or_default(),
        }
    }
}

impl<M> Display for GroupLabel<M> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(&self.label)
    }
}