berkshelf 1.4.0.rc1 → 1.4.0

data/.gitignore

@@ -23,3 +23,4 @@ tmp
 *.sw[op]
 \.\#*
 rerun.txt
+.rspec

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p327
+1.9.3-p392

data/berkshelf.gemspec

@@ -40,8 +40,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'json', '>= 1.5.0'
   s.add_dependency 'multi_json', '~> 1.5'
   s.add_dependency 'solve', '>= 0.4.2'
-  s.add_dependency 'thor', '~> 0.16.0'
+  s.add_dependency 'thor', '~> 0.18.0'
   s.add_dependency 'retryable'
+  s.add_dependency 'addressable'
 
   s.add_development_dependency 'aruba'
   s.add_development_dependency 'cane'

data/features/contingent_command.feature

@@ -0,0 +1,18 @@
+Feature: contingent command
+  As a user with a Berksfile
+  I want a way to the cookbooks that depend on another
+  So that I can better understand my infrastructure
+
+  Scenario: Running the contingent command against a cookbook
+    Given I write to "Berksfile" with:
+      """
+      cookbook "database", "1.3.12"
+      """
+    And I successfully run `berks install`
+    When I run `berks contingent mysql`
+    Then the output should contain:
+      """
+      Cookbooks contingent upon mysql:
+        * database (1.3.12)
+      """
+    And the exit status should be 0

data/features/cookbook_command.feature

@@ -15,14 +15,16 @@ Feature: cookbook command
     And the exit status should be 0
 
   Examples:
-    | option       | feature    |
-    | foodcritic   | Foodcritic |
-    | scmversion   | SCMVersion |
-    | no-bundler   | no Bundler |
-    | skip-git     | no Git     |
-    | skip-vagrant | no Vagrant |
+    | option        | feature       |
+    | foodcritic    | Foodcritic    |
+    | chef-minitest | Chef-Minitest |
+    | scmversion    | SCMVersion    |
+    | no-bundler    | no Bundler    |
+    | skip-git      | no Git        |
+    | skip-vagrant  | no Vagrant    |
 
   Scenario Outline: creating a new cookbook skeleton with options without the supporting gem installed
+    Given the gem "<gem>" is not installed
     When I run the cookbook command to create "sparkle_motion" with options:
       | --<option> |
     Then I should have a new cookbook skeleton "sparkle_motion" with <feature> support
@@ -33,10 +35,10 @@ Feature: cookbook command
     | option     | feature    | gem             |
     | foodcritic | Foodcritic | foodcritic      |
     | scmversion | SCMVersion | thor-scmversion |
-    # | no-bundler   | no Bundler | bundler         |
 
-    @pending
   Scenario: creating a new cookbook skeleton with bundler support without bundler installed
-    Given pending "Bundler is used in tests, so it always appears available. Need to mock out the Gem::Specification.find_by_name, but aruba is out of process testing."
-
-
+    Given the gem "bundler" is not installed
+    When I run the cookbook command to create "sparkle_motion"
+    Then I should have a new cookbook skeleton "sparkle_motion"
+    And the output should contain a warning to suggest supporting the default for "bundler" by installing "bundler"
+    And the exit status should be 0

data/features/info_command.feature

@@ -0,0 +1,39 @@
+Feature: info command
+  As a user
+  I want to be able to view the metadata information of a cached cookbook
+  So that I can troubleshoot bugs or satisfy my own curiosity
+
+  Scenario: Running the info command with an installed cookbook name
+    Given the cookbook store has the cookbooks:
+      | mysql   | 2.1.2  |
+      | mysql   | 1.2.4  |
+      | mysql   | 0.10.0 |
+    When I successfully run `berks info mysql`
+    Then the output should contain "Name: mysql"
+    Then the output should contain "Version: 2.1.2"
+    Then the output should contain "Description: A fabulous new cookbook"
+    Then the output should contain "Author: YOUR_COMPANY_NAME"
+    Then the output should contain "Email: YOUR_EMAIL"
+    Then the output should contain "License: none"
+    And the exit status should be 0
+
+  Scenario: Running the info command with an installed cookbook name and a version
+    Given the cookbook store has the cookbooks:
+      | mysql   | 2.1.2  |
+      | mysql   | 1.2.4  |
+      | mysql   | 0.10.0 |
+    When I successfully run `berks info mysql --version 1.2.4`
+    Then the output should contain "Name: mysql"
+    Then the output should contain "Version: 1.2.4"
+    Then the output should contain "Description: A fabulous new cookbook"
+    Then the output should contain "Author: YOUR_COMPANY_NAME"
+    Then the output should contain "Email: YOUR_EMAIL"
+    Then the output should contain "License: none"
+    And the exit status should be 0
+
+  Scenario: Running the info command with a not installed cookbook name
+    Given the cookbook store has the cookbooks:
+      | mysql   | 2.1.2  |
+    When I run `berks info build-essential`
+    Then the output should contain "Cookbook 'build-essential' was not installed by your Berksfile"
+    And the CLI should exit with the status code for error "CookbookNotFound"

data/features/step_definitions/filesystem_steps.rb

@@ -115,6 +115,38 @@ Then /^I should have a new cookbook skeleton "(.*?)"$/ do |name|
   }
 end
 
+Then /^I should have a new cookbook skeleton "(.*?)" with Chef-Minitest support$/ do |name|
+  steps %Q{ Then I should have a new cookbook skeleton "#{name}" }
+
+  cb_path = Pathname.new(current_dir).join(name)
+  cb_path.should have_structure {
+    file "Berksfile" do
+      contains "cookbook \"minitest-handler\""
+    end
+    file "Vagrantfile" do
+      contains "recipe[minitest-handler::default]"
+    end
+    directory "files" do
+      directory "default" do
+        directory "tests" do
+          directory "minitest" do
+            file "default_test.rb" do
+              contains "describe '#{name}::default' do"
+              contains "include Helpers::#{name.capitalize}"
+            end
+            directory "support" do
+              file "helpers.rb" do
+                contains "module #{name.capitalize}"
+              end
+            end
+          end
+        end
+      end
+    end
+  }
+end
+
+
 Then /^I should have a new cookbook skeleton "(.*?)" with Foodcritic support$/ do |name|
   steps %Q{ Then I should have a new cookbook skeleton "#{name}" }
 

data/features/step_definitions/gem_steps.rb

@@ -1,5 +1,6 @@
 Given /^the gem "(.*)" is not installed$/ do |gem_name|
-  # Because aruba is out of process, need to figure out how to mock the Gem::Specification.find_by_name call to pretend gems are not available.
+  # @see berkshelf/test.rb
+  set_env 'MISSING_GEMS', [ENV['MISSING_GEMS'], gem_name].compact.join(',')
 end
 
 Then /^the output should contain a warning to suggest supporting the option "(.*?)" by installing "(.*?)"$/ do |option, gem_name|
@@ -7,5 +8,5 @@ Then /^the output should contain a warning to suggest supporting the option "(.*
 end
 
 Then /^the output should contain a warning to suggest supporting the default for "(.*?)" by installing "(.*?)"$/ do |option, gem_name|
-  step "the output should contain \"By default, this cookbook was generated to support #{gem_name}, however, #{gem_name} is not installed.\nTo skip support for #{gem_name}, use --#{option}\"\nTo install #{gem_name}: gem install #{gem_name}"
+  step "the output should contain \"By default, this cookbook was generated to support #{gem_name}, however, #{gem_name} is not installed.\nTo skip support for #{gem_name}, use --no-#{option}\"\nTo install #{gem_name}: gem install #{gem_name}"
 end

data/features/support/env.rb

@@ -1,3 +1,5 @@
+ENV['RUBY_ENV'] == 'test'
+
 require 'rubygems'
 require 'bundler'
 require 'spork'

data/generator_files/Berksfile.erb

@@ -1,4 +1,9 @@
 site :opscode
+<% if options[:chef_minitest] -%>
+group :integration do
+  cookbook "minitest-handler"
+end
+<% end -%>
 <% if options[:metadata_entry] -%>
 
 metadata

data/generator_files/Vagrantfile.erb

@@ -68,6 +68,10 @@ Vagrant.configure("2") do |config|
   # The path to the Berksfile to use with Vagrant Berkshelf
   # config.berkshelf.berksfile_path = "./Berksfile"
 
+  # Enabling the Berkshelf plugin. To enable this globally, add this configuration
+  # option to your ~/.vagrant.d/Vagrantfile file
+  config.berkshelf.enabled = true
+
   # An array of symbols representing groups of cookbook described in the Vagrantfile
   # to exclusively install and copy to Vagrant's shelf.
   # config.berkshelf.only = []
@@ -83,6 +87,9 @@ Vagrant.configure("2") do |config|
     chef.validation_key_path    = "<%= options[:berkshelf_config].chef.validation_key_path %>"
 
     chef.run_list = [
+  <% if options[:chef_minitest] -%>
+      "recipe[minitest-handler::default]",
+  <% end -%>
       "recipe[<%= cookbook_name %>::default]"
     ]
   end
@@ -97,6 +104,9 @@ Vagrant.configure("2") do |config|
     }
 
     chef.run_list = [
+  <% if options[:chef_minitest] -%>
+      "recipe[minitest-handler::default]",
+  <% end -%>
       "recipe[<%= cookbook_name %>::default]"
     ]
   end

data/generator_files/default_test.rb.erb

@@ -0,0 +1,11 @@
+require File.expand_path('../support/helpers', __FILE__)
+
+describe '<%= cookbook_name %>::default' do
+
+  include Helpers::<%= cookbook_name.capitalize.sub('-','_') %>
+
+  # Example spec tests can be found at http://git.io/Fahwsw
+  it 'runs no tests by default' do
+  end
+
+end

data/generator_files/helpers.rb.erb

@@ -0,0 +1,7 @@
+module Helpers
+  module <%= cookbook_name.capitalize.sub('-','_') %>
+    include MiniTest::Chef::Assertions
+    include MiniTest::Chef::Context
+    include MiniTest::Chef::Resources
+  end
+end

data/lib/berkshelf.rb

@@ -1,11 +1,11 @@
-require 'multi_json'
-require 'ridley'
 require 'chozo/core_ext'
 require 'active_support/core_ext'
 require 'archive/tar/minitar'
 require 'forwardable'
 require 'hashie'
+require 'multi_json'
 require 'pathname'
+require 'ridley'
 require 'solve'
 require 'thor'
 require 'tmpdir'
@@ -13,9 +13,10 @@ require 'uri'
 require 'zlib'
 require 'celluloid'
 
-require 'berkshelf/version'
 require 'berkshelf/core_ext'
 require 'berkshelf/errors'
+require 'berkshelf/test' if ENV['RUBY_ENV'] == 'test'
+require 'berkshelf/version'
 require 'thor/monkies'
 
 JSON.create_id = nil

data/lib/berkshelf/berksfile.rb

@@ -264,7 +264,7 @@ module Berkshelf
 
       options[:constraint] = constraint
 
-      @sources[name] = CookbookSource.new(name, options)
+      @sources[name] = CookbookSource.new(self, name, options)
     end
 
     # @param [#to_s] source
@@ -365,10 +365,7 @@ module Berkshelf
     #
     # @return [Array<Berkshelf::CachedCookbook>]
     def install(options = {})
-      resolver = Resolver.new(
-        self.downloader,
-        sources: sources(options)
-      )
+      resolver = Resolver.new(self, sources: sources(options))
 
       @cached_cookbooks = resolver.resolve
       write_lockfile(resolver.sources) unless lockfile_present?
@@ -389,10 +386,7 @@ module Berkshelf
     # @option cookbooks [String, Array] :cookbooks
     #   Names of the cookbooks to retrieve sources for
     def update(options = {})
-      resolver = Resolver.new(
-        self.downloader,
-        sources: sources(options)
-      )
+      resolver = Resolver.new(self, sources: sources(options))
 
       cookbooks         = resolver.resolve
       sources           = resolver.sources
