vagrant-cookbook-fetcher 0.0.6 → 0.0.7

data/README.md

@@ -5,7 +5,7 @@ A Vagrant plugin to automatically fetch cookbooks, roles, and such whenever you
 
 ## Behavior
 
-Once you set a URL that provides a list of checkouts, this plugin will create two directory trees:
+Once you set a URL in your Vagrantfile that provides a list of checkouts, this plugin will create two directory trees (checkouts and combined):
 
    my-vagrant-project
     |...Vagrantfile
@@ -16,6 +16,7 @@ Once you set a URL that provides a list of checkouts, this plugin will create tw
         |...roles
         |...nodes
         |...data_bags
+        |...specs
 
 The plugin will loop through the list of checkouts, perform a clone/checkout or pull/update to make sure the checkout exists in the 'checkouts' directory. 
 
@@ -38,7 +39,7 @@ The fields are: VCS,repo address, directory name, branch, credentials
 
 ## Configuration
 
-### config.auto_checkout.url
+### config.cookbook_fetcher.url
 
 Default: none.
 
@@ -46,11 +47,11 @@ URL that replies with a CSV file containing the list of checkouts.
 
 If absent, no fetch occurs.
 
-### config.auto_checkout.disable
+### config.cookbook_fetcher.disable
 
 Default: false
 
-If true, no checkout will be be run.  This can be useful if you're provisioning frequently and making local changes to your recipes.
+If true, no checkout will be be run.  This can be useful if you're provisioning frequently and making local changes to your recipes; if you use git rebase, your build will break whenever you have a local change and an incoming change at the same time.
 
 Even if the fetch is disabled, this plugin will still try to tell chef-solo about your cookbook, role, and data_bag paths, unless you override them.
 

data/lib/vagrant_cookbook_fetcher.rb

@@ -1,51 +1,41 @@
+module CookbookFetcher
 
-# http://vagrantup.com/v1/docs/extending/configuration.html
-class CookbookFetcherConfig < Vagrant::Config::Base
-  attr_accessor :url
-  attr_accessor :disable
-end
-Vagrant.config_keys.register(:cookbook_fetcher) { CookbookFetcherConfig }
-
-
-# This is a Vagrant middleware plugin
-# http://vagrantup.com/v1/docs/extending/middleware.html
-
-class CookbookFetcher
-  def initialize(app, env)
-    @app = app
+  # http://vagrantup.com/v1/docs/extending/configuration.html
+  class Config < Vagrant::Config::Base
+    attr_accessor :url
+    attr_accessor :disable
   end
+  Vagrant.config_keys.register(:cookbook_fetcher) { CookbookFetcher::Config }
 
-  def call(env)
+  # Utility method - reads the config, fetches the checkout list, 
+  # does the checkout, and does the crosslinks.  Expects cwd to be the root_path.
+  def perform_fetch (global_config, logger)
 
-    if !env[:global_config].cookbook_fetcher.disable then
-      if !env[:global_config].cookbook_fetcher.url.nil? then
-        fetch_checkouts env
-      else
-        env[:ui].warn "No URL set for auto-checkout, skipping"
-      end
-    else
-      env[:ui].info "Auto-checkout disabled, skipping"
+    unless global_config.cookbook_fetcher then
+      logger.warn "No config.cookbook_fetcher section found in Vagrantfile - skipping checkouts"
+      return
     end
 
-    # Continue daisy chain
-    @app.call(env) 
-  end
-
-
-  def fetch_checkouts (env) 
-    url = env[:global_config].cookbook_fetcher.url
-    env[:ui].info "Fetching checkout list from #{url}"
+    url = global_config.cookbook_fetcher.url
+    unless url then
+      logger.warn "No config.cookbook_fetcher.url value found in Vagrantfile - skipping checkouts"
+      return
+    end
     
-    checkouts = fetch_checkout_list url
-    perform_checkouts checkouts
-    update_links checkouts
+    checkouts = CookbookFetcher.fetch_checkout_list(url,logger)
+    CookbookFetcher.perform_checkouts(checkouts,logger)
+    CookbookFetcher.update_links(checkouts,logger)
   end
+  module_function :perform_fetch
 
-  def fetch_checkout_list (url)
+  # Utility method, fetches checkout list, parses it, 
+  # and writes cookbook order to a file in the current working directory.
+  def fetch_checkout_list (url, logger)
     require 'open-uri'
-
+    
     checkouts = { :by_dir => {}, :cookbook_list => [] } 
 
+    logger.info "Fetching checkout list from #{url}"
     open(url, {:ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE }) do |resp|
       resp.each do |line|
         line.chomp!
@@ -70,22 +60,23 @@ class CookbookFetcher
           File.open('.cookbook-order', 'w') do |f|
             f.print(checkouts[:cookbook_list].join("\n"))
           end
-
         end
       end
     end
-
     return checkouts
-
   end
+  module_function :fetch_checkout_list
 
-  def perform_checkouts (checkouts)
+  # Utility method.  Based on a parsed checkout list, 
+  # performs each of the checkouts, creating the checkouts/ directory in 
+  # the current directory.
+  def perform_checkouts (checkouts,logger)
 
     if !Dir.exists?("checkouts") then Dir.mkdir("checkouts") end
     
     Dir.chdir("checkouts") do  
       checkouts[:by_dir].each do |dir, info|
-        puts "Updating checkout '#{dir}'"
+        logger.info "Updating checkout '#{dir}'"
         if info[:vcs] == 'git' then
 
           if Dir.exists?(info[:dir]) then
@@ -103,11 +94,11 @@ class CookbookFetcher
                 unless system cmd then raise "Could not find branch or commit #{info[:branch]}" end
                 cmd = "git checkout -b #{info[:branch]} origin/#{info[:branch]}"
                 unless system cmd then raise "Could not '#{cmd}'" end
-              # no branch
+                # no branch
               elsif local_branch.empty? then
                 cmd = "git checkout #{info[:branch]}"
                 unless system cmd then raise "Could not '#{cmd}'" end
-              # local branch already exists
+                # local branch already exists
               else
                 cmd = "git checkout #{info[:branch]}"
                 unless system cmd then raise "Could not '#{cmd}'" end
@@ -132,7 +123,7 @@ class CookbookFetcher
                   cmd = "git checkout -B #{info[:branch]} origin/#{info[:branch]}"
                   unless system cmd then raise "Could not '#{cmd}'" end
                 end
-              #commit
+                #commit
               else
                 cmd = "git checkout #{info[:branch]}"
                 unless system cmd then raise "Could not '#{cmd}'" end
@@ -145,10 +136,14 @@ class CookbookFetcher
       end
     end
   end
+  module_function :perform_checkouts
 
-  def update_links (checkouts) 
-    things_to_link = ["roles", "nodes", "handlers", "data_bags"]
-    puts "Updating links to #{things_to_link.join(', ')}"
+  # Utility method - given a parsed checkout list, and assuming the checkout have
+  # already been performed, creates the combined/ directory in the current directory,
+  # and symlinks in the roles, nodes, etc.
+  def update_links (checkouts,logger) 
+    things_to_link = ["roles", "nodes", "handlers", "data_bags", "specs"]
+    logger.info "Updating links to #{things_to_link.join(', ')}"
 
     if !Dir.exists?("combined") then Dir.mkdir("combined") end
     Dir.chdir("combined") do  
@@ -202,64 +197,98 @@ class CookbookFetcher
       end
     end  
   end
+  module_function :update_links
 
+  # This is a Vagrant middleware plugin, which implements fetching the cookbooks
+  # http://vagrantup.com/v1/docs/extending/middleware.html
+  class FetchHook
+    def initialize(app, env)
+      @app = app
+    end
 
-end
+    def call(env)
+      if !env[:global_config].cookbook_fetcher.disable then
+        Dir.chdir(env[:root_path]) do
+          CookbookFetcher.perform_fetch(env[:global_config], env[:ui])
+        end
+      else
+        env[:ui].info "Auto-checkout disabled, skipping"
+      end
 
-Vagrant.actions[:provision].insert(Vagrant::Action::General::Validate, CookbookFetcher)
-# Note that :up includes :start ( see https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/action/builtin.rb )
-Vagrant.actions[:start].insert(Vagrant::Action::General::Validate, CookbookFetcher)
+      # Continue daisy chain
+      @app.call(env) 
+    end
+  end
 
+  # Install fetcher hook
+  Vagrant.actions[:provision].insert(Vagrant::Action::General::Validate, CookbookFetcher::FetchHook)
+  # Note that :up includes :start ( see https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/action/builtin.rb )
+  Vagrant.actions[:start].insert(Vagrant::Action::General::Validate, CookbookFetcher::FetchHook)
 
-# Injects auto-checkout-derived chef-solo config
-class CookbookFetcherConfigureChef 
-  def initialize(app, env)
-    @app = app
-  end
 
-  def call(env)
-    # Do this even if fetch is disabled
+  # Middleware to tweak chef config
+  # Injects auto-checkout-derived chef-solo config
+  class ConfigureChef 
+    def initialize(app, env)
+      @app = app
+    end
+
+    def call(env)
+      # Do this even if fetch is disabled
 
-    require 'pp'
-    # there has got to be a better way
-    provisioners_list = env[:vm].config.to_hash["keys"][:vm].provisioners 
+      # there has got to be a better way
+      provisioners_list = env[:vm].config.to_hash["keys"][:vm].provisioners 
 
-    chef_solo = provisioners_list.find { |p| p.shortcut === :chef_solo }
-    if !chef_solo.nil? then
-      solo_cfg = chef_solo.config
+      chef_solo = provisioners_list.find { |p| p.shortcut === :chef_solo }
+      if !chef_solo.nil? then
+        solo_cfg = chef_solo.config
       
-      if solo_cfg.roles_path.nil? then
-        solo_cfg.roles_path = "combined/roles"
-      else
-        env[:ui].warn "Auto-checkout is keeping your custom chef-solo role path"
-      end
+        # TODO - need cwd block
+        Dir.chdir(env[:root_path]) do
+          if solo_cfg.roles_path.nil? then
+            solo_cfg.roles_path = "combined/roles"
+          else
+            env[:ui].warn "Auto-checkout is keeping your custom chef-solo role path"
+          end
 
-      if solo_cfg.data_bags_path.nil? then
-        solo_cfg.data_bags_path = "combined/data_bags"
-      else
-        env[:ui].warn "Auto-checkout is keeping your custom chef-solo data_bags path"
-      end
+          if solo_cfg.data_bags_path.nil? then
+            solo_cfg.data_bags_path = "combined/data_bags"
+          else
+            env[:ui].warn "Auto-checkout is keeping your custom chef-solo data_bags path"
+          end
 
-      # Cookbooks has a default
-      if solo_cfg.cookbooks_path === ["cookbooks", [:vm, "cookbooks"]] then
-        # Read from filesystem
-        if !File.exists?(".cookbook-order") then
-          env[:ui].error "Auto-checkout could not a .cookbook-order file.  You need to run provision with autocheckout enabled at least once (or else specify your own cookbook path)"
-        end
+          # Cookbooks has a default
+          if solo_cfg.cookbooks_path === ["cookbooks", [:vm, "cookbooks"]] then
+            # Read from filesystem
+            if !File.exists?(".cookbook-order") then
+              env[:ui].error "Auto-checkout could find not a .cookbook-order file.  You need to run provision with autocheckout enabled at least once (or else specify your own cookbook path)"
+            end
 
-        cbs = []
-        IO.readlines(".cookbook-order").each { |line| cbs.push line.chomp }
-        solo_cfg.cookbooks_path = cbs
-      else
-        env[:ui].warn "Auto-checkout is keeping your custom chef-solo cookbook path"
+            cbs = []
+            IO.readlines(".cookbook-order").each { |line| cbs.push line.chomp }
+            solo_cfg.cookbooks_path = cbs
+          else
+            env[:ui].warn "Auto-checkout is keeping your custom chef-solo cookbook path"
+          end
+        end
       end
 
+      # Continue daisy chain
+      @app.call(env) 
     end
+  end
+
+  Vagrant.actions[:provision].insert(Vagrant::Action::VM::Provision, CookbookFetcher::ConfigureChef)
+  Vagrant.actions[:start].insert(Vagrant::Action::VM::Provision, CookbookFetcher::ConfigureChef)
 
-    # Continue daisy chain
-    @app.call(env) 
+  class CheckoutCommand < Vagrant::Command::Base
+    def execute
+      Dir.chdir(@env.root_path) do
+        CookbookFetcher.perform_fetch(@env.config.global, @env.ui)
+      end
+    end
   end
-end
+  Vagrant.commands.register(:checkout) { CookbookFetcher::CheckoutCommand }
 
-Vagrant.actions[:provision].insert(Vagrant::Action::VM::Provision, CookbookFetcherConfigureChef)
-Vagrant.actions[:start].insert(Vagrant::Action::VM::Provision, CookbookFetcherConfigureChef)
+
+end

metadata

@@ -1,68 +1,67 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vagrant-cookbook-fetcher
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Clinton Wolfe
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-25 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: Whenever you run start, up, or provision, this plugin will dynamically fetch a list of checkouts from a URL; checkout each one; then create a combined roles directory, with symlinks.
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+description: Whenever you run start, up, or provision, this plugin will dynamically
+  fetch a list of checkouts from a URL; checkout each one; then create a combined
+  roles directory, with symlinks.
 email: clinton@NOSPAM.omniti.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - ChangeLog
 - LICENSE
 - README.md
 - lib/vagrant_init.rb
 - lib/vagrant_cookbook_fetcher.rb
-has_rdoc: true
 homepage: https://github.com/clintoncwolfe/vagrant-cookbook-fetcher
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Fetch your Chef cookbooks whenever you provision
 test_files: []
-