Class: CF::CLI

Inherits:
Mothership
  • Object
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

.clientObject


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

def client
  @@client
end

.client=(c) ⇒ Object


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

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

Instance Method Details

#add_exception_name_to_msg(e) ⇒ Object


180
181
182
183
184
# File 'lib/cf/cli.rb', line 180

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

#build_client(target, token = nil) ⇒ Object


435
436
437
438
439
440
# File 'lib/cf/cli.rb', line 435

def build_client(target, token = nil)
  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
end

#check_logged_inObject


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

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_targetObject


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

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

#client(target = client_target) ⇒ Object


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

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 = build_client(target, token)

  @@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_targetObject


338
339
340
# File 'lib/cf/cli.rb', line 338

def client_target
  return File.read(target_file).chomp if File.exists?(target_file)
end

#color_enabled?Boolean

Returns:

  • (Boolean)

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

def color_enabled?
  input[:color]
end

#debug?Boolean

Returns:

  • (Boolean)

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

def debug?
  !!input[:debug]
end

#default_actionObject


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

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

#ensure_config_dirObject


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

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


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

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

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


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

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:


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

def fail(msg)
  raise UserError, msg
end

#fail_unknown(display, name) ⇒ Object


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

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

#force?Boolean

Returns:

  • (Boolean)

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

def force?
  input[:force]
end

#formatted_exception_output(e, msg) ⇒ Object


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

def formatted_exception_output(e, msg)
  log_error(e)
  err msg

  raise if debug?
end

#helpObject


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# 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?
    puts "#{help_header}"

    Mothership::Help.print_help_groups(@@global, true)
  else
    Mothership::Help.basic_help(@@commands, @@global)
  end
end

#help_headerObject


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

def help_header
<<EOS
Cloud Foundry Command Line Interface, version [#{CF::VERSION}]
  Use '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_clientObject


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

def invalidate_client
  @@client = nil
  client
end

#log_error(e) ⇒ Object


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

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

#log_error_and_dump_crashlog(e) ⇒ Object


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

def log_error_and_dump_crashlog(e)
  log_error(e)
  err File.open(File.expand_path(CF::CRASH_FILE)).readlines.join("")

  raise if debug?
end

#name_list(xs) ⇒ Object


316
317
318
319
320
321
322
# File 'lib/cf/cli.rb', line 316

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


370
371
372
373
374
375
376
# File 'lib/cf/cli.rb', line 370

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


329
330
331
332
333
334
335
336
# File 'lib/cf/cli.rb', line 329

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)

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

def quiet?
  input[:quiet]
end

#remove_target_info(target = client_target) ⇒ Object


396
397
398
399
400
# File 'lib/cf/cli.rb', line 396

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

#sane_target_url(url) ⇒ Object


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

def sane_target_url(url)
  url = "https://#{url}" if url !~ /^http/
  url.gsub(/\/$/, "")
end

#save_target_info(info, target = client_target) ⇒ Object


390
391
392
393
394
# File 'lib/cf/cli.rb', line 390

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

#save_targets(ts) ⇒ Object


382
383
384
385
386
387
388
# File 'lib/cf/cli.rb', line 382

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_changesObject


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/cf/cli.rb', line 201

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


347
348
349
350
351
352
353
354
355
# File 'lib/cf/cli.rb', line 347

def set_target(url)
  ensure_config_dir

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

  invalidate_client
end

#table(headers, rows) ⇒ Object


310
311
312
313
314
# File 'lib/cf/cli.rb', line 310

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

#target_info(target = client_target) ⇒ Object


378
379
380
# File 'lib/cf/cli.rb', line 378

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

#targets_infoObject


357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/cf/cli.rb', line 357

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_colorsObject


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
# File 'lib/cf/cli.rb', line 278

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)

274
275
276
# File 'lib/cf/cli.rb', line 274

def verbose?
  input[:verbose]
end

#wrap_errorsObject


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

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 CFoundry::APIError => e
  formatted_exception_output(e, add_exception_name_to_msg(e))
rescue Exception => e
  log_error_and_dump_crashlog(e)
end