KarmaRunner<TSettings> Class

Summary

The karma runner for global mode execution.
Assembly
Cake.Karma.dll
Namespace
Cake.Karma
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Type["KarmaRunner<TSettings>"] class Type type-node Derived0["KarmaRunnerLocal<TSettings>"]-->Type click Derived0 "/api/Cake.Karma/KarmaRunnerLocal_1"

Syntax

public class KarmaRunner<TSettings> : Tool<TSettings> where TSettings : KarmaSettings, new()

Type Parameters

Name Description
TSettings The type of settings to provide for the relevant karma command (start, run, init).

Constructors

Properties

Name Value Summary
Environment ICakeEnvironment
A reference to the supplied ICakeEnvironment.
FileSystem IFileSystem
A reference to the supplied IFileSystem.

Methods

Name Value Summary
Execute(TSettings) void
Execute the runner with the specified settings.
GetToolExecutableNames() IEnumerable<string>
Available tool executable names for local karma runs.
GetToolName() string
The name of the tool, used during logging.
ValidateSettings(TSettings) void
Validates the provides settings for global mode.

Extension Methods

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