crates/googletest/src/matchers/ok_matcher.rs

// 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 std::fmt::Debug;

/// Matches a `Result` containing `Ok` with a value matched by `inner`.
///
/// ```
/// # use googletest::prelude::*;
/// # fn should_pass() -> googletest::Result<()> {
/// verify_that!(Ok::<_, ()>("Some value"), ok(eq("Some value")))?;  // Passes
/// #     Ok(())
/// # }
/// # fn should_fail_1() -> googletest::Result<()> {
/// verify_that!(Err::<&str, _>("An error"), ok(eq("An error")))?;   // Fails
/// #     Ok(())
/// # }
/// # fn should_fail_2() -> googletest::Result<()> {
/// verify_that!(Ok::<_, ()>("Some value"), ok(eq("Some other value")))?;   // Fails
/// #     Ok(())
/// # }
/// # should_pass().unwrap();
/// # should_fail_1().unwrap_err();
/// # should_fail_2().unwrap_err();
/// ```
pub fn ok<InnerMatcherT>(inner: InnerMatcherT) -> OkMatcher<InnerMatcherT> {
    OkMatcher { inner }
}

#[derive(MatcherBase)]
pub struct OkMatcher<InnerMatcherT> {
    inner: InnerMatcherT,
}

impl<T: Debug + Copy, E: Debug + Copy, InnerMatcherT: Matcher<T>> Matcher<std::result::Result<T, E>>
    for OkMatcher<InnerMatcherT>
{
    fn matches(&self, actual: std::result::Result<T, E>) -> MatcherResult {
        actual.map(|v| self.inner.matches(v)).unwrap_or(MatcherResult::NoMatch)
    }

    fn explain_match(&self, actual: std::result::Result<T, E>) -> Description {
        match actual {
            Ok(o) => {
                Description::new().text("which is a success").nested(self.inner.explain_match(o))
            }
            Err(_) => "which is an error".into(),
        }
    }

    fn describe(&self, matcher_result: MatcherResult) -> Description {
        match matcher_result {
            MatcherResult::Match => format!(
                "is a success containing a value, which {}",
                self.inner.describe(MatcherResult::Match)
            )
            .into(),
            MatcherResult::NoMatch => format!(
                "is an error or a success containing a value, which {}",
                self.inner.describe(MatcherResult::NoMatch)
            )
            .into(),
        }
    }
}

impl<'a, T: Debug, E: Debug, InnerMatcherT: Matcher<&'a T>> Matcher<&'a std::result::Result<T, E>>
    for OkMatcher<InnerMatcherT>
{
    fn matches(&self, actual: &'a std::result::Result<T, E>) -> MatcherResult {
        actual.as_ref().map(|v| self.inner.matches(v)).unwrap_or(MatcherResult::NoMatch)
    }

    fn explain_match(&self, actual: &'a std::result::Result<T, E>) -> Description {
        match actual {
            Ok(o) => {
                Description::new().text("which is a success").nested(self.inner.explain_match(o))
            }
            Err(_) => "which is an error".into(),
        }
    }

    fn describe(&self, matcher_result: MatcherResult) -> Description {
        match matcher_result {
            MatcherResult::Match => format!(
                "is a success containing a value, which {}",
                self.inner.describe(MatcherResult::Match)
            )
            .into(),
            MatcherResult::NoMatch => format!(
                "is an error or a success containing a value, which {}",
                self.inner.describe(MatcherResult::NoMatch)
            )
            .into(),
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::matcher::MatcherResult;
    use crate::prelude::*;
    use indoc::indoc;

    #[test]
    fn ok_matches_result_with_value() -> Result<()> {
        let matcher = ok(eq(1));
        let value: std::result::Result<i32, i32> = Ok(1);

        let result = matcher.matches(value);

        verify_that!(result, eq(MatcherResult::Match))
    }

    #[test]
    fn ok_does_not_match_result_with_wrong_value() -> Result<()> {
        let matcher = ok(eq(1));
        let value: std::result::Result<i32, i32> = Ok(0);

        let result = matcher.matches(value);

        verify_that!(result, eq(MatcherResult::NoMatch))
    }

    #[test]
    fn ok_does_not_match_result_with_err() -> Result<()> {
        let matcher = ok(eq(1));
        let value: std::result::Result<i32, i32> = Err(1);

        let result = matcher.matches(value);

        verify_that!(result, eq(MatcherResult::NoMatch))
    }

    #[test]
    fn ok_matches_result_with_value_by_ref() -> Result<()> {
        let result: std::result::Result<String, String> = Ok("123".into());
        verify_that!(result, ok(eq("123")))
    }

    #[test]
    fn ok_does_not_match_result_with_wrong_value_by_ref() -> Result<()> {
        let result: std::result::Result<String, String> = Ok("321".into());
        verify_that!(result, not(ok(eq("123"))))
    }

    #[test]
    fn ok_does_not_match_result_with_err_by_ref() -> Result<()> {
        let result: std::result::Result<String, String> = Err("123".into());
        verify_that!(result, not(ok(eq("123"))))
    }

    #[test]
    fn ok_full_error_message() -> Result<()> {
        let result = verify_that!(Ok::<i32, i32>(1), ok(eq(2)));

        verify_that!(
            result,
            err(displays_as(contains_substring(indoc!(
                "
                    Value of: Ok::<i32, i32>(1)
                    Expected: is a success containing a value, which is equal to 2
                    Actual: Ok(1),
                      which is a success
                        which isn't equal to 2
                "
            ))))
        )
    }

    #[test]
    fn ok_describe_match() -> Result<()> {
        let matcher = ok(eq(1));
        verify_that!(
            Matcher::<std::result::Result<i32, i32>>::describe(&matcher, MatcherResult::Match),
            displays_as(eq("is a success containing a value, which is equal to 1"))
        )
    }

    #[test]
    fn ok_describe_no_match() -> Result<()> {
        let matcher = ok(eq(1));
        verify_that!(
            Matcher::<std::result::Result<i32, i32>>::describe(&matcher, MatcherResult::NoMatch),
            displays_as(eq("is an error or a success containing a value, which isn't equal to 1"))
        )
    }

    #[test]
    fn ok_describe_match_by_ref() -> Result<()> {
        let matcher = ok(eq(&1));
        verify_that!(
            Matcher::<&std::result::Result<i32, String>>::describe(&matcher, MatcherResult::Match),
            displays_as(eq("is a success containing a value, which is equal to 1"))
        )
    }

    #[test]
    fn ok_describe_no_match_by_ref() -> Result<()> {
        let matcher = ok(eq(&1));
        verify_that!(
            Matcher::<&std::result::Result<i32, String>>::describe(
                &matcher,
                MatcherResult::NoMatch
            ),
            displays_as(eq("is an error or a success containing a value, which isn't equal to 1"))
        )
    }

    #[test]
    fn ok_explain_match_ok_success() -> Result<()> {
        let actual = Ok(1);
        let matcher = ok(eq(1));

        verify_that!(
            Matcher::<std::result::Result<i32, i32>>::explain_match(&matcher, actual),
            displays_as(eq("which is a success\n  which is equal to 1"))
        )
    }

    #[test]
    fn ok_explain_match_ok_fail() -> Result<()> {
        let actual = Ok(1);
        let matcher = ok(eq(2));

        verify_that!(
            Matcher::<std::result::Result<i32, i32>>::explain_match(&matcher, actual),
            displays_as(eq("which is a success\n  which isn't equal to 2"))
        )
    }

    #[test]
    fn ok_explain_match_ok_err() -> Result<()> {
        let actual = Err(1);
        let matcher = ok(eq(2));

        verify_that!(
            Matcher::<std::result::Result<i32, i32>>::explain_match(&matcher, actual),
            displays_as(eq("which is an error"))
        )
    }

    #[test]
    fn ok_explain_match_ok_success_by_ref() -> Result<()> {
        let actual = Ok("123".to_string());
        let matcher = ok(eq("123"));

        verify_that!(
            Matcher::<&std::result::Result<String, String>>::explain_match(&matcher, &actual),
            displays_as(eq("which is a success\n  which is equal to \"123\""))
        )
    }

    #[test]
    fn ok_explain_match_ok_fail_by_ref() -> Result<()> {
        let actual = Ok("321".to_string());
        let matcher = ok(eq("123"));

        verify_that!(
            Matcher::<&std::result::Result<String, String>>::explain_match(&matcher, &actual),
            displays_as(eq("which is a success\n  which isn't equal to \"123\""))
        )
    }

    #[test]
    fn ok_explain_match_ok_err_by_ref() -> Result<()> {
        let actual = Err("123".to_string());
        let matcher = ok(eq("123"));

        verify_that!(
            Matcher::<&std::result::Result<String, String>>::explain_match(&matcher, &actual),
            displays_as(eq("which is an error"))
        )
    }
}