Unit test to ensure Thread_PrioritizeRequests properly return equality

Signed-off-by: AMZN-Gene <[email protected]>

Author: AMZN-Gene

Code/Framework/AzCore/AzCore/IO/Streamer/FileRequest.h

@@ -270,8 +270,12 @@ namespace AZ::IO::Requests
 
 namespace AZ::IO
 {
+    class Streamer_SchedulerTest_RequestSorting_Test;
+
     class FileRequest final
     {
+        friend Streamer_SchedulerTest_RequestSorting_Test;
+
     public:
         inline constexpr static AZStd::chrono::steady_clock::time_point s_noDeadlineTime = AZStd::chrono::steady_clock::time_point::max();
 
@@ -407,6 +411,7 @@ namespace AZ::IO
         friend class StreamerContext;
         friend class Scheduler;
         friend class Device;
+        friend class Streamer_SchedulerTest_RequestSorting_Test;
         friend bool operator==(const FileRequestHandle& lhs, const FileRequestPtr& rhs);
 
     public:

Code/Framework/AzCore/AzCore/IO/Streamer/Scheduler.h

@@ -24,6 +24,7 @@
 namespace AZ::IO
 {
     class FileRequest;
+    class Streamer_SchedulerTest_RequestSorting_Test;
 
     namespace Requests
     {
@@ -65,6 +66,7 @@ namespace AZ::IO
         void GetRecommendations(IStreamerTypes::Recommendations& recommendations) const;
 
     private:
+        friend class Streamer_SchedulerTest_RequestSorting_Test;
         inline static constexpr u32 ProfilerColor = 0x0080ffff; //!< A lite shade of blue. (See https://www.color-hex.com/color/0080ff).
 
         void Thread_MainLoop();

Code/Framework/AzCore/AzCore/IO/Streamer/Streamer.h

@@ -28,13 +28,15 @@ namespace AZ::IO::Requests
 namespace AZ::IO
 {
     class StreamStackEntry;
+    class Streamer_SchedulerTest_RequestSorting_Test;
 
     /**
      * Data streamer.
      */
     class Streamer final
         : public AZ::IO::IStreamer
     {
+        friend Streamer_SchedulerTest_RequestSorting_Test;
     public:
         AZ_RTTI(Streamer, "{3D880982-6E3F-4913-9947-55E01030D4AA}", IStreamer);
         AZ_CLASS_ALLOCATOR(Streamer, SystemAllocator);

Code/Framework/AzCore/Tests/Streamer/SchedulerTests.cpp

@@ -378,4 +378,54 @@ namespace AZ::IO
 
         EXPECT_EQ(Iterations + 1, counter);
     }
+
+    TEST_F(Streamer_SchedulerTest, RequestSorting)
+    {
+        //////////////////////////////////////////////////////////////
+        // Test equal priority requests that are past their deadlines (aka panic)
+        //////////////////////////////////////////////////////////////
+        IStreamerTypes::Deadline panicDeadline(IStreamerTypes::Deadline::min());
+        auto estimatedCompleteTime = AZStd::chrono::steady_clock::now();
+        char fakeBuffer[8];
+        FileRequestPtr panicRequest = m_streamer->Read("PanicRequest", fakeBuffer, sizeof(fakeBuffer), 8, panicDeadline);
+        panicRequest->m_request.SetEstimatedCompletion(estimatedCompleteTime);
+
+        // Passed deadline, same object (same pointer)
+        EXPECT_EQ(
+            m_streamer->m_streamStack->Thread_PrioritizeRequests(&panicRequest->m_request, &panicRequest->m_request),
+            Scheduler::Order::Equal);
+
+        // Passed deadline, different object
+        FileRequestPtr panicRequest2 = m_streamer->Read("PanicRequest2", fakeBuffer, sizeof(fakeBuffer), 8, panicDeadline);
+        panicRequest2->m_request.SetEstimatedCompletion(estimatedCompleteTime);
+        EXPECT_EQ(
+            m_streamer->m_streamStack->Thread_PrioritizeRequests(&panicRequest->m_request, &panicRequest2->m_request),
+            Scheduler::Order::Equal);
+
+
+        //////////////////////////////////////////////////////////////
+        // Test equal priority requests that are both reading the same file
+        //////////////////////////////////////////////////////////////
+        FileRequestPtr readRequest = m_streamer->Read("SameFile", fakeBuffer, sizeof(fakeBuffer), 8, panicDeadline);
+        FileRequestPtr sameFileRequest = m_streamer->CreateRequest();
+        sameFileRequest->m_request.CreateRead(&sameFileRequest->m_request, fakeBuffer, 8, RequestPath(), 0, 8);
+        sameFileRequest->m_request.m_parent = &readRequest->m_request;
+        sameFileRequest->m_request.m_dependencies = 0;
+
+        // Same file read, same object (same pointer)
+        EXPECT_EQ(
+            m_streamer->m_streamStack->Thread_PrioritizeRequests(&sameFileRequest->m_request, &sameFileRequest->m_request),
+            Scheduler::Order::Equal);
+
+        FileRequestPtr readRequest2 = m_streamer->Read("SameFile2", fakeBuffer, sizeof(fakeBuffer), 8, panicDeadline);
+        FileRequestPtr sameFileRequest2 = m_streamer->CreateRequest();
+        sameFileRequest2->m_request.CreateRead(&sameFileRequest2->m_request, fakeBuffer, 8, RequestPath(), 0, 8);
+        sameFileRequest2->m_request.m_parent = &readRequest2->m_request;
+        sameFileRequest2->m_request.m_dependencies = 0;
+
+        // Same file read, different objects
+        EXPECT_EQ(
+            m_streamer->m_streamStack->Thread_PrioritizeRequests(&sameFileRequest->m_request, &sameFileRequest2->m_request),
+            Scheduler::Order::Equal);
+    }
 } // namespace AZ::IO