Skip to content

Commit acafc08

Browse files
committed
docs(behave): add BehaveX support to changelog and README
1 parent d5af142 commit acafc08

2 files changed

Lines changed: 48 additions & 0 deletions

File tree

qase-behave/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Qase Behave Reporter enables seamless integration between your Behave BDD tests
1414
- Automatic step reporting from Gherkin scenarios
1515
- Multi-project reporting support
1616
- Flexible configuration (file, environment variables)
17+
- **[BehaveX](https://github.com/hrcorval/behavex) parallel execution support**
1718

1819
## Installation
1920

@@ -204,10 +205,29 @@ export QASE_TESTOPS_RUN_TITLE="Regression Run"
204205
behave --format=qase.behave.formatter:QaseFormatter
205206
```
206207

208+
### Parallel Execution with BehaveX
209+
210+
Run tests in parallel using [BehaveX](https://github.com/hrcorval/behavex) (v4.0.0+):
211+
212+
```sh
213+
pip install behavex
214+
215+
behavex --formatter=qase.behave.formatter:QaseFormatter --parallel-processes=4 features/
216+
217+
# Parallel by feature
218+
behavex --formatter=qase.behave.formatter:QaseFormatter --parallel-processes=4 --parallel-scheme=feature features/
219+
```
220+
221+
Configuration is done via environment variables or `qase.config.json` (the same as for standard behave).
222+
223+
> **Note:** `qase.attach()` and `qase.comment()` are not supported in BehaveX mode. All other features (test case linking, metadata, steps, statuses) work normally.
224+
207225
## Requirements
208226

209227
- Python >= 3.9
210228
- behave >= 1.2.6
229+
- filelock >= 3.12.2
230+
- BehaveX >= 4.0.0 (optional, for parallel execution)
211231

212232
## Documentation
213233

qase-behave/changelog.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
# qase-behave 3.2.0
2+
3+
## What's new
4+
5+
- Added support for [BehaveX](https://github.com/hrcorval/behavex) parallel test execution via `--formatter` flag. BehaveX calls `launch_json_formatter()` with consolidated JSON after all workers complete — scenarios, steps, tags, statuses, and timing are fully reported.
6+
- Added `launch_json_formatter()` method implementing the BehaveX custom formatter interface
7+
- Added `parse_scenario_from_json()` and `parse_step_from_json()` utility functions for mapping BehaveX JSON to Qase models
8+
- Added `filelock` dependency for cross-process run coordination
9+
10+
### BehaveX Usage
11+
12+
```sh
13+
behavex --formatter=qase.behave.formatter:QaseFormatter --parallel-processes=4 features/
14+
```
15+
16+
Configuration via environment variables or `qase.config.json`:
17+
18+
```sh
19+
export QASE_MODE=testops
20+
export QASE_TESTOPS_PROJECT=PROJ
21+
export QASE_TESTOPS_API_TOKEN=your_token
22+
```
23+
24+
### Known Limitations
25+
26+
- `qase.attach()` and `qase.comment()` are not supported in BehaveX mode — tests have already completed when the formatter processes results.
27+
- Configuration is only available via environment variables or `qase.config.json` (behave `--define` options are not passed to the BehaveX formatter).
28+
129
# qase-behave 3.1.0
230

331
## What's new

0 commit comments

Comments
 (0)