inspec 4.7.3 → 4.7.18

data/lib/inspec/plugin/v1/plugins.rb

@@ -32,9 +32,9 @@ module Inspec
       # traverse out of inspec-vX.Y.Z/lib/inspec/plugins.rb
       @home = home || File.join(Inspec.config_dir, "plugins")
       @paths += Dir[File.join(@home, "**{,/*/**}", "*.gemspec")]
-                .map { |x| File.dirname(x) }
-                .map { |x| Dir[File.join(x, "lib", "inspec-*.rb")] }
-                .flatten
+        .map { |x| File.dirname(x) }
+        .map { |x| Dir[File.join(x, "lib", "inspec-*.rb")] }
+        .flatten
 
       # load bundled plugins
       bundled_dir = File.expand_path(File.dirname(__FILE__))
@@ -51,6 +51,7 @@ module Inspec
       if path.nil?
         raise "Couldn't find plugin #{name}. Searching in #{@home}"
       end
+
       # puts "Loading plugin #{name} from #{path}"
       require path
     end

data/lib/inspec/plugin/v1/registry.rb

@@ -24,8 +24,8 @@ class PluginRegistry
   # @return [Array[Plugin]] sorted list of plugins
   def modules
     @registry.values
-             .sort_by { |x| x.respond_to?(:priority) ? x.priority : 0 }
-             .reverse
+      .sort_by { |x| x.respond_to?(:priority) ? x.priority : 0 }
+      .reverse
   end
 end
 
@@ -44,6 +44,7 @@ class PluginRegistry
     # @return [nil] disregard
     def self.name(name)
       raise "Trying to register #{self} with name == nil" if name.nil?
+
       @name = name
       plugin_registry.registry[name] = self
     end

data/lib/inspec/plugin/v2.rb

@@ -40,6 +40,7 @@ module Inspec
     end
 
     return Inspec::Plugin::V2::PluginBase if plugin_type.nil?
+
     Inspec::Plugin::V2::PluginBase.base_class_for_type(plugin_type)
   end
 end

data/lib/inspec/plugin/v2/activator.rb

@@ -15,12 +15,14 @@ module Inspec::Plugin::V2
 
     def activated?(new_value = nil)
       return self[:activated?] if new_value.nil?
+
       self[:activated?] = new_value
     end
 
     # Load a plugin, but if an error is encountered, store it and continue
     def activate
       return if activated?
+
       # rubocop: disable Lint/RescueException
       begin
         impl_class = self[:activation_proc].call

data/lib/inspec/plugin/v2/config_file.rb

@@ -57,6 +57,7 @@ module Inspec::Plugin::V2
       unless existing_entry?(name)
         raise Inspec::Plugin::V2::ConfigError, "No such entry with plugin name '#{name}'"
       end
+
       @data[:plugins].delete_if { |entry| entry[:name] == name.to_sym }
     end
 
@@ -114,6 +115,7 @@ module Inspec::Plugin::V2
           next if idx == other_idx
           next unless other_entry.is_a? Hash # We'll catch that invalid entry later
           next if plugin_entry[:name] != other_entry[:name]
+
           indices = [idx, other_idx].sort
           raise Inspec::Plugin::V2::ConfigError, "Malformed plugins.json file - duplicate plugin entry '#{plugin_entry[:name]}' detected at index #{indices[0]} and #{indices[1]}"
         end
@@ -134,9 +136,10 @@ module Inspec::Plugin::V2
 
       if plugin_entry.key? :installation_type
         seen_type = plugin_entry[:installation_type]
-        unless [:gem, :path].include? seen_type.to_sym
+        unless %i{gem path}.include? seen_type.to_sym
           raise Inspec::Plugin::V2::ConfigError, "'plugins' entry with unrecognized installation_type (must be one of 'gem' or 'path')"
         end
+
         plugin_entry[:installation_type] = seen_type.to_sym
 
         if plugin_entry[:installation_type] == :path && !plugin_entry.key?(:installation_path)

data/lib/inspec/plugin/v2/filter.rb

@@ -46,6 +46,7 @@ module Inspec::Plugin::V2
       unless @filter_data.key?("exclude") && @filter_data["exclude"].is_a?(Array)
         raise Inspec::Plugin::V2::ConfigError, 'Unknown plugin fillter file format: expected "exclude" to be an array'
       end
+
       @filter_data["exclude"].each_with_index do |entry, idx|
         unless entry.is_a? Hash
           raise Inspec::Plugin::V2::ConfigError, "Unknown plugin fillter file format: expected entry #{idx} to be a Hash / JS Object"

data/lib/inspec/plugin/v2/installer.rb

@@ -249,7 +249,7 @@ module Inspec::Plugin::V2
       end
 
       opts[:scope] ||= :released
-      unless [:prerelease, :released, :latest].include?(opts[:scope])
+      unless %i{prerelease released latest}.include?(opts[:scope])
         raise SearchError, "Search scope for listing versons must be :prerelease, :released, or :latest."
       end
     end
@@ -267,11 +267,11 @@ module Inspec::Plugin::V2
       plugin_local_source = Gem::Source::SpecificFile.new(opts[:gem_file])
 
       plugin_dependency = Gem::Dependency.new(requested_plugin_name,
-                                              plugin_local_source.spec.version)
+        plugin_local_source.spec.version)
 
       requested_local_gem_set = Gem::Resolver::InstallerSet.new(:both)
       requested_local_gem_set.add_local(plugin_dependency.name,
-                                        plugin_local_source.spec, plugin_local_source)
+        plugin_local_source.spec, plugin_local_source)
 
       install_gem_to_plugins_dir(plugin_dependency, [requested_local_gem_set])
     end
@@ -283,8 +283,8 @@ module Inspec::Plugin::V2
     end
 
     def install_gem_to_plugins_dir(new_plugin_dependency, # rubocop: disable Metrics/AbcSize
-                                   extra_request_sets = [],
-                                   update_mode = false)
+      extra_request_sets = [],
+      update_mode = false)
 
       # Get a list of all the gems available to us.
       gem_to_force_update = update_mode ? new_plugin_dependency.name : nil
@@ -305,6 +305,7 @@ module Inspec::Plugin::V2
       # Activate all current plugins before trying to activate the new one
       loader.list_managed_gems.each do |spec|
         next if spec.name == new_plugin_dependency.name && update_mode
+
         spec.activate
       end
 
@@ -378,7 +379,7 @@ module Inspec::Plugin::V2
       # Find out which gems we still actually need...
       names_of_gems_we_actually_need = \
         request_set_we_still_must_satisfy.resolve(build_gem_request_universe)
-                                         .map(&:full_spec).map(&:full_name)
+          .map(&:full_spec).map(&:full_name)
 
       # ... vs what we currently have, which should have some cruft
       cruft_gem_specs = loader.list_managed_gems.reject do |spec|
@@ -423,7 +424,7 @@ module Inspec::Plugin::V2
 
         # find all gem specification directories
         directories = [Gem::Specification.default_specifications_dir]
-        if !defined?(::Bundler)
+        unless defined?(::Bundler)
           # add in any others that do not start with the user directory
           directories += Gem::Specification.dirs.find_all do |path|
             !path.start_with?(Gem.user_dir)
@@ -456,6 +457,7 @@ module Inspec::Plugin::V2
       installed_plugins_gem_set = Gem::Resolver::VendorSet.new
       loader.list_managed_gems.each do |spec|
         next if spec.name == gem_to_force_update
+
         installed_plugins_gem_set.add_vendor_gem(spec.name, spec.gem_dir)
       end
 

data/lib/inspec/plugin/v2/loader.rb

@@ -168,6 +168,7 @@ module Inspec::Plugin::V2
       end
       solution.each do |activation_request|
         next if activation_request.full_spec.activated?
+
         activation_request.full_spec.activate
         # TODO: If we are under Bundler, inform it that we loaded a gem
       end
@@ -177,6 +178,7 @@ module Inspec::Plugin::V2
       status = registry[plugin_name]
       return if status.api_generation == 2 # Gen2 have self-annotating superclasses
       return if status.api_generation == :'train-1' # Train plugins are here as a courtesy, don't poke them
