Merge pull request #4675 from aws-lumberyard-dev/editor_test_tools_cleanup

Editor test tools cleanup
2021-10-29 15:47:26 -07:00
parent e871dff70e 4e2de0170c
commit ea4bc31b38
9 changed files with 1655 additions and 128 deletions
@@ -0,0 +1,162 @@
+"""
+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 pytest
+import os
+import unittest.mock as mock
+import unittest
+
+import ly_test_tools.o3de.editor_test_utils as editor_test_utils
+
+pytestmark = pytest.mark.SUITE_smoke
+
+class TestEditorTestUtils(unittest.TestCase):
+
+    @mock.patch('ly_test_tools.environment.process_utils.kill_processes_named')
+    def test_KillAllLyProcesses_IncludeAP_CallsCorrectly(self, mock_kill_processes_named):
+        process_list = ['Editor', 'Profiler', 'RemoteConsole', 'AssetProcessor', 'AssetProcessorBatch', 'AssetBuilder']
+
+        editor_test_utils.kill_all_ly_processes(include_asset_processor=True)
+        mock_kill_processes_named.assert_called_once_with(process_list, ignore_extensions=True)
+
+    @mock.patch('ly_test_tools.environment.process_utils.kill_processes_named')
+    def test_KillAllLyProcesses_NotIncludeAP_CallsCorrectly(self, mock_kill_processes_named):
+        process_list = ['Editor', 'Profiler', 'RemoteConsole']
+        ap_process_list = ['AssetProcessor', 'AssetProcessorBatch', 'AssetBuilder']
+
+        editor_test_utils.kill_all_ly_processes(include_asset_processor=False)
+        mock_kill_processes_named.assert_called_once()
+        assert ap_process_list not in mock_kill_processes_named.call_args[0]
+
+    def test_GetTestcaseModuleFilepath_NoExtension_ReturnsPYExtension(self):
+        mock_module = mock.MagicMock()
+        file_path = os.path.join('path', 'under_test')
+        mock_module.__file__ = file_path
+
+        assert file_path + '.py' == editor_test_utils.get_testcase_module_filepath(mock_module)
+
+    def test_GetTestcaseModuleFilepath_PYExtension_ReturnsPYExtension(self):
+        mock_module = mock.MagicMock()
+        file_path = os.path.join('path', 'under_test.py')
+        mock_module.__file__ = file_path
+
+        assert file_path == editor_test_utils.get_testcase_module_filepath(mock_module)
+
+    def test_GetModuleFilename_PythonModule_ReturnsFilename(self):
+        mock_module = mock.MagicMock()
+        file_path = os.path.join('path', 'under_test.py')
+        mock_module.__file__ = file_path
+
+        assert 'under_test' == editor_test_utils.get_module_filename(mock_module)
+
+    def test_RetrieveLogPath_NormalProject_ReturnsLogPath(self):
+        mock_workspace = mock.MagicMock()
+        mock_workspace.paths.project.return_value = 'mock_project_path'
+        expected = os.path.join('mock_project_path', 'user', 'log_test_0')
+
+        assert expected == editor_test_utils.retrieve_log_path(0, 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())
+    def test_RetrieveCrashOutput_CrashLogExists_ReturnsLogInfo(self, mock_retrieve_log_path):
+        mock_retrieve_log_path.return_value = 'mock_log_path'
+        mock_workspace = mock.MagicMock()
+        mock_log = 'mock crash info'
+
+        with mock.patch('builtins.open', mock.mock_open(read_data=mock_log)) as mock_file:
+            assert mock_log == editor_test_utils.retrieve_crash_output(0, mock_workspace, 0)
+
+    @mock.patch('ly_test_tools.o3de.editor_test_utils.retrieve_log_path')
+    @mock.patch('ly_test_tools.environment.waiter.wait_for', mock.MagicMock())
+    def test_RetrieveCrashOutput_CrashLogNotExists_ReturnsError(self, mock_retrieve_log_path):
+        mock_retrieve_log_path.return_value = 'mock_log_path'
+        mock_workspace = mock.MagicMock()
+        expected = "-- No crash log available --\n[Errno 2] No such file or directory: 'mock_log_path\\\\error.log'"
+
+        assert expected == editor_test_utils.retrieve_crash_output(0, mock_workspace, 0)
+
+    @mock.patch('os.path.getmtime', mock.MagicMock())
+    @mock.patch('os.rename')
+    @mock.patch('time.strftime')
+    @mock.patch('ly_test_tools.o3de.editor_test_utils.retrieve_log_path')
+    @mock.patch('os.path.exists')
+    def test_CycleCrashReport_DmpExists_NamedCorrectly(self, mock_exists, mock_retrieve_log_path, mock_strftime,
+                                                       mock_rename):
+        mock_exists.side_effect = [False, True]
+        mock_retrieve_log_path.return_value = 'mock_log_path'
+        mock_workspace = mock.MagicMock()
+        mock_strftime.return_value = 'mock_strftime'
+
+        editor_test_utils.cycle_crash_report(0, mock_workspace)
+        mock_rename.assert_called_once_with(os.path.join('mock_log_path', 'error.dmp'),
+                                            os.path.join('mock_log_path', 'error_mock_strftime.dmp'))
+
+    @mock.patch('os.path.getmtime', mock.MagicMock())
+    @mock.patch('os.rename')
+    @mock.patch('time.strftime')
+    @mock.patch('ly_test_tools.o3de.editor_test_utils.retrieve_log_path')
+    @mock.patch('os.path.exists')
+    def test_CycleCrashReport_LogExists_NamedCorrectly(self, mock_exists, mock_retrieve_log_path, mock_strftime,
+                                                       mock_rename):
+        mock_exists.side_effect = [True, False]
+        mock_retrieve_log_path.return_value = 'mock_log_path'
+        mock_workspace = mock.MagicMock()
+        mock_strftime.return_value = 'mock_strftime'
+
+        editor_test_utils.cycle_crash_report(0, mock_workspace)
+        mock_rename.assert_called_once_with(os.path.join('mock_log_path', 'error.log'),
+                                            os.path.join('mock_log_path', 'error_mock_strftime.log'))
+
+    @mock.patch('ly_test_tools.o3de.editor_test_utils.retrieve_log_path')
+    @mock.patch('ly_test_tools.environment.waiter.wait_for', mock.MagicMock())
+    def test_RetrieveEditorLogContent_CrashLogExists_ReturnsLogInfo(self, mock_retrieve_log_path):
+        mock_retrieve_log_path.return_value = 'mock_log_path'
+        mock_logname = 'mock_log.log'
+        mock_workspace = mock.MagicMock()
+        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)
+
+    @mock.patch('ly_test_tools.o3de.editor_test_utils.retrieve_log_path')
+    @mock.patch('ly_test_tools.environment.waiter.wait_for', mock.MagicMock())
+    def test_RetrieveEditorLogContent_CrashLogNotExists_ReturnsError(self, mock_retrieve_log_path):
+        mock_retrieve_log_path.return_value = 'mock_log_path'
+        mock_logname = 'mock_log.log'
+        mock_workspace = mock.MagicMock()
+        expected = f"-- Error reading editor.log"
+
+        assert expected in editor_test_utils.retrieve_editor_log_content(0, mock_logname, mock_workspace)
+
+    def test_RetrieveLastRunTestIndexFromOutput_SecondTestFailed_Returns0(self):
+        mock_test = mock.MagicMock()
+        mock_test.__name__ = 'mock_test_name'
+        mock_test_list = [mock_test]
+        mock_editor_output = 'mock_test_name\n' \
+                             'mock_test_name_1'
+
+        assert 0 == editor_test_utils.retrieve_last_run_test_index_from_output(mock_test_list, mock_editor_output)
+
+    def test_RetrieveLastRunTestIndexFromOutput_TenthTestFailed_Returns9(self):
+        mock_test_list = []
+        mock_editor_output = ''
+        for x in range(10):
+            mock_test = mock.MagicMock()
+            mock_test.__name__ = f'mock_test_name_{x}'
+            mock_test_list.append(mock_test)
+            mock_editor_output += f'{mock_test.__name__}\n'
+        mock_editor_output += 'mock_test_name_x'
+        assert 9 == editor_test_utils.retrieve_last_run_test_index_from_output(mock_test_list, mock_editor_output)
+
+    def test_RetrieveLastRunTestIndexFromOutput_FirstItemFailed_Returns0(self):
+        mock_test_list = []
+        mock_editor_output = ''
+        for x in range(10):
+            mock_test = mock.MagicMock()
+            mock_test.__name__ = f'mock_test_name_{x}'
+            mock_test_list.append(mock_test)
+
+        assert 0 == editor_test_utils.retrieve_last_run_test_index_from_output(mock_test_list, mock_editor_output)
@@ -0,0 +1,41 @@
+"""
+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 pytest
+import os
+import unittest.mock as mock
+import unittest
+
+import ly_test_tools._internal.pytest_plugin.editor_test as editor_test
+
+pytestmark = pytest.mark.SUITE_smoke
+
+class TestEditorTest(unittest.TestCase):
+
+    @mock.patch('inspect.isclass', mock.MagicMock(return_value=True))
+    def test_PytestPycollectMakeitem_ValidArgs_CallsCorrectly(self):
+        mock_collector = mock.MagicMock()
+        mock_name = mock.MagicMock()
+        mock_obj = mock.MagicMock()
+        mock_base = mock.MagicMock()
+        mock_obj.__bases__ = [mock_base]
+
+        editor_test.pytest_pycollect_makeitem(mock_collector, mock_name, mock_obj)
+        mock_base.pytest_custom_makeitem.assert_called_once_with(mock_collector, mock_name, mock_obj)
+
+    def test_PytestCollectionModifyitem_OneValidClass_CallsOnce(self):
+        mock_item = mock.MagicMock()
+        mock_class = mock.MagicMock()
+        mock_class.pytest_custom_modify_items = mock.MagicMock()
+        mock_item.instance.__class__ = mock_class
+        mock_session = mock.MagicMock()
+        mock_items = [mock_item, mock.MagicMock()]
+        mock_config = mock.MagicMock()
+
+        generator = editor_test.pytest_collection_modifyitems(mock_session, mock_items, mock_config)
+        for x in generator:
+            pass
+        assert mock_class.pytest_custom_modify_items.call_count == 1