capistrano-s3_archive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f929af3d48043349bb6daae12fbab57f89944eff
+  data.tar.gz: 795364463429bd33d45273d179ee4164d8b1d6b9
+SHA512:
+  metadata.gz: 94a42525f5804a5ed3f44dd3de4c03e2a199888844f6395432a41560d599b3a9e5190207430dddf8a8a88f1bc26b48873e5115b91876ba9bbf49386e11e074ba
+  data.tar.gz: bdb87791a1eb8b1f583f3d6ab426bf281acf8c673220ad4ea2ee74d7565fa363db8aa2fedf80e4634c97f21c70c7efefd36c4d8e934c4881961876c678159ed3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.vagrant
+/vagrant_example/Gemfile.lock
+/vagrant_example/.bundle/
+/vagrant_example/vendor/
+/vagrant_example/tmp/

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,83 @@
+# Capistrano::S3Archive
+
+Capistrano::S3Archive is an extention of [Capistrano](http://www.capistranorb.com/) which enables to `set :scm, :s3_archive`.
+
+This behaves like the [capistrano-rsync](https://github.com/moll/capistrano-rsync) except downloading sources from S3 instead of GIT by default.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-s3_archive', github: 'komazarari/capistrano-s3_archive'
+```
+
+And then execute:
+
+    $ bundle
+
+<!-- Or install it yourself as: -->
+
+<!--     $ gem install capistrano-s3_archive -->
+
+## Usage
+
+`set :scm, :s3_archive` in your config file.
+
+Set a S3 path containing source archives to `repo_url`. For example, if you has following tree,
+
+    s3://yourbucket/somedirectory/
+                      |- 201506011200.zip
+                      |- 201506011500.zip
+                      ...
+                      |- 201506020100.zip
+                      `- 201506030100.zip
+
+then `set :repo_url, 's3://yourbucket/somedirectory'`.
+
+Set parameters to access Amazon S3:
+
+```ruby
+set :s3_client_options, { region: 'ap-northeast-1', credentials: somecredentials }
+```
+
+And set regular capistrano options. To deploy staging:
+```
+$ bundle exec cap staging deploy
+```
+
+Or to skip download & extruct archive and deploy local files:
+```
+$ bundle exec cap staging deploy_only
+```
+
+
+### Configuration
+Set parameters with `set :key, value`.
+
+#### Rsync Strategy (default)
+
+Key           | Default | Description
+--------------|---------|------------
+branch        | `latest` | The S3 Object basename to download. Support `:latest` or such as `'201506011500.zip'`.
+sort_proc     | `->(a,b) { b.key <=> a.key }` | Sort algorithm used to detect `:latest` object basename. It should be proc object for `a,b` as `Aws::S3::Object` comparing.
+rsync_options | `['-az']` | Options used to rsync.
+local_cache   | `tmp/deploy` | Path where to extruct your archive on local for staging and rsyncing. Can be both relative or absolute.
+rsync_cache   | `shared/deploy` | Path where to cache your repository on the server to avoid rsyncing from scratch each time. Can be both relative or absolute.<br> Set to `nil` if you want to disable the cache.
+s3_archive    | `tmp/archives` | Path where to download source archives. Can be both relative or absolute.
+
+
+## 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.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/capistrano-s3_archive/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Vagrantfile

@@ -0,0 +1,21 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+  config.vm.box = "ubuntu/trusty64"
+
+  config.vm.provision "shell", inline: <<-SHELL
+    if ! dpkg -l | grep ruby2.2 > /dev/null; then
+      apt-add-repository ppa:brightbox/ruby-ng
+      apt-get update
+      apt-get install ruby2.2 -y
+    fi
+    gem install bundler --no-ri --no-rdoc
+    cp /vagrant/vagrant_example/.insecure_private_key /home/vagrant/.ssh/insecure_key
+    chmod 400 /home/vagrant/.ssh/insecure_key
+    chown vagrant:vagrant /home/vagrant/.ssh/insecure_key
+    if ! grep "`ssh-keygen -y -f .ssh/insecure_key`" /home/vagrant/.ssh/authorized_keys ;then
+      ssh-keygen -y -f .ssh/insecure_key >> .ssh/authorized_keys
+    fi
+  SHELL
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/s3_archive"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-s3_archive.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/s3_archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-s3_archive"
+  spec.version       = Capistrano::S3Archive::VERSION
+  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.homepage      = "https://github.com/komazarari/capistrano-s3_archive"
+
+  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.required_ruby_version = '>= 2.0.0'
+  spec.add_dependency 'capistrano', '~> 3.0'
+  spec.add_dependency 'aws-sdk-core', '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/s3_archive/version.rb

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

data/lib/capistrano/s3_archive.rb

@@ -0,0 +1,136 @@
+load File.expand_path("../tasks/s3_archive.rake", __FILE__)
+
+require "capistrano/s3_archive/version"
+require 'capistrano/scm'
+require 'aws-sdk-core'
+
+set :rsync_options, ['-az']
+set :rsync_copy, "rsync --archive --acls --xattrs"
+set :rsync_cache, "shared/deploy"
+set :local_cache, "tmp/deploy"
+set :s3_archive, "tmp/archives"
+set :sort_proc, ->(a,b) { b.key <=> a.key }
+
+module Capistrano
+  module S3Archive
+    class SCM < Capistrano::SCM
+      include FileUtils
+      attr_accessor :bucket, :object_prefix
+
+      def initialize(*args)
+        super
+        @bucket, @object_prefix = parse_s3_uri(repo_url)
+        set :local_cache_dir, "#{fetch(:local_cache)}/#{fetch(:stage)}"
+      end
+
+      def get_object
+        s3_client.get_object(bucket: bucket, key: archive_object_key)
+      end
+
+      def list_objects(all_page = true)
+        response = s3_client.list_objects(bucket: bucket, prefix: object_prefix)
+        if all_page
+          response.inject([]) do |objects, page|
+            objects += page.contents
+          end
+        else
+          response
+        end
+      end
+
+      def archive_object_key
+        @archive_object_key ||=
+          case fetch(:branch)
+          when :master, :latest, nil
+            latest_object_key
+          else
+            [object_prefix, fetch(:branch)].join('/')
+          end
+      end
+
+      private
+      def s3_client
+        @s3_client ||= Aws::S3::Client.new(fetch(:s3_client_options))
+      end
+
+      def latest_object_key
+        list_objects.sort(&fetch(:sort_proc)).first.key
+      end
+
+      def parse_s3_uri(uri)
+        pathes = uri.split('://')[1].split('/')
+        [pathes.first, pathes.drop(1).join('/')]
+      end
+
+      ### Default strategy
+      private
+      module RsyncStrategy
+        def check
+          list_objects(false)
+        end
+
+        def stage
+          archive_file = File.join(fetch(:s3_archive), fetch(:stage).to_s, File.basename(archive_object_key))
+          if not File.exist?(archive_file)
+            mkdir_p(File.dirname(archive_file))
+            content = get_object.body.read
+            File.open(archive_file, 'w') do |f|
+              f.write(content)
+            end
+          else
+            context.info "#{archive_file} is found."
+          end
+
+          remove_entry_secure(fetch(:local_cache_dir)) if File.exist? fetch(:local_cache_dir)
+          mkdir_p(fetch(:local_cache_dir))
+          case archive_file
+          when /\.zip\Z/
+            dir = archive_file.gsub(/\.zip\Z/, '')
+            cmd = "unzip -q -d #{fetch(:local_cache_dir)} #{archive_file}"
+          when /\.tar\.gz\Z|\.tar\.bz2\Z/
+            dir = archive_file.gsub(/\.tar\.gz\Z|\.tar\.bz2\Z/, '')
+            cmd = "tar xf #{archive_file} -C #{fetch(:local_cache_dir)}"
+          end
+
+          run_locally do
+            execute cmd
+          end
+        end
+
+        def release(server = context.host)
+          user = server.user + '@' unless server.user.nil?
+          key  = server.keys.first || Array(server.ssh_options[:keys]).first
+
+          rsync = ['rsync']
+          rsync.concat fetch(:rsync_options)
+          rsync << fetch(:local_cache_dir) + '/'
+          rsync << "-e 'ssh -i #{key}'"
+          rsync << "#{user}#{server.hostname}:#{rsync_cache || release_path}"
+
+          run_locally do
+            execute *rsync
+          end
+
+          unless fetch(:rsync_cache).nil?
+            cache = rsync_cache
+            on server do
+              copy = %(#{fetch(:rsync_copy)} "#{cache}/" "#{release_path}/")
+              execute copy
+            end
+          end
+        end
+
+        def current_revision
+          archive_object_key
+        end
+
+        private
+        def rsync_cache
+          cache = fetch(:rsync_cache)
+          cache = deploy_to + "/" + cache if cache && cache !~ /^\//
+          cache
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/s3_archive.rake

@@ -0,0 +1,44 @@
+namespace :s3_archive do
+
+  def strategy
+    @strategy ||= Capistrano::S3Archive::SCM.new(self, fetch(:s3_archive_strategy, Capistrano::S3Archive::SCM::RsyncStrategy))
+  end
+
+  desc 'Check that the S3 buckets are reachable'
+  task :check  do
+    on release_roles :all do
+      strategy.check
+    end
+  end
+
+  desc 'Extruct and stage the S3 archive in a stage directory'
+  task :stage do
+    if fetch(:skip_staging, false)
+      run_locally do
+        info "Skip extructing and staging."
+      end
+    else
+      on release_roles :all do
+        strategy.stage
+      end
+    end
+  end
+
+  desc 'Copy repo to releases'
+  task :create_release => :stage do
+    on release_roles :all do |server|
+      execute :mkdir, '-p', release_path
+      strategy.release(server)
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+    set :current_revision, strategy.current_revision
+  end
+end unless Rake::Task.task_defined?("s3_archive:check")
+
+task :deploy_only do
+  set :skip_staging, true
+  invoke :deploy
+end

data/vagrant_example/.insecure_private_key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEogIBAAKCAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzI
+w+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoP
+kcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2
+hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NO
+Td0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcW
+yLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQIBIwKCAQEA4iqWPJXtzZA68mKd
+ELs4jJsdyky+ewdZeNds5tjcnHU5zUYE25K+ffJED9qUWICcLZDc81TGWjHyAqD1
+Bw7XpgUwFgeUJwUlzQurAv+/ySnxiwuaGJfhFM1CaQHzfXphgVml+fZUvnJUTvzf
+TK2Lg6EdbUE9TarUlBf/xPfuEhMSlIE5keb/Zz3/LUlRg8yDqz5w+QWVJ4utnKnK
+iqwZN0mwpwU7YSyJhlT4YV1F3n4YjLswM5wJs2oqm0jssQu/BT0tyEXNDYBLEF4A
+sClaWuSJ2kjq7KhrrYXzagqhnSei9ODYFShJu8UWVec3Ihb5ZXlzO6vdNQ1J9Xsf
+4m+2ywKBgQD6qFxx/Rv9CNN96l/4rb14HKirC2o/orApiHmHDsURs5rUKDx0f9iP
+cXN7S1uePXuJRK/5hsubaOCx3Owd2u9gD6Oq0CsMkE4CUSiJcYrMANtx54cGH7Rk
+EjFZxK8xAv1ldELEyxrFqkbE4BKd8QOt414qjvTGyAK+OLD3M2QdCQKBgQDtx8pN
+CAxR7yhHbIWT1AH66+XWN8bXq7l3RO/ukeaci98JfkbkxURZhtxV/HHuvUhnPLdX
+3TwygPBYZFNo4pzVEhzWoTtnEtrFueKxyc3+LjZpuo+mBlQ6ORtfgkr9gBVphXZG
+YEzkCD3lVdl8L4cw9BVpKrJCs1c5taGjDgdInQKBgHm/fVvv96bJxc9x1tffXAcj
+3OVdUN0UgXNCSaf/3A/phbeBQe9xS+3mpc4r6qvx+iy69mNBeNZ0xOitIjpjBo2+
+dBEjSBwLk5q5tJqHmy/jKMJL4n9ROlx93XS+njxgibTvU6Fp9w+NOFD/HvxB3Tcz
+6+jJF85D5BNAG3DBMKBjAoGBAOAxZvgsKN+JuENXsST7F89Tck2iTcQIT8g5rwWC
+P9Vt74yboe2kDT531w8+egz7nAmRBKNM751U/95P9t88EDacDI/Z2OwnuFQHCPDF
+llYOUI+SpLJ6/vURRbHSnnn8a/XG+nzedGH5JGqEJNQsz+xT2axM0/W/CRknmGaJ
+kda/AoGANWrLCz708y7VYgAtW2Uf1DPOIYMdvo6fxIB5i9ZfISgcJ/bbCUkFrhoH
++vq/5CIWxCPp0f85R4qxxQ5ihxJ0YDQT9Jpx4TMss4PSavPaBH3RXow5Ohe+bYoQ
+NE5OgEXk2wVfZczCZpigBKbKZHNYcelXtTt/nP3rsCuGcM4h53s=
+-----END RSA PRIVATE KEY-----

data/vagrant_example/Capfile

@@ -0,0 +1,27 @@
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+# 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'
+
+# Load custom tasks from `lib/capistrano/tasks` if you have any defined
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

data/vagrant_example/Gemfile

@@ -0,0 +1,5 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "capistrano"
+gem "capistrano-s3_archive", path: '/vagrant'

data/vagrant_example/config/deploy/production.rb

@@ -0,0 +1,7 @@
+server 'localhost',
+       user: 'vagrant',
+       roles: ['web', 'app'],
+       ssh_options: {
+         auth_methods: ['publickey'],
+         keys: '/home/vagrant/.ssh/insecure_key'
+       }

data/vagrant_example/config/deploy.rb

@@ -0,0 +1,50 @@
+# config valid only for current version of Capistrano
+lock '3.4.0'
+
+set :application, 'my_app_name'
+
+set :repo_url, 's3://<YOUR_BUCKET>/<PREFIX>'
+set :s3_client_options, { region: 'ap-northeast-1' } # and credentials, etc if needed
+
+# Default branch is :master
+# ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp
+
+# Default deploy_to directory is /var/www/my_app_name
+set :deploy_to, '/home/vagrant/my_app_name'
+
+# Default value for :scm is :git
+set :scm, :s3_archive
+
+# Default value for :format is :pretty
+# set :format, :pretty
+
+# Default value for :log_level is :debug
+# set :log_level, :debug
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for :linked_files is []
+# set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml')
+
+# Default value for linked_dirs is []
+# set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system')
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+# Default value for keep_releases is 5
+# set :keep_releases, 5
+
+namespace :deploy do
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      # end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-s3_archive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuto Komazaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: Capistrano deployment from an archive on Amazon S3.
+email:
+- komazarari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- Vagrantfile
+- bin/console
+- bin/setup
+- capistrano-s3_archive.gemspec
+- lib/capistrano/s3_archive.rb
+- lib/capistrano/s3_archive/version.rb
+- lib/capistrano/tasks/s3_archive.rake
+- vagrant_example/.insecure_private_key
+- vagrant_example/Capfile
+- vagrant_example/Gemfile
+- vagrant_example/config/deploy.rb
+- vagrant_example/config/deploy/production.rb
+homepage: https://github.com/komazarari/capistrano-s3_archive
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano deployment from an archive on Amazon S3.
+test_files: []