Interface IRunnerReporter

Namespace

Xunit.Runner.Common

Assembly

xunit.v3.runner.common.dll

This interface represents a reporter which is invoked by a test runner during test execution. The report can be explicitly invoked by a command line switch or implicitly invoked by being environmentally enabled (for example, a reporter that emits messages for TeamCity).

public interface IRunnerReporter

Properties

CanBeEnvironmentallyEnabled

Gets a value which indicates if it's possible for this reporter to be environmentally enabled.

Description

Gets the description of the reporter. This is typically used when showing the user the invocation option for the reporter.

ForceNoLogo

Gets a value which indicates whether this runner wishes to force no logo. Useful for runners which are designed for purely parseable output (for example, JsonReporter).

IsEnvironmentallyEnabled

Gets a value which indicates whether the reporter should be environmentally enabled.

RunnerSwitch

Gets a value which indicates a runner switch which can be used to explicitly enable the runner. If the return value is null, then the reported can only be environmentally enabled (implicitly). This value is used either as a command line switch (with the console or .NET CLI runner) or as a runner configuration value (with the MSBuild runner).

Methods

CreateMessageHandler(IRunnerLogger, IMessageSink?)

Creates a message handler that will report messages for the given test assembly.