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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
import subprocess
from pathlib import Path
import pytest
from syrupy.filters import props
from sphinx_needs.data import SphinxNeedsData
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml"}],
indirect=True,
)
def test_doc_build_html(test_app, snapshot):
app = test_app
app.build()
assert Path(app.outdir, "index.html").read_text(encoding="utf8")
data = SphinxNeedsData(app.env)
all_needs = dict(data.get_needs_view())
assert all_needs == snapshot()
all_needumls = data.get_or_create_umls()
assert all_needumls == snapshot(exclude=props("process_time"))
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_duplicate_key"}],
indirect=True,
)
def test_needuml_option_key_duplicate(test_app):
app = test_app
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 1
assert (
"sphinx_needs.directives.needuml.NeedumlException: Inside need: INT_001, "
"found duplicate Needuml option key name: sequence"
in out.stderr.decode("utf-8")
)
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_key_name_diagram"}],
indirect=True,
)
def test_needuml_option_key_forbidden(test_app):
app = test_app
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 1
assert (
"sphinx_needs.directives.needuml.NeedumlException: Needuml option key name can't be: diagram"
in out.stderr.decode("utf-8")
)
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_diagram_allowmixing"}],
indirect=True,
)
def test_needuml_diagram_allowmixing(test_app):
app = test_app
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 0
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_save"}],
indirect=True,
)
def test_needuml_save(test_app, snapshot):
app = test_app
app.build()
# check generated plantuml code saved in given path
from sys import platform
if platform == "win32":
assert "doc_needuml_save\\_build\\html" in str(app.outdir)
else:
assert "doc_needuml_save/_build/html" in str(app.outdir)
assert app.config.needs_build_needumls == "my_needumls"
uml_path = Path(app.outdir).joinpath(app.config.needs_build_needumls)
umls = {
"uml1": uml_path.joinpath("_build", "my_needuml.puml").read_text(),
"uml2": uml_path.joinpath("_out", "sub_folder", "my_needs.puml").read_text(),
}
assert umls == snapshot
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_save_with_abs_path"}],
indirect=True,
)
def test_needuml_save_with_abs_path(test_app):
app = test_app
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 1
assert (
"sphinx_needs.directives.needuml.NeedumlException: "
"Given save path: /_out/my_needuml.puml, is not a relative path."
in out.stderr.decode("utf-8")
)
@pytest.mark.parametrize(
"test_app",
[{"buildername": "needumls", "srcdir": "doc_test/doc_needuml_save"}],
indirect=True,
)
def test_needumls_builder(test_app, snapshot):
app = test_app
app.build()
# check generated plantuml code saved in given path
from sys import platform
if platform == "win32":
assert "doc_needuml_save\\_build\\needumls" in str(app.outdir)
else:
assert "doc_needuml_save/_build/needumls" in str(app.outdir)
uml_path = Path(app.outdir)
umls = {
"uml1": uml_path.joinpath("_build", "my_needuml.puml").read_text(),
"uml2": uml_path.joinpath("_out", "sub_folder", "my_needs.puml").read_text(),
}
assert umls == snapshot
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_filter"}],
indirect=True,
)
def test_needuml_filter(test_app, snapshot):
app = test_app
app.build()
all_needumls = app.env._needs_all_needumls
assert all_needumls == snapshot(exclude=props("process_time"))
html = Path(app.outdir, "index.html").read_text(encoding="utf8")
assert "as ST_002 [[../index.html#ST_002]]" in html
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 0
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_jinja_func_flow"}],
indirect=True,
)
def test_needuml_jinja_func_flow(test_app, snapshot):
app = test_app
app.build()
all_needumls = app.env._needs_all_needumls
assert all_needumls == snapshot(exclude=props("process_time"))
html = Path(app.outdir, "index.html").read_text(encoding="utf8")
assert "as ST_001 [[../index.html#ST_001]]" in html
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 0
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_jinja_func_need_removed"}],
indirect=True,
)
def test_needuml_jinja_func_need_removed(test_app):
app = test_app
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 1
assert (
"sphinx_needs.directives.needuml.NeedumlException: "
"Jinja function 'need()' is not supported in needuml directive."
in out.stderr.decode("utf-8")
)
@pytest.mark.parametrize(
"test_app",
[
{
"buildername": "html",
"srcdir": "doc_test/doc_needuml_jinja_func_import_negative_tests",
}
],
indirect=True,
)
def test_doc_needarch_jinja_import_negative(test_app):
app = test_app
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 1
assert (
"sphinx_needs.directives.needuml.NeedumlException: "
"Jinja function 'import()' is not supported in needuml directive."
in out.stderr.decode("utf-8")
)
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/doc_needuml_jinja_func_ref"}],
indirect=True,
)
def test_needuml_jinja_func_ref(test_app, snapshot):
app = test_app
app.build()
all_needumls = app.env._needs_all_needumls
assert all_needumls == snapshot(exclude=props("process_time"))
html = Path(app.outdir, "index.html").read_text(encoding="utf8")
assert "Marvel: [[../index.html#ST_001 Test story]]" in html
assert "DC: [[../index.html#ST_002 Different text to explain the story]]" in html
assert "Marvel: [[../index.html#ST_001.np_id np_id]]" in html
assert "DC: [[../index.html#ST_001.np_id np_content]]" in html
assert (
"Marvel: [[../index.html#ST_001.np_id Different text to explain the story 2]]"
in html
)
srcdir = Path(app.srcdir)
out_dir = srcdir / "_build"
out = subprocess.run(
["sphinx-build", "-M", "html", srcdir, out_dir], capture_output=True
)
assert out.returncode == 0
|
