knife_cookbook_dependencies 0.0.3 → 0.0.5

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

@@ -1,37 +1,38 @@
-require 'knife_cookbook_dependencies/dsl'
-
 module KnifeCookbookDependencies
   class Cookbookfile
     class << self
       include DSL
-      def read content
+
+      def read(content)
         # This will populate KnifeCookbookDependencies.shelf. TODO: consider making this
         # build and return the shelf rather than building the shelf as
         # a side effect.
         instance_eval(content)
       end
 
-      def process_install
+      def process_install(without=nil)
         # TODO: friendly error message when the file doesn't exist
         
-        filename = KnifeCookbookDependencies::DEFAULT_FILENAME + ".lock"
+        filename = KCD::DEFAULT_FILENAME + ".lock"
         lockfile = false
 
         if File.exist?(filename)
           lockfile = true
         else
-          filename = KnifeCookbookDependencies::DEFAULT_FILENAME unless File.exist?(filename)
+          filename = KCD::DEFAULT_FILENAME unless File.exist?(filename)
         end
 
         begin
-          read File.open(filename).read
+          read File.read(filename)
         rescue Errno::ENOENT => e
-          KnifeCookbookDependencies.ui.fatal ErrorMessages.missing_cookbookfile
+          KCD.ui.fatal ErrorMessages.missing_cookbookfile
           exit 100
         end
-        KnifeCookbookDependencies.shelf.resolve_dependencies
-        KnifeCookbookDependencies.shelf.populate_cookbooks_directory
-        KnifeCookbookDependencies.shelf.write_lockfile unless lockfile
+
+        KCD.shelf.exclude(without)
+        KCD.shelf.resolve_dependencies
+        KCD.shelf.populate_cookbooks_directory
+        KCD.shelf.write_lockfile unless lockfile
       end
     end
   end

data/lib/kcd/dsl.rb

@@ -0,0 +1,13 @@
+module KnifeCookbookDependencies
+  module DSL
+    def cookbook(*args)
+      KCD.shelf.shelve_cookbook(*args)
+    end
+
+    def group *args
+      KCD.shelf.active_group = args
+      yield
+      KCD.shelf.active_group = nil
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module KnifeCookbookDependencies
   module ErrorMessages
     class << self
-      def missing_cookbook name
+      def missing_cookbook(name)
         "The cookbook #{name} was not found on the Opscode Community site. Provide a git or path key for #{name} if it is unpublished."
       end
 

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

@@ -4,7 +4,7 @@ require 'chef/config'
 module KnifeCookbookDependencies
   module KnifeUtils
     def self.capture_knife_output(knife_obj)
-      knife_obj.ui = Chef::Knife::UI.new(StringIO.new, StringIO.new, StringIO.new, { :format => :json })
+      knife_obj.ui = Chef::Knife::UI.new(StringIO.new, StringIO.new, StringIO.new, :format => :json)
       knife_obj.run
       knife_obj.ui.stdout.rewind
       knife_obj.ui.stdout.read

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

@@ -1,12 +1,10 @@
-require 'knife_cookbook_dependencies/cookbookfile'
-
 module KnifeCookbookDependencies
   class Lockfile
     def initialize(cookbooks)
       @cookbooks = cookbooks
     end
 
-    def write(filename = KnifeCookbookDependencies::DEFAULT_FILENAME)
+    def write(filename = KCD::DEFAULT_FILENAME)
       content = @cookbooks.map do |cookbook|
                   get_cookbook_definition(cookbook)
                 end.join("\n")
@@ -14,9 +12,14 @@ module KnifeCookbookDependencies
     end
 
     def get_cookbook_definition(cookbook)
-      definition = "cookbook '#{cookbook.name}', :locked_version => '#{cookbook.locked_version}'"
-      if cookbook.git_repo
+      definition = "cookbook '#{cookbook.name}'"
+
+      if cookbook.from_git?
         definition += ", :git => '#{cookbook.git_repo}', :ref => '#{cookbook.git_ref || 'HEAD'}'"
+      elsif cookbook.from_path?
+        definition += ", :path => '#{cookbook.local_path}'"
+      else
+        definition += ", :locked_version => '#{cookbook.locked_version}'"
       end
 
       return definition

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

