chefspec 7.3.2 → 9.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c4571155e2841a391b08c56d4f7c6f9594a1101a0169d7f152f4d491b6657a4
-  data.tar.gz: 678d85972226787749577775b6f92b41863af50fa7e76d6a6b0e3771994d61d4
+  metadata.gz: d08884a5c636b308014e0dd1c6cedc065722c6f380474ce2c984c8fd3b25a493
+  data.tar.gz: e21ef1121d8ead918fa9636fb1bf1c7b8a177ac2db3c905764b43ed346026043
 SHA512:
-  metadata.gz: 8ef50f634ca41ff0c7eaf209cbfe6cc3ff890b2e072141aad3ad21862b5c6239fcf85adca96e5e5e95c18337673e4a4df5ab27d3729f7de4d7e615312d710717
-  data.tar.gz: c1c2c5e2f9bdfffdf6fdb2bc6c113a40a6274d626e4a34196738263cfcf4d73525d3818b271e5b8924e52411f8fd520c4a6c649e7c4f7fa8102c9f91f28a43af
+  metadata.gz: 5d2a4352d11afa3165b9c1f63a6e92aed6ab35bb5794b6f7ad2df330da74093c0268e3d9a6e0fc660142cf2363d5a6a2c6a42fb271c3acbfe14afe0c832fe1cd
+  data.tar.gz: 1d2a0074029fd1acba7b02a8d5cb5ef8a0e696ec250edb1077363b42e761302f2a6462eabb0eab338097a26332c29ef9187c8cb64b90105d5d010a22fb6d0f73

data/Gemfile

@@ -1,21 +1,28 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
 group :development do
-  gem 'rake'
-  gem 'redcarpet'
-  gem 'yard'
-  gem 'pry'
-  gem 'pry-byebug'
+  gem "rake"
+  gem "redcarpet"
+  gem "yard"
+  gem "pry"
+  gem "pry-byebug"
+  gem "chefstyle"
 end
 
 if ENV["GEMFILE_MOD"]
-  puts "GEMFILE_MOD: #{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"
+  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,

data/Rakefile

@@ -1,28 +1,36 @@
-require 'bundler/gem_tasks'
-require 'rspec/core'
-require 'rspec/core/rake_task'
-require 'yard/rake/yardoc_task'
-require 'tmpdir'
-require 'rspec'
-require 'chefspec'
+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 dir == '.' or dir == '..'
+    next if %w{. .. .DS_Store}.include?(dir)
+
     desc "#{dir} acceptance tests"
     task dir.to_sym do
       start_time ||= Time.now
@@ -41,6 +49,7 @@ namespace :acceptance do |ns|
           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)
@@ -60,15 +69,17 @@ namespace :acceptance do |ns|
       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
 
 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?
+  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,31 +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.16.42'
-  s.add_dependency 'fauxhai', '>= 4'
-  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"
+
+  # this needs to be remedied before Ruby 3.3
+  s.add_dependency "logger", "< 1.6"
+
+  # 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

@@ -36,7 +36,7 @@ module ChefSpec
       # @return [Hash<Symbol, Object>]
       def chef_runner_options
         options = {
-          step_into: chefspec_ancestor_gather([], :step_into) {|memo, val| memo | val },
+          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,
@@ -85,7 +85,7 @@ module ChefSpec
       # @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 = 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
@@ -115,7 +115,7 @@ module ChefSpec
         # @param name [String] Platform name to set.
         # @param version [String, nil] Platform version to set.
         # @return [void]
-        def platform(name, version=nil)
+        def platform(name, version = nil)
           let(:chefspec_platform) { name }
           let(:chefspec_platform_version) { version }
         end

data/lib/chefspec/api/described.rb

@@ -20,7 +20,7 @@ module ChefSpec
       # @return [String]
       #
       def described_cookbook
-        described_recipe.split('::').first
+        described_recipe.split("::").first
       end
 
       #
@@ -40,12 +40,10 @@ module ChefSpec
       # @return [String]
       #
       def described_recipe
-        scope = self.is_a?(Class) ? self : self.class
+        scope = is_a?(Class) ? self : self.class
 
         metahash = scope.metadata
-        while metahash.has_key?(:parent_example_group)
-          metahash = metahash[:parent_example_group]
-        end
+        metahash = metahash[:parent_example_group] while metahash.key?(:parent_example_group)
 
         metahash[:description].to_s
       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/stubs.rb

@@ -121,7 +121,7 @@ module ChefSpec
       #
       def stub_node(*args, &block)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        name    = args.first || 'node.example'
+        name    = args.first || "node.example"
 
         fauxhai = Fauxhai.mock(options).data
         fauxhai = fauxhai.merge(options[:ohai] || {})
@@ -165,7 +165,7 @@ module ChefSpec
       #
       # @return [ChefSpec::SearchStub]
       #
-      def stub_search(type, query = '*:*', &block)
+      def stub_search(type, query = "*:*", &block)
         ChefSpec::Stubs::SearchRegistry.register(ChefSpec::Stubs::SearchStub.new(type, query, &block))
       end
 

data/lib/chefspec/api/stubs_for.rb

@@ -1,4 +1,5 @@
 require "chef/version"
+require "mixlib/shellout" unless defined?(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)
@@ -55,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 unless 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.
       #
@@ -79,15 +82,15 @@ module ChefSpec
       # @param target [String, nil] Resource name to inject, or nil for all providers.
       # @param block [Proc] A block taking the resource object as a parameter.
       # @return [void]
-      def stubs_for_provider(target=nil, &block)
+      def stubs_for_provider(target = nil, &block)
         _chefspec_stubs_for_registry[:provider][target] << block
       end
 
-      def receive_shell_out(*cmd, stdout: '', stderr: '', exitstatus: 0, **opts)
+      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)
-        fake_cmd.define_singleton_method(:run_command) { } # Do nothing, just in case.
+        fake_cmd.define_singleton_method(:run_command) {} # Do nothing, just in case.
         # Inject our canned data.
         fake_cmd.instance_exec do
           @stdout = stdout
@@ -96,24 +99,25 @@ module ChefSpec
         end
         # On newer Chef, we can intercept using the new, better shell_out_compact hook point.
         shell_out_method ||= if HAS_SHELLOUT_COMPACTED.satisfied_by?(Gem::Version.create(Chef::VERSION))
-          :shell_out_compacted
-        else
-          :shell_out
-        end
+                               :shell_out_compacted
+                             else
+                               :shell_out
+                             end
         with_args = cmd + (opts.empty? ? [any_args] : [hash_including(opts)])
         receive(shell_out_method).with(*with_args).and_return(fake_cmd)
       end
 
       module ClassMethods
         # (see StubsFor#stubs_for_resource)
