Coverage for tests/test_security_api_key_header_optional.py: 100%

1from typing import Optional 7 ctx1abcdefg

2 

3from fastapi import Depends, FastAPI, Security 7 ctx1abcdefg

4from fastapi.security import APIKeyHeader 7 ctx1abcdefg

5from fastapi.testclient import TestClient 7 ctx1abcdefg

6from pydantic import BaseModel 7 ctx1abcdefg

7 

8app = FastAPI() 7 ctx1abcdefg

9 

10api_key = APIKeyHeader(name="key", auto_error=False) 7 ctx1abcdefg

11 

12 

13class User(BaseModel): 7 ctx1abcdefg

14 username: str 7 ctx1abcdefg

15 

16 

17def get_current_user(oauth_header: Optional[str] = Security(api_key)): 7 ctx1abcdefg

18 if oauth_header is None: 14 ctx1hoipjqkrlsmtnu

19 return None 7 ctx1opqrstu

20 user = User(username=oauth_header) 7 ctx1hijklmn

21 return user 7 ctx1hijklmn

22 

23 

24@app.get("/users/me") 7 ctx1abcdefg

25def read_current_user(current_user: Optional[User] = Depends(get_current_user)): 7 ctx1abcdefg

26 if current_user is None: 14 ctx1hoipjqkrlsmtnu

27 return {"msg": "Create an account first"} 7 ctx1opqrstu

28 return current_user 7 ctx1hijklmn

29 

30 

31client = TestClient(app) 7 ctx1abcdefg

32 

33 

34def test_security_api_key(): 7 ctx1abcdefg

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

36 assert response.status_code == 200, response.text 7 ctx1hijklmn

37 assert response.json() == {"username": "secret"} 7 ctx1hijklmn

38 

39 

40def test_security_api_key_no_key(): 7 ctx1abcdefg

41 response = client.get("/users/me") 7 ctx1opqrstu

42 assert response.status_code == 200, response.text 7 ctx1opqrstu

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

44 

45 

46def test_openapi_schema(): 7 ctx1abcdefg

47 response = client.get("/openapi.json") 7 ctx1vwxyzAB

48 assert response.status_code == 200, response.text 7 ctx1vwxyzAB

49 assert response.json() == { 7 ctx1vwxyzAB

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 }