DotNetCoreVSTestSettings Class

Summary

Contains settings used by DotNetCoreVSTester.
graph BT Type-->Base0["DotNetVSTestSettings"] click Base0 "/api/Cake.Common.Tools.DotNet.VSTest/DotNetVSTestSettings" 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["DotNetCoreVSTestSettings"] class Type type-node

Syntax

public sealed class DotNetCoreVSTestSettings : DotNetVSTestSettings

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
Arguments IDictionary<string, string>
Gets or sets a list of extra arguments that should be passed to adapter.
Inherited from DotNetVSTestSettings
DiagnosticFile FilePath
Gets or sets a file to write diagnostic messages to.
Inherited from DotNetVSTestSettings
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
Framework string
Gets or sets specific .Net Framework version to be used for test execution.
Inherited from DotNetVSTestSettings
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 DotNetVSTestSettings
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
Parallel bool
Gets or sets a value indicating whether the tests should be executed in parallel.
Inherited from DotNetVSTestSettings
ParentProcessId string
Gets or sets the Process Id of the Parent Process responsible for launching current process.
Inherited from DotNetVSTestSettings
Platform VSTestPlatform
Gets or sets the target platform architecture to be used for test execution.
Inherited from DotNetVSTestSettings
Port int?
Gets or sets the Port for socket connection and receiving the event messages.
Inherited from DotNetVSTestSettings
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 path to put the test results in.
Inherited from DotNetVSTestSettings
RollForward DotNetRollForward?
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
Settings FilePath
Gets or sets the settings file to use when running tests.
Inherited from DotNetVSTestSettings
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
TestAdapterPath DirectoryPath
Gets or sets the path to use for the custom test adapter in the test run.
Inherited from DotNetVSTestSettings
TestCaseFilter string
Gets or sets the filter expression to run test that match.
Inherited from DotNetVSTestSettings
TestsToRun ICollection<string>
Gets or sets the a list tests to run.
Inherited from DotNetVSTestSettings
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
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

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