chefspec 0.2.1 → 0.3.0

data/lib/chef/knife/cookbook_create_specs.rb

@@ -0,0 +1,107 @@
+require 'chefspec'
+
+if Chef.const_defined? :Knife
+  module ChefSpec
+    module Knife
+
+      # Knife plugin to create placeholder specs.
+      #
+      # $ knife cookbook create -o . my_new_cookbook
+      # $ knife cookbook create_specs -o . my_new_cookbook
+      # $ rspec my_new_cookbook
+      #
+      # http://help.opscode.com/kb/knife/manage-cookbooks-with-knife
+      class CookbookCreateSpecs < Chef::Knife
+
+        # Implemented as a separate knife command rather than extending the knife built-in create_cookbook_command.
+        # Extension may arguably have been better from the end user perspective but would be much more brittle.
+
+        banner "knife cookbook create_specs COOKBOOK (options)"
+
+        option :cookbook_path,
+               :short => "-o PATH",
+               :long => "--cookbook-path PATH",
+               :description => "The directory where the cookbook specs will be created"
+
+        # Invoke this command and create the new specs
+        def run
+          self.config = Chef::Config.merge!(config)
+          if @name_args.empty?
+            show_usage
+            ui.fatal("You must specify a cookbook name")
+            exit 1
+          end
+
+          if default_cookbook_path_empty? && parameter_empty?(config[:cookbook_path])
+            raise ArgumentError, "Default cookbook_path is not specified in the knife.rb config file, and a value to -o is not provided. Nowhere to write the new cookbook to."
+          end
+
+          create_specs(Array(config[:cookbook_path]).first, @name_args.first)
+        end
+
+        private
+
+        # Has a default cookbook path been set?
+        #
+        # @return [Boolean] True if cookbook path has been set in the Chef config.
+        def default_cookbook_path_empty?
+          Chef::Config[:cookbook_path].nil? || Chef::Config[:cookbook_path].empty?
+        end
+
+        # Create placeholder specs for the cookbook.
+        #
+        # @param [String] dir The directory to create the specs in
+        # @param [String] cookbook The name of the cookbook
+        # @param [String] recipe The name of the recipe to create a spec for
+        def create_specs(dir, cookbook)
+          spec_dir = "#{File.join(dir, cookbook, 'spec')}"
+          FileUtils.mkdir_p spec_dir
+          msg("** Creating specs for cookbook: #{cookbook}")
+          existing_recipes(dir, cookbook).each do |recipe|
+            create_spec(spec_dir, cookbook, recipe)
+          end
+        end
+
+        # The list of recipes for a cookbook
+        #
+        # @param [String] dir The directory
+        # @param [String] cookbook The name of the cookbook
+        # @return [Array] The list of recipes for the cookbook
+        def existing_recipes(dir, cookbook)
+          Dir[File.join(dir, cookbook, 'recipes/*.rb')].map{|recipe| File.basename recipe, '.rb'}
+        end
+
+        # Create a placeholder spec for the cookbook.
+        #
+        # @param [String] spec_dir The directory to create the specs in
+        # @param [String] cookbook The name of the cookbook
+        # @param [String] recipe The name of the recipe to create a spec for
+        def create_spec(spec_dir, cookbook, recipe)
+          unless File.exists?(File.join(spec_dir, "#{recipe}_spec.rb"))
+            open(File.join(spec_dir, "#{recipe}_spec.rb"), "w") do |file|
+              file.puts spec_file_content(cookbook, recipe)
+            end
+          end
+        end
+
+        # Generate the content for the placeholder spec file.
+        #
+        # @param [String] cookbook The name of the cookbook
+        # @param [String] recipe The name of the recipe
+        def spec_file_content(cookbook, recipe)
+          return <<-EOH
+require 'chefspec'
+
+describe '#{cookbook}::#{recipe}' do
+  let (:chef_run) { ChefSpec::ChefRunner.new.converge '#{cookbook}::#{recipe}' }
+  it 'should do something' do
+    pending 'Your recipe examples go here.'
+  end
+end
+          EOH
+        end
+
+      end
+    end
+  end
+end

data/lib/chefspec.rb

@@ -8,5 +8,6 @@ require 'chefspec/matchers/log'
 require 'chefspec/matchers/package'
 require 'chefspec/matchers/service'
 require 'chefspec/matchers/shared'
+require 'chefspec/matchers/file_content'
 require 'chefspec/monkey_patches/hash'
 require 'chefspec/monkey_patches/provider'

data/lib/chefspec/matchers/file_content.rb

@@ -0,0 +1,27 @@
+require 'chefspec/matchers/shared'
+
+module ChefSpec
+  module Matchers
+    RSpec::Matchers.define :create_file_with_content do |path, content|
+      match do |chef_run|
+        chef_run.resources.any? do |resource|
+          if resource.name == path
+            if resource.action.include?(:create) || resource.action.include?(:create_if_missing)
+              case resource_type(resource)
+                when 'template'
+                  @actual_content = render(resource, chef_run.node)
+                  content == @actual_content
+                when 'file'
+                  @actual_content = resource.content
+                  content == @actual_content
+              end
+            end
+          end
+        end
+      end
+      failure_message_for_should do |actual|
+        "File content:\n#{@actual_content} does not match expected:\n#{content}"
+      end
+    end
+  end
+end

data/lib/chefspec/matchers/log.rb

@@ -1,6 +1,7 @@
 require 'chefspec/matchers/shared'
 
 module ChefSpec
+  # RSpec Matchers
   module Matchers
     RSpec::Matchers.define :log do |message|
       match do |chef_run|

data/lib/chefspec/matchers/shared.rb

@@ -30,4 +30,24 @@ def define_resource_matchers(actions, resource_types, name_attribute)
       end
     end
   end
-end
+end
+
+# Render a template.
+#
+# @param [Chef::Resource::Template] template The template to render
+# @param [Chef::Node] node The node which may be required to render the template
+# @return [String] The result result of rendering the template
+def render(template, node)
+  # Duplicates functionality in the Chef Template provider
+  context = {}; context.merge!(template.variables)
+  context[:node] = node
+  Erubis::Eruby.new(IO.read(template_path(template))).evaluate(context)
+end
+
+# Given a template, return the path on disk.
+#
+# @param [Chef::Resource::Template] template The template
+# @return [String] The path on disk
+def template_path(template)
+  File.join("cookbooks/#{template.cookbook || template.cookbook_name}/templates/default", template.source)
+end

data/lib/chefspec/monkey_patches/provider.rb

@@ -1,9 +1,16 @@
 # Override Chef LWRP creation to remove existing class to avoid redefinition warnings.
 class Chef
+  # Chef provider for a resource
   class Provider
     class << self
-      alias :old_build_from_file :build_from_file
+      alias_method :old_build_from_file, :build_from_file
 
+      # Override Opscode provider to remove any existing LWRP
+      #
+      # @param [String] cookbook_name The name of the cookbook
+      # @param [String] filename File to load as a LWRP
+      # @param [Chef::RunContext] run_context Context of a Chef Run
+      # @return [Chef::Provider] the created provider
       def build_from_file(cookbook_name, filename, run_context)
         remove_existing_lwrp(convert_to_class_name(filename_to_qualified_string(cookbook_name, filename)))
         old_build_from_file(cookbook_name, filename, run_context)

data/lib/chefspec/version.rb

@@ -1,3 +1,4 @@
 module ChefSpec
-  VERSION = '0.2.1'
-end
+  # The gem version
+  VERSION = '0.3.0'
+end

metadata

@@ -1,73 +1,63 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: chefspec
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Andrew Crump
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2011-10-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: &2151873320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 9
-        - 12
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.12
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 10
-        version: "0.10"
-  name: chef
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :runtime
   prerelease: false
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2151873320
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: &2151885360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151885360
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: &2151891840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
   type: :runtime
   prerelease: false
-  requirement: *id002
+  version_requirements: *2151891840
 description: Write RSpec examples for Opscode Chef recipes
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- lib/chef/knife/cookbook_create_specs.rb
 - lib/chefspec/chef_runner.rb
 - lib/chefspec/matchers/execute.rb
 - lib/chefspec/matchers/file.rb
+- lib/chefspec/matchers/file_content.rb
 - lib/chefspec/matchers/log.rb
 - lib/chefspec/matchers/package.rb
 - lib/chefspec/matchers/service.rb
@@ -77,37 +67,34 @@ files:
 - lib/chefspec/version.rb
 - lib/chefspec.rb
 homepage: http://acrmp.github.com/chefspec
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 4357686734109657142
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 4357686734109657142
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: chefspec-0.2.1
+summary: chefspec-0.3.0
 test_files: []
-