From eafb2fdce53822b263467c8cd5ddd36c3cdf3b61 Mon Sep 17 00:00:00 2001 From: AMZN-AlexOteiza <82234181+AMZN-AlexOteiza@users.noreply.github.com> Date: Thu, 11 Nov 2021 22:15:44 +0000 Subject: [PATCH] Fixed editor log path and improved editor log not found error string (#5357) * Fixed editor log path and improved editor log not found error string * Renamed any lowercase editor.log to Editor.log * Fix unit test failures Signed-off-by: AMZN-AlexOteiza Co-authored-by: aljanru --- .../Gem/PythonTests/automatedtesting_shared/base.py | 2 +- .../_internal/managers/abstract_resource_locator.py | 2 +- .../ly_test_tools/_internal/managers/platforms/linux.py | 4 ++-- .../ly_test_tools/_internal/managers/platforms/mac.py | 4 ++-- .../ly_test_tools/_internal/managers/platforms/windows.py | 4 ++-- Tools/LyTestTools/ly_test_tools/o3de/editor_test_utils.py | 4 ++-- Tools/LyTestTools/tests/unit/test_editor_test_utils.py | 4 ++-- Tools/LyTestTools/tests/unit/test_manager_platforms_mac.py | 2 +- .../LyTestTools/tests/unit/test_manager_platforms_windows.py | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) diff --git a/AutomatedTesting/Gem/PythonTests/automatedtesting_shared/base.py b/AutomatedTesting/Gem/PythonTests/automatedtesting_shared/base.py index cbb6102a44..41d693cb60 100755 --- a/AutomatedTesting/Gem/PythonTests/automatedtesting_shared/base.py +++ b/AutomatedTesting/Gem/PythonTests/automatedtesting_shared/base.py @@ -165,7 +165,7 @@ class TestAutomationBase: for line in f.readlines(): error_str += f"|{log_basename}| {line}" except Exception as ex: - error_str += "-- No log available --" + error_str += f"-- No log available ({ex})--" pytest.fail(error_str) diff --git a/Tools/LyTestTools/ly_test_tools/_internal/managers/abstract_resource_locator.py b/Tools/LyTestTools/ly_test_tools/_internal/managers/abstract_resource_locator.py index fccc94bdcc..4ff71a5b31 100755 --- a/Tools/LyTestTools/ly_test_tools/_internal/managers/abstract_resource_locator.py +++ b/Tools/LyTestTools/ly_test_tools/_internal/managers/abstract_resource_locator.py @@ -378,7 +378,7 @@ class AbstractResourceLocator(object): def editor_log(self): """ Return path to the project's editor log dir using the builds project and platform - :return: path to editor.log + :return: path to Editor.log """ raise NotImplementedError( "editor_log() is not implemented on the base AbstractResourceLocator() class. " diff --git a/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/linux.py b/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/linux.py index fea60cc9cb..151a4a3e2b 100644 --- a/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/linux.py +++ b/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/linux.py @@ -49,9 +49,9 @@ class _LinuxResourceManager(AbstractResourceLocator): def editor_log(self): """ - :return: path to editor.log + :return: path to Editor.log """ - return os.path.join(self.project_log(), "editor.log") + return os.path.join(self.project_log(), "Editor.log") class LinuxWorkspaceManager(AbstractWorkspaceManager): diff --git a/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/mac.py b/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/mac.py index cc8f23f0e1..4a187b188c 100755 --- a/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/mac.py +++ b/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/mac.py @@ -58,9 +58,9 @@ class _MacResourceLocator(AbstractResourceLocator): def editor_log(self): """ Return path to the project's editor log dir using the builds project and platform - :return: path to editor.log + :return: path to Editor.log """ - return os.path.join(self.project_log(), "editor.log") + return os.path.join(self.project_log(), "Editor.log") class MacWorkspaceManager(AbstractWorkspaceManager): diff --git a/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/windows.py b/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/windows.py index 1fad15acce..29289166d4 100755 --- a/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/windows.py +++ b/Tools/LyTestTools/ly_test_tools/_internal/managers/platforms/windows.py @@ -64,9 +64,9 @@ class _WindowsResourceLocator(AbstractResourceLocator): def editor_log(self): """ Return path to the project's editor log dir using the builds project and platform - :return: path to editor.log + :return: path to Editor.log """ - return os.path.join(self.project_log(), "editor.log") + return os.path.join(self.project_log(), "Editor.log") class WindowsWorkspaceManager(AbstractWorkspaceManager): diff --git a/Tools/LyTestTools/ly_test_tools/o3de/editor_test_utils.py b/Tools/LyTestTools/ly_test_tools/o3de/editor_test_utils.py index 35fbe93d37..9f1e01342c 100644 --- a/Tools/LyTestTools/ly_test_tools/o3de/editor_test_utils.py +++ b/Tools/LyTestTools/ly_test_tools/o3de/editor_test_utils.py @@ -126,9 +126,9 @@ def retrieve_editor_log_content(run_id: int, log_name: str, workspace: AbstractW with open(editor_log) as f: editor_info = "" for line in f: - editor_info += f"[editor.log] {line}" + editor_info += f"[{log_name}] {line}" except Exception as ex: - editor_info = f"-- Error reading editor.log: {str(ex)} --" + editor_info = f"-- Error reading {log_name}: {str(ex)} --" return editor_info def retrieve_last_run_test_index_from_output(test_spec_list: list[EditorTestBase], output: str) -> int: diff --git a/Tools/LyTestTools/tests/unit/test_editor_test_utils.py b/Tools/LyTestTools/tests/unit/test_editor_test_utils.py index bf7fae7189..9a52758067 100644 --- a/Tools/LyTestTools/tests/unit/test_editor_test_utils.py +++ b/Tools/LyTestTools/tests/unit/test_editor_test_utils.py @@ -119,7 +119,7 @@ class TestEditorTestUtils(unittest.TestCase): mock_log = 'mock log info' with mock.patch('builtins.open', mock.mock_open(read_data=mock_log)) as mock_file: - assert f'[editor.log] {mock_log}' == editor_test_utils.retrieve_editor_log_content(0, mock_logname, mock_workspace) + assert f'[{mock_logname}] {mock_log}' == editor_test_utils.retrieve_editor_log_content(0, mock_logname, mock_workspace) @mock.patch('ly_test_tools.o3de.editor_test_utils.retrieve_log_path') @mock.patch('ly_test_tools.environment.waiter.wait_for', mock.MagicMock()) @@ -127,7 +127,7 @@ class TestEditorTestUtils(unittest.TestCase): mock_retrieve_log_path.return_value = 'mock_log_path' mock_logname = 'mock_log.log' mock_workspace = mock.MagicMock() - expected = f"-- Error reading editor.log" + expected = f"-- Error reading {mock_logname}" assert expected in editor_test_utils.retrieve_editor_log_content(0, mock_logname, mock_workspace) diff --git a/Tools/LyTestTools/tests/unit/test_manager_platforms_mac.py b/Tools/LyTestTools/tests/unit/test_manager_platforms_mac.py index e91b810f9d..e195aa5796 100755 --- a/Tools/LyTestTools/tests/unit/test_manager_platforms_mac.py +++ b/Tools/LyTestTools/tests/unit/test_manager_platforms_mac.py @@ -76,7 +76,7 @@ class TestMacResourceLocator(object): mock_project) expected = os.path.join( mac_resource_locator.project_log(), - 'editor.log') + 'Editor.log') assert mac_resource_locator.editor_log() == expected diff --git a/Tools/LyTestTools/tests/unit/test_manager_platforms_windows.py b/Tools/LyTestTools/tests/unit/test_manager_platforms_windows.py index 7e30289da0..b7cc8edf40 100755 --- a/Tools/LyTestTools/tests/unit/test_manager_platforms_windows.py +++ b/Tools/LyTestTools/tests/unit/test_manager_platforms_windows.py @@ -80,7 +80,7 @@ class TestWindowsResourceLocator(object): mock_build_directory, mock_project) expected = os.path.join( windows_resource_locator.project_log(), - 'editor.log') + 'Editor.log') assert windows_resource_locator.editor_log() == expected