syncwrap 1.5.2 → 2.0.0

data/lib/syncwrap/components/etc_hosts.rb

@@ -0,0 +1,44 @@
+#--
+# Copyright (c) 2011-2014 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/component'
+
+module SyncWrap
+
+  # Provision/update an RFC 952 /etc/hosts file for "internal"
+  # intra-Space host resolution. This can be used for simple internal
+  # network resolution instead of DNS.
+  #
+  # Host component dependencies: none
+  class EtcHosts < Component
+
+    def initialize( opts = {} )
+      super
+    end
+
+    def install
+      rput( "etc/hosts", user: :root )
+    end
+
+    def etc_host_table
+      host.space.hosts.map do |h|
+        [ h[ :internal_ip ] || "# internal_ip?", [ h[ :name ] ] ]
+      end
+    end
+
+  end
+
+end

data/lib/syncwrap/{geminabox.rb → components/geminabox.rb}

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2011-2013 David Kellum
+# Copyright (c) 2011-2014 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
@@ -14,26 +14,21 @@
 # permissions and limitations under the License.
 #++
 
-require 'syncwrap/user_run'
-require 'syncwrap/jruby'
+require 'syncwrap/components/iyyov_daemon'
 
-# Provisions the
-# {boxed-geminabox}[https://github.com/dekellum/boxed-geminabox/]
-# gem server.
-module SyncWrap::Geminabox
-  include SyncWrap::UserRun
-  include SyncWrap::JRuby
+module SyncWrap
 
-  attr_accessor :geminabox_version
+  # Provision the
+  # {boxed-geminabox}[https://github.com/dekellum/boxed-geminabox/]
+  # gem server as a simple specialization of IyyovDaemon.
+  #
+  # Host component dependencies: <Distro>, JrubyVM, RunUser, Iyyov
+  class Geminabox < IyyovDaemon
 
-  def initialize
-    super
-    @geminabox_version = '1.0.0'
-  end
+    def initialize( opts = {} )
+      super( { name: 'boxed-geminabox', version: '1.1.0' }.merge( opts ) )
+    end
 
-  def geminabox_install
-    jruby_install_gem( 'boxed-geminabox', :version => "=#{geminabox_version}" )
-    user_run_service_dir_setup( 'boxed-geminabox' )
   end
 
 end

data/lib/syncwrap/components/hashdot.rb

@@ -0,0 +1,97 @@
+#--
+# Copyright (c) 2011-2014 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/component'
+
+module SyncWrap
+
+  # Provision the {Hashdot}[http://hashdot.sourceforge.net/] JVM/script
+  # launcher by building it with gcc on the target host.
+  #
+  # Host component dependencies: <Distro>, <JDK>, JRubyVM
+  class Hashdot < Component
+
+    # Hashdot version (default: 1.4.0)
+    attr_accessor :hashdot_version
+
+    def initialize( opts = {} )
+      @hashdot_version = '1.4.0'
+
+      super
+    end
+
+    def hashdot_bin_url
+      [ 'http://downloads.sourceforge.net/project/hashdot/hashdot',
+        hashdot_version,
+        "hashdot-#{hashdot_version}-src.tar.gz" ].join( '/' )
+    end
+
+    # Install hashdot if the binary version doesn't match, otherwise
+    # just update the profile config files.
+    def install
+      if !test_hashdot_binary || dryrun?
+        install_system_deps
+        install_hashdot
+      else
+        # Just update config as needed.
+        rput( 'src/hashdot/profiles/',
+              "#{local_root}/lib/hashdot/profiles/",
+              excludes: :dev, user: :root )
+      end
+    end
+
+    def install_system_deps
+      dist_install( %w[ make gcc apr apr-devel ] )
+    end
+
+    def test_hashdot_binary
+      binary = "#{local_root}/bin/hashdot"
+      code,_ = capture( <<-SH, accept: [0,91,92] )
+        if [ -x #{binary} ]; then
+          cver=`#{binary} 2>&1 | grep -o -E '([0-9]\.?){2,}'`
+          if [ "$cver" = "#{hashdot_version}" ]; then
+            exit 0
+          fi
+          exit 92
+        fi
+        exit 91
+      SH
+      (code == 0)
+    end
+
+    def install_hashdot
+      src_root = '/tmp/src/hashdot'
+      src = "#{src_root}/hashdot-#{hashdot_version}"
+
+      sh <<-SH
+        sudo rm -rf /tmp/src
+        mkdir -p #{src_root}
+        curl -sSL #{hashdot_bin_url} | tar -C #{src_root} -zxf -
+      SH
+
+      rput( 'src/hashdot/', "#{src}/", :excludes => :dev )
+
+      sh <<-SH
+        cd #{src}
+        make
+        sudo make install
+      SH
+
+    end
+
+  end
+
+end

data/lib/syncwrap/components/iyyov.rb

@@ -0,0 +1,144 @@
+#--
+# Copyright (c) 2011-2014 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/component'
+
+# For distro class comparison only (pre-load for safety)
+require 'syncwrap/components/ubuntu'
+
+module SyncWrap
+
+  # Provision the {Iyyov}[http://rubydoc.info/gems/iyyov/] job
+  # scheduler and process monitor via jruby_gem_install. The
+  # installation setup and configuration templates assume use of a
+  # jobs.d directory, as supported in \Iyyov 1.3.0.
+  #
+  # Host component dependencies: <Distro>, JRubyVM, RunUser
+  class Iyyov < Component
+
+    attr_accessor :iyyov_version
+
+    def initialize( opts = {} )
+      @iyyov_version = '1.3.0'
+
+      super
+    end
+
+    # Deploy iyyov gem, init.d/iyyov and at least an empty jobs.rb.
+    def install
+      # Shorten if the desired iyyov version is already running
+      pid, ver = capture_running_version( 'iyyov' )
+      unless ver == iyyov_version
+        install_run_dir    #as root
+        install_iyyov_gem  #as root
+        install_iyyov_init #as root
+        iyyov_restart      #as root
+        true
+      end
+      false
+    end
+
+    # Given name(-instance), check for name.pid in service_dir and
+    # extract the version number from the associated cmdline. If this
+    # is running out of installed gem directory (Iyyov itself,
+    # standard Iyyov daemons) then cmdline should reference the gem
+    # version.  Returns [pid, version] or nil if not found running
+    def capture_running_version( name, instance = nil )
+      sdir = service_dir( name, instance )
+      code, out = capture( <<-SH, user: run_user, accept:[0,1,91] )
+        pid=$(< #{sdir}/#{name}.pid)
+        if [[ $(< /proc/$pid/cmdline) =~ -(([0-9]+)(\\.[0-9A-Za-z]+)+)[-/] ]]; then
+          echo $pid ${BASH_REMATCH[1]}
+          exit 0
+        fi
+        exit 91
+      SH
+      # Above accepts exit 1 as from $(< missing-file), since it would
+      # be a race to pre-check. Note '\\' escape is for this
+      # ruby here-doc.
+
+      if code == 0
+        pid, ver = out.strip.split( ' ' )
+        [ pid.to_i, ver ]
+      else
+        nil
+      end
+    end
+
+    # Update remote (run_dir/) iyyov/jobs.rb. If force is true, touch
+    # root jobs.rb even if it was not changed: forcing an iyyov config
+    # reload.  Returns any changes in the rput change format,
+    # including any forced mtime update.
+    def iyyov_install_jobs( force = false )
+
+      changes = rput( 'var/iyyov/jobs.rb', iyyov_run_dir, user: run_user )
+
+      if force && changes.empty?
+        rudo "touch #{iyyov_run_dir}/jobs.rb"
+        changes << [ '.f..T......', "#{iyyov_run_dir}/jobs.rb" ]
+      end
+      changes
+    end
+
+    def iyyov_run_dir
+      "#{run_dir}/iyyov"
+    end
+
+    # Create iyyov run directory and make sure there is at minimum an
+    # empty jobs file. Avoid touching it if already present.
+    def install_run_dir
+      # Run as root for merging with the other install fragments.
+      sudo <<-SH
+        mkdir -p #{iyyov_run_dir}
+        mkdir -p #{iyyov_run_dir}/jobs.d
+      SH
+      chown_run_user( '-R', iyyov_run_dir )
+      sudo <<-SH
+        if [ ! -e #{iyyov_run_dir}/jobs.rb ]; then
+          su #{run_user} -c "touch #{iyyov_run_dir}/jobs.rb"
+        fi
+      SH
+    end
+
+    # Ensure install of same gem version as init.d/iyyov script
+    def install_iyyov_gem
+      jruby_gem_install( 'iyyov', version: iyyov_version )
+    end
+
+    # Install iyyov daemon init.d script and add to init daemons
+    def install_iyyov_init
+      rput( 'etc/init.d/iyyov', user: :root,
+            erb_vars: { lsb: distro.kind_of?( Ubuntu ) } )
+
+      # 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
+
+end

data/lib/syncwrap/components/iyyov_daemon.rb

@@ -0,0 +1,125 @@
+#--
+# Copyright (c) 2011-2014 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/component'
+
+module SyncWrap
+
+  # Provision a gem installed, Iyyov launched and monitored jruby
+  # daemon using a standard set of conventions.  Can be used directly
+  # in the common case, or sub-classed as needed.
+  #
+  # Two :sync_paths files are searched for deployment: a config.rb and
+  # a jobs.d/<name>.rb.  If concrete or .erb variants of these are not
+  # found than an (empty) default/config.rb and a generic
+  # default/daemon.rb.erb is used. Again, these will work in the common
+  # case.
+  #
+  # Host component dependencies: <Distro>, JRubyVM, RunUser, Iyyov
+  class IyyovDaemon < Component
+
+    # The daemon process name, also used for service_dir (along with any
+    # instance) and as the default gem_name. (required)
+    attr_accessor :name
+
+    # Name of the gem (set if different than name)
+    attr_writer :gem_name
+
+    # The (gem) version String (required)
+    attr_accessor :version
+
+    # An optional secondary instance name, useful if running more than
+    # one of 'name' on a host (default: nil)
+    attr_accessor :instance
+
+    def initialize( opts = {} )
+      @gem_version = nil
+      @gem_name = nil
+      @daemon_name = nil
+      @instance = nil
+
+      super
+
+      raise "IyyovDaemon#name property not set" unless name
+      raise "IyyovDaemon#version property not set" unless version
+    end
+
+    def gem_name
+      @gem_name || @name
+    end
+
+    def install
+      standard_install
+    end
+
+    protected
+
+    def standard_install
+
+      create_service_dir( name, instance )
+      changes = rput_service_config
+
+      # Shorten if the desired versioned process is already running.
+      pid, ver = capture_running_version( name, instance )
+      if ver != version
+        gem_install( gem_name, version: version )
+        changes += rput( job_source,
+                         "#{iyyov_run_dir}/jobs.d/#{name_instance}.rb",
+                         user: run_user )
+        changes += iyyov_install_jobs
+      elsif !changes.empty?
+        rudo( "kill #{pid} || true" ) # ..and let Iyyov restart it
+      end
+      changes
+    end
+
+    def rput_service_config
+      rput( config_source, "#{daemon_service_dir}/config.rb", user: run_user )
+    end
+
+    def daemon_service_dir
+      service_dir( name, instance )
+    end
+
+    def name_instance
+      [ name, instance ].compact.join( '-' )
+    end
+
+    def job_source
+      sjob = "var/iyyov/jobs.d/#{name_instance}.rb"
+      unless find_source( sjob )
+        sjob = "var/iyyov/jobs.d/#{name}.rb"
+        unless find_source( sjob )
+          sjob = "var/iyyov/default/daemon.rb.erb"
+        end
+      end
+      sjob
+    end
+
+    def config_source
+      sconf = "var/#{name_instance}/config.rb"
+      unless find_source( sconf )
+        sconf = "var/#{name}/config.rb"
+        unless find_source( sconf )
+          sconf = 'var/iyyov/default/config.rb'
+        end
+      end
+      sconf
+    end
+
+  end
+
+end

data/lib/syncwrap/components/jruby_vm.rb

@@ -0,0 +1,122 @@
+#--
+# Copyright (c) 2011-2014 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/component'
+require 'syncwrap/ruby_support'
+
+module SyncWrap
+
+  # Provision JRuby (jruby.org - Ruby on the Java Virtual Machine) by
+  # direct download from public S3 repo. Includes utility methods for
+  # checking and installing JRuby gems.
+  #
+  # Host component dependencies: <Distro>
+  class JRubyVM < Component
+    include RubySupport
+
+    # JRuby version to install (default: 1.7.10)
+    attr_accessor :jruby_version
+
+    def initialize( opts = {} )
+      @jruby_version = '1.7.10'
+
+      super( { gem_command: 'jgem' }.merge( opts ) )
+    end
+
+    def jruby_dist_path
+      "#{local_root}/lib/jruby/jruby-#{jruby_version}"
+    end
+
+    def gemrc_path
+      "#{jruby_dist_path}/etc"
+    end
+
+    def jruby_gem_home
+      "#{local_root}/lib/jruby/gems"
+    end
+
+    # Install jruby if the jruby_version is not already present.
+    def install
+      jruby_install
+      install_gemrc
+    end
+
+    def jruby_bin_url
+      [ 'http://jruby.org.s3.amazonaws.com/downloads',
+        jruby_version,
+        "jruby-bin-#{jruby_version}.tar.gz" ].join( '/' )
+    end
+
+    # Install jruby, including usr/local/bin local contents
+    def jruby_install
+
+      root = "#{local_root}/lib/jruby"
+
+      sudo <<-SH
+        if [ ! -d #{jruby_dist_path} ]; then
+          mkdir -p #{root}
+          mkdir -p #{root}/gems
+          curl -sSL #{jruby_bin_url} | tar -C #{root} -zxf -
+          mkdir -p #{gemrc_path}
+          cd #{root} && ln -sfn jruby-#{jruby_version} jruby
+          cd #{local_root}/bin && ln -sf ../lib/jruby/jruby/bin/jirb .
+        fi
+      SH
+
+      rput( 'jruby/bin/', "#{local_root}/bin/", excludes: :dev, user: :root )
+    end
+
+    # See RubySupport#gem_install for usage.
+    #
+    # The jruby jgem command tends to be slow on virtual hardware.
+    # This implementation adds a faster short-circuit when an exact,
+    # single :version is given that avoids calling gem if the rubygems
+    # same version gemspec file is found.
+    def gem_install( gem, opts = {} )
+      version = Array( opts[ :version ] )
+      ver = (version.length == 1) && version[0] =~ /^=?\s*([0-9]\S+)/ && $1
+
+      unless ( opts[:check] || opts[:user_install] ||
+               opts[:minimize] == false || opts[:spec_check] == false ||
+               !version )
+
+        specs = [ "#{jruby_gem_home}/specifications/#{gem}-#{ver}-java.gemspec",
+                  "#{jruby_gem_home}/specifications/#{gem}-#{ver}.gemspec" ]
+
+        sudo( "if [ ! -e '#{specs[0]}' -a ! -e '#{specs[1]}' ]; then",
+              close: "fi" ) do
+          super
+        end
+      else
+        super
+      end
+
+    end
+
+    alias :jruby_gem_install :gem_install
+
+    def min_deps_supported?
+      varray = jruby_version.split('.').map { |n| n.to_i }
+      ( varray <=> [1, 7, 5] ) >= 0
+    end
+
+    def jruby_gem_version_flags( reqs )
+      Array( reqs ).flatten.compact.map { |req| "-v'#{req}'" }
+    end
+
+  end
+
+end