chefspec-bootstrap 0.0.5 → 0.1.0

data/.rubocop.yml

@@ -1,9 +1,6 @@
 LineLength:
   Max: 120
 
-Style/Next:
-  Enabled: false
-
 Documentation:
   Enabled: false
 

data/README.md

@@ -9,18 +9,18 @@ chefspec-bootstrap
 [travis]: http://travis-ci.org/AMeng/chefspec-bootstrap
 [codeclimate]: https://codeclimate.com/github/AMeng/chefspec-bootstrap
 
-A command line tool to get started with ChefSpec. Generates spec files for your untested recipes.
+A command line tool to get started with [ChefSpec](https://github.com/sethvargo/chefspec). Generates spec files for your untested recipes.
 
 Given a cookbook called `my_cookbook` with a recipe called `my_recipe.rb`:
 ```ruby
-package "apache2"
+package 'apache2'
 
-file "/etc/apache2/sites-available/default" do
+file '/etc/apache2/sites-available/default' do
   action :delete
 end
 
-template "/etc/apache2/sites-available/mysite" do
-  source "mysite.conf.erb"
+template '/etc/apache2/sites-available/mysite' do
+  source 'mysite.conf.erb'
 end
 ```
 
@@ -31,16 +31,16 @@ require 'chefspec'
 describe 'my_cookbook::my_recipe' do
   let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
 
-  it "installs the apache2 package" do
-    expect(chef_run).to install_package("apache2")
+  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")
+  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")
+  it 'creates the /etc/apache2/sites-available/mysite template' do
+    expect(chef_run).to create_template('/etc/apache2/sites-available/mysite')
   end
 end
 ```
@@ -62,8 +62,9 @@ Options
 ```
 Usage: chefspec-bootstrap <recipe.rb> [options]
     -t, --template <file>            ERB template file used to generate specs
-    -s, --spechelper <file>          spec_helper.rb file. By default, looks in spec/spec_helper.rb
+    -s, --spec-helper <file>         spec_helper.rb file. By default, looks in spec/spec_helper.rb
     -o, --output <file>              File to output spec. Prints to stdout if not specified.
+    -c, --cookbook-path <dir>        Cookbook path (directory). Your spec_helper file can override this.
 ```
 
 Creating a custom template

data/chefspec-bootstrap.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'chefspec-bootstrap'
-  s.version     = '0.0.5'
-  s.date        = '2014-12-01'
+  s.version     = '0.1.0'
+  s.date        = '2014-12-23'
   s.summary     = 'Bootstrap your ChefSpec tests.'
   s.description = 'Automatically generate ChefSpec tests based on your recipes.'
   s.authors     = ['Alexander Meng']

data/lib/chefspec_bootstrap.rb

@@ -96,13 +96,8 @@ module ChefSpec
 
     def get_resources(chef_run, cookbook, recipe)
       if chef_run
-        resources = get_all_resources(chef_run)
-        if @recursive
-          return resources
-        else
-          return resources.select do |resource|
-            resource.cookbook_name == cookbook.to_sym && resource.recipe_name == recipe
-          end
+        return get_all_resources(chef_run).select do |resource|
+          resource.cookbook_name == cookbook.to_sym && resource.recipe_name == recipe
         end
       else
         return []
@@ -112,19 +107,29 @@ module ChefSpec
     def generate_test_cases(resources)
       test_cases = []
       resources.each do |resource|
-        verbs = resource.action
-        verbs = [verbs] unless verbs.respond_to?(:each)
+        verbs = resource.instance_variable_get(:@performed_actions)
+        if verbs.empty?
+          if resource.action != [:nothing]
+            verbs = { resource.action.to_s => {} }
+          else
+            verbs = { nothing: {} }
+          end
+        end
 
         noun = resource.resource_name
         adjective = resource.name
+        guarded = resource.performed_actions.empty?
 
-        verbs.each do |verb|
-          next if verb == :nothing
-
+        verbs.each do |verb, time|
           test_cases.push(
             it: get_it_block(noun, verb, adjective),
             expect: get_expect_block(noun, verb),
-            name: adjective
+            name: adjective,
+            guarded: guarded,
+            nothing: verb == :nothing,
+            noun: noun,
+            adjective: adjective,
+            compile_time: time[:compile_time]
           )
         end
       end
@@ -132,6 +137,7 @@ module ChefSpec
     end
 
     def get_it_block(noun, verb, adjective)
+      verb = 'ignore' if verb == :nothing
       it = '%{verb}s the %{adjective} %{noun}'
       noun_readable = noun.to_s.gsub('_', ' ')
       verb_readable = verb.to_s.gsub('_', ' ')

data/spec/chefspec_bootstrap_spec.rb

@@ -2,12 +2,16 @@ require_relative '../lib/chefspec_bootstrap'
 require_relative 'spec_helper'
 
 describe 'Bootstrap' do
-  %w(failure directory package).each do |resource|
-    it "creates the expected spec file for #{resource}" do
-      bootstrap = ChefSpec::Bootstrap.new("spec/cookbooks/spec/recipes/#{resource}.rb", nil, nil, nil, nil)
-      template = File.open("spec/templates/#{resource}.txt", 'rb').read
+  recipes = Dir.entries('spec/cookbooks/spec/recipes').map do |file|
+    file.scan(/(.*).rb/).last.first if file.end_with?('.rb')
+  end.compact
 
-      expect { bootstrap.generate }.to output(template).to_stdout
+  recipes.each do |recipe|
+    it "creates the expected spec file for #{recipe}" do
+      bootstrap = ChefSpec::Bootstrap.new("spec/cookbooks/spec/recipes/#{recipe}.rb", nil, nil, nil, nil)
+      spec = File.open("spec/meta/#{recipe}_spec.rb", 'rb').read
+
+      expect { bootstrap.generate }.to output(spec).to_stdout
     end
   end
 end

data/spec/cookbooks/spec/recipes/compile_time.rb

@@ -0,0 +1,3 @@
+package 'compileable' do
+  action :nothing
+end.run_action(:install)

data/spec/cookbooks/spec/recipes/guard.rb

@@ -0,0 +1,9 @@
+# rubocop:disable Lint/UselessComparison
+
+package 'guardable' do
+  not_if { 1 == 1 }
+end
+
+package 'unguardable' do
+  only_if { 1 == 1 }
+end

data/spec/cookbooks/spec/recipes/multiple_actions.rb

@@ -0,0 +1,7 @@
+package 'multiactionable' do
+  action [:install, :upgrade, :purge]
+end
+
+package 'mixactionable' do
+  action [:upgrade, :purge]
+end.run_action(:install)

data/spec/cookbooks/spec/recipes/nothing.rb

@@ -0,0 +1,7 @@
+# rubocop:disable Lint/UselessComparison
+
+package 'actionable'
+
+package 'unactionable' do
+  action :nothing
+end

data/spec/meta/compile_time_spec.rb

@@ -0,0 +1,10 @@
+require 'chefspec'
+require_relative '../spec_helper'
+
+describe 'spec::compile_time' do
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+
+  it 'installs the compileable package' do
+    expect(chef_run).to install_package('compileable').at_compile_time
+  end
+end

data/spec/meta/directory_spec.rb

@@ -0,0 +1,22 @@
+require 'chefspec'
+require_relative '../spec_helper'
+
+describe 'spec::directory' do
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+
+  it 'creates the defaultable directory' do
+    expect(chef_run).to create_directory('defaultable')
+  end
+
+  it 'creates the identifiable directory' do
+    expect(chef_run).to create_directory('identifiable')
+  end
+
+  it 'creates the creatable directory' do
+    expect(chef_run).to create_directory('creatable')
+  end
+
+  it 'deletes the deletable directory' do
+    expect(chef_run).to delete_directory('deletable')
+  end
+end

data/spec/{templates/failure.txt → meta/failure_spec.rb}

@@ -4,6 +4,6 @@ require_relative '../spec_helper'
 describe 'spec::failure' do
   let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
   it 'runs successfully' do
-    expect{chef_run}.not_to raise_error
+    expect { chef_run }.to raise_error
   end
 end

data/spec/meta/guard_spec.rb

@@ -0,0 +1,14 @@
+require 'chefspec'
+require_relative '../spec_helper'
+
+describe 'spec::guard' do
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+
+  it 'installs the guardable package' do
+    expect(chef_run).to_not install_package('guardable')
+  end
+
+  it 'installs the unguardable package' do
+    expect(chef_run).to install_package('unguardable')
+  end
+end

data/spec/meta/multiple_actions_spec.rb

@@ -0,0 +1,30 @@
+require 'chefspec'
+require_relative '../spec_helper'
+
+describe 'spec::multiple_actions' do
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+
+  it 'installs the multiactionable package' do
+    expect(chef_run).to install_package('multiactionable')
+  end
+
+  it 'upgrades the multiactionable package' do
+    expect(chef_run).to upgrade_package('multiactionable')
+  end
+
+  it 'purges the multiactionable package' do
+    expect(chef_run).to purge_package('multiactionable')
+  end
+
+  it 'installs the mixactionable package' do
+    expect(chef_run).to install_package('mixactionable').at_compile_time
+  end
+
+  it 'upgrades the mixactionable package' do
+    expect(chef_run).to upgrade_package('mixactionable')
+  end
+
+  it 'purges the mixactionable package' do
+    expect(chef_run).to purge_package('mixactionable')
+  end
+end

data/spec/meta/nothing_spec.rb

@@ -0,0 +1,14 @@
+require 'chefspec'
+require_relative '../spec_helper'
+
+describe 'spec::nothing' do
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+
+  it 'installs the actionable package' do
+    expect(chef_run).to install_package('actionable')
+  end
+
+  it 'ignores the unactionable package' do
+    expect(chef_run.package('unactionable')).to do_nothing
+  end
+end

data/spec/meta/package_spec.rb

@@ -0,0 +1,34 @@
+require 'chefspec'
+require_relative '../spec_helper'
+
+describe 'spec::package' do
+  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+
+  it 'installs the defaultable package' do
+    expect(chef_run).to install_package('defaultable')
+  end
+
+  it 'installs the identifiable package' do
+    expect(chef_run).to install_package('identifiable')
+  end
+
+  it 'installs the installable package' do
+    expect(chef_run).to install_package('installable')
+  end
+
+  it 'purges the purgeable package' do
+    expect(chef_run).to purge_package('purgeable')
+  end
+
+  it 'reconfigs the reconfigurable package' do
+    expect(chef_run).to reconfig_package('reconfigurable')
+  end
+
+  it 'removes the removeable package' do
+    expect(chef_run).to remove_package('removeable')
+  end
+
+  it 'upgrades the upgradable package' do
+    expect(chef_run).to upgrade_package('upgradable')
+  end
+end

data/templates/default.erb

@@ -4,10 +4,11 @@ require_relative '../spec_helper'<% end %>
 describe '<%= cookbook %>::<%= recipe %>' do
   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] %>")
+  it '<%= test_case[:it] %>' do<% if test_case[:nothing] %>
+    expect(chef_run.<%= test_case[:noun] %>('<%= test_case[:adjective] %>')).to do_nothing<% else %>
+    expect(chef_run).to<% if test_case[:guarded] %>_not<% end %> <%= test_case[:expect] %>('<%= test_case[:name] %>')<% if test_case[:compile_time] %>.at_compile_time<% end %><% end %>
   end<% end %><% else %>
   it 'runs successfully' do
-    expect{chef_run}.not_to raise_error
+    expect { chef_run }.to raise_error
   end<% end %>
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec-bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chefspec
@@ -94,13 +94,21 @@ files:
 - lib/api_map.rb
 - lib/chefspec_bootstrap.rb
 - spec/chefspec_bootstrap_spec.rb
+- spec/cookbooks/spec/recipes/compile_time.rb
 - spec/cookbooks/spec/recipes/directory.rb
 - spec/cookbooks/spec/recipes/failure.rb
+- spec/cookbooks/spec/recipes/guard.rb
+- spec/cookbooks/spec/recipes/multiple_actions.rb
+- spec/cookbooks/spec/recipes/nothing.rb
 - spec/cookbooks/spec/recipes/package.rb
+- spec/meta/compile_time_spec.rb
+- spec/meta/directory_spec.rb
+- spec/meta/failure_spec.rb
+- spec/meta/guard_spec.rb
+- spec/meta/multiple_actions_spec.rb
+- spec/meta/nothing_spec.rb
+- spec/meta/package_spec.rb
 - spec/spec_helper.rb
-- spec/templates/directory.txt
-- spec/templates/failure.txt
-- spec/templates/package.txt
 - templates/default.erb
 homepage: http://rubygems.org/gems/chefspec-bootstrap
 licenses:

data/spec/templates/directory.txt

@@ -1,22 +0,0 @@
-require 'chefspec'
-require_relative '../spec_helper'
-
-describe 'spec::directory' do
-  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
-
-  it "creates the defaultable directory" do
-    expect(chef_run).to create_directory("defaultable")
-  end
-
-  it "creates the identifiable directory" do
-    expect(chef_run).to create_directory("identifiable")
-  end
-
-  it "creates the creatable directory" do
-    expect(chef_run).to create_directory("creatable")
-  end
-
-  it "deletes the deletable directory" do
-    expect(chef_run).to delete_directory("deletable")
-  end
-end

data/spec/templates/package.txt

@@ -1,34 +0,0 @@
-require 'chefspec'
-require_relative '../spec_helper'
-
-describe 'spec::package' do
-  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
-
-  it "installs the defaultable package" do
-    expect(chef_run).to install_package("defaultable")
-  end
-
-  it "installs the identifiable package" do
-    expect(chef_run).to install_package("identifiable")
-  end
-
-  it "installs the installable package" do
-    expect(chef_run).to install_package("installable")
-  end
-
-  it "purges the purgeable package" do
-    expect(chef_run).to purge_package("purgeable")
-  end
-
-  it "reconfigs the reconfigurable package" do
-    expect(chef_run).to reconfig_package("reconfigurable")
-  end
-
-  it "removes the removeable package" do
-    expect(chef_run).to remove_package("removeable")
-  end
-
-  it "upgrades the upgradable package" do
-    expect(chef_run).to upgrade_package("upgradable")
-  end
-end