Empact-deprec 1.99.21

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)
+    packages[:base].to_a.join(' ') + ' ' + packages[version].to_a.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} #{packages.to_a.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)) 
+    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: