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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
# 3rd party
import pytest
from apeye.requests_url import RequestsURL
from coincidence.params import count
from docutils import nodes
from docutils.nodes import system_message
from docutils.utils import Reporter
# this package
import sphinx_toolbox
from sphinx_toolbox import issues
from sphinx_toolbox.github.issues import IssueNode, issue_role, pull_role
from sphinx_toolbox.testing import run_setup
from tests.common import AttrDict
class FakePullInliner:
def __init__(self, github_issues_url: str):
config = AttrDict({"github_pull_url": RequestsURL(github_issues_url)})
app = AttrDict({"config": config})
env = AttrDict({"app": app})
settings = AttrDict({"env": env})
reporter = Reporter('', 0, 100)
self.document = AttrDict({"settings": settings, "reporter": reporter})
class FakeIssueInliner:
def __init__(self, github_issues_url: str):
config = AttrDict({"github_issues_url": RequestsURL(github_issues_url)})
app = AttrDict({"config": config})
env = AttrDict({"app": app})
settings = AttrDict({"env": env})
reporter = Reporter('', 0, 100)
self.document = AttrDict({"settings": settings, "reporter": reporter})
@pytest.mark.parametrize(
"url",
[
"https://github.com/sphinx-toolbox/sphinx-toolbox/issues",
"https://github.com/pytest-dev/pytest/issues",
"https://github.com/tox-dev/tox/issues",
"https://github.com/python/cpython/issues",
"https://github.com/psf/requests/issues",
]
)
@count(100)
def test_issue_role(count: int, url: str):
issue_number = count
nodes, messages = issue_role(
'',
'',
str(issue_number),
0,
FakeIssueInliner(url), # type: ignore[arg-type]
)
assert isinstance(nodes, list)
assert isinstance(messages, list)
assert not messages
assert isinstance(nodes[0], IssueNode)
assert nodes[0].issue_url == f"{url}/{issue_number}"
assert nodes[0].issue_number == issue_number
assert not nodes[0].has_tooltip
issues_repositories = pytest.mark.parametrize(
"url, repository",
[
("https://github.com/sphinx-toolbox/sphinx-toolbox/issues", "sphinx-toolbox/sphinx-toolbox"),
("https://github.com/pytest-dev/pytest/issues", "pytest-dev/pytest"),
("https://github.com/tox-dev/tox/issues", "tox-dev/tox"),
("https://github.com/python/cpython/issues", "python/cpython"),
("https://github.com/psf/requests/issues", "psf/requests"),
]
)
pull_repositories = pytest.mark.parametrize(
"url, repository",
[
("https://github.com/sphinx-toolbox/sphinx-toolbox/pull", "sphinx-toolbox/sphinx-toolbox"),
("https://github.com/pytest-dev/pytest/pull", "pytest-dev/pytest"),
("https://github.com/tox-dev/tox/pull", "tox-dev/tox"),
("https://github.com/python/cpython/pull", "python/cpython"),
("https://github.com/psf/requests/pull", "psf/requests"),
]
)
@issues_repositories
@count(100, 0, 10)
def test_issue_role_with_repository(count: int, url: str, repository: str):
issue_number = count
nodes, messages = issue_role('', '', f"{issue_number} <{repository}>", 0, "Not a URL") # type: ignore[arg-type]
assert isinstance(nodes, list)
assert isinstance(messages, list)
assert not messages
assert isinstance(nodes[0], IssueNode)
assert nodes[0].issue_url == f"{url}/{issue_number}"
assert nodes[0].issue_number == issue_number
assert not nodes[0].has_tooltip
@pytest.mark.parametrize(
"url",
[
"https://github.com/sphinx-toolbox/sphinx-toolbox/pull",
"https://github.com/pytest-dev/pytest/pull",
"https://github.com/tox-dev/tox/pull",
"https://github.com/python/cpython/pull",
"https://github.com/psf/requests/pull",
]
)
@count(100)
def test_pull_role(count: int, url: str):
issue_number = count
nodes, messages = pull_role(
'',
'',
str(issue_number), 0,
FakePullInliner(url), # type: ignore[arg-type]
)
assert isinstance(nodes, list)
assert isinstance(messages, list)
assert not messages
assert isinstance(nodes[0], IssueNode)
assert nodes[0].issue_url == f"{url}/{issue_number}"
assert nodes[0].issue_number == issue_number
assert not nodes[0].has_tooltip
@pull_repositories
@count(100, 0, 10)
def test_pull_role_with_repository(count: int, url: str, repository: str):
issue_number = count
nodes, messages = pull_role(
'',
'',
f"{issue_number} <{repository}>",
0,
"Not a URL", # type: ignore[arg-type]
)
assert isinstance(nodes, list)
assert isinstance(messages, list)
assert not messages
assert isinstance(nodes[0], IssueNode)
assert nodes[0].issue_url == f"{url}/{issue_number}"
assert nodes[0].issue_number == issue_number
assert not nodes[0].has_tooltip
def test_issue_role_invalid_repository(capsys):
url = "https://github.com/sphinx-toolbox/sphinx-toolbox"
nodes, messages = issue_role('', '', f"7 <foo>", 0, FakeIssueInliner(url)) # type: ignore[arg-type]
assert capsys.readouterr().err == ":: (WARNING/2) Invalid repository 'foo' for issue #7.\n"
issue_number = 7
assert isinstance(nodes, list)
assert nodes
assert isinstance(nodes[0], IssueNode)
assert nodes[0].issue_url == f"{url}/{issue_number}"
assert nodes[0].issue_number == issue_number
assert not nodes[0].has_tooltip
assert isinstance(messages, list)
assert messages
assert isinstance(messages[0], system_message)
assert messages[0].astext() == ":: (WARNING/2) Invalid repository 'foo' for issue #7."
def test_pull_role_invalid_repository(capsys):
url = "https://github.com/sphinx-toolbox/sphinx-toolbox"
nodes, messages = pull_role('', '', f"7 <foo>", 0, FakePullInliner(url)) # type: ignore[arg-type]
assert capsys.readouterr().err == ":: (WARNING/2) Invalid repository 'foo' for pull request #7.\n"
issue_number = 7
assert isinstance(nodes, list)
assert nodes
assert isinstance(nodes[0], IssueNode)
assert nodes[0].issue_url == f"{url}/{issue_number}"
assert nodes[0].issue_number == issue_number
assert not nodes[0].has_tooltip
assert isinstance(messages, list)
assert messages
assert isinstance(messages[0], system_message)
assert messages[0].astext() == ":: (WARNING/2) Invalid repository 'foo' for pull request #7."
class FakeTranslator:
def __init__(self):
self.body = []
def visit_reference(self, node: nodes.Node) -> None:
pass
def depart_reference(self, node: nodes.Node) -> None:
pass
#
# @pytest.fixture()
# def rootdir():
# rdir = PathPlus(__file__).parent.absolute() / "github-doc-test"
# (rdir / "sphinx-test-github-root").maybe_make(parents=True)
# return rdir
#
#
# @pytest.fixture()
# def github_issues_app(app):
# return app
#
#
# @pytest.fixture()
# def issues_content(github_issues_app):
# github_issues_app.build(force_all=True)
# yield github_issues_app
#
#
# @pytest.fixture()
# def issues_page(issues_content, request) -> BeautifulSoup:
# pagename = request.param
# c = (issues_content.outdir / pagename).read_text()
#
# yield BeautifulSoup(c, "html5lib")
#
#
# @pytest.mark.parametrize("issues_page", ["index.html"], indirect=True)
# def test_output_github(issues_page: BeautifulSoup):
# # Make sure the page title is what you expect
# title = issues_page.find("h1").contents[0].strip()
# assert "sphinx-toolbox Demo" == title
#
# tag_count = 0
#
# for a_tag in issues_page.select("a.reference.external"):
# if a_tag["href"] == "https://github.com/sphinx-toolbox/sphinx-toolbox/blob/master/sphinx_toolbox/config.py":
# if a_tag.contents[0] == "sphinx_toolbox/config.py":
# tag_count += 1
#
# assert tag_count == 1
def test_setup():
setup_ret, directives, roles, additional_nodes, app = run_setup(issues.setup)
assert setup_ret == {"version": sphinx_toolbox.__version__, "parallel_read_safe": True}
assert roles == {
"issue": issue_role,
"pr": pull_role,
"pull": pull_role,
}
assert additional_nodes == set()
assert app.registry.translation_handlers == {}
|
