deprec-core 3.1.0 → 3.1.1

data/README.md

@@ -0,0 +1,7 @@
+deprec-core
+===========
+
+Extracted from the deprec-gem, deprec core is a task free set of tools
+to make publishing your own Capistrano/Rake task gems simpler.
+
+To be continued...

data/lib/deprec-core/capistrano_extensions.rb

@@ -0,0 +1,418 @@
+# Copyright 2006-2008 by Mike Bailey. All rights reserved.
+require 'capistrano'
+require 'fileutils'
+
+module Deprec2
+  
+  # Temporarily modify ROLES if HOSTS not set
+  # Capistrano's default behaviour is for HOSTS to override ROLES
+  def for_roles(roles)
+    old_roles = ENV['ROLES']
+    ENV['ROLES'] = roles.to_s unless ENV['HOSTS']
+    yield
+    ENV['ROLES'] = old_roles.to_s unless ENV['HOSTS']
+  end
+
+  
+  # Temporarily ignore ROLES and HOSTS
+  def ignoring_roles_and_hosts
+    old_roles = ENV['ROLES']
+    old_hosts = ENV['HOSTS']
+    ENV['ROLES'] = nil
+    ENV['HOSTS'] = nil
+    yield
+    ENV['ROLES'] = old_roles
+    ENV['HOSTS'] = old_hosts
+  end
+  
+  DEPREC_TEMPLATES_BASE = File.join(File.dirname(__FILE__), 'templates')
+
+  # Render template (usually a config file) 
+  # 
+  # Usually we render it to a file on the local filesystem.
+  # This way, we keep a copy of the config file under source control.
+  # We can make manual changes if required and push to new hosts.
+  #
+  # If the options hash contains :path then it's written to that path.
+  # If it contains :remote => true, the file will instead be written to remote targets
+  # If options[:path] and options[:remote] are missing, it just returns the rendered
+  # template as a string (good for debugging).
+  #
+  #  XXX I would like to get rid of :render_template_to_file
+  #  XXX Perhaps pass an option to this function to write to remote
+  #
+  def render_template(app, options={})
+    template = options[:template]
+    path = options[:path] || nil
+    remote = options[:remote] || false
+    mode = options[:mode] || 0755
+    owner = options[:owner] || nil
+    stage = exists?(:stage) ? fetch(:stage).to_s : ''
+    # replace this with a check for the file
+    if ! template
+      puts "render_template() requires a value for the template!"
+      return false 
+    end
+  
+    # If local copies of deprec templates exist they will be used 
+    # If you don't specify the location with the local_template_dir option
+    # it defaults to config/templates.
+    # e.g. config/templates/nginx/nginx.conf.erb
+    local_template = File.join(local_template_dir, app.to_s, template)
+    if File.exists?(local_template)
+      puts
+      puts "Using local template (#{local_template})"
+      template = ERB.new(IO.read(local_template), nil, '-')
+    else
+      template = ERB.new(IO.read(File.join(DEPREC_TEMPLATES_BASE, app.to_s, template)), nil, '-')
+    end
+    rendered_template = template.result(binding)
+  
+    if remote 
+      # render to remote machine
+      puts 'You need to specify a path to render the template to!' unless path
+      exit unless path
+      sudo "test -d #{File.dirname(path)} || #{sudo} mkdir -p #{File.dirname(path)}"
+      std.su_put rendered_template, path, '/tmp/', :mode => mode
+      sudo "chown #{owner} #{path}" if defined?(owner)
+    elsif path 
+      # render to local file
+      full_path = File.join('config', stage, app.to_s, path)
+      path_dir = File.dirname(File.expand_path(full_path))
+      if File.exists?(full_path)
+        if IO.read(full_path) == rendered_template
+          puts "[skip] Identical file exists (#{full_path})."
+          return false
+        elsif overwrite?(full_path, rendered_template)
+          File.delete(full_path)
+        else
+          puts "[skip] Not overwriting #{full_path}"
+          return false
+        end
+      end
+      FileUtils.mkdir_p "#{path_dir}" if ! File.directory?(path_dir)
+      # added line above to make windows compatible
+      # system "mkdir -p #{path_dir}" if ! File.directory?(path_dir) 
+      File.open(File.expand_path(full_path), 'w'){|f| f.write rendered_template }
+      puts "[done] #{full_path} written"
+    else
+      # render to string
+      return rendered_template
+    end
+  end
+  
+  def overwrite?(full_path, rendered_template)
+    if defined?(overwrite_all)      
+      if overwrite_all == true
+        return true
+      else
+        return false
+      end
+    end
+    
+    # XXX add :always and :never later - not sure how to set persistent value from here
+    # response = Capistrano::CLI.ui.ask "File exists. Overwrite? ([y]es, [n]o, [a]lways, n[e]ver)" do |q|
+    puts
+    response = Capistrano::CLI.ui.ask "File exists (#{full_path}). 
+    Overwrite? ([y]es, [n]o, [d]iff)" do |q|
+      q.default = 'n'
+    end
+    
+    case response
+    when 'y'
+      return true
+    when 'n'
+      return false
+    when 'd'
+      require 'tempfile'
+      tf = Tempfile.new("deprec_diff") 
+      tf.puts(rendered_template)
+      tf.close
+      puts
+      puts "Running diff -u current_file new_file_if_you_overwrite"
+      puts
+      system "diff -u #{full_path} #{tf.path} | less"
+      puts
+      overwrite?(full_path, rendered_template)
+    # XXX add :always and :never later - not sure how to set persistent value from here  
+    # when 'a'
+    #   set :overwrite_all, true
+    # when 'e'
+    #   set :overwrite_all, false
+    end
+    
+  end
+
+  def render_template_to_file(template_name, destination_file_name, templates_dir = DEPREC_TEMPLATES_BASE)
+    template_name += '.conf' if File.extname(template_name) == '' # XXX this to be removed
+
+    file = File.join(templates_dir, template_name)
+    buffer = render :template => File.read(file)
+
+    temporary_location = "/tmp/#{template_name}"
+    put buffer, temporary_location
+    sudo "cp #{temporary_location} #{destination_file_name}"
+    delete temporary_location
+  end
+  
+  # Copy configs to server(s). Note there is no :pull task. No changes should 
+  # be made to configs on the servers so why would you need to pull them back?
+  def push_configs(app, files)   
+    app = app.to_s
+    stage = exists?(:stage) ? fetch(:stage).to_s : ''
+    
+    files.each do |file|
+      full_local_path = File.join('config', stage, app, file[:path])
+      if File.exists?(full_local_path)
+        # If the file path is relative we will prepend a path to this projects
+        # own config directory for this service.
+        if file[:path][0,1] != '/'
+          full_remote_path = File.join(deploy_to, app, file[:path]) 
+        else
+          full_remote_path = file[:path]
+        end
+        sudo "test -d #{File.dirname(full_remote_path)} || #{sudo} mkdir -p #{File.dirname(full_remote_path)}"
+        std.su_put File.read(full_local_path), full_remote_path, '/tmp/', :mode=>file[:mode]
+        sudo "chown #{file[:owner]} #{full_remote_path}"
+      else
+        # Render directly to remote host.
+        render_template(app, file.merge(:remote => true))
+      end
+    end
+  end
+  
+  def teardown_connections
+    sessions.keys.each do |server|
+         sessions[server].close
+         sessions.delete(server)
+    end
+  end
+
+  def append_to_file_if_missing(filename, value, options={})
+    # XXX sort out single quotes in 'value' - they'l break command!
+    # XXX if options[:requires_sudo] and :use_sudo then use sudo
+    sudo <<-END
+    sh -c '
+    grep -F "#{value}" #{filename} > /dev/null 2>&1 || 
+    echo "#{value}" >> #{filename}
+    '
+    END
+  end
+
+  # create new user account on target system
+  def useradd(user, options={})
+    options[:shell] ||= '/bin/bash' # new accounts on ubuntu 6.06.1 have been getting /bin/sh
+    switches = ''
+    switches += " --shell=#{options[:shell]} " if options[:shell]
+    switches += ' --create-home ' unless options[:homedir] == false
+    switches += " --gid #{options[:group]} " unless options[:group].nil?
+    invoke_command "grep '^#{user}:' /etc/passwd || #{sudo} /usr/sbin/useradd #{switches} #{user}", 
+    :via => run_method
+  end
+
+  # create a new group on target system
+  def groupadd(group, options={})
+    via = options.delete(:via) || run_method
+    # XXX I don't like specifying the path to groupadd - need to sort out paths before long
+    invoke_command "grep '#{group}:' /etc/group || #{sudo} /usr/sbin/groupadd #{group}", :via => via
+  end
+
+  # add group to the list of groups this user belongs to
+  def add_user_to_group(user, group)
+    invoke_command "groups #{user} | grep ' #{group} ' || #{sudo} /usr/sbin/usermod -G #{group} -a #{user}",
+    :via => run_method
+  end
+
+  # create directory if it doesn't already exist
+  # set permissions and ownership
+  # XXX move mode, path and
+  def mkdir(path, options={})
+    via = options.delete(:via) || :run
+    # XXX need to make sudo commands wrap the whole command (sh -c ?)
+    # XXX removed the extra 'sudo' from after the '||' - need something else
+    invoke_command "test -d #{path} || #{sudo if via == :sudo} mkdir -p #{path}"
+    invoke_command "chmod #{sprintf("%3o",options[:mode]||0755)} #{path}", :via => via if options[:mode]
+    invoke_command "chown -R #{options[:owner]} #{path}", :via => via if options[:owner]
+    groupadd(options[:group], :via => via) if options[:group]
+    invoke_command "chgrp -R #{options[:group]} #{path}", :via => via if options[:group]
+  end
+  
+  def create_src_dir
+    mkdir(src_dir, :mode => 0775, :group => group_src, :via => :sudo)
+  end
+  
+  # download source pkg if we don't already have it
+  def download_src(src_pkg, src_dir=src_dir)
+    set_pkg_defaults(src_pkg)
+    create_src_dir
+    # check if file exists and if we have an MD5 hash or bytecount to compare 
+    # against if so, compare and decide if we need to download again
+    if defined?(src_pkg[:md5sum])
+      md5_clause = " && echo '#{src_pkg[:md5sum]}' | md5sum -c - "
+    end
+    case src_pkg[:download_method]
+      # when getting source with git
+      when :git
+        # ensure git is installed
+        apt.install( {:base => %w(git-core)}, :stable) #TODO fix this to test ubuntu version <hardy might need specific git version for full git submodules support
+        pkg_dir = File.join(src_dir, src_pkg[:dir])
+        run "if [ -d #{pkg_dir} ]; then cd #{pkg_dir} && #{sudo} git checkout master && #{sudo} git pull && #{sudo} git submodule init && #{sudo} git submodule update; else #{sudo} git clone #{src_pkg[:url]} #{pkg_dir} && cd #{pkg_dir} && #{sudo} git submodule init && #{sudo} git submodule update ; fi"
+      	# Checkout the revision wanted if defined
+      	if src_pkg[:version]
+      	  run "cd #{pkg_dir} && git branch | grep '#{src_pkg[:version]}$' && #{sudo} git branch -D '#{src_pkg[:version]}'; exit 0"
+      	  run "cd #{pkg_dir} && #{sudo} git checkout -b #{src_pkg[:version]} #{src_pkg[:version]}" 
+        end
+	
+      # when getting source with wget    
+      when :http
+        # ensure wget is installed
+        apt.install( {:base => %w(wget)}, :stable )
+        # XXX replace with invoke_command
+        run "cd #{src_dir} && test -f #{src_pkg[:filename]} #{md5_clause} || #{sudo} wget --quiet --timestamping #{src_pkg[:url]}"
+
+      when :deb
+        run "cd #{src_dir} && test -f #{src_pkg[:filename]} #{md5_clause} || #{sudo} wget --quiet --timestamping #{src_pkg[:url]}"
+
+      else
+        puts "DOWNLOAD SRC: Download method not recognised. src_pkg[:download_method]: #{src_pkg[:download_method]}"
+    end
+  end
+
+  # unpack src and make it writable by the group
+  def unpack_src(src_pkg, src_dir=src_dir)
+    set_pkg_defaults(src_pkg)
+    pkg_dir = File.join([src_dir, src_pkg[:dir]].compact)
+    case src_pkg[:download_method]
+      # when unpacking git sources - nothing to do
+      when :deb
+        puts "UNPACK SRC: nothing to do for deb installs"
+      when :git
+        puts "UNPACK SRC: nothing to do for git installs"
+      when :http
+        run "test -d #{pkg_dir}.old && #{sudo} rm -fr #{pkg_dir}.old; exit 0"
+        run "test -d #{pkg_dir} && #{sudo} mv #{pkg_dir} #{pkg_dir}.old; exit 0"
+        run "cd #{src_dir} && #{sudo} #{src_pkg[:unpack]}" if src_pkg[:unpack] != ''
+        run "#{sudo} chgrp -R #{group} #{pkg_dir}"
+        run "#{sudo} chmod -R g+w #{pkg_dir}"
+      else
+        puts "UNPACK SRC: Download method not recognised. src_pkg[:download_method]: #{src_pkg[:download_method]} "
+    end
+  end
+
+  def set_pkg_defaults(pkg)
+    pkg[:filename] ||= File.basename(pkg[:url])
+    pkg[:download_method] ||= :http
+    pkg[:post_install] ||= ''
+    case pkg[:download_method]
+    when :http
+      pkg[:dir] ||= pkg[:filename].sub(/(\.tgz|\.tar\.gz)/,'')
+      pkg[:unpack] ||= "tar zxf #{pkg[:filename]};"
+      pkg[:configure] ||= './configure ;'
+      pkg[:make] ||= 'make;'
+      pkg[:install] ||= 'make install;'
+    when :deb
+      pkg[:dir] ||= ''
+      pkg[:unpack] ||= ''
+      pkg[:configure] ||= ''
+      pkg[:make] ||= ''
+      pkg[:install] ||= "dpkg -i #{pkg[:filename]}"
+    end
+  end
+
+  # install pkg from source
+  def install_from_src(src_pkg, src_dir=src_dir)
+    install_deps(src_pkg[:deps])
+    set_pkg_defaults(src_pkg)
+    pkg_dir = File.join([src_dir, src_pkg[:dir]].compact)
+    unpack_src(src_pkg, src_dir)
+    apt.install( {:base => %w(build-essential)}, :stable )
+    run "cd #{pkg_dir} && #{sudo} #{src_pkg[:configure]}" if src_pkg[:configure] != ''
+    run "cd #{pkg_dir} && #{sudo} #{src_pkg[:make]}" if src_pkg[:make] != ''
+    run "cd #{pkg_dir} && #{sudo} #{src_pkg[:install]}" if src_pkg[:install] != ''
+    run "cd #{pkg_dir} && #{sudo} #{src_pkg[:post_install]}" if src_pkg[:post_install] != ''
+  end
+
+  def install_deps(packages=[])
+    apt.install({:base => Array(packages)}, :stable)
+  end
+  
+  def read_database_yml
+    stage = exists?(:stage) ? fetch(:stage).to_s : ''
+    db_config = YAML.load_file(File.join('config', stage, 'database.yml'))
+    set :db_user, db_config[rails_env]["username"]
+    set :db_password, db_config[rails_env]["password"] 
+    set :db_name, db_config[rails_env]["database"]
+  end
+
+
+  ##
+  # Run a command and ask for input when input_query is seen.
+  # Sends the response back to the server.
+  #
+  # +input_query+ is a regular expression that defaults to /^Password/.
+  #
+  # Can be used where +run+ would otherwise be used.
+  #
+  #  run_with_input 'ssh-keygen ...', /^Are you sure you want to overwrite\?/
+
+  def run_with_input(shell_command, input_query=/^Password/, response=nil)
+    handle_command_with_input(:run, shell_command, input_query, response)
+  end
+
+  ##
+  # Run a command using sudo and ask for input when a regular expression is seen.
+  # Sends the response back to the server.
+  #
+  # See also +run_with_input+
+  #
+  # +input_query+ is a regular expression
+
+  def sudo_with_input(shell_command, input_query=/^Password/, response=nil)
+    handle_command_with_input(:sudo, shell_command, input_query, response)
+  end
+
+  def invoke_with_input(shell_command, input_query=/^Password/, response=nil)
+    handle_command_with_input(run_method, shell_command, input_query, response)
+  end
+
+  ##
+  # Run a command using sudo and continuously pipe the results back to the console.
+  #
+  # Similar to the built-in +stream+, but for privileged users.
+
+  def sudo_stream(command)
+    sudo(command) do |ch, stream, out|
+      puts out if stream == :out
+      if stream == :err
+        puts "[err : #{ch[:host]}] #{out}"
+        break
+      end
+    end
+  end
+
+  private
+
+  ##
+  # Does the actual capturing of the input and streaming of the output.
+  #
+  # local_run_method: run or sudo
+  # shell_command: The command to run
+  # input_query: A regular expression matching a request for input: /^Please enter your password/
+
+  def handle_command_with_input(local_run_method, shell_command, input_query, response=nil)
+    send(local_run_method, shell_command) do |channel, stream, data|
+      logger.info data, channel[:host]
+      if data =~ input_query
+        if response
+          channel.send_data "#{response}\n"
+        else 
+          response = ::Capistrano::CLI.password_prompt "#{data}"
+          channel.send_data "#{response}\n"
+        end
+      end
+    end
+  end
+  
+end
+
+Capistrano.plugin :deprec2, Deprec2

data/lib/deprec-core/version.rb

@@ -1,5 +1,5 @@
 module Deprec
   module Core
-    VERSION = "3.1.0"
+    VERSION = "3.1.1"
   end
 end

data/lib/vmbuilder_plugins/all.rb

@@ -0,0 +1,20 @@
+# =all.rb: Load all the Capistrano Plugins in the directory.
+#
+# Require all other ruby files in the directory.
+#
+# ----
+# Copyright (c) 2007 Neil Wilson, Aldur Systems Ltd
+#
+# Licensed under the GNU Public License v2. No warranty is provided.
+# ----
+# = Usage
+#
+#     require 'vmbuilder_plugins/all'
+
+# Splitting and joining __FILE__ deals with the current directory case
+# properly
+Dir[File.join( File.dirname(__FILE__), '*.rb')].each do |plugin_name|
+  unless plugin_name == File.join(File.dirname(__FILE__), File.basename(__FILE__))
+    require plugin_name
+  end
+end

data/lib/vmbuilder_plugins/apt.rb

@@ -0,0 +1,93 @@
+# =apt.rb: Debian 'apt' Installer library
+# Capistrano plugin module to install and manage apt packages
+#
+# ----
+# Copyright (c) 2007 Neil Wilson, Aldur Systems Ltd
+#
+# Licensed under the GNU Public License v2. No warranty is provided.
+
+require 'capistrano'
+
+# = Purpose
+# Apt is a Capistrano plugin module providing a set of methods
+# that invoke the *apt* package manager (as used in Debian and Ubuntu)
+#
+# Installs within Capistrano as the plugin _apt_.
+#
+# =Usage
+#    
+#    require 'vmbuilder_plugins/apt'
+#
+# Prefix all calls to the library with <tt>apt.</tt>
+#
+module Apt 
+
+  # Default apt-get command - reduces any interactivity to the minimum.
+  APT_GET="DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive apt-get" 
+
+  # Run the apt install program across the package list in 'packages'. 
+  # Select those packages referenced by <tt>:base</tt> and the +version+
+  # of the distribution you want to use.
+  def install(packages, version, options={})
+    update
+    special_options="--allow-unauthenticated" if version != :stable
+    send(run_method, %{
+      sh -c "#{APT_GET} -qyu --force-yes #{special_options.to_s} install #{package_list(packages, version)}"
+    }, options)
+  end
+
+  # Run an apt clean
+  def clean(options={})
+    send(run_method, %{sh -c "#{APT_GET} -qy clean"}, options)
+  end
+
+  # Run an apt autoclean
+  def autoclean(options={})
+    send(run_method, %{sh -c "#{APT_GET} -qy autoclean"}, options)
+  end
+
+  # Run an apt distribution upgrade
+  def dist_upgrade(options={})
+    update
+    send(run_method, %{sh -c "#{APT_GET} -qy dist-upgrade"}, options)
+  end
+
+  # Run an apt upgrade. Use dist_upgrade instead if you want to upgrade
+  # the critical base packages.
+  def upgrade(options={})
+    update
+    send(run_method, %{sh -c "#{APT_GET} -qy upgrade"}, options)
+  end
+
+  # Run an apt update.
+  def update(options={})
+    send(run_method, %{sh -c "#{APT_GET} -qy update"}, options)
+  end
+
+  # RPM package install via alien
+  def rpm_install(packages, options={})
+    install({:base => %w(wget alien) }, :base)
+    send(run_method, "wget -Ncq #{packages.join(' ')}", options)
+    files=packages.collect { |package| File.basename(package) }
+    send(run_method, "alien -i #{files.join(' ')}", options)
+  end
+
+  # Clear the source list and package cache
+  def clear_cache(options={})
+    clean
+    cmd="rm -f /var/cache/apt/*.bin /var/lib/apt/lists/*_* /var/lib/apt/lists/partial/*"
+    send(run_method, cmd, options)
+  end
+
+private
+
+  # Provides a string containing all the package names in the base
+  #list plus those in +version+.
+  def package_list(packages, version)
+    Array(packages[:base]).join(' ') + ' ' + Array(packages[version]).join(' ')
+  end
+
+end
+
+Capistrano.plugin :apt, Apt
+# vim: nowrap sw=2 sts=2 ts=8 ff=unix ft=ruby:

data/lib/vmbuilder_plugins/emerge.rb

@@ -0,0 +1,76 @@
+# =emerge.rb: Gentoo 'emerge' Installer library
+# Capistrano task library to install and manage portage packages
+#
+# Copyright (c) 2007 monki(Wesley Beary)
+#
+# inspiration: vmbuilder by Neil Wilson, Aldur Systems Ltd
+#
+# Licenced under the GNU Public License v2. No warranty is provided.
+
+require 'capistrano'
+
+# =Purpose
+# emerge is a Capistrano plugin module providing a set of methods
+# that invoke the portage package manage (as used in Gentoo)
+#
+# Installs within Capistrano as the plugin _emerge_.
+#
+# =Usage
+#
+#   require 'marshall/plugins/emerge'
+#
+# Prefix all calls to the library with <tt>emerge.</tt>
+#
+module Emerge
+  # Default emerge command - reduce interactivity to the minimum
+  EMERGE="emerge -q"
+  
+  # Emerge a new package or packages
+  def install(packages, options={})
+    cmd = <<-CMD
+    sh -c "#{EMERGE} #{packages.join(" ")}"
+    CMD
+    sudo(cmd, options)
+  end
+  
+  # Run clean old/unused packages
+  def clean(options={})
+    cmd = <<-CMD
+      sh -c "#{EMERGE} -clean"
+    CMD
+    sudo(cmd, options)
+  end
+  
+  # Upgrade installed package list
+  def upgrade(options={})
+    cmd = <<-CMD
+      sh -c "#{EMERGE} --sync"
+    CMD
+    sudo(cmd, options)
+  end
+  
+  # Update portage
+  def update_system(options={})
+    cmd = <<-CMD
+      sh -c "#{EMERGE} portage"
+    CMD
+    sudo(cmd, options)
+  end
+  
+  # Update all installed packages
+  def update(options={})
+    cmd = <<-CMD
+      sh -c "#{EMERGE} --update --deep --newuse world"
+    CMD
+    sudo(cmd, options)
+  end
+  
+  # Boot script manipulation command
+  def rc_update(packages, setting)
+    packages.each do |service|
+      sudo "rc_update add #{service} #{setting}"
+    end
+  end
+end
+
+Capistrano.plugin :emerge, Emerge

data/lib/vmbuilder_plugins/gem.rb

@@ -0,0 +1,90 @@
+# =gem.rb: Gem Installer library
+# Capistrano library to install and manage Ruby Gems.
+# 
+# ----
+# Copyright (c) 2007 Neil Wilson, Aldur Systems Ltd
+#
+# Licensed under the GNU Public License v2. No warranty is provided.
+
+require 'capistrano'
+
+# = Purpose
+# Gem is a Capistrano plugin module providing a set of methods
+# that invoke the *gem* package manager.
+#
+# Installs within Capistrano as the plugin _gem_.
+#
+# =Usage
+#    
+#    require 'vmbuilder_plugins/gem'
+#
+# Prefix all calls to the library with <tt>gem.</tt>
+#
+module Gem
+
+  # Default install command
+  #
+  # * doesn't install documentation
+  # * installs all required dependencies automatically.
+  #
+  GEM_INSTALL="gem install --no-rdoc --no-ri"
+  GEM_UPDATE=GEM_INSTALL.sub("install", "update")
+
+  # Upgrade the *gem* system to the latest version. Runs via *sudo*
+  def update_system
+    send(run_method, "#{GEM_UPDATE} --system")
+  end
+
+  # Updates all the installed gems to the latest version. Runs via *sudo*.
+  # Don't use this command if any of the gems require a version selection.
+  def upgrade
+    send(run_method, GEM_UPDATE)
+  end
+
+  # Removes old versions of gems from installation area.
+  def cleanup
+    send(run_method, "gem cleanup")
+  end
+
+  # Installs the gems detailed in +packages+, selecting version +version+ if
+  # specified.
+  #
+  # +packages+ can be a single string or an array of strings.
+  #  
+  def install(packages, version=nil)
+    send(run_method,"#{GEM_INSTALL} #{if version then '-v '+version.to_s end} #{Array(packages).join(' ')}")
+  end
+
+  # Auto selects a gem from a list and installs it.
+  #
+  # *gem* has no mechanism on the command line of disambiguating builds for
+  # different platforms, and instead asks the user. This method has the necessary
+  # conversation to select the +version+ relevant to +platform+ (or the one nearest
+  # the top of the list if you don't specify +version+).
+  def select(package, version=nil, platform='ruby')
+    selections={}
+    cmd="#{GEM_INSTALL} #{if version then '-v '+version.to_s end} #{package}"
+    send run_method, cmd do |channel, stream, data|
+      data.each_line do | line |
+	case line
+	when /\s(\d+).*\(#{platform}\)/
+	  if selections[channel[:host]].nil?
+	    selections[channel[:host]]=$1.dup+"\n"
+	    logger.info "Selecting #$&", "#{stream} :: #{channel[:host]}"
+	  end
+	when /\s\d+\./
+	  # Discard other selections from data stream
+	when /^>/
+	  channel.send_data selections[channel[:host]]
+	  logger.debug line, "#{stream} :: #{channel[:host]}"
+	else
+	  logger.info line, "#{stream} :: #{channel[:host]}"
+	end
+      end
+    end
+  end
+
+end
+
+Capistrano.plugin :gem2, Gem
+# vim: nowrap sw=2 sts=2 ts=8 ff=unix ft=ruby:

data/lib/vmbuilder_plugins/std.rb

@@ -0,0 +1,203 @@
+# =std.rb: Capistrano Standard Methods
+# Standard library of procedures and functions that you can use with Capistrano.
+# 
+# ----
+# Copyright (c) 2007 Neil Wilson, Aldur Systems Ltd
+#
+# Licensed under the GNU Public License v2. No warranty is provided.
+
+require 'capistrano'
+
+# = Purpose
+# Std is a Capistrano plugin that provides a set of standard methods refactored
+# out of several Capistrano task libraries.
+#
+# Installs within Capistrano as the plugin _std_
+#
+# = Usage
+#
+#    require 'vmbuilder_plugins/std'
+#
+# Prefix all calls to the library with <tt>std.</tt>
+module Std
+
+  begin
+    # Use the Mmap class if it is available
+    # http://moulon.inra.fr/ruby/mmap.html    
+    require 'mmap'
+    MMAP=true #:nodoc:
+  rescue LoadError
+    # no MMAP class, use normal reads instead
+    MMAP=false #:nodoc:
+  end
+
+  # Copies the files specified by +file_pattern+ to +destination+
+  #
+  # Error checking is minimal - a pattern onto a single file will result in +destination+
+  # containing the data from the last file only.
+  #
+  # Installs via *sudo*,  +options+ are as for *put*.
+  def fput(file_pattern, destination, options={})
+    logger.info file_pattern
+    Dir.glob(file_pattern) do |fname|
+      if File.readable?(fname) then
+	if MMAP
+	  logger.debug "Using Memory Mapped File Upload"
+	  fdata=Mmap.new(fname,"r", Mmap::MAP_SHARED, :advice => Mmap::MADV_SEQUENTIAL)
+        else
+	  fdata=File.open(fname).read
+	end
+	su_put(fdata, destination, File.join('/tmp',File.basename(fname)), options)
+      else
+	logger.error "Unable to read file #{fname}"
+      end
+    end
+  end
+
+  # Upload +data+ to +temporary_area+ before installing it in
+  # +destination+ using sudo.
+  #
+  # +options+ are as for *put*
+  #
+  def su_put(data, destination, temporary_area='/tmp', options={})
+    temporary_area = File.join(temporary_area,"#{File.basename(destination)}-$CAPISTRANO:HOST$") 
+    put(data, temporary_area, options)
+    send run_method, <<-CMD
+      sh -c "install -m#{sprintf("%3o",options[:mode]||0755)} #{temporary_area} #{destination} &&
+      rm -f #{temporary_area}"
+    CMD
+  end
+  
+  # Copies the +file_pattern+, which is assumed to be a tar
+  # file of some description (gzipped or plain), and unpacks it into
+  # +destination+.
+  def unzip(file_pattern, destination, options={})
+    Dir.glob(file_pattern) do |fname|
+      if File.readable?(fname) then
+	target="/tmp/#{File.basename(fname)}"
+	if MMAP
+	  logger.debug "Using Memory Mapped File Upload"
+	  fdata=Mmap.new(fname,"r", Mmap::MAP_SHARED, :advice => Mmap::MADV_SEQUENTIAL)
+        else
+	  fdata=File.open(fname).read
+	end
+	put(fdata, target, options)
+	send run_method, <<-CMD
+	  sh -c "cd #{destination} &&
+	  zcat -f #{target} | tar xvf - &&
+	  rm -f #{target}"
+	CMD
+      end
+    end
+  end
+  
+  # Wrap this around your task calls to catch the no servers error and
+  # ignore it
+  #    
+  #    std.ignore_no_servers_error do
+  #      activate_mysql
+  #    end
+  #    
+  def ignore_no_servers_error (&block)
+    begin
+      yield
+    rescue RuntimeError => failure
+      if failure.message =~ /no servers matched/
+	logger.debug "Ignoring 'no servers matched' error in task #{current_task.name}"
+      else
+	raise
+      end
+    end
+  end
+
+  # Wrap this around your task to force a connection as root.
+  # Flushes the session cache before and after the connection.
+  #
+  #    std.connect_as_root do
+  #      install_sudo
+  #    end
+  #
+  def connect_as_root (&block)
+    begin
+      tempuser = user
+      set :user, "root"
+      actor.sessions.delete_if { true }
+      yield tempuser
+    ensure
+      set :user, tempuser if tempuser
+      actor.sessions.delete_if { true }
+    end
+  end
+
+  #Returns a random string of alphanumeric characters of size +size+
+  #Useful for passwords, usernames and the like.
+  def random_string(size=10)
+    s = ""
+    size.times { s << (i = rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr }
+    s
+  end
+
+
+  # Return a relative path from the destination directory +from_str+
+  # to the target file/directory +to_str+. Used to create relative
+  # symbolic link paths.
+  def relative_path (from_str, to_str) 
+    require 'pathname'
+    Pathname.new(to_str).relative_path_from(Pathname.new(from_str)).to_s
+  end
+
+  # Run a ruby command file on the servers 
+  #
+  def ruby(cmd, options={}, &block)
+    temp_name = random_string + ".rb"
+    begin
+      put(cmd, temp_name, :mode => 0700)
+      send(run_method, "ruby #{temp_name}", options, &block)
+    ensure
+      delete temp_name
+    end
+  end
+
+  # Run a patchfile on the servers
+  # Ignores reverses and rejects.
+  #
+  def patch(patchfile, level = '0', where = '/')
+    temp_name = random_string
+    begin
+      fput(patchfile, temp_name, :mode => 0600)
+      send(run_method, %{
+        patch -p#{level} -tNd #{where} -r /dev/null < #{temp_name} || true
+      })
+    ensure
+      delete temp_name
+    end
+  end
+
+  # Deletes the given file(s) from all servers targetted by the current
+  # task, but runs the +delete+ command according to the current setting
+  # of <tt>:use_sudo</tt>.
+  #
+  # If <tt>:recursive => true</tt> is specified, it may be used to remove
+  # directories.
+  def su_delete(path, options={})
+    cmd = "rm -%sf #{path}" % (options[:recursive] ? "r" : "")
+    send(run_method, cmd, options)
+  end
+
+  # Render a template file and upload it to the servers
+  # 
+  def put_template(template, destination, options={})
+    if MMAP
+      logger.debug "Using Memory Mapped File Upload"
+      fdata=Mmap.new(template,"r", Mmap::MAP_SHARED, :advice => Mmap::MADV_SEQUENTIAL)
+    else
+      fdata=File.read(template)
+    end
+    put(render(:template => fdata), destination, options)
+  end
+
+end
+
+Capistrano.plugin :std, Std
+#
+# vim: nowrap sw=2 sts=2 ts=8 ff=unix ft=ruby:

metadata

@@ -2,7 +2,7 @@
 name: deprec-core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors: 
 - Mike Bailey
@@ -25,10 +25,17 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - deprec-core.gemspec
 - lib/deprec-core.rb
+- lib/deprec-core/capistrano_extensions.rb
 - lib/deprec-core/version.rb
+- lib/vmbuilder_plugins/all.rb
+- lib/vmbuilder_plugins/apt.rb
+- lib/vmbuilder_plugins/emerge.rb
+- lib/vmbuilder_plugins/gem.rb
+- lib/vmbuilder_plugins/std.rb
 homepage: ""
 licenses: []