agido / pageobject   0.3.0

Website GitHub

Page Object Pattern for Scala

Scala versions: 2.12 2.11 2.10

[ ![Build Status] travis-image ] travis [ License license-image ] license [ Dependencies dependencies-image ] dependencies [ ![Coverage Status] coverage-image ] coverage


A Page Object Pattern implementation written in Scala.

PageObject is a free, open-source (Apache Licence v2) extension for test runners implementing the Page Object Pattern. Currently only ScalaTest 3 is supported, but other testing frameworks should be easy to add.

Official Website:

PageObject was initially based on ScalaTest's Selenium Support and has adopted some features of geb.


You can find the Changelog here


Feel free to open an Issue if you think something is missing our you found a bug. Pull Requests are very welcome!

How can PageObject help me?

PageObject will manage all selenium stuff for you, including starting a browser, on linux optionally using VNC.

You just have to write a description of the page you want to test and the test itself.

PageObject Terms

A PageModule represents a part of a Page. Only PageModule's can access the DOM, they should provide a public API used by the tests. A PageModule can contain other PageModules.

A PageObject represents a Page in the Browser. A PageObject can contain PageModules (for example "navigation", "content" and "footer").

Use a PageObjectSuite to interact with the PageObject in your test.

A first example

source can be found here

 * Copyright 2016 agido GmbH
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * See the License for the specific language governing permissions and
 * limitations under the License.
package org.pageobject.examples.readme

import org.pageobject.core.JettySuite.JettyPage
import org.pageobject.examples.ExamplePageObjectSpec

 * The is a PageObjectSuite for the ReadmePage example.
class Readme extends ExamplePageObjectSpec {

   * ReadmePage is a PageObject because JettyPage extends PageObject.
   * JettyPage's will be served by a local jetty server,
   * because of this only a local path is needed.
  case class ReadmePage() extends JettyPage {
    val path: String = "/readme.html"

     * content is a PageModule
    object content extends PageModule {
      // PageModules can access the DOM.
      private val readme = $(id("readme"))

      def readmeText: String = readme.text

    // we assume that the browser is located
    // at the readme page when the page title is "Readme"
    def atChecker(): Boolean = pageTitle == "Readme"

  describe("a small readme page") {
    it("should contain the text 'readme...'") {
      val page = to(ReadmePage())
      assert(page.content.readmeText == "readme...")

ScalaTest Bug

Because of a bug in ScalaTest (See #1) we need to use a patched version. is a current build of ScalaTest 3.0.x, the only difference is that the PR to fix this bug was added. We hope that this PR will be merged into ScalaTest but unfortunately it looks like that pull requests are ignored...

Project Structure

  • core All Test Runner independent files of PageObject
  • examples examples how to use PageObject with ScalaTest 3
  • howto/maven example project how to use pageobject with maven
  • maven maven build configuration, used for internal testing only
  • project sbt build configuration used to build pageobject
  • scalatest Classes needed to use PageObject with ScalaTest 3
  • selenium Selenium Scripts and chrome driver, used for building pageobject
  • jetty base project for unit tests and examples
  • test/maven internal maven project to test maven build
  • test project used to test pageobject against selenium 3
  • travis Scripts used by travis to build and upload PageObject to sonatype
  • vnc A VNC server and control script reference implementation, used for building pageobject

Building PageObject


The followings are recommended for building PageObject: (other versions may work but are currently untested)

Building and Running Tests

This command will build and run the regular tests:

$ sbt test

If you are using Linux and want to run all Browsers inside of VNC Servers, (recommended for both linux developers and linux build/test servers) use this command:

$ travis/

Before first run you need to download VNC and selenium files:

$ travis/