Class TestCaseStarting

Namespace

Xunit.v3

Assembly

xunit.v3.core.dll

Default implementation of ITestCaseStarting.

[JsonTypeID("test-case-starting")]
public sealed class TestCaseStarting : TestCaseMessage, ITestCaseStarting, ITestCaseMessage, ITestMethodMessage, ITestClassMessage, ITestCollectionMessage, ITestAssemblyMessage, IMessageSinkMessage, IJsonSerializable, ITestCaseMetadata

Inheritance

object

MessageSinkMessage

TestAssemblyMessage

TestCollectionMessage

TestClassMessage

TestMethodMessage

TestCaseMessage

TestCaseStarting

Implements

ITestCaseStarting

ITestCaseMessage

ITestMethodMessage

ITestClassMessage

ITestCollectionMessage

ITestAssemblyMessage

IMessageSinkMessage

IJsonSerializable

ITestCaseMetadata

Inherited Members

TestCaseMessage.TestCaseUniqueID

TestMethodMessage.TestMethodUniqueID

TestClassMessage.TestClassUniqueID

TestCollectionMessage.TestCollectionUniqueID

TestAssemblyMessage.AssemblyUniqueID

MessageSinkMessage.ValidateObjectState()

MessageSinkMessage.ToJson()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Explicit

Gets a flag indicating whether this test case was marked as explicit or not.

public required bool Explicit { get; set; }

Property Value

bool

SkipReason

Gets the display text for the reason a test is being skipped; if the test is not statically skipped, returns null. (A test may be dynamically skipped at runtime while still returning null.)

public required string? SkipReason { get; set; }

Property Value

string

SourceFilePath

Gets the source file name. A null value indicates that the source file name is not known.

public required string? SourceFilePath { get; set; }

Property Value

string

SourceLineNumber

Gets the source file line number. A null value indicates that the source file line number is not known.

public required int? SourceLineNumber { get; set; }

Property Value

int?

TestCaseDisplayName

Gets the display name of the test case.

public required string TestCaseDisplayName { get; set; }

Property Value

string

TestClassMetadataToken

Gets the MetadataToken for the test class. If the test did not originate in a class, will return null.

public required int? TestClassMetadataToken { get; set; }

Property Value

int?

Remarks

This value is only populated for xUnit.net v3 or later test cases, and will return null for v1 or v2 test cases, regardless of whether TestClassName is null.

TestClassName

Gets the full name of the class where the test is defined (i.e., FullName). If the test did not originiate in a class, will return null.

public required string? TestClassName { get; set; }

Property Value

string

TestClassNamespace

Gets the namespace of the class where the test is defined. If the test did not originate in a class, or the class it originated in does not reside in a namespace, will return null.

public required string? TestClassNamespace { get; set; }

Property Value

string

TestClassSimpleName

Gets the simple name of the class where the test is defined (the class name without namespace). If the test did not originiate in a class, will return null.

public required string? TestClassSimpleName { get; set; }

Property Value

string

TestMethodMetadataToken

Gets the MetadataToken for the test method. If the test did not originate in a method, or the test framework did not provide this information, will return null.

public required int? TestMethodMetadataToken { get; set; }

Property Value

int?

Remarks

This value is only populated for xUnit.net v3 or later test cases, and will return null for v1 or v2 test cases, regardless of whether TestMethodName is null.

TestMethodName

Gets the method name where the test is defined, in the TestClassName class. If the test did not originiate in a method, will return null.

public required string? TestMethodName { get; set; }

Property Value

string

TestMethodParameterTypesVSTest

Gets the types for the test method parameters. If the test did not originate in a method, or the test framework does not provide this information, will return null; if the test method has no parameters, will return an empty array.

public required string[]? TestMethodParameterTypesVSTest { get; set; }

Property Value

string[]

Remarks

The values here are formatted according to VSTest rules in order to support Test Explorer. Note that this is not the same as FullName.

TestMethodReturnTypeVSTest

Gets the test method return type. If the test did not originate in a method, or the test framework did not provide this information, will return null.

public required string? TestMethodReturnTypeVSTest { get; set; }

Property Value

string

Remarks

The value here is formatted according to VSTest rules in order to support Test Explorer. Note that this is not the same as FullName.

Traits

Gets the trait values associated with this test case. If there are none, or the framework does not support traits, this should return an empty dictionary (not null).

public required IReadOnlyDictionary<string, IReadOnlyCollection<string>> Traits { get; set; }

Property Value

IReadOnlyDictionary<string, IReadOnlyCollection<string>>

Methods

Serialize(JsonObjectSerializer)

Override to serialize the values in the message into JSON.

protected override void Serialize(JsonObjectSerializer serializer)

Parameters

serializer JsonObjectSerializer

The serializer to write values to.

ToString()

public override string ToString()

Returns

string

ValidateObjectState(HashSet<string>)

Called before serializing the message. Implementers are expected to call ValidatePropertyIsNotNull(object?, string, HashSet<string>) for each property that must have a value, to record invalid property values into the provided hash set.

protected override void ValidateObjectState(HashSet<string> invalidProperties)

Parameters

invalidProperties HashSet<string>

The hash set to record invalid properties into