chefspec 7.2.1 → 7.3.0

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '7.2.1'
+  VERSION = '7.3.0'
 end

data/spec/unit/deprecations_spec.rb

@@ -27,31 +27,6 @@ describe ChefSpec::Runner do
     end
 
   end
-
-  describe '#new' do
-    before do
-      allow(ChefSpec::SoloRunner).to receive(:new)
-    end
-
-    it 'prints a deprecation' do
-      expect(ChefSpec::Runner).to receive(:deprecated)
-        .with("`ChefSpec::Runner' is deprecated. Please use" \
-        " `ChefSpec::SoloRunner' or `ChefSpec::ServerRunner' instead.")
-      ChefSpec::Runner.new
-    end
-
-    it 'calls SoloRunner#new with no args' do
-      expect(ChefSpec::SoloRunner).to receive(:new).with(no_args()).once
-      ChefSpec::Runner.new
-    end
-
-    it 'calls SoloRunner#new with args' do
-      args = [ 'args' ]
-      expect(ChefSpec::SoloRunner).to receive(:new).with(*args).once
-      ChefSpec::Runner.new(*args)
-    end
-
-  end
 end
 
 describe ChefSpec::Server do
@@ -62,7 +37,7 @@ describe ChefSpec::Server do
   it 'prints a deprecation for any method called' do
     expect(ChefSpec::Server).to receive(:deprecated)
       .with("`ChefSpec::Server.any_method' is deprecated. There is no longer" \
-        " a global Chef Server instance. Please use a ChefSpec::ServerRunner" \
+        " a global Chef Server instance. Please use a ChefSpec::SoloRunner" \
         " instead. More documentation can be found in the ChefSpec README."
       )
     expect {

data/spec/unit/macros_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe ChefSpec::Macros do
+describe ChefSpec::API::Stubs do
   describe '#stub_command' do
     let(:command_stub) { double('command') }
 
     it 'adds the command to the command registry' do
       allow(ChefSpec::Stubs::CommandStub).to receive(:new).and_return(command_stub)
-      described_class.stub_command('echo "hello"')
+      stub_command('echo "hello"')
 
       expect(ChefSpec::Stubs::CommandRegistry.stubs).to include(command_stub)
     end
@@ -17,7 +17,7 @@ describe ChefSpec::Macros do
 
     it 'adds the query to the search registry' do
       allow(ChefSpec::Stubs::SearchStub).to receive(:new).and_return(search_stub)
-      described_class.stub_search(:node, '*:*')
+      stub_search(:node, '*:*')
 
       expect(ChefSpec::Stubs::SearchRegistry.stubs).to include(search_stub)
     end
@@ -28,7 +28,7 @@ describe ChefSpec::Macros do
 
     it 'adds the query to the data_bag registry' do
       allow(ChefSpec::Stubs::DataBagStub).to receive(:new).and_return(data_bag_stub)
-      described_class.stub_data_bag(:users)
+      stub_data_bag(:users)
 
       expect(ChefSpec::Stubs::DataBagRegistry.stubs).to include(data_bag_stub)
     end
@@ -39,7 +39,7 @@ describe ChefSpec::Macros do
 
     it 'adds the query to the data_bag_item registry' do
       allow(ChefSpec::Stubs::DataBagItemStub).to receive(:new).and_return(data_bag_item_stub)
-      described_class.stub_data_bag_item(:users, 'id')
+      stub_data_bag_item(:users, 'id')
 
       expect(ChefSpec::Stubs::DataBagItemRegistry.stubs).to include(data_bag_item_stub)
     end
@@ -47,43 +47,43 @@ describe ChefSpec::Macros do
 
   describe '#stub_node' do
     it 'returns a Chef::Node' do
-      expect(described_class.stub_node).to be_a(Chef::Node)
+      expect(stub_node).to be_a(Chef::Node)
     end
 
     it 'defaults the node name to `node.example`' do
-      node = described_class.stub_node
+      node = stub_node
       expect(node.name).to eq('node.example')
     end
 
     it 'sets the node name when given' do
-      node = described_class.stub_node('example.com')
+      node = stub_node('example.com')
       expect(node.name).to eq('example.com')
     end
 
     it 'sets the automatic attributes' do
-      node = described_class.stub_node
+      node = stub_node
       expect(node.automatic).to eq(Fauxhai.mock.data)
     end
 
     it 'sets the automatic attributes with ohai overrides' do
-      node = described_class.stub_node('node.example', ohai: { ipaddress: '1.2.3.4' })
+      node = stub_node('node.example', ohai: { ipaddress: '1.2.3.4' })
       expect(node['ipaddress']).to eq('1.2.3.4')
     end
 
     it 'sets the automatic attributes for a specific platform and version' do
-      node = described_class.stub_node('node.example', platform: 'ubuntu', version: '16.04')
-      expect(node.automatic).to eq(Fauxhai.mock(platform: 'ubuntu', version: '16.04').data)
+      node = stub_node('node.example', platform: 'ubuntu', version: '18.04')
+      expect(node.automatic).to eq(Fauxhai.mock(platform: 'ubuntu', version: '18.04').data)
     end
 
     it 'sets the automatic attributes from a JSON data path' do
       allow(File).to receive(:exist?).with('/path/to/json').and_return(true)
       allow(File).to receive(:read).with('/path/to/json').and_return('{ "ipaddress": "1.2.3.4" }')
-      node = described_class.stub_node('node.example', path: '/path/to/json')
+      node = stub_node('node.example', path: '/path/to/json')
       expect(node['ipaddress']).to eq('1.2.3.4')
     end
 
     it 'yields a block' do
-      expect { |block| described_class.stub_node(&block) }.to yield_with_args(Chef::Node)
+      expect { |block| stub_node(&block) }.to yield_with_args(Chef::Node)
     end
   end
 end

data/spec/unit/matchers/render_file_matcher_spec.rb

@@ -12,7 +12,7 @@ describe ChefSpec::Matchers::RenderFileMatcher do
       expect(
         subject.with_content do |content|
           'Does not raise ArgumentError'
-        end.expected_content.call
+        end.expected_content.first.call
       ).to eq('Does not raise ArgumentError')
     end
   end
@@ -38,6 +38,13 @@ describe ChefSpec::Matchers::RenderFileMatcher do
       subject.matches?(chef_run)
       expect(subject.description).to eq(%Q(render file "#{path}"))
     end
+
+    it 'has the right value when with_content is chained' do
+      subject.matches?(chef_run)
+      expect(
+        subject.with_content('foo').with_content('bar').description
+      ).to eq(%Q(render file "#{path}" with content "foo" with content "bar"))
+    end
   end
 
   context 'when the file is correct' do

data/spec/unit/solo_runner_spec.rb

@@ -47,7 +47,7 @@ describe ChefSpec::SoloRunner do
     it 'defaults the cookbook_path to the calling spec when using windows paths' do
       runner = described_class.new
       windows_path = runner.instance_exec(windows_caller_stack) { |callstack|
-        calling_cookbook_path(callstack)
+        calling_cookbook_path({}, callstack)
       }
       # There's got to be a better way to do this the File.expand_path returns
       # something like /home/user/repos/chefspec/C:/cookbooks" which is less
@@ -93,12 +93,12 @@ describe ChefSpec::SoloRunner do
     end
 
     context 'fauxhai attributes' do
-      let(:hash) { described_class.new(platform: 'ubuntu', version: '16.04').node.to_hash }
+      let(:hash) { described_class.new(platform: 'ubuntu', version: '18.04').node.to_hash }
 
       it 'sets the attributes from fauxhai' do
         expect(hash['os']).to eq('linux')
         expect(hash['languages']['ruby']['ruby_bin']).to eq('/usr/local/bin/ruby')
-        expect(hash['os_version']).to match(/4.4.0-.*-.*/) # avoid failing when fauxhai data changes
+        expect(hash['os_version']).to match(/4.15.0-.*-.*/) # avoid failing when fauxhai data changes
         expect(hash['fqdn']).to eq('fauxhai.local')
         expect(hash['domain']).to eq('local')
         expect(hash['ipaddress']).to eq('10.0.0.2')

data/templates/errors/may_need_to_specify_platform.erb

@@ -13,7 +13,7 @@ options.
 You can specify the platform and version you would like ChefSpec to act like
 by specifying the platform and version like so:
 
-    ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '16.04')
+    ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '18.04')
 
 You can read more information in ChefSpec's README or the Fauxhai project:
 

data/templates/errors/shell_out_not_stubbed.erb

@@ -0,0 +1,10 @@
+Executing a real shell_out in <%= @resource %> is not allowed:
+
+    shell_out(<%= @args.inspect[1..-2] %>)
+
+You can stub this with:
+
+    stubs_for_<%= @type %>(<%= @resource.to_s.inspect %>) do |<%= @type %>|
+      allow(<%= @type %>).to receive_shell_out(<%= @args.inspect[1..-2] %>)
+    end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec
 version: !ruby/object:Gem::Version
-  version: 7.2.1
+  version: 7.3.0
 platform: ruby
 authors:
 - Andrew Crump
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -71,6 +71,7 @@ files:
 - ISSUES.md
 - LICENSE
 - README.md
+- README_old.md
 - Rakefile
 - chefspec.gemspec
 - examples/apt_package/recipes/install.rb
@@ -140,6 +141,9 @@ files:
 - examples/cookbook_file/spec/create_spec.rb
 - examples/cookbook_file/spec/delete_spec.rb
 - examples/cookbook_file/spec/touch_spec.rb
+- examples/core/recipes/default.rb
+- examples/core/spec/default_spec.rb
+- examples/core/spec/non_recipe_spec.rb
 - examples/cron/recipes/create.rb
 - examples/cron/recipes/delete.rb
 - examples/cron/spec/create_spec.rb
