Table of Contents

Class DefaultRunnerReporterMessageHandler

Namespace
Xunit.Runner.Common
Assembly
xunit.v3.runner.common.dll

An implementation of IRunnerReporterMessageHandler that supports DefaultRunnerReporter.

public class DefaultRunnerReporterMessageHandler : TestMessageSink, IRunnerReporterMessageHandler, IMessageSink, IAsyncDisposable
Inheritance
DefaultRunnerReporterMessageHandler
Implements
Derived
Inherited Members

Constructors

DefaultRunnerReporterMessageHandler(IRunnerLogger)

Initializes a new instance of the DefaultRunnerReporterMessageHandler class.

public DefaultRunnerReporterMessageHandler(IRunnerLogger logger)

Parameters

logger IRunnerLogger

The logger used to report messages

Fields

EnvVar_HidePassingOutput

Gets the environment variable that's used to hide passing tests with output when diagnostics messages are enabled.

public const string EnvVar_HidePassingOutput = "XUNIT_HIDE_PASSING_OUTPUT_DIAGNOSTICS"

Field Value

string

Properties

Logger

Get the logger used to report messages.

protected IRunnerLogger Logger { get; }

Property Value

IRunnerLogger

MetadataCache

Gets the metadata cache.

protected MessageMetadataCache MetadataCache { get; }

Property Value

MessageMetadataCache

Methods

Escape(string?)

Escapes text for display purposes.

protected virtual string Escape(string? text)

Parameters

text string

The text to be escaped

Returns

string

The escaped text

EscapeMultiLineIndent(string?, string)

Escapes multi-line text for display purposes, indenting on newlines.

protected virtual string EscapeMultiLineIndent(string? text, string indent)

Parameters

text string

The text to be escaped

indent string

The indent to use for multiple line text

Returns

string

The escaped text

GetAssemblyDisplayName(XunitProjectAssembly)

Gets the display name of a test assembly from a test assembly message.

protected virtual string GetAssemblyDisplayName(XunitProjectAssembly assembly)

Parameters

assembly XunitProjectAssembly

The test assembly

Returns

string

The assembly display name

GetExecutionOptions(string?)

Get the test framework options for the given assembly. If it cannot find them, then it returns a default set of options.

protected ITestFrameworkExecutionOptions GetExecutionOptions(string? assemblyFileName)

Parameters

assemblyFileName string

The test assembly filename

Returns

ITestFrameworkExecutionOptions

HandleErrorMessage(MessageHandlerArgs<IErrorMessage>)

Called when IErrorMessage is raised.

protected virtual void HandleErrorMessage(MessageHandlerArgs<IErrorMessage> args)

Parameters

args MessageHandlerArgs<IErrorMessage>

An object that contains the event data.

HandleTestAssemblyCleanupFailure(MessageHandlerArgs<ITestAssemblyCleanupFailure>)

Called when ITestAssemblyCleanupFailure is raised.

protected virtual void HandleTestAssemblyCleanupFailure(MessageHandlerArgs<ITestAssemblyCleanupFailure> args)

Parameters

args MessageHandlerArgs<ITestAssemblyCleanupFailure>

An object that contains the event data.

HandleTestAssemblyDiscoveryFinished(MessageHandlerArgs<TestAssemblyDiscoveryFinished>)

Called when TestAssemblyDiscoveryFinished is raised.

protected virtual void HandleTestAssemblyDiscoveryFinished(MessageHandlerArgs<TestAssemblyDiscoveryFinished> args)

Parameters

args MessageHandlerArgs<TestAssemblyDiscoveryFinished>

An object that contains the event data.

HandleTestAssemblyDiscoveryStarting(MessageHandlerArgs<TestAssemblyDiscoveryStarting>)

Called when TestAssemblyDiscoveryStarting is raised.

protected virtual void HandleTestAssemblyDiscoveryStarting(MessageHandlerArgs<TestAssemblyDiscoveryStarting> args)

Parameters

args MessageHandlerArgs<TestAssemblyDiscoveryStarting>

An object that contains the event data.

HandleTestAssemblyExecutionFinished(MessageHandlerArgs<TestAssemblyExecutionFinished>)

Called when TestAssemblyExecutionFinished is raised.

protected virtual void HandleTestAssemblyExecutionFinished(MessageHandlerArgs<TestAssemblyExecutionFinished> args)

Parameters

args MessageHandlerArgs<TestAssemblyExecutionFinished>

An object that contains the event data.

HandleTestAssemblyExecutionStarting(MessageHandlerArgs<TestAssemblyExecutionStarting>)

Called when TestAssemblyExecutionStarting is raised.

