berkshelf 2.0.4 → 2.0.5

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.0.5
+
+* Improve speed of resolution when a lockfile is present
+* Gracefully fail when a lockfile is present but empty
+* Fix issue where locked version was not honored if the cookbook store was empty
+
 # 2.0.4
 
 * Fix bug where community cookbooks compressed with bzip2 would not download and install

data/features/lockfile.feature

@@ -17,7 +17,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"80396ed07db133e0192593adebb360c27eed88c2",
         "sources":{
           "fake":{
-            "constraint":"= 1.0.0",
             "locked_version":"1.0.0"
           }
         }
@@ -44,7 +43,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha": "374a3d22920abae4a6d620a14a32b90d8babda8f",
         "sources": {
           "fake": {
-            "constraint": "= 1.0.0",
             "locked_version": "1.0.0"
           }
         }
@@ -69,7 +67,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"ebf27d476739b5aba7e7e8a61de23b3330e20a7d",
         "sources":{
           "fake":{
-            "constraint":"= 0.0.0",
             "path":"./fake"
           }
         }
@@ -92,11 +89,9 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"80396ed07db133e0192593adebb360c27eed88c2",
         "sources":{
           "fake":{
-            "constraint":"= 1.0.0",
             "locked_version":"1.0.0"
           },
           "dep":{
-            "constraint":"~> 1.0.0",
             "locked_version":"1.0.0"
           }
         }
@@ -117,7 +112,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"e42f8e41a5e646bd86591c5b7ec25442736b87fd",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "constraint":"~> 1.0.0",
             "locked_version":"1.0.0"
           }
         }
@@ -130,7 +124,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"e42f8e41a5e646bd86591c5b7ec25442736b87fd",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "constraint":"~> 1.0.0",
             "locked_version":"1.0.0"
           }
         }
@@ -152,7 +145,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"3dced4fcd9c3f72b68e746190aaa1140bdc6cc3d",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "constraint":"~> 0.1",
             "locked_version":"0.1.0"
           }
         }
@@ -165,7 +157,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"b2714a4f9bdf500cb20267067160a0b3c1d8404c",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "constraint":"~> 0.1",
             "locked_version":"0.2.0"
           }
         }
@@ -186,7 +177,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"c6438d7590f4d695d8abae83ff22586ba6d3a52e",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "constraint":"= 1.0.0",
             "locked_version":"1.0.0"
           }
         }
@@ -199,7 +189,6 @@ Feature: Creating and reading the Berkshelf lockfile
         "sha":"c6438d7590f4d695d8abae83ff22586ba6d3a52e",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "constraint":"= 1.0.0",
             "locked_version":"1.0.0"
           }
         }
