想要在 ASP.NET Core 2.1 中为 ViewComponent 创建一个单元测试

Question

在 ASP.NET Core 2.1 中，ViewComponents 与部分页面相比的一大广告优势是它们非常容易测试。我在文档中找不到任何关于如何实际测试的示例。

我的 ViewComponent 在其构造函数中采用 IConfiguration，因此我可以注入 AppSetting 值。它使用 Invoke 传入的几个参数执行。我假设我想以某种方式测试返回到视图的模型并确保它是我所期望的（基于 AppSettings 和这两个参数）。

[编辑] 这是一个简单的 ViewComponent 示例，它使用配置服务并将参数传递给调用。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;

namespace WebApp.Pages.Components.RatingControl
{

    public class MyModel
    {
        public string MyVal1 { get; set; }
        public string MyVal2 { get; set; }
    }

    public class MyViewData
    {
        public MyModel MyModel { get; set; }
        public string Param1 { get; set; }
    }
    public class SimpleViewComponent : ViewComponent
    {
        private readonly MyModel _myModel;

        public SimpleViewComponent(IConfiguration config)
        {
            _myModel = new MyModel
            {
                MyVal1 = config["myVal1"],
                MyVal2 = config["myVal2"],
            };
        }

        public IViewComponentResult Invoke(string param1)
        {
            var myViewData = new MyViewData
            {
                MyModel = _myModel,
                Param1 = param1
            };

            return View(myViewData);
        }

    }
}

也许这很明显，但我有点迷路了。

Answer 1

真的不应该将IConfiguration 作为依赖项传递。您已经有一个要填充的模型，因此您可以利用配置框架的绑定功能，并在启动时从配置中显式注入填充的模型..

所以假设你的 appsetting.json 文件

{
  ...

  "myval1": "value1",
  "myval2": "value2",

  ...
}

和现有的MyModel，您可以按照文档中的建议做法在启动时从配置中绑定对象图。

var builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json");

Configuration = builder.Build();

var myModel = new MyModel();
Configuration.Bind(myModel);

然后您将使用服务集合注册模型应用设置

services.AddSingleton(myModel);

因为视图组件是由框架通过依赖注入初始化的。

现在真的不需要将IConfiguration 注入到视图组件中，因为模型可以作为显式依赖项注入

public class SimpleViewComponent : ViewComponent {
    private readonly MyModel model;

    public SimpleViewComponent(MyModel model) {
        this.model = model;
    }

    public IViewComponentResult Invoke(string param1) {
        var myViewData = new MyViewData {
            MyModel = model,
            Param1 = param1
        };
        return View(myViewData);
    }
}

所有这些都将使单独测试视图组件变得相当容易，因为初始化模型的假实例是一件简单的事情。

//Arrange
var model = new MyModel {
    MyVal1 = "test1",
    MyVal2 = "test2",
}

var viewComponent = new SimpleViewComponent(model);
var param1 = "param1";

//Act
var result = viewComponent.Invoke(param1);

//Assert
result.Should().NotBeNull();
result.ViewData.Model
    .Should().NotBeNull()
    .And.BeOfType<MyViewData>();
//...other assertions