morpheus-cli 2.10.3 → 2.11.0

data/lib/morpheus/cli/license.rb

@@ -45,7 +45,7 @@ class Morpheus::Cli::License
           puts "No License Currently Applied to the appliance."
           exit 1
         else
-          print "\n", cyan, "License\n=======\n"
+          print_h1 "License"
           max_memory = Filesize.from("#{license['license']['maxMemory']} B").pretty
           max_storage = Filesize.from("#{license['license']['maxStorage']} B").pretty
           used_memory = Filesize.from("#{license['usedMemory']} B").pretty
@@ -77,7 +77,7 @@ class Morpheus::Cli::License
         key = args[0]
       else
         v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'licenseKey', 'fieldLabel' => 'License Key', 'type' => 'text', 'required' => true}], options[:options])
-        instance_name = v_prompt['licenseKey'] || ''
+        key = v_prompt['licenseKey'] || ''
       end
       if options[:dry_run]
         print_dry_run @license_interface.dry.apply(key)

data/lib/morpheus/cli/load_balancers.rb

@@ -47,9 +47,9 @@ class Morpheus::Cli::LoadBalancers
         print JSON.pretty_generate(json_response)
       else
         lbs = json_response['loadBalancers']
-        print "\n" ,cyan, bold, "Morpheus Load Balancers\n","==================", reset, "\n\n"
+        print_h1 "Morpheus Load Balancers"
         if lbs.empty?
-          puts yellow,"No load balancers currently configured.",reset
+          print cyan,"No load balancers found.",reset,"\n"
         else
           print cyan
           lb_table_data = lbs.collect do |lb|
@@ -186,9 +186,9 @@ class Morpheus::Cli::LoadBalancers
         print JSON.pretty_generate(json_response)
       else
         lb_types = json_response['loadBalancerTypes']
-        print "\n" ,cyan, bold, "Morpheus Load Balancer Types\n","============================", reset, "\n\n"
+        print_h1 "Morpheus Load Balancer Types"
         if lb_types.nil? || lb_types.empty?
-          puts yellow,"No lb types currently exist on this appliance. This could be a seed issue.",reset
+          print yellow,"No lb types currently exist on this appliance. This could be a seed issue.",reset,"\n"
         else
           print cyan
           lb_table_data = lb_types.collect do |lb_type|

data/lib/morpheus/cli/log_level_command.rb

@@ -1,6 +1,7 @@
 require 'optparse'
-require 'morpheus/cli/cli_command'
 require 'json'
+require 'morpheus/logging'
+require 'morpheus/cli/cli_command'
 
 class Morpheus::Cli::LogLevelCommand
   include Morpheus::Cli::CliCommand
@@ -34,13 +35,14 @@ EOT
     end
     if ["debug", "0"].include?(args[0].to_s.strip.downcase)
       Morpheus::Logging.set_log_level(Morpheus::Logging::Logger::DEBUG)
-      ::RestClient.log = Morpheus::Logging.debug? ? STDOUT : nil
+      ::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
+      Morpheus::Logging::DarkPrinter.puts "debug enabled"
     elsif ["info", "1"].include?(args[0].to_s.strip.downcase)
       Morpheus::Logging.set_log_level(Morpheus::Logging::Logger::INFO)
-      ::RestClient.log = Morpheus::Logging.debug? ? STDOUT : nil
+      ::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
     elsif args[0].to_i < 6
       Morpheus::Logging.set_log_level(args[0].to_i)
-      ::RestClient.log = Morpheus::Logging.debug? ? STDOUT : nil
+      ::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
     else
       puts optparse
       return false

data/lib/morpheus/cli/login.rb

@@ -49,7 +49,7 @@ class Morpheus::Cli::Login
         @appliance_name, @appliance_url = nil, nil
       end
       if !@appliance_name
-        print_red_alert "You have no appliance named '#{options[:remote]}' configured. See the `remote add` command."
+        print_red_alert "You have no appliance named '#{options[:remote]}' configured. See the `remote list` command."
         return false
       end
     else
@@ -70,11 +70,25 @@ class Morpheus::Cli::Login
       options[:remote_username] = username if username
       options[:remote_password] = password if password
       #options[:remote_url] = true # will skip credentials save
