berkshelf 2.0.3 → 2.0.4

data/lib/berkshelf/errors.rb

@@ -123,7 +123,9 @@ module Berkshelf
   class BerksfileReadError < BerkshelfError
     # @param [#status_code] original_error
     def initialize(original_error)
-      @original_error = original_error
+      @original_error  = original_error
+      @error_message   = original_error.to_s
+      @error_backtrace = original_error.backtrace
     end
 
     status_code(113)
@@ -132,11 +134,16 @@ module Berkshelf
       @original_error.respond_to?(:status_code) ? @original_error.status_code : 113
     end
 
+    alias_method :original_backtrace, :backtrace
+    def backtrace
+      Array(@error_backtrace) + Array(original_backtrace)
+    end
+
     def to_s
       [
         "An error occurred while reading the Berksfile:",
         "",
-        "  " +  @original_error.to_s.split("\n").map(&:strip).join("\n  "),
+        "  #{@error_message}",
       ].join("\n")
     end
   end

data/lib/berkshelf/formatters/human_readable.rb

@@ -18,9 +18,16 @@ module Berkshelf
       #
       # @param [String] cookbook
       # @param [String] version
-      # @param [String] path
-      def use(cookbook, version, path = nil)
-        Berkshelf.ui.info "Using #{cookbook} (#{version})#{' at '+path if path}"
+      # @param [~Location] location
+      def use(cookbook, version, location = nil)
+        message = "Using #{cookbook} (#{version})"
+
+        if location && location.is_a?(PathLocation)
+          message << ' from metadata' if location.metadata?
+          message << " at '#{location.relative_path}'" unless location.relative_path == '.'
+        end
+
+        Berkshelf.ui.info message
       end
 
       # Output a Cookbook upload message using {Berkshelf.ui}

data/lib/berkshelf/formatters/json.rb

@@ -41,11 +41,15 @@ module Berkshelf
       #
       # @param [String] cookbook
       # @param [String] version
-      # @param [String] path
-      def use(cookbook, version, path = nil)
+      # @param [~Location] location
+      def use(cookbook, version, location = nil)
         cookbooks[cookbook] ||= {}
         cookbooks[cookbook][:version] = version
-        cookbooks[cookbook][:location] = path if path
+
+        if location && location.is_a?(PathLocation)
+          cookbooks[cookbook][:metadata] = true if location.metadata?
+          cookbooks[cookbook][:location] = location.relative_path
+        end
       end
 
       # Add a Cookbook upload entry to delayed output

data/lib/berkshelf/git.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'buff/shell_out'
 
 module Berkshelf
   class Git
@@ -9,7 +10,7 @@ module Berkshelf
     HAS_SPACE_RE = %r{\s}.freeze
 
     class << self
-      include Ridley::Mixin::ShellOut
+      include Buff::ShellOut
 
       # @overload git(commands)
       #   Shellout to the Git executable on your system with the given commands.

data/lib/berkshelf/init_generator.rb

@@ -1,4 +1,6 @@
-require 'kitchen/generator/init'
+begin
+  require 'kitchen/generator/init'
+rescue LoadError; end
 
 module Berkshelf
   class InitGenerator < BaseGenerator
@@ -49,10 +51,12 @@ module Berkshelf
     class_option :cookbook_name,
       type: :string
 
-    class_option :skip_test_kitchen,
-      type: :boolean,
-      default: false,
-      desc: 'Skip adding a testing environment to your cookbook'
+    if defined?(Kitchen::Generator::Init)
+      class_option :skip_test_kitchen,
+        type: :boolean,
+        default: false,
+        desc: 'Skip adding a testing environment to your cookbook'
+    end
 
     def generate
       validate_configuration
@@ -89,13 +93,15 @@ module Berkshelf
         template 'Gemfile.erb', target.join('Gemfile')
       end
 
