feat: Initial codecov endpoint for fetching test results (#91911)

This PR creates our first new Sentry endpoint using the API Client and
Auth Middleware to successfully send a request to the Codecov Backend.
It is the endpoint for returning a list of test results for a particular
repository.

A lot of this PR pulls aspects from these [helpful Sentry API
Docs](https://develop.sentry.dev/backend/api/public/).

For this proof of concept the endpoint is currently hard coded to return
just the first 10 test results from the codecov gazebo repository to
unblock creation of the hook.

For my reviewers, here's roughly where everything is in this PR:

- urls.py -- Where the new endpoint is located
- build.py -- This populates the sidebar for the sentry [API doc
page](https://docs.sentry.io/api/auth/)
- parameters.py -- This creates a new label for our "usual" parameters
for our API docs
- base.py -- implements Sentry endpoint class. We can modify this as
needed overtime. Holds permission classes
- client.py -- adds json attribute to post function / updates the
callsite in query fn, since the GQL endpoint returns a json object
- Endpoints/TestResults -- Holds the query / serializer / endpoint
business logic and the hardcoded stuff



<!--

  Sentry employees and contractors can delete or ignore the following.

-->

### Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated
in the State of Delaware in 2015 as Functional Software, Inc. and is
gonna need some rights from me in order to utilize my contributions in
this here PR. So here's the deal: I retain all rights, title and
interest in and to my contributions, and by keeping this boilerplate
intact I confirm that Sentry can use, modify, copy, and redistribute my
contributions, under Sentry's choice of terms.

Author: ajay-sentry

.github/CODEOWNERS

@@ -374,6 +374,8 @@ tests/sentry/api/endpoints/test_organization_dashboard_widget_details.py     @ge
 /static/app/views/codecov/       @getsentry/codecov-merge-ux
 ## End of Codecov Merge UX
 
+/src/sentry/codecov/ @getsentry/codecov
+
 ## Frontend
 /static/app/components/analyticsArea.spec.tsx  @getsentry/app-frontend
 /static/app/components/analyticsArea.tsx       @getsentry/app-frontend

src/sentry/api/api_owners.py

@@ -9,6 +9,7 @@ class ApiOwner(Enum):
 
     ALERTS_NOTIFICATIONS = "alerts-notifications"
     BILLING = "revenue"
+    CODECOV = "codecov"
     CRONS = "crons"
     ECOSYSTEM = "ecosystem"
     ENTERPRISE = "enterprise"

src/sentry/api/urls.py

@@ -68,6 +68,7 @@
     SourceMapDebugBlueThunderEditionEndpoint,
 )
 from sentry.api.endpoints.trace_explorer_ai_setup import TraceExplorerAISetup
+from sentry.codecov.endpoints.TestResults.test_results import TestResultsEndpoint
 from sentry.data_export.endpoints.data_export import DataExportEndpoint
 from sentry.data_export.endpoints.data_export_details import DataExportDetailsEndpoint
 from sentry.data_secrecy.api.waive_data_secrecy import WaiveDataSecrecyEndpoint
@@ -3237,6 +3238,14 @@ def create_group_urls(name_prefix: str) -> list[URLPattern | URLResolver]:
     ),
 ]
 
+PREVENT_URLS = [
+    re_path(
+        r"^owner/(?P<owner>[^\/]+)/repository/(?P<repository>[^\/]+)/test-results/$",
+        TestResultsEndpoint.as_view(),
+        name="sentry-api-0-test-results",
+    ),
+]
+
 urlpatterns = [
     # Relay
     re_path(
@@ -3297,6 +3306,11 @@ def create_group_urls(name_prefix: str) -> list[URLPattern | URLResolver]:
         r"^broadcasts/",
         include(BROADCAST_URLS),
     ),
+    # Prevent
+    re_path(
+        r"^prevent/",
+        include(PREVENT_URLS),
+    ),
     #
     #
     #

src/sentry/apidocs/build.py

@@ -174,4 +174,14 @@ def get_old_json_components(filename: str) -> Any:
             "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/integration-platform/&template=api_error_template.md",
         },
     },
+    {
+        "name": "Prevent",
+        "x-sidebar-name": "Prevent",
+        "description": "Endpoints for Prevent",
+        "x-display-description": False,
+        "externalDocs": {
+            "description": "Found an error? Let us know.",
+            "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/prevent/&template=api_error_template.md",
+        },
+    },
 ]

src/sentry/apidocs/parameters.py

@@ -1024,3 +1024,20 @@ class ExploreSavedQueriesParams:
 - `myqueries`
         """,
     )
+
+
+class PreventParams:
+    OWNER = OpenApiParameter(
+        name="owner",
+        location="path",
+        required=True,
+        type=str,
+        description="The owner of the repository.",
+    )
+    REPOSITORY = OpenApiParameter(
+        name="repository",
+        location="path",
+        required=True,
+        type=str,
+        description="The name of the repository.",
+    )

src/sentry/codecov/base.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from rest_framework.request import Request
+
+from sentry.api.base import Endpoint
+
+
+class CodecovEndpoint(Endpoint):
+    """
+    Used for endpoints that are specific to Codecov / Prevent.
+    """
+
+    permission_classes = ()
+
+    def convert_args(self, request: Request, *args, **kwargs):
+        parsed_args, parsed_kwargs = super().convert_args(request, *args, **kwargs)
+        # TODO: in case we need to modify args, do it here
+        return (parsed_args, parsed_kwargs)

src/sentry/codecov/client.py

@@ -81,7 +81,7 @@ def __init__(
             "g_p": git_provider,
         }
 
-    def get(self, endpoint: str, params=None, headers=None) -> requests.Response | None:
+    def get(self, endpoint: str, params=None, headers=None) -> requests.Response:
         """
         Makes a GET request to the specified endpoint of the configured Codecov
         API host with the provided params and headers.
@@ -104,7 +104,7 @@ def get(self, endpoint: str, params=None, headers=None) -> requests.Response | N
 
         return response
 
-    def post(self, endpoint: str, data=None, headers=None) -> requests.Response | None:
+    def post(self, endpoint: str, data=None, json=None, headers=None) -> requests.Response:
         """
         Makes a POST request to the specified endpoint of the configured Codecov
         API host with the provided data and headers.
@@ -119,7 +119,9 @@ def post(self, endpoint: str, data=None, headers=None) -> requests.Response | No
         headers.update(jwt.authorization_header(token))
         url = f"{self.base_url}{endpoint}"
         try:
-            response = requests.post(url, data=data, headers=headers, timeout=TIMEOUT_SECONDS)
+            response = requests.post(
+                url, data=data, json=json, headers=headers, timeout=TIMEOUT_SECONDS
+            )
         except Exception:
             logger.exception("Error when making POST request")
             raise
@@ -128,7 +130,7 @@ def post(self, endpoint: str, data=None, headers=None) -> requests.Response | No
 
     def query(
         self, query: str, variables: dict, provider: GitProvider = GitProvider.GitHub
-    ) -> requests.Response | None:
+    ) -> requests.Response:
         """
         Convenience method for making a GraphQL query to the Codecov API, using the post method of this client.
         This method is used to make GraphQL queries to the Codecov API. Adds headers similar to what's done in Gazebo,
@@ -141,16 +143,16 @@ def query(
         :return: The response from the Codecov API.
         """
 
-        data = {
+        json = {
             "query": query,
             "variables": variables,
         }
 
         return self.post(
             f"/graphql/sentry/{provider.value}",
-            data=data,
+            json=json,
             headers={
-                "Content-Type": "application/json",
+                "Content-Type": "application/json; charset=utf-8",
                 "Accept": "application/json",
                 "Token-Type": f"{provider.value}-token",
             },

src/sentry/codecov/endpoints/TestResults/query.py

@@ -0,0 +1,56 @@
+query = """query GetTestResults(
+  $owner: String!
+  $repo: String!
+  $filters: TestResultsFilters
+  $ordering: TestResultsOrdering
+  $first: Int
+  $after: String
+  $last: Int
+  $before: String
+) {
+  owner(username: $owner) {
+    repository: repository(name: $repo) {
+      __typename
+      ... on Repository {
+        testAnalytics {
+          testResults(
+            filters: $filters
+            ordering: $ordering
+            first: $first
+            after: $after
+            last: $last
+            before: $before
+          ) {
+            edges {
+              node {
+                updatedAt
+                avgDuration
+                lastDuration
+                name
+                failureRate
+                flakeRate
+                commitsFailed
+                totalFailCount
+                totalFlakyFailCount
+                totalSkipCount
+                totalPassCount
+              }
+            }
+            pageInfo {
+              endCursor
+              hasNextPage
+            }
+            totalCount
+          }
+        }
+      }
+      ... on NotFoundError {
+        message
+      }
+      ... on OwnerNotActivatedError {
+        message
+      }
+    }
+  }
+}
+"""

src/sentry/codecov/endpoints/TestResults/serializers.py

@@ -0,0 +1,83 @@
+import logging
+
+import sentry_sdk
+from rest_framework import serializers
+
+logger = logging.getLogger(__name__)
+
+
+class TestResultNodeSerializer(serializers.Serializer):
+    """
+    Serializer for individual test result nodes from GraphQL response
+    """
+
+    updatedAt = serializers.CharField()
+    avgDuration = serializers.FloatField()
+    name = serializers.CharField()
+    failureRate = serializers.FloatField()
+    flakeRate = serializers.FloatField()
+    commitsFailed = serializers.IntegerField()
+    totalFailCount = serializers.IntegerField()
+    totalFlakyFailCount = serializers.IntegerField()
+    totalSkipCount = serializers.IntegerField()
+    totalPassCount = serializers.IntegerField()
+    lastDuration = serializers.FloatField()
+
+
+class PageInfoSerializer(serializers.Serializer):
+    """
+    Serializer for pagination information
+    """
+
+    endCursor = serializers.CharField(allow_null=True)
+    hasNextPage = serializers.BooleanField()
+
+
+class TestResultSerializer(serializers.Serializer):
+    """
+    Serializer for test results response including pagination metadata
+    """
+
+    results = TestResultNodeSerializer(many=True)
+    pageInfo = PageInfoSerializer()
+    totalCount = serializers.IntegerField()
+
+    def to_representation(self, graphql_response):
+        """
+        Transform the GraphQL response to the serialized format
+        """
+        try:
+            test_results_data = graphql_response["data"]["owner"]["repository"]["testAnalytics"][
+                "testResults"
+            ]
+            test_results = test_results_data["edges"]
+
+            nodes = []
+            for edge in test_results:
+                node = edge["node"]
+                nodes.append(node)
+
+            response_data = {
+                "results": nodes,
+                "pageInfo": test_results_data.get(
+                    "pageInfo", {"endCursor": None, "hasNextPage": False}
+                ),
+                "totalCount": test_results_data.get("totalCount", len(nodes)),
+            }
+
+            return super().to_representation(response_data)
+
+        except (KeyError, TypeError) as e:
+            sentry_sdk.capture_exception(e)
+            logger.exception(
+                "Error parsing GraphQL response",
+                extra={
+                    "error": str(e),
+                    "response_keys": (
+                        list(graphql_response.keys())
+                        if isinstance(graphql_response, dict)
+                        else None
+                    ),
+                },
+            )
+            raise