Issue 9549 (#9557)

* Changes PageFactory from WebDriver to SearchContext

* Updates unit tests

Co-authored-by: Diego Molina <diemol@users.noreply.github.com>

java/client/src/org/openqa/selenium/support/PageFactory.java

@@ -17,6 +17,7 @@
 
 package org.openqa.selenium.support;
 
+import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.support.pagefactory.DefaultElementLocatorFactory;
 import org.openqa.selenium.support.pagefactory.DefaultFieldDecorator;
@@ -51,30 +52,30 @@ public class PageFactory {
    * which takes a WebDriver instance as its only argument or falling back on a no-arg constructor.
    * An exception will be thrown if the class cannot be instantiated.
    *
-   * @param driver           The driver that will be used to look up the elements
+   * @param searchContext    The search context that will be used to look up the elements
    * @param pageClassToProxy A class which will be initialised.
    * @param <T>              Class of the PageObject
    * @return An instantiated instance of the class with WebElement and List&lt;WebElement&gt;
    * fields proxied
    * @see FindBy
    * @see CacheLookup
    */
-  public static <T> T initElements(WebDriver driver, Class<T> pageClassToProxy) {
-    T page = instantiatePage(driver, pageClassToProxy);
-    initElements(driver, page);
+  public static <T> T initElements(SearchContext searchContext, Class<T> pageClassToProxy) {
+    T page = instantiatePage(searchContext, pageClassToProxy);
+    initElements(searchContext, page);
     return page;
   }
 
   /**
-   * As {@link #initElements(WebDriver, Class)} but will only replace the fields of an already
+   * As {@link #initElements(SearchContext, Class)} but will only replace the fields of an already
    * instantiated Page Object.
    *
-   * @param driver The driver that will be used to look up the elements
+   * @param searchContext The driver that will be used to look up the elements
    * @param page   The object with WebElement and List&lt;WebElement&gt; fields that
    *               should be proxied.
    */
-  public static void initElements(WebDriver driver, Object page) {
-    initElements(new DefaultElementLocatorFactory(driver), page);
+  public static void initElements(SearchContext searchContext, Object page) {
+    initElements(new DefaultElementLocatorFactory(searchContext), page);
   }
 
   /**
@@ -119,11 +120,11 @@ private static void proxyFields(FieldDecorator decorator, Object page, Class<?>
     }
   }
 
-  private static <T> T instantiatePage(WebDriver driver, Class<T> pageClassToProxy) {
+  private static <T> T instantiatePage(SearchContext searchContext, Class<T> pageClassToProxy) {
     try {
       try {
         Constructor<T> constructor = pageClassToProxy.getConstructor(WebDriver.class);
-        return constructor.newInstance(driver);
+        return constructor.newInstance(searchContext);
       } catch (NoSuchMethodException e) {
         return pageClassToProxy.getDeclaredConstructor().newInstance();
       }

java/client/test/org/openqa/selenium/support/PageFactoryTest.java

@@ -26,6 +26,7 @@
 import org.junit.experimental.categories.Category;
 import org.mockito.ArgumentMatchers;
 import org.openqa.selenium.NoSuchElementException;
+import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.TimeoutException;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
@@ -41,7 +42,7 @@
 @Category(UnitTests.class)
 public class PageFactoryTest {
 
-  private WebDriver driver;
+  private SearchContext searchContext;
 
   @Test
   public void shouldProxyElementsInAnInstantiatedPage() {
@@ -50,15 +51,15 @@ public void shouldProxyElementsInAnInstantiatedPage() {
     assertThat(page.q).isNull();
     assertThat(page.list).isNull();
 
-    PageFactory.initElements(driver, page);
+    PageFactory.initElements(searchContext, page);
 
     assertThat(page.q).isNotNull();
     assertThat(page.list).isNotNull();
   }
 
   @Test
   public void shouldInsertProxiesForPublicWebElements() {
-    PublicPage page = PageFactory.initElements(driver, PublicPage.class);
+    PublicPage page = PageFactory.initElements(searchContext, PublicPage.class);
 
     assertThat(page.q).isNotNull();
     assertThat(page.list).isNotNull();
@@ -68,7 +69,7 @@ public void shouldInsertProxiesForPublicWebElements() {
   public void shouldProxyElementsFromParentClassesToo() {
     ChildPage page = new ChildPage();
 
-    PageFactory.initElements(driver, page);
+    PageFactory.initElements(searchContext, page);
 
     assertThat(page.q).isNotNull();
     assertThat(page.list).isNotNull();
@@ -77,7 +78,7 @@ public void shouldProxyElementsFromParentClassesToo() {
 
   @Test
   public void shouldProxyRenderedWebElementFields() {
-    PublicPage page = PageFactory.initElements(driver, PublicPage.class);
+    PublicPage page = PageFactory.initElements(searchContext, PublicPage.class);
 
     assertThat(page.rendered).isNotNull();
   }
@@ -86,15 +87,15 @@ public void shouldProxyRenderedWebElementFields() {
   public void shouldProxyPrivateElements() {
     PrivatePage page = new PrivatePage();
 
-    PageFactory.initElements(driver, page);
+    PageFactory.initElements(searchContext, page);
 
     assertThat(page.getField()).isNotNull();
     assertThat(page.getList()).isNotNull();
   }
 
   @Test
   public void shouldUseAConstructorThatTakesAWebDriverAsAnArgument() {
-    driver = mock(WebDriver.class);
+    WebDriver driver = mock(WebDriver.class);
 
     ConstructedPage page = PageFactory.initElements(driver, ConstructedPage.class);
 
@@ -127,7 +128,7 @@ public void triesToDecorateNonWebElements() {
   public void shouldNotDecorateListsOfWebElementsThatAreNotAnnotated() {
     UnmarkedListPage page = new UnmarkedListPage();
 
-    PageFactory.initElements(driver, page);
+    PageFactory.initElements(searchContext, page);
 
     assertThat(page.elements).isNull();
   }
@@ -136,7 +137,7 @@ public void shouldNotDecorateListsOfWebElementsThatAreNotAnnotated() {
   public void shouldNotDecorateListsThatAreTypedButNotWebElementLists() {
     UnmarkedListPage page = new UnmarkedListPage();
 
-    PageFactory.initElements(driver, page);
+    PageFactory.initElements(searchContext, page);
 
     assertThat(page.objects).isNull();
   }
@@ -145,7 +146,7 @@ public void shouldNotDecorateListsThatAreTypedButNotWebElementLists() {
   public void shouldNotDecorateUnTypedLists() {
     UnmarkedListPage page = new UnmarkedListPage();
 
-    PageFactory.initElements(driver, page);
+    PageFactory.initElements(searchContext, page);
 
     assertThat(page.untyped).isNull();
   }
@@ -168,7 +169,7 @@ public void shouldComplainWhenMoreThanOneFindByShortFormAttributeIsSet() {
 
   @Test
   public void shouldNotThrowANoSuchElementExceptionWhenUsedWithAFluentWait() {
-    driver = mock(WebDriver.class);
+    WebDriver driver = mock(WebDriver.class);
     when(driver.findElement(ArgumentMatchers.any())).thenThrow(new NoSuchElementException("because"));
 
     TickingClock clock = new TickingClock();