capistrano-net_storage 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59881a14b8980789fa4ef926786337ade0361eac
+  data.tar.gz: 0214927bf85b177f6ea64492c58cceeb84faab98
+SHA512:
+  metadata.gz: 21d9e21f3c3b016195d1268f8df7984d8312238bc5f378360157504892bc84a6395344f57a07c5181b7dc60c7fd22960d6c91ec143e3f9e2f1f6e406ade43e49
+  data.tar.gz: 67a53aa1569438d92ee71f7af8b44c153afce5e61412015ee4951e55043baeebec5044cd681f4aa31a2e6a5e92e4f9f505323aaa8a3b56c4477ea0c80912e479

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Editor Artifacts
+*.sw[pon]
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.8
+- 2.2.0
+before_install: gem install bundler -v 1.14.6
+install: bundle _1.14.6_ install
+script: bundle _1.14.6_ exec rake spec
+notifications:
+  slack:
+    secure: lJCLJetpFwFujt467h250JgTyjF+7qU04Ef6FdwOBZwvjgYmyyZMBhdbL2JOAxrQd6XCWhZy56jCXr4ZdMbMLtzL+wEkQefiOLdpV/556xXK5qmkjLyRWoYOMFEhxSTqjk8hHZVYcLO6IYmwr9CHBWaVGOydADCkR4CYyqmSHtKIbznSs9Y4qrpsf6YC9QiSxoP7d5hayvnVUI8oFvxC8DfPuwrmWoO4WyVTJy2ODg/r/ZNGJCMzW3pvnXGK5oZqgwArlGIV7l3tOX2l24QilkhxhuX7QRCikYoGiIdXqkXdf1S/piaflFGXJ1C2PN5aWEv1/8EYcm7RgPm8I9Pol+7zkpUFUiSj3FDLc/TZZKP7OwPCpXOXZkDTLn0+96H5oWUR+2xwTwETQpW8Qz6ZMiu4EKAiAeU99YgSZOgc3fmonvsQREFwTV1n9AHPFsTHv8f3bzC8gUm3n7PIZX4/vR7Aa+vTVZ1QGW9T7OuWThdCMVVB7L7Q/5pRaE+gFLsN9MQBfbZ5uOOXYHd+yh9rC5qi/wRXPxQ4w1F8R+iKIhF32nUF96jwwCkd7O/LZKlmFRT43App6sfmQIAdPp7Oy/BZZD34u0k5aOciZ59h10+BHmA1E0kphXfbYcbXd53MUCEiYc4HC2xtC5yT+ko+PQ2T37VkkneZIIhjRf+WzXQ=

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.2.0 (2017/4/12)
+
+Initial release.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 DeNA Co., Ltd., IKEDA Kiyoshi
+
+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 @@
+# Capistrano::NetStorage
+
+**Capistrano::NetStorage** is a [Capistrano](http://capistranorb.com/) plugin to deploy application
+via _remote storage_ such as [Amazon S3](https://aws.amazon.com/s3/),
+[Google Cloud Storage](https://cloud.google.com/storage/) and so on.
+
+Logically, this tool enables _O(1)_ deployment.
+
+
+## Concept
+
+The image below illustrates the concept of **Capistrano::NetStorage**.
+
+![concept](https://github.com/DeNADev/capistrano-net_storage/raw/resource/images/concept.png)
+
+This library goes following procedures as _capistrano tasks_:
+
+1. Prepare an archive of application to upload.
+  * Clone or update source code repository on deploy server.
+  * Do `bundle install` by an option.
+2. Upload the archive to _remote storage_.
+3. Download the archive from _remote storage_ on application servers.
+  * This task is executed in parallel way.
+
+NOTE:
+
+* You need to prepare a _transport class_ to execute upload/download operation suitable for
+_remote storage_. It should inherit `Capistrano::NetStorage::Transport::Base` class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-net_storage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-net_storage
+
+## Configuration
+
+Set Capistrano variables by `set name, value`.
+
+ Name | Default | Description
+------|---------|------------
+ `:scm`  | `nil` | Set `:net_storage`
+ `:branch` | `master` | Target branch of SCM to release
+ `:keep_releases` | `5` | Numbers to keep released versions
+ `:net_storage_transport` | `nil` | Transport class for _remote storage_
+ `:net_storage_archiver` | `Capistrano::NetStorage::Archiver::Zip` | Archiver class
+ `:net_storage_scm` | `Capistrano::NetStorage::SCM::Git` | Internal scm class for application repository
+ `:net_storage_with_bundle` | `false` | Do `bundle install` when creating archive
+ `:net_storage_config_files` | `nil` | Files to sync `config/` directory on target servers' application directory
+ `:net_storage_max_parallels` | number of servers | Max concurrency for remote tasks
+ `:net_storage_archive_on_missing` | `true` | If `true`, create and upload archive only when target archive is missing on remote storage
+ `:net_storage_upload_files_by_rsync` | `false` | Use rsync(1) to deploy config files
+ `:net_storage_local_base_path` | `.local_repo` | Base directory on deploy server
+
+### Transport Plugins
+
+Here are available plugins list which serves as `:net_storage_transport`:
+
+- [Capistrano::NetStorage::S3::Transport](https://github.com/DeNADev/capistrano-net_storage-s3)
+
+## Usage
+
+Edit Capfile:
+
+```ruby
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+require 'capistrano/net_storage'
+# Load transport plugin
+# require 'capistrano/net_storage/s3'
+```
+
+Edit your `config/deploy.rb`:
+
+```ruby
+set :scm, :net_storage
+set :net_storage_transport, Your::TransportPluginModule
+# set :net_storage_transport, Capistrano::NetStorage::S3::Transport # w/ capistrano-net_storage-s3
+# set :net_storage_config_files, [your_config_files]
+# set :net_storage_with_bundle, true
+# set :net_storage_archiver, Capistrano::NetStorage::Archiver::TarGzip
+```
+
+## Example
+
+You can see typical usage of this library by
+[capistrano-net_storage_demo](https://github.com/DeNADev/capistrano-net_storage_demo).
+
+## TODO
+
+* Support
+[Capistrano SCM plugin system](http://capistranorb.com/documentation/advanced-features/custom-scm/)
+introduced in Capistrano v3.7
+
+## License
+
+Available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright (c) 2017 DeNA Co., Ltd., IKEDA Kiyoshi
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Open a pry session preloaded with the library'
+task :console do
+  sh 'pry --gem'
+end
+task c: :console
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/capistrano-net_storage.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/net_storage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-net_storage'
+  spec.version       = Capistrano::NetStorage::VERSION
+  spec.authors       = ['progrhyme']
+
+  spec.summary       = 'Capistrano SCM Plugin for fast deployment via remote storage'
+  spec.description   = <<-EODESC
+    A Capistrano SCM Plugin to deploy application via remove storage.
+    Logically, this enables O(1) deployment.
+  EODESC
+  spec.homepage      = 'https://github.com/DeNADev/capistrano-net_storage'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency 'capistrano', '>= 3.3.3'
+  spec.add_runtime_dependency 'parallel'
+  spec.add_runtime_dependency 'bundler'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

data/lib/capistrano/net_storage/all.rb

@@ -0,0 +1,20 @@
+require 'capistrano/net_storage/base'
+require 'capistrano/net_storage/error'
+require 'capistrano/net_storage/config'
+require 'capistrano/net_storage/coordinator'
+require 'capistrano/net_storage/utils'
+require 'capistrano/net_storage/bundler'
+require 'capistrano/net_storage/cleaner'
+require 'capistrano/net_storage/archiver/zip'
+require 'capistrano/net_storage/archiver/tar_gzip'
+require 'capistrano/net_storage/scm/git'
+require 'capistrano/net_storage/version'
+
+# See capistrano/net_storage/base.rb
+Capistrano::NetStorage.setup! do
+  config = Capistrano::NetStorage::Config.new
+  {
+    config: config,
+    coordinator: Capistrano::NetStorage::Coordinator.new(config),
+  }
+end

data/lib/capistrano/net_storage/archiver/base.rb

@@ -0,0 +1,28 @@
+module Capistrano
+  module NetStorage
+    module Archiver
+      # Abstract class to archive and extract whole application contents
+      # @abstract
+      class Base
+        # Check prerequisites to archive
+        # @abstract
+        def check
+          raise NotImplementedError
+        end
+
+        # Create archive
+        # @abstract
+        def archive
+          raise NotImplementedError
+        end
+
+        # Extract archive.
+        # Archive file should be cleaned up after extracted.
+        # @abstract
+        def extract
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/archiver/tar_gzip.rb

@@ -0,0 +1,33 @@
+require 'capistrano/net_storage/archiver/base'
+require 'capistrano/net_storage/utils'
+
+# Archiver class for .tar.gz format
+class Capistrano::NetStorage::Archiver::TarGzip < Capistrano::NetStorage::Archiver::Base
+  include Capistrano::NetStorage::Utils
+
+  def check
+    on :local do
+      execute :which, 'tar'
+    end
+  end
+
+  def archive
+    c = config
+    on :local do
+      within c.local_release_path do
+        execute :tar, 'czf', c.local_archive_path, '.'
+      end
+    end
+  end
+
+  def extract
+    c = config
+    on c.servers, in: :groups, limit: c.max_parallels do
+      execute :mkdir, '-p', release_path
+      within release_path do
+        execute :tar, 'xzf', c.archive_path
+        execute :rm, '-f', c.archive_path
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/archiver/zip.rb

@@ -0,0 +1,30 @@
+require 'capistrano/net_storage/archiver/base'
+require 'capistrano/net_storage/utils'
+
+# Archiver class for zip format
+class Capistrano::NetStorage::Archiver::Zip < Capistrano::NetStorage::Archiver::Base
+  include Capistrano::NetStorage::Utils
+
+  def check
+    on :local do
+      execute :which, 'zip'
+    end
+  end
+
+  def archive
+    c = config
+    on :local do
+      within c.local_release_path do
+        execute :zip, c.local_archive_path, '-r', '.'
+      end
+    end
+  end
+
+  def extract
+    c = config
+    on c.servers, in: :groups, limit: c.max_parallels do
+      execute :unzip, c.archive_path, '-d', release_path
+      execute :rm, '-f', c.archive_path
+    end
+  end
+end

data/lib/capistrano/net_storage/base.rb

@@ -0,0 +1,18 @@
+require 'forwardable'
+
+module Capistrano
+  module NetStorage
+    class << self
+      attr_reader :config, :coordinator
+
+      extend Forwardable
+      def_delegators :coordinator, :archiver, :scm, :cleaner, :bundler, :transport
+    end
+
+    def self.setup!(params = nil)
+      params       ||= yield
+      @config        = params[:config]
+      @coordinator   = params[:coordinator]
+    end
+  end
+end

data/lib/capistrano/net_storage/bundler.rb

@@ -0,0 +1,67 @@
+require 'bundler'
+require 'capistrano/net_storage/utils'
+
+module Capistrano
+  module NetStorage
+    class Bundler
+      include Capistrano::NetStorage::Utils
+
+      def check
+        on :local do
+          execute :which, 'bundle'
+        end
+      end
+
+      # Do bundle install locally. Installed gems are to be included to the release.
+      def install
+        c = config
+        on :local do
+          local_release_bundle_path = c.local_release_path.join('vendor', 'bundle')
+          execute :mkdir, '-p', local_release_bundle_path
+          execute :mkdir, '-p', "#{c.local_release_path}/.bundle"
+          # Copy shared gems to release bundle path beforehand to reuse installed previously
+          execute :rsync, '-a', "#{c.local_bundle_path}/", "#{local_release_bundle_path}/"
+
+          within c.local_release_path do
+            ::Bundler.with_clean_env do
+              install_options = %W(
+                --gemfile #{c.local_release_path}/Gemfile --deployment --quiet
+                --path #{local_release_bundle_path} --without development test
+              )
+              execute :bundle, 'install', *install_options
+              execute :bundle, 'clean'
+              # Sync installed gems to shared directory to reuse them next time
+              rsync_options = %W(-a --delete #{local_release_bundle_path}/ #{c.local_bundle_path}/)
+              execute :rsync, *rsync_options
+            end
+          end
+        end
+      end
+
+      # Create +.bundle/config+ at release path on remote servers
+      def sync_config
+        c = config
+
+        on c.servers, in: :groups, limit: c.max_parallels do
+          within release_path do
+            execute :mkdir, '-p', '.bundle'
+          end
+        end
+
+        bundle_config_path = "#{c.local_base_path}/bundle_config"
+        File.open(bundle_config_path, 'w') do |file|
+          file.print(<<-EOS)
+---
+BUNDLE_FROZEN: "1"
+BUNDLE_PATH: "#{release_path.join('vendor', 'bundle')}"
+BUNDLE_WITHOUT: "development:test"
+BUNDLE_DISABLE_SHARED_GEMS: "true"
+BUNDLE_BIN: "#{release_path.join('bin')}"
+EOS
+        end
+
+        upload_files([bundle_config_path], dest_path: release_path.join('.bundle', 'config'))
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/cleaner.rb

@@ -0,0 +1,30 @@
+require 'capistrano/net_storage/utils'
+
+module Capistrano
+  module NetStorage
+    # Executor class for cleaning tasks
+    class Cleaner
+      include Capistrano::NetStorage::Utils
+
+      # Clean up local release directories and archives.
+      # Assumes they are under +config.local_releases_path+
+      # @see Capistrano::NetStorage::Config#local_releases_path
+      def cleanup_local_release
+        c = config
+        on :local do
+          releases = capture(:ls, '-xtr', c.local_releases_path).split
+          # Contains archive files and extracted directories
+          if releases.count > fetch(:keep_releases) * 2
+            info "Keeping #{fetch(:keep_releases)} * 2 of #{releases.count} local releases"
+            olds_str = (releases - releases.last(fetch(:keep_releases) * 2)).map do |file|
+              c.local_releases_path.join(file)
+            end.join(' ')
+            execute :rm, '-rf', olds_str
+          else
+            info "No old local releases in #{c.local_releases_path}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/config.rb

@@ -0,0 +1,163 @@
+require 'capistrano/net_storage/error'
+require 'capistrano/net_storage/bundler'
+require 'capistrano/net_storage/archiver/zip'
+require 'capistrano/net_storage/scm/git'
+
+module Capistrano
+  module NetStorage
+    class Config
+      def executor_class(type)
+        @executor_classes ||= {}
+        @executor_classes[type] ||= fetch(:"net_storage_#{type}")
+        @executor_classes[type] ||= begin
+          case type
+          when :archiver
+            Capistrano::NetStorage::Archiver::Zip
+          when :scm
+            Capistrano::NetStorage::SCM::Git
+          when :cleaner
+            Capistrano::NetStorage::Cleaner
+          when :bundler
+            Capistrano::NetStorage::Bundler
+          when :transport
+            msg = 'You have to set :net_storage_transport because no default transport class!'
+            raise Capistrano::NetStorage::Error, msg
+          else
+            raise "Unknown type! #{type}"
+          end
+        end
+      end
+
+      # Servers to deploy
+      def servers
+        fetch(:net_storage_servers, -> { release_roles(:all) })
+      end
+
+      def max_parallels
+        @max_parallels ||= fetch(:net_storage_max_parallels, servers.size)
+      end
+
+      # Application configuration files to be deployed with
+      # @return [Array<String, Pathname>]
+      def config_files
+        @config_files ||= fetch(:net_storage_config_files)
+      end
+
+      # If +true+, skip to bundle gems bundled with target app.
+      # Defaults to +true+
+      def skip_bundle?
+        @has_checked_skip_bundle ||= begin
+          @skip_bundle = !fetch(:net_storage_with_bundle)
+          true
+        end
+        @skip_bundle
+      end
+
+      # If +true+, create archive ONLY when it's not found on Network Storage.
+      # Otherwise, create archive ALWAYS.
+      # Defaults to +true+
+      def archive_on_missing?
+        @has_checked_archive_on_missing ||= begin
+          @archive_on_missing = fetch(:net_storage_archive_on_missing, true)
+          true
+        end
+        @archive_on_missing
+      end
+
+      # If +true+, use +rsync+ to sync config files.
+      # Otherwise, use +upload!+ by sshkit.
+      # Defaults to +false+
+      # @see #rsync_options
+      def upload_files_by_rsync?
+        @upload_files_by_rsync ||= fetch(:net_storage_upload_files_by_rsync, false)
+      end
+
+      # You can set +:user+, +:keys+, +:port+ as ssh options for +rsync+ command to sync configs
+      # when +:net_storage_upload_files_by_rsync+ is set +true+.
+      # @see #upload_files_by_rsync?
+      def rsync_options
+        @rsync_options ||= fetch(:net_storage_rsync_options, fetch(:ssh_options, {}))
+      end
+
+      #
+      # Path settings
+      #
+
+      # Path of base directory on localhost
+      # @return [Pathname]
+      def local_base_path
+        @local_base_path ||= pathname(fetch(:net_storage_local_base_path, "#{Dir.pwd}/.local_repo"))
+      end
+
+      # Path to clone repository on localhost
+      # @return [Pathname]
+      def local_mirror_path
+        @local_mirror_path ||= pathname(fetch(:net_storage_local_mirror_path))
+        @local_mirror_path ||= local_base_path.join('mirror')
+      end
+
+      # Path to keep release directories and archives on localhost
+      # @return [Pathname]
+      def local_releases_path
+        @local_releases_path ||= pathname(fetch(:net_storage_local_releases_path))
+        @local_releases_path ||= local_base_path.join('releases')
+      end
+
+      # Path to take a snapshot of repository for release
+      # @return [Pathname]
+      def local_release_path
+        @local_release_path ||= pathname(fetch(:net_storage_local_release_path))
+        @local_release_path ||= local_releases_path.join(release_timestamp)
+      end
+
+      # Shared directory to install gems
+      # @return [Pathname]
+      def local_bundle_path
+        @local_bundle_path ||= pathname(fetch(:net_storage_local_bundle_path))
+        @local_bundle_path ||= local_base_path.join('bundle')
+      end
+
+      # Destination path to archive application on localhost
+      # @return [Pathname]
+      def local_archive_path
+        @local_archive_path ||= pathname(fetch(:net_storage_local_archive_path))
+        @local_archive_path ||= pathname("#{local_release_path}.#{archive_suffix}")
+      end
+
+      # Path of archive file to be downloaded on servers
+      # @return [Pathname]
+      def archive_path
+        @archive_path ||= pathname(fetch(:net_storage_archive_path))
+        @archive_path ||= begin
+          # Set release_timestamp if not set
+          fetch(:release_path, set_release_path)
+          pathname("#{release_path}.#{archive_suffix}")
+        end
+      end
+
+      # Suffix of archive file
+      # @return [String]
+      def archive_suffix
+        case Capistrano::NetStorage.archiver
+        when Capistrano::NetStorage::Archiver::Zip
+          'zip'
+        when Capistrano::NetStorage::Archiver::TarGzip
+          'tar.gz'
+        else
+          'archive'
+        end
+      end
+
+      private
+
+      def pathname(path)
+        case path
+        when String
+          Pathname.new(path)
+        else
+          path
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/coordinator.rb

@@ -0,0 +1,38 @@
+module Capistrano
+  module NetStorage
+    class Coordinator
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def archiver
+        load_executor(:archiver)
+      end
+
+      def transport
+        load_executor(:transport)
+      end
+
+      def cleaner
+        load_executor(:cleaner)
+      end
+
+      def bundler
+        load_executor(:bundler)
+      end
+
+      def scm
+        load_executor(:scm)
+      end
+
+      private
+
+      def load_executor(type)
+        @executors ||= {}
+        @executors[type] ||= config.executor_class(type).new
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/error.rb

@@ -0,0 +1,6 @@
+module Capistrano
+  module NetStorage
+    class Error < StandardError
+    end
+  end
+end

data/lib/capistrano/net_storage/scm/base.rb

@@ -0,0 +1,49 @@
+require 'capistrano/net_storage/utils'
+
+module Capistrano
+  module NetStorage
+    module SCM
+      # Base internal SCM class of Capistrano::Netstrage
+      # @abstract
+      class Base
+        include Capistrano::NetStorage::Utils
+
+        # Check SCM prerequisites
+        # @abstract
+        def check
+          raise NotImplementedError
+        end
+
+        # Clone repository to local
+        # @abstract
+        def clone
+          raise NotImplementedError
+        end
+
+        # Update local repository
+        # @abstract
+        def update
+          raise NotImplementedError
+        end
+
+        # Set current revision to be deployed of the repository
+        # @abstract
+        def set_current_revision
+          raise NotImplementedError
+        end
+
+        # Prepare snapshot of repository to be archived for release
+        # @abstract
+        def prepare_archive
+          raise NotImplementedError
+        end
+
+        # Copy local config files to servers
+        def sync_config
+          return unless config.config_files
+          upload_files(config.config_files, dest_dir: release_path.join('config'))
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/scm/git.rb

@@ -0,0 +1,61 @@
+require 'capistrano/net_storage/scm/base'
+
+# Internal SCM class for Git repository
+class Capistrano::NetStorage::SCM::Git < Capistrano::NetStorage::SCM::Base
+  def check
+    on :local do
+      execute :git, 'ls-remote', repo_url, 'HEAD'
+    end
+  end
+
+  def clone
+    c = config
+    on :local do
+      if File.exist?("#{c.local_mirror_path}/HEAD")
+        info t(:mirror_exists, at: c.local_mirror_path)
+      else
+        execute :git, :clone, '--mirror', repo_url, c.local_mirror_path
+      end
+    end
+  end
+
+  def update
+    c = config
+    on :local do
+      within c.local_mirror_path do
+        execute :git, :remote, :update
+      end
+    end
+  end
+
+  def set_current_revision
+    return if fetch(:current_revision)
+    c = config
+    on :local do
+      within c.local_mirror_path do
+        set :current_revision, capture(:git, "rev-parse #{fetch(:branch)}")
+      end
+    end
+  end
+
+  def prepare_archive
+    c = config
+    on :local do
+      execute :mkdir, '-p', c.local_release_path
+
+      within c.local_mirror_path do
+        if tree = fetch(:repo_tree)
+          stripped = tree.slice %r{^/?(.*?)/?$}, 1 # strip both side /
+          num_components = stripped.count('/')
+          execute(
+            :git, :archive, fetch(:branch), tree,
+            "| tar -x --strip-components #{num_components} -f - -C ",
+            c.local_release_path
+          )
+        else
+          execute :git, :archive, fetch(:branch), '| tar -x -C', c.local_release_path
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/transport/base.rb

@@ -0,0 +1,34 @@
+module Capistrano
+  module NetStorage
+    module Transport
+      # Abstract class to transport archive from/to Network Storage
+      # @abstract
+      class Base
+        # Check prerequisites for transport
+        # @abstract
+        def check
+          raise NotImplementedError
+        end
+
+        # Find uploaded archive to be deployed and set +:net_storage_uploaded_archive+ its address
+        # @abstract
+        def find_uploaded
+          raise NotImplementedError
+        end
+
+        # Upload archive onto remote storage
+        # @abstract
+        def upload
+          raise NotImplementedError
+        end
+
+        # Download archive from remote storage to servers.
+        # Archive file should be placed at +config.archive_path+
+        # @abstract
+        def download
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/utils.rb

@@ -0,0 +1,67 @@
+require 'parallel'
+
+require 'capistrano/net_storage/base'
+
+module Capistrano
+  module NetStorage
+    # Common utility methods
+    module Utils
+      private
+
+      # @see lib/capistrano/net_storage/base.rb
+      def config
+        Capistrano::NetStorage.config
+      end
+
+      # @param dest_dir [String, Pathname] Destination directory on remote to copy local files into
+      # @param dest_path [String, Pathname] Destination file path on remote to copy local files to
+      # You can provide either of +dest_dir+ or +dest_path+, or files are copied to same pathes
+      def upload_files(files, dest_dir: nil, dest_path: nil)
+        c = config
+        files.each do |src|
+          basename = File.basename(src)
+          dest = dest_path || begin
+            dir = dest_dir || File.dirname(src)
+            File.join(dir, basename)
+          end
+
+          if c.upload_files_by_rsync?
+            Parallel.each(c.servers, in_threads: c.max_parallels) do |host|
+              ssh = build_ssh_command(host)
+              on :local do
+                execute :rsync, "-az --rsh='#{ssh}' #{src} #{host}:#{dest}"
+              end
+            end
+          else
+            on c.servers, in: :groups, limit: c.max_parallels do
+              upload! src, dest
+            end
+          end
+        end
+      end
+
+      # Build ssh command with options for rsync
+      def build_ssh_command(host)
+        user_opt    = ''
+        key_opt     = ''
+        port_opt    = ''
+        ssh_options = config.rsync_options
+
+        if user = host.user || ssh_options[:user]
+          user_opt = " -l #{user}"
+        end
+
+        if keys = (host.keys.empty? ? ssh_options[:keys] : host.keys)
+          keys    = keys.is_a?(Array) ? keys : [keys]
+          key_opt = keys.map { |key| " -i #{key}" }.join('')
+        end
+
+        if port = host.port || ssh_options[:port]
+          port_opt = " -p #{port}"
+        end
+
+        "ssh#{user_opt}#{key_opt}#{port_opt}"
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module NetStorage
+    VERSION = '0.2.0'
+  end
+end

data/lib/capistrano/net_storage.rb

@@ -0,0 +1,2 @@
+require 'capistrano/net_storage/all'
+load File.expand_path('../tasks/net_storage.rake', __FILE__)

data/lib/capistrano/tasks/net_storage.rake

@@ -0,0 +1,124 @@
+unless defined?(Capistrano::NetStorage::TASK_LOADED) # prevent multiple loads
+Capistrano::NetStorage::TASK_LOADED = true
+
+namespace :net_storage do
+  # Tasks called by deploy.rake bundled in capistrano core:
+  #  - :check
+  #  - :create_release
+  #  - :set_current_revision
+  desc %(Check all components' statuses)
+  check_dependencies = %w(archiver transport bundler scm directories).map do |t|
+    "net_storage:check:#{t}".to_sym
+  end
+  task check: check_dependencies
+
+  desc 'Create and deploy archives via remove storage'
+  task create_release: :'net_storage:check' do
+    config = Capistrano::NetStorage.config
+    skip_upload = false
+    if config.archive_on_missing?
+      invoke 'net_storage:transport:find_uploaded'
+      if fetch(:net_storage_uploaded_archive)
+        skip_upload = true
+      end
+    end
+    unless skip_upload
+      invoke 'net_storage:upload_archive'
+    end
+    invoke 'net_storage:pull_deploy'
+  end
+
+  desc 'Set the revision to be deployed'
+  task set_current_revision: :'net_storage:scm:update' do
+    Capistrano::NetStorage.scm.set_current_revision
+  end
+
+  # Additional tasks for capistrano-net_storage
+
+  desc 'Deploy config files'
+  task :sync_config do
+    config = Capistrano::NetStorage.config
+    Capistrano::NetStorage.scm.sync_config
+    Capistrano::NetStorage.bundler.sync_config unless config.skip_bundle?
+  end
+  after 'net_storage:create_release', 'net_storage:sync_config'
+
+  desc 'Clean up local old archives and snapshots'
+  task :cleanup_local_release do
+    Capistrano::NetStorage.cleaner.cleanup_local_release
+  end
+  after 'deploy:cleanup', 'net_storage:cleanup_local_release'
+
+  task prepare_archive: %i(net_storage:scm:update net_storage:check:bundler) do
+    config = Capistrano::NetStorage.config
+    Capistrano::NetStorage.scm.prepare_archive
+    Capistrano::NetStorage.bundler.install unless config.skip_bundle?
+  end
+
+  task create_archive: :'net_storage:prepare_archive' do
+    Capistrano::NetStorage.archiver.archive
+  end
+
+  task upload_archive: :'net_storage:create_archive' do
+    Capistrano::NetStorage.transport.upload
+  end
+
+  task pull_deploy: :'net_storage:transport:find_uploaded' do
+    Capistrano::NetStorage.transport.download
+    Capistrano::NetStorage.archiver.extract
+  end
+
+  namespace :check do
+    task :archiver do
+      Capistrano::NetStorage.archiver.check
+    end
+
+    task :transport do
+      Capistrano::NetStorage.transport.check
+    end
+
+    task :bundler do
+      config = Capistrano::NetStorage.config
+      Capistrano::NetStorage.bundler.check unless config.skip_bundle?
+    end
+
+    task :scm do
+      Capistrano::NetStorage.scm.check
+    end
+
+    task :directories do
+      config = Capistrano::NetStorage.config
+      dirs = [
+        config.local_base_path,
+        config.local_mirror_path,
+        config.local_releases_path,
+      ]
+      dirs << config.local_bundle_path unless config.skip_bundle?
+      on :local do
+        dirs.each { |dir| execute :mkdir, '-p', dir }
+      end
+    end
+  end
+
+  namespace :scm do
+    task clone: %i(net_storage:check:scm net_storage:check:directories) do
+      Capistrano::NetStorage.scm.clone
+    end
+
+    task update: :'net_storage:scm:clone' do
+      Capistrano::NetStorage.scm.update
+    end
+
+    task set_current_revision: :'net_storage:scm:update' do
+      Capistrano::NetStorage.scm.set_current_revision
+    end
+  end
+
+  namespace :transport do
+    task find_uploaded: :'net_storage:scm:set_current_revision' do
+      Capistrano::NetStorage.transport.find_uploaded
+    end
+  end
+end
+
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-net_storage
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- progrhyme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: |2
+      A Capistrano SCM Plugin to deploy application via remove storage.
+      Logically, this enables O(1) deployment.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-net_storage.gemspec
+- lib/capistrano-net_storage.rb
+- lib/capistrano/net_storage.rb
+- lib/capistrano/net_storage/all.rb
+- lib/capistrano/net_storage/archiver/base.rb
+- lib/capistrano/net_storage/archiver/tar_gzip.rb
+- lib/capistrano/net_storage/archiver/zip.rb
+- lib/capistrano/net_storage/base.rb
+- lib/capistrano/net_storage/bundler.rb
+- lib/capistrano/net_storage/cleaner.rb
+- lib/capistrano/net_storage/config.rb
+- lib/capistrano/net_storage/coordinator.rb
+- lib/capistrano/net_storage/error.rb
+- lib/capistrano/net_storage/scm/base.rb
+- lib/capistrano/net_storage/scm/git.rb
+- lib/capistrano/net_storage/transport/base.rb
+- lib/capistrano/net_storage/utils.rb
+- lib/capistrano/net_storage/version.rb
+- lib/capistrano/tasks/net_storage.rake
+homepage: https://github.com/DeNADev/capistrano-net_storage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Capistrano SCM Plugin for fast deployment via remote storage
+test_files: []