inspec 4.3.2 → 4.6.3

data/lib/inspec/objects/describe.rb

@@ -1,5 +1,3 @@
-# encoding:utf-8
-
 module Inspec
   class Describe
     # Internal helper to structure test objects.
@@ -11,24 +9,24 @@ module Inspec
       end
 
       def to_ruby
-        itsy = 'it'
+        itsy = "it"
         unless its.nil?
           if its.is_a? Array
-            itsy = 'its(' + its.inspect + ')'
+            itsy = "its(" + its.inspect + ")"
           else
-            itsy = 'its(' + its.to_s.inspect + ')'
+            itsy = "its(" + its.to_s.inspect + ")"
           end
         end
-        naughty = negated ? '_not' : ''
+        naughty = negated ? "_not" : ""
         xpect = if expectation.nil?
-                  ''
+                  ""
                 elsif expectation.class == Regexp
                   # without this, xpect values like / \/zones\// will not be parsed properly
                   "(#{expectation.inspect})"
                 else
-                  ' ' + expectation.inspect
+                  " " + expectation.inspect
                 end
-        format('%s { should%s %s%s }', itsy, naughty, matcher, xpect)
+        format("%s { should%s %s%s }", itsy, naughty, matcher, xpect)
       end
     end
 
@@ -84,8 +82,8 @@ module Inspec
       vars += "\n" unless vars.empty?
 
       objarr = @qualifier
-      objarr = [['unknown object'.inspect]] if objarr.nil? || objarr.empty?
-      obj = objarr.map { |q| ruby_qualifier(q) }.join('.')
+      objarr = [["unknown object".inspect]] if objarr.nil? || objarr.empty?
+      obj = objarr.map { |q| ruby_qualifier(q) }.join(".")
 
       rbtests = tests.map(&:to_ruby).join("\n  ")
       format("%sdescribe %s do\n  %s\nend", vars, obj, rbtests)

data/lib/inspec/objects/each_loop.rb

@@ -1,5 +1,3 @@
-# encoding:utf-8
-
 module Inspec
   class EachLoop < List
     attr_reader :variables
@@ -12,7 +10,7 @@ module Inspec
 
     def add_test(t = nil)
       t ||= Test.new
-      t.qualifier[0] = ['entry']
+      t.qualifier[0] = ["entry"]
       @tests.push(t)
       t
     end

data/lib/inspec/objects/input.rb

@@ -1,6 +1,4 @@
-# encoding:utf-8
-
-require 'utils/deprecation'
+require "inspec/utils/deprecation"
 
 # For backwards compatibility during the rename (see #3802),
 # maintain the Inspec::Attribute namespace for people checking for
@@ -8,7 +6,7 @@ require 'utils/deprecation'
 module Inspec
   class Attribute
     # This only exists to create the Inspec::Attribute::DEFAULT_ATTRIBUTE symbol with a class
-    class DEFAULT_ATTRIBUTE; end # rubocop: disable Style/ClassAndModuleCamelCase
+    class DEFAULT_ATTRIBUTE; end # rubocop: disable Naming/ClassAndModuleCamelCase
   end
 end
 
@@ -44,7 +42,7 @@ module Inspec
         properties.each do |prop_name, prop_value|
           if EVENT_PROPERTIES.include? prop_name
             # OK, save the property
-            send((prop_name.to_s + '=').to_sym, prop_value)
+            send((prop_name.to_s + "=").to_sym, prop_value)
           else
             raise "Unrecognized property to Input::Event: #{prop_name}"
           end
@@ -62,7 +60,7 @@ module Inspec
       end
 
       def diagnostic_string
-        to_h.reject { |_, val| val.nil? }.to_a.map { |pair| "#{pair[0]}: '#{pair[1]}'" }.join(', ')
+        to_h.reject { |_, val| val.nil? }.to_a.map { |pair| "#{pair[0]}: '#{pair[1]}'" }.join(", ")
       end
 
       def to_h
@@ -73,7 +71,7 @@ module Inspec
 
       def self.probe_stack
         frames = caller_locations(2, 40)
-        frames.reject! { |f| f.path && f.path.include?('/lib/inspec/') }
+        frames.reject! { |f| f.path && f.path.include?("/lib/inspec/") }
         frames.first
       end
     end
@@ -84,16 +82,18 @@ module Inspec
     # This special class is used to represent the value when an input has
     # not been assigned a value. This allows a user to explicitly assign nil
     # to an input.
