catch2/Test/ConditionTests.cpp

/*
 *  ConditionTests.cpp
 *  Catch - Test
 *
 *  Created by Phil on 08/11/2010.
 *  Copyright 2010 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 <string>

struct TestData
{
    TestData()
    :   int_seven( 7 ),
        str_hello( "hello" ),
        float_nine_point_one( 9.1f ),
        double_pi( 3.1415926535 )
    {}
    
    int int_seven;
    std::string str_hello;
    float float_nine_point_one;
    double double_pi;
};

// These tests all use the CHECK macro, which continues if the specific test fails.
// This allows us to see all results, even if an earlier check fails - which is 
// particularly important for the "should fail" checks

// Equality tests
TEST_CASE( "succeeding/conditions/equality", "Equality checks that should succeed" )
{
    TestData data;
    
    CHECK( data.int_seven == 7 );
    CHECK( data.float_nine_point_one == Approx( 9.1f ) );
    CHECK( data.double_pi == Approx( 3.1415926535 ) );
    CHECK( data.str_hello == "hello" );
    CHECK( data.str_hello.size() == 5 );

    double x = 1.1 + 0.1 + 0.1;
    CHECK( x == Approx( 1.3 ) );
}

TEST_CASE( "failing/conditions/equality", "Equality checks that should fail" )
{
    TestData data;
    
    CHECK( data.int_seven == 6 );
    CHECK( data.int_seven == 8 );
    CHECK( data.int_seven == 0 );
    CHECK( data.float_nine_point_one == Approx( 9.11f ) );
    CHECK( data.float_nine_point_one == Approx( 9.0f ) );
    CHECK( data.float_nine_point_one == 1 );
    CHECK( data.float_nine_point_one == 0 );
    CHECK( data.double_pi == Approx( 3.1415 ) );
    CHECK( data.str_hello == "goodbye" );
    CHECK( data.str_hello == "hell" );
    CHECK( data.str_hello == "hello1" );
    CHECK( data.str_hello.size() == 6 );

    double x = 1.1 + 0.1 + 0.1;
    CHECK( x == Approx( 1.301 ) );
}

TEST_CASE( "succeeding/conditions/inequality", "Inequality checks that should succeed" )
{
    TestData data;
    
    CHECK( data.int_seven != 6 );
    CHECK( data.int_seven != 8 );
    CHECK( data.float_nine_point_one != Approx( 9.11f ) );
    CHECK( data.float_nine_point_one != Approx( 9.0f ) );
    CHECK( data.float_nine_point_one != 1 );
    CHECK( data.float_nine_point_one != 0 );
    CHECK( data.double_pi != Approx( 3.1415 ) );
    CHECK( data.str_hello != "goodbye" );
    CHECK( data.str_hello != "hell" );
    CHECK( data.str_hello != "hello1" );
    CHECK( data.str_hello.size() != 6 );
}

TEST_CASE( "failing/conditions/inequality", "Inequality checks that should fails" )
{
    TestData data;
    
    CHECK( data.int_seven != 7 );
    CHECK( data.float_nine_point_one != Approx( 9.1f ) );
    CHECK( data.double_pi != Approx( 3.1415926535 ) );
    CHECK( data.str_hello != "hello" );
    CHECK( data.str_hello.size() != 5 );
}

// Ordering comparison tests
TEST_CASE( "succeeding/conditions/ordered", "Ordering comparison checks that should succeed" )
{
    TestData data;
    
    CHECK( data.int_seven < 8 );
    CHECK( data.int_seven > 6 );
    CHECK( data.int_seven > 0 );
    CHECK( data.int_seven > -1 );

    CHECK( data.int_seven >= 7 );
    CHECK( data.int_seven >= 6 );
    CHECK( data.int_seven <= 7 );
    CHECK( data.int_seven <= 8 );
    
    CHECK( data.float_nine_point_one > 9 );
    CHECK( data.float_nine_point_one < 10 );
    CHECK( data.float_nine_point_one < 9.2 );
    
    CHECK( data.str_hello <= "hello" );
    CHECK( data.str_hello >= "hello" );
    
    CHECK( data.str_hello < "hellp" );
    CHECK( data.str_hello < "zebra" );
    CHECK( data.str_hello > "hellm" );
    CHECK( data.str_hello > "a" );
}

TEST_CASE( "failing/conditions/ordered", "Ordering comparison checks that should fail" )
{
    TestData data;
    
    CHECK( data.int_seven > 7 );
    CHECK( data.int_seven < 7 );
    CHECK( data.int_seven > 8 );
    CHECK( data.int_seven < 6 );
    CHECK( data.int_seven < 0 );
    CHECK( data.int_seven < -1 );

    CHECK( data.int_seven >= 8 );
    CHECK( data.int_seven <= 6 );
    
    CHECK( data.float_nine_point_one < 9 );
    CHECK( data.float_nine_point_one > 10 );
    CHECK( data.float_nine_point_one > 9.2 );
    
    CHECK( data.str_hello > "hello" );
    CHECK( data.str_hello < "hello" );
    CHECK( data.str_hello > "hellp" );
    CHECK( data.str_hello > "z" );
    CHECK( data.str_hello < "hellm" );
    CHECK( data.str_hello < "a" );

    CHECK( data.str_hello >= "z" );
    CHECK( data.str_hello <= "a" );
}

// Not (!) tests
// The problem with the ! operator is that it has right-to-left associativity.
// This means we can't isolate it when we decompose. The simple CHECK( !false ) form, therefore,
// cannot have the operand value extracted. The test will work correctly, and the situation
// is detected and a warning issued.
// An alternative form of the macros (CHECK_NOT and EXPECT_NOT) can be used instead to capture
// the operand value.
TEST_CASE( "succeeding/conditions/not", "'Not' checks that should succeed" )
{
    bool falseValue = false;
    
    CHECK( !false );
    CHECK_NOT( false );

    CHECK( !falseValue );
    CHECK_NOT( falseValue );

    CHECK( !(1 == 2) );
    CHECK_NOT( 1 == 2 );
}

TEST_CASE( "failing/conditions/not", "'Not' checks that should fail" )
{
    bool trueValue = true;
    
    CHECK( !true );
    CHECK_NOT( true );
    
    CHECK( !trueValue );
    CHECK_NOT( trueValue );
    
    CHECK( !(1 == 1) );
    CHECK_NOT( 1 == 1 );
}