mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-19 01:26:45 +00:00
5dca0596a9
Summary: Many of our tests need to initialize certain subsystems/plugins of LLDB such as `FileSystem` or `HostInfo` by calling their static `Initialize` functions before the test starts and then calling `::Terminate` after the test is done (in reverse order). This adds a lot of error-prone boilerplate code to our testing code. This patch adds a RAII called SubsystemRAII that ensures that we always call ::Initialize and then call ::Terminate after the test is done (and that the Terminate calls are always in the reverse order of the ::Initialize calls). It also gets rid of all of the boilerplate that we had for these calls. Per-fixture initialization is still not very nice with this approach as it would require some kind of static unique_ptr that gets manually assigned/reseted from the gtest SetUpTestCase/TearDownTestCase functions. Because of that I changed all per-fixture setup to now do per-test setup which can be done by just having the SubsystemRAII as a member of the test fixture. This change doesn't influence our normal test runtime as LIT anyway runs each test case separately (and the Initialize/Terminate calls are anyway not very expensive). It will however make running all tests in a single executable slightly slower. Reviewers: labath, JDevlieghere, martong, espindola, shafik Reviewed By: labath Subscribers: mgorny, rnkovacs, emaste, MaskRay, abidh, lldb-commits Tags: #lldb Differential Revision: https://reviews.llvm.org/D71630
91 lines
2.8 KiB
C++
91 lines
2.8 KiB
C++
//===- SubsystemRAII.h ------------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_UNITTESTS_TESTINGSUPPORT_SUBSYSTEMRAII_H
|
|
#define LLDB_UNITTESTS_TESTINGSUPPORT_SUBSYSTEMRAII_H
|
|
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Testing/Support/Error.h"
|
|
#include "gtest/gtest.h"
|
|
#include <type_traits>
|
|
|
|
namespace lldb_private {
|
|
|
|
namespace detail {
|
|
/// Initializes and deinitializes a single subsystem.
|
|
/// @see SubsystemRAII
|
|
template <typename T> struct SubsystemRAIICase {
|
|
|
|
/// Calls ::Initialize if it has a void return type.
|
|
template <typename U = T>
|
|
typename std::enable_if<
|
|
std::is_same<decltype(U::Initialize()), void>::value>::type
|
|
CallInitialize() {
|
|
T::Initialize();
|
|
}
|
|
|
|
/// Calls ::Initialize if it has a llvm::Error return type and checks
|
|
/// the Error instance for success.
|
|
template <typename U = T>
|
|
typename std::enable_if<
|
|
std::is_same<decltype(U::Initialize()), llvm::Error>::value>::type
|
|
CallInitialize() {
|
|
ASSERT_THAT_ERROR(T::Initialize(), llvm::Succeeded());
|
|
}
|
|
|
|
SubsystemRAIICase() { CallInitialize(); }
|
|
~SubsystemRAIICase() { T::Terminate(); }
|
|
};
|
|
} // namespace detail
|
|
|
|
template <typename... T> class SubsystemRAII {};
|
|
|
|
/// RAII for initializing and deinitializing LLDB subsystems.
|
|
///
|
|
/// This RAII takes care of calling the Initialize and Terminate functions for
|
|
/// the subsystems specified by its template arguments. The ::Initialize
|
|
/// functions are called on construction for each subsystem template parameter
|
|
/// in the order in which they are passed as template parameters.
|
|
/// The ::Terminate functions are called in the reverse order at destruction
|
|
/// time.
|
|
///
|
|
/// If the ::Initialize function returns an llvm::Error this function handles
|
|
/// the Error instance (by checking that there is no error).
|
|
///
|
|
/// Constructing this RAII in a scope like this:
|
|
///
|
|
/// @code{.cpp}
|
|
/// {
|
|
/// SubsystemRAII<FileSystem, HostInfo, Socket> Subsystems;
|
|
/// DoingTestWork();
|
|
/// }
|
|
/// @endcode
|
|
///
|
|
/// is equivalent to the following code:
|
|
///
|
|
/// @code{.cpp}
|
|
/// {
|
|
/// FileSystem::Initialize();
|
|
/// HostInfo::Initialize();
|
|
/// ASSERT_THAT_ERROR(Socket::Initialize(), llvm::Succeeded());
|
|
///
|
|
/// DoingTestWork();
|
|
///
|
|
/// Socket::Terminate();
|
|
/// FileSystem::Terminate();
|
|
/// HostInfo::Terminate();
|
|
/// }
|
|
/// @endcode
|
|
template <typename T, typename... Ts> class SubsystemRAII<T, Ts...> {
|
|
detail::SubsystemRAIICase<T> CurrentSubsystem;
|
|
SubsystemRAII<Ts...> RemainingSubsystems;
|
|
};
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_UNITTESTS_TESTINGSUPPORT_SUBSYSTEMRAII_H
|