1310d18275
The argparse module already has the capability to default to stdout at CLI parameter definition time. This patch utilizes this and avoids the opening of the output file by each formatter. Change-Id: Ib1e89492558fe1fc06966711b6014bd5b86b84c8
202 lines
7.8 KiB
Python
202 lines
7.8 KiB
Python
# Copyright (c) 2015 VMware, Inc.
|
|
# Copyright (c) 2015 Hewlett Packard Enterprise
|
|
#
|
|
# 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.
|
|
|
|
from collections import OrderedDict
|
|
import tempfile
|
|
|
|
import mock
|
|
import testtools
|
|
|
|
import bandit
|
|
from bandit.core import config
|
|
from bandit.core import issue
|
|
from bandit.core import manager
|
|
from bandit.formatters import text as b_text
|
|
|
|
|
|
class TextFormatterTests(testtools.TestCase):
|
|
|
|
def setUp(self):
|
|
super(TextFormatterTests, self).setUp()
|
|
|
|
@mock.patch('bandit.core.issue.Issue.get_code')
|
|
def test_output_issue(self, get_code):
|
|
issue = _get_issue_instance()
|
|
get_code.return_value = 'DDDDDDD'
|
|
indent_val = 'CCCCCCC'
|
|
|
|
def _template(_issue, _indent_val, _code):
|
|
return_val = ["{}>> Issue: [{}:{}] {}".
|
|
format(_indent_val, _issue.test_id, _issue.test,
|
|
_issue.text),
|
|
"{} Severity: {} Confidence: {}".
|
|
format(_indent_val, _issue.severity.capitalize(),
|
|
_issue.confidence.capitalize()),
|
|
"{} Location: {}:{}".
|
|
format(_indent_val, _issue.fname, _issue.lineno)]
|
|
if _code:
|
|
return_val.append("{}{}".format(_indent_val, _code))
|
|
return '\n'.join(return_val)
|
|
|
|
issue_text = b_text._output_issue_str(issue, indent_val)
|
|
expected_return = _template(issue, indent_val, 'DDDDDDD')
|
|
self.assertEqual(expected_return, issue_text)
|
|
|
|
issue_text = b_text._output_issue_str(issue, indent_val,
|
|
show_code=False)
|
|
expected_return = _template(issue, indent_val, '')
|
|
self.assertEqual(expected_return, issue_text)
|
|
|
|
issue.lineno = ''
|
|
issue_text = b_text._output_issue_str(issue, indent_val,
|
|
show_lineno=False)
|
|
expected_return = _template(issue, indent_val, 'DDDDDDD')
|
|
self.assertEqual(expected_return, issue_text)
|
|
|
|
@mock.patch('bandit.core.manager.BanditManager.get_issue_list')
|
|
def test_no_issues(self, get_issue_list):
|
|
conf = config.BanditConfig()
|
|
self.manager = manager.BanditManager(conf, 'file')
|
|
|
|
(tmp_fd, self.tmp_fname) = tempfile.mkstemp()
|
|
self.manager.out_file = self.tmp_fname
|
|
|
|
get_issue_list.return_value = OrderedDict()
|
|
tmp_file = open(self.tmp_fname, 'w')
|
|
b_text.report(self.manager, tmp_file, bandit.LOW, bandit.LOW, lines=5)
|
|
|
|
with open(self.tmp_fname) as f:
|
|
data = f.read()
|
|
self.assertIn('No issues identified.', data)
|
|
|
|
@mock.patch('bandit.core.manager.BanditManager.get_issue_list')
|
|
def test_report_nobaseline(self, get_issue_list):
|
|
conf = config.BanditConfig()
|
|
self.manager = manager.BanditManager(conf, 'file')
|
|
|
|
(tmp_fd, self.tmp_fname) = tempfile.mkstemp()
|
|
self.manager.out_file = self.tmp_fname
|
|
|
|
self.manager.verbose = True
|
|
self.manager.files_list = ['binding.py']
|
|
|
|
self.manager.scores = [{'SEVERITY': [0, 0, 0, 1],
|
|
'CONFIDENCE': [0, 0, 0, 1]}]
|
|
|
|
self.manager.skipped = [('abc.py', 'File is bad')]
|
|
self.manager.excluded_files = ['def.py']
|
|
|
|
issue_a = _get_issue_instance()
|
|
issue_b = _get_issue_instance()
|
|
|
|
get_issue_list.return_value = [issue_a, issue_b]
|
|
|
|
self.manager.metrics.data['_totals'] = {'loc': 1000, 'nosec': 50}
|
|
for category in ['SEVERITY', 'CONFIDENCE']:
|
|
for level in ['UNDEFINED', 'LOW', 'MEDIUM', 'HIGH']:
|
|
self.manager.metrics.data['_totals']['%s.%s' %
|
|
(category, level)] = 1
|
|
|
|
# Validate that we're outputting the correct issues
|
|
output_str_fn = 'bandit.formatters.text._output_issue_str'
|
|
with mock.patch(output_str_fn) as output_str:
|
|
output_str.return_value = 'ISSUE_OUTPUT_TEXT'
|
|
|
|
tmp_file = open(self.tmp_fname, 'w')
|
|
b_text.report(self.manager, tmp_file, bandit.LOW, bandit.LOW,
|
|
lines=5)
|
|
|
|
calls = [mock.call(issue_a, '', lines=5),
|
|
mock.call(issue_b, '', lines=5)]
|
|
|
|
output_str.assert_has_calls(calls, any_order=True)
|
|
|
|
# Validate that we're outputting all of the expected fields and the
|
|
# correct values
|
|
tmp_file = open(self.tmp_fname, 'w')
|
|
b_text.report(self.manager, tmp_file, bandit.LOW, bandit.LOW,
|
|
lines=5)
|
|
with open(self.tmp_fname) as f:
|
|
data = f.read()
|
|
|
|
expected_items = ['Run started',
|
|
'Files in scope (1)',
|
|
'binding.py (score: ',
|
|
"CONFIDENCE: 1",
|
|
"SEVERITY: 1",
|
|
'Files excluded (1):',
|
|
'def.py',
|
|
'Undefined: 1',
|
|
'Low: 1',
|
|
'Medium: 1',
|
|
'High: 1',
|
|
'Total lines skipped ',
|
|
'(#nosec): 50',
|
|
'Total issues (by severity)',
|
|
'Total issues (by confidence)',
|
|
'Files skipped (1)',
|
|
'abc.py (File is bad)'
|
|
]
|
|
for item in expected_items:
|
|
self.assertIn(item, data)
|
|
|
|
@mock.patch('bandit.core.manager.BanditManager.get_issue_list')
|
|
def test_report_baseline(self, get_issue_list):
|
|
conf = config.BanditConfig()
|
|
self.manager = manager.BanditManager(conf, 'file')
|
|
|
|
(tmp_fd, self.tmp_fname) = tempfile.mkstemp()
|
|
self.manager.out_file = self.tmp_fname
|
|
|
|
issue_a = _get_issue_instance()
|
|
issue_b = _get_issue_instance()
|
|
|
|
issue_x = _get_issue_instance()
|
|
issue_x.fname = 'x'
|
|
issue_y = _get_issue_instance()
|
|
issue_y.fname = 'y'
|
|
issue_z = _get_issue_instance()
|
|
issue_z.fname = 'z'
|
|
|
|
get_issue_list.return_value = OrderedDict([(issue_a, [issue_x]),
|
|
(issue_b, [issue_y,
|
|
issue_z])])
|
|
|
|
# Validate that we're outputting the correct issues
|
|
indent_val = ' ' * 10
|
|
output_str_fn = 'bandit.formatters.text._output_issue_str'
|
|
with mock.patch(output_str_fn) as output_str:
|
|
output_str.return_value = 'ISSUE_OUTPUT_TEXT'
|
|
|
|
tmp_file = open(self.tmp_fname, 'w')
|
|
b_text.report(self.manager, tmp_file, bandit.LOW, bandit.LOW,
|
|
lines=5)
|
|
|
|
calls = [mock.call(issue_a, '', lines=5),
|
|
mock.call(issue_b, '', show_code=False,
|
|
show_lineno=False),
|
|
mock.call(issue_y, indent_val, lines=5),
|
|
mock.call(issue_z, indent_val, lines=5)]
|
|
|
|
output_str.assert_has_calls(calls, any_order=True)
|
|
|
|
|
|
def _get_issue_instance(severity=bandit.MEDIUM, confidence=bandit.MEDIUM):
|
|
new_issue = issue.Issue(severity, confidence, 'Test issue')
|
|
new_issue.fname = 'code.py'
|
|
new_issue.test = 'bandit_plugin'
|
|
new_issue.lineno = 1
|
|
return new_issue
|