Tests: fix interactive mode and added more settings to force image save (which would also capture RenderDoc)

xen2 · xen2 · commit 0ebed49b9836 · 2026-01-22T14:03:58.000+09:00
diff --git a/sources/engine/Stride.Audio.Tests/Stride.Audio.Tests.Windows.csproj b/sources/engine/Stride.Audio.Tests/Stride.Audio.Tests.Windows.csproj
@@ -9,6 +9,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Test this project only on D3D11 since it is graphics API independent -->
     <StrideCompilerTargetsEnable Condition="'$(StrideGraphicsApi)' != 'Direct3D11'">false</StrideCompilerTargetsEnable>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
diff --git a/sources/engine/Stride.BepuPhysics/Stride.BepuPhysics.Tests/Stride.BepuPhysics.Tests.csproj b/sources/engine/Stride.BepuPhysics/Stride.BepuPhysics.Tests/Stride.BepuPhysics.Tests.csproj
@@ -8,6 +8,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
     <Nullable>enable</Nullable>
diff --git a/sources/engine/Stride.Engine.NoAssets.Tests/Stride.Engine.NoAssets.Tests.Windows.csproj b/sources/engine/Stride.Engine.NoAssets.Tests/Stride.Engine.NoAssets.Tests.Windows.csproj
@@ -8,6 +8,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>false</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
   </PropertyGroup>
   <PropertyGroup>
     <StartupObject>xunit.runner.stride.Program</StartupObject>
diff --git a/sources/engine/Stride.Engine.Tests/Stride.Engine.Tests.Windows.csproj b/sources/engine/Stride.Engine.Tests/Stride.Engine.Tests.Windows.csproj
@@ -9,6 +9,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.Graphics.Regression/GameTestBase.cs b/sources/engine/Stride.Graphics.Regression/GameTestBase.cs
@@ -54,6 +54,11 @@ public abstract class GameTestBase : Game
         /// </summary>
         public static bool ForceInteractiveMode { get; set; }
 
+        /// <summary>
+        /// Force image to be saved even if image comparison was a success and no error during the test.
+        /// </summary>
+        public static bool ForceSaveImageOnSuccess { get; set; }
+
 
         /// <summary>
         ///   Gets the instance of the <see cref="FrameGameSystem"/> where the tests
@@ -98,6 +103,11 @@ public abstract class GameTestBase : Game
         private BackBufferSizeMode backBufferSizeMode;
 
 #if STRIDE_PLATFORM_DESKTOP
+        /// <summary>
+        /// Forces render doc capture even if test didn't fail. This can be used only when <see cref="CaptureRenderDocOnError"/> is set.
+        /// </summary>
+        public static bool ForceCaptureRenderDocOnSuccess = false;
+
         /// <summary>
         ///   Gets or sets a value indicating whether RenderDoc should capture a frame when an error occurs
         ///   or a test fails.
@@ -594,7 +604,8 @@ protected static void RunGameTest(GameTestBase game)
                 // If no comparison errors, and no test errors, discard the capture
                 if (game.comparisonFailedMessages.Count == 0 &&
                     game.comparisonMissingMessages.Count == 0 &&
-                    exceptionOrFailedAssert is null)
+                    exceptionOrFailedAssert is null &&
+                    !ForceCaptureRenderDocOnSuccess)
                 {
                     game.DiscardFrameCapture();
                 }
@@ -697,6 +708,8 @@ public void SendImage(Image image, string? testName)
                 }
             }
 
+            comparisonFailedMessages.Add($"* {testLocalFileName} (current)");
+
             if (testFileNames.Count == 0)
             {
                 // No source image, save this one so that user can later copy it to validated folder
@@ -711,6 +724,10 @@ public void SendImage(Image image, string? testName)
                 foreach (var file in testFileNames)
                     comparisonFailedMessages.Add($"  {file} ({ (matchingImage ? "reference" : "different platform/device") })");
             }
