如何测试属性是否需要注释？

Question

我有这样定义的属性：

[Required(ErrorMessage="The Year of Manufacture has to be filled")]
public int? YearOfManufacture { get; set; }

如果属性设置了所需的Annotation，我该如何编写单元测试，测试哪些？

Answer 1

您可以有一个测试助手方法，该方法将在您的视图模型的特定实例上运行验证：

public bool TryValidate(object model, out ICollection<ValidationResult> results)
{
    var context = new ValidationContext(model, serviceProvider: null, items: null);
    results = new List<ValidationResult>();
    return Validator.TryValidateObject(
        model, context, results, validateAllProperties: true
    );
}

然后在你的单元测试中：

[TestMethod]
public void YearOfManufacture_Is_Required()
{
    // arrange
    var sut = new MyViewModel();
    sut.YearOfManufacture = null;
    ICollection<ValidationResult> results;

    // act
    var actual = TryValidate(sut, out results);

    // assert
    Assert.IsFalse(actual);
}

除了使用DataAnnotations，您还可以查看FluentValidation.NET，它允许您以流畅的方式表达更复杂的验证规则，它有一个很好的integration with MVC 和testing，您的验证规则更加容易。

Answer 2

我会为此推荐FluentAssertions，它可以让你非常干净地做到这一点：

typeof(MyType)
    .GetProperty("YearOfManufacture")
    .Should()
    .BeDecoratedWith<RequiredAttribute>("because MyType.YearOfManufacture is required.");

Answer 3

如果您 - 无论出于何种原因 - 想要测试，属性被注释（而不是测试验证注释是否有效），您可以使用建议的扩展方法 here 在您的测试：

public static T GetAttributeFrom<T>(this object instance, string propertyName) where T : Attribute
{
    var attrType = typeof(T);
    var property = instance.GetType().GetProperty(propertyName);
    return (T)property .GetCustomAttributes(attrType, false).FirstOrDefault();
}

编辑： (1) 使用 FirstOrDefault() 而不是 First() 来正确处理非注释属性。 (2) @Pavel Straka：在下面添加了更多示例代码来回答 Pavel Straka 的评论。

class Sample
{
    [Required(ErrorMessage = "The Year of Manufacture has to be filled")]
    public int? YearOfManufacture { get; set; }

    public int? NotAttributedProperty { get; set; }
}

static class Annotations
{
    public static T GetAttributeFrom<T>(this object instance, string propertyName) where T : Attribute
    {
        var attrType = typeof(T);
        var property = instance.GetType().GetProperty(propertyName);
        return (T)property.GetCustomAttributes(attrType, false).FirstOrDefault();
    }
}

class Program
{
    static void Main(string[] args)
    {
        var sampleInstance = new Sample();
        var annotation = sampleInstance.GetAttributeFrom<RequiredAttribute>("YearOfManufacture");
        var nullAnnotation = sampleInstance.GetAttributeFrom<RequiredAttribute>("NotAttributedProperty");
    }
}