loft-arch-vis-sample/Project/PythonTests/conftest.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

pytest test configuration file for launching LoftSample.GameLauncher tests.
"""

import logging
import os
import types

import pytest

import ly_test_tools.builtin.helpers as helpers
import ly_test_tools.environment.file_system as file_system
import ly_test_tools.log.log_monitor

logger = logging.getLogger(__name__)


@pytest.fixture(scope="function", autouse=True)
def clean_loftsample_gamelauncher_logs(request, workspace):
    """Deletes any LoftSample log files so that the test run can start with empty logs."""
    logs = ['Game.log']
    logger.info(f'Deleting log files for LoftSample.GameLauncher tests: {logs}')

    for log in logs:
        log_file = os.path.join(workspace.paths.project_log(), log)
        if os.path.exists(log_file):
            file_system.delete(file_list=[log_file],
                               del_files=True,
                               del_dirs=False)


@pytest.fixture(scope="function", autouse=True)
def loftsample_gamelauncher_log_monitor(request, workspace):
    """Creates a LyTestTools log monitor object for monitoring LoftSample.GameLauncher logs."""
    def is_alive(launcher_name):
        return True

    launcher = ly_test_tools.launchers.platforms.base.Launcher(workspace, [])  # Needed for log monitor to work.
    launcher.is_alive = types.MethodType(is_alive, launcher)
    file_to_monitor = os.path.join(workspace.paths.project_log(), 'Game.log')
    log_monitor = ly_test_tools.log.log_monitor.LogMonitor(launcher=launcher, log_file_path=file_to_monitor,  log_creation_max_wait_time=40)
    log_monitor.file_to_monitor = file_to_monitor

    return log_monitor