Table of Contents

Interface IRunnerLogger

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

Interface implemented by runners, passed to IRunnerReporter, so that the report can log lines of text to the output device.

public interface IRunnerLogger
Extension Methods

Properties

LockObject

Gets a lock object that can be used to ensure that multiple calls to log messages will always be grouped together.

object LockObject { get; }

Property Value

object

Methods

LogError(StackFrameInfo, string)

Logs an error message with stack frame.

void LogError(StackFrameInfo stackFrame, string message)

Parameters

stackFrame StackFrameInfo

The stack frame information

message string

The message to be logged

LogImportantMessage(StackFrameInfo, string)

Logs a high-priority message with stack frame.

void LogImportantMessage(StackFrameInfo stackFrame, string message)

Parameters

stackFrame StackFrameInfo

The stack frame information

message string

The message to be logged

LogMessage(StackFrameInfo, string)

Logs a normal-priority message with stack frame.

void LogMessage(StackFrameInfo stackFrame, string message)

Parameters

stackFrame StackFrameInfo

The stack frame information

message string

The message to be logged

LogRaw(string)

Logs a messages with as little processing as possible. For example, the console runner will not attempt to set the color of the text that's being logged. This is most useful when attempting to render text lines that will be processed, like for TeamCity.

void LogRaw(string message)

Parameters

message string

The message to be logged.

LogWarning(StackFrameInfo, string)

Logs a warning message with stack frame.

void LogWarning(StackFrameInfo stackFrame, string message)

Parameters

stackFrame StackFrameInfo

The stack frame information

message string

The message to be logged

WaitForAcknowledgment()

Waits for an acknowledgement of a message.

void WaitForAcknowledgment()

Remarks

This is primarily for use by JsonReporterMessageHandler so that it can wait for acknowledgment of messages when running in synchronous mode by the in-process runner. Other runner loggers running outside this context (and/or when not in synchronous automated mode) should NOOP for this.

Edit this page