ci2/tests/04_ci2_assert.c

/* - | Copyright | ------------------------------------------------------------
   Copyright (c) 2026 Randy Jordan

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.

 * --------------------------------------------------------------------------*/
#define DEBUG
#include "../include/ci2.h"

#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>    /* bool, true, false             — C99 */
#include <string.h>     /* strcmp                        — C standard */
static void test_assert_passing(void){
    /* Basic truthy values */
    CI2_ASSERT(1);
    CI2_ASSERT(1 == 1);

    /* Pointer non-null */
    const char *str = "hello";
    CI2_ASSERT(str != NULL);

    /* Arithmetic */
    int x = 42;
    CI2_ASSERT(x > 0);
    CI2_ASSERT(x * 2 == 84);

    /* CI2_ASSERT_MSG variants */
    CI2_ASSERT_MSG(x == 42, "x must be 42");
    CI2_ASSERT_MSG(sizeof(int) == 4, "int must be 4 bytes on this platform");

    /* Boolean */
    bool flag = true;
    CI2_ASSERT(flag);
}


static void test_assert_failing(void){
    printf("  Triggering CI2_ASSERT(0) failure now...\n");
    fflush(stdout);
    CI2_ASSERT(0);                          /* <-- should break/trap here */
    /* Should never reach here */
    printf("  [FAIL] Execution continued past a failing CI2_ASSERT!\n");
}

static void test_assert_msg_failing(void){
    printf("CI2_ASSERT_MSG — Deliberate Failure (triggering a debug break...)\n");
    fflush(stdout);

    CI2_ASSERT_MSG(0, "This failure is intentional — testing the message path");

    printf("  [FAIL] Execution continued past a failing CI2_ASSERT_MSG!\n");
}

static void test_ndebug_status(void){
    printf("NDEBUG / Release Mode");

#ifdef NDEBUG
    printf("  NDEBUG is DEFINED  — asserts are compiled out.\n");
    CI2_ASSERT(0);   /* harmless in release */
    printf("  Confirmed: CI2_ASSERT(0) was a no-op.\n");
#else
    printf("  NDEBUG is NOT defined — asserts are active (debug build).\n");
#endif
}

int main(int argc, char *argv[]){
    (void) argc;
    (void) argv;
/* Determine whether the user wants to trigger a deliberate failure */
    bool run_fail     = false;
    bool run_fail_msg = false;

    for (int i = 1; i < argc; i++) {
        if (strcmp(argv[i], "--fail")     == 0) run_fail     = true;
        if (strcmp(argv[i], "--fail-msg") == 0) run_fail_msg = true;
    }

    /* --- Run the safe tests --- */
    test_assert_passing();
    test_ndebug_status();

    /* --- Optional deliberate-failure tests --- */
    if (run_fail)     test_assert_failing();
    if (run_fail_msg) test_assert_msg_failing();


    if (!run_fail && !run_fail_msg) {
        printf("Tip: run with --fail or --fail-msg to test the");
        printf("  debug-break path (attach a debugger first).\n");
    }
    return EXIT_SUCCESS;
}