utest.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/utest/utest.hpp
/// @brief Versions of gtest macros that run tests in a coroutine environment
 
#include <chrono>
 
#include <gtest/gtest.h>
 
#include <userver/compiler/impl/asan.hpp>
#include <userver/engine/run_in_coro.hpp>  // legacy
#include <userver/utest/assert_macros.hpp>
#include <userver/utest/test_case_macros.hpp>
 
// gtest-specific serializers
namespace testing {
 
void PrintTo(std::chrono::seconds s, std::ostream* os);
void PrintTo(std::chrono::milliseconds ms, std::ostream* os);
void PrintTo(std::chrono::microseconds us, std::ostream* os);
void PrintTo(std::chrono::nanoseconds ns, std::ostream* os);
 
}  // namespace testing
 
USERVER_NAMESPACE_BEGIN
 
/// Mocks and test helpers
namespace utest {
 
/// The maximum time a typical test is allowed to execute. If exceeded, a
/// deadlock is assumed. This time must not be too low to avoid flaky tests.
///
/// Use this timeout for awaiting something that is expected to complete.
/// Use appropriate shorter timeouts for awaiting something that is not expected to ever complete.
inline constexpr std::chrono::seconds kMaxTestWaitTime(20);
 
}  // namespace utest
 
USERVER_NAMESPACE_END
 
#ifndef NDEBUG
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_DEBUG_TEST_NAME(name) DISABLED_##name
#else
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_DEBUG_TEST_NAME(name) name
#endif
 
#if USERVER_IMPL_HAS_ASAN
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_ASAN_TEST_NAME(name) DISABLED_##name
#else
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_ASAN_TEST_NAME(name) name
#endif
 
#ifdef __APPLE__
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_MAC_OS_TEST_NAME(name) DISABLED_##name
#else
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_MAC_OS_TEST_NAME(name) name
#endif
 
#ifdef _LIBCPP_VERSION
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_LIBCPP_TEST_NAME(name) DISABLED_##name
#else
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define DISABLED_IN_LIBCPP_TEST_NAME(name) name
#endif
 
/// @defgroup userver_utest Unit-testing (utest)
///
/// @brief Versions of gtest macros that run tests in a coroutine environment
/// and other helpers.
///
/// There are the following extensions:
///
/// 1. `_MT` ("multi-threaded") macro versions take 'thread_count' integer
///    as the 3rd parameter at the test definition. It specifies the number of
///    worker threads that should be created for the test. By default,
///    there is only 1 worker thread, which should be enough for most tests;
/// 2. The current thread count is available via
///    `engine::current_task::GetWorkerCount()`.
///
/// ## Usage examples:
/// @snippet core/src/engine/semaphore_test.cpp  UTEST macro example 1
/// @snippet core/src/engine/semaphore_test.cpp  UTEST macro example 2
///
/// See @ref scripts/docs/en/userver/testing.md for more usage examples and
/// descriptions
/// @{
 
/// @brief An equivalent of the gtest macro TEST that starts the test body as a
/// coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST(test_suite_name, test_name) IMPL_UTEST_TEST(test_suite_name, test_name, 1, false)
 
/// @brief An equivalent of the gtest macro TEST for death tests that starts the
/// test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_DEATH(test_suite_name, test_name) IMPL_UTEST_TEST(test_suite_name, test_name, 1, true)
 
/// @brief An equivalent of the gtest macro TEST that starts the test body as a
/// coroutine task
/// @param thread_count the number of threads to process tasks
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_MT(test_suite_name, test_name, thread_count)
    IMPL_UTEST_TEST(test_suite_name, test_name, thread_count, false)
 
/// @brief An equivalent of the gtest macro TEST_F that starts the test body as
/// a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_F(test_suite_name, test_name) IMPL_UTEST_TEST_F(test_suite_name, test_name, 1, false)
 
/// @brief An equivalent of the gtest macro TEST_F for death tests that starts
/// the test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_F_DEATH(test_suite_name, test_name) IMPL_UTEST_TEST_F(test_suite_name, test_name, 1, true)
 
/// @brief An equivalent of the gtest macro TEST_F that starts the test body as
/// a coroutine task
/// @param thread_count the number of threads to process tasks
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_F_MT(test_suite_name, test_name, thread_count)
    IMPL_UTEST_TEST_F(test_suite_name, test_name, thread_count, false)
 
/// @brief An equivalent of the gtest macro TEST_P that starts the test body as
/// a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_P(test_suite_name, test_name) IMPL_UTEST_TEST_P(test_suite_name, test_name, 1, false)
 
/// @brief An equivalent of the gtest macro TEST_P for death tests that starts
/// the test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_P_DEATH(test_suite_name, test_name) IMPL_UTEST_TEST_P(test_suite_name, test_name, 1, true)
 
/// @brief An equivalent of the gtest macro TEST_P that starts the test body as
/// a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define UTEST_P_MT(test_suite_name, test_name, thread_count)
    IMPL_UTEST_TEST_P(test_suite_name, test_name, thread_count, false)
 
/// @brief An equivalent of the gtest macro TYPED_TEST that starts the test body
/// as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define TYPED_UTEST(test_suite_name, test_name) IMPL_UTEST_TYPED_TEST(test_suite_name, test_name, 1, false)
 
/// @brief An equivalent of the gtest macro TYPED_TEST that starts the test body
/// as a coroutine task
/// @param thread_count the number of threads to process tasks
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define TYPED_UTEST_MT(test_suite_name, test_name, thread_count)
    IMPL_UTEST_TYPED_TEST(test_suite_name, test_name, thread_count, false)
 
/// @brief An equivalent of the gtest macro TYPED_TEST_P that starts the test
/// body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define TYPED_UTEST_P(test_suite_name, test_name) IMPL_UTEST_TYPED_TEST_P(test_suite_name, test_name, 1, false)
 
/// @brief An equivalent of the gtest macro TYPED_TEST_P that starts the test
/// body as a coroutine task
/// @param thread_count the number of threads to process tasks
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define TYPED_UTEST_P_MT(test_suite_name, test_name, thread_count)
    IMPL_UTEST_TYPED_TEST_P(test_suite_name, test_name, thread_count, false)
 
/// @brief An equivalent of the gtest macro TYPED_TEST_SUITE that starts the
/// test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define TYPED_UTEST_SUITE(test_suite_name, types)
    IMPL_UTEST_MAKE_USER_FIXTURE_ALIAS_TYPED(test_suite_name);
    namespace IMPL_UTEST_NAMESPACE_NAME(test_suite_name) {
    IMPL_UTEST_HIDE_USER_FIXTURE_BY_TEST_LAUNCHER_TYPED(test_suite_name)
    TYPED_TEST_SUITE(test_suite_name, types, USERVER_NAMESPACE::utest::impl::DefaultNameGenerator);
    }
    struct UtestImplForceSemicolon
 
/// @brief An equivalent of the gtest macro INSTANTIATE_TEST_SUITE_P that starts
/// the test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define INSTANTIATE_UTEST_SUITE_P(prefix, test_suite_name, ...)
    IMPL_UTEST_MAKE_USER_FIXTURE_ALIAS(test_suite_name);
    namespace IMPL_UTEST_NAMESPACE_NAME(test_suite_name) {
    IMPL_UTEST_HIDE_USER_FIXTURE_BY_TEST_LAUNCHER(
        test_suite_name,
        USERVER_NAMESPACE::utest::impl::TestLauncherParametric
    )
    INSTANTIATE_TEST_SUITE_P(prefix, test_suite_name, __VA_ARGS__);
    }
    struct UtestImplForceSemicolon
 
/// @brief An equivalent of the gtest macro REGISTER_TYPED_TEST_SUITE_P that
/// starts the test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define REGISTER_TYPED_UTEST_SUITE_P(test_suite_name, ...)
    namespace IMPL_UTEST_NAMESPACE_NAME(test_suite_name) {
    REGISTER_TYPED_TEST_SUITE_P(test_suite_name, __VA_ARGS__);
    }
    struct UtestImplForceSemicolon
 
/// @brief An equivalent of the gtest macro INSTANTIATE_TYPED_TEST_SUITE_P that
/// starts the test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define INSTANTIATE_TYPED_UTEST_SUITE_P(prefix, test_suite_name, types)
    namespace IMPL_UTEST_NAMESPACE_NAME(test_suite_name) {
    INSTANTIATE_TYPED_TEST_SUITE_P(
        prefix,
        test_suite_name,
        types,
        USERVER_NAMESPACE::utest::impl::DefaultNameGenerator
    );
    }
    struct UtestImplForceSemicolon
 
/// @brief An equivalent of the gtest macro TYPED_TEST_SUITE_P that starts the
/// test body as a coroutine task
/// @hideinitializer
// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
#define TYPED_UTEST_SUITE_P(test_suite_name)
    IMPL_UTEST_MAKE_USER_FIXTURE_ALIAS_TYPED(test_suite_name);
    namespace IMPL_UTEST_NAMESPACE_NAME(test_suite_name) {
    IMPL_UTEST_HIDE_USER_FIXTURE_BY_TEST_LAUNCHER_TYPED(test_suite_name)
    TYPED_TEST_SUITE_P(test_suite_name);
    }
    struct UtestImplForceSemicolon
/// @}