chefspec 7.0.0 → 9.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5200ce7871519ab0cc3ec4991be81a879de497e
-  data.tar.gz: 06e54036feed75509905d6d0fa216fca5ad21e70
+SHA256:
+  metadata.gz: d08884a5c636b308014e0dd1c6cedc065722c6f380474ce2c984c8fd3b25a493
+  data.tar.gz: e21ef1121d8ead918fa9636fb1bf1c7b8a177ac2db3c905764b43ed346026043
 SHA512:
-  metadata.gz: c01f41111509834f0edfd555ccb1f6cd5b46286834884309ac1045b792404fe7110ad15669e9307f7b85f620eee3cdaf1e5a87c884ab4c41c06d5198b19223bc
-  data.tar.gz: 90a5eba4f6aaa993733d2880f9fa591fc8504dad190ab855821be27d1d98712644bc2057e16d683e352f49144a1f6f2664d93db4da820349e0d6182801068e86
+  metadata.gz: 5d2a4352d11afa3165b9c1f63a6e92aed6ab35bb5794b6f7ad2df330da74093c0268e3d9a6e0fc660142cf2363d5a6a2c6a42fb271c3acbfe14afe0c832fe1cd
+  data.tar.gz: 1d2a0074029fd1acba7b02a8d5cb5ef8a0e696ec250edb1077363b42e761302f2a6462eabb0eab338097a26332c29ef9187c8cb64b90105d5d010a22fb6d0f73

data/Gemfile

@@ -1,12 +1,30 @@
-source 'https://rubygems.org'
-
-# env var for travis
-if ENV['CHEF_VERSION']
-  if ENV['CHEF_VERSION'] == "master"
-    gem 'chef', git: "https://github.com/chef/chef"
-  else
-    gem 'chef', ENV['CHEF_VERSION']
-  end
-end
+source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "rake"
+  gem "redcarpet"
+  gem "yard"
+  gem "pry"
+  gem "pry-byebug"
+  gem "chefstyle"
+end
+
+if ENV["GEMFILE_MOD"]
+  puts "GEMFILE_MOD: #{ENV["GEMFILE_MOD"]}"
+  instance_eval(ENV["GEMFILE_MOD"])
+else
+  gem "chef", git: "https://github.com/chef/chef"
+  gem "ohai", git: "https://github.com/chef/ohai"
+end
+
+# TODO: remove when we drop ruby 2.5
+if Gem.ruby_version < Gem::Version.new("2.6")
+  # 16.7.23 required ruby 2.6+
+  gem "chef-utils", "< 16.7.23"
+end
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/Rakefile

@@ -1,29 +1,85 @@
-require 'bundler/gem_tasks'
-require 'cucumber/rake/task'
-require 'rspec/core/rake_task'
-require 'yard/rake/yardoc_task'
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+require "yard/rake/yardoc_task"
+require "tmpdir"
+require "rspec"
+require "chefspec"
+require "chefstyle"
 
-require 'chef/version'
+require "chef/version"
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << "--display-cop-names"
+end
 
 YARD::Rake::YardocTask.new
 
 RSpec::Core::RakeTask.new(:unit) do |t|
   t.rspec_opts = [].tap do |a|
-    a.push('--color')
-    a.push('--format progress')
-  end.join(' ')
+    a.push("--color")
+    a.push("--format progress")
+  end.join(" ")
+end
+
+failed = []
+start_time = nil
+
+namespace :acceptance do |ns|
+
+  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
+
+        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"
+
+          RSpec.configure do |config|
+            config.full_backtrace = true
+            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
+
+          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
 
-Cucumber::Rake::Task.new(:acceptance) do |t|
-  t.cucumber_opts = [].tap do |a|
-    a.push('--color')
-    a.push('--format progress')
-    a.push('--strict')
-    a.push('--tags ~@not_chef_' + Chef::VERSION.gsub('.', '_'))
-  end.join(' ')
+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?
 end
 
-desc 'Run all tests'
-task :test => [:unit, :acceptance]
+desc "Run all tests"
+task test: %i{unit acceptance}
 
-task :default => [:test]
+task default: [:test]

data/chefspec.gemspec

