ToolFixture<TToolSettings> Class

Summary

Base class for tool fixtures.
graph BT Type-->Base0["ToolFixture<TToolSettings, ToolFixtureResult>"] Base0-->Base1["object"] Type["ToolFixture<TToolSettings>"] class Type type-node

Syntax

public abstract class ToolFixture<TToolSettings> : ToolFixture<TToolSettings, ToolFixtureResult> 
    where TToolSettings : ToolSettings, new()

Type Parameters

Name Description
TToolSettings The type of the tool settings.

Constructors

Name Summary
ToolFixture(string) Initializes a new instance of the ToolFixture<TToolSettings> class.

Methods

Name Value Summary
CreateResult(FilePath, ProcessSettings) ToolFixtureResult
Creates the tool fixture result from the provided tool path and process settings.

Extension Methods

Name Value Summary
Dump<ToolFixture<TToolSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
GivenDefaultToolDoNotExist<TToolSettings, ToolFixtureResult>() void
Ensures that the tool does not exist under the tool settings tool path.
GivenProcessCannotStart<TToolSettings, ToolFixtureResult>() void
Ensures that the tool's process is unable to start.
GivenProcessExitsWithCode<TToolSettings, ToolFixtureResult>(int) void
Ensures that the tool process exits with the given exit code.
GivenSettingsToolPathExist<TToolSettings, ToolFixtureResult>() void
Ensures that the tool exist under the tool settings tool path.
IsIn<ToolFixture<TToolSettings>>(ToolFixture<TToolSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ToolFixture<TToolSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ToolFixture<TToolSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ToolFixture<TToolSettings>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ToolFixture<TToolSettings>>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin