Skip to content

Latest commit

 

History

History
334 lines (271 loc) · 12.6 KB

06-switch-database-to-new-dotnet.md

File metadata and controls

334 lines (271 loc) · 12.6 KB

Switching the database to the new .NET

The step04 branch contains the project before applying the following steps.

The step05 shows how the project looks like after applying the following steps.

Now, we have reached to the point when all ASP.NET Web Forms pages are rewritten into DotVVM.

We need to deal with the last obstacle - the application uses the old ASP.NET Universal Providers to store the user accounts in the database.

In this tutorial, we will migrate just 2 out of 3 projects.

After performing all the steps, the web application will be temporarily non-compilable as it still targets .NET Framework. We will finish this in the next tutorial.

Migrating to Entity Framework Core and ASP.NET Core Identity

  1. Make sure you have installed the .NET Migration Assistant extension.

  2. Right-click the Altairis.VtipBaze.Data project and select Upgrade.

    Figure 06-01 Start the project upgrade

  3. Select In-place project upgrade.

    Figure 06-02 Select the in-place project upgrade

  4. Select .NET 8 as the target framework.

    Figure 06-03 Select .NET 8.0

  5. Proceed with the selection and wait until the project is upgraded.

  6. Delete the Properties folder and App.config files. They are not needed any more.

  7. Double-click the Altairis.VtipBaze.Data project to view the project file.

  8. Change the Entity Framework 6 NuGet package to Entity Framework Core, and add the ASP.NET Core Identity package.

     <Project Sdk="Microsoft.NET.Sdk">
         <PropertyGroup>
             <TargetFramework>net8.0</TargetFramework>
             <OutputType>Library</OutputType>
             <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
         </PropertyGroup>
         <ItemGroup>
             <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
             <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
             <PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
    -        <PackageReference Include="EntityFramework" Version="6.4.4" />
    +        <PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="8.0.0" />
    +        <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="8.0.0">
    +          <PrivateAssets>all</PrivateAssets>
    +          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    +        </PackageReference>
    +        <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.0" />
    +        <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="8.0.0">
    +          <PrivateAssets>all</PrivateAssets>
    +          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    +        </PackageReference>
         </ItemGroup>
         <PropertyGroup>
             <AssemblyTitle>Altairis VtipBaze DAL</AssemblyTitle>
             <Company>Altairis, s. r. o.</Company>
             <Product>Altairis VtipBaze</Product>
             <Copyright>Copyright © Michal A. Valasek - Altairis, 2011</Copyright>
             <AssemblyVersion>1.0.%2a</AssemblyVersion>
             <FileVersion>1.0.0.0</FileVersion>
         </PropertyGroup>
     </Project>
  9. We need to add support for ASP.NET Core Identity to the VtipBazeContext.

     using System;
     using System.Collections.Generic;
    -using System.Data.Entity;
     using System.Linq;
     using System.Text;
     using System.Threading.Tasks;
    +using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
    +using Microsoft.EntityFrameworkCore;
    
     namespace Altairis.VtipBaze.Data
     {
    -    public class VtipBazeContext : DbContext
    +    public class VtipBazeContext : IdentityDbContext
         {
    
             public DbSet<Joke> Jokes { get; set; }
    
             public DbSet<Tag> Tags { get; set; }
    
         }
     }
  10. We also need to add the required constructors for Entity Framework Core, specify the default connection string for migrations, and configure the names of M:N relationship tables so they would map to the tables we already have in the database.

     public class VtipBazeContext : IdentityDbContext
     {
        ...
    
    +    public VtipBazeContext()
    +    {
    +    }
    +
    +    public VtipBazeContext(DbContextOptions options) : base(options)
    +    {
    +    }
    +
    +    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    +    {
    +        if (!optionsBuilder.IsConfigured)
    +        {
    +            optionsBuilder.UseSqlServer(@"Data Source=.\SQLEXPRESS; Integrated Security=True; Initial Catalog=VtipBaze-old; MultipleActiveResultSets=True; Trust Server Certificate=true");
    +        }
    +        base.OnConfiguring(optionsBuilder);
    +    }
    +
    +    protected override void OnModelCreating(ModelBuilder builder)
    +    {
    +        builder.Entity<Joke>()
    +            .HasMany(j => j.Tags)
    +            .WithMany(t => t.Jokes)
    +            .UsingEntity<Dictionary<string, object>>(
    +                "TagJokes",
    +                b => b.HasOne<Tag>().WithMany().HasForeignKey("Tag_TagName"),
    +                b => b.HasOne<Joke>().WithMany().HasForeignKey("Joke_JokeId"));
    +
    +        base.OnModelCreating(builder);
    +    }    
    }

Create the migrations

  1. Now, we want to create a migration to add the ASP.NET Core Identity tables in the database.

    Open the Package Manager Console pane and make sure the Altairis.VtipBaze.Data project is selected as the Default project.

    Figure 06-06 Select the default project

    Then, run the following command:

    Add-Migration AspNetIdentityTables -Project Altairis.VtipBaze.Data -StartupProject Altairis.VtipBaze.Data
    
  2. We will need to manually edit the *_AspNetIdentityTables.cs migration as it creates also the tables we already have in the database:

    ...
     public partial class AspNetIdentityTables : Migration
     {
         /// <inheritdoc />
         protected override void Up(MigrationBuilder migrationBuilder)
         {            
     ...
    -        migrationBuilder.CreateTable(
    -            name: "Jokes",
    -            ...
    -
    -        migrationBuilder.CreateTable(
    -            name: "Tags",
    -            ...
    
     ...
    
    -        migrationBuilder.CreateTable(
    -            name: "TagJokes",
    -            ...
    
     ...
    
    -        migrationBuilder.CreateIndex(
    -            name: "IX_TagJokes_Tag_TagName",
    -            table: "TagJokes",
    -            column: "Tag_TagName");
         }
    
         /// <inheritdoc />
         protected override void Down(MigrationBuilder migrationBuilder)
         {
             ...
    
    -        migrationBuilder.DropTable(
    -            name: "TagJokes");
    
             ...
    
    -        migrationBuilder.DropTable(
    -           name: "Jokes");
    -
    -        migrationBuilder.DropTable(
    -           name: "Tags");
        }
     }    
  3. In the VtipBazeContext.cs, update the connection string to point to your database.

  4. Run the following command in Package Manager Console:

    Update-Database -Project Altairis.VtipBaze.Data -StartupProject Altairis.VtipBaze.Data
    
  5. This migration added the following tables to the database:

    Figure 06-04 New tables added in the database

The identity tables are empty. It is our responsibility to migrate all the users to the new database structure.

ASP.NET Core Identity uses a different method for hashing the passwords. In real-world applications, the users will be required to reset their passwords.

Migrating the database seed tool

  1. Use the .NET Migration Assistant to upgrade the Altairis.VtipBaze.Import project to *.NET 8. The process is the same as with the Altairis.VtipBaze.Data.

  2. Delete the Properties folder and App.config files. They are not needed any more.

  3. Double-click the Altairis.VtipBaze.Import to open the project file. We can remove most package references since they are present in the Data project:

     <Project Sdk="Microsoft.NET.Sdk">
         <PropertyGroup>
             <OutputType>Exe</OutputType>
         </PropertyGroup>
         <PropertyGroup>
             <StartupObject>Altairis.VtipBaze.Import.Program</StartupObject>
         </PropertyGroup>
         <PropertyGroup>
             <TargetFramework>net8.0</TargetFramework>
             <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
             <AssemblyTitle>Altairis.VtipBaze.Import</AssemblyTitle>
             <Product>Altairis.VtipBaze.Import</Product>
             <Copyright>Copyright ©  2011</Copyright>
             <AssemblyVersion>1.0.0.0</AssemblyVersion>
             <FileVersion>1.0.0.0</FileVersion>
         </PropertyGroup>
    -    <ItemGroup>
    -        <Reference Include="System.Web" />
    -        <Reference Include="System.Web.ApplicationServices" />
    -    </ItemGroup>
         <ItemGroup>
             <ProjectReference Include="..\Altairis.VtipBaze.Data\Altairis.VtipBaze.Data.csproj" />
         </ItemGroup>
         <ItemGroup>
             <PackageReference Include="ColorCode" Version="1.0.1" />
    -        <PackageReference Include="Microsoft.AspNet.Providers.Core" Version="2.0.0" />
    -        <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
    -        <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
    -        <PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
    -        <PackageReference Include="EntityFramework" Version="6.4.4" />
         </ItemGroup>
     </Project>    
  4. Update the Program.cs file to work with the new Entity Framework Core API:

     using System;
     using System.Collections.Generic;
     using System.IO;
     using System.Linq;
     using System.Text;
     using System.Threading.Tasks;
    -using System.Web.Security;
     using Altairis.VtipBaze.Data;
    +using Microsoft.AspNetCore.Identity;
    +using Microsoft.Extensions.DependencyInjection;
     
     namespace Altairis.VtipBaze.Import
     {
         class Program
         {
    -        static void Main(string[] args)
    +        static async Task Main(string[] args)
             {
                 using (var dc = new VtipBazeContext())
                 {
    -                dc.Database.CreateIfNotExists();
    +                dc.Database.EnsureCreated();
    
                    // seed data (all jokes were kindly provided by ChatGPT)
                    if (!dc.Tags.Any())
                    {
     ...
                    }
    
    +               var services = new ServiceCollection();
    +               services.AddDbContext<VtipBazeContext>();
    +               services.AddIdentityCore<IdentityUser>()
    +                   .AddEntityFrameworkStores<VtipBazeContext>();
    +               var provider = services.BuildServiceProvider();
    +               var userManager = provider.GetRequiredService<UserManager<IdentityUser>>();
    
    -               var adminUsers = Membership.FindUsersByName("admin");
    -               if (adminUsers.Count == 0)
    -               {
    -                   var user = Membership.CreateUser("admin", "admin123", "test@mail.local");
    -                   user.IsApproved = true;
    -                   Membership.UpdateUser(user);
    +               var adminUser = await userManager.FindByNameAsync("admin");
    +               if (adminUser == null)
    +               {
    +                   var user = new IdentityUser()
    +                   {
    +                      UserName = "admin",
    +                      Email = "test@mail.local",
    +                      SecurityStamp = Guid.NewGuid().ToString()
    +                   };
    +                   await userManager.CreateAsync(user);
    +                   await userManager.AddPasswordAsync(user, "Admin123+");
    
                        Console.WriteLine("Created admin user.");
                    }
                    else
                    {
                        Console.WriteLine("Admin user already exists, skipped.");
                    }
                }
            } 
        }
    }
  5. Run the tool to seed the admin user in the new database structure by right-clicking the project and selecting Debug:

    Figure 06-05 Running the import tool to seed the admin user