From be4f3e7f1be6c2fc7f3af7626191c0d9059a233f Mon Sep 17 00:00:00 2001
From: Lukas Aldershaab <lpjoergensen@gmail.com>
Date: Sat, 8 Apr 2023 00:50:57 +0200
Subject: [PATCH] Prevent tests from never ending due to threading bug

---
 .github/workflows/cmake.yml                   | 33 +++++++++++++++
 .../threads/test/threadSafeDequeTest.cpp      | 41 ++++++++++++++++++-
 2 files changed, 72 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
index 9b5af2ea2..bf47f1043 100644
--- a/.github/workflows/cmake.yml
+++ b/.github/workflows/cmake.yml
@@ -66,9 +66,42 @@ jobs:
          fi
       shell: bash
 
+    - name: Upload Test Report
+      uses: actions/upload-artifact@v3
+      if: always() # always run even if the previous step fails
+      with:
+         name: junit-test-results
+         path: '${{github.workspace}}/My Projects/Torque3D/game/test_detail.xml'
+         retention-days: 1
 
     - name: Publish Test Report
       uses: mikepenz/action-junit-report@v3
       if: success() || failure() # always run even if the previous step fails
       with:
          report_paths: '${{github.workspace}}/My Projects/Torque3D/game/test_detail.xml'
+
+---
+name: Report Test Results
+on:
+   workflow_run:
+      workflows: [CMake]
+      types: [completed]
+
+permissions:
+   checks: write
+
+jobs:
+   checks:
+      runs-on: ubuntu-latest
+      steps:
+         - name: Download Test Report
+           uses: dawidd6/action-download-artifact@v2
+           with:
+              name: junit-test-results
+              workflow: ${{ github.event.workflow.id }}
+              run_id: ${{ github.event.workflow_run.id }}
+         - name: Publish Test Report
+           uses: mikepenz/action-junit-report@v3
+           with:
+              commit: ${{github.event.workflow_run.head_sha}}
+              report_paths: '${{github.workspace}}/My Projects/Torque3D/game/test_detail.xml'
diff --git a/Engine/source/platform/threads/test/threadSafeDequeTest.cpp b/Engine/source/platform/threads/test/threadSafeDequeTest.cpp
index 54df89ad4..3559ebd13 100644
--- a/Engine/source/platform/threads/test/threadSafeDequeTest.cpp
+++ b/Engine/source/platform/threads/test/threadSafeDequeTest.cpp
@@ -91,6 +91,18 @@ public:
             ValueRef val = new Value(i, tick);
             mDeque.pushBack(val);
          }
+
+         // WORKAROUND: due to a bug in the Deque, we lose an item, and thus the test will loop forever. We currently
+         //             don't have a timeout solution, so instead push som extra elements just to make sure Consumer
+         //             doesn't get stuck.
+         for(U32 i = mValues.size(); i < mValues.size() + 5; i++)
+         {
+            U32 tick = Platform::getRealMilliseconds();
+
+            ValueRef val = new Value(i, tick);
+
+            mDeque.pushBack(val);
+         }
       }
    };
 
@@ -107,7 +119,6 @@ public:
          {
             ValueRef value;
             while(!mDeque.tryPopFront(value));
-
             EXPECT_EQ(i, value->mIndex);
             EXPECT_EQ(value->mTick, mValues[i]);
          }
@@ -162,6 +173,8 @@ TEST_FIX(ThreadSafeDeque, PopBack)
 }
 
 // Test deque in a concurrent setting.
+
+// Test many items in a row
 TEST_FIX(ThreadSafeDeque, Concurrent1)
 {
    const U32 NumValues = 100;
@@ -183,4 +196,28 @@ TEST_FIX(ThreadSafeDeque, Concurrent1)
    mValues.clear();
 };
 
-#endif
\ No newline at end of file
+// Test a few items many times to catch any race-condition in start-up
+TEST_FIX(ThreadSafeDeque, Concurrent2)
+{
+   for (int i = 0; i < 10000; ++i)
+   {
+      Deque mDeque;
+      Vector<U32> mValues;
+
+      mValues.setSize(5);
+
+      ProducerThread pThread(mValues, mDeque);
+      ConsumerThread cThread(mValues, mDeque);
+
+      cThread.start();
+      pThread.start();
+
+      pThread.join();
+      cThread.join();
+
+      mValues.clear();
+      if (::testing::Test::HasFailure()) break;
+   }
+};
+
+#endif