ci: run XR tests for all test projects (except ECS) (#481)

* add and use UTSGraphicsTestConstants

* add XR tests for the Editor (not standalone)

* manually determine the path of XR images to be used for XR tests, 
   because the path passed to UseGraphicsTestCases attribute is defined in compile time, when XR is still disabled.

* setup GraphicsTest assembly

* rename XRUtility.EnableXR() to XRUtility.EnableXRInEditor() 

* add null check when enabling/disable XR

* add ReferenceImagePathLog when executing ImageAssert.AreEqual 

* Exclude ECS from XR tests

Author: sindharta

com.unity.toon-graphics-test/Runtime/SetupUTSGraphicsTestCases.cs

@@ -0,0 +1,14 @@
+namespace Unity.ToonShader.GraphicsTest
+{
+public class UTSGraphicsTestConstants {
+#if UTS_TEST_USE_HDRP
+    internal const string ReferenceImagePath = "Packages/com.unity.toon-reference-images/HDRP";
+#elif UTS_TEST_USE_URP
+    internal const string ReferenceImagePath = "Packages/com.unity.toon-reference-images/URP";
+#else
+    internal const string ReferenceImagePath = "Packages/com.unity.toon-reference-images/Built-In";
+#endif
+
+}
+
+} //end namespace

com.unity.toon-graphics-test/Runtime/UTSGraphicsTestConstants.cs

@@ -6,30 +6,75 @@
 using UnityEngine.TestTools.Graphics;
 using UnityEngine.SceneManagement;
 using System.IO;
+using Unity.ToonShader.GraphicsTest;
+using UnityEditor;
 
 
 namespace Tests
 {
+#if UNITY_EDITOR
+public class UTSGraphicsTestsXR {
 
+    [UnityTest]
+    [UseGraphicsTestCases(UTSGraphicsTestConstants.ReferenceImagePath)]
+    [Timeout(3600000)] //1 hour
+    public IEnumerator Run(GraphicsTestCase testCase) {
+        //[TODO-sin: 2025-7-18] ECS projects were never tested with XR, and currently they don't support XR.
+        string projectName = Path.GetFileName(Path.GetDirectoryName(UnityEngine.Application.dataPath));
+        if (!string.IsNullOrEmpty(projectName) && projectName.Contains("ECS")) {
+            Assert.Ignore();
+        }
+        
+        //Enable XR
+        XRUtility.EnableXRInEditor();
+        
+        //Rendering both eyes in XR requires backbuffer, which depends on the game view resolution
+        object gameViewSizeObj = UnityEditor.TestTools.Graphics.GameViewSize.SetCustomSize(1920, 1080);
+        Assert.IsNotNull(gameViewSizeObj, "Failed to add custom game view size for XR tests.");
+        UnityEditor.TestTools.Graphics.GameViewSize.SelectSize(gameViewSizeObj);
+        
+        string loadedXRDevice = UseGraphicsTestCasesAttribute.LoadedXRDevice;
+        
+        //Manually load the reference image for XR. Ex: URP/Linear/WindowsEditor/Vulkan/None/AngelRing.png
+        Assert.IsNotNull(testCase.ReferenceImage);
+        string imagePath = AssetDatabase.GetAssetPath(testCase.ReferenceImage);
+        string imageFileName = Path.GetFileName(imagePath);
+        string imageFolderName = Path.GetDirectoryName(Path.GetDirectoryName(imagePath));
+        Assert.IsNotNull(imageFolderName);
+        string xrImagePath = Path.Combine(imageFolderName, loadedXRDevice,imageFileName);
+        testCase.ReferenceImagePathLog = xrImagePath;
+        Assert.IsTrue(File.Exists(xrImagePath),$"XR Reference image not found at: {xrImagePath}");
+        testCase.ReferenceImage = AssetDatabase.LoadAssetAtPath<Texture2D>(xrImagePath);
+        
+        //Unity.ToonShader.GraphicsTest.SetupUTSGraphicsXRTestCases.Setup();
+        yield return UTS_GraphicsTests.RunInternal(testCase, isXR:true);
+        
+        XRUtility.DisableXR();
+    }
+   
+}
 
-    public class UTS_GraphicsTests
-    {
-#if UTS_TEST_USE_HDRP        
-        private const string ReferenceImagePath = "Packages/com.unity.toon-reference-images/HDRP";
-#elif UTS_TEST_USE_URP
-        private const string ReferenceImagePath = "Packages/com.unity.toon-reference-images/URP";
-#else        
-        private const string ReferenceImagePath = "Packages/com.unity.toon-reference-images/Built-In";
-#endif
-
+#endif //UNITY_EDITOR
+
+public class UTSGraphicsTestsNonXR  {
+    [UnityTest]
+    [UseGraphicsTestCases(UTSGraphicsTestConstants.ReferenceImagePath)]
+    [Timeout(3600000)] //1 hour
+    public IEnumerator Run(GraphicsTestCase testCase) {
+        //[TODO-sin: 2025-7-2] Hack for now to disable XR for non-Stereo projects
+        string projectName = Path.GetFileName(Path.GetDirectoryName(UnityEngine.Application.dataPath));
+        if (!string.IsNullOrEmpty(projectName) && !projectName.Contains("Stereo")) {
+            XRUtility.DisableXR();
+        }
 
-        [UnityTest]
-        [PrebuildSetup(typeof(Unity.ToonShader.GraphicsTest.SetupUTSGraphicsTestCases))]
-        [UseGraphicsTestCases(ReferenceImagePath)]
-        [Timeout(3600000)] //1 hour
-        public IEnumerator Run(GraphicsTestCase testCase)
-        {
+        yield return UTS_GraphicsTests.RunInternal(testCase);
+    }
+} 
 
+//----------------------------------------------------------------------------------------------------------------------
+
+    public class UTS_GraphicsTests {
+        internal static IEnumerator RunInternal(GraphicsTestCase testCase, bool isXR = false) {
             SceneManager.LoadScene(testCase.ScenePath);
 
             // Always wait one frame for scene load
@@ -39,6 +84,13 @@ public IEnumerator Run(GraphicsTestCase testCase)
             UTS_GraphicsTestSettings settings = Object.FindFirstObjectByType<UTS_GraphicsTestSettings>();
             Assert.IsNotNull(settings, "Invalid test scene, couldn't find UTS_GraphicsTestSettings");
 
+            if (isXR) {
+                settings.ImageComparisonSettings.UseBackBuffer = true; //results using both eyes need backbuffer 
+
+                //[TODO-sin: 2025-7-9] Hack for now. The resolution will be set to this later
+                settings.ImageComparisonSettings.ImageResolution = ImageComparisonSettings.Resolution.w1920h1080;
+            }
+
 
             int waitFrames = settings.WaitFrames;
 
@@ -51,7 +103,8 @@ public IEnumerator Run(GraphicsTestCase testCase)
             for (int i = 0; i < waitFrames; i++)
                 yield return new WaitForEndOfFrame();
 
-            ImageAssert.AreEqual(testCase.ReferenceImage, cameras.Where(x => x != null), settings.ImageComparisonSettings);
+            ImageAssert.AreEqual(testCase.ReferenceImage, cameras.Where(x => x != null), 
+                settings.ImageComparisonSettings, testCase.ReferenceImagePathLog);
 
             // Does it allocate memory when it renders what's on the main camera?
             bool allocatesMemory = false;

com.unity.toon-graphics-test/Runtime/SetupUTSGraphicsTestCases.cs.meta renamed to com.unity.toon-graphics-test/Runtime/UTSGraphicsTestConstants.cs.meta

@@ -4,7 +4,8 @@
     "references": [
         "GUID:c081bc530f560634bb5c21d4b323a7f1",
         "GUID:27619889b8ba8c24980f49ee34dbb44a",
-        "GUID:e40ba710768534012815d3193fa296cb"
+        "GUID:e40ba710768534012815d3193fa296cb",
+        "GUID:e18141520846dcc44b725b2f74e91229"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],

com.unity.toon-graphics-test/Runtime/UTS_GraphicsTests.cs

@@ -1,14 +1,24 @@
-using System.Collections;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.XR;
 using UnityEngine.XR.Management;
 
+#if UNITY_EDITOR
+using UnityEditor;
+#endif
+
 namespace Unity.ToonShader.GraphicsTest {
 
 public static class XRUtility {
 
-public static void EnableXR() {
+#if UNITY_EDITOR
+public static void EnableXRInEditor() {
+
+    if (null == XRGeneralSettings.Instance) {
+        XRGeneralSettings.Instance = AssetDatabase.LoadAssetAtPath<XRGeneralSettings>(
+            "Assets/XR/XRGeneralSettingsPerBuildTarget.asset");
+    }
+    
     //Disable everything first
     if (XRGeneralSettings.Instance.Manager.activeLoader ||
         XRGeneralSettings.Instance.Manager.isInitializationComplete)
@@ -36,13 +46,15 @@ public static void EnableXR() {
 
 }
 
+#endif //UNITY_EDITOR
 
 public static void DisableXR() {
 
-    if (XRGeneralSettings.Instance.Manager.isInitializationComplete)
+    XRManagerSettings xrManager = XRGeneralSettings.Instance?.Manager;
+    if (null!= xrManager && xrManager.isInitializationComplete)
     {
-        XRGeneralSettings.Instance.Manager.StopSubsystems();
-        XRGeneralSettings.Instance.Manager.DeinitializeLoader();
+        xrManager.StopSubsystems();
+        xrManager.DeinitializeLoader();
     }
 
 
@@ -52,10 +64,8 @@ public static void DisableXR() {
     for (int i = 0; i < count; i++) {
         xrDisplaySubsystems[i].Stop();
     }
-    
 }
 
-    
 }
 
 } //end namespace