单元测试方法参数的BindAttribute

时间:2015-06-05 16:06:28

标签: c# asp.net-mvc unit-testing model-binding

我希望编写单元测试来验证我的控制器,同时确保正确设置绑定属性。使用以下方法结构,如何确保仅从单元测试传递有效字段?

public ActionResult AddItem([Bind(Include = "ID, Name, Foo, Bar")] ItemViewModel itemData)
{
    if (ModelState.IsValid)
    {
        // Save and redirect
    }

    // Set Error Messages
    // Rebuild object drop downs, etc.
    itemData.AllowedFooValues = new List<Foo>();
    return View(itemData);
}

更广泛的说明: 我们的许多模型都列出了我们不想来回发送的允许值列表,因此我们在(ModelState.IsValid == false)时重建它们。为了确保这些工作,我们希望将单元测试放在原位以断言列表已重建,但在调用方法之前没有清除列表,测试无效。

我们正在使用此SO answer中的辅助方法来确保模型经过验证,然后我们的单元测试就是这样。

    public void MyTest()
    {
        MyController controller = new MyController();

        ActionResult result = controller.AddItem();
        Assert.IsNotNull(result);
        ViewResult viewResult = result as ViewResult;
        Assert.IsNotNull(viewResult);
        ItemViewModel itemData = viewResult.Model as ItemViewModel;
        Assert.IsNotNull(recipe);
        // Validate model, will fail due to null name
        controller.ValidateViewModel<ItemViewModel, MyController>(itemData);

        // Call controller action
        result = controller.AddItem(itemData);
        Assert.IsNotNull(result);
        viewResult = result as ViewResult;
        Assert.IsNotNull(viewResult);
        itemData = viewResult.Model as ItemViewModel;
        // Ensure list was rebuilt
        Assert.IsNotNull(itemData.AllowedFooValues);
    }

非常感谢任何正确方向的帮助或指示。

2 个答案:

答案 0 :(得分:3)

我可能会误解你所说的内容,但听起来你需要一些东西来确保你在测试中创建的模型在传递给你的控制器之前被过滤以模拟MVC绑定并防止您不小心编写了一个测试,该测试将信息传递给您正在测试的控制器,而该控制器实际上从未被框架填充。

考虑到这一点,我假设您只对Include成员集的Bind属性真正感兴趣。在这种情况下,您可以使用以下内容:

public static void PreBindModel<TViewModel, TController>(this TController controller, 
                                                         TViewModel viewModel, 
                                                         string operationName) {
    foreach (var paramToAction in typeof(TController).GetMethod(operationName).GetParameters()) {
        foreach (var bindAttribute in paramToAction.CustomAttributes.Where(x => x.AttributeType == typeof(BindAttribute))) {
            string properties;
            try {
                properties = bindAttribute.NamedArguments.Where(x => x.MemberName == "Include").First().TypedValue.Value.ToString();
            }
            catch (InvalidOperationException) {
                continue;
            }
            var propertyNames = properties.Split(',');

            var propertiesToReset = typeof(TViewModel).GetProperties().Where(x => propertyNames.Contains(x.Name) == false);

            foreach (var propertyToReset in propertiesToReset) {
                propertyToReset.SetValue(viewModel, null);
            }
        }
    }
}

在您调用控制器操作之前,将从您的单元测试中调用它:

controllerToTest.PreBindModel(model, "SomeMethod");
var result = controllerToTest.SomeMethod(model);

本质上,它所做的是迭代传递给给定控制器方法的每个参数,寻找绑定属性。如果它找到了绑定属性,那么它将获得Include列表,然后它会重置包含列表中未提及的viewModel的每个属性(基本上解除绑定)。

上面的代码可能需要一些调整,我不做很多MVC工作,所以我对属性和模型的使用做了一些假设。

上述代码的改进版本,它使用BindAttribute本身进行过滤:

public static void PreBindModel<TViewModel, TController>(this TController controller, TViewModel viewModel, string operationName) {
    foreach (var paramToAction in typeof(TController).GetMethod(operationName).GetParameters()) {
        foreach (BindAttribute bindAttribute in paramToAction.GetCustomAttributes(true)) {//.Where(x => x.AttributeType == typeof(BindAttribute))) {
            var propertiesToReset = typeof(TViewModel).GetProperties().Where(x => bindAttribute.IsPropertyAllowed(x.Name) == false);

            foreach (var propertyToReset in propertiesToReset) {
                propertyToReset.SetValue(viewModel, null);
            }
        }
    }
}

答案 1 :(得分:1)

根据Forsvarir提供的答案,我想出了这个作为我的最终实施。我删除了泛型以减少每次使用时的输入,并将其放在我的测试的基类中。我还必须为具有相同名称但不同参数的多个方法做一些额外的工作(例如:Get vs. Post),这是通过所有方法的循环而不是GetMethod解决的。

get 'settings'  => 'users/registrations#edit', as: 'edit_user_registration'
put 'settings/:id' => 'users/registrations#update', as: 'update_user_registration'

总的来说,这是一个非常简洁的解决方案,所以现在我的测试看起来像这样:

<%= form_for(resource,  as: resource_name,
                        url: update_user_registration_path(resource_name),
                        html: { method: :put }) do |f| %>

仅供参考,我的ValidateViewModel方法是:

    public static void PreBindModel(Controller controller, ViewModelBase viewModel, string operationName)
    {
        MethodInfo[] methods = controller.GetType().GetMethods();
        foreach (MethodInfo currentMethod in methods)
        {
            if (currentMethod.Name.Equals(operationName))
            {
                bool foundParamAttribute = false;
                foreach (ParameterInfo paramToAction in currentMethod.GetParameters())
                {
                    object[] attributes = paramToAction.GetCustomAttributes(true);
                    foreach (object currentAttribute in attributes)
                    {
                        BindAttribute bindAttribute = currentAttribute as BindAttribute;
                        if (bindAttribute == null)
                            continue;

                        PropertyInfo[] allProperties = viewModel.GetType().GetProperties();
                        IEnumerable<PropertyInfo> propertiesToReset =
                            allProperties.Where(x => bindAttribute.IsPropertyAllowed(x.Name) == false);

                        foreach (PropertyInfo propertyToReset in propertiesToReset)
                        {
                            propertyToReset.SetValue(viewModel, null);
                        }

                        foundParamAttribute = true;
                    }
                }

                if (foundParamAttribute)
                    return;
            }
        }
    }