conftest.py

# This work was created by participants in the DataONE project, and is
# jointly copyrighted by participating institutions in DataONE. For
# more information on DataONE, see our web site at http://dataone.org.
#
#   Copyright 2009-2019 DataONE
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""pytest setup and customization."""
import logging
import os
import sys
import tempfile

import mock
import posix_ipc
import psycopg2
import psycopg2.extensions
import pytest

import d1_gmn.app.sciobj_store
import d1_gmn.tests.gmn_test_case

import d1_common.date_time

import d1_test.d1_test_case
import d1_test.instance_generator.random_data
import d1_test.sample
import d1_test.test_files

from d1_client.cnclient_1_2 import CoordinatingNodeClient_1_2 as cn_v1
from d1_client.cnclient_2_0 import CoordinatingNodeClient_2_0 as cn_v2
from d1_client.mnclient_1_2 import MemberNodeClient_1_2 as mn_v1
from d1_client.mnclient_2_0 import MemberNodeClient_2_0 as mn_v2

import django.conf
import django.core.management
import django.db
import django.test

if not 'TRAVIS' in os.environ:
    import d1_test.pycharm

logger = logging.getLogger(__name__)

D1_SKIP_LIST = 'skip_passed/list'
D1_SKIP_COUNT = 'skip_passed/count'

# Dict lookup keys matching the keys in settings_test.DATABASE
TEMPLATE_DB_KEY = 'template'
TEST_DB_KEY = 'default'

DO_FIXTURE_REFRESH = False


# Allow redefinition of functions. Pytest allows multiple hooks with the same
# name.
# flake8: noqa: F811

# Hack to get access to print and logging output when running under pytest-xdist
# and pytest-catchlog. Without this, only output from failed tests is displayed.
# sys.stdout = sys.stderr


def pytest_addoption(parser):
    """Add command line switches for pytest customization. See README.md for info.

    Note: None of these options can be used with xdist (-n --dist -tx).

    """
    # Sample files

    parser.addoption(
        '--sample-ask',
        action='store_true',
        help='Prompt to update or write new test sample files on failures',
    )
    parser.addoption(
        '--sample-update',
        action='store_true',
        help='Automatically update or write sample files on failures',
    )
    parser.addoption(
        '--sample-review',
        action='store_true',
        help='Review samples (use after --sample-update)',
    )
    parser.addoption(
        '--sample-tidy',
        action='store_true',
        help='Move unused sample files to test_docs_tidy',
    )

    # PyCharm integration

    parser.addoption(
        '--pycharm',
        action='store_true',
        help='Attempt to move the cursor in PyCharm to location of most recent test '
        'failure',
    )

    # GMN database fixture

    parser.addoption(
        '--fixture-refresh',
        action='store_true',
        help='Drop and recreate GMN template database from JSON fixture file',
    )

    # Skip passed tests

    parser.addoption(
        '--skip',
        action='store_true',
        help='Skip tests that are in the list of passed tests',
    )
    parser.addoption(
        '--skip-print', action='store_true', help='Print the list of passed tests'
    )


# Hooks


def pytest_configure(config):
    """Allow plugins and conftest files to perform initial configuration This hook is
    called for every plugin and initial conftest file after command line options have
    been parsed.

    After that, the hook is called for other conftest files as they are imported.

    """
    global DO_FIXTURE_REFRESH
    DO_FIXTURE_REFRESH = (config.getoption('--fixture-refresh'),)

    sys.is_running_under_travis = 'TRAVIS' in os.environ
    sys.is_running_under_pytest = True

    d1_test.sample.options = {
        'ask': config.getoption('--sample-ask'),
        'review': config.getoption('--sample-review'),
        'update': config.getoption('--sample-update'),
    }


# noinspection PyUnresolvedReferences
def pytest_unconfigure(config):
    del sys.is_running_under_travis
    del sys.is_running_under_pytest


def pytest_sessionstart(session):
    """Called by pytest before calling session.main()

    - When running in parallel with xdist, this is called once for each worker. By
      default, the number of workers is the same as the number of CPU cores.

    """
    exit_if_switch_used_with_xdist(
        session,
        [
            # User input doesn't work well under xdist
            '--sample-ask',
            '--sample-review',
            '--pycharm',
            # Samples can be updated under xdist
            # '--sample-update',
            # Samples can be tidied under xdist
            # --sample-tidy
            # '--fixture-refresh',
            # Recently passed tests cannot be skipped in parallel run since all xdist
            # workers must collect the same number of tests.
            '--skip',
            '--skip-print',
        ],
    )
    if session.config.getoption('--sample-tidy'):
        logger.info('Starting sample tidy')
        d1_test.sample.start_tidy()

    # Running the tests without either --skip-print or --skip always clears the passed
    # list, so that, if --skip is added on the next run, it will continue from the most
    # recent failed test.
    if session.config.getoption('--skip-print'):
        logger.info('Printing list of passed tests')
        _print_skip_list(session)
    elif not session.config.getoption('--skip'):
        logger.info('Clearing list of passed tests')
        _clear_skip_list(session)


def pytest_sessionfinish(session, exitstatus):
    """Called by pytest after the test session ends."""
    # if exitstatus != 2:
    if session.config.getoption('--skip'):
        skipped_count = session.config.cache.get(D1_SKIP_COUNT, 0)
        if skipped_count:
            logger.warning('Skipped {} previously passed tests'.format(skipped_count))


@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
    """Called by pytest after setup, after call and after teardown of each test."""
    outcome = yield
    rep = outcome.get_result()
    # Ignore setup and teardown
    if rep.when != 'call':
        return
    if rep.passed or rep.skipped:
        passed_set = set(item.session.config.cache.get(D1_SKIP_LIST, []))
        passed_set.add(item.nodeid)
        item.session.config.cache.set(D1_SKIP_LIST, list(passed_set))
    elif rep.failed:
        if item.session.config.getoption('--pycharm'):
            _open_error_in_pycharm(call)


def pytest_collection_modifyitems(session, config, items):
    """Called by pytest after collecting tests.

    The collected tests and the order in which they will be called are in ``items``,
    which can be manipulated in place.

    """
    if not session.config.getoption('--skip'):
        return

    passed_set = set(session.config.cache.get(D1_SKIP_LIST, []))
    new_item_list = []
    for item in items:
        if item.nodeid not in passed_set:
            new_item_list.append(item)

    prev_skip_count = session.config.cache.get(D1_SKIP_COUNT, 0)
    cur_skip_count = len(items) - len(new_item_list)

    if prev_skip_count == cur_skip_count:
        logger.info('No tests were run (--skip). Restarting with complete test set')
        _clear_skip_list(session)
    else:
        session.config.cache.set(D1_SKIP_COUNT, cur_skip_count)
        logger.info(
            'Skipping {} previously passed tests (--skip)'.format(cur_skip_count)
        )
        items[:] = new_item_list


# TODO: Implement side by side diff display for string compare failures
# def pytest_assertrepr_compare(config, op, left, right):
#   """Called by pytest on failed assert
#   - Return custom assert error message as a list of strings
#   - Return None to use pytest's default error message
#   """
#   if isinstance(left, str) and isinstance(right, str) and op == "==":
#     # print('{0}\n{1}\n{0}\n{2}\n{0}\n'.format('~'*80, left, right))
#     msg = d1_test.sample._get_sxs_diff_str(left, right)#.encode('utf-8')
#     # print(msg)
#     return msg.splitlines()


def _clear_skip_list(session):
    session.config.cache.set(D1_SKIP_LIST, [])
    session.config.cache.set(D1_SKIP_COUNT, 0)


def _print_skip_list(session):
    list(map(logger.info, sorted(session.config.cache.get(D1_SKIP_LIST, []))))


def _open_error_in_pycharm(call):
    """Attempt to open error locations in PyCharm.

    Use with --exitfirst (-x)

    """
    logger.error('Test raised exception: {}'.format(call.excinfo.exconly()))
    test_path, test_lineno = d1_test.d1_test_case.D1TestCase.get_d1_test_case_location(
        call.excinfo.tb
    )
    logger.error('D1TestCase location: {}:{}'.format(test_path, test_lineno))
    exc_frame = call.excinfo.traceback.getcrashentry()
    logger.error(
        'Exception location: {}({})'.format(exc_frame.path, exc_frame.lineno + 1)
    )
    # src_path = call.excinfo.traceback[-1].path
    # src_line = call.excinfo.traceback[-1].lineno + 1
    d1_test.pycharm.open_and_set_cursor(test_path, test_lineno)


# Fixtures


def pytest_generate_tests(metafunc):
    """Parameterize test functions via parameterize_dict class member."""
    try:
        func_arg_list = metafunc.cls.parameterize_dict[metafunc.function.__name__]
    except (AttributeError, KeyError):
        return
    arg_names = sorted(func_arg_list[0])
    metafunc.parametrize(
        arg_names,
        [[func_args[name] for name in arg_names] for func_args in func_arg_list],
    )


# Fixtures for parameterizing tests over CN/MN and v1/v2 clients.


@pytest.fixture(scope='function', params=[True, False])
def true_false(request):
    yield request.param


@pytest.fixture(scope='function', params=[None, True])
def none_true(request):
    yield request.param


@pytest.fixture(scope='function', params=['v1', 'v2'])
def tag_v1_v2(request):
    yield request.param


# CN and MN (for baseclient)


@pytest.fixture(scope='function', params=[cn_v1, mn_v1])
def cn_mn_client_v1(request):
    yield request.param(d1_test.d1_test_case.MOCK_CN_MN_BASE_URL)


@pytest.fixture(scope='function', params=[cn_v2, mn_v2])
def cn_mn_client_v2(request):
    yield request.param(d1_test.d1_test_case.MOCK_CN_MN_BASE_URL)


@pytest.fixture(scope='function', params=[cn_v1, mn_v1, cn_v2, mn_v2])
def cn_mn_client_v1_v2(request):
    yield request.param(d1_test.d1_test_case.MOCK_CN_MN_BASE_URL)


# CN clients


@pytest.fixture(scope='function', params=[cn_v1])
def cn_client_v1(request):
    yield request.param(d1_test.d1_test_case.MOCK_CN_BASE_URL)


@pytest.fixture(scope='function', params=[cn_v2])
def cn_client_v2(request):
    yield request.param(d1_test.d1_test_case.MOCK_CN_BASE_URL)


@pytest.fixture(scope='function', params=[cn_v1, cn_v2])
def cn_client_v1_v2(request):
    yield request.param(d1_test.d1_test_case.MOCK_CN_BASE_URL)


# MN clients


@pytest.fixture(scope='function', params=[mn_v1])
def mn_client_v1(request):
    yield request.param(d1_test.d1_test_case.MOCK_MN_BASE_URL)


@pytest.fixture(scope='function', params=[mn_v2])
def mn_client_v2(request):
    yield request.param(d1_test.d1_test_case.MOCK_MN_BASE_URL)


@pytest.fixture(scope='function', params=[mn_v1, mn_v2])
def mn_client_v1_v2(request):
    yield request.param(d1_test.d1_test_case.MOCK_MN_BASE_URL)


@pytest.fixture(
    scope='function',
    params=d1_test.test_files.load_json('combined_tricky_identifiers_unicode.json'),
)
def tricky_identifier_dict(request):
    """Unicode identifiers that use various reserved characters and embedded URL
    segments.

    Each value is a dict with keys, 'unescaped', 'path_escaped', 'query_escaped'.

    """
    yield request.param


# Settings


@pytest.fixture(scope='session', autouse=True)
def django_sciobj_store_setup(request):
    """Create a unique SciObj store dir under /tmp for each worker.

    This overrides the path set in settings_test.OBJECT_STORE_PATH.

    """
    tmp_store_path = os.path.join(
        tempfile.gettempdir(), 'gmn_test_obj_store', get_xdist_worker_id(request)
    )
    mock.patch('d1_gmn.app.startup._create_sciobj_store_root')
    with d1_gmn.tests.gmn_test_case.unique_sciobj_store(tmp_store_path):
        yield


# Database setup


@pytest.fixture(scope='function', autouse=True)
def enable_db_access(db):
    # No current connection:
    # django.db.connection.(.connection).set_isolation_level(
    #   psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT
    # )
    #
    # Force the process to create new DB connections by closing the current ones.
    # Not allowed in atomic block: django.db.connections.close_all()
    pass


@pytest.fixture(scope='function')
def profile_sql(db):
    django.db.connection.queries = []
    yield
    logging.info('SQL queries by all methods:')
    list(map(logging.info, django.db.connection.queries))


@pytest.fixture(scope='session', autouse=True)
@pytest.mark.django_db
def django_db_setup(request, django_db_blocker):
    """Set up DB fixture.

    When running in parallel with xdist, each worker is handled as a separate session,
    so session scoped fixtures are called for each worker, causing a separate database
    to be set up for each worker.

    """
    global DO_FIXTURE_REFRESH

    single_db_setup = posix_ipc.Semaphore(
        name=__name__ + 'db_setup', flags=posix_ipc.O_CREAT, initial_value=1
    )

    logger.info('Setting up DB fixture')

    db_set_unique_db_name(request)

    with django_db_blocker.unblock():
        # Let one worker through here and block all the others until the database
        # fixture is ready to be dupliced into the per-worker databases.
        #
        # Regular multiprocessing.Lock() context manager did not work here. Also
        # tried creating the lock at module scope, and also directly calling
        # acquire() and release(). It's probably related to how the worker processes
        # relate to each other when launched by pytest-xdist as compared to what the
        # multiprocessing module expects.
        with posix_ipc.Semaphore(
            name=__name__ + 'db_refresh', flags=posix_ipc.O_CREAT, initial_value=1
        ):
            logger.warning(
                'LOCK BEGIN {} {}'.format(
                    db_get_name_by_key(TEMPLATE_DB_KEY), d1_common.date_time.utc_now()
                )
            )

            try:
                single_db_setup.acquire(timeout=0)
            except posix_ipc.BusyError:
                pass
            else:
                if DO_FIXTURE_REFRESH:
                    DO_FIXTURE_REFRESH = False
                    logger.info(
                        'Dropping and creating GMN template database from JSON fixture file'
                    )
                    db_drop(TEMPLATE_DB_KEY)

                if not db_exists(TEMPLATE_DB_KEY):
                    db_create_blank(TEMPLATE_DB_KEY)
                    db_migrate(TEMPLATE_DB_KEY)
                    db_populate_by_json(TEMPLATE_DB_KEY)
                    db_migrate(TEMPLATE_DB_KEY)

            logger.warning(
                'LOCK END {} {}'.format(
                    db_get_name_by_key(TEMPLATE_DB_KEY), d1_common.date_time.utc_now()
                )
            )

        db_drop(TEST_DB_KEY)
        db_create_from_template()
        # db_migrate(TEST_DB_KEY)

        # Haven't found out how to prevent transactions from being started. so
        # closing the implicit transaction here so that template fixture remains
        # available.
        # django.db.connections[TEST_DB_KEY].commit()

        # print(django.conf.settings)

        yield

        db_drop(TEST_DB_KEY)


def db_get_name_by_key(db_key):
    logger.debug('db_get_name_by_key() {}'.format(db_key))
    return django.conf.settings.DATABASES[db_key]['NAME']


def db_set_unique_db_name(request):
    logger.debug('db_set_unique_db_name()')
    db_name = '_'.join([db_get_name_by_key(TEST_DB_KEY), get_unique_suffix(request)])
    django.conf.settings.DATABASES[TEST_DB_KEY]['NAME'] = db_name


def db_create_from_template():
    logger.debug('db_create_from_template()')
    new_db_name = db_get_name_by_key(TEST_DB_KEY)
    template_db_name = db_get_name_by_key(TEMPLATE_DB_KEY)
    logger.info(
        'Creating new db from template. new_db="{}" template_db="{}"'.format(
            new_db_name, template_db_name
        )
    )
    run_sql(
        'postgres',
        'create database {} template {};'.format(new_db_name, template_db_name),
    )


def db_populate_by_json(db_key):
    """Load DB fixture from compressed JSON file to template database."""
    logger.debug('db_populate_by_json() {}'.format(db_key))
    fixture_file_path = d1_test.test_files.get_abs_test_file_path(
        'json/db_fixture.json.bz2'
    )

    django.core.management.call_command(
        'loaddata',
        fixture_file_path,
        database=db_key,
        # d1_test.sample.get_path_list('db_fixture.json.bz2'),
        # verbosity=0,
        # commit=False,
    )
    db_commit_and_close(db_key)


def db_migrate(db_key):
    logger.debug('db_migrate() {}'.format(db_key))
    django.core.management.call_command('migrate', '--run-syncdb', database=db_key)
    db_commit_and_close(db_key)


def db_drop(db_key):
    logger.debug('db_drop() {}'.format(db_key))
    db_name = db_get_name_by_key(db_key)
    logger.debug('Dropping database: {}'.format(db_name))
    db_commit_and_close(db_key)
    run_sql('postgres', 'drop database if exists {};'.format(db_name))


# noinspection PyUnresolvedReferences
def db_commit_and_close(db_key):
    logger.debug('db_commit_and_close() {}'.format(db_key))
    # try:
    django.db.connections[db_key].commit()
    # except (Exception, psycopg2.InterfaceError):
    #   pass
    # try:
    django.db.connections.close_all()
    # except django.db.transaction.TransactionManagementError:
    # except (Exception, psycopg2.InterfaceError):
    #   pass
    # for connection in django.db.connections.all():
    #   connection.close()


def db_create_blank(db_key):
    logger.debug('db_create_blank() {}'.format(db_key))
    db_name = db_get_name_by_key(db_key)
    logger.debug('Creating blank database: {}'.format(db_name))
    run_sql('postgres', "create database {} encoding 'utf-8';".format(db_name))


def db_exists(db_key):
    logger.debug('db_exists() {}'.format(db_key))
    db_name = db_get_name_by_key(db_key)
    exists_bool = bool(
        run_sql(
            'postgres', "select 1 from pg_database WHERE datname='{}'".format(db_name)
        )
    )
    logger.debug('db_exists(): {}'.format(exists_bool))
    return exists_bool


# noinspection PyUnresolvedReferences
def run_sql(db, sql):
    try:
        conn = psycopg2.connect(database=db)
        conn.set_isolation_level(psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT)
        cur = conn.cursor()
        cur.execute(sql)
    except psycopg2.DatabaseError as e:
        logger.debug('SQL query error: {}'.format(str(e)))
        raise
    try:
        return cur.fetchall()
    except psycopg2.DatabaseError:
        return None
    finally:
        conn.close()
        for connection in django.db.connections.all():
            connection.close()


def get_unique_suffix(request):
    return '_'.join(
        [
            d1_test.instance_generator.random_data.random_lower_ascii(fixed_len=10),
            get_xdist_worker_id(request),
        ]
    ).strip('_')


def get_xdist_worker_id(request):
    """Return a different string for each worker when running in parallel under pytest-
    xdist, else return an empty string.

    Returned strings are on the form, "gwN".

    """
    s = getattr(request.config, 'slaveinput', {}).get('slaveid')
    return s if s is not None else ''


def exit_if_switch_used_with_xdist(session, switch_list):
    if hasattr(session.config, 'slaveinput'):
        for switch_str in switch_list:
            if session.config.getoption(switch_str):
                pytest.exit(
                    'Cannot use {} when running in parallel under pytest-xdist '
                    '(e.g., -n --dist --tx)'.format(switch_str)
                )