inspec 1.51.15 → 1.51.18

data/lib/inspec/plugins.rb

@@ -1,60 +1,60 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'forwardable'
-
-module Inspec
-  # Resource Plugins
-  module Plugins
-    autoload :Resource, 'inspec/plugins/resource'
-    autoload :CLI, 'inspec/plugins/cli'
-    autoload :Fetcher, 'inspec/plugins/fetcher'
-    autoload :SourceReader, 'inspec/plugins/source_reader'
-    autoload :Secret, 'inspec/plugins/secret'
-  end
-
-  # PLEASE NOTE: The Plugin system is an internal mechanism for connecting
-  # inspec components. Its API is currently considered in an alpha state
-  # and may change between minor version revisions. A stable plugin API will be
-  # released in the future.
-  class PluginCtl
-    extend Forwardable
-
-    attr_reader :registry
-    def_delegator :registry, :keys, :list
-
-    def initialize(home = nil)
-      @paths = []
-
-      # load plugins in the same gem installation
-      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(Dir.home, '.inspec', 'plugins')
-      @paths += Dir[File.join(@home, '**{,/*/**}', '*.gemspec')]
-                .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__))
-      @paths += Dir[File.join(bundled_dir, '..', 'bundles', 'inspec-*.rb')].flatten
-
-      # map paths to names
-      @registry = Hash[@paths.map { |x|
-        [File.basename(x, '.rb'), x]
-      }]
-    end
-
-    def load(name)
-      path = @registry[name]
-      if path.nil?
-        raise "Couldn't find plugin #{name}. Searching in #{@home}"
-      end
-      # puts "Loading plugin #{name} from #{path}"
-      require path
-    end
-  end
-end
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+require 'forwardable'
+
+module Inspec
+  # Resource Plugins
+  module Plugins
+    autoload :Resource, 'inspec/plugins/resource'
+    autoload :CLI, 'inspec/plugins/cli'
+    autoload :Fetcher, 'inspec/plugins/fetcher'
+    autoload :SourceReader, 'inspec/plugins/source_reader'
+    autoload :Secret, 'inspec/plugins/secret'
+  end
+
+  # PLEASE NOTE: The Plugin system is an internal mechanism for connecting
+  # inspec components. Its API is currently considered in an alpha state
+  # and may change between minor version revisions. A stable plugin API will be
+  # released in the future.
+  class PluginCtl
+    extend Forwardable
+
+    attr_reader :registry
+    def_delegator :registry, :keys, :list
+
+    def initialize(home = nil)
+      @paths = []
+
+      # load plugins in the same gem installation
+      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(Dir.home, '.inspec', 'plugins')
+      @paths += Dir[File.join(@home, '**{,/*/**}', '*.gemspec')]
+                .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__))
+      @paths += Dir[File.join(bundled_dir, '..', 'bundles', 'inspec-*.rb')].flatten
+
+      # map paths to names
+      @registry = Hash[@paths.map { |x|
+        [File.basename(x, '.rb'), x]
+      }]
+    end
+
+    def load(name)
+      path = @registry[name]
+      if path.nil?
+        raise "Couldn't find plugin #{name}. Searching in #{@home}"
+      end
+      # puts "Loading plugin #{name} from #{path}"
+      require path
+    end
+  end
+end

data/lib/inspec/plugins/cli.rb

@@ -1,24 +1,24 @@
-# encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-module Inspec
-  module Plugins
-    # stores all CLI plugin, we expect those to the `Thor` subclasses
-    class CLI
-      def self.subcommands
-        @subcommands ||= {}
-      end
-
-      def self.add_subcommand(klass, subcommand_name, usage, description, options = {})
-        subcommands[subcommand_name] = {
-          klass: klass,
-          subcommand_name: subcommand_name,
-          usage: usage,
-          description: description,
-          options: options,
-        }
-      end
-    end
-  end
-end
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+module Inspec
+  module Plugins
+    # stores all CLI plugin, we expect those to the `Thor` subclasses
+    class CLI
+      def self.subcommands
+        @subcommands ||= {}
+      end
+
+      def self.add_subcommand(klass, subcommand_name, usage, description, options = {})
+        subcommands[subcommand_name] = {
+          klass: klass,
+          subcommand_name: subcommand_name,
+          usage: usage,
+          description: description,
+          options: options,
+        }
+      end
+    end
+  end
+end

data/lib/inspec/plugins/fetcher.rb

