chefspec-bootstrap 0.0.2 → 0.0.3

data/README.md

@@ -23,10 +23,6 @@ require 'chefspec'
 describe 'cookbook::recipe' do
   let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
 
-  it 'runs successfully' do
-    expect{chef_run}.not_to raise_error
-  end
-  
   it "installs the apache2 package" do
     expect(chef_run).to install_package("apache2")
   end

data/bin/chefspec-bootstrap

@@ -3,11 +3,21 @@
 require 'chefspec-bootstrap'
 require 'trollop'
 
+cookbook_path_help_text = "RSpec config for cookbook path. Defaults to RSpec.configure.cookbook_path from spec_helper.rb."
+
 opts = Trollop::options do
   opt :cookbooks_dir, "Your site cookbooks directory", :type => :string, :default => "site-cookbooks"
+  opt :cookbooks_path, cookbook_path_help_text, :type => :strings
+  opt :recursive, "Generate specs for included recipes."
   opt :spec_dir, "Your spec directory", :type => :string, :default => "spec"
   opt :template, "ERB template file used to generate specs", :type => :string
 end
 
-bootstrap = ChefSpec::Bootstrap.new(opts[:cookbooks_dir], opts[:spec_dir], opts[:template])
+bootstrap = ChefSpec::Bootstrap.new(
+  opts[:cookbooks_dir],
+  opts[:cookbooks_path],
+  opts[:spec_dir],
+  opts[:template],
+  opts[:recursive]
+)
 bootstrap.generate()

data/chefspec-bootstrap.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'chefspec-bootstrap'
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.date        = '2014-06-02'
   s.summary     = "Bootstrap your ChefSpec tests."
   s.description = "Automatically generate ChefSpec tests based on your recipes."

data/lib/api_map.rb

@@ -0,0 +1,84 @@
+module ChefSpec
+  class APIMap
+
+    IT_CREATE_IF_MISSING = "creates the %{adjective} %{noun} if it is missing"
+    IT_MODIFY = "modifies the %{adjective} %{noun}"
+    IT_TOUCH = "touches the %{adjective} %{noun}"
+    EXPECT_CREATE_IF_MISSING = "create_%{noun}_if_missing"
+
+    def map
+      {
+        :cookbook_file => {
+          :it => { :create_if_missing => IT_CREATE_IF_MISSING },
+          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+        },
+        :deploy => {
+          :it => { :force_deploy => "force deploys the %{adjective} %{noun}" }
+        },
+        :env => {
+          :it => { :modify => IT_MODIFY }
+        },
+        :execute => {
+          :it => { :run => "executes %{adjective}" }
+        },
+        :file => {
+          :it => {
+            :create_if_missing => IT_CREATE_IF_MISSING,
+            :touch => IT_TOUCH
+          },
+          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+        },
+        :git => {
+          :it => {
+            :default => "%{verb}s the %{adjective} git repository",
+            :checkout => "checks out the %{adjective} git repository"
+          }
+        },
+        :group => {
+          :it => { :modify => IT_MODIFY }
+        },
+        :http_request => {
+          :it => {
+            :default => "performs a %{verb} HTTP request to %{adjective}"
+          }
+        },
+        :ifconfig => {
+          :it => {
+            :default => "%{verb}s the %{adjective} network interface using %{noun}"
+          }
+        },
+        :registry_key => {
+          :it => {
+            :create_if_missing => IT_CREATE_IF_MISSING,
+            :delete => "%{verb}s the %{adjective} %{noun} value"
+          },
+          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+        },
+        :remote_directory => {
+          :it => { :create_if_missing => IT_CREATE_IF_MISSING },
+          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+        },
+        :remote_file => {
+          :it => {
+            :create_if_missing => IT_CREATE_IF_MISSING,
+            :touch => IT_TOUCH
+          },
+          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+        },
+        :subversion => {
+          :it => {
+            :default => "%{verb}s the %{adjective} svn repository",
+            :checkout => "checks out the %{adjective} svn repository"
+          }
+        },
+        :template => {
+          :it => {
+            :create_if_missing => IT_CREATE_IF_MISSING,
+            :touch => IT_TOUCH
+          },
+          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+        }
+      }
+    end
+  end
+end

data/lib/chefspec-bootstrap.rb

@@ -2,14 +2,17 @@ require 'erb'
 require 'fileutils'
 require 'ostruct'
 require 'chefspec'
+require_relative 'api_map'
 
 module ChefSpec
   class Bootstrap
 
-    def initialize(cookbooks_dir, spec_dir, template_file)
+    def initialize(cookbooks_dir, cookbooks_path, spec_dir, template_file, recursive)
       @cookbooks_dir = cookbooks_dir
+      @cookbooks_path = cookbooks_path
       @spec_dir = spec_dir
       @template_file = template_file
+      @recursive = recursive
     end
 
     def setup
@@ -24,6 +27,18 @@ module ChefSpec
       if not File.exist?(@template_file)
         abort "Unable to locate template file (#{@template_file})"
       end
+
+      @api_map = ChefSpec::APIMap.new.map
+
+      begin
+        require File.expand_path("#{@spec_dir}/spec_helper.rb")
+        @spec_helper = true
+      rescue LoadError
+        @spec_helper = false
+        ::RSpec.configure do |config|
+          config.cookbook_path = @cookbooks_path || [@cookbooks_dir, 'cookbooks']
+        end
+      end
     end
 
     def generate
@@ -31,14 +46,6 @@ module ChefSpec
 
       erb = ERB.new(File.read(@template_file))
 
-      # begin
-      #   require "#{@spec_dir}/spec_helper.rb"
-      # rescue LoadError
-
-      # end
-
-      ::RSpec.configure { |config| config.cookbook_path = [@cookbooks_dir, 'cookbooks'] }
-
       Dir.glob("#{@cookbooks_dir}/*/recipes/*").each do |path|
         path, recipe_file = File.split(path)
         recipe = recipe_file.split('.')[0]
@@ -62,7 +69,7 @@ module ChefSpec
             puts "    execution failed. Creating empty spec file."
           end
 
-          resources = get_resources(chef_run)
+          resources = get_resources(chef_run, cookbook, recipe)
           test_cases = generate_test_cases(resources)
 
           File.open(filename, "w") do |spec_file|
@@ -79,7 +86,7 @@ module ChefSpec
     def get_chef_run(cookbook, recipe)
       begin
         return ChefSpec::Runner.new.converge("#{cookbook}::#{recipe}")
-      rescue
+      rescue Exception => e
         return nil
       end
     end
@@ -88,9 +95,20 @@ module ChefSpec
       return resource.name || resource.identity
     end
 
-    def get_resources(chef_run)
+    def get_all_resources(chef_run)
+      return chef_run.resource_collection.all_resources
+    end
+
+    def get_resources(chef_run, cookbook, recipe)
       if chef_run
-        return chef_run.resource_collection.all_resources
+        resources = get_all_resources(chef_run)
+        if @recursive
+          return resources
+        else
+          return resources.select do |resource|
+            resource.cookbook_name == cookbook.to_sym and resource.recipe_name == recipe
+          end
+        end
       else
         return []
       end
@@ -110,8 +128,8 @@ module ChefSpec
         verbs.each do |verb|
           if not verb == :nothing
             test_cases.push({
-              :it => "#{verb}s the #{adjective} #{noun}",
-              :action => "#{verb}_#{noun}",
+              :it => get_it_block(noun, verb, adjective),
+              :expect => get_expect_block(noun, verb),
               :name => adjective
             })
           end
@@ -119,5 +137,42 @@ module ChefSpec
       end
       return test_cases
     end
+
+    def get_it_block(noun, verb, adjective)
+      it = "%{verb}s the %{adjective} %{noun}"
+      noun_readable = noun.to_s.gsub("_", " ")
+      verb_readable = verb.to_s.gsub("_", " ")
+      string_variables = {:noun => noun_readable, :verb => verb_readable, :adjective => adjective}
+
+      if @api_map[noun] and @api_map[noun][:it]
+        if @api_map[noun][:it][verb]
+          it = @api_map[noun][:it][verb]
+        elsif @api_map[noun][:it][:default]
+          it = @api_map[noun][:it][:default]
+        end
+      end
+
+      return escape_string(it  % string_variables)
+    end
+
+    def get_expect_block(noun, verb)
+      expect = "%{verb}_%{noun}"
+      string_variables = {:noun => noun, :verb => verb}
+
+      if @api_map[noun] and @api_map[noun][:expect]
+        if @api_map[noun][:expect][verb]
+          expect = @api_map[noun][:expect][verb]
+        elsif @api_map[noun][:expect][:default]
+          expect = @api_map[noun][:expect][:default]
+        end
+      end
+
+      return escape_string(expect % string_variables)
+    end
+
+    def escape_string(string)
+      return string.gsub("\\","\\\\").gsub("\"", "\\\"")
+    end
+
   end
 end

data/templates/default.erb

@@ -1,13 +1,12 @@
 require 'chefspec'
 
 describe '<%= cookbook %>::<%= recipe %>' do
-  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }<% if not test_cases.empty? %><% test_cases.each do |test_case| %>
 
+  it "<%= test_case[:it] %>" do
+    expect(chef_run).to <%= test_case[:expect] %>("<%= test_case[:name] %>")
+  end<% end %><% else %>
   it 'runs successfully' do
     expect{chef_run}.not_to raise_error
-  end<% if test_cases %><% test_cases.each do |test_case| %>
-
-  it "<%= test_case[:it] %>" do
-    expect(chef_run).to <%= test_case[:action] %>("<%= test_case[:name] %>")
-  end<% end %><% end %>
+  end<% end %>
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec-bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -55,6 +55,7 @@ files:
 - README.md
 - bin/chefspec-bootstrap
 - chefspec-bootstrap.gemspec
+- lib/api_map.rb
 - lib/chefspec-bootstrap.rb
 - templates/default.erb
 homepage: http://rubygems.org/gems/chefspec-bootstrap