#include "base/test/test_suite.h"
#include <signal.h>
#include <memory>
#include "base/allocator/partition_allocator/partition_alloc_buildflags.h"
#include "base/allocator/partition_allocator/tagging.h"
#include "base/at_exit.h"
#include "base/base_paths.h"
#include "base/base_switches.h"
#include "base/command_line.h"
#include "base/debug/asan_service.h"
#include "base/debug/debugger.h"
#include "base/debug/profiler.h"
#include "base/debug/stack_trace.h"
#include "base/feature_list.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/i18n/icu_util.h"
#include "base/i18n/rtl.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/memory/raw_ptr_exclusion.h"
#include "base/no_destructor.h"
#include "base/path_service.h"
#include "base/process/launch.h"
#include "base/process/memory.h"
#include "base/process/process.h"
#include "base/process/process_handle.h"
#include "base/strings/string_piece.h"
#include "base/task/thread_pool/thread_pool_instance.h"
#include "base/test/gtest_xml_unittest_result_printer.h"
#include "base/test/gtest_xml_util.h"
#include "base/test/icu_test_util.h"
#include "base/test/launcher/unit_test_launcher.h"
#include "base/test/mock_entropy_provider.h"
#include "base/test/multiprocess_test.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/scoped_run_loop_timeout.h"
#include "base/test/test_switches.h"
#include "base/test/test_timeouts.h"
#include "base/threading/platform_thread.h"
#include "base/time/time.h"
#include "base/tracing_buildflags.h"
#include "build/build_config.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "testing/multiprocess_func_list.h"
#if BUILDFLAG(IS_APPLE)
#include "base/mac/scoped_nsautorelease_pool.h"
#endif
#if BUILDFLAG(IS_IOS)
#include "base/test/test_listener_ios.h"
#include "base/test/test_support_ios.h"
#else
#include "base/strings/string_util.h"
#include "third_party/icu/source/common/unicode/uloc.h"
#endif
#if BUILDFLAG(IS_ANDROID)
#include "base/test/test_support_android.h"
#endif
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
#include "third_party/test_fonts/fontconfig/fontconfig_util_linux.h"
#endif
#if BUILDFLAG(IS_FUCHSIA)
#include "base/fuchsia/system_info.h"
#endif
#if BUILDFLAG(IS_WIN)
#if defined(_DEBUG)
#include <crtdbg.h>
#endif
#include <windows.h>
#include "base/debug/handle_hooks_win.h"
#endif
#if BUILDFLAG(USE_PARTITION_ALLOC)
#include "base/allocator/partition_alloc_support.h"
#endif
namespace base {
namespace {
bool IsMarkedMaybe(const testing::TestInfo& test) {
return strncmp(test.name(), "MAYBE_", 6) == 0;
}
class DisableMaybeTests : public testing::EmptyTestEventListener {
public:
void OnTestStart(const testing::TestInfo& test_info) override {
ASSERT_FALSE(IsMarkedMaybe(test_info))
<< "Probably the OS #ifdefs don't include all of the necessary "
"platforms.\nPlease ensure that no tests have the MAYBE_ prefix "
"after the code is preprocessed.";
}
};
class ResetCommandLineBetweenTests : public testing::EmptyTestEventListener {
public:
ResetCommandLineBetweenTests() : old_command_line_(CommandLine::NO_PROGRAM) {}
ResetCommandLineBetweenTests(const ResetCommandLineBetweenTests&) = delete;
ResetCommandLineBetweenTests& operator=(const ResetCommandLineBetweenTests&) =
delete;
void OnTestStart(const testing::TestInfo& test_info) override {
old_command_line_ = *CommandLine::ForCurrentProcess();
}
void OnTestEnd(const testing::TestInfo& test_info) override {
*CommandLine::ForCurrentProcess() = old_command_line_;
}
private:
CommandLine old_command_line_;
};
class FeatureListScopedToEachTest : public testing::EmptyTestEventListener {
public:
FeatureListScopedToEachTest() = default;
~FeatureListScopedToEachTest() override = default;
FeatureListScopedToEachTest(const FeatureListScopedToEachTest&) = delete;
FeatureListScopedToEachTest& operator=(const FeatureListScopedToEachTest&) =
delete;
void OnTestStart(const testing::TestInfo& test_info) override {
const CommandLine* command_line = CommandLine::ForCurrentProcess();
std::string enabled =
command_line->GetSwitchValueASCII(switches::kEnableFeatures);
std::string disabled =
command_line->GetSwitchValueASCII(switches::kDisableFeatures);
enabled += ",TestFeatureForBrowserTest1";
disabled += ",TestFeatureForBrowserTest2";
scoped_feature_list_.InitFromCommandLine(enabled, disabled);
CommandLine new_command_line(command_line->GetProgram());
CommandLine::SwitchMap switches = command_line->GetSwitches();
switches.erase(switches::kEnableFeatures);
switches.erase(switches::kDisableFeatures);
for (const auto& iter : switches)
new_command_line.AppendSwitchNative(iter.first, iter.second);
*CommandLine::ForCurrentProcess() = new_command_line;
#if BUILDFLAG(USE_PARTITION_ALLOC) && !defined(ADDRESS_SANITIZER)
allocator::PartitionAllocSupport::Get()->ReconfigureAfterFeatureListInit(
"", false);
#endif
}
void OnTestEnd(const testing::TestInfo& test_info) override {
scoped_feature_list_.Reset();
}
private:
test::ScopedFeatureList scoped_feature_list_;
};
class CheckForLeakedGlobals : public testing::EmptyTestEventListener {
public:
CheckForLeakedGlobals() = default;
CheckForLeakedGlobals(const CheckForLeakedGlobals&) = delete;
CheckForLeakedGlobals& operator=(const CheckForLeakedGlobals&) = delete;
void OnTestStart(const testing::TestInfo& test) override {
feature_list_set_before_test_ = FeatureList::GetInstance();
thread_pool_set_before_test_ = ThreadPoolInstance::Get();
}
void OnTestEnd(const testing::TestInfo& test) override {
DCHECK_EQ(feature_list_set_before_test_, FeatureList::GetInstance())
<< " in test " << test.test_case_name() << "." << test.name();
DCHECK_EQ(thread_pool_set_before_test_, ThreadPoolInstance::Get())
<< " in test " << test.test_case_name() << "." << test.name();
}
void OnTestCaseStart(const testing::TestCase& test_case) override {
feature_list_set_before_case_ = FeatureList::GetInstance();
thread_pool_set_before_case_ = ThreadPoolInstance::Get();
}
void OnTestCaseEnd(const testing::TestCase& test_case) override {
DCHECK_EQ(feature_list_set_before_case_, FeatureList::GetInstance())
<< " in case " << test_case.name();
DCHECK_EQ(thread_pool_set_before_case_, ThreadPoolInstance::Get())
<< " in case " << test_case.name();
}
private:
RAW_PTR_EXCLUSION FeatureList* feature_list_set_before_test_ = nullptr;
RAW_PTR_EXCLUSION FeatureList* feature_list_set_before_case_ = nullptr;
RAW_PTR_EXCLUSION ThreadPoolInstance* thread_pool_set_before_test_ = nullptr;
RAW_PTR_EXCLUSION ThreadPoolInstance* thread_pool_set_before_case_ = nullptr;
};
#if !BUILDFLAG(IS_APPLE)
class CheckProcessPriority : public testing::EmptyTestEventListener {
public:
CheckProcessPriority() { CHECK(!IsProcessBackgrounded()); }
CheckProcessPriority(const CheckProcessPriority&) = delete;
CheckProcessPriority& operator=(const CheckProcessPriority&) = delete;
void OnTestStart(const testing::TestInfo& test) override {
EXPECT_FALSE(IsProcessBackgrounded());
}
void OnTestEnd(const testing::TestInfo& test) override {
EXPECT_FALSE(IsProcessBackgrounded());
}
private:
bool IsProcessBackgrounded() const {
return Process::Current().IsProcessBackgrounded();
}
};
#endif
const std::string& GetProfileName() {
static const NoDestructor<std::string> profile_name([]() {
const CommandLine& command_line = *CommandLine::ForCurrentProcess();
if (command_line.HasSwitch(switches::kProfilingFile))
return command_line.GetSwitchValueASCII(switches::kProfilingFile);
else
return std::string("test-profile-{pid}");
}());
return *profile_name;
}
void InitializeLogging() {
#if BUILDFLAG(IS_FUCHSIA)
constexpr auto kLoggingDest = logging::LOG_TO_STDERR;
#else
constexpr auto kLoggingDest =
logging::LOG_TO_SYSTEM_DEBUG_LOG | logging::LOG_TO_STDERR;
#endif
CHECK(logging::InitLogging({.logging_dest = kLoggingDest}));
#if BUILDFLAG(IS_ANDROID)
logging::SetLogItems(false, false, false, false);
#else
logging::SetLogItems(true, true, false, false);
#endif
}
}
int RunUnitTestsUsingBaseTestSuite(int argc, char** argv) {
TestSuite test_suite(argc, argv);
return LaunchUnitTests(argc, argv,
BindOnce(&TestSuite::Run, Unretained(&test_suite)));
}
TestSuite::TestSuite(int argc, char** argv) {
PreInitialize();
InitializeFromCommandLine(argc, argv);
InitializeLogging();
}
#if BUILDFLAG(IS_WIN)
TestSuite::TestSuite(int argc, wchar_t** argv) {
PreInitialize();
InitializeFromCommandLine(argc, argv);
InitializeLogging();
}
#endif
TestSuite::~TestSuite() {
if (initialized_command_line_)
CommandLine::Reset();
}
void TestSuite::InitializeFromCommandLine(int argc, char** argv) {
initialized_command_line_ = CommandLine::Init(argc, argv);
testing::InitGoogleTest(&argc, argv);
testing::InitGoogleMock(&argc, argv);
#if BUILDFLAG(IS_IOS)
InitIOSArgs(argc, argv);
#endif
}
#if BUILDFLAG(IS_WIN)
void TestSuite::InitializeFromCommandLine(int argc, wchar_t** argv) {
initialized_command_line_ = CommandLine::Init(argc, NULL);
testing::InitGoogleTest(&argc, argv);
testing::InitGoogleMock(&argc, argv);
}
#endif
void TestSuite::PreInitialize() {
DCHECK(!is_initialized_);
#if BUILDFLAG(IS_WIN)
base::debug::HandleHooks::PatchLoadedModules();
#endif
#if !BUILDFLAG(IS_ANDROID)
testing::GTEST_FLAG(death_test_style) = "threadsafe";
#endif
#if BUILDFLAG(IS_WIN)
testing::GTEST_FLAG(catch_exceptions) = false;
#endif
EnableTerminationOnHeapCorruption();
#if (BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)) && defined(USE_AURA)
setlocale(LC_ALL, "");
setlocale(LC_NUMERIC, "C");
#endif
#if !BUILDFLAG(IS_ANDROID)
at_exit_manager_ = std::make_unique<AtExitManager>();
#endif
}
void TestSuite::AddTestLauncherResultPrinter() {
if (!CommandLine::ForCurrentProcess()->HasSwitch(
switches::kTestLauncherOutput)) {
return;
}
FilePath output_path(CommandLine::ForCurrentProcess()->GetSwitchValuePath(
switches::kTestLauncherOutput));
if (PathExists(output_path)) {
LOG(WARNING) << "Test launcher output path " << output_path.AsUTF8Unsafe()
<< " exists. Not adding test launcher result printer.";
return;
}
printer_ = new XmlUnitTestResultPrinter;
CHECK(printer_->Initialize(output_path))
<< "Output path is " << output_path.AsUTF8Unsafe()
<< " and PathExists(output_path) is " << PathExists(output_path);
testing::TestEventListeners& listeners =
testing::UnitTest::GetInstance()->listeners();
listeners.Append(printer_);
}
int TestSuite::Run() {
#if BUILDFLAG(IS_APPLE)
mac::ScopedNSAutoreleasePool scoped_pool;
#endif
std::string client_func =
CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
switches::kTestChildProcess);
#if BUILDFLAG(IS_FUCHSIA)
if (client_func.empty())
CHECK(FetchAndCacheSystemInfo());
#endif
Initialize();
if (!client_func.empty())
return multi_process_function_list::InvokeChildProcessTest(client_func);
#if BUILDFLAG(IS_IOS)
test_listener_ios::RegisterTestEndListener();
#endif
#if BUILDFLAG(IS_LINUX)
::partition_alloc::ChangeMemoryTaggingModeForCurrentThread(
::partition_alloc::TagViolationReportingMode::kSynchronous);
#elif BUILDFLAG(IS_ANDROID)
#endif
int result = RUN_ALL_TESTS();
#if BUILDFLAG(IS_APPLE)
scoped_pool.Recycle();
#endif
Shutdown();
return result;
}
void TestSuite::DisableCheckForLeakedGlobals() {
DCHECK(!is_initialized_);
check_for_leaked_globals_ = false;
}
void TestSuite::DisableCheckForThreadAndProcessPriority() {
DCHECK(!is_initialized_);
check_for_thread_and_process_priority_ = false;
}
void TestSuite::UnitTestAssertHandler(const char* file,
int line,
const StringPiece summary,
const StringPiece stack_trace) {
#if BUILDFLAG(IS_ANDROID)
const ::testing::TestInfo* const test_info =
::testing::UnitTest::GetInstance()->current_test_info();
if (test_info) {
LOG(ERROR) << "Currently running: " << test_info->test_case_name() << "."
<< test_info->name();
fflush(stderr);
}
#endif
if (printer_) {
const std::string summary_str(summary);
const std::string stack_trace_str = summary_str + std::string(stack_trace);
printer_->OnAssert(file, line, summary_str, stack_trace_str);
}
_exit(1);
}
#if BUILDFLAG(IS_WIN)
namespace {
void InvalidParameter(const wchar_t* expression,
const wchar_t* function,
const wchar_t* file,
unsigned int line,
uintptr_t reserved) {
__debugbreak();
_exit(1);
}
void PureCall() {
fprintf(stderr, "Pure-virtual function call. Terminating.\n");
__debugbreak();
_exit(1);
}
void AbortHandler(int signal) {
fprintf(stderr, "\n");
__debugbreak();
}
}
#endif
void TestSuite::SuppressErrorDialogs() {
#if BUILDFLAG(IS_WIN)
UINT new_flags =
SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX;
UINT existing_flags = SetErrorMode(new_flags);
SetErrorMode(existing_flags | new_flags);
#if defined(_DEBUG)
_CrtSetReportFile(_CRT_ASSERT, _CRTDBG_FILE_STDERR);
_CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_FILE | _CRTDBG_MODE_DEBUG);
_CrtSetReportFile(_CRT_ERROR, _CRTDBG_FILE_STDERR);
_CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_FILE | _CRTDBG_MODE_DEBUG);
#endif
_set_invalid_parameter_handler(InvalidParameter);
_set_purecall_handler(PureCall);
signal(SIGABRT, AbortHandler);
#endif
}
void TestSuite::Initialize() {
DCHECK(!is_initialized_);
#if defined(ADDRESS_SANITIZER)
base::debug::AsanService::GetInstance()->Initialize();
#endif
#if BUILDFLAG(USE_PARTITION_ALLOC) && !defined(ADDRESS_SANITIZER)
allocator::PartitionAllocSupport::Get()->ReconfigureForTests();
#endif
test::ScopedRunLoopTimeout::SetAddGTestFailureOnTimeout();
const CommandLine* command_line = CommandLine::ForCurrentProcess();
#if !BUILDFLAG(IS_IOS)
if (command_line->HasSwitch(switches::kWaitForDebugger)) {
debug::WaitForDebugger(60, true);
}
#endif
#if BUILDFLAG(DCHECK_IS_CONFIGURABLE)
if (command_line->HasSwitch("gtest_internal_run_death_test"))
logging::LOGGING_DCHECK = logging::LOG_FATAL;
#endif
#if BUILDFLAG(IS_IOS)
InitIOSTestMessageLoop();
#endif
#if BUILDFLAG(IS_ANDROID)
InitAndroidTestMessageLoop();
#endif
CHECK(debug::EnableInProcessStackDumping());
#if BUILDFLAG(IS_WIN)
RouteStdioToConsole(true);
Time::EnableHighResolutionTimer(true);
#endif
if (!debug::BeingDebugged() &&
!command_line->HasSwitch("show-error-dialogs")) {
SuppressErrorDialogs();
debug::SetSuppressDebugUI(true);
assert_handler_ = std::make_unique<logging::ScopedLogAssertHandler>(
BindRepeating(&TestSuite::UnitTestAssertHandler, Unretained(this)));
}
test::InitializeICUForTesting();
i18n::SetICUDefaultLocale("en_US");
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
test_fonts::SetUpFontconfig();
#endif
testing::TestEventListeners& listeners =
testing::UnitTest::GetInstance()->listeners();
listeners.Append(new DisableMaybeTests);
listeners.Append(new ResetCommandLineBetweenTests);
listeners.Append(new FeatureListScopedToEachTest);
if (check_for_leaked_globals_)
listeners.Append(new CheckForLeakedGlobals);
if (check_for_thread_and_process_priority_) {
#if !BUILDFLAG(IS_APPLE)
listeners.Append(new CheckProcessPriority);
#endif
}
AddTestLauncherResultPrinter();
TestTimeouts::Initialize();
#if BUILDFLAG(ENABLE_BASE_TRACING)
trace_to_file_.BeginTracingFromCommandLineOptions();
#endif
debug::StartProfiling(GetProfileName());
debug::VerifyDebugger();
is_initialized_ = true;
}
void TestSuite::Shutdown() {
DCHECK(is_initialized_);
debug::StopProfiling();
}
}