chefspec 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feb37fa56e514030940a63b574f753750fd7e626
-  data.tar.gz: 46581585e0fcf5ab806dfe1dfc2f69d5f69fc3f3
+  metadata.gz: 83803766a872ecfb05eeea5ecf9f715ca7cfa0e1
+  data.tar.gz: 43ff5901db1916b48a225a6f5576502c12892002
 SHA512:
-  metadata.gz: 763646749b05eda88a493d55181a7ee2586298eeeb092ad33f222ff50ab7c6839351ab9d0c5da5254374b0a223c08cc07efc48565b063afd09bfd57d9b782930
-  data.tar.gz: 8034fd1aa4818e79f8cbc6e549a2d4d60dd0cbc734e1877bf0d3a19f2a690144594f0faa5ca64f3845cb9bce58817051139351ec624e18341b356268866732cd
+  metadata.gz: 0020a9532258bf130a8c7b1de8372f09f7b07d03b39f697372b0172b4ed596bee0bce3dfdef169e85fedd413d5f7199727bc6109e8f22c0de34ef4d037f7d1d1
+  data.tar.gz: 3ddb0c339391d19642ce896041fc2e9fa39545f6c2c4413f3bd530d93b16f81b878a604319321b642f4de89264811317eb62dda35f9bf5ea84e1900c3011ff94

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 CHANGELOG for ChefSpec
 ======================
 
+## 3.3.1 (March 11, 2014)
+Bugfixes:
+  - Various typographical fixes in the README
+  - Remove unused JSON report
+  - Restore coverage reporting for Berkshelf 2 users
+  - Minor formatting changes for errors
+
+Improvements:
+  - Remove dependency on i18n and use native ERB instead
+  - Vendor Berkshelf/Librarian in a "cookbooks" directory so we can shorten the pathname during coverage reporting
+
 ## 3.3.0 (March 9, 2014)
 Bugfixes:
   - Update documentation for setting `automatic` attributes

data/README.md

@@ -550,7 +550,7 @@ end
 
 Reporting
 ---------
-ChefSpec can generate a report of resources read over resources tested. Please note, this feature is currently in beta phases and may not be 100% accurate. That being said, it is currently the only code coverage tool available for Chef recipes.
+ChefSpec can generate a report of resources read over resources tested.
 
 To generate the coverage report, add the following to your `spec_helper.rb` before you require any "Chef" code:
 
@@ -564,7 +564,7 @@ ChefSpec::Coverage.start!
 By default, that method will output helpful information to standard out:
 
 ```text
-ChefSpec Coverage report generated at '.coverage/results.json':
+ChefSpec Coverage report generated...
 
   Total Resources:   6
   Touched Resources: 1
@@ -579,10 +579,6 @@ Untouched Resources:
   package[core]              bacon/recipes/default.rb:6
 ```
 
-It also outputs a machine-parsable JSON file at `.coverage/results.json`. This file can be read by your CI server to determine changes in code coverage. We recommend adding the `.coverage` directory to your `.gitignore` to avoid committing it to git.
-
-You can configure both the announcing behavior and JSON file. Please see the YARD documentation for more information.
-
 By default, ChefSpec will test all cookbooks that are loaded as part of the Chef Client run. If you have a cookbook with many dependencies, this may be less than desireable. To restrict coverage reporting against certain cookbooks, `ChefSpec::Coverage` yields a block:
 
 ```ruby
@@ -876,7 +872,7 @@ expect(chef_run).to include_recipe('bacon::default')
 Assert that the correct attribute is used:
 
 ```ruby
-expect(runner.node['bacon']['temperature']).to eq(150)
+expect(chef_run.node['bacon']['temperature']).to eq(150)
 ```
 
 **NOTE** If your roles live somewhere outside of the expected path, you must set `RSpec.config.role_path` to point to the directory containing your roles **before** invoking the `#converge` method!

data/chefspec.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'chef',    '~> 11.0'
   s.add_dependency 'fauxhai', '~> 2.0'
   s.add_dependency 'rspec',   '~> 2.14'
-  s.add_dependency 'i18n',    '>= 0.6.9', '< 1.0.0'
 
   # Development Dependencies
   s.add_development_dependency 'chef-zero', '~> 1.7'

data/lib/chefspec.rb

@@ -46,7 +46,3 @@ module ChefSpec
     @root ||= Pathname.new(File.expand_path('../../', __FILE__))
   end
 end
-
-require 'i18n'
-I18n.enforce_available_locales = false
-I18n.load_path << Dir[ChefSpec.root.join('locales', '*.yml').to_s]

data/lib/chefspec/berkshelf.rb

@@ -23,19 +23,23 @@ module ChefSpec
     def setup!
       berksfile = ::Berkshelf::Berksfile.from_file('Berksfile')
 
+      # Grab a handle to tmpdir, since Berkshelf 2 modifies it a bit
+      tmpdir = File.join(@tmpdir, 'cookbooks')
+
       ::Berkshelf.ui.mute do
         if ::Berkshelf::Berksfile.method_defined?(:vendor)
-          FileUtils.rm_rf(@tmpdir) # Berkshelf 3.0 requires the directory to not exist
-          berksfile.vendor(@tmpdir)
+          # Berkshelf 3.0 requires the directory to not exist
+          FileUtils.rm_rf(tmpdir)
+          berksfile.vendor(tmpdir)
         else
-          berksfile.install(path: @tmpdir)
+          berksfile.install(path: tmpdir)
         end
       end
 
       filter = Coverage::BerkshelfFilter.new(berksfile)
       Coverage.add_filter(filter)
 
-      ::RSpec.configure { |config| config.cookbook_path = @tmpdir }
+      ::RSpec.configure { |config| config.cookbook_path = tmpdir }
     end
 
     #

data/lib/chefspec/coverage.rb

@@ -34,9 +34,9 @@ module ChefSpec
     # Start the coverage reporting analysis. This method also adds the the
     # +at_exit+ handler for printing the coverage report.
     #
-    def start!(*args, &block)
+    def start!(&block)
       instance_eval(&block) if block
-      at_exit { ChefSpec::Coverage.report!(*args) }
+      at_exit { ChefSpec::Coverage.report! }
     end
 
     #
@@ -110,17 +110,7 @@ module ChefSpec
     #
     #   ChefSpec::Coverage.report!
     #
-    # @example Generating a custom report without announcing
-    #
-    #   ChefSpec::Coverage.report!('/custom/path', false)
-    #
-    #
-    # @param [String] output
-    #   the path to output the report on disk (default: '.coverage/results.json')
-    # @param [Boolean] announce
-    #   print the results to standard out
-    #
-    def report!(output = '.coverage/results.json', announce = true)
+    def report!
       # Borrowed from simplecov#41
       #
       # If an exception is thrown that isn't a "SystemExit", we need to capture
@@ -131,55 +121,19 @@ module ChefSpec
         exit_status = EXIT_SUCCESS
       end
 
-      report = {}
-
-      report[:total] = @collection.size
-
-      if report[:total] == 0
-        puts 'No resources found, skipping coverage calculation'
-        return
+      report = {}.tap do |h|
+        h[:total]     = @collection.size
+        h[:touched]   = @collection.count { |_, resource| resource.touched? }
+        h[:coverage]  = ((h[:touched]/h[:total].to_f)*100).round(2)
       end
 
-      report[:touched] = @collection.count { |_, resource| resource.touched? }
-      report[:untouched] = report[:total] - report[:touched]
-      report[:coverage] = ((report[:touched].to_f/report[:total].to_f)*100).round(2)
-
-      report[:detailed] = Hash[*@collection.map do |name, wrapper|
-        [name, wrapper.to_hash]
-      end.flatten]
-
-      output = File.expand_path(output)
-      FileUtils.mkdir_p(File.dirname(output))
-      File.open(File.join(output), 'w') do |f|
-        f.write(JSON.pretty_generate(report) + "\n")
-      end
+      report[:untouched_resources] = @collection.collect do |_, resource|
+        resource unless resource.touched?
+      end.compact
 
-      if announce
-        puts <<-EOH.gsub(/^ {10}/, '')
-
-          WARNING: ChefSpec Coverage reporting is in beta. Please use with caution.
-
-          ChefSpec Coverage report generated at '#{output}':
-
-            Total Resources:   #{report[:total]}
-            Touched Resources: #{report[:touched]}
-            Touch Coverage:    #{report[:coverage]}%
-
-          Untouched Resources:
-
-          #{
-            report[:detailed]
-              .select { |_, resource| !resource[:touched] }
-              .sort_by { |_, resource| [resource[:source][:file], resource[:source][:line]] }
-              .map do |name, resource|
-                "  #{name.ljust(32)} #{resource[:source][:file]}:#{resource[:source][:line]}"
-              end
-              .flatten
-              .join("\n")
-          }
-
-        EOH
-      end
+      template = ChefSpec.root.join('templates', 'coverage', 'human.erb')
+      erb = Erubis::Eruby.new(File.read(template))
+      puts erb.evaluate(report)
 
       # Ensure we exit correctly (#351)
       exit(exit_status)
@@ -206,21 +160,12 @@ module ChefSpec
         @resource.to_s
       end
 
-      def source
-        return {} unless @resource.source_line
-        file, line, *_ = @resource.source_line.split(':')
-
-        {
-          file: shortname(file),
-          line: line.to_i,
-        }
+      def source_file
+        @source_file ||= shortname(@resource.source_line.split(':').first)
       end
 
-      def to_hash
-        {
-          source: source,
-          touched: touched?,
-        }
+      def source_line
+        @source_line ||= @resource.source_line.split(':', 2).last.to_i
       end
 
       def touch!

data/lib/chefspec/coverage/filters.rb

@@ -6,7 +6,7 @@ module ChefSpec
       end
 
       def matches?
-
+        raise RuntimeError, "Must override Filter#matches?"
       end
     end
 
@@ -50,7 +50,17 @@ module ChefSpec
     class BerkshelfFilter < Filter
       def initialize(berksfile)
         @berksfile = berksfile
-        @metadatas = berksfile.dependencies.select(&:metadata?).map(&:name)
+
+        @metadatas = if berksfile.respond_to?(:dependencies)
+          berksfile.dependencies
+            .select(&:metadata?)
+            .map(&:name)
+        else
+          berksfile.sources.select(&:location)
+            .map(&:location)
+            .select(&:metadata?)
+            .map(&:name)
+        end
       end
 
       def matches?(resource)

data/lib/chefspec/errors.rb

@@ -3,9 +3,11 @@ module ChefSpec
     class ChefSpecError < StandardError
       def initialize(options = {})
         class_name = self.class.to_s.split('::').last
-        error_key  = options[:_error_key] || Util.underscore(class_name)
+        filename   = options.delete(:_template) || Util.underscore(class_name)
+        template   = ChefSpec.root.join('templates', 'errors', "#{filename}.erb")
 
-        super I18n.t("chefspec.errors.#{error_key}", options)
+        erb = Erubis::Eruby.new(File.read(template))
+        super erb.evaluate(options)
       end
     end
 
@@ -19,10 +21,10 @@ module ChefSpec
         signature = "#{type}(#{options[:args].map(&:inspect).join(', ')})"
 
         super({
-          type:       type,
-          signature:  signature,
-          stub:       stub,
-          _error_key: :not_stubbed,
+          type:      type,
+          signature: signature,
+          stub:      stub,
+          _template: :not_stubbed,
         }.merge(options))
       end
     end

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'
 end

data/spec/unit/errors_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module ChefSpec::Error
+  describe CommandNotStubbed do
+    let(:instance) { described_class.new(args: ['cat']) }
+
+    it 'raises an exception with the correct message' do
+      instance
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          Executing a real command is disabled. Unregistered command:
+
+              command("cat")
+
+          You can stub this command with:
+
+              stub_command("cat").and_return(...)
+        EOH
+      }
+    end
+  end
+
+  describe CookbookPathNotFound do
+    let(:instance) { described_class.new }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          I could not find or infer a cookbook_path from your current working directory.
+          Please make sure you put your specs (tests) under a directory named 'spec' or
+          manually set the cookbook path in the RSpec configuration.
+        EOH
+      }
+    end
+  end
+
+  describe GemLoadError do
+    let(:instance) { described_class.new(gem: 'bacon', name: 'bacon') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          I could not load the 'bacon' gem! You must have the gem installed
+          on your local system before you can use the bacon plugin.
+          You can install bacon by running:
+
+              gem install bacon
+
+          or add bacon to your Gemfile and run the `bundle` command to install.
+        EOH
+      }
+    end
+  end
+end

data/templates/coverage/human.erb

@@ -0,0 +1,22 @@
+
+<% if @total == 0 %>
+  No Chef resources found, skipping coverage calculation...
+<% else %>
+ChefSpec Coverage report generated...
+
+  Total Resources:   <%= @total %>
+  Touched Resources: <%= @touched %>
+  Touch Coverage:    <%= @coverage %>%
+
+<% if @untouched_resources.empty? %>
+You are awesome and so is your test coverage! Have a fantastic day!
+
+<% else %>
+Untouched Resources:
+
+<% @untouched_resources.each do |resource| %>
+  <%= resource.to_s.ljust(32) %>   <%= resource.source_file %>:<%= resource.source_line %>
+<% end %>
+
+<% end %>
+<% end %>

data/templates/errors/cookbook_path_not_found.erb

@@ -0,0 +1,3 @@
+I could not find or infer a cookbook_path from your current working directory.
+Please make sure you put your specs (tests) under a directory named 'spec' or
+manually set the cookbook path in the RSpec configuration.

data/templates/errors/gem_load_error.erb

@@ -0,0 +1,7 @@
+I could not load the '<%= @name %>' gem! You must have the gem installed
+on your local system before you can use the <%= @gem %> plugin.
+You can install <%= @gem %> by running:
+
+    gem install <%= @gem %>
+
+or add <%= @name %> to your Gemfile and run the `bundle` command to install.

data/templates/errors/not_stubbed.erb

@@ -0,0 +1,7 @@
+Executing a real <%= @type %> is disabled. Unregistered <%= @type %>:
+
+    <%= @signature %>
+
+You can stub this <%= @type %> with:
+
+    <%= @stub %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefspec
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Andrew Crump
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -53,26 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: chef-zero
   requirement: !ruby/object:Gem::Requirement
@@ -731,11 +711,11 @@ files:
 - lib/chefspec/stubs/stub.rb
 - lib/chefspec/util.rb
 - lib/chefspec/version.rb
-- locales/en.yml
 - spec/spec_helper.rb
 - spec/support/hash.rb
 - spec/unit/api_spec.rb
 - spec/unit/cacher_spec.rb
+- spec/unit/errors_spec.rb
 - spec/unit/expect_exception_spec.rb
 - spec/unit/extensions/lwrp_base_spec.rb
 - spec/unit/macros_spec.rb
@@ -758,6 +738,10 @@ files:
 - spec/unit/stubs/search_registry_spec.rb
 - spec/unit/stubs/search_stub_spec.rb
 - spec/unit/stubs/stub_spec.rb
+- templates/coverage/human.erb
+- templates/errors/cookbook_path_not_found.erb
+- templates/errors/gem_load_error.erb
+- templates/errors/not_stubbed.erb
 homepage: http://code.sethvargo.com/chefspec
 licenses:
 - MIT
@@ -858,6 +842,7 @@ test_files:
 - spec/support/hash.rb
 - spec/unit/api_spec.rb
 - spec/unit/cacher_spec.rb
+- spec/unit/errors_spec.rb
 - spec/unit/expect_exception_spec.rb
 - spec/unit/extensions/lwrp_base_spec.rb
 - spec/unit/macros_spec.rb

data/locales/en.yml

@@ -1,19 +0,0 @@
-en:
-  chefspec:
-    errors:
-      cookbook_path_not_found: >
-        I could not find or infer a `cookbook_path' from your current working
-        directory. Please make sure you put your specs (tests) under a directory
-        named `spec' or manually set the cookbook path in the RSpec
-        configuration.
-      gem_load_error: >
-        I could not load the %{name} gem! You must have %{name} installed on
-        your local system before you can use the `%{gem}' plugin. You can
-        install %{gem} by running `gem install %{gem}', or add %{name} to your
-        Gemfile and run the `bundle' command to install.
-      not_stubbed: |-
-        Executing a real %{type} is disabled. Unregistered %{type}: `%{signature}`"
-
-        You can stub this %{type} with:
-
-          %{stub}