Class TestFrameworkOptions

Namespace

Xunit.Runner.Common

Assembly

xunit.v3.runner.common.dll

Represents options passed to a test framework for discovery or execution.

public class TestFrameworkOptions : ITestFrameworkDiscoveryOptions, ITestFrameworkExecutionOptions, ITestFrameworkOptions

Inheritance

object

TestFrameworkOptions

Implements

ITestFrameworkDiscoveryOptions

ITestFrameworkExecutionOptions

ITestFrameworkOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

TestFrameworkOptionsReadWriteExtensions.GetCulture(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetDiagnosticMessages(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetDiagnosticMessagesOrDefault(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetIncludeSourceInformation(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetIncludeSourceInformationOrDefault(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetInternalDiagnosticMessages(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetInternalDiagnosticMessagesOrDefault(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetMethodDisplay(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetMethodDisplayOptions(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetMethodDisplayOptionsOrDefault(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetMethodDisplayOrDefault(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetPreEnumerateTheories(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetPreEnumerateTheoriesOrDefault(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxEnumerableLength(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxObjectDepth(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxObjectMemberCount(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxStringLength(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetSynchronousMessageReporting(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.GetSynchronousMessageReportingOrDefault(ITestFrameworkDiscoveryOptions)

TestFrameworkOptionsReadWriteExtensions.SetCulture(ITestFrameworkDiscoveryOptions, string?)

TestFrameworkOptionsReadWriteExtensions.SetDiagnosticMessages(ITestFrameworkDiscoveryOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetIncludeSourceInformation(ITestFrameworkDiscoveryOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetInternalDiagnosticMessages(ITestFrameworkDiscoveryOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetMethodDisplay(ITestFrameworkDiscoveryOptions, TestMethodDisplay?)

TestFrameworkOptionsReadWriteExtensions.SetMethodDisplayOptions(ITestFrameworkDiscoveryOptions, TestMethodDisplayOptions?)

TestFrameworkOptionsReadWriteExtensions.SetPreEnumerateTheories(ITestFrameworkDiscoveryOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxEnumerableLength(ITestFrameworkDiscoveryOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxObjectDepth(ITestFrameworkDiscoveryOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxObjectMemberCount(ITestFrameworkDiscoveryOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxStringLength(ITestFrameworkDiscoveryOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetSynchronousMessageReporting(ITestFrameworkDiscoveryOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.GetAssertEquivalentMaxDepth(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetCulture(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetDiagnosticMessages(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetDiagnosticMessagesOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetDisableParallelization(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetDisableParallelizationOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetExplicitOption(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetExplicitOptionOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetFailSkips(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetFailSkipsOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetFailTestsWithWarnings(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetFailTestsWithWarningsOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetInternalDiagnosticMessages(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetInternalDiagnosticMessagesOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetMaxParallelThreads(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetMaxParallelThreadsOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetParallelAlgorithm(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetParallelAlgorithmOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxEnumerableLength(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxObjectDepth(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxObjectMemberCount(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetPrintMaxStringLength(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetSeed(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetShowLiveOutput(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetShowLiveOutputOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetStopOnTestFail(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetStopOnTestFailOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetSynchronousMessageReporting(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.GetSynchronousMessageReportingOrDefault(ITestFrameworkExecutionOptions)

TestFrameworkOptionsReadWriteExtensions.SetAssertEquivalentMaxDepth(ITestFrameworkExecutionOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetCulture(ITestFrameworkExecutionOptions, string?)

TestFrameworkOptionsReadWriteExtensions.SetDiagnosticMessages(ITestFrameworkExecutionOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetDisableParallelization(ITestFrameworkExecutionOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetExplicitOption(ITestFrameworkExecutionOptions, ExplicitOption?)

TestFrameworkOptionsReadWriteExtensions.SetFailSkips(ITestFrameworkExecutionOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetFailTestsWithWarnings(ITestFrameworkExecutionOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetInternalDiagnosticMessages(ITestFrameworkExecutionOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetMaxParallelThreads(ITestFrameworkExecutionOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetParallelAlgorithm(ITestFrameworkExecutionOptions, ParallelAlgorithm?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxEnumerableLength(ITestFrameworkExecutionOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxObjectDepth(ITestFrameworkExecutionOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxObjectMemberCount(ITestFrameworkExecutionOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetPrintMaxStringLength(ITestFrameworkExecutionOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetSeed(ITestFrameworkExecutionOptions, int?)

TestFrameworkOptionsReadWriteExtensions.SetShowLiveOutput(ITestFrameworkExecutionOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetStopOnTestFail(ITestFrameworkExecutionOptions, bool?)

TestFrameworkOptionsReadWriteExtensions.SetSynchronousMessageReporting(ITestFrameworkExecutionOptions, bool?)

Methods

Empty()

INTERNAL METHOD, FOR TESTING PURPOSES ONLY. DO NOT CALL.

public static TestFrameworkOptions Empty()

Returns

TestFrameworkOptions

ForDiscovery(TestAssemblyConfiguration)

Creates an instance of TestFrameworkOptions for discovery purposes.

public static ITestFrameworkDiscoveryOptions ForDiscovery(TestAssemblyConfiguration configuration)

Parameters

configuration TestAssemblyConfiguration

The configuration to copy values from.

Returns

ITestFrameworkDiscoveryOptions

ForDiscoveryFromSerialization(string)

Creates an instance of TestFrameworkOptions for discovery purposes.

public static ITestFrameworkDiscoveryOptions ForDiscoveryFromSerialization(string optionsJson)

Parameters

optionsJson string

The serialized discovery options.

Returns

ITestFrameworkDiscoveryOptions

ForExecution(TestAssemblyConfiguration)

Creates an instance of TestFrameworkOptions for execution purposes.

public static ITestFrameworkExecutionOptions ForExecution(TestAssemblyConfiguration configuration)

Parameters

configuration TestAssemblyConfiguration

The configuration to copy values from.

Returns

ITestFrameworkExecutionOptions

ForExecutionFromSerialization(string)

Creates an instance of TestFrameworkOptions for execution purposes.

public static ITestFrameworkExecutionOptions ForExecutionFromSerialization(string optionsJson)

Parameters

optionsJson string

The serialized execution options.

Returns

ITestFrameworkExecutionOptions

GetValue<TValue>(string)

Gets a value from the options collection.

public TValue? GetValue<TValue>(string name)

Parameters

name string

The name of the value.

Returns

TValue

Returns the value.

Type Parameters

TValue

The type of the value.

SetValue<TValue>(string, TValue)

Sets a value into the options collection.

public void SetValue<TValue>(string name, TValue value)

Parameters

name string

The name of the value.

value TValue

The value.

Type Parameters

TValue

The type of the value.

ToJson()

Converts the test framework options into JSON. Used for serializing the options for sending across a process boundary.

public string ToJson()

Returns

string

The serialized framework options.