berkshelf 0.4.0.rc4 → 0.4.0

data/.gitignore

@@ -16,6 +16,8 @@ tmp
 \#*
 .DS_Store
 /spec/knife.rb
+/spec/validator.pem
+/spec/berkshelf.pem
 /spec/fixtures/vcr_cassettes
 /features/config.yml
 *.sw[op]

data/Guardfile

@@ -1,22 +1,25 @@
+notification :off
+interactor :coolline
+
 guard 'spork' do
   watch('Gemfile')
   watch('spec/spec_helper.rb')  { :rspec }
   watch(%r{^features/support/}) { :cucumber }
 end
 
-guard 'yard', :stdout => '/dev/null', :stderr => '/dev/null' do
+guard 'yard', stdout: '/dev/null', stderr: '/dev/null' do
   watch(%r{app/.+\.rb})
   watch(%r{lib/.+\.rb})
   watch(%r{ext/.+\.c})
 end
 
-guard 'rspec', :version => 2, :cli => "--color --drb --format Fuubar", :all_on_start => false, :all_after_pass => false, :notification => false do
+guard 'rspec', version: 2, cli: "--color --drb --format Fuubar", all_on_start: false, all_after_pass: false do
   watch(%r{^spec/unit/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})          { |m| "spec/unit/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')       { "spec" }
 end
 
-guard 'cucumber', :cli => "--drb --format pretty --tags ~@no_run", :all_on_start => false, :all_after_pass => false, :notification => false do
+guard 'cucumber', cli: "--drb --format pretty --tags ~@no_run --tags ~@wip", all_on_start: false, all_after_pass: false do
   watch(%r{^features/.+\.feature$})
   watch(%r{^features/support/.+$})                      { 'features' }
   watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }

data/features/default_locations.feature

@@ -0,0 +1,122 @@
+Feature: Berksfile default locations
+  As a Berkshelf user
+  I want to be able to define default locations in my Berksfile
+  So I can set the precedence of where cookbook sources are downloaded from or define an alternate location for all 
+  cookbook sources to attempt to retrieve from
+
+  Scenario: with a default chef_api(1) and site(2) location with a cookbook source that is satisfied by the chef_api(1) location
+    Given I write to "Berksfile" with:
+      """
+      chef_api :knife
+      site 'http://cookbooks.opscode.com/api/v1/cookbooks'
+
+      cookbook "artifact", "= 0.10.0"
+      """
+    And the Chef server has cookbooks:
+      | artifact | 0.10.0 |
+    When I run the install command
+    Then the output should contain:
+      """
+      Installing artifact (0.10.0) from chef_api:
+      """
+    And the cookbook store should have the cookbooks:
+      | artifact | 0.10.0 |
+    And the exit status should be 0
+
+  Scenario: with a default chef_api(1) and site(2) location with a cookbook source that is not satisfied by the chef_api(1) location
+    Given I write to "Berksfile" with:
+      """
+      chef_api :knife
+      site 'http://cookbooks.opscode.com/api/v1/cookbooks'
+
+      cookbook "artifact", "= 0.10.0"
+      """
+    And the Chef server does not have the cookbooks:
+      | artifact | 0.10.0 |
+    When I run the install command
+    Then the output should contain:
+      """
+      Installing artifact (0.10.0) from site: 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      """
+    And the cookbook store should have the cookbooks:
+      | artifact | 0.10.0 |
+    And the exit status should be 0
+
+  Scenario: with a default site(1) and chef_api(2) location with a cookbook source that is satisfied by the site(1) location
+    Given I write to "Berksfile" with:
+      """
+      site 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      chef_api :knife
+
+      cookbook "artifact", "= 0.10.0"
+      """
+    And the Chef server has cookbooks:
+      | artifact | 0.10.0 |
+    When I run the install command
+    Then the output should contain:
+      """
+      Installing artifact (0.10.0) from site: 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      """
+    And the cookbook store should have the cookbooks:
+      | artifact | 0.10.0 |
+    And the exit status should be 0
+
+  Scenario: with a default chef_api(1) location and a cookbook source that is satisfied by the chef_api(1) location but has an explicit location set
+    Given I write to "Berksfile" with:
+      """
+      chef_api :knife
+
+      cookbook 'artifact', '= 0.10.0', site: 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      """
+    And the Chef server has cookbooks:
+      | artifact | 0.10.0 |
+    When I run the install command
+    Then the output should contain:
+      """
+      Installing artifact (0.10.0) from site: 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      """
+    And the cookbook store should have the cookbooks:
+      | artifact | 0.10.0 |
+    And the exit status should be 0
+
+  Scenario: with a defualt chef_api(1) location and a cookbook source that is not satisfied by it
+    Given I write to "Berksfile" with:
+      """
+      chef_api :knife
+
+      cookbook 'artifact', '= 0.10.0'
+      """
+    And the Chef server does not have the cookbooks:
+      | artifact | 0.10.0 |
+    When I run the install command
+    Then the output should contain:
+      """
+      Cookbook 'artifact' not found in any of the default locations
+      """
+    And the CLI should exit with the status code for error "CookbookNotFound"
+
+  Scenario: with two duplicate locations definitions
+    Given I write to "Berksfile" with:
+      """
+      site 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      site 'http://cookbooks.opscode.com/api/v1/cookbooks'
+
+      cookbook 'artifact', '= 0.10.0'
+      """
+    When I run the install command
+    Then the output should contain:
+      """
+      A default 'site' location with the value 'http://cookbooks.opscode.com/api/v1/cookbooks' is already defined
+      """
+    And the CLI should exit with the status code for error "DuplicateLocationDefined"
+
+  Scenario: with two locations of the same type but different values
+    Given I write to "Berksfile" with:
+      """
+      site 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      site 'http://cookbooks.opscode.com/api/v2/cookbooks'
+
+      cookbook 'artifact', '= 0.10.0'
+      """
+    When I run the install command
+    Then the exit status should be 0

