Summary
Contains settings used by
DotNetVSTester.
- Namespace
- Cake
.Common .Tools .DotNet .VSTest - 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["DotNetVSTestSettings"]
class Type type-node
Syntax
public class DotNetVSTestSettings : DotNetSettingsConstructors
| Name | Summary |
|---|---|
| DotNetVSTestSettings |
Initializes a new instance of the DotNetVSTestSettings 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
|
| Arguments | IDictionary |
Gets or sets a list of extra arguments that should be passed to adapter.
|
| 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
|
| Framework | string |
Gets or sets specific .Net Framework version to be used for test execution.
|
| 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
|
| Logger | string |
Gets or sets a logger for test results.
|
| 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
|
| Parallel | bool |
Gets or sets a value indicating whether the tests should be executed in parallel.
|
| ParentProcessId | string |
Gets or sets the Process Id of the Parent Process responsible for launching current process.
|
| Platform | VSTestPlatform |
Gets or sets the target platform architecture to be used for test execution.
|
| Port | int? |
Gets or sets the Port for socket connection and receiving the event messages.
|
| PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
| ResultsDirectory | DirectoryPath |
Gets or sets the path to put the test results in.
|
| RollForward | DotNetRollForward? |
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
|
| 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
|
| TestAdapterPath | DirectoryPath |
Gets or sets the path to use for the custom test adapter in the test run.
|
| TestCaseFilter | string |
Gets or sets the filter expression to run test that match.
|
| TestsToRun | ICollection |
Gets or sets the a list tests to 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
|
| 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 IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp 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.
|