Added code-coverage comments and modifications (same as in develop-2.0.0 branch)

Author: michalChrobot

.yamato/_run-all.yml

@@ -2,11 +2,11 @@
 ---
 
 # DESCRIPTION--------------------------------------------------------------------------
-# Those jobs group together related test as dependencies to allow to easily manage running a given set of tests.
-# This enables efficient test execution for different validation scenarios
+  # Those jobs group together related test as dependencies to allow to easily manage running a given set of tests.
+  # This enables efficient test execution for different validation scenarios
 
 # QUALITY CONSIDERATIONS---------------------------------------------------------------
-# It's important to ensure that all dependencies exist (this can be verified in Yamato) since a modification in parameters may result in a given job not being generated, and thus we will not be able to run such erroneous job.
+  # It's important to ensure that all dependencies exist (this can be verified in Yamato) since a modification in parameters may result in a given job not being generated, and thus we will not be able to run such erroneous job.
 
 #-----------------------------------------------------------------------------------
 

.yamato/_triggers.yml

@@ -2,39 +2,38 @@
 ---
 
 # DESCRIPTION--------------------------------------------------------------------------
-# This configuration defines three main CI trigger patterns:
-# 1. Pull Request Validation: Validation performed on PR basis
-# 2. Nightly Development: Test set run nightly (validates most important test cases)
-# 3. Weekly Full Validation: Test set run weekly (validates all test cases to prevent any surprises)
-# Each pattern represents different balance between validation depth, execution time and CI resource usage
+  # This configuration defines three main CI trigger patterns:
+    # 1. Pull Request Validation: Validation performed on PR basis
+    # 2. Nightly Development: Test set run nightly (validates most important test cases)
+    # 3. Weekly Full Validation: Test set run weekly (validates all test cases to prevent any surprises)
+  # Each pattern represents different balance between validation depth, execution time and CI resource usage
 
 # TRIGGER PATTERNS-------------------------------------------------------------------
-# Pull Request:
-# This test validates Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
-# Triggers on PRs to develop, develop, and release branches
-# Focuses on critical validation paths that we should validate before merging PRs
-# Cancels previous runs on new commits
-# Excludes draft PRs
+  # Pull Request:
+    # This test validates Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
+    # Triggers on PRs to develop, develop, and release branches
+    # Focuses on critical validation paths that we should validate before merging PRs
+    # Cancels previous runs on new commits
+    # Excludes draft PRs
 
-# Nightly:
-# This test validates same subset as pull_request_trigger with addition of mobile/console tests and webgl builds
-# Runs daily on develop (local configuration)
-# Includes all test types but only on trunk.
-# Adds platform-specific and APV validation
+  # Nightly:
+    # This test validates same subset as pull_request_trigger with addition of mobile/console tests and webgl builds
+    # Runs daily on develop (local configuration)
+    # Includes all test types but only on trunk.
+    # Adds platform-specific and APV validation
 
-# Weekly:
-# This test validates same subset as develop_nightly but runs per all supported editors as well as executes code coverage test and runs project standards per project
-# Runs across all supported editor versions
-# Includes code coverage analysis
-# Validates all projects and standards
+  # Weekly:
+    # This test validates same subset as develop_nightly but runs per all supported editors as well as executes code coverage test and runs project standards per project
+    # Runs across all supported editor versions
+    # Includes code coverage analysis
+    # Validates all projects and standards
 
 # CONFIGURATION STRUCTURE--------------------------------------------------------------
-# Jobs configurations are generated by ensuring that all dependencies are successful.
-# The dependencies are taken from _run-all.yml file where we can gather multiple tests into proper sets
+    # Jobs configurations are generated by ensuring that all dependencies are successful.
+    # The dependencies are taken from _run-all.yml file where we can gather multiple tests into proper sets
 
 # QUALITY CONSIDERATIONS---------------------------------------------------------------
-# It's important to ensure that all dependencies exist (this can be verified in Yamato) since a modification in parameters may result in a given job not being generated, and thus we will not be able to run such erroneous job.
-
+    # It's important to ensure that all dependencies exist (this can be verified in Yamato) since a modification in parameters may result in a given job not being generated, and thus we will not be able to run such erroneous job.
 
 
 #-----------------------------------------------------------------------------------

.yamato/code-coverage.yml

@@ -1,10 +1,30 @@
-{% 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.
 ---
 
-# Runs package tests in order to determine code coverage of the NGO package.
-# In essence it's performing the same task as .yamato/package-test jobs with the overhead being the measured code coverage
-# It's ok for code coverage to be performed only on one platform (default) since code coverage won't change much between those.
-# Default platform was chosen (ubuntu) since it's the fastest and most resource friendly with default editor.
+# DESCRIPTION--------------------------------------------------------------------------
+  # This job is responsible for executing package tests with code coverage analysis enabled.
+  # Coverage analysis provides insights into:
+  # Test coverage metrics for NGO assemblies
+  # Line and branch coverage statistics
+  # Generated HTML reports for coverage visualization
+  # Additional metrics for coverage analysis
+  
+# CONFIGURATION STRUCTURE--------------------------------------------------------------
+  # Jobs are generated using nested loops through:
+  # 1. For default platform only (Ubuntu) since coverage would not vary between platforms (no need for checks on more platforms)
+  # 2. For default editor version (trunk) since coverage would not vary between editors (no need for checks on more editors)
+  
+#TECHNICAL CONSIDERATIONS---------------------------------------------------------------
+  # In theory this job also runs package tests, but we don't want to use it as default since is heavier (because of added coverage analysis) and coverage is not changing that often
+  # Requires Unity Editor installation
+  # Burst compilation is disabled to ensure accurate coverage measurement
+  # In order to properly use -coverage-results-path parameter we need to start it with $PWD (which means the absolute path). Otherwise, coverage results will not be visible
+  
+# QUALITY CONSIDERATIONS--------------------------------------------------------------------
+  # TODO: somewhere in 2025 we will be able to upload resuls to CodeCov from public repos
+  # To see where this job is included (in trigger job definitions) look into _triggers.yml file
+  
+  
 {% for platform in test_platforms.default -%}
 {% for editor in validation_editors.default -%}
 code_coverage_{{ platform.name }}_{{ editor }}:
@@ -14,16 +34,13 @@ code_coverage_{{ platform.name }}_{{ editor }}:
     image: {{ platform.image }}
     flavor: {{ platform.flavor }}
   commands:
-    - npm install -g upm-ci-utils@stable --registry https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-npm
-    - unity-downloader-cli -u {{ editor }} -c Editor --fast --wait
+    - unity-downloader-cli -u {{ editor }} -c Editor
     - upm-pvp create-test-project test-project --packages "upm-ci~/packages/*.tgz" --unity .Editor
-    - UnifiedTestRunner --suite=editor --suite=playmode --editor-location=.Editor --testproject=test-project --enable-code-coverage --code-coverage-options="generateAdditionalMetrics;generateHtmlReport;assemblyFilters:+Unity.Netcode.Editor,+Unity.Netcode.Runtime" --extra-editor-arg=--burst-disable-compilation --extra-editor-arg=testCategory --extra-editor-arg=!Performance --timeout=1800 --reruncount=1 --clean-library-on-rerun --artifacts-path=test-results
+    - UnifiedTestRunner --suite=editor --suite=playmode --editor-location=.Editor --testproject=test-project --enable-code-coverage -coverage-results-path=$PWD/test-results/CodeCoverage --coverage-options="generateHtmlReport;generateAdditionalMetrics;assemblyFilters:+Unity.Netcode.Editor,+Unity.Netcode.Runtime" --extra-editor-arg=--burst-disable-compilation --timeout=1800 --reruncount=1 --clean-library-on-rerun --artifacts-path=test-results
   artifacts:
     logs:
       paths:
         - "test-results/**/*"
-        - "test-results/CodeCoverage/**/*"
-        - "test-results/CoverageResults/**/*"
   dependencies:
     - .yamato/package-pack.yml#package_pack_-_ngo_{{ platform.name }}
 {% endfor -%}