Skip to content

Commit

Permalink
Fixed bool params not working in ini file
Browse files Browse the repository at this point in the history
  • Loading branch information
@Babarberousse
Babarberousse committed Oct 20, 2019
1 parent acd6b40 commit b2f927d
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 110 deletions.
221 changes: 112 additions & 109 deletions bandit/cli/main.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,108 @@ def _log_info(args, profile):
LOG.info("cli exclude tests: %s", args.skips)


def _handle_bool_in_ini(ini_options, args):
"""Sets args values from cli, ini file or default value
To enable setting bool options in the ini file, their default values
can only be set after comparing cli and ini options
:param ini_options:
:param args:
:return:
"""
bool_options = {
'recursive': True,
'verbose': False,
'debug': False,
'quiet': False,
'ignore-nosec': False,
'exit-zero': False
}
for option, default_value in bool_options.items():
ini_value = ini_options.get(option)
cli_value = getattr(args, option.replace('-', '_'))
_log_option_source(cli_value, ini_value, option)

if ini_value is not None and cli_value is None:
setattr(args, option.replace('-', '_'), ini_value)
elif ini_value is None and cli_value is None:
setattr(args, option.replace('-', '_'), default_value)


def _handle_ini_options(ini_options, args):
# prefer command line, then ini file
args.excluded_paths = _log_option_source(
args.excluded_paths,
ini_options.get('exclude'),
'excluded paths')

args.skips = _log_option_source(
args.skips,
ini_options.get('skips'),
'skipped tests')

args.tests = _log_option_source(
args.tests,
ini_options.get('tests'),
'selected tests')

ini_targets = ini_options.get('targets')
if ini_targets:
ini_targets = ini_targets.split(',')

args.targets = _log_option_source(
args.targets,
ini_targets,
'selected targets')

args.agg_type = _log_option_source(
args.agg_type,
ini_options.get('aggregate'),
'aggregate output type')

args.context_lines = _log_option_source(
args.context_lines,
ini_options.get('number'),
'max code lines output for issue')

args.profile = _log_option_source(
args.profile,
ini_options.get('profile'),
'profile')

args.severity = _log_option_source(
args.severity,
ini_options.get('level'),
'severity level')

args.confidence = _log_option_source(
args.confidence,
ini_options.get('confidence'),
'confidence level')

args.output_format = _log_option_source(
args.output_format,
ini_options.get('format'),
'output format')

args.msg_template = _log_option_source(
args.msg_template,
ini_options.get('msg-template'),
'output message template')

args.output_file = _log_option_source(
args.output_file,
ini_options.get('output'),
'output file')

args.baseline = _log_option_source(
args.baseline,
ini_options.get('baseline'),
'path of a baseline report')
_handle_bool_in_ini(ini_options, args)


def main():
# bring our logging stuff up as early as possible
debug = (logging.DEBUG if '-d' in sys.argv or '--debug' in sys.argv else
Expand All @@ -169,7 +271,7 @@ def main():
)
parser.add_argument(
'-r', '--recursive', dest='recursive',
action='store_const', const=True,
action='store_true', default=None,
help='find and process files in subdirectories'
)
parser.add_argument(
Expand Down Expand Up @@ -234,20 +336,20 @@ def main():
)
group = parser.add_mutually_exclusive_group(required=False)
group.add_argument(
'-v', '--verbose', dest='verbose', action='store_true',
'-v', '--verbose', dest='verbose', action='store_true', default=None,
help='output extra information like excluded and included files'
)
parser.add_argument(
'-d', '--debug', dest='debug', action='store_true',
'-d', '--debug', dest='debug', action='store_true', default=None,
help='turn on debug mode'
)
group.add_argument(
'-q', '--quiet', '--silent', dest='quiet', action='store_true',
help='only show output in the case of an error'
default=None, help='only show output in the case of an error'
)
parser.add_argument(
'--ignore-nosec', dest='ignore_nosec', action='store_true',
help='do not skip lines with # nosec comments'
default=None, help='do not skip lines with # nosec comments'
)
parser.add_argument(
'-x', '--exclude', dest='excluded_paths', action='store',
Expand All @@ -265,21 +367,17 @@ def main():
'--ini', dest='ini_path', action='store', default=None,
help='path to an ini file that supplies command line arguments'
)
parser.add_argument('--exit-zero', action='store_true', dest='exit_zero',
default=False, help='exit with 0, '
'even with results found')
parser.add_argument(
'--exit-zero', action='store_true', dest='exit_zero',
default=None, help='exit with 0, even with results found'
)
python_ver = sys.version.replace('\n', '')
parser.add_argument(
'--version', action='version',
version='%(prog)s {version}\n python version = {python}'.format(
version=bandit.__version__, python=python_ver)
)

