Razor ASP.NET Core 中的頁面單元測試

ASP.NET Core 支援 Pages 應用程式的單元測試 Razor 。 在 DAL) 和頁面模型 (資料存取層的測試,有助於確保:

  • RazorPages 應用程式的元件會在應用程式建構期間獨立運作,並以單位的形式一起運作。
  • 類別和方法的責任範圍有限。
  • 應用程式應該如何運作的其他檔。
  • 在自動化建置和部署期間,會發現由程式碼更新所造成錯誤的回歸。

本主題假設您對 Pages 應用程式和單元測試有基本的瞭解 Razor 。 如果您不熟悉 Razor Pages 應用程式或測試概念,請參閱下列主題:

檢視或下載範例程式碼 (如何下載)

範例專案是由兩個應用程式所組成:

應用程式 專案資料夾 描述
訊息應用程式 src/ Razor PagesTestSample 允許使用者新增訊息、刪除一則訊息、刪除所有訊息,以及分析訊息, (尋找每個訊息的平均單字數) 。
測試應用程式 tests/ Razor PagesTestSample.Tests 用來對訊息應用程式的 DAL 和索引頁面模型進行單元測試。

您可以使用 IDE 的內建測試功能來執行測試,例如 Visual StudioVisual Studio for Mac。 如果使用 Visual Studio Code 或命令列,請在 tests/ Razor PagesTestSample.Tests 資料夾中的命令提示字元執行下列命令:

dotnet test

訊息應用程式組織

訊息應用程式是 Razor 具有下列特性的 Pages 訊息系統:

  • 應用程式 (Pages/Index.cshtmlPages/Index.cshtml.cs) 的 [索引] 頁面提供 UI 和頁面模型方法來控制訊息的新增、刪除和分析, (尋找每個訊息的平均單字數) 。
  • 類別會使用 Message 兩個屬性 () Data/Message.cs 描述訊息: Id (索引鍵) 和 Text (訊息) 。 屬性 Text 是必要的,且限制為 200 個字元。
  • 訊息會使用 Entity Framework 的記憶體內部資料庫來儲存†。
  • 應用程式在其資料庫內容類別別中包含 DAL, AppDbContext (Data/AppDbContext.cs) 。 DAL 方法會標示 virtual 為 ,允許模擬用於測試的方法。
  • 如果資料庫在應用程式啟動時是空的,訊息存放區會以三則訊息初始化。 這些 植入的訊息 也會用於測試中。

使用 InMemory 測試EF 主題說明如何使用記憶體內部資料庫搭配 MSTest 進行測試。 本主題使用 xUnit 測試架構。 不同測試架構的測試概念和測試實作很類似,但不同。

雖然範例應用程式不會使用存放庫模式,而且不是 工作單位 (UoW) 模式的有效範例, Razor 但 Pages 支援這些開發模式。 如需詳細資訊,請參閱在 ASP.NET Core 中 設計基礎結構持續性層測試控制器邏輯, (範例會實作存放庫模式) 。

測試應用程式組織

測試應用程式是 tests/ Razor PagesTestSample.Tests 資料夾內的主控台應用程式。

測試應用程式資料夾 描述
UnitTests
  • DataAccessLayerTest.cs 包含 DAL 的單元測試。
  • IndexPageTests.cs 包含索引頁面模型的單元測試。
公用程式 包含 TestDbContextOptions 用來為每個 DAL 單元測試建立新資料庫內容選項的方法,讓資料庫重設為每個測試的基準條件。

測試架構為 xUnit。 物件模擬架構為 Moq

DAL (DAL) 的資料存取層單元測試

訊息應用程式具有 DAL,其中包含類別 () 的 AppDbContextsrc/RazorPagesTestSample/Data/AppDbContext.cs 四個方法。 每個方法在測試應用程式中都有一或兩個單元測試。

DAL 方法 函式
GetMessagesAsync List<Message>從 依 Text 屬性排序的資料庫取得 。
AddMessageAsync Message將 加入至資料庫。
DeleteAllMessagesAsync 從資料庫刪除所有 Message 專案。
DeleteMessageAsync 藉由 Id 從資料庫刪除單 Message 一 。

建立每個測試的新 AppDbContext 時,DAL 的單元測試需要 DbContextOptions 。 為每個測試建立 DbContextOptions 的其中一種方法是使用 DbContextOptionsBuilder

var optionsBuilder = new DbContextOptionsBuilder<AppDbContext>()
    .UseInMemoryDatabase("InMemoryDb");

using (var db = new AppDbContext(optionsBuilder.Options))
{
    // Use the db here in the unit test.
}

此方法的問題在於,每個測試都會以先前測試留下的任何狀態接收資料庫。 嘗試撰寫不會互相干擾的不可部分完成單元測試時,這可能會造成問題。 若要強制 AppDbContext 針對每個測試使用新的資料庫內容,請提供 DbContextOptions 以新服務提供者為基礎的實例。 測試應用程式示範如何使用其 Utilities 類別方法 TestDbContextOptions (tests/RazorPagesTestSample.Tests/Utilities/Utilities.cs) :

public static DbContextOptions<AppDbContext> TestDbContextOptions()
{
    // Create a new service provider to create a new in-memory database.
    var serviceProvider = new ServiceCollection()
        .AddEntityFrameworkInMemoryDatabase()
        .BuildServiceProvider();

    // Create a new options instance using an in-memory database and 
    // IServiceProvider that the context should resolve all of its 
    // services from.
    var builder = new DbContextOptionsBuilder<AppDbContext>()
        .UseInMemoryDatabase("InMemoryDb")
        .UseInternalServiceProvider(serviceProvider);

    return builder.Options;
}

DbContextOptions在 DAL 單元測試中使用 ,可讓每個測試以全新資料庫實例以不可部分完成的方式執行:

using (var db = new AppDbContext(Utilities.TestDbContextOptions()))
{
    // Use the db here in the unit test.
}

類別中的每個 DataAccessLayerTest 測試方法 (UnitTests/DataAccessLayerTest.cs) 遵循類似的 Arrange-Act-Assert 模式:

  1. 排列:已針對測試設定資料庫,並定義/或預期的結果。
  2. 動作:執行測試。
  3. 判斷提示:判斷判斷測試結果是否成功。

例如, DeleteMessageAsync 方法負責移除其 Id (src/RazorPagesTestSample/Data/AppDbContext.cs) 所識別的單一訊息:

public async virtual Task DeleteMessageAsync(int id)
{
    var message = await Messages.FindAsync(id);

    if (message != null)
    {
        Messages.Remove(message);
        await SaveChangesAsync();
    }
}

此方法有兩個測試。 一項測試會檢查方法在資料庫中有訊息時,是否刪除訊息。 如果刪除的訊息 Id 不存在,其他方法會測試資料庫不會變更。 方法 DeleteMessageAsync_MessageIsDeleted_WhenMessageIsFound 如下所示:

[Fact]
public async Task DeleteMessageAsync_MessageIsDeleted_WhenMessageIsFound()
{
    using (var db = new AppDbContext(Utilities.TestDbContextOptions()))
    {
        // Arrange
        var seedMessages = AppDbContext.GetSeedingMessages();
        await db.AddRangeAsync(seedMessages);
        await db.SaveChangesAsync();
        var recId = 1;
        var expectedMessages = 
            seedMessages.Where(message => message.Id != recId).ToList();

        // Act
        await db.DeleteMessageAsync(recId);

        // Assert
        var actualMessages = await db.Messages.AsNoTracking().ToListAsync();
        Assert.Equal(
            expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
            actualMessages.OrderBy(m => m.Id).Select(m => m.Text));
    }
}

首先,方法會執行 Arrange 步驟,其中會進行 Act 步驟的準備。 植入訊息會取得並保留在 中 seedMessages 。 植入訊息會儲存到資料庫中。 具有 Id1 訊息已設定為要刪除。 DeleteMessageAsync執行 方法時,預期的訊息應該包含所有訊息,但 具有 Id1 訊息除外。 變數 expectedMessages 代表此預期的結果。

// Arrange
var seedMessages = AppDbContext.GetSeedingMessages();
await db.AddRangeAsync(seedMessages);
await db.SaveChangesAsync();
var recId = 1;
var expectedMessages = 
    seedMessages.Where(message => message.Id != recId).ToList();

方法作用:方法 DeleteMessageAsync 會在 的 中 recId1 執行方法:

// Act
await db.DeleteMessageAsync(recId);

最後,方法會 Messages 從內容取得 ,並將它 expectedMessages 與判斷提示相等:

// Assert
var actualMessages = await db.Messages.AsNoTracking().ToListAsync();
Assert.Equal(
    expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
    actualMessages.OrderBy(m => m.Id).Select(m => m.Text));

為了比較這兩者 List<Message> 相同:

  • 訊息會依 Id 排序。
  • 訊息組會在 屬性上 Text 進行比較。

類似的測試方法會 DeleteMessageAsync_NoMessageIsDeleted_WhenMessageIsNotFound 檢查嘗試刪除不存在之訊息的結果。 在此情況下,資料庫中的預期訊息應該等於執行 方法之後 DeleteMessageAsync 的實際訊息。 資料庫的內容應該不會有任何變更:

[Fact]
public async Task DeleteMessageAsync_NoMessageIsDeleted_WhenMessageIsNotFound()
{
    using (var db = new AppDbContext(Utilities.TestDbContextOptions()))
    {
        // Arrange
        var expectedMessages = AppDbContext.GetSeedingMessages();
        await db.AddRangeAsync(expectedMessages);
        await db.SaveChangesAsync();
        var recId = 4;

        // Act
        try
        {
            await db.DeleteMessageAsync(recId);
        }
        catch
        {
            // recId doesn't exist
        }

        // Assert
        var actualMessages = await db.Messages.AsNoTracking().ToListAsync();
        Assert.Equal(
            expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
            actualMessages.OrderBy(m => m.Id).Select(m => m.Text));
    }
}

頁面模型方法的單元測試

另一組單元測試負責頁面模型方法的測試。 在訊息應用程式中,索引頁面模型位於 中的 類別中 IndexModelsrc/RazorPagesTestSample/Pages/Index.cshtml.cs

頁面模型方法 函式
OnGetAsync 使用 方法從 DAL 取得 UI 的 GetMessagesAsync 訊息。
OnPostAddMessageAsync 如果 ModelState 有效,則呼叫 AddMessageAsync 以將訊息新增至資料庫。
OnPostDeleteAllMessagesAsync 呼叫 DeleteAllMessagesAsync 以刪除資料庫中的所有訊息。
OnPostDeleteMessageAsync DeleteMessageAsync執行 以刪除具有指定之 的 Id 訊息。
OnPostAnalyzeMessagesAsync 如果資料庫中有一或多個訊息,則計算每個訊息的平均單字數。

頁面模型方法會使用類別中的 IndexPageTests 七個測試來測試 (tests/RazorPagesTestSample.Tests/UnitTests/IndexPageTests.cs) 。 測試會使用熟悉的 Arrange-Assert-Act 模式。 這些測試著重于:

  • 判斷當 ModelState 無效時,方法是否遵循正確的行為。
  • 確認方法會產生正確的 IActionResult
  • 檢查屬性值指派是否正確。

這個測試群組通常會模擬 DAL 的方法,以針對執行頁面模型方法的 Act 步驟產生預期的資料。 例如, GetMessagesAsyncAppDbContext 方法會模擬以產生輸出。 當頁面模型方法執行這個方法時,模擬會傳回結果。 資料不是來自資料庫。 這會在頁面模型測試中使用 DAL 來建立可預測的可靠測試條件。

OnGetAsync_PopulatesThePageModel_WithAListOfMessages 測試顯示如何 GetMessagesAsync 模擬頁面模型的 方法:

var mockAppDbContext = new Mock<AppDbContext>(optionsBuilder.Options);
var expectedMessages = AppDbContext.GetSeedingMessages();
mockAppDbContext.Setup(
    db => db.GetMessagesAsync()).Returns(Task.FromResult(expectedMessages));
var pageModel = new IndexModel(mockAppDbContext.Object);

OnGetAsync在 Act 步驟中執行 方法時,它會呼叫頁面模型的 GetMessagesAsync 方法。

單元測試動作步驟 (tests/RazorPagesTestSample.Tests/UnitTests/IndexPageTests.cs) :

// Act
await pageModel.OnGetAsync();

IndexPage 頁面模型 OnGetAsync 的方法 (src/RazorPagesTestSample/Pages/Index.cshtml.cs) :

public async Task OnGetAsync()
{
    Messages = await _db.GetMessagesAsync();
}

GetMessagesAsyncDAL 中的 方法不會傳回這個方法呼叫的結果。 方法的模擬版本會傳回結果。

在步驟中 Assert ,會從 Messages 頁面模型的 屬性指派實際訊息 (actualMessages) 。 指派訊息時也會執行類型檢查。 預期和實際訊息會與其屬性進行比較 Text 。 測試判斷提示兩 List<Message> 個實例包含相同的訊息。

// Assert
var actualMessages = Assert.IsAssignableFrom<List<Message>>(pageModel.Messages);
Assert.Equal(
    expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
    actualMessages.OrderBy(m => m.Id).Select(m => m.Text));

此群組中的其他測試會建立包含 、 ModelStateDictionaryActionContext 要建立 PageContext 、、 ViewDataDictionaryPageContext 的頁面模型物件 DefaultHttpContext 。 這些在進行測試時很有用。 例如,訊息應用程式會 ModelState 建立錯誤, AddModelError 以檢查執行時 OnPostAddMessageAsync 是否傳回有效的 PageResult

[Fact]
public async Task OnPostAddMessageAsync_ReturnsAPageResult_WhenModelStateIsInvalid()
{
    // Arrange
    var optionsBuilder = new DbContextOptionsBuilder<AppDbContext>()
        .UseInMemoryDatabase("InMemoryDb");
    var mockAppDbContext = new Mock<AppDbContext>(optionsBuilder.Options);
    var expectedMessages = AppDbContext.GetSeedingMessages();
    mockAppDbContext.Setup(db => db.GetMessagesAsync()).Returns(Task.FromResult(expectedMessages));
    var httpContext = new DefaultHttpContext();
    var modelState = new ModelStateDictionary();
    var actionContext = new ActionContext(httpContext, new RouteData(), new PageActionDescriptor(), modelState);
    var modelMetadataProvider = new EmptyModelMetadataProvider();
    var viewData = new ViewDataDictionary(modelMetadataProvider, modelState);
    var tempData = new TempDataDictionary(httpContext, Mock.Of<ITempDataProvider>());
    var pageContext = new PageContext(actionContext)
    {
        ViewData = viewData
    };
    var pageModel = new IndexModel(mockAppDbContext.Object)
    {
        PageContext = pageContext,
        TempData = tempData,
        Url = new UrlHelper(actionContext)
    };
    pageModel.ModelState.AddModelError("Message.Text", "The Text field is required.");

    // Act
    var result = await pageModel.OnPostAddMessageAsync();

    // Assert
    Assert.IsType<PageResult>(result);
}

其他資源

ASP.NET Core 支援 Pages 應用程式的單元測試 Razor 。 資料存取層的測試 (DAL) 和頁面模型有助於確保:

  • RazorPages 應用程式的元件會在應用程式建構期間獨立運作,並一起運作。
  • 類別和方法的責任範圍有限。
  • 應用程式應該如何運作的其他檔存在。
  • 在自動化建置和部署期間,發現由程式碼更新所造成錯誤的回歸。

本主題假設您對 Pages 應用程式和單元測試有基本瞭解 Razor 。 如果您不熟悉 Razor Pages 應用程式或測試概念,請參閱下列主題:

檢視或下載範例程式碼 (如何下載)

範例專案是由兩個應用程式所組成:

應用程式 專案資料夾 描述
訊息應用程式 src/ Razor PagesTestSample 允許使用者新增訊息、刪除一則訊息、刪除所有訊息,以及分析訊息, (尋找每個訊息的平均單字數) 。
測試應用程式 tests/ Razor PagesTestSample.Tests 用來單元測試訊息應用程式的 DAL 和索引頁面模型。

您可以使用 IDE 的內建測試功能來執行測試,例如 Visual StudioVisual Studio for Mac。 如果使用 Visual Studio Code 或命令列,請在 tests/ Razor PagesTestSample.Tests 資料夾中的命令提示字元執行下列命令:

dotnet test

訊息應用程式組織

訊息應用程式是 Razor 具有下列特性的 Pages 訊息系統:

  • 應用程式 (Pages/Index.cshtmlPages/Index.cshtml.cs) 的 [索引] 頁面提供 UI 和頁面模型方法來控制訊息的新增、刪除和分析, (尋找每個訊息的平均單字數) 。
  • 類別會以 Message 兩個屬性描述訊息 () Data/Message.csId (索引鍵) 和 Text (訊息) 。 屬性 Text 是必要的,且限制為 200 個字元。
  • 訊息會使用 Entity Framework 的記憶體內部資料庫來儲存†。
  • 應用程式在其資料庫內容類別別中包含 DAL, AppDbContext (Data/AppDbContext.cs) 。 DAL 方法會標示 virtual 為 ,允許模擬測試中使用的方法。
  • 如果資料庫在應用程式啟動時是空的,則會使用三則訊息初始化訊息存放區。 這些 植入的訊息 也會用於測試中。

† EF 主題 InMemory 測試說明如何使用記憶體內部資料庫搭配 MSTest 進行測試。 本主題使用 xUnit 測試架構。 不同測試架構的測試概念和測試實作很類似,但不相同。

雖然範例應用程式不使用存放庫模式,而且不是 工作單位 (UoW) 模式的有效範例, Razor 但 Pages 支援這些開發模式。 如需詳細資訊,請參閱在 ASP.NET Core 中 設計基礎結構持續性層測試控制器邏輯 , (範例會實作存放庫模式) 。

測試應用程式組織

測試應用程式是 測試/ Razor PagesTestSample.Tests 資料夾內的主控台應用程式。

測試應用程式資料夾 描述
UnitTests
  • DataAccessLayerTest.cs 包含 DAL 的單元測試。
  • IndexPageTests.cs 包含索引頁面模型的單元測試。
公用程式 包含 TestDbContextOptions 用來為每個 DAL 單元測試建立新資料庫內容選項的方法,讓資料庫重設為每個測試的基準條件。

測試架構為 xUnit。 物件模擬架構為 Moq

資料存取層的單元測試 (DAL)

訊息應用程式有一個 DAL,其類別包含 AppDbContext 四個方法 (src/RazorPagesTestSample/Data/AppDbContext.cs) 。 每個方法在測試應用程式中都有一或兩個單元測試。

DAL 方法 函式
GetMessagesAsync List<Message>從依 Text 屬性排序的資料庫取得 。
AddMessageAsync Message將 加入至資料庫。
DeleteAllMessagesAsync 從資料庫刪除所有 Message 專案。
DeleteMessageAsync 藉由 Id 從資料庫刪除單 Message 一 。

建立每個測試的新 AppDbContext 時,DAL 的單元測試需要 DbContextOptions 。 建立每個測試的其中一種方法 DbContextOptions 是使用 DbContextOptionsBuilder

var optionsBuilder = new DbContextOptionsBuilder<AppDbContext>()
    .UseInMemoryDatabase("InMemoryDb");

using (var db = new AppDbContext(optionsBuilder.Options))
{
    // Use the db here in the unit test.
}

這種方法的問題在於,每個測試都會以先前測試留下的任何狀態接收資料庫。 嘗試撰寫不會互相干擾的不可部分完成單元測試時,這可能會造成問題。 若要強制 AppDbContext 針對每個測試使用新的資料庫內容,請提供 DbContextOptions 以新服務提供者為基礎的實例。 測試應用程式示範如何使用其 Utilities 類別方法 TestDbContextOptions (tests/RazorPagesTestSample.Tests/Utilities/Utilities.cs) :

public static DbContextOptions<AppDbContext> TestDbContextOptions()
{
    // Create a new service provider to create a new in-memory database.
    var serviceProvider = new ServiceCollection()
        .AddEntityFrameworkInMemoryDatabase()
        .BuildServiceProvider();

    // Create a new options instance using an in-memory database and 
    // IServiceProvider that the context should resolve all of its 
    // services from.
    var builder = new DbContextOptionsBuilder<AppDbContext>()
        .UseInMemoryDatabase("InMemoryDb")
        .UseInternalServiceProvider(serviceProvider);

    return builder.Options;
}

DbContextOptions在 DAL 單元測試中使用 ,可讓每個測試以全新資料庫實例以不可部分完成的方式執行:

using (var db = new AppDbContext(Utilities.TestDbContextOptions()))
{
    // Use the db here in the unit test.
}

類別中的每個 DataAccessLayerTest 測試方法 (UnitTests/DataAccessLayerTest.cs) 遵循類似的 Arrange-Act-Assert 模式:

  1. 排列:已針對測試設定資料庫,並定義/或預期的結果。
  2. 動作:執行測試。
  3. 判斷提示:判斷判斷測試結果是否成功。

例如, DeleteMessageAsync 方法負責移除其 Id (src/RazorPagesTestSample/Data/AppDbContext.cs) 所識別的單一訊息:

public async virtual Task DeleteMessageAsync(int id)
{
    var message = await Messages.FindAsync(id);

    if (message != null)
    {
        Messages.Remove(message);
        await SaveChangesAsync();
    }
}

此方法有兩個測試。 一項測試會檢查方法在資料庫中有訊息時,是否刪除訊息。 如果刪除的訊息 Id 不存在,其他方法會測試資料庫不會變更。 方法 DeleteMessageAsync_MessageIsDeleted_WhenMessageIsFound 如下所示:

[Fact]
public async Task DeleteMessageAsync_MessageIsDeleted_WhenMessageIsFound()
{
    using (var db = new AppDbContext(Utilities.TestDbContextOptions()))
    {
        // Arrange
        var seedMessages = AppDbContext.GetSeedingMessages();
        await db.AddRangeAsync(seedMessages);
        await db.SaveChangesAsync();
        var recId = 1;
        var expectedMessages = 
            seedMessages.Where(message => message.Id != recId).ToList();

        // Act
        await db.DeleteMessageAsync(recId);

        // Assert
        var actualMessages = await db.Messages.AsNoTracking().ToListAsync();
        Assert.Equal(
            expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
            actualMessages.OrderBy(m => m.Id).Select(m => m.Text));
    }
}

首先,方法會執行 Arrange 步驟,其中會進行 Act 步驟的準備。 植入訊息會取得並保留在 中 seedMessages 。 植入訊息會儲存到資料庫中。 具有 Id1 訊息已設定為要刪除。 DeleteMessageAsync執行 方法時,預期的訊息應該包含所有訊息,但 具有 Id1 訊息除外。 變數 expectedMessages 代表此預期的結果。

// Arrange
var seedMessages = AppDbContext.GetSeedingMessages();
await db.AddRangeAsync(seedMessages);
await db.SaveChangesAsync();
var recId = 1;
var expectedMessages = 
    seedMessages.Where(message => message.Id != recId).ToList();

方法作用:方法 DeleteMessageAsync 會在 的 中 recId1 執行方法:

// Act
await db.DeleteMessageAsync(recId);

最後,方法會 Messages 從內容取得 ,並將它 expectedMessages 與判斷提示相等:

// Assert
var actualMessages = await db.Messages.AsNoTracking().ToListAsync();
Assert.Equal(
    expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
    actualMessages.OrderBy(m => m.Id).Select(m => m.Text));

為了比較這兩者 List<Message> 相同:

  • 訊息會依 Id 排序。
  • 訊息組會在 屬性上 Text 進行比較。

類似的測試方法會 DeleteMessageAsync_NoMessageIsDeleted_WhenMessageIsNotFound 檢查嘗試刪除不存在之訊息的結果。 在此情況下,資料庫中的預期訊息應該等於執行 方法之後 DeleteMessageAsync 的實際訊息。 資料庫的內容應該不會有任何變更:

[Fact]
public async Task DeleteMessageAsync_NoMessageIsDeleted_WhenMessageIsNotFound()
{
    using (var db = new AppDbContext(Utilities.TestDbContextOptions()))
    {
        // Arrange
        var expectedMessages = AppDbContext.GetSeedingMessages();
        await db.AddRangeAsync(expectedMessages);
        await db.SaveChangesAsync();
        var recId = 4;

        // Act
        await db.DeleteMessageAsync(recId);

        // Assert
        var actualMessages = await db.Messages.AsNoTracking().ToListAsync();
        Assert.Equal(
            expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
            actualMessages.OrderBy(m => m.Id).Select(m => m.Text));
    }
}

頁面模型方法的單元測試

另一組單元測試負責頁面模型方法的測試。 在訊息應用程式中,索引頁面模型位於 中的 類別中 IndexModelsrc/RazorPagesTestSample/Pages/Index.cshtml.cs

頁面模型方法 函式
OnGetAsync 使用 方法從 DAL 取得 UI 的 GetMessagesAsync 訊息。
OnPostAddMessageAsync 如果 ModelState 有效,則呼叫 AddMessageAsync 以將訊息新增至資料庫。
OnPostDeleteAllMessagesAsync 呼叫 DeleteAllMessagesAsync 以刪除資料庫中的所有訊息。
OnPostDeleteMessageAsync DeleteMessageAsync執行 以刪除具有指定之 的 Id 訊息。
OnPostAnalyzeMessagesAsync 如果資料庫中有一或多個訊息,則計算每則訊息的平均字數。

頁面模型方法會使用 類別中的 IndexPageTests 七個測試來測試 (tests/RazorPagesTestSample.Tests/UnitTests/IndexPageTests.cs) 。 測試會使用熟悉的 Arrange-Assert-Act 模式。 這些測試著重于:

  • 判斷當 ModelState 無效時,方法是否遵循正確的行為。
  • 確認方法會產生正確的 IActionResult
  • 檢查屬性值指派是否正確。

這個測試群組通常會模擬 DAL 的方法,以產生執行頁面模型方法之 Act 步驟的預期資料。 例如, GetMessagesAsyncAppDbContext 方法會模擬以產生輸出。 當頁面模型方法執行這個方法時,模擬會傳回結果。 資料不是來自資料庫。 這會在頁面模型測試中使用 DAL 建立可預測的可靠測試條件。

OnGetAsync_PopulatesThePageModel_WithAListOfMessages 測試顯示如何 GetMessagesAsync 模擬頁面模型的 方法:

var mockAppDbContext = new Mock<AppDbContext>(optionsBuilder.Options);
var expectedMessages = AppDbContext.GetSeedingMessages();
mockAppDbContext.Setup(
    db => db.GetMessagesAsync()).Returns(Task.FromResult(expectedMessages));
var pageModel = new IndexModel(mockAppDbContext.Object);

OnGetAsync在 Act 步驟中執行 方法時,它會呼叫頁面模型的 GetMessagesAsync 方法。

單元測試 Act 步驟 (tests/RazorPagesTestSample.Tests/UnitTests/IndexPageTests.cs) :

// Act
await pageModel.OnGetAsync();

IndexPage 頁面模型 OnGetAsync 的方法 (src/RazorPagesTestSample/Pages/Index.cshtml.cs) :

public async Task OnGetAsync()
{
    Messages = await _db.GetMessagesAsync();
}

GetMessagesAsyncDAL 中的 方法不會傳回這個方法呼叫的結果。 方法的模擬版本會傳回結果。

在步驟中 Assert ,會從 Messages 頁面模型的 屬性指派 actualMessages 實際訊息 () 。 指派訊息時也會執行類型檢查。 預期的和實際訊息會以其 Text 屬性進行比較。 測試會判斷提示兩 List<Message> 個實例包含相同的訊息。

// Assert
var actualMessages = Assert.IsAssignableFrom<List<Message>>(pageModel.Messages);
Assert.Equal(
    expectedMessages.OrderBy(m => m.Id).Select(m => m.Text), 
    actualMessages.OrderBy(m => m.Id).Select(m => m.Text));

此群組中的其他測試會建立頁面模型物件,其中包含 DefaultHttpContextModelStateDictionaryActionContext 用來建立 PageContext 、、 ViewDataDictionaryPageContext 。 這些在進行測試時很有用。 例如,訊息應用程式會 ModelState 建立錯誤, AddModelError 以檢查執行時 OnPostAddMessageAsync 是否傳回有效 PageResult

[Fact]
public async Task OnPostAddMessageAsync_ReturnsAPageResult_WhenModelStateIsInvalid()
{
    // Arrange
    var optionsBuilder = new DbContextOptionsBuilder<AppDbContext>()
        .UseInMemoryDatabase("InMemoryDb");
    var mockAppDbContext = new Mock<AppDbContext>(optionsBuilder.Options);
    var expectedMessages = AppDbContext.GetSeedingMessages();
    mockAppDbContext.Setup(db => db.GetMessagesAsync()).Returns(Task.FromResult(expectedMessages));
    var httpContext = new DefaultHttpContext();
    var modelState = new ModelStateDictionary();
    var actionContext = new ActionContext(httpContext, new RouteData(), new PageActionDescriptor(), modelState);
    var modelMetadataProvider = new EmptyModelMetadataProvider();
    var viewData = new ViewDataDictionary(modelMetadataProvider, modelState);
    var tempData = new TempDataDictionary(httpContext, Mock.Of<ITempDataProvider>());
    var pageContext = new PageContext(actionContext)
    {
        ViewData = viewData
    };
    var pageModel = new IndexModel(mockAppDbContext.Object)
    {
        PageContext = pageContext,
        TempData = tempData,
        Url = new UrlHelper(actionContext)
    };
    pageModel.ModelState.AddModelError("Message.Text", "The Text field is required.");

    // Act
    var result = await pageModel.OnPostAddMessageAsync();

    // Assert
    Assert.IsType<PageResult>(result);
}

其他資源