io.testable.selenium

Class TestableSelenium

java.lang.Object

io.testable.selenium.TestableSelenium

public class TestableSelenium
extends java.lang.Object

Main entry point for creating a selenium driver for use on the Testable platform as well as a set of useful utilities like taking screenshots and reporting custom metrics.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHROME_BINARY_PATH
static java.lang.String	FIREFOX_BINARY_PATH
static java.lang.String	GLOBAL_CLIENT_INDEX
static java.lang.String	ITERATION
static java.lang.String	OUTPUT_DIR
static java.lang.String	PROFILE_DIR
static java.lang.String	PROXY_AUTOCONFIG_URL
static java.lang.String	REGION_NAME
static java.lang.String	RESULT_FILE
static int	SELENIUM_PORT

Constructor Summary

Constructors

Constructor and Description
TestableSelenium()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	collectPerformanceMetrics(org.openqa.selenium.WebDriver driver) Collect some useful browser performance metrics by executing some Javascript in the browser.
static void	log(TestableLog.Level level, java.lang.String msg) Log a message into the test results at the chosen level.
static void	log(TestableLog.Level level, java.lang.Throwable cause) Log an exception into the test results at the chosen level.
static org.openqa.selenium.WebDriver	newWebDriver(org.openqa.selenium.Capabilities capabilities) Create a RemoteWebDriver instance that is compatible with Testable.
static TestableCSVReader	readCsv(java.lang.String path) Read data from a CSV uploaded to your scenario.
static void	reportMetric(TestableMetric metric) Report a custom metric into the test results.
static TestableTest	startTest(java.lang.String name) Start a new set of test steps that you want to record and view in the Assertions widget within the Testable test results.
static java.nio.file.Path	takeScreenshot(org.openqa.selenium.WebDriver driver, java.lang.String name) Takes a screenshot of the current browser and copies it to the appropriate output directory to be picked up by the test runner (found at the OUTPUT_DIR system property).

Methods inherited from class java.lang.Object

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

Field Detail

SELENIUM_PORT

public static final int SELENIUM_PORT

OUTPUT_DIR

public static final java.lang.String OUTPUT_DIR

REGION_NAME

public static final java.lang.String REGION_NAME

GLOBAL_CLIENT_INDEX

public static final java.lang.String GLOBAL_CLIENT_INDEX

ITERATION

public static final java.lang.String ITERATION

PROXY_AUTOCONFIG_URL

public static final java.lang.String PROXY_AUTOCONFIG_URL

CHROME_BINARY_PATH

public static final java.lang.String CHROME_BINARY_PATH

FIREFOX_BINARY_PATH

public static final java.lang.String FIREFOX_BINARY_PATH

PROFILE_DIR

public static final java.lang.String PROFILE_DIR

RESULT_FILE

public static final java.lang.String RESULT_FILE

Constructor Detail

TestableSelenium

public TestableSelenium()

Method Detail

newWebDriver

public static org.openqa.selenium.WebDriver newWebDriver(org.openqa.selenium.Capabilities capabilities)

Create a RemoteWebDriver instance that is compatible with Testable. All this means is that the URL will be http://localhost:[port]/wd/hub where [port] is passed from Testable to the Selenium process as the SELENIUM_PORT system property. When run locally outside Testable, the default Selenium port (4444) is used.

Parameters:

capabilities - Capabilities to utilize

Returns:

A WebDriver instance that is compatible with the local Testable Selenium instance.

takeScreenshot

public static java.nio.file.Path takeScreenshot(org.openqa.selenium.WebDriver driver,
                                                java.lang.String name)

Takes a screenshot of the current browser and copies it to the appropriate output directory to be picked up by the test runner (found at the OUTPUT_DIR system property). When run locally the file is not copied but the screenshot is still taken.

Parameters:

driver - The WebDriver instance

name - Name of the file to use. Actual file name when run on Testable will be [region_name]-[virtual_user]-[test_iteration]-[name] so you have context on which region, virtual user, and iteration of the test this image is associated with.

Returns:

The path where the screenshot can be found.

reportMetric

public static void reportMetric(TestableMetric metric)

Report a custom metric into the test results. This can be a counter, timing, or histogram. When run locally the metric will be output to the console. Example:

  TestableSelenium.reportMetric(TestableMetric.newCounterBuilder()
     .withName("My Request Counter")
     .withVal(1)
     .withUnits("requests")
     .build()); 
 

Parameters:

metric -

log

public static void log(TestableLog.Level level,
                       java.lang.String msg)

Log a message into the test results at the chosen level. When run outside Testable logging is simply written to the console. Trace level logging is only available while smoke testing a scenario. Fatal logging will cause your entire test run to stop.

Parameters:

level - The logging level

msg - The message to log.

log

public static void log(TestableLog.Level level,
                       java.lang.Throwable cause)

Log an exception into the test results at the chosen level. The entire stack trace will be logged. When run outside Testable logging is simply written to the console. Trace level logging is only available while smoke testing a scenario. Fatal logging will cause your entire test run to stop.

Parameters:

level - The logging level

cause - The exception to log

collectPerformanceMetrics

public static java.util.Map<java.lang.String,java.lang.Object> collectPerformanceMetrics(org.openqa.selenium.WebDriver driver)

Collect some useful browser performance metrics by executing some Javascript in the browser. Metrics include: page load time, speed index, page requests, page weight, time to first byte, time to first paint, time to first contentful paint, and time to interactive.

Parameters:

driver - The WebDriver instance

readCsv

public static TestableCSVReader readCsv(java.lang.String path)
                                 throws java.io.IOException

Read data from a CSV uploaded to your scenario. TestableCSVReader for more details of the available API. When run locally, the CSV will be loaded from the local classpath.

Parameters:

path - Path to your CSV file. Relative to the classpath or working directory.

Returns:

A TestableCSVReader instance to access the contents of the CSV in various ways.

Throws:

java.io.IOException

startTest

public static TestableTest startTest(java.lang.String name)

Start a new set of test steps that you want to record and view in the Assertions widget within the Testable test results. Allows you to track a series of test steps, whether they pass, any errors that occurred, and the duration of each step.

Parameters:

name - The name of the test.

Returns:

An object that lets you record test steps and their outcome