Coverage for tests/test_exception_handlers.py: 100%

1import pytest 7 ctx1abcdefg

2from fastapi import Depends, FastAPI, HTTPException 7 ctx1abcdefg

3from fastapi.exceptions import RequestValidationError 7 ctx1abcdefg

4from fastapi.testclient import TestClient 7 ctx1abcdefg

5from starlette.responses import JSONResponse 7 ctx1abcdefg

6 

7 

8def http_exception_handler(request, exception): 7 ctx1abcdefg

9 return JSONResponse({"exception": "http-exception"}) 7 ctx1vwxyzAB

10 

11 

12def request_validation_exception_handler(request, exception): 7 ctx1abcdefg

13 return JSONResponse({"exception": "request-validation"}) 7 ctx1CDEFGHI

14 

15 

16def server_error_exception_handler(request, exception): 7 ctx1abcdefg

17 return JSONResponse(status_code=500, content={"exception": "server-error"}) 21 ctx1JohKpiLqjMrkNslOtmPun

18 

19 

20app = FastAPI( 7 ctx1abcdefg

21 exception_handlers={ 

22 HTTPException: http_exception_handler, 

23 RequestValidationError: request_validation_exception_handler, 

24 Exception: server_error_exception_handler, 

25 } 

26) 

27 

28client = TestClient(app) 7 ctx1abcdefg

29 

30 

31def raise_value_error(): 7 ctx1abcdefg

32 raise ValueError() 7 ctx1hijklmn

33 

34 

35def dependency_with_yield(): 7 ctx1abcdefg

36 yield raise_value_error() 7 ctx1hijklmn

37 

38 

39@app.get("/dependency-with-yield", dependencies=[Depends(dependency_with_yield)]) 7 ctx1abcdefg

40def with_yield(): ... 7 ctx1abcdefg

41 

42 

43@app.get("/http-exception") 7 ctx1abcdefg

44def route_with_http_exception(): 7 ctx1abcdefg

45 raise HTTPException(status_code=400) 7 ctx1vwxyzAB

46 

47 

48@app.get("/request-validation/{param}/") 7 ctx1abcdefg

49def route_with_request_validation_exception(param: int): 7 ctx1abcdefg

50 pass # pragma: no cover 

51 

52 

53@app.get("/server-error") 7 ctx1abcdefg

54def route_with_server_error(): 7 ctx1abcdefg

55 raise RuntimeError("Oops!") 14 ctx1JoKpLqMrNsOtPu

56 

57 

58def test_override_http_exception(): 7 ctx1abcdefg

59 response = client.get("/http-exception") 7 ctx1vwxyzAB

60 assert response.status_code == 200 7 ctx1vwxyzAB

61 assert response.json() == {"exception": "http-exception"} 7 ctx1vwxyzAB

62 

63 

64def test_override_request_validation_exception(): 7 ctx1abcdefg

65 response = client.get("/request-validation/invalid") 7 ctx1CDEFGHI

66 assert response.status_code == 200 7 ctx1CDEFGHI

67 assert response.json() == {"exception": "request-validation"} 7 ctx1CDEFGHI

68 

69 

70def test_override_server_error_exception_raises(): 7 ctx1abcdefg

71 with pytest.raises(RuntimeError): 7 ctx1JKLMNOP

72 client.get("/server-error") 7 ctx1JKLMNOP

73 

74 

75def test_override_server_error_exception_response(): 7 ctx1abcdefg

76 client = TestClient(app, raise_server_exceptions=False) 7 ctx1opqrstu

77 response = client.get("/server-error") 7 ctx1opqrstu

78 assert response.status_code == 500 7 ctx1opqrstu

79 assert response.json() == {"exception": "server-error"} 7 ctx1opqrstu

80 

81 

82def test_traceback_for_dependency_with_yield(): 7 ctx1abcdefg

83 client = TestClient(app, raise_server_exceptions=True) 7 ctx1hijklmn

84 with pytest.raises(ValueError) as exc_info: 7 ctx1hijklmn

85 client.get("/dependency-with-yield") 7 ctx1hijklmn

86 last_frame = exc_info.traceback[-1] 7 ctx1hijklmn

87 assert str(last_frame.path) == __file__ 7 ctx1hijklmn

88 assert last_frame.lineno == raise_value_error.__code__.co_firstlineno 7 ctx1hijklmn