xunit.v3.runner.common

Used to decorate xUnit.net test assemblies to indicate the availability of a custom runner reporter.

Runner reporter registration attributes are only valid at the assembly level.

Gets the type of the runner reporter to be registered.

The runner reporter type must implement .

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

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

Logs a normal-priority message with stack frame.

The stack frame information The message to be logged

Logs a high-priority message with stack frame.

The stack frame information The message to be logged

Logs a warning message with stack frame.

The stack frame information The message to be logged

Logs an error message with stack frame.

The stack frame information The message to be logged

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.

The message to be logged.

Waits for an acknowledgement of a message.

This is primarily for use by 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.

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).

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

Note that this differs from which checks to see whether the conditions currently exist to environmentally enable the reporter. This value is used when constructing the console runner help output that lists which runners might be environmentally enabled.

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

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, ).

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

When a runner reporter is environmentally enabled in Microsoft Testing Platform CLI mode (or dotnet test), by default all realtime output is filtered except calls to (unless the user has specified the --xunit-info switch). Environmentally enabled reporters that require realtime console output (for example, to send formatted messages to a CI system which parses the console output) must use to ensure those messages will always be visible. All other messages will always be output to the Microsoft Testing Platform diagnostic logs, which are enabled via the --diagnostic switch.

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).

Runner switches are only used in xUnit.net native CLI mode. When Microsoft Testing Platform CLI mode is enabled, reporters are only supported via environmental enablement, since MTP generally controls all the normal output.

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

The logger used to send result messages to An optional message sink that diagnostic messages can be sent to. The message handler that handles the messages

Indicates a message sink that's designed for use with runner reporters. In particular, this allows runner reporters to implement and forces runners to dispose of the message handler that's returned to them.

This class is used to read JSON-based configuration information for a test assembly.

Loads the test assembly configuration for the given test assembly.

The configuration object to write the values to. The test assembly. The test assembly configuration file. A container to receive loading warnings, if desired. A flag which indicates whether configuration values were read.

Loads the test assembly configuration for the given test assembly.

The configuration object to write the values to. The configuration JSON, as a string A container to receive loading warnings, if desired. A flag which indicates whether configuration values were read. A flag which indicates whether configuration values were read.

Utilities for reading configuration values.

Gets the regular expression that matches the multiplier-style value for maximum parallel threads (that is, '0.5x', '2x', etc.).

Extensions methods for .

Logs a normal-priority message.

The logger The message to be logged

Logs a normal-priority formatted message.

The logger The format of the message to be logged The format arguments

Logs a normal-priority formatted message with stack frame.

The logger The stack frame information The format of the message to be logged The format arguments

Logs a high-priority message.

The logger The message to be logged

Logs a high-priority formatted message.

The logger The format of the message to be logged The format arguments

Logs a high-priority formatted message with stack frame.

The logger The stack frame information The format of the message to be logged The format arguments

Logs a warning message.

The logger The message to be logged

Logs a formatted warning message.

The logger The format of the message to be logged The format arguments

Logs a formatted warning message with stack frame.

The logger The stack frame information The format of the message to be logged The format arguments

Logs an error message.

The logger The message to be logged

Logs a formatted error message.

The logger The format of the message to be logged The format arguments

Logs a formatted error message with stack frame.

The logger The stack frame information The format of the message to be logged The format arguments

The logger The format of the message to be logged The format arguments

Represents a filter run against a test case (and the associated assembly it resides in).

Determines whether the given passes the filter.

The simple assembly name without file extension The test case to be checked against the filter

This class is used to parse a graphy query.

See for the query filter language description.

Parse and return a filter that represents the query.

Represents the ability to track query filters or simple filters. Any attempt to add a mix of the two will result in an exception.

Gets a flag indicating whether there are any active filters.

Adds a simple filter which excludes a fully qualified class name.

The filter query The query may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a simple filter which excludes a fully qualified method name. A fully qualified method name is in the form of "FullyQualifiedTypeName.MethodName".

The filter query The query may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a simple filter which excludes a namespace.

The filter query The query may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a simple filter which excludes tests with the given name/value pair.

The name of the trait The value of the trait The name and/or value may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a simple filter matching a fully qualified class name.

The query may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a simple filter which matches a fully qualified method name. A fully qualified method name is in the form of "FullyQualifiedTypeName.MethodName".

The filter query The query may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a simple filter which matches a namespace.

The filter query The query may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a simple filter which matches tests with the given name/value pair.

The name of the trait The value of the trait The name and/or value may begin and/or end with * to add as a wildcard. No other wildcards are permitted in any other locations.

Adds a query filter.

For more information on the query syntax, see

Gets the command-line arguments to pass to an xUnit.net v3 test assembly to perform the filtering contained within this filter.

Indicates the current level of app domain support that's in effect, for use by runner reporters.

App domains are not supported by the current platform

App domains are supported, but currently disabled

App domains are supported and currently enabled

Indicates the level of app domain support that the runner is requesting. Note that these values are only valid for v1 and v2 tests; v3 tests always run in a separate process rather than in the runner process.

Requests that app domains be used for v1 and v2 tests, if available; if app domains cannot be used, then the tests will be discovered and run in the runner's app domain.

Requires that v1 and v2 tests run in a separate app domain. Can only be requested by runners written in .NET Framework.

Requires that v1 and v2 tests be run in the runner's app domain.

Extension methods for

Determines if the value is a valid enum value.

Collects execution totals for a group of test cases.

Gets or set the total number of tests run.

Gets or sets the number of failed tests.

Gets or sets the number of skipped tests.

Gets or sets the number of tests not run.

Gets or sets the total execution time for the tests.

Gets or sets the total errors (i.e., cleanup failures) for the tests.

Represents a provider which gives source line information for a test case after discovery has completed. This is typically provided by a third party runner (for example, the VSTest plugin provides this via DiaSession from Visual Studio). It's used to supplement test case metadata when the discovery process itself cannot provide source file and line information.

Returns the source information for a test case.

The test class name, if known The test method name, if known The source information, with null string and int values when the information is not available. Note: return value should never be null, only the interior data values inside.

Designates the format that the test list should take.

Lists the information in JSON (machine readable) format

Lists the information in plain text (human readable) format

Indicates the kind of list a runner should generate, rather than running tests.

Lists all the classes in the assembly which contain tests.

Lists the test cases as discovery objects (only valid for the in-process runner).

Lists full metadata about the test discovery.

Lists all the methods in the assembly which contain a test.

Lists all the tests (as display name) in the assembly.

Lists all the traits that are generated from the assembly.

Represents information about long running tests from .

Configured notification time Tests

Represents information about long running tests from .

Configured notification time Tests

A null implementation of which always returns empty source information. Get the singleton via .

Gets the singleton instance of the .

Represents available parallelism options

Do not parallelize any tests.

Run tests in different assemblies in parallel

Run tests in different test collections in parallel

Enable maximum parallelization

Source information returned by .

The source file, if known The line number, if known

Source information returned by .

The source file, if known The line number, if known

Gets a singleton instance of that represents no source information.

Gets the source file, if known; null, otherwise

Gets the source line number, if known; null, otherwise

Represents the top of a stack frame, typically taken from an exception or failure information.

The file name from the stack frame The line number from the stack frame

Represents the top of a stack frame, typically taken from an exception or failure information.

The file name from the stack frame The line number from the stack frame

Gets the filename of the stack frame. May be null if the stack frame is not known.

Returns true if this is an empty stack frame (e.g., ).

Gets the line number of the stack frame. May be 0 if the stack frame is not known.

Get a default (unknown) stack frame info.

Creates a stack frame info from error metadata.

The error to inspect The stack frame info

Represents the configuration items set in the configuration file of a test assembly. Should be read with the class.

Initalizes a new instance of the class.

Gets or sets a flag indicating whether an app domain should be used to discover and run tests.

Gets or sets a flag indicating whether an app domain should be used to discover and run tests. If the flag is not set, returns the default value ().

Gets a value which indicates the maximum object depth to compare when using Assert.Equivalent.

Gets or sets the desired culture to run the tests under. Use null (default) to indicate that we should use the default OS culture; use an empty string to indicate that we should use the invariant culture; or use any culture value that is valid for calling .

Gets or sets a flag indicating that the end user wants diagnostic messages from the test framework.

Gets a flag indicating that the end user wants diagnostic messages from the test framework. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating how explicit tests should be handled.

Gets a flag indicating how explicit tests should be handled. If the flag isn't set, returns the default value ().

Gets or sets a flag indicating that skipped tests should be converted into failed tests.

Gets a flag indicating that skipped tests should be converted into failed tests. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that passing tests with warnings should be converted into failed tests.

Gets or sets a flag indicating that passing tests with warnings should be converted into failed tests. If the flag is not set, returns the default value (false).

Gets the list of filters used during test discovery.

Gets or sets a flag indicating that discovery should include source information for the test cases.

Gets a flag indicating that discovery should include source information for the test cases. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that the end user wants internal diagnostic messages from the test framework.

