chefspec-bootstrap 0.0.4 → 0.0.5

data/.gitignore

@@ -1,34 +1,9 @@
+Gemfile.lock
 *.gem
 *.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
 /spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
 /.bundle/
 /lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.ruby-version
+.ruby-gemset
 .rvmrc

data/.rubocop.yml

@@ -1,13 +1,25 @@
-Encoding:
-  Enabled: false
-
 LineLength:
   Max: 120
 
+Style/Next:
+  Enabled: false
+
 Documentation:
   Enabled: false
 
 MethodLength:
   Enabled: false
 
-inherit_from: .rubocop_todo.yml
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 150
+
+Style/FileName:
+  Exclude:
+    - bin/chefspec-bootstrap
+
+Lint/UselessAssignment:
+  Exclude:
+    - lib/chefspec_bootstrap.rb

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+
+addons:
+  code_climate:
+    repo_token: 05908e3abbf8623c35e780470ccc7883031c7dc06b993cf916f0cb898f49a164

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
-gem 'rubocop'
 
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -1,6 +1,14 @@
 chefspec-bootstrap
 ==================
 
+[![Gem Version](http://img.shields.io/gem/v/chefspec-bootstrap.svg)][gem]
+[![Build Status](http://img.shields.io/travis/AMeng/chefspec-bootstrap.svg)][travis]
+[![Code Climate](http://img.shields.io/codeclimate/github/AMeng/chefspec-bootstrap.svg)][codeclimate]
+
+[gem]: https://rubygems.org/gems/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.
 
 Given a cookbook called `my_cookbook` with a recipe called `my_recipe.rb`:
@@ -16,7 +24,7 @@ template "/etc/apache2/sites-available/mysite" do
 end
 ```
 
-The command line tool will generate output the following to stdout:
+The command line tool will output the following to stdout:
 ```ruby
 require 'chefspec'
 
@@ -37,7 +45,6 @@ describe 'my_cookbook::my_recipe' do
 end
 ```
 
-
 Getting Started
 ---
 Install the gem
@@ -45,7 +52,7 @@ Install the gem
 gem install chefspec-bootstrap
 ```
 
-Run the command-line tool
+Run the command-line tool, pointing to a recipe:
 ```
 chefspec-bootstrap my_cookbook/recipes/my_recipe.rb
 ```
@@ -54,9 +61,15 @@ Options
 ---
 ```
 Usage: chefspec-bootstrap <recipe.rb> [options]
-    -t, --template TEMPLATEFILE      ERB template file used to generate specs
+    -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
+    -o, --output <file>              File to output spec. Prints to stdout if not specified.
 ```
 
 Creating a custom template
 ---
 A custom erb template can be passsed using the `-t` flag. See the included default template for an example.
+
+What this project is NOT:
+---
+This is not a replacement for writing ChefSpec tests. Rather, this is a way to get started when you have an entirely untested recipe.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/bin/chefspec-bootstrap

@@ -1,28 +1,31 @@
 #!/usr/bin/env ruby
 
-require 'rspec/expectations'
-require 'chefspec-bootstrap'
+require_relative '../lib/chefspec_bootstrap'
 require 'optparse'
 
-options = {:template => nil}
+options = { template: nil }
 
 optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: chefspec-bootstrap <recipe.rb> [options]"
+  opts.banner = 'Usage: chefspec-bootstrap <recipe.rb> [options]'
 
-  opts.on('-t', '--template <file>', "ERB template file used to generate specs") do |t|
+  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|
+  opts.on('-s', '--spec-helper <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|
+  opts.on('-o', '--output <file>', 'File to output spec. Prints to stdout if not specified.') do |o|
     options[:output_file] = o
   end
+
+  opts.on('-c', '--cookbook-path <dir>', 'Cookbook path (directory). Your spec_helper file can override this.') do |c|
+    options[:cookbook_path] = c
+  end
 end
 
-abort "Recipe not specified!" if ARGV.empty?
+abort 'Recipe not specified!' if ARGV.empty?
 
 optparse.parse!
 
@@ -31,6 +34,7 @@ bootstrap = ChefSpec::Bootstrap.new(
   recipe,
   options[:template],
   options[:spec_helper],
-  options[:output_file]
+  options[:output_file],
+  options[:cookbook_path]
 )
 bootstrap.generate

data/chefspec-bootstrap.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'chefspec-bootstrap'
-  s.version     = '0.0.4'
+  s.version     = '0.0.5'
   s.date        = '2014-12-01'
   s.summary     = 'Bootstrap your ChefSpec tests.'
   s.description = 'Automatically generate ChefSpec tests based on your recipes.'
@@ -9,8 +9,12 @@ Gem::Specification.new do |s|
   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 'chefspec', '~> 4.0.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop'
 end

data/lib/{chefspec-bootstrap.rb → chefspec_bootstrap.rb}

@@ -6,11 +6,12 @@ require_relative 'api_map'
 
 module ChefSpec
   class Bootstrap
-    def initialize(recipe, template_file, spec_helper_file, output_file)
+    def initialize(recipe, template_file, spec_helper_file, output_file, cookbook_path)
       @template_file = template_file
       @recipe = recipe
       @spec_helper_file = spec_helper_file || 'spec/spec_helper.rb'
       @output_file = output_file
+      @cookbook_path = cookbook_path || 'cookbooks'
     end
 
     def setup
@@ -34,7 +35,7 @@ module ChefSpec
       rescue LoadError
         @spec_helper = false
         ::RSpec.configure do |config|
-          config.cookbook_path = ['cookbooks']
+          config.cookbook_path = [@cookbook_path]
         end
       end
     end
@@ -42,17 +43,15 @@ module ChefSpec
     def generate
       setup
 
-      abort 'Output file already exists. Refusing to override.' if @output_file and File.exist?(@output_file)
+      abort 'Output file already exists. Refusing to override.' if @output_file && File.exist?(@output_file)
 
       erb = ERB.new(File.read(@template_file))
 
       path, recipe_file = File.split(@recipe)
       recipe = recipe_file.split('.')[0]
-      cookbook = path.split(File::SEPARATOR)[1]
+      cookbook = path.split(File::SEPARATOR)[-2]
       chef_run = get_chef_run(cookbook, recipe)
 
-      puts 'Chefspec execution failed. Generating generic spec.' unless chef_run
-
       resources = get_resources(chef_run, cookbook, recipe)
       test_cases = generate_test_cases(resources)
       spec_helper = @spec_helper
@@ -60,9 +59,7 @@ module ChefSpec
       spec_output = erb.result(binding)
 
       if @output_file
-        File.open(@output_file, 'w') do |spec_file|
-          spec_file.write(spec_output)
-        end
+        generate_spec_file(spec_output)
       else
         puts spec_output
       end
@@ -72,9 +69,20 @@ module ChefSpec
       @root ||= Pathname.new(File.expand_path('../../', __FILE__))
     end
 
+    def generate_spec_file(output)
+      output_path = @output_file.split(File::SEPARATOR)
+      output_path.pop
+
+      FileUtils.mkpath(output_path.join(File::SEPARATOR)) if output_path
+
+      File.open(@output_file, 'w') do |spec_file|
+        spec_file.write(output)
+      end
+    end
+
     def get_chef_run(cookbook, recipe)
       return ChefSpec::Runner.new.converge("#{cookbook}::#{recipe}")
-    rescue Exception => e
+    rescue StandardError
       return nil
     end
 
@@ -105,21 +113,19 @@ module ChefSpec
       test_cases = []
       resources.each do |resource|
         verbs = resource.action
-        unless verbs.respond_to?(:each)
-          verbs = [verbs]
-        end
+        verbs = [verbs] unless verbs.respond_to?(:each)
 
         noun = resource.resource_name
         adjective = resource.name
 
         verbs.each do |verb|
-          unless verb == :nothing
-            test_cases.push(
-              it: get_it_block(noun, verb, adjective),
-              expect: get_expect_block(noun, verb),
-              name: adjective
-            )
-          end
+          next if verb == :nothing
+
+          test_cases.push(
+            it: get_it_block(noun, verb, adjective),
+            expect: get_expect_block(noun, verb),
+            name: adjective
+          )
         end
       end
       test_cases

data/spec/chefspec_bootstrap_spec.rb

@@ -0,0 +1,13 @@
+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
+
+      expect { bootstrap.generate }.to output(template).to_stdout
+    end
+  end
+end

data/spec/cookbooks/spec/recipes/directory.rb

@@ -0,0 +1,13 @@
+directory 'defaultable'
+
+directory 'identifiable' do
+  path 'nameable'
+end
+
+directory 'creatable' do
+  action :create
+end
+
+directory 'deletable' do
+  action :delete
+end

data/spec/cookbooks/spec/recipes/failure.rb

@@ -0,0 +1 @@
+failure

data/spec/cookbooks/spec/recipes/package.rb

@@ -0,0 +1,25 @@
+package 'defaultable'
+
+package 'identifiable' do
+  package_name 'nameable'
+end
+
+package 'installable' do
+  action :install
+end
+
+package 'purgeable' do
+  action :purge
+end
+
+package 'reconfigurable' do
+  action :reconfig
+end
+
+package 'removeable' do
+  action :remove
+end
+
+package 'upgradable' do
+  action :upgrade
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+RSpec.configure do |config|
+  config.cookbook_path = ['spec/cookbooks']
+  config.raise_errors_for_deprecations!
+end

data/spec/templates/directory.txt

@@ -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

@@ -0,0 +1,9 @@
+require 'chefspec'
+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
+  end
+end

data/spec/templates/package.txt

@@ -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

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: chefspec-bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
+  prerelease: 
 platform: ruby
 authors:
 - Alexander Meng
@@ -13,17 +14,67 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: chefspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automatically generate ChefSpec tests based on your recipes.
 email: alexbmeng@gmail.com
 executables:
@@ -33,37 +84,48 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rubocop.yml
-- .rubocop_todo.yml
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/chefspec-bootstrap
 - chefspec-bootstrap.gemspec
 - lib/api_map.rb
-- lib/chefspec-bootstrap.rb
+- lib/chefspec_bootstrap.rb
+- spec/chefspec_bootstrap_spec.rb
+- spec/cookbooks/spec/recipes/directory.rb
+- spec/cookbooks/spec/recipes/failure.rb
+- spec/cookbooks/spec/recipes/package.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:
 - 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: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Bootstrap your ChefSpec tests.
 test_files: []
+has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!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_todo.yml

@@ -1,35 +0,0 @@
-# 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