-    class NO_VALUE_SET # rubocop: disable Style/ClassAndModuleCamelCase
+    class NO_VALUE_SET # rubocop: disable Naming/ClassAndModuleCamelCase
       def initialize(name)
         @name = name
 
         # output warn message if we are in a exec call
-        Inspec::Log.warn(
-          "Input '#{@name}' does not have a value. "\
-          "Use --input-file to provide a value for '#{@name}' or specify a  "\
-          "value with `attribute('#{@name}', value: 'somevalue', ...)`.",
-        ) if Inspec::BaseCLI.inspec_cli_command == :exec
+        if Inspec::BaseCLI.inspec_cli_command == :exec
+          Inspec::Log.warn(
+            "Input '#{@name}' does not have a value. "\
+            "Use --input-file to provide a value for '#{@name}' or specify a  "\
+            "value with `attribute('#{@name}', value: 'somevalue', ...)`."
+          )
+        end
       end
 
       def method_missing(*_)
@@ -224,7 +224,7 @@ module Inspec
         provider: options[:provider] || :unknown,
         priority: options[:priority] || Inspec::Input::DEFAULT_PRIORITY_FOR_UNKNOWN_CALLER,
         file: location.path,
-        line: location.lineno,
+        line: location.lineno
       )
 
       if options.key?(:default)
@@ -257,7 +257,7 @@ module Inspec
         action: :create,
         provider: options[:provider],
         file: loc.path,
-        line: loc.lineno,
+        line: loc.lineno
       )
     end
 
@@ -289,11 +289,9 @@ module Inspec
         priority: priority,
         value: new_value,
         file: location.path,
-        line: location.lineno,
+        line: location.lineno
       )
       enforce_type_restriction!
-
-      new_value
     end
 
     def value
@@ -320,7 +318,7 @@ module Inspec
     end
 
     def ruby_var_identifier
-      identifier || 'attr_' + name.downcase.strip.gsub(/\s+/, '-').gsub(/[^\w-]/, '')
+      identifier || "attr_" + name.downcase.strip.gsub(/\s+/, "-").gsub(/[^\w-]/, "")
     end
 
     def to_ruby
@@ -332,7 +330,7 @@ module Inspec
       # send the default: option as well. See #3759
       res.push "  default: #{value.inspect}," unless value.to_s.empty?
       res.push "  description: '#{description}'," unless description.to_s.empty?
-      res.push '})'
+      res.push "})"
       res.join("\n")
     end
 
@@ -368,16 +366,16 @@ module Inspec
       return unless has_value?
 
       type_req = type
-      return if type_req == 'Any'
+      return if type_req == "Any"
 
       proposed_value = current_value
 
       invalid_type = false
-      if type_req == 'Regexp'
+      if type_req == "Regexp"
         invalid_type = true if !valid_regexp?(proposed_value)
-      elsif type_req == 'Numeric'
+      elsif type_req == "Numeric"
         invalid_type = true if !valid_numeric?(proposed_value)
-      elsif type_req == 'Boolean'
+      elsif type_req == "Boolean"
         invalid_type = true if ![true, false].include?(proposed_value)
       elsif proposed_value.is_a?(Module.const_get(type_req)) == false
         # TODO: why is this case here?
@@ -398,8 +396,8 @@ module Inspec
 
       type_req = type.capitalize
       abbreviations = {
-        'Num' => 'Numeric',
-        'Regex' => 'Regexp',
+        "Num" => "Numeric",
+        "Regex" => "Regexp",
       }
       type_req = abbreviations[type_req] if abbreviations.key?(type_req)
       if !VALID_TYPES.include?(type_req)

data/lib/inspec/objects/list.rb

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

data/lib/inspec/objects/or_test.rb

@@ -1,5 +1,3 @@
-# encoding:utf-8
-
 module Inspec
   class OrTest
     attr_reader :tests
@@ -20,10 +18,10 @@ module Inspec
       if @negated
         # We don't use the describe.one wrapper when negated because:
         # !(test1 || test2)     same as    (!test1 && !test2)    where && is implicit in inspec
-        all_tests = @tests.map { |test|
+        all_tests = @tests.map do |test|
           test.negate!
           test
-        }.map(&:to_ruby).join("\n")
+        end.map(&:to_ruby).join("\n")
 
         all_tests
       else

data/lib/inspec/objects/ruby_helper.rb

@@ -1,14 +1,12 @@
-# encoding: utf-8
-
 module Inspec
   module RubyHelper
     def ruby_qualifier(q)
       if q.length <= 1
         q[0]
-      elsif q[0] == 'map' && q.length == 2
-        q[0] + ' ' + q[1]
+      elsif q[0] == "map" && q.length == 2
+        q[0] + " " + q[1]
       else
-        q[0] + '(' + q[1..-1].map(&:inspect).join(', ') + ')'
+        q[0] + "(" + q[1..-1].map(&:inspect).join(", ") + ")"
       end
     end
   end

data/lib/inspec/objects/tag.rb

@@ -1,5 +1,3 @@
-# encoding:utf-8
-
 module Inspec
   class Tag
     attr_accessor :key, :value

data/lib/inspec/objects/test.rb

@@ -1,5 +1,3 @@
-# encoding:utf-8
-
 module Inspec
   class Test
     attr_accessor :qualifier, :matcher, :expectation, :skip, :negated, :variables, :only_if
@@ -43,17 +41,17 @@ module Inspec
       return nil if @qualifier.empty?
 
       resource = @qualifier.length > 1 ? @qualifier[0..-2] : [@qualifier[0]]
-      res = resource.map { |q| ruby_qualifier(q) }.join('.')
+      res = resource.map { |q| ruby_qualifier(q) }.join(".")
       xres = nil
 
       if @qualifier.length > 1
         last = @qualifier[-1]
-        last_call = last.is_a?(Array) ? last[0].to_s : ''
-        if last.length == 1 && last_call !~ /^to_.$/ && !last_call.include?('[') && !last_call.empty?
+        last_call = last.is_a?(Array) ? last[0].to_s : ""
+        if last.length == 1 && last_call !~ /^to_.$/ && !last_call.include?("[") && !last_call.empty?
           # this will go in its()
           xres = last_call
         else
-          res += '.' + ruby_qualifier(last) unless last_call.empty?
+          res += "." + ruby_qualifier(last) unless last_call.empty?
         end
       end
 
@@ -65,15 +63,15 @@ module Inspec
       vars = variables.map(&:to_ruby).join("\n")
       vars += "\n" unless vars.empty?
       res, xtra = describe_chain
-      itsy = xtra.nil? ? 'it' : 'its(' + xtra.to_s.inspect + ')'
-      naughty = @negated ? '_not' : ''
+      itsy = xtra.nil? ? "it" : "its(" + xtra.to_s.inspect + ")"
+      naughty = @negated ? "_not" : ""
       xpect = if !defined?(@expectation)
-                ''
+                ""
               elsif @expectation.class == Regexp
                 # without this, xpect values like / \/zones\// will not be parsed properly
                 "(#{@expectation.inspect})"
-              elsif xpect != ''
-                ' ' + expectation.inspect
+              elsif xpect != ""
+                " " + expectation.inspect
               end
       format("%s%sdescribe %s do\n  %s { should%s %s%s }\nend",
              only_if_clause, vars, res, itsy, naughty, matcher, xpect)

data/lib/inspec/objects/value.rb

@@ -1,5 +1,3 @@
-# encoding:utf-8
-
 module Inspec
   class Value
     include ::Inspec::RubyHelper
@@ -14,12 +12,12 @@ module Inspec
     end
 
     def to_ruby
-      res = @variable.nil? ? '' : "#{@variable} = "
-      res + @qualifier.map { |x| ruby_qualifier(x) }.join('.')
+      res = @variable.nil? ? "" : "#{@variable} = "
+      res + @qualifier.map { |x| ruby_qualifier(x) }.join(".")
     end
 
     def name_variable(cache = [])
-      @variable = Array('a'..'z').find { |x| !cache.include?(x) }
+      @variable = Array("a".."z").find { |x| !cache.include?(x) }
       cache.push(@variable)
       @variable
     end

data/lib/inspec/plugin/v1.rb

@@ -1,2 +1,2 @@
-require 'inspec/plugin/v1/plugins'
-require 'inspec/plugin/v1/registry'
+require "inspec/plugin/v1/plugins"
+require "inspec/plugin/v1/registry"

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

@@ -1,8 +1,4 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-require 'inspec/plugin/v1/registry'
+require "inspec/plugin/v1/registry"
 
 module Inspec
   module Plugins

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

@@ -1,8 +1,5 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-require 'inspec/file_provider'
-require 'inspec/plugin/v1/registry'
+require "inspec/file_provider"
+require "inspec/plugin/v1/registry"
 
 module Inspec
   module Plugins

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

@@ -1,6 +1,4 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
+require "inspec/exceptions"
 
 module Inspec
   module ResourceBehaviors
@@ -45,7 +43,7 @@ module Inspec
     # Even tho this is defined as an instance method, it gets added to
     # Inspec::Plugins::Resource via `extend`, so this is actually a class defintion.
     def method_missing(method_name, *arguments, &block)
-      require 'inspec/plugin/v2'
+      require "inspec/plugin/v2"
       # Check to see if there is a resource_dsl plugin activator hook with the method name
       registry = Inspec::Plugin::V2::Registry.instance
       hook = registry.find_activators(plugin_type: :resource_dsl, activator_name: method_name).first
@@ -118,7 +116,7 @@ module Inspec
 
         def check_supports
           status = inspec.platform.supported?(@supports)
-          fail_msg = "Resource #{@__resource_name__.capitalize} is not supported on platform #{inspec.platform.name}/#{inspec.platform.release}."
+          fail_msg = "Resource `#{@__resource_name__}` is not supported on platform #{inspec.platform.name}/#{inspec.platform.release}."
           fail_resource(fail_msg) unless status
           status
         end
@@ -150,7 +148,7 @@ module Inspec
 
       # Warn if a resource pack is overwriting a core resource.
       # Suppress warning if the resource is an AWS resource, see #3822
-      if __resource_registry.key?(name) && !name.start_with?('aws_')
+      if __resource_registry.key?(name) && !name.start_with?("aws_")
         Inspec::Log.warn("Overwriting resource #{name}. To reference a specific version of #{name} use the resource() method")
       end
       __resource_registry[name] = cl

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

@@ -1,8 +1,4 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'inspec/plugin/v1/registry'
+require "inspec/plugin/v1/registry"
 
 module Inspec
   module Plugins

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

@@ -1,8 +1,4 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'inspec/plugin/v1/registry'
+require "inspec/plugin/v1/registry"
 
 module Inspec
   module Plugins

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

@@ -1,19 +1,15 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'forwardable'
+require "forwardable"
 
 module Inspec
   # Resource Plugins
   # NOTE: the autoloading here is rendered moot by the fact that
   # all core plugins are `require`'d by the base inspec.rb
   module Plugins
-    autoload :Resource, 'inspec/plugin/v1/plugin_types/resource'
-    autoload :CLI, 'inspec/plugin/v1/plugin_types/cli'
-    autoload :Fetcher, 'inspec/plugin/v1/plugin_types/fetcher'
-    autoload :SourceReader, 'inspec/plugin/v1/plugin_types/source_reader'
-    autoload :Secret, 'inspec/plugin/v1/plugin_types/secret'
+    autoload :Resource, "inspec/plugin/v1/plugin_types/resource"
+    autoload :CLI, "inspec/plugin/v1/plugin_types/cli"
+    autoload :Fetcher, "inspec/plugin/v1/plugin_types/fetcher"
+    autoload :SourceReader, "inspec/plugin/v1/plugin_types/source_reader"
+    autoload :Secret, "inspec/plugin/v1/plugin_types/secret"
   end
 
   # PLEASE NOTE: The Plugin system is an internal mechanism for connecting
@@ -30,24 +26,24 @@ module Inspec
       @paths = []
 
       # load plugins in the same gem installation
-      lib_home = File.expand_path(File.join(__FILE__, '..', '..', '..', '..'))
-      @paths += Dir[lib_home+'/inspec-*-*/lib/inspec-*rb']
+      lib_home = File.expand_path(File.join(__FILE__, "..", "..", "..", ".."))
+      @paths += Dir[lib_home + "/inspec-*-*/lib/inspec-*rb"]
 
       # 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')]
+      @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')] }
+                .map { |x| Dir[File.join(x, "lib", "inspec-*.rb")] }
                 .flatten
 
       # load bundled plugins
       bundled_dir = File.expand_path(File.dirname(__FILE__))
-      @paths += Dir[File.join(bundled_dir, '..', 'bundles', 'inspec-*.rb')].flatten
+      @paths += Dir[File.join(bundled_dir, "..", "bundles", "inspec-*.rb")].flatten
 
       # map paths to names
-      @registry = Hash[@paths.map { |x|
-        [File.basename(x, '.rb'), x]
-      }]
+      @registry = Hash[@paths.map do |x|
+        [File.basename(x, ".rb"), x]
+      end]
     end
 
     def load(name)