From dfe9498d986cffb76dc06f2e75fe5d3e424ab589 Mon Sep 17 00:00:00 2001 From: bilalAlpaslan Date: Tue, 12 Apr 2022 22:55:06 +0300 Subject: [PATCH 1/6] APIKey scheme name default changed --- fastapi/security/api_key.py | 6 +- tests/test_security_api_key_cookie.py | 4 +- ...est_security_api_key_cookie_description.py | 4 +- .../test_security_api_key_cookie_optional.py | 4 +- tests/test_security_api_key_header.py | 4 +- ...est_security_api_key_header_description.py | 4 +- .../test_security_api_key_header_optional.py | 4 +- .../test_security_api_key_multiple_header.py | 105 ++++++++++++++++++ tests/test_security_api_key_query.py | 4 +- ...test_security_api_key_query_description.py | 4 +- tests/test_security_api_key_query_optional.py | 4 +- 11 files changed, 126 insertions(+), 21 deletions(-) create mode 100644 tests/test_security_api_key_multiple_header.py diff --git a/fastapi/security/api_key.py b/fastapi/security/api_key.py index 36ab60e30..adb619077 100644 --- a/fastapi/security/api_key.py +++ b/fastapi/security/api_key.py @@ -23,7 +23,7 @@ class APIKeyQuery(APIKeyBase): self.model: APIKey = APIKey( **{"in": APIKeyIn.query}, name=name, description=description ) - self.scheme_name = scheme_name or self.__class__.__name__ + self.scheme_name = scheme_name or name self.auto_error = auto_error async def __call__(self, request: Request) -> Optional[str]: @@ -50,7 +50,7 @@ class APIKeyHeader(APIKeyBase): self.model: APIKey = APIKey( **{"in": APIKeyIn.header}, name=name, description=description ) - self.scheme_name = scheme_name or self.__class__.__name__ + self.scheme_name = scheme_name or name self.auto_error = auto_error async def __call__(self, request: Request) -> Optional[str]: @@ -77,7 +77,7 @@ class APIKeyCookie(APIKeyBase): self.model: APIKey = APIKey( **{"in": APIKeyIn.cookie}, name=name, description=description ) - self.scheme_name = scheme_name or self.__class__.__name__ + self.scheme_name = scheme_name or name self.auto_error = auto_error async def __call__(self, request: Request) -> Optional[str]: diff --git a/tests/test_security_api_key_cookie.py b/tests/test_security_api_key_cookie.py index a5b2e44f0..b0b77ac85 100644 --- a/tests/test_security_api_key_cookie.py +++ b/tests/test_security_api_key_cookie.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": {"type": "apiKey", "name": "key", "in": "cookie"} + "key": {"type": "apiKey", "name": "key", "in": "cookie"} } }, } diff --git a/tests/test_security_api_key_cookie_description.py b/tests/test_security_api_key_cookie_description.py index 2cd3565b4..ef6ae3e9f 100644 --- a/tests/test_security_api_key_cookie_description.py +++ b/tests/test_security_api_key_cookie_description.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": { + "key": { "type": "apiKey", "name": "key", "in": "cookie", diff --git a/tests/test_security_api_key_cookie_optional.py b/tests/test_security_api_key_cookie_optional.py index 96a64f09a..451738147 100644 --- a/tests/test_security_api_key_cookie_optional.py +++ b/tests/test_security_api_key_cookie_optional.py @@ -45,13 +45,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": {"type": "apiKey", "name": "key", "in": "cookie"} + "key": {"type": "apiKey", "name": "key", "in": "cookie"} } }, } diff --git a/tests/test_security_api_key_header.py b/tests/test_security_api_key_header.py index d53395f99..1816c7252 100644 --- a/tests/test_security_api_key_header.py +++ b/tests/test_security_api_key_header.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"} + "key": {"type": "apiKey", "name": "key", "in": "header"} } }, } diff --git a/tests/test_security_api_key_header_description.py b/tests/test_security_api_key_header_description.py index cc9802708..0589224a8 100644 --- a/tests/test_security_api_key_header_description.py +++ b/tests/test_security_api_key_header_description.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": { + "key": { "type": "apiKey", "name": "key", "in": "header", diff --git a/tests/test_security_api_key_header_optional.py b/tests/test_security_api_key_header_optional.py index 4ab599c2d..b7900176c 100644 --- a/tests/test_security_api_key_header_optional.py +++ b/tests/test_security_api_key_header_optional.py @@ -44,13 +44,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"} + "key": {"type": "apiKey", "name": "key", "in": "header"} } }, } diff --git a/tests/test_security_api_key_multiple_header.py b/tests/test_security_api_key_multiple_header.py new file mode 100644 index 000000000..16c0d56fb --- /dev/null +++ b/tests/test_security_api_key_multiple_header.py @@ -0,0 +1,105 @@ +from fastapi import Depends, FastAPI, Security +from fastapi.security import APIKeyHeader +from fastapi.testclient import TestClient +from pydantic import BaseModel + +app = FastAPI() + +api_key = APIKeyHeader(name="key") +another_key = APIKeyHeader(name="another_key") + + +class User(BaseModel): + username: str + + +def get_current_user(oauth_header: str = Security(api_key)): + user = User(username=oauth_header) + return user + + +def get_current_user_with_another_key(oauth_header: str = Security(another_key)): + user = User(username=oauth_header) + return user + + +@app.get("/users/me") +def read_current_user(current_user: User = Depends(get_current_user)): + return current_user + + +@app.get("/another_key/users/me") +def read_current_user_another_key(current_user: User = Depends(get_current_user_with_another_key)): + return current_user + + +client = TestClient(app) + +openapi_schema = { + "openapi": "3.0.2", + "info": {"title": "FastAPI", "version": "0.1.0"}, + "paths": { + "/users/me": { + "get": { + "responses": { + "200": { + "description": "Successful Response", + "content": {"application/json": {"schema": {}}}, + } + }, + "summary": "Read Current User", + "operationId": "read_current_user_users_me_get", + "security": [{"key": []}], + } + }, + "/another_key/users/me": { + "get": { + "responses": { + "200": { + "description": "Successful Response", + "content": {"application/json": {"schema": {}}}, + } + }, + "summary": "Read Current User Another Key", + "operationId": "read_current_user_another_key_another_key_users_me_get", + "security": [{"another_key": []}], + } + } + }, + "components": { + "securitySchemes": { + "key": {"type": "apiKey", "name": "key", "in": "header"}, + "another_key": {"type": "apiKey", "name": "another_key", "in": "header"} + } + }, +} + + +def test_openapi_schema(): + response = client.get("/openapi.json") + assert response.status_code == 200, response.text + assert response.json() == openapi_schema + + +def test_security_api_key(): + response = client.get("/users/me", headers={"key": "secret"}) + assert response.status_code == 200, response.text + assert response.json() == {"username": "secret"} + + +def test_security_api_key_no_key(): + response = client.get("/users/me") + assert response.status_code == 403, response.text + assert response.json() == {"detail": "Not authenticated"} + + +def test_another_security_api_key(): + response = client.get("/another_key/users/me", headers={"another_key": "secret"}) + assert response.status_code == 200, response.text + assert response.json() == {"username": "secret"} + + +def test_another_security_api_key_no_key(): + response = client.get("/another_key/users/me") + assert response.status_code == 403, response.text + assert response.json() == {"detail": "Not authenticated"} diff --git a/tests/test_security_api_key_query.py b/tests/test_security_api_key_query.py index 4844c65e2..8bcb9334d 100644 --- a/tests/test_security_api_key_query.py +++ b/tests/test_security_api_key_query.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"} + "key": {"type": "apiKey", "name": "key", "in": "query"} } }, } diff --git a/tests/test_security_api_key_query_description.py b/tests/test_security_api_key_query_description.py index 9b608233a..e7a88a86f 100644 --- a/tests/test_security_api_key_query_description.py +++ b/tests/test_security_api_key_query_description.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": { + "key": { "type": "apiKey", "name": "key", "in": "query", diff --git a/tests/test_security_api_key_query_optional.py b/tests/test_security_api_key_query_optional.py index 9339b7b3a..b9e65d347 100644 --- a/tests/test_security_api_key_query_optional.py +++ b/tests/test_security_api_key_query_optional.py @@ -44,13 +44,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"} + "key": {"type": "apiKey", "name": "key", "in": "query"} } }, } From 8d8825e15d21d3f769fc02b60d14ea3bc5ccad14 Mon Sep 17 00:00:00 2001 From: bilalAlpaslan Date: Tue, 12 Apr 2022 22:55:06 +0300 Subject: [PATCH 2/6] APIKey scheme name default changed --- fastapi/security/api_key.py | 6 +- tests/test_security_api_key_cookie.py | 4 +- ...est_security_api_key_cookie_description.py | 4 +- .../test_security_api_key_cookie_optional.py | 4 +- tests/test_security_api_key_header.py | 4 +- ...est_security_api_key_header_description.py | 4 +- .../test_security_api_key_header_optional.py | 4 +- .../test_security_api_key_multiple_header.py | 105 ++++++++++++++++++ tests/test_security_api_key_query.py | 4 +- ...test_security_api_key_query_description.py | 4 +- tests/test_security_api_key_query_optional.py | 4 +- 11 files changed, 126 insertions(+), 21 deletions(-) create mode 100644 tests/test_security_api_key_multiple_header.py diff --git a/fastapi/security/api_key.py b/fastapi/security/api_key.py index 36ab60e30..adb619077 100644 --- a/fastapi/security/api_key.py +++ b/fastapi/security/api_key.py @@ -23,7 +23,7 @@ class APIKeyQuery(APIKeyBase): self.model: APIKey = APIKey( **{"in": APIKeyIn.query}, name=name, description=description ) - self.scheme_name = scheme_name or self.__class__.__name__ + self.scheme_name = scheme_name or name self.auto_error = auto_error async def __call__(self, request: Request) -> Optional[str]: @@ -50,7 +50,7 @@ class APIKeyHeader(APIKeyBase): self.model: APIKey = APIKey( **{"in": APIKeyIn.header}, name=name, description=description ) - self.scheme_name = scheme_name or self.__class__.__name__ + self.scheme_name = scheme_name or name self.auto_error = auto_error async def __call__(self, request: Request) -> Optional[str]: @@ -77,7 +77,7 @@ class APIKeyCookie(APIKeyBase): self.model: APIKey = APIKey( **{"in": APIKeyIn.cookie}, name=name, description=description ) - self.scheme_name = scheme_name or self.__class__.__name__ + self.scheme_name = scheme_name or name self.auto_error = auto_error async def __call__(self, request: Request) -> Optional[str]: diff --git a/tests/test_security_api_key_cookie.py b/tests/test_security_api_key_cookie.py index a5b2e44f0..b0b77ac85 100644 --- a/tests/test_security_api_key_cookie.py +++ b/tests/test_security_api_key_cookie.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": {"type": "apiKey", "name": "key", "in": "cookie"} + "key": {"type": "apiKey", "name": "key", "in": "cookie"} } }, } diff --git a/tests/test_security_api_key_cookie_description.py b/tests/test_security_api_key_cookie_description.py index 2cd3565b4..ef6ae3e9f 100644 --- a/tests/test_security_api_key_cookie_description.py +++ b/tests/test_security_api_key_cookie_description.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": { + "key": { "type": "apiKey", "name": "key", "in": "cookie", diff --git a/tests/test_security_api_key_cookie_optional.py b/tests/test_security_api_key_cookie_optional.py index 96a64f09a..451738147 100644 --- a/tests/test_security_api_key_cookie_optional.py +++ b/tests/test_security_api_key_cookie_optional.py @@ -45,13 +45,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": {"type": "apiKey", "name": "key", "in": "cookie"} + "key": {"type": "apiKey", "name": "key", "in": "cookie"} } }, } diff --git a/tests/test_security_api_key_header.py b/tests/test_security_api_key_header.py index d53395f99..1816c7252 100644 --- a/tests/test_security_api_key_header.py +++ b/tests/test_security_api_key_header.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"} + "key": {"type": "apiKey", "name": "key", "in": "header"} } }, } diff --git a/tests/test_security_api_key_header_description.py b/tests/test_security_api_key_header_description.py index cc9802708..0589224a8 100644 --- a/tests/test_security_api_key_header_description.py +++ b/tests/test_security_api_key_header_description.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": { + "key": { "type": "apiKey", "name": "key", "in": "header", diff --git a/tests/test_security_api_key_header_optional.py b/tests/test_security_api_key_header_optional.py index 4ab599c2d..b7900176c 100644 --- a/tests/test_security_api_key_header_optional.py +++ b/tests/test_security_api_key_header_optional.py @@ -44,13 +44,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"} + "key": {"type": "apiKey", "name": "key", "in": "header"} } }, } diff --git a/tests/test_security_api_key_multiple_header.py b/tests/test_security_api_key_multiple_header.py new file mode 100644 index 000000000..16c0d56fb --- /dev/null +++ b/tests/test_security_api_key_multiple_header.py @@ -0,0 +1,105 @@ +from fastapi import Depends, FastAPI, Security +from fastapi.security import APIKeyHeader +from fastapi.testclient import TestClient +from pydantic import BaseModel + +app = FastAPI() + +api_key = APIKeyHeader(name="key") +another_key = APIKeyHeader(name="another_key") + + +class User(BaseModel): + username: str + + +def get_current_user(oauth_header: str = Security(api_key)): + user = User(username=oauth_header) + return user + + +def get_current_user_with_another_key(oauth_header: str = Security(another_key)): + user = User(username=oauth_header) + return user + + +@app.get("/users/me") +def read_current_user(current_user: User = Depends(get_current_user)): + return current_user + + +@app.get("/another_key/users/me") +def read_current_user_another_key(current_user: User = Depends(get_current_user_with_another_key)): + return current_user + + +client = TestClient(app) + +openapi_schema = { + "openapi": "3.0.2", + "info": {"title": "FastAPI", "version": "0.1.0"}, + "paths": { + "/users/me": { + "get": { + "responses": { + "200": { + "description": "Successful Response", + "content": {"application/json": {"schema": {}}}, + } + }, + "summary": "Read Current User", + "operationId": "read_current_user_users_me_get", + "security": [{"key": []}], + } + }, + "/another_key/users/me": { + "get": { + "responses": { + "200": { + "description": "Successful Response", + "content": {"application/json": {"schema": {}}}, + } + }, + "summary": "Read Current User Another Key", + "operationId": "read_current_user_another_key_another_key_users_me_get", + "security": [{"another_key": []}], + } + } + }, + "components": { + "securitySchemes": { + "key": {"type": "apiKey", "name": "key", "in": "header"}, + "another_key": {"type": "apiKey", "name": "another_key", "in": "header"} + } + }, +} + + +def test_openapi_schema(): + response = client.get("/openapi.json") + assert response.status_code == 200, response.text + assert response.json() == openapi_schema + + +def test_security_api_key(): + response = client.get("/users/me", headers={"key": "secret"}) + assert response.status_code == 200, response.text + assert response.json() == {"username": "secret"} + + +def test_security_api_key_no_key(): + response = client.get("/users/me") + assert response.status_code == 403, response.text + assert response.json() == {"detail": "Not authenticated"} + + +def test_another_security_api_key(): + response = client.get("/another_key/users/me", headers={"another_key": "secret"}) + assert response.status_code == 200, response.text + assert response.json() == {"username": "secret"} + + +def test_another_security_api_key_no_key(): + response = client.get("/another_key/users/me") + assert response.status_code == 403, response.text + assert response.json() == {"detail": "Not authenticated"} diff --git a/tests/test_security_api_key_query.py b/tests/test_security_api_key_query.py index 4844c65e2..8bcb9334d 100644 --- a/tests/test_security_api_key_query.py +++ b/tests/test_security_api_key_query.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"} + "key": {"type": "apiKey", "name": "key", "in": "query"} } }, } diff --git a/tests/test_security_api_key_query_description.py b/tests/test_security_api_key_query_description.py index 9b608233a..e7a88a86f 100644 --- a/tests/test_security_api_key_query_description.py +++ b/tests/test_security_api_key_query_description.py @@ -38,13 +38,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": { + "key": { "type": "apiKey", "name": "key", "in": "query", diff --git a/tests/test_security_api_key_query_optional.py b/tests/test_security_api_key_query_optional.py index 9339b7b3a..b9e65d347 100644 --- a/tests/test_security_api_key_query_optional.py +++ b/tests/test_security_api_key_query_optional.py @@ -44,13 +44,13 @@ openapi_schema = { }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"} + "key": {"type": "apiKey", "name": "key", "in": "query"} } }, } From 2a48bb23c724daa28234144a4ac9b59b4b6c029f Mon Sep 17 00:00:00 2001 From: bilalAlpaslan Date: Wed, 13 Apr 2022 01:41:56 +0300 Subject: [PATCH 3/6] APIKey scheme name default changed --- tests/test_security_api_key_cookie.py | 4 +--- tests/test_security_api_key_cookie_optional.py | 4 +--- tests/test_security_api_key_header.py | 4 +--- tests/test_security_api_key_header_optional.py | 4 +--- tests/test_security_api_key_multiple_header.py | 8 +++++--- tests/test_security_api_key_query.py | 4 +--- tests/test_security_api_key_query_optional.py | 4 +--- .../test_tutorial/test_request_files/test_tutorial001.py | 2 +- 8 files changed, 12 insertions(+), 22 deletions(-) diff --git a/tests/test_security_api_key_cookie.py b/tests/test_security_api_key_cookie.py index b0b77ac85..b3c3fec56 100644 --- a/tests/test_security_api_key_cookie.py +++ b/tests/test_security_api_key_cookie.py @@ -43,9 +43,7 @@ openapi_schema = { } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "cookie"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "cookie"}} }, } diff --git a/tests/test_security_api_key_cookie_optional.py b/tests/test_security_api_key_cookie_optional.py index 451738147..f1fe7b2f3 100644 --- a/tests/test_security_api_key_cookie_optional.py +++ b/tests/test_security_api_key_cookie_optional.py @@ -50,9 +50,7 @@ openapi_schema = { } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "cookie"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "cookie"}} }, } diff --git a/tests/test_security_api_key_header.py b/tests/test_security_api_key_header.py index 1816c7252..cb0379e0e 100644 --- a/tests/test_security_api_key_header.py +++ b/tests/test_security_api_key_header.py @@ -43,9 +43,7 @@ openapi_schema = { } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "header"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "header"}} }, } diff --git a/tests/test_security_api_key_header_optional.py b/tests/test_security_api_key_header_optional.py index b7900176c..9ecbdc4a0 100644 --- a/tests/test_security_api_key_header_optional.py +++ b/tests/test_security_api_key_header_optional.py @@ -49,9 +49,7 @@ openapi_schema = { } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "header"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "header"}} }, } diff --git a/tests/test_security_api_key_multiple_header.py b/tests/test_security_api_key_multiple_header.py index 16c0d56fb..c6b4b5fc1 100644 --- a/tests/test_security_api_key_multiple_header.py +++ b/tests/test_security_api_key_multiple_header.py @@ -29,7 +29,9 @@ def read_current_user(current_user: User = Depends(get_current_user)): @app.get("/another_key/users/me") -def read_current_user_another_key(current_user: User = Depends(get_current_user_with_another_key)): +def read_current_user_another_key( + current_user: User = Depends(get_current_user_with_another_key), +): return current_user @@ -64,12 +66,12 @@ openapi_schema = { "operationId": "read_current_user_another_key_another_key_users_me_get", "security": [{"another_key": []}], } - } + }, }, "components": { "securitySchemes": { "key": {"type": "apiKey", "name": "key", "in": "header"}, - "another_key": {"type": "apiKey", "name": "another_key", "in": "header"} + "another_key": {"type": "apiKey", "name": "another_key", "in": "header"}, } }, } diff --git a/tests/test_security_api_key_query.py b/tests/test_security_api_key_query.py index 8bcb9334d..96853c452 100644 --- a/tests/test_security_api_key_query.py +++ b/tests/test_security_api_key_query.py @@ -43,9 +43,7 @@ openapi_schema = { } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "query"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "query"}} }, } diff --git a/tests/test_security_api_key_query_optional.py b/tests/test_security_api_key_query_optional.py index b9e65d347..273c3a809 100644 --- a/tests/test_security_api_key_query_optional.py +++ b/tests/test_security_api_key_query_optional.py @@ -49,9 +49,7 @@ openapi_schema = { } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "query"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "query"}} }, } diff --git a/tests/test_tutorial/test_request_files/test_tutorial001.py b/tests/test_tutorial/test_request_files/test_tutorial001.py index c1537f445..841116e30 100644 --- a/tests/test_tutorial/test_request_files/test_tutorial001.py +++ b/tests/test_tutorial/test_request_files/test_tutorial001.py @@ -162,7 +162,7 @@ def test_post_file(tmp_path): def test_post_large_file(tmp_path): - default_pydantic_max_size = 2 ** 16 + default_pydantic_max_size = 2**16 path = tmp_path / "test.txt" path.write_bytes(b"x" * (default_pydantic_max_size + 1)) From 35726e0e146ccdc906e9ce78319e87bf0c8300e4 Mon Sep 17 00:00:00 2001 From: bilalAlpaslan Date: Wed, 7 Jun 2023 01:45:31 +0300 Subject: [PATCH 4/6] Update for updated tests --- tests/test_security_api_key_cookie.py | 35 +--------------- ...est_security_api_key_cookie_description.py | 42 +------------------ .../test_security_api_key_cookie_optional.py | 35 +--------------- tests/test_security_api_key_header.py | 33 +-------------- ...est_security_api_key_header_description.py | 40 +----------------- .../test_security_api_key_header_optional.py | 33 +-------------- tests/test_security_api_key_query.py | 33 +-------------- ...test_security_api_key_query_description.py | 40 +----------------- tests/test_security_api_key_query_optional.py | 33 +-------------- 9 files changed, 18 insertions(+), 306 deletions(-) diff --git a/tests/test_security_api_key_cookie.py b/tests/test_security_api_key_cookie.py index addb9cdb4..586e92c5f 100644 --- a/tests/test_security_api_key_cookie.py +++ b/tests/test_security_api_key_cookie.py @@ -22,37 +22,6 @@ def read_current_user(current_user: User = Depends(get_current_user)): return current_user -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "cookie"}} - }, -} - - -def test_openapi_schema(): - client = TestClient(app) - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - - def test_security_api_key(): client = TestClient(app, cookies={"key": "secret"}) response = client.get("/users/me") @@ -85,13 +54,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": {"type": "apiKey", "name": "key", "in": "cookie"} + "key": {"type": "apiKey", "name": "key", "in": "cookie"} } }, } diff --git a/tests/test_security_api_key_cookie_description.py b/tests/test_security_api_key_cookie_description.py index 25f4e19fa..17ec35e71 100644 --- a/tests/test_security_api_key_cookie_description.py +++ b/tests/test_security_api_key_cookie_description.py @@ -22,44 +22,6 @@ def read_current_user(current_user: User = Depends(get_current_user)): return current_user -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": { - "key": { - "type": "apiKey", - "name": "key", - "in": "cookie", - "description": "An API Cookie Key", - } - } - }, -} - - -def test_openapi_schema(): - client = TestClient(app) - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - - def test_security_api_key(): client = TestClient(app, cookies={"key": "secret"}) response = client.get("/users/me") @@ -92,13 +54,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": { + "key": { "type": "apiKey", "name": "key", "in": "cookie", diff --git a/tests/test_security_api_key_cookie_optional.py b/tests/test_security_api_key_cookie_optional.py index 6da8ec019..de2193934 100644 --- a/tests/test_security_api_key_cookie_optional.py +++ b/tests/test_security_api_key_cookie_optional.py @@ -29,37 +29,6 @@ def read_current_user(current_user: User = Depends(get_current_user)): return current_user -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "cookie"}} - }, -} - - -def test_openapi_schema(): - client = TestClient(app) - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - - def test_security_api_key(): client = TestClient(app, cookies={"key": "secret"}) response = client.get("/users/me") @@ -92,13 +61,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyCookie": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyCookie": {"type": "apiKey", "name": "key", "in": "cookie"} + "key": {"type": "apiKey", "name": "key", "in": "cookie"} } }, } diff --git a/tests/test_security_api_key_header.py b/tests/test_security_api_key_header.py index 0824d9bfa..2e5ed7ad5 100644 --- a/tests/test_security_api_key_header.py +++ b/tests/test_security_api_key_header.py @@ -24,35 +24,6 @@ def read_current_user(current_user: User = Depends(get_current_user)): client = TestClient(app) -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "header"}} - }, -} - - -def test_openapi_schema(): - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - def test_security_api_key(): response = client.get("/users/me", headers={"key": "secret"}) @@ -83,13 +54,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"} + "key": {"type": "apiKey", "name": "key", "in": "header"} } }, } diff --git a/tests/test_security_api_key_header_description.py b/tests/test_security_api_key_header_description.py index adc40e556..ffbe03784 100644 --- a/tests/test_security_api_key_header_description.py +++ b/tests/test_security_api_key_header_description.py @@ -24,42 +24,6 @@ def read_current_user(current_user: User = Depends(get_current_user)): client = TestClient(app) -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": { - "key": { - "type": "apiKey", - "name": "key", - "in": "header", - "description": "An API Key Header", - } - } - }, -} - - -def test_openapi_schema(): - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - def test_security_api_key(): response = client.get("/users/me", headers={"key": "secret"}) @@ -90,13 +54,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": { + "key": { "type": "apiKey", "name": "key", "in": "header", diff --git a/tests/test_security_api_key_header_optional.py b/tests/test_security_api_key_header_optional.py index 674cdaa30..79f553caa 100644 --- a/tests/test_security_api_key_header_optional.py +++ b/tests/test_security_api_key_header_optional.py @@ -30,35 +30,6 @@ def read_current_user(current_user: Optional[User] = Depends(get_current_user)): client = TestClient(app) -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "header"}} - }, -} - - -def test_openapi_schema(): - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - def test_security_api_key(): response = client.get("/users/me", headers={"key": "secret"}) @@ -89,13 +60,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyHeader": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"} + "key": {"type": "apiKey", "name": "key", "in": "header"} } }, } diff --git a/tests/test_security_api_key_query.py b/tests/test_security_api_key_query.py index c0d99aaf3..fcfde8308 100644 --- a/tests/test_security_api_key_query.py +++ b/tests/test_security_api_key_query.py @@ -24,35 +24,6 @@ def read_current_user(current_user: User = Depends(get_current_user)): client = TestClient(app) -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "query"}} - }, -} - - -def test_openapi_schema(): - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - def test_security_api_key(): response = client.get("/users/me?key=secret") @@ -83,13 +54,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"} + "key": {"type": "apiKey", "name": "key", "in": "query"} } }, } diff --git a/tests/test_security_api_key_query_description.py b/tests/test_security_api_key_query_description.py index b5a977f31..98000e266 100644 --- a/tests/test_security_api_key_query_description.py +++ b/tests/test_security_api_key_query_description.py @@ -24,42 +24,6 @@ def read_current_user(current_user: User = Depends(get_current_user)): client = TestClient(app) -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": { - "key": { - "type": "apiKey", - "name": "key", - "in": "query", - "description": "API Key Query", - } - } - }, -} - - -def test_openapi_schema(): - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - def test_security_api_key(): response = client.get("/users/me?key=secret") @@ -90,13 +54,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": { + "key": { "type": "apiKey", "name": "key", "in": "query", diff --git a/tests/test_security_api_key_query_optional.py b/tests/test_security_api_key_query_optional.py index a97df1bd7..4862a9657 100644 --- a/tests/test_security_api_key_query_optional.py +++ b/tests/test_security_api_key_query_optional.py @@ -30,35 +30,6 @@ def read_current_user(current_user: Optional[User] = Depends(get_current_user)): client = TestClient(app) -openapi_schema = { - "openapi": "3.0.2", - "info": {"title": "FastAPI", "version": "0.1.0"}, - "paths": { - "/users/me": { - "get": { - "responses": { - "200": { - "description": "Successful Response", - "content": {"application/json": {"schema": {}}}, - } - }, - "summary": "Read Current User", - "operationId": "read_current_user_users_me_get", - "security": [{"key": []}], - } - } - }, - "components": { - "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "query"}} - }, -} - - -def test_openapi_schema(): - response = client.get("/openapi.json") - assert response.status_code == 200, response.text - assert response.json() == openapi_schema - def test_security_api_key(): response = client.get("/users/me?key=secret") @@ -89,13 +60,13 @@ def test_openapi_schema(): }, "summary": "Read Current User", "operationId": "read_current_user_users_me_get", - "security": [{"APIKeyQuery": []}], + "security": [{"key": []}], } } }, "components": { "securitySchemes": { - "APIKeyQuery": {"type": "apiKey", "name": "key", "in": "query"} + "key": {"type": "apiKey", "name": "key", "in": "query"} } }, } From c4ba08fbf26fd96cafe389951598c66328a73c5d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 6 Jun 2023 22:46:52 +0000 Subject: [PATCH 5/6] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20for?= =?UTF-8?q?mat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/test_security_api_key_query.py | 4 +--- tests/test_security_api_key_query_optional.py | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/tests/test_security_api_key_query.py b/tests/test_security_api_key_query.py index fcfde8308..497fcd34e 100644 --- a/tests/test_security_api_key_query.py +++ b/tests/test_security_api_key_query.py @@ -59,8 +59,6 @@ def test_openapi_schema(): } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "query"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "query"}} }, } diff --git a/tests/test_security_api_key_query_optional.py b/tests/test_security_api_key_query_optional.py index 4862a9657..40dafe5cd 100644 --- a/tests/test_security_api_key_query_optional.py +++ b/tests/test_security_api_key_query_optional.py @@ -65,8 +65,6 @@ def test_openapi_schema(): } }, "components": { - "securitySchemes": { - "key": {"type": "apiKey", "name": "key", "in": "query"} - } + "securitySchemes": {"key": {"type": "apiKey", "name": "key", "in": "query"}} }, } From 587d42a39060b26857e0135a67e40288d5476f77 Mon Sep 17 00:00:00 2001 From: "bilal.alpaslan" Date: Wed, 18 Oct 2023 21:24:39 +0300 Subject: [PATCH 6/6] update openapi version --- tests/test_security_api_key_multiple_header.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_security_api_key_multiple_header.py b/tests/test_security_api_key_multiple_header.py index c6b4b5fc1..b976da824 100644 --- a/tests/test_security_api_key_multiple_header.py +++ b/tests/test_security_api_key_multiple_header.py @@ -38,7 +38,7 @@ def read_current_user_another_key( client = TestClient(app) openapi_schema = { - "openapi": "3.0.2", + "openapi": "3.1.0", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { "/users/me": {