mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
ecfd08d325
Tests for Sphinx's CLIs, like test_apidoc, indirectly init_console to initialize translations for Sphinx's console domain, the one with Sphinx's log messages. This bleeds over subsequent tests by making warnings translated. Fix this by skipping init_console when running Sphinx's test suite.
62 lines
1.5 KiB
Python
62 lines
1.5 KiB
Python
import os
|
|
import shutil
|
|
|
|
import docutils
|
|
import pytest
|
|
|
|
import sphinx
|
|
import sphinx.locale
|
|
from sphinx.testing import comparer
|
|
from sphinx.testing.path import path
|
|
|
|
|
|
def _init_console(locale_dir=sphinx.locale._LOCALE_DIR, catalog='sphinx'):
|
|
"""Monkeypatch ``init_console`` to skip its action.
|
|
|
|
Some tests rely on warning messages in English. We don't want
|
|
CLI tests to bleed over those tests and make their warnings
|
|
translated.
|
|
"""
|
|
return sphinx.locale.NullTranslations(), False
|
|
|
|
|
|
sphinx.locale.init_console = _init_console
|
|
|
|
pytest_plugins = 'sphinx.testing.fixtures'
|
|
|
|
# Exclude 'roots' dirs for pytest test collector
|
|
collect_ignore = ['roots']
|
|
|
|
|
|
@pytest.fixture(scope='session')
|
|
def rootdir():
|
|
return path(__file__).parent.abspath() / 'roots'
|
|
|
|
|
|
def pytest_report_header(config):
|
|
header = ("libraries: Sphinx-%s, docutils-%s" %
|
|
(sphinx.__display_version__, docutils.__version__))
|
|
if hasattr(config, '_tmp_path_factory'):
|
|
header += "\nbase tempdir: %s" % config._tmp_path_factory.getbasetemp()
|
|
|
|
return header
|
|
|
|
|
|
def pytest_assertrepr_compare(op, left, right):
|
|
comparer.pytest_assertrepr_compare(op, left, right)
|
|
|
|
|
|
def _initialize_test_directory(session):
|
|
if 'SPHINX_TEST_TEMPDIR' in os.environ:
|
|
tempdir = os.path.abspath(os.getenv('SPHINX_TEST_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):
|
|
_initialize_test_directory(session)
|