Asserter.h

Go to the documentation of this file.

/*
 * Robot Testing Framework
 *
 * Copyright (C) 2015-2019 Istituto Italiano di Tecnologia (IIT)
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */


#ifndef ROBOTTESTINGFRAMEWORK_ASSERTER_H
#define ROBOTTESTINGFRAMEWORK_ASSERTER_H

#include <robottestingframework/Exception.h>
#include <robottestingframework/TestCase.h>
#include <robottestingframework/TestMessage.h>
#include <robottestingframework/TestSuite.h>

#if defined _MSC_VER && _MSC_VER <= 1800 //Visual Studio 12 or earlier has not [[noreturn]]
#    define ROBOTTESTINGFRAMEWORK_NORETURN __declspec(noreturn)
#else
#    define ROBOTTESTINGFRAMEWORK_NORETURN [[noreturn]]
#endif


namespace robottestingframework {

class Asserter
{
public:
    ROBOTTESTINGFRAMEWORK_NORETURN static void fail(TestMessage msg);

    static void fail(bool condition,
                     TestMessage msg);

    ROBOTTESTINGFRAMEWORK_NORETURN static void error(TestMessage msg);

    static void error(bool condition,
                      TestMessage msg);

    static void report(TestMessage msg,
                       TestSuite* testsuite);

    static void report(TestMessage msg,
                       TestCase* testcase);

    static void testFail(bool condition,
                         TestMessage msg,
                         TestCase* testcase);

    static void testCheck(bool condition,
                          TestMessage msg,
                          TestCase* testcase);

    static std::string format(const char* msg, ...);
};

} // namespace robottestingframework

#endif // ROBOTTESTINGFRAMEWORK_ASSERTER_H