Class: Puma::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/puma/cli.rb

Overview

Handles invoke a Puma::Server in a command line style.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv, events = Events.stdio) ⇒ CLI

Create a new CLI object using argv as the command line arguments.

stdout and stderr can be set to IO-like objects which this object will report status on.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/puma/cli.rb', line 27

def initialize(argv, events=Events.stdio)
  @debug = false
  @argv = argv

  @events = events

  @status = nil
  @runner = nil

  @config = nil

  ENV['NEWRELIC_DISPATCHER'] ||= "Puma"

  setup_options
  generate_restart_data

  @binder = Binder.new(@events)
  @binder.import_from_env
end

Instance Attribute Details

#binderObject (readonly)

The Binder object containing the sockets bound to.



48
49
50
# File 'lib/puma/cli.rb', line 48

def binder
  @binder
end

#configObject (readonly)

The Configuration object used.



51
52
53
# File 'lib/puma/cli.rb', line 51

def config
  @config
end

#eventsObject (readonly)

The Events object used to output information.



57
58
59
# File 'lib/puma/cli.rb', line 57

def events
  @events
end

#optionsObject (readonly)

The Hash of options used to configure puma.



54
55
56
# File 'lib/puma/cli.rb', line 54

def options
  @options
end

Instance Method Details

#clustered?Boolean

Returns:

  • (Boolean)


320
321
322
# File 'lib/puma/cli.rb', line 320

def clustered?
  @options[:workers] > 0
end

#debug(str) ⇒ Object



71
72
73
74
75
# File 'lib/puma/cli.rb', line 71

def debug(str)
  if @options[:debug]
    @events.log "- #{str}"
  end
end

#delete_pidfileObject



272
273
274
275
276
# File 'lib/puma/cli.rb', line 272

def delete_pidfile
  if path = @options[:pidfile]
    File.unlink path if File.exist? path
  end
end

#envObject



261
262
263
264
265
# File 'lib/puma/cli.rb', line 261

def env
  # Try the user option first, then the environment variable,
  # finally default to development
  @options[:environment] || ENV['RACK_ENV'] || 'development'
end

#error(str) ⇒ Object

Delegate error to @events



67
68
69
# File 'lib/puma/cli.rb', line 67

def error(str)
  @events.error str
end

#find_configObject



278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'lib/puma/cli.rb', line 278

def find_config
  if cfg = @options[:config_file]
    # Allow - to disable config finding
    if cfg == "-"
      @options[:config_file] = nil
      return
    end

    return
  end

  pos = ["config/puma/#{env}.rb", "config/puma.rb"]
  @options[:config_file] = pos.find { |f| File.exist? f }
end

#generate_restart_dataObject



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/puma/cli.rb', line 330

def generate_restart_data
  # Use the same trick as unicorn, namely favor PWD because
  # it will contain an unresolved symlink, useful for when
  # the pwd is /data/releases/current.
  if dir = ENV['PWD']
    s_env = File.stat(dir)
    s_pwd = File.stat(Dir.pwd)

    if s_env.ino == s_pwd.ino and (jruby? or s_env.dev == s_pwd.dev)
      @restart_dir = dir
      @options[:worker_directory] = dir
    end
  end

  @restart_dir ||= Dir.pwd

  @original_argv = ARGV.dup

  if defined? Rubinius::OS_ARGV
    @restart_argv = Rubinius::OS_ARGV
  else
    require 'rubygems'

    # if $0 is a file in the current directory, then restart
    # it the same, otherwise add -S on there because it was
    # picked up in PATH.
    #
    if File.exist?($0)
      arg0 = [Gem.ruby, $0]
    else
      arg0 = [Gem.ruby, "-S", $0]
    end

    # Detect and reinject -Ilib from the command line
    lib = File.expand_path "lib"
    arg0[1,0] = ["-I", lib] if $:[0] == lib

    if defined? Puma::WILD_ARGS
      @restart_argv = arg0 + Puma::WILD_ARGS + ARGV
    else
      @restart_argv = arg0 + ARGV
    end
  end
end

#graceful_stopObject



324
325
326
327
328
# File 'lib/puma/cli.rb', line 324

def graceful_stop
  @runner.stop_blocked
  log "=== puma shutdown: #{Time.now} ==="
  log "- Goodbye!"
end

#haltObject



600
601
602
603
# File 'lib/puma/cli.rb', line 600

def halt
  @status = :halt
  @runner.halt
end

#jruby?Boolean

Returns:

  • (Boolean)


77
78
79
# File 'lib/puma/cli.rb', line 77

def jruby?
  IS_JRUBY
end

#jruby_daemon_startObject



383
384
385
386
# File 'lib/puma/cli.rb', line 383

def jruby_daemon_start
  require 'puma/jruby_restart'
  JRubyRestart.daemon_start(@restart_dir, restart_args)
end

#log(str) ⇒ Object

Delegate log to @events



61
62
63
# File 'lib/puma/cli.rb', line 61

def log(str)
  @events.log str
end

#parse_optionsObject

:nodoc:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/puma/cli.rb', line 294

def parse_options
  @parser.parse! @argv

  if @argv.last
    @options[:rackup] = @argv.shift
  end

  find_config

  @config = Puma::Configuration.new @options

  # Advertise the Configuration
  Puma.cli_config = @config

  @config.load

  if clustered?
    unsupported "worker mode not supported on JRuby or Windows",
                jruby? || windows?
  end

  if @options[:daemon] and windows?
    unsupported "daemon mode not supported on Windows"
  end
end

#phased_restartObject



584
585
586
587
588
589
590
# File 'lib/puma/cli.rb', line 584

def phased_restart
  unless @runner.respond_to?(:phased_restart) and @runner.phased_restart
    log "* phased-restart called but not available, restarting normally."
    return restart
  end
  true
end

#prune_bundler?Boolean

Returns:

  • (Boolean)


444
445
446
# File 'lib/puma/cli.rb', line 444

def prune_bundler?
  @options[:prune_bundler] && clustered? && !@options[:preload_app]
end

#redirect_ioObject



592
593
594
# File 'lib/puma/cli.rb', line 592

def redirect_io
  @runner.redirect_io
end

#reload_worker_directoryObject



580
581
582
# File 'lib/puma/cli.rb', line 580

def reload_worker_directory
  @runner.reload_worker_directory if @runner.respond_to?(:reload_worker_directory)
end

#restartObject



575
576
577
578
# File 'lib/puma/cli.rb', line 575

def restart
  @status = :restart
  @runner.restart
end

#restart!Object



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# File 'lib/puma/cli.rb', line 388

def restart!
  @options[:on_restart].each do |block|
    block.call self
  end

  if jruby?
    @binder.listeners.each_with_index do |(str,io),i|
      io.close

      # We have to unlink a unix socket path that's not being used
      uri = URI.parse str
      if uri.scheme == "unix"
        path = "#{uri.host}#{uri.path}"
        File.unlink path
      end
    end

    require 'puma/jruby_restart'
    JRubyRestart.chdir_exec(@restart_dir, restart_args)

  elsif windows?
    @binder.listeners.each_with_index do |(str,io),i|
      io.close

      # We have to unlink a unix socket path that's not being used
      uri = URI.parse str
      if uri.scheme == "unix"
        path = "#{uri.host}#{uri.path}"
        File.unlink path
      end
    end

    argv = restart_args

    Dir.chdir @restart_dir

    argv += [redirects] unless RUBY_VERSION < '1.9'
    Kernel.exec(*argv)

  else
    redirects = {:close_others => true}
    @binder.listeners.each_with_index do |(l,io),i|
      ENV["PUMA_INHERIT_#{i}"] = "#{io.to_i}:#{l}"
      redirects[io.to_i] = io.to_i
    end

    argv = restart_args

    Dir.chdir @restart_dir

    argv += [redirects] unless RUBY_VERSION < '1.9'

    Kernel.exec(*argv)
  end
end

#restart_argsObject



375
376
377
378
379
380
381
# File 'lib/puma/cli.rb', line 375

def restart_args
  if cmd = @options[:restart_cmd]
    cmd.split(' ') + @original_argv
  else
    @restart_argv
  end
end

#runObject

Parse the options, load the rackup, start the server and wait for it to finish.



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# File 'lib/puma/cli.rb', line 451

def run
  begin
    parse_options
  rescue UnsupportedOption
    exit 1
  end

  if dir = @options[:directory]
    Dir.chdir dir
  end

  if prune_bundler? && defined?(Bundler)
    puma = Bundler.rubygems.loaded_specs("puma")

    dirs = puma.require_paths.map { |x| File.join(puma.full_gem_path, x) }

    puma_lib_dir = dirs.detect { |x| File.exist? File.join(x, "../bin/puma-wild") }

    deps = puma.runtime_dependencies.map { |d|
      spec = Bundler.rubygems.loaded_specs(d.name)
      "#{d.name}:#{spec.version.to_s}"
    }.join(",")

    if puma_lib_dir
      log "* Pruning Bundler environment"

      home = ENV['GEM_HOME']

      Bundler.with_clean_env do

        ENV['GEM_HOME'] = home

        wild = File.expand_path(File.join(puma_lib_dir, "../bin/puma-wild"))

        wild_loadpath = dirs.join(":")

        args = [Gem.ruby] + [wild, "-I", wild_loadpath, deps] + @original_argv

        Kernel.exec(*args)
      end
    end

    log "! Unable to prune Bundler environment, continuing"
  end

  set_rack_environment

  if clustered?
    @events.formatter = Events::PidFormatter.new
    @options[:logger] = @events

    @runner = Cluster.new(self)
  else
    @runner = Single.new(self)
  end

  setup_signals
  set_process_title

  @status = :run

  @runner.run

  case @status
  when :halt
    log "* Stopping immediately!"
  when :run, :stop
    graceful_stop
  when :restart
    log "* Restarting..."
    @runner.before_restart
    restart!
  when :exit
    # nothing
  end
end

#set_rack_environmentObject



267
268
269
270
# File 'lib/puma/cli.rb', line 267

def set_rack_environment
  @options[:environment] = env
  ENV['RACK_ENV'] = env
end

#setup_optionsObject

Build the OptionParser object to handle the available options.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/puma/cli.rb', line 93

def setup_options
  @options = {
    :min_threads => 0,
    :max_threads => 16,
    :quiet => false,
    :debug => false,
    :binds => [],
    :workers => 0,
    :daemon => false,
    :before_worker_shutdown => [],
    :before_worker_boot => [],
    :after_worker_boot => []
  }

  @parser = OptionParser.new do |o|
    o.on "-b", "--bind URI", "URI to bind to (tcp://, unix://, ssl://)" do |arg|
      @options[:binds] << arg
    end

    o.on "-C", "--config PATH", "Load PATH as a config file" do |arg|
      @options[:config_file] = arg
    end

    o.on "--control URL", "The bind url to use for the control server",
                          "Use 'auto' to use temp unix server" do |arg|
      if arg
        @options[:control_url] = arg
      elsif jruby?
        unsupported "No default url available on JRuby"
      end
    end

    o.on "--control-token TOKEN",
         "The token to use as authentication for the control server" do |arg|
      @options[:control_auth_token] = arg
    end

    o.on "-d", "--daemon", "Daemonize the server into the background" do
      @options[:daemon] = true
      @options[:quiet] = true
    end

    o.on "--debug", "Log lowlevel debugging information" do
      @options[:debug] = true
    end

    o.on "--dir DIR", "Change to DIR before starting" do |d|
      @options[:directory] = d.to_s
      @options[:worker_directory] = d.to_s
    end

    o.on "-e", "--environment ENVIRONMENT",
         "The environment to run the Rack app on (default development)" do |arg|
      @options[:environment] = arg
    end

    o.on "-I", "--include PATH", "Specify $LOAD_PATH directories" do |arg|
      $LOAD_PATH.unshift(*arg.split(':'))
    end

    o.on "-p", "--port PORT", "Define the TCP port to bind to",
                              "Use -b for more advanced options" do |arg|
      @options[:binds] << "tcp://#{Configuration::DefaultTCPHost}:#{arg}"
    end

    o.on "--pidfile PATH", "Use PATH as a pidfile" do |arg|
      @options[:pidfile] = arg
    end

    o.on "--preload", "Preload the app. Cluster mode only" do
      @options[:preload_app] = true
    end

    o.on "--prune-bundler", "Prune out the bundler env if possible" do
      @options[:prune_bundler] = true
    end

    o.on "-q", "--quiet", "Quiet down the output" do
      @options[:quiet] = true
    end

    o.on "-R", "--restart-cmd CMD",
         "The puma command to run during a hot restart",
         "Default: inferred" do |cmd|
      @options[:restart_cmd] = cmd
    end

    o.on "-S", "--state PATH", "Where to store the state details" do |arg|
      @options[:state] = arg
    end

    o.on '-t', '--threads INT', "min:max threads to use (default 0:16)" do |arg|
      min, max = arg.split(":")
      if max
        @options[:min_threads] = min
        @options[:max_threads] = max
      else
        @options[:min_threads] = 0
        @options[:max_threads] = arg
      end
    end

    o.on "--tcp-mode", "Run the app in raw TCP mode instead of HTTP mode" do
      @options[:mode] = :tcp
    end

    o.on "-V", "--version", "Print the version information" do
      puts "puma version #{Puma::Const::VERSION}"
      exit 1
    end

    o.on "-w", "--workers COUNT",
               "Activate cluster mode: How many worker processes to create" do |arg|
      @options[:workers] = arg.to_i
    end

    o.on "--tag NAME", "Additional text to display in process listing" do |arg|
      @options[:tag] = arg
    end
  end

  @parser.banner = "puma <options> <rackup file>"

  @parser.on_tail "-h", "--help", "Show help" do
    log @parser
    exit 1
  end
end

#setup_signalsObject



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
# File 'lib/puma/cli.rb', line 528

def setup_signals
  begin
    Signal.trap "SIGUSR2" do
      restart
    end
  rescue Exception
    log "*** SIGUSR2 not implemented, signal based restart unavailable!"
  end

  begin
    Signal.trap "SIGUSR1" do
      phased_restart
    end
  rescue Exception
    log "*** SIGUSR1 not implemented, signal based restart unavailable!"
  end

  begin
    Signal.trap "SIGTERM" do
      stop
    end
  rescue Exception
    log "*** SIGTERM not implemented, signal based gracefully stopping unavailable!"
  end

  begin
    Signal.trap "SIGHUP" do
      redirect_io
    end
  rescue Exception
    log "*** SIGHUP not implemented, signal based logs reopening unavailable!"
  end

  if jruby?
    Signal.trap("INT") do
      @status = :exit
      graceful_stop
      exit
    end
  end
end

#statsObject



596
597
598
# File 'lib/puma/cli.rb', line 596

def stats
  @runner.stats
end

#stopObject



570
571
572
573
# File 'lib/puma/cli.rb', line 570

def stop
  @status = :stop
  @runner.stop
end

#unsupported(str, cond = true) ⇒ Object

Raises:



85
86
87
88
89
# File 'lib/puma/cli.rb', line 85

def unsupported(str, cond=true)
  return unless cond
  @events.error str
  raise UnsupportedOption
end

#windows?Boolean

Returns:

  • (Boolean)


81
82
83
# File 'lib/puma/cli.rb', line 81

def windows?
  RUBY_PLATFORM =~ /mswin32|ming32/
end

#write_pidObject

If configured, write the pid of the current process out to a file.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/puma/cli.rb', line 245

def write_pid
  if path = @options[:pidfile]
    File.open(path, "w") do |f|
      f.puts Process.pid
    end

    cur = Process.pid

    at_exit do
      if cur == Process.pid
        delete_pidfile
      end
    end
  end
end

#write_stateObject



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/puma/cli.rb', line 222

def write_state
  write_pid

  require 'yaml'

  if path = @options[:state]
    state = { "pid" => Process.pid }

    cfg = @config.dup

    [ :logger, :before_worker_shutdown, :before_worker_boot, :after_worker_boot, :on_restart, :lowlevel_error_handler ].each { |o| cfg.options.delete o }

    state["config"] = cfg

    File.open(path, "w") do |f|
      f.write state.to_yaml
    end
  end
end