syncwrap 2.7.1 → 2.8.0

data/lib/syncwrap/components/puma.rb

@@ -15,18 +15,23 @@
 #++
 
 require 'syncwrap/component'
+require 'syncwrap/change_key_listener'
+require 'syncwrap/systemd_service'
 
 module SyncWrap
 
-  # Provision to install, start/restart a Puma HTTP
-  # server, optionally triggered by a state change key.
+  # Provision to install and start/restart a Puma HTTP server
+  # instance, optionally triggered by a state change key. Systemd
+  # service and socket units are supported.
   #
-  # Host component dependencies: RunUser, <ruby>
+  # Host component dependencies:  <Distro>?, RunUser, <ruby>, SourceTree?
   class Puma < Component
+    include ChangeKeyListener
+    include SystemDService
 
     # 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)
+    # to run.  (Default: nil; Example: 3.3.0)
     attr_accessor :puma_version
 
     # Path to the application/configuration directory which
@@ -48,16 +53,11 @@ module SyncWrap
         state: "#{rack_path}/puma.state",
         control: "unix://#{rack_path}/control",
         environment: "production",
-        port: 5874,
         daemon: !foreground? }.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
@@ -66,21 +66,40 @@ module SyncWrap
       @always_restart
     end
 
-    # The name of the systemd unit file to create for this instance of
-    # puma. If specified, the name should include a '.service' suffix.
-    # (Default: nil -> no unit)
-    attr_accessor :systemd_unit
+    # Deprecated
+    alias :systemd_unit :systemd_service
+
+    # Deprecated
+    alias :systemd_unit= :systemd_service=
+
+    # An array of ListenStream configuration values for
+    # #systemd_socket. If a #puma_flags[:port] is specified, this
+    # defaults to a single '0.0.0.0:port' stream. Otherwise this
+    # setting is required if #systemd_socket is specified.
+    attr_writer :listen_streams
+
+    def listen_streams
+      if @listen_streams
+        @listen_streams
+      elsif p = puma_flags[:port]
+        [ "0.0.0.0:#{p}" ]
+      else
+        raise( "Neither #listen_streams nor #puma_flags[:port] specified" +
+               " with Puma#systemd_socket" )
+      end
+    end
 
     public
 
     def initialize( opts = {} )
       @puma_version = nil
       @always_restart = false
-      @change_key = nil
       @rack_path = nil
       @puma_flags = {}
-      @systemd_unit = nil
       super
+      if systemd_socket && !systemd_service
+        raise "Puma#systemd_service is required when #systemd_socket is specified"
+      end
     end
 
     def install
@@ -88,46 +107,78 @@ module SyncWrap
         gem_install( 'puma', version: puma_version )
       end
 
-      changes = change_key && state[ change_key ]
-
-      if systemd_unit
-        uchanges = rput( '/etc/systemd/system/puma.service',
-                         "/etc/systemd/system/#{systemd_unit}",
-                         user: :root )
-        if !uchanges.empty?
-          systemctl( 'enable', systemd_unit )
-        end
-        if( change_key.nil? || changes || uchanges || always_restart? )
-          systemctl( 'restart', systemd_unit )
-        else
-          systemctl( 'start', systemd_unit )
-        end
+      if systemd_service
+        install_units( always_restart? || change_key_changes? )
       else
         rudo( "( cd #{rack_path}", close: ')' ) do
           rudo( "if [ -f puma.state -a -e control ]; then",
                 close: bare_else_start ) do
-            if ( change_key && !changes ) && !always_restart?
-              rudo 'true' #no-op
-            else
+            if always_restart? || change_key_changes?
               bare_restart
+            else
+              rudo 'true' #no-op
             end
           end
         end
+        nil
+      end
+    end
+
+    def start
+      if systemd_service
+        super
+      else
+        bare_start
+      end
+    end
+
+    def restart( *args )
+      if systemd_service
+        super
+      else
+        bare_restart
+      end
+    end
+
+    def stop
+      if systemd_service
+        super
+      else
+        bare_stop
+      end
+    end
+
+    def status
+      if systemd_service
+        super
+      else
+        bare_status
       end
-      nil
     end
 
     protected
 
-    # By default, runs in foreground if a systemd_unit is specified.
+    # By default, runs in foreground if a systemd_service is specified.
     def foreground?
-      !!systemd_unit
+      !!systemd_service
     end
 
     def bare_restart
       rudo( ( pumactl_command + %w[ --state puma.state restart ] ).join( ' ' ) )
     end
 
+    def bare_stop
+      rudo( ( pumactl_command + %w[ --state puma.state stop ] ).join( ' ' ) )
+    end
+
+    def bare_status
+      rudo( ( pumactl_command + %w[ --state puma.state status ] ).join( ' ' ) )
+    end
+
+    def bare_start
+      rudo( "cd #{rack_path} && #{puma_start_command}" )
+    end
+
     def bare_else_start
       <<-SH
         else
@@ -171,5 +222,31 @@ module SyncWrap
       '--' + key.to_s.gsub( /_/, '-' )
     end
 
+    def rput_unit_files
+      c = rput( src_for_systemd_service,
+                "/etc/systemd/system/#{systemd_service}", user: :root )
+      if systemd_socket
+        c += rput( src_for_systemd_socket,
+                   "/etc/systemd/system/#{systemd_socket}", user: :root )
+      end
+      c
+    end
+
+    def src_for_systemd_service
+      s = "/etc/systemd/system/#{systemd_service}"
+      unless find_source( s )
+        s = '/etc/systemd/system/puma.service'
+      end
+      s
+    end
+
+    def src_for_systemd_socket
+      s = "/etc/systemd/system/#{systemd_socket}"
+      unless find_source( s )
+        s = '/etc/systemd/system/puma.socket'
+      end
+      s
+    end
+
   end
 end

data/lib/syncwrap/components/qpid.rb

@@ -131,7 +131,7 @@ module SyncWrap
 
     def corosync_install!( opts = {} )
       corosync_build
-      dist_install( "#{corosync_src}/x86_64/*.rpm", succeed: true )
+      dist_install( "#{corosync_src}/x86_64/*.rpm" )
     end
 
     def qpid_tools_install!
@@ -287,7 +287,7 @@ module SyncWrap
         cd /tmp/rpm-drop
         #{curls.join("\n")}
       SH
-      dist_install( "/tmp/rpm-drop/*.rpm", succeed: true )
+      dist_install( "/tmp/rpm-drop/*.rpm" )
     end
 
     protected

data/lib/syncwrap/components/rhel.rb

@@ -33,67 +33,98 @@ module SyncWrap
 
     alias :distro_version :rhel_version
 
+    protected
+
+    # Set true/false to override the default, distro version based
+    # determination of whether systemd is PID 1 on the system.
+    attr_writer :systemd
+
+    public
+
     def initialize( opts = {} )
       super
     end
 
     def systemd?
-      @is_systemd ||= version_gte?( rhel_version, [7] )
+      if @systemd.nil?
+        @systemd = version_gte?( rhel_version, [7] )
+      end
+      @systemd
     end
 
-    # Install the specified package names. A trailing hash is
-    # interpreted as options, see below.
+    # Install the specified packages. When rpm HTTP URLs or local file
+    # paths are given instead of package names, these are installed
+    # first and individually via #dist_install_url. Calling that
+    # explicitly may be preferable. A trailing hash is interpreted as
+    # options, see below.
     #
     # ==== Options
     #
-    # :check_install:: Short-circuit if all packages already
-    #                  installed. Thus no upgrades will be performed.
+    # :check_install:: Short-circuit if packages are already
+    #                  installed, and thus don't perform updates
+    #                  unless versions are specified. (Default: true)
     #
-    # :succeed:: Deprecated, use check_install instead
+    # :yum_flags:: Additional array of flags to pass to `yum install`.
     #
-    # Additional options are passed to the sudo calls.
+    # Options are also passed to the sudo calls.
     def dist_install( *pkgs )
-      opts = pkgs.last.is_a?( Hash ) && pkgs.pop.dup || {}
-      opts.delete( :minimal )
-      pkgs.flatten!
-      chk = opts.delete( :check_install )
-      chk = opts.delete( :succeed ) if chk.nil?
+      opts = pkgs.last.is_a?( Hash ) && pkgs.pop || {}
+      chk = opts[ :check_install ]
       chk = check_install? if chk.nil?
-      dist_if_not_installed?( pkgs, chk, opts ) do
-        sudo( "yum install -q -y #{pkgs.join( ' ' )}", opts )
+      flags = Array( opts[ :yum_flags ] )
+      pkgs.flatten!
+      rpms,names = pkgs.partition { |p| p =~ /\.rpm$/ || p =~ /^http(s)?:/i }
+      rpms.each do |url|
+        dist_install_url( url, nil, opts )
+      end
+      !names.empty? && dist_if_not_installed?( names, chk != false, opts ) do
+        sudo( "yum install -q -y #{(flags + names).join ' '}", opts )
       end
     end
 
-    # Uninstall the specified package names. A trailing hash is
-    # interpreted as options, see below.
+    # Install packages by HTTP URL or local file path to rpm. Uses
+    # name to check_install. If not specified, name is deduced via
+    # `File.basename( url, '.rpm' )`. It is not recommended to set
+    # option `check_install: false`, because `yum` will fail with
+    # "Error: Nothing to do" if given a file/URL and the package is
+    # already installed.
     #
     # ==== Options
     #
-    # :succeed:: Succeed even if none of the packages are
-    #            installed. (Deprecated, Default: true)
+    # :check_install:: Short-circuit if package is already
+    #                  installed. (Default: true)
     #
-    # Additional options are passed to the sudo calls.
+    # :yum_flags:: Additional array of flags to pass to `yum install`.
+    #
+    # Options are also passed to the sudo calls.
+    def dist_install_url( url, name = nil, opts = {} )
+      name ||= File.basename( url, '.rpm' )
+      chk = opts[ :check_install ]
+      flags = Array( opts[ :yum_flags ] )
+      dist_if_not_installed?( name, chk != false, opts ) do
+        sudo( "yum install -q -y #{(flags + [url]).join ' '}", opts )
+      end
+    end
+
+    # Uninstall the specified package names. A trailing hash is
+    # interpreted as options. These are passed to the sudo.
     def dist_uninstall( *pkgs )
-      opts = pkgs.last.is_a?( Hash ) && pkgs.pop.dup || {}
+      opts = pkgs.last.is_a?( Hash ) && pkgs.pop || {}
       pkgs.flatten!
-      if opts.delete( :succeed ) != false
-        sudo( <<-SH, opts )
-          if yum list -C -q installed #{pkgs.join( ' ' )} >/dev/null 2>&1; then
-            yum remove -q -y #{pkgs.join( ' ' )}
-          fi
-        SH
-      else
-        sudo( "yum remove -q -y #{pkgs.join( ' ' )}", opts )
-      end
+      sudo( <<-SH, opts )
+        if yum list -C -q installed #{pkgs.join ' '} >/dev/null 2>&1; then
+          yum remove -q -y #{pkgs.join ' '}
+        fi
+      SH
     end
 
-    # If chk is true, then wrap block in a sudo bash conditional
-    # testing if any specified pkgs are not installed. Otherwise just
+    # If chk is true, then wrap block in a sudo bash conditional that tests
+    # if any specified pkgs are not installed. Otherwise just
     # yield to block.
     def dist_if_not_installed?( pkgs, chk, opts, &block )
-      if chk && pkgs.all? { |p| p !~ /\.rpm$/ && p !~ /^http(s)?:/ }
-        qry = "yum list -C -q installed #{pkgs.join ' '}"
-        cnt = qry + " | tail -n +2 | wc -l"
+      if chk
+        pkgs = Array( pkgs )
+        cnt = "rpm -q #{pkgs.join ' '} | grep -cv 'not installed'"
         cond = %Q{if [ "$(#{cnt})" != "#{pkgs.count}" ]; then}
         sudo( cond, opts.merge( close: 'fi' ), &block )
       else

data/lib/syncwrap/components/run_user.rb

@@ -36,6 +36,9 @@ module SyncWrap
       @run_dir || "/var/local/#{run_user}"
     end
 
+    # File mode as integer for the #run_dir (default: 0755)
+    attr_accessor :run_dir_mode
+
     # Home directory for the #run_user
     # (default: nil -> same as #run_dir)
     attr_writer :run_user_home
@@ -48,6 +51,7 @@ module SyncWrap
       @run_user    = 'runr'
       @run_group   = nil
       @run_dir     = nil
+      @run_dir_mode = 0755
       @run_user_home = nil
       super
     end
@@ -73,7 +77,7 @@ module SyncWrap
     # Create and set owner/permission of run_dir, such that run_user may
     # create new directories there.
     def create_run_dir
-      mkdir_run_user( run_dir )
+      mkdir_run_user( run_dir, mode: run_dir_mode )
     end
 
     def service_dir( sname, instance = nil )
@@ -87,11 +91,14 @@ module SyncWrap
       mkdir_run_user( sdir )
     end
 
-    # Make dir including parents, chown to run_user and chmod 775.
-    def mkdir_run_user( dir )
+    # Make dir including parents via sudo, chown to run_user, and chmod
+    # === Options
+    # :mode:: Integer file mode for directory set via chmod (Default: 0775)
+    def mkdir_run_user( dir, opts = {} )
+      mode = opts[:mode] || 0775
       sudo "mkdir -p #{dir}"
       chown_run_user dir
-      sudo "chmod 775 #{dir}"
+      sudo( "chmod %o %s" % [ mode, dir ] )
     end
 
     # Deprecated

data/lib/syncwrap/components/source_tree.rb

@@ -53,6 +53,9 @@ module SyncWrap
       @remote_dir || source_dir
     end
 
+    # File mode as integer for the #remote_dir (Default: 0755)
+    attr_accessor :remote_dir_mode
+
     protected
 
     # Require local source_dir to be clean per Git before #rput of the
@@ -84,6 +87,7 @@ module SyncWrap
       @local_source_root = path_relative_to_caller( '..', clr )
       @source_dir = nil
       @remote_dir = nil
+      @remote_dir_mode = 0755
       @remote_source_root = nil
       @require_clean = true
       @rput_options = {}
@@ -99,7 +103,7 @@ module SyncWrap
     end
 
     def install
-      mkdir_run_user( remote_source_path )
+      mkdir_run_user( remote_source_path, mode: remote_dir_mode )
       changes = sync_source
       on_change( changes ) unless changes.empty?
       changes

data/lib/syncwrap/components/tarpit_gem.rb

@@ -24,7 +24,7 @@ module SyncWrap
   #
   class TarpitGem < Component
 
-    # Tarpit version to install (Default: 1.1.0)
+    # Tarpit version to install (Default: 2.1.1)
     attr_accessor :tarpit_version
 
     protected
@@ -39,7 +39,7 @@ module SyncWrap
     public
 
     def initialize( opts = {} )
-      @tarpit_version = '2.1.0'
+      @tarpit_version = '2.1.1'
       @user_install = false
       super
     end

data/lib/syncwrap/components/users.rb

@@ -197,7 +197,8 @@ module SyncWrap
         flags[ :ssh_user ] = ssh_user
         if ssh_user_pem
           flags[ :ssh_user_pem ] = ssh_user_pem
-          flags[ :ssh_options ] = { 'IdentitiesOnly' => 'yes' }
+          flags[ :ssh_options ] = { 'IdentitiesOnly' => 'yes',
+                                    'PasswordAuthentication' => 'no' }
         end
       end
       flags

data/lib/syncwrap/context.rb

@@ -93,7 +93,7 @@ module SyncWrap
       opts = @default_options.merge( opts )
       close = opts.delete( :close )
 
-      flush if opts != @queued_opts #may still be a no-op
+      flush unless sh_opts_equal?( @queued_opts, opts ) #may still be a no-op
 
       @queued_cmd << command
       @queued_opts = opts
@@ -185,6 +185,19 @@ module SyncWrap
 
     private
 
+    SH_OPT_KEYS = [ :accept, :coalesce, :dryrun, :error, :pipefail,
+                    :sh_verbose, :ssh_flags, :ssh_options, :ssh_user,
+                    :ssh_user_pem, :sudo_flags, :user, :verbose ].freeze
+
+    # Compare options hashes for equality, but only keys that
+    # influence execution of #sh, ignoring others.
+    def sh_opts_equal?( o1, o2 )
+      SH_OPT_KEYS.each do |k|
+        return false if o1[k] != o2[k]
+      end
+      true
+    end
+
     def ssh_host_name
       host.space.ssh_host_name( host )
     end
@@ -207,7 +220,7 @@ module SyncWrap
 
     def rsync( srcs, target, opts )
       args = rsync_args( ssh_host_name, srcs, target, opts )
-      exit_code, outputs = capture_stream( args, host, :rsync, opts )
+      _,outputs = capture_stream( args, host, :rsync, opts )
 
       # Return array of --itemize-changes on standard out.
       collect_stream( :out, outputs ).

data/lib/syncwrap/distro.rb

@@ -41,20 +41,19 @@ module SyncWrap
     #
     # ==== Options
     #
-    # :check_install:: Short-circuit if all packages already
-    #                  installed. Thus no upgrades will be performed.
-    #
-    # :succeed:: Deprecated, use check_install instead
+    # :check_install:: Short-circuit if packages are already
+    #                  installed. Thus no upgrades will be
+    #                  performed. (Default: true)
     #
     # :minimal:: Avoid additional "optional" packages when possible
     #
-    # Additional options are passed to the sudo calls.
+    # Options are also passed to the sudo calls.
     def dist_install( *pkgs )
       raise "Include a distro-specific component, e.g. Debian, RHEL"
     end
 
     # Uninstall the specified package names. A trailing hash is
-    # interpreted as options, passed to the sudo calls.
+    # interpreted as options and passed to the sudo calls.
     def dist_uninstall( *pkgs )
       raise "Include a distro-specific component, e.g. Debian, RHEL"
     end
@@ -67,7 +66,6 @@ module SyncWrap
     #   systemctl( 'enable', 'name.service' )
     #
     # See #systemd?, SystemD#systemctl
-    #
     def dist_install_init_service( name )
       raise "Include a distro-specific component, e.g. Debian, RHEL"
     end

data/lib/syncwrap/shell.rb

@@ -98,7 +98,7 @@ module SyncWrap
 
       if opts[ :coalesce ]
         args << '-c'
-        cmd = "exec 1>&2\n"
+        cmd = String.new( "exec 1>&2\n" )
         if opts[ :sh_verbose ]
           cmd << "set " << ( opts[ :sh_verbose ] == :x ? '-x' : '-v' ) << "\n"
         end
@@ -110,7 +110,7 @@ module SyncWrap
           args << ( opts[ :sh_verbose ] == :x ? '-x' : '-v' )
         end
         args << '-c'
-        cmd = ""
+        cmd = String.new
         cmd << "cd /\n" if opts[:user]
         cmd << command_lines_cleanup( command )
         args << cmd