Модульні тести з валідації MVC

Як я можу перевірити, що моя дія контролера вводить правильні помилки в ModelState під час перевірки сутності, коли я використовую перевірку даних DataAnnotation у MVC 2 Preview 1?

Якийсь код для ілюстрації. По-перше, дія:

    [HttpPost]
    public ActionResult Index(BlogPost b)
    {
        if(ModelState.IsValid)
        {
            _blogService.Insert(b);
            return(View("Success", b));
        }
        return View(b);
    }

І ось невдалий модульний тест, який, на мою думку, повинен проходити, але не проходить (за допомогою MbUnit & Moq):

[Test]
public void When_processing_invalid_post_HomeControllerModelState_should_have_at_least_one_error()
{
    // arrange
    var mockRepository = new Mock<IBlogPostSVC>();
    var homeController = new HomeController(mockRepository.Object);

    // act
    var p = new BlogPost { Title = "test" };            // date and content should be required
    homeController.Index(p);

    // assert
    Assert.IsTrue(!homeController.ModelState.IsValid);
}

Я думаю, на додаток до цього питання, чи варто мені перевіряти перевірку та чи слід перевіряти це таким чином?

Замість передачі a BlogPostви також можете оголосити параметр actions як FormCollection. Тоді ви можете створити BlogPostсебе і зателефонувати UpdateModel(model, formCollection.ToValueProvider());.

Це спричинить перевірку для будь-якого поля в FormCollection.

    [HttpPost]
    public ActionResult Index(FormCollection form)
    {
        var b = new BlogPost();
        TryUpdateModel(model, form.ToValueProvider());

        if (ModelState.IsValid)
        {
            _blogService.Insert(b);
            return (View("Success", b));
        }
        return View(b);
    }

Просто переконайтеся, що ваш тест додає нульове значення для кожного поля у формі подання, яке потрібно залишити порожнім.

Я виявив, що, роблячи це таким чином, за рахунок кількох зайвих рядків коду, мої модульні тести нагадують те, як код викликається під час виконання, роблять їх більш цінними. Також ви можете перевірити, що відбувається, коли хтось вводить "abc" у елемент керування, прив'язаний до властивості int.

Ненавиджу розміщувати стару публікацію, але я думав додати власні думки (оскільки я просто мав цю проблему і натрапляв на цю публікацію, шукаючи відповіді).

1. Не перевіряйте перевірку в тестах контролера. Або ви довіряєте валідації MVC, або пишете свій власний (тобто не тестуйте чужий код, протестуйте свій код)
2. Якщо ви хочете, щоб перевірка перевірки робить те, що ви очікуєте, протестуйте її у своїх тестах моделі (я роблю це для декількох моїх більш складних перевірок регулярних виразів).

Що ви справді хочете перевірити, це те, що ваш контролер робить те, що ви очікуєте, коли перевірка не вдається. Це ваш код і ваші очікування. Перевірити це легко, коли зрозумієш, що це все, що ти хочеш перевірити:

[test]
public void TestInvalidPostBehavior()
{
    // arrange
    var mockRepository = new Mock<IBlogPostSVC>();
    var homeController = new HomeController(mockRepository.Object);
    var p = new BlogPost();

    homeController.ViewData.ModelState.AddModelError("Key", "ErrorMessage"); // Values of these two strings don't matter.  
    // What I'm doing is setting up the situation: my controller is receiving an invalid model.

    // act
    var result = (ViewResult) homeController.Index(p);

    // assert
    result.ForView("Index")
    Assert.That(result.ViewData.Model, Is.EqualTo(p));
}

У мене була та ж проблема, і після прочитання відповіді та коментаря Паулса я шукав спосіб ручної перевірки моделі подання.

Я знайшов цей підручник, який пояснює, як вручну перевірити ViewModel, який використовує DataAnnotations. Фрагмент коду Key Key знаходиться в кінці допису.

Я трохи змінив код - у підручнику 4 параметр TryValidateObject опущено (validateAllProperties). Для того, щоб отримати всі анотації для перевірки, слід встановити значення true.

Крім того, я переробив код на загальний метод, щоб зробити тестування перевірки ViewModel простим:

    public static void ValidateViewModel<TViewModel, TController>(this TController controller, TViewModel viewModelToValidate) 
        where TController : ApiController
    {
        var validationContext = new ValidationContext(viewModelToValidate, null, null);
        var validationResults = new List<ValidationResult>();
        Validator.TryValidateObject(viewModelToValidate, validationContext, validationResults, true);
        foreach (var validationResult in validationResults)
        {
            controller.ModelState.AddModelError(validationResult.MemberNames.FirstOrDefault() ?? string.Empty, validationResult.ErrorMessage);
        }
    }

Наразі це у нас працювало дуже добре.

Коли ви викликаєте метод homeController.Index у своєму тесті, ви не використовуєте жодну структуру MVC, яка запускає перевірку, тому ModelState.IsValid завжди буде істинною. У нашому коді ми називаємо допоміжний метод Validate безпосередньо в контролері, а не використовуючи зовнішню перевірку. У мене не було великого досвіду роботи з DataAnnotations (ми використовуємо NHibernate.Validators), можливо, хтось інший може запропонувати вказівки щодо виклику перевірки з вашого контролера.

Я досліджував це сьогодні і знайшов цю публікацію в блозі Роберто Ернандеса (MVP), яка, мабуть, забезпечує найкраще рішення для запуску валідаторів для дії контролера під час модульного тестування. Це призведе до правильних помилок у ModelState під час перевірки сутності.

У своїх тестових випадках я використовую ModelBinders, щоб мати можливість оновити значення model.IsValid.

var form = new FormCollection();
form.Add("Name", "0123456789012345678901234567890123456789");

var model = MvcModelBinder.BindModel<AddItemModel>(controller, form);

ViewResult result = (ViewResult)controller.Add(model);

З моїм методом MvcModelBinder.BindModel наступним чином (в основному той самий код, який використовується всередині в рамках MVC):

        public static TModel BindModel<TModel>(Controller controller, IValueProvider valueProvider) where TModel : class
        {
            IModelBinder binder = ModelBinders.Binders.GetBinder(typeof(TModel));
            ModelBindingContext bindingContext = new ModelBindingContext()
            {
                FallbackToEmptyPrefix = true,
                ModelMetadata = ModelMetadataProviders.Current.GetMetadataForType(null, typeof(TModel)),
                ModelName = "NotUsedButNotNull",
                ModelState = controller.ModelState,
                PropertyFilter = (name => { return true; }),
                ValueProvider = valueProvider
            };

            return (TModel)binder.BindModel(controller.ControllerContext, bindingContext);
        }

Це точно не відповідає на ваше запитання, оскільки воно відмовляється від DataAnnotations, але я додаю його, оскільки це може допомогти іншим людям писати тести для своїх контролерів:

У вас є можливість не використовувати перевірку, надану System.ComponentModel.DataAnnotations, але все одно використовувати об’єкт ViewData.ModelState, використовуючи його AddModelErrorметод та деякі інші механізми перевірки. Наприклад:

public ActionResult Create(CompetitionEntry competitionEntry)
{        
    if (competitionEntry.Email == null)
        ViewData.ModelState.AddModelError("CompetitionEntry.Email", "Please enter your e-mail");

    if (ModelState.IsValid)
    {
       // insert code to save data here...
       // ...

       return Redirect("/");
    }
    else
    {
        // return with errors
        var viewModel = new CompetitionEntryViewModel();
        // insert code to populate viewmodel here ...
        // ...


        return View(viewModel);
    }
}

Це все ще дозволяє скористатися Html.ValidationMessageFor()матеріалом, який створює MVC, без використання DataAnnotations. Ви повинні переконатись, що ключ, який ви використовуєте для AddModelErrorзбігу, відповідає тому, що подання очікує для повідомлень про перевірку.

Потім контролер стає перевіряється, тому що перевірка відбувається явно, а не робиться автоматично в рамках MVC.

Я погоджуюсь, що ARM має найкращу відповідь: протестуйте поведінку свого контролера, а не вбудовану перевірку.

Однак ви також можете модульно перевірити, чи є у вашої моделі / ViewModel правильні визначені атрибути перевірки. Скажімо, ваш ViewModel виглядає так:

public class PersonViewModel
{
    [Required]
    public string FirstName { get; set; }
}

Цей модульний тест перевірить наявність [Required]атрибута:

[TestMethod]
public void FirstName_should_be_required()
{
    var propertyInfo = typeof(PersonViewModel).GetProperty("FirstName");

    var attribute = propertyInfo.GetCustomAttributes(typeof(RequiredAttribute), false)
                                .FirstOrDefault();

    Assert.IsNotNull(attribute);
}

На відміну від ARM, у мене немає проблем із копанням могил. Тож ось моя пропозиція. Він спирається на відповідь Джайлза Сміта і працює для ASP.NET MVC4 (я знаю, що питання стосується MVC 2, але Google не робить дискримінації при пошуку відповідей, і я не можу перевірити на MVC2.) Замість того, щоб вставляти код перевірки в загальний статичний метод, я помістив його в контролер тесту. Контролер має все необхідне для перевірки. Отже, контролер тесту виглядає так:

using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Wbe.Mvc;

protected class TestController : Controller
    {
        public void TestValidateModel(object Model)
        {
            ValidationContext validationContext = new ValidationContext(Model, null, null);
            List<ValidationResult> validationResults = new List<ValidationResult>();
            Validator.TryValidateObject(Model, validationContext, validationResults, true);
            foreach (ValidationResult validationResult in validationResults)
            {
                this.ModelState.AddModelError(String.Join(", ", validationResult.MemberNames), validationResult.ErrorMessage);
            }
        }
    }

Звичайно, клас не повинен бути захищеним внутрішнім класом, саме так я зараз його використовую, але, мабуть, я збираюся використовувати цей клас повторно. Якщо десь є модель MyModel, яка прикрашена приємними атрибутами анотації даних, то тест виглядає приблизно так:

    [TestMethod()]
    public void ValidationTest()
    {
        MyModel item = new MyModel();
        item.Description = "This is a unit test";
        item.LocationId = 1;

        TestController testController = new TestController();
        testController.TestValidateModel(item);

        Assert.IsTrue(testController.ModelState.IsValid, "A valid model is recognized.");
    }

Перевага цієї установки полягає в тому, що я можу повторно використовувати контрольний контролер для тестів усіх своїх моделей і, можливо, зможу розширити його, щоб трохи більше знущатися про контролер або використовувати захищені методи, які має контролер.

Сподіваюся, це допоможе.

Якщо ви дбаєте про перевірку, але вам байдуже про те, як вона реалізована, якщо вам важлива лише перевірка вашого методу дії на найвищому рівні абстракції, незалежно від того, реалізована вона як за допомогою DataAnnotations, ModelBinders або навіть ActionFilterAttributes, тоді ви можете використовувати пакет nuget Xania.AspNet.Simulator наступним чином:

install-package Xania.AspNet.Simulator

-

var action = new BlogController()
    .Action(c => c.Index(new BlogPost()), "POST");
var modelState = action.ValidateRequest();

modelState.IsValid.Should().BeFalse();

На основі відповідей та коментарів @ giles-smith для веб-API:

    public static void ValidateViewModel<TViewModel, TController>(this TController controller, TViewModel viewModelToValidate) 
        where TController : ApiController
    {
        var validationContext = new ValidationContext(viewModelToValidate, null, null);
        var validationResults = new List<ValidationResult>();
        Validator.TryValidateObject(viewModelToValidate, validationContext, validationResults, true);
        foreach (var validationResult in validationResults)
        {
            controller.ModelState.AddModelError(validationResult.MemberNames.FirstOrDefault() ?? string.Empty, validationResult.ErrorMessage);
        }
    }

Дивіться у редагуванні відповіді вище ...

Відповідь @ giles-smith - це мій кращий підхід, але реалізацію можна спростити:

    public static void ValidateViewModel(this Controller controller, object viewModelToValidate)
    {
        var validationContext = new ValidationContext(viewModelToValidate, null, null);
        var validationResults = new List<ValidationResult>();
        Validator.TryValidateObject(viewModelToValidate, validationContext, validationResults, true);
        foreach (var validationResult in validationResults)
        {
            controller.ModelState.AddModelError(validationResult.MemberNames.FirstOrDefault() ?? string.Empty, validationResult.ErrorMessage);
        }
    }