conftest.py

import os
from datetime import datetime, timedelta

import flask_migrate
import pytest
from sqlalchemy.orm import scoped_session, sessionmaker

from newdle.core.app import create_app
from newdle.core.db import db
from newdle.models import Newdle, Participant

TEST_DATABASE_URI = os.environ.get(
    'NEWDLE_TEST_DATABASE_URI', 'postgresql:///newdle_tests'
)


@pytest.fixture(scope='session')
def app():
    """Session-wide test `Flask` application."""
    config_override = {
        'TESTING': True,
        'SQLALCHEMY_DATABASE_URI': TEST_DATABASE_URI,
        'SERVER_NAME': 'flask.test',
        'SECRET_KEY': 'test',
        'EMAIL_BACKEND': 'newdle.vendor.django_mail.backends.locmem.EmailBackend',
    }
    app = create_app(config_override, use_env_config=False)
    ctx = app.app_context()
    ctx.push()
    yield app
    ctx.pop()


@pytest.fixture(scope='session')
def database(app):
    flask_migrate.upgrade(revision='head')
    yield
    flask_migrate.downgrade(revision='base')


@pytest.fixture
def db_session(app, database):
    """Create a new database session."""
    connection = db.engine.connect()
    transaction = connection.begin()

    options = {'bind': connection, 'binds': {}}
    session_factory = sessionmaker(**options)
    session = scoped_session(session_factory)

    db.session = session
    db.app = app

    yield session

    transaction.rollback()
    connection.close()
    session.remove()


@pytest.fixture
def mail_queue():
    from newdle.vendor import django_mail

    django_mail.outbox = []
    return django_mail.outbox


@pytest.fixture
def flask_client(app):
    return app.test_client()


@pytest.fixture
def cli_runner(app):
    return app.test_cli_runner()


@pytest.fixture
def dummy_uid():
    return 'user123'


@pytest.fixture
def dummy_participant_uid():
    return 'pig'


@pytest.fixture
def create_newdle(dummy_uid, db_session):
    """Return a callable which lets you create dummy newdles."""

    def _create_newdle(id=None, **kwargs):
        kwargs.setdefault(
            'participants',
            {
                Participant(
                    code=f'part1{id}' if id is not None else 'part1',
                    name='Guinea Pig',
                    email='example@example.com',
                    auth_uid='pig',
                ),
            },
        )
        kwargs.setdefault(
            'timeslots',
            [
                datetime(2019, 9, 11, 13, 0),
                datetime(2019, 9, 11, 14, 0),
                datetime(2019, 9, 12, 13, 0),
                datetime(2019, 9, 12, 13, 30),
            ],
        )
        kwargs.setdefault('code', f'dummy#{id}' if id is not None else 'dummy')
        kwargs.setdefault(
            'title', f'Test event {id}' if id is not None else 'Test event'
        )
        kwargs.setdefault('creator_name', 'Dummy')
        kwargs.setdefault('duration', timedelta(minutes=60))
        kwargs.setdefault('private', True)
        kwargs.setdefault('timezone', 'Europe/Zurich')
        newdle = Newdle(
            id=id,
            creator_uid=dummy_uid,
            **kwargs,
        )
        db_session.add(newdle)
        db_session.flush()
        return newdle

    return _create_newdle


@pytest.fixture
def override_config(app):
    """Return a callable which lets you override app config variables."""
    orig_config = dict(app.config)

    def _override_config(**kwargs):
        app.config.update(**kwargs)

    try:
        yield _override_config
    finally:
        app.config.update(orig_config)


@pytest.fixture
def dummy_newdle(db_session, dummy_uid):
    newdle = Newdle(
        code='dummy',
        title='Test event',
        creator_uid=dummy_uid,
        creator_name='Dummy',
        duration=timedelta(minutes=60),
        private=True,
        timezone='Europe/Zurich',
        timeslots=[
            datetime(2019, 9, 11, 13, 0),
            datetime(2019, 9, 11, 14, 0),
            datetime(2019, 9, 12, 13, 0),
            datetime(2019, 9, 12, 13, 30),
        ],
        participants={
            Participant(code='part1', name='Tony Stark'),
            Participant(code='part2', name='Albert Einstein'),
            Participant(
                code='part3',
                name='Guinea Pig',
                email='example@example.com',
                auth_uid='pig',
            ),
        },
    )
    db_session.add(newdle)
    db_session.flush()
    return newdle