From 366253f3817e2d89a169244ce607d43657e5cdfd Mon Sep 17 00:00:00 2001
From: YevgeniyShunevych <yevgeniy.shunevych@gmail.com>
Date: Tue, 17 Oct 2023 13:08:47 +0200
Subject: [PATCH] #785 Add `Report.Setup<TResult>(Func<TOwner, TPageObject>
 function)` method

---
 src/Atata/Logging/ReportExtensions.cs         | 24 +++++++++++++++++++
 .../ReportExtensionsTests.cs                  | 20 ++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 src/Atata/Logging/ReportExtensions.cs
 create mode 100644 test/Atata.IntegrationTests/ReportExtensionsTests.cs

diff --git a/src/Atata/Logging/ReportExtensions.cs b/src/Atata/Logging/ReportExtensions.cs
new file mode 100644
index 00000000..354c8520
--- /dev/null
+++ b/src/Atata/Logging/ReportExtensions.cs
@@ -0,0 +1,24 @@
+namespace Atata;
+
+/// <summary>
+/// Provides a set of extension methods for <see cref="Report{TOwner}"/>.
+/// </summary>
+public static class ReportExtensions
+{
+    /// <summary>
+    /// Executes the specified function and represents it in a log as a setup section with the message like <c>"Set up "&lt;Some&gt;" page"</c>.
+    /// The setup function time is not counted as a "Test body" execution time, but counted as "Setup" time.
+    /// </summary>
+    /// <typeparam name="TOwner">The type of the owner.</typeparam>
+    /// <typeparam name="TPageObject">The type of the result page object.</typeparam>
+    /// <param name="report">The <see cref="Report{TOwner}"/> object.</param>
+    /// <param name="function">The setup function.</param>
+    /// <returns>The result page object of the <paramref name="function"/>.</returns>
+    public static TPageObject Setup<TOwner, TPageObject>(this Report<TOwner> report, Func<TOwner, TPageObject> function)
+        where TPageObject : PageObject<TPageObject>
+    {
+        string componentFullName = UIComponentResolver.ResolvePageObjectFullName<TPageObject>();
+
+        return report.Setup($"Set up {componentFullName}", function);
+    }
+}
diff --git a/test/Atata.IntegrationTests/ReportExtensionsTests.cs b/test/Atata.IntegrationTests/ReportExtensionsTests.cs
new file mode 100644
index 00000000..713b7698
--- /dev/null
+++ b/test/Atata.IntegrationTests/ReportExtensionsTests.cs
@@ -0,0 +1,20 @@
+namespace Atata.IntegrationTests;
+
+public class ReportExtensionsTests : UITestFixture
+{
+    [Test]
+    public void Setup()
+    {
+        AtataContext.Current.Report.Setup(x => x
+            .Go.To<OrdinaryPage>());
+
+        VerifyLastLogMessagesMatch(
+            minLogLevel: LogLevel.Trace,
+            "^> Set up \"<ordinary>\" page$",
+            "^> Go to \"<ordinary>\" page",
+            "^> Navigate to URL",
+            "^< Navigate to URL",
+            "^< Go to \"<ordinary>\" page",
+            "^< Set up \"<ordinary>\" page");
+    }
+}