NUnitSettings Class

Summary

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

Syntax

public sealed class NUnitSettings : ToolSettings

Constructors

Name Summary
NUnitSettings() Initializes a new instance of the NUnitSettings class.

Properties

Name Value Summary
AppDomainUsage NUnitAppDomainUsage
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
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
ErrorOutputFile FilePath
Gets or sets the location that NUnit should write test error output.
Exclude string
Gets or sets the categories to exclude from a run.
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
Include string
Gets or sets the categories to include in a run.
Labels bool
Gets or sets a value indicating whether to cause an identifying label to be displayed at the start of each test case.
NoLogo 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.
NoThread bool
Gets or sets a value indicating whether the main thread should be used for running tests.
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.
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
Process NUnitProcessOption
Gets or sets a value indicating how NUnit should load tests in processes. The Default value is Single.
ResultsFile FilePath
Gets or sets the name of the XML result file.
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 tests should be run as a shadow copy. Default value is true.
StopOnError bool
Gets or sets a value indicating whether execution of the test run should terminate immediately on the first test failure or error.
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
Trace string
Gets or sets the amount of information that NUnit should write to its internal trace log.
UseSingleThreadedApartment bool
Gets or sets a value indicating whether Single Threaded Apartment state (STA) will be used. Corresponds to the /apartment command line option.
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<NUnitSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<NUnitSettings>(NUnitSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NUnitSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NUnitSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<NUnitSettings>(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<NUnitSettings>(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
ToStringWithNullMarkup() string
Requires the Cake.Issues addin
WithArgumentCustomization<NUnitSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<NUnitSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<NUnitSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<NUnitSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<NUnitSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<NUnitSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<NUnitSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<NUnitSettings>(FilePath) T
Sets the tool path.
WithToolSettings<NUnitSettings>(Action<NUnitSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<NUnitSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<NUnitSettings>(DirectoryPath) T
Sets the tool working directory.