capistrano2-remote_cache_from_local 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 300c48ccaf62c3a4b22e0423a2df1599fa236d7a
+  data.tar.gz: ac55d5ea4cdbaed42f3c855a17e89a52f349ad8d
+SHA512:
+  metadata.gz: b82947c59fd18a095120ed1fd38ce61987c37f8f3da5e2b2b437fae3ff4999f6a058a83f633a8931cda413605ddaa762a2cf225340b1a09ddaa1fca0c9e7abf8
+  data.tar.gz: 64412d07911a9026874b85752b5e052fc065dd946994e3acb7596054ecebda47a494d4d5d6158f74e838e2400d8e556faaf8ef2659d7caaff73d2e41a7262e51

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano2-remote_cache_from_local.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Collaborative Drug Discovery
+
+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,115 @@
+# :remote_cache_from_local for Capistrano 2
+
+This gem allows you to deploy a project using Capistrano 2 directly from the
+local git repo to the deployment server, removing your reliance on a central,
+possibly-unavailable SCM service. It supports git submodules in the same way —
+your local checkouts of the project's submodules will be used to clone on the
+deployment server.
+
+It piggybacks on the SSH connection that Capistrano sets up, so you do not need
+to separately configure it. Besides cloning from the local checkout, it
+otherwise behaves the same as Capistrano's built-in `:remote_cache` strategy.
+
+### Alternatives
+
+Capistrano's `:copy` strategy can also deploy from the local working copy, at
+the cost of re-copying the entire codebase from the local machine to the server
+on every deploy. This strategy takes advantage of git to only transfer what has
+changed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano2-remote_cache_from_local', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano2-remote_cache_from_local
+
+## Usage
+
+In your `deploy.rb`, add this line:
+
+```
+require 'capistrano/remote_cache_from_local'
+```
+
+**Remove** anywhere you have a `:repository`, `:scm`, or `:deploy_via` variable
+set. This strategy needs to specify those values for you.
+
+```ruby
+# set :repository, 'git+shh://git.example.com/foo.git'
+# set :scm, :git
+# set :deploy_via, :remote_cache
+```
+
+Set any of the following variables if you need a value other than the defaults
+listed here:
+
+```ruby
+# The path to the root of the local working copy, relative to this project's root.
+set :local_repository, '.'
+# The port used for the temporary git daemon.
+set :git_tunnel_local_port, 50123
+# The port used for the remote side of the temporary SSH tunnel used for cloning
+set :git_tunnel_remote_port, 50123
+# The PID file used to keep track of the git daemon.
+set :git_daemon_pid_file, 'tmp/git-daemon.pid'
+# To see the details of the git operations, make this true
+set :scm_verbose, false
+```
+
+To enable submodules to be cloned from the local copies, you must also disable
+Capistrano's built-in submodule support:
+
+```ruby
+# Disable built-in submodule support
+set :git_enable_submodules, false
+# Enable remote_cache_from_local's submodule support
+set :git_local_enable_submodules, true
+```
+
+## Security
+
+In order to make the local repo available to clone from the server, the strategy
+starts a temporary [git-daemon][]. It listens only on `localhost` — connections
+from the server are forwarded via an SSH tunnel — so it is not visible to the
+network at large.
+
+However, because connections to git-daemon are not authenticated, this temporary
+daemon is accessible to any process running on the deploying machine. A
+malicious process running as a different user could gain read access to the
+deployed application's source code. So don't use this if you don't trust the
+machine you are deploying from.
+
+[git-daemon]: https://www.kernel.org/pub/software/scm/git/docs/git-daemon.html
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then,
+run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cdd/capistrano2-remote_cache_from_local.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Future work
+
+* An alternate implementation for Capistrano 3.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capistrano2-remote_cache_from_local.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/remote_cache_from_local/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano2-remote_cache_from_local"
+  spec.version       = Capistrano::RemoteCacheFromLocal::VERSION
+  spec.authors       = ["Rhett Sutphin"]
+  spec.email         = ["rhett@detailedbalance.net"]
+
+  spec.summary       = %q{Allows deploying with capistrano directly from the local git repo.}
+  spec.description   = %q{A deployment strategy for Capistrano 2 that allows deploying directly from the local git repo, piggybacking on Capistrano's existing SSH connection.}
+  spec.homepage      = "https://github.com/cdd/capistrano2-remote_cache_from_local"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", "~> 2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/capistrano/recipes/deploy/scm/git_local.rb

@@ -0,0 +1,61 @@
+require 'capistrano/recipes/deploy/scm/git'
+
+module Capistrano::Deploy::SCM
+  ##
+  # An SCM that works in tandem with the :remote_cache_from_local strategy
+  # to support git submodules being retrieved via the local SSH tunnel also.
+  # Does not currently support recursive submodules.
+  class GitLocal < Git
+    default_command "git" # Not inherited
+
+    def checkout(revision, destination)
+      super_command = super
+      super_with_submodules_if_enabled(super_command, destination)
+    end
+
+    def sync(revision, destination)
+      sync_command = super
+      # Match remote URL to current repository setting — don't know why the base
+      # Git SCM only does this when the remote is not "origin".
+      sync_with_remote_set_url_command = [
+        "cd #{destination}",
+        "#{command} remote set-url #{origin} #{variable(:repository)}",
+        sync_command
+      ].join(' && ')
+
+      super_with_submodules_if_enabled(sync_with_remote_set_url_command, destination)
+    end
+
+    private
+
+    def super_with_submodules_if_enabled(super_command, destination)
+      if variable(:git_local_enable_submodules)
+        [super_command, update_submodules(destination)].join(' && ')
+      else
+        super_command
+      end
+    end
+
+    def update_submodules(main_checkout)
+      git = command
+      repo_prefix = repository.sub(/\.git$/, '')
+      execute = []
+
+      submodules_root = File.expand_path('../cached-submodules', main_checkout)
+      execute << "mkdir -p #{submodules_root}"
+      execute << "cd #{main_checkout}"
+      execute << "#{git} submodule #{verbose} init"
+      # This mess does the following:
+      # - Parses .gitmodules to extract a list of [path-property-name, path-value] pairs
+      # - For each of these pairs,
+      #   - Transforms the path property name to the URL property name
+      #   - Uses git-config to set the local URL property of the submodule to the version available via the SSH tunnel
+      # N.b.: `git submodule foreach` could do this slightly cleaner, but it doesn't work until after `update` for some reason.
+      execute << %Q[#{git} config -f .gitmodules --get-regexp 'submodule.*path' | awk '{ gsub("path", "url", $1); system(sprintf("git config %s #{repo_prefix}%s/.git", $1, $2)) }']
+      execute << "#{git} config --get-regexp submodule" if variable(:scm_verbose)
+      execute << "#{git} submodule #{verbose} update"
+
+      execute.join(' && ')
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+require 'capistrano/recipes/deploy/strategy/remote_cache'
+
+module Capistrano::Deploy::Strategy
+  ##
+  # A deployment strategy which has the app server pull the code from the
+  # deploying machine via an SSH tunnel. The strategy behaves like :remote_cache
+  # otherwise.
+  class RemoteCacheFromLocal < RemoteCache
+    private
+
+    def update_repository_cache
+      configuration.set(:repository, "git://127.0.0.1:#{git_tunnel_remote_port}/.git")
+      with_tunneled_local_daemon { super }
+    end
+
+    def with_tunneled_local_daemon
+      execute_on_servers do |servers|
+        servers.each do |s|
+          begin
+            # Run a git daemon locally (listening on 127.0.0.1 only)
+            execute "Run local git daemon" do
+              system "git daemon --verbose --listen=127.0.0.1 --port=#{git_tunnel_local_port} --reuseaddr --export-all --base-path='#{local_repository}' --detach --pid-file='#{git_daemon_pid_file}'"
+            end
+
+            # Forward remote connections to local git daemon via capistrano's SSH session
+            session = sessions[s]
+            session.forward.remote(git_tunnel_local_port, '127.0.0.1', git_tunnel_remote_port)
+            keep_looping = true
+            Thread.new { session.loop { sleep(0.1); keep_looping } }
+
+            yield
+          ensure
+            keep_looping = false
+            execute "Kill local git daemon if running" do
+              system "if [ -e #{git_daemon_pid_file} ]; then kill `cat '#{git_daemon_pid_file}'`; rm '#{git_daemon_pid_file}'; fi"
+            end
+          end
+        end
+      end
+    end
+
+    def git_tunnel_local_port
+      fetch(:git_tunnel_local_port, 50123)
+    end
+
+    def git_tunnel_remote_port
+      fetch(:git_tunnel_remote_port, 50123)
+    end
+
+    def git_daemon_pid_file
+      fetch(:git_daemon_pid_file, 'tmp/git-daemon.pid')
+    end
+
+    # Local execution methods copied from the copy strategy
+
+    def execute(description, &block)
+      logger.debug description
+      handle_system_errors(&block)
+    end
+
+    def handle_system_errors(&block)
+      block.call
+      raise_command_failed if last_command_failed?
+    end
+
+    def raise_command_failed
+      raise Capistrano::Error, "shell command failed with return code #{$?}"
+    end
+
+    def last_command_failed?
+      $? != 0
+    end
+  end
+end

data/lib/capistrano/remote_cache_from_local/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module RemoteCacheFromLocal
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/remote_cache_from_local.rb

@@ -0,0 +1,6 @@
+if Capistrano::Configuration.instance
+  config = Capistrano::Configuration.instance
+  config.set :scm, :git_local
+  config.set :deploy_via, :remote_cache_from_local
+  config.set :local_repository, '.'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: capistrano2-remote_cache_from_local
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rhett Sutphin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A deployment strategy for Capistrano 2 that allows deploying directly
+  from the local git repo, piggybacking on Capistrano's existing SSH connection.
+email:
+- rhett@detailedbalance.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano2-remote_cache_from_local.gemspec
+- lib/capistrano/recipes/deploy/scm/git_local.rb
+- lib/capistrano/recipes/deploy/strategy/remote_cache_from_local.rb
+- lib/capistrano/remote_cache_from_local.rb
+- lib/capistrano/remote_cache_from_local/version.rb
+homepage: https://github.com/cdd/capistrano2-remote_cache_from_local
+licenses:
+- MIT
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Allows deploying with capistrano directly from the local git repo.
+test_files: []