stktest_context.h

Go to the documentation of this file.

/*
 * SuperTinyKernel(TM) RTOS: Lightweight High-Performance Deterministic C++ RTOS for Embedded Systems.
 *
 * Source: https://github.com/SuperTinyKernel-RTOS
 *
 * Copyright (c) 2022-2026 Neutron Code Limited <stk@neutroncode.com>. All Rights Reserved.
 * License: MIT License, see LICENSE for a full text.
 */
 
#ifndef STKTEST_CONTEX_H_
#define STKTEST_CONTEX_H_
 
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <exception>
 
namespace stk {
namespace test {

class TestContext
{
public:
    enum EConsts
    {
        SUCCESS_EXIT_CODE         = 0,
        DEFAULT_FAILURE_EXIT_CODE = 1 
    };
 
    explicit TestContext() : m_expect_assert(false), m_expect_panic(false), m_rethrow_assert(true)
    {}

    void ExpectAssert(bool expect) { m_expect_assert = expect; }

    bool IsExpectingAssert() const { return m_expect_assert; }

    void ExpectPanic(bool expect) { m_expect_panic = expect; }

    bool IsExpectingPanic() const { return m_expect_panic; }

    void RethrowAssertException(bool rethrow) { m_rethrow_assert = rethrow; }

    bool IsRethrowingAssertException() const { return m_rethrow_assert; }

    static inline void ShowTestSuitePrologue()
    {
        // required to show log in Eclipse IDE Console for 64-bit binary
    #if defined(_WIN32) || defined(WIN32)
        setbuf(stdout, NULL);
    #endif
 
        printf("STKTEST-START\n");
    }

    static inline void ShowTestSuiteEpilogue(int32_t result)
    {
        printf("STKTEST-RESULT: %d\n", (int)result);
    }

    static inline void ForceExitTestSuite(int32_t result)
    {
        ShowTestSuiteEpilogue(result);
        exit(result);
    }
 
private:
    static TestContext m_instance; 
    bool m_expect_assert;          
    bool m_expect_panic;           
    bool m_rethrow_assert;         
};

extern TestContext g_TestContext;

#define STK_TEST_CHECK_EQUAL(expected, actual)\
    if ((expected) != (actual)) {\
        printf("STK_TEST_CHECK_EQUAL failed!\n file: %s\n line: %d\n  expected: %d\n  actual: %d\n", __FILE__, __LINE__, (int)expected, (int)actual);\
        __stk_debug_break();\
        exit(1);\
    }

#define STK_TEST_DECL_ASSERT\
    extern void STK_ASSERT_HANDLER(const char *message, const char *file, int32_t line)\
    {\
        printf("_STK_ASSERT failed!\n file: %s\n line: %d\n message: %s\n", file, (int)line, message);\
        __stk_debug_break();\
        abort();\
    }
 
} // namespace test
} // namespace stk
 
#endif /* STKTEST_CONTEX_H_ */