use-test-assertion 0.1.0

Primitive assertion metadata for RustUse testing vocabulary.
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

/// Primitive assertion categories.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum TestAssertionKind {
    Equal,
    NotEqual,
    Contains,
    DoesNotContain,
    GreaterThan,
    GreaterThanOrEqual,
    LessThan,
    LessThanOrEqual,
    ApproxEqual,
    IsTrue,
    IsFalse,
    IsSome,
    IsNone,
    IsOk,
    IsErr,
}

/// Assertion metadata without assertion execution.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct TestAssertion {
    pub kind: TestAssertionKind,
    pub label: Option<String>,
}

impl TestAssertion {
    pub const fn new(kind: TestAssertionKind) -> Self {
        Self { kind, label: None }
    }

    pub fn with_label(kind: TestAssertionKind, label: impl Into<String>) -> Self {
        Self {
            kind,
            label: Some(label.into()),
        }
    }

    pub const fn kind(&self) -> TestAssertionKind {
        self.kind
    }

    pub fn label(&self) -> Option<&str> {
        self.label.as_deref()
    }
}

#[cfg(test)]
mod tests {
    use super::{TestAssertion, TestAssertionKind};

    #[test]
    fn creates_unlabeled_assertion() {
        let assertion = TestAssertion::new(TestAssertionKind::IsOk);

        assert_eq!(assertion.kind(), TestAssertionKind::IsOk);
        assert_eq!(assertion.label(), None);
    }

    #[test]
    fn creates_labeled_assertion() {
        let assertion = TestAssertion::with_label(TestAssertionKind::Contains, "has item");

        assert_eq!(assertion.kind(), TestAssertionKind::Contains);
        assert_eq!(assertion.label(), Some("has item"));
    }
}