chefspec 2.0.1 → 3.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99f76ee3ebc113772db94655dd859bc9904b474d
-  data.tar.gz: ee588d2f65647778014e5b289e1fec6665a25e62
+  metadata.gz: 804fd5cc6af81945c28e0e0e65d94e935ff0bb82
+  data.tar.gz: d9d195301868641521b6159d67106e3ac7a6abd2
 SHA512:
-  metadata.gz: e5803437489929a05a1f2432d6d93ae16beb5f06d9cf67756a41d1f3a84943b6baf25c308a2427044e923a450bd70820baa48ad69724674a1012bd84928ddbae
-  data.tar.gz: 04dba2a600d9a4f7c2299d2a54d57b34bb21ac9291e4dd5c920604495d1b06fe24b9b222ec3ee1b7a54aca9647bd75a6751beb3107de83df0d9f509b39131bc0
+  metadata.gz: 5f951adb7cdac28459d0e0df5172e6a2e1124776a4335dcc62a6ff06c80264ca7b39290de15df21cea551b51528252e304249c2fcf45ad3888ec3fe67b2970f5
+  data.tar.gz: 7165b07393a29850245dd0fdff9d21f9222816acb723e9e381b5c195ff180f6e87be26e8013b9e5d99b73458fdde7861c510da479f7cd089f7cda21a327abf3a

data/lib/chefspec.rb

@@ -1,48 +1,34 @@
-require 'chef'
-require 'chef/formatters/chefspec'
-require 'chef/expect_exception'
-require 'chefspec/chef_runner'
-require 'chefspec/version'
+require 'rspec'
 
-if defined?(RSpec)
-  require 'chefspec/matchers/cron'
-  require 'chefspec/matchers/execute'
-  require 'chefspec/matchers/file'
-  require 'chefspec/matchers/link'
-  require 'chefspec/matchers/log'
-  require 'chefspec/matchers/package'
-  require 'chefspec/matchers/ruby_block'
-  require 'chefspec/matchers/service'
-  require 'chefspec/matchers/shared'
-  require 'chefspec/matchers/notifications'
-  require 'chefspec/matchers/file_content'
-  require 'chefspec/matchers/user'
-  require 'chefspec/matchers/group'
-  require 'chefspec/matchers/env'
-  require 'chefspec/matchers/include_recipe'
-  require 'chefspec/matchers/script'
-  require 'chefspec/matchers/python'
+require_relative 'chefspec/extensions/chef/client'
+require_relative 'chefspec/extensions/chef/conditional'
+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 'chefspec/helpers/describe'
-  RSpec.configure do |c|
-    c.include ChefSpec::Helpers::Describe
-  end
-end
+require_relative 'chefspec/stubs/command_registry'
+require_relative 'chefspec/stubs/command_stub'
+require_relative 'chefspec/stubs/data_bag_item_registry'
+require_relative 'chefspec/stubs/data_bag_item_stub'
+require_relative 'chefspec/stubs/data_bag_registry'
+require_relative 'chefspec/stubs/data_bag_stub'
+require_relative 'chefspec/stubs/registry'
+require_relative 'chefspec/stubs/stub'
+require_relative 'chefspec/stubs/search_registry'
+require_relative 'chefspec/stubs/search_stub'
 
-require 'chefspec/minitest'
-require 'chefspec/monkey_patches/conditional'
-require 'chefspec/monkey_patches/hash'
-require 'chefspec/monkey_patches/lwrp_base'
-require 'chefspec/monkey_patches/provider'
+require_relative 'chefspec/api'
+require_relative 'chefspec/errors'
+require_relative 'chefspec/expect_exception'
+require_relative 'chefspec/formatter'
+require_relative 'chefspec/macros'
+require_relative 'chefspec/matchers'
+require_relative 'chefspec/renderer'
+require_relative 'chefspec/rspec'
+require_relative 'chefspec/runner'
+require_relative 'chefspec/version'
 
-module ChefSpec
-  class << self
-    def chef_11?
-      Gem::Requirement.new('~> 11.0').satisfied_by?(Gem::Version.new(Chef::VERSION))
-    end
-
-    def chef_10?
-      Gem::Requirement.new('~> 10.0').satisfied_by?(Gem::Version.new(Chef::VERSION))
-    end
-  end
-end
+# Load deprecations module last, so it can monkey patch and print out nasty
+# deprecation warnings for us :)
+require_relative 'chefspec/deprecations'

data/lib/chefspec/api.rb

@@ -0,0 +1,74 @@
+require_relative 'runner'
+
+module ChefSpec
+  module API
+    extend self
+
+    def self.included(base)
+      submodules.each do |child|
+        base.send(:include, child)
+      end
+    end
+
+    private
+      #
+      # WARNING: This is metaprogramming madness. Find all modules who are
+      # nested beneath this module.
+      #
+      # @return [Array<Module>]
+      #
+      def submodules
+        self.constants
+          .map { |name| const_get(name) }
+          .select { |const| const.class == Module }
+      end
+  end
+end
+
+require_relative 'api/apt_package'
+require_relative 'api/batch'
+require_relative 'api/chef_gem'
+require_relative 'api/cookbook_file'
+require_relative 'api/cron'
+require_relative 'api/deploy'
+require_relative 'api/directory'
+require_relative 'api/dpkg_package'
+require_relative 'api/easy_install_package'
+require_relative 'api/env'
+require_relative 'api/erl_call'
+require_relative 'api/execute'
+require_relative 'api/file'
+require_relative 'api/freebsd_package'
+require_relative 'api/gem_package'
+require_relative 'api/git'
+require_relative 'api/group'
+require_relative 'api/http_request'
+require_relative 'api/ifconfig'
+require_relative 'api/include_recipe'
+require_relative 'api/ips_package'
+require_relative 'api/link'
+require_relative 'api/log'
+require_relative 'api/macports_package'
+require_relative 'api/mdadm'
+require_relative 'api/mount'
+require_relative 'api/notifications'
+require_relative 'api/ohai'
+require_relative 'api/package'
+require_relative 'api/pacman_package'
+require_relative 'api/portage_package'
+require_relative 'api/powershell_script'
+require_relative 'api/registry_key'
+require_relative 'api/remote_directory'
+require_relative 'api/remote_file'
+require_relative 'api/render_file'
+require_relative 'api/route'
+require_relative 'api/rpm_package'
+require_relative 'api/ruby_block'
+require_relative 'api/script'
+require_relative 'api/service'
+require_relative 'api/smartos_package'
+require_relative 'api/solaris_package'
+require_relative 'api/subversion'
+require_relative 'api/template'
+require_relative 'api/user'
+require_relative 'api/yum_package'

data/lib/chefspec/api/apt_package.rb

@@ -0,0 +1,192 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module AptPackageMatchers
+    ChefSpec::Runner.define_runner_method :apt_package
+
+    #
+    # Assert that an +apt_package+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "apache2" as an
+    # +apt_package+:
+    #
+    #     apt_package 'apache2' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_package+ was installed
+    #   expect(chef_run).to install_apt_package('apache2')
+    #
+    # @example Assert that an +apt_package+ was installed with predicate matchers
+    #   expect(chef_run).to install_apt_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +apt_package+ was installed with attributes
+    #   expect(chef_run).to install_apt_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +apt_package+ was installed using a regex
+    #   expect(chef_run).to install_apt_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +apt_package+ was _not_ installed
+    #   expect(chef_run).to_not install_apt_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_apt_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_package, :install, resource_name)
+    end
+
+    #
+    # Assert that an +apt_package+ resource exists in the Chef run with the
+    # action +:purge+. Given a Chef Recipe that purges "apache2" as an
+    # +apt_package+:
+    #
+    #     apt_package 'apache2' do
+    #       action :purge
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_package+ was purged
+    #   expect(chef_run).to purge_apt_package('apache2')
+    #
+    # @example Assert that an +apt_package+ was purged with predicate matchers
+    #   expect(chef_run).to purge_apt_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +apt_package+ was purged with attributes
+    #   expect(chef_run).to purge_apt_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +apt_package+ was purged using a regex
+    #   expect(chef_run).to purge_apt_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +apt_package+ was _not_ purged
+    #   expect(chef_run).to_not purge_apt_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_apt_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_package, :purge, resource_name)
+    end
+
+    #
+    # Assert that an +apt_package+ resource exists in the Chef run with the
+    # action +:reconfig+. Given a Chef Recipe that reconfigures "apache2" as an
+    # +apt_package+:
+    #
+    #     apt_package 'apache2' do
+    #       action :reconfig
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_package+ was reconfigured
+    #   expect(chef_run).to reconfig_apt_package('apache2')
+    #
+    # @example Assert that an +apt_package+ was reconfigured with predicate matchers
+    #   expect(chef_run).to reconfig_apt_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +apt_package+ was reconfigured with attributes
+    #   expect(chef_run).to reconfig_apt_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +apt_package+ was reconfigured using a regex
+    #   expect(chef_run).to reconfig_apt_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +apt_package+ was _not_ reconfigured
+    #   expect(chef_run).to_not reconfig_apt_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def reconfig_apt_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_package, :reconfig, resource_name)
+    end
+
+    #
+    # Assert that an +apt_package+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "apache2" as an
+    # +apt_package+:
+    #
+    #     apt_package 'apache2' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_package+ was removed
+    #   expect(chef_run).to remove_apt_package('apache2')
+    #
+    # @example Assert that an +apt_package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_apt_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +apt_package+ was removed with attributes
+    #   expect(chef_run).to remove_apt_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +apt_package+ was removed using a regex
+    #   expect(chef_run).to remove_apt_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +apt_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_apt_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_apt_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_package, :remove, resource_name)
+    end
+
+    #
+    # Assert that an +apt_package+ resource exists in the Chef run with the
+    # action +:upgrade+. Given a Chef Recipe that upgrades "apache2" as an
+    # +apt_package+:
+    #
+    #     apt_package 'apache2' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +apt_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +apt_package+ was upgraded
+    #   expect(chef_run).to upgrade_apt_package('apache2')
+    #
+    # @example Assert that an +apt_package+ was upgraded with predicate matchers
+    #   expect(chef_run).to upgrade_apt_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +apt_package+ was upgraded with attributes
+    #   expect(chef_run).to upgrade_apt_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +apt_package+ was upgraded using a regex
+    #   expect(chef_run).to upgrade_apt_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +apt_package+ was _not_ upgraded
+    #   expect(chef_run).to_not upgrade_apt_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_apt_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:apt_package, :upgrade, resource_name)
+    end
+
+  end
+end

data/lib/chefspec/api/batch.rb

@@ -0,0 +1,43 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module BatchMatchers
+    ChefSpec::Runner.define_runner_method :batch
+
+    #
+    # Assert that a +batch+ resource exists in the Chef run with the
+    # action +:run+. Given a Chef Recipe that runs "unzip" using
+    # +batch+:
+    #
+    #     batch 'unzip' do
+    #       action :run
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +batch+ resource with ChefSpec.
+    #
+    # @example Assert that a +batch+ was run
+    #   expect(chef_run).to run_batch('unzip')
+    #
+    # @example Assert that a +batch+ was run with predicate matchers
+    #   expect(chef_run).to run_batch('unzip').with_cwd('/home')
+    #
+    # @example Assert that a +batch+ was run with attributes
+    #   expect(chef_run).to run_batch('unzip').with(cwd: '/home')
+    #
+    # @example Assert that a +batch+ was run using a regex
+    #   expect(chef_run).to run_batch('unzip').with(cwd: /\/(.+)/)
+    #
+    # @example Assert that a +batch+ was _not_ run
+    #   expect(chef_run).to_not run_batch('unzip')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def run_batch(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:batch, :run, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/chef_gem.rb

@@ -0,0 +1,191 @@
+module ChefSpec::API
+  # @since 0.8.0
+  module ChefGemMatchers
+    ChefSpec::Runner.define_runner_method :chef_gem
+
+    #
+    # Assert that a +chef_gem+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "community-zero" as a
+    # +chef_gem+:
+    #
+    #     chef_gem 'community-zero' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chef_gem+ resource with ChefSpec.
+    #
+    # @example Assert that a +chef_gem+ was installed
+    #   expect(chef_run).to install_chef_gem('community-zero')
+    #
+    # @example Assert that a +chef_gem+ was installed with predicate matchers
+    #   expect(chef_run).to install_chef_gem('community-zero').with_version('1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was installed with attributes
+    #   expect(chef_run).to install_chef_gem('community-zero').with(version: '1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was installed using a regex
+    #   expect(chef_run).to install_chef_gem('community-zero').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +chef_gem+ was _not_ installed
+    #   expect(chef_run).to_not install_chef_gem('community-zero')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_chef_gem(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chef_gem, :install, resource_name)
+    end
+
+    #
+    # Assert that a +chef_gem+ resource exists in the Chef run with the
+    # action +:purge+. Given a Chef Recipe that purges "community-zero" as a
+    # +chef_gem+:
+    #
+    #     chef_gem 'community-zero' do
+    #       action :purge
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chef_gem+ resource with ChefSpec.
+    #
+    # @example Assert that a +chef_gem+ was purgeed
+    #   expect(chef_run).to purge_chef_gem('community-zero')
+    #
+    # @example Assert that a +chef_gem+ was purgeed with predicate matchers
+    #   expect(chef_run).to purge_chef_gem('community-zero').with_version('1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was purgeed with attributes
+    #   expect(chef_run).to purge_chef_gem('community-zero').with(version: '1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was purgeed using a regex
+    #   expect(chef_run).to purge_chef_gem('community-zero').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +chef_gem+ was _not_ purgeed
+    #   expect(chef_run).to_not purge_chef_gem('community-zero')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_chef_gem(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chef_gem, :purge, resource_name)
+    end
+
+    #
+    # Assert that a +chef_gem+ resource exists in the Chef run with the
+    # action +:reconfig+. Given a Chef Recipe that reconfigures "community-zero"
+    # as a +chef_gem+:
+    #
+    #     chef_gem 'community-zero' do
+    #       action :reconfig
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chef_gem+ resource with ChefSpec.
+    #
+    # @example Assert that a +chef_gem+ was reconfigured
+    #   expect(chef_run).to reconfig_chef_gem('community-zero')
+    #
+    # @example Assert that a +chef_gem+ was reconfigured with predicate matchers
+    #   expect(chef_run).to reconfig_chef_gem('community-zero').with_version('1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was reconfigured with attributes
+    #   expect(chef_run).to reconfig_chef_gem('community-zero').with(version: '1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was reconfigured using a regex
+    #   expect(chef_run).to reconfig_chef_gem('community-zero').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +chef_gem+ was _not_ reconfigured
+    #   expect(chef_run).to_not reconfig_chef_gem('community-zero')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def reconfig_chef_gem(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chef_gem, :reconfig, resource_name)
+    end
+
+    #
+    # Assert that a +chef_gem+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "community-zero" as a
+    # +chef_gem+:
+    #
+    #     chef_gem 'community-zero' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chef_gem+ resource with ChefSpec.
+    #
+    # @example Assert that a +chef_gem+ was removeed
+    #   expect(chef_run).to remove_chef_gem('community-zero')
+    #
+    # @example Assert that a +chef_gem+ was removeed with predicate matchers
+    #   expect(chef_run).to remove_chef_gem('community-zero').with_version('1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was removeed with attributes
+    #   expect(chef_run).to remove_chef_gem('community-zero').with(version: '1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was removeed using a regex
+    #   expect(chef_run).to remove_chef_gem('community-zero').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +chef_gem+ was _not_ removeed
+    #   expect(chef_run).to_not remove_chef_gem('community-zero')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_chef_gem(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chef_gem, :remove, resource_name)
+    end
+
+    #
+    # Assert that a +chef_gem+ resource exists in the Chef run with the
+    # action +:upgrade+. Given a Chef Recipe that upgrades "community-zero" as a
+    # +chef_gem+:
+    #
+    #     chef_gem 'community-zero' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +chef_gem+ resource with ChefSpec.
+    #
+    # @example Assert that a +chef_gem+ was upgradeed
+    #   expect(chef_run).to upgrade_chef_gem('community-zero')
+    #
+    # @example Assert that a +chef_gem+ was upgradeed with predicate matchers
+    #   expect(chef_run).to upgrade_chef_gem('community-zero').with_version('1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was upgradeed with attributes
+    #   expect(chef_run).to upgrade_chef_gem('community-zero').with(version: '1.2.3')
+    #
+    # @example Assert that a +chef_gem+ was upgradeed using a regex
+    #   expect(chef_run).to upgrade_chef_gem('community-zero').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +chef_gem+ was _not_ upgradeed
+    #   expect(chef_run).to_not upgrade_chef_gem('community-zero')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_chef_gem(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:chef_gem, :upgrade, resource_name)
+    end
+  end
+end