Skip to content

Commit fd05494

Browse files
cramertjcopybara-github
cramertj
authored and
copybara-github
committed
Use UFCS for with_message assertions
Before this CL, the assertion macro variants which accept messages would add the message via a call to the `with_message` method from the `GoogleTestSupport` trait. However, that trait may not be imported if users are not bringing in the full googletest prelude. This CL switches those method calls to UFCS and adds a utility method `and_log_failure_with_message` in order to make such calls more readable. PiperOrigin-RevId: 775268801
1 parent 7ef5c8b commit fd05494

File tree

4 files changed

+95
-57
lines changed

4 files changed

+95
-57
lines changed

‎googletest/src/assertions.rs‎

Lines changed: 61 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -513,9 +513,9 @@ macro_rules! expect_true {
513513
$crate::GoogleTestSupport::and_log_failure($crate::verify_true!($condition))
514514
}};
515515
($condition:expr, $($format_args:expr),* $(,)?) => {{
516-
$crate::GoogleTestSupport::and_log_failure($crate::verify_true!($condition)
517-
.with_failure_message(|| format!($($format_args),*))
518-
);
516+
$crate::GoogleTestSupport::and_log_failure_with_message(
517+
$crate::verify_true!($condition),
518+
|| format!($($format_args),*));
519519
}};
520520
}
521521
pub use expect_true;
@@ -602,9 +602,9 @@ macro_rules! expect_false {
602602
$crate::GoogleTestSupport::and_log_failure(($crate::verify_false!($condition)))
603603
}};
604604
($condition:expr, $($format_args:expr),* $(,)?) => {{
605-
$crate::GoogleTestSupport::and_log_failure($crate::verify_false!($condition)
606-
.with_failure_message(|| format!($($format_args),*))
607-
);
605+
$crate::GoogleTestSupport::and_log_failure_with_message(
606+
$crate::verify_false!($condition),
607+
|| format!($($format_args),*))
608608
}};
609609
}
610610
pub use expect_false;
@@ -731,25 +731,25 @@ macro_rules! expect_eq {
731731
$crate::GoogleTestSupport::and_log_failure($crate::verify_eq!($actual, [$($expected),*]));
732732
}};
733733
($actual:expr, [$($expected:expr),+ $(,)?], $($format_args:expr),* $(,)?) => {{
734-
$crate::GoogleTestSupport::and_log_failure($crate::verify_eq!($actual, [$($expected),*])
735-
.with_failure_message(|| format!($($format_args),*))
736-
);
734+
$crate::GoogleTestSupport::and_log_failure_with_message(
735+
$crate::verify_eq!($actual, [$($expected),*]),
736+
|| format!($($format_args),*));
737737
}};
738738
($actual:expr, {$($expected:expr),+ $(,)?} $(,)?) => {{
739739
$crate::GoogleTestSupport::and_log_failure($crate::verify_eq!($actual, {$($expected),*}));
740740
}};
741741
($actual:expr, {$($expected:expr),+ $(,)?}, $($format_args:expr),* $(,)?) => {{
742-
$crate::GoogleTestSupport::and_log_failure($crate::verify_eq!($actual, {$($expected),*})
743-
.with_failure_message(|| format!($($format_args),*))
744-
);
742+
$crate::GoogleTestSupport::and_log_failure_with_message(
743+
$crate::verify_eq!($actual, {$($expected),*}),
744+
|| format!($($format_args),*));
745745
}};
746746
($actual:expr, $expected:expr $(,)?) => {{
747747
$crate::GoogleTestSupport::and_log_failure($crate::verify_eq!($actual, $expected));
748748
}};
749749
($actual:expr, $expected:expr, $($format_args:expr),* $(,)?) => {{
750-
$crate::GoogleTestSupport::and_log_failure($crate::verify_eq!($actual, $expected)
751-
.with_failure_message(|| format!($($format_args),*))
752-
);
750+
$crate::GoogleTestSupport::and_log_failure_with_message(
751+
$crate::verify_eq!($actual, $expected),
752+
|| format!($($format_args),*));
753753
}};
754754
}
755755
pub use expect_eq;
@@ -822,9 +822,9 @@ pub use verify_ne;
822822
#[macro_export]
823823
macro_rules! expect_ne {
824824
($actual:expr, $expected:expr, $($format_args:expr),+ $(,)?) => {{
825-
$crate::GoogleTestSupport::and_log_failure($crate::verify_ne!($actual, $expected)
826-
.with_failure_message(|| format!($($format_args),*))
827-
);
825+
$crate::GoogleTestSupport::and_log_failure_with_message(
826+
$crate::verify_ne!($actual, $expected),
827+
|| format!($($format_args),*));
828828
}};
829829
($actual:expr, $expected:expr $(,)?) => {{
830830
$crate::GoogleTestSupport::and_log_failure($crate::verify_ne!($actual, $expected));
@@ -900,9 +900,9 @@ pub use verify_lt;
900900
#[macro_export]
901901
macro_rules! expect_lt {
902902
($actual:expr, $expected:expr, $($format_args:expr),+ $(,)?) => {{
903-
$crate::GoogleTestSupport::and_log_failure($crate::verify_lt!($actual, $expected)
904-
.with_failure_message(|| format!($($format_args),*))
905-
);
903+
$crate::GoogleTestSupport::and_log_failure_with_message(
904+
$crate::verify_lt!($actual, $expected),
905+
|| format!($($format_args),*));
906906
}};
907907
($actual:expr, $expected:expr $(,)?) => {{
908908
$crate::GoogleTestSupport::and_log_failure($crate::verify_lt!($actual, $expected));
@@ -979,9 +979,9 @@ pub use verify_le;
979979
#[macro_export]
980980
macro_rules! expect_le {
981981
($actual:expr, $expected:expr, $($format_args:expr),+ $(,)?) => {{
982-
$crate::GoogleTestSupport::and_log_failure($crate::verify_le!($actual, $expected)
983-
.with_failure_message(|| format!($($format_args),*))
984-
);
982+
$crate::GoogleTestSupport::and_log_failure_with_message(
983+
$crate::verify_le!($actual, $expected),
984+
|| format!($($format_args),*));
985985
}};
986986
($actual:expr, $expected:expr $(,)?) => {{
987987
$crate::GoogleTestSupport::and_log_failure($crate::verify_le!($actual, $expected));
@@ -1057,9 +1057,9 @@ pub use verify_gt;
10571057
#[macro_export]
10581058
macro_rules! expect_gt {
10591059
($actual:expr, $expected:expr, $($format_args:expr),+ $(,)?) => {{
1060-
$crate::GoogleTestSupport::and_log_failure($crate::verify_gt!($actual, $expected)
1061-
.with_failure_message(|| format!($($format_args),*))
1062-
);
1060+
$crate::GoogleTestSupport::and_log_failure_with_message(
1061+
$crate::verify_gt!($actual, $expected),
1062+
|| format!($($format_args),*));
10631063
}};
10641064
($actual:expr, $expected:expr $(,)?) => {{
10651065
$crate::GoogleTestSupport::and_log_failure($crate::verify_gt!($actual, $expected));
@@ -1137,9 +1137,9 @@ pub use verify_ge;
11371137
#[macro_export]
11381138
macro_rules! expect_ge {
11391139
($actual:expr, $expected:expr, $($format_args:expr),+ $(,)?) => {{
1140-
$crate::GoogleTestSupport::and_log_failure($crate::verify_ge!($actual, $expected)
1141-
.with_failure_message(|| format!($($format_args),*))
1142-
);
1140+
$crate::GoogleTestSupport::and_log_failure_with_message(
1141+
$crate::verify_ge!($actual, $expected),
1142+
|| format!($($format_args),*));
11431143
}};
11441144
($actual:expr, $expected:expr $(,)?) => {{
11451145
$crate::GoogleTestSupport::and_log_failure($crate::verify_ge!($actual, $expected));
@@ -1232,9 +1232,9 @@ pub use verify_float_eq;
12321232
#[macro_export]
12331233
macro_rules! expect_float_eq {
12341234
($actual:expr, $expected:expr, $($format_args:expr),+ $(,)?) => {{
1235-
$crate::GoogleTestSupport::and_log_failure($crate::verify_float_eq!($actual, $expected)
1236-
.with_failure_message(|| format!($($format_args),*))
1237-
);
1235+
$crate::GoogleTestSupport::and_log_failure_with_message(
1236+
$crate::verify_float_eq!($actual, $expected),
1237+
|| format!($($format_args),*));
12381238
}};
12391239
($actual:expr, $expected:expr $(,)?) => {{
12401240
$crate::GoogleTestSupport::and_log_failure($crate::verify_float_eq!($actual, $expected));
@@ -1313,9 +1313,9 @@ pub use verify_near;
13131313
#[macro_export]
13141314
macro_rules! expect_near {
13151315
($actual:expr, $expected:expr, $max_abs_error:expr, $($format_args:expr),+ $(,)?) => {{
1316-
$crate::GoogleTestSupport::and_log_failure($crate::verify_near!($actual, $expected, $max_abs_error)
1317-
.with_failure_message(|| format!($($format_args),*))
1318-
);
1316+
$crate::GoogleTestSupport::and_log_failure_with_message(
1317+
$crate::verify_near!($actual, $expected, $max_abs_error),
1318+
|| format!($($format_args),*));
13191319
}};
13201320
($actual:expr, $expected:expr, $max_abs_error:expr $(,)?) => {{
13211321
$crate::GoogleTestSupport::and_log_failure($crate::verify_near!($actual, $expected, $max_abs_error));
@@ -1394,8 +1394,9 @@ macro_rules! assert_that {
13941394

13951395
// w/ format args, specialized to sequence:
13961396
($actual:expr, [ $($expected:expr),* ], $($format_args:expr),* $(,)?) => {
1397-
match $crate::verify_that!($actual, [ $($expected),* ])
1398-
.with_failure_message(|| format!($($format_args),*))
1397+
match $crate::GoogleTestSupport::with_failure_message(
1398+
$crate::verify_that!($actual, [ $($expected),* ]),
1399+
|| format!($($format_args),*))
13991400
{
14001401
Ok(_) => {}
14011402
Err(e) => {
@@ -1408,8 +1409,9 @@ macro_rules! assert_that {
14081409

14091410
// w/ format args, specialized to unordered sequence:
14101411
($actual:expr, { $($expected:expr),* }, $($format_args:expr),* $(,)?) => {
1411-
match $crate::verify_that!($actual, { $($expected),* })
1412-
.with_failure_message(|| format!($($format_args),*))
1412+
match $crate::GoogleTestSupport::with_failure_message(
1413+
$crate::verify_that!($actual, { $($expected),* }),
1414+
|| format!($($format_args),*))
14131415
{
14141416
Ok(_) => {}
14151417
Err(e) => {
@@ -1434,8 +1436,9 @@ macro_rules! assert_that {
14341436

14351437
// w/ format args, general case:
14361438
($actual:expr, $expected:expr, $($format_args:expr),* $(,)?) => {
1437-
match $crate::verify_that!($actual, $expected)
1438-
.with_failure_message(|| format!($($format_args),*))
1439+
match $crate::GoogleTestSupport::with_failure_message(
1440+
$crate::verify_that!($actual, $expected),
1441+
|| format!($($format_args),*))
14391442
{
14401443
Ok(_) => {}
14411444
Err(e) => {
@@ -1490,8 +1493,10 @@ macro_rules! assert_pred {
14901493

14911494
// w/ format args
14921495
($content:expr $(,)?, $($format_args:expr),* $(,)?) => {
1493-
match $crate::verify_pred!($content)
1494-
.with_failure_message(|| format!($($format_args),*)) {
1496+
match $crate::GoogleTestSupport::with_failure_message(
1497+
$crate::verify_pred!($content),
1498+
|| format!($($format_args),*)
1499+
) {
14951500
Ok(_) => {}
14961501
Err(e) => {
14971502
// The extra newline before the assertion failure message makes the failure a
@@ -1559,16 +1564,16 @@ macro_rules! expect_that {
15591564

15601565
// w/ format args, specialized to sequence:
15611566
($actual:expr, [$($expected:expr),*], $($format_args:expr),* $(,)?) => {
1562-
$crate::GoogleTestSupport::and_log_failure($crate::verify_that!($actual, [$($expected),*])
1563-
.with_failure_message(|| format!($($format_args),*))
1564-
)
1567+
$crate::GoogleTestSupport::and_log_failure_with_message(
1568+
$crate::verify_that!($actual, [$($expected),*]),
1569+
|| format!($($format_args),*))
15651570
};
15661571

15671572
// w/ format args, specialized to unordered sequence:
15681573
($actual:expr, {$($expected:expr),*}, $($format_args:expr),* $(,)?) => {
1569-
$crate::GoogleTestSupport::and_log_failure($crate::verify_that!($actual, {$($expected),*})
1570-
.with_failure_message(|| format!($($format_args),*))
1571-
)
1574+
$crate::GoogleTestSupport::and_log_failure_with_message(
1575+
$crate::verify_that!($actual, {$($expected),*}),
1576+
|| format!($($format_args),*))
15721577
};
15731578

15741579
// general case:
@@ -1578,9 +1583,9 @@ macro_rules! expect_that {
15781583

15791584
// w/ format args, general case:
15801585
($actual:expr, $expected:expr, $($format_args:expr),* $(,)?) => {
1581-
$crate::GoogleTestSupport::and_log_failure($crate::verify_that!($actual, $expected)
1582-
.with_failure_message(|| format!($($format_args),*))
1583-
)
1586+
$crate::GoogleTestSupport::and_log_failure_with_message(
1587+
$crate::verify_that!($actual, $expected),
1588+
|| format!($($format_args),*))
15841589
};
15851590
}
15861591
pub use expect_that;
@@ -1628,9 +1633,9 @@ macro_rules! expect_pred {
16281633
}};
16291634
// w/ format args
16301635
($content:expr $(,)?, $($format_args:expr),* $(,)?) => {
1631-
$crate::GoogleTestSupport::and_log_failure($crate::verify_pred!($content)
1632-
.with_failure_message(|| format!($($format_args),*))
1633-
)
1636+
$crate::GoogleTestSupport::and_log_failure_with_message(
1637+
$crate::verify_pred!($content),
1638+
|| format!($($format_args),*))
16341639
};
16351640
}
16361641
pub use expect_pred;

‎googletest/src/lib.rs‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,31 @@ pub trait GoogleTestSupport {
148148
/// ```
149149
fn and_log_failure(self);
150150

151+
/// If `self` is a `Result::Err`, writes to `stdout` with a failure report
152+
/// and the message returned by `provider`.
153+
///
154+
/// This is equivalent to combining [`GoogleTestSupport::and_log_failure`]
155+
/// with a call to [`GoogleTestSupport::with_failure_message`].
156+
///
157+
/// Example:
158+
///
159+
/// ```
160+
/// # use googletest::GoogleTestSupport;
161+
/// # use googletest::assertions::verify_eq;
162+
/// # use googletest::internal::test_outcome::TestOutcome;
163+
/// # TestOutcome::init_current_test_outcome();
164+
/// let actual = 0;
165+
/// verify_eq!(actual, 42)
166+
/// .and_log_failure_with_message(|| format!("Actual {} was wrong!", actual));
167+
/// # TestOutcome::close_current_test_outcome::<&str>(Ok(())).unwrap_err();
168+
/// ```
169+
fn and_log_failure_with_message(self, provider: impl FnOnce() -> String)
170+
where
171+
Self: Sized,
172+
{
173+
self.with_failure_message(provider).and_log_failure();
174+
}
175+
151176
/// Adds `message` to the logged failure message if `self` is a
152177
/// `Result::Err`. Otherwise, does nothing.
153178
///

‎integration_tests/src/integration_tests.rs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2002,6 +2002,9 @@ mod tests {
20022002
contains_substring("test tests::expect_false_works ... ok"),
20032003
contains_substring("test tests::verify_eq_works ... ok"),
20042004
contains_substring("test tests::expect_eq_works ... ok"),
2005+
contains_substring(
2006+
"test tests::expect_eq_with_message_compiles_without_trait_imports ... ok"
2007+
),
20052008
contains_substring("test tests::verify_ne_works ... ok"),
20062009
contains_substring("test tests::expect_ne_works ... ok"),
20072010
contains_substring("test tests::verify_lt_works ... ok"),
@@ -2020,7 +2023,7 @@ mod tests {
20202023
contains_substring("test tests::assert_pred_works ... ok"),
20212024
contains_substring("test tests::expect_that_works ... ok"),
20222025
contains_substring("test tests::expect_pred_works ... ok"),
2023-
contains_substring("test result: FAILED. 27 passed; 3 failed;")
2026+
contains_substring("test result: FAILED. 28 passed; 3 failed;")
20242027
)
20252028
)
20262029
}

‎integration_tests/src/macro_hygiene.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ mod tests {
8888
googletest::expect_eq!(2 + 2, 4);
8989
}
9090

91+
#[gtest]
92+
fn expect_eq_with_message_compiles_without_trait_imports() {
93+
googletest::expect_eq!(1, 1, "Some message.");
94+
}
95+
9196
#[gtest]
9297
fn verify_ne_works() -> googletest::Result<()> {
9398
googletest::verify_ne!(2 + 2, 5)

0 commit comments

Comments
 (0)