NUnit3Settings Class

Summary

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

Syntax

public sealed class NUnit3Settings : ToolSettings

Properties

Name Value Summary
Agents int?
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<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
ConfigFile FilePath
Gets or sets a value indicating the path to an alternative app.config file to load.
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<string, string>
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 the version of the runtime to be used when executing tests.
HandleExitCode Func<int, bool>
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
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.
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
OutputFile FilePath
Gets or sets the location that NUnit should write test output.
Params IDictionary<string, string>
Gets or sets the parameters that should be passed to the runner.
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
Process NUnit3ProcessOption
Gets or sets a value indicating how NUnit should load tests in processes. The Default value is Multiple.
Results ICollection<NUnit3Result>
Gets or sets the results that should be saved.
Seed int?
Gets or sets the random seed used to generate test cases.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
ShadowCopy bool
Gets or sets a value indicating whether to shadow copy tests. Default value is false.
SkipNonTestAssemblies bool
Gets or sets a value indicating whether execution of the test run should skip any non-test assemblies specified, without error.
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.
TestParams IDictionary<string, string>
Gets or sets the test parameters that should be passed to the runner.
Timeout int?
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 TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
TraceLevel NUnitInternalTraceLevel?
Gets or sets the level of detail at which the runner should write to its internal trace log. Corresponds to the -trace=LEVEL command line argument. If null, no argument will be specified.
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 int?
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.
Requires the Cake.Incubator addin
IsIn<NUnit3Settings>(NUnit3Settings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NUnit3Settings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NUnit3Settings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<NUnit3Settings>(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
ThrowIfNull<NUnit3Settings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
WithArgumentCustomization<NUnit3Settings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<NUnit3Settings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<NUnit3Settings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<NUnit3Settings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<NUnit3Settings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<NUnit3Settings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<NUnit3Settings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<NUnit3Settings>(FilePath) T
Sets the tool path.
WithToolSettings<NUnit3Settings>(Action<NUnit3Settings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<NUnit3Settings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<NUnit3Settings>(DirectoryPath) T
Sets the tool working directory.