chefspec 4.2.0 → 4.3.0

data/examples/server/spec/search_spec.rb

@@ -34,6 +34,9 @@ describe 'server::search' do
 
   let(:chef_run) do
     ChefSpec::ServerRunner.new do |node, server|
+      node.set['bar'] = true
+      server.update_node(node)
+
       server.create_node(node_1)
       server.create_node(node_2)
       server.create_node(node_3)
@@ -44,6 +47,7 @@ describe 'server::search' do
   it 'finds all nodes with the bar attribute' do
     expect(chef_run).to write_log('nodes with an attribute')
       .with_message(<<-EOH.gsub(/^ {8}/, '').strip)
+        chefspec, FQDN: chefspec.local, hostname: chefspec
         node_1, FQDN: node_1.example.com, hostname: node_1
         node_2, FQDN: node_2.example.com, hostname: node_2
         node_3, FQDN: node_3.example.com, hostname: node_3

data/examples/windows_service/recipes/configure_startup.rb

@@ -0,0 +1,13 @@
+windows_service 'explicit_action' do
+  action :configure_startup
+end
+
+windows_service 'with_attributes' do
+  pattern 'pattern'
+  action :configure_startup
+end
+
+windows_service 'specifying the identity attribute' do
+  service_name 'identity_attribute'
+  action :configure_startup
+end

data/examples/windows_service/recipes/disable.rb

@@ -0,0 +1,13 @@
+windows_service 'explicit_action' do
+  action :disable
+end
+
+windows_service 'with_attributes' do
+  pattern 'pattern'
+  action :disable
+end
+
+windows_service 'specifying the identity attribute' do
+  service_name 'identity_attribute'
+  action :disable
+end

data/examples/windows_service/recipes/enable.rb

@@ -0,0 +1,13 @@
+windows_service 'explicit_action' do
+  action :enable
+end
+
+windows_service 'with_attributes' do
+  pattern 'pattern'
+  action :enable
+end
+
+windows_service 'specifying the identity attribute' do
+  service_name 'identity_attribute'
+  action :enable
+end

data/examples/windows_service/recipes/reload.rb

@@ -0,0 +1,13 @@
+windows_service 'explicit_action' do
+  action :reload
+end
+
+windows_service 'with_attributes' do
+  pattern 'pattern'
+  action :reload
+end
+
+windows_service 'specifying the identity attribute' do
+  service_name 'identity_attribute'
+  action :reload
+end

data/examples/windows_service/recipes/restart.rb

@@ -0,0 +1,13 @@
+windows_service 'explicit_action' do
+  action :restart
+end
+
+windows_service 'with_attributes' do
+  pattern 'pattern'
+  action :restart
+end
+
+windows_service 'specifying the identity attribute' do
+  service_name 'identity_attribute'
+  action :restart
+end

data/examples/windows_service/recipes/start.rb

@@ -0,0 +1,13 @@
+windows_service 'explicit_action' do
+  action :start
+end
+
+windows_service 'with_attributes' do
+  pattern 'pattern'
+  action :start
+end
+
+windows_service 'specifying the identity attribute' do
+  service_name 'identity_attribute'
+  action :start
+end

data/examples/windows_service/recipes/stop.rb

@@ -0,0 +1,13 @@
+windows_service 'explicit_action' do
+  action :stop
+end
+
+windows_service 'with_attributes' do
+  pattern 'pattern'
+  action :stop
+end
+
+windows_service 'specifying the identity attribute' do
+  service_name 'identity_attribute'
+  action :stop
+end

data/examples/windows_service/spec/configure_startup_spec.rb

@@ -0,0 +1,19 @@
+require 'chefspec'
+
+describe 'windows_service::configure_startup' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'configures startup for a windows_service with an explicit action' do
+    expect(chef_run).to configure_startup_windows_service('explicit_action')
+    expect(chef_run).to_not configure_startup_windows_service('not_explicit_action')
+  end
+
+  it 'configures startup for a windows_service with attributes' do
+    expect(chef_run).to configure_startup_windows_service('with_attributes').with(pattern: 'pattern')
+    expect(chef_run).to_not configure_startup_windows_service('with_attributes').with(pattern: 'bacon')
+  end
+
+  it 'configures startup for a windows_service when specifying the identity attribute' do
+    expect(chef_run).to configure_startup_windows_service('identity_attribute')
+  end
+end

data/examples/windows_service/spec/disable_spec.rb

@@ -0,0 +1,19 @@
+require 'chefspec'
+
+describe 'windows_service::disable' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'disables a windows_service with an explicit action' do
+    expect(chef_run).to disable_windows_service('explicit_action')
+    expect(chef_run).to_not disable_windows_service('not_explicit_action')
+  end
+
+  it 'disables a windows_service with attributes' do
+    expect(chef_run).to disable_windows_service('with_attributes').with(pattern: 'pattern')
+    expect(chef_run).to_not disable_windows_service('with_attributes').with(pattern: 'bacon')
+  end
+
+  it 'disables a windows_service when specifying the identity attribute' do
+    expect(chef_run).to disable_windows_service('identity_attribute')
+  end
+end

data/examples/windows_service/spec/enable_spec.rb

@@ -0,0 +1,19 @@
+require 'chefspec'
+
+describe 'windows_service::enable' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'enables a windows_service with an explicit action' do
+    expect(chef_run).to enable_windows_service('explicit_action')
+    expect(chef_run).to_not enable_windows_service('not_explicit_action')
+  end
+
+  it 'enables a windows_service with attributes' do
+    expect(chef_run).to enable_windows_service('with_attributes').with(pattern: 'pattern')
+    expect(chef_run).to_not enable_windows_service('with_attributes').with(pattern: 'bacon')
+  end
+
+  it 'enables a windows_service when specifying the identity attribute' do
+    expect(chef_run).to enable_windows_service('identity_attribute')
+  end
+end

data/examples/windows_service/spec/reload_spec.rb

@@ -0,0 +1,19 @@
+require 'chefspec'
+
+describe 'windows_service::reload' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'reloads a windows_service with an explicit action' do
+    expect(chef_run).to reload_windows_service('explicit_action')
+    expect(chef_run).to_not reload_windows_service('not_explicit_action')
+  end
+
+  it 'reloads a windows_service with attributes' do
+    expect(chef_run).to reload_windows_service('with_attributes').with(pattern: 'pattern')
+    expect(chef_run).to_not reload_windows_service('with_attributes').with(pattern: 'bacon')
+  end
+
+  it 'reloads a windows_service when specifying the identity attribute' do
+    expect(chef_run).to reload_windows_service('identity_attribute')
+  end
+end

data/examples/windows_service/spec/restart_spec.rb

@@ -0,0 +1,19 @@
+require 'chefspec'
+
+describe 'windows_service::restart' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'restarts a windows_service with an explicit action' do
+    expect(chef_run).to restart_windows_service('explicit_action')
+    expect(chef_run).to_not restart_windows_service('not_explicit_action')
+  end
+
+  it 'restarts a windows_service with attributes' do
+    expect(chef_run).to restart_windows_service('with_attributes').with(pattern: 'pattern')
+    expect(chef_run).to_not restart_windows_service('with_attributes').with(pattern: 'bacon')
+  end
+
+  it 'restarts a windows_service when specifying the identity attribute' do
+    expect(chef_run).to restart_windows_service('identity_attribute')
+  end
+end

data/examples/windows_service/spec/start_spec.rb

@@ -0,0 +1,19 @@
+require 'chefspec'
+
+describe 'windows_service::start' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'starts a windows_service with an explicit action' do
+    expect(chef_run).to start_windows_service('explicit_action')
+    expect(chef_run).to_not start_windows_service('not_explicit_action')
+  end
+
+  it 'starts a windows_service with attributes' do
+    expect(chef_run).to start_windows_service('with_attributes').with(pattern: 'pattern')
+    expect(chef_run).to_not start_windows_service('with_attributes').with(pattern: 'bacon')
+  end
+
+  it 'starts a windows_service when specifying the identity attribute' do
+    expect(chef_run).to start_windows_service('identity_attribute')
+  end
+end

data/examples/windows_service/spec/stop_spec.rb

@@ -0,0 +1,19 @@
+require 'chefspec'
+
+describe 'windows_service::stop' do
+  let(:chef_run) { ChefSpec::SoloRunner.converge(described_recipe) }
+
+  it 'stops a windows_service with an explicit action' do
+    expect(chef_run).to stop_windows_service('explicit_action')
+    expect(chef_run).to_not stop_windows_service('not_explicit_action')
+  end
+
+  it 'stops a windows_service with attributes' do
+    expect(chef_run).to stop_windows_service('with_attributes').with(pattern: 'pattern')
+    expect(chef_run).to_not stop_windows_service('with_attributes').with(pattern: 'bacon')
+  end
+
+  it 'stops a windows_service when specifying the identity attribute' do
+    expect(chef_run).to stop_windows_service('identity_attribute')
+  end
+end

data/features/reboot.feature

@@ -0,0 +1,19 @@
+@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
+
+  Scenario Outline: Running specs
+    * I successfully run `rspec spec/<Matcher>_spec.rb`
+    * the output should contain "0 failures"
+  Examples:
+    | Matcher |
+    | request |
+    | now     |
+    | cancel  |

data/features/windows_service.feature

@@ -0,0 +1,23 @@
+@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
+
+  Scenario Outline: Running specs
+    * I successfully run `rspec spec/<Matcher>_spec.rb`
+    * the output should contain "0 failures"
+  Examples:
+    | Matcher |
+    | configure_startup |
+    | disable |
+    | enable  |
+    | reload  |
+    | restart |
+    | start   |
+    | stop    |

data/gemfiles/chefspec.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+if ENV['CHEF_VERSION'] == 'master'
+  gem 'chef', github: 'chef/chef'
+else
+  gem 'chef', ENV['CHEF_VERSION']
+end
+
+gemspec path: '..'

data/lib/chefspec.rb

@@ -42,13 +42,13 @@ module ChefSpec
   module_function :matchers
 end
 
+require_relative 'chefspec/extensions/chef/securable'
 require_relative 'chefspec/extensions/chef/client'
 require_relative 'chefspec/extensions/chef/conditional'
 require_relative 'chefspec/extensions/chef/cookbook_uploader'
 require_relative 'chefspec/extensions/chef/data_query'
 require_relative 'chefspec/extensions/chef/lwrp_base'
 require_relative 'chefspec/extensions/chef/resource'
-require_relative 'chefspec/extensions/chef/securable'
 require_relative 'chefspec/extensions/chef/resource/freebsd_package'
 
 require_relative 'chefspec/mixins/normalize'

data/lib/chefspec/api.rb

@@ -57,6 +57,7 @@ require_relative 'api/package'
 require_relative 'api/pacman_package'
 require_relative 'api/portage_package'
 require_relative 'api/powershell_script'
+require_relative 'api/reboot'
 require_relative 'api/registry_key'
 require_relative 'api/remote_directory'
 require_relative 'api/remote_file'
@@ -73,4 +74,5 @@ require_relative 'api/subscriptions'
 require_relative 'api/subversion'
 require_relative 'api/template'
 require_relative 'api/user'
+require_relative 'api/windows_service'
 require_relative 'api/yum_package'

data/lib/chefspec/api/reboot.rb

@@ -0,0 +1,18 @@
+module ChefSpec::API
+  # @since 0.5.0
+  module RebootMatchers
+    ChefSpec.define_matcher :reboot
+
+    def now_reboot(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:reboot, :reboot_now, resource_name)
+    end
+
+    def request_reboot(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:reboot, :request_reboot, resource_name)
+    end
+
+    def cancel_reboot(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:reboot, :cancel, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/windows_service.rb

@@ -0,0 +1,286 @@
+module ChefSpec::API
+  # @since 0.5.0
+  module WindowsServiceMatchers
+    ChefSpec.define_matcher :windows_service
+
+    #
+    # Assert that a +windows_service+ resource exists in the Chef run with the
+    # action +:configure_startup+. Given a Chef Recipe that configures startup for "BITS" as a
+    # +windows_service+:
+    #
+    #     windows_service 'BITS' do
+    #       action :configure_startup
+    #     end
+    #
+    # To test the content rendered by a +windows_service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +windows_service+ resource with ChefSpec.
+    #
+    # @example Assert that a +windows_service+ had its startup configured
+    #   expect(chef_run).to disable_windows_service('BITS')
+    #
+    # @example Assert that a +windows_service+ had its startup configured with predicate matchers
+    #   expect(chef_run).to disable_windows_service('BITS').with_pattern('BI*')
+    #
+    # @example Assert that a +windows_service+ had its startup configured with attributes
+    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: 'BI*')
+    #
+    # @example Assert that a +windows_service+ had its startup configured using a regex
+    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: /(.+)/)
+    #
+    # @example Assert that a +windows_service+ did _not_ have its startup configured
+    #   expect(chef_run).to_not disable_windows_service('BITS')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def configure_startup_windows_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :configure_startup, resource_name)
+    end
+
+    #
+    # Assert that a +windows_service+ resource exists in the Chef run with the
+    # action +:disable+. Given a Chef Recipe that disables "BITS" as a
+    # +windows_service+:
+    #
+    #     windows_service 'BITS' do
+    #       action :disable
+    #     end
+    #
+    # To test the content rendered by a +windows_service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +windows_service+ resource with ChefSpec.
+    #
+    # @example Assert that a +windows_service+ was disabled
+    #   expect(chef_run).to disable_windows_service('BITS')
+    #
+    # @example Assert that a +windows_service+ was disabled with predicate matchers
+    #   expect(chef_run).to disable_windows_service('BITS').with_pattern('BI*')
+    #
+    # @example Assert that a +windows_service+ was disabled with attributes
+    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: 'BI*')
+    #
+    # @example Assert that a +windows_service+ was disabled using a regex
+    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: /(.+)/)
+    #
+    # @example Assert that a +windows_service+ was _not_ disabled
+    #   expect(chef_run).to_not disable_windows_service('BITS')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def disable_windows_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :disable, resource_name)
+    end
+
+    #
+    # Assert that a +windows_service+ resource exists in the Chef run with the
+    # action +:enable+. Given a Chef Recipe that enables "BITS" as a
+    # +windows_service+:
+    #
+    #     windows_service 'BITS' do
+    #       action :enable
+    #     end
+    #
+    # To test the content rendered by a +windows_service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +windows_service+ resource with ChefSpec.
+    #
+    # @example Assert that a +windows_service+ was enabled
+    #   expect(chef_run).to enable_windows_service('BITS')
+    #
+    # @example Assert that a +windows_service+ was enabled with predicate matchers
+    #   expect(chef_run).to enable_windows_service('BITS').with_pattern('BI*')
+    #
+    # @example Assert that a +windows_service+ was enabled with attributes
+    #   expect(chef_run).to enable_windows_service('BITS').with(pattern: 'BI*')
+    #
+    # @example Assert that a +windows_service+ was enabled using a regex
+    #   expect(chef_run).to enable_windows_service('BITS').with(pattern: /(.+)/)
+    #
+    # @example Assert that a +windows_service+ was _not_ enabled
+    #   expect(chef_run).to_not enable_windows_service('BITS')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def enable_windows_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :enable, resource_name)
+    end
+
+    #
+    # Assert that a +windows_service+ resource exists in the Chef run with the
+    # action +:reload+. Given a Chef Recipe that reloads "BITS" as a
+    # +windows_service+:
+    #
+    #     windows_service 'BITS' do
+    #       action :reload
+    #     end
+    #
+    # To test the content rendered by a +windows_service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +windows_service+ resource with ChefSpec.
+    #
+    # @example Assert that a +windows_service+ was reload
+    #   expect(chef_run).to reload_windows_service('BITS')
+    #
+    # @example Assert that a +windows_service+ was reload with predicate matchers
+    #   expect(chef_run).to reload_windows_service('BITS').with_pattern('BI*')
+    #
+    # @example Assert that a +windows_service+ was reload with attributes
+    #   expect(chef_run).to reload_windows_service('BITS').with(pattern: 'BI*')
+    #
+    # @example Assert that a +windows_service+ was reload using a regex
+    #   expect(chef_run).to reload_windows_service('BITS').with(pattern: /(.+)/)
+    #
+    # @example Assert that a +windows_service+ was _not_ reload
+    #   expect(chef_run).to_not reload_windows_service('BITS')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def reload_windows_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :reload, resource_name)
+    end
+
+    #
+    # Assert that a +windows_service+ resource exists in the Chef run with the
+    # action +:restart+. Given a Chef Recipe that restarts "BITS" as a
+    # +windows_service+:
+    #
+    #     windows_service 'BITS' do
+    #       action :restart
+    #     end
+    #
+    # To test the content rendered by a +windows_service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +windows_service+ resource with ChefSpec.
+    #
+    # @example Assert that a +windows_service+ was restarted
+    #   expect(chef_run).to restart_windows_service('BITS')
+    #
+    # @example Assert that a +windows_service+ was restarted with predicate matchers
+    #   expect(chef_run).to restart_windows_service('BITS').with_pattern('BI*')
+    #
+    # @example Assert that a +windows_service+ was restarted with attributes
+    #   expect(chef_run).to restart_windows_service('BITS').with(pattern: 'BI*')
+    #
+    # @example Assert that a +windows_service+ was restarted using a regex
+    #   expect(chef_run).to restart_windows_service('BITS').with(pattern: /(.+)/)
+    #
+    # @example Assert that a +windows_service+ was _not_ restarted
+    #   expect(chef_run).to_not restart_windows_service('BITS')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def restart_windows_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :restart, resource_name)
+    end
+
+    #
+    # Assert that a +windows_service+ resource exists in the Chef run with the
+    # action +:start+. Given a Chef Recipe that starts "BITS" as a
+    # +windows_service+:
+    #
+    #     windows_service 'BITS' do
+    #       action :start
+    #     end
+    #
+    # To test the content rendered by a +windows_service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +windows_service+ resource with ChefSpec.
+    #
+    # @example Assert that a +windows_service+ was started
+    #   expect(chef_run).to start_windows_service('BITS')
+    #
+    # @example Assert that a +windows_service+ was started with predicate matchers
+    #   expect(chef_run).to start_windows_service('BITS').with_pattern('BI*')
+    #
+    # @example Assert that a +windows_service+ was started with attributes
+    #   expect(chef_run).to start_windows_service('BITS').with(pattern: 'BI*')
+    #
+    # @example Assert that a +windows_service+ was started using a regex
+    #   expect(chef_run).to start_windows_service('BITS').with(pattern: /(.+)/)
+    #
+    # @example Assert that a +windows_service+ was _not_ started
+    #   expect(chef_run).to_not start_windows_service('BITS')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def start_windows_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :start, resource_name)
+    end
+
+    #
+    # Assert that a +windows_service+ resource exists in the Chef run with the
+    # action +:stop+. Given a Chef Recipe that stops "BITS" as a
+    # +windows_service+:
+    #
+    #     windows_service 'BITS' do
+    #       action :stop
+    #     end
+    #
+    # To test the content rendered by a +windows_service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +windows_service+ resource with ChefSpec.
+    #
+    # @example Assert that a +windows_service+ was stopped
+    #   expect(chef_run).to stop_windows_service('BITS')
+    #
+    # @example Assert that a +windows_service+ was stopped with predicate matchers
+    #   expect(chef_run).to stop_windows_service('BITS').with_pattern('BI*')
+    #
+    # @example Assert that a +windows_service+ was stopped with attributes
+    #   expect(chef_run).to stop_windows_service('BITS').with(pattern: 'BI*')
+    #
+    # @example Assert that a +windows_service+ was stopped using a regex
+    #   expect(chef_run).to stop_windows_service('BITS').with(pattern: /(.+)/)
+    #
+    # @example Assert that a +windows_service+ was _not_ stopped
+    #   expect(chef_run).to_not stop_windows_service('BITS')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def stop_windows_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :stop, resource_name)
+    end
+  end
+end