Gets a flag indicating that the end user wants internal diagnostic messages from the test framework. If the flag is not set, returns the default value (false).

Gets the number of seconds that a test can run before being considered "long running". Set to a positive value to enable the feature.

Gets the number of seconds that a test can run before being considered "long running". If the value is not set, returns the default value (-1).

Gets or sets the maximum number of thread to use when parallelizing this assembly. A value of null or 0 indicates that the default should be used (); a value of -1 indicates that tests should run with an unlimited-sized thread pool.

Gets the maximum number of thread to use when parallelizing this assembly. If the value is not set, returns the default value ().

Gets or sets the default display name for test methods.

Gets the default display name for test methods. If the value is not set, returns the default value ().

Gets or sets the default display options for test methods.

Gets the default display options for test methods. If the value is not set, returns the default value ().

Gets or sets the algorithm to be used for parallelization.

Gets or sets a flag indicating that this assembly is safe to parallelize against other assemblies.

Gets a flag indicating that this assembly is safe to parallelize against other assemblies. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that this test assembly wants to run test collections in parallel against one another.

Gets a flag indicating that this test assembly wants to run test collections in parallel against one another. If the flag is not set, returns the default value (true).

Gets or sets a flag indicating whether theory data should be pre-enumerated during test discovery.

Gets a value indicating the maximum length for printing collections.

Gets a value indicating the maximum recursive depth when printing objects.

Gets a value indicating the maximum members to show when printing objects.

Gets a value indicating the maximum length for printing string values.

Gets or sets the seed value used for randomization. Only supported for v3 or later test assemblies.

Gets or sets a flag indicating whether shadow copies should be used.

Gets a flag indicating whether shadow copies should be used. If the flag is not set, returns the default value (true).

Gets or sets the folder to be used for shadow copy files. If the value is not set, the system defaults for shadow copying are used.

Gets or sets a flag indicating whether output from should be shown live as they're logged (in addition to being collected together after the test finishes).

Gets a flag indicating whether output from should be shown live as they're logged (in addition to being collected together after the test finishes). If the flag is not set, returns the default value (false).

Gets or sets a flag indicating whether testing should stop on a failure.

Gets a flag indicating whether testing should stop on a test failure. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that synchronous message reporting is desired.

Gets a flag indicating that synchronous message reporting is desired. If the flag is not set, returns the default value (false).

Represents options passed to a test framework for discovery or execution.

INTERNAL METHOD, FOR TESTING PURPOSES ONLY. DO NOT CALL.

Creates an instance of for discovery purposes.

The configuration to copy values from.

Creates an instance of for discovery purposes.

The serialized discovery options.

Creates an instance of for execution purposes.

The configuration to copy values from.

Creates an instance of for execution purposes.

The serialized execution options.

Gets a value from the options collection.

The type of the value. The name of the value. Returns the value.

Sets a value into the options collection.

The type of the value. The name of the value. The value.

Represents the configuration settings for a test runner which are independent of the test assembly. Are usually passed via command line or some other equivalent mechanism. Accessed via ..

Initializes a new instance of the class.

Gets or sets a flag which indicates whether the runner should return assembly information rather than listing or executing tests.

Gets a flag which indicates whether the runner should return assembly information rather than listing or executing tests. If the flag is not specified, returns the default value (false).

Gets the environment variable name used to test for the user requesting no color output.

Gets the time (in milliseconds) that the crash detection sink will wait after process termination for timely message dispatch, to determine if the process exited cleanly or crashed.

Gets the time (in milliseconds) that the crash detection sink will wait after process termination for timely message dispatch, to determine if the process exited cleanly or crashed. If the value isn't set, returns the default value (60 seconds).

Gets or sets a flag which indicates whether the runner should attempt to attach the debugger before running any tests.

Gets a flag which indicates whether the runner should attempt to attach the debugger before running any tests. If the flag is not specified, returns the default value (false).

Gets or sets a flag which indicates whether the runner should ignore test failures.

Gets a flag which indicates whether the runner should ignore test failures. If the flag is not specified, returns the default value (false).

Gets or sets a flag to indicate that we should list things instead of run them (and what we're listing, and in what format).

The output files that should be generated from the test run. The key is the output type, and the value is the output filename. The output type matches the property on the transforms available in ..

Gets or sets a flag indicating that the test runner should not attempt to use any automatically (aka environmentally) enabled reporters.

Gets a flag indicating that the test runner should not attempt to use any automatically (aka environmentally) enabled reporters. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that the test runner should not output any color codes when writing text to the console.

Gets a flag indicating that the test runner should not output any color codes when writing text to the console. If the flag is not set, returns true if the user has defined the NO_COLOR environment variable, or false otherwise.

Gets or sets a flag indicating that the test runner should not output the copyright information.

Gets a flag indicating that the test runner hsould not output the copyright information. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that the test runner should pause before running any tests.

Gets a flag indicating that the test runner should pause before running any tests. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that ANSI color usage should be forced on Windows. ANSI color is always used for non-Windows.

Gets a flag indicating that ANSI color usage should be forced on Windows. ANSI color is always used for non-Windows. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that the test runner should pause after all tests have run.

Gets a flag indicating that the test runner should pause after all tests have run. If the flag is not set, returns the default value (false).

Gets or sets a flag indicating that the test runner should wait for a debugger to be attached before performing any actions.

Gets a flag indicating that the test runner should wait for a debugger to be attached before performing any actions. If the flag is not set, returns the default value (false).

Represents a project which contains zero or more test assemblies, as well as global (cross-assembly) configuration settings.

Initializes a new instance of the class.

Gets the assemblies that are in the project.

Gets the configuration values for the test project.

Gets a flag indicating whether has been set yet or not.

Gets or sets the runner reporter.

Adds an assembly to the project.

The assembly to add to the project.

Create an instance of populated by launch options.

The project that is our template to copy from The launch options

Represents an assembly in an .

Initializes a new instance of the class

The project this assembly belongs to. The assembly filename The assembly metadata

Gets or sets the assembly under test. May be null when the test assembly is not loaded into the current .

Gets the assembly display name.

Gets or sets the assembly file name.

Gets or sets the metadata about the assembly.

Gets or sets the config file name.

Gets the configuration values for the test assembly.

Gets an identifier for the current assembly. This is guaranteed to be unique, but not necessarily repeatable across runs (because it relies on ).

Gets the project that this project assembly belongs to.

Gets a list of serialized test cases to be run. If the list is empty, then all test cases (that match the filters) will be run.

Create an instance of populated by front controller settings.

The settings

Create an instance of populated by front controller settings.

The settings

Create an instance of populated by front controller settings.

The settings

An implementation of which logs messages to a (typically the one from ).

Initializes a new instance of the class.

A flag to indicate whether colors should be used when logging messages. A flag to indicate whether ANSI colors should be forced on Windows. The helper for writing console output. A flag to indicate whether the logger should wait for acknowledgments or not

Writes a (non-colored) message. If is false, all ANSI-SGR sequences will be removed prior to writing.

Message to write See for details about ANSI-SGR.

An implementation of which is given to ProjectAssemblyRunner.Run, which only uses to send occasional JSON-encoded messages. This will decode them and send them along to the correct message sink.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of , with serialization and deserialization support.

Because of deserialization, all concrete message sink message types must have a parameterless public constructor that will be used to create the message for deserialization purposes, and must be decorated with to set a unique type ID for deserialization purposes.

Empty traits, to be used to initialize traits values in messages.

Gets the string value that message properties will return, when a value was not provided during deserialization.

Override to deserialize the values in the dictionary into the message.

The root of the JSON object

Initializes a new instance of the see class.

Override to serialize the values in the message into JSON.

The serializer to write values to.

Converts a string array into a display value, for use in an overload.

Converts am array into a display value, for use in an overload.

Creates a JSON serialized version of this message.

Thrown if the message class does not have a . Thrown when one or more properties are missing values.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be 0 if there was no value provided during deserialization. Note: Will be if there was no value provided during deserialization. Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Default implementation of .

Note: Will be if there was no value provided during deserialization.

Creates a new instance of the class.

Creates a new instance of the class with the provided message.

The diagnostic message

Creates a new instance of the class with the provided message format and single argument.

The message format string The value to replace {0} in the format string.

Creates a new instance of the class with the provided message format and two arguments.

The message format string The value to replace {0} in the format string. The value to replace {1} in the format string.

Creates a new instance of the class with the provided message format and three arguments.

The message format string The value to replace {0} in the format string. The value to replace {1} in the format string. The value to replace {2} in the format string.

Creates a new instance of the class with the provided message format and multiple arguments.

The message format string An object array that contains zero or more objects to format.

Default implementation of .

Note: Will be 0 if there was no value provided during deserialization.

Default implementation of .

Note: Will be an empty array if there was no value provided during deserialization. Note: Will be an empty array if there was no value provided during deserialization. Note: Will be an empty array if there was no value provided during deserialization. Note: Will be an empty array if there was no value provided during deserialization.

Creates a new constructed from an object.

The exception to use