-      unless options[:skip_test_kitchen]
-        # Temporarily use Dir.chdir to ensure the destionation_root of test kitchen's generator
-        # is where we expect until this bug can be addressed:
-        # https://github.com/opscode/test-kitchen/pull/140
-        Dir.chdir target do
-          # Kitchen::Generator::Init.new([], {}, destination_root: target).invoke_all
-          Kitchen::Generator::Init.new([], {}).invoke_all
+      if defined?(Kitchen::Generator::Init)
+        unless options[:skip_test_kitchen]
+          # Temporarily use Dir.chdir to ensure the destionation_root of test kitchen's generator
+          # is where we expect until this bug can be addressed:
+          # https://github.com/opscode/test-kitchen/pull/140
+          Dir.chdir target do
+            # Kitchen::Generator::Init.new([], {}, destination_root: target).invoke_all
+            Kitchen::Generator::Init.new([], {}).invoke_all
+          end
         end
       end
 

data/lib/berkshelf/location.rb

@@ -134,11 +134,6 @@ module Berkshelf
       raise AbstractFunction
     end
 
-    # @return [Boolean]
-    def downloaded?
-      @downloaded_status
-    end
-
     # Ensure the retrieved CachedCookbook is valid
     #
     # @param [CachedCookbook] cached_cookbook
@@ -170,15 +165,10 @@ module Berkshelf
     def to_json(options = {})
       JSON.pretty_generate(to_hash, options)
     end
-
-    private
-
-      def set_downloaded_status(state)
-        @downloaded_status = state
-      end
   end
 end
 
-Dir["#{File.dirname(__FILE__)}/locations/*.rb"].sort.each do |path|
-  require_relative "locations/#{File.basename(path, '.rb')}"
-end
+require_relative 'locations/chef_api_location'
+require_relative 'locations/git_location'
+require_relative 'locations/github_location'
+require_relative 'locations/site_location'

data/lib/berkshelf/locations/chef_api_location.rb

@@ -156,7 +156,6 @@ module Berkshelf
       cached = CachedCookbook.from_store_path(berks_path)
       validate_cached(cached)
 
-      set_downloaded_status(true)
       cached
     end
 

data/lib/berkshelf/locations/git_location.rb

@@ -54,7 +54,7 @@ module Berkshelf
     # @return [Berkshelf::CachedCookbook]
     def download(destination)
       if cached?(destination)
-        @ref = Berkshelf::Git.rev_parse(revision_path(destination))
+        @ref ||= Berkshelf::Git.rev_parse(revision_path(destination))
         return local_revision(destination)
       end
 
@@ -77,7 +77,6 @@ module Berkshelf
       cached = CachedCookbook.from_store_path(cb_path)
       validate_cached(cached)
 
-      set_downloaded_status(true)
       cached
     end
 

data/lib/berkshelf/locations/path_location.rb

@@ -22,6 +22,7 @@ module Berkshelf
     include Location
 
     set_location_key :path
+    set_valid_options :path, :metadata
 
     attr_accessor :path
     attr_reader :name
@@ -30,26 +31,49 @@ module Berkshelf
     # @param [Solve::Constraint] version_constraint
     # @param [Hash] options
     #
-    # @option options [String] :path
+    # @option options [#to_s] :path
     #   a filepath to the cookbook on your local disk
+    # @option options [Boolean] :metadata
+    #   true if this is a metadata source
     def initialize(name, version_constraint, options = {})
       @name               = name
       @version_constraint = version_constraint
-      @path               = options[:path]
-      set_downloaded_status(true)
+      @path               = options[:path].to_s
+      @metadata           = options[:metadata]
     end
 
-    # @param [#to_s] destination
+    # The cookbook associated with this path location.
     #
     # @return [Berkshelf::CachedCookbook]
-    def download(destination)
-      cached = CachedCookbook.from_path(path, name: name)
-      validate_cached(cached)
+    #   the cached cookbook for this location
+    def cookbook
+      @cookbook ||= CachedCookbook.from_path(path, name: name)
+    end
+
+    # Returns true if the location is a metadata location. By default, no
+    # locations are the metadata location.
+    #
+    # @return [Boolean]
+    def metadata?
+      !!@metadata
+    end
+
+    # Return this PathLocation's path relative to the given target.
+    #
+    # @param [#to_s] target
+    #   the path to a file or directory to be relative to
+    #
+    # @return [String]
+    #   the relative path relative to the target
+    def relative_path(target = '.')
+      my_path     = Pathname.new(path).expand_path
+      target_path = Pathname.new(target.to_s).expand_path
+      target_path = target_path.dirname if target_path.file?
+
+      new_path = my_path.relative_path_from(target_path).to_s
 