-      Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).login(options)
+      login_result = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).login(options)
+
+      # check to see if we got credentials, or just look at login_result above...
+      creds = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).load_saved_credentials() # .load_saved_credentials(true)
+
+      # recalculate shell prompt after this change
+      if Morpheus::Cli::Shell.instance
+        Morpheus::Cli::Shell.instance.reinitialize()
+      end
+
+      if creds
+        return 0 # ,  nil
+      else
+        return 1 # , "Login failed"
+      end
 
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
-      exit 1
+      return 1
     end
 
   end

data/lib/morpheus/cli/logout.rb

@@ -32,28 +32,42 @@ class Morpheus::Cli::Logout
     options = {}
     optparse = OptionParser.new do|opts|
       opts.banner = usage
-      build_common_options(opts, options, [:remote]) # todo: support :remote too perhaps
+      build_common_options(opts, options, [:remote, :quiet])
     end
     optparse.parse!(args)
-    connect(options)
+    # connect(options)
+    # establish @appliance_name, @appliance_url, 
+    @api_client = establish_remote_appliance_connection(options.merge({:no_prompt => true, :skip_verify_access_token => true}))
 
     begin
       if !@appliance_name
-        print yellow,"Please specify a Morpheus Appliance to logout of with -r or see the command `remote use`#{reset}\n"
-        return
+        print_error Morpheus::Terminal.angry_prompt
+        puts_error "Please specify a Morpheus Appliance to logout of with -r or see the command `remote use`"
+        return 1
       end
-      creds = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).load_saved_credentials()
-      if !creds
-        print yellow,"You are not currently logged in to #{display_appliance(@appliance_name, @appliance_url)}\n",reset
-        return 0
+      creds = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url)
+      token = creds.saved_credentials
+      if !token
+        if !options[:quiet]
+          puts "You are not currently logged in to #{display_appliance(@appliance_name, @appliance_url)}"
+        end
       else
+        # todo: need to tell the server to delete the token too..
+        # delete token from credentials file
+        # note: this also handles updating appliance session info
         Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).logout()
-        print cyan,"Goodbye\n",reset
+        if !options[:quiet]
+          puts "#{cyan}Logged out of #{@appliance_name}. Goodbye.#{reset}"
+        end
       end
-
+      # recalculate shell prompt after this change
+      if Morpheus::Cli::Shell.instance
+        Morpheus::Cli::Shell.instance.reinitialize()
+      end
+      return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
-      return 1
+      return false
     end
 
   end

data/lib/morpheus/cli/man_command.rb

@@ -0,0 +1,388 @@
+require 'optparse'
+require 'morpheus/logging'
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::ManCommand
+  include Morpheus::Cli::CliCommand
+  set_command_name :man
+  set_command_hidden
+
+  # this should be read only anyway...
+  @@default_editor = "less" # ENV['EDITOR']
+  
+  def handle(args)
+    options = {}
+    regenerate = false
+    editor = @@default_editor
+    open_as_link = false # true please
+    goto_wiki = false
+    optparse = Morpheus::Cli::OptionParser.new do|opts|
+      opts.banner = "Usage: morpheus man"
+      opts.on('-w','--wiki', "Open the morpheus-cli wiki instead of the local man page") do
+        goto_wiki = true
+      end
+      opts.on('-e','--editor EDITOR', "Specify which program to open the manual with. Default is '#{editor}'.") do |val|
+        editor = val
+        open_as_link = false
+      end
+      opts.on('-g','--generate', "Regenerate the manual file") do
+        regenerate = true
+      end
+      opts.on('-q','--quiet', "Do not open manual, for use with the -g option.") do
+        options[:quiet] = true
+      end
+      #build_common_options(opts, options, [:quiet])
+      # disable ANSI coloring
+      opts.on('-C','--nocolor', "Disable ANSI coloring") do
+        Term::ANSIColor::coloring = false
+      end
+
+      opts.on('-V','--debug', "Print extra output for debugging. ") do
+        Morpheus::Logging.set_log_level(Morpheus::Logging::Logger::DEBUG)
+        ::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
+      end
+      opts.on('-h', '--help', "Prints this help" ) do
+        puts opts
+        exit
+      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.
+EOT
+    end
+    optparse.parse!(args)
+
+    if goto_wiki
+      link = "https://github.com/gomorpheus/morpheus-cli/wiki/CLI-Manual"
+      if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+        system "start #{link}"
+      elsif RbConfig::CONFIG['host_os'] =~ /darwin/
+        system "open #{link}"
+      elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
+        system "xdg-open #{link}"
+      end
+      return 0, nil
+    end
+
+    fn = Morpheus::Cli::ManCommand.man_file_path
+    if regenerate || !File.exists?(fn)
+      #Morpheus::Logging::DarkPrinter.puts "generating manual #{fn} ..." if Morpheus::Logging.debug?
+      Morpheus::Cli::ManCommand.generate_manual()
+    end
+    
+    if options[:quiet]
+      return 0, nil
+    end
+    
+    Morpheus::Logging::DarkPrinter.puts "opening manual file #{fn}" if Morpheus::Logging.debug?
+    
+    
+    if open_as_link # not used atm
+      link = "file://#{fn}"
+      if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+        system "start #{link}"
+      elsif RbConfig::CONFIG['host_os'] =~ /darwin/
+        system "open #{link}"
+      elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
+        system "xdg-open #{link}"
+      end
+      return 0, nil
+    else
+      if editor
+        if !system_command_available?(editor)
+          raise_command_error "The editor program '#{editor}' is not available on your system."
+          # puts_error "#{red}The editor program '#{editor}' is not available on your system.#{reset}"
+          # return 1
+        end        
+        system("#{editor} #{fn}")
+      else
+        raise_command_error "Tell me how to open the manual file #{fn}. Try -e emacs or run export EDITOR=emacs"
+        return 1
+      end
+    end
+
+    return 0, nil
+  end
+
+  # determine if system command is available
+  # uses *nix's `which` command.
+  # Prevents using dangerous commands rm,mv,passwd
+  # todo: support for Windows and PowerShell
+  def system_command_available?(cmd)
+    has_it = false
+    begin
+      cmd = cmd.strip
+      if cmd.include?(';') || 
+          cmd =~ /^rm/  || cmd.strip =~ /^mv/ || cmd.strip =~ /^passwd/ || 
+          cmd.include?("/rm")  || cmd.include?("/mv") || cmd.include?("/passwd")
+        raise_command_error "The specified system command '#{cmd}' is invalid."
+      end
+      system("which #{cmd} > /dev/null 2>&1")
+      has_it = $?.success?
+    rescue => e
+      raise e
+    end
+    return has_it
+  end
+
+  def self.man_file_path
+    File.join(Morpheus::Cli.home_directory, "CLI-Manual-#{Morpheus::Cli::VERSION}.md")
+  end
+
+  # def self.save_manual(fn, content)
+  #   # fn = man_file_path()
+  #   if !Dir.exists?(File.dirname(fn))
+  #     FileUtils.mkdir_p(File.dirname(fn))
+  #   end
+  #   Morpheus::Logging::DarkPrinter.puts "saving manual to #{fn}" if Morpheus::Logging.debug?
+  #   File.open(fn, 'w') {|f| f.write content.to_s } #Store
+  #   FileUtils.chmod(0600, fn)
+  # end
+
+  def self.generate_manual()
+    # 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 !Dir.exists?(File.dirname(fn))
+      FileUtils.mkdir_p(File.dirname(fn))
+    end
+    Morpheus::Logging::DarkPrinter.puts "generating manual #{fn}" if Morpheus::Logging.debug?
+
+    File.open(fn, 'w') {|f| f.write("") } # clear file
+    FileUtils.chmod(0600, fn)
+
+    manpage = File.new(fn, 'w')
+    previous_stdout = $stdout
+    $stdout = manpage
+    begin
+
+      $stdout.print <<-ENDTEXT
+## NAME
+
+    morpheus - the command line interface for interacting with the Morpheus Data appliance
+
+## SYNOPSIS
+
+    morpheus [command] [<args>]
+
+## DESCRIPTION
+
+    Morpheus CLI
+
+    This is a command line interface for managing a Morpheus Appliance.
+    All communication with the remote appliance is done via the Morpheus API.
+
+    To setup a new appliance, see the `remote add` and `remote setup` commands.
+
+    To get started, 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 API, visit http://bertramdev.github.io/morpheus-apidoc/ 
+
+## GLOBAL OPTIONS
+
+    Morpheus supports a few global options.
+
+    -v, --version                    Print the version.
+        --noprofile                  Do not read and execute the personal initialization script .morpheus_profile
+    -C, --nocolor                    Disable ANSI coloring
+    -V, --debug                      Print extra output for debugging. 
+    -h, --help                       Prints this help
+
+## COMMON OPTIONS
+
+    There are some common options that many commands support. They work the same way for each command.
+
+    -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.
+    -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.
+
+## MORPHEUS COMMANDS
+
+    We divide morpheus into commands.  
+    Every 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.
+ENDTEXT
+      
+      terminal = Morpheus::Terminal.new($stdin, $stdout)
+      Morpheus::Logging::DarkPrinter.puts "appending command help `morpheus --help`" if Morpheus::Logging.debug?
+
+      $stdout.print "\n"
+      $stdout.print "## morpheus\n"
+      $stdout.print "\n"
+      $stdout.print "```\n"
+      exit_code, err = terminal.execute("--help")
+      $stdout.print "```\n"
+      $stdout.print "\n"
+      # output help for every unhidden command
+      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?
+        #help_cmd = "morpheus #{cmd} --help"
+        #help_output = `#{help_cmd}`
+        $stdout.print "\n"
+        $stdout.print "### morpheus #{cmd}\n"
+        $stdout.print "\n"
+        $stdout.print "```\n"
+        begin
+          cmd_instance.handle(["--help"])
+        rescue SystemExit => err
+          raise err unless err.success?
+        end
+        $stdout.print "```\n"
+        subcommands = cmd_klass.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?
+            $stdout.print "\n"
+            $stdout.print "#### morpheus #{cmd} #{subcommand}\n"
+            $stdout.print "\n"
+            $stdout.print "```\n"
+            begin
+              cmd_instance.handle([subcommand, "--help"])
+            rescue SystemExit => err
+              raise err unless err.success?
+            end
+            $stdout.print "```\n"
+            # $stdout.print "\n"
+          end
+        end
+        $stdout.print "\n"
+      end
+
+      $stdout.print <<-ENDTEXT
+
+## ENVIRONMENT VARIABLES
+
+Morpheus has only one environment variable that it uses.
+
+### MORPHEUS_CLI_HOME
+
+The **MORPHEUS_CLI_HOME** variable is where morpheus CLI stores its configuration files.
+This can be set to allow a single system user to maintain many different configurations
+If the directory does not exist, morpheus will attempt to create it.
+
+The default home directory is **$HOME/.morpheus**
+
+To see how this works, run the following:
+
+```shell
+MORPHEUS_CLI_HOME=~/.morpheus_test morpheus shell
+```
+
+Now, in your new morpheus shell, you can see that it is a fresh environment.
+There are no remote appliances configured.
+
+```shell
+morpheus> remote list
+
+Morpheus Appliances
+==================
+
+You have no appliances configured. See the `remote add` command.
+
+```
+
+You can use this to create isolated environments (sandboxes), within which to execute your morpheus commands.
+
+```shell
+export MORPHEUS_CLI_HOME=~/morpheus_test
+morpheus remote add myremote https://testmorpheusappliance.mycompany.com --insecure
+morpheus instances list
+```
+
+Morpheus saves the remote appliance information, including api access tokens, 
+to the $MORPHEUS_HOME_DIRECTORY. These files are saved with file permissions **6000**.
+So, only one system user should be allowed to execute morpheus with that home directory.
+See [Configuration](#Configuration) for more information on the files morpheus reads and writes.
+
+## CONFIGURATION
+
+Morpheus reads and writes several configuration files within the $MORPHEUS_CLI_HOME directory.
+
+**Note:** These files are maintained by the program. It is not recommended for you to manipulate them.
+
+### appliances file
+
+The `appliances` YAML file contains a list of known appliances, keyed by name.
+
+Example:
+```yaml
+:qa:
+  :host: https://qa.mycoolsite.com
+  :active: true
+:production:
+  :host: https://morpheus.mycoolsite.com
+  :active: false
+```
+
+### credentials file
+
+The `.morpheus/credentials` YAML file contains access tokens for each known appliance.
+
+### groups file
+
+The `.morpheus/groups` YAML file contains the active group information for each known appliance.
+
+
+## Startup scripts
+
+When Morpheus starts, it executes the commands in a couple of dot files.
+
+These scripts are written in morpheus commands, not bash, so they can only execute morpheus commands and aliases. 
+
+### .morpheus_profile file
+
+It looks for `$MORPHEUS_CLI_HOME/.morpheus_profile`, and reads and executes it (if it exists). 
+
+This may be inhibited by using the `--noprofile` option.
+
+### .morpheusrc file
+
+When started as an interactive shell with the `morpheus 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:
+
+```
+# .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
+
+```
+
+ENDTEXT
+
+    ensure
+      manpage.close if manpage
+      $stdout = previous_stdout if previous_stdout
+    end
+
+    return true
+  end
+
+end