NUnit3Settings Class

Summary

Contains settings used by NUnit3Runner.
Namespace
Cake.Common.Tools.NUnit
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["NUnit3Settings"] class Type type-node

Syntax

public sealed class NUnit3Settings : ToolSettings

Properties

Name Value Summary
Agents Nullable<T>
Gets or sets the maximum number of test assembly agents to run at one time. If not specified, there is no limit.
AppDomainUsage NUnit3AppDomainUsage
Gets or sets a value to control creation of AppDomains for running tests. Corresponds to the /domain command line switch. The default is to use multiple domains if multiple assemblies are listed on the command line, otherwise a single domain is used.
ArgumentCustomization Func<T, TResult>
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
Configuration string
Gets or sets the name of a project configuration to load (e.g.:Debug). This selects the configuration within the NUnit project file.
DisposeRunners bool
Gets or sets a value indicating whether to Dispose each test runner after it has finished running its tests.
EnvironmentVariables IDictionary<TKey, TValue>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
ErrorOutputFile FilePath
Gets or sets the location that NUnit should write test error output.
Framework string
Gets or sets the version of the runtime to be used when executing tests.
Full bool
Gets or sets a value indicating whether to print full report of all test results.
Labels NUnit3Labels
Gets or sets a value specifying whether to write test case names to the output.
NoColor bool
Gets or sets a value indicating whether to show the output in color.
NoHeader bool
Gets or sets a value indicating whether to show copyright information at the start of the program.
NoResults bool
Gets or sets a value indicating whether to generate the XML result file.
OutputFile FilePath
Gets or sets the location that NUnit should write test output.
Params IDictionary<TKey, TValue>
Gets or sets the params that should be passed to the runner.
Process NUnit3ProcessOption
Gets or sets a value indicating how NUnit should load tests in processes. The Default value is Multiple.
Results ICollection<T>
Gets or sets the results that should be saved.
Seed Nullable<T>
Gets or sets the random seed used to generate test cases.
ShadowCopy bool
Gets or sets a value indicating whether to shadow copy tests. Default value is false.
StopOnError bool
Gets or sets a value indicating whether execution of the test run should terminate immediately on the first test failure or error.
TeamCity bool
Gets or sets a value indicating whether to turn on TeamCity service messages.
Test string
Gets or sets the list of tests to run or explore.
TestList FilePath
Gets or sets a file containing the tests to run.
Timeout Nullable<T>
Gets or sets the default timeout to be used for test cases in this run. If any test exceeds the timeout value, it is cancelled and reported as an error.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout Nullable<T>
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbose bool
Gets or sets a value indicating whether to show additional information as the tests run.
Where string
Gets or sets the test selection expression indicating what tests will be run.
Work DirectoryPath
Gets or sets the directory to use for output files. If not specified, defaults to the current directory.
Workers Nullable<T>
Gets or sets the number of worker threads to be used in running tests.If not specified, defaults to 2 or the number of processors, whichever is greater.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
X86 bool
Gets or sets a value indicating whether to run tests in an x86 process on 64 bit systems.

Extension Methods

Name Value Summary
Dump<NUnit3Settings>() string
Get a basic string representation of specified object.
IsIn<NUnit3Settings>(NUnit3Settings[]) bool
Checks if the source is contained in a list
NotNull<NUnit3Settings>(string) void
Throws an exception if the specified parameter's value is null.
NotNull<NUnit3Settings>(string) void
Throws an exception if the specified parameter's value is null.
ThrowIfNull<NUnit3Settings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<NUnit3Settings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value