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. |
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.
-
Install Meson Build System: Install Meson version
1.3or newer:python -m pip install meson # To install Meson python -m pip install --upgrade meson # To upgrade Meson
-
Create a
.wrapFile: Add afossil-test.wrapfile in yoursubprojectsdirectory with the following content:# ====================== # Git Wrap package definition # ====================== [wrap-git] url = https://github.com/fossillogic/fossil-test.git revision = v1.2.2 [provide] fossil-test = fossil_test_dep
-
Integrate the Dependency: In your
meson.buildfile, integrate Fossil Test by adding the following line:dep = dependency('fossil-test')
Note: For the best experience, always use the latest release of Pizza Test. Visit the Pizza Test Releases page for the latest versions.
The Pizza Test CLI provides an efficient way to run and manage tests directly from the terminal. Here are the available commands and options:
| Command | Description | Notes |
|---|---|---|
--version |
Displays the current version of Pizza 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. |
--dry-run |
Perform a dry run without executing commands. | Ideal for verifying test selection criteria before actual execution. |
--host |
Shows info about the current host system. | Useful for looking up system you are running test on. |
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. |
color=<mode> |
Set color mode (enable, disable, auto). | Enhances readability in supported terminals. |
config=<file> |
Specify a configuration file (must be pizza_test.ini). | Allows loading custom settings for test execution. |
theme=<name> |
Set the theme (pizza, catch, doctest, etc.). | Customizes the appearance of test output. |
verbose=<level> |
Set verbosity level (plain, ci, doge). | Adjusts the level of detail in test output. |
timeout=<seconds> |
Set a timeout for test execution. | Ensures tests do not exceed the specified duration, helping to identify long-running tests. |
| Option | Description | Notes |
|---|---|---|
--fail-fast |
Stop on the first failure. | Useful for quickly identifying and addressing critical issues. |
--only <test> |
Run only the specified test. | Focuses execution on a single test for debugging or validation purposes. |
--skip <test> |
Skip the specified test. | Allows excluding specific tests from execution. |
--repeat <count> |
Repeat the test a specified number of times. | Useful for stress testing or verifying consistency across multiple runs. |
--help |
Show help for the run command. | Provides detailed usage instructions for the run command. |
| Option | Description | Notes |
|---|---|---|
--options |
Show all available filter options. | Provides a comprehensive list of filter-related flags and their usage. |
--test-name <name> |
Filter by test name. | Enables precise targeting of individual tests. |
--suite-name <name> |
Filter by suite name. | Useful for running all tests within a specific suite. |
--tag <tag> |
Filter by tag. | Allows grouping and execution of tests based on custom tags. |
--help |
Show help for the filter command. | Provides detailed usage instructions for the filter command. |
| Option | Description | Notes |
|---|---|---|
--options |
Show all available sort options. | Provides a comprehensive list of sort-related flags and their usage. |
--by <criteria> |
Sort by specified criteria. | Common criteria include execution time, name, or priority. |
--order <asc/desc> |
Sort in ascending or descending order. | Helps organize test execution based on preferred order. |
--help |
Show help for the sort command. | Provides detailed usage instructions for the sort command. |
| Option | Description |
|---|---|
--options |
Show all available shuffle options. |
--seed <seed> |
Specify the seed for shuffling. |
--count <count> |
Number of items to shuffle. |
--by <criteria> |
Shuffle by specified criteria. |
--help |
Show help for the shuffle command. |
To configure the build system with testing enabled, use the following command:
meson setup builddir -Dwith_test=enabledIf you would like to contribute, have questions, or need help, feel free
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.