Updating reparent prefab test to test several use cases as well as undo/redo

Signed-off-by: jckand-amzn <[email protected]>

AutomatedTesting/Gem/PythonTests/Prefab/TestSuite_Main.py

@@ -46,8 +46,8 @@ class TestAutomation(TestAutomationBase):
         from Prefab.tests.delete_prefab import DeletePrefab_ContainingASingleEntity as test_module
         self._run_prefab_test(request, workspace, editor, test_module)
 
-    def test_ReparentPrefab_UnderAnotherPrefab(self, request, workspace, editor, launcher_platform):
-        from Prefab.tests.reparent_prefab import ReparentPrefab_UnderAnotherPrefab as test_module
+    def test_ReparentPrefab_UnderPrefabAndEntityHierarchies(self, request, workspace, editor, launcher_platform):
+        from Prefab.tests.reparent_prefab import ReparentPrefab_UnderPrefabAndEntityHierarchies as test_module
         self._run_prefab_test(request, workspace, editor, test_module, autotest_mode=False)
 
     def test_DetachPrefab_UnderAnotherPrefab(self, request, workspace, editor, launcher_platform):

AutomatedTesting/Gem/PythonTests/Prefab/TestSuite_Main_Optimized.py

@@ -39,8 +39,8 @@ class TestAutomationNoAutoTestMode(EditorTestSuite):
     class test_DeleteEntity_UnderLevelPrefab(EditorSharedTest):
         from .tests.delete_entity import DeleteEntity_UnderLevelPrefab as test_module
 
-    class test_ReparentPrefab_UnderAnotherPrefab(EditorSharedTest):
-        from .tests.reparent_prefab import ReparentPrefab_UnderAnotherPrefab as test_module
+    class test_ReparentPrefab_UnderPrefabAndEntityHierarchies(EditorSharedTest):
+        from .tests.reparent_prefab import ReparentPrefab_UnderPrefabAndEntityHierarchies as test_module
 
     class test_DetachPrefab_UnderAnotherPrefab(EditorSharedTest):
         from .tests.detach_prefab import DetachPrefab_UnderAnotherPrefab as test_module

AutomatedTesting/Gem/PythonTests/Prefab/tests/reparent_prefab/ReparentPrefab_UnderAnotherPrefab.py

@@ -1,53 +0,0 @@
-"""
-Copyright (c) Contributors to the Open 3D Engine Project.
-For complete copyright and license terms please see the LICENSE at the root of this distribution.
-
-SPDX-License-Identifier: Apache-2.0 OR MIT
-"""
-
-def ReparentPrefab_UnderAnotherPrefab():
-
-    from pathlib import Path
-    CAR_PREFAB_FILE_NAME = Path(__file__).stem + 'car_prefab'
-    WHEEL_PREFAB_FILE_NAME = Path(__file__).stem + 'wheel_prefab'
-
-    import editor_python_test_tools.pyside_utils as pyside_utils
-
-    @pyside_utils.wrap_async
-    async def run_test():
-
-        from editor_python_test_tools.editor_entity_utils import EditorEntity
-        from editor_python_test_tools.prefab_utils import Prefab
-
-        import Prefab.tests.PrefabTestUtils as prefab_test_utils
-
-        prefab_test_utils.open_base_tests_level()
-
-        # Creates a new car entity at the root level
-        car_entity = EditorEntity.create_editor_entity()
-        car_prefab_entities = [car_entity]
-
-        # Creates a prefab from the car entity
-        _, car = Prefab.create_prefab(
-            car_prefab_entities, CAR_PREFAB_FILE_NAME)
-
-        # Creates another new wheel entity at the root level
-        wheel_entity = EditorEntity.create_editor_entity()
-        wheel_prefab_entities = [wheel_entity]
-
-        # Creates another prefab from the wheel entity
-        _, wheel = Prefab.create_prefab(
-            wheel_prefab_entities, WHEEL_PREFAB_FILE_NAME)
-
-        # Ensure focus gets set on the prefab you want to parent under. This mirrors how users would do
-        # reparenting in the editor.
-        car.container_entity.focus_on_owning_prefab()
-
-        # Reparents the wheel prefab instance to the container entity of the car prefab instance
-        await wheel.ui_reparent_prefab_instance(car.container_entity.id)
-
-    run_test()
-
-if __name__ == "__main__":
-    from editor_python_test_tools.utils import Report
-    Report.start_test(ReparentPrefab_UnderAnotherPrefab)

AutomatedTesting/Gem/PythonTests/Prefab/tests/reparent_prefab/ReparentPrefab_UnderPrefabAndEntityHierarchies.py

