[Visual Testing] Add ability of visualization checks for the Screen (#31) +semver: breaking

mialeska · web-flow · commit 34686ae3daa6 · 2021-06-09T17:45:10.000+03:00
* [Visual Testing] Add ability of visualization checks for the Screen +semver: breaking

* update Aquality.Selenium.Core to latest version

* make Screen inherit the Form&lt;IElement&gt;, implement abstractions

* Add visualization settings block to settings.json
Add SaveAndCompareScreenDump test to ensure that visualization feature works correctly

* Install runtime.osx.10.10-x64.CoreCompat.System.Drawing to run tests on MacOS
diff --git a/.gitignore b/.gitignore
@@ -37,3 +37,4 @@ msbuild.wrn
 .vs/
 
 Log/
+VisualDumps/
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.csproj b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.csproj
@@ -46,7 +46,7 @@
   
   <ItemGroup>
     <PackageReference Include="Appium.WebDriver" Version="4.3.1" />
-    <PackageReference Include="Aquality.Selenium.Core" Version="1.3.1" />
+    <PackageReference Include="Aquality.Selenium.Core" Version="1.6.1" />
   </ItemGroup>
 
 </Project>
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.xml b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.xml
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Elements/Element.cs b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Elements/Element.cs
@@ -6,6 +6,7 @@
 using Aquality.Selenium.Core.Elements.Interfaces;
 using Aquality.Selenium.Core.Localization;
 using Aquality.Selenium.Core.Utilities;
+using Aquality.Selenium.Core.Visualization;
 using Aquality.Selenium.Core.Waitings;
 using OpenQA.Selenium;
 using OpenQA.Selenium.Appium;
@@ -36,6 +37,8 @@ protected Element(By locator, string name, ElementState state) : base(locator, n
 
         protected override IElementFinder Finder => AqualityServices.Get<IElementFinder>();
 
+        protected override IImageComparator ImageComparator => AqualityServices.Get<IImageComparator>();
+
         protected override ILocalizedLogger LocalizedLogger => AqualityServices.LocalizedLogger;
 
         protected override ILocalizationManager LocalizationManager => AqualityServices.Get<ILocalizationManager>();
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Resources/settings.json b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Resources/settings.json
@@ -53,5 +53,11 @@
       "verticalOffset": 0.2,
       "horizontalOffset": 0.5
     }
+  },
+  "visualization": {
+    "defaultThreshold": 0.012,
+    "comparisonWidth": 16,
+    "comparisonHeight": 16,
+    "pathToDumps": "../../../Resources/VisualDumps/"
   }
 }
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Screens/IScreen.cs b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Screens/IScreen.cs
@@ -1,4 +1,5 @@
 ﻿using Aquality.Selenium.Core.Elements.Interfaces;
+using Aquality.Selenium.Core.Forms;
 using OpenQA.Selenium;
 using System.Drawing;
 
@@ -7,18 +8,13 @@ namespace Aquality.Appium.Mobile.Screens
     /// <summary>
     /// Interface that describes application under the test screen.
     /// </summary>
-    public interface IScreen 
+    public interface IScreen : IForm
     {
         /// <summary>
         /// Unique screen locator.
         /// </summary>
         By Locator { get; }
 
-        /// <summary>
-        /// Unique screen name.
-        /// </summary>
-        string Name { get; }
-
         /// <summary>
         /// Size of the element described by screen locator.
         /// </summary>
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Screens/Screen.cs b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Screens/Screen.cs
@@ -1,6 +1,9 @@
 ﻿using Aquality.Appium.Mobile.Applications;
 using Aquality.Appium.Mobile.Elements.Interfaces;
+using Aquality.Selenium.Core.Configurations;
 using Aquality.Selenium.Core.Elements.Interfaces;
+using Aquality.Selenium.Core.Forms;
+using Aquality.Selenium.Core.Localization;
 using OpenQA.Selenium;
 using System.Drawing;
 using IElement = Aquality.Appium.Mobile.Elements.Interfaces.IElement;
@@ -13,7 +16,7 @@ namespace Aquality.Appium.Mobile.Screens
     /// Use <see cref="ScreenFactory.ScreenTypeAttribute"/> on your screen class to identify platform.
     /// <seealso cref="ScreenFactory.ScreenFactory"/>
     /// </summary>
-    public abstract class Screen : IScreen
+    public abstract class Screen : Form<IElement>, IScreen
     {
         private readonly ILabel screenLabel;
 
@@ -39,7 +42,11 @@ protected Screen(By locator, string name)
         /// Element factory <see cref="IElementFactory"/>
         /// </summary>
         protected static IElementFactory ElementFactory => AqualityServices.ElementFactory;
-        
+
+        protected override IVisualizationConfiguration VisualizationConfiguration => AqualityServices.Get<IVisualizationConfiguration>();
+
+        protected override ILocalizedLogger LocalizedLogger => AqualityServices.LocalizedLogger;
+
         /// <summary>
         /// Locator of the screen.
         /// </summary>
@@ -48,12 +55,12 @@ protected Screen(By locator, string name)
         /// <summary>
         /// Name of the screen.
         /// </summary>
-        public string Name { get; }
+        public override string Name { get; }
 
         /// <summary>
         /// Gets size of form element defined by its locator.
         /// </summary>
-        public Size Size => screenLabel.GetElement().Size;
+        public Size Size => screenLabel.Visual.Size;
 
         /// <summary>
         /// Provides ability to get screen's state (whether it is displayed, exists or not) and respective waiting functions.
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Aquality.Appium.Mobile.Tests.csproj b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Aquality.Appium.Mobile.Tests.csproj
@@ -7,12 +7,13 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="nunit" Version="3.13.1" />
-    <PackageReference Include="NUnit3TestAdapter" Version="3.17.0">
+    <PackageReference Include="nunit" Version="3.13.2" />
+    <PackageReference Include="NUnit3TestAdapter" Version="4.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+    <PackageReference Include="runtime.osx.10.10-x64.CoreCompat.System.Drawing" Version="5.8.64" />
   </ItemGroup>
   
   <ItemGroup>
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.androidwebsession.json b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.androidwebsession.json
@@ -44,5 +44,11 @@
       "verticalOffset": 0.2,
       "horizontalOffset": 0.5
     }
+  },
+  "visualization": {
+    "defaultThreshold": 0.012,
+    "comparisonWidth": 16,
+    "comparisonHeight": 16,
+    "pathToDumps": "../../../Resources/VisualDumps/"
   }
 }
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.json b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.json
@@ -55,5 +55,11 @@
       "verticalOffset": 0.2,
       "horizontalOffset": 0.5
     }
