Cangming.Logs.xUnit 0.1.9.1122

Prefix Reserved
dotnet add package Cangming.Logs.xUnit --version 0.1.9.1122
                    
NuGet\Install-Package Cangming.Logs.xUnit -Version 0.1.9.1122
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Cangming.Logs.xUnit" Version="0.1.9.1122" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Cangming.Logs.xUnit" Version="0.1.9.1122" />
                    
Directory.Packages.props
<PackageReference Include="Cangming.Logs.xUnit" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Cangming.Logs.xUnit --version 0.1.9.1122
                    
#r "nuget: Cangming.Logs.xUnit, 0.1.9.1122"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Cangming.Logs.xUnit@0.1.9.1122
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Cangming.Logs.xUnit&version=0.1.9.1122
                    
Install as a Cake Addin
#tool nuget:?package=Cangming.Logs.xUnit&version=0.1.9.1122
                    
Install as a Cake Tool

Cangming.Logs.xUnit

日志领域的测试适配层(net8.0;net10.0),提供两类能力:把 MEL(Microsoft.Extensions.Logging)日志路由到 xUnit 的 ITestOutputHelper,以及在测试内按异步作用域捕获日志条目。包版本由仓库根 Directory.Build.props 统一控制,项目内不覆盖。本工程只依赖 MEL 抽象与 xunit.v3.extensibility.core(xUnit v3 编译面),不依赖任何组织内包;捕获类型放在 Cangming.Logs.Testing 命名空间,不引用任何 xUnit 类型,后续若拆独立测试包可以原样迁移。

输出到测试输出

测试类注入 ITestOutputHelper,把它包成 ILoggerProvider 交给独立工厂:

using var factory = LoggerFactory.Create(builder =>
    builder.AddProvider(new XUnitLoggerProvider(output)));

var logger = factory.CreateLogger<MyTests>();
logger.LogInformation("测试开始");

输出形如 [14:32:01.123 Information] MyNamespace.MyTests - 测试开始;异常另起 EXCEPTION: 行。XUnitLogger.IsEnabled 对除 LogLevel.None 外的一切级别返回 true,级别过滤由工厂的 AddFilter 完成;XUnitLogger.BeginScope 恒返回 null,它不承担捕获作用域。

捕获日志

CaptureLoggerProvider 挂在进程级唯一工厂上,用 BeginScope 开启当前异步流的捕获会话;没有活动会话时日志直接丢弃,不影响其它 Provider:

using Cangming.Logs.Testing;

var capture = new CaptureLoggerProvider();

using var factory = LoggerFactory.Create(builder =>
    builder.AddProvider(new XUnitLoggerProvider(output))
           .AddProvider(capture));

var logger = factory.CreateLogger<MyTests>();

using var scope = capture.BeginScope();
logger.LogWarning(new EventId(7, "sample"), new InvalidOperationException("boom"), "温度 {Value}", 42);

var entry = Assert.Single(scope.Entries);
Assert.Equal("温度 42", entry.Message);
Assert.Equal(LogLevel.Warning, entry.Level);

CapturedLogEntry 包含类别、级别、EventId、格式化后的消息、原始异常、状态对象与捕获时间;formatter 抛异常时捕获为 <formatter threw ...>,不向写日志线程冒泡。

作用域语义

  • 作用域使用 AsyncLocal<CaptureSession>,只在当前异步流内生效;并行测试各自开作用域时互不串台。
  • 嵌套作用域内层覆盖外层,释放后恢复外层;作用域释放后仍可读取已捕获快照,但不再接收新日志。
  • CaptureScope.Clear() 只清空当前作用域,不结束作用域;重复 Dispose() 无副作用。
  • 捕获与输出是两个独立 Provider,可以同时挂;不要用 LogHub.BeginScope 替换工厂,当前库没有这条路线。
  • LogHub.Initialize 进程内只允许一次;需要让业务静态字段也进入捕获时,在测试程序集的 [ModuleInitializer] 或共享 fixture 中初始化一次,把 CaptureLoggerProvider 与业务工厂一起挂上,不要在测试类构造函数里重复初始化。

同族项目

项目 角色
Cangming.Logs.Contracts 契约(本工程不直接引用)
Cangming.Logs LogHub 门面(进程级工厂由宿主或测试程序集初始化)
Cangming.Logs.NLog 生产环境落地(与本工程平行:一个面向生产 NLog,一个面向测试)
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.9.1122 0 11/22/2026
0.1.8.1117 77 11/17/2026
0.1.7.1116 86 11/16/2026
0.1.6.1109 89 11/9/2026
0.1.5.1105 96 11/5/2026
0.1.4.1105 96 11/5/2026
0.1.3.1102 106 11/2/2026
0.1.2.1029 107 10/29/2026
0.1.1.1028 107 10/28/2026

见仓库根 CHANGELOG.md