inspec-core 4.23.4 → 4.24.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2786d0d36c3218a4d79f4578c4a814469115787d4470fa81d422b05b2025462
-  data.tar.gz: a0d30c7b81dbb4e58e6b9e8c0447f0855ce1f94f223c1f4f5861a03dfce2ce6c
+  metadata.gz: bfed5976ebd618d37b1fbf0058fbd9389b243dbd5070444fda7558cf309392c3
+  data.tar.gz: 3b894051f2f56e249af59acf0de10c50d8a826d3af1755eaf60100a7a4934dab
 SHA512:
-  metadata.gz: 915bbf9f4302c5fe2e8a41bc131b935bc42861cd4f76d0163ef1aeddc231cdbaf1f653ffd621bb79e5a531baa941e59852b34550d114bf30d95d4eb2ff5aa876
-  data.tar.gz: d7b5f80f550bf092aaa0faaf660225f99e3e4d6b600d9a89a45c0648b752a00cac5e30aaaf74fdb940bb135b2ae2ae02112f9617adbe6c25abc46c10d9492c5d
+  metadata.gz: c1d9b3598a4bc81085d95b5a4b254ac57001aa301e4371394b8b8b307b54ed26644784ccf9dafd2e52d4e2553e5c1ff77ae821691ef738e542f13d892f692f81
+  data.tar.gz: 54f9be8adc1870127be3e825e809499270717d395fa26d11408f186a66fdb61ca7db0ac78fd73143652893bd482acf2d1009c3343609e8b34bcd3ff3eb0aaa0c

data/Gemfile

@@ -11,6 +11,11 @@ gem "inspec-bin", path: "./inspec-bin"
 
 gem "ffi", ">= 1.9.14", "!= 1.13.0"
 
+if Gem.ruby_version.to_s.start_with?("2.5")
+  # 16.7.23 required ruby 2.6+
+  gem "chef-utils", "< 16.7.23" # TODO: remove when we drop ruby 2.5
+end
+
 group :omnibus do
   gem "rb-readline"
   gem "appbundler"
@@ -19,45 +24,23 @@ group :omnibus do
 end
 
 group :test do
-  gem "chefstyle", "~> 1.2.1"
-  gem "minitest", "~> 5.5"
-  gem "minitest-sprint", "~> 1.0"
-  gem "rake", ">= 10"
-  gem "simplecov", ["~> 0.10", "<=0.18.2"]
+  gem "chefstyle", "~> 1.5.7"
   gem "concurrent-ruby", "~> 1.0"
+  gem "html-proofer", platforms: :ruby # do not attempt to run proofer on windows
+  gem "json_schemer", ">= 0.2.1", "< 0.2.12"
+  gem "m"
+  gem "minitest-sprint", "~> 1.0"
+  gem "minitest", "~> 5.5"
   gem "mocha", "~> 1.1"
+  gem "nokogiri", "~> 1.9"
+  gem "pry-byebug"
+  gem "pry", "~> 0.10"
+  gem "rake", ">= 10"
   gem "ruby-progressbar", "~> 1.8"
+  gem "simplecov", "~> 0.18"
   gem "webmock", "~> 3.0"
-  gem "m"
-  gem "pry", "~> 0.10"
-  gem "pry-byebug"
-  gem "html-proofer", platforms: :ruby # do not attempt to run proofer on windows
-end
-
-group :integration do
-  gem "berkshelf"
-  gem "test-kitchen"
-  gem "kitchen-vagrant"
-  gem "chef", "< 15"
-  gem "chef-zero", "< 15"
-  gem "kitchen-inspec"
-  gem "kitchen-ec2"
-  gem "kitchen-dokken"
-  gem "git"
-end
-
-# gems for Maintainers.md generation
-group :maintenance do
-  gem "tomlrb"
-
-  # To sync maintainers with github
-  gem "octokit"
-  gem "netrc"
 end
 
 group :deploy do
   gem "inquirer"
 end
-
-# add these additional dependencies into Gemfile.local
-eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/inspec-core.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "inspec/version"
 
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.license       = "Apache-2.0"
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = "~> 2.4"
+  spec.required_ruby_version = ">= 2.5"
 
   # the gemfile and gemspec are necessary for appbundler so don't remove it
   spec.files =
@@ -26,22 +26,21 @@ Gem::Specification.new do |spec|
   spec.add_dependency "chef-telemetry",     "~> 1.0"
   spec.add_dependency "license-acceptance", ">= 0.2.13", "< 3.0"
   spec.add_dependency "thor",               ">= 0.20", "< 2.0"