+  },
+  "visualization": {
+    "defaultThreshold": 0.012,
+    "comparisonWidth": 16,
+    "comparisonHeight": 16,
+    "pathToDumps": "../../../Resources/VisualDumps/"
   }
 }
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/AndroidBasicInteractionsTest.cs b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/AndroidBasicInteractionsTest.cs
@@ -24,6 +24,20 @@ public void SendKeys()
             Assert.AreEqual(query, searchScreen.SearchResult, "Search result don't match to entered query");
         }
 
+        [Test]
+        public void SaveAndCompareScreenDump()
+        {
+            var searchScreen = new InvokeSearchScreen();
+            searchScreen.Open();
+            Assume.That(searchScreen.State.IsDisplayed, $"{searchScreen.Name} should be opened from the menu");
+
+            searchScreen.Dump.Save();
+            Assert.That(searchScreen.Dump.Compare(), Is.EqualTo(0), "Current screen should have no visual difference comparing to just saved dump");
+            const string query = "Hello world!";
+            searchScreen.TypeQuery(query);
+            Assert.That(searchScreen.Dump.Compare(), Is.GreaterThan(0), "Current screen should have visual difference comparing to dump saved before the search");
+        }
+
         [Test]
         public void AlertInteraction()
         {
@@ -51,8 +65,8 @@ public void TestVerticalSwipeToElement()
             OpenRadioButtonsScreen();
             viewControlsScreen.ScrollToAllInsideScrollViewLabel();
             Assert.AreEqual(
-                viewControlsScreen.AllInsideScrollViewLabelText,
                 "(And all inside of a ScrollView!)",
+                viewControlsScreen.AllInsideScrollViewLabelText,
                 "Label text does not match expected");
             viewControlsScreen.ScrollToDisabledButton();
             Assert.IsFalse(viewControlsScreen.IsDisabledButtonClickable);
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/ApiDemos/Screens/InvokeSearchScreen.cs b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/ApiDemos/Screens/InvokeSearchScreen.cs
@@ -20,9 +20,11 @@ public InvokeSearchScreen() : base(By.XPath("//android.widget.TextView[@text='Ap
 
         public string SearchResult => searchResultLabel.Text;
 
+        public void TypeQuery(string query) => searchTextBox.ClearAndType(query);
+
         public void SubmitSearch(string query)
         {
-            searchTextBox.ClearAndType(query);
+            TypeQuery(query);
             startSearchButton.Click();
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -37,3 +37,4 @@ msbuild.wrn`
`37`	`37`	`.vs/`
`38`	`38`
`39`	`39`	`Log/`
	`40`	`+VisualDumps/`
Original file line number	Diff line number	Diff line change
`@@ -53,5 +53,11 @@`
`53`	`53`	`"verticalOffset": 0.2,`
`54`	`54`	`"horizontalOffset": 0.5`
`55`	`55`	`}`
	`56`	`+ },`
	`57`	`+ "visualization": {`
	`58`	`+ "defaultThreshold": 0.012,`
	`59`	`+ "comparisonWidth": 16,`
	`60`	`+ "comparisonHeight": 16,`
	`61`	`+ "pathToDumps": "../../../Resources/VisualDumps/"`
`56`	`62`	`}`
`57`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,5 +44,11 @@`
`44`	`44`	`"verticalOffset": 0.2,`
`45`	`45`	`"horizontalOffset": 0.5`
`46`	`46`	`}`
	`47`	`+ },`
	`48`	`+ "visualization": {`
	`49`	`+ "defaultThreshold": 0.012,`
	`50`	`+ "comparisonWidth": 16,`
	`51`	`+ "comparisonHeight": 16,`
	`52`	`+ "pathToDumps": "../../../Resources/VisualDumps/"`
`47`	`53`	`}`
`48`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,5 +55,11 @@`
`55`	`55`	`"verticalOffset": 0.2,`
`56`	`56`	`"horizontalOffset": 0.5`
`57`	`57`	`}`
	`58`	`+ },`
	`59`	`+ "visualization": {`
	`60`	`+ "defaultThreshold": 0.012,`
	`61`	`+ "comparisonWidth": 16,`
	`62`	`+ "comparisonHeight": 16,`
	`63`	`+ "pathToDumps": "../../../Resources/VisualDumps/"`
`58`	`64`	`}`
`59`	`65`	`}`