Bogus in C#: net10.0, UseSeeding, seeded generator, email test fix (#2300)

* Bogus: net10.0, UseSeeding instead of HasData, Migrate, seeded generator, email test fix

Retarget both projects to net10.0 (Bogus 35.6.5, EF Core 10.0.13, direct System.Security.Cryptography.Pkcs 10.0.13 for the SqlClient advisory; xunit 2.9.3, runner 4.0.1, Test SDK 18.11.0, coverlet 10.1.0).
EmployeeContext seeds through UseSeeding() in OnConfiguring(); OnModelCreating() and HasData() removed.
GetSeededEmployeesFromDb() calls Migrate() instead of EnsureCreated(); the employee generator keeps its Vehicles rule.
Add GenerateRepeatableVehicles(int seed) and a test that the same seed gives the same vehicles.
The email test asserts StartsWith(FirstName): Bogus does not always use the last name.

* Bogus: email test compares against the slugified first name

Bogus slugifies the name when it builds the email (D'angelo becomes Dangelo), so StartsWith(FirstName) failed about 2 to 3 times in 10,000 runs.
The test now asserts StartsWith(Utils.Slugify(FirstName)); 10,000 probe runs give 0 failures.

Author: vladimir-pecanac-main

dotnet-client-libraries/BogusNugetPackage/BogusNugetPackage/BogusNugetPackage.csproj

@@ -2,19 +2,20 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Bogus" Version="34.0.2" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="7.0.1" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="7.0.1">
+    <PackageReference Include="Bogus" Version="35.6.5" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="10.0.13" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="10.0.13">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="7.0.1" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="10.0.13" />
+    <PackageReference Include="System.Security.Cryptography.Pkcs" Version="10.0.13" />
   </ItemGroup>
 
 </Project>

dotnet-client-libraries/BogusNugetPackage/BogusNugetPackage/DataGenerator.cs

@@ -7,8 +7,8 @@
 namespace BogusNugetPackage;
 public static class DataGenerator
 {
-    public static readonly List<Employee> Employees = new();
-    public static readonly List<Vehicle> Vehicles = new();
+    public static readonly List<Employee> Employees = [];
+    public static readonly List<Vehicle> Vehicles = [];
 
     public const int NumberOfEmployees = 5;
     public const int NumberOfVehiclesPerEmployee = 2;
@@ -17,7 +17,7 @@ public static List<Employee> GetSeededEmployeesFromDb()
     {
         using var employeeDbContext = new EmployeeContext();
 
-        employeeDbContext.Database.EnsureCreated();
+        employeeDbContext.Database.Migrate();
 
         var dbEmployeesWithVehicles = employeeDbContext.Employees
            .Include(e => e.Vehicles)
@@ -31,14 +31,23 @@ public static void InitBogusData()
         var employeeGenerator = GetEmployeeGenerator();
         var generatedEmployees = employeeGenerator.Generate(NumberOfEmployees);
         Employees.AddRange(generatedEmployees);
-        generatedEmployees.ForEach(e => Vehicles.AddRange(GetBogusVehicleData(e.Id)));
+    }
+
+    public static List<Vehicle> GenerateRepeatableVehicles(int seed)
+    {
+        return new Faker<Vehicle>()
+            .UseSeed(seed)
+            .RuleFor(v => v.Id, f => f.Random.Guid())
+            .RuleFor(v => v.Manufacturer, f => f.Vehicle.Manufacturer())
+            .RuleFor(v => v.Fuel, f => f.Vehicle.Fuel())
+            .Generate(NumberOfVehiclesPerEmployee);
     }
 
     private static List<Vehicle> GetBogusVehicleData(Guid employeeId)
     {
         var vehicleGenerator = GetVehicleGenerator(employeeId);
         var generatedVehicles = vehicleGenerator.Generate(NumberOfVehiclesPerEmployee);
-
+        Vehicles.AddRange(generatedVehicles);
         return generatedVehicles;
     }
 
@@ -52,7 +61,11 @@ private static Faker<Employee> GetEmployeeGenerator()
             .RuleFor(e => e.Email, (f, e) => f.Internet.Email(e.FirstName, e.LastName))
             .RuleFor(e => e.AboutMe, f => f.Lorem.Paragraph(1))
             .RuleFor(e => e.YearsOld, f => f.Random.Int(18, 90))
-            .RuleFor(e => e.Personality, f => f.PickRandom<Personality>());
+            .RuleFor(e => e.Personality, f => f.PickRandom<Personality>())
+            .RuleFor(e => e.Vehicles, (_, e) =>
+            {
+                return GetBogusVehicleData(e.Id);
+            });
     }
 
     private static Faker<Vehicle> GetVehicleGenerator(Guid employeeId)

dotnet-client-libraries/BogusNugetPackage/BogusNugetPackage/Database/EmployeeContext.cs

@@ -9,15 +9,17 @@ public sealed class EmployeeContext : DbContext
 
     protected override void OnConfiguring(DbContextOptionsBuilder options)
     {
-        options.UseSqlServer("Server=localhost;Database=EmployeeDb;Trusted_Connection=True;MultipleActiveResultSets=True;TrustServerCertificate=True");
-        options.EnableSensitiveDataLogging();
-    }
+        options.UseSqlServer("Server=localhost;Database=EmployeeDb;Trusted_Connection=True;MultipleActiveResultSets=True;TrustServerCertificate=True")
+            .UseSeeding((context, _) =>
+            {
+                if (context.Set<Employee>().Any())
+                {
+                    return;
+                }
 
-    protected override void OnModelCreating(ModelBuilder modelBuilder)
-    {
-        base.OnModelCreating(modelBuilder);
-
-        modelBuilder.Entity<Employee>().HasData(DataGenerator.Employees);
-        modelBuilder.Entity<Vehicle>().HasData(DataGenerator.Vehicles);
+                context.Set<Employee>().AddRange(DataGenerator.Employees);
+                context.SaveChanges();
+            });
+        options.EnableSensitiveDataLogging();
     }
 }

dotnet-client-libraries/BogusNugetPackage/Tests/Tests.cs

@@ -1,4 +1,5 @@
-using BogusNugetPackage;
+using Bogus;
+using BogusNugetPackage;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -29,12 +30,22 @@ public void WhenGettingSingleVehicle_ThenObjectIsNotNull()
     }
 
     [Fact]
-    public void WhenGettingSingleEmployee_ThenEmailContainsLastName()
+    public void WhenGettingSingleEmployee_ThenEmailStartsWithFirstName()
     {
         DataGenerator.InitBogusData();
 
         var employee = DataGenerator.Employees.First();
 
-        Assert.Contains(employee.LastName, employee.Email);
+        // Bogus slugifies the name for the email, so D'angelo becomes Dangelo
+        Assert.StartsWith(Utils.Slugify(employee.FirstName), employee.Email);
+    }
+
+    [Fact]
+    public void WhenGeneratingWithTheSameSeed_ThenVehiclesAreEqual()
+    {
+        var first = DataGenerator.GenerateRepeatableVehicles(1338);
+        var second = DataGenerator.GenerateRepeatableVehicles(1338);
+
+        Assert.Equal(first.Select(v => v.ToString()), second.Select(v => v.ToString()));
     }
 }

dotnet-client-libraries/BogusNugetPackage/Tests/Tests.csproj

@@ -1,21 +1,21 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
-    <PackageReference Include="xunit" Version="2.4.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.11.0" />
+    <PackageReference Include="xunit" Version="2.9.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="4.0.1">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.1.2">
+    <PackageReference Include="coverlet.collector" Version="10.1.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>