Merge pull request google#565 from calder:dev/finite-matchers

PiperOrigin-RevId: 726887315

Author: copybara-github

googletest/src/matchers/is_finite_matcher.rs

@@ -0,0 +1,84 @@
+// Copyright 2022 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.
+
+use crate::{
+    description::Description,
+    matcher::{Matcher, MatcherBase, MatcherResult},
+};
+use num_traits::float::Float;
+use std::fmt::Debug;
+
+/// Matches a floating point value which is Finite.
+pub fn is_finite() -> IsFiniteMatcher {
+    IsFiniteMatcher
+}
+
+#[derive(MatcherBase)]
+pub struct IsFiniteMatcher;
+
+impl<T: Float + Debug + Copy> Matcher<T> for IsFiniteMatcher {
+    fn matches(&self, actual: T) -> MatcherResult {
+        actual.is_finite().into()
+    }
+
+    fn describe(&self, matcher_result: MatcherResult) -> Description {
+        if matcher_result.into() { "is Finite" } else { "isn't Finite" }.into()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::prelude::*;
+    use crate::Result;
+
+    #[test]
+    fn matches_f32_number() -> Result<()> {
+        verify_that!(0.0f32, is_finite())
+    }
+
+    #[test]
+    fn does_not_match_f32_pos_infinity() -> Result<()> {
+        verify_that!(f32::INFINITY, not(is_finite()))
+    }
+
+    #[test]
+    fn does_not_match_f32_neg_infinity() -> Result<()> {
+        verify_that!(f32::NEG_INFINITY, not(is_finite()))
+    }
+
+    #[test]
+    fn does_not_match_f32_nan() -> Result<()> {
+        verify_that!(f32::NAN, not(is_finite()))
+    }
+
+    #[test]
+    fn matches_f64_number() -> Result<()> {
+        verify_that!(0.0f64, is_finite())
+    }
+
+    #[test]
+    fn does_not_match_f64_pos_infinity() -> Result<()> {
+        verify_that!(f64::INFINITY, not(is_finite()))
+    }
+
+    #[test]
+    fn does_not_match_f64_neg_infinity() -> Result<()> {
+        verify_that!(f64::NEG_INFINITY, not(is_finite()))
+    }
+
+    #[test]
+    fn does_not_match_f64_nan() -> Result<()> {
+        verify_that!(f64::NAN, not(is_finite()))
+    }
+}

googletest/src/matchers/is_infinite_matcher.rs

@@ -0,0 +1,84 @@
+// Copyright 2022 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.
+
+use crate::{
+    description::Description,
+    matcher::{Matcher, MatcherBase, MatcherResult},
+};
+use num_traits::float::Float;
+use std::fmt::Debug;
+
+/// Matches a floating point value which is Infinite.
+pub fn is_infinite() -> IsInfiniteMatcher {
+    IsInfiniteMatcher
+}
+
+#[derive(MatcherBase)]
+pub struct IsInfiniteMatcher;
+
+impl<T: Float + Debug + Copy> Matcher<T> for IsInfiniteMatcher {
+    fn matches(&self, actual: T) -> MatcherResult {
+        actual.is_infinite().into()
+    }
+
+    fn describe(&self, matcher_result: MatcherResult) -> Description {
+        if matcher_result.into() { "is Infinite" } else { "isn't Infinite" }.into()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::prelude::*;
+    use crate::Result;
+
+    #[test]
+    fn matches_f32_pos_infinity() -> Result<()> {
+        verify_that!(f32::INFINITY, is_infinite())
+    }
+
+    #[test]
+    fn matches_f32_neg_infinity() -> Result<()> {
+        verify_that!(f32::NEG_INFINITY, is_infinite())
+    }
+
+    #[test]
+    fn does_not_match_f32_number() -> Result<()> {
+        verify_that!(0.0f32, not(is_infinite()))
+    }
+
+    #[test]
+    fn does_not_match_f32_nan() -> Result<()> {
+        verify_that!(f32::NAN, not(is_finite()))
+    }
+
+    #[test]
+    fn matches_f64_pos_infinity() -> Result<()> {
+        verify_that!(f64::INFINITY, is_infinite())
+    }
+
+    #[test]
+    fn matches_f64_neg_infinity() -> Result<()> {
+        verify_that!(f64::NEG_INFINITY, is_infinite())
+    }
+
+    #[test]
+    fn does_not_match_f64_number() -> Result<()> {
+        verify_that!(0.0f64, not(is_infinite()))
+    }
+
+    #[test]
+    fn does_not_match_f64_nan() -> Result<()> {
+        verify_that!(f64::NAN, not(is_finite()))
+    }
+}

googletest/src/matchers/mod.rs

@@ -36,6 +36,8 @@ mod ge_matcher;
 mod gt_matcher;
 mod has_entry_matcher;
 mod is_encoded_string_matcher;
+mod is_finite_matcher;
+mod is_infinite_matcher;
 mod is_matcher;
 mod is_nan_matcher;
 mod le_matcher;
@@ -75,6 +77,8 @@ pub use ge_matcher::ge;
 pub use gt_matcher::gt;
 pub use has_entry_matcher::has_entry;
 pub use is_encoded_string_matcher::is_utf8_string;
+pub use is_finite_matcher::is_finite;
+pub use is_infinite_matcher::is_infinite;
 pub use is_nan_matcher::is_nan;
 pub use le_matcher::le;
 pub use len_matcher::len;