berkshelf 0.3.7 → 0.4.0.rc1

data/.gitignore

@@ -15,6 +15,7 @@ tmp
 *.tar*
 \#*
 .DS_Store
-/spec/fixtures/vcr_cassettes/*
+/spec/knife.rb
+/spec/fixtures/vcr_cassettes
 /features/config.yml
 *.sw[op]

data/README.md

@@ -1,4 +1,5 @@
 # Berkshelf
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/RiotGames/berkshelf)
 
 Manage a Cookbook or an Application's Cookbook dependencies
 
@@ -33,8 +34,15 @@ Bundler will install all gems and their dependencies required for testing and de
 
 ### Running unit (RSpec) and acceptance (Cucumber) tests
 
+Simply copy the `spec/knife.rb.sample` to `spec/knife.rb`, and point it at a
+chef server. Berkshelf tests may upload and destroy cookbooks on your chef
+server, so be sure to configure a server safe for this task.
+
     $ bundle exec guard start
 
+See [here](https://github.com/tdegrunt/vagrant-chef-server-bootstrap) for a
+quick way to get a testing chef server up.
+
 # Authors and Contributors
 
 * Josiah Kiehl (<josiah@skirmisher.net>)

data/Thorfile

@@ -33,7 +33,7 @@ class Default < Thor
 
   desc "cucumber", "Run Cucumber features"
   def cucumber
-    exec "cucumber --color --format=progress"
+    exec "cucumber --color --format progress --tags ~@no_run"
   end
 
   class VCR < Thor
@@ -41,7 +41,7 @@ class Default < Thor
 
     desc "clean", "clean VCR cassettes"
     def clean
-      FileUtils.rm_rf("spec/fixtures/vcr_cassettes/*")
+      FileUtils.rm_rf("spec/fixtures/vcr_cassettes")
     end
   end
 end

data/berkshelf.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.version               = Berkshelf::VERSION
   s.required_ruby_version = ">= 1.9.1"
 
-  s.add_runtime_dependency 'dep_selector'
+  s.add_runtime_dependency 'solve',           '~> 0.2.1'
   s.add_runtime_dependency 'chef',            '~> 10.12.0'
   s.add_runtime_dependency 'minitar'
   s.add_runtime_dependency 'thor',            '~> 0.15.2'

data/features/install.feature

@@ -71,8 +71,8 @@ Feature: install cookbooks from a Berksfile
       cookbook "artifact", git: "git://github.com/RiotGames/artifact-cookbook.git", ref: "0.9.8"
       """
     When I run the install command
-    Then the cookbook store should have the cookbooks:
-      | artifact | 0.9.8 |
+    Then the cookbook store should have the git cookbooks:
+      | artifact | 0.9.8 | c0a0b456a4716a81645bef1369f5fd1a4e62ce6d |
     And the output should contain:
       """
       Installing artifact (0.9.8) from git: 'git://github.com/RiotGames/artifact-cookbook.git' with branch: '0.9.8'
@@ -147,6 +147,29 @@ Feature: install cookbooks from a Berksfile
       """
     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:
+      """
+      metadata
+      """
+    When I cd to "sparkle_motion"
+    And I run the install command with flags:
+      | --shims |
+    Then the following directories should exist:
+      | cookbooks                |
+      | cookbooks/sparkle_motion |
+    And the output should contain:
+      """
+      Shims written to: 
+      """
+    And the output should contain:
+      """
+      Using sparkle_motion (0.0.0) at path:
+      """
+    And the exit status should be 0
+
+
   Scenario: installing a Berksfile that has a Git location source with an invalid Git URI
     Given I write to "Berksfile" with:
       """
@@ -197,3 +220,80 @@ Feature: install cookbooks from a Berksfile
       Installing artifact (0.10.0) from git: 'git://github.com/RiotGames/artifact-cookbook.git' with branch: '0.10.0'
       """
     And the exit status should be 0
+
+  Scenario: with a cookbook definition containing an invalid option
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", whatisthis: "I don't even know", anotherwat: "isthat"
+      """
+    When I run the install command
+    Then the output should contain:
+      """
+      Invalid options for Cookbook Source: 'whatisthis', 'anotherwat'.
+      """
+    And the CLI should exit with the status code for error "InternalError"
+
+  Scenario: with a cookbook definition containing a chef_api source location
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", chef_api: :knife
+      """
+    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 chef_api source location specifying :knife when a Knife config is not found at the given path
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", chef_api: :knife
+      """
+    When I run the install command with flags:
+      | -c /tmp/nothere.lol |
+    Then the output should contain:
+      """
+      A Knife config is required when ':knife' is given for the value of a 'chef_api' location. Attempted to load configuration from: '/tmp/nothere.lol' but not found.
+      """
+    And the CLI should exit with the status code for error "KnifeConfigNotFound"
+
+  Scenario: with a chef_api source location specifying a Chef API URL but missing a node_name option
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", chef_api: "https://api.opscode.com/organizations/vialstudios", client_key: "/Users/reset/.chef/knife.rb"
+      """
+    When I run the install command
+    Then the output should contain:
+      """
+      Source 'artifact' is a 'chef_api' location with a URL for it's value but is missing options: 'node_name'.
+      """
+    And the CLI should exit with the status code for error "InvalidChefAPILocation"
+
+  Scenario: with a chef_api source location specifying a Chef API URL but missing a client_key option
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", chef_api: "https://api.opscode.com/organizations/vialstudios", node_name: "reset"
+      """
+    When I run the install command
+    Then the output should contain:
+      """
+      Source 'artifact' is a 'chef_api' location with a URL for it's value but is missing options: 'client_key'.
+      """
+    And the CLI should exit with the status code for error "InvalidChefAPILocation"
+
+  Scenario: with a chef_api source location specifying a Chef API URL but missing a client_key option
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", chef_api: "https://api.opscode.com/organizations/vialstudios"
+      """
+    When I run the install command
+    Then the output should contain:
+      """
+      Source 'artifact' is a 'chef_api' location with a URL for it's value but is missing options: 'node_name', 'client_key'.
+      """
+    And the CLI should exit with the status code for error "InvalidChefAPILocation"

data/features/lockfile.feature

@@ -17,6 +17,6 @@ Feature: Berksfile.lock
       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.0'
+      cookbook 'windows', :locked_version => '1.3.2'
       cookbook 'chef_handler', :locked_version => '1.0.6'
       """

data/features/step_definitions/chef_server_steps.rb

@@ -6,6 +6,14 @@ Given /^the Chef server does not have the cookbooks:$/ do |cookbooks|
   end
 end
 
+Given /^the Chef server has cookbooks:$/ do |cookbooks|
+  cookbooks.raw.each do |name, version|
+    purge_cookbook(name, version)
+    cb_path = generate_cookbook(tmp_path, name, version)
+    upload_cookbook(cb_path)
+  end
+end
+
 Then /^the Chef server should have the cookbooks:$/ do |cookbooks|
   cookbooks.raw.each do |name, version|
     server_has_cookbook?(name, version).should be_true

data/features/step_definitions/cli_steps.rb

@@ -43,7 +43,7 @@ When /^I run the install command$/ do
 end
 
 When /^I run the install command with flags:$/ do |flags|
-  run_simple(unescape("berks install #{flags.raw.join(" ")}"), true)
+  run_simple(unescape("berks install #{flags.raw.join(" ")}"), false)
 end
 
 When /^I run the update command$/ do

data/features/step_definitions/filesystem_steps.rb

@@ -45,6 +45,18 @@ Then /^the cookbook store should have the cookbooks:$/ do |cookbooks|
   end
 end
 
+Then /^the cookbook store should have the git cookbooks:$/ do |cookbooks|
+  cookbooks.raw.each do |name, version, sha1|
+    cookbook_store.should have_structure {
+      directory "#{name}-#{sha1}" do
+        file "metadata.rb" do
+          contains version
+        end
+      end
+    }
+  end
+end
+
 Then /^the cookbook store should not have the cookbooks:$/ do |cookbooks|
   cookbooks.raw.each do |name, version|
     cookbook_store.should_not have_structure {

data/features/support/env.rb

@@ -12,12 +12,6 @@ Spork.prefork do
 
   ENV["BERKSHELF_PATH"] = File.join(APP_ROOT, "tmp", "berkshelf")
 
-  begin
-    CONFIG = YAML.load(File.read(File.join(APP_ROOT, "features", "config.yml")))
-  rescue Errno::ENOENT
-    raise "Please create a config file at features/config.yml from the sample found at features/config.sample.yml"
-  end
-  
   Dir[File.join(APP_ROOT, "spec/support/**/*.rb")].each {|f| require f}
 
   Around do |scenario, block|
@@ -27,15 +21,13 @@ Spork.prefork do
   end
 
   Before do
-    Chef::Config[:chef_server_url] = CONFIG['chef_server_url']
-    Chef::Config[:client_key] = CONFIG['client_key']
-    Chef::Config[:node_name] = CONFIG['node_name']
     clean_cookbook_store
     @aruba_io_wait_seconds = 5
+    @aruba_timeout_seconds = 8
   end
 
   Before('@slow_process') do
-    @aruba_timeout_seconds = 15
+    @aruba_timeout_seconds = 60
     @aruba_io_wait_seconds = 10
   end
 
@@ -52,11 +44,17 @@ Spork.prefork do
     Pathname.new(APP_ROOT)
   end
 
+  def tmp_path
+    app_root_path.join('spec/tmp')
+  end
+
   def fixtures_path
     app_root_path.join('spec/fixtures')
   end
 end
 
 Spork.each_run do
+  Berkshelf::RSpec::Knife.load_knife_config(File.join(APP_ROOT, 'spec/knife.rb'))
+  
   require 'berkshelf'
 end

data/features/update.feature

@@ -18,6 +18,6 @@ Feature: update
       """
       cookbook 'mysql', :locked_version => '1.2.6'
       cookbook 'openssl', :locked_version => '1.0.0'
-      cookbook 'windows', :locked_version => '1.3.0'
+      cookbook 'windows', :locked_version => '1.3.2'
       cookbook 'chef_handler', :locked_version => '1.0.6'
       """

data/lib/berkshelf.rb

@@ -1,11 +1,12 @@
 require 'pathname'
-require 'dep_selector'
 require 'zlib'
 require 'archive/tar/minitar'
+require 'solve'
 require 'chef/knife'
 require 'chef/rest'
 require 'chef/platform'
 require 'chef/cookbook/metadata'
+require 'chef/cookbook_version'
 
 require 'berkshelf/version'
 require 'berkshelf/core_ext'
@@ -14,6 +15,7 @@ require 'berkshelf/errors'
 Chef::Config[:cache_options][:path] = Dir.mktmpdir
 
 module Berkshelf
+  DEFAULT_CONFIG = File.expand_path(ENV["CHEF_CONFIG"] || "~/.chef/knife.rb")
   DEFAULT_STORE_PATH = File.expand_path("~/.berkshelf").freeze
   DEFAULT_FILENAME = 'Berksfile'.freeze
 
@@ -37,6 +39,8 @@ module Berkshelf
     attr_accessor :cookbook_store
     attr_accessor :downloader
 
+    attr_writer :config_path
+
     def root
       @root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
     end
@@ -62,6 +66,20 @@ module Berkshelf
       @downloader ||= Downloader.new(cookbook_store)
     end
 
+    def config_path
+      @config_path ||= DEFAULT_CONFIG
+    end
+
+    # Load the config found at the given path as the Chef::Config. If no path is specified
+    # the value of Berkshelf.chef_config will be used.
+    #
+    # @param [String] path
+    def load_config(path = config_path)
+      Chef::Config.from_file(File.expand_path(path))
+    rescue Errno::ENOENT
+      raise KnifeConfigNotFound, "Attempted to load configuration from: '#{path}' but not found."
+    end
+
     # Ascend the directory structure from the given path to find a
     # metadata.rb file of a Chef Cookbook. If no metadata.rb file
     # was found, nil is returned.

data/lib/berkshelf/berksfile.rb

@@ -185,21 +185,33 @@ module Berkshelf
     # @param [Pathname, String] path
     # @param [Array<Berkshelf::CachedCookbook>] cached_cookbooks
     def write_shims(path, cached_cookbooks)
+      actual_path = nil
+
+      if descendant_directory?(path, Dir.pwd)
+        actual_path = path
+        FileUtils.rm_rf(actual_path)
+        path = Dir.mktmpdir("berkshelf-")
+      end
+
       FileUtils.mkdir_p(path)
       cached_cookbooks.each do |cached_cookbook|
         destination = File.expand_path(File.join(path, cached_cookbook.cookbook_name))
         FileUtils.rm_rf(destination)
-        begin
-          FileUtils.ln_r(cached_cookbook.path, destination, force: true)
-        rescue ArgumentError
-          Berkshelf.ui.warn "Skipping shim for #{cached_cookbook}."
-          Berkshelf.ui.warn "Cannot write a shim for a path location source into a subdirectory of itself."
-        end
+        FileUtils.ln_r(cached_cookbook.path, destination, force: true)
+      end
+
+      if actual_path
+        FileUtils.mv(path, actual_path)
       end
     end
 
     private
 
+      def descendant_directory?(candidate, parent)
+        hack = FileUtils::Entry_.new('/tmp')
+        hack.send(:descendant_diretory?, candidate, parent)
+      end
+
       def lockfile_present?
         File.exist?(Berkshelf::Lockfile::DEFAULT_FILENAME)
       end

data/lib/berkshelf/cli.rb

@@ -8,6 +8,7 @@ module Berkshelf
       super
       # JW TODO: Replace Chef::Knife::UI with our own UI class
       ::Berkshelf.ui = Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
+      ::Berkshelf.config_path = @options[:config]
       @options = options.dup # unfreeze frozen options Hash from Thor
     rescue BerkshelfError => e
       Berkshelf.ui.fatal e
@@ -23,7 +24,7 @@ module Berkshelf
 
     class_option :config,
       type: :string,
-      default: File.expand_path(ENV["CHEF_CONFIG"] || "~/.chef/knife.rb"),
+      default: Berkshelf::DEFAULT_CONFIG,
       desc: "Path to Knife or Chef configuration to use.",
       aliases: "-c",
       banner: "PATH"
@@ -95,7 +96,7 @@ module Berkshelf
       desc: "Upload all cookbooks even if a frozen one exists on the target Chef Server"
     desc "upload", "Upload the Cookbooks specified by a Berksfile or a Berksfile.lock to a Chef Server."
     def upload
-      load_config 
+      Berkshelf.load_config 
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
       berksfile.upload(Chef::Config[:chef_server_url], options)
     rescue BerkshelfError => e
@@ -135,11 +136,5 @@ module Berkshelf
       def license
         File.read(Berkshelf.root.join('LICENSE'))
       end
-
-      def load_config
-        Chef::Config.from_file(File.expand_path(options[:config]))
-      rescue Errno::ENOENT
-        raise KnifeConfigNotFound, "Unable to find a Knife config at #{options[:config]}. Specify a different path with --config."
-      end
   end
 end

data/lib/berkshelf/cookbook_source.rb

@@ -1,14 +1,65 @@
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
   class CookbookSource
-    extend Forwardable
+    class << self
+      @@valid_options = [:group, :locked_version]
+      @@location_keys = Hash.new
+
+      # Returns an array of valid options to pass to the initializer
+      #
+      # @return [Array<Symbol>]
+      def valid_options
+        @@valid_options
+      end
+
+      # Returns an array of the registered source location keys. Every source
+      # location is identified by a key (symbol) to differentiate which class
+      # to instantiate for the location of a CookbookSource at initialization.
+      #
+      # @return [Array<Symbol>]
+      def location_keys
+        @@location_keys
+      end
+
+      # Add a option to the list of valid options
+      # @see #valid_options
+      #
+      # @param [Symbol] option
+      #
+      # @return [Array<Symbol>]
+      def add_valid_option(option)
+        @@valid_options.push(option) unless @@valid_options.include?(option)
+        @@valid_options
+      end
 
-    autoload :Location, 'berkshelf/cookbook_source/location'
-    autoload :SiteLocation, 'berkshelf/cookbook_source/site_location'
-    autoload :GitLocation, 'berkshelf/cookbook_source/git_location'
-    autoload :PathLocation, 'berkshelf/cookbook_source/path_location'
+      # Register a location key with the CookbookSource class
+      # @see #location_keys
+      #
+      # @param [Symbol] location
+      #
+      # @raise [ArgumentError] if the location key has already been defined
+      #
+      # @return [Array<Symbol>]
+      def add_location_key(location, klass)
+        unless @@location_keys.has_key?(location)
+          add_valid_option(location)
+          @@location_keys[location] = klass
+        end
+
+        @@location_keys
+      end
+    end
+
+    extend Forwardable
 
-    LOCATION_KEYS = [:git, :path, :site]
+    # JW TODO: Move locations out of CookbookSource namespace.
+    #   Move all locations into berkshelf/locations/*
+    #   Autorequire all items in berkshelf/locations/
+    require 'berkshelf/cookbook_source/location'
+    require 'berkshelf/cookbook_source/site_location'
+    require 'berkshelf/cookbook_source/git_location'
+    require 'berkshelf/cookbook_source/path_location'
+    require 'berkshelf/cookbook_source/chef_api_location'
 
     attr_reader :name
     alias_method :to_s, :name
@@ -24,36 +75,59 @@ module Berkshelf
     #   @param [#to_s] name
     #   @param [#to_s] version_constraint
     #   @param [Hash] options
+    #
+    #   @option options [String] :git
+    #     the Git URL to clone
+    #   @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 [Symbol, Array] :group
+    #     the group or groups that the cookbook belongs to
+    #   @option options [String] :ref
+    #     the commit hash or an alias to a commit hash to clone
+    #   @option options [String] :branch
+    #     same as ref
+    #   @option options [String] :tag
+    #     same as tag
+    #   @option options [String] :locked_version
     # @overload initialize(name, options = {})
     #   @param [#to_s] name
     #   @param [Hash] options
+    #
+    #   @option options [String] :git
+    #     the Git URL to clone
+    #   @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 [Symbol, Array] :group
+    #     the group or groups that the cookbook belongs to
+    #   @option options [String] :ref
+    #     the commit hash or an alias to a commit hash to clone
+    #   @option options [String] :branch
+    #     same as ref
+    #   @option options [String] :tag
+    #     same as tag
+    #   @option options [String] :locked_version
     def initialize(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
       name, constraint = args
 
       @name = name
-      @version_constraint = DepSelector::VersionConstraint.new(constraint || ">= 0.0.0")
+      @version_constraint = Solve::Constraint.new(constraint || ">= 0.0.0")
       @groups = []
       @cached_cookbook = nil
 
-      if (options.keys & LOCATION_KEYS).length > 1
-        raise ArgumentError, "Only one location key (#{LOCATION_KEYS.join(', ')}) may be specified"
-      end
+      validate_options(options)
 
-      @location = case 
-      when options[:git]
-        GitLocation.new(name, version_constraint, options)
-      when options[:path]
-        loc = PathLocation.new(name, version_constraint, options)
-        @cached_cookbook = CachedCookbook.from_path(loc.path)
-        loc
-      when options[:site]
-        SiteLocation.new(name, version_constraint, options)
-      else
-        SiteLocation.new(name, version_constraint, options)
-      end
+      @location = Location.init(name, version_constraint, options)
 
-      @locked_version = DepSelector::Version.new(options[:locked_version]) if options[:locked_version]
+      if @location.is_a?(PathLocation)
+        @cached_cookbook = CachedCookbook.from_path(@location.path)
+      end
+      
+      @locked_version = Solve::Version.new(options[:locked_version]) if options[:locked_version]
 
       add_group(options[:group]) if options[:group]
       add_group(:default) if groups.empty?
@@ -98,5 +172,16 @@ module Berkshelf
       def set_local_path(path)
         @local_path = path
       end
+
+      def validate_options(options)
+        invalid_options = options.keys - self.class.valid_options
+
+        unless invalid_options.empty?
+          invalid_options.collect! { |opt| "'#{opt}'" }
+          raise InternalError, "Invalid options for Cookbook Source: #{invalid_options.join(', ')}."
+        end
+
+        true
+      end
   end
 end