C++ тестирование с помощью catch2

Аннотация

В этой статье я объясню, как использовать catch2 для модульного тестирования.

Как построить

Чтобы собрать исходники, вам нужно скачать релиз с https://github.com/catchorg/Catch2/tags. Теперь вы можете скомпилировать исходный код с помощью gcc. Следующий фрагмент кода покажет cmake script для компиляции.

    #Please set the environment variables to your needs 

    cmake \
    -G "Unix Malkefiles" \
    -D CMAKE_BUILD_TYPE=Release \
    -D BUILD_TESTING=OFF \
    -D BUILD_SHARED_LIBS=ON \
    -D "CMAKE_STAGING_PREFIX=${CMAKE_STAGING_PREFIX}" \
    -D "CMAKE_INSTALL_PREFIX=${CMAKE_STAGING_PREFIX}" \
    -D BUILD_TESTS=OFF \
    -S "${SOURCE_DIRECTORY}" \
    -B "${BUILD_DIRECTORY}"

    cmake --build "${BUILD_DIRECTORY}" --target install

Интегрировать в структуру проекта

Рекомендуемая структура проекта:

|-- project
|----CMakeLists-txt
|----test
|------cmake
|--------Catch.cmake
|--------CatchAddTests.cmake
|--------FindCatch2.cmake
|--------ParseAndAddCatchTests.cmake
|------Main.cpp
|------ExampleTest1.cpp
|------ExampleTest2.cpp
|------CMakeLists.txt

Настройки в CMakeLists.txt проекта

include(CTest)

target_compile_definitions(${TARGET} PRIVATE
    TEST_DATA_PATH="${PROJECT_SOURCE_DIR}/data")

//set environment variable to ON if you want to enable testing
if (BUILD_TESTING)
    enable_testing()
    add_subdirectory(test)
endif()

Настройки в CMakeLists.txt тестового каталога.

cmake_minimum_required(VERSION 3.13)

list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/test/cmake")

set (WILDCARD_SOURCE *.cpp)

file(GLOB_RECURSE TEST_SOURCES ${WILDCARD_SOURCE})

add_executable(${TARGET_TEST} ${TEST_SOURCES})

find_package(Catch2 REQUIRED)

# Link to the desired libraries
target_link_libraries(${TARGET_TEST}
    PRIVATE
    Catch2::Catch2
    ...
)

target_compile_definitions(DcmlParserTest PRIVATE
    TEST_DATA_PATH="${PROJECT_SOURCE_DIR}/data")

include(ParseAndAddCatchTests)

ParseAndAddCatchTests(${TARGET_TEST}) 

Как использовать

Main.cpp

#define CATCH_CONFIG_MAIN
#include <catch2/catch.hpp>

ПримерTest.cpp

В этом примере показано, как протестировать с помощью SCENARIOS .

#include <catch2/catch.hpp>

#ifndef DATA_PATH
#define DATA_PATH "/tmp/data"
#endif

SCENARIO("testcase", "")
{
    GIVEN("usercase 1")
    {
        WHEN("instance is created")
        {
            THEN("test properties")
            {

                //check if true
                REQUIRE(...);

                /check if no exception
                REQUIRE_NOTHROW(...);

            }
        }
    }
}

ПримерTest2.cpp

В этом примере показано, как протестировать с помощью TEST_CASE .

#include <catch2/catch.hpp>

#ifndef DATA_PATH
#define DATA_PATH "/tmp/data"
#endif

TEST_CASE( "TestCase1", "" ) {

    REQUIRE( 1 == 1 );

}

TEST_CASE( "Testcase2", "" ) {

    REQUIRE( 3 != 1 );

}

Особое примечание к приложениям PLCnext

Чтобы использовать catch2 в качестве среды тестирования вы должны исключить содержимое ARP. Вы должны скомпилировать свой код с помощью локального компилятора gcc. С помощью этой настройки вы можете локально протестировать код без ARP.

Дополнительная информация

Если вы хотите получить дополнительную информацию о catch2 вы можете проверить следующую ссылку:

• GitHub:https://github.com/catchorg/Catch2

Лицензия

Библиотека опубликована под лицензией Boost Software License 1.0