chefspec-bootstrap 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTA2YjJjMWJkYTNmNDU4OGNlOWFmMGVlNDBjMzdiYTRlMjk5OTRkMg==
+  data.tar.gz: !binary |-
+    Y2I2OTdlNmNkZDYzMTA4MThhMjY3M2U2OGNlOWVjZGRlZTBiZjExMA==
+SHA512:
+  metadata.gz: !binary |-
+    NDE1Y2NjYTljNjJlMTA4NjkzZGM2ODU4ZTNjNmFlMTZlMzMyZTFhZWJkNTU4
+    NzM2MDE0N2NiMTI1NGYwZTM0MWQwZDZjN2RhY2EyMGQxZTQ1NDA3YjE2OWI5
+    M2JkMjlhYjExZGQ4ZGVhM2VjNmU1MWE1OGEzNzIxZGE5MzE4N2U=
+  data.tar.gz: !binary |-
+    MTNkYzA3ZmY3MDQxYjk3NmMzZGI5NWJkYWVkZWIwYzI1OWRjMzgxNGQwYjk3
+    NzQxYmE2YWFmZjFkZDEyMTIwNDM3NDQyYzFiMDRkODA1MzZkOWU1N2I5Nzg2
+    ODQyY2FmNGVlNDMxYzcwODc3Zjc5MGNhMmI5MGFmZjc0OGM4NDM=

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,35 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-09 15:47:50 -0400 using RuboCop version 0.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/RescueException:
+  Enabled: false
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Style/ClassLength:
+  Max: 134
+
+# Offense count: 2
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/Next:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rubocop'
+

data/README.md

@@ -3,7 +3,7 @@ chefspec-bootstrap
 
 A command line tool to get started with ChefSpec. Generates spec files for your untested recipes.
 
-Given a cookbook called `cookbook` with a recipe called `recipe.rb`:
+Given a cookbook called `my_cookbook` with a recipe called `my_recipe.rb`:
 ```ruby
 package "apache2"
 
@@ -16,11 +16,11 @@ template "/etc/apache2/sites-available/mysite" do
 end
 ```
 
-The command line tool will generate the following spec file at `spec/cookbook/recipe_spec.rb`:
+The command line tool will generate output the following to stdout:
 ```ruby
 require 'chefspec'
 
-describe 'cookbook::recipe' do
+describe 'my_cookbook::my_recipe' do
   let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
 
   it "installs the apache2 package" do
@@ -47,15 +47,14 @@ gem install chefspec-bootstrap
 
 Run the command-line tool
 ```
-chefspec-bootstrap
+chefspec-bootstrap my_cookbook/recipes/my_recipe.rb
 ```
 
 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
+Usage: chefspec-bootstrap <recipe.rb> [options]
+    -t, --template TEMPLATEFILE      ERB template file used to generate specs
 ```
 
 Creating a custom template

data/bin/chefspec-bootstrap

@@ -1,23 +1,36 @@
 #!/usr/bin/env ruby
 
+require 'rspec/expectations'
 require 'chefspec-bootstrap'
-require 'trollop'
+require 'optparse'
 
-cookbook_path_help_text = "RSpec config for cookbook path. Defaults to RSpec.configure.cookbook_path from spec_helper.rb."
+options = {:template => nil}
 
-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
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: chefspec-bootstrap <recipe.rb> [options]"
+
+  opts.on('-t', '--template <file>', "ERB template file used to generate specs") do |t|
+    options[:template] = t
+  end
+
+  opts.on('-s', '--spechelper <file>', "spec_helper.rb file. By default, looks in spec/spec_helper.rb") do |s|
+    options[:spec_helper] = s
+  end
+
+  opts.on('-o', '--output <file>', "File to output spec. Prints to stdout if not specified.") do |o|
+    options[:output_file] = o
+  end
 end
 
+abort "Recipe not specified!" if ARGV.empty?
+
+optparse.parse!
+
+recipe = ARGV[0]
 bootstrap = ChefSpec::Bootstrap.new(
-  opts[:cookbooks_dir],
-  opts[:cookbooks_path],
-  opts[:spec_dir],
-  opts[:template],
-  opts[:recursive]
+  recipe,
+  options[:template],
+  options[:spec_helper],
+  options[:output_file]
 )
-bootstrap.generate()
+bootstrap.generate

data/chefspec-bootstrap.gemspec

@@ -1,17 +1,16 @@
 Gem::Specification.new do |s|
   s.name        = 'chefspec-bootstrap'
-  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."
-  s.authors     = ["Alexander Meng"]
+  s.version     = '0.0.4'
+  s.date        = '2014-12-01'
+  s.summary     = 'Bootstrap your ChefSpec tests.'
+  s.description = 'Automatically generate ChefSpec tests based on your recipes.'
+  s.authors     = ['Alexander Meng']
   s.email       = 'alexbmeng@gmail.com'
-  s.files       = `git ls-files`.split($/)
+  s.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.homepage    = 'http://rubygems.org/gems/chefspec-bootstrap'
   s.license     = 'Apache'
