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
|
import re
from typing import Iterable
import lxml.etree as etree
import pytest
from doxysphinx.html_parser import RstBlockProcessor
from doxysphinx.utils.contexts import TimedContext
rst_block_with_doxysphinx_marker = """
<div>
<pre class="fragment">{rst}
* .. need:: test
* :status: open
*
* This is the description
</pre>
</div>
"""
rst_block_with_doxysphinx_autodetect_directive = """
<div>
<pre class="fragment">
* .. need:: test
* :status: open
*
* This is the description
</pre>
</div>
"""
rst_block_with_doxysphinx_marker_and_strange_comments = """
<div>
<pre class="fragment">{rst}
//! .. need:: test
//! :status: open
//!
//! This is the description
</pre>
</div>
"""
rst_block_with_breathe_general_marker = """
<div>
<pre class="fragment">embed:rst
* .. need:: test
* :status: open
*
* This is the description
</pre>
</div>
"""
rst_block_with_breathe_leading_asterisk_marker = """
<div>
<pre class="fragment">embed:rst:leading-asterisk
*.. need:: test
* :status: open
*
* This is the description
</pre>
</div>
"""
rst_block_with_breathe_leading_slashes_marker = """
<div>
<pre class="fragment">embed:rst:leading-slashes
///.. need:: test
/// :status: open
///
/// This is the description
</pre>
</div>
"""
invalid_rst_block_without_any_marker = """
<div>
<pre class="fragment">
..need: test
:status: open
This is the description
</pre>
</div>
"""
invalid_rst_block_with_breathe_inline_rst_marker = """
<div>
<pre class="fragment">embed:rst:inline
.. need:: test
:status: open
This is the description
</pre>
</div>
"""
expected_rst_block = """
<div>
<snippet type="rst:block">
.. need:: test
:status: open
This is the description
</snippet>
</div>
"""
def _load_code_element(html_string: str) -> etree._Element:
parser: Any = etree.HTMLParser()
e = etree.fromstring(html_string, parser)
result: Any = e.find(f".//pre")
if result is None:
result = e.find(f".//code")
return result
def _clean_html_string(html: str):
return html.replace("\n", "").replace(" ", "").replace("> ", ">").replace(" <", "<").strip()
@pytest.mark.parametrize(
"input, expected",
[
pytest.param(rst_block_with_doxysphinx_marker, expected_rst_block, id="rst_block_with_doxysphinx_marker"),
pytest.param(
rst_block_with_doxysphinx_autodetect_directive,
expected_rst_block,
id="rst_block_with_doxysphinx_autodetect_directive",
),
pytest.param(
rst_block_with_doxysphinx_marker_and_strange_comments,
expected_rst_block,
id="rst_block_with_doxysphinx_marker_and_strange_comments",
),
pytest.param(
rst_block_with_breathe_general_marker, expected_rst_block, id="rst_block_with_breathe_general_marker"
),
pytest.param(
rst_block_with_breathe_leading_asterisk_marker,
expected_rst_block,
id="rst_block_with_breathe_leading_asterisk_marker",
),
pytest.param(
rst_block_with_breathe_leading_slashes_marker,
expected_rst_block,
id="rst_block_with_breathe_leading_slashes_marker",
),
],
)
def test_rst_block_processor_works_as_expected(input: str, expected: str):
element = _load_code_element(input)
proc = RstBlockProcessor()
result = proc.try_process(element)
assert result is True
root_div = element.getparent()
rendered_element = etree.tostring(root_div, encoding="unicode")
a = _clean_html_string(rendered_element)
b = _clean_html_string(expected)
assert a == b
@pytest.mark.parametrize(
"input, expected",
[
pytest.param(
invalid_rst_block_without_any_marker,
invalid_rst_block_without_any_marker,
id="invalid_rst_block_without_any_marker",
),
pytest.param(
invalid_rst_block_with_breathe_inline_rst_marker,
invalid_rst_block_with_breathe_inline_rst_marker,
id="invalid_rst_block_with_breathe_inline_rst_marker",
),
],
)
def test_rst_block_processor_with_invalid_blocks_does_nothing(input: str, expected: str):
element = _load_code_element(input)
proc = RstBlockProcessor()
result = proc.try_process(element)
assert result is False
root_div = element.getparent()
rendered_element = etree.tostring(root_div, encoding="unicode", pretty_print=True)
a = rendered_element.strip()
b = expected.strip()
assert a == b
|
