[ADMINAPI-1477] - Moves Instance Management endpoints to /dataStores/manage (v3) and /odsInstances/manage (v2)

Application/EdFi.Ods.AdminApi.Common/Constants/Constants.cs

@@ -66,7 +66,7 @@ public enum AdminApiMode
     Unversioned
 }
 
-public enum DbInstanceStatus
+public enum OdsInstanceManageStatus
 {
     PendingCreate,
     Created,

Application/EdFi.Ods.AdminApi.Common/Infrastructure/Jobs/JobConstants.cs

@@ -9,12 +9,12 @@ public class JobConstants
 {
     public const string JobTypeKey = "JobType";
     public const string TenantNameKey = "TenantName";
-    public const string DbInstanceIdKey = "DbInstanceId";
+    public const string OdsInstanceManageIdKey = "OdsInstanceManageId";
     public const string OdsInstanceIdKey = "OdsInstanceId";
     public const string CreateInstanceJobName = "CreateInstanceJob";
-    public const string CreatePendingDbInstancesDispatcherJobName = "CreatePendingDbInstancesDispatcherJob";
+    public const string CreatePendingOdsInstanceManagesDispatcherJobName = "CreatePendingOdsInstanceManagesDispatcherJob";
     public const string DeleteInstanceJobName = "DeleteInstanceJob";
-    public const string DeletePendingDbInstancesDispatcherJobName = "DeletePendingDbInstancesDispatcherJob";
+    public const string DeletePendingOdsInstanceManagesDispatcherJobName = "DeletePendingOdsInstanceManagesDispatcherJob";
     public const string RefreshEducationOrganizationsJobName = "RefreshEducationOrganizationsJob";
     public const string RunIdKey = "RunId";
 }

Application/EdFi.Ods.AdminApi.Common/Infrastructure/Models/DbInstance.cs → Application/EdFi.Ods.AdminApi.Common/Infrastructure/Models/OdsInstanceManage.cs

@@ -8,7 +8,7 @@
 
 namespace EdFi.Ods.AdminApi.Common.Infrastructure.Models;
 
-public class DbInstance
+public class OdsInstanceManage
 {
     [Key]
     [DatabaseGenerated(DatabaseGeneratedOption.Identity)]

Application/EdFi.Ods.AdminApi.Common/Settings/AppSettings.cs

@@ -24,10 +24,10 @@ public class AppSettings
     public bool PreventDuplicateApplications { get; set; }
     public bool EnableApplicationResetEndpoint { get; set; }
     public int EdOrgsRefreshIntervalInMins { get; set; }
-    public int CreateDbInstancesSweepIntervalInMins { get; set; } = 5;
-    public int CreateDbInstancesMaxRetryAttempts { get; set; } = 3;
-    public int DeleteDbInstancesSweepIntervalInMins { get; set; } = 5;
-    public int DeleteDbInstancesMaxRetryAttempts { get; set; } = 3;
+    public int CreateOdsInstanceManagesSweepIntervalInMins { get; set; } = 5;
+    public int CreateOdsInstanceManagesMaxRetryAttempts { get; set; } = 3;
+    public int DeleteOdsInstanceManagesSweepIntervalInMins { get; set; } = 5;
+    public int DeleteOdsInstanceManagesMaxRetryAttempts { get; set; } = 3;
     public int MaxDegreeOfParallelism { get; set; } = 10;
     public string? AdminApiMode { get; set; }
 }

Application/EdFi.Ods.AdminApi.DBTests/Database/CommandTests/AddDbInstanceCommandTests.cs → Application/EdFi.Ods.AdminApi.DBTests/Database/CommandTests/AddOdsInstanceManageCommandTests.cs

@@ -14,74 +14,74 @@
 namespace EdFi.Ods.AdminApi.DBTests.Database.CommandTests;
 
 [TestFixture]
-public class AddDbInstanceCommandTests : AdminApiDbContextTestBase
+public class AddOdsInstanceManageCommandTests : AdminApiDbContextTestBase
 {
     [Test]
-    public void ShouldAddDbInstance()
+    public void ShouldAddOdsInstanceManage()
     {
-        var model = new Mock<IAddDbInstanceModel>();
+        var model = new Mock<IAddOdsInstanceManageModel>();
         model.Setup(x => x.Name).Returns("Test Instance");
         model.Setup(x => x.DatabaseTemplate).Returns("Minimal");
 
         var id = 0;
         Transaction(context =>
         {
-            var command = new AddDbInstanceCommand(context);
+            var command = new AddOdsInstanceManageCommand(context);
             id = command.Execute(model.Object).Id;
             id.ShouldBeGreaterThan(0);
         });
 
         Transaction(context =>
         {
-            var instance = context.DbInstances.Single(d => d.Id == id);
+            var instance = context.OdsInstanceManages.Single(d => d.Id == id);
             instance.Name.ShouldBe("Test Instance");
             instance.DatabaseTemplate.ShouldBe("Minimal");
-            instance.Status.ShouldBe(DbInstanceStatus.PendingCreate.ToString());
+            instance.Status.ShouldBe(OdsInstanceManageStatus.PendingCreate.ToString());
             instance.OdsInstanceId.ShouldBeNull();
             instance.OdsInstanceName.ShouldBeNull();
             instance.DatabaseName.ShouldBeNull();
         });
     }
 
     [Test]
-    public void ShouldAddDbInstanceWithSampleTemplate()
+    public void ShouldAddOdsInstanceManageWithSampleTemplate()
     {
-        var model = new Mock<IAddDbInstanceModel>();
+        var model = new Mock<IAddOdsInstanceManageModel>();
         model.Setup(x => x.Name).Returns("Sample Instance");
         model.Setup(x => x.DatabaseTemplate).Returns("Sample");
 
         var id = 0;
         Transaction(context =>
         {
-            var command = new AddDbInstanceCommand(context);
+            var command = new AddOdsInstanceManageCommand(context);
             id = command.Execute(model.Object).Id;
             id.ShouldBeGreaterThan(0);
         });
 
         Transaction(context =>
         {
-            var instance = context.DbInstances.Single(d => d.Id == id);
+            var instance = context.OdsInstanceManages.Single(d => d.Id == id);
             instance.DatabaseTemplate.ShouldBe("Sample");
         });
     }
 
     [Test]
     public void ShouldTrimNameAndDatabaseTemplate()
     {
-        var model = new Mock<IAddDbInstanceModel>();
+        var model = new Mock<IAddOdsInstanceManageModel>();
         model.Setup(x => x.Name).Returns("  Trimmed Instance  ");
         model.Setup(x => x.DatabaseTemplate).Returns("  Minimal  ");
 
         var id = 0;
         Transaction(context =>
         {
-            var command = new AddDbInstanceCommand(context);
+            var command = new AddOdsInstanceManageCommand(context);
             id = command.Execute(model.Object).Id;
         });
 
         Transaction(context =>
         {
-            var instance = context.DbInstances.Single(d => d.Id == id);
+            var instance = context.OdsInstanceManages.Single(d => d.Id == id);
             instance.Name.ShouldBe("Trimmed Instance");
             instance.DatabaseTemplate.ShouldBe("Minimal");
         });
@@ -90,21 +90,21 @@ public void ShouldTrimNameAndDatabaseTemplate()
     [Test]
     public void ShouldSetLastRefreshedAndLastModifiedDate()
     {
-        var model = new Mock<IAddDbInstanceModel>();
+        var model = new Mock<IAddOdsInstanceManageModel>();
         model.Setup(x => x.Name).Returns("Timestamp Instance");
         model.Setup(x => x.DatabaseTemplate).Returns("Minimal");
 
         var before = DateTime.UtcNow;
         var id = 0;
         Transaction(context =>
         {
-            var command = new AddDbInstanceCommand(context);
+            var command = new AddOdsInstanceManageCommand(context);
             id = command.Execute(model.Object).Id;
         });
 
         Transaction(context =>
         {
-            var instance = context.DbInstances.Single(d => d.Id == id);
+            var instance = context.OdsInstanceManages.Single(d => d.Id == id);
             instance.LastRefreshed.ShouldBeGreaterThanOrEqualTo(before);
             instance.LastModifiedDate.ShouldNotBeNull();
             instance.LastModifiedDate!.Value.ShouldBeGreaterThanOrEqualTo(before);

Application/EdFi.Ods.AdminApi.DBTests/Database/CommandTests/DeleteDbInstanceCommandTests.cs → Application/EdFi.Ods.AdminApi.DBTests/Database/CommandTests/DeleteOdsInstanceManageCommandTests.cs

@@ -14,55 +14,55 @@
 namespace EdFi.Ods.AdminApi.DBTests.Database.CommandTests;
 
 [TestFixture]
-public class DeleteDbInstanceCommandTests : AdminApiDbContextTestBase
+public class DeleteOdsInstanceManageCommandTests : AdminApiDbContextTestBase
 {
     [Test]
     public void ShouldSetStatusToPendingDelete()
     {
-        var instance = new DbInstance
+        var instance = new OdsInstanceManage
         {
             Name = "Delete Test Instance",
-            Status = DbInstanceStatus.Created.ToString(),
+            Status = OdsInstanceManageStatus.Created.ToString(),
             DatabaseTemplate = "Minimal",
             LastRefreshed = DateTime.UtcNow
         };
         Save(instance);
 
         Transaction(context =>
         {
-            var command = new DeleteDbInstanceCommand(context);
+            var command = new DeleteOdsInstanceManageCommand(context);
             command.Execute(instance.Id);
         });
 
         Transaction(context =>
         {
-            var updated = context.DbInstances.Single(d => d.Id == instance.Id);
-            updated.Status.ShouldBe(DbInstanceStatus.PendingDelete.ToString());
+            var updated = context.OdsInstanceManages.Single(d => d.Id == instance.Id);
+            updated.Status.ShouldBe(OdsInstanceManageStatus.PendingDelete.ToString());
         });
     }
 
     [Test]
     public void ShouldUpdateLastModifiedDate()
     {
         var before = DateTime.UtcNow;
-        var instance = new DbInstance
+        var instance = new OdsInstanceManage
         {
             Name = "Timestamp Test Instance",
-            Status = DbInstanceStatus.Created.ToString(),
+            Status = OdsInstanceManageStatus.Created.ToString(),
             DatabaseTemplate = "Minimal",
             LastRefreshed = DateTime.UtcNow
         };
         Save(instance);
 
         Transaction(context =>
         {
-            var command = new DeleteDbInstanceCommand(context);
+            var command = new DeleteOdsInstanceManageCommand(context);
             command.Execute(instance.Id);
         });
 
         Transaction(context =>
         {
-            var updated = context.DbInstances.Single(d => d.Id == instance.Id);
+            var updated = context.OdsInstanceManages.Single(d => d.Id == instance.Id);
             updated.LastModifiedDate.ShouldNotBeNull();
             updated.LastModifiedDate!.Value.ShouldBeGreaterThanOrEqualTo(before);
         });
@@ -71,24 +71,24 @@ public void ShouldUpdateLastModifiedDate()
     [Test]
     public void ShouldNotHardDeleteRecord()
     {
-        var instance = new DbInstance
+        var instance = new OdsInstanceManage
         {
             Name = "No Hard Delete Instance",
-            Status = DbInstanceStatus.Created.ToString(),
+            Status = OdsInstanceManageStatus.Created.ToString(),
             DatabaseTemplate = "Minimal",
             LastRefreshed = DateTime.UtcNow
         };
         Save(instance);
 
         Transaction(context =>
         {
-            var command = new DeleteDbInstanceCommand(context);
+            var command = new DeleteOdsInstanceManageCommand(context);
             command.Execute(instance.Id);
         });
 
         Transaction(context =>
         {
-            var stillExists = context.DbInstances.Any(d => d.Id == instance.Id);
+            var stillExists = context.OdsInstanceManages.Any(d => d.Id == instance.Id);
             stillExists.ShouldBeTrue();
         });
     }

Application/EdFi.Ods.AdminApi.DBTests/Database/QueryTests/GetDbInstanceByIdQueryTests.cs → Application/EdFi.Ods.AdminApi.DBTests/Database/QueryTests/GetOdsInstanceManageByIdQueryTests.cs

@@ -12,23 +12,23 @@
 namespace EdFi.Ods.AdminApi.DBTests.Database.QueryTests;
 
 [TestFixture]
-public class GetDbInstanceByIdQueryTests : AdminApiDbContextTestBase
+public class GetOdsInstanceManageByIdQueryTests : AdminApiDbContextTestBase
 {
     [Test]
     public void ShouldReturnNullForNonExistentId()
     {
         Transaction(context =>
         {
-            var query = new GetDbInstanceByIdQuery(context);
+            var query = new GetOdsInstanceManageByIdQuery(context);
             var result = query.Execute(0);
             result.ShouldBeNull();
         });
     }
 
     [Test]
-    public void ShouldGetDbInstanceById()
+    public void ShouldGetOdsInstanceManageById()
     {
-        var instance = new DbInstance
+        var instance = new OdsInstanceManage
         {
             Name = "Test Instance",
             Status = "Pending",
@@ -39,7 +39,7 @@ public void ShouldGetDbInstanceById()
 
         Transaction(context =>
         {
-            var query = new GetDbInstanceByIdQuery(context);
+            var query = new GetOdsInstanceManageByIdQuery(context);
             var result = query.Execute(instance.Id);
             result.ShouldNotBeNull();
             result!.Id.ShouldBe(instance.Id);
@@ -52,7 +52,7 @@ public void ShouldGetDbInstanceById()
     [Test]
     public void ShouldReturnNullWhenIdDoesNotMatch()
     {
-        var instance = new DbInstance
+        var instance = new OdsInstanceManage
         {
             Name = "Another Instance",
             Status = "Pending",
@@ -63,7 +63,7 @@ public void ShouldReturnNullWhenIdDoesNotMatch()
 
         Transaction(context =>
         {
-            var query = new GetDbInstanceByIdQuery(context);
+            var query = new GetOdsInstanceManageByIdQuery(context);
             var result = query.Execute(instance.Id + 9999);
             result.ShouldBeNull();
         });