XUnit2Settings Class

Summary

Contains settings used by XUnit2Runner.
Namespace
Cake.Common.Tools.XUnit
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 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
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
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<string>
Gets the class names to include.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
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<string>
Gets the test methods to include.
NamespacesToInclude ICollection<string>
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.
ReportName string
Gets or sets the name that should be used for the HTML and XML reports.
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<string, IList<string>>
Gets the traits to exclude.
TraitsToInclude IDictionary<string, IList<string>>
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<XUnit2Settings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ExcludeTrait(string, string[]) XUnit2Settings
Adds a trait to the settings, to exclude in test execution.
IncludeClass(string) XUnit2Settings
Adds a class name to the settings, to include in test execution. Class name should be fully qualified; i.e., MyNameSpace.MyClassName
IncludeMethod(string) 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(string) XUnit2Settings
Adds a namespace to the settings, to include in test execution. Namespace should be fully qualified; i.e., MyNameSpace.MySubNamespace
IncludeTrait(string, string[]) XUnit2Settings
Adds a trait to the settings, to include in test execution.
IsIn<XUnit2Settings>(XUnit2Settings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<XUnit2Settings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<XUnit2Settings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<XUnit2Settings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<XUnit2Settings>(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