TestEngine: *BREAKING* reworked ImGuiTestEngine_GetResult() as ImGuiTestEngine_GetResultSummary().

Author: ocornut

docs/CHANGELOG.txt

@@ -6,6 +6,11 @@ CHANGELOG
 ** For a while this is going to ONLY INCLUDE BREAKING CHANGES.
 
 2025/03/17:
+- TestEngine: *BREAKING* reworked ImGuiTestEngine_GetResult() as ImGuiTestEngine_GetResultSummary()
+  outputting a structure where we can add more fields.
+    Prev:  void ImGuiTestEngine_GetResult(ImGuiTestEngine* engine, int& count_tested, int& count_passed);
+    Now:   void ImGuiTestEngine_GetResultSummary(ImGuiTestEngine* engine, ImGuiTestEngineResultSummary* out_result);
+  New structure include the number of tests remaining in queue (for when aborting or crashing).
 - TestEngine: helper crash handler installed by ImGuiTestEngine_InstallDefaultCrashHandler()
   always print a crash string and extra info, even if result export settings are set to None.
 

imgui_test_engine/imgui_te_engine.cpp

@@ -1458,20 +1458,30 @@ void ImGuiTestEngine_UpdateTestsSourceLines(ImGuiTestEngine* engine)
         }
 }
 
-void ImGuiTestEngine_GetResult(ImGuiTestEngine* engine, int& count_tested, int& count_success)
+// count_remaining could be >0 if e.g. called during a crash handler or aborting a run.
+void ImGuiTestEngine_GetResultSummary(ImGuiTestEngine* engine, ImGuiTestEngineResultSummary* out_results)
 {
-    count_tested = 0;
-    count_success = 0;
+    int count_tested = 0;
+    int count_success = 0;
+    int count_remaining = 0;
     for (int n = 0; n < engine->TestsAll.Size; n++)
     {
         ImGuiTest* test = engine->TestsAll[n];
-        if (test->Output.Status == ImGuiTestStatus_Unknown || test->Output.Status == ImGuiTestStatus_Queued)
+        if (test->Output.Status == ImGuiTestStatus_Unknown)
             continue;
+        if (test->Output.Status == ImGuiTestStatus_Queued)
+        {
+            count_remaining++;
+            continue;
+        }
         IM_ASSERT(test->Output.Status != ImGuiTestStatus_Running);
         count_tested++;
         if (test->Output.Status == ImGuiTestStatus_Success)
             count_success++;
     }
+    out_results->CountTested = count_tested;
+    out_results->CountSuccess = count_success;
+    out_results->CountInQueue = count_remaining;
 }
 
 // Get a copy of the test list

imgui_test_engine/imgui_te_engine.h

@@ -43,6 +43,7 @@ struct ImGuiTestContext;            // Context while a test is running
 struct ImGuiTestCoroutineInterface; // Interface to expose coroutine functions (imgui_te_coroutine provides a default implementation for C++11 using std::thread, but you may use your own)
 struct ImGuiTestEngine;             // Test engine instance
 struct ImGuiTestEngineIO;           // Test engine public I/O
+struct ImGuiTestEngineResultSummary;// Output of ImGuiTestEngine_GetResultSummary()
 struct ImGuiTestItemInfo;           // Info queried from item (id, geometry, status flags, debug label)
 struct ImGuiTestItemList;           // A list of items
 struct ImGuiTestInputs;             // Simulated user inputs (will be fed into ImGuiIO by the test engine)
@@ -153,6 +154,13 @@ enum ImGuiTestRunFlags_
     // TODO: Add GuiFunc options
 };
 
+struct ImGuiTestEngineResultSummary
+{
+    int     CountTested = 0;    // Number of tests executed
+    int     CountSuccess = 0;   // Number of tests succeeded
+    int     CountInQueue = 0;   // Number of tests remaining in queue (e.g. aborted, crashed)
+};
+
 //-------------------------------------------------------------------------
 // Functions
 //-------------------------------------------------------------------------
@@ -206,10 +214,15 @@ IMGUI_API ImGuiTest*          ImGuiTestEngine_FindTestByName(ImGuiTestEngine* en
 // FIXME: Clarify API to avoid function calls vs raw bools in ImGuiTestEngineIO
 IMGUI_API bool                ImGuiTestEngine_IsTestQueueEmpty(ImGuiTestEngine* engine);
 IMGUI_API bool                ImGuiTestEngine_IsUsingSimulatedInputs(ImGuiTestEngine* engine);
-IMGUI_API void                ImGuiTestEngine_GetResult(ImGuiTestEngine* engine, int& count_tested, int& success_count);
+IMGUI_API void                ImGuiTestEngine_GetResultSummary(ImGuiTestEngine* engine, ImGuiTestEngineResultSummary* out_results);
 IMGUI_API void                ImGuiTestEngine_GetTestList(ImGuiTestEngine* engine, ImVector<ImGuiTest*>* out_tests);
 IMGUI_API void                ImGuiTestEngine_GetTestQueue(ImGuiTestEngine* engine, ImVector<ImGuiTestRunTask>* out_tests);
 
+#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
+// Obsoleted 2025/03/17
+static inline void            ImGuiTestEngine_GetResult(ImGuiTestEngine* engine, int& out_count_tested, int& out_count_passed) { ImGuiTestEngineResultSummary summary; ImGuiTestEngine_GetResultSummary(engine, &summary); out_count_tested = summary.CountTested; out_count_passed = summary.CountPassed; }
+#endif
+
 // Functions: Crash Handling
 // Ensure past test results are properly exported even if application crash during a test.
 IMGUI_API void                ImGuiTestEngine_InstallDefaultCrashHandler();     // Install default crash handler (if you don't have one)

imgui_test_engine/imgui_te_exporters.cpp

@@ -30,21 +30,23 @@ static void ImGuiTestEngine_ExportJUnitXml(ImGuiTestEngine* engine, const char*
 
 void ImGuiTestEngine_PrintResultSummary(ImGuiTestEngine* engine)
 {
-    int count_tested = 0;
-    int count_success = 0;
-    ImGuiTestEngine_GetResult(engine, count_tested, count_success);
+    ImGuiTestEngineResultSummary summary;
+    ImGuiTestEngine_GetResultSummary(engine, &summary);
 
-    if (count_success < count_tested)
+    if (summary.CountSuccess < summary.CountTested)
     {
         printf("\nFailing tests:\n");
         for (ImGuiTest* test : engine->TestsAll)
             if (test->Output.Status == ImGuiTestStatus_Error)
                 printf("- %s\n", test->Name);
     }
 
-    ImOsConsoleSetTextColor(ImOsConsoleStream_StandardOutput, (count_success == count_tested) ? ImOsConsoleTextColor_BrightGreen : ImOsConsoleTextColor_BrightRed);
-    printf("\nTests Result: %s\n", (count_success == count_tested) ? "OK" : "Errors");
-    printf("(%d/%d tests passed)\n", count_success, count_tested);
+    bool success = (summary.CountSuccess == summary.CountTested);
+    ImOsConsoleSetTextColor(ImOsConsoleStream_StandardOutput, success ? ImOsConsoleTextColor_BrightGreen : ImOsConsoleTextColor_BrightRed);
+    printf("\nTests Result: %s\n", success ? "OK" : "Errors");
+    printf("(%d/%d tests passed)\n", summary.CountSuccess, summary.CountTested);
+    if (summary.CountInQueue > 0)
+        printf("(%d queued tests remaining)\n", summary.CountInQueue);
     ImOsConsoleSetTextColor(ImOsConsoleStream_StandardOutput, ImOsConsoleTextColor_White);
 }
 

imgui_test_suite/imgui_test_suite.cpp

@@ -629,11 +629,10 @@ int main(int argc, char** argv)
     ImGuiTestAppErrorCode error_code = ImGuiTestAppErrorCode_Success;
     if (!aborted)
     {
-        int count_tested = 0;
-        int count_success = 0;
-        ImGuiTestEngine_GetResult(engine, count_tested, count_success);
+        ImGuiTestEngineResultSummary summary;
+        ImGuiTestEngine_GetResultSummary(engine, &summary);
         ImGuiTestEngine_PrintResultSummary(engine);
-        if (count_tested != count_success)
+        if (summary.CountSuccess < summary.CountTested)
             error_code = ImGuiTestAppErrorCode_TestFailed;
     }