Custom (Unknown) Measure (#165)

UknownMeasure

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

@@ -103,7 +103,7 @@ class AtumContext private[agent] (
    * @param measurements   the measurements to be included in the checkpoint
    * @return the AtumContext after the checkpoint has been created
    */
-  def createCheckpointOnProvidedData(checkpointName: String, measurements: Map[AtumMeasure, MeasureResult]): AtumContext = {
+  def createCheckpointOnProvidedData(checkpointName: String, measurements: Map[Measure, MeasureResult]): AtumContext = {
     val dateTimeNow = ZonedDateTime.now()
 
     val checkpointDTO = CheckpointDTO(

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

@@ -29,12 +29,14 @@ import za.co.absa.atum.model.dto.MeasureResultDTO.ResultValueType
 sealed trait Measure {
   val measureName: String
   def measuredColumns: Seq[String]
-}
-
-trait AtumMeasure extends Measure with MeasurementProcessor {
   val resultValueType: ResultValueType
 }
 
+trait AtumMeasure extends Measure with MeasurementProcessor
+
+final case class UnknownMeasure(measureName: String, measuredColumns: Seq[String], resultValueType: ResultValueType)
+  extends Measure
+
 object AtumMeasure {
 
   val supportedMeasureNames: Seq[String] = Seq(

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

@@ -24,7 +24,7 @@ import za.co.absa.atum.model.dto.{MeasureDTO, MeasureResultDTO, MeasurementDTO}
  */
 private [agent] object MeasurementBuilder {
 
-  private def validateMeasureAndResultTypeCompatibility(measure: AtumMeasure, result: MeasureResult): Unit = {
+  private def validateMeasureAndResultTypeCompatibility(measure: Measure, result: MeasureResult): Unit = {
     val requiredType = measure.resultValueType
     val actualType = result.resultValueType
 
@@ -35,7 +35,7 @@ private [agent] object MeasurementBuilder {
       )
   }
 
-  def buildMeasurementDTO(measure: AtumMeasure, measureResult: MeasureResult): MeasurementDTO = {
+  def buildMeasurementDTO(measure: Measure, measureResult: MeasureResult): MeasurementDTO = {
     validateMeasureAndResultTypeCompatibility(measure, measureResult)
 
     val measureDTO = MeasureDTO(measure.measureName, measure.measuredColumns)
@@ -46,8 +46,8 @@ private [agent] object MeasurementBuilder {
     MeasurementDTO(measureDTO, measureResultDTO)
   }
 
-  def buildAndValidateMeasurementsDTO(measurements: Map[AtumMeasure, MeasureResult]): Set[MeasurementDTO] = {
-    measurements.toSet[(AtumMeasure, MeasureResult)].map { case (measure: AtumMeasure, measureResult: MeasureResult) =>
+  def buildAndValidateMeasurementsDTO(measurements: Map[Measure, MeasureResult]): Set[MeasurementDTO] = {
+    measurements.toSet[(Measure, MeasureResult)].map { case (measure: Measure, measureResult: MeasureResult) =>
         validateMeasureAndResultTypeCompatibility(measure, measureResult)
         buildMeasurementDTO(measure, measureResult)
     }

agent/src/test/scala/za/co/absa/atum/agent/AtumContextTest.scala

@@ -23,8 +23,8 @@ import org.mockito.Mockito.{mock, times, verify, when}
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
 import za.co.absa.atum.agent.AtumContext.AtumPartitions
-import za.co.absa.atum.agent.model.{AtumMeasure, MeasureResult, MeasurementBuilder}
-import za.co.absa.atum.agent.model.AtumMeasure._
+import za.co.absa.atum.agent.model.AtumMeasure.{RecordCount, SumOfValuesOfColumn}
+import za.co.absa.atum.agent.model.{Measure, MeasureResult, MeasurementBuilder, UnknownMeasure}
 import za.co.absa.atum.model.dto.CheckpointDTO
 import za.co.absa.atum.model.dto.MeasureResultDTO.ResultValueType
 
@@ -112,9 +112,10 @@ class AtumContextTest extends AnyFlatSpec with Matchers {
     val atumPartitions = AtumPartitions("key" -> "value")
     val atumContext: AtumContext = new AtumContext(atumPartitions, mockAgent)
 
-    val measurements: Map[AtumMeasure, MeasureResult] = Map(
+    val measurements: Map[Measure, MeasureResult] = Map(
       RecordCount("col")          -> MeasureResult(1L),
-      SumOfValuesOfColumn("col")  -> MeasureResult(BigDecimal(1))
+      SumOfValuesOfColumn("col")  -> MeasureResult(BigDecimal(1)),
+      UnknownMeasure("customMeasureName", Seq("col"), ResultValueType.BigDecimal) -> MeasureResult(BigDecimal(1))
     )
 
     atumContext.createCheckpointOnProvidedData(

agent/src/test/scala/za/co/absa/atum/agent/model/MeasurementBuilderTest.scala

@@ -87,10 +87,11 @@ class MeasurementBuilderTest extends AnyFlatSpec {
   }
 
   "buildAndValidateMeasurementsDTO" should "build Seq[MeasurementDTO] for multiple measures, all unique" in {
-    val measurements: Map[AtumMeasure, MeasureResult] = Map(
+    val measurements: Map[Measure, MeasureResult] = Map(
       DistinctRecordCount(Seq("col")) -> MeasureResult("1", ResultValueType.Long),
       SumOfValuesOfColumn("col1")     -> MeasureResult(BigDecimal(1.2)),
-      SumOfValuesOfColumn("col2")     -> MeasureResult(BigDecimal(1.3))
+      SumOfValuesOfColumn("col2")     -> MeasureResult(BigDecimal(1.3)),
+      UnknownMeasure("unknownMeasure", Seq("col"), ResultValueType.BigDecimal) -> MeasureResult(BigDecimal(1.1))
     )
     val measurementDTOs = MeasurementBuilder.buildAndValidateMeasurementsDTO(measurements)
 
@@ -103,6 +104,9 @@ class MeasurementBuilderTest extends AnyFlatSpec {
       ),
       MeasurementDTO(
         MeasureDTO("aggregatedTotal", Seq("col2")), MeasureResultDTO(TypedValue("1.3", ResultValueType.BigDecimal))
+      ),
+      MeasurementDTO(
+        MeasureDTO("unknownMeasure", Seq("col")), MeasureResultDTO(TypedValue("1.1", ResultValueType.BigDecimal))
       )
     )