test.h

//     https://github.com/ccgargantua/arena-allocator/blob/main/test.h
// 
//     Tests are contained in testing suite functions, the forware declarations
//     of which are bundled together. A testing suite function should exist for
//     each function within `arena.h`, and should be placed relative to where
//     the function they are testing is placed in regard to the functions around
//     it for both forward declarations, implementations, and `SUITE`s.
//
//     After implementing a testing suite, you should use the `SUITE` in
//     `main()`.
//
//     Within the testing suite, the following macros should be used:
//
//
//     TEST_EQUAL(a, b)          | TEST_EQUAL will fail when a != b
//
//     TEST_NULL(a)              | TEST_NULL will fail when a != NULL
//
//     TEST_NOT_NULL(a)          | TEST_NOT_NULL will fail when a == NULL
//
//     TEST_ARRAY_EQUAL(a, b, s) | TEST_ARRAY_EQUAL will fail if any elements differ

#ifndef TEST_H
#define TEST_H


#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stddef.h>


int passed_tests = 0;
int total_tests = 0;
int temp_passed;
int temp_total;


constexpr int BUFFER_SIZE = 4096;
char buffer[BUFFER_SIZE];
int buffer_index = 0;


#define REPORT(msg)                                                      \
    buffer_index += snprintf(buffer + buffer_index,                      \
                             (unsigned int)(BUFFER_SIZE - buffer_index), \
                             "  FAILURE: '%s' at %s:%d\n",               \
                             msg, __FILE__, __LINE__)


#define TEST(exp, msg)      \
    do                      \
    {                       \
        if (!(exp))         \
        {                   \
            REPORT(msg);    \
        }                   \
        else                \
        {                   \
            passed_tests++; \
        }                   \
        total_tests++;      \
    }while (0)


#define TEST_NULL(a)                TEST(a == NULL,         #a " is not NULL")
#define TEST_NOT_NULL(a)            TEST(a != NULL,         #a " is NULL")
#define TEST_EQUAL(a, b)            TEST(a == b,            #a " does not equal " #b)
#define TEST_TRUE(a)                TEST(a,                 #a " is not true")
#define TEST_FALSE(a)               TEST(!a,                #a " is not true")


#define TEST_ARRAY_EQUAL(a, b, s)                 \
    do                                            \
    {                                             \
        int i;                                    \
        total_tests++;                            \
        for (i = 0; i < s; i++)                   \
        {                                         \
            if (a[i] != b[i])                     \
            {                                     \
                REPORT(#a " does not equal " #b); \
                break;                            \
            }                                     \
        }                                         \
        passed_tests++;                           \
    }while (0)


#define SUITE(suite)                                                                                               \
    do                                                                                                             \
    {                                                                                                              \
        temp_passed = passed_tests;                                                                                \
        temp_total = total_tests;                                                                                  \
        suite();                                                                                                   \
        fprintf(stderr, "Passed %d/%d tests in '%s'\n", passed_tests-temp_passed, total_tests-temp_total, #suite); \
        fprintf(stderr, "%s", buffer);                                                                             \
        buffer_index = 0;                                                                                          \
        buffer[0] = '\0';                                                                                          \
    } while(0)


#define WRAP_UP() fprintf(stderr, "\nFinished. Passed %d/%d tests.\n", passed_tests, total_tests);


#endif