-      set_downloaded_status(true)
-      cached
-    rescue IOError
-      raise Berkshelf::CookbookNotFound
+      return new_path if new_path.index('.') == 0
+      "./#{new_path}"
     end
 
     def to_hash

data/lib/berkshelf/locations/site_location.rb

@@ -47,7 +47,6 @@ module Berkshelf
       cached = CachedCookbook.from_store_path(berks_path)
       validate_cached(cached)
 
-      set_downloaded_status(true)
       cached
     end
 

data/lib/berkshelf/resolver.rb

@@ -85,7 +85,7 @@ module Berkshelf
     # @return [Array<Berkshelf::CookbookSource>]
     #   an array of CookbookSources that are currently added to this resolver
     def sources
-      @sources.collect { |name, source| source }
+      @sources.values
     end
 
     # Finds a solution for the currently added sources and their dependencies and
@@ -153,24 +153,28 @@ module Berkshelf
       #
       # @return [Boolean]
       def use_source(source)
+        name       = source.name
+        constraint = source.version_constraint
+        location   = source.location
+
         if source.downloaded?
           cached = source.cached_cookbook
-          source.location.validate_cached(cached)
+          location.validate_cached(cached)
+          Berkshelf.formatter.use(name, cached.version, location)
+          true
+        elsif location.is_a?(GitLocation)
+          false
         else
-          if source.location.is_a?(GitLocation)
-            return false
+          cached = downloader.cookbook_store.satisfy(name, constraint)
+
+          if cached
+            get_source(source).cached_cookbook = cached
+            Berkshelf.formatter.use(name, cached.version)
+            true
+          else
+            false
           end
-
-          cached = downloader.cookbook_store.satisfy(source.name, source.version_constraint)
-          return false if cached.nil?
-
-          get_source(source).cached_cookbook = cached
         end
-
-        path = source.location.is_a?(PathLocation) ? source.location.to_s : nil
-        Berkshelf.formatter.use(cached.cookbook_name, cached.version, path)
-
-        true
       end
   end
 end

data/lib/berkshelf/version.rb

@@ -1,3 +1,3 @@
 module Berkshelf
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/spec/fixtures/cookbooks/example_cookbook/Berksfile

@@ -0,0 +1 @@
+site :opscode

data/spec/unit/berkshelf/berksfile_spec.rb

@@ -129,8 +129,8 @@ describe Berkshelf::Berksfile do
 
     before { Dir.chdir(path) }
 
-    it 'sends the add_source message with an explicit version constraint and the path to the cookbook' do
-      subject.should_receive(:add_source).with('example_cookbook', '= 0.5.0', path: path.to_s)
+    it 'sends the add_source message with no version constraint, the path to the cookbook, and the metadata definition' do
+      subject.should_receive(:add_source).with('example_cookbook', nil, path: path.to_s, metadata: true)
       subject.metadata
     end
   end
@@ -572,4 +572,32 @@ describe Berkshelf::Berksfile do
       end
     end
   end
+
+  describe '#validate_files!' do
+    before { described_class.send(:public, :validate_files!) }
+    let(:cookbook) { double('cookbook', cookbook_name: 'cookbook', path: 'path') }
+
+    it 'raises an error when the cookbook has spaces in the files' do
+      Dir.stub(:glob).and_return(['/there are/spaces/in this/recipes/default.rb'])
+      expect {
+        subject.validate_files!(cookbook)
+      }.to raise_error(Berkshelf::InvalidCookbookFiles)
+    end
+
+    it 'does not raise an error when the cookbook is valid' do
+      Dir.stub(:glob).and_return(['/there-are/no-spaces/in-this/recipes/default.rb'])
+      expect {
+        subject.validate_files!(cookbook)
+      }.to_not raise_error(Berkshelf::InvalidCookbookFiles)
+    end
+
+    it 'does not raise an exception with spaces in the path' do
+      Dir.stub(:glob).and_return(['/there are/spaces/in this/recipes/default.rb'])
+      Pathname.any_instance.stub(:dirname).and_return('/there are/spaces/in this')
+
+      expect {
+        subject.validate_files!(cookbook)
+      }.to_not raise_error
+    end
+  end
 end

