LibTest: Support death tests without child process cloning

A challenge for getting LibTest working on Windows has always
been CrashTest. It implements death tests similar to Google Test
where a child process is cloned to invoke the expression that
should abort/terminate the program. Then the exit code of the
child is used by the parent test process to verify if the
application correctly aborted/terminated due to invoking
the expression.

The problem was that finding an equivalent way to port Crash::run()
to Windows was not looking very likely as publicly exposed Win32/
Native APIs have no equivalent to fork(); however, Windows actually
does have native support for process cloning via undocumented NT
APIs that clever people reverse engineered and published, see
`NtCreateUserProcess()`.

All that being said, this `EXPECT_DEATH()` implementation avoids
needing to use a child process in general, allowing us to remove
CrashTest in favour of a single cross-platform solution for death
tests.
This commit is contained in:
ayeteadoe 2025-05-15 07:55:33 -07:00 committed by Andrew Kaster
commit 744fd91d0b
Notes: github-actions[bot] 2025-05-16 19:24:44 +00:00
13 changed files with 133 additions and 101 deletions

View file

@ -7,11 +7,10 @@
#pragma once
#include <AK/Assertions.h>
#include <AK/CheckedFormatString.h>
#include <AK/Math.h>
#include <AK/SourceLocation.h>
#include <LibTest/CrashTest.h>
#include <LibTest/AssertionHandler.h>
#include <LibTest/Export.h>
#include <LibTest/Randomized/RandomnessSource.h>
#include <LibTest/TestResult.h>
@ -185,29 +184,32 @@ consteval void expect_consteval(T) { }
#define EXPECT_CONSTEVAL(...) ::Test::expect_consteval(__VA_ARGS__)
// To use, specify the lambda to execute in a sub process and verify it exits:
// EXPECT_CRASH("This should fail", []{
// return Test::Crash::Failure::DidNotCrash;
// });
#define EXPECT_CRASH(test_message, test_func) \
do { \
Test::Crash crash(test_message, test_func); \
if (!crash.run()) \
::Test::set_current_test_result(::Test::TestResult::Failed); \
#define EXPECT_DEATH(message, expression) \
do { \
::Test::set_assertion_jump_validity(true); \
if (LIBTEST_SETJMP(::Test::assertion_jump_buffer()) == 0) { \
(expression); \
::Test::set_assertion_jump_validity(false); \
if (::Test::is_reporting_enabled()) \
::AK::warnln("\033[31;1mFAIL\033[0m: {}:{}: EXPECT_DEATH({}) did not crash", __FILE__, __LINE__, message); \
::Test::set_current_test_result(::Test::TestResult::Failed); \
} else { \
::Test::set_assertion_jump_validity(false); \
} \
} while (false)
#define EXPECT_CRASH_WITH_SIGNAL(test_message, signal, test_func) \
do { \
Test::Crash crash(test_message, test_func, (signal)); \
if (!crash.run()) \
::Test::set_current_test_result(::Test::TestResult::Failed); \
} while (false)
#define EXPECT_NO_CRASH(test_message, test_func) \
do { \
Test::Crash crash(test_message, test_func, 0); \
if (!crash.run()) \
::Test::set_current_test_result(::Test::TestResult::Failed); \
#define EXPECT_NO_DEATH(message, expression) \
do { \
::Test::set_assertion_jump_validity(true); \
if (LIBTEST_SETJMP(::Test::assertion_jump_buffer()) == 0) { \
(expression); \
::Test::set_assertion_jump_validity(false); \
} else { \
::Test::set_assertion_jump_validity(false); \
if (::Test::is_reporting_enabled()) \
::AK::warnln("\033[31;1mFAIL\033[0m: {}:{}: EXPECT_NO_DEATH({}) crashed", __FILE__, __LINE__, message); \
::Test::set_current_test_result(::Test::TestResult::Failed); \
} \
} while (false)
#define TRY_OR_FAIL(expression) \