Merge pull request #19 from dreamer-coding/enhance_scanning

Enhance scanning and introspection for assertion info

Author: dreamer-coding

README.md

@@ -1,4 +1,4 @@
-# ***Fossil Test: Unit Testing/Mocking Framework*** - `C/C++`
+# ***Fossil Test: Unit Testing/Mocking Framework*** - `C, C++`
 
 **Overview:**
 Fossil Test is a robust unit testing and mocking framework developed by Fossil Logic, designed to facilitate the creation of high-quality test cases across any C or C++ project. The framework supports both Behavior-Driven Development (BDD) and Test-Driven Development (TDD) styles, providing a flexible and comprehensive solution for ensuring software reliability and correctness.
@@ -40,7 +40,7 @@ Before getting started, make sure you have the following installed:
    # ======================
    [wrap-git]
    url = https://github.com/fossillogic/fossil-test.git
-   revision = v1.0.1
+   revision = v1.0.2
 
    [provide]
    fossil-test = fossil_test_dep

code/include/fossil/unittest/internal.h

@@ -224,6 +224,8 @@ typedef struct {
     bool shoudl_timeout;   /**< Flag indicating whether the test case should timeout (1 for true, 0 for false). */
     bool should_fail;      /**< Flag indicating whether the test case should fail (1 for true, 0 for false). */
     bool has_assert;       /**< Flag indicating if an assertion occurred (1 for true, 0 for false). */
+    bool same_assert;      /**< Flag indicating if the test case is the same (1 for true, 0 for false). */
+    int32_t num_asserts;   /**< Number of assertions that occurred. */
     int32_t line;          /**< Line number where the assertion occurred. */
     char *func;            /**< Function name where the assertion occurred. */
     char *file;            /**< File name where the assertion occurred. */

code/source/unittest/console.c

@@ -17,7 +17,7 @@ Organization: Fossil Logic
 
 static const char* FOSSIL_TEST_NAME = "Fossil Test";
 static const char* FOSSIL_TEST_AUTH = "Michael Gene Brockus (Dreamer)";
-static const char* FOSSIL_TEST_VERSION = "1.0.1";
+static const char* FOSSIL_TEST_VERSION = "1.0.2";
 static const char* FOSSIL_TEST_INFO = "Fossil Test is a next-generation unit testing/mockup framework for C/C++.";
 
 // ==============================================================================
@@ -402,11 +402,17 @@ void fossil_test_io_unittest_then(char *description) {
 
 void fossil_test_io_unittest_step(xassert_info *assume) {
     if (_CLI.verbose_level == 2) {
-        fossil_test_cout("blue", "has assert: ");
+        fossil_test_cout("blue", "has assert  : ");
         fossil_test_cout("cyan", " -> %s\n", assume->has_assert ? COLOR_GREEN "has assertions" COLOR_RESET : COLOR_RED "missing assertions" COLOR_RESET);
+        fossil_test_cout("blue", "asserts used: ");
+        fossil_test_cout("cyan", COLOR_GREEN "%3i\n" COLOR_RESET , assume->num_asserts);
     } else if (_CLI.verbose_level == 1) {
-        fossil_test_cout("blue", "[intro] has_assert: ");
+        fossil_test_cout("blue", "[intro] has_assert : ");
         fossil_test_cout("cyan", "%s\n", assume->has_assert ? COLOR_GREEN "yes" COLOR_RESET : COLOR_RED "no" COLOR_RESET);
+        fossil_test_cout("blue", "[intro] same_assert: ");
+        fossil_test_cout("cyan", "%s\n", assume->same_assert ? COLOR_RED "yes" COLOR_RESET : COLOR_GREEN "no" COLOR_RESET);
+        fossil_test_cout("blue", "[intro] num_asserts: ");
+        fossil_test_cout("cyan", COLOR_GREEN "%3i\n" COLOR_RESET , assume->num_asserts);
     }
 }
 

code/source/unittest/unittest.c

@@ -16,6 +16,21 @@ Organization: Fossil Logic
 #include "fossil/unittest/commands.h"
 #include <stdarg.h>
 
+#define MAX_ASSERT_HISTORY 100
+
+typedef struct {
+    bool expression;
+    xassert_type_t behavior;
+    char* message;
+    char* file;
+    int line;
+    unsigned long fingerprint;
+    char* func;
+} assert_history_t;
+
+static assert_history_t assert_history[MAX_ASSERT_HISTORY];
+static int assert_history_count = 0;
+
 fossil_env_t _TEST_ENV;
 xassert_info _ASSERT_INFO;
 
@@ -391,6 +406,8 @@ void fossil_test_run_testcase(fossil_test_t *test) {
     _ASSERT_INFO.has_assert     = false;
     _ASSERT_INFO.should_fail    = false;
     _ASSERT_INFO.shoudl_timeout = false;
+    _ASSERT_INFO.num_asserts    = 0;
+    _ASSERT_INFO.same_assert    = false;
 
     if (_TEST_ENV.rule.skipped && strcmp(test->marks, "skip") == 0) {
         return;
@@ -707,18 +724,84 @@ void fossil_test_assert_impl_expect(bool expression, xassert_info *assume) {
     }
 } // end of func
 
-void _fossil_test_assert_class(bool expression, xassert_type_t behavor, char* message, char* file, int line, char* func) {
+bool is_assert_in_history(bool expression, xassert_type_t behavior, char* message, char* file, int line, char* func) {
+    for (int i = 0; i < assert_history_count; i++) {
+        if (assert_history[i].expression == expression &&
+            assert_history[i].behavior == behavior &&
+            strcmp(assert_history[i].message, message) == 0 &&
+            strcmp(assert_history[i].file, file) == 0 &&
+            assert_history[i].line == line &&
+            strcmp(assert_history[i].func, func) == 0) {
+            return true;
+        }
+    }
+    return false;
+}
+
+unsigned long generate_fingerprint(bool expression, xassert_type_t behavior, char* message, char* file, int line, char* func) {
+    unsigned long hash = 5381;
+    int c;
+
+    hash = ((hash << 5) + hash) + expression;
+    hash = ((hash << 5) + hash) + behavior;
+
+    while ((c = *message++))
+        hash = ((hash << 5) + hash) + c;
+
+    while ((c = *file++))
+        hash = ((hash << 5) + hash) + c;
+
+    hash = ((hash << 5) + hash) + line;
+
+    while ((c = *func++))
+        hash = ((hash << 5) + hash) + c;
+
+    return hash;
+}
+
+bool is_assert_similar_in_history(unsigned long fingerprint) {
+    for (int i = 0; i < assert_history_count; i++) {
+        if (assert_history[i].fingerprint == fingerprint) {
+            return true;
+        }
+    }
+    return false;
+}
+
+void _fossil_test_assert_class(bool expression, xassert_type_t behavior, char* message, char* file, int line, char* func) {
+    unsigned long fingerprint = generate_fingerprint(expression, behavior, message, file, line, func);
+
+    if (is_assert_similar_in_history(fingerprint)) {
+        // Skip the assertion as a similar one has already been executed
+         _ASSERT_INFO.same_assert = true;
+        return;
+    }
+
     _ASSERT_INFO.func = func;
     _ASSERT_INFO.file = file;
     _ASSERT_INFO.line = line;
     _ASSERT_INFO.message = message;
 
-    if (behavor == TEST_ASSERT_AS_CLASS_ASSUME) {
+    if (behavior == TEST_ASSERT_AS_CLASS_ASSUME) {
         fossil_test_assert_impl_assume(expression, &_ASSERT_INFO);
-    } else if (behavor == TEST_ASSERT_AS_CLASS_ASSERT) {
+    } else if (behavior == TEST_ASSERT_AS_CLASS_ASSERT) {
         fossil_test_assert_impl_assert(expression, &_ASSERT_INFO);
-    } else if (behavor == TEST_ASSERT_AS_CLASS_EXPECT) {
+    } else if (behavior == TEST_ASSERT_AS_CLASS_EXPECT) {
         fossil_test_assert_impl_expect(expression, &_ASSERT_INFO);
     }
+
+    _ASSERT_INFO.num_asserts++; // increment the number of asserts
     _ASSERT_INFO.has_assert = true; // Make note of an assert being added in a given test case
+
+    // Add the assertion to the history with its fingerprint
+    if (assert_history_count < MAX_ASSERT_HISTORY) {
+        assert_history[assert_history_count].expression = expression;
+        assert_history[assert_history_count].behavior = behavior;
+        assert_history[assert_history_count].message = message;
+        assert_history[assert_history_count].file = file;
+        assert_history[assert_history_count].line = line;
+        assert_history[assert_history_count].func = func;
+        assert_history[assert_history_count].fingerprint = fingerprint;
+        assert_history_count++;
+    }
 }

meson.build

@@ -1,7 +1,7 @@
 project('Fossil Test', 'c', 'cpp',
     meson_version: '>=1.2.0',
     license: 'MPL-2.0',
-    version: '1.0.1',
+    version: '1.0.2',
     default_options: ['c_std=c18', 'cpp_std=c++20'])
 
 subdir('code')