+
       case status.installation_type
       when :bundle
         annotate_bundle_plugin_status_after_load(plugin_name)

data/lib/inspec/plugin/v2/plugin_base.rb

@@ -82,6 +82,7 @@ module Inspec::Plugin::V2
         # If called from a Plugin definition class...
         stat = reg.find_status_by_class(self)
         return stat.name if stat
+
         # Called from an implementation class
         return find_name_by_implementation_class(self)
       end

data/lib/inspec/plugin/v2/plugin_types/cli.rb

@@ -32,8 +32,8 @@ module Inspec::Plugin::V2::PluginType
     def self.register_with_thor
       # Figure out my activator name (= subcommand group name)
       subcommand_name = Inspec::Plugin::V2::Registry.instance \
-                                                    .find_activators(plugin_type: :cli_command, implementation_class: self) \
-                                                    .first.activator_name.to_s
+        .find_activators(plugin_type: :cli_command, implementation_class: self) \
+        .first.activator_name.to_s
 
       # Register with Thor
       Inspec::InspecCLI.register(self, subcommand_name, @usage_msg, @desc_msg, {})

data/lib/inspec/plugin/v2/registry.rb

@@ -30,6 +30,7 @@ module Inspec::Plugin::V2
       # HACK: Status is normally the source of truth for loadedness, unless it is a train plugin; then the Train::Registry is the source of truth.
       # Also, InSpec registry is keyed on Symbols; Train is keyed on Strings.
       return registry.dig(name.to_sym, :loaded) unless name.to_s.start_with?("train-")
+
       Train::Plugins.registry.key?(name.to_s.sub(/^train-/, ""))
     end
 
@@ -61,7 +62,7 @@ module Inspec::Plugin::V2
     # @returns [Array] Possibly empty array of Activators
     def find_activators(filters = {})
       plugin_statuses.map(&:activators).flatten.select do |act|
-        [:plugin_name, :plugin_type, :activator_name, :implementation_class].all? do |criteria|
+        %i{plugin_name plugin_type activator_name implementation_class}.all? do |criteria|
           !filters.key?(criteria) || act[criteria] == filters[criteria]
         end
       end
@@ -75,6 +76,7 @@ module Inspec::Plugin::V2
       elsif matched_plugins.empty?
         raise Inspec::Plugin::V2::LoadError, "Plugin hooks search returned zero results for filter #{filters.inspect}"
       end
+
       matched_plugins.first
     end
 

data/lib/inspec/profile.rb

@@ -34,6 +34,7 @@ module Inspec
       keys = content.keys
       keys.each do |key|
         next if content[key].nil?
+
         # remove prefix
         rel = Pathname.new(key).relative_path_from(Pathname.new("vendor")).to_s
         tar = Pathname.new(opts[:vendor_cache].path).join(rel)
@@ -187,10 +188,12 @@ module Inspec
     def collect_tests(include_list = @controls)
       unless @tests_collected
         return unless supports_platform?
+
         locked_dependencies.each(&:collect_tests)
 
         tests.each do |path, content|
           next if content.nil? || content.empty?
+
           abs_path = source_reader.target.abs_path(path)
           @runner_context.load_control_file(content, abs_path, nil)
         end
@@ -207,6 +210,7 @@ module Inspec
         next if inclusion.is_a?(Regexp)
         # Insist the user wrap the regex in slashes to demarcate it as a regex
         next unless inclusion.start_with?("/") && inclusion.end_with?("/")
+
         inclusion = inclusion[1..-2] # Trim slashes
         begin
           re = Regexp.new(inclusion)
@@ -271,6 +275,7 @@ module Inspec
       # add information about the controls
       res[:controls] = res[:controls].map do |id, rule|
         next if id.to_s.empty?
+
         data = rule.dup
         data.delete(:checks)
         data[:impact] ||= 0.5
@@ -284,7 +289,7 @@ module Inspec
             profile = dep.profile
             code = Inspec::MethodSource.code_at(data[:source_location], profile.source_reader)
             data[:code] = code unless code.nil? || code.empty?
