From 050d8cde38f50b52f48b4c71d287265730ed84f6 Mon Sep 17 00:00:00 2001 From: Daniel Date: Mon, 11 Dec 2023 02:24:39 +0100 Subject: [PATCH] add discovery segment --- docs/documentation.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/documentation.md b/docs/documentation.md index e27c359..013e57e 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -96,6 +96,21 @@ def condition_function(args: ConditionArgs) -> bool: ... ``` +## Discovery of `Runners` and `Tests` + +- Runners will be discovered, if they are defined in a moduled of name `runner_*.py` including a class of name `Runner*`. + +- Tests will be discovered by filename as long as they are placed in the parent dir of `runner_*.py` or in any subdirectory. + +``` +DIR parent_dir +├── FILE runner_*.py +├── FILE test1.py +└── DIR subdir + ├── DIR subsubdir + │ └── test2.py + └── test3.py +``` # Create custom Tests