morpheus-cli 4.2.22 → 5.2.1

data/lib/morpheus/cli/setup.rb

@@ -9,7 +9,7 @@ class Morpheus::Cli::Setup
   
   set_command_name :setup
   
-  register_subcommands :init
+  # register_subcommands :init
 
   # no authorization needed
   def connect(options={})

data/lib/morpheus/cli/shell.rb

@@ -92,6 +92,13 @@ class Morpheus::Cli::Shell
   def recalculate_auto_complete_commands
     @morpheus_commands = Morpheus::Cli::CliRegistry.all.keys.reject {|k| [:shell].include?(k) }
     @shell_commands = [:clear, :history, :reload, :help, :exit]
+    @shell_command_descriptions = {
+      :clear => "Clear terminal output and move cursor to the top", 
+      :history => "View morpheus shell command history", 
+      :reload => "Reload the shell, can be useful when developing", 
+      :help => "Print this help", 
+      :exit => "Exit the morpheus shell"
+    }
     @alias_commands = Morpheus::Cli::CliRegistry.all_aliases.keys
     @exploded_commands = []
     Morpheus::Cli::CliRegistry.all.each do |cmd, klass|
@@ -336,6 +343,11 @@ class Morpheus::Cli::Shell
     #Morpheus::Logging::DarkPrinter.puts "Shell command: #{input}"
     input = input.to_s.strip
 
+    # allow pasting in commands that have 'morpheus ' prefix
+    if input[0..(prog_name.size)] == "#{prog_name} "
+      input = input[(prog_name.size + 1)..-1] || ""
+    end
+
     if !input.empty?
 
       if input == 'exit'
@@ -345,26 +357,36 @@ class Morpheus::Cli::Shell
         return 0
         #exit 0
       elsif input == 'help'
+        out = ""
         if @temporary_shell_mode
-          puts "You are in a (temporary) morpheus shell"
+          out << "You are in a (temporary) morpheus shell\n"
         else
-          puts "You are in a morpheus shell."
+          out << "You are in a morpheus shell.\n"
         end
-        puts "See the available commands below."
+        out <<  "See the available commands below.\n"
 
-        puts "\nCommands:"
+        out << "\nCommands:"
         # commands = @morpheus_commands + @shell_commands
-        @morpheus_commands.sort.each {|cmd|
-          puts "\t#{cmd.to_s}"
+        # @morpheus_commands.sort.each {|cmd|
+        #   out <<  "\t#{cmd.to_s}\n"
+        # }
+        sorted_commands = Morpheus::Cli::CliRegistry.all.values.sort { |x,y| x.command_name.to_s <=> y.command_name.to_s }
+        sorted_commands.each {|cmd|
+          # JD: not ready to show description yet, gotta finish filling in every command first
+          # maybe change 'View and manage' to something more concise like 'Manage'
+          # out << "\t#{cmd.command_name.to_s.ljust(28, ' ')} #{cmd.command_description}\n"
+          out << "\t#{cmd.command_name.to_s}\n"
         }
         #puts "\n"
-        puts "\nShell Commands:"
+        out <<  "\nShell Commands:\n"
         @shell_commands.each {|cmd|
-          puts "\t#{cmd.to_s}"
+          # out << "\t#{cmd.to_s.ljust(28, ' ')} #{@shell_command_descriptions ? @shell_command_descriptions[cmd] : ''}\n"
+          out <<  "\t#{cmd.to_s}\n"
         }
-        puts "\n"
-        puts "For more information, see https://github.com/gomorpheus/morpheus-cli/wiki"
-        #print "\n"
+        out << "\n"
+        out << "For more information, see https://github.com/gomorpheus/morpheus-cli/wiki"
+        out << "\n"
+        print out
         return 0
       elsif input =~ /^\s*#/
         Morpheus::Logging::DarkPrinter.puts "ignored comment: #{input}" if Morpheus::Logging.debug?

data/lib/morpheus/cli/storage_providers_command.rb

@@ -42,71 +42,39 @@ class Morpheus::Cli::StorageProvidersCommand
   def list(args)
     options = {}
     params = {}
+    ref_ids = []
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage()
-      build_common_options(opts, options, [:list, :json, :yaml, :csv, :fields, :json, :dry_run, :remote])
+      opts.banner = subcommand_usage("[search]")
+      build_standard_list_options(opts, options)
       opts.footer = "List storage buckets."
     end
     optparse.parse!(args)
-    if args.count != 0
-      print_error Morpheus::Terminal.angry_prompt
-      puts_error  "wrong number of arguments, expected 0 and got #{args.count}\n#{optparse}"
-      return 1
-    end
     connect(options)
-    begin
-      params.merge!(parse_list_options(options))
-      @storage_providers_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @storage_providers_interface.dry.list(params)
-        return
-      end
-      json_response = @storage_providers_interface.list(params)
-      storage_providers = json_response["storageBuckets"]
-      if options[:json]
-        puts as_json(json_response, options, "storageBuckets")
-        return 0
-      elsif options[:yaml]
-        puts as_yaml(json_response, options, "storageBuckets")
-        return 0
-      elsif options[:csv]
-        puts records_as_csv(storage_providers, options)
-        return 0
-      end
-      title = "Morpheus Storage Buckets"
-      subtitles = []
-      subtitles += parse_list_subtitles(options)
-      print_h1 title, subtitles
-      if storage_providers.empty?
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
+    params.merge!(parse_list_options(options))
+    @storage_providers_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @storage_providers_interface.dry.list(params)
+      return
+    end
+    json_response = @storage_providers_interface.list(params)
+    storage_buckets = json_response['storageBuckets']
+    render_response(json_response, options, 'storageBuckets') do
+      print_h1 "Morpheus Storage Buckets", parse_list_subtitles(options), options
+      if storage_buckets.empty?
         print cyan,"No storage buckets found.",reset,"\n"
       else
-        rows = storage_providers.collect {|storage_provider| 
-          row = {
-            id: storage_provider['id'],
-            name: storage_provider['name'],
-            provider: format_storage_provider_type(storage_provider), 
-            bucket: format_bucket_name(storage_provider), 
-            backups: storage_provider['defaultBackupTarget'] ? 'Yes' : 'No', 
-            deployments: storage_provider['defaultDeploymentTarget'] ? 'Yes' : 'No', 
-            virtualImages: storage_provider['defaultVirtualImageTarget'] ? 'Yes' : 'No', 
-          }
-          row
-        }
-        columns = [:id, :name, {:provider => {:display_name => "Provider Type".upcase} }, {:bucket => {:display_name => "Bucket Name".upcase} }, :backups, :deployments]
-        if options[:include_fields]
-          columns = options[:include_fields]
-          rows = storage_providers
-        end
-        print cyan
-        print as_pretty_table(rows, columns, options)
-        print reset
-        print_results_pagination(json_response, {:label => "storage bucket", :n_label => "storage buckets"})
+        print as_pretty_table(storage_buckets, storage_bucket_column_definitions.upcase_keys!, options)
+        print_results_pagination(json_response)
       end
       print reset,"\n"
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
+    end
+    if storage_buckets.empty?
+      return 1, "no storage buckets found"
+    else
+      return 0, nil
     end
   end
 
@@ -1232,6 +1200,22 @@ class Morpheus::Cli::StorageProvidersCommand
 
   private
 
+  def storage_bucket_column_definitions()
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      # "Description" => 'description',
+      "Provider Type" => lambda {|it| format_storage_provider_type(it) },
+      "Bucket Name" => lambda {|it| format_bucket_name(it) },
+      # "Source" => lambda {|it| it['source'] },
+      "Backups" => lambda {|it| format_boolean(it['defaultBackupTarget']) },
+      "Deployments" => lambda {|it| format_boolean(it['defaultDeploymentTarget']) },
+      "Virtual Images" => lambda {|it| format_boolean(it['defaultVirtualImageTarget']) },
+      # "Archive Snapshots" => lambda {|it| format_boolean(it['copyToStore']) },
+      # "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+      # "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
+    }
+  end
 
   def get_storage_provider_types()
     [

data/lib/morpheus/cli/tasks.rb

@@ -27,34 +27,31 @@ class Morpheus::Cli::Tasks
     params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage()
+      opts.banner = subcommand_usage("[search]")
       opts.on('-t', '--type x,y,z', Array, "Filter by task type code(s)") do |val|
         params['taskTypeCodes'] = val
       end
-      build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
+      build_standard_list_options(opts, options)
+      opts.footer = "List tasks."
     end
     optparse.parse!(args)
+    connect(options)
     if args.count > 0
-      raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
+      options[:phrase] = args.join(" ")
     end
-    connect(options)
-    begin
-      params.merge!(parse_list_options(options))
-      @tasks_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @tasks_interface.dry.list(params)
-        return
-      end
-      json_response = @tasks_interface.list(params)
-
-      render_result = render_with_format(json_response, options, 'tasks')
-      return 0 if render_result
-      
+    params.merge!(parse_list_options(options))
+    @tasks_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @tasks_interface.dry.list(params)
+      return
+    end
+    json_response = @tasks_interface.list(params)
+    tasks = json_response['tasks']
+    render_response(json_response, options, 'tasks') do
       title = "Morpheus Tasks"
       subtitles = []
       subtitles += parse_list_subtitles(options)
       print_h1 title, subtitles
-      tasks = json_response['tasks']
       if tasks.empty?
         print cyan,"No tasks found.",reset,"\n"
       else
@@ -63,11 +60,13 @@ class Morpheus::Cli::Tasks
         print_results_pagination(json_response)
       end
       print reset,"\n"
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
     end
+    if tasks.empty?
+      return 1, "no tasks found"
+    else
+      return 0, nil
+    end
+    
   end
 
   def get(args)
@@ -334,10 +333,9 @@ class Morpheus::Cli::Tasks
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
     end
     optparse.parse!(args)
-    if args.count > 1
-      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
-    end
+    #verify_args!(args:args, count:1, optparse:optparse)
     if args[0]
+      # task_name = args[0]
       task_name = args[0]
     end
     # if task_name.nil? || task_type_name.nil?
@@ -425,6 +423,9 @@ class Morpheus::Cli::Tasks
             has_file_content = true
             it['fieldContext'] = nil
             it['fieldName'] = 'file'
+            # this should be required right!? fix api optionType data plz
+            it['required'] = true
+            it['defaultValue'] = 'local'
           else
             if it['fieldContext'].nil? || it['fieldContext'] == ''
               it['fieldContext'] = 'taskOptions'
@@ -658,9 +659,7 @@ class Morpheus::Cli::Tasks
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
     end
     optparse.parse!(args)
-    if args.count != 1
-      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
-    end
+    verify_args!(args:args, count:1, optparse:optparse)
     task_name = args[0]
     connect(options)
     begin
@@ -734,7 +733,6 @@ class Morpheus::Cli::Tasks
 
   def remove(args)
     params = {}
-    task_name = args[0]
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[task]")
@@ -744,10 +742,8 @@ class Morpheus::Cli::Tasks
       end
     end
     optparse.parse!(args)
-    if args.count < 1
-      puts optparse
-      exit 1
-    end
+    verify_args!(args:args, count:1, optparse:optparse)
+    task_name = args[0]
     connect(options)
     begin
       task = find_task_by_name_or_id(task_name)
@@ -820,6 +816,7 @@ class Morpheus::Cli::Tasks
     if args.count != 1
       raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
     end
+    verify_args!(args:args, count:1, optparse:optparse)
     task_name = args[0]
     connect(options)
     begin

data/lib/morpheus/cli/usage_command.rb

@@ -0,0 +1,203 @@
+require 'morpheus/cli/cli_command'
+
+# CLI command usages
+# UI is Costing - Usage
+# API is /usage and returns usages
+class Morpheus::Cli::UsageCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::OptionSourceHelper
+
+  set_command_name :'usage'
+
+  register_subcommands :list, :get
+  
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @usage_interface = @api_client.usage
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end
+
+  def list(args)
+    options = {}
+    params = {}
+    ref_ids = []
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[search]")
+      opts.on( '-t', '--type TYPE', "Filter by type" ) do |val|
+        params['type'] = parse_usage_type(val)
+      end
+      opts.on( '-c', '--cloud CLOUD', "Filter by cloud" ) do |val|
+        options[:cloud] = val
+      end
+      opts.on('--start DATE', String, "Start date in the format YYYY-MM-DD.") do |val|
+        params['startDate'] = val # parse_time(val).utc.iso8601
+      end
+      opts.on('--end DATE', String, "End date in the format YYYY-MM-DD. Default is the current date.") do |val|
+        params['endDate'] = val # parse_time(val).utc.iso8601
+      end
+      opts.on('--sigdig DIGITS', "Significant digits when rounding cost values for display as currency. Default is 5.") do |val|
+        options[:sigdig] = val.to_i
+      end
+      build_standard_list_options(opts, options)
+      opts.footer = "List usages."
+    end
+    optparse.parse!(args)
+    connect(options)
+    # verify_args!(args:args, optparse:optparse, count:0)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
+    params.merge!(parse_list_options(options))
+    # --cloud
+    if options[:cloud]
+      params['cloud'] = parse_id_list(options[:cloud]).collect {|cloud_id|
+        if cloud_id.to_s =~ /\A\d{1,}\Z/
+          cloud_id
+        else
+          cloud = find_cloud_option(cloud_id)
+          return 1 if cloud.nil?
+          cloud['id']
+        end
+      }
+    end
+
+    @usage_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @usage_interface.dry.list(params)
+      return
+    end
+    json_response = @usage_interface.list(params)
+    usages = json_response[usage_list_key]
+    render_response(json_response, options, usage_list_key) do
+      print_h1 "Morpheus Usages", parse_list_subtitles(options), options
+      if usages.empty?
+        print cyan,"No usages found.",reset,"\n"
+      else
+        list_columns = {
+          "ID" => 'id',
+          "Cloud" => 'zoneName',
+          "Type" => lambda {|it| format_usage_type(it) },
+          "Name" => 'name',
+          "Plan" => 'planName',
+          "Start Date" => lambda {|it| format_local_dt(it['startDate']) },
+          "End Date" => lambda {|it| format_local_dt(it['endDate']) },
+          "Usage Status" => lambda {|it| format_usage_status(it) },
+          "Usage Cost" => lambda {|it| format_money(it['costDetails']['cost'], it['currency'] || 'USD', {sigdig: (options[:sigdig] || 5)}) },
+          "Usage Price" => lambda {|it| format_money(it['price'], it['currency'] || 'USD', {sigdig: (options[:sigdig] || 5)}) },
+        }
+        print as_pretty_table(usages, list_columns.upcase_keys!, options)
+        print_results_pagination(json_response)
+      end
+      print reset,"\n"
+    end
+    if usages.empty?
+      return 1, "no usages found"
+    else
+      return 0, nil
+    end
+  end
+
+  def get(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[usage]")
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a specific usage.
+[usage] is required. This is the id of a usage record.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1)
+    connect(options)
+    id_list = parse_id_list(args)
+    return run_command_for_each_arg(id_list) do |arg|
+      _get(arg, params, options)
+    end
+  end
+
+  def _get(id, params, options)
+    usage = nil
+    @usage_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @usage_interface.dry.get(id, params)
+      return
+    end
+    json_response = @usage_interface.get(id, params)
+    usage = json_response[usage_object_key]
+    render_response(json_response, options, usage_object_key) do
+      print_h1 "Usage Details", [], options
+      print cyan
+      show_columns = {
+        "ID" => 'id',
+        "Cloud" => 'zoneName',
+        "Type" => lambda {|it| format_usage_type(it) },
+        "Name" => 'name',
+        "Plan" => 'planName',
+        "Start Date" => lambda {|it| format_local_dt(it['startDate']) },
+        "End Date" => lambda {|it| format_local_dt(it['endDate']) },
+        "Usage Status" => lambda {|it| format_usage_status(it) },
+        "Usage Cost" => lambda {|it| format_money(it['costDetails']['cost'], it['currency'] || 'USD', {sigdig: (options[:sigdig] || 5)}) },
+        "Usage Price" => lambda {|it| format_money(it['price'], it['currency'] || 'USD', {sigdig: (options[:sigdig] || 5)}) },
+      }
+      print_description_list(show_columns, usage)
+
+      # print_h2 "Applicable Prices"
+      
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+  
+  private
+
+  def usage_object_key
+    'usage'
+  end
+
+  def usage_list_key
+    'usages'
+  end
+
+  def format_usage_type(usage)
+    #return usage['costDetails']['refType']
+    ref_type = usage['costDetails'] ? usage['costDetails']['refType'].to_s : ''
+    if ref_type == 'discoveredServer'
+      'Discovered'
+    elsif ref_type == 'computeServer'
+      'Host'
+    elsif ref_type == 'container'
+      'Container'
+    else
+      ref_type.to_s
+    end
+  end
+
+  def parse_usage_type(val)
+    type_string = val.to_s.downcase
+    if type_string == 'discoveredServer'
+      'discoveredServer'
+    elsif type_string == 'host'
+      'computeServer'
+    elsif type_string == 'container'
+      'container'
+    else
+      val
+    end
+  end
+
+  def format_usage_status(usage, return_color=cyan)
+    #return usage['status'].to_s.capitalize
+    status_string = usage['status'].to_s
+    if status_string == 'stopped'
+      return "#{red}#{status_string.upcase}#{return_color}"
+    else
+      return "#{green}#{status_string.upcase}#{return_color}"
+    end
+  end
+
+end