chap 0.0.1

data/lib/chap/strategy/util/copy.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+# ---------------------------------------------------------------------------
+# A simple copy script for doing hard links and symbolic links instead of
+# explicit copies. Some OS's will already have a utility to do this, but
+# some won't; this file suffices in either case.
+#
+# Usage: ruby copy.rb <source> <target> <exclude> ...
+#
+# The <source> directory is recursively descended, and hard links to all of
+# the files are created in corresponding locations under <target>. Symbolic
+# links in <source> map to symbolic links in <target> that point to the same
+# destination.
+#
+# All arguments after <target> are taken to be exclude patterns. Any file
+# or directory in <source> that matches any of those patterns will be
+# skipped, and will thus not be present in <target>.
+# ---------------------------------------------------------------------------
+# This file is distributed under the terms of the MIT license by 37signals,
+# LLC, and is copyright (c) 2008 by the same. See the LICENSE file distributed
+# with this file for the complete text of the license.
+# ---------------------------------------------------------------------------
+require 'fileutils'
+
+from = ARGV.shift or abort "need source directory"
+to   = ARGV.shift or abort "need target directory"
+
+exclude = ARGV
+
+from = File.expand_path(from)
+to   = File.expand_path(to)
+
+Dir.chdir(from) do
+  FileUtils.mkdir_p(to)
+  queue = Dir.glob("*", File::FNM_DOTMATCH)
+  while queue.any?
+    item = queue.shift
+    name = File.basename(item)
+
+    next if name == "." || name == ".."
+    next if exclude.any? { |pattern| File.fnmatch(pattern, item) }
+
+    source = File.join(from, item)
+    target = File.join(to, item)
+
+    if File.symlink?(item)
+      FileUtils.ln_s(File.readlink(source), target)
+    elsif File.directory?(item)
+      queue += Dir.glob("#{item}/*", File::FNM_DOTMATCH)
+      FileUtils.mkdir_p(target, :mode => File.stat(item).mode)
+    else
+      FileUtils.ln(source, target)
+    end
+  end
+end

data/lib/chap/strategy.rb

@@ -0,0 +1,6 @@
+strategy = File.expand_path('../strategy', __FILE__)
+require "#{strategy}/base"
+require "#{strategy}/checkout"
+Dir.glob("#{strategy}/*.rb").each do |file|
+  require file
+end

data/lib/chap/task.rb

@@ -0,0 +1,28 @@
+module Chap
+  class Task
+    def self.setup(options={})
+      puts "Generating config files" unless options[:quiet]
+      setup = File.expand_path("../../setup", __FILE__)
+      output = options[:output] || '.'
+      Dir.glob("#{setup}/*").each do |source|
+        dest = "#{output}/#{File.basename(source)}"
+        if File.exist?(dest)
+          if options[:force]
+            puts "Overwriting: #{dest}" unless options[:quiet]
+            FileUtils.cp(source, dest)
+          else
+            puts "Already exist: #{dest}" unless options[:quiet]
+          end
+        else
+          FileUtils.cp(source, dest)
+          puts "Created: #{dest}" unless options[:quiet]
+        end
+      end
+    end
+
+    def self.deploy(options)
+      runner = options.empty? ? Runner.new : Runner.new(options)
+      runner.deploy
+    end
+  end
+end

data/lib/chap/version.rb

@@ -0,0 +1,3 @@
+module Chap
+  VERSION = "0.0.1"
+end

data/lib/chap.rb

@@ -0,0 +1,17 @@
+require "chap/version"
+require "yaml"
+require "json"
+require "colorize"
+require "logger"
+require "thor"
+require "pp"
+
+$:.unshift File.expand_path('../', __FILE__)
+require 'mash'
+require 'chap/cli'
+require 'chap/task'
+require 'chap/special_methods'
+require 'chap/config'
+require 'chap/runner'
+require 'chap/hook'
+require 'chap/strategy'

data/lib/mash.rb

