Removing deleted test from CMakeLists and updated in line comments for sample test

Signed-off-by: evanchia <evanchia@amazon.com>

Tools/LyTestTools/tests/CMakeLists.txt

@@ -52,18 +52,4 @@ if(PAL_TRAIT_BUILD_HOST_TOOLS AND PAL_TRAIT_BUILD_TESTS_SUPPORTED AND AutomatedT
             AutomatedTesting.Assets
             COMPONENT TestTools
     )
-
-    # Example tests.
-    ly_add_pytest(
-        NAME LyTestTools_ExampleTests_periodic_no_gpu
-        PATH ${CMAKE_CURRENT_LIST_DIR}/example/test_system_example.py
-        TEST_SERIAL
-        TEST_SUITE periodic
-        RUNTIME_DEPENDENCIES
-            Legacy::Editor
-            AssetProcessor
-            AutomatedTesting.GameLauncher
-            AutomatedTesting.Assets
-            COMPONENT TestTools
-    )
 endif()

Tools/LyTestTools/tests/integ/sanity_tests.py

@@ -6,24 +6,43 @@ SPDX-License-Identifier: Apache-2.0 OR MIT
 A sanity test for the built-in fixtures.
 Launch the windows launcher attached to the currently installed instance.
 """
+# Import any dependencies for the test.
 import logging
 import pytest
 
+# Import any desired LTT modules from the package `ly_test_tools`. All LTT modules can be viewed at `Tools/LyTestTools/ly_test_tools`.
 import ly_test_tools
+# The `launchers.launcher_helper` module helps create Launcher objects which control the Open 3D Engine (O3DE) Editor and game clients.
 import ly_test_tools.launchers.launcher_helper as launcher_helper
+# The `builtin.helpers` module helps create the Workspace object, which controls the testing workspace in LTT.
 import ly_test_tools.builtin.helpers as helpers
+# The `environment` module contains tools that involve the system's environment such as processes or timed waiters.
 import ly_test_tools.environment.process_utils as process_utils
 import ly_test_tools.environment.waiter as waiter
 
+# Initialize a logger instance to hook all test logs together. The sub-logger pattern below makes it easy to track which file creates a log line.
 logger = logging.getLogger(__name__)
 
 # Note: For device testing, device ids must exist in ~/ly_test_tools/devices.ini, see README.txt for more info.
 
 
+# First define the class `TestAutomatedTestingProject` to group test functions together.
+# The example test contains two test functions: `test_StartGameLauncher_Sanity` and `test_StartEditor_Sanity`.
 @pytest.mark.parametrize("project", ["AutomatedTesting"])
+# The example test utilizes Pytest parameterization. The following sets the `project` parameter to `AutomatedTesting`
+# for both test functions. Notice that the Pytest mark is defined at the class level to affect both test functions.
 class TestAutomatedTestingProject(object):
 
     def test_StartGameLauncher_Sanity(self, project):
+        """
+        The `test_StartGameLauncher_Sanity` test function verifies that the O3DE game client launches successfully.
+        Start the test by utilizing the `kill_processes_named` function to close any open O3DE processes that may
+        interfere with the test. The Workspace object emulates the O3DE package by locating the engine and project
+        directories. The Launcher object controls the O3DE game client and requires a Workspace object for
+        initialization. Add the `-rhi=Null` arg to the executable call to disable GPU rendering. This allows the
+        test to run on instances without a GPU. We launch the game client executable and wait for the process to exist.
+        A try/finally block ensures proper test cleanup if issues occur during the test.
+        """
         # Kill processes that may interfere with the test
         process_utils.kill_processes_named(names=process_utils.LY_PROCESS_KILL_LIST, ignore_extensions=True)
 
@@ -45,6 +64,13 @@ class TestAutomatedTestingProject(object):
 
     @pytest.mark.skipif(not ly_test_tools.WINDOWS, reason="Editor currently only functions on Windows")
     def test_StartEditor_Sanity(self, project):
+        """
+        The `test_StartEditor_Sanity` test function is similar to the previous example with minor adjustments. A
+        PyTest mark skips the test if the operating system is not Windows. We use the `create_editor` function instead
+        of `create_launcher` to create an Editor type launcher instead of a game client type launcher. The additional
+        `-autotest_mode` arg supresses modal dialogs from interfering with our test. We launch the Editor executable and
+        wait for the process to exist.
+        """
         # Kill processes that may interfere with the test
         process_utils.kill_processes_named(names=process_utils.LY_PROCESS_KILL_LIST, ignore_extensions=True)