syncwrap 2.2.0 → 2.3.0

data/lib/syncwrap/components/puma.rb

@@ -0,0 +1,146 @@
+#--
+# 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 to install, start/restart a Puma HTTP
+  # server, optionally triggered by a state change key.
+  #
+  # Host component dependencies: RunUser, <ruby>
+  class Puma < Component
+
+    # Puma version to install and run, if set. Otherwise assume puma
+    # is bundled with the application (i.e. Bundle) and use bin stubs
+    # to run.  (Default: nil; Example: 2.9.0)
+    attr_accessor :puma_version
+
+    # Path to the application/configuration directory which
+    # contains the config.ru.
+    # (Default: SourceTree#remote_source_path)
+    attr_writer :rack_path
+
+    def rack_path
+      @rack_path || remote_source_path
+    end
+
+    # Hash of puma command line flag overrides.
+    # (Default: See #puma_flags)
+    attr_writer :puma_flags
+
+    def puma_flags
+      { dir: rack_path,
+        pidfile: "#{rack_path}/puma.pid",
+        state: "#{rack_path}/puma.state",
+        control: "unix://#{rack_path}/control",
+        environment: "production",
+        port: 5874,
+        daemon: true }.merge( @puma_flags )
+    end
+
+    protected
+
+    # An optional state key to check, indicating changes requiring
+    # a Puma restart (Default: nil; Example: :source_tree)
+    attr_accessor :change_key
+
+    # Should Puma be restarted even when there were no source bundle
+    # changes? (Default: false)
+    attr_writer :always_restart
+
+    def always_restart?
+      @always_restart
+    end
+
+    public
+
+    def initialize( opts = {} )
+      @puma_version = nil
+      @always_restart = false
+      @change_key = nil
+      @rack_path = nil
+      @puma_flags = {}
+      super
+    end
+
+    def install
+      if puma_version
+        gem_install( 'puma', version: puma_version )
+      end
+
+      changes = change_key && state[ change_key ]
+      rudo( "( cd #{rack_path}", close: ')' ) do
+        rudo( "if [ -f puma.state -a -e control ]; then", close: else_start ) do
+          if ( change_key && !changes ) && !always_restart?
+            rudo 'true' #no-op
+          else
+            restart
+          end
+        end
+      end
+      nil
+    end
+
+    protected
+
+    def restart
+      rudo( ( pumactl_command + %w[ --state puma.state restart ] ).join( ' ' ) )
+    end
+
+    def else_start
+      <<-SH
+        else
+          #{puma_start_command}
+        fi
+      SH
+    end
+
+    def puma_start_command
+      args = puma_flags.map do |key,value|
+        if value.is_a?( TrueClass )
+          key_to_arg( key )
+        elsif value.is_a?( FalseClass )
+          nil
+        else
+          [ key_to_arg( key ), value && value.to_s ]
+        end
+      end
+      ( puma_command + args.compact ).join( ' ' )
+    end
+
+    def puma_command
+      if puma_version
+        [ ruby_command, '-S', 'puma', "_#{puma_version}_" ]
+      else
+        [ "#{bundle_install_bin_stubs}/puma" ]
+      end
+    end
+
+    def pumactl_command
+      if puma_version
+        [ ruby_command, '-S', 'pumactl', "_#{puma_version}_" ]
+      else
+        [ "#{bundle_install_bin_stubs}/pumactl" ]
+      end
+    end
+
+    def key_to_arg( key )
+      '--' + key.to_s.gsub( /_/, '-' )
+    end
+
+  end
+end

data/lib/syncwrap/components/qpid.rb

@@ -20,7 +20,7 @@ require 'syncwrap/components/rhel'
 module SyncWrap
 
   # Qpid AMQP broker provisioning. Currently this is RHEL (CentoOS,
-  # Amazon Linux) centric; it has not been ported to Debian/Ubuntu.
+  # Amazon Linux) centric; it has not been ported to Debian.
   #
   # Host component dependencies: RHEL
   class Qpid < Component

data/lib/syncwrap/components/rake_gem.rb

@@ -0,0 +1,46 @@
+#--
+# 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 for the rake rubygem and its (j)rake command
+  #
+  # Host component dependencies: <Ruby>
+  #
+  class RakeGem < Component
+
+    # Rake version to install (Default: 10.3.2)
+    attr_accessor :rake_version
+
+    def initialize( opts = {} )
+      @rake_version = '10.3.2'
+      super
+    end
+
+    def rake_command
+      ( ruby_command == 'jruby' ) ? 'jrake' : 'rake'
+    end
+
+    def install
+      opts = { version: rake_version }
+      opts[ :format_executable ] = true unless rake_command == 'rake'
+      gem_install( 'rake', opts )
+    end
+
+  end
+end

data/lib/syncwrap/components/rhel.rb

@@ -19,12 +19,16 @@ require 'syncwrap/distro'
 
 module SyncWrap
 
-  # Customizations for RedHat Enterprise Linux and derivatives like
-  # CentOS and Amazon Linux.  Specific distros/versions may further
-  # override these.
+  # Customizations for RedHat Enterprise Linux and base class for
+  # derivatives like CentOS and AmazonLinux.
   class RHEL < Component
     include SyncWrap::Distro
 
+    # RHEL version, i.e. '6'. No default value.
+    attr_accessor :rhel_version
+
+    alias :distro_version :rhel_version
+
     def initialize( opts = {} )
       super
     end

data/lib/syncwrap/components/run_user.rb

@@ -73,7 +73,7 @@ module SyncWrap
     # Create and set owner/permission of run_dir, such that run_user may
     # create new directories there.
     def create_run_dir
-      make_dir( run_dir )
+      mkdir_run_user( run_dir )
     end
 
     def service_dir( sname, instance = nil )
@@ -84,15 +84,19 @@ module SyncWrap
     # run_dir.
     def create_service_dir( sname, instance = nil )
       sdir = service_dir( sname, instance )
-      make_dir( sdir )
+      mkdir_run_user( sdir )
     end
 
-    def make_dir( dir )
+    # Make dir including parents, chown to run_user and chmod 775.
+    def mkdir_run_user( dir )
       sudo "mkdir -p #{dir}"
       chown_run_user dir
       sudo "chmod 775 #{dir}"
     end
 
+    # Deprecated
+    alias make_dir mkdir_run_user
+
     # Chown to user:run_group where args may be flags and files/directories.
     def chown_run_user( *args )
       flags, paths = args.partition { |a| a =~ /^-/ }

data/lib/syncwrap/components/source_tree.rb

@@ -0,0 +1,128 @@
+#--
+# 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/git_help'
+require 'syncwrap/path_util'
+
+module SyncWrap
+
+  # Install/synchronize a source tree to remotes via rput. By default
+  # assumes the local source tree is in a Git DVCS repository and
+  # checks that it is clean before executing.
+  #
+  # The remote source directory will be owned by the RunUser#run_user
+  #
+  # Host component dependencies: RunUser
+  class SourceTree < Component
+    include PathUtil
+
+    # Local path to root directory in which #source_dir is found
+    # (Default: <sync-file directory>/..)
+    attr_accessor :local_source_root
+
+    # Source directory name (required)
+    attr_accessor :source_dir
+
+    # Remote path to the root directory in which #remote_dir should be
+    # installed. (Default: RunUser#run_dir)
+    attr_writer :remote_source_root
+
+    def remote_source_root
+      @remote_source_root || run_dir
+    end
+
+    # Remote directory name (Default: #source_dir)
+    attr_writer :remote_dir
+
+    def remote_dir
+      @remote_dir || source_dir
+    end
+
+    protected
+
+    # Require local source_dir to be clean per Git before #rput of the
+    # tree. (Default: true)
+    attr_writer :require_clean
+
+    def require_clean?
+      @require_clean
+    end
+
+    # The state key (or Array of keys) to set to if there are any
+    # changes to the tree
+    # (Default: :source_tree)
+    attr_accessor :change_key
+
+    # Any additional options for the rput (Default: {} -> none)
+    attr_accessor :rput_options
+
+    public
+
+    def initialize( opts = {} )
+      opts = opts.dup
+      clr = opts.delete(:caller) || caller
+      @local_source_root = path_relative_to_caller( '..', clr )
+      @source_dir = nil
+      @remote_dir = nil
+      @remote_source_root = nil
+      @require_clean = true
+      @rput_options = {}
+      @change_key = :source_tree
+      super
+
+      raise "SourceTree#source_dir not set" unless source_dir
+    end
+
+    def remote_source_path
+      File.join( remote_source_root, remote_dir )
+    end
+
+    def install
+      mkdir_run_user( remote_source_path )
+      changes = sync_source
+      on_change( changes ) unless changes.empty?
+      changes
+    end
+
+    protected
+
+    def local_source_path
+      File.join( local_source_root, source_dir )
+    end
+
+    def on_change( changes )
+      unless changes.empty? || change_key.nil?
+        Array(change_key).each do |key|
+          state[ key ] ||= []
+          state[ key ] += changes
+        end
+      end
+    end
+
+    def sync_source
+      GitHelp.require_clean!( local_source_path ) if require_clean?
+      opts = { erb_process: false,
+               excludes: [ :dev, '.bundle/' ],
+               user: run_user,
+               sync_paths: [ local_source_root ] }.
+        merge( rput_options )
+      rput( source_dir + '/', remote_source_path, opts )
+    end
+
+  end
+end

data/lib/syncwrap/components/tarpit_gem.rb

@@ -0,0 +1,60 @@
+#--
+# 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 for the rjack-tarpit rubygem
+  #
+  # Host component dependencies: RunUser?, <ruby>
+  #
+  class TarpitGem < Component
+
+    # Tarpit version to install (Default: 1.1.0)
+    attr_accessor :tarpit_version
+
+    protected
+
+    # Perform a user_install as the run_user? (Default: false)
+    attr_writer :user_install
+
+    def user_install?
+      @user_install
+    end
+
+    public
+
+    def initialize( opts = {} )
+      @tarpit_version = '2.1.0'
+      @user_install = false
+      super
+    end
+
+    def install
+      opts = { version: tarpit_version, user_install: user_install? && run_user }
+
+      # tarpit depends on rake, etc. which could be installed with it,
+      # so use format_executable even though tarpit doesn't have any
+      # bin scripts
+      opts[ :format_executable ] = true if ruby_command == 'jruby'
+
+      gem_install( 'rjack-tarpit', opts )
+    end
+
+  end
+
+end

data/lib/syncwrap/components/ubuntu.rb

@@ -14,67 +14,26 @@
 # permissions and limitations under the License.
 #++
 
-require 'syncwrap/component'
-require 'syncwrap/distro'
+require 'syncwrap/components/debian'
 
 module SyncWrap
 
-  # Customizations for \Ubuntu and possibly other Debian/apt packaged
-  # derivatives. Specific distros/versions may further specialize.
-  class Ubuntu < Component
-    include SyncWrap::Distro
+  # Customizations for \Ubuntu and derivatives. Specific
+  # distros/versions may further specialize.
+  class Ubuntu < Debian
 
-    def initialize( opts = {} )
-      super
-    end
-
-    # Install the specified package names. The first time this is
-    # applied to any given host, an "apt-get update" is issued as
-    # well.  A trailing hash is interpreted as options, see below.
-    #
-    # ==== Options
-    # :minimal:: Eqv to --no-install-recommends
-    #
-    # Other options will be ignored.
-    def dist_install( *args )
-      opts = args.last.is_a?( Hash ) && args.pop || {}
-      args.unshift "--no-install-recommends" if opts[ :minimal ]
-
-      sudo( "apt-get -yqq update" ) if first_apt?
-      sudo( "apt-get -yq install #{args.join ' '}" )
-    end
-
-    # Uninstall the specified package names.
-    def dist_uninstall( *pkgs )
-      sudo "aptitude -yq purge #{pkgs.join ' '}"
-    end
-
-    # Install a System V style init.d service script
-    def dist_install_init_service( name )
-      sudo "/usr/sbin/update-rc.d #{name} defaults"
-    end
-
-    # Enable the System V style init.d service
-    def dist_enable_init_service( name )
-      sudo "/usr/sbin/update-rc.d #{name} enable"
-    end
-
-    # Run via sudo, the service command typically supporting 'start',
-    # 'stop', 'restart', 'status', etc. arguments.
-    def dist_service( *args )
-      sudo( [ '/usr/sbin/service', *args ].join( ' ' ) )
-    end
+    # Ubuntu version, i.e. '14.04' or '12.04.4'. No default value.
+    attr_accessor :ubuntu_version
 
-    protected
+    alias :distro_version :ubuntu_version
 
-    def first_apt?
-      s = state
-      if s[ :ubuntu_apt_updated ]
-        false
-      else
-        s[ :ubuntu_apt_updated ] = true
-        true
-      end
+    # Return Debian#debian_version if specified, or provide comparable
+    # default Debian version if #ubuntu_vesion is specified. This is
+    # an approximation of the LTS lineage.
+    def debian_version
+      super ||
+        ( version_gte?( ubuntu_version, [14,4] ) && '7' ) ||
+        ( version_gte?( ubuntu_version, [12,4] ) && '6' )
     end
 
   end

data/lib/syncwrap/components/users.rb

@@ -156,9 +156,8 @@ module SyncWrap
     end
 
     def set_sudoers( user )
-      #FIXME: make this a template?
       #FIXME: Use local_root for secure_path? (Order issue)
-      #Relax, less overrides needed for Ubuntu?
+
       sudo <<-SH
         echo '#{user} ALL=(ALL) NOPASSWD:ALL'  > /etc/sudoers.d/#{user}
         echo 'Defaults:#{user} !requiretty'   >> /etc/sudoers.d/#{user}

data/lib/syncwrap/distro.rb

@@ -18,7 +18,7 @@ require 'syncwrap/base'
 
 module SyncWrap
 
-  # Support module and inteface for (Linux) distribution components.
+  # Support module and interface for distribution components.
   module Distro
 
     # The root directory for local, non-distro managed installs
