Merge branch 'main' into LYN-2461

Code/Framework/AzToolsFramework/Tests/Prefab/PrefabDuplicateTests.cpp

@@ -0,0 +1,129 @@
+/*
+* 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 <AzToolsFramework/ToolsComponents/TransformComponent.h>
+
+#include <Prefab/PrefabTestComponent.h>
+#include <Prefab/PrefabTestDomUtils.h>
+#include <Prefab/PrefabTestFixture.h>
+
+namespace UnitTest
+{
+    using PrefabDuplicateTest = PrefabTestFixture;
+
+    TEST_F(PrefabDuplicateTest, PrefabDuplicate_DuplicateSingleEntitySucceeds)
+    {
+        AZStd::string entityName("Same Name");
+        AZ::Entity* entity1 = CreateEntity(entityName.c_str());
+        entity1->Deactivate();
+        entity1->CreateComponent<PrefabTestComponent>();
+        entity1->Activate();
+
+        AzToolsFramework::EditorEntityContextRequestBus::Broadcast(
+            &AzToolsFramework::EditorEntityContextRequests::HandleEntitiesAdded, AzToolsFramework::EntityList{ entity1 });
+        AZStd::unique_ptr<Instance> newInstance = m_prefabSystemComponent->CreatePrefab(
+            { entity1 },
+            {},
+            PrefabMockFilePath);
+
+        // We've created a prefab with a single Entity, so there should only be one EntityAlias in our instance
+        EXPECT_EQ(newInstance->GetEntityAliases().size(), 1);
+
+        // Duplicate the Entity and trigger the UpdateTemplateInstancesInQueue so the changes get propagated
+        m_prefabPublicInterface->DuplicateEntitiesInInstance(AzToolsFramework::EntityIdList{ entity1->GetId() });
+        m_instanceUpdateExecutorInterface->UpdateTemplateInstancesInQueue();
+
+        // We duplicated a single Entity, so there should now be two EntityAliases
+        EXPECT_EQ(newInstance->GetEntityAliases().size(), 2);
+
+        newInstance->GetConstEntities([&](const AZ::Entity& entity)
+        {
+            // Both of the entities should have the same name
+            EXPECT_EQ(entity.GetName(), entityName);
+
+            // Both of the entities should have the PrefabTestComponent we added
+            auto testComponent = entity.FindComponent<PrefabTestComponent>();
+            EXPECT_NE(nullptr, testComponent);
+
+            return true;
+        });
+    }
+
+    TEST_F(PrefabDuplicateTest, PrefabDuplicate_DuplicateMultipleEntitiesAndFixesReferences)
+    {
+        AZ::Entity* parentEntity = CreateEntity("Parent Entity");
+
+        AZ::Entity* childEntity = CreateEntity("Child Entity");
+        childEntity->Deactivate();
+        auto newComponent = childEntity->CreateComponent<PrefabTestComponent>();
+        childEntity->Activate();
+
+        // Set the EntityId reference property on our PrefabTestComponent so we can
+        // verify that arbitrary EntityId's are fixed up properly
+        newComponent->m_entityIdProperty = parentEntity->GetId();
+
+        AzToolsFramework::EditorEntityContextRequestBus::Broadcast(
+            &AzToolsFramework::EditorEntityContextRequests::HandleEntitiesAdded, AzToolsFramework::EntityList{ parentEntity, childEntity });
+
+        AZStd::unique_ptr<Instance> newInstance = m_prefabSystemComponent->CreatePrefab(
+            { parentEntity, childEntity },
+            {},
+            PrefabMockFilePath);
+
+        // We've created a prefab with two entities, so there should be two EntityAliases in our instance
+        EXPECT_EQ(newInstance->GetEntityAliases().size(), 2);
+
+        // Duplicate the entities and trigger the UpdateTemplateInstancesInQueue so the changes get propagated
+        m_prefabPublicInterface->DuplicateEntitiesInInstance(AzToolsFramework::EntityIdList{ parentEntity->GetId(), childEntity->GetId() });
+        m_instanceUpdateExecutorInterface->UpdateTemplateInstancesInQueue();
+
+        // We duplicated two entities, so there should now be four EntityAliases
+        EXPECT_EQ(newInstance->GetEntityAliases().size(), 4);
+
+        AzToolsFramework::EntityIdList parentEntityIds;
+        newInstance->GetConstEntities([&](const AZ::Entity& entity)
+        {
+            // Gather the parent EntityIds by tracking which entities don't have a PrefabTestComponent
+            auto testComponent = entity.FindComponent<PrefabTestComponent>();
+            if (!testComponent)
+            {
+                parentEntityIds.push_back(entity.GetId());
+            }
+
+            return true;
+        });
+
+        // There should only be two parents
+        EXPECT_EQ(parentEntityIds.size(), 2);
+
+        // Verify that the EntityId reference on the PrefabTestComponent on the children correspond
+        // to unique entities, which will verify that the EntityIds are fixed up on duplicate
+        newInstance->GetConstEntities([&](const AZ::Entity& entity)
+        {
+            // Only the child entities have a PrefabTestComponent
+            auto testComponent = entity.FindComponent<PrefabTestComponent>();
+            if (testComponent)
+            {
+                auto it = AZStd::find(parentEntityIds.begin(), parentEntityIds.end(), testComponent->m_entityIdProperty);
+                EXPECT_NE(it, parentEntityIds.end());
+
+                // Erase when we find it so that the matches will be unique
+                parentEntityIds.erase(it);
+            }
+
+            return true;
+        });
+
+        // Verify we matched each of the parent EntityIds
+        EXPECT_EQ(parentEntityIds.size(), 0);
+    }
+}

Code/Framework/AzToolsFramework/Tests/Prefab/PrefabTestFixture.cpp

@@ -20,6 +20,17 @@
 
 namespace UnitTest
 {
+    PrefabTestToolsApplication::PrefabTestToolsApplication(AZStd::string appName)
+        : ToolsTestApplication(AZStd::move(appName))
+    {
+    }
+
+    bool PrefabTestToolsApplication::IsPrefabSystemEnabled() const
+    {
+        // Make sure our prefab tests always run with prefabs enabled
+        return true;
+    }
+
     void PrefabTestFixture::SetUpEditorFixtureImpl()
     {
         // Acquire the system entity
@@ -32,6 +43,9 @@ namespace UnitTest
         m_prefabLoaderInterface = AZ::Interface<AzToolsFramework::Prefab::PrefabLoaderInterface>::Get();
         EXPECT_TRUE(m_prefabLoaderInterface);
 
+        m_prefabPublicInterface = AZ::Interface<AzToolsFramework::Prefab::PrefabPublicInterface>::Get();
+        EXPECT_TRUE(m_prefabPublicInterface);
+
         m_instanceUpdateExecutorInterface = AZ::Interface<AzToolsFramework::Prefab::InstanceUpdateExecutorInterface>::Get();
         EXPECT_TRUE(m_instanceUpdateExecutorInterface);
 
@@ -41,6 +55,11 @@ namespace UnitTest
         GetApplication()->RegisterComponentDescriptor(PrefabTestComponent::CreateDescriptor());
     }
 
+    AZStd::unique_ptr<ToolsTestApplication> PrefabTestFixture::CreateTestApplication()
+    {
+        return AZStd::make_unique<PrefabTestToolsApplication>("PrefabTestApplication");
+    }
+
     AZ::Entity* PrefabTestFixture::CreateEntity(const char* entityName, const bool shouldActivate)
     {
         // Circumvent the EntityContext system and generate a new entity with a transformcomponent

Code/Framework/AzToolsFramework/Tests/Prefab/PrefabTestFixture.h

@@ -31,6 +31,16 @@ namespace UnitTest
     using namespace AzToolsFramework::Prefab;
     using namespace PrefabTestUtils;
 
+    class PrefabTestToolsApplication
+        : public ToolsTestApplication
+    {
+    public:
+        PrefabTestToolsApplication(AZStd::string appName);
+
+        // Make sure our prefab tests always run with prefabs enabled
+        bool IsPrefabSystemEnabled() const override;
+    };
+
     class PrefabTestFixture
         : public ToolsApplicationFixture,
           public UnitTest::TraceBusRedirector
@@ -45,6 +55,8 @@ namespace UnitTest
 
         void SetUpEditorFixtureImpl() override;
 
+        AZStd::unique_ptr<ToolsTestApplication> CreateTestApplication() override;
+
         AZ::Entity* CreateEntity(const char* entityName, const bool shouldActivate = true);
 
         void CompareInstances(const Instance& instanceA, const Instance& instanceB, bool shouldCompareLinkIds = true,
@@ -57,6 +69,7 @@ namespace UnitTest
 
         PrefabSystemComponent* m_prefabSystemComponent = nullptr;
         PrefabLoaderInterface* m_prefabLoaderInterface = nullptr;
+        PrefabPublicInterface* m_prefabPublicInterface = nullptr;
         InstanceUpdateExecutorInterface* m_instanceUpdateExecutorInterface = nullptr;
         InstanceToTemplateInterface* m_instanceToTemplateInterface = nullptr;
     };

Code/Framework/AzToolsFramework/Tests/aztoolsframeworktests_files.cmake

@@ -54,6 +54,7 @@ set(FILES
     Prefab/Spawnable/SpawnableMetaDataTests.cpp
     Prefab/MockPrefabFileIOActionValidator.cpp
     Prefab/MockPrefabFileIOActionValidator.h
+    Prefab/PrefabDuplicateTests.cpp
     Prefab/PrefabEntityAliasTests.cpp
     Prefab/PrefabInstanceToTemplatePropagatorTests.cpp
     Prefab/PrefabInstantiateTests.cpp