capistrano-rsync-remote-cache 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a192c1b61afd3e96c2e83cf8363a47995eec949b
+  data.tar.gz: 86566b4259ff53f584ae0613c0c2ff4974353087
+SHA512:
+  metadata.gz: 39ded65f0305a147d7928c10d220dd10c84693b11a9611d30646c4d93946d422a59dc23e86729748ac1384688a6616a8b68e4fa12d8223d6a365e0f140e2dafc
+  data.tar.gz: 11b17b09541e9691cbe78a3d8f22dc9cd1d5145dbbc39923ac7767338b1342018323083e18c532c701c25a5cf654ebef5da32b958e9e47297eed1bedf93b8a93

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-scm-passthrough.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,72 @@
+= Capistrano 2.0 rsync_remote_cache Deployment Strategy
+
+== Description
+
+This gem provides a deployment strategy for Capistrano which combines the
+<tt>rsync</tt> command with a remote cache, allowing fast deployments from SCM
+repositories behind firewalls.
+
+== Aim
+
+The original gem is outdated. In this gem, I have merged all the pull requests
+that were interesting, such as rsync in parallel, rsh parameters, etc.
+
+== Original gem
+
+For the original gem, visit: https://github.com/vigetlabs/capistrano_rsync_with_remote_cache
+
+== Installation
+
+    gem install capistrano-rsync-remote-cache
+
+== Usage
+
+To use this deployment strategy, add this line to your <tt>deploy.rb</tt> file:
+
+    set :deploy_via, :rsync_remote_cache
+
+If you want to enable the parallel deployment:
+
+    set :rsync_in_parallel, true
+
+If you want to tune the number of threads:
+
+    set :rsync_concurrency, 8
+
+By default, the deployments spawns 8 threads.
+
+== Under the Hood
+
+This strategy maintains two cache directories:
+
+* The local cache directory is a checkout from the SCM repository. The local
+  cache directory is specified with the <tt>:local_cache</tt> variable in the
+  configuration. If not specified, it will default to <tt>.rsync_cache</tt>
+  in the same directory as the Capfile.
+
+* The remote cache directory is an <tt>rsync</tt> copy of the local cache directory.
+  The remote cache directory is specified with the <tt>:repository_cache</tt> variable
+  in the configuration (this name comes from the <tt>:remote_cache</tt> strategy that
+  ships with Capistrano, and has been maintained for compatibility.) If not
+  specified, it will default to <tt>shared/cached-copy</tt> (again, for compatibility
+  with remote_cache.)
+
+Deployment happens in three major steps. First, the local cache directory is
+processed. There are three possibilities:
+
+* If the local cache does not exist, it is created with a checkout of the
+  revision to be deployed.
+* If the local cache exists and matches the <tt>:repository</tt> variable, it is
+  updated to the revision to be deployed.
+* If the local cache exists and does not match the <p>:repository</p> variable,
+  the local cache is purged and recreated with a checkout of the revision
+  to be deployed.
+* If the local cache exists but is not a directory, an exception is raised
+
+Second, <tt>rsync</tt> runs on the local side to sync the remote cache to the local
+cache. When the <tt>rsync</tt> is complete, the remote cache should be an exact
+replica of the local cache.
+
+Finally, a copy of the remote cache is made in the appropriate release
+directory. The end result is the same as if the code had been checked out
+directly on the remote server, as in the default strategy.

data/Rakefile

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

data/capistrano-rsync-remote-cache.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-rsync-remote-cache"
+  gem.version       = "1.0.0"
+  gem.authors       = ["Yeongseok"]
+  gem.email         = ["iyagi15@gmail.com"]
+  gem.homepage      = "https://github.com/iyagi15/capistrano_rsync_remote_cache"
+  gem.summary       = %q{Improved version of rsync-with-remote-cache deployment strategy.}
+  gem.description   = %q{Improved version of rsync-with-remote-cache deployment strategy.}
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency('capistrano', '>=2.4.0')
+  gem.add_dependency('parallel', '>=0.0.0')
+end

data/lib/capistrano/recipes/deploy/strategy/rsync_remote_cache.rb

@@ -0,0 +1,141 @@
+require 'capistrano/recipes/deploy/strategy/remote'
+require 'fileutils'
+require 'parallel'
+
+module Capistrano
+  module Deploy
+    module Strategy
+      class RsyncRemoteCache < Remote
+
+        class InvalidCacheError < Exception; end
+        class RsyncFailedError < Exception; end
+        class LocalCacheUpdateFailedError < Exception; end
+
+        def self.default_attribute(attribute, default_value)
+          define_method(attribute) { configuration[attribute] || default_value }
+        end
+
+        INFO_COMMANDS = {
+          :subversion => "svn info . | sed -n \'s/URL: //p\'",
+          :git        => "git config remote.origin.url",
+          :mercurial  => "hg showconfig paths.default",
+          :bzr        => "bzr info | grep parent | sed \'s/^.*parent branch: //\'"
+        }
+
+        default_attribute :rsync_options, '-az --delete'
+        default_attribute :local_cache, '.rsync_cache'
+        default_attribute :repository_cache, 'cached-copy'
+        default_attribute :rsync_concurrency, 8
+        default_attribute :rsync_in_parallel, false
+        default_attribute :rsync_ssh_options, '-o PasswordAuthentication=no -o StrictHostKeyChecking=no'
+
+        def deploy!
+          update_local_cache
+          update_remote_cache
+          copy_remote_cache
+        end
+
+        def system!(command)
+          system(command) or raise RuntimeError.new("Command exit with non zero status: #{command}")
+        end
+
+        def update_local_cache
+          system!(command)
+          mark_local_cache
+        end
+
+        def update_remote_cache
+          finder_options = {:except => { :no_release => true }}
+          if rsync_in_parallel
+            Parallel.map(find_servers(finder_options), :in_processes => rsync_concurrency) do |s|
+              system!(rsync_command_for(s))
+            end.all?
+          else
+            find_servers(finder_options).each {|s| system(rsync_command_for(s)) }
+          end
+        end
+
+        def copy_remote_cache
+          run("rsync -azx #{repository_cache_path}/ #{configuration[:release_path]}/")
+        end
+
+        def rsync_command_for(server)
+          "sshpass -p '#{password}'' rsync #{rsync_options} --rsh='ssh -p #{ssh_port(server)} #{rsync_ssh_options}' '#{local_cache_path}/' #{rsync_host(server)}:#{repository_cache_path}/"
+        end
+
+        def mark_local_cache
+          File.open(File.join(local_cache_path, 'REVISION'), 'w') {|f| f << revision }
+        end
+
+        def ssh_port(server)
+          server.port || ssh_options[:port] || 22
+        end
+
+        def local_cache_path
+          File.expand_path(local_cache)
+        end
+
+        def repository_cache_path
+          File.join(shared_path, repository_cache)
+        end
+
+        def repository_url
+          `cd #{local_cache_path} && #{INFO_COMMANDS[configuration[:scm]]}`.strip
+        end
+
+        def repository_url_changed?
+          repository_url != configuration[:repository]
+        end
+
+        def remove_local_cache
+          logger.trace "repository has changed; removing old local cache from #{local_cache_path}"
+          FileUtils.rm_rf(local_cache_path)
+        end
+
+        def remove_local_cache_if_repository_url_changed
+          remove_local_cache if repository_url_changed?
+        end
+
+        def rsync_host(server)
+          configuration[:user] ? "#{configuration[:user]}@#{server.host}" : server.host
+        end
+
+        def local_cache_exists?
+          File.exist?(local_cache_path)
+        end
+
+        def local_cache_valid?
+          local_cache_exists? && File.directory?(local_cache_path)
+        end
+
+        # Defines commands that should be checked for by deploy:check. These include the SCM command
+        # on the local end, and rsync on both ends. Note that the SCM command is not needed on the
+        # remote end.
+        def check!
+          super.check do |check|
+            check.local.command(source.command)
+            check.local.command('rsync')
+            check.local.command('sshpass')
+            check.remote.command('rsync')
+          end
+        end
+
+        private
+
+        def command
+          if local_cache_exists?
+            remove_local_cache_if_repository_url_changed
+          end
+          if local_cache_valid?
+            source.sync(revision, local_cache_path)
+          elsif !local_cache_exists?
+            "mkdir -p #{local_cache_path} && #{source.checkout(revision, local_cache_path)}"
+          else
+            raise InvalidCacheError, "The local cache exists but is not valid (#{local_cache_path})"
+          end
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rsync-remote-cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yeongseok
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+description: Improved version of rsync-with-remote-cache deployment strategy.
+email:
+- iyagi15@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- capistrano-rsync-remote-cache.gemspec
+- lib/capistrano/recipes/deploy/strategy/rsync_remote_cache.rb
+homepage: https://github.com/iyagi15/capistrano_rsync_remote_cache
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Improved version of rsync-with-remote-cache deployment strategy.
+test_files: []