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
|
"""Test for SmartFactory generator base.
Verifies common helper functions and produced source code.
"""
import collections
import unittest
from pathlib import Path
import sys
sys.path.append(Path(__file__).absolute().parents[3].as_posix())
sys.path.append(Path(__file__).absolute().parents[4].joinpath('rpc_spec/InterfaceParser').as_posix())
try:
from generator.generators import SmartFactoryBase
from model.enum import Enum
from model.enum_element import EnumElement
from model.issue import Issue
from generator.generators import SmartFactoryBase
except ModuleNotFoundError as error:
print('{}.\nProbably you did not initialize submodule'.format(error))
sys.exit(1)
EXPECTED_RESULT_FULL_COMMENT = u"""/**
* @brief Enumeration Test Name.
*
* Description Line1
* Description Line2
*
* Design Line1
*
* @note Issue1
* @note Issue2
* @note Issue3
*
* @todo Do1
* @todo Do2
*/"""
EXPECTED_RESULT_ENUM_ELEMENT1 = u"""/**
* @brief InternalName.
*/
InternalName = 10"""
EXPECTED_RESULT_ENUM_ELEMENT2 = u"""/**
* @brief NO_VALUE_ELEMENT.
*
* Description Line1
* Description Line2
*
* Design Line1
*/
NO_VALUE_ELEMENT"""
EXPECTED_RESULT_ENUM_ELEMENTS1 = u"""/**
* @brief name1.
*
* Design Line1
*
* @todo Do1
* @todo Do2
*/
name1 = 1,
/**
* @brief internal_name2.
*
* Description Line1
* Description Line2
*
* @note Issue1
* @note Issue2
* @note Issue3
*/
internal_name2"""
EXPECTED_RESULT_ENUM1 = u"""namespace Enum1 {
/**
* @brief Enumeration Enum1.
*
* @todo Do1
* @todo Do2
*/
enum eType {
/**
* @brief INVALID_ENUM.
*/
INVALID_ENUM = -1,
/**
* @brief name1.
*
* Design Line1
*
* @todo Do1
* @todo Do2
*/
name1 = 1,
/**
* @brief internal_name2.
*
* Description Line1
* Description Line2
*
* @note Issue1
* @note Issue2
* @note Issue3
*/
internal_name2
};
} // Enum1
"""
EXPECTED_RESULT_ENUM2 = u"""namespace E2 {
/**
* @brief Enumeration E2.
*/
enum eType {
/**
* @brief INVALID_ENUM.
*/
INVALID_ENUM = -1,
/**
* @brief val_1.
*/
val_1,
/**
* @brief val_2.
*/
val_2 = 100,
/**
* @brief val_3.
*/
val_3
};
} // E2
"""
DESCRIPTION = [u"Description Line1", u"Description Line2"]
DESIGN_DESCRIPTION = [u"Design Line1"]
ISSUES = [Issue(value=u"Issue1"),
Issue(value=u"Issue2"),
Issue(value=u"Issue3")]
TODOS = [u"Do1", u"Do2"]
class Test(unittest.TestCase):
"""Test for SmartFactory base generator.
This class holds set of test cases for the SmartFactory base generator.
"""
def test_gen_comment(self):
"""Test generation of the source code comments.
Verifies correct generation of the code comments.
"""
generator = SmartFactoryBase.CodeGenerator()
enum = Enum(name=u"Test Name",
description=DESCRIPTION,
design_description=DESIGN_DESCRIPTION,
issues=ISSUES,
todos=TODOS)
self.assertEqual(generator._gen_comment(enum),
EXPECTED_RESULT_FULL_COMMENT,
"Full comment for enum is invalid")
def test_gen_enum_element(self):
"""Test generation of the single enum element.
Verifies correct generation of the single enum element.
"""
generator = SmartFactoryBase.CodeGenerator()
enum_element1 = EnumElement(name=u"Element1",
internal_name=u"InternalName",
value=u"10")
self.assertEqual(
generator._gen_enum_element(enum_element1),
EXPECTED_RESULT_ENUM_ELEMENT1,
"Short commented enum element with internal name is invalid")
enum_element2 = EnumElement(
name=u"NO_VALUE_ELEMENT",
description=DESCRIPTION,
design_description=DESIGN_DESCRIPTION)
self.assertEqual(generator._gen_enum_element(enum_element2),
EXPECTED_RESULT_ENUM_ELEMENT2,
"Enum element with no value is invalid")
def test_gen_enum_elements(self):
"""Test generation of the enum elements.
Verifies correct generation of the enum elements.
"""
generator = SmartFactoryBase.CodeGenerator()
elements = [EnumElement(name=u"name1",
design_description=DESIGN_DESCRIPTION,
todos=TODOS,
value=u"1"),
EnumElement(name=u"name2",
description=DESCRIPTION,
issues=ISSUES,
internal_name=u"internal_name2")]
self.assertEqual(generator._gen_enum_elements(elements),
EXPECTED_RESULT_ENUM_ELEMENTS1,
"Simple enum elements are invalid")
def test_gen_enum(self):
"""Test generation of the enum.
Verifies correct generation of the enum.
"""
generator = SmartFactoryBase.CodeGenerator()
elements1 = collections.OrderedDict()
elements1[u"name1"] = EnumElement(
name=u"name1",
design_description=DESIGN_DESCRIPTION,
todos=TODOS,
value=u"1")
elements1[u"name2"] = EnumElement(
name=u"name2",
description=DESCRIPTION,
issues=ISSUES,
internal_name=u"internal_name2")
enum1 = Enum(name=u"Enum1",
todos=TODOS,
elements=elements1)
self.assertEqual(generator._gen_enum(enum1),
EXPECTED_RESULT_ENUM1,
"Simple enum is invalid")
elements2 = collections.OrderedDict()
elements2[u"xxx"] = EnumElement(name=u"xxx",
internal_name=u"val_1")
elements2[u"yyy"] = EnumElement(name=u"yyy",
internal_name=u"val_2",
value=u"100")
elements2[u"zzz"] = EnumElement(name=u"val_3")
enum2 = Enum(name=u"E2",
elements=elements2)
self.assertEqual(generator._gen_enum(enum2),
EXPECTED_RESULT_ENUM2,
"Long enum is invalid")
self.assertEqual(generator._gen_enums([enum1, enum2],
collections.OrderedDict()),
u"{0}\n{1}".format(EXPECTED_RESULT_ENUM1,
EXPECTED_RESULT_ENUM2),
"Generated enums are invalid")
def test_normalize_multiline_comments(self):
"""Test normalization of the multiline comments.
Verifies correct normalization of the multiline comments.
"""
generator = SmartFactoryBase.CodeGenerator()
self.assertEqual(generator._normalize_multiline_comments([]), [])
self.assertEqual(generator._normalize_multiline_comments(["aaa",
"bbb",
"ccc ccc",
"ddd\tddd"]),
["aaa", "bbb", "ccc ccc", "ddd\tddd"])
self.assertEqual(generator._normalize_multiline_comments(["aaa\n1",
"bbb\r\n2",
"ccc\r3",
"aaa aaa"]),
["aaa", "1", "bbb", "2", "ccc", "3", "aaa aaa"])
if __name__ == '__main__':
unittest.main()
|
