-
Notifications
You must be signed in to change notification settings - Fork 581
/
KeywordBearTest.py
241 lines (205 loc) · 9.08 KB
/
KeywordBearTest.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
from collections import namedtuple
from queue import Queue
import unittest
import logging
from bears.general.KeywordBear import KeywordBear
from coalib.results.HiddenResult import HiddenResult
from coalib.results.SourceRange import SourceRange
from coalib.settings.Section import Section
from coalib.settings.Setting import Setting
from coalib.testing.LocalBearTestHelper import verify_local_bear, execute_bear
test_file = """
test line fix me
to do
error fixme
"""
KeywordBearTest = verify_local_bear(
KeywordBear,
valid_files=(test_file,),
invalid_files=('test line todo',
'test line warNING'),
settings={'keywords': 'todo, warning'})
class KeywordBearDiffTest(unittest.TestCase):
def setUp(self):
self.section = Section('')
self.section.append(Setting('language', 'python3'))
self.section.append(Setting('keywords', 'TODO'))
self.uut = KeywordBear(self.section, Queue())
self.annotation_bear_result_type = namedtuple('result', ['contents'])
self.dep_results = {'AnnotationBear': HiddenResult(
'AnnotationBear', {'comments': ()})}
def test_empty_keyword(self):
text = ['a == b']
with execute_bear(self.uut, 'F', text,
dependency_results=self.dep_results) as result:
self.assertEqual(result, [])
def test_keyword_in_comment(self):
dep_results = {
'AnnotationBear': {}
}
text = ['# todo 123']
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs, {})
self.assertEqual(result[0].affected_code[0].start.line, 1)
self.assertEqual(len(result), 1)
dep_results = {'AnnotationBear': HiddenResult(
'AnnotationBear', {'comments': 123})}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs, {})
self.assertEqual(result[0].affected_code[0].start.line, 1)
self.assertEqual(len(result), 1)
dep_results = {'AnnotationBear': HiddenResult(
'AnnotationBear', 123)}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs, {})
self.assertEqual(result[0].affected_code[0].start.line, 1)
self.assertEqual(len(result), 1)
def test_keyword_not_in_comment(self):
text = ['# comment 123\n', 'a = "TODO"\n']
comments = [SourceRange.from_values('F', 1, 1, 1, 40)]
dep_results = {
'AnnotationBear': [
self.annotation_bear_result_type({'comments': comments})
]
}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(len(result[0].diffs), 0)
def test_keyword_diff(self):
text = ['# todo 123\n']
comments = [SourceRange.from_values('F', 1, 1, 1, 10)]
dep_results = {
'AnnotationBear': [
self.annotation_bear_result_type({'comments': comments})
]
}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs['F'].unified_diff,
'--- \n'
'+++ \n'
'@@ -1 +0,0 @@\n'
'-# todo 123\n')
text = ['test = 55 # todo 123\n']
comments = [SourceRange.from_values('F', 1, 11, 1, 23)]
dep_results = {
'AnnotationBear': [
self.annotation_bear_result_type({'comments': comments})
]
}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs['F'].unified_diff,
'--- \n'
'+++ \n'
'@@ -1 +1 @@\n'
'-test = 55 # todo 123\n'
'+test = 55\n')
def test_keyword_outside_of_comment(self):
text = ['todo = 123\n']
with execute_bear(self.uut, 'F', text,
dependency_results=self.dep_results) as result:
self.assertEquals(result[0].diffs, {})
def test_keyword_between_code(self):
self.section.append(Setting('language', 'c'))
self.section.append(Setting('keywords', 'todo'))
text = ['int a=0; /* TODO: Test */ int b=1;\n']
comments = [SourceRange.from_values('F', 1, 10, 1, 25)]
dep_results = {
'AnnotationBear': [
self.annotation_bear_result_type({'comments': comments})
]
}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs['F'].unified_diff,
'--- \n'
'+++ \n'
'@@ -1 +1 @@\n'
'-int a=0; /* TODO: Test */ int b=1;\n'
'+int a=0; int b=1;\n')
text = ['int a = 0; /* TODO test\n',
'another test\n',
'*/\n']
comments = [SourceRange.from_values('F', 1, 12, 3, 2)]
dep_results = {
'AnnotationBear': [
self.annotation_bear_result_type({'comments': comments})
]
}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs['F'].unified_diff,
'--- \n'
'+++ \n'
'@@ -1,3 +1,3 @@\n'
'-int a = 0; /* TODO test\n'
'+int a = 0; /*\n'
' another test\n'
' */\n')
text = ['/* TODO\n',
'test\n',
'*/\n']
comments = [SourceRange.from_values('F', 1, 1, 3, 2)]
dep_results = {
'AnnotationBear': [
self.annotation_bear_result_type({'comments': comments})
]
}
with execute_bear(self.uut, 'F', text,
dependency_results=dep_results) as result:
self.assertEqual(result[0].diffs['F'].unified_diff,
'--- \n'
'+++ \n'
'@@ -1,3 +1,3 @@\n'
'-/* TODO\n'
'+/*\n'
' test\n'
' */\n')
def test_keyword_regex(self):
text = ['# add two given values and result the result\n',
'def add(a, b):',
' return a+b\n',
' \n',
'print(add(2, 3))\n']
regex_keyword = 'r.s.l.'
with execute_bear(self.uut, filename='F', file=text,
regex_keyword=regex_keyword,
dependency_results=self.dep_results) as result:
self.assertEqual(result[0].message, 'The line contains the keyword'
" 'result' which resulted in a"
' match with given regex.')
text = ['# bla bla bla',
'Issue #123',
'bla bla bla']
regex_keyword = '[iI]ssue #[1-9][0-9]*'
with execute_bear(self.uut, filename='F', file=text,
regex_keyword=regex_keyword,
dependency_results=self.dep_results) as result:
self.assertEqual(result[0].message, 'The line contains the keyword'
" 'Issue #123' which resulted "
'in a match with given regex.')
def test_wrong_language(self):
self.section.append(Setting('language', 'anything'))
logger = logging.getLogger()
annotation_bear_result_type = namedtuple('result', 'contents')
dep_results = {
'AnnotationBear': [
annotation_bear_result_type(
'coalang specification for anything not found.')
]
}
text = ['# todo 123']
with self.assertLogs(logger, 'ERROR') as log:
with execute_bear(self.uut, filename='F', file=text,
dependency_results=dep_results) as result:
self.assertEqual(len(result), 1)
self.assertEqual(result[0].diffs, {})
self.assertEqual(result[0].affected_code[0].start.line, 1)
self.assertEqual(len(log.output), 1)
self.assertIn(log.output[0],
'ERROR:root:coalang specification'
' for anything not found.')