Merge pull request #142 from atlanhq/AM-364

Am 364 - Tags sent in a purpose are not translated

Author: ErnestoLoma

HISTORY.md

@@ -1,5 +1,6 @@
 ## 1.3.0 (October 5, 2023)
 
+* Correct issue with incorrect type on purpose_atlan_tags of Purpose
 * Added support for searching audit logs
 * Fixed bug preventing creation of locked custom metadata
 * Fully-validate connection parameters on save

pyatlan/generator/class_generator.py

@@ -324,6 +324,11 @@ def set_entity_defs(cls, entity_defs: list[EntityDef]):
         entity_defs = sorted(entity_defs, key=lambda e: ",".join(e.super_types or []))
         for entity_def in entity_defs:
             name = entity_def.name
+            if name == "Purpose" and entity_def.attribute_defs:
+                for attribute in entity_def.attribute_defs:
+                    if attribute["name"] == "purposeClassifications":
+                        attribute["typeName"] = "array<AtlanTagName>"
+
             if (not entity_def.super_types and name != REFERENCEABLE) or any(
                 super_type in cls.super_type_names_to_ignore
                 for super_type in (entity_def.super_types or [])

pyatlan/generator/templates/imports.jinja2

@@ -10,7 +10,7 @@ from urllib.parse import quote, unquote
 
 from pydantic import Field, PrivateAttr, StrictStr, root_validator, validator
 
-from pyatlan.model.core import Announcement, AtlanObject, AtlanTag, Meaning
+from pyatlan.model.core import Announcement, AtlanObject, AtlanTag, AtlanTagName, Meaning
 from pyatlan.model.custom_metadata import CustomMetadataDict, CustomMetadataProxy
 from pyatlan.model.enums import (
     ADLSAccessTier,

pyatlan/model/assets/asset13.py

@@ -8,6 +8,7 @@
 
 from pydantic import Field, validator
 
+from pyatlan.model.core import AtlanTagName
 from pyatlan.model.enums import (
     AuthPolicyCategory,
     AuthPolicyResourceCategory,
@@ -195,17 +196,17 @@ def __setattr__(self, name, value):
     ]
 
     @property
-    def purpose_atlan_tags(self) -> Optional[set[str]]:
+    def purpose_atlan_tags(self) -> Optional[list[AtlanTagName]]:
         return None if self.attributes is None else self.attributes.purpose_atlan_tags
 
     @purpose_atlan_tags.setter
-    def purpose_atlan_tags(self, purpose_atlan_tags: Optional[set[str]]):
+    def purpose_atlan_tags(self, purpose_atlan_tags: Optional[list[AtlanTagName]]):
         if self.attributes is None:
             self.attributes = self.Attributes()
         self.attributes.purpose_atlan_tags = purpose_atlan_tags
 
     class Attributes(AccessControl.Attributes):
-        purpose_atlan_tags: Optional[set[str]] = Field(
+        purpose_atlan_tags: Optional[list[AtlanTagName]] = Field(
             None, description="", alias="purposeClassifications"
         )
 

tests/integration/purpose_test.py

@@ -7,6 +7,7 @@
 
 from pyatlan.client.atlan import AtlanClient
 from pyatlan.model.assets import AuthPolicy, Purpose
+from pyatlan.model.core import AtlanTagName
 from pyatlan.model.enums import (
     AssetSidebarTab,
     AtlanTagColor,
@@ -22,7 +23,7 @@
 
 
 @pytest.fixture(scope="module")
-def atlan_tag(
+def atlan_tag_def(
     client: AtlanClient,
 ) -> Generator[AtlanTagDef, None, None]:
     atlan_tag_def = AtlanTagDef.create(name=MODULE_NAME, color=AtlanTagColor.GREEN)
@@ -31,28 +32,33 @@ def atlan_tag(
     client.purge_typedef(MODULE_NAME, typedef_type=AtlanTagDef)
 
 
+@pytest.fixture(scope="module")
+def atlan_tag_name(atlan_tag_def):
+    return AtlanTagName(atlan_tag_def.display_name)
+
+
 @pytest.fixture(scope="module")
 def purpose(
     client: AtlanClient,
-    atlan_tag: AtlanTagDef,
+    atlan_tag_name,
 ) -> Generator[Purpose, None, None]:
-    to_create = Purpose.create(name=MODULE_NAME, atlan_tags=[atlan_tag.display_name])
+    to_create = Purpose.create(name=MODULE_NAME, atlan_tags=[atlan_tag_name])
     response = client.save(to_create)
     p = response.assets_created(asset_type=Purpose)[0]
     yield p
     delete_asset(client, guid=p.guid, asset_type=Purpose)
 
 
-def test_purpose(
-    client: AtlanClient,
-    purpose: Purpose,
-):
+def test_purpose(client: AtlanClient, purpose: Purpose, atlan_tag_name: AtlanTagName):
     assert purpose
     assert purpose.guid
     assert purpose.qualified_name
     assert purpose.name == MODULE_NAME
     assert purpose.display_name == MODULE_NAME
     assert purpose.qualified_name != MODULE_NAME
+    purpose = client.get_asset_by_guid(guid=purpose.guid, asset_type=Purpose)
+    assert purpose.purpose_atlan_tags
+    assert [atlan_tag_name] == purpose.purpose_atlan_tags
 
 
 @pytest.mark.order(after="test_purpose")
@@ -88,7 +94,9 @@ def test_find_purpose_by_name(
     client: AtlanClient,
     purpose: Purpose,
 ):
-    result = client.find_purposes_by_name(MODULE_NAME)
+    result = client.find_purposes_by_name(
+        MODULE_NAME, attributes=["purposeClassifications"]
+    )
     count = 0
     # TODO: replace with exponential back-off and jitter
     while not result and count < 10:

tests/unit/test_model.py

@@ -488,6 +488,7 @@
     "Optional[list[MatillionJob]]": [MatillionJob()],
     "Optional[MatillionJob]": MatillionJob(),
     "Optional[list[LookerFolder]]": [LookerFolder()],
+    "Optional[list[AtlanTagName]]": [],
 }