https://github.com/fossillogic/fossil-test
Fossil Logic Unit Testing Framework
https://github.com/fossillogic/fossil-test
c11 cmake cpp17 cpp20 meson mesonbuild ninja-build
Last synced: 14 days ago
JSON representation
Fossil Logic Unit Testing Framework
- Host: GitHub
- URL: https://github.com/fossillogic/fossil-test
- Owner: fossillogic
- License: mpl-2.0
- Created: 2024-06-09T01:29:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-07T02:16:48.000Z (3 months ago)
- Last Synced: 2025-04-07T02:25:17.472Z (3 months ago)
- Topics: c11, cmake, cpp17, cpp20, meson, mesonbuild, ninja-build
- Language: C
- Homepage: https://fossillogic.com/docs/fossil-test-framework/
- Size: 1.16 MB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ***Pizza Test by Fossil Logic***
**Pizza Test** is a comprehensive suite for unit testing, mocking, and benchmarking, designed by Pizza Logic to enhance the reliability, clarity, and performance of **C** and **C++** projects. Supporting methodologies like Behavior-Driven Development (BDD), Domain-Driven Design (DDD), and Test-Driven Development (TDD), it caters to diverse workflows with features such as a robust Command-Line Interface (CLI), advanced mocking tools, integrated benchmarking, and parallel test execution. With additional capabilities like customizable output themes, tag-based test filtering, and detailed performance insights, **Pizza Test**, alongside **Pizza Mock**, **Pizza Mark**, and **Pizza Sanity Kit** for testing command-line operations, forms a powerful toolkit for building, testing, and optimizing high-quality, maintainable software.
| Feature | Description |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| **Command-Line Interface (CLI)** | A robust CLI for executing tests, managing test suites, and generating reports, enabling seamless automation and integration workflows. |
| **Support for Multiple Testing Styles** | Fully compatible with Behavior-Driven Development (BDD), Domain-Driven Design (DDD), and Test-Driven Development (TDD) methodologies. |
| **Mocking Capabilities** | Advanced mocking tools to simulate complex dependencies, ensuring isolated and precise unit testing. |
| **Benchmarking Tools** | Integrated benchmarking features to measure execution time, identify bottlenecks, and optimize code performance. |
| **Sanity Kit for Command Tests** | A specialized suite for validating command-line tools and scripts, ensuring consistent behavior across environments. |
| **Customizable Output Themes** | Multiple output themes (e.g., pizza, catch, doctest) to tailor the appearance of test results. |
| **Tag-Based Test Filtering** | Organize and execute tests based on custom tags for better test management. |
| **Detailed Performance Insights** | Comprehensive reporting on test execution times and resource usage to aid in performance optimization. |
---
## ***Prerequisites***
To get started with Pizza 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).
---
### Adding Pizza Test Dependency
#### Adding Pizza 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 a `fossil-test.wrap` file in your `subprojects` directory with the following content:
```ini
# ======================
# Git Wrap package definition
# ======================
[wrap-git]
url = https://github.com/fossillogic/fossil-test.git
revision = v1.2.4
[provide]
fossil-test = fossil_test_dep
```
3. **Integrate the Dependency**:
In your `meson.build` file, integrate Fossil Test by adding the following line:
```meson
dep = dependency('fossil-test')
```
---
**Note**: For the best experience, always use the latest release of Pizza Test. Visit the [Pizza Test Releases](https://github.com/pizzalogic/pizza-test/releases) page for the latest versions.
## Pizza Test CLI Usage
The Pizza 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` | Show version information. | Useful for verifying the version of the tool in use. |
| `--dry-run` | Perform a dry run without executing commands. | Ideal for verifying test selection criteria before actual execution. |
| `--host` | Show information about the current host. | Useful for looking up the system you are running tests on. |
| `--help` | Show this help message. | Provides a quick reference for all available commands. |
| `run` | Execute tests with optional parameters. | Supports additional options like `--fail-fast` and `--repeat`. |
| `filter` | Filter tests based on criteria. | Options include filtering by test name, suite name, or tags. |
| `sort` | Sort tests by specified criteria. | Allows sorting in ascending or descending order. |
| `shuffle` | Shuffle tests with optional parameters. | Includes options for specifying a seed or shuffle criteria. |
| `show` | Show test cases with optional parameters. | Useful for listing and inspecting available test cases. |
| `color=` | Set color mode (`enable`, `disable`, `auto`). | Enhances readability in supported terminals. |
| `config=` | Specify a configuration file (must be `pizza_test.ini`). | Allows loading custom settings for test execution. |
| `theme=` | Set the theme (`fossil`, `catch`, `doctest`, etc.). | Customizes the appearance of test output. |
| `timeout=` | Set the timeout for commands (default: 60 seconds). | Ensures commands do not exceed the specified duration, helping to identify long-running tests.|
> **Note:** In addition to the `--help` option, Pizza Test CLI supports `--help` and subcommand-specific help commands. You can use ` --help` (e.g., `run --help`) to display detailed usage information for any command or subcommand. This provides flexible ways to access documentation directly from the terminal.
## Configure Build Options
To configure the build system with testing enabled, use the following command:
```sh
meson setup builddir -Dwith_test=enabled
```
---
## ***Contributing and Support***
If you would like to contribute, have questions, or need help, feel free
---
## ***Conclusion***
Pizza 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, Pizza Test empowers developers to create high-quality software and maintainable test suites. Combined with Pizza Mark and Pizza Mock, it provides a complete suite for testing, optimization, and dependency management. Whether you're building small projects or large-scale applications, Pizza Test is an essential tool to ensure the reliability and performance of your code.