@@ -0,0 +1,225 @@
+# Copyright (c) 2009 Dan Kubb
+
+# 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.
+
+# ---
+# ---
+
+# Some portions of blank.rb and mash.rb are verbatim copies of software
+# licensed under the MIT license. That license is included below:
+
+# Copyright (c) 2005-2008 David Heinemeier Hansson
+
+# 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.
+
+# This class has dubious semantics and we only have it so that people can write
+# params[:key] instead of params['key'].
+class Mash < Hash
+
+  # @param constructor<Object>
+  #   The default value for the mash. Defaults to an empty hash.
+  #
+  # @details [Alternatives]
+  #   If constructor is a Hash, a new mash will be created based on the keys of
+  #   the hash and no default value will be set.
+  def initialize(constructor = {})
+    if constructor.is_a?(Hash)
+      super()
+      update(constructor)
+    else
+      super(constructor)
+    end
+  end
+
+  # @param orig<Object> Mash being copied
+  #
+  # @return [Object] A new copied Mash
+  def initialize_copy(orig)
+    super
+    # Handle nested values
+    each do |k,v|
+      if v.kind_of?(Mash) || v.is_a?(Array)
+        self[k] = v.dup
+      end
+    end
+    self
+  end
+
+  # @param key<Object> The default value for the mash. Defaults to nil.
+  #
+  # @details [Alternatives]
+  #   If key is a Symbol and it is a key in the mash, then the default value will
+  #   be set to the value matching the key.
+  def default(key = nil)
+    if key.is_a?(Symbol) && include?(key = key.to_s)
+      self[key]
+    else
+      super
+    end
+  end
+
+  alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+  alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+  # @param key<Object> The key to set.
+  # @param value<Object>
+  #   The value to set the key to.
+  #
+  # @see Mash#convert_key
+  # @see Mash#convert_value
+  def []=(key, value)
+    regular_writer(convert_key(key), convert_value(value))
+  end
+
+  # @param other_hash<Hash>
+  #   A hash to update values in the mash with. The keys and the values will be
+  #   converted to Mash format.
+  #
+  # @return [Mash] The updated mash.
+  def update(other_hash)
+    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+    self
+  end
+
+  alias_method :merge!, :update
+
+  # @param key<Object> The key to check for. This will be run through convert_key.
+  #
+  # @return [Boolean] True if the key exists in the mash.
+  def key?(key)
+    super(convert_key(key))
+  end
+
+  # def include? def has_key? def member?
+  alias_method :include?, :key?
+  alias_method :has_key?, :key?
+  alias_method :member?, :key?
+
+  # @param key<Object> The key to fetch. This will be run through convert_key.
+  # @param *extras<Array> Default value.
+  #
+  # @return [Object] The value at key or the default value.
+  def fetch(key, *extras)
+    super(convert_key(key), *extras)
+  end
+
+  # @param *indices<Array>
+  #   The keys to retrieve values for. These will be run through +convert_key+.
+  #
+  # @return [Array] The values at each of the provided keys
+  def values_at(*indices)
+    indices.collect {|key| self[convert_key(key)]}
+  end
+
+  # @param hash<Hash> The hash to merge with the mash.
+  #
+  # @return [Mash] A new mash with the hash values merged in.
+  def merge(hash)
+    self.dup.update(hash)
+  end
+
+  # @param key<Object>
+  #   The key to delete from the mash.\
+  def delete(key)
+    super(convert_key(key))
+  end
+
+  # @param *rejected<Array[(String, Symbol)] The mash keys to exclude.
+  #
+  # @return [Mash] A new mash without the selected keys.
+  #
+  # @example
+  #   { :one => 1, :two => 2, :three => 3 }.except(:one)
+  #     #=> { "two" => 2, "three" => 3 }
+  def except(*keys)
+    super(*keys.map {|k| convert_key(k)})
+  end
+
+  # Used to provide the same interface as Hash.
+  #
+  # @return [Mash] This mash unchanged.
+  def stringify_keys!; self end
+
+  # @return [Hash] The mash as a Hash with symbolized keys.
+  def symbolize_keys
+    h = Hash.new(default)
+    each { |key, val| h[key.to_sym] = val }
+    h
+  end
+
+  # @return [Hash] The mash as a Hash with string keys.
+  def to_hash
+    Hash.new(default).merge(self)
+  end
+
+  # @return [Mash] Convert a Hash into a Mash
+  # The input Hash's default value is maintained
+  def self.from_hash(hash)
+    mash = Mash.new(hash)
+    mash.default = hash.default
+    mash
+  end
+
+  protected
+  # @param key<Object> The key to convert.
+  #
+  # @param [Object]
+  #   The converted key. If the key was a symbol, it will be converted to a
+  #   string.
+  #
+  # @api private
+  def convert_key(key)
+    key.kind_of?(Symbol) ? key.to_s : key
+  end
+
+  # @param value<Object> The value to convert.
+  #
+  # @return [Object]
+  #   The converted value. A Hash or an Array of hashes, will be converted to
+  #   their Mash equivalents.
+  #
+  # @api private
+  def convert_value(value)
+    if value.class == Hash
+      Mash.from_hash(value)
+    elsif value.is_a?(Array)
+      value.collect { |e| convert_value(e) }
+    else
+      value
+    end
+  end
+end

data/lib/setup/chap.json

