關於單元測試的思考--Asp.Net Core單元測試最佳實踐

在我們碼字過程中，單元測試是必不可少的。但在從業過程中，很多開發者卻對單元測試望而卻步。有些時候並不是不想寫，而是常常會碰到下麵這些問題，讓開發者放下了碼字的腳步：

1. 這個類初始數據太麻煩，你看：new MyService(new User("test",1), new MyDAO(new Connection(......)),new ToManyPropsClass(......) .....) 。我：。。。
2. 這個代碼內部邏輯都是和Cookie有關，我單元測試不好整啊，還是得啟動到瀏覽器里一個按鈕一個按鈕點。
3. 這個代碼內部讀了配置文件，單元測試也不能給我整個配置文件啊？
4. 這個代碼主要是驗證WebAPI入口得模型綁定，必須得調用一次啊？

這些問題確實存在，但它們阻止不了我們那顆要寫單元測試的心。單元測試的優點很多，你或許可以不管。但至少能讓你從那些需要在瀏覽器里點擊10多下的操作里解脫出來。本文從一個簡單的邏輯測試出發，慢慢拉開測試的大幕，讓你愛上測試。文章主要是傳播一些單元測試的理念，其次才是介紹asp.net core中的單元測試。

本文使用的環境為asp.net core 2.1 webapi，所有代碼都發佈到github:https://github.com/yubaolee/DotNetCoreUnitTestSamples 項目依賴的包為：

    <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="2.1.0" />
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.5.0" />
    <PackageReference Include="Moq" Version="4.8.3" />
    <PackageReference Include="NUnit" Version="3.9.0" />
    <PackageReference Include="NUnit3TestAdapter" Version="3.9.0" />
    <PackageReference Include="System.Linq" Version="4.3.0" />

可以直接修改csproj文件，也可以nuget導入。

測試的業務邏輯為：

public class UserService{
        public bool CheckLogin(UserInfo user)
        {
            return user.Name == user.Password;  //登錄邏輯，為了看著舒服，少點
        }
    }
public class UserInfo{
        public string Name { get; set; }
        public string Password { get; set; }
    }

測試的WebAPI控制器如下：

 public class ValuesController : ControllerBase
    {
        private UserService _service;

        public ValuesController(UserService service)
        {
            _service = service;
        }

        [HttpGet]
        [Route("checklogin")]
        public bool CheckLogin([FromQuery]UserInfo user)
        {
            return _service.CheckLogin(user);
        }

    }

普通業務的單元測試

public class TestService
    {
        private UserService _service;

        [SetUp]
        public void Init()
        {
            var server = new TestServer(WebHost.CreateDefaultBuilder().UseStartup<Startup>());
            _service = server.Host.Services.GetService<UserService>();
        }
        [Test]
        public void TestLogin()
        {
            bool result = _service.CheckLogin(new UserInfo { Name = "yubao", Password = "yubao" });
            Assert.IsTrue(result);
        }
    }

 在做業務測試過程中要善於使用註入功能，而不是使用new對象的方式，比如這裡的Host.Services.GetService，防止出現new MyService(new User("test",1), new MyDAO(new Connection(......)),new ToManyPropsClass(......) .....)這種尷尬。用的越多你就越能體會這種做法的好處。我在openauth.net中使用的是autofac的AutofacServiceProvider。

測試Controller

很多時候我們需要測試頂層的controller（八成是controller里混的有業務邏輯）。這時我們可以快速的寫出下麵的測試代碼：

 public class TestController
    {
        private ValuesController _controller;

        [SetUp]
        public void Init()
        {
            var server = new TestServer(WebHost.CreateDefaultBuilder().UseStartup<Startup>());
            _controller = server.Host.Services.GetService<ValuesController>();
        }
        [Test]
        public void TestLogin()
        {
            bool result = _controller.CheckLogin(new UserInfo{Name = "yubao",Password = "yubao"});
            Assert.IsTrue(result);
        }
    }

這段代碼在JAVA spring mvc框架下是沒有問題的，但在asp.net core 中，你會發現：

獲取不到controller？spring mvc的理念就是萬物皆服務，哪怕是一個controller也是一個普通的服務。但微軟不喜歡這樣，預設時它要掌控controller的生死（The Subtle Perils of Controller Dependency Injection in ASP.NET Core MVC 有人在聲討微軟了）。所以我們不能通過普通的ServicCollection來註入和獲取它，除非你指明Controller As Service，如下：

 public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().AddControllersAsServices().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        }

這時即可順利測試通過。

測試含有HTTP上下文的業務邏輯，比如Cookie、URL中的QueryString

在平時的代碼過程中，常常會和HTTP上下文HttpContext打交道，最常見的如request、response、cookie、querystring等，比如我們新的邏輯：

public class UserService
    {
        private IHttpContextAccessor _httpContextAccessor;

        public UserService(IHttpContextAccessor httpContextAccessor)
        {
            _httpContextAccessor = httpContextAccessor;
        }

        public bool IsLogin()
        {
            return _httpContextAccessor.HttpContext.Request.Cookies["username"] != null;
        }
    }

這時如何測試呢？馬丁福勒在他的大作《企業應用架構模式》中明確指出“測試樁”的概念，來應對這種情況。各種Mock框架應運而生。比如我最喜歡的Moq：

public class TestCookie
    {
        private UserService _service;

        [SetUp]
        public void Init()
        {
            var httpContextAccessorMock = new Mock<IHttpContextAccessor>();
            httpContextAccessorMock.Setup(x => x.HttpContext.Request.Cookies["username"]).Returns("yubaolee");

            var server = new TestServer(WebHost.CreateDefaultBuilder()
                .ConfigureServices(u =>u.AddScoped(x =>httpContextAccessorMock.Object))
                .UseStartup<Startup>());
            _service = server.Host.Services.GetService<UserService>();
        }
        [Test]
        public void TestLogin()
        {
            bool result = _service.IsLogin();
            Assert.IsTrue(result);
        }
    }

  測試一次HTTP請求

 有時我們需要測試Mvc框架的模型綁定，看看一次客戶端的請求是否能被正確解析，亦或者測試WebAPI入口的一些Filter AOP等是否被正確觸發，這時就需要測試一次HTTP請求。從嚴格意義上來講這種測試已經脫離的單元測試的範疇，屬於集成測試。但這種測試代碼可以節省我們大量的重覆勞動。asp.net core中可以通過TestServer快速實現這種模擬：

public class TestHttpRequest
    {
        private TestServer _testServer;

        [SetUp]
        public void Init()
        {
            _testServer = new TestServer(WebHost.CreateDefaultBuilder().UseStartup<Startup>());
        }
        [Test]
        public void TestLogin()
        {
            var client = _testServer.CreateClient();
            var result = client.GetStringAsync("/api/values/checklogin?name=yubao&password=yubao");
            Console.WriteLine(result.Result);
        }
    }

在進行單元測試的過程中，測試的理念（或者TDD的思維？）異常重要，它能幫助你構建和諧優美的代碼。

G