morpheus-cli 4.2.8 → 4.2.10

data/lib/morpheus/cli/instances.rb

@@ -3,21 +3,18 @@ require 'rest_client'
 require 'optparse'
 require 'filesize'
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/mixins/accounts_helper'
-require 'morpheus/cli/mixins/provisioning_helper'
-require 'morpheus/cli/mixins/processes_helper'
-require 'morpheus/cli/mixins/logs_helper'
-require 'morpheus/cli/option_types'
 
 class Morpheus::Cli::Instances
   include Morpheus::Cli::CliCommand
-  include Morpheus::Cli::AccountsHelper
+  include Morpheus::Cli::AccountsHelper # needed? replace with OptionSourceHelper
+  include Morpheus::Cli::OptionSourceHelper
   include Morpheus::Cli::ProvisioningHelper
   include Morpheus::Cli::ProcessesHelper
   include Morpheus::Cli::LogsHelper
+
   set_command_name :instances
   set_command_description "View and manage instances."
-  register_subcommands :list, :count, :get, :view, :add, :update, :update_notes, :remove, :cancel_removal, :logs, :history, {:'history-details' => :history_details}, {:'history-event' => :history_event_details}, :stats, :stop, :start, :restart, :actions, :action, :suspend, :eject, :backup, :backups, :stop_service, :start_service, :restart_service, :resize, :clone, :envs, :setenv, :delenv, :security_groups, :apply_security_groups, :run_workflow, :import_snapshot, :console, :status_check, {:containers => :list_containers}, :scaling, {:'scaling-update' => :scaling_update}
+  register_subcommands :list, :count, :get, :view, :add, :update, :remove, :cancel_removal, :logs, :history, {:'history-details' => :history_details}, {:'history-event' => :history_event_details}, :stats, :stop, :start, :restart, :actions, :action, :suspend, :eject, :backup, :backups, :stop_service, :start_service, :restart_service, :resize, :clone, :envs, :setenv, :delenv, :security_groups, :apply_security_groups, :run_workflow, :import_snapshot, :console, :status_check, {:containers => :list_containers}, :scaling, {:'scaling-update' => :scaling_update}
   register_subcommands :wiki, :update_wiki
   register_subcommands :exec => :execution_request
   #register_subcommands :firewall_disable, :firewall_enable
@@ -66,27 +63,31 @@ class Morpheus::Cli::Instances
       opts.on( '-H', '--host HOST', "Host Name or ID" ) do |val|
         options[:host] = val
       end
-      opts.on( '--created-by USER', "Created By User Username or ID" ) do |val|
-        options[:created_by] = val
+      opts.on( '--owner USER', "Owner Username or ID" ) do |val|
+        options[:owner] = val
+      end
+      opts.on( '--created-by USER', "Alias for --owner" ) do |val|
+        options[:owner] = val
       end
+      opts.add_hidden_option('--created-by')
       opts.on('--details', "Display more details: memory and storage usage used / max values." ) do
         options[:details] = true
       end
       opts.on('--status STATUS', "Filter by status i.e. provisioning,running,starting,stopping") do |val|
-        params['status'] ||= []
-        params['status'] << val
+        params['status'] = (params['status'] || []) + val.to_s.split(',').collect {|s| s.strip }.select {|s| s != "" }
       end
       opts.on('--pending-removal', "Include instances pending removal.") do
-        options[:pendingRemoval] = true
+        options[:showDeleted] = true
+      end
+      opts.on('--pending-removal-only', "Only instances pending removal.") do
+        options[:deleted] = true
       end
       build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
       opts.footer = "List instances."
     end
     optparse.parse!(args)
+    verify_args!(args:args, count:0, optparse:optparse)
     connect(options)
-    if args.count != 0
-      raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args}\n#{optparse}"
-    end
     begin
       params.merge!(parse_list_options(options))
       group = options[:group] ? find_group_by_name_or_id_for_provisioning(options[:group]) : nil
@@ -107,14 +108,18 @@ class Morpheus::Cli::Instances
       end
 
       account = nil
-      if options[:created_by]
-        created_by_ids = find_all_user_ids(account ? account['id'] : nil, options[:created_by])
+      #todo: user = find_available_user_option(owner_id)
+
+      if options[:owner]
+        created_by_ids = find_all_user_ids(account ? account['id'] : nil, options[:owner])
         return if created_by_ids.nil?
         params['createdBy'] = created_by_ids
+        params['ownerId'] = created_by_ids # 4.2.1+
       end
 
-      params['showDeleted'] = true if options[:pendingRemoval]
-
+      params['showDeleted'] = true if options[:showDeleted]
+      params['deleted'] = true if options[:deleted]
+      
       @instances_interface.setopts(options)
       if options[:dry_run]
         print_dry_run @instances_interface.dry.list(params)
@@ -152,8 +157,8 @@ class Morpheus::Cli::Instances
         if host
           subtitles << "Host: #{host['name']}".strip
         end
-        if options[:created_by]
-          subtitles << "Created By: #{options[:created_by]}"
+        if options[:owner]
+          subtitles << "Created By: #{options[:owner]}"
         end
         subtitles += parse_list_subtitles(options)
         print_h1 title, subtitles, options
@@ -191,13 +196,15 @@ class Morpheus::Cli::Instances
               name: instance['name'],
               connection: format_instance_connection_string(instance),
               environment: instance['instanceContext'],
-              user: instance['createdBy'].is_a?(Hash) ? instance['createdBy']['username'] : instance['createdBy'],
+              user: (instance['owner'] ? (instance['owner']['username'] || instance['owner']['id']) : (instance['createdBy'].is_a?(Hash) ? instance['createdBy']['username'] : instance['createdBy'])),
+              tenant: (instance['owner'] ? (instance['owner']['username'] || instance['owner']['id']) : (instance['createdBy'].is_a?(Hash) ? instance['createdBy']['username'] : instance['createdBy'])),
               nodes: instance['containers'].count,
               status: format_instance_status(instance, cyan),
               type: instance['instanceType']['name'],
               group: !instance['group'].nil? ? instance['group']['name'] : nil,
               cloud: !instance['cloud'].nil? ? instance['cloud']['name'] : nil,
               version: instance['instanceVersion'] ? instance['instanceVersion'] : '',
+              created: format_local_dt(instance['dateCreated']),
               cpu: cpu_usage_str + cyan,
               memory: memory_usage_str + cyan, 
               storage: storage_usage_str + cyan
@@ -206,7 +213,9 @@ class Morpheus::Cli::Instances
           }
           columns = [:id, {:name => {:max_width => 50}}, :group, :cloud, 
               :type, :version, :environment, 
-              {:user => {:display_name => "CREATED BY", :max_width => 20}}, 
+              {:created => {:display_name => "CREATED"}}, 
+              # {:tenant => {:display_name => "TENANT"}}, 
+              {:user => {:display_name => "OWNER", :max_width => 20}}, 
               :nodes, {:connection => {:max_width => 30}}, :status, :cpu, :memory, :storage]
           # custom pretty table columns ... this is handled in as_pretty_table now(), 
           # todo: remove all these.. and try to always pass rows as the json data itself..
@@ -239,9 +248,13 @@ class Morpheus::Cli::Instances
       opts.on( '-H', '--host HOST', "Host Name or ID" ) do |val|
         options[:host] = val
       end
-      opts.on( '--created-by USER', "Created By User Username or ID" ) do |val|
-        options[:created_by] = val
+      opts.on( '--owner USER', "Owner Username or ID" ) do |val|
+        options[:owner] = val
       end
+      opts.on( '--created-by USER', "Alias for --owner" ) do |val|
+        options[:owner] = val
+      end
+      opts.add_hidden_option('--created-by')
       opts.on( '-s', '--search PHRASE', "Search Phrase" ) do |phrase|
         options[:phrase] = phrase
       end
@@ -271,10 +284,11 @@ class Morpheus::Cli::Instances
       end
 
       account = nil
-      if options[:created_by]
-        created_by_ids = find_all_user_ids(account ? account['id'] : nil, options[:created_by])
+      if options[:owner]
+        created_by_ids = find_all_user_ids(account ? account['id'] : nil, options[:owner])
         return if created_by_ids.nil?
         params['createdBy'] = created_by_ids
+        # params['ownerId'] = created_by_ids # 4.2.1+
       end
       
       @instances_interface.setopts(options)
@@ -486,9 +500,7 @@ class Morpheus::Cli::Instances
   end
 
   def update(args)
