inspec 4.18.51 → 4.18.85

data/lib/plugins/inspec-init/templates/plugins/inspec-plugin-template/test/unit/plugin_def_test.rb

@@ -1,51 +0,0 @@
-# This unit test performs some tests to verify that
-# the inspec-resource-lister plugin is configured correctly.
-
-# Include our test harness
-require_relative '../helper'
-
-# Load the class under test, the Plugin definition.
-require '<%= plugin_name %>/plugin'
-
-# Because InSpec is a Spec-style test suite, we're going to use Minitest::Spec
-# here, for familiar look and feel. However, this isn't InSpec (or RSpec) code.
-
-describe InspecPlugins::<%= module_name %>::Plugin do
-
-  # When writing tests, you can use `let` to create variables that you
-  # can reference easily.
-
-  # Internally, plugins are always known by a Symbol name. Convert here.
-  let(:plugin_name) { :'<%= plugin_name %>' }
-
-  # The Registry knows about all plugins that ship with InSpec by
-  # default, as well as any that are installed by the user. When a
-  # plugin definition is loaded, it will also self-register.
-  let(:registry) { Inspec::Plugin::V2::Registry.instance }
-
-  # The plugin status record tells us what the Registry knows.
-  # Note that you can use previously-defined 'let's.
-  let(:status) { registry[plugin_name] }
-
-  # OK, actual tests!
-
-  # Does the Registry know about us at all?
-  it "should be registered" do
-    registry.known_plugin?(plugin_name)
-  end
-
-  # Some tests through here use minitest Expectations, which attach to all
-  # Objects, and begin with 'must' (positive) or 'wont' (negative)
-  # See http://docs.seattlerb.org/minitest/Minitest/Expectations.html
-
-  # The plugin system had an undocumented v1 API; this should be a v2 example.
-  it "should be an api-v2 plugin" do
-    status.api_generation.must_equal(2)
-  end
-
-  # Plugins can support several different activator hooks, each of which has a type.
-  # Since this is (primarily) a CliCommand plugin, we'd expect to see that among our types.
-  it "should include a cli_command activator hook" do
-    status.plugin_types.must_include(:cli_command)
-  end
-end

data/lib/plugins/inspec-init/templates/profiles/os/README.md

@@ -1,3 +0,0 @@
-# Example InSpec Profile
-
-This example shows the implementation of an InSpec profile.

data/lib/plugins/inspec-init/templates/profiles/os/controls/example.rb

@@ -1,18 +0,0 @@
-# copyright: 2018, The Authors
-
-title "sample section"
-
-# you can also use plain tests
-describe file("/tmp") do
-  it { should be_directory }
-end
-
-# you add controls here
-control "tmp-1.0" do                        # A unique ID for this control
-  impact 0.7                                # The criticality, if this control fails.
-  title "Create /tmp directory"             # A human-readable title
-  desc "An optional description..."
-  describe file("/tmp") do                  # The actual test
-    it { should be_directory }
-  end
-end

data/lib/plugins/inspec-init/templates/profiles/os/inspec.yml

@@ -1,10 +0,0 @@
-name: <%= name %>
-title: InSpec Profile
-maintainer: The Authors
-copyright: The Authors
-copyright_email: you@example.com
-license: Apache-2.0
-summary: An InSpec Compliance Profile
-version: 0.1.0
-supports:
-  platform: os

data/lib/plugins/inspec-init/test/functional/inspec_init_plugin_test.rb

@@ -1,184 +0,0 @@
-require_relative "../../../shared/core_plugin_test_helper.rb"
-
-class InitPluginCli < Minitest::Test
-  include CorePluginFunctionalHelper
-
-  def test_generating_inspec_plugin_correct_prefix_required
-    Dir.mktmpdir do |dir|
-      plugin = "wacky-name"
-      run_result = run_inspec_process("init plugin --no-prompt #{plugin} ", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes run_result.stdout, "ERROR"
-      assert_includes run_result.stdout, "Plugin names must begin with"
-
-      assert_empty run_result.stderr
-
-      assert_exit_code 1, run_result
-    end
-  end
-
-  def test_generating_inspec_plugin_with_default_options
-    Dir.mktmpdir do |dir|
-      plugin = "inspec-test-generated-plugin"
-      snake_case = plugin.tr("-", "_")
-      module_name = plugin.sub(/^inspec\-/, "").split("-").map(&:capitalize).join("")
-
-      run_result = run_inspec_process("init plugin --no-prompt #{plugin}", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes run_result.stdout, "Creating new inspec plugin at"
-      assert_includes run_result.stdout, plugin
-
-      assert_empty run_result.stderr
-
-      assert_exit_code 0, run_result
-
-      # Check generated files and contents.
-      # Each file must exist, and its contents must match each of the regexen given.
-      {
-        File.join(plugin, "README.md") => [
-          /#{plugin}/,
-        ],
-        File.join(plugin, "LICENSE") => [
-          /(?!opyright)/, # No copyright by default
-          /Apache License/,
-        ],
-        File.join(plugin, "Gemfile") => [], # No interpolation
-        File.join(plugin, "Rakefile") => [], # No interpolation
-        File.join(plugin, plugin + ".gemspec") => [
-          %r{require '#{plugin}/version'},
-          /spec\.name\s+=\s+'#{plugin}'/,
-          /spec\.version\s+=\s+InspecPlugins::#{module_name}::VERSION/,
-          /README\.md\s+#{snake_case}\.gemspec\s+Gemfile/,
-          /spec\.authors\s+=\s+\['Your Name'\]/,
-          /spec\.email\s+=\s+\['you@example\.com'\]/,
-          /spec\.summary\s+=\s+'A plugin with a default summary'/,
-          /spec\.description\s+=\s+''/,
-          %r{spec\.homepage\s+=\s+'https://github.com/you/#{plugin}'},
-          /spec\.license\s+=\s+'Apache-2\.0'/,
-        ],
-        File.join(plugin, "lib", plugin + ".rb") => [
-          %r{require\s'#{plugin}/plugin'},
-        ],
-        File.join(plugin, "lib", plugin, "plugin.rb") => [
-          %r{require\s'#{plugin}/version'},
-          /\#\s#{plugin}\s=>\s#{module_name}/,
-          /module\s#{module_name}/,
-          /plugin_name\s+:'#{plugin}'/,
-          # Default assumes one cli hook
-          /cli_command :my_command/,
-          %r{require\s'#{plugin}/cli_command'},
-          /InspecPlugins::#{module_name}::CliCommand/,
-        ],
-        File.join(plugin, "lib", plugin, "version.rb") => [
-          /module\s#{module_name}/,
-        ],
-        File.join(plugin, "lib", plugin, "cli_command.rb") => [
-          /module\sInspecPlugins::#{module_name}/,
-          /\#\smakes\s`inspec\smy-command\s\.\.\.`\swork\./,
-          /subcommand_desc\s'my_command\s\[COMMAND\]'/,
-          /\#\sas\s`inspec\smy-command\sdo-something/,
-          /\#\sin\s`inspec\shelp\smy-command`/,
-          /\#\sruns\s`inspec\smy-command\sdo-something`./,
-          %r{Edit\slib/#{plugin}/cli_command\.rb\sto\smake\sit\sdo},
-        ],
-        File.join(plugin, "test", "helper.rb") => [], # No interpolation
-        File.join(plugin, "test", "functional", "README.md") => [], # No interpolation
-        File.join(plugin, "test", "functional", snake_case + "_test.rb") => [
-          # Whatever goes here
-        ],
-        File.join(plugin, "test", "unit", "plugin_def_test.rb") => [
-          %r{require\s'#{plugin}/plugin'},
-          /describe InspecPlugins::#{module_name}::Plugin\sdo/,
-          /let\(:plugin_name\) \{ \:'#{plugin}\' \}/,
-        ],
-        File.join(plugin, "test", "unit", "cli_args_test.rb") => [
-          %r{require '#{plugin}/cli_command'},
-          /describe InspecPlugins::#{module_name}::CliCommand do/,
-          /let\(\:cli_class\) \{ InspecPlugins::#{module_name}::CliCommand \}/,
-        ],
-        File.join(plugin, "test", "unit", "README.md") => [
-          /cli_args_test\.rb/,
-        ],
-      }.each do |path, regexen|
-        full_path = File.join(dir, path)
-        assert(File.exist?(full_path), "#{path} should have been generated")
-        next if regexen.empty?
-
-        contents = File.read(full_path)
-        regexen.each do |re|
-          assert_match re, contents, "#{path} should match #{re}"
-        end
-      end
-    end
-  end
-
-  def test_generating_inspec_plugin_with_custom_options
-    Dir.mktmpdir do |dir|
-      plugin = "inspec-test-generated-plugin"
-      snake_case = plugin.tr("-", "_")
-
-      opts = ""
-      opts += " --author-email bob@example.com "
-      opts += " --author-name Bob "
-      opts += ' --copyright "Copyright © 2018 Bob" '
-      opts += ' --description "That you will really like" '
-      opts += " --license-name BSD-3-Clause "
-      opts += ' --summary "A fantastic plugin" '
-
-      opts += " --homepage http://example.com "
-      opts += " --module_name FunPlugin"
-
-      run_result = run_inspec_process("init plugin #{plugin} --no-prompt #{opts}", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes run_result.stdout, "Creating new inspec plugin at"
-      assert_includes run_result.stdout, plugin
-
-      assert_empty run_result.stderr
-
-      assert_exit_code 0, run_result
-
-      # Check generated files and contents.
-      # Each file must exist, and its contents must match each of the regexen given.
-
-      {
-        File.join(plugin, "README.md") => [],
-        File.join(plugin, "LICENSE") => [
-          /Copyright . 2018 Bob/,
-          /used to endorse or promote/,
-        ],
-        File.join(plugin, "Gemfile") => [],
-        File.join(plugin, "Rakefile") => [],
-        File.join(plugin, plugin + ".gemspec") => [
-          /spec\.version\s+=\s+InspecPlugins::FunPlugin::VERSION/,
-          /spec\.authors\s+=\s+\['Bob'\]/,
-          /spec\.email\s+=\s+\['bob@example\.com'\]/,
-          /spec\.summary\s+=\s+'A fantastic plugin'/,
-          /spec\.description\s+=\s+'That you will really like'/,
-          %r{spec\.homepage\s+=\s+'http://example.com'},
-          /spec\.license\s+=\s+'BSD-3-Clause'/,
-        ],
-        File.join(plugin, "lib", plugin + ".rb") => [],
-        File.join(plugin, "lib", plugin, "plugin.rb") => [],
-        File.join(plugin, "lib", plugin, "version.rb") => [],
-        File.join(plugin, "lib", plugin, "cli_command.rb") => [],
-        File.join(plugin, "test", "helper.rb") => [],
-        File.join(plugin, "test", "functional", snake_case + "_test.rb") => [],
-        File.join(plugin, "test", "unit", "plugin_def_test.rb") => [],
-        File.join(plugin, "test", "unit", "cli_args_test.rb") => [],
-      }.each do |path, regexen|
-        full_path = File.join(dir, path)
-        assert(File.exist?(full_path), "#{path} should have been generated")
-        next if regexen.empty?
-
-        contents = File.read(full_path)
-        regexen.each do |re|
-          assert_match re, contents, "#{path} should match #{re}"
-        end
-      end
-    end
-  end
-
-end

data/lib/plugins/inspec-init/test/functional/inspec_init_profile_test.rb

@@ -1,121 +0,0 @@
-require "yaml"
-require_relative "../../../shared/core_plugin_test_helper.rb"
-
-class InitCli < Minitest::Test
-  include CorePluginFunctionalHelper
-
-  def test_generating_inspec_profile
-    Dir.mktmpdir do |dir|
-      profile = File.join(dir, "test-profile")
-      out = run_inspec_process("init profile test-profile", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes out.stdout, "Creating new profile at"
-      assert_includes out.stdout, profile
-      assert_includes Dir.entries(profile).join, "inspec.yml"
-      assert_includes Dir.entries(profile).join, "README.md"
-
-      assert_exit_code 0, out
-    end
-  end
-
-  def test_generating_inspec_profile_with_explicit_platform
-    Dir.mktmpdir do |dir|
-      profile = File.join(dir, "test-profile")
-      out = run_inspec_process("init profile --platform os test-profile", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes out.stdout, "Creating new profile at"
-      assert_includes out.stdout, profile
-      assert_includes Dir.entries(profile).join, "inspec.yml"
-      assert_includes Dir.entries(profile).join, "README.md"
-
-      assert_exit_code 0, out
-    end
-  end
-
-  def test_generating_inspec_profile_with_bad_platform
-    Dir.mktmpdir do |dir|
-      out = run_inspec_process("init profile --platform nonesuch test-profile", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes out.stdout, "Unable to generate profile"
-      assert_includes out.stdout, "No template available for platform 'nonesuch'"
-
-      assert_exit_code 1, out
-    end
-  end
-
-  def test_profile_with_slash_name
-    Dir.mktmpdir do |dir|
-      profile = dir + "/test/deeper/profile"
-      out = run_inspec_process("init profile test/deeper/profile", prefix: "cd #{dir} &&")
-      skip_windows!
-      assert_equal true, File.exist?(profile)
-      profile = YAML.load_file("#{profile}/inspec.yml")
-      assert_equal "profile", profile["name"]
-
-      assert_exit_code 0, out
-    end
-  end
-
-  def test_generating_inspec_profile_gcp
-    Dir.mktmpdir do |dir|
-      profile = File.join(dir, "test-gcp-profile")
-      out = run_inspec_process("init profile --platform gcp test-gcp-profile", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes out.stdout, "Creating new profile at"
-      assert_includes out.stdout, profile
-      assert_includes Dir.entries(profile).join, "inspec.yml"
-      assert_includes Dir.entries(profile).join, "README.md"
-
-      assert_exit_code 0, out
-    end
-  end
-
-  def test_generating_inspec_profile_aws
-    Dir.mktmpdir do |dir|
-      profile = File.join(dir, "test-aws-profile")
-      out = run_inspec_process("init profile --platform aws test-aws-profile", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes out.stdout, "Creating new profile at"
-      assert_includes out.stdout, profile
-      assert_includes Dir.entries(profile).join, "inspec.yml"
-      assert_includes Dir.entries(profile).join, "README.md"
-
-      assert_exit_code 0, out
-    end
-  end
-
-  def test_generating_inspec_profile_azure
-    Dir.mktmpdir do |dir|
-      profile = File.join(dir, "test-azure-profile")
-      out = run_inspec_process("init profile --platform azure test-azure-profile", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes out.stdout, "Creating new profile at"
-      assert_includes out.stdout, profile
-      assert_includes Dir.entries(profile).join, "inspec.yml"
-      assert_includes Dir.entries(profile).join, "README.md"
-
-      assert_exit_code 0, out
-    end
-  end
-
-  def test_generating_inspec_profile_os
-    Dir.mktmpdir do |dir|
-      profile = File.join(dir, "test-os-profile")
-      out = run_inspec_process("init profile --platform os test-os-profile", prefix: "cd #{dir} &&")
-
-      skip_windows!
-      assert_includes out.stdout, "Creating new profile at"
-      assert_includes out.stdout, profile
-      assert_includes Dir.entries(profile).join, "inspec.yml"
-      assert_includes Dir.entries(profile).join, "README.md"
-
-      assert_exit_code 0, out
-    end
-  end
-end

data/lib/plugins/inspec-plugin-manager-cli/README.md

@@ -1,6 +0,0 @@
-# InSpec Plugin Manager CLI
-
-This is a CLI plugin for InSpec.  It uses the Plugins API v2 to create a
-series of commands to manage plugins.
-
-It was the first plugin to be authored as a core plugin under Plugins v2.

data/lib/plugins/inspec-plugin-manager-cli/lib/inspec-plugin-manager-cli.rb

@@ -1,17 +0,0 @@
-# Because this is a core plugin, we place the plugin definition here in the entry point.
-# This is needed because under core testing, the entry point may be reloaded multiple times,
-# and we need plugin registration to properly occur each time.
-# More typically, the entry point would just load a plugin definition file.
-
-module InspecPlugins
-  module PluginManager
-    class Plugin < Inspec.plugin(2)
-      plugin_name :'inspec-plugin-manager-cli'
-
-      cli_command :plugin do
-        require_relative "inspec-plugin-manager-cli/cli_command"
-        InspecPlugins::PluginManager::CliCommand
-      end
-    end
-  end
-end

data/lib/plugins/inspec-plugin-manager-cli/lib/inspec-plugin-manager-cli/cli_command.rb

@@ -1,518 +0,0 @@
-require "pathname"
-require "inspec/plugin/v2"
-require "inspec/plugin/v2/installer"
-require "inspec/dist"
-
-module InspecPlugins
-  module PluginManager
-    class CliCommand < Inspec.plugin(2, :cli_command)
-      INSTALL_TYPE_LABELS = {
-        bundle: "core", # Calling this core, too - not much of a distinction
-        core: "core",
-        path: "path",
-        user_gem: "gem (user)",
-        system_gem: "gem (system)",
-      }.freeze
-
-      include Inspec::Dist
-
-      subcommand_desc "plugin SUBCOMMAND", "Manage #{PRODUCT_NAME} and Train plugins"
-
-      #==================================================================#
-      #                      inspec plugin list
-      #==================================================================#
-
-      desc "list [options]", "Lists user-installed #{PRODUCT_NAME} plugins."
-      option :all, desc: "List all types of plugins (default)", type: :boolean, default: true, aliases: [:a]
-      option :user, desc: "List user plugins, from ~/.inspec/gems", banner: "", type: :boolean, default: false, aliases: [:u]
-      option :system, desc: "List system plugins, those InSpec depends on", banner: "", type: :boolean, default: false, aliases: [:s]
-      option :core, desc: "List core plugins, those InSpec ships with", banner: "", type: :boolean, default: false, aliases: [:c]
-
-      def list
-        plugin_statuses = Inspec::Plugin::V2::Registry.instance.plugin_statuses
-        options[:all] = false if options[:core] || options[:user] || options[:system]
-        plugin_statuses.select! do |status|
-          type = status.installation_type
-          options[:all] ||
-            (options[:core] && %i{core bundle}.include?(type)) ||
-            (options[:user] && %i{user_gem path}.include?(type)) ||
-            (options[:system] && :system_gem == type)
-        end
-
-        unless plugin_statuses.empty?
-          ui.table do |t|
-            t.header = ["Plugin Name", "Version", "Via", "ApiVer"]
-            plugin_statuses.sort_by { |s| s.name.to_s }.each do |status|
-              t << [
-                status.name,
-                make_pretty_version(status),
-                make_pretty_install_type(status),
-                status.api_generation,
-              ]
-            end
-          end
-        end
-        ui.plain_line(" #{plugin_statuses.count} plugin(s) total")
-        puts
-      end
-
-      #==================================================================#
-      #                        inspec plugin search
-      #==================================================================#
-
-      desc "search [options] PATTERN", "Searches rubygems.org for plugins."
-      long_desc <<~EOLD
-        Searches rubygems.org for #{PRODUCT_NAME} plugins. Exits 0 on a search hit, 1 on user error,
-        2 on a search miss. PATTERN is a simple string; a wildcard will be added as
-        a suffix, unless -e is used.
-      EOLD
-      option :all, desc: "List all available versions, not just the latest one.", type: :boolean, aliases: [:a]
-      option :exact, desc: "Assume PATTERN is exact; do not add a wildcard to the end", type: :boolean, aliases: [:e]
-      option :'include-test-fixture', type: :boolean, desc: "Internal use", hide: true
-      # Justification for disabling ABC: currently at 33.51/33
-      def search(search_term) # rubocop: disable Metrics/AbcSize
-        search_results = installer.search(search_term, exact: options[:exact])
-        # The search results have already been filtered by the reject list.  But the
-        # RejectList doesn't filter {inspec, train}-test-fixture because we need those
-        # for testing.  We want to hide those from users, so unless we know we're in
-        # test mode, remove them.
-        unless options[:'include-test-fixture']
-          search_results.delete("inspec-test-fixture")
-          search_results.delete("train-test-fixture")
-        end
-
-        puts
-        ui.bold(format(" %-30s%-50s\n", "Plugin Name", "Versions Available"))
-        ui.line
-        search_results.keys.sort.each do |plugin_name|
-          versions = options[:all] ? search_results[plugin_name] : [search_results[plugin_name].first]
-          versions = "(" + versions.join(", ") + ")"
-          ui.plain_line(format(" %-30s%-50s", plugin_name, versions))
-        end
-        ui.line
-        ui.plain_line(" #{search_results.count} plugin(s) found")
-        puts
-
-        ui.exit Inspec::UI::EXIT_PLUGIN_ERROR if search_results.empty?
-      rescue Inspec::Plugin::V2::SearchError => ex
-        Inspec::Log.error ex.message
-        ui.exit Inspec::UI::EXIT_USAGE_ERROR
-      end
-
-      #==================================================================#
-      #                       inspec plugin install
-      #==================================================================#
-      desc "install [-v VERSION] PLUGIN", "Installs a plugin from rubygems.org, a gemfile, or a path to local source."
-      long_desc <<~EOLD
-        PLUGIN may be the name of a gem on rubygems.org that begins with inspec- or train-.
-        PLUGIN may also be the path to a local gemfile, which will then be installed like
-        any other gem.  Finally, if PLUGIN is a path ending in .rb, it is taken to be a
-        local file that will act as athe entry point for a plugin (this mode is provided
-        for local plugin development).  Exit codes are 0 on success, 2 if the plugin is
-        already installed, and 1 if any other error occurs.
-      EOLD
-      option :version, desc: "When installing from rubygems.org, specifies a specific version to install.", aliases: [:v]
-      def install(plugin_id_arg)
-        if plugin_id_arg =~ /\.gem$/ # Does it end in .gem?
-          install_from_gemfile(plugin_id_arg)
-        elsif plugin_id_arg =~ %r{[\/\\]} || Dir.exist?(plugin_id_arg) # Does the argument have a slash, or exist as dir in the local directory?
-          install_from_path(plugin_id_arg)
-        else
-          install_from_remote_gem(plugin_id_arg)
-        end
-      end
-
-      #--------------------------
-      #        update
-      #--------------------------
-      desc "update PLUGIN", "Updates a plugin to the latest from from rubygems.org"
-      long_desc <<~EOLD
-        PLUGIN may be the name of a gem on rubygems.org that begins with inspec- or train-.
-        Exit codes are 0 on success, 2 if the plugin is already up to date, and 1 if any
-        other error occurs.
-      EOLD
-      def update(plugin_name)
-        pre_update_versions = installer.list_installed_plugin_gems.select { |spec| spec.name == plugin_name }.map { |spec| spec.version.to_s }
-        old_version = pre_update_versions.join(", ")
-
-        update_preflight_check(plugin_name, pre_update_versions)
-
-        begin
-          installer.update(plugin_name)
-        rescue Inspec::Plugin::V2::UpdateError => ex
-          ui.plain_line("#{ui.red("Update error:", print: false)} #{ex.message} - update failed")
-          ui.exit Inspec::UI::EXIT_USAGE_ERROR
-        end
-        post_update_versions = installer.list_installed_plugin_gems.select { |spec| spec.name == plugin_name }.map { |spec| spec.version.to_s }
-        new_version = (post_update_versions - pre_update_versions).first
-
-        ui.bold(plugin_name + " plugin, version #{old_version} -> " \
-                "#{new_version}, updated from rubygems.org\n")
-      end
-
-      #--------------------------
-      #        uninstall
-      #--------------------------
-      desc "uninstall PLUGIN_NAME", "Uninstalls a gem- or path- based plugin"
-      long_desc <<~EOLD
-        Removes a plugin from the users configuration.
-          In the case of a gem plugin (by far the most common), the plugin gem is removed, along
-        with any of its dependencies that are no longer needed by anything else. Finally, the
-        plugin configuration file is updated to reflect that the plugin is no longer present.
-          In the case of a path-based plugin (often used for plugin development), no changes
-        are made to the referenced plugin source code. Rather, the plugin's entry is simply removed
-        from the plugin config file.
-      EOLD
-      def uninstall(plugin_name)
-        status = Inspec::Plugin::V2::Registry.instance[plugin_name.to_sym]
-        unless status
-          ui.plain_line("#{ui.red("No such plugin installed:", print: false)} #{plugin_name} is not " \
-                 "installed - uninstall failed")
-          ui.exit Inspec::UI::EXIT_USAGE_ERROR
-        end
-        installer = Inspec::Plugin::V2::Installer.instance
-
-        pre_uninstall_versions = installer.list_installed_plugin_gems.select { |spec| spec.name == plugin_name }.map { |spec| spec.version.to_s }
-        old_version = pre_uninstall_versions.join(", ")
-
-        installer.uninstall(plugin_name)
-
-        if status.installation_type == :path
-          ui.bold(plugin_name + " path-based plugin install has been " \
-                  "uninstalled\n")
-        else
-          ui.bold(plugin_name + " plugin, version #{old_version}, has " \
-                  "been uninstalled\n")
-        end
-
-        ui.exit Inspec::UI::EXIT_NORMAL
-      end
-
-      private
-
-      #==================================================================#
-      #                          install breakdown
-      #==================================================================#
-      # These are broken down because rubocop complained.
-
-      def install_from_gemfile(gem_file)
-        unless File.exist? gem_file
-          ui.red("No such plugin gem file #{gem_file} - installation failed.\n")
-          ui.exit Inspec::UI::EXIT_USAGE_ERROR
-        end
-
-        plugin_name_parts = File.basename(gem_file, ".gem").split("-")
-        version = plugin_name_parts.pop
-        plugin_name = plugin_name_parts.join("-")
-        check_plugin_name(plugin_name, "installation")
-
-        installer.install(plugin_name, gem_file: gem_file)
-
-        ui.bold("#{plugin_name} plugin, version #{version}, installed from " \
-                "local .gem file\n")
-        ui.exit Inspec::UI::EXIT_NORMAL
-      end
-
-      def install_from_path(path)
-        unless File.exist? path
-          ui.red("No such source code path #{path} - installation failed.\n")
-          ui.exit Inspec::UI::EXIT_USAGE_ERROR
-        end
-
-        plugin_name = File.basename(path, ".rb")
-
-        # While installer.install does some rudimentary checking,
-        # this file has good UI access, so we promise to validate the
-        # input a lot and hand the installer a sure-thing.
-
-        # Name OK?
-        check_plugin_name(plugin_name, "installation")
-
-        # Already installed?
-        if registry.known_plugin?(plugin_name.to_sym)
-          ui.red("Plugin already installed - #{plugin_name} - Use '#{EXEC_NAME} " \
-                 "plugin list' to see previously installed plugin - " \
-                 "installation failed.\n")
-          ui.exit Inspec::UI::EXIT_PLUGIN_ERROR
-        end
-
-        # Can we figure out how to load it?
-        entry_point = install_from_path__apply_entry_point_heuristics(path)
-
-        # If you load it, does it act like a plugin?
-        install_from_path__probe_load(entry_point, plugin_name)
-
-        # OK, install it!
-        installer.install(plugin_name, path: entry_point)
-
-        ui.bold("#{plugin_name} plugin installed via source path reference, " \
-                "resolved to entry point #{entry_point}\n")
-        ui.exit Inspec::UI::EXIT_NORMAL
-      end
-
-      # Rationale for rubocop variances: It's a heuristics method, and will be full of
-      # conditionals.  The code is well-commented; refactoring into sub-methods would
-      # reduce clarity.
-      def install_from_path__apply_entry_point_heuristics(path) # rubocop: disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        given = Pathname.new(path)
-        given = given.expand_path # Resolve any relative paths
-        name_regex = /^(inspec|train)-/
-        versioned_regex = /^(inspec|train)-[a-z0-9\-\_]+-\d+\.\d+\.\d+$/
-        sha_ref_regex = /^(inspec|train)-[a-z0-9\-\_]+-[0-9a-f]{5,40}$/
-
-        # What are the last four things like?
-        parts = [
-          given.parent.parent.basename,
-          given.parent.basename,
-          given.basename(".rb"),
-          given.extname,
-        ].map(&:to_s)
-
-        # Case 1: Simplest case: it was a full entry point, as presented.
-        # /home/you/projects/inspec-something/lib/inspec-something.rb
-        #   parts index:           ^0^        ^1^      ^2^        ^3^
-        if parts[0] =~ name_regex && parts[1] == "lib" && parts[2] == parts[0] && parts[3] == ".rb"
-          return given.to_s
-        end
-
-        # Case 2: Also easy: they either referred to the internal library directory,
-        # or left the extansion off.  Those are the same to us.
-        # /home/you/projects/inspec-something/lib/inspec-something
-        #   parts index:           ^0^        ^1^      ^2^          (3 is empty)
-        if parts[0] =~ name_regex && parts[1] == "lib" && parts[2] == parts[0] && parts[3].empty?
-          return given.to_s + ".rb"
-        end
-
-        # Case 3: Maybe they were refering to a path that is inside a gem installation, or an exploded gem?
-        # In that case, we'll have a version on the plugin name in part 0
-        # /home/you/.gems/2.4.0/gems/inspec-something-3.45.1/lib/inspec-something.rb
-        #   parts index:                     ^0^             ^1^      ^2^         ^3^
-        if (parts[0] =~ versioned_regex || parts[0] =~ sha_ref_regex) && parts[1] == "lib" && parts[0].start_with?(parts[2]) && parts[3] == ".rb"
-          return given.to_s
-        end
-
-        # Case 4: Like case 3, but missing the .rb
-        # /home/you/.gems/2.4.0/gems/inspec-something-3.45.1/lib/inspec-something
-        #   parts index:                     ^0^             ^1^      ^2^         ^3^ (empty)
-        if (parts[0] =~ versioned_regex || parts[0] =~ sha_ref_regex) && parts[1] == "lib" && parts[0].start_with?(parts[2]) && parts[3].empty?
-          return given.to_s + ".rb"
-        end
-
-        # Case 5: Easy to recognize, but harder to handle: they referred to the project root.
-        #                 /home/you/projects/inspec-something
-        #   parts index:        ^0^   ^1^         ^2^          (3 is empty)
-        #   0 and 1 are not meaningful to us, but we hope to find a parts[2]/lib/inspec-something.rb.
-        entry_point_guess = File.join(given.to_s, "lib", parts[2] + ".rb")
-        if parts[2] =~ name_regex && File.exist?(entry_point_guess)
-          return entry_point_guess
-        end
-
-        # Well, if we got here, parts[2] matches an inspec/train prefix, but we have no idea about anything.
-        # Give up.
-        ui.red("Unrecognizable plugin structure - #{parts[2]} - When " \
-               "installing from a path, please provide the path of the " \
-               "entry point file - installation failed.\n")
-        ui.exit Inspec::UI::EXIT_USAGE_ERROR
-      end
-
-      def install_from_path__probe_load(entry_point, plugin_name)
-        # Brazenly attempt to load a file, and see if it registers a plugin.
-        begin
-          require entry_point
-        rescue LoadError => ex
-          ui.red("Plugin contains errors - #{plugin_name} - Encountered " \
-                 "errors while trying to test load the plugin entry point, " \
-                 "resolved to #{entry_point} - installation failed\n")
-          ui.plain_line ex.message
-          ui.exit Inspec::UI::EXIT_USAGE_ERROR
-        end
-
-        # OK, the wheels didn't fall off.  But is it a plugin?
-        if plugin_name.to_s.start_with?("train")
-          # Train internal names do not include the prix in their registry entries
-          # And the registry is keyed on Strings
-          registry_key = plugin_name.to_s.sub(/^train-/, "")
-          unless Train::Plugins.registry.key?(registry_key)
-            ui.red("Does not appear to be a plugin - #{plugin_name} - After " \
-                   "probe-loading the supposed plugin, it did not register " \
-                   "itself to Train. Ensure something inherits from " \
-                   "'Train.plugin(1)' - installation failed.\n")
-            ui.exit Inspec::UI::EXIT_USAGE_ERROR
-          end
-        else
-          unless registry.known_plugin?(plugin_name.to_sym)
-            ui.red("Does not appear to be a plugin - #{plugin_name} - After " \
-                   "probe-loading the supposed plugin, it did not register " \
-                   "itself to InSpec. Ensure something inherits from " \
-                   "'Inspec.plugin(2)' - installation failed.\n")
-            ui.exit Inspec::UI::EXIT_USAGE_ERROR
-          end
-        end
-      end
-
-      def install_from_remote_gem(plugin_name)
-        requested_version = options[:version]
-
-        check_plugin_name(plugin_name, "installation")
-
-        # Version pre-flighting
-        pre_installed_versions = installer.list_installed_plugin_gems.select { |spec| spec.name == plugin_name }.map { |spec| spec.version.to_s }
-        install_from_remote_gem_verson_preflight_check(plugin_name, requested_version, pre_installed_versions)
-
-        install_attempt_install(plugin_name)
-
-        # Success messaging.  What did we actually install?
-        post_installed_versions = installer.list_installed_plugin_gems.select { |spec| spec.name == plugin_name }.map { |spec| spec.version.to_s }
-        new_version = (post_installed_versions - pre_installed_versions).first
-
-        ui.bold("#{plugin_name} plugin, version #{new_version}, installed " \
-                "from rubygems.org\n")
-        ui.exit Inspec::UI::EXIT_NORMAL
-      end
-
-      def install_from_remote_gem_verson_preflight_check(plugin_name, requested_version, pre_installed_versions)
-        return if pre_installed_versions.empty?
-
-        # Everything past here in the block is a code 2 error
-
-        # If they didn't ask for a specific version, they implicitly ask for the latest.
-        # Do an expensive search to determine the latest version.
-        unless requested_version
-          latest_version = installer.search(plugin_name, exact: true, scope: :latest)
-          latest_version = latest_version[plugin_name]&.last
-          if latest_version && !requested_version
-            requested_version = latest_version
-          end
-        end
-
-        # Check for already-installed at desired version conditions
-        they_explicitly_asked_for_a_version = !options[:version].nil?
-        what_we_would_install_is_already_installed = pre_installed_versions.include?(requested_version)
-        if what_we_would_install_is_already_installed && they_explicitly_asked_for_a_version
-          ui.red("Plugin already installed at requested version - plugin " \
-                 "#{plugin_name} #{requested_version} - refusing to install.\n")
-        elsif what_we_would_install_is_already_installed && !they_explicitly_asked_for_a_version
-          ui.red("Plugin already installed at latest version - plugin " \
-                 "#{plugin_name} #{requested_version} - refusing to install.\n")
-        else
-          # There are existing versions installed, but none of them are what was requested
-          ui.red("Update required - plugin #{plugin_name}, requested " \
-                 "#{requested_version}, have " \
-                 "#{pre_installed_versions.join(", ")}; use `inspec " \
-                 "plugin update` - refusing to install.\n")
-        end
-
-        ui.exit Inspec::UI::EXIT_PLUGIN_ERROR
-      end
-
-      # Rationale for RuboCop variance: This is a one-line method with heavy UX-focused error handling.
-      def install_attempt_install(plugin_name) # rubocop: disable Metrics/AbcSize
-        installer.install(plugin_name, version: options[:version])
-      rescue Inspec::Plugin::V2::PluginExcludedError => ex
-        ui.red("Plugin on Exclusion List - #{plugin_name} is listed as an " \
-               "incompatible gem - refusing to install.\n")
-        ui.plain_line("Rationale: #{ex.details.rationale}")
-        ui.plain_line("Exclusion list location: " +
-                 File.join(Inspec.src_root, "etc", "plugin_filters.json"))
-        ui.plain_line("If you disagree with this determination, please accept " \
-                 "our apologies for the misunderstanding, and open an issue " \
-                 "at https://github.com/inspec/inspec/issues/new")
-        ui.exit Inspec::UI::EXIT_PLUGIN_ERROR
-      rescue Inspec::Plugin::V2::InstallError
-        raise if Inspec::Log.level == :debug
-
-        results = installer.search(plugin_name, exact: true)
-        if results.empty?
-          ui.red("No such plugin gem #{plugin_name} could be found on " \
-                 "rubygems.org - installation failed.\n")
-        elsif options[:version] && !results[plugin_name].include?(options[:version])
-          ui.red("No such version - #{plugin_name} exists, but no such " \
-                 "version #{options[:version]} found on rubygems.org - " \
-                 "installation failed.\n")
-        else
-          ui.red("Unknown error occured - installation failed.\n")
-        end
-        ui.exit Inspec::UI::EXIT_USAGE_ERROR
-      end
-
-      #==================================================================#
-      #                          update breakdown
-      #==================================================================#
-      def update_preflight_check(plugin_name, pre_update_versions)
-        if pre_update_versions.empty?
-          # Check for path install
-          status = Inspec::Plugin::V2::Registry.instance[plugin_name.to_sym]
-          if !status
-            ui.plain_line("#{ui.red("No such plugin installed:", print: false)} #{plugin_name} - update failed")
-            ui.exit Inspec::UI::EXIT_USAGE_ERROR
-          elsif status.installation_type == :path
-            ui.plain_line("#{ui.red("Cannot update path-based install:", print: false)} " \
-                   "#{plugin_name} is installed via path reference; " \
-                   "use `inspec plugin uninstall` to remove - refusing to" \
-                   "update")
-            ui.exit Inspec::UI::EXIT_PLUGIN_ERROR
-          end
-        end
-
-        # Check for latest version (and implicitly, existance)
-        latest_version = installer.search(plugin_name, exact: true, scope: :latest)
-        latest_version = latest_version[plugin_name]&.last
-
-        if pre_update_versions.include?(latest_version)
-          ui.plain_line("#{ui.red("Already installed at latest version:", print: false)} " \
-                   "#{plugin_name} is at #{latest_version}, which the " \
-                   "latest - refusing to update")
-          ui.exit Inspec::UI::EXIT_PLUGIN_ERROR
-        end
-      end
-
-      #==================================================================#
-      #                            utilities
-      #==================================================================#
-      def installer
-        Inspec::Plugin::V2::Installer.instance
-      end
-
-      def registry
-        Inspec::Plugin::V2::Registry.instance
-      end
-
-      def check_plugin_name(plugin_name, action)
-        unless plugin_name =~ /^(inspec|train)-/
-          ui.red("Invalid plugin name - #{plugin_name} - All inspec " \
-                 "plugins must begin with either 'inspec-' or 'train-' " \
-                 "- #{action} failed.\n")
-          ui.exit Inspec::UI::EXIT_USAGE_ERROR
-        end
-      end
-
-      def make_pretty_version(status)
-        case status.installation_type
-        when :core, :bundle
-          Inspec::VERSION
-        when :user_gem, :system_gem
-          if status.version.nil?
-            "(unknown)"
-          elsif status.version =~ /^\d+\.\d+\.\d+$/
-            status.version
-          else
-            # Assume it is a version constraint string and try to resolve
-            # TODO: this is naive, and assumes the latest version is the one that will be used. Logged on #3317
-            # In fact, the logic to determine "what version would be used" belongs in the Loader.
-            plugin_name = status.name.to_s
-            Inspec::Plugin::V2::Loader.list_installed_plugin_gems
-              .select { |spec| spec.name == plugin_name }
-              .sort_by(&:version)
-              .last.version
-          end
-        when :path
-          "src"
-        end
-      end
-
-      def make_pretty_install_type(status)
-        INSTALL_TYPE_LABELS[status.installation_type]
-      end
-    end
-  end
-end