Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit b7faabc

Browse files
authoredFeb 15, 2025··
docs: improve consistency and readability of the guide
1 parent f018924 commit b7faabc

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed
 

Diff for: ‎website_and_docs/content/documentation/test_practices/encouraged/page_object_models.en.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A Page Object only models these as objects within the test code.
1818
This reduces the amount of duplicated code and means that if the UI changes,
1919
the fix needs only to be applied in one place.
2020

21-
Page Object is a Design Pattern that has become popular in test automation for
21+
Page Object Model is a Design Pattern that has become popular in test automation for
2222
enhancing test maintenance and reducing code duplication. A page object is an
2323
object-oriented class that serves as an interface to a page of your AUT. The
2424
tests then use the methods of this page object class whenever they need to
@@ -43,6 +43,7 @@ helpful tips beyond the scope of this user guide. To get you started,
4343
we’ll illustrate page objects with a simple example.
4444

4545
### Examples
46+
4647
First, consider an example, typical of test automation, that does not use a
4748
page object:
4849

@@ -74,7 +75,7 @@ must change.
7475
* The ID-locators would be spread in multiple tests, in all tests that had to
7576
use this login page.
7677

77-
Applying the page object techniques, this example could be rewritten like this
78+
Applying the page object model, this example could be rewritten like this
7879
in the following example of a page object for a Sign-in page.
7980

8081
```java
@@ -183,6 +184,7 @@ there are a few basic rules for getting the desired maintainability of your
183184
test code.
184185

185186
## Assertions in Page Objects
187+
186188
Page objects themselves should never make verifications or assertions. This is
187189
part of your test and should always be within the test’s code, never in a page
188190
object. The page object will contain the representation of the page, and the
@@ -197,6 +199,7 @@ HomePage constructors check that the expected page is available and ready for
197199
requests from the test.
198200

199201
## Page Component Objects
202+
200203
A page object does not necessarily need to represent all the parts of a
201204
page itself. This was [noted by Martin Fowler](https://martinfowler.com/bliki/PageObject.html#footnote-panel-object) in the early days, while first coining the term "panel objects".
202205

@@ -279,7 +282,7 @@ public class ProductsPage extends BasePage {
279282
.stream()
280283
.filter(condition) // Filter by product name or price
281284
.findFirst()
282-
.orElseThrow();
285+
.orElseThrow(() -> new RuntimeException("Product not found")); // Error thrown during actual test run
283286
}
284287
}
285288
```
@@ -347,7 +350,7 @@ public class ProductsTest {
347350
}
348351
```
349352

350-
The page and component are represented by their own objects. Both objects only have methods for the **services** they offer, which matches the real-world application in object-oriented programming.
353+
The page and component are represented by their own objects. Both objects only have methods for the **services** they offer, which matches the real-world application as is the core principle of object-oriented programming. When applications are built, they are not made of a massive page entity. They are built with components contained in a page. Page Component Objects implement the same approach.
351354

352355
You can even
353356
nest component objects inside other component objects for more complex
@@ -356,6 +359,7 @@ components used throughout the site (e.g. a navigation bar), then it
356359
may improve maintainability and reduce code duplication.
357360

358361
## Other Design Patterns Used in Testing
362+
359363
There are other design patterns that also may be used in testing. Discussing all of these is
360364
beyond the scope of this user guide. Here, we merely want to introduce the
361365
concepts to make the reader aware of some of the things that can be done. As
@@ -364,12 +368,11 @@ reader to search for blogs on these topics.
364368

365369
## Implementation Notes
366370

371+
Page Objects can be thought of as facing in two directions simultaneously. Facing toward the developer of a test, they represent the **services** offered by a particular page. Facing away from the developer, they should be the only thing that has a deep knowledge of the structure of the HTML of a page (or part of a page) It's simplest to think of the methods on a Page Object as offering the "services" that a page offers rather than exposing the details and mechanics of the page. As an example, think of the inbox of any web-based email system. Amongst the services it offers are the ability to compose a new email, choose to read a single email, and list the subject lines of the emails in the inbox. How these are implemented shouldn't matter to the test.
367372

368-
PageObjects can be thought of as facing in two directions simultaneously. Facing toward the developer of a test, they represent the **services** offered by a particular page. Facing away from the developer, they should be the only thing that has a deep knowledge of the structure of the HTML of a page (or part of a page) It's simplest to think of the methods on a Page Object as offering the "services" that a page offers rather than exposing the details and mechanics of the page. As an example, think of the inbox of any web-based email system. Amongst the services it offers are the ability to compose a new email, choose to read a single email, and list the subject lines of the emails in the inbox. How these are implemented shouldn't matter to the test.
369-
370-
Because we're encouraging the developer of a test to try and think about the services they're interacting with rather than the implementation, PageObjects should seldom expose the underlying WebDriver instance. To facilitate this, **methods on the PageObject should return other PageObjects**. This means we can effectively model the user's journey through our application. It also means that should the way that pages relate to one another change (like when the login page asks the user to change their password the first time they log into a service when it previously didn't do that), simply changing the appropriate method's signature will cause the tests to fail to compile. Put another way; we can tell which tests would fail without needing to run them when we change the relationship between pages and reflect this in the PageObjects.
373+
Because we're encouraging the developer of a test to try and think about the services they're interacting with rather than the implementation, Page Objects should seldom expose the underlying WebDriver instance. To facilitate this, **methods on the Page Object may return another Page Object, another Page Component Object, or even itself (this)**. This means we can effectively model the user's journey through our application. It also means that should the way that pages relate to one another change (like when the login page asks the user to change their password the first time they log into a service when it previously didn't do that), simply changing the appropriate method's signature will cause the tests to fail to compile. Put another way; we can tell which tests would fail without needing to run them when we change the relationship between pages and reflect this in the Page Objects.
371374

372-
One consequence of this approach is that it may be necessary to model (for example) both a successful and unsuccessful login; or a click could have a different result depending on the app's state. When this happens, it is common to have multiple methods on the PageObject:
375+
One consequence of this approach is that it may be necessary to model (for example) both a successful and unsuccessful login; or a click could have a different result depending on the app's state. When this happens, it is common to have multiple methods on the Page Object:
373376

374377
```java
375378
public class LoginPage {
@@ -387,7 +390,7 @@ public class LoginPage {
387390
}
388391
```
389392

390-
The code presented above shows an important point: the tests, not the PageObjects, should be responsible for making assertions about the state of a page. For example:
393+
The code presented above shows an important point: the tests, not the Page Objects, should be responsible for making assertions about the state of a page. For example:
391394

392395
```java
393396
public void testMessagesAreReadOrUnread() {
@@ -407,17 +410,17 @@ public void testMessagesAreReadOrUnread() {
407410
}
408411
```
409412

410-
Of course, as with every guideline, there are exceptions, and one that is commonly seen with PageObjects is to check that the WebDriver is on the correct page when we instantiate the PageObject. This is done in the example below.
413+
Of course, as with every guideline, there are exceptions, and one that is commonly seen with Page Objects is to check that the WebDriver is on the correct page when we instantiate the Page Object. This is done in the example below.
411414

412-
Finally, a PageObject need not represent an entire page. It may represent a section that appears frequently within a site or page, such as site navigation. The essential principle is that there is only one place in your test suite with knowledge of the structure of the HTML of a particular (part of a) page.
415+
Finally, a Page Object need not represent an entire page and can be composed of Page Object Components. These components may represent a section that appears frequently within a site or page, such as site navigation. The essential principle is that there is only one place in your test suite with knowledge of the structure of the HTML of a particular (part of a) page.
413416

414417
## Summary
415418

416-
* The public methods represent the services that the page offers
417-
* Try not to expose the internals of the page
419+
* The public methods represent the services that the page or component offers
420+
* Try not to expose the internals of the page or component
418421
* Generally don't make assertions
419-
* Methods return other PageObjects
420-
* Need not represent an entire page
422+
* Methods return other Page Objects, Page Component Objects, or optionally themselves (for fluent syntax)
423+
* Need not represent an entire page all the time
421424
* Different results for the same action are modelled as different methods
422425

423426
## Example

0 commit comments

Comments
 (0)
Please sign in to comment.