Added desktop-standalone comments

Author: michalChrobot

.yamato/desktop-standalone-tests.yml

@@ -1,14 +1,34 @@
-{% metadata_file .yamato/project.metafile %}
+{% metadata_file .yamato/project.metafile %} # All configuration that is used to create different configurations (used in for loops) is taken from this file.
 ---
 
-# Builds a player on desktop standalone platform and executes RuntimeTests (equivalent to PlayMode tests) of the NGO package in the Standalone build.
-# Default project (testptoject) in this case is used as a context.
-# Builds are made on each desktop platform as in project.metafile declaration
-# Builds are made on each supported editor as in project.metafile declaration
-# Builds are made with different scripting backends as in project.metafile declaration
-# ARM64 architectures are for now not considered since Windows_arm64 is recommended to use only after builds (would require separation here) and when it comes to macOS_arm64 there is problem with OpenCL not being available
+# DESCRIPTION--------------------------------------------------------------------------
+  # This job is responsible for Desktop platform test validation.
+  # Those tests cover both PlayMode and EditMode tests from package test assemblies.
 
-# Build phase
+# CONFIGURATION STRUCTURE--------------------------------------------------------------
+  # Jobs are generated using nested loops (separate build phase and run phase). Worth noting that run phase uses the build as dependency:
+    # 1. For all desktop platform (Windows, macOS, Ubuntu)
+    # 2. For all supported Unity Editor versions (for NGOv1.X this means 2021.3+ editors)
+    # 3. For the default project.
+    # 4. For all scripting backends (mono, il2cpp)
+  
+# TECHNICAL CONSIDERATIONS---------------------------------------------------------------
+  # For desktop devices a split is into two phases is not required but we use it for consistency with setup of others standalone platforms:
+    # 1. Build Phase: Creates standalone players for desktop platforms
+    # 2. Run Phase: Executes runtime tests on actual desktop devices
+  # The Run phase uses build job as dependency
+  
+  # Note: More of a Unity specific but test assemblies need to be included in the build phase command
+  # Note: All builds can be made on x64 machines since those are compatible with ARM64 target devices
+  
+# QUALITY THOUGHTS--------------------------------------------------------------------
+  # TODO: consider adding all projects that have tests
+  # To see where this job is included (in trigger job definitions) look into _triggers.yml file
+  
+#-----------------------------------------------------------------------------------
+  
+  
+# BUILD PHASE CONFIGURATION------------------------------------------------------------------------------------
 {% for project in projects.default -%}
 {% for platform in test_platforms.desktop -%}
 {% for editor in validation_editors.all -%}
@@ -19,23 +39,16 @@ desktop_standalone_build_{{ project.name }}_{{ platform.name }}_{{ backend }}_{{
     type: {% if platform.name == "mac" %} {{ platform.type }} {% else %} {{ platform.type }}::GPU {% endif %}
     image: {{ platform.image }}
     flavor: {{ platform.flavor }}
-  commands:  
-    - pip install unity-downloader-cli --index-url https://artifactory.prd.it.unity3d.com/artifactory/api/pypi/pypi/simple
-  
-# Installing editor
-    - unity-downloader-cli -u {{ editor }} -c Editor {% if backend == "il2cpp" %} -c il2cpp {% endif %} --fast --wait
-  
-# Build Player
+  commands:
+    - unity-downloader-cli -u {{ editor }} -c Editor {% if backend == "il2cpp" %} -c il2cpp {% endif %}
     - UnifiedTestRunner --suite=playmode --platform={{ platform.standalone }} --editor-location=.Editor --testproject={{ project.path }} --scripting-backend={{ backend }} --testfilter="Unity.Netcode.RuntimeTests.*" --player-save-path=build/players --artifacts-path=artifacts --extra-editor-arg=-batchmode --extra-editor-arg=-nographics --reruncount=1 --clean-library-on-rerun --build-only --timeout=1800
-
   artifacts:
     players:
       paths:
         - "build/players/**/*"
     logs:
       paths:
         - "artifacts/**/*"
-        
   dependencies:
     - .yamato/project-pack.yml#project_pack_-_{{ project.name }}_{{ platform.name }}
 {% endfor -%}
@@ -46,7 +59,7 @@ desktop_standalone_build_{{ project.name }}_{{ platform.name }}_{{ backend }}_{{
 
 
 
-# Run phase
+# RUN PHASE CONFIGURATION------------------------------------------------------------------------------------
 {% for project in projects.default -%}
 {% for platform in test_platforms.desktop -%}
 {% for editor in validation_editors.all -%}
@@ -57,15 +70,30 @@ desktop_standalone_test_{{ project.name }}_{{ platform.name }}_{{ backend }}_{{
     type: {% if platform.name == "mac" %} {{ platform.type }} {% else %} {{ platform.type }}::GPU {% endif %}
     image: {{ platform.image }}
     flavor: {{ platform.flavor }}
-  commands:
-{% if editor == "2021.3" and platform.name == "ubuntu" %}
-    - sudo apt-get install -y libssl1.1 # For this specific configuration there is a difference in what libssl version is installed on the image and what editor uses. This should be removed when 2021 editor is out of support
+  
+# Set additional variables for running the echo server
+{% if platform.name != "win" %}
+  variables:
+    ECHO_SERVER_PORT: "7788"
+    # Set this to ensure the DA codec tests will fail if they cannot connect to the echo-server
+    # The default is to ignore the codec tests if the echo-server fails to connect
+    ENSURE_CODEC_TESTS: "true"
 {% endif %}
-    - pip install unity-downloader-cli --index-url https://artifactory.prd.it.unity3d.com/artifactory/api/pypi/pypi/simple # Installing unity downloader
-    - unity-downloader-cli -u {{ editor }} -c Editor {% if backend == "il2cpp" %} -c il2cpp {% endif %} --fast --wait # Installing appropriate Unity version for the test case. Important to note is the fact that even though we have a build we still need the editor to run tests
 
-# Running Standalone desktop tests
+  commands:
+    - unity-downloader-cli -u {{ editor }} -c Editor {% if backend == "il2cpp" %} -c il2cpp {% endif %}
     - UnifiedTestRunner --suite=playmode --player-load-path=build/players --artifacts-path=test-results --testproject={{ project.path }} --editor-location=.Editor --playergraphicsapi=Null --fail-on-assert --reruncount=1 --clean-library-on-rerun --timeout=1800
+  
+    # If ubuntu, run rust echo server
+{% if platform.name != "win" %}
+    - git clone https://github.com/Unity-Technologies/mps-common-multiplayer-backend.git
+    # Install rust
+    - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+    # Build the echo server
+    - cd ./mps-common-multiplayer-backend/runtime && $HOME/.cargo/bin/cargo build --example ngo_echo_server
+    # Run the echo server in the background - this will reuse the artifacts from the build
+    - cd ./mps-common-multiplayer-backend/runtime && $HOME/.cargo/bin/cargo run --example ngo_echo_server -- --port $ECHO_SERVER_PORT &
+{% endif %}
 
   artifacts:
     logs: