使用Selenium内置的PageFactory实现页面对象模式

在这一部分中，将通过Selenium的内置PageFactory支持类来介绍Page Object模式的实现。PageFactory提供一种机制来初始化任何声明WebElement或List<WebElement>带有@FindBy注释的字段的Page Object。

由于不可描述的原因，我已经将测试网页打包，需要的请留意文末信息。

页面对象模式的目标是从实际测试中抽象出应用程序页面和功能。页面对象模式提高了代码在测试和固定装置之间的可重用性，但也使代码易于维护。

我们将从将TodoMVC页面建模为Page Object 的项目开始。该对象将表示将在测试中使用的页面API。可以使用接口对API本身进行建模。如果查看以下界面的方法，则会注意到这些方法只是页面上可用的用户功能。用户可以创建待办事项，用户可以重命名待办事项，也可以删除待办事项：

  1. public interface TodoMvc {
  3.     void navigateTo();
  4.     
  5.     void createTodo(String todoName);
  6.     
  7.     void createTodos(String... todoNames);
  8.     
  9.     int getTodosLeft();
  10.     
  11.     boolean todoExists(String todoName);
  12.     
  13.     int getTodoCount();
  14.     
  15.     List<String> getTodos();
  16.     
  17.     void renameTodo(String todoName, String newTodoName);
  18.     
  19.     void removeTodo(String todoName);
  20.     
  21.     void completeTodo(String todoName);
  22.     
  23.     void completeAllTodos();
  24.     
  25.     void showActive();
  26.     
  27.     void showCompleted();
  28.     
  29.     void clearCompleted();
  30. }

上面的接口隐藏了所有实现细节。实际上，它与Selenium WebDriver无关。因此，从理论上讲，我们可以针对不同的设备（例如移动本机应用程序，桌面应用程序和Web应用程序）使用此页面的不同实现。

定义了页面API后，可以直接跳转到创建测试方法。在确认API可用于创建测试之后，再进行页面实现。这种设计模式使测试人员可以专注于应用程序的实际使用，而不必太早掉进细节的坑里。

创建了以下测试：

  1. @ExtendWith(SeleniumExtension.class)
  2. @DisplayName("Managing Todos")
  3. class TodoMvcTests {
  4.  
  5.     private TodoMvc todoMvc;
  6.  
  7.     private final String buyTheMilk = "Buy the milk";
  8.     private final String cleanupTheRoom = "Clean up the room";
  9.     private final String readTheBook = "Read the book";
  10.  
  11.     @BeforeEach
  12.     void beforeEach(ChromeDriver driver) {
  13.         this.todoMvc = null;
  14.         this.todoMvc.navigateTo();
  15.     }
  16.  
  17.     @Test
  18.     @DisplayName("Creates Todo with given name")
  19.     void createsTodo() {
  20.  
  21.         todoMvc.createTodo(buyTheMilk);
  22.  
  23.         assertAll(
  24.                 () -> assertEquals(1, todoMvc.getTodosLeft()),
  25.                 () -> assertTrue(todoMvc.todoExists(buyTheMilk))
  26.         );
  27.     }
  28.  
  29.     @Test
  30.     @DisplayName("Creates Todos all with the same name")
  31.     void createsTodosWithSameName() {
  32.  
  33.         todoMvc.createTodos(buyTheMilk, buyTheMilk, buyTheMilk);
  34.  
  35.         assertEquals(3, todoMvc.getTodosLeft());
  36.  
  37.  
  38.         todoMvc.showActive();
  39.  
  40.         assertEquals(3, todoMvc.getTodoCount());
  41.     }
  42.  
  43.     @Test
  44.     @DisplayName("Edits inline double-clicked Todo")
  45.     void editsTodo() {
  46.  
  47.         todoMvc.createTodos(buyTheMilk, cleanupTheRoom);
  48.  
  49.         todoMvc.renameTodo(buyTheMilk, readTheBook);
  50.  
  51.         assertAll(
  52.                 () -> assertFalse(todoMvc.todoExists(buyTheMilk)),
  53.                 () -> assertTrue(todoMvc.todoExists(readTheBook)),
  54.                 () -> assertTrue(todoMvc.todoExists(cleanupTheRoom))
  55.         );
  56.     }
  57.  
  58.     @Test
  59.     @DisplayName("Removes selected Todo")
  60.     void removesTodo() {
  61.  
  62.         todoMvc.createTodos(buyTheMilk, cleanupTheRoom, readTheBook);
  63.  
  64.         todoMvc.removeTodo(buyTheMilk);
  65.  
  66.         assertAll(
  67.                 () -> assertFalse(todoMvc.todoExists(buyTheMilk)),
  68.                 () -> assertTrue(todoMvc.todoExists(cleanupTheRoom)),
  69.                 () -> assertTrue(todoMvc.todoExists(readTheBook))
  70.         );
  71.     }
  72.  
  73.     @Test
  74.     @DisplayName("Toggles selected Todo as completed")
  75.     void togglesTodoCompleted() {
  76.         todoMvc.createTodos(buyTheMilk, cleanupTheRoom, readTheBook);
  77.  
  78.         todoMvc.completeTodo(buyTheMilk);
  79.         assertEquals(2, todoMvc.getTodosLeft());
  80.  
  81.         todoMvc.showCompleted();
  82.         assertEquals(1, todoMvc.getTodoCount());
  83.  
  84.         todoMvc.showActive();
  85.         assertEquals(2, todoMvc.getTodoCount());
  86.     }
  87.  
  88.     @Test
  89.     @DisplayName("Toggles all Todos as completed")
  90.     void togglesAllTodosCompleted() {
  91.         todoMvc.createTodos(buyTheMilk, cleanupTheRoom, readTheBook);
  92.  
  93.         todoMvc.completeAllTodos();
  94.         assertEquals(0, todoMvc.getTodosLeft());
  95.  
  96.         todoMvc.showCompleted();
  97.         assertEquals(3, todoMvc.getTodoCount());
  98.  
  99.         todoMvc.showActive();
  100.         assertEquals(0, todoMvc.getTodoCount());
  101.     }
  102.  
  103.     @Test
  104.     @DisplayName("Clears all completed Todos")
  105.     void clearsCompletedTodos() {
  106.         todoMvc.createTodos(buyTheMilk, cleanupTheRoom);
  107.         todoMvc.completeAllTodos();
  108.         todoMvc.createTodo(readTheBook);
  109.  
  110.         todoMvc.clearCompleted();
  111.         assertEquals(1, todoMvc.getTodosLeft());
  112.  
  113.         todoMvc.showCompleted();
  114.         assertEquals(0, todoMvc.getTodoCount());
  115.  
  116.         todoMvc.showActive();
  117.         assertEquals(1, todoMvc.getTodoCount());
  118.     }
  119. }

在上述测试类中，我们看到在每次测试之前，ChromeDriver均已@BeforeEach通过Selenium Jupiter扩展名（@ExtendWith(SeleniumExtension.class)）初始化并注入到设置方法中。驱动程序对象将用于初始化页面对象。

页面对象模式很大程度上取决于项目的特征。你可能要经常使用接口，但这不是必需的。你可能要考虑在较低的抽象水平，其中API是暴露的更详细的方法，例如setTodoInput(String value)，clickSubmitButton()。

我们已经有一个接口可以对TodoMVC页面的行为进行建模，并且我们有使用API​​的失败测试。下一步是实际实现页面对象。为此，我们将使用Selenium内置PageFactory类及其实用程序。

PageFactory类简化了页面对象模式的实现。该类提供了一种机制来初始化任何声明WebElement或List<WebElement>带有@FindBy注释的字段的Page Object。PageFactory中提供了支持Page Object模式实现的和其他注释。

