Summary
Contains settings used by
OpenCoverRunner
.
- Namespace
- Cake
.Common .Tools .OpenCover - Base Types
-
- object
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
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 |
---|---|---|
Argument |
Func |
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 |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
Excluded |
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.
|
HandleExitCode | Func |
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
|
HideSkippedOption | Open |
Gets or sets the hide skipped option of OpenCover.
|
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.
|
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
|
OldStyle | bool |
Gets or sets a value indicating whether the OldStyle option for OpenCover should be used.
|
PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
Register | Open |
Gets or sets the register option.
|
Return |
int? |
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.
|
SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
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 | 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 |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
ExcludeByAttribute |
OpenCoverSettings |
Exclude a class or method by filter
that match attributes that have been applied.
|
ExcludeByFile |
OpenCoverSettings |
Exclude a class (or methods) by filter that match the filenames.
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|
With |
T |
Sets the tool argument customization delegate.
|
With |
T |
Sets or adds tool environment variable.
|
WithExpectedExitCode |
T |
Sets expected exit code using
WithHandleExitCode<T>(T, Func<int, bool>) .
|
WithFilter |
OpenCoverSettings |
Adds the filter.
|
WithHandleExitCode |
T |
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
|
With |
T |
Sets whether the tool should use a working directory or not.
|
WithoutRegister |
OpenCoverSettings |
Sets the register-option to "none".
|
WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
WithRegisterAdmin |
OpenCoverSettings |
Sets the register-option to admin-registry-access.
|
WithRegisterDll |
OpenCoverSettings |
Sets the register-option to dll-registration (i.e no registry-access).
|
WithRegisterUser |
OpenCoverSettings |
Sets the register-option to user-registry-access.
|
With |
T |
Sets a delegate to configure the process settings.
|
WithToolPath |
T |
Sets the tool path.
|
WithToolSettings |
T |
Provides fluent null guarded tool settings action.
|
WithToolTimeout |
T |
Sets the tool timeout.
|
WithWorkingDirectory |
T |
Sets the tool working directory.
|