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
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
test_bashate
----------------------------------
Tests for `bashate` module.
"""
from unittest import mock
from bashate import bashate
from bashate import messages
from bashate.tests import base
MESSAGES = messages.MESSAGES
class TestBashate(base.TestCase):
def setUp(self):
super(TestBashate, self).setUp()
self.run = bashate.BashateRun()
@mock.patch('bashate.bashate.BashateRun')
def test_main_no_files(self, m_bashaterun):
m_run_obj = mock.MagicMock()
m_run_obj.error_count = 0
m_run_obj.warning_count = 0
m_bashaterun.return_value = m_run_obj
result = bashate.main([])
expected_return = 1
self.assertEqual(expected_return, result)
@mock.patch('bashate.bashate.BashateRun')
def test_main_return_one_on_errors(self, m_bashaterun):
m_run_obj = mock.MagicMock()
m_run_obj.warning_count = 1
m_run_obj.error_count = 1
m_bashaterun.return_value = m_run_obj
result = bashate.main([])
expected_return = 1
self.assertEqual(expected_return, result)
@mock.patch('bashate.bashate.BashateRun')
def test_main_return_one_on_ioerror(self, m_bashaterun):
m_run_obj = mock.MagicMock()
m_run_obj.error_count = 0
m_run_obj.check_files = mock.Mock(side_effect=IOError)
m_bashaterun.return_value = m_run_obj
result = bashate.main(['--verbose',
'/path/to/fileA', '/path/to/fileB'])
m_run_obj.check_files.assert_called_with(
['/path/to/fileA', '/path/to/fileB'],
True,
79
)
expected_return = 1
self.assertEqual(expected_return, result)
def test_multi_ignore_with_slash(self):
self.run.register_ignores('E001|E011')
bashate.check_no_trailing_whitespace("if ", self.run)
bashate.check_if_then("if ", self.run)
self.assertEqual(0, self.run.error_count)
def test_multi_ignore_with_comma(self):
self.run.register_ignores('E001,E011')
bashate.check_no_trailing_whitespace("if ", self.run)
bashate.check_if_then("if ", self.run)
self.assertEqual(0, self.run.error_count)
def test_multi_ignore_mixed(self):
self.run.register_ignores('E001|E002,E003|E011')
bashate.check_no_trailing_whitespace("if ", self.run)
bashate.check_if_then("if ", self.run)
bashate.check_indents(" echo", self.run)
self.assertEqual(0, self.run.error_count)
def test_ignore(self):
self.run.register_ignores('E001')
bashate.check_no_trailing_whitespace("if ", self.run)
self.assertEqual(0, self.run.error_count)
@mock.patch('bashate.bashate.BashateRun.print_error')
def test_while_check_for_do(self, m_print_error):
test_line = 'while `do something args`'
bashate.check_for_do(test_line, self.run)
m_print_error.assert_called_once_with(
MESSAGES['E010'].msg % 'while', test_line)
class TestBashateSamples(base.TestCase):
"""End to end regression testing of bashate against script samples."""
def setUp(self):
super(TestBashateSamples, self).setUp()
log_error_patcher = mock.patch(
'bashate.bashate.BashateRun.log_error')
self.m_log_error = log_error_patcher.start()
self.run = bashate.BashateRun()
self.addCleanup(log_error_patcher.stop)
def assert_error_found(self, error, lineno):
error_found = False
for call in self.m_log_error.call_args_list:
# unwrap args
args = call[0]
if (args[0].startswith(error) and lineno == args[3]):
error_found = True
if not error_found:
self.fail('Error %s expected at line %d not found!' %
(error, lineno))
def test_sample_E001(self):
test_files = ['bashate/tests/samples/E001_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E001', 4)
def test_sample_E002(self):
test_files = ['bashate/tests/samples/E002_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E002', 3)
def test_sample_E003(self):
test_files = ['bashate/tests/samples/E003_good.sh']
self.run.check_files(test_files, False)
self.assertEqual(0, self.run.error_count)
def test_sample_E003_bad(self):
test_files = ['bashate/tests/samples/E003_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E003', 4)
self.assert_error_found('E003', 7)
self.assert_error_found('E003', 11)
def test_sample_E004_bad(self):
test_files = ['bashate/tests/samples/E004_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E004', 3)
def test_sample_E006_bad(self):
test_files = ['bashate/tests/samples/E006_bad.sh']
self.run.check_files(test_files, False)
self.assertEqual(self.run.warning_count, 3)
self.assert_error_found('E006', 5)
self.assert_error_found('E006', 6)
self.assert_error_found('E006', 8)
def test_sample_E006_bad_ignore_trailing_ws(self):
self.run.register_ignores('E001')
test_files = ['bashate/tests/samples/E006_bad.sh']
self.run.check_files(test_files, False)
self.assertEqual(self.run.warning_count, 3)
self.assert_error_found('E006', 5)
self.assert_error_found('E006', 6)
self.assert_error_found('E006', 8)
def test_sample_E006_bad_custom_max_line_length(self):
test_files = ['bashate/tests/samples/E006_bad_custom_length.sh']
self.run.check_files(test_files, False, 10)
self.assertEqual(self.run.warning_count, 2)
self.assert_error_found('E006', 5)
self.assert_error_found('E006', 6)
def test_sample_E006_good(self):
test_files = ['bashate/tests/samples/E006_good.sh']
self.run.check_files(test_files, False)
self.assertEqual(self.run.warning_count, 0)
def test_sample_E010_good(self):
test_files = ['bashate/tests/samples/E010_good.sh']
self.run.check_files(test_files, False)
self.assertEqual(self.run.error_count, 0)
def test_sample_E010(self):
test_files = ['bashate/tests/samples/E010_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E010', 3)
self.assert_error_found('E010', 9)
def test_sample_E011_good(self):
test_files = ['bashate/tests/samples/E011_good.sh']
self.run.check_files(test_files, False)
self.assertEqual(self.run.error_count, 0)
def test_sample_E011(self):
test_files = ['bashate/tests/samples/E011_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E011', 3)
self.assert_error_found('E011', 6)
def test_sample_E012(self):
test_files = ['bashate/tests/samples/E012_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E012', 9)
self.assert_error_found('E040', 10)
def test_sample_E041(self):
test_files = ['bashate/tests/samples/E041_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E041', 4)
def test_sample_E042(self):
test_files = ['bashate/tests/samples/E042_bad.sh']
self.run.register_errors('E042')
self.run.check_files(test_files, False)
self.assert_error_found('E042', 2)
self.assert_error_found('E042', 6)
self.assert_error_found('E042', 10)
self.assert_error_found('E042', 11)
def test_sample_E043(self):
test_files = ['bashate/tests/samples/E043_bad.sh']
self.run.register_errors('E043')
self.run.check_files(test_files, False)
self.assert_error_found('E043', 6)
def test_sample_for_loops(self):
test_files = ['bashate/tests/samples/for_loops.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E010', 14)
self.assert_error_found('E010', 20)
def test_sample_comments(self):
test_files = ['bashate/tests/samples/comments.sh']
self.run.check_files(test_files, False)
self.assertEqual(0, self.run.error_count)
def test_sample_E005(self):
test_files = ['bashate/tests/samples/E005_bad']
self.run.register_errors('E005')
self.run.check_files(test_files, False)
self.assert_error_found('E005', 1)
def test_sample_E005_excluded(self):
test_files = ['bashate/tests/samples/.E005_excluded']
self.run.check_files(test_files, False)
self.assertEqual(0, self.run.error_count)
def test_sample_E040(self):
test_files = ['bashate/tests/samples/E040_syntax_error.sh']
self.run.register_errors('E040')
self.run.check_files(test_files, False)
self.assert_error_found('E040', 7)
def test_sample_E044(self):
test_files = ['bashate/tests/samples/E044_bad.sh']
self.run.check_files(test_files, False)
self.assert_error_found('E044', 3)
self.assert_error_found('E044', 7)
self.assert_error_found('E044', 17)
self.assert_error_found('E044', 21)
self.assert_error_found('E044', 31)
self.assert_error_found('E044', 35)
def test_sample_warning(self):
# reuse a couple of the above files to make sure we turn
# errors down to warnings if requested
test_files = ['bashate/tests/samples/E011_bad.sh',
'bashate/tests/samples/E041_bad.sh']
self.run.register_warnings('E011,E041')
self.run.check_files(test_files, False)
self.assertEqual(0, self.run.error_count)
self.assertEqual(4, self.run.warning_count)
def test_ignore_heredoc(self):
test_files = ['bashate/tests/samples/heredoc_ignore.sh']
self.run.check_files(test_files, False)
self.assertEqual(0, self.run.error_count)
def test_pre_zero_dot_one_sample_file(self):
"""Test the sample file with all pre 0.1.0 release checks.
This is a legacy compatibility check to make sure we still
catch the same errors as we did before the first 0.1.0
release of the bashate pypi package. There were no tests
before this, so it is our baseline regression check.
New checks shouldn't need to be added here, and should
have their own separate unit test and/or sample file checks.
"""
test_files = ['bashate/tests/samples/legacy_sample.sh']
self.run.check_files(test_files, False)
expected_errors = [
('E002', 4),
('E003', 6),
('E001', 10),
('E010', 13),
('E010', 18),
('E010', 23),
('E011', 29),
('E020', 3)
]
for error in expected_errors:
self.assert_error_found(*error)
|
