o3de/AutomatedTesting/Gem/PythonTests/Physics/tests/shape_collider/ShapeCollider_CanBeAddedWitNoWarnings.py

"""
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

Test case ID : C19578021
Test Case Title : Verify that a shape collider component may be added to an entity along with one or more PhysX collider components

"""


# fmt: off
class Tests():
    create_collider_entity       = ("Created Collider Entity",    "Failed to create Collider Entity")
    add_physx_shape_collider     = ("PhysX Shape Collider added", "Failed to add PhysX Shape Collider")
    add_box_shape                = ("Box Shape added",            "Failed to add Box Shape")
    add_physx_primitive_collider = ("PhysX Primitive Collider added", "Failed to add PhysX Primitive Collider")
    add_physx_mesh_collider      = ("PhysX Mesh Collider added",  "Failed to add PhysX Mesh Collider")
    no_warnings_found            = ("Trace found no warnings",    "One or more components has been removed")
# fmt: on


def ShapeCollider_CanBeAddedWitNoWarnings():
    """
    Summary:
     Adding a PhysX Primitive Collider and PhysX Mesh Collider components when a PhysX Shape Collider and Box Shape components are already present

    Expected Behavior:
     When adding the PhysX Primitive Collider and PhysX Mesh Collider, there should be no warnings in the entity outliner

    Test Steps:
     1) Load the empty level
     2) Create an entity
     3) Add the PhysX Shape Collider and a Box Shape components
     4) Start the Tracer to catch any warnings
     5) Add the PhysX Primitive Collider component
     6) Add the PhysX Mesh Collider component
     7) Verify there are no warnings in the entity outliner

    Note:
     - This test file must be called from the Open 3D Engine Editor command terminal
     - Any passed and failed tests are written to the Editor.log file.
            Parsing the file or running a log_monitor are required to observe the test results.

    :return: None
    """
    # Helper Files

    from editor_python_test_tools.editor_entity_utils import EditorEntity as Entity
    from editor_python_test_tools.utils import Report
    from editor_python_test_tools.utils import TestHelper as helper
    from editor_python_test_tools.utils import Tracer
    from consts.physics import PHYSX_PRIMITIVE_COLLIDER
    from consts.physics import PHYSX_SHAPE_COLLIDER
    from consts.physics import PHYSX_MESH_COLLIDER

    import editor_python_test_tools.hydra_editor_utils as hydra

    # Open 3D Engine Imports
    import azlmbr.legacy.general as general

    # 1) Load the empty level
    hydra.open_base_level()

    # 2) Create an entity
    collider_entity = Entity.create_editor_entity("Collider")
    collider_entity.add_component("PhysX Static Rigid Body")
    Report.result(Tests.create_collider_entity, collider_entity.id.IsValid())

    # 3) Add the PhysX Shape Collider and a Box Shape components
    collider_entity.add_component(PHYSX_SHAPE_COLLIDER)
    Report.result(Tests.add_physx_shape_collider, collider_entity.has_component(PHYSX_SHAPE_COLLIDER))

    collider_entity.add_component("Box Shape")
    Report.result(Tests.add_box_shape, collider_entity.has_component("Box Shape"))

    # 4) Start the Tracer to catch any warnings while adding the PhysX Collider
    with Tracer() as section_tracer:
        # 5) Add the PhysX Primitive Collider component
        collider_entity.add_component(PHYSX_PRIMITIVE_COLLIDER)
        Report.result(Tests.add_physx_primitive_collider, collider_entity.has_component(PHYSX_PRIMITIVE_COLLIDER))
        
        # 6) Add the PhysX Mesh Collider component
        collider_entity.add_component(PHYSX_MESH_COLLIDER)
        Report.result(Tests.add_physx_mesh_collider, collider_entity.has_component(PHYSX_MESH_COLLIDER))

    # 7) Verify there are no warnings in the entity outliner
    success_condition = not section_tracer.has_warnings and not section_tracer.has_errors
    Report.result(Tests.no_warnings_found, success_condition)

    if not success_condition:
        exception_str = ""
        if section_tracer.has_warnings:
            exception_str += f"Warnings found: {section_tracer.warnings}\n"
        if section_tracer.has_errors:
            exception_str += f"Errors found: {section_tracer.errors}"
        Report.failure(exception_str)


if __name__ == "__main__":
    from editor_python_test_tools.utils import Report
    Report.start_test(ShapeCollider_CanBeAddedWitNoWarnings)