openstack
/
deb-python-bashate
Code Issues Proposed changes

Cleanup variable names TODO 

Take care of this TODO by renaming our non-constant
instance variables to something more descriptive.

Change-Id: I8ab9eb41180ef9c55c75bccb627413f2b717d217
This commit is contained in:
Matt Odden 2014-12-30 13:48:31 -06:00 committed by Mathew Odden
parent a14a7a313d
commit 77e8ad47de
2 changed files with 30 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
bashate/bashate.py
View File

@ -103,35 +103,34 @@ def check_hashbang(line, filename, report):
class BashateRun(object):
def __init__(self):
# TODO(mrodden): rename these to match convention
self.ERRORS = 0
self.ERRORS_LIST = None
self.IGNORE_LIST = None
self.WARNINGS = 0
self.WARNINGS_LIST = None
self.error_count = 0
self.error_list = None
self.ignore_list = None
self.warning_count = 0
self.warning_list = None
def register_ignores(self, ignores):
if ignores:
self.IGNORE_LIST = '^(' + '|'.join(ignores.split(',')) + ')'
self.ignore_list = '^(' + '|'.join(ignores.split(',')) + ')'
def register_warnings(self, warnings):
if warnings:
self.WARNINGS_LIST = '^(' + '|'.join(warnings.split(',')) + ')'
self.warning_list = '^(' + '|'.join(warnings.split(',')) + ')'
def register_errors(self, errors):
if errors:
self.ERRORS_LIST = '^(' + '|'.join(errors.split(',')) + ')'
self.error_list = '^(' + '|'.join(errors.split(',')) + ')'
def should_ignore(self, error):
return self.IGNORE_LIST and re.search(self.IGNORE_LIST, error)
return self.ignore_list and re.search(self.ignore_list, error)
def should_warn(self, error):
# if in the errors list, overrides warning level
if self.ERRORS_LIST and re.search(self.ERRORS_LIST, error):
if self.error_list and re.search(self.error_list, error):
return False
if messages.is_default_warning(error):
return True
return self.WARNINGS_LIST and re.search(self.WARNINGS_LIST, error)
return self.warning_list and re.search(self.warning_list, error)
def print_error(self, error, line,
filename=None, filelineno=None):
@ -145,9 +144,9 @@ class BashateRun(object):
if not filelineno:
filelineno = fileinput.filelineno()
if warn:
self.WARNINGS = self.WARNINGS + 1
self.warning_count = self.warning_count + 1
else:
self.ERRORS = self.ERRORS + 1
self.error_count = self.error_count + 1
self.log_error(error, line, filename, filelineno, warn)
@ -284,11 +283,11 @@ def main():
print("bashate: %s" % e)
return 1
if run.WARNINGS > 0:
print("%d bashate warning(s) found" % run.WARNINGS)
if run.warning_count > 0:
print("%d bashate warning(s) found" % run.warning_count)
if run.ERRORS > 0:
print("%d bashate error(s) found" % run.ERRORS)
if run.error_count > 0:
print("%d bashate error(s) found" % run.error_count)
return 1
return 0

26
bashate/tests/test_bashate.py
View File

@ -37,7 +37,7 @@ class TestBashate(base.TestCase):
@mock.patch('sys.argv')
def test_main_no_files(self, m_bashaterun, m_argv):
m_run_obj = mock.MagicMock()
m_run_obj.ERRORS = 0
m_run_obj.error_count = 0
m_bashaterun.return_value = m_run_obj
result = bashate.main()
@ -48,8 +48,8 @@ class TestBashate(base.TestCase):
@mock.patch('sys.argv')
def test_main_return_one_on_errors(self, m_bashaterun, m_argv):
m_run_obj = mock.MagicMock()
m_run_obj.WARNINGS = 1
m_run_obj.ERRORS = 1
m_run_obj.warning_count = 1
m_run_obj.error_count = 1
m_bashaterun.return_value = m_run_obj
result = bashate.main()
@ -60,7 +60,7 @@ class TestBashate(base.TestCase):
@mock.patch('sys.argv')
def test_main_return_one_on_ioerror(self, m_bashaterun, m_argv):
m_run_obj = mock.MagicMock()
m_run_obj.ERRORS = 0
m_run_obj.error_count = 0
m_run_obj.check_files = mock.Mock(side_effect=IOError)
m_bashaterun.return_value = m_run_obj
@ -73,14 +73,14 @@ class TestBashate(base.TestCase):
bashate.check_no_trailing_whitespace("if ", self.run)
bashate.check_if_then("if ", self.run)
self.assertEqual(0, self.run.ERRORS)
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.ERRORS)
self.assertEqual(0, self.run.error_count)
def test_multi_ignore_mixed(self):
self.run.register_ignores('E001|E002,E003|E011')
@ -88,13 +88,13 @@ class TestBashate(base.TestCase):
bashate.check_if_then("if ", self.run)
bashate.check_indents(" echo", self.run)
self.assertEqual(0, self.run.ERRORS)
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.ERRORS)
self.assertEqual(0, self.run.error_count)
@mock.patch('bashate.bashate.BashateRun.print_error')
def test_while_check_for_do(self, m_print_error):
@ -143,7 +143,7 @@ class TestBashateSamples(base.TestCase):
test_files = ['bashate/tests/samples/E010_good.sh']
self.run.check_files(test_files, False)
self.assertEqual(self.run.ERRORS, 0)
self.assertEqual(self.run.error_count, 0)
def test_sample_E010(self):
test_files = ['bashate/tests/samples/E010_bad.sh']
@ -156,7 +156,7 @@ class TestBashateSamples(base.TestCase):
test_files = ['bashate/tests/samples/E011_good.sh']
self.run.check_files(test_files, False)
self.assertEqual(self.run.ERRORS, 0)
self.assertEqual(self.run.error_count, 0)
def test_sample_E011(self):
test_files = ['bashate/tests/samples/E011_bad.sh']
@ -182,7 +182,7 @@ class TestBashateSamples(base.TestCase):
test_files = ['bashate/tests/samples/comments.sh']
self.run.check_files(test_files, False)
self.assertEqual(0, self.run.ERRORS)
self.assertEqual(0, self.run.error_count)
def test_sample_E005(self):
test_files = ['bashate/tests/samples/E005_bad']
@ -199,8 +199,8 @@ class TestBashateSamples(base.TestCase):
self.run.register_warnings('E011,E041')
self.run.check_files(test_files, False)
self.assertEqual(0, self.run.ERRORS)
self.assertEqual(4, self.run.WARNINGS)
self.assertEqual(0, self.run.error_count)
self.assertEqual(4, self.run.warning_count)
def test_pre_zero_dot_one_sample_file(self):
"""Test the sample file with all pre 0.1.0 release checks.