Class TestCollectionStarting

Namespace

Xunit.v3

Assembly

xunit.v3.core.dll

Default implementation of ITestCollectionStarting.

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

Inheritance

object

MessageSinkMessage

TestAssemblyMessage

TestCollectionMessage

TestCollectionStarting

Implements

ITestCollectionStarting

ITestCollectionMessage

ITestAssemblyMessage

IMessageSinkMessage

IJsonSerializable

ITestCollectionMetadata

Inherited Members

TestCollectionMessage.TestCollectionUniqueID

TestAssemblyMessage.AssemblyUniqueID

MessageSinkMessage.ValidateObjectState()

MessageSinkMessage.ToJson()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

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

TestCollectionDisplayName

Gets the display name of the test collection.

public required string TestCollectionDisplayName { get; set; }

Property Value

string

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

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