inspec 4.7.3 → 4.7.18

data/lib/inspec/resources/zfs_dataset.rb

@@ -16,7 +16,8 @@ module Inspec::Resources
     EXAMPLE
 
     def initialize(zfs_dataset)
-      return skip_resource "The `zfs_dataset` resource is not supported on your OS yet." if !inspec.os.bsd?
+      return skip_resource "The `zfs_dataset` resource is not supported on your OS yet." unless inspec.os.bsd?
+
       @zfs_dataset = zfs_dataset
 
       @params = gather
@@ -28,7 +29,8 @@ module Inspec::Resources
     end
 
     def mounted?
-      return false if !exists?
+      return false unless exists?
+
       inspec.mount(@params["mountpoint"]).mounted?
     end
 

data/lib/inspec/resources/zfs_pool.rb

@@ -15,7 +15,8 @@ module Inspec::Resources
     EXAMPLE
 
     def initialize(zfs_pool)
-      return skip_resource "The `zfs_pool` resource is not supported on your OS yet." if !inspec.os.bsd?
+      return skip_resource "The `zfs_pool` resource is not supported on your OS yet." unless inspec.os.bsd?
+
       @zfs_pool = zfs_pool
 
       @params = gather

data/lib/inspec/rule.rb

@@ -49,6 +49,7 @@ module Inspec
 
       # evaluate the given definition
       return unless block_given?
+
       begin
         instance_eval(&block)
       rescue StandardError => e
@@ -91,6 +92,7 @@ module Inspec
 
     def desc(v = nil, data = nil)
       return @descriptions[:default] if v.nil?
+
       if data.nil?
         @descriptions[:default] = unindent(v)
       else
@@ -100,11 +102,13 @@ module Inspec
 
     def descriptions(description_hash = nil)
       return @descriptions if description_hash.nil?
+
       @descriptions.merge!(description_hash)
     end
 
     def ref(ref = nil, opts = {})
       return @refs if ref.nil? && opts.empty?
+
       if opts.empty? && ref.is_a?(Hash)
         opts = ref
       else
@@ -191,7 +195,7 @@ module Inspec
 
     def self.set_skip_rule(rule, value, message = nil)
       rule.instance_variable_set(:@__skip_rule,
-                                 { result: value, message: message })
+        { result: value, message: message })
     end
 
     def self.merge_count(rule)
@@ -205,6 +209,7 @@ module Inspec
     def self.prepare_checks(rule)
       skip_check = skip_status(rule)
       return checks(rule) unless skip_check[:result].eql?(true)
+
       if skip_check[:message]
         msg = "Skipped control due to only_if condition: #{skip_check[:message]}"
       else
@@ -223,12 +228,14 @@ module Inspec
         # TODO: register an error, this case should not happen
         return
       end
+
       sp = rule_id(src)
       dp = rule_id(dst)
       if sp != dp
         # TODO: register an error, this case should not happen
         return
       end
+
       # merge all fields
       dst.impact(src.impact)                 unless src.impact.nil?
       dst.title(src.title)                   unless src.title.nil?
@@ -274,6 +281,7 @@ module Inspec
     #
     def with_dsl(block)
       return nil if block.nil?
+
       if self.class.resource_dsl
         dsl = self.class.resource_dsl
         proc do |*args|
@@ -299,6 +307,7 @@ module Inspec
     # @return [String] input with indentation removed; '' if input is nil
     def unindent(text)
       return "" if text.nil?
+
       len = text.split("\n").reject { |l| l.strip.empty? }.map { |x| x.index(/[^\s]/) }.compact.min
       text.gsub(/^[[:blank:]]{#{len}}/, "").strip
     end
@@ -306,6 +315,7 @@ module Inspec
     # get the source location of the block
     def __get_block_source_location(&block)
       return {} unless block_given?
+
       r, l = block.source_location
       { ref: r, line: l }
     rescue MethodSource::SourceNotFoundError

data/lib/inspec/runner.rb

@@ -136,7 +136,7 @@ module Inspec
     end
 
     def write_lockfile(profile)
-      return false if !profile.writable?
+      return false unless profile.writable?
 
       if profile.lockfile_exists?
         Inspec::Log.debug "Using existing lockfile #{profile.lockfile_path}"
@@ -182,16 +182,17 @@ module Inspec
     #
     def add_target(target, _opts = [])
       profile = Inspec::Profile.for_target(target,
-                                           vendor_cache: @cache,
-                                           backend: @backend,
-                                           controls: @controls,
-                                           runner_conf: @conf)
+        vendor_cache: @cache,
+        backend: @backend,
+        controls: @controls,
+        runner_conf: @conf)
       raise "Could not resolve #{target} to valid input." if profile.nil?
+
       @target_profiles << profile if supports_profile?(profile)
     end
 
     def supports_profile?(profile)
-      if !profile.supports_runtime?
+      unless profile.supports_runtime?
         raise "This profile requires #{Inspec::Dist::PRODUCT_NAME} version "\
              "#{profile.metadata.inspec_requirement}. You are running "\
              "#{Inspec::Dist::PRODUCT_NAME} v#{Inspec::VERSION}.\n"
@@ -211,6 +212,7 @@ module Inspec
       new_tests = false
       ctx.rules.each do |rule_id, rule|
         next if block_given? && !(yield rule_id, rule)
+
         new_tests = true
         register_rule(rule)
       end
@@ -238,6 +240,7 @@ module Inspec
 
     def block_source_info(block)
       return {} if block.nil? || !block.respond_to?(:source_location)
+
       opts = {}
       file_path, line = block.source_location
       opts["file_path"] = file_path

data/lib/inspec/runner_rspec.rb

@@ -31,10 +31,10 @@ module Inspec
     # @return [nil]
     def add_profile(profile)
       RSpec.configuration.formatters
-           .find_all { |c| c.is_a?(Inspec::Formatters::Base) }
-           .each do |fmt|
-        fmt.add_profile(profile)
-      end
+        .find_all { |c| c.is_a?(Inspec::Formatters::Base) }
+        .each do |fmt|
+          fmt.add_profile(profile)
+        end
     end
 
     # Configure the backend of the runner.
@@ -43,10 +43,10 @@ module Inspec
     # @return [nil]
     def backend=(backend)
       RSpec.configuration.formatters
-           .find_all { |c| c.is_a?(Inspec::Formatters::Base) }
-           .each do |fmt|
-        fmt.backend = backend
-      end
+        .find_all { |c| c.is_a?(Inspec::Formatters::Base) }
+        .each do |fmt|
+          fmt.backend = backend
+        end
     end
 
     # Add an example group to the list of registered tests.
@@ -81,6 +81,7 @@ module Inspec
     # @return [int] exit code
     def exit_code
       return @rspec_exit_code if @formatter.results.empty?
+
       stats = @formatter.results[:statistics][:controls]
       skipped = @formatter.results&.fetch(:profiles, nil)&.first&.fetch(:status, nil) == "skipped"
       if stats[:failed][:total] == 0 && stats[:skipped][:total] == 0 && !skipped
@@ -111,6 +112,7 @@ module Inspec
     #
     def set_optional_formatters
       return if @conf["reporter"].nil?
+
       if @conf["reporter"].key?("json-rspec")
         # We cannot pass in a nil output path. Rspec only accepts a valid string or a IO object.
         if @conf["reporter"]["json-rspec"]&.[]("file").nil?

data/lib/inspec/schema.rb

@@ -228,6 +228,7 @@ module Inspec
       else
         v = LIST[name]
       end
+
       JSON.dump(v)
     end
   end

data/lib/inspec/secrets.rb

@@ -7,6 +7,7 @@ module Inspec
     if version != 1
       raise "Only secrets version 1 is supported!"
     end
+
     Inspec::Plugins::Secret
   end
 end

data/lib/inspec/secrets/yaml.rb

@@ -10,6 +10,7 @@ module Secrets
       unless target.is_a?(String) && File.file?(target) && [".yml", ".yaml"].include?(File.extname(target).downcase)
         return nil
       end
+
       new(target)
     end
 

data/lib/inspec/shell.rb

@@ -24,7 +24,7 @@ module Inspec
       # Delete any before_session, before_eval, and after_eval hooks so we can
       # replace them with our own. Pry 0.10 used to have a single method to clear
       # all hooks, but this was removed in Pry 0.11.
-      [:before_session, :before_eval, :after_eval].each do |event|
+      %i{before_session before_eval after_eval}.each do |event|
         Pry.hooks.get_hooks(event).keys.map { |hook| Pry.hooks.delete_hook(event, hook) }
       end
 
@@ -54,13 +54,14 @@ module Inspec
       # test file, register all the rules it discovered.
       Pry.hooks.add_hook(:after_eval, "inspec_after_eval") do
         @runner.load
-        @runner.run_tests if !@runner.all_rules.empty?
+        @runner.run_tests unless @runner.all_rules.empty?
       end
 
       # Don't print out control class inspection when the user uses DSL methods.
       # Instead produce a result of evaluating their control.
       Pry.config.print = proc do |_output_, value, pry|
-        next if !@runner.all_rules.empty?
+        next unless @runner.all_rules.empty?
+
         pry.pager.open do |pager|
           pager.print pry.config.output_prefix
           Pry::ColorPrinter.pp(value, pager, Pry::Terminal.width! - 1)
@@ -78,7 +79,7 @@ module Inspec
 
     def intro
       puts "Welcome to the interactive InSpec Shell"
-      puts "To find out how to use it, type: #{mark 'help'}"
+      puts "To find out how to use it, type: #{mark "help"}"
       puts
     end
 
@@ -118,18 +119,18 @@ module Inspec
         print_matchers_help
       elsif !Inspec::Resource.registry[topic].nil? # TODO: fix unnecessary logic
         topic_info = Inspec::Resource.registry[topic]
-        info = "#{mark 'Name:'} #{topic}\n\n"
+        info = "#{mark "Name:"} #{topic}\n\n"
         unless topic_info.desc.nil?
-          info += "#{mark 'Description:'}\n\n"
+          info += "#{mark "Description:"}\n\n"
           info += "#{topic_info.desc}\n\n"
         end
 
         unless topic_info.example.nil?
-          info += "#{mark 'Example:'}\n\n"
+          info += "#{mark "Example:"}\n\n"
           info += "#{topic_info.example}\n\n"
         end
 
-        info += "#{mark 'Web Reference:'}\n\n"
+        info += "#{mark "Web Reference:"}\n\n"
         info += "https://www.inspec.io/docs/reference/resources/#{topic}\n\n"
         puts info
       else
@@ -147,15 +148,15 @@ module Inspec
         resources implement their own custom matchers, the following matchers are
         common amongst all resources:
 
-        #{mark 'be'}
+        #{mark "be"}
 
-        The #{mark 'be'} matcher can be used to compare numeric values.
+        The #{mark "be"} matcher can be used to compare numeric values.
 
           its('size') { should be >= 10 }
 
-        #{mark 'cmp'}
+        #{mark "cmp"}
 
-        The #{mark 'cmp'} matcher is like #{mark 'eq'} but less restrictive. It will try
+        The #{mark "cmp"} matcher is like #{mark "eq"} but less restrictive. It will try
         to fit the resource value to the expectation.
 
         "Protocol" likely returns a string, but cmp will ensure it's a number before
@@ -174,23 +175,23 @@ module Inspec
           its('log_format') { should cmp 'raw' }
           its('log_format') { should cmp 'RAW' }
 
-        #{mark 'eq'}
+        #{mark "eq"}
 
-        The #{mark 'eq'} matcher tests for exact equality of two values. Value type
+        The #{mark "eq"} matcher tests for exact equality of two values. Value type
         (string, number, etc.) is important and must be the same. For a less-restrictive
-        comparison matcher, use the #{mark 'cmp'} matcher.
+        comparison matcher, use the #{mark "cmp"} matcher.
 
           its('RSAAuthentication') { should_not eq 'no' }
 
-        #{mark 'include'}
+        #{mark "include"}
 
-        The #{mark 'include'} matcher tests to see if a value is included in a list.
+        The #{mark "include"} matcher tests to see if a value is included in a list.
 
           its('users') { should include 'my_user' }
 
-        #{mark 'match'}
+        #{mark "match"}
 
-        The #{mark 'match'} matcher can be used to test a string for a match using a
+        The #{mark "match"} matcher can be used to test a string for a match using a
         regular expression.
 
           its('content') { should_not match /^MyKey:\\s+some value/ }

data/lib/inspec/shell_detector.rb

@@ -23,7 +23,7 @@ module Inspec
     end
 
     def shell
-      @shell = detect if !detected?(@shell)
+      @shell = detect unless detected?(@shell)
       @shell
     end
 

data/lib/inspec/source_reader.rb

@@ -6,6 +6,7 @@ module Inspec
   class SourceReaderRegistry < PluginRegistry
     def resolve(target)
       return nil if target.nil?
+
       super(target)
     end
   end
@@ -16,6 +17,7 @@ module Inspec
     if version != 1
       raise "Only source readers version 1 is supported!"
     end
+
     Inspec::Plugins::SourceReader
   end
 end

data/lib/inspec/ui.rb

@@ -204,6 +204,7 @@ module Inspec
       unless interactive?
         raise Inspec::UserInteractionRequired, "Somthing is trying to ask the user a question, but interactivity is disabled."
       end
+
       require "tty-prompt"
 
       @prompt ||= TTY::Prompt.new

data/lib/inspec/utils/deprecation/config_file.rb

@@ -41,6 +41,7 @@ module Inspec
         unless File.exist?(default_path)
           raise Inspec::Deprecation::MalformedConfigError, "Missing deprecation config file: #{default_path}"
         end
+
         File.open(default_path)
       end
 
@@ -57,6 +58,7 @@ module Inspec
         unless @raw_data["groups"].is_a?(Hash)
           raise Inspec::Deprecation::InvalidConfigFileError, "Groups field must be a Hash"
         end
+
         @raw_data["groups"].each do |group_name, group_info|
           validate_group_entry(group_name, group_info)
         end
@@ -67,22 +69,23 @@ module Inspec
           raise Inspec::Deprecation::InvalidConfigFileError, "Missing file_version field"
         end
         unless @raw_data["file_version"] == "1.0.0"
-          raise Inspec::Deprecation::InvalidConfigFileError, "Unrecognized file_version '#{@raw_data['file_version']}' - supported versions: 1.0.0"
+          raise Inspec::Deprecation::InvalidConfigFileError, "Unrecognized file_version '#{@raw_data["file_version"]}' - supported versions: 1.0.0"
         end
       end
 
       def validate_unknown_group_action
         seen_action = (@raw_data["unknown_group_action"] || @unknown_group_action).to_sym
         unless VALID_ACTIONS.include?(seen_action)
-          raise Inspec::Deprecation::UnrecognizedActionError, "Unrecognized value '#{seen_action}' for field 'unknown_group_action' - supported actions: #{VALID_ACTIONS.map(&:to_s).join(', ')}"
+          raise Inspec::Deprecation::UnrecognizedActionError, "Unrecognized value '#{seen_action}' for field 'unknown_group_action' - supported actions: #{VALID_ACTIONS.map(&:to_s).join(", ")}"
         end
+
         @unknown_group_action = seen_action
       end
 
       def validate_group_entry(name, opts)
         opts.each do |seen_field, _value|
           unless VALID_GROUP_FIELDS.include?(seen_field)
-            raise Inspec::Deprecation::InvalidConfigFileError, "Unrecognized field for group '#{name}' - saw '#{seen_field}', supported fields: #{VALID_GROUP_FIELDS.map(&:to_s).join(', ')}"
+            raise Inspec::Deprecation::InvalidConfigFileError, "Unrecognized field for group '#{name}' - saw '#{seen_field}', supported fields: #{VALID_GROUP_FIELDS.map(&:to_s).join(", ")}"
           end
         end
 
@@ -90,8 +93,9 @@ module Inspec
 
         opts["action"] = (opts["action"] || :warn).to_sym
         unless VALID_ACTIONS.include?(opts["action"])
-          raise Inspec::Deprecation::UnrecognizedActionError, "Unrecognized action for group '#{name}' - saw '#{opts['action']}', supported actions: #{VALID_ACTIONS.map(&:to_s).join(', ')}"
+          raise Inspec::Deprecation::UnrecognizedActionError, "Unrecognized action for group '#{name}' - saw '#{opts["action"]}', supported actions: #{VALID_ACTIONS.map(&:to_s).join(", ")}"
         end
+
         entry.action = opts["action"]
 
         entry.suffix = opts["suffix"]

data/lib/inspec/utils/erlang_parser.rb

@@ -94,6 +94,7 @@ class ErlangBitstream
   def bit_size(size, type)
     raise "Cannot specify size and type at the same time." if !type.nil? && !size.nil?
     return (size || 8).to_i if type.nil?
+
     TYPES[type] || raise("Cannot handle binary-stream type #{type}")
   end
 
@@ -101,6 +102,7 @@ class ErlangBitstream
     if i[:integer].nil? && i[:string].nil?
       raise "No data provided, internal error for binary-stream processing!"
     end
+
     s = bit_size(i[:size], i[:type])
     unless i[:string].nil?
       str2int(i[:string].to_s, i[:type]).map { |e| add_bits(int2bits(e, 8)) }

data/lib/inspec/utils/file_reader.rb

@@ -6,7 +6,7 @@ module FileReader
     # pre-refactor (which used skip_resource). These should likely be changed to
     # ResourceFailed during a major version bump.
     file = inspec.file(path)
-    if !file.file?
+    unless file.file?
       raise Inspec::Exceptions::ResourceSkipped, "Can't find file: #{path}"
     end