@@ -2,7 +2,7 @@ module KnifeCookbookDependencies
   class MetaCookbook
     attr_reader :name, :dependencies
 
-    def initialize name, dependencies
+    def initialize(name, dependencies)
       @name = name
       @dependencies = dependencies
     end

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

@@ -1,10 +1,8 @@
-require 'knife_cookbook_dependencies/lockfile'
-
 module KnifeCookbookDependencies
   class Shelf
     META_COOKBOOK_NAME = 'cookbook_dependencies_shelf'
 
-    attr_accessor :cookbooks
+    attr_accessor :cookbooks, :active_group, :excluded_groups
 
     def initialize
       @cookbooks = []
@@ -17,8 +15,10 @@ module KnifeCookbookDependencies
     def resolve_dependencies
       graph = DepSelector::DependencyGraph.new
 
+      post_exclusions = requested_cookbooks
+      cookbooks_to_install = @cookbooks.select {|c| post_exclusions.include?(c.name)}
       # all cookbooks in the Cookbookfile are dependencies of the shelf
-      shelf = MetaCookbook.new(META_COOKBOOK_NAME, @cookbooks) 
+      shelf = MetaCookbook.new(META_COOKBOOK_NAME, cookbooks_to_install)
 
       self.class.populate_graph graph, shelf
 
@@ -29,7 +29,7 @@ module KnifeCookbookDependencies
     end
 
     def write_lockfile
-      KnifeCookbookDependencies::Lockfile.new(@cookbooks).write
+      KCD::Lockfile.new(@cookbooks).write
     end
 
     def get_cookbook(name)
@@ -50,6 +50,31 @@ module KnifeCookbookDependencies
       @cookbooks = @cookbooks.uniq.reject { |x| x.locked_version.nil? }
     end
 
+    def exclude(groups)
+      groups = groups.to_s.split(/[,:]/) unless groups.is_a?(Array)
+      @excluded_groups = groups.collect {|c| c.to_sym}
+    end
+
+    def cookbook_groups
+      {}.tap do |groups|
+        @cookbooks.each do |cookbook|
+          cookbook.groups.each do |group|
+            groups[group] ||= []
+            groups[group] << cookbook.name
+          end
+        end
+      end
+    end
+
+    def requested_cookbooks
+      return @cookbooks.collect(&:name) unless @excluded_groups
+      [].tap do |r|
+        cookbook_groups.each do |group, cookbooks|
+          r << cookbooks unless @excluded_groups.include?(group.to_sym)
+        end
+      end.flatten.uniq
+    end
+
     class << self
       def populate_graph(graph, cookbook)
         package = graph.package cookbook.name

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

@@ -1,3 +1,3 @@
 module KnifeCookbookDependencies
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/knife_cookbook_dependencies.rb

@@ -1,28 +1,32 @@
 require 'dep_selector'
 require 'zlib'
 require 'archive/tar/minitar'
-require 'chef/config'
-require 'chef/knife/cookbook_site_download'
-
-require 'knife_cookbook_dependencies/version'
-require 'knife_cookbook_dependencies/shelf'
-require 'knife_cookbook_dependencies/cookbook'
-require 'knife_cookbook_dependencies/metacookbook'
-require 'knife_cookbook_dependencies/dependency_reader'
-require 'knife_cookbook_dependencies/dsl'
-require 'knife_cookbook_dependencies/cookbookfile'
-require 'knife_cookbook_dependencies/git'
-require 'knife_cookbook_dependencies/error_messages'
+
+require 'kcd/version'
+require 'kcd/shelf'
+require 'kcd/cookbook'
+require 'kcd/metacookbook'
+require 'kcd/dsl'
+require 'kcd/cookbookfile'
+require 'kcd/lockfile'
+require 'kcd/git'
+require 'kcd/error_messages'
 
 module KnifeCookbookDependencies
   DEFAULT_FILENAME = 'Cookbookfile'
   COOKBOOKS_DIRECTORY = 'cookbooks'
 
+  autoload :KnifeUtils, 'kcd/knife_utils'
+
   class << self
     attr_accessor :ui
 
+    def root
+      File.join(File.dirname(__FILE__), '..')
+    end
+
     def shelf
-      @shelf ||= KnifeCookbookDependencies::Shelf.new
+      @shelf ||= KCD::Shelf.new
     end
 
     def clear_shelf!
