inspec 4.3.2 → 4.6.3

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

@@ -1,7 +1,3 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
 class PluginRegistry
   attr_reader :registry
 

data/lib/inspec/plugin/v2.rb

@@ -1,4 +1,4 @@
-require 'inspec/errors'
+require "inspec/errors"
 
 module Inspec
   module Plugin
@@ -23,20 +23,20 @@ module Inspec
   end
 end
 
-require 'inspec/globals'
-require 'inspec/plugin/v2/config_file'
-require 'inspec/plugin/v2/registry'
-require 'inspec/plugin/v2/loader'
-require 'inspec/plugin/v2/plugin_base'
+require "inspec/globals"
+require "inspec/plugin/v2/config_file"
+require "inspec/plugin/v2/registry"
+require "inspec/plugin/v2/loader"
+require "inspec/plugin/v2/plugin_base"
 
 # Load all plugin type base classes
-Dir.glob(File.join(__dir__, 'v2', 'plugin_types', '*.rb')).each { |file| require file }
+Dir.glob(File.join(__dir__, "v2", "plugin_types", "*.rb")).each { |file| require file }
 
 module Inspec
   # Provides the base class that plugin implementors should use.
   def self.plugin(version, plugin_type = nil)
     unless version == 2
-      raise 'Only plugins version 2 is supported!'
+      raise "Only plugins version 2 is supported!"
     end
 
     return Inspec::Plugin::V2::PluginBase if plugin_type.nil?

data/lib/inspec/plugin/v2/activator.rb

@@ -6,7 +6,7 @@ module Inspec::Plugin::V2
     :activated?,
     :exception,
     :activation_proc,
-    :implementation_class,
+    :implementation_class
   ) do
     def initialize(*)
       super

data/lib/inspec/plugin/v2/config_file.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Inspec::Plugin::V2
   # Represents the plugin config file on disk.
@@ -17,7 +17,7 @@ module Inspec::Plugin::V2
     # Returns the defaut path for a config file.
     # This respects ENV['INSPEC_CONFIG_DIR'].
     def self.default_path
-      File.join(Inspec.config_dir, 'plugins.json')
+      File.join(Inspec.config_dir, "plugins.json")
     end
 
     # Implement Enumerable. All Enumerable methds act
@@ -40,7 +40,7 @@ module Inspec::Plugin::V2
     # Add an entry with full validation.
     def add_entry(proposed_entry)
       unless proposed_entry.keys.all? { |field| field.is_a? Symbol }
-        raise Inspec::Plugin::V2::ConfigError, 'All keys to ConfigFile#add_entry must be symbols'
+        raise Inspec::Plugin::V2::ConfigError, "All keys to ConfigFile#add_entry must be symbols"
       end
 
       validate_entry(proposed_entry)
@@ -71,7 +71,7 @@ module Inspec::Plugin::V2
 
     def blank_structure
       {
-        plugins_config_version: '1.0.0',
+        plugins_config_version: "1.0.0",
         plugins: [],
       }
     end
@@ -88,7 +88,7 @@ module Inspec::Plugin::V2
         raise Inspec::Plugin::V2::ConfigError, "Missing 'plugins_config_version' entry at #{path} - currently support versions: 1.0.0"
       end
 
-      unless @data[:plugins_config_version] == '1.0.0'
+      unless @data[:plugins_config_version] == "1.0.0"
         raise Inspec::Plugin::V2::ConfigError, "Unsupported plugins.json file version #{@data[:plugins_config_version]} at #{path} - currently support versions: 1.0.0"
       end
 
@@ -106,7 +106,7 @@ module Inspec::Plugin::V2
           validate_entry(plugin_entry)
         rescue Inspec::Plugin::V2::ConfigError => ex
           # append some context to the message
-          raise Inspec::Plugin::V2::ConfigError, 'Malformed plugins.json file - ' + ex.message + " at index #{idx}"
+          raise Inspec::Plugin::V2::ConfigError, "Malformed plugins.json file - " + ex.message + " at index #{idx}"
         end
 
         # Check for duplicates

data/lib/inspec/plugin/v2/filter.rb

@@ -1,6 +1,6 @@
-require 'singleton'
-require 'json'
-require 'inspec/globals'
+require "singleton"
+require "json"
+require "inspec/globals"
 
 module Inspec::Plugin::V2
   Exclusion = Struct.new(:plugin_name, :rationale)
@@ -27,33 +27,33 @@ module Inspec::Plugin::V2
     private
 
     def read_filter_data
-      path = File.join(Inspec.src_root, 'etc', 'plugin_filters.json')
+      path = File.join(Inspec.src_root, "etc", "plugin_filters.json")
       @filter_data = JSON.parse(File.read(path))
 
-      unless @filter_data['file_version'] == '1.0.0'
+      unless @filter_data["file_version"] == "1.0.0"
         raise Inspec::Plugin::V2::ConfigError, "Unknown plugin fillter file format at #{path}"
       end
 
-      validate_plugin_filter_file('1.0.0')
+      validate_plugin_filter_file("1.0.0")
 
-      @filter_data[:exclude] = @filter_data['exclude'].map do |entry|
-        Exclusion.new(entry['plugin_name'], entry['rationale'])
+      @filter_data[:exclude] = @filter_data["exclude"].map do |entry|
+        Exclusion.new(entry["plugin_name"], entry["rationale"])
       end
-      @filter_data.delete('exclude')
+      @filter_data.delete("exclude")
     end
 
     def validate_plugin_filter_file(_file_version)
-      unless @filter_data.key?('exclude') && @filter_data['exclude'].is_a?(Array)
+      unless @filter_data.key?("exclude") && @filter_data["exclude"].is_a?(Array)
         raise Inspec::Plugin::V2::ConfigError, 'Unknown plugin fillter file format: expected "exclude" to be an array'
       end
-      @filter_data['exclude'].each_with_index do |entry, idx|
+      @filter_data["exclude"].each_with_index do |entry, idx|
         unless entry.is_a? Hash
           raise Inspec::Plugin::V2::ConfigError, "Unknown plugin fillter file format: expected entry #{idx} to be a Hash / JS Object"
         end
-        unless entry.key?('plugin_name')
+        unless entry.key?("plugin_name")
           raise Inspec::Plugin::V2::ConfigError, "Unknown plugin fillter file format: expected entry #{idx} to have a \"plugin_name\" field"
         end
-        unless entry.key?('rationale')
+        unless entry.key?("rationale")
           raise Inspec::Plugin::V2::ConfigError, "Unknown plugin fillter file format: expected entry #{idx} to have a \"rationale\" field"
         end
       end

data/lib/inspec/plugin/v2/installer.rb

@@ -1,16 +1,16 @@
 # This file is not required by default.
 
-require 'singleton'
-require 'forwardable'
-require 'fileutils'
+require "singleton"
+require "forwardable"
+require "fileutils"
 
 # Gem extensions for doing unusual things - not loaded by Gem default
-require 'rubygems/package'
-require 'rubygems/name_tuple'
-require 'rubygems/uninstaller'
-require 'rubygems/remote_fetcher'
+require "rubygems/package"
+require "rubygems/name_tuple"
+require "rubygems/uninstaller"
+require "rubygems/remote_fetcher"
 
-require 'inspec/plugin/v2/filter'
+require "inspec/plugin/v2/filter"
 
 module Inspec::Plugin::V2
   # Handles all actions modifying the user's plugin set:
@@ -23,7 +23,7 @@ module Inspec::Plugin::V2
     include Singleton
     extend Forwardable
 
-    Gem.configuration['verbose'] = false
+    Gem.configuration["verbose"] = false
 
     attr_reader :conf_file, :loader, :registry
     def_delegator :loader, :plugin_gem_path, :gem_path
@@ -60,6 +60,8 @@ module Inspec::Plugin::V2
       # TODO: - check plugins.json for validity before trying anything that needs to modify it.
       validate_installation_opts(plugin_name, opts)
 
+      # TODO: change all of these to return installed spec/gem/thingy
+      # TODO: return installed thingy
       if opts[:path]
         install_from_path(plugin_name, opts)
       elsif opts[:gem_file]
@@ -128,7 +130,7 @@ module Inspec::Plugin::V2
       if opts[:exact]
         matched_tuples = fetcher.detect(opts[:scope]) { |tuple| tuple.name == plugin_query }
       else
-        regex = Regexp.new('^' + plugin_query + '.*')
+        regex = Regexp.new("^" + plugin_query + ".*")
         matched_tuples = fetcher.detect(opts[:scope]) do |tuple|
           tuple.name =~ regex && !Inspec::Plugin::V2::PluginFilter.exclude?(tuple.name)
         end
@@ -172,15 +174,15 @@ module Inspec::Plugin::V2
       end
 
       if opts.key?(:gem_file) && opts.key?(:path)
-        raise InstallError, 'May not specify both gem_file and a path (for installing from source)'
+        raise InstallError, "May not specify both gem_file and a path (for installing from source)"
       end
 
       if opts.key?(:version) && (opts.key?(:gem_file) || opts.key?(:path))
-        raise InstallError, 'May not specify a version when installing from a gem file or source path'
+        raise InstallError, "May not specify a version when installing from a gem file or source path"
       end
 
       if opts.key?(:gem_file)
-        unless opts[:gem_file].end_with?('.gem')
+        unless opts[:gem_file].end_with?(".gem")
           raise InstallError, "When installing from a local gem file, gem file must have '.gem' extension - saw #{opts[:gem_file]}"
         end
         unless File.exist?(opts[:gem_file])
@@ -248,7 +250,7 @@ module Inspec::Plugin::V2
 
       opts[:scope] ||= :released
       unless [:prerelease, :released, :latest].include?(opts[:scope])
-        raise SearchError, 'Search scope for listing versons must be :prerelease, :released, or :latest.'
+        raise SearchError, "Search scope for listing versons must be :prerelease, :released, or :latest."
       end
     end
 
@@ -264,26 +266,33 @@ module Inspec::Plugin::V2
       # Make Set that encompasses just the gemfile that was provided
       plugin_local_source = Gem::Source::SpecificFile.new(opts[:gem_file])
 
-      plugin_dependency = Gem::Dependency.new(requested_plugin_name, plugin_local_source.spec.version)
-      requested_local_gem_set = Gem::Resolver::InstallerSet.new(:both) # :both means local and remote; allow satisfying our gemfile's deps from rubygems.org
-      requested_local_gem_set.add_local(plugin_dependency.name, plugin_local_source.spec, plugin_local_source)
+      plugin_dependency = Gem::Dependency.new(requested_plugin_name,
+                                              plugin_local_source.spec.version)
+
+      requested_local_gem_set = Gem::Resolver::InstallerSet.new(:both)
+      requested_local_gem_set.add_local(plugin_dependency.name,
+                                        plugin_local_source.spec, plugin_local_source)
 
       install_gem_to_plugins_dir(plugin_dependency, [requested_local_gem_set])
     end
 
     def install_from_remote_gems(requested_plugin_name, opts)
-      plugin_dependency = Gem::Dependency.new(requested_plugin_name, opts[:version] || '> 0')
+      plugin_dependency = Gem::Dependency.new(requested_plugin_name, opts[:version] || "> 0")
       # BestSet is rubygems.org API + indexing
       install_gem_to_plugins_dir(plugin_dependency, [Gem::Resolver::BestSet.new], opts[:update_mode])
     end
 
-    def install_gem_to_plugins_dir(new_plugin_dependency, extra_request_sets = [], update_mode = false) # rubocop: disable Metrics/AbcSize
+    def install_gem_to_plugins_dir(new_plugin_dependency, # rubocop: disable Metrics/AbcSize
+                                   extra_request_sets = [],
+                                   update_mode = false)
+
       # Get a list of all the gems available to us.
       gem_to_force_update = update_mode ? new_plugin_dependency.name : nil
       set_available_for_resolution = build_gem_request_universe(extra_request_sets, gem_to_force_update)
 
       # Solve the dependency (that is, find a way to install the new plugin and anything it needs)
       request_set = Gem::RequestSet.new(new_plugin_dependency)
+
       begin
         solution = request_set.resolve(set_available_for_resolution)
       rescue Gem::UnsatisfiableDependencyError => gem_ex
@@ -325,6 +334,7 @@ module Inspec::Plugin::V2
       # not obliged to during packaging.)
       # So, after each install, run a scan for all gem(specs) we manage, and copy in their gemspec file
       # into the exploded gem source area if absent.
+
       loader.list_managed_gems.each do |spec|
         path_inside_source = File.join(spec.gem_dir, "#{spec.name}.gemspec")
         unless File.exist?(path_inside_source)
@@ -357,7 +367,7 @@ module Inspec::Plugin::V2
         status.installation_type == :gem && status.name != plugin_name_to_be_removed.to_sym
       end
       plugin_deps_we_still_must_satisfy = plugin_deps_we_still_must_satisfy.map do |status|
-        constraint = status.version || '> 0'
+        constraint = status.version || "> 0"
         Gem::Dependency.new(status.name.to_s, constraint)
       end
 
@@ -385,7 +395,7 @@ module Inspec::Plugin::V2
           all: true,
           executables: true,
           force: true,
-          ignore: true,
+          ignore: true
         ).uninstall_gem(cruft_spec)
       end
     end
@@ -394,12 +404,12 @@ module Inspec::Plugin::V2
     #                        Utilities
     #===================================================================#
 
-    # This class alows us to build a Resolver set with the gems that are
+    # This class allows us to build a Resolver set with the gems that are
     # already included either with Ruby or with the InSpec install
     #
     # This code is heavily based on:
-    # https://github.com/hashicorp/vagrant/blob/master/lib/vagrant/bundler.rb#L400
-    # https://github.com/hashicorp/vagrant/blob/master/lib/vagrant/bundler.rb#L565
+    # https://github.com/hashicorp/vagrant/blob/32237377/lib/vagrant/bundler.rb#L400
+    # https://github.com/hashicorp/vagrant/blob/32237377/lib/vagrant/bundler.rb#L565
     class InstalledVendorSet < Gem::Resolver::Set
       def initialize
         super
@@ -479,6 +489,8 @@ module Inspec::Plugin::V2
       end
 
       conf_file.save
+
+      conf_file
     end
   end
 end

data/lib/inspec/plugin/v2/loader.rb

@@ -1,11 +1,11 @@
-require 'inspec/log'
-require 'inspec/plugin/v2/config_file'
+require "inspec/log"
+require "inspec/plugin/v2/config_file"
 
 # Add the current directory of the process to the load path
-$LOAD_PATH.unshift('.') unless $LOAD_PATH.include?('.')
+$LOAD_PATH.unshift(".") unless $LOAD_PATH.include?(".")
 # Add the InSpec source root directory to the load path
-folder = File.expand_path(File.join('..', '..', '..', '..'), __dir__)
-$LOAD_PATH.unshift(folder) unless $LOAD_PATH.include?('folder')
+folder = File.expand_path(File.join("..", "..", "..", ".."), __dir__)
+$LOAD_PATH.unshift(folder) unless $LOAD_PATH.include?("folder")
 
 module Inspec::Plugin::V2
   class Loader
@@ -51,7 +51,7 @@ module Inspec::Plugin::V2
             require plugin_details.entry_point
           else
             load_path = plugin_details.entry_point
-            load_path += '.rb' unless plugin_details.entry_point.end_with?('.rb')
+            load_path += ".rb" unless plugin_details.entry_point.end_with?(".rb")
             load load_path
           end
           plugin_details.loaded = true
@@ -67,16 +67,16 @@ module Inspec::Plugin::V2
     # This should possibly be in either lib/inspec/cli.rb or Registry
     def exit_on_load_error
       if registry.any_load_failures?
-        Inspec::Log.error 'Errors were encountered while loading plugins...'
+        Inspec::Log.error "Errors were encountered while loading plugins..."
         registry.plugin_statuses.select(&:load_exception).each do |plugin_status|
-          Inspec::Log.error 'Plugin name: ' + plugin_status.name.to_s
-          Inspec::Log.error 'Error: ' + plugin_status.load_exception.message
-          if ARGV.include?('--debug')
-            Inspec::Log.error 'Exception: ' + plugin_status.load_exception.class.name
-            Inspec::Log.error 'Trace: ' + plugin_status.load_exception.backtrace.join("\n")
+          Inspec::Log.error "Plugin name: " + plugin_status.name.to_s
+          Inspec::Log.error "Error: " + plugin_status.load_exception.message
+          if ARGV.include?("--debug")
+            Inspec::Log.error "Exception: " + plugin_status.load_exception.class.name
+            Inspec::Log.error "Trace: " + plugin_status.load_exception.backtrace.join("\n")
           end
         end
-        Inspec::Log.error('Run again with --debug for a stacktrace.') unless ARGV.include?('--debug')
+        Inspec::Log.error("Run again with --debug for a stacktrace.") unless ARGV.include?("--debug")
         exit 2
       end
     end
@@ -93,7 +93,7 @@ module Inspec::Plugin::V2
 
         # If the user invoked `inspec help`, `inspec --help`, or only `inspec`
         # then activate all CLI plugins so they can display their usage message.
-        activate_me ||= ['help', '--help', nil].include?(cli_args.first)
+        activate_me ||= ["help", "--help", nil].include?(cli_args.first)
 
         # If there is anything in the CLI args with the same name, activate it.
         # This is the expected usual activation for individual plugins.
@@ -113,16 +113,16 @@ module Inspec::Plugin::V2
     end
 
     def self.plugin_gem_path
-      # I can't believe there isn't a simpler way of getting this
-      # 2.4.2.p123 => 2.4.0
-      ruby_abi_version = (Gem.ruby_version.segments[0, 2] << 0).join('.')
-      File.join(Inspec.config_dir, 'gems', ruby_abi_version)
+      require "rbconfig"
+      ruby_abi_version = RbConfig::CONFIG["ruby_version"]
+      # TODO: why are we installing under the api directory for plugins?
+      File.join(Inspec.config_dir, "gems", ruby_abi_version)
     end
 
     # Lists all gems found in the plugin_gem_path.
     # @return [Array[Gem::Specification]] Specs of all gems found.
     def self.list_managed_gems
-      Dir.glob(File.join(plugin_gem_path, 'specifications', '*.gemspec')).map { |p| Gem::Specification.load(p) }
+      Dir.glob(File.join(plugin_gem_path, "specifications", "*.gemspec")).map { |p| Gem::Specification.load(p) }
     end
 
     def list_managed_gems
@@ -145,7 +145,7 @@ module Inspec::Plugin::V2
     # 'Activating' a gem adds it to the load path, so 'require "gemname"' will work.
     # Given a gem name, this activates the gem and all of its dependencies, respecting
     # version pinning needs.
-    def activate_managed_gems_for_plugin(plugin_gem_name, version_constraint = '> 0')
+    def activate_managed_gems_for_plugin(plugin_gem_name, version_constraint = "> 0")
       # TODO: enforce first-level version pinning
       plugin_deps = [Gem::Dependency.new(plugin_gem_name.to_s, version_constraint)]
       managed_gem_set = Gem::Resolver::VendorSet.new
@@ -197,18 +197,18 @@ module Inspec::Plugin::V2
       act.activator_name = :default
       status.activators = [act]
 
-      v0_subcommand_name = plugin_name.to_s.gsub('inspec-', '')
+      v0_subcommand_name = plugin_name.to_s.gsub("inspec-", "")
       status.plugin_class = Inspec::Plugins::CLI.subcommands[v0_subcommand_name][:klass]
     end
 
     def detect_bundled_plugins
-      bundle_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'bundles'))
+      bundle_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "bundles"))
       globs = [
-        File.join(bundle_dir, 'inspec-*.rb'),
-        File.join(bundle_dir, 'train-*.rb'),
+        File.join(bundle_dir, "inspec-*.rb"),
+        File.join(bundle_dir, "train-*.rb"),
       ]
       Dir.glob(globs).each do |loader_file|
-        name = File.basename(loader_file, '.rb').to_sym
+        name = File.basename(loader_file, ".rb").to_sym
         status = Inspec::Plugin::V2::Status.new
         status.name = name
         status.entry_point = loader_file
@@ -219,13 +219,13 @@ module Inspec::Plugin::V2
     end
 
     def detect_core_plugins
-      core_plugins_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'plugins'))
+      core_plugins_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "plugins"))
       # These are expected to be organized as proper separate projects,
       # with lib/ dirs, etc.
-      Dir.glob(File.join(core_plugins_dir, 'inspec-*')).each do |plugin_dir|
+      Dir.glob(File.join(core_plugins_dir, "inspec-*")).each do |plugin_dir|
         status = Inspec::Plugin::V2::Status.new
         status.name = File.basename(plugin_dir).to_sym
-        status.entry_point = File.join(plugin_dir, 'lib', status.name.to_s + '.rb')
+        status.entry_point = File.join(plugin_dir, "lib", status.name.to_s + ".rb")
         status.installation_type = :core
         status.loaded = false
         registry[status.name.to_sym] = status

data/lib/inspec/plugin/v2/plugin_base.rb

@@ -57,6 +57,13 @@ module Inspec::Plugin::V2
       @@plugin_type_classes[plugin_type_name]
     end
 
+    def self.find_name_by_implementation_class(impl_class)
+      # This is super awkward
+      activators = Inspec::Plugin::V2::Registry.instance.find_activators
+      activator = activators.detect { |a| a.implementation_class == impl_class }
+      activator.plugin_name
+    end
+
     #=====================================================================#
     #                           DSL Methods
     #=====================================================================#
@@ -71,7 +78,13 @@ module Inspec::Plugin::V2
     # @returns [Symbol] Name of the plugin
     def self.plugin_name(name = nil)
       reg = Inspec::Plugin::V2::Registry.instance
-      return reg.find_status_by_class(self).name if name.nil?
+      if name.nil?
+        # If called from a Plugin definition class...
+        stat = reg.find_status_by_class(self)
+        return stat.name if stat
+        # Called from an implementation class
+        return find_name_by_implementation_class(self)
+      end
 
       name = name.to_sym
 
@@ -83,7 +96,7 @@ module Inspec::Plugin::V2
         # Under some testing situations, we may not pre-exist.
         status = Inspec::Plugin::V2::Status.new
         reg.register(name, status)
-        status.entry_point = 'inline'
+        status.entry_point = "inline"
         status.installation_type = :mock_inline
       end