Update Aquality.Selenium.Core version (#25)

* Update Aquality.Selenium.Core version

*Support overriding of capabilities from environment variables
Use GetValueDictionaryOrEmpty in DeviceSettings

*Support FindChildElements feature for Screen via ScreenElement property

* Add documentation to screen methods.

* Make ElementFactory property static in to make it possible to be used during the field initialization

Author: mialeska

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Applications/ApplicationFactory.cs

@@ -6,6 +6,7 @@
 using OpenQA.Selenium.Appium.Android;
 using OpenQA.Selenium.Appium.iOS;
 using System;
+using System.Collections.Generic;
 using System.Linq;
 
 namespace Aquality.Appium.Mobile.Applications
@@ -42,7 +43,7 @@ protected virtual AppiumDriver<AppiumWebElement> CreateSession(PlatformName plat
             return driver;
         }
 
-        protected class CustomActionRetrier : ElementActionRetrier
+        protected class CustomActionRetrier : ActionRetrier
         {
             private static readonly string[] handledErrorMessages = new string[]
             {
@@ -55,13 +56,18 @@ protected class CustomActionRetrier : ElementActionRetrier
             };
 
             public CustomActionRetrier() 
-                : base(AqualityServices.Get<IRetryConfiguration>(), new[] { typeof(WebDriverException) })
+                : base(AqualityServices.Get<IRetryConfiguration>())
             {
             }
 
-            protected override bool IsExceptionHandled(Exception exception)
+            protected override bool IsExceptionHandled(IEnumerable<Type> handledExceptions, Exception exception)
             {
-                return base.IsExceptionHandled(exception) && handledErrorMessages.Any(message => exception.Message.ToLower().Contains(message));
+                var exceptions = new List<Type>(handledExceptions ?? new List<Type>())
+                {
+                    typeof(WebDriverException)
+                };
+                return base.IsExceptionHandled(exceptions, exception) 
+                    && handledErrorMessages.Any(message => exception.Message.ToLower().Contains(message));
             }
         }
 

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
@@ -46,7 +46,7 @@
 
   <ItemGroup>
     <PackageReference Include="Appium.WebDriver" Version="4.1.1" />
-    <PackageReference Include="Aquality.Selenium.Core" Version="0.3.10" />
+    <PackageReference Include="Aquality.Selenium.Core" Version="1.1.1" />
   </ItemGroup>
 
 </Project>

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.xml

@@ -38,6 +38,6 @@ public AppiumOptions AppiumOptions
             }
         }
 
-        private IDictionary<string, object> Capabilities => settingsFile.GetValueOrNew<Dictionary<string, object>>($"{deviceKey}.capabilities");
+        private IReadOnlyDictionary<string, object> Capabilities => settingsFile.GetValueDictionaryOrEmpty<object>($"{deviceKey}.capabilities");
     }
 }

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Configurations/DeviceSettings.cs

@@ -27,20 +27,20 @@ public DriverSettings(ISettingsFile settingsFile, PlatformName platformName)
 
         private string ApplicationPathJPath => $"{DriverSettingsPath}.{ApplicationPathKey}";
 
-        protected IDictionary<string, object> Capabilities => settingsFile.GetValueOrNew<Dictionary<string, object>>($"{DriverSettingsPath}.capabilities");
+        protected virtual IReadOnlyDictionary<string, object> Capabilities => settingsFile.GetValueDictionaryOrEmpty<object>($"{DriverSettingsPath}.capabilities");
 
         /// <summary>
         /// Defines does the current settings have the application path defined
         /// </summary>
-        protected bool HasApplicationPath => settingsFile.IsValuePresent(ApplicationPathJPath);
+        protected virtual bool HasApplicationPath => settingsFile.IsValuePresent(ApplicationPathJPath) || Capabilities.ContainsKey(AppCapabilityKey);
 
-        public AppiumOptions AppiumOptions
+        public virtual AppiumOptions AppiumOptions
         {
             get
             {
                 var options = new AppiumOptions();
                 Capabilities.ToList().ForEach(capability => options.AddAdditionalCapability(capability.Key, capability.Value));
-                if (HasApplicationPath)
+                if (HasApplicationPath && ApplicationPath != null)
                 {
                     options.AddAdditionalCapability(AppCapabilityKey, ApplicationPath);
                 }
@@ -49,7 +49,15 @@ public AppiumOptions AppiumOptions
             }
         }
 
-        public string ApplicationPath => Path.GetFullPath(settingsFile.GetValue<string>(ApplicationPathJPath));
+        public virtual string ApplicationPath
+        {
+            get
+            {
+                var appValue = settingsFile.GetValueOrDefault(ApplicationPathJPath,
+                    defaultValue: (Capabilities.ContainsKey(AppCapabilityKey) ? Capabilities[AppCapabilityKey] : null)?.ToString());
+                return appValue?.StartsWith(".") == true ? Path.GetFullPath(appValue) : appValue;
+            }
+        }
 
         private AppiumOptions DeviceOptions
         {

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Configurations/DriverSettings.cs

@@ -7,16 +7,16 @@
   "driverSettings": {
     "android": {
       "deviceKey": "<KEY_OF_ANDROID_DEVICE_FROM_DEVICES_JSON>",
-      "applicationPath": "./Resources/Apps/ApiDemos-debug.apk",
       "capabilities": {
+        "app": "./Resources/Apps/ApiDemos-debug.apk",
         "platformName": "Android",
         "automationName": "UiAutomator2"
       }
     },
     "ios": {
       "deviceKey": "<KEY_OF_IOS_DEVICE_FROM_DEVICES_JSON>",
-      "applicationPath": "./Resources/Apps/TestApp.app.zip",
       "capabilities": {
+        "app": "./Resources/Apps/TestApp.app.zip",
         "platformName": "iOS",
         "automationName": "XCUITest"
       }

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Resources/settings.json

@@ -3,29 +3,61 @@
 using Aquality.Selenium.Core.Elements.Interfaces;
 using OpenQA.Selenium;
 using System.Drawing;
+using IElement = Aquality.Appium.Mobile.Elements.Interfaces.IElement;
 using IElementFactory = Aquality.Appium.Mobile.Elements.Interfaces.IElementFactory;
 
 namespace Aquality.Appium.Mobile.Screens
 {
+    /// <summary>
+    /// Defines base class for any mobile screen.
+    /// Use <see cref="ScreenFactory.ScreenTypeAttribute"/> on your screen class to identify platform.
+    /// <seealso cref="ScreenFactory.ScreenFactory"/>
+    /// </summary>
     public abstract class Screen : IScreen
     {
         private readonly ILabel screenLabel;
 
+        /// <summary>
+        /// Constructor with parameters.
+        /// </summary>
+        /// <param name="locator">Unique locator of the screen.</param>
+        /// <param name="name">Name of the screen.</param>
         protected Screen(By locator, string name)
         {
             Locator = locator;
             Name = name;
             screenLabel = ElementFactory.GetLabel(locator, name);
         }
 
+        /// <summary>
+        /// Gets Screen element defined by its locator and name.
+        /// Could be used to find child elements relative to screen element.
+        /// </summary>
+        protected IElement ScreenElement => screenLabel;
+        
+        /// <summary>
+        /// Element factory <see cref="IElementFactory"/>
+        /// </summary>
+        protected static IElementFactory ElementFactory => AqualityServices.ElementFactory;
+        
+        /// <summary>
+        /// Locator of the screen.
+        /// </summary>
         public By Locator { get; }
 
+        /// <summary>
+        /// Name of the screen.
+        /// </summary>
         public string Name { get; }
 
+        /// <summary>
+        /// Gets size of form element defined by its locator.
+        /// </summary>
         public Size Size => screenLabel.GetElement().Size;
 
+        /// <summary>
+        /// Provides ability to get screen's state (whether it is displayed, exists or not) and respective waiting functions.
+        /// </summary>
         public IElementStateProvider State => screenLabel.State;
-
-        protected IElementFactory ElementFactory => AqualityServices.ElementFactory;
     }
 }

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Screens/Screen.cs

@@ -12,7 +12,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
   </ItemGroup>
 
   <ItemGroup>

Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Aquality.Appium.Mobile.Tests.csproj

@@ -7,8 +7,8 @@
   "driverSettings": {
     "android": {
       "deviceKey": "Android_Emulator",
-      "applicationPath": "./Resources/Apps/ApiDemos-debug.apk",
       "capabilities": {
+        "app": "./Resources/Apps/ApiDemos-debug.apk",
         "platformName": "Android",
         "automationName": "UIAutomator2",
         "eventTimings": true,
@@ -17,8 +17,8 @@
     },
     "ios": {
       "deviceKey": "iOS_Simulator",
-      "applicationPath": "./Resources/Apps/TestApp.app.zip",
       "capabilities": {
+        "app": "./Resources/Apps/TestApp.app.zip",
         "platformName": "iOS",
         "automationName": "XCUITest"
       }

Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.json

@@ -21,8 +21,8 @@ protected AndroidScreen(By locator, string name) : base(locator, name)
         protected void StartActivity(string appPackage, string appActivity, bool stopApp = true)
         {
             AqualityServices.LocalizedLogger.Info("loc.application.android.activity.start", appPackage, appActivity);
-            var adnroidAppiumDriver = (AndroidDriver<AppiumWebElement>) AqualityServices.Application.Driver;
-            adnroidAppiumDriver.StartActivity(appPackage, appActivity, stopApp: stopApp);
+            var androidAppiumDriver = (AndroidDriver<AppiumWebElement>) AqualityServices.Application.Driver;
+            androidAppiumDriver.StartActivity(appPackage, appActivity, stopApp: stopApp);
         }
     }
 }