Executable Specifications

ProtractorFrameworkAdapter

to meet the requirements described in "Framework Adapters for Protractor"

produces a Protractor report that

describes no test results if no tests were executed

describes successful tests

describes failing tests

describes both successful and failing tests

invokes runner.runTestPreparer before executing the tests

invokes runner.getConfig().onComplete() after executing the tests

when a test succeeds

invokes runner.emit with a "testPass" message

invokes runner.afterEach after each test

when a test fails

invokes runner.emit with a "testFail" message

invokes runner.afterEach after each test

error handling

fails the test run when runner.afterEach errors out

fails the test run when runner.afterEach rejects the promise

configuration

provides sensible defaults when no explicit configuration is provided

allows for the defaults to be overridden

StandardisedCapabilities

See the ProtractorFrameworkAdapter specs to see how the ProtractorReporter is used in the context

with default threshold

with custom threshold

TestRunnerDetector

when using TestRunnerAdapter for

Cucumber

uses the configured runner even when configuration for other runners is present as well

uses Cucumber test runner when cucumberOpts are present in config

merges cucumberOpts present in capabilities with root config

instructs TestRunnerLoader

to take over standard output when the config

defines serenity.crew and there is no cucumberOpts.format specified

defines serenity.crew and there is a cucumberOpts.format specified

to redirect output to a temp file when the config

does not specify serenity.crew and there are is no cucumberOpts.format specified either

does not specify serenity.crew, but there is a cucumberOpts.format specified

make the formatter output files unique when the config

specifies multiCapabilities

specifies shardTestFiles

Jasmine

uses Jasmine TestRunnerAdapter when no other runners are specified

uses the configured runner even when configuration for other runners is present as well

uses Jasmine test runner when jasmineNodeOpts are present in config

merges jasmineNodeOpts present in capabilities with root config

Mocha

uses the configured runner even when configuration for other runners is present as well

uses Mocha test runner when jasmineNodeOpts are present in config

merges mochaOpts present in capabilities with root config

TestRunnerLoader

when loading a TestRunnerAdapter for

Jasmine

passes the configuration to the adapter

Mocha

passes the configuration to the adapter

Cucumber

resolves glob patterns in require to absolute paths

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

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 field

allows the actor to clear the value of an empty input 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

Close

anyNewWindows()

should close any new windows and switch back to the original window

should do nothing if no new windows have been opened

should provide a sensible description of the interaction being performed

currentWindow()

should close the current window

should provide 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 the value 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

to(url).withTimeout(duration)

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

keyboard shortcuts

allows the actor to use keyboard shortcuts

ResizeBrowserWindow

allows the actor to change width and height of the browser window

produces a sensible description of the interaction being performed

toMaximum()

allows the actor to resize browser window to maximum

produces 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

Select

when working with single-option selects

Select.value()

should select a single option by its static value

should select a single option by its Answerable value

Select.option()

should select a single option by its static pageName

should select a single option by its Answerable name

when working with multi-option selects

Select.values()

should select multiple options by their static value

should select multiple options by their Answerable value

should concatenate option values from several Answerables

should concatenate option values from several static values

Select.options()

should select multiple options by their static pageName

should select multiple options by their Answerable name

should concatenate option values from several Answerables

should concatenate option values from several static values

toString()

provides a sensible description of Select.value()

provides a sensible description of Selected.valueOf

provides a sensible description of Select.option()

provides a sensible description of Selected.optionIn()

provides a sensible description of Select.values()

provides a sensible description of Select.valuesOf()

provides a sensible description of Select.options()

provides a sensible description of Selected.optionsIn()

Switch

when working with frames

toFrame()

should switch to an iframe identified by Question<ElementFinder>

should switch to an iframe identified by index

should switch to an iframe identified by name

should provide a sensible description when the iframe

is specified by Question<ElementFinder>

is specified by index number

is specified by name

toParentFrame()

should not switch the frame if there are no parent frames

should switch to the parent hosting an iframe

should support nested frames

should provide a sensible description of the interaction being performed

toDefaultContent()

should not switch the frame if there are no parent frames

should support nested frames

should provide a sensible description of the interaction being performed

toFrame().and()

should perform any activities in the context of the frame it switched to

should provide a sensible description of the interaction being performed

when working with windows

toWindow()

should switch to a window identified by its index

should switch to a window identified by its name

should provide a sensible description when the window

is specified by its index

is specified by name

toWindow().and()

should perform any activities in the context of the window it switched to

should provide a sensible description of the interaction being performed

should switch to a newly opened window

should provide a sensible description of the interaction being performed

toNewWindow().and()

should perform any activities in the context of the new window it switched to

should provide a sensible description of the interaction being performed

should switch back from a newly opened window

should provide a sensible description of the interaction being performed

TakeScreenshot

allows the actor to take a screenshot with an arbitrary name

provides a sensible description of the interaction being performed

UseAngular

synchronisation

when enabled

can be disabled

when disabled

can be enabled

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

allows the actor to read an attribute of a DOM element

Browser

returns no entries if the console log is empty

allows the actor to read the browser log entries

clears the log upon invocation

CSSClasses

of

allows for a question relative to another target to be asked

Cookie

over HTTP

when working with the value

allows the actor to retrieve it

returns an undefined when it can't retrieve it

provides a sensible description of the question being asked

when working with the path

allows the actor to retrieve it

returns an undefined when it can't retrieve it

provides a sensible description of the question being asked

when working with the domain

allows the actor to retrieve it

returns an undefined when it can't retrieve it

provides a sensible description of the question being asked

when working with http-only cookies

allows the actor to confirm that a cookie is http-only

returns an undefined when it can't retrieve it

provides a sensible description of the question being asked

when working with an expiry date

allows the actor to retrieve it

returns an undefined when it can't retrieve it

provides a sensible description of the question being asked

when working with secure cookies

allows the actor to confirm that a cookie is not secure

allows the actor to confirm that a cookie is secure

provides a sensible description of the question being asked

LastScriptExecution

when used with ExecuteScript.sync

allows the actor to retrieve the result of the script execution

returns null if the script did not return any result

when used with ExecuteScript.async

allows the actor to retrieve the result of the script execution

returns null if the script did not return any result

complains if the script hasn't been executed yet

ModalDialog,

when working with alert(),

allows the actor to accept an alert

allows the actor to dismiss an alert

allows the actor to read the message on an alert

when working with confirm(),

allows the actor to accept a confirmation dialog

allows the actor to dismiss a confirmation dialog

allows the actor to read the message on a confirmation dialog

when working with prompt(),

allows the actor to accept a prompt

allows the actor to dismiss a prompt

allows the actor to read the message on a prompt

allows the actor to enter value into a prompt

when waiting

allows the actor to wait until a modal dialog is present

when interacting with the Photographer,

is does not negatively impact the screenshot capture process

Pick

(when 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

provides a custom description when the name of its subject is overridden and it

returns the number of items

picks all the items

picks the first item

picks the last item

picks the nth item

(when 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 answers

picks all the items

picks the first item

picks the last item

(when 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

(when 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

ProtractorParam

lets the actor read the value of a primitive Protractor parameter specified in protractor.conf.js

lets the actor read the value of an object Protractor parameter specified in protractor.conf.js

lets the actor read the value of a Protractor parameter specified by path

complains if the parameter is undefined

contributes to a human-readable description of an activity

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

has been located

is nested

elements that

are being targeted

have been located

are nested

when nesting targets

allows for Target<ElementFinder> to be nested within another Target<ElementFinder>

allows for Target<ElementFinder> to form a chain with other Target<ElementFinder>s

allows for Target<ElementArrayFinder> to be nested within another Target<ElementFinder>

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

Website

title

allows the actor to read the title of the website

url

allows the actor to read the URL of the website

Loop

allows the actor to perform a sequence of activities for every element given

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