Coverage for tests / test_security_api_key_query_optional.py: 100%

1from fastapi import Depends, FastAPI, Security 4 ctx1abcd

2from fastapi.security import APIKeyQuery 4 ctx1abcd

3from fastapi.testclient import TestClient 4 ctx1abcd

4from inline_snapshot import snapshot 4 ctx1abcd

5from pydantic import BaseModel 4 ctx1abcd

6 

7app = FastAPI() 4 ctx1abcd

8 

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

10 

11 

12class User(BaseModel): 4 ctx1abcd

13 username: str 4 ctx1abcd

14 

15 

16def get_current_user(oauth_header: str | None = Security(api_key)): 4 ctx1abcd

17 if oauth_header is None: 6 ctx1ehfigj

18 return None 3 ctx1hij

19 user = User(username=oauth_header) 3 ctx1efg

20 return user 3 ctx1efg

21 

22 

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

24def read_current_user(current_user: User | None = Depends(get_current_user)): 4 ctx1abcd

25 if current_user is None: 6 ctx1ehfigj

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

27 return current_user 3 ctx1efg

28 

29 

30client = TestClient(app) 4 ctx1abcd

31 

32 

33def test_security_api_key(): 4 ctx1abcd

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

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

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

37 

38 

39def test_security_api_key_no_key(): 4 ctx1abcd

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

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

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

43 

44 

45def test_openapi_schema(): 4 ctx1abcd

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

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

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

49 { 

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 } 

73 )