Merge pull request #472 from Lombiq/issue/NEST-560

NEST-560: Fixing flaky Audit Trail and Workflow UI testing extensions, adding extra checks

Author: Piedone

Lombiq.Tests.UI/BasicOrchardFeaturesTesting/AuditTrailFeatureTestingUITestContextExtensions.cs

@@ -28,6 +28,8 @@ public static Task TestAuditTrailAsync(this UITestContext context) =>
 
             await context.ClickReliablyOnSubmitAsync();
 
+            context.SuccessMessageExists("Site settings updated successfully.");
+
             var contentItemsPage = await context.GoToContentItemsPageAsync();
             context.RefreshCurrentAtataContext();
             contentItemsPage

Lombiq.Tests.UI/BasicOrchardFeaturesTesting/WorkflowsFeatureTestingUITestContextExtensions.cs

@@ -32,6 +32,7 @@ public static Task TestWorkflowsAsync(this UITestContext context) =>
                 await context.ClickAndFillInWithRetriesAsync(By.Id("IActivity_ActivityMetadata_Title"), "Content Published Trigger");
                 await context.SetCheckboxValueAsync(By.XPath("//input[@value='Page']"));
                 await context.ClickReliablyOnSubmitAsync();
+                context.ShouldBeSuccess();
 
                 await context.ClickReliablyOnAsync(By.XPath("//button[@data-activity-type='Task']"));
                 await context.ClickReliablyOnAsync(By.XPath("//a[contains(@href, 'NotifyTask')]"));
@@ -54,10 +55,15 @@ public static Task TestWorkflowsAsync(this UITestContext context) =>
                 // buggy during UI testing (it won't be clicked, even if we check for its existence). This way it's
                 // always clicked.
                 await context.ClickReliablyOnSubmitAsync();
+                context.ShouldBeSuccess();
+
                 await context.ClickReliablyOnAsync(By.XPath("//div[contains(@class, 'activity-event')]"));
 
                 await context.ClickReliablyOnAsync(By.XPath("//a[@title='Startup event']"));
-                await context.ClickReliablyOnSubmitAsync();
+
+                // Sometimes during this step the test can fail, so we are using JavaScript to click submit, this only
+                // happens here.
+                await context.ClickReliablyOnSubmitAsync(withJavaScript: true);
 
                 context.ShouldBeSuccess("Workflow has been saved.");
 

Lombiq.Tests.UI/CompatibilitySuppressions.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!-- https://learn.microsoft.com/dotnet/fundamentals/package-validation/diagnostic-ids -->
 <Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Suppression>
@@ -71,6 +71,13 @@
     <Right>lib/net8.0/Lombiq.Tests.UI.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>
   </Suppression>
+  <Suppression>
+    <DiagnosticId>CP0002</DiagnosticId>
+    <Target>M:Lombiq.Tests.UI.Extensions.FormUITestContextExtensions.ClickReliablyOnSubmitAsync(Lombiq.Tests.UI.Services.UITestContext)</Target>
+    <Left>lib/net8.0/Lombiq.Tests.UI.dll</Left>
+    <Right>lib/net8.0/Lombiq.Tests.UI.dll</Right>
+    <IsBaselineSuppression>true</IsBaselineSuppression>
+  </Suppression>
   <Suppression>
     <DiagnosticId>CP0002</DiagnosticId>
     <Target>M:Lombiq.Tests.UI.Extensions.FrontendUITestContextExtensions.ExecuteJavascriptTestAsync(Lombiq.Tests.UI.Services.UITestContext,System.String,Xunit.Abstractions.ITestOutputHelper)</Target>
@@ -428,4 +435,4 @@
     <Right>lib/net8.0/Lombiq.Tests.UI.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>
   </Suppression>
-</Suppressions>
+</Suppressions>

Lombiq.Tests.UI/Extensions/FormUITestContextExtensions.cs

@@ -310,8 +310,18 @@ public static DateTime GetDatePicker(this UITestContext context, string id) =>
     /// <summary>
     /// Finds the first submit button (excluding any "Log off" buttons) and clicks on it reliably.
     /// </summary>
-    public static Task ClickReliablyOnSubmitAsync(this UITestContext context) =>
-        context.ClickReliablyOnAsync(By.XPath("//button[@type='submit' and not(ancestor::form[@action='/Users/LogOff'])]"));
+    /// <param name="withJavaScript">When set to <see langword="true"/> it clicks the button with JavaScript.</param>
+    public static Task ClickReliablyOnSubmitAsync(this UITestContext context, bool withJavaScript = false)
+    {
+        if (withJavaScript)
+        {
+            context.ExecuteScript("document.querySelector(\"button[type='submit']:not(form[action='/Users/LogOff'] button)\").click();");
+            return Task.CompletedTask;
+        }
+
+        return
+            context.ClickReliablyOnAsync(By.XPath("//button[@type='submit' and not(ancestor::form[@action='/Users/LogOff'])]"));
+    }
 
     /// <summary>
     /// Finds the "Add New" button.