Class TestCollectionMessage

Namespace

Xunit.v3

Assembly

xunit.v3.core.dll

Default implementation of ITestCollectionMessage.

public abstract class TestCollectionMessage : TestAssemblyMessage, ITestCollectionMessage, ITestAssemblyMessage, IMessageSinkMessage, IJsonSerializable

Inheritance

object

MessageSinkMessage

TestAssemblyMessage

TestCollectionMessage

Implements

ITestCollectionMessage

ITestAssemblyMessage

IMessageSinkMessage

IJsonSerializable

Derived

TestClassMessage

TestCollectionCleanupFailure

TestCollectionFinished

TestCollectionStarting

Inherited Members

TestAssemblyMessage.AssemblyUniqueID

MessageSinkMessage.ValidateObjectState()

MessageSinkMessage.ValidatePropertyIsNotNull(object, string, HashSet<string>)

MessageSinkMessage.ToDisplayString(string[])

MessageSinkMessage.ToDisplayString<T>(T[])

MessageSinkMessage.ToJson()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

TestCollectionUniqueID

Gets the test collection's unique ID. Can be used to correlate test messages with the appropriate test collection that they're related to.

public required string TestCollectionUniqueID { get; set; }

Property Value

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