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.

Constant Summary collapse

IS_JRUBY = 
defined?(JRUBY_VERSION)

Instance Method Summary collapse

Constructor Details

#initialize(argv, stdout = STDOUT, stderr = STDERR) ⇒ 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.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/puma/cli.rb', line 23

def initialize(argv, stdout=STDOUT, stderr=STDERR)
  @argv = argv
  @stdout = stdout
  @stderr = stderr

  @events = Events.new @stdout, @stderr

  @server = nil
  @status = nil

  @restart = false
  @temp_status_path = nil

  setup_options

  generate_restart_data
end

Instance Method Details

#error(str) ⇒ Object

Write str to @stderr



100
101
102
103
 
# File 'lib/puma/cli.rb', line 100

def error(str)
  @stderr.puts "ERROR: #{str}"
  exit 1
end

#generate_restart_data ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/puma/cli.rb', line 50

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 s_env.dev == s_pwd.dev
      @restart_dir = dir
    end
  end

  @restart_dir ||= Dir.pwd

  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.exists?($0)
      @restart_argv = [Gem.ruby, $0] + ARGV
    else
      @restart_argv = [Gem.ruby, "-S", $0] + ARGV
    end
  end
end

#log(str) ⇒ Object

Write str to @stdout



94
95
96
 
# File 'lib/puma/cli.rb', line 94

def log(str)
  @stdout.puts str
end

#parse_options ⇒ Object

:nodoc:



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/puma/cli.rb', line 202

def parse_options
  @parser.parse! @argv

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

  @config = Puma::Configuration.new @options
  @config.load

  @temp_status_path = @options[:control_path_temp]
end

#restart! ⇒ Object 



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

def restart!
  if IS_JRUBY
    require 'puma/jruby_restart'
    JRubyRestart.chdir_exec(@restart_dir, Gem.ruby, *@restart_argv)
  else
    Dir.chdir @restart_dir
    Kernel.exec(*@restart_argv)
  end
end

#restart_on_stop! ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'lib/puma/cli.rb', line 41

def restart_on_stop!
  if @restart_argv
    @restart = true
    return true
  else
    return false
  end
end

#run ⇒ Object

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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
319
320
321
322
323
 
# File 'lib/puma/cli.rb', line 218

def run
  parse_options

  app = @config.app

  write_pid
  write_state

  min_t = @options[:min_threads]
  max_t = @options[:max_threads]

  server = Puma::Server.new app, @events
  server.min_threads = min_t
  server.max_threads = max_t

  log "Puma #{Puma::Const::PUMA_VERSION} starting..."
  log "* Min threads: #{min_t}, max threads: #{max_t}"

  @options[:binds].each do |str|
    uri = URI.parse str
    case uri.scheme
    when "tcp"
      log "* Listening on #{str}"
      server.add_tcp_listener uri.host, uri.port
    when "unix"
      log "* Listening on #{str}"
      path = "#{uri.host}#{uri.path}"

      server.add_unix_listener path
    when "ssl"
      log "* Listening on #{str}"
      params = Rack::Utils.parse_query uri.query
      require 'openssl'

      ctx = OpenSSL::SSL::SSLContext.new
      unless params['key']
        error "Please specify the SSL key via 'key='"
      end

      ctx.key = OpenSSL::PKey::RSA.new File.read(params['key'])

      unless params['cert']
        error "Please specify the SSL cert via 'cert='"
      end

      ctx.cert = OpenSSL::X509::Certificate.new File.read(params['cert'])

      ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE

      server.add_ssl_listener uri.host, uri.port, ctx
    else
      error "Invalid URI: #{str}"
    end
  end

  @server = server

  if str = @options[:control_url]
    require 'puma/app/status'

    uri = URI.parse str

    app = Puma::App::Status.new server, self

    if token = @options[:control_auth_token]
      app.auth_token = token unless token.empty? or token == :none
    end

    status = Puma::Server.new app, @events
    status.min_threads = 0
    status.max_threads = 1

    case uri.scheme
    when "tcp"
      log "* Starting status server on #{str}"
      status.add_tcp_listener uri.host, uri.port
    when "unix"
      log "* Starting status server on #{str}"
      path = "#{uri.host}#{uri.path}"

      status.add_unix_listener path
    else
      error "Invalid status URI: #{str}"
    end

    status.run
    @status = status
  end

  log "Use Ctrl-C to stop"

  begin
    server.run.join
  rescue Interrupt
    log " - Gracefully stopping, waiting for requests to finish"
    server.stop(true)
    log " - Goodbye!"
  end

  File.unlink @temp_status_path if @temp_status_path

  if @restart
    log "* Restarting..."
    restart!
  end
end

#setup_options ⇒ Object

Build the OptionParser object to handle the available options.



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
 
# File 'lib/puma/cli.rb', line 107

def setup_options
  @options = {
    :min_threads => 0,
    :max_threads => 16,
    :quiet => false,
    :binds => []
  }

  @parser = OptionParser.new do |o|
    o.on "-b", "--bind URI", "URI to bind to (tcp:// and unix:// only)" 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 "-p", "--port PORT", "Define what port 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 "-q", "--quiet", "Quiet down the output" do
      @options[:quiet] = true
    end

    o.on "-S", "--state PATH", "Where to store the state details" do |arg|
      @options[:state] = 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 IS_JRUBY
        raise NotImplementedError, "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 '-t', '--threads INT', "min:max threads to use (default 0:16)" do |arg|
      min, max = arg.split(":")
      if max
        @options[:min_threads] = min.to_i
        @options[:max_threads] = max.to_i
      else
        @options[:min_threads] = 0
        @options[:max_threads] = arg.to_i
      end
    end

  end

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

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

#stop ⇒ Object 



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

def stop
  @server.stop(true) if @server
end

#write_pid ⇒ Object

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



179
180
181
182
183
184
185
 
# File 'lib/puma/cli.rb', line 179

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

#write_state ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/puma/cli.rb', line 187

def write_state
  require 'yaml'

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

    state["config"] = @config

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