Merge pull request #106 from aquality-automation/feature/cross-platform-visualization

[Visual] Migration from System.Drawing.Common to SkiaSharp +semver: breaking

Author: aqualityAutomation

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.csproj

@@ -53,6 +53,6 @@
     <PackageReference Include="NLog" Version="5.1.2" />
     <PackageReference Include="Selenium.Support" Version="4.8.1" />
     <PackageReference Include="Selenium.WebDriver" Version="4.8.1" />
-    <PackageReference Include="System.Drawing.Common" Version="6.0.0" />    
+    <PackageReference Include="SkiaSharp" Version="2.88.3" />    
   </ItemGroup>
 </Project>

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

@@ -32,7 +32,7 @@
   "loc.form.dump.exceededdumpname": "Перевищено довжину назви дампу. Кінцевий шлях: [{0}]",
   "loc.form.dump.imagenotsaved": "Не вдалося зберегти зображення елемента [{0}]: {1}",
   "loc.form.dump.compare": "Порівняння елементів форми з дампом [{0}]",
-  "loc.form.dump.elementnotfound": "Елемент [{0}]знайдено в дампі, але не знайдено на формі",
+  "loc.form.dump.elementnotfound": "Елемент [{0}] знайдено в дампі, але не знайдено на формі",
   "loc.form.dump.elementsmissedindump": "Елементи, які були знайдені на формі, але пропущені в дампі: [{0}].",
   "loc.form.dump.elementsmissedonform": "Елементи, які були знайдені в дампі, але пропущені на формі: [{0}].",
   "loc.form.dump.unprocessedelements": "Кількість необроблених (без відповідності між формою і дампом) елементів становить [{0}]. Для них різниця вважається 100%",

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Resources/Localization/uk.json

@@ -3,7 +3,6 @@
 using Aquality.Selenium.Core.Localization;
 using System;
 using System.Collections.Generic;
-using System.Drawing;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -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(Image.FromFile(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

@@ -1,5 +1,5 @@
 using Aquality.Selenium.Core.Configurations;
-using System.Drawing;
+using SkiaSharp;
 
 namespace Aquality.Selenium.Core.Visualization
 {
@@ -17,6 +17,6 @@ public interface IImageComparator
         /// <param name="theOtherOne">The image to compare with</param>
         /// <param name="threshold">How big a difference will be ignored as a percentage - value between 0 and 1. </param>
         /// <returns>The difference between the two images as a percentage  - value between 0 and 1.</returns>
-        float PercentageDifference(Image thisOne, Image theOtherOne, float? threshold = null);
+        float PercentageDifference(SKImage thisOne, SKImage theOtherOne, float? threshold = null);
     }
 }

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

@@ -1,4 +1,5 @@
 using Aquality.Selenium.Core.Configurations;
+using SkiaSharp;
 using System.Drawing;
 
 namespace Aquality.Selenium.Core.Visualization
@@ -22,7 +23,7 @@ public interface IVisualStateProvider
         /// <summary>
         /// Gets an image containing the screenshot of the element.
         /// </summary>
-        Image Image { get; }
+        SKImage Image { get; }
 
         /// <summary>
         /// Gets the difference between the image of the element and the provided image
@@ -32,6 +33,6 @@ public interface IVisualStateProvider
         /// <param name="threshold">How big a difference will be ignored as a percentage - value between 0 and 1.
         /// If the value is null, the default value is got from <see cref="IVisualizationConfiguration"/>.</param>
         /// <returns>The difference between the two images as a percentage  - value between 0 and 1.</returns>
-        float GetDifference(Image theOtherOne, float? threshold = null);
+        float GetDifference(SKImage theOtherOne, float? threshold = null);
     }
 }

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

@@ -1,6 +1,6 @@
 using Aquality.Selenium.Core.Configurations;
+using SkiaSharp;
 using System;
-using System.Drawing;
 
 namespace Aquality.Selenium.Core.Visualization
 {
@@ -33,7 +33,7 @@ public ImageComparator(IVisualizationConfiguration visualizationConfiguration)
         /// If the value is null, the default value is got from <see cref="IVisualizationConfiguration"/>.</param>
         /// <returns>The difference between the two images as a percentage  - value between 0 and 1.</returns>
         /// <remarks>See https://web.archive.org/web/20130208001434/http://tech.pro:80/tutorial/660/csharp-tutorial-convert-a-color-image-to-grayscale for more details.</remarks>
-        public virtual float PercentageDifference(Image thisOne, Image theOtherOne, float? threshold = null)
+        public virtual float PercentageDifference(SKImage thisOne, SKImage theOtherOne, float? threshold = null)
         {
             var thresholdValue = threshold ?? DefaultThreshold;
             if (thresholdValue < 0 || thresholdValue > 1)
@@ -53,7 +53,7 @@ public virtual float PercentageDifference(Image thisOne, Image theOtherOne, floa
         /// <param name="threshold">How big a difference (out of 255) will be ignored - the default is 3.</param>
         /// <returns>The difference between the two images as a percentage</returns>
         /// <remarks>See https://web.archive.org/web/20130208001434/http://tech.pro:80/tutorial/660/csharp-tutorial-convert-a-color-image-to-grayscale for more details</remarks>
-        protected virtual float PercentageDifference(Image thisOne, Image theOtherOne, byte threshold = 3)
+        protected virtual float PercentageDifference(SKImage thisOne, SKImage theOtherOne, byte threshold = 3)
         {
             var differences = GetDifferences(thisOne, theOtherOne);
 
@@ -73,7 +73,7 @@ protected virtual float PercentageDifference(Image thisOne, Image theOtherOne, b
         /// <param name="thisOne">The first image</param>
         /// <param name="theOtherOne">The image to compare with</param>
         /// <returns>the differences between the two images as a double-array</returns>
-        protected virtual byte[,] GetDifferences(Image thisOne, Image theOtherOne)
+        protected virtual byte[,] GetDifferences(SKImage thisOne, SKImage theOtherOne)
         {
             var firstGray = GetResizedGrayScaleValues(thisOne);
             var secondGray = GetResizedGrayScaleValues(theOtherOne);
@@ -95,17 +95,17 @@ protected virtual float PercentageDifference(Image thisOne, Image theOtherOne, b
         /// </summary>
         /// <param name="img">The image to get the lightness for</param>
         /// <returns>A double-array (16x16 by default) containing the lightness of the sections(256 by default)</returns>
-        protected virtual byte[,] GetResizedGrayScaleValues(Image img)
+        protected virtual byte[,] GetResizedGrayScaleValues(SKImage img)
         {
-            using (var thisOne = (Bitmap)img.Resize(ComparisonWidth, ComparisonHeight).GetGrayScaleVersion())
+            using (var thisOne = SKBitmap.FromImage(img.Resize(ComparisonWidth, ComparisonHeight).GetGrayScaleVersion()))
             {
                 byte[,] grayScale = new byte[thisOne.Width, thisOne.Height];
 
                 for (int y = 0; y < thisOne.Height; y++)
                 {
                     for (int x = 0; x < thisOne.Width; x++)
                     {
-                        grayScale[x, y] = (byte)Math.Abs(thisOne.GetPixel(x, y).R);
+                        grayScale[x, y] = (byte)Math.Abs(thisOne.GetPixel(x, y).Red);
                     }
                 }