inspec 4.3.2 → 4.6.3

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

@@ -1,75 +1,75 @@
-require_relative '../../../shared/core_plugin_test_helper.rb'
+require_relative "../../../shared/core_plugin_test_helper.rb"
 
 #-----------------------------------------------------------------------#
 # Thor option defs
 #-----------------------------------------------------------------------#
-class PluginManagerCliOptions < MiniTest::Test
+class PluginManagerCliOptions < Minitest::Test
   include CorePluginUnitHelper
   let(:cli_class) { InspecPlugins::PluginManager::CliCommand }
 
   def setup
-    require_relative '../../lib/inspec-plugin-manager-cli/cli_command'
+    require_relative "../../lib/inspec-plugin-manager-cli/cli_command"
   end
 
   def test_list_args
-    arg_config = cli_class.all_commands['list'].options
-    assert_equal 1, arg_config.count, 'The list command should have 1 option'
+    arg_config = cli_class.all_commands["list"].options
+    assert_equal 1, arg_config.count, "The list command should have 1 option"
 
-    assert_includes arg_config.keys, :all, 'The list command should have an --all option'
-    assert_equal :boolean, arg_config[:all].type, 'The --all option should be boolean'
-    assert_equal :a, arg_config[:all].aliases.first, 'The --all option should be aliased as -a'
-    refute_nil arg_config[:all].description, 'The --all option should have a description'
-    refute arg_config[:all].required, 'The --all option should not be required'
+    assert_includes arg_config.keys, :all, "The list command should have an --all option"
+    assert_equal :boolean, arg_config[:all].type, "The --all option should be boolean"
+    assert_equal :a, arg_config[:all].aliases.first, "The --all option should be aliased as -a"
+    refute_nil arg_config[:all].description, "The --all option should have a description"
+    refute arg_config[:all].required, "The --all option should not be required"
 
-    assert_equal 0, cli_class.instance_method(:list).arity, 'The list command should take no arguments'
+    assert_equal 0, cli_class.instance_method(:list).arity, "The list command should take no arguments"
   end
 
   def test_search_args
-    arg_config = cli_class.all_commands['search'].options
-    assert_equal 3, arg_config.count, 'The search command should have 3 options'
+    arg_config = cli_class.all_commands["search"].options
+    assert_equal 3, arg_config.count, "The search command should have 3 options"
 
-    assert_includes arg_config.keys, :all, 'The search command should have an --all option'
-    assert_equal :boolean, arg_config[:all].type, 'The --all option should be boolean'
-    assert_equal :a, arg_config[:all].aliases.first, 'The --all option should be aliased as -a'
-    refute_nil arg_config[:all].description, 'The --all option should have a description'
-    refute arg_config[:all].required, 'The --all option should not be required'
+    assert_includes arg_config.keys, :all, "The search command should have an --all option"
+    assert_equal :boolean, arg_config[:all].type, "The --all option should be boolean"
+    assert_equal :a, arg_config[:all].aliases.first, "The --all option should be aliased as -a"
+    refute_nil arg_config[:all].description, "The --all option should have a description"
+    refute arg_config[:all].required, "The --all option should not be required"
 
-    assert_includes arg_config.keys, :exact, 'The search command should have an --exact option'
-    assert_equal :boolean, arg_config[:exact].type, 'The --exact option should be boolean'
-    assert_equal :e, arg_config[:exact].aliases.first, 'The --exact option should be aliased as -e'
-    refute_nil arg_config[:exact].description, 'The --exact option should have a description'
-    refute arg_config[:exact].required, 'The --exact option should not be required'
+    assert_includes arg_config.keys, :exact, "The search command should have an --exact option"
+    assert_equal :boolean, arg_config[:exact].type, "The --exact option should be boolean"
+    assert_equal :e, arg_config[:exact].aliases.first, "The --exact option should be aliased as -e"
+    refute_nil arg_config[:exact].description, "The --exact option should have a description"
+    refute arg_config[:exact].required, "The --exact option should not be required"
 
-    assert_includes arg_config.keys, :'include-test-fixture', 'The search command should have an --include-test-fixture option'
-    assert_equal :boolean, arg_config[:'include-test-fixture'].type, 'The --include-test-fixture option should be boolean'
-    refute arg_config[:'include-test-fixture'].required, 'The --include-test-fixture option should not be required'
+    assert_includes arg_config.keys, :'include-test-fixture', "The search command should have an --include-test-fixture option"
+    assert_equal :boolean, arg_config[:'include-test-fixture'].type, "The --include-test-fixture option should be boolean"
+    refute arg_config[:'include-test-fixture'].required, "The --include-test-fixture option should not be required"
 
-    assert_equal 1, cli_class.instance_method(:search).arity, 'The search command should take one argument'
+    assert_equal 1, cli_class.instance_method(:search).arity, "The search command should take one argument"
   end
 
   def test_install_args
-    arg_config = cli_class.all_commands['install'].options
-    assert_equal 1, arg_config.count, 'The install command should have 1 option'
+    arg_config = cli_class.all_commands["install"].options
+    assert_equal 1, arg_config.count, "The install command should have 1 option"
 
-    assert_includes arg_config.keys, :version, 'The install command should have a --version option'
-    assert_equal :string, arg_config[:version].type, 'The --version option should be a string'
-    assert_equal :v, arg_config[:version].aliases.first, 'The --version option should be aliased as -v'
-    refute_nil arg_config[:version].description, 'The --version option should have a description'
-    refute arg_config[:version].required, 'The --version option should not be required'
+    assert_includes arg_config.keys, :version, "The install command should have a --version option"
+    assert_equal :string, arg_config[:version].type, "The --version option should be a string"
+    assert_equal :v, arg_config[:version].aliases.first, "The --version option should be aliased as -v"
+    refute_nil arg_config[:version].description, "The --version option should have a description"
+    refute arg_config[:version].required, "The --version option should not be required"
 
-    assert_equal 1, cli_class.instance_method(:install).arity, 'The install command should take one argument'
+    assert_equal 1, cli_class.instance_method(:install).arity, "The install command should take one argument"
   end
 
   def test_update_args
     # TODO: allow specifying version
-    arg_config = cli_class.all_commands['update'].options
-    assert_equal 0, arg_config.count, 'The update command should have no options'
-    assert_equal 1, cli_class.instance_method(:update).arity, 'The update command should take one argument'
+    arg_config = cli_class.all_commands["update"].options
+    assert_equal 0, arg_config.count, "The update command should have no options"
+    assert_equal 1, cli_class.instance_method(:update).arity, "The update command should take one argument"
   end
 
   def test_uninstall_args
-    arg_config = cli_class.all_commands['uninstall'].options
-    assert_equal 0, arg_config.count, 'The uninstall command should have no options'
-    assert_equal 1, cli_class.instance_method(:uninstall).arity, 'The uninstall command should take one argument'
+    arg_config = cli_class.all_commands["uninstall"].options
+    assert_equal 0, arg_config.count, "The uninstall command should have no options"
+    assert_equal 1, cli_class.instance_method(:uninstall).arity, "The uninstall command should take one argument"
   end
 end

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

@@ -1,20 +1,39 @@
-require_relative '../../../shared/core_plugin_test_helper.rb'
+require_relative "../../../shared/core_plugin_test_helper.rb"
 
 #-----------------------------------------------------------------------#
 # Plugin Definition
 #-----------------------------------------------------------------------#
-class PluginManagerCliDefinitionTests < MiniTest::Test
+class PluginManagerCliDefinitionTests < Minitest::Test
   include CorePluginUnitHelper
 
+  @@orig_home = Dir.home
+
+  def setup
+    mock_path = File.expand_path "test/unit/mock"
+
+    @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'
+    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'
+    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,23 +1,22 @@
-
-# Load test harness - MiniTest
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'minitest/pride'
-require 'minitest/spec'
+# Load test harness - Minitest
+require "minitest/autorun"
+require "minitest/pride"
 
 # Data formats commonly used in testing
-require 'json'
-require 'ostruct'
+require "json"
+require "ostruct"
 
 # Utilities often needed
-require 'fileutils'
-require 'tmpdir'
-require 'pathname'
-require 'forwardable'
+require "fileutils"
+require "tmpdir"
+require "pathname"
+require "forwardable"
+
+require "inspec/plugin/v2"
 
-# Configure MiniTest to expose things like `let`
+# Configure Minitest to expose things like `let`
 class Module
-  include Minitest::Spec::DSL
+  include Minitest::Spec::DSL # TODO: NO! remove this!
 end
 
 module Inspec
@@ -38,29 +37,35 @@ module Inspec
 end
 
 module CorePluginBaseHelper
-  let(:repo_path) { File.expand_path(File.join(__FILE__, '..', '..', '..', '..')) }
-  let(:inspec_bin_path) { File.join(repo_path, 'inspec-bin', 'bin', 'inspec') }
-  let(:core_mock_path) { File.join(repo_path, 'test', 'unit', 'mock') }
-  let(:core_fixture_plugins_path) { File.join(core_mock_path, 'plugins') }
-  let(:core_config_dir_path) { File.join(core_mock_path, 'config_dirs') }
+  libdir = File.expand_path "lib"
+
+  let(:repo_path) { File.expand_path(File.join(__FILE__, "..", "..", "..", "..")) }
+  let(:inspec_path) { File.join(repo_path, "inspec-bin", "bin", "inspec") }
+  let(:exec_inspec) { [Gem.ruby, "-I#{libdir}", inspec_path].join " " }
+  let(:core_mock_path) { File.join(repo_path, "test", "unit", "mock") }
+  let(:core_fixture_plugins_path) { File.join(core_mock_path, "plugins") }
+  let(:core_config_dir_path) { File.join(core_mock_path, "config_dirs") }
 
   let(:registry) { Inspec::Plugin::V2::Registry.instance }
 end
 
+require "functional/helper"
+
 module CorePluginFunctionalHelper
   include CorePluginBaseHelper
+  include FunctionalHelper
 
-  require 'train'
-  TRAIN_CONNECTION = Train.create('local', command_runner: :generic).connection
+  require "train"
+  TRAIN_CONNECTION = Train.create("local", command_runner: :generic).connection
 
   def run_inspec_process(command_line, opts = {})
-    prefix = ''
+    prefix = ""
     if opts.key?(:prefix)
       prefix = opts[:prefix]
     elsif opts.key?(:env)
-      prefix = opts[:env].to_a.map { |assignment| "#{assignment[0]}=#{assignment[1]}" }.join(' ')
+      prefix = opts[:env].to_a.map { |assignment| "#{assignment[0]}=#{assignment[1]}" }.join(" ")
     end
-    Inspec::FuncTestRunResult.new(TRAIN_CONNECTION.run_command("#{prefix} #{inspec_bin_path} #{command_line}"))
+    Inspec::FuncTestRunResult.new(TRAIN_CONNECTION.run_command("#{prefix} #{exec_inspec} #{command_line}"))
   end
 
   # This helper does some fancy footwork to make InSpec think a plugin
@@ -79,7 +84,7 @@ module CorePluginFunctionalHelper
 
     # 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-')
+    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)
@@ -87,11 +92,11 @@ module CorePluginFunctionalHelper
 
     Dir.mktmpdir do |tmp_dir|
       opts[:pre_run]&.call(plugin_file_data, tmp_dir)
-      plugin_file_path = File.join(tmp_dir, 'plugins.json')
+      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
+      opts[:env]["INSPEC_CONFIG_DIR"] = tmp_dir
       run_result = run_inspec_process(command_line, opts)
 
       # Read the resulting plugins.json into memory, if any
@@ -111,27 +116,27 @@ module CorePluginFunctionalHelper
     # 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)-/
+    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?
+    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 = 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')
+    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["plugins"] << {
+      "name" => plugin_name,
+      "installation_type" => "path",
+      "installation_path" => path,
     }
     data
   end
@@ -139,8 +144,8 @@ module CorePluginFunctionalHelper
   def __make_empty_plugin_file_data_structure
     # TODO: dry this up, refs #3350
     {
-      'plugins_config_version' => '1.0.0',
-      'plugins' => [],
+      "plugins_config_version" => "1.0.0",
+      "plugins" => [],
     }
   end
 end

data/lib/resource_support/aws.rb

@@ -1,76 +1,76 @@
 # Main AWS loader file.  The intent is for this to be
 # loaded only if AWS resources are needed.
 
-require 'aws-sdk-core'
+require "aws-sdk-core"
 
-require 'aws-sdk-cloudtrail'
-require 'aws-sdk-cloudwatch'
-require 'aws-sdk-cloudwatchlogs'
-require 'aws-sdk-costandusagereportservice'
-require 'aws-sdk-configservice'
-require 'aws-sdk-ec2'
-require 'aws-sdk-ecs'
-require 'aws-sdk-eks'
-require 'aws-sdk-elasticloadbalancing'
-require 'aws-sdk-iam'
-require 'aws-sdk-kms'
-require 'aws-sdk-rds'
-require 'aws-sdk-s3'
-require 'aws-sdk-sqs'
-require 'aws-sdk-sns'
+require "aws-sdk-cloudtrail"
+require "aws-sdk-cloudwatch"
+require "aws-sdk-cloudwatchlogs"
+require "aws-sdk-costandusagereportservice"
+require "aws-sdk-configservice"
+require "aws-sdk-ec2"
+require "aws-sdk-ecs"
+require "aws-sdk-eks"
+require "aws-sdk-elasticloadbalancing"
+require "aws-sdk-iam"
+require "aws-sdk-kms"
+require "aws-sdk-rds"
+require "aws-sdk-s3"
+require "aws-sdk-sqs"
+require "aws-sdk-sns"
 
-require 'resource_support/aws/aws_backend_factory_mixin'
-require 'resource_support/aws/aws_resource_mixin'
-require 'resource_support/aws/aws_singular_resource_mixin'
-require 'resource_support/aws/aws_plural_resource_mixin'
-require 'resource_support/aws/aws_backend_base'
+require "resource_support/aws/aws_backend_factory_mixin"
+require "resource_support/aws/aws_resource_mixin"
+require "resource_support/aws/aws_singular_resource_mixin"
+require "resource_support/aws/aws_plural_resource_mixin"
+require "resource_support/aws/aws_backend_base"
 
 # Load all AWS resources
 # TODO: loop over and load entire directory
 # for f in ls lib/resources/aws/*; do t=$(echo $f | cut -c 5- | cut -f1 -d. ); echo "require '${t}'"; done
-require 'resources/aws/aws_billing_report'
-require 'resources/aws/aws_billing_reports'
-require 'resources/aws/aws_cloudtrail_trail'
-require 'resources/aws/aws_cloudtrail_trails'
-require 'resources/aws/aws_cloudwatch_alarm'
-require 'resources/aws/aws_cloudwatch_log_metric_filter'
-require 'resources/aws/aws_config_delivery_channel'
-require 'resources/aws/aws_config_recorder'
-require 'resources/aws/aws_ec2_instance'
-require 'resources/aws/aws_ebs_volume'
-require 'resources/aws/aws_ebs_volumes'
-require 'resources/aws/aws_flow_log'
-require 'resources/aws/aws_ec2_instances'
-require 'resources/aws/aws_ecs_cluster'
-require 'resources/aws/aws_eks_cluster'
-require 'resources/aws/aws_elb'
-require 'resources/aws/aws_elbs'
-require 'resources/aws/aws_iam_access_key'
-require 'resources/aws/aws_iam_access_keys'
-require 'resources/aws/aws_iam_group'
-require 'resources/aws/aws_iam_groups'
-require 'resources/aws/aws_iam_password_policy'
-require 'resources/aws/aws_iam_policies'
-require 'resources/aws/aws_iam_policy'
-require 'resources/aws/aws_iam_role'
-require 'resources/aws/aws_iam_root_user'
-require 'resources/aws/aws_iam_user'
-require 'resources/aws/aws_iam_users'
-require 'resources/aws/aws_kms_key'
-require 'resources/aws/aws_kms_keys'
-require 'resources/aws/aws_rds_instance'
-require 'resources/aws/aws_route_table'
-require 'resources/aws/aws_route_tables'
-require 'resources/aws/aws_s3_bucket'
-require 'resources/aws/aws_s3_bucket_object'
-require 'resources/aws/aws_s3_buckets'
-require 'resources/aws/aws_security_group'
-require 'resources/aws/aws_security_groups'
-require 'resources/aws/aws_sns_subscription'
-require 'resources/aws/aws_sns_topic'
-require 'resources/aws/aws_sns_topics'
-require 'resources/aws/aws_sqs_queue'
-require 'resources/aws/aws_subnet'
-require 'resources/aws/aws_subnets'
-require 'resources/aws/aws_vpc'
-require 'resources/aws/aws_vpcs'
+require "resources/aws/aws_billing_report"
+require "resources/aws/aws_billing_reports"
+require "resources/aws/aws_cloudtrail_trail"
+require "resources/aws/aws_cloudtrail_trails"
+require "resources/aws/aws_cloudwatch_alarm"
+require "resources/aws/aws_cloudwatch_log_metric_filter"
+require "resources/aws/aws_config_delivery_channel"
+require "resources/aws/aws_config_recorder"
+require "resources/aws/aws_ec2_instance"
+require "resources/aws/aws_ebs_volume"
+require "resources/aws/aws_ebs_volumes"
+require "resources/aws/aws_flow_log"
+require "resources/aws/aws_ec2_instances"
+require "resources/aws/aws_ecs_cluster"
+require "resources/aws/aws_eks_cluster"
+require "resources/aws/aws_elb"
+require "resources/aws/aws_elbs"
+require "resources/aws/aws_iam_access_key"
+require "resources/aws/aws_iam_access_keys"
+require "resources/aws/aws_iam_group"
+require "resources/aws/aws_iam_groups"
+require "resources/aws/aws_iam_password_policy"
+require "resources/aws/aws_iam_policies"
+require "resources/aws/aws_iam_policy"
+require "resources/aws/aws_iam_role"
+require "resources/aws/aws_iam_root_user"
+require "resources/aws/aws_iam_user"
+require "resources/aws/aws_iam_users"
+require "resources/aws/aws_kms_key"
+require "resources/aws/aws_kms_keys"
+require "resources/aws/aws_rds_instance"
+require "resources/aws/aws_route_table"
+require "resources/aws/aws_route_tables"
+require "resources/aws/aws_s3_bucket"
+require "resources/aws/aws_s3_bucket_object"
+require "resources/aws/aws_s3_buckets"
+require "resources/aws/aws_security_group"
+require "resources/aws/aws_security_groups"
+require "resources/aws/aws_sns_subscription"
+require "resources/aws/aws_sns_topic"
+require "resources/aws/aws_sns_topics"
+require "resources/aws/aws_sqs_queue"
+require "resources/aws/aws_subnet"
+require "resources/aws/aws_subnets"
+require "resources/aws/aws_vpc"
+require "resources/aws/aws_vpcs"