Use mock auth service in tests

Author: JBorrow

soauth/service/mock.py

@@ -0,0 +1,73 @@
+"""
+The mock Auth Provider, used for testing.
+"""
+
+from sqlalchemy.ext.asyncio import AsyncSession
+from structlog.typing import FilteringBoundLogger
+
+from soauth.config.settings import Settings
+from soauth.database.login import LoginRequest
+from soauth.database.user import User
+from soauth.service import user as user_service
+from soauth.service.provider import AuthProvider, BaseLoginError
+
+
+class MockLoginError(BaseLoginError):
+    pass
+
+
+class MockProvider(AuthProvider):
+    name = "mock"
+
+    user_name: str
+    full_name: str
+    email: str
+    grants: str
+
+    def __init__(self, user_name: str, full_name: str, email: str, grants: str):
+        self.user_name = user_name
+        self.full_name = full_name
+        self.email = email
+        self.grants = grants
+
+    async def redirect(self, login_request: LoginRequest, settings: Settings) -> str:
+        # Does not make sense for the mock provider
+        raise NotImplementedError
+
+    async def login(
+        self,
+        code: str,
+        settings: Settings,
+        conn: AsyncSession,
+        log: FilteringBoundLogger,
+    ) -> User:
+        try:
+            user = await user_service.read_by_name(user_name=self.user_name, conn=conn)
+        except user_service.UserNotFound:
+            user = await user_service.create_user(
+                user_name=self.user_name,
+                email=self.email,
+                full_name=self.email,
+                grants=self.grants,
+                conn=conn,
+                log=log,
+            )
+
+        conn.add(user)
+
+        return user
+
+    async def refresh(
+        self,
+        user: User,
+        settings: Settings,
+        conn: AsyncSession,
+        log: FilteringBoundLogger,
+    ) -> User:
+        user.full_name = self.full_name
+        user.email = self.email
+        user.grants = self.grants
+
+        conn.add(user)
+
+        return user

tests/test_service/conftest.py

@@ -8,6 +8,7 @@
 from soauth.config.settings import Settings
 from soauth.service import app as app_service
 from soauth.service import user as user_service
+from soauth.service.mock import MockProvider
 
 
 @pytest_asyncio.fixture(scope="session")
@@ -70,3 +71,14 @@ async def app(session_manager, logger, user, server_settings):
                 conn=conn,
                 log=logger,
             )
+
+
+@pytest_asyncio.fixture(scope="session")
+async def provider():
+    # Same as `user`
+    yield MockProvider(
+        user_name="admin",
+        email="admin@simonsobservatory.org",
+        full_name="Admin User",
+        grants="admin",
+    )

tests/test_service/test_flow.py

@@ -12,7 +12,7 @@
 
 @pytest.mark.asyncio(loop_scope="session")
 async def test_primary_then_secondary(
-    user, app, logger, server_settings, session_manager
+    user, app, logger, server_settings, session_manager, provider
 ):
     async with session_manager.session() as conn:
         async with conn.begin():
@@ -50,6 +50,7 @@ async def test_primary_then_secondary(
                 settings=server_settings,
                 conn=conn,
                 log=logger,
+                provider=provider,
             )
 
             auth = key_content.access_token

tests/test_service/test_refresh.py

@@ -11,7 +11,9 @@
 
 
 @pytest.mark.asyncio(loop_scope="session")
-async def test_create_refresh_key(user, app, session_manager, logger, server_settings):
+async def test_create_refresh_key(
+    user, app, session_manager, logger, server_settings, provider
+):
     async with session_manager.session() as conn:
         async with conn.begin():
             encoded, refresh_key = await refresh_service.create_refresh_key(
@@ -60,7 +62,11 @@ async def test_create_refresh_key(user, app, session_manager, logger, server_set
                     encoded_payload=encoded, conn=conn
                 )
                 await refresh_service.refresh_refresh_key(
-                    payload=decoded, settings=server_settings, conn=conn, log=logger
+                    payload=decoded,
+                    settings=server_settings,
+                    conn=conn,
+                    log=logger,
+                    provider=provider,
                 )
 
     # Now let's refresh our new refresh key.
@@ -73,7 +79,11 @@ async def test_create_refresh_key(user, app, session_manager, logger, server_set
                 refreshed_encoded,
                 refreshed_refresh_key,
             ) = await refresh_service.refresh_refresh_key(
-                payload=decoded, settings=server_settings, conn=conn, log=logger
+                payload=decoded,
+                settings=server_settings,
+                conn=conn,
+                log=logger,
+                provider=provider,
             )
             REFRESHED_KEY_ID = refreshed_refresh_key.refresh_key_id
             assert refreshed_refresh_key.previous == NEW_REFRESH_KEY_ID