DotNetTestSettings Class

Summary

Contains settings used by DotNetTester.
graph BT Type-->Base0["DotNetSettings"] click Base0 "/api/Cake.Common.Tools.DotNet/DotNetSettings" Base0-->Base1["ToolSettings"] click Base1 "/api/Cake.Core.Tooling/ToolSettings" Base1-->Base2["object"] Type["DotNetTestSettings"] class Type type-node

Syntax

public class DotNetTestSettings : DotNetSettings

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
Blame bool
Gets or sets a value indicating whether to run the tests in blame mode. This option is helpful in isolating a problematic test causing the test host to crash. Outputs a 'Sequence.xml' file in the current directory that captures the order of execution of test before the crash.
Collectors ICollection<string>
Gets or sets the data collectors for the test run.
Configuration string
Gets or sets the configuration under which to build.
DiagnosticFile FilePath
Gets or sets a file to write diagnostic messages to.
DiagnosticOutput bool
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
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
Filter string
Gets or sets the filter expression to filter out tests in the current project.
Framework string
Gets or sets specific framework to compile.
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
Loggers ICollection<string>
Gets or sets the loggers for test results.
MSBuildSettings DotNetMSBuildSettings
Gets or sets additional arguments to be passed to MSBuild.
NoBuild bool
Gets or sets a value indicating whether to not build the project before testing.
NoLogo bool
Gets or sets a value indicating whether to run tests without displaying the Microsoft TestPlatform banner.
NoRestore bool
Gets or sets a value indicating whether to not do implicit NuGet package restore. This makes build faster, but requires restore to be done before build is executed.
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
OutputDirectory DirectoryPath
Gets or sets the output directory.
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
ResultsDirectory DirectoryPath
Gets or sets the results directory. This setting is only available from 2.0.0 upward.
RollForward DotNetRollForward?
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
Runtime string
Gets or sets the target runtime to test for. This setting is only available from .NET Core 3.x upward.
Settings FilePath
Gets or sets the settings file to use when running tests.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
Sources ICollection<string>
Gets or sets the specified NuGet package sources to use during testing.
TestAdapterPath DirectoryPath
Gets or sets the path to use for the custom test adapter in the test run.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbosity DotNetVerbosity?
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
VSTestReportPath FilePath
Gets or sets the file path to write VSTest reports to.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<DotNetTestSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotNetTestSettings>(DotNetTestSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotNetTestSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DotNetTestSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<DotNetTestSettings>(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<DotNetTestSettings>(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<DotNetTestSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<DotNetTestSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<DotNetTestSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<DotNetTestSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<DotNetTestSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<DotNetTestSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<DotNetTestSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<DotNetTestSettings>(FilePath) T
Sets the tool path.
WithToolSettings<DotNetTestSettings>(Action<DotNetTestSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<DotNetTestSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<DotNetTestSettings>(DirectoryPath) T
Sets the tool working directory.