chefspec 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75d0edf1b239bc0e3f2925b5369b05446c94e5af
-  data.tar.gz: 05c29cdc3052844db10148b184b9b8476c88c016
+  metadata.gz: aa3e59bb811bc68639e3c2c4214f10cbf7e89731
+  data.tar.gz: c1129471fe9e8ed5cc656048ac19dfdd566f4a81
 SHA512:
-  metadata.gz: fddcc55b0216f17d1d39eb0c8d5515a2efd09eb8f9db6e7ffc4affcc2c4c2f4c140d8e3a4abca91404b96040e8a3d5596dac00e5314fe617f7fd3c7df58fbe9d
-  data.tar.gz: 49e6647e765e13381955b457ac19df13f000f974344030648356afc589ee1c646676a40033bf667df0f1f274b4a62cb9e9eda38b48eadaf437628e962435be7e
+  metadata.gz: 55e9765354fac8ee356d820c3e37a84932458bcf2ad6df72e38790cb6eb316f30534bb13bccf1250ca4da5ac132f940460377480a451c78563a8fa50571e40ba
+  data.tar.gz: ad94b0e9a758bfbca910593de93bdb30dfea1599461bcfc24014b6efc95a0d5372807aff0c7b3caffe3e5582c811fdaf411c9745b24798f1892b1c12b52431ff

data/.travis.yml

@@ -1,31 +1,36 @@
+language: ruby
+cache: bundler
 sudo: false
 
 rvm:
   - 2.0.0
   - 2.1
+  - 2.2
 
 branches:
   only:
     - master
 
-notifications:
-  irc:
-    channels:
-      - "chat.freenode.net#chefspec"
-    use_notice: true
-    skip_join: true
-    template:
-      - "%{message} (%{author}): %{build_url}"
-
 bundler_args: --jobs 7 --retry 3
 
-gemfile:
-  - gemfiles/chef-11.14.0.gemfile
-  - gemfiles/chef-11.16.0.gemfile
-  - gemfiles/chef-12.0.0.gemfile
-  - gemfiles/chef-master.gemfile
+gemfile: gemfiles/chefspec.gemfile
+
+env:
+  - CHEF_VERSION=master
+  - CHEF_VERSION=12.2.1
+  - CHEF_VERSION=12.1.2
+  - CHEF_VERSION=12.1.1
+  - CHEF_VERSION=12.1.0
+  - CHEF_VERSION=12.0.3
+  - CHEF_VERSION=11.18.6
+  - CHEF_VERSION=11.18.0
+  - CHEF_VERSION=11.16.4
+  - CHEF_VERSION=11.16.2
+  - CHEF_VERSION=11.16.0
+  - CHEF_VERSION=11.14.6
+  - CHEF_VERSION=11.14.2
 
 matrix:
   fast_finish: true
   allow_failures:
-    - gemfile: gemfiles/chef-master.gemfile
+    - env: CHEF_VERSION=master

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 CHANGELOG for ChefSpec
 ======================
 
+## 4.3.0 (July 16, 2015)
+
+Bugfixes:
+  - Improved documentation
+  - Use TemplateContext's `_extend_modules` for passing on template helper
+    modules to nested partial templates
+  - Only exit if the status is a failure [GH-565]
+  - Fix load order on Windows when using the `rights` attributes
+  - Improve testing matrix and remove deprecated Chef versions
+  - Supress chef_gem compile_time warnings
+  - Fix exceptions on converge for Chef 12.1.0 masking
+  - Update Librarian `Cheffile` site URL to supermerket.chef.io
+  - Filter Windows and Unix paths for test coverage report with Berkshelf
+
+Improvements:
+  - Added possibility to specify file_cache_path globally
+  - Added new capabilities for reboot resouce
+  - Use `Chef::Resource#declared_type` first if available (Chef >= 12),
+    otherwise fall back to `Chef::Resource#resource_name` (Chef <= 11)
+  - Extend render_file to yield the content as a block
+  - Add windows_service resource
+
 ## 4.2.0 (December 25, 2014)
 Bugfixes:
   - Updated README grep examples

data/README.md

@@ -2,13 +2,9 @@ ChefSpec
 ========
 [![Gem Version](http://img.shields.io/gem/v/chefspec.svg)][gem]
 [![Build Status](http://img.shields.io/travis/sethvargo/chefspec.svg)][travis]
-[![Dependency Status](http://img.shields.io/gemnasium/sethvargo/chefspec.svg)][gemnasium]
-[![Code Climate](http://img.shields.io/codeclimate/github/sethvargo/chefspec.svg)][codeclimate]
 
 [gem]: https://rubygems.org/gems/chefspec
 [travis]: http://travis-ci.org/sethvargo/chefspec
-[gemnasium]: https://gemnasium.com/sethvargo/chefspec
-[codeclimate]: https://codeclimate.com/github/sethvargo/chefspec
 
 ChefSpec is a unit testing framework for testing Chef cookbooks. ChefSpec makes it easy to write examples and get fast feedback on cookbook changes without the need for virtual machines or cloud servers.
 
@@ -35,6 +31,15 @@ Important Notes
 - **ChefSpec aims to maintain compatability with the two most recent minor versions of Chef.** If you are running an older version of Chef it may work, or you will need to run an older version of ChefSpec.
 
 
+Notes on Compatability with Chef Versions
+-----------------------------------------
+As a general rule, if it is tested in the Travis CI matrix, it is a supported version. The section below details any specific versions that are _not_ supported and why:
+
+- Chef 12 prior to Chef 12.0.2 is not supported due to the lack of a declared resource type. This was fixed in [Chef 12.0.2](https://github.com/chef/chef/blob/12.0.2/lib/chef/resource.rb#L422-428).
+
+Additionally, if you look at a cucumber feature and see a tag like `@not_chef_x_y_z`, that means that particular functionality is not supported on those versions of Chef.
+
+
 Writing a Cookbook Example
 --------------------------
 If you want `knife` to automatically generate spec stubs for you, install [knife-spec](https://github.com/sethvargo/knife-spec).
@@ -84,6 +89,9 @@ RSpec.configure do |config|
   # Specify the path for Chef Solo to find environments (default: [ascending search])
   config.environment_path = '/var/environments'
 
+  # Specify the path for Chef Solo file cache path (default: nil)
+  config.file_cache_path = '/var/chef/cache'
+
   # Specify the Chef log_level (default: :warn)
   config.log_level = :debug
 
@@ -158,7 +166,7 @@ have to write your `Cheffile` like this:
 
 ```ruby
 # Cheffile
-site 'http://community.opscode.com/api/v1'
+site 'https://supermarket.chef.io/api/v1'
 
 cookbook 'name_of_your_cookbook', path: '.'
 ```
@@ -248,6 +256,24 @@ Assert that the Chef run included a recipe from another cookbook
 expect(chef_run).to include_recipe('other_cookbook::recipe')
 ```
 
+Keep the resources from an included recipe from being loaded into the Chef run, but test that the recipe was included
+
+```ruby
+describe 'example::default' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  before do
+    allow_any_instance_of(Chef::Recipe).to receive(:include_recipe).and_call_original
+    allow_any_instance_of(Chef::Recipe).to receive(:include_recipe).with('other_cookbook::default')
+  end
+
+  it 'includes the other_cookbook' do
+    expect_any_instance_of(Chef::Recipe).to receive(:include_recipe).with('other_cookbook::default')
+    chef_run
+  end
+end
+```
+
 ##### notify
 Assert that a resource notifies another in the Chef run
 
@@ -271,6 +297,10 @@ Assert that the Chef run renders a file (with optional content); this will match
 expect(chef_run).to render_file('/etc/foo')
 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.+/)
+expect(chef_run).to render_file('/etc/foo').with_content { |content|
+  # Regular RSpec matches work in here
+  expect(content).to include('any RSpec matcher')
+}
 ```
 
 You can use any RSpec content matcher inside of the `with_content` predicate:
@@ -411,7 +441,19 @@ ChefSpec::ServerRunner.new do |node, server|
 end
 ```
 
-Note: the current "node" is always uploaded to the server.
+Note: the current "node" is always uploaded to the server. However, due to the way the Chef Client compiles cookbooks, you must update the current node on the server if any attributes are changed:
+
+```ruby
+ChefSpec::ServerRunner.new do |node, server|
+  node.set['attribute'] = 'value'
+
+  # At this point, the server already has a copy of the current node object due
+  # to the way Chef compiled the resources. However, that node does not have
+  # this new value. As such, you must "save" the node back to the server to
+  # persist this attribute update.
+  server.update_node(node)
+end
+```
 
 You may also use the `stub_node` macro, which will create a new `Chef::Node` object and accepts the same parameters as the Chef Runner and a Fauxhai object:
 
@@ -786,12 +828,12 @@ Other developers can write RSpec tests against your LWRP in their cookbooks:
 expect(chef_run).to write_motd_message('my message')
 ```
 
-**Don't forget to include documentation in your cookbook's README noting the custom matcher and it's API!**
+**Don't forget to include documentation in your cookbook's README noting the custom matcher and its API!**
 
 
 Writing Custom Matchers
 -----------------------
-If you are testing a cookbook that does not package it's LWRP matchers, you can create your own following the same pattern as the "Packaging Custom Matchers" section. Simply, create a file at `spec/support/matchers.rb` and add your resource matchers:
+If you are testing a cookbook that does not package its LWRP matchers, you can create your own following the same pattern as the "Packaging Custom Matchers" section. Simply, create a file at `spec/support/matchers.rb` and add your resource matchers:
 
 ```ruby
 # spec/support/matchers.rb

data/chefspec.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
                     'ChefSpec makes it easy to write examples and get fast ' \
                     'feedback on cookbook changes without the need for ' \
                     'virtual machines or cloud servers.'
-  s.homepage      = 'http://code.sethvargo.com/chefspec'
+  s.homepage      = 'https://sethvargo.github.io/chefspec/'
   s.license       = 'MIT'
 
   # Packaging

data/examples/chef_gem/recipes/install.rb

@@ -1,13 +1,18 @@
-chef_gem 'default_action'
+chef_gem 'default_action' do
+  compile_time false if respond_to?(:compile_time)
+end
 
 chef_gem 'explicit_action' do
-  action :install
+  action       :install
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'with_attributes' do
-  version '1.0.0'
+  version      '1.0.0'
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'specifying the identity attribute' do
   package_name 'identity_attribute'
+  compile_time false if respond_to?(:compile_time)
 end

data/examples/chef_gem/recipes/purge.rb

@@ -1,13 +1,16 @@
 chef_gem 'explicit_action' do
-  action :purge
+  action       :purge
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'with_attributes' do
-  version '1.0.0'
-  action  :purge
+  version      '1.0.0'
+  action       :purge
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'specifying the identity attribute' do
   package_name 'identity_attribute'
   action       :purge
+  compile_time false if respond_to?(:compile_time)
 end

data/examples/chef_gem/recipes/reconfig.rb

@@ -1,13 +1,16 @@
 chef_gem 'explicit_action' do
-  action :reconfig
+  action       :reconfig
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'with_attributes' do
-  version '1.0.0'
-  action  :reconfig
+  version      '1.0.0'
+  action       :reconfig
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'specifying the identity attribute' do
   package_name 'identity_attribute'
   action       :reconfig
+  compile_time false if respond_to?(:compile_time)
 end

data/examples/chef_gem/recipes/remove.rb

@@ -1,13 +1,16 @@
 chef_gem 'explicit_action' do
-  action :remove
+  action       :remove
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'with_attributes' do
-  version '1.0.0'
-  action  :remove
+  version      '1.0.0'
+  action       :remove
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'specifying the identity attribute' do
   package_name 'identity_attribute'
   action       :remove
+  compile_time false if respond_to?(:compile_time)
 end

data/examples/chef_gem/recipes/upgrade.rb

@@ -1,13 +1,16 @@
 chef_gem 'explicit_action' do
-  action :upgrade
+  action       :upgrade
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'with_attributes' do
-  version '1.0.0'
-  action  :upgrade
+  version      '1.0.0'
+  action       :upgrade
+  compile_time false if respond_to?(:compile_time)
 end
 
 chef_gem 'specifying the identity attribute' do
   package_name 'identity_attribute'
   action       :upgrade
+  compile_time false if respond_to?(:compile_time)
 end

data/examples/directory/recipes/create.rb

@@ -12,3 +12,7 @@ end
 directory 'specifying the identity attribute' do
   path '/tmp/identity_attribute'
 end
+
+directory 'c:\temp\with_windows_rights' do
+  rights :read_execute, 'Users', applies_to_children: true
+end

data/examples/directory/spec/create_spec.rb

@@ -24,6 +24,10 @@ describe 'directory::create' do
     )
   end
 
+  it 'creates a directory with windows rights' do
+    expect(chef_run).to create_directory('c:\temp\with_windows_rights').with(rights: [{:permissions=>:read_execute, :principals=>"Users", :applies_to_children=>true}])
+  end
+
   it 'creates a directory when specifying the identity attribute' do
     expect(chef_run).to create_directory('/tmp/identity_attribute')
   end

data/examples/reboot/recipes/cancel.rb

@@ -0,0 +1,3 @@
+reboot 'explicit cancel' do
+  action :cancel
+end

data/examples/reboot/recipes/now.rb

@@ -0,0 +1,3 @@
+reboot 'explicit_action' do
+  action :reboot_now
+end

data/examples/reboot/recipes/request.rb

@@ -0,0 +1,3 @@
+reboot 'explicit_action' do
+  action :request_reboot
+end

data/examples/reboot/spec/cancel_spec.rb

@@ -0,0 +1,10 @@
+require 'chefspec'
+
+describe 'reboot::cancel' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'runs a cancel_reboot' do
+    expect(chef_run).to cancel_reboot('explicit cancel')
+  end
+end
+

data/examples/reboot/spec/now_spec.rb

@@ -0,0 +1,10 @@
+require 'chefspec'
+
+describe 'reboot::now' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'runs a reboot_now when specifying action' do
+    expect(chef_run).to now_reboot('explicit_action')
+  end
+end
+

data/examples/reboot/spec/request_spec.rb

@@ -0,0 +1,10 @@
+require 'chefspec'
+
+describe 'reboot::request' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'runs a request_reboot' do
+    expect(chef_run).to request_reboot('explicit_action')
+  end
+end
+

data/examples/render_file/spec/default_spec.rb

@@ -19,6 +19,16 @@ describe 'render_file::default' do
       expect(chef_run).to_not render_file('/tmp/file').with_content(/^Not(.+)$/)
     end
 
+    it 'renders the file when given a block' do
+      expect(chef_run).to render_file('/tmp/file').with_content { |content|
+        expect(content).to include('This is content!')
+      }
+
+      expect(chef_run).to render_file('/tmp/file').with_content { |content|
+        expect(content).to_not include('This is not content!')
+      }
+    end
+
     it 'renders the file with content matching arbitrary matcher' do
       expect(chef_run).to render_file('/tmp/file').with_content(
         start_with('This')
@@ -46,6 +56,16 @@ describe 'render_file::default' do
         expect(chef_run).to_not render_file('/tmp/cookbook_file').with_content(/^Not(.+)$/)
       end
 
+      it 'renders the file when given a block' do
+        expect(chef_run).to render_file('/tmp/cookbook_file').with_content { |content|
+          expect(content).to include('This is content!')
+        }
+
+        expect(chef_run).to render_file('/tmp/cookbook_file').with_content { |content|
+          expect(content).to_not include('This is not content!')
+        }
+      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')
@@ -86,6 +106,16 @@ describe 'render_file::default' do
       expect(chef_run).to_not render_file('/tmp/template').with_content(/^Not(.+)$/)
     end
 
+    it 'renders the file when given a block' do
+      expect(chef_run).to render_file('/tmp/template').with_content { |content|
+        expect(content).to include('This is content!')
+      }
+
+      expect(chef_run).to render_file('/tmp/template').with_content { |content|
+        expect(content).to_not include('This is not content!')
+      }
+    end
+
     it 'renders the file with content matching arbitrary matcher' do
       expect(chef_run).to render_file('/tmp/template').with_content(
         start_with('This')
@@ -107,6 +137,16 @@ describe 'render_file::default' do
       expect(chef_run).to_not render_file('/tmp/partial').with_content('This template has a partial: This is not a template partial!')
     end
 
+    it 'renders the file when given a block' do
+      expect(chef_run).to render_file('/tmp/partial').with_content { |content|
+        expect(content).to include('has a partial')
+      }
+
+      expect(chef_run).to render_file('/tmp/partial').with_content { |content|
+        expect(content).to_not include('not a template partial')
+      }
+    end
+
     it 'renders the file with matching content' do
       expect(chef_run).to render_file('/tmp/partial').with_content(/^This(.+)$/)
       expect(chef_run).to_not render_file('/tmp/partial').with_content(/^Not(.+)$/)