+            else if (ForceSaveImageOnSuccess)
+            {
+                ImageTester.SaveImage(image, testLocalFileName);
+            }
             else
             {
                 // If test is a success, let's delete the local file if it was previously generated
diff --git a/sources/engine/Stride.Graphics.Tests.10_0/Stride.Graphics.Tests.10_0.Windows.csproj b/sources/engine/Stride.Graphics.Tests.10_0/Stride.Graphics.Tests.10_0.Windows.csproj
@@ -8,6 +8,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.Graphics.Tests.11_0/Stride.Graphics.Tests.11_0.Windows.csproj b/sources/engine/Stride.Graphics.Tests.11_0/Stride.Graphics.Tests.11_0.Windows.csproj
@@ -8,6 +8,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.Graphics.Tests/Stride.Graphics.Tests.Windows.csproj b/sources/engine/Stride.Graphics.Tests/Stride.Graphics.Tests.Windows.csproj
@@ -8,6 +8,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.Input.Tests/Stride.Input.Tests.Windows.csproj b/sources/engine/Stride.Input.Tests/Stride.Input.Tests.Windows.csproj
@@ -9,6 +9,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.Navigation.Tests/Stride.Navigation.Tests.Windows.csproj b/sources/engine/Stride.Navigation.Tests/Stride.Navigation.Tests.Windows.csproj
@@ -9,6 +9,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.Particles.Tests/Stride.Particles.Tests.Windows.csproj b/sources/engine/Stride.Particles.Tests/Stride.Particles.Tests.Windows.csproj
@@ -9,6 +9,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.Physics.Tests/Stride.Physics.Tests.Windows.csproj b/sources/engine/Stride.Physics.Tests/Stride.Physics.Tests.Windows.csproj
@@ -9,6 +9,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/engine/Stride.UI.Tests/Stride.UI.Tests.Windows.csproj b/sources/engine/Stride.UI.Tests/Stride.UI.Tests.Windows.csproj
@@ -9,6 +9,7 @@
     <StrideBuildTags>*</StrideBuildTags>
     <StrideCompileAssets>true</StrideCompileAssets>
     <StrideGraphicsApiDependent>true</StrideGraphicsApiDependent>
+    <StrideGraphicsRegression>true</StrideGraphicsRegression>
     <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
     <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
   </PropertyGroup>
diff --git a/sources/shared/tests/xunit/LauncherGame.Desktop.cs b/sources/shared/tests/xunit/LauncherGame.Desktop.cs
@@ -1,13 +1,10 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+
+using Stride.Graphics.Regression;
 
 namespace xunit.runner.stride
 {
     class Program
     {
-        public static void Main(string[] args) => StrideXunitRunner.Main(args, interactiveMode => GameTestBase.ForceInteractiveMode = interactiveMode);
+        public static void Main(string[] args) => StrideXunitRunner.Main(args, interactiveMode => GameTestBase.ForceInteractiveMode = interactiveMode, forceSaveImage => GameTestBase.ForceSaveImageOnSuccess = forceSaveImage);
     }
 }
diff --git a/sources/targets/Stride.UnitTests.targets b/sources/targets/Stride.UnitTests.targets
@@ -55,10 +55,10 @@
     <StartupObject>xunit.runner.stride.Program</StartupObject>
   </PropertyGroup>
   <ItemGroup Condition="'$(StridePlatform)' == 'Linux' Or '$(StridePlatform)' == 'Windows'">
-    <Compile Condition="'$(StrideGraphicsApiDependent)' != 'true'" Include="$(MSBuildThisFileDirectory)..\shared\tests\xunit\LauncherSimple.Desktop.cs">
+    <Compile Condition="'$(StrideGraphicsRegression)' != 'true'" Include="$(MSBuildThisFileDirectory)..\shared\tests\xunit\LauncherSimple.Desktop.cs">
       <Link>LauncherSimple.Desktop.cs</Link>
     </Compile>
-    <Compile Condition="'$(StrideGraphicsApiDependent)' == 'true'" Include="$(MSBuildThisFileDirectory)..\shared\tests\xunit\LauncherSimple.Desktop.cs">
+    <Compile Condition="'$(StrideGraphicsRegression)' == 'true'" Include="$(MSBuildThisFileDirectory)..\shared\tests\xunit\LauncherGame.Desktop.cs">
       <Link>LauncherGame.Desktop.cs</Link>
     </Compile>
   </ItemGroup>
diff --git a/sources/tests/xunit.runner.stride/App.axaml.cs b/sources/tests/xunit.runner.stride/App.axaml.cs
@@ -14,6 +14,7 @@ public partial class App : Application
 {
     internal readonly CancellationTokenSource cts = new();
     internal Action<bool>? setInteractiveMode;
+    internal Action<bool>? setForceSaveImage;
 
     public override void Initialize()
     {
@@ -35,7 +36,9 @@ public override void OnFrameworkInitializationCompleted()
                     Tests =
                     {
                         SetInteractiveMode = setInteractiveMode,
+                        SetForceSaveImage = setForceSaveImage,
                         IsInteractiveMode = true,
+                        IsForceSaveImage = false,
                     }
                 }
             };
@@ -52,7 +55,9 @@ public override void OnFrameworkInitializationCompleted()
                     Tests =
                     {
                         SetInteractiveMode = setInteractiveMode,
+                        SetForceSaveImage = setForceSaveImage,
                         IsInteractiveMode = true,
+                        IsForceSaveImage = false,
                     }
                 }
             };
diff --git a/sources/tests/xunit.runner.stride/StrideXunitRunner.cs b/sources/tests/xunit.runner.stride/StrideXunitRunner.cs
@@ -12,20 +12,19 @@ public static class StrideXunitRunner
     // Initialization code. Don't use any Avalonia, third-party APIs or any
     // SynchronizationContext-reliant code before AppMain is called: things aren't initialized
     // yet and stuff might break.
-    public static void Main(string[] _, Action<bool>? setInteractiveMode = null)
+    public static void Main(string[] _, Action<bool>? setInteractiveMode = null, Action<bool>? setForceSaveImage = null)
     {
-        var builder = BuildAvaloniaApp()
+        var builder = BuildAvaloniaApp(setInteractiveMode, setForceSaveImage)
             .SetupWithLifetime(new ClassicDesktopStyleApplicationLifetime());
         if (builder.Instance is App app)
         {
-            app.setInteractiveMode = setInteractiveMode;
             app.Run(app.cts.Token);
         }
     }
 
     // Avalonia configuration, don't remove; also used by visual designer.
-    public static AppBuilder BuildAvaloniaApp()
-        => AppBuilder.Configure<App>()
+    public static AppBuilder BuildAvaloniaApp(Action<bool>? setInteractiveMode = null, Action<bool>? setForceSaveImage = null)
+        => AppBuilder.Configure(() => new App { setInteractiveMode = setInteractiveMode, setForceSaveImage = setForceSaveImage })
             .UsePlatformDetect()
             .WithInterFont()
             .LogToTrace();
diff --git a/sources/tests/xunit.runner.stride/ViewModels/TestsViewModel.cs b/sources/tests/xunit.runner.stride/ViewModels/TestsViewModel.cs
@@ -115,6 +115,21 @@ public bool IsInteractiveMode
         }
     }
 
+    bool isForceSaveImage = false;
+    public bool IsForceSaveImage
+    {
+        get => isForceSaveImage;
+        set
+        {
+            SetProperty(ref isForceSaveImage, value);
+            SetForceSaveImage?.Invoke(isForceSaveImage);
+        }
+    }
+
     public List<TestNodeViewModel> TestCases { get; } = [];
     public Action<bool>? SetInteractiveMode { get; set; }
+    public bool HasInteractiveMode => SetInteractiveMode != null;
+
+    public Action<bool>? SetForceSaveImage { get; set; }
+    public bool HasForceSaveImage => SetForceSaveImage != null;
 }
diff --git a/sources/tests/xunit.runner.stride/Views/MainView.axaml b/sources/tests/xunit.runner.stride/Views/MainView.axaml
@@ -7,7 +7,11 @@
              x:Class="xunit.runner.stride.Views.MainView"
              x:DataType="vm:MainViewModel">
   <DockPanel DataContext="{Binding Tests}">
-    <CheckBox DockPanel.Dock="Top" Content="Interactive Mode" IsChecked="{Binding IsInteractiveMode}"/>
+    <StackPanel DockPanel.Dock="Top" Orientation="Horizontal">
+      <CheckBox Content="Interactive Mode" IsChecked="{Binding IsInteractiveMode}" IsEnabled="{Binding HasInteractiveMode}"/>
+		<Separator Opacity="0" Width="10"/>
+      <CheckBox Content="Force Save Image" IsChecked="{Binding IsForceSaveImage}" IsEnabled="{Binding HasForceSaveImage}"/>
+    </StackPanel>
     <ProgressBar DockPanel.Dock="Top"
                  Height="16"
                  Minimum="0" Maximum="100" Value="{Binding TestCompletion}" />
