chefspec 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4abcb8430f01e2e4a0d3a1be5f8266929d2a0dbc
-  data.tar.gz: 07da81047be5641e57bb1cfd4c331b1b4082ea09
+  metadata.gz: 50dd772f6c2d50123373b31b0a8e6a405a247658
+  data.tar.gz: 8bc37a0bf75e8125a436bda5c84fe61a618062fc
 SHA512:
-  metadata.gz: cf4f698fca28f6ef69b7d7a176733cbfb0b2608c3bfb8fb8c090187391c167a87bd72564809ecd3f31f4b6e7770431aeba816450efa5c638277df31a646a5f2f
-  data.tar.gz: d7804c8c4f6f77fb783b161907524d203cdc9505bc089b9e2a46857413d1cc6d1265baee2e6a64e946d89b0eadc1a6f7205b07463deae1e1e0691b74423b5c53
+  metadata.gz: 5728bd4b70d37f1426237615aebf8a857a4c77a7d69a91ba21d8798269329de0c5b162656ab8a710830a9015fa7a3145b2222f237081e2b7491f124ff421f49c
+  data.tar.gz: 71de6b27a4bcbe114daaa379d721ac5c950c896f24c1f95110ce46c3735dfa3ee818fe873b9a5e6ecc61d3d4fe344e5507c8f372c1a78adeaa39f0b73c457e19

data/.travis.yml

@@ -17,6 +17,8 @@ gemfile: gemfiles/chefspec.gemfile
 
 env:
   - CHEF_VERSION=master
+  - CHEF_VERSION=12.7.2
+  - CHEF_VERSION=12.6.0
   - CHEF_VERSION=12.5.1
   - CHEF_VERSION=12.4.3
   - CHEF_VERSION=12.4.0

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 CHANGELOG for ChefSpec
 ======================
 
+## 4.6.0 (March 7, 2016)
+
+Improvements
+
+  - Add support for adding `berkshelf_options` to the RSpec config
+  - Add `chocolately_package` matches
+  - Support `do..end` style syntax in block expectations
+  - Output a diff when multi-line resource parameters are unmatched
+
+Bugfixes
+
+  - Update tests to include better descriptions and feature names
+  - Add support for Policyfile workflow
+
 ## 4.5.0 (December 4, 2015)
 
 Improvements

data/README.md

@@ -145,6 +145,16 @@ Requiring this file will:
 - Download all the dependencies listed in your `Berksfile` into the temporary directory
 - Set ChefSpec's `cookbook_path` to the temporary directory
 
+You can customize the list of options passed to the installation command using the `berkshelf_options` RSpec configuration:
+
+```ruby
+RSpec.configuration do |config|
+  config.berkshelf_options = { only: "my-group" }
+end
+```
+
+This is a Ruby hash and valid options include `only` and `except`.
+
 ### Librarian
 
 If you are using Librarian, simply require `chefspec/librarian` in your `spec_helper` after requiring `chefspec`:
@@ -244,7 +254,7 @@ require 'chefspec'
 describe 'example::default' do
   let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
 
-  it 'does something' do
+  it 'installs apache2' do
     expect(chef_run).to install_package('apache2')
   end
 end
@@ -260,7 +270,7 @@ require 'chefspec'
 describe 'example::default' do
   let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
 
-  it 'does something' do
+  it 'adds the member vagrant to the docker group' do
     expect(chef_run).to modify_group('docker').with(members: ['vagrant'])
   end
 end
@@ -981,9 +991,34 @@ it 'raises an error' do
 end
 ```
 
+Testing Multiple Recipes
+-------------
+Even though ChefSpec is cookbook-centric, you can still converge multiple recipes in a single `ChefSpec::SoloRunner` instance. Given a cookbook "sandwich" with recipes "bacon", "lettuce" and "tomato":
+
+```ruby
+# cookbooks/sandwich/recipes/bacon.rb
+package 'bacon'
+
+# cookbooks/sandwich/recipes/lettuce.rb
+package 'lettuce'
+
+# cookbooks/sandwich/recipes/tomato.rb
+package 'tomato'
+```
+
+```ruby
+let(:chef_run) { ChefSpec::SoloRunner.converge('sandwich::bacon', 'sandwich::lettuce', 'sandwich::tomato') }
+```
+
+```ruby
+expect(chef_run).to install_package('bacon')
+expect(chef_run).to install_package('lettuce')
+expect(chef_run).to install_package('tomato')
+```
+
 Testing Roles
 -------------
-Even though ChefSpec is cookbook-centric, you can still converge multiple recipes and roles in a single `ChefSpec::SoloRunner` instance. Given a cookbook "bacon" with a default recipe:
+Roles can also be used in a single `ChefSpec::SoloRunner` instance. Given a cookbook "bacon" with a default recipe:
 
 ```ruby
 # cookbooks/bacon/recipes/default.rb

data/examples/chocolatey_package/recipes/install.rb

@@ -0,0 +1,6 @@
+chocolatey_package '7zip'
+
+chocolatey_package 'git' do
+  version '2.7.1'
+  options '--params /GitAndUnixToolsOnPath'
+end

data/examples/chocolatey_package/recipes/remove.rb

@@ -0,0 +1,8 @@
+chocolatey_package '7zip' do
+  action :remove
+end
+
+chocolatey_package 'git' do
+  version '2.7.1'
+  action :remove
+end

data/examples/chocolatey_package/recipes/upgrade.rb

@@ -0,0 +1,8 @@
+chocolatey_package '7zip' do
+  action :upgrade
+end
+
+chocolatey_package 'git' do
+  version '2.7.1'
+  action :upgrade
+end

data/examples/chocolatey_package/spec/install_spec.rb

@@ -0,0 +1,21 @@
+require 'chefspec'
+
+RSpec.configure do |config|
+  config.platform = 'windows'
+  config.version  = '2012R2'
+end
+
+describe 'chocolatey_package::install' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'installs a package' do
+    expect(chef_run).to install_chocolatey_package('7zip')
+  end
+
+  it 'installs a specific version of a package with options' do
+    expect(chef_run).to install_chocolatey_package('git').with(
+      version: %w(2.7.1),
+      options: '--params /GitAndUnixToolsOnPath'
+    )
+  end
+end

data/examples/chocolatey_package/spec/remove_spec.rb

@@ -0,0 +1,20 @@
+require 'chefspec'
+
+RSpec.configure do |config|
+  config.platform = 'windows'
+  config.version  = '2012R2'
+end
+
+describe 'chocolatey_package::remove' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'removes a package' do
+    expect(chef_run).to remove_chocolatey_package('7zip')
+  end
+
+  it 'removes a specific version of a package with options' do
+    expect(chef_run).to remove_chocolatey_package('git').with(
+      version: %w(2.7.1)
+    )
+  end
+end

data/examples/chocolatey_package/spec/upgrade_spec.rb

@@ -0,0 +1,20 @@
+require 'chefspec'
+
+RSpec.configure do |config|
+  config.platform = 'windows'
+  config.version  = '2012R2'
+end
+
+describe 'chocolatey_package::upgrade' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'upgrades a package' do
+    expect(chef_run).to upgrade_chocolatey_package('7zip')
+  end
+
+  it 'upgrades a specific version of a package with options' do
+    expect(chef_run).to upgrade_chocolatey_package('git').with(
+      version: %w(2.7.1)
+    )
+  end
+end

data/features/chocolatey_package.feature

@@ -0,0 +1,29 @@
+@not_chef_11_14_2
+@not_chef_11_14_6
+@not_chef_11_16_0
+@not_chef_11_16_2
+@not_chef_11_16_4
+@not_chef_11_18_0
+@not_chef_11_18_6
+@not_chef_12_0_3
+@not_chef_12_1_0
+@not_chef_12_1_1
+@not_chef_12_1_2
+@not_chef_12_2_1
+@not_chef_12_3_0
+@not_chef_12_4_0
+@not_chef_12_4_3
+@not_chef_12_5_1
+@not_chef_12_6_0
+Feature: The chocolatey_package matcher
+  Background:
+    * I am using the "chocolatey_package" cookbook
+
+  Scenario Outline: Running specs
+    * I successfully run `rspec spec/<Matcher>_spec.rb`
+    * the output should contain "0 failures"
+  Examples:
+    | Matcher |
+    | install |
+    | remove  |
+    | upgrade |

data/lib/chefspec/api.rb

@@ -27,6 +27,7 @@ end
 require_relative 'api/apt_package'
 require_relative 'api/batch'
 require_relative 'api/chef_gem'
+require_relative 'api/chocolatey_package'
 require_relative 'api/cookbook_file'
 require_relative 'api/cron'
 require_relative 'api/deploy'

data/lib/chefspec/api/chocolatey_package.rb

@@ -0,0 +1,107 @@
+module ChefSpec::API
+  # @since 4.6.0
+  module ChocolateyPackageMatchers
+    ChefSpec.define_matcher :chocolatey_package
+    #
+    # Assert that a +chocolatey_package+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "7zip" as a
+    # +chocolatey_package+:
+    #
+    #     chocolatey_package '7zip' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chocolatey_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +chocolatey_package+ was installed
+    #   expect(chef_run).to install_chocolatey_package('7zip')
+    #
+    # @example Assert that a +chocolatey_package+ was installed with attributes
+    #   expect(chef_run).to install_chocolatey_package('git').with(
+    #     version: %w(2.7.1),
+    #     options: '--params /GitAndUnixToolsOnPath'
+    #  )
+    #
+    # @example Assert that a +chocolatey_package+ was _not_ installed
+    #   expect(chef_run).to_not install_chocolatey_package('flashplayeractivex')
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_chocolatey_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chocolatey_package, :install, resource_name)
+    end
+
+    #
+    # Assert that a +chocolatey_package+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "7zip" as a
+    # +chocolatey_package+:
+    #
+    #     chocolatey_package '7zip' do
+    #       action :remove
+    #     end
+    #
+    # To test the content rendered by a +chocolatey_package+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chocolatey_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +chocolatey_package+ was removed
+    #   expect(chef_run).to remove_chocolatey_package('7zip')
+    #
+    # @example Assert that a specific +chocolatey_package+ version was removed
+    #   expect(chef_run).to remove_chocolatey_package('7zip').with(
+    #     version: %w(15.14)
+    #   )
+    #
+    # @example Assert that a +chocolatey_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_chocolatey_package('7zip')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_chocolatey_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chocolatey_package, :remove, resource_name)
+    end
+
+    #
+    # Assert that a +chocolatey_package+ resource exists in the Chef run with the
+    # action +:upgrade+. Given a Chef Recipe that upgrades "7zip" as a
+    # +chocolatey_package+:
+    #
+    #     chocolatey_package '7zip' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chocolatey_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +chocolatey_package+ was upgraded
+    #   expect(chef_run).to upgrade_chocolatey_package('7zip')
+    #
+    # @example Assert that a +chocolatey_package+ was upgraded with attributes
+    #   expect(chef_run).to upgrade_chocolatey_package('git').with(
+    #     version: %w(2.7.1),
+    #     options: '-params "/GitAndUnixToolsOnPath"'
+    #  )
+    #
+    # @example Assert that a +chocolatey_package+ was _not_ upgraded
+    #   expect(chef_run).to_not upgrade_chocolatey_package('flashplayeractivex')
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_chocolatey_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chocolatey_package, :upgrade, resource_name)
+    end
+  end
+end

data/lib/chefspec/berkshelf.rb

@@ -21,7 +21,13 @@ module ChefSpec
     # Setup and install the necessary dependencies in the temporary directory.
     #
     def setup!
-      berksfile = ::Berkshelf::Berksfile.from_file('Berksfile')
+      # Get the list of Berkshelf options
+      opts = RSpec.configuration.berkshelf_options
+      if !opts.is_a?(Hash)
+        raise InvalidBerkshelfOptions(value: opts.inspect)
+      end
+
+      berksfile = ::Berkshelf::Berksfile.from_file('Berksfile', opts)
 
       # Grab a handle to tmpdir, since Berkshelf 2 modifies it a bit
       tmpdir = File.join(@tmpdir, 'cookbooks')

data/lib/chefspec/errors.rb

@@ -38,5 +38,7 @@ module ChefSpec
     class GemLoadError < ChefSpecError; end
 
     class MayNeedToSpecifyPlatform < ChefSpecError; end
+
+    class InvalidBerkshelfOptions < ChefSpecError; end
   end
 end

data/lib/chefspec/matchers/render_file_matcher.rb

@@ -1,5 +1,6 @@
 module ChefSpec::Matchers
   class RenderFileMatcher
+    attr_reader :expected_content
     def initialize(path)
       @path = path
     end
@@ -20,7 +21,7 @@ module ChefSpec::Matchers
         raise ArgumentError, "Cannot specify expected content and a block!"
       elsif expected_content
         @expected_content = expected_content
-      elsif block
+      elsif block_given?
         @expected_content = block
       else
         raise ArgumentError, "Must specify expected content or a block!"

data/lib/chefspec/matchers/resource_matcher.rb

@@ -1,3 +1,6 @@
+require 'rspec/matchers/expecteds_for_multiple_diffs'
+require 'rspec/expectations/fail_with'
+
 module ChefSpec::Matchers
   class ResourceMatcher
     def initialize(resource_name, expected_action, expected_identity)
@@ -60,10 +63,14 @@ module ChefSpec::Matchers
               %Q{expected "#{resource.to_s}" to be run at converge time}
             end
           else
-            %Q{expected "#{resource.to_s}" to have parameters:} \
+            message = %Q{expected "#{resource.to_s}" to have parameters:} \
             "\n\n" \
             "  " + unmatched_parameters.collect { |parameter, h|
-              "#{parameter} #{h[:expected].inspect}, was #{h[:actual].inspect}"
+              msg = "#{parameter} #{h[:expected].inspect}, was #{h[:actual].inspect}"
+              diff = ::RSpec::Matchers::ExpectedsForMultipleDiffs.from(h[:expected]) \
+                     .message_with_diff(message, ::RSpec::Expectations::differ, h[:actual])
+              msg += diff if diff
+              msg
             }.join("\n  ")
           end
         else

data/lib/chefspec/policyfile.rb

@@ -23,7 +23,6 @@ module ChefSpec
     #
     def setup!
       policyfile_path = File.join(Dir.pwd, 'Policyfile.rb')
-      cbdir = File.join(@tmpdir, 'cookbooks')
 
       installer = ChefDK::PolicyfileServices::Install.new(
         policyfile: policyfile_path,
@@ -40,7 +39,12 @@ module ChefSpec
       FileUtils.rm_rf(@tmpdir)
       exporter.run
 
-      ::RSpec.configure { |config| config.cookbook_path = cbdir }
+      ::RSpec.configure do |config|
+        config.cookbook_path = [
+          File.join(@tmpdir, 'cookbooks'),
+          File.join(@tmpdir, 'cookbook_artifacts')
+        ]
+      end
     end
 
     #

data/lib/chefspec/rspec.rb

@@ -9,6 +9,7 @@ RSpec.configure do |config|
     ChefSpec::Stubs::SearchRegistry.reset!
   end
 
+  config.add_setting :berkshelf_options, default: {}
   config.add_setting :cookbook_path
   config.add_setting :role_path
   config.add_setting :environment_path

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '4.5.0'
+  VERSION = '4.6.0'
 end

data/spec/unit/matchers/render_file_matcher_spec.rb

@@ -6,6 +6,17 @@ describe ChefSpec::Matchers::RenderFileMatcher do
   let(:chef_run) { double('chef run', find_resource: file) }
   subject { described_class.new(path) }
 
+  describe '#with_content' do
+    it 'accepts do/end syntax' do
+      subject.matches?(chef_run)
+      expect(
+        subject.with_content do |content|
+          'Does not raise ArgumentError'
+        end.expected_content.call
+      ).to eq('Does not raise ArgumentError')
+    end
+  end
+
   describe '#failure_message' do
     it 'has the right value' do
       subject.matches?(chef_run)

data/templates/errors/invalid_berkshelf_options.erb

@@ -0,0 +1,4 @@
+The currently configured value for `berkshelf_options` appears to be invalid.
+This attribute must be a Ruby hash with symbol keys. The current value is:
+
+  <%= @value %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Andrew Crump
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -162,6 +162,12 @@ files:
 - examples/chef_gem/spec/reconfig_spec.rb
 - examples/chef_gem/spec/remove_spec.rb
 - examples/chef_gem/spec/upgrade_spec.rb
+- examples/chocolatey_package/recipes/install.rb
+- examples/chocolatey_package/recipes/remove.rb
+- examples/chocolatey_package/recipes/upgrade.rb
+- examples/chocolatey_package/spec/install_spec.rb
+- examples/chocolatey_package/spec/remove_spec.rb
+- examples/chocolatey_package/spec/upgrade_spec.rb
 - examples/compile_time/recipes/default.rb
 - examples/compile_time/spec/default_spec.rb
 - examples/cookbook_file/recipes/create.rb
@@ -569,6 +575,7 @@ files:
 - features/batch.feature
 - features/cached.feature
 - features/chef_gem.feature
+- features/chocolatey_package.feature
 - features/compile_time.feature
 - features/cookbook_file.feature
 - features/cron.feature
@@ -645,6 +652,7 @@ files:
 - lib/chefspec/api/apt_package.rb
 - lib/chefspec/api/batch.rb
 - lib/chefspec/api/chef_gem.rb
+- lib/chefspec/api/chocolatey_package.rb
 - lib/chefspec/api/cookbook_file.rb
 - lib/chefspec/api/cron.rb
 - lib/chefspec/api/deploy.rb
@@ -777,6 +785,7 @@ files:
 - templates/coverage/human.erb
 - templates/errors/cookbook_path_not_found.erb
 - templates/errors/gem_load_error.erb
+- templates/errors/invalid_berkshelf_options.erb
 - templates/errors/may_need_to_specify_platform.erb
 - templates/errors/no_conversion_error.erb
 - templates/errors/not_stubbed.erb
@@ -810,6 +819,7 @@ test_files:
 - features/batch.feature
 - features/cached.feature
 - features/chef_gem.feature
+- features/chocolatey_package.feature
 - features/compile_time.feature
 - features/cookbook_file.feature
 - features/cron.feature