chefspec 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5200ce7871519ab0cc3ec4991be81a879de497e
-  data.tar.gz: 06e54036feed75509905d6d0fa216fca5ad21e70
+  metadata.gz: a3617560994bd67eae8bece75bdfcd66c6fcc259
+  data.tar.gz: 953c6f0e6e1471483ad9d7fd1f9ecb8b7d77f5be
 SHA512:
-  metadata.gz: c01f41111509834f0edfd555ccb1f6cd5b46286834884309ac1045b792404fe7110ad15669e9307f7b85f620eee3cdaf1e5a87c884ab4c41c06d5198b19223bc
-  data.tar.gz: 90a5eba4f6aaa993733d2880f9fa591fc8504dad190ab855821be27d1d98712644bc2057e16d683e352f49144a1f6f2664d93db4da820349e0d6182801068e86
+  metadata.gz: 2f6016eb17cf6fcbb0497d1b9f097f5f4ddc54002572653ff87c666a60bb7819d38e4c452ff14bb3c49cb3c3705fbe79f373f00662e98a5524019b507bc509ee
+  data.tar.gz: ab41f6c8868ba16d5f6f350a847e5314d1c983bccb98aab78a9de6bd99ea0a835b95be565263b69c81777063ad98af3d4605a8f2e6fc4fce8363d15ec17d5151

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # CHANGELOG for ChefSpec
 
-## 7.0.0 (April, 18, 2017)
+## 7.1.0 (May 9, 2017)
+
+- Resource matchers are now generated automatically. What does this mean for you? A lot:
+  1. You won't have to worry about older releases of ChefSpec not knowing about new resources in chef-client.
+  2. You won't have to define the matchers in your cookbook code, which also means you won't have issues if a community cookbook lacks matchers
+
+- Removed the usage of Cucumber for testing
+- Removed all test deps from the Gemspec
+- Added a warning about stubbing core Ruby methods and the issues that can cause
+
+## 7.0.0 (April 18, 2017)
 
 - Increased the chef gem dependency from 12.6+ to 12.14+. Since ChefSpec is consumed within ChefDK this actually has a minor impact on end users who generally consume Chefspec via ChefDK, which will bundle both compatible chef and chefspec releases.
 - Fixed incompatibilities with Chef 13.

data/Gemfile

@@ -10,3 +10,9 @@ if ENV['CHEF_VERSION']
 end
 
 gemspec
+
+group :development do
+  gem 'rake'
+  gem 'redcarpet'
+  gem 'yard'
+end

data/README.md

@@ -9,26 +9,18 @@ ChefSpec runs your cookbook(s) locally with Chef Solo without actually convergin
 - It's really fast!
 - Your tests can vary node attributes, operating systems, and search results to assert behavior under varying conditions.
 
-## What people are saying
-
-> I just wanted to drop you a line to say "HELL YES!" to ChefSpec. - [Joe Goggins](https://twitter.com/jgoggins)
-
-> OK ChefSpec is my new best friend. Delightful few hours working with it. - [Michael Ivey](https://twitter.com/ivey)
-
-**Chat with us - [#chefspec](irc://irc.freenode.net/chefspec) on Freenode**
-
 ## Important Notes
 
 - **ChefSpec requires Ruby 2.2 or later and Chef 12.14.89 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.
+- **Each resource matcher is self-documented using [Yard](http://rubydoc.info/github/sethvargo/chefspec) and has a corresponding test recipe in the [examples directory](https://github.com/sethvargo/chefspec/tree/master/examples).**
 
 ## Notes on Compatibility with Chef Versions
 
+**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.
+
 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:
 
-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
 
@@ -710,6 +702,34 @@ describe 'example::default' do
 end
 ```
 
+### Ruby libraries (File, FileUtils, etc)
+
+When stubbing core ruby libraries, users must be aware that there is no differentiation between your cookbook code that calls `File.exist?` and core chef
+code (e.g. the cookbook loader) that calls `File.exist?`.  If you stub or setup an expectation without qualifying the arguments then you will stub that
+method for all core chef code as well.  Also note that if you setup an expectation on a particular argument that invoking the method with any other
+argument will throw an unexpected argument error out of rspec, so you must setup an allowance using `.and_call_original` to avoid breaking core chef.
+
+```ruby
+describe 'example::default' do
+  let(:chef_run) { ChefSpec::SoloRunner.new }
+
+  before do
+    # avoid breaking all of core chef wherever it calls File.exist? with other arguments
+    allow(File).to receive(:exist?).and_call_original
+  end
+
+  it "tests something when /etc/myfile.txt does not exist" do
+    # only setup an expectation on our file
+    expect(File).to receive(:exist?).with("/etc/myfile.txt").and_return(false)
+    [ ... test that the chef resource collection is constructed correctly in this case ... ]
+  end
+end
+```
+
+This is basic usage of rspec and not specific to chefspec.  It applies to any class method in `File`, `Dir`, `FileUtils`, `IO` or any other ruby library.  In
+general any time you `expect(Some::Symbol).to receive(:a_method).and_return(value)` you run the risk of breaking other code unless you isolate your mocking
+or expectation down to only the arguments which your code uses.
+
 ## Reporting
 
 ChefSpec can generate a report of resources read over resources tested.
@@ -893,6 +913,18 @@ end
 
 **NOTE:** If your cookbook exposes LWRPs, it is highly recommended you also create a `libraries/matchers.rb` file as outlined below in the "Packaging Custom Matchers" section. **You should never `step_into` an LWRP unless you are testing it. Never `step_into` an LWRP from another cookbook!**
 
+## Automatic Matchers
+
+As of ChefSpec 7.1.0 there are "custom" matchers generated for all internal core-chef resources, along with any LWRPs/HWRPs/Custom Resources that are user-defined in cookbooks.
+
+The matchers follow the standard custom of `<action>_<resource_name>` with the exception of the `create_if_missing` action which *also* gets a `create_<resource_name>_if_missing`
+matcher.
+
+Matchers should be wired up for the `resource_name` of the resource along with all define `provides` lines synonyms and any `action` methods or `allowed_actions`.
+
+There should be little reason to package custom matchers in cookbooks any more, but the approach below still works if there are special matchers which cookbooks wish to expose which do
+not follow the automatically generated pattern.
+
 ## Packaging Custom Matchers
 
 ChefSpec exposes the ability for cookbook authors to package custom matchers inside a cookbook so that other developers may take advantage of them in testing. This is done by creating a special library file in the cookbook named `matchers.rb`:

data/Rakefile

@@ -1,7 +1,10 @@
 require 'bundler/gem_tasks'
-require 'cucumber/rake/task'
+require 'rspec/core'
 require 'rspec/core/rake_task'
 require 'yard/rake/yardoc_task'
+require 'tmpdir'
+require 'rspec'
+require 'chefspec'
 
 require 'chef/version'
 
@@ -14,13 +17,50 @@ RSpec::Core::RakeTask.new(:unit) do |t|
   end.join(' ')
 end
 
-Cucumber::Rake::Task.new(:acceptance) do |t|
-  t.cucumber_opts = [].tap do |a|
-    a.push('--color')
-    a.push('--format progress')
-    a.push('--strict')
-    a.push('--tags ~@not_chef_' + Chef::VERSION.gsub('.', '_'))
-  end.join(' ')
+failed = false
+
+namespace :acceptance do |ns|
+  Dir.foreach("examples") do |dir|
+    next if dir == '.' or dir == '..'
+    desc "#{dir} acceptance tests"
+    task dir.to_sym do
+      Dir.mktmpdir do |tmp|
+        FileUtils.cp_r("examples/#{dir}", tmp)
+
+        pwd = Dir.pwd
+
+        Dir.chdir "#{tmp}/#{dir}" do
+          puts "rspec examples/#{dir}"
+
+          #
+          # This bit of mildly awful magic below is to load each file into an in-memory
+          # RSpec runner while keeping a persistent ChefZero server alive.
+          #
+          load "#{pwd}/lib/chefspec/rspec.rb"
+
+          RSpec.configure do |config|
+            config.color = true
+            config.before(:suite) do
+              ChefSpec::ZeroServer.setup!
+            end
+            config.after(:each) do
+              ChefSpec::ZeroServer.reset!
+            end
+          end
+
+          RSpec.clear_examples
+          exitstatus = RSpec::Core::Runner.run(["spec"])
+          RSpec.reset
+          failed = true unless exitstatus == 0
+        end
+      end
+    end
+  end
+end
+
+
+task acceptance: Rake.application.tasks.select { |t| t.name.start_with?("acceptance:") } do
+  raise "some tests failed" if failed
 end
 
 desc 'Run all tests'

data/chefspec.gemspec

@@ -28,12 +28,4 @@ Gem::Specification.new do |s|
   s.add_dependency 'chef',    '>= 12.14.89'
   s.add_dependency 'fauxhai', '>= 4', '< 6'
   s.add_dependency 'rspec',   '~> 3.0'
-
-  # Development Dependencies
-  s.add_development_dependency 'rake',      '< 13.0'
-  s.add_development_dependency 'redcarpet', '~> 3.3'
-  s.add_development_dependency 'yard',      '~> 0.8'
-
-  # Testing Dependencies
-  s.add_development_dependency 'aruba', '~> 0.8'
 end

data/examples/cab_package/spec/install_spec.rb

@@ -1,26 +1,28 @@
 require 'chefspec'
 
-describe 'cab_package::install' do
-  let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'windows', version: '2012R2')
-                          .converge(described_recipe)
-  end
+if defined?(Chef::Resource::CabPackage)
+  describe 'cab_package::install' do
+    let(:chef_run) do
+      ChefSpec::ServerRunner.new(platform: 'windows', version: '2012R2')
+        .converge(described_recipe)
+    end
 
-  it 'installs a cab_package with the default action' do
-    expect(chef_run).to install_cab_package('default_action')
-    expect(chef_run).to_not install_cab_package('not_default_action')
-  end
+    it 'installs a cab_package with the default action' do
+      expect(chef_run).to install_cab_package('default_action')
+      expect(chef_run).to_not install_cab_package('not_default_action')
+    end
 
-  it 'installs a cab_package with an explicit action' do
-    expect(chef_run).to install_cab_package('explicit_action')
-  end
+    it 'installs a cab_package with an explicit action' do
+      expect(chef_run).to install_cab_package('explicit_action')
+    end
 
-  it 'installs a cab_package with attributes' do
-    expect(chef_run).to install_cab_package('with_attributes').with(version: '1.2.3')
-    expect(chef_run).to_not install_cab_package('with_attributes').with(version: '1.2.4')
-  end
+    it 'installs a cab_package with attributes' do
+      expect(chef_run).to install_cab_package('with_attributes').with(version: '1.2.3')
+      expect(chef_run).to_not install_cab_package('with_attributes').with(version: '1.2.4')
+    end
 
-  it 'installs a cab_package when specifying the identity attribute' do
-    expect(chef_run).to install_cab_package('identity_attribute')
+    it 'installs a cab_package when specifying the identity attribute' do
+      expect(chef_run).to install_cab_package('identity_attribute')
+    end
   end
 end

data/examples/cab_package/spec/remove_spec.rb

@@ -1,22 +1,24 @@
 require 'chefspec'
 
-describe 'cab_package::remove' do
-  let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'windows', version: '2012R2')
-                          .converge(described_recipe)
-  end
+if defined?(Chef::Resource::CabPackage)
+  describe 'cab_package::remove' do
+    let(:chef_run) do
+      ChefSpec::ServerRunner.new(platform: 'windows', version: '2012R2')
+        .converge(described_recipe)
+    end
 
-  it 'removes a cab_package with an explicit action' do
-    expect(chef_run).to remove_cab_package('explicit_action')
-    expect(chef_run).to_not remove_cab_package('not_explicit_action')
-  end
+    it 'removes a cab_package with an explicit action' do
+      expect(chef_run).to remove_cab_package('explicit_action')
+      expect(chef_run).to_not remove_cab_package('not_explicit_action')
+    end
 
-  it 'removes a cab_package with attributes' do
-    expect(chef_run).to remove_cab_package('with_attributes').with(version: '1.2.3')
-    expect(chef_run).to_not remove_cab_package('with_attributes').with(version: '1.2.4')
-  end
+    it 'removes a cab_package with attributes' do
+      expect(chef_run).to remove_cab_package('with_attributes').with(version: '1.2.3')
+      expect(chef_run).to_not remove_cab_package('with_attributes').with(version: '1.2.4')
+    end
 
-  it 'removes a cab_package when specifying the identity attribute' do
-    expect(chef_run).to remove_cab_package('identity_attribute')
+    it 'removes a cab_package when specifying the identity attribute' do
+      expect(chef_run).to remove_cab_package('identity_attribute')
+    end
   end
 end

data/examples/cached/spec/default_spec.rb

@@ -1,3 +1,4 @@
+require 'chefspec'
 require 'chefspec/cacher'
 
 RSpec.configure do |config|

data/examples/compile_time/spec/default_spec.rb

@@ -1,3 +1,5 @@
+require 'chefspec'
+
 describe 'compile_time::default' do
   let(:chef_run) { ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '16.04').converge(described_recipe) }
 

data/examples/custom_matcher/libraries/matcher.rb

@@ -1,23 +1 @@
-if defined?(ChefSpec)
-  ChefSpec.define_matcher :custom_matcher_thing
-
-  #
-  # When defining a custom LWRP matcher, you should always add some
-  # documentation indicating how to use the custom matcher.
-  #
-  # @example This is an example
-  #   expect(chef_run).to install_custom_matcher_thing('foo')
-  #
-  # @param [String] resource_name
-  #   the resource name
-  #
-  # @return [ChefSpec::Matchers::ResourceMatcher]
-  #
-  def install_custom_matcher_thing(resource_name)
-    ChefSpec::Matchers::ResourceMatcher.new(:custom_matcher_thing, :install, resource_name)
-  end
-
-  def remove_custom_matcher_thing(resource_name)
-    ChefSpec::Matchers::ResourceMatcher.new(:custom_matcher_thing, :remove, resource_name)
-  end
-end
+# this file is no longer required

data/examples/dnf_package/spec/install_spec.rb

@@ -1,26 +1,28 @@
 require 'chefspec'
 
-describe 'dnf_package::install' do
-  let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'fedora', version: '25')
-                          .converge(described_recipe)
-  end
+if defined?(Chef::Resource::DnfPackage)
+  describe 'dnf_package::install' do
+    let(:chef_run) do
+      ChefSpec::ServerRunner.new(platform: 'fedora', version: '25')
+        .converge(described_recipe)
+    end
 
-  it 'installs a dnf_package with the default action' do
-    expect(chef_run).to install_dnf_package('default_action')
-    expect(chef_run).to_not install_dnf_package('not_default_action')
-  end
+    it 'installs a dnf_package with the default action' do
+      expect(chef_run).to install_dnf_package('default_action')
+      expect(chef_run).to_not install_dnf_package('not_default_action')
+    end
 
-  it 'installs a dnf_package with an explicit action' do
-    expect(chef_run).to install_dnf_package('explicit_action')
-  end
+    it 'installs a dnf_package with an explicit action' do
+      expect(chef_run).to install_dnf_package('explicit_action')
+    end
 
-  it 'installs a dnf_package with attributes' do
-    expect(chef_run).to install_dnf_package('with_attributes').with(version: '1.0.0')
-    expect(chef_run).to_not install_dnf_package('with_attributes').with(version: '1.2.3')
-  end
+    it 'installs a dnf_package with attributes' do
+      expect(chef_run).to install_dnf_package('with_attributes').with(version: '1.0.0')
+      expect(chef_run).to_not install_dnf_package('with_attributes').with(version: '1.2.3')
+    end
 
-  it 'installs a dnf_package when specifying the identity attribute' do
-    expect(chef_run).to install_dnf_package('identity_attribute')
+    it 'installs a dnf_package when specifying the identity attribute' do
+      expect(chef_run).to install_dnf_package('identity_attribute')
+    end
   end
 end

data/examples/dnf_package/spec/purge_spec.rb

@@ -1,22 +1,24 @@
 require 'chefspec'
 
-describe 'dnf_package::purge' do
-  let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'fedora', version: '25')
-                          .converge(described_recipe)
-  end
+if defined?(Chef::Resource::DnfPackage)
+  describe 'dnf_package::purge' do
+    let(:chef_run) do
+      ChefSpec::ServerRunner.new(platform: 'fedora', version: '25')
+        .converge(described_recipe)
+    end
 
-  it 'purges a dnf_package with an explicit action' do
-    expect(chef_run).to purge_dnf_package('explicit_action')
-    expect(chef_run).to_not purge_dnf_package('not_explicit_action')
-  end
+    it 'purges a dnf_package with an explicit action' do
+      expect(chef_run).to purge_dnf_package('explicit_action')
+      expect(chef_run).to_not purge_dnf_package('not_explicit_action')
+    end
 
-  it 'purges a dnf_package with attributes' do
-    expect(chef_run).to purge_dnf_package('with_attributes').with(version: '1.0.0')
-    expect(chef_run).to_not purge_dnf_package('with_attributes').with(version: '1.2.3')
-  end
+    it 'purges a dnf_package with attributes' do
+      expect(chef_run).to purge_dnf_package('with_attributes').with(version: '1.0.0')
+      expect(chef_run).to_not purge_dnf_package('with_attributes').with(version: '1.2.3')
+    end
 
-  it 'purges a dnf_package when specifying the identity attribute' do
-    expect(chef_run).to purge_dnf_package('identity_attribute')
+    it 'purges a dnf_package when specifying the identity attribute' do
+      expect(chef_run).to purge_dnf_package('identity_attribute')
+    end
   end
 end

data/examples/dnf_package/spec/remove_spec.rb

@@ -1,22 +1,24 @@
 require 'chefspec'
 
-describe 'dnf_package::remove' do
-  let(:chef_run) do
-    ChefSpec::ServerRunner.new(platform: 'fedora', version: '25')
-                          .converge(described_recipe)
-  end
+if defined?(Chef::Resource::DnfPackage)
+  describe 'dnf_package::remove' do
+    let(:chef_run) do
+      ChefSpec::ServerRunner.new(platform: 'fedora', version: '25')
+        .converge(described_recipe)
+    end
 
-  it 'removes a dnf_package with an explicit action' do
-    expect(chef_run).to remove_dnf_package('explicit_action')
-    expect(chef_run).to_not remove_dnf_package('not_explicit_action')
-  end
+    it 'removes a dnf_package with an explicit action' do
+      expect(chef_run).to remove_dnf_package('explicit_action')
+      expect(chef_run).to_not remove_dnf_package('not_explicit_action')
+    end
 
-  it 'removes a dnf_package with attributes' do
-    expect(chef_run).to remove_dnf_package('with_attributes').with(version: '1.0.0')
-    expect(chef_run).to_not remove_dnf_package('with_attributes').with(version: '1.2.3')
-  end
+    it 'removes a dnf_package with attributes' do
+      expect(chef_run).to remove_dnf_package('with_attributes').with(version: '1.0.0')
+      expect(chef_run).to_not remove_dnf_package('with_attributes').with(version: '1.2.3')
+    end
 
-  it 'removes a dnf_package when specifying the identity attribute' do
-    expect(chef_run).to remove_dnf_package('identity_attribute')
+    it 'removes a dnf_package when specifying the identity attribute' do
+      expect(chef_run).to remove_dnf_package('identity_attribute')
+    end
   end
 end