All Classes and Interfaces
Class
Description
Similar to
SmartElementHandler but wraps a concrete WebElement
instead of an ElementLocator.Base class for handlers of non-List members.
Define WebDriver logging levels using the webdriver.logprefs.* properties, e.g.
The Agency keeps track of multiple listeners assigned to different agents (which represent actors or activities), to facilitate parallel execution of test tasks.
An agent is an actor or task that can keep track of events in a separate step listener.
A page object that can represent any page, without specifiying the exact page.
Manage Appium servers for multiple devices.
The Appium Service pool is responsible for starting up and shutting down Appium servers.
Define the URLs that a given Page Object works with.
Observes the test run and stores test run details for later reporting.
Created with IntelliJ IDEA.
Indicates whether or not the screenshots should be blurred.
Read browser preferences from a part of the serenity.conf file via the environment variables.
Provides BrowserStack specific capabilities
Deprecated.
Use By instead
By Selector that finds Shadow Dom elements.
By Selector that finds Shadow Dom elements.
Created by john on 14/06/2016.
Created by john on 25/06/2016.
A checkbox web element.
Created by Sergio Sacristan on 03/12/17.
A description goes here.
Load any implementations of the FixtureService class declared on the classpath.
Specifies the annotations of the cleanup methods.
Created by john on 12/03/15.
Test data from a CSV file.
CustomCapabilities are use to define both general and browser-specific capabilities for drivers in a generic way.
Created by Sergio Sacristan on 03/12/17.
A darkroom processes and saves screenshots that were taken during the tests.
Keep track of whether the current thread is running a data-driven step or not.
Create a proxy for scenario steps objects to be used for data-driven tests.
Invoke a step multiple times, each time initialized with a different set of test data.
Created by john on 6/03/15.
Define the URLs that a given Page Object works with.
Initializes the
WebElementFacade members of a WidgetObject.Marks a task that should not generate any screenshots (such as a REST call or backend action) even if the test overall is a UI test
Created by john on 25/06/2016.
Thrown when the test runner tries to use an unsupported WebDriver driver.
Options that will be passed to a driver specified by the @WithDriver annotation
DriverServicePool<T extends org.openqa.selenium.remote.service.DriverService>
You can implement this class to provide your own driver instance.
Used to indicate that the provided driver has not been specified by the driverType() method.
Created by john on 25/06/2016.
Created by IntelliJ IDEA.
Created by john on 26/03/2015.
Utility class for implementing equals().
Models a condition that might reasonably be expected to eventually evaluate to something that is
neither null nor false.
Error that occurs if the test data could not be instanciated for some reason.
Utility class to convert CSV headings to valid JavaBean property names.
Created by john on 29/06/2014.
Created by john on 30/10/2014.
A class that helps upload a file to an HTML form in using a fluent API.
Deprecated.
Replaced by FindBy
Firefox profile preferences are configured in firefox.preferences.* variables
A description goes here.
Class designed to make it easier reading from and reasoning about data in HTML tables.
Annotation is used to specify the implementation Class of the interface
that extends WebElementFacade.
Annotation is used to specify the implementation Class of the interface
that extends WebElementFacade.
Helper class for finding and invoking constructors.
Thrown if no suitable WebDriver field with the @Managed annotation is found in a test.
Thrown if no suitable WebDriver field with the @Managed annotation is found in a test.
Thrown if no suitable WebDriver field with the @Managed annotation is found in a test.
Marks a task that will not be reported.
Marks a task that will not be reported.
Simple encapsulation of Javascript execution.
Created by john on 14/06/2016.
Annotation that marks a WebDriver field as one that is managed by the Test Runner.
Annotation that marks a WebDriver field as one that is managed by the Test Runner.
The WebDriver driver is stored as an annotated field in the test classes.
Created by john on 2/02/15.
Annotation that marks a manual test.
Determines which URLs a given page object will work with.
Created by john on 9/08/2015.
Created by john on 7/08/2015.
Created by john on 17/03/15.
Created by john on 28/10/2014.
Created by john on 14/06/2016.
A convenience class to help handle multiple select fields.
Define the URLs that a given Page Object works with.
Define the URLs that a given Page Object works with.
I need
NoSuchElementException that does
not include
InvalidSelectorException.Thrown when there is an implementation error of WebElementFacade extension
Created by john on 14/07/2017.
A description goes here.
This class allows you to override driver capabilities defined in the Serenity configuration files at runtime.
Allows you to instantiate PageObject fields in
A base class representing a WebDriver page object.
A base class representing a WebDriver page object.
The Pages object keeps track of what web pages a test visits, and helps with mapping pages to Page Objects.
The Pages object keeps track of the Page Objects used during the tests.
Manage the URLs associated with a page
Urls can be associated with a page using annotations or via the default configuration properties.
A PhotoLens encapsulates a WebDriver or Playwright object that can be used to take screenshots
A description goes here.
A static interceptor that guards against method calls before the interceptor is set.
Created by john on 25/06/2016.
A Remote Driver using SauceLabs or Browserstack (for remote web testing), or Selenium Grid.
A page view that handles checking and waiting for element visibility.
Annotation that marks a WebDriver field as one that is managed by the Test Runner.
Created by john on 26/06/2016.
A set of reusable steps for use in an acceptance test suite.
Implement this interface if you want to implement your own WebDriver screenshot logic.
A screenshot taken by a photographer.
Deprecated.
A simple sequencer for screenshot numbers.
A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
Provide supporting methods for creating report listeners and generating reports.
Manage WebDriver instances.
Shared is a synonym for @Steps(shared=true)
Handles Lists of
WebElementFacades.Handles single-item
WidgetObject proxies.Initializes
WidgetObject fields with contextual locators.Utility class used to inject fields into a test case.
Data-driven test step execution.
An event bus for Step-related notifications.
Produces an instance of a set of requirement steps for use in the acceptance tests.
Listen to step results and publish notification messages.
Represents a class that monitors step results and can report on test outcomes.
Marks a class that implements test steps as individual methods.
Used to identify Step library fields that need to be instantiated.
Test data from a set of Strings.
The list of supported web drivers.
Utility class used to inject fields into a test case.
A set of test data used in parameterized web tests.
Helps analyse annotations on test methods, steps and step groups.
A named test method was not found in a test class.
Result of a test step or sequence of test steps.
Used as a wrapper around the GeckoDriverService to make it behave in a Threadsafe manner
like all the other DriverService implementations.
Deprecated.
Use Serenity class instead
A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
Created by john on 28/10/2014.
Deprecated.
Use SerenityListeners instead
Deprecated.
Use SerenityListeners instead
Listener class used to know when a new Webdriver instance has been created.
A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
Created by john on 30/01/15.
Created by john on 12/03/15.
An action class designed to interact an application via the UI
An action class designed to query an application via the UI
Could not invoke a Page Oject method annotated with the WhenPageOpens annotation.
Created by john on 27/06/2014.
Mark a test case with a code identifing a user story.
A proxy class for webdriver instances, designed to prevent the browser being opened unnecessarily.
Provides an instance of a supported WebDriver.
One or more WebDriver drivers that are being used in a test.
Manage WebDriver instances.
Take a screenshot with a specified WebDriver instance.
Provides a proxy for a WebDriver instance.
The default screenshot mechanism, using the standard WebDriver screenshot functionality
Created by john on 30/01/15.
Deprecated.
Use same-named class in serenitybdd package
A proxy class for a web element, providing some more methods.
Deprecated.
Use same-named class in serenitybdd package
Handles a resolved
WebElementFacade from a List.This interface is a way of presenting state information about a web element without exposing (too much) of the
WebDriver API.
Deprecated.
Use same-named class in serenitybdd package
Indicates a method on a Page Object that is called when the page is opened.
Handles a resolved
WidgetObject from a List.Represents a page fragment which occurs across pages or multiple times in a single
page.
Base implementation for
WidgetObject.Created by john on 12/03/15.
Run an individual test with a specific driver.
We have navigated to the wrong page.