OpenCoverSettings Class

Summary

Contains settings used by OpenCoverRunner.
Namespace
Cake.Common.Tools.OpenCover
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["OpenCoverSettings"] class Type type-node

Syntax

public sealed class OpenCoverSettings : ToolSettings

Constructors

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

Properties

Name Value Summary
ArgumentCustomization Func<T, TResult>
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
EnvironmentVariables IDictionary<TKey, TValue>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
ExcludedAttributeFilters ISet<>
Gets attribute filters used to exclude classes or methods. This represents the -excludebyattribute option.
ExcludedFileFilters ISet<>
Gets file filters used to excluded classes or methods. This represents the -excludebyfile option.
ExcludeDirectories ISet<>
Gets a list of directories where assemblies being loaded from will be ignored.
Filters ISet<>
Gets the filters. This represents the -filter option.
IsService bool
Gets or sets a value indicating whether if the value provided in the target parameter is the name of a service rather than a name of a process.
LogLevel OpenCoverLogLevel
Gets or sets the log level of OpenCover.
MergeByHash bool
Gets or sets a value indicating whether to merge the coverage results for an assembly regardless of where it was loaded assuming it has the same file-hash in each location.
MergeOutput bool
Gets or sets a value indicating whether to merge the results with an existing file
NoDefaultFilters bool
Gets or sets a value indicating whether the default filters should be applied or not.
OldStyle bool
Gets or sets a value indicating whether the OldStyle option for OpenCover should be used
Register string
Gets or sets the register option
ReturnTargetCodeOffset Nullable<T>
Gets or sets the Return target code offset to be used
SearchDirectories ISet<>
Gets a list of directories with alternative locations to look for PDBs.
SkipAutoProps bool
Gets or sets a value indicating whether or not auto-implemented properties should be skipped.
TargetDirectory DirectoryPath
Gets or sets a value indicating the path to the target directory. If the target already contains a path, this parameter can be used as additional path where PDBs may be found.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout Nullable<T>
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<OpenCoverSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ExcludeByAttribute(string) OpenCoverSettings
Exclude a class or method by filter that match attributes that have been applied.
ExcludeByFile(string) OpenCoverSettings
Exclude a class (or methods) by filter that match the filenames.
IsIn<OpenCoverSettings>(OpenCoverSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<OpenCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<OpenCoverSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<OpenCoverSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<OpenCoverSettings>(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
WithFilter(string) OpenCoverSettings
Adds the filter.