morpheus-cli 6.2.3 → 6.3.1

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

@@ -1,15 +1,136 @@
+require 'morpheus/cli/option_types'
+
 # Mixin for Morpheus::Cli command classes
-# Provides common methods for prompting for input
+# Provides common methods for prompting for option type inputs and forms.
+# Prompting is delegated to the {Morpheus::Cli::OptionTypes} module
+# while the provided {#prompt} simplifies the required parameters
+# The command class must establish the +@api_client+ on its own.
+#
 module Morpheus::Cli::PromptHelper
 
-	# prompt for a single option type and and return the input value
-	# @param option_type [Hash] The OptionType input record to prompt for , contians fieldName, fieldLabel, etc.
-  # @param options [Hash] The context being constructed, checks this for the value before prompting the user for input.
-  # @param no_prompt [Boolean] The context being constructed, checks this for the value before prompting the user for input.
-  # @param api_params [Hash] Optional map of parameters to include in API request for select option types
-  # @return input value for the option type, usually a string or number if the value is an ID or of type: number
-	def prompt_value(option_type, options, no_prompt=false, api_params={})
-		# this does not work with fieldContext, so get rid of it
-		return Morpheus::Cli::OptionTypes.prompt([option_type.merge({'fieldContext' => nil})], options, @api_client, api_params, no_prompt)[option_type['fieldName']]
-	end
+  # Prompt for a list of inputs (OptionType) and return a Hash containing
+  # all of the provides values.  The user is prompted to provide a value 
+  # for each input, unless the value is already set in the options.
+  # @param [Array, Hash] option_types the list of OptionType inputs with fieldName, fieldLabel, etc.
+  #   A single option type Hash can be passed instead.
+  # @param [Hash] options the standard command options
+  #   This map is a mixture of keys that are Symbols that provide some common
+  #   functionality like :no_prompt, :context_map, etc.
+  #   Any keys that are Strings get used to lookup input values, along with 
+  #   +options[:options]+ and +options[:params]+.
+  #   The precedence for providing option values is as follows: 
+  #   1. options['foo']  2. options[:params]['foo'] 3. options[:options]['foo'] 4. User is prompted.
+  # @option options [Hash] :options map of values provided by the user via the generic -O OPTIONS switch, gets merged into the context used for providing input values
+  # @option options [Hash] :params map of additional values provided by the user via explicite options, gets merged into the context used for providing input values
+  # @option options [Hash] :no_prompt supresses prompting, use default values and error if a required input is not provided. Default is of course +false+.
+  # @option options [Hash] :context_map Can to change the fieldContext of the option_types, eg. :context_map => {'networkDhcpRelay' => ''}
+  # @option options [APIClient] :api_client The {APIClient} to use for option types that request api calls. Default is the @api_client established by the class
+  # @option options [Hash] :api_params Optional map of parameters to include in API request for select option types
+  # @option options [Boolean] :paging_enabled Enable paging if there are a lot of available options to display. Default is +false+.
+  # @option options [Boolean] :ignore_empty Ignore inputs that have no options, this can be used to allow prompting to continue without error if a select input has no options.
+  # @option options [Boolean] :skip_sort Do not sort the inputs by displayOrder, assume they are already sorted. Default is +true+.
+  # @return [Hash] containing the values provided for each option type, the key is the input fieldName
+  #
+  # @example Prompt for name
+  #
+  #   results = prompt([{'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true}], options)
+  #   puts "Name: #{results['name']}"
+  #
+  def prompt(option_types, options={})
+    # option types can be passed as a single input instead of an array
+    option_types = option_types.is_a?(Hash) ? [option_types] : option_types #Array(option_types)
+    # construct options parameter for Morpheus::Cli::OptionTypes.prompt
+    options = construct_prompt_options(options)
+    # by default the @api_client established by the command is used
+    api_client = options.key?(:api_client) ? options[:api_client] : @api_client
+    api_params = options.key?(:api_params) ? options[:api_params] : {}
+    no_prompt = options.key?(:no_prompt) ? options[:no_prompt] : false
+    paging_enabled = options.key?(:paging_enabled) ? options[:paging_enabled] : true
+    ignore_empty = options.key?(:ignore_empty) ? options[:ignore_empty] : false
+    # Defaulting skip_sort to true which is the opposite of OptionTypes.prompt()
+    # The API handles sorting most of the time now, calling function can sort before prompting if needed
+    # maybe switch this later if needed, removing skip_sort would be nice though...
+    skip_sort = options.key?(:skip_sort) ? options[:skip_sort] : true
+    results = Morpheus::Cli::OptionTypes.prompt(option_types, options, api_client, api_params, no_prompt, paging_enabled, ignore_empty, skip_sort)
+    # trying to get rid of the need to do these compact and booleanize calls..
+    # for now you can use options.merge({compact: true,booleanize: true}) or modify the results yourself
+    results.deep_compact! if options[:compact]
+    results.booleanize! if options[:booleanize] # 'on' => true
+    return results
+  end
+
+  # Process 1-N inputs (OptionType) in a special 'edit mode' that supresses user interaction.
+  # This is used by +update+ commands where we want to process option types
+  # without prompting the user so that the results only contains values that are passed in explicitely as options and default values are not used.
+  # @see {#prompt} method for details on the supported options
+  #
+  def no_prompt(option_types, options={})
+    options = options.merge({:edit_mode => true, :no_prompt => true})
+    options.delete(:no_prompt) if options[:always_prompt] # --prompt to always prompt
+    return prompt(option_types, options)
+  end
+
+  # Prompt for a single input and return only the value
+  # @param [Hash] option_type the OptionType input record to prompt for, contains fieldName, fieldLabel, etc.
+  # @param [Hash] options the standard command options
+  # @see {#prompt} method for details on the supported options
+  # @return [String, Number, Hash, Array, nil] value provided by the options or user input, usually a string or a number or nil if no value is provided.
+  #
+  # @example Prompt for name value
+  #
+  #   chosen_name = prompt_value({'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true}, options)
+  #   puts "Chosen Name: #{chosen_name}"
+  #
+  def prompt_value(option_type, options={})
+    # this does not need with fieldContext, so get rid of it
+    # option_types = [option_type.merge({'fieldContext' => nil})]
+    # results = prompt(Array(option_type), options)
+    # return results[option_type['fieldName']]
+
+    # this works with fieldContext now, hooray
+    # use get_object_value() to traverse object to get the value
+    option_types = [option_type] # Array(option_type)
+    results = prompt(option_types, options)
+    return get_option_type_value(results, option_types.first)
+  end
+
+  # Process inputs of a form, prompting for its options and field groups
+  # @param [Hash] form the OptionTypeForm to process
+  # @param [Hash] options the standard command options
+  # @see {#prompt} method for defailts on the supported options
+  # @return Hash containing the values provided for each option type, the key is the fieldName
+  #
+  def prompt_form(form, options={})
+    form_results = {}
+    results = prompt(Array(form['options']), options.merge(form_results))
+    form_results.deep_merge!(results)
+    # prompt for each field group, merging results into options context as we go
+    Array(form['fieldGroups']).each do |field_group|
+      # todo: look at isCollapsible, defaultCollapsed and visibleOnCode to see if the group should
+      # if collapsed then just use options.merge({:no_prompt => true}) and maybe need to set :required => false ?
+      results = prompt(field_group['options'], options.merge(form_results))
+      form_results.deep_merge!(results)
+    end
+    return form_results
+  end
+
+  protected
+
+  # construct options parameter for Morpheus::Cli::OptionTypes.prompt
+  # This options Hash is a mixture of Symbols that provide some common functionality like :no_prompt, and :context_map, etc.
+  # String keys are used to lookup values being passed into the command in order to prevent prompting the user
+  # The precedence for providing option values is as follows: 
+  #   1. options['foo']  2. options[:params]['foo'] 3. options[:options]['foo']
+  #
+  def construct_prompt_options(options)
+    passed_options = Hash(options[:options]).select {|k,v| k.is_a?(String) }
+    params = Hash(options[:params]).select {|k,v| k.is_a?(String) }
+    return passed_options.deep_merge(params).deep_merge!(options)
+  end
+
+  def get_option_type_value(results, option_type)
+    field_key = [option_type['fieldContext'], option_type['fieldName']].select {|it| it && it != '' }.join('.')
+    get_object_value(results, field_key)
+  end
+
 end

data/lib/morpheus/cli/option_types.rb

@@ -217,6 +217,12 @@ module Morpheus
             context_map = context_map[ns.to_s]
           end
 
+          # CLI only options that need some do some inflection to decide how to prompt
+          # defaultValue is it right now..
+          if option_type[:preprocesser].is_a?(Proc)
+            option_type[:preprocesser].call(option_type, api_client, option_params)
+          end
+
           # credential type
           handle_credential_type = -> {
             credential_type = select_prompt(option_type.merge({'defaultValue' => value}), api_client, option_params.merge({'credentialTypes' => option_type['config']['credentialTypes']}), !value.nil?, nil, paging_enabled, ignore_empty, options[:edit_mode])
@@ -326,7 +332,9 @@ module Morpheus
           end
 
           if !value_found
-            if option_type['type'] == 'number'
+            if option_type['type'] == 'text'
+              value = generic_prompt(option_type)
+            elsif option_type['type'] == 'number'
               value = number_prompt(option_type)
             elsif option_type['type'] == 'password'
               value = password_prompt(option_type)
@@ -380,8 +388,10 @@ module Morpheus
               end
             elsif option_type['type'] == 'file'
               value = file_prompt(option_type)
-            elsif option_type['type'] == 'file-content'
+            elsif option_type['type'] == 'file-content' || option_type['type'] == 'fileContent'
               value = file_content_prompt(option_type, options, api_client, {})
+            elsif option_type['type'] == 'logoSelector'
+              value = file_prompt(option_type)
             elsif option_type['type'] == 'multiText'
               value = multitext_prompt(option_type)
             elsif option_type['type'] == 'azureMarketplace'
@@ -396,7 +406,6 @@ module Morpheus
               value = generic_prompt(option_type)
             end
           end
-
           # --labels x,y,z uses processValue proc to convert strings to an array
           if option_type['processValue'].is_a?(Proc)
             value = option_type['processValue'].call(value)
@@ -409,6 +418,61 @@ module Morpheus
             if value && value.is_a?(String)
               value = value.split(",").collect {|it| it.strip }
             end
+          # todo: Handle these types added with the new form fields:
+          #
+          # byteSize
+          # code-editor
+          # fileContent
+          # logoSelector
+          # keyValue
+          # textArray
+          # typeahead
+          # group
+          # cloud
+          # environment
+          # diskManager
+          # layout
+          # networkManager
+          # plan
+          # resourcePool
+          # secGroup
+          # tag
+          # httpHeader
+          elsif option_type['type'] == 'byteSize'
+            if value.to_s.empty?
+              value = 0 # nil
+            elsif value.is_a?(String)
+              if value.to_s.upcase.include?("G")
+                value = value.to_i * 1024 * 1024 * 1024
+              elsif value.to_s.upcase.include?("M")
+                value = value * 1024 * 1024
+              else
+                # assume bytes by default..
+                value = value.to_i
+              end
+            end
+          elsif option_type['type'] == 'keyValue'
+            value = try_as_json(value)
+            if value.is_a?(String)
+              map = {}
+              value.split(",").each do |it| 
+                pair = it.split("="); 
+                map[pair[0].to_s.strip] = pair[1..-1].join("=").strip
+              end
+              value = map
+            end
+          elsif option_type['type'] == 'textArray'
+            value = try_as_json(value)
+            if value.is_a?(String)
+              value = value.split(",").collect {|it| it.to_s.strip }
+            end
+          else
+            # default translation
+            # for non text inputs, try to parse value as JSON
+            # if option_type['type'] == 'group' || option_type['type'] == 'cloud' etc..
+            if value.is_a?(String) && option_type['type'] != 'text'
+              value = try_as_json(value)
+            end
           end
           context_map[field_name] = value if !(value.nil? || (value.is_a?(Hash) && value.empty?))
           parent_context_map.reject! {|k,v| k == parent_ns && (v.nil? || (v.is_a?(Hash) && v.empty?))}
@@ -526,7 +590,12 @@ module Morpheus
             if matched_options.size > 1
               print Term::ANSIColor.red, "\nInvalid Option #{option_type['fieldLabel']}: [#{use_value}]\n\n", Term::ANSIColor.reset
               print Term::ANSIColor.red, "  * #{option_type['fieldLabel']} [-O #{option_type['fieldContext'] ? (option_type['fieldContext']+'.') : ''}#{option_type['fieldName']}=] - #{option_type['description']}\n", Term::ANSIColor.reset
-              display_select_options(option_type, matched_options)
+              if matched_options && matched_options.size > 10
+                display_select_options(option_type, matched_options.first(10))
+                puts " (#{matched_options.size-10} more)"
+              else
+                display_select_options(option_type, matched_options)
+              end
               print "The value '#{input}' matched #{matched_options.size()} options.\n"
               # print "Perhaps you meant one of these? #{ored_list(matched_options.collect {|i|i[value_field]}, 3)}\n"
               print "Try using value instead of name.\n"
@@ -595,7 +664,12 @@ module Morpheus
                 if matched_options.size > 1
                   print Term::ANSIColor.red, "\nInvalid Option #{option_type['fieldLabel']}: [#{default_value}]\n\n", Term::ANSIColor.reset
                   print Term::ANSIColor.red, "  * #{option_type['fieldLabel']} [-O #{option_type['fieldContext'] ? (option_type['fieldContext']+'.') : ''}#{option_type['fieldName']}=] - #{option_type['description']}\n", Term::ANSIColor.reset
-                  display_select_options(option_type, matched_options)
+                  if matched_options && matched_options.size > 10
+                    display_select_options(option_type, matched_options.first(10))
+                    puts " (#{matched_options.size-10} more)"
+                  else
+                    display_select_options(option_type, matched_options)
+                  end
                   print "The value '#{default_value}' matched #{matched_options.size()} options.\n"
                   # print "Perhaps you meant one of these? #{ored_list(matched_options.collect {|i|i[value_field]}, 3)}\n"
                   print "Try using value instead of name.\n"
@@ -679,7 +753,12 @@ module Morpheus
             if matched_options.size > 1
               print Term::ANSIColor.red, "\nInvalid Option #{option_type['fieldLabel']}: [#{input}]\n\n", Term::ANSIColor.reset
               print Term::ANSIColor.red, "  * #{option_type['fieldLabel']} [-O #{option_type['fieldContext'] ? (option_type['fieldContext']+'.') : ''}#{option_type['fieldName']}=] - #{option_type['description']}\n", Term::ANSIColor.reset
-              display_select_options(option_type, matched_options)
+              if matched_options && matched_options.size > 10
+                display_select_options(option_type, matched_options.first(10))
+                puts " (#{matched_options.size-10} more)"
+              else
+                display_select_options(option_type, matched_options)
+              end
               print "The value '#{input}' matched #{matched_options.size()} options.\n"
               # print "Perhaps you meant one of these? #{ored_list(matched_options.collect {|i|i[value_field]}, 3)}\n"
               print "Try using value instead of name.\n"
@@ -867,7 +946,12 @@ module Morpheus
               exit 1
             else
               #help_prompt(option_type)
-              display_select_options(option_type, select_options)
+              if select_options && select_options.size > 10
+                display_select_options(option_type, select_options.first(10))
+                puts " (#{select_options.size-10} more)"
+              else
+                display_select_options(option_type, select_options)
+              end
               print "\n"
               if select_options.empty?
                 print "The value '#{input}' matched 0 options.\n"
@@ -1381,6 +1465,19 @@ module Morpheus
         end
         rtn
       end
+
+      def self.try_as_json(val)
+        if val.is_a?(String)
+          if (val.to_s[0] == '{' && val.to_s[-1] == '}') || (val.to_s[0] == '[' && val.to_s[-1] == ']')
+            begin
+              val = JSON.parse(val)
+            rescue
+              Morpheus::Logging::DarkPrinter.puts "Failed to parse option value '#{val}' as JSON" if Morpheus::Logging.debug?
+            end
+          end
+        end
+        return val
+      end
     end
   end
 end

data/lib/morpheus/cli/version.rb

@@ -1,6 +1,6 @@
 
 module Morpheus
   module Cli
-    VERSION = "6.2.3"
+    VERSION = "6.3.1"
   end
 end

data/lib/morpheus/routes.rb

@@ -50,9 +50,12 @@ module Morpheus::Routes
         "#!app-templates", # App Blueprints (blueprints)
         "#!catalog-items",
         "#!compute-type-layouts", # Cluster Layouts
+        "#!compute-type-packages", # Cluster Packages
       ],
       :'virtual-images' => {},
       options: [
+        "#!forms", # Forms
+        "#!option-types", # Inputs
         "#!option-type-lists", # Option Lists
       ],
       templates: [
@@ -181,6 +184,12 @@ module Morpheus::Routes
 
       # map well known aliases
       case(path.dasherize.pluralize)
+      # when "forms"
+      #   path = "/library/options/#!forms"
+      when "inputs"
+        path = "/library/options/#!option-types"
+      when "option-lists"
+        path = "/library/options/#!option-type-lists"
       when "backups"
         path = id ? "/backups/show" : "/backups/list"
       when "backup-jobs"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: morpheus-cli
 version: !ruby/object:Gem::Version
-  version: 6.2.3
+  version: 6.3.1
 platform: ruby
 authors:
 - David Estes
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -251,6 +251,7 @@ files:
 - lib/morpheus/api/jobs_interface.rb
 - lib/morpheus/api/key_pairs_interface.rb
 - lib/morpheus/api/library_cluster_layouts_interface.rb
+- lib/morpheus/api/library_cluster_packages_interface.rb
 - lib/morpheus/api/library_container_scripts_interface.rb
 - lib/morpheus/api/library_container_templates_interface.rb
 - lib/morpheus/api/library_container_types_interface.rb
@@ -301,6 +302,7 @@ files:
 - lib/morpheus/api/network_subnets_interface.rb
 - lib/morpheus/api/network_types_interface.rb
 - lib/morpheus/api/networks_interface.rb
+- lib/morpheus/api/option_type_forms_interface.rb
 - lib/morpheus/api/option_type_lists_interface.rb
 - lib/morpheus/api/option_types_interface.rb
 - lib/morpheus/api/options_interface.rb
@@ -430,9 +432,11 @@ files:
 - lib/morpheus/cli/commands/jobs_command.rb
 - lib/morpheus/cli/commands/key_pairs.rb
 - lib/morpheus/cli/commands/library_cluster_layouts_command.rb
+- lib/morpheus/cli/commands/library_cluster_packages_command.rb
 - lib/morpheus/cli/commands/library_container_scripts_command.rb
 - lib/morpheus/cli/commands/library_container_templates_command.rb
 - lib/morpheus/cli/commands/library_container_types_command.rb
+- lib/morpheus/cli/commands/library_forms_command.rb
 - lib/morpheus/cli/commands/library_instance_types_command.rb
 - lib/morpheus/cli/commands/library_layouts_command.rb
 - lib/morpheus/cli/commands/library_option_lists_command.rb
@@ -507,6 +511,7 @@ files:
 - lib/morpheus/cli/commands/security_package_types.rb
 - lib/morpheus/cli/commands/security_packages.rb
 - lib/morpheus/cli/commands/security_scans.rb
+- lib/morpheus/cli/commands/self_service_command.rb
 - lib/morpheus/cli/commands/service_catalog_command.rb
 - lib/morpheus/cli/commands/service_plans_command.rb
 - lib/morpheus/cli/commands/set_prompt_command.rb