chefspec 8.0.1 → 9.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74bb24c63b0385dccb22c7a83abcd2350429986bd6de6f1444df2d548d8bb72b
-  data.tar.gz: a66b22b4e3f705eea2d2d11fc65e9285cb890aa00f76ab826b47b66d37497678
+  metadata.gz: 925cb2abc56b376354e60cc27bc9e4539d5841e2d78ecc617dd287052f9340eb
+  data.tar.gz: 0534af872e3c3d8feb88564ccb66d976ac23c368f8e2aa85e37d7fbe3429c6ba
 SHA512:
-  metadata.gz: 77dd4b42946b4bf2129dba71039fee03a5c1cebf8c9b2026ae4c7b31e443dea9a9a579e78d7b36ba89d75562a6eeaf9d1a701052a143cd2cc26914e15f64a4f7
-  data.tar.gz: 4471c363638234ee7e5268db4de027b1d0b749c7ae74eaa9343c0a3f35db9b9ce0eb2c97e6b8a8c57efad75fe3b7500c34c7218a040716dfcf8cd1cba60dc6c8
+  metadata.gz: 89d4e0d603e9ee1c162b68836fe711e3040e31b7d950aebb25212df1f08d2381f573011665b4a8b5346881f2bf6cf72d19f2d0034fcf8d3f46f6a2373436f411
+  data.tar.gz: b9811de2bdba005fa11fb6f3649651310aa9748dd9f91340ab44a65c52120fe7305152b0a41a6706ebff2421b20d3f1fcb2bd55890b27b7324fe3fdcd3286e2b

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,77 +1,85 @@
-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|
-  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
-
-          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.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
+  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
-  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
+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,30 +1,30 @@
-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://github.com/chefspec/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/chefspec/chefspec"
+  s.license       = "MIT"
 
   # Packaging
   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.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 2.4'
+  s.required_ruby_version = ">= 2.5"
 
-  s.add_dependency 'chef',    '>= 14'
-  s.add_dependency 'chef-cli'
-  s.add_dependency 'fauxhai', '>= 6.11'
-  s.add_dependency 'rspec',   '~> 3.0'
+  s.add_dependency "chef", ">= 15"
+  s.add_dependency "chef-cli"
+  s.add_dependency "fauxhai-ng", ">= 7.5"
+  s.add_dependency "rspec",   "~> 3.0"
 end

data/lib/chefspec.rb

@@ -1,4 +1,4 @@
-require 'rspec'
+require "rspec"
 
 module ChefSpec
   #
@@ -25,7 +25,7 @@ module ChefSpec
   # @return [Pathname]
   #
   def root
-    @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    @root ||= Pathname.new(File.expand_path("..", __dir__))
   end
   module_function :root
 
@@ -42,34 +42,34 @@ module ChefSpec
   module_function :matchers
 end
 
-require_relative 'chefspec/extensions'
+require_relative "chefspec/extensions"
 
-require_relative 'chefspec/mixins/normalize'
+require_relative "chefspec/mixins/normalize"
 
-require_relative 'chefspec/stubs/command_registry'
-require_relative 'chefspec/stubs/command_stub'
-require_relative 'chefspec/stubs/data_bag_item_registry'
-require_relative 'chefspec/stubs/data_bag_item_stub'
-require_relative 'chefspec/stubs/data_bag_registry'
-require_relative 'chefspec/stubs/data_bag_stub'
-require_relative 'chefspec/stubs/registry'
-require_relative 'chefspec/stubs/stub'
-require_relative 'chefspec/stubs/search_registry'
-require_relative 'chefspec/stubs/search_stub'
+require_relative "chefspec/stubs/command_registry"
+require_relative "chefspec/stubs/command_stub"
+require_relative "chefspec/stubs/data_bag_item_registry"
+require_relative "chefspec/stubs/data_bag_item_stub"
+require_relative "chefspec/stubs/data_bag_registry"
+require_relative "chefspec/stubs/data_bag_stub"
+require_relative "chefspec/stubs/registry"
+require_relative "chefspec/stubs/stub"
+require_relative "chefspec/stubs/search_registry"
+require_relative "chefspec/stubs/search_stub"
 
-require_relative 'chefspec/api'
-require_relative 'chefspec/cacher'
-require_relative 'chefspec/coverage'
-require_relative 'chefspec/errors'
-require_relative 'chefspec/expect_exception'
-require_relative 'chefspec/formatter'
-require_relative 'chefspec/matchers'
-require_relative 'chefspec/renderer'
-require_relative 'chefspec/rspec'
-require_relative 'chefspec/server_runner'
-require_relative 'chefspec/solo_runner'
-require_relative 'chefspec/runner'
-require_relative 'chefspec/util'
-require_relative 'chefspec/version'
+require_relative "chefspec/api"
+require_relative "chefspec/cacher"
+require_relative "chefspec/coverage"
+require_relative "chefspec/errors"
+require_relative "chefspec/expect_exception"
+require_relative "chefspec/formatter"
+require_relative "chefspec/matchers"
+require_relative "chefspec/renderer"
+require_relative "chefspec/rspec"
+require_relative "chefspec/server_runner"
+require_relative "chefspec/solo_runner"
+require_relative "chefspec/runner"
+require_relative "chefspec/util"
+require_relative "chefspec/version"
 
-require_relative 'chefspec/deprecations'
+require_relative "chefspec/deprecations"

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/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