@@ -1,86 +1,86 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-require 'utils/plugin_registry'
-require 'inspec/file_provider'
-
-module Inspec
-  module Plugins
-    #
-    # An Inspec::Plugins::Fetcher is responsible for fetching a remote
-    # source to a local directory or file provided by the user.
-    #
-    # In general, there are two kinds of fetchers.  (1) Fetchers that
-    # implement this entire API (see the Git or Url fetchers for
-    # examples), and (2) fetchers that only implement self.resolve and
-    # then call the resolve_next method with a modified target hash.
-    # Fetchers in (2) do not need to implement the functions in this
-    # class because the caller will never actually get an instance of
-    # those fetchers.
-    #
-    class Fetcher < PluginRegistry::Plugin
-      def self.plugin_registry
-        Inspec::Fetcher
-      end
-
-      attr_accessor :target
-
-      def writable?
-        false
-      end
-
-      #
-      # The path to the archive on disk.  This can be passed to a
-      # FileProvider to get access to the files in the fetched
-      # profile.
-      #
-      def archive_path
-        raise "Fetcher #{self} does not implement `archive_path()`. This is required."
-      end
-
-      #
-      # Fetches the remote source to a local source, using the
-      # provided path as a partial filename. That is, if you pass
-      # /foo/bar/baz, the fetcher can create:
-      #
-      # /foo/bar/baz/: A profile directory, or
-      # /foo/bar/baz.tar.gz: A profile tarball, or
-      # /foo/bar/baz.zip
-      #
-      def fetch(_path)
-        raise "Fetcher #{self} does not implement `fetch()`. This is required."
-      end
-
-      #
-      # The full specification of the remote source, with any
-      # ambigious references provided by the user resolved to an exact
-      # reference where possible.  For example, in the Git provide, a
-      # tag will be resolved to an exact revision.
-      #
-      def resolved_source
-        raise "Fetcher #{self} does not implement `resolved_source()`. This is required for terminal fetchers."
-      end
-
-      #
-      # The unique key based on the content of the remote archive.
-      #
-      def cache_key
-        raise "Fetcher #{self} does not implement `cache_key()`. This is required for terminal fetchers."
-      end
-
-      #
-      # relative_target is provided to keep compatibility with 3rd
-      # party plugins.
-      #
-      # Deprecated: This function may be removed in future versions of
-      # Inspec, don't depend on it in new plugins.
-      #
-      # @returns [Inspec::RelativeFileProvider]
-      #
-      def relative_target
-        file_provider = Inspec::FileProvider.for_path(archive_path)
-        file_provider.relative_provider
-      end
-    end
-  end
-end
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+require 'utils/plugin_registry'
+require 'inspec/file_provider'
+
+module Inspec
+  module Plugins
+    #
+    # An Inspec::Plugins::Fetcher is responsible for fetching a remote
+    # source to a local directory or file provided by the user.
+    #
+    # In general, there are two kinds of fetchers.  (1) Fetchers that
+    # implement this entire API (see the Git or Url fetchers for
+    # examples), and (2) fetchers that only implement self.resolve and
+    # then call the resolve_next method with a modified target hash.
+    # Fetchers in (2) do not need to implement the functions in this
+    # class because the caller will never actually get an instance of
+    # those fetchers.
+    #
+    class Fetcher < PluginRegistry::Plugin
+      def self.plugin_registry
+        Inspec::Fetcher
+      end
+
+      attr_accessor :target
+
+      def writable?
+        false
+      end
+
+      #
+      # The path to the archive on disk.  This can be passed to a
+      # FileProvider to get access to the files in the fetched
+      # profile.
+      #
+      def archive_path
+        raise "Fetcher #{self} does not implement `archive_path()`. This is required."
+      end
+
+      #
+      # Fetches the remote source to a local source, using the
+      # provided path as a partial filename. That is, if you pass
+      # /foo/bar/baz, the fetcher can create:
+      #
+      # /foo/bar/baz/: A profile directory, or
+      # /foo/bar/baz.tar.gz: A profile tarball, or
+      # /foo/bar/baz.zip
+      #
+      def fetch(_path)
+        raise "Fetcher #{self} does not implement `fetch()`. This is required."
+      end
+
+      #
+      # The full specification of the remote source, with any
+      # ambigious references provided by the user resolved to an exact
+      # reference where possible.  For example, in the Git provide, a
+      # tag will be resolved to an exact revision.
+      #
+      def resolved_source
+        raise "Fetcher #{self} does not implement `resolved_source()`. This is required for terminal fetchers."
+      end
+
+      #
+      # The unique key based on the content of the remote archive.
+      #
+      def cache_key
+        raise "Fetcher #{self} does not implement `cache_key()`. This is required for terminal fetchers."
+      end
+
+      #
+      # relative_target is provided to keep compatibility with 3rd
+      # party plugins.
+      #
+      # Deprecated: This function may be removed in future versions of
+      # Inspec, don't depend on it in new plugins.
+      #
+      # @returns [Inspec::RelativeFileProvider]
+      #
+      def relative_target
+        file_provider = Inspec::FileProvider.for_path(archive_path)
+        file_provider.relative_provider
+      end
+    end
+  end
+end

data/lib/inspec/plugins/resource.rb

@@ -1,132 +1,132 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-module Inspec
-  module ResourceBehaviors
-    def to_s
-      @__resource_name__
-    end
-
-    # Overwrite inspect to provide better output to RSpec results.
-    #
-    # @return [String] full name of the resource
-    def inspect
-      to_s
-    end
-  end
-
-  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
-
-    def __resource_registry
-      Inspec::Resource.registry
-    end
-
-    def __register(name, obj) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      cl = Class.new(obj) do # rubocop:disable Metrics/BlockLength
-        attr_reader :resource_exception_message
-
-        def initialize(backend, name, *args)
-          @resource_skipped = false
-          @resource_failed = false
-          @supports = Inspec::Resource.supports[name]
-
-          # attach the backend to this instance
-          @__backend_runner__ = backend
-          @__resource_name__ = name
-
-          # check resource supports
-          check_supports unless @supports.nil?
-
-          # call the resource initializer
-          begin
-            super(*args)
-          rescue Inspec::Exceptions::ResourceSkipped => e
-            skip_resource(e.message)
-          rescue Inspec::Exceptions::ResourceFailed => e
-            fail_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
-
-        def check_supports
-          status = inspec.platform.supported?(@supports)
-          skip_msg = "Resource #{@__resource_name__.capitalize} is not supported on platform #{inspec.platform.name}/#{inspec.platform.release}."
-          skip_resource(skip_msg) unless status
-        end
-
-        def skip_resource(message)
-          @resource_skipped = true
-          @resource_exception_message = message
-        end
-
-        def resource_skipped?
-          @resource_skipped
-        end
-
-        def resource_skipped
-          warn('[DEPRECATION] Use `resource_exception_message` for the resource skipped message. This method will be removed in InSpec 2.0.')
-          # Returning `nil` here to match previous behavior
-          return nil if @resource_skipped == false
-          @resource_exception_message
-        end
-
-        def fail_resource(message)
-          @resource_failed = true
-          @resource_exception_message = message
-        end
-
-        def resource_failed?
-          @resource_failed
-        end
-
-        def inspec
-          @__backend_runner__
-        end
-      end
-
-      # rubocop:enable Lint/NestedMethodDefinition
-      if __resource_registry.key?(name)
-        Inspec::Log.warn("Overwriting resource #{name}. To reference a specific version of #{name} use the resource() method")
-      end
-      __resource_registry[name] = cl
-    end
-  end
-
-  module Plugins
-    class Resource
-      extend Inspec::ResourceDSL
-      include Inspec::ResourceBehaviors
-    end
-  end
-end
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+module Inspec
+  module ResourceBehaviors
+    def to_s
+      @__resource_name__
+    end
+
+    # Overwrite inspect to provide better output to RSpec results.
+    #
+    # @return [String] full name of the resource
+    def inspect
+      to_s
+    end
+  end
+
+  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
+
+    def __resource_registry
+      Inspec::Resource.registry
+    end
+
+    def __register(name, obj) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      cl = Class.new(obj) do # rubocop:disable Metrics/BlockLength
+        attr_reader :resource_exception_message
+
+        def initialize(backend, name, *args)
+          @resource_skipped = false
+          @resource_failed = false
+          @supports = Inspec::Resource.supports[name]
+
+          # attach the backend to this instance
+          @__backend_runner__ = backend
+          @__resource_name__ = name
+
+          # check resource supports
+          check_supports unless @supports.nil?
+
+          # call the resource initializer
+          begin
+            super(*args)
+          rescue Inspec::Exceptions::ResourceSkipped => e
+            skip_resource(e.message)
+          rescue Inspec::Exceptions::ResourceFailed => e
+            fail_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
+
+        def check_supports
+          status = inspec.platform.supported?(@supports)
+          skip_msg = "Resource #{@__resource_name__.capitalize} is not supported on platform #{inspec.platform.name}/#{inspec.platform.release}."
+          skip_resource(skip_msg) unless status
+        end
+
+        def skip_resource(message)
+          @resource_skipped = true
+          @resource_exception_message = message
+        end
+
+        def resource_skipped?
+          @resource_skipped
+        end
+
+        def resource_skipped
+          warn('[DEPRECATION] Use `resource_exception_message` for the resource skipped message. This method will be removed in InSpec 2.0.')
+          # Returning `nil` here to match previous behavior
+          return nil if @resource_skipped == false
+          @resource_exception_message
+        end
+
+        def fail_resource(message)
+          @resource_failed = true
+          @resource_exception_message = message
+        end
+
+        def resource_failed?
+          @resource_failed
+        end
+
+        def inspec
+          @__backend_runner__
+        end
+      end
+
+      # rubocop:enable Lint/NestedMethodDefinition
+      if __resource_registry.key?(name)
+        Inspec::Log.warn("Overwriting resource #{name}. To reference a specific version of #{name} use the resource() method")
+      end
+      __resource_registry[name] = cl
+    end
+  end
+
+  module Plugins
+    class Resource
+      extend Inspec::ResourceDSL
+      include Inspec::ResourceBehaviors
+    end
+  end
+end