@@ -1,39 +1,37 @@
-lib = File.expand_path('../lib/', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $:.unshift lib unless $:.include?(lib)
-require 'chefspec/version'
+require "chefspec/version"
 
 Gem::Specification.new do |s|
-  s.name          = 'chefspec'
+  s.name          = "chefspec"
   s.version       = ChefSpec::VERSION
-  s.authors       = ['Andrew Crump', 'Seth Vargo']
-  s.email         = ['andrew.crump@ieee.org', 'sethvargo@gmail.com']
-  s.summary       = 'Write RSpec examples and generate coverage reports for ' \
-                    'Chef recipes!'
-  s.description   = 'ChefSpec is a unit testing and resource coverage ' \
-                    '(code coverage) framework for testing Chef cookbooks ' \
-                    '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.license       = 'MIT'
+  s.authors       = ["Andrew Crump", "Seth Vargo"]
+  s.email         = ["andrew.crump@ieee.org", "sethvargo@gmail.com"]
+  s.summary       = "Write RSpec examples and generate coverage reports for " \
+                    "Chef recipes!"
+  s.description   = "ChefSpec is a unit testing and resource coverage " \
+                    "(code coverage) framework for testing Chef cookbooks " \
+                    "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://github.com/chef/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.require_paths = ['lib']
+  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.5"
 
-  s.add_dependency 'chef',    '>= 12.14.89'
-  s.add_dependency 'fauxhai', '>= 4', '< 6'
-  s.add_dependency 'rspec',   '~> 3.0'
+  s.add_dependency "chef", ">= 15"
+  s.add_dependency "chef-cli"
+  s.add_dependency "fauxhai-chef", ">= 9.3"
+  s.add_dependency "rspec",   "~> 3.0"
 
-  # Development Dependencies
-  s.add_development_dependency 'rake',      '< 13.0'
-  s.add_development_dependency 'redcarpet', '~> 3.3'
-  s.add_development_dependency 'yard',      '~> 0.8'
+  # this needs to be remedied before Ruby 3.3
+  s.add_dependency "logger", "< 1.6"
 
-  # Testing Dependencies
-  s.add_development_dependency 'aruba', '~> 0.8'
+  # temporary restriction to a version of rspec-expectations that includes the
+  # `RSpec::Matchers::ExpectedsForMultipleDiffs` class (renamed in 3.12.4)
+  s.add_dependency "rspec-expectations", "<= 3.12.3"
 end

data/lib/chefspec/api/core.rb

@@ -0,0 +1,217 @@
+module ChefSpec
+  module API
+    # Module containing the core RSpec API for ChefSpec.
+    module Core
+      # Pull in the needed machinery to use `around` and `let` in here.
+      extend RSpec::SharedContext
+
+      # Activate all of the various ChefSpec stubs for the duraction of this
+      # example block.
+      around do |ex|
+        old_chefspec_mode = $CHEFSPEC_MODE
+        $CHEFSPEC_MODE = true
+        begin
+          # 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_instance.preload! if chefspec_platform
+          ex.run
+        ensure
+          $CHEFSPEC_MODE = old_chefspec_mode
+        end
+      end
+
+      # 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 }
+
+      # 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_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
+        # global settings.
+        options[:platform] = chefspec_platform if chefspec_platform
+        options[:version] = chefspec_platform_version if chefspec_platform_version
+        # Merge in any final overrides.
+        options.update(chefspec_attributes(:chefspec_options).symbolize_keys)
+        options
+      end
+
+      # 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}.
+      #
+      # @api private
+      # @param start [Object] Initial value for the reducer.
+      # @param method [Symbol] Name of the group-level method to call on each
+      #   ancestor.
+      # @param block [Proc] Reducer callable.
+      # @return [Object]
+      def chefspec_ancestor_gather(start, method, &block)
+        candidate_ancestors = self.class.ancestors.select { |cls| cls.respond_to?(method) && cls != ChefSpec::API::Core }
+        candidate_ancestors.reverse.inject(start) do |memo, cls|
+          block.call(memo, cls.send(method))
+        end
+      end
+
+      # Special case of {#chefspec_ancestor_gather} because we do it four times.
+      #
+      # @api private
+      # @param method [Symbol] Name of the group-level method to call on each
+      #   ancestor.
+      # @return [Mash]
+      def chefspec_attributes(method)
+        chefspec_ancestor_gather(Mash.new, method) do |memo, val|
+          Chef::Mixin::DeepMerge.merge(memo, val)
+        end
+      end
+
+      # Methods that will end up as group-level.
+      #
+      # @api private
+      module ClassMethods
+        # Set the Fauxhai platform to use for this example group.
+        #
+        # @example
+        #   describe 'myrecipe' do
+        #     platform 'ubuntu', '18.04'
+        # @param name [String] Platform name to set.
+        # @param version [String, nil] Platform version to set.
+        # @return [void]
+        def platform(name, version = nil)
+          let(:chefspec_platform) { name }
+          let(:chefspec_platform_version) { version }
+        end
+
+        # Use an in-line block of recipe code for this example group rather
+        # than a recipe from a cookbook.
+        #
+        # @example
+        #   describe 'my_resource' do
+        #     recipe do
+        #       my_resource 'helloworld'
+        #     end
+        # @param block [Proc] A block of Chef recipe code.
+        # @return [void]
+        def recipe(&block)
+          let(:chef_run) do
+            chef_runner.converge_block(&block)
+          end
+        end
+
+        # Set default-level node attributes to use for this example group.
+        #
+        # @example
+        #   describe 'myapp::install' do
+        #     default_attributes['myapp']['version'] = '1.0'
+        # @return [Chef::Node::VividMash]
+        def default_attributes
+          @chefspec_default_attributes ||= Chef::Node::VividMash.new
+        end
+
+        # Set normal-level node attributes to use for this example group.
+        #
+        # @example
+        #   describe 'myapp::install' do
+        #     normal_attributes['myapp']['version'] = '1.0'
+        # @return [Chef::Node::VividMash]
+        def normal_attributes
+          @chefspec_normal_attributes ||= Chef::Node::VividMash.new
+        end
+
+        # Set override-level node attributes to use for this example group.
+        #
+        # @example
+        #   describe 'myapp::install' do
+        #     override_attributes['myapp']['version'] = '1.0'
+        # @return [Chef::Node::VividMash]
+        def override_attributes
+          @chefspec_override_attributes ||= Chef::Node::VividMash.new
+        end
+
+        # Set automatic-level node attributes to use for this example group.
+        #
+        # @example
+        #   describe 'myapp::install' do
+        #     automatic_attributes['kernel']['machine'] = 'ppc64'
+        # @return [Chef::Node::VividMash]
+        def automatic_attributes
+          @chefspec_automatic_attributes ||= Chef::Node::VividMash.new
+        end
+
+        # Set additional ChefSpec runner options to use for this example group.
+        #
+        # @example
+        #   describe 'myapp::install' do
+        #     chefspec_options[:log_level] = :debug
+        # @return [Chef::Node::VividMash]
+        def chefspec_options
+          @chefspec_options ||= Chef::Node::VividMash.new
+        end
+
+        # Add resources to the step_into list for this example group.
+        #
+        # @example
+        #   describe 'myapp::install' do
+        #     step_into :my_resource
+        # @return [Array]
+        def step_into(*resources)
+          @chefspec_step_into ||= []
+          @chefspec_step_into |= resources.flatten.map(&:to_s)
+        end
+
+        # @api private
+        def included(klass)
+          super
+          # Inject classmethods into the group.
+          klass.extend(ClassMethods)
+          # If the describe block is aimed at string or resource/provider class
+          # then set the default subject to be the Chef run.
+          if klass.described_class.nil? || klass.described_class.is_a?(Class) && (klass.described_class < Chef::Resource || klass.described_class < Chef::Provider)
+            klass.subject { chef_run }
+          end
+        end
+      end
+
+      extend ClassMethods
+
+    end
+  end
+end

data/lib/chefspec/api/described.rb

@@ -0,0 +1,53 @@
+module ChefSpec
+  module API
+    module Described
+      #
+      # The name of the currently running cookbook spec. Given the top-level
+      # +describe+ block is of the format:
+      #
+      #     describe 'my_cookbook::my_recipe' do
+      #       # ...
+      #     end
+      #
+      # The value of +described_cookbook+ is "my_cookbook".
+      #
+      # @example Using +described_cookbook+ in a context block
+      #   context "#{described_recipe} installs foo" do
+      #     # ...
+      #   end
+      #
+      #
+      # @return [String]
+      #
+      def described_cookbook
+        described_recipe.split("::").first
+      end
+
+      #
+      # The name of the currently running recipe spec. Given the top-level
+      # +describe+ block is of the format:
+      #
+      #     describe 'my_cookbook::my_recipe' do
+      #       # ...
+      #     end
+      #
+      # The value of +described_recipe+ is "my_cookbook::my_recipe".
+      #
+      # @example Using +described_recipe+ in the +ChefSpec::SoloRunner+
+      #   let(:chef_run) { ChefSpec::SoloRunner.new.converge(described_recipe) }
+      #
+      #
+      # @return [String]
+      #
+      def described_recipe
+        scope = is_a?(Class) ? self : self.class
+
+        metahash = scope.metadata
+        metahash = metahash[:parent_example_group] while metahash.key?(:parent_example_group)
+
+        metahash[:description].to_s
+      end
+
+    end
+  end
+end

data/lib/chefspec/api/do_nothing.rb

@@ -1,24 +1,26 @@
-module ChefSpec::API
-  # @since 3.4.0
-  module DoNothingMatchers
-    #
-    # Assert that a resource in the Chef run does not perform any actions. Given
-    # a resource with +action :nothing+:
-    #
-    #     package 'apache2' do
-    #       action :nothing
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test that no
-    # actions were performed on a resource in a Chef run.
-    #
-    # @example Assert the +package+ does not perform any actions
-    #
-    #
-    # @return [ChefSpec::Matchers::DoNothingMatcher]
-    #
-    def do_nothing
-      ChefSpec::Matchers::DoNothingMatcher.new
+module ChefSpec
+  module API
+    module DoNothing
+      #
+      # Assert that a resource in the Chef run does not perform any actions. Given
+      # a resource with +action :nothing+:
+      #
+      #     package 'apache2' do
+      #       action :nothing
+      #     end
+      #
+      # The Examples section demonstrates the different ways to test that no
+      # actions were performed on a resource in a Chef run.
+      #
+      # @example Assert the +package+ does not perform any actions
+      #   expect(chef_run.package('apache2')).to do_nothing
+      #
+      # @return [ChefSpec::Matchers::DoNothingMatcher]
+      #
+      def do_nothing
+        ChefSpec::Matchers::DoNothingMatcher.new
+      end
+
     end
   end
 end

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

@@ -1,26 +1,28 @@
-module ChefSpec::API
-  # @since 0.2.1
-  module IncludeRecipeMatchers
-    #
-    # Assert that a Chef run includes a certain recipe. Given a Chef Recipe
-    # that calls +include_recipe+:
-    #
-    #     include_recipe 'apache2::default'
-    #
-    # The Examples section demonstrates the different ways to test an
-    # +include_recipe+ directive with ChefSpec.
-    #
-    # @example Assert the +apache2::default+ recipe is included in the Chef run
-    #   expect(chef_run).to include_recipe('apache2::default')
-    #
-    #
-    # @param [String] recipe_name
-    #   the name of the recipe to be included
-    #
-    # @return [ChefSpec::Matchers::IncludeRecipeMatcher]
-    #
-    def include_recipe(recipe_name)
-      ChefSpec::Matchers::IncludeRecipeMatcher.new(recipe_name)
+module ChefSpec
+  module API
+    module IncludeRecipe
+      #
+      # Assert that a Chef run includes a certain recipe. Given a Chef Recipe
+      # that calls +include_recipe+:
+      #
+      #     include_recipe 'apache2::default'
+      #
+      # The Examples section demonstrates the different ways to test an
+      # +include_recipe+ directive with ChefSpec.
+      #
+      # @example Assert the +apache2::default+ recipe is included in the Chef run
+      #   expect(chef_run).to include_recipe('apache2::default')
+      #
+      #
+      # @param [String] recipe_name
+      #   the name of the recipe to be included
+      #
+      # @return [ChefSpec::Matchers::IncludeRecipeMatcher]
+      #
+      def include_recipe(recipe_name)
+        ChefSpec::Matchers::IncludeRecipeMatcher.new(recipe_name)
+      end
+
     end
   end
 end