Class XunitTestClassRunner

Namespace

Xunit.v3

Assembly

xunit.v3.core.dll

The test class runner for xUnit.net v3 tests.

public class XunitTestClassRunner : XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>

Inheritance

object

TestClassRunner<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>

XunitTestClassRunner

Inherited Members

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.CreateTestClassConstructorArguments(XunitTestClassRunnerContext)

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.FormatConstructorArgsMissingMessage(XunitTestClassRunnerContext, ConstructorInfo, IReadOnlyList<Tuple<int, ParameterInfo>>)

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.GetConstructorArgument(XunitTestClassRunnerContext, ConstructorInfo, int, ParameterInfo)

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.OnTestClassFinished(XunitTestClassRunnerContext, RunSummary)

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.OnTestClassStarting(XunitTestClassRunnerContext)

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.OrderTestCases(XunitTestClassRunnerContext)

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.SelectTestClassConstructor(XunitTestClassRunnerContext)

XunitTestClassRunnerBase<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.SetTestContext(XunitTestClassRunnerContext, TestEngineStatus)

TestClassRunner<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.FailTestMethod(XunitTestClassRunnerContext, IXunitTestMethod, IReadOnlyCollection<IXunitTestCase>, object[], Exception)

TestClassRunner<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.OnTestClassCleanupFailure(XunitTestClassRunnerContext, Exception)

TestClassRunner<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.Run(XunitTestClassRunnerContext)

TestClassRunner<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.RunTestMethods(XunitTestClassRunnerContext, Exception)

TestClassRunner<XunitTestClassRunnerContext, IXunitTestClass, IXunitTestMethod, IXunitTestCase>.RunTestMethod(XunitTestClassRunnerContext, IXunitTestMethod, IReadOnlyCollection<IXunitTestCase>, object[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

XunitTestClassRunner()

Initializes a new instance of the XunitTestClassRunner class.

protected XunitTestClassRunner()

Properties

Instance

Gets the singleton instance of the XunitTestClassRunner class.

public static XunitTestClassRunner Instance { get; }

Property Value

XunitTestClassRunner

Methods

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

Runs the test class.

public ValueTask<RunSummary> Run(IXunitTestClass testClass, IReadOnlyCollection<IXunitTestCase> testCases, ExplicitOption explicitOption, IMessageBus messageBus, ITestCaseOrderer testCaseOrderer, ExceptionAggregator aggregator, CancellationTokenSource cancellationTokenSource, FixtureMappingManager collectionFixtureMappings)

Parameters

testClass IXunitTestClass

The test class 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 will be used to decide how to order the test.

aggregator ExceptionAggregator

The exception aggregator used to run code and collect exceptions.

cancellationTokenSource CancellationTokenSource

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

collectionFixtureMappings FixtureMappingManager

The mapping of collection fixture types to fixtures.

Returns

ValueTask<RunSummary>

RunTestMethod(XunitTestClassRunnerContext, IXunitTestMethod?, IReadOnlyCollection<IXunitTestCase>, object?[])

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

protected override ValueTask<RunSummary> RunTestMethod(XunitTestClassRunnerContext ctxt, IXunitTestMethod? testMethod, IReadOnlyCollection<IXunitTestCase> testCases, object?[] constructorArguments)

Parameters

ctxt XunitTestClassRunnerContext

The context that describes the current test class

testMethod IXunitTestMethod

The test method that contains the test cases. May be null for test cases that do not support classes and methods.

testCases IReadOnlyCollection<IXunitTestCase>

The test cases to be run.

constructorArguments object[]

The constructor arguments that will be used to create the test class.

Returns

ValueTask<RunSummary>

Returns summary information about the tests that were run.