TestMockFailure.h

/*
 * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef D_TestMockFailure_h
#define D_TestMockFailure_h

#define CHECK_EXPECTED_MOCK_FAILURE(expectedFailure) CHECK_EXPECTED_MOCK_FAILURE_LOCATION(expectedFailure, __FILE__, __LINE__)
#define CHECK_NO_MOCK_FAILURE() CHECK_NO_MOCK_FAILURE_LOCATION(__FILE__, __LINE__)


class MockFailureReporterForTest : public MockFailureReporter
{
public:

    SimpleString mockFailureString;
    int amountOfFailures;

    MockFailureReporterForTest() : amountOfFailures(0) {}

    virtual void failTest(const MockFailure& failure)
    {
        amountOfFailures++;
        mockFailureString = failure.getMessage();
    }

    virtual int getAmountOfTestFailures()
    {
        return amountOfFailures;
    }

    static MockFailureReporterForTest* getReporter()
    {
        static MockFailureReporterForTest reporter;
        return &reporter;
    }
};

inline UtestShell* mockFailureTest()
{
    return MockFailureReporterForTest::getReporter()->getTestToFail();
}

inline SimpleString mockFailureString()
{
    return MockFailureReporterForTest::getReporter()->mockFailureString;
}

inline void CLEAR_MOCK_FAILURE()
{
    MockFailureReporterForTest::getReporter()->mockFailureString = "";
    MockFailureReporterForTest::getReporter()->amountOfFailures = 0;
}

inline void CHECK_EXPECTED_MOCK_FAILURE_LOCATION(const MockFailure& expectedFailure, const char* file, int line)
{
    SimpleString expectedFailureString = expectedFailure.getMessage();
    SimpleString actualFailureString = mockFailureString();
    CLEAR_MOCK_FAILURE();
    if (expectedFailureString != actualFailureString)
    {
        SimpleString error = "MockFailures are different.\n";
        error += "Expected MockFailure:\n\t";
        error += expectedFailureString;
        error += "\nActual MockFailure:\n\t";
        error += actualFailureString;
        FAIL_LOCATION(error.asCharString(), file, line);
    }
}

inline void CHECK_NO_MOCK_FAILURE_LOCATION(const char* file, int line)
{
    if (mockFailureString() != "") {
        SimpleString error = "Unexpected mock failure:\n";
        error += mockFailureString();
        CLEAR_MOCK_FAILURE();
        FAIL_LOCATION(error.asCharString(), file, line);

    }
    CLEAR_MOCK_FAILURE();
}

#endif