StorytellerSettings Class

Summary

Settings used by StorytellerRunner. Definitions provided in Storyteller Documentation
Assembly
Cake.Storyteller.dll
Namespace
Cake.Storyteller
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["StorytellerSettings"] class Type type-node

Syntax

public class StorytellerSettings : ToolSettings

Constructors

Name Summary
StorytellerSettings()

Properties

Name Value Summary
Build string
Specify a build target to force Storyteller to choose that profile. By default, ST will use 'Debug'
Config string
Optional. Override the config file selection of the Storyteller test running AppDomain
Csv string
WriteToText the performance data in CSV format to the specified path
Dump string
Dump the raw JSON history of the batch run to the specified path
ExcludeTags string
Optional. Excludes specs with any of the specified tags (comma-delimited)
Json string
WriteToText the raw result information to JSON format at the specified path
Lifecycle string
Optional. Only runs tests with desired Lifecycle
Open Nullable<bool>
Open the results in a browser after the run. DO NOT DO THIS IN CI!
Profile string
Storyteller test mode profile for systems like Serenity that use this
ResultsPath string
Path to write out the results. Default is stresults.htm
Retries Nullable<int>
Sets a minimum number of retry attempts for this execution
TeamCity Nullable<bool>
Optional. Applies extra logging to see progress within TeamCity during CI runs
Timeout Nullable<int>
Optional. Default project timeout in seconds.
Workspace string
Optional. Runs only one workspace

Extension Methods

Name Value Summary
Dump<StorytellerSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<StorytellerSettings>(StorytellerSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<StorytellerSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<StorytellerSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<StorytellerSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<StorytellerSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin