From a9042c1208e32f3f420a2fa1eb9b4533efb50804 Mon Sep 17 00:00:00 2001 From: Daniel Date: Fri, 8 Dec 2023 00:15:07 +0100 Subject: [PATCH] further improve docs --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 54fd681..2ea98e8 100644 --- a/README.md +++ b/README.md @@ -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: -- `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 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 - `--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 ``` +### 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 To use pytest-abra, follow these steps: