All Classes

Class Description
AbstractRequirementsTagProvider  
AcceptanceCriteriaRequirmentCounter  
AcceptanceTestFullReporter  
AcceptanceTestLoader  
AcceptanceTestReporter
Generates a report based on a set of acceptance test results.
AdaptorService  
AllRequirements  
AnnotatedFeature  
AnnotatedStepDescription
Test steps and step groups can be described by various annotations.
AnnotatedTags  
AnnotationBasedTagProvider
Returns test tags based on the @WithTag, @WithTags and @WithTagValuesOf.
AnsiEscapes  
ApplicationFeature
A feature represents a higher-level functionality that is illustrated by several user stories.
AScenarioHasNoNameException  
AsciiColors  
Asciidoc  
AsciidocMarkupRenderer  
AtomicTestCount
Keeps track of the tests executed.
BadgeBackground  
BaseRequirementsService  
BasicXUnitLoader  
BatchManager  
BatchManagerProvider  
BatchStrategy  
BeanCollectionMatcher  
BeanFieldMatcher  
BeanFields  
BeanMatcher  
BeanMatcherAsserts  
BeanMatchers  
BeanMatchers.BeanConstraint  
BigDecimalValueMatcher  
BlankRowResultIcon  
BreadcrumbTagFilter  
BreadcrumbTagFilter.RequirementTagFilter  
BrowserStackLinkGenerator
Used to generate links to BrowserStack videos when the tests are executed on the BrowserStack servers.
BuildInfoProvider
Created by john on 12/02/15.
BuildProperties
Created by john on 12/02/15.
CastMember  
CausesAssertionFailure  
CausesCompromisedTestFailure  
ChildElementAdder
Created by john on 13/07/2016.
ChildElementAdder.ChildElementAdderBuilder  
ChildrenFirstOrderedMap  
ChildRequirementCounter  
ClassFinder
Load classes from a given package.
ClassInfoAnnotations  
ClassNarrative
Created by john on 20/07/2016.
ClassNarrative.ClassNarrativeText  
ClassNarrative.ClassNarrativeType  
ClasspathDependencyInjectorService  
ClasspathRequirementsProviderService
Provides a way to obtain the list of requirements providers.
ClasspathTagProviderService  
ClassTypeAdapter  
CollectionAdapter  
CompoundDuration  
Configuration<T extends Configuration>  
ConfiguredEnvironment  
ConsoleColors  
ConsoleEvent  
ConsoleHeading  
ConsoleHeadingStyle  
ConsoleLoggingListener  
ContextIcon  
ContextTagProvider
Allows tags to be added via the injected.tag system property.
CopyDirectory  
CoreTagProvider
A core system-provided tag provider: used to know if any additional providers are present on the classpath.
CouldNotLoadRequirementsException
Created by john on 28/07/2016.
CouldNotReadXUnitFileException  
CSVReporter
Stores test outcomes as CSV files
CucumberCompatibleFilter  
CucumberParser
Created by john on 5/03/15.
CucumberTagConverter  
CurrentOS  
CurrentOS.OSType  
CustomFieldValue  
DataSet
Created by john on 13/08/2014.
DataSetDescriptor
Created by john on 13/08/2014.
DataTable
A table of test data
DataTable.DataTableBuilder  
DataTable.RowValueAccessor  
DataTableRow  
DateCollectionContainsSameDatesMatcher  
DateMatchers
Hamcrest matchers to be used with Dates.
DateProvider  
DateTimeCollectionContainsSameDatesMatcher  
DefaultRequirements
Created by john on 26/06/2016.
DefaultXUnitAdaptor  
DependencyInjector  
DependencyInjectorService  
DescriptionSplitter  
DescriptionWithScenarioReferences  
Digest  
DisabledRequirementsStore  
Downloadables  
DriverCapabilityRecord
Created by john on 12/02/15.
EnvironmentDefinedTags  
EnvironmentSpecificConfiguration  
EnvironmentVariables
Return system environment variable values.
ErrorMessageFormatter
Converts a full WebDriver message into a shorter, more web-friendly format.
Example  
ExampleBuilder  
ExampleRowResultIcon  
ExampleTable  
ExampleTableInMarkdown  
ExcludedUnrelatedRequirementTypes  
ExecutedStepDescription
A description of a step executed during a Thucydides step run.
ExternalLink  
FailingManualTestException  
FailureAnalysis
Determine whether a given type of exception should result in a failure or an error.
FailureAnalysisConfiguration  
FailureCause  
FailureDetails  
Feature
Marks a class as representing an application feature.
FeatureBackgroundNarrative  
FeatureFileScenarioOutcomes  
FeatureFileStrategy  
FeatureStoryTagProvider
Legacy tag provider that builds tags based on the Feature/Story structure, if the @WithTag annotation is not used.
FeatureTagAsDefined
Created by john on 6/07/2016.
FeatureTagStrategy  
FeatureTitle
Created by john on 7/07/2016.
FeatureType
Created by john on 6/03/15.
FieldFinder  
Fields
Find the annotated fields in a given class.
Fields.FieldValue  
Fields.FieldValueBuilder  
FieldSetter
Internal class used to set field values inside an object.
FieldValue
Internal class used to set field values inside an object.
FilebasedOutcomeAdaptor  
FileDeserializer
Created by john on 11/02/15.
FileMatchers  
FilePathParser
Builds a file path by substituting environment variables.
FileResources
Utility class used to copy resources from a classpath to a target directory.
FileSerializer
Created by john on 11/02/15.
FileSystemRequirements
Created by john on 25/06/2016.
FileSystemRequirementsService  
FileSystemRequirementsStore  
FileSystemRequirementsTagProvider
Load a set of requirements (epics/themes,...) from the directory structure.
FileSystemRequirmentsOutcomeFactory  
FileSystemTestOutcomeSummaryRecorder  
FileSystemUtils
Created by john on 29/06/2014.
FirstLine  
Flag  
FlagCounts  
FlagProvider  
FlagsAugmenter  
FormatConfiguration  
FreemarkerReportTemplate  
FreeMarkerTemplateManager
Manages velocity templates.
GsonJSONConverter  
GsonPreviousOutcomeConverter  
HeuristicTestResult  
HistoricalFlagProvider  
IdentifiedExampleTable  
IdentifiedScenario  
IgnoredStepException
Exception thrown to indicate that a test cannot proceed and should be considered 'skipped'.
Inflection  
Inflector
Transforms words to singular, plural, humanized (human readable), underscore, camel case, or ordinal form.
Inflector.Rule  
InjectedTagProvider
Allows tags to be added via the injected.tag system property.
Injectors
Somewhere to hold the Guice injector.
InternalSystemClock
Object that encapsulates system clock operations.
InvalidFeatureFileException  
Issue
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
IssueExtractor  
IssueKeyFormat  
Issues
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
IssueTracking
Determine the issue tracking URL formats for a project.
JiraUpdaterService  
Joiner  
JSONConverter  
JSONRequirementsTree  
JSONTestOutcomeReporter  
JUnitAdapter
This is an INTERNAL helper class of serenity, it should not be used directly and may be subject to refactoring.
JUnitTagProviderStrategy  
JUnitXMLConverter  
JUnitXMLOutcomeReporter  
LastElement  
LeafRequirementAdder  
LeafRequirementAdder.LeafRequirementsAdderBuilder  
LettuceXUnitAdaptor  
LinkGenerator
Generate the link to an external system
LoadedNarrative  
LocalPreferences
Loads configuration values from local files into the environment variables.
LoggingLevel
Which errors should be displayed
ManualTestEvidence  
MarkdownRendering  
MarkdownRendering.RenderedElements  
MarkupRenderer  
MavenOrGradleBuildPath  
MergeStepResultStrategy  
MetaField  
MethodFinder  
MockEnvironmentVariables  
MultipleInflection  
MultipleSourceRequirmentsOutcomeFactory
Merges and consolidates requirements hierarchies coming from several sources.
MultiSourceRequirementsService  
NameConverter
Utility class to convert test case and method names into human-readable form.
NamedExampleTable  
NamedScenario  
Narrative  
Narrative  
NarrativeFinder  
NarrativeFromCucumberComments  
NarrativeReader
Load a narrative text from a directory.
NarrativeTitle  
NewFailure  
NewList  
NewMap  
NewSet  
NextStepCompromisedStrategy  
NextStepFailedStrategy  
NextStepStatusTakesPriorityStrategy
Created by john on 9/08/2015.
NextStepWasSkippedStrategy  
Node  
NoException  
NoFeatureStrategy  
NonLeafRequirementsAdder
Created by john on 13/07/2016.
NonLeafRequirementsAdder.NonLeafRequirementsAdderBuilder  
NotAThucydidesReportException
Exception thrown if we attempt to process a file that is not a valid Thucydides XML report.
NumberOfThreads  
NumericalFormatter  
OptionalTypeAdapter<E>  
OutcomeAugmenter  
OutcomeCounter  
OutcomeFormat  
OutcomeSummary  
OutcomeTagFilter  
OverridableTagProvider
A default tag provider that can be overridden by any additional tag provider if present on the classpath.
OverviewReader  
PackageAnnotationBasedTagProvider
A requirements Provider that reads requirement from class or package annotation.
PackageBasedLeafRequirements  
PackageInfoClass
Created by john on 20/07/2016.
PackageInfoNarrative
Created by john on 20/07/2016.
PackageInfoNarrative.TextPackageInfoNarrative  
PackageInfoNarrative.TypePackageInfoNarrative  
PackageRequirementsTagProvider
Load a set of requirements (epics/themes,...) from the directory structure.
ParentRequirementProvider  
ParentRequirementsProvided  
PathElements
Created by john on 13/07/2016.
Pending
Annotation that marks a test or test step as pending implementation.
PendingStepException
Exception thrown to indicate that a test cannot proceed and should be considered 'pending'.
PercentageRequirementCounter
Created by john on 22/07/2016.
PreviousTestOutcome  
ProgressSnapshot  
ProgressSnapshot.ProgressSnapshotBuilder  
ProgressSnapshot.ProgressSnapshotBuilder.ResultCountBuilder  
PropertiesFileLocalPreferences
Loads Thucydides preferences from a local file called thucydides.properties.
PropertiesUtil  
PropertyBasedDriverCapabilityRecord
Created by john on 12/02/15.
PublicThucydidesMatchers  
ReferencedExampleTable
An example table that is mentioned by name in a feature narrative.
ReferencedScenario
A scenario that is mentioned by name in a feature narrative.
Release
A release or version of a software project.
ReleaseManager  
ReleaseProvider
This interface is used to implement plugins that provide a complete list of the known releases.
RemoteTestingLinkManager  
RenderCucumber  
RenderedExampleTable  
RenderMarkdown  
ReplaceField  
ReplaceField.ReplaceFieldBuilder  
ReportBadges  
ReportData  
ReportData.ReportDataBuilder  
ReportFormatter  
ReportGenerationFailedError
Report generation has failed for some reason.
ReportLoadingFailedError
Report loading has failed for some reason.
ReportNameProvider  
ReportNamer
Determies the correct default name for test reports.
ReportOptions
Encapsulates user-specified formatting options for the generated reports.
ReportService
Generates different Thucydides reports in a given output directory.
ReportTemplate  
ReportType
The report namer knows how to find names for these types of reports
Requirement
A requirement represents a high-level business goal that will appear in the result summary report.
Requirement.CustomFieldSetter  
RequirementAncestry  
RequirementBuilderNameStep  
RequirementBuilderTypeStep  
RequirementOutcome  
RequirementPersister  
Requirements  
RequirementsConfiguration  
RequirementsFilter  
RequirementsList
Provide aggregate information about a list of requirements
RequirementsMerger
Created by john on 16/04/2015.
RequirementsOutcomeFactory
Find the requirements tree for a given set of test outcomes
RequirementsOutcomes
A set of test results for a list of high-level requirements.
RequirementsOutcomesOfTypeCache  
RequirementsPath  
RequirementsPercentageFormatter  
RequirementsProportionCounter  
RequirementsProvided  
RequirementsProviderService  
RequirementsService
Find the requirements hierarchy or the requirements associated with a given test outcome
RequirementsStore  
RequirementsTagProvider
A requirements provider returns the set of application requirements in a tree structure.
RequirementsTree  
RequirementTree
Created by john on 30/5/17.
RequirementTypeAt  
RequirementTypesProvider
Provides a list of the requirement types used in the current project structure.
ResizableImage  
ResizedImage  
ResourceCopyingError
An error occurred when copying resources required for the HTML reports.
ResourceList
Utility class to read report resources from the classpath.
RestMethod  
RestQuery  
RestQuery.RestQueryBuilder  
ResultChecker  
ResultCounts  
ResultIconFormatter  
ResultsOutput  
RootCause  
RootCauseAnalyzer
Created by john on 3/07/2014.
RootDirectory
Find the root directory of the requirements hierarchy when using Cucumber or JBehave.
RowResultIcon  
Rule  
RuleBackground  
SafelyMoveFiles  
SafelyMoveFiles.SafelyMoveFilesBuilder  
ScenarioDisplayOption  
ScenarioOutcome  
ScenarioOutcomeCounter  
ScenarioOutcomes  
ScenarioReport  
ScenarioSplitter
Split a list of output lines into normal scenarios and table-based scenarios
ScenarioStep  
ScenarioStepReader  
ScenarioSummaryOutcome  
ScreenplayInspector  
Screenshot
Represents a screenshot stored during a test execution.
Screenshot.HtmlFormattedInfo  
ScreenshotAndHtmlSource
A screenshot image and the corresponding HTML source code.
ScreenshotException
The screenshot could not be taken for some reason.
ScreenshotHasFilenamesMatcher
Does a list of screenshot objects contain a specified list of screenshot filenames?
ScreenshotPreferencesByClass  
ScreenshotPreferencesByClass.ScreenshotPreferencesByClassBuilder  
SearchForFilesOfType  
SearchForFilesWithName  
SectionNumber
Define the order of appearance of a test method in the Serenity Requirements reports.
SerenityManagedException  
SerenitySystemProperties
Convenience class used to get and set Serenity system properties.
SerenityTestCaseFinder
Created by john on 22/07/2015.
SessionLocalTempDirectory  
SimpleValueMatcher  
SingleScenarioOutcome  
Skip
Details about a skipped test
SkipStepException
Exception thrown to indicate that a test cannot proceed and should be considered 'skipped'.
SpecflowAdaptor
Loads TestOutcomes from a specflow output file
SpecflowScenario  
SpecflowScenarioTitleLine  
SpecflowTableRow  
SpreadsheetResultsOutput  
StackTraceAnalyser  
StackTraceElementDeserializer
Created by john on 11/02/15.
StackTraceElementSerializer  
StackTraceSanitizer
Created by john on 30/01/15.
Statistics  
Step
A step in an acceptance test.
StepArgumentWriter  
StepFailure
Description and underlying cause behind a step failure.
StepFailureException
Used to indicate a failing step.
StepGroup Deprecated.
Just use @Step
StepListener
Represents a class interested in knowing about test execution flow and results.
StepResultMergeStragegy
Created by john on 9/08/2015.
Stopwatch  
Stories
Helper methods to deal with stories and related classes.
Story
Indicates that a particular test case tests a given user story.
Story
Represents a given user story or feature.
StoryFileStrategy  
SubrequirementsCount
Created by john on 23/07/2016.
SubrequirementsPercentageCount  
SubrequirementsProportionCount  
SummaryRowResultIcon  
SystemClock
Find the current system time.
SystemDateProvider  
SystemEnvironmentVariables
Return system environment variable values.
SystemPropertiesConfiguration
Centralized configuration of the test runner.
SystemPropertiesIssueTracking
Determine the issue tracking URL formats for a project.
SystemVariableBasedBatchManager
Manages running test cases (i.e.
TagConverters  
TagFilter  
Taggable
Indicates that a test case can have the @WithTag annotation and be filtered using the -Dtags option.
TagInflector  
TagInflector.InflectableTag  
TagProvider  
TagProviderFilter<T extends TagProvider>  
TagProviderService  
TagProviderStrategy  
TagScanner  
TakeScreenshots  
TemplateManager
Created by IntelliJ IDEA.
TemplateMergeException
An error that occurs during template merging, such as a template parsing error.
TestAnnotations
Utility class used to help process annotations on tests and test steps.
TestCase  
TestCaseOrder  
TestCompromisedException  
TestCount  
TestCountBasedBatchManager  
TestCoverageFormatter  
TestDuration  
TestError  
TestException
A failure or error as represented in an xUnit testcase result.
TestFailureCause  
TestFailureException
Created by john on 4/07/2014.
TestOutcome
Represents the results of a test (or "scenario") execution.
TestOutcome.OptionalElements  
TestOutcome.StepCountBuilder  
TestOutcomeAdaptor
Test outcome adaptors provide a way to read test results from an external source.
TestOutcomeConverter
XStream converter used to generate the XML acceptance test report.
TestOutcomeCounter
A basic builder used to count test outcomes of a particular type
TestOutcomeFilter  
TestOutcomeLoader
Loads test outcomes from a given directory, and reports on their contents.
TestOutcomeLoader.TestOutcomeLoaderBuilder  
TestOutcomeMatchers  
TestOutcomeResultsMatcher
Does a test outcome contain a given list of results, in the specified order?
TestOutcomes
A set of test outcomes, which lets you perform query operations on the test outcomes.
TestOutcomes.TestOutcomeMatcher  
TestOutcomesCompromised
Created by john on 10/01/2016.
TestOutcomesError
Created by john on 22/09/2014.
TestOutcomesFailures
Created by john on 22/09/2014.
TestOutcomeStream  
TestOutcomeSummary
Lightweight copy of a TestOutcome.
TestOutcomeSummaryRecorder  
TestResources  
TestResult
Acceptance test results.
TestResultComparison
A list of test results, used to determine the overall test result.
TestResultList
A list of test results, used to determine the overall test result.
TestResultSnapshot  
TestSourceType  
TestsRequirement
Used to associate a test with a particular reauirement or issue.
TestsRequirements
Indicate that a test scenario or test step addresses a particular requirement or requirements.
TestStatus
Determine the status of a method based on its annotations.
TestStep
An acceptance test run is made up of test steps.
TestStep.TestStepBuilder  
TestStepFactory  
TestSuite  
TestTag  
TestTag.TestTagBuilder  
TestTags  
TestType  
TheDirectoryStructure  
TheErrorType  
ThucydidesLogging  
ThucydidesMatchers  
ThucydidesModule  
ThucydidesReporter
A base directory for Thucydides report generators.
ThucydidesSystemProperty
Properties that can be passed to a web driver test to customize its behaviour.
TimeoutConfiguration  
TimeoutConfiguration.TimeoutConfigurationGetter  
TimeoutValue  
Title
An optional title placed on a step, to override the default step name.
TitleBuilder  
UndefinedEnvironmentVariableException  
UnknownAdaptor  
UnknownEnvironmentException  
UnknownExampleTable  
UnknownScenario  
UnrecognisedException  
UnsupportedBatchStrategyException
Exception container for invalid batchng strategy
URIResource  
UserStoryTestReporter
Generates an aggregate acceptance test report for each user story.
Version
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
VersionProvider
Created by john on 19/06/2014.
WebdriverAssertionError
Turns a webdriver error into an ordinary assertion error.
WindowsFriendly  
WithTag
Used to indicate that a test case or test relates to a particular issue or story card in the issue tracking system.
WithTags  
WithTagValuesOf  
XMLTestOutcomeReporter Deprecated.
XML outputs are no longer supported.
XUnitFiles  
XUnitLoader
Converts an xUnit compatible file into a list of TestSuite objects that can be used to create TestOutcomes.
ZonedDateTimeAdapter