whiskey_disk 0.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+whiskey_disk.gemspec
+pkg/

data/README

@@ -0,0 +1,51 @@
+Whiskey Disk -- embarrassingly fast deployments.
+
+The idea here is inspired by github's cleaned up deployment scripts, and mislav's git-deploy project.  Only, we gave up on capistrano a long time ago, and after a few years of doing deployments on a few dozen projects, we realized that we really have very little variation on how we do things.  That is, we can afford to have a very opinionated tool to do our deployments.
+
+Here are the features/constraints we're envisioning:
+
+ - We need some sort of very basic "run this on a remote server" functionality.  We've been using vlad for years now and this would suffice:  it does what we're looking for and is much much smaller than capistrano.  If we don't load the included recipes it's basically a fancy ruby ssh wrapper.
+ 
+ - Setup should mostly just do a very fast remote git checkout in the right place.  Deployment should very quickly update that checkout.
+ 
+ - We have been considering a move towards tracking configuration data across our projects as a separate concern.  So, if we can have a private repo that stores per-project and per-environment (here I mean staging vs. production, etc.) configuration files, and have our deployments overlay those files quickly, that would be ideal.  I'm talking about hoptoad configs, database.yml files, AWS cert files, GeoKit API keys, etc., etc., etc.
+
+ - We should be able to use the same "setup == clone" + "deploy == reset" technique to manage the per-project/per-environment config files.
+ 
+ - Using rsync on the remote to those overlay config files on the deployed project would be a fast way to get them in place.
+ 
+ - Get rid of a bunch of annoying symlinks and symlink-hoops-to-jump-through.
+ 
+ - Get rid of a bunch of space (yeah yeah disk is cheap, but copying isn't) on the disk devoted to umpteen "releases".
+ 
+ - Obviously reduce deployment time by doing less, ssh-ing less, and taking less time to do whatever.
+ 
+ - should be rake based, and should provide a bare minimum of tasks -- like deploy:setup, deploy:now, and maybe a deploy:refresh_config_files.
+ 
+ - While a very basic task or few would run after setup or after deployment (e.g., rake db:migrate if migrations were changed, or touch tmp/restart.txt if the web server needs a restart; see git-deploy for more examples), we should be able to declare optional rake tasks (e.g., "deploy:staging:post_deploy") and have them run on this project if they are declared.
+ 
+ - Should work with projects that aren't remotely ruby.
+ 
+ - Should be loadable as a gem, meaning that it doesn't need to live in your project's space.  (see also non-ruby projects)
+ 
+ - Should be able to use a non-ruby config, preferably yaml, for information for all environments.  That could be stored in <project>/config/deploy.yml and saved with the project.  Even if this is just shoved into vlad 'set' commands, it's still an improvement:  we don't need ruby in the config file because we're opinionated.
+ 
+ - should be able to override settings for an environment locally by declaring a <project>/config/deploy-<environment>.yml.  Ideal for testing out deployments to different servers (or deploying locally).  This also makes it possible to .gitignore your local settings, so everyone can have their config repos in different places.
+ 
+ - should make it easier to do local development (e.g., on a laptop) by being able to overlay config files using the same rake tasks as used for remote deployments, just not running the functionality remotely.
+ 
+ - dropping in a project Rakefile can add post-deploy / post-setup hooks transparently.
+ 
+ - actually have meaningful error messages, unlike anything that ever seems to happen with cap or vlad.  :-/
+
+ - build this spec-first (whenever possible) so that there's a useful test suite.
+ 
+ - M$ windows hasn't been a priority for me for over a decade, not starting now.
+
+---
+
+Resources:
+  - http://github.com/blog/470-deployment-script-spring-cleaning
+  - http://github.com/mislav/git-deploy
+  - http://toroid.org/ams/git-website-howto
+  

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rake/testtask'
+
+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
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "whiskey_disk"
+    gemspec.summary = "embarrassingly fast deployments."
+    gemspec.description = "Opinionated gem for doing fast git-based server deployments."
+    gemspec.email = "rick@rickbradley.com"
+    gemspec.homepage = "http://github.com/flogic/whiskey_disk"
+    gemspec.authors = ["Rick Bradley"]
+    gemspec.add_dependency('vlad', '>= 1.3.2')
+  end
+  Jeweler::GemcutterTasks.new  
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+

data/TODO.txt

@@ -0,0 +1,3 @@
+ - update the README
+ - push gem to gemcutter
+ - install hooks (look at maybe git-deploy for good examples)

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/deploy-staging.yml

@@ -0,0 +1,6 @@
+staging:
+  domain: "user@www.example.com"
+  deploy_to: "/var/www/suparsite.com/"
+  repository: "git://github.com/clarkkent/suparsite.git"
+  config_repository: "git@github.com:clarkkent/suparconfig.git"
+  deploy_config_to: "/var/cache/git/suparconfig"

data/examples/deploy.rake

@@ -0,0 +1,11 @@
+namespace :deploy do
+  namespace :staging do
+    task :post_setup do
+      puts "This is my local post_setup hook."
+    end
+
+    task :post_deploy do
+      puts "This is my local post_deploy hook."
+    end
+  end
+end

data/examples/deploy.yml

@@ -0,0 +1,12 @@
+staging:
+  domain: "user@www.example.com"
+  deploy_to: "/var/www/suparsite.com/"
+  repository: "git://github.com/clarkkent/suparsite.git"
+  config_repository: "git@github.com:clarkkent/suparconfig.git"
+  deploy_config_to: "/var/cache/git/suparconfig"
+  branch: "production"
+local:
+  repository: "git://github.com/clarkkent/suparsite.git"
+  config_repository: "git@github.com:clarkkent/suparconfig.git"
+  deploy_to: "/Users/clark/git/suparsite"
+  deploy_config_to: "/Users/clark/git/suparconfig"

data/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'whiskey_disk'))

