Class XunitTestCollectionRunner

Namespace

Xunit.v3

Assembly

xunit.v3.core.dll

The test collection runner for xUnit.net v3 tests.

public class XunitTestCollectionRunner : XunitTestCollectionRunnerBase<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>

Inheritance

object

TestCollectionRunner<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>

XunitTestCollectionRunnerBase<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>

XunitTestCollectionRunner

Inherited Members

XunitTestCollectionRunnerBase<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.GetTestCaseOrderer(XunitTestCollectionRunnerContext)

XunitTestCollectionRunnerBase<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.OnTestCollectionFinished(XunitTestCollectionRunnerContext, RunSummary)

XunitTestCollectionRunnerBase<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.OnTestCollectionStarting(XunitTestCollectionRunnerContext)

TestCollectionRunner<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.FailTestClass(XunitTestCollectionRunnerContext, IXunitTestClass, IReadOnlyCollection<IXunitTestCase>, Exception)

TestCollectionRunner<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.OnTestCollectionCleanupFailure(XunitTestCollectionRunnerContext, Exception)

TestCollectionRunner<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.Run(XunitTestCollectionRunnerContext)

TestCollectionRunner<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.RunTestClasses(XunitTestCollectionRunnerContext, Exception)

TestCollectionRunner<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.RunTestClass(XunitTestCollectionRunnerContext, IXunitTestClass, IReadOnlyCollection<IXunitTestCase>)

TestCollectionRunner<XunitTestCollectionRunnerContext, IXunitTestCollection, IXunitTestClass, IXunitTestCase>.SetTestContext(XunitTestCollectionRunnerContext, TestEngineStatus)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

XunitTestCollectionRunner()

Initializes a new instance of the XunitTestCollectionRunner class.

protected XunitTestCollectionRunner()

Properties

Instance

Gets the singleton instance of XunitTestCollectionRunner.

public static XunitTestCollectionRunner Instance { get; }

Property Value

XunitTestCollectionRunner

Methods

Run(IXunitTestCollection, IReadOnlyCollection<IXunitTestCase>, ExplicitOption, IMessageBus, ITestCaseOrderer, ExceptionAggregator, CancellationTokenSource, FixtureMappingManager)

Runs the test collection.

public ValueTask<RunSummary> Run(IXunitTestCollection testCollection, IReadOnlyCollection<IXunitTestCase> testCases, ExplicitOption explicitOption, IMessageBus messageBus, ITestCaseOrderer testCaseOrderer, ExceptionAggregator aggregator, CancellationTokenSource cancellationTokenSource, FixtureMappingManager assemblyFixtureMappings)

Parameters

testCollection IXunitTestCollection

The test collection to be run.

testCases IReadOnlyCollection<IXunitTestCase>

The test cases to be run. Cannot be empty.

explicitOption ExplicitOption

A flag to indicate how explicit tests should be treated.

messageBus IMessageBus

The message bus to report run status to.

testCaseOrderer ITestCaseOrderer

The test case orderer that was applied at the assembly level.

aggregator ExceptionAggregator

The exception aggregator used to run code and collection exceptions.

cancellationTokenSource CancellationTokenSource

The task cancellation token source, used to cancel the test run.

assemblyFixtureMappings FixtureMappingManager

The mapping manager for assembly fixtures.

Returns

ValueTask<RunSummary>

RunTestClass(XunitTestCollectionRunnerContext, IXunitTestClass?, IReadOnlyCollection<IXunitTestCase>)

Override this method to run the tests in an individual test class.

protected override ValueTask<RunSummary> RunTestClass(XunitTestCollectionRunnerContext ctxt, IXunitTestClass? testClass, IReadOnlyCollection<IXunitTestCase> testCases)

Parameters

ctxt XunitTestCollectionRunnerContext

The context that describes the current test collection

testClass IXunitTestClass

The test class to be run. May be null for test cases that do not support classes and methods.

testCases IReadOnlyCollection<IXunitTestCase>

The test cases to be run.

Returns

ValueTask<RunSummary>

Returns summary information about the tests that were run.