Adding EditorPython methods to Multiplayer gem for launching the editor gamemode with a server. Adding a test for networkinput with scriptcanvas to ensure the autonomous client can create input and that the server can receive and process the input via script canvas.

Signed-off-by: Gene Walters <genewalt@amazon.com>
2021-10-18 21:47:40 -07:00
parent d097a4e951
commit 580153b16e
16 changed files with 2887 additions and 12 deletions
@@ -58,3 +58,6 @@ add_subdirectory(smoke)

 ## AWS ##
 add_subdirectory(AWS)
+
+## Multiplayer ##
+add_subdirectory(Multiplayer)
@@ -14,6 +14,7 @@ from typing import Callable, Tuple

 import azlmbr
 import azlmbr.legacy.general as general
+import azlmbr.multiplayer as multiplayer
 import azlmbr.debug


@@ -66,6 +67,25 @@ class TestHelper:
        TestHelper.wait_for_condition(lambda : general.is_in_game_mode(), 1.0)
        Report.critical_result(msgtuple_success_fail, general.is_in_game_mode())

+    @staticmethod
+    def multiplayer_enter_game_mode(msgtuple_success_fail : Tuple[str, str], sv_default_player_spawn_asset : str):
+        # type: (tuple) -> None
+        """
+        :param msgtuple_success_fail: The tuple with the expected/unexpected messages for entering game mode.
+        :param sv_default_player_spawn_asset: The path to the network player prefab that will be automatically spawned upon entering gamemode.  The engine default is "prefabs/player.network.spawnable" 
+
+        :return: None
+        """
+        Report.info("Entering game mode")
+
+        if sv_default_player_spawn_asset :
+            general.set_cvar("sv_defaultPlayerSpawnAsset", sv_default_player_spawn_asset)
+        
+        multiplayer.PythonEditorFuncs_enter_game_mode()
+        
+        TestHelper.wait_for_condition(lambda : multiplayer.PythonEditorFuncs_is_in_game_mode(), 30.0)
+        Report.critical_result(msgtuple_success_fail, multiplayer.PythonEditorFuncs_is_in_game_mode())
+
    @staticmethod
    def exit_game_mode(msgtuple_success_fail : Tuple[str, str]):
        # type: (tuple) -> None
@@ -0,0 +1,23 @@
+#
+# 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
+#
+#
+
+if(PAL_TRAIT_BUILD_TESTS_SUPPORTED AND PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_add_pytest(
+        NAME AutomatedTesting::MultiplayerTests_Main
+        TEST_SUITE main
+        TEST_SERIAL
+        PATH ${CMAKE_CURRENT_LIST_DIR}/TestSuite_Main.py
+        RUNTIME_DEPENDENCIES
+            Legacy::Editor
+            AZ::AssetProcessor
+            AutomatedTesting.Assets
+            AutomatedTesting.ServerLauncher
+        COMPONENT
+            Mutliplayer
+    )
+endif()
@@ -0,0 +1,35 @@
+"""
+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
+
+"""
+
+# This suite consists of all test cases that are under development and have not been verified yet.
+# Once they are verified, please move them to TestSuite_Active.py
+
+import pytest
+import os
+import sys
+
+from .utils.FileManagement import FileManagement as fm
+
+sys.path.append(os.path.dirname(os.path.abspath(__file__)) + '/../automatedtesting_shared')
+
+from base import TestAutomationBase
+
+
+@pytest.mark.parametrize("project", ["AutomatedTesting"])
+@pytest.mark.parametrize("launcher_platform", ['windows_editor'])
+class TestAutomation(TestAutomationBase):
+    def _run_prefab_test(self, request, workspace, editor, test_module, batch_mode=True, autotest_mode=True):
+        self._run_test(request, workspace, editor, test_module, 
+            extra_cmdline_args=["--regset=/Amazon/Preferences/EnablePrefabSystem=true"], 
+            batch_mode=batch_mode,
+            autotest_mode=autotest_mode)
+
+    def test_Multiplayer_AutoComponent_NetworkInput(self, request, workspace, editor, launcher_platform):
+        from .tests import Multiplayer_AutoComponent_NetworkInput as test_module
+        self._run_prefab_test(request, workspace, editor, test_module)
+
@@ -0,0 +1,6 @@
+"""
+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
+"""
@@ -0,0 +1,115 @@
+"""
+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
+"""
+
+
+# Test Case Title : Check that network input can be created, received by the authority, and processed
+
+
+# fmt: off
+class Tests():
+    enter_game_mode =           ("Entered game mode",                       "Failed to enter game mode")
+    exit_game_mode =            ("Exited game mode",                        "Couldn't exit game mode")
+    find_network_player =       ("Found network player",                    "Couldn't find network player")
+    found_lines =               ("Expected log lines were found",           "Expected log lines were not found")
+    found_unexpected_lines =    ("Unexpected log lines were not found",     "Unexpected log lines were found")
+# fmt: on
+
+
+def Multiplayer_AutoComponent_NetworkInput():
+    r"""
+    Summary:
+    Runs a test to make sure that network input can be sent from the autonomous player, received by the authority, and processed
+
+    Level Description:
+    - Dynamic
+        1. Although the level is empty, when the server and editor connect the server will spawn and replicate the player network prefab.
+           a. The player network prefab has a NetworkTestPlayerComponent.AutoComponent and a script canvas attached which will listen for the CreateInput and ProcessInput events.  
+               Print logs occur upon triggering the CreateInput and ProcessInput events along with their values; we are testing to make sure the expected events are values are recieved. 
+    - Static
+        1. This is an empty level. All the logic occurs on the Player.network.spawnable (see the above Dynamic description)
+    
+                    
+    Expected Outcome:
+    We should see editor logs saying "AutoComponent_NetworkInput ProcessInput called!" and "AutoComponent_NetworkInput CreateInput called!"
+    However, if the script receives unexpected values for the Process event we will see "AutoComponent_NetworkInput received bad fwdback" or "AutoComponent_NetworkInput received bad leftright"
+    
+    :return:
+    """
+    import azlmbr.legacy.general as general
+    from editor_python_test_tools.utils import Report
+    from editor_python_test_tools.utils import Tracer
+
+    from editor_python_test_tools.utils import TestHelper as helper
+    from ly_remote_console.remote_console_commands import RemoteConsole as RemoteConsole
+
+
+    def find_expected_line(expected_line):
+        found_lines = [printInfo.message.strip() for printInfo in section_tracer.prints]
+        return expected_line in found_lines
+
+    def find_unexpected_line(expected_line):
+        return not find_expected_line(expected_line)
+
+    unexpected_lines = [
+        'AutoComponent_NetworkInput received bad fwdback!',
+        'AutoComponent_NetworkInput received bad leftright!',
+
+    ]
+    expected_lines = [
+        'AutoComponent_NetworkInput ProcessInput called!',
+        'AutoComponent_NetworkInput CreateInput called!',
+    ]
+
+    expected_lines_server = [
+        '(Script) - AutoComponent_NetworkInput ProcessInput called!',
+    ]
+
+    level_name = "AutoComponent_NetworkInput"
+    player_prefab_name = "Player"
+    player_prefab_path = f"levels/multiplayer/{level_name}/{player_prefab_name}.network.spawnable"
+
+    helper.init_idle()
+
+
+    # 1) Open Level
+    helper.open_level("Multiplayer", level_name)
+
+    with Tracer() as section_tracer:
+        # 2) Enter game mode
+        helper.multiplayer_enter_game_mode(Tests.enter_game_mode, player_prefab_path)
+
+        # 3) Make sure the network player was spawned
+        player_id = general.find_game_entity(player_prefab_name)
+        Report.critical_result(Tests.find_network_player, player_id.IsValid())
+
+        # 4) Check the editor logs for expected and unexpected log output
+        EXPECTEDLINE_WAIT_TIME_SECONDS = 1.0
+        for expected_line in expected_lines :
+            helper.wait_for_condition(lambda: find_expected_line(expected_line), EXPECTEDLINE_WAIT_TIME_SECONDS)
+            Report.result(Tests.found_lines, find_expected_line(expected_line))
+
+        general.idle_wait_frames(1)
+        for unexpected_line in unexpected_lines :
+            Report.result(Tests.found_unexpected_lines, find_unexpected_line(unexpected_line))
+
+        # 5) Check the ServerLauncher logs for expected log output 
+        # Since the editor has  started a server launcher, the RemoteConsole with the default port=4600 will automatically be able to read the server logs
+        server_console = RemoteConsole()
+        server_console.start()
+        for line in expected_lines_server:
+            assert server_console.expect_log_line(line, EXPECTEDLINE_WAIT_TIME_SECONDS), f"Expected line not found: {line}"
+        server_console.stop()
+
+    
+    # Exit game mode
+    helper.exit_game_mode(Tests.exit_game_mode)
+
+
+
+if __name__ == "__main__":
+    from editor_python_test_tools.utils import Report
+    Report.start_test(Multiplayer_AutoComponent_NetworkInput)