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

import os
import pytest

import ly_test_tools.environment.file_system as file_system
from ly_test_tools.o3de.editor_test import EditorSingleTest, EditorBatchedTest, EditorTestSuite


@pytest.mark.SUITE_main
@pytest.mark.parametrize("launcher_platform", ['windows_editor'])
@pytest.mark.parametrize("project", ["AutomatedTesting"])
class TestAutomationNoAutoTestMode(EditorTestSuite):

    # Disable -autotest_mode and -BatchMode. Tests cannot run in -BatchMode due to UI interactions, and these tests
    # interact with modal dialogs
    global_extra_cmdline_args = []

    # Helper for test level cleanup
    def cleanup_test_level(self, workspace):
        file_system.delete([os.path.join(workspace.paths.engine_root(), "AutomatedTesting", "Levels", "tmp_level")],
                           True, True)

    @pytest.mark.skip(reason="Skipped for intermittently failing.")
    class test_AssetPicker_UI_UX(EditorBatchedTest):
        from .EditorScripts import AssetPicker_UI_UX as test_module

    class test_BasicEditorWorkflows_ExistingLevel_EntityComponentCRUD(EditorBatchedTest):
        from .EditorScripts import BasicEditorWorkflows_ExistingLevel_EntityComponentCRUD as test_module

    class test_BasicEditorWorkflows_LevelEntityComponentCRUD(EditorSingleTest):

        # Custom setup and teardown to remove level created during test
        def setup(self, request, workspace):
            TestAutomationNoAutoTestMode.cleanup_test_level(self, workspace)

        def teardown(self, request, workspace, editor_test_results):
            TestAutomationNoAutoTestMode.cleanup_test_level(self, workspace)

        from .EditorScripts import BasicEditorWorkflows_LevelEntityComponentCRUD as test_module

    @pytest.mark.REQUIRES_gpu
    class test_BasicEditorWorkflows_GPU_LevelEntityComponentCRUD(EditorSingleTest):
        # Disable null renderer
        use_null_renderer = False

        # Custom teardown to remove level created during test
        def setup(self, request, workspace):
            TestAutomationNoAutoTestMode.cleanup_test_level(self, workspace)

        def teardown(self, request, workspace, editor_test_results):
            TestAutomationNoAutoTestMode.cleanup_test_level(self, workspace)

        from .EditorScripts import BasicEditorWorkflows_LevelEntityComponentCRUD as test_module

    @pytest.mark.skip(reason="Skipped for intermittently failing.")
    class test_InputBindings_Add_Remove_Input_Events(EditorBatchedTest):
        from .EditorScripts import InputBindings_Add_Remove_Input_Events as test_module


@pytest.mark.SUITE_main
@pytest.mark.parametrize("launcher_platform", ['windows_editor'])
@pytest.mark.parametrize("project", ["AutomatedTesting"])
class TestAutomationAutoTestMode(EditorTestSuite):

    # Enable only -autotest_mode for these tests. Tests cannot run in -BatchMode due to UI interactions
    global_extra_cmdline_args = ["-autotest_mode"]

    class test_AssetBrowser_SearchFiltering(EditorBatchedTest):
        from .EditorScripts import AssetBrowser_SearchFiltering as test_module

    class test_AssetBrowser_TreeNavigation(EditorSingleTest):
        from .EditorScripts import AssetBrowser_TreeNavigation as test_module

    class test_ComponentCRUD_Add_Delete_Components(EditorSingleTest):
        from .EditorScripts import ComponentCRUD_Add_Delete_Components as test_module

    @pytest.mark.REQUIRES_gpu
    class test_Docking_BasicDockedTools(EditorSingleTest):
        from .EditorScripts import Docking_BasicDockedTools as test_module

    class test_EntityOutliner_EntityOrdering(EditorSingleTest):
        from .EditorScripts import EntityOutliner_EntityOrdering as test_module

        # https://github.com/o3de/o3de/issues/10799
        extra_cmdline_args = ["-rhi=Null", "-NullRenderer"]

    class test_Menus_EditMenuOptions_Work(EditorBatchedTest):
        from .EditorScripts import Menus_EditMenuOptions as test_module

    class test_Menus_FileMenuOptions_Work(EditorBatchedTest):
        from .EditorScripts import Menus_FileMenuOptions as test_module

    class test_Menus_ViewMenuOptions_Work(EditorBatchedTest):
        from .EditorScripts import Menus_ViewMenuOptions as test_module


@pytest.mark.SUITE_main
@pytest.mark.parametrize("launcher_platform", ['windows_editor'])
@pytest.mark.parametrize("project", ["AutomatedTesting"])
class TestAutomation(EditorTestSuite):

    # These tests require no UI interaction or modal dialog interactions

    def cleanup_temp_levels(self, workspace):
        file_system.delete([os.path.join(workspace.paths.engine_root(), "AutomatedTesting", "Levels", "tmp_level_1")],
                        True, True)
        file_system.delete([os.path.join(workspace.paths.engine_root(), "AutomatedTesting", "Levels", "tmp_level_2")],
                        True, True)

    class test_EditorWorkflow_ParentEntityTransform_Affects_ChildEntityTransform(EditorBatchedTest):
        from .EditorScripts import EditorWorkflow_ParentEntityTransform_Affects_ChildEntityTransform as test_module

    class test_EditorWorkflow_ChildEntityTransform_Persists_After_ParentEntityTransform(EditorBatchedTest):
        from .EditorScripts import EditorWorkflow_ChildEntityTransform_Persists_After_ParentEntityTransform as test_module

    class test_EditorWorkflow_EditorCameraMovesToEntityTransformWithBeThisCamera(EditorSingleTest):
        from .EditorScripts import EditorWorkflow_EditorCameraMovesToEntityTransformWithBeThisCamera as test_module

    class test_EditorWorkflow_EditorCameraReturnsToOriginalPositionWhenTogglingBeThisCamera(EditorSingleTest):
        from .EditorScripts import EditorWorkflow_EditorCameraReturnsToOriginalPositionWhenTogglingBeThisCamera as test_module

    class test_EditorWorkflow_EditorCameraReturnsToOriginalPositionWhenLeavingGameMode(EditorSingleTest):
        from .EditorScripts import EditorWorkflow_EditorCameraReturnsToOriginalPositionWhenLeavingGameMode as test_module

    class test_EditorWorkflow_EditorCameraInBeThisCameraReturnsToOriginalPositionWhenLeavingGameMode(EditorSingleTest):
        from .EditorScripts import EditorWorkflow_EditorCameraInBeThisCameraReturnsToOriginalPositionWhenLeavingGameMode as test_module

    class test_EditorWorkflow_EditorCameraReturnsToOriginalPositionWhenLeavingFullscreenGameMode(EditorSingleTest):
        from .EditorScripts import EditorWorkflow_EditorCameraReturnsToOriginalPositionWhenLeavingFullscreenGameMode as test_module

    class test_EditorWorkflow_EditorCameraTransformCanBeModifiedWhileInBeThisCamera(EditorSingleTest):
        from .EditorScripts import EditorWorkflow_EditorCameraTransformCanBeModifiedWhileInBeThisCamera as test_module

    class test_EditorWorkflow_EditorCameraGameModeTransitionWithMultipleCamerasReportsNoErrors(EditorSingleTest):
        from .EditorScripts import EditorWorkflow_EditorCameraGameModeTransitionWithMultipleCamerasReportsNoErrors as test_module

    class test_EditorWorkflow_EditorCameraBeThisCameraIsClearedWhenChangingLevel(EditorSingleTest):
        # Custom teardown to remove level created during test
        def setup(self, request, workspace):
            self.cleanup_temp_levels(workspace)

        def teardown(self, request, workspace, editor_test_results):
            self.cleanup_temp_levels(workspace)
        
        from .EditorScripts import EditorWorkflow_EditorCameraBeThisCameraIsClearedWhenChangingLevel as test_module