@@ -503,9 +497,9 @@ module Berkshelf
         raise UploadFailure, "Missing required attribute in your Berkshelf configuration: chef.client_key"
       end
 
-      conn        = Ridley.new(ridley_options)
       solution    = resolve(options)
       upload_opts = options.slice(:force, :freeze)
+      conn        = Ridley.new(ridley_options)
 
       solution.each do |cb|
         Berkshelf.formatter.upload(cb.cookbook_name, cb.version, conn.server_url)
@@ -596,11 +590,7 @@ module Berkshelf
       #
       # @return <Berkshelf::Resolver>
       def resolver(options = {})
-        Resolver.new(
-          self.downloader,
-          sources: sources(options),
-          skip_dependencies: options[:skip_dependencies]
-        )
+        Resolver.new(self, sources: sources(options), skip_dependencies: options[:skip_dependencies])
       end
 
       def write_lockfile(sources)

data/lib/berkshelf/cached_cookbook.rb

@@ -23,5 +23,23 @@ module Berkshelf
     def dependencies
       metadata.recommendations.merge(metadata.dependencies)
     end
+
+    def pretty_print
+      [].tap do |a|
+        a.push "        Name: #{cookbook_name}" unless name.blank?
+        a.push "     Version: #{version}" unless version.blank?
+        a.push " Description: #{metadata.description}" unless metadata.description.blank?
+        a.push "      Author: #{metadata.maintainer}" unless metadata.maintainer.blank?
+        a.push "       Email: #{metadata.maintainer_email}" unless metadata.maintainer_email.blank?
+        a.push "     License: #{metadata.license}" unless metadata.license.blank?
+        a.push "   Platforms: #{pretty_map(metadata.platforms, 14)}" unless metadata.platforms.blank?
+        a.push "Dependencies: #{pretty_map(dependencies, 14)}" unless dependencies.blank?
+      end.join("\n")
+    end
+
+    private
+      def pretty_map(hash, padding)
+        hash.map { |k,v| "#{k} (#{v})" }.join("\n" + ' '*padding)
+      end
   end
 end

data/lib/berkshelf/chef/config.rb

@@ -8,15 +8,6 @@ module Berkshelf::Chef
   #
   # Inspired by and a dependency-free replacement for {https://raw.github.com/opscode/chef/11.4.0/lib/chef/config.rb}
   class Config
-    # List taken from: http://wiki.opscode.com/display/chef/Chef+Configuration+Settings
-    # Listed in order of preferred preference
-    KNIFE_LOCATIONS = [
-      './.chef/knife.rb',
-      '~/.chef/knife.rb',
-      '/etc/chef/solo.rb',
-      '/etc/chef/client.rb'
-    ].freeze
-
     class << self
       # Load and return a Chef::Config for Berkshelf. The location of the configuration to be loaded
       # can be configured by setting a value for {Berkshelf::Chef::Config.path=}
@@ -34,29 +25,27 @@ module Berkshelf::Chef
       # Return the most sensible path to the Chef configuration file. This can be configured by setting a
       # value for the 'BERKSHELF_CHEF_CONFIG' environment variable.
       #
-      # If no value is set for the environment variable then a search will begin for a configuration at these paths
-      # in this order:
-      #
-      # * './chef/knife.rb'
-      # * '~/.chef/knife.rb',
-      # * '/etc/chef/solo.rb'
-      # * '/etc/chef/client.rb'
-      #
       # @return [String, nil]
       def path
         @path ||= begin
-          possibles = KNIFE_LOCATIONS.dup
+          possibles = []
+
+          possibles << ENV['BERKSHELF_CHEF_CONFIG'] if ENV['BERKSHELF_CHEF_CONFIG']
+          possibles << File.join(ENV['KNIFE_HOME'], 'knife.rb') if ENV['KNIFE_HOME']
+          possibles << File.join(working_dir, 'knife.rb') if working_dir
 
-          unless ENV['BERKSHELF_CHEF_CONFIG'].nil?
-            possibles.unshift(ENV['BERKSHELF_CHEF_CONFIG'])
-          end
+          # Ascending search for .chef directory siblings
+          Pathname.new(working_dir).ascend do |file|
+            sibling_chef = File.join(file, '.chef')
+            possibles << File.join(sibling_chef, 'knife.rb')
+          end if working_dir
 
-          location = possibles.find do |location|
-            File.exists?(File.expand_path(location))
-          end
-          location ||= "~/.chef/knife.rb"
+          possibles << File.join(ENV['HOME'], '.chef', 'knife.rb') if ENV['HOME']
+          possibles.compact!
 
-          File.expand_path(location)
+          location = possibles.find { |loc| File.exists?(File.expand_path(loc)) }
+
+          File.expand_path(location) unless location.nil?
         end
       end
 
@@ -67,6 +56,12 @@ module Berkshelf::Chef
         @instance = nil
         @path     = value
       end
+
+      private
+
+        def working_dir
+          ENV['PWD'] || Dir.pwd
+        end
     end
 
     extend Berkshelf::Mixin::PathHelpers

data/lib/berkshelf/cli.rb

@@ -15,7 +15,7 @@ module Berkshelf
           end
         else
           super
-          Berkshelf.formatter.cleanup_hook unless config[:current_task].name == "help"
+          Berkshelf.formatter.cleanup_hook unless config[:current_command].name == "help"
         end
       end
     end
@@ -331,10 +331,8 @@ module Berkshelf
       desc: "Path to a Berksfile to operate off of.",
       aliases: "-b",
       banner: "PATH"
-    desc "show [COOKBOOK]", "Display the source path on the local file system for the given cookbook"
-    def show(name = nil)
-      return list if name.nil?
-
+    desc "show COOKBOOK", "Display the source path on the local file system for the given cookbook"
+    def show(name)
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
       cookbook = Berkshelf.ui.mute { berksfile.resolve }.find{ |cookbook| cookbook.cookbook_name == name }
 
@@ -342,6 +340,40 @@ module Berkshelf
       Berkshelf.ui.say(cookbook.path)
     end
 
+    method_option :version,
+      type: :string,
+      desc: 'The version of the cookbook to display.',
+      aliases: '-v'
+    desc "info [COOKBOOK]", "Display name, author, copyright, and dependency information about a cookbook"
+    def info(name)
+      if options[:version]
+        cookbook = Berkshelf.cookbook_store.cookbook(name, options[:version])
+      else
+        cookbook = Berkshelf.cookbook_store.cookbooks(name).sort_by(&:version).last
+      end
+
+      raise CookbookNotFound, "Cookbook '#{name}' was not installed by your Berksfile" if cookbook.nil?
+      Berkshelf.ui.say(cookbook.pretty_print)
+    end
+
+    method_option :berksfile,
+      type: :string,
+      default: File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME),
+      desc: "Path to a Berksfile to operate off of.",
+      aliases: "-b",
+      banner: "PATH"
+    desc "contingent COOKBOOK", "Display a list of cookbooks that depend on the given cookbook"
+    def contingent(name)
+      berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
+
+      Berkshelf.ui.say "Cookbooks contingent upon #{name}:"
+      sources = Berkshelf.ui.mute { berksfile.resolve }.sort.each do |cookbook|
+        if cookbook.dependencies.include?(name)
+          Berkshelf.ui.say "  * #{cookbook.cookbook_name} (#{cookbook.version})"
+        end
+      end
+    end
+
     desc "version", "Display version and copyright information"
     def version
       Berkshelf.formatter.msg version_header
@@ -352,6 +384,9 @@ module Berkshelf
     method_option :foodcritic,
       type: :boolean,
       desc: "Creates a Thorfile with Foodcritic support to lint test your cookbook"
+    method_option :chef_minitest,
+      type: :boolean,
+      desc: "Creates chef-minitest support files and directories, adds minitest-handler cookbook to run_list of Vagrantfile"
     method_option :scmversion,
       type: :boolean,
       desc: "Creates a Thorfile with SCMVersion support to manage versions for continuous integration"