morpheus-cli 6.1.1 → 6.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: morpheus-cli
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.0
 platform: ruby
 authors:
 - David Estes
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,6 +199,8 @@ files:
 - lib/morpheus/api/audit_interface.rb
 - lib/morpheus/api/auth_interface.rb
 - lib/morpheus/api/backup_jobs_interface.rb
+- lib/morpheus/api/backup_restores_interface.rb
+- lib/morpheus/api/backup_results_interface.rb
 - lib/morpheus/api/backup_service_types_interface.rb
 - lib/morpheus/api/backup_services_interface.rb
 - lib/morpheus/api/backup_settings_interface.rb
@@ -226,7 +228,6 @@ files:
 - lib/morpheus/api/datastores_interface.rb
 - lib/morpheus/api/deploy_interface.rb
 - lib/morpheus/api/deployments_interface.rb
-- lib/morpheus/api/doc_interface.rb
 - lib/morpheus/api/environments_interface.rb
 - lib/morpheus/api/execute_schedules_interface.rb
 - lib/morpheus/api/execution_request_interface.rb
@@ -372,6 +373,8 @@ files:
 - lib/morpheus/cli/commands/archives_command.rb
 - lib/morpheus/cli/commands/audit.rb
 - lib/morpheus/cli/commands/backup_jobs_command.rb
+- lib/morpheus/cli/commands/backup_restores_command.rb
+- lib/morpheus/cli/commands/backup_results_command.rb
 - lib/morpheus/cli/commands/backup_services_command.rb
 - lib/morpheus/cli/commands/backup_settings_command.rb
 - lib/morpheus/cli/commands/backups_command.rb
@@ -400,7 +403,6 @@ files:
 - lib/morpheus/cli/commands/deploy.rb
 - lib/morpheus/cli/commands/deployments.rb
 - lib/morpheus/cli/commands/deploys.rb
-- lib/morpheus/cli/commands/doc.rb
 - lib/morpheus/cli/commands/echo_command.rb
 - lib/morpheus/cli/commands/edit_profile_command.rb
 - lib/morpheus/cli/commands/edit_rc_command.rb
@@ -578,14 +580,12 @@ files:
 - lib/morpheus/util.rb
 - morpheus-cli.gemspec
 - test/api/containers_interface_test.rb
-- test/api/doc_interface_test.rb
 - test/api/instances_interface_test.rb
 - test/api/whoami_interface_test.rb
 - test/cli/access_token_test.rb
 - test/cli/auth_test.rb
 - test/cli/cli_test.rb
 - test/cli/containers_test.rb
-- test/cli/doc_test.rb
 - test/cli/help_test.rb
 - test/cli/instances_test.rb
 - test/cli/man_test.rb
@@ -624,14 +624,12 @@ specification_version: 4
 summary: Provides CLI Interface to the Morpheus Public/Private Cloud Appliance
 test_files:
 - test/api/containers_interface_test.rb
-- test/api/doc_interface_test.rb
 - test/api/instances_interface_test.rb
 - test/api/whoami_interface_test.rb
 - test/cli/access_token_test.rb
 - test/cli/auth_test.rb
 - test/cli/cli_test.rb
 - test/cli/containers_test.rb
-- test/cli/doc_test.rb
 - test/cli/help_test.rb
 - test/cli/instances_test.rb
 - test/cli/man_test.rb

data/lib/morpheus/api/doc_interface.rb

@@ -1,50 +0,0 @@
-require 'morpheus/api/api_client'
-
-class Morpheus::DocInterface < Morpheus::APIClient
-
-  def list(params={})
-    url = "/api/doc"
-    headers = {params: params}
-    execute(method: :get, url: url, headers: headers)
-  end
-
-  def openapi(params={})
-    url = "/api/doc/openapi"
-    fmt = params.delete('format')
-    if fmt
-      url = url + "." + fmt
-    end
-    is_yaml = fmt == "yml" || fmt == "yaml"
-    headers = {params: params}
-    execute(method: :get, url: url, headers: headers, timeout: 172800, parse_json: !is_yaml)
-  end
-
-  def download_openapi(outfile, params={})
-    # note that RestClient.execute still requires the full path with base_url
-    url = "#{@base_url}/api/doc/openapi"
-    fmt = params.delete('format')
-    if fmt
-      url = url + "." + fmt
-    end
-    headers = {params: params, authorization: "Bearer #{@access_token}"}
-    opts = {method: :get, url: url, headers: headers, timeout: 172800, parse_json: false}
-
-    if @dry_run
-      return opts
-    end
-
-    http_response = nil
-    File.open(File.expand_path(outfile), 'w') {|f|
-      block = proc { |response|
-        response.read_body do |chunk|
-          # writing to #{outfile} ..."
-          f.write chunk
-        end
-      }
-      opts[:block_response] = block
-      http_response = Morpheus::RestClient.execute(opts)
-    }
-    http_response
-  end
-
-end

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

@@ -1,182 +0,0 @@
-require 'morpheus/cli/cli_command'
-
-# This provides commands for authentication 
-# This also includes credential management.
-class Morpheus::Cli::Doc
-  include Morpheus::Cli::CliCommand
-
-  set_command_name :'doc'
-  register_subcommands :list
-  register_subcommands :get => :openapi
-  register_subcommands :download => :download_openapi
-
-  # hidden until doc complete (or close to it)
-  set_command_hidden
-
-  def initialize()
-    # @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
-  end
-
-  def handle(args)
-    handle_subcommand(args)
-  end
-
-  def connect(options)
-    # @api_client = establish_remote_appliance_connection(options.merge({:no_prompt => true, :skip_verify_access_token => true, :skip_login => true}))
-    @api_client = establish_remote_appliance_connection(options)
-    @doc_interface = @api_client.doc
-  end
-
-  def list(args)
-    exit_code, err = 0, nil
-    params, options = {}, {}
-    optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage()
-      build_standard_get_options(opts, options)
-      opts.footer = <<-EOT
-List documentation links.
-EOT
-    end
-    optparse.parse!(args)
-    verify_args!(args:args, optparse:optparse, count:0)
-    connect(options)
-    # construct the api request
-    params.merge!(parse_list_options(options))
-    # execute the api request
-    @doc_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @doc_interface.dry.list(params)
-      return 0, nil
-    end
-    json_response = @doc_interface.list(params)
-    render_response(json_response, options, "links") do
-      title = "Morpheus Documentation"
-      print_h1 title, options
-      if json_response['links'].empty?
-        print yellow, "No help links found.",reset,"\n"
-      else
-        columns = {
-          "Link Name" => 'name',
-          "URL" => 'url',
-          "Description" => {display_method:'description', max_width: (options[:wrap] ? nil : 50)}, 
-        }
-        print as_pretty_table(json_response['links'], columns.upcase_keys!, options)
-        # print_results_pagination(json_response)
-      end
-      print reset,"\n"
-    end
-    return exit_code, err
-  end
-
-  def openapi(args)
-    exit_code, err = 0, nil
-    params, options = {}, {}
-    optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage()
-      # opts.on(nil, "--refresh", "Refresh the document. By default the openapi.yml and openapi.json are cached by the server.") do
-      #   params['refresh'] = true
-      # end
-      # opts.on('-g', '--generate', "Alias for --refresh") do
-      #   params['refresh'] = true
-      # end
-      build_standard_get_options(opts, options, [], [:csv])
-      opts.footer = <<-EOT
-Print the Morpheus API OpenAPI Documentation (swagger).
-The default format is JSON. Supports json or yaml.
-EOT
-    end
-    optparse.parse!(args)
-    verify_args!(args:args, optparse:optparse, count:0)
-    connect(options)
-    # construct the api request
-    params.merge!(parse_list_options(options))
-    # for now, always use .json, and just convert to yaml for display on cli side
-    openapi_format = options[:yaml] ? "yaml" : "json"
-    # params['format'] = openapi_format
-    # execute the api request
-    @doc_interface.setopts(options)
-    if options[:dry_run]
-      params['format'] = openapi_format
-      print_dry_run @doc_interface.dry.openapi(params)
-      return 0, nil
-    end
-    json_response = @doc_interface.openapi(params)
-    # default format is to print header and json
-    render_response(json_response, options) do
-      title = "Morpheus API openapi.#{openapi_format}"
-      print_h1 title, options
-      print cyan
-      print as_json(json_response, options)
-      print reset,"\n"
-    end
-    return exit_code, err
-  end
-
-  def download_openapi(args)
-    exit_code, err = 0, nil
-    params, options = {}, {}
-    optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[local-file]")
-      # build_standard_get_options(opts, options, [], [:csv,:out])
-      opts.on(nil, '--yaml', "YAML Output") do
-        options[:yaml] = true
-        options[:format] = :yaml
-      end
-      # opts.on(nil, "--refresh", "Refresh the document. By default the openapi.yml and openapi.json are cached by the server.") do
-      #   params['refresh'] = true
-      # end
-      # opts.on('-g', '--generate', "Alias for --refresh") do
-      #   params['refresh'] = true
-      # end
-      opts.on( '-f', '--force', "Overwrite existing [local-file] if it exists." ) do
-        options[:overwrite] = true
-      end
-      opts.on( '-p', '--mkdir', "Create missing directories for [local-file] if they do not exist." ) do
-        options[:mkdir] = true
-      end
-      build_common_options(opts, options, [:dry_run, :quiet, :remote])
-      opts.footer = <<-EOT
-Download the Morpheus API OpenAPI Documentation (swagger).
-[local-file] is required. This is the full local filepath for the downloaded file.
-The default format is JSON. Supports json or yaml.
-EOT
-    end
-    optparse.parse!(args)
-    verify_args!(args:args, optparse:optparse, count:1)
-    connect(options)
-    # parse args
-    outfile = args[0]
-    if !validate_outfile(outfile, options)
-      return 1, "Failed to validate outfile"
-    end
-    # construct the api request
-    params.merge!(parse_list_options(options))
-    if outfile.include?(".yml") || outfile.include?(".yaml")
-      options[:yaml] = true
-    end
-    openapi_format = options[:yaml] ? "yaml" : "json"
-    params['format'] = openapi_format
-    # execute the api request
-    @doc_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @doc_interface.dry.download_openapi(outfile, params)
-      return 0, nil
-    end
-    print cyan + "Downloading openapi.#{openapi_format} to #{outfile} ... " if !options[:quiet]
-    http_response = @doc_interface.download_openapi(outfile, params)
-    if http_response.code.to_i == 200
-      print green + "SUCCESS" + reset + "\n" if !options[:quiet]
-      return 0, nil
-    else
-      print red + "ERROR" + reset + " HTTP #{http_response.code}" + "\n" if !options[:quiet]
-      if File.exist?(outfile) && File.file?(outfile)
-        Morpheus::Logging::DarkPrinter.puts "Deleting bad file download: #{outfile}" if Morpheus::Logging.debug?
-        File.delete(outfile)
-      end
-      return 1, "HTTP #{http_response.code}"
-    end
-  end
-
-  protected
-
-end

