chefspec 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83803766a872ecfb05eeea5ecf9f715ca7cfa0e1
-  data.tar.gz: 43ff5901db1916b48a225a6f5576502c12892002
+  metadata.gz: db7a5ff46f8abc2437123170af409eee038f23bb
+  data.tar.gz: 37af4d6d9df0ec11b63c73c2ee4d5bb7735c0406
 SHA512:
-  metadata.gz: 0020a9532258bf130a8c7b1de8372f09f7b07d03b39f697372b0172b4ed596bee0bce3dfdef169e85fedd413d5f7199727bc6109e8f22c0de34ef4d037f7d1d1
-  data.tar.gz: 3ddb0c339391d19642ce896041fc2e9fa39545f6c2c4413f3bd530d93b16f81b878a604319321b642f4de89264811317eb62dda35f9bf5ea84e1900c3011ff94
+  metadata.gz: 9e9f02d613fe796154fcec30b55d6f716ccb9851aca20a6dc9c632247280658fa88ad9adc13ce56417be0f7c67dd833fb3292260244b664c0156ce7ab36d7f2a
+  data.tar.gz: 785722986b2db643a6b4023b8c5d77562d1e91ca1d54df5e453f83bcb1dbc93d6776d4d5b7149652cc00fe10ac12ae7b7a4f55498caeb16ab922dc013041a401

data/.travis.yml

@@ -2,9 +2,11 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+
 branches:
   only:
     - master
+
 notifications:
   irc:
     channels:
@@ -13,6 +15,9 @@ notifications:
     skip_join: true
     template:
       - "%{message} (%{author}): %{build_url}"
+
+bundler_args: --jobs 7
+
 gemfile:
   - gemfiles/chef-11.0.0.gemfile
   - gemfiles/chef-11.2.0.gemfile
@@ -20,6 +25,7 @@ gemfile:
   - gemfiles/chef-11.6.0.gemfile
   - gemfiles/chef-11.8.0.gemfile
   - gemfiles/chef-master.gemfile
+
 matrix:
   fast_finish: true
   allow_failures:

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 CHANGELOG for ChefSpec
 ======================
 
+## 3.3.2 (March 16, 2014)
+Bugfixes:
+  - Restore Berkshelf 2 support (missing edge case)
+  - Add negative failure message for subscribes/notifies matchers
+
+Features:
+  - Added `do_nothing` matcher for asserting a resource performed no actions
+
+Improvements:
+  - Increased spec coverage for matchers
+  - Support RSpec matchers in `with_content`
+
 ## 3.3.1 (March 11, 2014)
 Bugfixes:
   - Various typographical fixes in the README

data/README.md

@@ -267,7 +267,13 @@ expect(chef_run).to render_file('/etc/foo').with_content('This is content')
 expect(chef_run).to render_file('/etc/foo').with_content(/regex works too.+/)
 ```
 
-Additionally, it is possible to assert which [Chef phase of execution](http://docs.opscode.com/essentials_nodes_chef_run.html) a resource is created. Given a resource that is installed at compile time using `run_action`:
+You can use any RSpec content matcher inside of the `with_content` predicate:
+
+```ruby
+expect(chef_run).to render_file('/etc/foo').with_content(start_with('# First line'))
+```
+
+It is possible to assert which [Chef phase of execution](http://docs.opscode.com/essentials_nodes_chef_run.html) a resource is created. Given a resource that is installed at compile time using `run_action`:
 
 ```ruby
 package('apache2').run_action(:install)
@@ -287,6 +293,14 @@ expect(chef_run).to install_package('apache2').at_converge_time
 
 Since "converge time" is the default behavior for all recipes, this test might be redundant and the predicate could be dropped depending on your situation.
 
+##### do_nothing
+Assert that a resource performs no action
+
+```ruby
+resource = chef_run.execute('install')
+expect(resource).to do_nothing
+```
+
 **For more complex examples, please see the [examples directory](https://github.com/sethvargo/chefspec/tree/master/examples) or the [Yard documentation](http://rubydoc.info/github/sethvargo/chefspec).**
 
 

data/examples/do_nothing/recipes/default.rb

@@ -0,0 +1,3 @@
+execute 'install' do
+  action :nothing
+end

data/examples/do_nothing/spec/default_spec.rb

@@ -0,0 +1,15 @@
+require 'chefspec'
+
+describe 'do_nothing::default' do
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+
+  it 'includes the `other` recipe' do
+    execute = chef_run.execute('install')
+    expect(execute).to do_nothing
+  end
+
+  it 'does not include the `not` recipe' do
+    execute = chef_run.execute('not_install')
+    expect(execute).to_not do_nothing
+  end
+end

data/examples/render_file/spec/default_spec.rb

@@ -18,6 +18,15 @@ describe 'render_file::default' do
       expect(chef_run).to render_file('/tmp/file').with_content(/^This(.+)$/)
       expect(chef_run).to_not render_file('/tmp/file').with_content(/^Not(.+)$/)
     end
+
+    it 'renders the file with content matching arbitrary matcher' do
+      expect(chef_run).to render_file('/tmp/file').with_content(
+        start_with('This')
+      )
+      expect(chef_run).to_not render_file('/tmp/file').with_content(
+        end_with('not')
+      )
+    end
   end
 
   context 'cookbook_file' do
@@ -35,6 +44,15 @@ describe 'render_file::default' do
       expect(chef_run).to render_file('/tmp/cookbook_file').with_content(/^This(.+)$/)
       expect(chef_run).to_not render_file('/tmp/cookbook_file').with_content(/^Not(.+)$/)
     end
+
+    it 'renders the file with content matching arbitrary matcher' do
+      expect(chef_run).to render_file('/tmp/cookbook_file').with_content(
+        start_with('This')
+      )
+      expect(chef_run).to_not render_file('/tmp/cookbook_file').with_content(
+        end_with('not')
+      )
+    end
   end
 
   context 'template' do
@@ -52,6 +70,15 @@ describe 'render_file::default' do
       expect(chef_run).to render_file('/tmp/template').with_content(/^This(.+)$/)
       expect(chef_run).to_not render_file('/tmp/template').with_content(/^Not(.+)$/)
     end
+
+    it 'renders the file with content matching arbitrary matcher' do
+      expect(chef_run).to render_file('/tmp/template').with_content(
+        start_with('This')
+      )
+      expect(chef_run).to_not render_file('/tmp/template').with_content(
+        end_with('not')
+      )
+    end
   end
 
   context 'template with render' do

data/features/do_nothing.feature

@@ -0,0 +1,10 @@
+Feature: The do_nothing matcher
+  Background:
+    * I am using the "do_nothing" cookbook
+
+  Scenario Outline: Running specs
+    * I successfully run `rspec spec/<Matcher>_spec.rb`
+    * the output should contain "0 failures"
+  Examples:
+    | Matcher |
+    | default |

data/lib/chefspec/api.rb

@@ -34,6 +34,7 @@ require_relative 'api/cron'
 require_relative 'api/deploy'
 require_relative 'api/directory'
 require_relative 'api/dpkg_package'
+require_relative 'api/do_nothing'
 require_relative 'api/easy_install_package'
 require_relative 'api/env'
 require_relative 'api/erl_call'

data/lib/chefspec/api/do_nothing.rb

@@ -0,0 +1,24 @@
+module ChefSpec::API
+  # @since 3.4.0
+  module DoNothingMatchers
+    #
+    # 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
+    end
+  end
+end

data/lib/chefspec/api/render_file.rb

@@ -16,6 +16,9 @@ module ChefSpec::API
     # @example Assert a template is rendered with matching content
     #   expect(template).to render_file('/etc/foo').with_content(/^This(.+)$/)
     #
+    # @example Assert a template is rendered with content matching any RSpec matcher
+    #   expect(template).to render_file('/etc/foo').with_content(starts_with('This'))
+    #
     # @example Assert a partial path to a template is rendered with matching content
     #   expect(template).to render_file(/\/etc\/foo-(\d+)$/).with_content(/^This(.+)$/)
     #

data/lib/chefspec/coverage/filters.rb

@@ -56,10 +56,14 @@ module ChefSpec
             .select(&:metadata?)
             .map(&:name)
         else
-          berksfile.sources.select(&:location)
-            .map(&:location)
-            .select(&:metadata?)
-            .map(&:name)
+          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
 

data/lib/chefspec/matchers.rb

@@ -1,5 +1,6 @@
 module ChefSpec
   module Matchers
+    require_relative 'matchers/do_nothing_matcher'
     require_relative 'matchers/include_recipe_matcher'
     require_relative 'matchers/link_to_matcher'
     require_relative 'matchers/notifications_matcher'

data/lib/chefspec/matchers/do_nothing_matcher.rb

@@ -0,0 +1,50 @@
+module ChefSpec::Matchers
+  class DoNothingMatcher
+    def matches?(resource)
+      @resource = resource
+
+      if @resource
+        actions = @resource.performed_actions
+        actions.empty? || actions == [:nothing]
+      else
+        false
+      end
+    end
+
+    def description
+      'do nothing'
+    end
+
+    def failure_message_for_should
+      if @resource
+        message =  %|expected #{@resource} to do nothing, but the following |
+        message << %|actions were performed:|
+        message << %|\n\n|
+        @resource.performed_actions.each do |action|
+          message << %|  :#{action}|
+        end
+        message
+      else
+        message =  %|expected _something_ to do nothing, but the _something_ |
+        message << %|you gave me was nil! If you are running a test like:|
+        message << %|\n\n|
+        message << %|  expect(_something_).to do_nothing|
+        message << %|\n\n|
+        message << %|make sure that `_something_` exists, because I got nil!|
+        message
+      end
+    end
+
+    def failure_message_for_should_not
+      if @resource
+        message =  %|expected #{@resource} to do something, but no actions |
+        message << %|were performed.|
+        message
+      else
+        message =  %|expected _something_ to do something, but no actions |
+        message << %|were performed.|
+        message
+      end
+    end
+  end
+end

data/lib/chefspec/matchers/notifications_matcher.rb

@@ -53,7 +53,7 @@ module ChefSpec::Matchers
 
     def failure_message_for_should
       if @resource
-        message = %Q{expected "#{resource_name(@resource)}[#{@resource.name}]" to notify "#{@expected_resource_type}[#{@expected_resource_name}]"}
+        message = %Q{expected "#{@resource}" to notify "#{@expected_resource_type}[#{@expected_resource_name}]"}
         message << " with action :#{@action}" if @action
         message << " immediately" if @immediately
         message << " delayed" if @delayed
@@ -77,6 +77,14 @@ module ChefSpec::Matchers
       end
     end
 
+    def failure_message_for_should_not
+      if @resource
+        message = %Q{expected "#{@resource}" to not notify "#{@expected_resource_type}[#{@expected_resource_name}]"}
+        message << ", but it did."
+        message
+      end
+    end
+
     private
 
     def all_notifications

data/lib/chefspec/matchers/render_file_matcher.rb

@@ -29,9 +29,9 @@ module ChefSpec::Matchers
     def failure_message_for_should
       message = %Q{expected Chef run to render "#{@path}"}
       if @expected_content
-        message << " with:"
+        message << " matching:"
         message << "\n\n"
-        message << @expected_content.to_s
+        message << expected_content_message
         message << "\n\n"
         message << "but got:"
         message << "\n\n"
@@ -44,9 +44,9 @@ module ChefSpec::Matchers
     def failure_message_for_should_not
       message = %Q{expected file "#{@path}"}
       if @expected_content
-        message << " with:"
+        message << " matching:"
         message << "\n\n"
-        message << @expected_content.to_s
+        message << expected_content_message
         message << "\n\n"
       end
       message << " to not be in Chef run"
@@ -55,6 +55,14 @@ module ChefSpec::Matchers
 
     private
 
+    def expected_content_message
+      if RSpec::Matchers.is_a_matcher?(@expected_content) && @expected_content.respond_to?(:description)
+        @expected_content.description
+      else
+        @expected_content.to_s
+      end
+    end
+
     def resource
       @resource ||= @runner.find_resource(:cookbook_file, @path) ||
                     @runner.find_resource(:file, @path) ||
@@ -88,6 +96,8 @@ module ChefSpec::Matchers
 
       if @expected_content.is_a?(Regexp)
         @actual_content =~ @expected_content
+      elsif RSpec::Matchers.is_a_matcher?(@expected_content)
+        @expected_content.matches?(@actual_content)
       else
         @actual_content.include?(@expected_content)
       end

data/lib/chefspec/matchers/subscribes_matcher.rb

@@ -55,5 +55,9 @@ module ChefSpec::Matchers
     def failure_message_for_should
       @instance.failure_message_for_should
     end
+
+    def failure_message_for_should_not
+      @instance.failure_message_for_should_not
+    end
   end
 end

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '3.3.1'
+  VERSION = '3.4.0'
 end

data/spec/unit/matchers/do_nothing_matcher.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ChefSpec::Matchers::DoNothingMatcher do
+  pending
+end

data/spec/unit/matchers/notifications_matcher_spec.rb

@@ -1,5 +1,39 @@
 require 'spec_helper'
 
 describe ChefSpec::Matchers::NotificationsMatcher do
-  pending
+  subject { described_class.new('execute[install]') }
+  let(:package) do
+    double('package',
+      name: 'package',
+      to_s: 'package[foo]',
+      is_a?: true,
+      performed_action?: true,
+      immediate_notifications: [],
+      delayed_notifications: [],
+    )
+  end
+
+  describe '#failure_message_for_should' do
+    it 'has the right value' do
+      subject.matches?(package)
+      expect(subject.failure_message_for_should)
+        .to include %|expected "package[foo]" to notify "execute[install]", but did not.|
+    end
+  end
+
+  describe '#failure_message_for_should_not' do
+    it 'has the right value' do
+      subject.matches?(package)
+      expect(subject.failure_message_for_should_not)
+        .to eq %|expected "package[foo]" to not notify "execute[install]", but it did.|
+    end
+  end
+
+  describe '#description' do
+    it 'has the right value' do
+      subject.matches?(package)
+      expect(subject.description)
+        .to eq %|notify "execute[install]"|
+    end
+  end
 end

data/spec/unit/matchers/subscribes_matcher_spec.rb

@@ -1,5 +1,64 @@
 require 'spec_helper'
 
 describe ChefSpec::Matchers::SubscribesMatcher do
-  pending
+  subject { described_class.new('execute[install]') }
+  let(:runner) { double('runner', find_resource: nil) }
+  let(:run_context) { double('run_context', node: node) }
+  let(:node) { double('node', runner: runner) }
+  let(:package) do
+    double('package',
+      name: 'package',
+      to_s: 'package[foo]',
+      run_context: run_context,
+    )
+  end
+
+  context 'when no resource is found' do
+    describe '#failure_message_for_should' do
+      it 'has the right value' do
+        subject.matches?(package)
+        expect(subject.failure_message_for_should)
+          .to include %|expected _something_ to notify "package[foo]", but the _something_ you gave me was nil! If you are running a test like:|
+      end
+    end
+  end
+
+  context 'when the resource exists' do
+    let(:execute) do
+      double('execute',
+        name: 'execute',
+        to_s: 'execute[install]',
+        immediate_notifications: [],
+        delayed_notifications: [],
+      )
+    end
+
+    before do
+      runner.stub(:find_resource).and_return(execute)
+    end
+
+    describe '#failure_message_for_should' do
+      it 'has the right value' do
+        subject.matches?(package)
+        expect(subject.failure_message_for_should)
+          .to include %|expected "execute[install]" to notify "package[foo]", but did not.|
+      end
+    end
+
+    describe '#failure_message_for_should_not' do
+      it 'has the right value' do
+        subject.matches?(package)
+        expect(subject.failure_message_for_should_not)
+          .to eq %|expected "execute[install]" to not notify "package[foo]", but it did.|
+      end
+    end
+  end
+
+  describe '#description' do
+    it 'has the right value' do
+      subject.matches?(package)
+      expect(subject.description)
+        .to eq %|notify "package[foo]"|
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Andrew Crump
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -201,6 +201,8 @@ files:
 - examples/directory/recipes/delete.rb
 - examples/directory/spec/create_spec.rb
 - examples/directory/spec/delete_spec.rb
+- examples/do_nothing/recipes/default.rb
+- examples/do_nothing/spec/default_spec.rb
 - examples/dpkg_package/recipes/install.rb
 - examples/dpkg_package/recipes/purge.rb
 - examples/dpkg_package/recipes/remove.rb
@@ -553,6 +555,7 @@ files:
 - features/custom_matcher.feature
 - features/deploy.feature
 - features/directory.feature
+- features/do_nothing.feature
 - features/dpkg_package.feature
 - features/easy_install_package.feature
 - features/env.feature
@@ -628,6 +631,7 @@ files:
 - lib/chefspec/api/cron.rb
 - lib/chefspec/api/deploy.rb
 - lib/chefspec/api/directory.rb
+- lib/chefspec/api/do_nothing.rb
 - lib/chefspec/api/dpkg_package.rb
 - lib/chefspec/api/easy_install_package.rb
 - lib/chefspec/api/env.rb
@@ -687,6 +691,7 @@ files:
 - 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
 - lib/chefspec/matchers/link_to_matcher.rb
 - lib/chefspec/matchers/notifications_matcher.rb
@@ -719,6 +724,7 @@ files:
 - spec/unit/expect_exception_spec.rb
 - spec/unit/extensions/lwrp_base_spec.rb
 - spec/unit/macros_spec.rb
+- spec/unit/matchers/do_nothing_matcher.rb
 - spec/unit/matchers/include_recipe_matcher_spec.rb
 - spec/unit/matchers/link_to_matcher_spec.rb
 - spec/unit/matchers/notifications_matcher_spec.rb
@@ -778,6 +784,7 @@ test_files:
 - features/custom_matcher.feature
 - features/deploy.feature
 - features/directory.feature
+- features/do_nothing.feature
 - features/dpkg_package.feature
 - features/easy_install_package.feature
 - features/env.feature
@@ -846,6 +853,7 @@ test_files:
 - spec/unit/expect_exception_spec.rb
 - spec/unit/extensions/lwrp_base_spec.rb
 - spec/unit/macros_spec.rb
+- spec/unit/matchers/do_nothing_matcher.rb
 - spec/unit/matchers/include_recipe_matcher_spec.rb
 - spec/unit/matchers/link_to_matcher_spec.rb
 - spec/unit/matchers/notifications_matcher_spec.rb