Changeset 8993

Timestamp:

03/08/08 19:07:46 (5 months ago)

Author:

minam

Message:

Improved "copy" strategy, including support for local caching and pattern exclusion

Files:

• tools/capistrano/CHANGELOG (modified) (1 diff)
• tools/capistrano/lib/capistrano/recipes/deploy/strategy/base.rb (modified) (1 diff)
• tools/capistrano/lib/capistrano/recipes/deploy/strategy/copy.rb (modified) (3 diffs)
• tools/capistrano/test/deploy/strategy/copy_test.rb (modified) (5 diffs)

tools/capistrano/CHANGELOG

@@ +1 @@
+*SVN*
+
+* Improved "copy" strategy supports local caching and pattern exclusion (via :copy_cache and :copy_exclude variables) [Jamis Buck]
+
+
-*2.2.0* February 27, 2008
-

tools/capistrano/lib/capistrano/recipes/deploy/strategy/base.rb

@@ -47 +47 @@
-          end
-
+          # A wrapper for Kernel#system that logs the command being executed.
+          def system(*args)
+            logger.trace "executing locally: #{args.join(' ')}"
+            super
+          end
+
-        private
-

tools/capistrano/lib/capistrano/recipes/deploy/strategy/copy.rb

@@ -16 +16 @@
-      # you can set the :copy_strategy variable to :export.
-      #
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      # :copy_compression, which must be one of :gzip, :bz2, or
-      # :zip, and which specifies how the source should be compressed for
@@ -26 +45 @@
-        # directory.
-        def deploy!
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-          File.open(File.join(destination, "REVISION"), "w") { |f| f.puts(revision) }
-
@@ -49 +97 @@
-        end
-
+        # Returns the location of the local copy cache, if the strategy should
+        # use a local cache + copy instead of a new checkout/export every
+        # time. Returns +nil+ unless :copy_cache has been set. If :copy_cache
+        # is +true+, a default cache location will be returned.
+        def copy_cache
+          @copy_cache ||= configuration[:copy_cache] == true ?
+            File.join(Dir.tmpdir, configuration[:application]) :
+            configuration[:copy_cache]
+        end
+
-        private
+
+          # Specify patterns to exclude from the copy. This is only valid
+          # when using a local cache.
+          def copy_exclude
+            @copy_exclude ||= Array(configuration.fetch(:copy_exclude, []))
+          end
-
-          # Returns the basename of the release_path, which will be used to

tools/capistrano/test/deploy/strategy/copy_test.rb

@@ -6 +6 @@
-class DeployStrategyCopyTest < Test::Unit::TestCase
-  def setup
-
+
+
-                :releases_path => "/u/apps/test/releases",
-                :release_path => "/u/apps/test/releases/1234567890",
@@ -17 +18 @@
-  def test_deploy_with_defaults_should_use_tar_gz_and_checkout
-    Dir.expects(:tmpdir).returns("/temp/dir")
-    Dir.expects(:chdir).with("/temp/dir").yields
-    @source.expects(:checkout).with("154", "/temp/dir/1234567890").returns(:local_checkout)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-    @strategy.deploy!
-  end
@@ -38 +27 @@
-  def test_deploy_with_export_should_use_tar_gz_and_export
-    Dir.expects(:tmpdir).returns("/temp/dir")
-    Dir.expects(:chdir).with("/temp/dir").yields
-    @config[:copy_strategy] = :export
-    @source.expects(:export).with("154", "/temp/dir/1234567890").returns(:local_export)
-
-    @strategy.expects(:system).with(:local_export)
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-    @strategy.deploy!
-  end
@@ -80 +57 @@
-  end
-
-zip
+bz2
-    Dir.expects(:tmpdir).returns("/temp/dir")
-    Dir.expects(:chdir).with("/temp/dir").yields
@@ -145 +122 @@
-    @strategy.deploy!
-  end
+
+  def test_with_copy_cache_should_checkout_to_cache_if_cache_does_not_exist_and_then_copy
+    @config[:copy_cache] = true
+
+    Dir.stubs(:tmpdir).returns("/temp/dir")
+    File.expects(:exists?).with("/temp/dir/captest").returns(false)
+    Dir.expects(:chdir).with("/temp/dir/captest").yields
+
+    @source.expects(:checkout).with("154", "/temp/dir/captest").returns(:local_checkout)
+    @strategy.expects(:system).with(:local_checkout)
+
+    FileUtils.expects(:mkdir_p).with("/temp/dir/1234567890")
+
+    prepare_directory_tree!("/temp/dir/captest")
+
+    prepare_standard_compress_and_copy!
+    @strategy.deploy!
+  end
+
+  def test_with_copy_cache_should_update_cache_if_cache_exists_and_then_copy
+    @config[:copy_cache] = true
+
+    Dir.stubs(:tmpdir).returns("/temp/dir")
+    File.expects(:exists?).with("/temp/dir/captest").returns(true)
+    Dir.expects(:chdir).with("/temp/dir/captest").yields
+
+    @source.expects(:sync).with("154", "/temp/dir/captest").returns(:local_sync)
+    @strategy.expects(:system).with(:local_sync)
+
+    FileUtils.expects(:mkdir_p).with("/temp/dir/1234567890")
+
+    prepare_directory_tree!("/temp/dir/captest")
+
+    prepare_standard_compress_and_copy!
+    @strategy.deploy!
+  end
+
+  def test_with_copy_cache_with_custom_cache_dir_should_use_specified_cache_dir
+    @config[:copy_cache] = "/u/caches/captest"
+
+    Dir.stubs(:tmpdir).returns("/temp/dir")
+    File.expects(:exists?).with("/u/caches/captest").returns(true)
+    Dir.expects(:chdir).with("/u/caches/captest").yields
+
+    @source.expects(:sync).with("154", "/u/caches/captest").returns(:local_sync)
+    @strategy.expects(:system).with(:local_sync)
+
+    FileUtils.expects(:mkdir_p).with("/temp/dir/1234567890")
+
+    prepare_directory_tree!("/u/caches/captest")
+
+    prepare_standard_compress_and_copy!
+    @strategy.deploy!
+  end
+
+  def test_with_copy_cache_with_excludes_should_not_copy_excluded_files
+    @config[:copy_cache] = true
+    @config[:copy_exclude] = "*/bar.txt"
+
+    Dir.stubs(:tmpdir).returns("/temp/dir")
+    File.expects(:exists?).with("/temp/dir/captest").returns(true)
+    Dir.expects(:chdir).with("/temp/dir/captest").yields
+
+    @source.expects(:sync).with("154", "/temp/dir/captest").returns(:local_sync)
+    @strategy.expects(:system).with(:local_sync)
+
+    FileUtils.expects(:mkdir_p).with("/temp/dir/1234567890")
+
+    prepare_directory_tree!("/temp/dir/captest", true)
+
+    prepare_standard_compress_and_copy!
+    @strategy.deploy!
+  end
+
+  private
+
+    def prepare_directory_tree!(cache, exclude=false)
+      Dir.expects(:glob).with("*", File::FNM_DOTMATCH).returns([".", "..", "app", "foo.txt"])
+      File.expects(:directory?).with("app").returns(true)
+      FileUtils.expects(:mkdir).with("/temp/dir/1234567890/app")
+      File.expects(:directory?).with("foo.txt").returns(false)
+      FileUtils.expects(:ln).with("#{cache}/foo.txt", "/temp/dir/1234567890/foo.txt")
+
+      Dir.expects(:glob).with("app/*", File::FNM_DOTMATCH).returns(["app/.", "app/..", "app/bar.txt"])
+      unless exclude
+        File.expects(:directory?).with("app/bar.txt").returns(false)
+        FileUtils.expects(:ln).with("#{cache}/app/bar.txt", "/temp/dir/1234567890/app/bar.txt")
+      end
+    end
+
+    def prepare_standard_compress_and_copy!
+      Dir.expects(:chdir).with("/temp/dir").yields
+      @strategy.expects(:system).with("tar czf 1234567890.tar.gz 1234567890")
+      @strategy.expects(:put).with(:mock_file_contents, "/tmp/1234567890.tar.gz")
+      @strategy.expects(:run).with("cd /u/apps/test/releases && tar xzf /tmp/1234567890.tar.gz && rm /tmp/1234567890.tar.gz")
+
+      mock_file = mock("file")
+      mock_file.expects(:puts).with("154")
+      File.expects(:open).with("/temp/dir/1234567890/REVISION", "w").yields(mock_file)
+      File.expects(:open).with("/temp/dir/1234567890.tar.gz", "rb").yields(StringIO.new).returns(:mock_file_contents)
+
+      FileUtils.expects(:rm).with("/temp/dir/1234567890.tar.gz")
+      FileUtils.expects(:rm_rf).with("/temp/dir/1234567890")
+    end
-end