Skip to content

Add meaningful matchers to death tests #17401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rascani merged 2 commits into from
Feb 12, 2026
Merged

Add meaningful matchers to death tests #17401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
848ff58
Add meaningful matchers to death tests
rascani Feb 11, 2026
739d0a8
Add ET_EXPECT_DEATH_NO_PAL_INIT for uninitialized PAL tests
rascani Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion devtools/etdump/tests/etdump_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,9 @@ TEST_F(ProfilerETDumpTest, AddAllocators) {
// Add a profiling event and then try to add an allocator which should fail.
EventTracerEntry entry = etdump_gen[i]->start_profiling("test_event", 0, 1);
etdump_gen[i]->end_profiling(entry);
ET_EXPECT_DEATH(etdump_gen[i]->track_allocator("test_allocator"), "");
ET_EXPECT_DEATH(
etdump_gen[i]->track_allocator("test_allocator"),
"before any events are added");
}
}

Expand Down
3 changes: 2 additions & 1 deletion extension/aten_util/test/aten_bridge_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ TEST(ATenBridgeTest, AliasATTensorToETensorFailDimOrder) {
dim_order.data(),
strides.data());
torch::executor::Tensor etensor(&tensor_impl);
ET_EXPECT_DEATH(alias_attensor_to_etensor(etensor), "");
ET_EXPECT_DEATH(
alias_attensor_to_etensor(etensor), "Strides don't match dim order");
}

TEST(ATenBridgeTest, AliasETensorToATenTensorChannelsLast) {
Expand Down
2 changes: 1 addition & 1 deletion runtime/core/exec_aten/util/test/operator_impl_example_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ TEST(OperatorImplExampleTest, UnhandledDtypeDies) {

// Adding the two boolean tensors should cause an assertion and kill the
// test process.
ET_EXPECT_DEATH(add_tensors_op(a, b, out), "");
ET_EXPECT_DEATH(add_tensors_op(a, b, out), "Unhandled dtype");
}

TEST(OpAddOutKernelTest, MismatchedInputDimsDies) {
Expand Down
10 changes: 6 additions & 4 deletions runtime/core/exec_aten/util/test/scalar_type_util_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,15 @@ TEST(ScalarTypeUtilTest, IsValidFalse) {
TEST(ScalarTypeUtilTest, UnknownTypeElementSizeDies) {
// Undefined, which is sort of a special case since it's not part of the
// iteration macros but is still a part of the enum.
ET_EXPECT_DEATH(elementSize(ScalarType::Undefined), "");
ET_EXPECT_DEATH(elementSize(ScalarType::Undefined), "Unknown ScalarType");

// Some out-of-range types, also demonstrating that NumOptions is not really a
// scalar type.
ET_EXPECT_DEATH(elementSize(ScalarType::NumOptions), "");
ET_EXPECT_DEATH(elementSize(static_cast<ScalarType>(127)), "");
ET_EXPECT_DEATH(elementSize(static_cast<ScalarType>(-1)), "");
ET_EXPECT_DEATH(elementSize(ScalarType::NumOptions), "Unknown ScalarType");
ET_EXPECT_DEATH(
elementSize(static_cast<ScalarType>(127)), "Unknown ScalarType");
ET_EXPECT_DEATH(
elementSize(static_cast<ScalarType>(-1)), "Unknown ScalarType");
}

TEST(ScalarTypeUtilTest, canCastTest) {
Expand Down
3 changes: 2 additions & 1 deletion runtime/core/exec_aten/util/test/tensor_util_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,8 @@ TEST_F(TensorUtilTest, ContiguousCheckSupported) {
ET_CHECK_CONTIGUOUS(t_contiguous);

// Assert t_incontiguous is incontiguous.
ET_EXPECT_DEATH(ET_CHECK_CONTIGUOUS(t_incontiguous), "");
ET_EXPECT_DEATH(
ET_CHECK_CONTIGUOUS(t_incontiguous), "stride of the.*dimension shall");
}

TEST_F(TensorUtilTest, CheckSameContiguousStrideSupported) {
Expand Down
4 changes: 2 additions & 2 deletions runtime/executor/test/memory_manager_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ TEST(MemoryManagerTest, DeprecatedCtorWithSameAllocator) {
/*non_constant_allocator=*/&planned_memory,
/*runtime_allocator=*/&method_allocator,
/*temp_allocator=*/&method_allocator),
"");
"cannot be the same");
}

TEST(MemoryManagerTest, CtorWithSameAllocator) {
Expand All @@ -91,5 +91,5 @@ TEST(MemoryManagerTest, CtorWithSameAllocator) {
/*runtime_allocator=*/&method_allocator,
/*non_constant_allocator=*/&planned_memory,
/*temp_allocator=*/&method_allocator),
"");
"cannot be the same");
}
16 changes: 8 additions & 8 deletions runtime/executor/test/method_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@ TEST_F(MethodTest, GetInputTests) {
method->get_input(num_inputs - 1);

// Out-of-range inputs should abort.
ET_EXPECT_DEATH(method->get_input(num_inputs), "");
ET_EXPECT_DEATH(method->get_input(num_inputs + 1), "");
ET_EXPECT_DEATH(method->get_input(num_inputs), "[0-9]+ >= [0-9]+");
ET_EXPECT_DEATH(method->get_input(num_inputs + 1), "[0-9]+ >= [0-9]+");
}

TEST_F(MethodTest, MutableInputTests) {
Expand All @@ -157,8 +157,8 @@ TEST_F(MethodTest, MutableInputTests) {
method->mutable_input(num_inputs - 1);

// Out-of-range inputs should abort.
ET_EXPECT_DEATH(method->mutable_input(num_inputs), "");
ET_EXPECT_DEATH(method->mutable_input(num_inputs + 1), "");
ET_EXPECT_DEATH(method->mutable_input(num_inputs), "[0-9]+ >= [0-9]+");
ET_EXPECT_DEATH(method->mutable_input(num_inputs + 1), "[0-9]+ >= [0-9]+");
}

TEST_F(MethodTest, GetOutputTests) {
Expand All @@ -174,8 +174,8 @@ TEST_F(MethodTest, GetOutputTests) {
method->get_output(num_outputs - 1);

// Out-of-range outputs should abort.
ET_EXPECT_DEATH(method->get_output(num_outputs), "");
ET_EXPECT_DEATH(method->get_output(num_outputs + 1), "");
ET_EXPECT_DEATH(method->get_output(num_outputs), "[0-9]+ >= [0-9]+");
ET_EXPECT_DEATH(method->get_output(num_outputs + 1), "[0-9]+ >= [0-9]+");
}

TEST_F(MethodTest, MutableOutputTests) {
Expand All @@ -191,8 +191,8 @@ TEST_F(MethodTest, MutableOutputTests) {
method->mutable_output(num_outputs - 1);

// Out-of-range outputs should abort.
ET_EXPECT_DEATH(method->mutable_output(num_outputs), "");
ET_EXPECT_DEATH(method->mutable_output(num_outputs + 1), "");
ET_EXPECT_DEATH(method->mutable_output(num_outputs), "[0-9]+ >= [0-9]+");
ET_EXPECT_DEATH(method->mutable_output(num_outputs + 1), "[0-9]+ >= [0-9]+");
}

TEST_F(MethodTest, SetPrimInputTest) {
Expand Down
4 changes: 2 additions & 2 deletions runtime/kernel/test/operator_registry_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ TEST_F(OperatorRegistryTest, RegisterOpsMoreThanOnceDie) {
Kernel("foo", [](KernelRuntimeContext&, Span<EValue*>) {}),
Kernel("foo", [](KernelRuntimeContext&, Span<EValue*>) {})};
Span<const Kernel> kernels_span = Span<const Kernel>(kernels);
ET_EXPECT_DEATH({ (void)register_kernels(kernels_span); }, "");
ET_EXPECT_DEATH((void)register_kernels(kernels_span), "registration failed");
}

TEST_F(OperatorRegistryTest, KernelKeyEquals) {
Expand Down Expand Up @@ -408,7 +408,7 @@ TEST_F(OperatorRegistryTest, DoubleRegisterKernelsDies) {
});
Kernel kernels[] = {kernel_1, kernel_2};
// clang-tidy off
ET_EXPECT_DEATH({ (void)register_kernels(kernels); }, "");
ET_EXPECT_DEATH((void)register_kernels(kernels), "registration failed");
// clang-tidy on
}

Expand Down
4 changes: 1 addition & 3 deletions runtime/platform/test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ et_cxx_test(
executor_pal_static_runtime_override_test.cpp
)

# TODO: Re-enable this test on OSS
#
# et_cxx_test(platform_death_test SOURCES executor_pal_death_test.cpp)
et_cxx_test(platform_death_test SOURCES executor_pal_death_test.cpp)

# No weak function symbols on Windows/MSVC, thus PAL intercept doesn't work.
# Skip logging tests in Release mode.
Expand Down
7 changes: 4 additions & 3 deletions runtime/platform/test/executor_pal_death_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,15 @@ TEST(ExecutorPalTest, UninitializedPalDeath) {

#ifndef NDEBUG

ET_EXPECT_DEATH({ et_pal_current_ticks(); }, "");
ET_EXPECT_DEATH_NO_PAL_INIT(
{ et_pal_current_ticks(); }, "PAL must be initialized");

ET_EXPECT_DEATH(
ET_EXPECT_DEATH_NO_PAL_INIT(
{
et_pal_emit_log_message(
0, et_pal_log_level_t::kFatal, "", "", 0, "", 0);
},
"");
"PAL must be initialized");

#endif // !defined(NDEBUG)
}
Expand Down
22 changes: 22 additions & 0 deletions test/utils/DeathTest.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#include <gtest/gtest.h>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>

#ifndef ET_BUILD_MODE_COV
#define ET_BUILD_MODE_COV 0
Expand All @@ -30,6 +31,7 @@
* tests.
*/
#define ET_EXPECT_DEATH(_statement, _matcher) ((void)0)
#define ET_EXPECT_DEATH_NO_PAL_INIT(_statement, _matcher) ((void)0)

#elif defined(_WIN32) || !ET_LOG_ENABLED

Expand All @@ -40,6 +42,14 @@
* causes the process to terminate.
*/
#define ET_EXPECT_DEATH(_statement, _matcher) \
EXPECT_DEATH_IF_SUPPORTED( \
{ \
et_pal_init(); \
_statement; \
}, \
"")

#define ET_EXPECT_DEATH_NO_PAL_INIT(_statement, _matcher) \
EXPECT_DEATH_IF_SUPPORTED(_statement, "")

#else // ET_BUILD_MODE_COV
Expand All @@ -52,6 +62,18 @@
* the dying process. If this does not match, the test will fail.
*/
#define ET_EXPECT_DEATH(_statement, _matcher) \
EXPECT_DEATH_IF_SUPPORTED( \
{ \
et_pal_init(); \
Copy link
Contributor Author

@rascani rascani Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like adding this broke the executor_pal_death_test that was testing to make sure other PAL functions failed if this hadn't been called.

Copy link
Contributor Author

@rascani rascani Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a EXPECT_DEATH_NO_PAL_INIT variation.

_statement; \
}, \
_matcher)

/**
* Like ET_EXPECT_DEATH but without PAL initialization.
* Use this only for tests that specifically test uninitialized PAL behavior.
*/
#define ET_EXPECT_DEATH_NO_PAL_INIT(_statement, _matcher) \
EXPECT_DEATH_IF_SUPPORTED(_statement, _matcher)

#endif // ET_BUILD_MODE_COV
Loading