Coverage for tests/test_security_api_key_header.py: 100%

1from fastapi import Depends, FastAPI, Security 6 ctx1abcdef

2from fastapi.security import APIKeyHeader 6 ctx1abcdef

3from fastapi.testclient import TestClient 6 ctx1abcdef

4from pydantic import BaseModel 6 ctx1abcdef

5 

6app = FastAPI() 6 ctx1abcdef

7 

8api_key = APIKeyHeader(name="key") 6 ctx1abcdef

9 

10 

11class User(BaseModel): 6 ctx1abcdef

12 username: str 6 ctx1abcdef

13 

14 

15def get_current_user(oauth_header: str = Security(api_key)): 6 ctx1abcdef

16 user = User(username=oauth_header) 6 ctx1ghijkl

17 return user 6 ctx1ghijkl

18 

19 

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

21def read_current_user(current_user: User = Depends(get_current_user)): 6 ctx1abcdef

22 return current_user 6 ctx1ghijkl

23 

24 

25client = TestClient(app) 6 ctx1abcdef

26 

27 

28def test_security_api_key(): 6 ctx1abcdef

29 response = client.get("/users/me", headers={"key": "secret"}) 6 ctx1ghijkl

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

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

32 

33 

34def test_security_api_key_no_key(): 6 ctx1abcdef

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

36 assert response.status_code == 403, response.text 6 ctx1mnopqr

37 assert response.json() == {"detail": "Not authenticated"} 6 ctx1mnopqr

38 

39 

40def test_openapi_schema(): 6 ctx1abcdef

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

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

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

44 "openapi": "3.1.0", 

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

46 "paths": { 

47 "/users/me": { 

48 "get": { 

49 "responses": { 

50 "200": { 

51 "description": "Successful Response", 

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

53 } 

54 }, 

55 "summary": "Read Current User", 

56 "operationId": "read_current_user_users_me_get", 

57 "security": [{"APIKeyHeader": []}], 

58 } 

59 } 

60 }, 

61 "components": { 

62 "securitySchemes": { 

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

64 } 

65 }, 

66 }