chap 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+system_root

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3@chap

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/chap/(.+)\.rb$}) { |m| "spec/lib/chap_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tung Nguyen
+
+MIT License
+
+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,121 @@
+# Chap
+
+chef + capistrano = chap: deploy your app with either chef or capistrano.  This was written to solve the issue between having 2 deployment systems that are very similar but not exactly the same.  With chap you can deploy to a single server by running one command: 
+
+<pre>
+$ chap deploy
+</pre>
+
+The same command is called whether you're using chef or capistrano for deployment.  The chap deploy command does the heavy lifting and manages the deploy instead of capistrano or chef.
+
+## Requirements
+
+<pre>
+$ gem install chap
+</pre>
+
+## Usage
+
+The chap command is meant to be executed on the server which you want to deploy the code.  
+
+## Setup
+
+Chap requires 3 configuration files: chap.yml, chap.json and node.json.
+
+* chap.json: contains capistrano-like configuration settings.
+* node.json: is intended to be the same file that chef solo uses and contains instance specific information, like node[:instance_role].
+: chap.yml: The paths of the chap.json and node.json are configured in this file.
+
+Here are examples of the starter setup files that you can generate via: 
+
+<pre>
+$ chap setup -o /etc/chef
+</pre>
+
+<pre>
+$ cat /etc/chef/chap.yml
+chap: /etc/chef/chap.json
+node: /etc/chef/node.json
+$ cat /etc/chef/chap.json
+{
+  "repo": "git@github.com:tongueroo/chapdemo.git",
+  "branch": "master",
+  "application": "chapdemo",
+  "deploy_to": "/data/chapdemo",
+  "strategy": "checkout",
+  "keep": 5,
+  "user": "deploy",
+  "group": "deploy"
+}
+$ cat /etc/chef/node.json
+{
+  "environment": "staging",
+  "application": "chapdemo",
+  "instance_role": "app"
+}
+</pre>
+
+### Deploy sequence
+
+The deploy sequence is based on the sequence from the capistrano and chef deploy resource provider.
+
+1. Download code to [deploy_to]/releases/[timestamp]
+2. Run chap/deploy hook
+3. Symlink [deploy_to]/releases/[timestamp] to [deploy_to]/current
+4. Run chap/restart hook
+5. Clean up old releases
+
+On the server:
+
+<pre>
+$ chap deploy
+</pre>
+
+From capistrano, on local or deploy box:
+
+<pre>
+$ cap deploy # cap recipe calls "chap deploy"
+</pre>
+
+Chef Chap LWRP:
+
+<pre>
+# chef LWRP creates chap.yml and chap.json setup files and calls "chap deploy"
+chap_deploy "chapdemo" do
+  repo "git@github.com:tongueroo/chapdemo.git"
+  revision "master"
+end
+</pre>
+
+Chap loads up information from node.json because it needs the information for hooks, which tend to work differently for different server roles.  For example, the chap/restart hook below will run "touch tmp/restart.txt" for an app role and will run "rvmsudo bluepill restart resque" for a resque role.  Example:
+
+<pre>
+$ cat chap/restart
+#!/usr/bin/env ruby
+restart = case node[:instance_role]
+          when 'app'
+            "touch tmp/restart.txt"
+          when 'resque'
+            "rvmsudo bluepill restart resque"
+          end
+run "cd #{current_path} && #{restart}"
+</pre>
+
+## Deploy Hooks
+
+Define your deploy hooks in the chap folder of the project.  There are 2 deploy hooks.
+
+* chap/deploy - runs after the code has been deployed but not yet symlinked
+* chap/restart - runs after the code has been symlinked and app needs to be restarted
+
+Deploy hooks get evaluated within the context of a chap deploy run and have some special variables and methods:
+
+Special variables:
+
+* node - contains data from /etc/chef/node.json.  Avaiable as mash.
+* chap - contains data from /etc/chef/chap.json and some special variables added by chap.  Avaiable as mash.  Special variables: release_path, current_path, shared_path, cached_path.  The special variables are also available directly as methods.
+
+Special methods:
+
+* run - output the command to be ran and runs command.
+* log - log messages to [shared_path]/chap/chap.log.

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new

data/bin/chap

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require 'chap'
+
+Chap::CLI.start

data/chap.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chap/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "chap"
+  gem.version       = Chap::VERSION
+  gem.authors       = ["Tung Nguyen"]
+  gem.email         = ["tongueroo@gmail.com"]
+  gem.description   = %q{chef + capistrano = chap: deploy your app with either chef or capistrano}
+  gem.summary       = %q{chef + capistrano = chap: deploy your app with either chef or capistrano}
+  gem.homepage      = "https://github.com/tongueroo/chap"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rake"
+  gem.add_dependency "json"
+  gem.add_dependency "thor"
+  gem.add_dependency "colorize"
+  gem.add_dependency "logger"
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-bundler'
+  gem.add_development_dependency 'rb-fsevent'
+  # gem.add_development_dependency 'fakefs'
+end

data/lib/chap/cli.rb

@@ -0,0 +1,26 @@
+module Chap
+  class CLI < Thor
+    desc "setup", "Sets up chap config files"
+    long_desc "Creates chap.json, chap.yml and node.json example files."
+    method_option :force, :aliases => '-f', :type => :boolean, :desc => "Overwrite existing files"
+    method_option :quiet, :aliases => '-q', :type => :boolean, :desc => "Quiet commands"
+    method_option :output, :aliases => '-o', :desc => "Folder which example files will be written to"
+    def setup
+      Chap::Task.setup(options)
+    end
+
+    desc "deploy", "Deploy application"
+    long_desc <<-EOL
+      Example:
+
+      $ chap deploy
+
+      Deploys code using settings from chap.json and node.json.  chap.json and node.json should be referenced in chap.yml.
+    EOL
+    method_option :quiet, :aliases => '-q', :type => :boolean, :desc => "Quiet commands"
+    method_option :config, :aliases => '-c', :default => '/etc/chef/chap.yml', :desc => "chap.yml config to use"
+    def deploy
+      Chap::Task.deploy(options)
+    end
+  end
+end

data/lib/chap/config.rb

@@ -0,0 +1,113 @@
+module Chap
+  class Config
+    attr_reader :options, :node, :chap
+    def initialize(options={})
+      @options = options
+      # preload all config files so validatation happens before deploys
+      _ = yaml, chap, node
+    end
+
+    def yaml
+      path = options[:config]
+      if File.exist?(path)
+        @yaml ||= Mash.from_hash(YAML.load(IO.read(path)))
+      else
+        puts "ERROR: chap.yaml config does not exist at: #{path}"
+        exit 1
+      end
+    end
+
+    def chap
+      return @chap if @chap
+      @chap = load_json(:chap)
+      @chap[:release_path] = release_path
+      @chap[:current_path] = current_path
+      @chap[:cached_path] = cached_path
+      @chap
+    end
+
+    def node
+      @node ||= load_json(:node)
+    end
+
+    # the chap.json and node.json is assumed to be in th same folder as
+    # chap.yml if a relative path is given
+    def load_json(key)
+      path = if yaml[key] =~ %r{^/} # root path given
+               yaml[key]
+             else # relative path
+               dirname = File.dirname(options[:config])
+               "#{dirname}/#{yaml[key]}"
+             end
+      if File.exist?(path)
+        Mash.from_hash(JSON.parse(IO.read(path)))
+      else
+        puts "ERROR: #{key}.json config does not exist at: #{path}"
+        exit 1
+      end
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.strftime("%Y%m%d%H%M%S")
+    end
+
+    def deploy_to
+      chap[:deploy_to]
+    end
+
+    # special attributes added to chap  
+    def release_path
+      return @release_path if @release_path
+      @release_path = "#{deploy_to}/releases/#{timestamp}"
+    end
+
+    def current_path
+      return @current_path if @current_path
+      @current_path = "#{deploy_to}/current"
+    end
+
+    def shared_path
+      return @shared_path if @shared_path
+      @shared_path = "#{deploy_to}/shared"
+    end
+
+    def cached_path
+      return @cached_path if @cached_path
+      path = chap[:repo].split(':').last.sub('.git','')
+      @cached_path = "#{shared_path}/cache/#{strategy}/#{path}"
+    end
+
+    def strategy
+      chap[:strategy] || 'checkout'
+    end
+
+    def log(msg)
+      puts msg unless options[:quiet]
+      logger.info(msg)
+    end
+
+    def chap_log_path
+      return @chap_log_path if @chap_log_path
+      dir = "#{shared_path}/chap"
+      FileUtils.mkdir_p(dir) unless File.exist?(dir)
+      @chap_log_path = "#{dir}/chap.log"
+      system("cat /dev/null > #{@chap_log_path}")
+      @chap_log_path
+    end
+
+    def logger
+      return @logger if @logger
+      @logger = Logger.new(chap_log_path)
+      # @logger.level = Logger::WARN
+      @logger
+    end
+
+    def run(cmd)      
+      log "Running: #{cmd}"
+      cmd = "#{cmd} 2>&1" unless cmd.include?(" > ")
+      out = `#{cmd}`
+      log out
+      raise "DeployError" if $?.exitstatus > 0
+    end
+  end
+end

data/lib/chap/hook.rb

@@ -0,0 +1,16 @@
+module Chap
+  class Hook
+    include SpecialMethods
+
+    attr_reader :options, :config
+    def initialize(path, config)
+      @path = path
+      @config = config
+    end
+
+    def evaluate
+      instance_eval(File.read(@path), @path)
+    end
+
+  end
+end

data/lib/chap/runner.rb

@@ -0,0 +1,129 @@
+module Chap
+  class Runner
+    include SpecialMethods
+
+    attr_reader :options, :config
+    def initialize(options={})
+      @options = options
+      @config = Config.new(options)
+    end
+
+    def deploy
+      setup
+      strategy.deploy
+      symlink_shared
+      hook(:deploy)
+      symlink_current
+      hook(:restart)
+      cleanup
+    end
+
+    def setup
+      user = config.chap[:user] || ENV['USER']
+      group = config.chap[:group]
+      begin
+        FileUtils.mkdir_p(deploy_to)
+        FileUtils.chown_R user, group, deploy_to
+      rescue Exception
+        # retry to create deploy_to folder with sudo
+        user_group = [user,group].compact.join(':')
+        raise unless system("sudo mkdir -p #{deploy_to}")
+        raise unless system("sudo chown -R #{user_group} #{deploy_to}")
+      end
+      dirs = ["#{deploy_to}/releases"]
+      dirs += shared_dirs
+      dirs.each do |dir|
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def strategy
+      strategy = config.strategy
+      klass = Strategy.const_get(camel_case(strategy))
+      @strategy ||= klass.new(:config => @config)
+    end
+
+    def camel_case(string)
+      return string if string !~ /_/ && string =~ /[A-Z]+.*/
+      string.split('_').map{|e| e.capitalize}.join
+    end
+
+    def symlink_shared
+      shared_dirs.each do |path|
+        src = path
+        relative_path = path.sub("#{shared_path}/",'')
+        dest = "#{release_path}/#{relative_path}"
+        # make sure the directory exist for symlink creation
+        dirname = File.dirname(dest)
+        FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+        if File.symlink?(dest)
+          File.delete(dest)
+        elsif File.directory?(dest)
+          FileUtils.rm_rf(dest)
+        end
+        FileUtils.ln_s(src,dest)
+      end
+    end
+
+    def symlink_current
+      FileUtils.rm(current_path) if File.exist?(current_path)
+      FileUtils.ln_s(release_path, current_path)
+      log "Current symlink updated".colorize(:green)
+    end
+
+    def cleanup
+      log "Cleaning up".colorize(:green)
+      remove_old_releases
+      logrotate
+    end
+
+    def remove_old_releases
+      dirname = File.dirname(release_path)
+      releases = Dir.glob("#{dirname}/*").sort.reverse
+      keep = config.chap[:keep] || 5
+      delete = releases - releases[0..keep-1]
+      delete.each do |old_release|
+        FileUtils.rm_rf(old_release)
+      end
+    end
+
+    def logrotate
+      logrotate_file(config.chap_log_path)
+    end
+
+    def logrotate_timestamp
+      @logrotate_timestamp ||= Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+    end
+
+    def logrotate_file(log_path)
+      dirname = File.dirname(log_path)
+      basename = File.basename(log_path, '.log')
+      archive = "#{dirname}/#{basename}-#{logrotate_timestamp}.log"
+      FileUtils.cp(log_path, archive) if File.exist?(log_path)
+      logs = Dir.glob("#{dirname}/#{basename}-*.log").sort.reverse
+      delete = logs - logs[0..9] # keep last 10 chap logs
+      delete.each do |old_log|
+        FileUtils.rm_f(old_log)
+      end
+    end
+
+    def shared_dirs
+      dirs = config.chap[:shared_dirs] || [
+        "public/system",
+        "log",
+        "tmp/pids"
+      ]
+      dirs.map! {|p| "#{shared_path}/#{p}"}
+    end
+
+    def hook(name)
+      log "Running hook: #{name}".colorize(:green)
+      path = "#{release_path}/chap/#{name}"
+      if File.exist?(path)
+        Hook.new(path, @config).evaluate
+      else
+        log "chap/#{name} hook does not exist".colorize(:red)
+      end
+    end
+  end
+end

data/lib/chap/special_methods.rb

@@ -0,0 +1,23 @@
+module Chap
+  module SpecialMethods
+    SPECIAL_METHODS = %w/deploy_to release_path current_path shared_path cached_path node chap log run/
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+      base.define_special_methods
+    end
+
+    module ClassMethods
+      # delegate to the config class
+      def define_special_methods
+        SPECIAL_METHODS.each do |method|
+          class_eval <<-EOL
+            def #{method}(*args)
+              @config.#{method}(*args)
+            end
+          EOL
+        end
+      end
+    end
+  end
+end

data/lib/chap/strategy/base.rb

@@ -0,0 +1,20 @@
+module Chap
+  module Strategy
+    class Base
+      include SpecialMethods
+
+      attr_reader :options, :config
+      def initialize(options={})
+        @options = options
+        @config = options[:config]
+        log "Deploying via #{self.class} strategy".colorize(:green)
+      end
+
+      # should download code to the release_path
+      def deploy
+        raise "Must implement deploy method"
+      end
+
+    end # of Base
+  end # of Strategy
+end # of Chap

data/lib/chap/strategy/checkout.rb

@@ -0,0 +1,62 @@
+module Chap
+  module Strategy
+    class Checkout < Base
+      def deploy
+        update
+        copy
+      end
+
+      def update
+        log "Updating repo in #{cached_path}".colorize(:green)
+        cached_root = File.dirname(cached_path)
+        FileUtils.mkdir_p(cached_root) unless File.exist?(cached_root)
+        if File.exist?(cached_path)
+          sync
+        else
+          checkout
+        end
+      end
+
+      def sync
+        command =<<-BASH
+cd #{cached_path} &&  \
+git fetch -q origin && \
+git fetch --tags -q origin && \
+git reset -q --hard #{revision} && \
+git clean -q -d -x -f
+BASH
+        run(command)
+      end
+
+      def checkout
+        command =<<BASH
+  git clone -q #{config.chap[:repo]} #{cached_path} && \
+  cd #{cached_path} && \
+  git checkout -q -b deploy #{revision}
+BASH
+        run(command)
+      end
+
+      def copy
+        command = "cp -RPp #{cached_path} #{release_path} && #{mark}"
+        run command
+        log "Code copied to #{release_path}".colorize(:green)
+      end
+
+    private
+
+      def mark
+        "(echo #{revision} > #{release_path}/REVISION)"
+      end
+
+      def revision
+        return @revision if @revision
+        result = `git ls-remote #{config.chap[:repo]} #{config.chap[:branch]}`
+        @revision = result.split(/\s/).first
+        log "Fetched revision #{@revision}".colorize(:green)
+        @revision
+      end
+
+    end # of RemoteCache
+  end # of Strategy
+end # of Chap

data/lib/chap/strategy/copy.rb

@@ -0,0 +1,10 @@
+module Chap
+  module Strategy
+    # useful for specs
+    class Copy < Base
+      def deploy
+        run("cp -RPp #{config.chap[:source]} #{release_path}")
+      end
+    end
+  end # of Strategy
+end # of Chap

data/lib/chap/strategy/hardlink.rb

@@ -0,0 +1,13 @@
+module Chap
+  module Strategy
+    class Hardlink < Checkout
+      def copy
+        copy = File.expand_path("../util/copy.rb", __FILE__)
+        command = "#{copy} #{cached_path} #{release_path} && #{mark}"
+        run command
+        log "Code copied to #{release_path}".colorize(:green)
+      end
+
+    end # of HardLink
+  end # of Strategy
+end # of Chap