diff --git a/prototyping/structure.md b/prototyping/documentation.md similarity index 90% rename from prototyping/structure.md rename to prototyping/documentation.md index 15c820f..8581223 100644 --- a/prototyping/structure.md +++ b/prototyping/documentation.md @@ -1,3 +1,10 @@ +# RUN + + + + + + Abratest has 3 required inputs, but most importantly the test configuration is done through the .env files given with the --env_paths argument. So let's say we want to run abratest with these 3 .env files: @@ -60,11 +67,14 @@ Furthermore, some `Runner` classes can depend on others. For example, `RunnerWor | 9. | Wordpress-2 | cleanups | +# Create a Runner -To comprehend this process, 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. +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. ```python +from pytest_abra import Runner, Test + class RunnerWordpress(Runner): env_type = "wordpress" dependencies = ["authentik"]