test.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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 UCX_TEST_H
#define UCX_TEST_H
 
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <setjmp.h>
 
#ifndef __FUNCTION__
#define __FUNCTION__ __func__
#endif
 
#if !defined(__clang__) && __GNUC__ > 3
#pragma GCC diagnostic ignored "-Wclobbered"
#endif

typedef struct CxTestSuite CxTestSuite;

typedef size_t (*cx_test_output_func)(const void*, size_t, size_t, void*);

typedef void(*CxTest)(CxTestSuite *, void *, cx_test_output_func);

typedef struct CxTestSet CxTestSet;

struct CxTestSet {
    
    CxTest test;
    
    CxTestSet *next;
};

struct CxTestSuite {
    
    unsigned int success;
    
    unsigned int failure;

    const char *name;
    
    CxTestSet *tests;
};

static inline CxTestSuite* cx_test_suite_new(const char *name) {
    CxTestSuite* suite = (CxTestSuite*) malloc(sizeof(CxTestSuite));
    if (suite != NULL) {
        suite->name = name;
        suite->success = 0;
        suite->failure = 0;
        suite->tests = NULL;
    }
 
    return suite;
}

static inline void cx_test_suite_free(CxTestSuite* suite) {
    if (suite == NULL) return;
    CxTestSet *l = suite->tests;
    while (l != NULL) {
        CxTestSet *e = l;
        l = l->next;
        free(e);
    }
    free(suite);
}

static inline int cx_test_register(CxTestSuite* suite, CxTest test) {
    CxTestSet *t = (CxTestSet*) malloc(sizeof(CxTestSet));
    if (t) {
        t->test = test;
        t->next = NULL;
        if (suite->tests == NULL) {
            suite->tests = t;
        } else {
            CxTestSet *last = suite->tests;
            while (last->next) {
                last = last->next;
            }
            last->next = t;
        }
        return 0;
    } else {
        return 1;
    }
}

static inline void cx_test_run(CxTestSuite *suite, void *out_target,
        cx_test_output_func out_writer) {
    if (suite->name == NULL) {
        out_writer("*** Test Suite ***\n", 1, 19, out_target);
    } else {
        out_writer("*** Test Suite : ", 1, 17, out_target);
        out_writer(suite->name, 1, strlen(suite->name), out_target);
        out_writer(" ***\n", 1, 5, out_target);
    }
    suite->success = 0;
    suite->failure = 0;
    for (CxTestSet *elem = suite->tests; elem; elem = elem->next) {
        elem->test(suite, out_target, out_writer);
    }
    out_writer("\nAll test completed.\n", 1, 21, out_target);
    char total[80];
    int len = snprintf(
            total, 80,
            "  Tests:   %5u\n  Success: %5u\n  Failure: %5u\n\n",
            suite->success + suite->failure, suite->success, suite->failure
    );
    out_writer(total, 1, len, out_target);
}

#define cx_test_run_f(suite, file) cx_test_run(suite, (void*)file, \
        (cx_test_output_func) fwrite)

#define cx_test_run_stdout(suite) cx_test_run_f(suite, stdout)

#define CX_TEST(name) void name(CxTestSuite* _suite_,void *_output_, \
        cx_test_output_func _writefnc_)

#define CX_TEST_DO _writefnc_("Running ", 1, 8, _output_);\
        _writefnc_(__FUNCTION__, 1, strlen(__FUNCTION__), _output_);\
        _writefnc_("... ", 1, 4, _output_);\
        jmp_buf _env_;\
        for (unsigned int _cx_test_loop_ = 0 ;\
             _cx_test_loop_ == 0 && !setjmp(_env_);\
             _writefnc_("success.\n", 1, 9, _output_),\
             _suite_->success++, _cx_test_loop_++)

#define CX_TEST_ASSERTM(condition,message) if (!(condition)) { \
        const char *_assert_msg_ = message; \
        _writefnc_(_assert_msg_, 1, strlen(_assert_msg_), _output_); \
        _writefnc_(".\n", 1, 2, _output_); \
        _suite_->failure++; \
        longjmp(_env_, 1);\
    } (void) 0

#define CX_TEST_ASSERT(condition) \
        CX_TEST_ASSERTM(condition, #condition " failed")

#define CX_TEST_SUBROUTINE(name,...) void name(CxTestSuite* _suite_,\
        void *_output_, cx_test_output_func _writefnc_, \
        jmp_buf _env_, __VA_ARGS__)

#define CX_TEST_CALL_SUBROUTINE(name,...) \
        name(_suite_,_output_,_writefnc_,_env_,__VA_ARGS__)
 
#endif  /* UCX_TEST_H */