似乎没有关于如何为实际 ASP.NET核心控制器操作编写良好单元测试的信息。关于如何使这项工作真实的指导?
答案 0 :(得分:9)
我现在有一个似乎运作良好的系统,所以我想我会分享它,看看它是否不能帮助其他人。有一个really useful article in the Entity Framework documentation指明了方向。但这是我如何将其纳入实际的工作应用程序。
有很多很棒的文章可以帮助你入门。基本设置和脚手架的documentation非常有用。为此,您需要创建一个包含个人用户帐户的Web应用程序,以便您的ApplicationDbContext设置为自动使用EntityFramework。
使用文档中包含的信息创建一个具有基本CRUD操作的简单控制器。
在您的解决方案中,创建一个新的.NET Core Library并引用您新创建的Web应用程序。在我的示例中,我使用的模型称为Company
,它使用CompaniesController
。
对于这个项目,我使用xUnit作为我的测试运行器,Moq用于模拟对象,FluentAssertions用于做出更有意义的断言。使用NuGet Package Manager和/或Console将这三个库添加到项目中。您可能需要选中Show Prerelease
复选框来搜索它们。
您还需要一些软件包才能使用EntityFramework的新Sqlite-InMemory数据库选项。 这是秘诀。以下是NuGet上的包名列表:
Per the article I mentioned earlier,有一种简单,漂亮的方法可以将Sqlite设置为内存中的关系数据库,您可以对其进行测试。
您希望编写单元测试方法,以便每个方法都有一个新的,干净的数据库副本。上面的文章向您展示了如何在一次性完成此操作基础。这是我如何设置我的夹具尽可能DRY。
我编写了以下方法,允许我使用Arrange / Act / Assert模型编写测试,每个阶段在我的测试中充当参数。下面是方法的代码以及它引用的TestFixture
中的相关类属性,最后是调用代码的示例。
public class TestFixture {
public SqliteConnection ConnectionFactory() => new SqliteConnection("DataSource=:memory:");
public DbContextOptions<ApplicationDbContext> DbOptionsFactory(SqliteConnection connection) =>
new DbContextOptionsBuilder<ApplicationDbContext>()
.UseSqlite(connection)
.Options;
public Company CompanyFactory() => new Company {Name = Guid.NewGuid().ToString()};
public void RunWithDatabase(
Action<ApplicationDbContext> arrange,
Func<ApplicationDbContext, IActionResult> act,
Action<IActionResult> assert)
{
var connection = ConnectionFactory();
connection.Open();
try
{
var options = DbOptionsFactory(connection);
using (var context = new ApplicationDbContext(options))
{
context.Database.EnsureCreated();
// Arrange
arrange?.Invoke(context);
}
using (var context = new ApplicationDbContext(options))
{
// Act (and pass result into assert)
var result = act.Invoke(context);
// Assert
assert.Invoke(result);
}
}
finally
{
connection.Close();
}
}
...
}
以下是调用代码来测试Create
上的CompaniesController
方法的样子(我使用参数名称来帮助我保持表达能力,但是你不会&#39 ;严格需要他们):
[Fact]
public void Get_ReturnsAViewResult()
{
_fixture.RunWithDatabase(
arrange: null,
act: context => new CompaniesController(context, _logger).Create(),
assert: result => result.Should().BeOfType<ViewResult>()
);
}
我的CompaniesController
类需要一个记录器,我用Moq模拟并在我的TestFixture中存储为变量。
当然,许多内置的ASP.NET Core操作都是异步的。为了使用这个结构,我已经写了下面的方法:
public class TestFixture {
...
public async Task RunWithDatabaseAsync(
Func<ApplicationDbContext, Task> arrange,
Func<ApplicationDbContext, Task<IActionResult>> act,
Action<IActionResult> assert)
{
var connection = ConnectionFactory();
await connection.OpenAsync();
try
{
var options = DbOptionsFactory(connection);
using (var context = new ApplicationDbContext(options))
{
await context.Database.EnsureCreatedAsync();
if (arrange != null) await arrange.Invoke(context);
}
using (var context = new ApplicationDbContext(options))
{
var result = await act.Invoke(context);
assert.Invoke(result);
}
}
finally
{
connection.Close();
}
}
}
它几乎完全相同,只是使用异步方法和等待者进行设置。下面是调用这些方法的示例:
[Fact]
public async Task Post_WhenViewModelDoesNotMatchId_ReturnsNotFound()
{
await _fixture.RunWithDatabaseAsync(
arrange: async context =>
{
context.Company.Add(CompanyFactory());
await context.SaveChangesAsync();
},
act: async context => await new CompaniesController(context, _logger).Edit(1, CompanyFactory()),
assert: result => result.Should().BeOfType<NotFoundResult>()
);
}
当然,有时您必须在测试阶段之间来回传递数据。这是我编写的一种方法,允许您这样做:
public class TestFixture {
...
public async Task RunWithDatabaseAsync(
Func<ApplicationDbContext, Task<dynamic>> arrange,
Func<ApplicationDbContext, dynamic, Task<IActionResult>> act,
Action<IActionResult, dynamic> assert)
{
var connection = ConnectionFactory();
await connection.OpenAsync();
try
{
object data;
var options = DbOptionsFactory(connection);
using (var context = new ApplicationDbContext(options))
{
await context.Database.EnsureCreatedAsync();
data = arrange != null
? await arrange?.Invoke(context)
: null;
}
using (var context = new ApplicationDbContext(options))
{
var result = await act.Invoke(context, data);
assert.Invoke(result, data);
}
}
finally
{
connection.Close();
}
}
}
当然,这是我如何使用此代码的示例:
[Fact]
public async Task Post_WithInvalidModel_ReturnsModelErrors()
{
await _fixture.RunWithDatabaseAsync(
arrange: async context =>
{
var data = new
{
Key = "Name",
Message = "Name cannot be null",
Company = CompanyFactory()
};
context.Company.Add(data.Company);
await context.SaveChangesAsync();
return data;
},
act: async (context, data) =>
{
var ctrl = new CompaniesController(context, _logger);
ctrl.ModelState.AddModelError(data.Key, data.Message);
return await ctrl.Edit(1, data.Company);
},
assert: (result, data) => result.As<ViewResult>()
.ViewData.ModelState.Keys.Should().Contain((string) data.Key)
);
}
我真的希望这可以帮助一些人在C#和ASP.NET Core中出色的新东西站起来。如果您有任何问题,批评或建议,请告诉我!我也是新手,所以任何建设性的反馈对我来说都是非常宝贵的!