Added mobile-standalone comments

Author: michalChrobot

.yamato/mobile-standalone-test.yml

@@ -1,33 +1,52 @@
-{% 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 mobile 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/Tests are made on each mobile platform (Android and iOS) as in project.metafile declaration
-# Builds/Tests are made on each supported editor as in project.metafile declaration
-    
-# For mobile devices it's necessary to split build and run phases
-# For iOS we need to use il2cpp. For android we could use both but il2cpp is recommended so for now we will only use il2cpp as scripting backend
-# iOS works only with ARM64 and Android is tested with both ARM64 and ARMv7
 
-# Builds are made with x64 architecture machines since those are compatible to run on ARM64 devices
+# DESCRIPTION--------------------------------------------------------------------------
+  # This job is responsible for Mobile platform test validation.
+  # Those tests cover both PlayMode and EditMode tests from package test assemblies.
+  
+# CONFIGURATION STRUCTURE--------------------------------------------------------------
+  # Jobs are generated using nested loops through:
+    # 1. For all mobile platform (Android, iOS)
+    # 2. For all supported Unity Editor versions (for NGOv1.X this means 2021.3+ editors)
+    # 3. For the default project.
+  
+# TECHNICAL CONSIDERATIONS---------------------------------------------------------------
+  # For mobile devices a split is required into two phases:
+    # 1. Build Phase: Creates standalone players for mobile platforms
+    # 2. Run Phase: Executes runtime tests on actual mobile 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
+  
+# PLATFORM SPECIFICS--------------------------------------------------------------------
+  # iOS Requirements:
+    # Must use IL2CPP scripting backend
+    # Only supports ARM64 architecture
+    # Builds on macOS agents only
+  
+  # Android Requirements:
+    # Uses IL2CPP scripting backend (recommended over Mono)
+    # Supports both ARM64 and ARMv7 architectures
+    # Can be built on any desktop platform
+  
+# QUALITY CONSIDERATIONS--------------------------------------------------------------------
+  # 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.mobile_build -%}
 {% for editor in validation_editors.all -%}
 mobile_standalone_build_{{ project.name }}_{{ platform.name }}_{{ editor }}:
-  name: Build {{ project.name }} - [{{ platform.name }}, {{ editor }},  il2cpp]
+  name: Build {{ project.name }} - [{{ platform.name }}, {{ editor }}, il2cpp]
   agent:
-      type: {{ platform.type }}
-      image: {{ platform.image }}
-      flavor: {{ platform.flavor }}
+    type: {{ platform.type }}
+    image: {{ platform.image }}
+    flavor: {{ platform.flavor }}
   commands:
-    # Installing tools
-    - 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 -c il2cpp {% if platform.base == "mac" %} -c ios {% else %} -c android {% endif %} --fast --wait
-    
-    # Platform specific Build
+    - unity-downloader-cli -u {{ editor }} -c Editor -c il2cpp {% if platform.base == "mac" %} -c ios {% else %} -c android {% endif %}
     - UnifiedTestRunner --suite=playmode --platform={{ platform.standalone }} --testproject={{ project.path }} --architecture={{ platform.architecture }} --scripting-backend=il2cpp --editor-location=.Editor --artifacts-path=artifacts --testfilter="Unity.Netcode.RuntimeTests.*" --player-save-path=build/players --extra-editor-arg=-batchmode --extra-editor-arg=-nographics --reruncount=1 --clean-library-on-rerun --build-only --timeout=1800
   artifacts:
     players:
@@ -36,16 +55,12 @@ mobile_standalone_build_{{ project.name }}_{{ platform.name }}_{{ editor }}:
     logs:
       paths:
         - "artifacts/**/*"
-  
-  variables:
-    CI: true
-    ENABLE_BURST_COMPILATION: False
 {% endfor -%}
 {% endfor -%}
 {% endfor -%}
 
 
-# Executes RuntimeTests of the NGO package in the Standalone build for mobiles
+# RUN PHASE CONFIGURATION------------------------------------------------------------------------------------
 {% for project in projects.default -%}
 {% for platform in test_platforms.mobile_test -%}
 {% for editor in validation_editors.all -%}
@@ -58,32 +73,26 @@ mobile_standalone_test_{{ project.name }}_{{ platform.name }}_{{ editor }}:
 {% if platform.model %}
     model: {{ platform.model }}
 {% endif %}
-  # Skip repository cloning
-  skip_checkout: true
   commands:
-    # Installing tools
-    - pip install unity-downloader-cli --index-url https://artifactory.prd.it.unity3d.com/artifactory/api/pypi/pypi/simple
-
-    # Installing editor. We still need the editor to run tests on standalone build
-    - unity-downloader-cli -u {{ editor }} -c Editor -c il2cpp {% if platform.base == "mac" %} -c ios {% else %} -c android {% endif %} --fast --wait
-      
+    # Installing editor. We still need the editor to run tests on standalone build and for that the Editor is required
+    - unity-downloader-cli -u {{ editor }} -c Editor -c il2cpp {% if platform.base == "mac" %} -c ios {% else %} -c android {% endif %}
+  
 {% if platform.standalone == "Android" %}
     # Download standalone UnityTestRunner and ADB setup
-    - command: curl -s https://artifactory.prd.it.unity3d.com/artifactory/unity-tools-local/utr-standalone/utr.bat --output utr.bat
     - command: wget http://artifactory-slo.bf.unity3d.com/artifactory/mobile-generic/android/ADBKeys.zip!/adbkey.pub -O %USERPROFILE%/.android/adbkey.pub
     - command: wget http://artifactory-slo.bf.unity3d.com/artifactory/mobile-generic/android/ADBKeys.zip!/adbkey -O %USERPROFILE%/.android/adbkey
     - command: gsudo NetSh Advfirewall set allprofiles state off
-
+  
     # Connect to Android device
     - command: '"%ANDROID_SDK_ROOT%\platform-tools\adb.exe" connect %BOKKEN_DEVICE_IP%'
-
-    # Run tests
+  
+    # Run tests for Android devices
     - |
       set ANDROID_DEVICE_CONNECTION=%BOKKEN_DEVICE_IP%
       UnifiedTestRunner --suite=playmode --platform={{ platform.standalone }} --artifacts-path=test-results --player-load-path=build/players --testproject={{ project.path }} --editor-location=.Editor --player-connection-ip=%BOKKEN_HOST_IP% --fail-on-assert --reruncount=1 --clean-library-on-rerun --timeout=3600
 {% else %}
-
-    # Run tests
+  
+    # Run tests for non-Android devices
     - UnifiedTestRunner --suite=playmode --platform={{ platform.standalone }} --artifacts-path=test-results --player-load-path=build/players --testproject={{ project.path }} --editor-location=.Editor --fail-on-assert --reruncount=1 --clean-library-on-rerun --timeout=3600
 {% endif %}
   artifacts: