capistrano-bundle_rsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 230c7ac05986a116441bf2c1d1322efc1ad936b3
+  data.tar.gz: e9919ec57dddf809f1757f7d00feb0b27431ef5f
+SHA512:
+  metadata.gz: 8394fcb8707bbaecf7185b2b80dc947677c58228127391b67cdb636f5c075596475e2ccf56a66972a96d7c34f5f65ed4a95c919df3fda5637e3ca8223d187162
+  data.tar.gz: 726fbbab18998b824396c1f266a4e2fa36e9f44ed36950ba412e08855b3c7cc933a0dc5ed8dff2d314b8433ea4b386813774f35f294f8b3c3cb8661b5f9e6dfb

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/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.2 (2014/07/08)
+
+First version

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Naotoshi Seo
+
+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,184 @@
+# Capistrano::BundleRsync for Capistrano v3
+
+Deploy an application and bundled gems via rsync
+
+## What is this for?
+
+Capistrano::BundleRsync requires to bundle gems only once on the deploy machine,
+which saves you from building gems on each your production machine. 
+
+Also saves you from having to install Git and Build Tools on your production machine.
+
+## How it works
+
+Capistrano::BundleRsync works as followings:
+
+1. Do `git clone --mirror URL .local_repo/repo` on a deploy (local) machine.
+2. Extract a branch by `git archive {branch}` to `.local_repo/release_{time}`
+4. Deploy the `release` directory to remote machines by `rsync`. 
+3. Do `bundle --without development,test --path .local_repo/bundle` on a deploy (local) machine.
+5. Deploy the `bundle` directory to remote machines by `rsync`.
+
+## Prerequisites
+
+The deploy machine and remote machines must be on same architectures (i386, x86\_64) because
+C exntension gems are built on the deploy machine and transfered by rsync. 
+
+Requiremens on remote machines:
+
+1. rbenv (rvm should work, but not verified)
+2. ruby
+
+Requirements on a deploy machine:
+
+1. rbenv (rvm should work, but not verified)
+2. git
+3. Build Tools required to build C exntension gems (like gcc).
+4. A ruby to execute capistrano (you may use the ruby of 5.)
+5. The same ruby used at your remote machines
+6. A ssh key to login to your remote machines via ssh (Passowrd authentication is not supported)
+
+Notice that it is not required to have Git and Build Tools on each remote machine. 
+
+## Configuration
+
+Set Capistrano variables with `set name, value`.
+
+Name          | Default | Description
+--------------|---------|------------
+repo_url      | `.` | The path or URL to a Git repository to clone from.  
+branch        | `master` | The Git branch to checkout.  
+ssh_options   | `{}`  | Configuration of ssh :user and :keys.
+bundle_rsync_local_base_path   | `$(pwd)/.local_repo` | The working base directory
+bundle_rsync_local_repo_path | `#{base_path}/repo"` | Path where to mirror your repository
+bundle_rsync_local_release_path | `"#{base_path}/relase_#{Time.now.to_i}"` | Path where to checkout your repository
+bundle_rsync_local_bundle_path | `"#{base_path}/bundle"` | Path where to bundle install gems.
+bundle_rsync_local_bin_path | `"#{base_path}/bin"` | Path where to bundle install bin scripts.
+bundle_rsync_config_files | `nil` | Additional files to rsync. Specified files are copied into `config` directory.
+bundle_rsync_ssh_options | `ssh_options` | Configuration of ssh for rsync. Default uses the value of `ssh_options`
+bundle_rsync_max_parallels | number of hosts | Number of concurrency. The default is the number of hosts to deploy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-bundle_rsync'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-bundle_rsync
+
+## Usage
+
+Add followings to your Gemfile:
+
+```ruby
+gem 'capistrano'
+gem 'capistrano-rbenv'
+gem 'capistrano-bundle_rsync'
+```
+
+Run `bundle exec cap install`. 
+
+```bash
+$ bundle
+$ bundle exec cap install
+```
+
+This creates the following files:
+
+```
+├── Capfile
+├── config
+│   ├── deploy
+│   │   ├── production.rb
+│   │   └── staging.rb
+│   └── deploy.rb
+└── lib
+    └── capistrano
+            └── tasks
+```
+
+To create different stages:
+
+```bash
+$ bundle exec cap install STAGES=localhost,sandbox,qa,production
+```
+
+Edit Capfile:
+
+```ruby
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+require 'capistrano/rbenv'
+require 'capistrano/bundle_rsync'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }
+```
+
+Edit `config/deploy/localhost.rb` as followings for example:
+
+```ruby
+set :branch, ENV['BRANCH'] || 'master'
+set :rbenv_type, :user
+set :linked_dirs, %w(bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system tmp/run)
+set :keep_releases, 5
+set :scm, :bundle_rsync # Need this
+set :bundle_rsync_max_parallels, ENV['PARA']
+set :bundle_rsync_config_files, ['~/config/database.yml']
+
+set :application, 'sample'
+set :repo_url, "git@github.com:sonots/rails-sample.git"
+set :deploy_to, "/home/sonots/sample"
+set :rbenv_ruby, "2.1.2" # Required on both deploy machine and remote machines
+set :ssh_options, user: 'sonots', keys: [File.expand_path('~/.ssh/id_rsa'), File.expand_path('~/.ssh/id_dsa')]
+
+role :app, ['127.0.0.1']
+```
+
+Deploy by following command:
+
+```bash
+$ bundle exec cap localhost deploy
+```
+
+## FAQ
+
+Q. What is difference with [capistrano-rsync](https://github.com/moll/capistrano-rsync)?
+
+A. capistrano-bundle\_rsync does `bundle install` at the deploy machine, not on each remote machine. 
+
+## ToDo
+
+1. Support rsync_options
+2. Support other SCMs than `git`. 
+
+## ChangeLog
+
+[CHANGELOG.md](./CHANGELOG.md)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+See [LICENSE.txt](./LICENSE.txt) for details.
+
+## Special Thanks
+
+capistrano-bundle_rsync was originally created by [@tohae](https://github.com/tohae). Thank you very much!

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-bundle_rsync.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-bundle_rsync"
+  spec.version       = "0.1.0"
+  spec.authors       = ["sonots", "tohae"]
+  spec.email         = ["sonots@gmail.com", "tohaechan@gmail.com"]
+  spec.description   = %q{Deploy an application and bundled gems via rsync}
+  spec.summary       = %q{Deploy an application and bundled gems via rsync.}
+  spec.homepage      = "https://github.com/sonots/capistrano-bundle_rsync"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '>= 3.0.0'
+  spec.add_dependency 'parallel'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/bundle_rsync.rb

@@ -0,0 +1,7 @@
+module Capistrano
+  module BundleRsync
+  end
+end
+
+require 'capistrano/bundle_rsync/config'
+load File.expand_path('../tasks/bundle_rsync.rake', __FILE__)

data/lib/capistrano/bundle_rsync/config.rb

@@ -0,0 +1,78 @@
+module Capistrano::BundleRsync
+  class Config
+    def self.local_base_path
+      @local_base_path ||= fetch(:bundle_rsync_local_base_path) || "#{Dir::pwd}/.local_repo"
+    end
+
+    def self.local_repo_path
+      @local_repo_path ||= fetch(:bundle_rsync_local_repo_path) || "#{local_base_path}/repo"
+    end
+
+    def self.local_release_path
+      @local_release_path ||= fetch(:bundle_rsync_local_release_path) || "#{local_base_path}/release_#{Time.now.to_i}"
+    end
+
+    def self.local_bundle_path
+      @local_bundle_path ||= fetch(:bundle_rsync_local_bundle_path) || "#{local_base_path}/bundle"
+    end
+
+    def self.local_bin_path
+      @local_bin_path ||= fetch(:bundle_rsync_local_bin_path) || "#{local_base_path}/bin"
+    end
+
+    def self.config_files
+      return nil unless config_files = fetch(:bundle_rsync_config_files)
+      config_files.is_a?(Array) ? config_files : [config_files]
+    end
+
+    # Build ssh command options for rsync
+    #
+    # First, search available user and keys configurations for each role:
+    #
+    #     role :app, ['hostname'], {
+    #       user: username,
+    #       keys: File.expand_path('~/.ssh/id_rsa'),
+    #       port: 22,
+    #     }
+    #
+    # If not available, look :bundle_rsync_ssh_options:
+    #
+    #     set :bundle_rsync_ssh_options {
+    #       user: username,
+    #       keys: [File.expand_path('~/.ssh/id_rsa')],
+    #       port: 22,
+    #     }
+    #
+    # If :bundle_rsync_ssh_options are not available also, look :ssh_options finally:
+    #
+    #     set :ssh_options {
+    #       user: username,
+    #       keys: [File.expand_path('~/.ssh/id_rsa')],
+    #       port: 22,
+    #     }
+    #
+    # `keys` can be a string or an array.
+    # NOTE: :password is not supported.
+    def self.build_ssh_command(host)
+      user_opt, key_opt, port_opt = "", "", ""
+      ssh_options = fetch(:bundle_rsync_ssh_options) || fetch(:ssh_options)
+      if user = host.user || ssh_options[:user]
+        user_opt = " -l #{user}"
+      end
+      if keys = (host.keys.empty? ? ssh_options[:keys] : host.keys)
+        keys = keys.is_a?(Array) ? keys : [keys]
+        key_opt = keys.map {|key| " -i #{key}" }.join("")
+      end
+      if port = host.port || ssh_options[:port]
+        port_opt = " -p #{port}"
+      end
+      "ssh#{user_opt}#{key_opt}#{port_opt}"
+    end
+
+    # Fetch the :bundle_rsync_max_parallels,
+    # where the default is the number of hosts
+    def self.max_parallels(hosts)
+      fetch(:bundle_rsync_max_parallels) || hosts.size
+    end
+  end
+end

data/lib/capistrano/tasks/bundle_rsync.rake

@@ -0,0 +1,125 @@
+unless defined?(Capistrano::BundleRsync::TASK_LOADED) # protect multiple loads
+Capistrano::BundleRsync::TASK_LOADED = true
+require 'fileutils'
+require 'parallel'
+
+namespace :bundle_rsync do
+  def config
+    Capistrano::BundleRsync::Config
+  end
+
+  namespace :bundler do
+    task :install do
+      hosts = roles(:all)
+      on hosts, in: :groups, limit: config.max_parallels(hosts) do
+        within release_path do
+          execute :mkdir, '-p', '.bundle'
+        end
+      end
+
+      run_locally do
+        Bundler.with_clean_env do
+          execute :bundle, "--gemfile #{config.local_release_path}/Gemfile --deployment --quiet --path #{config.local_bundle_path} --without development test --binstubs=#{config.local_bin_path}"
+        end
+
+        lines = <<-EOS
+---
+BUNDLE_FROZEN: '1'
+BUNDLE_PATH: #{shared_path.join('bundle')}
+BUNDLE_WITHOUT: development:test
+BUNDLE_DISABLE_SHARED_GEMS: '1'
+BUNDLE_BIN: #{shared_path.join('bin')}
+        EOS
+        bundle_config_path = "#{config.local_base_path}/bundle_config"
+        File.open(bundle_config_path, "w") {|file| file.print(lines) }
+
+        Parallel.each(hosts, in_processes: config.max_parallels(hosts)) do |host|
+          ssh = config.build_ssh_command(host)
+          if config_files = config.config_files
+            config_files.each do |config_file|
+              basename = File.basename(config_file)
+              execute :rsync, "-az --delete --rsh='#{ssh}' #{config_file} #{host}:#{release_path}/config/#{basename}"
+            end
+          end
+
+          execute :rsync, "-az --delete --rsh='#{ssh}' #{config.local_bundle_path}/ #{host}:#{shared_path}/bundle/"
+          execute :rsync, "-az --delete --rsh='#{ssh}' #{config.local_bin_path}/ #{host}:#{shared_path}/bin/"
+          execute :rsync, "-az --delete --rsh='#{ssh}' #{bundle_config_path} #{host}:#{release_path}/.bundle/config"
+        end
+
+        FileUtils.rm_rf(config.local_release_path)
+      end
+    end
+  end
+
+  desc 'Check that the repository is reachable'
+  task :check do
+    fetch(:branch)
+    run_locally do
+      exit 1 unless execute("git ls-remote #{repo_url}")
+      execute("mkdir -p #{config.local_base_path}")
+    end
+  end
+
+  desc 'Clone the repo to the cache'
+  task :clone do
+    run_locally do
+      if File.exist?("#{config.local_repo_path}/HEAD")
+        info t(:mirror_exists, at: config.local_repo_path)
+      else
+        execute :git, :clone, '--mirror', repo_url, config.local_repo_path
+      end
+    end
+  end
+
+  desc 'Update the repo mirror to reflect the origin state'
+  task update: :'bundle_rsync:clone' do
+    run_locally do
+      within config.local_repo_path do
+        execute :git, :remote, :update
+      end
+    end
+  end
+
+  desc 'Copy repo to releases'
+  task create_release: :'bundle_rsync:update' do
+    hosts = roles(:all)
+    run_locally do
+      execute "mkdir -p #{config.local_release_path}"
+
+      within config.local_repo_path do
+        execute :git, :archive, fetch(:branch), '| tar -x -C', "#{config.local_release_path}"
+      end
+
+      Parallel.each(hosts, in_processes: config.max_parallels(hosts)) do |host|
+        ssh = config.build_ssh_command(host)
+        execute :rsync, "-az --delete --rsh='#{ssh}' #{config.local_release_path}/ #{host}:#{release_path}/"
+      end
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+    run_locally do
+      within config.local_repo_path do
+        set :current_revision, capture(:git, "rev-parse --short #{fetch(:branch)}")
+      end
+    end
+  end
+
+  before 'deploy:updated', 'bundle_rsync:bundler:install'
+end
+
+namespace :load do
+  task :defaults do
+    set :bundle_rsync_local_base_path, nil
+    set :bundle_rsync_local_repo_path, nil
+    set :bundle_rsync_local_release_path, nil
+    set :bundle_rsync_local_bundle_path, nil
+    set :bundle_rsync_local_bin_path, nil
+    set :bundle_rsync_config_files, nil
+    set :bundle_rsync_ssh_options, nil # Default to be ssh_options. Note: :password is not supported.
+    set :bundle_rsync_max_parallels, nil
+  end
+end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-bundle_rsync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sonots
+- tohae
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deploy an application and bundled gems via rsync
+email:
+- sonots@gmail.com
+- tohaechan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-bundle_rsync.gemspec
+- lib/capistrano-bundle_rsync.rb
+- lib/capistrano/bundle_rsync.rb
+- lib/capistrano/bundle_rsync/config.rb
+- lib/capistrano/tasks/bundle_rsync.rake
+homepage: https://github.com/sonots/capistrano-bundle_rsync
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Deploy an application and bundled gems via rsync.
+test_files: []