capistrano-s3_archive 0.9.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97cf12d50fcd21483d0594609a57b4867f898e47
-  data.tar.gz: 7109636be3cb0841c520546ca318991c5a6bbf28
+SHA256:
+  metadata.gz: af4eb25b90c60b6a5ef6f072ff01024706128c1924e051424191f3d1f535ff50
+  data.tar.gz: 523ba94440f350ae342fd2b73b45f0d9b593cbf7e9d3935c4e239c100649d03b
 SHA512:
-  metadata.gz: f0953e0106a31337751b0e0c9eb045ce845581d313ad040a96ab529308a2911c4fc127b182be47ff9d3da80d94a614974163521862e40d2fb0acefef23b24903
-  data.tar.gz: 243cc2aa9fd85e1977a08705827ae26f3a2d10be857bdd1430c6cc47406cbf39c09775c28baff8c5bc298fd37650364d72b786efe5e9b331df24f1e6fe5bfad2
+  metadata.gz: cfe3e1ac51a0dac8ef600e2a313feb4e3a665120c3ee1df0e46292e6e455c8ea428e50cdec7c8d5437c9bdc699259bbd5cc232b909cc4e0a4d5bec02cdda2a80
+  data.tar.gz: 7c2bb15d6493e9e2f82704c5d0e544679f27ea69c920501b81f5e1701d9a4b7c88dec4180a096b192675decf6bdde70fe7e20ce74f996281f2bb4c0c8fdc0dcd

data/.gitignore

@@ -7,9 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor
 
-.vagrant
-/vagrant_example/Gemfile.lock
-/vagrant_example/.bundle/
-/vagrant_example/vendor/
-/vagrant_example/tmp/
+/example/vendor
+/example/tmp/
+/example/log/

data/.rubocop.yml

@@ -0,0 +1,73 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
+  Exclude:
+    - "vagrant_example/**/*"
+    - "vendor/**/*"
+    - "spec/**/*"
+    - "lib/capistrano/**/*legacy*"
+    - "example/**/*"
+
+Lint/AmbiguousBlockAssociation:
+  Enabled:
+    false
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "lib/**/*.rake"
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - "Dangerfile"
+Layout/IndentHeredoc:
+  Enabled: false
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/TrivialAccessors:
+  AllowPredicates: true
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/SingleLineBlockParams:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+
+# Enable someday
+Style/Documentation:
+  Enabled: false
+
+# Needs refactors
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Style/PerlBackrefs:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-07-12 16:40:11 +0900 using RuboCop version 0.65.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/RedundantBlockCall:
+  Exclude:
+    - 'lib/capistrano/scm/s3_archive/local_cache.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: percent_q, bare_percent
+Style/BarePercentLiterals:
+  Exclude:
+    - 'lib/capistrano/scm/s3_archive.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/capistrano/scm/s3_archive.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/capistrano/scm/tasks/s3_archive.rake'

data/README.md

@@ -1,19 +1,21 @@
 # Capistrano::S3Archive
 
-Capistrano::S3Archive is an extention of [Capistrano](http://www.capistranorb.com/).
+Capistrano::S3Archive is the `SCM` extention of [Capistrano](http://www.capistranorb.com/).
 
-This behaves like the [capistrano-rsync](https://github.com/moll/capistrano-rsync) except downloading sources from S3 instead of GIT by default.
+**CAUTION!!** Document for VERSION < 0.9 is [legacy_README](legacy_README.md)
 
-![img_s3archive_to_local_to_remote](./img/s3_archive-rsync.png)
+This `SCM` treats your S3 bucket as a source repository, and maps the uploaded ZIP/TAR archive file to a `branch` in Capistrano.
 
-**CAUTION!!** Document for VERSION < 0.9 is [legacy_README](legacy_README.md)
+![img_s3archive_repository_and_branches](./img/s3_archive-repo-branch.png)
+
+And this makes it possible to separate the deployment process into "pre-build" and "distribution", and helps to shorten the time of distribution and simplify the management of access rights. For example, you can prepare a zip file that has already done `npm install`, and an other, you can set up an EC2 IAM profile that allowed to read S3 instead of putting access keys for your private Git repository on the remote hosts.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'capistrano-s3_archive', '>= 0.9'
+gem 'capistrano-s3_archive', '~> 1.0'
 ```
 
 And then execute:
@@ -24,16 +26,14 @@ And then execute:
 
 <!--     $ gem install capistrano-s3_archive -->
 
-## Usage
 
 ### Quick Start
 
 In Capfile:
 
-```
     require "capistrano/scm/s3_archive"
     install_plugin Capistrano::SCM::S3Archive
-```
+
 
 And set a S3 path containing source archives to `:repo_url` and the parameters to access Amazon S3 to `:s3_archive_client_options`, For example, if you has following tree,
 
@@ -46,10 +46,9 @@ And set a S3 path containing source archives to `:repo_url` and the parameters t
 
 then your `config/deploy.rb` would be:
 
-```
     set :repo_url, 's3://yourbucket/somedirectory/'
     set :s3_archive_client_options, { region: 'ap-northeast-1', credentials: somecredentials }
-```
+
 
 To deploy staging:
 
@@ -57,28 +56,64 @@ To deploy staging:
 $ bundle exec cap staging deploy
 ```
 
-Or to skip download & extruct archive and deploy local files:
-```
-$ bundle exec cap staging deploy_only
-```
+## Usage
+### Set strategy
+Choose a strategy for deploying extracted code to the remote from the archive.
+- rsync
+- direct (alpha)
+
+_e.g._ `set :s3_archive_strategy, :rsync`.
+
+
+#### strategy `rsync` (default)
+![img_s3archive_to_local_to_remote](./img/s3_archive-rsync.png)
+
+This strategy behaves like the [capistrano-rsync](https://github.com/moll/capistrano-rsync) except downloading sources from S3 instead of GIT by default.
+
+#### strategy `direct` (alpha)
+![img_s3archive_to_local_to_remote](./img/s3_archive-direct.png)
+
+
+### Requirements
+
+| For `rsync` strategy  | local | remotes |
+| :-                    | :-:   | :-:     |
+| rsync                 | ✔     | ✔       |
+| unzip or tar          | ✔     | -       |
+| awscli                | -     | -       |
+| s3:ListBucket         | ✔     | -       |
+| s3:ListBucketVersions | ✔     | -       |
+| s3:GetObjectVersion   | ✔     | -       |
+| s3:GetObject          | ✔     | -       |
+
+
+
+| For `direct` strategy     | local | remotes |
+| :-                        | :-:   | :-:     |
+| rsync                     | -     | -       |
+| unzip or tar              | -     | ✔       |
+| awscli                    | -     | ✔       |
+| awscli configuration (*1) | -     | ✔       |
+| s3:ListBucket             | ✔     | ✔       |
+| s3:ListBucketVersions     | ✔     | ✔       |
+| s3:GetObjectVersion       | -     | ✔       |
+| s3:GetObject              | -     | ✔       |
+
+_(*1) awscli on remote hosts need to have access rights to S3 by default settings._
 
 
 ### Configuration
 
 Available configurations are followings (key, default).
 
+    # COMMON SETTINGS
     :repo_url, nil
     :branch, :latest
-    :s3_archive_client_options, nil
+    :s3_archive_client_options, {}
     :s3_archive_sort_proc, ->(new, old) { old.key <=> new.key }
+    :s3_archive_strategy, :rsync
     :s3_archive_object_version_id, nil
-    :s3_archive_local_download_dir, "tmp/archives"
-    :s3_archive_local_cache_dir, "tmp/deploy"
-    :s3_archive_remote_rsync_options, ['-az', '--delete']
-    :s3_archive_remote_rsync_ssh_options, []
-    :s3_archive_remote_rsync_runner_options, {}
-    :s3_archive_rsync_cache_dir, "shared/deploy"
-    :s3_archive_hardlink_release, false
+
 
 **`repo_url` (required)**
 
@@ -96,10 +131,29 @@ Options passed to `Aws::S3::Client.new(options)` to fetch archives.
 
 Sort algorithm used to detect basename of `:latest` object. It should be proc object for `new,old` as `Aws::S3::Object` comparing.
 
+**`:s3_archive_strategy, :rsync`**
+
+A Strategy to distribute archived source code. You can set `:rsync` or `direct`.
+
 **`:s3_archive_object_version_id`**
 
 Version ID of version-controlled S3 object. It should use with `:branch`. e.g. `set :branch, 'myapp.zip'; set :version_id, 'qawsedrftgyhujikolq'`
 
+#### Configurations for `rsync` strategy
+
+    :s3_archive_skip_download, nil
+    :s3_archive_local_download_dir, "tmp/archives"
+    :s3_archive_local_cache_dir, "tmp/deploy"
+    :s3_archive_remote_rsync_options, ['-az', '--delete']
+    :s3_archive_remote_rsync_ssh_options, []
+    :s3_archive_remote_rsync_runner_options, {}
+    :s3_archive_rsync_cache_dir, "shared/deploy"
+    :s3_archive_hardlink_release, false
+
+**`:s3_archive_skip_download`**
+
+If this set to true, skip downloading the archive and rsync from local cache.
+
 **`:s3_archive_local_download_dir`**
 
 Path where to download source archives. Can use both relative or absolute.
@@ -128,6 +182,11 @@ Path where to cache your sources on the remote server to avoid rsyncing from scr
 
 Enable `--link-dest` option when creating release directory by remote rsyncing. It could speed deployment up.
 
+#### Configurations for `direct` strategy
+
+    :s3_archive_remote_cache_dir, -> { File.join(shared_path, "archives") } # 典型的には,
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/capistrano-s3_archive.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'capistrano/s3_archive/version'
 
@@ -9,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Takuto Komazaki"]
   spec.email         = ["komazarari@gmail.com"]
 
-  spec.summary       = %q{Capistrano deployment from an archive on Amazon S3.}
-  spec.description   = %q{Capistrano deployment from an archive on Amazon S3.}
+  spec.summary       = 'Capistrano deployment from an archive on Amazon S3.'
+  spec.description   = 'Capistrano deployment from an archive on Amazon S3.'
   spec.homepage      = "https://github.com/komazarari/capistrano-s3_archive"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -18,11 +17,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.4.0'
+  spec.add_dependency 'aws-sdk-s3', '~> 1'
   spec.add_dependency 'capistrano', '~> 3.0'
-  spec.add_dependency 'aws-sdk', '~> 2.0'
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
 end

data/example/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "vendor/bundle"

data/example/Capfile

@@ -0,0 +1,41 @@
+# Load DSL and set up stages
+require "capistrano/setup"
+
+# Include default deployment tasks
+require "capistrano/deploy"
+
+# Load the SCM plugin appropriate to your project:
+#
+# require "capistrano/scm/hg"
+# install_plugin Capistrano::SCM::Hg
+# or
+# require "capistrano/scm/svn"
+# install_plugin Capistrano::SCM::Svn
+# or
+require "capistrano/scm/s3_archive"
+install_plugin Capistrano::SCM::S3Archive
+
+# Include tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails
+#   https://github.com/capistrano/passenger
+#
+# require "capistrano/rvm"
+# require "capistrano/rbenv"
+# require "capistrano/chruby"
+# require "capistrano/bundler"
+# require "capistrano/rails/assets"
+# require "capistrano/rails/migrations"
+# require "capistrano/passenger"
+require "capistrano/locally"
+
+require "pry"
+
+# Load custom tasks from `lib/capistrano/tasks` if you have any defined
+Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }

data/example/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "capistrano-s3_archive", path: "../"
+
+### local stage exapmle
+gem "capistrano-locally"
+
+### debug
+gem "pry"

data/example/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: ..
+  specs:
+    capistrano-s3_archive (1.0.0.beta)
+      aws-sdk-s3 (~> 1)
+      capistrano (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.3.2)
+      sshkit (>= 1.6.1, != 1.7.0)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.187.0)
+    aws-sdk-core (3.59.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.23.0)
+      aws-sdk-core (~> 3, >= 3.58.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.45.0)
+      aws-sdk-core (~> 3, >= 3.58.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    capistrano (3.11.0)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-locally (0.2.6)
+      capistrano (~> 3.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    method_source (0.9.2)
+    net-scp (2.0.0)
+      net-ssh (>= 2.6.5, < 6.0.0)
+    net-ssh (5.2.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.2)
+    sshkit (1.19.1)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-locally
+  capistrano-s3_archive!
+  pry
+
+BUNDLED WITH
+   1.17.2

data/example/config/deploy/localtest.rb

@@ -0,0 +1,3 @@
+set :deploy_to, '/var/tmp/myapp'
+
+server "localhost", roles: [:app]

data/example/config/deploy/production.rb

@@ -0,0 +1,61 @@
+# server-based syntax
+# ======================
+# Defines a single server with a list of roles and multiple properties.
+# You can define all roles on a single server, or split them:
+
+# server "example.com", user: "deploy", roles: %w{app db web}, my_property: :my_value
+# server "example.com", user: "deploy", roles: %w{app web}, other_property: :other_value
+# server "db.example.com", user: "deploy", roles: %w{db}
+
+
+
+# role-based syntax
+# ==================
+
+# Defines a role with one or multiple servers. The primary server in each
+# group is considered to be the first unless any hosts have the primary
+# property set. Specify the username and a domain or IP for the server.
+# Don't use `:all`, it's a meta role.
+
+# role :app, %w{deploy@example.com}, my_property: :my_value
+# role :web, %w{user1@primary.com user2@additional.com}, other_property: :other_value
+# role :db,  %w{deploy@example.com}
+
+
+
+# Configuration
+# =============
+# You can set any configuration variable like in config/deploy.rb
+# These variables are then only loaded and set in this stage.
+# For available Capistrano configuration variables see the documentation page.
+# http://capistranorb.com/documentation/getting-started/configuration/
+# Feel free to add new variables to customise your setup.
+
+
+
+# Custom SSH Options
+# ==================
+# You may pass any option but keep in mind that net/ssh understands a
+# limited set of options, consult the Net::SSH documentation.
+# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+#
+# Global options
+# --------------
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+#
+# The server-based syntax can be used to override options:
+# ------------------------------------
+# server "example.com",
+#   user: "user_name",
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: "user_name", # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: "please use keys"
+#   }

data/example/config/deploy/staging.rb

@@ -0,0 +1,65 @@
+server 'koma-bionic.dev-inf.gree-dev.net', roles: [:app]
+
+set :deploy_to, '/var/tmp/testmyapp'
+
+# server-based syntax
+# ======================
+# Defines a single server with a list of roles and multiple properties.
+# You can define all roles on a single server, or split them:
+
+# server "example.com", user: "deploy", roles: %w{app db web}, my_property: :my_value
+# server "example.com", user: "deploy", roles: %w{app web}, other_property: :other_value
+# server "db.example.com", user: "deploy", roles: %w{db}
+
+
+
+# role-based syntax
+# ==================
+
+# Defines a role with one or multiple servers. The primary server in each
+# group is considered to be the first unless any hosts have the primary
+# property set. Specify the username and a domain or IP for the server.
+# Don't use `:all`, it's a meta role.
+
+# role :app, %w{deploy@example.com}, my_property: :my_value
+# role :web, %w{user1@primary.com user2@additional.com}, other_property: :other_value
+# role :db,  %w{deploy@example.com}
+
+
+
+# Configuration
+# =============
+# You can set any configuration variable like in config/deploy.rb
+# These variables are then only loaded and set in this stage.
+# For available Capistrano configuration variables see the documentation page.
+# http://capistranorb.com/documentation/getting-started/configuration/
+# Feel free to add new variables to customise your setup.
+
+
+
+# Custom SSH Options
+# ==================
+# You may pass any option but keep in mind that net/ssh understands a
+# limited set of options, consult the Net::SSH documentation.
+# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+#
+# Global options
+# --------------
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+#
+# The server-based syntax can be used to override options:
+# ------------------------------------
+# server "example.com",
+#   user: "user_name",
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: "user_name", # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: "please use keys"
+#   }

data/example/config/deploy.rb

@@ -0,0 +1,13 @@
+# config valid for current version and patch releases of Capistrano
+lock "~> 3.11.0"
+
+set :application, "my_app_name"
+set :repo_url, "s3://komazarari-public-01/capistrano-s3_archive/test-archives/"
+
+# set :branch, '20190711_my_app.zip'
+# set :branch, :master # same as :latest
+set :branch, :latest
+
+set :s3_archive_client_options, { region: 'us-east-1' }
+set :s3_archive_strategy, :direct
+# set :s3_archive_object_version_id, 'QUC.zh2MUXf7_ZCkFa7IZJN5CJKYlLKy'

data/lib/capistrano/s3_archive/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module S3Archive
-    VERSION = "0.9.9"
+    VERSION = "1.0.0".freeze
   end
 end

data/lib/capistrano/s3_archive.rb

@@ -1 +1 @@
-load File.expand_path("../legacy_s3_archive.rb", __FILE__)
+load File.expand_path('legacy_s3_archive.rb', __dir__)