@@ -0,0 +1,103 @@
+"""
+Copyright (c) Contributors to the Open 3D Engine Project.
+For complete copyright and license terms please see the LICENSE at the root of this distribution.
+
+SPDX-License-Identifier: Apache-2.0 OR MIT
+"""
+
+def ReparentPrefab_UnderPrefabAndEntityHierarchies():
+
+    from pathlib import Path
+    CAR_PREFAB_FILE_NAME = Path(__file__).stem + '_car_prefab'
+    WHEEL_PREFAB_FILE_NAME = Path(__file__).stem + '_wheel_prefab'
+    DRIVER_PREFAB_FILE_NAME = Path(__file__).stem + '_driver_prefab'
+
+    import editor_python_test_tools.pyside_utils as pyside_utils
+
+    @pyside_utils.wrap_async
+    async def run_test():
+
+        from editor_python_test_tools.editor_entity_utils import EditorEntity, EditorLevelEntity
+        from editor_python_test_tools.prefab_utils import Prefab, wait_for_propagation
+
+        import Prefab.tests.PrefabTestUtils as prefab_test_utils
+        import azlmbr.legacy.general as general
+
+        async def reparent_with_undo_redo(prefab_instance, new_parent_entity_id):
+            # Get child data on the original parent, and reparent to new entity
+            original_parent = EditorEntity(prefab_instance.container_entity.get_parent_id())
+            original_parent_original_children_ids = {child_id.ToString(): child_id for child_id in
+                                                     original_parent.get_children_ids()}
+            await prefab_instance.ui_reparent_prefab_instance(new_parent_entity_id)
+
+            # Undo the reparent operation, and verify original parent is restored
+            general.undo()
+            wait_for_propagation()
+            original_parent_new_children_ids = {child_id.ToString(): child_id for child_id in
+                                                original_parent.get_children_ids()}
+            assert original_parent_original_children_ids == original_parent_new_children_ids, \
+                "Failed to reparent instance to the original parent via Undo"
+
+            # Redo the reparent operation, and verify the new instance is not among the original parent's child entities
+            general.redo()
+            wait_for_propagation()
+            original_parent_new_children_ids = {child_id.ToString(): child_id for child_id in
+                                                original_parent.get_children_ids()}
+            assert prefab_instance.container_entity.id not in original_parent_new_children_ids, \
+                "Redo on reparent operation failed"
+
+        prefab_test_utils.open_base_tests_level()
+
+        Report.info(f"Level Entity Id: {EditorEntity(EditorLevelEntity).id}")
+        # Creates a new car entity at the root level
+        car_entity = EditorEntity.create_editor_entity()
+        car_prefab_entities = [car_entity]
+
+        # Creates a prefab from the car entity
+        _, car = Prefab.create_prefab(car_prefab_entities, CAR_PREFAB_FILE_NAME)
+
+        # Creates another new wheel entity at the root level
+        wheel_entity = EditorEntity.create_editor_entity()
+        wheel_prefab_entities = [wheel_entity]
+
+        # Creates another prefab from the wheel entity
+        _, wheel = Prefab.create_prefab(wheel_prefab_entities, WHEEL_PREFAB_FILE_NAME)
+
+        # Creates another new driver entity at the root level
+        driver_entity = EditorEntity.create_editor_entity()
+        driver_prefab_entities = [driver_entity]
+
+        # Creates another prefab from the driver entity
+        _, driver = Prefab.create_prefab(driver_prefab_entities, DRIVER_PREFAB_FILE_NAME)
+
+        # Creates a few new entity hierarchies starting at the root level
+        non_prefab_entity = EditorEntity.create_editor_entity("Non-Prefab Entity")
+        non_prefab_parent_entity = EditorEntity.create_editor_entity("Non-Prefab Parent Entity")
+        non_prefab_child_entity = EditorEntity.create_editor_entity("Non-Prefab Child Entity",
+                                                                    non_prefab_parent_entity.id)
+
+        # Ensure focus gets set on the prefab you want to parent under. This mirrors how users would do
+        # reparenting in the editor.
+        car.container_entity.focus_on_owning_prefab()
+
+        # Reparents the wheel prefab instance to the container entity of the car prefab instance
+        await reparent_with_undo_redo(wheel, car.container_entity.id)
+
+        # Reparents the driver instance to the container entity of the now nested car/wheel prefab
+        wheel.container_entity.focus_on_owning_prefab()
+        await reparent_with_undo_redo(driver, wheel.container_entity.id)
+
+        # Reparents the wheel prefab instance to the non-prefab entity at the root level
+        non_prefab_entity.focus_on_owning_prefab()
+        await reparent_with_undo_redo(wheel, non_prefab_entity.id)
+
+        # Reparents the wheel prefab instance to the child entity of the non-prefab entity hierarchy
+        non_prefab_child_entity.focus_on_owning_prefab()
+        await reparent_with_undo_redo(wheel, non_prefab_child_entity.id)
+
+    run_test()
+
+
+if __name__ == "__main__":
+    from editor_python_test_tools.utils import Report
+    Report.start_test(ReparentPrefab_UnderPrefabAndEntityHierarchies)