vagrant-cookbook-fetcher 0.0.4

data/LICENSE

@@ -0,0 +1,29 @@
+Copyright (c) 2012, OmniTI Computer Consulting, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name OmniTI Computer Consulting, Inc. nor the names
+      of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,62 @@
+vagrant-cookbook-fetcher
+========================
+
+A Vagrant plugin to automatically fetch cookbooks, roles, and such whenever you run vagrant provision, up or start.
+
+## Behavior
+
+Once you set a URL that provides a list of checkouts, this plugin will create two directory trees:
+
+   my-vagrant-project
+    |...Vagrantfile
+    |...checkouts
+    |   |...checkout-foo
+    |   |...checkout-bar
+    |...combined
+        |...roles
+        |...nodes
+        |...data_bags
+
+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. 
+
+Next, the plugin creates the 'combined' directory.  Each checkout that has a roles directory gets its roles symlinked to; likewise for data bags and nodes.  This feature allows you to have roles defined in multiple checkouts, and used from your local project.  In the event of name collisions, the later checkout wins.  The links are specially constructed to be valid from within the VM, so long as the v-root remains mounted at /vagrant .
+
+Finally, the plugin configures chef-solo, setting the cookbook path (to an ordered array of the checkouts's cookbooks directories), the roles path (to the combined path), and the databags path (to the combined path).  
+
+## Checkout List Format
+
+    git,src@src.omniti.com:~internal/chef/common,omniti-internal-common,multi-repo,chef.key
+    git,git@trac-il.omniti.net:myproject/support/chef,myproject-chef,master,AGENT
+    git,https://github.com/opscode-cookbooks/php.git,opscode-php/cookbooks/php,master,NONE
+
+The fields are: VCS,repo address, directory name, branch, credentials
+ * VCS may be either 'git' or 'svn' (TODO).
+ * repo address is the identifier of the repository from which to obtain the checkout.
+ * directory name is the path under <vagrant-root>/checkouts to clone/checkout into.  It may contain slashes.
+ * branch is the name of the git branch.  Leave blank for svn (use repo address for svn branching)
+ * (this feature is TODO) credentials is the method to authenticate to the repo server.  NONE means use no authentication.  AGENT means to rely on a running ssh-agent to provide credentials.  All other values are taken to specify the location of a SSH private key, relative to <vagrant-root>, that should be used with a GIT_SSH wrapper.
+
+## Configuration
+
+### config.auto_checkout.url
+
+Default: none.
+
+URL that replies with a CSV file containing the list of checkouts.
+
+If absent, no fetch occurs.
+
+### config.auto_checkout.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.
+
+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.
+
+## TODO
+
+ * Add svn support
+ * Actually respect the credentials column
+ * Make checkout list format less awful, add headers
+ * support chef, not just chef-solo

data/lib/vagrant_cookbook_fetcher.rb

@@ -0,0 +1,205 @@
+
+# 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
+  end
+
+  def call(env)
+
+    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"
+    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}"
+    
+    checkouts = fetch_checkout_list url
+    perform_checkouts checkouts
+    update_links checkouts
+  end
+
+  def fetch_checkout_list (url)
+    require 'open-uri'
+
+    checkouts = { :by_dir => {}, :cookbook_list => [] } 
+
+    open(url, {:ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE }) do |resp|
+      resp.each do |line|
+        line.chomp!
+        if !line.empty? then
+          pieces = line.split(/,/)
+          branch = pieces[3]
+          dir = pieces[2]
+
+          # Build info hash
+          checkouts[:by_dir][dir] = {
+            :vcs => pieces[0],
+            :repo => pieces[1],
+            :dir => dir,
+            :branch => pieces[3],
+            :creds => pieces[4],          
+          }
+          
+          # Build cookbook list.  Use first part of directory, and append cookbooks
+          checkouts[:cookbook_list].push 'checkouts/' + (dir.split('/'))[0] + '/cookbooks'
+
+          # Write cookbook order to a file, in case we are later disabled
+          File.open('.cookbook-order', 'w') do |f|
+            f.print(checkouts[:cookbook_list].join("\n"))
+          end
+
+        end
+      end
+    end
+
+    return checkouts
+
+  end
+
+  def perform_checkouts (checkouts)
+
+    if !Dir.exists?("checkouts") then Dir.mkdir("checkouts") end
+    
+    Dir.chdir("checkouts") do  
+      checkouts[:by_dir].each do |dir, info|
+        puts "Updating checkout '#{dir}'"
+        if info[:vcs] == 'git' then
+
+          if Dir.exists?(info[:dir]) then
+            # pull
+            Dir.chdir(info[:dir]) do
+              # TODO ignores git creds
+              cmd = "git checkout #{info[:branch]}"
+              unless system cmd then raise "Could not '#{cmd}'" end
+              cmd = "git pull"
+              unless system cmd then raise "Could not '#{cmd}'" end
+            end
+          else
+            # clone
+            cmd = "git clone -b #{info[:branch]} #{info[:repo]} #{info[:dir]}"
+            unless system cmd then raise "Could not '#{cmd}'" end
+          end
+        else
+          raise "Unsupported VCS '#{info[:vcs]}' in checkout list for entry '#{dir}'"
+        end
+      end
+    end
+  end
+
+  def update_links (checkouts) 
+    things_to_link = ["roles", "nodes", "handlers", "data_bags"]
+    puts "Updating links to #{things_to_link.join(', ')}"
+
+    if !Dir.exists?("combined") then Dir.mkdir("combined") end
+    Dir.chdir("combined") do  
+
+      # Create/clear the subdirs
+      things_to_link.each do |thing|
+        if !Dir.exists?(thing) then Dir.mkdir(thing) end
+        Dir.foreach(thing) do |file|
+          if FileTest.symlink?(file) then File.delete(file) end
+        end
+      end
+    end
+
+    # Being careful to go in cookbook order, symlink the files
+    checkouts[:cookbook_list].each do |cookbook_dir|
+      checkout_dir = (cookbook_dir.split('/'))[1]
+      things_to_link.each do |thing|
+        co_thing_dir = "checkouts/#{checkout_dir}/#{thing}"
+        combined_dir = "combined/#{thing}"
+        if Dir.exists?(co_thing_dir) then
+          Dir.entries(co_thing_dir).grep(/\.(rb|json)$/).each do |file|
+            # Under vagrant, we see this directory as /vagrant/checkouts/foo/role/bar.rb
+            # Use -f so later checkouts can override earlier ones
+            cmd = "ln -sf /vagrant/#{co_thing_dir}/#{file} combined/#{thing}/#{file}"
+            unless system cmd then raise "Could not '#{cmd}'" end
+          end
+        end
+      end
+    end  
+  end
+
+
+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)
+
+
+# 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
+
+    require 'pp'
+    # 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
+      
+      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
+
+      # 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
+
+        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
+
+    # Continue daisy chain
+    @app.call(env) 
+  end
+end
+
+Vagrant.actions[:provision].insert(Vagrant::Action::VM::Provision, CookbookFetcherConfigureChef)
+Vagrant.actions[:start].insert(Vagrant::Action::VM::Provision, CookbookFetcherConfigureChef)

data/lib/vagrant_init.rb

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

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-cookbook-fetcher
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Clinton Wolfe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-09 00:00:00.000000000 Z
+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.
+email: clinton@NOSPAM.omniti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/vagrant_init.rb
+- lib/vagrant_cookbook_fetcher.rb
+homepage: https://github.com/clintoncwolfe/vagrant-cookbook-fetcher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Fetch your Chef cookbooks whenever you provision
+test_files: []