us.johnmeyer.sitetest.core

Class Controller

java.lang.Object

us.johnmeyer.sitetest.core.Controller

public final class Controller
extends Object

Provides core functionality for performing site test via Selenium/Browserstack. Stores test parameters collected prior to running the test. This is a class to embed within specific tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Controller.Builder Enables construction of a Controller instance via a multi-step process.

Field Summary

Fields

Modifier and Type	Field and Description
private String	additionalArgsDescription Additional command line arguments for custom test.
private ResultBuilder	resultBuilder Accumulates all information relevant to test.
private WebDriverWrapper	systemUnderTestWebDriverWrapper Selenium WebDriver wrapper.
private UrlWrapper	targetUrl Variable to hold target URL.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Controller(UrlWrapper targetUrlParam, WebDriverWrapper systemParam) Private constructor for factory usage.

Method Summary

Modifier and Type	Method and Description
static String	getBaseCommandLineParameters() Returns base command line parameters.
String	getBuildName() Provides build name.
UrlWrapper	getTargetUrl() Provides the URL that the test is to target.
String	getTargetUrlString() Provides URL in string form.
ResultBuilder	getTestResultBuilder() Returns ResultBuilder.
static String	getUrlParamErrorString() Returns missing URL parameter error string.
WebDriverWrapper	getWebDriverWrapper() Returns Selenium WebDriver.
static Controller.Builder	newTestBuilder() Returns test builder with no data.
static Controller.Builder	newTestBuilder(String[] argsParam) Processeses command line arguments to create test builder.
static Controller.Builder	newTestBuilder(String[] argsParam, String additionalArgsDescripParam) Processeses command line arguments to create test builder, with option of specifying additional controller arguments.
static Controller.Builder	newTestBuilder(UrlWrapper urlParam, String buildNameParam) Returns a test builder instance based on all parameters.
static Controller.Builder	newTestBuilder(UrlWrapper urlParam, WebDriverWrapper driverWrapperParam, String buildNameParam) Returns a test builder instance based on driver wrapper.
static void	printCommandLineParameters(String additionalArgsDescriptionParam) Prints appropriate command line parameters to the the console, including any parameters specific to the test controller.
String	toString() Returns information about the test.

Methods inherited from class java.lang.Object

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

Field Detail

additionalArgsDescription

private String additionalArgsDescription

Additional command line arguments for custom test.

systemUnderTestWebDriverWrapper

private WebDriverWrapper systemUnderTestWebDriverWrapper

Selenium WebDriver wrapper. Webdriver is the intersection of system under test and the test itself, so it needs to be tracked at the test level.

resultBuilder

private ResultBuilder resultBuilder

Accumulates all information relevant to test.

targetUrl

private UrlWrapper targetUrl

Variable to hold target URL.

Constructor Detail

Controller

private Controller(UrlWrapper targetUrlParam,
                   WebDriverWrapper systemParam)

Private constructor for factory usage.

Parameters:

targetUrlParam - URL to test

systemParam - webdriver of system under test

Method Detail

newTestBuilder

public static Controller.Builder newTestBuilder()

Returns test builder with no data.

Returns:

Empty instance.

newTestBuilder

public static Controller.Builder newTestBuilder(String[] argsParam)

Processeses command line arguments to create test builder. Provides validation.

Parameters:

argsParam - command line args from test

Returns:

builder instance populated with command line info.

Throws:

NullPointerException - if no command line args passed

newTestBuilder

public static Controller.Builder newTestBuilder(String[] argsParam,
                                                String additionalArgsDescripParam)

Processeses command line arguments to create test builder, with option of specifying additional controller arguments. Provides validation.

Parameters:

argsParam - command line args

additionalArgsDescripParam - additional args specific to calling test class in format '[arg1] [arg2]... etc.'

Returns:

Instance populated with command line info.

newTestBuilder

public static Controller.Builder newTestBuilder(UrlWrapper urlParam,
                                                String buildNameParam)

Returns a test builder instance based on all parameters.

Parameters:

urlParam - pre-validated URL to test.

buildNameParam - build name that is used by Browserstack to organize test results

Returns:

instance of Controller.Builder.

newTestBuilder

public static Controller.Builder newTestBuilder(UrlWrapper urlParam,
                                                WebDriverWrapper driverWrapperParam,
                                                String buildNameParam)

Returns a test builder instance based on driver wrapper. This is for testing; use instead method that does not accept wrapper.

Parameters:

urlParam - pre-validated URL to test.

driverWrapperParam - initialized webdriver.

buildNameParam - build name that is used by Browserstack to organize test results

Returns:

instance of Controller.Builder.

Throws:

IllegalArgumentException - if the driverWrapper is not initialized to match the provided build name.

NullPointerException - if any input value is null

getUrlParamErrorString

public static String getUrlParamErrorString()

Returns missing URL parameter error string.

Returns:

message to return when no URL param provided

getBaseCommandLineParameters

public static String getBaseCommandLineParameters()

Returns base command line parameters.

Returns:

Command line parameter usage.

printCommandLineParameters

public static void printCommandLineParameters(String additionalArgsDescriptionParam)

Prints appropriate command line parameters to the the console, including any parameters specific to the test controller.

Parameters:

additionalArgsDescriptionParam - Description of any command line parameters beyond first two, e.g., third and beyond.

toString

public String toString()

Returns information about the test.

Overrides:

toString in class Object

getTestResultBuilder

public ResultBuilder getTestResultBuilder()

Returns ResultBuilder.

Returns:

reference to actual result builder for this test.

getWebDriverWrapper

public WebDriverWrapper getWebDriverWrapper()

Returns Selenium WebDriver. Webdriver is specific to the system under test, so it needs to be tracked at the test level.

Returns:

Selenium webdriver of system under test.

getTargetUrl

public UrlWrapper getTargetUrl()

Provides the URL that the test is to target.

Returns:

URL to be tested

getTargetUrlString

public String getTargetUrlString()

Provides URL in string form.

Returns:

URL in String form.

getBuildName

public String getBuildName()

Provides build name.

Returns:

Build name -- to appear on Browserstack.