(#204) WIP: Cosmos, with single time db setup for test performance.

Author: Adrian Hall

infra/modules/cosmos.bicep

@@ -73,7 +73,15 @@ resource cosmos_container 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/co
         compositeIndexes: [
           [
             { path: '/UpdatedAt', order: 'ascending' }
-            { path: '/Id', order: 'ascending' }
+            { path: '/id', order: 'ascending' }
+          ]
+          [
+            { path: '/Title', order: 'ascending' }
+            { path: '/id', order: 'ascending' }
+          ]
+          [
+            { path: '/Title', order: 'descending' }
+            { path: '/id', order: 'ascending' }
           ]
         ]
       }

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

@@ -9,7 +9,9 @@ namespace CommunityToolkit.Datasync.Server.Test.Helpers;
 /// </summary>
 public class DatabaseFixture
 {
-
+    public bool AzureSqlIsInitialized { get; set; } = false;
+    public bool CosmosIsInitialized { get; set; } = false;
+    public bool PgIsInitialized { get; set; } = false;
 }
 
 [CollectionDefinition("LiveTestsCollection", DisableParallelization = true)]

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

@@ -19,20 +19,20 @@ public class AzureSQL_Controller_Tests : LiveControllerTests<AzureSqlEntityMovie
     private readonly Random random = new();
     private readonly string connectionString;
     private readonly List<AzureSqlEntityMovie> movies;
-    private readonly Lazy<AzureSqlDbContext> _context;
 
     public AzureSQL_Controller_Tests(DatabaseFixture fixture, ITestOutputHelper output) : base()
     {
         this._fixture = fixture;
         this.connectionString = Environment.GetEnvironmentVariable("DATASYNC_AZSQL_CONNECTIONSTRING");
         if (!string.IsNullOrEmpty(this.connectionString))
         {
-            this._context = new Lazy<AzureSqlDbContext>(() => AzureSqlDbContext.CreateContext(this.connectionString, output));
+            Context = AzureSqlDbContext.CreateContext(this.connectionString, output, clearEntities: this._fixture.AzureSqlIsInitialized);
             this.movies = [.. Context.Movies.AsNoTracking()];
+            this._fixture.AzureSqlIsInitialized = true;
         }
     }
 
-    private AzureSqlDbContext Context { get => this._context.Value; }
+    private AzureSqlDbContext Context { get; set; }
 
     protected override bool CanRunLiveTests() => !string.IsNullOrEmpty(this.connectionString);
 

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

@@ -0,0 +1,59 @@
+// 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 Cosmos_Controller_Tests : LiveControllerTests<CosmosEntityMovie>
+{
+    #region Setup
+    private readonly DatabaseFixture _fixture;
+    private readonly Random random = new();
+    private readonly string connectionString;
+    private readonly List<CosmosEntityMovie> movies;
+
+    public Cosmos_Controller_Tests(DatabaseFixture fixture, ITestOutputHelper output) : base()
+    {
+        this._fixture = fixture;
+        this.connectionString = Environment.GetEnvironmentVariable("DATASYNC_COSMOS_CONNECTIONSTRING");
+        if (!string.IsNullOrEmpty(this.connectionString))
+        {
+            // Note: we don't clear entities on every run to speed up the test runs.  This can only be done because
+            // the tests are read-only (associated with the query and get capabilities).  If the test being run writes
+            // to the database then change clearEntities to true.
+            Context = CosmosDbContext.CreateContext(this.connectionString, output, clearEntities: this._fixture.CosmosIsInitialized);
+            this.movies = [.. Context.Movies.AsNoTracking()];
+            this._fixture.CosmosIsInitialized = true;
+        }
+    }
+
+    private CosmosDbContext Context { get; set; }
+
+    protected override bool CanRunLiveTests() => !string.IsNullOrEmpty(this.connectionString);
+
+    /// <summary>
+    /// There are a set of tests that are not supported by CosmosDB, so we disable them
+    /// </summary>
+    protected override bool CanRunMathQueryTests() => false;
+
+    protected override Task<CosmosEntityMovie> 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<CosmosEntityMovie>> GetPopulatedRepositoryAsync()
+        => Task.FromResult<IRepository<CosmosEntityMovie>>(new EntityTableRepository<CosmosEntityMovie>(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.Server.Test/Live/PgSQL_Controller_Tests.cs

@@ -19,20 +19,20 @@ public class PgSQL_Controller_Tests : LiveControllerTests<PgEntityMovie>
     private readonly Random random = new();
     private readonly string connectionString;
     private readonly List<PgEntityMovie> movies;
-    private readonly Lazy<PgDbContext> _context;
 
     public PgSQL_Controller_Tests(DatabaseFixture fixture, ITestOutputHelper output) : base()
     {
         this._fixture = fixture;
         this.connectionString = Environment.GetEnvironmentVariable("DATASYNC_PGSQL_CONNECTIONSTRING");
         if (!string.IsNullOrEmpty(this.connectionString))
         {
-            this._context = new Lazy<PgDbContext>(() => PgDbContext.CreateContext(this.connectionString, output));
+            Context = PgDbContext.CreateContext(this.connectionString, output, clearEntities: this._fixture.PgIsInitialized);
             this.movies = Context.Movies.AsNoTracking().ToList();
+            this._fixture.PgIsInitialized = true;
         }
     }
 
-    private PgDbContext Context { get => this._context.Value; }
+    private PgDbContext Context { get; set; }
 
     protected override bool CanRunLiveTests() => !string.IsNullOrEmpty(this.connectionString);
 

tests/CommunityToolkit.Datasync.TestCommon/Databases/AzureSql/AzureSqlDbContext.cs

@@ -11,7 +11,7 @@ namespace CommunityToolkit.Datasync.TestCommon.Databases;
 [ExcludeFromCodeCoverage]
 public class AzureSqlDbContext(DbContextOptions<AzureSqlDbContext> options) : BaseDbContext<AzureSqlDbContext, AzureSqlEntityMovie>(options)
 {
-    public static AzureSqlDbContext CreateContext(string connectionString, ITestOutputHelper output = null)
+    public static AzureSqlDbContext CreateContext(string connectionString, ITestOutputHelper output = null, bool clearEntities = true)
     {
         if (string.IsNullOrEmpty(connectionString))
         {
@@ -23,12 +23,12 @@ public static AzureSqlDbContext CreateContext(string connectionString, ITestOutp
             .EnableLogging(output);
         AzureSqlDbContext context = new(optionsBuilder.Options);
 
-        context.InitializeDatabase();
+        context.InitializeDatabase(clearEntities);
         context.PopulateDatabase();
         return context;
     }
 
-    internal void InitializeDatabase()
+    internal void InitializeDatabase(bool clearEntities)
     {
         const string datasyncTrigger = @"
             CREATE OR ALTER TRIGGER [dbo].[{0}_datasync] ON [dbo].[{0}] AFTER INSERT, UPDATE AS
@@ -44,8 +44,12 @@ internal void InitializeDatabase()
         ";
 
         Database.EnsureCreated();
-        ExecuteRawSqlOnEachEntity("DELETE FROM [dbo].[{0}]");
         ExecuteRawSqlOnEachEntity(datasyncTrigger);
+
+        if (clearEntities)
+        {
+            ExecuteRawSqlOnEachEntity("DELETE FROM [dbo].[{0}]");
+        }
     }
 
     protected override void ConfigureConventions(ModelConfigurationBuilder configurationBuilder)

tests/CommunityToolkit.Datasync.TestCommon/Databases/Base/BaseDbContext.cs

@@ -48,8 +48,15 @@ protected void ExecuteRawSqlOnEachEntity(string format)
     /// <summary>
     /// Populates the database with the core set of movies.  Ensures that we have the same data for all tests.
     /// </summary>
+    [SuppressMessage("Performance", "CA1827:Do not use Count() or LongCount() when Any() can be used", Justification = "CosmosDB does not support .Any()")]
     protected void PopulateDatabase()
     {
+        bool hasEntities = Movies.Count() > 0;
+        if (hasEntities)
+        {
+            return;
+        }
+
         List<TEntity> movies = [.. TestData.Movies.OfType<TEntity>()];
         MovieIds = movies.ConvertAll(m => m.Id);
 

tests/CommunityToolkit.Datasync.TestCommon/Databases/CosmosDb/CosmosDbContext.cs

@@ -12,7 +12,7 @@ namespace CommunityToolkit.Datasync.TestCommon.Databases;
 [ExcludeFromCodeCoverage]
 public class CosmosDbContext(DbContextOptions<CosmosDbContext> options) : BaseDbContext<CosmosDbContext, CosmosEntityMovie>(options)
 {
-    public static CosmosDbContext CreateContext(string connectionString, ITestOutputHelper output = null)
+    public static CosmosDbContext CreateContext(string connectionString, ITestOutputHelper output = null, bool clearEntities = true)
     {
         if (string.IsNullOrEmpty(connectionString))
         {
@@ -24,15 +24,18 @@ public static CosmosDbContext CreateContext(string connectionString, ITestOutput
             .EnableLogging(output);
         CosmosDbContext context = new(optionsBuilder.Options);
 
-        context.InitializeDatabase();
+        context.InitializeDatabase(clearEntities);
         context.PopulateDatabase();
         return context;
     }
 
-    internal void InitializeDatabase()
+    internal void InitializeDatabase(bool clearEntities)
     {
-        RemoveRange(Movies.ToList());
-        SaveChanges();
+        if (clearEntities)
+        {
+            RemoveRange(Movies.ToList());
+            SaveChanges();
+        }
     }
 
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
@@ -48,6 +51,10 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             builder.HasNoDiscriminator();
             builder.HasPartitionKey(model => model.Id);
             builder.Property(model => model.EntityTag).IsETagConcurrency();
+
+            // Note that the composite indices needed for Cosmos are defined in the bicep
+            // See infra/modules/cosmos.bicep
+
         });
         base.OnModelCreating(modelBuilder);
     }

tests/CommunityToolkit.Datasync.TestCommon/Databases/Postgresql/PgDbContext.cs

@@ -10,7 +10,7 @@ namespace CommunityToolkit.Datasync.TestCommon.Databases;
 [ExcludeFromCodeCoverage]
 public class PgDbContext(DbContextOptions<PgDbContext> options) : BaseDbContext<PgDbContext, PgEntityMovie>(options)
 {
-    public static PgDbContext CreateContext(string connectionString, ITestOutputHelper output = null)
+    public static PgDbContext CreateContext(string connectionString, ITestOutputHelper output = null, bool clearEntities = true)
     {
         if (string.IsNullOrEmpty(connectionString))
         {
@@ -22,12 +22,12 @@ public static PgDbContext CreateContext(string connectionString, ITestOutputHelp
             .EnableLogging(output);
         PgDbContext context = new(optionsBuilder.Options);
 
-        context.InitializeDatabase();
+        context.InitializeDatabase(clearEntities);
         context.PopulateDatabase();
         return context;
     }
 
-    internal void InitializeDatabase()
+    internal void InitializeDatabase(bool clearEntities)
     {
         const string datasyncTrigger = @"
             CREATE OR REPLACE FUNCTION {0}_datasync() RETURNS trigger AS $$
@@ -47,8 +47,12 @@ FOR EACH ROW EXECUTE PROCEDURE
         ";
 
         Database.EnsureCreated();
-        ExecuteRawSqlOnEachEntity(@"DELETE FROM ""{0}""");
         ExecuteRawSqlOnEachEntity(datasyncTrigger);
+
+        if (clearEntities)
+        {
+            ExecuteRawSqlOnEachEntity(@"DELETE FROM ""{0}""");
+        }
     }
 
     protected override void OnModelCreating(ModelBuilder modelBuilder)