File: DatabaseErrorPageTest.cs
Web Access
Project: src\src\Middleware\Diagnostics.EntityFrameworkCore\test\UnitTests\Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.Tests.csproj (Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.Tests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Text;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.Tests.Helpers;
using Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.Views;
using Microsoft.AspNetCore.Http;
using Microsoft.EntityFrameworkCore;
using Moq;
 
#nullable enable
namespace Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.Tests;
 
public class DatabaseErrorPageTest
{
    [Fact]
    public async Task No_database_or_migrations_only_displays_scaffold_first_migration()
    {
        var options = new DatabaseErrorPageOptions();
 
        var model = new DatabaseErrorPageModel(
            new Exception(),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: false,
                        pendingModelChanges: false,
                        pendingMigrations: new string[] { })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        AssertHelpers.DisplaysScaffoldFirstMigration(typeof(BloggingContext), content);
        AssertHelpers.NotDisplaysApplyMigrations(typeof(BloggingContext), content);
        AssertHelpers.NotDisplaysScaffoldNextMigraion(typeof(BloggingContext), content);
    }
 
    [Fact]
    public async Task No_database_with_migrations_only_displays_apply_migrations()
    {
        var options = new DatabaseErrorPageOptions();
 
        var model = new DatabaseErrorPageModel(
            new Exception(),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: false,
                        pendingModelChanges: false,
                        pendingMigrations: new string[] { "111_MigrationOne" })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        AssertHelpers.NotDisplaysScaffoldFirstMigration(typeof(BloggingContext), content);
        AssertHelpers.DisplaysApplyMigrations(typeof(BloggingContext), content);
        AssertHelpers.NotDisplaysScaffoldNextMigraion(typeof(BloggingContext), content);
    }
 
    [Fact]
    public async Task Existing_database_with_migrations_only_displays_apply_migrations()
    {
        var options = new DatabaseErrorPageOptions();
 
        var model = new DatabaseErrorPageModel(
            new Exception(),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: true,
                        pendingModelChanges: false,
                        pendingMigrations: new string[] { "111_MigrationOne" })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        AssertHelpers.NotDisplaysScaffoldFirstMigration(typeof(BloggingContext), content);
        AssertHelpers.DisplaysApplyMigrations(typeof(BloggingContext), content);
        AssertHelpers.NotDisplaysScaffoldNextMigraion(typeof(BloggingContext), content);
    }
 
    [Fact]
    public async Task Existing_database_with_migrations_and_pending_model_changes_only_displays_apply_migrations()
    {
        var options = new DatabaseErrorPageOptions();
 
        var model = new DatabaseErrorPageModel(
            new Exception(),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: true,
                        pendingModelChanges: true,
                        pendingMigrations: new string[] { "111_MigrationOne" })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        AssertHelpers.NotDisplaysScaffoldFirstMigration(typeof(BloggingContext), content);
        AssertHelpers.DisplaysApplyMigrations(typeof(BloggingContext), content);
        AssertHelpers.NotDisplaysScaffoldNextMigraion(typeof(BloggingContext), content);
    }
 
    [Fact]
    public async Task Pending_model_changes_only_displays_scaffold_next_migration()
    {
        var options = new DatabaseErrorPageOptions();
 
        var model = new DatabaseErrorPageModel(
            new Exception(),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: true,
                        pendingModelChanges: true,
                        pendingMigrations: new string[] { })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        AssertHelpers.NotDisplaysScaffoldFirstMigration(typeof(BloggingContext), content);
        AssertHelpers.NotDisplaysApplyMigrations(typeof(BloggingContext), content);
        AssertHelpers.DisplaysScaffoldNextMigraion(typeof(BloggingContext), content);
    }
 
    [Fact]
    public async Task Exception_details_are_displayed()
    {
        var options = new DatabaseErrorPageOptions();
 
        var model = new DatabaseErrorPageModel(
            new Exception("Something bad happened"),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: false,
                        pendingModelChanges: false,
                        pendingMigrations: new string[] { })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        Assert.Contains("Something bad happened", content);
    }
 
    [Fact]
    public async Task Inner_exception_details_are_displayed()
    {
        var options = new DatabaseErrorPageOptions();
 
        var model = new DatabaseErrorPageModel(
            new Exception("Something bad happened", new Exception("Because something more badder happened")),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: false,
                        pendingModelChanges: false,
                        pendingMigrations: new string[] { })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        Assert.Contains("Something bad happened", content);
        Assert.Contains("Because something more badder happened", content);
    }
 
    [Fact]
    public async Task MigrationsEndPointPath_is_respected()
    {
        var options = new DatabaseErrorPageOptions();
        options.MigrationsEndPointPath = "/HitThisEndPoint";
 
        var model = new DatabaseErrorPageModel(
            new Exception(),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: true,
                        pendingModelChanges: false,
                        pendingMigrations: new string[] { "111_MigrationOne" })
            },
            options: options,
            pathBase: PathString.Empty);
 
        var content = await ExecutePage(options, model);
 
        Assert.NotNull(options.MigrationsEndPointPath.Value); // guard
        Assert.Contains(options.MigrationsEndPointPath.Value, content);
    }
 
    [Fact]
    public async Task PathBase_is_respected()
    {
        var options = new DatabaseErrorPageOptions();
        options.MigrationsEndPointPath = "/HitThisEndPoint";
 
        var model = new DatabaseErrorPageModel(
            new Exception(),
            new DatabaseContextDetails[]
            {
                    new DatabaseContextDetails(
                        type: typeof(BloggingContext),
                        databaseExists: true,
                        pendingModelChanges: false,
                        pendingMigrations: new string[] { "111_MigrationOne" })
            },
            options: options,
            pathBase: "/PathBase");
 
        var content = await ExecutePage(options, model);
 
        Assert.Contains("/PathBase/HitThisEndPoint", content);
    }
 
    private static async Task<string> ExecutePage(DatabaseErrorPageOptions options, DatabaseErrorPageModel model)
    {
        var page = new DatabaseErrorPage();
        var context = new Mock<HttpContext>();
        var response = new Mock<HttpResponse>();
        var stream = new MemoryStream();
 
        response.Setup(r => r.Body).Returns(stream);
        context.Setup(c => c.Response).Returns(response.Object);
 
        page.Model = model;
 
        await page.ExecuteAsync(context.Object);
        var content = Encoding.ASCII.GetString(stream.ToArray());
        return content;
    }
 
    private class BloggingContext : DbContext
    {
 
    }
}