data/test/api/doc_interface_test.rb

@@ -1,35 +0,0 @@
-require 'morpheus_test'
-
-# Tests for Morpheus::DocInterface
-class MorpheusTest::DocInterfaceTest < MorpheusTest::TestCase
-  
-  def test_doc_list
-    @doc_interface = client.doc
-    response = @doc_interface.list()
-    assert_equal response['links'].class, Array
-  end
-
-  def test_doc_get
-    @doc_interface = client.doc
-    response = @doc_interface.openapi()
-    assert_equal response['openapi'], '3.0.3'
-    # todo: fix this, can be cached and fail
-    #assert_equal response['version'], Morpheus::Cli::Remote.load_remote(@config.remote_name)[:build_version]
-  end
-
-  def test_doc_get_yaml
-    @doc_interface = client.doc
-    response = @doc_interface.openapi({'format' => "yaml"})
-    assert response.body
-    assert YAML.load(response.body)
-  end
-
-  # def test_doc_download
-  #   @doc_interface = client.doc
-  #   response = @doc_interface.download_openapi('/path/to/openapi.json')
-  #   yaml_content = response.body
-  #   yaml_data = YAML.load(yaml_content)
-  #   assert_not_nil yaml_data
-  # end
-
-end

data/test/cli/doc_test.rb

@@ -1,35 +0,0 @@
-require 'morpheus_test'
-
-# Tests for Morpheus::Cli::Doc
-class MorpheusTest::DocTest < MorpheusTest::TestCase
-  
-  def test_doc_list
-    assert_execute("doc list")
-  end
-
-  def test_doc_get
-    # using --quiet because the output is massive
-    assert_execute("doc get --quiet")
-  end
-
-  def test_doc_get_yaml
-    # using --quiet because the output is massive
-    assert_execute("doc get --yaml --quiet") 
-  end
-
-  # def test_doc_download
-  #   assert_execute("doc download '/path/to/openapi.json')
-  # end
-
-  # def test_doc_download_yaml
-  #   assert_execute("doc download '/path/to/openapi.yaml' --yaml")
-  # end
-
-  def test_doc_get_unauthorized
-    # authentication is NOT required for this api
-    without_authentication do
-      assert_error("doc get -q")
-    end
-  end
-
-end