DotCoverCoverSettings Class

Summary

Contains settings used by DotCoverCoverer.
Namespace
Cake.Common.Tools.DotCover.Cover
Base Types
graph BT Type-->Base0["DotCoverCoverageSettings"] click Base0 "/api/Cake.Common.Tools.DotCover/DotCoverCoverageSettings" Base0-->Base1["DotCoverSettings"] click Base1 "/api/Cake.Common.Tools.DotCover/DotCoverSettings" Base1-->Base2["ToolSettings"] click Base2 "/api/Cake.Core.Tooling/ToolSettings" Base2-->Base3["object"] Type["DotCoverCoverSettings"] class Type type-node

Syntax

public sealed class DotCoverCoverSettings : DotCoverCoverageSettings

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
ExcludeAssemblies ISet<string>
Gets assembly names to exclude from analysis. Wildcards (*) allowed. This represents the --exclude-assemblies option.
ExcludeAttributes ISet<string>
Gets fully qualified attribute names to exclude from analysis. Wildcards (*) allowed. Code marked with these attributes will be excluded from coverage. This represents the --exclude-attributes option.
ExcludeProcesses ISet<string>
Gets process names to ignore during analysis. Wildcards (*) allowed. This represents the --exclude-processes option.
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
JsonReportCoveringTestsScope DotCoverReportScope?
Gets or sets the granularity for including covering tests in JSON reports. This represents the --json-report-covering-tests-scope option.
JsonReportOutput FilePath
Gets or sets the path to save formatted JSON report. This represents the --json-report-output option.
LogFile FilePath
Gets or sets a value that enables logging and specifies log file name This represents the /LogFile option.
Inherited from DotCoverSettings
NoNGen bool
Gets or sets a value indicating whether to disable loading of NGen images during coverage. This represents the --no-ngen option.
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 --target-working-directory option for Cover command, /TargetWorkingDir for others.
TemporaryDirectory DirectoryPath
Gets or sets the directory for temporary files. This represents the --temporary-directory 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
UseApi bool
Gets or sets a value indicating whether to control the coverage session using the profiler API. This represents the --use-api option.
UseLegacySyntax bool
Gets or sets a value indicating whether to use the legacy command syntax. When true, uses old format like '/TargetExecutable="/path"'. When false, uses new format like '--target-executable "/path"'. Default is false (new format).
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
XmlReportCoveringTestsScope DotCoverReportScope?
Gets or sets the granularity for including covering tests in XML reports. This represents the --xml-report-covering-tests-scope option.
XmlReportOutput FilePath
Gets or sets the path to save formatted XML report. This represents the --xml-report-output option.

Extension Methods

Name Value Summary
Dump<DotCoverCoverSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotCoverCoverSettings>(DotCoverCoverSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotCoverCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<DotCoverCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<DotCoverCoverSettings>(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<DotCoverCoverSettings>(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<DotCoverCoverSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithAttributeFilter<DotCoverCoverSettings>(string) T
Adds the attribute filter.
WithConfigFile<DotCoverCoverSettings>(FilePath) T
Adds the scope.
WithEnvironmentVariable<DotCoverCoverSettings>(string, string) T
Sets or adds tool environment variable.
WithExcludeAssembly<DotCoverCoverSettings>(string) T
Adds an assembly name to exclude from analysis.
WithExcludeAttribute<DotCoverCoverSettings>(string) T
Adds a fully qualified attribute name to exclude from analysis.
WithExcludeProcess<DotCoverCoverSettings>(string) T
Adds a process name to ignore during analysis.
WithExpectedExitCode<DotCoverCoverSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithFilter<DotCoverCoverSettings>(string) T
Adds the filter.
WithHandleExitCode<DotCoverCoverSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithJsonReportCoveringTestsScope(DotCoverReportScope) DotCoverCoverSettings
Sets the JSON report covering tests scope.
WithJsonReportOutput(FilePath) DotCoverCoverSettings
Sets the JSON report output path.
WithLegacySyntax(bool) DotCoverCoverSettings
Configures whether to use legacy command syntax.
WithNoNGen(bool) DotCoverCoverSettings
Disables loading of NGen images during coverage.
WithNoWorkingDirectory<DotCoverCoverSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<DotCoverCoverSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithProcessFilter<DotCoverCoverSettings>(string) T
Adds the filter.
WithScope<DotCoverCoverSettings>(string) T
Adds the scope.
WithSetupProcessSettings<DotCoverCoverSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithTemporaryDirectory(DirectoryPath) DotCoverCoverSettings
Sets the temporary directory for files.
WithToolPath<DotCoverCoverSettings>(FilePath) T
Sets the tool path.
WithToolSettings<DotCoverCoverSettings>(Action<DotCoverCoverSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<DotCoverCoverSettings>(TimeSpan) T
Sets the tool timeout.
WithUseApi(bool) DotCoverCoverSettings
Enables control of the coverage session using the profiler API.
WithWorkingDirectory<DotCoverCoverSettings>(DirectoryPath) T
Sets the tool working directory.
WithXmlReportCoveringTestsScope(DotCoverReportScope) DotCoverCoverSettings
Sets the XML report covering tests scope.
WithXmlReportOutput(FilePath) DotCoverCoverSettings
Sets the XML report output path.