capistrano-scm-gitcopy 0.0.8 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0376743e4d7c3600ea0c54ff689f58de8a19a1d0
-  data.tar.gz: cf014f4102cbf8ff0972dbd44ad8b1664ce7080a
+  metadata.gz: 5d35e2b43b2d196cc35eccfa170dcd701aacdd4e
+  data.tar.gz: defb71f2f16a188a6206029c613103586269aaca
 SHA512:
-  metadata.gz: 14516584d5ec9b0e6f2a6f5d0d2f596190d2fb4fb3e339c56b7e7b42a8ffd01d643edddc122aceca070a3f83aaf10f51a72d5d9a08e92735edb211c73d44cf5c
-  data.tar.gz: 8aa615deee498b81d950ae8757d7ebed6faddf6437a5705fe0ef86bcf4bdccbcdeeb2af8b74f9ccb3bab713aff8b33fc24d418a08f8f1aa844d6717806252069
+  metadata.gz: 8e1eb382e5054e69d52090b8ddc24651744f34a563c56c90e4ac314fe389d1b0a7e4ac71d08cdbf19318b51c344fa522438145d67987d9ed61682ac60f6aafd0
+  data.tar.gz: de3ebff42cbc833879194ebc1f8486335bdabc65d5fb30d5de6bff9e278953be0ad40c35028b2f39c485e21d938aaa69342cb52bf20e43d49cd4b7c98f4de524

data/README.md

@@ -25,6 +25,7 @@ Servers:
 
 - mktemp
 - tar
+- ruby
 
 Installation
 ============
@@ -37,6 +38,8 @@ Then switch the `:scm` option to `:gitcopy` in `config/deploy.rb`:
 
     set :scm, :gitcopy
     
+Finally, DO NOT ADD `require 'capistrano/gitcopy'` to `Capfile` because `capistrano/setup` already loads the scm module with the :scm value you specified.
+
 
 Usage
 ============

data/capistrano-scm-gitcopy.gemspec

@@ -1,21 +1,24 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "capistrano-scm-gitcopy"
-  s.version     = "0.0.8"
-  s.licenses    = ["MIT"]
-  s.authors     = ["Jack Wu", "Carl Douglas"]
-  s.email       = ["xuwupeng2000@gmail.com"]
-  s.homepage    = "https://github.com/xuwupeng2000/capsitrano-scm-gitcopy.git"
+  s.name        = 'capistrano-scm-gitcopy'
+  s.version     = '0.1.2'
+  s.licenses    = ['MIT']
+  s.authors     = ['Jack Wu', 'Carl Douglas']
+  s.email       = ['xuwupeng2000@gmail.com']
+  s.homepage    = 'https://github.com/xuwupeng2000/capsitrano-scm-gitcopy.git'
   s.summary     = %q{Gitcopy strategy for capistrano 3.x}
   s.description = %q{Gitcopy strategy for capistrano 3.x}
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split
+  s.executables   = `git ls-files -- bin/*`.split.map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
 
   # specify any dependencies here; for example:
-  s.add_dependency "capistrano", "~> 3.0"
+  s.add_dependency 'capistrano', '~> 3.0'
+
+  s.add_development_dependency 'rspec', '~> 3.0.0'
+  s.add_development_dependency 'mocha', '~> 1.1.0'
 end

data/lib/capistrano/gitcopy.rb

@@ -1 +1,66 @@
 load File.expand_path('../tasks/gitcopy.rake', __FILE__)
+
+require 'capistrano/scm'
+
+set_if_empty :repo_path, -> { "/tmp/#{fetch(:application)}-repository" }
+
+class Capistrano::GitCopy < Capistrano::SCM
+
+  # execute git with argument in the context
+  #
+  def git(*args)
+    args.unshift :git
+    context.execute(*args)
+  end
+
+  module DefaultStrategy
+
+    def test
+      test! " [ -f #{repo_path}/HEAD ] "
+    end
+
+    def check
+      git :'ls-remote --heads', repo_url
+    end
+
+    def clone
+      if (depth = fetch(:git_shallow_clone))
+        git :clone, '--verbose', '--mirror', '--depth', depth, '--no-single-branch', repo_url, repo_path
+      else
+        git :clone, '--verbose', '--mirror', repo_url, repo_path
+      end
+    end
+
+    def update
+      # Note: Requires git version 1.9 or greater
+      if (depth = fetch(:git_shallow_clone))
+        git :fetch, '--depth', depth, 'origin', fetch(:branch)
+      else
+        git :remote, :update
+      end
+    end
+
+    def fetch_revision
+      context.capture(:git, "rev-list --max-count=1 --abbrev-commit --abbrev=12 #{fetch(:branch)}")
+    end
+
+    def local_tarfile
+      "#{fetch(:tmp_dir)}/#{fetch(:application)}-#{fetch(:current_revision).strip}.tar.gz"
+    end
+
+    def remote_tarfile
+      "#{fetch(:tmp_dir)}/#{fetch(:application)}-#{fetch(:current_revision).strip}.tar.gz"
+    end
+
+    def release
+      if (tree = fetch(:repo_tree))
+        tree = tree.slice %r#^/?(.*?)/?$#, 1
+        components = tree.split('/').size
+        git :archive, fetch(:branch), tree, '--format', 'tar', "|gzip > #{local_tarfile}"
+      else
+        git :archive, fetch(:branch), '--format', 'tar', "|gzip > #{local_tarfile}"
+      end
+    end
+  end 
+
+end

data/lib/capistrano/tasks/gitcopy.rake

@@ -1,46 +1,100 @@
 namespace :gitcopy do
 
-  archive_name =  "archive.#{ DateTime.now.strftime('%Y%m%d%m%s') }.tar.gz" 
-
-  desc "Archive files to #{archive_name}"
-  file archive_name do |file| 
-    system "git ls-remote #{fetch(:repo_url)} | grep #{fetch(:branch)}"
-    if $?.exitstatus == 0
-      system "git archive --remote #{fetch(:repo_url)} --format=tar #{fetch(:branch)}:#{fetch(:sub_directory)} | gzip > #{ archive_name }"
-    else
-      puts "Can't find commit for: #{fetch(:branch)}"
-    end
+  def strategy
+    @strategy ||= Capistrano::GitCopy.new(self, fetch(:git_strategy, Capistrano::GitCopy::DefaultStrategy))
   end
 
-  desc "Deploy #{archive_name} to release_path"
-  task :deploy => archive_name do |file|
-    tarball = file.prerequisites.first
-    on roles :all do
-      # Make sure the release directory exists
-      execute :mkdir, "-p", release_path
+  set :git_environmental_variables, ->() {
+    {
+      git_askpass: "/bin/echo",
+      git_ssh:     "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+    }
+  }
 
-      # Create a temporary file on the server
-      tmp_file = capture("mktemp")
+  desc 'Generate the git wrapper script, this script guarantees that we can script git without getting an interactive prompt'
+  task :wrapper do
+    run_locally do
+      execute :mkdir, "-p", "#{fetch(:tmp_dir)}/#{fetch(:application)}/"
+      File.open("#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh", "w") do |file|
+        file.write ("#!/bin/sh -e\nexec /usr/bin/ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no \"$@\"\n")
+      end
+      execute :chmod, "+x", "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+    end
+  end
 
-      # Upload the archive, extract it and finally remove the tmp_file
-      upload!(tarball, tmp_file)
-      execute :tar, "-xzf", tmp_file, "-C", release_path
-      execute :rm, tmp_file
+  desc 'Check that the repository is reachable'
+  task :check => :'gitcopy:wrapper' do
+    fetch(:branch)
+    run_locally do
+      with fetch(:git_environmental_variables) do
+        strategy.check
+      end
     end
   end
 
+  desc 'Clone the repo to the cache'
+  task :clone => :'gitcopy:wrapper' do
+    run_locally do
+      execute :mkdir, '-p', repo_path
+      if strategy.test
+        info t(:mirror_exists, at: repo_path)
+      else
+        within repo_path do
+          with fetch(:git_environmental_variables) do
+            strategy.clone
+          end
+        end
+      end
+    end
+  end
 
-  task :clean do |t|
-    # Delete the local archive
-    File.delete archive_name if File.exists? archive_name
+  desc 'Update the repo mirror to reflect the origin state'
+  task :update => :'gitcopy:clone' do
+    run_locally do
+      within repo_path do
+        with fetch(:git_environmental_variables) do
+          strategy.update
+        end
+      end
+    end
   end
-  after 'deploy:finished', 'gitcopy:clean'
 
+  desc 'Create tarfile'
+  task :create_tarfile => [:'gitcopy:update', :'gitcopy:set_current_revision'] do
+    run_locally do
+      within repo_path do
+        with fetch(:git_environmental_variables) do
+          strategy.release
+        end
+      end
+    end
+  end
 
-  task :create_release => :deploy
+  desc 'Copy repo to releases'
+  task :create_release => :'gitcopy:create_tarfile' do
 
-  task :check
+    on release_roles :all do
+      within deploy_to do
+        execute :mkdir, '-p', release_path
+        upload! strategy.local_tarfile, strategy.remote_tarfile
+        execute :tar, '--extract --verbose --file', strategy.remote_tarfile, '--directory', release_path
+        execute :rm, strategy.remote_tarfile
+      end
+    end
 
-  task :set_current_revision
+    run_locally do
+      if File.exists? strategy.local_tarfile
+        execute :rm, strategy.local_tarfile
+      end
+    end
+  end
 
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+    run_locally do
+      with fetch(:git_environmental_variables) do
+        set :current_revision, strategy.fetch_revision
+      end
+    end
+  end
 end

data/spec/lib/capistrano/gitcopy_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+require 'capistrano/gitcopy'
+
+module Capistrano
+  describe GitCopy do
+    let(:context) { Class.new.new }
+    subject { Capistrano::GitCopy.new(context, Capistrano::GitCopy::DefaultStrategy) }
+
+    describe "#git" do
+      it "should call execute git in the context, with arguments" do
+        context.expects(:execute).with(:git, :init)
+        subject.git(:init)
+      end
+    end
+  end
+
+  describe GitCopy::DefaultStrategy do
+    let(:context) { Class.new.new }
+    subject { Capistrano::GitCopy.new(context, Capistrano::GitCopy::DefaultStrategy) }
+
+    describe "#test" do
+      it "should call test for repo HEAD" do
+        context.expects(:repo_path).returns("/path/to/repo")
+        context.expects(:test).with " [ -f /path/to/repo/HEAD ] "
+
+        subject.test
+      end
+    end
+
+    describe "#check" do
+      it "should test the repo url" do
+        context.expects(:repo_url).returns(:url)
+        context.expects(:execute).with(:git, :'ls-remote --heads', :url).returns(true)
+
+        subject.check
+      end
+    end
+
+    describe "#clone" do
+      it "should run git clone" do
+        context.expects(:fetch).with(:git_shallow_clone).returns(nil)
+        context.expects(:repo_url).returns(:url)
+        context.expects(:repo_path).returns(:path)
+        context.expects(:execute).with(:git, :clone, '--verbose', '--mirror', :url, :path)
+
+        subject.clone
+      end
+
+      it "should run git clone in shallow mode" do
+        context.expects(:fetch).with(:git_shallow_clone).returns('1')
+        context.expects(:repo_url).returns(:url)
+        context.expects(:repo_path).returns(:path)
+
+        context.expects(:execute).with(:git, :clone, '--verbose', '--mirror', "--depth", '1', '--no-single-branch', :url, :path)
+
+        subject.clone
+      end
+    end
+
+    describe "#update" do
+      it "should run git update" do
+        context.expects(:fetch).with(:git_shallow_clone).returns(nil)
+        context.expects(:execute).with(:git, :remote, :update)
+
+        subject.update
+      end
+
+      it "should run git update in shallow mode" do
+        context.expects(:fetch).with(:git_shallow_clone).returns('1')
+        context.expects(:fetch).with(:branch).returns(:branch)
+        context.expects(:execute).with(:git, :fetch, "--depth", '1', "origin",  :branch)
+
+        subject.update
+      end
+    end
+
+    describe "#release" do
+      it "should run git archive without a subtree" do
+        context.expects(:fetch).with(:repo_tree).returns(nil)
+        context.expects(:fetch).with(:branch).returns(:branch)
+        context.expects(:fetch).with(:tmp_dir).returns('/tmp')
+        context.expects(:fetch).with(:application).returns('rspec-test')
+        context.expects(:fetch).with(:current_revision).returns('ABCDEF')
+
+        context.expects(:execute).with(:git, :archive, :branch, '--format', 'tar', "|gzip > /tmp/rspec-test-ABCDEF.tar.gz")
+
+        subject.release
+      end
+
+      it "should run git archive with a subtree" do
+        context.expects(:fetch).with(:repo_tree).returns('tree')
+        context.expects(:fetch).with(:branch).returns(:branch)
+        context.expects(:fetch).with(:tmp_dir).returns('/tmp')
+        context.expects(:fetch).with(:application).returns('rspec-test')
+        context.expects(:fetch).with(:current_revision).returns('ABCDEF')
+
+        context.expects(:execute).with(:git, :archive, :branch, 'tree', '--format', 'tar', "|gzip > /tmp/rspec-test-ABCDEF.tar.gz")
+
+        subject.release
+      end
+    end
+
+    describe "#fetch_revision" do
+      it "should capture git rev-list" do
+        context.expects(:fetch).with(:branch).returns(:branch)
+        context.expects(:capture).with(:git, "rev-list --max-count=1 --abbrev-commit --abbrev=12 branch").returns("01abcde")
+        revision = subject.fetch_revision
+        expect(revision).to eq("01abcde")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'capistrano/all'
+require 'rspec'
+require 'mocha/api'
+require 'time'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each {|f| require f}
+
+RSpec.configure do |config|
+	config.raise_errors_for_deprecations!
+  config.mock_framework = :mocha
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-scm-gitcopy
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.2
 platform: ruby
 authors:
 - Jack Wu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -25,6 +25,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: Gitcopy strategy for capistrano 3.x
 email:
 - xuwupeng2000@gmail.com
@@ -41,6 +69,8 @@ files:
 - lib/capistrano-scm-gitcopy.rb
 - lib/capistrano/gitcopy.rb
 - lib/capistrano/tasks/gitcopy.rake
+- spec/lib/capistrano/gitcopy_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/xuwupeng2000/capsitrano-scm-gitcopy.git
 licenses:
 - MIT
@@ -61,8 +91,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gitcopy strategy for capistrano 3.x
-test_files: []
+test_files:
+- spec/lib/capistrano/gitcopy_spec.rb
+- spec/spec_helper.rb