Class: CF::CLI

Inherits:
Mothership show all
Includes:
Interactive, Spacing
Defined in:
lib/cf/cli.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Spacing

#indented, #justify, #line, #lines, #spaced, #start_line, #tabular, #text_width, #trim_escapes

Methods included from Interactive

#ask, #handler, #input_state, #list_choices, #prompt, #show_default

Class Method Details

.client ⇒ Object 



446
447
448
 
# File 'lib/cf/cli.rb', line 446

def client
  @@client
end

.client=(c) ⇒ Object 



450
451
452
 
# File 'lib/cf/cli.rb', line 450

def client=(c)
  @@client = c
end

Instance Method Details

#add_exception_name_to_msg(e) ⇒ Object 



175
176
177
178
179
 
# File 'lib/cf/cli.rb', line 175

def add_exception_name_to_msg(e)
  msg = e.class.name
  msg << ": #{e}" unless e.to_s.empty?
  msg
end

#check_logged_in ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cf/cli.rb', line 75

def check_logged_in
  check_target
  unless client.logged_in?
    if force?
      fail "Please log in with 'cf login'."
    else
      line c("Please log in first to proceed.", :warning)
      line
      invoke :login
      invalidate_client
    end
  end
end

#check_target ⇒ Object 



69
70
71
72
73
 
# File 'lib/cf/cli.rb', line 69

def check_target
  unless client && client.target
    fail "Please select a target with 'cf target'."
  end
end

#client(target = client_target) ⇒ Object 



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

def client(target = client_target)
  return @@client if defined?(@@client) && @@client
  return unless target

  info = target_info(target)
  token = info[:token] && CFoundry::AuthToken.from_hash(info)

  fail "V1 targets are no longer supported." if info[:version] == 1

  @@client = CFoundry::V2::Client.new(target, token)

  @@client.http_proxy = input[:http_proxy] || ENV['HTTP_PROXY'] || ENV['http_proxy']
  @@client.https_proxy = input[:https_proxy] || ENV['HTTPS_PROXY'] || ENV['https_proxy']
  @@client.trace = input[:trace]

  uri = URI.parse(target)
  @@client.log = File.expand_path("#{LOGS_DIR}/#{uri.host}.log")

  unless info.key? :version
    info[:version] = @@client.version
    save_target_info(info, target)
  end

  @@client.current_organization = @@client.organization(info[:organization]) if info[:organization]
  @@client.current_space = @@client.space(info[:space]) if info[:space]

  @@client
rescue CFoundry::InvalidTarget
end

#client_target ⇒ Object 



341
342
343
344
 
# File 'lib/cf/cli.rb', line 341

def client_target
  return File.read(target_file).chomp if File.exists?(target_file)
  sane_target_url(CF::DEFAULT_API_URL)
end

#color_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


265
266
267
 
# File 'lib/cf/cli.rb', line 265

def color_enabled?
  input[:color]
end

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
 
# File 'lib/cf/cli.rb', line 261

def debug?
  !!input[:debug]
end

#default_action ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/cf/cli.rb', line 61

def default_action
  if input[:version]
    line "cf #{VERSION}"
  else
    super
  end
end

#ensure_config_dir ⇒ Object 



346
347
348
349
 
# File 'lib/cf/cli.rb', line 346

def ensure_config_dir
  config = File.expand_path(CF::CONFIG_DIR)
  FileUtils.mkdir_p(config) unless File.exist? config
end

#err(msg, status = 1) ⇒ Object 



296
297
298
299
 
# File 'lib/cf/cli.rb', line 296

def err(msg, status = 1)
  $stderr.puts c(msg, :error)
  exit_status status
end

#execute(cmd, argv, global = {}) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/cf/cli.rb', line 181

def execute(cmd, argv, global = {})
  if input[:help]
    invoke :help, :command => cmd.name.to_s
  else
    wrap_errors do
      @command = cmd
      precondition if respond_to? :precondition

      save_token_if_it_changes do
        super
      end
    end
  end
end

#fail(msg) ⇒ Object

Raises:



301
302
303
 
# File 'lib/cf/cli.rb', line 301

def fail(msg)
  raise UserError, msg
end

#fail_unknown(display, name) ⇒ Object 



441
442
443
 
# File 'lib/cf/cli.rb', line 441

def fail_unknown(display, name)
  fail("Unknown #{display} '#{name}'.")
end

#force? ⇒ Boolean

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/cf/cli.rb', line 257

def force?
  input[:force]
end

#formatted_exception_output(e, msg) ⇒ Object 



167
168
169
170
171
172
173
 
# File 'lib/cf/cli.rb', line 167

def formatted_exception_output(e, msg)
  log_error(e)
  msg << "\ncat #{CF::CRASH_FILE} # for more details"
  err msg

  raise if debug?
end

#help ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/cf/cli.rb', line 92

def help
  if name = input[:command]
    if cmd = @@commands[name.gsub("-", "_").to_sym]
      Mothership::Help.command_help(cmd)
    else
      unknown_command(name)
    end
  elsif Help.has_groups?
    unless input[:all]
      puts "#{help_header}"
    end

    Mothership::Help.print_help_groups(@@global, input[:all])
  else
    Mothership::Help.basic_help(@@commands, @@global)
  end
end

#help_header ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/cf/cli.rb', line 110

def help_header
<<EOS
Cloud Foundry Command Line Interface, version [#{CF::VERSION}]
  Use 'cf help' for basic help, 'cf help --all' for all commands, 'cf help [command]' for command details.
  For docs and support visit http://support.cloudfoundry.com

USAGE EXAMPLES
  $ cf target api.run.pivotal.io    <-- sets the CF instance target where your app will be pushed
  $ cf push                         <-- deploys app to current app space on current target
  $ cf target -s staging            <-- changes currently targeted app space to 'staging'

EOS
end

#invalidate_client ⇒ Object 



406
407
408
409
 
# File 'lib/cf/cli.rb', line 406

def invalidate_client
  @@client = nil
  client
end

#log_error(e) ⇒ Object 



214
215
216
217
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
 
# File 'lib/cf/cli.rb', line 214

def log_error(e)
  ensure_config_dir

  msg = e.class.name
  msg << ": #{e}" unless e.to_s.empty?

  crash_file = File.expand_path(CF::CRASH_FILE)

  FileUtils.mkdir_p(File.dirname(crash_file))

  File.open(crash_file, "w") do |f|
    f.puts "Time of crash:"
    f.puts "  #{Time.now}"
    f.puts ""
    f.puts msg
    f.puts ""

    if e.respond_to?(:request_trace)
      f.puts "<<<"
      f.puts e.request_trace
    end

    if e.respond_to?(:response_trace)
      f.puts e.response_trace
      f.puts ">>>"
      f.puts ""
    end

    cf_dir = File.expand_path("../../../..", __FILE__) + "/"
    e.backtrace.each do |loc|
      if loc =~ /\/gems\//
        f.puts loc.sub(/.*\/gems\//, "")
      else
        f.puts loc.sub(cf_dir, "")
      end
    end
  end
end

#name_list(xs) ⇒ Object 



311
312
313
314
315
316
317
 
# File 'lib/cf/cli.rb', line 311

def name_list(xs)
  if xs.empty?
    d("none")
  else
    xs.collect { |x| c(x.name, :name) }.join(", ")
  end
end

#normalize_targets_info(info_by_url) ⇒ Object 



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

def normalize_targets_info(info_by_url)
  info_by_url.reduce({}) do |hash, pair|
    key, value = pair
    hash[key] = value.is_a?(String) ? { :token => value } : value
    hash
  end
end

#one_of(*paths) ⇒ Object 



332
333
334
335
336
337
338
339
 
# File 'lib/cf/cli.rb', line 332

def one_of(*paths)
  paths.each do |p|
    exp = File.expand_path(p)
    return exp if File.exist? exp
  end

  File.expand_path(paths.first)
end

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
 
# File 'lib/cf/cli.rb', line 253

def quiet?
  input[:quiet]
end

#remove_target_info(target = client_target) ⇒ Object 



400
401
402
403
404
 
# File 'lib/cf/cli.rb', line 400

def remove_target_info(target = client_target)
  ts = targets_info
  ts.delete target
  save_targets(ts)
end

#sane_target_url(url) ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/cf/cli.rb', line 319

def sane_target_url(url)
  unless url =~ /^https?:\/\//
    begin
      TCPSocket.new(url, Net::HTTP.https_default_port)
      url = "https://#{url}"
    rescue Errno::ECONNREFUSED, SocketError, Timeout::Error
      url = "http://#{url}"
    end
  end

  url.gsub(/\/$/, "")
end

#save_target_info(info, target = client_target) ⇒ Object 



394
395
396
397
398
 
# File 'lib/cf/cli.rb', line 394

def save_target_info(info, target = client_target)
  ts = targets_info
  ts[target] = info
  save_targets(ts)
end

#save_targets(ts) ⇒ Object 



386
387
388
389
390
391
392
 
# File 'lib/cf/cli.rb', line 386

def save_targets(ts)
  ensure_config_dir

  File.open(File.expand_path(CF::TOKENS_FILE), "w") do |io|
    YAML.dump(ts, io)
  end
end

#save_token_if_it_changes ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/cf/cli.rb', line 196

def save_token_if_it_changes
  return yield unless client && client.token

  before_token = client.token

  yield

  after_token = client.token

  return unless after_token

  if before_token != after_token
    info = target_info
    info[:token] = after_token.auth_header
    save_target_info(info)
  end
end

#set_target(url) ⇒ Object 



351
352
353
354
355
356
357
358
359
 
# File 'lib/cf/cli.rb', line 351

def set_target(url)
  ensure_config_dir

  File.open(File.expand_path(CF::TARGET_FILE), "w") do |f|
    f.write(sane_target_url(url))
  end

  invalidate_client
end

#table(headers, rows) ⇒ Object 



305
306
307
308
309
 
# File 'lib/cf/cli.rb', line 305

def table(headers, rows)
  tabular(
    !quiet? && headers.collect { |h| h && b(h) },
    *rows)
end

#target_info(target = client_target) ⇒ Object 



382
383
384
 
# File 'lib/cf/cli.rb', line 382

def target_info(target = client_target)
  targets_info[target] || {}
end

#targets_info ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/cf/cli.rb', line 361

def targets_info
  new_toks = File.expand_path(CF::TOKENS_FILE)

  info =
    if File.exist? new_toks
      YAML.load_file(new_toks)
    end

  info ||= {}

  normalize_targets_info(info)
end

#user_colors ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/cf/cli.rb', line 273

def user_colors
  return @user_colors if @user_colors

  colors = File.expand_path(COLORS_FILE)

  @user_colors = super.dup

  # most terminal schemes are stupid, so use cyan instead
  @user_colors.each do |k, v|
    if v == :blue
      @user_colors[k] = :cyan
    end
  end

  if File.exists?(colors)
    YAML.load_file(colors).each do |k, v|
      @user_colors[k.to_sym] = v.to_sym
    end
  end

  @user_colors
end

#verbose? ⇒ Boolean

Returns:

  • (Boolean) 


269
270
271
 
# File 'lib/cf/cli.rb', line 269

def verbose?
  input[:verbose]
end

#wrap_errors ⇒ Object 



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

def wrap_errors
  yield
rescue CFoundry::Timeout => e
  err(e.message)
rescue Interrupt
  exit_status 130
rescue Mothership::Error
  raise
rescue UserError => e
  log_error(e)
  err e.message
rescue SystemExit
  raise
rescue UserFriendlyError => e
  err e.message
rescue CFoundry::InvalidAuthToken => e
  line
  line c("Invalid authentication token. Try logging in again with 'cf login'. If problems continue, please contact your Cloud Operator.", :warning)
rescue CFoundry::Forbidden => e
  if !$cf_asked_auth
    $cf_asked_auth = true

    line
    line c("Not authenticated! Try logging in:", :warning)

    # TODO: there's no color here; global flags not being passed
    # through (mothership bug?)
    invoke :login

    retry
  end

  log_error(e)

  err "Denied: #{e.description}"
rescue CFoundry::StagingError => e
  message = "Application failed to stage"
  formatted_exception_output(e, message)

rescue Exception => e
  formatted_exception_output(e, add_exception_name_to_msg(e))
end