下面的TodoMvcPage类实现了我们之前创建的接口。它声明了几个带有@FindBy注解的字段。它还声明一个构造函数，该构造WebDriver函数采用工厂使用的用于初始化字段的参数：

  1. public class TodoMvcPage implements TodoMvc {
  2.  
  3.     private final WebDriver driver;
  4.  
  5.     private static final By byTodoEdit = By.cssSelector("input.edit");
  6.     private static final By byTodoRemove = By.cssSelector("button.destroy");
  7.     private static final By byTodoComplete = By.cssSelector("input.toggle");
  8.  
  9.     @FindBy(className = "new-todo")
  10.     private WebElement newTodoInput;
  11.  
  12.     @FindBy(css = ".todo-count > strong")
  13.     private WebElement todoCount;
  14.  
  15.     @FindBy(css = ".todo-list li")
  16.     private List<WebElement> todos;
  17.  
  18.     @FindBy(className = "toggle-all")
  19.     private WebElement toggleAll;
  20.  
  21.     @FindBy(css = "a[href='#/active']")
  22.     private WebElement showActive;
  23.  
  24.     @FindBy(css = "a[href='#/completed']")
  25.     private WebElement showCompleted;
  26.  
  27.     @FindBy(className = "clear-completed")
  28.     private WebElement clearCompleted;
  29.  
  30.     public TodoMvcPage(WebDriver driver) {
  31.         this.driver = driver;
  32.     }
  33.  
  34.     @Override
  35.     public void navigateTo() {
  36.         driver.get("***");
  37.     }
  38.  
  39.     public void createTodo(String todoName) {
  40.         newTodoInput.sendKeys(todoName + Keys.ENTER);
  41.     }
  42.  
  43.     public void createTodos(String... todoNames) {
  44.         for (String todoName : todoNames) {
  45.             createTodo(todoName);
  46.         }
  47.     }
  48.  
  49.     public int getTodosLeft() {
  50.         return Integer.parseInt(todoCount.getText());
  51.     }
  52.  
  53.     public boolean todoExists(String todoName) {
  54.         return getTodos().stream().anyMatch(todoName::equals);
  55.     }
  56.  
  57.     public int getTodoCount() {
  58.         return todos.size();
  59.     }
  60.  
  61.     public List<String> getTodos() {
  62.         return todos
  63.                 .stream()
  64.                 .map(WebElement::getText)
  65.                 .collect(Collectors.toList());
  66.     }
  67.  
  68.     public void renameTodo(String todoName, String newTodoName) {
  69.         WebElement todoToEdit = getTodoElementByName(todoName);
  70.         doubleClick(todoToEdit);
  71.  
  72.         WebElement todoEditInput = find(byTodoEdit, todoToEdit);
  73.         executeScript("arguments[0].value = ''", todoEditInput);
  74.  
  75.         todoEditInput.sendKeys(newTodoName + Keys.ENTER);
  76.     }
  77.  
  78.     public void removeTodo(String todoName) {
  79.         WebElement todoToRemove = getTodoElementByName(todoName);
  80.         moveToElement(todoToRemove);
  81.         click(byTodoRemove, todoToRemove);
  82.     }
  83.  
  84.     public void completeTodo(String todoName) {
  85.         WebElement todoToComplete = getTodoElementByName(todoName);
  86.         click(byTodoComplete, todoToComplete);
  87.     }
  88.  
  89.     public void completeAllTodos() {
  90.         toggleAll.click();
  91.     }
  92.  
  93.     public void showActive() {
  94.         showActive.click();
  95.     }
  96.  
  97.     public void showCompleted() {
  98.         showCompleted.click();
  99.     }
  100.  
  101.     public void clearCompleted() {
  102.         clearCompleted.click();
  103.     }
  104.  
  105.     private WebElement getTodoElementByName(String todoName) {
  106.         return todos
  107.                 .stream()
  108.                 .filter(el -> todoName.equals(el.getText()))
  109.                 .findFirst()
  110.                 .orElseThrow(() -> new RuntimeException("Todo with name " + todoName + " not found!"));
  111.     }
  112.  
  113.     private WebElement find(By by, SearchContext searchContext) {
  114.         return searchContext.findElement(by);
  115.     }
  116.  
  117.     private void click(By by, SearchContext searchContext) {
  118.         WebElement element = searchContext.findElement(by);
  119.         element.click();
  120.     }
  121.  
  122.     private void moveToElement(WebElement element) {
  123.         new Actions(driver).moveToElement(element).perform();
  124.     }
  125.  
  126.     private void doubleClick(WebElement element) {
  127.         new Actions(driver).doubleClick(element).perform();
  128.     }
  129.  
  130.     private void executeScript(String script, Object... arguments) {
  131.         ((JavascriptExecutor) driver).executeScript(script, arguments);
  132.     }
  133. }

@FindBy不是用于在Page Object中查找元素的唯一注释。也有@FindBys和@FindAll。

@FindBys批注用于标记Page Object上的字段，以指示查找应使用一系列@FindBy标签。在这个例子中，硒将搜索元件与class = “button”是内与元件id = “menu”：

  1. @FindBys({
  2.   @FindBy(id = "menu"),
  3.   @FindBy(className = "button")
  4. })
  5. private WebElement element;

@FindAll批注用于标记Page Object上的字段，以指示查找应使用一系列@FindBy标记。在此示例中，Selenium将搜索带有class = “button” 和的所有元素id = “menu”。不保证元素按文档顺序排列：

  1. FindAll({
  2.   @FindBy(id = "menu"),
  3.   @FindBy(className = "button")
  4. })
  5. private List<WebElement> webElements;

PageFactory提供了几种静态方法来初始化Page Objects。在我们的测试中，在beforeEach()方法中，我们需要初始化TodoMvcPage对象：

  1. @BeforeEach
  2. void beforeEach(ChromeDriver driver) {
  3.     this.todoMvc = PageFactory.initElements(driver, TodoMvcPage.class);
  4.     this.todoMvc.navigateTo();
  5. }

在PageFactory使用反射初始化对象，然后将其初始化所有WebElement或List<WebElement>标有字段@FindBy注释。使用此方法要求Page Object具有单个参数构造函数接受WebDriver对象。

那么元素何时定位？每次访问该字段都会进行查找。例如，当我们执行代码：new TodoInput.sendKeys(todoName + Keys.ENTER);在in createTodo()方法时，实际执行的指令是：driver.findElement(By.className('new-todo')).sendKeys(todoName + Keys.ENTER)。不是在对象初始化期间而是在第一个元素查找期间引发未找到元素的潜在异常。Selenium使用代理模式来实现所描述的行为。

在某些情况下，每次访问带注释的字段时都不需要查找元素。在这种情况下，我们可以使用@CacheLookup注释。在示例中，输入字段在页面上没有更改，因此可以缓存查找结果：

  1. @FindBy(className = "new-todo")
  2. @CacheLookup
  3. private WebElement newTodoInput;

现在是执行测试的时候了。可以从IDE或使用终端来完成：

./gradlew clean test --tests *TodoMvcTests

通过所有测试，构建成功：

  1. > Task :test
  2.  
  3. demos.selenium.todomvc.TodoMvcTests > editsTodo() PASSED
  4.  
  5. demos.selenium.todomvc.TodoMvcTests > togglesTodoCompleted() PASSED
  6.  
  7. demos.selenium.todomvc.TodoMvcTests > createsTodo() PASSED
  8.  
  9. demos.selenium.todomvc.TodoMvcTests > removesTodo() PASSED
  10.  
  11. demos.selenium.todomvc.TodoMvcTests > togglesAllTodosCompleted() PASSED
  12.  
  13. demos.selenium.todomvc.TodoMvcTests > createsTodosWithSameName() PASSED
  14.  
  15. demos.selenium.todomvc.TodoMvcTests > clearsCompletedTodos() PASSED
  16.  
  17. BUILD SUCCESSFUL in 27s
  18. 3 actionable tasks: 3 executed

微信公众号后台回复“测试网页”，获取测试网页下载地址。

  • 郑重声明：文章首发于公众号“FunTester”，禁止第三方（腾讯云除外）转载、发表。

版权声明：本文为FunTester原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/FunTester/p/12190498.html