Adding FindsByAllAttribute to .NET PageFactory implementation

This allows the user to specify that an element must match the criteria of
all of the FindsBy attributes a property or field is marked with in order
to be found by the PageFactory. Previously, a class member marked with
multiple FindsBy attributes would find an element matching any of the
attributes' criteria. Because of the nature of this change, you cannot use
FindsBySequence and FindsByAll on the same class member. Attempting to do
so will result in an exception when InitElements is called.

Author: jimevans

Diff for: dotnet/src/support/PageObjects/FindsByAllAttribute.cs

@@ -0,0 +1,51 @@
+// <copyright file="FindsByAllAttribute.cs" company="WebDriver Committers">
+// Copyright 2015 Software Freedom Conservancy
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace OpenQA.Selenium.Support.PageObjects
+{
+    /// <summary>
+    /// Marks elements to indicate that found elements should match the criteria of
+    /// all <see cref="FindsByAttribute"/> on the field or property.
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// When used with a set of <see cref="FindsByAttribute"/>, all criteria must be
+    /// matched to be returned. The criteria are used in sequence according to the
+    /// Priority property. Note that the behavior when setting multiple
+    /// <see cref="FindsByAttribute"/> Priority properties to the same value, or not
+    /// specifying a Priority value, is undefined.
+    /// </para>
+    /// <para>
+    /// <code>
+    /// // Will find the element with the tag name "input" that also has an ID
+    /// // attribute matching "elementId".
+    /// [FindsByAll]
+    /// [FindsBy(How = How.TagName, Using = "input", Priority = 0)]
+    /// [FindsBy(How = How.Id, Using = "elementId", Priority = 1)]
+    /// public IWebElement thisElement;
+    /// </code>
+    /// </para>
+    /// </remarks>
+    [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
+    public sealed class FindsByAllAttribute : Attribute
+    {
+    }
+}

Diff for: dotnet/src/support/PageObjects/PageFactory.cs

@@ -189,6 +189,14 @@ private static List<By> CreateLocatorList(MemberInfo member)
             var useSequenceAttributes = Attribute.GetCustomAttributes(member, typeof(FindsBySequenceAttribute), true);
             bool useSequence = useSequenceAttributes.Length > 0;
 
+            var useAllAttributes = Attribute.GetCustomAttributes(member, typeof(FindsByAllAttribute), true);
+            bool useAll = useAllAttributes.Length > 0;
+
+            if (useSequence && useAll)
+            {
+                throw new ArgumentException("Cannot specify FindsBySequence and FindsByAll on the same member");
+            }
+
             List<By> bys = new List<By>();
             var attributes = Attribute.GetCustomAttributes(member, typeof(FindsByAttribute), true);
             if (attributes.Length > 0)
@@ -211,6 +219,13 @@ private static List<By> CreateLocatorList(MemberInfo member)
                     bys.Clear();
                     bys.Add(chained);
                 }
+
+                if (useAll)
+                {
+                    ByAll all = new ByAll(bys.ToArray());
+                    bys.Clear();
+                    bys.Add(all);
+                }
             }
 
             return bys;

Diff for: dotnet/src/support/WebDriver.Support.csproj

@@ -82,6 +82,7 @@
     <Compile Include="PageObjects\ByFactory.cs" />
     <Compile Include="PageObjects\CacheLookupAttribute.cs" />
     <Compile Include="PageObjects\ByIdOrName.cs" />
+    <Compile Include="PageObjects\FindsByAllAttribute.cs" />
     <Compile Include="PageObjects\RetryingElementLocatorFactory.cs" />
     <Compile Include="PageObjects\DefaultElementLocatorFactory.cs" />
     <Compile Include="PageObjects\FindsByAttribute.cs" />

Diff for: dotnet/test/support/PageObjects/PageFactoryBrowserTest.cs

@@ -99,6 +99,24 @@ public void ShouldFindElementUsingSequence()
             Assert.AreEqual("I'm a child", page.NestedElement.Text.Trim());
         }
 
+        [Test]
+        public void ShouldFindElementUsingAllFindBys()
+        {
+            driver.Url = xhtmlTestPage;
+            var page = new PageFactoryBrowserTest.Page();
+            PageFactory.InitElements(driver, page);
+            Assert.True(page.ByAllElement.Displayed);
+        }
+
+        [Test]
+        [ExpectedException(typeof(ArgumentException), ExpectedMessage = "Cannot specify FindsBySequence and FindsByAll on the same member", MatchType = MessageMatch.Contains)]
+        public void MixingFindBySequenceAndFindByAllShouldThrow()
+        {
+            driver.Url = xhtmlTestPage;
+            var page = new PageFactoryBrowserTest.InvalidAttributeCombinationPage();
+            PageFactory.InitElements(driver, page);
+        }
+
         #region Page classes for tests
         #pragma warning disable 649 //We set fields through reflection, so expect an always-null warning
 
@@ -111,6 +129,11 @@ private class Page
             [FindsBy(How = How.Id, Using = "parent", Priority = 0)]
             [FindsBy(How = How.Id, Using = "child", Priority = 1)]
             public IWebElement NestedElement;
+
+            [FindsByAll]
+            [FindsBy(How = How.TagName, Using = "form", Priority = 0)]
+            [FindsBy(How = How.Name, Using = "someForm", Priority = 1)]
+            public IWebElement ByAllElement;
         }
 
         private class HoverPage
@@ -125,6 +148,15 @@ private class LinksPage
             public IList<IWebElement> AllLinks;
         }
 
+        private class InvalidAttributeCombinationPage
+        {
+            [FindsByAll]
+            [FindsBySequence]
+            [FindsBy(How = How.Id, Using = "parent", Priority = 0)]
+            [FindsBy(How = How.Id, Using = "child", Priority = 1)]
+            public IWebElement NotFound;
+        }
+
         #pragma warning restore 649
         #endregion
     }