@@ -39,3 +43,6 @@ module KnifeCookbookDependencies
     end
   end
 end
+
+# Alias for {KnifeCookbookDependencies}
+KCD = KnifeCookbookDependencies

data/spec/acceptance/knife_cookbook_dependencies_spec.rb

@@ -7,16 +7,6 @@ describe "knife cookbook dependencies install" do
   describe "should print a friendly error message" do
     include Aruba::Api
 
-    it "for missing cookbooks" do
-      pending "Knife commands produce no output when run with aruba. I'm not sure why." # TODO FIXME
-
-      cookbook_name = 'thisisamissingcookbook'
-      with_cookbookfile %Q[cookbook "#{cookbook_name}"] do
-        cmd = 'cat nofile' #'knife cookbook dependencies install'
-        process = run(cmd)
-        process.output(true).should match(/#{KnifeCookbookDependencies::ErrorMessages.missing_cookbook(cookbook_name)}/)
-      end
-    end
-    it "for missing Cookbookfile"
+    it "for --without option"
   end
 end

data/spec/fixtures/lockfile_spec/with_lock/Cookbookfile

@@ -0,0 +1 @@
+cookbook 'nginx', '= 0.101.0'

data/spec/fixtures/lockfile_spec/without_lock/Cookbookfile.lock

@@ -0,0 +1,5 @@
+cookbook 'nginx', :locked_version => '0.101.0'
+cookbook 'build-essential', :locked_version => '1.0.0'
+cookbook 'runit', :locked_version => '0.15.0'
+cookbook 'bluepill', :locked_version => '1.0.4'
+cookbook 'ohai', :locked_version => '1.0.2'

data/spec/lib/{knife_cookbook_dependencies → kcd}/cookbook_spec.rb

@@ -15,7 +15,7 @@ module KnifeCookbookDependencies
 
       # FIXME: This test is flakey
       it "should raise an error if the cookbook is unpacked without being downloaded first" do
-        -> { subject.unpack(subject.unpacked_cookbook_path, true, false) }.should raise_error
+        -> { subject.unpack(subject.unpacked_cookbook_path, :clean => true, :download => false) }.should raise_error
       end
 
       describe '#unpacked_cookbook_path' do
@@ -36,7 +36,7 @@ module KnifeCookbookDependencies
       describe "#copy_to" do
         it "should copy from the unpacked cookbook directory to the target" do
           example_cookbook_from_path.copy_to_cookbooks_directory
-          File.exists?(File.join(KnifeCookbookDependencies::COOKBOOKS_DIRECTORY, example_cookbook_from_path.name)).should be_true
+          File.exists?(File.join(KCD::COOKBOOKS_DIRECTORY, example_cookbook_from_path.name)).should be_true
         end
       end
     end
@@ -47,17 +47,9 @@ module KnifeCookbookDependencies
       end
     end
 
-    describe '#version_from_metadata_file' do
-      it "should be able to handle single quoted strings" do
-        Cookbook.any_instance.stub(:metadata_file).and_return(%Q{version '1.2.3'})
-
-        subject.version_from_metadata_file.should == DepSelector::Version.new('1.2.3')
-      end
-
-      it "should be able to handle double quoted strings" do
-        Cookbook.any_instance.stub(:metadata_file).and_return(%Q{version "1.2.3"})
-
-        subject.version_from_metadata_file.should == DepSelector::Version.new('1.2.3')
+    describe '#version_from_metadata' do
+      it "should return the correct version" do
+        subject.version_from_metadata.should == DepSelector::Version.new('1.1.8')
       end
     end
 
@@ -90,7 +82,14 @@ module KnifeCookbookDependencies
     describe '#dependencies' do
       it "should not contain the cookbook itself" do
         # TODO: Mock
-        Cookbook.new('riot_base', git: 'git@github.riotgames.com:cookbooks/riot_base.git').dependencies.collect(&:name).include?('riot_base').should_not be_true
+        Cookbook.new('nginx').dependencies.collect(&:name).include?('nginx').should_not be_true
+      end
+
+      it "should compute the correct dependencies" do
+        cookbook = Cookbook.new('mysql')
+        cookbook.dependencies.should == [Cookbook.new('openssl')]
+        # Second computation is intentional, to make sure it doesn't change the dependency list.
+        cookbook.dependencies.should == [Cookbook.new('openssl')]
       end
     end
 
@@ -102,5 +101,35 @@ module KnifeCookbookDependencies
     #     subject.unpack
     #   end
     # end
+
+    describe '#groups' do
+      it "should have the default group" do
+        subject.groups.should == [:default]
+      end
+    end
+
+    describe '#add_group' do
+      it "should store strings as symbols" do
+        subject.add_group "foo"
+        subject.groups.should == [:default, :foo]
+      end
+
+      it "should not store duplicate groups" do
+        subject.add_group "bar"
+        subject.add_group "bar"
+        subject.add_group :bar
+        subject.groups.should == [:default, :bar]
+      end
+
+      it "should add multiple groups" do
+        subject.add_group "baz", "quux"
+        subject.groups.should == [:default, :baz, :quux]
+      end
+
+      it "should handle multiple groups as an array" do
+        subject.add_group ["baz", "quux"]
+        subject.groups.should == [:default, :baz, :quux]
+      end
+    end
   end
 end

data/spec/lib/{knife_cookbook_dependencies → kcd}/cookbookfile_spec.rb

@@ -4,7 +4,7 @@ module KnifeCookbookDependencies
   describe Cookbookfile do
     describe '::read' do
       after do
-        KnifeCookbookDependencies.shelf.cookbooks.each(&:clean)
+        KCD.shelf.cookbooks.each(&:clean)
       end
 
       it "should read the cookbookfile and build a dependency list" do
@@ -16,10 +16,10 @@ cookbook 'ssh_known_hosts2', :git => 'https://github.com/erikh/chef-ssh_known_ho
 COOKBOOKFILE
 
         ['ntp', 'mysql', 'nginx', 'ssh_known_hosts2'].each do |dep|
-          KnifeCookbookDependencies.shelf.cookbooks.collect(&:name).should include dep
+          KCD.shelf.cookbooks.collect(&:name).should include dep
         end
 
-        KnifeCookbookDependencies.shelf.populate_cookbooks_directory
+        KCD.shelf.populate_cookbooks_directory
       end
     end
   end

data/spec/lib/kcd/dsl_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'kcd/dsl'
+
+module KnifeCookbookDependencies
+  describe DSL do
+    include DSL
+
+    describe "#cookbook" do
+      after do
+        KnifeCookbookDependencies.shelf.cookbooks.each(&:clean)
+      end
+
+      it 'should add the cookbooks to the shelf' do
+        cookbook "ntp"
+        cookbook "nginx"
+
+        ['ntp', 'nginx'].each do |cookbook|
+          KnifeCookbookDependencies.shelf.cookbooks.collect(&:name).should include cookbook
+        end
+      end
+
+      it 'should take version constraints' do
+        Cookbook.any_instance.stub(:clean)
+        cookbook 'ntp', '= 1.2.3'
+        KnifeCookbookDependencies.shelf.cookbooks.select {|c| c.name == 'ntp'}.first.version_constraints.first.should == DepSelector::VersionConstraint.new('= 1.2.3')
+      end
+
+      it 'should take group' do
+        cookbook 'nginx', :group => 'web'
+        KnifeCookbookDependencies.shelf.cookbooks.select {|c| c.name == 'nginx'}.first.groups.should == [:web]
+      end
+    end
+
+    describe '#group' do
+      it "should set the group on all cookbooks" do
+        cookbooks = %w[hashbrowns mashed_potatoes bourbon]
+        group "awesome" do
+          cookbooks.each {|c| cookbook c}
+        end
+        cookbooks.each do |c|
+          KnifeCookbookDependencies.shelf.cookbooks.select {|n| n.name == c}.first.groups.should == [:awesome]
+        end
+      end
+
+      it "should not set the group on cookbooks after the group" do
+        cookbooks = %w[apple orange strawberry]
+        group "fruit" do
+          cookbooks.each {|c| cookbook c}
+        end
+        cookbook 'sesame_chicken'
+        KnifeCookbookDependencies.shelf.cookbooks.select {|n| n.name == 'sesame_chicken'}.first.groups.should == [:default]
+      end
+
+    end
+  end
+end