capistrano-central_git 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d2196a8907e8b21b8668cac52fcff822c52b013
+  data.tar.gz: ebdbccf3154e3946abba8ed18f8bc6eb018bd40b
+SHA512:
+  metadata.gz: 27b0899958981d4c6eaef631f9ceaec6ff2342fbe4279a7124778fea2d45c4333fb9841c730c167d1d1407474c33a968ca80531bda8f331ec4d5a57a3bc77221
+  data.tar.gz: 056a1bf4ade98a499b7bad140afd54b044bfe1b8da5ddd991db8cd6ce87e7a1784bbcfdfc0b3de6d35751f3dc82b03e4a39a7ca65395f9f5cab523e2f6bd38dc

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.2.1
+before_install: gem install bundler -v 1.10.3

data/Gemfile

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

data/README.md

@@ -0,0 +1,73 @@
+# Capistrano::CentralGit
+
+**Note that this product is still under development. So they can be changed without notices.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-central_git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-central_git
+
+## Usage
+
+In Capfile:
+
+```ruby
+require "capistrano/setup"
+require "capistrano/deploy"
+require "capistrano/central_git"
+```
+
+In config/deploy.rb:
+
+```ruby
+set :deploy_to, "/var/www/my-app"
+set :repo_url, "git@github.com:you/my-app.git"
+
+set :scm, :central_git
+set :central_host, "your-build-server"
+set :central_path, "/home/you/central_git"
+```
+
+And make sure that:
+
+- Your central_host can access to release servers via ssh.
+- Your central_host includes rsync.
+
+## Configurations
+
+| Name | Default | Description |
+|---|---|---|
+| repo_url | | |
+| repo_tree | `nil` | |
+| branch | master | |
+| ssh_options | {} | |
+| keep_releases | 5 | |
+| scm | `nil` | | Must be `central_git` |
+| central_host | `nil` | |
+| central_host_ssh_options | {} | |
+| central_path | /var/www/#{application} | |
+| central_repo_path | #{central_path}/repo | |
+| central_packages_path | #{central_path}/packages |
+| deploy_to | /var/www/#{application} | |
+| release_packages_path | #{deploy_to}/packages | |
+| excludes | [] | |
+| rsync_options | -al | |
+| rsync_rsh | /usr/bin/ssh | |
+| max_parallels | number of hosts | |
+| keep_packages | 5 | |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/a2ikm/capistrano-central_git.
+

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/central_git/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-central_git"
+  spec.version       = Capistrano::CentralGit::VERSION
+  spec.authors       = ["Masato Ikeda"]
+  spec.email         = ["masato.ikeda@gmail.com"]
+
+  spec.summary       = %q{Build release files on central server.}
+  spec.description   = %q{Build release files on central server.}
+  spec.homepage      = "https://github.com/a2ikm/capistrano-central_git"
+
+  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.2"
+  spec.add_dependency "parallel"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/central_git/config.rb

@@ -0,0 +1,59 @@
+module Capistrano::CentralGit
+  class Config
+    def self.package_name
+      @package_name ||= fetch(:package_name, "#{fetch(:release_timestamp)}.tar.gz")
+    end
+
+    def self.central_path
+      @central_path ||= Pathname.new(fetch(:central_path, "/var/www/#{fetch(:application)}"))
+    end
+
+    def self.central_repo_path
+      @central_repo_path ||= Pathname.new(fetch(:central_repo_path, central_path.join("repo")))
+    end
+
+    def self.central_packages_path
+      @central_packages_path ||= Pathname.new(fetch(:central_packages_path, central_path.join("packages")))
+    end
+
+    def self.central_package_path
+      @central_package_path ||= Pathname.new(fetch(:central_package_path, central_packages_path.join(package_name)))
+    end
+
+    def self.release_packages_path
+      @release_packages_path ||= Pathname.new(fetch(:release_packages_path, shared_path.join("packages")))
+    end
+
+    def self.release_package_path
+      @release_package_path ||= Pathname.new(fetch(:remote_packge_path, release_packages_path.join(package_name)))
+    end
+
+    def self.excludes
+      @excludes ||= fetch(:excludes, []).push(".git").uniq
+    end
+
+    def self.central_host
+      @central_host ||= fetch(:central_host)
+    end
+
+    def self.central_host_ssh_options
+      @central_host_ssh_options ||= fetch(:central_host_ssh_options) || fetch(:ssh_options, {})
+    end
+
+    def self.rsync_options
+      @rsync_options ||= fetch(:rsync_options, "-al")
+    end
+
+    def self.rsync_rsh
+      @rsync_rsh ||= fetch(:rsync_rsh, "/usr/bin/ssh")
+    end
+
+    def self.max_parallels(hosts)
+      @max_parallels ||= fetch(:max_parallels, hosts.size).to_i
+    end
+
+    def self.keep_packages
+      @keep_packages ||= fetch(:keep_packages, 5).to_i
+    end
+  end
+end

