o3de/AutomatedTesting/Gem/PythonTests/assetpipeline/ap_fixtures/asset_processor_fixture.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

A fixture for using the Asset Processor, this will stop the asset processor after every test via
the teardown. Using the fixture at class level will stop the asset processor after the suite completes.
Using the fixture at test level will stop asset processor after the test completes. Calling this fixture as a test argument will still run the teardown to stop the Asset Processor.
"""

# Import Builtins
import pytest
import logging

# Import LyTestTools
import ly_test_tools.o3de.asset_processor as asset_processor_commands
import ly_test_tools.o3de.asset_processor_utils

logger = logging.getLogger(__name__)


@pytest.fixture
def asset_processor(request: pytest.fixture, workspace: pytest.fixture) -> asset_processor_commands.AssetProcessor:
    """
    Sets up usage of the asset proc
    :param request:
    :return: ly_test_tools.03de.asset_processor.AssetProcessor
    """

    # Initialize the Asset Processor
    ap = asset_processor_commands.AssetProcessor(workspace)

    # Custom teardown method for this fixture
    def teardown():
        logger.info("Running asset_processor_fixture teardown to stop the AP")
        ap.stop()

    request.addfinalizer(teardown)
    for n in ly_test_tools.o3de.asset_processor_utils.processList:
        assert not ly_test_tools.o3de.asset_processor_utils.check_ap_running(n), f"{n} process did not shutdown correctly."


    return ap