float_eq family of assertions

PiperOrigin-RevId: 652899702

Author: satylogin

googletest/src/assertions.rs

@@ -1046,6 +1046,101 @@ macro_rules! expect_ge {
     }};
 }
 
+/// Checks whether the float given by first argument is approximately
+/// equal to second argument.
+///
+/// This automatically computes a tolerance from the magnitude of `expected` and
+/// matches any actual value within this tolerance of the expected value. The
+/// tolerance is chosen to account for the inaccuracies in most ordinary
+/// floating point calculations. To see details of how the tolerance is
+/// calculated look at the implementation of
+/// [`googletest::approx_eq`][crate::matchers::approx_eq].
+///
+/// Evaluates to `Result::Ok(())` if the first argument is approximately equal
+/// to the second and `Result::Err(TestAssertionFailure)` if it is not. The
+/// caller must then decide how to handle the `Err` variant. It has a few
+/// options:
+///  * Abort the current function with the `?` operator. This requires that the
+///    function return a suitable `Result`.
+///  * Log the test failure and continue by calling the method
+///    `and_log_failure`.
+///
+/// Of course, one can also use all other standard methods on `Result`.
+///
+/// **Invoking this macro by itself does not cause a test failure to be recorded
+/// or output.** The resulting `Result` must be handled as described above to
+/// cause the test to be recorded as a failure.
+///
+/// Example:
+/// ```ignore
+/// use googletest::prelude::*;
+///
+/// #[test]
+/// fn should_fail() -> Result<()> {
+///     verify_float_eq!(1.0, 2.0)
+/// }
+/// ```
+#[macro_export]
+macro_rules! verify_float_eq {
+    ($actual:expr, $expected:expr $(,)?) => {
+        verify_that!($actual, $crate::matchers::approx_eq($expected))
+    };
+}
+
+/// Marks test as failed and continues execution if the float given by the first
+/// argument is not approximately equal to the float given by the second
+/// argument.
+///
+/// This automatically computes a tolerance from the magnitude of `expected` and
+/// matches any actual value within this tolerance of the expected value. The
+/// tolerance is chosen to account for the inaccuracies in most ordinary
+/// floating point calculations. To see details of how the tolerance is
+/// calculated look at the implementation of
+/// [`googletest::approx_eq`][crate::matchers::approx_eq].
+///
+/// This is a **not-fatal** failure. The test continues execution even after the
+/// macro execution.
+///
+/// This can only be invoked inside tests with the
+/// [`googletest::test`][crate::test] attribute. The failure must be generated
+/// in the same thread as that running the test itself.
+///
+/// Example:
+/// ```ignore
+/// use googletest::prelude::*;
+///
+/// #[googletest::test]
+/// fn should_fail() {
+///     expect_float_eq!(1.0, 2.0);
+///     println!("This will print!");
+/// }
+/// ```
+///
+/// One may include formatted arguments in the failure message:
+///```ignore
+/// use googletest::prelude::*;
+///
+/// #[googletest::test]
+/// fn should_fail() {
+///     let argument = "argument"
+///     expect_float_eq!(1.0, 2.0, "custom failure message: {argument}");
+///     println!("This will print!");
+/// }
+/// ```
+#[macro_export]
+macro_rules! expect_float_eq {
+    ($actual:expr, $expected:expr, $($format_args:expr),+ $(,)?) => {{
+        use $crate::GoogleTestSupport;
+        verify_float_eq!($actual, $expected)
+            .with_failure_message(|| format!($($format_args),*))
+            .and_log_failure();
+    }};
+    ($actual:expr, $expected:expr $(,)?) => {{
+        use $crate::GoogleTestSupport;
+        verify_float_eq!($actual, $expected).and_log_failure();
+    }};
+}
+
 /// Matches the given value against the given matcher, panicking if it does not
 /// match.
 ///

googletest/src/lib.rs

@@ -50,10 +50,10 @@ pub mod prelude {
     pub use super::Result;
     // Assert macros
     pub use super::{
-        add_failure, add_failure_at, assert_that, expect_eq, expect_false, expect_ge, expect_gt,
-        expect_le, expect_lt, expect_ne, expect_pred, expect_that, expect_true, fail, succeed,
-        verify_eq, verify_false, verify_ge, verify_gt, verify_le, verify_lt, verify_ne,
-        verify_pred, verify_that, verify_true,
+        add_failure, add_failure_at, assert_that, expect_eq, expect_false, expect_float_eq,
+        expect_ge, expect_gt, expect_le, expect_lt, expect_ne, expect_pred, expect_that,
+        expect_true, fail, succeed, verify_eq, verify_false, verify_float_eq, verify_ge, verify_gt,
+        verify_le, verify_lt, verify_ne, verify_pred, verify_that, verify_true,
     };
 }
 

integration_tests/Cargo.toml

@@ -290,6 +290,21 @@ name = "expect_ge_supports_custom_message"
 path = "src/expect_ge_supports_custom_message.rs"
 test = false
 
+[[bin]]
+name = "verify_float_eq_when_not_equal_returns_error"
+path = "src/verify_float_eq_when_not_equal_returns_error.rs"
+test = false
+
+[[bin]]
+name = "expect_float_eq_when_not_equal_marks_failed"
+path = "src/expect_float_eq_when_not_equal_marks_failed.rs"
+test = false
+
+[[bin]]
+name = "expect_float_eq_supports_custom_message"
+path = "src/expect_float_eq_supports_custom_message.rs"
+test = false
+
 [[bin]]
 name = "failure_due_to_returned_error_with_line_numbers"
 path = "src/failure_due_to_returned_error_with_line_numbers.rs"

integration_tests/src/expect_float_eq_supports_custom_message.rs

@@ -0,0 +1,24 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+fn main() {}
+#[cfg(test)]
+mod tests {
+    use googletest::prelude::*;
+    #[googletest::test]
+    fn should_fail() {
+        let arg = "argument";
+        expect_float_eq!(1.0, 2.0, "Failure message with argument: {arg}");
+        println!("This will print");
+    }
+}

integration_tests/src/expect_float_eq_when_not_equal_marks_failed.rs

@@ -0,0 +1,23 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+fn main() {}
+#[cfg(test)]
+mod tests {
+    use googletest::prelude::*;
+    #[googletest::test]
+    fn should_fail() {
+        expect_float_eq!(1.0, 2.0);
+        println!("This will print");
+    }
+}

integration_tests/src/integration_tests.rs

@@ -1464,6 +1464,84 @@ mod tests {
         verify_that!(output, contains_regex("This will print"))
     }
 
+    #[test]
+    fn verify_float_eq_should_pass() -> Result<()> {
+        verify_float_eq!(1.0, 1.0)
+    }
+
+    #[test]
+    fn verify_float_eq_supports_trailing_comma() -> Result<()> {
+        verify_float_eq!(1.0, 1.0,)
+    }
+
+    #[googletest::test]
+    fn verify_float_eq_when_not_equal_returns_error() -> Result<()> {
+        let output = run_external_process_in_tests_directory(
+            "verify_float_eq_when_not_equal_returns_error",
+        )?;
+
+        verify_that!(
+            output,
+            contains_regex(indoc! {"
+                Expected: is within 1.[0-9]+e-[0-9]+ of 2.0
+                Actual: 1.0,
+                  which isn't within 1.[0-9]+e-[0-9]+ of 2.0
+                  at .*verify_float_eq_when_not_equal_returns_error.rs:[0-9]+:[0-9]
+            "})
+        )
+    }
+
+    #[googletest::test]
+    fn expect_float_eq_should_pass() {
+        expect_float_eq!(1.0, 1.0);
+    }
+
+    #[googletest::test]
+    fn expect_float_eq_supports_trailing_comma() {
+        expect_float_eq!(1.0, 1.0,);
+    }
+
+    #[googletest::test]
+    fn expect_float_eq_allows_multiple_invocations() {
+        expect_float_eq!(1.0, 1.0);
+        expect_float_eq!(2.0, 2.0);
+    }
+
+    #[googletest::test]
+    fn expect_float_eq_when_not_equal_marks_failed() -> Result<()> {
+        let output =
+            run_external_process_in_tests_directory("expect_float_eq_when_not_equal_marks_failed")?;
+
+        expect_that!(
+            output,
+            contains_regex(indoc! {"
+                Expected: is within 1.[0-9]+e-[0-9]+ of 2.0
+                Actual: 1.0,
+                  which isn't within 1.[0-9]+e-[0-9]+ of 2.0
+                  at .*expect_float_eq_when_not_equal_marks_failed.rs:[0-9]+:[0-9]
+            "})
+        );
+        verify_that!(output, contains_regex("This will print"))
+    }
+
+    #[googletest::test]
+    fn expect_float_eq_supports_custom_message() -> Result<()> {
+        let output =
+            run_external_process_in_tests_directory("expect_float_eq_supports_custom_message")?;
+
+        expect_that!(
+            output,
+            contains_regex(indoc! {"
+                Expected: is within 1.[0-9]+e-[0-9]+ of 2.0
+                Actual: 1.0,
+                  which isn't within 1.[0-9]+e-[0-9]+ of 2.0
+                Failure message with argument: argument
+                  at .*expect_float_eq_supports_custom_message.rs:[0-9]+:[0-9]
+            "})
+        );
+        verify_that!(output, contains_regex("This will print"))
+    }
+
     #[test]
     fn test_using_normal_test_attribute_macro_formats_failure_message_correctly() -> Result<()> {
         let result = should_display_error_correctly_without_google_test_macro();

integration_tests/src/verify_float_eq_when_not_equal_returns_error.rs

@@ -0,0 +1,25 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+fn main() {}
+
+#[cfg(test)]
+mod tests {
+    use googletest::prelude::*;
+
+    #[test]
+    fn should_fail() -> Result<()> {
+        verify_float_eq!(1.0, 2.0)
+    }
+}

run_integration_tests.sh

@@ -75,6 +75,9 @@ INTEGRATION_TEST_BINARIES=(
   "verify_ge_when_less_returns_error"
   "expect_ge_when_less_marks_failed"
   "expect_ge_supports_custom_message"
+  "verify_float_eq_when_not_equal_returns_error"
+  "expect_float_eq_when_not_equal_marks_failed"
+  "expect_float_eq_supports_custom_message"
   "fatal_and_non_fatal_failure"
   "first_failure_aborts"
   "google_test_with_rstest"