测试WebApi控制器Url.Link

Question

我有以下控制器操作

public void Post(Dto model)
{
    using (var message = new MailMessage())
    {
        var link = Url.Link("ConfirmAccount", new { model.Id });

        message.To.Add(model.ToAddress);
        message.IsBodyHtml = true;
        message.Body = string.Format(@"<p>Click <a href=""{0}"">here</a> to complete your registration.<p><p>You may also copy and paste this link into your browser.</p><p>{0}</p>", link);

        MailClient.Send(message);
    }
}

为了测试这个,我需要设置控制器上下文

var httpConfiguration = new HttpConfiguration(new HttpRouteCollection { { "ConfirmAccount", new HttpRoute() } });
var httpRouteData = new HttpRouteData(httpConfiguration.Routes.First());
var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, "http://localhost");
sut = new TheController
{
    ControllerContext = new HttpControllerContext(httpConfiguration, httpRouteData, httpRequestMessage),
    MailClient = new SmtpClient { PickupDirectoryLocation = location }
};

这似乎是很多设置来测试链接的创建.有更清洁的方法吗？我已经阅读过有关内存服务器的内容,但看起来它比httpclient更适用于直接测试控制器.

Answer 1

我开始在Web API 2.0中使用这种方法.

如果你正在使用一个模拟库(并且你真的应该用于任何真实世界的单元测试),你可以直接模拟UrlHelper对象,就像它上面的所有方法一样virtual.

var mock = new Mock<UrlHelper>();
mock.Setup(m => m.Link(It.IsAny<string>(), It.IsAny<object>())).Returns("test url");

var controller = new FooController {
    Url = mock.Object
};

这是一个比Ben Foster的答案更清晰的解决方案,因为使用这种方法,您需要为您正在使用的每个名称添加路由到配置.这可能很容易改变或成为一个可笑的大量路线设置.

Answer 2

下面是UrlHelper没有任何类型的模拟库测试所需的绝对最小代码.扔我(并花了我一些时间追踪)的事情是你需要设置IHttpRouteData请求.如果不这样做,IHttpRoute实例将无法生成导致空URL的虚拟路径.

    public class FooController : ApiController
    {
        public string Get()
        {
            return Url.Link(RouteNames.DefaultRoute, new { controller = "foo", id = "10" });
        }
    }

    [TestFixture]
    public class FooControllerTests
    {
        FooController controller;

        [SetUp]
        public void SetUp()
        {
            var config = new HttpConfiguration();

            config.Routes.MapHttpRoute(
                name: "Default",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional });

            var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost");
            request.Properties[HttpPropertyKeys.HttpConfigurationKey] = config;
            request.Properties[HttpPropertyKeys.HttpRouteDataKey] = new HttpRouteData(new HttpRoute());

            controller = new FooController
            {
                Request = request
            };
        }

        [Test]
        public void Get_returns_link()
        {
            Assert.That(controller.Get(), Is.EqualTo("http://localhost/api/foo/10"));
        }
    }

Answer 3

我也遇到了同样的白痴。我能找到的所有参考资料都希望您模拟请求/控制器，这是（正如您所指出的）大量工作。

具体参考：

• http://aspnetwebstack.codeplex.com/discussions/358709/
• http://www.peterprovost.org/blog/2012/06/16/unit-testing-asp-dot-net-web-api/#testing-the-harder-stuff-postproduct
• ASP.NET MVC 控制器单元测试 - UrlHelper 扩展问题
• ASP.NET MVC：使用 UrlHelper 的单元测试控制器
• 互联网的其余部分

我还没有抽出时间尝试实际的模拟框架，所以我有一个辅助类来“构建”我的控制器。所以而不是

sut = new TheController { ... }

我用类似的东西：

// actually rolled together to `sut = MyTestSetup.GetController(method, url)`
sut = new TheController()...
MyTestSetup.FakeRequest(sut, HttpMethod.Whatever, "~/the/expected/url");

作为参考，方法基本上是：

public void FakeRequest(ApiController controller, HttpMethod method = null, string requestUrl = null, string controllerName = null) {
    HttpConfiguration config = new HttpConfiguration();
    // rebuild the expected request
    var request = new HttpRequestMessage( null == method ? this.requestMethod : method, string.IsNullOrWhiteSpace(requestUrl) ? this.requestUrl : requestUrl);
    //var route = System.Web.Routing.RouteTable.Routes["DefaultApi"];
    var route  = config.Routes.MapHttpRoute("DefaultApi", "api/{controller}/{id}");

    // TODO: get from application?  maybe like https://stackoverflow.com/a/5943810/1037948
    var routeData = new HttpRouteData(route, new HttpRouteValueDictionary { { "controller", string.IsNullOrWhiteSpace(controllerName) ? this.requestController : controllerName } });

    controller.ControllerContext = new HttpControllerContext(config, routeData, request);

    // attach fake request
    controller.Request = request;
    controller.Request.Properties[/* "MS_HttpConfiguration" */ HttpPropertyKeys.HttpConfigurationKey] = config;
}