#698 Add page snapshot functionality

atata-framework · Nov 16, 2022 · 5c1a245 · 5c1a245
1 parent 14d4bf3
commit 5c1a245
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 6 deletions.
diff --git a/src/Atata/Context/PageSnapshots/PageSnapshotsAtataContextBuilder.cs b/src/Atata/Context/PageSnapshots/PageSnapshotsAtataContextBuilder.cs
@@ -45,7 +45,7 @@ public PageSnapshotsAtataContextBuilder UseStrategy(IPageSnapshotStrategy strate
 
         /// <summary>
         /// Sets the file name template of page snapshots.
-        /// The default value is <c>"{snapshot-number:D2} - {snapshot-pageobjectname} {snapshot-pageobjecttypename}{snapshot-title: - *}"</c>.
+        /// The default value is <c>"{snapshot-number:D2}{snapshot-pageobjectname: - *}{snapshot-pageobjecttypename: *}{snapshot-title: - *}"</c>.
         /// </summary>
         /// <param name="fileNameTemplate">The file name template.</param>
         /// <returns>The <see cref="PageSnapshotsAtataContextBuilder"/> instance.</returns>

diff --git a/src/Atata/Context/PageSnapshots/PageSnapshotsConfiguration.cs b/src/Atata/Context/PageSnapshots/PageSnapshotsConfiguration.cs
@@ -16,10 +16,10 @@ public sealed class PageSnapshotsConfiguration : ICloneable
         /// <summary>
         /// Gets or sets the page snapshot file name template.
         /// The file name is relative to Artifacts path.
-        /// The default value is <c>"{snapshot-number:D2} - {snapshot-pageobjectname} {snapshot-pageobjecttypename}{snapshot-title: - *}"</c>.
+        /// The default value is <c>"{snapshot-number:D2}{snapshot-pageobjectname: - *}{snapshot-pageobjecttypename: *}{snapshot-title: - *}"</c>.
         /// </summary>
         public string FileNameTemplate { get; set; } =
-            "{snapshot-number:D2} - {snapshot-pageobjectname} {snapshot-pageobjecttypename}{snapshot-title: - *}";
+            "{snapshot-number:D2}{snapshot-pageobjectname: - *}{snapshot-pageobjecttypename: *}{snapshot-title: - *}";
 
         /// <inheritdoc cref="Clone"/>
         object ICloneable.Clone() => Clone();

diff --git a/src/Atata/Logging/Snapshots/PageSnapshotTaker.cs b/src/Atata/Logging/Snapshots/PageSnapshotTaker.cs
@@ -49,9 +49,9 @@ private string FormatFilePath(string title)
             {
                 ["snapshot-number"] = _snapshotNumber,
                 ["snapshot-title"] = title,
-                ["snapshot-pageobjectname"] = pageObject.ComponentName,
-                ["snapshot-pageobjecttypename"] = pageObject.ComponentTypeName,
-                ["snapshot-pageobjectfullname"] = pageObject.ComponentFullName
+                ["snapshot-pageobjectname"] = pageObject?.ComponentName,
+                ["snapshot-pageobjecttypename"] = pageObject?.ComponentTypeName,
+                ["snapshot-pageobjectfullname"] = pageObject?.ComponentFullName
             };
 
             return AtataContext.Current.FillPathTemplateString(_filePathTemplate, snapshotVariables);

diff --git a/test/Atata.IntegrationTests/Context/AtataContextTests.cs b/test/Atata.IntegrationTests/Context/AtataContextTests.cs
@@ -193,4 +193,25 @@ public class FillTemplateString : UITestFixtureBase
             _sut.ResultOf(x => x.FillTemplateString("start_{missingkey}_end"))
                 .Should.Throw<FormatException>();
     }
+
+    public class TakePageSnapshot : UITestFixture
+    {
+        [Test]
+        public void WhenNavigated()
+        {
+            Go.To<InputPage>();
+
+            AtataContext.Current.TakePageSnapshot();
+
+            AtataContext.Current.Artifacts.Should.ContainFile("01 - Input page.mhtml");
+        }
+
+        [Test]
+        public void WhenNoNavigation()
+        {
+            AtataContext.Current.TakePageSnapshot();
+
+            AtataContext.Current.Artifacts.Should.ContainFile("01.mhtml");
+        }
+    }
 }