sentinel/tests/sentry/analytics/test_event.py

from datetime import datetime, timezone
from unittest.mock import patch

import pytest

from sentry.analytics import Attribute, Event, Map
from sentry.testutils.cases import TestCase
from sentry.testutils.silo import region_silo_test


class ExampleEvent(Event):
    type = "example"

    attributes = (
        Attribute("id", type=int),
        Map("map", (Attribute("key"),)),
        Attribute("optional", type=bool, required=False),
    )


class DummyType:
    key = "value"


@region_silo_test
class EventTest(TestCase):
    @patch("sentry.analytics.event.uuid1")
    def test_simple(self, mock_uuid1):
        mock_uuid1.return_value = self.get_mock_uuid()

        result = ExampleEvent(
            id="1",
            map={"key": "value"},
            optional=False,
            datetime=datetime(2001, 4, 18, tzinfo=timezone.utc),
        )
        assert result.data == {"id": 1, "map": {"key": "value"}, "optional": False}
        assert result.serialize() == {
            "data": {"id": 1, "map": {"key": "value"}, "optional": False},
            "type": "example",
            "timestamp": 987552000,
            "uuid": b"AAEC",
        }

    def test_optional_is_optional(self):
        result = ExampleEvent(id="1", map={"key": "value"})
        assert result.data == {"id": 1, "map": {"key": "value"}, "optional": None}

    def test_required_cannot_be_none(self):
        with pytest.raises(ValueError):
            ExampleEvent(id="1", map={"key": None})

    def test_invalid_map(self):
        with pytest.raises(ValueError):
            ExampleEvent(id="1", map="foo")

    def test_map_with_instance(self):
        result = ExampleEvent(id="1", map=DummyType())
        assert result.data["map"] == {"key": "value"}