morpheus-cli 4.2.16 → 4.2.17

data/lib/morpheus/api/instances_interface.rb

@@ -302,4 +302,9 @@ class Morpheus::InstancesInterface < Morpheus::APIClient
     execute(opts)
   end
 
+  def deploys(id, params)
+    # todo: make this plural??
+    execute(method: :get, url: "/api/instances/#{id}/deploy", params: params)
+  end
+
 end

data/lib/morpheus/api/rest_interface.rb

@@ -0,0 +1,40 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::RestInterface < Morpheus::APIClient
+
+  # subclasses should override in your interface
+  # Example: "/api/things"
+  def base_path
+    raise "#{self.class} has not defined base_path!"
+  end
+
+  def list(params={})
+    execute(method: :get, url: "#{base_path}", params: params)
+  end
+
+  def get(id, params={})
+    validate_id!(id)
+    execute(method: :get, url: "#{base_path}/#{id}", params: params)
+  end
+
+  def create(payload, params={})
+    execute(method: :post, url: "#{base_path}", params: params, payload: payload.to_json)
+  end
+
+  def update(id, payload, params={})
+    validate_id!(id)
+    execute(method: :put, url: "#{base_path}/#{id}", params: params, payload: payload.to_json)
+  end
+
+  def destroy(id, params = {})
+    validate_id!(id)
+    execute(method: :delete, url: "#{base_path}/#{id}", params: params)
+  end
+
+  protected
+
+  def validate_id!(id)
+    raise "#{self.class} passed a blank id!" if id.to_s.strip.empty?
+  end
+
+end

data/lib/morpheus/api/user_sources_interface.rb

@@ -24,21 +24,6 @@ class Morpheus::UserSourcesInterface < Morpheus::APIClient
     execute(opts)
   end
 
-  # def feature_permissions(account_id, id)
-  #   url = build_url(account_id, id) + "/feature-permissions"
-  #   headers = { params: {}, authorization: "Bearer #{@access_token}" }
-  #   opts = {method: :get, url: url, timeout: 10, headers: headers}
-  #   execute(opts)
-  # end
-
-  # def available_roles(account_id, id=nil, options={})
-  #   url = build_url(account_id, id) + "/available-roles"
-  #   headers = { params: {}, authorization: "Bearer #{@access_token}" }
-  #   headers[:params].merge!(options)
-  #   opts = {method: :get, url: url, timeout: 10, headers: headers}
-  #   execute(opts)
-  # end
-
   def create(account_id, options)
     url = build_url(account_id)
     headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }

data/lib/morpheus/api/users_interface.rb

@@ -16,10 +16,9 @@ class Morpheus::UsersInterface < Morpheus::APIClient
     execute(opts)
   end
 
-  def list(account_id, options={})
+  def list(account_id, params={})
     url = build_url(account_id)
-    headers = { params: {}, authorization: "Bearer #{@access_token}" }
-    headers[:params].merge!(options)
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
     opts = {method: :get, url: url, timeout: 10, headers: headers}
     execute(opts)
   end

data/lib/morpheus/benchmarking.rb

@@ -218,9 +218,9 @@ module Morpheus::Benchmarking
       end
       duration_str = duration
       if @start_time && @end_time
-        time_str = "#{seconds} seconds"
+        time_str = "#{seconds} s"
       elsif @start_time
-        time_str = "#{seconds} seconds (running)"
+        time_str = "#{seconds} s (running)"
       else
         time_str = "(unstarted)"
       end

data/lib/morpheus/cli.rb

@@ -70,6 +70,7 @@ module Morpheus
 
       # all the known commands
       load 'morpheus/cli/remote.rb'
+      load 'morpheus/cli/doc.rb'
       load 'morpheus/cli/ping.rb'
       load 'morpheus/cli/setup.rb'
       load 'morpheus/cli/login.rb'
@@ -77,7 +78,6 @@ module Morpheus
       load 'morpheus/cli/whoami.rb'
       load 'morpheus/cli/access_token_command.rb'
       load 'morpheus/cli/user_settings_command.rb'
-      # load 'morpheus/cli/auth_command.rb'
       load 'morpheus/cli/dashboard_command.rb'
       load 'morpheus/cli/recent_activity_command.rb' # deprecated, removing soon
       load 'morpheus/cli/activity_command.rb'
