Prefab support for dynamic vegetation (#1374)

* First version of prefab support for dynamic vegetation * Addressed PR feedback - Made MockSpawnableEntitiesInterface a proper GMock in AzFramework - Added Get/SetSpawnableAssetId - Added lots of comments to better explain things that were asked about in the PR * Exposed AzFrameworkTestShared on all platforms, not just host platforms
2021-06-17 16:24:33 -05:00
parent 0a11931422
commit f6fc425a1a
10 changed files with 977 additions and 35 deletions
@@ -9,7 +9,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #

-if(PAL_TRAIT_BUILD_TESTS_SUPPORTED AND PAL_TRAIT_BUILD_HOST_TOOLS)
+if(PAL_TRAIT_BUILD_TESTS_SUPPORTED)

    ly_get_list_relative_pal_filename(pal_dir ${CMAKE_CURRENT_LIST_DIR}/Platform/${PAL_PLATFORM_NAME})

@@ -27,40 +27,42 @@ if(PAL_TRAIT_BUILD_TESTS_SUPPORTED AND PAL_TRAIT_BUILD_HOST_TOOLS)
                AZ::AzFramework
    )

-    ly_add_target(
-        NAME ProcessLaunchTest EXECUTABLE
-        NAMESPACE AZ
-        FILES_CMAKE
-            process_launch_test_files.cmake
-        INCLUDE_DIRECTORIES
-            PRIVATE
-                .
-        BUILD_DEPENDENCIES
-            PRIVATE
-                AZ::AzCore
-                AZ::AzFramework
-    )
+    if(PAL_TRAIT_BUILD_HOST_TOOLS)
+        ly_add_target(
+            NAME ProcessLaunchTest EXECUTABLE
+            NAMESPACE AZ
+            FILES_CMAKE
+                process_launch_test_files.cmake
+            INCLUDE_DIRECTORIES
+                PRIVATE
+                    .
+            BUILD_DEPENDENCIES
+                PRIVATE
+                    AZ::AzCore
+                    AZ::AzFramework
+        )

-    ly_add_target(
-        NAME Framework.Tests ${PAL_TRAIT_TEST_TARGET_TYPE}
-        NAMESPACE AZ
-        FILES_CMAKE
-            frameworktests_files.cmake
-        INCLUDE_DIRECTORIES
-            PRIVATE
-                .
-                ${pal_dir}
-        BUILD_DEPENDENCIES
-            PRIVATE
-                AZ::AzTest
-                AZ::AzToolsFramework
-                AZ::AzTestShared
-                AZ::AzFrameworkTestShared
-        RUNTIME_DEPENDENCIES
-            AZ::ProcessLaunchTest
-    )
-    ly_add_googletest(
-        NAME AZ::Framework.Tests
-    )
+        ly_add_target(
+            NAME Framework.Tests ${PAL_TRAIT_TEST_TARGET_TYPE}
+            NAMESPACE AZ
+            FILES_CMAKE
+                frameworktests_files.cmake
+            INCLUDE_DIRECTORIES
+                PRIVATE
+                    .
+                    ${pal_dir}
+            BUILD_DEPENDENCIES
+                PRIVATE
+                    AZ::AzTest
+                    AZ::AzToolsFramework
+                    AZ::AzTestShared
+                    AZ::AzFrameworkTestShared
+            RUNTIME_DEPENDENCIES
+                AZ::ProcessLaunchTest
+        )
+        ly_add_googletest(
+            NAME AZ::Framework.Tests
+        )
+    endif()

 endif()
@@ -0,0 +1,84 @@
+/*
+ * 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.
+ *
+ */
+#pragma once
+
+#include <AzCore/UnitTest/UnitTest.h>
+#include <gmock/gmock.h>
+#include <AzFramework/Spawnable/SpawnableEntitiesInterface.h>
+#include <AzFramework/Spawnable/SpawnableEntitiesManager.h>
+
+namespace AzFramework
+{
+    class MockSpawnableEntitiesInterface;
+    using NiceSpawnableEntitiesInterfaceMock = ::testing::NiceMock<MockSpawnableEntitiesInterface>;
+
+    class MockSpawnableEntitiesInterface : public SpawnableEntitiesDefinition
+    {
+    public:
+        AZ_RTTI(MockSpawnableEntitiesInterface, "{2A20FF73-C445-4F32-ABB9-5CF0A5778404}", SpawnableEntitiesDefinition);
+
+        MockSpawnableEntitiesInterface()
+        {
+            AZ::Interface<SpawnableEntitiesDefinition>::Register(this);
+        }
+
+        virtual ~MockSpawnableEntitiesInterface()
+        {
+            AZ::Interface<SpawnableEntitiesDefinition>::Unregister(this);
+        }
+
+        MOCK_METHOD2(SpawnAllEntities, void(EntitySpawnTicket& ticket, SpawnAllEntitiesOptionalArgs optionalArgs));
+
+        MOCK_METHOD3(
+            SpawnEntities,
+            void(EntitySpawnTicket& ticket, AZStd::vector<size_t> entityIndices, SpawnEntitiesOptionalArgs optionalArgs));
+
+        MOCK_METHOD2(DespawnAllEntities, void(EntitySpawnTicket& ticket, DespawnAllEntitiesOptionalArgs optionalArgs));
+
+        MOCK_METHOD3(
+            ReloadSpawnable,
+            void(EntitySpawnTicket& ticket, AZ::Data::Asset<Spawnable> spawnable, ReloadSpawnableOptionalArgs optionalArgs));
+
+        MOCK_METHOD3(
+            ListEntities, void(EntitySpawnTicket& ticket, ListEntitiesCallback listCallback, ListEntitiesOptionalArgs optionalArgs));
+
+        MOCK_METHOD3(
+            ListIndicesAndEntities,
+            void(EntitySpawnTicket& ticket, ListIndicesEntitiesCallback listCallback, ListEntitiesOptionalArgs optionalArgs));
+
+        MOCK_METHOD3(
+            ClaimEntities,
+            void(EntitySpawnTicket& ticket, ClaimEntitiesCallback listCallback, ClaimEntitiesOptionalArgs optionalArgs));
+
+        MOCK_METHOD3(Barrier, void(EntitySpawnTicket& ticket, BarrierCallback completionCallback, BarrierOptionalArgs optionalArgs));
+
+        MOCK_METHOD1(CreateTicket, AZStd::pair<EntitySpawnTicket::Id, void*>(AZ::Data::Asset<Spawnable>&& spawnable));
+        MOCK_METHOD1(DestroyTicket, void(void* ticket));
+
+        /** Installs some default result values for the above functions.
+         *   Note that you can always override these in scope of your test by adding additional ON_CALL / EXPECT_CALL
+         *   statements in the body of your test or after calling this function, and yours will take precedence.
+         **/
+        static void InstallDefaultReturns(NiceSpawnableEntitiesInterfaceMock& target)
+        {
+            using namespace ::testing;
+
+            // The ID and pointer are completely arbitrary, they just need to both be non-zero to look like a valid ticket.
+            constexpr EntitySpawnTicket::Id ticketId(1);
+            static int ticketPayload = 0;
+            ON_CALL(target, CreateTicket(_)).WillByDefault(
+                Return(AZStd::make_pair<AzFramework::EntitySpawnTicket::Id, void*>(ticketId, &ticketPayload)));
+        }
+
+    };
+
+} // namespace AzFramework
@@ -10,6 +10,7 @@
 #

 set(FILES
+    Mocks/MockSpawnableEntitiesInterface.h
    Utils/Utils.h
    Utils/Utils.cpp
 )