All Classes and Interfaces
Class
Description
Generates a report based on a set of acceptance test results.
Created by john on 25/06/2016.
Test steps and step groups can be described by various annotations.
Read the story name from the @DisplayName annotation if present
Returns test tags based on the @WithTag, @WithTags and @WithTagValuesOf.
A feature represents a higher-level functionality that is illustrated by several user stories.
Define the URLs that a given Page Object works with.
Keeps track of the tests executed.
Created with IntelliJ IDEA.
Indicates whether or not the screenshots should be blurred.
Used to generate links to BrowserStack videos when the tests are executed on the BrowserStack servers.
Created by john on 12/02/15.
Created by john on 12/02/15.
Created by john on 13/07/2016.
Load classes from a given package.
Created by john on 20/07/2016.
This class is responsible for loading and returning instances of
DependencyInjector discovered in the classpath.Provides a way to obtain the list of requirements providers.
Allows tags to be added via the injected.tag system property.
A core system-provided tag provider: used to know if any additional providers are present on the classpath.
Created by john on 28/07/2016.
Stores test outcomes as CSV files
Created by john on 5/03/15.
Created by john on 13/08/2014.
Created by john on 13/08/2014.
A table of test data
Hamcrest matchers to be used with Dates.
This is an INTERNAL helper class of serenity, it should not be used directly and may be subject to refactoring.
Created by john on 26/06/2016.
Define the URLs that a given Page Object works with.
Created by john on 12/02/15.
Options that will be passed to a driver specified by the @WithDriver annotation
Return system environment variable values.
Converts a full WebDriver message into a shorter, more web-friendly format.
A description of a step executed during a Thucydides step run.
Determine whether a given type of exception should result in a failure or an error.
Marks a class as representing an application feature.
Check whether a stream of files contains valid feature files, and throw an InvalidFeatureFileException if one is either not valid Gherkin syntax,
or contains errors or inconsistencies such as empty or duplicate scenario names
Return a stream of all the feature files in a given directory
Legacy tag provider that builds tags based on the Feature/Story structure, if the @WithTag annotation is not used.
Created by john on 6/07/2016.
Created by john on 7/07/2016.
Created by john on 6/03/15.
Find the annotated fields in a given class.
Internal class used to set field values inside an object.
Internal class used to set field values inside an object.
Created by john on 11/02/15.
Builds a file path by substituting environment variables.
Utility class used to copy resources from a classpath to a target directory.
Created by john on 11/02/15.
Created by john on 25/06/2016.
Load a set of requirements (epics/themes,...) from the directory structure.
Created by john on 29/06/2014.
Manages Freemarker templates.
Exception thrown to indicate that a test cannot proceed and should be considered 'skipped'.
Transforms words to singular, plural, humanized (human readable), underscore, camel case, or ordinal form.
Allows tags to be added via the injected.tag system property.
Object that encapsulates system clock operations.
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
Determine the issue tracking URL formats for a project.
Generate the link to an external system
Read localised labels from the serenity.conf file.
Loads configuration values from local files into the environment variables.
Which errors should be displayed
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.
Annotation that marks a manual test.
Merges and consolidates requirements hierarchies coming from several sources.
Utility class to convert test case and method names into human-readable form.
Define the URLs that a given Page Object works with.
Define the URLs that a given Page Object works with.
Load a narrative text from a directory.
Created by john on 9/08/2015.
Created by john on 13/07/2016.
Exception thrown if we attempt to process a file that is not a valid Thucydides XML report.
A default tag provider that can be overridden by any additional tag provider if present on the classpath.
A requirements Provider that reads requirement from class or package annotation.
Created by john on 20/07/2016.
Created by john on 20/07/2016.
Deprecated.
Created by john on 13/07/2016.
Annotation that marks a test or test step as pending implementation.
Exception thrown to indicate that a test cannot proceed and should be considered 'pending'.
Created by john on 22/07/2016.
Loads Thucydides preferences from a local file called thucydides.properties.
Created by john on 12/02/15.
An example table that is mentioned by name in a feature narrative.
A scenario that is mentioned by name in a feature narrative.
A release or version of a software project.
This interface is used to implement plugins that provide a complete list of the known releases.
Annotation that marks a WebDriver field as one that is managed by the Test Runner.
Report generation has failed for some reason.
Report loading has failed for some reason.
Determies the correct default name for test reports.
Encapsulates user-specified formatting options for the generated reports.
Generates different Thucydides reports in a given output directory.
The report namer knows how to find names for these types of reports
A requirement represents a high-level business goal that will appear in the result summary report.
Provide aggregate information about a list of requirements
Created by john on 16/04/2015.
Find the requirements tree for a given set of test outcomes
A set of test results for a list of high-level requirements.
Find the requirements hierarchy or the requirements associated with a given test outcome
A requirements provider returns the set of application requirements in a tree structure.
Created by john on 30/5/17.
Provides a list of the requirement types used in the current project structure.
An error occurred when copying resources required for the HTML reports.
Utility class to read report resources from the classpath.
Created by john on 3/07/2014.
Find the root directory of the requirements hierarchy when using Cucumber or JBehave.
Split a list of output lines into normal scenarios and table-based scenarios
Represents a screenshot stored during a test execution.
A screenshot image and the corresponding HTML source code.
The screenshot could not be taken for some reason.
Does a list of screenshot objects contain a specified list of screenshot filenames?
Define the order of appearance of a test method in the Serenity Requirements reports.
Convenience class used to get and set Serenity system properties.
Created by john on 22/07/2015.
Shared is a synonym for @Steps(shared=true)
A shorthand notation equivalent to adding the @singlebrowser tag to a test
Details about a skipped test
Exception thrown to indicate that a test cannot proceed and should be considered 'skipped'.
Loads TestOutcomes from a specflow output file
Created by john on 11/02/15.
Created by john on 30/01/15.
A step in an acceptance test.
Description and underlying cause behind a step failure.
Used to indicate a failing step.
Deprecated.
Just use @Step
Represents a class interested in knowing about test execution flow and results.
Created by john on 9/08/2015.
Marks a class that implements test steps as individual methods.
Helper methods to deal with stories and related classes.
Indicates that a particular test case tests a given user story.
Represents a given user story or feature.
Created by john on 23/07/2016.
Find the current system time.
Return system environment variable values.
Centralized configuration of the test runner.
Determine the issue tracking URL formats for a project.
Manages running test cases (i.e.
Tags can be excluded from the reports using the serenity.report.exclude.tags property
The '*' symbol can be used as a wildcard for any type or any value,
E.g.
Indicates that a test case can have the @WithTag annotation and be filtered using the -Dtags option.
An error that occurs during template merging, such as a template parsing error.
Utility class used to help process annotations on tests and test steps.
Test paths need to use displayed names when used rather than package names.
A failure or error as represented in an xUnit testcase result.
Created by john on 4/07/2014.
Environment variables set for an individual test, that will override the default environment values.
Represents the results of a test (or "scenario") execution.
Test outcome adaptors provide a way to read test results from an external source.
XStream converter used to generate the XML acceptance test report.
A basic builder used to count test outcomes of a particular type
Loads test outcomes from a given directory, and reports on their contents.
Read requirements from test outcomes, based on the path specified in each test outcome
Does a test outcome contain a given list of results, in the specified order?
A set of test outcomes, which lets you perform query operations on the test outcomes.
Created by john on 10/01/2016.
Created by john on 22/09/2014.
Created by john on 22/09/2014.
Lightweight copy of a TestOutcome.
Acceptance test results.
A list of test results, used to determine the overall test result.
A list of test results, used to determine the overall test result.
Used to associate a test with a particular reauirement or issue.
Indicate that a test scenario or test step addresses a particular requirement or requirements.
Determine the status of a method based on its annotations.
An acceptance test run is made up of test steps.
This is an INTERNAL helper class of serenity, it should not be used directly and may be subject to refactoring.
A base directory for Thucydides report generators.
Properties that can be passed to a web driver test to customize its behaviour.
An optional title placed on a step, to override the default step name.
Exception container for invalid batchng strategy
Mark a test case with a code identifing a user story.
Generates an aggregate acceptance test report for each user story.
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
Created by john on 19/06/2014.
Turns a webdriver error into an ordinary assertion error.
Indicates a method on a Page Object that is called when the page is opened.
Run an individual test with a specific driver.
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
Converts an xUnit compatible file into a list of TestSuite objects that can be used to create TestOutcomes.