DotCoverCoverageSettings Class

Summary

Contains settings used by DotCoverTool<TSettings>.
Namespace
Cake.Common.Tools.DotCover
Base Types
Derived Types
graph BT Type-->Base0["DotCoverSettings"] click Base0 "/api/Cake.Common.Tools.DotCover/DotCoverSettings" Base0-->Base1["ToolSettings"] click Base1 "/api/Cake.Core.Tooling/ToolSettings" Base1-->Base2["object"] Type["DotCoverCoverageSettings"] class Type type-node Derived0["DotCoverCoverSettings"]-->Type click Derived0 "/api/Cake.Common.Tools.DotCover.Cover/DotCoverCoverSettings" Derived1["DotCoverAnalyseSettings"]-->Type click Derived1 "/api/Cake.Common.Tools.DotCover.Analyse/DotCoverAnalyseSettings"

Syntax

public abstract class DotCoverCoverageSettings : DotCoverSettings

Constructors

Name Summary
DotCoverCoverageSettings() Initializes a new instance of the DotCoverCoverageSettings class.

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
AttributeFilters ISet<string>
Gets the attribute filters using the following syntax: filter1;filter2;... Asterisk wildcard(*) is supported here This represents the /AttributeFilters option.
ConfigFile FilePath
Gets or sets a value that enables DotCover configuration file. A configuration file is a reasonable alternative to specifying all parameters in-line or having them in a batch file.
Inherited from DotCoverSettings
DisableDefaultFilters bool
Gets or sets a value indicating whether the default (automatically added) filters should be disabled This represents the /DisableDefaultFilters option.
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
Filters ISet<string>
Gets the coverage filters using the following syntax: +:module=*;class=*;function=*; Use -:myassembly to exclude an assembly from code coverage. Asterisk wildcard (*) is supported here. This represents the /Filters option.
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
LogFile FilePath
Gets or sets a value that enables logging and specifies log file name This represents the /LogFile option.
Inherited from DotCoverSettings
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
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
ProcessFilters ISet<string>
Gets the coverage process filters using the following syntax: +:test.exe;program.exe*; Use -:anexe to exclude an assembly from code coverage. This represents the /ProcessFilters option.
Scope ISet<string>
Gets the assemblies loaded in the specified scope into coverage results. Ant-style patterns are supported here (e.g.ProjectFolder/**/*.dll) This represents the /Scope option.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
TargetWorkingDir DirectoryPath
Gets or sets program working directory This represents the /TargetWorkingDir option.
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

Extension Methods

Name Value Summary
Dump<DotCoverCoverageSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotCoverCoverageSettings>(DotCoverCoverageSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotCoverCoverageSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<DotCoverCoverageSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<DotCoverCoverageSettings>(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<DotCoverCoverageSettings>(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
WithArgumentCustomization<DotCoverCoverageSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithAttributeFilter<DotCoverCoverageSettings>(string) T
Adds the attribute filter.
WithConfigFile<DotCoverCoverageSettings>(FilePath) T
Adds the scope.
WithEnvironmentVariable<DotCoverCoverageSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<DotCoverCoverageSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithFilter<DotCoverCoverageSettings>(string) T
Adds the filter.
WithHandleExitCode<DotCoverCoverageSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<DotCoverCoverageSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<DotCoverCoverageSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithProcessFilter<DotCoverCoverageSettings>(string) T
Adds the filter.
WithScope<DotCoverCoverageSettings>(string) T
Adds the scope.
WithSetupProcessSettings<DotCoverCoverageSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<DotCoverCoverageSettings>(FilePath) T
Sets the tool path.
WithToolSettings<DotCoverCoverageSettings>(Action<DotCoverCoverageSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<DotCoverCoverageSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<DotCoverCoverageSettings>(DirectoryPath) T
Sets the tool working directory.