-    usage = "Usage: morpheus instances update [instance] [options]"
-    options = {}
-    params = {}
+    params, payload, options = {}, {}, {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[instance]")
       opts.on('--name VALUE', String, "Name") do |val|
@@ -518,9 +530,13 @@ class Morpheus::Cli::Instances
       opts.on('--power-schedule-type ID', String, "Power Schedule Type ID") do |val|
         params['powerScheduleType'] = val == "null" ? nil : val
       end
-      opts.on('--created-by ID', String, "Created By User ID") do |val|
-        options[:created_by_id] = val
+      opts.on( '--owner USER', "Owner Username or ID" ) do |val|
+        options[:owner] = val == 'null' ? nil : val
+      end
+      opts.on( '--created-by USER', "Alias for --owner" ) do |val|
+        options[:owner] = val == 'null' ? nil : val
       end
+      opts.add_hidden_option('--created-by')
       # opts.on("--shutdown-days [DAYS]", Integer, "Automation: Shutdown Days") do |val|
       #   params['shutdownDays'] = val.to_s.empty? ? nil : val.to_i
       # end
@@ -540,141 +556,50 @@ class Morpheus::Cli::Instances
       instance = find_instance_by_name_or_id(args[0])
       return 1 if instance.nil?
       new_group = nil
-      if options[:group]
-        new_group = find_group_by_name_or_id_for_provisioning(options[:group])
-        return 1 if new_group.nil?
-        params['site'] = {'id' => new_group['id']}
-      end
-      if options[:metadata]
-        if options[:metadata] == "[]" || options[:metadata] == "null"
-          params['metadata'] = []
-        else
-          # parse string into format name:value, name:value
-          # merge IDs from current metadata
-          # todo: should allow quoted semicolons..
-          metadata_list = options[:metadata].split(",").select {|it| !it.to_s.empty? }
-          metadata_list = metadata_list.collect do |it|
-            metadata_pair = it.split(":")
-            row = {}
-            row['name'] = metadata_pair[0].to_s.strip
-            row['value'] = metadata_pair[1].to_s.strip
-            existing_metadata = (instance['metadata'] || []).find { |m| m['name'] == it['name'] }
-            if existing_metadata
-              row['id'] = existing_metadata['id']
-            end
-            row
-          end
-          params['metadata'] = metadata_list
-        end
-      end
-      params.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]
-      payload = nil
+      
+      
       if options[:payload]
         payload = options[:payload]
-        # support args and option parameters on top of payload
-        if !params.empty?
-          payload['instance'] ||= {}
-          payload['instance'].deep_merge!(params)
-        end
-      else
-        if params.empty? && options[:created_by_id].nil?
-          print_red_alert "Specify at least one option to update"
-          puts optparse
-          exit 1
-        end
-        payload = {}
-        payload['instance'] = params
-        if options[:created_by_id]
-          payload['createdById'] = options[:created_by_id].to_i
-        end
       end
-      @instances_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @instances_interface.dry.update(instance["id"], payload)
-        return
-      end
-      json_response = @instances_interface.update(instance["id"], payload)
-
-      if options[:json]
-        puts as_json(json_response, options)
-      else
-        print_green_success "Updated instance #{instance['name']}"
-        #list([])
-        get([instance['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
-      end
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
-    end
-  end
-
-  def update_notes(args)
-    usage = "Usage: morpheus instances update-notes [instance] [options]"
-    options = {}
-    params = {}
-    optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[instance]")
-      opts.on('--notes VALUE', String, "Notes content (Markdown)") do |val|
-        params['notes'] = val
-      end
-      opts.on('--file FILE', "File containing the notes content. This can be used instead of --notes") do |filename|
-        full_filename = File.expand_path(filename)
-        if File.exists?(full_filename)
-          params['notes'] = File.read(full_filename)
+      payload['instance'] ||= {}
+      payload.deep_merge!({'instance' => parse_passed_options(options)})
+
+      if options.key?(:owner) && [nil].include?(options[:owner])
+        # allow clearing
+        params['ownerId'] = nil
+      elsif options[:owner]
+        owner_id = options[:owner].to_s
+        if owner_id.to_s =~ /\A\d{1,}\Z/
+          # allow id without lookup
         else
-          print_red_alert "File not found: #{full_filename}"
-          return 1
-        end
-        # use the filename as the name by default.
-        if !params['name']
-          params['name'] = File.basename(full_filename)
+          user = find_available_user_option(owner_id)
+          return 1 if user.nil?
+          owner_id = user['id']
         end
+        params['ownerId'] = owner_id
+        #payload['createdById'] = options[:owner].to_i # pre 4.2.1 api
       end
-      opts.on(nil, '--clear', "Clear current notes") do |val|
-        params['notes'] = ""
+      if params.empty? && options[:owner].nil?
+        print_red_alert "Specify at least one option to update"
+        puts optparse
+        exit 1
       end
-      build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote])
-    end
-    optparse.parse!(args)
-    if args.count != 1
-      puts_error  "#{Morpheus::Terminal.angry_prompt}wrong number of arguments. Expected 1 and received #{args.count} #{args.inspect}\n#{optparse}"
-      return 1
-    end
-    connect(options)
-    print_error "#{yellow}DEPRECATION WARNING: `instances update-notes` is deprecated in 4.0, use `instances update-wiki` instead.#{reset}\n"
-    begin
-      instance = find_instance_by_name_or_id(args[0])
-      return 1 if instance.nil?
-      new_group = nil
-      params.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]
-      payload = nil
-      if options[:payload]
-        payload = options[:payload]
-        # support args and option parameters on top of payload
-        if !params.empty?
-          payload['instance'] ||= {}
-          payload['instance'].deep_merge!(params)
-        end
-      else
-        if params['notes'].nil?
-          v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'notes', 'type' => 'code-editor', 'fieldLabel' => 'Notes', 'required' => true, 'description' => 'Notes (Markdown)'}], options[:options])
-          params['notes'] = v_prompt['notes']
-        end
-        payload = {}
-        payload['instance'] = params
+      if !params.empty?
+        payload['instance'].deep_merge!(params)
       end
+      payload.delete('instance') if payload['instance'] && payload['instance'].empty?
+      raise_command_error "Specify at least one option to update.\n#{optparse}" if payload.empty?
       @instances_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @instances_interface.dry.update_notes(instance["id"], payload)
+        print_dry_run @instances_interface.dry.update(instance["id"], payload)
         return
       end
-      json_response = @instances_interface.update_notes(instance["id"], payload)
+      json_response = @instances_interface.update(instance["id"], payload)
 
       if options[:json]
         puts as_json(json_response, options)
       else
