chefspec 3.1.0.beta.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecd2e2844bf5859e413abf186d1f71ed0f5af281
-  data.tar.gz: 72f1818ef26032cc0cb039bf3f51923eaae47800
+  metadata.gz: 8bf78a43443b7bf6d169b3de994c43635190082f
+  data.tar.gz: d6dd0630dc5f670e7037594fce9f2073bf5bc0e8
 SHA512:
-  metadata.gz: ac4ce6148c62de28889fd679ca8ba7306ec0f9be180b3bb81fbeb752c7103285fc47a7091865bbc4c28e27d608bd3d94d485caaeb56a2998b12727294c83c47b
-  data.tar.gz: ca086443be533996952f5dd17aa634bf520a8a46e4f972f0d1374481365642eca928915e1713c30cea40b92d4409c7183a314466f372d98e008ae6fc37913e77
+  metadata.gz: d12dc6f4f2fcc138e9b36be1e5a4b8f87011906edf358b749acf28a7b8d84524efae0f33e07bb3e0c1e393265c1d5271f3067bbe1350bf8ff1d5b020f824e9dc
+  data.tar.gz: a9a7bf4ae1e7d085697eaec8c872113c65310bc82b13eae615fa789a8f070ab78a3d2a10566914cd0f9d8d38505671a037de447ec1cf96f8ab0cbd67afb5d87a

data/lib/chefspec.rb

@@ -30,4 +30,23 @@ require_relative 'chefspec/matchers'
 require_relative 'chefspec/renderer'
 require_relative 'chefspec/rspec'
 require_relative 'chefspec/runner'
+require_relative 'chefspec/util'
 require_relative 'chefspec/version'
+
+module ChefSpec
+  extend self
+
+  #
+  # The source root of the ChefSpec gem. This is useful when requiring files
+  # that are relative to the root of the project.
+  #
+  # @return [Pathname]
+  #
+  def root
+    @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+  end
+end
+
+require 'i18n'
+I18n.enforce_available_locales = false
+I18n.load_path << Dir[ChefSpec.root.join('locales', '*.yml').to_s]

data/lib/chefspec/berkshelf.rb

@@ -1,10 +1,7 @@
 begin
   require 'berkshelf'
 rescue LoadError
-  raise RuntimeError, "Berkshelf not found! You must have the berkshelf" \
-    " installed on your system before requiring chefspec/berkshelf. Install" \
-    " berkshelf by running:\n\n  gem install berkshelf\n\nor add Berkshelf" \
-    " to your Gemfile:\n\n  gem 'berkshelf'\n\n"
+  raise ChefSpec::Error::GemLoadError.new(gem: 'berkshelf', name: 'Berkshelf')
 end
 
 module ChefSpec

data/lib/chefspec/coverage.rb

@@ -1,8 +1,11 @@
 module ChefSpec
   class Coverage
+
+    attr_accessor :filters
+
     class << self
       extend Forwardable
-      def_delegators :instance, :add, :cover!, :report!
+      def_delegators :instance, :add, :cover!, :report!, :filters
     end
 
     include Singleton
@@ -12,6 +15,7 @@ module ChefSpec
     #
     def initialize
       @collection = {}
+      @filters = []
     end
 
     #
@@ -20,7 +24,7 @@ module ChefSpec
     # @param [Chef::Resource] resource
     #
     def add(resource)
-      @collection[resource.to_s] = ResourceWrapper.new(resource)
+      @collection[resource.to_s] = ResourceWrapper.new(resource) if filtered?(resource)
     end
 
     #
@@ -29,11 +33,20 @@ module ChefSpec
     # @param [Chef::Resource] resource
     #
     def cover!(resource)
-      if wrapper = find(resource)
+      if filtered?(resource) && (wrapper = find(resource))
         wrapper.touch!
       end
     end
 
+    #
+    # Called to check if a resource belongs to a cookbook from the specified directories
+    #
+    # @param [Chef::Resource] resource
+    #
+    def filtered?(resource)
+      filters.empty? || filters.any? { |f| resource.source_line =~/^#{f}/ }
+    end
+
     #
     # Generate a coverage report. This report **must** be generated +at_exit+
     # or else the entire resource collection may not be complete!

data/lib/chefspec/errors.rb

@@ -1,99 +1,38 @@
 module ChefSpec
-  class Error < StandardError; end
+  module Error
+    class ChefSpecError < StandardError
+      def initialize(options = {})
+        class_name = self.class.to_s.split('::').last
+        error_key  = options[:_error_key] || Util.underscore(class_name)
 
-  class CommandNotStubbedError < Error
-    def initialize(command)
-      message =  "Real commands are disabled. Unregistered command: `#{command}`"
-      message << "\n\n"
-      message << "You can stub this command with:"
-      message << "\n\n"
-      message << "  #{Stubs::CommandStub.new(command).and_return(true).signature}"
-
-      unless Stubs::CommandRegistry.stubs.empty?
-        message << "\n\n"
-        message << "registered command stubs:"
-        message << "\n"
-
-        Stubs::CommandRegistry.stubs.each do |command|
-          message << "\n  #{command.signature}"
-        end
+        super I18n.t("chefspec.errors.#{error_key}", options)
       end
-
-      message << "\n\n"
-      message << "="*60
-      super(message)
     end
-  end
-
-  class SearchNotStubbedError < Error
-    def initialize(type, query)
-      message =  "Real searches are disabled. Unregistered search: search(#{type.inspect}, #{query.inspect})"
-      message << "\n\n"
-      message << "You can stub this search with:"
-      message << "\n\n"
-      message << "  #{Stubs::SearchStub.new(type, query).and_return({}).signature}"
 
-      unless Stubs::SearchRegistry.stubs.empty?
-        message << "\n\n"
-        message << "registered search stubs:"
-        message << "\n"
-
-        Stubs::SearchRegistry.stubs.each do |search|
-          message << "\n  #{search.signature}"
-        end
+    class NotStubbed < ChefSpecError
+      def initialize(options = {})
+        name  = self.class.name.to_s.split('::').last
+        type  = Util.underscore(name).gsub('_not_stubbed', '')
+        klass = Stubs.const_get(name.gsub('NotStubbed', '') + 'Stub')
+        stub  = klass.new(*options[:args]).and_return('...').signature
+
+        signature = "#{type}(#{options[:args].map(&:inspect).join(', ')})"
+
+        super({
+          type:       type,
+          signature:  signature,
+          stub:       stub,
+          _error_key: :not_stubbed,
+        }.merge(options))
       end
-
-      message << "\n\n"
-      message << "="*60
-      super(message)
     end
-  end
 
-  class DataBagNotStubbedError < Error
-    def initialize(bag)
-      message =  "Real data_bags are disabled. Unregistered data_bag: data_bag(#{bag.inspect})"
-      message << "\n\n"
-      message << "You can stub this data_bag with:"
-      message << "\n\n"
-      message << "  #{Stubs::DataBagStub.new(bag).and_return({}).signature}"
+    class CommandNotStubbed < NotStubbed; end
+    class SearchNotStubbed < NotStubbed; end
+    class DataBagNotStubbed < NotStubbed; end
+    class DataBagItemNotStubbed < NotStubbed; end
 
-      unless Stubs::DataBagRegistry.stubs.empty?
-        message << "\n\n"
-        message << "registered data_bag stubs:"
-        message << "\n"
-
-        Stubs::DataBagRegistry.stubs.each do |data_bag|
-          message << "\n  #{data_bag.signature}"
-        end
-      end
-
-      message << "\n\n"
-      message << "="*60
-      super(message)
-    end
-  end
-
-  class DataBagItemNotStubbedError < Error
-    def initialize(bag, id)
-      message =  "Real data_bag_items are disabled. Unregistered search: data_bag_item(#{bag.inspect}, #{id.inspect})"
-      message << "\n\n"
-      message << "You can stub this data_bag_item with:"
-      message << "\n\n"
-      message << "  #{Stubs::DataBagItemStub.new(bag, id).and_return({}).signature}"
-
-      unless Stubs::DataBagItemRegistry.stubs.empty?
-        message << "\n\n"
-        message << "registered data_bag_item stubs:"
-        message << "\n"
-
-        Stubs::DataBagItemRegistry.stubs.each do |data_bag_item|
-          message << "\n  #{data_bag_item.signature}"
-        end
-      end
-
-      message << "\n\n"
-      message << "="*60
-      super(message)
-    end
+    class CookbookPathNotFound < ChefSpecError; end
+    class GemLoadError < ChefSpecError; end
   end
 end

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

@@ -4,7 +4,10 @@ class Chef::Resource::Conditional
   # @see Chef::Resource::Conditional#evaluate_command
   def evaluate_command
     stub = ChefSpec::Stubs::CommandRegistry.stub_for(@command)
-    raise ChefSpec::CommandNotStubbedError.new(@command) if stub.nil?
+
+    if stub.nil?
+      raise ChefSpec::Error::CommandNotStubbed.new(args: [@command])
+    end
 
     stub.result
   end

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

@@ -9,7 +9,10 @@ module Chef::DSL::DataQuery
     type  = args[0]
     query = args[1] || '*:*'
     stub = ChefSpec::Stubs::SearchRegistry.stub_for(type, query)
-    raise ChefSpec::SearchNotStubbedError.new(type, query) if stub.nil?
+
+    if stub.nil?
+      raise ChefSpec::Error::SearchNotStubbed.new(args: [type, query])
+    end
 
     stub.result
   end
@@ -20,7 +23,10 @@ module Chef::DSL::DataQuery
     return old_data_bag(bag) unless Chef::Config[:solo]
 
     stub = ChefSpec::Stubs::DataBagRegistry.stub_for(bag)
-    raise ChefSpec::DataBagNotStubbedError.new(bag) if stub.nil?
+
+    if stub.nil?
+      raise ChefSpec::Error::DataBagNotStubbed.new(args: [bag])
+    end
 
     stub.result
   end
@@ -31,7 +37,10 @@ module Chef::DSL::DataQuery
     return old_data_bag_item(bag, id) unless Chef::Config[:solo]
 
     stub = ChefSpec::Stubs::DataBagItemRegistry.stub_for(bag, id)
-    raise ChefSpec::DataBagItemNotStubbedError.new(bag, id) if stub.nil?
+
+    if stub.nil?
+      raise ChefSpec::Error::DataBagItemNotStubbed.new(args: [bag, id])
+    end
 
     stub.result
   end

data/lib/chefspec/librarian.rb

@@ -3,10 +3,8 @@ begin
   require 'librarian/action/resolve'
   require 'librarian/action/install'
 rescue LoadError
-  raise RuntimeError, "Librarian not found! You must have the librarian-chef" \
-    " gem installed on your system before requiring chefspec/librarian." \
-    " Install it by running:\n\n  gem install librarian-chef\n\nor add" \
-    " Librarian to your Gemfile:\n\n  gem 'librarian-chef'\n\n"
+  raise ChefSpec::Error::GemLoadError.new(
+    gem: 'librarian-chef', name: 'Librarian')
 end
 
 module ChefSpec

data/lib/chefspec/macros.rb

@@ -167,6 +167,8 @@ module ChefSpec
     # @option options [Hash] :ohai
     #   a Hash of Ohai attributes to mock on the node
     #
+    # @return [Chef::Node]
+    #
     def stub_node(name = 'node.example', options = {}, &block)
       fauxhai = Fauxhai.mock(options).data
       fauxhai = fauxhai.merge(options[:ohai] || {})

data/lib/chefspec/runner.rb

@@ -87,43 +87,6 @@ module ChefSpec
       yield node if block_given?
     end
 
-    #
-    # Execute the specified recipes on the node, without actually converging
-    # the node. This is the equivalent of `chef-apply`.
-    #
-    # @example Converging a single recipe
-    #   chef_run.apply('example::default')
-    #
-    # @example Converging multiple recipes
-    #   chef_run.apply('example::default', 'example::secondary')
-    #
-    #
-    # @param [Array] recipe_names
-    #   The names of the recipe or recipes to apply
-    #
-    # @return [ChefSpec::Runner]
-    #   A reference to the calling Runner (for chaining purposes)
-    #
-    def apply(*recipe_names)
-      recipe_names.each do |recipe_name|
-        cookbook, recipe = Chef::Recipe.parse_recipe_name(recipe_name)
-        recipe_path = File.join(Dir.pwd, 'recipes', "#{recipe}.rb")
-
-        recipe = Chef::Recipe.new(cookbook, recipe, run_context)
-        recipe.from_file(recipe_path)
-      end
-
-      # Expand the run_list
-      expand_run_list!
-
-      # Setup the run_context
-      @run_context = Chef::RunContext.new(client.node, {}, client.events)
-
-      @converging = true
-      @client.converge(@run_context)
-      self
-    end
-
     #
     # Execute the given `run_list` on the node, without actually converging
     # the node.
@@ -150,8 +113,13 @@ module ChefSpec
       # Expand the run_list
       expand_run_list!
 
+      # Save the node back to the server for searching purposes
+      unless Chef::Config[:solo]
+        client.register
+        node.save
+      end
+
       # Setup the run_context
-      client.register unless Chef::Config[:solo]
       @run_context = client.setup_run_context
 
       # Allow stubbing/mocking after the cookbook has been compiled but before the converge
@@ -299,6 +267,8 @@ module ChefSpec
       #
       def calling_cookbook_path(kaller)
         calling_spec = kaller.find { |line| line =~ /\/spec/ }
+        raise Error::CookbookPathNotFound if calling_spec.nil?
+
         bits = calling_spec.split(':', 2).first.split(File::SEPARATOR)
         spec_dir = bits.index('spec') || 0
 
@@ -331,6 +301,7 @@ module ChefSpec
         @client.ohai.data = Mash.from_hash(Fauxhai.mock(options).data)
         @client.load_node
         @client.build_node
+        @client.save_updated_node
         @client
       end
 

data/lib/chefspec/server.rb

@@ -1,10 +1,7 @@
 begin
   require 'chef_zero/server'
 rescue LoadError
-  raise RuntimeError, "chef-zero not found! You must have the chef-zero gem" \
-    " installed on your system before requiring chefspec/server. Install" \
-    " Chef Zero by running:\n\n  gem install chef-zero\n\nor add Chef Zero" \
-    " to your Gemfile:\n\n  gem 'chef-zero'\n\n"
+  raise ChefSpec::Error::GemLoadError.new(gem: 'chef-zero', name: 'Chef Zero')
 end
 
 require 'chef/cookbook_loader'
@@ -64,6 +61,73 @@ module ChefSpec
       instance.send(m, *args, &block)
     end
 
+    #
+    # @macro entity
+    #   @method create_$1(name, data = {})
+    #     Create a new $1 on the Chef Server
+    #
+    #     @param [String] name
+    #       the name of the $1
+    #     @param [Hash] data
+    #       the list of data to load
+    #
+    #
+    #   @method $1(name)
+    #     Find a $1 at the given name
+    #
+    #     @param [String] name
+    #       the name of the $1
+    #
+    #     @return [$2, nil]
+    #
+    #
+    #   @method $3
+    #     The list of $1 on the Chef Server
+    #
+    #     @return [Array<Hash>]
+    #       all the $1 on the Chef Server
+    #
+    #
+    #   @method has_$1?(name)
+    #     Determine if the Chef Server has the given $1
+    #
+    #     @param [String] name
+    #       the name of the $1 to find
+    #
+    #     @return [Boolean]
+    #
+    def self.entity(method, klass, key)
+      class_eval <<-EOH, __FILE__, __LINE__ + 1
+        def create_#{method}(name, data = {})
+          data = JSON.fast_generate(data) unless '#{key}' == 'data'
+          @server.load_data('#{key}' => { name => data })
+        end
+
+        def #{method}(name)
+          data = @server.data_store.get(['#{key}', name])
+          json = JSON.parse(data)
+
+          if #{klass}.respond_to?(:json_create)
+            #{klass}.json_create(json)
+          else
+            #{klass}.new(json)
+          end
+        rescue ChefZero::DataStore::DataNotFoundError
+          nil
+        end
+
+        def #{key}
+          @server.data_store.list(['#{key}'])
+        end
+
+        def has_#{method}?(name)
+          !@server.data_store.get(['#{key}', name]).nil?
+        rescue ChefZero::DataStore::DataNotFoundError
+          false
+        end
+      EOH
+    end
+
     include Singleton
 
     attr_reader :server
@@ -78,6 +142,12 @@ module ChefSpec
       )
     end
 
+    entity :client,      Chef::Client, 'clients'
+    entity :data_bag,    Chef::DataBag, 'data'
+    entity :environment, Chef::Environment, 'environments'
+    entity :node,        Chef::Node, 'nodes'
+    entity :role,        Chef::Role, 'roles'
+
     #
     # The path to the insecure Chef Zero private key on disk. Because Chef
     # requires the path to a file instead of the contents of the key (why),
@@ -122,45 +192,6 @@ module ChefSpec
       FileUtils.rm_rf(cache_dir)
     end
 
-    #
-    # Create a client on the Chef Server.
-    #
-    def create_client(name, data = {})
-      load_data(:clients, name, data)
-    end
-
-    #
-    # Create a data_bag on the Chef Server.
-    #
-    def create_data_bag(name, data = {})
-      @server.load_data('data' => { name => data })
-    end
-
-    #
-    # Create an environment on the Chef Server.
-    #
-    def create_environment(name, data = {})
-      load_data(:environments, name, data)
-    end
-
-    #
-    # Create a node on the Chef Server.
-    #
-    # @note
-    #   The current node (chefspec) is automatically registered and added to
-    #   the Chef Server
-    #
-    def create_node(name, data = {})
-      load_data(:nodes, name, data)
-    end
-
-    #
-    # Create a role on the Chef Server.
-    #
-    def create_role(name, data = {})
-      load_data(:roles, name, data)
-    end
-
     private
 
       #

data/lib/chefspec/util.rb

@@ -0,0 +1,58 @@
+module ChefSpec
+  module Util
+    extend self
+
+    #
+    # Covert the given CaMelCaSeD string to under_score. Graciously borrowed
+    # from http://stackoverflow.com/questions/1509915.
+    #
+    # @param [String] string
+    #   the string to use for transformation
+    #
+    # @return [String]
+    #
+    def underscore(string)
+      string
+        .to_s
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+
+    #
+    # Convert an underscored string to it's camelcase equivalent constant.
+    #
+    # @param [String] string
+    #   the string to convert
+    #
+    # @return [String]
+    #
+    def camelize(string)
+      string
+        .to_s
+        .split('_')
+        .map { |e| e.capitalize }
+        .join
+    end
+
+    #
+    # Truncate the given string to a certain number of characters.
+    #
+    # @param [String] string
+    #   the string to truncate
+    # @param [Hash] options
+    #   the list of options (such as +length+)
+    #
+    def truncate(string, options = {})
+      length = options[:length] || 30
+
+      if string.length > length
+        string[0..length-3] + '...'
+      else
+        string
+      end
+    end
+  end
+end

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '3.1.0.beta.1'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec
 version: !ruby/object:Gem::Version
-  version: 3.1.0.beta.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Andrew Crump
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -53,6 +53,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: chef-zero
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +143,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/chefspec.rb
+- lib/chefspec/api.rb
 - lib/chefspec/api/apt_package.rb
 - lib/chefspec/api/batch.rb
 - lib/chefspec/api/chef_gem.rb
@@ -177,7 +193,6 @@ files:
 - lib/chefspec/api/template.rb
 - lib/chefspec/api/user.rb
 - lib/chefspec/api/yum_package.rb
-- lib/chefspec/api.rb
 - lib/chefspec/berkshelf.rb
 - lib/chefspec/cacher.rb
 - lib/chefspec/coverage.rb
@@ -193,13 +208,13 @@ files:
 - lib/chefspec/formatter.rb
 - lib/chefspec/librarian.rb
 - lib/chefspec/macros.rb
+- lib/chefspec/matchers.rb
 - lib/chefspec/matchers/include_recipe_matcher.rb
 - lib/chefspec/matchers/link_to_matcher.rb
 - lib/chefspec/matchers/notifications_matcher.rb
 - lib/chefspec/matchers/render_file_matcher.rb
 - lib/chefspec/matchers/resource_matcher.rb
 - lib/chefspec/matchers/state_attrs_matcher.rb
-- lib/chefspec/matchers.rb
 - lib/chefspec/mixins/normalize.rb
 - lib/chefspec/renderer.rb
 - lib/chefspec/rspec.rb
@@ -215,8 +230,8 @@ files:
 - lib/chefspec/stubs/search_registry.rb
 - lib/chefspec/stubs/search_stub.rb
 - lib/chefspec/stubs/stub.rb
+- lib/chefspec/util.rb
 - lib/chefspec/version.rb
-- lib/chefspec.rb
 homepage: http://acrmp.github.com/chefspec
 licenses:
 - MIT
@@ -232,14 +247,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: chefspec-3.1.0.beta.1
+summary: chefspec-3.1.0
 test_files: []
 has_rdoc: