chefspec 4.7.0 → 5.0.0

data/examples/stub_node/spec/default_spec.rb

@@ -2,8 +2,8 @@ require 'chefspec'
 
 describe 'stub_node::default' do
   let(:my_node) do
-    stub_node('example.com', platform: 'ubuntu', version: '12.04') do |node|
-      node.set['foo']['bar'] = 'zip'
+    stub_node('example.com', platform: 'ubuntu', version: '14.04') do |node|
+      node.normal['foo']['bar'] = 'zip'
     end
   end
 

data/examples/subscribes/recipes/before.rb

@@ -0,0 +1,5 @@
+template '/tmp/notifying_resource'
+
+service 'receiving_resource' do
+  subscribes :create, 'template[/tmp/notifying_resource]', :before
+end

data/examples/subscribes/spec/before_spec.rb

@@ -0,0 +1,16 @@
+require 'chefspec'
+
+describe 'subscribes::before' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:service) { chef_run.service('receiving_resource') }
+
+  it 'subscribes to the template creation' do
+    expect(service).to subscribe_to('template[/tmp/notifying_resource]').before
+    expect(service).to_not subscribe_to('template[/tmp/not_notifying_resource]').before
+  end
+
+  it 'subscribes to the specific action on the resource before' do
+    expect(service).to subscribe_to('template[/tmp/notifying_resource]').on(:create).before
+    expect(service).to_not subscribe_to('template[/tmp/notifying_resource]').on(:delete).immediately
+  end
+end

data/examples/user/spec/create_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'user::create' do
-  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '14.04').converge(described_recipe) }
 
   it 'creates a user with the default action' do
     expect(chef_run).to create_user('default_action')

data/examples/user/spec/lock_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'user::lock' do
-  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '14.04').converge(described_recipe) }
 
   it 'locks a user with an explicit action' do
     expect(chef_run).to lock_user('explicit_action')

data/examples/user/spec/manage_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'user::manage' do
-  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '14.04').converge(described_recipe) }
 
   it 'manages a user with an explicit action' do
     expect(chef_run).to manage_user('explicit_action')

data/examples/user/spec/modify_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'user::modify' do
-  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '14.04').converge(described_recipe) }
 
   it 'modifys a user with an explicit action' do
     expect(chef_run).to modify_user('explicit_action')

data/examples/user/spec/remove_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'user::remove' do
-  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '14.04').converge(described_recipe) }
 
   it 'removes a user with an explicit action' do
     expect(chef_run).to remove_user('explicit_action')

data/examples/user/spec/unlock_spec.rb

@@ -1,7 +1,7 @@
 require 'chefspec'
 
 describe 'user::unlock' do
-  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '14.04').converge(described_recipe) }
 
   it 'unlocks a user with an explicit action' do
     expect(chef_run).to unlock_user('explicit_action')

data/features/chocolatey_package.feature

@@ -1,17 +1,7 @@
-@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

data/features/dsc_resource.feature

@@ -1,13 +1,4 @@
-@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
 Feature: The dsc_resource matcher
   Background:

data/features/notifications.feature

@@ -1,3 +1,10 @@
+@not_chef_12_0_3
+@not_chef_12_1_2
+@not_chef_12_2_1
+@not_chef_12_3_0
+@not_chef_12_4_3
+@not_chef_12_5_1
+
 Feature: The notifications matcher
   Background:
     * I am using the "notifications" cookbook
@@ -7,6 +14,7 @@ Feature: The notifications matcher
     * the output should contain "0 failures"
   Examples:
     | Matcher     |
+    | before      |
     | chained     |
     | default     |
     | delayed     |

data/features/reboot.feature

@@ -1,10 +1,3 @@
-@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
 Feature: The reboot matcher
   Background:
     * I am using the "reboot" cookbook

data/features/step_into.feature

@@ -1,10 +1,3 @@
-@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
 Feature: The step_into matcher
   Background:
     * I am using the "step_into" cookbook

data/features/subscribes.feature

@@ -1,3 +1,10 @@
+@not_chef_12_0_3
+@not_chef_12_1_2
+@not_chef_12_2_1
+@not_chef_12_3_0
+@not_chef_12_4_3
+@not_chef_12_5_1
+
 Feature: The subscribes matcher
   Background:
     * I am using the "subscribes" cookbook
@@ -7,6 +14,7 @@ Feature: The subscribes matcher
     * the output should contain "0 failures"
   Examples:
     | Matcher     |
+    | before      |
     | chained     |
     | default     |
     | delayed     |

data/features/windows_package.feature

@@ -1,13 +1,4 @@
-@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

data/features/windows_service.feature

@@ -1,10 +1,3 @@
-@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
 Feature: The windows_service matcher
   Background:
     * I am using the "windows_service" cookbook

data/gemfiles/chefspec.gemfile

@@ -1,5 +1,11 @@
 source 'https://rubygems.org'
 
+# travis runs on older chef releases failed while including
+# rack 2.X on Ruby 2.1. When we remove Ruby 2.1 support this can go
+if ENV['CHEF_VERSION'].to_f < 12.6
+  gem 'rack', '~> 1.0'
+end
+
 if ENV['CHEF_VERSION'] == 'master'
   gem 'chef', github: 'chef/chef'
 else

data/lib/chefspec/api/apt_repository.rb

@@ -0,0 +1,56 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module AptRepositoryMatchers
+    ChefSpec.define_matcher :apt_repository
+
+    #
+    # Assert that an +apt_repository+ resource exists in the Chef run with the
+    # action +:add+. Given a Chef Recipe that adds "rsyslog" as an
+    # +apt_repository+:
+    #
+    #     apt_repository 'rsyslog' do
+    #       uri 'ppa:adiscon/v8-stable'
+    #       action :add
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_repository+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_repository+ was added
+    #   expect(chef_run).to add_apt_repository('rsyslog')
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+
+    def add_apt_repository(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_repository, :add,
+                                              resource_name)
+    end
+
+    #
+    # Assert that an +apt_repository+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "rsyslog" as an
+    # +apt_repository+:
+    #
+    #     apt_repository 'rsyslog' do
+    #       uri 'ppa:adiscon/v8-stable'
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_repository+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_repository+ was removed
+    #   expect(chef_run).to remove_apt_repository('rsyslog')
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+
+    def remove_apt_repository(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_repository, :remove,
+                                              resource_name)
+    end
+  end
+end

data/lib/chefspec/api/apt_update.rb

@@ -0,0 +1,53 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module AptUpdateMatchers
+    ChefSpec.define_matcher :apt_update
+
+    #
+    # Assert that an +apt_update+ resource exists in the Chef run with the
+    # action +:update+. Given a Chef Recipe that adds "rsyslog" as a repository
+    # to update.
+    #     apt_repository 'rsyslog' do
+    #       action :update
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_update+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_update+ was run
+    #   expect(chef_run).to update_apt_update('rsyslog')
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+
+    def update_apt_update(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_update, :update,
+                                              resource_name)
+    end
+
+    #
+    # Assert that an +apt_update+ resource exists in the Chef run
+    # with the action +:periodic+. Given a Chef Recipe that updates "rsyslog"
+    # as an +apt_update+: periodically
+    #
+    #     apt_update 'rsyslog' do
+    #       action :periodic
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_update+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_update+ was updated periodically
+    #   expect(chef_run).to periodic_apt_update('rsyslog')
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+
+    def periodic_apt_update(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_update, :periodic,
+                                              resource_name)
+    end
+  end
+end

data/lib/chefspec/cacher.rb

@@ -35,8 +35,9 @@ module ChefSpec
 
     def cached(name, &block)
       location = ancestors.first.metadata[:location]
-      unless ancestors.first.metadata[:description].nil? || location.nil?
-        location += ancestors.first.metadata[:description]
+      unless location.nil?
+        location += ancestors.first.metadata[:description] unless ancestors.first.metadata[:description].nil?
+        location += ancestors.first.metadata[:scoped_id] unless ancestors.first.metadata[:scoped_id].nil?
       end
       location ||= ancestors.first.metadata[:parent_example_group][:location]
 

data/lib/chefspec/coverage.rb

@@ -28,6 +28,7 @@ module ChefSpec
     def initialize
       @collection = {}
       @filters    = {}
+      @template = ChefSpec.root.join('templates', 'coverage', 'human.erb')
     end
 
     #
@@ -67,7 +68,26 @@ module ChefSpec
 
       true
     end
-
+    #
+    # Change the template for reporting of converage analysis.
+    #
+    # @param [string] path
+    #   The template file to use for the output of the report
+    #
+    # @return [true]
+    #
+    def set_template(file = 'human.erb')
+      [
+        ChefSpec.root.join('templates', 'coverage', file),
+        File.expand_path(file, Dir.pwd)
+      ].each do |temp|
+        if File.exist?(temp)
+          @template = temp
+          return
+        end
+      end
+      raise Error::TemplateNotFound.new(path: file)
+    end
     #
     # Add a resource to the resource collection. Only new resources are added
     # and only resources that match the given filter are covered (which is *
@@ -130,10 +150,14 @@ module ChefSpec
       report[:untouched_resources] = @collection.collect do |_, resource|
         resource unless resource.touched?
       end.compact
-
-      template = ChefSpec.root.join('templates', 'coverage', 'human.erb')
-      erb = Erubis::Eruby.new(File.read(template))
-      puts erb.evaluate(report)
+      report[:all_resources] = @collection.values
+      
+      begin
+        erb = Erubis::Eruby.new(File.read(@template))
+        puts erb.evaluate(report)
+      rescue NameError => e
+        raise Error::ErbTemplateParseError.new(original_error: e.message)
+      end
 
       # Ensure we exit correctly (#351)
       Kernel.exit(exit_status) if exit_status && exit_status > 0
@@ -160,6 +184,15 @@ module ChefSpec
         @resource.to_s
       end
 
+      def to_json
+        {
+          "source_file" => source_file,
+          "source_line" => source_line,
+          "touched" => touched?,
+          "resource" => to_s
+        }.to_json
+      end
+
       def source_file
         @source_file ||= if @resource.source_line
           shortname(@resource.source_line.split(':').first)

data/lib/chefspec/errors.rb

@@ -40,5 +40,8 @@ module ChefSpec
     class MayNeedToSpecifyPlatform < ChefSpecError; end
 
     class InvalidBerkshelfOptions < ChefSpecError; end
+
+    class TemplateNotFound < ChefSpecError; end
+    class ErbTemplateParseError < ChefSpecError; end
   end
 end

data/lib/chefspec/extensions/chef/data_query.rb

@@ -33,8 +33,8 @@ module Chef::DSL::DataQuery
 
   # @see Chef::DSL::DataQuery#data_bag_item
   alias_method :old_data_bag_item, :data_bag_item
-  def data_bag_item(bag, id)
-    return old_data_bag_item(bag, id) unless Chef::Config[:solo]
+  def data_bag_item(bag, id, secret = nil)
+    return old_data_bag_item(bag, id, secret) unless Chef::Config[:solo]
 
     stub = ChefSpec::Stubs::DataBagItemRegistry.stub_for(bag, id)