inspec-core 4.20.2 → 4.20.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2395ce22d38edca9eaac2fad00c1fc61f3fb95a154618540d23bc2a1e6ce0fcd
-  data.tar.gz: 4ebdbe5526025408e729b52e0614b43fe89f70b0faae5eeecc8c23db8f0f1ff9
+  metadata.gz: bad597d54eeb47c2f634b9c2bba2fcec8afa0d507e0b321244caee264c3b59cf
+  data.tar.gz: 966803761b3601c83b1d2474b3405b863b245396f8e4962fc950484ed87ee9ea
 SHA512:
-  metadata.gz: f2b21bfbc96b4830edf20f1d48493257845bfbeb52137141269371066c47359092d3ed280cc64e9358b3587d0ddb0c54a643cafd730d57ad2d7ba2331d35b33a
-  data.tar.gz: 84bc11b59621836d20c045efcdee955cc97c605e5902fafaa79c8756dd44f66334731256c6ba4273484d645484f374b1ec2daf471a6dc56805ea819ab2685f38
+  metadata.gz: 2ea62a2de16846b6d3bd1075868e070e41a14d9a8dce9a711155e7d75519eb56fa23238fa4cc3b53a97480396c4bd7a1b20a98251918268a66278c970ab0cda1
+  data.tar.gz: a420f3368a7ae4b6f264f15901848e7615bd6e7fefac559dda3c955d83b7059dd59464e685cef5e4310da2d503e61f72c254739c4a054e7b6f76c7bd5f61ef37

data/Gemfile

@@ -9,7 +9,7 @@ gem "inspec", path: "."
 # in it in order to package the executable. Hence the odd backwards dependency.
 gem "inspec-bin", path: "./inspec-bin"
 
-gem "ffi", [">= 1.9.14", "< 1.13"] # 1.13 does not work on Windows: https://github.com/ffi/ffi/issues/784
+gem "ffi", ">= 1.9.14", "!= 1.13.0"
 
 group :omnibus do
   gem "rb-readline"

data/inspec-core.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday",            ">= 0.9.0"
   spec.add_dependency "tty-table",          "~> 0.10"
   spec.add_dependency "tty-prompt",         "~> 0.17"
-  spec.add_dependency "tomlrb",             "~> 1.2"
+  spec.add_dependency "tomlrb",             "~> 1.2.0"
   spec.add_dependency "addressable",        "~> 2.4"
   spec.add_dependency "parslet",            "~> 1.5"
   spec.add_dependency "semverse",           "~> 3.0"

data/lib/inspec/config.rb

@@ -341,10 +341,8 @@ module Inspec
       # Tracked on https://github.com/inspec/inspec/issues/3667
       inspec_reporters_that_are_not_yet_plugins = %w{
         automate
-        cli
         json
         json-automate
-        json-min
         junit
         yaml
       }
@@ -356,7 +354,12 @@ module Inspec
         .find_activators(plugin_type: :reporter)\
         .map(&:activator_name).map(&:to_s)
 
-      valid_types = rspec_built_in_formatters + inspec_reporters_that_are_not_yet_plugins + plugin_reporters
+      # Include CLI explicitly, because it is the default reporter and will usually not be
+      # present on the command line, and thus its plugin will not appear on the list.
+      valid_types = rspec_built_in_formatters + \
+        inspec_reporters_that_are_not_yet_plugins + \
+        plugin_reporters + \
+        [ "cli" ]
 
       reporters.each do |reporter_name, reporter_config|
         raise NotImplementedError, "'#{reporter_name}' is not a valid reporter type." unless valid_types.include?(reporter_name)

data/lib/inspec/reporters.rb

@@ -1,8 +1,6 @@
 require "inspec/reporters/base"
-require "inspec/reporters/cli"
 require "inspec/reporters/json"
 require "inspec/reporters/json_automate"
-require "inspec/reporters/json_min"
 require "inspec/reporters/junit"
 require "inspec/reporters/automate"
 require "inspec/reporters/yaml"
@@ -13,16 +11,12 @@ module Inspec::Reporters
     name, config = reporter.dup
     config[:run_data] = run_data
     case name
