Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/fossillogic/fossil-test

Fossil Test is a comprehensive unit testing, mocking, and benchmarking suite created by Fossil Logic, designed to ensure the reliability and performance of C and C++ projects. With support for multiple development methodologies, including Behavior-Driven Development (BDD), Domain-Driven Design (DDD), and Test-Driven Development (TDD). đź“ť
https://github.com/fossillogic/fossil-test

bdd c cpp ddd fossillogic meson mesonbuild mocking mockup tdd testing unittest

Last synced: 2 months ago
JSON representation

Fossil Test is a comprehensive unit testing, mocking, and benchmarking suite created by Fossil Logic, designed to ensure the reliability and performance of C and C++ projects. With support for multiple development methodologies, including Behavior-Driven Development (BDD), Domain-Driven Design (DDD), and Test-Driven Development (TDD). đź“ť

Awesome Lists containing this project

README 

        
# ***Fossil Test by Fossil Logic***



**Fossil Test** is a comprehensive unit testing, mocking, and benchmarking suite created by Fossil Logic, designed to ensure the reliability and performance of C and C++ projects. With support for multiple development methodologies, including Behavior-Driven Development (BDD), Domain-Driven Design (DDD), and Test-Driven Development (TDD), Fossil Test provides a versatile foundation for crafting high-quality test cases across various workflows.



The Fossil suite consists of three complementary frameworks to streamline the development and testing process:



- **Fossil Test**: The core unit testing framework that enables developers to create, manage, and execute unit tests effectively, ensuring each component functions as expected.

- **Fossil Mock**: A dedicated mocking library that simulates complex dependencies. Using mock objects, developers can isolate and thoroughly test individual components, improving the precision and reliability of test coverage.

- **Fossil Mark**: A benchmarking tool that provides detailed performance insights by measuring execution time, identifying bottlenecks, and offering in-depth reporting to optimize code efficiency.



Together, **Fossil Test**, **Fossil Mock**, and **Fossil Mark** offer a powerful, integrated toolkit for developing, testing, and optimizing robust software, making them an essential asset for developers committed to quality and performance.



---



**Key Features:**



| Feature                  | Description                                                                                                                                                     |

|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|

| **BDD, DDD, and TDD Support** | Supports Behavior-Driven, Domain-Driven, and Test-Driven Development styles, catering to various project methodologies.                                        |

| **Comprehensive Unit Testing** | A full suite of tools for creating, managing, and executing unit tests, ensuring that individual units of code behave as expected.                             |

| **Mocking Capabilities** | Powerful mocking features allow developers to simulate complex dependencies, ensuring focused and reliable unit tests.                                         |

| **Performance Tracking** | Measures and reports the performance of each test case, helping developers optimize test execution time and performance.                                         |

| **Command-Line Interface (CLI)** | A powerful CLI for running tests, generating reports, and managing the test suite, supporting automation and integration workflows.                        |



---



## ***Prerequisites***



To get started with Fossil Test, ensure you have the following installed:



- **Meson Build System**: If you don’t have Meson installed, follow the installation instructions on the official [Meson website](https://mesonbuild.com/Getting-meson.html).

- **CMake Build System**: If you don’t have CMake installed, follow the installation instructions on the official [CMake website](https://cmake.org/getting-started/).



---



### Adding Fossil Test Dependency



#### Adding Fossil Test Dependency With Meson



1. **Install Meson Build System**:

   Install Meson version `1.3` or newer:

   ```sh

   python -m pip install meson           # To install Meson

   python -m pip install --upgrade meson # To upgrade Meson

   ```



2. **Create a `.wrap` File**:

   Add the `fossil-test.wrap` file in your `subprojects` directory and include the following content:



   ```ini

   # ======================

   # Git Wrap package definition

   # ======================

   [wrap-git]

   url = https://github.com/fossillogic/fossil-test.git

   revision = v1.1.6



   [provide]

   fossil-test = fossil_test_dep

   ```



3. **Integrate the Dependency**:

   In your `meson.build` file, integrate Fossil Test by adding the following line:

   ```ini

   dep = dependency('fossil-test')

   ```



---



#### Adding Fossil Test Dependency With CMake



To use Fossil Test with CMake, follow these steps:



1. **Install CMake**:

   Install CMake version `3.13.4` or newer:



   ```sh

   python -m pip install cmake           # To install CMake

   python -m pip install --upgrade cmake # To upgrade CMake

   ```



2. **Find and Integrate Fossil Test**:

   After installing CMake, you can integrate Fossil Test as a dependency. Add the following lines to your `CMakeLists.txt` file:



   ```cmake

   # Find Fossil Test package

   find_package(FossilTest REQUIRED)



   # Link the Fossil Test to your project

   target_link_libraries(your_target FossilTest)

   ```



3. **Configure Your CMake Project**:

   Make sure to configure your CMake project to include the necessary paths and dependencies for Fossil Test. Typically, you’ll want to make sure the `FossilTest` library is correctly linked in your build configuration.



   This will ensure that Fossil Test is included and properly built with your project.



---



**Note**: For the best experience, always use the latest release of Fossil Test. Visit the [Fossil Test Releases](https://github.com/fossillogic/fossil-test/releases) page for the latest versions.



## Fossil Test CLI Usage



The Fossil Test CLI provides an efficient way to run and manage tests directly from the terminal. Here are the available commands and options:



### Commands and Options



| Command                         | Description                                                                                   | Notes                                                                                          |

|----------------------------------|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|

| `--version`                      | Displays the current version of Fossil Test.                                                  | Useful for verifying the version of the tool in use.                                          |

| `--help`                         | Shows help message with usage instructions.                                                   | Provides a quick reference for all available commands.                                        |

| `--info`                         | Displays detailed information about the test run.                                             | Includes information such as test count, duration, and configuration.                        |

| `reverse [enable/disable]`       | Enables or disables reverse order of test execution.                                           | Useful for debugging or ensuring the tests don't depend on execution order.                  |

| `shuffle [enable/disable]`       | Enables or disables shuffling of test execution order.                                         | Helps identify order-dependent issues in the test suite.                                     |

| `dry-run [enable/disable]`       | Enables or disables dry run mode, showing which tests will execute without running them.       | Ideal for verifying test selection criteria before actual execution.                         |

| `repeat=`                | Repeats the test suite a specified number of times.                                            | Handy for stress-testing or reproducing intermittent failures.                               |



### Key Notes Summary:

- **Version**: Quickly check the installed version of Fossil Test.

- **Help**: Access usage instructions and command references.

- **Info**: Get detailed insights about the test run, including test count and duration.

- **Reverse and Shuffle**: Help debug issues by manipulating test execution order.

- **Repeat**: Ideal for reliability testing by repeatedly executing tests.

- **Dry Run**: Provides a preview of the test plan without running the tests, useful for preparation and validation.



### Usage



To use the Fossil Test CLI, navigate to your project directory and run the desired command. For example, to check the version of Fossil Test, use:



```sh

fossil-test --version

```



To display help information, use:



```sh

fossil-test --help

```



For detailed information about the test run, use:



```sh

fossil-test --info

```



To enable reverse order of test execution, use:



```sh

fossil-test reverse enable

```



To disable reverse order of test execution, use:



```sh

fossil-test reverse disable

```



To enable shuffling of test execution order, use:



```sh

fossil-test shuffle enable

```



To disable shuffling of test execution order, use:



```sh

fossil-test shuffle disable

```



To perform a dry run, use:



```sh

fossil-test dry-run enable

```



To disable dry run mode, use:



```sh

fossil-test dry-run disable

```



To repeat the test suite a specified number of times, use:



```sh

fossil-test repeat=

```



---



## Configure Build Options



To configure the build system with testing enabled, use the following command:



```sh

meson setup builddir -Dwith_test=enabled

```



For CMake, ensure the appropriate flags and dependencies are passed during the configuration step.



---



## ***Contributing and Support***



If you would like to contribute, have questions, or need help, feel free to open an issue on the [Fossil Test GitHub repository](https://github.com/fossillogic/fossil-test) or consult the [Fossil Logic Docs](https://fossillogic.com/docs).



---



## ***Conclusion***



Fossil Test is a powerful and flexible framework for C and C++ developers, designed to support a wide range of testing methodologies such as BDD, DDD, and TDD. With features like mocking, detailed reporting, and performance tracking, Fossil Test empowers developers to create high-quality software and maintainable test suites. Combined with Fossil Mark and Fossil Mock, it provides a complete suite for testing, optimization, and dependency management. Whether you're building small projects or large-scale applications, Fossil Test is an essential tool to ensure the reliability and performance of your code.