Summary

Contains settings used by SpecFlowTestExecutionReporter.

Namespace

Cake.Common.Tools.SpecFlow.TestExecutionReport

Base Types

graph BT Type-->Base0["SpecFlowSettings"] click Base0 "/api/Cake.Common.Tools.SpecFlow/SpecFlowSettings" Base0-->Base1["ToolSettings"] click Base1 "/api/Cake.Core.Tooling/ToolSettings" Base1-->Base2["object"] Type["SpecFlowTestExecutionReportSettings"] class Type type-node

Syntax

public sealed class SpecFlowTestExecutionReportSettings : SpecFlowSettings

Properties

Name	Value	Summary
ArgumentCustomization	Func<ProcessArgumentBuilder, ProcessArgumentBuilder>	Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues. Inherited from ToolSettings
EnvironmentVariables	IDictionary<string, string>	Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information. Inherited from ToolSettings
HandleExitCode	Func<int, bool>	Gets or sets whether the exit code from the tool process causes an exception to be thrown. If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code. If the delegate returns true then no exception is thrown. This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value. Inherited from ToolSettings
NoWorkingDirectory	bool	Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process. Inherited from ToolSettings
Out	FilePath	Gets or sets the generated Output File. Optional. Default: TestResult.html. Inherited from SpecFlowSettings
PostAction	Action<IProcess>	Gets or sets a delegate which is executed after the process was started. Inherited from ToolSettings
SetupProcessSettings	Action<ProcessSettings>	Gets or sets a delegate to configure the process settings. Inherited from ToolSettings
ThrowOnTestFailure	bool	Gets or sets a value indicating whether exceptions from the intercepted action should be rethrown after report generation.
ToolPath	FilePath	Gets or sets the tool path. Inherited from ToolSettings
ToolTimeout	TimeSpan?	Gets or sets optional timeout for tool execution. Inherited from ToolSettings
WorkingDirectory	DirectoryPath	Gets or sets the working directory for the tool process. Inherited from ToolSettings
XsltFile	FilePath	Gets or sets the custom XSLT file to use, defaults to built-in stylesheet if not provided. Optional. Default: not specified. Inherited from SpecFlowSettings

Extension Methods

Name	Value	Summary
Dump<SpecFlowTestExecutionReportSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<SpecFlowTestExecutionReportSettings>(SpecFlowTestExecutionReportSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<SpecFlowTestExecutionReportSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<SpecFlowTestExecutionReportSettings>(string)	void	From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<SpecFlowTestExecutionReportSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<SpecFlowTestExecutionReportSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	From StringExtensions Requires the Cake.Issues addin
WithArgumentCustomization<SpecFlowTestExecutionReportSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>)	T	Sets the tool argument customization delegate. From ToolSettingsExtensions
WithEnvironmentVariable<SpecFlowTestExecutionReportSettings>(string, string)	T	Sets or adds tool environment variable. From ToolSettingsExtensions
WithExpectedExitCode<SpecFlowTestExecutionReportSettings>(int)	T	Sets expected exit code using `WithHandleExitCode<T>(T, Func<int, bool>)`. From ToolSettingsExtensions
WithHandleExitCode<SpecFlowTestExecutionReportSettings>(Func<int, bool>)	T	Sets delegate whether the exit code from the tool process causes an exception to be thrown. From ToolSettingsExtensions
WithNoWorkingDirectory<SpecFlowTestExecutionReportSettings>(bool)	T	Sets whether the tool should use a working directory or not. From ToolSettingsExtensions
WithPostAction<SpecFlowTestExecutionReportSettings>(Action<IProcess>)	T	Sets a delegate which is executed after the tool process was started. From ToolSettingsExtensions
WithSetupProcessSettings<SpecFlowTestExecutionReportSettings>(Action<ProcessSettings>)	T	Sets a delegate to configure the process settings. From ToolSettingsExtensions
WithToolPath<SpecFlowTestExecutionReportSettings>(FilePath)	T	Sets the tool path. From ToolSettingsExtensions
WithToolSettings<SpecFlowTestExecutionReportSettings>(Action<SpecFlowTestExecutionReportSettings>)	T	Provides fluent null guarded tool settings action. From ToolSettingsExtensions
WithToolTimeout<SpecFlowTestExecutionReportSettings>(TimeSpan)	T	Sets the tool timeout. From ToolSettingsExtensions
WithWorkingDirectory<SpecFlowTestExecutionReportSettings>(DirectoryPath)	T	Sets the tool working directory. From ToolSettingsExtensions

SpecFlowTestExecutionReportSettings Class

Summary

Syntax

Properties

Extension Methods