data/install.rb

@@ -0,0 +1,5 @@
+def readme_contents
+  IO.read(File.expand_path(File.join(File.dirname(__FILE__), 'README')))
+end
+
+puts readme_contents

data/lib/tasks/deploy.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'whiskey_disk'))
+require 'rake'
+require 'vlad'
+
+namespace :deploy do
+  desc "Perform initial setup for deployment"
+  task :setup do
+    WhiskeyDisk.ensure_main_parent_path_is_present        if WhiskeyDisk.remote?
+    WhiskeyDisk.ensure_config_parent_path_is_present     
+    WhiskeyDisk.checkout_main_repository                  if WhiskeyDisk.remote?
+    WhiskeyDisk.install_hooks                             if WhiskeyDisk.remote?
+    WhiskeyDisk.checkout_configuration_repository
+    WhiskeyDisk.refresh_configuration
+    WhiskeyDisk.run_post_setup_hooks
+    WhiskeyDisk.flush
+  end
+  
+  desc "Deploy now."
+  task :now do
+    WhiskeyDisk.update_main_repository_checkout           if WhiskeyDisk.remote?
+    WhiskeyDisk.update_configuration_repository_checkout
+    WhiskeyDisk.refresh_configuration
+    WhiskeyDisk.run_post_deploy_hooks
+    WhiskeyDisk.flush
+  end
+  
+  task :post_setup do
+    env = WhiskeyDisk[:environment]
+    Rake::Task["deploy:#{env}:post_setup"].invoke if Rake::Task.task_defined? "deploy:#{env}:post_setup"      
+  end
+
+  task :post_deploy do
+    env = WhiskeyDisk[:environment]
+    Rake::Task["deploy:#{env}:post_deploy"].invoke if Rake::Task.task_defined? "deploy:#{env}:post_deploy"      
+  end
+end

data/lib/whiskey_disk/config.rb

@@ -0,0 +1,77 @@
+require 'yaml'
+
+class WhiskeyDisk
+  class Config
+    class << self
+      def environment_name
+        (ENV['to'] && ENV['to'] != '') ? ENV['to'] : false
+      end
+      
+      def contains_rakefile?(path)
+        File.exists?(File.expand_path(File.join(path, 'Rakefile')))
+      end
+      
+      def base_path
+        while (!contains_rakefile?(Dir.pwd))
+          raise "Could not find Rakefile in the current directory tree!" if Dir.pwd == '/'
+          Dir.chdir('..')
+        end
+        Dir.pwd
+      end
+      
+      def main_configuration_file
+        File.expand_path(File.join(base_path, 'config', 'deploy.yml'))
+      end
+      
+      def main_configuration_data
+        raise "Main configuration file [#{main_configuration_file}] not found!" unless File.exists?(main_configuration_file)
+        File.read(main_configuration_file)
+      end
+      
+      def environment_configuration_file
+        raise "Cannot determine current environment -- try rake ... to=staging, for example." unless environment_name
+        File.expand_path(File.join(base_path, 'config', "deploy-#{environment_name}.yml"))
+      end
+      
+      def environment_configuration_data
+        File.exists?(environment_configuration_file) ? File.read(environment_configuration_file) : nil
+      rescue Exception => e
+        raise %Q{Could not read configuration file [#{environment_configuration_file}] for environment [#{environment_name}]: "#{e}"}
+      end
+      
+      def project_name(config)
+        return '' unless config['repository'] and config['repository'] != ''
+        config['repository'].sub(%r{^.*/}, '').sub(%r{\.git$}, '')
+      end
+      
+      def load_main_data
+        YAML.load(main_configuration_data)
+      rescue Exception => e
+        raise %Q{Error reading configuration file [#{main_configuration_file}]: "#{e}"}
+      end
+      
+      def load_environment_data        
+        begin
+          env = environment_configuration_data ? YAML.load(environment_configuration_data) : nil
+        rescue Exception => e
+          raise %Q{Error reading configuration file [#{environment_configuration_file}]: "#{e}"}
+        end
+        raise "Configuration file [#{environment_configuration_file}] does not define data for environment [#{environment_name}]" if env and !env[environment_name]
+        env || {}
+      end
+      
+      def fetch
+        raise "Cannot determine current environment -- try rake ... to=staging, for example." unless environment_name
+        main, env = load_main_data, load_environment_data
+        raise "No configuration file defined data for environment [#{environment_name}]" unless main[environment_name] or env[environment_name]
+        config = (main[environment_name] || {}).merge(env[environment_name] || {}).merge({'environment' => environment_name})
+        { 'project' => project_name(config) }.merge(config)
+      end
+    
+      def filenames
+        raise "Cannot determine current environment -- try rake ... to=staging, for example." unless environment_name
+        [ main_configuration_file, environment_configuration_file ]
+      end
+    end
+  end
+end

data/lib/whiskey_disk.rb

@@ -0,0 +1,122 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'tasks', 'deploy'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'whiskey_disk', 'config'))
+
+class WhiskeyDisk
+  class << self
+    def reset
+      @configuration = nil
+      @buffer = nil
+    end
+    
+    def buffer
+      @buffer ||= []
+    end
+    
+    def configuration
+      @configuration ||= WhiskeyDisk::Config.fetch
+    end
+    
+    def [](key)
+      configuration[key.to_s]
+    end
+    
+    def enqueue(command)
+      buffer << command
+    end
+    
+    def remote?
+      ! (self[:domain].nil? or self[:domain] == '')
+    end
+    
+    def parent_path(path)
+      File.split(path).first
+    end
+    
+    def tail_path(path)
+      File.split(path).last
+    end
+    
+    def register_configuration
+      configuration.each_pair {|k,v| set k, v }
+    end
+    
+    def needs(*keys)
+      keys.each do |key|
+        raise "No value for '#{key}' declared in configuration files [#{WhiskeyDisk::Config.filenames.join(", ")}]" unless self[key]
+      end
+    end
+    
+    def bundle
+      return '' if buffer.empty?
+      buffer.collect {|c| "(#{c})" }.join(' && ')
+    end
+    
+    def flush
+      if remote?
+        register_configuration
+        run(bundle)
+      else
+        system(bundle)
+      end
+    end
+    
+    def ensure_main_parent_path_is_present
+      needs(:deploy_to)
+      enqueue "mkdir -p #{parent_path(self[:deploy_to])}"
+    end
+    
+    def ensure_config_parent_path_is_present
+      needs(:deploy_config_to)
+      enqueue "mkdir -p #{parent_path(self[:deploy_config_to])}"
+    end
+    
+    def checkout_main_repository
+      needs(:deploy_to, :repository)
+      enqueue "cd #{parent_path(self[:deploy_to])}"
+      enqueue "git clone #{self[:repository]} #{tail_path(self[:deploy_to])} || true"
+    end
+    
+    def install_hooks
+      needs(:deploy_to)
+      # FIXME - TODO: MORE HERE
+    end
+
+    def checkout_configuration_repository
+      needs(:deploy_config_to, :config_repository)
+      enqueue "cd #{parent_path(self[:deploy_config_to])}"
+      enqueue "git clone #{self[:config_repository]} #{tail_path(self[:deploy_config_to])} || true"
+    end
+    
+    def update_main_repository_checkout
+      needs(:deploy_to)
+      branch = (self[:branch] and self[:branch] != '') ? self[:branch] : 'master'
+      enqueue "cd #{self[:deploy_to]}"
+      enqueue "git fetch origin +refs/heads/#{branch}:refs/remotes/origin/#{branch}"
+      enqueue "git reset --hard origin/#{branch}"
+    end
+    
+    def update_configuration_repository_checkout
+      needs(:deploy_config_to)
+      enqueue "cd #{self[:deploy_config_to]}"
+      enqueue "git fetch origin +refs/heads/master:refs/remotes/origin/master"
+      enqueue "git reset --hard origin/master"
+    end
+    
+    def refresh_configuration
+      needs(:deploy_to, :deploy_config_to)
+      enqueue "rsync -av --progress #{self[:deploy_config_to]}/#{self[:project]}/#{self[:environment]}/ #{self[:deploy_to]}/"
+    end
+    
+    def run_post_setup_hooks
+      needs(:deploy_to)
+      enqueue "cd #{self[:deploy_to]}"
+      enqueue "rake deploy:post_setup"
+    end
+
+    def run_post_deploy_hooks
+      needs(:deploy_to)
+      enqueue "cd #{self[:deploy_to]}"
+      enqueue "rake deploy:post_deploy"
+    end
+  end
+end

data/spec/init_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper.rb'))
+require 'rake'
+
+describe 'when the init.rb plugin loader has been included' do
+  it 'should load the main library' do
+    require(File.expand_path(File.join(File.dirname(__FILE__), '..', 'init')))
+    $".should.include(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'whiskey_disk.rb')))
+  end
+end

data/spec/install_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+def do_install
+  eval File.read(File.join(File.dirname(__FILE__), *%w[.. install.rb ]))
+end
+
+describe 'the plugin install.rb script' do
+  before do
+    self.stub!(:puts).and_return(true)
+  end
+  
+  it 'displays the content of the plugin README file' do
+    self.stub!(:readme_contents).and_return('README CONTENTS')
+    self.should.receive(:puts).with('README CONTENTS')
+    do_install
+  end
+  
+  describe 'readme_contents' do
+    it 'should work without arguments' do
+      do_install
+      lambda { readme_contents }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should accept no arguments' do
+      do_install
+      lambda { readme_contents(:foo) }.should.raise(ArgumentError)
+    end
+    
+    it 'should read the plugin README file' do
+      do_install
+      File.stub!(:join).and_return('/path/to/README')
+      IO.should.receive(:read).with('/path/to/README')
+      readme_contents
+    end
+    
+    it 'should return the contents of the plugin README file' do
+      do_install
+      File.stub!(:join).and_return('/path/to/README')
+      IO.stub!(:read).with('/path/to/README').and_return('README CONTENTS')
+      readme_contents.should == 'README CONTENTS'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bacon'
+require 'facon'
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))