protected virtual void HandleTestAssemblyExecutionStarting(MessageHandlerArgs<TestAssemblyExecutionStarting> args)

Parameters

args MessageHandlerArgs<TestAssemblyExecutionStarting>

An object that contains the event data.

HandleTestAssemblyFinished(MessageHandlerArgs<ITestAssemblyFinished>)

Called when ITestAssemblyFinished is raised.

protected virtual void HandleTestAssemblyFinished(MessageHandlerArgs<ITestAssemblyFinished> args)

Parameters

args MessageHandlerArgs<ITestAssemblyFinished>

An object that contains the event data.

HandleTestAssemblyStarting(MessageHandlerArgs<ITestAssemblyStarting>)

Called when ITestAssemblyStarting is raised.

protected virtual void HandleTestAssemblyStarting(MessageHandlerArgs<ITestAssemblyStarting> args)

Parameters

args MessageHandlerArgs<ITestAssemblyStarting>

An object that contains the event data.

HandleTestCaseCleanupFailure(MessageHandlerArgs<ITestCaseCleanupFailure>)

Called when ITestCaseCleanupFailure is raised.

protected virtual void HandleTestCaseCleanupFailure(MessageHandlerArgs<ITestCaseCleanupFailure> args)

Parameters

args MessageHandlerArgs<ITestCaseCleanupFailure>

An object that contains the event data.

HandleTestCaseFinished(MessageHandlerArgs<ITestCaseFinished>)

Called when ITestCaseFinished is raised.

protected virtual void HandleTestCaseFinished(MessageHandlerArgs<ITestCaseFinished> args)

Parameters

args MessageHandlerArgs<ITestCaseFinished>

An object that contains the event data.

HandleTestCaseStarting(MessageHandlerArgs<ITestCaseStarting>)

Called when ITestCaseStarting is raised.

protected virtual void HandleTestCaseStarting(MessageHandlerArgs<ITestCaseStarting> args)

Parameters

args MessageHandlerArgs<ITestCaseStarting>

An object that contains the event data.

HandleTestClassCleanupFailure(MessageHandlerArgs<ITestClassCleanupFailure>)

Called when ITestClassCleanupFailure is raised.

protected virtual void HandleTestClassCleanupFailure(MessageHandlerArgs<ITestClassCleanupFailure> args)

Parameters

args MessageHandlerArgs<ITestClassCleanupFailure>

An object that contains the event data.

HandleTestClassFinished(MessageHandlerArgs<ITestClassFinished>)

Called when ITestClassFinished is raised.

protected virtual void HandleTestClassFinished(MessageHandlerArgs<ITestClassFinished> args)

Parameters

args MessageHandlerArgs<ITestClassFinished>

An object that contains the event data.

HandleTestClassStarting(MessageHandlerArgs<ITestClassStarting>)

Called when ITestClassStarting is raised.

protected virtual void HandleTestClassStarting(MessageHandlerArgs<ITestClassStarting> args)

Parameters

args MessageHandlerArgs<ITestClassStarting>

An object that contains the event data.

HandleTestCleanupFailure(MessageHandlerArgs<ITestCleanupFailure>)

Called when ITestCleanupFailure is raised.

protected virtual void HandleTestCleanupFailure(MessageHandlerArgs<ITestCleanupFailure> args)

Parameters

args MessageHandlerArgs<ITestCleanupFailure>

An object that contains the event data.

HandleTestCollectionCleanupFailure(MessageHandlerArgs<ITestCollectionCleanupFailure>)

Called when ITestCollectionCleanupFailure is raised.

protected virtual void HandleTestCollectionCleanupFailure(MessageHandlerArgs<ITestCollectionCleanupFailure> args)

Parameters

args MessageHandlerArgs<ITestCollectionCleanupFailure>

An object that contains the event data.

HandleTestCollectionFinished(MessageHandlerArgs<ITestCollectionFinished>)

Called when ITestCollectionFinished is raised.

protected virtual void HandleTestCollectionFinished(MessageHandlerArgs<ITestCollectionFinished> args)

Parameters

args MessageHandlerArgs<ITestCollectionFinished>

An object that contains the event data.

HandleTestCollectionStarting(MessageHandlerArgs<ITestCollectionStarting>)

Called when ITestCollectionStarting is raised.

protected virtual void HandleTestCollectionStarting(MessageHandlerArgs<ITestCollectionStarting> args)

Parameters

args MessageHandlerArgs<ITestCollectionStarting>

An object that contains the event data.

HandleTestExecutionSummaries(MessageHandlerArgs<TestExecutionSummaries>)

Called when TestExecutionSummaries is raised.

