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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
"""Configure `doctest` tests."""
from __future__ import annotations
import builtins
import logging
import sys
from functools import partial
from pathlib import Path
from typing import Any, Callable, Iterator
from unittest import mock
import pytest
import pytest_mock
import typer
from mypy_boto3_appconfigdata import AppConfigDataClient
from mypy_boto3_secretsmanager import SecretsManagerClient
from config_ninja.backend import Backend
_no_default = object()
# pylint: disable=redefined-outer-name,too-many-arguments
# note: the following is needed for testing on Python < 3.10
# ref: https://docs.python.org/3/library/functions.html#anext
def py_anext(iterator: Iterator[Any], default: Any = _no_default) -> Any: # pylint: disable=too-complex # pragma: no cover
"""Pure-Python implementation of anext() for testing purposes.
Closely matches the builtin anext() C implementation.
Can be used to compare the built-in implementation of the inner
coroutines machinery to C-implementation of __anext__() and send()
or throw() on the returned generator.
ref: https://github.com/python/cpython/blob/ea786a882b9ed4261eafabad6011bc7ef3b5bf94/Lib/test/test_asyncgen.py#L52-L80
"""
try:
__anext__ = type(iterator).__anext__ # type: ignore[attr-defined]
except AttributeError as exc:
raise TypeError(f'{iterator!r} is not an async iterator') from exc
if default is _no_default:
return __anext__(iterator) # pyright: ignore[reportUnknownVariableType]
async def anext_impl() -> Any:
try:
# The C code is way more low-level than this, as it implements
# all methods of the iterator protocol. In this implementation
# we're relying on higher-level coroutine concepts, but that's
# exactly what we want -- crosstest pure-Python high-level
# implementation and low-level C anext() iterators.
return await __anext__(iterator) # pyright: ignore[reportUnknownVariableType]
except StopAsyncIteration:
return default
return anext_impl()
class ExampleBackend:
"""A sample backend class used in `doctest` tests."""
source: str
__repr__ = Backend.__repr__
def __init__(self, source: str) -> None:
"""Initialize the backend with the given `source`."""
self.source = source
@pytest.fixture
def seed_import_error(monkeypatch: pytest.MonkeyPatch) -> Callable[[], None]:
"""Use the `pytest.MonkeyPatch` fixture to seed an import error when called."""
return partial(monkeypatch.setitem, sys.modules, 'config_ninja.hooks', None)
@pytest.fixture(autouse=True)
def src_doctest_namespace( # noqa: PLR0913
doctest_namespace: dict[str, Any],
mock_appconfigdata_client: AppConfigDataClient,
mock_appconfigdata_client_first_empty: AppConfigDataClient,
mock_secretsmanager_client: SecretsManagerClient,
mock_secretsmanager_client_no_current: SecretsManagerClient,
mock_secretsmanager_client_no_current_initially: SecretsManagerClient,
example_file: Path,
monkeypatch_systemd: tuple[Path, Path],
caplog: pytest.LogCaptureFixture,
mocker: pytest_mock.MockerFixture,
seed_import_error: Callable[[], None],
) -> dict[str, Any]:
"""Add various mocks and patches to the doctest namespace."""
if 'anext' not in builtins.__dict__: # pragma: no cover
doctest_namespace['anext'] = py_anext
ctx = mock.MagicMock(spec=typer.Context)
ctx.resilient_parsing = False
ctx.obj = {}
mocker.patch('logging.config.dictConfig')
mocker.patch('boto3.Session')
caplog.set_level(logging.NOTSET)
doctest_namespace['SYSTEM_INSTALL_PATH'] = monkeypatch_systemd[0]
doctest_namespace['USER_INSTALL_PATH'] = monkeypatch_systemd[1]
doctest_namespace['example_file'] = example_file
doctest_namespace['pytest'] = pytest
doctest_namespace['appconfigdata_client'] = mock_appconfigdata_client
doctest_namespace['appconfigdata_client_first_empty'] = mock_appconfigdata_client_first_empty
doctest_namespace['secretsmanager_client'] = mock_secretsmanager_client
doctest_namespace['secretsmanager_client_no_current'] = mock_secretsmanager_client_no_current
doctest_namespace['secretsmanager_client_no_current_initially'] = mock_secretsmanager_client_no_current_initially
doctest_namespace['ExampleBackend'] = ExampleBackend
doctest_namespace['ctx'] = ctx
doctest_namespace['caplog'] = caplog
doctest_namespace['seed_import_error'] = seed_import_error
return doctest_namespace
|