chefspec 0.0.1

data/lib/chefspec.rb

@@ -0,0 +1,9 @@
+require 'chef'
+require 'chefspec/chef_runner'
+require 'chefspec/matchers/execute'
+require 'chefspec/matchers/file'
+require 'chefspec/matchers/log'
+require 'chefspec/matchers/package'
+require 'chefspec/matchers/service'
+require 'chefspec/matchers/shared'
+require 'chefspec/monkey_patches/hash'

data/lib/chefspec/chef_runner.rb

@@ -0,0 +1,95 @@
+require 'chef'
+require 'chef/client'
+require 'chef/cookbook_loader'
+require 'chefspec/matchers/shared'
+
+# ChefSpec allows you to write rspec examples for Chef recipes to gain faster feedback without the need to converge a
+# node.
+module ChefSpec
+
+  # The main entry point for running recipes within RSpec.
+  class ChefRunner
+
+    @step_into = []
+    @resources = []
+
+    attr_reader :resources
+    attr_reader :node
+
+    # Instantiate a new runner to run examples with.
+    #
+    # @param [string] cookbook_path The path to the chef cookbook(s) to be tested
+    def initialize(cookbook_path=default_cookbook_path)
+      the_runner = self
+
+      Chef::Resource.class_eval do
+        alias :old_run_action :run_action
+
+        @@runner = the_runner
+
+        def run_action(action)
+          @@runner.resources << self
+        end
+      end
+
+      Chef::Config[:solo] = true
+      Chef::Config[:cookbook_path] = cookbook_path
+      Chef::Log.verbose = true
+      Chef::Log.level(:debug)
+      @client = Chef::Client.new
+      @client.run_ohai
+      @node = @client.build_node
+    end
+
+    # Infer the default cookbook path from the location of the calling spec.
+    #
+    # @return [String] The path to the cookbooks directory
+    def default_cookbook_path
+      File.join(caller(2).first.split(':').slice(0..-3).to_s, "..", "..", "..")
+    end
+
+    # Run the specified recipes, but without actually converging the node.
+    #
+    # @param [array] recipe_names The names of the recipes to execute
+    def converge(*recipe_names)
+      recipe_names.each do |recipe_name|
+        @client.node.run_list << recipe_name
+      end
+
+      @resources = []
+      run_context = Chef::RunContext.new(@client.node, Chef::CookbookCollection.new(Chef::CookbookLoader.new))
+
+      runner = Chef::Runner.new(run_context)
+      runner.converge
+    end
+
+    # Find any directory declared with the given path
+    #
+    # @param [String] path The directory path
+    # @return [Chef::Resource::Directory] The matching directory, or Nil
+    def directory(path)
+      find_resource('directory', path)
+    end
+
+    # Find any file declared with the given path
+    #
+    # @param [String] path The file path
+    # @return [Chef::Resource::Directory] The matching file, or Nil
+    def file(path)
+      find_resource('file', path)
+    end
+
+    private
+
+    # Find the resource with the declared type and name
+    #
+    # @param [String] type The type of resource - e.g. 'file' or 'directory'
+    # @param [String] name The resource name
+    # @return [Chef::Resource] The matching resource, or Nil
+    def find_resource(type, name)
+      resources.find{|resource| resource_type(resource) == type and resource.name == name}
+    end
+
+  end
+
+end

data/lib/chefspec/matchers/execute.rb

@@ -0,0 +1,13 @@
+require 'chefspec/matchers/shared'
+
+module ChefSpec
+  module Matchers
+    RSpec::Matchers.define :execute_command do |command|
+      match do |chef_run|
+        chef_run.resources.any? do |resource|
+          resource_type(resource) == 'execute' and resource.command == command
+        end
+      end
+    end
+  end
+end

data/lib/chefspec/matchers/file.rb

@@ -0,0 +1,16 @@
+require 'chefspec/matchers/shared'
+
+module ChefSpec
+  module Matchers
+
+    define_resource_matchers([:create, :delete], [:file, :directory], :path)
+
+    RSpec::Matchers.define :be_owned_by do |user, group|
+      match do |file|
+        file.owner == user and file.group == group
+      end
+    end
+  end
+end
+
+

data/lib/chefspec/matchers/log.rb

@@ -0,0 +1,13 @@
+require 'chefspec/matchers/shared'
+
+module ChefSpec
+  module Matchers
+    RSpec::Matchers.define :log do |message|
+      match do |chef_run|
+        chef_run.resources.any? do |resource|
+          resource_type(resource) == 'log' and resource.name == message
+        end
+      end
+    end
+  end
+end

data/lib/chefspec/matchers/package.rb

@@ -0,0 +1,16 @@
+require 'chefspec/matchers/shared'
+
+module ChefSpec
+  module Matchers
+
+    define_resource_matchers([:install, :remove, :upgrade, :purge], [:package], :package_name)
+
+    RSpec::Matchers.define :install_package_at_version do |package_name, version|
+      match do |chef_run|
+        chef_run.resources.any? do |resource|
+          resource_type(resource) == 'package' and resource.package_name == package_name and resource.action.to_s == 'install' and resource.version == version
+        end
+      end
+    end
+  end
+end

data/lib/chefspec/matchers/service.rb

@@ -0,0 +1,16 @@
+require 'chefspec/matchers/shared'
+
+module ChefSpec
+  module Matchers
+
+    define_resource_matchers([:start, :stop, :restart, :reload], [:service], :service_name)
+
+    RSpec::Matchers.define :set_service_to_start_on_boot do |service|
+      match do |chef_run|
+        chef_run.resources.any? do |resource|
+          resource_type(resource) == 'service' and resource.service_name == service and resource.action.include? :enable
+        end
+      end
+    end
+  end
+end

data/lib/chefspec/matchers/shared.rb

@@ -0,0 +1,33 @@
+# Given a resource return the unqualified type it is
+#
+# @param [String] resource A Chef Resource
+# @return [String] The resource type
+def resource_type(resource)
+  resource.class.name.split("::").last.downcase
+end
+
+# Define simple RSpec matchers for the product of resource types and actions
+#
+# @param [Array] actions The valid actions - for example [:create, :delete]
+# @param [Array] resource_types The resource types
+# @param [Symbol] name_attribute The name attribute of the resource types
+def define_resource_matchers(actions, resource_types, name_attribute)
+  actions.product(resource_types).flatten.each_slice(2) do |action, resource_type|
+    RSpec::Matchers.define "#{action}_#{resource_type}".to_sym do |name|
+      match do |chef_run|
+        accepted_types = [resource_type.to_s]
+        accepted_types << 'template' if action.to_s == 'create' and resource_type.to_s == 'file'
+        chef_run.resources.any? do |resource|
+          accepted_types.include? resource_type(resource) and resource.send(name_attribute) == name and
+              resource.action.to_s.include? action.to_s
+        end
+      end
+      failure_message_for_should do |actual|
+        "No #{resource_type} resource named '#{name}' with action :#{action} found."
+      end
+      failure_message_for_should_not do |actual|
+        "Found #{resource_type} resource named '#{name}' with action :#{action} that should not exist."
+      end
+    end
+  end
+end

data/lib/chefspec/monkey_patches/hash.rb

@@ -0,0 +1,16 @@
+# Ruby stdlib Hash class
+class Hash
+
+  # Monkey-patch to stdlib Hash to give us auto-vivifying hashes like Chef.
+  # @param [Symbol] method_id The method name
+  def method_missing(method_id)
+    key = method_id.id2name
+    if has_key?(key)
+      self[key]
+    elsif has_key?(key.to_sym)
+      self[key.to_sym]
+    else
+      super.method_missing(method_id)
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: chefspec
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andrew Crump
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-31 00:00:00 Z
+dependencies: []
+
+description: Write RSpec examples for Opscode Chef recipes
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/chefspec/chef_runner.rb
+- lib/chefspec/matchers/execute.rb
+- lib/chefspec/matchers/file.rb
+- lib/chefspec/matchers/log.rb
+- lib/chefspec/matchers/package.rb
+- lib/chefspec/matchers/service.rb
+- lib/chefspec/matchers/shared.rb
+- lib/chefspec/monkey_patches/hash.rb
+- lib/chefspec.rb
+homepage: http://acrmp.github.com/chefspec
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: chefspec-0.0.1
+test_files: []
+