o3de/AutomatedTesting/Gem/PythonTests/editor/EditorScripts/Menus_ViewMenuOptions.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
"""


def Menus_ViewMenuOptions_Work():
    """
    Summary:
    Interact with View Menu options and verify if all the options are working.

    Expected Behavior:
    The View menu functions normally.

    Test Steps:
     1) Open an existing level
     2) Interact with View Menu options

    Note:
    - This test file must be called from the O3DE 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
    """

    import azlmbr.legacy.general as general
    import editor_python_test_tools.hydra_editor_utils as hydra
    import pyside_utils
    from editor_python_test_tools.utils import Report

    view_menu_options = [
        ("Viewport", "Go to Position"),
        ("Viewport", "Find Selected Entities in Viewport"),
        ("Viewport", "Go to Location"),
        ("Viewport", "Viewport Helpers", "Show Icons"),
        ("Viewport", "Viewport Helpers", "Show Helpers for all entities"),
        ("Viewport", "Viewport Helpers", "Show Helpers for selected entities"),
        ("Viewport", "Viewport Helpers", "Hide Helpers"),
        ("Refresh Style",)
    ]

    # 1) Open an existing simple level
    hydra.open_base_level()

    # The action manager doesn't register the menus until the next system tick, so need to wait
    # until the menu bar has been populated
    general.idle_enable(True)
    general.idle_wait_frames(1)

    # 2) Interact with View Menu options
    editor_window = pyside_utils.get_editor_main_window()
    for option in view_menu_options:
        try:
            action = pyside_utils.get_action_for_menu_path(editor_window, "View", *option)
            Report.info(f"Triggering {action.iconText()}")
            action.trigger()
            action_triggered = True
        except Exception as e:
            action_triggered = False
            print(e)
        menu_action_triggered = (
            f"{action.iconText()} action triggered successfully",
            f"Failed to trigger {action.iconText()} action"
        )
        Report.result(menu_action_triggered, action_triggered)


if __name__ == "__main__":

    from editor_python_test_tools.utils import Report
    Report.start_test(Menus_ViewMenuOptions_Work)