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

Using chrome console to test xPath and css selectors

Note: If you are new to java and selenium then start with selenium java training videos .       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 wri

XPath and single quotes

I had tough time dealing with XPath and single quote. Though W3C recommends using ' to escape it but I never got it working, let me know if any of you get through. Came across this blog and found that “concat” could be used in this situation. So original XPath expression is – //meta[@name=’DESCRIPTION’][@content=’Tester’s Test’] This is some thing which certainly fails as single quote in “Tester’s” marks it at end of string and then XPath blows up, next trial was – //meta[@name=’DESCRIPTION’][@content=’Tester''s Test’] This does not work despite w3c recommendation! And then I used concat function and split the string as – concat(‘Tester’,”’”,’s Test’) NOTICE that single quote is kept in double quote while other characters are kept in single quotes. So XPath looks as – //meta[@name=’DESCRIPTION’][@content=concat(‘Tester’,”’”,’s Test’)] And this works charm.

Return only first or last element from webelements collection

Note: If you are new to java and selenium then start with selenium java training videos .     We often come across situation when there are multiple elements on a page and we probably like to exercise only a few of them using selenium webdriver. May be just first and last element. For example on a search result page we may like to click on only first and last link and not all. This is when Iterables API comes handy. (By the way I am assuming that you have already completed watching selenium training videos :)). Once we have collection of web element then we can use Iterables to get only first or last element as following - Consider that we fetch collection of element as - List< WebElement > webElements = getDriver().findElements(By. id ( "htmlID" ));   Now we can get the first web element from this collection as -  WebElement firstElement = Iterables. getFirst (webElements,  getDriver().findElement(By. id ( "defaultElement" )));   Herein second