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
|
import os
from pathlib import Path
from unittest.mock import Mock
import pytest
from sphinx.util.console import strip_colors
from sphinx_needs.filter_common import filter_needs_parts, filter_needs_view
from sphinx_needs.views import NeedsView
@pytest.mark.parametrize(
"test_app",
[{"buildername": "html", "srcdir": "doc_test/filter_doc"}],
indirect=True,
)
def test_filter_build_html(test_app):
app = test_app
app.build()
warnings = strip_colors(app._warning.getvalue()).replace(
str(app.srcdir) + os.path.sep, "<srcdir>/"
)
# print(warnings.splitlines())
expected_warnings = [
"<srcdir>/index.rst:51: WARNING: Filter 'xxx' not valid. Error: name 'xxx' is not defined. [needs.filter]",
"<srcdir>/index.rst:54: WARNING: Filter '1' not valid. Error: Filter did not evaluate to a boolean, instead <class 'int'>: 1. [needs.filter]",
"<srcdir>/index.rst:57: WARNING: Filter 'yyy' not valid. Error: name 'yyy' is not defined. [needs.filter]",
"<srcdir>/index.rst:60: WARNING: Sorting parameter yyy not valid: Error: 'yyy' [needs.filter]",
"<srcdir>/index.rst:63: WARNING: Filter 'zzz' not valid. Error: name 'zzz' is not defined. [needs.filter]",
]
assert warnings.splitlines() == expected_warnings
html = Path(app.outdir, "index.html").read_text()
assert "story_a_1" in html
assert "story_b_1" not in html
assert "story_a_b_1" in html
assert "req_a_1" not in html
assert "req_b_1" not in html
assert "req_c_1" in html
html_2 = Path(app.outdir, "filter_tags_or.html").read_text()
assert "req_a" in html_2
assert "req_b" in html_2
assert "req_c" in html_2
html_3 = Path(app.outdir, "filter_all.html").read_text()
assert "req_a_not" not in html_3
assert "req_b_found" in html_3
assert "req_c_not" not in html_3
assert "req_d_found" in html_3
assert "story_1_not" not in html_3
assert "story_2_found" in html_3
assert "my_test" in html_3
html_4 = Path(app.outdir, "filter_search.html").read_text()
assert "search_a" in html_4
assert "search_b" not in html_4
assert "search_c" not in html_4
assert "search_d" not in html_4
assert "search_2_1" in html_4
assert "search_2_2" in html_4
assert "test_email" in html_4
# nested needs
html_5 = Path(app.outdir, "nested_needs.html").read_text()
assert "STORY_PARENT" in html_5
assert "CHILD_1_STORY" in html_5
assert "CHILD_2_STORY" in html_5
assert (
'<div class="line">child needs: <span class="parent_needs"><span><a class="reference internal" '
'href="#CHILD_1_STORY" title="STORY_PARENT">CHILD_1_STORY</a></span></span></div>'
in html_5
)
assert (
'<div class="line">parent needs: <span class="parent_needs"><span><a class="reference internal" '
'href="#CHILD_1_STORY" title="CHILD_2_STORY">CHILD_1_STORY</a></span></span></div>'
in html_5
)
html_6 = Path(app.outdir, "filter_no_needs.html").read_text()
assert html_6.count("No needs passed the filters") == 6
assert html_6.count("Should show no specific message and no default message") == 6
assert html_6.count("<figure class=") == 3
assert html_6.count("got filter warning from needtable") == 1
assert "no filter warning from needtable" not in html_6
assert html_6.count('<table class="NEEDS_DATATABLES') == 1
assert html_6.count("got filter warning from needlist") == 1
assert "no filter warning from needlist" not in html_6
assert html_6.count("got filter warning from needflow") == 1
assert "no filter warning from needflow" not in html_6
assert html_6.count("got filter warning from needgant") == 1
assert "no filter warning from needgant" not in html_6
assert (
html_6.count("got filter warning from needsequence") == 1
) # maybe fixed later, now always start node is shown
assert "no filter warning from needsequence" not in html_6
assert html_6.count("got filter warning from needpie") == 1
assert "no filter warning from needpie" not in html_6
assert '<img alt="_images/need_pie_' in html_6
assert html_6.count('<p class="needs_filter_warning"') == 18
def create_needs_view():
needs = [
{
"id": "req_a_1",
"type": "requirement",
"type_name": "Req",
"tags": ["a", "b"],
"status": "",
"is_external": False,
"parts": {},
},
{
"id": "req_b_1",
"type": "requirement",
"type_name": "Req",
"tags": ["b", "c"],
"status": "",
"is_external": False,
"parts": {},
},
{
"id": "req_c_1",
"type": "requirement",
"type_name": "Req",
"tags": ["c", "d"],
"status": "",
"is_external": False,
"parts": {},
},
{
"id": "story_a_1",
"type": "story",
"type_name": "Story",
"tags": ["a", "b"],
"status": "",
"is_external": True,
"parts": {},
},
{
"id": "story_b_1",
"type": "story",
"type_name": "Story",
"tags": ["b", "c"],
"status": "ongoing",
"is_external": False,
"parts": {},
},
{
"id": "story_a_b_1",
"type": "story",
"type_name": "Story",
"tags": ["a", "b", "c"],
"status": "done",
"is_external": False,
"parts": {
"part_a": {
"id": "part_a",
},
},
},
]
return NeedsView._from_needs({n["id"]: n for n in needs})
std_test_params = (
("", list(create_needs_view()), True),
("True", list(create_needs_view()), True),
("xxx", list(create_needs_view()), False),
("not xxx", [], False),
("False", [], True),
("False and False", [], True),
("False and True", [], True),
("True and True", list(create_needs_view()), True),
("True or False", list(create_needs_view()), False),
("id == 'req_a_1'", ["req_a_1"], True),
("id == 'unknown'", [], True),
("is_external", ["story_a_1"], True),
("is_external==True", ["story_a_1"], True),
("type == 'requirement'", ["req_a_1", "req_b_1", "req_c_1"], True),
("type == 'unknown'", [], True),
("type == 'requirement' and True", ["req_a_1", "req_b_1", "req_c_1"], True),
("type == 'requirement' and False", [], True),
("type == 'story' and status == 'done'", ["story_a_b_1"], True),
("status in ['ongoing', 'done']", ["story_b_1", "story_a_b_1"], True),
("status in ('ongoing', 'done')", ["story_b_1", "story_a_b_1"], True),
("status in {'ongoing', 'done'}", ["story_b_1", "story_a_b_1"], True),
("'d' in tags", ["req_c_1"], True),
("'a' in tags", ["story_a_1", "req_a_1", "story_a_b_1"], True),
)
@pytest.mark.parametrize(
"filter_string, expected_ids, strict_eval",
std_test_params,
ids=[s for s, _, _ in std_test_params],
)
def test_filter_needs_view(filter_string, expected_ids, strict_eval):
mock_config = Mock()
mock_config.filter_data = {"xxx": True}
result = filter_needs_view(
create_needs_view(), mock_config, filter_string, strict_eval=strict_eval
)
assert {n["id"] for n in result} == set(expected_ids)
_all_need_part_ids = []
for need in create_needs_view().values():
_all_need_part_ids.append(need["id"])
_all_need_part_ids.extend(need["parts"])
part_test_params = (
("", _all_need_part_ids, True),
("True", _all_need_part_ids, True),
("xxx", _all_need_part_ids, False),
("not xxx", [], False),
("False", [], True),
("False and False", [], True),
("False and True", [], True),
("True and True", _all_need_part_ids, True),
("True or False", _all_need_part_ids, False),
("id == 'req_a_1'", ["req_a_1"], True),
("id == 'unknown'", [], True),
("is_external", ["story_a_1"], True),
("is_external==True", ["story_a_1"], True),
("type == 'requirement'", ["req_a_1", "req_b_1", "req_c_1"], True),
("type == 'unknown'", [], True),
("type == 'requirement' and True", ["req_a_1", "req_b_1", "req_c_1"], True),
("type == 'requirement' and False", [], True),
("type == 'story' and status == 'done'", ["story_a_b_1", "part_a"], True),
("status in ['ongoing', 'done']", ["story_b_1", "story_a_b_1", "part_a"], True),
("status in ('ongoing', 'done')", ["story_b_1", "story_a_b_1", "part_a"], True),
("status in {'ongoing', 'done'}", ["story_b_1", "story_a_b_1", "part_a"], True),
("'d' in tags", ["req_c_1"], True),
("'a' in tags", ["story_a_1", "req_a_1", "story_a_b_1", "part_a"], True),
("id == 'part_a'", ["part_a"], True),
("id in ['part_a', 'req_a_1']", ["part_a", "req_a_1"], True),
("id in ['part_a', 'story_a_b_1']", ["story_a_b_1", "part_a"], True),
)
@pytest.mark.parametrize(
"filter_string, expected_ids, strict_eval",
part_test_params,
ids=[s for s, _, _ in part_test_params],
)
def test_filter_needs_parts(filter_string, expected_ids, strict_eval):
mock_config = Mock()
mock_config.filter_data = {"xxx": True}
result = filter_needs_parts(
create_needs_view().to_list_with_parts(),
mock_config,
filter_string,
str,
strict_eval=strict_eval,
)
assert {n["id"] for n in result} == set(expected_ids)
def test_filter_needs_then_parts():
npl = (
create_needs_view()
.filter_ids(["story_b_1", "story_a_b_1"])
.to_list_with_parts()
.filter_has_tag(["a"])
)
assert {n["id"] for n in npl} == {"story_a_b_1", "part_a"}
|
