OFFI-142: Handle dynamic setup operation

Lombiq.Tests.UI.Samples/UITestBase.cs

@@ -99,6 +99,17 @@ protected override Task ExecuteTestAsync(
                             "OrchardCore.Media.Core.DefaultMediaFileStoreCacheFileProvider|ERROR|Error deleting cache folder",
                         ]);
 
+                // Strictly speaking this is not necessary here, because we always use the same static method for setup.
+                // However, if you used a dynamic setup operation (e.g. `context => SetupHelpers.RunSetupAsync(context,
+                // someOtherVariable)` then the default setup identifier calculator would always return a new random
+                // value, because it uses `setupOperation.GetHashCode()` under the hood. A custom calculator would fix
+                // that. But in this example we just safely replace it with a human-readable name so the setup snapshot
+                // directory is easier to find.
+                configuration.SetupConfiguration.SetupOperationIdentifierCalculator = setupOperation =>
+                    setupOperation == SetupHelpers.RunSetupAsync
+                        ? "Sample Setup"
+                        : OrchardCoreSetupConfiguration.DefaultSetupOperationIdentifierCalculator(setupOperation);
+
                 if (changeConfigurationAsync != null) await changeConfigurationAsync(configuration);
             });
 }

Lombiq.Tests.UI/Services/OrchardCoreSetupConfiguration.cs

@@ -13,6 +13,9 @@ namespace Lombiq.Tests.UI.Services;
 /// </summary>
 public class OrchardCoreSetupConfiguration
 {
+    public static readonly Func<Func<UITestContext, Task<Uri>>, string> DefaultSetupOperationIdentifierCalculator =
+        setupOperation => setupOperation.GetHashCode().ToTechnicalString();
+
     /// <summary>
     /// Gets or sets the Orchard setup operation so the result can be snapshot and used in subsequent tests.
     /// WARNING: It's highly recommended to put assertions at the end to detect setup issues and fail tests early (since
@@ -21,6 +24,15 @@ public class OrchardCoreSetupConfiguration
     /// </summary>
     public Func<UITestContext, Task<Uri>> SetupOperation { get; set; }
 
+    /// <summary>
+    /// Gets or sets a function that calculates a unique ID which represents the setup operation. This is used when
+    /// generating the setup snapshot path. If you set the <see cref="SetupOperation"/> to a dynamic value (e.g. using a
+    /// lambda expression or a method that returns a new <see cref="Func{T,TResult}"/> instance) then you must set this
+    /// property to a custom function. Otherwise, it's safe to leave it as-is.
+    /// </summary>
+    public Func<Func<UITestContext, Task<Uri>>, string> SetupOperationIdentifierCalculator { get; set; } =
+        DefaultSetupOperationIdentifierCalculator;
+
     /// <summary>
     /// Gets or sets a value indicating whether if a specific setup operations fails and exhausts <see
     /// cref="OrchardCoreUITestExecutorConfiguration.MaxRetryCount"/> globally then all tests using the same operation
@@ -37,4 +49,11 @@ public class OrchardCoreSetupConfiguration
 
     public BeforeSetupHandler BeforeSetup { get; set; }
     public AfterSetupHandler AfterSetup { get; set; }
+
+    /// <summary>
+    /// If <see cref="SetupOperation"/> is not <see langword="null"/>, it invokes <see
+    /// cref="SetupOperationIdentifierCalculator"/> with the <see cref="SetupOperation"/> and returns the result.
+    /// </summary>
+    public string CalculateSetupOperationIdentifier() =>
+        SetupOperation is null ? null : SetupOperationIdentifierCalculator(SetupOperation);
 }

Lombiq.Tests.UI/Services/UITestExecutionSession.cs

@@ -1,4 +1,5 @@
 using Atata.HtmlValidation;
+using Cysharp.Text;
 using Lombiq.HelpfulLibraries.Common.Utilities;
 using Lombiq.Tests.UI.Constants;
 using Lombiq.Tests.UI.Exceptions;
@@ -452,7 +453,7 @@ private async Task SetupAsync()
             snapshotSubdirectory = "SQLite-AzureBlob";
         }
 
-        snapshotSubdirectory += "-" + setupConfiguration.SetupOperation!.GetHashCode().ToTechnicalString();
+        snapshotSubdirectory += "-" + setupConfiguration.CalculateSetupOperationIdentifier();
 
         _snapshotDirectoryPath = Path.Combine(setupConfiguration.SetupSnapshotDirectoryPath, snapshotSubdirectory);
 
@@ -661,9 +662,10 @@ Task UITestingBeforeAppStartHandlerAsync(OrchardCoreAppStartContext context, Ins
     }
 
     private string GetSetupHashCode() =>
-        _configuration.SetupConfiguration.SetupOperation.GetHashCode().ToTechnicalString() +
-        _configuration.UseSqlServer +
-        _configuration.UseAzureBlobStorage;
+        ZString.Concat(
+            _configuration.SetupConfiguration.CalculateSetupOperationIdentifier(),
+            _configuration.UseSqlServer,
+            _configuration.UseAzureBlobStorage);
 
     private Task OnAssertLogsAsync(UITestContext context) => context.AssertLogsAsync();