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
|
import os
import re
from pathlib import Path
import pytest
from sphinx import version_info
from sphinx.util.console import strip_colors
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/doc_dynamic_functions",
"no_plantuml": True,
}
],
indirect=True,
)
def test_doc_dynamic_functions(test_app):
app = test_app
app.build()
warnings = strip_colors(
app._warning.getvalue().replace(str(app.srcdir) + os.sep, "srcdir/")
).splitlines()
assert warnings == [
'srcdir/index.rst:11: WARNING: The `need_func` role is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
'srcdir/index.rst:40: WARNING: The `need_func` role is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
'srcdir/index.rst:44: WARNING: The `need_func` role is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
'srcdir/index.rst:9: WARNING: The [[copy("id")]] syntax in need content is deprecated. Replace with :ndf:`copy("id")` instead. [needs.deprecated]',
'srcdir/index.rst:27: WARNING: The [[copy("tags")]] syntax in need content is deprecated. Replace with :ndf:`copy("tags")` 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:38: WARNING: The [[copy('id')]] syntax in need content is deprecated. Replace with :ndf:`copy('id')` instead. [needs.deprecated]",
"srcdir/index.rst:44: WARNING: Error while executing function 'copy': Need not found [needs.dynamic_function]",
"srcdir/index.rst:44: WARNING: Error while executing function 'copy': Need not found [needs.dynamic_function]",
]
html = Path(app.outdir, "index.html").read_text()
assert "This is id SP_TOO_001" in html
assert "This is also id SP_TOO_001" in html
assert "This is the best id SP_TOO_001" in html
assert (
sum(1 for _ in re.finditer('<span class="needs_data">test2</span>', html)) == 2
)
assert (
sum(1 for _ in re.finditer('<span class="needs_data">test</span>', html)) == 2
)
assert (
sum(1 for _ in re.finditer('<span class="needs_data">my_tag</span>', html)) == 1
)
assert (
sum(1 for _ in re.finditer('<span class="needs_data">test_4a</span>', html))
== 1
)
assert (
sum(1 for _ in re.finditer('<span class="needs_data">test_4b</span>', html))
== 1
)
assert (
sum(1 for _ in re.finditer('<span class="needs_data">TEST_4</span>', html)) == 2
)
assert (
sum(1 for _ in re.finditer('<span class="needs_data">TEST_5</span>', html)) == 2
)
assert "Test output of dynamic function; need: TEST_3" in html
assert "Test dynamic func in tags: test_4a, test_4b, TEST_4" in html
assert '<a class="reference external" href="http://www.TEST_5">link</a>' in html
assert "nested id TEST_6" in html
assert "nested id also TEST_6" in html
assert "nested id best TEST_6" in html
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_df_calc_sum"}],
indirect=True,
)
def test_doc_df_calc_sum(test_app):
app = test_app
app.build()
html = Path(app.outdir, "index.html").read_text()
assert "43210" in html # all hours
assert "3210" in html # hours of linked needs
assert "210" in html # hours of filtered needs
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_df_check_linked_values"}],
indirect=True,
)
def test_doc_df_linked_values(test_app):
app = test_app
app.build()
html = Path(app.outdir, "index.html").read_text()
assert "all_good" in html
assert "all_bad" not in html
assert "all_awesome" in html
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/doc_df_user_functions",
"no_plantuml": True,
}
],
indirect=True,
)
def test_doc_df_user_functions(test_app):
app = test_app
app.build()
warnings = strip_colors(
app._warning.getvalue().replace(str(app.srcdir) + os.sep, "srcdir/")
).splitlines()
# print(warnings)
expected = [
"srcdir/index.rst:10: WARNING: Return value of function 'bad_function' is of type <class 'object'>. Allowed are str, int, float, list [needs.dynamic_function]",
"srcdir/index.rst:8: WARNING: The [[my_own_function()]] syntax in need content is deprecated. Replace with :ndf:`my_own_function()` instead. [needs.deprecated]",
"srcdir/index.rst:14: WARNING: The [[bad_function()]] syntax in need content is deprecated. Replace with :ndf:`bad_function()` instead. [needs.deprecated]",
"srcdir/index.rst:14: WARNING: Return value of function 'bad_function' is of type <class 'object'>. Allowed are str, int, float, list [needs.dynamic_function]",
"srcdir/index.rst:16: WARNING: The [[invalid]] syntax in need content is deprecated. Replace with :ndf:`invalid` instead. [needs.deprecated]",
"srcdir/index.rst:16: WARNING: Function string 'invalid' could not be parsed: Given dynamic function string is not a valid python call. Got: invalid [needs.dynamic_function]",
"srcdir/index.rst:18: WARNING: The [[unknown()]] syntax in need content is deprecated. Replace with :ndf:`unknown()` instead. [needs.deprecated]",
"srcdir/index.rst:18: WARNING: Unknown function 'unknown' [needs.dynamic_function]",
]
if version_info >= (7, 3):
warn = "WARNING: cannot cache unpickable configuration value: 'needs_functions' (because it contains a function, class, or module object)"
if version_info >= (8, 0):
warn += " [config.cache]"
if version_info >= (8, 2):
warn = warn.replace("unpickable", "unpickleable")
expected.insert(0, warn)
assert warnings == expected
html = Path(app.outdir, "index.html").read_text()
assert "Awesome" in html
|
