capistrano_rsync_with_remote_cache 2.3 → 2.3.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007, 2008 Mark Cornick of Viget Labs (http://www.viget.com/)
+
+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,32 @@
+# Capistrano rsync_with_remote_cache
+
+This gem provides a deployment strategy for Capistrano which combines rsync with a remote cache, allowing fast deployments from Subversion repositories behind firewalls.
+
+## Requirements
+
+This gem requires Capistrano 2.0.0 and higher. Git support requires Capistrano 2.1.0 or higher.
+
+This gem has only been tested with Subversion and Git. It is unlikely to be supported for other SCM systems unless we adopt them at Viget Labs, or get outside help.
+
+This gem requires and `rsync` command line utilities on the local and remote hosts. It also requires either `svn` or `git` on the local host, but not the remote host.
+
+This gem is tested on Mac OS X and Linux. Windows is not tested or supported.
+
+## Using the strategy
+
+To use this deployment strategy, add this line to your `deploy.rb` file:
+
+    set :deploy_via, :rsync_with_remote_cache
+
+## How it works
+
+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 `local_cache` variable in the configuration. If not specified, it will default to `.rsync_cache` in the same directory as the Capfile.
+* The remote cache directory is an rsync copy of the local cache directory. The remote cache directory is specified with the `repository_cache` variable in the configuration (this name comes from the `remote_cache` strategy that ships with Capistrano, and has been maintained for compatibility.) If not specified, it will default to `shared/cached-copy` (again, for compatibility with remote_cache.)
+
+Deployment happens in three major steps. First, the local cache directory is processed. If it does not exist, it is created with a checkout of the revision to be deployed. If it exists, it is updated to the revision to be deployed.
+
+Second, rsync runs on the local side to sync the remote cache to the local cache. When the rsync 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,85 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "capistrano_rsync_with_remote_cache"
+    gem.summary = "rsync_with_remote_cache strategy for Capistrano"
+    gem.description = 'A deployment strategy for Capistrano 2.0 which combines rsync with a remote cache, allowing fast deployments from SCM servers behind firewalls.'
+    gem.email = "mark@viget.com"
+    gem.homepage = "http://github.com/vigetlabs/capistrano_rsync_with_remote_cache"
+    gem.authors = ["Mark Cornick"]
+    gem.rubyforge_project = "viget"
+    gem.add_dependency 'capistrano', '>= 2.0'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+    test.rcov_opts << '-x gems'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "capistrano_rsync_with_remote_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/capistrano_rsync_with_remote_cache/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 2
+:minor: 3
+:patch: 1

data/test/capistrano_rsync_with_remote_cache_test.rb

@@ -0,0 +1,159 @@
+# This test suite was written way after the code, back when the author didn't do TDD consistently.
+# Also, the code does a lot of things with external servers and services, so there's a lot of mocking.
+# Therefore, this suite is nearly impossible to follow in places. Sorry.
+
+require 'test_helper'
+
+class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
+  def stub_configuration(hash)
+    @rwrc.expects(:configuration).at_least_once.returns(hash)
+  end
+
+  context 'RsyncWithRemoteCache' do
+    setup do
+      @rwrc = Capistrano::Deploy::Strategy::RsyncWithRemoteCache.new
+
+      logger_stub = stub()
+      logger_stub.stubs(:trace)
+      @rwrc.stubs(:logger).returns(logger_stub)
+
+      # FIXME: this is lame
+      class << @rwrc
+        def `(cmd)
+          '\n'
+        end
+      end
+    end
+
+    should 'deploy!' do
+      stub_configuration(:deploy_to => 'deploy_to', :release_path => 'release_path', :scm => :subversion)
+      @rwrc.stubs(:shared_path).returns('shared')
+
+      # Step 1: Update the local cache.
+      @rwrc.expects(:command).returns('command')
+      @rwrc.expects(:system).with('command')
+      revision_file_stub = stub()
+      revision_file_stub.expects(:puts)
+      File.expects(:open).with(File.join('.rsync_cache', 'REVISION'), 'w').yields(revision_file_stub)
+
+      # Step 2: Update the remote cache.
+      server_stub = stub(:host => 'host')
+      @rwrc.expects(:system).with("rsync -az --delete .rsync_cache/ host:shared/cached-copy/")
+      @rwrc.expects(:find_servers).returns([server_stub])
+
+      # Step 3: Copy the remote cache into place.
+      @rwrc.expects(:mark).returns('mark')
+      @rwrc.expects(:run).with("rsync -a --delete shared/cached-copy/ release_path/ && mark")
+
+      @rwrc.deploy!
+    end
+
+    should 'check!' do
+      configuration = {:releases_path => 'releases_path', :deploy_to => 'deploy_to'}
+      configuration.stubs(:invoke_command)
+      @rwrc.expects(:configuration).at_least_once.returns(configuration)
+
+      source_stub = stub(:command => 'command')
+      @rwrc.stubs(:source).returns(source_stub)
+
+      @rwrc.check!
+    end
+
+    context 'repository_cache' do
+      setup do
+        @rwrc.expects(:shared_path).returns('shared')
+      end
+
+      should 'return specified cache if present in configuration' do
+        stub_configuration(:repository_cache => 'cache')
+        assert_equal 'shared/cache', @rwrc.send(:repository_cache)
+      end
+
+      should 'return default cache if not present in configuration' do
+        stub_configuration(:repository_cache => nil)
+        assert_equal 'shared/cached-copy', @rwrc.send(:repository_cache)
+      end
+    end
+
+    context 'local_cache' do
+      should 'return specified cache if present in configuration' do
+        stub_configuration(:local_cache => 'cache')
+        assert_equal 'cache', @rwrc.send(:local_cache)
+      end
+
+      should 'return default cache if not present in configuration' do
+        stub_configuration(:local_cache => nil)
+        assert_equal '.rsync_cache', @rwrc.send(:local_cache)
+      end
+    end
+
+    context 'rsync_options' do
+      should 'return specified options if present in configuration' do
+        stub_configuration(:rsync_options => 'options')
+        assert_equal 'options', @rwrc.send(:rsync_options)
+      end
+
+      should 'return default options if not present in configuration' do
+        stub_configuration(:rsync_options => nil)
+        assert_equal '-az --delete', @rwrc.send(:rsync_options)
+      end
+    end
+
+    context 'rsync_host' do
+      setup do
+        @server_stub = stub(:host => 'host')
+      end
+
+      should 'prefix user if present in configuration' do
+        stub_configuration(:user => 'user')
+        assert_equal 'user@host', @rwrc.send(:rsync_host, @server_stub)
+      end
+
+      should 'not prefix user if not present in configuration' do
+        stub_configuration(:user => nil)
+        assert_equal 'host', @rwrc.send(:rsync_host, @server_stub)
+      end
+    end
+
+    context 'command' do
+      should 'remove local cache dir if it detects subversion info has changed' do
+        stub_configuration(:scm => :subversion)
+
+        @rwrc.expects(:`).returns('something else')
+        @rwrc.expects(:system).with("rm -rf .rsync_cache")
+
+        File.expects(:exists?).with('.rsync_cache').times(2).returns(false)
+        File.expects(:directory?).with(File.dirname('.rsync_cache')).returns(false)
+        Dir.expects(:mkdir).with(File.dirname('.rsync_cache'))
+
+        source_stub = stub()
+        source_stub.expects(:checkout)
+        @rwrc.expects(:source).returns(source_stub)
+
+        @rwrc.send(:command)
+
+      end
+
+      should 'update local cache if it exists' do
+        File.expects(:exists?).with('.rsync_cache').returns(true)
+        File.expects(:directory?).with('.rsync_cache').returns(true)
+        source_stub = stub()
+        source_stub.expects(:sync)
+        @rwrc.expects(:source).returns(source_stub)
+
+        @rwrc.send(:command)
+      end
+
+      should 'update local cache if it does not exist' do
+        File.expects(:exists?).with('.rsync_cache').times(2).returns(false)
+        File.expects(:directory?).with(File.dirname('.rsync_cache')).returns(false)
+        Dir.expects(:mkdir).with(File.dirname('.rsync_cache'))
+        source_stub = stub()
+        source_stub.expects(:checkout)
+        @rwrc.expects(:source).returns(source_stub)
+
+        @rwrc.send(:command)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'capistrano/recipes/deploy/strategy/rsync_with_remote_cache'
+
+class Test::Unit::TestCase
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano_rsync_with_remote_cache
 version: !ruby/object:Gem::Version 
-  version: "2.3"
+  version: 2.3.1
 platform: ruby
 authors: 
 - Mark Cornick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-30 00:00:00 -05:00
+date: 2009-05-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,22 +22,30 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "2.0"
     version: 
-description: 
+description: A deployment strategy for Capistrano 2.0 which combines rsync with a remote cache, allowing fast deployments from SCM servers behind firewalls.
 email: mark@viget.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- LICENSE
+- README.md
 files: 
+- LICENSE
+- README.md
+- Rakefile
+- VERSION.yml
 - lib/capistrano/recipes/deploy/strategy/rsync_with_remote_cache.rb
-- README
+- test/capistrano_rsync_with_remote_cache_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/vigetlabs/capistrano_rsync_with_remote_cache
-post_install_message: 
-rdoc_options: []
+licenses: []
 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -54,10 +62,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.1
+rubyforge_project: viget
+rubygems_version: 1.3.2
 signing_key: 
-specification_version: 2
-summary: A deployment strategy for Capistrano 2.0 which combines rsync with a remote cache, allowing fast deployments from SCM servers behind firewalls.
-test_files: []
-
+specification_version: 3
+summary: rsync_with_remote_cache strategy for Capistrano
+test_files: 
+- test/capistrano_rsync_with_remote_cache_test.rb
+- test/test_helper.rb

