vagrant-application-cookbooks 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+!example_box/Vagrantfile
+
+# Berkshelf
+cookbooks
+Berksfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format=doc
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+script:
+  - rake spec

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+# 0.1.0 (unreleased)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", "1.2.7",
+    :git => "https://github.com/mitchellh/vagrant.git",
+    :ref => "v1.2.7"
+  gem "berkshelf", "2.0.8"
+  gem "vagrant-omnibus", "1.1.1"
+  gem "vagrant-cachier", "0.3.3"
+end

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2013 Torben Knerr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Vagrant Application Cookbooks Plugin
+
+[![Build Status](https://travis-ci.org/tknerr/vagrant-application-cookbooks.png?branch=master)](https://travis-ci.org/tknerr/vagrant-application-cookbooks)
+
+
+This [Vagrant](http://www.vagrantup.com) 1.2+ plugin lets you specify application cookbooks to deploy your VMs with. It will take care of cloning the application cookbook from the Git repository, resolve its dependencies via Berkshelf, and configure the Chef Solo provisioner accordingly.
+
+## Features
+
+* allows you to deploy [application cookbooks](http://red-badger.com/blog/2013/06/24/berkshelf-application-cookbooks/) from a git repository (remote or local)
+* lets you choose a specific `ref` (i.e. commit, tag or branch) to deploy
+* resolves each VMs application cookbook dependencies in isolation to `.vagrant/app-cookbooks/<vm-name>/cookbooks/` (i.e. no inter-VM dependency conflicts)
+* uses the `Berksfile` that is shipped with the application cookbook to resolve dependencies
+* configures the `cookbooks_path` of the `:chef_solo` provisioner accordingly
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods or via bindler. 
+
+To deploy the `sample-app` application cookbook from the `master` branch:
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.define :sample do |sample_config|
+    sample_config.app_cookbook.url = "https://github.com/tknerr/sample-application-cookbook"
+    sample_config.vm.provision :chef_solo do |chef|
+      chef.add_recipe "sample-app"
+    end
+  end
+end
+```
+
+Or to deploy from a specific git `ref`, `branch` or `tag`:
+```ruby
+...
+    sample_config.app_cookbook.url = "https://github.com/tknerr/sample-application-cookbook"
+    sample_config.app_cookbook.ref = "some_ref"
+...
+```
+
+You can also use local file URLs:
+```ruby
+...
+    sample_config.app_cookbook.url = "file:///path/to/application-cookbook"
+...
+```
+
+
+## Development
+
+To work on the `vagrant-application-cookbooks` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+```
+$ bundle
+```
+
+Once you have the dependencies, verify the unit tests pass with `rake`:
+
+```
+$ bundle exec rake
+```
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by using the
+`Vagrantfile` in the top level of this directory and use bundler to execute Vagrant.
+
+To test that the `my_app` vm is deployed with the `sample-app` application cookbook simply run:
+```
+$ bundle exec vagrant up my_app
+```
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new
+
+# Default task is to run the unit tests
+task :default => "spec"

data/TODO.md

@@ -0,0 +1,17 @@
+
+# TODO
+
+[x] improve log/info output
+[-] configure app cookbook in chef_solo config rather than vm config
+[x] warn if cookbook_path is manually configured and will be overridden
+[x] skip everything (e.g. cloning, resolving deps) for vms which don't define an app cookbook
+[x] skip everything for vms which don't have a chef provisioner
+[x] support for cloning a specific ref / branch / tag
+[-] configure the default recipe automatically
+[ ] use Berkshelf Ruyb API rather than shelling out 
+[x] add spec tests for the config
+[ ] add spec tests for the clone action
+[ ] check if url is a valid url
+[ ] use i18n
+[ ] suppress stdout / stderr when shelling out git commands
+[ ] add support for more provisioners / dependency managers

data/Vagrantfile

@@ -0,0 +1,76 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# require plugin for testing via bundler
+Vagrant.require_plugin "vagrant-application-cookbooks"
+Vagrant.require_plugin "vagrant-omnibus"
+Vagrant.require_plugin "vagrant-cachier"
+
+Vagrant.configure("2") do |config|
+
+  config.omnibus.chef_version = "11.6.0"
+  config.cache.auto_detect = true
+
+  config.vm.box = "opscode_ubuntu-12.04_provisionerless"
+  config.vm.box_url = "https://opscode-vm-bento.s3.amazonaws.com/vagrant/opscode_ubuntu-12.04_provisionerless.box"
+
+  #
+  # configure vm to be deployed with application cookbook
+  #
+  config.vm.define :my_app do |my_app_config|
+    # app cookbook to deploy
+    my_app_config.app_cookbook.url = "https://github.com/tknerr/sample-application-cookbook"
+
+    my_app_config.vm.provision :chef_solo do |chef|
+      chef.add_recipe "sample-app"
+      chef.json = {
+        :sample_app => {
+          :words_of_wisdom => "Chuck Norris' beard can type 140 wpm!"
+        }
+      }
+    end
+  end
+
+  #
+  # example for deploying a specific branch
+  #
+  config.vm.define :my_app_branched do |my_app_config|
+    # app cookbook to deploy
+    my_app_config.app_cookbook.url = "https://github.com/tknerr/sample-application-cookbook"
+    my_app_config.app_cookbook.ref = "lxc"
+
+    my_app_config.vm.provision :chef_solo do |chef|
+      chef.add_recipe "sample-app"
+    end
+  end
+
+  #
+  # example using a local file url
+  #
+  config.vm.define :my_app_local_file do |my_app_config|
+    # app cookbook to deploy
+    my_app_config.app_cookbook.url = "file://D:/Repos/_github/_cookbooks/sample-application-cookbook"
+    
+    my_app_config.vm.provision :chef_solo do |chef|
+      chef.add_recipe "sample-app"
+    end
+  end
+
+  #
+  # example without application cookbook configured
+  #
+  config.vm.define :my_app_no_app_cookbook do |my_app_config|
+    my_app_config.vm.provision :chef_solo do |chef|
+      chef.add_recipe "sample-app"
+    end
+  end
+
+  #
+  # example without provisioner - should kick in here
+  #
+  config.vm.define :my_app_no_provisioner do |my_app_config|
+    # app cookbook to deploy
+    my_app_config.app_cookbook.url = "https://github.com/tknerr/sample-application-cookbook"
+  end
+
+end

data/lib/vagrant-application-cookbooks.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-application-cookbooks/plugin"
+
+module VagrantPlugins
+  module ApplicationCookbooks
+    lib_path = Pathname.new(File.expand_path("../vagrant-application-cookbooks", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-application-cookbooks/action.rb

@@ -0,0 +1,14 @@
+require 'pathname'
+
+module VagrantPlugins
+  module ApplicationCookbooks
+    module Action
+
+      def self.action_root
+        Pathname.new(File.expand_path("../action", __FILE__))
+      end
+
+      autoload :Clone, action_root.join("clone")
+    end
+  end
+end

data/lib/vagrant-application-cookbooks/action/clone.rb

@@ -0,0 +1,109 @@
+module VagrantPlugins
+  module ApplicationCookbooks
+    module Action
+      
+      # This middleware checks if reqiured plugins are present
+      class Clone
+
+        attr_reader :cloned_repo_path, :cookbook_install_path, :git_url, :git_ref
+
+        def initialize(app, env)
+          @app = app
+          @env = env
+
+          # machine-specific paths to clone git repo and install cookbooks
+          @cloned_repo_path = env[:root_path].join('.vagrant', 'app-cookbooks', env[:machine].name.to_s, 'repo')
+          @cookbook_install_path = env[:root_path].join('.vagrant', 'app-cookbooks', env[:machine].name.to_s, 'cookbooks')
+          
+          # shortcut for values from config
+          @git_url = env[:machine].config.app_cookbook.url
+          @git_ref = env[:machine].config.app_cookbook.ref
+        end
+
+        def provisioners(name)
+          @env[:machine].config.vm.provisioners.select{ |prov| prov.name == name }
+        end
+
+        def log(msg)
+          @env[:ui].info msg
+        end
+
+        def is_cloned?
+          File.exist?(cloned_repo_path) && get_origin.eql?(git_url)
+        end
+
+        def get_origin
+          `cd #{cloned_repo_path} && git config --get remote.origin.url`.strip
+        end
+
+        def cookbooks_path_configured?(provisioner)
+          # see https://github.com/mitchellh/vagrant/blob/master/plugins/provisioners/chef/config/chef_solo.rb#L41-45
+          provisioner.config.cookbooks_path != [[:host, "cookbooks"], [:vm, "cookbooks"]]
+        end
+
+        def has_chef_solo_provisioner?
+          provisioners(:chef_solo).size > 0
+        end
+
+        def app_cookbook_configured?
+          git_url != nil
+        end
+
+        def clean_and_clone_repo
+          FileUtils.rm_rf cloned_repo_path
+          FileUtils.mkdir_p cloned_repo_path
+          unless system("git clone #{git_url} #{cloned_repo_path}")
+            raise "something went wrong while cloning '#{git_url}'"
+          end
+        end
+
+        def update_and_checkout
+          unless system("cd #{cloned_repo_path} && git pull && git checkout #{git_ref}")
+            raise "something went wrong while updating / checking out '#{git_ref}'"
+          end
+        end
+
+        def install_cookbooks
+          unless system("cd #{cloned_repo_path} && berks install --path #{cookbook_install_path}")
+            raise "something went wrong while installing cookbook dependencies"
+          end
+        end
+
+        def configure_chef_solo
+          provisioners(:chef_solo).each do |provisioner|
+            if cookbooks_path_configured? provisioner
+              @env[:ui].warn "WARNING: already configured `cookbooks_path` will be overridden!"
+            end
+            provisioner.config.cookbooks_path = provisioner.config.send(:prepare_folders_config, cookbook_install_path)
+          end
+        end
+
+
+        def call(env)
+
+          if app_cookbook_configured? && has_chef_solo_provisioner?
+
+            if not is_cloned?
+              log "Cloning application cookbook from '#{git_url}'"
+              clean_and_clone_repo
+            else
+              log "Using application cookbook '#{git_url}'"
+            end
+
+            log "Ensuring application cookbook is checked out at '#{git_ref}'"
+            update_and_checkout
+
+            log "Installing application cookbook dependencies to '#{cookbook_install_path}'"
+            install_cookbooks
+
+            log "Configuring Chef Solo provisioner for application cookbook"
+            configure_chef_solo
+          end
+
+          # continue if ok
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-application-cookbooks/config.rb

@@ -0,0 +1,35 @@
+require "vagrant"
+
+module VagrantPlugins
+  module ApplicationCookbooks
+    class Config < Vagrant.plugin(2, :config)
+      
+      # git url to clone from
+      attr_accessor :url
+      # git ref / branch to checkout
+      attr_accessor :ref
+
+      def initialize
+        @url = UNSET_VALUE
+        @ref = UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = _detected_errors
+        if @ref != nil
+          errors << "'app_cookbook.url' must be specified when 'app_cookbook.ref' is used" if @url.nil?
+        end
+        { "vagrant-application-cookbooks" => errors }
+      end
+
+      def finalize!
+        @url = nil if @url == UNSET_VALUE
+        if @url != nil
+          @ref = 'master' if @ref == UNSET_VALUE
+        else
+          @ref = nil if @ref == UNSET_VALUE
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-application-cookbooks/plugin.rb

@@ -0,0 +1,32 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant ApplicationCookbooks plugin must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.2.0"
+  raise "The Vagrant ApplicationCookbooks plugin is only compatible with Vagrant 1.2+"
+end
+
+module VagrantPlugins
+  module ApplicationCookbooks
+    class Plugin < Vagrant.plugin("2")
+      name "ApplicationCookbooks"
+      description "This plugin allows you to deploy Application Cookbooks"
+
+      config "app_cookbook" do
+        require_relative "config"
+        Config
+      end
+
+      clone_action_hook = lambda do |hook|
+        hook.before Vagrant::Action::Builtin::ConfigValidate, VagrantPlugins::ApplicationCookbooks::Action::Clone
+      end
+      action_hook 'clone-application-cookbook-on-machine-up', :machine_action_up, &clone_action_hook
+      action_hook 'clone-application-cookbook-on-machine-reload', :machine_action_reload, &clone_action_hook
+      action_hook 'clone-application-cookbook-on-machine-provision', :machine_action_provision, &clone_action_hook
+    end
+  end
+end

data/lib/vagrant-application-cookbooks/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module ApplicationCookbooks
+    VERSION = "0.1.0"
+  end
+end

data/spec/vagrant-application-cookbooks/config_spec.rb

@@ -0,0 +1,40 @@
+require "vagrant-application-cookbooks/config"
+
+describe VagrantPlugins::ApplicationCookbooks::Config do
+  let(:instance) { described_class.new }
+
+  describe "defaults" do
+    subject do
+      instance.tap do |o|
+        o.finalize!
+      end
+    end
+
+    its("url")     { should be_nil }
+    its("ref")     { should be_nil }
+  end
+
+  describe "overriding defaults" do
+    it "should use the specified url with 'master' branch as default" do
+      instance.url = "https://github.com/some/repo"
+      instance.finalize!
+      instance.url.should == "https://github.com/some/repo"
+      instance.ref.should == "master"
+    end
+
+    it "should be possible to specify a different branch" do
+      instance.url = "https://github.com/some/repo"
+      instance.ref = "my_branch"
+      instance.finalize!
+      instance.url.should == "https://github.com/some/repo"
+      instance.ref.should == "my_branch"
+    end
+
+    it "should error if a branch is specified but no url" do
+      instance.ref = "my_branch"
+      instance.finalize!
+      err_hash = instance.validate(nil)
+      err_hash['vagrant-application-cookbooks'].size.should == 1
+    end
+  end
+end

data/vagrant-application-cookbooks.gemspec

@@ -0,0 +1,56 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-application-cookbooks/version"
+
+Gem::Specification.new do |s|
+  s.name          = "vagrant-application-cookbooks"
+  s.version       = VagrantPlugins::ApplicationCookbooks::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = "Torben Knerr"
+  s.email         = "mail@tknerr.de"
+  s.homepage      = "https://github.com/tknerr/vagrant-application-cookbooks"
+  s.summary       = "Deploy Chef \"Application Cookbooks\" directly from a Git repository"
+  s.description   = "Deploy Chef \"Application Cookbooks\" directly from a Git repository"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "vagrant-application-cookbooks"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec-core", "~> 2.12.2"
+  s.add_development_dependency "rspec-expectations", "~> 2.12.1"
+  s.add_development_dependency "rspec-mocks", "~> 2.12.1"
+
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  s.files         = unignored_files
+  s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  s.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-application-cookbooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Torben Knerr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+description: Deploy Chef "Application Cookbooks" directly from a Git repository
+email: mail@tknerr.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- lib/vagrant-application-cookbooks/action/clone.rb
+- lib/vagrant-application-cookbooks/action.rb
+- lib/vagrant-application-cookbooks/config.rb
+- lib/vagrant-application-cookbooks/plugin.rb
+- lib/vagrant-application-cookbooks/version.rb
+- lib/vagrant-application-cookbooks.rb
+- LICENSE
+- Rakefile
+- README.md
+- spec/vagrant-application-cookbooks/config_spec.rb
+- TODO.md
+- vagrant-application-cookbooks.gemspec
+- Vagrantfile
+- .gitignore
+- .rspec
+- .travis.yml
+homepage: https://github.com/tknerr/vagrant-application-cookbooks
+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'
+      segments:
+      - 0
+      hash: 37287891
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: vagrant-application-cookbooks
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Deploy Chef "Application Cookbooks" directly from a Git repository
+test_files: []