-        print_green_success "Updated notes for instance #{instance['name']}"
+        print_green_success "Updated instance #{instance['name']}"
         #list([])
         get([instance['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
       end
@@ -783,23 +708,11 @@ class Morpheus::Cli::Instances
 
       link = "#{@appliance_url}/login/oauth-redirect?access_token=#{@access_token}\\&redirectUri=/provisioning/instances/#{instance['id']}#!wiki"
 
-      open_command = nil
-      if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-        open_command = "start #{link}"
-      elsif RbConfig::CONFIG['host_os'] =~ /darwin/
-        open_command = "open #{link}"
-      elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
-        open_command = "xdg-open #{link}"
-      end
-
       if options[:dry_run]
-        puts "system: #{open_command}"
+        puts Morpheus::Util.open_url_command(link)
         return 0
       end
-
-      system(open_command)
-      
-      return 0
+      return Morpheus::Util.open_url(link)
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
       exit 1
@@ -976,7 +889,7 @@ class Morpheus::Cli::Instances
       opts.on( '-n', '--node NODE_ID', "Scope console to specific Container or VM" ) do |node_id|
         options[:node_id] = node_id.to_i
       end
-      build_common_options(opts, options, [:remote])
+      build_common_options(opts, options, [:dry_run, :remote])
     end
     optparse.parse!(args)
     if args.count < 1
@@ -993,13 +906,11 @@ class Morpheus::Cli::Instances
         link += "?containerId=#{options[:node_id]}"
       end
 
-      if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-        system "start #{link}"
-      elsif RbConfig::CONFIG['host_os'] =~ /darwin/
-        system "open #{link}"
-      elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
-        system "xdg-open #{link}"
+      if options[:dry_run]
+        puts Morpheus::Util.open_url_command(link)
+        return 0
       end
+      return Morpheus::Util.open_url(link)
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
       exit 1
@@ -1307,11 +1218,17 @@ class Morpheus::Cli::Instances
         "Labels" => lambda {|it| it['tags'] ? it['tags'].join(',') : '' },
         "Metadata" => lambda {|it| it['metadata'] ? it['metadata'].collect {|m| "#{m['name']}: #{m['value']}" }.join(', ') : '' },
         "Power Schedule" => lambda {|it| (it['powerSchedule'] && it['powerSchedule']['type']) ? it['powerSchedule']['type']['name'] : '' },
-        "Created By" => lambda {|it| it['createdBy'] ? (it['createdBy']['username'] || it['createdBy']['id']) : '' },
+        "Owner" => lambda {|it| 
+          if it['owner']
+            (it['owner']['username'] || it['owner']['id'])
+          else
+            it['createdBy'] ? (it['createdBy']['username'] || it['createdBy']['id']) : '' 
+          end
+        },
+        #"Tenant" => lambda {|it| it['tenant'] ? it['tenant']['name'] : '' },
         "Date Created" => lambda {|it| format_local_dt(it['dateCreated']) },
         "Nodes" => lambda {|it| it['containers'] ? it['containers'].count : 0 },
         "Connection" => lambda {|it| format_instance_connection_string(it) },
-        #"Account" => lambda {|it| it['account'] ? it['account']['name'] : '' },
         "Status" => lambda {|it| format_instance_status(it) }
       }
 
@@ -2355,7 +2272,7 @@ class Morpheus::Cli::Instances
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do|opts|
       opts.banner = subcommand_usage("[id or name list]")
-      opts.footer = "This outputs the list of the actions available to specified instance(s)."
+      opts.footer = "List the actions available to specified instance(s)."
       build_common_options(opts, options, [:json, :dry_run, :remote])
     end
     optparse.parse!(args)
@@ -2924,6 +2841,7 @@ class Morpheus::Cli::Instances
 
   def import_snapshot(args)
     options = {}
+    query_params = {}
     storage_provider_id = nil
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[instance]")
@@ -2933,9 +2851,8 @@ class Morpheus::Cli::Instances
       build_common_options(opts, options, [:auto_confirm, :json, :dry_run, :remote])
     end
     optparse.parse!(args)
-    if args.count < 1
-      puts optparse
-      exit 1
+    if args.count != 1
+      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
     end
     connect(options)
     begin
@@ -2951,7 +2868,7 @@ class Morpheus::Cli::Instances
         options[:options] ||= {}
         options[:options]['storageProviderId'] = storage_provider_id if storage_provider_id
         storage_provider_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'storageProviderId', 'type' => 'select', 'fieldLabel' => 'Storage Provider', 'optionSource' => 'storageProviders', 'required' => false, 'description' => 'Select Storage Provider.'}], options[:options], @api_client, {})
-        if !storage_provider_prompt['storageProviderId'].empty?
+        if !storage_provider_prompt['storageProviderId'].to_s.empty?
           payload['storageProviderId'] = storage_provider_prompt['storageProviderId']
         end
       rescue RestClient::Exception => e
@@ -2961,10 +2878,10 @@ class Morpheus::Cli::Instances
       end
       @instances_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @instances_interface.dry.import_snapshot(instance['id'], payload)
+        print_dry_run @instances_interface.dry.import_snapshot(instance['id'], query_params, payload)
         return
       end
-      json_response = @instances_interface.import_snapshot(instance['id'], payload)
+      json_response = @instances_interface.import_snapshot(instance['id'], query_params, payload)
       if options[:json]
         puts as_json(json_response, options)
       else
@@ -3677,9 +3594,9 @@ class Morpheus::Cli::Instances
       execution_request = json_response['executionRequest']
       print_green_success "Executing request #{execution_request['uniqueId']}"
       if do_refresh
-        Morpheus::Cli::ExecutionRequestCommand.new.handle(["get", execution_request['uniqueId'], "--refresh"])
+        Morpheus::Cli::ExecutionRequestCommand.new.handle(["get", execution_request['uniqueId'], "--refresh"]+ (options[:remote] ? ["-r",options[:remote]] : []))
       else
-        Morpheus::Cli::ExecutionRequestCommand.new.handle(["get", execution_request['uniqueId']])
+        Morpheus::Cli::ExecutionRequestCommand.new.handle(["get", execution_request['uniqueId']]+ (options[:remote] ? ["-r",options[:remote]] : []))
       end
       return 0
     rescue RestClient::Exception => e