♻️ 63 migrate to use docker db (#72)

* Add Common.csproj, DbConnectionFactory.cs, and docker-compose.yml * Add Common project and update connection string generation * All DbContext's now use common DbContextFactory to create the connection string. This allows us to easily switch out the server if needed. * Tweak GitHub workflow * Fixed build errors * Try using linux-style paths * Add explicit .NET 8 build target * Fixed casing on Directory.Build.props
danielmackay · Dec 17, 2023 · 38c381f · 38c381f
1 parent f0ec20a
commit 38c381f
Show file tree

Hide file tree

Showing 35 changed files with 175 additions and 125 deletions.
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -18,9 +18,9 @@ jobs:
     - uses: actions/checkout@v3
     - name: Setup .NET
       uses: actions/setup-dotnet@v3
-    - name: Restore dependencies
-      run: dotnet restore
+      with:
+        dotnet-version: 8.0.x
     - name: Build
-      run: dotnet build --no-restore
+      run: dotnet build
 #    - name: Test
 #      run: dotnet test --no-build --verbosity normal
diff --git a/BackingFields/ApplicationDbContext.cs b/BackingFields/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace BackingFields;
 
@@ -9,8 +10,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=BackingFields;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("BackingFields"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/BufferingAndStreaming/ApplicationDbContext.cs b/BufferingAndStreaming/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Diagnostics;
 
 namespace BufferingAndStreaming;
@@ -10,8 +11,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=BufferingAndStreaming;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("BufferingAndStreaming"));
 
         optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/BulkDeletes/ApplicationDbContext.cs b/BulkDeletes/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace BulkDeletes;
 
@@ -9,8 +10,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=BulkDeletes;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("BulkDeletes"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/BulkUpdates/ApplicationDbContext.cs b/BulkUpdates/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace BulkUpdates;
 
@@ -9,8 +10,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=BulkUpdate;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("BulkUpdate"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/Common/Common.csproj b/Common/Common.csproj
@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net8.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Data.SqlClient" Version="5.1.1" />
+    </ItemGroup>
+
+</Project>
diff --git a/Common/DbConnectionFactory.cs b/Common/DbConnectionFactory.cs
@@ -0,0 +1,23 @@
+using Microsoft.Data.SqlClient;
+
+namespace Common;
+
+public static class DbConnectionFactory
+{
+    public static string Create(string databaseName)
+    {
+        var builder = new SqlConnectionStringBuilder
+        {
+            DataSource = "localhost",
+            InitialCatalog = databaseName,
+            UserID = "sa",
+            Password = "yourStrong(!)Password",
+            TrustServerCertificate = true,
+            MultipleActiveResultSets = true
+        };
+
+        Console.WriteLine($"Generated connection string: {builder.ConnectionString}");
+
+        return builder.ConnectionString;
+    }
+}
diff --git a/CompiledModels/ApplicationDbContext.cs b/CompiledModels/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using CompiledModels.CompiledModels;
+using Common;
+using CompiledModels.CompiledModels;
 using Microsoft.EntityFrameworkCore;
 
 namespace CompiledModels;
@@ -10,8 +11,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=CompiledModels;Trusted_Connection=True")
+            .UseSqlServer(DbConnectionFactory.Create("CompiledModels"))
             .UseModel(ApplicationDbContextModel.Instance);
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });

diff --git a/CompiledQueries/ApplicationDbContext.cs b/CompiledQueries/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace CompiledQueries;
 
@@ -9,8 +10,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=CompiledQueries;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("CompiledQueries"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/DateOnlyTimeOnly/ApplicationDbContext.cs b/DateOnlyTimeOnly/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace DateOnlyTimeOnly;
 
@@ -9,8 +10,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=DateOnlyTimeOnly;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("DateOnlyTimeOnly"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/DateOnlyTimeOnly/DateOnlyTimeOnly.csproj b/DateOnlyTimeOnly/DateOnlyTimeOnly.csproj
@@ -11,4 +11,8 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\Common\Common.csproj" />
+  </ItemGroup>
+
 </Project>
diff --git a/DbContextPooling/Program.cs b/DbContextPooling/Program.cs
@@ -1,4 +1,5 @@
-using DbContextPooling;
+using Common;
+using DbContextPooling;
 using Microsoft.EntityFrameworkCore.Infrastructure;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection;
@@ -8,7 +9,7 @@
 Console.WriteLine("Pooling WITHOUT Dependency Injection");
 
 var options = new DbContextOptionsBuilder<ApplicationDbContext>()
-    .UseSqlServer(@"Server=(localdb)\mssqllocaldb;Database=DbContextPooling;Trusted_Connection=True");
+        .UseSqlServer(DbConnectionFactory.Create("DbContextPooling"));
 
 var factory = new PooledDbContextFactory<ApplicationDbContext>(options.Options);
 
@@ -20,7 +21,7 @@
 
 var services = new ServiceCollection();
 services.AddDbContextPool<ApplicationDbContext>(
-    o => o.UseSqlServer(@"Server=(localdb)\mssqllocaldb;Database=DbContextPooling;Trusted_Connection=True"));
+    o => o.UseSqlServer(DbConnectionFactory.Create("DbContextPooling")));
 
 var sp = services.BuildServiceProvider();
 

diff --git a/Directory.Build.Props b/Directory.Build.Props
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -0,0 +1,8 @@
+<Project>
+    <PropertyGroup>
+        <TreatWarningsAsErrors Condition="'$(Configuration)' != 'Debug'">true</TreatWarningsAsErrors>
+    </PropertyGroup>
+    <ItemGroup Condition="'$(MSBuildProjectName)' != 'Common'">
+        <ProjectReference Include="../Common/Common.csproj"/>
+    </ItemGroup>
+</Project>
diff --git a/EfCoreSamples.sln b/EfCoreSamples.sln
@@ -54,6 +54,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BufferingAndStreaming", "Bu
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CompiledModels", "CompiledModels\CompiledModels.csproj", "{01B7FAFB-DA74-4259-B2C3-4DAC9154D8E8}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Common", "Common\Common.csproj", "{7047FA95-2543-4221-A749-35AE5E92B716}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -152,6 +154,10 @@ Global
 		{01B7FAFB-DA74-4259-B2C3-4DAC9154D8E8}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{01B7FAFB-DA74-4259-B2C3-4DAC9154D8E8}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{01B7FAFB-DA74-4259-B2C3-4DAC9154D8E8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7047FA95-2543-4221-A749-35AE5E92B716}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7047FA95-2543-4221-A749-35AE5E92B716}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7047FA95-2543-4221-A749-35AE5E92B716}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7047FA95-2543-4221-A749-35AE5E92B716}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/JsonColumns/ApplicationDbContext.cs b/JsonColumns/ApplicationDbContext.cs
@@ -1,16 +1,16 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace JsonColumns;
 
 public class ApplicationDbContext : DbContext
 {
-    public DbSet<Contact> Contacts { get; set; }
+    public DbSet<Contact> Contacts { get; set; } = null!;
 
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=JsonColumns;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("JsonColumns"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/JsonColumns/Entities.cs b/JsonColumns/Entities.cs
@@ -3,8 +3,8 @@
 public class Contact
 {
     public int Id { get; set; }
-    public string Name { get; set; } = null!;
-    public Address? Address { get; set; }
+    public string Name { get; init; } = null!;
+    public required Address Address { get; set; } = null!;
     public ICollection<Note>? Notes { get; set; }
 
     public override string ToString()

diff --git a/JsonColumns/Program.cs b/JsonColumns/Program.cs
@@ -8,55 +8,32 @@
 
 var contacts = new List<Contact>
 {
-    new Contact
+    new()
     {
         Name = "John Doe",
-        Address = new Address
-        {
-            Line1 = "123 Main St.",
-            Line2 = "Suite 101",
-            City = "Seattle",
-            State = "WA"
-        },
-        Notes = new List<Note>
-        {
-            new Note { Text = "Note 1"},
-            new Note { Text = "Note 2"},
-            new Note { Text = "Note 3"}
-        }
+        Address = new Address { Line1 = "123 Main St.", Line2 = "Suite 101", City = "Seattle", State = "WA" },
+        Notes =
+            new List<Note>
+            {
+                new() { Text = "Note 1" }, new() { Text = "Note 2" }, new() { Text = "Note 3" }
+            }
     },
-    new Contact
+    new()
     {
         Name = "Jane Doe",
-        Address = new Address
-        {
-            Line1 = "456 Main St.",
-            Line2 = "Suite 202",
-            City = "Seattle",
-            State = "WA"
-        },
+        Address = new Address { Line1 = "456 Main St.", Line2 = "Suite 202", City = "Seattle", State = "WA" },
         Notes = new List<Note>
         {
-            new Note { Text = "Note 4"},
-            new Note { Text = "Note 5"},
-            new Note { Text = "Note 6"}
+            new() { Text = "Note 4" }, new() { Text = "Note 5" }, new() { Text = "Note 6" }
         }
     },
-    new Contact
+    new()
     {
         Name = "John Smith",
-        Address = new Address
-        {
-            Line1 = "789 Main St.",
-            Line2 = "Suite 303",
-            City = "Seattle",
-            State = "WA"
-        },
+        Address = new Address { Line1 = "789 Main St.", Line2 = "Suite 303", City = "Seattle", State = "WA" },
         Notes = new List<Note>
         {
-            new Note { Text = "Note 7"},
-            new Note { Text = "Note 8"},
-            new Note { Text = "Note 9"}
+            new() { Text = "Note 7" }, new() { Text = "Note 8" }, new() { Text = "Note 9" }
         }
     }
 };
@@ -72,6 +49,8 @@
     .First(c => c.Name == "John Smith")
     .Notes;
 
+ArgumentNullException.ThrowIfNull(notes);
+
 foreach (var note in notes)
     Console.WriteLine(note);
 
@@ -82,8 +61,7 @@
 
 Console.WriteLine("Deleting Data");
 var contactToDelete = db.Contacts.First(c => c.Name == "Jane Doe");
-contact.Address = null;
+contactToDelete.Address = new Address();
 db.SaveChanges();
 
-Console.ReadLine();
-
+Console.ReadLine();
diff --git a/KeysetPagination/ApplicationDbContext.cs b/KeysetPagination/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace KeysetPagination;
 
@@ -9,8 +10,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=KeysetPagination;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("KeysetPagination"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }

diff --git a/MigrationBundles/ApplicationDbContext.cs b/MigrationBundles/ApplicationDbContext.cs
@@ -1,4 +1,5 @@
-using Microsoft.EntityFrameworkCore;
+using Common;
+using Microsoft.EntityFrameworkCore;
 
 namespace MigrationBundles;
 
@@ -9,8 +10,7 @@ public class ApplicationDbContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         optionsBuilder
-            .UseSqlServer(
-                @"Server=(localdb)\mssqllocaldb;Database=MigrationBundles;Trusted_Connection=True");
+            .UseSqlServer(DbConnectionFactory.Create("MigrationBundles"));
 
         //optionsBuilder.LogTo(Console.WriteLine, new[] { RelationalEventId.CommandExecuted });
     }