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
|
import os.path
from pathlib import Path
import pytest
from lxml import html as html_parser
from sphinx.util.console import strip_colors
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/doc_needextract",
"no_plantuml": True,
}
],
indirect=True,
)
def test_needextract_basic(test_app):
app = test_app
app.build()
assert not app._warning.getvalue()
def run_checks(checks, html_path):
html_path = str(Path(app.outdir, html_path))
tree = html_parser.parse(html_path)
for check in checks:
img_src = tree.xpath(
f"//table[@id='{check[0]}']//td[@class='need content']//img/@src"
)[0]
assert img_src == check[1]
assert os.path.exists(
str(Path(app.outdir, os.path.dirname(html_path), img_src))
)
checks = [
("US_SUB_001", "_images/smile.png"),
("US_SUB_002", "_images/smile.png"),
("US_SUB_003", "_images/smile1.png"),
("US_SUB_004", "_images/smile1.png"),
("US_SUB_005", "_images/smile1.png"),
("US_SUB_005", "_images/smile1.png"),
("US_002", "_images/smile.png"),
("US_003", "_images/smile.png"),
]
run_checks(checks, "check_images.html")
checks = [
("US_002", "../_images/smile.png"),
("US_003", "../_images/smile.png"),
]
run_checks(checks, "subfolder/check_images_2.html")
index_html = Path(app.outdir, "check_need_refs.html").read_text()
assert "Awesome Sphinx-Needs" in index_html
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/needextract_with_nested_needs",
"no_plantuml": True,
}
],
indirect=True,
)
def test_needextract_with_nested_needs(test_app):
app = test_app
app.build()
warnings = strip_colors(
app._warning.getvalue().replace(str(app.srcdir) + os.sep, "srcdir/")
).splitlines()
# print(warnings)
# note these warnings are emitted twice because they are resolved twice: once when first specified and once when copied with needextract
assert warnings == [
'srcdir/index.rst:13: WARNING: The [[copy("id")]] syntax in need content is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
'srcdir/index.rst:33: WARNING: The [[copy("id")]] syntax in need content is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
'srcdir/index.rst:13: WARNING: The [[copy("id")]] syntax in need content is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
'srcdir/index.rst:33: WARNING: The [[copy("id")]] syntax in need content is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
]
needextract_html = Path(app.outdir, "needextract.html").read_text()
# ensure that the needs exist and that their hrefs point to the correct location
assert (
'<span class="needs-id"><a class="reference internal" href="index.html#SPEC_1" title="SPEC_1">SPEC_1</a>'
in needextract_html
)
assert (
'<span class="needs-id"><a class="reference internal" href="index.html#SPEC_1_1" title="SPEC_1_1">SPEC_1_1</a>'
in needextract_html
)
assert (
'<span class="needs-id"><a class="reference internal" '
'href="index.html#SPEC_1_1_1" title="SPEC_1_1_1">SPEC_1_1_1</a>'
in needextract_html
)
assert (
'<span class="needs-id"><a class="reference internal" '
'href="index.html#SPEC_1_1_2" title="SPEC_1_1_2">SPEC_1_1_2</a>'
in needextract_html
)
# dynamic functions should be executed
assert "This is id SPEC_1 SPEC_1" in needextract_html
assert "This is grandchild id SPEC_1_1_2 SPEC_1_1_2" in needextract_html
|
