sentry/tests/apidocs/endpoints/organizations/test_org_stats_v2.py

from datetime import datetime, timedelta, timezone

from django.test.client import RequestFactory
from django.urls import reverse

from fixtures.apidocs_test_case import APIDocsTestCase
from sentry.constants import DataCategory
from sentry.testutils.cases import OutcomesSnubaTest
from sentry.utils.outcomes import Outcome


class OrganizationStatsDocs(APIDocsTestCase, OutcomesSnubaTest):
    def setUp(self):
        super().setUp()
        self.now = datetime(2021, 3, 14, 12, 27, 28, tzinfo=timezone.utc)
        self.login_as(user=self.user)
        self.store_outcomes(
            {
                "org_id": self.organization.id,
                "timestamp": self.now - timedelta(hours=1),
                "project_id": self.project.id,
                "outcome": Outcome.ACCEPTED,
                "reason": "none",
                "category": DataCategory.ERROR,
                "quantity": 1,
            },
            5,
        )
        self.store_outcomes(
            {
                "org_id": self.organization.id,
                "timestamp": self.now - timedelta(hours=1),
                "project_id": self.project.id,
                "outcome": Outcome.ACCEPTED,
                "reason": "none",
                "category": DataCategory.PROFILE_DURATION,
                "quantity": 1000,  # Duration in milliseconds
            },
            3,
        )

        self.url = reverse(
            "sentry-api-0-organization-stats-v2",
            kwargs={"organization_id_or_slug": self.organization.slug},
        )

    def test_get(self):
        """
        Test that the organization stats endpoint returns valid schema.
        This test verifies that the endpoint correctly handles basic queries with interval, field and groupBy parameters.
        """
        query = {"interval": "1d", "field": "sum(quantity)", "groupBy": "category"}
        response = self.client.get(self.url, query, format="json")
        request = RequestFactory().get(self.url)

        self.validate_schema(request, response)

    def test_profile_duration_category(self):
        """
        Test that the organization stats endpoint correctly handles profile duration category.
        This test verifies that the endpoint returns valid schema when filtering by profile_duration category
        and aggregating quantity values.
        """
        query = {
            "interval": "1d",
            "field": "sum(quantity)",
            "groupBy": "category",
            "category": "profile_duration",
        }
        response = self.client.get(self.url, query, format="json")
        request = RequestFactory().get(self.url)

        self.validate_schema(request, response)