DotNetCoreTestSettings Class

Summary

Contains settings used by DotNetCoreTester.
Namespace
Cake.Common.Tools.DotNetCore.Test
Base Types
graph BT Type-->Base0["DotNetTestSettings"] click Base0 "/api/Cake.Common.Tools.DotNet.Test/DotNetTestSettings" Base0-->Base1["DotNetSettings"] click Base1 "/api/Cake.Common.Tools.DotNet/DotNetSettings" Base1-->Base2["ToolSettings"] click Base2 "/api/Cake.Core.Tooling/ToolSettings" Base2-->Base3["object"] Type["DotNetCoreTestSettings"] class Type type-node

Syntax

public sealed class DotNetCoreTestSettings : DotNetTestSettings

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.
Inherited from DotNetTestSettings
Collectors ICollection<string>
Gets or sets the data collectors for the test run.
Inherited from DotNetTestSettings
Configuration string
Gets or sets the configuration under which to build.
Inherited from DotNetTestSettings
DiagnosticFile FilePath
Gets or sets a file to write diagnostic messages to.
Inherited from DotNetTestSettings
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.
Inherited from DotNetTestSettings
Framework string
Gets or sets specific framework to compile.
Inherited from DotNetTestSettings
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
Logger string
Gets or sets a logger for test results.
Inherited from DotNetTestSettings
Loggers ICollection<string>
Gets or sets the loggers for test results.
Inherited from DotNetTestSettings
NoBuild bool
Gets or sets a value indicating whether to not build the project before testing.
Inherited from DotNetTestSettings
NoLogo bool
Gets or sets a value indicating whether to run tests without displaying the Microsoft TestPlatform banner.
Inherited from DotNetTestSettings
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.
Inherited from DotNetTestSettings
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.
Inherited from DotNetTestSettings
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.
Inherited from DotNetTestSettings
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.
Inherited from DotNetTestSettings
Settings FilePath
Gets or sets the settings file to use when running tests.
Inherited from DotNetTestSettings
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.
Inherited from DotNetTestSettings
TestAdapterPath DirectoryPath
Gets or sets the path to use for the custom test adapter in the test run.
Inherited from DotNetTestSettings
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.
Inherited from DotNetTestSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<DotNetCoreTestSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotNetCoreTestSettings>(DotNetCoreTestSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotNetCoreTestSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DotNetCoreTestSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DotNetCoreTestSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DotNetCoreTestSettings>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin