inspec 4.18.51 → 4.18.85

data/lib/inspec/objects/value.rb

@@ -1,32 +0,0 @@
-# This class is deprecated and will be removed in the next major release of InSpec.
-# Use the Inspec::Object classes from the inspec-objects rubygem instead.
-
-require "inspec/utils/deprecation"
-
-module Inspec
-  class Value
-    include ::Inspec::RubyHelper
-
-    attr_accessor :qualifier
-    attr_accessor :skip
-    attr_accessor :variable
-
-    def initialize(qualifiers = [])
-      @qualifier = qualifiers
-      @variable = nil
-
-      Inspec.deprecate(:object_classes, "The Inspec::Value class is deprecated. Use the Inspec::Object::Value class from the inspec-objects Ruby library.")
-    end
-
-    def to_ruby
-      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) }
-      cache.push(@variable)
-      @variable
-    end
-  end
-end

data/lib/inspec/plugin/v1.rb

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

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

@@ -1,22 +0,0 @@
-require "inspec/plugin/v1/registry"
-
-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/plugin/v1/plugin_types/fetcher.rb

@@ -1,83 +0,0 @@
-require "inspec/file_provider"
-require "inspec/plugin/v1/registry"
-
-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::Registry
-      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/plugin/v1/plugin_types/resource.rb

@@ -1,176 +0,0 @@
-require "inspec/exceptions"
-
-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 @name 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?
-
-      key = @name.to_sym
-
-      Inspec::Resource.supports[key] ||= []
-      Inspec::Resource.supports[key].push(criteria)
-    end
-
-    def example(example = nil)
-      return if example.nil?
-
-      __resource_registry[@name].example(example)
-    end
-
-    # Support for Resource DSL plugins.
-    # This is called when an unknown method is encountered
-    # within a resource class definition.
-    # 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"
-      # 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
-      if hook
-        # OK, load the hook if it hasn't been already.  We'll then know a module,
-        # which we can then inject into the resource
-        hook.activate
-        # Inject the module's methods into the resource as class methods.
-        # implementation_class is the field name, but this is actually a module.
-        extend(hook.implementation_class)
-        # Now that the module is loaded, it defined one or more methods
-        # (presumably the one we were looking for.)
-        # We still haven't called it, so do so now.
-        send(method_name, *arguments, &block)
-      else
-        # If we couldn't find a plugin to match, maybe something up above has it,
-        # or maybe it is just a unknown method error.
-        super
-      end
-    end
-
-    def __resource_registry
-      Inspec::Resource.registry
-    end
-
-    def __register(name, obj) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      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.to_sym]
-          @resource_exception_message = nil
-
-          # attach the backend to this instance
-          @__backend_runner__ = backend
-          @__resource_name__ = name
-
-          # check resource supports
-          supported = @supports ? check_supports : true # check_supports has side effects!
-          test_backend = defined?(Train::Transports::Mock::Connection) && backend.backend.class == Train::Transports::Mock::Connection
-          # raise unless we are supported or in test
-          unless supported || test_backend
-            msg = "Unsupported resource/backend combination: %s / %s. Exiting." %
-              [name, backend.platform.name]
-            raise ArgumentError, msg
-          end
-
-          # 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)
-          rescue NotImplementedError => e
-            fail_resource(e.message) unless @resource_failed
-          rescue NoMethodError => e
-            skip_resource(e.message) unless @resource_failed
-          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
-          require "inspec/resources/platform"
-          status = inspec.platform.supported?(@supports)
-          fail_msg = "Resource `#{@__resource_name__}` is not supported on platform #{inspec.platform.name}/#{inspec.platform.release}."
-          fail_resource(fail_msg) unless status
-          status
-        end
-
-        def skip_resource(message)
-          @resource_skipped = true
-          @resource_exception_message = message
-        end
-
-        def resource_skipped?
-          @resource_skipped
-        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
-
-      # 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_")
-        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 # TODO: possibly push up to inspec/resource.rb
-      extend Inspec::ResourceDSL
-      include Inspec::ResourceBehaviors
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-require "inspec/plugin/v1/registry"
-
-module Inspec
-  module Plugins
-    class Secret < PluginRegistry::Plugin
-      def self.plugin_registry
-        Inspec::SecretsBackend
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-require "inspec/plugin/v1/registry"
-
-module Inspec
-  module Plugins
-    class SourceReader < PluginRegistry::Plugin
-      def self.plugin_registry
-        Inspec::SourceReader
-      end
-
-      # Retrieve this profile's metadata.
-      #
-      # @return [Inspec::Metadata] profile metadata
-      def metadata
-        raise "SourceReader #{self} does not implement `metadata()`. This method is required"
-      end
-
-      # Retrieve this profile's tests
-      #
-      # "tests" here refers to a test file. Individual controls and anonymous
-      # tests are later extracted from the raw contents of a test file. The map
-      # her simply maps from a test file name to the file contents.
-      #
-      # @return [Hash] Collection with references pointing to test contents
-      def tests
-        raise "SourceReader #{self} does not implement `tests()`. This method is required"
-      end
-
-      # Retrieve this profile's libraries
-      #
-      # @return [Hash] Collection with references pointing to library contents
-      def libraries
-        raise "SourceReader #{self} does not implement `libraries()`. This method is required"
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-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"
-  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(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
-
-      # 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 do |x|
-        [File.basename(x, ".rb"), x]
-      end]
-    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/plugin/v1/registry.rb

@@ -1,90 +0,0 @@
-class PluginRegistry
-  attr_reader :registry
-
-  def initialize
-    @registry = {}
-  end
-
-  # Resolve a target via available plugins.
-  #
-  # @param [String] target to resolve
-  # @return [Plugin] plugin instance if it can be resolved, nil otherwise
-  def resolve(target)
-    modules.each do |m|
-      res = m.resolve(target)
-      return res unless res.nil?
-    end
-    nil
-  end
-
-  private
-
-  # Get all registered plugins sorted by priority, with highest first
-  #
-  # @return [Array[Plugin]] sorted list of plugins
-  def modules
-    @registry.values
-      .sort_by { |x| x.respond_to?(:priority) ? x.priority : 0 }
-      .reverse
-  end
-end
-
-class PluginRegistry
-  class Plugin
-    # Retrieve the plugin registry associated with this plugin
-    #
-    # @return [PluginRegistry] plugin registry for this plugin
-    def self.plugin_registry
-      raise "Plugin #{self} does not implement `self.plugin_registry()`. This method is required"
-    end
-
-    # Register a new plugin by name
-    #
-    # @param [String] the unique name of this plugin
-    # @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
-
-    # This plugin's priority. Set it by providing the priority as an
-    # argument. Higher numbers ensure that the plugin is
-    # called early to check if a target belongs to it. When called without
-    # an argument, it retrieves this plugin's priority. Defaults to 0.
-    #
-    # @param [Numeric] Priority as a number. Will only be set if != nil
-    # @return [Numeric] This plugin's priority
-    def self.priority(x = nil)
-      @priority = x unless x.nil?
-      @priority || 0
-    end
-
-    # Try to resolve the target. If this plugin cannot handle it, the result
-    # will be nil. If, however, the plugin can resolve it, the resulting
-    # object will be an instance of this plugin. This means, that the interface
-    # that this base class provides, is the basis for the returned type.
-    #
-    # @param [String] target to try to resolve
-    # @return [Plugin] instance if it can be resolved, nil otherwise
-    def self.resolve(_target)
-      raise "Plugin #{self} does not implement `self.resolve(target)`. This method is required"
-    end
-
-    # When a plugin's resolve doesn't lead to the final state, it can
-    # use this method to hand it back for another resolver to handle.
-    #
-    # @param [Any] the current target that needs resolving
-    # @param [Plugin] an instance of the calling resolver
-    # @return [Plugin] instance if it can be resolved, nil otherwise
-    def self.resolve_next(target, parent)
-      res = plugin_registry.resolve(target)
-      res.parent = parent
-      res
-    end
-
-    attr_reader :target
-    attr_accessor :parent
-  end
-end