Class Wait

Namespace

CSF.Screenplay.Selenium.Actions

Assembly

CSF.Screenplay.Selenium.dll

A performable action that waits until a specified condition is met, or a timeout expires (whichever is sooner).

public class Wait : IPerformable, ICanReport

Inheritance

object

Wait

Implements

IPerformable

ICanReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This action makes use of Selenium's OpenQA.Selenium.Support.UI.WebDriverWait class to implement the waiting logic. The maximum time (the timeout) for which to wait is determined by the following rules of precedence:

1. If a timeout was specified when constructing this instance, that value is used.
2. If the Actor performing this question has the ability UseADefaultWaitTime, then the time specified by WaitTime is used.
3. If neither of the above apply, a default timeout of 5 seconds is used.

If the wait fails to complete within the timeout period, a OpenQA.Selenium.WebDriverTimeoutException is thrown.

Constructors

Wait(WaitUntilPredicate<bool>, TimeSpan?, TimeSpan?, ICollection<Type>)

Initializes a new instance of the Wait class.

public Wait(WaitUntilPredicate<bool> predicate, TimeSpan? timeout, TimeSpan? pollingInterval = null, ICollection<Type> ignoredExceptionTypes = null)

Parameters

predicate WaitUntilPredicate<bool>

The predicate function to evaluate.

timeout TimeSpan?

An optional maximum amount of time to wait for the condition; the default is determined by the presence of the UseADefaultWaitTime ability. See the documentation of this class for more details.

pollingInterval TimeSpan?

An optional interval at which to poll the predicate; the Selenium default is 500ms.

ignoredExceptionTypes ICollection<Type>

An optional collection of types of exceptions to ignore while waiting; the default is an empty collection.

Methods

GetReportFragment(Actor, IFormatsReportFragment)

Gets a fragment of a Screenplay report, specific to the execution (performables) or gaining (abilities) of the current instance, for the specified actor.

public ReportFragment GetReportFragment(Actor actor, IFormatsReportFragment formatter)

Parameters

actor Actor

An actor for whom to write the report fragment

formatter IFormatsReportFragment

A report-formatting service

Returns

ReportFragment

A human-readable report fragment.

Examples

For a performable which clicks a button (where the button itself has been constructor-injected into the performable instance), then a suitable return value might be a formatted string such as {Actor name} clicks {Button}, where the two placeholders indicated by braces: {} are substituted with the actor's Name and a string representation of the button.

For a performable which reads the temperature from a thermometer, a suitable return value might be a string in the format {Actor name} reads the temperature.

For an ability which allows the actor to wash dishes then a suitable return value might be a string in the format {Actor name} is able to wash the dishes.

Remarks

Implementers should return a string which indicates that the named actor is performing (present tense) the performable, for types which also implement a performable interface. For types which represent abilities, the implementer should return a string which indicates that the named actor is able to do something. In particular for abilities, to make them easily recognisable in reports, it helps to stick to the convention {Actor name} is able to {Ability summary}.

For performables which return a value (Questions, or Tasks which behave like Questions), there is no need to include the returned value within the report fragment. The framework will include the return value in the report and will format it via a different mechanism.

Good report fragments are concise. Be aware that report fragments for Tasks (which are composed from other performables) do not need to go into detail about what they do. Users reading Screenplay reports are able to drill-down into Tasks to see what they are composed from, so if the user is curious as to what the task does, it is easy to discover. It is also strongly recommended to avoid periods (full stops) at the end of a report fragment. Whilst report fragments tend to be complete sentences, punctuation like this is distracting and reports are seldom presented as paragraphs of prose.

PerformAsAsync(ICanPerform, CancellationToken)

Performs the action(s) are represented by the current instance.

public ValueTask PerformAsAsync(ICanPerform actor, CancellationToken cancellationToken = default)

Parameters

actor ICanPerform

The actor that is performing.

cancellationToken CancellationToken

An optional cancellation token by which to abort the performable.

Returns

ValueTask

A task which completes when the performable represented by the current instance is complete.