-    when "cli"
-      reporter = Inspec::Reporters::CLI.new(config)
     when "json"
       reporter = Inspec::Reporters::Json.new(config)
     # This reporter is only used for Chef internal. We reserve the
     # right to introduce breaking changes to this reporter at any time.
     when "json-automate"
       reporter = Inspec::Reporters::JsonAutomate.new(config)
-    when "json-min"
-      reporter = Inspec::Reporters::JsonMin.new(config)
     when "junit"
       reporter = Inspec::Reporters::Junit.new(config)
     when "automate"
@@ -60,15 +54,23 @@ module Inspec::Reporters
     case name
     when "json"
       reporter = Inspec::Reporters::Json.new(config)
-    when "json-min"
-      reporter = Inspec::Reporters::JsonMin.new(config)
     when "json-automate"
       reporter = Inspec::Reporters::JsonAutomate.new(config)
     when "yaml"
       reporter = Inspec::Reporters::Yaml.new(config)
     else
-      # use base run_data hash for any other report
-      return run_data
+      # If we made it here, it might be a plugin
+      begin
+        activator = Inspec::Plugin::V2::Registry.instance.find_activator(plugin_type: :reporter, activator_name: name.to_sym)
+        activator.activate!
+        reporter = activator.implementation_class.new(config)
+        unless reporter.respond_to(:report?)
+          return run_data
+        end
+      rescue Inspec::Plugin::V2::LoadError
+        # Must not have been a plugin - just return the run_data
+        return run_data
+      end
     end
 
     reporter.report

data/lib/inspec/run_data.rb

@@ -1,12 +1,19 @@
 
 module Inspec
   module HashLikeStruct
+    # Only list keys whose value are non-nil
     def keys
-      members
+      members.reject { |k| self[k].nil? }
     end
 
+    # Only list non-nil members for backwards compatibility
     def key?(item)
-      members.include?(item)
+      members.include?(item) && non_nil?(item)
+    end
+
+    # This is provided for clarity - many locations make this test
+    def non_nil?(item)
+      !self[item].nil?
     end
   end
 

data/lib/inspec/version.rb

@@ -1,3 +1,3 @@
 module Inspec
-  VERSION = "4.20.2".freeze
+  VERSION = "4.20.6".freeze
 end

data/lib/plugins/inspec-reporter-cli/README.md

@@ -0,0 +1,12 @@
+# cli reporter
+
+This is the implementation of the "cli" reporter. It is the default reporter used if you do not specify a reporter.
+
+## To Install This Plugin
+
+This plugin is included with inspec. There is no need to install it separately.
+
+## What This Plugin Does
+
+This reporter generates a summary of output at the end of the run to STDOUT by default. By default it uses color and terminal graphics if possible, depending on the capabilities of the host platform.
+

data/lib/plugins/inspec-reporter-cli/lib/inspec-reporter-cli.rb

@@ -0,0 +1,13 @@
+require_relative "inspec-reporter-cli/version"
+
+module InspecPlugins
+  module CliReporter
+    class Plugin < ::Inspec.plugin(2)
+      plugin_name :'inspec-reporter-cli'
+      reporter :cli do
+        require_relative "inspec-reporter-cli/reporter"
+        InspecPlugins::CliReporter::Reporter
+      end
+    end
+  end
+end

data/lib/{inspec/reporters/cli.rb → plugins/inspec-reporter-cli/lib/inspec-reporter-cli/reporter.rb}

@@ -1,5 +1,8 @@
-module Inspec::Reporters
-  class CLI < Base
+require "forwardable"
+
+module InspecPlugins::CliReporter
+  class Reporter < Inspec.plugin(2, :reporter)
+
     case RUBY_PLATFORM
     when /windows|mswin|msys|mingw|cygwin/
       # Most currently available Windows terminals have poor support
@@ -40,11 +43,15 @@ module Inspec::Reporters
 
     MULTI_TEST_CONTROL_SUMMARY_MAX_LEN = 60
 
+    def self.run_data_schema_constraints
+      "~> 0.0"
+    end
+
     def render
-      run_data[:profiles].each do |profile|
-        if profile[:status] == "skipped"
-          platform = run_data[:platform]
-          output("Skipping profile: '#{profile[:name]}' on unsupported platform: '#{platform[:name]}/#{platform[:release]}'.")
+      run_data.profiles.each do |profile|
+        if profile.status == "skipped"
+          platform = run_data.platform
+          output("Skipping profile: '#{profile.name}' on unsupported platform: '#{platform.name}/#{platform.release}'.")
           next
         end
         @control_count = 0
@@ -70,9 +77,9 @@ module Inspec::Reporters
     def print_profile_header(profile)
       header = {
         "Profile" => format_profile_name(profile),
-        "Version" => profile[:version] || "(not specified)",
+        "Version" => profile.version || "(not specified)",
       }
-      header["Target"] = run_data[:platform][:target] unless run_data[:platform][:target].nil?
+      header["Target"] = run_data.platform.target unless run_data.platform.target.nil?
       header["Target ID"] = @config["target_id"] unless @config["target_id"].nil?
 
       pad = header.keys.max_by(&:length).length + 1
@@ -84,8 +91,8 @@ module Inspec::Reporters
 
     def print_standard_control_results(profile)
       standard_controls_from_profile(profile).each do |control_from_profile|
-        control = Control.new(control_from_profile)
-        next if control.results.nil?
+        control = ControlForCliDisplay.new(control_from_profile)
+        next if control.results.empty?
 
         output(format_control_header(control))
         control.results.each do |result|
@@ -98,8 +105,8 @@ module Inspec::Reporters
 
     def print_anonymous_control_results(profile)
       anonymous_controls_from_profile(profile).each do |control_from_profile|
-        control = Control.new(control_from_profile)
-        next if control.results.nil?
+        control = ControlForCliDisplay.new(control_from_profile)
+        next if control.results.empty?
 
         output(format_control_header(control))
         control.results.each do |result|
@@ -110,10 +117,10 @@ module Inspec::Reporters
     end
 
     def format_profile_name(profile)
-      if profile[:title].nil?
-        (profile[:name] || "unknown").to_s
+      if profile.title.nil?
+        (profile.name || "unknown").to_s
       else
-        "#{profile[:title]} (#{profile[:name] || "unknown"})"
+        "#{profile.title} (#{profile.name || "unknown"})"
       end
     end
 
@@ -129,16 +136,16 @@ module Inspec::Reporters
     def format_result(control, result, type)
       impact = control.impact_string_for_result(result)
 
-      message = if result[:status] == "skipped"
-                  result[:skip_message]
+      message = if result.status == "skipped"
+                  result.skip_message
                 elsif type == :anonymous
-                  result[:expectation_message]
+                  result.expectation_message
                 else
-                  result[:code_desc]
+                  result.code_desc
                 end
 
       # append any failure details to the message if they exist
-      message += "\n#{result[:message]}" if result[:message]
+      message += "\n#{result.message}" if result.message
 
       format_message(
         color: impact,
@@ -170,9 +177,7 @@ module Inspec::Reporters
 
     def all_unique_controls
       @unique_controls ||= begin
-                             run_data[:profiles].flat_map do |profile|
-                               profile[:controls]
-                             end.uniq
+                             run_data.profiles.flat_map(&:controls).uniq
                            end
     end
 
@@ -182,12 +187,12 @@ module Inspec::Reporters
       passed = 0
 
       all_unique_controls.each do |control|
-        next if control[:id].start_with? "(generated from "
-        next unless control[:results]
+        next if control.id.start_with? "(generated from "
+        next if control.results.empty?
 
-        if control[:results].any? { |r| r[:status] == "failed" }
+        if control.results.any? { |r| r.status == "failed" }
           failed += 1
-        elsif control[:results].any? { |r| r[:status] == "skipped" }
+        elsif control.results.any? { |r| r.status == "skipped" }
           skipped += 1
         else
           passed += 1
@@ -211,12 +216,12 @@ module Inspec::Reporters
       passed = 0
 
       all_unique_controls.each do |control|
-        next unless control[:results]
+        next if control.results.empty?
 
-        control[:results].each do |result|
-          if result[:status] == "failed"
+        control.results.each do |result|
+          if result.status == "failed"
             failed += 1
-          elsif result[:status] == "skipped"
+          elsif result.status == "skipped"
             skipped += 1
           else
             passed += 1
@@ -273,42 +278,30 @@ module Inspec::Reporters
     end
 
     def standard_controls_from_profile(profile)
-      profile[:controls].reject { |c| is_anonymous_control?(c) }
+      profile.controls.reject { |c| is_anonymous_control?(c) }
     end
 
     def anonymous_controls_from_profile(profile)
-      profile[:controls].select { |c| is_anonymous_control?(c) && !c[:results].nil? }
+      profile.controls.select { |c| is_anonymous_control?(c) && !c[:results].nil? }
     end
 
     def is_anonymous_control?(control)
-      control[:id].start_with?("(generated from ")
+      control.id.start_with?("(generated from ")
     end
 
     def indent_lines(message, indentation)
       message.lines.map { |line| " " * indentation + line }.join
     end
 
-    class Control
-      attr_reader :data
+    class ControlForCliDisplay
 
-      def initialize(control_hash)
-        @data = control_hash
-      end
+      extend Forwardable
 
-      def id
-        data[:id]
-      end
-
-      def title
-        data[:title]
-      end
-
-      def results
-        data[:results]
-      end
+      attr_reader :control_obj
+      def_delegators :@control_obj, :id, :impact, :results, :title
 
-      def impact
-        data[:impact]
+      def initialize(control_obj)
+        @control_obj = control_obj
       end
 
       def anonymous?
@@ -317,9 +310,9 @@ module Inspec::Reporters
 
       def title_for_report
         # if this is an anonymous control, just grab the resource title from any result entry
-        return results.first[:resource_title] if anonymous?
+        return results.first.resource_title if anonymous?
 
-        title_for_report = "#{id}: #{title || results.first[:resource_title]}"
+        title_for_report = "#{id}: #{title || results.first.resource_title}"
 
         # we will not add any additional data to the title if there's only
         # zero or one test for this control.
@@ -337,9 +330,9 @@ module Inspec::Reporters
           nil
         elsif impact.nil?
           "unknown"
-        elsif results&.find { |r| r[:status] == "skipped" }
+        elsif results&.find { |r| r.status == "skipped" }
           "skipped"
-        elsif results.nil? || results.empty? || results.all? { |r| r[:status] == "passed" }
+        elsif results.empty? || results.all? { |r| r.status == "passed" }
           "passed"
         else
           "failed"
@@ -347,9 +340,9 @@ module Inspec::Reporters
       end
 
       def impact_string_for_result(result)
-        if result[:status] == "skipped"
+        if result.status == "skipped"
           "skipped"
-        elsif result[:status] == "passed"
+        elsif result.status == "passed"
           "passed"
         elsif impact.nil?
           "unknown"
@@ -359,11 +352,11 @@ module Inspec::Reporters
       end
 
       def failure_count
-        results.select { |r| r[:status] == "failed" }.size
+        results.select { |r| r.status == "failed" }.size
       end
 
       def skipped_count
-        results.select { |r| r[:status] == "skipped" }.size
+        results.select { |r| r.status == "skipped" }.size
       end
     end
   end

data/lib/plugins/inspec-reporter-cli/lib/inspec-reporter-cli/version.rb

@@ -0,0 +1,5 @@
+module InspecPlugins
+  module CliReporter
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/plugins/inspec-reporter-json-min/README.md

@@ -0,0 +1,10 @@
+# JSON Minimal Reporter Plugin
+
+## To Install This Plugin
+
+This plugin is included with InSpec. There is no need to install it.
+
+## What This Plugin Does
+
+This plugin provides the `json-min` reporter, which produces test output in JSON format with less detail than the `json` reporter.
+

data/lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min.rb

@@ -0,0 +1,13 @@
+require_relative "inspec-reporter-json-min/version"
+
+module InspecPlugins
+  module JsonMinReporter
+    class Plugin < ::Inspec.plugin(2)
+      plugin_name :"inspec-reporter-json-min"
+      reporter :"json-min" do
+        require_relative "inspec-reporter-json-min/reporter"
+        InspecPlugins::JsonMinReporter::Reporter
+      end
+    end
+  end
+end

data/lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min/reporter.rb

@@ -0,0 +1,50 @@
+require "json"
+
+module InspecPlugins::JsonMinReporter
+  class Reporter < Inspec.plugin(2, :reporter)
+    def self.run_data_schema_constraints
+      "~> 0.0"
+    end
+
+    def render
+      output(report.to_json, false)
+    end
+
+    def report # rubocop:disable Metrics/AbcSize
+      report = {
+        controls: [],
+        statistics: { duration: run_data.statistics.duration },
+        version: run_data.version,
+      }
+
+      # collect all test results and add them to the report
+      run_data.profiles.each do |profile|
+        profile_id = profile.name
+
+        profile.controls.each do |control|
+          control_id = control.id
+
+          control.results.each do |result|
+            result_for_report = {
+              id: control_id,
+              profile_id: profile_id,
+              profile_sha256: profile.sha256,
+              status: result.status,
+              code_desc: result.code_desc,
+            }
+
+            result_for_report[:skip_message] = result.skip_message if result.non_nil?(:skip_message)
+            result_for_report[:resource] = result.resource if result.non_nil?(:resource)
+            result_for_report[:message] = result.message if result.non_nil?(:message)
+            result_for_report[:exception] = result.exception if result.non_nil?(:exception)
+            result_for_report[:backtrace] = result.backtrace if result.non_nil?(:backtrace)
+
+            report[:controls] << result_for_report
+          end
+        end
+      end
+
+      report
+    end
+  end
+end

data/lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min/version.rb

@@ -0,0 +1,5 @@
+module InspecPlugins
+  module JsonMinReporter
+    VERSION = "0.1.0".freeze
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-core
 version: !ruby/object:Gem::Version
-  version: 4.20.2
+  version: 4.20.6
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-telemetry
@@ -264,14 +264,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -480,10 +480,8 @@ files:
 - lib/inspec/reporters.rb
 - lib/inspec/reporters/automate.rb
 - lib/inspec/reporters/base.rb
-- lib/inspec/reporters/cli.rb
 - lib/inspec/reporters/json.rb
 - lib/inspec/reporters/json_automate.rb
-- lib/inspec/reporters/json_min.rb
 - lib/inspec/reporters/junit.rb
 - lib/inspec/reporters/yaml.rb
 - lib/inspec/require_loader.rb
@@ -724,6 +722,14 @@ files:
 - lib/plugins/inspec-plugin-manager-cli/lib/inspec-plugin-manager-cli.rb
 - lib/plugins/inspec-plugin-manager-cli/lib/inspec-plugin-manager-cli/cli_command.rb
 - lib/plugins/inspec-plugin-manager-cli/lib/inspec-plugin-manager-cli/plugin.rb
+- lib/plugins/inspec-reporter-cli/README.md
+- lib/plugins/inspec-reporter-cli/lib/inspec-reporter-cli.rb
+- lib/plugins/inspec-reporter-cli/lib/inspec-reporter-cli/reporter.rb
+- lib/plugins/inspec-reporter-cli/lib/inspec-reporter-cli/version.rb
+- lib/plugins/inspec-reporter-json-min/README.md
+- lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min.rb
+- lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min/reporter.rb
+- lib/plugins/inspec-reporter-json-min/lib/inspec-reporter-json-min/version.rb
 - lib/plugins/shared/core_plugin_test_helper.rb
 - lib/plugins/things-for-train-integration.rb
 - lib/source_readers/flat.rb

data/lib/inspec/reporters/json_min.rb

@@ -1,48 +0,0 @@
-require "json"
-
-module Inspec::Reporters
-  class JsonMin < Base
-    def render
-      output(report.to_json, false)
-    end
-
-    def report # rubocop:disable Metrics/AbcSize
-      report = {
-        controls: [],
-        statistics: { duration: run_data[:statistics][:duration] },
-        version: run_data[:version],
-      }
-
-      # collect all test results and add them to the report
-      run_data[:profiles].each do |profile|
-        profile_id = profile[:name]
-        next unless profile[:controls]
-
-        profile[:controls].each do |control|
-          control_id = control[:id]
-          next unless control[:results]
-
-          control[:results].each do |result|
-            result_for_report = {
-              id: control_id,
-              profile_id: profile_id,
-              profile_sha256: profile[:sha256],
-              status: result[:status],
-              code_desc: result[:code_desc],
-            }
-
-            result_for_report[:skip_message] = result[:skip_message] if result.key?(:skip_message)
-            result_for_report[:resource] = result[:resource] if result.key?(:resource)
-            result_for_report[:message] = result[:message] if result.key?(:message)
-            result_for_report[:exception] = result[:exception] if result.key?(:exception)
-            result_for_report[:backtrace] = result[:backtrace] if result.key?(:backtrace)
-
-            report[:controls] << result_for_report
-          end
-        end
-      end
-
-      report
-    end
-  end
-end