#83: Serde for DTO objects (#93)

#83: Serde for DTO objects

agent/src/main/scala/za/co/absa/atum/agent/AtumContext.scala

@@ -17,11 +17,11 @@
 package za.co.absa.atum.agent
 
 import org.apache.spark.sql.DataFrame
+import za.co.absa.atum.agent.AtumContext.AtumPartitions
 import za.co.absa.atum.agent.model.{Checkpoint, Measure, Measurement, MeasuresMapper}
-import AtumContext.AtumPartitions
 import za.co.absa.atum.model.dto.{AtumContextDTO, PartitionDTO}
 
-import java.time.ZonedDateTime
+import java.time.OffsetDateTime
 import scala.collection.immutable.ListMap
 
 /**
@@ -51,13 +51,13 @@ class AtumContext private[agent] (
                                       author: String,
                                       measurements: Seq[Measurement]
                                     ): Checkpoint = {
-    val zonedDateTimeNow = ZonedDateTime.now()
+    val offsetDateTimeNow = OffsetDateTime.now()
     Checkpoint(
       name = checkpointName,
       author = author,
       atumPartitions = this.atumPartitions,
-      processStartTime = zonedDateTimeNow,
-      processEndTime = Some(zonedDateTimeNow),
+      processStartTime = offsetDateTimeNow,
+      processEndTime = Some(offsetDateTimeNow),
       measurements = measurements
     )
   }

agent/src/main/scala/za/co/absa/atum/agent/model/Checkpoint.scala

@@ -19,16 +19,16 @@ package za.co.absa.atum.agent.model
 import za.co.absa.atum.agent.AtumContext.AtumPartitions
 import za.co.absa.atum.model.dto.CheckpointDTO
 
-import java.time.ZonedDateTime
+import java.time.OffsetDateTime
 import java.util.UUID
 
 case class Checkpoint(
                        name: String,
                        author: String,
                        measuredByAtumAgent: Boolean = false,
                        atumPartitions: AtumPartitions,
-                       processStartTime: ZonedDateTime,
-                       processEndTime: Option[ZonedDateTime],
+                       processStartTime: OffsetDateTime,
+                       processEndTime: Option[OffsetDateTime],
                        measurements: Seq[Measurement]
                         ) {
   private [agent] def toCheckpointDTO: CheckpointDTO = {

build.sbt

@@ -110,7 +110,7 @@ lazy val model = (projectMatrix in file("model"))
   .settings(
     commonSettings ++ Seq(
       name         := "atum-model",
-      libraryDependencies ++= Dependencies.modelDependencies,
+      libraryDependencies ++= Dependencies.modelDependencies(scalaVersion.value),
       (Compile / compile) := ((Compile / compile) dependsOn printSparkScalaVersion).value,
     ): _*
   )

model/src/main/scala/za/co/absa/atum/model/dto/CheckpointDTO.scala

@@ -16,16 +16,16 @@
 
 package za.co.absa.atum.model.dto
 
-import java.time.ZonedDateTime
+import java.time.OffsetDateTime
 import java.util.UUID
 
 case class CheckpointDTO(
-  id: UUID,
-  name: String,
-  author: String,
-  measuredByAtumAgent: Boolean = false,
-  partitioning: Seq[PartitionDTO],
-  processStartTime: ZonedDateTime,
-  processEndTime: Option[ZonedDateTime],
-  measurements: Seq[MeasurementDTO]
+                          id: UUID,
+                          name: String,
+                          author: String,
+                          measuredByAtumAgent: Boolean = false,
+                          partitioning: Seq[PartitionDTO],
+                          processStartTime: OffsetDateTime,
+                          processEndTime: Option[OffsetDateTime],
+                          measurements: Seq[MeasurementDTO]
 )

model/src/main/scala/za/co/absa/atum/model/utils/OffsetDateTimeSerializer.scala

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2021 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.atum.model.utils
+
+import org.json4s.JsonAST.JString
+import org.json4s.{CustomSerializer, JNull}
+
+import java.time.OffsetDateTime
+
+case object OffsetDateTimeSerializer extends CustomSerializer[OffsetDateTime](_ => (
+  {
+    case JString(s) => OffsetDateTime.parse(s, SerializationUtils.timestampFormat)
+    case JNull => null
+  },
+  {
+    case d: OffsetDateTime => JString(SerializationUtils.timestampFormat.format(d))
+  }
+))

model/src/main/scala/za/co/absa/atum/model/utils/SerializationUtils.scala

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2021 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.atum.model.utils
+
+import org.json4s.jackson.Serialization
+import org.json4s.jackson.Serialization.{write, writePretty}
+import org.json4s.{Formats, NoTypeHints, ext}
+import za.co.absa.atum.model.dto.MeasureResultDTO.ResultValueType
+
+import java.time.format.DateTimeFormatter
+
+object SerializationUtils {
+
+  implicit private val formatsJson: Formats =
+    Serialization.formats(NoTypeHints).withBigDecimal + new ext.EnumNameSerializer(ResultValueType) +
+      ext.UUIDSerializer + OffsetDateTimeSerializer
+
+  val timestampFormat: DateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSSSSSX")
+
+  /**
+   * The method returns arbitrary object as a Json string.
+   *
+   * @return A string representing the object in Json format
+   */
+  def asJson[T <: AnyRef](obj: T): String = {
+    write[T](obj)
+  }
+
+  /**
+   * The method returns arbitrary object as a pretty Json string.
+   *
+   * @return A string representing the object in Json format
+   */
+  def asJsonPretty[T <: AnyRef](obj: T): String = {
+    writePretty[T](obj)
+  }
+
+  /**
+   * The method returns arbitrary object parsed from Json string.
+   *
+   * @return An object deserialized from the Json string
+   */
+  def fromJson[T <: AnyRef](jsonStr: String)(implicit m: Manifest[T]): T = {
+    Serialization.read[T](jsonStr)
+  }
+
+}