From 9ff1d1a2a0efc6ecc4982d26e09182973f41ccc1 Mon Sep 17 00:00:00 2001 From: Daniel Date: Thu, 14 Dec 2023 13:28:57 +0100 Subject: [PATCH] wip more docs --- docs/documentation.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/documentation.md b/docs/documentation.md index 560ce6e..b84c7da 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -213,6 +213,16 @@ Furthermore, some `Runner` classes can depend on others. For example, `RunnerWor | 9. | Wordpress-2 | cleanups | +# Create a test suite for a recipe + +todo + +To understand how a test suite is built, let's have a look at the files + +runner_authentik.py -> required, defines the Runner subclass (see below) +conftest.py -> not required. special file for pytest. is automatically discovered and loaded. convenient place to define fixtures and functions to be used in more than one test routine +setup_authentik.py -> not required. can hold setup routine for authentik, has to be registered in runner_authentik.py + # Create a custom Runner To comprehend the process of creating a new subclass of `Runner`, let's examine a simplified rendition of the `RunnerWordpress` class. Within it, there exist two setup scripts and two test scripts, one of which operates conditionally.