-  spec.add_dependency "json_schemer",       ">= 0.2.1", "< 0.2.12"
   spec.add_dependency "method_source",      ">= 0.8", "< 2.0"
-  spec.add_dependency "rubyzip",            "~> 1.2", ">= 1.2.2"
-  spec.add_dependency "rspec",              "~> 3.9"
+  spec.add_dependency "rubyzip",            ">= 1.2.2", "< 3.0"
+  spec.add_dependency "rspec",              "~> 3.10"
   spec.add_dependency "rspec-its",          "~> 1.2"
   spec.add_dependency "pry",                "~> 0.13"
-  spec.add_dependency "hashie",             "~> 3.4"
+  spec.add_dependency "hashie",             ">= 3.4", "< 5.0"
   spec.add_dependency "mixlib-log",         "~> 3.0"
   spec.add_dependency "sslshake",           "~> 1.2"
   spec.add_dependency "parallel",           "~> 1.9"
-  spec.add_dependency "faraday",            ">= 0.9.0"
+  spec.add_dependency "faraday",            ">= 0.9.0", "< 1.2"
   spec.add_dependency "tty-table",          "~> 0.10"
   spec.add_dependency "tty-prompt",         "~> 0.17"
-  spec.add_dependency "tomlrb",             "~> 1.2.0"
+  spec.add_dependency "tomlrb",             ">= 1.2", "< 2.1"
   spec.add_dependency "addressable",        "~> 2.4"
-  spec.add_dependency "parslet",            "~> 1.5"
+  spec.add_dependency "parslet",            ">= 1.5", "< 3.0"
   spec.add_dependency "semverse",           "~> 3.0"
   spec.add_dependency "multipart-post",     "~> 2.0"
 

data/lib/bundles/inspec-supermarket/api.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "net/http"
-require "addressable/uri"
+require "net/http" unless defined?(Net::HTTP)
+require "addressable/uri" unless defined?(Addressable::URI)
 
 module Supermarket
   class API

data/lib/bundles/inspec-supermarket/target.rb

@@ -1,4 +1,4 @@
-require "uri"
+require "uri" unless defined?(URI)
 require "inspec/fetcher"
 require "inspec/fetcher/url"
 

data/lib/inspec/archive/tar.rb

@@ -1,4 +1,4 @@
-require "rubygems/package"
+require "rubygems/package" unless defined?(Gem::Package)
 
 module Inspec::Archive
   class TarArchiveGenerator

data/lib/inspec/archive/zip.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "zip"
-require "pathname"
+require "rubygems" unless defined?(Gem)
+require "zip" unless defined?(Zip)
+require "pathname" unless defined?(Pathname)
 
 module Inspec::Archive
   class ZipArchiveGenerator

data/lib/inspec/base_cli.rb

@@ -1,4 +1,4 @@
-require "thor"
+require "thor" unless defined?(Thor)
 require "inspec/log"
 require "inspec/ui"
 require "inspec/config"
@@ -164,6 +164,12 @@ module Inspec
         desc: "After normal execution order, results are sorted by control ID, or by file (default), or randomly. None uses legacy unsorted mode."
     end
 
+    def self.help(*args)
+      super(*args)
+      puts "\nAbout #{Inspec::Dist::PRODUCT_NAME}:"
+      puts "  Patents: chef.io/patents\n\n"
+    end
+
     def self.format_platform_info(params: {}, indent: 0, color: 39)
       str = ""
       params.each do |item, info|

data/lib/inspec/cached_fetcher.rb

@@ -1,5 +1,5 @@
 require "inspec/fetcher"
-require "forwardable"
+require "forwardable" unless defined?(Forwardable)
 
 module Inspec
   class CachedFetcher

data/lib/inspec/cli.rb

@@ -48,7 +48,8 @@ class Inspec::InspecCLI < Inspec::BaseCLI
     desc: "Allow or disable user interaction"
 
   class_option :disable_core_plugins, type: :string, banner: "", # Actually a boolean, but this suppresses the creation of a --no-disable...
-    desc: "Disable loading all plugins that are shipped in the lib/plugins directory of InSpec. Useful in development."
+    desc: "Disable loading all plugins that are shipped in the lib/plugins directory of InSpec. Useful in development.",
+    hide: true
 
   class_option :disable_user_plugins, type: :string, banner: "",
     desc: "Disable loading all plugins that the user installed."
@@ -66,7 +67,7 @@ class Inspec::InspecCLI < Inspec::BaseCLI
     desc: "A list of controls to include. Ignore all other tests."
   profile_options
   def json(target)
-    require "json"
+    require "json" unless defined?(JSON)
 
     o = config
     diagnose(o)
@@ -194,7 +195,8 @@ class Inspec::InspecCLI < Inspec::BaseCLI
     pretty_handle_exception(e)
   end
 
-  desc "exec LOCATIONS", <<~EOT
+  desc "exec LOCATIONS", "Run all tests at LOCATIONS."
+  long_desc <<~EOT
     Run all test files at the specified LOCATIONS.
 
     Loads the given profile(s) and fetches their dependencies if needed. Then

data/lib/inspec/config.rb

@@ -1,11 +1,11 @@
 # Represents InSpec configuration.  Merges defaults, config file options,
 # and CLI arguments.
 
-require "pp"
-require "stringio"
-require "forwardable"
-require "thor"
-require "base64"
+require "pp" unless defined?(PP)
+require "stringio" unless defined?(StringIO)
+require "forwardable" unless defined?(Forwardable)
+require "thor" unless defined?(Thor)
+require "base64" unless defined?(Base64)
 require "inspec/plugin/v2/filter"
 
 module Inspec

data/lib/inspec/dependencies/cache.rb

@@ -1,4 +1,4 @@
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 
 module Inspec
   #

data/lib/inspec/env_printer.rb

@@ -1,6 +1,6 @@
 require "inspec/shell_detector"
-require "erb"
-require "shellwords"
+require "erb" unless defined?(Erb)
+require "shellwords" unless defined?(Shellwords)
 
 module Inspec
   class EnvPrinter

data/lib/inspec/fetcher/git.rb

@@ -1,6 +1,6 @@
-require "tmpdir"
-require "fileutils"
-require "mixlib/shellout"
+require "tmpdir" unless defined?(Dir.mktmpdir)
+require "fileutils" unless defined?(FileUtils)
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
 require "inspec/log"
 
 module Inspec::Fetcher

data/lib/inspec/fetcher/local.rb

@@ -1,4 +1,4 @@
-require "openssl"
+require "openssl" unless defined?(OpenSSL)
 
 module Inspec::Fetcher
   class Local < Inspec.fetcher(1)

data/lib/inspec/fetcher/url.rb

@@ -1,7 +1,7 @@
-require "uri"
-require "openssl"
-require "tempfile"
-require "open-uri"
+require "uri" unless defined?(URI)
+require "openssl" unless defined?(OpenSSL)
+require "tempfile" unless defined?(Tempfile)
+require "open-uri" unless defined?(OpenURI)
 
 module Inspec::Fetcher
   class Url < Inspec.fetcher(1)

data/lib/inspec/file_provider.rb

@@ -1,7 +1,7 @@
-require "rubygems/package"
-require "pathname"
-require "zlib"
-require "zip"
+require "rubygems/package" unless defined?(Gem::Package)
+require "pathname" unless defined?(Pathname)
+require "zlib" unless defined?(Zlib)
+require "zip" unless defined?(Zip)
 
 module Inspec
   class FileProvider

data/lib/inspec/formatters/base.rb

@@ -159,6 +159,14 @@ module Inspec::Formatters
         resource_title: example.metadata[:described_class] || example.metadata[:example_group][:description],
         expectation_message: format_expectation_message(example),
         waiver_data: example.metadata[:waiver_data],
+        # This enforces the resource name as expected based off of the class
+        # name. However, if we wanted the `name` attribute against the class
+        # to be canonical for this case (consider edge cases!) we would use
+        # example.metadata[:described_class].instance_variable_get(:@__resource_name__)&.to_s
+        resource_class: example.metadata[:described_class].class.superclass.name,
+        # This is a raw grep of the text passed to the resource in any format,
+        # and is used to enforce near-uniqueness against the resource.
+        resource_params: find_resource_params(example.metadata[:described_class]),
       }
 
       unless (pid = example.metadata[:profile_id]).nil?
@@ -174,6 +182,14 @@ module Inspec::Formatters
       res
     end
 
+    def find_resource_params(example)
+      if example.class.ancestors.include?(Inspec::Resource)
+        example.instance_variable_get(:@resource_params)
+      else
+        []
+      end
+    end
+
     def format_expectation_message(example)
       if (example.metadata[:example_group][:description_args].first == example.metadata[:example_group][:described_class]) ||
           example.metadata[:example_group][:described_class].nil?

data/lib/inspec/globals.rb

@@ -1,15 +1,21 @@
 require_relative "utils/install_context"
 
 module Inspec
-
   extend Inspec::InstallContextHelpers
 
   def self.config_dir
-    ENV["INSPEC_CONFIG_DIR"] ? ENV["INSPEC_CONFIG_DIR"] : File.join(Dir.home, ".inspec")
+    ENV["INSPEC_CONFIG_DIR"] || File.join(home_path, ".inspec")
   end
 
   def self.src_root
     @src_root ||= File.expand_path(File.join(__FILE__, "../../.."))
   end
 
+  def self.home_path
+    Dir.home
+  rescue ArgumentError, NoMethodError
+    # If ENV['HOME'] is not set, Dir.home will fail due to expanding the ~. Fallback to Etc.
+    require "etc" unless defined?(Etc)
+    Etc.getpwuid.dir
+  end
 end

data/lib/inspec/input.rb

@@ -14,14 +14,17 @@ module Inspec
   class Input
 
     class Error < Inspec::Error; end
+
     class ValidationError < Error
       attr_accessor :input_name
       attr_accessor :input_value
       attr_accessor :input_type
     end
+
     class TypeError < Error
       attr_accessor :input_type
     end
+
     class RequiredError < Error
       attr_accessor :input_name
     end

data/lib/inspec/input_registry.rb

@@ -1,5 +1,5 @@
-require "forwardable"
-require "singleton"
+require "forwardable" unless defined?(Forwardable)
+require "singleton" unless defined?(Singleton)
 require "inspec/input"
 require "inspec/secrets"
 require "inspec/exceptions"
@@ -14,9 +14,11 @@ module Inspec
     extend Forwardable
 
     class Error < Inspec::Error; end
+
     class ProfileLookupError < Error
       attr_accessor :profile_name
     end
+
     class InputLookupError < Error
       attr_accessor :profile_name
       attr_accessor :input_name
@@ -199,7 +201,7 @@ module Inspec
           value = YAML.load(value)
         rescue Psych::SyntaxError => yaml_error
           # It could be that we just tried to run JSON through the YAML parser.
-          require "json"
+          require "json" unless defined?(JSON)
           begin
             value = JSON.parse(value)
           rescue JSON::ParserError => json_error

data/lib/inspec/metadata.rb

@@ -216,7 +216,7 @@ module Inspec
     end
 
     def self.from_yaml(ref, content, profile_id, logger = nil)
-      require "erb"
+      require "erb" unless defined?(Erb)
       res = Metadata.new(ref, logger)
       res.params = YAML.load(ERB.new(content).result)
       res.content = content

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

@@ -1,4 +1,4 @@
-require "forwardable"
+require "forwardable" unless defined?(Forwardable)
 
 module Inspec
   # Resource Plugins
@@ -36,7 +36,7 @@ module Inspec
         .flatten
 
       # load bundled plugins
-      bundled_dir = File.expand_path(File.dirname(__FILE__))
+      bundled_dir = __dir__
       @paths += Dir[File.join(bundled_dir, "..", "bundles", "inspec-*.rb")].flatten
 
       # map paths to names

data/lib/inspec/plugin/v2.rb

@@ -6,17 +6,22 @@ module Inspec
       class Exception < Inspec::Error; end
       class ConfigError < Inspec::Plugin::V2::Exception; end
       class LoadError < Inspec::Plugin::V2::Exception; end
+
       class GemActionError < Inspec::Plugin::V2::Exception
         attr_accessor :plugin_name
         attr_accessor :version
       end
+
       class InstallError < Inspec::Plugin::V2::GemActionError; end
+
       class PluginExcludedError < Inspec::Plugin::V2::InstallError
         attr_accessor :details
       end
+
       class UpdateError < Inspec::Plugin::V2::GemActionError
         attr_accessor :from_version, :to_version
       end
+
       class UnInstallError < Inspec::Plugin::V2::GemActionError; end
       class SearchError < Inspec::Plugin::V2::GemActionError; end
     end

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

@@ -1,4 +1,4 @@
-require "json"
+require "json" unless defined?(JSON)
 
 module Inspec::Plugin::V2
   # Represents the plugin config file on disk.