Automated test for bundle mode that creates and mounts a bundle with a level.pak file in it, and verifies that occurs. (#5805)

This is a regression test for bundle mode causing the editor to crash if you mount a bundle containing a level.pak file.

Signed-off-by: AMZN-stankowi <4838196+AMZN-stankowi@users.noreply.github.com>

AutomatedTesting/Gem/PythonTests/assetpipeline/asset_processor_tests/CMakeLists.txt

@@ -103,6 +103,19 @@ if(PAL_TRAIT_BUILD_TESTS_SUPPORTED AND PAL_TRAIT_BUILD_HOST_TOOLS)
             AZ::AssetBundlerBatch
     )
 
+    ly_add_pytest(
+        NAME AssetPipelineTests.BundleMode
+        PATH ${CMAKE_CURRENT_LIST_DIR}/bundle_mode_tests.py
+        EXCLUDE_TEST_RUN_TARGET_FROM_IDE
+        TEST_SERIAL
+        TEST_SUITE periodic
+        RUNTIME_DEPENDENCIES
+            AZ::AssetProcessor
+            AZ::AssetBundlerBatch
+            Legacy::Editor
+            AutomatedTesting.Assets
+    )
+
     ly_add_pytest(
         NAME AssetPipelineTests.AssetBuilder
         PATH ${CMAKE_CURRENT_LIST_DIR}/asset_builder_tests.py

AutomatedTesting/Gem/PythonTests/assetpipeline/asset_processor_tests/bundle_mode_in_editor_tests.py

@@ -0,0 +1,20 @@
+"""
+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 azlmbr.bus
+import azlmbr.editor
+import azlmbr.legacy.general
+import sys
+
+# Print out the passed in bundle_path, so the outer test can verify this was sent in correctly
+bundle_path = sys.argv[1]
+print('Bundle mode test running with path {}'.format(sys.argv[1]))
+
+# Turn on bundle mode. This will trigger some printouts that the outer test logic will validate.
+azlmbr.legacy.general.set_cvar_integer("sys_report_files_not_found_in_paks", 1)
+azlmbr.legacy.general.run_console(f"loadbundles {bundle_path}")
+
+azlmbr.editor.EditorToolsApplicationRequestBus(azlmbr.bus.Broadcast, 'ExitNoPrompt')

AutomatedTesting/Gem/PythonTests/assetpipeline/asset_processor_tests/bundle_mode_tests.py

@@ -0,0 +1,93 @@
+"""
+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 os
+import pytest
+import logging
+import sys
+import time
+pytest.importorskip('ly_test_tools')
+
+import ly_test_tools.environment.file_system as fs
+import ly_test_tools.environment.waiter as waiter
+import ly_test_tools.log.log_monitor
+
+from ..ap_fixtures.asset_processor_fixture import asset_processor as asset_processor
+from ..ap_fixtures.bundler_batch_setup_fixture import bundler_batch_setup_fixture as bundler_batch_helper
+from ..ap_fixtures.timeout_option_fixture import timeout_option_fixture as timeout
+
+@pytest.mark.SUITE_periodic
+@pytest.mark.parametrize('launcher_platform', ['windows_editor'])
+@pytest.mark.parametrize('project', ['AutomatedTesting'])
+@pytest.mark.parametrize('level', ['auto_test'])
+class TestBundleMode(object):
+    def test_bundle_mode_with_levels_mounts_bundles_correctly(self, request, editor, level, launcher_platform,
+                                                              asset_processor, workspace, bundler_batch_helper):
+        level_pak = os.path.join("levels", level, "level.pak")
+
+        bundles_folder = os.path.join(workspace.paths.project(), "Bundles")
+        bundle_request_path = os.path.join(bundles_folder, "bundle.pak")
+        bundle_result_path = os.path.join(bundles_folder,
+                                          bundler_batch_helper.platform_file_name(
+                                              "bundle.pak", workspace.asset_processor_platform))
+
+        # Create target 'Bundles' folder if it doesn't exist
+        if not os.path.exists(bundles_folder):
+            os.mkdir(bundles_folder)
+        # Delete target bundle file if it already exists
+        if os.path.exists(bundle_result_path):
+            fs.delete([bundle_result_path], True, False)
+
+        # Make asset list file to use in the bundle
+        bundler_batch_helper.call_assetLists(
+            addSeed=level_pak,
+            assetListFile=bundler_batch_helper["asset_info_file_request"],
+        )
+
+        # Make bundle in <project_folder>/Bundles
+        bundler_batch_helper.call_bundles(
+            assetListFile=bundler_batch_helper["asset_info_file_result"],
+            outputBundlePath=bundle_request_path,
+            maxSize="2048",
+        )
+
+        # Ensure the bundle was created
+        assert os.path.exists(bundle_result_path), f"Bundle was not created at location: {bundle_result_path}"
+
+        # The editor flips the slash direction in some of the printouts
+        bundle_result_path_editor_separator = bundle_result_path.replace('\\', '/')
+
+        expected_lines = [
+            # A beginning of test printout can help debug where failures occur, if this line is missing
+            # then the Editor didn't launch, didn't run the Python test, or didn't pass in the right parameter
+            f'Bundle mode test running with path {bundles_folder}',
+            # These printouts happen in response to the loadbundles call, and verify this bundle is actually loaded
+            f"[CONSOLE] Executing console command 'loadbundles {bundles_folder}'",
+            f'(BundlingSystem) - Loading bundles from {bundles_folder} of type .pak',
+            f'(Archive) - Opening archive file {bundle_result_path_editor_separator}',
+        ]
+        unexpected_lines = []
+
+        timeout = 180
+        halt_on_unexpected = False
+        test_directory = os.path.join(os.path.dirname(__file__))
+        test_file = os.path.join(test_directory, 'bundle_mode_in_editor_tests.py')
+        editor.args.extend(['-NullRenderer', '-rhi=Null', "--skipWelcomeScreenDialog",
+                            "--autotest_mode", "--runpythontest", test_file, "--runpythonargs", bundles_folder])
+
+        with editor.start(launch_ap=True):
+            editor_log_file = os.path.join(editor.workspace.paths.project_log(), 'Editor.log')
+            log_monitor = ly_test_tools.log.log_monitor.LogMonitor(editor, editor_log_file)
+            waiter.wait_for(
+                lambda: editor.is_alive(),
+                timeout,
+                exc=("Log file '{}' was never opened by another process.".format(editor_log_file)),
+                interval=1)
+            log_monitor.monitor_log_for_lines(expected_lines, unexpected_lines, halt_on_unexpected, timeout)
+
+        # Delete the bundle created and used in this test
+        fs.delete([bundle_result_path], True, False)

Tools/LyTestTools/ly_test_tools/launchers/platforms/base.py

@@ -91,7 +91,7 @@ class Launcher(object):
                         open(os.path.join(self.workspace.paths.project_log(), artifact), 'w').close() # clear it
                         log.info(f"Clearing pre-existing artifact {artifact} from calling Launcher.setup()")
                 except PermissionError:
-                    log.warn(f'Unable to remove artifact: {artifact}, skipping.')
+                    log.warning(f'Unable to remove artifact: {artifact}, skipping.')
                     pass
 
         # In case this is the first run, we will create default logs to prevent the logmonitor from not finding the file