Crate assertables

source · [−]

Expand description

Assertables: Rust crate of “assert” macros for testing

The assertables Rust crate provides many “assert” macros to help with compile-time testing and run-time reliability

Crate: https://crates.io/crates/assertables

Docs: https://docs.rs/assertables/

Repo: https://github.com/sixarm/assertables-rust-crate/

Highlights

Value macros such as:

assert_gt!(value1, value2)
Means value1 > value2

Set macros such as:

assert_set_subset!(set1, set2)
Means set1 ⊆ set2

Function macros such as:

assert_fn_eq!(function, input, output)
Means function(input) == output

Reader macros such as:

assert_read_to_string_eq!(reader, string)
Means reader.read_to_string() == string

Commmand macros such as:

assert_command_stdout_eq!(command, expr)
Means String::from_utf8(command.output().unwrap().stdout).unwrap() == expr

Naming conventions

Abbreviations:

eq means equal; ne means not equal.
lt means less than; le means less than or equal.
gt means greater than; ge means greater than or equal.

Shorthands:

reader means implements .read_to_string(…) such as std::io::Read.
matcher means implements .is_match(…) such as regex::Regex.
containee means usable inside .contains(…) such as a std::string::String substring.
set means a collection such as ::std::collections::BTreeSet.
bag means a collection such as ::std::collections::BTreeMap with key counts.

Forms for panic! versus Err()

The macros have two forms, for immediate interrupts versus returning results:

assert_gt!(a, b) => () or panic!(…)
assert_gt_as_result!(a, b) => Result Ok(()) or Result Err(…)

Forms for default messages versus custom messages

The macros have two forms, for default messages versus custom messages.

Example:

assert_gt(1, 2) => panic!("assertion failed: assert_gt(1, 2)…")
assert_gt(1, 2, "lorem ipsum") => panic!("lorem ipsum")

Forms for comparing an expression versus equivalent

Some macros have forms for comparing to an expression (expr) versus an equivalent (other):

Example:

assert_read_to_string_eq!(reader, expr) => reader.read_to_string() == expr
assert_read_to_string_eq_other!(reader1, reader2) => reader1.read_to_string() == reader2.read_to_string()

assert_* for values

Compare values.

assert_eq!(a, b) ~ a == b
assert_ne!(a, b) ~ a != b
assert_lt!(a, b) ~ a < b
assert_le!(a, b) ~ a <= b
assert_gt!(a, b) ~ a > b
assert_ge!(a, b) ~ a >= b

assert_set_* for set collection comparisons

These macros help with comparison of set parameters, such as two arrays or two vectors. where the item order does not matter, and the item count does not matter. The macros convert inputs into HashSet iterators.

assert_set_eq!(a, b) ~ set a == set b
assert_set_ne!(a, b) ~ set a != set b
assert_set_subset!(a, b) ~ set a ⊆ set b
assert_set_superset!(a, b) ~ set a ⊇ set b
assert_set_joint!(a, b) ~ set a is joint with set b
assert_set_disjoint!(a, b) ~ set a is disjoint with set b

assert_bag_* for bag collection comparisons

These macros help with comparison of bag parameters, such as comparison of two arrays or two vectors, where the item order does not matter, and the item count does matter. The macros convert inputs into HashMap iterators.

assert_bag_eq(a, b) ~ bag a == bag b
assert_bag_ne(a, b) ~ bag a != bag b
assert_bag_subbag(a, b) ~ bag a ⊆ bag b
assert_bag_superbag(a, b) ~ bag a ⊇ bag b

assert_fn_* for function return comparisons

assert_fn_eq!(f, a, b) ~ f(a) == b
assert_fn_eq_other!(f, a, b) ~ f(a) == f(b)
assert_fn_ne!(f, a, b) ~ f(a) != b
assert_fn_ne_other!(f, a, b) ~ f(a) != f(b)
assert_fn_lt!(f, a, b) ~ f(a) < v
assert_fn_lt_other!(f, a, b) ~ f(a) < f(b)
assert_fn_le!(f, a, b) ~ f(a) <= b
assert_fn_le_other!(f, a, b) ~ f(a) <= f(b)
assert_fn_gt!(f, a, b) ~ f(a) > b
assert_fn_gt_other!(f, a, b) ~ f(a) > f(b)
assert_fn_ge!(f, a, b) ~ f(a) >= b
assert_fn_ge_other!(f, a, b) ~ f(a) >= f(b)

