whiskey_disk 0.4.5 → 0.5.0

data/README.markdown

@@ -84,15 +84,17 @@ As a rails plugin:
 
 Known config file settings (if you're familiar with capistrano and vlad these should seem eerily familiar):
  
-    domain:            host on which to deploy (this is an ssh connect string) 
-    deploy_to:         path to which to deploy main application
-    repository:        git repo path for main application
-    branch:            git branch to deploy from main application git repo (default: master)
-    deploy_config_to:  where to deploy the configuration repository
-    config_repository: git repository for configuration files
-    config_branch:     git branch to deploy from configuration git repo (default: master)
-    project:           project name (used to compute path in configuration checkout)
-    rake_env:          hash of environment variables to set when running post_setup and post_deploy rake tasks
+    domain:              host on which to deploy (this is an ssh connect string) 
+    deploy_to:           path to which to deploy main application
+    repository:          git repo path for main application
+    branch:              git branch to deploy from main application git repo (default: master)
+    deploy_config_to:    where to deploy the configuration repository
+    config_repository:   git repository for configuration files
+    config_branch:       git branch to deploy from configuration git repo (default: master)
+    project:             project name (used to compute path in configuration checkout)
+    post_deploy_script:  path to a shell script to run after deployment
+    post_setup_script:   path to a shell script to run after setup
+    rake_env:            hash of environment variables to set when running post_setup and post_deploy rake tasks
 
 
 A simple config/deploy.yml might look like:
@@ -114,6 +116,39 @@ of deploy:setup
 at the end of deploy:now
 
 
+#### post\_deploy\_script and post\_setup\_script ###
+
+Whiskey\_disk provides rake task hooks (deploy:post\_setup and deploy:post\_deploy) to allow running custom
+code after setup or deployment.  There are situations where it is desirable to run some commands prior to 
+running those rake tasks (e.g., if using bundler and needing to do a 'bundle install' before running rake).
+It may also be the case that the target system doesn't have rake (and/or ruby) installed, but some post-setup
+or post-deploy operations need to happen.  For these reasons, whiskey\_disk allows specifying a (bash-compatible)
+shell script to run after setup and/or deployment via the post\_deploy\_script and post\_setup\_script settings
+in the configuration file.  These scripts, when specified, are run immediately before running the deploy:post\_setup 
+or deploy:post\_deploy rake tasks, if they are present.
+
+The paths provided to post\_deploy\_script and post\_setup\_script can be either absolute or relative.  A path
+starting with a '/' is an absolute path, and the script specified should be at that exact location on the 
+target filesystem.  A path which does not start with a '/' is a relative path, and the script specified should
+be located at the specified path under the deployed application path.  This implies that it's possible to 
+manage post\_setup and post\_deploy scripts out of a configuration repository.
+
+A config/deploy.yml using post\_deploy\_script and post\_setup\_script might look like this:
+  
+    production:
+      domain: "ogc@www.ogtastic.com"
+      deploy_to: "/var/www/www.ogtastic.com"
+      repository: "git@ogtastic.com:www.ogtastic.com.git"
+      branch: "stable"
+      post_setup_script: "/home/ogc/horrible_place_for_this/prod-setup.sh"
+      post_deploy_script: "bin/post-deploy.sh"
+      rake_env:
+        RAILS_ENV: 'production'
+
+The post\_deploy\_script will be run from /var/www/www.ogtastic.com/bin/post-deploy.sh on the 
+target system.
+
+
 
 ### Running via rake ###
 
@@ -150,7 +185,7 @@ The --path argument can take either a file or a directory.  When given a file it
 All this means you can manage a large number of project deployments (local or remote) and have a single scripted deployment manager that keeps them up to date.  Configurations can live in a centralized location, and developers don't have to be actively involved in ensuring code gets shipped up to a server.  Win.
 
 
-### A note about post\__{setup,deploy} Rake tasks
+### A note about post\_{setup,deploy} Rake tasks
 
 If you want actions to run on the deployment target after you do a whiskey\_disk setup or whiskey\_disk deploy, 
 you will need to make sure that whiskey\_disk is available on the target system (either by gem installation,

data/Rakefile

@@ -5,10 +5,9 @@ desc 'Default: run unit tests.'
 task :default => :test
 
 desc 'Test RubyCloud'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = true
+task :test do
+  files = Dir['spec/**/*_spec.rb'].join(" ")
+  system("bacon #{files}")
 end
 
 begin

data/TODO.txt

@@ -1,3 +1,19 @@
+ - make sure that deployments don't require ruby or rake on the target machine
+ - we should probably do --depth 1 on setup, for even fastertude
+ - support 'check=yes' as a wd --check flag
+ - if someone specifies :project in a config repo block in a localized config (say a RAILS app), then use that for determining which project to use when loading the config repo
+
+ - batch deployments (--batch=/etc/deploy/hourly.yml)
+   - could have this simply pointing to a single yaml file with project name, target name, check value (default = true) (business value:  only need one command, or one cron, to manage all of these)
+   - could be a directory of individual yaml files with that information in each of them (representing one project, one target) (business value:  puppet/chef could more easily manage directories of files)
+   - trying to avoid re-using the deploy.yml because we may want to not auto-deploy all things that we have configurations for, or we may want to auto-deploy them at different frequencies
+   - do we want the config path to be in the meta file, or do we want that to come as part of the arguments to the deployment?
+
+     wd deploy --batch=/etc/deploy/hourly.yml --path=/etc/deploy/projects/
+     wd deploy --batch=/etc/deploy/hourly/ --path=/etc/deploy/projects/
+     wd deploy --batch=/etc/deploy/hourly.yml --path=/etc/deploy/deploy.yml
+     wd deploy --batch=/etc/deploy/hourly --path=/etc/deploy/projects/deploy.yml
+
  - allow whiskey_disk to pull configuration file from an url (which would be based on project, environment)
 
  - do git-deploy style change detection:  
@@ -16,19 +32,6 @@
        end
      end
 
----
-
- - [Q] how to specify readily which projects need to be deployed?  Metaconfig?:
-   
-     --- 
-     - config: /path/to/config
-       project: larry
-       target: staging
-     - config: /path/to/config
-       project: larry
-       target: production
-       cache: no
-
  - [Q] what about maintenance pages(?) (i.e., do we need a pre-deploy hook?; also are these per-target config stuffs?; fun managing changes to a maintenance page ;-)
  - [Q] do we want a mechanism to manage the config repo?  (add a repo, add a project, add an environment, put a file into the config repo for an environment?)
  - [Q] what about per-target rake tasks, do we just store these in the config repo?  does this work?

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.5.0

data/lib/whiskey_disk.rb

@@ -140,6 +140,17 @@ class WhiskeyDisk
         if_task_defined(task_name, "#{env_vars} rake --trace #{task_name} to=#{self[:environment]}")))
     end
     
+    def build_path(path)
+      return path if path =~ %r{^/}
+      File.join(self[:deploy_to], path)
+    end
+
+    def run_script(script)
+      return unless script
+      path = build_path(script)
+      enqueue("if [ -e #{path} ]; then sh -x #{path}; fi ")
+    end
+
     def ensure_main_parent_path_is_present
       needs(:deploy_to)
       enqueue "mkdir -p #{parent_path(self[:deploy_to])}"
@@ -178,11 +189,13 @@ class WhiskeyDisk
     
     def run_post_setup_hooks
       needs(:deploy_to)
+      run_script(self[:post_setup_script])
       run_rake_task(self[:deploy_to], "deploy:post_setup")
     end
-
+    
     def run_post_deploy_hooks
       needs(:deploy_to)
+      run_script(self[:post_deploy_script])
       run_rake_task(self[:deploy_to], "deploy:post_deploy")
     end
   end

data/spec/whiskey_disk_spec.rb

@@ -357,11 +357,76 @@ describe 'WhiskeyDisk' do
       WhiskeyDisk.buffer.join(' ').should.match(%r{cd /path/to/main/repo})
     end
     
+    describe 'when a post setup script is specified' do
+      describe 'and the script path does not start with a "/"' do      
+        before do
+          @parameters = { 'deploy_to'          => '/path/to/main/repo', 
+                          'post_setup_script' => '/path/to/setup/script' }
+          WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
+          WhiskeyDisk.reset
+        end
+      
+        it 'should attempt to run the post setup script' do        
+          WhiskeyDisk.run_post_setup_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x .*/path/to/setup/script})
+        end
+      
+        it 'should use an absolute path to run the post setup script when the script path starts with a "/"' do
+          WhiskeyDisk.run_post_setup_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x /path/to/setup/script})         
+        end
+        
+        it 'should make the post setup script run conditional on the presence of the script' do
+          WhiskeyDisk.run_post_setup_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{if \[ -e /path/to/setup/script \]; then .*; fi})
+        end
+      end
+      
+      describe 'and the script path does not start with a "/"' do
+        before do
+          @parameters = { 'deploy_to'          => '/path/to/main/repo', 
+                          'post_setup_script' => 'path/to/setup/script' }
+          WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
+          WhiskeyDisk.reset         
+        end
+
+        it 'should attempt to run the post setup script' do        
+          WhiskeyDisk.run_post_setup_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x .*/path/to/setup/script})
+        end
+      
+        it 'should use a path relative to the setupment path to run the post setup script' do
+          WhiskeyDisk.run_post_setup_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x /path/to/main/repo/path/to/setup/script})
+        end
+        
+        it 'should make the post setup script run conditional on the presence of the script' do
+          WhiskeyDisk.run_post_setup_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{if \[ -e /path/to/main/repo/path/to/setup/script \]; then .*; fi})
+        end
+      end
+    end
+        
+    it 'should attempt to run the post setup rake tasks' do
+      WhiskeyDisk.run_post_setup_hooks
+      WhiskeyDisk.buffer.join(' ').should.match(%r{rake.*deploy:post_setup})
+    end
+    
+    it 'should use the same environment when running the rake tasks' do
+      WhiskeyDisk.run_post_setup_hooks
+      WhiskeyDisk.buffer.join(' ').should.match(%r{to=#{@env}})      
+    end
+    
     it 'should make the post setup rake tasks conditional on the presence of a Rakefile in the deployment path' do      
       WhiskeyDisk.run_post_setup_hooks
       WhiskeyDisk.buffer.join(' ').should.match(%r{if \[ -e /path/to/main/repo/Rakefile \]; then .*; fi})
     end
     
+    it 'should make the post setup rake tasks conditional on the deploy:post_setup rake task being defined' do
+      WhiskeyDisk.run_post_setup_hooks
+      WhiskeyDisk.buffer.join(' ').should.match(%r{if \[\[ \`rake -P | grep deploy:post_setup\` != "" \]\]; })      
+    end
+
     it 'should ensure that any rake ENV variable are set when checking for deploy:post_setup tasks' do
       @parameters = { 'deploy_to' => '/path/to/main/repo', 'rake_env' => { 'RAILS_ENV' => 'production', 'FOO' => 'bar' } }
       WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
@@ -372,21 +437,6 @@ describe 'WhiskeyDisk' do
       end
     end
     
-    it 'should make the post setup rake tasks conditional on the deploy:post_setup rake task being defined' do
-      WhiskeyDisk.run_post_setup_hooks
-      WhiskeyDisk.buffer.join(' ').should.match(%r{if \[\[ \`rake -P | grep deploy:post_setup\` != "" \]\]; })      
-    end
-
-    it 'should attempt to run the post setup rake tasks' do
-      WhiskeyDisk.run_post_setup_hooks
-      WhiskeyDisk.buffer.join(' ').should.match(%r{rake.*deploy:post_setup})
-    end
-    
-    it 'should use the same environment when running the rake tasks' do
-      WhiskeyDisk.run_post_setup_hooks
-      WhiskeyDisk.buffer.join(' ').should.match(%r{to=#{@env}})      
-    end
-    
     it 'should set any rake_env variables when running the rake tasks' do
       @parameters = { 'deploy_to' => '/path/to/main/repo', 'rake_env' => { 'RAILS_ENV' => 'production', 'FOO' => 'bar' } }
       WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
@@ -416,16 +466,66 @@ describe 'WhiskeyDisk' do
       WhiskeyDisk.buffer.join(' ').should.match(%r{cd /path/to/main/repo})
     end
     
-    it 'should ensure that any rake ENV variable are set when checking for deploy:post_setup tasks' do
-      @parameters = { 'deploy_to' => '/path/to/main/repo', 'rake_env' => { 'RAILS_ENV' => 'production', 'FOO' => 'bar' } }
-      WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
-      WhiskeyDisk.reset
-      WhiskeyDisk.run_post_deploy_hooks
-      @parameters['rake_env'].each_pair do |k,v|
-        WhiskeyDisk.buffer.join(' ').should.match(%r{#{k}='#{v}' .*rake -P})
+    describe 'when a post deployment script is specified' do
+      describe 'and the script path does not start with a "/"' do      
+        before do
+          @parameters = { 'deploy_to'          => '/path/to/main/repo', 
+                          'post_deploy_script' => '/path/to/deployment/script' }
+          WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
+          WhiskeyDisk.reset
+        end
+      
+        it 'should attempt to run the post deployment script' do        
+          WhiskeyDisk.run_post_deploy_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x .*/path/to/deployment/script})
+        end
+      
+        it 'should use an absolute path to run the post deployment script when the script path starts with a "/"' do
+          WhiskeyDisk.run_post_deploy_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x /path/to/deployment/script})         
+        end
+        
+        it 'should make the post deployment script run conditional on the presence of the script' do
+          WhiskeyDisk.run_post_deploy_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{if \[ -e /path/to/deployment/script \]; then .*; fi})
+        end
+      end
+      
+      describe 'and the script path does not start with a "/"' do
+        before do
+          @parameters = { 'deploy_to'          => '/path/to/main/repo', 
+                          'post_deploy_script' => 'path/to/deployment/script' }
+          WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
+          WhiskeyDisk.reset         
+        end
+
+        it 'should attempt to run the post deployment script' do        
+          WhiskeyDisk.run_post_deploy_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x .*/path/to/deployment/script})
+        end
+      
+        it 'should use a path relative to the deployment path to run the post deployment script' do
+          WhiskeyDisk.run_post_deploy_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{sh -x /path/to/main/repo/path/to/deployment/script})
+        end
+        
+        it 'should make the post deployment script run conditional on the presence of the script' do
+          WhiskeyDisk.run_post_deploy_hooks
+          WhiskeyDisk.buffer.join(' ').should.match(%r{if \[ -e /path/to/main/repo/path/to/deployment/script \]; then .*; fi})
+        end
       end
     end
+        
+    it 'should attempt to run the post deployment rake tasks' do
+      WhiskeyDisk.run_post_deploy_hooks
+      WhiskeyDisk.buffer.join(' ').should.match(%r{rake.*deploy:post_deploy})
+    end
     
+    it 'should use the same environment when running the rake tasks' do
+      WhiskeyDisk.run_post_deploy_hooks
+      WhiskeyDisk.buffer.join(' ').should.match(%r{to=#{@env}})      
+    end
+
     it 'should make the post deployment rake tasks conditional on the presence of a Rakefile in the deployment path' do      
       WhiskeyDisk.run_post_deploy_hooks
       WhiskeyDisk.buffer.join(' ').should.match(%r{if \[ -e /path/to/main/repo/Rakefile \]; then .*; fi})
@@ -435,15 +535,15 @@ describe 'WhiskeyDisk' do
       WhiskeyDisk.run_post_deploy_hooks
       WhiskeyDisk.buffer.join(' ').should.match(%r{if \[\[ \`rake -P | grep deploy:post_deploy\` != "" \]\]; })      
     end
-    
-    it 'should attempt to run the post deployment rake tasks' do
-      WhiskeyDisk.run_post_deploy_hooks
-      WhiskeyDisk.buffer.join(' ').should.match(%r{rake.*deploy:post_deploy})
-    end
-    
-    it 'should use the same environment when running the rake tasks' do
+
+    it 'should ensure that any rake ENV variable are set when checking for deploy:post_setup tasks' do
+      @parameters = { 'deploy_to' => '/path/to/main/repo', 'rake_env' => { 'RAILS_ENV' => 'production', 'FOO' => 'bar' } }
+      WhiskeyDisk::Config.stub!(:fetch).and_return(@parameters)
+      WhiskeyDisk.reset
       WhiskeyDisk.run_post_deploy_hooks
-      WhiskeyDisk.buffer.join(' ').should.match(%r{to=#{@env}})      
+      @parameters['rake_env'].each_pair do |k,v|
+        WhiskeyDisk.buffer.join(' ').should.match(%r{#{k}='#{v}' .*rake -P})
+      end
     end
     
     it 'should set any rake_env variables when running the rake tasks' do

data/whiskey_disk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whiskey_disk}
-  s.version = "0.4.5"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rick Bradley"]
-  s.date = %q{2010-08-31}
+  s.date = %q{2010-09-06}
   s.default_executable = %q{wd}
   s.description = %q{Opinionated gem for doing fast git-based server deployments.}
   s.email = %q{rick@rickbradley.com}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whiskey_disk
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
   - 5
-  version: 0.4.5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Rick Bradley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 -05:00
+date: 2010-09-06 00:00:00 -05:00
 default_executable: wd
 dependencies: 
 - !ruby/object:Gem::Dependency