dotnet-testing-test-output-logging_skill

Overview

This skill is a practical guide for implementing robust test output and logging in .NET xUnit projects. It explains how to use ITestOutputHelper correctly, create test-friendly ILogger implementations (XUnitLogger, AbstractLogger, CompositeLogger), and design structured, diagnostic output for unit and performance tests.

How this skill works

It inspects common xUnit patterns and provides concrete implementations and patterns you can adopt: constructor injection of ITestOutputHelper, an AbstractLogger base to simplify mocking, an XUnitLogger that writes log entries to test output, and a CompositeLogger to combine mock verification with visible output. It also shows how to record timestamps and checkpoints for performance diagnostics.

When to use it

• When you need deterministic test diagnostics visible in xUnit output
• When testing code that depends on ILogger and you need a verifiable substitute
• When you want structured, consistent logs to debug failing tests
• When running performance or long-running tests that need time-point reporting
• When combining assertionable behavior with human-readable test logs

Best practices

• Inject ITestOutputHelper via constructor; do not store it in static fields
• Use structured sections, key-value lines, and timestamps for readable output
• Prefer AbstractLogger to simplify mocking Log<TState> behavior in tests
• Verify log level and relevant message fragments rather than exact text
• Combine a mock logger with XUnitLogger via CompositeLogger for both verification and visible output
• Avoid logging sensitive data and excessive output that slows tests

Example use cases

• Unit test that asserts error handling and verifies an Error-level log was produced
• Integration test where XUnitLogger writes progress and failures to test output for debugging
• Performance test that records checkpoints and prints elapsed milliseconds per stage
• Service test using CompositeLogger to both assert log interactions and dump readable messages
• Diagnostic test base class that standardizes LogTestStart, LogTestData, and assertion failure output