Coding enhancements in DumpManager and tests

Author: mialeska

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.xml

@@ -1,7 +1,6 @@
 using Aquality.Selenium.Core.Configurations;
 using Aquality.Selenium.Core.Elements.Interfaces;
 using Aquality.Selenium.Core.Localization;
-using SkiaSharp;
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -39,15 +38,7 @@ public virtual float Compare(string dumpName = null)
         {
             var directory = GetDumpDirectory(dumpName);
             LocalizedLogger.Info("loc.form.dump.compare", directory.Name);
-            if (!directory.Exists)
-            {
-                throw new InvalidOperationException($"Dump directory [{directory.FullName}] does not exist.");
-            }
-            var imageFiles = directory.GetFiles($"*{ImageFormat.Extension}");
-            if (imageFiles.Length == 0)
-            {
-                throw new InvalidOperationException($"Dump directory [{directory.FullName}] does not contain any [*{ImageFormat.Extension}] files.");
-            }
+            var imageFiles = GetImageFiles(directory);
             var existingElements = FilterElementsForVisualization().ToDictionary(el => el.Key, el => el.Value);
             var countOfUnproceededElements = existingElements.Count;
             var countOfProceededElements = 0;
@@ -64,12 +55,21 @@ public virtual float Compare(string dumpName = null)
                 }
                 else
                 {
-                    comparisonResult += existingElements[key].Visual.GetDifference(SKImage.FromEncodedData(imageFile.FullName));
+                    comparisonResult += existingElements[key].Visual.GetDifference(imageFile.ReadImage());
                     countOfUnproceededElements--;
                     countOfProceededElements++;
                     existingElements.Remove(key);
                 }
             }
+            LogUnproceededElements(countOfUnproceededElements, existingElements, absentOnFormElementNames);
+            // adding of countOfUnproceededElements means 100% difference for each element absent in dump or on page
+            var result = (comparisonResult + countOfUnproceededElements) / (countOfProceededElements + countOfUnproceededElements);
+            LocalizedLogger.Info("loc.form.dump.compare.result", result.ToString("P", CultureInfo.InvariantCulture));
+            return result;
+        }
+
+        private void LogUnproceededElements(int countOfUnproceededElements, IDictionary<string, T> existingElements, IList<string> absentOnFormElementNames)
+        {
             if (countOfUnproceededElements > 0)
             {
                 if (existingElements.Any())
@@ -82,10 +82,20 @@ public virtual float Compare(string dumpName = null)
                 }
                 LocalizedLogger.Warn("loc.form.dump.unprocessedelements", countOfUnproceededElements);
             }
-            // adding of countOfUnproceededElements means 100% difference for each element absent in dump or on page
-            var result = (comparisonResult + countOfUnproceededElements) / (countOfProceededElements + countOfUnproceededElements);
-            LocalizedLogger.Info("loc.form.dump.compare.result", result.ToString("P", CultureInfo.InvariantCulture));
-            return result;
+        }
+
+        private FileInfo[] GetImageFiles(DirectoryInfo directory)
+        {
+            if (!directory.Exists)
+            {
+                throw new InvalidOperationException($"Dump directory [{directory.FullName}] does not exist.");
+            }
+            var imageFiles = directory.GetFiles($"*{ImageFormat.Extension}");
+            if (imageFiles.Length == 0)
+            {
+                throw new InvalidOperationException($"Dump directory [{directory.FullName}] does not contain any [*{ImageFormat.Extension}] files.");
+            }
+            return imageFiles;
         }
 
         public virtual void Save(string dumpName = null)
@@ -170,10 +180,11 @@ protected virtual DirectoryInfo GetDumpDirectory(string dumpName = null)
             if (fullDumpPath.Length + maxNameLengthOfDumpElements > MaxFullFileNameLength)
             {
                 validDumpNameString = validDumpNameString.Substring(0, MaxFullFileNameLength - Path.GetFullPath(DumpsDirectory).Length - maxNameLengthOfDumpElements);
-                LocalizedLogger.Warn("loc.form.dump.exceededdumpname", validDumpNameString);
+                fullDumpPath = Path.Combine(DumpsDirectory, validDumpNameString);
+                LocalizedLogger.Warn("loc.form.dump.exceededdumpname", fullDumpPath);
             }
 
-            return new DirectoryInfo(Path.Combine(DumpsDirectory, validDumpNameString));
+            return new DirectoryInfo(fullDumpPath);
         }
     }
 }

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Visualization/DumpManager.cs

@@ -18,6 +18,16 @@ public static class ImageExtensions
             0,     0,     0,      1, 0
         });
 
+        /// <summary>
+        /// Reads image from file.
+        /// </summary>
+        /// <param name="imageFile">The file to read the image from.</param>
+        /// <returns>Instance of SKImage.</returns>
+        public static SKImage ReadImage(this FileInfo imageFile)
+        {
+            return SKImage.FromEncodedData(imageFile.FullName);
+        }
+
         /// <summary>
         /// Resizes an image
         /// </summary>
@@ -66,8 +76,19 @@ public static SKImage GetGrayScaleVersion(this SKImage original)
             return SKImage.FromBitmap(newBitmap);
         }
 
+        /// <summary>
+        /// Gets size of the image.
+        /// </summary>
+        /// <param name="image">Current image.</param>
+        /// <returns>Size of the image.</returns>
         public static Size Size(this SKImage image) => new Size(image.Width, image.Height);
 
+        /// <summary>
+        /// Saves the image in specified format.
+        /// </summary>
+        /// <param name="image">Source image.</param>
+        /// <param name="name">Target file name.</param>
+        /// <param name="format">Image format.</param>
         public static void Save(this SKImage image, string name, SKEncodedImageFormat format = SKEncodedImageFormat.Png)
         {
             using (Stream stream = new FileStream(name, FileMode.OpenOrCreate))

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Visualization/ImageExtensions.cs

@@ -50,7 +50,7 @@ public void Should_BePossibleTo_SaveFormDump_WithDefaultName()
         public void Should_BePossibleTo_SaveFormDump_WithSubfoldersInName()
         {
             var form = new WebForm();
-            var dumpName = $"SubFolder1\\SubFolder2";
+            var dumpName = $"SubFolder1{Path.DirectorySeparatorChar}SubFolder2";
             var pathToDump = CleanUpAndGetPathToDump(dumpName);
 
             Assert.DoesNotThrow(() => form.Dump.Save(dumpName));
@@ -103,11 +103,11 @@ public void Should_BePossibleTo_SaveAndCompareWithDump_WithOverlengthDumpName_Wh
             customForm.SetElementsForDump(WebForm.ElementsFilter.AllElements);
 
             var maxElementNameLength = (int)customForm.Dump.GetType().GetMethod("GetMaxNameLengthOfDumpElements", BindingFlags.Instance | BindingFlags.NonPublic).Invoke(customForm.Dump, new object[] { });
-            var imageExtensioLength = ((ImageFormat)customForm.Dump.GetType().GetProperty("ImageFormat", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(customForm.Dump)).Extension.Length;
+            var imageExtensionLength = ((ImageFormat)customForm.Dump.GetType().GetProperty("ImageFormat", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(customForm.Dump)).Extension.Length;
             var maxLength = (int)customForm.Dump.GetType().GetProperty("MaxFullFileNameLength", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(customForm.Dump);
             var pathToDumpLength = PathToDumps.Length;
 
-            var dumpName = new string('A', maxLength - pathToDumpLength - maxElementNameLength - imageExtensioLength);
+            var dumpName = new string('A', maxLength - pathToDumpLength - maxElementNameLength - imageExtensionLength);
             var overlengthDumpName = dumpName + "_BCDE";
 
             var overlengthPathToDump = CleanUpAndGetPathToDump(overlengthDumpName);
@@ -150,7 +150,7 @@ public void Should_BePossibleTo_SaveFormDump_WithValidExtension(string imageExte
 
             foreach (var file in pathToDump.GetFiles())
             {
-                Assert.AreEqual(imageExtension, file.Extension, "Image extension not exual to expexted");
+                Assert.AreEqual(imageExtension, file.Extension, "Image extension not equal to expected");
                 Assert.That(file.Name.Contains(imageExtension), "Image name doesn't contain expected extension");
             }
         }