PostFX Shape Weight Modifier component P0 parallel test

Signed-off-by: Scott Murray <scottmur@amazon.com>
2021-10-12 13:21:55 -07:00
parent 7fcaeb16c4
commit 4c5906a8d4
2 changed files with 215 additions and 0 deletions
@@ -67,5 +67,9 @@ class TestAutomation(EditorTestSuite):
    class AtomEditorComponents_PostFXLayerAdded(EditorSharedTest):
        from Atom.tests import hydra_AtomEditorComponents_PostFXLayerAdded as test_module

+    @pytest.mark.test_case_id("C36525665")
+    class AtomEditorComponents_PostFXShapeWeightModifierAdded(EditorSharedTest):
+        from Atom.tests import hydra_AtomEditorComponents_PostFxShapeWeightModifierAdded as test_module
+
    class ShaderAssetBuilder_RecompilesShaderAsChainOfDependenciesChanges(EditorSharedTest):
        from Atom.tests import hydra_ShaderAssetBuilder_RecompilesShaderAsChainOfDependenciesChanges as test_module
@@ -0,0 +1,211 @@
+"""
+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
+"""
+
+class Tests:
+    creation_undo = (
+        "UNDO Entity creation success",
+        "UNDO Entity creation failed")
+    creation_redo = (
+        "REDO Entity creation success",
+        "REDO Entity creation failed")
+    postfx_shape_weight_creation = (
+        "PostFx Shape Weight Modifier Entity successfully created",
+        "PostFx Shape Weight Modifier Entity failed to be created")
+    postfx_shape_weight_component = (
+        "Entity has a PostFx Shape Weight Modifier component",
+        "Entity failed to find PostFx Shape Weight Modifier component")
+    postfx_shape_weight_disabled = (
+        "PostFx Shape Weight Modifier component disabled",
+        "PostFx Shape Weight Modifier component was not disabled.")
+    postfx_layer_component = (
+        "Entity has an Actor component",
+        "Entity did not have an Actor component")
+    shape_component = (
+        "Entity has a Tube Shape component",
+        "Entity did not have a Tube Shape component")
+    shape_undo = (
+        "Entity shape component add undone",
+        "Entity shape component undo failed to remove shape")
+    postfx_shape_weight_enabled = (
+        "PostFx Shape Weight Modifier component enabled",
+        "PostFx Shape Weight Modifier component was not enabled.")
+    enter_game_mode = (
+        "Entered game mode",
+        "Failed to enter game mode")
+    exit_game_mode = (
+        "Exited game mode",
+        "Couldn't exit game mode")
+    is_visible = (
+        "Entity is visible",
+        "Entity was not visible")
+    is_hidden = (
+        "Entity is hidden",
+        "Entity was not hidden")
+    entity_deleted = (
+        "Entity deleted",
+        "Entity was not deleted")
+    deletion_undo = (
+        "UNDO deletion success",
+        "UNDO deletion failed")
+    deletion_redo = (
+        "REDO deletion success",
+        "REDO deletion failed")
+
+
+def AtomEditorComponents_postfx_shape_weight_AddedToEntity():
+    """
+    Summary:
+    Tests the PostFx Shape Weight Modifier component can be added to an entity and has the expected functionality.
+
+    Test setup:
+    - Wait for Editor idle loop.
+    - Open the "Base" level.
+
+    Expected Behavior:
+    The component can be added, used in game mode, hidden/shown, deleted, and has accurate required components.
+    Creation and deletion undo/redo should also work.
+
+    Test Steps:
+    1) Create a PostFx Shape Weight Modifier entity with no components.
+    2) Add a PostFx Shape Weight Modifier component to PostFx Shape Weight Modifier entity.
+    3) UNDO the entity creation and component addition.
+    4) REDO the entity creation and component addition.
+    5) Verify PostFx Shape Weight Modifier component not enabled.
+    6) Add PostFX Layer component since it is required by the PostFx Shape Weight Modifier component.
+    7) Verify PostFx Shape Weight Modifier component is NOT enabled since it also requires a shape.
+    8) Add a required shape looping over a list and checking if it enables PostFX Shape Weight Modifier.
+    9) Undo to remove each added shape and verify PostFX Shape Weight Modifier is not enabled
+    10) Verify PostFx Shape Weight Modifier component is enabled by adding Spline and Tube Shape componen.
+    11) Enter/Exit game mode.
+    12) Test IsHidden.
+    13) Test IsVisible.
+    14) Delete PostFx Shape Weight Modifier entity.
+    15) UNDO deletion.
+    16) REDO deletion.
+    17) Look for errors.
+
+    :return: None
+    """
+
+    import azlmbr.legacy.general as general
+
+    from editor_python_test_tools.editor_entity_utils import EditorEntity
+    from editor_python_test_tools.utils import Report, Tracer, TestHelper
+
+    with Tracer() as error_tracer:
+        # Test setup begins.
+        # Setup: Wait for Editor idle loop before executing Python hydra scripts then open "Base" level.
+        TestHelper.init_idle()
+        TestHelper.open_level("", "Base")
+
+        # Test steps begin.
+        # 1. Create a PostFx Shape Weight Modifier entity with no components.
+        postfx_shape_weight_name = "PostFX Shape Weight Modifier"
+        postfx_shape_weight_entity = EditorEntity.create_editor_entity(postfx_shape_weight_name)
+        Report.critical_result(Tests.postfx_shape_weight_creation, postfx_shape_weight_entity.exists())
+
+        # 2. Add a PostFx Shape Weight Modifier component to PostFx Shape Weight Modifier entity.
+        postfx_shape_weight_component = postfx_shape_weight_entity.add_component(postfx_shape_weight_name)
+        Report.critical_result(
+            Tests.postfx_shape_weight_component,
+            postfx_shape_weight_entity.has_component(postfx_shape_weight_name))
+
+        # 3. UNDO the entity creation and component addition.
+        # -> UNDO component addition.
+        general.undo()
+        # -> UNDO naming entity.
+        general.undo()
+        # -> UNDO selecting entity.
+        general.undo()
+        # -> UNDO entity creation.
+        general.undo()
+        general.idle_wait_frames(1)
+        Report.result(Tests.creation_undo, not postfx_shape_weight_entity.exists())
+
+        # 4. REDO the entity creation and component addition.
+        # -> REDO entity creation.
+        general.redo()
+        # -> REDO selecting entity.
+        general.redo()
+        # -> REDO naming entity.
+        general.redo()
+        # -> REDO component addition.
+        general.redo()
+        general.idle_wait_frames(1)
+        Report.result(Tests.creation_redo, postfx_shape_weight_entity.exists())
+
+        # 5. Verify PostFx Shape Weight Modifier component not enabled.
+        Report.result(Tests.postfx_shape_weight_disabled, not postfx_shape_weight_component.is_enabled())
+
+        # 6. Add PostFX Layer component since it is required by the PostFx Shape Weight Modifier component.
+        postfx_layer_name = "PostFX Layer"
+        postfx_shape_weight_entity.add_component(postfx_layer_name)
+        Report.result(Tests.postfx_layer_component, postfx_shape_weight_entity.has_component(postfx_layer_name))
+
+        # 7. Verify PostFx Shape Weight Modifier component not enabled because shape is also required.
+        Report.result(Tests.postfx_shape_weight_disabled, not postfx_shape_weight_component.is_enabled())
+
+        # 8. Add remove each shape to test if the PostFX Shape Weight Modifier is enabled by having a required shape
+        for shape in ['Axis Aligned Box Shape', 'Box Shape', 'Capsule Shape', 'Compound Shape', 'Cylinder Shape',
+                      'Disk Shape', 'Polygon Prism Shape', 'Quad Shape', 'Sphere Shape', 'Vegetation Reference Shape']:
+            postfx_shape_weight_entity.add_component(shape)
+            test_shape = (
+                f"Entity has a {shape} component",
+                f"Entity did not have a {shape} component")
+            Report.result(test_shape, postfx_shape_weight_entity.has_component(shape))
+
+            #Check if required shape allows PostFX Shape Weight Modifier to be enabled
+            Report.result(Tests.postfx_shape_weight_enabled, postfx_shape_weight_component.is_enabled())
+
+            # 9. UNDO component addition and check that PostFX Shape Weight Modifier is not enabled
+            general.undo()
+            general.idle_wait_frames(1)
+            Report.result(Tests.shape_undo, not postfx_shape_weight_entity.has_component(shape))
+            Report.result(Tests.postfx_shape_weight_disabled, not postfx_shape_weight_component.is_enabled())
+
+        # 10. Add Tube Shape and Spline to fulfil the required shape component
+        postfx_shape_weight_entity.add_components(['Spline', 'Tube Shape'])
+        Report.result(Tests.shape_component, postfx_shape_weight_entity.has_component('Tube Shape'))
+        Report.result(Tests.postfx_shape_weight_enabled, postfx_shape_weight_component.is_enabled())
+
+        # 11. Enter/Exit game mode.
+        TestHelper.enter_game_mode(Tests.enter_game_mode)
+        general.idle_wait_frames(1)
+        TestHelper.exit_game_mode(Tests.exit_game_mode)
+
+        # 12. Test IsHidden.
+        postfx_shape_weight_entity.set_visibility_state(False)
+        Report.result(Tests.is_hidden, postfx_shape_weight_entity.is_hidden() is True)
+
+        # 13. Test IsVisible.
+        postfx_shape_weight_entity.set_visibility_state(True)
+        general.idle_wait_frames(1)
+        Report.result(Tests.is_visible, postfx_shape_weight_entity.is_visible() is True)
+
+        # 14. Delete PostFx Shape Weight Modifier entity.
+        postfx_shape_weight_entity.delete()
+        Report.result(Tests.entity_deleted, not postfx_shape_weight_entity.exists())
+
+        # 15. UNDO deletion.
+        general.undo()
+        Report.result(Tests.deletion_undo, postfx_shape_weight_entity.exists())
+
+        # 16. REDO deletion.
+        general.redo()
+        Report.result(Tests.deletion_redo, not postfx_shape_weight_entity.exists())
+
+        # 17. Look for errors or asserts.
+        TestHelper.wait_for_condition(lambda: error_tracer.has_errors or error_tracer.has_asserts, 1.0)
+        for error_info in error_tracer.errors:
+            Report.info(f"Error: {error_info.filename} {error_info.function} | {error_info.message}")
+        for assert_info in error_tracer.asserts:
+            Report.info(f"Assert: {assert_info.filename} {assert_info.function} | {assert_info.message}")
+
+
+if __name__ == "__main__":
+    from editor_python_test_tools.utils import Report
+    Report.start_test(AtomEditorComponents_postfx_shape_weight_AddedToEntity)