test: confirm chunks parse as expected json values

Author: zimeg

tests/slack_sdk/models/test_chunks.py

@@ -0,0 +1,72 @@
+import unittest
+
+from slack_sdk.models.messages.chunk import MarkdownTextChunk, TaskUpdateChunk, URLSource
+
+
+class MarkdownTextChunkTests(unittest.TestCase):
+    def test_json(self):
+        self.assertDictEqual(
+            MarkdownTextChunk(text="greetings!").to_dict(),
+            {
+                "type": "markdown_text",
+                "text": "greetings!",
+            },
+        )
+
+
+class TaskUpdateChunkTests(unittest.TestCase):
+    def test_json(self):
+        self.assertDictEqual(
+            TaskUpdateChunk(id="001", title="Waiting...", status="pending").to_dict(),
+            {
+                "type": "task_update",
+                "id": "001",
+                "title": "Waiting...",
+                "status": "pending",
+            },
+        )
+        self.assertDictEqual(
+            TaskUpdateChunk(
+                id="002",
+                title="Wondering...",
+                status="in_progress",
+                details="- Gathering information...",
+            ).to_dict(),
+            {
+                "type": "task_update",
+                "id": "002",
+                "title": "Wondering...",
+                "status": "in_progress",
+                "details": "- Gathering information...",
+            },
+        )
+        self.assertDictEqual(
+            TaskUpdateChunk(
+                id="003",
+                title="Answering...",
+                status="complete",
+                output="Found a solution",
+                sources=[
+                    URLSource(
+                        text="The Free Encyclopedia",
+                        url="https://wikipedia.org",
+                        icon_url="https://example.com/globe.png",
+                    ),
+                ],
+            ).to_dict(),
+            {
+                "type": "task_update",
+                "id": "003",
+                "title": "Answering...",
+                "status": "complete",
+                "output": "Found a solution",
+                "sources": [
+                    {
+                        "type": "url",
+                        "text": "The Free Encyclopedia",
+                        "url": "https://wikipedia.org",
+                        "icon_url": "https://example.com/globe.png",
+                    },
+                ],
+            },
+        )

tests/slack_sdk/web/test_internal_utils.py

@@ -2,18 +2,18 @@
 import unittest
 from io import BytesIO
 from pathlib import Path
-from typing import Dict, Sequence, Union
+from typing import Dict
 
-import pytest
 
 from slack_sdk.models.attachments import Attachment
 from slack_sdk.models.blocks import Block, DividerBlock
+from slack_sdk.models.messages.chunk import MarkdownTextChunk, TaskUpdateChunk
 from slack_sdk.web.internal_utils import (
     _build_unexpected_body_error_message,
+    _get_url,
+    _next_cursor_is_present,
     _parse_web_class_objects,
     _to_v2_file_upload_item,
-    _next_cursor_is_present,
-    _get_url,
 )
 
 
@@ -57,6 +57,20 @@ def test_can_parse_sequence_of_attachments(self):
             for attachment in kwargs["attachments"]:
                 assert isinstance(attachment, Dict)
 
+    def test_can_parse_sequence_of_chunks(self):
+        for chunks in [
+            [MarkdownTextChunk(text="fiz"), TaskUpdateChunk(id="001", title="baz", status="complete")],  # list
+            (
+                MarkdownTextChunk(text="fiz"),
+                TaskUpdateChunk(id="001", title="baz", status="complete"),
+            ),  # tuple
+        ]:
+            kwargs = {"chunks": chunks}
+            _parse_web_class_objects(kwargs)
+            assert kwargs["chunks"]
+            for chunks in kwargs["chunks"]:
+                assert isinstance(chunks, Dict)
+
     def test_can_parse_str_blocks(self):
         input = json.dumps([Block(block_id="42").to_dict(), Block(block_id="24").to_dict()])
         kwargs = {"blocks": input}
@@ -71,6 +85,15 @@ def test_can_parse_str_attachments(self):
         assert isinstance(kwargs["attachments"], str)
         assert input == kwargs["attachments"]
 
+    def test_can_parse_str_chunks(self):
+        input = json.dumps(
+            [MarkdownTextChunk(text="fiz").to_dict(), TaskUpdateChunk(id="001", title="baz", status="complete").to_dict()]
+        )
+        kwargs = {"chunks": input}
+        _parse_web_class_objects(kwargs)
+        assert isinstance(kwargs["chunks"], str)
+        assert input == kwargs["chunks"]
+
     def test_can_parse_user_auth_blocks(self):
         kwargs = {
             "channel": "C12345",