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

.client ⇒ Object 



418
419
420
 
# File 'lib/cf/cli.rb', line 418

def client
  @@client
end

.client=(c) ⇒ Object 



422
423
424
 
# File 'lib/cf/cli.rb', line 422

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

Instance Method Details

#check_logged_in ⇒ Object 



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

def check_logged_in
  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 



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

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

#client(target = client_target) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/cf/cli.rb', line 378

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

  if (org = info[:organization])
    @@client.current_organization = @@client.organization(org)
  end

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

  @@client
rescue CFoundry::InvalidTarget
end

#client_target ⇒ Object 



307
308
309
310
311
 
# File 'lib/cf/cli.rb', line 307

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

#color_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/cf/cli.rb', line 231

def color_enabled?
  input[:color]
end

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


227
228
229
 
# File 'lib/cf/cli.rb', line 227

def debug?
  !!input[:debug]
end

#default_action ⇒ Object 



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

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

#ensure_config_dir ⇒ Object 



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

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 



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

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

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/cf/cli.rb', line 147

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

      save_token_if_it_changes do
        super
      end
    end
  end
end

#fail(msg) ⇒ Object

Raises:



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

def fail(msg)
  raise UserError, msg
end

#fail_unknown(display, name) ⇒ Object 



413
414
415
 
# File 'lib/cf/cli.rb', line 413

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

#force? ⇒ Boolean

Returns:

  • (Boolean) 


223
224
225
 
# File 'lib/cf/cli.rb', line 223

def force?
  input[:force]
end

#invalidate_client ⇒ Object 



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

def invalidate_client
  @@client = nil
  client
end

#log_error(e) ⇒ Object 



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

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 



277
278
279
280
281
282
283
 
# File 'lib/cf/cli.rb', line 277

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 



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

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 



298
299
300
301
302
303
304
305
 
# File 'lib/cf/cli.rb', line 298

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

#precondition ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cf/cli.rb', line 87

def precondition
  check_target
  check_logged_in

  unless client.current_organization
    fail "Please select an organization with 'cf target --organization ORGANIZATION_NAME'. (Get organization names from 'cf orgs'.)"
  end

  unless client.current_space
    fail "Please select a space with 'cf target --space SPACE_NAME'. (Get space names from 'cf spaces'.)"
  end
end

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


219
220
221
 
# File 'lib/cf/cli.rb', line 219

def quiet?
  input[:quiet]
end

#remove_target_info(target = client_target) ⇒ Object 



367
368
369
370
371
 
# File 'lib/cf/cli.rb', line 367

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

#sane_target_url(url) ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cf/cli.rb', line 285

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 



361
362
363
364
365
 
# File 'lib/cf/cli.rb', line 361

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

#save_targets(ts) ⇒ Object 



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

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 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/cf/cli.rb', line 162

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 



318
319
320
321
322
323
324
325
326
 
# File 'lib/cf/cli.rb', line 318

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 



271
272
273
274
275
 
# File 'lib/cf/cli.rb', line 271

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

#target_info(target = client_target) ⇒ Object 



349
350
351
 
# File 'lib/cf/cli.rb', line 349

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

#targets_info ⇒ Object 



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

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 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cf/cli.rb', line 239

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) 


235
236
237
 
# File 'lib/cf/cli.rb', line 235

def verbose?
  input[:verbose]
end

#wrap_errors ⇒ Object 



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

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 Exception => e
  log_error(e)

  msg = e.class.name
  msg << ": #{e}" unless e.to_s.empty?
  msg << "\nFor more information, see #{CF::CRASH_FILE}"
  err msg

  raise if debug?
end