Coverage for tests/test_security_api_key_header_optional.py: 100%

1from typing import Optional 5 ctx1abcde

2 

3from fastapi import Depends, FastAPI, Security 5 ctx1abcde

4from fastapi.security import APIKeyHeader 5 ctx1abcde

5from fastapi.testclient import TestClient 5 ctx1abcde

6from pydantic import BaseModel 5 ctx1abcde

7 

8app = FastAPI() 5 ctx1abcde

9 

10api_key = APIKeyHeader(name="key", auto_error=False) 5 ctx1abcde

11 

12 

13class User(BaseModel): 5 ctx1abcde

14 username: str 5 ctx1abcde

15 

16 

17def get_current_user(oauth_header: Optional[str] = Security(api_key)): 5 ctx1abcde

18 if oauth_header is None: 5 ctx1abcde

19 return None 5 ctx1abcde

20 user = User(username=oauth_header) 5 ctx1abcde

21 return user 5 ctx1abcde

22 

23 

24@app.get("/users/me") 5 ctx1abcde

25def read_current_user(current_user: Optional[User] = Depends(get_current_user)): 5 ctx1abcde

26 if current_user is None: 5 ctx1abcde

27 return {"msg": "Create an account first"} 5 ctx1abcde

28 return current_user 5 ctx1abcde

29 

30 

31client = TestClient(app) 5 ctx1abcde

32 

33 

34def test_security_api_key(): 5 ctx1abcde

35 response = client.get("/users/me", headers={"key": "secret"}) 5 ctx1abcde

36 assert response.status_code == 200, response.text 5 ctx1abcde

37 assert response.json() == {"username": "secret"} 5 ctx1abcde

38 

39 

40def test_security_api_key_no_key(): 5 ctx1abcde

41 response = client.get("/users/me") 5 ctx1abcde

42 assert response.status_code == 200, response.text 5 ctx1abcde

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

44 

45 

46def test_openapi_schema(): 5 ctx1abcde

47 response = client.get("/openapi.json") 5 ctx1abcde

48 assert response.status_code == 200, response.text 5 ctx1abcde

49 assert response.json() == { 5 ctx1abcde

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": [{"APIKeyHeader": []}], 

64 } 

65 } 

66 }, 

67 "components": { 

68 "securitySchemes": { 

69 "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"} 

70 } 

71 }, 

72 }