@@ -0,0 +1,10 @@
+{
+  "repo": "git@github.com:tongueroo/chapdemo.git",
+  "branch": "master",
+  "application": "chapdemo",
+  "deploy_to": "/data/chapdemo",
+  "strategy": "checkout",
+  "keep": 5,
+  "user": "deploy",
+  "group": "deploy"
+}

data/lib/setup/chap.yml

@@ -0,0 +1,2 @@
+chap: /etc/chef/chap.json
+node: /etc/chef/node.json

data/lib/setup/node.json

@@ -0,0 +1,5 @@
+{
+  "environment": "staging",
+  "application": "chapdemo",
+  "instance_role": "app"
+}

data/spec/fixtures/chapdemo/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/fixtures/chapdemo/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'rack'

data/spec/fixtures/chapdemo/chap/deploy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+log "cd #{release_path} && bundle"
+run "cd #{release_path} && echo bundle"

data/spec/fixtures/chapdemo/chap/restart

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+restart = case node[:instance_role]
+          when 'app'
+            "touch tmp/restart.txt"
+          when 'resque'
+            "rvmsudo bluepill restart resque"
+          end
+log "cd #{current_path} && #{restart}"
+run "cd #{current_path} && echo '#{restart}'"

data/spec/fixtures/chapdemo/config.ru

@@ -0,0 +1 @@
+run Proc.new {|env| [200, {"Content-Type" => "text/html"}, ["OK"]]}

data/spec/lib/chap_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Chap do
+  before(:each) do
+    @root = File.expand_path("../../../", __FILE__)
+    @system_root = "#{@root}/spec/fixtures/system_root"
+  end
+
+  describe "deploy" do
+    before(:each) do
+      setup_files
+
+      @chap = Chap::Runner.new(
+        :quiet => true,
+        :config => "#{@system_root}/etc/chef/chap.yml"
+      )
+      timestamp = @chap.config.timestamp
+      @release_path = "#{@system_root}/data/chapdemo/releases/#{timestamp}"
+    end
+
+    it "should deploy code" do
+      @chap.deploy
+      File.exist?("#{@system_root}/data/chapdemo/shared").should be_true
+      File.exist?(@release_path).should be_true
+      File.symlink?("#{@system_root}/data/chapdemo/current").should be_true
+      releases = Dir.glob("#{@system_root}/data/chapdemo/releases/*").size
+      releases.should >= 1
+      releases.should <= 2 # test the keep option
+    end
+
+    it "should deploy code via command line" do
+      system("cd #{@root} && ./bin/chap deploy -q -c #{@system_root}/etc/chef/chap.yml")
+      releases = Dir.glob("#{@system_root}/data/chapdemo/releases/*").sort
+      timestamp = releases.last.split('/').last
+      release_path = "#{@system_root}/data/chapdemo/releases/#{timestamp}"
+
+      File.exist?("#{@system_root}/data/chapdemo/shared").should be_true
+      File.exist?(release_path).should be_true
+      File.symlink?("#{@system_root}/data/chapdemo/current").should be_true
+      releases = Dir.glob("#{@system_root}/data/chapdemo/releases/*").size
+      releases.should >= 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require "pp"
+require "bundler"
+
+Bundler.require(:development)
+
+$root = File.expand_path('../../', __FILE__)
+
+require "#{$root}/lib/chap"
+
+# use to overwrite the demo one created from examples/chap.json for testing
+def setup_files(options={})
+  FileUtils.mkdir_p("#{@system_root}/etc/chef")
+  system("cd #{@root} && ./bin/chap setup -q -f -o #{@system_root}/etc/chef")
+  update_chap_yml(options)
+  update_chap_json(options)
+end
+
+# change system_root for chap.yml
+def update_chap_yml(options)
+  path = "#{@system_root}/etc/chef/chap.yml"
+  yaml = YAML.load(IO.read(path))
+  yaml['chap'] = @system_root + yaml['chap']
+  yaml['node'] = @system_root + yaml['node']
+  File.open("#{@system_root}/etc/chef/chap.yml", "w") do |file|
+    data = YAML.dump(yaml)
+    file.write(data)
+  end
+end
+
+# change system_root for chap.json
+def update_chap_json(options)
+  chap = JSON.parse(IO.read("#{@system_root}/etc/chef/chap.json"))
+  chap['deploy_to'] = @system_root + chap['deploy_to']
+  chap['strategy'] = ENV['TIER'] == '2' ? "checkout" : "copy"
+  chap['source'] = @root + "/spec/fixtures/chapdemo"
+  chap['keep'] = 2
+  chap['user'] = ENV['USER']
+  chap['group'] = nil
+  File.open("#{@system_root}/etc/chef/chap.json", "w") do |file|
+    json = JSON.pretty_generate(chap)
+    file.write(json)
+  end
+end