protected virtual void HandleTestExecutionSummaries(MessageHandlerArgs<TestExecutionSummaries> args)

Parameters

args MessageHandlerArgs<TestExecutionSummaries>

An object that contains the event data.

HandleTestFailed(MessageHandlerArgs<ITestFailed>)

Called when ITestFailed is raised.

protected virtual void HandleTestFailed(MessageHandlerArgs<ITestFailed> args)

Parameters

args MessageHandlerArgs<ITestFailed>

An object that contains the event data.

HandleTestFinished(MessageHandlerArgs<ITestFinished>)

Called when ITestFinished is raised.

protected virtual void HandleTestFinished(MessageHandlerArgs<ITestFinished> args)

Parameters

args MessageHandlerArgs<ITestFinished>

An object that contains the event data.

HandleTestMethodCleanupFailure(MessageHandlerArgs<ITestMethodCleanupFailure>)

Called when ITestMethodCleanupFailure is raised.

protected virtual void HandleTestMethodCleanupFailure(MessageHandlerArgs<ITestMethodCleanupFailure> args)

Parameters

args MessageHandlerArgs<ITestMethodCleanupFailure>

An object that contains the event data.

HandleTestMethodFinished(MessageHandlerArgs<ITestMethodFinished>)

Called when ITestMethodFinished is raised.

protected virtual void HandleTestMethodFinished(MessageHandlerArgs<ITestMethodFinished> args)

Parameters

args MessageHandlerArgs<ITestMethodFinished>

An object that contains the event data.

HandleTestMethodStarting(MessageHandlerArgs<ITestMethodStarting>)

Called when ITestMethodStarting is raised.

protected virtual void HandleTestMethodStarting(MessageHandlerArgs<ITestMethodStarting> args)

Parameters

args MessageHandlerArgs<ITestMethodStarting>

An object that contains the event data.

HandleTestOutput(MessageHandlerArgs<ITestOutput>) 

protected virtual void HandleTestOutput(MessageHandlerArgs<ITestOutput> args)

Parameters

args MessageHandlerArgs<ITestOutput>

HandleTestPassed(MessageHandlerArgs<ITestPassed>)

Called when ITestPassed is raised.

protected virtual void HandleTestPassed(MessageHandlerArgs<ITestPassed> args)

Parameters

args MessageHandlerArgs<ITestPassed>

An object that contains the event data.

HandleTestSkipped(MessageHandlerArgs<ITestSkipped>)

Called when ITestSkipped is raised.

protected virtual void HandleTestSkipped(MessageHandlerArgs<ITestSkipped> args)

Parameters

args MessageHandlerArgs<ITestSkipped>

An object that contains the event data.

HandleTestStarting(MessageHandlerArgs<ITestStarting>)

Called when ITestStarting is raised.

protected virtual void HandleTestStarting(MessageHandlerArgs<ITestStarting> args)

Parameters

args MessageHandlerArgs<ITestStarting>

An object that contains the event data.

LogError(IErrorMetadata, string)

Logs an error message to the logger.

protected void LogError(IErrorMetadata errorMetadata, string failureType)

Parameters

errorMetadata IErrorMetadata

The failure information

failureType string

The type of the failure

LogError(IErrorMetadata, string, params object?[])

Logs an error message to the logger.

protected void LogError(IErrorMetadata errorMetadata, string failureTypeFormat, params object?[] args)

Parameters

errorMetadata IErrorMetadata

The failure information

failureTypeFormat string

The type of the failure, in message format

args object[]

The arguments to format failureTypeFormat with

LogOutput(StackFrameInfo, string?)

Logs test output to the logger.

protected virtual void LogOutput(StackFrameInfo frameInfo, string? output)

Parameters

frameInfo StackFrameInfo
output string

LogStackTrace(StackFrameInfo, string?)

Logs a stack trace to the logger.

protected virtual void LogStackTrace(StackFrameInfo frameInfo, string? stackTrace)

Parameters

frameInfo StackFrameInfo
stackTrace string

LogWarnings(StackFrameInfo, string[]?)

Logs warnings to the logger.

protected virtual void LogWarnings(StackFrameInfo frameInfo, string[]? warnings)

Parameters

frameInfo StackFrameInfo
warnings string[]

WriteDefaultSummary(IRunnerLogger, TestExecutionSummaries)

Writes the default summary to the given logger. Can be used by other reporters who also wish to write the standard summary information.

public void WriteDefaultSummary(IRunnerLogger logger, TestExecutionSummaries summaries)

Parameters

logger IRunnerLogger

The logger used to send result messages to.

summaries TestExecutionSummaries

The execution summary to display.

Edit this page