[#26] Implementing TouchActions

* [#26] Implementing TouchActions
- Adding TouchActions
- Adding ElementTouchActions
- Updating Element
- Adding tests
- Updating Localization Settings
- Updating settings
- Updating project dependencies

Author: n-verbitsky

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Actions/ITouchActions.cs

@@ -0,0 +1,21 @@
+using System.Drawing;
+
+namespace Aquality.Appium.Mobile.Actions
+{
+    public interface ITouchActions
+    {
+        /// <summary>
+        /// Swipes from start point to end point using TouchAction.
+        /// </summary>
+        /// <param name="startPoint">Point on screen to swipe from.</param>
+        /// <param name="endPoint">Point on screen to swipe to.</param>
+        void Swipe(Point startPoint, Point endPoint);
+
+        /// <summary>
+        /// Performs long press action and moves cursor from a start point to an end point imitating the swipe action.
+        /// </summary>
+        /// <param name="startPoint">Point on screen to swipe from.</param>
+        /// <param name="endPoint">Point on screen to swipe to.</param>
+        void SwipeWithLongPress(Point startPoint, Point endPoint);
+    }
+}

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Actions/SwipeDirection.cs

@@ -0,0 +1,10 @@
+namespace Aquality.Appium.Mobile.Actions
+{
+    public enum SwipeDirection
+    {
+        Up,
+        Down,
+        Left,
+        Right
+    }
+}

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Actions/TouchActions.cs

@@ -0,0 +1,53 @@
+using Aquality.Appium.Mobile.Applications;
+using Aquality.Appium.Mobile.Configurations;
+using Aquality.Selenium.Core.Utilities;
+using OpenQA.Selenium.Appium.Interfaces;
+using OpenQA.Selenium.Appium.MultiTouch;
+using System;
+using System.Drawing;
+
+namespace Aquality.Appium.Mobile.Actions
+{
+    public class TouchActions : ITouchActions
+    {
+        public void Swipe(Point startPoint, Point endPoint)
+        {
+            AqualityServices.LocalizedLogger.Info(
+                "loc.action.swipe",
+                startPoint.X,
+                startPoint.Y,
+                endPoint.X,
+                endPoint.Y);
+            PerformTouchAction(
+                touchAction => touchAction
+                    .Press(startPoint.X, startPoint.Y)
+                    .Wait(GetLongSwipeDuration()),
+                endPoint);
+        }
+
+        public void SwipeWithLongPress(Point startPoint, Point endPoint)
+        {
+            AqualityServices.LocalizedLogger.Info(
+               "loc.action.swipeLongPress",
+               startPoint.X,
+               startPoint.Y,
+               endPoint.X,
+               endPoint.Y);
+            PerformTouchAction(touchAction => touchAction.LongPress(startPoint.X, startPoint.Y), endPoint);
+        }
+
+        protected void PerformTouchAction(Func<ITouchAction, ITouchAction> function, Point endPoint)
+        {
+            var actionRetrier = AqualityServices.Get<IElementActionRetrier>();
+            var touchAction = new TouchAction(AqualityServices.Application.Driver);
+            actionRetrier.DoWithRetry(() =>
+                function(touchAction).MoveTo(endPoint.X, endPoint.Y).Release().Perform());
+        }
+
+        private long GetLongSwipeDuration()
+        {
+            var swipeDuration = AqualityServices.Get<ITouchActionsSettings>().SwipeDuration;
+            return Convert.ToInt64(swipeDuration.TotalMilliseconds);
+        }
+    }
+}

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

@@ -1,4 +1,5 @@
-using Aquality.Appium.Mobile.Configurations;
+using Aquality.Appium.Mobile.Actions;
+using Aquality.Appium.Mobile.Configurations;
 using Aquality.Appium.Mobile.Elements.Interfaces;
 using Aquality.Appium.Mobile.Screens.ScreenFactory;
 using Aquality.Selenium.Core.Applications;
@@ -60,11 +61,16 @@ public class AqualityServices : AqualityServices<IMobileApplication>
         /// </summary>
         public static IScreenFactory ScreenFactory => Get<IScreenFactory>();
 
+        /// <summary>
+        /// Gets the the utility used to perform touch actions.
+        /// </summary>
+        public static ITouchActions TouchActions => Get<ITouchActions>();
+
         /// <summary>
         /// Resolves required service from <see cref="ServiceProvider"/>
         /// </summary>
         /// <typeparam name="T">type of required service</typeparam>
-        /// <exception cref="InvalidOperationException">Thrown if there is no service of the required type.</exception> 
+        /// <exception cref="InvalidOperationException">Thrown if there is no service of the required type.</exception>
         /// <returns></returns>
         public static T Get<T>()
         {
@@ -119,15 +125,15 @@ public static IApplicationFactory ApplicationFactory
         /// </summary>
         public static void SetDefaultFactory()
         {
-            ApplicationFactory = ApplicationProfile.IsRemote ? new RemoteApplicationFactory() : (IApplicationFactory) new LocalApplicationFactory();
+            ApplicationFactory = ApplicationProfile.IsRemote ? new RemoteApplicationFactory() : new LocalApplicationFactory() as IApplicationFactory;
         }
 
         private static IServiceProvider ServiceProvider => GetServiceProvider(services => Application, ConfigureServices);
 
         private static Func<IServiceProvider, IMobileApplication> StartApplicationFunction => (services) => ApplicationFactory.Application;
 
         private static IServiceCollection ConfigureServices()
-        {           
+        {
             return ApplicationStartupContainer.Value.ConfigureServices(new ServiceCollection(), serviceProvider => Application);
         }
     }

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

@@ -1,15 +1,16 @@
-using Aquality.Selenium.Core.Applications;
+using Aquality.Appium.Mobile.Actions;
+using Aquality.Appium.Mobile.Configurations;
+using Aquality.Appium.Mobile.Elements;
+using Aquality.Appium.Mobile.Elements.Interfaces;
+using Aquality.Appium.Mobile.Screens.ScreenFactory;
+using Aquality.Selenium.Core.Applications;
 using Aquality.Selenium.Core.Configurations;
-using CoreElementFactory = Aquality.Selenium.Core.Elements.Interfaces.IElementFactory;
-using Microsoft.Extensions.DependencyInjection;
-using System;
 using Aquality.Selenium.Core.Localization;
 using Aquality.Selenium.Core.Logging;
+using Microsoft.Extensions.DependencyInjection;
+using System;
 using System.Reflection;
-using Aquality.Appium.Mobile.Elements.Interfaces;
-using Aquality.Appium.Mobile.Elements;
-using Aquality.Appium.Mobile.Configurations;
-using Aquality.Appium.Mobile.Screens.ScreenFactory;
+using CoreElementFactory = Aquality.Selenium.Core.Elements.Interfaces.IElementFactory;
 
 namespace Aquality.Appium.Mobile.Applications
 {
@@ -25,9 +26,11 @@ public override IServiceCollection ConfigureServices(IServiceCollection services
             base.ConfigureServices(services, applicationProvider, settings);
             services.AddTransient<IElementFactory, ElementFactory>();
             services.AddTransient<CoreElementFactory, ElementFactory>();
-            services.AddSingleton<IApplicationProfile, ApplicationProfile>();            
+            services.AddSingleton<IApplicationProfile, ApplicationProfile>();
             services.AddSingleton<ILocalServiceSettings, LocalServiceSettings>();
+            services.AddSingleton<ITouchActionsSettings, TouchActionsSettings>();
             services.AddSingleton<IScreenFactory, ScreenFactory>();
+            services.AddSingleton<ITouchActions, TouchActions>();
             services.AddSingleton<ILocalizationManager>(serviceProvider => new LocalizationManager(serviceProvider.GetRequiredService<ILoggerConfiguration>(), serviceProvider.GetRequiredService<Logger>(), Assembly.GetExecutingAssembly()));
             services.AddTransient(serviceProvider => AqualityServices.ApplicationFactory);
             services.AddScoped(serviceProvider => applicationProvider(serviceProvider) as IMobileApplication);

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

@@ -0,0 +1,50 @@
+using System;
+
+namespace Aquality.Appium.Mobile.Configurations
+{
+    /// <summary>
+    /// Describes Touch Actions settings.
+    /// </summary>
+    public interface ITouchActionsSettings
+    {
+        /// <summary>
+        /// Gets number of retries to perform swipe.
+        /// </summary>
+        int SwipeRetries { get; }
+
+        /// <summary>
+        /// Gets the number of seconds required to perform a swipe action.
+        /// </summary>
+        TimeSpan SwipeDuration { get; }
+
+        /// <summary>
+        /// Gets the offset coefficient to adjust the start/end point for swipe action relatively to the parallel screen edge.
+        /// Example for swipe down action:
+        /// The offset coefficient is used to calculate start/end point's Y coordinate.
+        /// If offset coefficient == 0.2, then the start point's Y coordinate == screen's length * (1 - 0.2).
+        /// If offset coefficient == 0.2, then the end point's Y coordinate == screen's length * 0.2.
+        /// The vice versa for swipe up action.
+        /// Example for swipe left action:
+        /// The offset coefficient is used to calculate start/end point's X coordinate.
+        /// If offset coefficient == 0.2, then the start point's X coordinate == screen's width * (1 - 0.2).
+        /// If offset coefficient == 0.2, then the end point's X coordinate == screen's width * 0.2.
+        /// The vice versa for swipe right action.
+        /// </summary>
+        double SwipeVerticalOffset { get; }
+
+        /// <summary>
+        /// Gets the offset coefficient to adjust the start/end point for swipe action relatively to the perpendicular screen edge.
+        /// Example for swipe down action:
+        /// The offset coefficient is used to calculate start/end point's X coordinate.
+        /// If offset coefficient == 0.5, then the start point's X coordinate == screen's width * (1 - 0.5).
+        /// If offset coefficient == 0.5, then the end point's X coordinate == screen's width * 0.5.
+        /// The vice versa for swipe up action.
+        /// Example for swipe left action:
+        /// The offset coefficient is used to calculate start/end point's X coordinate.
+        /// If offset coefficient == 0.5, then the start point's Y coordinate == screen's length * (1 - 0.5).
+        /// If offset coefficient == 0.5, then the end point's Y coordinate == screen's length * 0.5.
+        /// The vice versa for swipe right action.
+        /// </summary>
+        double SwipeHorizontalOffset { get; }
+    }
+}

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

@@ -0,0 +1,24 @@
+using Aquality.Selenium.Core.Configurations;
+using System;
+
+namespace Aquality.Appium.Mobile.Configurations
+{
+    public class TouchActionsSettings : ITouchActionsSettings
+    {
+        private readonly ISettingsFile settingsFile;
+        private readonly string swipeSettingsPath = ".touchActions.swipe";
+
+        public TouchActionsSettings(ISettingsFile settingsFile)
+        {
+            this.settingsFile = settingsFile;
+        }
+
+        public int SwipeRetries => settingsFile.GetValue<int>($"{swipeSettingsPath}.retries");
+
+        public TimeSpan SwipeDuration => TimeSpan.FromSeconds(settingsFile.GetValue<long>($"{swipeSettingsPath}.duration"));
+
+        public double SwipeVerticalOffset => settingsFile.GetValue<double>($"{swipeSettingsPath}.verticalOffset");
+
+        public double SwipeHorizontalOffset => settingsFile.GetValue<double>($"{swipeSettingsPath}.horizontalOffset");
+    }
+}

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Elements/Actions/ElementTouchActions.cs

@@ -0,0 +1,103 @@
+using Aquality.Appium.Mobile.Actions;
+using Aquality.Appium.Mobile.Applications;
+using Aquality.Appium.Mobile.Configurations;
+using Aquality.Selenium.Core.Elements.Interfaces;
+using System.ComponentModel;
+using System.Drawing;
+
+namespace Aquality.Appium.Mobile.Elements.Actions
+{
+    public class ElementTouchActions : IElementTouchActions
+    {
+        private readonly IElement element;
+        private readonly ITouchActionsSettings touchActionsSettings = AqualityServices.Get<ITouchActionsSettings>();
+        private readonly Point scrollDownStartPoint;
+        private readonly Point scrollDownEndPoint;
+        private readonly Point swipeLeftStartPoint;
+        private readonly Point swipeLeftEndPoint;
+        private readonly Point scrollUpStartPoint;
+        private readonly Point scrollUpEndPoint;
+        private readonly Point swipeRightStartPoint;
+        private readonly Point swipeRightEndPoint;
+
+        public ElementTouchActions(IElement element)
+        {
+            this.element = element;
+            var horizontalOffset = touchActionsSettings.SwipeHorizontalOffset;
+            var verticalOffset = touchActionsSettings.SwipeVerticalOffset;
+            scrollDownStartPoint = RecalculatePointCoordinates(
+                GetBottomRightCornerPoint(),
+                1 - horizontalOffset,
+                1 - verticalOffset);
+            scrollDownEndPoint = RecalculatePointCoordinates(
+                GetBottomRightCornerPoint(),
+                horizontalOffset,
+                verticalOffset);
+            swipeLeftStartPoint = RecalculatePointCoordinates(
+                GetBottomRightCornerPoint(),
+                1 - verticalOffset,
+                1 - horizontalOffset);
+            swipeLeftEndPoint = RecalculatePointCoordinates(
+                GetBottomRightCornerPoint(),
+                horizontalOffset,
+                verticalOffset);
+            scrollUpStartPoint = scrollDownEndPoint;
+            scrollUpEndPoint = scrollDownStartPoint;
+            swipeRightStartPoint = swipeLeftEndPoint;
+            swipeRightEndPoint = swipeLeftStartPoint;
+        }
+
+        public void Swipe(Point endPoint)
+        {
+            AqualityServices.TouchActions.Swipe(GetElementLocation(), endPoint);
+        }
+
+        public void SwipeWithLongPress(Point endPoint)
+        {
+            AqualityServices.TouchActions.SwipeWithLongPress(GetElementLocation(), endPoint);
+        }
+
+        public void ScrollToElement(SwipeDirection direction)
+        {
+            var numberOfRetries = touchActionsSettings.SwipeRetries;
+            var touchActions = AqualityServices.TouchActions;
+            while (numberOfRetries-- > 0 && !element.State.IsDisplayed)
+            {
+                switch (direction)
+                {
+                    case SwipeDirection.Down:
+                        touchActions.Swipe(scrollDownStartPoint, scrollDownEndPoint);
+                        break;
+                    case SwipeDirection.Up:
+                        touchActions.Swipe(scrollUpStartPoint, scrollUpEndPoint);
+                        break;
+                    case SwipeDirection.Left:
+                        touchActions.Swipe(swipeLeftStartPoint, swipeLeftEndPoint);
+                        break;
+                    case SwipeDirection.Right:
+                        touchActions.Swipe(swipeRightStartPoint, swipeRightEndPoint);
+                        break;
+                    default:
+                        throw new InvalidEnumArgumentException($"'{direction}' direction does not exist");
+                }
+            }
+        }
+
+        private Point GetElementLocation() => element.GetElement().Location;
+
+        private Point RecalculatePointCoordinates(
+            Point point,
+            double horizontalOffset,
+            double verticalOffset)
+        {
+            return new Point((int)(point.X * horizontalOffset),
+                             (int)(point.Y * verticalOffset));
+        }
+
+        private Point GetBottomRightCornerPoint()
+        {
+            var screnSize = AqualityServices.Application.Driver.Manage().Window.Size;
+            return new Point(screnSize.Width, screnSize.Height);
+        }
+    }
+}

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Elements/Actions/IElementTouchActions.cs

@@ -0,0 +1,33 @@
+using Aquality.Appium.Mobile.Actions;
+using System.Drawing;
+
+namespace Aquality.Appium.Mobile.Elements.Actions
+{
+    /// <summary>
+    /// Describes Touch Actions for elements.
+    /// </summary>
+    public interface IElementTouchActions
+    {
+        /// <summary>
+        /// Swipes from element to end point using TouchAction.
+        /// </summary>
+        /// <param name="endPoint"> Point on screen to swipe to.</param>
+        /// <exception cref="OpenQA.Selenium.NoSuchElementException">Thrown if element was not found.</exception>
+        void Swipe(Point endPoint);
+
+        /// <summary>
+        /// Swipes from element to end point using LongPress.
+        /// <param name="endPoint"> Point on screen to swipe to.</param>
+        /// </summary>
+        /// <exception cref="OpenQA.Selenium.NoSuchElementException">Thrown if element was not found.</exception>
+        void SwipeWithLongPress(Point endPoint);
+
+        /// <summary>
+        /// Scrolls current screen in provided direction until element is displayed.
+        /// <param name="direction"> Direction to swipe.</param>
+        /// </summary>
+        /// <exception cref="OpenQA.Selenium.NoSuchElementException">Thrown if element was not found.</exception>
+        /// <exception cref="System.ComponentModel.InvalidEnumArgumentException">Thrown if incorrect swipe direction was provided.</exception>
+        void ScrollToElement(SwipeDirection direction);
+    }
+}

Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Elements/CheckableElement.cs

@@ -28,8 +28,7 @@ protected virtual bool GetState()
                 return string.IsNullOrEmpty(checkedAttribute)
                     ? GetElement().Selected
                     : checkedAttribute == "true";
-
             });
         }
     }
-}
+}