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

Reduce test flakiness #389

Merged
merged 1 commit into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 19 additions & 3 deletions fixbackend/auth/user_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ def __init__(
self.workspace_repository = workspace_repository
self.domain_events_publisher = domain_events_publisher
self.invitation_repository = invitation_repository
self.custom_password_helper = password_helper is not None
self.otp_valid_window = 1

def parse_id(self, value: Any) -> UserId:
if isinstance(value, UUID):
Expand Down Expand Up @@ -219,6 +221,12 @@ async def oauth_associate_callback(
return user

async def compute_recovery_codes(self) -> Tuple[list[str], list[str]]:
# use custom password helper if provided, e.g. for testing
if self.custom_password_helper:
recovery_codes = [secrets.token_hex(16) for _ in range(10)]
hashes = [self.password_helper.hash(code) for code in recovery_codes]
return recovery_codes, hashes

# create recovery codes
recovery_codes = [secrets.token_hex(16) for _ in range(10)]
# create hashes of the recovery codes
Expand Down Expand Up @@ -246,7 +254,7 @@ async def recreate_mfa(self, user: User) -> OTPConfig:

async def enable_mfa(self, user: User, otp: str) -> bool:
assert not user.is_mfa_active, "User already has MFA enabled."
if (secret := user.otp_secret) and not pyotp.TOTP(secret).verify(otp, valid_window=1):
if (secret := user.otp_secret) and not pyotp.TOTP(secret).verify(otp, valid_window=self.otp_valid_window):
return False
await self.user_repository.update(user, {"is_mfa_active": True})
return True
Expand All @@ -263,15 +271,23 @@ async def check_otp(self, user: User, otp: Optional[str], recovery_code: Optiona
if not user.is_mfa_active:
return True
if (secret := user.otp_secret) and (otp_defined := otp):
return pyotp.TOTP(secret).verify(otp_defined)
return pyotp.TOTP(secret).verify(otp_defined, valid_window=self.otp_valid_window)
if recovery_code:
return await self.user_repository.delete_recovery_code(user.id, recovery_code, self.password_helper)
return False


def get_password_helper() -> PasswordHelperProtocol | None:
return None


PasswordHelperDependency = Annotated[PasswordHelperProtocol | None, Depends(get_password_helper)]


async def get_user_manager(
config: ConfigDependency,
user_repository: UserRepositoryDependency,
password_helper: PasswordHelperDependency,
user_verifier: AuthEmailSenderDependency,
workspace_repository: WorkspaceRepositoryDependency,
domain_event_publisher: DomainEventPublisherDependency,
Expand All @@ -280,7 +296,7 @@ async def get_user_manager(
yield UserManager(
config,
user_repository,
None,
password_helper,
user_verifier,
workspace_repository,
domain_event_publisher,
Expand Down
14 changes: 6 additions & 8 deletions tests/fixbackend/auth/router_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

import os
from typing import Callable, List, Optional, Sequence, Tuple, override

import jwt
Expand All @@ -27,6 +26,7 @@
from fixbackend.auth.models import User
from fixbackend.auth.models.orm import UserMFARecoveryCode
from fixbackend.auth.schemas import OTPConfig
from fixbackend.auth.user_manager import get_password_helper
from fixbackend.auth.user_repository import UserRepository
from fixbackend.auth.user_verifier import AuthEmailSender, get_auth_email_sender
from fixbackend.domain_events.dependencies import get_domain_event_publisher
Expand All @@ -38,7 +38,7 @@
from fixbackend.workspaces.invitation_repository import InvitationRepository, get_invitation_repository
from fixbackend.workspaces.models import WorkspaceInvitation
from fixbackend.workspaces.repository import WorkspaceRepository
from tests.fixbackend.conftest import InMemoryDomainEventPublisher
from tests.fixbackend.conftest import InMemoryDomainEventPublisher, InsecureFastPasswordHelper
from fixbackend.certificates.cert_store import CertificateStore


Expand Down Expand Up @@ -122,16 +122,14 @@ async def remove_roles(


@pytest.mark.asyncio
@pytest.mark.skipif(
os.getenv("LOCAL_DEV_ENV") is not None, reason="Skipping in local dev environment for performance reasons."
)
async def test_registration_flow(
api_client: AsyncClient,
fast_api: FastAPI,
domain_event_sender: InMemoryDomainEventPublisher,
workspace_repository: WorkspaceRepository,
user_repository: UserRepository,
cert_store: CertificateStore,
password_helper: InsecureFastPasswordHelper,
) -> None:
verifier = InMemoryVerifier()
invitation_repo = InMemoryInvitationRepo()
Expand All @@ -140,6 +138,7 @@ async def test_registration_flow(
fast_api.dependency_overrides[get_domain_event_publisher] = lambda: domain_event_sender
fast_api.dependency_overrides[get_invitation_repository] = lambda: invitation_repo
fast_api.dependency_overrides[get_role_repository] = lambda: role_repo
fast_api.dependency_overrides[get_password_helper] = lambda: password_helper

registration_json = {
"email": "[email protected]",
Expand Down Expand Up @@ -214,14 +213,12 @@ async def test_registration_flow(


@pytest.mark.asyncio
@pytest.mark.skipif(
os.getenv("LOCAL_DEV_ENV") is not None, reason="Skipping in local dev environment for performance reasons."
)
async def test_mfa_flow(
api_client: AsyncClient,
fast_api: FastAPI,
domain_event_sender: InMemoryDomainEventPublisher,
user_repository: UserRepository,
password_helper: InsecureFastPasswordHelper,
) -> None:
verifier = InMemoryVerifier()
invitation_repo = InMemoryInvitationRepo()
Expand All @@ -230,6 +227,7 @@ async def test_mfa_flow(
fast_api.dependency_overrides[get_domain_event_publisher] = lambda: domain_event_sender
fast_api.dependency_overrides[get_invitation_repository] = lambda: invitation_repo
fast_api.dependency_overrides[get_role_repository] = lambda: role_repo
fast_api.dependency_overrides[get_password_helper] = lambda: password_helper

# register user
registration_json = {"email": "[email protected]", "password": "changeme"}
Expand Down
22 changes: 22 additions & 0 deletions tests/fixbackend/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.

import asyncio
import hashlib
import json
import os
from argparse import Namespace
from asyncio import AbstractEventLoop
from datetime import datetime, timezone
from pathlib import Path
import random
from typing import Any, AsyncIterator, Awaitable, Callable, Dict, Iterator, List, Sequence, Tuple, Optional
from unittest.mock import patch

Expand All @@ -39,6 +41,7 @@
from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, create_async_engine
from sqlalchemy_utils import create_database, database_exists, drop_database

from fastapi_users.password import PasswordHelper
from fixbackend.analytics import AnalyticsEventSender
from fixbackend.analytics.events import AnalyticsEvent
from fixbackend.app import fast_api_app
Expand Down Expand Up @@ -688,6 +691,25 @@
return CertificateStore(default_config)


class InsecureFastPasswordHelper(PasswordHelper):
def __init__(self) -> None:
pass

def verify_and_update(self, plain_password: str, hashed_password: str) -> Tuple[bool, str]:
return hashed_password == hashlib.md5(plain_password.encode()).hexdigest(), hashed_password
github-advanced-security[bot] marked this conversation as resolved.
Dismissed
Show resolved Hide resolved

def hash(self, password: str) -> str:
return hashlib.md5(password.encode()).hexdigest()
github-advanced-security[bot] marked this conversation as resolved.
Dismissed
Show resolved Hide resolved

def generate(self) -> str:
return str(random.randint(100000, 999999))


@pytest.fixture
def password_helper() -> InsecureFastPasswordHelper:
return InsecureFastPasswordHelper()


@pytest.fixture
async def fix_deps(
db_engine: AsyncEngine,
Expand Down
Loading