inspec 4.3.2 → 4.6.3

data/lib/inspec/profile_vendor.rb

@@ -1,8 +1,5 @@
-# encoding: utf-8
-# author: Adam Leff
-
-require 'inspec/profile'
-require 'inspec/config'
+require "inspec/profile"
+require "inspec/config"
 
 module Inspec
   class ProfileVendor
@@ -34,11 +31,11 @@ module Inspec
     end
 
     def cache_path
-      profile_path.join('vendor')
+      profile_path.join("vendor")
     end
 
     def lockfile
-      profile_path.join('inspec.lock')
+      profile_path.join("inspec.lock")
     end
 
     private
@@ -66,10 +63,10 @@ module Inspec
     end
 
     def extract_archives
-      Dir.glob(File.join(cache_path, '*')).each do |filepath|
+      Dir.glob(File.join(cache_path, "*")).each do |filepath|
         # Get SHA without extension
         # We use split since '.' is not valid in a SHA checksum
-        destination_dir_name = File.basename(filepath).split('.')[0]
+        destination_dir_name = File.basename(filepath).split(".")[0]
         destination_path = File.join(cache_path, destination_dir_name)
 
         provider = FileProvider.for_path(filepath)

data/lib/inspec/reporters.rb

@@ -1,11 +1,11 @@
-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'
+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"
 
 module Inspec::Reporters
   # rubocop:disable Metrics/CyclomaticComplexity
@@ -13,21 +13,21 @@ module Inspec::Reporters
     name, config = reporter.dup
     config[:run_data] = run_data
     case name
-    when 'cli'
+    when "cli"
       reporter = Inspec::Reporters::CLI.new(config)
-    when 'json'
+    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'
+    when "json-automate"
       reporter = Inspec::Reporters::JsonAutomate.new(config)
-    when 'json-min'
+    when "json-min"
       reporter = Inspec::Reporters::JsonMin.new(config)
-    when 'junit'
+    when "junit"
       reporter = Inspec::Reporters::Junit.new(config)
-    when 'automate'
+    when "automate"
       reporter = Inspec::Reporters::Automate.new(config)
-    when 'yaml'
+    when "yaml"
       reporter = Inspec::Reporters::Yaml.new(config)
     else
       raise NotImplementedError, "'#{name}' is not a valid reporter type."
@@ -39,15 +39,15 @@ module Inspec::Reporters
     reporter.render
     output = reporter.rendered_output
 
-    if config['file']
+    if config["file"]
       # create destination directory if it does not exist
-      dirname = File.dirname(config['file'])
+      dirname = File.dirname(config["file"])
       FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
 
-      File.write(config['file'], output)
-    elsif config['stdout'] == true
+      File.write(config["file"], output)
+    elsif config["stdout"] == true
       print output
-      STDOUT.flush
+      $stdout.flush
     end
   end
 
@@ -55,13 +55,13 @@ module Inspec::Reporters
     name, config = reporter.dup
     config[:run_data] = run_data
     case name
-    when 'json'
+    when "json"
       reporter = Inspec::Reporters::Json.new(config)
-    when 'json-min'
+    when "json-min"
       reporter = Inspec::Reporters::JsonMin.new(config)
-    when 'json-automate'
+    when "json-automate"
       reporter = Inspec::Reporters::JsonAutomate.new(config)
-    when 'yaml'
+    when "yaml"
       reporter = Inspec::Reporters::Yaml.new(config)
     else
       # use base run_data hash for any other report

data/lib/inspec/reporters/automate.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
-require 'json'
-require 'net/http'
+require "json"
+require "net/http"
 
 module Inspec::Reporters
   class Automate < JsonAutomate
@@ -9,10 +7,10 @@ module Inspec::Reporters
       super(config)
 
       # allow the insecure flag
-      @config['verify_ssl'] = !@config['insecure'] if @config.key?('insecure')
+      @config["verify_ssl"] = !@config["insecure"] if @config.key?("insecure")
 
       # default to not verifying ssl for sending reports
-      @config['verify_ssl'] = @config['verify_ssl'] || false
+      @config["verify_ssl"] = @config["verify_ssl"] || false
     end
 
     def enriched_report
@@ -20,30 +18,30 @@ module Inspec::Reporters
       final_report = report
 
       # Label this content as an inspec_report
-      final_report[:type] = 'inspec_report'
+      final_report[:type] = "inspec_report"
 
-      final_report[:end_time] = Time.now.utc.strftime('%FT%TZ')
-      final_report[:node_uuid] = @config['node_uuid'] || @config['target_id']
-      raise Inspec::ReporterError, 'Cannot find a UUID for your node. Please specify one via json-config.' if final_report[:node_uuid].nil?
+      final_report[:end_time] = Time.now.utc.strftime("%FT%TZ")
+      final_report[:node_uuid] = @config["node_uuid"] || @config["target_id"]
+      raise Inspec::ReporterError, "Cannot find a UUID for your node. Please specify one via json-config." if final_report[:node_uuid].nil?
 
-      final_report[:report_uuid] = @config['report_uuid'] || uuid_from_string(final_report[:end_time] + final_report[:node_uuid])
+      final_report[:report_uuid] = @config["report_uuid"] || uuid_from_string(final_report[:end_time] + final_report[:node_uuid])
 
       final_report
     end
 
     def send_report
-      headers = { 'Content-Type' => 'application/json' }
-      headers['x-data-collector-token'] = @config['token']
-      headers['x-data-collector-auth'] = 'version=1.0'
+      headers = { "Content-Type" => "application/json" }
+      headers["x-data-collector-token"] = @config["token"]
+      headers["x-data-collector-auth"] = "version=1.0"
 
-      uri = URI(@config['url'])
+      uri = URI(@config["url"])
       req = Net::HTTP::Post.new(uri.path, headers)
       req.body = enriched_report.to_json
       begin
         Inspec::Log.debug "Posting report to Chef Automate: #{uri.path}"
         http = Net::HTTP.new(uri.hostname, uri.port)
-        http.use_ssl = uri.scheme == 'https'
-        if @config['verify_ssl'] == true
+        http.use_ssl = uri.scheme == "https"
+        if @config["verify_ssl"] == true
           http.verify_mode = OpenSSL::SSL::VERIFY_PEER
         else
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -70,11 +68,11 @@ module Inspec::Reporters
     def uuid_from_string(string)
       hash = Digest::SHA1.new
       hash.update(string)
-      ary = hash.digest.unpack('NnnnnN')
+      ary = hash.digest.unpack("NnnnnN")
       ary[2] = (ary[2] & 0x0FFF) | (5 << 12)
       ary[3] = (ary[3] & 0x3FFF) | 0x8000
       # rubocop:disable Style/FormatString
-      '%08x-%04x-%04x-%04x-%04x%08x' % ary
+      "%08x-%04x-%04x-%04x-%04x%08x" % ary
     end
   end
 end

data/lib/inspec/reporters/base.rb

@@ -5,7 +5,7 @@ module Inspec::Reporters
     def initialize(config)
       @config = config
       @run_data = config[:run_data]
-      @output = ''
+      @output = ""
     end
 
     def output(str, newline = true)

data/lib/inspec/reporters/cli.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Inspec::Reporters
   class CLI < Base
     case RUBY_PLATFORM
@@ -7,36 +5,36 @@ module Inspec::Reporters
       # Most currently available Windows terminals have poor support
       # for ANSI extended colors
       COLORS = {
-        'failed'   => "\033[0;1;31m",
-        'passed'   => "\033[0;1;32m",
-        'skipped'  => "\033[0;37m",
-        'reset'    => "\033[0m",
+        "failed" => "\033[0;1;31m",
+        "passed" => "\033[0;1;32m",
+        "skipped" => "\033[0;37m",
+        "reset" => "\033[0m",
       }.freeze
 
       # Most currently available Windows terminals have poor support
       # for UTF-8 characters so use these boring indicators
       INDICATORS = {
-        'failed'   => '[FAIL]',
-        'skipped'  => '[SKIP]',
-        'passed'   => '[PASS]',
-        'unknown'  => '[UNKN]',
+        "failed" => "[FAIL]",
+        "skipped" => "[SKIP]",
+        "passed" => "[PASS]",
+        "unknown" => "[UNKN]",
       }.freeze
     else
       # Extended colors for everyone else
       COLORS = {
-        'failed'   => "\033[38;5;9m",
-        'passed'   => "\033[38;5;41m",
-        'skipped'  => "\033[38;5;247m",
-        'reset'    => "\033[0m",
+        "failed" => "\033[38;5;9m",
+        "passed" => "\033[38;5;41m",
+        "skipped" => "\033[38;5;247m",
+        "reset" => "\033[0m",
       }.freeze
 
       # Groovy UTF-8 characters for everyone else...
       # ...even though they probably only work on Mac
       INDICATORS = {
-        'failed'   => '×',
-        'skipped'  => '↺',
-        'passed'   => '✔',
-        'unknown'  => '?',
+        "failed" => "×",
+        "skipped" => "↺",
+        "passed" => "✔",
+        "unknown" => "?",
       }.freeze
     end
 
@@ -44,23 +42,25 @@ module Inspec::Reporters
 
     def render
       run_data[:profiles].each do |profile|
-        if profile[:status] == 'skipped'
+        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
-        output('')
+        output("")
         print_profile_header(profile)
         print_standard_control_results(profile)
         print_anonymous_control_results(profile)
-        output(format_message(
-                 indentation: 5,
-                 message: 'No tests executed.',
-        )) if @control_count == 0
+        if @control_count == 0
+          output(format_message(
+                   indentation: 5,
+                   message: "No tests executed."
+          ))
+        end
       end
 
-      output('')
+      output("")
       print_profile_summary
       print_tests_summary
     end
@@ -69,17 +69,17 @@ module Inspec::Reporters
 
     def print_profile_header(profile)
       header = {
-        'Profile' => format_profile_name(profile),
-        'Version' => profile[:version] || '(not specified)',
+        "Profile" => format_profile_name(profile),
+        "Version" => profile[:version] || "(not specified)",
       }
-      header['Target'] = run_data[:platform][:target] unless run_data[:platform][:target].nil?
-      header['Target ID'] = @config['target_id'] unless @config['target_id'].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
       header.each do |title, value|
-        output(format("%-#{pad}s %s", title + ':', value))
+        output(format("%-#{pad}s %s", title + ":", value))
       end
-      output('')
+      output("")
     end
 
     def print_standard_control_results(profile)
@@ -92,7 +92,7 @@ module Inspec::Reporters
           @control_count += 1
         end
       end
-      output('') if @control_count > 0
+      output("") if @control_count > 0
     end
 
     def print_anonymous_control_results(profile)
@@ -109,7 +109,7 @@ module Inspec::Reporters
 
     def format_profile_name(profile)
       if profile[:title].nil?
-        (profile[:name] || 'unknown').to_s
+        (profile[:name] || "unknown").to_s
       else
         "#{profile[:title]} (#{profile[:name] || 'unknown'})"
       end
@@ -120,14 +120,14 @@ module Inspec::Reporters
       format_message(
         color: impact,
         indicator: impact,
-        message: control.title_for_report,
+        message: control.title_for_report
       )
     end
 
     def format_result(control, result, type)
       impact = control.impact_string_for_result(result)
 
-      message = if result[:status] == 'skipped'
+      message = if result[:status] == "skipped"
                   result[:skip_message]
                 elsif type == :anonymous
                   result[:expectation_message]
@@ -142,7 +142,7 @@ module Inspec::Reporters
         color: impact,
         indicator: impact,
         indentation: 5,
-        message: message,
+        message: message
       )
     end
 
@@ -152,7 +152,7 @@ module Inspec::Reporters
       indentation = message_info.fetch(:indentation, 2)
       message = message_info[:message]
 
-      message_to_format = ''
+      message_to_format = ""
       message_to_format += "#{INDICATORS[indicator]}  " unless indicator.nil?
       message_to_format += message.to_s.lstrip.force_encoding(Encoding::UTF_8)
 
@@ -167,14 +167,11 @@ module Inspec::Reporters
     end
 
     def all_unique_controls
-      return @unique_controls unless @unique_controls.nil?
-
-      @unique_controls = Set.new
-      run_data[:profiles].each do |profile|
-        profile[:controls].map { |control| @unique_controls.add(control) }
-      end
-
-      @unique_controls
+      @unique_controls ||= begin
+                             run_data[:profiles].flat_map do |profile|
+                               profile[:controls]
+                             end.uniq
+                           end
     end
 
     def profile_summary
@@ -183,11 +180,11 @@ module Inspec::Reporters
       passed = 0
 
       all_unique_controls.each do |control|
-        next if control[:id].start_with? '(generated from '
+        next if control[:id].start_with? "(generated from "
         next unless control[:results]
-        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
@@ -197,10 +194,10 @@ module Inspec::Reporters
       total = failed + passed + skipped
 
       {
-        'total' => total,
-        'failed' => failed,
-        'skipped' => skipped,
-        'passed' => passed,
+        "total" => total,
+        "failed" => failed,
+        "skipped" => skipped,
+        "passed" => passed,
       }
     end
 
@@ -213,9 +210,9 @@ module Inspec::Reporters
       all_unique_controls.each do |control|
         next unless control[:results]
         control[:results].each do |result|
-          if result[:status] == 'failed'
+          if result[:status] == "failed"
             failed += 1
-          elsif result[:status] == 'skipped'
+          elsif result[:status] == "skipped"
             skipped += 1
           else
             passed += 1
@@ -224,48 +221,48 @@ module Inspec::Reporters
       end
 
       {
-        'total' => total,
-        'failed' => failed,
-        'skipped' => skipped,
-        'passed' => passed,
+        "total" => total,
+        "failed" => failed,
+        "skipped" => skipped,
+        "passed" => passed,
       }
     end
 
     def print_profile_summary
       summary = profile_summary
-      return unless summary['total'] > 0
+      return unless summary["total"] > 0
 
-      success_str = summary['passed'] == 1 ? '1 successful control' : "#{summary['passed']} successful controls"
-      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_str = summary["passed"] == 1 ? "1 successful control" : "#{summary['passed']} successful controls"
+      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'] > 0 ? 'failed' : 'no_color'
-      skipped_color = summary['skipped'] > 0 ? 'skipped' : 'no_color'
+      success_color = summary["passed"] > 0 ? "passed" : "no_color"
+      failed_color = summary["failed"] > 0 ? "failed" : "no_color"
+      skipped_color = summary["skipped"] > 0 ? "skipped" : "no_color"
 
       s = format(
-        'Profile Summary: %s, %s, %s',
+        "Profile Summary: %s, %s, %s",
         format_with_color(success_color, success_str),
         format_with_color(failed_color, failed_str),
-        format_with_color(skipped_color, skipped_str),
+        format_with_color(skipped_color, skipped_str)
       )
-      output(s) if summary['total'] > 0
+      output(s) if summary["total"] > 0
     end
 
     def print_tests_summary
       summary = tests_summary
 
-      failed_str = summary['failed'] == 1 ? '1 failure' : "#{summary['failed']} failures"
+      failed_str = summary["failed"] == 1 ? "1 failure" : "#{summary['failed']} failures"
 
-      success_color = summary['passed'] > 0 ? 'passed' : 'no_color'
-      failed_color = summary['failed'] > 0 ? 'failed' : 'no_color'
-      skipped_color = summary['skipped'] > 0 ? 'skipped' : 'no_color'
+      success_color = summary["passed"] > 0 ? "passed" : "no_color"
+      failed_color = summary["failed"] > 0 ? "failed" : "no_color"
+      skipped_color = summary["skipped"] > 0 ? "skipped" : "no_color"
 
       s = format(
-        'Test Summary: %s, %s, %s',
+        "Test Summary: %s, %s, %s",
         format_with_color(success_color, "#{summary['passed']} successful"),
         format_with_color(failed_color, failed_str),
-        format_with_color(skipped_color, "#{summary['skipped']} skipped"),
+        format_with_color(skipped_color, "#{summary['skipped']} skipped")
       )
 
       output(s)
@@ -280,11 +277,11 @@ module Inspec::Reporters
     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
+      message.lines.map { |line| " " * indentation + line }.join
     end
 
     class Control
@@ -311,7 +308,7 @@ module Inspec::Reporters
       end
 
       def anonymous?
-        id.start_with?('(generated from ')
+        id.start_with?("(generated from ")
       end
 
       def title_for_report
@@ -335,34 +332,34 @@ module Inspec::Reporters
         if anonymous?
           nil
         elsif impact.nil?
-          'unknown'
-        elsif results&.find { |r| r[:status] == 'skipped' }
-          'skipped'
-        elsif results.nil? || results.empty? || results.all? { |r| r[:status] == 'passed' }
-          'passed'
+          "unknown"
+        elsif results&.find { |r| r[:status] == "skipped" }
+          "skipped"
+        elsif results.nil? || results.empty? || results.all? { |r| r[:status] == "passed" }
+          "passed"
         else
-          'failed'
+          "failed"
         end
       end
 
       def impact_string_for_result(result)
-        if result[:status] == 'skipped'
-          'skipped'
-        elsif result[:status] == 'passed'
-          'passed'
+        if result[:status] == "skipped"
+          "skipped"
+        elsif result[:status] == "passed"
+          "passed"
         elsif impact.nil?
-          'unknown'
+          "unknown"
         else
-          'failed'
+          "failed"
         end
       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