Catch2/projects/SelfTest/UsageTests/Matchers.tests.cpp

/*
 *  Created by Phil on 21/02/2017.
 *  Copyright 2017 Two Blue Cubes Ltd. All rights reserved.
 *
 *  Distributed under the Boost Software License, Version 1.0. (See accompanying
 *  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 */

#include "catch.hpp"

#include <sstream>

#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wweak-vtables"
#pragma clang diagnostic ignored "-Wpadded"
#endif

#ifndef CATCH_CONFIG_DISABLE_MATCHERS

inline const char* testStringForMatching()
{
    return "this string contains 'abc' as a substring";
}
inline const char* testStringForMatching2()
{
    return "some completely different text that contains one common word";
}

using namespace Catch::Matchers;

TEST_CASE("String matchers", "[matchers]" ) {
    REQUIRE_THAT( testStringForMatching(), Contains( "string" ) );
    REQUIRE_THAT( testStringForMatching(), Contains( "string", Catch::CaseSensitive::No ));
    CHECK_THAT( testStringForMatching(), Contains( "abc" ) );
    CHECK_THAT( testStringForMatching(), Contains( "aBC", Catch::CaseSensitive::No ));

    CHECK_THAT( testStringForMatching(), StartsWith( "this" ) );
    CHECK_THAT( testStringForMatching(), StartsWith( "THIS", Catch::CaseSensitive::No ));
    CHECK_THAT( testStringForMatching(), EndsWith( "substring" ) );
    CHECK_THAT( testStringForMatching(), EndsWith(" SuBsTrInG", Catch::CaseSensitive::No ));
}

TEST_CASE("Contains string matcher", "[.][failing][matchers]") {
    CHECK_THAT( testStringForMatching(), Contains( "not there", Catch::CaseSensitive::No ) );
    CHECK_THAT( testStringForMatching(), Contains( "STRING" ));
}

TEST_CASE("StartsWith string matcher", "[.][failing][matchers]") {
    CHECK_THAT( testStringForMatching(), StartsWith( "This String" ));
    CHECK_THAT( testStringForMatching(), StartsWith( "string", Catch::CaseSensitive::No ) );
}

TEST_CASE("EndsWith string matcher", "[.][failing][matchers]") {
    CHECK_THAT( testStringForMatching(), EndsWith( "Substring" ));
    CHECK_THAT( testStringForMatching(), EndsWith( "this", Catch::CaseSensitive::No ) );
}

TEST_CASE("Equals string matcher", "[.][failing][matchers]") {
    CHECK_THAT( testStringForMatching(), Equals( "this string contains 'ABC' as a substring" ) );
    CHECK_THAT( testStringForMatching(), Equals( "something else", Catch::CaseSensitive::No ));
}

TEST_CASE("Equals", "[matchers]") {
    CHECK_THAT( testStringForMatching(), Equals( "this string contains 'abc' as a substring" ));
    CHECK_THAT( testStringForMatching(), Equals( "this string contains 'ABC' as a substring", Catch::CaseSensitive::No ) );
}

// <regex> does not work in libstdc++ 4.8, so we have to enable these tests only when they
// are expected to pass and cannot have them in baselines
TEST_CASE("Regex string matcher -- libstdc++-4.8 workaround", "[matchers][approvals]") {

// This is fiiiine
// Taken from an answer at
// https://stackoverflow.com/questions/12530406/is-gcc-4-8-or-earlier-buggy-about-regular-expressions
#if (!defined(__GNUC__))                                 || \
      (__cplusplus >= 201103L                            && \
      (!defined(__GLIBCXX__) || (__cplusplus >= 201402L) || \
        (defined(_GLIBCXX_REGEX_DFS_QUANTIFIERS_LIMIT)   || \
          defined(_GLIBCXX_REGEX_STATE_LIMIT)            || \
             (defined(_GLIBCXX_RELEASE)                  && \
             _GLIBCXX_RELEASE > 4))))

    REQUIRE_THAT(testStringForMatching(), Matches("this string contains 'abc' as a substring"));
    REQUIRE_THAT(testStringForMatching(), Matches("this string CONTAINS 'abc' as a substring", Catch::CaseSensitive::No));
    REQUIRE_THAT(testStringForMatching(), Matches("^this string contains 'abc' as a substring$"));
    REQUIRE_THAT(testStringForMatching(), Matches("^.* 'abc' .*$"));
    REQUIRE_THAT(testStringForMatching(), Matches("^.* 'ABC' .*$", Catch::CaseSensitive::No));
#endif

    REQUIRE_THAT(testStringForMatching2(), !Matches("this string contains 'abc' as a substring"));
}

TEST_CASE("Regex string matcher", "[matchers][.failing]") {
    CHECK_THAT( testStringForMatching(), Matches("this STRING contains 'abc' as a substring"));
    CHECK_THAT( testStringForMatching(), Matches("contains 'abc' as a substring"));
    CHECK_THAT( testStringForMatching(), Matches("this string contains 'abc' as a"));
}

TEST_CASE("Matchers can be (AllOf) composed with the && operator", "[matchers][operators][operator&&]")
{
    CHECK_THAT( testStringForMatching(),
                Contains( "string" ) &&
                Contains( "abc" ) &&
                Contains( "substring" ) &&
                Contains( "contains" ) );
}

TEST_CASE("Matchers can be (AnyOf) composed with the || operator", "[matchers][operators][operator||]")
{
    CHECK_THAT( testStringForMatching(), Contains( "string" ) || Contains( "different" ) || Contains( "random" ) );
    CHECK_THAT( testStringForMatching2(), Contains( "string" ) || Contains( "different" ) || Contains( "random" ) );
}

TEST_CASE("Matchers can be composed with both && and ||", "[matchers][operators][operator||][operator&&]")
{
    CHECK_THAT( testStringForMatching(), ( Contains( "string" ) || Contains( "different" ) ) && Contains( "substring" ) );
}

TEST_CASE("Matchers can be composed with both && and || - failing", "[matchers][operators][operator||][operator&&][.failing]")
{
    CHECK_THAT( testStringForMatching(), ( Contains( "string" ) || Contains( "different" ) ) && Contains( "random" ) );
}

TEST_CASE("Matchers can be negated (Not) with the ! operator", "[matchers][operators][not]")
{
    CHECK_THAT( testStringForMatching(), !Contains( "different" ) );
}

TEST_CASE("Matchers can be negated (Not) with the ! operator - failing", "[matchers][operators][not][.failing]")
{
    CHECK_THAT( testStringForMatching(), !Contains( "substring" ) );
}

TEST_CASE( "Vector matchers", "[matchers][vector]" ) {
    std::vector<int> v;
    v.push_back( 1 );
    v.push_back( 2 );
    v.push_back( 3 );

    std::vector<int> v2;
    v2.push_back( 1 );
    v2.push_back( 2 );

    std::vector<int> empty;

    SECTION( "Contains (element)" ) {
        CHECK_THAT( v, VectorContains( 1 ) );
        CHECK_THAT( v, VectorContains( 2 ) );
    }
    SECTION( "Contains (vector)" ) {
        CHECK_THAT( v, Contains( v2 ) );
        v2.push_back( 3 ); // now exactly matches
        CHECK_THAT( v, Contains( v2 ) );

        CHECK_THAT( v, Contains( empty) );
        CHECK_THAT( empty, Contains( empty) );
    }
    SECTION( "Contains (element), composed" ) {
        CHECK_THAT( v, VectorContains( 1 ) && VectorContains( 2 ) );
    }

    SECTION( "Equals" ) {

        // Same vector
        CHECK_THAT( v, Equals( v ) );

        CHECK_THAT( empty, Equals( empty ) );

        // Different vector with same elements
        v2.push_back( 3 );
        CHECK_THAT( v, Equals( v2 ) );
    }
}

TEST_CASE( "Vector matchers that fail", "[matchers][vector][.][failing]" ) {
    std::vector<int> v;
    v.push_back( 1 );
    v.push_back( 2 );
    v.push_back( 3 );

    std::vector<int> v2;
    v2.push_back( 1 );
    v2.push_back( 2 );

    std::vector<int> empty;

    SECTION( "Contains (element)" ) {
        CHECK_THAT( v, VectorContains( -1 ) );
        CHECK_THAT( empty, VectorContains( 1 ) );
    }
    SECTION( "Contains (vector)" ) {
        CHECK_THAT( empty, Contains( v) );
        v2.push_back( 4 );
        CHECK_THAT( v, Contains( v2 ) );
    }

    SECTION( "Equals" ) {

        CHECK_THAT( v, Equals( v2 ) );
        CHECK_THAT( v2, Equals( v ) );
        CHECK_THAT( empty, Equals( v ) );
        CHECK_THAT( v, Equals( empty ) );
    }
}

#ifdef _MSC_VER
#pragma warning(disable:4702) // Unreachable code -- MSVC 19 (VS 2015) sees right through the indirection
#endif

#include <exception>

struct SpecialException : std::exception {
    SpecialException(int i_):i(i_) {}
    int i;
};

void doesNotThrow() {}

[[noreturn]]
void throws(int i) {
    throw SpecialException{ i };
}

[[noreturn]]
void throwsAsInt(int i) {
    throw i;
}

class ExceptionMatcher : public Catch::MatcherBase<SpecialException> {
    int m_expected;
public:
    ExceptionMatcher(int i):m_expected(i) {}
    bool match(SpecialException const& se) const override {
        return se.i == m_expected;
    }

    std::string describe() const override {
        std::ostringstream ss;
        ss << "special exception has value of " << m_expected;
        return ss.str();
    }
};


TEST_CASE( "Exception matchers that succeed", "[matchers][exceptions][!throws]" ) {
    CHECK_THROWS_MATCHES(throws(1), SpecialException, ExceptionMatcher{ 1 });
    REQUIRE_THROWS_MATCHES(throws(2), SpecialException, ExceptionMatcher{ 2 });
}

TEST_CASE("Exception matchers that fail", "[matchers][exceptions][!throws][.failing]") {
    SECTION("No exception") {
        CHECK_THROWS_MATCHES(doesNotThrow(), SpecialException, ExceptionMatcher{ 1 });
        REQUIRE_THROWS_MATCHES(doesNotThrow(), SpecialException, ExceptionMatcher{ 1 });
    }
    SECTION("Type mismatch") {
        CHECK_THROWS_MATCHES(throwsAsInt(1), SpecialException, ExceptionMatcher{ 1 });
        REQUIRE_THROWS_MATCHES(throwsAsInt(1), SpecialException, ExceptionMatcher{ 1 });
    }
    SECTION("Contents are wrong") {
        CHECK_THROWS_MATCHES(throws(3), SpecialException, ExceptionMatcher{ 1 });
        REQUIRE_THROWS_MATCHES(throws(4), SpecialException, ExceptionMatcher{ 1 });
    }
}

TEST_CASE("Floating point matchers: float", "[matchers][floating-point]") {
    SECTION("Margin") {
        REQUIRE_THAT(1.f, WithinAbs(1.f, 0));
        REQUIRE_THAT(0.f, WithinAbs(1.f, 1));

        REQUIRE_THAT(0.f, !WithinAbs(1.f, 0.99f));
        REQUIRE_THAT(0.f, !WithinAbs(1.f, 0.99f));

        REQUIRE_THAT(0.f, WithinAbs(-0.f, 0));
        REQUIRE_THAT(NAN, !WithinAbs(NAN, 0));
    }
    SECTION("ULPs") {
        REQUIRE_THAT(1.f, WithinULP(1.f, 0));

        REQUIRE_THAT(std::nextafter(1.f, 2.f), WithinULP(1.f, 1));
        REQUIRE_THAT(std::nextafter(1.f, 0.f), WithinULP(1.f, 1));
        REQUIRE_THAT(std::nextafter(1.f, 2.f), !WithinULP(1.f, 0));

        REQUIRE_THAT(1.f, WithinULP(1.f, 0));
        REQUIRE_THAT(-0.f, WithinULP(0.f, 0));

        REQUIRE_THAT(NAN, !WithinULP(NAN, 123));
    }
    SECTION("Composed") {
        REQUIRE_THAT(1.f, WithinAbs(1.f, 0.5) || WithinULP(1.f, 1));
        REQUIRE_THAT(1.f, WithinAbs(2.f, 0.5) || WithinULP(1.f, 0));

        REQUIRE_THAT(NAN, !(WithinAbs(NAN, 100) || WithinULP(NAN, 123)));
    }
}

TEST_CASE("Floating point matchers: double", "[matchers][floating-point]") {
    SECTION("Margin") {
        REQUIRE_THAT(1., WithinAbs(1., 0));
        REQUIRE_THAT(0., WithinAbs(1., 1));

        REQUIRE_THAT(0., !WithinAbs(1., 0.99));
        REQUIRE_THAT(0., !WithinAbs(1., 0.99));

        REQUIRE_THAT(NAN, !WithinAbs(NAN, 0));
    }
    SECTION("ULPs") {
        REQUIRE_THAT(1., WithinULP(1., 0));

        REQUIRE_THAT(std::nextafter(1., 2.), WithinULP(1., 1));
        REQUIRE_THAT(std::nextafter(1., 0.), WithinULP(1., 1));
        REQUIRE_THAT(std::nextafter(1., 2.), !WithinULP(1., 0));

        REQUIRE_THAT(1., WithinULP(1., 0));
        REQUIRE_THAT(-0., WithinULP(0., 0));

        REQUIRE_THAT(NAN, !WithinULP(NAN, 123));
    }
    SECTION("Composed") {
        REQUIRE_THAT(1., WithinAbs(1., 0.5) || WithinULP(2., 1));
        REQUIRE_THAT(1., WithinAbs(2., 0.5) || WithinULP(1., 0));

        REQUIRE_THAT(NAN, !(WithinAbs(NAN, 100) || WithinULP(NAN, 123)));
    }
}

#endif // CATCH_CONFIG_DISABLE_MATCHERS

#ifdef __clang__
#pragma clang diagnostic pop
#endif