class SyncWrap::Puma

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: <Distro>?, RunUser, <ruby>, SourceTree?

Attributes

always_restart[W]

Should Puma be restarted even when there were no source bundle changes? (Default: false)

listen_streams[W]

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.

puma_flags[W]

Hash of puma command line flag overrides. (Default: See puma_flags)

puma_version[RW]

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: 3.3.0)

rack_path[W]

Path to the application/configuration directory which contains the config.ru. (Default: SyncWrap::SourceTree#remote_source_path)

Public Class Methods

new( opts = {} ) click to toggle source

Calls superclass method SyncWrap::SystemDService.new

# File lib/syncwrap/components/puma.rb, line 94
def initialize( opts = {} )
  @puma_version = nil
  @always_restart = false
  @rack_path = nil
  @puma_flags = {}
  super
  if systemd_socket && !systemd_service
    raise "Puma#systemd_service is required when #systemd_socket is specified"
  end
end

Public Instance Methods

install() click to toggle source

# File lib/syncwrap/components/puma.rb, line 105
def install
  if puma_version
    gem_install( 'puma', version: puma_version )
  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 always_restart? || change_key_changes?
          bare_restart
        else
          rudo 'true' #no-op
        end
      end
    end
    nil
  end
end

puma_flags() click to toggle source

# File lib/syncwrap/components/puma.rb, line 50
def puma_flags
  { dir: rack_path,
    pidfile: "#{rack_path}/puma.pid",
    state: "#{rack_path}/puma.state",
    control: "unix://#{rack_path}/control",
    environment: "production",
    daemon: !foreground? }.merge( @puma_flags )
end

rack_path() click to toggle source

# File lib/syncwrap/components/puma.rb, line 42
def rack_path
  @rack_path || remote_source_path
end

restart( *args ) click to toggle source

Calls superclass method SyncWrap::SystemDService#restart

# File lib/syncwrap/components/puma.rb, line 135
def restart( *args )
  if systemd_service
    super
  else
    bare_restart
  end
end

start() click to toggle source

Calls superclass method SyncWrap::SystemDService#start

# File lib/syncwrap/components/puma.rb, line 127
def start
  if systemd_service
    super
  else
    bare_start
  end
end

status() click to toggle source

Calls superclass method SyncWrap::SystemDService#status

# File lib/syncwrap/components/puma.rb, line 151
def status
  if systemd_service
    super
  else
    bare_status
  end
end

stop() click to toggle source

Calls superclass method SyncWrap::SystemDService#stop

# File lib/syncwrap/components/puma.rb, line 143
def stop
  if systemd_service
    super
  else
    bare_stop
  end
end

Protected Instance Methods

always_restart?() click to toggle source

# File lib/syncwrap/components/puma.rb, line 65
def always_restart?
  @always_restart
end

bare_else_start() click to toggle source

# File lib/syncwrap/components/puma.rb, line 182
def bare_else_start
  <<-SH
    else
      #{puma_start_command}
    fi
  SH
end

bare_restart() click to toggle source

# File lib/syncwrap/components/puma.rb, line 166
def bare_restart
  rudo( ( pumactl_command + %w[ --state puma.state restart ] ).join( ' ' ) )
end

bare_start() click to toggle source

# File lib/syncwrap/components/puma.rb, line 178
def bare_start
  rudo( "cd #{rack_path} && #{puma_start_command}" )
end

bare_status() click to toggle source

# File lib/syncwrap/components/puma.rb, line 174
def bare_status
  rudo( ( pumactl_command + %w[ --state puma.state status ] ).join( ' ' ) )
end

bare_stop() click to toggle source

# File lib/syncwrap/components/puma.rb, line 170
def bare_stop
  rudo( ( pumactl_command + %w[ --state puma.state stop ] ).join( ' ' ) )
end

foreground?() click to toggle source

By default, runs in foreground if a systemd_service is specified.

# File lib/syncwrap/components/puma.rb, line 162
def foreground?
  !!systemd_service
end

key_to_arg( key ) click to toggle source

# File lib/syncwrap/components/puma.rb, line 221
def key_to_arg( key )
  '--' + key.to_s.gsub( /_/, '-' )
end

listen_streams() click to toggle source

# File lib/syncwrap/components/puma.rb, line 81
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

puma_command() click to toggle source

# File lib/syncwrap/components/puma.rb, line 203
def puma_command
  if puma_version
    [ ruby_command, '-S', 'puma', "_#{puma_version}_" ]
  else
    [ File.expand_path( File.join( bundle_install_bin_stubs, "puma" ),
                        rack_path ) ]
  end
end

puma_start_command() click to toggle source

# File lib/syncwrap/components/puma.rb, line 190
def puma_start_command
  args = puma_flags.map do |key,value|
    if value.is_a?( TrueClass )
      key_to_arg( key )
    elsif value.nil? || value.is_a?( FalseClass )
      nil
    else
      [ key_to_arg( key ), value && value.to_s ]
    end
  end
  ( puma_command + args.compact ).join( ' ' )
end

pumactl_command() click to toggle source

# File lib/syncwrap/components/puma.rb, line 212
def pumactl_command
  if puma_version
    [ ruby_command, '-S', 'pumactl', "_#{puma_version}_" ]
  else
    [ File.expand_path( File.join( bundle_install_bin_stubs, "pumactl" ),
                        rack_path ) ]
  end
end

rput_unit_files() click to toggle source

# File lib/syncwrap/components/puma.rb, line 225
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

src_for_systemd_service() click to toggle source

# File lib/syncwrap/components/puma.rb, line 235
def src_for_systemd_service
  s = "/etc/systemd/system/#{systemd_service}"
  unless find_source( s )
    s = '/etc/systemd/system/puma.service'
  end
  s
end

src_for_systemd_socket() click to toggle source

# File lib/syncwrap/components/puma.rb, line 243
def src_for_systemd_socket
  s = "/etc/systemd/system/#{systemd_socket}"
  unless find_source( s )
    s = '/etc/systemd/system/puma.socket'
  end
  s
end