further improve docs

This commit is contained in:
Daniel 2023-12-08 00:15:07 +01:00
parent 8aacea68a0
commit a9042c1208

View file

@ -2,19 +2,19 @@
Pytest-Abra is an installable python package design to test instances created with [abra](https://docs.coopcloud.tech/abra/). After installation, you will have two things: Pytest-Abra is an installable python package design to test instances created with [abra](https://docs.coopcloud.tech/abra/). After installation, you will have two things:
- `abratest` CLI command - `abratest` CLI command. *Used to initialize the testing.*
- `pytest-abra` Pytest plugin - `pytest-abra` Pytest plugin. *Automatically loads custom fixtures in any pytest.*
## CLI (abratest) ## CLI (`abratest`)
The easiest way to call abratest is via the helper script in `main.py`. You can also directly call abratest via terminal, but you will have to make sure that the requirements below are met. To do that, you can call `abratest` with: `Abratest` can be called via terminal:
```bash ```bash
abratest [arguments] abratest [arguments]
``` ```
The cli command abratest has 3 **required arguments**: To run successfully, very specific arguments are required. The easiest way to use abratest is with the helper script in `main.py`. Of yourse you can implement a similar helper script in the language of your liking. The cli command `abratest` has 3 **required arguments**:
- `--env_paths`: list of the .env files used in the test - `--env_paths`: list of the .env files used in the test
- `--recipes_dir`: directory of all available abra recipes - `--recipes_dir`: directory of all available abra recipes
@ -72,6 +72,14 @@ The class `RunnerWordpress` will be automatically imported by `importlib`, which
from wordpress.tests_wordpress.runner_wordpress import RunnerWordpress from wordpress.tests_wordpress.runner_wordpress import RunnerWordpress
``` ```
### output_dir [string]
Path to the directory where all test outputs are stored (test report, tracebacks, playwright traces etc.)
```
abratest --output_dir /path/to/output
```
# Usage # Usage
To use pytest-abra, follow these steps: To use pytest-abra, follow these steps: