morpheus-cli 5.3.2.2 → 5.4.0

data/lib/morpheus/cli/mixins/rest_command.rb

@@ -10,7 +10,8 @@
 #  * load_balancer_column_definitions() - Column definitions for the "get" command display output.
 #  * load_balancer_list_column_definitions() - Column definitions for the "list" command display output.
 #
-# # An example of a RestCommand for `morpheus load-balancers`.
+# Example of a RestCommand for `morpheus load-balancers`.
+#
 # class Morpheus::Cli::LoadBalancers
 #
 #   include Morpheus::Cli::CliCommand
@@ -21,7 +22,7 @@
 #   # and would be the default values if not set.
 #   set_rest_name :load_balancers
 #   set_rest_label "Load Balancer"
-#   set_rest_plural_label "Load Balancers"
+#   set_rest_label_plural "Load Balancers"
 #   set_rest_object_key "load_balancer"
 #   set_rest_has_type true
 #   set_rest_type "load_balancer_types"
@@ -38,7 +39,7 @@ module Morpheus::Cli::RestCommand
 
   module ClassMethods
 
-    # rest_name is the plural name of the rest command resource eg. NeatThingsCommand would be "neat_things"
+    # rest_name is the plural name of the resource eg. NeatThings would be "neat_things"
     # It is used to derive all other default rest settings key, label, etc.  
     # The default name the command name with underscores `_` instead of dashes `-`.
     def rest_name
@@ -50,7 +51,7 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_name=(v)
-      @rest_name = v
+      @rest_name = v.to_s
     end
 
     alias :set_rest_name :rest_name=
@@ -61,11 +62,11 @@ module Morpheus::Cli::RestCommand
     end
 
     def default_rest_key
-      rest_name.chomp("s")
+      rest_name.to_s.chomp("s")
     end
 
     def rest_key=(v)
-      @rest_key = v
+      @rest_key = v.to_s
     end
 
     alias :set_rest_key :rest_key=
@@ -80,7 +81,7 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_arg=(v)
-      @rest_arg = v
+      @rest_arg = v.to_s
     end
 
     alias :set_rest_arg :rest_arg=
@@ -95,26 +96,26 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_label=(v)
-      @rest_label = v
+      @rest_label = v.to_s
     end
 
     alias :set_rest_label :rest_label=
 
     # the plural version of the label eg. "Neat Things"
-    def rest_plural_label
-      @rest_plural_label || default_rest_plural_label
+    def rest_label_plural
+      @rest_label_plural || default_rest_label_plural
     end
     
-    def default_rest_plural_label
+    def default_rest_label_plural
       #rest_name.to_s.split("_").collect {|it| it.to_s.capitalize }.join(" ")
       rest_label.to_s.pluralize
     end
 
-    def rest_plural_label=(v)
-      @rest_plural_label = v
+    def rest_label_plural=(v)
+      @rest_label_plural = v.to_s
     end
     
-    alias :set_rest_plural_label :rest_plural_label=
+    alias :set_rest_label_plural :rest_label_plural=
 
     # rest_interface_name is the interface name for the resource. eg. "neat_things"
     def rest_interface_name
@@ -126,7 +127,7 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_interface_name=(v)
-      @rest_interface_name = v
+      @rest_interface_name = v.to_s
     end
 
     alias :set_rest_interface_name :rest_interface_name=
@@ -158,7 +159,7 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_type_name=(v)
-      @rest_type_name = v
+      @rest_type_name = v.to_s
     end
 
     alias :set_rest_type_name :rest_type_name=
@@ -175,7 +176,7 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_type_key=(v)
-      @rest_type_key = v
+      @rest_type_key = v.to_s
     end
 
     alias :set_rest_type_key :rest_type_key=
@@ -190,7 +191,7 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_type_arg=(v)
-      @rest_type_arg = v
+      @rest_type_arg = v.to_s
     end
 
     alias :set_rest_type_arg :rest_type_arg=
@@ -205,26 +206,26 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_type_label=(v)
-      @rest_type_label = v
+      @rest_type_label = v.to_s
     end
 
     alias :set_rest_type_label :rest_type_label=
 
     # the plural version of the label eg. "Neat Things"
-    def rest_type_plural_label
-      @rest_type_plural_label || default_rest_type_plural_label
+    def rest_type_label_plural
+      @rest_type_label_plural || default_rest_type_label_plural
     end
     
-    def default_rest_type_plural_label
+    def default_rest_type_label_plural
       #rest_type_name.to_s.split("_").collect {|it| it.to_s.capitalize }.join(" ")
       rest_type_label.to_s.pluralize
     end
 
-    def rest_type_plural_label=(v)
-      @rest_type_plural_label = v
+    def rest_type_label_plural=(v)
+      @rest_type_label_plural = v.to_s
     end
     
-    alias :set_rest_type_plural_label :rest_type_plural_label=
+    alias :set_rest_type_label_plural :rest_type_label_plural=
 
     # the name of the default interface, matches the rest name eg. "neat_things"
     def rest_type_interface_name
@@ -236,7 +237,7 @@ module Morpheus::Cli::RestCommand
     end
 
     def rest_type_interface_name=(v)
-      @rest_type_interface_name = v
+      @rest_type_interface_name = v.to_s
     end
 
     alias :set_rest_type_interface_name :rest_type_interface_name=
@@ -247,7 +248,7 @@ module Morpheus::Cli::RestCommand
     def register_interfaces(*interfaces)
       @registered_interfaces ||= []
       interfaces.flatten.each do |it|
-        @registered_interfaces << it.to_sym
+        @registered_interfaces << it.to_s
       end
       # put the default rest_interface first
       if rest_interface_name && !@registered_interfaces.include?(rest_interface_name)
@@ -300,8 +301,8 @@ module Morpheus::Cli::RestCommand
     self.class.rest_label
   end
 
-  def rest_plural_label
-    self.class.rest_plural_label
+  def rest_label_plural
+    self.class.rest_label_plural
   end
 
   def rest_interface_name
@@ -356,8 +357,8 @@ module Morpheus::Cli::RestCommand
     self.class.rest_type_label
   end
 
-  def rest_type_plural_label
-    self.class.rest_type_plural_label
+  def rest_type_label_plural
+    self.class.rest_type_label_plural
   end
 
   def rest_type_interface_name
@@ -415,9 +416,12 @@ module Morpheus::Cli::RestCommand
     params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage()
+      opts.banner = subcommand_usage("[search]")
       build_standard_list_options(opts, options)
-      opts.footer = "List #{rest_plural_label.downcase}."
+            opts.footer = <<-EOT
+List #{rest_label_plural.downcase}.
+[search] is optional. This is a search phrase to filter the results.
+EOT
     end
     optparse.parse!(args)
     connect(options)
@@ -433,9 +437,9 @@ module Morpheus::Cli::RestCommand
     json_response = rest_interface.list(params)
     render_response(json_response, options, rest_list_key) do
       records = json_response[rest_list_key]
-      print_h1 "Morpheus #{rest_plural_label}"
+      print_h1 "Morpheus #{rest_label_plural}"
       if records.nil? || records.empty?
-        print cyan,"No #{rest_plural_label.downcase} found.",reset,"\n"
+        print cyan,"No #{rest_label_plural.downcase} found.",reset,"\n"
       else
         print as_pretty_table(records, rest_list_column_definitions.upcase_keys!, options)
         print_results_pagination(json_response) if json_response['meta']
@@ -449,7 +453,7 @@ module Morpheus::Cli::RestCommand
     params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[type]")
+      opts.banner = subcommand_usage("[#{rest_arg}]")
       build_standard_get_options(opts, options)
       opts.footer = <<-EOT
 Get details about #{a_or_an(rest_label)} #{rest_label.downcase}.
@@ -500,21 +504,27 @@ EOT
   end
 
   def add(args)
