test-boiler-plate.h

#include "FakeAvr/interrupt.h"
#include <unity.h>
#include <Mock.h>
#include "StatusCodes.h" // Python-to-Firmware communication status codes
#include "HardwareFake.h" // Fake hardware (registers, pins)
/* =====[ Test Helpers ]===== */
static void _SilentAssertCall(uint16_t num, char const * name)
{
    // Put num and name in the message displayed if test fails
    GString *message = g_string_new(NULL);
    g_string_append_printf(message, "`%s` is not call %d", name, num);
    // Perform the test
    TEST_ASSERT_TRUE_MESSAGE(
        SilentAssertCall(mock, num, name),
        message->str
        );
    // Free memory used by GString
    g_string_free(message, true);
}
static void _AssertCall(uint16_t num, char const * name)
{
    // Put num and name in the message displayed if test fails
    GString *message = g_string_new(NULL);
    g_string_append_printf(message, "`%s` is not call %d", name, num);
    // Perform the test
    TEST_ASSERT_TRUE_MESSAGE(
        AssertCall(mock, num, name),
        message->str
        );
    // Free memory used by GString
    g_string_free(message, true);
}
static void _AssertArg(uint16_t call_n, uint8_t arg_n, void *pval)
{
 
    GString *msg = g_string_new(NULL);
    g_string_printf(msg, "Expect different value for call %d arg %d.", call_n, arg_n);
    // I cannot print the expected value without asking the
    // caller to include the type as a string. Better to keep the
    // arg list short. Call and arg number are good enough.
    TEST_ASSERT_TRUE_MESSAGE(
        AssertArg(mock, call_n, arg_n, pval),
        msg->str
        );
    g_string_free(msg, true);
}
static void _AssertArgByteVal(uint16_t call_n, uint8_t arg_n, uint8_t byte_val) { _AssertArg(call_n, arg_n, &byte_val); }
static void _test_call_count_is(uint16_t num)
{
    // Print this message if test fails
    // Note: msg is appended if I use a TEST_ASSERT_EQUAL macro,
    // so use TEST_FAIL_MESSAGE macro instead.
    GString *msg = g_string_new(NULL);
    g_string_printf(msg,
        "Expect call count is %d, but was %d.",
        num, NumberOfActualCalls(mock)
        );
    // Run test
    if (num == NumberOfActualCalls(mock)) TEST_PASS();
    else TEST_FAIL_MESSAGE(msg->str);
    // Free string-object memory
    g_string_free(msg, true);
}