Merge pull request #2021 from aml-org/W-16006973

W-16006973: add avro annotations

amf-api-contract/shared/src/main/scala/amf/apicontract/internal/spec/avro/parser/domain/AvroCollectionShapeParser.scala

@@ -4,6 +4,8 @@ import amf.apicontract.internal.spec.avro.parser.context.AvroSchemaContext
 import amf.core.internal.parser.YMapOps
 import amf.shapes.client.scala.model.domain.AnyShape
 import org.yaml.model.{YMap, YMapEntry}
+import amf.shapes.internal.annotations.AVROSchemaType
+import org.yaml.model.YScalar
 
 abstract class AvroCollectionShapeParser[T <: AnyShape](map: YMap, membersKey: String)(implicit ctx: AvroSchemaContext)
     extends AvroComplexShapeParser(map) {
@@ -20,5 +22,14 @@ abstract class AvroCollectionShapeParser[T <: AnyShape](map: YMap, membersKey: S
     shape
   }
 
-  protected def parseMembers(e: YMapEntry): AnyShape = AvroTextTypeParser(e.value.as[String], None).parse()
+  protected def parseMembers(e: YMapEntry): AnyShape = {
+    e.value.value match {
+      case scalar: YScalar =>
+        val avroType    = scalar.text
+        val parsedShape = AvroTextTypeParser(avroType, None).parse()
+        parsedShape.annotations += AVROSchemaType(avroType)
+        parsedShape
+      case map: YMap => new AvroShapeParser(map).parse().getOrElse(AnyShape())
+    }
+  }
 }

amf-api-contract/shared/src/main/scala/amf/apicontract/internal/spec/avro/parser/domain/AvroComplexShapeParser.scala

@@ -1,11 +1,13 @@
 package amf.apicontract.internal.spec.avro.parser.domain
 
 import amf.apicontract.internal.spec.avro.parser.context.AvroSchemaContext
+import amf.core.client.scala.model.domain.Shape
 import amf.core.internal.datanode.DataNodeParser
 import amf.core.internal.metamodel.domain.ShapeModel
 import amf.core.internal.parser.YMapOps
 import amf.core.internal.parser.domain.Annotations
 import amf.shapes.client.scala.model.domain.AnyShape
+import amf.shapes.internal.annotations.AVROSchemaType
 import amf.shapes.internal.domain.metamodel.AnyShapeModel
 import amf.shapes.internal.spec.common.parser.QuickFieldParserOps
 import org.yaml.model._
@@ -63,4 +65,6 @@ trait AvroKeyExtractor {
     def isPrimitive: Boolean =
       Seq("null", "boolean", "int", "long", "float", "double", "bytes", "string").contains(value)
   }
+
+  def getAvroType(shape: Shape): Option[AVROSchemaType] = shape.annotations.find(classOf[AVROSchemaType])
 }

amf-api-contract/shared/src/main/scala/amf/apicontract/internal/spec/avro/parser/domain/AvroEnumParser.scala

@@ -2,7 +2,9 @@ package amf.apicontract.internal.spec.avro.parser.domain
 
 import amf.apicontract.internal.spec.avro.parser.context.AvroSchemaContext
 import amf.core.client.scala.model.DataType
-import amf.core.client.scala.model.domain.ScalarNode
+import amf.core.client.scala.model.domain.{AmfArray, ScalarNode}
+import amf.core.internal.metamodel.domain.ShapeModel
+import amf.core.internal.parser.domain.Annotations
 import amf.core.internal.parser.{YMapOps, YScalarYRead}
 import amf.shapes.client.scala.model.domain.AnyShape
 import org.yaml.model._
@@ -18,10 +20,10 @@ class AvroEnumParser(map: YMap)(implicit ctx: AvroSchemaContext) extends AvroTex
   }
 
   override def parseSpecificFields(): Unit = {
-    map
-      .key("symbols")
-      .map(parseSymbols)
-      .map(shape.withValues)
+    map.key("symbols").map { entry =>
+      val symbols = parseSymbols(entry)
+      shape.setWithoutId(ShapeModel.Values, AmfArray(symbols, Annotations(entry.value)), Annotations(entry))
+    }
   }
 
   private def parseSymbols(e: YMapEntry): Seq[ScalarNode] = {

amf-api-contract/shared/src/main/scala/amf/apicontract/internal/spec/avro/parser/domain/AvroMapShapeParser.scala

@@ -1,13 +1,16 @@
 package amf.apicontract.internal.spec.avro.parser.domain
 
 import amf.apicontract.internal.spec.avro.parser.context.AvroSchemaContext
+import amf.core.internal.parser.domain.Annotations
 import amf.shapes.client.scala.model.domain.{AnyShape, NodeShape}
+import amf.shapes.internal.domain.metamodel.NodeShapeModel.AdditionalPropertiesSchema
 import org.yaml.model.YMap
 
 case class AvroMapShapeParser(map: YMap)(implicit ctx: AvroSchemaContext)
     extends AvroCollectionShapeParser[NodeShape](map, "values") {
-  override val shape: NodeShape                     = NodeShape(map)
-  override def setMembers(anyShape: AnyShape): Unit = shape.withAdditionalPropertiesSchema(anyShape)
+  override val shape: NodeShape = NodeShape(map)
+  override def setMembers(anyShape: AnyShape): Unit =
+    shape.setWithoutId(AdditionalPropertiesSchema, anyShape, Annotations(map))
 
   override def parseSpecificFields(): Unit = {}
 }

amf-api-contract/shared/src/main/scala/amf/apicontract/internal/spec/avro/parser/domain/AvroRecordParser.scala

@@ -1,6 +1,7 @@
 package amf.apicontract.internal.spec.avro.parser.domain
 
 import amf.apicontract.internal.spec.avro.parser.context.AvroSchemaContext
+import amf.core.client.scala.model.domain.AmfArray
 import amf.core.client.scala.model.domain.extensions.PropertyShape
 import amf.core.internal.datanode.DataNodeParser
 import amf.core.internal.metamodel.domain.ShapeModel
@@ -9,6 +10,7 @@ import amf.core.internal.parser.YMapOps
 import amf.core.internal.parser.domain.Annotations
 import amf.shapes.client.scala.model.domain.{AnyShape, NodeShape}
 import amf.shapes.internal.domain.metamodel.AnyShapeModel
+import amf.shapes.internal.domain.metamodel.NodeShapeModel.Properties
 import org.yaml.model.{YMap, YMapEntry, YNode}
 
 class AvroRecordParser(map: YMap)(implicit ctx: AvroSchemaContext) extends AvroComplexShapeParser(map) {
@@ -21,15 +23,25 @@ class AvroRecordParser(map: YMap)(implicit ctx: AvroSchemaContext) extends AvroC
 
   private def parseFieldsEntry(e: YMapEntry): Unit = {
     val fields = e.value.as[Seq[YMap]].flatMap(parseField)
-    shape.withProperties(fields)
+    shape.setWithoutId(Properties, AmfArray(fields, Annotations(e.value)), Annotations(e))
   }
 
   def parseField(map: YMap): Option[PropertyShape] = {
-    val maybeShape: Option[PropertyShape] = AvroRecordFieldParser(map).parse().map(buildProperty)
+    val maybeShape =
+      AvroRecordFieldParser(map)
+        .parse()
+        .map { s =>
+          // add the map annotations + the avro type annotation to the PropertyShape wrapper
+          var ann = Annotations(map)
+          getAvroType(s).foreach(avroTypeAnnotation => ann = ann += avroTypeAnnotation)
+          val p = PropertyShape(ann).withRange(s)
+          p.setWithoutId(PropertyShapeModel.Range, s, s.annotations)
+        }
     maybeShape.foreach { p =>
       map.key("name", AnyShapeModel.Name in p)
       map.key("aliases", AnyShapeModel.Aliases in p)
       map.key("doc", AnyShapeModel.Description in p)
+      // todo: change to new field Order (being a string)
       map.key("order", PropertyShapeModel.SerializationOrder in p)
       map.key(
         "default",
@@ -41,9 +53,6 @@ class AvroRecordParser(map: YMap)(implicit ctx: AvroSchemaContext) extends AvroC
     }
     maybeShape
   }
-
-  private def buildProperty(anyShape: AnyShape): PropertyShape =
-    PropertyShape(Annotations.virtual()).withName("field").withRange(anyShape)
 }
 
 case class AvroRecordFieldParser(map: YMap)(implicit ctx: AvroSchemaContext) extends AvroShapeParser(map) {

amf-api-contract/shared/src/main/scala/amf/apicontract/internal/spec/avro/parser/domain/AvroShapeParser.scala

@@ -21,7 +21,7 @@ class AvroShapeParser(map: YMap)(implicit ctx: AvroSchemaContext) extends AvroKe
         // todo: should validate invalid type when using the AVRO Validator
         (None, "invalid avro type")
     }
-    maybeShape.map(_.annotations += AVROSchemaType(avroType))
+    maybeShape.map(_.annotations += AVROSchemaType(avroType)) // avroType = record, enum, fixed, array, map, etc.
     maybeShape
   }
 

amf-api-contract/shared/src/main/scala/amf/apicontract/internal/spec/avro/parser/domain/AvroUnionShapeParser.scala

@@ -1,6 +1,7 @@
 package amf.apicontract.internal.spec.avro.parser.domain
 
 import amf.apicontract.internal.spec.avro.parser.context.AvroSchemaContext
+import amf.core.internal.parser.domain.Annotations
 import amf.shapes.client.scala.model.domain.UnionShape
 import org.yaml.model.{YMap, YNode}
 
@@ -10,6 +11,6 @@ case class AvroUnionShapeParser(members: Seq[YNode], node: YNode)(implicit ctx:
 
   override def parseSpecificFields(): Unit = {
     val parsedMembers = members.map(node => AvroTextParser(node).parse())
-    shape.withAnyOf(parsedMembers)
+    shape.withAnyOf(parsedMembers, Annotations(node))
   }
 }