data/features/install.feature

@@ -65,7 +65,7 @@ Feature: install cookbooks from a Berksfile
       """
     And the exit status should be 0
 
-  @wip
+  @no_run
   Scenario: installing a Berksfile that contains a path location which contains a broken symlink
     Given a Berksfile with path location sources to fixtures:
       | example_cookbook_broken_link | example_cookbook_broken_link |
@@ -142,9 +142,9 @@ Feature: install cookbooks from a Berksfile
     And I run the install command
     Then the output should contain:
       """
-      Cookbook 'doesntexist' not found at site: 'http://cookbooks.opscode.com/api/v1/cookbooks'
+      Cookbook 'doesntexist' not found in any of the default locations
       """
-    And the CLI should exit with the status code for error "DownloadFailure"
+    And the CLI should exit with the status code for error "CookbookNotFound"
 
   Scenario: running install command with the --shims flag to create a directory of shims
     Given I write to "Berksfile" with:
@@ -162,6 +162,22 @@ Feature: install cookbooks from a Berksfile
       """
     And the exit status should be 0
 
+  Scenario: running install command with the --shims flag and a relative path
+    Given I write to "Berksfile" with:
+      """
+      cookbook "mysql", "1.2.4"
+      """
+    When I run the install command with flags:
+      | --shims relativepath |
+    Then the following directories should exist:
+      | relativepath       |
+      | relativepath/mysql |
+    And the output should contain:
+      """
+      Shims written to: 
+      """
+    And the exit status should be 0
+
   Scenario: running install with --shims when current project is a cookbook and the 'metadata' is specified
     Given a cookbook named "sparkle_motion"
     And the cookbook "sparkle_motion" has the file "Berksfile" with:
@@ -254,7 +270,7 @@ Feature: install cookbooks from a Berksfile
       cookbook "artifact", chef_api: :knife
       """
     And the Chef server has cookbooks:
-      | artifact | 0.10.0 |
+      | artifact | 0.10.2 |
     When I run the install command
     Then the output should contain:
       """

data/features/lockfile.feature

@@ -7,16 +7,11 @@ Feature: Berksfile.lock
   Scenario: Writing the Berksfile.lock
     Given I write to "Berksfile" with:
       """
-      cookbook 'ntp'
-      cookbook 'mysql', git: 'https://github.com/opscode-cookbooks/mysql.git', :ref => '190c0c2267785b7b9b303369b8a64ed04364d5f9'
+      cookbook 'ntp', '1.1.8'
       """
     When I run the install command
     Then a file named "Berksfile.lock" should exist in the current directory
     And the file "Berksfile.lock" should contain in the current directory:
       """
       cookbook 'ntp', :locked_version => '1.1.8'
-      cookbook 'mysql', :git => 'https://github.com/opscode-cookbooks/mysql.git', :ref => '190c0c2267785b7b9b303369b8a64ed04364d5f9'
-      cookbook 'openssl', :locked_version => '1.0.0'
-      cookbook 'windows', :locked_version => '1.3.2'
-      cookbook 'chef_handler', :locked_version => '1.0.6'
       """

data/features/update.feature

@@ -6,7 +6,7 @@ Feature: update
   Scenario: knife berkshelf update
     Given I write to "Berksfile" with:
       """
-      cookbook "mysql"
+      cookbook "mysql", "1.3.0"
       """
     Given I write to "Berksfile.lock" with:
       """
@@ -18,6 +18,5 @@ Feature: update
       """
       cookbook 'mysql', :locked_version => '1.3.0'
       cookbook 'openssl', :locked_version => '1.0.0'
-      cookbook 'windows', :locked_version => '1.3.2'
-      cookbook 'chef_handler', :locked_version => '1.0.6'
+      cookbook 'build-essential', :locked_version => '1.1.0'
       """

data/generator_files/Berksfile.erb

@@ -1,3 +1,5 @@
+site :opscode
 <% if options[:metadata_entry] -%>
+
 metadata
 <% end -%>

data/generator_files/gitignore.erb

@@ -1,6 +1,12 @@
 .vagrant
 Berksfile.lock
 Gemfile.lock
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
 /cookbooks
 <% if options[:scmversion] -%>
 VERSION

data/lib/berkshelf.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+require 'uri'
 require 'pathname'
 require 'zlib'
 require 'archive/tar/minitar'
@@ -20,7 +22,6 @@ module Berkshelf
   DEFAULT_FILENAME = 'Berksfile'.freeze
 
   autoload :Cli, 'berkshelf/cli'
-  autoload :DSL, 'berkshelf/dsl'
   autoload :Git, 'berkshelf/git'
   autoload :Berksfile, 'berkshelf/berksfile'
   autoload :Lockfile, 'berkshelf/lockfile'
@@ -30,18 +31,17 @@ module Berkshelf
   autoload :CookbookSource, 'berkshelf/cookbook_source'
   autoload :CookbookStore, 'berkshelf/cookbook_store'
   autoload :CachedCookbook, 'berkshelf/cached_cookbook'
-  autoload :TXResult, 'berkshelf/tx_result'
-  autoload :TXResultSet, 'berkshelf/tx_result_set'
   autoload :Downloader, 'berkshelf/downloader'
   autoload :Uploader, 'berkshelf/uploader'
   autoload :Resolver, 'berkshelf/resolver'
 
+  require 'berkshelf/location'
+
   class << self
     attr_accessor :ui
-    attr_accessor :cookbook_store
-    attr_accessor :downloader
-
+    
     attr_writer :config_path
+    attr_writer :cookbook_store
 
     def root
       @root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
@@ -74,10 +74,6 @@ module Berkshelf
       @cookbook_store ||= CookbookStore.new(cookbooks_dir)
     end
 
-    def downloader
-      @downloader ||= Downloader.new(cookbook_store)
-    end
-
     def config_path
       @config_path ||= DEFAULT_CONFIG
     end

data/lib/berkshelf/berksfile.rb

@@ -1,9 +1,13 @@
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
   class Berksfile
-    include DSL
+    extend Forwardable
 
     class << self
+      # @param [String] file
+      #   a path on disk to a Berksfile to instantiate from
+      #
+      # @return [Berksfile]
       def from_file(file)
         content = File.read(file)
         object = new(file)
@@ -28,26 +32,201 @@ module Berkshelf
       end
     end
 
+    @@active_group = nil
+
+    # @return [String]
+    #   The path on disk to the file representing this instance of Berksfile
     attr_reader :filepath
+    
+    # @return [Berkshelf::Downloader]
+    attr_reader :downloader
+
+    def_delegator :downloader, :add_location
+    def_delegator :downloader, :locations
 
     def initialize(path)
       @filepath = path
       @sources = Hash.new
+      @downloader = Downloader.new(Berkshelf.cookbook_store)
     end
 
-    # Add the given source to the sources array. A DuplicateSourceDefined
-    # exception will be raised if a source is added whose name conflicts
-    # with a source who has already been added.
+    # Add a cookbook source to the Berksfile to be retrieved and have it's dependencies recurisvely retrieved
+    # and resolved.
+    #
+    # @example a cookbook source that will be retrieved from one of the default locations
+    #   cookbook 'artifact'
+    #
+    # @example a cookbook source that will be retrieved from a path on disk
+    #   cookbook 'artifact', path: '/Users/reset/code/artifact'
+    #
+    # @example a cookbook source that will be retrieved from a remote community site
+    #   cookbook 'artifact', site: 'http://cookbooks.opscode.com/api/v1/cookbooks'
+    #
+    # @example a cookbook source that will be retrieved from the latest API of the Opscode Community Site
+    #   cookbook 'artifact', site: :opscode
+    #
+    # @example a cookbook source that will be retrieved from a Git server
+    #   cookbook 'artifact', git: 'git://github.com/RiotGames/artifact-cookbook.git'
     #
-    # @param [Berkshelf::CookbookSource] source
-    #   the source to add
+    # @example a cookbook source that will be retrieved from a Chef API (Chef Server)
+    #   cookbook 'artifact', chef_api: 'https://api.opscode.com/organizations/vialstudios', node_name: 'reset', client_key: '/Users/reset/.chef/knife.rb'
+    #
+    # @example a cookbook source that will be retrieved from a Chef API using your Knife config
+    #   cookbook 'artifact', chef_api: :knife
+    #
+    # @overload cookbook(name, version_constraint, options = {})
+    #   @param [#to_s] name
+    #   @param [#to_s] version_constraint
+    #   @param [Hash] options
+    #
+    #   @option options [Symbol, Array] :group
+    #     the group or groups that the cookbook belongs to
+    #   @option options [String, Symbol] :chef_api
+    #     a URL to a Chef API. Alternatively the symbol :knife can be provided
+    #     which will instantiate this location with the values found in your
+    #     knife configuration.
+    #   @option options [String] :site
+    #     a URL pointing to a community API endpoint
+    #   @option options [String] :path
+    #     a filepath to the cookbook on your local disk
+    #   @option options [String] :git
+    #     the Git URL to clone
+    #
+    #   @see ChefAPILocation
+    #   @see SiteLocation
+    #   @see PathLocation
+    #   @see GitLocation
+    # @overload cookbook(name, options = {})
+    #   @param [#to_s] name
+    #   @param [Hash] options
+    #
+    #   @option options [Symbol, Array] :group
+    #     the group or groups that the cookbook belongs to
+    #   @option options [String, Symbol] :chef_api
+    #     a URL to a Chef API. Alternatively the symbol :knife can be provided
+    #     which will instantiate this location with the values found in your
+    #     knife configuration.
+    #   @option options [String] :site
+    #     a URL pointing to a community API endpoint
+    #   @option options [String] :path
+    #     a filepath to the cookbook on your local disk
+    #   @option options [String] :git
+    #     the Git URL to clone
+    #
+    #   @see ChefAPILocation
+    #   @see SiteLocation
+    #   @see PathLocation
+    #   @see GitLocation
+    def cookbook(*args)
+      options = args.last.is_a?(Hash) ? args.pop : Hash.new
+      name, constraint = args
+
+      options[:group] = Array(options[:group])
+      
+      if @@active_group
+        options[:group] += @@active_group
+      end
+
+      add_source(name, constraint, options)
+    end
+
+
+    def group(*args)
+      @@active_group = args
+      yield
+      @@active_group = nil
+    end
+
+    # Use a Cookbook metadata file to determine additional cookbook sources to retrieve. All
+    # sources found in the metadata will use the default locations set in the Berksfile (if any are set)
+    # or the default locations defined by Berkshelf.
+    #
+    # @param [Hash] options
+    #
+    # @option options [String] :path
+    #   path to the metadata file
+    def metadata(options = {})
+      path = options[:path] || File.dirname(filepath)
+
+      metadata_file = Berkshelf.find_metadata(path)
+
+      unless metadata_file
+        raise CookbookNotFound, "No 'metadata.rb' found at #{path}"
+      end
+
+      metadata = Chef::Cookbook::Metadata.new
+      metadata.from_file(metadata_file.to_s)
+
+      name = if metadata.name.empty? || metadata.name.nil?
+        File.basename(File.dirname(metadata_file))
+      else
+        metadata.name
+      end
+
+      constraint = "= #{metadata.version}"
+
+      add_source(name, constraint, path: File.dirname(metadata_file))
+    end
+
+    # Add a 'Site' default location which will be used to resolve cookbook sources that do not
+    # contain an explicit location.
+    #
+    # @note
+    #   specifying the symbol :opscode as the value of the site default location is an alias for the
+    #   latest API of the Opscode Community Site.
+    #
+    # @example
+    #   site :opscode
+    #   site "http://cookbooks.opscode.com/api/v1/cookbooks"
+    #
+    # @param [String, Symbol] value
+    #
+    # @return [Hash]
+    def site(value)
+      add_location(:site, value)
+    end
+
+    # Add a 'Chef API' default location which will be used to resolve cookbook sources that do not
+    # contain an explicit location.
+    #
+    # @note
+    #   specifying the symbol :knife as the value of the chef_api default location will attempt to use the
+    #   contents of your user's Knife.rb to find the Chef API to interact with.
+    #
+    # @example using the symbol :knife to add a Chef API default location
+    #   chef_api :knife
+    #
+    # @example using a URL, node_name, and client_key to add a Chef API default location
+    #   chef_api "https://api.opscode.com/organizations/vialstudios", node_name: "reset", client_key: "/Users/reset/.chef/knife.rb"
+    #
+    # @param [String, Symbol] value
+    # @param [Hash] options
+    #
+    # @return [Hash]
+    def chef_api(value, options = {})
+      add_location(:chef_api, value, options)
+    end
+
+    # Add a source of the given name and constraint to the array of sources.
+    #
+    # @param [String] name
+    #   the name of the source to add
+    # @param [String, Solve::Constraint] constraint
+    #   the constraint to lock the source to
+    # @param [Hash] options
+    #
+    # @raise [DuplicateSourceDefined] if a source is added whose name conflicts
+    #   with a source who has already been added.
     #
     # @return [Array<Berkshelf::CookbookSource]
-    def add_source(source)
-      if has_source?(source)
-        raise DuplicateSourceDefined, "Berksfile contains two sources named '#{source.name}'. Remove one and try again."
+    def add_source(name, constraint = nil, options = {})
+      if has_source?(name)
+        raise DuplicateSourceDefined, "Berksfile contains two sources named '#{name}'. Remove one and try again."
       end
-      @sources[source.to_s] = source
+
+      options[:constraint] = constraint
+
+      @sources[name] = CookbookSource.new(name, options)
     end
 
     # @param [#to_s] source
@@ -97,7 +276,7 @@ module Berkshelf
     #     }
     def groups
       {}.tap do |groups|
-        @sources.each_pair do |name, source|
+        sources.each do |source|
           source.groups.each do |group|
             groups[group] ||= []
             groups[group] << source
@@ -122,7 +301,11 @@ module Berkshelf
     #   Path to a directory of shims each pointing to a Cookbook Version that is
     #   part of the dependency solution. Each shim is a hard link on disk.
     def install(options = {})
-      resolver = Resolver.new(Berkshelf.downloader, sources(exclude: options[:without]))
+      resolver = Resolver.new(
+        self.downloader,
+        sources: sources(exclude: options[:without])
+      )
+
       solution = resolver.resolve
       if options[:shims]
         write_shims(options[:shims], solution)
@@ -154,7 +337,7 @@ module Berkshelf
 
       solution.each do |cb|
         Berkshelf.formatter.upload cb.cookbook_name, cb.version, chef_server_url
-        uploader.upload!(cb, options)
+        uploader.upload(cb, options)
       end
     end
 
@@ -166,7 +349,10 @@ module Berkshelf
     #
     # @return [Array<Berkshelf::CachedCookbooks]
     def resolve(options = {})
-      Resolver.new(Berkshelf.downloader, sources(exclude: options[:without])).resolve
+      Resolver.new(
+        self.downloader,
+        sources: sources(exclude: options[:without])
+      ).resolve
     end
 
     # Write a collection of hard links to the given path representing the given
@@ -182,6 +368,7 @@ module Berkshelf
     # @param [Pathname, String] path
     # @param [Array<Berkshelf::CachedCookbook>] cached_cookbooks
     def write_shims(path, cached_cookbooks)
+      path        = File.expand_path(path)
       actual_path = nil
 
       if descendant_directory?(path, Dir.pwd)
@@ -207,6 +394,8 @@ module Berkshelf
     #
     # @param [String] content
     #
+    # @raise [BerksfileReadError] if Berksfile contains bad content
+    #
     # @return [Berksfile]
     def load(content)
       begin