import asyncio import json from contextlib import suppress import pytest from aiohttp import web from aiohttp.client import ServerDisconnectedError from aiohttp.web_request import Request from sentry_sdk.integrations.aiohttp import AioHttpIntegration try: from unittest import mock # python 3.3 and above except ImportError: import mock # python < 3.3 async def test_basic(sentry_init, aiohttp_client, loop, capture_events): sentry_init(integrations=[AioHttpIntegration()]) async def hello(request): 1 / 0 app = web.Application() app.router.add_get("/", hello) events = capture_events() client = await aiohttp_client(app) resp = await client.get("/") assert resp.status == 500 (event,) = events assert ( event["transaction"] == "tests.integrations.aiohttp.test_aiohttp.test_basic..hello" ) (exception,) = event["exception"]["values"] assert exception["type"] == "ZeroDivisionError" request = event["request"] host = request["headers"]["Host"] assert request["env"] == {"REMOTE_ADDR": "127.0.0.1"} assert request["method"] == "GET" assert request["query_string"] == "" assert request.get("data") is None assert request["url"] == "http://{host}/".format(host=host) assert request["headers"] == { "Accept": "*/*", "Accept-Encoding": "gzip, deflate", "Host": host, "User-Agent": request["headers"]["User-Agent"], } async def test_post_body_not_read(sentry_init, aiohttp_client, loop, capture_events): from sentry_sdk.integrations.aiohttp import BODY_NOT_READ_MESSAGE sentry_init(integrations=[AioHttpIntegration()]) body = {"some": "value"} async def hello(request): 1 / 0 app = web.Application() app.router.add_post("/", hello) events = capture_events() client = await aiohttp_client(app) resp = await client.post("/", json=body) assert resp.status == 500 (event,) = events (exception,) = event["exception"]["values"] assert exception["type"] == "ZeroDivisionError" request = event["request"] assert request["env"] == {"REMOTE_ADDR": "127.0.0.1"} assert request["method"] == "POST" assert request["data"] == BODY_NOT_READ_MESSAGE async def test_post_body_read(sentry_init, aiohttp_client, loop, capture_events): sentry_init(integrations=[AioHttpIntegration()]) body = {"some": "value"} async def hello(request): await request.json() 1 / 0 app = web.Application() app.router.add_post("/", hello) events = capture_events() client = await aiohttp_client(app) resp = await client.post("/", json=body) assert resp.status == 500 (event,) = events (exception,) = event["exception"]["values"] assert exception["type"] == "ZeroDivisionError" request = event["request"] assert request["env"] == {"REMOTE_ADDR": "127.0.0.1"} assert request["method"] == "POST" assert request["data"] == json.dumps(body) async def test_403_not_captured(sentry_init, aiohttp_client, loop, capture_events): sentry_init(integrations=[AioHttpIntegration()]) async def hello(request): raise web.HTTPForbidden() app = web.Application() app.router.add_get("/", hello) events = capture_events() client = await aiohttp_client(app) resp = await client.get("/") assert resp.status == 403 assert not events async def test_cancelled_error_not_captured( sentry_init, aiohttp_client, loop, capture_events ): sentry_init(integrations=[AioHttpIntegration()]) async def hello(request): raise asyncio.CancelledError() app = web.Application() app.router.add_get("/", hello) events = capture_events() client = await aiohttp_client(app) with suppress(ServerDisconnectedError): # Intended `aiohttp` interaction: server will disconnect if it # encounters `asyncio.CancelledError` await client.get("/") assert not events async def test_half_initialized(sentry_init, aiohttp_client, loop, capture_events): sentry_init(integrations=[AioHttpIntegration()]) sentry_init() async def hello(request): return web.Response(text="hello") app = web.Application() app.router.add_get("/", hello) events = capture_events() client = await aiohttp_client(app) resp = await client.get("/") assert resp.status == 200 assert events == [] async def test_tracing(sentry_init, aiohttp_client, loop, capture_events): sentry_init(integrations=[AioHttpIntegration()], traces_sample_rate=1.0) async def hello(request): return web.Response(text="hello") app = web.Application() app.router.add_get("/", hello) events = capture_events() client = await aiohttp_client(app) resp = await client.get("/") assert resp.status == 200 (event,) = events assert event["type"] == "transaction" assert ( event["transaction"] == "tests.integrations.aiohttp.test_aiohttp.test_tracing..hello" ) @pytest.mark.parametrize( "url,transaction_style,expected_transaction,expected_source", [ ( "/message", "handler_name", "tests.integrations.aiohttp.test_aiohttp.test_transaction_style..hello", "component", ), ( "/message", "method_and_path_pattern", "GET /{var}", "route", ), ], ) async def test_transaction_style( sentry_init, aiohttp_client, capture_events, url, transaction_style, expected_transaction, expected_source, ): sentry_init( integrations=[AioHttpIntegration(transaction_style=transaction_style)], traces_sample_rate=1.0, ) async def hello(request): return web.Response(text="hello") app = web.Application() app.router.add_get(r"/{var}", hello) events = capture_events() client = await aiohttp_client(app) resp = await client.get(url) assert resp.status == 200 (event,) = events assert event["type"] == "transaction" assert event["transaction"] == expected_transaction assert event["transaction_info"] == {"source": expected_source} async def test_traces_sampler_gets_request_object_in_sampling_context( sentry_init, aiohttp_client, DictionaryContaining, # noqa:N803 ObjectDescribedBy, ): traces_sampler = mock.Mock() sentry_init( integrations=[AioHttpIntegration()], traces_sampler=traces_sampler, ) async def kangaroo_handler(request): return web.Response(text="dogs are great") app = web.Application() app.router.add_get("/tricks/kangaroo", kangaroo_handler) client = await aiohttp_client(app) await client.get("/tricks/kangaroo") traces_sampler.assert_any_call( DictionaryContaining( { "aiohttp_request": ObjectDescribedBy( type=Request, attrs={"method": "GET", "path": "/tricks/kangaroo"} ) } ) )