Coverage for tests/test_security_api_key_query_optional.py: 100%

1from typing import Optional 6 ctx1abcdef

2 

3from fastapi import Depends, FastAPI, Security 6 ctx1abcdef

4from fastapi.security import APIKeyQuery 6 ctx1abcdef

5from fastapi.testclient import TestClient 6 ctx1abcdef

6from pydantic import BaseModel 6 ctx1abcdef

7 

8app = FastAPI() 6 ctx1abcdef

9 

10api_key = APIKeyQuery(name="key", auto_error=False) 6 ctx1abcdef

11 

12 

13class User(BaseModel): 6 ctx1abcdef

14 username: str 6 ctx1abcdef

15 

16 

17def get_current_user(oauth_header: Optional[str] = Security(api_key)): 6 ctx1abcdef

18 if oauth_header is None: 12 ctx1gmhniojpkqlr

19 return None 6 ctx1mnopqr

20 user = User(username=oauth_header) 6 ctx1ghijkl

21 return user 6 ctx1ghijkl

22 

23 

24@app.get("/users/me") 6 ctx1abcdef

25def read_current_user(current_user: Optional[User] = Depends(get_current_user)): 6 ctx1abcdef

26 if current_user is None: 12 ctx1gmhniojpkqlr

27 return {"msg": "Create an account first"} 6 ctx1mnopqr

28 return current_user 6 ctx1ghijkl

29 

30 

31client = TestClient(app) 6 ctx1abcdef

32 

33 

34def test_security_api_key(): 6 ctx1abcdef

35 response = client.get("/users/me?key=secret") 6 ctx1ghijkl

36 assert response.status_code == 200, response.text 6 ctx1ghijkl

37 assert response.json() == {"username": "secret"} 6 ctx1ghijkl

38 

39 

40def test_security_api_key_no_key(): 6 ctx1abcdef

41 response = client.get("/users/me") 6 ctx1mnopqr

42 assert response.status_code == 200, response.text 6 ctx1mnopqr

43 assert response.json() == {"msg": "Create an account first"} 6 ctx1mnopqr

44 

45 

46def test_openapi_schema(): 6 ctx1abcdef

47 response = client.get("/openapi.json") 6 ctx1stuvwx

48 assert response.status_code == 200, response.text 6 ctx1stuvwx

49 assert response.json() == { 6 ctx1stuvwx

50 "openapi": "3.1.0", 

51 "info": {"title": "FastAPI", "version": "0.1.0"}, 

52 "paths": { 

53 "/users/me": { 

54 "get": { 

55 "responses": { 

56 "200": { 

57 "description": "Successful Response", 

58 "content": {"application/json": {"schema": {}}}, 

59 } 

60 }, 

61 "summary": "Read Current User", 

62 "operationId": "read_current_user_users_me_get", 

63 "security": [{"APIKeyQuery": []}], 

64 } 

65 } 

66 }, 

67 "components": { 

68 "securitySchemes": { 

69 "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"} 

70 } 

71 }, 

72 }