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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
/*!
# Tutorial
A brief guide on how to use xpct to write tests.
[↩︎ Back to User Docs](crate::docs)
To make an assertion, you'll usually start with the [`expect!`] macro, which
returns an [`Assertion`].
```
use xpct::{expect, equal};
expect!("Disco").to(equal("Disco"));
```
In the above example, [`equal`] is a *matcher*. This crate provides [a number of
matchers][crate::docs::matcher_list], and you can implement custom matchers as
well.
When an assertion fails, it panics with an error message.
You can also chain matchers like this:
```
use xpct::{expect, be_gt, be_lt};
expect!(41)
.to(be_gt(0)) // 41 > 0
.to(be_lt(57)); // 41 < 57
```
When you chain together multiple matchers like this, the assertion only succeeds
if *all* of them succeed.
You can also negate matchers by calling [`Assertion::to_not`] or using the
[`not`] matcher:
```
use xpct::{expect, equal, not};
// These are equivalent.
expect!(41).to_not(equal(57));
expect!(41).to(not(equal(57)));
```
Some matchers are actually just aliases for negating other matchers:
```
use xpct::{expect, be_some, be_none};
let value: Option<&str> = None;
// These are equivalent.
expect!(value).to(be_none());
expect!(value).to_not(be_some());
```
When you chain together matchers, they pass the value you passed to [`expect!`]
into the next matcher in the chain. Matchers can change the type of this value,
which allows some matchers to do things like unwrap [`Result`] and [`Option`]
types.
```
use std::io;
use xpct::{expect, equal, be_ok};
fn location() -> io::Result<String> {
Ok(String::from("Martinaise"))
}
expect!(location())
.to(be_ok())
.to(equal("Martinaise"));
```
In the above example, we don't need to unwrap the [`Result`], because the
[`be_ok`] matcher did it for us! If we were to negate this matcher with [`not`]
(or just use [`be_err`]), then it would return the value of the [`Err`] variant
instead.
If you want to map a value by applying a function to it as part of a chain of
matchers, you can use the matchers [`map`] and [`try_map`] as well as
[`Assertion::map`] and [`Assertion::try_map`].
```
use std::convert::Infallible;
use xpct::{expect, map, try_map, equal};
struct Name(String);
expect!(Name(String::from("Cuno")))
.map(|name| name.0)
.to(equal("Cuno"));
// We use `try_map` for conversions that can fail.
expect!(vec![0x43, 0x75, 0x6e, 0x6f])
.try_map(|bytes| Ok(String::from_utf8(bytes)?))
.to(equal("Cuno"));
```
If you need to convert between types that implement [`From`] or [`TryFrom`], you
can use the matchers [`into`] and [`try_into`] as well as [`Assertion::into`]
and [`Assertion::try_into`].
```
use xpct::{expect, equal};
expect!(41u64)
.try_into::<u32>()
.to(equal(41u32));
```
You can always get the value back out at the end of a chain of matchers by
calling [`Assertion::into_inner`]. This lets you use the same value in another
assertion.
```
use xpct::{be_some, equal, expect, have_len};
let name = expect!(["Mañana", "Evrart"])
.to(have_len(2))
.into_inner();
expect!(name.first())
.to(be_some())
.to(equal(&"Mañana"));
```
There are combinator matchers like [`all`], [`each`], and [`any`] which allow
you to combine matchers in different ways:
```
use xpct::{expect, any, equal, be_none};
fn description() -> Option<String> {
None
}
// This is either `None` or `Some("horrific")`.
expect!(description()).to(any(|ctx| {
ctx.map(Option::as_deref)
.to(be_none())
.to(equal(Some("horrific")));
}));
```
If you want to attach additional context to a matcher to include in the failure
output, you can use [`why`] and [`why_lazy`]:
```
use xpct::{expect, match_regex, why};
expect!("Kim").to(why(
match_regex(r"^\p{Lu}"),
"names should start with a capital letter",
));
```
You can test that a value matches a pattern using the [`match_pattern`] matcher
and the [`pattern!`] macro.
```
use xpct::{expect, match_pattern, pattern};
#[derive(Debug)]
enum Command {
Create(String),
Update(String),
Delete,
}
let command = Command::Create("foo".into());
expect!(command).to(match_pattern(pattern!(
Command::Create(_) | Command::Delete
)));
```
You can use [`eq_diff`] instead of [`equal`] for any type that implements
[`Diffable`] to print a rich diff when the values are not equal.
```
use xpct::{expect, eq_diff};
expect!("diffing strings").to(eq_diff("diffing strings"));
expect!(["slices", "too"]).to(eq_diff(["slices", "too"]));
// Also sets and maps!
```
If you want to assert on multiple fields of a struct, rather than using a
separate [`expect!`] assertion for each field, you can use [`match_fields`] with
the [`fields!`] macro.
```
use xpct::{be_gt, be_some, be_true, expect, fields, have_prefix, match_fields};
struct Person {
id: String,
name: Option<String>,
age: u32,
is_superstar: bool,
}
let value = Person {
id: String::from("REV12-62-05-JAM41"),
name: Some(String::from("Raphaël")),
age: 44,
is_superstar: true,
};
expect!(value).to(match_fields(fields!(Person {
id: have_prefix("REV"),
name: be_some(),
age: be_gt(0),
is_superstar: be_true(),
})));
```
There are also a number of matchers for dealing with collections. For example,
you can assert that a collection contains certain elements using
[`contain_element`] and [`contain_elements`].
```
use xpct::{contain_element, expect};
expect!(["Mañana", "Evrart"]).to(contain_element("Evrart"));
```
You can also use [`consist_of`] to assert that a collection consists of exactly
the given elements, in any order.
```
use xpct::{consist_of, expect};
expect!(&["Mañana", "Evrart"]).to(consist_of(["Evrart", "Mañana"]));
```
The [`be_in`] matcher can test that something is in a collection.
```
use xpct::{be_in, expect};
expect!("Mañana").to(be_in(["Evrart", "Mañana"]));
expect!('C').to(be_in("Cuno"));
expect!(50).to(be_in(41..57));
```
The [`every`] matcher allows you to test every element in a collection against
the same matcher.
```
use xpct::{be_some, every, expect, have_prefix};
let items = vec![Some("Cuno"), Some("Cindy")];
// Notice it unwraps the `Vec<Option<&str>>` to a `Vec<&str>`.
let unwrapped: Vec<&str> = expect!(items)
.to(every(be_some))
.into_inner();
```
The [`match_elements`] matcher allows you to tests each element of a collection
against a different matcher.
```
use xpct::{be_in, equal, expect, have_prefix, match_elements};
let items = vec!["apple", "banana", "cucumber"];
expect!(items).to(match_elements([
equal("apple"),
be_in(["banana", "orange"]),
have_prefix("c"),
]));
```
The matchers for collections are implemented using the [`Len`] and [`Contains`]
traits. You can implement these traits for your own types to use them with the
collections matchers.
Check out [Provided Matchers][crate::docs::matcher_list] for a list of all the
matchers provided by this crate.
[`equal`]: crate::equal
[`eq_diff`]: crate::eq_diff
[`not`]: crate::not
[`be_ok`]: crate::be_ok
[`be_err`]: crate::be_err
[`map`]: crate::map
[`try_map`]: crate::try_map
[`into`]: crate::into
[`try_into`]: crate::try_into
[`all`]: crate::all
[`each`]: crate::each
[`any`]: crate::any
[`why`]: crate::why
[`why_lazy`]: crate::why_lazy
[`match_pattern`]: crate::match_pattern
[`Diffable`]: crate::matchers::diff::Diffable
[`pattern!`]: crate::pattern
[`match_fields`]: crate::match_fields
[`expect!`]: crate::expect
[`fields!`]: crate::fields
[`contain_element`]: crate::contain_element
[`contain_elements`]: crate::contain_elements
[`consist_of`]: crate::consist_of
[`be_in`]: crate::be_in
[`every`]: crate::every
[`match_elements`]: crate::match_elements
[`Len`]: crate::matchers::collections::Len
[`Contains`]: crate::matchers::collections::Contains
[`Assertion`]: crate::core::Assertion
[`Assertion::to_not`]: crate::core::Assertion::to_not
[`Matcher`]: crate::core::Matcher
[`Assertion::into_inner`]: crate::core::Assertion::into_inner
[`Assertion::map`]: crate::core::Assertion::map
[`Assertion::try_map`]: crate::core::Assertion::try_map
[`Assertion::into`]: crate::core::Assertion::into
[`Assertion::try_into`]: crate::core::Assertion::try_into
*/