Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-26 22:50:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

Create a real GroupEntry when the group is unrecognized, simplifying logic

Browse source 
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
This commit is contained in:
Clinton Wolfe 2019-01-16 00:38:33 -05:00
parent b89681350e
commit 45c1a11ad6
1 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
lib/utils/deprecation/deprecator.rb
View file

@ -12,17 +12,25 @@ module Inspec
end end
def handle_deprecation(group_name, message, opts = {}) def handle_deprecation(group_name, message, opts = {})
group = groups[group_name.to_sym] # Will be nil if unrecognized group group = groups[group_name.to_sym] || create_group_entry_for_unknown_group(group_name)
annotate_stack_information(opts) annotate_stack_information(opts)
assembled_message = assemble_message(message, group, group_name, opts) assembled_message = assemble_message(message, group, opts)
action = (group ? group[:action] : :warn) || :warn action = group[:action] || :warn
action_method = ('handle_' + action.to_s + '_action').to_sym action_method = ('handle_' + action.to_s + '_action').to_sym
send(action_method, assembled_message, group) send(action_method, assembled_message, group)
end end
private private
def create_group_entry_for_unknown_group(group_name)
group = ConfigFile::GroupEntry.new
group.name = group_name
group.action = config.unknown_group_action
group.suffix = "Additionally, the deprecation message is in an unknown group '#{group_name}'."
group
end
def annotate_stack_information(opts) def annotate_stack_information(opts)
stack = caller_locations(1, 25) stack = caller_locations(1, 25)
@ -45,10 +53,9 @@ module Inspec
opts[:used_at_stack_frame] = used_at if used_at opts[:used_at_stack_frame] = used_at if used_at
end end
def assemble_message(message, group, group_name, opts) def assemble_message(message, group, opts)
prefix = group ? (group.prefix || '') : '' prefix = group.prefix || ''
suffix = group ? (group.suffix || '') : '' suffix = group.suffix || ''
suffix += "Additionally, the deprecation message is in an unknown group '#{group_name}'." unless group
prefix += ' ' unless prefix.empty? prefix += ' ' unless prefix.empty?
suffix = ' ' + suffix unless suffix.empty? suffix = ' ' + suffix unless suffix.empty?
@ -69,11 +76,11 @@ module Inspec
false false
end end
def handle_ignore_action(message, group) def handle_ignore_action(message, _group)
handle_log_action(message, :debug, group) handle_log_action(message, :debug)
end end
def handle_log_action(message, level, _group) def handle_log_action(message, level)
case level case level
when :debug when :debug
Inspec::Log.debug message Inspec::Log.debug message
@ -84,12 +91,12 @@ module Inspec
end end
end end
def handle_warn_action(message, group) def handle_warn_action(message, _group)
handle_log_action(message, :warn, group) handle_log_action(message, :warn)
end end
def handle_error_action(message, group) def handle_error_action(message, _group)
handle_log_action(message, :error, group) handle_log_action(message, :error)
end end
def handle_fail_control_action(message, group) def handle_fail_control_action(message, group)
@ -102,7 +109,7 @@ module Inspec
def handle_exit_action(message, group) def handle_exit_action(message, group)
handle_error_action(message, group) handle_error_action(message, group)
status = (group ? group[:exit_status] : :fatal_deprecation) || :fatal_deprecation status = group[:exit_status] || :fatal_deprecation
Inspec::UI.new.exit(status) Inspec::UI.new.exit(status)
end end
end end