Feature/1693 api v3 delete recreate

data-model/src/main/scala/za/co/absa/enceladus/model/test/factories/DatasetFactory.scala

@@ -16,11 +16,10 @@
 package za.co.absa.enceladus.model.test.factories
 
 import java.time.ZonedDateTime
-
 import za.co.absa.enceladus.model.Dataset
 import za.co.absa.enceladus.model.conformanceRule._
 import za.co.absa.enceladus.model.menas.MenasReference
-import za.co.absa.enceladus.model.versionedModel.VersionedSummary
+import za.co.absa.enceladus.model.versionedModel.VersionedSummaryV2
 
 object DatasetFactory extends EntityFactory[Dataset] {
 
@@ -127,8 +126,8 @@ object DatasetFactory extends EntityFactory[Dataset] {
     MenasReference(collection, name, version)
   }
 
-  def toSummary(dataset: Dataset): VersionedSummary = {
-    VersionedSummary(dataset.name, dataset.version)
+  def toSummaryV2(dataset: Dataset): VersionedSummaryV2 = {
+    VersionedSummaryV2(dataset.name, dataset.version)
   }
 
 }

data-model/src/main/scala/za/co/absa/enceladus/model/versionedModel/NamedVersion.scala

@@ -15,4 +15,7 @@
 
 package za.co.absa.enceladus.model.versionedModel
 
-case class NamedVersion(name: String, version: Int)
+/**
+ * V3 Wrapper for [[za.co.absa.enceladus.model.versionedModel.VersionedSummary]]
+ */
+case class NamedVersion(name: String, version: Int, disabled: Boolean)

data-model/src/main/scala/za/co/absa/enceladus/model/versionedModel/VersionedSummary.scala

@@ -15,8 +15,18 @@
 
 package za.co.absa.enceladus.model.versionedModel
 
-case class VersionedSummary(_id: String, latestVersion: Int) {
-  def toNamedVersion: NamedVersion = NamedVersion(_id, latestVersion)
+/**
+ * V2 Representation of `VersionedSummary` - V2 does not carry disabled information
+ */
+case class VersionedSummaryV2(_id: String, latestVersion: Int)
+
+case class VersionedSummary(_id: String, latestVersion: Int, disabledSet: Set[Boolean]) {
+  def toV2: VersionedSummaryV2 = VersionedSummaryV2(_id, latestVersion)
+
+  def toNamedVersion: NamedVersion = {
+    val disabled = disabledSet.contains(true) // legacy mixed state reported as disabled for V3 summary
+    NamedVersion(_id, latestVersion, disabled)
+  }
 }
 
 

rest-api/src/main/scala/za/co/absa/enceladus/rest_api/controllers/DatasetController.scala

@@ -30,7 +30,7 @@ import za.co.absa.enceladus.rest_api.services.DatasetService
 import za.co.absa.enceladus.utils.validation.ValidationLevel.ValidationLevel
 import za.co.absa.enceladus.model.conformanceRule.ConformanceRule
 import za.co.absa.enceladus.model.properties.PropertyDefinition
-import za.co.absa.enceladus.model.versionedModel.VersionedSummary
+import za.co.absa.enceladus.model.versionedModel.VersionedSummaryV2
 import za.co.absa.enceladus.model.{Dataset, Validation}
 import za.co.absa.enceladus.utils.validation.ValidationLevel.Constants.DefaultValidationLevelName
 
@@ -49,9 +49,9 @@ class DatasetController @Autowired()(datasetService: DatasetService)
   @GetMapping(Array("/latest"))
   @ResponseStatus(HttpStatus.OK)
   def getLatestVersions(@RequestParam(value = "missing_property", required = false)
-                        missingProperty: Optional[String]): CompletableFuture[Seq[VersionedSummary]] = {
+                        missingProperty: Optional[String]): CompletableFuture[Seq[VersionedSummaryV2]] = {
     datasetService.getLatestVersions(missingProperty.toScalaOption)
-      .map(datasets => datasets.map(dataset => VersionedSummary(dataset.name, dataset.version)))
+      .map(datasets => datasets.map(dataset => VersionedSummaryV2(dataset.name, dataset.version)))
   }
 
   @PostMapping(Array("/{datasetName}/rule/create"))

rest-api/src/main/scala/za/co/absa/enceladus/rest_api/controllers/VersionedModelController.scala

@@ -23,7 +23,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal
 import org.springframework.security.core.userdetails.UserDetails
 import org.springframework.web.bind.annotation._
 import za.co.absa.enceladus.model.{ExportableObject, UsedIn}
-import za.co.absa.enceladus.model.versionedModel._
+import za.co.absa.enceladus.model.versionedModel.{VersionedModel, VersionedSummaryV2}
 import za.co.absa.enceladus.rest_api.exceptions.NotFoundException
 import za.co.absa.enceladus.rest_api.services.VersionedModelService
 import za.co.absa.enceladus.model.menas.audit._
@@ -38,8 +38,9 @@ abstract class VersionedModelController[C <: VersionedModel with Product with Au
 
   @GetMapping(Array("/list", "/list/{searchQuery}"))
   @ResponseStatus(HttpStatus.OK)
-  def getList(@PathVariable searchQuery: Optional[String]): CompletableFuture[Seq[VersionedSummary]] = {
+  def getList(@PathVariable searchQuery: Optional[String]): CompletableFuture[Seq[VersionedSummaryV2]] = {
     versionedModelService.getLatestVersionsSummarySearch(searchQuery.toScalaOption)
+      .map(_.map(_.toV2))
   }
 
   @GetMapping(Array("/searchSuggestions"))

rest-api/src/main/scala/za/co/absa/enceladus/rest_api/repositories/VersionedMongoRepository.scala

@@ -27,7 +27,7 @@ import org.mongodb.scala.model.Updates._
 import org.mongodb.scala.model._
 import org.mongodb.scala.result.UpdateResult
 import za.co.absa.enceladus.model.menas._
-import za.co.absa.enceladus.model.versionedModel.{VersionedModel, VersionedSummary}
+import za.co.absa.enceladus.model.versionedModel.{VersionedModel, VersionedSummary, VersionedSummaryV2}
 
 import scala.concurrent.Future
 import scala.reflect.ClassTag
@@ -68,10 +68,13 @@ abstract class VersionedMongoRepository[C <: VersionedModel](mongoDb: MongoDatab
     }
     val pipeline = Seq(
       filter(Filters.and(searchFilter, getNotDisabledFilter)),
-      Aggregates.group("$name", Accumulators.max("latestVersion", "$version")),
+      Aggregates.group("$name",
+        Accumulators.max("latestVersion", "$version")
+      ),
       sort(Sorts.ascending("_id"))
     )
-    collection.aggregate[VersionedSummary](pipeline).toFuture()
+    collection.aggregate[VersionedSummaryV2](pipeline).toFuture()
+      .map(_.map(summaryV2 => VersionedSummary(summaryV2._id, summaryV2.latestVersion, Set(true)))) // because of the notDisabled filter
   }
 
   def getLatestVersions(missingProperty: Option[String]): Future[Seq[C]] = {
@@ -90,7 +93,10 @@ abstract class VersionedMongoRepository[C <: VersionedModel](mongoDb: MongoDatab
   def getLatestVersionSummary(name: String): Future[Option[VersionedSummary]] = {
     val pipeline = Seq(
       filter(getNameFilter(name)),
-      Aggregates.group("$name", Accumulators.max("latestVersion", "$version"))
+      Aggregates.group("$name",
+        Accumulators.max("latestVersion", "$version"),
+        Accumulators.addToSet("disabledSet", "$disabled")
+      )
     )
     collection.aggregate[VersionedSummary](pipeline).headOption()
   }

rest-api/src/test/scala/za/co/absa/enceladus/rest_api/integration/controllers/v3/DatasetControllerV3IntegrationSuite.scala

@@ -138,7 +138,29 @@ class DatasetControllerV3IntegrationSuite extends BaseRestApiTestV3 with BeforeA
 
         val response = sendGet[NamedVersion](s"$apiUrl/datasetA")
         assertOk(response)
-        assert(response.getBody == NamedVersion("datasetA", 2))
+        assert(response.getBody == NamedVersion("datasetA", 2, disabled = false))
+      }
+
+      "a Dataset with the given name exists - all disabled" in {
+        schemaFixture.add(SchemaFactory.getDummySchema("dummySchema"))
+        val datasetV1 = DatasetFactory.getDummyDataset(name = "datasetA", version = 1, disabled = true)
+        val datasetV2 = DatasetFactory.getDummyDataset(name = "datasetA", version = 2, disabled = true)
+        datasetFixture.add(datasetV1, datasetV2)
+
+        val response = sendGet[NamedVersion](s"$apiUrl/datasetA")
+        assertOk(response)
+        assert(response.getBody == NamedVersion("datasetA", 2, disabled = true))
+      }
+
+      "a Dataset with with mixed disabled states" in {
+        schemaFixture.add(SchemaFactory.getDummySchema("dummySchema"))
+        val datasetV1 = DatasetFactory.getDummyDataset(name = "datasetA", version = 1)
+        val datasetV2 = DatasetFactory.getDummyDataset(name = "datasetA", version = 2, disabled = true)
+        datasetFixture.add(datasetV1, datasetV2)
+
+        val response = sendGet[NamedVersion](s"$apiUrl/datasetA")
+        assertOk(response)
+        assert(response.getBody == NamedVersion("datasetA", 2, disabled = true)) // mixed state -> disabled
       }
     }
 

rest-api/src/test/scala/za/co/absa/enceladus/rest_api/integration/controllers/v3/PropertyDefinitionControllerV3IntegrationSuite.scala

@@ -144,7 +144,7 @@ class PropertyDefinitionControllerV3IntegrationSuite extends BaseRestApiTestV3 w
 
         val response = sendGet[NamedVersion](s"$apiUrl/pdA")
         assertOk(response)
-        assert(response.getBody == NamedVersion("pdA", 2))
+        assert(response.getBody == NamedVersion("pdA", 2, disabled = false))
       }
     }
 

rest-api/src/test/scala/za/co/absa/enceladus/rest_api/integration/repositories/DatasetRepositoryIntegrationSuite.scala

@@ -500,7 +500,7 @@ class DatasetRepositoryIntegrationSuite extends BaseRepositoryTest with Matchers
         datasetFixture.add(dataset2, dataset3, dataset4, dataset5)
         val actual = await(datasetMongoRepository.getLatestVersionsSummarySearch(Some("dataset2")))
 
-        val expected = Seq(dataset3).map(DatasetFactory.toSummary)
+        val expected = Seq(dataset3).map(DatasetFactory.toSummaryV2)
         assert(actual == expected)
       }
       "search query is a partial match" in {
@@ -512,7 +512,7 @@ class DatasetRepositoryIntegrationSuite extends BaseRepositoryTest with Matchers
         datasetFixture.add(dataset2, dataset3, dataset4, dataset5)
         val actual = await(datasetMongoRepository.getLatestVersionsSummarySearch(Some("tas")))
 
-        val expected = Seq(dataset3, dataset4).map(DatasetFactory.toSummary)
+        val expected = Seq(dataset3, dataset4).map(DatasetFactory.toSummaryV2)
         assert(actual == expected)
       }
 
@@ -548,7 +548,7 @@ class DatasetRepositoryIntegrationSuite extends BaseRepositoryTest with Matchers
         datasetFixture.add(dataset1ver1, dataset1ver2, dataset2ver1, abc1)
         val actual = await(datasetMongoRepository.getLatestVersionsSummarySearch(Some("")))
 
-        val expected = Seq(abc1, dataset1ver2, dataset2ver1).map(DatasetFactory.toSummary)
+        val expected = Seq(abc1, dataset1ver2, dataset2ver1).map(DatasetFactory.toSummaryV2)
         assert(actual == expected)
       }
     }
@@ -565,7 +565,7 @@ class DatasetRepositoryIntegrationSuite extends BaseRepositoryTest with Matchers
 
       val actual = await(datasetMongoRepository.getLatestVersionsSummarySearch(None))
 
-      val expected = Seq(dataset1ver2, dataset2ver2).map(DatasetFactory.toSummary)
+      val expected = Seq(dataset1ver2, dataset2ver2).map(DatasetFactory.toSummaryV2)
       assert(actual == expected)
     }
   }
@@ -579,11 +579,11 @@ class DatasetRepositoryIntegrationSuite extends BaseRepositoryTest with Matchers
     }
     "returns even the disabled dataset" when {
       "only disabled dataset exists" in {
-        val dataset1 = DatasetFactory.getDummyDataset(name = "datasetA", disabled = true)
+        val dataset1 = DatasetFactory.getDummyDataset(name = "datasetA", disabled = false)
         val dataset2 = DatasetFactory.getDummyDataset(name = "datasetA", disabled = true, version = 2)
         datasetFixture.add(dataset1, dataset2)
         val actual = await(datasetMongoRepository.getLatestVersionSummary("datasetA"))
-        actual shouldBe Some(VersionedSummary("datasetA", 2)) // warning: currently, this method reports the disabled, too
+        actual shouldBe Some(VersionedSummary("datasetA", 2, Set(true, false)))
       }
     }
 
@@ -595,7 +595,7 @@ class DatasetRepositoryIntegrationSuite extends BaseRepositoryTest with Matchers
         datasetFixture.add(dataset1, dataset2, dataset3)
 
         val actual = await(datasetMongoRepository.getLatestVersionSummary("datasetA"))
-        actual shouldBe Some(VersionedSummary("datasetA", 3))
+        actual shouldBe Some(VersionedSummary("datasetA", 3, Set(false)))
       }
     }
   }