chefspec 7.3.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4149e5d01cef76e9961206a3c21e026f8d1514c5411d4e736775494e7df2fd5e
-  data.tar.gz: 1c2f041d3734fb0d1b4311652e545753ae93e13ac1d5699287754a2005ab30c5
+  metadata.gz: 96c39db8c598b7a40e7fd080c65db3a073a1e8e95f59a2628682587e5de4db56
+  data.tar.gz: a0bc37df1322446f83af4488fa1def9124d821478c0364a40fcce138c10f63cf
 SHA512:
-  metadata.gz: 86b9445a05713b120154104b065300b29944c2178277c0dbaf57271baed0d675b9582272c73044101cc36625b7ff9e1d189efff6f8525dbac2aed5ba225be0fd
-  data.tar.gz: 6dc383647ef0ca7f97c3a4ecfbe68a4323949a95d03c8ee853c80000682a7eab9deebed4db231cedd7ba0765c37d18a3304e145ed012739b6a5283b927f43889
+  metadata.gz: 354c875c5eb0890aea76c9bb7593dfec11d122157c42ca79842ff8a4264766e6a230fb57a14dfdd6c87887e7c4ba147ee388465e5c2b1fa782ed77a912145844
+  data.tar.gz: 64ff73a7906b1e4ba085a9d5d9182903de2965c9ea4c979ad95363b45677d083868e0f64c30c2637ee7beed85333d309cbe42c26024c6fc7fddc0f6b3b08861d

data/Rakefile

@@ -21,48 +21,51 @@ failed = []
 start_time = nil
 
 namespace :acceptance do |ns|
-  Dir.foreach("examples") do |dir|
-    next if dir == '.' or dir == '..'
-    desc "#{dir} acceptance tests"
-    task dir.to_sym do
-      start_time ||= Time.now
-      Dir.mktmpdir do |tmp|
-        FileUtils.cp_r("examples/#{dir}", tmp)
+  begin
+    Dir.foreach("examples") do |dir|
+      next if %w(. .. .DS_Store).include?(dir)
+      desc "#{dir} acceptance tests"
+      task dir.to_sym do
+        start_time ||= Time.now
+        Dir.mktmpdir do |tmp|
+          FileUtils.cp_r("examples/#{dir}", tmp)
 
-        pwd = Dir.pwd
+          pwd = Dir.pwd
 
-        Dir.chdir "#{tmp}/#{dir}" do
-          puts "rspec examples/#{dir}"
+          Dir.chdir "#{tmp}/#{dir}" do
+            puts "rspec examples/#{dir}"
 
-          #
-          # This bit of mildly awful magic below is to load each file into an in-memory
-          # RSpec runner while keeping a persistent ChefZero server alive.
-          #
-          load "#{pwd}/lib/chefspec/rspec.rb"
+            #
+            # This bit of mildly awful magic below is to load each file into an in-memory
+            # RSpec runner while keeping a persistent ChefZero server alive.
+            #
+            load "#{pwd}/lib/chefspec/rspec.rb"
 
-          RSpec.configure do |config|
-            config.color = true
-            config.run_all_when_everything_filtered = true
-            config.filter_run(:focus)
-            config.before(:suite) do
-              ChefSpec::ZeroServer.setup!
+            RSpec.configure do |config|
+              config.color = true
+              config.run_all_when_everything_filtered = true
+              config.filter_run(:focus)
+              config.before(:suite) do
+                ChefSpec::ZeroServer.setup!
+              end
+              config.after(:each) do
+                ChefSpec::ZeroServer.reset!
+              end
             end
-            config.after(:each) do
-              ChefSpec::ZeroServer.reset!
-            end
-          end
 
-          RSpec.clear_examples
-          exitstatus = RSpec::Core::Runner.run(["spec"])
-          RSpec.reset
-          failed << dir unless exitstatus == 0
+            RSpec.clear_examples
+            exitstatus = RSpec::Core::Runner.run(["spec"])
+            RSpec.reset
+            failed << dir unless exitstatus == 0
+          end
         end
       end
     end
+  rescue Errno::ENOENT # examples dir is probably missing
+    puts "The rake acceptance tests require a full git checkout of chefspec including all examples files!"
   end
 end
 
-
 task acceptance: Rake.application.tasks.select { |t| t.name.start_with?("acceptance:") } do
   puts "Acceptance tests took #{Time.now - start_time} seconds"
   raise "some tests failed: #{failed.join(', ')}" unless failed.empty?

data/chefspec.gemspec

@@ -14,18 +14,17 @@ Gem::Specification.new do |s|
                     'ChefSpec makes it easy to write examples and get fast ' \
                     'feedback on cookbook changes without the need for ' \
                     'virtual machines or cloud servers.'
-  s.homepage      = 'https://sethvargo.github.io/chefspec/'
+  s.homepage      = 'https://github.com/chefspec/chefspec'
   s.license       = 'MIT'
 
   # Packaging
-  s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.files         = %w{LICENSE Rakefile Gemfile chefspec.gemspec} + Dir.glob("{lib,templates,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.2'
+  s.required_ruby_version = '>= 2.4'
 
-  s.add_dependency 'chef',    '>= 12.14.89'
-  s.add_dependency 'fauxhai', '>= 4'
+  s.add_dependency 'chef',    '>= 14'
+  s.add_dependency 'chef-cli'
+  s.add_dependency 'fauxhai-ng', '>= 7.5'
   s.add_dependency 'rspec',   '~> 3.0'
 end

data/lib/chefspec/api/core.rb

@@ -14,27 +14,33 @@ module ChefSpec
           # Only run the preload if a platform is configured via the new system
           # since otherwise it will spam warnings about the platform not being
           # set.
-          chef_runner.preload! if chefspec_platform
+          chef_runner_instance.preload! if chefspec_platform
           ex.run
         ensure
           $CHEFSPEC_MODE = old_chefspec_mode
         end
       end
 
-      # Let variables to set the platform in a scoped way. Used below by
+      # Let variables to set data in a scoped way. Used below by
       # {ClassMethods#platform}.
+      let(:chefspec_default_attributes) { chefspec_attributes(:default_attributes) }
+      let(:chefspec_normal_attributes) { chefspec_attributes(:normal_attributes) }
+      let(:chefspec_override_attributes) { chefspec_attributes(:override_attributes) }
+      let(:chefspec_automatic_attributes) { chefspec_attributes(:automatic_attributes) }
       let(:chefspec_platform) { nil }
       let(:chefspec_platform_version) { nil }
 
-      # Set up the runner object but don't actually run anything yet. This can
-      # be overridden if needed to set up very custom things.
-      let(:chef_runner) do
+      # Compute the options for the runner.
+      #
+      # @abstract
+      # @return [Hash<Symbol, Object>]
+      def chef_runner_options
         options = {
           step_into: chefspec_ancestor_gather([], :step_into) {|memo, val| memo | val },
-          default_attributes: chefspec_attributes(:default_attributes),
-          normal_attributes: chefspec_attributes(:normal_attributes),
-          override_attributes: chefspec_attributes(:override_attributes),
-          automatic_attributes: chefspec_attributes(:automatic_attributes),
+          default_attributes: chefspec_default_attributes,
+          normal_attributes: chefspec_normal_attributes,
+          override_attributes: chefspec_override_attributes,
+          automatic_attributes: chefspec_automatic_attributes,
           spec_declaration_locations: self.class.declaration_locations.last[0],
         }
         # Only specify these if set in the example so we don't override the
@@ -43,16 +49,32 @@ module ChefSpec
         options[:version] = chefspec_platform_version if chefspec_platform_version
         # Merge in any final overrides.
         options.update(chefspec_attributes(:chefspec_options).symbolize_keys)
-        # At some point this is probably going to need a flag for ServerRunner
-        # because someone will complain.
-        ChefSpec::SoloRunner.new(options)
+        options
       end
 
-      # By default, run the recipe in the base `describe` block.
-      let(:chef_run) do
-        chef_runner.converge(described_recipe)
+      # Class of runner to use.
+      #
+      # @abstract
+      # @return [Class]
+      def chef_runner_class
+        ChefSpec::SoloRunner
+      end
+
+      # Create an instance of the runner.
+      #
+      # This should only be used in cases where the `let()` cache would be a problem.
+      #
+      # @return [ChefSpec::SoloRunner]
+      def chef_runner_instance
+        chef_runner_class.new(chef_runner_options)
       end
 
+      # Set up the runner object but don't actually run anything yet.
+      let(:chef_runner) { chef_runner_instance }
+
+      # By default, run the recipe in the base `describe` block.
+      let(:chef_run) { chef_runner.converge(described_recipe) }
+
       # Helper method for some of the nestable test value methods like
       # {ClassMethods#default_attributes} and {ClassMethods#step_into}.
       #

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,4 +1,5 @@
 require "chef/version"
+require "mixlib/shellout"
 
 module ChefSpec
   module API
@@ -34,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)
@@ -86,7 +87,7 @@ module ChefSpec
       def receive_shell_out(*cmd, stdout: '', stderr: '', exitstatus: 0, **opts)
         # Ruby does not allow constructing an actual exitstatus object from Ruby code. Really.
         fake_exitstatus = double(exitstatus: exitstatus)
-        fake_cmd = Mixlib::ShellOut.new(*cmd, **opts)
+        fake_cmd = Mixlib::ShellOut.new(*cmd)
         fake_cmd.define_singleton_method(:run_command) { } # Do nothing, just in case.
         # Inject our canned data.
         fake_cmd.instance_exec do
@@ -100,7 +101,8 @@ module ChefSpec
         else
           :shell_out
         end
-        receive(shell_out_method).with(*cmd).and_return(fake_cmd)
+        with_args = cmd + (opts.empty? ? [any_args] : [hash_including(opts)])
+        receive(shell_out_method).with(*with_args).and_return(fake_cmd)
       end
 
       module ClassMethods

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/extensions/chef/cookbook/gem_installer.rb

@@ -25,7 +25,7 @@ Chef::Cookbook::GemInstaller.prepend(Module.new do
     gem_cmd = "gem install #{gem_name} --version '#{gem_requirements.join(', ')}'"
     gemfile_line = "gem '#{[gem_name, *gem_requirements].join('\', \'')}'"
     warn "No matching version found for '#{gem_name}' in your gem environment.\n" \
-         " - if you are using ChefDK, run the following command: \"chef #{gem_cmd}\"\n" \
+         " - if you are using Chef Workstation, run the following command: \"chef #{gem_cmd}\"\n" \
          " - if you are using bundler, append \"#{gemfile_line}\" to your Gemfile and run \"bundle install\"\n" \
          " - otherwise run: \"#{gem_cmd}\""
   end

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:

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/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/policyfile.rb

@@ -1,8 +1,8 @@
 begin
-  require 'chef-dk/policyfile_services/export_repo'
-  require 'chef-dk/policyfile_services/install'
+  require 'chef-cli/policyfile_services/export_repo'
+  require 'chef-cli/policyfile_services/install'
 rescue LoadError
-  raise ChefSpec::Error::GemLoadError.new(gem: 'chef-dk', name: 'ChefDK')
+  raise ChefSpec::Error::GemLoadError.new(gem: 'chef-cli', name: 'ChefCLI')
 end
 
 module ChefSpec
@@ -22,16 +22,19 @@ module ChefSpec
     # Setup and install the necessary  dependencies in the temporary directory
     #
     def setup!
-      policyfile_path = File.join(Dir.pwd, 'Policyfile.rb')
+      policyfile_path = RSpec.configuration.policyfile_path
+      if policyfile_path.nil?
+        policyfile_path = File.join(Dir.pwd, 'Policyfile.rb')
+      end
 
-      installer = ChefDK::PolicyfileServices::Install.new(
+      installer = ChefCLI::PolicyfileServices::Install.new(
         policyfile: policyfile_path,
-        ui: ChefDK::UI.null
+        ui: ChefCLI::UI.null
       )
 
       installer.run
 
-      exporter = ChefDK::PolicyfileServices::ExportRepo.new(
+      exporter = ChefCLI::PolicyfileServices::ExportRepo.new(
         policyfile: policyfile_path,
         export_dir: @tmpdir
       )

data/lib/chefspec/rspec.rb

@@ -4,6 +4,7 @@ RSpec.configure do |config|
   end
 
   config.add_setting :berkshelf_options, default: {}
+  config.add_setting :policyfile_path
   config.add_setting :file_cache_path
   config.add_setting :cookbook_root
   config.add_setting :cookbook_path

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 = '7.3.0'
+  VERSION = '9.1.0'
 end

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