Merge pull request #615 from atlanhq/APP-6523

  APP-6523: Added optional `description` parameters to `cm/attributedef.creator()` methods

Author: Aryamanz29

pyatlan/model/typedef.py

@@ -832,6 +832,7 @@ def create(
         applicable_other_asset_types: Optional[OtherAssetTypes] = None,
         applicable_domains: Optional[Set[str]] = None,
         applicable_domain_types: Optional[DomainTypes] = None,
+        description: Optional[str] = None,
     ) -> AttributeDef:
         from pyatlan.utils import validate_required_fields
 
@@ -847,7 +848,7 @@ def create(
             ),
             is_new=True,
             cardinality=Cardinality.SINGLE,
-            description="",
+            description=description,
             name="",
             include_in_notification=False,
             is_indexable=True,
@@ -1152,7 +1153,9 @@ def with_logo_from_icon(
     )
 
     @staticmethod
-    def create(display_name: str) -> CustomMetadataDef:
+    def create(
+        display_name: str, description: Optional[str] = None
+    ) -> CustomMetadataDef:
         from pyatlan.utils import validate_required_fields
 
         validate_required_fields(
@@ -1164,6 +1167,7 @@ def create(display_name: str) -> CustomMetadataDef:
             category=AtlanTypeCategory.CUSTOM_METADATA,
             display_name=display_name,
             name=display_name,
+            description=description,
         )
 
 

tests/integration/custom_metadata_test.py

@@ -75,6 +75,8 @@
     "Uniqueness",
 ]
 DQ_TYPE_EXTRA_LIST = ["Unknown", "Others"]
+CM_DESCRIPTION = "Automated testing of the Python SDK (cm)."
+ATTRIBUTE_DESCRIPTION = "Automated testing of the Python SDK (attribute)."
 
 _removal_epoch: Optional[int]
 
@@ -88,7 +90,7 @@ def create_custom_metadata(
     icon: Optional[AtlanIcon] = None,
     color: Optional[AtlanTagColor] = None,
 ) -> CustomMetadataDef:
-    cm_def = CustomMetadataDef.create(display_name=name)
+    cm_def = CustomMetadataDef.create(display_name=name, description=CM_DESCRIPTION)
     cm_def.attribute_defs = attribute_defs
     if icon and color:
         cm_def.options = CustomMetadataDef.Options.with_logo_from_icon(
@@ -143,6 +145,7 @@ def cm_ipr(
         AttributeDef.create(
             display_name=CM_ATTR_IPR_LICENSE,
             attribute_type=AtlanCustomAttributePrimitiveType.STRING,
+            description=ATTRIBUTE_DESCRIPTION,
             **limit_attribute_applicability_kwargs,
         ),
         AttributeDef.create(
@@ -175,6 +178,7 @@ def test_cm_ipr(cm_ipr: CustomMetadataDef, limit_attribute_applicability_kwargs)
     assert cm_ipr.guid
     assert cm_ipr.name != cm_name
     assert cm_ipr.display_name == cm_name
+    assert cm_ipr.description == CM_DESCRIPTION
     attributes = cm_ipr.attribute_defs
     assert attributes
     assert len(attributes) == 5
@@ -183,6 +187,7 @@ def test_cm_ipr(cm_ipr: CustomMetadataDef, limit_attribute_applicability_kwargs)
     assert one_with_limited.options
     assert one_with_limited.display_name == CM_ATTR_IPR_LICENSE
     assert one_with_limited.name
+    assert one_with_limited.description == ATTRIBUTE_DESCRIPTION
     assert one_with_limited.name != CM_ATTR_IPR_LICENSE
     assert one_with_limited.type_name == AtlanCustomAttributePrimitiveType.STRING.value
     assert not one_with_limited.options.multi_value_select

tests/integration/test_index_search.py

@@ -1,5 +1,6 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright 2022 Atlan Pte. Ltd.
+import math
 from dataclasses import dataclass, field
 from datetime import datetime
 from time import sleep, time
@@ -335,8 +336,6 @@ def _assert_search_results(results, expected_sorts, size, TOTAL_ASSETS, bulk=Fal
 
 @patch.object(LOGGER, "debug")
 def test_search_pagination(mock_logger, client: AtlanClient):
-    size = 2
-
     # Avoid testing on integration tests objects
     exclude_sdk_terms = [
         Asset.NAME.wildcard("psdk_*"),
@@ -352,13 +351,22 @@ def test_search_pagination(mock_logger, client: AtlanClient):
     dsl = DSL(
         query=query,
         post_filter=Term.with_type_name(value="AtlasGlossaryTerm"),
-        size=size,
+        size=0,  # to get the total count
     )
+
     request = IndexSearchRequest(dsl=dsl)
     results = client.asset.search(criteria=request)
     # Assigning this here to ensure the total assets
     # remain constant across different test cases
     TOTAL_ASSETS = results.count
+
+    # set page_size to divide into ~5 API calls
+    size = max(1, math.ceil(TOTAL_ASSETS / 5))
+    request.dsl.size = size
+
+    # Now, we can test different test scenarios for search() with the dynamic page size
+    results = client.asset.search(criteria=request)
+
     expected_sorts = [Asset.GUID.order(SortOrder.ASCENDING)]
     _assert_search_results(results, expected_sorts, size, TOTAL_ASSETS)
 
@@ -385,7 +393,7 @@ def test_search_pagination(mock_logger, client: AtlanClient):
         FluentSearch(where_nots=exclude_sdk_terms)
         .where(CompoundQuery.active_assets())
         .where(CompoundQuery.asset_type(AtlasGlossaryTerm))
-        .page_size(2)
+        .page_size(size)
     ).to_request()
     results = client.asset.search(criteria=request)
     expected_sorts = [Asset.GUID.order(SortOrder.ASCENDING)]
@@ -396,7 +404,7 @@ def test_search_pagination(mock_logger, client: AtlanClient):
         FluentSearch(where_nots=exclude_sdk_terms)
         .where(CompoundQuery.active_assets())
         .where(CompoundQuery.asset_type(AtlasGlossaryTerm))
-        .page_size(2)
+        .page_size(size)
     ).to_request()
     results = client.asset.search(criteria=request, bulk=True)
     expected_sorts = [
@@ -413,7 +421,7 @@ def test_search_pagination(mock_logger, client: AtlanClient):
         FluentSearch(where_nots=exclude_sdk_terms)
         .where(CompoundQuery.active_assets())
         .where(CompoundQuery.asset_type(AtlasGlossaryTerm))
-        .page_size(2)
+        .page_size(size)
     ).execute(client, bulk=True)
     expected_sorts = [
         Asset.CREATE_TIME.order(SortOrder.ASCENDING),
@@ -431,7 +439,7 @@ def test_search_pagination(mock_logger, client: AtlanClient):
             FluentSearch(where_nots=exclude_sdk_terms)
             .where(CompoundQuery.active_assets())
             .where(CompoundQuery.asset_type(AtlasGlossaryTerm))
-            .page_size(2)
+            .page_size(size)
         ).to_request()
         results = client.asset.search(criteria=request)
         expected_sorts = [

tests/unit/test_base_vcr_json.py

@@ -13,7 +13,7 @@ class TestBaseVCRJSON(BaseVCR):
 
     BASE_URL = "https://httpbin.org"
 
-    @pytest.fixture(scope="session")
+    @pytest.fixture(scope="module")
     def vcr_config(self):
         """
         Override the VCR configuration to use JSON serialization across the module.