feat: add events endpoint calls (#913)

* add initial new command names

* add methods

* add brief docs

* fix spaces

* fix spaces

* revert tests

* remove extra new line

* add test

* Update EventsTests.cs

Author: KazuCocoa

src/Appium.Net/Appium/AppiumCommand.cs

@@ -147,7 +147,7 @@ public class AppiumCommand
                 "/session/{sessionId}/appium/device/finger_print"),
 
             #endregion Driver Commands
-            
+
 
             // Enable W3C Actions on AppiumWebDriver
 
@@ -211,13 +211,24 @@ public class AppiumCommand
 
             #endregion
 
+            #region Logs
+
             new AppiumCommand(HttpCommandInfo.GetCommand, DriverCommand.GetAvailableLogTypes,
                 "session/{sessionId}/log/types"),
-            new AppiumCommand(HttpCommandInfo.PostCommand, DriverCommand.GetLog, "session/{sessionId}/log")
+            new AppiumCommand(HttpCommandInfo.PostCommand, DriverCommand.GetLog, "session/{sessionId}/log"),
+
+            #endregion
+
+            #region Event logs
+
+            new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.GetEvents, "session/{sessionId}/appium/events"),
+            new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.LogEvent, "session/{sessionId}/appium/log_event")
+
+            #endregion
         };
 
         /// <summary>
-        /// This method adds Appium-specific commands to the given 
+        /// This method adds Appium-specific commands to the given
         /// CommandInfoRepository
         /// </summary>
         /// <param name="repo">is a CommandInfoRepository instance which is used</param>
@@ -234,12 +245,12 @@ internal static ICommandExecutor Merge(ICommandExecutor repo)
         }
 
         /// <summary>
-        /// command type 
+        /// command type
         /// </summary>
         internal readonly string CommandType;
 
         /// <summary>
-        /// Command 
+        /// Command
         /// </summary>
         internal readonly string CommandName;
 

src/Appium.Net/Appium/AppiumDriver.cs

@@ -148,7 +148,7 @@ public void RemoveApp(string appId) =>
 
         public void ActivateApp(string appId) =>
             Execute(AppiumDriverCommand.ActivateApp, AppiumCommandExecutionHelper.PrepareArgument("appId", appId));
-        
+
         public void ActivateApp(string appId, TimeSpan timeout) =>
             Execute(AppiumDriverCommand.ActivateApp,
                     AppiumCommandExecutionHelper.PrepareArguments(new string[] {"appId", "options"},
@@ -508,7 +508,7 @@ public FeaturesMatchingResult MatchImageFeatures(string base64Image1, string bas
         }
 
         /// <summary>
-        /// Performs images matching by template to find possible occurrence of 
+        /// Performs images matching by template to find possible occurrence of
         /// the partial image in the full image with default options. Read
         /// https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html
         /// for more details on this topic.
@@ -567,6 +567,47 @@ public SimilarityMatchingResult GetImagesSimilarity(string base64Image1, string
 
         #endregion Compare Images
 
+        #region Event logs
+
+        /// <summary>
+        /// Retrieves events information from the current session.
+        /// See https://appium.io/docs/en/latest/guides/event-timing/ also.
+        /// </summary>
+        /// <param name="type">key name to filter with. It can be empty, string or an array of keys. </param>
+        /// <returns>A dictionary of events timing information containing the following entries</returns>
+        public Dictionary<string, object> GetEvents(string type)
+        {
+            return this.GetEvents([type]);
+        }
+
+        public Dictionary<string, object> GetEvents(string[] type = null)
+        {
+            Dictionary<string, object> parameters = new Dictionary<string, object>();
+            if (type != null)
+            {
+                parameters.Add("type", type);
+            }
+            return (Dictionary<string, object>)Execute(AppiumDriverCommand.GetEvents, parameters).Value;
+        }
+
+        /// <summary>
+        /// Log a custom event on the Appium server.
+        /// See https://appium.io/docs/en/latest/guides/event-timing/ also.
+        /// </summary>
+        /// <param name="vendorName">The vendor to log. </param>
+        /// <param name="eventName">The event to log. </param>
+        public void LogEvent(string vendorName, string eventName)
+        {
+            Dictionary<string, object> parameters = new Dictionary<string, object>
+            {
+                { "vendor", vendorName },
+                { "event", eventName }
+            };
+            Execute(AppiumDriverCommand.LogEvent, parameters);
+        }
+
+        #endregion Event logs
+
         #endregion Public Methods
 
         #region Support methods

src/Appium.Net/Appium/AppiumDriverCommand.cs

@@ -313,5 +313,19 @@ public class AppiumDriverCommand
         public const string CompareImages = "compareImages";
 
         #endregion
+
+        #region Event logs
+
+        /// <summary>
+        /// Represents the GetEvents command
+        /// </summary>
+        public static readonly string GetEvents = "getEvents";
+
+        /// <summary>
+        /// Represents the LogEvent command
+        /// </summary>
+        public static readonly string LogEvent = "logEvent";
+
+        #endregion
     }
 }

test/integration/Android/EventsTests.cs

@@ -0,0 +1,63 @@
+using Appium.Net.Integration.Tests.helpers;
+using NUnit.Framework;
+using OpenQA.Selenium.Appium.Android;
+using OpenQA.Selenium.Support.UI;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Appium.Net.Integration.Tests.Android
+{
+    public class EventTests
+    {
+        private AndroidDriver _driver;
+
+        private readonly string _appKey = "androidApiDemos";
+
+        [OneTimeSetUp]
+        public void BeforeAll()
+        {
+            var capabilities = Env.ServerIsRemote()
+                ? Caps.GetAndroidUIAutomatorCaps(Apps.Get(_appKey))
+                : Caps.GetAndroidUIAutomatorCaps(Apps.Get(_appKey));
+            var serverUri = Env.ServerIsRemote() ? AppiumServers.RemoteServerUri : AppiumServers.LocalServiceUri;
+            _driver = new AndroidDriver(serverUri, capabilities, Env.InitTimeoutSec);
+        }
+
+        [Test]
+        public void GetEventsTestCase()
+        {
+            object value;
+            _driver.GetEvents().TryGetValue("commands", out value);
+            Assert.That(value, Is.Not.Null);
+        }
+
+        [Test]
+        public void LogEventTestCase()
+        {
+            object value;
+
+            _driver.GetEvents().TryGetValue("appium:hello", out value);
+            Assert.That(value, Is.Null);
+
+            _driver.LogEvent("appium", "hello");
+
+            _driver.GetEvents().TryGetValue("appium:hello", out value);
+            Assert.That(value, Is.Not.Null);
+        }
+
+        [OneTimeTearDown]
+        public void AfterAll()
+        {
+            if (_driver != null)
+            {
+                _ = _driver.TerminateApp(Apps.GetId(_appKey));
+                _driver?.Quit();
+            }
+            if (!Env.ServerIsRemote())
+            {
+                AppiumServers.StopLocalService();
+            }
+        }
+    }
+}