Feature/1693 api v3 delete recreate

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

@@ -15,15 +15,42 @@
 
 package za.co.absa.enceladus.model
 
+import com.fasterxml.jackson.annotation.JsonIgnore
 import za.co.absa.enceladus.model.menas.MenasReference
 
-case class UsedIn(
-  datasets: Option[Seq[MenasReference]] = None,
-  mappingTables: Option[Seq[MenasReference]] = None
-) {
+case class UsedIn(datasets: Option[Seq[MenasReference]] = None,
+                  mappingTables: Option[Seq[MenasReference]] = None) {
 
-  def nonEmpty: Boolean = {
-    datasets.exists(_.nonEmpty) || mappingTables.exists(_.nonEmpty)
+  /**
+   * Should any of the original UsedIn equal to Some(Seq.empty), it will be None after normalization
+   */
+  @JsonIgnore
+  lazy val normalized: UsedIn = {
+    def normalizeOne(field: Option[Seq[MenasReference]]) = field match {
+      case None => None
+      case Some(x) if x.isEmpty => None
+      case otherNonEmpty => otherNonEmpty
+    }
+
+    val normalizedDs = normalizeOne(datasets)
+    val normalizedMt = normalizeOne(mappingTables)
+
+    (normalizedDs, normalizedMt) match {
+      case (`datasets`, `mappingTables`) => this // no normalization needed
+      case _ => UsedIn(normalizedDs, normalizedMt)
+    }
+  }
+
+  val isEmpty: Boolean = {
+    normalized.datasets == None && normalized.mappingTables == None
   }
 
+  val nonEmpty: Boolean = !isEmpty
+}
+
+object UsedIn {
+  /**
+   * Normalized
+   */
+  val empty = UsedIn(None, None)
 }

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

@@ -15,4 +15,4 @@
 
 package za.co.absa.enceladus.model.versionedModel
 
-case class NamedLatestVersion(name: String, version: Int)
+case class NamedVersion(name: String, version: Int)

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

@@ -16,7 +16,7 @@
 package za.co.absa.enceladus.model.versionedModel
 
 case class VersionedSummary(_id: String, latestVersion: Int) {
-  def toNamedLatestVersion: NamedLatestVersion = NamedLatestVersion(_id, latestVersion)
+  def toNamedVersion: NamedVersion = NamedVersion(_id, latestVersion)
 }
 
 

data-model/src/test/scala/za/co/absa/enceladus/model/UsedInTest.scala

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2018 ABSA Group Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package za.co.absa.enceladus.model
+
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+import za.co.absa.enceladus.model.menas.MenasReference
+
+class UsedInTest extends AnyFlatSpec with Matchers {
+
+  private val exampleRef = MenasReference(Some("collection1"), "entity1", 1)
+
+  "UsedIn" should "correctly evaluate .nonEmpty" in {
+    UsedIn(Some(Seq(exampleRef)), Some(Seq(exampleRef))).nonEmpty shouldBe true
+    UsedIn(Some(Seq(exampleRef)), Some(Seq.empty)).nonEmpty shouldBe true
+    UsedIn(Some(Seq(exampleRef)), None).nonEmpty shouldBe true
+
+    UsedIn(Some(Seq.empty), Some(Seq(exampleRef))).nonEmpty shouldBe true
+    UsedIn(None, Some(Seq(exampleRef))).nonEmpty shouldBe true
+
+    UsedIn(Some(Seq.empty), Some(Seq.empty)).nonEmpty shouldBe false
+    UsedIn(None, Some(Seq.empty)).nonEmpty shouldBe false
+    UsedIn(Some(Seq.empty), None).nonEmpty shouldBe false
+    UsedIn(None, None).nonEmpty shouldBe false
+  }
+
+  it should "correctly evaluate .empty" in {
+    UsedIn(Some(Seq(exampleRef)), Some(Seq(exampleRef))).isEmpty shouldBe false
+    UsedIn(Some(Seq(exampleRef)), Some(Seq.empty)).isEmpty shouldBe false
+    UsedIn(Some(Seq(exampleRef)), None).isEmpty shouldBe false
+
+    UsedIn(Some(Seq.empty), Some(Seq(exampleRef))).isEmpty shouldBe false
+    UsedIn(None, Some(Seq(exampleRef))).isEmpty shouldBe false
+
+    UsedIn(Some(Seq.empty), Some(Seq.empty)).isEmpty shouldBe true
+    UsedIn(None, Some(Seq.empty)).isEmpty shouldBe true
+    UsedIn(Some(Seq.empty), None).isEmpty shouldBe true
+    UsedIn(None, None).isEmpty shouldBe true
+  }
+
+  it should "normalize" in {
+    UsedIn(Some(Seq(exampleRef)), Some(Seq(exampleRef))).normalized shouldBe UsedIn(Some(Seq(exampleRef)), Some(Seq(exampleRef)))
+
+    UsedIn(Some(Seq(exampleRef)), Some(Seq.empty)).normalized shouldBe UsedIn(Some(Seq(exampleRef)), None)
+    UsedIn(Some(Seq(exampleRef)), None).normalized shouldBe UsedIn(Some(Seq(exampleRef)), None)
+
+    UsedIn(Some(Seq.empty), Some(Seq(exampleRef))).normalized shouldBe UsedIn(None, Some(Seq(exampleRef)))
+    UsedIn(None, Some(Seq(exampleRef))).normalized shouldBe UsedIn(None, Some(Seq(exampleRef)))
+
+    UsedIn(Some(Seq.empty), Some(Seq.empty)).normalized shouldBe UsedIn(None, None)
+    UsedIn(None, None).normalized shouldBe UsedIn(None, None)
+
+
+
+
+  }
+
+
+
+}

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

@@ -26,7 +26,6 @@ import org.springframework.security.access.prepost.PreAuthorize
 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.rest_api.exceptions.EndpointDisabled
 import za.co.absa.enceladus.rest_api.services.PropertyDefinitionService
 import za.co.absa.enceladus.model.ExportableObject
 import za.co.absa.enceladus.model.properties.PropertyDefinition
@@ -39,15 +38,15 @@ import scala.concurrent.ExecutionContext.Implicits.global
  */
 @RestController
 @RequestMapping(path = Array("/api/properties/datasets"), produces = Array("application/json"))
-class PropertyDefinitionController @Autowired()(propertyDefService: PropertyDefinitionService)
-  extends VersionedModelController(propertyDefService) {
+class PropertyDefinitionController @Autowired()(propertyDefinitionService: PropertyDefinitionService)
+  extends VersionedModelController(propertyDefinitionService) {
 
   import za.co.absa.enceladus.rest_api.utils.implicits._
 
   @GetMapping(Array(""))
   def getAllDatasetProperties(): CompletableFuture[Seq[PropertyDefinition]] = {
     logger.info("retrieving all dataset properties in full")
-    propertyDefService.getLatestVersions()
+    propertyDefinitionService.getLatestVersions()
   }
 
   @PostMapping(Array(""))
@@ -63,8 +62,6 @@ class PropertyDefinitionController @Autowired()(propertyDefService: PropertyDefi
       val location: URI = new URI(s"/api/properties/datasets/${entity.name}/${entity.version}")
       ResponseEntity.created(location).body(entity)
     }
-
-    // TODO: Location header would make sense for the underlying VersionedModelController.create, too. Issue #1611
   }
 
   @GetMapping(Array("/{propertyName}"))

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

@@ -62,11 +62,16 @@ class RestExceptionHandler {
     ResponseEntity.notFound().build[Any]()
   }
 
-  @ExceptionHandler(value = Array(classOf[EndpointDisabled]))
-  def handleEndpointDisabled(exception: EndpointDisabled): ResponseEntity[Any] = {
+  @ExceptionHandler(value = Array(classOf[EndpointDisabledException]))
+  def handleEndpointDisabled(exception: EndpointDisabledException): ResponseEntity[Any] = {
     ResponseEntity.status(HttpStatus.I_AM_A_TEAPOT).build[Any]() // Could change for LOCKED but I like this more
   }
 
+  @ExceptionHandler(value = Array(classOf[EntityDisabledException]))
+  def handleEntityDisabled(exception: EntityDisabledException): ResponseEntity[EntityDisabledException] = {
+    ResponseEntity.status(HttpStatus.BAD_REQUEST).body(exception)
+  }
+
   @ExceptionHandler(value = Array(classOf[SchemaParsingException]))
   def handleBadRequestException(exception: SchemaParsingException): ResponseEntity[Any] = {
     val response = RestResponse(exception.message, Option(SchemaParsingError.fromException(exception)))

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

@@ -15,7 +15,6 @@
 
 package za.co.absa.enceladus.rest_api.controllers.v3
 
-import com.mongodb.client.result.UpdateResult
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.http.{HttpStatus, ResponseEntity}
 import org.springframework.security.access.prepost.PreAuthorize
@@ -24,16 +23,16 @@ import org.springframework.security.core.userdetails.UserDetails
 import org.springframework.web.bind.annotation._
 import za.co.absa.enceladus.model.properties.PropertyDefinition
 import za.co.absa.enceladus.model.{ExportableObject, Validation}
-import za.co.absa.enceladus.rest_api.services.PropertyDefinitionService
+import za.co.absa.enceladus.rest_api.models.rest.DisabledPayload
+import za.co.absa.enceladus.rest_api.services.v3.PropertyDefinitionServiceV3
 
-import java.util.Optional
 import java.util.concurrent.CompletableFuture
 import javax.servlet.http.HttpServletRequest
 
 @RestController
 @RequestMapping(path = Array("/api-v3/property-definitions/datasets"), produces = Array("application/json"))
-class PropertyDefinitionControllerV3 @Autowired()(propertyDefService: PropertyDefinitionService)
-  extends VersionedModelControllerV3(propertyDefService) {
+class PropertyDefinitionControllerV3 @Autowired()(propertyDefinitionService: PropertyDefinitionServiceV3)
+  extends VersionedModelControllerV3(propertyDefinitionService) {
 
   // super-class implementation is sufficient, but the following changing endpoints need admin-auth
 
@@ -69,16 +68,11 @@ class PropertyDefinitionControllerV3 @Autowired()(propertyDefService: PropertyDe
     super.edit(user, name, version, item, request)
   }
 
-  @DeleteMapping(Array("/{name}", "/{name}/{version}"))
+  @DeleteMapping(Array("/{name}"))
   @ResponseStatus(HttpStatus.OK)
   @PreAuthorize("@authConstants.hasAdminRole(authentication)")
-  override def disable(@PathVariable name: String,
-              @PathVariable version: Optional[String]): CompletableFuture[UpdateResult] = {
-
-    super.disable(name, version)
+  override def disable(@PathVariable name: String): CompletableFuture[DisabledPayload] = {
+    super.disable(name)
   }
-
-  // todo add "enable" with preAuth check when available, too
-
 }
 

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

@@ -26,6 +26,8 @@ import za.co.absa.enceladus.model.versionedModel._
 import za.co.absa.enceladus.model.{ExportableObject, UsedIn, Validation}
 import za.co.absa.enceladus.rest_api.controllers.BaseController
 import za.co.absa.enceladus.rest_api.controllers.v3.VersionedModelControllerV3.LatestVersionKey
+import za.co.absa.enceladus.rest_api.exceptions.{EntityDisabledException, NotFoundException, ValidationException}
+import za.co.absa.enceladus.rest_api.models.rest.DisabledPayload
 import za.co.absa.enceladus.rest_api.services.VersionedModelService
 
 import java.net.URI
@@ -36,7 +38,7 @@ import scala.concurrent.Future
 import scala.util.{Failure, Success, Try}
 
 object VersionedModelControllerV3 {
-  val LatestVersionKey = "latest"
+  final val LatestVersionKey = "latest"
 }
 
 abstract class VersionedModelControllerV3[C <: VersionedModel with Product
@@ -49,16 +51,16 @@ abstract class VersionedModelControllerV3[C <: VersionedModel with Product
   // todo maybe offset/limit?
   @GetMapping(Array(""))
   @ResponseStatus(HttpStatus.OK)
-  def getList(@RequestParam searchQuery: Optional[String]): CompletableFuture[Seq[NamedLatestVersion]] = {
+  def getList(@RequestParam searchQuery: Optional[String]): CompletableFuture[Seq[NamedVersion]] = {
     versionedModelService.getLatestVersionsSummarySearch(searchQuery.toScalaOption)
-      .map(_.map(_.toNamedLatestVersion))
+      .map(_.map(_.toNamedVersion))
   }
 
   @GetMapping(Array("/{name}"))
   @ResponseStatus(HttpStatus.OK)
-  def getVersionSummaryForEntity(@PathVariable name: String): CompletableFuture[NamedLatestVersion] = {
+  def getVersionSummaryForEntity(@PathVariable name: String): CompletableFuture[NamedVersion] = {
     versionedModelService.getLatestVersionSummary(name) map {
-      case Some(entity) => entity.toNamedLatestVersion
+      case Some(entity) => entity.toNamedVersion
       case None => throw notFound()
     }
   }
@@ -87,6 +89,12 @@ abstract class VersionedModelControllerV3[C <: VersionedModel with Product
     forVersionExpression(name, version) { case (name, versionInt) => versionedModelService.getUsedIn(name, Some(versionInt)) }
   }
 
+  @GetMapping(Array("/{name}/used-in"))
+  @ResponseStatus(HttpStatus.OK)
+  def usedIn(@PathVariable name: String): CompletableFuture[UsedIn] = {
+    versionedModelService.getUsedIn(name, None)
+  }
+
   @GetMapping(Array("/{name}/{version}/export"))
   @ResponseStatus(HttpStatus.OK)
   def exportSingleEntity(@PathVariable name: String, @PathVariable version: String): CompletableFuture[String] = {
@@ -125,7 +133,7 @@ abstract class VersionedModelControllerV3[C <: VersionedModel with Product
              request: HttpServletRequest): CompletableFuture[ResponseEntity[Validation]] = {
     versionedModelService.isDisabled(item.name).flatMap { isDisabled =>
       if (isDisabled) {
-        versionedModelService.recreate(principal.getUsername, item)
+        Future.failed(EntityDisabledException(s"Entity ${item.name} is disabled. Enable it first (PUT) to push new versions (PUT)."))
       } else {
         versionedModelService.create(item, principal.getUsername)
       }
@@ -148,25 +156,42 @@ abstract class VersionedModelControllerV3[C <: VersionedModel with Product
     } else if (version != item.version) {
       Future.failed(new IllegalArgumentException(s"URL and payload version mismatch: ${version} != ${item.version}"))
     } else {
-      versionedModelService.update(user.getUsername, item).map {
-        case Some((updatedEntity, validation)) =>
-          createdWithNameVersionLocationBuilder(updatedEntity.name, updatedEntity.version, request, stripLastSegments = 2).body(validation)
-        case None => throw notFound()
+      versionedModelService.isDisabled(item.name).flatMap { isDisabled =>
+        if (isDisabled) {
+          throw EntityDisabledException(s"Entity ${item.name} is disabled. Enable it first to create new versions.")
+        } else {
+          versionedModelService.update(user.getUsername, item).map {
+            case Some((updatedEntity, validation)) =>
+              createdWithNameVersionLocationBuilder(updatedEntity.name, updatedEntity.version, request, stripLastSegments = 2).body(validation)
+            case None => throw notFound()
+          }
+        }
       }
     }
   }
 
-  @DeleteMapping(Array("/{name}", "/{name}/{version}"))
+  @PutMapping(Array("/{name}"))
   @ResponseStatus(HttpStatus.OK)
-  def disable(@PathVariable name: String,
-              @PathVariable version: Optional[String]): CompletableFuture[UpdateResult] = {
-    val v = if (version.isPresent) {
-      // For some reason Spring reads the Optional[Int] param as a Optional[String] and then throws ClassCastException
-      Some(version.get.toInt)
-    } else {
-      None
+  def enable(@PathVariable name: String): CompletableFuture[DisabledPayload] = {
+    versionedModelService.enableEntity(name).map { updateResult => // always enabling all version of the entity
+      if (updateResult.getMatchedCount > 0) {
+        DisabledPayload(disabled = false)
+      } else {
+        throw NotFoundException(s"No versions for entity $name found to be enabled.")
+      }
+    }
+  }
+
+  @DeleteMapping(Array("/{name}"))
+  @ResponseStatus(HttpStatus.OK)
+  def disable(@PathVariable name: String): CompletableFuture[DisabledPayload] = {
+    versionedModelService.disableVersion(name, None).map { updateResult => // always disabling all version of the entity
+      if (updateResult.getMatchedCount > 0) {
+        DisabledPayload(disabled = true)
+      } else {
+        throw NotFoundException(s"No versions for entity $name found to be disabled.")
+      }
     }
-    versionedModelService.disableVersion(name, v)
   }
 
   /**

rest-api/src/main/scala/za/co/absa/enceladus/rest_api/exceptions/EndpointDisabledException.scala

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018 ABSA Group Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package za.co.absa.enceladus.rest_api.exceptions
+
+// todo, there is no usage, remove?
+case class EndpointDisabledException(message:String = "", cause: Throwable = None.orNull) extends Exception(message, cause)
+

rest-api/src/main/scala/za/co/absa/enceladus/rest_api/exceptions/EndpointDisabled.scala → rest-api/src/main/scala/za/co/absa/enceladus/rest_api/exceptions/EntityDisabledException.scala

@@ -15,5 +15,5 @@
 
 package za.co.absa.enceladus.rest_api.exceptions
 
-case class EndpointDisabled(message:String = "", cause: Throwable = None.orNull) extends Exception(message, cause)
+case class EntityDisabledException(message:String = "", cause: Throwable = None.orNull) extends Exception(message, cause)