syncwrap 1.0.0

data/lib/syncwrap/common.rb

@@ -0,0 +1,151 @@
+#--
+# Copyright (c) 2011-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'syncwrap/base'
+
+# Common utility methods and variables.
+module SyncWrap::Common
+
+  # The prefix for local non-distro installs (default: /usr/local)
+  attr_accessor :common_prefix
+
+  def initialize
+    super
+    @common_prefix = '/usr/local'
+  end
+
+  # Return true if remote file exists, as per "test -e"
+  def exist?( file )
+    exec_conditional { run "test -e #{file}" } == 0
+  end
+
+  # Put files or entire directories to remote.
+  #
+  #   rput( src..., dest, {options} )
+  #   rput( src, {options} )
+  #
+  # A trailing hash is interpreted as options, see below.
+  #
+  # If there is two or more remaining arguments, the last is
+  # interpreted as the remote destination.  If there is a single
+  # remaining argument, the destination is implied by finding its base
+  # directory and prepending '/'. Thus for example:
+  #
+  #   rput( 'etc/gemrc', :user => 'root' )
+  #
+  # has an implied destination of: `/etc/`. The src and destination
+  # are intrepreted as by `rsync`: glob patterns are expanded and
+  # trailing '/' is significant.
+  #
+  # ==== Options
+  # :user:: Files should be owned on destination by a user other than
+  #         installer (ex: 'root') (implies sudo)
+  # :perms:: Permissions to set for install files.
+  # :excludes:: One or more rsync compatible --filter excludes, or
+  #             :dev which excludes common developmoent tree droppings
+  #             like '*~'
+  def rput( *args )
+    opts = args.last.is_a?( Hash ) && args.pop || {}
+
+    if args.length == 1
+      abspath = "/" + args.first
+      abspath = File.dirname( abspath ) + '/' unless abspath =~ %r{/$}
+    else
+      abspath = args.pop
+    end
+
+    flags = []
+
+    excludes = Array( opts[ :excludes ] )
+    flags += excludes.map do |e|
+      if e == :dev
+        '--cvs-exclude'
+      else
+        "--filter=#{e}"
+      end
+    end
+
+    if opts[ :perms ]
+      flags << '-p'
+      flags << "--chmod=#{opts[ :perms ]}"
+    end
+
+    if opts[ :user ]
+      # Use sudo to place files at remote.
+      user = opts[ :user ] || 'root'
+      flags << ( if user != 'root'
+                   "--rsync-path=sudo -u #{user} rsync"
+                 else
+                   "--rsync-path=sudo rsync"
+                 end )
+    end
+
+    cmd = [ flags, args, [ target_host, abspath ].join(':') ].flatten.compact
+    rsync( *cmd )
+
+  end
+
+  # Run args as shell command on the remote host. A line delimited
+  # argument is interpreted as multiple commands, otherwise arguments
+  # are joined as a single command.
+  #
+  # A trailing Hash is interpreted as options, see below.
+  #
+  # ==== options
+  # :error:: Set the error handling mode: If `:exit`, causes "set -e" to
+  #          be passed as the first line of a multi-line
+  #          command. (Default: :exit)
+  def run( *args )
+    raise "Include a remoting-specific module, e.g. RemoteTask"
+  end
+
+  # Run args under sudo on remote host. A line delimited argument is
+  # interpreted as multiple commands, otherwise arguments are joined
+  # as a single command.
+  #
+  # A trailing Hash is interpreted as options, see below.
+  #
+  # ==== options
+  # :user:: Run as specified user (default: root)
+  # :flags:: Additional sudo flags
+  # :shell:: Run command in a shell by wrapping it in sh -c "", and
+  #          escaping quotes in the original joined args command.
+  #          (default: true)
+  # :error:: Set the error handling mode: If `:exit`, causes "set -e" to
+  #          be passed as the first line of a multi-line
+  #          command. (Default: :exit, only applies if :shell)
+  def sudo( *args )
+    raise "Include a remoting-specific module, e.g. RemoteTask"
+  end
+
+  # Return the exit status of the first non-zero command result, or 0
+  # if all commands succeeded.
+  def exec_conditional
+    raise "Include a remoting-specific module, e.g. RemoteTask"
+  end
+
+  # Implement rsync as used by rput. Note that args should not be
+  # passed through shell interpretation, eg run via system( Array )
+  def rsync( *args )
+    raise "Include a remoting-specific module, e.g. RemoteTask"
+  end
+
+  # Returns the current target host when called from a running task.
+  def target_host
+    raise "Include a remoting-specific module, e.g. RemoteTask"
+  end
+
+end

data/lib/syncwrap/distro.rb

@@ -0,0 +1,64 @@
+#--
+# Copyright (c) 2011-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'syncwrap/base'
+
+# Support for distro specializations.
+module SyncWrap::Distro
+
+  # A Hash of internal/common package names to distro specific package
+  # names.  Here defined as empty.
+  attr_reader :packages_map
+
+  def initialize
+    super
+
+    @packages_map = {}
+  end
+
+  # Map internal/common names and return distro-specific names. If a
+  # mapping does not exist, assume internal name is a common name and
+  # return.
+  def dist_map_packages( *pkgs )
+    pkgs.flatten.compact.map { |pkg| packages_map[ pkg ] || pkg }
+  end
+
+  # Install the specified packages using distro-specific mapped
+  # package names and command.
+  def dist_install( *pkgs )
+    raise "Include a distro-specific module, e.g. Ubuntu, RHEL"
+  end
+
+  # Uninstall specified packages using distro-specific mapped
+  # package names and command.
+  def dist_uninstall( *pkgs )
+    raise "Include a distro-specific module, e.g. Ubuntu, RHEL"
+  end
+
+  # Install a System V style init.d script (already placed at remote
+  # /etc/init.d/<name>) via distro-specific command
+  def dist_install_init_service( name )
+    raise "Include a distro-specific module, e.g. Ubuntu, RHEL"
+  end
+
+  # Distro (and System V replacement) specific service command,
+  # typically supporting 'start', 'stop', 'restart', 'status',
+  # etc. argumnets.
+  def dist_service( *args )
+    raise "Include a distro-specific module, e.g. Ubuntu, RHEL"
+  end
+
+end

data/lib/syncwrap/ec2.rb

@@ -0,0 +1,59 @@
+#--
+# Copyright (c) 2011-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'syncwrap/common'
+
+# Provisions for common Amazon EC2 image tasks.
+module SyncWrap::EC2
+  include SyncWrap::Common
+
+  # The device name of the EBS device mounted on /mnt
+  # (default: 'xvdb')
+  attr_accessor :ec2_ebs_mnt_device
+
+  def initialize
+    super
+
+    @ec2_ebs_mnt_device = 'xvdb'
+  end
+
+  # WARNING: Destructive if run!
+  # Re-mkfs /mnt partition as ext4 if its ec2_ebs_mnt_device and is
+  # currently ext3
+  def ec2_reformat_mnt_as_ext4
+    rc = exec_conditional do
+      run "mount | grep '/dev/#{ec2_ebs_mnt_device} on /mnt'"
+    end
+    raise "Device /dev/#{ec2_ebs_mnt_device} not mounted on /mnt" unless rc == 0
+
+    rc = exec_conditional do
+      run "mount | grep '/dev/#{ec2_ebs_mnt_device} on /mnt type ext3'"
+    end
+    ec2_reformat_mnt_as_ext4! if rc == 0
+  end
+
+  # WARNING: Destructive!
+  # Re-mkfs /mnt partition as ext4
+  # See: http://serverfault.com/questions/317009
+  def ec2_reformat_mnt_as_ext4!
+    sudo <<-SH
+      umount /mnt
+      mkfs -t ext4 /dev/#{ec2_ebs_mnt_device}
+      mount  /mnt
+    SH
+  end
+
+end

data/lib/syncwrap/hashdot.rb

@@ -0,0 +1,70 @@
+#--
+# Copyright (c) 2011-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'syncwrap/common'
+require 'syncwrap/distro'
+
+# Provisions the {Hashdot}[http://hashdot.sourceforge.net/] JVM/script
+# launcher by building it with gcc on the target host.
+module SyncWrap::Hashdot
+  include SyncWrap::Common
+  include SyncWrap::Distro
+
+  # Hashdot version (default: 1.4.0)
+  attr_accessor :hashdot_version
+
+  def initialize
+    super
+
+    @hashdot_version = '1.4.0'
+  end
+
+  def hashdot_install_system_deps
+    dist_install( %w[ make gcc apr apr-devel ] )
+  end
+
+  # Install hashdot if the binary is not found. If the binary is found
+  # then still attempt to update the profile config files.
+  def hashdot_install
+    if !exist?( "#{common_prefix}/bin/hashdot" )
+      hashdot_install!
+    else
+      # Just update config as needed.
+      rput( 'src/hashdot/profiles/',
+            "#{common_prefix}/lib/hashdot/profiles/",
+            :excludes => :dev, :user => 'root' )
+    end
+  end
+
+  def hashdot_install!
+    hashdot_install_system_deps
+
+    url = ( "http://downloads.sourceforge.net/project/hashdot/" +
+            "hashdot/#{hashdot_version}/hashdot-#{hashdot_version}-src.tar.gz" )
+    src_root = '/tmp/src'
+    hd_src = "#{src_root}/hashdot-#{hashdot_version}"
+
+    run <<-SH
+      mkdir -p #{src_root}
+      rm -rf #{hd_src}
+      curl -sSL #{url} | tar -C #{src_root} -zxf -
+    SH
+    rput( 'src/hashdot/', "#{hd_src}/", :excludes => :dev )
+    run  "cd #{hd_src} && make"
+    sudo "cd #{hd_src} && make install"
+  end
+
+end

data/lib/syncwrap/iyyov.rb

@@ -0,0 +1,124 @@
+#--
+# Copyright (c) 2011-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'syncwrap/user_run'
+require 'syncwrap/distro'
+require 'syncwrap/jruby'
+
+# Provisions the {Iyyov}[http://rubydoc.info/gems/iyyov/] job
+# scheduler and process monitor by jruby_install_gem.
+module SyncWrap::Iyyov
+  include SyncWrap::UserRun
+  include SyncWrap::Distro
+  include SyncWrap::JRuby
+
+  attr_accessor :iyyov_version
+
+  def initialize
+    super
+
+    @iyyov_version = '1.1.3'
+  end
+
+  # Install then (re-)start Iyyov if needed, yield to block if given
+  # for daemon gem or other setup, then finally update remote
+  # (user_run) var/iyyov/jobs.rb; which will trigger any necessary
+  # restarts.
+  def iyyov_install_jobs
+    user_run_dir_setup
+
+    restart = iyyov_install
+    if restart
+      iyyov_restart
+      sleep 15
+    elsif !exist?( "#{iyyov_run_dir}/iyyov.pid" )
+      iyyov_start
+      sleep 15
+    end
+
+    # FIXME: Need a better solution to wait on Iyyov than an arbitrary
+    # sleep.
+
+    # Any Iyyov restart completes *before* job changes
+
+    yield if block_given?
+
+    user_run_rput( 'var/iyyov/jobs.rb', iyyov_run_dir )
+
+    # FIXME: If no jobs.rb change, still touch file to ensure
+    # check, but avoid both an update and a touch...
+
+  end
+
+  # Deploy iyyov gem, init.d/iyyov and at least an empty
+  # jobs.rb. Returns true if iyyov was installed/upgraded and should
+  # be restarted.
+  def iyyov_install
+    iyyov_install_rundir
+
+    if iyyov_install_gem
+      iyyov_install_init!
+      true
+    else
+      false
+    end
+
+  end
+
+  def iyyov_run_dir
+    "#{user_run_dir}/iyyov"
+  end
+
+  # Create iyyov rundir and make sure there is at minimum an empty
+  # jobs file. Avoid touching it if already present
+  def iyyov_install_rundir
+    run <<-SH
+      mkdir -p #{iyyov_run_dir}
+      if [ ! -e #{iyyov_run_dir}/jobs.rb ]; then
+        touch #{iyyov_run_dir}/jobs.rb
+      fi
+    SH
+    user_run_chown( '-R', iyyov_run_dir )
+  end
+
+  # Ensure install of same gem version as init.d/iyyov script
+  # Return true if installed
+  def iyyov_install_gem
+    jruby_install_gem( 'iyyov', :version => "=#{iyyov_version}",
+                       :check => true )
+  end
+
+  # Install iyyov daemon init.d script and add to init daemons
+  def iyyov_install_init!
+    rput( 'etc/init.d/iyyov', :user => 'root' )
+
+    # Add to init.d
+    dist_install_init_service( 'iyyov' )
+  end
+
+  def iyyov_start
+    dist_service( 'iyyov', 'start' )
+  end
+
+  def iyyov_stop
+    dist_service( 'iyyov', 'stop' )
+  end
+
+  def iyyov_restart
+    dist_service( 'iyyov', 'restart' )
+  end
+
+end

data/lib/syncwrap/java.rb

@@ -0,0 +1,61 @@
+#--
+# Copyright (c) 2011-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'syncwrap/common'
+
+# Provisions a JDK via an HTTP accessable binary repository of your
+# making.  Sun/Oracle JDK usage terms generally preclude sharing a
+# binary repository for these.
+module SyncWrap::Java
+  include SyncWrap::Common
+
+  # HTTP URL to repo base directory. Note that the default
+  # (http://localhost/repo) is unlikely to work here.
+  attr_accessor :java_repo_base_url
+
+  # The name of the JDK, which is used for download via
+  # java_repo_base_url/<name>.tar.gz and the expected top level
+  # directory when unpackaged.
+  attr_accessor :java_jdk_name
+
+  def initialize
+    super
+
+    @java_repo_base_url = 'http://localhost/repo'
+    @java_jdk_name = 'jdk-ora-1.7.0_04-x64'
+  end
+
+  def java_jdk_url
+    File.join( @java_repo_base_url, @java_jdk_name + '.tar.gz' )
+  end
+
+  def java_install
+    java_install! unless exist?( "#{common_prefix}/lib/#{java_jdk_name}" )
+  end
+
+  def java_install!
+    bins = %w[ java jmap jstack jps jinfo jhat javac ].
+      map { |b| "../lib/java/bin/#{b}" }.
+      join( ' ' )
+
+    sudo <<-SH
+      curl -sSL #{java_jdk_url} | tar -C #{common_prefix}/lib -zxf -
+      cd #{common_prefix}/lib && ln -sfn #{java_jdk_name} java
+      cd #{common_prefix}/bin && ln -sfn #{bins} .
+    SH
+
+  end
+end

data/lib/syncwrap/jruby.rb

@@ -0,0 +1,107 @@
+#--
+# Copyright (c) 2011-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'syncwrap/common'
+
+# Provisions JRuby by direct download from public S3 repo. Includes
+# utility methods for checking and installing JRuby gems.
+module SyncWrap::JRuby
+  include SyncWrap::Common
+
+  # JRuby version to install (default: 1.6.7)
+  attr_accessor :jruby_version
+
+  # The name of the gem command to be installed/used (default: jgem)
+  attr_accessor :jruby_gem_command
+
+  # Default gem install arguments (default: --no-rdoc, --no-ri)
+  attr_accessor :jruby_gem_install_args
+
+  def initialize
+    super
+
+    @jruby_version = '1.6.7'
+    @jruby_gem_command = 'jgem'
+    @jruby_gem_install_args = %w[ --no-rdoc --no-ri ]
+  end
+
+  # Install jruby if the jruby_version is not already present.
+  def jruby_install
+    unless exist?( "#{common_prefix}/lib/jruby/jruby-#{jruby_version}" )
+      jruby_install!
+    end
+  end
+
+  # Install jruby, including usr/local/bin local contents
+  def jruby_install!
+    url = ( "http://jruby.org.s3.amazonaws.com/downloads/#{jruby_version}/" +
+            "jruby-bin-#{jruby_version}.tar.gz" )
+
+    root = "#{common_prefix}/lib/jruby"
+
+    sudo <<-SH
+      mkdir -p #{root}
+      mkdir -p #{root}/gems
+      curl -sSL #{url} | tar -C #{root} -zxf -
+      cd #{root} && ln -sf jruby-#{jruby_version} jruby
+      cd #{common_prefix}/bin && ln -sf ../lib/jruby/jruby/bin/jirb .
+    SH
+
+    rput( 'usr/local/bin/', :excludes => :dev, :user => 'root' )
+  end
+
+  # Return true if gem is already installed.
+  # ==== Options
+  # :version:: Version specifier array, like in spec. files
+  #            (default: none, i.e. latest)
+  # :user:: If true, perform a --user-install as current user, else
+  #         system install with sudo (default: false )
+  def jruby_check_gem( gems, opts = {} )
+    query = [ jruby_gem_command, 'query', '-i',
+              jruby_gem_version_flags( opts[ :version ] ),
+              '-n', gems, '>/dev/null' ].flatten.compact
+
+    status = exec_conditional do
+      send( opts[ :user ] ? :run : :sudo, query )
+    end
+    ( status == 0 )
+  end
+
+  # Install the specified gem(s)
+  # ==== Options
+  # :version:: Version specifier array, like in spec. files
+  #            (default: none, i.e. latest)
+  # :user:: If true, perform a --user-install as current user, else
+  #         system install with sudo (default: false )
+  def jruby_install_gem( gems, opts = {} )
+    if opts[ :check ] && jruby_check_gem( gems, opts )
+      false
+    else
+      cmd = [ jruby_gem_command, 'install',
+              jruby_gem_install_args,
+              ( '--user-install' if opts[ :user ] ),
+              jruby_gem_version_flags( opts[ :version ] ),
+              gems ].flatten.compact
+      send( opts[ :user ] ? :run : :sudo, cmd )
+      true
+    end
+  end
+
+  def jruby_gem_version_flags( reqs )
+    Array( reqs ).flatten.compact.map { |req| "-v'#{req}'" }
+  end
+
+end