inspec-core 4.23.15 → 4.24.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d456ded6249283aa4db22d7dc054afeb37996472a16d9d8d007bd492f7a6c8
-  data.tar.gz: f355c608691df7895a0440a7f70a0ffb0f8cd0d7167da490dfcefeec45bba2bc
+  metadata.gz: 40b226d810bf523c7b914a00d3e3e0556d23eb78b944f12fe7af7fac35a279f4
+  data.tar.gz: ff6cafe82a9e7234814575a3723098ccb1238fb88754cb4891288547e9c3a47b
 SHA512:
-  metadata.gz: f9c878fa83d12844ea6d0b1a58da70d6e39650a41e5ad7b7041bfc11faee21c8ce67adee8c5eae29ef04a4734b7c916415d285dab888c0c776a80717037c049b
-  data.tar.gz: f072fbccdb85a007f3a33ba9294024b403eda80b184ee806a08226a47728681aaed1692ac61cbefde5fe7e965ea0db5e6306405e6c808f15d4011a44a6215542
+  metadata.gz: c663121d4e9dba5764ba321d391b4779f3b9236b827fc7dca58aa2a6a3b9d76a5749205635c38ca6a28f614364f19fef1c7c790321067fef2ae1e1eb9a1dbd74
+  data.tar.gz: da255c1b0637e48aa1f83ea42607829767450bd03fd5f970e527afa81898ba215b7ac4ec66c508d23ef2de74ebb9e3dc26893427c76ab4176e67ffaf5df42c54

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"
@@ -20,45 +25,31 @@ 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 "concurrent-ruby", "~> 1.0"
-  gem "nokogiri", "~> 1.9"
+  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.10", "<=0.18.2"]
   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 "test-kitchen", ">= 2.8"
+  gem "kitchen-vagrant", ">= 1.7"
+  gem "kitchen-inspec", ">= 2.0"
+  gem "kitchen-dokken", ">= 2.11"
   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")
+end

data/inspec-core.gemspec

@@ -26,10 +26,9 @@ 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 "rspec",              "~> 3.9.0"
   spec.add_dependency "rspec-its",          "~> 1.2"
   spec.add_dependency "pry",                "~> 0.13"
   spec.add_dependency "hashie",             "~> 3.4"

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/plugin/v2/loader.rb

@@ -50,6 +50,11 @@ module Inspec::Plugin::V2
       # we want to allow "sidecar loading", in which case a plugin may add an entry to the registry.
       registry.plugin_names.dup.each do |plugin_name|
         plugin_details = registry[plugin_name]
+
+        # Under some conditions (kitchen-inspec with multiple test suites, for example), this may be
+        # called multple times. Don't reload anything.
+        next if plugin_details.loaded
+
         # We want to capture literally any possible exception here, since we are storing them.
         # rubocop: disable Lint/RescueException
         begin

data/lib/inspec/reporters/json.rb

@@ -40,6 +40,8 @@ module Inspec::Reporters
           message:      r[:message],
           exception:    r[:exception],
           backtrace:    r[:backtrace],
+          resource_class: r[:resource_class],
+          resource_params: r[:resource_params].to_s,
         }.reject { |_k, v| v.nil? }
       }
     end

data/lib/inspec/resource.rb

@@ -108,6 +108,7 @@ module Inspec
     # Infrastructure / Bookkeeping
 
     def self.__register(name, resource_klass)
+      # This has bitten us and should be a great candidate to remove in InSpec5
       cl = Class.new(resource_klass) do # TODO: remove
         # As best I can figure out, this anonymous class only exists
         # because we're trying to avoid having resources with
@@ -116,6 +117,7 @@ module Inspec
         # documentation.
         def initialize(backend, name, *args)
           supersuper_initialize(backend, name) do
+            @resource_params = args
             super(*args)
           end
         end

data/lib/inspec/resources/grub_conf.rb

@@ -29,7 +29,7 @@ module Inspec::Resources
       @content = read_file(@conf_path)
       @kernel = kernel || "default"
     rescue UnknownGrubConfig
-      skip_resource "The `grub_config` resource is not supported on your OS yet."
+      skip_resource "The `grub_conf` resource is not yet supported on the target OS #{inspec.os[:name]}."
     end
 
     def config_for_platform(path)
@@ -77,6 +77,7 @@ module Inspec::Resources
 
     def grub2_parse_kernel_lines(content, conf)
       menu_entries = extract_menu_entries(content)
+      return {} if menu_entries.empty?
 
       if @kernel == "default"
         default_menu_entry(menu_entries, conf["GRUB_DEFAULT"])

data/lib/inspec/resources/package.rb

@@ -314,7 +314,7 @@ module Inspec::Resources
       # Find the package
       cmd = inspec.command <<-EOF.gsub(/^\s*/, "")
         Get-ItemProperty (@("#{search_paths.join('", "')}") | Where-Object { Test-Path $_ }) |
-        Where-Object { $_.DisplayName -match "^\s*#{package_name.shellescape}\.*" -or $_.PSChildName -match "^\s*#{package_name.shellescape}\.*" } |
+        Where-Object { $_.DisplayName -like "#{package_name}" -or $_.PSChildName -like "#{package_name}" } |
         Select-Object -Property DisplayName,DisplayVersion | ConvertTo-Json
       EOF
 

data/lib/inspec/resources/platform.rb

@@ -81,7 +81,7 @@ module Inspec::Resources
           when :os, :platform then
             platform?(v)
           when :os_name, :platform_name then
-            name == v
+            check_name(v)
           when :release then
             check_release(v)
           end
@@ -99,6 +99,16 @@ module Inspec::Resources
 
     private
 
+    def check_name(value)
+      # allow wild card matching
+      if value.include?("*")
+        cleaned = Regexp.escape(value).gsub('\*', ".*?")
+        name =~ /#{cleaned}/
+      else
+        name == value
+      end
+    end
+
     def check_release(value)
       # allow wild card matching
       if value.include?("*")

data/lib/inspec/resources/wmi.rb

@@ -16,7 +16,10 @@ module Inspec::Resources
         namespace: 'root\\rsop\\computer',
         filter: 'KeyName = \'MinimumPasswordAge\' And precedence=1'
       }) do
-         its('Setting') { should eq true }
+         its('Setting') { should cmp true }
+      end
+      describe wmi({namespace: "root\\cimv2", query: "SELECT installstate FROM win32_optionalfeature"}) do
+        its("installstate") { should include 2 }
       end
     EXAMPLE
 
@@ -66,13 +69,18 @@ module Inspec::Resources
 
       # run wmi command and filter empty wmi
       script = <<-EOH
-      Filter Aggregate
-      {
-          $arr = @{}
-          $_.properties | % {
-              $arr.Add($_.name, $_.value)
+      Function Aggregate {
+        $propsHash = @{}
+        ForEach ($wmiObj in $Input) {
+          ForEach ($wmiProp in $wmiObj.properties) {
+            If($propsHash.ContainsKey($wmiProp.name)) {
+              $propsHash[$wmiProp.name].add($wmiProp.value) | Out-Null
+            } Else {
+              $propsHash[$wmiProp.name] = [System.Collections.ArrayList]@($wmiProp.value)
+            }
           }
-          $arr
+        }
+        $propsHash
       }
       Get-WmiObject #{params} | Aggregate | ConvertTo-Json
       EOH

data/lib/inspec/run_data.rb

@@ -47,7 +47,7 @@ module Inspec
     # core reporters have been migrated to plugins. It is probable that new data elements
     # and new Hash compatibility behavior will be added during the core reporter plugin
     # conversion process.
-    SCHEMA_VERSION = "0.2.0".freeze
+    SCHEMA_VERSION = "0.3.0".freeze
 
     def self.compatible_schema?(constraints)
       reqs = Gem::Requirement.create(constraints)

data/lib/inspec/run_data/result.rb

@@ -8,6 +8,7 @@ module Inspec
       :run_time,            # Float seconds execution time
       :skip_message,        # String
       :start_time,          # DateTime
+      :resource_params,     # What is passed to the resource as a raw grep
       :status, # String
       :resource_title, # Ugly internals
       # :waiver_data,       # Undocumented tramp data / not exposed in this API
@@ -34,6 +35,7 @@ module Inspec
         end
 
         self.resource_name = raw_res_data[:resource_title].instance_variable_get(:@__resource_name__)&.to_s
+        self.resource_params = raw_res_data[:resource_title].instance_variable_get(:@grep)&.to_s
       end
     end
   end

data/lib/inspec/schema.rb

@@ -56,6 +56,7 @@ module Inspec
         "code_desc" => { "type" => "string" },
         "run_time" => { "type" => "number" },
         "start_time" => { "type" => "string" },
+        "resource_class" => { "type" => "string", "optional" => true },
         "skip_message" => { "type" => "string", "optional" => true },
         "resource" => { "type" => "string", "optional" => true },
         "message" => { "type" => "string", "optional" => true },
@@ -194,6 +195,7 @@ module Inspec
         "profile_sha256" => { "type" => "string" },
         "status" => { "type" => "string" },
         "code_desc" => { "type" => "string" },
+        "resource_class" => { "type" => "string", "optional" => true },
         "skip_message" => { "type" => "string", "optional" => true },
         "resource" => { "type" => "string", "optional" => true },
         "message" => { "type" => "string", "optional" => true },

data/lib/inspec/version.rb

@@ -1,3 +1,3 @@
 module Inspec
-  VERSION = "4.23.15".freeze
+  VERSION = "4.24.8".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-core
 version: !ruby/object:Gem::Version
-  version: 4.23.15
+  version: 4.24.8
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-telemetry
@@ -64,26 +64,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: json_schemer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.2.12
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.2.12
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
@@ -130,14 +110,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement