manageiq-appliance_console 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c51a1645cacd16b9f78f45db22f3a1ae65976639e4cf4b350fac41e3cb8e736
-  data.tar.gz: d8307195379d0abd4d7379aa02ec3d0a9a779845f801b537b62861c63153aed3
+  metadata.gz: dab9032437ce55e00eacbd51c230873b67c7c6ebbce41637ecdf167c687f1fb9
+  data.tar.gz: 7f3414f814c1afe4764c5a042c0ca4d5243efdaba391039ed34d0838401d57f9
 SHA512:
-  metadata.gz: 703481bd2a07952b373444c4e1b2b7b65978341e2d6a9007ecbe66481a98b1b49122593149ce8b7b4109b7f148482e6281f090bae405112debd4c1a372bab4b2
-  data.tar.gz: 4a9b89883776c42b38861a371d657ffc4be786e9f109bc6a39c9c68b3df88ae4ccf701d4c0720b9dee95d28deada418ce8c2c21a25561760e6bbd3bd985791f5
+  metadata.gz: 4b10da6f428508db44d798a4486ffd9b0d19aad3aaf0141dbfd6d5bdb453bc436c2133962446535240e633e70217ec7918893f956c90ab587bafe468e859628d
+  data.tar.gz: 8657df612109649196c051e5054e30b9b66ecb599e56170b3746aa302bd7ec98b0b4776541b05a1b7296454feb444a12bc8c078d2b9c2a8ebe2dcab29f5dca77

data/lib/manageiq/appliance_console/database_admin.rb

@@ -1,16 +1,11 @@
 require 'manageiq/appliance_console/errors'
+require 'uri'
 
 module ManageIQ
   module ApplianceConsole
     class DatabaseAdmin < HighLine
       include ManageIQ::ApplianceConsole::Prompts
 
-      LOCAL_FILE     = "Local file".freeze
-      NFS_FILE       = "Network File System (NFS)".freeze
-      SMB_FILE       = "Samba (SMB)".freeze
-      S3_FILE        = "Amazon S3 (S3)".freeze
-      FILE_OPTIONS   = [LOCAL_FILE, NFS_FILE, SMB_FILE, S3_FILE, CANCEL].freeze
-
       DB_RESTORE_FILE      = "/tmp/evm_db.backup".freeze
       DB_DEFAULT_DUMP_FILE = "/tmp/evm_db.dump".freeze
       LOCAL_FILE_VALIDATOR = ->(a) { File.exist?(a) }.freeze
@@ -28,7 +23,8 @@ module ManageIQ
 
       WARN
 
-      attr_reader :action, :backup_type, :task, :task_params, :delete_agree, :uri, :filename
+      attr_accessor :uri
+      attr_reader :action, :backup_type, :task, :task_params, :delete_agree, :filename
 
       def initialize(action = :restore, input = $stdin, output = $stdout)
         super(input, output)
@@ -37,11 +33,20 @@ module ManageIQ
         @task_params = []
       end
 
+      def local_backup?
+        backup_type == "local".freeze
+      end
+
+      def object_store_backup?
+        backup_type == "s3".freeze || backup_type == "swift".freeze
+      end
+
       def ask_questions
         setting_header
         say(DB_DUMP_WARNING) if action == :dump
         ask_file_location
         ask_for_tables_to_exclude_in_dump
+        ask_to_split_up_output
       end
 
       def activate
@@ -53,12 +58,14 @@ module ManageIQ
       end
 
       def ask_file_location
-        case @backup_type = ask_with_menu(*file_menu_args)
-        when LOCAL_FILE then ask_local_file_options
-        when NFS_FILE   then ask_nfs_file_options
-        when SMB_FILE   then ask_smb_file_options
-        when S3_FILE    then ask_s3_file_options
-        when CANCEL     then raise MiqSignalError
+        @backup_type = ask_with_menu(*file_menu_args) do |menu|
+          menu.choice(CANCEL) { |_| raise MiqSignalError }
+        end
+        if URI(backup_type).scheme
+          ask_custom_file_options(backup_type)
+        else
+          # calling methods like ask_ftp_file_options and ask_s3_file_options
+          send("ask_#{backup_type}_file_options")
         end
       end
 
@@ -120,8 +127,75 @@ module ManageIQ
         @task_params = ["--", params]
       end
 
+      def ask_ftp_file_options
+        @filename    = just_ask(*filename_prompt_args) unless action == :restore
+        @uri         = ask_for_uri(*remote_file_prompt_args_for("ftp"), :optional_path => true)
+        user         = just_ask(USER_PROMPT)
+        pass         = ask_for_password("password for #{user}")
+
+        params = { :uri => uri }
+        params[:uri_username]     = user     if user.present?
+        params[:uri_password]     = pass     if pass.present?
+        params[:remote_file_name] = filename if filename
+
+        @task        = "evm:db:#{action}:remote"
+        @task_params = ["--", params]
+      end
+
+      def ask_custom_file_options(server_uri)
+        hostname  = URI(server_uri).host
+        @filename = ask_custom_file_prompt(hostname)
+        @uri      = server_uri
+
+        params = {:uri => uri, :remote_file_name => filename}
+
+        if (custom_params = custom_endpoint_config_for(hostname))
+          params.merge!(custom_params[:rake_options]) if custom_params[:rake_options]
+        end
+
+        @task        = "evm:db:#{action}:remote"
+        @task_params = ["--", params]
+      end
+
+      def ask_swift_file_options
+        require 'uri'
+        swift_user_prompt = <<-PROMPT.strip_heredoc.chomp
+          User Name with access to this file.
+          Example: 'openstack_user'
+        PROMPT
+
+        @filename  = just_ask(*filename_prompt_args) { |q| q.readline = false } unless action == :restore
+        @uri       = URI(ask_for_uri(*remote_file_prompt_args_for("swift")) { |q| q.readline = false })
+        @task      = "evm:db:#{action}:remote"
+        user       = just_ask(swift_user_prompt) { |q| q.readline = false }
+        pass       = ask_for_password("password for #{user}") { |q| q.readline = false }
+        @uri.query = swift_query_elements.join('&').presence
+
+        params = {
+          :uri          => @uri.to_s,
+          :uri_username => user,
+          :uri_password => pass
+        }
+        params[:remote_file_name] = filename if filename
+        @task        = "evm:db:#{action}:remote"
+        @task_params = ["--", params]
+      end
+
+      def swift_query_elements
+        region            = just_ask("OpenStack Swift Region") { |q| q.readline = false }
+        @uri.port         = just_ask("OpenStack Swift Port", "5000") { |q| q.readline = false }
+        security_protocol = ask_with_menu(*security_protocol_menu_args)
+        api_version       = ask_with_menu(*api_version_menu_args) { |q| q.readline = false }
+        domain_ident      = just_ask("OpenStack V3 Domain Identifier") { |q| q.readline = false } if api_version == "v3"
+        query_elements    = []
+        query_elements    << "region=#{region}"                       if region.present?
+        query_elements    << "api_version=#{api_version}"             if api_version.present?
+        query_elements    << "domain_id=#{domain_ident}"              if domain_ident.present?
+        query_elements    << "security_protocol=#{security_protocol}" if security_protocol.present?
+      end
+
       def ask_to_delete_backup_after_restore
-        if action == :restore && backup_type == LOCAL_FILE
+        if action == :restore && local_backup?
           say("The local database restore file is located at: '#{uri}'.\n")
           @delete_agree = agree("Should this file be deleted after completing the restore? (Y/N): ")
         end
@@ -147,6 +221,12 @@ module ManageIQ
         end || true
       end
 
