Coverage for tests / test_security_api_key_query_description.py: 100%

1from fastapi import Depends, FastAPI, Security 4 ctx1adbc

2from fastapi.security import APIKeyQuery 4 ctx1adbc

3from fastapi.testclient import TestClient 4 ctx1adbc

4from inline_snapshot import snapshot 4 ctx1adbc

5from pydantic import BaseModel 4 ctx1adbc

6 

7app = FastAPI() 4 ctx1adbc

8 

9api_key = APIKeyQuery(name="key", description="API Key Query") 4 ctx1adbc

10 

11 

12class User(BaseModel): 4 ctx1adbc

13 username: str 3 ctx1abc

14 

15 

16def get_current_user(oauth_header: str = Security(api_key)): 4 ctx1adbc

17 user = User(username=oauth_header) 4 ctx1efgh

18 return user 4 ctx1efgh

19 

20 

21@app.get("/users/me") 4 ctx1adbc

22def read_current_user(current_user: User = Depends(get_current_user)): 4 ctx1adbc

23 return current_user 4 ctx1efgh

24 

25 

26client = TestClient(app) 4 ctx1adbc

27 

28 

29def test_security_api_key(): 4 ctx1adbc

30 response = client.get("/users/me?key=secret") 4 ctx1efgh

31 assert response.status_code == 200, response.text 4 ctx1efgh

32 assert response.json() == {"username": "secret"} 4 ctx1efgh

33 

34 

35def test_security_api_key_no_key(): 4 ctx1adbc

36 response = client.get("/users/me") 4 ctx1ijkl

37 assert response.status_code == 401, response.text 4 ctx1ijkl

38 assert response.json() == {"detail": "Not authenticated"} 4 ctx1ijkl

39 assert response.headers["WWW-Authenticate"] == "APIKey" 4 ctx1ijkl

40 

41 

42def test_openapi_schema(): 4 ctx1adbc

43 response = client.get("/openapi.json") 4 ctx1mnop

44 assert response.status_code == 200, response.text 4 ctx1mnop

45 assert response.json() == snapshot( 4 ctx1mnop

46 { 

47 "openapi": "3.1.0", 

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

49 "paths": { 

50 "/users/me": { 

51 "get": { 

52 "responses": { 

53 "200": { 

54 "description": "Successful Response", 

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

56 } 

57 }, 

58 "summary": "Read Current User", 

59 "operationId": "read_current_user_users_me_get", 

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

61 } 

62 } 

63 }, 

64 "components": { 

65 "securitySchemes": { 

66 "APIKeyQuery": { 

67 "type": "apiKey", 

68 "name": "key", 

69 "in": "query", 

70 "description": "API Key Query", 

71 } 

72 } 

73 }, 

74 } 

75 )