morpheus-cli 5.5.2.1 → 5.5.3

data/lib/morpheus/cli/cli_command.rb

@@ -133,10 +133,12 @@ module Morpheus
       end
 
       # this returns all the options passed in by -O, parsed all nicely into objects.
-      def parse_passed_options(options)
-        passed_options = options[:options] ? options[:options].reject {|k,v| k.is_a?(Symbol) } : {}
+      def parse_passed_options(options, parse_opts={})
+        excludes = [parse_opts[:exclude], parse_opts[:excludes]].flatten.compact
+        passed_options = options[:options] ? options[:options].reject {|k,v| k.is_a?(Symbol) || excludes.include?(k) } : {}
         return passed_options
       end
+
       # Appends Array of OptionType definitions to an OptionParser instance
       # This adds an option like --fieldContext.fieldName="VALUE"
       # @param opts [OptionParser]
@@ -378,35 +380,53 @@ module Morpheus
               end
               options[:options] = custom_options
             end
-            opts.on('-P','--prompt', "Always prompts. Use passed options as the default value.") do |val|
+            # --always-prompt can be used with for update commands where it normally defaults to --no-prompt
+            opts.on('--prompt', "Always prompt for input on every option, even those not prompted for by default.") do
               options[:always_prompt] = true
-              options[:options] ||= {}
               options[:options][:always_prompt] = true
             end
-            opts.on('-N','--no-prompt', "Skip prompts. Use default values for all optional fields.") do |val|
+            opts.on('-N','--no-prompt', "No prompt, skips all input prompting.") do |val|
               options[:no_prompt] = true
-              options[:options] ||= {}
-              options[:options][:no_prompt] = true
-            end
-
-          when :prompt
-            opts.on('-P','--prompt', "Always prompts. Use passed options as the default value.") do |val|
-              options[:always_prompt] = true
-              options[:options] ||= {}
-              options[:options][:always_prompt] = true
-            end
-            opts.on('-N','--no-prompt', "Skip prompts. Use default values for all optional fields.") do |val|
-              options[:no_prompt] = true
-              options[:options] ||= {}
               options[:options][:no_prompt] = true
             end
+            # opts.on('--skip-prompt x,y,z', String, "Skip prompt, do not prompt for input of the specified options.") do |val|
+            #   options[:skip_prompt] ||= []
+            #   options[:skip_prompt] += parse_array(val)
+            #   options[:options][:skip_prompt] = options[:skip_prompt]
+            # end
+            # opts.on('--only-prompt x,y,z', String, "Only prompt for input on the specified options.") do |val|
+            #   options[:only_prompt] ||= []
+            #   options[:only_prompt] += parse_array(val)
+            #   options[:options][:only_prompt] = options[:only_prompt]
+            # end
+            opts.on('--no-options', String, "No options, skips all option parsing so no options are required and no default values are used.") do
+              options[:no_options] = true
+              options[:options][:no_options] = options[:no_options]
+            end
+            opts.on('--skip-options x,y,z', String, "Skip parsing of the specified options so that they are not required and their default value is not used.") do |val|
+              options[:skip_options] ||= []
+              options[:skip_options] += parse_array(val)
+              options[:options][:skip_options] = options[:skip_options]
+            end
+            # opts.on('--only-options x,y,z', String, "Only parse the specified options and skip all others.") do |val|
+            #   options[:only_options] ||= []
+            #   options[:only_options] += parse_array(val)
+            #   options[:options][:only_options] = options[:only_options]
+            # end
+            
+            # hide these while incubating
+            opts.add_hidden_option('--skip-prompt')
+            opts.add_hidden_option('--only-prompt')
+            opts.add_hidden_option('--no-options')
+            opts.add_hidden_option('--skip-options')
+            opts.add_hidden_option('--only-options')
 
           when :payload
             opts.on('--payload FILE', String, "Payload from a local JSON or YAML file, skip all prompting") do |val|
               options[:payload_file] = val.to_s
               begin
                 payload_file = File.expand_path(options[:payload_file])
-                if !File.exists?(payload_file) || !File.file?(payload_file)
+                if !File.exist?(payload_file) || !File.file?(payload_file)
                   raise ::OptionParser::InvalidOption.new("File not found: #{payload_file}")
                   #return false
                 end
@@ -419,10 +439,10 @@ module Morpheus
                 raise ::OptionParser::InvalidOption.new("Failed to parse payload file: #{payload_file} Error: #{ex.message}")
               end
             end
-            opts.on('--payload-dir DIRECTORY', String, "Payload from a local directory containing 1-N JSON or YAML files, skip all prompting") do |val|
+            opts.on('--payload-dir DIRECTORY', String, "Payload from a local directory containing 1-N JSON or YAML files, skip all prompting.") do |val|
               options[:payload_dir] = val.to_s
               payload_dir = File.expand_path(options[:payload_dir])
-              if !Dir.exists?(payload_dir) || !File.directory?(payload_dir)
+              if !Dir.exist?(payload_dir) || !File.directory?(payload_dir)
                 raise ::OptionParser::InvalidOption.new("Directory not found: #{payload_dir}")
               end
               payload = {}
@@ -592,7 +612,7 @@ module Morpheus
             end unless excludes.include?(:remote_token)
             opts.on( '--token-file FILE', String, "Token File, read a file containing the access token." ) do |val|
               token_file = File.expand_path(val)
-              if !File.exists?(token_file) || !File.file?(token_file)
+              if !File.exist?(token_file) || !File.file?(token_file)
                 raise ::OptionParser::InvalidOption.new("File not found: #{token_file}")
               end
               options[:remote_token] = File.read(token_file).to_s.split("\n").first.strip
@@ -609,7 +629,7 @@ module Morpheus
               end
               opts.on( '--password-file FILE', String, "Password File, read a file containing the password for authentication." ) do |val|
                 password_file = File.expand_path(val)
-                if !File.exists?(password_file) || !File.file?(password_file)
+                if !File.exist?(password_file) || !File.file?(password_file)
                   raise ::OptionParser::InvalidOption.new("File not found: #{password_file}")
                 end
                 file_content = File.read(password_file) #.strip
@@ -914,12 +934,12 @@ module Morpheus
 
         opts.on('--hidden-help', "Print help that includes all the hidden options, like this one." ) do
           puts opts.full_help_message({show_hidden_options:true})
-          exit # return 0 maybe?
+          exit 0 # return 0 maybe?
         end
         opts.add_hidden_option('--hidden-help') if opts.is_a?(Morpheus::Cli::OptionParser)
         opts.on('-h', '--help', "Print this help" ) do
           puts opts
-          exit # return 0 maybe?
+          exit 0 # return 0 maybe?
         end
 
         opts
@@ -1012,9 +1032,9 @@ module Morpheus
             out << "\n"
           }
         end
-        if command_description
+        if command_description && !command_description.to_s.strip.empty?
           out << "\n"
-          out << "#{command_description}\n"
+          out << "#{command_description.strip}\n"
         end
         # out << "\n"
         out
@@ -1248,6 +1268,14 @@ module Morpheus
         true
       end
 
+      def confirm(msg, options)
+        options[:yes] or ::Morpheus::Cli::OptionTypes::confirm(msg, options)
+      end
+
+      def confirm!(msg, options)
+        confirm(msg, options) or raise CommandAborted.new("confirmation declined: #{msg}")
+      end
+
       # The default way to build options for the list command
       # @param [OptionParser] opts
       # @param [Hash] options
@@ -1449,11 +1477,11 @@ module Morpheus
       def validate_outfile(outfile, options)
         full_filename = File.expand_path(outfile)
         outdir = File.dirname(full_filename)
-        if Dir.exists?(full_filename)
+        if Dir.exist?(full_filename)
           print_red_alert "[local-file] is invalid. It is the name of an existing directory: #{outfile}"
           return false
         end
-        if !Dir.exists?(outdir)
+        if !Dir.exist?(outdir)
           if options[:mkdir]
             print cyan,"Creating local directory #{outdir}",reset,"\n"
             FileUtils.mkdir_p(outdir)
@@ -1462,7 +1490,7 @@ module Morpheus
             return false
           end
         end
-        if File.exists?(full_filename) && !options[:overwrite]
+        if File.exist?(full_filename) && !options[:overwrite]
           print_red_alert "[local-file] is invalid. File already exists: #{outfile}\nUse -f to overwrite the existing file."
           return false
         end
@@ -1753,6 +1781,9 @@ module Morpheus
 
       module ClassMethods
 
+        # attr_writer :command_name, :command_description, :hidden_command, :default_refresh_interval,
+        #             :subcommands, :hidden_subcommands, :default_subcommand, :subcommand_aliases, :subcommand_descriptions
+
         def prog_name
           "morpheus"
         end
@@ -1779,7 +1810,11 @@ module Morpheus
         # alias :command_name= :set_command_name
 
         def hidden_command
-          !!@hidden_command
+          defined?(@hidden_command) && @hidden_command == true
+        end
+
+        def hidden_subcommands
+          @hidden_subcommands ||= []
         end
 
         def set_subcommands_hidden(*cmds)
@@ -1791,7 +1826,7 @@ module Morpheus
         end
 
         def command_description
-          @command_description
+          @command_description ||= ""
         end
 
         def set_command_description(val)
@@ -1880,10 +1915,8 @@ module Morpheus
 
         def visible_subcommands
           cmds = subcommands.clone
-          if @hidden_subcommands && !@hidden_subcommands.empty?
-            @hidden_subcommands.each do |hidden_cmd|
-              cmds.delete(hidden_cmd.to_s.gsub('_', '-'))
-            end
+          hidden_subcommands.each do |hidden_cmd|
+            cmds.delete(hidden_cmd.to_s.gsub('_', '-'))
           end
           cmds
         end

data/lib/morpheus/cli/cli_registry.rb

@@ -78,10 +78,17 @@ module Morpheus
 
         def exec_command(command_name, args)
           #puts "exec_command(#{command_name}, #{args})"
+          result = nil
           if has_alias?(command_name)
-            exec_alias(command_name, args)
+            result = exec_alias(command_name, args)
           elsif has_command?(command_name)
-            instance.get(command_name).new.handle(args)
+            begin
+              result = instance.get(command_name).new.handle(args)
+            rescue SystemExit => e
+              result = Morpheus::Cli::ErrorHandler.new(Morpheus::Terminal.instance.stderr).handle_error(e) # lol
+            rescue => e
+              result = Morpheus::Cli::ErrorHandler.new(Morpheus::Terminal.instance.stderr).handle_error(e) # lol
+            end
           else
             # todo: need to just return error instead of raise
             msg = "'#{command_name}' is not a morpheus command."
@@ -97,8 +104,10 @@ module Morpheus
                 msg += "\t" + suggestion + "\n"
               end
             end
-            raise CommandNotFoundError.new(msg)
+            #raise CommandNotFoundError.new(msg)
+            result = Morpheus::Cli::ErrorHandler.new(Morpheus::Terminal.instance.stderr).handle_error(CommandNotFoundError.new(msg)) # lol
           end
+          return result
         end
 
         def exec_alias(alias_name, args)
@@ -248,17 +257,17 @@ module Morpheus
 
         # parse any object into a command result [exit_code, error]
         # 0 means success.
-        # This treats nil, true, or an object success.
-        # 0 or
-        # @return [Array] exit_code, error. Success returns [0, nil].
+        # This treats nil, true, or an object as success ie. [0, nil]
+        # and false is treated as an error [1, error]
+        # @return [Array] [exit_code, error]. Success returns [0, nil].
         def parse_command_result(cmd_result)
-          exit_code, err = nil, nil
+          exit_code, error = nil, nil
           if cmd_result.is_a?(Array)
             exit_code = cmd_result[0] || 0
-            err = cmd_result[1]
+            error = cmd_result[1]
           elsif cmd_result.is_a?(Hash)
             exit_code = cmd_result[:exit_code] || 0
-            err = cmd_result[:error] || cmd_result[:err]
+            error = cmd_result[:error] || cmd_result[:err]
           elsif cmd_result == nil || cmd_result == true
             exit_code = 0
           elsif cmd_result == false
@@ -279,7 +288,7 @@ module Morpheus
               exit_code = 0
             end
           end
-          return exit_code, err
+          return exit_code, error
         end
 
         def cached_command_list

data/lib/morpheus/cli/commands/access_token_command.rb

@@ -116,7 +116,7 @@ class Morpheus::Cli::AccessTokenCommand
       end
       opts.on( '--token-file FILE', String, "Refresh Token File, read a file containing the refresh token." ) do |val|
         token_file = File.expand_path(val)
-        if !File.exists?(token_file) || !File.file?(token_file)
+        if !File.exist?(token_file) || !File.file?(token_file)
           raise ::OptionParser::InvalidOption.new("File not found: #{token_file}")
         end
         options[:refresh_token] = File.read(token_file).to_s.split("\n").first.strip

data/lib/morpheus/cli/commands/apps.rb

@@ -2260,7 +2260,7 @@ EOT
       build_option_type_options(opts, options, update_wiki_page_option_types)
       opts.on('--file FILE', "File containing the wiki content. This can be used instead of --content") do |filename|
         full_filename = File.expand_path(filename)
-        if File.exists?(full_filename)
+        if File.exist?(full_filename)
           params['content'] = File.read(full_filename)
         else
           print_red_alert "File not found: #{full_filename}"

data/lib/morpheus/cli/commands/archives_command.rb

@@ -383,7 +383,6 @@ class Morpheus::Cli::ArchivesCommand
   end
 
   def remove_bucket(args)
-    full_command_string = "#{command_name} remove #{args.join(' ')}".strip
     options = {}
     query_params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
@@ -414,7 +413,7 @@ class Morpheus::Cli::ArchivesCommand
       end
       @archive_buckets_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @archive_buckets_interface.dry.destroy(archive_bucket['id'], query_params), full_command_string
+        print_dry_run @archive_buckets_interface.dry.destroy(archive_bucket['id'], query_params)
         return 0
       end
       json_response = @archive_buckets_interface.destroy(archive_bucket['id'], query_params)
@@ -470,7 +469,7 @@ class Morpheus::Cli::ArchivesCommand
       puts_error  "#{command_name} missing argument: [local-file]\n#{optparse}"
       return 1
     end
-    if !File.exists?(local_file_path)
+    if !File.exist?(local_file_path)
       print_error Morpheus::Terminal.angry_prompt
       puts_error  "#{command_name} bad argument: [local-file]\nFile '#{local_file_path}' was not found.\n#{optparse}"
       return 1
@@ -595,7 +594,7 @@ class Morpheus::Cli::ArchivesCommand
       else
 
         # upload file
-        if !File.exists?(local_file_path) && !File.file?(local_file_path)
+        if !File.exist?(local_file_path) && !File.file?(local_file_path)
           print_error Morpheus::Terminal.angry_prompt
           puts_error  "#{command_name} bad argument: [local-file]\nFile '#{local_file_path}' was not found.\n#{optparse}"
           return 1
@@ -886,7 +885,6 @@ class Morpheus::Cli::ArchivesCommand
   end
 
   def get_file(args)
-    full_command_string = "#{command_name} get-file #{args.join(' ')}".strip
     options = {}
     max_links = 10
     max_history = 10
@@ -929,9 +927,9 @@ class Morpheus::Cli::ArchivesCommand
       @archive_files_interface.setopts(options)
       if options[:dry_run]
         if file_id
-          print_dry_run @archive_files_interface.dry.get(file_id, params), full_command_string
+          print_dry_run @archive_files_interface.dry.get(file_id, params)
         else
-          print_dry_run @archive_buckets_interface.dry.list_files(bucket_id, file_path, params), full_command_string
+          print_dry_run @archive_buckets_interface.dry.list_files(bucket_id, file_path, params)
         end
         return 0
       end
@@ -1211,7 +1209,6 @@ class Morpheus::Cli::ArchivesCommand
   end
 
   def download_file(args)
-    full_command_string = "#{command_name} download #{args.join(' ')}".strip
     options = {}
     outfile = nil
     do_overwrite = false
@@ -1256,15 +1253,15 @@ class Morpheus::Cli::ArchivesCommand
       #   outfile = File.join(outfile, File.basename(full_file_path))
       # end
       outfile = File.expand_path(outfile)
-      if Dir.exists?(outfile)
+      if Dir.exist?(outfile)
         outfile = File.join(outfile, File.basename(full_file_path))
       end
-      if Dir.exists?(outfile)
+      if Dir.exist?(outfile)
         print_red_alert "[local-file] is invalid. It is the name of an existing directory: #{outfile}"
         return 1
       end
       destination_dir = File.dirname(outfile)
-      if !Dir.exists?(destination_dir)
+      if !Dir.exist?(destination_dir)
         if do_mkdir
           print cyan,"Creating local directory #{destination_dir}",reset,"\n"
           FileUtils.mkdir_p(destination_dir)
@@ -1273,7 +1270,7 @@ class Morpheus::Cli::ArchivesCommand
           return 1
         end
       end
-      if File.exists?(outfile)
+      if File.exist?(outfile)
         if do_overwrite
           # uhh need to be careful wih the passed filepath here..
           # don't delete, just overwrite.
@@ -1288,11 +1285,10 @@ class Morpheus::Cli::ArchivesCommand
       begin
         @archive_files_interface.setopts(options)
         if options[:dry_run]
-          # print_dry_run @archive_files_interface.dry.download_file_by_path(full_file_path), full_command_string
           if use_public_url
-            print_dry_run @archive_files_interface.dry.download_public_file_by_path_chunked(full_file_path, outfile), full_command_string
+            print_dry_run @archive_files_interface.dry.download_public_file_by_path_chunked(full_file_path, outfile)
           else
-            print_dry_run @archive_files_interface.dry.download_file_by_path_chunked(full_file_path, outfile), full_command_string
+            print_dry_run @archive_files_interface.dry.download_file_by_path_chunked(full_file_path, outfile)
           end
           return 0
         end
@@ -1322,7 +1318,7 @@ class Morpheus::Cli::ArchivesCommand
             print red + "ERROR" + reset + " HTTP #{http_response.code}" + "\n"
           end
           # F it, just remove a bad result
-          if File.exists?(outfile) && File.file?(outfile)
+          if File.exist?(outfile) && File.file?(outfile)
             Morpheus::Logging::DarkPrinter.puts "Deleting bad file download: #{outfile}" if Morpheus::Logging.debug?
             File.delete(outfile)
           end
@@ -1348,7 +1344,6 @@ class Morpheus::Cli::ArchivesCommand
   end
 
   def read_file(args)
-    full_command_string = "archives read #{args.join(' ')}".strip
     options = {}
     outfile = nil
     do_overwrite = false
@@ -1374,7 +1369,7 @@ class Morpheus::Cli::ArchivesCommand
       full_file_path = "#{bucket_id}/#{file_path}".squeeze('/')
       @archive_files_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @archive_files_interface.dry.download_file_by_path(full_file_path), full_command_string
+        print_dry_run @archive_files_interface.dry.download_file_by_path(full_file_path)
         return 1
       end
       if archive_file['rawSize'].to_i > 1024
@@ -1497,7 +1492,6 @@ class Morpheus::Cli::ArchivesCommand
   end
 
   def download_file_link(args)
-    full_command_string = "archives download-link #{args.join(' ')}".strip
     options = {}
     outfile = nil
     do_overwrite = false
@@ -1533,15 +1527,15 @@ class Morpheus::Cli::ArchivesCommand
       # full_file_path = args[0]
       outfile = File.expand_path(args[1])
       # [local-file] must include the full file name when downloading a link
-      # if Dir.exists?(outfile)
+      # if Dir.exist?(outfile)
       #   outfile = File.join(outfile, File.basename(archive_file['name']))
       # end
-      if Dir.exists?(outfile)
+      if Dir.exist?(outfile)
         print_red_alert "[local-file] is invalid. It is the name of an existing directory: #{outfile}"
         return 1
       end
       destination_dir = File.dirname(outfile)
-      if !Dir.exists?(destination_dir)
+      if !Dir.exist?(destination_dir)
         if do_mkdir
           print cyan,"Creating local directory #{destination_dir}",reset,"\n"
           FileUtils.mkdir_p(destination_dir)
@@ -1550,7 +1544,7 @@ class Morpheus::Cli::ArchivesCommand
           return 1
         end
       end
-      if File.exists?(outfile)
+      if File.exist?(outfile)
         if do_overwrite
           # uhh need to be careful wih the passed filepath here..
           # don't delete, just overwrite.
@@ -1566,8 +1560,7 @@ class Morpheus::Cli::ArchivesCommand
       end
       @archive_files_interface.setopts(options)
       if options[:dry_run]
-        # print_dry_run @archive_files_interface.dry.download_file_by_path(full_file_path), full_command_string
-        print_dry_run @archive_files_interface.dry.download_file_by_link_chunked(link_key, outfile), full_command_string
+        print_dry_run @archive_files_interface.dry.download_file_by_link_chunked(link_key, outfile)
         return 1
       end
       if !options[:quiet]
@@ -1591,7 +1584,7 @@ class Morpheus::Cli::ArchivesCommand
           print red + "ERROR" + reset + " HTTP #{http_response.code}" + "\n"
         end
         # F it, just remove a bad result
-        if File.exists?(outfile) && File.file?(outfile)
+        if File.exist?(outfile) && File.file?(outfile)
           Morpheus::Logging::DarkPrinter.puts "Deleting bad file download: #{outfile}" if Morpheus::Logging.debug?
           File.delete(outfile)
         end
@@ -1608,7 +1601,6 @@ class Morpheus::Cli::ArchivesCommand
   end
 
   def download_bucket_zip(args)
-    full_command_string = "#{command_name} download-bucket #{args.join(' ')}".strip
     options = {}
     outfile = nil
     do_overwrite = false
@@ -1651,10 +1643,10 @@ class Morpheus::Cli::ArchivesCommand
       #   outfile = File.join(outfile, archive_bucket['name'].to_s) + ".zip"
       # end
       outfile = File.expand_path(outfile)
-      if Dir.exists?(outfile)
+      if Dir.exist?(outfile)
         outfile = File.join(outfile, archive_bucket['name'].to_s) + ".zip"
       end
-      if Dir.exists?(outfile)
+      if Dir.exist?(outfile)
         print_red_alert "[local-file] is invalid. It is the name of an existing directory: #{outfile}"
         return 1
       end
@@ -1663,7 +1655,7 @@ class Morpheus::Cli::ArchivesCommand
         outfile << ".zip"
       end
       destination_dir = File.dirname(outfile)
-      if !Dir.exists?(destination_dir)
+      if !Dir.exist?(destination_dir)
         if do_mkdir
           print cyan,"Creating local directory #{destination_dir}",reset,"\n"
           FileUtils.mkdir_p(destination_dir)
@@ -1672,7 +1664,7 @@ class Morpheus::Cli::ArchivesCommand
           return 1
         end
       end
-      if File.exists?(outfile)
+      if File.exist?(outfile)
         if do_overwrite
           # uhh need to be careful wih the passed filepath here..
           # don't delete, just overwrite.
@@ -1686,7 +1678,7 @@ class Morpheus::Cli::ArchivesCommand
       end
       @archive_buckets_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @archive_buckets_interface.dry.download_bucket_zip_chunked(bucket_id, outfile), full_command_string
+        print_dry_run @archive_buckets_interface.dry.download_bucket_zip_chunked(bucket_id, outfile)
         return 1
       end
       if !options[:quiet]
@@ -1707,7 +1699,7 @@ class Morpheus::Cli::ArchivesCommand
           print red + "ERROR" + reset + " HTTP #{http_response.code}" + "\n"
         end
         # F it, just remove a bad result
-        if File.exists?(outfile) && File.file?(outfile)
+        if File.exist?(outfile) && File.file?(outfile)
           Morpheus::Logging::DarkPrinter.puts "Deleting bad file download: #{outfile}" if Morpheus::Logging.debug?
           File.delete(outfile)
         end