diff --git a/tangostationcontrol/docs/source/static/images/layered-setup-commands.png b/tangostationcontrol/docs/source/static/images/layered-setup-commands.png new file mode 100644 index 0000000000000000000000000000000000000000..d8959058fa557c8abc36929272a68fa7cb5809a8 Binary files /dev/null and b/tangostationcontrol/docs/source/static/images/layered-setup-commands.png differ diff --git a/tangostationcontrol/docs/source/static/images/layered-setup-pass.png b/tangostationcontrol/docs/source/static/images/layered-setup-pass.png new file mode 100644 index 0000000000000000000000000000000000000000..0498765af21919563831160a9485bda2fb0b68e3 Binary files /dev/null and b/tangostationcontrol/docs/source/static/images/layered-setup-pass.png differ diff --git a/tangostationcontrol/docs/source/static/images/layered-setup.png b/tangostationcontrol/docs/source/static/images/layered-setup.png new file mode 100644 index 0000000000000000000000000000000000000000..df67cf9d648c9e89019064b5e510b5484601f5b4 Binary files /dev/null and b/tangostationcontrol/docs/source/static/images/layered-setup.png differ diff --git a/tangostationcontrol/tangostationcontrol/integration_test/README.md b/tangostationcontrol/tangostationcontrol/integration_test/README.md index 6c2321ad67ffade31894fcb2d71d160fb9e6f849..c917ae188593bfd8539552072e149307414db166 100644 --- a/tangostationcontrol/tangostationcontrol/integration_test/README.md +++ b/tangostationcontrol/tangostationcontrol/integration_test/README.md @@ -2,6 +2,10 @@ Integration tests are separated into multi modules. Each module requires a different state and configuration. These configurations are managed externally. +An overview of the entire layered setup of different integration test components +is shown below + + To minimize runtime overhead and memory pressure it is best to execute the dummy integration test module before any other container is created. This will @@ -33,6 +37,18 @@ instead of through tox directly: make integration import.path.class.functionname` ``` +Since at each layer tests can be specified, the information amount selection +modules and tests has to be passed down from the top layers to the ones below. +To be able to understand the flow of this information the following diagram +below is provided. + + + +It should be noted that not all layers of the setup are convenient to interact +with. Some should be avoided see diagram below. + + + ## Breakpoints & Debuggers with Integration Tests It can be extremely helpful to be able to mount a debugger during integration