WebDriverWrapper (site-test 0.3.5-SNAPSHOT API)

java.lang.Object
- us.johnmeyer.sitetest.credentials.WebDriverWrapper

```
public final class WebDriverWrapper
extends Object
```
Provides Selenium WebDriver. Encapsulates driver instantiation, use, and disposal.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WebDriverWrapper.Browser
Enumerates browser options for Browserstack.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebDriverWrapper.Browser` Enumerates browser options for Browserstack.

Field Summary

Fields
Modifier and Type	Field and Description
`private static WebDriverWrapper`	`activeWrapper` The previously instantiated wrapper, to prevent reinstatiation without quit.
`private static String`	`BROWSER_CAPABILITY_KEY` Browserstack capability key.
`private static String`	`BROWSER_DEBUG_FLAG_DESIRED_CAPABILITY_KEY_VALUE` Browserstack/Selenium 'Desired Capabilities' debug flag capaibilty key.
`private static WebDriverWrapper.Browser`	`BROWSER_SELECTION` Browserstack/Selenium browser 'Desired Capabilities' capability key.
`private static String`	`BROWSERSTACK_BUILD_NAME_CAPABILITY_KEY` Browserstack/Selenium build name capability.
`private static String`	`BROWSERSTACK_BUILD_NAME_DESIRED_CAPABILITY_KEY_VALUE` Browserstack/Selenium 'Desired Capabilities' build name capability key.
`private static String`	`BROWSERSTACK_DEBUG_CAPABILITY_KEY` Browserstack/Selenium debug flag capability.
`private String`	`buildName` Build name for Browserstack UI organization.
`private String`	`elementTimeout` Element timeout in seconds.
`private static String`	`REINSTANTIATION_EXCEPTION_CODE` Message if wrapper is re-instantiated with out quitting previous.
`private String`	`systemUrl` System URL.
`private org.openqa.selenium.WebDriver`	`webDriver` Selenium Webdriver.

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`WebDriverWrapper(org.openqa.selenium.WebDriver webDriverParam, String buildNameParam)` Constructs wrapper, stores webDriver reference.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.openqa.selenium.WebElement`	`findElement(org.openqa.selenium.By byParam)` Returns an instance of a Selenium html elmement.
`List<org.openqa.selenium.WebElement>`	`findElements(org.openqa.selenium.By byParam)` Returns list of web page elements, using Selenium.
`void`	`get(String targetUrlString)` Sends remote browser to specified URL.
`String`	`getBodyText()` Retrieve body element from target.
`static String`	`getBrowserCapabilityKey()` Browserstack capability key.
`static String`	`getBrowserDebugFlagDesiredCapabilityKeyValue()` Browserstack/Selenium 'Desired Capabilities' debug flag capaibilty key.
`static WebDriverWrapper.Browser`	`getBrowserSelection()` Browserstack/Selenium browser 'Desired Capabilities' capability key.
`static String`	`getBrowserstackBuildNameCapabilityKey()` Browserstack/Selenium build name capability.
`static String`	`getBrowserstackBuildNameDesiredCapabilityKeyValue()` Browserstack/Selenium 'Desired Capabilities' build name capability key.
`static String`	`getBrowserstackDebugCapabilityKey()` Browserstack/Selenium debug flag capability.
`String`	`getBuildName()` Returns buildname.
`static org.openqa.selenium.remote.DesiredCapabilities`	`getDesiredCapabilities(String browserKeyParam, String debugKeyParam, String buildNameKeyParam, WebDriverWrapper.Browser browserValueParam, String debugValueParam, String buildNameValueParam)` Creates webDriver DesiredCapabilities object.
`String`	`getPageSource()` Retrieve page source from target.
`private static WebDriverWrapper`	`getPreviousWrapper()` Retrieves previously instantiated wrapper that is still active.
`private org.openqa.selenium.WebDriver`	`getWebDriver()` Provides direct access to web driver.
`String`	`getWebDriverToString()` Provides access to active WebDriver toString() method.
`private boolean`	`isBuildName(String buildNameParam)` Returns true if buildname matches.
`boolean`	`isInactive()` Checks if this wrapper is not active due to quit().
`static boolean`	`isInitialized()` Is wrapper initialized?
`static void`	`log(String logEntryParam)` Logs wrapper activity.
`private static org.openqa.selenium.WebDriver`	`newWebDriver(String buildNameParam)` Initializes webdriver.
`static WebDriverWrapper`	`newWebDriverWrapper()` Returns previous wrapper unless previous has been de-initialized.
`static WebDriverWrapper`	`newWebDriverWrapper(String buildNameParam)` Recycles previous wrapper if possible; if it matches existing build name.
`static WebDriverWrapper`	`newWebDriverWrapper(String buildNameParam, org.openqa.selenium.WebDriver webDriverParam)` Uses previous wrapper if possible; matches build name.
`void`	`quit()` Quits webdriver and designates this wrapper as inactive.
`static void`	`setActiveWrapper(WebDriverWrapper wrapperParam)` Stores latest instantiated wrapper.
`String`	`toString()` Returns object state without any secrets.
`void`	`waitSeconds(long secondsParam)` Waits so webdriver can load all elements.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - REINSTANTIATION_EXCEPTION_CODE
```
private static final String REINSTANTIATION_EXCEPTION_CODE
```
    Message if wrapper is re-instantiated with out quitting previous.
    
    See Also:
    
    Constant Field Values
  - BROWSER_CAPABILITY_KEY
```
private static final String BROWSER_CAPABILITY_KEY
```
    Browserstack capability key.
    
    See Also:
    
    Constant Field Values
  - BROWSERSTACK_DEBUG_CAPABILITY_KEY
```
private static final String BROWSERSTACK_DEBUG_CAPABILITY_KEY
```
    Browserstack/Selenium debug flag capability.
    
    See Also:
    
    Constant Field Values
  - BROWSERSTACK_BUILD_NAME_CAPABILITY_KEY
```
private static final String BROWSERSTACK_BUILD_NAME_CAPABILITY_KEY
```
    Browserstack/Selenium build name capability.
    
    See Also:
    
    Constant Field Values
  - BROWSER_SELECTION
```
private static final WebDriverWrapper.Browser BROWSER_SELECTION
```
    Browserstack/Selenium browser 'Desired Capabilities' capability key.
  - BROWSER_DEBUG_FLAG_DESIRED_CAPABILITY_KEY_VALUE
```
private static final String BROWSER_DEBUG_FLAG_DESIRED_CAPABILITY_KEY_VALUE
```
    Browserstack/Selenium 'Desired Capabilities' debug flag capaibilty key.
    
    See Also:
    
    Constant Field Values
  - BROWSERSTACK_BUILD_NAME_DESIRED_CAPABILITY_KEY_VALUE
```
private static final String BROWSERSTACK_BUILD_NAME_DESIRED_CAPABILITY_KEY_VALUE
```
    Browserstack/Selenium 'Desired Capabilities' build name capability key.
    
    See Also:
    
    Constant Field Values
  - activeWrapper
```
private static WebDriverWrapper activeWrapper
```
    The previously instantiated wrapper, to prevent reinstatiation without quit. As this is in a STATIC FIELD it is a global value and represents only the latest wrapper. Null means it's a new run or the driver was quit.
  - buildName
```
private String buildName
```
    Build name for Browserstack UI organization.
  - webDriver
```
private org.openqa.selenium.WebDriver webDriver
```
    Selenium Webdriver.
  - systemUrl
```
private String systemUrl
```
    System URL.
  - elementTimeout
```
private String elementTimeout
```
    Element timeout in seconds.
- Constructor Detail
  - WebDriverWrapper
```
private WebDriverWrapper(org.openqa.selenium.WebDriver webDriverParam,
                         String buildNameParam)
```
    Constructs wrapper, stores webDriver reference.
    
    Parameters:
    
    webDriverParam - web driver to wrap
    
    buildNameParam - name of build to be tracked on Browserstack
- Method Detail
  - isInitialized
```
public static boolean isInitialized()
```
    Is wrapper initialized?
    
    Returns:
    
    true if a WebDriverWrapper is initialized and has not been quit
  - getBrowserCapabilityKey
```
public static String getBrowserCapabilityKey()
```
    Browserstack capability key.
    
    Returns:
    
    the BrowserCapabilityKey
  - getBrowserstackDebugCapabilityKey
```
public static String getBrowserstackDebugCapabilityKey()
```
    Browserstack/Selenium debug flag capability.
    
    Returns:
    
    the BrowserstackDebugCapabilityKey
  - getBrowserstackBuildNameCapabilityKey
```
public static String getBrowserstackBuildNameCapabilityKey()
```
    Browserstack/Selenium build name capability.
    
    Returns:
    
    the BrowserstackBuildNameCapabilityKey
  - getBrowserSelection
```
public static WebDriverWrapper.Browser getBrowserSelection()
```
    Browserstack/Selenium browser 'Desired Capabilities' capability key.
    
    Returns:
    
    the BrowserDesiredCapabilityKey
  - getBrowserDebugFlagDesiredCapabilityKeyValue
```
public static String getBrowserDebugFlagDesiredCapabilityKeyValue()
```
    Browserstack/Selenium 'Desired Capabilities' debug flag capaibilty key.
    
    Returns:
    
    the BrowserDebugFlagDesiredCapabilityKey
  - getBrowserstackBuildNameDesiredCapabilityKeyValue
```
public static String getBrowserstackBuildNameDesiredCapabilityKeyValue()
```
    Browserstack/Selenium 'Desired Capabilities' build name capability key.
    
    Returns:
    
    the BrowserstackBuildNameDesiredCapabilityKey
  - newWebDriverWrapper
```
public static WebDriverWrapper newWebDriverWrapper(String buildNameParam)
```
    Recycles previous wrapper if possible; if it matches existing build name.
    
    Parameters:
    
    buildNameParam - Name of build to use to organize tests on Browserstack
    
    Returns:
    
    Initialized/active Selenium WebDriver wrapper instance
  - newWebDriverWrapper
```
public static WebDriverWrapper newWebDriverWrapper(String buildNameParam,
                                                   org.openqa.selenium.WebDriver webDriverParam)
```
    Uses previous wrapper if possible; matches build name.
    
    Parameters:
    
    webDriverParam - driver to wrap
    
    buildNameParam - Name of build to use to organize tests on Browserstack
    
    Returns:
    
    Initialized/active Selenium WebDriver wrapper instance
  - newWebDriverWrapper
```
public static WebDriverWrapper newWebDriverWrapper()
```
    Returns previous wrapper unless previous has been de-initialized.
    
    Returns:
    
    Initialized/active Selenium WebDriver wrapper instance
  - getDesiredCapabilities
```
public static org.openqa.selenium.remote.DesiredCapabilities getDesiredCapabilities(String browserKeyParam,
                                                                                    String debugKeyParam,
                                                                                    String buildNameKeyParam,
                                                                                    WebDriverWrapper.Browser browserValueParam,
                                                                                    String debugValueParam,
                                                                                    String buildNameValueParam)
```
    Creates webDriver DesiredCapabilities object. Labels represent K and values represent V in KV syntax.
    
    Parameters:
    
    browserKeyParam - label for browser requested field
    
    debugKeyParam - label for debug key field
    
    buildNameKeyParam - label for build name field
    
    browserValueParam - value for browser requested
    
    debugValueParam - value for debug value
    
    buildNameValueParam - value for build name
    
    Returns:
    
    configured desired capabilities object
  - log
```
public static void log(String logEntryParam)
```
    Logs wrapper activity.
    
    Parameters:
    
    logEntryParam - text to log
  - getPreviousWrapper
```
private static WebDriverWrapper getPreviousWrapper()
```
    Retrieves previously instantiated wrapper that is still active.
    
    Returns:
    
    still-active wrapper registered previously, or null if never initialized or if the last one quit.
  - setActiveWrapper
```
public static void setActiveWrapper(WebDriverWrapper wrapperParam)
```
    Stores latest instantiated wrapper.
    
    Parameters:
    
    wrapperParam - reference to wrapper, to be stored
  - newWebDriver
```
private static org.openqa.selenium.WebDriver newWebDriver(String buildNameParam)
```
    Initializes webdriver.
    
    Parameters:
    
    buildNameParam - build name to use
    
    Returns:
    
    unwrapped Selenium driver
  - isBuildName
```
private boolean isBuildName(String buildNameParam)
```
    Returns true if buildname matches.
    
    Parameters:
    
    buildNameParam - build name to check
    
    Returns:
    
    true if that build name is used in this wrapper
  - getBuildName
```
public String getBuildName()
```
    Returns buildname.
    
    Returns:
    
    build name as stored in instance field of this object
  - waitSeconds
```
public void waitSeconds(long secondsParam)
```
    Waits so webdriver can load all elements. Issues of not finding elements immediately after pageLoad require this to be added.
    
    Parameters:
    
    secondsParam - Time (in seconds) to wait before timing out the element search.
  - getPageSource
```
public String getPageSource()
```
    Retrieve page source from target.
    
    Returns:
    
    test of page source from connected site.
  - getBodyText
```
public String getBodyText()
```
    Retrieve body element from target.
    
    Returns:
    
    test of body element from connected site.
  - isInactive
```
public boolean isInactive()
```
    Checks if *this* wrapper is not active due to quit().
    
    Returns:
    
    true if this wrapper was never or is no longer active
  - toString
```
public String toString()
```
    Returns object state without any secrets. Returns class name, build name, webDriver object ID, and obfuscated tester system URL.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    description of state of this wrapper instance.
  - get
```
public void get(String targetUrlString)
```
    Sends remote browser to specified URL.
    
    Parameters:
    
    targetUrlString - URL to load
  - findElement
```
public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By byParam)
```
    Returns an instance of a Selenium html elmement.
    
    Parameters:
    
    byParam - Selenium element locator.
    
    Returns:
    
    A Selenium HTML element instance.
  - findElements
```
public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By byParam)
```
    Returns list of web page elements, using Selenium.
    
    Parameters:
    
    byParam - Selenium element locator.
    
    Returns:
    
    A Selenium HTML element instance.
  - quit
```
public void quit()
```
    Quits webdriver and designates this wrapper as inactive.
  - getWebDriverToString
```
public String getWebDriverToString()
```
    Provides access to active WebDriver toString() method. For test purposes.
    
    Returns:
    
    toString() output from wrapped WebDriver or {code}null{/code} if none active
  - getWebDriver
```
private org.openqa.selenium.WebDriver getWebDriver()
```
    Provides direct access to web driver. This is a transitional method, deprecated at birth.
    
    Returns:
    
    raw Selenium webDriver
    
    Throws:
    
    IllegalStateException - if this instance has not been initialized with a driver.

Class WebDriverWrapper

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REINSTANTIATION_EXCEPTION_CODE

BROWSER_CAPABILITY_KEY

BROWSERSTACK_DEBUG_CAPABILITY_KEY

BROWSERSTACK_BUILD_NAME_CAPABILITY_KEY

BROWSER_SELECTION

BROWSER_DEBUG_FLAG_DESIRED_CAPABILITY_KEY_VALUE

BROWSERSTACK_BUILD_NAME_DESIRED_CAPABILITY_KEY_VALUE

activeWrapper

buildName

webDriver

systemUrl

elementTimeout

Constructor Detail

WebDriverWrapper

Method Detail

isInitialized

getBrowserCapabilityKey

getBrowserstackDebugCapabilityKey

getBrowserstackBuildNameCapabilityKey

getBrowserSelection

getBrowserDebugFlagDesiredCapabilityKeyValue

getBrowserstackBuildNameDesiredCapabilityKeyValue

newWebDriverWrapper

newWebDriverWrapper

newWebDriverWrapper

getDesiredCapabilities

log

getPreviousWrapper

setActiveWrapper

newWebDriver

isBuildName

getBuildName

waitSeconds

getPageSource

getBodyText

isInactive

toString

get

findElement

findElements

quit

getWebDriverToString

getWebDriver