whiskey_disk 0.6.2 → 0.6.3

data/CHANGELOG

@@ -1,3 +1,11 @@
+
+0.6.3 / 2011-01-13 
+==================
+
+  * adding support for config_target in deploy.yml
+  * updating README for upcoming config_target support
+  * bumping version to 0.6.3
+
 0.6.2 / 2010-12-23 
 ==================
 

data/README.markdown

@@ -39,7 +39,8 @@ current local checkout.
   - You can separate per-deployment application configuration information (e.g., passwords, 
     database configs, hoptoad/AWS/email config data, etc.) in separate repositories from 
     the application, and whiskey\_disk will merge the correct data onto the deployed 
-    application at deployment time.
+    application at deployment time.  You can even share sets of configuration files among
+    deployment targets that behave alike.
 
   - You can have per-developer configurations for targets (especially
     useful for "local" or "development" targets).  Use .gitignore, or
@@ -116,6 +117,7 @@ Known config file settings (if you're familiar with capistrano and vlad these sh
     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)
+    config_target:       configuration repository target path to use
     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
@@ -532,11 +534,62 @@ overlaid on top of the most recent checkout of the project.  Snap.
                         |
                         ....
 
- 
+
+#### Sharing a set of configuration files among multiple targets ####
+
+Developers on applications with many deployment targets can find that configuration repositories can become a burden to maintain, especially when a number of environments share essentially the same configurations.  For example, for an application where deployments for user acceptance testing, QA, staging, and feature branch demoing are all essentially the same (though differing from production configurations and developer configurations), it's probably easiest to store a configuration for development, a configuration for production, a configuration for staging and then use the staging configuration for all the other environments: user acceptance testing, QA, staging, demo1, demo2, etc.  Using the config\_target setting, a deploy.yml might look like this:
+
+
+    production:
+      domain: "www.ogtastic.com"
+      deploy_to: "/var/www/www.ogtastic.com"
+      repository: "git@ogtastic.com:www.ogtastic.com.git"
+      branch: "production"
+      config_repository: "git@ogtastic.com:ogc-production-config.git"
+    development:
+      deploy_to: '/var/www/devel.ogtastic.com'
+      repository: "git@ogtastic.com:www.ogtastic.com.git"
+      branch: "develop"
+      config_repository: "git@ogtastic.com:ogc-config.git"
+    staging:
+      [...]
+      config_repository: "git@ogtastic.com:ogc-config.git"
+    uat:
+      [....]
+      config_repository: "git@ogtastic.com:ogc-config.git"
+      config_target: "staging"
+    qa:
+      [....]
+      config_repository: "git@ogtastic.com:ogc-config.git"
+      config_target: "staging"
+
+
+So here we have the 'staging', 'uat', and 'qa' deployment targets all sharing the 'staging' configuration repo information.  The non-production configuration repo can then look like:
+
+
+    project-config/
+      |
+      +---ogtastic/
+            |
+            +---staging/
+            |     |
+            |     |
+            |     +---config/
+            |           |
+            |           ....
+            |
+            +---development/
+                  |
+                  +---config/
+                        |
+                        ....
+
+
+Notice that there are no separate trees for 'uat' and 'qa' targets.
 
 ### More Examples: ###
 
- - We are using this to manage larry.  See [https://github.com/flogic/larry/blob/master/config/deploy-local.yml.example](https://github.com/flogic/larry/blob/master/config/deploy-local.yml.example) and [http://github.com/flogic/larry/blob/master/lib/tasks/deploy.rake](http://github.com/flogic/larry/blob/master/lib/tasks/deploy.rake)
+ - We are using whiskey\_disk to manage larry.  See [https://github.com/flogic/larry/blob/master/config/deploy-local.yml.example](https://github.com/flogic/larry/blob/master/config/deploy-local.yml.example) and [http://github.com/flogic/larry/blob/master/lib/tasks/deploy.rake](http://github.com/flogic/larry/blob/master/lib/tasks/deploy.rake)
 
  - Here is a sample of a lib/tasks/deploy.rake from a Rails application we deployed once upon a time:
 

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.3

data/examples/deploy-configs.yml

@@ -0,0 +1,13 @@
+production:
+  domain: "ogc@hoenir.websages.com"
+  deploy_to: "/tmp/test-deployment"
+  deploy_config_to: "/tmp/test-config"
+  repository: "git@git.ogtastic.com:whiskey_disk.git"
+  config_repository: "git@git.ogtastic.com:ogc-config.git"
+staging:
+  domain: "ogc@hoenir.websages.com"
+  deploy_to: "/tmp/test-deployment"
+  deploy_config_to: "/tmp/test-config"
+  repository: "git@git.ogtastic.com:whiskey_disk.git"
+  config_repository: "git@git.ogtastic.com:ogc-config.git"
+  config_target: "local"

data/lib/whiskey_disk.rb

@@ -230,7 +230,7 @@ class WhiskeyDisk
     def refresh_configuration
       needs(:deploy_to, :deploy_config_to)
       raise "Must specify project name when using a configuration repository." unless project_name_specified?
-      enqueue("rsync -av --progress #{self[:deploy_config_to]}/#{self[:project]}/#{self[:environment]}/ #{self[:deploy_to]}/")
+      enqueue("rsync -av --progress #{self[:deploy_config_to]}/#{self[:project]}/#{self[:config_target]}/ #{self[:deploy_to]}/")
     end
     
     def run_post_setup_hooks

data/lib/whiskey_disk/config.rb

@@ -143,11 +143,16 @@ class WhiskeyDisk
       end
 
       def filter_data(data)
-        raise "No configuration file defined data for environment [#{environment_name}]" unless data[project_name][environment_name]
-        data[project_name][environment_name].merge({
+        current = data[project_name][environment_name]
+        raise "No configuration file defined data for environment [#{environment_name}]" unless current
+
+        current.merge!({
           'environment' => environment_name,
-          'project' => project_name
+          'project' => project_name,
         })
+        
+        current['config_target'] ||= environment_name
+        current
       end
 
       def fetch

data/spec/whiskey_disk/config_spec.rb

@@ -159,6 +159,18 @@ describe WhiskeyDisk::Config do
       write_config_file('production' => { 'repository' => 'b'}, 'staging' => staging)
       WhiskeyDisk::Config.fetch['project'].should == 'diskey_whisk'
     end
+    
+    it 'should include the environment name as the config_target setting when no config_target is specified' do
+      staging = { 'foo' => 'bar', 'repository' => 'xyzzy', 'project' => 'diskey_whisk' }
+      write_config_file('production' => { 'repository' => 'b'}, 'staging' => staging)
+      WhiskeyDisk::Config.fetch['config_target'].should == 'staging'
+    end
+    
+    it 'should include the config_target setting when a config_target is specified' do
+      staging = { 'foo' => 'bar', 'repository' => 'xyzzy', 'project' => 'diskey_whisk', 'config_target' => 'testing' }
+      write_config_file('production' => { 'repository' => 'b'}, 'staging' => staging)
+      WhiskeyDisk::Config.fetch['config_target'].should == 'testing'
+    end
   end
 
   describe 'returning configuration data from a configuration file' do

data/spec/whiskey_disk_spec.rb

@@ -305,6 +305,7 @@ describe 'WhiskeyDisk' do
                       'environment' => 'production',
                       'config_repository' => 'git@git://foo.bar.git',
                       'config_branch' => 'master',
+                      'config_target' => 'staging',
                       'project' => 'whiskey_disk' }
       WhiskeyDisk.configuration = @parameters
     end
@@ -313,23 +314,23 @@ describe 'WhiskeyDisk' do
       WhiskeyDisk.configuration = @parameters.merge('deploy_to' => nil)
       lambda { WhiskeyDisk.refresh_configuration }.should.raise
     end
-    
+  
     it 'should fail if the configuration deployment path is not specified' do
       WhiskeyDisk.configuration = @parameters.merge('deploy_config_to' => nil)
       lambda { WhiskeyDisk.refresh_configuration }.should.raise
     end
-    
+  
     it 'should fail if no project name was specified' do
       WhiskeyDisk.configuration = @parameters.merge('project' => 'unnamed_project')
       lambda { WhiskeyDisk.refresh_configuration }.should.raise      
     end
-    
-    it 'should use rsync to overlay the configuration checkout for the project in the configured environment onto the main checkout' do
+  
+    it 'should use rsync to overlay the configuration checkout for the project in the config target onto the main checkout' do
       WhiskeyDisk.refresh_configuration
-      WhiskeyDisk.buffer.last.should.match(%r{rsync.* /path/to/config/repo/whiskey_disk/production/ /path/to/main/repo/})
+      WhiskeyDisk.buffer.last.should.match(%r{rsync.* /path/to/config/repo/whiskey_disk/staging/ /path/to/main/repo/})
     end
   end
-  
+
   describe 'running post setup hooks' do
     before do
       WhiskeyDisk.configuration = { 'deploy_to' => '/path/to/main/repo' }

data/whiskey_disk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whiskey_disk}
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rick Bradley"]
-  s.date = %q{2010-12-23}
+  s.date = %q{2011-01-13}
   s.description = %q{Opinionated gem for doing fast git-based server deployments.}
   s.email = %q{rick@rickbradley.com}
   s.executables = ["wd_role", "wd"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "WHY.txt",
     "bin/wd",
     "bin/wd_role",
+    "examples/deploy-configs.yml",
     "examples/deploy-local.yml",
     "examples/deploy-multiple-remotes.yml",
     "examples/deploy-staging.yml",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whiskey_disk
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Rick Bradley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-23 00:00:00 -05:00
+date: 2011-01-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - WHY.txt
 - bin/wd
 - bin/wd_role
+- examples/deploy-configs.yml
 - examples/deploy-local.yml
 - examples/deploy-multiple-remotes.yml
 - examples/deploy-staging.yml