morpheus-cli 4.2.21 → 5.2.0

data/lib/morpheus/cli/cli_command.rb

@@ -194,7 +194,7 @@ module Morpheus
           if option_type['placeHolder']
             value_label = option_type['placeHolder']
           elsif option_type['type'] == 'checkbox'
-            value_label = 'on|off' # or.. true|false
+            value_label = '[on|off]' # or.. true|false
           elsif option_type['type'] == 'number'
             value_label = 'NUMBER'
           elsif option_type['type'] == 'multiSelect'
@@ -203,13 +203,23 @@ module Morpheus
           #   value_label = 'SELECT'
           # elsif option['type'] == 'select'
           end
-          opts.on("--#{full_field_name} #{value_label}", String, description) do |val|
-            # attempt to parse JSON, this allows blank arrays for multiSelect like --tenants []
-            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?
+          full_option = "--#{full_field_name} #{value_label}"
+          shorthand_option = option_type['shorthand']
+          arg1, arg2 = full_option, String
+          if option_type['shorthand']
+            arg1, arg2 = full_option, option_type['shorthand']
+          end
+          opts.on(arg1, arg2, description) do |val|
+            if option_type['type'] == 'checkbox'
+              val = (val.to_s != 'false' && val.to_s != 'off')
+            else
+              # attempt to parse JSON, this allows blank arrays for multiSelect like --tenants []
+              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
             cur_namespace = custom_options
@@ -265,6 +275,11 @@ module Morpheus
         build_standard_delete_options(opts, options, includes, excludes)
       end
       
+      # number of decimal places to show with curreny
+      def default_sigdig
+        2
+      end
+
       # appends to the passed OptionParser all the generic options
       # @param opts [OptionParser] the option parser object being constructed
       # @param options [Hash] the output Hash that is to being modified
@@ -305,6 +320,20 @@ module Morpheus
             opts.add_hidden_option('-a, --account') if opts.is_a?(Morpheus::Cli::OptionParser)
             opts.add_hidden_option('-A, --account-id') if opts.is_a?(Morpheus::Cli::OptionParser)
 
+          when :details
+            opts.on('-a', '--all', "Show all details." ) do
+              options[:details] = true
+            end
+            opts.on('--details', '--details', "Show more details" ) do
+              options[:details] = true
+            end
+            opts.add_hidden_option('--details')
+
+          when :sigdig
+            opts.on('--sigdig DIGITS', "Significant digits to display for prices (currency). Default is #{default_sigdig}.") do |val|
+              options[:sigdig] = val.to_i
+            end
+
           when :options
             options[:options] ||= {}
             opts.on( '-O', '--option OPTION', "Option in the format -O field=\"value\"" ) do |option|
@@ -489,13 +518,17 @@ module Morpheus
 
           when :query, :query_filters
             # arbitrary query parameters in the format -Q "category=web&phrase=nginx"
+            # or pass it many times like -Q foo=bar -Q hello=world
             opts.on( '-Q', '--query PARAMS', "Query parameters. PARAMS format is 'foo=bar&category=web'" ) do |val|
-              options[:query_filters_raw] = val
-              options[:query_filters] = {}
-              # todo: smarter parsing
+              if options[:query_filters_raw] && !options[:query_filters_raw].empty?
+                options[:query_filters_raw] += ("&" + val)
+              else
+                options[:query_filters_raw] = val
+              end
+              options[:query_filters] ||= {}
               val.split('&').each do |filter| 
                 k, v = filter.split('=')
-                # allow "woot:true instead of woot=true"
+                # allow woot:true instead of woot=true
                 if (k.include?(":") && v == nil)
                   k, v = k.split(":")
                 end
@@ -594,13 +627,13 @@ module Morpheus
             end
             # opts.add_hidden_option('-H') if opts.is_a?(Morpheus::Cli::OptionParser)
             # opts.add_hidden_option('--header') if opts.is_a?(Morpheus::Cli::OptionParser)
-            opts.add_hidden_option('--headers') if opts.is_a?(Morpheus::Cli::OptionParser)
+            opts.add_hidden_option('-H, --header') if opts.is_a?(Morpheus::Cli::OptionParser)
 
           #when :timeout
             opts.on( '--timeout SECONDS', "Timeout for api requests. Default is typically 30 seconds." ) do |val|
               options[:timeout] = val ? val.to_f : nil
             end
-            # opts.add_hidden_option('--timeout') if opts.is_a?(Morpheus::Cli::OptionParser)
+            opts.add_hidden_option('--timeout') if opts.is_a?(Morpheus::Cli::OptionParser)
 
           when :auto_confirm
             opts.on( '-y', '--yes', "Auto Confirm" ) do
@@ -707,7 +740,7 @@ module Morpheus
           
 
           when :dry_run
-            opts.on('-d','--dry-run', "Dry Run, print the API request instead of executing it") do
+            opts.on('-d','--dry-run', "Dry Run, print the API request instead of executing it.") do
               # todo: this should print after parsing obv..
               # need a hook after parse! or a standard_handle(options) { ... } paradigm
               # either that or hook it up in every command somehow, maybe a hook on connect()
@@ -719,7 +752,7 @@ module Morpheus
               end
               options[:dry_run] = true
             end
-            opts.on(nil,'--curl', "Dry Run to output API request as a curl command.") do
+            opts.on(nil,'--curl', "Curl, print the API request as a curl command instead of executing it.") do
               # print once and dont munge json
               if !options[:dry_run] && !options[:json]
                 puts "#{cyan}#{bold}#{dark}DRY RUN#{reset}"
@@ -822,10 +855,18 @@ module Morpheus
         opts
       end
 
+      def prog_name
+        self.class.prog_name
+      end
+
       def command_name
         self.class.command_name
       end
 
+      def command_description
+        self.class.command_description
+      end
+
       def subcommands
         self.class.subcommands
       end
@@ -862,14 +903,14 @@ module Morpheus
 
       def usage
         if !subcommands.empty?
-          "Usage: morpheus #{command_name} [command] [options]"
+          "Usage: #{prog_name} #{command_name} [command] [options]"
         else
-          "Usage: morpheus #{command_name} [options]"
+          "Usage: #{prog_name} #{command_name} [options]"
         end
       end
 
       def my_help_command
-        "morpheus #{command_name} --help"
+        "#{prog_name} #{command_name} --help"
       end
 
       def subcommand_usage(*extra)
@@ -880,7 +921,7 @@ module Morpheus
           extra.shift
         end
         #extra = ["[options]"] if extra.empty?
-        "Usage: morpheus #{command_name} #{subcommand_name} #{extra.join(' ')}".squeeze(' ').strip
+        "Usage: #{prog_name} #{command_name} #{subcommand_name} #{extra.join(' ')}".squeeze(' ').strip
       end
 
       # a string to describe the usage of your command
@@ -900,6 +941,10 @@ module Morpheus
             out << "\n"
           }
         end
+        if command_description
+          out << "\n"
+          out << "#{command_description}\n"
+        end
         # out << "\n"
         out
       end
@@ -931,7 +976,7 @@ module Morpheus
         end
         cmd_method = subcommands[subcommand_name]
         if !cmd_method
-          error_msg = "'#{command_name} #{subcommand_name}' is not a morpheus command.\n#{full_command_usage}"
+          error_msg = "'#{command_name} #{subcommand_name}' is not a #{prog_name} command.\n#{full_command_usage}"
           raise CommandNotFoundError.new(error_msg)
         end
         self.send(cmd_method, args[1..-1])
@@ -1287,6 +1332,10 @@ module Morpheus
 
       module ClassMethods
 
+        def prog_name
+          "morpheus"
+        end
+
         def set_command_name(cmd_name)
           @command_name = cmd_name
           Morpheus::Cli::CliRegistry.add(self, self.command_name)

data/lib/morpheus/cli/commands/standard/curl_command.rb

@@ -9,15 +9,20 @@ class Morpheus::Cli::CurlCommand
   set_command_hidden
 
   def handle(args)
-    split_args = args.join(" ").split(" -- ")
-    args = split_args[0].split(" ")
-    curl_args = split_args[1] ? split_args[1].split(" ") : []
+    # support syntax for arbitrary curl args after " -- " 
+    # eg. curl /api/instances -- -ksv
+    split_index = args.index("--")
+    curl_args = []
+    if split_index
+      if args.length > (split_index + 1)
+        curl_args = args[(split_index + 1)..-1]
+      end
+      args = args[0..(split_index - 1)]
+    end
     curl_method = nil
     curl_data = nil
     curl_verbsose = false
     show_progress = false
-    # puts "args is : #{args}"
-    # puts "curl_args is : #{curl_args}"
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do|opts|
       opts.banner = "Usage: morpheus curl [path] -- [*args]"
@@ -36,7 +41,7 @@ class Morpheus::Cli::CurlCommand
       opts.on( '--progress', '--progress', "Display progress output by excluding the -s option." ) do
         show_progress = true
       end
-      build_common_options(opts, options, [:dry_run, :remote])
+      build_common_options(opts, options, [:dry_run, :json, :remote])
       opts.add_hidden_option('--curl')
       #opts.add_hidden_option('--scrub')
       opts.footer = <<-EOT
@@ -98,16 +103,27 @@ EOT
     end
     curl_cmd << " \"#{url}\""
     if @access_token
-      curl_cmd << " -H \"Authorization: Bearer #{@access_token}\""
+      if !(options[:headers] && options[:headers]['Authorization'])
+        curl_cmd << " -H \"Authorization: Bearer #{@access_token}\""
+      end
     end
     if curl_data
       #todo: curl_data.gsub("'","\\'")
       curl_cmd << " --data '#{curl_data}'"
+      if api_path !~ /^\/?oauth/
+        if !(options[:headers] && options[:headers]['Content-Type'])
+          curl_cmd << " -H \"Content-Type: application/json\""
+        end
+      end
+    end
+    if options[:headers]
+      options[:headers].each do |k,v|
+        curl_cmd << " -H \"#{k}: #{v}\""
+      end
     end
     if !curl_args.empty?
       curl_cmd << " " + curl_args.join(' ')
     end
-    
     # Morpheus::Logging::DarkPrinter.puts "#{curl_cmd}" if Morpheus::Logging.debug?
     curl_cmd_str = options[:scrub] ? Morpheus::Logging.scrub_message(curl_cmd) : curl_cmd
 
@@ -124,16 +140,14 @@ EOT
     print reset
     # print result
     curl_output = `#{curl_cmd}`
-    if options[:pretty]
+    if options[:pretty] || options[:json]
       output_lines = curl_output.split("\n")
       last_line = output_lines.pop
       if output_lines.size > 0
         puts output_lines.join("\n")
       end
       begin
-        json_data = JSON.parse(last_line)
-        json_string = JSON.pretty_generate(json_data)
-        puts json_string
+        puts as_json(JSON.parse(last_line), options)
       rescue => ex
         Morpheus::Logging::DarkPrinter.puts "failed to parse curl result as JSON data Error: #{ex.message}" if Morpheus::Logging.debug?
         puts last_line

data/lib/morpheus/cli/commands/standard/history_command.rb

@@ -6,7 +6,9 @@ require 'morpheus/cli/cli_command'
 class Morpheus::Cli::HistoryCommand
   include Morpheus::Cli::CliCommand
   set_command_name :'history'
-  set_command_hidden
+  set_command_description "View morpheus shell command history"
+  # hidden for now because it is a shell command, shouldnt just be shell command though
+  set_command_hidden 
 
   # todo: support all the other :list options too, not just max
   # AND start logging every terminal command, not just shell...

data/lib/morpheus/cli/commands/standard/man_command.rb

@@ -9,7 +9,7 @@ class Morpheus::Cli::ManCommand
 
   # this should be read only anyway...
   @@default_editor = "less" # ENV['EDITOR']
-  
+
   def handle(args)
     options = {}
     regenerate = false
@@ -28,6 +28,12 @@ class Morpheus::Cli::ManCommand
       opts.on('-g','--generate', "Regenerate the manual file") do
         regenerate = true
       end
+      opts.on('-o','--out FILE', "Write manual file to a custom location") do |val|
+        options[:outfile] = val
+      end
+      opts.on('--overwrite', '--overwrite', "Overwrite output file if it already exists.") do |val|
+        options[:overwrite] = true
+      end
       opts.on('-q','--quiet', "Do not open manual, for use with the -g option.") do
         options[:quiet] = true
       end
@@ -47,7 +53,8 @@ class Morpheus::Cli::ManCommand
       end
       opts.footer = <<-EOT
 Open the morpheus manual located at #{Morpheus::Cli::ManCommand.man_file_path}
-The -g switch be used to regenerate the file.
+The -g option can be used to regenerate the file.
+The --out FILE option be used to write the manual file to a custom location.
 EOT
     end
     optparse.parse!(args)
@@ -65,18 +72,35 @@ EOT
     end
 
     fn = Morpheus::Cli::ManCommand.man_file_path
+    if options[:outfile]
+      regenerate = true
+      fn = File.expand_path(options[:outfile])
+      if File.directory?(fn)
+        # if you give me a directory, could still work and use the default filename
+        # fn = File.join(fn, "CLI-Manual-#{Morpheus::Cli::VERSION}.md")
+        # raise_command_error "outfile is invalid. It is the name of an existing directory: #{fn}"
+        print_error "#{red}Output file '#{fn}' is invalid.#{reset}\n"
+        print_error "#{red}It is the name of an existing directory.#{reset}\n"
+        return 1
+      end
+      if File.exists?(fn) && options[:overwrite] != true
+        print_error "#{red}Output file '#{fn}' already exists.#{reset}\n"
+        print_error "#{red}Use --overwrite to overwrite the existing file.#{reset}\n"
+        return 1
+      end
+    end
+    exit_code, err = 0, nil
     if regenerate || !File.exists?(fn)
       #Morpheus::Logging::DarkPrinter.puts "generating manual #{fn} ..." if Morpheus::Logging.debug? && !options[:quiet]
-      Morpheus::Cli::ManCommand.generate_manual(options)
+      exit_code, err = Morpheus::Cli::ManCommand.generate_manual(options)
     end
     
     if options[:quiet]
-      return 0, nil
+      return exit_code, err
     end
     
     Morpheus::Logging::DarkPrinter.puts "opening manual file #{fn}" if Morpheus::Logging.debug? && !options[:quiet]
     
-    
     if open_as_link # not used atm
       link = "file://#{fn}"
       if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
@@ -138,6 +162,14 @@ EOT
     # todo: use pandoc or something else to convert the CLI-Manual.md to a man page
     # and install it, so the os command `man morpheus` will work too.
     fn = man_file_path()
+    if options[:outfile]
+      fn = File.expand_path(options[:outfile])
+      if File.exists?(fn) && options[:overwrite] != true
+        print_error "#{red}Output file '#{options[:outfile]}' already exists.#{reset}\n"
+        print_error "#{red}Use --overwrite to overwrite the existing file.#{reset}\n"
+        return 1, "output file already exists"
+      end
+    end
     if !Dir.exists?(File.dirname(fn))
       FileUtils.mkdir_p(File.dirname(fn))
     end
@@ -153,7 +185,7 @@ EOT
     begin
 
       manpage.print <<-ENDTEXT
-morpheus v#{Morpheus::Cli::VERSION}
+#{prog_name} v#{Morpheus::Cli::VERSION}
 
 ## NAME
 
@@ -170,17 +202,17 @@ morpheus v#{Morpheus::Cli::VERSION}
     This is a command line interface for managing a Morpheus Appliance.
     All communication with the remote appliance is done via the Morpheus API.
 
-    To get started, see the command `remote add` command.
+    Use the command `#{prog_name} remote add` to connect to your Morpheus appliance.
 
     To learn more, visit https://github.com/gomorpheus/morpheus-cli/wiki/Getting-Started
 
-    To learn more about the Morpheus Appliance, visit https://www.morpheusdata.com/features
+    To learn more about the Morpheus Appliance, visit https://www.morpheusdata.com
 
     To learn more about the Morpheus API, visit https://apidocs.morpheusdata.com
 
 ## GLOBAL OPTIONS
 
-    Morpheus supports a few global options.
+    There are several global options available.
 
     -v, --version                    Print the version.
         --noprofile                  Do not read and execute the personal initialization script .morpheus_profile
@@ -190,30 +222,42 @@ morpheus v#{Morpheus::Cli::VERSION}
 
 ## COMMON OPTIONS
 
-    There are some common options that many commands support. They work the same way for each command.
+    There are many common options that are supported by a most commands.
 
     -O, --option OPTION              Option value in the format -O var="value" (deprecated soon in favor of first class options)
     -N, --no-prompt                  Skip prompts. Use default values for all optional fields.
+        --payload FILE               Payload from a local JSON or YAML file, skip all prompting
+        --payload-dir DIRECTORY      Payload from a local directory containing 1-N JSON or YAML files, skip all prompting
+        --payload-json JSON          Payload JSON, skip all prompting
+        --payload-yaml YAML          Payload YAML, skip all prompting
     -j, --json                       JSON Output
     -d, --dry-run                    Dry Run, print the API request instead of executing it
-    -r, --remote REMOTE              Remote Appliance Name to use for this command. The active appliance is used by default.
-    -I, --insecure                   Allow for insecure HTTPS communication i.e. bad SSL certificate       
-    -y, --yes                        Auto confirm, skip any 'Are you sure?' confirmations.
-    -r, --quiet                      No Output, when successful.
+        --curl                       Dry Run to output API request as a curl command.
+        --scrub                      Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
+    -r, --remote REMOTE              Remote name. The current remote is used by default.
+        --remote-url URL             Remote url. This allows adhoc requests instead of using a configured remote.
+    -T, --token TOKEN                Access token for authentication with --remote. Saved credentials are used by default.
+    -U, --username USERNAME          Username for authentication.
+    -P, --password PASSWORD          Password for authentication.
+    -I, --insecure                   Allow insecure HTTPS communication.  i.e. bad SSL certificate.
+    -H, --header HEADER              Additional HTTP header to include with requests.
+        --timeout SECONDS            Timeout for api requests. Default is typically 30 seconds.
+    -y, --yes                        Auto Confirm
+    -q, --quiet                      No Output, do not print to stdout
 
 ## MORPHEUS COMMANDS
 
-    We divide morpheus into commands.  
-    Every morpheus command may have 0-N sub-commands that it supports. 
+    The morpheus executable is divided into commands.
+    Each morpheus command may have 0-N sub-commands that it supports. 
     Commands generally map to the functionality provided in the Morpheus UI.
        
     You can get help for any morpheus command by using the -h option.
 
-    The available commands and their options are also documented below.
+    The available commands and their options are documented below.
 ENDTEXT
       
       terminal = Morpheus::Terminal.new($stdin, manpage)
-      Morpheus::Logging::DarkPrinter.puts "appending command help `morpheus --help`" if Morpheus::Logging.debug? && !options[:quiet]
+      Morpheus::Logging::DarkPrinter.puts "appending command help `#{prog_name} --help`" if Morpheus::Logging.debug? && !options[:quiet]
 
       manpage.print "\n"
       manpage.print "## morpheus\n"
@@ -226,7 +270,7 @@ ENDTEXT
       Morpheus::Cli::CliRegistry.all.keys.sort.each do |cmd|
         cmd_klass = Morpheus::Cli::CliRegistry.instance.get(cmd)
         cmd_instance = cmd_klass.new
-        Morpheus::Logging::DarkPrinter.puts "appending command help `morpheus #{cmd} --help`" if Morpheus::Logging.debug? && !options[:quiet]
+        Morpheus::Logging::DarkPrinter.puts "appending command help `#{prog_name} #{cmd} --help`" if Morpheus::Logging.debug? && !options[:quiet]
         #help_cmd = "morpheus #{cmd} --help"
         #help_output = `#{help_cmd}`
         manpage.print "\n"
@@ -243,7 +287,7 @@ ENDTEXT
         subcommands = cmd_klass.visible_subcommands
         if subcommands && subcommands.size > 0
           subcommands.sort.each do |subcommand, subcommand_method|
-            Morpheus::Logging::DarkPrinter.puts "appending command help `morpheus #{cmd} #{subcommand} --help`" if Morpheus::Logging.debug? && !options[:quiet]
+            Morpheus::Logging::DarkPrinter.puts "appending command help `#{prog_name} #{cmd} #{subcommand} --help`" if Morpheus::Logging.debug? && !options[:quiet]
             manpage.print "\n"
             manpage.print "#### morpheus #{cmd} #{subcommand}\n"
             manpage.print "\n"
@@ -289,7 +333,7 @@ morpheus> remote list
 Morpheus Appliances
 ==================
 
-You have no appliances configured. See the `remote add` command.
+You have no appliances configured. See the `#{prog_name} remote add` command.
 
 ```
 
@@ -319,11 +363,10 @@ The `appliances` YAML file contains a list of known appliances, keyed by name.
 Example:
 ```yaml
 :qa:
-  :host: https://qa.mycoolsite.com
+  :host: https://qa.mymorpheus.com
   :active: true
 :production:
-  :host: https://morpheus.mycoolsite.com
-  :active: false
+  :host: https://mymorpheus.com
 ```
 
 ### credentials file
@@ -349,7 +392,7 @@ This may be inhibited by using the `--noprofile` option.
 
 ### .morpheusrc file
 
-When started as an interactive shell with the `morpheus shell` command,
+When started as an interactive shell with the `#{prog_name} shell` command,
 Morpheus reads and executes `$MORPHEUS_CLI_HOME/.morpheusrc` (if it exists). This may be inhibited by using the `--norc` option. 
 
 An example startup script might look like this:
@@ -357,20 +400,11 @@ An example startup script might look like this:
 ```
 # .morpheusrc
 
-# aliases
-alias our-instances='instances list -c "Our Cloud"'
-
-# switch to our appliance that we created with `remote add morphapp1`
-remote use morphapp1
-
-# greeting
-echo "Welcome back human,  have fun!"
-
-# print current user information
-whoami
-
-# print the list of instances in our cloud
-our-instances
+set-prompt "%cyan%username%reset@%magenta%remote %cyanmorpheus> %reset"
+version
+remote current
+echo "Welcome back %username"
+echo
 
 ```
 
@@ -383,7 +417,7 @@ ENDTEXT
       terminal = Morpheus::Terminal.new()
     end
 
-    return true
+    return 0, nil
   end
 
 end