chefspec 8.0.0 → 9.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 888dff160c4e09262e47271fc25e19e24dfa5415f9c17566d5fab2c3b07d3f38
-  data.tar.gz: a79eacde94a5abdad1ab8e4530ed95d46255323927fbfe9706873aa7d6d99545
+  metadata.gz: d5591af3861eae4ba3b5d9c37d274f38fa0279c9a5d91e2668d923251d1885ae
+  data.tar.gz: 36be14ae6da887efee4516070e3b6884e43950a8b9fddbbc28660d1ea7f6c841
 SHA512:
-  metadata.gz: 76b576b0e8fd51f067bda1eaca73ebb3bd5f49f0ce366ac4c59d84942b2d1437cead58afc7fd1b0c96e7051e656342e2b2ac9e1d2d3c183953ed8fefba15b79f
-  data.tar.gz: f5ba63555cde2fb189c53ceedfffd46491744605ea50f8927f85502c8ba480455a69ba397cdc27d1ace387509e95b8c5442b10b411ea50b3d18aaf075c0a5b3d
+  metadata.gz: 24e86fab969faea333b44ab9db94663efe783383c37760ce581bd0a088e1f3dc96927dc8bab7624da966d5e60440cf6c97e31a2b56b3c72a89135b0805d17ebc
+  data.tar.gz: d6b244cc4207077b59a6f53f343b632fe2550549b4e3778bdbfca9848a510861d7fdbe885bc26556c38ba5d74dbb5d619e1073521a2d0a4da3f7d1bd3b94576d

data/chefspec.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'chef',    '>= 14'
   s.add_dependency 'chef-cli'
-  s.add_dependency 'fauxhai', '>= 6.11'
+  s.add_dependency 'fauxhai-ng', '>= 7.5'
   s.add_dependency 'rspec',   '~> 3.0'
 end

data/lib/chefspec/api.rb

@@ -3,6 +3,7 @@ module ChefSpec
     autoload :Core, 'chefspec/api/core'
     autoload :Described, 'chefspec/api/described'
     autoload :DoNothing, 'chefspec/api/do_nothing'
+    autoload :IncludeAnyRecipe, 'chefspec/api/include_any_recipe'
     autoload :IncludeRecipe, 'chefspec/api/include_recipe'
     autoload :Link, 'chefspec/api/link'
     autoload :Notifications, 'chefspec/api/notifications'
@@ -19,6 +20,7 @@ module ChefSpec
       klass.include(ChefSpec::API::Core)
       klass.include(ChefSpec::API::Described)
       klass.include(ChefSpec::API::DoNothing)
+      klass.include(ChefSpec::API::IncludeAnyRecipe)
       klass.include(ChefSpec::API::IncludeRecipe)
       klass.include(ChefSpec::API::DoNothing)
       klass.include(ChefSpec::API::RenderFile)

data/lib/chefspec/api/include_any_recipe.rb

@@ -0,0 +1,24 @@
+module ChefSpec
+  module API
+    module IncludeAnyRecipe
+      #
+      # Assert that a Chef run includes any recipe.
+      #
+      #     include_recipe 'apache2::default'
+      #
+      # The Examples section demonstrates the different ways to test an
+      # +include_any_recipe+ directive with ChefSpec.
+      #
+      # @example Assert the Chef run did not include any recipes
+      #   expect(chef_run).not_to include_any_recipe
+      #
+      #
+      # @return [ChefSpec::Matchers::IncludeAnyRecipeMatcher]
+      #
+      def include_any_recipe
+        ChefSpec::Matchers::IncludeAnyRecipeMatcher.new
+      end
+      alias_method :include_any_recipes, :include_any_recipe
+    end
+  end
+end

data/lib/chefspec/api/stubs_for.rb

@@ -1,5 +1,5 @@
 require "chef/version"
-require "mixlib/shellout"
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
 
 module ChefSpec
   module API
@@ -35,7 +35,7 @@ module ChefSpec
       before do
         allow(StubsFor).to receive(:setup_stubs_for) do |object, type|
           type_stubs = _chefspec_stubs_for_registry[type]
-          resource_object = object.is_a?(Chef::Provider) ? object.new_resource : object
+          resource_object = object.respond_to?(:new_resource) ? object.new_resource : object
           stubs = type_stubs[nil] + type_stubs[resource_object.resource_name.to_s] + type_stubs[resource_object.to_s]
           stubs.each do |stub|
             instance_exec(object, &stub)
@@ -56,23 +56,25 @@ module ChefSpec
       #     expect(subject.some_method).to eq "asdf"
       #   end
       # @param target [String, nil] Resource name to inject, or nil for all resources.
-      # @param current_resource [Boolean] If true, also register stubs for current_resource objects on the same target.
+      # @param current_value [Boolean] If true, also register stubs for current_value objects on the same target.
       # @param block [Proc] A block taking the resource object as a parameter.
       # @return [void]
-      def stubs_for_resource(target=nil, current_resource: true, &block)
+      def stubs_for_resource(target=nil, current_value: true, current_resource: true, &block)
+        current_value = false if !current_resource
         _chefspec_stubs_for_registry[:resource][target] << block
-        stubs_for_current_resource(target, &block) if current_resource
+        stubs_for_current_value(target, &block) if current_value
       end
 
-      # Register stubs for current_resource objects.
+      # Register stubs for current_value objects.
       #
       # @see #stubs_for_resource
       # @param target [String, nil] Resource name to inject, or nil for all resources.
       # @param block [Proc] A block taking the resource object as a parameter.
       # @return [void]
-      def stubs_for_current_resource(target=nil, &block)
-        _chefspec_stubs_for_registry[:current_resource][target] << block
+      def stubs_for_current_value(target=nil, &block)
+        _chefspec_stubs_for_registry[:current_value][target] << block
       end
+      alias_method :stubs_for_current_resource, :stubs_for_current_value
 
       # Register stubs for provider objects.
       #
@@ -111,10 +113,11 @@ module ChefSpec
           before { stubs_for_resource(*args, &block) }
         end
 
-        # (see StubsFor#stubs_for_current_resource)
-        def stubs_for_current_resource(*args, &block)
-          before { stubs_for_current_resource(*args, &block) }
+        # (see StubsFor#stubs_for_current_value)
+        def stubs_for_current_value(*args, &block)
+          before { stubs_for_current_value(*args, &block) }
         end
+        alias_method :stubs_for_current_resource, :stubs_for_current_value
 
         # (see StubsFor#stubs_for_provider)
         def stubs_for_provider(*args, &block)

data/lib/chefspec/coverage.rb

@@ -90,6 +90,26 @@ module ChefSpec
       @outputs << block
     end
 
+    #
+    # Change the template for reporting of converage analysis.
+    #
+    # @param [string] path
+    #   The template file to use for the output of the report
+    #
+    # @return [true]
+    #
+    def set_template(file = 'human.erb')
+      [
+        ChefSpec.root.join('templates', 'coverage', file),
+        File.expand_path(file, Dir.pwd)
+      ].each do |temp|
+        if File.exist?(temp)
+          @template = temp
+          return
+        end
+      end
+      raise Error::TemplateNotFound.new(path: file)
+    end
     #
     # Add a resource to the resource collection. Only new resources are added
     # and only resources that match the given filter are covered (which is *

data/lib/chefspec/extensions.rb

@@ -18,3 +18,4 @@ require_relative 'extensions/chef/lwrp_base'
 require_relative 'extensions/chef/resource/freebsd_package'
 require_relative 'extensions/chef/run_context/cookbook_compiler'
 require_relative 'extensions/chef/cookbook_loader'
+require_relative 'extensions/ohai/system'

data/lib/chefspec/extensions/chef/provider.rb

@@ -1,5 +1,5 @@
 require 'chef/provider'
-require 'chefspec/api'
+require_relative '../../api'
 
 Chef::Provider.prepend(Module.new do
   def self.name

data/lib/chefspec/extensions/chef/resource.rb

@@ -1,6 +1,6 @@
 require 'chef/resource'
 require 'chef/version'
-require 'chefspec/api'
+require_relative '../../api'
 
 #
 # Three concerns:
@@ -21,7 +21,8 @@ module ChefSpec::Extensions::Chef::Resource
       # If we're directly inside a `load_current_resource`, this is probably
       # something like `new_resource.class.new` so we want to call this a current_resource,
       # Otherwise it's probably a normal resource instantiation.
-      mode = caller[1].include?("`load_current_resource'") ? :current_resource : :resource
+      mode = :resource
+      mode = :current_value if caller.any? { |x| x.include?("`load_current_resource'") || x.include?("`load_after_resource'") }
       ChefSpec::API::StubsFor.setup_stubs_for(self, mode)
     end
   end
@@ -33,7 +34,7 @@ module ChefSpec::Extensions::Chef::Resource
     super.tap do |dup_resource|
       # We're directly inside a load_current_resource, which is probably via
       # the load_current_value DSL system, so call this a current resource.
-      ChefSpec::API::StubsFor.setup_stubs_for(dup_resource, :current_resource) if stack.first.include?("`load_current_resource'")
+      ChefSpec::API::StubsFor.setup_stubs_for(dup_resource, :current_value) if caller.any? { |x| x.include?("`load_current_resource'") || x.include?("`load_after_resource'") }
     end
   end
 
@@ -133,7 +134,7 @@ module ChefSpec::Extensions::Chef::Resource
       super
     end
 
-    def provides(name, *args, &block)
+    def provides(name, **options, &block)
       provides_names << name unless provides_names.include?(name)
       inject_actions(*allowed_actions)
       super

data/lib/chefspec/extensions/chef/run_context/cookbook_compiler.rb

@@ -22,6 +22,15 @@ Chef::RunContext::CookbookCompiler.prepend(Module.new do
     super
   end
 
+  def load_ohai_plugins_from_cookbook(cookbook)
+    return super unless $CHEFSPEC_MODE
+    $CHEFSPEC_OHAI_PRELOAD ||= {}
+    # Already loaded this once.
+    return if $CHEFSPEC_OHAI_PRELOAD[cookbook]
+    $CHEFSPEC_OHAI_PRELOAD[cookbook] = true
+    super
+  end
+
   def load_lwrps_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
     $CHEFSPEC_LWRP_PRELOAD ||= {}

data/lib/chefspec/extensions/ohai/system.rb

@@ -0,0 +1,11 @@
+require 'ohai/system'
+
+Ohai::System.prepend(Module.new do
+  # If an Ohai segment exists, don't actually pull data in for ohai.
+  # (we have fake data for that)
+  # @see Ohai::System#run_additional_plugins
+  def run_additional_plugins(plugin_path)
+    return super unless $CHEFSPEC_MODE
+    # noop
+  end
+end)

data/lib/chefspec/file_cache_path_proxy.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'singleton'
+require 'fileutils' unless defined?(FileUtils)
+require 'singleton' unless defined?(Singleton)
 
 module ChefSpec
   class FileCachePathProxy

data/lib/chefspec/formatter.rb

@@ -133,6 +133,18 @@ module ChefSpec
     # Called when LWRPs are finished loading
     def lwrp_load_complete; end
 
+    # Called when an ohai plugin file loading starts
+    def ohai_plugin_load_start(file_count); end
+
+    # Called when an ohai plugin file has been loaded
+    def ohai_plugin_file_loaded(path); end
+
+    # Called when an ohai plugin file has an error on load.
+    def ohai_plugin_file_load_failed(path, exception); end
+
+    # Called when an ohai plugin file loading has finished
+    def ohai_plugin_load_complete; end
+
     # Called before attribute files are loaded
     def attribute_load_start(attribute_file_count); end
 

data/lib/chefspec/matchers.rb

@@ -1,6 +1,7 @@
 module ChefSpec
   module Matchers
     require_relative 'matchers/do_nothing_matcher'
+    require_relative 'matchers/include_any_recipe_matcher'
     require_relative 'matchers/include_recipe_matcher'
     require_relative 'matchers/link_to_matcher'
     require_relative 'matchers/notifications_matcher'

data/lib/chefspec/matchers/include_any_recipe_matcher.rb

@@ -0,0 +1,51 @@
+module ChefSpec::Matchers
+  class IncludeAnyRecipeMatcher
+    def matches?(runner)
+      @runner = runner
+      !(loaded_recipes - run_list_recipes).empty?
+    end
+
+    def description
+      'include any recipe'
+    end
+
+    def failure_message
+      'expected to include any recipe'
+    end
+
+    def failure_message_when_negated
+      'expected not to include any recipes'
+    end
+
+    private
+
+    #
+    # The list of run_list recipes on the Chef run (normalized)
+    #
+    # @return [Array<String>]
+    #
+    def run_list_recipes
+      @runner.run_context.node.run_list.run_list_items.map { |x| with_default(x.name) }
+    end
+
+    #
+    # Automatically appends "+::default+" to recipes that need them.
+    #
+    # @param [String] name
+    #
+    # @return [String]
+    #
+    def with_default(name)
+      name.include?('::') ? name : "#{name}::default"
+    end
+
+    #
+    # The list of loaded recipes on the Chef run (normalized)
+    #
+    # @return [Array<String>]
+    #
+    def loaded_recipes
+      @runner.run_context.loaded_recipes.map { |name| with_default(name) }
+    end
+  end
+end

data/lib/chefspec/runner.rb

@@ -1,4 +1,4 @@
-require "chefspec/solo_runner"
+require_relative "solo_runner"
 
 module ChefSpec
   # As we start to migrate back to only SoloRunner, include this alias for now.

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '8.0.0'
+  VERSION = '9.2.1'
 end

data/lib/chefspec/zero_server.rb

@@ -122,7 +122,7 @@ module ChefSpec
                 require "chef_zero/data_store/memory_store_v2"
                 ChefZero::DataStore::MemoryStoreV2.new
               when :on_disk
-                require "tmpdir"
+                require "tmpdir" unless defined?(Dir.mktmpdir)
                 require "chef_zero/data_store/raw_file_store"
                 tmpdir = Dir.mktmpdir
                 ChefZero::DataStore::RawFileStore.new(Dir.mktmpdir)

data/spec/spec_helper.rb

@@ -1,6 +1,11 @@
 require 'chefspec'
 require 'support/hash'
 
+
+ChefSpec::Coverage.start! do
+  set_template 'table.erb'
+end
+
 RSpec.configure do |config|
   config.expect_with(:rspec) { |c| c.syntax = :expect }
   config.filter_run(focus: true)

data/spec/unit/matchers/include_any_recipe_matcher_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe ChefSpec::Matchers::IncludeAnyRecipeMatcher do
+  let(:node) { double('Chef::Node', run_list: run_list) }
+  let(:run_list) { double('Chef::RunList', run_list_items: run_list_items) }
+  let(:run_list_items) { [run_list_item_one] }
+  let(:run_list_item_one) { double('Chef::RunList::RunListItem', name: 'one') }
+  let(:run_list_item_two) { double('Chef::RunList::RunListItem', name: 'two') }
+  let(:loaded_recipes) { %w(one) }
+  let(:chef_run) { double('chef run', run_context: { loaded_recipes: loaded_recipes, node: node }) }
+
+  subject { described_class.new }
+
+  describe '#failure_message' do
+    it 'has the right value' do
+      subject.matches?(chef_run)
+      expect(subject.failure_message).to eq('expected to include any recipe')
+    end
+  end
+
+  describe '#failure_message_when_negated' do
+    it 'has the right value' do
+      subject.matches?(chef_run)
+      expect(subject.failure_message_when_negated).to eq('expected not to include any recipes')
+    end
+  end
+
+  describe '#description' do
+    it 'has the right value' do
+      subject.matches?(chef_run)
+      expect(subject.description).to eq('include any recipe')
+    end
+  end
+
+  describe '#matches?' do
+    context 'when 0 recipes are included' do
+      let(:loaded_recipes) { %w(one) }
+
+      it 'returns false' do
+        expect(subject.matches?(chef_run)).to be false
+      end
+    end
+
+    context 'when at least one recipe is included' do
+      let(:loaded_recipes) { %w(one two) }
+
+      it 'returns true' do
+        expect(subject.matches?(chef_run)).to be true
+      end
+    end
+  end
+end

data/spec/unit/solo_runner_spec.rb

@@ -98,7 +98,7 @@ describe ChefSpec::SoloRunner do
       it 'sets the attributes from fauxhai' do
         expect(hash['os']).to eq('linux')
         expect(hash['languages']['ruby']['ruby_bin']).to eq('/usr/local/bin/ruby')
-        expect(hash['os_version']).to match(/4.15.0-.*-.*/) # avoid failing when fauxhai data changes
+        expect(hash['os_version']).to match(/5.3.0-.*-.*/) # avoid failing when fauxhai data changes
         expect(hash['fqdn']).to eq('fauxhai.local')
         expect(hash['domain']).to eq('local')
         expect(hash['ipaddress']).to eq('10.0.0.2')

data/templates/coverage/human.erb

@@ -0,0 +1,22 @@
+
+<% if @total == 0 %>
+  No Chef resources found, skipping coverage calculation...
+<% else %>
+ChefSpec Coverage report generated...
+
+  Total Resources:   <%= @total %>
+  Touched Resources: <%= @touched %>
+  Touch Coverage:    <%= @coverage %>%
+
+<% if @untouched_resources.empty? %>
+You are awesome and so is your test coverage! Have a fantastic day!
+
+<% else %>
+Untouched Resources:
+
+<% @untouched_resources.each do |resource| %>
+  <%= resource.to_s.ljust(32) %>   <%= resource.source_file %>:<%= resource.source_line %>
+<% end %>
+
+<% end %>
+<% end %>

data/templates/coverage/json.erb

@@ -0,0 +1,8 @@
+{ "resources":[
+  <%= @all_resources.map { |resource| resource.to_json }.join(",\n") %>
+  ],
+  "resource_count": <%= @total %>,
+  "resources_touched": <%= @touched %>,
+  "resource_coverage":    <%= @coverage %>
+
+}

data/templates/coverage/table.erb

@@ -0,0 +1,14 @@
+<%='Touched'.to_s.ljust(8) %> <%='Resource'.to_s.ljust(48) %>   File:Line
+<% @all_resources.each do |resource| %>
+<%=resource.touched?.to_s.ljust(8) %> <%= resource.to_s.ljust(48) %>   <%= resource.source_file %>:<%= resource.source_line %>
+<% end %>
+
+<% if @total == 0 %>
+  No Chef resources found, skipping coverage calculation...
+<% else %>
+ChefSpec Coverage report generated...
+
+  Total Resources:   <%= @total %>
+  Touched Resources: <%= @touched %>
+  Touch Coverage:    <%= @coverage %>%
+<% end %>

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: chefspec
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.2.1
 platform: ruby
 authors:
 - Andrew Crump
 - Seth Vargo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -40,19 +40,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fauxhai
+  name: fauxhai-ng
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.11'
+        version: '7.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.11'
+        version: '7.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - lib/chefspec/api/core.rb
 - lib/chefspec/api/described.rb
 - lib/chefspec/api/do_nothing.rb
+- lib/chefspec/api/include_any_recipe.rb
 - lib/chefspec/api/include_recipe.rb
 - lib/chefspec/api/link.rb
 - lib/chefspec/api/notifications.rb
@@ -118,11 +119,13 @@ files:
 - lib/chefspec/extensions/chef/resource/freebsd_package.rb
 - lib/chefspec/extensions/chef/run_context/cookbook_compiler.rb
 - lib/chefspec/extensions/chef/securable.rb
+- lib/chefspec/extensions/ohai/system.rb
 - lib/chefspec/file_cache_path_proxy.rb
 - lib/chefspec/formatter.rb
 - lib/chefspec/librarian.rb
 - lib/chefspec/matchers.rb
 - lib/chefspec/matchers/do_nothing_matcher.rb
+- lib/chefspec/matchers/include_any_recipe_matcher.rb
 - lib/chefspec/matchers/include_recipe_matcher.rb
 - lib/chefspec/matchers/link_to_matcher.rb
 - lib/chefspec/matchers/notifications_matcher.rb
@@ -161,6 +164,7 @@ files:
 - spec/unit/expect_exception_spec.rb
 - spec/unit/macros_spec.rb
 - spec/unit/matchers/do_nothing_matcher.rb
+- spec/unit/matchers/include_any_recipe_matcher_spec.rb
 - spec/unit/matchers/include_recipe_matcher_spec.rb
 - spec/unit/matchers/link_to_matcher_spec.rb
 - spec/unit/matchers/notifications_matcher_spec.rb
@@ -181,6 +185,9 @@ files:
 - spec/unit/stubs/search_registry_spec.rb
 - spec/unit/stubs/search_stub_spec.rb
 - spec/unit/stubs/stub_spec.rb
+- templates/coverage/human.erb
+- templates/coverage/json.erb
+- templates/coverage/table.erb
 - templates/errors/cookbook_path_not_found.erb
 - templates/errors/erb_template_parse_error.erb
 - templates/errors/gem_load_error.erb
@@ -194,7 +201,7 @@ homepage: https://github.com/chefspec/chefspec
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -209,8 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Write RSpec examples and generate coverage reports for Chef recipes!
 test_files: []