@@ -171,6 +171,8 @@ module Morpheus
       load 'morpheus/cli/invoices_command.rb'
       load 'morpheus/cli/guidance_command.rb'
       load 'morpheus/cli/projects_command.rb'
+      load 'morpheus/cli/backups_command.rb'
+      load 'morpheus/cli/backup_jobs_command.rb'
       # add new commands here...
 
     end

data/lib/morpheus/cli/access_token_command.rb

@@ -55,7 +55,7 @@ class Morpheus::Cli::AccessTokenCommand
       opts.banner = subcommand_usage()
       build_common_options(opts, options, [:remote, :quiet])
       opts.footer = "Print your current authentication credentials.\n" +
-                    "This contains tokens that should be kept secret, be careful."
+                    "This contains tokens that should be kept secret. Be careful."
     end
     optparse.parse!(args)
     if args.count != 0
@@ -111,8 +111,18 @@ class Morpheus::Cli::AccessTokenCommand
     params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage()
-      build_common_options(opts, options, [:auto_confirm, :remote, :dry_run, :json, :quiet])
-      opts.footer = "Use your refresh token.\n" +
+      opts.on( '-T', '--token TOKEN', "Refresh Token to use. The saved credentials are used by default." ) do |val|
+        options[:refresh_token] = val
+      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)
+          raise ::OptionParser::InvalidOption.new("File not found: #{token_file}")
+        end
+        options[:refresh_token] = File.read(token_file).to_s.split("\n").first.strip
+      end
+      build_common_options(opts, options, [:auto_confirm, :remote, :dry_run, :json, :quiet], [:remote_username, :remote_password, :remote_token])
+      opts.footer = "Use the refresh token in your saved credentials, or a provided token.\n" +
                     "This will replace your current access and refresh tokens with a new values.\n" +
                     "Your current access token will be invalidated\n" +
                     "All other users or applications with access to your token will need to update to the new token."
@@ -131,15 +141,22 @@ class Morpheus::Cli::AccessTokenCommand
     #   end
     #   return 1
     # end
-    if @wallet['refresh_token'].nil?
-      unless options[:quiet]
-        print_error yellow,"No refresh token found for appliance #{display_appliance(@appliance_name, @appliance_url)}",reset,"\n"
-        print_error yellow,"Use the 'login' command.",reset,"\n"
+    refresh_token_value = nil
+    if options[:refresh_token]
+      refresh_token_value = options[:refresh_token]
+    else
+      if @wallet['refresh_token']
+        refresh_token_value = @wallet['refresh_token']
+      else
+        unless options[:quiet]
+          print_error yellow,"No refresh token found for appliance #{display_appliance(@appliance_name, @appliance_url)}",reset,"\n"
+          print_error yellow,"Use the 'login' command.",reset,"\n"
+        end
+        return 1
       end
-      return 1
     end
     if options[:dry_run]
-      print_dry_run Morpheus::AuthInterface.new({url:@appliance_url}).setopts(options).use_refresh_token(@wallet['refresh_token'])
+      print_dry_run Morpheus::AuthInterface.new({url:@appliance_url}).setopts(options).use_refresh_token(refresh_token_value)
       return 0
     end
     unless options[:quiet]
@@ -160,7 +177,7 @@ class Morpheus::Cli::AccessTokenCommand
 
     # ok, let's use our refresh token
     # this regenerates the current access token.
-    refresh_result = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).use_refresh_token(options)
+    refresh_result = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).use_refresh_token(refresh_token_value, options)
     new_wallet = refresh_result
     if options[:json]
       puts as_json(refresh_result, options)

data/lib/morpheus/cli/apps.rb

@@ -603,22 +603,28 @@ class Morpheus::Cli::Apps
       rescue TypeError, JSON::ParserError => ex
         print_error red, "Failed to parse JSON response: #{ex}", reset, "\n"
       end
-      # The default way to print errors, except instances => []
-      (json_response['errors'] || {}).each do |error_key, error_msg|
-        if error_key != 'instances'
-          print_error red, " * #{error_key} : #{error_msg}", reset, "\n"
+      if json_response && (json_response['errors'].nil? || json_response['errors'].empty?)
+        # The default way to print error msg
+        print_rest_exception(e, options)
+      else
+        # print errors and look for special errors.instances
+        # todo: just handle sub lists of errors default error handler (print_rest_exception)
+        (json_response['errors'] || {}).each do |error_key, error_msg|
+          if error_key != 'instances'
+            print_error red, " * #{error_key} : #{error_msg}", reset, "\n"
+          end
         end