parser.set_defaults(debug=False)
parser.set_defaults(verbose=False)
parser.set_defaults(quiet=False)
parser.set_defaults(ignore_nosec=False)

plugin_info = ["%s\t%s" % (a[0], a[1].name) for a in
extension_mgr.plugins_by_id.items()]
blacklist_info = []
Expand Down Expand Up @@ -333,102 +431,7 @@ def main():
# Handle .bandit files in projects to pass cmdline args from file
ini_options = _get_options_from_ini(args.ini_path, args.targets)
if ini_options:
# prefer command line, then ini file
args.excluded_paths = _log_option_source(
args.excluded_paths,
ini_options.get('exclude'),
'excluded paths')

args.skips = _log_option_source(
args.skips,
ini_options.get('skips'),
'skipped tests')

args.tests = _log_option_source(
args.tests,
ini_options.get('tests'),
'selected tests')

ini_targets = ini_options.get('targets')
if ini_targets:
ini_targets = ini_targets.split(',')

args.targets = _log_option_source(
args.targets,
ini_targets,
'selected targets')

# TODO(tmcpeak): any other useful options to pass from .bandit?

ini_recursive = ini_options.get('recursive')
if ini_recursive and args.recursive is None:
# In this case, the ini file provides the intended config
args.recursive = ini_recursive

args.agg_type = _log_option_source(
args.agg_type,
ini_options.get('aggregate'),
'aggregate output type')

args.context_lines = _log_option_source(
args.context_lines,
ini_options.get('number'),
'max code lines output for issue')

args.profile = _log_option_source(
args.profile,
ini_options.get('profile'),
'profile')

args.severity = _log_option_source(
args.severity,
ini_options.get('level'),
'severity level')

args.confidence = _log_option_source(
args.confidence,
ini_options.get('confidence'),
'confidence level')

args.output_format = _log_option_source(
args.output_format,
ini_options.get('format'),
'output format')

args.msg_template = _log_option_source(
args.msg_template,
ini_options.get('msg-template'),
'output message template')

args.output_file = _log_option_source(
args.output_file,
ini_options.get('output'),
'output file')

args.verbose = _log_option_source(
args.verbose,
ini_options.get('verbose'),
'output extra information')

args.debug = _log_option_source(
args.debug,
ini_options.get('debug'),
'debug mode')

args.quiet = _log_option_source(
args.quiet,
ini_options.get('quiet'),
'silent mode')

args.ignore_nosec = _log_option_source(
args.ignore_nosec,
ini_options.get('ignore-nosec'),
'do not skip lines with # nosec')

args.baseline = _log_option_source(
args.baseline,
ini_options.get('baseline'),
'path of a baseline report')
_handle_ini_options(ini_options, args)

# If no target has been set through args or ini file, then use a default
if not args.targets:
Expand Down
17 changes: 16 additions & 1 deletion bandit/core/utils.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,22 @@ def parse_ini_file(f_loc):
config = configparser.ConfigParser()
try:
config.read(f_loc)
return {k: v for k, v in config.items('bandit')}
bool_params = [
'recursive',
'verbose',
'debug',
'quiet',
'ignore-nosec',
'exit-zero'
]
options = {k: v for k, v in config['bandit'].items()}
for bool_param in bool_params:
if config['bandit'].getboolean(bool_param):
options.update(
{bool_param: config['bandit'].getboolean(bool_param)}
)

return options

except (configparser.Error, KeyError, TypeError):
LOG.debug("Config file %s not found or missing [bandit] "
Expand Down

0 comments on commit b2f927d

Please sign in to comment.