inspec 4.7.3 → 4.7.18

data/lib/inspec/fetcher.rb

@@ -11,12 +11,13 @@ module Inspec
       end
     end
 
-    NON_FETCHER_KEYS = [:name, :version_constraint, :cwd, :backend, :cache, :sha256].freeze
+    NON_FETCHER_KEYS = %i{name version_constraint cwd backend cache sha256}.freeze
     def fetcher_specified?(target)
       # Only set a default for Hash-based (i.e. from
       # inspec.yml/inspec.lock) targets
 
-      return true if !target.respond_to?(:keys)
+      return true unless target.respond_to?(:keys)
+
       !(target.keys - NON_FETCHER_KEYS).empty?
     end
 
@@ -31,6 +32,7 @@ module Inspec
     if version != 1
       raise "Only fetcher version 1 is supported!"
     end
+
     Inspec::Plugins::Fetcher
   end
 end

data/lib/inspec/file_provider.rb

@@ -21,8 +21,7 @@ module Inspec
       end
     end
 
-    def initialize(_path)
-    end
+    def initialize(_path); end
 
     # List all files that are offered.
     #
@@ -80,12 +79,14 @@ module Inspec
     def read(file)
       return nil unless files.include?(file)
       return nil unless File.file?(file)
+
       File.read(file)
     end
 
     def binread(file)
       return nil unless files.include?(file)
       return nil unless File.file?(file)
+
       File.binread(file)
     end
   end
@@ -133,10 +134,12 @@ module Inspec
 
     def read_from_zip(file)
       return nil unless @files.include?(file)
+
       res = nil
       walk_zip(@path) do |io|
         while (entry = io.get_next_entry)
           next unless file == entry.name
+
           res = io.read
           break
         end
@@ -172,6 +175,7 @@ module Inspec
       walk_tar(@path) do |files|
         files.each do |file|
           next unless @files.include?(file.full_name)
+
           final_path = File.join(destination_path, file.full_name)
 
           # This removes the top level directory (and any other files) to ensure
@@ -199,11 +203,13 @@ module Inspec
 
     def read_from_tar(file)
       return nil unless @files.include?(file)
+
       res = nil
       # NB `TarReader` includes `Enumerable` beginning with Ruby 2.x
       walk_tar(@path) do |tar|
         tar.each do |entry|
           next unless entry.file? && [file, "./#{file}"].include?(entry.full_name)
+
           res = entry.read
           break
         end
@@ -235,16 +241,17 @@ module Inspec
       # PAX-formatted tar files. Do not do any translation of the path if the
       # path is an absolute path.
       @files = parent.files
-                     .find_all { |x| x.start_with?(prefix) && x != prefix }
-                     .map { |x| x[prefix.length..-1] }
-                     .map do |x|
-                       path = Pathname.new(x)
-                       path.absolute? ? path.to_s : path.relative_path_from(Pathname.new(".")).to_s
-                     end
+        .find_all { |x| x.start_with?(prefix) && x != prefix }
+        .map { |x| x[prefix.length..-1] }
+        .map do |x|
+          path = Pathname.new(x)
+          path.absolute? ? path.to_s : path.relative_path_from(Pathname.new(".")).to_s
+        end
     end
 
     def abs_path(file)
       return nil if file.nil?
+
       prefix + file
     end
 
@@ -278,12 +285,14 @@ module Inspec
 
     def get_folder_prefix(fs)
       return get_files_prefix(fs) if fs.length == 1
+
       first, *rest = fs
       pre = prefix_candidate_for(first)
 
       if rest.all? { |i| i.start_with? pre }
         return get_folder_prefix(rest)
       end
+
       get_files_prefix(fs)
     end
 
@@ -303,6 +312,7 @@ module Inspec
 
       new_pre = get_prefix(rest)
       return new_pre if pre.start_with? new_pre
+
       # edge case: completely different prefixes; retry prefix detection
       a = File.dirname(pre + "a")
       b = File.dirname(new_pre + "b")

data/lib/inspec/formatters/base.rb

@@ -49,6 +49,7 @@ module Inspec::Formatters
           end
 
           next if e.is_a? RSpec::Expectations::ExpectationNotMetError
+
           hash[:exception] = e.class.name
           hash[:backtrace] = e.backtrace
         end
@@ -101,6 +102,7 @@ module Inspec::Formatters
 
       all_unique_controls.each do |control|
         next unless control[:results]
+
         if control[:results].any? { |r| r[:status] == "failed" }
           failed += 1
         elsif control[:results].any? { |r| r[:status] == "skipped" }
@@ -185,6 +187,7 @@ module Inspec::Formatters
     # the proper report.
     def platform(field)
       return nil if @backend.nil?
+
       begin
         @backend.platform[field]
       rescue Train::Error => e
@@ -195,6 +198,7 @@ module Inspec::Formatters
 
     def backend_target
       return nil if @backend.nil?
+
       connection = @backend.backend
       connection.respond_to?(:uri) ? connection.uri : nil
     end
@@ -218,6 +222,7 @@ module Inspec::Formatters
     def example2control(example)
       profile = profile_from_example(example)
       return nil unless profile&.[](:controls)
+
       profile[:controls].find { |x| x[:id] == example[:id] }
     end
 

data/lib/inspec/impact.rb

@@ -12,6 +12,7 @@ module Inspec::Impact
     # return if its a number
     return value if is_number?(value)
     raise Inspec::ImpactError, "'#{value}' is not a valid impact name. Valid impact names: none, low, medium, high, critical." unless IMPACT_SCORES.key?(value.downcase)
+
     IMPACT_SCORES[value]
   end
 
@@ -25,6 +26,7 @@ module Inspec::Impact
   def self.string_from_impact(value)
     value = value.to_f
     raise Inspec::ImpactError, "'#{value}' is not a valid impact score. Valid impact scores: [0.0 - 1.0]." if value < 0 || value > 1
+
     IMPACT_SCORES.reverse_each do |name, impact|
       return name if value >= impact
     end

data/lib/inspec/input_registry.rb

@@ -169,11 +169,12 @@ module Inspec
         data = Inspec::SecretsBackend.resolve(path)
         if data.nil?
           raise Inspec::Exceptions::SecretsBackendNotFound,
-                "Cannot find parser for inputs file '#{path}'. " \
-                "Check to make sure file has the appropriate extension."
+            "Cannot find parser for inputs file '#{path}'. " \
+            "Check to make sure file has the appropriate extension."
         end
 
         next if data.inputs.nil?
+
         data.inputs.each do |input_name, input_value|
           evt = Inspec::Input::Event.new(
             value: input_value,
@@ -190,14 +191,14 @@ module Inspec
     def validate_inputs_file_readability!(path)
       unless File.exist?(path)
         raise Inspec::Exceptions::InputsFileDoesNotExist,
-              "Cannot find input file '#{path}'. " \
-              "Check to make sure file exists."
+          "Cannot find input file '#{path}'. " \
+          "Check to make sure file exists."
       end
 
       unless File.readable?(path)
         raise Inspec::Exceptions::InputsFileNotReadable,
-              "Cannot read input file '#{path}'. " \
-              "Check to make sure file is readable."
+          "Cannot read input file '#{path}'. " \
+          "Check to make sure file is readable."
       end
 
       true
@@ -260,13 +261,13 @@ module Inspec
 
     # These class methods are convenience methods so you don't always
     # have to call #instance when calling the registry
-    [
-      :find_or_register_input,
-      :register_profile_alias,
-      :list_inputs_for_profile,
-      :list_potential_input_names_for_profile,
-      :bind_profile_inputs,
-    ].each do |meth|
+    %i{
+      find_or_register_input
+      register_profile_alias
+      list_inputs_for_profile
+      list_potential_input_names_for_profile
+      bind_profile_inputs
+    }.each do |meth|
       define_singleton_method(meth) do |*args|
         instance.send(meth, *args)
       end

data/lib/inspec/metadata.rb

@@ -74,6 +74,7 @@ module Inspec
 
       %w{name version}.each do |field|
         next unless params[field.to_sym].nil?
+
         errors.push("Missing profile #{field} in #{ref}")
       end
 
@@ -89,6 +90,7 @@ module Inspec
 
       %w{title summary maintainer copyright license}.each do |field|
         next unless params[field.to_sym].nil?
+
         warnings.push("Missing profile #{field} in #{ref}")
       end
 
@@ -151,8 +153,8 @@ module Inspec
       when nil then nil
       else
         Inspec.deprecate(:supports_syntax,
-                         "Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
-                         "supports:\n  - os-family: #{x}\n\n")
+          "Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
+          "supports:\n  - os-family: #{x}\n\n")
         { :'os-family' => x } # rubocop:disable Style/HashSyntax
       end
     end
@@ -182,12 +184,14 @@ module Inspec
       # Crudely slug the target to not contain slashes, to avoid breaking
       # unit tests that look for warning sequences
       return if original_target.to_s.empty?
+
       metadata.params[:title] = "tests from #{original_target}"
       metadata.params[:name] = metadata.params[:title].gsub(%r{[\/\\]}, ".")
     end
 
     def self.finalize(metadata, profile_id, options, logger = nil)
       return nil if metadata.nil?
+
       param = metadata.params || {}
       options ||= {}
       param["version"] = param["version"].to_s unless param["version"].nil?

data/lib/inspec/method_source.rb

@@ -14,7 +14,7 @@ module Inspec
       ::MethodSource.expression_at(src.lines, location[:line]).force_encoding("utf-8")
     rescue SyntaxError => e
       raise ::MethodSource::SourceNotFoundError,
-            "Could not parse source at #{location[:ref]}:#{location[:line]}: #{e.message}"
+        "Could not parse source at #{location[:ref]}:#{location[:line]}: #{e.message}"
     end
   end
 end

data/lib/inspec/objects/control.rb

@@ -33,6 +33,7 @@ module Inspec
       descriptions.each do |label, text|
         if label == :default
           next if text.nil? || (text == "") # don't render empty/nil desc
+
           res.push "  desc  #{prettyprint_text(text, 2)}"
         else
           res.push "  desc  #{label.to_s.inspect}, #{prettyprint_text(text, 2)}"
@@ -52,6 +53,7 @@ module Inspec
     def print_ref(x)
       return x.inspect if x.is_a?(String)
       raise "Cannot process the ref: #{x}" unless x.is_a?(Hash)
+
       "(" + x.inspect + ")"
     end
 
@@ -62,7 +64,8 @@ module Inspec
     # @return [String] pretty-printed textblock
     def prettyprint_text(s, depth)
       txt = s.to_s.inspect.gsub('\n', "\n")
-      return txt if !txt.include?("\n")
+      return txt unless txt.include?("\n")
+
       middle = indent(txt[1..-2], depth + 2)
       txt[0] + "\n" + middle + "\n" + " " * depth + txt[-1]
     end

data/lib/inspec/objects/describe.rb

@@ -62,7 +62,8 @@ module Inspec
     end
 
     def to_ruby
-      return rb_skip if !skip.nil?
+      return rb_skip unless skip.nil?
+
       rb_describe
     end
 
@@ -72,6 +73,7 @@ module Inspec
 
     def resource
       return nil if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?
+
       qualifier[0][0]
     end
 

data/lib/inspec/objects/input.rb

@@ -309,9 +309,10 @@ module Inspec
 
     def to_hash
       as_hash = { name: name, options: {} }
-      [:description, :title, :identifier, :type, :required, :value].each do |field|
+      %i{description title identifier type required value}.each do |field|
         val = send(field)
         next if val.nil?
+
         as_hash[:options][field] = val
       end
       as_hash
@@ -372,11 +373,11 @@ module Inspec
 
       invalid_type = false
       if type_req == "Regexp"
-        invalid_type = true if !valid_regexp?(proposed_value)
+        invalid_type = true unless valid_regexp?(proposed_value)
       elsif type_req == "Numeric"
-        invalid_type = true if !valid_numeric?(proposed_value)
+        invalid_type = true unless valid_numeric?(proposed_value)
       elsif type_req == "Boolean"
-        invalid_type = true if ![true, false].include?(proposed_value)
+        invalid_type = true unless [true, false].include?(proposed_value)
       elsif proposed_value.is_a?(Module.const_get(type_req)) == false
         # TODO: why is this case here?
         invalid_type = true
@@ -400,7 +401,7 @@ module Inspec
         "Regex" => "Regexp",
       }
       type_req = abbreviations[type_req] if abbreviations.key?(type_req)
-      if !VALID_TYPES.include?(type_req)
+      unless VALID_TYPES.include?(type_req)
         error = Inspec::Input::TypeError.new
         error.input_type = type_req
         raise error, "Type '#{error.input_type}' is not a valid input type."

data/lib/inspec/objects/list.rb

@@ -2,10 +2,12 @@ module Inspec
   class List < Value
     def map
       raise "Inspec::List.map needs to be called with a block" unless block_given?
+
       t = List.new
       t.qualifier = [["x"]]
       yield(t)
       return if t.qualifier == [["x"]]
+
       @qualifier.push(["map", "{ |x| #{t.to_ruby} }"])
       self
     end

data/lib/inspec/objects/test.rb

@@ -14,7 +14,8 @@ module Inspec
     end
 
     def to_ruby
-      return rb_skip if !skip.nil?
+      return rb_skip unless skip.nil?
+
       rb_describe
     end
 
@@ -74,7 +75,7 @@ module Inspec
                 " " + expectation.inspect
               end
       format("%s%sdescribe %s do\n  %s { should%s %s%s }\nend",
-             only_if_clause, vars, res, itsy, naughty, matcher, xpect)
+        only_if_clause, vars, res, itsy, naughty, matcher, xpect)
     end
 
     def rb_skip

data/lib/inspec/plugin/v1/plugin_types/resource.rb

@@ -17,23 +17,27 @@ module Inspec
   module ResourceDSL
     def name(name = nil)
       return if name.nil?
+
       @name = name
       __register(name, self)
     end
 
     def desc(description = nil)
       return if description.nil?
+
       __resource_registry[@name].desc(description)
     end
 
     def supports(criteria = nil)
       return if criteria.nil?
+
       Inspec::Resource.supports[@name] ||= []
       Inspec::Resource.supports[@name].push(criteria)
     end
 
     def example(example = nil)
       return if example.nil?
+
       __resource_registry[@name].example(example)
     end
 
@@ -100,17 +104,20 @@ module Inspec
             # The new platform resources have methods generated on the fly
             # for inspec check to work we need to skip these train errors
             raise unless test_backend && e.receiver.class == Train::Transports::Mock::Connection
+
             skip_resource(e.message)
           end
         end
 
         def self.desc(description = nil)
           return @description if description.nil?
+
           @description = description
         end
 
         def self.example(example = nil)
           return @example if example.nil?
+
           @example = example
         end