Coverage for tests / test_security_api_key_query_optional.py: 100%

1from typing import Optional 4 ctx1abcd

2 

3from fastapi import Depends, FastAPI, Security 4 ctx1abcd

4from fastapi.security import APIKeyQuery 4 ctx1abcd

5from fastapi.testclient import TestClient 4 ctx1abcd

6from inline_snapshot import snapshot 4 ctx1abcd

7from pydantic import BaseModel 4 ctx1abcd

8 

9app = FastAPI() 4 ctx1abcd

10 

11api_key = APIKeyQuery(name="key", auto_error=False) 4 ctx1abcd

12 

13 

14class User(BaseModel): 4 ctx1abcd

15 username: str 4 ctx1abcd

16 

17 

18def get_current_user(oauth_header: Optional[str] = Security(api_key)): 4 ctx1abcd

19 if oauth_header is None: 6 ctx1ehfigj

20 return None 3 ctx1hij

21 user = User(username=oauth_header) 3 ctx1efg

22 return user 3 ctx1efg

23 

24 

25@app.get("/users/me") 4 ctx1abcd

26def read_current_user(current_user: Optional[User] = Depends(get_current_user)): 4 ctx1abcd

27 if current_user is None: 6 ctx1ehfigj

28 return {"msg": "Create an account first"} 3 ctx1hij

29 return current_user 3 ctx1efg

30 

31 

32client = TestClient(app) 4 ctx1abcd

33 

34 

35def test_security_api_key(): 4 ctx1abcd

36 response = client.get("/users/me?key=secret") 3 ctx1efg

37 assert response.status_code == 200, response.text 3 ctx1efg

38 assert response.json() == {"username": "secret"} 3 ctx1efg

39 

40 

41def test_security_api_key_no_key(): 4 ctx1abcd

42 response = client.get("/users/me") 3 ctx1hij

43 assert response.status_code == 200, response.text 3 ctx1hij

44 assert response.json() == {"msg": "Create an account first"} 3 ctx1hij

45 

46 

47def test_openapi_schema(): 4 ctx1abcd

48 response = client.get("/openapi.json") 3 ctx1klm

49 assert response.status_code == 200, response.text 3 ctx1klm

50 assert response.json() == snapshot( 3 ctx1klm

51 { 

52 "openapi": "3.1.0", 

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

54 "paths": { 

55 "/users/me": { 

56 "get": { 

57 "responses": { 

58 "200": { 

59 "description": "Successful Response", 

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

61 } 

62 }, 

63 "summary": "Read Current User", 

64 "operationId": "read_current_user_users_me_get", 

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

66 } 

67 } 

68 }, 

69 "components": { 

70 "securitySchemes": { 

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

72 } 

73 }, 

74 } 

75 )