Summary
Contains settings used by
XUnit2Runner
.
- Namespace
- Cake
.Common .Tools .XUnit - Base Types
-
- object
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
Type["XUnit2Settings"]
class Type type-node
Syntax
public sealed class XUnit2Settings : ToolSettings
Constructors
Name | Summary |
---|---|
XUnit2Settings |
Initializes a new instance of the XUnit2Settings 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
|
ClassesToInclude | ICollection |
Gets the class names to include.
|
EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
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
|
HtmlReport | bool |
Gets or sets a value indicating whether an HTML report should be generated.
|
JUnitReport | bool |
Gets or sets a value indicating whether an JUnit style XML report should be generated.
|
MaxThreads | int? |
Gets or sets the maximum thread count for collection parallelization.
|
MethodsToInclude | ICollection |
Gets the test methods to include.
|
NamespacesToInclude | ICollection |
Gets the namespaces to include.
|
NoAppDomain | bool |
Gets or sets a value indicating whether to not use app domains to run test code.
|
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
|
NUnitReport | bool |
Gets or sets a value indicating whether an NUnit style XML report should be generated.
|
OutputDirectory | DirectoryPath |
Gets or sets the output directory.
|
Parallelism | ParallelismOption? |
Gets or sets the parallelism option.
Corresponds to the -parallel command line switch.
|
PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
ReportName | string |
Gets or sets the name that should be used for the HTML and XML reports.
|
SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
ShadowCopy | bool |
Gets or sets a value indicating whether tests should be run as a shadow copy.
Default value is
true .
|
ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
TraitsToExclude | IDictionary |
Gets the traits to exclude.
|
TraitsToInclude | IDictionary |
Gets the traits to include.
|
UseX86 | bool |
Gets or sets a value indicating whether to run tests in using x86 test runner.
|
WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
XmlReport | bool |
Gets or sets a value indicating whether an XML report should be generated.
|
XmlReportV1 | bool |
Gets or sets a value indicating whether an xUnit.net v1 style XML report should be generated.
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
ExcludeTrait |
XUnit2Settings |
Adds a trait to the settings, to exclude in test execution.
|
IncludeClass |
XUnit2Settings |
Adds a class name to the settings, to include in test execution. Class name should be fully qualified; i.e., MyNameSpace.MyClassName.
|
IncludeMethod |
XUnit2Settings |
Adds a method name to the settings, to include in test execution. Method name should be fully qualified; i.e., MyNameSpace.MyClassName.MyMethod.
|
IncludeNamespace |
XUnit2Settings |
Adds a namespace to the settings, to include in test execution. Namespace should be fully qualified; i.e., MyNameSpace.MySubNamespace.
|
IncludeTrait |
XUnit2Settings |
Adds a trait to the settings, to include in test execution.
|
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 |
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 |
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.
|