assertions.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Ondrej Starek
 *
 * This file is part of OTest2.
 *
 * OTest2 is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OTest2 is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with OTest2.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef OTest2__INCLUDE_OTEST2_ASSERTIONS_H_
#define OTest2__INCLUDE_OTEST2_ASSERTIONS_H_
 
#include <functional>
 
#include <otest2/assertbean.h>
#include <otest2/assertcontext.h>
#include <otest2/assertionannotation.h>
#include <otest2/comparisons.h>
#include <otest2/const.h>
 
namespace OTest2 {
 
class GenericAssertion : public AssertContext {
  public:
    /* -- avoid copying */
    GenericAssertion(
        const GenericAssertion&) = delete;
    GenericAssertion& operator =(
        const GenericAssertion&) = delete;
 
    /* -- inherit the constructor - the parent constructor is invoked
     *    from the test suite generated code. */
    using AssertContext::AssertContext;
 
    /* -- the assertion implementation */
    bool testAssert(
        bool condition_);
    bool testAssert(
        const AssertBean& bean_);
 
    template<typename Compare_, typename A_, typename B_>
    bool reportAssertion(
        Compare_&& cmp_,
        A_&& a_,
        B_&& b_,
        bool condition_);
    template<template<typename, typename> class Compare_, typename A_, typename B_>
    bool testAssertCompare(
        A_&& a_,
        B_&& b_);
    template<template<typename, typename, typename> class Compare_, typename A_, typename B_, typename Precision_ = long double>
    bool testAssertCompareFP(
        A_ a_,
        B_ b_,
        Precision_ precision_ = DEFAULT_FLOAT_PRECISION);
 
    /* -- exception assertion - it's never used as an assertion as
     *    it's always generated. */
    bool testException(
        std::function<bool()> ftor_);
};
 
namespace Assertions {
 
bool testAssert(
    bool condition_) TEST_ASSERTION_MARK(::OTest2::GenericAssertion, testAssert);
 
bool testAssert(
    const AssertBean& bean_) TEST_ASSERTION_MARK(::OTest2::GenericAssertion, testAssert);
 
bool testAssertExpr(
    bool expression_) TEST_ASSERTION_EXPR_MARK("::OTest2::GenericAssertion", "testAssert", "testAssertCompare< ::$1 >");
 
template<template<typename, typename> class Compare_, typename A_, typename B_>
bool testAssertCmp(
    A_ a_,
    B_ b_)
TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompare< ::$1 >");
 
template<template<typename, typename, typename> class Compare_, typename A_, typename B_, typename P_ = long double>
bool testAssertCmpFP(
    A_ a_,
    B_ b_,
    P_ precision_ = DEFAULT_FLOAT_PRECISION)
TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompareFP< ::$1 >");
 
template<typename A_, typename B_>
bool testAssertEqual(
    A_ a_,
    B_ b_) TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompare< ::OTest2::Equal >");
 
template<typename A_, typename B_, typename P_ = long double>
bool testAssertEqualFP(
    A_ a_,
    B_ b_,
    P_ precision_ = DEFAULT_FLOAT_PRECISION)
TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompareFP< ::OTest2::EqualFP >");
 
template<typename A_, typename B_>
bool testAssertNotEqual(
    A_ a_,
    B_ b_) TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompare< ::OTest2::NotEqual >");
 
template<typename A_, typename B_, typename P_ = long double>
bool testAssertNotEqualFP(
    A_ a_,
    B_ b_,
    P_ precision_ = DEFAULT_FLOAT_PRECISION)
TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompareFP< ::OTest2::NotEqualFP >");
 
template<typename A_, typename B_>
bool testAssertLess(
    A_ a_,
    B_ b_) TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompare< ::OTest2::Less >");
 
template<typename A_, typename B_>
bool testAssertLessOrEqual(
    A_ a_,
    B_ b_) TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompare< ::OTest2::LessOrEqual >");
 
template<typename A_, typename B_>
bool testAssertGreater(
    A_ a_,
    B_ b_) TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompare< ::OTest2::Greater >");
 
template<typename A_, typename B_>
bool testAssertGreaterOrEqual(
    A_ a_,
    B_ b_) TEST_ASSERTION_MARK_TMPL("::OTest2::GenericAssertion", "testAssertCompare< ::OTest2::GreaterOrEqual >");
 
} /* -- namespace Assertions */
 
} /* -- namespace OTest2 */
 
#endif /* OTest2__INCLUDE_OTEST2_ASSERTIONS_H_ */