inspec 1.51.25 → 2.0.16

data/lib/inspec/cli.rb

@@ -162,12 +162,6 @@ class Inspec::InspecCLI < Inspec::BaseCLI
     diagnose(o)
     configure_logger(o)
 
-    # TODO: REMOVE for inspec 2.0
-    if o.key?('cache')
-      o[:vendor_cache] = o[:cache]
-      o[:logger].warn '[DEPRECATED] The use of `--cache` is being deprecated in InSpec 2.0. Please use `--vendor-cache` instead.'
-    end
-
     runner = Inspec::Runner.new(o)
     targets.each { |target| runner.add_target(target) }
 
@@ -184,17 +178,27 @@ class Inspec::InspecCLI < Inspec::BaseCLI
   option :format, type: :string
   def detect
     o = opts(:detect).dup
-    o[:command] = 'os.params'
+    o[:command] = 'platform.params'
     (_, res) = run_command(o)
     if o['format'] == 'json'
       puts res.to_json
     else
-      headline('Operating System Details')
-      %w{name family release arch}.each { |item|
-        puts format('%-10s %s', item.to_s.capitalize + ':',
-                    mark_text(res[item.to_sym]))
+      headline('Platform Details')
+      %w{name families release arch}.each { |item|
+        data = res[item.to_sym]
+
+        # Format Array for better output if applicable
+        data = data.join(', ') if data.is_a?(Array)
+
+        # Do not output fields of data is missing ('unknown' is fine)
+        next if data.nil?
+
+        puts format('%-10s %s', item.to_s.capitalize + ':', mark_text(data))
       }
     end
+  rescue ArgumentError, RuntimeError, Train::UserError => e
+    $stderr.puts e.message
+    exit 1
   rescue StandardError => e
     pretty_handle_exception(e)
   end

data/lib/inspec/formatters/base.rb

@@ -23,6 +23,7 @@ module Inspec::Formatters
       run_data[:version] = Inspec::VERSION
       run_data[:statistics] = {
         duration: summary.duration,
+        controls: statistics,
       }
     end
 
@@ -84,6 +85,47 @@ module Inspec::Formatters
 
     private
 
+    def all_unique_controls
+      unique_controls = Set.new
+      run_data[:profiles].each do |profile|
+        profile[:controls].map { |control| unique_controls.add(control) }
+      end
+
+      unique_controls
+    end
+
+    def statistics
+      failed = 0
+      skipped = 0
+      passed = 0
+
+      all_unique_controls.each do |control|
+        next unless control[:results]
+        if control[:results].any? { |r| r[:status] == 'failed' }
+          failed += 1
+        elsif control[:results].any? { |r| r[:status] == 'skipped' }
+          skipped += 1
+        else
+          passed += 1
+        end
+      end
+
+      total = failed + passed + skipped
+
+      {
+        total: total,
+        passed: {
+          total: passed,
+        },
+        skipped: {
+          total: skipped,
+        },
+        failed: {
+          total: failed,
+        },
+      }
+    end
+
     def exception_message(exception)
       if exception.is_a?(RSpec::Core::MultipleExceptionError)
         exception.all_exceptions.map(&:message).uniq.join("\n\n")
@@ -111,7 +153,7 @@ module Inspec::Formatters
         status: example.execution_result.status.to_s,
         code_desc: code_description,
         run_time: example.execution_result.run_time,
-        start_time: example.execution_result.started_at.to_s,
+        start_time: example.execution_result.started_at.to_datetime.rfc3339.to_s,
         resource_title: example.metadata[:described_class] || example.metadata[:example_group][:description],
         expectation_message: format_expectation_message(example),
       }

data/lib/inspec/metadata.rb

@@ -54,15 +54,9 @@ module Inspec
     end
 
     def inspec_requirement
-      inspec_in_supports = params[:supports].find { |x| !x[:inspec].nil? }
-      if inspec_in_supports
-        warn '[DEPRECATED] The use of inspec.yml `supports:inspec` is deprecated and will be removed in InSpec 2.0. Please use `inspec_version` instead.'
-        Gem::Requirement.create(inspec_in_supports[:inspec])
-      else
-        # using Gem::Requirement here to allow nil values which
-        # translate to [">= 0"]
-        Gem::Requirement.create(params[:inspec_version])
-      end
+      # using Gem::Requirement here to allow nil values which
+      # translate to [">= 0"]
+      Gem::Requirement.create(params[:inspec_version])
     end
 
     def supports_runtime?

data/lib/inspec/plugins/resource.rb

@@ -43,7 +43,7 @@ module Inspec
       Inspec::Resource.registry
     end
 
-    def __register(name, obj) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def __register(name, obj) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       cl = Class.new(obj) do # rubocop:disable Metrics/BlockLength
         attr_reader :resource_exception_message
 
@@ -57,7 +57,14 @@ module Inspec
           @__resource_name__ = name
 
           # check resource supports
-          check_supports unless @supports.nil?
+          supported = true
+          supported = check_supports unless @supports.nil?
+          if defined?(Train::Transports::Mock::Connection) && backend.backend.class == Train::Transports::Mock::Connection
+            # do not exit out for tests
+          elsif supported == false
+            # do not run resource initalize if we are unsupported
+            return
+          end
 
           # call the resource initializer
           begin
@@ -83,6 +90,7 @@ module Inspec
           status = inspec.platform.supported?(@supports)
           skip_msg = "Resource #{@__resource_name__.capitalize} is not supported on platform #{inspec.platform.name}/#{inspec.platform.release}."
           skip_resource(skip_msg) unless status
+          status
         end
 
         def skip_resource(message)
@@ -94,13 +102,6 @@ module Inspec
           @resource_skipped
         end
 
-        def resource_skipped
-          warn('[DEPRECATION] Use `resource_exception_message` for the resource skipped message. This method will be removed in InSpec 2.0.')
-          # Returning `nil` here to match previous behavior
-          return nil if @resource_skipped == false
-          @resource_exception_message
-        end
-
         def fail_resource(message)
           @resource_failed = true
           @resource_exception_message = message

data/lib/inspec/reporters/cli.rb

@@ -7,9 +7,6 @@ module Inspec::Reporters
       # Most currently available Windows terminals have poor support
       # for ANSI extended colors
       COLORS = {
-        'critical' => "\033[0;1;31m",
-        'major'    => "\033[0;1;31m",
-        'minor'    => "\033[0;36m",
         'failed'   => "\033[0;1;31m",
         'passed'   => "\033[0;1;32m",
         'skipped'  => "\033[0;37m",
@@ -19,9 +16,6 @@ module Inspec::Reporters
       # Most currently available Windows terminals have poor support
       # for UTF-8 characters so use these boring indicators
       INDICATORS = {
-        'critical' => '[CRIT]',
-        'major'    => '[MAJR]',
-        'minor'    => '[MINR]',
         'failed'   => '[FAIL]',
         'skipped'  => '[SKIP]',
         'passed'   => '[PASS]',
@@ -30,9 +24,6 @@ module Inspec::Reporters
     else
       # Extended colors for everyone else
       COLORS = {
-        'critical' => "\033[38;5;9m",
-        'major'    => "\033[38;5;208m",
-        'minor'    => "\033[0;36m",
         'failed'   => "\033[38;5;9m",
         'passed'   => "\033[38;5;41m",
         'skipped'  => "\033[38;5;247m",
@@ -42,9 +33,6 @@ module Inspec::Reporters
       # Groovy UTF-8 characters for everyone else...
       # ...even though they probably only work on Mac
       INDICATORS = {
-        'critical' => '×',
-        'major'    => '∅',
-        'minor'    => '⊚',
         'failed'   => '×',
         'skipped'  => '↺',
         'passed'   => '✔',
@@ -177,27 +165,15 @@ module Inspec::Reporters
     end
 
     def profile_summary
-      return @profile_summary unless @profile_summary.nil?
-
       failed = 0
       skipped = 0
       passed = 0
-      critical = 0
-      major = 0
-      minor = 0
 
       all_unique_controls.each do |control|
         next if control[:id].start_with? '(generated from '
         next unless control[:results]
         if control[:results].any? { |r| r[:status] == 'failed' }
           failed += 1
-          if control[:impact] >= 0.7
-            critical += 1
-          elsif control[:impact] >= 0.4
-            major += 1
-          else
-            minor += 1
-          end
         elsif control[:results].any? { |r| r[:status] == 'skipped' }
           skipped += 1
         else
@@ -207,22 +183,15 @@ module Inspec::Reporters
 
       total = failed + passed + skipped
 
-      @profile_summary = {
+      {
         'total' => total,
-        'failed' => {
-          'total' => failed,
-          'critical' => critical,
-          'major' => major,
-          'minor' => minor,
-        },
+        'failed' => failed,
         'skipped' => skipped,
         'passed' => passed,
       }
     end
 
     def tests_summary
-      return @tests_summary unless @tests_summary.nil?
-
       total = 0
       failed = 0
       skipped = 0
@@ -241,7 +210,12 @@ module Inspec::Reporters
         end
       end
 
-      @tests_summary = { 'total' => total, 'failed' => failed, 'skipped' => skipped, 'passed' => passed }
+      {
+        'total' => total,
+        'failed' => failed,
+        'skipped' => skipped,
+        'passed' => passed,
+      }
     end
 
     def print_profile_summary
@@ -249,11 +223,11 @@ module Inspec::Reporters
       return unless summary['total'] > 0
 
       success_str = summary['passed'] == 1 ? '1 successful control' : "#{summary['passed']} successful controls"
-      failed_str  = summary['failed']['total'] == 1 ? '1 control failure' : "#{summary['failed']['total']} control failures"
+      failed_str  = summary['failed'] == 1 ? '1 control failure' : "#{summary['failed']} control failures"
       skipped_str = summary['skipped'] == 1 ? '1 control skipped' : "#{summary['skipped']} controls skipped"
 
       success_color = summary['passed'] > 0 ? 'passed' : 'no_color'
-      failed_color = summary['failed']['total'] > 0 ? 'failed' : 'no_color'
+      failed_color = summary['failed'] > 0 ? 'failed' : 'no_color'
       skipped_color = summary['skipped'] > 0 ? 'skipped' : 'no_color'
 
       s = format(
@@ -301,11 +275,6 @@ module Inspec::Reporters
     end
 
     class Control
-      IMPACT_SCORES = {
-        critical: 0.7,
-        major: 0.4,
-      }.freeze
-
       attr_reader :data
 
       def initialize(control_hash)
@@ -358,12 +327,8 @@ module Inspec::Reporters
           'skipped'
         elsif results.nil? || results.empty? || results.all? { |r| r[:status] == 'passed' }
           'passed'
-        elsif impact >= IMPACT_SCORES[:critical]
-          'critical'
-        elsif impact >= IMPACT_SCORES[:major]
-          'major'
         else
-          'minor'
+          'failed'
         end
       end
 
@@ -374,12 +339,8 @@ module Inspec::Reporters
           'passed'
         elsif impact.nil?
           'unknown'
-        elsif impact >= IMPACT_SCORES[:critical]
-          'critical'
-        elsif impact >= IMPACT_SCORES[:major]
-          'major'
         else
-          'minor'
+          'failed'
         end
       end
 

data/lib/inspec/reporters/json.rb

@@ -12,10 +12,10 @@ module Inspec::Reporters
       {
         platform: platform,
         profiles: profiles,
-        statistics: { duration: run_data[:statistics][:duration] },
+        statistics: {
+          duration: run_data[:statistics][:duration],
+        },
         version: run_data[:version],
-        controls: controls,
-        other_checks: run_data[:other_checks],
       }
     end
 
@@ -28,28 +28,6 @@ module Inspec::Reporters
       }
     end
 
-    def controls
-      controls = []
-      return controls if run_data[:controls].nil?
-
-      run_data[:controls].each do |c|
-        control = {
-          status: c[:status],
-          start_time: c[:start_time],
-          run_time: c[:run_time],
-          code_desc: c[:code_desc],
-        }
-        control[:resource] = c[:resource] if c[:resource]
-        control[:skip_message] = c[:skip_message] if c[:skip_message]
-        control[:message] = c[:message] if c[:message]
-        control[:exception] = c[:exception] if c[:exception]
-        control[:backtrace] = c[:backtrace] if c[:backtrace]
-
-        controls << control
-      end
-      controls
-    end
-
     def profile_results(control)
       results = []
       return results if control[:results].nil?
@@ -127,7 +105,6 @@ module Inspec::Reporters
           copyright_email: p[:copyright_email],
           supports: p[:supports],
           attributes: p[:attributes],
-          depends: p[:depends],
           groups: profile_groups(p),
           controls: profile_controls(p),
         }