Executable Specifications

WebdriverIOFrameworkAdapterFactory

when initialising WebdriverIOFrameworkAdapter

loads specs using @serenity-js/mocha adapter by default

loads specs using @serenity-js/mocha when configured to do so

loads specs using @serenity-js/jasmine when configured to do so

loads specs using @serenity-js/cucumber when configured to do so

complains when configured with an invalid runner

WebdriverIONotifier

failureCount()

does not count retried scenarios

notifications

emits events when a test suite starts and is finished

emits events when a nested test suite starts and is finished

emits events when a nested test starts and is finished

BrowserCapabilitiesReporter

when working with a single browser/device

records browser and platform tags when the test run starts and emits them upon start of the scenario

emits the recorded tags whenever a new test scenario starts

when working with multiple browsers/devices

emits only unique browser and platform tags

OutputStreamBuffer

TagPrinter

when working with a mobile device

should tag browser and platform for mobile web browser

should mark browser as "unknown" when information is missing

should tag the native app as "browser"

should tag a simulator

when working with a single browser

should tag "platform" as unknown where the information is missing

should tag both browser and platform, where platformVersion is not available

should tag both browser and platform, where platformVersion is available

running on BrowserStack

should correctly describe desired capabilities when "os" is given

should tag "platform" as unknown where "os" is missing

should tag "platform" even when "os_version" is missing

isActive

allows the actor flow to continue when the element is active

breaks the actor flow when element is inactive

contributes to a human-readable description of an assertion

contributes to a human-readable description of a wait

isClickable

allows the actor flow to continue when the element is clickable

breaks the actor flow when element is disabled

breaks the actor flow when element is not visible

contributes to a human-readable description of an assertion

contributes to a human-readable description of a wait

isEnabled

allows the actor flow to continue when the element is enabled

breaks the actor flow when element is disabled

contributes to a human-readable description of an assertion

contributes to a human-readable description of a wait

isPresent

allows the actor flow to continue when the element is present in the DOM

breaks the actor flow when element does not become present in the DOM

breaks the actor flow when element is not present in the DOM

contributes to a human-readable description of an assertion

contributes to a human-readable description of a wait

isSelected

allows the actor flow to continue when the element is selected

breaks the actor flow when element is not selected

breaks the actor flow when element is not present

contributes to a human-readable description of an assertion

contributes to a human-readable description of a wait

isVisible

allows the actor flow to continue when the element is visible

breaks the actor flow when element is not visible

breaks the actor flow when element does not exist

contributes to a human-readable description of an assertion

contributes to a human-readable description of a wait

Clear

allows the actor to clear the value of an empty input

does not affect elements with no "value" attribute

allows the actor to clear the value of an input field

allows the actor to clear the value of an number field

allows the actor to clear the value of a date field

allows the actor to clear the value of an RTL input field

complains if the element cannot be cleared

provides a sensible description of the interaction being performed

Click

allows the actor to click on an element

provides a sensible description of the interaction being performed

DoubleClick

allows the actor to clear the value of a field

provides a sensible description of the interaction being performed

Enter

allows the actor to enter the value into an input field

allows the actor to enter a sequence of keys into a number field

provides a sensible description of the interaction being performed

Hover

allows the actor to position the mouse cursor over a given target

provides a sensible description of the interaction being performed

Navigate

to(url)

allows the actor to navigate to a desired destination

provides a sensible description of the interaction being performed

back

allows the actor to navigate back in the browser history

provides a sensible description of the interaction being performed

forward

allows the actor to navigate forward in the browser history

provides a sensible description of the interaction being performed

reloadPage

allows the actor to navigate to a desired destination

provides a sensible description of the interaction being performed

Press

single keys

allows the actor to enter keys individually into a field

key chords

allows the actor to use modifier keys

allows the actor to use keyboard shortcuts outside the context of any specific input box

allows the actor to use keyboard shortcuts in the context of a specific input box

RightClick

allows the actor to click on an element

provides a sensible description of the interaction being performed

Scroll

allows the actor to scroll to a given target so that it appears in the viewport

provides a sensible description of the interaction being performed

Wait

for

pauses the actor flow for the length of an explicitly-set duration