assert_fn_ok_* for function Ok() comparisons

assert_fn_ok_eq!(f, a, b) ~ f(a).unwrap() == b
assert_fn_ok_eq_other!(f, a, b) ~ f(a).unwrap() == f(b).unwrap()
assert_fn_ok_ne!(f, a, b) ~ f(a).unwrap() != b
assert_fn_ok_ne_other!(f, a, b) ~ f(a).unwrap() != f(b).unwrap()
assert_fn_ok_lt!(f, a, b) ~ f(a).unwrap() < b
assert_fn_ok_lt_other!(f, a, b) ~ f(a).unwrap() < f(b).unwrap()
assert_fn_ok_le!(f, a, b) ~ f(a).unwrap() <= b
assert_fn_ok_le_other!(f, a, b) ~ f(a).unwrap() <= f(b).unwrap()
assert_fn_ok_gt!(f, a, b) ~ f(a).unwrap() > b
assert_fn_ok_gt_other!(f, a, b) ~ f(a).unwrap() > f(b).unwrap()
assert_fn_ok_gt!(f, a, b) ~ f(a).unwrap() > b
assert_fn_ok_gt_other!(f, a, b) ~ f(a).unwrap() > f(b).unwrap()

assert_fn_err_* for function Err() comparisons

assert_fn_err_eq!(f, a, b) ~ f(a).unwrap_err() == b
assert_fn_err_eq_other!(f, a, b) ~ f(a).unwrap_err() == f(b).unwrap_err()
assert_fn_err_ne!(f, a, b) ~ f(a).unwrap_err() != b
assert_fn_err_ne_other!(f, a, b) ~ f(a).unwrap_err() != f(b).unwrap_err()
assert_fn_err_lt!(f, a, b) ~ f(a).unwrap_err() < b
assert_fn_err_lt_other!(f, a, b) ~ f(a).unwrap_err() < f(b).unwrap_err()
assert_fn_err_le!(f, a, b) ~ f(a).unwrap_err() <= b
assert_fn_err_le_other!(f, a, b) ~ f(a).unwrap_err() <= f(b).unwrap_err()
assert_fn_err_gt!(f, a, b) ~ f(a).unwrap_err() > b
assert_fn_err_gt_other!(f, a, b) ~ f(a).unwrap_err() > f(b).unwrap_err()
assert_fn_err_ge!(f, a, b)~ f(a).unwrap_err() >= b
assert_fn_err_ge_other!(f, a, b)~ f(a).unwrap_err() >= f(b).unwrap_err()

assert_read_to_string_* for std::io::Read comparisons

These macros help with readers, such as file handles, byte arrays, input streams, and the trait std::io::Read.

assert_read_to_string_eq!(a, b) ~ a.read_to_string() == b
assert_read_to_string_eq_other!(a, b) ~ a.read_to_string() == b.read_to_string()
assert_read_to_string_ne!(a, b) ~ a.read_to_string() != b
assert_read_to_string_ne_other!(a, b) ~ a.read_to_string() != b.read_to_string()
assert_read_to_string_lt!(a, b) ~ a.read_to_string() < b
assert_read_to_string_lt_other!(a, b) ~ a.read_to_string() < b.read_to_string()
assert_read_to_string_le!(a, b) ~ a.read_to_string() <= b
assert_read_to_string_le_other!(a, b) ~ a.read_to_string() <= b.read_to_string()
assert_read_to_string_gt!(a, b) ~ a.read_to_string() > b
assert_read_to_string_gt_other!(a, b) ~ a.read_to_string() > b.read_to_string()
assert_read_to_string_ge!(a, b) ~ a.read_to_string() >= b
assert_read_to_string_ge_other!(a, b) ~ a.read_to_string() >= b.read_to_string()

assert_command_ for process command comparisons

Using standard output a.k.a. stdout:

assert_command_stdout_eq!(command, value) ~ String::from_utf8(command.output().unwrap().stdout).unwrap() == value
assert_command_stdout_eq_other!(command, command) ~ String::from_utf8(command.output().unwrap().stdout).unwrap() == String::from_utf8(command.output().unwrap().stdout).unwrap()
assert_command_stdout_contains!(command, containee) ~ String::from_utf8(command.output().unwrap().stdout).unwrap().contains(containee)
assert_command_stdout_matches!(command, matcher) ~ regex.is_match(String::from_utf8(command.output().unwrap().stdout).unwrap())

Using standard error a.k.a. stderr:

assert_command_stderr_eq!(command, value) ~ String::from_utf8(command.output().unwrap().stderr).unwrap() == value
assert_command_stderr_eq_other!(command, command) ~ String::from_utf8(command.output().unwrap().stderr).unwrap() == String::from_utf8(command.output().unwrap().stdout).unwrap()
assert_command_stderr_contains!(command, containee) ~ String::from_utf8(command.output().unwrap().stderr).unwrap().contains(containee)
assert_command_stderr_matches!(command, matcher) ~ regex.is_match(String::from_utf8(command.output().unwrap().stderr).unwrap())

Tracking

Package: assertables-rust-crate
Version: 5.1.0
Created: 2021-03-30T15:47:49Z
Updated: 2022-04-11T11:22:18Z
License: MIT or Apache-2.0 or GPL-2.0 or contact us for custom license
Contact: Joel Parker Henderson (joel@sixarm.com)

Modules

assert_bag_subbag

assert_bag_superbag

assert_command_stderr_contains

assert_command_stderr_eq

assert_command_stderr_eq_other

assert_command_stderr_matches

assert_command_stdout_contains

assert_command_stdout_eq

assert_command_stdout_eq_other

assert_command_stdout_matches

assert_fn_eq_other

assert_fn_err_eq

assert_fn_err_eq_other

assert_fn_err_ge

assert_fn_err_ge_other

assert_fn_err_gt

assert_fn_err_gt_other

assert_fn_err_le

assert_fn_err_le_other

assert_fn_err_lt

assert_fn_err_lt_other

assert_fn_err_ne

assert_fn_err_ne_other

assert_fn_ge_other

assert_fn_gt_other

assert_fn_le_other

assert_fn_lt_other

assert_fn_ne_other

assert_fn_ok_eq

assert_fn_ok_eq_other

assert_fn_ok_ge

assert_fn_ok_ge_other

assert_fn_ok_gt

assert_fn_ok_gt_other

assert_fn_ok_le

assert_fn_ok_le_other

assert_fn_ok_lt

assert_fn_ok_lt_other

assert_fn_ok_ne

assert_fn_ok_ne_other

assert_read_to_string_contains

assert_read_to_string_eq

assert_read_to_string_eq_other

assert_read_to_string_ge

assert_read_to_string_ge_other

assert_read_to_string_gt

assert_read_to_string_gt_other

assert_read_to_string_le

assert_read_to_string_le_other

assert_read_to_string_lt

assert_read_to_string_lt_other

assert_read_to_string_matches

assert_read_to_string_ne

assert_read_to_string_ne_other

assert_set_disjoint

assert_set_joint

assert_set_subset

assert_set_superset

Macros

assert_as_result

Assert a condition is true.

Assert a bag is equal to another.

assert_bag_eq_as_result

Assert a bag is equal to another.

Assert a bag is not equal to another.

assert_bag_ne_as_result

Assert a bag is not equal to another.

assert_bag_subbag

Assert a bag is a subbag of another.

assert_bag_subbag_as_result

Assert a bag is a subbag of another.

assert_bag_superbag

Assert a bag is a superbag of another.

assert_bag_superbag_as_result

Assert a bag is a superbag of another.

assert_command_stderr_contains

Assert a command stderr string contains a given containee.

assert_command_stderr_contains_as_result

Assert a command stderr string contains a given containee.

assert_command_stderr_eq

Assert a command stderr string is equal to an expression.

assert_command_stderr_eq_as_result

Assert a command stderr string is equal to an expression.

assert_command_stderr_eq_other

Assert a command stderr string is equal to another.

assert_command_stderr_eq_other_as_result

Assert a command stderr string is equal to another.

assert_command_stderr_matches

Assert a command stderr string is a match to a given regex.

assert_command_stderr_matches_as_result

Assert a command stderr string is a match to a given regex.

assert_command_stdout_contains

Assert a command stdout string contains a given containee.

assert_command_stdout_contains_as_result

Assert a command stdout string contains a given containee.

assert_command_stdout_eq

Assert a command stdout string is equal to an expression.

assert_command_stdout_eq_as_result

Assert a command stdout string is equal to an expression.

assert_command_stdout_eq_other

Assert a command stdout string is equal to another.

assert_command_stdout_eq_other_as_result

Assert a command stdout string is equal to another.

assert_command_stdout_matches

Assert a command stdout string is a match to a given regex.

assert_command_stdout_matches_as_result

Assert a command stdout string is a match to a given regex.

assert_eq_as_result

Assert a values is equal to another.

Assert a function output is equal to a given value.

assert_fn_eq_as_result

Assert a function output is equal to a given.

assert_fn_eq_other

Assert a function output is equal to another.

assert_fn_eq_other_as_result

Assert one function output is equal to another function output.

assert_fn_err_eq

Assert a function err() is equal to another.

assert_fn_err_eq_as_result

Assert one function ok() is equal to another function ok().

assert_fn_err_eq_other

Assert a function err() is equal to another.

assert_fn_err_eq_other_as_result

Assert one function ok() is equal to another function ok().

assert_fn_err_ge

Assert a function err() is greater than or equal to another.

assert_fn_err_ge_as_result

Assert one function ok() is not equal to another function ok().

assert_fn_err_ge_other

Assert a function err() is greater than or equal to another.

assert_fn_err_ge_other_as_result

Assert one function ok() is not equal to another function ok().

assert_fn_err_gt

Assert a function err() is greater than another.

assert_fn_err_gt_as_result

Assert one function ok() is greater than another.

assert_fn_err_gt_other

Assert a function err() is greater than another.

assert_fn_err_gt_other_as_result

Assert one function ok() is greater than another.

assert_fn_err_le

Assert a function err() is less than or equal to another.

assert_fn_err_le_as_result

Assert one function ok() is less than or equal to another function ok().

assert_fn_err_le_other

Assert a function err() is less than or equal to another.

assert_fn_err_le_other_as_result

Assert one function ok() is less than or equal to another function ok().

assert_fn_err_lt

Assert a function err() is less than another.

assert_fn_err_lt_as_result

Assert one function ok() is less than another.

assert_fn_err_lt_other

Assert a function err() is less than another.

assert_fn_err_lt_other_as_result

Assert one function ok() is less than another.

assert_fn_err_ne

Assert a function err() is not equal to another.

assert_fn_err_ne_as_result

Assert one function ok() is not equal to another function ok().

assert_fn_err_ne_other

Assert a function err() is not equal to another.

assert_fn_err_ne_other_as_result

Assert one function ok() is not equal to another function ok().

assert_fn_ge_other

Assert a function output is greater than or equal to another.

assert_fn_ge_other_as_result

Assert one function output is not equal to another function output.

assert_fn_gt_other

Assert a function output is greater than another.

assert_fn_gt_other_as_result

Assert one function output is greater than another.

assert_fn_le_other

Assert a function output is less than or equal to another.

assert_fn_le_other_as_result

Assert one function output is less than or equal to another function output.

assert_fn_lt_other

Assert a function output is less than another.

assert_fn_lt_other_as_result

Assert one function output is less than another.

Assert a function output is not equal to another.

assert_fn_ne_as_result

Assert one function output is not equal to another function output.

assert_fn_ne_other

Assert a function output is not equal to another.

assert_fn_ne_other_as_result

Assert one function output is not equal to another function output.

assert_fn_ok_eq

Assert a function ok() is equal to another.

assert_fn_ok_eq_as_result

Assert one function ok() is equal to another function ok().

assert_fn_ok_eq_other

Assert a function ok() is equal to another.

assert_fn_ok_eq_other_as_result

Assert one function ok() is equal to another function ok().

assert_fn_ok_ge

Assert a function ok() is greater than or equal to another.

assert_fn_ok_ge_as_result

Assert one function ok() is not equal to another function ok().

assert_fn_ok_ge_other

Assert a function ok() is greater than or equal to another.

assert_fn_ok_ge_other_as_result

Assert one function ok() is not equal to another function ok().

assert_fn_ok_gt

Assert a function ok() is greater than another.

assert_fn_ok_gt_as_result

Assert one function ok() is greater than another.

assert_fn_ok_gt_other

Assert a function ok() is greater than another.

assert_fn_ok_gt_other_as_result

Assert one function ok() is greater than another.

assert_fn_ok_le

Assert a function ok() is less than or equal to another.

assert_fn_ok_le_as_result

Assert one function ok() is less than or equal to another function ok().

assert_fn_ok_le_other

Assert a function ok() is less than or equal to another.

assert_fn_ok_le_other_as_result

Assert one function ok() is less than or equal to another function ok().

assert_fn_ok_lt

Assert a function ok() is less than another.

assert_fn_ok_lt_as_result

Assert one function ok() is less than another.

assert_fn_ok_lt_other

Assert a function ok() is less than another.

assert_fn_ok_lt_other_as_result

Assert one function ok() is less than another.

assert_fn_ok_ne

Assert a function ok() is not equal to another.

assert_fn_ok_ne_as_result

Assert one function ok() is not equal to another function ok().

assert_fn_ok_ne_other

Assert a function ok() is not equal to another.

assert_fn_ok_ne_other_as_result

Assert one function ok() is not equal to another function ok().

Assert a value is greater than or equal to another.

assert_ge_as_result

Assert one value is greater than or equal to another value.

Assert a value is greater than another.

assert_gt_as_result

Assert one value is greater than another.

Assert a value is less than or equal to another.

assert_le_as_result

Assert one value is less than or equal to another value.

Assert a value is less than another.

assert_lt_as_result

Assert one value is less than another.

assert_ne_as_result

Assert a value is not equal to another.

assert_read_to_string_contains

Assert a a std::io::Read read_to_string() contains a pattern.

assert_read_to_string_contains_as_result

Assert a std::io::Read read_to_string() contains a pattern.

assert_read_to_string_eq

Assert a read_to_string() value is equal to another.

assert_read_to_string_eq_as_result

Assert a std::io::Read read_to_string() is equal to another.

assert_read_to_string_eq_other

Assert a read_to_string() value is equal to another.

assert_read_to_string_eq_other_as_result

Assert a std::io::Read read_to_string() is equal to another.

assert_read_to_string_ge

Assert a std::io::Read read_to_string() value is greater than or equal to another.

assert_read_to_string_ge_as_result

Assert one std::io::Read read_to_string() value is greater than or equal to another.

assert_read_to_string_ge_other

Assert a std::io::Read read_to_string() value is greater than or equal to another.

assert_read_to_string_ge_other_as_result

Assert one std::io::Read read_to_string() value is greater than or equal to another.

assert_read_to_string_gt

Assert a std::io::Read read_to_string() value is greater than another.

assert_read_to_string_gt_as_result

Assert one std::io::Read read_to_string() value is greater than another.

assert_read_to_string_gt_other

Assert a std::io::Read read_to_string() value is greater than another.

assert_read_to_string_gt_other_as_result

Assert one std::io::Read read_to_string() value is greater than another.

assert_read_to_string_le

Assert a std::io::Read read_to_string() value is less than or equal to another.

assert_read_to_string_le_as_result

Assert one std::io::Read read_to_string() value is less than or equal to another.

assert_read_to_string_le_other

Assert a std::io::Read read_to_string() value is less than or equal to another.

assert_read_to_string_le_other_as_result

Assert one std::io::Read read_to_string() value is less than or equal to another.

assert_read_to_string_lt

Assert a std::io::Read read_to_string() value is less than another.

assert_read_to_string_lt_as_result

Assert one std::io::Read read_to_string() value is less than another.

assert_read_to_string_lt_other

Assert a std::io::Read read_to_string() value is less than another.

assert_read_to_string_lt_other_as_result

Assert one std::io::Read read_to_string() value is less than another.

assert_read_to_string_matches

Assert a a std::io::Read read_to_string() is a match to a given regex.

assert_read_to_string_matches_as_result

Assert a a std::io::Read read_to_string() is a match to a given regex.

assert_read_to_string_ne

Assert a std::io::Read read_to_string() is not equal to another.

assert_read_to_string_ne_as_result

Assert a std::io::Read read_to_string() is not equal to another.

assert_read_to_string_ne_other

Assert a std::io::Read read_to_string() is not equal to another.

assert_read_to_string_ne_other_as_result

Assert a std::io::Read read_to_string() is not equal to another.

assert_set_disjoint

Assert a set is disjoint with another.

assert_set_disjoint_as_result

Assert a set is disjoint with another.

Assert a set is equal to another.

assert_set_eq_as_result

Assert a set is equal to another.

assert_set_joint

Assert a set is joint with another.

assert_set_joint_as_result

Assert a set is joint with another.

Assert a set is not equal to another.

assert_set_ne_as_result

Assert a set is not equal to another.

assert_set_subset

Assert a set is a subset of another.

assert_set_subset_as_result

Assert a set is a subset of another.

assert_set_superset

Assert a set is a superset of another.

assert_set_superset_as_result

Assert a set is a superset of another.