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.

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.)

SourceFilePath

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

SourceLineNumber

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

TestCaseDisplayName

Gets the display name of the test case.

TestClassMetadataToken

Gets the MetadataToken for the test class. If the test did not originate in a class, will return 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.

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.

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.

TestMethodArity

Gets the arity (number of generic types) on the method itself. If the test did not originate in a method, will return null.

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.

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.

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.

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.

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).

Methods

Serialize(JsonObjectSerializer)

Override to serialize the values in the message into JSON.

ToString()

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.