lumberyard-employee-dm
3dec5d3b71
* LYN-2537 Moved the Engine and Editor folder to be within the EngineAssets folder * Fixed Documentation in bootstrap.cfg to correct the path to the user project specific registry file * Adding a newline to the output of AssetCatalog 'Registering asset..., but type is not set' message * Updating the AssetProcessorPlatformConfig.setreg Scan Folder to detect the @ENGINEROOT@/EngineAssets/Engine path for engine runtime assets and @ENGINEROOT@/EngineAssets/Editor path for engine tool assets * Updating references to Icons and other assets to account for moving the Engine and Editor folder under a single EngineAssets folder * Moving the Engine Settings Registry folder from Engine/Registry -> Registry * Removed the LY_PROJECT_CMAKE_PATH define as it is not portable to other locations. It is hard coded to the project location that was used for the CMake configuration. Furthermore it paths with backslashes within it are treated as escape characters and not a path separator * Updated the LyTestTools asset_processor.py script to copy the exclude.filetag from the EngineAssets/Engine directory now * Fixed Atom Shader Preprocessing when running using an External Project * Updated the TSGenerateAction.cpp to fix the build error with using a renamed variable * Updated the Install_Common.cmake ly_setup_others function to install the EngineAssets directory and the each of the Gem's Assets directory while maintaining the relative directory structure to the Engine Root Also updated the install step to install the Registry folder at the engine root * Fixed the copying of the Registry folder to be in the install root, instead of under a second 'Registry' folder * Moving the AssetProcessorPlatformConfig.setreg file over to the Registry folder * Updated the LyTestTools and C++ code to point that the new location of the AssetProcessorPlatformConfig.setreg file inside of the Registry folder * Renamed Test AssetProcessor*Config.ini files to have the .setreg extension * Converted the AssetProcessor test setreg files from ini format to json format using the SerializeContextTools convert-ini command * Updated the AssetProcessor CMakeLists.txt to copy over the test setreg files to the build folder * Updated the assetprocessor test file list to point at the renamed AsssetProcessor*Config setreg filenames * Removed the Output Prefix code from the AssetProcessor. The complexity that it brought to the AP code is not needed, as users can replicate the behavior by just moving there assets underneath a another folder, underneath the scan folder * Adding back support to read the AssetProcessorPlatformConfig.setreg file from the asset root. This is only needed for C++ UnitTests as they run in an environment where the accessing the Engine Settings Registry is not available * Updating the Install_common.cmake logic to copy any "Assets" folder to the install layout. The Script has also been updated to copy over the "Assets" folder in the Engine Root to the install layout instead of an "EngineAssets" folder * Updating References to EngineAssets source asset folder in code to be the Assets source folder * Moved the Engine Source Asset folder of 'EngineAssets' to a new folder name of 'Assets'. This is inline with the naming scheme we use for Gem asset folders * Adding the EngineFinder.cmake to the AutomatedTesting project to allow it to work in a project centric manner * Updating the LyTestTools copy_assets_to_project function to be able to copy assets with folders to the temporary project root Fixed an issue in LyTestTools where the temporary log directory could have shutil.rmtree being called twice on it leading to an exception which fails an automated test Updated the asset_procesor_gui_tests_2 AddScanFolder test to not use the output prefix, but instead place the source asset root into a subdirectory * Correct the AssetProcessorPlatformConfig Scan Folders for the EngineAssets directory to point at the Assets directory * Updated the asset procesor batch dependency test scan folder to point at the 'Assets' folder instead of 'EngineAssets'
230 lines
12 KiB
Python
Executable File
230 lines
12 KiB
Python
Executable File
"""
|
|
All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
|
its licensors.
|
|
|
|
For complete copyright and license terms please see the LICENSE at the root of this
|
|
distribution (the "License"). All use of this software is governed by the License,
|
|
or, if provided, by the license below or the license accompanying this file. Do not
|
|
remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
Unit Tests for ly_test_tools._internal.managers.abstract_resource_locator
|
|
"""
|
|
import os
|
|
|
|
import unittest.mock as mock
|
|
import pytest
|
|
|
|
import ly_test_tools._internal.managers.abstract_resource_locator as abstract_resource_locator
|
|
|
|
pytestmark = pytest.mark.SUITE_smoke
|
|
|
|
mock_initial_path = "mock_initial_path"
|
|
mock_engine_root = "mock_engine_root"
|
|
mock_dev_path = "mock_dev_path"
|
|
mock_build_directory = 'mock_build_directory'
|
|
mock_project = 'mock_project'
|
|
|
|
|
|
class TestFindEngineRoot(object):
|
|
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.abspath')
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.exists')
|
|
def test_FindEngineRoot_InitialPathExists_ReturnsTuple(self, mock_path_exists, mock_abspath):
|
|
mock_path_exists.return_value = True
|
|
|
|
engine_root = abstract_resource_locator._find_engine_root(mock_engine_root)
|
|
|
|
assert engine_root == mock_engine_root
|
|
mock_path_exists.assert_called_once()
|
|
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.abspath')
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.exists')
|
|
def test_FindEngineRoot_InitialPathDoesntExist_RaisesOSError(self, mock_path_exists, mock_abspath):
|
|
mock_path_exists.return_value = False
|
|
mock_abspath.return_value = mock_engine_root
|
|
|
|
with pytest.raises(OSError):
|
|
abstract_resource_locator._find_engine_root(mock_initial_path)
|
|
|
|
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.abspath',
|
|
mock.MagicMock(return_value=mock_initial_path))
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator._find_engine_root',
|
|
mock.MagicMock(return_value=mock_engine_root))
|
|
class TestAbstractResourceLocator(object):
|
|
|
|
def test_Init_HasEngineRoot_SetsAttrs(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
|
|
assert mock_abstract_resource_locator._build_directory == mock_build_directory
|
|
assert mock_abstract_resource_locator._engine_root == mock_engine_root
|
|
assert mock_abstract_resource_locator._project == mock_project
|
|
|
|
def test_BasePath_IsCalled_ReturnsBasePath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
|
|
assert mock_abstract_resource_locator.engine_root() == mock_engine_root
|
|
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.isfile')
|
|
def test_3rdParty_IsCalledHasTxtFile_Returns3rdPartyPath(self, mock_isfile):
|
|
mock_isfile.return_value = True
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator._engine_root, '3rdParty')
|
|
|
|
assert mock_abstract_resource_locator.third_party() == expected_path
|
|
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.isfile')
|
|
def test_3rdParty_IsCalledNoTxtFile_RaisesFileNotFoundError(self, mock_isfile):
|
|
mock_isfile.return_value = False
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
|
|
with pytest.raises(FileNotFoundError):
|
|
mock_abstract_resource_locator.third_party()
|
|
mock_isfile.assert_called_once()
|
|
|
|
def test_BuildDirectory_IsCalled_ReturnsBuildDirectoryPath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
|
|
assert mock_abstract_resource_locator.build_directory() == mock_build_directory
|
|
|
|
def test_Project_IsCalled_ReturnsProjectPath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.engine_root(), mock_project)
|
|
|
|
assert mock_abstract_resource_locator.project() == expected_path
|
|
|
|
def test_AssetProcessor_IsCalled_ReturnsAssetProcessorPath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.build_directory(), 'AssetProcessor')
|
|
|
|
assert mock_abstract_resource_locator.asset_processor() == expected_path
|
|
|
|
def test_AssetProcessorBatch_IsCalled_ReturnsAssetProcessorBatchPath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.build_directory(), 'AssetProcessorBatch')
|
|
|
|
assert mock_abstract_resource_locator.asset_processor_batch() == expected_path
|
|
|
|
def test_Editor_IsCalled_ReturnsEditorPath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.build_directory(), 'Editor')
|
|
|
|
assert mock_abstract_resource_locator.editor() == expected_path
|
|
|
|
def test_Cache_IsCalled_ReturnsCachePath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.cache())
|
|
|
|
assert mock_abstract_resource_locator.cache() == expected_path
|
|
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.exists')
|
|
def test_GetShaderCompilerPath_IsCalledExecutablePathExists_ReturnsGetShaderCompilerPath(self, mock_path_exists):
|
|
mock_path_exists.return_value = True
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.build_directory(), 'CrySCompileServer')
|
|
|
|
assert mock_abstract_resource_locator.get_shader_compiler_path() == expected_path
|
|
|
|
def test_GetShaderCompilerDir_IsCalled_ReturnsShaderCompilerDir(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = mock_abstract_resource_locator.build_directory()
|
|
|
|
assert mock_build_directory == expected_path
|
|
|
|
def test_ShaderCompilerConfigFile_IsCalled_ReturnsShaderCompilerConfigPath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.build_directory(), 'config.ini')
|
|
|
|
assert mock_abstract_resource_locator.shader_compiler_config_file() == expected_path
|
|
|
|
def test_ShaderCache_IsCalled_ReturnsShaderCacheDir(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.build_directory(), 'Cache')
|
|
|
|
assert mock_abstract_resource_locator.shader_cache() == expected_path
|
|
|
|
def test_BootstrapConfigFile_IsCalled_ReturnBootstrapConfigFilePath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.engine_root(), 'bootstrap.cfg')
|
|
|
|
assert mock_abstract_resource_locator.bootstrap_config_file() == expected_path
|
|
|
|
def test_AssetProcessorConfigFile_IsCalled_ReturnsAssetProcessorConfigFilePath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.engine_root(), 'Registry', 'AssetProcessorPlatformConfig.setreg')
|
|
|
|
assert mock_abstract_resource_locator.asset_processor_config_file() == expected_path
|
|
|
|
def test_AutoexecFile_IsCalled_ReturnsAutoexecFilePath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.engine_root(),
|
|
mock_abstract_resource_locator._project,
|
|
'autoexec.cfg')
|
|
|
|
assert mock_abstract_resource_locator.autoexec_file() == expected_path
|
|
|
|
def test_TestResults_IsCalled_TestResultsPath(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_abstract_resource_locator.engine_root(), 'TestResults')
|
|
|
|
assert mock_abstract_resource_locator.test_results() == expected_path
|
|
|
|
@mock.patch('ly_test_tools._internal.managers.abstract_resource_locator.os.path.expanduser')
|
|
def test_DevicesFile_IsCalled_ReturnsDevicesFilePath(self, mock_expanduser):
|
|
mock_expanded_path = 'C:/somepath/'
|
|
mock_expanduser.return_value = mock_expanded_path
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
expected_path = os.path.join(mock_expanded_path, 'ly_test_tools', 'devices.ini')
|
|
|
|
assert mock_abstract_resource_locator.devices_file() == expected_path
|
|
|
|
def test_PlatformConfigFile_NotImplemented_RaisesNotImplementedError(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
with pytest.raises(NotImplementedError):
|
|
mock_abstract_resource_locator.platform_config_file()
|
|
|
|
def test_PlatformCache_NotImplemented_RaisesNotImplementedError(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
with pytest.raises(NotImplementedError):
|
|
mock_abstract_resource_locator.platform_cache()
|
|
|
|
def test_ProjectLog_NotImplemented_RaisesNotImplementedError(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
with pytest.raises(NotImplementedError):
|
|
mock_abstract_resource_locator.project_log()
|
|
|
|
def test_ProjectScreenshots_NotImplemented_RaisesNotImplementedError(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
with pytest.raises(NotImplementedError):
|
|
mock_abstract_resource_locator.project_screenshots()
|
|
|
|
def test_EditorLog_NotImplemented_RaisesNotImplementedError(self):
|
|
mock_abstract_resource_locator = abstract_resource_locator.AbstractResourceLocator(
|
|
mock_build_directory, mock_project)
|
|
with pytest.raises(NotImplementedError):
|
|
mock_abstract_resource_locator.editor_log()
|