-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathvariable_naming_rule_test.py
390 lines (369 loc) · 13.9 KB
/
variable_naming_rule_test.py
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
import test_support
class VariableNamingRuleTest(test_support.TestBase):
def setUp(self):
self.set_default_rules_selection(['VariableNamingRule'])
self.set_default_error_id('variable naming')
self.set_default_error_severity('style')
def test_function_local_variable_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo { int x; };',
'void Bar()',
'{',
' int camel = 1;',
' float camelCase = 2.0f;',
' const char* camelCaseName = "3";',
' Foo aDDoubledCapitalInCamelCaseName{4};',
'}'
],
expected_errors = [])
def test_function_local_variable_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'void Bar()',
'{',
' int under_score_name = 1;',
' float CapitalCaseName = 2.0f;',
' const char* ALLCAPS = "3";',
'}'
],
expected_errors = [
{
'msg': "Local variable 'under_score_name' should be named in camelCase style",
'line': '3'
},
{
'msg': "Local variable 'CapitalCaseName' should be named in camelCase style",
'line': '4'
},
{
'msg': "Local variable 'ALLCAPS' should be named in camelCase style",
'line': '5'
}
])
def test_function_parameter_variable_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo { int x; };',
'void Bar(int camel,',
' float camelCase,',
' const char* camelCaseName,',
' Foo aDDoubledCapitalInCamelCaseName)',
'{',
'}'
],
expected_errors = [])
def test_function_parameter_variable_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'void Bar(int under_score_name,',
' float CapitalCaseName,',
' const char* ALLCAPS)',
'{',
'}'
],
expected_errors = [
{
'msg': "Local variable 'under_score_name' should be named in camelCase style",
'line': '1'
},
{
'msg': "Local variable 'CapitalCaseName' should be named in camelCase style",
'line': '2'
},
{
'msg': "Local variable 'ALLCAPS' should be named in camelCase style",
'line': '3'
}
])
def test_const_global_variable_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo { int x; };',
'const int ALL = 1;',
'const float ALL_CAPITAL = 2.0f;',
'const char* const ALL_CAPITAL_LETTERS = "3";',
'const Foo ALL_CAPITALS{4};'
],
expected_errors = [])
def test_const_global_variable_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo { int x; };',
'const int NOT_ALL_capitals = 1;',
'const float _STARTING_FROM_UNDERSCORE = 2.0f;',
'const char* const camelCase = "3";',
'const Foo g_namedLikeNonConstGlobal{4};'
],
expected_errors = [
{
'msg': "Const global variable 'NOT_ALL_capitals' should be named in ALL_CAPS style",
'line': '2'
},
{
'msg': "Const global variable '_STARTING_FROM_UNDERSCORE' should be named in ALL_CAPS style",
'line': '3'
},
{
'msg': "Const global variable 'camelCase' should be named in ALL_CAPS style",
'line': '4'
},
{
'msg': "Const global variable 'g_namedLikeNonConstGlobal' should be named in ALL_CAPS style",
'line': '5'
}
])
def test_non_const_global_variable_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo { int x; };',
'int g_prefixed = 1;',
'float g_prefixedCamel = 2.0f;',
'const char* g_prefixedCamelCase = "3";',
'Foo g_prefixedCamelCaseName{4};'
],
expected_errors = [])
def test_non_const_global_variable_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo { int x; };',
'int notPrefixedCamelCase = 1;',
'float m_wronglyPefixed = 2.0f;',
'const char* ALL_CAPS = "3";',
'Foo CapitalCaseName{4};'
],
expected_errors = [
{
'msg': "Non-const global variable 'notPrefixedCamelCase' should be named in g_camelCase style",
'line': '2'
},
{
'msg': "Non-const global variable 'm_wronglyPefixed' should be named in g_camelCase style",
'line': '3'
},
{
'msg': "Non-const global variable 'ALL_CAPS' should be named in g_camelCase style",
'line': '4'
},
{
'msg': "Non-const global variable 'CapitalCaseName' should be named in g_camelCase style",
'line': '5'
}
])
def test_deprecated_variable_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'void Bar()',
'{',
' bool bBool = false;',
' int* pPtr = nullptr;',
' int p1 = 0; // but this is fine',
'}'
],
expected_errors = [
{
'msg': "Local variable 'bBool' is named in a style that is deprecated",
'line': '3'
},
{
'msg': "Local variable 'pPtr' is named in a style that is deprecated",
'line': '4'
}
])
def test_public_static_class_member_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo',
'{',
' static const int camelCase;',
' static float camelCaseName;',
' static const char* aDDoubledCapitalInCamelCaseName;',
'};'
],
expected_errors = [])
def test_public_static_class_member_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo',
'{',
' static const int under_score_name;',
' static float CapitalCaseName;',
' static const char* ALLCAPS;',
'};'
],
expected_errors = [
{
'msg': "Public field 'under_score_name' should be named in camelCase style",
'line': '3'
},
{
'msg': "Public field 'CapitalCaseName' should be named in camelCase style",
'line': '4'
},
{
'msg': "Public field 'ALLCAPS' should be named in camelCase style",
'line': '5'
}
])
def test_private_and_protected_static_class_member_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'class Foo',
'{',
' static const int m_camelCase;',
'protected:',
' static float m_camelCaseName;',
'private:',
' static const char* m_aDDoubledCapitalInCamelCaseName;',
'};'
],
expected_errors = [])
def test_private_and_protected_static_class_member_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'class Foo',
'{',
' static int under_score_name;',
'protected:',
' static float CapitalCaseName;',
'private:',
' static const char* ALLCAPS;',
'};'
],
expected_errors = [
{
'msg': "Private field 'under_score_name' should be named in m_camelCase style",
'line': '3'
},
{
'msg': "Protected field 'CapitalCaseName' should be named in m_camelCase style",
'line': '5'
},
{
'msg': "Private field 'ALLCAPS' should be named in m_camelCase style",
'line': '7'
}
])
def test_public_class_member_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo',
'{',
' const int camelCase;',
' float camelCaseName;',
' const char* aDDoubledCapitalInCamelCaseName;',
'};'
],
expected_errors = [])
def test_public_class_member_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo',
'{',
' const int under_score_name;',
' float CapitalCaseName;',
' const char* ALLCAPS;',
'};'
],
expected_errors = [
{
'msg': "Public field 'under_score_name' should be named in camelCase style",
'line': '3'
},
{
'msg': "Public field 'CapitalCaseName' should be named in camelCase style",
'line': '4'
},
{
'msg': "Public field 'ALLCAPS' should be named in camelCase style",
'line': '5'
}
])
def test_private_and_protected_class_member_correct_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'class Foo',
'{',
' Foo();',
' const int m_camelCase;',
'protected:',
' float m_camelCaseName;',
'private:',
' const char* m_aDDoubledCapitalInCamelCaseName;',
'};'
],
expected_errors = [])
def test_private_and_protected_class_member_incorrect_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'class Foo',
'{',
' int under_score_name;',
'protected:',
' float CapitalCaseName;',
'private:',
' const char* ALLCAPS;',
'};'
],
expected_errors = [
{
'msg': "Private field 'under_score_name' should be named in m_camelCase style",
'line': '3'
},
{
'msg': "Protected field 'CapitalCaseName' should be named in m_camelCase style",
'line': '5'
},
{
'msg': "Private field 'ALLCAPS' should be named in m_camelCase style",
'line': '7'
}
])
def test_deprecated_class_member_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'class Foo',
'{',
' bool m_bBool;',
' int* m_pPtr;',
' int m_p1; // but this is fine',
'};'
],
expected_errors = [
{
'msg': "Private field 'm_bBool' is named in a style that is deprecated",
'line': '3'
},
{
'msg': "Private field 'm_pPtr' is named in a style that is deprecated",
'line': '4'
}
])
def test_ignore_compiler_generated_names(self):
self.assert_colobot_lint_result(
source_file_lines = [
'void Print(int);',
'void PrintNums()',
'{',
' int nums[] = {1, 2, 3, 4};',
' for (auto x : nums) // compiler generates __range, __begin and __end locals here',
' {',
' Print(x);',
' }',
'',
'}'
],
expected_errors = [])
def test_allow_names_with_numbers(self):
self.assert_colobot_lint_result(
source_file_lines = [
'struct Foo { int x; };',
'void Bar()',
'{',
' int camel1 = 1;',
' float camelCase2 = 2.0f;',
' const char* camel123CaseName = "3";',
' Foo aDoubled44NumberInCamelCaseName{4};',
'}'
],
expected_errors = [])