@@ -154,6 +158,8 @@ files:
 - examples/custom_resource/recipes/default.rb
 - examples/custom_resource/resources/custom_resource.rb
 - examples/custom_resource/spec/default_spec.rb
+- examples/custom_resource_block/resources/default.rb
+- examples/custom_resource_block/spec/default_spec.rb
 - examples/directory/recipes/create.rb
 - examples/directory/recipes/delete.rb
 - examples/directory/spec/create_spec.rb
@@ -282,6 +288,9 @@ files:
 - examples/launchd/spec/delete_spec.rb
 - examples/launchd/spec/disable_spec.rb
 - examples/launchd/spec/enable_spec.rb
+- examples/library_patch/libraries/default.rb
+- examples/library_patch/recipes/default.rb
+- examples/library_patch/spec/default_spec.rb
 - examples/link/recipes/create.rb
 - examples/link/recipes/delete.rb
 - examples/link/recipes/link_to.rb
@@ -398,6 +407,9 @@ files:
 - examples/reboot/spec/cancel_spec.rb
 - examples/reboot/spec/now_spec.rb
 - examples/reboot/spec/request_spec.rb
+- examples/recipe_block/metadata.rb
+- examples/recipe_block/spec/recipe_block_spec.rb
+- examples/recipe_block/templates/apache2.conf.erb
 - examples/registry_key/recipes/create.rb
 - examples/registry_key/recipes/create_if_missing.rb
 - examples/registry_key/recipes/delete.rb
@@ -447,6 +459,8 @@ files:
 - examples/ruby_block/recipes/run.rb
 - examples/ruby_block/spec/create_spec.rb
 - examples/ruby_block/spec/run_spec.rb
+- examples/runner/recipes/default.rb
+- examples/runner/spec/default_spec.rb
 - examples/script/recipes/run_bash.rb
 - examples/script/recipes/run_csh.rb
 - examples/script/recipes/run_ksh.rb
@@ -500,6 +514,15 @@ files:
 - examples/solaris_package/spec/install_spec.rb
 - examples/solaris_package/spec/remove_spec.rb
 - examples/solaris_package/spec/upgrade_spec.rb
+- examples/spec_attributes/attributes/default.rb
+- examples/spec_attributes/recipes/default.rb
+- examples/spec_attributes/spec/default_spec.rb
+- examples/spec_platform/recipes/default.rb
+- examples/spec_platform/spec/default_spec.rb
+- examples/spec_step_into/recipes/default.rb
+- examples/spec_step_into/resources/one.rb
+- examples/spec_step_into/resources/two.rb
+- examples/spec_step_into/spec/default_spec.rb
 - examples/state_attrs/providers/lwrp.rb
 - examples/state_attrs/recipes/default.rb
 - examples/state_attrs/resources/lwrp.rb
@@ -523,6 +546,9 @@ files:
 - examples/stub_search/recipes/default.rb
 - examples/stub_search/spec/block_spec.rb
 - examples/stub_search/spec/default_spec.rb
+- examples/stubs_for/resources/default.rb
+- examples/stubs_for/resources/old.rb
+- examples/stubs_for/spec/default_spec.rb
 - examples/subscribes/recipes/before.rb
 - examples/subscribes/recipes/chained.rb
 - examples/subscribes/recipes/default.rb
@@ -643,6 +669,8 @@ files:
 - examples/zypper_package/spec/upgrade_spec.rb
 - lib/chefspec.rb
 - lib/chefspec/api.rb
+- lib/chefspec/api/core.rb
+- lib/chefspec/api/described.rb
 - lib/chefspec/api/do_nothing.rb
 - lib/chefspec/api/include_recipe.rb
 - lib/chefspec/api/link.rb
@@ -650,6 +678,8 @@ files:
 - lib/chefspec/api/reboot.rb
 - lib/chefspec/api/render_file.rb
 - lib/chefspec/api/state_attrs.rb
+- lib/chefspec/api/stubs.rb
+- lib/chefspec/api/stubs_for.rb
 - lib/chefspec/api/subscriptions.rb
 - lib/chefspec/api/user.rb
 - lib/chefspec/berkshelf.rb
@@ -663,16 +693,18 @@ files:
 - lib/chefspec/extensions/chef/client.rb
 - lib/chefspec/extensions/chef/conditional.rb
 - lib/chefspec/extensions/chef/cookbook/gem_installer.rb
+- lib/chefspec/extensions/chef/cookbook_loader.rb
 - lib/chefspec/extensions/chef/cookbook_uploader.rb
 - lib/chefspec/extensions/chef/data_query.rb
 - lib/chefspec/extensions/chef/lwrp_base.rb
+- lib/chefspec/extensions/chef/provider.rb
 - lib/chefspec/extensions/chef/resource.rb
 - lib/chefspec/extensions/chef/resource/freebsd_package.rb
+- lib/chefspec/extensions/chef/run_context/cookbook_compiler.rb
 - lib/chefspec/extensions/chef/securable.rb
 - lib/chefspec/file_cache_path_proxy.rb
 - lib/chefspec/formatter.rb
 - lib/chefspec/librarian.rb
-- lib/chefspec/macros.rb
 - lib/chefspec/matchers.rb
 - lib/chefspec/matchers/do_nothing_matcher.rb
 - lib/chefspec/matchers/include_recipe_matcher.rb
@@ -686,6 +718,7 @@ files:
 - lib/chefspec/policyfile.rb
 - lib/chefspec/renderer.rb
 - lib/chefspec/rspec.rb
+- lib/chefspec/runner.rb
 - lib/chefspec/server.rb
 - lib/chefspec/server_methods.rb
 - lib/chefspec/server_runner.rb
@@ -742,6 +775,7 @@ files:
 - templates/errors/may_need_to_specify_platform.erb
 - templates/errors/no_conversion_error.erb
 - templates/errors/not_stubbed.erb
+- templates/errors/shell_out_not_stubbed.erb
 - templates/errors/template_not_found.erb
 homepage: https://sethvargo.github.io/chefspec/
 licenses:
@@ -763,7 +797,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Write RSpec examples and generate coverage reports for Chef recipes!

data/lib/chefspec/macros.rb

@@ -1,222 +0,0 @@
-module ChefSpec
-  module Macros
-    extend self
-
-    #
-    # 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
-
-    #
-    # Stub a shell command to return a particular value without
-    # shelling out to the system.
-    #
-    # @example stubbing a command to return true
-    #   stub_command('test -f /tmp/bacon').and_return(true)
-    #
-    # @example stubbing a block that is evaluated at runtime
-    #   stub_command('test -f /tmp/bacon') { MyClass.check? }
-    #
-    # @example stubbing a command that matches a pattern
-    #   stub_command(/test \-f/).and_return(true)
-    #
-    # @example stubbing a command that raises an exception
-    #   stub_command('test -f /tmp/bacon').and_raise(SomeException)
-    #
-    #
-    # @param [String, Regexp] command
-    #   the command to stub
-    #
-    # @return [ChefSpec::CommandStub]
-    #
-    def stub_command(command, &block)
-      Stubs::CommandRegistry.register(Stubs::CommandStub.new(command, &block))
-    end
-
-    #
-    # Stub a Chef call to load a data_bag.
-    #
-    # @example stubbing a data_bag to return an empty Array
-    #   stub_data_bag('users').and_return([])
-    #
-    # @example stubbing a data_bag with a block that is evaluated at runtime
-    #   stub_data_bag('users') { JSON.parse(File.read('fixtures/data_bag.json')) }
-    #
-    # @example stubbing a data_bag to return an Array of Hashes
-    #   stub_data_bag('users').and_return([
-    #     { id: 'bacon', comment: 'delicious' },
-    #     { id: 'ham', comment: 'also good' }
-    #   ])
-    #
-    # @example stubbing a data_bag to raise an exception
-    #   stub_data_bag('users').and_raise(Chef::Exceptions::PrivateKeyMissing)
-    #
-    #
-    # @param [String, Symbol] bag
-    #   the name of the data bag to stub
-    #
-    # @return [ChefSpec::DataBagStub]
-    #
-    def stub_data_bag(bag, &block)
-      Stubs::DataBagRegistry.register(Stubs::DataBagStub.new(bag, &block))
-    end
-
-    #
-    # Stub a Chef data_bag call.
-    #
-    # @example stubbing a data_bag_item to return a Hash of data
-    #   stub_data_bag_item('users', 'svargo').and_return({
-    #     id: 'svargo',
-    #     name: 'Seth Vargo'
-    #   })
-    #
-    # @example stubbing a data_bag_item with a block that is evaluated at runtime
-    #   stub_data_bag_item('users', 'svargo') { JSON.parse(File.read('fixtures/data_bag_item.json')) }
-    #
-    # @example stubbing a data_bag_item to raise an exception
-    #   stub_data_bag('users', 'svargo').and_raise(Chef::Exceptions::PrivateKeyMissing)
-    #
-    #
-    # @param [String, Symbol] bag
-    #   the name of the data bag to find the item in
-    # @param [String] id
-    #   the id of the data bag item to stub
-    #
-    # @return [ChefSpec::DataBagItemStub]
-    #
-    def stub_data_bag_item(bag, id, &block)
-      Stubs::DataBagItemRegistry.register(Stubs::DataBagItemStub.new(bag, id, &block))
-    end
-
-    #
-    # Creates a fake Chef::Node for use in testing.
-    #
-    # @example mocking a simple node
-    #   stub_node('mynode.example')
-    #
-    # @example mocking a specific platform and version
-    #   stub_node('mynode.example', platform: 'ubuntu', version: '16.04')
-    #
-    # @example overriding a specific ohai attribute
-    #   stub_node('mynode.example', ohai: { ipaddress: '1.2.3.4' })
-    #
-    # @example stubbing a node based on a JSON fixture
-    #   stub_node('mynode.example', path: File.join('fixtures', 'nodes', 'default.json'))
-    #
-    # @example setting specific attributes
-    #   stub_node('mynode.example') do |node|
-    #     node.default['attribute']['thing'] = 'value'
-    #   end
-    #
-    #
-    # @param [String] name
-    #   the name of the node
-    # @param [Hash] options
-    #   the list of options for the node
-    #
-    # @option options [Symbol] :platform
-    #   the platform to mock
-    # @option options [Symbol] :version
-    #   the version of the platform to mock
-    # @option options [Symbol] :path
-    #   filepath to a JSON file to pull a node from
-    # @option options [Hash] :ohai
-    #   a Hash of Ohai attributes to mock on the node
-    #
-    # @return [Chef::Node]
-    #
-    def stub_node(*args, &block)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      name    = args.first || 'node.example'
-
-      fauxhai = Fauxhai.mock(options).data
-      fauxhai = fauxhai.merge(options[:ohai] || {})
-      fauxhai = Mash.new(fauxhai)
-
-      node = Chef::Node.new
-      node.name(name)
-      node.automatic_attrs = fauxhai
-      node.instance_eval(&block) if block_given?
-      node
-    end
-
-    #
-    # Stub a Chef search to return pre-defined data. When providing a value,
-    # the value is automatically mashified (to the best of ChefSpec's abilities)
-    # to ease in use.
-    #
-    # @example stubbing a search to return nothing
-    #   stub_search(:node)
-    #
-    # @example stubbing a search with a query
-    #   stub_search(:node, 'name:*')
-    #
-    # @example stubbing a search with a query as a regex
-    #   stub_search(:node, /name:(.+)/)
-    #
-    # @example stubbing a search with a block that is evaluated at runtime
-    #   stub_search(:node) { JSON.parse(File.read('fixtures/nodes.json')) }
-    #
-    # @example stubbing a search to return a fixed value
-    #   stub_search(:node).and_return([ { a: 'b' } ])
-    #
-    # @example stubbing a search to raise an exception
-    #   stub_search(:node).and_raise(Chef::Exceptions::PrivateKeyMissing)
-    #
-    #
-    # @param [String, Symbol] type
-    #   the type to search to stub
-    # @param [String, Symbol, nil] query
-    #   the query to stub
-    #
-    # @return [ChefSpec::SearchStub]
-    #
-    def stub_search(type, query = '*:*', &block)
-      Stubs::SearchRegistry.register(Stubs::SearchStub.new(type, query, &block))
-    end
-  end
-end