如何让dotCover统计C#模型属性自定义特性的测试覆盖率？

dotCover默认不会将特性的元数据定义纳入覆盖率统计，只有当特性的构造函数被调用或内部逻辑被执行时，才会被计入覆盖范围。以下是具体的测试编写方法：

核心逻辑说明 #

特性本质是元数据标记，dotCover不会自动扫描属性上的特性定义来统计覆盖。必须在测试中显式触发特性的实例化或逻辑执行，才能让dotCover识别到这些代码被使用。

分场景测试写法 #

场景1：特性仅包含构造逻辑（无额外方法） #

如果你的特性只有构造函数（比如带参数的属性初始化），需要通过反射获取属性上的特性实例，触发构造函数执行：

示例代码

自定义特性与模型：

public class RequiredWithMessageAttribute : Attribute
{
    public string ErrorMessage { get; }

    public RequiredWithMessageAttribute(string errorMessage)
    {
        ErrorMessage = errorMessage;
    }
}

public class OrderModel
{
    [RequiredWithMessage("订单编号不能为空")]
    public string OrderId { get; set; }
}

测试代码：

[Test]
public void RequiredWithMessageAttribute_IsAppliedToOrderIdProperty()
{
    // 通过反射获取特性实例，触发构造函数
    var orderIdProperty = typeof(OrderModel).GetProperty(nameof(OrderModel.OrderId));
    var attribute = orderIdProperty.GetCustomAttribute<RequiredWithMessageAttribute>();

    // 验证特性参数是否正确，确保构造逻辑符合预期
    Assert.That(attribute.ErrorMessage, Is.EqualTo("订单编号不能为空"));
}

场景2：特性包含自定义业务逻辑（如验证方法） #

如果特性内部有可执行的方法（比如验证、格式化逻辑），除了实例化特性，还需要调用这些方法来覆盖对应的代码：

示例代码

带逻辑的自定义特性：

public class StringLengthLimitAttribute : Attribute
{
    public int MaxLength { get; }
    public string OverLimitMessage { get; }

    public StringLengthLimitAttribute(int maxLength, string overLimitMessage)
    {
        MaxLength = maxLength;
        OverLimitMessage = overLimitMessage;
    }

    public bool IsWithinLimit(string input)
    {
        return input == null || input.Length <= MaxLength;
    }
}

public class UserProfileModel
{
    [StringLengthLimit(20, "昵称长度不能超过20个字符")]
    public string Nickname { get; set; }
}

测试代码：

// 测试特性的业务逻辑
[Test]
public void StringLengthLimitAttribute_IsWithinLimit_ReturnsCorrectResult()
{
    var attribute = new StringLengthLimitAttribute(20, "昵称长度不能超过20个字符");
    
    var validCase = attribute.IsWithinLimit("合法昵称");
    var invalidCase = attribute.IsWithinLimit("这个昵称长度明显超过了二十个字符的限制");

    Assert.Multiple(() =>
    {
        Assert.That(validCase, Is.True);
        Assert.That(invalidCase, Is.False);
    });
}

// 测试特性是否正确应用到属性上
[Test]
public void StringLengthLimitAttribute_IsAppliedToNicknameProperty()
{
    var nicknameProperty = typeof(UserProfileModel).GetProperty(nameof(UserProfileModel.Nickname));
    var attribute = nicknameProperty.GetCustomAttribute<StringLengthLimitAttribute>();

    Assert.That(attribute, Is.Not.Null);
    Assert.That(attribute.MaxLength, Is.EqualTo(20));
}

额外注意事项 #

• 检查dotCover的覆盖率过滤设置，确保没有排除特性所在的程序集或类型；
• 确保测试被正常执行，没有被标记为跳过或忽略；
• 对于框架自动调用的特性（如ASP.NET Core的验证特性），集成测试中触发框架的验证流程也能覆盖特性逻辑，但单元测试仍需显式调用以保证覆盖全面。

内容的提问来源于stack exchange，提问作者s.d.90