Class: Morpheus::Cli::FileCopyRequestCommand

Inherits:
Object
  • Object
show all
Includes:
CliCommand
Defined in:
lib/morpheus/cli/commands/file_copy_request_command.rb

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from CliCommand

#add_query_parameter, #apply_options, #build_common_options, #build_get_options, #build_list_options, #build_option_type_options, #build_standard_add_many_options, #build_standard_add_options, #build_standard_api_options, #build_standard_delete_options, #build_standard_get_options, #build_standard_list_options, #build_standard_post_options, #build_standard_put_options, #build_standard_remove_options, #build_standard_update_options, #command_description, #command_name, #confirm, #confirm!, #default_refresh_interval, #default_sigdig, #default_subcommand, #establish_remote_appliance_connection, #execute_api, #execute_api_payload, #execute_api_request, #find_all, #find_all_json, #find_by_id, #find_by_name, #find_by_name_or_id, #find_record, #find_record_json, #full_command_usage, #get_interface, #get_list_key, #get_object_key, #get_subcommand_description, #handle_each_payload, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_array, #parse_bytes_param, #parse_get_options!, #parse_id_list, #parse_labels, #parse_list_options, #parse_list_options!, #parse_list_subtitles, #parse_options, #parse_parameter_as_resource_id!, #parse_passed_options, #parse_payload, #parse_query_options, #print, #print_error, #println, #prog_name, #puts, #puts_error, #raise_args_error, #raise_command_error, #render_response, #run_command_for_each_arg, #subcommand_aliases, #subcommand_description, #subcommand_usage, #subcommands, #usage, #validate_outfile, #verify_args!, #visible_subcommands

Constructor Details

#initialize ⇒ FileCopyRequestCommand

set_default_subcommand :list



13
14
15
 
# File 'lib/morpheus/cli/commands/file_copy_request_command.rb', line 13

def initialize()
  # @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
end

Instance Method Details

#connect(opts) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/morpheus/cli/commands/file_copy_request_command.rb', line 17

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  # @instances_interface = @api_client.instances
  # @containers_interface = @api_client.containers
  # @servers_interface = @api_client.servers
  @file_copy_request_interface = @api_client.file_copy_request
end

#download(args) ⇒ Object 



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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/morpheus/cli/commands/file_copy_request_command.rb', line 232

def download(args)
  options = {}
  params = {}
  script_content = nil
  filename = nil
  do_overwrite = false
  do_mkdir = false
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[uid] [file]")
    opts.on('--file FILE', "Local file destination for the downloaded file." ) do |val|
      filename = val
    end
    opts.on( '-f', '--force', "Overwrite existing [file] if it exists." ) do
      do_overwrite = true
      # do_mkdir = true
    end
    opts.on( '-p', '--mkdir', "Create missing directories for [file] if they do not exist." ) do
      do_mkdir = true
    end
    #build_option_type_options(opts, options, add_user_source_option_types())
    build_common_options(opts, options, [:options, :json, :dry_run, :quiet, :remote])
    opts.footer = "Download a file associated with a file copy request." + "\n" +
                  "[uid] is required. This is the unique id of a file copy request." + "\n" +
                  "[file] is required. This is the full local filepath for the downloaded file."
  end
  optparse.parse!(args)
  connect(options)
  if args.count < 1 || args.count > 2
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "wrong number of arguments, expected 0 and got (#{args.count}) #{args.inspect}\n#{optparse}"
    return 1
  end
  file_copy_request_id = args[0]
  if args[1]
    filename = args[1]
  end
  outfile = File.expand_path(filename)
  if Dir.exist?(outfile)
    print_red_alert "[file] is invalid. It is the name of an existing directory: #{outfile}"
    return 1
  end
  destination_dir = File.dirname(outfile)
  if !Dir.exist?(destination_dir)
    if do_mkdir
      print cyan,"Creating local directory #{destination_dir}",reset,"\n"
      FileUtils.mkdir_p(destination_dir)
    else
      print_red_alert "[file] is invalid. Directory not found: #{destination_dir}"
      return 1
    end
  end
  if File.exist?(outfile)
    if do_overwrite
      # uhh need to be careful wih the passed filepath here..
      # don't delete, just overwrite.
      # File.delete(outfile)
    else
      print_error Morpheus::Terminal.angry_prompt
      puts_error "[file] is invalid. File already exists: #{outfile}", "Use -f to overwrite the existing file."
      # puts_error optparse
      return 1
    end
  end
  begin
    # construct payload
    
    @file_copy_request_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @file_copy_request_interface.dry.download_file_chunked(file_copy_request_id, outfile, params)
      return 0
    end
    # do it
    
    if !options[:quiet]
      print cyan + "Downloading file copy request #{file_copy_request_id} to #{outfile} ... "
    end

    http_response = @file_copy_request_interface.download_file_chunked(file_copy_request_id, outfile, params)

    # FileUtils.chmod(0600, outfile)
    success = http_response.code.to_i == 200
    if success
      if !options[:quiet]
        print green + "SUCCESS" + reset + "\n"
      end
      return 0
    else
      if !options[:quiet]
        print red + "ERROR" + reset + " HTTP #{http_response.code}" + "\n"
      end
      # F it, just remove a bad result
      if File.exist?(outfile) && File.file?(outfile)
        Morpheus::Logging::DarkPrinter.puts "Deleting bad file download: #{outfile}" if Morpheus::Logging.debug?
        File.delete(outfile)
      end
      if options[:debug]
        puts_error http_response.inspect
      end
      return 1
    end

  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#execute(args) ⇒ Object 



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
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/morpheus/cli/commands/file_copy_request_command.rb', line 129

def execute(args)
  options = {}
  params = {}
  script_content = nil
  do_refresh = true
  filename = nil
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[options]")
    opts.on('--server ID', String, "Server ID") do |val|
      params['serverId'] = val
    end
    opts.on('--instance ID', String, "Instance ID") do |val|
      params['instanceId'] = val
    end
    opts.on('--container ID', String, "Container ID") do |val|
      params['containerId'] = val
    end
    opts.on('--request ID', String, "File Copy Request ID") do |val|
      params['requestId'] = val
    end
    opts.on('--file FILE', "Local file to be copied." ) do |val|
      filename = val
    end
    opts.on('--target-path PATH', "Target path for file on destination host." ) do |val|
      params['targetPath'] = val
    end
    opts.on(nil, '--no-refresh', "Do not refresh until finished" ) do
      do_refresh = false
    end
    #build_option_type_options(opts, options, add_user_source_option_types())
    build_common_options(opts, options, [:options, :json, :dry_run, :quiet, :remote])
    opts.footer = "Copy a file to a remote host(s)." + "\n" +
                  "[server] or [instance] or [container] is required. This is the id of a server, instance or container." + "\n" +
                  "[file] is required. This is the local filename that is to be copied." + "\n" +
                  "[target-path] is required. This is the target path for the file on the destination host."
  end
  optparse.parse!(args)
  connect(options)
  if args.count != 0
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "wrong number of arguments, expected 0 and got (#{args.count}) #{args.inspect}\n#{optparse}"
    return 1
  end
  if params['serverId'].nil? && params['instanceId'].nil? && params['containerId'].nil? && params['requestId'].nil?
    puts_error "#{Morpheus::Terminal.angry_prompt}missing required option: --server or --instance or --container\n#{optparse}"
    return 1
  end
  # if filename.nil?
  #   puts_error "#{Morpheus::Terminal.angry_prompt}missing required option: --file\n#{optparse}"
  #   return 1
  # end
  # if params['targetPath'].nil?
  #   puts_error "#{Morpheus::Terminal.angry_prompt}missing required option: --target-path\n#{optparse}"
  #   return 1
  # end
  begin
    # construct payload
    params.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]
    full_filename = nil
    if filename.nil?
      v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'file', 'type' => 'file', 'fieldLabel' => 'File', 'required' => true, 'description' => 'The local file to be copied'}], options[:options])
      filename = v_prompt['file']
    end
    full_filename = File.expand_path(filename)        
    if !File.exist?(full_filename)
      print_red_alert "File not found: #{full_filename}"
      return 1
    end
    local_file = File.new(full_filename, 'rb')
    
    if params['targetPath'].nil?
      v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'targetPath', 'type' => 'text', 'fieldLabel' => 'Target Path', 'required' => true, 'description' => 'The target path for the file on the destination host.'}], options[:options])
      params['targetPath'] = v_prompt['targetPath']
    end

    @file_copy_request_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @file_copy_request_interface.dry.create(local_file, params)
      return 0
    end
    # do it
    json_response = @file_copy_request_interface.create(local_file, params)
    # print and return result
    if options[:quiet]
      return 0
    elsif options[:json]
      puts as_json(json_response, options)
      return 0
    end
    file_copy_request = json_response['fileCopyRequest']
    print_green_success "Executing file copy request #{file_copy_request['uniqueId']}"
    if do_refresh
      get([file_copy_request['uniqueId'], "--refresh"])
    else
      get([file_copy_request['uniqueId']])
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#format_file_copy_request_status(file_copy_request, return_color = cyan) ⇒ Object 



339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/morpheus/cli/commands/file_copy_request_command.rb', line 339

def format_file_copy_request_status(file_copy_request, return_color=cyan)
  out = ""
  status_str = file_copy_request['status']
  if status_str == 'complete'
    out << "#{green}#{status_str.upcase}#{return_color}"
  elsif status_str == 'failed' || status_str == 'expired'
    out << "#{red}#{status_str.upcase}#{return_color}"
  else
    out << "#{cyan}#{status_str.upcase}#{return_color}"
  end
  out
end

#get(args) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
81
82
83
84
85
86
87
88
89
90
91
92
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
 
# File 'lib/morpheus/cli/commands/file_copy_request_command.rb', line 29

def get(args)
  raw_args = args
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[uid]")
    build_common_options(opts, options, [:query, :json, :yaml, :csv, :fields, :dry_run, :remote])
    opts.on('--refresh [SECONDS]', String, "Refresh until execution is finished. Default interval is #{default_refresh_interval} seconds.") do |val|
      options[:refresh_until_finished] = true
      if !val.to_s.empty?
        options[:refresh_interval] = val.to_f
      end
    end
    opts.footer = "Get details about a file copy request." + "\n" +
                  "[uid] is required. This is the unique id of a file copy request."
  end
  optparse.parse!(args)
  connect(options)
  if args.count != 1
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "wrong number of arguments, expected 1 and got (#{args.count}) #{args.inspect}\n#{optparse}"
    return 1
  end
  file_copy_request_id = args[0]
  begin
    params.merge!(parse_list_options(options))
    @file_copy_request_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @file_copy_request_interface.dry.get(file_copy_request_id, params)
      return
    end
    json_response = @file_copy_request_interface.get(file_copy_request_id, params)
    if options[:json]
      puts as_json(json_response, options, "fileCopyRequest")
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "fileCopyRequest")
      return 0
    elsif options[:csv]
      puts records_as_csv([json_response['fileCopyRequest']], options)
      return 0
    end

    file_copy_request = json_response['fileCopyRequest']

    # refresh until a status is reached
    if options[:refresh_until_finished]
      if options[:refresh_interval].nil? || options[:refresh_interval].to_f < 0
        options[:refresh_interval] = default_refresh_interval
      end
      if ['complete','failed','expired'].include?(file_copy_request['status'])
        # it is finished
      else
        print cyan
        refresh_display_seconds = options[:refresh_interval] % 1.0 == 0 ? options[:refresh_interval].to_i : options[:refresh_interval]
        print "File copy request has not yet finished. Refreshing every #{refresh_display_seconds} seconds"
        while !['complete','failed','expired'].include?(file_copy_request['status']) do
          sleep(options[:refresh_interval])
          print cyan,".",reset
          json_response = @file_copy_request_interface.get(file_copy_request_id, params)
          file_copy_request = json_response['fileCopyRequest']
        end
        #sleep_with_dots(options[:refresh_interval])
        print "\n", reset
        # get(raw_args)
      end
    end

    print_h1 "File Copy Request Details"
    print cyan
    description_cols = {
      #"ID" => lambda {|it| it['id'] },
      "Unique ID" => lambda {|it| it['uniqueId'] },
      "Server ID" => lambda {|it| it['serverId'] },
      "Instance ID" => lambda {|it| it['instanceId'] },
      "Container ID" => lambda {|it| it['containerId'] },
      "Expires At" => lambda {|it| format_local_dt it['expiresAt'] },
      #"Exit Code" => lambda {|it| it['exitCode'] },
      "Status" => lambda {|it| format_file_copy_request_status(it) },
      #"Created By" => lambda {|it| it['createdById'] },
      #"Subdomain" => lambda {|it| it['subdomain'] },
    }
    print_description_list(description_cols, file_copy_request)      

    if file_copy_request['stdErr']
      print_h2 "Error"
      puts file_copy_request['stdErr'].to_s.strip
    end
    if file_copy_request['stdOut']
      print_h2 "Output"
      puts file_copy_request['stdOut'].to_s.strip
    end
    print reset, "\n"
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    return 1
  end
end

#handle(args) ⇒ Object 



25
26
27
 
# File 'lib/morpheus/cli/commands/file_copy_request_command.rb', line 25

def handle(args)
  handle_subcommand(args)
end