diff --git a/README.md b/README.md index 538266cd14b46aab7260840eae2ea6ea0ef523d5..c98de1ce6ff683dfe4271c748b441c134281dd45 100644 --- a/README.md +++ b/README.md @@ -1,16 +1 @@ # EDD Pipeline Test Framework (currently under developement) - -This repository is a test framework for black box testing of EDD (Effelsberg Direct Digitization) pipelines, which are part of the EDD backend software stack. -The EDD backend software stack essentially consists of three components: -- [mpikat](https://gitlab.mpcdf.mpg.de/mpifr-bdg/mpikat) -- [edd_ansible](https://gitlab.mpcdf.mpg.de/mpifr-bdg/edd_ansible) -- [psrdada_cpp](https://gitlab.mpcdf.mpg.de/mpifr-bdg/psrdada_cpp) -The three components already implement various tests (build tests, unit tests, component tests) to ensure continuous integration (CI). However, black box testing is a huge benefit to ensure the correct interaction of these components and assess the reliability of EDD pipelines. - -## Requirements - -## How to use -For testing an EDD Pipline, three components are required: -1. A config file describing the KATCP control interface, in- and output streams (multicast IP, port, interface address, SPEAD2 item descriptors etc.) as well as the configuration of the pipeline under test. -2. A golden standard processors which implements the algorithm of the pipeline under test. Thus, known output data can be generated. -3. A test case which is implemented as a child class of `PipelineUnderTest`