#94 Add support of page snapshots configuration

Author: YevgeniyShunevych

src/Atata.Configuration.Json/JsonConfig`1.cs

@@ -197,6 +197,10 @@ public double? RetryInterval
 
         public string TakeScreenshotOnNUnitErrorTitle { get; set; }
 
+        public bool TakePageSnapshotOnNUnitError { get; set; }
+
+        public string TakePageSnapshotOnNUnitErrorTitle { get; set; }
+
         public bool OnCleanUpAddArtifactsToNUnitTestContext { get; set; }
 
         public string OnCleanUpAddDirectoryFilesToNUnitTestContext { get; set; }
@@ -250,5 +254,10 @@ public double? RetryInterval
         /// Gets or sets the event subscriptions.
         /// </summary>
         public List<EventSubscriptionJsonSection> EventSubscriptions { get; set; }
+
+        /// <summary>
+        /// Gets or sets the page snapshots configuration.
+        /// </summary>
+        public PageSnapshotsJsonSection PageSnapshots { get; set; }
     }
 }

src/Atata.Configuration.Json/Mapping/JsonConfigMapper.cs

@@ -112,6 +112,14 @@ public static AtataContextBuilder Map<TConfig>(TConfig config, AtataContextBuild
                     builder.TakeScreenshotOnNUnitError();
             }
 
+            if (config.TakePageSnapshotOnNUnitError)
+            {
+                if (config.TakePageSnapshotOnNUnitErrorTitle != null)
+                    builder.TakePageSnapshotOnNUnitError(config.TakePageSnapshotOnNUnitErrorTitle);
+                else
+                    builder.TakePageSnapshotOnNUnitError();
+            }
+
             if (config.OnCleanUpAddArtifactsToNUnitTestContext)
                 builder.OnCleanUpAddArtifactsToNUnitTestContext();
 
@@ -151,6 +159,9 @@ public static AtataContextBuilder Map<TConfig>(TConfig config, AtataContextBuild
             if (config.EventSubscriptions != null)
                 MapEventSubscriptions(config.EventSubscriptions, builder);
 
+            if (config.PageSnapshots != null)
+                MapPageSnapshots(config.PageSnapshots, builder);
+
             return builder;
         }
 
@@ -275,5 +286,36 @@ private static void MapEventSubscriptions(List<EventSubscriptionJsonSection> sec
             builder.BuildingContext.EventSubscriptions.AddRange(
                 sections.Select(x => eventSubscriptionMapper.Map(x)));
         }
+
+        private static void MapPageSnapshots(PageSnapshotsJsonSection section, AtataContextBuilder builder)
+        {
+            if (!string.IsNullOrEmpty(section.FileNameTemplate))
+                builder.PageSnapshots.UseFileNameTemplate(section.FileNameTemplate);
+
+            if (section?.Strategy?.Type != null)
+            {
+                if (!PageSnapshotStrategyAliases.TryResolve(section.Strategy.Type, out IPageSnapshotStrategy strategy))
+                    strategy = (IPageSnapshotStrategy)CreateObject(
+                        section.Strategy.Type,
+                        section.Strategy.ExtraPropertiesMap,
+                        builder.BuildingContext.DefaultAssemblyNamePatternToFindTypes);
+
+                builder.PageSnapshots.UseStrategy(strategy);
+            }
+        }
+
+        private static object CreateObject(string typeName, Dictionary<string, object> valuesMap, string assemblyNamePatternToFindType)
+        {
+            IObjectConverter objectConverter = new ObjectConverter
+            {
+                AssemblyNamePatternToFindTypes = assemblyNamePatternToFindType
+            };
+            IObjectMapper objectMapper = new ObjectMapper(objectConverter);
+            IObjectCreator objectCreator = new ObjectCreator(objectConverter, objectMapper);
+
+            var assembliesToFindTypes = AssemblyFinder.FindAllByPattern(assemblyNamePatternToFindType);
+            Type strategyType = TypeFinder.FindInAssemblies(typeName, assembliesToFindTypes);
+            return objectCreator.Create(strategyType, valuesMap);
+        }
     }
 }

src/Atata.Configuration.Json/Models/PageSnapshots/PageSnapshotStrategyJsonSection.cs

@@ -0,0 +1,7 @@
+namespace Atata.Configuration.Json
+{
+    public sealed class PageSnapshotStrategyJsonSection : JsonSection
+    {
+        public string Type { get; set; }
+    }
+}

src/Atata.Configuration.Json/Models/PageSnapshots/PageSnapshotsJsonSection.cs

@@ -0,0 +1,9 @@
+namespace Atata.Configuration.Json
+{
+    public sealed class PageSnapshotsJsonSection
+    {
+        public string FileNameTemplate { get; set; }
+
+        public PageSnapshotStrategyJsonSection Strategy { get; set; }
+    }
+}

test/Atata.Configuration.Json.Tests/Configs/Chrome+NUnit.json

@@ -23,6 +23,12 @@
       "sectionFinish": true
     }
   ],
+  "pageSnapshots": {
+    "fileNameTemplate": "{snapshot-number:D2}!",
+    "strategy": {
+      "type": "pageSource"
+    }
+  },
   "assertionExceptionType": "NUnit.Framework.AssertionException, nunit.framework",
   "baseRetryTimeout": 7,
   "baseRetryInterval": 0.7,

test/Atata.Configuration.Json.Tests/GeneralSettingsTests.cs

@@ -41,6 +41,9 @@ public void GeneralAndNUnit()
             context.DefaultAssemblyNamePatternToFindTypes.Should().Be("def");
             context.AssemblyNamePatternToFindComponentTypes.Should().Be("comp");
             context.AssemblyNamePatternToFindAttributeTypes.Should().Be("attr");
+
+            context.PageSnapshots.FileNameTemplate.Should().Be("{snapshot-number:D2}!");
+            context.PageSnapshots.Strategy.Should().BeOfType<PageSourcePageSnapshotStrategy>();
         }
     }
 }