chap 0.0.6 → 0.0.7

data/README.md

@@ -19,17 +19,13 @@ The same command is called whether you're using chef or capistrano for deploymen
 $ 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.
+* 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: 
 
@@ -60,6 +56,10 @@ $ cat /etc/chef/node.json
 }
 </pre>
 
+## Usage
+
+The chap command is meant to be executed on the server which you want to deploy the code.  
+
 ### Deploy sequence
 
 The deploy sequence is based on the sequence from the capistrano and chef deploy resource provider.
@@ -97,16 +97,14 @@ Chap loads up information from node.json because it needs the information for ho
 <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}"
+if node[:instance_role] == 'app'
+  run "cd #{current_path} && touch tmp/restart.txt"
+elsif node[:instance_role] == 'resque'
+  run "rvmsudo bluepill restart resque"
+end
 </pre>
 
-## Deploy Hooks
+### Deploy Hooks
 
 Define your deploy hooks in the chap folder of the project.  There are 2 deploy hooks.
 
@@ -118,12 +116,32 @@ Deploy hooks get evaluated within the context of a chap deploy run and have some
 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.
+* 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, latest_release.  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.
+* symlink_configs - useful as a chap/deploy hook. Symlinks any config files in [shared_path]/config/* over to [release_path]/config.
+* with - used to prepend all commands with the run method in a block with another command.  A example is provided below.
+
+
+with example:
+
+<pre>
+with "cd #{release_path} && RAILS_ENV=#{node[:environment]} " do
+  run "rake do:something1"
+  run "rake do:something2"
+end
+</pre>
+
+is the same as:
+
+<pre>
+run "cd #{release_path} && RAILS_ENV=#{node[:environment]} rake do:something1"
+run "cd #{release_path} && RAILS_ENV=#{node[:environment]} rake do:something2"
+</pre>
+
 
 ### Test deploy hooks
 
@@ -134,4 +152,13 @@ $ cap hook deploy
 $ cap hook restart
 </pre>
 
-This will test the hooks on the latest timestamp release at [deploy_to]/releases/[timestamp].
+This will test the hooks on the latest timestamp release at [deploy_to]/releases/[timestamp].
+
+### Syncing restart phase
+
+Some apps require that all the code be available on all the servers before a restart should happen on any of the servers.  For example, if you're serving assets on the same server as your app code, you wan to make sure that the assets have been download on all servers before any of the servers start serving the new assets.  To sync the retart phase you have to break out the capistano recipe so that it calls 2 chap command:
+
+<pre>
+$ chap deploy --stop-at-symlink
+$ chap deploy --cont-at-symlink
+</pre>

data/lib/chap/cli.rb

@@ -19,6 +19,8 @@ module Chap
     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"
+    method_option :stop_at_symlink, :type => :boolean, :desc => "Deploy code but stop right before the symlink"
+    method_option :cont_at_symlink, :type => :boolean, :desc => "Symlink and contine the deploy"
     def deploy
       Chap::Task.deploy(options)
     end
@@ -36,5 +38,19 @@ module Chap
     def hook(name)
       Chap::Runner.new(options).test_hook(name)
     end
+
+    desc "symlink", "Symlink latest timestamp release to current"
+    long_desc <<-EOL
+      Example:
+
+      $ chap symlink
+
+      Useful for testing between testing deploy and restart hooks.
+    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 symlink
+      Chap::Runner.new(options).symlink
+    end
   end
 end

data/lib/chap/runner.rb

@@ -9,16 +9,30 @@ module Chap
     end
 
     def deploy
+      deploy_to_symlink
+      deploy_from_symlink
+    end
+
+    def deploy_to_symlink
       setup
       strategy.deploy
       symlink_shared
       rm_rvmrc
       hook(:deploy)
+    end
+
+    def deploy_from_symlink(use_previous=false)
+      use_previous_timestamp if use_previous
       symlink_current
       hook(:restart)
       cleanup
     end
 
+    def symlink
+      use_previous_timestamp
+      symlink_current
+    end
+
     def setup
       user = config.chap[:user] || ENV['USER']
       group = config.chap[:group]
@@ -125,9 +139,13 @@ module Chap
     end
 
     def test_hook(name)
+      use_previous_timestamp
+      hook(name)
+    end
+
+    def use_previous_timestamp
       timestamp = File.basename(latest_release)
       config.override_timestamp(timestamp)
-      hook(name)
     end
 
     def hook(name)

data/lib/chap/task.rb

@@ -22,7 +22,13 @@ module Chap
 
     def self.deploy(options)
       runner = options.empty? ? Runner.new : Runner.new(options)
-      runner.deploy
+      if options[:stop_at_symlink]
+        runner.deploy_to_symlink
+      elsif options[:cont_at_symlink]
+        runner.deploy_from_symlink(true)
+      else
+        runner.deploy
+      end
     end
   end
 end

data/lib/chap/version.rb

@@ -1,3 +1,3 @@
 module Chap
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/lib/chap_spec.rb

@@ -2,70 +2,111 @@ require 'spec_helper'
 
 describe Chap do
   before(:each) do
-    @root = File.expand_path("../../../", __FILE__)
-    @system_root = "#{@root}/spec/fixtures/system_root"
+    setup
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(system_root)
   end
 
   describe "internal code deploy" do
     before(:each) do
-      setup_files
-
       @chap = Chap::Runner.new(
         :quiet => true,
-        :config => "#{@system_root}/etc/chef/chap.yml"
+        :config => "#{system_root}/etc/chef/chap.yml"
       )
       timestamp = @chap.config.timestamp
-      @release_path = "#{@system_root}/data/chapdemo/releases/#{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?("#{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
+      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
   end
 
   describe "cli deploy" do
-    before(:each) do
-      setup_files
-    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
+      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}"
+      release_path = "#{system_root}/data/chapdemo/releases/#{timestamp}"
 
-      File.exist?("#{@system_root}/data/chapdemo/shared").should be_true
+      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
+      File.symlink?("#{system_root}/data/chapdemo/current").should be_true
+      releases = Dir.glob("#{system_root}/data/chapdemo/releases/*").size
       releases.should >= 1
     end
 
     it "should deploy code and test hook" do
-      system("cd #{@root} && ./bin/chap deploy -q -c #{@system_root}/etc/chef/chap.yml")
-      releases = Dir.glob("#{@system_root}/data/chapdemo/releases/*").sort
+      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}"
-      current_path = "#{@system_root}/data/chapdemo/current"
+      release_path = "#{system_root}/data/chapdemo/releases/#{timestamp}"
+      current_path = "#{system_root}/data/chapdemo/current"
       File.exist?(release_path).should be_true
       File.exist?("#{release_path}/deploy.txt").should be_true
 
       # test hook deploy
       FileUtils.rm_f("#{release_path}/deploy.txt")
       File.exist?("#{release_path}/deploy.txt").should be_false
-      system("cd #{@root} && ./bin/chap hook deploy -q -c #{@system_root}/etc/chef/chap.yml")
+      system("cd #{root} && ./bin/chap hook deploy -q -c #{system_root}/etc/chef/chap.yml")
       File.exist?("#{release_path}/deploy.txt").should be_true
 
       # test hook restart
       FileUtils.rm_f("#{current_path}/restart.txt")
-      system("cd #{@root} && ./bin/chap hook restart -q -c #{@system_root}/etc/chef/chap.yml")
+      system("cd #{root} && ./bin/chap hook restart -q -c #{system_root}/etc/chef/chap.yml")
       File.exist?("#{current_path}/restart.txt").should be_true
     end
+
+    it "should deploy code stopping and continuing at symlink" do
+      system("cd #{root} && ./bin/chap deploy --stop-at-symlink -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}"
+      current_path = "#{system_root}/data/chapdemo/current"
+      File.exist?(release_path).should be_true
+      # no current symlink
+      File.exist?(current_path).should_not be_true
+      releases = Dir.glob("#{system_root}/data/chapdemo/releases/*").size
+      releases.should == 1
+      sleep 2 if tier(2)
+      # continue deploy
+      system("cd #{root} && ./bin/chap deploy --cont-at-symlink -q -c #{system_root}/etc/chef/chap.yml")
+      link = File.readlink(current_path)
+      link.should == release_path
+    end
+
+    it "should symlink previous release to current" do
+      system("cd #{root} && ./bin/chap deploy --stop-at-symlink -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}"
+      current_path = "#{system_root}/data/chapdemo/current"
+      File.exist?(release_path).should be_true
+      # no current symlink
+      File.exist?(current_path).should_not be_true
+      system("cd #{root} && ./bin/chap symlink -q -c #{system_root}/etc/chef/chap.yml")
+      File.exist?(current_path).should be_true
+      link = File.readlink(current_path)
+      link.should == release_path
+      # running twice should link to same symlink
+      system("cd #{root} && ./bin/chap symlink -q -c #{system_root}/etc/chef/chap.yml")
+      link = File.readlink(current_path)
+      link.should == release_path
+    end
+
+    it "should only respect keep option" do
+      system("cd #{root} && ./bin/chap deploy -q -c #{system_root}/etc/chef/chap.yml")
+      system("cd #{root} && ./bin/chap deploy -q -c #{system_root}/etc/chef/chap.yml")
+      system("cd #{root} && ./bin/chap deploy -q -c #{system_root}/etc/chef/chap.yml")
+      releases = Dir.glob("#{system_root}/data/chapdemo/releases/*").size
+      releases.should == 2 # test the keep option
+    end
   end
 end

data/spec/spec_helper.rb

@@ -7,37 +7,54 @@ $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
+module Helpers
+  attr_reader :root, :system_root
+  def setup
+    @root = File.expand_path("../../", __FILE__)
+    @system_root = "#{@root}/spec/fixtures/system_root"
+    create_chap_files
+  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)
+  # use to overwrite the demo one created from examples/chap.json for testing
+  def create_chap_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
-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)
+  # 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
+
+  def tier(level)
+    ENV['TIER'] == level.to_s
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chap
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake