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
|
import os
from pathlib import Path
import pytest
from sphinx.testing.util import SphinxTestApp
from sphinx.util.console import strip_colors
def get_warnings(app: SphinxTestApp):
return (
strip_colors(app._warning.getvalue())
.replace(str(app.srcdir) + os.path.sep, "<srcdir>/")
.splitlines()
)
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/doc_basic",
"confoverrides": {"needs_id_required": True},
"no_plantuml": True,
}
],
indirect=True,
)
def test_id_required_build_html(test_app: SphinxTestApp):
test_app.build()
assert get_warnings(test_app) == [
"<srcdir>/index.rst:8: WARNING: Need could not be created: No ID defined, but 'needs_id_required' is set to True. [needs.create_need]"
]
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/broken_doc", "no_plantuml": True}],
indirect=True,
)
def test_duplicate_id(test_app: SphinxTestApp):
test_app.build()
assert get_warnings(test_app) == [
"<srcdir>/index.rst:11: WARNING: Need could not be created: A need with ID 'SP_TOO_001' already exists. [needs.create_need]"
]
html = (test_app.outdir / "index.html").read_text()
assert "<h1>BROKEN DOCUMENT" in html
assert "SP_TOO_001" in html
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/broken_links", "no_plantuml": True}],
indirect=True,
)
def test_broken_links(test_app: SphinxTestApp):
app = test_app
app.build()
assert get_warnings(test_app) == [
"<srcdir>/index.rst:12: WARNING: Need 'SP_TOO_002' has unknown outgoing link 'NOT_WORKING_LINK' in field 'links' [needs.link_outgoing]",
"<srcdir>/index.rst:21: WARNING: linked need BROKEN_LINK not found [needs.link_ref]",
]
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/broken_statuses",
"no_plantuml": True,
}
],
indirect=True,
)
def test_broken_statuses(test_app: SphinxTestApp):
test_app.build()
assert get_warnings(test_app) == [
"<srcdir>/index.rst:11: WARNING: Need could not be created: Status 'NOT_ALLOWED' not in 'needs_statuses'. [needs.create_need]"
]
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/broken_syntax_doc",
"no_plantuml": True,
}
],
indirect=True,
)
def test_broken_syntax(test_app: SphinxTestApp):
test_app.build()
assert [li for li in get_warnings(test_app) if li.startswith("<srcdir>")] == [
'<srcdir>/index.rst:4: ERROR: Error in "spec" directive:',
'<srcdir>/index.rst:11: ERROR: Error in "spec" directive:',
'<srcdir>/index.rst:19: ERROR: Error in "spec" directive:',
]
html = Path(test_app.outdir, "index.html").read_text()
assert "SP_TOO_001" not in html
assert "SP_TOO_002" not in html
assert "SP_TOO_003" not in html
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/broken_tags", "no_plantuml": True}],
indirect=True,
)
def test_broken_tags(test_app: SphinxTestApp):
test_app.build()
assert get_warnings(test_app) == [
"<srcdir>/index.rst:17: WARNING: Need could not be created: Tags {'BROKEN'} not in 'needs_tags'. [needs.create_need]"
]
|
