dusty-basic_deploy 0.0.1

data/README.txt

@@ -0,0 +1,48 @@
+# Dusty's basic capistrano deploy script
+
+## Installation
+
+    # gem sources -a http://gems.github.com/
+    # gem install dusty-sinatra_deploy
+
+## Usage
+
+Open your application's `Capfile` and make it look like this, the last three lines are the magic. also you can safely remove line two if you won't be loading additional plugin files. (this is a railsism):
+
+    load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+    # Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+
+    require 'rubygems'
+    require 'railsless-deploy'
+    load    'config/deploy'
+
+You should then be able to proceed as you would usually, you may want to familiarise yourself with the truncated list of tasks, you can get a full list with:
+
+    $ cap -T
+
+## What's in the box?
+
+If you want to try before you buy, here's the list of tasks included with this version of the deploy recipe:
+
+    cap deploy               # Deploys your project.
+    cap deploy:check         # Test deployment dependencies.
+    cap deploy:cleanup       # Clean up old releases.
+    cap deploy:cold          # Deploys and starts a `cold' application.
+    cap deploy:pending       # Displays the commits since your last deploy.
+    cap deploy:pending:diff  # Displays the `diff' since your last deploy.
+    cap deploy:rollback      # Rolls back to a previous version and restarts.
+    cap deploy:rollback:code # Rolls back to the previously deployed version.
+    cap deploy:setup         # Prepares one or more servers for deployment.
+    cap deploy:symlink       # Updates the symlink to the most recently deployed ...
+    cap deploy:update        # Copies your project and updates the symlink.
+    cap deploy:update_code   # Copies your project to the remote servers.
+    cap deploy:upload        # Copy files to the currently deployed version.
+    cap invoke               # Invoke a single command on the remote servers.
+    cap shell                # Begin an interactive Capistrano session.
+
+
+## Bugs & Feedback
+
+Via my Github profile please:
+
+    http://github.com/leehambley

data/lib/basic_deploy.rb

@@ -0,0 +1,274 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  require 'capistrano/recipes/deploy/scm'
+  require 'capistrano/recipes/deploy/strategy'
+
+  def _cset(name, *args, &block)
+    unless exists?(name)
+      set(name, *args, &block)
+    end
+  end
+
+  # =========================================================================
+  # These variables MUST be set in the client capfiles. If they are not set,
+  # the deploy will fail with an error.
+  # =========================================================================
+
+  _cset(:application) { abort "Please specify the name of your application, set :application, 'foo'" }
+  _cset(:repository)  { abort "Please specify the repository that houses your application's code, set :repository, 'foo'" }
+
+  # =========================================================================
+  # These variables may be set in the client capfile if their default values
+  # are not sufficient.
+  # =========================================================================
+
+  _cset :scm, :subversion
+  _cset :deploy_via, :checkout
+
+  _cset(:deploy_to) { "/var/www/apps/#{application}" }
+  _cset(:revision)  { source.head }
+
+  # =========================================================================
+  # These variables should NOT be changed unless you are very confident in
+  # what you are doing. Make sure you understand all the implications of your
+  # changes if you do decide to muck with these!
+  # =========================================================================
+
+  _cset(:source)            { Capistrano::Deploy::SCM.new(scm, self) }
+  _cset(:real_revision)     { source.local.query_revision(revision) { |cmd| with_env("LC_ALL", "C") { run_locally(cmd) } } }
+
+  _cset(:strategy)          { Capistrano::Deploy::Strategy.new(deploy_via, self) }
+
+  _cset(:release_name)      { set :deploy_timestamped, true; Time.now.utc.strftime("%Y%m%d%H%M%S") }
+
+  _cset :version_dir,       "releases"
+  _cset :shared_dir,        "shared"
+  _cset :shared_children,   %w(log tmp gems)
+  _cset :current_dir,       "current"
+
+  _cset(:releases_path)     { File.join(deploy_to, version_dir) }
+  _cset(:shared_path)       { File.join(deploy_to, shared_dir) }
+  _cset(:current_path)      { File.join(deploy_to, current_dir) }
+  _cset(:release_path)      { File.join(releases_path, release_name) }
+
+  _cset(:releases)          { capture("ls -xt #{releases_path}").split.reverse }
+  _cset(:current_release)   { File.join(releases_path, releases.last) }
+  _cset(:previous_release)  { releases.length > 1 ? File.join(releases_path, releases[-2]) : nil }
+
+  _cset(:current_revision)  { capture("cat #{current_path}/REVISION").chomp }
+  _cset(:latest_revision)   { capture("cat #{current_release}/REVISION").chomp }
+  _cset(:previous_revision) { capture("cat #{previous_release}/REVISION").chomp }
+
+  _cset(:run_method)        { fetch(:use_sudo, true) ? :sudo : :run }
+
+  # some tasks, like symlink, need to always point at the latest release, but
+  # they can also (occassionally) be called standalone. In the standalone case,
+  # the timestamped release_path will be inaccurate, since the directory won't
+  # actually exist. This variable lets tasks like symlink work either in the
+  # standalone case, or during deployment.
+  _cset(:latest_release) { exists?(:deploy_timestamped) ? release_path : current_release }
+
+  # =========================================================================
+  # These are helper methods that will be available to your recipes.
+  # =========================================================================
+
+  # Temporarily sets an environment variable, yields to a block, and restores
+  # the value when it is done.
+  def with_env(name, value)
+    saved, ENV[name] = ENV[name], value
+    yield
+  ensure
+    ENV[name] = saved
+  end
+
+  # logs the command then executes it locally.
+  # returns the command output as a string
+  def run_locally(cmd)
+    logger.trace "executing locally: #{cmd.inspect}" if logger
+    `#{cmd}`
+  end
+
+  # If a command is given, this will try to execute the given command, as
+  # described below. Otherwise, it will return a string for use in embedding in
+  # another command, for executing that command as described below.
+  #
+  # If :run_method is :sudo (or :use_sudo is true), this executes the given command
+  # via +sudo+. Otherwise is uses +run+. If :as is given as a key, it will be
+  # passed as the user to sudo as, if using sudo. If the :as key is not given,
+  # it will default to whatever the value of the :admin_runner variable is,
+  # which (by default) is unset.
+  #
+  # THUS, if you want to try to run something via sudo, and what to use the
+  # root user, you'd just to try_sudo('something'). If you wanted to try_sudo as
+  # someone else, you'd just do try_sudo('something', :as => "bob"). If you
+  # always wanted sudo to run as a particular user, you could do 
+  # set(:admin_runner, "bob").
+  def try_sudo(*args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    command = args.shift
+    raise ArgumentError, "too many arguments" if args.any?
+
+    as = options.fetch(:as, fetch(:admin_runner, nil))
+    via = fetch(:run_method, :sudo)
+    if command
+      invoke_command(command, :via => via, :as => as)
+    elsif via == :sudo
+      sudo(:as => as)
+    else
+      ""
+    end
+  end
+
+  # Same as sudo, but tries sudo with :as set to the value of the :runner
+  # variable (which defaults to "app").
+  def try_runner(*args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    args << options.merge(:as => fetch(:runner, "app"))
+    try_sudo(*args)
+  end
+
+  # =========================================================================
+  # These are the tasks that are available to help with deploying web apps,
+  # and specifically, Rails applications. You can have cap give you a summary
+  # of them with `cap -T'.
+  # =========================================================================
+
+  namespace :deploy do
+    desc 'Deploy your project'
+    task :default do
+      update
+    end
+
+    desc 'Setup the project for deployment'
+    task :setup, :except => { :no_release => true } do
+      dirs = [deploy_to, releases_path, shared_path]
+      dirs += shared_children.map { |d| File.join(shared_path, d) }
+      run "#{try_sudo} mkdir -p #{dirs.join(' ')} && #{try_sudo} chmod g+w #{dirs.join(' ')}"
+    end
+
+    desc 'Update the code of your project and the symlinks'
+    task :update do
+      transaction do
+        update_code
+        symlink
+      end
+    end
+
+    desc 'Update the code of your project'
+    task :update_code, :except => { :no_release => true } do
+      on_rollback { run "rm -rf #{release_path}; true" }
+      strategy.deploy!
+      finalize_update
+    end
+
+    desc 'Update permissions and symlinks in project'
+    task :finalize_update, :except => { :no_release => true } do
+      run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
+      shared_children.each do |child|
+        run "ln -nfs #{shared_path}/#{child} #{latest_release}"
+      end
+    end
+
+    desc 'Updates the symlink of current to point to the newest release'
+    task :symlink, :except => { :no_release => true } do
+      on_rollback do
+        if previous_release
+          run "rm -f #{current_path}; ln -s #{previous_release} #{current_path}; true"
+        else
+          logger.important "no previous release to rollback to, rollback of symlink skipped"
+        end
+      end
+
+      run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
+    end
+
+    desc <<-DESC
+Copy files to the currently deployed version.
+ $ cap deploy:upload FILES=templates,controller.rb
+ $ cap deploy:upload FILES='config/apache/*.conf'
+    DESC
+    task :upload, :except => { :no_release => true } do
+      files = (ENV["FILES"] || "").split(",").map { |f| Dir[f.strip] }.flatten
+      abort "Please specify at least one file or directory to update (via the FILES environment variable)" if files.empty?
+      files.each { |file| top.upload(file, File.join(current_path, file)) }
+    end
+
+    namespace :rollback do
+      desc <<-DESC
+[internal] Points the current symlink at the previous revision.
+This is called by the rollback sequence, and should rarely (if ever) need to
+be called directly.
+      DESC
+      task :revision, :except => { :no_release => true } do
+        if previous_release
+          run "rm #{current_path}; ln -s #{previous_release} #{current_path}"
+        else
+          abort "could not rollback the code because there is no prior release"
+        end
+      end
+
+      desc <<-DESC
+[internal] Removes the most recently deployed release.
+This is called by the rollback sequence, and should rarely (if ever) need to
+be called directly.
+      DESC
+      task :cleanup, :except => { :no_release => true } do
+        run "if [ `readlink #{current_path}` != #{current_release} ]; then rm -rf #{current_release}; fi"
+      end
+
+      desc <<-DESC
+Rolls back to the previously deployed version. The `current' symlink will
+be updated to point at the previously deployed version, and then the
+current release will be removed from the servers.
+      DESC
+      task :code, :except => { :no_release => true } do
+        revision
+        cleanup
+      end
+
+      desc <<-DESC
+Rolls back to a previous version and restarts. This is handy if you ever
+discover that you've deployed a lemon; `cap rollback' and you're right
+back where you were, on the previously deployed version.
+      DESC
+      task :default do
+        revision
+        cleanup
+      end
+    end
+
+    desc <<-DESC
+Clean up old releases. By default, the last 5 releases are kept on each
+server (though you can change this with the keep_releases variable). All
+other deployed revisions are removed from the servers.
+    DESC
+    task :cleanup, :except => { :no_release => true } do
+      count = fetch(:keep_releases, 5).to_i
+      if count >= releases.length
+        logger.important "no old releases to clean up"
+      else
+        logger.info "keeping #{count} of #{releases.length} deployed releases"
+
+        directories = (releases - releases.last(count)).map { |release|
+          File.join(releases_path, release) }.join(" ")
+
+        try_sudo "rm -rf #{directories}"
+      end
+    end
+
+    namespace :pending do
+      desc 'Displays the diff since your last deploy'
+      task :diff, :except => { :no_release => true } do
+        system(source.local.diff(current_revision))
+      end
+
+      desc 'Displays the commits since your last deploy'
+      task :default, :except => { :no_release => true } do
+        from = source.next_revision(current_revision)
+        system(source.local.log(from))
+      end
+    end
+
+  end
+
+end # Capistrano::Configuration.instance(:must_exist).load do

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: dusty-basic_deploy
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dusty Doris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: github@dusty.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.txt
+- lib/basic_deploy.rb
+has_rdoc: false
+homepage: http://code.dusty.name
+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: none
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Basic deploy script for capistrano
+test_files: []
+