Merged PR 583517: Complete unit test for every API endpoint we support on PC Desktop

Create new unit tests for the following API endpoints:
- POST /session/:sessionId/element/active API endpoint
- GET /session/:sessionId/element/:id/equals/:other API endpoint
- GET /session/:sessionId/element/:id/enabled API endpoint
- GET /session/:sessionId/element/:id/location API endpoint
- GET /session/:sessionId/element/:id/location_in_view API endpoint
- GET /session/:sessionId/element/:id/name API endpoint
- GET /session/:sessionId/element/:id/size API endpoint
- GET /session/:sessionId/element/:id/text API endpoint
- POST /session/:sessionId/element/:id/clear API endpoint
- POST /session/:sessionId/element/:id/click API endpoint

Create a new Utility class containing helper functions to create session, get orphaned element etc
Create a new app session base for calculator app with extensive error case scenarios
Rename TouchBase to EdgeBase and group all app session base classes in a folder
Add common ErrorStrings class in CommonTestSettings
Add missing error scenario for various element API endpoint test
Add a helper function in AlarmClockBase to recreate stale element scenario
Optimize unit tests inheriting AlarmClockBase and CalculatorBase to re-use existing sessions

Related work items: #9226712

Author: timotiusmargo

Tests/W3CWebDriver/AlarmClockBase.cs renamed to Tests/W3CWebDriver/AppSessionBase/AlarmClockBase.cs

@@ -29,19 +29,18 @@ public class AlarmClockBase
 
         public static void Setup(TestContext context)
         {
-            // Cleanup leftover objects from previous test if exists
-            TearDown();
-
-            // Launch Alarm Clock
-            DesiredCapabilities appCapabilities = new DesiredCapabilities();
-            appCapabilities.SetCapability("app", CommonTestSettings.AlarmClockAppId);
-            session = new WindowsDriver<WindowsElement>(new Uri(CommonTestSettings.WindowsApplicationDriverUrl), appCapabilities);
-            Assert.IsNotNull(session);
-            Assert.IsNotNull(session.SessionId);
-
-            // Initialize touch screen object
-            touchScreen = new RemoteTouchScreen(session);
-            Assert.IsNotNull(touchScreen);
+            // Launch Alarm Clock if it is not yet launched
+            if (session == null || touchScreen == null || !CurrentWindowIsAlive())
+            {
+                TearDown();
+                session = Utility.CreateNewSession(CommonTestSettings.AlarmClockAppId);
+                Assert.IsNotNull(session);
+                Assert.IsNotNull(session.SessionId);
+
+                // Initialize touch screen object
+                touchScreen = new RemoteTouchScreen(session);
+                Assert.IsNotNull(touchScreen);
+            }
         }
 
         public static void TearDown()
@@ -83,6 +82,27 @@ protected void AddAlarmEntry(string alarmName)
             session.FindElementByAccessibilityId("AlarmSaveButton").Click();
         }
 
+        private static bool CurrentWindowIsAlive()
+        {
+            bool windowIsAlive = false;
+
+            if (session != null)
+            {
+                try
+                {
+                    windowIsAlive = !String.IsNullOrEmpty(session.CurrentWindowHandle) && session.CurrentWindowHandle != "0";
+                    windowIsAlive = true;
+                }
+                catch
+                {
+                    session.Quit();
+                    session = null;
+                }
+            }
+
+            return windowIsAlive;
+        }
+
         protected void DeletePreviouslyCreatedAlarmEntry(string alarmName)
         {
             while (true)
@@ -120,5 +140,15 @@ protected void CreateStopwatchLapEntries(uint numberOfEntry)
             }
             stopwatchPlayPauseButton.Click();
         }
+
+        protected static WindowsElement GetStaleElement()
+        {
+            // Open the add alarm page, locate the cancel button, and click it to get a stale cancel button
+            session.FindElementByAccessibilityId("AddAlarmButton").Click();
+            WindowsElement staleElement = session.FindElementByAccessibilityId("CancelButton");
+            staleElement.Click();
+            System.Threading.Thread.Sleep(1000);
+            return staleElement;
+        }
     }
 }

Tests/W3CWebDriver/AppSessionBase/CalculatorBase.cs

@@ -0,0 +1,91 @@
+//******************************************************************************
+//
+// Copyright (c) 2017 Microsoft Corporation. All rights reserved.
+//
+// This code is licensed under the MIT License (MIT).
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+//******************************************************************************
+
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.Appium.Windows;
+
+namespace W3CWebDriver
+{
+    public class CalculatorBase
+    {
+        protected static WindowsDriver<WindowsElement> session;
+        private static WindowsElement header;
+
+        public static void Setup(TestContext context)
+        {
+            // Launch Calculator if it is not yet launched
+            if (session == null)
+            {
+                session = Utility.CreateNewSession(CommonTestSettings.CalculatorAppId);
+                Assert.IsNotNull(session);
+                Assert.IsNotNull(session.SessionId);
+                header = session.FindElementByAccessibilityId("Header");
+                Assert.IsNotNull(header);
+            }
+
+            // Set focus on the calculator window
+            header.Click();
+
+            // Ensure that calculator is in standard mode
+            if (!header.Text.Equals("Standard"))
+            {
+                session.FindElementByAccessibilityId("NavButton").Click();
+                System.Threading.Thread.Sleep(1000);
+                var splitViewPane = session.FindElementByClassName("SplitViewPane");
+                splitViewPane.FindElementByName("Standard Calculator").Click();
+                System.Threading.Thread.Sleep(1000);
+                Assert.AreEqual("Standard", header.Text);
+            }
+        }
+
+        public static void TearDown()
+        {
+            header = null;
+
+            // Close the application and delete the session
+            if (session != null)
+            {
+                session.Quit();
+                session = null;
+            }
+        }
+
+        protected static WindowsElement GetStaleElement()
+        {
+            session.FindElementByAccessibilityId("ClearMemoryButton").Click();
+            session.FindElementByAccessibilityId("clearButton").Click();
+            session.FindElementByAccessibilityId("memButton").Click();
+
+            try
+            {
+                // Locate the Memory pivot item tab that is displayed in expanded mode
+                session.FindElementByAccessibilityId("MemoryLabel").Click();
+            }
+            catch
+            {
+                // Open the memory flyout when the calculator is in compact mode
+                session.FindElementByAccessibilityId("MemoryButton").Click();
+            }
+
+            System.Threading.Thread.Sleep(1000);
+            WindowsElement staleElement = session.FindElementByAccessibilityId("MemoryListView").FindElementByName("0") as WindowsElement;
+            session.FindElementByAccessibilityId("ClearMemory").Click();
+            header.Click(); // Dismiss memory flyout that could be displayed if calculator is in compact mode
+            System.Threading.Thread.Sleep(1000);
+            return staleElement;
+        }
+    }
+}

Tests/W3CWebDriver/CommonTestSettings.cs renamed to Tests/W3CWebDriver/AppSessionBase/CommonTestSettings.cs

@@ -14,20 +14,26 @@
 //
 //******************************************************************************
 
-using Microsoft.VisualStudio.TestTools.UnitTesting;
-
 namespace W3CWebDriver
 {
-    [TestClass]
     public class CommonTestSettings
     {
         public const string WindowsApplicationDriverUrl = "http://127.0.0.1:4723";
         public const string AlarmClockAppId = "Microsoft.WindowsAlarms_8wekyb3d8bbwe!App";
         public const string CalculatorAppId = "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App";
+        public const string DesktopAppId = "Root";
         public const string EdgeAppId = "Microsoft.MicrosoftEdge_8wekyb3d8bbwe!MicrosoftEdge";
         public const string ExplorerAppId = @"C:\Windows\System32\explorer.exe";
         public const string NotepadAppId = @"C:\Windows\System32\notepad.exe";
         public const string MicrosoftUrl = "www.microsoft.com";
         public const string GitHubUrl = "https://github.com/Microsoft/WinAppDriver";
     }
+
+    public class ErrorStrings
+    {
+        public const string ElementNotVisible = "An element command could not be completed because the element is not pointer- or keyboard interactable.";
+        public const string NoSuchElement = "An element could not be located on the page using the given search parameters.";
+        public const string NoSuchWindow = "Currently selected window has been closed";
+        public const string StaleElementReference = "An element command failed because the referenced element is no longer attached to the DOM.";
+    }
 }

Tests/W3CWebDriver/TouchBase.cs renamed to Tests/W3CWebDriver/AppSessionBase/EdgeBase.cs

@@ -26,7 +26,7 @@
 
 namespace W3CWebDriver
 {
-    public class TouchBase
+    public class EdgeBase
     {
         protected static WindowsDriver<WindowsElement> session;
         protected static RemoteTouchScreen touchScreen;
@@ -39,9 +39,7 @@ public static void Setup(TestContext context)
             TearDown();
 
             // Launch the Edge browser app
-            DesiredCapabilities appCapabilities = new DesiredCapabilities();
-            appCapabilities.SetCapability("app", CommonTestSettings.EdgeAppId);
-            session = new WindowsDriver<WindowsElement>(new Uri(CommonTestSettings.WindowsApplicationDriverUrl), appCapabilities);
+            session = Utility.CreateNewSession(CommonTestSettings.EdgeAppId);
             session.Manage().Timeouts().ImplicitlyWait(TimeSpan.FromSeconds(5));
             Assert.IsNotNull(session);
             Assert.IsNotNull(session.SessionId);

Tests/W3CWebDriver/AppSessionBase/Utility.cs

@@ -0,0 +1,83 @@
+//******************************************************************************
+//
+// Copyright (c) 2017 Microsoft Corporation. All rights reserved.
+//
+// This code is licensed under the MIT License (MIT).
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+//******************************************************************************
+
+using OpenQA.Selenium.Appium.Windows;
+using OpenQA.Selenium.Remote;
+using System;
+
+namespace W3CWebDriver
+{
+    public class Utility
+    {
+        private static WindowsDriver<WindowsElement> orphanedSession;
+        private static WindowsElement orphanedElement;
+
+        ~Utility()
+        {
+            CleanupOrphanedSession();
+        }
+
+        public static WindowsDriver<WindowsElement> CreateNewSession(string appId)
+        {
+            DesiredCapabilities appCapabilities = new DesiredCapabilities();
+            appCapabilities.SetCapability("app", appId);
+            return new WindowsDriver<WindowsElement>(new Uri(CommonTestSettings.WindowsApplicationDriverUrl), appCapabilities);
+        }
+
+        public static WindowsElement GetOrphanedElement()
+        {
+            // Re-initialize orphaned session and element if they are compromised
+            if (orphanedSession == null || orphanedElement == null)
+            {
+                InitializeOrphanedSession();
+            }
+
+            return orphanedElement;
+        }
+
+        public static WindowsDriver<WindowsElement> GetOrphanedSession()
+        {
+            // Re-initialize orphaned session and element if they are compromised
+            if (orphanedSession == null || orphanedElement == null)
+            {
+                InitializeOrphanedSession();
+            }
+
+            return orphanedSession;
+        }
+
+        private static void CleanupOrphanedSession()
+        {
+            orphanedElement = null;
+
+            // Cleanup after the session if exists
+            if (orphanedSession != null)
+            {
+                orphanedSession.Quit();
+                orphanedSession = null;
+            }
+        }
+
+        private static void InitializeOrphanedSession()
+        {
+            // Create new calculator session and close the window to get an orphaned element
+            CleanupOrphanedSession();
+            orphanedSession = CreateNewSession(CommonTestSettings.CalculatorAppId);
+            orphanedElement = orphanedSession.FindElementByAccessibilityId("Header");
+            orphanedSession.Close();
+        }
+    }
+}

Tests/W3CWebDriver/Back.cs

@@ -29,9 +29,7 @@ public class Back
         [TestMethod]
         public void NavigateBackBrowser()
         {
-            DesiredCapabilities appCapabilities = new DesiredCapabilities();
-            appCapabilities.SetCapability("app", CommonTestSettings.EdgeAppId);
-            session = new WindowsDriver<WindowsElement>(new Uri(CommonTestSettings.WindowsApplicationDriverUrl), appCapabilities);
+            session = Utility.CreateNewSession(CommonTestSettings.EdgeAppId);
             Assert.IsNotNull(session);
             System.Threading.Thread.Sleep(3000); // Sleep for 3 seconds
 
@@ -59,9 +57,7 @@ public void NavigateBackBrowser()
         [TestMethod]
         public void NavigateBackModernApp()
         {
-            DesiredCapabilities appCapabilities = new DesiredCapabilities();
-            appCapabilities.SetCapability("app", CommonTestSettings.AlarmClockAppId);
-            session = new WindowsDriver<WindowsElement>(new Uri(CommonTestSettings.WindowsApplicationDriverUrl), appCapabilities);
+            session = Utility.CreateNewSession(CommonTestSettings.AlarmClockAppId);
             Assert.IsNotNull(session);
 
             // Navigate to New Alarm view
@@ -80,9 +76,7 @@ public void NavigateBackModernApp()
         [TestMethod]
         public void NavigateBackSystemApp()
         {
-            DesiredCapabilities appCapabilities = new DesiredCapabilities();
-            appCapabilities.SetCapability("app", CommonTestSettings.ExplorerAppId);
-            session = new WindowsDriver<WindowsElement>(new Uri(CommonTestSettings.WindowsApplicationDriverUrl), appCapabilities);
+            session = Utility.CreateNewSession(CommonTestSettings.ExplorerAppId);
             Assert.IsNotNull(session);
 
             System.Threading.Thread.Sleep(1000); // Sleep for 1 second
@@ -109,24 +103,15 @@ public void NavigateBackSystemApp()
         [TestMethod]
         public void ErrorNavigateBackNoSuchWindow()
         {
-            DesiredCapabilities appCapabilities = new DesiredCapabilities();
-            appCapabilities.SetCapability("app", CommonTestSettings.AlarmClockAppId);
-            session = new WindowsDriver<WindowsElement>(new Uri(CommonTestSettings.WindowsApplicationDriverUrl), appCapabilities);
-            Assert.IsNotNull(session);
-
             try
             {
-                session.Close();
-                session.Navigate().Back();
+                Utility.GetOrphanedSession().Navigate().Back();
                 Assert.Fail("Exception should have been thrown");
             }
             catch (System.InvalidOperationException exception)
             {
-                Assert.AreEqual("Currently selected window has been closed", exception.Message);
+                Assert.AreEqual(ErrorStrings.NoSuchWindow, exception.Message);
             }
-
-            session.Quit();
-            session = null;
         }
     }
 }

Tests/W3CWebDriver/Element.cs

@@ -146,6 +146,20 @@ public void ErrorFindElementByUnsupportedLocatorPartialLinkText()
             Assert.Fail("Exception should have been thrown");
         }
 
+        [TestMethod]
+        public void ErrorFindElementNoSuchWindow()
+        {
+            try
+            {
+                WindowsElement element = Utility.GetOrphanedSession().FindElementByAccessibilityId("An accessibility id") as WindowsElement;
+                Assert.Fail("Exception should have been thrown");
+            }
+            catch (System.InvalidOperationException exception)
+            {
+                Assert.AreEqual(ErrorStrings.NoSuchWindow, exception.Message);
+            }
+        }
+
         [TestMethod]
         public void FindElementByTagName()
         {