(#215) MySQL Test Suite

Author: Adrian Hall

Directory.Packages.props

@@ -27,6 +27,7 @@
     <PackageVersion Include="NSubstitute" Version="5.3.0" />
     <PackageVersion Include="NSwag.AspNetCore" Version="14.2.0" />
     <PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.3" />
+    <PackageVersion Include="Pomelo.EntityFrameworkCore.MySql" Version="8.0.2" />
     <PackageVersion Include="Swashbuckle.AspNetCore" Version="7.2.0" />
     <PackageVersion Include="System.Formats.Asn1" Version="9.0.1" />
     <PackageVersion Include="System.Linq.Async" Version="6.0.1" />

tests/CommunityToolkit.Datasync.Server.EntityFrameworkCore.Test/MySqlEntityTableRepository_Tests.cs

@@ -0,0 +1,94 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using CommunityToolkit.Datasync.TestCommon;
+using CommunityToolkit.Datasync.TestCommon.Databases;
+using Microsoft.EntityFrameworkCore;
+using Xunit.Abstractions;
+
+namespace CommunityToolkit.Datasync.Server.EntityFrameworkCore.Test;
+
+[ExcludeFromCodeCoverage]
+[Collection("LiveTestsCollection")]
+public class MysqlEntityTableRepository_Tests : RepositoryTests<MysqlEntityMovie>
+{
+    #region Setup
+    private readonly DatabaseFixture _fixture;
+    private readonly Random random = new();
+    private readonly string connectionString;
+    private readonly List<MysqlEntityMovie> movies;
+    private readonly Lazy<MysqlDbContext> _context;
+
+    public MysqlEntityTableRepository_Tests(DatabaseFixture fixture, ITestOutputHelper output) : base()
+    {
+        this._fixture = fixture;
+        this.connectionString = Environment.GetEnvironmentVariable("DATASYNC_MYSQL_CONNECTIONSTRING");
+        if (!string.IsNullOrEmpty(this.connectionString))
+        {
+            this._context = new Lazy<MysqlDbContext>(() => MysqlDbContext.CreateContext(this.connectionString, output));
+            this.movies = Context.Movies.AsNoTracking().ToList();
+        }
+    }
+
+    private MysqlDbContext Context { get => this._context.Value; }
+
+    protected override bool CanRunLiveTests() => !string.IsNullOrEmpty(this.connectionString);
+
+    protected override Task<MysqlEntityMovie> GetEntityAsync(string id)
+        => Task.FromResult(Context.Movies.AsNoTracking().SingleOrDefault(m => m.Id == id));
+
+    protected override Task<int> GetEntityCountAsync()
+        => Task.FromResult(Context.Movies.Count());
+
+    protected override Task<IRepository<MysqlEntityMovie>> GetPopulatedRepositoryAsync()
+        => Task.FromResult<IRepository<MysqlEntityMovie>>(new EntityTableRepository<MysqlEntityMovie>(Context));
+
+    protected override Task<string> GetRandomEntityIdAsync(bool exists)
+       => Task.FromResult(exists ? this.movies[this.random.Next(this.movies.Count)].Id : Guid.NewGuid().ToString());
+    #endregion
+
+    [SkippableFact]
+    public void EntityTableRepository_BadDbSet_Throws()
+    {
+        Skip.IfNot(CanRunLiveTests());
+        Action act = () => _ = new EntityTableRepository<EntityTableData>(Context);
+        act.Should().Throw<ArgumentException>();
+    }
+
+    [SkippableFact]
+    public void EntityTableRepository_GoodDbSet_Works()
+    {
+        Skip.IfNot(CanRunLiveTests());
+        Action act = () => _ = new EntityTableRepository<MysqlEntityMovie>(Context);
+        act.Should().NotThrow();
+    }
+
+    [SkippableFact]
+    public async Task WrapExceptionAsync_ThrowsConflictException_WhenDbConcurrencyUpdateExceptionThrown()
+    {
+        Skip.IfNot(CanRunLiveTests());
+        EntityTableRepository<MysqlEntityMovie> repository = await GetPopulatedRepositoryAsync() as EntityTableRepository<MysqlEntityMovie>;
+        string id = await GetRandomEntityIdAsync(true);
+        MysqlEntityMovie expectedPayload = await GetEntityAsync(id);
+
+        static Task innerAction() => throw new DbUpdateConcurrencyException("Concurrency exception");
+
+        Func<Task> act = async () => await repository.WrapExceptionAsync(id, innerAction);
+        (await act.Should().ThrowAsync<HttpException>()).WithStatusCode(409).And.WithPayload(expectedPayload);
+    }
+
+    [SkippableFact]
+    public async Task WrapExceptionAsync_ThrowsRepositoryException_WhenDbUpdateExceptionThrown()
+    {
+        Skip.IfNot(CanRunLiveTests());
+        EntityTableRepository<MysqlEntityMovie> repository = await GetPopulatedRepositoryAsync() as EntityTableRepository<MysqlEntityMovie>;
+        string id = await GetRandomEntityIdAsync(true);
+        MysqlEntityMovie expectedPayload = await GetEntityAsync(id);
+
+        static Task innerAction() => throw new DbUpdateException("Non-concurrency exception");
+
+        Func<Task> act = async () => await repository.WrapExceptionAsync(id, innerAction);
+        await act.Should().ThrowAsync<RepositoryException>();
+    }
+}

tests/CommunityToolkit.Datasync.Server.Test/Helpers/LiveTestsCollection.cs

@@ -11,6 +11,7 @@ public class DatabaseFixture
 {
     public bool AzureSqlIsInitialized { get; set; } = false;
     public bool CosmosIsInitialized { get; set; } = false;
+    public bool MysqlIsInitialized { get; set; } = false;
     public bool PgIsInitialized { get; set; } = false;
 }
 

tests/CommunityToolkit.Datasync.Server.Test/Live/MySQL_Controller_Tests.cs

@@ -0,0 +1,54 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using CommunityToolkit.Datasync.Server.EntityFrameworkCore;
+using CommunityToolkit.Datasync.Server.Test.Helpers;
+using CommunityToolkit.Datasync.TestCommon.Databases;
+using Microsoft.EntityFrameworkCore;
+using Xunit.Abstractions;
+
+namespace CommunityToolkit.Datasync.Server.Test.Live;
+
+[ExcludeFromCodeCoverage]
+[Collection("LiveTestsCollection")]
+public class MySQL_Controller_Tests : LiveControllerTests<MysqlEntityMovie>
+{
+    #region Setup
+    private readonly DatabaseFixture _fixture;
+    private readonly Random random = new();
+    private readonly string connectionString;
+    private readonly List<MysqlEntityMovie> movies;
+
+    public MySQL_Controller_Tests(DatabaseFixture fixture, ITestOutputHelper output) : base()
+    {
+        this._fixture = fixture;
+        this.connectionString = Environment.GetEnvironmentVariable("DATASYNC_MYSQL_CONNECTIONSTRING");
+        if (!string.IsNullOrEmpty(this.connectionString))
+        {
+            output.WriteLine($"MysqlIsInitialized = {this._fixture.MysqlIsInitialized}");
+            Context = MysqlDbContext.CreateContext(this.connectionString, output, clearEntities: !this._fixture.MysqlIsInitialized);
+            this.movies = Context.Movies.AsNoTracking().ToList();
+            this._fixture.MysqlIsInitialized = true;
+        }
+    }
+
+    private MysqlDbContext Context { get; set; }
+
+    protected override string DriverName { get; } = "PgSQL";
+
+    protected override bool CanRunLiveTests() => !string.IsNullOrEmpty(this.connectionString);
+
+    protected override Task<MysqlEntityMovie> GetEntityAsync(string id)
+        => Task.FromResult(Context.Movies.AsNoTracking().SingleOrDefault(m => m.Id == id));
+
+    protected override Task<int> GetEntityCountAsync()
+        => Task.FromResult(Context.Movies.Count());
+
+    protected override Task<IRepository<MysqlEntityMovie>> GetPopulatedRepositoryAsync()
+        => Task.FromResult<IRepository<MysqlEntityMovie>>(new EntityTableRepository<MysqlEntityMovie>(Context));
+
+    protected override Task<string> GetRandomEntityIdAsync(bool exists)
+        => Task.FromResult(exists ? this.movies[this.random.Next(this.movies.Count)].Id : Guid.NewGuid().ToString());
+    #endregion
+}

tests/CommunityToolkit.Datasync.TestCommon/CommunityToolkit.Datasync.TestCommon.csproj

@@ -19,6 +19,7 @@
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
     <PackageReference Include="Microsoft.Spatial" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" />
+    <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" />
   </ItemGroup>
 
   <ItemGroup>

tests/CommunityToolkit.Datasync.TestCommon/Databases/MySQL/MysqlDbContext.cs

@@ -0,0 +1,47 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using Microsoft.EntityFrameworkCore;
+using Xunit.Abstractions;
+
+namespace CommunityToolkit.Datasync.TestCommon.Databases;
+
+[ExcludeFromCodeCoverage]
+public class MysqlDbContext(DbContextOptions<MysqlDbContext> options) : BaseDbContext<MysqlDbContext, MysqlEntityMovie>(options)
+{
+    public static MysqlDbContext CreateContext(string connectionString, ITestOutputHelper output = null, bool clearEntities = true)
+    {
+        if (string.IsNullOrEmpty(connectionString))
+        {
+            throw new ArgumentNullException(nameof(connectionString));
+        }
+
+        DbContextOptionsBuilder<MysqlDbContext> optionsBuilder = new DbContextOptionsBuilder<MysqlDbContext>()
+            .UseMySql(connectionString: connectionString, serverVersion: ServerVersion.AutoDetect(connectionString))
+            .EnableLogging(output);
+        MysqlDbContext context = new(optionsBuilder.Options);
+
+        context.InitializeDatabase(clearEntities);
+        context.PopulateDatabase();
+        return context;
+    }
+
+    internal void InitializeDatabase(bool clearEntities)
+    {
+        Database.EnsureCreated();
+
+        if (clearEntities)
+        {
+            ExecuteRawSqlOnEachEntity(@"DELETE FROM ""{0}""");
+        }
+    }
+
+    protected override void OnModelCreating(ModelBuilder modelBuilder)
+    {
+        modelBuilder.Entity<MysqlEntityMovie>().Property(m => m.UpdatedAt)
+            .ValueGeneratedOnAddOrUpdate();
+
+        base.OnModelCreating(modelBuilder);
+    }
+}

tests/CommunityToolkit.Datasync.TestCommon/Databases/MySQL/MysqlEntityMovie.cs

@@ -0,0 +1,64 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using CommunityToolkit.Datasync.Server.EntityFrameworkCore;
+using CommunityToolkit.Datasync.TestCommon.Models;
+using System.ComponentModel.DataAnnotations;
+
+namespace CommunityToolkit.Datasync.TestCommon.Databases;
+
+[ExcludeFromCodeCoverage]
+public class MysqlEntityMovie : EntityTableData, IMovie, IEquatable<IMovie>
+{
+    /// <summary>
+    /// True if the movie won the oscar for Best Picture
+    /// </summary>
+    public bool BestPictureWinner { get; set; }
+
+    /// <summary>
+    /// The running time of the movie
+    /// </summary>
+    [Required]
+    [Range(60, 360)]
+    public int Duration { get; set; }
+
+    /// <summary>
+    /// The MPAA rating for the movie, if available.
+    /// </summary>
+    public MovieRating Rating { get; set; } = MovieRating.Unrated;
+
+    /// <summary>
+    /// The release date of the movie.
+    /// </summary>
+    [Required]
+    public DateOnly ReleaseDate { get; set; }
+
+    /// <summary>
+    /// The title of the movie.
+    /// </summary>
+    [Required]
+    [StringLength(128, MinimumLength = 2)]
+    public string Title { get; set; } = string.Empty;
+
+    /// <summary>
+    /// The year that the movie was released.
+    /// </summary>
+    [Required]
+    [Range(1920, 2030)]
+    public int Year { get; set; }
+
+    /// <summary>
+    /// Determines if this movie has the same content as another movie.
+    /// </summary>
+    /// <param name="other">The other movie</param>
+    /// <returns>true if the content is the same</returns>
+    public bool Equals(IMovie other)
+        => other != null
+        && other.BestPictureWinner == BestPictureWinner
+        && other.Duration == Duration
+        && other.Rating == Rating
+        && other.ReleaseDate == ReleaseDate
+        && other.Title == Title
+        && other.Year == Year;
+}

tests/CommunityToolkit.Datasync.TestService/CommunityToolkit.Datasync.TestService.csproj

@@ -18,5 +18,6 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" />
+    <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" />
   </ItemGroup>
 </Project>