capistrano-stretcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6eb32df62c7426e64ac97effd685d1f3ccc7e796
+  data.tar.gz: aac0d3cf7eaba2572aebdbc812f8e4e01215dbef
+SHA512:
+  metadata.gz: 3293cd4abe640a2a1987a00557b17f003cc679096d4c896be0809106b2d41d3281dcf13ff693cc1a255d8180e720b399d0d8ac152f84ac1b6e27b08ee6d25f5f
+  data.tar.gz: 9e47a94761e8ef7f1124bc56c29c1df2c40b8bef9cad9a435a183630df2fa52972b7eebfb147919183b6f429ed4468cfd20edd091dd18c08cefa72971e6bfbf0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+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 capistrano-stretcher.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015- GMO Pepabo, Inc.
+
+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,98 @@
+# Capistrano::Stretcher
+
+capistrano task for stretcher.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-stretcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-stretcher
+
+## Requirements
+
+capistrano-stretcher requires target server for building to application assets. this server should be installed folloing packages:
+
+ * git
+ * rsync
+ * tar
+ * gzip
+ * awk
+ * openssl
+ * aws-cli
+ * consul
+
+target server build assets, upload assets to AWS S3 and invoke `consul event` automatically. so target server can access AWS s3 via aws-cli and join your deployment consul cluster.
+
+## Usage
+
+You need to add `require "capistrano/stretcher" to Capfile` and add `config/deploy.rb` following variables:
+
+```
+role :build, ['your-target-server.lan'], :no_release => true
+set :application, 'your-application'
+set :deploy_to, '/var/www'
+set :deploy_roles, 'www,batch'
+set :stretcher_hooks, 'config/stretcher.yml.erb'
+set :local_tarball_name, 'rails-applicaiton.tar.gz'
+set :stretcher_src, "s3://your-deployment-bucket/assets/rails-application-#{env.now}.tgz"
+set :manifest_path, "s3://your-deployment-bucket/manifests/"
+```
+
+and write hooks for stretcher to `config/stretcher.yml.erb`
+
+```yaml
+default: &default
+  pre:
+    -
+  success:
+    -
+  failure:
+    - cat >> /tmp/failure
+www:
+  <<: *default
+  post:
+    - ln -nfs <%= fetch(:deploy_to) %>/shared/data <%= fetch(:deploy_to) %>/current/data
+    - sudo systemctl reload unicorn
+batch:
+  <<: *default
+  post:
+    - ln -nfs <%= fetch(:deploy_to) %>/shared/data <%= fetch(:deploy_to) %>/current/data
+```
+
+above hooks is extracted to manifest.yml for stretcher. If you have "www,batch" roles and stages named staging and production, capistrano-stretcher extract to following yaml from configuration.
+
+ * `manifest_www_staging.yml`
+ * `manifest_batch_staging.yml`
+
+and invoke
+
+ * `consul event -name deploy_www_staging s3://.../manifest_www.yml`
+ * `consul event -name deploy_batch_staging s3://.../manifest_batch.yml`
+
+with `cap staging stretcher:deploy` command on target server. When it's invoked with `cap production stretcher:deploy`, capistrano-strecher replace suffix `staging` to `production`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, 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/pepabo/capistrano-stretcher.
+
+## LICENSE
+
+The MIT License (MIT)
+
+Copyright (c) 2015- GMO Pepabo, Inc.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/stretcher"
+
+# 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-stretcher.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-stretcher"
+  spec.version       = "0.1.0"
+  spec.authors       = ["SHIBATA Hiroshi", "Uchio Kondo"]
+  spec.email         = ["hsbt@ruby-lang.org", "udzura@udzura.jp"]
+
+  spec.summary       = %q{capistrano task for stretcher.}
+  spec.description   = %q{capistrano task for stretcher.}
+  spec.homepage      = "https://github.com/pepabo/capistrano-stretcher"
+
+  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', '>= 3'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/capistrano-stretcher.rb

@@ -0,0 +1 @@
+# this file is dummy file for Bundler.setup

data/lib/capistrano/stretcher.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/stretcher.rake", __FILE__)

data/lib/capistrano/tasks/stretcher.rake

@@ -0,0 +1,153 @@
+# -*- coding: utf-8; mode: ruby -*-
+require 'erb'
+require 'yaml'
+
+namespace :stretcher do
+  set :exclude_dirs, ['tmp']
+
+  def local_working_path_base
+    @_local_working_path_base ||= fetch(:local_working_path_base, "/var/tmp/#{fetch :application}")
+  end
+
+  def local_repo_path
+    "#{local_working_path_base}/repo"
+  end
+
+  def local_checkout_path
+    "#{local_working_path_base}/checkout"
+  end
+
+  def local_build_path
+    "#{local_working_path_base}/build"
+  end
+
+  def local_tarball_path
+    "#{local_working_path_base}/tarballs"
+  end
+
+  def application_builder_roles
+    roles(fetch(:application_builder_roles, [:build]))
+  end
+
+  task :mark_deploying do
+    set :deploying, true
+  end
+
+  desc "Create a tarball that is set up for deploy"
+  task :archive_project =>
+    [:ensure_directories, :checkout_local,
+     :create_tarball, :upload_tarball,
+     :create_and_upload_manifest, :cleanup_dirs]
+
+  task :ensure_directories do
+    on application_builder_roles do
+      execute :mkdir, '-p', local_repo_path, local_checkout_path, local_build_path, local_tarball_path
+    end
+  end
+
+  task :checkout_local do
+    on application_builder_roles do
+      if test("[ -f #{local_repo_path}/HEAD ]")
+        within local_repo_path do
+          execute :git, :remote, :update
+        end
+      else
+        execute :git, :clone, '--mirror', repo_url, local_repo_path
+      end
+
+      within local_repo_path do
+        execute :mkdir, '-p', "#{local_checkout_path}/#{env.now}"
+        execute :git, :archive, fetch(:branch), "| tar -x -C", "#{local_checkout_path}/#{env.now}"
+        set :current_revision, capture(:git, 'rev-parse', fetch(:branch)).chomp
+
+        execute :echo, fetch(:current_revision), "> #{local_checkout_path}/#{env.now}/REVISION"
+
+        execute :rsync, "-av", "--delete",
+          *fetch(:exclude_dirs).map{|d| ['--exclude', d].join(' ')},
+          "#{local_checkout_path}/#{env.now}/", "#{local_build_path}/",
+          "| pv -l -s $( find #{local_checkout_path}/#{env.now}/ -type f | wc -l ) >/dev/null"
+      end
+    end
+  end
+
+  task :create_tarball do
+    on application_builder_roles do
+      within local_build_path do
+        execute :mkdir, '-p', "#{local_tarball_path}/#{env.now}"
+        execute :tar, '-cf', '-',
+          "--exclude tmp", "--exclude spec", "./",
+          "| pv -s $( du -sb ./ | awk '{print $1}' )",
+          "| gzip -9 > #{local_tarball_path}/#{env.now}/#{fetch(:local_tarball_name)}"
+      end
+      within local_tarball_path do
+        execute :rm, '-f', 'current'
+        execute :ln, '-sf', env.now, 'current'
+      end
+    end
+  end
+
+  task :upload_tarball do
+    on application_builder_roles do
+      as 'root' do
+        execute :aws, :s3, :cp, "#{local_tarball_path}/current/#{fetch(:local_tarball_name)}", fetch(:stretcher_src)
+      end
+    end
+  end
+
+  task :create_and_upload_manifest do
+    on application_builder_roles do
+      as 'root' do
+        failure_message = "Deploy failed at *$(hostname)* :fire:"
+        checksum = capture("openssl sha256 #{local_tarball_path}/current/#{fetch(:local_tarball_name)} | gawk -F' ' '{print $2}'").chomp
+        src = fetch(:stretcher_src)
+        template = File.read(File.expand_path('../../templates/manifest.yml.erb', __FILE__))
+        yaml = YAML.load(ERB.new(capture(:cat, "#{local_build_path}/#{fetch(:stretcher_hooks)}")).result(binding))
+        fetch(:deploy_roles).split(',').each do |role|
+          hooks = yaml[role]
+          yml = ERB.new(template).result(binding)
+          tempfile_path = Tempfile.open("manifest_#{role}") do |t|
+            t.write yml
+            t.path
+          end
+          upload! tempfile_path, "#{local_tarball_path}/current/manifest_#{role}_#{fetch(:stage)}.yml"
+          execute :aws, :s3, :cp, "#{local_tarball_path}/current/manifest_#{role}_#{fetch(:stage)}.yml", "#{fetch(:manifest_path)}/manifest_#{role}_#{fetch(:stage)}.yml"
+        end
+      end
+    end
+  end
+
+  # refs https://github.com/capistrano/capistrano/blob/master/lib/capistrano/tasks/deploy.rake#L138
+  task :cleanup_dirs do
+    on application_builder_roles do
+      releases = capture(:ls, '-tr', "#{local_tarball_path}", "| grep -v current").split
+
+      if releases.count >= fetch(:keep_releases)
+        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: releases.count)
+        directories = (releases - releases.last(fetch(:keep_releases)))
+        unless directories.empty?
+          directories_str = directories.map do |release|
+            "#{local_tarball_path}/#{release} #{local_checkout_path}/#{release}"
+          end.join(" ")
+          execute :rm, '-rf', directories_str
+        else
+          info t(:no_old_releases, host: host.to_s, keep_releases: fetch(:keep_releases))
+        end
+      end
+    end
+  end
+
+  desc "Kick the stretcher's deploy event via Consul"
+  task :kick_stretcher do
+    fetch(:deploy_roles).split(',').each do |target_role|
+      on application_builder_roles do
+        opts = ["-name deploy_#{target_role}_#{fetch(:stage)}"]
+        opts << "-node #{ENV['TARGET_HOSTS']}" if ENV['TARGET_HOSTS']
+        opts << "#{fetch(:manifest_path)}/manifest_#{target_role}_#{fetch(:stage)}.yml"
+        execute :consul, :event, *opts
+      end
+    end
+  end
+
+  desc 'Deploy via Stretcher'
+  task :deploy => ["stretcher:mark_deploying", "stretcher:archive_project", "stretcher:kick_stretcher"]
+end

data/lib/capistrano/templates/manifest.yml.erb

@@ -0,0 +1,28 @@
+src: <%= src %>
+checksum: <%= checksum %>
+dest: <%= fetch(:deploy_to) %>/releases/<%= env.now %>
+commands:
+  pre:
+    <% hooks["pre"].each do |c| %>
+    - <%= c %>
+    <% end %>
+  post:
+    - ln -nfs <%= fetch(:deploy_to) %>/releases/<%= env.now %> <%= fetch(:deploy_to) %>/current
+    - rm -rf <%= fetch(:deploy_to) %>/current/log
+    - ln -nfs <%= fetch(:deploy_to) %>/shared/log <%= fetch(:deploy_to) %>/current/log
+    - mkdir -p <%= fetch(:deploy_to) %>/current/tmp
+    - ln -nfs <%= fetch(:deploy_to) %>/shared/pids <%= fetch(:deploy_to) %>/current/tmp/pids
+    <% hooks["post"].each do |c| %>
+    - <%= c %>
+    <% end %>
+  success:
+    <% hooks["success"].each do |c| %>
+    - <%= c %>
+    <% end %>
+  failure:
+    <% hooks["failure"].each do |c| %>
+    - <%= c %>
+    <% end %>
+excludes:
+  - "*.pid"
+  - "*.socket"

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-stretcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SHIBATA Hiroshi
+- Uchio Kondo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: minitest
+  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: capistrano task for stretcher.
+email:
+- hsbt@ruby-lang.org
+- udzura@udzura.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-stretcher.gemspec
+- lib/capistrano-stretcher.rb
+- lib/capistrano/stretcher.rb
+- lib/capistrano/tasks/stretcher.rake
+- lib/capistrano/templates/manifest.yml.erb
+homepage: https://github.com/pepabo/capistrano-stretcher
+licenses: []
+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.5.0
+signing_key: 
+specification_version: 4
+summary: capistrano task for stretcher.
+test_files: []
+has_rdoc: