inspec 4.18.51 → 4.18.85

data/lib/plugins/inspec-plugin-manager-cli/test/unit/plugin_def_test.rb

@@ -1,39 +0,0 @@
-require_relative "../../../shared/core_plugin_test_helper.rb"
-
-#-----------------------------------------------------------------------#
-# Plugin Definition
-#-----------------------------------------------------------------------#
-class PluginManagerCliDefinitionTests < Minitest::Test
-  include CorePluginUnitHelper
-
-  @@orig_home = Dir.home
-
-  def setup
-    mock_path = File.expand_path "test/fixtures"
-
-    @config_dir_path = File.join(mock_path, "config_dirs")
-    ENV["HOME"] = File.join(@config_dir_path, "fakehome")
-  end
-
-  def teardown
-    reset_globals
-  end
-
-  def reset_globals # TODO: REFACTOR this with install/loader tests
-    ENV["HOME"] = @@orig_home
-    ENV["INSPEC_CONFIG_DIR"] = nil
-    Inspec::Plugin::V2::Registry.instance.__reset
-  end
-
-  def test_plugin_registered
-    loader = Inspec::Plugin::V2::Loader.new
-    loader.load_all # We want to ensure it is auto-loaded
-
-    assert registry.known_plugin?(:'inspec-plugin-manager-cli'), "inspec-plugin-manager-cli should be registered"
-    assert registry.loaded_plugin?(:'inspec-plugin-manager-cli'), "inspec-plugin-manager-cli should be loaded"
-
-    status = registry[:'inspec-plugin-manager-cli']
-    assert_equal 2, status.api_generation, "inspec-plugin-manager-cli should be v2"
-    assert_includes status.plugin_types, :cli_command, "inspec-plugin-manager-cli should have cli_command activators"
-  end
-end

data/lib/plugins/shared/core_plugin_test_helper.rb

@@ -1,153 +0,0 @@
-# Load test harness - Minitest
-require "minitest/autorun"
-require "minitest/pride"
-
-# Data formats commonly used in testing
-require "json"
-require "ostruct"
-
-# Utilities often needed
-require "fileutils"
-require "tmpdir"
-require "pathname"
-require "forwardable"
-
-require "functional/helper"
-require "inspec/plugin/v2"
-
-# Configure Minitest to expose things like `let`
-class Module
-  include Minitest::Spec::DSL # TODO: NO! remove this!
-end
-
-# module Inspec
-#   class FuncTestRunResult
-#     attr_reader :train_result
-#     attr_reader :payload
-#
-#     extend Forwardable
-#     def_delegator :train_result, :stdout
-#     def_delegator :train_result, :stderr
-#     def_delegator :train_result, :exit_status
-#
-#     def initialize(train_result)
-#       @train_result = train_result
-#       @payload = OpenStruct.new
-#     end
-#   end
-# end
-
-# TODO: remove me! There's no need!
-module CorePluginBaseHelper
-  let(:mock_path) { File.join(repo_path, "test", "fixtures", "mock") }
-  let(:core_fixture_plugins_path) { File.join(mock_path, "plugins") }
-  let(:core_config_dir_path) { File.join(mock_path, "config_dirs") }
-
-  let(:registry) { Inspec::Plugin::V2::Registry.instance }
-end
-
-module CorePluginFunctionalHelper
-  include CorePluginBaseHelper
-  include FunctionalHelper
-
-  # TODO: so much duplication! Remove everything we can!
-  require "train"
-  TRAIN_CONNECTION = Train.create("local", command_runner: :generic).connection
-
-  # TODO: remove me! it's in test/functional/helper.rb
-  def run_inspec_process(command_line, opts = {})
-    prefix = ""
-    if opts.key?(:prefix)
-      prefix = opts[:prefix]
-    elsif opts.key?(:env)
-      prefix = assemble_env_prefix opts[:env]
-    end
-
-    TRAIN_CONNECTION.run_command("#{prefix} #{exec_inspec} #{command_line}")
-  end
-
-  # This helper does some fancy footwork to make InSpec think a plugin
-  # under development is temporarily installed.
-  # @param String command_line Invocation, without the word 'inspec'
-  # @param Hash opts options as for run_inspec_process, with more options:
-  #    :pre_run: Proc(plugin_statefile_data, tmp_dir_path) - optional setup block.
-  #       Modify plugin_statefile_data as needed; it will be written to a plugins.json
-  #       in tmp_dir_path.  You may also copy in other things to the tmp_dir_path. Your PWD
-  #       will be in the tmp_dir, and it will exist and be empty.
-  #    :post_run: Proc(CommandResult, tmp_dir_path) - optional result capture block.
-  #       Your PWD will be the tmp_dir, and it will still exist (for a moment!)
-  def run_inspec_process_with_this_plugin(command_line, opts = {})
-    plugin_path = __find_plugin_path_from_caller
-
-    # If it looks like it is a core plugin under test, don't add it to the plugin file
-    # since the loader will auto-load it anyway
-    if plugin_path.include?("lib/plugins/inspec-")
-      plugin_file_data = __make_empty_plugin_file_data_structure
-    else
-      plugin_file_data = __make_plugin_file_data_structure_with_path(plugin_path)
-    end
-
-    Dir.mktmpdir do |tmp_dir|
-      opts[:pre_run]&.call(plugin_file_data, tmp_dir)
-      plugin_file_path = File.join(tmp_dir, "plugins.json")
-      # HACK: If the block cleared the hash, take that to mean it will provide a plugins.json file of its own.
-      File.write(plugin_file_path, JSON.generate(plugin_file_data)) unless plugin_file_data.empty?
-      opts[:env] ||= {}
-      opts[:env]["INSPEC_CONFIG_DIR"] = tmp_dir
-      run_result = run_inspec_process(command_line, opts)
-
-      # Read the resulting plugins.json into memory, if any
-      if File.exist?(plugin_file_path)
-        @plugin_data = JSON.parse(File.read(plugin_file_path))
-      end
-
-      opts[:post_run]&.call(run_result, tmp_dir)
-      run_result
-    end
-  end
-
-  def __find_plugin_path_from_caller(frames_back = 2)
-    caller_path = Pathname.new(caller_locations(frames_back, 1).first.absolute_path)
-    # Typical caller path:
-    # /Users/cwolfe/sandbox/inspec-resource-lister/test/functional/inspec_resource_lister_test.rb
-    # We want:
-    # /Users/cwolfe/sandbox/inspec-resource-lister/lib/inspec-resource-lister.rb
-    cursor = caller_path
-    until cursor.basename.to_s == "test" && cursor.parent.basename.to_s =~ /^(inspec|train)-/
-      cursor = cursor.parent
-      break if cursor.nil?
-    end
-    raise "Could not comprehend plugin project directory structure" if cursor.nil?
-
-    project_dir = cursor.parent
-    plugin_name = project_dir.basename
-    entry_point = File.join(project_dir.to_s, "lib", plugin_name.to_s + ".rb")
-    raise "Could not find plugin entry point" unless File.exist?(entry_point)
-
-    entry_point
-  end
-
-  def __make_plugin_file_data_structure_with_path(path)
-    # TODO: dry this up, refs #3350
-    plugin_name = File.basename(path, ".rb")
-    data = __make_empty_plugin_file_data_structure
-    data["plugins"] << {
-      "name" => plugin_name,
-      "installation_type" => "path",
-      "installation_path" => path,
-    }
-    data
-  end
-
-  def __make_empty_plugin_file_data_structure
-    # TODO: dry this up, refs #3350
-    {
-      "plugins_config_version" => "1.0.0",
-      "plugins" => [],
-    }
-  end
-end
-
-module CorePluginUnitHelper
-  include CorePluginBaseHelper
-end

data/lib/plugins/things-for-train-integration.rb

@@ -1,14 +0,0 @@
-# docs/plugins
-# Update that train plugins are now possible
-
-# test/unit/plugin/v2/loader_test.rb
-# TODO: loading all plugins does not activate Train plugins
-
-# lib/plugins/inspec-plugin-manager-cli/test/functional/inspec-plugin_test.rb
-# ~ Should be able to install a train plugin - in place, will fail until plugin published
-# ~ Should be able to search for a train plugin - in place, will fail until plugin published
-
-# test/functional/plugins_test.rb
-# % Should be able to suggest a train transport plugin when an unsupported --target schema is used and a gem search is successful
-# % Should be able to suggest a train transport plugin when an unrecognized profile platform declaration is used and a gem search is successful
-# - Should be able to run inspec detect targeting a test target

data/lib/source_readers/flat.rb

@@ -1,36 +0,0 @@
-require "inspec/fetcher"
-require "inspec/metadata"
-
-module SourceReaders
-  class Flat < Inspec.source_reader(1)
-    name "flat"
-    priority 5
-
-    def self.resolve(target)
-      # TODO: eventually remove the metadata.rb exception here
-      # when we have fully phased out metadata.rb in 1.0
-      files = target.files.find_all do |x|
-        x.end_with?(".rb") && !x.include?("/") && x != "metadata.rb"
-      end
-      return nil if files.empty?
-
-      new(target, files)
-    end
-
-    attr_reader :metadata, :tests, :libraries, :data_files
-
-    def initialize(target, files)
-      @target = target
-      @metadata = ::Inspec::Metadata.new(nil)
-      @tests = load_tests(files)
-      @libraries = {}
-      @data_files = {}
-    end
-
-    private
-
-    def load_tests(files)
-      Hash[files.map { |x| [x, @target.read(x)] }]
-    end
-  end
-end

data/lib/source_readers/inspec.rb

@@ -1,66 +0,0 @@
-require "inspec/fetcher"
-require "inspec/metadata"
-
-module SourceReaders
-  class InspecReader < Inspec.source_reader(1)
-    name "inspec"
-    priority 10
-
-    def self.resolve(target)
-      return new(target, "inspec.yml") if target.files.include?("inspec.yml")
-
-      nil
-    end
-
-    attr_reader :metadata, :tests, :libraries, :data_files
-
-    # This create a new instance of an InSpec profile source reader
-    #
-    # @param [FileProvider] target An instance of a FileProvider object that can list files and read them
-    # @param [String] metadata_source eg. inspec.yml or metadata.rb
-    def initialize(target, metadata_source)
-      @target     = target
-      @metadata   = load_metadata(metadata_source)
-      @tests      = load_tests
-      @libraries  = load_libs
-      @data_files = load_data_files
-    end
-
-    private
-
-    def load_metadata(metadata_source)
-      Inspec::Metadata.from_ref(
-        metadata_source,
-        @target.read(metadata_source),
-        nil
-      )
-    rescue Psych::SyntaxError => e
-      raise "Unable to parse inspec.yml: line #{e.line}, #{e.problem} #{e.context}"
-    rescue => e
-      raise "Unable to parse #{metadata_source}: #{e.class} -- #{e.message}"
-    end
-
-    def find_all(regexp)
-      @target.files.grep(regexp)
-    end
-
-    def load_all(regexp)
-      find_all(regexp)
-        .map { |path| file = @target.read(path); [path, file] if file }
-        .compact
-        .to_h
-    end
-
-    def load_tests
-      load_all(%r{^controls/.*\.rb$})
-    end
-
-    def load_libs
-      load_all(%r{^libraries/.*\.rb$})
-    end
-
-    def load_data_files
-      load_all(%r{^files/})
-    end
-  end
-end