chefspec 3.1.4 → 3.2.0

data/lib/chefspec/server.rb

@@ -40,16 +40,16 @@ class ChefSpec::Runner
 
   private
 
-    #
-    # Upload the cookbooks to the Chef Server.
-    #
-    def upload_cookbooks!
-      loader = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
-      loader.load_cookbooks
+  #
+  # Upload the cookbooks to the Chef Server.
+  #
+  def upload_cookbooks!
+    loader = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
+    loader.load_cookbooks
 
-      uploader = Chef::CookbookUploader.new(loader.cookbooks, loader.cookbook_paths)
-      uploader.upload_cookbooks
-    end
+    uploader = Chef::CookbookUploader.new(loader.cookbooks, loader.cookbook_paths)
+    uploader.upload_cookbooks
+  end
 end
 
 module ChefSpec
@@ -99,13 +99,11 @@ module ChefSpec
     def self.entity(method, klass, key)
       class_eval <<-EOH, __FILE__, __LINE__ + 1
         def create_#{method}(name, data = {})
-          unless '#{key}' == 'data'
-            # Automatically set the "name" if no explicit one was given
-            data[:name] ||= name
+          # Automatically set the "name" if no explicit one was given
+          data[:name] ||= name
 
-            # Convert it to JSON
-            data = JSON.fast_generate(data)
-          end
+          # Convert it to JSON
+          data = JSON.fast_generate(data)
 
           @server.load_data('#{key}' => { name => data })
         end
@@ -155,6 +153,53 @@ module ChefSpec
     entity :node,        Chef::Node, 'nodes'
     entity :role,        Chef::Role, 'roles'
 
+    #
+    # Create a new data_bag on the Chef Server. This overrides the method
+    # created by {entity}
+    #
+    # @param [String] name
+    #   the name of the data bag
+    # @param [Hash] data
+    #   the data to load into the data bag
+    #
+    def create_data_bag(name, data = {})
+      @server.load_data('data' => { name => data })
+    end
+
+    #
+    # Create a new node on the Chef Server. This overrides the method created
+    # by {entity}, permitting users to pass a raw +Chef::Node+ object in
+    # addition to a hash.
+    #
+    # @example Create a node from a hash
+    #
+    #   create_node('bacon', attribute: 'value')
+    #
+    # @example Create a node from a +Chef::Node+ object
+    #
+    #   node = stub_node('bacon', platform: 'ubuntu', version: '12.04')
+    #   create_node(node)
+    #
+    # @param [String, Chef::Node] object
+    #   the object to create; this can be the name of the node, or an actual
+    #   +Chef::Node+ object
+    # @param [Hash] data
+    #   the list of data to populate the node with; this is ignored if an
+    #   actual node object is given
+    #
+    def create_node(object, data = {})
+      if object.is_a?(Chef::Node)
+        name = object.name
+        data = object.to_json
+      else
+        name = object.to_s
+        data[:name] ||= name
+        data = JSON.fast_generate(data)
+      end
+
+      @server.load_data('nodes' => { name => data })
+    end
+
     #
     # The path to the insecure Chef Zero private key on disk. Because Chef
     # requires the path to a file instead of the contents of the key (why),
@@ -201,31 +246,31 @@ module ChefSpec
 
     private
 
-      #
-      # The directory where any cache information (such as private keys) should
-      # be stored. This cache is destroyed at the end of the run.
-      #
-      # @return [String]
-      #   the path to the cache directory on disk
-      #
-      def cache_dir
-        @cache_dir ||= Dir.mktmpdir(['chefspec', 'cache'])
-      end
+    #
+    # The directory where any cache information (such as private keys) should
+    # be stored. This cache is destroyed at the end of the run.
+    #
+    # @return [String]
+    #   the path to the cache directory on disk
+    #
+    def cache_dir
+      @cache_dir ||= Dir.mktmpdir(['chefspec', 'cache'])
+    end
 
-      #
-      # Shortcut method for loading data into Chef Zero.
-      #
-      # @param [String, Symbol] key
-      #   the key to load
-      # @param [String] name
-      #   the name or id of the item to load
-      # @param [Hash] data
-      #   the data for the object, which will be converted to JSON and uploaded
-      #   to the server
-      #
-      def load_data(key, name, data = {})
-        @server.load_data(key.to_s => { name => JSON.fast_generate(data) })
-      end
+    #
+    # Shortcut method for loading data into Chef Zero.
+    #
+    # @param [String, Symbol] key
+    #   the key to load
+    # @param [String] name
+    #   the name or id of the item to load
+    # @param [Hash] data
+    #   the data for the object, which will be converted to JSON and uploaded
+    #   to the server
+    #
+    def load_data(key, name, data = {})
+      @server.load_data(key.to_s => { name => JSON.fast_generate(data) })
+    end
   end
 end
 

data/lib/chefspec/stubs/stub.rb

@@ -22,16 +22,17 @@ module ChefSpec
       end
 
       private
-        def recursively_mashify(thing)
-          case thing
-          when Array
-            thing.collect { |item| recursively_mashify(item) }
-          when Hash
-            Mash.from_hash(thing)
-          else
-            thing
-          end
+
+      def recursively_mashify(thing)
+        case thing
+        when Array
+          thing.collect { |item| recursively_mashify(item) }
+        when Hash
+          Mash.from_hash(thing)
+        else
+          thing
         end
+      end
     end
   end
 end

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '3.1.4'
+  VERSION = '3.2.0'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'chefspec'
+require 'support/hash'
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+  config.filter_run(focus: true)
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/hash.rb

@@ -0,0 +1,35 @@
+#
+# An extension of a Hash that allows mash-style like lookups.
+#
+# @private
+#
+class Hash
+  # Like, seriously Windows?
+  undef_method(:timeout)
+
+  #
+  # Monkey-patch to allow mash-style look ups for tests
+  #
+  def method_missing(m, *args, &block)
+    if has_key?(m.to_sym)
+      self[m.to_sym]
+    elsif has_key?(m.to_s)
+      self[m.to_s]
+    else
+      super
+    end
+  end
+
+  #
+  # Monkey-patch to stdlib Hash to correspond to Mash-style lookup
+  #
+  # @see Hash#respond_to?
+  #
+  def respond_to?(m, include_private = false)
+    if has_key?(m.to_sym) || has_key?(m.to_s)
+      true
+    else
+      super
+    end
+  end
+end

data/spec/unit/api_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ChefSpec::API do
+  before do
+    module ChefSpec::API
+      module CustomSubmodule
+        def custom_method; end
+      end
+    end
+  end
+
+  subject { Class.new { include ChefSpec::API }.new }
+
+  it 'includes all submodules in the including class' do
+    expect(subject).to be_a(ChefSpec::API::CustomSubmodule)
+    expect(subject).to respond_to(:custom_method)
+  end
+end

data/spec/unit/cacher_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'chefspec/cacher'
+
+describe ChefSpec::Cacher do
+  let(:klass) do
+    Class.new(RSpec::Core::ExampleGroup) do
+      extend ChefSpec::Cacher
+
+      def self.metadata
+        { example_group: { location: 'spec' } }
+      end
+    end
+  end
+
+  let(:cache) { described_class.class_variable_get(:@@cache) }
+
+  before(:each) { described_class.class_variable_set(:@@cache, {}) }
+
+  describe 'cached' do
+    it 'lazily defines the results for the cache' do
+      klass.cached(:chef_run)
+      expect(klass).to be_method_defined(:chef_run)
+    end
+
+    it 'adds the item to the cache when called' do
+      runner = double(:runner)
+      klass.cached(:chef_run) { runner }
+      klass.new.chef_run
+
+      expect(cache[Thread.current.object_id]).to have_key('spec.chef_run')
+      expect(cache[Thread.current.object_id]['spec.chef_run']).to eq(runner)
+    end
+
+    context 'when multithreaded environment' do
+      it 'is thread safe' do
+        (1..2).each do |n|
+          Thread.new do
+            klass.cached(:chef_run) { n }
+            expect(klass.new.chef_run).to eq(n)
+          end.join
+        end
+      end
+    end
+  end
+
+  describe 'cached!' do
+    it 'loads the value at runtime' do
+      expect(klass).to receive(:cached).with(:chef_run).once
+      expect(klass).to receive(:before).once
+
+      klass.cached!(:chef_run) { }
+    end
+  end
+end

data/spec/unit/expect_exception_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe ChefSpec::ExpectException do
+  context 'when there have been no `raise_error` matchers' do
+    subject { described_class.new(Exception) }
+
+    it 'does not match' do
+      RSpec::Matchers::BuiltIn::RaiseError.stub(:last_run).and_return(nil)
+      expect(subject.expected?).to be_false
+    end
+  end
+
+  context 'when the last error does not match the expected type' do
+    subject { described_class.new(RuntimeError) }
+
+    it 'does not match' do
+      last_error = double('last error', expected_error: ArgumentError)
+      RSpec::Matchers::BuiltIn::RaiseError.stub(:last_run).and_return(last_error)
+      expect(subject.expected?).to be_false
+    end
+  end
+
+  context 'when the last error matches the expected type' do
+    subject { described_class.new(RuntimeError) }
+
+    it 'does not match' do
+      last_error = double('last error', expected_error: RuntimeError)
+      RSpec::Matchers::BuiltIn::RaiseError.stub(:last_run).and_return(last_error)
+      expect(subject.expected?).to be_true
+    end
+  end
+end

data/spec/unit/extensions/lwrp_base_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+# Don't run this test on older versions of Chef
+if Chef::VERSION >= '11.0.0'
+
+  module ChefSpec
+    module Extensions
+      describe :LWRPBase do
+        describe '#remove_existing_lwrp' do
+          before do
+            Chef::Provider::MysqlDatabase = nil
+            Chef::Resource::MysqlDatabase = nil
+          end
+
+          after do
+            [Chef::Provider, Chef::Resource].each do |mod|
+              next unless mod.const_defined?(:MysqlDatabase, false)
+              mod.send(:remove_const, :MysqlDatabase)
+            end
+          end
+
+          context Chef::Provider do
+            before do
+              Chef::Provider::LWRPBase.remove_existing_lwrp('MysqlDatabase')
+            end
+
+            it 'removes the provider if it already exists' do
+              expect(Chef::Provider.constants).to_not include(:MysqlDatabase)
+            end
+
+            it 'does not remove resource'  do
+              expect(Chef::Resource.constants).to include(:MysqlDatabase)
+            end
+
+            it 'does not throw an error if the resource does not already exist' do
+              expect {
+                Chef::Provider::LWRPBase.remove_existing_lwrp 'Human'
+              }.to_not raise_error
+            end
+          end
+
+          context Chef::Resource do
+            before do
+              Chef::Resource::LWRPBase.remove_existing_lwrp('MysqlDatabase')
+            end
+
+            it 'removes the resource if it already exists' do
+              expect(Chef::Resource.constants).to_not include(:MysqlDatabase)
+            end
+
+            it 'does not remove the provider'  do
+              Chef::Resource::LWRPBase.remove_existing_lwrp('MysqlDatabase')
+              expect(Chef::Provider.constants).to include(:MysqlDatabase)
+            end
+
+            it 'does not throw an error if the resource does not already exist' do
+              expect {
+                Chef::Resource::LWRPBase.remove_existing_lwrp 'Human'
+              }.to_not raise_error
+            end
+          end
+        end
+      end
+
+      describe '#build_from_file' do
+        let(:args){ %w{mycookbook thisfile context} }
+
+        shared_context "wrapping" do
+          it 'wraps the existing chef build_from_file method' do
+            klass = mod::LWRPBase
+            allow(klass).to receive(:build_from_file_without_removal)
+            expect(klass).to receive(:build_from_file_without_removal).with(*args)
+            klass.build_from_file(*args)
+          end
+        end
+
+        context Chef::Provider do
+          let(:mod){ Chef::Provider }
+          include_context "wrapping"
+        end
+
+        context Chef::Resource do
+          let(:mod){ Chef::Resource }
+          include_context "wrapping"
+        end
+      end
+    end
+  end
+end

data/spec/unit/macros_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe ChefSpec::Macros do
+  describe '#stub_command' do
+    let(:command_stub) { double('command') }
+
+    it 'adds the command to the command registry' do
+      ChefSpec::Stubs::CommandStub.stub(:new).and_return(command_stub)
+      described_class.stub_command('echo "hello"')
+
+      expect(ChefSpec::Stubs::CommandRegistry.stubs).to include(command_stub)
+    end
+  end
+
+  describe '#stub_search' do
+    let(:search_stub) { double('search') }
+
+    it 'adds the query to the search registry' do
+      ChefSpec::Stubs::SearchStub.stub(:new).and_return(search_stub)
+      described_class.stub_search(:node, '*:*')
+
+      expect(ChefSpec::Stubs::SearchRegistry.stubs).to include(search_stub)
+    end
+  end
+
+  describe '#stub_data_bag' do
+    let(:data_bag_stub) { double('data_bag') }
+
+    it 'adds the query to the data_bag registry' do
+      ChefSpec::Stubs::DataBagStub.stub(:new).and_return(data_bag_stub)
+      described_class.stub_data_bag(:users)
+
+      expect(ChefSpec::Stubs::DataBagRegistry.stubs).to include(data_bag_stub)
+    end
+  end
+
+  describe '#stub_data_bag_item' do
+    let(:data_bag_item_stub) { double('data_bag_item') }
+
+    it 'adds the query to the data_bag_item registry' do
+      ChefSpec::Stubs::DataBagItemStub.stub(:new).and_return(data_bag_item_stub)
+      described_class.stub_data_bag_item(:users, 'id')
+
+      expect(ChefSpec::Stubs::DataBagItemRegistry.stubs).to include(data_bag_item_stub)
+    end
+  end
+
+  describe '#stub_node' do
+    it 'returns a Chef::Node' do
+      expect(described_class.stub_node).to be_a(Chef::Node)
+    end
+
+    it 'defaults the node name to `node.example`' do
+      node = described_class.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')
+      expect(node.name).to eq('example.com')
+    end
+
+    it 'sets the automatic attributes' do
+      node = described_class.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' })
+      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: '12.04')
+      expect(node.automatic).to eq(Fauxhai.mock(platform: 'ubuntu', version: '12.04').data)
+    end
+
+    it 'sets the automatic attributes from a JSON data path' do
+      File.stub(:exists?).with('/path/to/json').and_return(true)
+      File.stub(:read).with('/path/to/json').and_return('{ "ipaddress": "1.2.3.4" }')
+      node = described_class.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)
+    end
+  end
+end
+
+describe 'nginx::source' do
+  describe '#described_cookbook' do
+    describe 'nginx::source' do
+      it 'returns the name of the cookbook' do
+        expect(described_cookbook).to eq('nginx')
+      end
+
+      context 'in a nested context' do
+        it 'still returns the name of the cookbook' do
+          expect(described_cookbook).to eq('nginx')
+        end
+      end
+    end
+  end
+
+  describe '#described_recipe' do
+    describe 'nginx::source' do
+      it 'returns the cookbook::recipe' do
+        expect(described_recipe).to eq('nginx::source')
+      end
+
+      context 'in a nested context' do
+        it 'still retrns the cookbook::recipe' do
+          expect(described_recipe).to eq('nginx::source')
+        end
+      end
+    end
+  end
+end