-  s.executables   = ["chefspec-bootstrap"]
+  s.executables   = ['chefspec-bootstrap']
   s.required_ruby_version = '>= 1.9'
 
   s.add_dependency 'chefspec', '~> 3.4.0'
-  s.add_dependency 'trollop', '~> 2.0.0'
 end

data/lib/api_map.rb

@@ -1,82 +1,81 @@
 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"
+    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 }
+        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}" }
+        deploy: {
+          it: { force_deploy: 'force deploys the %{adjective} %{noun}' }
         },
-        :env => {
-          :it => { :modify => IT_MODIFY }
+        env: {
+          it: { modify: IT_MODIFY }
         },
-        :execute => {
-          :it => { :run => "executes %{adjective}" }
+        execute: {
+          it: { run: 'executes %{adjective}' }
         },
-        :file => {
-          :it => {
-            :create_if_missing => IT_CREATE_IF_MISSING,
-            :touch => IT_TOUCH
+        file: {
+          it: {
+            create_if_missing: IT_CREATE_IF_MISSING,
+            touch: IT_TOUCH
           },
-          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+          expect: { create_if_missing: EXPECT_CREATE_IF_MISSING }
         },
-        :git => {
-          :it => {
-            :default => "%{verb}s the %{adjective} git repository",
-            :checkout => "checks out the %{adjective} git repository"
+        git: {
+          it: {
+            default: '%{verb}s the %{adjective} git repository',
+            checkout: 'checks out the %{adjective} git repository'
           }
         },
-        :group => {
-          :it => { :modify => IT_MODIFY }
+        group: {
+          it: { modify: IT_MODIFY }
         },
-        :http_request => {
-          :it => {
-            :default => "performs a %{verb} HTTP request to %{adjective}"
+        http_request: {
+          it: {
+            default: 'performs a %{verb} HTTP request to %{adjective}'
           }
         },
-        :ifconfig => {
-          :it => {
-            :default => "%{verb}s the %{adjective} network interface using %{noun}"
+        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"
+        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 }
+          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_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
+        remote_file: {
+          it: {
+            create_if_missing: IT_CREATE_IF_MISSING,
+            touch: IT_TOUCH
           },
-          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+          expect: { create_if_missing: EXPECT_CREATE_IF_MISSING }
         },
-        :subversion => {
-          :it => {
-            :default => "%{verb}s the %{adjective} svn repository",
-            :checkout => "checks out the %{adjective} svn repository"
+        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
+        template: {
+          it: {
+            create_if_missing: IT_CREATE_IF_MISSING,
+            touch: IT_TOUCH
           },
-          :expect => { :create_if_missing => EXPECT_CREATE_IF_MISSING }
+          expect: { create_if_missing: EXPECT_CREATE_IF_MISSING }
         }
       }
     end

data/lib/chefspec-bootstrap.rb

@@ -6,76 +6,65 @@ require_relative 'api_map'
 
 module ChefSpec
   class Bootstrap
-
-    def initialize(cookbooks_dir, cookbooks_path, spec_dir, template_file, recursive)
-      @cookbooks_dir = cookbooks_dir
-      @cookbooks_path = cookbooks_path
-      @spec_dir = spec_dir
+    def initialize(recipe, template_file, spec_helper_file, output_file)
       @template_file = template_file
-      @recursive = recursive
+      @recipe = recipe
+      @spec_helper_file = spec_helper_file || 'spec/spec_helper.rb'
+      @output_file = output_file
     end
 
     def setup
-      if not Dir.exist?(@cookbooks_dir)
-        abort "Unable to locate your cookbooks directory (#{@cookbooks_dir})"
+      unless File.exist?(@recipe)
+        abort "Unable to locate recipe file (#{@recipe})"
       end
 
-      if not @template_file
+      unless @template_file
         @template_file = root.join('templates', 'default.erb')
       end
 
-      if not File.exist?(@template_file)
+      unless 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")
+        require File.expand_path(@spec_helper_file)
         @spec_helper = true
       rescue LoadError
         @spec_helper = false
         ::RSpec.configure do |config|
-          config.cookbook_path = @cookbooks_path || [@cookbooks_dir, 'cookbooks']
+          config.cookbook_path = ['cookbooks']
         end
       end
     end
 
     def generate
-      setup()
-
-      erb = ERB.new(File.read(@template_file))
+      setup
 
-      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]
+      abort 'Output file already exists. Refusing to override.' if @output_file and File.exist?(@output_file)
 
-        filename = "#{@spec_dir}/#{cookbook}/#{recipe}_spec.rb"
-
-        puts filename
+      erb = ERB.new(File.read(@template_file))
 
-        if File.exist?(filename)
-          puts "    spec already exists. Skipping."
-        else
-          FileUtils.mkdir_p "#{@spec_dir}/#{cookbook}"
+      path, recipe_file = File.split(@recipe)
+      recipe = recipe_file.split('.')[0]
+      cookbook = path.split(File::SEPARATOR)[1]
+      chef_run = get_chef_run(cookbook, recipe)
 
-          puts "    executing recipe with ChefSpec..."
-          chef_run = get_chef_run(cookbook, recipe)
+      puts 'Chefspec execution failed. Generating generic spec.' unless chef_run
 
-          if chef_run
-            puts "    execution suceeded. Creating spec file."
-          else
-            puts "    execution failed. Creating empty spec file."
-          end
+      resources = get_resources(chef_run, cookbook, recipe)
+      test_cases = generate_test_cases(resources)
+      spec_helper = @spec_helper
 
-          resources = get_resources(chef_run, cookbook, recipe)
-          test_cases = generate_test_cases(resources)
+      spec_output = erb.result(binding)
 
-          File.open(filename, "w") do |spec_file|
-            spec_file.write(erb.result(binding))
-          end
+      if @output_file
+        File.open(@output_file, 'w') do |spec_file|
+          spec_file.write(spec_output)
         end
+      else
+        puts spec_output
       end
     end
 
@@ -84,19 +73,17 @@ module ChefSpec
     end
 
     def get_chef_run(cookbook, recipe)
-      begin
-        return ChefSpec::Runner.new.converge("#{cookbook}::#{recipe}")
-      rescue Exception => e
-        return nil
-      end
+      return ChefSpec::Runner.new.converge("#{cookbook}::#{recipe}")
+    rescue Exception => e
+      return nil
     end
 
     def get_resource_name(resource)
-      return resource.name || resource.identity
+      resource.name || resource.identity
     end
 
     def get_all_resources(chef_run)
-      return chef_run.resource_collection.all_resources
+      chef_run.resource_collection.all_resources
     end
 
     def get_resources(chef_run, cookbook, recipe)
@@ -106,7 +93,7 @@ module ChefSpec
           return resources
         else
           return resources.select do |resource|
-            resource.cookbook_name == cookbook.to_sym and resource.recipe_name == recipe
+            resource.cookbook_name == cookbook.to_sym && resource.recipe_name == recipe
           end
         end
       else
@@ -118,7 +105,7 @@ module ChefSpec
       test_cases = []
       resources.each do |resource|
         verbs = resource.action
-        if not verbs.respond_to?(:each)
+        unless verbs.respond_to?(:each)
           verbs = [verbs]
         end
 
@@ -126,25 +113,25 @@ module ChefSpec
         adjective = resource.name
 
         verbs.each do |verb|
-          if not verb == :nothing
-            test_cases.push({
-              :it => get_it_block(noun, verb, adjective),
-              :expect => get_expect_block(noun, verb),
-              :name => adjective
-            })
+          unless verb == :nothing
+            test_cases.push(
+              it: get_it_block(noun, verb, adjective),
+              expect: get_expect_block(noun, verb),
+              name: adjective
+            )
           end
         end
       end
-      return test_cases
+      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}
+      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] && @api_map[noun][:it]
         if @api_map[noun][:it][verb]
           it = @api_map[noun][:it][verb]
         elsif @api_map[noun][:it][:default]
@@ -152,14 +139,14 @@ module ChefSpec
         end
       end
 
-      return escape_string(it  % string_variables)
+      escape_string(it  % string_variables)
     end
 
     def get_expect_block(noun, verb)
-      expect = "%{verb}_%{noun}"
-      string_variables = {:noun => noun, :verb => verb}
+      expect = '%{verb}_%{noun}'
+      string_variables = { noun: noun, verb: verb }
 
-      if @api_map[noun] and @api_map[noun][:expect]
+      if @api_map[noun] && @api_map[noun][:expect]
         if @api_map[noun][:expect][verb]
           expect = @api_map[noun][:expect][verb]
         elsif @api_map[noun][:expect][:default]
@@ -167,12 +154,11 @@ module ChefSpec
         end
       end
 
-      return escape_string(expect % string_variables)
+      escape_string(expect % string_variables)
     end
 
     def escape_string(string)
-      return string.gsub("\\","\\\\").gsub("\"", "\\\"")
+      string.gsub('\\', '\\\\').gsub("\"", "\\\"")
     end
-
   end
 end

data/templates/default.erb

@@ -1,4 +1,5 @@
-require 'chefspec'
+require 'chefspec'<% if spec_helper %>
+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| %>

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: chefspec-bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Alexander Meng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chefspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,27 +20,10 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.4.0
-- !ruby/object:Gem::Dependency
-  name: trollop
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 description: Automatically generate ChefSpec tests based on your recipes.
 email: alexbmeng@gmail.com
 executables:
@@ -51,6 +32,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
+- Gemfile
 - LICENSE
 - README.md
 - bin/chefspec-bootstrap
@@ -61,26 +45,25 @@ files:
 homepage: http://rubygems.org/gems/chefspec-bootstrap
 licenses:
 - Apache
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Bootstrap your ChefSpec tests.
 test_files: []