Class FakeLoggingBuilderExtensions

Namespace

LogAssertions.TUnit

Assembly

LogAssertions.TUnit.dll

ILoggingBuilder extensions that wire a Microsoft.Extensions.Logging.Testing.FakeLogCollector into a logging builder you already own - a host's ConfigureLogging, a Create(Action<ILoggingBuilder>) callback, or any other - so the capture composes alongside your own level, filters, and providers. Use these when the self-contained CreateTeed(LogLevel) tuple does not fit because the capture must live inside an existing builder, for example an ASP.NET Core test host.

public static class FakeLoggingBuilderExtensions

Inheritance

object

FakeLoggingBuilderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddFakeLogging(ILoggingBuilder, FakeLogCollector, LogLevel)

Adds a Microsoft.Extensions.Logging.Testing.FakeLoggerProvider backed by collector for assertions and sets the builder's minimum level to minimumLevel, registering that level as the collector's capture floor so the vacuous-HasNotLogged() guard applies. No record is teed to the test output; use AddTeedFakeLogging(ILoggingBuilder, FakeLogCollector, LogLevel, ILoggerProvider?) for that.

[SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "The provider is registered into the ILoggingBuilder and becomes part of the built logger pipeline; its lifetime is the caller's, not this method's. FakeLoggerProvider holds no unmanaged resources.")]
public static ILoggingBuilder AddFakeLogging(this ILoggingBuilder builder, FakeLogCollector collector, LogLevel minimumLevel = LogLevel.Trace)

Parameters

builder ILoggingBuilder

The logging builder to add the capture provider to.

collector FakeLogCollector

The collector that receives records for assertions.

minimumLevel LogLevel

The minimum level to capture, also registered as the capture floor. Default is Trace (everything).

Returns

ILoggingBuilder

The same builder for chaining.

Remarks

The helper owns the builder's minimum level so the registered capture floor is accurate: a floor below the level the builder actually filters at would let the vacuity guard miss a genuinely vacuous absence and pass when it should fail. Pass a higher minimumLevel to capture less.

Exceptions

ArgumentNullException

builder or collector is null.

AddTeedFakeLogging(ILoggingBuilder, FakeLogCollector, LogLevel, ILoggerProvider?)

Adds a Microsoft.Extensions.Logging.Testing.FakeLoggerProvider backed by collector for assertions, plus a tee provider that mirrors each record into the test report - teeProvider when supplied, otherwise the built-in LogAssertions.TUnit.TestOutputLoggerProvider. Supplying your own provider lets you plug in correlation that survives background threads (for example TUnit's CorrelatedTUnitLoggerProvider) without this package taking a dependency on it. Sets the builder's minimum level and registers the capture floor exactly as AddFakeLogging(ILoggingBuilder, FakeLogCollector, LogLevel) does.

[SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "Both providers are registered into the ILoggingBuilder and become part of the built logger pipeline; their lifetime is the caller's, not this method's.")]
public static ILoggingBuilder AddTeedFakeLogging(this ILoggingBuilder builder, FakeLogCollector collector, LogLevel minimumLevel = LogLevel.Trace, ILoggerProvider? teeProvider = null)

Parameters

builder ILoggingBuilder

The logging builder to add the providers to.

collector FakeLogCollector

The collector that receives records for assertions.

minimumLevel LogLevel

The minimum level to capture and tee, also registered as the capture floor. Default is Trace (everything).

teeProvider ILoggerProvider

The provider that mirrors records into the test report, or null to use the built-in LogAssertions.TUnit.TestOutputLoggerProvider.

Returns

ILoggingBuilder

The same builder for chaining.

Remarks

A supplied teeProvider is registered into the builder and becomes part of the built logger pipeline. The logging factory does not dispose externally-supplied provider instances, so dispose it yourself if it holds resources (the usual display/correlation providers do not). The built-in tee binds to the active test captured at this call - the per-test case runs on the test's own thread - so a record logged on a background thread is teed, not dropped. When no test is current here (a host shared across many tests), it falls back to resolving the test at emit time and skips records it cannot attribute; pass a correlation-aware teeProvider for that case.

Exceptions

ArgumentNullException

builder or collector is null.