data/README

@@ -1,36 +0,0 @@
-= Capistrano rsync_with_remote_cache
-
-This gem provides a deployment strategy for Capistrano which combines rsync with a remote cache, allowing fast deployments from Subversion repositories behind firewalls.
-
-== Requirements
-
-This gem requires Capistrano 2.0.0 and higher. Git support requires Capistrano 2.1.0 or higher.
-
-This gem has only been tested with Subversion and Git. It is unlikely to be supported for other SCM systems unless we adopt them at Viget Labs, or get outside help.
-
-This gem requires and <tt>rsync</tt> command line utilities on the local and remote hosts. It also requires either <tt>svn</tt> or <tt>git</tt> on the local host, but not the remote host.
-
-This gem is tested primarily on Mac OS X and Linux. It may work with a Windows local host, but is not tested or supported. Like Capistrano itself, it will not work with a Windows remote host.
-
-== Gem preliminaries
-
-To create the gem, run <tt>gem build capistrano_rsync_with_remote_cache.gemspec</tt> in this directory.
-
-To use this deployment strategy, add this line to your configuration:
-
-<tt>set :deploy_via, :rsync_with_remote_cache</tt>
-
-== How it works
-
-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 ".rsync_cache" in the same directory as the Capfile.
-* The remote cache directory is an rsync 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 remote_cache strategy that ships with Capistrano, and has been maintained for compatibility.) If not specified, it will default to "shared/cached-copy" (again, for compatibility with remote_cache.)
-
-Deployment happens in three major steps. First, the local cache directory is processed. If it does not exist, it is created with a checkout of the revision to be deployed. If it exists, it is updated to the revision to be deployed.
-
-Second, rsync runs on the local side to sync the remote cache to the local cache. When the rsync 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.
-
-Copyright (c) 2007, 2008 Mark Cornick of Viget Labs, released under the MIT license