DEVEXP-786: Batches - Models and APIs Unit Tests

Author: matsk-sinch

tests/unit/domains/sms/v1/models/internal/test_delivery_feedback_request_model.py

@@ -0,0 +1,94 @@
+import pytest
+from pydantic import ValidationError
+from sinch.domains.sms.models.v1.internal import DeliveryFeedbackRequest
+
+
+@pytest.fixture
+def sample_delivery_feedback_request_data():
+    return {
+        "batch_id": "01W4FFL35P4NC4K35SMSBATCH3",
+        "recipients": ["+46876543210", "+46987654321"],
+    }
+
+
+def test_delivery_feedback_request_expects_valid_inputs(
+    sample_delivery_feedback_request_data,
+):
+    """Test DeliveryFeedbackRequest with valid inputs."""
+    request = DeliveryFeedbackRequest(**sample_delivery_feedback_request_data)
+    assert (
+        request.batch_id == sample_delivery_feedback_request_data["batch_id"]
+    )
+    assert (
+        request.recipients
+        == sample_delivery_feedback_request_data["recipients"]
+    )
+
+
+def test_delivery_feedback_request_expects_single_recipient():
+    """Test DeliveryFeedbackRequest with a single recipient."""
+    request = DeliveryFeedbackRequest(
+        batch_id="01W4FFL35P4NC4K35SMSBATCH3",
+        recipients=["+46876543210"],
+    )
+    assert request.batch_id == "01W4FFL35P4NC4K35SMSBATCH3"
+    assert len(request.recipients) == 1
+    assert request.recipients[0] == "+46876543210"
+
+
+def test_delivery_feedback_request_expects_empty_recipients_list():
+    """Test DeliveryFeedbackRequest with empty recipients list."""
+    request = DeliveryFeedbackRequest(
+        batch_id="01W4FFL35P4NC4K35SMSBATCH3",
+        recipients=[],
+    )
+    assert request.batch_id == "01W4FFL35P4NC4K35SMSBATCH3"
+    assert request.recipients == []
+
+
+@pytest.mark.parametrize(
+    "missing_field",
+    ["batch_id", "recipients"],
+)
+def test_delivery_feedback_request_expects_required_fields(
+    sample_delivery_feedback_request_data, missing_field
+):
+    """Test that DeliveryFeedbackRequest requires batch_id and recipients fields."""
+    data = sample_delivery_feedback_request_data.copy()
+    data.pop(missing_field)
+    with pytest.raises(ValidationError) as exc_info:
+        DeliveryFeedbackRequest(**data)
+    assert missing_field in str(exc_info.value)
+
+
+@pytest.mark.parametrize(
+    "invalid_batch_id",
+    [12345, None],
+)
+def test_delivery_feedback_request_expects_batch_id_must_be_string(
+    invalid_batch_id,
+):
+    """Test that batch_id must be a string."""
+    with pytest.raises(ValidationError):
+        DeliveryFeedbackRequest(
+            batch_id=invalid_batch_id,
+            recipients=["+46876543210"],
+        )
+
+
+@pytest.mark.parametrize(
+    "invalid_recipients",
+    ["+46876543210", [123, 456], ["+46876543210", None]],
+)
+def test_delivery_feedback_request_expects_recipients_must_be_list_of_strings(
+    invalid_recipients,
+):
+    """Test that recipients must be a list of strings."""
+    with pytest.raises(ValidationError):
+        DeliveryFeedbackRequest(
+            batch_id="01W4FFL35P4NC4K35SMSBATCH3",
+            recipients=invalid_recipients,
+        )
+
+
+

tests/unit/domains/sms/v1/models/internal/test_list_batches_request_model.py

@@ -0,0 +1,78 @@
+from datetime import datetime, timezone
+import pytest
+from pydantic import ValidationError
+from sinch.domains.sms.models.v1.internal import ListBatchesRequest
+
+
+def test_list_batches_request_expects_defaults():
+    """Test that the model correctly sets default values."""
+    model = ListBatchesRequest()
+    assert model.page is None
+    assert model.page_size is None
+    assert model.start_date is None
+    assert model.end_date is None
+    assert model.from_ is None
+    assert model.client_reference is None
+
+
+def test_list_batches_request_expects_parsed_input():
+    """Test that the model correctly parses input with all parameters."""
+    start = datetime(2025, 1, 1, 12, 0, 0, tzinfo=timezone.utc)
+    end = datetime(2025, 1, 8, 12, 0, 0, tzinfo=timezone.utc)
+
+    model = ListBatchesRequest(
+        page=1,
+        page_size=50,
+        start_date=start,
+        end_date=end,
+        from_=["+46701234567", "+46709876543"],
+        client_reference="my-client-ref",
+    )
+
+    assert model.page == 1
+    assert model.page_size == 50
+    assert model.start_date == start
+    assert model.end_date == end
+    assert model.from_ == ["+46701234567", "+46709876543"]
+    assert model.client_reference == "my-client-ref"
+
+
+def test_list_batches_request_expects_from_alias():
+    """Test that the 'from' alias works correctly."""
+    model = ListBatchesRequest(from_=["+46701234567"])
+
+    assert model.from_ == ["+46701234567"]
+
+    # Check that model_dump with by_alias=True uses "from"
+    dumped = model.model_dump(exclude_none=True, by_alias=True)
+    assert "from" in dumped
+    assert dumped["from"] == ["+46701234567"]
+    assert "from_" not in dumped
+
+    # Check that model_dump with by_alias=False uses "from_"
+    dumped_no_alias = model.model_dump(exclude_none=True, by_alias=False)
+    assert "from_" in dumped_no_alias
+    assert dumped_no_alias["from_"] == ["+46701234567"]
+    assert "from" not in dumped_no_alias
+
+
+def test_list_batches_request_expects_partial_input():
+    """Test that the model works with partial input."""
+    model = ListBatchesRequest(page=2, page_size=20)
+
+    assert model.page == 2
+    assert model.page_size == 20
+    assert model.start_date is None
+    assert model.end_date is None
+    assert model.from_ is None
+    assert model.client_reference is None
+
+
+def test_list_batches_request_expects_empty_from_list():
+    """Test that from_ can be an empty list."""
+    model = ListBatchesRequest(from_=[])
+
+    assert model.from_ == []
+
+
+

tests/unit/domains/sms/v1/models/internal/test_replace_binary_request_model.py

@@ -0,0 +1,74 @@
+import pytest
+from pydantic import ValidationError
+from datetime import datetime, timezone
+from sinch.domains.sms.models.v1.internal.replace_batch_request import (
+    ReplaceBinaryRequest,
+)
+
+
+@pytest.fixture
+def sample_replace_binary_request_data():
+    return {
+        "batch_id": "01FC66621XXXXX119Z8PMV1QPQ",
+        "to": ["+46701234567", "+46709876543"],
+        "from_": "+46701111111",
+        "body": "SGVsbG8gV29ybGQh",
+        "udh": "06050423F423F4",
+    }
+
+
+def test_replace_binary_request_expects_valid_inputs_and_all_fields(
+    sample_replace_binary_request_data,
+):
+    """Test ReplaceBinaryRequest with valid inputs and all optional fields."""
+    request = ReplaceBinaryRequest(**sample_replace_binary_request_data)
+    assert request.batch_id == sample_replace_binary_request_data["batch_id"]
+    assert request.to == sample_replace_binary_request_data["to"]
+    assert request.from_ == sample_replace_binary_request_data["from_"]
+    assert request.body == sample_replace_binary_request_data["body"]
+    assert request.udh == sample_replace_binary_request_data["udh"]
+    assert request.type == "mt_binary"
+    assert request.delivery_report is None
+    assert request.feedback_enabled is None
+
+    send_at = datetime(2025, 1, 1, 12, 0, 0, tzinfo=timezone.utc)
+    expire_at = datetime(2025, 1, 2, 12, 0, 0, tzinfo=timezone.utc)
+
+    request = ReplaceBinaryRequest(
+        **sample_replace_binary_request_data,
+        delivery_report="summary",
+        send_at=send_at,
+        expire_at=expire_at,
+        callback_url="https://capybara.com/callback",
+        client_reference="test-ref",
+        feedback_enabled=True,
+        from_ton=1,
+        from_npi=1,
+    )
+
+    assert request.delivery_report == "summary"
+    assert request.send_at == send_at
+    assert request.expire_at == expire_at
+    assert request.callback_url == "https://capybara.com/callback"
+    assert request.client_reference == "test-ref"
+    assert request.feedback_enabled is True
+    assert request.from_ton == 1
+    assert request.from_npi == 1
+
+
+@pytest.mark.parametrize(
+    "missing_field",
+    ["batch_id", "to", "body", "udh"],
+)
+def test_replace_binary_request_expects_required_fields(
+    sample_replace_binary_request_data, missing_field
+):
+    """Test that ReplaceBinaryRequest requires batch_id, to, body, and udh fields."""
+    data = sample_replace_binary_request_data.copy()
+    data.pop(missing_field)
+    with pytest.raises(ValidationError) as exc_info:
+        ReplaceBinaryRequest(**data)
+    assert missing_field in str(exc_info.value)
+
+
+

tests/unit/domains/sms/v1/models/internal/test_replace_media_request_model.py

@@ -0,0 +1,101 @@
+import pytest
+from pydantic import ValidationError
+from datetime import datetime, timezone
+from sinch.domains.sms.models.v1.internal.replace_batch_request import (
+    ReplaceMediaRequest,
+)
+from sinch.domains.sms.models.v1.shared import MediaBody
+
+
+@pytest.fixture
+def sample_replace_media_request_data():
+    return {
+        "batch_id": "01W4FFL35P4NC4K35SMSBATCH2",
+        "to": ["+46876543210", "+46987654321"],
+        "from_": "+46800123456",
+        "body": MediaBody(
+            url="https://capybara.com/video.mp4",
+            message="Watch this amazing capybara video!",
+            subject="Capybara Video",
+        ),
+    }
+
+
+def test_replace_media_request_expects_valid_inputs_and_all_fields(
+    sample_replace_media_request_data,
+):
+    """Test ReplaceMediaRequest with valid inputs and all optional fields."""
+    request = ReplaceMediaRequest(**sample_replace_media_request_data)
+    assert request.batch_id == sample_replace_media_request_data["batch_id"]
+    assert request.to == sample_replace_media_request_data["to"]
+    assert request.from_ == sample_replace_media_request_data["from_"]
+    assert isinstance(request.body, MediaBody)
+    assert request.body.url == "https://capybara.com/video.mp4"
+    assert request.body.message == "Watch this amazing capybara video!"
+    assert request.body.subject == "Capybara Video"
+    assert request.type == "mt_media"
+    assert request.delivery_report is None
+    assert request.feedback_enabled is None
+    assert request.strict_validation is None
+
+    send_at = datetime(2025, 1, 1, 12, 0, 0, tzinfo=timezone.utc)
+    expire_at = datetime(2025, 1, 2, 12, 0, 0, tzinfo=timezone.utc)
+
+    request = ReplaceMediaRequest(
+        **sample_replace_media_request_data,
+        delivery_report="full",
+        send_at=send_at,
+        expire_at=expire_at,
+        callback_url="https://capybara.com/webhook",
+        client_reference="capybara-media-batch-123",
+        feedback_enabled=True,
+        strict_validation=True,
+        parameters={
+            "name": {"+46876543210": "Alice", "default": "user"},
+            "promo": {"+46876543210": "SUMMER2024"},
+        },
+    )
+
+    assert request.delivery_report == "full"
+    assert request.send_at == send_at
+    assert request.expire_at == expire_at
+    assert request.callback_url == "https://capybara.com/webhook"
+    assert request.client_reference == "capybara-media-batch-123"
+    assert request.feedback_enabled is True
+    assert request.strict_validation is True
+    assert request.parameters["name"]["+46876543210"] == "Alice"
+    assert request.parameters["promo"]["+46876543210"] == "SUMMER2024"
+
+
+@pytest.mark.parametrize(
+    "missing_field",
+    ["batch_id", "to", "body"],
+)
+def test_replace_media_request_expects_required_fields(
+    sample_replace_media_request_data, missing_field
+):
+    """Test that ReplaceMediaRequest requires batch_id, to, and body fields."""
+    data = sample_replace_media_request_data.copy()
+    data.pop(missing_field)
+    with pytest.raises(ValidationError) as exc_info:
+        ReplaceMediaRequest(**data)
+    assert missing_field in str(exc_info.value)
+
+
+def test_replace_media_request_expects_body_must_be_media_body(
+    sample_replace_media_request_data,
+):
+    """Test that body must be a MediaBody instance or dict that can be converted."""
+    data = sample_replace_media_request_data.copy()
+    data["body"] = "invalid"
+    with pytest.raises(ValidationError):
+        ReplaceMediaRequest(**data)
+
+    data["body"] = None
+    with pytest.raises(ValidationError):
+        ReplaceMediaRequest(**data)
+
+    data["body"] = {"url": "https://capybara.com/audio.mp3"}
+    request = ReplaceMediaRequest(**data)
+    assert isinstance(request.body, MediaBody)
+    assert request.body.url == "https://capybara.com/audio.mp3"