chefspec 7.2.1 → 7.3.0

data/examples/yum_repository/spec/add_spec.rb

@@ -2,7 +2,7 @@ require 'chefspec'
 
 describe 'yum_repository::add' do
   let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'centos', version: '7.3.1611')
+    ChefSpec::SoloRunner.new(platform: 'centos', version: '7.5.1804')
                           .converge(described_recipe)
   end
 

data/examples/yum_repository/spec/create_spec.rb

@@ -2,7 +2,7 @@ require 'chefspec'
 
 describe 'yum_repository::create' do
   let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'centos', version: '7.3.1611')
+    ChefSpec::SoloRunner.new(platform: 'centos', version: '7.5.1804')
                           .converge(described_recipe)
   end
 

data/examples/yum_repository/spec/delete_spec.rb

@@ -2,7 +2,7 @@ require 'chefspec'
 
 describe 'yum_repository::delete' do
   let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'centos', version: '7.3.1611')
+    ChefSpec::SoloRunner.new(platform: 'centos', version: '7.5.1804')
                           .converge(described_recipe)
   end
 

data/examples/yum_repository/spec/makecache_spec.rb

@@ -2,7 +2,7 @@ require 'chefspec'
 
 describe 'yum_repository::makecache' do
   let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'centos', version: '7.3.1611')
+    ChefSpec::SoloRunner.new(platform: 'centos', version: '7.5.1804')
                           .converge(described_recipe)
   end
 

data/examples/yum_repository/spec/remove_spec.rb

@@ -2,7 +2,7 @@ require 'chefspec'
 
 describe 'yum_repository::remove' do
   let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'centos', version: '7.3.1611')
+    ChefSpec::SoloRunner.new(platform: 'centos', version: '7.5.1804')
                           .converge(described_recipe)
   end
 

data/examples/zypper_package/spec/install_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'zypper_package::install' do
-  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.1').converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.3').converge(described_recipe) }
 
   it 'installs a zypper_package with the default action' do
     expect(chef_run).to install_zypper_package('default_action')

data/examples/zypper_package/spec/lock_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'zypper_package::lock' do
-  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.1').converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.3').converge(described_recipe) }
 
   it 'locks a zypper_package with an explicit action' do
     expect(chef_run).to lock_zypper_package('explicit_action')

data/examples/zypper_package/spec/purge_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'zypper_package::purge' do
-  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.1').converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.3').converge(described_recipe) }
 
   it 'purges a zypper_package with an explicit action' do
     expect(chef_run).to purge_zypper_package('explicit_action')

data/examples/zypper_package/spec/remove_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'zypper_package::remove' do
-  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.1').converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.3').converge(described_recipe) }
 
   it 'removes a zypper_package with an explicit action' do
     expect(chef_run).to remove_zypper_package('explicit_action')

data/examples/zypper_package/spec/unlock_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'zypper_package::unlock' do
-  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.1').converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.3').converge(described_recipe) }
 
   it 'unlocks a zypper_package with an explicit action' do
     expect(chef_run).to unlock_zypper_package('explicit_action')

data/examples/zypper_package/spec/upgrade_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'zypper_package::upgrade' do
-  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.1').converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'opensuse', version: '42.3').converge(described_recipe) }
 
   it 'upgrades a zypper_package with an explicit action' do
     expect(chef_run).to upgrade_zypper_package('explicit_action')

data/lib/chefspec.rb

@@ -63,12 +63,12 @@ require_relative 'chefspec/coverage'
 require_relative 'chefspec/errors'
 require_relative 'chefspec/expect_exception'
 require_relative 'chefspec/formatter'
-require_relative 'chefspec/macros'
 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'
 

data/lib/chefspec/api.rb

@@ -1,18 +1,37 @@
 module ChefSpec
   module API
-    # empty container
-  end
-end
+    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'
 
-# non-resources
-require_relative 'api/do_nothing'
-require_relative 'api/include_recipe'
-require_relative 'api/notifications'
-require_relative 'api/render_file'
-require_relative 'api/state_attrs'
-require_relative 'api/subscriptions'
+    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::IncludeRecipe)
+      klass.include(ChefSpec::API::DoNothing)
+      klass.include(ChefSpec::API::RenderFile)
+      klass.include(ChefSpec::API::StateAttrs)
+      klass.include(ChefSpec::API::Notifications)
+      klass.include(ChefSpec::API::Stubs)
+      klass.include(ChefSpec::API::StubsFor)
+      klass.include(ChefSpec::API::Subscriptions)
 
-# hacks and sugar for resources that don't follow the normal pattern
-require_relative 'api/user'
-require_relative 'api/link'
-require_relative 'api/reboot'
+      # hacks and sugar for resources that don't follow the normal pattern
+      klass.include(ChefSpec::API::User)
+      klass.include(ChefSpec::API::Link)
+      klass.include(ChefSpec::API::Reboot)
+    end
+  end
+end

data/lib/chefspec/api/core.rb

@@ -0,0 +1,195 @@
+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.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
+      # {ClassMethods#platform}.
+      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
+        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),
+          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)
+        # At some point this is probably going to need a flag for ServerRunner
+        # because someone will complain.
+        ChefSpec::SoloRunner.new(options)
+      end
+
+      # By default, run the recipe in the base `describe` block.
+      let(:chef_run) do
+        chef_runner.converge(described_recipe)
+      end
+
+      # 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,55 @@
+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 = self.is_a?(Class) ? self : self.class
+
+        metahash = scope.metadata
+        while metahash.has_key?(:parent_example_group)
+          metahash = metahash[:parent_example_group]
+        end
+
+        metahash[:description].to_s
+      end
+
+    end
+  end
+end

data/lib/chefspec/api/do_nothing.rb

@@ -1,21 +1,26 @@
-module ChefSpec::API
-  #
-  # 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