summaryrefslogtreecommitdiff
path: root/tests/conftest.py
blob: 0d6b39681234e954d2ef5a04ee33c6364a28261f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# -*- coding: utf-8 -*-
"""
    pytest config for sphinx/tests
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import os
import shutil
import sys
import warnings

import pytest
from sphinx.testing.path import path

pytest_plugins = 'sphinx.testing.fixtures'

# Exclude 'roots' dirs for pytest test collector
collect_ignore = ['roots']

# Disable Python version-specific
if sys.version_info < (3, 5):
    collect_ignore += ['py35']


@pytest.fixture(scope='session')
def rootdir():
    return path(os.path.dirname(__file__) or '.').abspath() / 'roots'


def pytest_report_header(config):
    return 'Running Sphinx test suite (with Python %s)...' % (
        sys.version.split()[0])


def _filter_warnings():
    def ignore(**kwargs): warnings.filterwarnings('ignore', **kwargs)

    ignore(category=DeprecationWarning, module='site')  # virtualenv
    ignore(category=PendingDeprecationWarning, module=r'_pytest\..*')
    ignore(category=ImportWarning, module='pkgutil')


def _initialize_test_directory(session):
    testroot = os.path.join(str(session.config.rootdir), 'tests')
    tempdir = os.path.abspath(os.getenv('SPHINX_TEST_TEMPDIR',
                              os.path.join(testroot, 'build')))
    os.environ['SPHINX_TEST_TEMPDIR'] = tempdir

    print('Temporary files will be placed in %s.' % tempdir)

    if os.path.exists(tempdir):
        shutil.rmtree(tempdir)

    os.makedirs(tempdir)


def pytest_sessionstart(session):
    _filter_warnings()
    _initialize_test_directory(session)