capistrano_s3 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Bill Kirtley <bill@virosity.com>
+
+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.

data/README

@@ -0,0 +1,31 @@
+= Introduction
+
+Capistrano-S3 is a capistrano deployment strategy that will:
+
+    * svn export locally
+    * make a tarball (named after the svn revision) of the release
+    * push the tarball to S3
+    * each server pulls that tarball from S3 
+
+This allows one to use an svn repository not exposed to the outside world, save time pushing out of a poky cable modem, and have new EC2 instances pull directly from S3 on startup.
+
+If the tarball is already in S3 (from a previous deployment, say to a staging instance) the checkout is skipped.
+
+= Installation
+  gem install capistrano_s3
+
+To use it, specify properties in <tt>config/deploy.rb</tt>:
+  set :deploy_via, :s3_bucket
+  set :deploy_s3_bucket, 'com.example.releases' # The name of the S3 bucket that should get releases
+  s3_config = YAML::load(ERB.new(IO.read("secret/s3.yml")).result) # Follow this pattern and don't ckin your secrets
+  # s3_config = { 'AWS_ACCOUNT_NUMBER' => '1234-5678-9012', 'AWS_ACCESS_KEY_ID' => 'ABCDEFGHIJKLMNOPQRST', 'AWS_SECRET_ACCESS_KEY' => 'abcdefghijklmnopqrstuvwxyz01234567890ABC' }
+  set :s3_config, s3_config
+
+Now regular capistrano deployment tasks will go through S3
+
+= About
+
+Rubyforge Project:: http://rubyforge.org/projects/capistrano-s3
+Author:: Bill Kirtley - bill at [nospam] virosity dt com
+License:: Distributed under MIT License
+Copyright:: 2008 Bill Kirtley, Virosity Inc.

data/lib/capistrano/recipes/deploy/strategy/s3_bucket.rb

@@ -0,0 +1,96 @@
+require 'capistrano/recipes/deploy/strategy/copy'
+require 'fileutils'
+require 'tempfile'  # Dir.tmpdir
+
+#implementing a capistrano deploy strategy that:
+# - Expects a deploy_bucket it can read from and write to
+# - Uses configuration[:s3_config] to find creds
+# - Names releases {application}_{revision}.tgz
+# - Looks in the bucket for a file with that name - skip to actual deployment if found
+# - Checks out the specified revision, bundles it up, and pushes to the S3 bucket
+# - depends on the s3cmd command, perhaps installed with `gem install s3sync`
+
+# Copyright 2008 Bill Kirtley, Virosity Inc.
+# Distributed via MIT license
+# Feedback appreciated: bill at [nospam] virosity dt com
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      class S3Bucket < Copy
+
+        def deploy!
+          logger.debug "getting (via #{copy_strategy}) revision #{revision} to #{destination}"
+          logger.debug "#{configuration[:release_path]} #{File.basename(configuration[:release_path])}"
+          put_package
+          
+          run "#{aws_environment} s3cmd get #{bucket_name}:#{package_name} #{remote_filename}"
+          run "mkdir #{configuration[:release_path]} && cd #{configuration[:release_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
+          logger.debug "done!"
+        end
+
+        #!! implement me!
+        # Performs a check on the remote hosts to determine whether everything
+        # is setup such that a deploy could succeed.
+        # def check!
+        # end
+
+    private
+        def aws_environment
+          @aws_environment ||= "AWS_ACCOUNT_NUMBER=#{configuration[:s3_config]['AWS_ACCOUNT_NUMBER']} AWS_ACCESS_KEY_ID=#{configuration[:s3_config]['AWS_ACCESS_KEY_ID']} AWS_SECRET_ACCESS_KEY=#{configuration[:s3_config]['AWS_SECRET_ACCESS_KEY']}"
+        end
+        # Responsible for ensuring that the package for the current revision is in the bucket
+        def put_package
+          set :release_name, revision
+          logger.debug "#{package_name} already in bucket #{bucket_name}" and return if bucket_includes_package
+          logger.debug "#{package_name} not found in bucket #{bucket_name} so ckout to add it"
+          
+          # Do the checkout locally
+          system(command)
+          File.open(File.join(destination, "REVISION"), "w") { |f| f.puts(revision) }
+
+          # Compress it
+          logger.trace "compressing in #{destination}"
+          logger.trace compress('*', package_path).join(" ")
+
+          Dir.chdir(destination) { system(compress('*', package_path).join(" ")) }
+
+          # Put to S3
+          logger.trace "pushing to S3 bucket #{bucket_name} key #{package_name}"
+          system("s3cmd put #{bucket_name}:#{package_name} #{package_path}")
+        end
+
+        def bucket_includes_package
+          /#{package_name}/.match(`s3cmd list #{bucket_name}:#{package_name}`)
+        end
+
+        def package_name
+          @package_name ||= "#{configuration[:application]}_#{revision}.tgz"
+        end
+        
+        def package_path
+          @package_path ||= File.join(tmpdir, package_name)
+        end
+        
+        def bucket_name
+          configuration[:deploy_s3_bucket]
+        end
+        
+        def bucket
+          @bucket ||= Bucket.find(bucket_name) or raise "Failed to find bucket #{configuration[:deploy_s3_bucket]}"
+        end
+
+        def initialize(config={})
+          super(config)
+          
+          raise "Failed to find :s3_config" unless configuration[:s3_config]
+          # Annoying that merge doesnt work because ENV isn't really a Hash:
+          # ENV.merge(configuration[:s3_config])
+          configuration[:s3_config].each_pair { |name, value| ENV[name] = value }
+        end
+
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,9 @@
+module Capistrano_S3 #:nodoc:
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/deploy_s3_bucket_test.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+require 'capistrano/logger'
+require 'capistrano/recipes/deploy/strategy/s3_bucket'
+require 'stringio'
+
+context "Capistrano::Deploy::Strategy::S3Bucket" do
+  def setup
+    logger = Capistrano::Logger.new(:output => StringIO.new)
+    # Uncomment this line to see the output a cap user would see for debugging
+    # logger = Capistrano::Logger.new
+    logger.level = Capistrano::Logger::MAX_LEVEL
+    @config = { :application => "testapp",
+                :logger => logger,
+                :releases_path => "/u/apps/test/releases",
+                :release_path => "/u/apps/test/releases/1234567890",
+                :real_revision => "154",
+                :deploy_s3_bucket => 'com.example.bucket',
+                :s3_config => {'AWS_ACCOUNT_NUMBER' => '1234-5678-9012', 
+                               'AWS_ACCESS_KEY_ID' => 'ABCDEFGHIJKLMNOPQRST', 
+                               'AWS_SECRET_ACCESS_KEY' => 'abcdefghijklmnopqrstuvwxyz01234567890ABC' }
+                 }
+    @source = mock("source")
+    @config.stubs(:source).returns(@source)
+    @config.stubs(:set)
+    @strategy = Capistrano::Deploy::Strategy::S3Bucket.new(@config)
+    Dir.stubs(:tmpdir).returns("/temp/dir")
+  end
+
+  specify "does not push to S3 if already there" do
+    @strategy.expects(:`).returns("--------------------\ncom.example.bucket:testapp_154.tgz")
+    prepare_deploy
+    @strategy.deploy!
+  end
+
+  specify "does push to S3 if not already there" do
+    @strategy.expects(:`).returns("--------------------\n")    
+    prepare_deploy
+    @source.expects(:checkout).with("154", "/temp/dir/1234567890").returns(:local_checkout)
+    @strategy.expects(:system).with(:local_checkout)
+    File.expects(:open).with('/temp/dir/1234567890/REVISION', 'w')
+    Dir.expects(:chdir).with("/temp/dir/1234567890").yields
+    @strategy.expects(:system).with('tar czf /temp/dir/testapp_154.tgz *')
+    @strategy.expects(:system).with('s3cmd put com.example.bucket:testapp_154.tgz /temp/dir/testapp_154.tgz')
+    @strategy.deploy!
+  end
+
+private
+
+  def aws_credential_envs
+    "AWS_ACCOUNT_NUMBER=1234-5678-9012 AWS_ACCESS_KEY_ID=ABCDEFGHIJKLMNOPQRST AWS_SECRET_ACCESS_KEY=abcdefghijklmnopqrstuvwxyz01234567890ABC"
+  end
+
+  # These are expected for any deploy
+  def prepare_deploy
+    @strategy.expects(:run).with("#{aws_credential_envs} s3cmd get com.example.bucket:testapp_154.tgz /tmp/1234567890.tar.gz")
+    @strategy.expects(:run).with("mkdir /u/apps/test/releases/1234567890 && cd /u/apps/test/releases/1234567890 && tar xzf /tmp/1234567890.tar.gz && rm /tmp/1234567890.tar.gz")
+  end
+
+end 
+ 
+  

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift 'lib/', File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+
+try = proc do |library, version|
+  begin
+    dashed = library.gsub('/','-')
+    require library
+    gem dashed, version
+  rescue LoadError
+    puts "=> You need the #{library} gem to run these tests.",
+         "=> $ sudo gem install #{dashed}"
+    exit
+  end
+end
+
+try['test/spec', '>= 0.3']
+try['mocha', '>= 0.4']

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano_s3
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Bill Kirtley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: s3sync
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A deployment strategy for capistrano using S3
+email: bill@virosity.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/capistrano
+- lib/capistrano/recipes
+- lib/capistrano/recipes/deploy
+- lib/capistrano/recipes/deploy/strategy
+- lib/capistrano/recipes/deploy/strategy/s3_bucket.rb
+- lib/version.rb
+- test/deploy_s3_bucket_test.rb
+- test/test_helper.rb
+- README
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://virosity.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: capistrano-s3
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A deployment strategy for capistrano using S3
+test_files: []
+