-        def stubs_for_resource(*args, &block)
-          before { stubs_for_resource(*args, &block) }
+        def stubs_for_resource(*args, **kwargs, &block)
+          before { stubs_for_resource(*args, **kwargs, &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/api.rb

@@ -1,24 +1,26 @@
 module ChefSpec
   module API
-    autoload :Core, 'chefspec/api/core'
-    autoload :Described, 'chefspec/api/described'
-    autoload :DoNothing, 'chefspec/api/do_nothing'
-    autoload :IncludeRecipe, 'chefspec/api/include_recipe'
-    autoload :Link, 'chefspec/api/link'
-    autoload :Notifications, 'chefspec/api/notifications'
-    autoload :Reboot, 'chefspec/api/reboot'
-    autoload :RenderFile, 'chefspec/api/render_file'
-    autoload :StateAttrs, 'chefspec/api/state_attrs'
-    autoload :Stubs, 'chefspec/api/stubs'
-    autoload :StubsFor, 'chefspec/api/stubs_for'
-    autoload :Subscriptions, 'chefspec/api/subscriptions'
-    autoload :User, 'chefspec/api/user'
+    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"
+    autoload :Reboot, "chefspec/api/reboot"
+    autoload :RenderFile, "chefspec/api/render_file"
+    autoload :StateAttrs, "chefspec/api/state_attrs"
+    autoload :Stubs, "chefspec/api/stubs"
+    autoload :StubsFor, "chefspec/api/stubs_for"
+    autoload :Subscriptions, "chefspec/api/subscriptions"
+    autoload :User, "chefspec/api/user"
 
     def self.included(klass)
       # non-resources
       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/berkshelf.rb

@@ -1,7 +1,7 @@
 begin
-  require 'berkshelf'
+  require "berkshelf"
 rescue LoadError
-  raise ChefSpec::Error::GemLoadError.new(gem: 'berkshelf', name: 'Berkshelf')
+  raise ChefSpec::Error::GemLoadError.new(gem: "berkshelf", name: "Berkshelf")
 end
 
 module ChefSpec
@@ -23,14 +23,14 @@ module ChefSpec
     def setup!
       # Get the list of Berkshelf options
       opts = RSpec.configuration.berkshelf_options
-      if !opts.is_a?(Hash)
+      unless opts.is_a?(Hash)
         raise InvalidBerkshelfOptions(value: opts.inspect)
       end
 
       berksfile = ::Berkshelf::Berksfile.from_options(opts)
 
       # Grab a handle to tmpdir, since Berkshelf 2 modifies it a bit
-      tmpdir = File.join(@tmpdir, 'cookbooks')
+      tmpdir = File.join(@tmpdir, "cookbooks")
 
       ::Berkshelf.ui.mute do
         if ::Berkshelf::Berksfile.method_defined?(:vendor)

data/lib/chefspec/cacher.rb

@@ -42,8 +42,8 @@ module ChefSpec
       location ||= ancestors.first.metadata[:parent_example_group][:location]
 
       define_method(name) do
-        key = [location, name.to_s].join('.')
-        unless @@cache.has_key?(Thread.current.object_id)
+        key = [location, name.to_s].join(".")
+        unless @@cache.key?(Thread.current.object_id)
           ObjectSpace.define_finalizer(Thread.current, FINALIZER)
         end
         @@cache[Thread.current.object_id] ||= {}

data/lib/chefspec/coverage/filters.rb

@@ -6,7 +6,7 @@ module ChefSpec
       end
 
       def matches?
-        raise RuntimeError, "Must override Filter#matches?"
+        raise "Must override Filter#matches?"
       end
     end
 
@@ -17,6 +17,7 @@ module ChefSpec
     class RegexpFilter < Filter
       def matches?(resource)
         return true if resource.source_line.nil?
+
         @filter =~ resource.source_line
       end
     end
@@ -41,6 +42,7 @@ module ChefSpec
     class BlockFilter < Filter
       def matches?(resource)
         return true if resource.source_line.nil?
+
         @filter.call(resource)
       end
     end
@@ -54,25 +56,26 @@ module ChefSpec
         @berksfile = berksfile
 
         @metadatas = if berksfile.respond_to?(:dependencies)
-          berksfile.dependencies
-            .select(&:metadata?)
-            .map(&:name)
-        else
-          berksfile.sources.collect do |source|
-            location = source.location
-            if location.respond_to?(:metadata?) && location.metadata?
-              source
-            else
-              nil
-            end
-          end.compact.map(&:name)
-        end
+                       berksfile.dependencies
+                         .select(&:metadata?)
+                         .map(&:name)
+                     else
+                       berksfile.sources.collect do |source|
+                         location = source.location
+                         if location.respond_to?(:metadata?) && location.metadata?
+                           source
+                         else
+                           nil
+                         end
+                       end.compact.map(&:name)
+                     end
       end
 
       def matches?(resource)
         return true if resource.source_line.nil?
+
         normalized_source_line = resource.source_line.gsub("\\", "/")
-        normalized_source_line=~ /cookbooks\/(?!#{@metadatas.join('|')})/
+        normalized_source_line =~ %r{cookbooks/(?!#{@metadatas.join('|')})}
       end
     end
   end