Class PageObject

All Implemented Interfaces:
Direct Known Subclasses:
Action, Artifact, BuildHistory, BuildWithParameters, Changes, ConfigFileProvider, ConfigurablePageObject, DiskUsage, GerritTriggerJob, GerritTriggerNewServer, GerritTriggerServer, JcascManage, JenkinsDatabaseSecurityRealm.Signup, JenkinsLogger, JobConfigHistory.Change, Login, Logout, LogParserOutputPage, ProvidedFile, ScriptApproval, SecurityDisabler, SnippetGenerator, SubversionSvmAdvanced, SvnRepositoryBrowser, WizardCreateAdminUser, WizardCustomizeJenkins, WizardLogin, Workspace

public abstract class PageObject extends CapybaraPortingLayerImpl
Encapsulates a model in Jenkins and wraps interactions with it.

See ...

Most non-trivial page objects should derive from ContainerPageObject.

Kohsuke Kawaguchi
  • Field Details

    • jsonParser

      @Inject protected com.fasterxml.jackson.databind.ObjectMapper jsonParser
    • url

      public final URL url
      Full URL of the object that this page object represents. Ends with '/', like "http://localhost:8080/job/foo/"
      See Also:
  • Constructor Details

    • PageObject

      public PageObject( injector, URL url)
    • PageObject

      protected PageObject(PageObject context, URL url)
  • Method Details

    • createRandomName

      public static String createRandomName()
    • getJenkins

      public Jenkins getJenkins()
    • open

      public org.openqa.selenium.WebDriver open()
      Visits the top page of this object.
    • visit

      public void visit(String relativePath)
      Given the path relative to url, visit that page
    • url

      public URL url(String rel)
      Resolves relative path against url and treats any exception a a fatal problem.
    • url

      public URL url(String format, Object... args)
    • control

      public Control control(String... relativePaths)
      Create a control object that wraps access to the specific INPUT element in this page area.

      The Control object itself can be created early as the actual element resolution happens lazily. This means PageAreaImpl implementations can put these in their fields.

      Several paths can be provided to find the first matching element. Useful when element path changed between versions.

    • control

      public Control control(org.openqa.selenium.By selector)
    • createPageArea

      @NonNull public String createPageArea(String pathPrefix, Runnable action) throws org.openqa.selenium.TimeoutException
      Capture path attribute of newly created form chunk upon invoking action.

      Consider "Add" button in page area with path "/foo" that is supposed to create new page area with path "/foo/bar" or "/foo/bar[n]". There are several problems with the straightforward approach: - Created area may or may not be the first one of its kind so figuring the "path" is nontrivial. - The area may can take a while to render so waiting is needed. - Even after the markup appears, it can take a while for "path" attribute is added.

      This method properly wait until the new path is known. To be used as:

        String barPath = fooArea.createPageArea("/bar", () -> control("add-button").click());
        new FooBarArea(fooArea, barPath);
      pathPrefix - Prefix of the expected path. The path is always absolute.
      action - An action that triggers the page area creation. Clicking the button, etc.
      The surrounding path of the area, exception thrown when not able to find out.
    • toString

      public String toString()
      toString in class Object
    • getContext

      protected PageObject getContext()