tests/unit_tests: update user related tests

Integrate `mongomock_motor` package to mock
async mongo client for Beanie initialization.
Add fixture to initialize Beanie on app startup.
Remove fixtures and add methods to get current active user.
Update `app.dependency_overrides` dictionary to mock
dependency callable from `fastapi-users` to get users
while creating `TestClient`.
Update all the tests accordingly.

Signed-off-by: Jeny Sadadia <[email protected]>

docker/api/requirements-tests.txt

@@ -6,3 +6,4 @@ pytest-dependency==0.5.1
 pytest-mock==3.6.1
 pytest-order==1.0.1
 httpx==0.23.3
+mongomock_motor==0.0.21

tests/unit_tests/conftest.py

@@ -15,9 +15,18 @@
 import fakeredis.aioredis
 from fastapi.testclient import TestClient
 import pytest
-
-from api.main import app
-from api.models import User, UserGroup, UserProfile
+from mongomock_motor import AsyncMongoMockClient
+from beanie import init_beanie
+from fastapi import Request, HTTPException, status
+
+from api.main import (
+    app,
+    versioned_app,
+    get_current_user,
+    get_current_superuser,
+)
+from api.models import UserGroup
+from api.user_models import User
 from api.pubsub import PubSub
 
 BEARER_TOKEN = "Bearer \
@@ -36,7 +45,10 @@
 @pytest.fixture
 def test_client():
     """Fixture to get FastAPI Test client instance"""
-    with TestClient(app=app, base_url=BASE_URL) as client:
+    # Mock dependency callables for getting current user
+    app.dependency_overrides[get_current_user] = mock_get_current_user
+    app.dependency_overrides[get_current_superuser] = mock_get_current_admin_user
+    with TestClient(app=versioned_app, base_url=BASE_URL) as client:
         return client
 
 
@@ -117,46 +129,47 @@ def mock_db_find_one_by_attributes(mocker):
     return async_mock
 
 
-@pytest.fixture
-def mock_get_current_user(mocker):
+def mock_get_current_user(request: Request):
     """
-    Mocks async call to Authentication class method
-    used to get current user
+    Get current active user
     """
-    async_mock = AsyncMock()
-    profile = UserProfile(
+    token = request.headers.get('authorization')
+    if not token:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Missing token",
+        )
+    return User(
         username='bob',
         hashed_password='$2b$12$CpJZx5ooxM11bCFXT76/z.o6HWs2sPJy4iP8.'
                         'xCZGmM8jWXUXJZ4K',
-        email='[email protected]'
+        email='[email protected]',
+        is_active=True,
+        is_superuser=False,
+        is_verified=True
     )
-    user = User(profile=profile, active=True)
-    mocker.patch('api.auth.Authentication.get_current_user',
-                 side_effect=async_mock)
-    async_mock.return_value = user, None
-    return async_mock
 
 
-@pytest.fixture
-def mock_get_current_admin_user(mocker):
+def mock_get_current_admin_user(request: Request):
     """
-    Mocks async call to Authentication class method
-    used to get current user
+    Get current active admin user
     """
-    async_mock = AsyncMock()
-    profile = UserProfile(
+    token = request.headers.get('authorization')
+    if not token:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Missing token",
+        )
+    return User(
         username='admin',
         hashed_password='$2b$12$CpJZx5ooxM11bCFXT76/z.o6HWs2sPJy4iP8.'
                         'xCZGmM8jWXUXJZ4K',
         email='[email protected]',
-        groups=[UserGroup(name='admin')])
-    user = User(
-        profile=profile,
-        active=True)
-    mocker.patch('api.auth.Authentication.get_current_user',
-                 side_effect=async_mock)
-    async_mock.return_value = user, None
-    return async_mock
+        groups=[UserGroup(name='admin')],
+        is_active=True,
+        is_superuser=True,
+        is_verified=True
+    )
 
 
 @pytest.fixture(autouse=True)
@@ -238,3 +251,15 @@ def mock_unsubscribe(mocker):
     mocker.patch('api.pubsub.PubSub.unsubscribe',
                  side_effect=async_mock)
     return async_mock
+
+
+@pytest.fixture(autouse=True)
+async def mock_init_beanie(mocker):
+    """Mocks async call to Database method to initialize Beanie"""
+    async_mock = AsyncMock()
+    client = AsyncMongoMockClient()
+    init = await init_beanie(
+        document_models=[User], database=client.get_database(name="db"))
+    mocker.patch('api.db.Database.initialize_beanie',
+                 side_effect=async_mock, return_value=init)
+    return async_mock

tests/unit_tests/test_listen_handler.py

@@ -13,8 +13,7 @@
 from tests.unit_tests.conftest import BEARER_TOKEN
 
 
-def test_listen_endpoint(mock_get_current_user,
-                         mock_init_sub_id,
+def test_listen_endpoint(mock_init_sub_id,
                          mock_listen, test_client):
     """
     Test Case : Test KernelCI API GET /listen endpoint for the
@@ -34,8 +33,7 @@ def test_listen_endpoint(mock_get_current_user,
     assert response.status_code == 200
 
 
-def test_listen_endpoint_not_found(mock_get_current_user,
-                                   mock_init_sub_id, test_client):
+def test_listen_endpoint_not_found(mock_init_sub_id, test_client):
     """
     Test Case : Test KernelCI API GET /listen endpoint for the
     negative path
@@ -54,8 +52,7 @@ def test_listen_endpoint_not_found(mock_get_current_user,
     assert 'detail' in response.json()
 
 
-def test_listen_endpoint_without_token(mock_get_current_user,
-                                       test_client):
+def test_listen_endpoint_without_token(test_client):
     """
     Test Case : Test KernelCI API GET /listen endpoint for the
     negative path

tests/unit_tests/test_node_handler.py

@@ -17,8 +17,7 @@
 from api.paginator_models import PageModel
 
 
-def test_create_node_endpoint(mock_get_current_user,
-                              mock_db_create, mock_publish_cloudevent,
+def test_create_node_endpoint(mock_db_create, mock_publish_cloudevent,
                               test_client):
     """
     Test Case : Test KernelCI API /node endpoint
@@ -91,8 +90,7 @@ def test_create_node_endpoint(mock_get_current_user,
     }
 
 
-def test_get_nodes_by_attributes_endpoint(mock_get_current_user,
-                                          mock_db_find_by_attributes,
+def test_get_nodes_by_attributes_endpoint(mock_db_find_by_attributes,
                                           test_client):
     """
     Test Case : Test KernelCI API GET /nodes?attribute_name=attribute_value
@@ -159,7 +157,6 @@ def test_get_nodes_by_attributes_endpoint(mock_get_current_user,
 
 
 def test_get_nodes_by_attributes_endpoint_node_not_found(
-        mock_get_current_user,
         mock_db_find_by_attributes,
         test_client):
     """
@@ -190,7 +187,7 @@ def test_get_nodes_by_attributes_endpoint_node_not_found(
     assert response.json().get('total') == 0
 
 
-def test_get_node_by_id_endpoint(mock_get_current_user, mock_db_find_by_id,
+def test_get_node_by_id_endpoint(mock_db_find_by_id,
                                  test_client):
     """
     Test Case : Test KernelCI API GET /node/{node_id} endpoint
@@ -244,8 +241,7 @@ def test_get_node_by_id_endpoint(mock_get_current_user, mock_db_find_by_id,
     }
 
 
-def test_get_node_by_id_endpoint_empty_response(mock_get_current_user,
-                                                mock_db_find_by_id,
+def test_get_node_by_id_endpoint_empty_response(mock_db_find_by_id,
                                                 test_client):
     """
     Test Case : Test KernelCI API GET /node/{node_id} endpoint
@@ -262,7 +258,7 @@ def test_get_node_by_id_endpoint_empty_response(mock_get_current_user,
     assert response.json() is None
 
 
-def test_get_all_nodes(mock_get_current_user, mock_db_find_by_attributes,
+def test_get_all_nodes(mock_db_find_by_attributes,
                        test_client):
     """
     Test Case : Test KernelCI API GET /nodes endpoint for the
@@ -343,8 +339,7 @@ def test_get_all_nodes(mock_get_current_user, mock_db_find_by_attributes,
     assert len(response.json()) > 0
 
 
-def test_get_all_nodes_empty_response(mock_get_current_user,
-                                      mock_db_find_by_attributes,
+def test_get_all_nodes_empty_response(mock_db_find_by_attributes,
                                       test_client):
     """
     Test Case : Test KernelCI API GET /nodes endpoint for the

tests/unit_tests/test_subscribe_handler.py

@@ -11,8 +11,7 @@
 from api.pubsub import Subscription
 
 
-def test_subscribe_endpoint(mock_get_current_user,
-                            mock_subscribe, test_client):
+def test_subscribe_endpoint(mock_subscribe, test_client):
     """
     Test Case : Test KernelCI API /subscribe endpoint
     Expected Result :

tests/unit_tests/test_unsubscribe_handler.py

@@ -10,8 +10,7 @@
 from tests.unit_tests.conftest import BEARER_TOKEN
 
 
-def test_unsubscribe_endpoint(mock_get_current_user,
-                              mock_unsubscribe, test_client):
+def test_unsubscribe_endpoint(mock_unsubscribe, test_client):
     """
     Test Case : Test KernelCI API /unsubscribe endpoint positive path
     Expected Result :
@@ -26,8 +25,7 @@ def test_unsubscribe_endpoint(mock_get_current_user,
     assert response.status_code == 200
 
 
-def test_unsubscribe_endpoint_empty_response(mock_get_current_user,
-                                             test_client):
+def test_unsubscribe_endpoint_empty_response(test_client):
     """
     Test Case : Test KernelCI API /unsubscribe endpoint negative path
     Expected Result :