data/spec/unit/berkshelf/community_rest_spec.rb

@@ -5,21 +5,59 @@ describe Berkshelf::CommunityREST, vcr: { record: :new_episodes, serialize_with:
     let(:target) { '/foo/bar' }
     let(:destination) { '/destination/bar' }
     let(:file) { double('file') }
-    let(:gzip_reader) { double('gzip_reader') }
 
-    before do
-      File.stub(:open).with(target, 'rb').and_return(file)
-      Zlib::GzipReader.stub(:new).with(file).and_return(gzip_reader)
-      Archive::Tar::Minitar.stub(:unpack).with(gzip_reader, destination)
+    describe 'a tar.gz file' do
+      let(:gzip_reader) { double('gzip_reader') }
+
+      before do
+        File.stub(:open).with(target, 'rb').and_return(file)
+        Zlib::GzipReader.stub(:new).with(file).and_return(gzip_reader)
+        Archive::Tar::Minitar.stub(:unpack).with(gzip_reader, destination)
+      end
+
+      it 'unpacks the file' do
+        File.should_receive(:open).with(target, 'rb')
+        ::IO.should_receive(:binread).with(target, 2).and_return([0x1F, 0x8B].pack("C*"))
+        Zlib::GzipReader.should_receive(:new).with(file)
+        Archive::Tar::Minitar.should_receive(:unpack).with(gzip_reader, destination)
+
+        expect(Berkshelf::CommunityREST.unpack(target, destination)).to eq(destination)
+      end
+    end
+
+    describe 'a tar file' do
+      before do
+        File.stub(:open).with(target, 'rb').and_return(file)
+        Archive::Tar::Minitar.stub(:unpack).with(target, destination)
+      end
+
+      it 'unpacks the file' do
+        ::IO.should_receive(:binread).once
+        ::IO.should_receive(:binread).with(target, 8, 257).and_return("ustar\x0000")
+        Archive::Tar::Minitar.should_receive(:unpack).with(target, destination)
+
+        expect(Berkshelf::CommunityREST.unpack(target, destination)).to eq(destination)
+      end
     end
 
-    it 'unpacks the tar' do
-      File.should_receive(:open).with(target, 'rb')
-      ::IO.should_receive(:binread).with(target, 2).and_return([0x1F, 0x8B].pack("C*"))
-      Zlib::GzipReader.should_receive(:new).with(file)
-      Archive::Tar::Minitar.should_receive(:unpack).with(gzip_reader, destination)
+    describe 'a tar.bz2 file' do
+      let(:bzip2_reader) { double('bzip2_reader') }
+
+      before do
+        File.stub(:open).with(target, 'rb').and_return(file)
+        RBzip2::Decompressor.stub(:new).with(file).and_return(bzip2_reader)
+        Archive::Tar::Minitar.stub(:unpack).with(bzip2_reader, destination)
+      end
+
+      it 'unpacks the file' do
+        File.should_receive(:open).with(target, 'rb')
+        ::IO.should_receive(:binread).twice
+        ::IO.should_receive(:binread).with(target, 3).and_return('BZh')
+        RBzip2::Decompressor.should_receive(:new).with(file)
+        Archive::Tar::Minitar.should_receive(:unpack).with(bzip2_reader, destination)
 
-      expect(Berkshelf::CommunityREST.unpack(target, destination)).to eq(destination)
+        expect(Berkshelf::CommunityREST.unpack(target, destination)).to eq(destination)
+      end
     end
   end