@@ -441,3 +430,37 @@ Feature: Creating and reading the Berkshelf lockfile
       Try running `berks update berkshelf-cookbook-fixture, which will try to find  'berkshelf-cookbook-fixture' matching '~> 1.3.0'
       """
     And the CLI should exit with the status code for error "OutdatedCookbookSource"
+
+  Scenario: Installing when the Lockfile is empty
+    Given the cookbook store has the cookbooks:
+      | fake | 1.0.0 |
+    And I write to "Berksfile" with:
+      """
+      site :opscode
+      cookbook 'fake', '1.0.0'
+      """
+    And an empty file named "Berksfile.lock"
+    When I successfully run `berks install`
+    Then the output should contain:
+      """
+      Using fake (1.0.0)
+      """
+    And the exit status should be 0
+
+  Scenario: Installing when the Lockfile is in a bad state
+    Given I write to "Berksfile" with:
+      """
+      site :opscode
+      cookbook 'fake', '1.0.0'
+      """
+    Given I write to "Berksfile.lock" with:
+      """
+      this is totally not valid
+      """
+    When I run `berks install`
+    Then the output should contain:
+      """
+      Error reading the Berkshelf lockfile `Berksfile.lock` (JSON::ParserError)
+      """
+    And the CLI should exit with the status code for error "LockfileParserError"
+

data/features/update_command.feature

@@ -23,8 +23,7 @@ Feature: Updating a cookbook defined by a Berksfile
         "sha":"b2714a4f9bdf500cb20267067160a0b3c1d8404c",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "locked_version":"0.1.0",
-            "constraint":"~> 0.1"
+            "locked_version":"0.1.0"
           }
         }
       }
@@ -47,12 +46,10 @@ Feature: Updating a cookbook defined by a Berksfile
         "sha":"69b2e00e970d2bb6a9b1d09aeb3e6a17ef3df955",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "locked_version":"0.1.0",
-            "constraint":"~> 0.1"
+            "locked_version":"0.1.0"
           },
           "hostsfile":{
-            "locked_version":"1.0.1",
-            "constraint":"= 1.0.1"
+            "locked_version":"1.0.1"
           }
         }
       }
@@ -64,12 +61,10 @@ Feature: Updating a cookbook defined by a Berksfile
         "sha":"69b2e00e970d2bb6a9b1d09aeb3e6a17ef3df955",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "locked_version":"0.2.0",
-            "constraint":"~> 0.1"
+            "locked_version":"0.2.0"
           },
           "hostsfile":{
-            "locked_version":"1.0.1",
-            "constraint":"~> 1.0.0"
+            "locked_version":"1.0.1"
           }
         }
       }
@@ -92,12 +87,10 @@ Feature: Updating a cookbook defined by a Berksfile
         "sha":"69b2e00e970d2bb6a9b1d09aeb3e6a17ef3df955",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "locked_version":"0.1.0",
-            "constraint":"~> 0.1"
+            "locked_version":"0.1.0"
           },
           "hostsfile":{
-            "locked_version":"1.0.0",
-            "constraint":"~> 1.0.0"
+            "locked_version":"1.0.0"
           }
         }
       }
@@ -109,12 +102,10 @@ Feature: Updating a cookbook defined by a Berksfile
         "sha":"69b2e00e970d2bb6a9b1d09aeb3e6a17ef3df955",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "locked_version":"0.2.0",
-            "constraint":"~> 0.1"
+            "locked_version":"0.2.0"
           },
           "hostsfile":{
-            "locked_version":"1.0.0",
-            "constraint":"~> 1.0.0"
+            "locked_version":"1.0.0"
           }
         }
       }
@@ -134,8 +125,7 @@ Feature: Updating a cookbook defined by a Berksfile
         "sha":"23150cfe61b7b86882013c8664883058560b899d",
         "sources":{
           "berkshelf-cookbook-fixture":{
-            "locked_version":"0.1.0",
-            "constraint":"~> 0.1"
+            "locked_version":"0.1.0"
           }
         }
       }

data/lib/berkshelf/cookbook_source.rb

@@ -198,10 +198,6 @@ module Berkshelf
           h[:locked_version] = locked_version.to_s
         end
 
-        unless version_constraint.to_s == DEFAULT_CONSTRAINT
-          h[:constraint] = version_constraint.to_s
-        end
-
         if location.kind_of?(SiteLocation)
           h[:site] = location.api_uri if location.api_uri != CommunityREST::V1_API
         end

data/lib/berkshelf/downloader.rb

@@ -116,31 +116,10 @@ module Berkshelf
       # @return [Berkshelf::CachedCookbook, nil]
       #   the downloaded cached cookbook, or nil if one was not found
       def download_location(source, location, raise_if_not_found = false)
-        from_cache(source) || location.download(storage_path)
+        location.download(storage_path)
       rescue Berkshelf::CookbookNotFound
         raise if raise_if_not_found
         nil
       end
-
-      # Load the cached cookbook from the cookbook store.
-      #
-      # @param [Berkshelf::CookbookSource] source
-      #   the source to find in the cache
-      #
-      # @return [Berkshelf::CachedCookbook, nil]
-      def from_cache(source)
-        # Can't safely read a git location from cache
-        return nil if source.location.kind_of?(Berkshelf::GitLocation)
-
-        if source.locked_version
-          cookbook = cookbook_store.cookbook_path(source.name, source.locked_version)
-          path = File.expand_path(File.join(storage_path, cookbook))
-
-          return nil unless File.exists?(path)
-          return Berkshelf::CachedCookbook.from_path(path, name: source.name)
-        end
-
-        cookbook_store.satisfy(source.name, source.version_constraint)
-      end
   end
 end

data/lib/berkshelf/errors.rb

@@ -379,4 +379,21 @@ module Berkshelf
       "No #{@type.capitalize} config file found at: '#{@path}'!"
     end
   end
+
+  class LockfileParserError < BerkshelfError
+    status_code(136)
+
+    # @param [String] lockfile
+    #   the path to the Lockfile
+    # @param [~Exception] original
+    #   the original exception class
+    def initialize(lockfile, original)
+      @lockfile = Pathname.new(lockfile.to_s).basename.to_s
+      @original = original
+    end
+
+    def to_s
+      "Error reading the Berkshelf lockfile `#{@lockfile}` (#{@original.class})"
+    end
+  end
 end

data/lib/berkshelf/lockfile.rb

@@ -33,19 +33,9 @@ module Berkshelf
 
     # Load the lockfile from file system.
     def load!
-      contents = File.read(filepath)
-
-      begin
-        hash = JSON.parse(contents, symbolize_names: true)
-      rescue JSON::ParserError
-        if contents =~ /^cookbook ["'](.+)["']/
-          Berkshelf.ui.warn 'You are using the old lockfile format. Attempting to convert...'
-          hash = LockfileLegacy.parse(berksfile, contents)
-        else
-          raise
-        end
-      end
+      contents = File.read(filepath).strip
 
+      hash = parse(contents)
       @sha = hash[:sha]
 
       hash[:sources].each do |name, options|
@@ -168,6 +158,25 @@ module Berkshelf
 
     private
 
+      # Parse the given string as JSON.
+      #
+      # @param [String] contents
+      #
+      # @return [Hash]
+      def parse(contents)
+        # Ruby's JSON.parse cannot handle an empty string/file
+        return { sha: nil, sources: [] } if contents.strip.empty?
+
+        JSON.parse(contents, symbolize_names: true)
+      rescue Exception => e
+        if e.class == JSON::ParserError && contents =~ /^cookbook ["'](.+)["']/
+          Berkshelf.ui.warn 'You are using the old lockfile format. Attempting to convert...'
+          return LockfileLegacy.parse(berksfile, contents)
+        else
+          raise Berkshelf::LockfileParserError.new(filepath, e)
+        end
+      end
+
       # Save the contents of the lockfile to disk.
       def save
         File.open(filepath, 'w') do |file|

data/lib/berkshelf/resolver.rb

@@ -154,9 +154,13 @@ module Berkshelf
       # @return [Boolean]
       def use_source(source)
         name       = source.name
-        constraint = source.version_constraint
+        locked     = source.locked_version
         location   = source.location
 
+        # Lock the version constraint if a locked version was supplied
+        source.version_constraint = Solve::Constraint.new(locked.to_s) if locked
+        constraint = source.version_constraint
+
         if source.downloaded?
           cached = source.cached_cookbook
           location.validate_cached(cached)
@@ -165,7 +169,12 @@ module Berkshelf
         elsif location.is_a?(GitLocation)
           false
         else
-          cached = downloader.cookbook_store.satisfy(name, constraint)
+          # If a locked version if specified, it must exist
+          if locked
+            cached = downloader.cookbook_store.cookbook(name, locked)
+          else
+            cached = downloader.cookbook_store.satisfy(name, constraint)
+          end
 
           if cached
             get_source(source).cached_cookbook = cached

data/lib/berkshelf/version.rb

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

data/spec/unit/berkshelf/cookbook_source_spec.rb

@@ -1,3 +1,4 @@
+
 require 'spec_helper'
 
 describe Berkshelf::CookbookSource do
@@ -260,13 +261,6 @@ describe Berkshelf::CookbookSource do
       end
     end
 
-    it 'includes the constraint' do
-      subject.version_constraint = '~> 1.0.0'
-
-      expect(hash).to have_key(:constraint)
-      expect(hash[:constraint]).to eq('~> 1.0.0')
-    end
-
     it 'includes the locked version' do
       subject.cached_cookbook = double('cached', version: '1.2.3')
 

data/spec/unit/berkshelf/resolver_spec.rb

@@ -7,6 +7,8 @@ describe Berkshelf::Resolver, :chef_server, vcr: { record: :new_episodes, serial
     double('source',
       name: 'mysql',
       version_constraint: Solve::Constraint.new('= 1.2.4'),
+      :version_constraint= => nil,
+      locked_version: '1.2.4',
       downloaded?: true,
       cached_cookbook: double('mysql-cookbook',
         name: 'mysql-1.2.4',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berkshelf
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport