Merge pull request #1174 from atlanhq/FT-858

Fixes typedef toolkit to generate appropriate AttributeDefs on RelationshipDefs
atlanhq · Dec 24, 2024 · 42edf23 · 42edf23
2 parents 557d142 + b863d99
commit 42edf23
Show file tree

Hide file tree

Showing 4 changed files with 85 additions and 4 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -8,7 +8,7 @@ testng = "7.10.2"
 log4j = "2.24.3"
 wiremock = "3.10.0"
 jnanoid = "2.0.0"
-awssdk = "2.29.39"
+awssdk = "2.29.40"
 gcs = "26.51.0"
 system-stubs = "2.1.7"
 fastcsv = "3.4.0"

diff --git a/samples/typedefs/build.gradle.kts b/samples/typedefs/build.gradle.kts
@@ -15,9 +15,10 @@ tasks {
 pkl {
     evaluators {
         register("genPklTypedefs") {
-            sourceModules.add("src/main/resources/MultiDimensionalDataset.pkl")
-            sourceModules.add("src/main/resources/DataModel.pkl")
             sourceModules.add("src/main/resources/Application.pkl")
+            sourceModules.add("src/main/resources/Custom.pkl")
+            sourceModules.add("src/main/resources/DataModel.pkl")
+            sourceModules.add("src/main/resources/MultiDimensionalDataset.pkl")
             modulePath.from(file("../../typedef-toolkit/model/src/main/resources"))
             outputFormat.set("json")
             multipleFileOutputDir.set(layout.projectDirectory.dir("build"))

diff --git a/samples/typedefs/src/main/resources/Custom.pkl b/samples/typedefs/src/main/resources/Custom.pkl
@@ -0,0 +1,80 @@
+/* SPDX-License-Identifier: Apache-2.0
+   Copyright 2024 Atlan Pte. Ltd. */
+amends "modulepath:/Model.pkl"
+
+t = "Custom"
+a = t.decapitalize()
+
+shared {
+  supertypeDefinition {
+    name = t
+    description = "Base class for all \(t) types."
+    superTypes { "Catalog" }
+    attributes {}
+  }
+}
+
+customTypes {
+  ["\(t)Entity"] {
+    label = "Custom"
+    icon = entityIcon
+    description = "Instances of \(t)Entity in Atlan."
+    relationships {
+      ["\(a)EntityAggregation"] {
+        description = "Containment relationship between two custom entities."
+        parent {
+          type = "\(t)Entity"
+          attribute = "\(a)ChildEntities"
+          description = "Custom entities contained within this entity."
+        }
+        children {
+          type = "\(t)Entity"
+          attribute = "\(a)ParentEntity"
+          description = "Custom entity that contains this entity."
+        }
+        relationshipAttributes {
+          ["\(a)EntityChildrenLabel"] {
+            type = "string"
+            description = "Name for the relationship when referring from the parent entity to its children entities."
+          }
+          ["\(a)EntityParentLabel"] {
+            type = "string"
+            description = "Name for the relationship when referring from a child entity to its parent entity."
+          }
+        }
+      }
+      ["\(a)EntityAssociation"] {
+        description = "Inter-relationship between two custom assets."
+        peers {
+          new {
+            type = "\(t)Entity"
+            attribute = "\(a)RelatedToEntities"
+            description = "Target custom entity indicating where the relationship is directed."
+          }
+          new {
+            type = "\(t)Entity"
+            attribute = "\(a)RelatedFromEntities"
+            description = "Source custom entity indicating where the relationship originates."
+          }
+        }
+        relationshipAttributes {
+          ["\(a)EntityToLabel"] {
+            type = "string"
+            description = "Name for the relationship when referring from endDef1 entity to endDef2 entity."
+          }
+          ["\(a)EntityFromLabel"] {
+            type = "string"
+            description = "Name for the relationship when referring from endDef2 entity to endDef1 entity."
+          }
+        }
+      }
+    }
+  }
+}
+
+local entityIcon = new Icon {
+  name = "EntityGray"
+  nameActive = "Entity"
+  svg = "entity-gray.svg"
+  svgActive = "entity.svg"
+}
diff --git a/typedef-toolkit/model/src/main/resources/Model.pkl b/typedef-toolkit/model/src/main/resources/Model.pkl
@@ -413,7 +413,7 @@ class RelationshipDef extends TypeDef {
     else "ASSOCIATION"
 
   /// Generated list of [relationship attributes][RelationshipAttributeDef] for the type definition.
-  fixed relationshipAttributeDefs: List<RelationshipAttributeDef>? = relationshipAttributes?.fold(List(), (acc: List<RelationshipAttributeDef>, key, value) ->
+  fixed attributeDefs: List<AttributeDef>? = relationshipAttributes?.fold(List(), (acc: List<RelationshipAttributeDef>, key, value) ->
     let (attrDef =
       (value) {
         name = key // Set the name from the map's key