+      def ask_to_split_up_output
+        if action == :dump && should_split_output?
+          @task_params.last[:byte_count] = ask_for_string("byte size to split by", "500M")
+        end || true
+      end
+
       def confirm_and_execute
         if allowed_to_execute?
           processing_message
@@ -157,15 +237,46 @@ module ManageIQ
 
       def allowed_to_execute?
         return true unless action == :restore
+
         say("\nNote: A database restore cannot be undone.  The restore will use the file: #{uri}.\n")
         agree("Are you sure you would like to restore the database? (Y/N): ")
       end
 
+      def file_options
+        @file_options ||= I18n.t("database_admin.menu_order").each_with_object({}) do |file_option, h|
+          # special anonymous ftp sites are defined by uri
+          uri = URI(file_option)
+          if uri.scheme
+            h["#{uri.scheme} to #{uri.host}"] = file_option unless skip_file_location?(uri.host)
+          else
+            h[I18n.t("database_admin.#{file_option}")] = file_option
+          end
+        end
+      end
+
+      def api_version_menu_args
+        [
+          "OpenStack API Version",
+          [["Keystone v2".freeze, "v2".freeze], ["Keystone v3".freeze, "v3".freeze], ["None".freeze, nil]].freeze,
+          ["Keystone v2".freeze, "v2".freeze],
+          nil
+        ]
+      end
+
       def file_menu_args
         [
           action == :restore ? "Restore Database File" : "#{action.capitalize} Output File Name",
-          FILE_OPTIONS,
-          LOCAL_FILE,
+          file_options,
+          "local",
+          nil
+        ]
+      end
+
+      def security_protocol_menu_args
+        [
+          "OpenStack Security Protocol",
+          [["SSL without validation".freeze, "ssl".freeze], ["SSL".freeze, "ssl-with-validation".freeze], ["Non-SSL".freeze, "non-ssl".freeze], ["None".freeze, nil]].freeze,
+          ["Non-SSL".freeze, "non-ssl".freeze],
           nil
         ]
       end
@@ -176,24 +287,53 @@ module ManageIQ
 
       private
 
