chefspec 4.7.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d6b31aada6aae7b0e9d80006a7f59b4928b4e18
-  data.tar.gz: ef5e7a024c06199069f4349264a69a113f096571
+  metadata.gz: e2cb55b871d4f280113670d8ab781c00fd904bcf
+  data.tar.gz: ad23485af0935d3e69b4c3690c461f86edb416f6
 SHA512:
-  metadata.gz: caac16818a6152ae7cf12e4cc71a1649915be6d22fa175f486035009426e6c27d140e5a67833629976360765a99c4bbfbc1465c188ae7e8b4b66bf99066641d1
-  data.tar.gz: ad3ab1cf59daf6ea6f2aec22b7b417d96472d5625b927616d768e452aa30a12e8a05748e9871ea17b4544dba91c53290a4d0485dbbcf9af400035f06c54179b2
+  metadata.gz: 624855a8994a04ebeaf46ef353aeed11b49693166a08d3b044ae80cbaff8a5656c5a25c33edca93b3f83ae7ea419c3a67c66ae661b5c2bb8d4a22833cd67f704
+  data.tar.gz: 28d33704f79f50c2cf0b96e3f498c696236f2449cae23e1917ec0a619e79d2d9bf775a0520eb857d24fca80e8b36a34ffe607e181da75c5070e3ef2915842cee

data/.travis.yml

@@ -6,8 +6,8 @@ before_install:
   - gem install bundler
 
 rvm:
-  - 2.1
-  - 2.2
+  - 2.1.9
+  - 2.2.5
 
 branches:
   only:
@@ -19,36 +19,22 @@ gemfile: gemfiles/chefspec.gemfile
 
 env:
   - CHEF_VERSION=master
+  - CHEF_VERSION=12.13.37
+  - CHEF_VERSION=12.12.15
+  - CHEF_VERSION=12.11.18
+  - CHEF_VERSION=12.10.24
+  - CHEF_VERSION=12.9.41
   - CHEF_VERSION=12.8.1
   - 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
   - CHEF_VERSION=12.3.0
   - 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
 
 matrix:
   fast_finish: true
   allow_failures:
     - env: CHEF_VERSION=master
-  include:
-    - env: CHEF_VERSION=11.18.6
-      rvm: 1.9.3
-    - env: CHEF_VERSION=11.18.0
-      rvm: 1.9.3
-    - env: CHEF_VERSION=11.16.4
-      rvm: 1.9.3
-    - env: CHEF_VERSION=11.16.2
-      rvm: 1.9.3
-    - env: CHEF_VERSION=11.16.0
-      rvm: 1.9.3
-    - env: CHEF_VERSION=11.14.6
-      rvm: 1.9.3
-    - env: CHEF_VERSION=11.14.2
-      rvm: 1.9.3
-

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG for ChefSpec
 
+## 5.0.0 (August 24, 2016)
+
+IMPROVEMENTS
+
+  - Require a minimum of Chef 12.0
+  - Add custom templating to Coverage Reporting. See readme for details
+  - Add matcher for apt_repository resource
+  - Add matcher for apt_update resource
+  - Add support for the :before notification
+  - Allow stubbing encrypted databags loaded with data_bag_item
+  - Add testing against Chef 12.8 - 12.3
+
+BUG FIXES
+
+  - Update docs/examples to use node.normal instead of node.set, which has been deprecated
+  - Update user spec examples to specify the platform
+  - Update docs to clarify the Ruby 2.1 requirement
+
 ## 4.7.0 (May 13, 2016)
 
 IMPROVEMENTS

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
+
 gemspec

data/README.md

@@ -25,7 +25,7 @@ What people are saying
 
 Important Notes
 ---------------
-- **ChefSpec 3.0+ requires Ruby 1.9 or higher!**
+- **ChefSpec requires Ruby 2.1 or later and Chef 12.0.2 or later!**
 - **This documentation corresponds to the master branch, which may be unreleased. Please check the README of the latest git tag or the gem's source for your version's documentation!**
 - **Each resource matcher is self-documented using [Yard](http://rubydoc.info/github/sethvargo/chefspec) and has a corresponding aruba test from the [examples directory](https://github.com/sethvargo/chefspec/tree/master/examples).**
 - **ChefSpec aims to maintain compatibility 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.
@@ -35,8 +35,6 @@ Notes on Compatibility 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.
 
 
@@ -102,7 +100,7 @@ RSpec.configure do |config|
   config.platform = 'ubuntu'
 
   # Specify the operating version to mock Ohai data from (default: nil)
-  config.version = '12.04'
+  config.version = '14.04'
 end
 ```
 
@@ -110,10 +108,10 @@ Values specified at the initialization of a "Runner" merge and take precedence o
 
 ```ruby
 # Override only the operating system version (platform is still "ubuntu" from above)
-ChefSpec::SoloRunner.new(version: '10.04')
+ChefSpec::SoloRunner.new(version: '16.04')
 
 # Use a different operating system platform and version
-ChefSpec::SoloRunner.new(platform: 'centos', version: '5.10')
+ChefSpec::SoloRunner.new(platform: 'centos', version: '7.2.1511')
 
 # Specify a different cookbook_path
 ChefSpec::SoloRunner.new(cookbook_path: '/var/my/other/path', role_path: '/var/my/roles')
@@ -128,7 +126,7 @@ ChefSpec::SoloRunner.new(file_cache_path: '/var/chef/cache')
 ChefSpec::SoloRunner.new(log_level: :debug).converge(described_recipe)
 ```
 
-**NOTE** You do not _need_ to specify a platform and version to use ChefSpec. However, some cookbooks may rely on [Ohai](http://github.com/opscode/ohai) data that ChefSpec cannot not automatically generate. Specifying the `platform` and `version` keys instructs ChefSpec to load stubbed Ohai attributes from another platform using [fauxhai](https://github.com/customink/fauxhai).
+**NOTE** You do not _need_ to specify a platform and version to use ChefSpec. However, some cookbooks may rely on [Ohai](http://github.com/chef/ohai) data that ChefSpec cannot not automatically generate. Specifying the `platform` and `version` keys instructs ChefSpec to load stubbed Ohai attributes from another platform using [fauxhai](https://github.com/customink/fauxhai).
 
 ### Berkshelf
 If you are using Berkshelf, simply require `chefspec/berkshelf` in your `spec_helper` after requiring `chefspec`:
@@ -342,7 +340,7 @@ You can use any RSpec content matcher inside of the `with_content` predicate:
 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`:
+It is possible to assert which [Chef phase of execution](https://docs.chef.io/chef_client.html#the-chef-client-title-run) a resource is created. Given a resource that is installed at compile time using `run_action`:
 
 ```ruby
 package('apache2').run_action(:install)
@@ -381,7 +379,7 @@ Node attribute can be set when creating the `Runner`. The initializer yields a b
 describe 'example::default' do
   let(:chef_run) do
     ChefSpec::SoloRunner.new do |node|
-      node.set['cookbook']['attribute'] = 'hello'
+      node.normal['cookbook']['attribute'] = 'hello'
     end.converge(described_recipe)
   end
 end
@@ -400,7 +398,7 @@ describe 'example::default' do
 end
 ```
 
-The `node` that is returned is actually a [`Chef::Node`](http://docs.opscode.com/essentials_node_object.html) object.
+The `node` that is returned is actually a [`Chef::Node`](https://docs.chef.io/nodes.html) object.
 
 To set an attribute within a specific test, set the attribute in the `it` block and then **(re-)converge the node**:
 
@@ -409,7 +407,7 @@ describe 'example::default' do
   let(:chef_run) { ChefSpec::SoloRunner.new } # Notice we don't converge here
 
   it 'performs the action' do
-    chef_run.node.set['cookbook']['attribute'] = 'hello'
+    chef_run.node.normal['cookbook']['attribute'] = 'hello'
     chef_run.converge(described_recipe) # The converge happens inside the test
 
     expect(chef_run).to do_something
@@ -478,7 +476,7 @@ Note: the current "node" is always uploaded to the server. However, due to the w
 
 ```ruby
 ChefSpec::ServerRunner.new do |node, server|
-  node.set['attribute'] = 'value'
+  node.normal['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
@@ -492,7 +490,7 @@ You may also use the `stub_node` macro, which will create a new `Chef::Node` obj
 
 ```ruby
 www = stub_node(platform: 'ubuntu', version: '12.04') do |node|
-        node.set['attribute'] = 'value'
+        node.normal['attribute'] = 'value'
       end
 
 # `www` is now a local Chef::Node object you can use in your test. To publish
@@ -719,11 +717,11 @@ Untouched Resources:
   package[git]               bacon/recipes/default.rb:2
   package[build-essential]   bacon/recipes/default.rb:3
   package[apache2]           bacon/recipes/default.rb:4
-  package[libvrt]            bacon/recipes/default.rb:5
+  package[libvirt]           bacon/recipes/default.rb:5
   package[core]              bacon/recipes/default.rb:6
 ```
 
-By default, ChefSpec will test all cookbooks that are loaded as part of the Chef Client run. If you have a cookbook with many dependencies, this may be less than desireable. To restrict coverage reporting against certain cookbooks, `ChefSpec::Coverage` yields a block:
+By default, ChefSpec will test all cookbooks that are loaded as part of the Chef Client run. If you have a cookbook with many dependencies, this may be less than desirable. To restrict coverage reporting against certain cookbooks, `ChefSpec::Coverage` yields a block:
 
 ```ruby
 ChefSpec::Coverage.start! do
@@ -781,6 +779,20 @@ ChefSpec::Coverage.start! do
 end
 ```
 
+If you would like a different output format for the Coverage.report! output, you can specify one of the three built-in templates, or supply your own by calling the set_template in the `ChefSpec::Coverage` block:
+
+```ruby
+ChefSpec::Coverage.start! do
+  set_template 'json.erb'
+end
+```
+Provided templates are human.erb*(default)*, table.erb and json.erb, to supply a custom template, specify a relative(to run directory) or absolute path.
+
+```ruby
+ChefSpec::Coverage.start! do
+  set_template '/opt/custom/templates/verbose.erb'
+end
+```
 
 Mocking Out Environments
 ------------------------
@@ -858,9 +870,10 @@ end
 
 1. The entire contents of this file must be wrapped with the conditional clause checking if `ChefSpec` is defined.
 2. Each matcher is actually a top-level method. The above example corresponds to the following RSpec test:
-    ```ruby
-    expect(chef_run).to my_custom_matcher('...')
-    ```
+
+  ```ruby
+  expect(chef_run).to my_custom_matcher('...')
+  ```
 
 3. `ChefSpec::Matchers::ResourceMatcher` accepts three parameters:
     1. The name of the resource to find in the resource collection (i.e. the name of the LWRP).
@@ -1148,11 +1161,15 @@ Development
 1. Fork the repository from GitHub.
 2. Clone your fork to your local machine:
 
-        $ git clone git@github.com:USER/chefspec.git
+  ```
+  $ git clone git@github.com:USER/chefspec.git
+  ```
 
 3. Create a git branch
 
-        $ git checkout -b my_bug_fix
+  ```
+  $ git checkout -b my_bug_fix
+  ```
 
 4. **Write tests**
 5. Make your changes/patches/fixes, committing appropriately

data/chefspec.gemspec

@@ -23,11 +23,11 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  # ChefSpec requires Ruby 1.9+
-  s.required_ruby_version = '>= 1.9'
+  # ChefSpec requires Ruby 2.1+ since ChefDK uses 2.1.X
+  s.required_ruby_version = '>= 2.1'
 
-  s.add_dependency 'chef',    '>= 11.14'
-  s.add_dependency 'fauxhai', '~> 3.2'
+  s.add_dependency 'chef',    '>= 12.0'
+  s.add_dependency 'fauxhai', '~> 3.6'
   s.add_dependency 'rspec',   '~> 3.0'
 
   # Development Dependencies

data/examples/apt_repository/recipes/add.rb

@@ -0,0 +1,8 @@
+apt_repository 'default_action' do
+  uri 'some_uri'
+end
+
+apt_repository 'explicit_action' do
+  uri 'some_url'
+  action :add
+end

data/examples/apt_repository/recipes/remove.rb

@@ -0,0 +1,4 @@
+apt_repository 'explicit_remove_action' do
+  uri 'some_uri'
+  action :remove
+end

data/examples/apt_repository/spec/add_spec.rb

@@ -0,0 +1,14 @@
+require 'chefspec'
+
+describe 'apt_repository::add' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'adds a apt_repository with default action' do
+    expect(chef_run).to add_apt_repository('default_action')
+    expect(chef_run).to_not add_apt_repository('not_default_action')
+  end
+
+  it 'installs a apt_repository with an explicit action' do
+    expect(chef_run).to add_apt_repository('explicit_action')
+  end
+end

data/examples/apt_repository/spec/remove_spec.rb

@@ -0,0 +1,9 @@
+require 'chefspec'
+
+describe 'apt_repository::remove' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'removes a apt_repository with default action' do
+    expect(chef_run).to remove_apt_repository('explicit_remove_action')
+  end
+end

data/examples/apt_update/recipes/periodic.rb

@@ -0,0 +1,5 @@
+apt_repository 'default_action'
+
+apt_update 'explicit_action' do
+  action :periodic
+end

data/examples/apt_update/recipes/update.rb

@@ -0,0 +1,3 @@
+apt_update 'update_repo' do
+  action :update
+end

data/examples/apt_update/spec/periodic_spec.rb

@@ -0,0 +1,14 @@
+require 'chefspec'
+
+describe 'apt_update::periodic' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'updates apt with default action' do
+    expect(chef_run).to periodic_apt_update('default_action')
+    expect(chef_run).to_not periodic_apt_update('not_default_action')
+  end
+
+  it 'installs a apt_repository with an explicit action' do
+    expect(chef_run).to periodic_apt_update('explicit_action')
+  end
+end

data/examples/apt_update/spec/update_spec.rb

@@ -0,0 +1,9 @@
+require 'chefspec'
+
+describe 'apt_update::update' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'updates apt repo' do
+    expect(chef_run).to update_apt_update('update_repo')
+  end
+end

data/examples/attributes/spec/default_spec.rb

@@ -4,7 +4,7 @@ describe 'attributes::default' do
   let(:chef_run) do
     ChefSpec::SoloRunner.new do |node|
       node.automatic['ipaddress'] = '500.500.500.500' # Intentionally not a real IP
-      node.set['attributes']['message'] = 'The new message is here'
+      node.normal['attributes']['message'] = 'The new message is here'
     end.converge(described_recipe)
   end
 

data/examples/notifications/recipes/before.rb

@@ -0,0 +1,7 @@
+template '/tmp/notifying_resource' do
+  notifies :restart, 'service[receiving_resource]', :before
+end
+
+service 'receiving_resource' do
+  action :nothing
+end

data/examples/notifications/spec/before_spec.rb

@@ -0,0 +1,16 @@
+require 'chefspec'
+
+describe 'notifications::before' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:template) { chef_run.template('/tmp/notifying_resource') }
+
+  it 'sends a notification to the service' do
+    expect(template).to notify('service[receiving_resource]').before
+    expect(template).to_not notify('service[not_receiving_resource]').before
+  end
+
+  it 'sends the specific notification to the service before' do
+    expect(template).to notify('service[receiving_resource]').to(:restart).before
+    expect(template).to_not notify('service[receiving_resource]').to(:restart).immediately
+  end
+end

data/examples/server/spec/node_spec.rb

@@ -18,7 +18,7 @@ describe 'server::node' do
 
   context 'with custom Ohai data' do
     let(:chef_run) do
-      ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '12.04')
+      ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '14.04')
         .converge(described_recipe)
     end
 
@@ -27,7 +27,7 @@ describe 'server::node' do
 
       node = chef_run.get_node('chefspec')
       expect(node['kernel']['name']).to eq('Linux')
-      expect(node['kernel']['release']).to eq('3.2.0-92-generic')
+      expect(node['kernel']['release']).to eq('3.13.0-66-generic')
       expect(node['kernel']['machine']).to eq('x86_64')
     end
   end
@@ -35,7 +35,7 @@ describe 'server::node' do
   context 'with overridden node data' do
     let(:chef_run) do
       ChefSpec::ServerRunner.new do |node, server|
-        node.set['breakfast']['bacon'] = true
+        node.normal['breakfast']['bacon'] = true
       end.converge(described_recipe)
     end
 

data/examples/server/spec/search_spec.rb

@@ -5,7 +5,7 @@ describe 'server::search' do
     stub_node('node_1') do |node|
       node.automatic['hostname'] = 'node_1'
       node.automatic['fqdn'] = 'node_1.example.com'
-      node.set['bar'] = true
+      node.normal['bar'] = true
     end
   end
 
@@ -13,7 +13,7 @@ describe 'server::search' do
     stub_node('node_2') do |node|
       node.automatic['hostname'] = 'node_2'
       node.automatic['fqdn'] = 'node_2.example.com'
-      node.set['bar'] = true
+      node.normal['bar'] = true
     end
   end
 
@@ -21,7 +21,7 @@ describe 'server::search' do
     stub_node('node_3') do |node|
       node.automatic['hostname'] = 'node_3'
       node.automatic['fqdn'] = 'node_3.example.com'
-      node.set['bar'] = true
+      node.normal['bar'] = true
     end
   end
 
@@ -34,7 +34,7 @@ describe 'server::search' do
 
   let(:chef_run) do
     ChefSpec::ServerRunner.new do |node, server|
-      node.set['bar'] = true
+      node.normal['bar'] = true
       server.update_node(node)
 
       server.create_node(node_1)