Class GetAssetFilePaths

Namespace

CSF.Screenplay.Abilities

Assembly

CSF.Screenplay.Abstractions.dll

Screenplay ability which gets the file system path for asset files generated by actors participating in the current performance.

public class GetAssetFilePaths : ICanReport

Inheritance

object

GetAssetFilePaths

Implements

ICanReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GetAssetFilePaths(IGetsAssetFilePath)

Initializes a new instance of the GetAssetFilePaths class.

public GetAssetFilePaths(IGetsAssetFilePath pathProvider)

Parameters

pathProvider IGetsAssetFilePath

The path provider used to get asset file paths.

Methods

GetAssetFilePath(string)

Gets the file system path for the specified asset file.

public string GetAssetFilePath(string baseName)

Parameters

baseName string

A short descriptive file name fragment for the asset file, including the file extension.

Returns

string

The asset file path.

Remarks

The returned file system path is an absolute path to which the asset file should be written. The path is determined by the logic of the service IGetsAssetFilePath. This means that the final filename will not be identical to the baseName but will include that base name within it.

If this method returns null then the asset file should not be written to the file system.

See Also

GetAssetFilePath(string)

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.