provides a sensible description of the interaction being performed

until

pauses the actor flow until the expectation is met

fails the actor flow when the timeout expires

provides a sensible description of the interaction being performed

ExecuteAsynchronousScript

allows the actor to execute an asynchronous script

allows the actor to execute an asynchronous script with a static argument

allows the actor to execute an asynchronous script with a promised argument

allows the actor to execute an asynchronous script with a Target argument

provides a sensible description of the interaction being performed when invoked without arguments

provides a sensible description of the interaction being performed when invoked with arguments

complains if the script has failed

emits the events so that the details of the script being executed can be reported

ExecuteScriptFromUrl

allows the actor to execute a script stored at a specific location

complains if the script could not be loaded

complains if the script has already been loaded

provides a sensible description of the interaction being performed

ExecuteSynchronousScript

allows the actor to execute a synchronous script

allows the actor to retrieve the value returned by the script

allows the actor to execute a synchronous script with a static argument

allows the actor to execute a synchronous script with a promised argument

allows the actor to execute a synchronous script with a Target argument

provides a sensible description of the interaction being performed when invoked without arguments

provides a sensible description of the interaction being performed when invoked with arguments

complains if the script has failed

emits the events so that the details of the script being executed can be reported

Attribute

called

allows the actor to read an attribute of a DOM element matching the locator

produces a sensible description of the question being asked

complains if the target is not specified

can be used to filter a list of elements

Text

of

allows the actor to read the text of the DOM element matching the locator

produces a sensible description of the question being asked

when mapping

allows for the answer to be mapped to another type

allows for the transformations to be chained

ofAll

allows the actor to read the text of all DOM elements matching the locator

allows for a question relative to another target to be asked

produces sensible description of the question being asked

allows for the answer to be mapped

Value

of

allows the actor to read the "value" attribute of a DOM element matching the locator

allows the actor to read the "value" attribute of a DOM element matching the locator

allows for a question relative to another target to be asked

by

id

should retrieve a matching element

should retrieve all matching elements

css

should retrieve a matching element

should retrieve all matching elements

tagName

should retrieve a matching element

should retrieve all matching elements

linkText

should retrieve a matching element

should retrieve all matching elements

partialLinkText

should retrieve a matching element

should retrieve all matching elements

xpath

should retrieve a matching element

should retrieve all matching elements

Target

allows the actor to locate

a single web element matching the selector

all web elements matching the selector

an element relative to another target

all elements relative to another target

provides a sensible description of

an element that

is being targeted

is nested

elements that

are being targeted

are nested

when filtering a list of targets

and no filters are applied

lets the actor interact with the list of matching elements so that it

gets the number of items

picks all the items

picks the first item

picks the last item

picks the nth item

provides a sensible description when it

returns the number of items

picks all the items

picks the first item

picks the last item

and a filter is applied

lets the actor filter the list of matching elements so that it

gets the number of items

picks all the items

picks the first item

picks the last item

picks the nth item

provides a sensible description when it

returns the number of items

picks all the items

picks the first item

picks the last item

and multiple filters are applied

lets the actor filter the list of matching elements so that it

gets the number of items

picks all the items

picks the first item

picks the last item

picks the nth item

provides a sensible description when it

returns the number of answers

picks all the items

picks the first item

picks the last item

and interacting with elements on screen

makes it easy for an actor to pick the element of interest

makes it easy for an actor to pick all elements of interest

Photographer

complains when sent DomainEvents before getting assigned to a Stage

Photographer

when instructed to take photos before and after all interactions

takes a before and after photo when the interaction goes well

takes a photo when a problem occurs

takes a photo before and after Interaction, even though nested tasks might all be marked as failing

takes two photos per interaction

includes the browser context in the name of the emitted artifact

Photographer

when instructed to take a photo of failed interactions,

does nothing if everything goes well

takes a photo when a problem occurs

takes only one picture, even though nested tasks might all be marked as failing

Photographer

when instructed to take a photo of all interactions

takes a photo when the interaction goes well

takes a photo when a problem occurs

takes only one photo, even though nested tasks might all be marked as failing

takes one photo per interaction

includes the browser context in the name of the emitted artifact