+    record_type = nil
     record_type_id = nil
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[#{rest_arg}]")
       if rest_has_type
-        opts.banner = subcommand_usage("[name] -t TYPE")
         opts.on( '-t', "--#{rest_type_arg} TYPE", "#{rest_type_label}" ) do |val|
           record_type_id = val
         end
-      else
-        opts.banner = subcommand_usage("[name]")
       end
-      # if defined?(add_#{rest_key}_option_types)
-      #   build_option_type_options(opts, options, add_#{rest_key}_option_types)
-      # end
+      if self.class.method_defined?("add_#{rest_key}_option_types")
+        build_option_type_options(opts, options, self.send("add_#{rest_key}_option_types"))
+      end
+      if self.class.method_defined?("add_#{rest_key}_advanced_option_types")
+        build_option_type_options(opts, options, self.send("add_#{rest_key}_advanced_option_types"))
+      end
       build_standard_add_options(opts, options)
+      opts.footer = <<-EOT
+Create a new #{rest_label.downcase}.
+[#{rest_arg}] is required. This is the name of the new #{rest_label.downcase}.
+EOT
     end
     optparse.parse!(args)
     # todo: make supporting args[0] optional and more flexible
@@ -524,14 +534,15 @@ EOT
       record_name = args[0]
     end
     verify_args!(args:args, optparse:optparse, min:0, max: 1)
-    # todo: maybe need a flag to make this required, it could be an option type too, so
+    connect(options)
+    # load or prompt for type
     if rest_has_type
       if record_type_id.nil?
-        raise_command_error "#{rest_type_label} is required.\n#{optparse}"
+        #raise_command_error "#{rest_type_label} is required.\n#{optparse}"
+        type_list = rest_type_interface.list({max:10000})[rest_type_list_key]
+        type_dropdown_options = type_list.collect {|it| {'name' => it['name'], 'value' => it['code']} }
+        record_type_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'type', 'fieldLabel' => rest_type_label, 'type' => 'select', 'selectOptions' => type_dropdown_options, 'required' => true}], options[:options], @api_client)['type']
       end
-    end
-    connect(options)
-    if rest_has_type
       record_type = rest_type_find_by_name_or_id(record_type_id)
       if record_type.nil?
         raise_command_error "#{rest_type_label} not found for '#{record_type_id}'.\n#{optparse}"
@@ -549,11 +560,21 @@ EOT
         options[:options]['name'] = record_name # injected for prompt
       end
       if rest_has_type && record_type
-        # record_payload['type'] = {'code' => record_type['code']}
+        # inject type to options for prompting
         record_payload['type'] = record_type['code']
-        options[:options]['type'] = record_type['code'] # injected for prompt
+        options[:options]['type'] = record_type['code']
+        # initialize params for loading optionSource data
+        options[:params] ||= {}
+        options[:params]['type'] = record_type['code']
       end
       record_payload.deep_merge!(passed_options)
+      if self.class.method_defined?("add_#{rest_key}_option_types")
+        add_option_types = self.send("add_#{rest_key}_option_types")
+        v_prompt = Morpheus::Cli::OptionTypes.prompt(add_option_types, options[:options], @api_client, options[:params])
+        v_prompt.deep_compact!
+        v_prompt.booleanize! # 'on' => true
+        record_payload.deep_merge!(v_prompt)
+      end
       # options by type
       my_option_types = record_type ? record_type['optionTypes'] : nil
       if my_option_types && !my_option_types.empty?
@@ -568,6 +589,14 @@ EOT
         v_prompt.booleanize! # 'on' => true
         record_payload.deep_merge!(v_prompt)
       end
+      # advanced options (uses no_prompt)
+      if self.class.method_defined?("add_#{rest_key}_advanced_option_types")
+        add_advanced_option_types = self.send("add_#{rest_key}_advanced_option_types")
+        v_prompt = Morpheus::Cli::OptionTypes.no_prompt(add_advanced_option_types, options[:options], @api_client, options[:params])
+        v_prompt.deep_compact!
+        v_prompt.booleanize! # 'on' => true
+        record_payload.deep_merge!(v_prompt)
+      end
       payload[rest_object_key] = record_payload
     end
     rest_interface.setopts(options)
@@ -586,24 +615,93 @@ EOT
 
   def update(args)
     id = args[0]
+    record_type = nil
+    record_type_id = nil
     options = {}
-    params = {}
-    account_name = nil
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[#{rest_arg}] [options]")
+      if self.class.method_defined?("update_#{rest_key}_option_types")
+        build_option_type_options(opts, options, self.send("update_#{rest_key}_option_types"))
+      end
+      if self.class.method_defined?("update_#{rest_key}_advanced_option_types")
+        build_option_type_options(opts, options, self.send("update_#{rest_key}_advanced_option_types"))
+      end
       build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Update an existing #{rest_label.downcase}.
+[#{rest_arg}] is required. This is the name or id of #{a_or_an(rest_label)} #{rest_label.downcase}.
+EOT
     end
     optparse.parse!(args)
     verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
     record = rest_find_by_name_or_id(id)
+    if record.nil?
+      return 1, "#{rest_name} not found for '#{id}'"
+    end
+    # load type so we can prompt for those option types
+    if rest_has_type
+      record_type_id = record['type']['id']
+      record_type = rest_type_find_by_name_or_id(record_type_id)
+      if record_type.nil?
+        raise_command_error "#{rest_type_label} not found for '#{record_type_id}'.\n#{optparse}"
+      end
+    end
     passed_options = parse_passed_options(options)
-    payload = nil
+    payload = {}
     if options[:payload]
       payload = options[:payload]
       payload.deep_merge!({rest_object_key => passed_options}) unless passed_options.empty?
     else
       record_payload = passed_options
+      if rest_has_type && record_type
+        # inject type to options for prompting
+        # record_payload['type'] = record_type['code']
+        # options[:options]['type'] = record_type['code']
+        # initialize params for loading optionSource data
+        options[:params] ||= {}
+        options[:params]['type'] = record_type['code']
+      end
+      # update options without prompting by default
+      if self.class.method_defined?("update_#{rest_key}_option_types")
+        update_option_types = self.send("update_#{rest_key}_option_types")
+        v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_option_types, options[:options], @api_client, options[:params])
+        v_prompt.deep_compact!
+        v_prompt.booleanize! # 'on' => true
+        record_payload.deep_merge!(v_prompt)
+      end
+      # options by type
+      my_option_types = record_type ? record_type['optionTypes'] : nil
+      if my_option_types && !my_option_types.empty?
+        # remove redundant fieldContext
+        # make them optional for updates
+        # todo: use current value as default instead of just making things optioanl
+        # maybe new prompt() options like {:mode => :edit, :object => storage_server} or something
+        my_option_types.each do |option_type| 
+          if option_type['fieldContext'] == rest_object_key
+            option_type['fieldContext'] = nil
+          end
+          option_type.delete('required')
+          option_type.delete('defaultValue')
+        end
+        v_prompt = Morpheus::Cli::OptionTypes.no_prompt(my_option_types, options[:options], @api_client, options[:params])
+        v_prompt.deep_compact!
+        v_prompt.booleanize! # 'on' => true
+        record_payload.deep_merge!(v_prompt)
+      end
+      # advanced options
+      if self.class.method_defined?("update_#{rest_key}_advanced_option_types")
+        update_advanced_option_types = self.send("update_#{rest_key}_advanced_option_types")
+        v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_advanced_option_types, options[:options], @api_client, options[:params])
+        v_prompt.deep_compact!
+        v_prompt.booleanize! # 'on' => true
+        record_payload.deep_merge!(v_prompt)
+      end
+      # remove empty config, compact could hanlde this
+      if record_payload['config'] && record_payload['config'].empty?
+        record_payload.delete('config')
+      end
+      # prevent updating with empty payload
       if record_payload.empty?
         raise_command_error "Specify at least one option to update.\n#{optparse}"
       end
@@ -629,6 +727,10 @@ EOT
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[#{rest_arg}]")
       build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete an existing #{rest_label.downcase}.
+[#{rest_arg}] is required. This is the name or id of #{a_or_an(rest_label)} #{rest_label.downcase}.
+EOT
     end
     optparse.parse!(args)
     verify_args!(args:args, optparse:optparse, count:1)