-            break if !data[:code].empty?
+            break unless data[:code].empty?
           end
         end
         data
@@ -377,8 +382,8 @@ module Inspec
       # only run the vendor check if the legacy profile-path is not used as argument
       if @legacy_profile_path == false
         # verify that a lockfile is present if we have dependencies
-        if !metadata.dependencies.empty?
-          error.call(meta_path, 0, 0, nil, "Your profile needs to be vendored with `inspec vendor`.") if !lockfile_exists?
+        unless metadata.dependencies.empty?
+          error.call(meta_path, 0, 0, nil, "Your profile needs to be vendored with `inspec vendor`.") unless lockfile_exists?
         end
 
         if lockfile_exists?
@@ -393,7 +398,7 @@ module Inspec
             next if dep[:name].nil?
 
             # TODO: should we also verify that the soure is the same?
-            if !lockfile.deps.map { |x| x[:name] }.include? dep[:name]
+            unless lockfile.deps.map { |x| x[:name] }.include? dep[:name]
               error.call(meta_path, 0, 0, nil, "Cannot find #{dep[:name]} in lockfile. Please re-vendor with `inspec vendor`.")
             end
           end
@@ -417,6 +422,7 @@ module Inspec
         sline = control[:source_location][:line]
         error.call(sfile, sline, nil, id, "Avoid controls with empty IDs") if id.nil? || id.empty?
         next if id.start_with? "(generated "
+
         warn.call(sfile, sline, nil, id, "Control #{id} has no title") if control[:title].to_s.empty?
         warn.call(sfile, sline, nil, id, "Control #{id} has no descriptions") if control[:descriptions][:default].to_s.empty?
         warn.call(sfile, sline, nil, id, "Control #{id} has impact > 1.0") if control[:impact].to_f > 1.0
@@ -547,7 +553,7 @@ module Inspec
         [["inspec.lock.deps", YAML.dump(deps)]]
 
       files.sort_by { |a| a[0] }
-           .map { |f| res << f[0] << "\0" << f[1] << "\0" }
+        .map { |f| res << f[0] << "\0" << f[1] << "\0" }
 
       res.digest.unpack("H*")[0]
     end
@@ -591,6 +597,7 @@ module Inspec
       prefix = @source_reader.target.prefix || ""
       tests&.each do |rule|
         next if rule.nil?
+
         f = load_rule_filepath(prefix, rule)
         load_rule(rule, f, controls, groups)
       end
@@ -623,7 +630,7 @@ module Inspec
       if controls[id][:code].empty? && Inspec::Rule.merge_count(rule) > 0
         Inspec::Rule.merge_changes(rule).each do |merge_location|
           code = Inspec::MethodSource.code_at(merge_location, source_reader)
-          if !code.empty?
+          unless code.empty?
             controls[id][:code] = code
             break
           end

data/lib/inspec/profile_context.rb

@@ -94,7 +94,7 @@ module Inspec
 
     def subcontext_by_name(name)
       found = @lib_subcontexts.find { |c| c.profile_id == name }
-      if !found
+      unless found
         @lib_subcontexts.each do |c|
           found = c.subcontext_by_name(name)
           break if found
@@ -133,6 +133,7 @@ module Inspec
       # load all files directly that are flat inside the libraries folder
       autoloads.each do |path|
         next unless path.end_with?(".rb")
+
         load_library_file(*@require_loader.load(path)) unless @require_loader.loaded?(path)
       end
       reload_dsl
@@ -150,7 +151,7 @@ module Inspec
     end
 
     def load_with_context(context, content, source = nil, line = nil)
-      Inspec::Log.debug("Loading #{source || '<anonymous content>'} into #{self}")
+      Inspec::Log.debug("Loading #{source || "<anonymous content>"} into #{self}")
       @current_load = { file: source }
       if content.is_a? Proc
         context.instance_eval(&content)
@@ -195,6 +196,7 @@ module Inspec
 
     def full_id(pid, rid)
       return rid.to_s if pid.to_s.empty?
+
       pid.to_s + "/" + rid.to_s
     end
   end

data/lib/inspec/reporters/cli.rb

@@ -54,8 +54,8 @@ module Inspec::Reporters
         print_anonymous_control_results(profile)
         if @control_count == 0
           output(format_message(
-                   indentation: 5,
-                   message: "No tests executed."
+            indentation: 5,
+            message: "No tests executed."
           ))
         end
       end
@@ -86,6 +86,7 @@ module Inspec::Reporters
       standard_controls_from_profile(profile).each do |control_from_profile|
         control = Control.new(control_from_profile)
         next if control.results.nil?
+
         output(format_control_header(control))
         control.results.each do |result|
           output(format_result(control, result, :standard))
@@ -99,6 +100,7 @@ module Inspec::Reporters
       anonymous_controls_from_profile(profile).each do |control_from_profile|
         control = Control.new(control_from_profile)
         next if control.results.nil?
+
         output(format_control_header(control))
         control.results.each do |result|
           output(format_result(control, result, :anonymous))
@@ -111,7 +113,7 @@ module Inspec::Reporters
       if profile[:title].nil?
         (profile[:name] || "unknown").to_s
       else
-        "#{profile[:title]} (#{profile[:name] || 'unknown'})"
+        "#{profile[:title]} (#{profile[:name] || "unknown"})"
       end
     end
 
@@ -163,7 +165,7 @@ module Inspec::Reporters
       return text if defined?(RSpec.configuration) && !RSpec.configuration.color
       return text unless COLORS.key?(color_name)
 
-      "#{COLORS[color_name]}#{text}#{COLORS['reset']}"
+      "#{COLORS[color_name]}#{text}#{COLORS["reset"]}"
     end
 
     def all_unique_controls
@@ -182,6 +184,7 @@ module Inspec::Reporters
       all_unique_controls.each do |control|
         next if control[:id].start_with? "(generated from "
         next unless control[:results]
+
         if control[:results].any? { |r| r[:status] == "failed" }
           failed += 1
         elsif control[:results].any? { |r| r[:status] == "skipped" }
@@ -209,6 +212,7 @@ module Inspec::Reporters
 
       all_unique_controls.each do |control|
         next unless control[:results]
+
         control[:results].each do |result|
           if result[:status] == "failed"
             failed += 1
@@ -232,9 +236,9 @@ module Inspec::Reporters
       summary = profile_summary
       return unless summary["total"] > 0
 
-      success_str = summary["passed"] == 1 ? "1 successful control" : "#{summary['passed']} successful controls"
-      failed_str  = summary["failed"] == 1 ? "1 control failure" : "#{summary['failed']} control failures"
-      skipped_str = summary["skipped"] == 1 ? "1 control skipped" : "#{summary['skipped']} controls skipped"
+      success_str = summary["passed"] == 1 ? "1 successful control" : "#{summary["passed"]} successful controls"
+      failed_str  = summary["failed"] == 1 ? "1 control failure" : "#{summary["failed"]} control failures"
+      skipped_str = summary["skipped"] == 1 ? "1 control skipped" : "#{summary["skipped"]} controls skipped"
 
       success_color = summary["passed"] > 0 ? "passed" : "no_color"
       failed_color = summary["failed"] > 0 ? "failed" : "no_color"
@@ -252,7 +256,7 @@ module Inspec::Reporters
     def print_tests_summary
       summary = tests_summary
 
-      failed_str = summary["failed"] == 1 ? "1 failure" : "#{summary['failed']} failures"
+      failed_str = summary["failed"] == 1 ? "1 failure" : "#{summary["failed"]} failures"
 
       success_color = summary["passed"] > 0 ? "passed" : "no_color"
       failed_color = summary["failed"] > 0 ? "failed" : "no_color"
@@ -260,9 +264,9 @@ module Inspec::Reporters
 
       s = format(
         "Test Summary: %s, %s, %s",
-        format_with_color(success_color, "#{summary['passed']} successful"),
+        format_with_color(success_color, "#{summary["passed"]} successful"),
         format_with_color(failed_color, failed_str),
-        format_with_color(skipped_color, "#{summary['skipped']} skipped")
+        format_with_color(skipped_color, "#{summary["skipped"]} skipped")
       )
 
       output(s)