Skip to main content

Is page object returning another page object a bad practice?

I have come across few articles which talk of page object returning another page object being bad practice. The reason cited are following -

  • Tight coupling between page objects and less flexibility
  • Duplication of code as two variant of a method need to be created returning two different page object depending on if operation was valid or not, i.e. -
loginAs‘ and ‘loginAsExpectingError

Let’s see following example of page objects wherein a page object class does not return another page object. For the sake of simplicity, I have consider three page object classes -


  • LoginPage class which lets user login
  • LoggedInUserHomePage class which provides services when user is logged in
  • InvoiceDetailPage class using which user invoice details

A simplified version of classes would be -

public class LoginPage {

  public LoginPage() {
      if(!WebUIDriver.getWebDriver().getTitle().equalsIgnoreCase("login page")) {
          throw new IllegalStateException("Not Login Page");
      }
  }

private TextFieldElement loginTextBox = new TextFieldElement("login text box", Locator.locateById("login"));

private TextFieldElement passwordTextBox = new TextFieldElement("password text box", Locato.locateById("password"));

private ButtonElement submitButton = new ButtonElement("password text box", Locator.locateById("password"));


public void login(User user) {
      loginTextBox.sendKeys(user.getUserName());
      passwordTextBox.sendKeys(user.getPassword());
      submitButton.click();
  }
}

public class LoggedInUserHomePage {

  public LoggedInUserHomePage() {
      if(!WebUIDriver.getWebDriver().getTitle().equalsIgnoreCase("logged in user page")) {
          throw new IllegalStateException("not logged in user page");
      }
  }

  public void getInvoiceDetailsOfOrderNumber(Object orderNumber) {
  }
}

And

public class InvoiceDetailPage {

public InvoiceDetailPage() {
      if(!WebUIDriver.getWebDriver().getTitle().equalsIgnoreCase("invoice detail page")) {
          throw new IllegalStateException("Not invoice detail Page");
      }
  }

public BigDecimal getOrderAmount(Object orderNumber) {
      return orderAmount;
  }
}


A test method may look as -

@Test
public void shouldDisplayOrderAmountOfGivenOrderNumber() {
  int orderNumber = 12345;
  BigDecimal expectedOrderAmount = new BigDecimal(50.0);

  LoginPage loginPage = new LoginPage();
  loginPage.login(new User());

LoggedInUserHomePage loggedInUserHomePage = new LoggedInUserHomePage();
  loggedInUserHomePage.getInvoiceDetailsOfOrderNumber(orderNumber);

  InvoiceDetailPage invoiceDetailPage = new InvoiceDetailPage();
  BigDecimal orderAmount = invoiceDetailPage.getOrderAmount(orderNumber);

  assertThat("Wrong order amount", orderAmount, is(expectedOrderAmount));
}


Notice that how each page object class had to be instantiated each time before being able to use the corresponding page object. That’s because none of our page object method return a page object.
Now let’s consider the old page object approach wherein each page object method return object of another page if it brings control on it. In this case test method would looks as -


@Test
public void shouldDisplayOrderAmountOfGivenOrderNumber() {
  int orderNumber = 12345;
  BigDecimal expectedOrderAmount = new BigDecimal(50.0);

  BigDecimal orderAmount = new LoginPage()
                              .login(new User())
                              .getInvoiceDetailsOfOrderNumber(orderNumber)
                              .getOrderAmount(orderNumber);
  assertThat("Wrong order amount", orderAmount, is(expectedOrderAmount));
}

You can see how succinct and comprehensible test is when page object method return other objects. This is an example of just three page objects but real world applications have more deep linked pages than this. And the advantages I cited earlier begin to diminish when pages are deep linked. Do you page object methods also return other page objects? What is your opinion about this?

Popular posts from this blog

How can you save resources when instantiaing driver?

I asked on my previous post about what was wrong in instantiating driver on set up method? And here is the solution video on my YouTube channel (After 5 years of gap I finally added new video tutorial :)) The solution described on video tutorial uses following set up - public class BaseClassOnDemandDriverSetup { private WebDriver driver ; @BeforeMethod public void setupTest () { // Any other set up goes here } @AfterMethod public void teardown () { if ( driver != null ) { driver .quit() ; } } public WebDriver getDriver () { if ( driver == null ) { WebDriverManager. chromedriver ().setup() ; driver = new ChromeDriver() ; } return driver ; } }

Using chrome console to test xPath and css selectors

Since the advent of selenium there have been many plugin to test xPath / css selectors but you don’t need any of them if you have chrome browser. Using Chrome console you can test both xPath and css selectors. Launch website to be tested in chrome browser and hit F-12 and you would see chrome console opened in lower pane of application - Hit escape key and console would open another pane to write element locators - And now you can start writing xPath or css selectors in chrome console and test them - The syntax for writing css id - $$(“ ”) And hit the enter key. If your expression is right then html snippet of the application element corresponding to the css selector would be displayed - If you mouse over the html snippet in chrome console then it would highlight the corresponding element in application - If you want to clean console of previously written element selectors then just hit ctrl+L keys and chrome console would be empty again. Pro

Using xPath to reach parent of an element

Well, I am big fan of css locator my self there are times when css locators don't fit requirement. One such requirement is when you want to navigate to parent element of an element and may be parent of parent and even more. Unfortunately css locators don't provide any mechanism to navigate to parent of an element. See this for more. Of late I came across a scenario when I wanted to click on a link depending upon the text in a text box. Herein parent of text box and parent of link were at the same location. More over there could have been many such combinations in application. Fortunately I just need to pick first such instance and Web Driver any way considers only first instance when multiple locators are found matching an element. Element in question is in following html - Here I need to click on highlighted anchor on the basis of input element (which is also highlighted in image) Herein first I need to reach div parent (class = 'left couponmainarea