2021-01-02 00:17:27 +01:00
|
|
|
---
|
|
|
|
|
id: pom
|
|
|
|
|
title: "Page Object Models"
|
|
|
|
|
---
|
|
|
|
|
|
2021-01-15 00:01:39 +01:00
|
|
|
Large test suites can be structured to optimize ease of authoring and maintenance. Page object models are one such
|
|
|
|
|
approach to structure your test suite.
|
2020-12-31 03:04:51 +01:00
|
|
|
|
2021-01-02 00:17:27 +01:00
|
|
|
<!-- TOC -->
|
2020-12-31 03:04:51 +01:00
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
2021-01-15 00:01:39 +01:00
|
|
|
A page object represents a part of your web application. An e-commerce web application might have a home page, a
|
|
|
|
|
listings page and a checkout page. Each of them can be represented by page object models.
|
2020-12-31 03:04:51 +01:00
|
|
|
|
2021-01-15 00:01:39 +01:00
|
|
|
Page objects **simplify authoring**. They create a higher-level API which suits your application.
|
|
|
|
|
|
|
|
|
|
Page objects **simplify maintenance**. They capture element selectors in one place and create reusable code to avoid
|
|
|
|
|
repetition.
|
2020-12-31 03:04:51 +01:00
|
|
|
|
|
|
|
|
## Implementation
|
2021-01-15 00:01:39 +01:00
|
|
|
|
2020-12-31 03:04:51 +01:00
|
|
|
Page object models wrap over a Playwright [Page].
|
|
|
|
|
|
|
|
|
|
```js
|
|
|
|
|
// models/Search.js
|
|
|
|
|
class SearchPage {
|
|
|
|
|
constructor(page) {
|
|
|
|
|
this.page = page;
|
|
|
|
|
}
|
|
|
|
|
async navigate() {
|
|
|
|
|
await this.page.goto('https://bing.com');
|
|
|
|
|
}
|
|
|
|
|
async search(text) {
|
|
|
|
|
await this.page.fill('[aria-label="Enter your search term"]', text);
|
2021-01-15 00:01:39 +01:00
|
|
|
await this.page.press('[aria-label="Enter your search term"]', 'Enter');
|
2020-12-31 03:04:51 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
module.exports = { SearchPage };
|
|
|
|
|
```
|
|
|
|
|
|
2021-03-01 18:18:44 +01:00
|
|
|
```java
|
|
|
|
|
// models/SearchPage.java
|
|
|
|
|
package models;
|
|
|
|
|
|
|
|
|
|
import com.microsoft.playwright;
|
|
|
|
|
|
|
|
|
|
public class SearchPage {
|
|
|
|
|
private final Page page;
|
|
|
|
|
|
|
|
|
|
public SearchPage(Page page) {
|
|
|
|
|
this.page = page;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void navigate() {
|
|
|
|
|
page.navigate("https://bing.com");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void search(String text) {
|
|
|
|
|
page.fill("[aria-label='Enter your search term']", text);
|
|
|
|
|
page.press("[aria-label='Enter your search term']", "Enter");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2021-01-15 00:01:39 +01:00
|
|
|
```python async
|
|
|
|
|
# models/search.py
|
|
|
|
|
class SearchPage:
|
|
|
|
|
def __init__(self, page):
|
|
|
|
|
self.page = page
|
|
|
|
|
|
|
|
|
|
async def navigate(self):
|
|
|
|
|
await self.page.goto("https://bing.com")
|
|
|
|
|
|
|
|
|
|
async def search(self, text):
|
|
|
|
|
await self.page.fill('[aria-label="Enter your search term"]', text)
|
|
|
|
|
await self.page.press('[aria-label="Enter your search term"]', "Enter")
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```python sync
|
|
|
|
|
# models/search.py
|
|
|
|
|
class SearchPage:
|
|
|
|
|
def __init__(self, page):
|
|
|
|
|
self.page = page
|
|
|
|
|
|
|
|
|
|
def navigate(self):
|
|
|
|
|
self.page.goto("https://bing.com")
|
|
|
|
|
|
|
|
|
|
def search(self, text):
|
|
|
|
|
self.page.fill('[aria-label="Enter your search term"]', text)
|
|
|
|
|
self.page.press('[aria-label="Enter your search term"]', "Enter")
|
|
|
|
|
```
|
|
|
|
|
|
2020-12-31 03:04:51 +01:00
|
|
|
Page objects can then be used inside a test.
|
|
|
|
|
|
|
|
|
|
```js
|
|
|
|
|
// search.spec.js
|
|
|
|
|
const { SearchPage } = require('./models/Search');
|
|
|
|
|
|
|
|
|
|
// In the test
|
|
|
|
|
const page = await browser.newPage();
|
|
|
|
|
const searchPage = new SearchPage(page);
|
|
|
|
|
await searchPage.navigate();
|
|
|
|
|
await searchPage.search('search query');
|
|
|
|
|
```
|
|
|
|
|
|
2021-03-01 18:18:44 +01:00
|
|
|
```java
|
|
|
|
|
import models.SearchPage;
|
|
|
|
|
import com.microsoft.playwright.*;
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
// In the test
|
|
|
|
|
Page page = browser.newPage();
|
|
|
|
|
SearchPage searchPage = new SearchPage(page);
|
|
|
|
|
searchPage.navigate();
|
|
|
|
|
searchPage.search("search query");
|
|
|
|
|
```
|
|
|
|
|
|
2021-01-15 00:01:39 +01:00
|
|
|
```python async
|
|
|
|
|
# test_search.py
|
|
|
|
|
from models.search import SearchPage
|
|
|
|
|
|
|
|
|
|
# in the test
|
|
|
|
|
page = await browser.new_page()
|
|
|
|
|
search_page = SearchPage(page)
|
|
|
|
|
await search_page.navigate()
|
|
|
|
|
await search_page.search("search query")
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```python sync
|
|
|
|
|
# test_search.py
|
|
|
|
|
from models.search import SearchPage
|
|
|
|
|
|
|
|
|
|
# in the test
|
|
|
|
|
page = browser.new_page()
|
|
|
|
|
search_page = SearchPage(page)
|
|
|
|
|
search_page.navigate()
|
|
|
|
|
search_page.search("search query")
|
|
|
|
|
```
|
|
|
|
|
|
2020-12-31 03:04:51 +01:00
|
|
|
### API reference
|
2021-01-15 00:01:39 +01:00
|
|
|
- [Page]
|