+      def ask_custom_file_prompt(hostname)
+        prompts = custom_endpoint_config_for(hostname)
+        prompt_text  = prompts && prompts[:filename_text] || "Target filename for backup".freeze
+        prompt_regex = prompts && prompts[:filename_validator]
+        validator    = prompt_regex ? ->(x) { x.to_s =~ /#{prompt_regex}/ } : ->(x) { x.to_s.present? }
+        just_ask(prompt_text, nil, validator)
+      end
+
+      def skip_file_location?(hostname)
+        config = custom_endpoint_config_for(hostname)
+        return false unless config && config[:enabled_for].present?
+        !Array(config[:enabled_for]).include?(action.to_s)
+      end
+
+      def custom_endpoint_config_for(hostname)
+        # hostname has a period in it, so we need to look it up by [] instead of the traditional i18n method
+        I18n.t("database_admin.prompts", :default => {})[hostname.to_sym]
+      end
+
       def should_exclude_tables?
         ask_yn?("Would you like to exclude tables in the dump") do |q|
           q.readline = true
         end
       end
 
-      def filename_prompt_args
-        default   = action == :dump ? DB_DEFAULT_DUMP_FILE : DB_RESTORE_FILE
-        validator = LOCAL_FILE_VALIDATOR if action == :restore && backup_type == LOCAL_FILE
-        [local_file_prompt, default, validator, "file that exists"]
+      def should_split_output?
+        ask_yn?("Would you like to split the #{action} output into multiple parts") do |q|
+          q.readline = true
+        end
       end
 
-      def local_file_prompt
-        if action == :restore
-          "location of the local restore file"
-        else
-          "location to save the #{action} file to"
+      def filename_prompt_args
+        return restore_prompt_args if action == :restore
+        default = action == :dump ? DB_DEFAULT_DUMP_FILE : DB_RESTORE_FILE
+        prompt  = "location to save the #{action} file to"
+        if object_store_backup?
+          prompt  = "name for the remote #{action} file"
+          default = File.basename(default)
         end
+        [prompt, default, nil, "file that exists"]
+      end
+
+      def restore_prompt_args
+        default   = DB_RESTORE_FILE
+        validator = LOCAL_FILE_VALIDATOR if local_backup?
+        prompt    = "location of the local restore file"
+        [prompt, default, validator, "file that exists"]
       end
 
       def remote_file_prompt_args_for(remote_type)
@@ -202,10 +342,14 @@ module ManageIQ
                   else
                     "location to save the remote #{action} file to"
                   end
-        prompt += "\nExample: #{SAMPLE_URLS[remote_type]}"
+        prompt += "\nExample: #{sample_url(remote_type)}"
         [prompt, remote_type]
       end
 
+      def sample_url(scheme)
+        I18n.t("database_admin.sample_url.#{scheme}")
+      end
+
       def processing_message
         msg = if action == :restore
                 "\nRestoring the database..."

data/lib/manageiq/appliance_console/prompts.rb

@@ -15,16 +15,6 @@ module ApplianceConsole
     NONE_REGEXP   = /^('?NONE'?)?$/i.freeze
     HOSTNAME_REGEXP = /^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$/
 
-    SAMPLE_URLS = {
-      'nfs' => 'nfs://host.mydomain.com/exported/my_exported_folder/db.backup',
-      'smb' => 'smb://host.mydomain.com/my_share/daily_backup/db.backup',
-      's3'  => 's3://mybucket/my_subdirectory/daily_backup/db.backup',
-    }
-
-    def sample_url(scheme)
-      SAMPLE_URLS[scheme]
-    end
-
     def ask_for_uri(prompt, expected_scheme, opts = {})
       require 'uri'
       just_ask(prompt, nil, nil, 'a valid URI') do |q|
@@ -38,6 +28,7 @@ module ApplianceConsole
             (u.host =~ HOSTNAME_REGEXP || u.hostname =~ IP_REGEXP) &&
             (opts[:optional_path] || !u.path.empty?)
         end
+        yield q if block_given?
       end
     end
 

data/lib/manageiq/appliance_console/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module ApplianceConsole
-    VERSION = '3.2.0'.freeze
+    VERSION = '3.3.0'.freeze
   end
 end

data/locales/appliance/en.yml

@@ -42,3 +42,23 @@ en:
     shutdown: Shut Down Appliance
     summary: Summary Information
     quit: Quit
+  database_admin:
+    menu_order:
+    - local
+    - nfs
+    - smb
+    - s3
+    - ftp
+    - swift
+    local: Local file
+    nfs: Network File System (NFS)
+    smb: Samba (SMB)
+    s3: Amazon S3 (S3)
+    ftp: File Transfer Protocol (FTP)
+    swift: OpenStack Swift (Swift)
+    sample_url:
+      nfs: nfs://host.mydomain.com/exported/my_exported_folder/db.backup
+      smb: smb://host.mydomain.com/my_share/daily_backup/db.backup
+      s3: s3://mybucket/my_subdirectory/daily_backup/db.backup
+      ftp: ftp://host.mydomain.com/path/to/daily_backup/db.backup
+      swift: swift://host.mydomain.com/path/to/daily_backup/db.backup

data/manageiq-appliance_console.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "bcrypt",                  "~> 3.1.10"
   spec.add_runtime_dependency "highline",                "~> 1.6.21"
   spec.add_runtime_dependency "i18n",                    "~> 0.7"
-  spec.add_runtime_dependency "linux_admin",             "~> 1.0"
+  spec.add_runtime_dependency "linux_admin",             ["~> 1.0", ">=1.2.2"]
   spec.add_runtime_dependency "pg"
   spec.add_runtime_dependency "trollop",                 "~> 2.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-appliance_console
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -101,6 +101,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -108,6 +111,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement