create endpoint for webhook

Author: nvo87

requirements.in

@@ -0,0 +1,3 @@
+fastapi[all]
+pytest
+pip-tools

requirements.txt

@@ -0,0 +1,114 @@
+#
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
+#
+#    pip-compile requirements.in
+#
+anyio==3.6.2
+    # via
+    #   httpcore
+    #   starlette
+    #   watchfiles
+attrs==22.1.0
+    # via pytest
+build==0.9.0
+    # via pip-tools
+certifi==2022.9.24
+    # via
+    #   httpcore
+    #   httpx
+click==8.1.3
+    # via
+    #   pip-tools
+    #   uvicorn
+dnspython==2.2.1
+    # via email-validator
+email-validator==1.3.0
+    # via fastapi
+exceptiongroup==1.0.4
+    # via pytest
+fastapi[all]==0.87.0
+    # via -r requirements.in
+h11==0.14.0
+    # via
+    #   httpcore
+    #   uvicorn
+httpcore==0.16.1
+    # via httpx
+httptools==0.5.0
+    # via uvicorn
+httpx==0.23.1
+    # via fastapi
+idna==3.4
+    # via
+    #   anyio
+    #   email-validator
+    #   rfc3986
+iniconfig==1.1.1
+    # via pytest
+itsdangerous==2.1.2
+    # via fastapi
+jinja2==3.1.2
+    # via fastapi
+markupsafe==2.1.1
+    # via jinja2
+orjson==3.8.2
+    # via fastapi
+packaging==21.3
+    # via
+    #   build
+    #   pytest
+pep517==0.13.0
+    # via build
+pip-tools==6.10.0
+    # via -r requirements.in
+pluggy==1.0.0
+    # via pytest
+pydantic==1.10.2
+    # via fastapi
+pyparsing==3.0.9
+    # via packaging
+pytest==7.2.0
+    # via -r requirements.in
+python-dotenv==0.21.0
+    # via uvicorn
+python-multipart==0.0.5
+    # via fastapi
+pyyaml==6.0
+    # via
+    #   fastapi
+    #   uvicorn
+rfc3986[idna2008]==1.5.0
+    # via httpx
+six==1.16.0
+    # via python-multipart
+sniffio==1.3.0
+    # via
+    #   anyio
+    #   httpcore
+    #   httpx
+starlette==0.21.0
+    # via fastapi
+tomli==2.0.1
+    # via
+    #   build
+    #   pep517
+    #   pytest
+typing-extensions==4.4.0
+    # via pydantic
+ujson==5.5.0
+    # via fastapi
+uvicorn[standard]==0.20.0
+    # via fastapi
+uvloop==0.17.0
+    # via uvicorn
+watchfiles==0.18.1
+    # via uvicorn
+websockets==10.4
+    # via uvicorn
+wheel==0.38.4
+    # via pip-tools
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip
+# setuptools

src/sentry/main.py

@@ -1,7 +1,11 @@
-from typing import Any, Literal, Mapping
+from typing import Any, Mapping
+from fastapi.requests import Request
+from fastapi.responses import Response
 from uuid import UUID
 
 from fastapi import FastAPI
+from fastapi import status
+from pydantic.config import Extra
 from pydantic.main import BaseModel
 
 app = FastAPI()
@@ -11,16 +15,24 @@ class Installation(BaseModel):
     uuid: UUID
 
 
-class Request(BaseModel):
+class Webhook(BaseModel, extra=Extra.allow):
     action: str
     data: Mapping[str, Any]
-    actor: Mapping[str, Any]
     installation: Installation
 
 
-SentryHookResource = Literal['installation', 'event_alert', 'issue', 'metric_alert', 'error', 'comment']
+@app.post("/api/sentry/webhook", status_code=status.HTTP_200_OK)
+async def sentry_webhook(webhook: Webhook, request: Request):
+    if request.headers.get('sentry-hook-resource') == 'issue':
 
+        #todo send webhook.data.get('title') to the Basecamp
 
-@app.post("/api/sentry/webhook")
-async def root(request: Request):
-    return request
+        return 'ok!'
+
+    elif request.headers.get('sentry-hook-resource') == 'event-alert':
+
+        return 'ok!'
+
+    else:
+
+        return Response(status_code=status.HTTP_400_BAD_REQUEST)

src/sentry/tests/conftest.py

@@ -0,0 +1,51 @@
+import pytest
+from fastapi.testclient import TestClient
+from sentry.main import app
+from sentry.tests.request_data import event, issue
+
+
+@pytest.fixture
+def client():
+    return TestClient(app)
+
+
+@pytest.fixture
+def headers():
+    return {
+        'sentry-hook-resource': 'issue',
+    }
+
+
+SENTRY_INSTALLATION_UUID = "7a485448-a9e2-4c85-8a3c-4f44175783c9"
+
+
+@pytest.fixture
+def installation():
+    return {
+        "app": {
+            "uuid": "64bf2cf4-37ca-4365-8dd3-6b6e56d741b8",
+            "slug": "app",
+        },
+        "organization": {
+            "slug": "example",
+        },
+        "uuid": SENTRY_INSTALLATION_UUID,
+    }
+
+
+@pytest.fixture
+def issue_resolved_webhook(installation):
+    return {
+        'action': 'resolved',
+        'data': {'issue': issue},
+        'installation': installation,
+    }
+
+
+@pytest.fixture
+def alert_triggered_webhook(installation):
+    return {
+        "action": "triggered",
+        "data": {"event": event},
+        "installation": installation,
+    }

src/sentry/tests/request_data.py

@@ -0,0 +1,55 @@
+issue = {
+    "id": "123",
+    "shortId": "IPE-1",
+    "title": "Error #1: This is a test error!",
+    "culprit": "SentryCustomError(frontend/src/util)",
+    "level": "error",
+    "status": "unresolved",
+    "statusDetails": {},
+    "isPublic": False,
+    "platform": "javascript",
+    "project": {
+        "id": "456",
+        "name": "ipe",
+        "slug": "ipe",
+        "platform": "javascript-react",
+    },
+    "type": "error",
+    "metadata": {
+        "value": "This is a test error!",
+        "type": "Another Error #1",
+        "filename": "/frontend/src/util.ts",
+        "function": "SentryCustomError",
+        "display_title_with_tree_label": False,
+    },
+    "numComments": 0,
+    "assignedTo": {
+        "email": "person@example.com",
+        "type": "user",
+        "id": "789",
+        "name": "Person",
+    },
+    "isBookmarked": False,
+    "isSubscribed": False,
+    "hasSeen": False,
+    "isUnhandled": False,
+    "count": "1",
+    "userCount": 1,
+    "firstSeen": "2022-04-04T18:17:18.320000Z",
+    "lastSeen": "2022-04-04T18:17:18.320000Z",
+}
+
+event = {
+    "event_id": "def456",
+    "platform": issue["platform"],
+    "datetime": issue["firstSeen"],
+    "culprit": issue["culprit"],
+    "metadata": issue["metadata"],
+    "title": issue["title"],
+    "issue_id": issue["id"],
+    "environment": "production",
+    "web_url": f"https://sentry.io/organizations/lxyz/issues/{issue['id']}/events/def456/",
+    "breadcrumbs": {},
+    "contexts": {},
+    "sdk": {},
+}

src/sentry/tests/test_webhook.py

@@ -0,0 +1,23 @@
+
+def test_response_if_issue(client, issue_resolved_webhook, headers):
+    response = client.post('/api/sentry/webhook', json=issue_resolved_webhook, headers=headers)
+
+    assert response.status_code == 200
+
+
+def test_response_if_alert(client, alert_triggered_webhook, headers):
+    response = client.post('/api/sentry/webhook', json=alert_triggered_webhook, headers=headers)
+
+    assert response.status_code == 200
+
+
+def test_bad_response_if_bad_headers(client, issue_resolved_webhook):
+    response = client.post('/api/sentry/webhook', json=issue_resolved_webhook, headers={'missing': 'header'})
+
+    assert response.status_code == 400
+
+
+def test_bad_response_if_bad_content(client, issue_resolved_webhook, headers):
+    response = client.post('/api/sentry/webhook', json={'malformed': True}, headers=headers)
+
+    assert response.status_code == 422