com.coveros.selenified

Class Selenified

java.lang.Object

com.coveros.selenified.Selenified

public class Selenified
extends Object

Selenified contains all of the elements to setup the test suite, and to start and finish your tests. The site under test should either be set in the @BeforeClass, as there is no default site set for testing. If not, this site can be passed in as a system parameter. Before each suite is run, the system variables are gathered, to set the browser, test site, proxy, hub, etc. This class should be extended by each test class to allow for simple execution of tests. By default each test run will launch a selenium browser, and open the defined test site. If no browser is needed for the test, override the startTest method. Similarly, if you don't want a URL to initially load, override the startTest method.

Version:

3.0.0

Author:

Max Saperstone

Field Summary

Fields

Modifier and Type	Field and Description
protected ThreadLocal<App>	apps
protected ThreadLocal<Browser>	browser
protected static List<Browser>	browsers
protected ThreadLocal<Call>	calls
protected static List<org.openqa.selenium.remote.DesiredCapabilities>	capabilities
protected ThreadLocal<org.openqa.selenium.remote.DesiredCapabilities>	capability
protected static org.openqa.selenium.remote.DesiredCapabilities	extraCapabilities
protected ThreadLocal<OutputFile>	files
protected static String	servicesPass
protected static String	servicesUser

Constructor Summary

Constructors

Constructor and Description
Selenified()

Method Summary

Modifier and Type	Method and Description
protected void	beforeSuite() Runs once before any of the tests run, to parse and setup the static passed information such as browsers, proxy, hub, etc
protected void	endTest(Object[] dataProvider, Method method, org.testng.ITestContext test, org.testng.ITestResult result) After each test is completed, the test is closed out, and the test counter is incremented
protected void	finish() Concludes each test case.
protected void	finish(int errors) Concludes each test case.
protected String	getAuthor(String clazz, org.testng.ITestContext context) Obtains the author of the current test suite being executed.
String	getTestSite(String clazz, org.testng.ITestContext context) Obtains the application under test, as a URL.
protected String	getVersion(String clazz, org.testng.ITestContext context) Obtains the version of the current test suite being executed.
protected static void	setAuthor(Selenified clazz, org.testng.ITestContext context, String author) Sets the author of the current test suite being executed.
protected static void	setTestSite(Selenified clazz, org.testng.ITestContext context, String siteURL) Sets the URL of the application under test.
protected static void	setVersion(Selenified clazz, org.testng.ITestContext context, String version) Sets the version of the current test suite being executed.
protected void	startTest(Object[] dataProvider, Method method, org.testng.ITestContext test, org.testng.ITestResult result) Before any tests run, setup the logging and test details.
protected void	startTest(Object[] dataProvider, Method method, org.testng.ITestContext test, org.testng.ITestResult result, DriverSetup selenium) Gathers all of the testing information, and setup up the logging.

Methods inherited from class java.lang.Object

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

Field Detail

servicesUser

protected static String servicesUser

servicesPass

protected static String servicesPass

extraCapabilities

protected static org.openqa.selenium.remote.DesiredCapabilities extraCapabilities

browsers

protected static List<Browser> browsers

capabilities

protected static List<org.openqa.selenium.remote.DesiredCapabilities> capabilities

browser

protected ThreadLocal<Browser> browser

capability

protected ThreadLocal<org.openqa.selenium.remote.DesiredCapabilities> capability

files

protected ThreadLocal<OutputFile> files

apps

protected ThreadLocal<App> apps

calls

protected ThreadLocal<Call> calls

Constructor Detail

Selenified

public Selenified()

Method Detail

getTestSite

public String getTestSite(String clazz,
                          org.testng.ITestContext context)

Obtains the application under test, as a URL. If the site was provided as a system property, that value will override whatever was set in the particular test suite. If no site was set, null will be returned, which will causes the tests to error out

Parameters:

clazz - - the test suite class, used for making threadsafe storage of application, allowing suites to have independent applications under test, run at the same time

context - - the TestNG context associated with the test suite, used for storing app url information

Returns:

String: the URL of the application under test

setTestSite

protected static void setTestSite(Selenified clazz,
                                  org.testng.ITestContext context,
                                  String siteURL)

