capistrano-paratrooper-chef 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-paratrooper-chef.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Takeshi KOMIYA
+
+MIT License
+
+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,131 @@
+# Paratrooper-chef
+
+A capistrano recipe to execute chef-solo in each server.
+All of you can use chef-solo remotely without chef-server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-paratrooper-chef'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-paratrooper-chef
+
+## Usage
+
+This recipe will execute chef-solo through paratrooper:chef task.
+
+To setup paratrooper-chef for your application, add following in you config/deploy.rb.
+
+    # in "config/deploy.rb"
+    require 'capistrano-paratrooper-chef'
+
+And then, put your chef-kitchen files to config/ directory. 
+by default, paratrooper-chef uses following files and directories.
+
+* config/solo.rb
+* config/cookbooks
+* config/site-cookbooks
+* config/roles
+* config/data_bags
+
+Finally, run capistrano with paratrooper:chef task. Then chef-solo runs at remote host.
+
+    $ cap paratrooper:chef
+
+
+## Setup chef-solo to remote hosts
+
+Paratrooper-chef includes another task to setup chef-solo to remote hosts.
+To enable it, add following in your config/deploy.rb.
+
+    # in "config/deploy.rb"
+    require "capistrano-paratrooper-chef/install"
+
+This recipe will install chef-solo during deploy:setup task.
+
+## Define attributes for specific host
+
+Paratrooper-chef supports switching attributes for each host.
+Put definition to config/nodes/#{hostname}.json.
+
+If there are no defitions for host, paratrooper-chef uses config/solo.rb as attributes.
+
+## Chef roles Auto discovery
+
+Chef roles auto discovery appends roles of chef to run_list of each host.
+To enable auto discovery, set :chef_roles_auto_discovery true (as defualt, it is disabled).
+
+   # in "config/deploy.rb"
+   set :chef_roles_auto_discovery, true
+
+This feature makes name-based relations with role of capistrano and chef's one::
+* Discovering role definitions of chef from role-names of capistrano that server is assigned
+* Run chef with discovered roles at each server
+* Be able to play different roles of chef for each server
+
+
+For example, 'web.example.com' plays :web role:
+
+   set :web, 'web.example.com'
+
+And, there is role defition named 'web.json'.
+
+   # config/roles/web.json
+   {
+     "nginx" : {
+       # ...
+     },
+     "run_list" : [
+       "recipe[nginx]",
+     }
+   }
+
+Then, paratrooper-chef detects automatically these relation, and append 'role[web]' to run_list of web.example.com .
+(do not effect to other hosts)
+
+## Options
+
+Following options are available.
+
+* Settings for remote host
+
+    * `:chef_solo_path` - the path of `chef-solo` command. use `chef-solo` by default (search command from $PATH).
+    * `:chef_working_dir` - the path where chef-kitchen should installed. use `$HOME/chef-solo` by default.
+    * `:chef_cache_dir` - the path for caches. use `/var/chef/cache` by default.
+
+* Settings for chef and paratrooper
+
+    * `:chef_roles_auto_discovery` - Enable "Chef roles Auto discovery". use `false` by default.
+    * `:chef_verbose_logging`, - Enable verbose logging mode of `chef-solo`. use `true` by default.
+    * `:chef_debug` - Enable debug mode of `chef-solo`. use `false` by default.
+
+* Settings for directories
+
+    * `:chef_kitchen_path` - root directory of kitchen. use `config` by default.
+    * `:chef_default_solo_json_path` - default attribute file a.k.a solo.json. use `solo.json` by default. 
+    * `:chef_cookbooks_path` - cookbooks directories list. use `["cookbooks", "site-cookbooks"]` by default.
+    * `:chef_nodes_path` - nodes directory. use `nodes` by default.
+    * `:chef_roles_path` - roles directory. use `roles` by default.
+    * `:chef_databagas_path` - data bags directory. use `data_bagas` by default.
+
+## Support recipes
+
+Following recipes work fine with paratrooper-chef.
+
+* rvm-capistrano (https://github.com/wayneeseguin/rvm-capistrano)
+* capistrano-rbenv (https://github.com/yyuu/capistrano-rbenv)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/capistrano-paratrooper-chef.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano-paratrooper-chef/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Takeshi KOMIYA"]
+  gem.email         = ["i.tkomiya@gmail.com"]
+  gem.description   = %q{A capistrano task to invoke chef-solo}
+  gem.summary       = %q{A capistrano task to invoke chef-solo}
+  gem.homepage      = "https://github.com/tk0miya/capistrano-paratrooper-chef"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "capistrano-paratrooper-chef"
+  gem.require_paths = ["lib"]
+  gem.version       = Capistrano::Paratrooper::Chef::VERSION
+
+  gem.add_dependency("capistrano")
+end

data/lib/capistrano-paratrooper-chef.rb

@@ -0,0 +1,206 @@
+require "json"
+require "tempfile"
+require "capistrano-paratrooper-chef/version"
+
+
+Capistrano::Configuration.instance.load do
+  namespace :paratrooper do
+    # directory structure of chef-kitchen
+    set :chef_kitchen_path, "config"
+    set :chef_default_solo_json_path, "solo.json"
+    set :chef_cookbooks_path, ["cookbooks", "site-cookbooks"]
+    set :chef_nodes_path, "nodes"
+    set :chef_roles_path, "roles"
+    set :chef_databags_path, "data_bags"
+
+    # remote chef settings
+    set :chef_solo_path, "chef-solo"
+    set :chef_working_dir, "chef-solo"
+    set :chef_cache_dir, "/var/chef/cache"
+
+    # chef settings
+    set :chef_roles_auto_discovery, false
+    set :chef_verbose_logging, true
+    set :chef_debug, false
+
+    def sudocmd
+      envvars = fetch(:default_environment, {}).collect{|k, v| "#{k}=#{v}"}
+
+      begin
+        old_sudo = self[:sudo]
+        if fetch(:rvm_type, nil) == :user
+          self[:sudo] = "rvmsudo_secure_path=1 #{File.join(rvm_bin_path, "rvmsudo")}"
+        end
+
+        if envvars
+          cmd = "#{top.sudo} env #{envvars.join(" ")}"
+        else
+          cmd = top.sudo
+        end
+      ensure
+        self[:sudo] = old_sudo  if old_sudo
+      end
+
+      cmd
+    end
+
+    def sudo(command, *args)
+      run "#{sudocmd} #{command}", *args
+    end
+
+    def remote_path(*path)
+      File.join(fetch(:chef_working_dir), *path)
+    end
+
+    def cookbooks_paths
+      fetch(:chef_cookbooks_path).collect{|path| File.join(fetch(:chef_kitchen_path), path)}
+    end
+
+    def roles_path
+      File.join(fetch(:chef_kitchen_path), fetch(:chef_roles_path))
+    end
+
+    def role_exists?(name)
+      File.exist?(File.join(roles_path, name.to_s + ".json")) ||
+      File.exist?(File.join(roles_path, name.to_s + ".rb"))
+    end
+
+    def databags_path
+      File.join(fetch(:chef_kitchen_path), fetch(:chef_databags_path))
+    end
+
+    def nodes_path
+      File.join(fetch(:chef_kitchen_path), fetch(:chef_nodes_path))
+    end
+
+
+    namespace :run_list do
+      def solo_json_path_for(name)
+        path = File.join(nodes_path, name.to_s + ".json")
+        if File.exist?(path)
+          path
+        else
+          File.join(fetch(:chef_kitchen_path), fetch(:chef_default_solo_json_path))
+        end
+      end
+
+      def discover
+        find_servers_for_task(current_task).each do |server|
+          begin
+            open(solo_json_path_for(server.host)) do |fd|
+              server.options[:chef_attributes] = JSON.load(fd)
+
+              if server.options[:chef_attributes]["run_list"].nil?
+                server.options[:chef_attributes]["run_list"] = []
+              end
+            end
+          rescue
+            server.options[:chef_attributes] = attrs = {"run_list" => []}
+          end
+
+          if fetch(:chef_roles_auto_discovery)
+            role_names_for_host(server).each do |role|
+              server.options[:chef_attributes]["run_list"] << "role[#{role}]"  if role_exists?(role)
+            end
+          end
+        end
+      end
+
+      def discovered_attributes
+        find_servers_for_task(current_task).collect{|server| server.options[:chef_attributes]}.compact
+      end
+
+      def discovered_lists
+        discovered_attributes.collect{|attr| attr["run_list"]}
+      end
+
+      def unique?
+        if fetch(:chef_roles_auto_discovery)
+          discovered_lists.uniq.size == 1
+        else
+          true
+        end
+      end
+
+      def ensure
+        if discovered_lists.all?{|run_list| run_list.empty?}
+          abort "You must specify at least one recipe or role"
+        end
+      end
+    end
+
+    namespace :chef do
+      task :default, :except => { :no_release => true } do
+        run_list.discover
+        run_list.ensure
+        kitchen.ensure_cookbooks
+        kitchen.ensure_working_dir
+        kitchen.upload
+        chef.generate_solo_rb
+        chef.generate_solo_json
+        chef.execute
+      end
+
+      task :solo, :except => { :no_release => true } do
+        chef.default
+      end
+
+      def generate_solo_rb
+        config = <<-CONF
+          root = File.expand_path(File.dirname(__FILE__))
+          file_cache_path #{fetch(:chef_cache_dir).inspect}
+          cookbook_path #{kitchen.cookbooks_paths.inspect}.collect{|dir| File.join(root, dir)}
+          role_path File.join(root, #{kitchen.roles_path.inspect})
+          data_bag_path File.join(root, #{kitchen.databags_path.inspect})
+          verbose_logging #{fetch(:chef_verbose_logging)}
+        CONF
+        put config, remote_path("solo.rb"), :via => :scp
+      end
+
+      def generate_solo_json
+        find_servers_for_task(current_task).each do |server|
+          put server.options[:chef_attributes].to_json, remote_path("solo.json"), :hosts => server.host, :via => :scp
+        end
+      end
+
+      desc "Run chef-solo"
+      task :execute, :except => { :no_release => true } do
+        logger.info "Now running chef-solo"
+        command = "#{chef_solo_path} -c #{remote_path("solo.rb")} -j #{remote_path("solo.json")}#{' -l debug' if fetch(:chef_debug)}"
+        if run_list.unique?
+          sudo command
+        else
+          parallel do |session|
+            session.when "options[:chef_attributes]['run_list'].size > 0",
+              "#{sudocmd} #{command}"
+          end
+        end
+      end
+    end
+
+    namespace :kitchen do
+      def ensure_cookbooks
+        abort "No cookbooks found in #{fetch(:cookbooks_directory).inspect}" if kitchen.cookbooks_paths.empty?
+      end
+
+      def ensure_working_dir
+        run "rm -rf #{fetch(:chef_working_dir)} && mkdir -p #{fetch(:chef_working_dir)}"
+        sudo "mkdir -p #{fetch(:chef_cache_dir)}"
+      end
+
+      desc "Upload files in kitchen"
+      task :upload, :except => { :no_release => true } do
+        kitchen_paths = [cookbooks_paths, roles_path, databags_path].flatten.compact.select{|d| File.exists?(d)}
+        tarball = Tempfile.new("kitchen.tar")
+        begin
+          tarball.close
+          system "tar -czf #{tarball.path} #{kitchen_paths.join(' ')}"
+          top.upload tarball.path, remote_path("kitchen.tar"), :via => :scp
+          run "cd #{fetch(:chef_working_dir)} && tar -xzf kitchen.tar"
+        ensure
+          tarball.unlink
+        end
+      end
+    end
+  end
+end

data/lib/capistrano-paratrooper-chef/install.rb

@@ -0,0 +1,41 @@
+require 'capistrano-paratrooper-chef'
+
+Capistrano::Configuration.instance.load do
+  namespace :paratrooper do
+    namespace :chef do
+      set :chef_version, ">= 11.0.0"
+
+      on :load do
+        if top.namespaces.key?(:rbenv)
+          after "rbenv:setup", "paratrooper:chef:setup"
+        elsif top.namespaces.key?(:rvm)
+          after "rvm:install_ruby", "paratrooper:chef:setup"
+        else
+          after "deploy:setup" "paratrooper:chef:setup"
+        end
+      end
+
+      desc "Installs chef"
+      task :setup, :except => { :no_release => true } do
+        required_version = fetch(:chef_version).inspect
+        installed = capture("gem list -i chef -v #{required_version} || true").strip
+
+        if installed == "false"
+          if fetch(:rvm_type, nil) == :user or fetch(:rbenv_path, nil)
+            run "gem uninstall -xaI chef || true"
+            run "gem install chef -v #{fetch(:chef_version).inspect} --quiet --no-ri --no-rdoc"
+            run "gem install ruby-shadow --quiet --no-ri --no-rdoc"
+
+            if fetch(:rbenv_path, nil)
+              rbenv.rehash
+            end
+          else
+            sudo "gem uninstall -xaI chef || true"
+            sudo "gem install chef -v #{fetch(:chef_version).inspect} --quiet --no-ri --no-rdoc"
+            sudo "gem install ruby-shadow --quiet --no-ri --no-rdoc"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano-paratrooper-chef/version.rb

@@ -0,0 +1,7 @@
+module Capistrano
+  module Paratrooper
+    module Chef
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-paratrooper-chef
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Takeshi KOMIYA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A capistrano task to invoke chef-solo
+email:
+- i.tkomiya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-paratrooper-chef.gemspec
+- lib/capistrano-paratrooper-chef.rb
+- lib/capistrano-paratrooper-chef/install.rb
+- lib/capistrano-paratrooper-chef/version.rb
+homepage: https://github.com/tk0miya/capistrano-paratrooper-chef
+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.24
+signing_key: 
+specification_version: 3
+summary: A capistrano task to invoke chef-solo
+test_files: []