update

Author: vegeris

integration_tests/web/test_message_metadata.py

@@ -2,9 +2,17 @@
 import os
 import time
 import unittest
+import json
 
 from integration_tests.env_variable_names import SLACK_SDK_TEST_BOT_TOKEN
-from slack_sdk.models.metadata import Metadata, EventAndEntityMetadata, EntityMetadata, EntityType, ExternalRef
+from slack_sdk.models.metadata import (
+    Metadata, EventAndEntityMetadata, EntityMetadata, EntityType, ExternalRef, 
+    EntityPayload, EntityAttributes, EntityTitle, TaskEntityFields, EntityStringField,
+    EntityTitle, EntityAttributes, EntityFullSizePreview,
+    TaskEntityFields, EntityTypedField, EntityStringField, EntityTimestampField,
+    EntityEditSupport, EntityEditTextConfig, EntityCustomField, EntityUserIDField,
+    EntityIconField, ExternalRef as CustomExternalRef
+)
 from slack_sdk.web import WebClient
 
 
@@ -128,9 +136,68 @@ def test_publishing_message_metadata_using_models(self):
 
     def test_publishing_message_entity_metadata_using_models(self):
 
-        payload = { "attributes": { "title": { "text": "Work References" }, "product_name": "We reference only", "metadata_last_modified": 1760999279, "full_size_preview": { "is_supported": True } }, "fields": { "due_date": { "value": "2026-06-06", "type": "slack#/types/date", "edit": { "enabled": True } }, "created_by": { "type": "slack#/types/user", "user": { "user_id": "U014KLZE350" }, "edit": { "enabled": True } }, "description": { "value": "Initial task work object for test test test", "format": "markdown", "long": True, "edit": { "enabled": True, "text": { "min_length": 1, "max_length": 100 } } }, "date_created": { "value": 1760629278 }, "date_updated": { "value": 1760999279 } }, "custom_fields": [ { "label": "img", "key": "img", "type": "slack#/types/image", "image_url": "https://cdn.shopify.com/s/files/1/0156/3796/files/shutterstock_54266797_large.jpg?v=1549042211" }, { "label": "Reference tasks", "key": "ref-tasks", "type": "slack#/types/entity_ref", "entity_ref": { "entity_url": "https://app-one-app-two-auth-dev.tinyspeck.com/admin/slack/workobject/129/change/", "external_ref": { "id": "129" }, "title": "Radiant task", "display_type": "tasks", "icon": { "alt_text": "img", "url": "https://avatars.slack-edge.com/2024-09-05/7707480927360_791cc0c5cdf5b6720b21_512.png" } } }, { "label": "All related references", "key": "related-refs", "type": "array", "item_type": "slack#/types/entity_ref", "value": [ { "entity_ref": { "entity_url": "https://app-one-app-two-auth-dev.tinyspeck.com/admin/slack/workobject/131/change/", "external_ref": { "id": "131" }, "title": "Work object planner", "icon": { "alt_text": "img", "url": "https://avatars.slack-edge.com/2024-09-05/7707480927360_791cc0c5cdf5b6720b21_512.png" } } }, { "entity_ref": { "entity_url": "https://app-one-app-two-auth-dev.tinyspeck.com/admin/slack/workobject/133/change/", "external_ref": { "id": "133" }, "title": "Test" } }, { "entity_ref": { "entity_url": "https://app-one-app-two-auth-dev.tinyspeck.com/admin/slack/workobject/142/change/", "external_ref": { "id": "142" }, "title": "Test" } } ] } ] }
+        # Build the metadata
 
-        client: WebClient = WebClient(token=self.bot_token,base_url='https://dev2378.slack.com/api/')
+        title = EntityTitle(text="My title")
+        full_size_preview = EntityFullSizePreview(
+            is_supported=True,
+            preview_url="https://s3-media3.fl.yelpcdn.com/bphoto/c7ed05m9lC2EmA3Aruue7A/o.jpg",
+            mime_type="image/jpeg"
+        )
+        attributes = EntityAttributes(
+            title=title,
+            product_name="My Product",
+            full_size_preview=full_size_preview
+        )
+        description = EntityStringField(
+            value="Description of the task.",
+            long=True,
+            edit=EntityEditSupport(
+                enabled=True,
+                text=EntityEditTextConfig(
+                    min_length=5,
+                    max_length=100
+                )
+            )
+        )
+        due_date = EntityTypedField(
+            value="2026-06-06",
+            type="slack#/types/date",
+            edit=EntityEditSupport(enabled=True)
+        )
+        created_by = EntityTypedField(
+            type="slack#/types/user",
+            user=EntityUserIDField(user_id="USLACKBOT"),
+        )
+        date_created = EntityTimestampField(
+            value=1762450663,
+            type="slack#/types/timestamp"
+        )
+        date_updated = EntityTimestampField(
+            value=1762450663,
+            type="slack#/types/timestamp"
+        )
+        fields = TaskEntityFields(
+            description=description,
+            due_date=due_date,
+            created_by=created_by,
+            date_created=date_created,
+            date_updated=date_updated
+        )
+        custom_fields = []
+        custom_fields.append(EntityCustomField(
+            label="My Image",
+            key="my-image",
+            type="slack#/types/image",
+            image_url="https://s3-media3.fl.yelpcdn.com/bphoto/c7ed05m9lC2EmA3Aruue7A/o.jpg"
+        ))
+        entity = EntityPayload(
+            attributes=attributes,
+            fields=fields,
+            custom_fields=custom_fields
+        )
+
+        client: WebClient = WebClient(token=self.bot_token)
         new_message = client.chat_postMessage(
             channel="C014KLZN9M0",
             text="dbl check message with metadata",
@@ -140,9 +207,10 @@ def test_publishing_message_entity_metadata_using_models(self):
                     entity_type=EntityType.TASK,
                     external_ref=ExternalRef(id="abc123"),
                     url="https://myappdomain.com",
-                    entity_payload=payload,
+                    entity_payload=entity,
             )]),
         )
 
         self.assertIsNone(new_message.get("error"))
+        print(new_message.get("response_metadata"))
         self.assertIsNone(new_message.get("warning"))