Summary
Contains settings used by
DotNetTester
.
- Namespace
- Cake
.Common .Tools .DotNet .Test - Base Types
-
- object
- ToolSettings
- DotNetSettings
graph BT
Type-->Base0["DotNetSettings"]
click Base0 "/api/Cake.Common.Tools.DotNet/DotNetSettings"
Base0-->Base1["ToolSettings"]
click Base1 "/api/Cake.Core.Tooling/ToolSettings"
Base1-->Base2["object"]
Type["DotNetTestSettings"]
class Type type-node
Syntax
public class DotNetTestSettings : DotNetSettings
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
|
Blame | bool |
Gets or sets a value indicating whether to run the tests in blame mode. This option is helpful in isolating a problematic test causing the test host to crash.
Outputs a 'Sequence.xml' file in the current directory that captures the order of execution of test before the crash.
|
Collectors | ICollection |
Gets or sets the data collectors for the test run.
|
Configuration | string |
Gets or sets the configuration under which to build.
|
DiagnosticFile | FilePath |
Gets or sets a file to write diagnostic messages to.
|
DiagnosticOutput | bool |
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
|
EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
Filter | string |
Gets or sets the filter expression to filter out tests in the current project.
|
Framework | string |
Gets or sets specific framework to compile.
|
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
|
Loggers | ICollection |
Gets or sets the loggers for test results.
|
MSBuildSettings | Dot |
Gets or sets additional arguments to be passed to MSBuild.
|
NoBuild | bool |
Gets or sets a value indicating whether to not build the project before testing.
|
NoLogo | bool |
Gets or sets a value indicating whether to run tests without displaying the Microsoft TestPlatform banner.
|
NoRestore | bool |
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
|
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
|
OutputDirectory | DirectoryPath |
Gets or sets the output directory.
|
PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
ResultsDirectory | DirectoryPath |
Gets or sets the results directory. This setting is only available from 2.0.0 upward.
|
RollForward | DotNetRollForward? |
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
|
Runtime | string |
Gets or sets the target runtime to test for. This setting is only available from .NET Core 3.x upward.
|
Settings | FilePath |
Gets or sets the settings file to use when running tests.
|
SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
Sources | ICollection |
Gets or sets the specified NuGet package sources to use during testing.
|
TestAdapterPath | DirectoryPath |
Gets or sets the path to use for the custom test adapter in the test run.
|
ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
Verbosity | DotNetVerbosity? |
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
|
VSTestReportPath | FilePath |
Gets or sets the file path to write VSTest reports to.
|
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
|
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>) .
|
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.
|
WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
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.
|