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
//! The ntest lib enhances the rust test framework with some useful functions.
// Reexport procedural macros
extern crate ntest_test_cases;
extern crate ntest_timeout;
#[doc(inline)]
pub use ntest_test_cases::test_case;
#[doc(inline)]
pub use ntest_timeout::timeout;
use std::sync::mpsc;
use std::thread;
use std::time::Duration;
// Reexport traits
mod traits;
#[doc(inline)]
pub use crate::traits::MaxDifference;
#[doc(hidden)]
/// Timeout helper for proc macro timeout
pub fn execute_with_timeout<T: Send>(
code: &'static (dyn Fn() -> T + Sync + 'static),
timeout_ms: u64,
) -> Option<T> {
let (sender, receiver) = mpsc::channel();
thread::spawn(move || if let Ok(()) = sender.send(code()) {});
match receiver.recv_timeout(Duration::from_millis(timeout_ms)) {
Ok(t) => Some(t),
Err(_) => None,
}
}
#[doc(hidden)]
/// Difference helper for proc macro about equal
pub fn about_eq<T: MaxDifference>(a: T, b: T, eps: f64) -> bool {
a.max_diff(b) < eps
}
/// Compare floating point values or vectors of floating points wether they are approximately equal.
/// The default value for epsilon is `1.0e-6`.
///
/// # Examples
///
/// Compare two floating point values which are about equal:
/// ```
/// # use ntest::assert_about_eq;
/// # fn main() {
/// assert_about_eq!(42.00000001f32, 42.0f32);
/// # }
/// ```
///
/// Explicitly set an epsilon value. This test should fail:
/// ``` should_panic
/// # use ntest::assert_about_eq;
/// # fn main() {
/// assert_about_eq!(42.001f32, 42.0f32, 1.0e-4);
/// # }
/// ```
///
/// Compare two vectors or arrays of floats which are about equal:
/// ```
/// # use ntest::assert_about_eq;
/// # fn main() {
/// assert_about_eq!(vec![1.100000001, 2.1], vec![1.1, 2.1], 0.001f64);
/// # }
/// ```
///
/// Arrays can be compared to a length of up to `32`. See the [MaxDifference](trait.MaxDifference.html) implementation for more details:
/// ```
/// # use ntest::assert_about_eq;
/// # fn main() {
///# // Test double usage
///# assert_about_eq!([1.100000001, 2.1], [1.1, 2.1], 0.001f64);
/// assert_about_eq!([1.100000001, 2.1], [1.1, 2.1], 0.001f64);
/// # }
/// ```
#[macro_export]
macro_rules! assert_about_eq {
($a:expr, $b:expr, $eps:expr) => {
let eps = $eps;
assert!(
$crate::about_eq($a, $b, eps),
"assertion failed: `(left !== right)` \
(left: `{:?}`, right: `{:?}`, epsilon: `{:?}`)",
$a,
$b,
eps
);
};
($a:expr, $b:expr,$eps:expr,) => {
assert_about_eq!($a, $b, $eps);
};
($a:expr, $b:expr) => {
assert_about_eq!($a, $b, 1.0e-6);
};
($a:expr, $b:expr,) => {
assert_about_eq!($a, $b, 1.0e-6);
};
}
/// Expects a true expression. Otherwise panics.
///
/// Is an alias for the [assert! macro](https://doc.rust-lang.org/std/macro.assert.html).
///
/// # Examples
///
/// This call won't panic.
/// ```rust
/// # use ntest::assert_true;
/// # fn main() {
/// assert_true!(true);
/// # }
///```
///
/// This call will panic.
/// ```should_panic
/// # use ntest::assert_true;
/// # fn main() {
/// assert_true!(false);
/// # }
/// ```
#[macro_export]
macro_rules! assert_true {
($x:expr) => {
if !$x {
panic!("assertion failed: Expected 'true', but was 'false'");
}
};
($x:expr,) => {
assert_true!($x);
};
}
/// Expects a false expression. Otherwise panics.
///
/// # Examples
///
/// This call won't panic.
/// ```rust
/// # use ntest::assert_false;
/// # fn main() {
/// assert_false!(false);
/// # }
/// ```
///
/// This call will panic.
/// ```should_panic
/// # use ntest::assert_false;
/// # fn main() {
/// assert_false!(true);
/// # }
/// ```
#[macro_export]
macro_rules! assert_false {
($x:expr) => {{
if $x {
panic!("assertion failed: Expected 'false', but was 'true'");
}
}};
($x:expr,) => {{
assert_false!($x);
}};
}
/// A panic in Rust is not always implemented via unwinding, but can be implemented by aborting the
/// process as well. This function only catches unwinding panics, not those that abort the process.
/// See the catch unwind [documentation](https://doc.rust-lang.org/std/panic/fn.catch_unwind.html)
/// for more information.
///
/// # Examples
///
/// This call won't panic.
/// ```rust
/// # use ntest::assert_panics;
/// # fn main() {
/// // Other panics can happen before this call.
/// assert_panics!({panic!("I am panicing")});
/// # }
/// ```
///
/// This call will panic.
/// ```should_panic
/// # use ntest::assert_panics;
/// # fn main() {
/// assert_panics!({println!("I am not panicing")});
/// # }
/// ```
#[macro_export]
macro_rules! assert_panics {
($x:block) => {{
let result = std::panic::catch_unwind(|| $x);
if !result.is_err() {
panic!("assertion failed: code in block did not panic");
}
}};
($x:block,) => {{
assert_panics!($x);
}};
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn assert_true() {
assert_true!(true);
}
#[test]
#[should_panic]
fn assert_true_fails() {
assert_true!(false);
}
#[test]
fn assert_true_trailing_comma() {
assert_true!(true,);
}
#[test]
fn assert_false() {
assert_false!(false);
}
#[test]
#[should_panic]
fn assert_false_fails() {
assert_false!(true);
}
#[test]
fn assert_false_trailing_comma() {
assert_false!(false,);
}
#[test]
fn assert_panics() {
assert_panics!({ panic!("I am panicing!") },);
}
#[test]
#[should_panic]
fn assert_panics_fails() {
assert_panics!({ println!("I am not panicing!") },);
}
#[test]
fn assert_panics_trailing_comma() {
assert_panics!({ panic!("I am panicing!") },);
}
#[test]
fn vector() {
assert_about_eq!(vec![1.1, 2.1], vec![1.1, 2.1]);
}
#[test]
#[should_panic]
fn vector_fails() {
assert_about_eq!(vec![1.2, 2.1], vec![1.1, 2.1]);
}
#[test]
fn vector_trailing_comma() {
assert_about_eq!(vec![1.2, 2.1], vec![1.2, 2.1],);
}
#[test]
fn vector_trailing_comma_with_epsilon() {
assert_about_eq!(vec![1.100000001, 2.1], vec![1.1, 2.1], 0.001f64,);
}
#[test]
fn it_should_not_panic_if_values_are_approx_equal() {
assert_about_eq!(64f32.sqrt(), 8f32);
}
#[test]
fn about_equal_f32() {
assert_about_eq!(3f32, 3f32, 1f64);
}
#[test]
fn about_equal_f64() {
assert_about_eq!(3f64, 3f64);
}
#[test]
fn compare_with_epsilon() {
assert_about_eq!(42f64, 43f64, 2f64);
}
#[test]
#[should_panic]
fn fail_with_epsilon() {
assert_about_eq!(3f64, 4f64, 1e-8f64);
}
}