Merge pull request #20 from dreamer-coding/main

Updates for 1.0.3

Author: dreamer-coding

.github/ciimage/Dockerfile.debian

@@ -28,7 +28,7 @@ RUN apt-get update && \
     rm -rf /var/lib/apt/lists/*
 
 # Install Meson, Ninja, and Cython using pip
-RUN python3 -m pip install --no-cache-dir meson ninja
+RUN python3 -m pip install --no-cache-dir meson==1.4.0 ninja
 
 # Set environment variables
 ENV CC=/usr/bin/clang

.github/workflows/meson_ci.yml

@@ -18,12 +18,11 @@ on:
 
 jobs:
   build_msvc:
-    name: Building on MSVC ${{ matrix.msvc_version }} with Meson v${{ matrix.meson_version }}
+    name: Building on MSVC ${{ matrix.msvc_version }}
     runs-on: windows-latest
     strategy:
       matrix:
         msvc_version: [2015, 2017, 2019, 2022]
-        meson_version: ["1.2.0", "1.3.0", "1.4.0"]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -39,7 +38,7 @@ jobs:
         shell: pwsh
         run: |
           python -m pip install --upgrade pip
-          python -m pip install meson==${{ matrix.meson_version }} ninja
+          python -m pip install meson ninja
           if ($env:msvc_version -eq "2015") {
             choco install visualstudio2015buildtools --package-parameters "--add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --includeRecommended --includeOptional --passive"
           } elseif ($env:msvc_version -eq "2017") {
@@ -69,12 +68,11 @@ jobs:
           path: builddir_msvc_${{ matrix.msvc_version }}/meson-logs/testlog.txt
 
   build_macosx:
-    name: Building on macOS with Xcode ${{ matrix.xcode_version }} and Meson v${{ matrix.meson_version }}
+    name: Building on macOS with Xcode ${{ matrix.xcode_version }}
     runs-on: macos-latest
     strategy:
       matrix:
-        xcode_version: ["15.0", "15.1", "15.2", "15.3", "15.4"]
-        meson_version: ["1.2.0", "1.3.0", "1.4.0"]
+        xcode_version: ["15.2", "15.3"]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -91,7 +89,7 @@ jobs:
 
       - name: Install Meson and Ninja
         run: |
-          python -m pip install meson==${{ matrix.meson_version }} ninja
+          python -m pip install meson ninja
   
       - name: Configure
         run: meson setup builddir --fatal-meson-warnings -Dwerror=true -Dwith_test=enabled -Dwarning_level=3
@@ -110,12 +108,11 @@ jobs:
           path: builddir/meson-logs/testlog.txt
 
   build_msys:
-    name: Building on MSYS with Meson v${{ matrix.meson_version }}
+    name: Building on MSYS ${{ matrix.architecture }}
     runs-on: windows-latest
     strategy:
       matrix:
         architecture: [x86, x64]
-        meson_version: ["1.2.0", "1.3.0", "1.4.0"]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -139,7 +136,7 @@ jobs:
 
       - name: Install Meson and Ninja
         run: |
-          python -m pip install meson==${{ matrix.meson_version }} ninja
+          python -m pip install meson ninja
 
       - name: Configure
         run: meson setup builddir --fatal-meson-warnings -Dwerror=true -Dwith_test=enabled -Dwarning_level=3
@@ -158,12 +155,11 @@ jobs:
           path: builddir/meson-logs/testlog.txt
 
   build_mingw:
-    name: Building on MinGW with Meson v${{ matrix.meson_version }}
+    name: Building on MinGW ${{ matrix.architecture }}
     runs-on: windows-latest
     strategy:
       matrix:
         architecture: [x86, x64]
-        meson_version: ["1.2.0", "1.3.0", "1.4.0"]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -191,7 +187,7 @@ jobs:
 
       - name: Install Meson and Ninja
         run: |
-          python -m pip install meson==${{ matrix.meson_version }} ninja
+          python -m pip install meson ninja
 
       - name: Configure
         run: meson setup builddir --fatal-meson-warnings -Dwerror=true -Dwith_test=enabled -Dwarning_level=3
@@ -343,4 +339,4 @@ jobs:
 
       - name: Build the Project
         run: |
-          meson compile -C builddir
+          meson compile -C builddir

.vscode/settings.json

@@ -1,7 +1,13 @@
 # ***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.
+Fossil Test is a robust unit testing and mocking framework developed by Fossil Logic. It is designed to facilitate the creation of high-quality test cases across any C and C++ project. The framework supports Behavior-Driven Development (BDD), Domain Driven Development (DDD), and Test-Driven Development (TDD) styles, providing a flexible and comprehensive solution for ensuring software reliability and correctness.
+
+In addition to Fossil Test, Fossil Logic also offers two additional frameworks: Fossil Mark and Fossil Mock. Fossil Mark is a powerful benchmarking framework that allows developers to measure the performance of their code and identify areas for optimization. With built-in timing information and detailed reporting, developers can easily track the execution time of each test case and make informed decisions to improve the efficiency of their software.
+
+Fossil Mock, on the other hand, provides powerful mocking capabilities that enable developers to simulate the behavior of complex dependencies. This ensures focused and reliable unit tests, as developers can create mock objects that mimic the behavior of real dependencies, allowing for thorough testing of different scenarios.
+
+By combining the features of Fossil Test, Fossil Mark, and Fossil Mock, developers can create robust and performant code, ensuring the quality and reliability of their software projects.
 
 **Key Features:**
 
@@ -25,7 +31,7 @@ Before getting started, make sure you have the following installed:
 
 ## Adding Dependency
 
-1. **Install Meson Build System**: Before integrating the dependency, ensure you have Meson `1.2` or newer installed on your host system. You can install it with this command.
+1. **Install Meson Build System**: Before integrating the dependency, ensure you have Meson `1.3` or newer installed on your host system. You can install it with this command.
 
    ```sh
    python -m pip install meson           # to install Meson
@@ -40,11 +46,12 @@ Before getting started, make sure you have the following installed:
    # ======================
    [wrap-git]
    url = https://github.com/fossillogic/fossil-test.git
-   revision = v1.0.2
+   revision = v1.0.3
 
    [provide]
    fossil-test = fossil_test_dep
    fossil-mock = fossil_mock_dep
+   fossil-mark = fossil_mark_dep
    ```
 
 3. **Integrate the New Dependency**: After creating the dependency `.wrap` file, you need to integrate it into your Meson project. This typically involves adding the dependency to your `meson.build` file. Here's an example of how you might do that:

README.md

@@ -1,15 +1,17 @@
 /*
-==============================================================================
-Author: Michael Gene Brockus (Dreamer)
-Email: [email protected]
-Organization: Fossil Logic
-Description: 
-    This file is part of the Fossil Logic project, where innovation meets
-    excellence in software development. Michael Gene Brockus, also known as
-    "Dreamer," is a dedicated contributor to this project. For any inquiries,
-    feel free to contact Michael at [email protected].
-==============================================================================
-*/
+ * -----------------------------------------------------------------------------
+ * Project: Fossil Logic
+ *
+ * This file is part of the Fossil Logic project, which aims to develop high-
+ * performance, cross-platform applications and libraries. The code contained
+ * herein is subject to the terms and conditions defined in the project license.
+ *
+ * Author: Michael Gene Brockus (Dreamer)
+ * Date: 07/01/2024
+ *
+ * Copyright (C) 2024 Fossil Logic. All rights reserved.
+ * -----------------------------------------------------------------------------
+ */
 #ifndef FOSSIL_TEST_COMMON_H
 #define FOSSIL_TEST_COMMON_H
 

code/include/fossil/_common/common.h

@@ -1,15 +1,17 @@
 /*
-==============================================================================
-Author: Michael Gene Brockus (Dreamer)
-Email: [email protected]
-Organization: Fossil Logic
-Description: 
-    This file is part of the Fossil Logic project, where innovation meets
-    excellence in software development. Michael Gene Brockus, also known as
-    "Dreamer," is a dedicated contributor to this project. For any inquiries,
-    feel free to contact Michael at [email protected].
-==============================================================================
-*/
+ * -----------------------------------------------------------------------------
+ * Project: Fossil Logic
+ *
+ * This file is part of the Fossil Logic project, which aims to develop high-
+ * performance, cross-platform applications and libraries. The code contained
+ * herein is subject to the terms and conditions defined in the project license.
+ *
+ * Author: Michael Gene Brockus (Dreamer)
+ * Date: 07/01/2024
+ *
+ * Copyright (C) 2024 Fossil Logic. All rights reserved.
+ * -----------------------------------------------------------------------------
+ */
 #ifndef FOSSIL_TEST_PLATFORM_H
 #define FOSSIL_TEST_PLATFORM_H
 

code/include/fossil/_common/platform.h

@@ -0,0 +1,133 @@
+/*
+ * -----------------------------------------------------------------------------
+ * Project: Fossil Logic
+ *
+ * This file is part of the Fossil Logic project, which aims to develop high-
+ * performance, cross-platform applications and libraries. The code contained
+ * herein is subject to the terms and conditions defined in the project license.
+ *
+ * Author: Michael Gene Brockus (Dreamer)
+ * Date: 07/01/2024
+ *
+ * Copyright (C) 2024 Fossil Logic. All rights reserved.
+ * -----------------------------------------------------------------------------
+ */
+#ifndef FOSSIL_MARK_BENCHMARK_H
+#define FOSSIL_MARK_BENCHMARK_H
+
+#include "fossil/_common/common.h"
+
+#include <stdio.h>
+#include <stdint.h>
+#include <time.h>
+#include <float.h>
+
+typedef struct {
+    const char* name;
+    clock_t start_time;
+    clock_t end_time;
+    int num_samples;
+    double total_duration;
+    double min_duration;
+    double max_duration;
+    int running;
+} fossil_benchmark_t;
+
+/**
+ * @brief Initializes a fossil_benchmark_t object with the given name.
+ * @param benchmark The fossil_benchmark_t object to initialize.
+ * @param name The name of the benchmark.
+ */
+void fossil_benchmark_init(fossil_benchmark_t* benchmark, const char* name);
+
+/**
+ * @brief Starts the benchmark timer.
+ * @param benchmark The fossil_benchmark_t object to start.
+ */
+void fossil_benchmark_start(fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Stops the benchmark timer.
+ * @param benchmark The fossil_benchmark_t object to stop.
+ */
+void fossil_benchmark_stop(fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Returns the total elapsed time in seconds.
+ * @param benchmark The fossil_benchmark_t object to get the elapsed time from.
+ * @return The total elapsed time in seconds.
+ */
+double fossil_benchmark_elapsed_seconds(const fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Returns the minimum elapsed time in seconds.
+ * @param benchmark The fossil_benchmark_t object to get the minimum time from.
+ * @return The minimum elapsed time in seconds.
+ */
+double fossil_benchmark_min_time(const fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Returns the maximum elapsed time in seconds.
+ * @param benchmark The fossil_benchmark_t object to get the maximum time from.
+ * @return The maximum elapsed time in seconds.
+ */
+double fossil_benchmark_max_time(const fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Returns the average elapsed time in seconds.
+ * @param benchmark The fossil_benchmark_t object to get the average time from.
+ * @return The average elapsed time in seconds.
+ */
+double fossil_benchmark_avg_time(const fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Resets the benchmark statistics.
+ * @param benchmark The fossil_benchmark_t object to reset.
+ */
+void fossil_benchmark_reset(fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Prints a report of the benchmark statistics.
+ * @param benchmark The fossil_benchmark_t object to report.
+ */
+void fossil_benchmark_report(const fossil_benchmark_t* benchmark);
+
+typedef struct {
+    fossil_benchmark_t* benchmark;
+} scoped_benchmark_t;
+
+/**
+ * @brief Initializes a scoped_benchmark_t object with the given benchmark.
+ * @param scoped_benchmark The scoped_benchmark_t object to initialize.
+ * @param benchmark The benchmark to be scoped.
+ */
+void fossil_scoped_benchmark_init(scoped_benchmark_t* scoped_benchmark, fossil_benchmark_t* benchmark);
+
+/**
+ * @brief Destroys a scoped_benchmark_t object.
+ * @param scoped_benchmark The scoped_benchmark_t object to destroy.
+ */
+void fossil_scoped_benchmark_destroy(scoped_benchmark_t* scoped_benchmark);
+
+/**
+ * Function to test benchmark with specified duration type, expected value, and actual value.
+ * 
+ * @param duration_type The duration type to test.
+ * @param expected The expected value.
+ * @param actual The actual value.
+ */
+void fossil_test_benchmark(char* duration_type, double expected, double actual);
+
+/**
+ * Function to start the benchmark.
+ */
+void fossil_test_start_benchmark(void);
+
+/**
+ * Function to stop the benchmark and return the elapsed time in nanoseconds.
+ * 
+ * @return The elapsed time in nanoseconds.
+ */
+uint64_t fossil_test_stop_benchmark(void);
+
+#endif // FOSSIL_MARK_FRAMEWORK_H