[Offload] Make OffloadAPI gtest error messages more readable

[RossBrunton]

No description provided.

[llvmbot]

@llvm/pr-subscribers-offload

Author: Ross Brunton (RossBrunton)

Changes

---

Full diff: https://github.com/llvm/llvm-project/pull/140728.diff

1 Files Affected:

• (modified) offload/unittests/OffloadAPI/common/Fixtures.hpp (+8-1)

diff --git a/offload/unittests/OffloadAPI/common/Fixtures.hpp b/offload/unittests/OffloadAPI/common/Fixtures.hpp
index 2303601feb933..ff3c1f4194807 100644
--- a/offload/unittests/OffloadAPI/common/Fixtures.hpp
+++ b/offload/unittests/OffloadAPI/common/Fixtures.hpp
@@ -15,7 +15,14 @@
 #pragma once
 
 #ifndef ASSERT_SUCCESS
-#define ASSERT_SUCCESS(ACTUAL) ASSERT_EQ(OL_SUCCESS, ACTUAL)
+#define ASSERT_SUCCESS(ACTUAL)                                                 \
+  do {                                                                         \
+    ol_result_t Res = ACTUAL;                                                  \
+    if (Res && Res->Code != OL_ERRC_SUCCESS) {                                 \
+      GTEST_FAIL() << #ACTUAL " returned " << Res->Code << ": "                \
+                   << Res->Details;                                            \
+    }                                                                          \
+  } while (0)
 #endif
 
 // TODO: rework this so the EXPECTED/ACTUAL results are readable

[RossBrunton]

Example output on my system:

FAIL: Offload-Unit :: OffloadAPI/./offload.unittests/33/35 (4 of 35)
******************** TEST 'Offload-Unit :: OffloadAPI/./offload.unittests/33/35' FAILED ********************
Script(shard):
--
GTEST_OUTPUT=json:/home/ross/build/llvm-project.release/runtimes/runtimes-bins/offload/unittests/OffloadAPI/./offload.unittests-Offload-Unit-780349-33-35.json GTEST_SHUFFLE=0 GTEST_TOTAL_SHARD
S=35 GTEST_SHARD_INDEX=33 /home/ross/build/llvm-project.release/runtimes/runtimes-bins/offload/unittests/OffloadAPI/./offload.unittests
--

Script:
--
/home/ross/build/llvm-project.release/runtimes/runtimes-bins/offload/unittests/OffloadAPI/./offload.unittests --gtest_filter=olWaitEventTest.Success/AMDGPU_gfx1100
--
/home/ross/llvm-project/offload/unittests/OffloadAPI/event/olWaitEvent.cpp:26: Failure
Failed
olWaitEvent(Event) returned OL_ERRC_UNIMPLEMENTED: synchronize event not implemented


/home/ross/llvm-project/offload/unittests/OffloadAPI/event/olWaitEvent.cpp:26
Failed
olWaitEvent(Event) returned OL_ERRC_UNIMPLEMENTED: synchronize event not implemented



********************
********************
Failed Tests (1):
  Offload-Unit :: OffloadAPI/./offload.unittests/olWaitEventTest/Success/AMDGPU_gfx1100