Class TestCollectionStarting

Namespace

Xunit.Runner.Common

Assembly

xunit.v3.runner.common.dll

Default implementation of ITestCollectionStarting.

[JsonTypeID("test-collection-starting")]
public sealed class TestCollectionStarting : TestCollectionMessage, IJsonDeserializable, ITestCollectionStarting, ITestCollectionMessage, ITestAssemblyMessage, IMessageSinkMessage, IJsonSerializable, ITestCollectionMetadata

Inheritance

object

MessageSinkMessage

TestAssemblyMessage

TestCollectionMessage

TestCollectionStarting

Implements

IJsonDeserializable

ITestCollectionStarting

ITestCollectionMessage

ITestAssemblyMessage

IMessageSinkMessage

IJsonSerializable

ITestCollectionMetadata

Inherited Members

TestCollectionMessage.TestCollectionUniqueID

TestAssemblyMessage.AssemblyUniqueID

MessageSinkMessage.UnsetStringPropertyValue

MessageSinkMessage.FromJson(IReadOnlyDictionary<string, object>)

MessageSinkMessage.ToJson()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

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

Properties

TestCollectionClassName

Gets the type that the test collection was defined with, if available; may be null if the test collection didn't have a definition type.

public required string? TestCollectionClassName { get; set; }

Property Value

string

Remarks

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

TestCollectionDisplayName

Gets the display name of the test collection.

public required string TestCollectionDisplayName { get; set; }

Property Value

string

Remarks

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

Traits

Gets the trait values associated with this test collection (and the test assembly). If there are none, or the framework does not support traits, this returns an empty dictionary (not null).

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

Property Value

IReadOnlyDictionary<string, IReadOnlyCollection<string>>

Remarks

Note: Will be an empty dictionary 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