knife_cookbook_dependencies 0.0.3 → 0.0.5

data/.gitignore

@@ -19,4 +19,7 @@ cookbooks
 *~
 *.tar*
 \#*
-Cookbookfile*
+^Cookbookfile*
+.DS_Store
+spec/fixtures/vcr_cassettes/*
+*.sw[op]

data/README.rdoc

@@ -1,6 +1,44 @@
 = Knife Cookbook Dependencies
 
-= Running tests
+A knife plugin to manage cookbook dependencies.
+
+== Getting Started
+
+To start, just install the plugin
+
+    $ gem install knife_cookbook_dependencies
+
+And add your dependencies to the Cookbookfile in the top-level of your repo
+
+    cookbook 'memcached'
+    cookbook 'ngnix'
+
+Install the dependencies to cookbooks/
+
+    $ knife cookbook dependencies install
+
+Put dependencies in a group so they can be ignored at deploy time. This is especially helpful
+when working with chef-solo.
+
+    group :solo do
+      cookbook 'base'
+    end
+
+If you only have 1 in the group, you can pass it as an option
+
+    cookbook 'base', :group => 'solo'
+
+By default, cookbooks are loaded from the community site. You can load them from a git repository
+
+    cookbook 'nfs', :git => 'git://github.com/RiotGames/cookbook-nfs.git'
+
+Or from a local path
+
+    cookbook 'myapp', :path => './cookbook'
+
+= Contributing
+
+== Running tests
 
 === Install prerequisites
 
@@ -27,4 +65,5 @@ Bundler will install all gems and their dependencies required for testing and de
 
 * Josiah Kiehl (<josiah@skirmisher.net>)
 * Jamie Winsor (<jamie@vialstudios.com>)
-* Erik Hollensbe (<erik@hollensbe.org>)
+* Erik Hollensbe (<erik@hollensbe.org>)
+* Michael Ivey (<ivey@gweezlebur.com>)

data/Rakefile

@@ -27,3 +27,45 @@ end
 
 task :check => [:default, "rdoc:check"]
 task :default => [:clean, :spec]
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run specs"
+  RSpec::Core::RakeTask.new(:spec) do |r|
+    r.rspec_path = "bundle exec rspec"
+  end
+rescue LoadError
+  desc 'RSpec rake task not available'
+  task :spec do
+    abort 'RSpec rake task is not available. Be sure to install rspec.'
+  end
+end
+
+begin
+  require 'cucumber'
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress --tags ~@wip --tags ~@live"
+  end
+
+  namespace :features do
+    Cucumber::Rake::Task.new(:wip) do |t|
+      t.cucumber_opts = "--format progress --tags @wip"
+    end
+
+    Cucumber::Rake::Task.new(:current) do |t|
+      t.cucumber_opts = "--format progress --tags @current"
+    end
+
+    Cucumber::Rake::Task.new(:tag) do |t|
+      t.cucumber_opts = "--format progress --tags @#{ENV['tag']}"
+    end
+  end       
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber.'
+  end
+end

data/features/lib/chef/knife/error_messages.feature

@@ -0,0 +1,16 @@
+Feature: Friendly error messages
+  As a CLI user
+  I want to have friendly human readable error messages
+  So I can identify what went wrong without ambiguity
+
+  Scenario: running without a Cookbookfile
+    When I run `knife cookbook dependencies install`
+    Then the output should contain "FATAL: There is no Cookbookfile in "
+
+  Scenario: when missing a cookbook
+    Given I write to "Cookbookfile" with:
+    """
+    cookbook "doesntexist"
+    """
+    When I run `knife cookbook dependencies install`
+    Then the output should contain "FATAL: The cookbook doesntexist was not found on the Opscode Community site. Provide a git or path key for doesntexist if it is unpublished."

data/features/lib/chef/knife/lockfile.feature

@@ -0,0 +1,25 @@
+Feature: Cookbookfile.lock
+  As a user
+  I want my versions to be locked even when I don't specify versions in my Cookbookfile 
+  So when I share my repository, all other developers get the same versions that I did when I installed.
+
+  @slow_process
+  Scenario: Writing the Cookbookfile.lock
+    Given I write to "Cookbookfile" with:
+    """
+    cookbook 'ntp'
+    cookbook 'mysql', git: 'https://github.com/opscode-cookbooks/mysql.git', :ref => '190c0c2267785b7b9b303369b8a64ed04364d5f9'
+    cookbook 'example_cookbook', path: File.join(KCD.root, 'spec', 'fixtures', 'cookbooks')
+    """
+    When I run `knife cookbook dependencies install`
+    When I sleep
+    Then a file named "Cookbookfile.lock" should exist in the current directory
+    And the file "Cookbookfile.lock" should contain in the current directory:
+    """
+    cookbook 'mysql', :git => 'https://github.com/opscode-cookbooks/mysql.git', :ref => '190c0c2267785b7b9b303369b8a64ed04364d5f9'
+    cookbook 'example_cookbook', :path => .*
+    cookbook 'ntp', :locked_version => '1.1.8'
+    cookbook 'openssl', :locked_version => '1.0.0'
+    cookbook 'windows', :locked_version => '1.2.12'
+    cookbook 'chef_handler', :locked_version => '1.0.6'
+    """

data/features/lib/chef/knife/without.feature

@@ -0,0 +1,27 @@
+Feature: --without block
+  As a user
+  I want to be able to exclude blocks in my Cookbookfile
+  So I can have cookbooks organized for use in different situations in a single Cookbookfile
+
+  @slow_process
+  Scenario: Exclude a block
+    Given I write to "Cookbookfile" with:
+    """
+    group :notme do
+      cookbook "nginx"
+    end
+    
+    cookbook "mysql"
+
+    group :takeme do
+      cookbook "ntp"
+    end
+    """
+    When I run `knife cookbook dependencies install --without notme`
+    Then the following directories should exist:
+    | cookbooks/mysql   |
+    | cookbooks/openssl |
+    | cookbooks/ntp     |
+    And the following directories should not exist:
+    | cookbooks/nginx |
+

data/features/support/env.rb

@@ -0,0 +1,30 @@
+require 'spork'
+
+Spork.prefork do
+  require 'rspec'
+  require 'pp'
+  require 'aruba/cucumber'
+  require 'vcr'
+  
+  APP_ROOT = File.expand_path('../../', __FILE__)
+  
+  Dir[File.join(APP_ROOT, "spec/support/**/*.rb")].each {|f| require f}
+
+  After do
+    KCD.clean
+  end
+
+  Around do |scenario, block|
+    VCR.use_cassette(scenario.title) do
+      block.call
+    end
+  end
+
+  Before('@slow_process') do
+    @aruba_io_wait_seconds = 5
+  end
+end
+
+Spork.each_run do
+  require 'kcd'
+end

data/features/support/step_definitions.rb

@@ -0,0 +1,22 @@
+Then /^I trace$/ do
+end
+
+When /^I sleep$/ do
+  sleep 10
+end
+
+Then /^a file named "(.*?)" should exist in the current directory$/ do |filename|
+  in_current_dir do
+    File.exists?(filename).should be_true # not sure why Aruba's
+                                          # #check_file_presence
+                                          # doesn't work here. It
+                                          # looks in the wrong
+                                          # directory.
+  end
+end
+
+Then /^the file "(.*?)" should contain in the current directory:$/ do |filename, string|
+  in_current_dir do
+    File.read(filename).should match(Regexp.new(string))
+  end
+end

data/knife_cookbook_dependencies.gemspec

@@ -1,5 +1,6 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/knife_cookbook_dependencies/version', __FILE__)
+# -*- encoding: utf-8; mode: ruby -*-
+
+require File.expand_path('../lib/kcd/version', __FILE__)
 
 Gem::Specification.new do |s|
   # TODO FIXME need to modify all of these
@@ -20,6 +21,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'chef',            '~> 0.10.0'
   s.add_runtime_dependency 'minitar'
 
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
   s.add_development_dependency 'aruba'
   s.add_development_dependency 'rake',        '~> 0.9.0'
   s.add_development_dependency 'rdoc',        '~> 3.0'

data/lib/chef/knife/cookbook_dependencies_install.rb

@@ -1,17 +1,23 @@
 require 'chef/knife'
-require 'knife_cookbook_dependencies'
+require 'kcd'
 
 module KnifeCookbookDependencies
   class CookbookDependenciesInstall < Chef::Knife
-    banner "knife cookbook dependencies install"
+    banner "knife cookbook dependencies install (options)"
+
+    option :without,
+      :short => "-W WITHOUT",
+      :long => "--without WITHOUT",
+      :description => "Exclude cookbooks that are in these groups"
 
     def run
       ui.info 'Reading Cookbookfile'
-      ::KnifeCookbookDependencies.ui = ui
-      ::KnifeCookbookDependencies::Cookbookfile.process_install
+      ::KCD.ui = ui
+      ::KCD::Cookbookfile.process_install(config[:without])
     end
   end
   
-  class CookbookDepsInstall < CookbookDependenciesInstall; end
-
+  class CookbookDepsInstall < CookbookDependenciesInstall
+    banner "knife cookbook deps install (options)"
+  end
 end

data/lib/kcd.rb

@@ -0,0 +1 @@
+require 'knife_cookbook_dependencies'

data/lib/{knife_cookbook_dependencies → kcd}/cookbook.rb

@@ -1,17 +1,17 @@
-require 'knife_cookbook_dependencies/knife_utils'
-require 'knife_cookbook_dependencies/git'
 require 'chef/knife/cookbook_site_download'
 require 'chef/knife/cookbook_site_show'
+require 'chef/cookbook/metadata'
 
 module KnifeCookbookDependencies
   class Cookbook
-    attr_reader :name, :version_constraints
+    attr_reader :name, :version_constraints, :groups
     attr_accessor :locked_version
 
     DOWNLOAD_LOCATION = ENV["TMPDIR"] || '/tmp'
 
-    def initialize *args
+    def initialize(*args)
       @options = args.last.is_a?(Hash) ? args.pop : {}
+      @groups = []
 
       if from_git? and from_path?
         raise "Invalid: path and git options provided to #{args[0]}. They are mutually exclusive."
@@ -21,14 +21,17 @@ module KnifeCookbookDependencies
       @name, constraint_string = args
 
       add_version_constraint(if from_path?
-                               "= #{version_from_metadata_file.to_s}"
+                               "= #{version_from_metadata.to_s}"
                              else
                                constraint_string
                              end)
       @locked_version = DepSelector::Version.new(@options[:locked_version]) if @options[:locked_version]
+      add_group(KnifeCookbookDependencies.shelf.active_group) if KnifeCookbookDependencies.shelf.active_group
+      add_group(@options[:group]) if @options[:group]
+      add_group(:default) if @groups.empty?
     end
 
-    def add_version_constraint constraint_string
+    def add_version_constraint(constraint_string)
       @version_constraints ||= []
       @version_constraints << DepSelector::VersionConstraint.new(constraint_string) unless @version_constraints.collect(&:to_s).include? constraint_string
     end
@@ -36,22 +39,21 @@ module KnifeCookbookDependencies
     def download(show_output = false)
       return if @downloaded
       return if !from_git? and downloaded_archive_exists?
+      return if from_path? and !from_git?
 
       if from_git? 
-        @git ||= KnifeCookbookDependencies::Git.new(@options[:git])
+        @git ||= KCD::Git.new(@options[:git])
         @git.clone
         @git.checkout(@options[:ref]) if @options[:ref]
         @options[:path] ||= @git.directory
-      elsif from_path?
-        return
       else
         csd = Chef::Knife::CookbookSiteDownload.new([name, latest_constrained_version.to_s, "--file", download_filename])
         rescue_404 do
-          output = KnifeCookbookDependencies::KnifeUtils.capture_knife_output(csd)
+          output = KCD::KnifeUtils.capture_knife_output(csd)
         end
 
         if show_output
-          puts output
+          output.split(/\r?\n/).each { |x| KCD.ui.info(x) }
         end
       end
 
@@ -59,69 +61,74 @@ module KnifeCookbookDependencies
     end
 
     def copy_to_cookbooks_directory
-      FileUtils.mkdir_p KnifeCookbookDependencies::COOKBOOKS_DIRECTORY
+      FileUtils.mkdir_p KCD::COOKBOOKS_DIRECTORY
 
-      target = File.join(KnifeCookbookDependencies::COOKBOOKS_DIRECTORY, @name)
+      target = File.join(KCD::COOKBOOKS_DIRECTORY, @name)
       FileUtils.rm_rf target
       FileUtils.cp_r full_path, target
       FileUtils.rm_rf File.join(target, '.git') if from_git?
     end
 
     # TODO: Clean up download repetition functionality here, in #download and the associated test.
-    def unpack(location = unpacked_cookbook_path, do_clean = false, do_download = true)
+    def unpack(location = unpacked_cookbook_path, options={})
       return true if from_path?
-      self.clean(File.join(location, @name)) if do_clean
-      download if do_download
-      fname = download_filename
-      if File.directory? location
-        true # noop
-      elsif downloaded_archive_exists?
-        Archive::Tar::Minitar.unpack(Zlib::GzipReader.new(File.open(fname)), location)
-        true
-      else
-        # TODO: Raise friendly error message class
+
+      clean     if options[:clean]
+      download  if options[:download]
+
+      unless downloaded_archive_exists? or File.directory?(location)
+        # TODO raise friendly error
         raise "Archive hasn't been downloaded yet"
       end
+
+      if downloaded_archive_exists?
+        Archive::Tar::Minitar.unpack(Zlib::GzipReader.new(File.open(download_filename)), location)
+      end
+
+      return true
     end
 
     def dependencies
       download
       unpack
-      @dependencies ||= DependencyReader.new(self).read
+
+      unless @dependencies
+        @dependencies = []
+        metadata.dependencies.each { |name, constraint| depends(name, constraint) }
+      end
+
+      @dependencies
     end
 
     def latest_constrained_version
       return @locked_version if @locked_version
-      return version_from_metadata_file if from_path? or from_git?
+      return version_from_metadata if from_path? or from_git?
 
       versions.reverse.each do |v|
         return v if version_constraints_include? v
       end
-      KnifeCookbookDependencies.ui.fatal "No version available to fit the following constraints for #{@name}: #{version_constraints.inspect}\nAvailable versions: #{versions.inspect}"
+      KCD.ui.fatal "No version available to fit the following constraints for #{@name}: #{version_constraints.inspect}\nAvailable versions: #{versions.inspect}"
       exit 1
     end
 
-    def version_constraints_include? version
+    def version_constraints_include?(version)
       @version_constraints.inject(true) { |check, constraint| check and constraint.include? version }
     end
 
     def versions
       return [latest_constrained_version] if @locked_version
-      return [version_from_metadata_file] if from_path? or from_git?
+      return [version_from_metadata] if from_path? or from_git?
       cookbook_data['versions'].collect { |v| DepSelector::Version.new(v.split(/\//).last.gsub(/_/, '.')) }.sort
     end
 
-    def version_from_metadata_file
-      # TODO: make a generic metadata file reader to replace
-      # dependencyreader and incorporate pulling the version as
-      # well... knife probably has something like this I can use/steal
-      DepSelector::Version.new(metadata_file.match(/version\s+[\"\']([0-9\.]*)[\"\']/)[1])
+    def version_from_metadata
+      DepSelector::Version.new(metadata.version)
     end
 
     def cookbook_data
       css = Chef::Knife::CookbookSiteShow.new([@name])
       rescue_404 do
-        @cookbook_data ||= JSON.parse(KnifeCookbookDependencies::KnifeUtils.capture_knife_output(css))
+        @cookbook_data ||= JSON.parse(KCD::KnifeUtils.capture_knife_output(css))
       end
     end
 
@@ -146,18 +153,25 @@ module KnifeCookbookDependencies
       File.join(full_path, "metadata.rb")
     end
 
-    def metadata_file
+    def metadata
       download
       unpack
-      File.open(metadata_filename).read
+
+      cookbook_metadata = Chef::Cookbook::Metadata.new
+      cookbook_metadata.from_file(metadata_filename)
+      cookbook_metadata
+    end
+
+    def local_path
+      @options[:path]
     end
 
     def from_path?
-      !!@options[:path]
+      !!local_path
     end
 
     def from_git?
-      !!@options[:git]
+      !!git_repo
     end
 
     def git_repo
@@ -168,6 +182,14 @@ module KnifeCookbookDependencies
       (from_git? && @git) ? @git.ref : nil
     end
 
+    def add_group(*groups)
+      groups = groups.first if groups.first.is_a?(Array)
+      groups.each do |group|
+        group = group.to_sym
+        @groups << group unless @groups.include?(group)
+      end
+    end
+
     def downloaded_archive_exists?
       download_filename && File.exists?(download_filename)
     end
@@ -189,9 +211,19 @@ module KnifeCookbookDependencies
       begin
         yield
       rescue Net::HTTPServerException => e
-        KnifeCookbookDependencies.ui.fatal ErrorMessages.missing_cookbook(@name) if e.message.match(/404/)
+        KCD.ui.fatal ErrorMessages.missing_cookbook(@name) if e.message.match(/404/)
         exit 100
       end
     end
+
+    private
+      def depends(name, constraint = nil)
+        dependency_cookbook = KCD.shelf.get_cookbook(name) || @dependencies.find { |c| c.name == name }
+        if dependency_cookbook
+          dependency_cookbook.add_version_constraint constraint
+        else
+          @dependencies << Cookbook.new(name, constraint) 
+        end
+      end
   end
 end