Skip to content

Commit fec4647

Browse files
committed
update readme
1 parent 75b0132 commit fec4647

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ To run with command-line options:
2727
cargo run --release -- --config datafusion-fuzzer.toml --rounds 5 --queries-per-round 20
2828
```
2929

30+
To run with verbose oracle/query logs to stdout:
31+
```bash
32+
RUST_LOG=info cargo run -- --config datafusion-fuzzer.toml --display-logs
33+
```
34+
35+
## Oracles
36+
37+
The runner currently chooses one oracle at random for each test case:
38+
39+
- `NoCrashOracle`: checks for non-whitelisted crashes/errors.
40+
- `TlpWhereOracle`: validates TLP partitioning over `WHERE` (`p`, `NOT p`, `p IS NULL`) via value-level multiset comparison.
41+
- `TlpHavingOracle`: validates TLP partitioning over `HAVING` (`p`, `NOT p`, `p IS NULL`) via value-level multiset comparison.
42+
3043
## Configuration
3144

3245
The fuzzer supports extensive configuration options to customize the fuzzing process.
@@ -45,18 +58,20 @@ See `datafusion-fuzzer.toml` for an example configuration file:
4558
seed = 42
4659
rounds = 3
4760
queries_per_round = 10
48-
timeout_seconds = 30
61+
timeout_seconds = 2
4962

5063
# Logging settings
51-
display_logs = true
52-
enable_tui = false
53-
# log_path = "logs/datafusion-fuzzer.log"
64+
display_logs = false
65+
enable_tui = true
66+
log_path = "logs"
67+
sample_interval_secs = 5
5468

5569
# Table generation parameters
5670
max_column_count = 5
5771
max_row_count = 100
5872
max_expr_level = 3
5973
max_table_count = 3
74+
max_insert_per_table = 20
6075
```
6176

6277
### Command Line Options
@@ -69,6 +84,8 @@ Options:
6984
-q, --queries-per-round <QUERIES> Number of queries per round
7085
-t, --timeout <TIMEOUT> Query timeout in seconds
7186
-l, --log-path <LOG_PATH> Path to log file
87+
-d, --display-logs Display logs
88+
--enable-tui Enable TUI display
7289
-h, --help Print help
7390
-V, --version Print version
7491
```
@@ -85,7 +102,7 @@ Options:
85102
- [x] where
86103
- [ ] sort + limit, offset
87104
- [ ] aggregate
88-
- [ ] having
105+
- [x] having
89106
- [ ] join
90107
- [ ] union/union all/intersect/except
91108

@@ -112,4 +129,4 @@ Options:
112129

113130
## License
114131

115-
[MIT](LICENSE)
132+
[MIT](LICENSE)

0 commit comments

Comments
 (0)