SpecFlowTool<TSettings> Class

Summary

Base class for all SpecFlow related tools.
Namespace
Cake.Common.Tools.SpecFlow
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Base0-->Base1["object"] Type["SpecFlowTool<TSettings>"] class Type type-node Derived0["SpecFlowStepDefinitionReporter"]-->Type click Derived0 "/api/Cake.Common.Tools.SpecFlow.StepDefinitionReport/SpecFlowStepDefinitionReporter" Derived1["SpecFlowTestExecutionReporter"]-->Type click Derived1 "/api/Cake.Common.Tools.SpecFlow.TestExecutionReport/SpecFlowTestExecutionReporter"

Syntax

public abstract class SpecFlowTool<TSettings> : Tool<TSettings> where TSettings : SpecFlowSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

Name Summary
SpecFlowTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the SpecFlowTool<TSettings> class.

Methods

Name Value Summary
AppendArguments(SpecFlowSettings, ProcessArgumentBuilder) void
Appends the SpecFlowSettings arguments to builder.
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.

Extension Methods

Name Value Summary
Dump<SpecFlowTool<TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SpecFlowTool<TSettings>>(SpecFlowTool<TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<SpecFlowTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<SpecFlowTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<SpecFlowTool<TSettings>>(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<SpecFlowTool<TSettings>>(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