@@ -46,25 +46,25 @@ module SyncWrap
     #
     # :minimal:: Avoid additional "optional" packages when possible.
     def dist_install( *pkgs )
-      raise "Include a distro-specific component, e.g. Ubuntu, RHEL"
+      raise "Include a distro-specific component, e.g. Debian, RHEL"
     end
 
     # Uninstall the specified package names.
     def dist_uninstall( *pkgs )
-      raise "Include a distro-specific component, e.g. Ubuntu, RHEL"
+      raise "Include a distro-specific component, e.g. Debian, 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 component, e.g. Ubuntu, RHEL"
+      raise "Include a distro-specific component, e.g. Debian, RHEL"
     end
 
     # Run via sudo, the System V style, distro specific `service`
     # command, typically supporting 'start', 'stop', 'restart',
     # 'status', etc. arguments.
     def dist_service( *args )
-      raise "Include a distro-specific component, e.g. Ubuntu, RHEL"
+      raise "Include a distro-specific component, e.g. Debian, RHEL"
     end
 
   end

data/lib/syncwrap/ruby_support.rb

@@ -26,7 +26,11 @@ module SyncWrap
     # Default gem install arguments (default: --no-rdoc, --no-ri)
     attr_accessor :gem_install_args
 
+    # Ruby VM command name (default: ruby; alt example: jruby)
+    attr_accessor :ruby_command
+
     def initialize( *args )
+      @ruby_command = 'ruby'
       @gem_command = 'gem'
       @gem_install_args = %w[ --no-rdoc --no-ri ]
 
@@ -53,9 +57,10 @@ module SyncWrap
     #              '~> 1.1'
     #              ['>=1.0', '<1.2']
     #
-    # :user_install:: If true, perform a --user-install as the current
-    #                 user.  Otherwise system install with sudo (the
-    #                 default, false).
+    # :user_install:: Perform a --user-install if true, as the
+    #                 indicated user if a String or as the login user.
+    #                 Otherwise system install with sudo (the default,
+    #                 false).
     #
     # :check:: If true, capture output and return the number of gems
     #          actually installed.  Combine with :minimize to only
@@ -67,17 +72,28 @@ module SyncWrap
     #             installs to the minimum required to satisfy the
     #             version requirements.  (Default: true)
     #
+    # :format_executable:: Use --format-executable to prefix commands
+    #                      for specific ruby VMs if needed.
+    #
     def gem_install( gem, opts = {} )
       cmd = [ gem_command, 'install',
               gem_install_args,
               ( '--user-install' if opts[ :user_install ] ),
+              ( '--format-executable' if opts[ :format_executable ] ),
               ( '--conservative' if opts[ :minimize] != false ),
               ( '--minimal-deps' if opts[ :minimize] != false &&
                 min_deps_supported? ),
               gem_version_flags( opts[ :version ] ),
               gem ].flatten.compact.join( ' ' )
 
-      shopts = opts[ :user_install ] ? {} : {user: :root}
+      shopts = {}
+
+      case opts[ :user_install ]
+      when String
+        shopts[ :user ] = opts[ :user_install ]
+      when nil, false
+        shopts[ :user ] = :root
+      end
 
       clean_env( opts[ :user_install ] ) do
         if opts[ :check ]

data/lib/syncwrap/version_support.rb

@@ -0,0 +1,62 @@
+#--
+# 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.
+#++
+
+module SyncWrap
+
+  # A Support module for parsing and comparing version strings.
+  module VersionSupport
+
+    protected
+
+    # Convert version decimal String to Array of Integer or String
+    # values. The characters '.' and '-' are treated as
+    # delimiters. Any remaining non-digit in a segment results in a
+    # String being returned for that segment. Return v if not a
+    # String (incl nil).
+    def version_string_to_a( v )
+      if v.is_a?( String )
+        v.split(/[.\-]/).map do |p|
+          if p =~ /^\d+$/
+            p.to_i
+          else
+            p
+          end
+        end
+      else
+        v
+      end
+    end
+
+    # Return true if v1 and v2 are not nil, (auto converted) array
+    # positions are type compatible and compare as v1 >= v2.
+    def version_gte?( v1, v2 )
+      v1 = version_string_to_a( v1 )
+      v2 = version_string_to_a( v2 )
+      c = v1 && v2 && ( v1 <=> v2 ) #-> nil for String/Integer mix
+      c && c >= 0
+    end
+
+    # Return true if v1 and v2 are not nil, (auto converted) array
+    # positions are type compatible and compare v1 < v2.
+    def version_lt?( v1, v2 )
+      v1 = version_string_to_a( v1 )
+      v2 = version_string_to_a( v2 )
+      c = v1 && v2 && ( v1 <=> v2 ) #-> nil for String/Integer mix
+      c && c < 0
+    end
+  end
+
+end