assertables 8.12.0

Assertables: assert macros for better testing, debugging, quality assurance, and runtime reliability.
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
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

# Assertables: Rust crate of assert macros for testing

The `assertables` Rust crate provides many assert macros to improve your
compile-time tests and run-time reliability.

* Crate: [https://crates.io/crates/assertables](https://crates.io/crates/assertables)
* Docs: [https://docs.rs/assertables/](https://docs.rs/assertables/)
* Repo: [https://github.com/sixarm/assertables-rust-crate/](https://github.com/sixarm/assertables-rust-crate/)
* Contact: [joel@joelparkerhenderson.com](mailto:joel@joelparkerhenderson.com)


## Introduction

The Rust programming language provides assert macros to test code:

* [`assert!(…)`](https://doc.rust-lang.org/std/macro.assert.html)
* [`assert_eq!(a, b)`](https://doc.rust-lang.org/std/macro.assert_eq.html) `// equal`
* [`assert_ne!(a, b)`](https://doc.rust-lang.org/std/macro.assert_ne.html) `// not equal`

The assertables crate provides many more, so you can write smarter tests.

Examples:

* [`assert_lt!(1, 2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_lt.html) `// compare less than`
* [`assert_approx_eq!(1.0000001, 1.0000002)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_approx_eq.html) `// compare floats`
* [`assert_starts_with!("hello world", "hello")`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_starts_with.html) `// compare strings`
* [`assert_fs_read_to_string_eq!("a.txt", "b.txt")`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_fs_read_to_string_eq.html) `// compare files`

Top 3 benefits:

1. You can write better tests to improve reliability and maintainability.
2. You can handle more corner cases without needing to write custom code.
3. You can troubleshoot faster because error messages show specifics.

Top 3 features:

1. Easy to use: everything is well-documented with runnable examples.
2. Runtime savvy: all the assertables macros have runtime versions.
3. Zero overhead: if you don't use a macro, then it's never compiled.

To use this crate, add it to your `Cargo.toml` file:

```toml
[dev-dependencies]
assertables = "8.12.0"
```

## Assert macros

For values:

* [`assert_lt!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_lt.html) `// less than`
* [`assert_le!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_le.html) `// less than or equal`
* [`assert_gt!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_gt.html) `// greater than`
* [`assert_ge!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_ge.html) `// greater than or equal`

For approximation:

* [`assert_approx_eq!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_approx_eq.html)
* [`assert_approx_ne!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_approx_ne.html)

For strings:

* [`assert_starts_with!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_starts_with.html)
* [`assert_ends_with!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_ends_with.html)

For matching:

* [`assert_contains!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_contains.html)
* [`assert_is_match!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_is_match.html)

For infix operators:

* [`assert_infix!(a == b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_infix.html) ([more](https://docs.rs/assertables/8.12.0/assertables/assert_infix))
* [`assert_infix!(a && b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_infix.html) ([more](https://docs.rs/assertables/8.12.0/assertables/assert_infix))

For nearness:

* [`assert_in_delta!(a, b, delta)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_in_delta.html)
* [`assert_in_epsilon!(a, b, epsilon)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_in_epsilon.html)

For Result Ok/Err:

* [`assert_ok!(a)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_ok.html) ([eq, ne, etc.](https://docs.rs/assertables/8.12.0/assertables/assert_ok))
* [`assert_err!(a)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_err.html ([eq, ne, etc.](https://docs.rs/assertables/8.12.0/assertables/assert_err))

For Option Some/None:

* [`assert_some!(a)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_some.html) ([eq, ne, etc.](https://docs.rs/assertables/8.12.0/assertables/assert_some))
* [`assert_none!(a)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_none.html)

For Poll Ready/Pending:

* [`assert_ready!(a)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_ready.html) ([eq, ne, etc.](https://docs.rs/assertables/8.12.0/assertables/assert_ready))
* [`assert_pending!(a)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_pending.html)

For collections such as arrays, vectors, iterators, sets, bags:

* [`assert_iter_eq!(collection1, collection2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_iter_eq.html) ([eq, ne, etc.](https://docs.rs/assertables/8.12.0/assertables/assert_iter))
* [`assert_set_eq!(collection1, collection2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_set_eq.html) [eq, ne, etc.](https://docs.rs/assertables/8.12.0/assertables/assert_set))
* [`assert_bag_eq!(collection1, collection2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_bag_eq.html) ([eq, ne, etc.](https://docs.rs/assertables/8.12.0/assertables/assert_bag))

For file system paths and input/output readers:

* [`assert_fs_read_to_string_eq!(path1, path2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_fs_read_to_string_eq.html)
* [`assert_io_read_to_string_eq!(reader1, reader2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_io_read_to_string_eq.html)

For command capture of standard output and standard error:

* [`assert_command_stdout_eq!(command1, command2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_command_stdout_eq.html)
* [`assert_program_args_stdout_eq!(program1, args1, program2, args2)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_program_args_stdout_eq.html)

There are many more macros that are grouped into modules.

Modules for collections such as arrays, vectors, iterators, sets, bags:

* [`assert_iter`](https://docs.rs/assertables/8.12.0/assertables/assert_iter) for iterator collections
* [`assert_set`](https://docs.rs/assertables/8.12.0/assertables/assert_set) for set collections
* [`assert_bag`](https://docs.rs/assertables/8.12.0/assertables/assert_bag) for bag collections

Modules for variants:

* [`assert_ok`](module@crate::assert_ok)/[`assert_err`](module@crate::assert_err) for Result Ok/Err.
* [`assert_some`](module@crate::assert_some)/[`assert_none`](module@crate::assert_none) for Option Some/None.
* [`assert_ready`](module@crate::assert_ready)/[`assert_pending`](module@crate::assert_pending) for Poll Ready/Pending.

Modules for functions:

* [`assert_fn`](https://docs.rs/assertables/8.12.0/assertables/assert_fn) for functions in general.
* [`assert_fn_ok`](https://docs.rs/assertables/8.12.0/assertables/assert_fn_ok) for functions that return `Result::Ok`.
* [`assert_fn_err`](https://docs.rs/assertables/8.12.0/assertables/assert_fn_err) for functions that return `Result::Err`.

Modules for readers:

* [`assert_fs_read_to_string`](https://docs.rs/assertables/8.12.0/assertables/assert_fs_read_to_string) for file system path contents.
* [`assert_io_read_to_string`](https://docs.rs/assertables/8.12.0/assertables/assert_io_read_to_string) for input/output reader streams.

Modules for external calls:

* [`assert_command`](https://docs.rs/assertables/8.12.0/assertables/assert_command) for commands with stdout/stderr.
* [`assert_program_args`](https://docs.rs/assertables/8.12.0/assertables/assert_program_args) for programs with args with stdout/stderr.


## Forms

All assertables macros have forms for different outcomes:

* [`assert_gt!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_gt.html) // panic during typical test
* [`assert_gt_as_result!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_gt_as_result.html) // return Ok or Err
* [`debug_assert_gt!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.debug_assert_gt.html) // panic when in debug mode

All assertables macros have forms for an optional message:

* [`assert_gt!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_gt.html) // automatic error message
* [`assert_gt!(a, b, "your text")`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_gt.html) // custom error message

Many assertables macros have forms for comparing left hand side (LHS) and right hand side (RHS) as the same type or as an expression:

* [`assert_ok_eq!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_ok_eq.html) // Ok(…) = Ok(…)
* [`assert_ok_eq_expr!(a, b)`](https://docs.rs/assertables/8.12.0/assertables/macro.assert_ok_eq_expr.html) // Ok(…) = expression


## Tracking

* Package: assertables-rust-crate
* Version: 8.12.0
* Created: 2021-03-30T15:47:49Z
* Updated: 2024-10-02T16:29:24Z
* License: MIT or Apache-2.0 or GPL-2.0 or GPL-3.0 or contact us for more
* Contact: Joel Parker Henderson (joel@sixarm.com)