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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
# stdlib
from typing import List
# 3rd party
import pytest
from sphinx.events import EventListener
# this package
from sphinx_toolbox import installation
from sphinx_toolbox.installation import make_installation_instructions
from sphinx_toolbox.testing import run_setup
from tests.common import AttrDict, get_app_config_values
class FakeBuildEnvironment(AttrDict):
def __init__(self, tab_width: int):
config = AttrDict({
"docutils_tab_width": tab_width,
"github_username": "octocat",
"github_repository": "hello_world",
"conda_channels": [],
})
app = AttrDict(extensions=[
"sphinx_toolbox.installation",
"sphinx_toolbox.github",
])
super().__init__({"config": config, "app": app})
def test_make_installation_instructions_errors():
with pytest.warns(UserWarning) as w:
assert make_installation_instructions({}, FakeBuildEnvironment(4)) == [] # type: ignore[arg-type]
assert len(w) == 1
args: List[str] = w[0].message.args # type: ignore[union-attr, assignment]
assert args[0] == "No installation source specified. No installation instructions will be shown."
with pytest.raises(ValueError, match="No PyPI project name supplied for the PyPI installation instructions."):
make_installation_instructions({"pypi": True}, FakeBuildEnvironment(4)) # type: ignore[arg-type]
with pytest.raises(ValueError, match="No username supplied for the Anaconda installation instructions."):
make_installation_instructions({"anaconda": True}, FakeBuildEnvironment(4)) # type: ignore[arg-type]
def test_make_installation_instructions():
assert make_installation_instructions(
{"pypi": True, "project_name": "my_project"},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from PyPI",
'',
" .. prompt:: bash",
'',
" python3 -m pip install my_project --user",
]
assert make_installation_instructions(
{"pypi": True, "project_name": "my_project", "pypi-name": "my-project"},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from PyPI",
'',
" .. prompt:: bash",
'',
" python3 -m pip install my-project --user",
]
assert make_installation_instructions(
{"anaconda": True, "project_name": "my_project"},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from Anaconda",
'',
" .. prompt:: bash",
'',
" conda install my_project",
'',
]
assert make_installation_instructions(
{"anaconda": True, "project_name": "my_project", "conda-name": "my-project"},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from Anaconda",
'',
" .. prompt:: bash",
'',
" conda install my-project",
'',
]
assert make_installation_instructions(
{"anaconda": True, "project_name": "my_project", "pypi-name": "pypi-project"},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from Anaconda",
'',
" .. prompt:: bash",
'',
" conda install pypi-project",
'',
]
assert make_installation_instructions(
{"github": True, "project_name": "my_project"},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from GitHub",
'',
" .. prompt:: bash",
'',
" python3 -m pip install git+https://github.com/octocat/hello_world@master --user",
]
assert make_installation_instructions(
{
"anaconda": True,
"conda-channels": "foo,bar",
"project_name": "my_project",
},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from Anaconda",
'',
" First add the required channels",
'',
" .. prompt:: bash",
'',
" conda config --add channels https://conda.anaconda.org/foo",
" conda config --add channels https://conda.anaconda.org/bar",
'',
" Then install",
'',
" .. prompt:: bash",
'',
" conda install my_project",
'',
]
# Testd whitespace
assert make_installation_instructions(
{
"anaconda": True,
"conda-channels": " foo , bar ",
"project_name": "my_project",
},
FakeBuildEnvironment(4), # type: ignore[arg-type]
) == [
".. tabs::",
'',
" .. tab:: from Anaconda",
'',
" First add the required channels",
'',
" .. prompt:: bash",
'',
" conda config --add channels https://conda.anaconda.org/foo",
" conda config --add channels https://conda.anaconda.org/bar",
'',
" Then install",
'',
" .. prompt:: bash",
'',
" conda install my_project",
'',
]
def test_setup():
setup_ret, directives, roles, additional_nodes, app = run_setup(installation.setup)
assert app.events.listeners == {
"env-purge-doc": [
EventListener(id=1, handler=installation.extensions_node_purger.purge_nodes, priority=500),
],
"env-get-outdated": [
EventListener(
id=0,
handler=installation.installation_node_purger.get_outdated_docnames,
priority=500
),
],
"build-finished": [EventListener(id=3, handler=installation.copy_asset_files, priority=500)],
"config-inited": [EventListener(id=2, handler=installation._on_config_inited, priority=510)],
}
assert get_app_config_values(app.config.values["conda_channels"]) == ([], "env", [list])
assert directives == {
"installation": installation.InstallationDirective,
"extensions": installation.ExtensionsDirective,
}
assert app.registry.source_parsers == {}
assert app.registry.css_files == []
assert app.registry.js_files == []
installation._on_config_inited(app, app.config) # type: ignore[arg-type]
assert app.registry.css_files == [("sphinx_toolbox_installation.css", {})]
assert app.registry.js_files == [("sphinx_toolbox_installation.js", {})]
|
