me.alb_i986.selenium.tinafw.domain

Class WebUser<T extends WebUser<?>>

java.lang.Object

me.alb_i986.selenium.tinafw.domain.WebUser<T>

public class WebUser<T extends WebUser<?>>
extends Object

WebUser encapsulates Browser, and has two main behaviors:

• openBrowser(): creates an instance of WebDriver, thus opening a real browser
• doTask(WebTask): performs the given actions against the SUT

A typical use is as follows:

 
 new WebUser()
   .openBrowser()
   .doTasks(
      new XYTask(),
      new YZTask(),
      [..]
   ).closeBrowser()
 ;
 
 

BTW, this is how tests will look like.

Typically the navigation will be performed by tasks. Using browseTo(String) instead is not recommended, and it will probably be deprecated/removed.

A WebUser may have a username and a password. WebUser may be extended in case more information were required (e.g.: a role). Subclasses should just add fields, setters, and getters, and possibly override equals(WebUser).

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
WebUser() Create a WebUser with a closed Browser, and no initial page.
WebUser(Browser browser) Create a WebUser with the given Browser (which may be open or closed) and no initial page.
WebUser(Browser browser, WebPage initialPage) Create a WebUser with the given Browser (which may be open or closed) and the given initial page.

Method Summary

Modifier and Type	Method and Description
T	browseTo(String relativeUrl)
void	closeBrowser() Any method chain ends with this method.
T	doTask(WebTask task) Run the given task (or tasks, if it is a CompositeWebTask), starting from the known current page (which is part of the state of this object).
T	doTasks(WebTask... tasks) Instantiate a CompositeWebTask made up of all of the given tasks, and run it.
boolean	equals(Object o)
boolean	equals(WebUser<?> user)
Browser	getBrowser()
WebPage	getCurrentPage()
String	getPassword()
String	getUsername()
T	openBrowser() Open the browser previously specified with withBrowserType(SupportedBrowser).
T	openBrowser(SupportedBrowser browserType) Open the browser but do not navigate to any page yet.
T	withBrowserType(SupportedBrowser browserType)
T	withPassword(String password)
T	withUsername(String username)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

WebUser

public WebUser()

Create a WebUser with a closed Browser, and no initial page.

WebUser

public WebUser(Browser browser)

Create a WebUser with the given Browser (which may be open or closed) and no initial page.

Parameters:

browser -

WebUser

public WebUser(Browser browser,
               WebPage initialPage)

Create a WebUser with the given Browser (which may be open or closed) and the given initial page.

Parameters:

browser -

initialPage -

Method Detail

openBrowser

public T openBrowser(SupportedBrowser browserType)

Open the browser but do not navigate to any page yet. If the browser was already open, does nothing.

Returns:

this

See Also:

Browser.open(SupportedBrowser)

openBrowser

public T openBrowser()

Open the browser previously specified with withBrowserType(SupportedBrowser).

Returns:

this

Throws:

IllegalStateException - if the browser type has not been specified, i.e. withBrowserType has not been called

See Also:

openBrowser(SupportedBrowser)

closeBrowser

public void closeBrowser()

Any method chain ends with this method.

See Also:

Browser.close()

browseTo

public T browseTo(String relativeUrl)

Parameters:

relativeUrl - a relative URL (relative to WebPage.BASE_URL)

See Also:

Browser.browseTo(String)

doTask

public T doTask(WebTask task)

Run the given task (or tasks, if it is a CompositeWebTask), starting from the known current page (which is part of the state of this object). Finally update the current page with the one the given task visited last.

Parameters:

task -

Returns:

this

See Also:

WebTask.run(WebPage)

doTasks

public T doTasks(WebTask... tasks)

Instantiate a CompositeWebTask made up of all of the given tasks, and run it.

Convenience method for running multiple tasks at once without wrapping them around a CompositeWebTask by hand.

Parameters:

tasks -

Returns:

this

See Also:

doTask(WebTask)

getCurrentPage

public WebPage getCurrentPage()

Returns:

the page that the last performed task was visiting; or the initial page (which may be null), if no tasks have been performed yet.

getUsername

public String getUsername()

withUsername

public T withUsername(String username)

getPassword

public String getPassword()

withPassword

public T withPassword(String password)

withBrowserType

public T withBrowserType(SupportedBrowser browserType)

getBrowser

public Browser getBrowser()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public boolean equals(WebUser<?> user)

Parameters:

user -

Returns:

true if the two users have the same username