ADTF Testing SDK

Table of Contents

• ADTF Testing SDK
  • Introduction
  • Usage:
    • CMake:
    • Test Implementations:

ADTF Testing SDK

The ADTF Testing SDK provides some simple functionality to test your ADTF components. It will work with each testing framework you like, we recommend and support the use with Catch2.

The main header to include is:

#include <adtftesting/adtf_testing.h>

Introduction

The main focus of this package is to create functional tests for ADTF components (such as Filter, Streaming Service or System Service) as well as all other ADTF code created with the use of Software Development Kit.

Usage:

CMake:

In CMake, just use the provided macro

adtf_add_catch_test(...)

Now you can access the catch2 Macros within your test scope. Have a look at Test for Demo Data Trigger Plugin for an example usage. If you would like to test Qt based components make sure to pass ENABLE_QT_ENV to the macro.

The test report handling is configured via the following CMake cache variables:

• ADTF_TESTING_CATCH_REPORTER: The reporter used in Catch2. This is passed to the test executable via the "-r" parameter.
• ADTF_TESTING_CATCH_GENERATE_REPORTS: Whether or not to generate report files.
• ADTF_TESTING_CATCH_REPORTS_DIR: The directory where the test reports should pe placed in.
• ADTF_TESTING_CATCH_REPORT_NAME_PATTERN: The pattern for constructing the report filenames, relative to ADTF_TESTING_CATCH_REPORTS_DIR. This support CMake generator expressions and CMake variables. ${NAME} can be used to address the name of the tests. Defaults to "\${NAME}/report_\${NAME}_\$<IF:\$<CONFIG:Debug>,debug,release>_\${PLATFORM}.xml"

Test Implementations:

We extended the SDKs with some additional classes for your testing porpuse.

The ADTF System SDK provides following testing helper classes:

• adtf::system::testing::giant::cTestSystem for setting up the tester runtime environment
• adtf::system::testing::giant::cSessionTestSystem for controlling a tester ADTF Session

To use them, just include following header:

#include <adtfsystemsdk/testing/test_system.h>

The ADTF Filter SDK provides following testing helper classes:

• adtf::filter::testing::giant::cTestWriter for creating sample data
• adtf::filter::testing::giant::cOutputRecorder for accesing sample data

To use them, just include following header:

#include <adtffiltersdk/testing/testing_pkg.h>

For an example please have a look at Testing SDK Examples, especially:

• Test for Demo Data Trigger Plugin

Note

You can use these helper classes with every testing framework that you desire.