data/lib/capistrano/central_git/scm.rb

@@ -0,0 +1,103 @@
+require "delegate"
+require "parallel"
+require "capistrano/central_git/config"
+
+module Capistrano::CentralGit
+  class SCM < SimpleDelegator
+    def initialize(context)
+      super(context)
+    end
+
+    def config
+      Capistrano::CentralGit::Config
+    end
+
+    def sshkit_host
+      @sshkit_host ||= SSHKit::Host.new(config.central_host).tap do |h|
+        h.ssh_options = config.central_host_ssh_options
+      end
+    end
+
+    def git(*args)
+      args.unshift :git
+      execute *args
+    end
+
+    def test!(*args)
+      __getobj__.test *args
+    end
+
+    def test
+      test! " [ -d #{config.central_repo_path}/.git ] "
+    end
+
+    def check
+      git :"ls-remote --heads", repo_url
+    end
+
+    def clone
+      git :clone, "--recursive", repo_url, config.central_repo_path
+    end
+
+    def update
+      git :remote, :update
+      git :checkout, fetch(:branch)
+      git :pull
+      git :submodule, :update, "--init"
+    end
+
+    def create_package
+      excludes = config.excludes.flat_map { |e| ["--exclude", e] }
+
+      tree_top =
+        if tree = fetch(:repo_tree)
+          tree.slice %r#^/?(.*?)/?$#, 1
+        else
+          ""
+        end
+
+      execute :mkdir, "-p", config.central_packages_path
+
+      within tree_top do
+        execute :tar, "zcf", config.central_package_path, *excludes, "."
+      end
+    end
+
+    def deploy_package
+      hosts = ::Capistrano::Configuration.env.filter(release_roles(:all))
+      rsync_options = config.rsync_options
+      rsync_rsh = config.rsync_rsh
+      central_package_path = config.central_package_path
+      release_package_path = config.release_package_path
+      Parallel.each(hosts, in_threads: config.max_parallels(hosts)) do |host|
+        execute :rsync, "#{rsync_options} --rsh='#{rsync_rsh}' #{central_package_path} #{host}:#{release_package_path}"
+      end
+    end
+
+    def extract_package
+      execute :mkdir, "-p", release_path
+      execute :tar, "zxf", config.release_package_path, "-C", release_path
+    end
+
+    def cleanup_package
+      packages = capture(:ls, '-xtr', config.central_packages_path).split
+      keep_packages = config.keep_packages
+      if packages.count >= keep_packages
+        info t(:keeping_packages, host: host.to_s, keep_packages: keep_packages, packages: packages.count)
+        older_packages = (packages - packages.last(:keep_packages))
+        if older_packages.any?
+          older_packages_str = older_packages.map do |package|
+            config.central_packages_path.join(package)
+          end.join(" ")
+          execute :rm, '-rf', older_packages_str
+        else
+          info t(:no_old_packages, host: host.to_s, keep_packages: keep_packages)
+        end
+      end
+    end
+
+    def fetch_revision
+      capture(:git, "rev-list --max-count=1 --abbrev-commit #{fetch(:branch)}").strip
+    end
+  end
+end

data/lib/capistrano/central_git/version.rb

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

data/lib/capistrano/central_git.rb

@@ -0,0 +1,8 @@
+require "capistrano/central_git/version"
+
+module Capistrano
+  module CentralGit
+  end
+end
+
+load File.expand_path("../tasks/central_git.rake", __FILE__)

data/lib/capistrano/tasks/central_git.rake

@@ -0,0 +1,155 @@
+unless defined?(Capistrano::CentralGit::TASK_LOADED)
+Capistrano::CentralGit::TASK_LOADED = true
+
+require "capistrano/central_git/scm"
+
+namespace :central_git do
+
+  def central_git_scm
+    @central_git_scm ||= Capistrano::CentralGit::SCM.new(self)
+  end
+
+  def run_central(&block)
+    SSHKit.config.backend.new(central_git_scm.sshkit_host, &block).run
+  end
+
+  def central_path
+    central_git_scm.config.central_path
+  end
+
+  def central_repo_path
+    central_git_scm.config.central_repo_path
+  end
+
+  def central_packages_path
+    central_git_scm.config.central_packages_path
+  end
+
+  def release_packages_path
+    central_git_scm.config.release_packages_path
+  end
+
+  set :git_environmental_variables, ->() {
+    {
+      git_askpass: "/bin/echo",
+      git_ssh:     "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+    }
+  }
+
+  desc "Upload the git wrapper script, this script guarantees that we can script git without getting an interactive prompt"
+  task :wrapper do
+    run_central do
+      execute :mkdir, "-p", "#{fetch(:tmp_dir)}/#{fetch(:application)}/"
+      upload! StringIO.new("#!/bin/sh -e\nexec /usr/bin/ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no \"$@\"\n"), "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+      execute :chmod, "+x", "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+    end
+  end
+
+  desc "Check that the repository is reachable"
+  task check: :"central_git:wrapper" do
+    fetch(:branch)
+    run_central do
+      with fetch(:git_environmental_variables) do
+        central_git_scm.check
+      end
+      execute :mkdir, "-p", central_path
+    end
+
+    on release_roles :all do |host|
+      execute :mkdir, "-p", release_packages_path
+    end
+  end
+
+  desc "Clone the repo to the cache"
+  task clone: :"central_git:wrapper" do
+    run_central do
+      if central_git_scm.test
+        info t(:mirror_exists, at: central_repo_path)
+      else
+        with fetch(:git_environmental_variables) do
+          central_git_scm.clone
+        end
+      end
+    end
+  end
+
+  desc "Update the repo mirror to reflect the origin state"
+  task update: :"central_git:clone" do
+    run_central do
+      within central_repo_path do
+        with fetch(:git_environmental_variables) do
+          central_git_scm.update
+        end
+      end
+    end
+  end
+
+  desc "Copy repo to releases"
+  task create_release: :"central_git:update" do
+    run_central do
+      with fetch(:git_environmental_variables) do
+        within central_repo_path do
+          central_git_scm.create_package
+          central_git_scm.deploy_package
+        end
+      end
+    end
+
+    on release_roles :all do
+      within releases_path do
+        central_git_scm.extract_package
+      end
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+    run_central do
+      within central_repo_path do
+        with fetch(:git_environmental_variables) do
+          set :current_revision, central_git_scm.fetch_revision
+        end
+      end
+    end
+  end
+
+  desc "Cleanup packages"
+  task cleanup: :"deploy:cleanup" do
+    run_central do
+      within central_packages_path do
+        central_git_scm.cleanup_packages
+      end
+    end
+  end
+
+  desc "Show configurations"
+  task :config do
+    config = central_git_scm.config
+    hosts = ::Capistrano::Configuration.env.filter(release_roles(:all))
+
+    pairs = {
+      repo_url: fetch(:repo_url),
+      repo_tree: fetch(:repo_tree),
+      central_host: config.central_host,
+      central_path: config.central_path,
+      central_repo_path: config.central_repo_path,
+      central_packages_path: config.central_packages_path,
+      deploy_to: fetch(:deploy_to),
+      release_packages_path: config.release_packages_path,
+      excludes: config.excludes.join(" "),
+      rsync_options: config.rsync_options,
+      rsync_rsh: config.rsync_rsh,
+      max_parallels: config.max_parallels(hosts),
+      keep_packages: config.keep_packages,
+    }
+
+    max_key_length = pairs.keys.map { |k| k.to_s.length }.max
+    col = max_key_length + 2
+    pairs.each do |key, value|
+      puts "#{key.to_s.rjust(col)}    #{value}"
+    end
+
+  end
+end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-central_git
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masato Ikeda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: '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'
+description: Build release files on central server.
+email:
+- masato.ikeda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-central_git.gemspec
+- lib/capistrano/central_git.rb
+- lib/capistrano/central_git/config.rb
+- lib/capistrano/central_git/scm.rb
+- lib/capistrano/central_git/version.rb
+- lib/capistrano/tasks/central_git.rake
+homepage: https://github.com/a2ikm/capistrano-central_git
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Build release files on central server.
+test_files: []
+has_rdoc: