chefspec-bootstrap 0.0.1 → 0.0.2

data/README.md

@@ -1,11 +1,67 @@
 chefspec-bootstrap
 ==================
 
-A tool to get started with ChefSpec. The script will look up all your recipes and create a spec file for each one.
+A command line tool to get started with ChefSpec. Generates spec files for your untested recipes.
 
-From within your chef project directory:
+Given a cookbook called `cookbook` with a recipe called `recipe.rb`:
+```ruby
+package "apache2"
+
+file "/etc/apache2/sites-available/default" do
+  action :delete
+end
+
+template "/etc/apache2/sites-available/mysite" do
+  source "mysite.conf.erb"
+end
+```
+
+The command line tool will generate the following spec file at `spec/cookbook/recipe_spec.rb`:
+```ruby
+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
+
+  it "deletes the /etc/apache2/conf.d/python.conf file" do
+    expect(chef_run).to delete_file("/etc/apache2/conf.d/python.conf")
+  end
+
+  it "creates the /etc/apache2/sites-available/mysite template" do
+    expect(chef_run).to create_template("/etc/apache2/sites-available/mysite")
+  end
+end
 ```
-wget https://raw.githubusercontent.com/AMeng/chefspec-bootstrap/master/bootstrap.rb
-chmod +x bootstrap.rb
-./bootstrap.rb
+
+
+Getting Started
+---
+Install the gem
 ```
+gem install chefspec-bootstrap
+```
+
+Run the command-line tool
+```
+chefspec-bootstrap
+```
+
+Options
+---
+```
+--cookbooks-dir, -c <s>:   Your site cookbooks directory (default: site-cookbooks)
+--spec-dir, -s <s>:        Your spec directory (default: spec)
+--template, -t <s>:        ERB template file used to generate specs
+```
+
+Creating a custom template
+---
+A custom erb template can be passsed using the `-t` flag. See the included default template for an example.

data/bin/chefspec-bootstrap

@@ -9,6 +9,5 @@ opts = Trollop::options do
   opt :template, "ERB template file used to generate specs", :type => :string
 end
 
-bootstrap = ChefSpec::Bootstrap.new
-
-bootstrap.generate(opts[:cookbooks_dir], opts[:spec_dir], opts[:template])
+bootstrap = ChefSpec::Bootstrap.new(opts[:cookbooks_dir], opts[:spec_dir], opts[:template])
+bootstrap.generate()

data/chefspec-bootstrap.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'chefspec-bootstrap'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = '2014-06-02'
   s.summary     = "Bootstrap your ChefSpec tests."
   s.description = "Automatically generate ChefSpec tests based on your recipes."
@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.executables   = ["chefspec-bootstrap"]
   s.required_ruby_version = '>= 1.9'
 
-  s.add_dependency 'chef',     '~> 11.0'
-  s.add_dependency 'chefspec', '~> 3.1.0'
+  s.add_dependency 'chefspec', '~> 3.4.0'
   s.add_dependency 'trollop', '~> 2.0.0'
 end

data/lib/chefspec-bootstrap.rb

@@ -1,37 +1,69 @@
-#!/usr/bin/env ruby
-
 require 'erb'
 require 'fileutils'
 require 'ostruct'
+require 'chefspec'
 
 module ChefSpec
   class Bootstrap
-    def generate(cookbooks_dir, spec_dir, template_file)
-      if not Dir.exist?(cookbooks_dir)
-        abort "Unable to locate your cookbooks directory (#{cookbooks_dir})"
+
+    def initialize(cookbooks_dir, spec_dir, template_file)
+      @cookbooks_dir = cookbooks_dir
+      @spec_dir = spec_dir
+      @template_file = template_file
+    end
+
+    def setup
+      if not Dir.exist?(@cookbooks_dir)
+        abort "Unable to locate your cookbooks directory (#{@cookbooks_dir})"
       end
 
-      if not template_file
-        template_file = root.join('templates', 'default.erb')
+      if not @template_file
+        @template_file = root.join('templates', 'default.erb')
       end
 
-      if not File.exist?(template_file)
-        abort "Unable to locate template file (#{template_file})"
+      if not File.exist?(@template_file)
+        abort "Unable to locate template file (#{@template_file})"
       end
+    end
+
+    def generate
+      setup()
+
+      erb = ERB.new(File.read(@template_file))
+
+      # begin
+      #   require "#{@spec_dir}/spec_helper.rb"
+      # rescue LoadError
 
-      erb = ERB.new(File.read(template_file))
+      # end
 
-      Dir.glob("#{cookbooks_dir}/*/recipes/*").each do |path|
+      ::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]
         cookbook = path.split(File::SEPARATOR)[1]
 
-        filename = "#{spec_dir}/#{cookbook}/#{recipe}_spec.rb"
+        filename = "#{@spec_dir}/#{cookbook}/#{recipe}_spec.rb"
+
+        puts filename
 
-        if not File.exist?(filename)
-          FileUtils.mkdir_p "#{spec_dir}/#{cookbook}"
+        if File.exist?(filename)
+          puts "    spec already exists. Skipping."
+        else
+          FileUtils.mkdir_p "#{@spec_dir}/#{cookbook}"
 
-          puts "Creating spec file: #{filename}"
+          puts "    executing recipe with ChefSpec..."
+          chef_run = get_chef_run(cookbook, recipe)
+
+          if chef_run
+            puts "    execution suceeded. Creating spec file."
+          else
+            puts "    execution failed. Creating empty spec file."
+          end
+
+          resources = get_resources(chef_run)
+          test_cases = generate_test_cases(resources)
 
           File.open(filename, "w") do |spec_file|
             spec_file.write(erb.result(binding))
@@ -43,5 +75,49 @@ module ChefSpec
     def root
       @root ||= Pathname.new(File.expand_path('../../', __FILE__))
     end
+
+    def get_chef_run(cookbook, recipe)
+      begin
+        return ChefSpec::Runner.new.converge("#{cookbook}::#{recipe}")
+      rescue
+        return nil
+      end
+    end
+
+    def get_resource_name(resource)
+      return resource.name || resource.identity
+    end
+
+    def get_resources(chef_run)
+      if chef_run
+        return chef_run.resource_collection.all_resources
+      else
+        return []
+      end
+    end
+
+    def generate_test_cases(resources)
+      test_cases = []
+      resources.each do |resource|
+        verbs = resource.action
+        if not verbs.respond_to?(:each)
+          verbs = [verbs]
+        end
+
+        noun = resource.resource_name
+        adjective = resource.name
+
+        verbs.each do |verb|
+          if not verb == :nothing
+            test_cases.push({
+              :it => "#{verb}s the #{adjective} #{noun}",
+              :action => "#{verb}_#{noun}",
+              :name => adjective
+            })
+          end
+        end
+      end
+      return test_cases
+    end
   end
 end

data/templates/default.erb

@@ -5,5 +5,9 @@ describe '<%= cookbook %>::<%= recipe %>' do
 
   it 'runs successfully' do
     expect{chef_run}.not_to raise_error
-  end
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec-bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,22 +11,6 @@ bindir: bin
 cert_chain: []
 date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: chef
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: chefspec
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement