testfw.h

/*
------------------------------------------------------------------------------
		  Licensing information can be found at the end of the file.
------------------------------------------------------------------------------

testfw.h - v1.0 - Basic test framwework for C/C++.

Do this:
	#define TESTFW_IMPLEMENTATION
before you include this file in *one* C/C++ file to create the implementation.
*/

#ifndef testfw_h
#define testfw_h

#define TESTFW_INIT() testfw_init()
#define TESTFW_SUMMARY() testfw_summary( __FILE__, __func__, __LINE__ )
#define TESTFW_TEST_BEGIN( desc ) testfw_test_begin( desc, __FILE__, __func__, __LINE__ );
#define TESTFW_TEST_END() testfw_test_end( __FILE__, __func__, __LINE__ )
#define TESTFW_EXPECTED( expression ) testfw_expected( (expression) ? 1 : 0, #expression, __FILE__, __func__, __LINE__ )


void testfw_init();
void testfw_summary( char const* filename, char const* funcname, int line );
void testfw_test_begin( char const* desc, char const* filename, char const* funcname, int line );
void testfw_test_end( char const* filename, char const* funcname, int line );
void testfw_expected( int expression, char const* expression_str, char const* filename, char const* funcname, int line );
void testfw_print_test_desc();
void testfw_print_failure( char const* filename, int line );
void testfw_assertion_count_inc();
void testfw_current_test_assertion_failed();


#endif /* testfw_h */



#ifdef TESTFW_IMPLEMENTATION
#undef TESTFW_IMPLEMENTATION

#define _CRT_NONSTDC_NO_DEPRECATE 
#define _CRT_SECURE_NO_WARNINGS
#include <string.h>

#ifdef _WIN32
    #pragma warning( push ) 
    #pragma warning( disable: 4619 ) // pragma warning : there is no warning number 'number'
    #pragma warning( disable: 4668 ) // 'symbol' is not defined as a preprocessor macro, replacing with '0' 
    #include <crtdbg.h>
    #pragma warning( pop ) 
#endif /* _WIN32 */

#ifndef TESTFW_PRINTF
    #define _CRT_NONSTDC_NO_DEPRECATE 
    #define _CRT_SECURE_NO_WARNINGS
    #include <stdio.h>

    #define TESTFW_PRINTF printf
#endif

#ifdef TESTFW_NO_ANSI
    #define TESTFW_ANSI_BLACK ""
    #define TESTFW_ANSI_BLUE ""
    #define TESTFW_ANSI_GREEN ""
    #define TESTFW_ANSI_CYAN ""
    #define TESTFW_ANSI_RED ""
    #define TESTFW_ANSI_MAGENTA ""
    #define TESTFW_ANSI_BROWN ""
    #define TESTFW_ANSI_LIGHT_GREY ""
    #define TESTFW_ANSI_GREY ""
    #define TESTFW_ANSI_LIGHT_BLUE ""
    #define TESTFW_ANSI_LIGHT_GREEN ""
    #define TESTFW_ANSI_LIGHT_CYAN ""
    #define TESTFW_ANSI_LIGHT_RED ""
    #define TESTFW_ANSI_LIGHT_MAGENTA ""
    #define TESTFW_ANSI_YELLOW ""
    #define TESTFW_ANSI_WHITE ""
    #define TESTFW_ANSI_RESET ""
#else
    #ifndef TESTFW_ANSI_BLACK
        #define TESTFW_ANSI_BLACK "\x1b[30m"
    #endif
    #ifndef TESTFW_ANSI_BLUE
        #define TESTFW_ANSI_BLUE "\x1b[34m"
    #endif
    #ifndef TESTFW_ANSI_GREEN
        #define TESTFW_ANSI_GREEN "\x1b[32m"
    #endif
    #ifndef TESTFW_ANSI_CYAN
        #define TESTFW_ANSI_CYAN "\x1b[36m"
    #endif
    #ifndef TESTFW_ANSI_RED
        #define TESTFW_ANSI_RED "\x1b[31m"
    #endif
    #ifndef TESTFW_ANSI_MAGENTA
        #define TESTFW_ANSI_MAGENTA "\x1b[35m"
    #endif
    #ifndef TESTFW_ANSI_BROWN
        #define TESTFW_ANSI_BROWN "\x1b[33m"
    #endif
    #ifndef TESTFW_ANSI_LIGHT_GREY
        #define TESTFW_ANSI_LIGHT_GREY "\x1b[37m"
    #endif
    #ifndef TESTFW_ANSI_GREY
        #define TESTFW_ANSI_GREY "\x1b[30;1m"
    #endif
    #ifndef TESTFW_ANSI_LIGHT_BLUE
        #define TESTFW_ANSI_LIGHT_BLUE "\x1b[34;1m"
    #endif
    #ifndef TESTFW_ANSI_LIGHT_GREEN
        #define TESTFW_ANSI_LIGHT_GREEN "\x1b[32;1m"
    #endif
    #ifndef TESTFW_ANSI_LIGHT_CYAN
        #define TESTFW_ANSI_LIGHT_CYAN "\x1b[36;1m"
    #endif
    #ifndef TESTFW_ANSI_LIGHT_RED
        #define TESTFW_ANSI_LIGHT_RED "\x1b[31;1m"
    #endif
    #ifndef TESTFW_ANSI_LIGHT_MAGENTA
        #define TESTFW_ANSI_LIGHT_MAGENTA "\x1b[35;1m"
    #endif
    #ifndef TESTFW_ANSI_YELLOW
        #define TESTFW_ANSI_YELLOW "\x1b[33;1m"
    #endif
    #ifndef TESTFW_ANSI_WHITE
        #define TESTFW_ANSI_WHITE "\x1b[37;1m"
    #endif
    #ifndef TESTFW_ANSI_RESET
        #define TESTFW_ANSI_RESET "\x1b[0m"
    #endif
#endif


struct testfw_internal_current_test_state_t
    {
    int is_active;
    char const* file;
    char const* func;
    int line;
    char const* desc;
    int desc_printed;
    int counted_as_failed;
    };


static struct 
    {
    int tests_total;
    int tests_failed;
    int assertions_total;
    int assertions_failed;
    testfw_internal_current_test_state_t current_test;
    } testfw_internal_state = {};


static void testfw_internal_print_progress_divider( char ch, int fail, int total )
    {
    int width = 79;
    int first = (int)( ( width * fail ) / total );
    int second = width - first;
    if( fail > 0 && first == 0 )
        {
        ++first;
        --second;
        }
    TESTFW_PRINTF( "%s", TESTFW_ANSI_LIGHT_RED );
    for( int i = 0; i < first; ++i ) TESTFW_PRINTF( "%c", ch );
    TESTFW_PRINTF( "%s", TESTFW_ANSI_LIGHT_GREEN );
    for( int i = 0; i < second; ++i ) TESTFW_PRINTF( "%c", ch );
    TESTFW_PRINTF( "%s", TESTFW_ANSI_RESET );
    TESTFW_PRINTF( "\n" );
    }


#if defined( _WIN32 ) && defined( _DEBUG )

    static int testfw_internal_debug_report_hook( int report_type, char* message, int* return_value ) 
        { 
        static int total_leaks = 0;

        *return_value = 0; // Don't break to debugger

        if( stricmp( message, "Detected memory leaks!\n" ) == 0 )
            {
            TESTFW_PRINTF( "-------------------------------------------------------------------------------\n" );
            TESTFW_PRINTF( "%sMEMORY CHECKS FAILED:%s Detected memory leaks\n", TESTFW_ANSI_LIGHT_RED, 
                TESTFW_ANSI_RESET );
            return 1; // Tell CRT not to print the message
            }
        else if( stricmp( message, "Dumping objects ->\n" ) == 0 )
            {
            TESTFW_PRINTF( "-------------------------------------------------------------------------------\n" );
            TESTFW_PRINTF( "\n" );
            return 1; // Tell CRT not to print the message
            }
        else if( stricmp( message, "Object dump complete.\n" ) == 0 )
            {
            TESTFW_PRINTF( "\n" );
            _CrtMemState state;
            _CrtMemCheckpoint( &state );

            static char const* const block_use_names[ 5 ] = { "Free", "Normal", "CRT", "Ignore", "Client", };
            for( unsigned int i = 0; i < 5; ++i )
                {
                if( i != 2 && state.lCounts[ i ] )
                    TESTFW_PRINTF( "%Id bytes in %Id %hs Blocks.\n", (long long) state.lSizes[ i ], 
                        (long long) state.lCounts[ i ], block_use_names[ i ] );
                }

            TESTFW_PRINTF( "\n" );
            TESTFW_PRINTF( "High water mark: %Id bytes.\n", (long long)state.lHighWaterCount);
            TESTFW_PRINTF( "All allocations: %Id bytes.\n",   (long long)state.lTotalCount);
            TESTFW_PRINTF( "\n" );
            TESTFW_PRINTF( "===============================================================================\n" );
            TESTFW_PRINTF( "%sMEMORY LEAKS: %d%s\n\n", TESTFW_ANSI_LIGHT_RED, total_leaks, TESTFW_ANSI_RESET );
            return 1; // Tell CRT not to print the message
            }
        else if( strnicmp( message, " Data: <", 8 ) == 0 )
            {
            ++total_leaks;
            return 1; // Tell CRT not to print the message
            }
    
        return 0;  // Tell CRT it can print the message, as we didn't handle it
        }

#endif /* _WIN32 && _DEBUG */


void testfw_init()
    {
    memset( &testfw_internal_state, 0, sizeof( testfw_internal_state ) );

    #ifdef _WIN32
        int flag = _CrtSetDbgFlag( _CRTDBG_REPORT_FLAG ); // Get current flag
        flag ^= _CRTDBG_LEAK_CHECK_DF; // Turn on leak-checking bit
        _CrtSetDbgFlag( flag ); // Set flag to the new value
        _CrtSetReportMode( _CRT_WARN, _CRTDBG_MODE_FILE );
        _CrtSetReportFile( _CRT_WARN, _CRTDBG_FILE_STDOUT );
        _CrtSetReportHook2( _CRT_RPTHOOK_INSTALL, testfw_internal_debug_report_hook );
    #endif /* _WIN32 */
    }


static int testfw_internal_must_be_in_test()
    {
    if( !testfw_internal_state.current_test.is_active )
        TESTFW_PRINTF( "\n\n%sEXPECTED TO BE IN AN ACTIVE TEST, BUT NO TEST IS CURRENTLY ACTIVE.%s\n\n", 
            TESTFW_ANSI_LIGHT_RED, TESTFW_ANSI_RESET );
    return !testfw_internal_state.current_test.is_active;
    }


static int testfw_internal_can_not_be_in_test()
    {
    if( testfw_internal_state.current_test.is_active )
        TESTFW_PRINTF( "\n\n%sEXPECTED TO NOT BE IN AN ACTIVE TEST, BUT A TEST IS CURRENTLY ACTIVE.%s\n\n", 
            TESTFW_ANSI_LIGHT_RED, TESTFW_ANSI_RESET );
    return testfw_internal_state.current_test.is_active;
    }


void testfw_print_test_desc()
    {
    if( testfw_internal_must_be_in_test() ) return;

    if( !testfw_internal_state.current_test.desc_printed ) 
        {
        testfw_internal_state.current_test.desc_printed = 1;
        
        TESTFW_PRINTF( "\n" );
        TESTFW_PRINTF( "-------------------------------------------------------------------------------\n" );
        TESTFW_PRINTF( "%s\n", testfw_internal_state.current_test.desc ? testfw_internal_state.current_test.desc : 
            "<NO DESCRIPTION>" ); 
        TESTFW_PRINTF( "-------------------------------------------------------------------------------\n" );
        TESTFW_PRINTF( "%s%s(%d): %s%s\n", TESTFW_ANSI_GREY, testfw_internal_state.current_test.file, 
            testfw_internal_state.current_test.line, TESTFW_ANSI_RESET, testfw_internal_state.current_test.func );
        
        TESTFW_PRINTF( "%s", TESTFW_ANSI_GREY );
        TESTFW_PRINTF( "...............................................................................\n" );
        TESTFW_PRINTF( "%s", TESTFW_ANSI_RESET );
        } 
    }


void testfw_summary( char const* filename, char const* funcname, int line )
    {
    if( testfw_internal_can_not_be_in_test() ) return;

    TESTFW_PRINTF( "\n" );
    testfw_internal_print_progress_divider( '=', testfw_internal_state.tests_failed, testfw_internal_state.tests_total );   
    if( testfw_internal_state.tests_failed == 0 && testfw_internal_state.assertions_failed == 0 )
        {
        TESTFW_PRINTF( "%sAll tests passed%s (%d assertions in %d test cases)\n", TESTFW_ANSI_LIGHT_GREEN, 
            TESTFW_ANSI_RESET, testfw_internal_state.assertions_total, testfw_internal_state.tests_total );
        }
    else
        {
        TESTFW_PRINTF( "test cases: %4d |%s %4d passed %s|%s %4d failed%s\n", testfw_internal_state.tests_total,
            TESTFW_ANSI_LIGHT_GREEN, testfw_internal_state.tests_total - testfw_internal_state.tests_failed, 
            TESTFW_ANSI_RESET, TESTFW_ANSI_LIGHT_RED, testfw_internal_state.tests_failed, TESTFW_ANSI_RESET );
        TESTFW_PRINTF( "assertions: %4d |%s %4d passed %s|%s %4d failed%s\n", testfw_internal_state.assertions_total, 
            TESTFW_ANSI_LIGHT_GREEN, testfw_internal_state.assertions_total - testfw_internal_state.assertions_failed, 
            TESTFW_ANSI_RESET, TESTFW_ANSI_LIGHT_RED, testfw_internal_state.assertions_failed, TESTFW_ANSI_RESET );
        }

    TESTFW_PRINTF( "\n\n" );
    }


void testfw_test_begin( char const* desc, char const* filename, char const* funcname, int line )
    {
    if( testfw_internal_can_not_be_in_test() ) return;

    memset( &testfw_internal_state.current_test, 0, sizeof( testfw_internal_state.current_test ) );    
    testfw_internal_state.current_test.is_active = 1;
    testfw_internal_state.current_test.file = filename;
    testfw_internal_state.current_test.func = funcname;
    testfw_internal_state.current_test.line = line;
    testfw_internal_state.current_test.desc = desc;
    testfw_internal_state.current_test.desc_printed = 0;
    testfw_internal_state.current_test.counted_as_failed = 0;

    ++testfw_internal_state.tests_total;
    }


void testfw_test_end( char const* filename, char const* funcname, int line )
    {
    if( testfw_internal_must_be_in_test() ) return;

    memset( &testfw_internal_state.current_test, 0, sizeof( testfw_internal_state.current_test ) );    
    }


void testfw_current_test_assertion_failed()
    {
    if( testfw_internal_must_be_in_test() ) return;

    ++testfw_internal_state.assertions_failed;

    if( !testfw_internal_state.current_test.counted_as_failed ) 
        {
        testfw_internal_state.current_test.counted_as_failed = 1;
        ++testfw_internal_state.tests_failed;
        }
    }


void testfw_assertion_count_inc()
    {
    if( testfw_internal_must_be_in_test() ) return;

    ++testfw_internal_state.assertions_total;
    }


void testfw_print_failure( char const* filename, int line )
    {
    TESTFW_PRINTF( "\n%s%s(%d): %sFAILED:%s\n", TESTFW_ANSI_GREY, filename, line, TESTFW_ANSI_LIGHT_RED, 
        TESTFW_ANSI_RESET );
    }


void testfw_expected( int expression, char const* expression_str, char const* filename, 
    char const* funcname, int line )
    {
    if( testfw_internal_must_be_in_test() ) return;

    testfw_assertion_count_inc();

    if( !expression ) 
        { 
        testfw_current_test_assertion_failed();
        testfw_print_test_desc();
        testfw_print_failure( filename, line );
        TESTFW_PRINTF( "\n  %sTESTFW_EXPECTED( %s%s%s )%s\n", TESTFW_ANSI_CYAN, TESTFW_ANSI_WHITE, expression_str, 
            TESTFW_ANSI_CYAN, TESTFW_ANSI_RESET );
        }
    }

#endif /* TESTFW_IMPLEMENTATION */

/*
------------------------------------------------------------------------------

This software is available under 2 licenses - you may choose the one you like.

------------------------------------------------------------------------------

ALTERNATIVE A - MIT License

Copyright (c) 2019 Mattias Gustavsson

Permission is hereby granted, free of charge, to any person obtaining a copy of 
this software and associated documentation files (the "Software"), to deal in 
the Software without restriction, including without limitation the rights to 
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
of the Software, and to permit persons to whom the Software is furnished to do 
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
SOFTWARE.

------------------------------------------------------------------------------

ALTERNATIVE B - Public Domain (www.unlicense.org)

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this 
software, either in source code form or as a compiled binary, for any purpose, 
commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this 
software dedicate any and all copyright interest in the software to the public 
domain. We make this dedication for the benefit of the public at large and to 
the detriment of our heirs and successors. We intend this dedication to be an 
overt act of relinquishment in perpetuity of all present and future rights to 
this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

------------------------------------------------------------------------------
*/