Class TestCollectionMessage

Namespace

Xunit.Runner.Common

Assembly

xunit.v3.runner.common.dll

Default implementation of ITestCollectionMessage.

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

Inheritance

object

MessageSinkMessage

TestAssemblyMessage

TestCollectionMessage

Implements

IJsonDeserializable

ITestCollectionMessage

ITestAssemblyMessage

IMessageSinkMessage

IJsonSerializable

Derived

TestClassMessage

TestCollectionCleanupFailure

TestCollectionFinished

TestCollectionStarting

Inherited Members

TestAssemblyMessage.AssemblyUniqueID

MessageSinkMessage.EmptyTraits

MessageSinkMessage.UnsetStringPropertyValue

MessageSinkMessage.FromJson(IReadOnlyDictionary<string, object>)

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)

Extension Methods

MessageSinkMessageExtensions.DispatchWhen<TMessage>(IMessageSinkMessage, MessageHandler<TMessage>?)

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

Remarks

Note: Will be UnsetStringPropertyValue if there was no value provided during deserialization.

Methods

Deserialize(IReadOnlyDictionary<string, object?>)

Override to deserialize the values in the dictionary into the message.

protected override void Deserialize(IReadOnlyDictionary<string, object?> root)

Parameters

root IReadOnlyDictionary<string, object>

The root of the JSON object

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