capistrano_rsync_with_remote_cache 2.3.3 → 2.3.4

data/README.rdoc

@@ -0,0 +1,36 @@
+= 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 or 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.
+
+This gem requires <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 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 <tt>deploy.rb</tt> 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 <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 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 <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 <tt>:repository</tt> variable, the local cache is purged and recreated with a checkout of 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/VERSION.yml

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

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

@@ -6,7 +6,8 @@ module Capistrano
     module Strategy
       class RsyncWithRemoteCache < Remote
 
-        # The deployment method itself, in three major steps.
+        # The deployment method itself, in three major steps: update the local cache, update the remote
+        # cache, and copy the remote cache into place.
         def deploy!
 
           # Step 1: Update the local cache.
@@ -61,27 +62,32 @@ module Capistrano
             server.host
           end
         end
-        
+
         # Command to get source from SCM on the local side. If the local_cache directory exists,
         # we check to see if it's an SCM checkout that matches the currently configured repository.
         # If it matches, we update it. If it doesn't match (either it's for another repository or
         # not a checkout at all), we remove the directory and recreate it with a fresh SCM checkout.
         # If the directory doesn't exist, we create it with a fresh SCM checkout.
-        #
-        # FIXME: The above logic only takes place if the SCM is Subversion. At some point, similar logic
-        # will probably be necessary for Git and other SCMs we might use.
-        #
         # TODO: punt in some sensible way if local_cache exists but is a regular file.
         def command
-          if configuration[:scm] == :subversion
-            svn_info = IO.popen("svn info #{local_cache} | sed -n 's/URL: //p'")
-            svn_url = svn_info.gets
-            svn_info.close
-            if svn_url && svn_url.chomp != configuration[:repository]
-              logger.trace "repository has changed; removing old local cache"
-              FileUtils.rm_rf local_cache
-            end
+          case configuration[:scm].to_s
+          when 'subversion'
+            info_command = "svn info #{local_cache} | sed -n 's/URL: //p'"
+          when 'git'
+            info_command = "cd #{local_cache} && git config remote.origin.url"
+          else
+            # an effective no-op
+            info_command = "echo #{configuration[:repository]}"
           end
+          cache_info = IO.popen(info_command)
+
+          cached_repository = cache_info.gets
+          cache_info.close
+          if cached_repository && cached_repository.chomp != configuration[:repository]
+            logger.trace "repository has changed; removing old local cache"
+            FileUtils.rm_rf local_cache
+          end
+
           if File.exists?(local_cache) && File.directory?(local_cache)
             logger.trace "updating local cache to revision #{revision}"
             cmd = source.sync(revision, local_cache)

data/test/capistrano_rsync_with_remote_cache_test.rb

@@ -17,7 +17,14 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
     source_stub.expects(:checkout)
     @rwrc.expects(:source).returns(source_stub)
   end
-  
+
+  def stub_detection_of_changed_local_cache(command, returns)
+    cache_info_stub = stub()
+    cache_info_stub.expects(:gets).returns(returns)
+    cache_info_stub.expects(:close)
+    IO.expects(:popen).with(command).returns(cache_info_stub)
+  end
+
   context 'RsyncWithRemoteCache' do
     setup do
       @rwrc = Capistrano::Deploy::Strategy::RsyncWithRemoteCache.new
@@ -117,42 +124,37 @@ class CapistranoRsyncWithRemoteCacheTest < Test::Unit::TestCase
     end
 
     context 'command' do
-      should 'purge and recreate local cache if it detects subversion info has changed' do
+      should 'purge local cache if it detects subversion info has changed' do
         stub_configuration(:scm => :subversion, :repository => 'repository')        
+        stub_detection_of_changed_local_cache("svn info .rsync_cache | sed -n 's/URL: //p'", "URL: url\n")
+        FileUtils.expects(:rm_rf).with('.rsync_cache')
+        stub_creation_of_new_local_cache
 
-        svn_info_stub = stub()
-        svn_info_stub.expects(:gets).returns("URL: url\n")
-        svn_info_stub.expects(:close)
-        IO.expects(:popen).with("svn info .rsync_cache | sed -n 's/URL: //p'").returns(svn_info_stub)
+        @rwrc.send(:command)
+      end
 
+      should 'purge local cache if it detects git info has changed' do
+        stub_configuration(:scm => :git, :repository => 'repository')        
+        stub_detection_of_changed_local_cache("cd .rsync_cache && git config remote.origin.url", "beep\n")
         FileUtils.expects(:rm_rf).with('.rsync_cache')
-
         stub_creation_of_new_local_cache
 
         @rwrc.send(:command)
       end
 
-      should 'not attempt to purge and recreate local cache that does not exist' do
+      should 'not attempt to purge local cache that does not exist' do
         stub_configuration(:scm => :subversion, :repository => 'repository')        
-
-        svn_info_stub = stub()
-        svn_info_stub.expects(:gets).returns(nil)
-        svn_info_stub.expects(:close)
-        IO.expects(:popen).with("svn info .rsync_cache | sed -n 's/URL: //p'").returns(svn_info_stub)
-
+        stub_detection_of_changed_local_cache("svn info .rsync_cache | sed -n 's/URL: //p'", nil)
         FileUtils.expects(:rm_rf).with('.rsync_cache').never
-
         stub_creation_of_new_local_cache
 
         @rwrc.send(:command)
       end
 
-      should 'not attempt to purge and recreate local cache if the scm is not subversion' do
-        stub_configuration(:scm => :git, :repository => 'repository')        
-
-        IO.expects(:popen).with("svn info .rsync_cache | sed -n 's/URL: //p'").never
+      should 'not attempt to purge local cache if the scm is not supported by this gem' do
+        stub_configuration(:scm => :bzr, :repository => 'repository')        
+        stub_detection_of_changed_local_cache("echo repository", "repository\n")
         FileUtils.expects(:rm_rf).with('.rsync_cache').never
-
         stub_creation_of_new_local_cache
 
         @rwrc.send(:command)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano_rsync_with_remote_cache
 version: !ruby/object:Gem::Version 
-  version: 2.3.3
+  version: 2.3.4
 platform: ruby
 authors: 
 - Mark Cornick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 -04:00
+date: 2009-05-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,10 +30,10 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.md
+- README.rdoc
 files: 
 - LICENSE
-- README.md
+- README.rdoc
 - Rakefile
 - VERSION.yml
 - lib/capistrano/recipes/deploy/strategy/rsync_with_remote_cache.rb

data/README.md

@@ -1,32 +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 `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.