Sets the URL of the application under test. If the site was provided as a system property, this method ignores the passed in value, and uses the system property.

Parameters:

clazz - - the test suite class, used for making threadsafe storage of application, allowing suites to have independent applications under test, run at the same time

context - - the TestNG context associated with the test suite, used for storing app url information

siteURL - - the URL of the application under test

getVersion

protected String getVersion(String clazz,
                            org.testng.ITestContext context)

Obtains the version of the current test suite being executed. If no version was set, null will be returned

Parameters:

clazz - - the test suite class, used for making threadsafe storage of application, allowing suites to have independent applications under test, run at the same time

context - - the TestNG context associated with the test suite, used for storing app url information

Returns:

String: the version of the current test being executed

setVersion

protected static void setVersion(Selenified clazz,
                                 org.testng.ITestContext context,
                                 String version)

Sets the version of the current test suite being executed.

Parameters:

clazz - - the test suite class, used for making threadsafe storage of application, allowing suites to have independent applications under test, run at the same time

context - - the TestNG context associated with the test suite, used for storing app url information

version - - the version of the test suite

getAuthor

protected String getAuthor(String clazz,
                           org.testng.ITestContext context)

Obtains the author of the current test suite being executed. If no author was set, null will be returned

Parameters:

clazz - - the test suite class, used for making threadsafe storage of application, allowing suites to have independent applications under test, run at the same time

context - - the TestNG context associated with the test suite, used for storing app url information

Returns:

String: the author of the current test being executed

setAuthor

protected static void setAuthor(Selenified clazz,
                                org.testng.ITestContext context,
                                String author)

Sets the author of the current test suite being executed.

Parameters:

clazz - - the test suite class, used for making threadsafe storage of application, allowing suites to have independent applications under test, run at the same time

context - - the TestNG context associated with the test suite, used for storing app url information

author - - the author of the test suite

beforeSuite

protected void beforeSuite()
                    throws InvalidBrowserException

Runs once before any of the tests run, to parse and setup the static passed information such as browsers, proxy, hub, etc

Throws:

InvalidBrowserException - If a browser that is not one specified in the Selenium.Browser class is used, this exception will be thrown

startTest

protected void startTest(Object[] dataProvider,
                         Method method,
                         org.testng.ITestContext test,
                         org.testng.ITestResult result)

Before any tests run, setup the logging and test details. If a selenium test is being run, it sets up the driver as well

Parameters:

dataProvider - - any objects that are being passed to the tests to loop through as variables

method - - what is the method that is being run. the test name will be extracted from this

test - - was the is context associated with this test suite. suite information will be extracted from this

result - - where are the test results stored. browser information will be kept here

startTest

protected void startTest(Object[] dataProvider,
                         Method method,
                         org.testng.ITestContext test,
                         org.testng.ITestResult result,
                         DriverSetup selenium)

Gathers all of the testing information, and setup up the logging. If a selenium test is running, also sets up the webdriver object

Parameters:

dataProvider - - any objects that are being passed to the tests to loop through as variables

method - - what is the method that is being run. the test name will be extracted from this

test - - was the is context associated with this test suite. suite information will be extracted from this

result - - where are the test results stored. browser information will be kept here

selenium - - is this a selenium test. if so, the webdriver content will be setup

endTest

protected void endTest(Object[] dataProvider,
                       Method method,
                       org.testng.ITestContext test,
                       org.testng.ITestResult result)

After each test is completed, the test is closed out, and the test counter is incremented

Parameters:

dataProvider - - any objects that are being passed to the tests to loop through as variables

method - - what is the method that is being run. the test name will be extracted from this

test - - was the is context associated with this test suite. suite information will be extracted from this

result - - where are the test results stored. browser information will be kept here

finish

protected void finish()

Concludes each test case. This should be run as the last time of each @Test. It will close out the output logging file, and count any errors that were encountered during the test, and fail the test if any errors were encountered

finish

protected void finish(int errors)

Concludes each test case. This should be run as the last time of each @Test. It will close out the output logging file, and count any errors that were encountered during the test, and assert that the number of errors that occurred equals the provided number of errors.

Parameters:

errors - - number of expected errors from the test