-      end
-      # looks for special error format like instances.instanceErrors 
-      if json_response['errors'] && json_response['errors']['instances']
-        json_response['errors']['instances'].each do |error_obj|
-          tier_name = error_obj['tier']
-          instance_index = error_obj['index']
-          instance_errors = error_obj['instanceErrors']
-          print_error red, "#{tier_name} : #{instance_index}", reset, "\n"
-          if instance_errors
-            instance_errors.each do |err_key, err_msg|
-              print_error red, " * #{err_key} : #{err_msg}", reset, "\n"
+        # looks for special error format like instances.instanceErrors 
+        if json_response['errors'] && json_response['errors']['instances']
+          json_response['errors']['instances'].each do |error_obj|
+            tier_name = error_obj['tier']
+            instance_index = error_obj['index']
+            instance_errors = error_obj['instanceErrors']
+            print_error red, "#{tier_name} : #{instance_index}", reset, "\n"
+            if instance_errors
+              instance_errors.each do |err_key, err_msg|
+                print_error red, " * #{err_key} : #{err_msg}", reset, "\n"
+              end
             end
           end
         end

data/lib/morpheus/cli/backup_jobs_command.rb

@@ -0,0 +1,276 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::BackupJobsCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::BackupsHelper
+  # include Morpheus::Cli::ProvisioningHelper
+  # include Morpheus::Cli::OptionSourceHelper
+
+  set_command_hidden # hide until ready
+
+  set_command_name :'backup-jobs'
+
+  register_subcommands :list, :get, :add, :update, :remove, :run
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @backups_interface = @api_client.backups
+    @backup_jobs_interface = @api_client.backup_jobs
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end  
+
+  def list(args)
+    options = {}
+    params = {}
+    ref_ids = []
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[search]")
+      build_standard_list_options(opts, options)
+      opts.footer = "List backup jobs."
+    end
+    optparse.parse!(args)
+    connect(options)
+    # verify_args!(args:args, optparse:optparse, count:0)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
+    params.merge!(parse_list_options(options))
+    @backup_jobs_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_jobs_interface.dry.list(params)
+      return
+    end
+    json_response = @backup_jobs_interface.list(params)
+    backup_jobs = json_response['jobs']
+    render_response(json_response, options, 'jobs') do
+      print_h1 "Morpheus Backup Jobs", parse_list_subtitles(options), options
+      if backup_jobs.empty?
+        print yellow,"No backup jobs found.",reset,"\n"
+      else
+        print as_pretty_table(backup_jobs, backup_job_column_definitions.upcase_keys!, options)
+        print_results_pagination(json_response)
+      end
+      print reset,"\n"
+    end
+    if backup_jobs.empty?
+      return 1, "no backup jobs found"
+    else
+      return 0, nil
+    end
+  end
+  
+  def get(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[job]")
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a specific backup job.
+[job] is required. This is the id or name a backup job.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1)
+    connect(options)
+    id_list = parse_id_list(args)
+    id_list = id_list.collect do |id|
+      if id.to_s =~ /\A\d{1,}\Z/
+        id
+      else
+        backup_job = find_backup_job_by_name(id)
+        if backup_job
+          backup_job['id']
+        else
+          return 1, "backup job not found for name '#{id}'"
+        end
+      end
+    end
+    return run_command_for_each_arg(id_list) do |arg|
+      _get(arg, params, options)
+    end
+  end
+
+  def _get(id, params, options)
+    @backup_jobs_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_jobs_interface.dry.get(id, params)
+      return
+    end
+    json_response = @backup_jobs_interface.get(id, params)
+    backup_job = json_response['job']
+    render_response(json_response, options, 'job') do
+      print_h1 "Backup Job Details", [], options
+      print cyan
+      print_description_list(backup_job_column_definitions, backup_job)
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+
+  def add(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[name] [options]")
+      build_option_type_options(opts, options, add_backup_job_option_types)
+      build_option_type_options(opts, options, add_backup_job_advanced_option_types)
+      build_standard_add_options(opts, options)
+      opts.footer = <<-EOT
+Create a new backup job
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:0, max:1)
+    options[:options]['name'] = args[0] if args[0]
+    connect(options)
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!({'job' => parse_passed_options(options)})
+    else
+      payload.deep_merge!({'job' => parse_passed_options(options)})
+      v_prompt = Morpheus::Cli::OptionTypes.prompt(add_backup_job_option_types(), options[:options], @api_client, options[:params])
+      params.deep_merge!(v_prompt)
+      advanced_config = Morpheus::Cli::OptionTypes.no_prompt(add_backup_job_advanced_option_types, options[:options], @api_client, options[:params])
+      advanced_config.deep_compact!
+      params.deep_merge!(advanced_config)
+      payload['job'].deep_merge!(params)
+    end
+    @backup_jobs_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_jobs_interface.dry.create(payload)
+      return 0, nil
+    end
+    json_response = @backup_jobs_interface.create(payload)
+    backup_job = json_response['job']
+    render_response(json_response, options, 'job') do
+      print_green_success "Added backup job #{backup_job['name']}"
+      return _get(backup_job["id"], {}, options)
+    end
+    return 0, nil
+  end
+
+  def update(args)
+    options = {}
+    params = {}
+    payload = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[job] [options]")
+      build_option_type_options(opts, options, update_backup_job_option_types)
+      build_option_type_options(opts, options, update_backup_job_advanced_option_types)
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Update a backup job.
+[job] is required. This is the name or id of a backup job.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    backup_job = find_backup_job_by_name_or_id(args[0])
+    return 1 if backup_job.nil?
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!({'job' => parse_passed_options(options)})
+    else
+      payload.deep_merge!({'job' => parse_passed_options(options)})
+      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_backup_job_option_types, options[:options], @api_client, options[:params])
+      v_prompt.deep_compact!
+      params.deep_merge!(v_prompt)
+      advanced_config = Morpheus::Cli::OptionTypes.no_prompt(update_backup_job_advanced_option_types, options[:options], @api_client, options[:params])
+      advanced_config.deep_compact!
+      params.deep_merge!(advanced_config)
+      payload.deep_merge!({'job' => params})
+      if payload['job'].empty? # || options[:no_prompt]
+        raise_command_error "Specify at least one option to update.\n#{optparse}"
+      end
+    end
+    @backup_jobs_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_jobs_interface.dry.update(backup_job['id'], payload)
+      return
+    end
+    json_response = @backup_jobs_interface.update(backup_job['id'], payload)
+    backup_job = json_response['job']
+    render_response(json_response, options, 'job') do
+      print_green_success "Updated backup job #{backup_job['name']}"
+      return _get(backup_job["id"], {}, options)
+    end
+    return 0, nil
+  end
+
+  def remove(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[job] [options]")
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete a backup job.
+[job] is required. This is the name or id of a backup job.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    backup_job = find_backup_job_by_name_or_id(args[0])
+    return 1 if backup_job.nil?
+    @backup_jobs_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_jobs_interface.dry.destroy(backup_job['id'], params)
+      return
+    end
+    json_response = @backup_jobs_interface.destroy(backup_job['id'], params)
+    render_response(json_response, options) do
+      print_green_success "Removed backup job #{backup_job['name']}"
+    end
+    return 0, nil
+  end
+
+  private
+
+  def backup_job_column_definitions()
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Schedule" => lambda {|it| it['schedule']['name'] rescue '' },
+      "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+      "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
+    }
+  end
+
+  def add_backup_job_option_types
+    [
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true, 'displayOrder' => 1},
+      {'fieldName' => 'code', 'fieldLabel' => 'Code', 'type' => 'text', 'required' => true, 'displayOrder' => 2},
+      {'fieldName' => 'retentionCount', 'fieldLabel' => 'Retention Count', 'type' => 'number', 'displayOrder' => 3},
+      {'fieldName' => 'scheduleId', 'fieldLabel' => 'Schedule', 'type' => 'select', 'optionSource' => 'executeSchedules', 'displayOrder' => 4}, # should use jobSchedules instead maybe? do we support manual schedules for backups?
+    ]
+  end
+
+  def add_backup_job_advanced_option_types
+    []
+  end
+
+  def update_backup_job_option_types
+    add_backup_job_option_types.collect {|it|
+      it.delete('required')
+      it.delete('defaultValue')
+      it
+    }
+  end
+
+  def update_backup_job_advanced_option_types
+    add_backup_job_advanced_option_types.collect {|it|
+      it.delete('required')
+      it.delete('defaultValue')
+      it
+    }
+  end
+
+end