capistrano-offroad 0.0.1

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2010, Maciej Pasternacki <maciej@pasternacki.net>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the copyright holder nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL MACIEJ PASTERNACKI BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/capistrano-offroad.rb

@@ -0,0 +1,7 @@
+require 'capistrano-offroad/reset'
+require 'capistrano-offroad/utils'
+
+# just for consistency
+def offroad_modules(*modules)
+  modules.each { |mod| require "capistrano-offroad/modules/#{mod}" }
+end

data/lib/capistrano-offroad/modules/daemontools.rb

@@ -0,0 +1,75 @@
+# Running via demontools
+require 'capistrano'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :svscan_root, "/service"
+  set :supervise_name, "#{application}"
+
+  def svc(cmd)
+    sudo "svc #{cmd} #{svscan_root}/#{supervise_name}"
+  end
+
+  namespace :daemontools do
+    desc "Create symlink in svscan directory"
+    task :create_symlink do
+      sudo "ln -s -v #{current_path} #{svscan_root}/#{supervise_name}"
+    end
+
+    desc "[internal] Remove symlink from svscan directory"
+    task :remove_symlink do
+      sudo "rm -v #{svscan_root}/#{supervise_name}"
+    end
+
+    desc "Remove symlink from svscan directory and stop supervise"
+    task :remove do
+      remove_symlink
+      sudo "svc -x -t #{current_path}"
+    end
+
+    desc "Supervise status of current release"
+    task :status do
+      sudo "svstat #{svscan_root}/#{supervise_name}"
+    end
+
+    desc "Supervise status of all releases"
+    task :relstatus do
+      sudo "svstat #{releases_path}/*"
+    end
+  end
+
+  namespace :deploy do
+    desc "Start service (svc -u)"
+    task :start do
+      svc "-u"
+    end
+
+    desc "Stop service (svc -d)"
+    task :stop do
+      svc "-d"
+    end
+
+    desc "Restart service (svc -t)"
+    task :restart do
+      svc "-t"
+    end
+
+    desc <<-DESC
+  [internal] Symlink latest release to current, taking daemontools into accont.
+
+  WARNING: rollback is broken!
+  DESC
+    task :symlink do
+      on_rollback { run "rm -f #{current_path}; ln -s #{previous_release} #{current_path}; true" } # FIXME!
+      run "rm -f #{current_path}"
+      sleep 5
+      sudo "svc -t -x #{previous_release}"
+      run "ln -s #{latest_release} #{current_path}"
+    end
+  end
+
+  before "deploy:cleanup" do
+    # needed, by default I don't use sudo, but we need one to remove
+    # supervise/ directories.
+    set :run_method, :sudo
+  end
+end

data/lib/capistrano-offroad/modules/defaults.rb

@@ -0,0 +1,9 @@
+# My defaults for deployment, may or may nat be useful for anyone else.
+require 'capistrano'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :scm, :git
+  set :ssh_options, { :forward_agent => true }
+  set :use_sudo, false
+  set :deploy_to, "/srv/#{application}"
+end

data/lib/capistrano-offroad/modules/django.rb

@@ -0,0 +1,51 @@
+# Django deployment
+
+require 'capistrano'
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  set :python, "python"
+
+  set :django_project_subdirectory, "project"
+  set :django_use_south, false
+
+  depend :remote, :command, "#{python}"
+
+  def django_manage(cmd, options={})
+    path = options.delete(:path) || "#{latest_release}"
+    run "cd #{path}/#{django_project_subdirectory}; #{python} manage.py #{cmd}", options
+  end
+
+  namespace :django do
+    desc <<EOF
+Run custom Django management command in latest release.
+
+Pass the management command and arguments in COMMAND="..." variable.
+If COMMAND variable is not provided, Capistrano will ask for a command.
+EOF
+    task :manage do
+      set_from_env_or_ask :command, "Enter management command"
+      django_manage "#{command}"
+    end
+  end
+
+  namespace :deploy do
+    desc "Run manage.py syncdb in latest release."
+    task :migrate, :roles => :db, :only => { :primary => true } do
+      # FIXME: path, see default railsy deploy:migrate
+      django_manage "syncdb --noinput"
+      django_manage "migrate" if fetch(:django_use_south, false)
+    end
+  end
+
+  # depend :remote, :python_module, "module_name"
+  # runs #{python} and tries to import module_name.
+  class Capistrano::Deploy::RemoteDependency
+    def python_module(module_name, options={})
+      @message ||= "Cannot import `#{module_name}'"
+      python = configuration.fetch(:python, "python")
+      try("#{python} -c 'import #{module_name}'", options)
+      self
+    end
+  end
+end

data/lib/capistrano-offroad/modules/monit.rb

@@ -0,0 +1,51 @@
+require 'capistrano'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :monit_group, nil
+  set :monit_command, "monit"
+
+  def _monit_args()
+    if fetch :monit_group, nil then
+      return " -g #{monit_group} "
+    else
+      return ""
+    end
+  end
+
+  namespace :deploy do
+    desc "Start processes"
+    task :start do
+      process = ENV['PROCESS'] || 'all'
+      sudo "#{monit_command} #{_monit_args} start #{process}"
+    end
+
+    desc "Stop processes"
+    task :stop do
+      process = ENV['PROCESS'] || 'all'
+      sudo "#{monit_command} #{_monit_args} stop #{process}"
+    end
+
+    desc "Restart processes"
+    task :restart do
+      process = ENV['PROCESS'] || 'all'
+      sudo "#{monit_command} #{_monit_args} restart #{process}"
+    end
+
+    namespace :status do
+      desc "Status summary"
+      task :default do
+        sudo "#{monit_command} #{_monit_args} summary"
+      end
+
+      desc "Full status"
+      task :full do
+        sudo "#{monit_command} #{_monit_args} status"
+      end
+    end
+
+    desc "Reload monit"
+    task :reload_monit do
+      sudo "#{monit_command} reload"
+    end
+  end
+end

data/lib/capistrano-offroad/modules/supervisord.rb

@@ -0,0 +1,94 @@
+require 'capistrano'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :supervisord_path, ""
+  set :supervisord_command, "supervisord"
+  set :supervisorctl_command, "supervisorctl"
+  set :supervisord_conf, "supervisord_conf"
+  set :supervisord_pidfile, "supervisord.pid"
+  set :supervisord_start_group, nil
+  set :supervisord_stop_group, nil
+
+  namespace :deploy do
+    def supervisord_pidfile_path ; "#{shared_path}/#{supervisord_pidfile}" end
+    def supervisord_pid ; "`cat #{supervisord_pidfile_path}`" end
+
+    # Run supervisorctl command `cmd'.
+    # If options[:try_start] is true (default) and supervisord is not running, start it.
+    # If just started supervisord, and options[:run_when_started] is false (default), skip running supervisorctl
+    def supervisorctl(cmd, options={})
+      try_start = options.delete(:try_start) {|k| true}
+
+      full_command = "#{supervisord_path}#{supervisorctl_command} -c #{current_path}/#{supervisord_conf} #{cmd}"
+      after_start = (full_command if options.delete(:run_when_started)) || ""
+
+      if not try_start then
+        run full_command, options
+      else
+        run <<-EOF, options
+        if test -f #{shared_path}/#{supervisord_pidfile}
+             && ps #{supervisord_pid} > /dev/null ;
+        then
+          echo "supervisord seems to be up, good" ;
+          #{full_command} ;
+        else
+          echo "starting supervisord" ;
+          #{sudo :as => deploy_user} #{supervisord_path}#{supervisord_command} -c #{current_path}/#{supervisord_conf} ;
+          #{after_start}
+        fi
+    EOF
+      end
+    end
+
+    def _target(var)
+      group_name = ENV['GROUP']
+      group_name ||= fetch var
+      prog_name = ENV['PROGRAM']
+      prog_name ||= 'all'
+
+      if ['', nil].include? group_name then
+        prog_name
+      else
+        "'#{group_name}:*'"
+      end
+    end
+
+    desc "Start processes"
+    task :start do
+      to_start = _target(:supervisord_start_group)
+      supervisorctl "start #{to_start}", :try_start => true
+    end
+
+    desc "Stop processes"
+    task :stop do
+      to_stop = _target(:supervisord_stop_group)
+      supervisorctl "stop #{to_stop}", :try_start => false
+    end
+
+    desc "Restart processes"
+    task :restart do
+      to_restart = _target(:supervisord_start_group)
+      supervisorctl "restart #{to_restart}"
+    end
+
+    desc "Display status of processes"
+    task :status do
+      supervisorctl "status", :try_start => false
+    end
+
+    desc "Display detailed list of processes"
+    task :processes do
+      run "test -f #{supervisord_pidfile_path} && pstree -a #{supervisord_pid}"
+    end
+
+    desc "Reload supervisor daemon"
+    task :reload_supervisord do
+      supervisorctl "reload"
+    end
+
+    task :run_supervisorctl do
+      set_from_env_or_ask :command, "supervisorctl command: "
+      supervisorctl "#{command}", :try_start => false
+    end
+  end
+end

data/lib/capistrano-offroad/reset.rb

@@ -0,0 +1,20 @@
+# Reset Rails-specific stuff.
+
+require 'capistrano'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :shared_children, %w()
+
+  namespace :deploy do
+    task :finalize_update, :except => { :no_release => true } do
+      if fetch(:group_writable, true)
+        sudo "chgrp -R #{deploy_group} #{latest_release}"
+        run "chmod -R g+w #{latest_release}"
+      end
+    end
+    task :migrate do end
+    task :start do end
+    task :stop do end
+    task :restart do end
+  end
+end

data/lib/capistrano-offroad/utils.rb

@@ -0,0 +1,24 @@
+# Small extensions to Capistrano
+
+require 'capistrano'
+
+# depend :remote, :run, "whole command with args"
+# runs command, if return code <> 0, dependency fails.
+class Capistrano::Deploy::RemoteDependency
+  def run(command, options={})
+    @message ||= "Cannot run `#{command}'"
+    try(command, options)
+    self
+  end
+end
+
+# set_from_env_or_ask :variable, "Please enter variable name: "
+# If there is VARIABLE in enviroment, set :variable to it, otherwise
+# ask user for a value
+def set_from_env_or_ask(sym, question)
+  if ENV.has_key? sym.to_s.upcase then
+    set sym, ENV[sym.to_s.upcase]
+  else
+    set sym do Capistrano::CLI.ui.ask question end
+  end
+end

data/lib/capistrano-offroad/version.rb

@@ -0,0 +1,8 @@
+module CapistranoOffroad
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-offroad
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Maciej Pasternacki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Capistrano add-ons and recipes for non-rails projects
+email: maciej@pasternacki.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/capistrano-offroad/modules/daemontools.rb
+- lib/capistrano-offroad/modules/defaults.rb
+- lib/capistrano-offroad/modules/django.rb
+- lib/capistrano-offroad/modules/monit.rb
+- lib/capistrano-offroad/modules/supervisord.rb
+- lib/capistrano-offroad/reset.rb
+- lib/capistrano-offroad/utils.rb
+- lib/capistrano-offroad/version.rb
+- lib/capistrano-offroad.rb
+- README
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/mpasternacki/capistrano-offroad
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Capistrano add-ons and recipes for non-rails projects
+test_files: []
+