You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-38Lines changed: 36 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,29 @@ Pizza Test is a smart unit testing framework developed by Fossil Logic for C and
18
18
|**Tag-Based Test Filtering**| Execute subsets of tests based on custom tags for better test suite organization and faster iteration. |
19
19
|**Detailed Performance Insights**| In-depth statistics on execution time, memory usage, and test stability to help improve code performance and reliability. |
20
20
21
-
---
21
+
## Command-Line
22
+
23
+
The Pizza Test CLI provides an efficient way to run and manage tests directly from the terminal. Here are the available commands and options:
|`--version`| Show version information. | Useful for verifying the version of the tool in use. |
30
+
|`--dry-run`| Perform a dry run without executing commands. | Ideal for verifying test selection criteria before actual execution. |
31
+
|`--host`| Show information about the current host. | Useful for looking up the system you are running tests on. |
32
+
|`--help`| Show this help message. | Provides a quick reference for all available commands. |
33
+
|`run`| Execute tests with optional parameters. | Supports additional options like `--fail-fast` and `--repeat`. |
34
+
|`filter`| Filter tests based on criteria. | Options include filtering by test name, suite name, or tags. |
35
+
|`sort`| Sort tests by specified criteria. | Allows sorting in ascending or descending order. |
36
+
|`shuffle`| Shuffle tests with optional parameters. | Includes options for specifying a seed or shuffle criteria. |
37
+
|`show`| Show test cases with optional parameters. | Useful for listing and inspecting available test cases. |
38
+
|`color=<mode>`| Set color mode (`enable`, `disable`, `auto`). | Enhances readability in supported terminals. |
39
+
|`config=<file>`| Specify a configuration file (must be `pizza_test.ini`). | Allows loading custom settings for test execution. |
40
+
|`theme=<name>`| Set the theme (`fossil`, `catch`, `doctest`, etc.). | Customizes the appearance of test output. |
41
+
|`timeout=<seconds>`| Set the timeout for commands (default: 60 seconds). | Ensures commands do not exceed the specified duration, helping to identify long-running tests.|
22
42
23
-
Pizza Test is a first-class citizen of the **Truthful Intelligence** ecosystem, using **Jellyfish AI** as its foundation for test integrity, learning from outcomes over time, and enabling tamper-proof validation across distributed development environments.
43
+
> **Note:** In addition to the `--help` option, Pizza Test CLI supports `--help` and subcommand-specific help commands. You can use `<command> --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.
24
44
25
45
---
26
46
@@ -29,15 +49,25 @@ Pizza Test is a first-class citizen of the **Truthful Intelligence** ecosystem,
29
49
To get started with Pizza Test, ensure you have the following installed:
30
50
31
51
-**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).
52
+
-**Conan Package Manager**: If you prefer using Conan, ensure it is installed by following the instructions on the official [Conan website](https://docs.conan.io/en/latest/installation.html).
32
53
33
54
---
34
55
35
-
### Adding Pizza Test Dependency
56
+
### Adding Dependency
57
+
58
+
#### Adding via Conan GitHub repository
59
+
60
+
Conan can install packages directly from a GitHub repository if it contains a valid conanfile.py.
**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.
77
99
78
-
## Pizza Test CLI Usage
79
-
80
-
The Pizza Test CLI provides an efficient way to run and manage tests directly from the terminal. Here are the available commands and options:
|`--version`| Show version information. | Useful for verifying the version of the tool in use. |
87
-
|`--dry-run`| Perform a dry run without executing commands. | Ideal for verifying test selection criteria before actual execution. |
88
-
|`--host`| Show information about the current host. | Useful for looking up the system you are running tests on. |
89
-
|`--help`| Show this help message. | Provides a quick reference for all available commands. |
90
-
|`run`| Execute tests with optional parameters. | Supports additional options like `--fail-fast` and `--repeat`. |
91
-
|`filter`| Filter tests based on criteria. | Options include filtering by test name, suite name, or tags. |
92
-
|`sort`| Sort tests by specified criteria. | Allows sorting in ascending or descending order. |
93
-
|`shuffle`| Shuffle tests with optional parameters. | Includes options for specifying a seed or shuffle criteria. |
94
-
|`show`| Show test cases with optional parameters. | Useful for listing and inspecting available test cases. |
95
-
|`color=<mode>`| Set color mode (`enable`, `disable`, `auto`). | Enhances readability in supported terminals. |
96
-
|`config=<file>`| Specify a configuration file (must be `pizza_test.ini`). | Allows loading custom settings for test execution. |
97
-
|`theme=<name>`| Set the theme (`fossil`, `catch`, `doctest`, etc.). | Customizes the appearance of test output. |
98
-
|`timeout=<seconds>`| Set the timeout for commands (default: 60 seconds). | Ensures commands do not exceed the specified duration, helping to identify long-running tests.|
99
-
100
-
> **Note:** In addition to the `--help` option, Pizza Test CLI supports `--help` and subcommand-specific help commands. You can use `<command> --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.
101
-
102
100
## Configure Build Options
103
101
104
102
To configure the build system with testing enabled, use the following command:
0 commit comments