Coverage for tests/test_exception_handlers.py: 100%

1import pytest 5 ctx1abcde

2from fastapi import Depends, FastAPI, HTTPException 5 ctx1abcde

3from fastapi.exceptions import RequestValidationError 5 ctx1abcde

4from fastapi.testclient import TestClient 5 ctx1abcde

5from starlette.responses import JSONResponse 5 ctx1abcde

6 

7 

8def http_exception_handler(request, exception): 5 ctx1abcde

9 return JSONResponse({"exception": "http-exception"}) 5 ctx1pqrst

10 

11 

12def request_validation_exception_handler(request, exception): 5 ctx1abcde

13 return JSONResponse({"exception": "request-validation"}) 5 ctx1uvwxy

14 

15 

16def server_error_exception_handler(request, exception): 5 ctx1abcde

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

18 

19 

20app = FastAPI( 5 ctx1abcde

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) 5 ctx1abcde

29 

30 

31def raise_value_error(): 5 ctx1abcde

32 raise ValueError() 5 ctx1fghij

33 

34 

35def dependency_with_yield(): 5 ctx1abcde

36 yield raise_value_error() 5 ctx1fghij

37 

38 

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

40def with_yield(): ... 5 ctx1abcde

41 

42 

43@app.get("/http-exception") 5 ctx1abcde

44def route_with_http_exception(): 5 ctx1abcde

45 raise HTTPException(status_code=400) 5 ctx1pqrst

46 

47 

48@app.get("/request-validation/{param}/") 5 ctx1abcde

49def route_with_request_validation_exception(param: int): 5 ctx1abcde

50 pass # pragma: no cover 

51 

52 

53@app.get("/server-error") 5 ctx1abcde

54def route_with_server_error(): 5 ctx1abcde

55 raise RuntimeError("Oops!") 10 ctx1zkAlBmCnDo

56 

57 

58def test_override_http_exception(): 5 ctx1abcde

59 response = client.get("/http-exception") 5 ctx1pqrst

60 assert response.status_code == 200 5 ctx1pqrst

61 assert response.json() == {"exception": "http-exception"} 5 ctx1pqrst

62 

63 

64def test_override_request_validation_exception(): 5 ctx1abcde

65 response = client.get("/request-validation/invalid") 5 ctx1uvwxy

66 assert response.status_code == 200 5 ctx1uvwxy

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

68 

69 

70def test_override_server_error_exception_raises(): 5 ctx1abcde

71 with pytest.raises(RuntimeError): 5 ctx1zABCD

72 client.get("/server-error") 5 ctx1zABCD

73 

74 

75def test_override_server_error_exception_response(): 5 ctx1abcde

76 client = TestClient(app, raise_server_exceptions=False) 5 ctx1klmno

77 response = client.get("/server-error") 5 ctx1klmno

78 assert response.status_code == 500 5 ctx1klmno

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

80 

81 

82def test_traceback_for_dependency_with_yield(): 5 ctx1abcde

83 client = TestClient(app, raise_server_exceptions=True) 5 ctx1fghij

84 with pytest.raises(ValueError) as exc_info: 5 ctx1fghij

85 client.get("/dependency-with-yield") 5 ctx1fghij

86 last_frame = exc_info.traceback[-1] 5 ctx1fghij

87 assert str(last_frame.path) == __file__ 5 ctx1fghij

88 assert last_frame.lineno == raise_value_error.__code__.co_firstlineno 5 ctx1fghij