溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
小編給大家分享一下ASP.NET Core項目如何使用xUnit進行單元測試，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！
在以前的.NET Framework項目中，我們也寫過一些單元測試的項目，而在ASP.NET Core 這種Web或者API應用程序中要做單元測試是很方便的。
這篇文章主要講解如何使用xUnit對ASP.NET Core應用程序做單元測試。.NET Core中常用的測試工具還有NUnit和MSTest。
xUnit是一個測試框架，可以針對.net/.net core項目進行測試。測試項目需要引用被測試的項目，從而對其進行測試。測試項目同時需要引用xUnit庫。測試編寫好后，用Test Runner來運行測試。Test Runner可以讀取測試代碼，并且會知道我們所使用的測試框架，然后執行，并顯示結果。目前可用的Test Runner包括vs自帶的Test Explorer，或者dotnet core命令行，以及第三方工具，例如resharper等。
xUnit可以支持多種平臺的測試：
.NET Framework
.NET Core
.NET Standard
UWP
Xamarin
為了使示例項目更加的貼近真實的項目開發，這里采用分層的方式創建一個示例項目，創建完成后的項目結構如下圖所示：
下面講解一下每層的作用，按照從上往下的順序：
TestDemo：從名字就可以看出來，這是一個單元測試的項目，針對控制器進行測試。
UnitTest.Data：數據訪問，封裝與EntityFrameworkCore相關的操作。
UnitTest.IRepository：泛型倉儲接口，封裝基礎的增刪改查。
UnitTest.Model：實體層，定義項目中使用到的所有實體。
UnitTest.Repository：泛型倉儲接口實現層，實現接口里面定義的方法。
UnitTestDemo：ASP.NET Core WebApi，提供API接口。
實體層里面只有一個Student類：
using System;
using System.Collections.Generic;
using System.Text;
namespace UnitTest.Model
{
public class Student
{
public int ID { get; set; }
public string Name { get; set; }
public int Age { get; set; }
public string Gender { get; set; }
}
}里面封裝與EF Core有關的操作，首先需要引入Microsoft.EntityFrameworkCore、Microsoft.EntityFrameworkCore.SqlServer、Microsoft.EntityFrameworkCore.Tools三個NuGet包，直接在管理NuGet程序包里面引入，這里不在講述。
引入相關NuGet包以后，我們創建數據上下文類，該類繼承自EF Core的DbContext，里面設置表名和一些屬性：
using Microsoft.EntityFrameworkCore;
using UnitTest.Model;
namespace UnitTest.Data
{
/// <summary>
/// 數據上下文類
/// </summary>
public class AppDbContext : DbContext
{
/// <summary>
/// 通過構造函數給父類構造傳參
/// </summary>
/// <param name="options"></param>
public AppDbContext(DbContextOptions<AppDbContext> options) : base(options)
{
}
public DbSet<Student> Students { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Student>().ToTable("T_Student");
modelBuilder.Entity<Student>().HasKey(p => p.ID);
modelBuilder.Entity<Student>().Property(p => p.Name).HasMaxLength(32);
// 添加種子數據
modelBuilder.Entity<Student>().HasData(
new Student()
{
ID = 1,
Name = "測試1",
Age = 20,
Gender = "男"
},
new Student()
{
ID = 2,
Name = "測試2",
Age = 22,
Gender = "女"
},
new Student()
{
ID = 3,
Name = "測試3",
Age = 23,
Gender = "男"
});
base.OnModelCreating(modelBuilder);
}
}
}這里采用數據遷移的方式生成數據庫，需要在API項目中引入Microsoft.EntityFrameworkCore、Microsoft.EntityFrameworkCore.SqlServer、Microsoft.EntityFrameworkCore.Tools三個NuGet包。引入方式同上。
然后在API項目的appsettings.json文件里面添加數據庫鏈接字符串：
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"AllowedHosts": "*",
// 數據庫連接字符串
"ConnectionString": {
"DbConnection": "Initial Catalog=TestDb;User Id=sa;Password=1234;Data Source=.;Connection Timeout=10;"
}
}在JSON文件中添加完連接字符串以后，修改Startup類的ConfigureServices方法，在里面配置使用在json文件中添加的連接字符串：
// 添加數據庫連接字符串
services.AddDbContext<AppDbContext>(options =>
{
options.UseSqlServer(Configuration.GetSection("ConnectionString").GetSection("DbConnection").Value);
});這樣就可以使用數據遷移的方式生成數據庫了。
該項目中使用泛型倉儲，定義一個泛型倉儲接口：
using System.Collections.Generic;
using System.Threading.Tasks;
namespace UnitTest.IRepository
{
public interface IRepository<T> where T:class,new()
{
Task<List<T>> GetList();
Task<int?> Add(T entity);
Task<int?> Update(T entity);
Task<int?> Delete(T entity);
}
}然后在定義IStudentRepository接口繼承自IRepository泛型接口：
using UnitTest.Model;
namespace UnitTest.IRepository
{
public interface IStudentRepository: IRepository<Student>
{
}
}這里是實現上面定義的倉儲接口：
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using UnitTest.Data;
using UnitTest.IRepository;
using UnitTest.Model;
namespace UnitTest.Repository
{
public class StudentRepository : IStudentRepository
{
private readonly AppDbContext _dbContext;
/// <summary>
/// 通過構造函數實現依賴注入
/// </summary>
/// <param name="dbContext"></param>
public StudentRepository(AppDbContext dbContext)
{
_dbContext = dbContext;
}
public async Task<int?> Add(Student entity)
{
_dbContext.Students.Add(entity);
return await _dbContext.SaveChangesAsync();
}
public async Task<int?> Delete(Student entity)
{
_dbContext.Students.Remove(entity);
return await _dbContext.SaveChangesAsync();
}
public async Task<List<Student>> GetList()
{
List<Student> list = new List<Student>();
list = await Task.Run<List<Student>>(() =>
{
return _dbContext.Students.ToList();
});
return list;
}
public async Task<int?> Update(Student entity)
{
Student student = _dbContext.Students.Find(entity.ID);
if (student != null)
{
student.Name = entity.Name;
student.Age = entity.Age;
student.Gender = entity.Gender;
_dbContext.Entry<Student>(student).State = Microsoft.EntityFrameworkCore.EntityState.Modified;
return await _dbContext.SaveChangesAsync();
}
return 0;
}
}
}先添加一個Value控制器，里面只有一個Get方法，而且沒有任何的依賴關系，先進行最簡單的測試：
using Microsoft.AspNetCore.Mvc;
namespace UnitTestDemo.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class ValueController : ControllerBase
{
[HttpGet("{id}")]
public ActionResult<string> Get(int id)
{
return $"Para is {id}";
}
}
}我們在添加測試項目的時候，直接選擇使用xUnit測試項目，如下圖所示：
這樣項目創建完成以后，就會自動添加xUnit的引用：
<ItemGroup> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" /> <PackageReference Include="xunit" Version="2.4.1" /> <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" /> </ItemGroup>
但要測試 ASP.NET Core 應用還需要添加兩個 NuGet 包：
Install-Package Microsoft.AspNetCore.App Install-Package Microsoft.AspNetCore.TestHost
上面是使用命令的方式進行安裝，也可以在管理NuGet程序包里面進行搜索，然后安裝。
千萬不要忘記還要引入要測試的項目。最后的項目引入是這樣的：
<Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <TargetFramework>netcoreapp3.1</TargetFramework> <IsPackable>false</IsPackable> </PropertyGroup> <ItemGroup> <PackageReference Include="Microsoft.AspNetCore.App" Version="2.2.8" /> <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="3.1.2" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" /> <PackageReference Include="Newtonsoft.Json" Version="12.0.3" /> <PackageReference Include="xunit" Version="2.4.1" /> <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" /> <PackageReference Include="coverlet.collector" Version="1.0.1" /> </ItemGroup> <ItemGroup> <ProjectReference Include="..\UnitTest.Model\UnitTest.Model.csproj" /> <ProjectReference Include="..\UnitTestDemo\UnitTestDemo.csproj" /> </ItemGroup> </Project>
都添加完以后，重新編譯項目，保證生成沒有錯誤。
單元測試按照從上往下的順序，一般分為三個階段：
Arrange：準備階段。這個階段做一些準備工作，例如創建對象實例，初始化數據等。
Act：行為階段。這個階段是用準備好的數據去調用要測試的方法。
Assert：斷定階段。這個階段就是把調用目標方法的返回值和預期的值進行比較，如果和預期值一致則測試通過，否則測試失敗。
我們在API項目中添加了一個Value控制器，我們以Get方法作為測試目標。一般一個單元測試方法就是一個測試用例。
我們在測試項目中添加一個ValueTest測試類，然后編寫一個單元測試方法，這里是采用模擬HTTPClient發送Http請求的方式進行測試：
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.TestHost;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
using UnitTestDemo;
using Xunit;
namespace TestDemo
{
public class ValueTests
{
public HttpClient _client { get; }
/// <summary>
/// 構造方法
/// </summary>
public ValueTests()
{
var server = new TestServer(WebHost.CreateDefaultBuilder()
.UseStartup<Startup>());
_client = server.CreateClient();
}
[Fact]
public async Task GetById_ShouldBe_Ok()
{
// 1、Arrange
var id = 1;
// 2、Act
// 調用異步的Get方法
var response = await _client.GetAsync($"/api/value/{id}");
// 3、Assert
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
}
}
}我們在構造函數中，通過TestServer拿到一個HttpClient對象，用它來模擬Http請求。我們寫了一個測試用例，完整演示了單元測試的Arrange、Act和Assert三個步驟。
單元測試用例寫好以后，打開“測試資源管理器”：
在底部就可以看到測試資源管理器了：
在要測試的方法上面右鍵，選擇“運行測試”就可以進行測試了：
注意觀察測試方法前面圖標的顏色，目前是藍色的，表示測試用例還沒有運行過：
測試用例結束以后，我們在測試資源管理器里面可以看到結果：
綠色表示測試通過。我們還可以看到執行測試用例消耗的時間。
如果測試結果和預期結果一致，那么測試用例前面圖標的顏色也會變成綠色：
如果測試結果和預期結果不一致就會顯示紅色，然后需要修改代碼直到出現綠色圖標。我們修改測試用例，模擬測試失敗的情況：
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.TestHost;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
using UnitTestDemo;
using Xunit;
namespace TestDemo
{
public class ValueTests
{
public HttpClient _client { get; }
/// <summary>
/// 構造方法
/// </summary>
public ValueTests()
{
var server = new TestServer(WebHost.CreateDefaultBuilder()
.UseStartup<Startup>());
_client = server.CreateClient();
}
[Fact]
public async Task GetById_ShouldBe_Ok()
{
// 1、Arrange
var id = 1;
// 2、Act
// 調用異步的Get方法
var response = await _client.GetAsync($"/api/value/{id}");
//// 3、Assert
//Assert.Equal(HttpStatusCode.OK, response.StatusCode);
// 3、Assert
// 模擬測試失敗
Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
}
}
}然后運行測試用例：
我們也可以通過添加斷點的方式在測試用例中進行調試。調試單元測試很簡單，只需要在要調試的方法上面右鍵選擇“調試測試”，如下圖所示：
其它操作就跟調試普通方法一樣。
除了添加斷點調試，我們還可以采用打印日志的方法來快速調試，xUnit可以很方便地做到這一點。我們修改ValueTest類：
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.TestHost;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
using UnitTestDemo;
using Xunit;
using Xunit.Abstractions;
namespace TestDemo
{
public class ValueTests
{
public HttpClient _client { get; }
public ITestOutputHelper Output { get; }
/// <summary>
/// 構造方法
/// </summary>
public ValueTests(ITestOutputHelper outputHelper)
{
var server = new TestServer(WebHost.CreateDefaultBuilder()
.UseStartup<Startup>());
_client = server.CreateClient();
Output = outputHelper;
}
[Fact]
public async Task GetById_ShouldBe_Ok()
{
// 1、Arrange
var id = 1;
// 2、Act
// 調用異步的Get方法
var response = await _client.GetAsync($"/api/value/{id}");
// 3、Assert
// 模擬測試失敗
//Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
// 輸出返回信息
// Output
var responseText = await response.Content.ReadAsStringAsync();
Output.WriteLine(responseText);
// 3、Assert
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
}
}
}這里我們在構造函數中添加了 ITestOutputHelper 參數，xUnit 會將一個實現此接口的實例注入進來。拿到這個實例后，我們就可以用它來輸出日志了。運行（注意不是 Debug）此方法，運行結束后在測試資源管理器里面查看：
點擊就可以看到輸出的日志了：
在上面的例子中，我們是使用的簡單的Value控制器進行測試，控制器里面沒有其他依賴關系，如果控制器里面有依賴關系該如何測試呢？方法還是一樣的，我們新建一個Student控制器，里面依賴IStudentRepository接口，代碼如下：
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using UnitTest.IRepository;
using UnitTest.Model;
namespace UnitTestDemo.Controllers
{
[Route("api/student")]
[ApiController]
public class StudentController : ControllerBase
{
private readonly IStudentRepository _repository;
/// <summary>
/// 通過構造函數注入
/// </summary>
/// <param name="repository"></param>
public StudentController(IStudentRepository repository)
{
_repository = repository;
}
/// <summary>
/// get方法
/// </summary>
/// <returns></returns>
[HttpGet]
public async Task<ActionResult<List<Student>>> Get()
{
return await _repository.GetList();
}
}
}然后在Startup類的ConfigureServices方法中注入：
public void ConfigureServices(IServiceCollection services)
{
// 添加數據庫連接字符串
services.AddDbContext<AppDbContext>(options =>
{
options.UseSqlServer(Configuration.GetSection("ConnectionString").GetSection("DbConnection").Value);
});
// 添加依賴注入到容器中
services.AddScoped<IStudentRepository, StudentRepository>();
services.AddControllers();
}在單元測試項目中添加StudentTest類：
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.TestHost;
using Newtonsoft.Json;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;
using UnitTest.Model;
using UnitTestDemo;
using Xunit;
using Xunit.Abstractions;
namespace TestDemo
{
public class StudentTest
{
public HttpClient Client { get; }
public ITestOutputHelper Output { get; }
public StudentTest(ITestOutputHelper outputHelper)
{
var server = new TestServer(WebHost.CreateDefaultBuilder()
.UseStartup<Startup>());
Client = server.CreateClient();
Output = outputHelper;
}
[Fact]
public async Task Get_ShouldBe_Ok()
{
// 2、Act
var response = await Client.GetAsync($"api/student");
// Output
string context = await response.Content.ReadAsStringAsync();
Output.WriteLine(context);
List<Student> list = JsonConvert.DeserializeObject<List<Student>>(context);
// Assert
Assert.Equal(3, list.Count);
}
}
}然后運行單元測試：
可以看到，控制器里面如果有依賴關系，也是可以使用這種方式進行測試的。
Post方法也可以使用同樣的方式進行測試，修改控制器，添加Post方法：
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using UnitTest.IRepository;
using UnitTest.Model;
namespace UnitTestDemo.Controllers
{
[Route("api/student")]
[ApiController]
public class StudentController : ControllerBase
{
private readonly IStudentRepository _repository;
/// <summary>
/// 通過構造函數注入
/// </summary>
/// <param name="repository"></param>
public StudentController(IStudentRepository repository)
{
_repository = repository;
}
/// <summary>
/// get方法
/// </summary>
/// <returns></returns>
[HttpGet]
public async Task<ActionResult<List<Student>>> Get()
{
return await _repository.GetList();
}
/// <summary>
/// Post方法
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
[HttpPost]
public async Task<bool> Post([FromBody]Student entity)
{
int? result = await _repository.Add(entity);
if(result==null)
{
return false;
}
else
{
return result > 0 ? true : false;
}
}
}
}在增加一個Post的測試方法：
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.TestHost;
using Newtonsoft.Json;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;
using UnitTest.Model;
using UnitTestDemo;
using Xunit;
using Xunit.Abstractions;
namespace TestDemo
{
public class StudentTest
{
public HttpClient Client { get; }
public ITestOutputHelper Output { get; }
public StudentTest(ITestOutputHelper outputHelper)
{
var server = new TestServer(WebHost.CreateDefaultBuilder()
.UseStartup<Startup>());
Client = server.CreateClient();
Output = outputHelper;
}
[Fact]
public async Task Get_ShouldBe_Ok()
{
// 2、Act
var response = await Client.GetAsync($"api/student");
// Output
string context = await response.Content.ReadAsStringAsync();
Output.WriteLine(context);
List<Student> list = JsonConvert.DeserializeObject<List<Student>>(context);
// Assert
Assert.Equal(3, list.Count);
}
[Fact]
public async Task Post_ShouldBe_Ok()
{
// 1、Arrange
Student entity = new Student()
{
Name="測試9",
Age=25,
Gender="男"
};
var str = JsonConvert.SerializeObject(entity);
HttpContent content = new StringContent(str);
// 2、Act
content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/json");
HttpResponseMessage response = await Client.PostAsync("api/student", content);
string responseBody = await response.Content.ReadAsStringAsync();
Output.WriteLine(responseBody);
// 3、Assert
Assert.Equal("true", responseBody);
}
}
}運行測試用例：
這樣一個簡單的單元測試就完成了。
我們觀察上面的兩個測試類，發現這兩個類都有一個共同的特點：都是在構造函數里面創建一個HttpClient對象，我們可以把創建HttpClient對象抽離到一個共同的基類里面，所有的類都繼承自基類。該基類代碼如下：
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.TestHost;
using System.IO;
using System.Net.Http;
using UnitTestDemo;
namespace TestDemo
{
/// <summary>
/// 基類
/// </summary>
public class ApiControllerTestBase
{
/// <summary>
/// 返回HttpClient對象
/// </summary>
/// <returns></returns>
protected HttpClient GetClient()
{
var builder = new WebHostBuilder()
// 指定使用當前目錄
.UseContentRoot(Directory.GetCurrentDirectory())
// 使用Startup類作為啟動類
.UseStartup<Startup>()
// 設置使用測試環境
.UseEnvironment("Testing");
var server = new TestServer(builder);
// 創建HttpClient
HttpClient client = server.CreateClient();
return client;
}
}
}然后修改StudentTest類，使該類繼承自上面創建的基類：
using Newtonsoft.Json;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;
using UnitTest.Model;
using Xunit;
using Xunit.Abstractions;
namespace TestDemo
{
public class StudentTest: ApiControllerTestBase
{
public HttpClient Client { get; }
public ITestOutputHelper Output { get; }
public StudentTest(ITestOutputHelper outputHelper)
{
// var server = new TestServer(WebHost.CreateDefaultBuilder()
//.UseStartup<Startup>());
// Client = server.CreateClient();
// 從父類里面獲取HttpClient對象
Client = base.GetClient();
Output = outputHelper;
}
[Fact]
public async Task Get_ShouldBe_Ok()
{
// 2、Act
var response = await Client.GetAsync($"api/student");
// Output
string context = await response.Content.ReadAsStringAsync();
Output.WriteLine(context);
List<Student> list = JsonConvert.DeserializeObject<List<Student>>(context);
// Assert
Assert.Equal(3, list.Count);
}
[Fact]
public async Task Post_ShouldBe_Ok()
{
// 1、Arrange
Student entity = new Student()
{
Name="測試9",
Age=25,
Gender="男"
};
var str = JsonConvert.SerializeObject(entity);
HttpContent content = new StringContent(str);
// 2、Act
content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/json");
HttpResponseMessage response = await Client.PostAsync("api/student", content);
string responseBody = await response.Content.ReadAsStringAsync();
Output.WriteLine(responseBody);
// 3、Assert
Assert.Equal("true", responseBody);
}
}
}以上是“ASP.NET Core項目如何使用xUnit進行單元測試”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
