Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changing query filters from list of tuples to dict #37

Merged
merged 25 commits into from
Nov 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
179a3c9
[enhancement] Changing query filters from list of tuples to dict
martin1tab Nov 15, 2020
594a90e
Merge branch 'master' into Issue28
martin1tab Nov 15, 2020
3116e7d
Add test for getCurrentUser
martin1tab Nov 16, 2020
0aedd8b
Add test for getCurrentUser
martin1tab Nov 16, 2020
dcbcc5b
Merge branch 'Issue28' of github.com:martin1tab/pyronear-api into Iss…
martin1tab Nov 16, 2020
f12c754
Fix some issues
martin1tab Nov 16, 2020
faa9c38
Fix Flake8 issues
martin1tab Nov 16, 2020
103c84a
Add test for getCurrentUser
martin1tab Nov 16, 2020
08f5554
Fix some issues
martin1tab Nov 16, 2020
0ec8dbd
Fix Flake8 issues
martin1tab Nov 16, 2020
62218a6
Merge branch 'Issue28' of github.com:martin1tab/pyronear-api into Iss…
martin1tab Nov 16, 2020
eaa3a6d
Fix static code analysis issues
martin1tab Nov 16, 2020
4e5500d
Fix static code checks issues
martin1tab Nov 16, 2020
1a8c773
Some more static checks errors
martin1tab Nov 16, 2020
761fa29
Add test get_current_device
martin1tab Nov 16, 2020
16d07f6
Pull changes from master and fix conflicts
martin1tab Nov 18, 2020
d9cf261
Fix merge conflicts
martin1tab Nov 18, 2020
4922ee0
Fix Flake8 issues
martin1tab Nov 18, 2020
0d1f469
Fix merge conflicts
martin1tab Nov 18, 2020
48af58b
Merge branch 'master' into Issue28
martin1tab Nov 18, 2020
031fd09
Fix Merge conflicts
martin1tab Nov 18, 2020
1da7ccb
Handle comments
martin1tab Nov 18, 2020
4f831b8
Refactor tests_deps
martin1tab Nov 20, 2020
d0796c7
Merge branch 'master' into Issue28
martin1tab Nov 20, 2020
9192c4d
add output type:
martin1tab Nov 20, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/app/api/crud.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ async def get(entry_id: int, table: Table) -> Dict[str, Any]:
return await database.fetch_one(query=query)


async def fetch_all(table: Table, query_filters: Optional[List[Tuple[str, Any]]] = None) -> List[Dict[str, Any]]:
async def fetch_all(table: Table, query_filters: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
query = table.select()
if isinstance(query_filters, list):
for query_filter in query_filters:
query = query.where(getattr(table.c, query_filter[0]) == query_filter[1])
if isinstance(query_filters, dict):
for query_filter_key, query_filter_value in query_filters.items():
query = query.where(getattr(table.c, query_filter_key) == query_filter_value)
return await database.fetch_all(query=query)


async def fetch_one(table: Table, query_filters: List[Tuple[str, Any]]) -> Dict[str, Any]:
async def fetch_one(table: Table, query_filters: Dict[str, Any]) -> Dict[str, Any]:
query = table.select()
for query_filter in query_filters:
query = query.where(getattr(table.c, query_filter[0]) == query_filter[1])
for query_filter_key, query_filter_value in query_filters.items():
query = query.where(getattr(table.c, query_filter_key) == query_filter_value)
return await database.fetch_one(query=query)


Expand Down
7 changes: 3 additions & 4 deletions src/app/api/deps.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def unauthorized_exception(detail: str, authenticate_value: str) -> HTTPExceptio


async def get_current_access(security_scopes: SecurityScopes, token: str = Depends(reusable_oauth2)) -> AccessRead:
"""Dependency to use as fastapi.security.Security with scopes.
""" Dependency to use as fastapi.security.Security with scopes.

>>> @app.get("/users/me")
>>> async def read_users_me(current_user: User = Security(get_current_access, scopes=["me"])):
Expand Down Expand Up @@ -63,16 +63,15 @@ async def get_current_access(security_scopes: SecurityScopes, token: str = Depen


async def get_current_user(access: AccessRead = Depends(get_current_access)) -> UserRead:
user = await crud.fetch_one(users, [('access_id', access.id)])

user = await crud.fetch_one(users, {'access_id': access.id})
if user is None:
raise HTTPException(status_code=400, detail="Permission denied")

return UserRead(**user)


async def get_current_device(access: AccessRead = Depends(get_current_access)) -> DeviceOut:
device = await crud.fetch_one(devices, [('access_id', access.id)])
device = await crud.fetch_one(devices, {'access_id': access.id})
if device is None:
raise HTTPException(status_code=400, detail="Permission denied")

Expand Down
2 changes: 1 addition & 1 deletion src/app/api/routes/accesses.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

async def post_access(login: str, password: str, scopes: str) -> AccessRead:
# Check that the login does not already exist
if await crud.fetch_one(accesses, [('login', login)]) is not None:
if await crud.fetch_one(accesses, {'login': login}) is not None:
raise HTTPException(
status_code=400,
detail=f"An entry with login='{login}' already exists.",
Expand Down
4 changes: 2 additions & 2 deletions src/app/api/routes/devices.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ async def delete_device(device_id: int = Path(..., gt=0), _=Security(get_current

@router.get("/my-devices", response_model=List[DeviceOut])
async def fetch_my_devices(me: UserRead = Security(get_current_user, scopes=["admin", "me"])):
return await crud.fetch_all(devices, [("owner_id", me.id)])
return await crud.fetch_all(devices, {"owner_id": me.id})


@router.put("/heartbeat", response_model=DeviceOut)
Expand All @@ -57,7 +57,7 @@ async def update_device_location(
user: UserRead = Security(get_current_user, scopes=["admin", "me"])
):
# Check that device is accessible to this user
entry = await crud.fetch_one(devices, [("id", device_id), ("owner_id", user.id)])
entry = await crud.fetch_one(devices, {"id": device_id, "owner_id": user.id})
if entry is None:
raise HTTPException(
status_code=400,
Expand Down
2 changes: 1 addition & 1 deletion src/app/api/routes/login.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
@router.post("/access-token", response_model=Token)
async def create_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
# Verify credentials
entry = await crud.fetch_one(accesses, [('login', form_data.username)])
entry = await crud.fetch_one(accesses, {'login': form_data.username})
if entry is None or not await security.verify_password(form_data.password, entry['hashed_password']):
raise HTTPException(status_code=400, detail="Invalid credentials")
# create access token using user user_id/user_scopes
Expand Down
4 changes: 2 additions & 2 deletions src/tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ async def mock_fetch_all(table, query_filters=None):
return table
response = []
for entry in table:
if all(entry[k] == v for k, v in query_filters):
if all(entry[k] == v for k, v in query_filters.items()):
response.append(entry)
return response


async def mock_fetch_one(table, query_filters=None):
for entry in table:
if all(entry[k] == v for k, v in query_filters):
if all(entry[k] == v for k, v in query_filters.items()):
return entry
return None

Expand Down
50 changes: 50 additions & 0 deletions src/tests/test_deps.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import pytest

from app.api import crud, deps
from app.api.schemas import AccessRead, UserRead, DeviceOut
from copy import deepcopy

USER_TABLE = [
{"id": 1, "login": "first_user", "access_id": 1, "created_at": "2020-10-13T08:18:45.447773"},
{"id": 99, "login": "connected_user", "access_id": 2, "created_at": "2020-11-13T08:18:45.447773"},
]

DEVICE_TABLE = [
{"id": 1, "login": "first_device", "owner_id": 1, "access_id": 1, "specs": "v0.1", "elevation": None, "lat": None,
"lon": None, "yaw": None, "pitch": None, "last_ping": None, "created_at": "2020-10-13T08:18:45.447773"},
{"id": 2, "login": "second_device", "owner_id": 99, "access_id": 2, "specs": "v0.1", "elevation": None, "lat": None,
"lon": None, "yaw": None, "pitch": None, "last_ping": None, "created_at": "2020-10-13T08:18:45.447773"},
{"id": 99, "login": "connected_device", "owner_id": 1, "access_id": 3, "specs": "raspberry", "elevation": None,
"lat": None, "lon": None, "yaw": None, "pitch": None, "last_ping": None,
"created_at": "2020-10-13T08:18:45.447773"},
]


def _patch_session(monkeypatch, mock_user_table=None, mock_device_table=None):
# DB patching
if mock_user_table is not None:
monkeypatch.setattr(deps, "users", mock_user_table)
if mock_device_table is not None:
monkeypatch.setattr(deps, "devices", mock_device_table)
# Sterilize all DB interactions through CRUD override
monkeypatch.setattr(crud, "fetch_one", pytest.mock_fetch_one)


@pytest.mark.asyncio
async def test_get_current_user(test_app, monkeypatch):

mock_user_table = deepcopy(USER_TABLE)
_patch_session(monkeypatch, mock_user_table, None)

response = await deps.get_current_user(AccessRead(id=1, login="JohnDoe", scopes="me"))
assert response == UserRead(**mock_user_table[0])


@pytest.mark.asyncio
async def test_get_current_device(test_app, monkeypatch):

mock_device_table = deepcopy(DEVICE_TABLE)
_patch_session(monkeypatch, None, mock_device_table)

response = await deps.get_current_device(AccessRead(id=1, login="JohnDoe", scopes="me"))
assert response == DeviceOut(**mock_device_table[0])