inspec 0.34.1 → 1.0.0

data/lib/inspec/rspec_json_formatter.rb

@@ -36,11 +36,8 @@ class InspecRspecMiniJson < RSpec::Core::Formatters::JsonFormatter
   # Called after stop has been called and the run is complete.
   def dump_summary(summary)
     @output_hash[:version] = Inspec::VERSION
-    @output_hash[:summary] = {
+    @output_hash[:statistics] = {
       duration: summary.duration,
-      example_count: summary.example_count,
-      failure_count: summary.failure_count,
-      skip_count: summary.pending_count,
     }
   end
 
@@ -66,10 +63,18 @@ class InspecRspecMiniJson < RSpec::Core::Formatters::JsonFormatter
   private
 
   def format_example(example)
+    if example.metadata[:description_args].length == 0
+      code_description = example.metadata[:full_description]
+    else
+      # For skipped profiles, rspec returns in full_description the skip_message as well. We don't want
+      # to mix the two, so we pick the full_description from the example.metadata[:example_group] hash.
+      code_description = example.metadata[:example_group][:description]
+    end
+
     res = {
       id: example.metadata[:id],
       status: example.execution_result.status.to_s,
-      code_desc: example.full_description,
+      code_desc: code_description,
     }
 
     unless (pid = example.metadata[:profile_id]).nil?
@@ -86,7 +91,7 @@ class InspecRspecMiniJson < RSpec::Core::Formatters::JsonFormatter
   end
 end
 
-class InspecRspecJson < InspecRspecMiniJson
+class InspecRspecJson < InspecRspecMiniJson # rubocop:disable Metrics/ClassLength
   RSpec::Core::Formatters.register self, :start, :stop, :dump_summary
   attr_writer :backend
 
@@ -108,7 +113,7 @@ class InspecRspecJson < InspecRspecMiniJson
   def start(_notification)
     # Note that the default profile may have no name - therefore
     # the hash may have a valid nil => entry.
-    @profiles_info ||= Hash[@profiles.map { |x| profile_info(x) }]
+    @profiles_info = @profiles.map(&:info!).map(&:dup)
   end
 
   def dump_one_example(example, control)
@@ -133,20 +138,59 @@ class InspecRspecJson < InspecRspecMiniJson
     @output_hash[:other_checks] = missing
   end
 
-  def dump_summary(summary)
-    super(summary)
+  def controls_summary
+    failed = 0
+    skipped = 0
+    passed = 0
+    critical = 0
+    major = 0
+    minor = 0
+
+    @control_tests.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
+        passed += 1
+      end
+    end
+
+    total = failed + passed + skipped
+
+    { 'total' => total,
+      'failed' => {
+        'total' => failed,
+        'critical' => critical,
+        'major' => major,
+        'minor' => minor,
+      },
+      'skipped' => skipped,
+      'passed' => passed }
+  end
+
+  def tests_summary
     total = 0
     failed = 0
     skipped = 0
     passed = 0
 
-    @profiles_info.each do |_name, profile|
-      total += profile[:controls].length
-      profile[:controls].each do |_control_name, control|
-        next unless control[:results]
-        if control[:results].any? { |r| r[:status] == 'failed' }
+    all_tests = @anonymous_tests + @control_tests
+    all_tests.each do |control|
+      next unless control[:results]
+      control[:results].each do |result|
+        if result[:status] == 'failed'
           failed += 1
-        elsif control[:results].any? { |r| r[:status] == 'skipped' }
+        elsif result[:status] == 'skipped'
           skipped += 1
         else
           passed += 1
@@ -154,16 +198,11 @@ class InspecRspecJson < InspecRspecMiniJson
       end
     end
 
-    # TODO: provide this information in the output
+    { 'total' => total, 'failed' => failed, 'skipped' => skipped, 'passed' => passed }
   end
 
   private
 
-  def profile_info(profile)
-    info = profile.info.dup
-    [info[:name], info]
-  end
-
   #
   # TODO(ssd+vj): We should probably solve this by either ensuring the example has
   # the profile_id of the top level profile when it is included as a dependency, or
@@ -171,7 +210,7 @@ class InspecRspecJson < InspecRspecMiniJson
   # this heuristic matching.
   #
   def example2profile(example, profiles)
-    profiles.values.find { |p| profile_contains_example?(p, example) }
+    profiles.find { |p| profile_contains_example?(p, example) }
   end
 
   def profile_contains_example?(profile, example)
@@ -180,7 +219,7 @@ class InspecRspecJson < InspecRspecMiniJson
     # Case 2: The profile contains a control that matches the id of the example
     if profile[:name] == example[:profile_id]
       true
-    elsif profile[:controls] && profile[:controls].key?(example[:id])
+    elsif profile[:controls] && profile[:controls].any? { |x| x[:id] == example[:id] }
       true
     else
       false
@@ -188,8 +227,9 @@ class InspecRspecJson < InspecRspecMiniJson
   end
 
   def example2control(example, profiles)
-    p = example2profile(example, profiles)
-    p[:controls][example[:id]] if p && p[:controls]
+    profile = example2profile(example, profiles)
+    return nil unless profile && profile[:controls]
+    profile[:controls].find { |x| x[:id] == example[:id] }
   end
 
   def format_example(example)
@@ -246,16 +286,17 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
     @current_profile = nil
     @missing_controls = []
     @anonymous_tests = []
+    @control_tests = []
     super(*args)
   end
 
-  def close(_notification)
+  def close(_notification) # rubocop:disable Metrics/AbcSize
     flush_current_control
     output.puts('') unless @current_control.nil?
     print_tests
     output.puts('')
 
-    @profiles_info.each do |_id, profile|
+    @profiles_info.each do |profile|
       next if profile[:already_printed]
       @current_profile = profile
       next unless print_current_profile
@@ -266,13 +307,20 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
       output.puts('')
     end
 
-    res = @output_hash[:summary]
-    passed = res[:example_count] - res[:failure_count] - res[:skip_count]
-    s = format('Summary: %s%d successful%s, %s%d failures%s, %s%d skipped%s',
-               COLORS['passed'], passed, COLORS['reset'],
-               COLORS['failed'], res[:failure_count], COLORS['reset'],
-               COLORS['skipped'], res[:skip_count], COLORS['reset'])
-    output.puts(s)
+    controls_res = controls_summary
+    tests_res = tests_summary
+
+    s = format('Profile Summary: %s%d successful%s, %s%d failures%s, %s%d skipped%s',
+               COLORS['passed'], controls_res['passed'], COLORS['reset'],
+               COLORS['failed'], controls_res['failed']['total'], COLORS['reset'],
+               COLORS['skipped'], controls_res['skipped'], COLORS['reset'])
+    output.puts(s) if controls_res['total'] > 0
+
+    s = format('Test Summary: %s%d successful%s, %s%d failures%s, %s%d skipped%s',
+               COLORS['passed'], tests_res['passed'], COLORS['reset'],
+               COLORS['failed'], tests_res['failed'], COLORS['reset'],
+               COLORS['skipped'], tests_res['skipped'], COLORS['reset'])
+    output.puts(s) if !@anonymous_tests.empty? || @current_control.nil?
   end
 
   private
@@ -334,8 +382,6 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
       if res.length == 1
         # Single test - be nice and just print the exception message if the test
         # failed. No need to say "1 failed".
-        fails.clear
-        skips.clear
         res[0][:message].to_s
       else
         [
@@ -371,7 +417,11 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
       test_color = @colors[test_status]
       indicator = @indicators[x[:status]]
       indicator = @indicators['empty'] if indicator.nil?
-      msg = x[:message] || x[:skip_message] || x[:code_desc]
+      if x[:message]
+        msg = x[:code_desc] + "\n" + x[:message]
+      else
+        msg = x[:skip_message] || x[:code_desc]
+      end
       print_line(
         color:      test_color,
         indicator:  @indicators['small'] + indicator,
@@ -381,7 +431,7 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
     end
   end
 
-  def print_tests
+  def print_tests # rubocop:disable Metrics/AbcSize
     @anonymous_tests.each do |control|
       control_result = control[:results]
       title = control_result[0][:code_desc].split[0..1].join(' ')
@@ -394,7 +444,7 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
           test_result = test[:message]
         else
           # determine title
-          test_result = test[:code_desc].split[2..-1].join(' ')
+          test_result = test[:skip_message] || test[:code_desc].split[2..-1].join(' ')
           # show error message
           test_result += "\n" + test[:message] unless test[:message].nil?
         end
@@ -414,7 +464,7 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
     return if @current_control.nil?
 
     prev_profile = @current_profile
-    @current_profile = @profiles_info[@current_control[:profile_id]]
+    @current_profile = @profiles_info.find { |i| i[:id] == @current_control[:profile_id] }
     print_current_profile if prev_profile != @current_profile
 
     fails, skips, passes, summary_indicator = current_control_infos
@@ -425,6 +475,7 @@ class InspecRspecCli < InspecRspecJson # rubocop:disable Metrics/ClassLength
     if control_id.start_with? '(generated from '
       @anonymous_tests.push(@current_control)
     else
+      @control_tests.push(@current_control)
       print_line(
         color:      @colors[summary_indicator] || '',
         indicator:  @indicators[summary_indicator] || @indicators['unknown'],

data/lib/inspec/rule.rb

@@ -12,6 +12,24 @@ module Inspec
   class Rule # rubocop:disable Metrics/ClassLength
     include ::RSpec::Matchers
 
+    #
+    # Include any resources from the given resource DSL.  The passed
+    # resource_dsl will also be included in any Inspec::Expect objects
+    # we make.
+    #
+    # @params resource_dsl [Module]
+    # @returns [TrueClass]
+    #
+    def self.with_resource_dsl(resource_dsl)
+      include resource_dsl
+      @resource_dsl = resource_dsl
+      true
+    end
+
+    def self.resource_dsl # rubocop:disable Style/TrivialAccessors
+      @resource_dsl
+    end
+
     def initialize(id, profile_id, _opts, &block)
       @impact = nil
       @title = nil
@@ -106,12 +124,12 @@ module Inspec
           include dsl
         end.new(method(:__add_check))
       else
-        __add_check('describe', values, block)
+        __add_check('describe', values, with_dsl(block))
       end
     end
 
     def expect(value, &block)
-      target = Inspec::Expect.new(value, &block)
+      target = Inspec::Expect.new(value, &with_dsl(block))
       __add_check('expect', [value], target)
       target
     end
@@ -188,6 +206,31 @@ module Inspec
       @__checks.push([describe_or_expect, values, block])
     end
 
+    #
+    # Takes a block and returns a block that will run the given block
+    # with access to the resource_dsl of the current class. This is to
+    # ensure that inside the constructed Rspec::ExampleGroup users
+    # have access to DSL methods. Previous this was done in
+    # Inspec::Runner before sending the example groups to rspec. It
+    # was moved here to ensure that code inside `its` blocks hae the
+    # same visibility into resources as code outside its blocks.
+    #
+    # @param [Proc] block
+    # @return [Proc]
+    #
+    def with_dsl(block)
+      return nil if block.nil?
+      if self.class.resource_dsl
+        dsl = self.class.resource_dsl
+        proc do |*args|
+          include dsl
+          instance_exec(*args, &block)
+        end
+      else
+        block
+      end
+    end
+
     # Idio(ma)tic unindent
     # TODO: replace this
     #

data/lib/inspec/runner.rb

@@ -11,6 +11,7 @@ require 'inspec/profile_context'
 require 'inspec/profile'
 require 'inspec/metadata'
 require 'inspec/secrets'
+require 'inspec/dependencies/cache'
 # spec requirements
 
 module Inspec
@@ -32,7 +33,6 @@ module Inspec
     extend Forwardable
 
     def_delegator :@test_collector, :report
-    def_delegator :@test_collector, :reset
 
     attr_reader :backend, :rules, :attributes
     def initialize(conf = {})
@@ -42,7 +42,8 @@ module Inspec
       @target_profiles = []
       @controls = @conf[:controls] || []
       @ignore_supports = @conf[:ignore_supports]
-
+      @create_lockfile = @conf[:create_lockfile]
+      @cache = Inspec::Cache.new(@conf[:cache])
       @test_collector = @conf.delete(:test_collector) || begin
         require 'inspec/runner_rspec'
         RunnerRspec.new(@conf)
@@ -64,13 +65,20 @@ module Inspec
       @test_collector.backend = @backend
     end
 
-    def run(with = nil)
-      Inspec::Log.debug "Starting run with targets: #{@target_profiles.map(&:to_s)}"
-      Inspec::Log.debug "Backend is #{@backend}"
+    def reset
+      @test_collector.reset
+      @target_profiles.each do |profile|
+        profile.runner_context.rules = {}
+      end
+      @rules = []
+    end
+
+    def load
       all_controls = []
 
       @target_profiles.each do |profile|
         @test_collector.add_profile(profile)
+        write_lockfile(profile) if @create_lockfile
         profile.locked_dependencies
         profile.load_libraries
         @attributes |= profile.runner_context.attributes
@@ -78,9 +86,29 @@ module Inspec
       end
 
       all_controls.each do |rule|
-        register_rule(rule)
+        register_rule(rule) unless rule.nil?
+      end
+    end
+
+    def run(with = nil)
+      Inspec::Log.debug "Starting run with targets: #{@target_profiles.map(&:to_s)}"
+      load
+      run_tests(with)
+    end
+
+    def write_lockfile(profile)
+      return false if !profile.writable?
+
+      if profile.lockfile_exists?
+        Inspec::Log.debug "Using existing lockfile #{profile.lockfile_path}"
+      else
+        Inspec::Log.debug "Creating lockfile: #{profile.lockfile_path}"
+        lockfile = profile.generate_lockfile
+        File.write(profile.lockfile_path, lockfile.to_yaml)
       end
+    end
 
+    def run_tests(with = nil)
       @test_collector.run(with)
     end
 
@@ -127,6 +155,7 @@ module Inspec
     #
     def add_target(target, _opts = [])
       profile = Inspec::Profile.for_target(target,
+                                           cache: @cache,
                                            backend: @backend,
                                            controls: @controls,
                                            attributes: @conf[:attributes])
@@ -134,32 +163,17 @@ module Inspec
       @target_profiles << profile if supports_profile?(profile)
     end
 
-    #
-    # This is used by inspec-shell and inspec-detect. This should
-    # probably be cleaned up a bit.
-    #
-    # @params [Hash] Options
-    # @returns [Inspec::ProfileContext]
-    #
-    def create_context(options = {})
-      meta = options[:metadata]
-      profile_id = nil
-      profile_id = meta.params[:name] unless meta.nil?
-      Inspec::ProfileContext.new(profile_id, @backend, @conf.merge(options))
-    end
-
     def supports_profile?(profile)
-      return true if profile.metadata.nil? || @ignore_supports
+      return true if @ignore_supports
 
-      if !profile.metadata.supports_runtime?
+      if !profile.supports_runtime?
         fail 'This profile requires InSpec version '\
              "#{profile.metadata.inspec_requirement}. You are running "\
              "InSpec v#{Inspec::VERSION}.\n"
       end
 
-      if !profile.metadata.supports_transport?(@backend)
-        os_info = @backend.os[:name].to_s
-        fail "This OS/platform (#{os_info}) is not supported by this profile."
+      if !profile.supports_os?
+        fail "This OS/platform (#{@backend.os[:name]}) is not supported by this profile."
       end
 
       true
@@ -182,6 +196,14 @@ module Inspec
       new_tests
     end
 
+    def eval_with_virtual_profile(command)
+      require 'fetchers/mock'
+      add_target({ 'inspec.yml' => 'name: inspec-shell' })
+      our_profile = @target_profiles.first
+      ctx = our_profile.runner_context
+      ctx.load(command)
+    end
+
     private
 
     def block_source_info(block)
@@ -231,21 +253,11 @@ module Inspec
       Inspec::Log.debug "Registering rule #{rule}"
       @rules << rule
       checks = ::Inspec::Rule.prepare_checks(rule)
-      examples = checks.map do |m, a, b|
+      examples = checks.flat_map do |m, a, b|
         get_check_example(m, a, b)
-      end.flatten.compact
-
-      examples.each do |example|
-        # TODO: Remove this!! It is very dangerous to do this here.
-        # The goal of this is to make the audit DSL available to all
-        # describe blocks. Right now, these blocks are executed outside
-        # the scope of this run, thus not gaining ony of the DSL pieces.
-        # To circumvent this, the full DSL is attached to the example's
-        # scope.
-        dsl = Inspec::Resource.create_dsl(backend)
-        example.send(:include, dsl)
-        @test_collector.add_test(example, rule)
-      end
+      end.compact
+
+      examples.each { |e| @test_collector.add_test(e, rule) }
     end
   end
 end

data/lib/inspec/shell.rb

@@ -15,18 +15,13 @@ module Inspec
     end
 
     def start
-      # Create an in-memory empty runner so that we can add tests to it later.
-      # This context lasts for the duration of this "start" method call/pry
-      # session.
-      @ctx = @runner.create_context
-      configure_pry
-
       # This will hold a single evaluation binding context as opened within
       # the instance_eval context of the anonymous class that the profile
       # context creates to evaluate each individual test file. We want to
       # pretend like we are constantly appending to the same file and want
       # to capture the local variable context from inside said class.
-      @ctx_binding = @ctx.load('binding')
+      @ctx_binding = @runner.eval_with_virtual_profile('binding')
+      configure_pry
       @ctx_binding.pry
     end
 
@@ -51,26 +46,20 @@ module Inspec
 
       # Track the rules currently registered and what their merge count is.
       Pry.hooks.add_hook(:before_eval, 'inspec_before_eval') do
-        @current_eval_rules = @ctx.rules.each_with_object({}) do |(rule_id, rule), h|
-          h[rule_id] = Inspec::Rule.merge_count(rule)
-        end
         @runner.reset
       end
 
       # After pry has evaluated a commanding within the binding context of a
       # test file, register all the rules it discovered.
       Pry.hooks.add_hook(:after_eval, 'inspec_after_eval') do
-        @current_eval_new_tests =
-          @runner.register_rules(@ctx) do |rule_id, rule|
-            @current_eval_rules[rule_id] != Inspec::Rule.merge_count(rule)
-          end
-        @runner.run if @current_eval_new_tests
+        @runner.load
+        @runner.run_tests if !@runner.all_rules.empty?
       end
 
       # Don't print out control class inspection when the user uses DSL methods.
       # Instead produce a result of evaluating their control.
       Pry.config.print = proc do |_output_, value, pry|
-        next if @current_eval_new_tests
+        next if !@runner.all_rules.empty?
         pry.pager.open do |pager|
           pager.print pry.config.output_prefix
           Pry::ColorPrinter.pp(value, pager, Pry::Terminal.width! - 1)

data/lib/inspec/version.rb

@@ -4,5 +4,5 @@
 # author: Christoph Hartmann
 
 module Inspec
-  VERSION = '0.34.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/resources/apache_conf.rb

@@ -105,7 +105,7 @@ module Inspec::Resources
 
       includes = []
       (include_files + include_files_optional).each do |f|
-        id = File.join(@conf_dir, f)
+        id    = Pathname.new(f).absolute? ? f : File.join(@conf_dir, f)
         files = find_files(id, depth: 1, type: 'file')
 
         includes.push(files) if files

data/lib/resources/gem.rb

@@ -9,6 +9,7 @@ module Inspec::Resources
     example "
       describe gem('rubocop') do
         it { should be_installed }
+        its('version') { should eq '0.33.0' }
       end
     "