Integrating latest 47acbe8

Gems/EditorPythonBindings/Code/Tests/PythonThreadingTests.cpp

@@ -0,0 +1,224 @@
+/*
+ * All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+ * its licensors.
+ *
+ * For complete copyright and license terms please see the LICENSE at the root of this
+ * distribution (the "License"). All use of this software is governed by the License,
+ * or, if provided, by the license below or the license accompanying this file. Do not
+ * remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *
+ */
+#include <Source/PythonCommon.h>
+#include <pybind11/pybind11.h>
+#include <pybind11/embed.h>
+#include "PythonTraceMessageSink.h"
+#include "PythonTestingUtility.h"
+
+#include <AzCore/RTTI/BehaviorContext.h>
+#include <AzFramework/StringFunc/StringFunc.h>
+#include <AzToolsFramework/API/EditorPythonRunnerRequestsBus.h>
+#include <AzToolsFramework/API/EditorPythonConsoleBus.h>
+
+namespace UnitTest
+{
+    //////////////////////////////////////////////////////////////////////////
+    // behavior
+
+    struct PythonThreadNotifications
+        : public AZ::EBusTraits
+    {
+        virtual AZ::s64 OnNotification(AZ::s64 value) = 0;
+    };
+    using PythonThreadNotificationBus = AZ::EBus<PythonThreadNotifications>;
+
+    struct PythonThreadNotificationBusHandler final
+        : public PythonThreadNotificationBus::Handler
+        , public AZ::BehaviorEBusHandler
+    {
+        AZ_EBUS_BEHAVIOR_BINDER(PythonThreadNotificationBusHandler, "{CADEF35D-D88C-4DE0-B5FC-A88D383C124E}", AZ::SystemAllocator,
+            OnNotification);
+
+        virtual ~PythonThreadNotificationBusHandler() = default;
+
+        AZ::s64 OnNotification(AZ::s64 value) override
+        {
+            AZ::s64 result = 0;
+            CallResult(result, FN_OnNotification, value);
+            return result;
+        }
+
+        void Reflect(AZ::ReflectContext* context)
+        {
+            if (AZ::BehaviorContext* behaviorContext = azrtti_cast<AZ::BehaviorContext*>(context))
+            {
+                behaviorContext->EBus<PythonThreadNotificationBus>("PythonThreadNotificationBus")
+                    ->Attribute(AZ::Script::Attributes::Scope, AZ::Script::Attributes::ScopeFlags::Automation)
+                    ->Attribute(AZ::Script::Attributes::Module, "test")
+                    ->Handler<PythonThreadNotificationBusHandler>()
+                    ->Event("OnNotification", &PythonThreadNotificationBus::Events::OnNotification)
+                    ;
+            }
+        }
+    };
+
+    //////////////////////////////////////////////////////////////////////////
+    // fixtures
+
+    struct PythonThreadingTest
+        : public PythonTestingFixture
+    {
+        PythonTraceMessageSink m_testSink;
+
+        void SetUp() override
+        {
+            PythonTestingFixture::SetUp();
+            PythonTestingFixture::RegisterComponentDescriptors();
+        }
+
+        void TearDown() override
+        {
+            // clearing up memory
+            m_testSink = PythonTraceMessageSink();
+            PythonTestingFixture::TearDown();
+        }
+    };
+
+    //////////////////////////////////////////////////////////////////////////
+    // tests
+
+    TEST_F(PythonThreadingTest, PythonInterface_ThreadLogic_Runs)
+    {
+        enum class LogTypes
+        {
+            Skip = 0,
+            RanInThread
+        };
+
+        m_testSink.m_evaluateMessage = [](const char* window, const char* message) -> int
+        {
+            if (AzFramework::StringFunc::Equal(window, "python"))
+            {
+                if (AzFramework::StringFunc::StartsWith(message, "RanInThread"))
+                {
+                    return aznumeric_cast<int>(LogTypes::RanInThread);
+                }
+            }
+            return aznumeric_cast<int>(LogTypes::Skip);
+        };
+
+        PythonThreadNotificationBusHandler pythonThreadNotificationBusHandler;
+        pythonThreadNotificationBusHandler.Reflect(m_app.GetSerializeContext());
+        pythonThreadNotificationBusHandler.Reflect(m_app.GetBehaviorContext());
+
+        AZ::Entity e;
+        Activate(e);
+        SimulateEditorBecomingInitialized();
+
+        try
+        {
+            // prepare handler on this thread
+            pybind11::exec(R"(
+                import azlmbr.test
+
+                def on_notification(args):
+                    value = args[0] + 2
+                    print ('RanInThread')
+                    return value
+
+                handler = azlmbr.test.PythonThreadNotificationBusHandler()
+                handler.connect()
+                handler.add_callback('OnNotification', on_notification)
+                )");
+
+            // start thread; in thread issue notification
+            auto threadCallback = []()
+            {
+                AZ::s64 result = 0;
+                auto notificationCallback = [&result]()
+                {
+                    PythonThreadNotificationBus::BroadcastResult(result, &PythonThreadNotificationBus::Events::OnNotification, 40);
+                };
+
+                auto editorPythonEventsInterface = AZ::Interface<AzToolsFramework::EditorPythonEventsInterface>::Get();
+                if (editorPythonEventsInterface)
+                {
+                    editorPythonEventsInterface->ExecuteWithLock(notificationCallback);
+                }
+
+                EXPECT_EQ(42, result);
+            };
+            AZStd::thread theThread(threadCallback);
+            AZStd::this_thread::sleep_for(AZStd::chrono::milliseconds(100));
+            theThread.join();
+        }
+        catch ([[maybe_unused]] const std::exception& e)
+        {
+            AZ_Error("UnitTest", false, "Failed during thread test with %s", e.what());
+        }
+
+        e.Deactivate();
+        EXPECT_EQ(1, m_testSink.m_evaluationMap[aznumeric_cast<int>(LogTypes::RanInThread)]);
+    }
+
+    TEST_F(PythonThreadingTest, PythonInterface_ThreadLogic_HandlesPythonException)
+    {
+        PythonThreadNotificationBusHandler pythonThreadNotificationBusHandler;
+        pythonThreadNotificationBusHandler.Reflect(m_app.GetSerializeContext());
+        pythonThreadNotificationBusHandler.Reflect(m_app.GetBehaviorContext());
+
+        AZ::Entity e;
+        Activate(e);
+        SimulateEditorBecomingInitialized();
+
+        try
+        {
+            AZ_TEST_START_TRACE_SUPPRESSION;
+
+            // prepare handler on this thread, but will throw a Python exception 
+            pybind11::exec(R"(
+                import azlmbr.test
+
+                def on_notification(args):
+                    raise NotImplementedError("boom")
+
+                handler = azlmbr.test.PythonThreadNotificationBusHandler()
+                handler.connect()
+                handler.add_callback('OnNotification', on_notification)
+                )");
+
+            // start thread; in thread issue notification
+            auto threadCallback = []()
+            {
+                AZ::s64 result = 0;
+                auto notificationCallback = [&result]()
+                {
+                    PythonThreadNotificationBus::BroadcastResult(result, &PythonThreadNotificationBus::Events::OnNotification, 40);
+                };
+
+                auto editorPythonEventsInterface = AZ::Interface<AzToolsFramework::EditorPythonEventsInterface>::Get();
+                if (editorPythonEventsInterface)
+                {
+                    editorPythonEventsInterface->ExecuteWithLock(notificationCallback);
+                }
+
+                EXPECT_EQ(0, result);
+            };
+            AZStd::thread theThread(threadCallback);
+            AZStd::this_thread::sleep_for(AZStd::chrono::milliseconds(100));
+            theThread.join();
+
+            // the Python script above raises an exception which causes two AZ_Error() message lines:
+            // "Python callback threw an exception NotImplementedError : boom At : <string>(6) : on_notification"
+            // "Python callback threw an exception TypeError : 'NoneType' object is not callable At : <string>(7) : on_notification"
+            AZ_TEST_STOP_TRACE_SUPPRESSION(2);
+        }
+        catch ([[maybe_unused]] const std::exception& e)
+        {
+            AZ_Error("UnitTest", false, "Failed during thread test with %s", e.what());
+        }
+
+        e.Deactivate();
+    }
+
+}