xpct 0.5.1

An extensible test assertion library
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

#![cfg(feature = "regex")]

use std::fmt;

use crate::core::Matcher;
use crate::matchers::strings::RegexMatcher;

use super::MismatchFormat;

/// Succeeds when the actual value matches the given regular expression.
///
/// This succeeds if the actual string contains any match for the given regex. If you want to test
/// that the regex matches the *entire* string, you should use the `^` and `$` anchors.
///
/// The regex engine does not support lookarounds or backreferences.
///
/// # Examples
///
/// ```
/// use xpct::{expect, match_regex};
///
/// expect!("foobar").to(match_regex(r"^foo\w*$"));
/// ```
pub fn match_regex<'a, Actual>(regex: impl AsRef<str>) -> Matcher<'a, Actual, Actual>
where
    Actual: fmt::Debug + AsRef<str> + 'a,
{
    Matcher::new(
        RegexMatcher::new(regex),
        MismatchFormat::new("to match the regex", "to not match the regex"),
    )
}

#[cfg(test)]
mod tests {
    use super::match_regex;
    use crate::expect;

    #[test]
    fn succeeds_when_matches_regex() {
        expect!("foobar").to(match_regex("^foo"));
    }

    #[test]
    fn succeeds_when_not_matches_regex() {
        expect!("foobar").to_not(match_regex("^a regex that does not match$"));
    }

    #[test]
    #[should_panic]
    fn fails_when_matches_regex() {
        expect!("foobar").to_not(match_regex("^foo"));
    }

    #[test]
    #[should_panic]
    fn fails_when_not_matches_regex() {
        expect!("foobar").to(match_regex("^a regex that does not match$"));
    }

    #[test]
    #[should_panic]
    fn fails_when_regex_is_invalid() {
        expect!("foobar").to(match_regex("[an invalid regex"));
    }
}