Fix fetching many elemhandlers (#152)

* Work on being able to dynamically declare the index location in GetElementHandlers

Co-authored-by: Kevin B <Keboo@users.noreply.github.com>

* Update XML summary and make one additional change from PR feedback

---------

Co-authored-by: Curn, Mike <Mike.Curn@avistacorp.com>
Co-authored-by: Kevin B <Keboo@users.noreply.github.com>

Author: 3 people

IntelliTect.TestTools.Selenate.Tests/GetElementHandlersTests.cs

@@ -66,7 +66,7 @@ public void VerifyByXPathDoesNotChangeFormat()
     public void GetElementHandlersWorksWithAllSelectorTypes(string selectorType)
     {
         const string cssIndex = ":nth-of-type";
-        List<By> convertedBys = new();
+        List<By> convertedBys = new(2);
 
         for (int i = 1; i < 3; i++)
         {
@@ -114,6 +114,58 @@ public void GetElementHandlersWorksWithAllSelectorTypes(string selectorType)
         Assert.Single(elementHandlers);
     }
 
+    [Theory]
+    [InlineData("css", "div[id='test']>div", "div[id='test']>div:nth-of-type({index})")]
+    [InlineData("css", "div[id='test']{index}>div", "div[id='test']:nth-of-type({index})>div")]
+    [InlineData("xpath", "//div[@id='test']/div", "//div[@id='test']/div[{index}]")]
+    [InlineData("xpath", "//div[@id='test']{index}/div", "//div[@id='test'][{index}]/div")]
+    public void GetElementHandlersWorksWithAllSelectorTypesTest(string selectorType, string selectorCriteria, string expectedResult)
+    {
+        List<By> convertedBys = new(2);
+
+        for (int i = 1; i < 3; i++)
+        {
+            convertedBys.Add(selectorType switch
+            {
+                "css" => By.CssSelector(expectedResult.Replace("{index}", i.ToString())),
+                "xpath" => By.XPath(expectedResult.Replace("{index}", i.ToString())),
+                _ => throw new ArgumentException($"Please add support for this selector type: {selectorType}")
+            });
+        }
+
+        By by = selectorType switch
+        {
+            "css" => By.CssSelector(selectorCriteria),
+            "xpath" => By.XPath(selectorCriteria),
+            _ => throw new ArgumentException($"Please add support for this selector type: {selectorType}")
+        };
+
+        var mockElement1 = new Mock<IWebElement>();
+        mockElement1.SetupGet(e1 => e1.Text).Returns("Testing1");
+        mockElement1.SetupGet(e1 => e1.Displayed).Returns(true);
+
+        var mockElement2 = new Mock<IWebElement>();
+        mockElement2.SetupGet(e2 => e2.Text).Returns("Testing2");
+        mockElement2.SetupGet(e2 => e2.Displayed).Returns(false);
+
+        var mockDriver = new Mock<IWebDriver>();
+        mockDriver.Setup
+            (f => f.FindElement(convertedBys[0]))
+            .Returns(mockElement1.Object);
+
+        mockDriver.Setup
+            (f => f.FindElement(convertedBys[1]))
+            .Returns(mockElement2.Object);
+
+        ElementsHandler handler = new(mockDriver.Object, By.CssSelector("div#test"));
+        IEnumerable<ElementHandler> elementHandlers = handler
+            .SetTimeout(TimeSpan.FromMilliseconds(20))
+            .GetElementHandlers(by);
+
+        var elementHandler = Assert.Single(elementHandlers);
+        Assert.Equal(convertedBys[0].Criteria, elementHandler.Locator.Criteria);
+    }
+
     [Theory]
     [InlineData("tagname")]
     [InlineData("link")]

IntelliTect.TestTools.Selenate/ElementsHandler.cs

@@ -104,32 +104,43 @@ public bool ContainsText(string text)
         }
 
         /// <summary>
-        /// Returns an ElementHandler as long as a matching DOM item is found, based on XPath or CSS index.
+        /// Returns an ElementHandler as long as a matching DOM item is found, based on XPath or CSS index. <br />
+        /// Note that if your locator does not have '{index}' in it, one will be appended to the end. <br />
+        /// E.G. The locator By.CssSelector("div>div") will become By.CssSelector("div>div:nth-of-type(1)") <br />
+        /// and By.CssSelector("div{index}>div") will become By.CssSelector("div:nth-of-type(1)>div") <br /> <br />
         /// Please ensure at least two elements can be found when attempting to use this method.  <br />
-        /// Respects any timeout set for this ElementsHandler. <br />
+        /// Respects any timeout set for this ElementsHandler. <br /> <br />
         /// NOTE: By.Name locators have not yet been verified to work. Please file an issue if one is encountered: https://github.com/IntelliTect/TestTools.Selenate/issues
         /// </summary>
+        /// <param name="byOverride">Used to override the locator only for this operation. This is primarily used when your regular locator <br />
+        /// is needed for other operations, but you must specify where the indexing call needs to go for this specific operation.</param>
         /// <returns>The enumerable of ElementHandlers that exist at the time of invocation.</returns>
-        public IEnumerable<ElementHandler> GetElementHandlers()
+        public IEnumerable<ElementHandler> GetElementHandlers(By? byOverride = null)
         {
             // DOM elements are 1-based indexes
             int iteration = 1;
-            
+            By locator = byOverride ?? Locator;
+            string locatorCriteria = locator.Criteria;
+            if (!locatorCriteria.Contains("{index}"))
+            {
+                locatorCriteria = $"{locatorCriteria}{{index}}";
+            }
+
             do
             {
                 By by;
-                if (Locator.Mechanism is "css selector")
+                if (locator.Mechanism is "css selector")
                 {
-                    by = By.CssSelector($"{Locator.Criteria}:nth-of-type({iteration})");
+                    by = By.CssSelector(locatorCriteria.Replace("{index}", $":nth-of-type({iteration})"));
                 }
-                else if (Locator.Mechanism is "xpath")
+                else if (locator.Mechanism is "xpath")
                 {
-                    by = By.XPath($"{Locator.Criteria}[{iteration}]");
+                    by = By.XPath(locatorCriteria.Replace("{index}", $"[{iteration}]"));
                 }
                 else
                 {
                     throw new ArgumentException(
-                        $"Invalid selector type, {Locator.Mechanism} for method {nameof(GetElementHandlers)}. Please convert to any selector type other than Partial Link Text, Link Text, or Tag Name.");
+                        $"Invalid selector type, {locator.Mechanism} for method {nameof(GetElementHandlers)}. Please convert to any selector type other than Partial Link Text, Link Text, or Tag Name.");
                 }
 
                 ElementHandler foundHandler = new(WrappedDriver, by);