Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

Revision fc7747df7177f2f610c55c9709a81e7b0b618806 authored by Jochen Kupperschmidt on 03 January 2026, 00:21:02 UTC, committed by Jochen Kupperschmidt on 03 January 2026, 00:21:02 UTC
Display only language icon on CozyLAN locale selector dropdown button
1 parent 2e587a4
  • Files
  • Changes
  • 86abe66
  • /
  • tests
  • /
  • helpers
  • /
  • __init__.py
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • revision
  • directory
  • content
revision badge
swh:1:rev:fc7747df7177f2f610c55c9709a81e7b0b618806
directory badge
swh:1:dir:57955b01a30e11f12d2af123b163d90bfc1e363b
content badge
swh:1:cnt:d041c9d371e4033e65a2c3924aa800db4030c6f5

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • revision
  • directory
  • content
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
__init__.py
"""
tests.helpers
~~~~~~~~~~~~~

:Copyright: 2014-2025 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from collections.abc import Iterable
from contextlib import contextmanager
from datetime import date, datetime
from secrets import token_hex
from uuid import UUID

from babel import Locale
from flask import appcontext_pushed, g
from secret_type import secret
from uuid6 import uuid7

from byceps.byceps_app import BycepsApp
from byceps.database import db
from byceps.services.authn.session import authn_session_repository
from byceps.services.authn.session.models import CurrentUser
from byceps.services.authz import authz_service
from byceps.services.authz.models import PermissionID, RoleID
from byceps.services.board.models import BoardID
from byceps.services.brand.models import Brand, BrandID
from byceps.services.party import party_service
from byceps.services.party.models import Party, PartyID
from byceps.services.shop.storefront.models import StorefrontID
from byceps.services.site import site_service
from byceps.services.site.models import SiteID
from byceps.services.user import (
    user_command_service,
    user_creation_service,
    user_service,
)
from byceps.services.user.models.user import User, UserID


def generate_token(n: int = 4) -> str:
    return token_hex(n)


def generate_uuid() -> UUID:
    return uuid7()


@contextmanager
def current_user_set(app: BycepsApp, current_user: CurrentUser):
    def handler(sender, **kwargs):
        g.user = current_user

    with appcontext_pushed.connected_to(handler, app):
        yield


DEFAULT_DATE_OF_BIRTH = date(1993, 2, 15)


def create_user(
    screen_name: str | None = '__random__',
    *,
    email_address: str | None = None,
    email_address_verified: bool = False,
    initialized: bool = True,
    suspended: bool = False,
    deleted: bool = False,
    locale: Locale | None = None,
    legacy_id: str | None = None,
    first_name: str | None = 'John Joseph',
    last_name: str | None = 'Doe',
    date_of_birth=DEFAULT_DATE_OF_BIRTH,
    country: str | None = 'State of Mind',
    postal_code: str | None = '31337',
    city: str | None = 'Atrocity',
    street: str | None = 'Elite Street 1337',
    phone_number: str | None = '555-CALL-ME-MAYBE',
    password: str = 'hunter2',
) -> User:
    if screen_name == '__random__':
        screen_name = generate_token(8)

    if not email_address:
        email_address = f'user{generate_token(6)}@users.test'

    user, _ = user_creation_service.create_user(
        screen_name,
        email_address,
        secret(password),
        locale=locale,
        legacy_id=legacy_id,
        first_name=first_name,
        last_name=last_name,
        date_of_birth=date_of_birth,
        country=country,
        postal_code=postal_code,
        city=city,
        street=street,
        phone_number=phone_number,
    ).unwrap()

    if initialized:
        user_command_service.initialize_account(user, assign_roles=False)

    if email_address_verified or suspended or deleted:
        db_user = user_service.get_db_user(user.id)
        db_user.email_address_verified = email_address_verified
        db_user.suspended = suspended
        db_user.deleted = deleted
        db.session.commit()

    updated_user = user_service.get_user(user.id)

    return updated_user


def create_role_with_permissions_assigned(
    role_id: RoleID, permission_ids: Iterable[PermissionID]
) -> None:
    role = authz_service.create_role(role_id, role_id).unwrap()

    for permission_id in permission_ids:
        authz_service.assign_permission_to_role(permission_id, role.id)


def create_party(
    brand: Brand,
    party_id: PartyID | None = None,
    title: str | None = None,
    *,
    max_ticket_quantity: int | None = None,
) -> Party:
    if party_id is None:
        party_id = PartyID(generate_token())

    if title is None:
        title = generate_token()

    starts_at = datetime(2014, 10, 24, 16, 0)
    ends_at = datetime(2014, 10, 26, 13, 0)

    return party_service.create_party(
        party_id,
        brand,
        title,
        starts_at,
        ends_at,
        max_ticket_quantity=max_ticket_quantity,
    )


def create_site(
    site_id: SiteID,
    brand_id: BrandID,
    *,
    title: str | None = None,
    server_name: str | None = None,
    enabled: bool = True,
    user_account_creation_enabled: bool = True,
    login_enabled: bool = True,
    party_id: PartyID | None = None,
    board_id: BoardID | None = None,
    storefront_id: StorefrontID | None = None,
    is_intranet: bool = False,
):
    if title is None:
        title = site_id

    if server_name is None:
        server_name = f'{site_id}.test'

    return site_service.create_site(
        site_id,
        title,
        server_name,
        brand_id,
        enabled=enabled,
        user_account_creation_enabled=user_account_creation_enabled,
        login_enabled=login_enabled,
        party_id=party_id,
        board_id=board_id,
        storefront_id=storefront_id,
        is_intranet=is_intranet,
    )


@contextmanager
def http_client(app: BycepsApp, *, user_id: UserID | None = None):
    """Provide an HTTP client.

    If a user ID is given, the client authenticates with the user's
    credentials.
    """
    client = app.test_client()

    if user_id is not None:
        _add_user_credentials_to_session(client, user_id)

    yield client


def _add_user_credentials_to_session(client, user_id: UserID) -> None:
    session_token = authn_session_repository.find_session_token_for_user(
        user_id
    )
    if session_token is None:
        raise Exception(f'Could not find session token for user ID "{user_id}"')

    with client.session_transaction() as session:
        session['user_id'] = str(user_id)
        session['user_auth_token'] = str(session_token.token)


def log_in_user(user_id: UserID) -> None:
    """Authenticate the user to create a session."""
    authn_session_repository.get_session_token(user_id)
The diff you're trying to view is too large. Only the first 1000 changed files have been loaded.
Showing with 0 additions and 0 deletions (0 / 0 diffs computed)
swh spinner

Computing file changes ...

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API