test.h

/*
 * Copyright (c) 2008, Brian Koropoff
 * 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 Moonunit project 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 BRIAN KOROPOFF ``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 BRIAN KOROPOFF 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 __MU_TEST_H__
#define __MU_TEST_H__

#include <moonunit/internal/boilerplate.h>
#include <moonunit/type.h>

/* @{ */

C_BEGIN_DECLS

/* Forward declarations */
struct MuTestToken;
struct MuTest;
struct MuLoader;
struct MuLibrary;

typedef enum MuTestStatus
{
    MU_STATUS_SUCCESS = 0,
    MU_STATUS_FAILURE,
    MU_STATUS_ASSERTION,
    MU_STATUS_CRASH,
    MU_STATUS_TIMEOUT,
    MU_STATUS_EXCEPTION,
    MU_STATUS_RESOURCE,
    MU_STATUS_SKIPPED
} MuTestStatus;

typedef enum MuTestStage
{
    MU_STAGE_LIBRARY_SETUP,
    MU_STAGE_FIXTURE_SETUP,
    MU_STAGE_TEST,
    MU_STAGE_FIXTURE_TEARDOWN,
    MU_STAGE_LIBRARY_TEARDOWN,
    MU_STAGE_UNKNOWN
} MuTestStage;

#ifndef DOXYGEN
typedef struct MuBacktrace
{
    unsigned long return_addr;
    unsigned long func_addr;
    const char* file_name;
    const char* func_name;
    struct MuBacktrace* up;
    /* Reserved */
    void* reserved1;
    void* reserved2;
} MuBacktrace;

typedef struct MuTestResult
{
    MuTestStatus status;
    MuTestStatus expected;
    MuTestStage stage;
    const char* reason;
    const char* file;
    unsigned int line;
    MuBacktrace* backtrace;
    /* Reserved */
    void* reserved1;
    void* reserved2;
} MuTestResult;
#endif

typedef enum
{
    MU_LEVEL_WARNING,
    MU_LEVEL_INFO,
    MU_LEVEL_VERBOSE,
    MU_LEVEL_DEBUG,
    MU_LEVEL_TRACE
} MuLogLevel;

#ifndef DOXYGEN

typedef struct MuLogEvent
{
    MuTestStage stage;
    const char* file;
    unsigned int line;
    MuLogLevel level;
    const char* message;
    /* Reserved */
    void* reserved1;
    void* reserved2;
} MuLogEvent;

typedef struct MuTest
{
    struct MuLoader* loader;
    struct MuLibrary* library;
} MuTest;

typedef void (*MuThunk) (void);

const char* mu_test_status_to_string(MuTestStatus status);
const char* mu_test_stage_to_string(MuTestStage stage);
const char* mu_test_name(MuTest* test);
const char* mu_test_suite(MuTest* test);

#endif

C_END_DECLS

/* @} */

#endif